编写一个简单的Linux内核并输出消息在日志里"

本文最后更新于:November 28, 2021 am

前言:

Linux 内 核 模 块 全 称 为 “ 动 态 可 加 载 内 核 模 块 (Loadable Kernel Module,LKM)”,是系统内核向外部提供的功能插口。作为宏内核结构,Linux 内核具有效率高的特点,但也有可扩展性和可维护性相对较差的不足,Linux 提供模块机制正是弥补这一缺陷。

模块是具有独立功能的程序,它可以被单独编译,但不能独立运行。模块在运行时被链接到内核作为内核的一部分在内核空间运行,这与运行在用户控件的进程是不同的。模块通常有一组函数和数据结构组成,用来实现某种文件系统、驱动程序或其它内核上层功能。

本文将介绍如何编写一个简单的内核模块以及如何传递参数给此模块。

一、 编写一个简单的内核模块

1.编写模块程序

编写如下简单代码,本示例中代码文件命名“hello_module.c”。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
//hello_module.c
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>

static int __init hello_init(void){
printk("This is hello_module, welcome to Linux kernel \n");
return 0;
}

static void __exit hello_exit(void){
printk("see you next time!\n");
}

module_init(hello_init);
module_exit(hello_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Mr Q");
MODULE_DESCRIPTION("hello kernel module");
MODULE_ALIAS("hello");

以上代码解释如下:

(1) #include <linux/module.h>:必须。module.h 头文件包含了对模块的结构定义以及模块的版本控制,任何模块程序的编写都要包含这个头文件;

(2) #include <linux/kernel.h>:kernel.h 包含了常用的内核函数,如以上程序中的 printk()函数;

(3) #include <linux/init.h>:必须。init.h 包含了 module_init()和 module_exit()函数的声明;

(4) module_init():必须。模块加载函数,加载模块式该函数自动执行,进行初始化操作;

(5) module_exit():必须。模块卸载函数,卸载模块时函数自动执行,进行清理操作;

(6) MODULE_LICENSE():表示模块代码接受的软件许可协议。Linux 内核是使用 GPL V2 的开源项目,其要求所有使用和修改了 Linux 内核代码的个人或组织都有义务把修改后的源代码公开,这是一个强制的开源协议,所以一般编写驱动代码都需要显示的声明和遵循本协议,否则内核 UI 发出被污染的警告;

(7) MODULE_AUTHOR():描述模块的作者信息;

(8) MODULE_DESCRIPTION():简单描述模块的用途、功能介绍等;

(9) MODULE_ALIAS():为用户控件提供的别名;

(10) printk():内核输出函数,默认打印系统文件 “ /var/log/kern.log”的内容。

2. 编译内核模块

编写 Makefile 文件,文件名必须为“Makefile”

1
2
3
4
5
6
7
8
9
10
obj-m := hello_module.o

KERNELBUILD := /lib/modules/$(shell uname -r)/build
CURRENT_PATH := $(shell pwd)

all:
make -C $(KERNELBUILD) M=$(CURRENT_PATH) modules

clean:
make -C $(KERNELBUILD) M=$(CURRENT_PATH) clean

以上代码解释如下:

(1) obj-m := <模块名>.o:定义要生成的模块名称

(2) KERNELBUILD := /lib/modules/$(shell uname -r)/build :

KERNELBUILD 为自定义名称,用于指向正在运行 Linux 的内核编译目录,其中“uname -r”标识显示对应的内核版本;

(3) CURRENT_PATH := $(shell pwd):CURRENT_PATH 为自定义名称,用于指向当前当前目录;

(4) all:编译执行的动作

(5) clean:zhixing make clean 需要的动作。“make clean”用于清除上次的 make 命令所产生的 object 文件(后缀为“.o”的文件)及可执行文件。

3.编译

将以上两个文件(hello_module.c 和 Makefile)保存于同一目录下,将上文中代码存放在路径为“/code/hellomodule/”,编译需在文件保存目录中进行。

image-20200608113407988

编译成功后,可看到生成的 hello_module.ko 目标文件

image-20200608113502338

4.检查编译模块

可通过 file 命令检查编译的模块是否正确,可以看到 x86-64 架构的 elf文件,说明编译成功:

image-20200608113816662

也可通过 modinfo 命令进一步检查 :

image-20200608114046227

5.插入模块

通过 insmod 命令插入模块,完成插入后可通过 lsmod 命令查看当前模块是否已经被加载到系统中:

image-20200608115103707

系统加载模块后,也会在“/sys/module”目录下新建以模块名命名的目录 :

image-20200608115252879

6.查看输出

因 本 演示 中 prink()采 用 默认 输出 等级 ,可 通 过“ dmesg” 或“ tail /var/log/kern.log”命令查看输出结果。

image-20200608115615691

“ tail /var/log/kern.log”命令查看输出结果:

image-20200608115832820

7. 卸载模块

卸载模块,可通过“rmmod 模块名”实现,通 过“ tail /var/log/kern.log”命令查看输出结果。

image-20200608120215696

二、 模块参数

1.说明

Linux 内核提供一个宏来实现模块的参数传递

1
2
3
4
5
#define module_param(name, type, perm) \
module_param_named(name, name, type, perm)

#define MODULE_PARM_DESC(_parm, desc) \
_MODULE_INFO(parm, _parm, #_parm ":" desc);

module_param()宏由 3 个参数组成,name 表示参数名,type 表示参数类型,perm 表示参数读写权限。MODULE_PARM_DESC()宏提供参数的简单说明,参数类型可为 byte、short、int、long、char、bool 等类型;perm 指定在 sysfs 中相应文件的访问权限,如设置为 0 则不会出现在 sysfs 文件系统中,设置为 0644 标识 root 用户可修改本参数。

1
2
3
4
5
static int debug = 1;
module_param(debug, int, 0644);
MODULE_PARM_DESC(debug, "enable debugging information");

#define dprintk(args...) if(debug){printk(KERN_DEBUG args);}

如上述实际代码所示(driver/misc/altera-stap1/altera.c),实际定义模块参数 debug,类型是 int,访问权限是 0644。参数用途是大概调试信息,实际内核编程中常用此方法进行内核调试。

2.开始动手

修改上文中的“hello_module.c”文件,改为以下内容:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
//hello_module.c
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>

static int debug = 1;
module_param(debug, int, 0644);
MODULE_PARM_DESC(debug, "debugging information");

#define dprintk(args...) if(debug){printk(KERN_DEBUG args);}
static int myparm = 10;
module_param(myparm, int, 0644);
MODULE_PARM_DESC(myparm, "kernel module parameter experiment.");


static int __init parm_init(void){
dprintk("my linux kernel module init.\n");
dprintk("module parameter = %d\n", myparm);

return 0;
}

static void __exit parm_exit(void){
printk("see you next time!\n");
}

module_init(parm_init);
module_exit(parm_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Mr Q");
MODULE_DESCRIPTION("kernel module paramter experiment");
MODULE_ALIAS("myparm");

make编译,装载模块,并查看输出:

image-20200608122047862

通过查看日志信息,可发现输出以上程序中 参数 的默认值。

卸载模块,赋值重新加载模块,修改参数 myparm 值为 116:

1
insmod parm_module.ko myparm=116  

image-20200608122350054

通过查看日志信息,可发现 参数 值已经改变。