quejing
发布于 2023-12-25 / 205 阅读
0

02 Hello-World

Hello World是许多人开始写代码的时候第一个编写的例子,这里也延续传统,从Hello World开始。

本节主要学会以下内容:

  • 了解模块相关的内容:模块概念、模块编译、模块加载/卸载命令
  • HelloWorld模块:编译、加载

1. 模块相关内容

Linux本身是一个单内核,为了提高其可扩展性和可维护性,其提供了模块机制。基于模块机制,开发者可以动态地向内核添加功能,这样测试新驱动时,可以不用经过冗长的开关机重启过程。

模块编译

模块编译的前提是要有内核树,这在《Linux设备驱动程序》——前言中有说明。

有了内核树后,需要编写对应的Makefile文件,其内容只要输入以下内容就可以了:

obj-m	+=	helloworld.o

其中,“helloworld.o”对应的是模块源码的文件名“helloworld.c”,后续根据源码文件名修改即可。

当然,要想让上述Makefile文件生效,需要在内核构造系统环境中调用它,有两种方法:

第一种:在前面《Linux设备驱动程序》——前言 也有提到,在Makefile相同目录中使用以下make命令来生成模块:

make -C {linux_header_dir} M='pwd' modules

其中,{linux_header_dir}是linux-header的根目录。

这条命令会先去执行-C后面指定目录中的Makefile文件,执行完成后即构建了内核构造系统环境,然后跳回到当前目录中,执行当前目录中的Makefile,编译生成需要的模块。

接下来的学习过程中采用这个方法进行模块编译。这种做法的好处是将模块的代码与内核源码区分开来,一方面不会污染内核源码,另一方面,如果需要针对不同内核编译模块,只需要修改linux-header目录即可。

第二种:将模块的代码和Makefile放入到内核树中,成为内核树的一部分,并确保Makefile被层级Makefile包含。这样,在源码根目录下执行以下命令即可编译生成需要的模块。

make modules

模块编译完成后,会在模块代码相同目录下生成一个.ko文件,这就是我们需要的模块。

模块加载/卸载

加载模块使用的命令是insmod,需要在su权限下运行,格式如下:

insmod {name}.ko

其中,{name}为刚刚编译的文件名。

卸载模块使用的命令是rmmod,需要在su权限下运行,格式如下:

rmmod {name}

其中,{name}为刚刚编译的文件名,没有.ko后缀。

除此之外,还有以下几个命令可以了解一下:

lsmod 列出当前系统所有模块
modprobe 作用与insmod相同,不同的是它会搜索相关依赖,并一起加载到内核中
modinfo 列出当前模块的信息

2. HelloWorld模块

终于要开始写模块了。在写代码之前,先创建一些目录,结构如下:

LinuxDeviceDriver(内核源码根目录)
    |- Makefile(文件,项目根目录下创建Makefile文件)
    |- helloworld(HelloWorld模块文件夹)
        |- helloworld.c (HelloWorld模块源码)
        |- Makefile	(Helloworld模块的Makefile文件)

首先创建了一个LinuxDeviceDriver的目录,作为整个项目的根目录(下面简称根目录);在根目录中创建了一个Makefile文件,用于编译整个项目中的模块;在根目录中创建了一个helloworld目录,用于存放HelloWorld模块的源码和对应的编译文件。

后续新加的模块都会在根目录下新创建一个目录,这样各个模块不会相互干扰,结构更加清晰。

根目录下的Makefile文件内容如下:

KERNEL_DIR = /usr/src/linux-headers-5.4.0-40-generic
CUR_DIR = $(shell pwd)
SUB_DIR = helloworld/

ifneq   ($(KERNELRELEASE),)
        obj-y   +=      $(SUB_DIR)
else
default:
        make -C $(KERNEL_DIR) M=$(CUR_DIR) modules
endif

clean:
        @-rm -f *.o *~ *.mod *.mod.c *.cmd *.order *.symvers
        @for n in $(SUB_DIR); do $(MAKE) -C $$n clean; done

这个Makefile会被执行两次,第一次执行的时候,由于KERNELRELEASE没有定义,所以会执行else中的make -C $(KERNEL_DIR) M=$(CUR_DIR) modules,构建内核系统环境,这个make返回前,会回到当前目录中,执行当前目录中Makefile文件(即再次执行),此时KERNELRELEASE已定义,会执行obj-y += $(SUB_DIR),即继续去执行SUB_DIR中的Makefile文件,最终由内核编译出对应的模块。

clean规则用于清理当前目录和所有子目录中生成的编译产物。

helloworld.c文件中的内容如下:

#include <linux/init.h>
#include <linux/module.h>

static int hello_world_init(void)
{
    printk(KERN_ALERT "Hello World!\n");
    return 0;
}

static void hello_world_exit(void)
{
    printk(KERN_ALERT "Hello World, Good-Bye!\n");
}

module_init(hello_world_init);
module_exit(hello_world_exit);

MODULE_LICENSE("GPL");

init.h和module.h两个头文件在模块编写中基本是必须的。

printk可以理解为内核中的printf,因为printf不能在内核中使用,因为内核不包含printf的库。

module_init()和module_exit()是告诉内核在加载的时候调用哪个函数,在卸载的时候调用哪个函数,其具体的实现过程后面再说,或者也可以看我写的博客:

https://blog.csdn.net/quejing1992/article/details/102468988

MODULE_LICENSE用于标注当前源码使用的许可证。类似的宏还有如下:

MODULE_AUTHOR("作者");
MODULE_DESCRIPTION("用途描述");
MODULE_VERSION("版本号");
MODULE_ALIAS("模块别名");
MODULE_DEVICE_TABLE("模块支持的设备");

helloworld目录中的Makefile内容如下:

obj-m   +=      helloworld.o

clean:
        @-rm -f *.ko* *.mod* *.o* *~ *.order .*?.*?

编译HelloWorld模块

准备好以上内容后,即可编译模块。

切换到根目录下,执行make命令,即可编译模块,编译结果如下图所示。
编译HelloWorld模块结果

编译HelloWorld模块结果

此时会在helloworld目录下生成helloworld.ko,这就是我们需要的HelloWorld模块。

加载/卸载HelloWorld模块

得到上面的ko文件后,即可进行加载和卸载,使用insmod命令加载,rmmod命令卸载,如下图所示。

模块加载卸载操作

模块加载卸载操作

至此,HelloWorld模块完成。

(代码同步放在:https://gitee.com/Quehehe/LinuxDeviceDriver.git)