Linux内核模块

Linux设备驱动会以内核模块的形式出现，因此，学会编写Linux内核模块编程是学习Linux设备驱动的先决条件。
4.1-4.2节讲解了Linux内核模块的概念和结构，4.3-4.8节对Linux内核模块的各个组成部分进行详细讲解，4.1-4.2节与4.3-4.8节是整体与部分的关系。
4.9节讲解了独立存在的Linux内核模块的Makefile文件编写方法和模块的编译方法。

4.1 Linux内核模块简介

Linux内核的整体结构非常庞大，其包含的组件也非常多。我们怎样把需要的部分都包含在内核中呢？
一种方法是把所有需要的功能都编译到Linux内核。这会导致两个问题，一是生成的内核会很大，二是如果我们要在现有的内核中新增或删除发功能，将不得不重新编译内核。
有没有一种机制使得编译出的内核本身并不需要包含所有功能，而在这些功能需要被使用的时候，其对应的代码可被动态地加载到内核中呢？
Linux提供了这样的一种机制，这种机制被称为模块（Module），可以实现以上效果。模块具有以下特点。

1. 模块本身不被编译入内核映像，从而控制了内核的大小。
2. 模块一旦被加载，它就和内核中的其他部分完全一样。

为了使读者对模块建立初步的感性认识，我们先来看一个最简单的内核模块“Hello World”。

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

MODULE_LICENSE("Dual BSD/GPL")

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

static void hello_exit(void)
{
    printk(KERN_ALERT"Hello World exit\n");
}

module_init(hello_init);
module_exit(hello_exit);

MODULE_AUTHOR("Song Baohua");
MODULE_DESCRIPTION("A simple Hello World Module");
MODULE_ALIAS("a simplest module");

这个最简单的内核模块只包含内核模块加载函数、卸载函数和对Dual BSD/GPL许可权限的声明以及一些描述信息。编译它会产生hello.ko目标文件，通过“insmod ./hello.ko”命令可以加载它，通过“rmmod hello”命令可以卸载它，加载时输出“Hello World enter”，卸载时输出“Hello World exit”。
内核模块中用于输出的函数是内核空间的printk()而非用户空间的printf()，printk()的用法和printf()相似，但前者可定义输出级别。printk()可作为一种最基本的内核调试手段。
在Linux系统中，使用lsmod命令可以获得系统中加载了的所有模块以及模块间的依赖关系，例如：

lsmod命令实际上读取并分析/proc/modules文件，与上述lsmod命令结果对应的/proc/modules文件如下：

内核中已加载模块的信息也存在于/sys/module目录下，加载hello.ko后，内核中将包含/sys/module/hello目录，该目录下又包含了一个refcnt文件和一个sections目录，在/sys/module/hello目录下运行“tree -a”得到如下目录树：

modprobe命令比insmod命令要强大，它在加载某模块时会同时加载该模块所依赖的其他模块。使用modprobe命令加载的模块若以“modprobe -r filename”的方式卸载将同时卸载其依赖的模块。
使用modinfo<模块名>命令可以获得模块的信息，包括模块的作者、模块的说明、模块所支持的参数以及vermagic，如下所示：

4.2 Linux内核模块的程序结构

一个内核模块主要由以下几个部分组成。

1. 模块加载函数（必须）。
   当通过insmod或modprobe命令加载内核模块时，模块的加载函数会自动被执行，完成本模块的相关初始化工作。
2. 模块卸载函数（必须）。
   当通过rmmod命令卸载某模块时，模块的卸载函数会自动被执行，完成与模块加载函数相反的功能。
3. 模块许可证声明（必须）。
   模块许可证（LISENCE）声明描述内核模块的许可权限，如果不声明LICENSE，模块被加载时，将收到内核被污染的警告。
   在Linux2.6内核中，可接受的LISENCE包括“GPL”、“GPL v2”、“GPL and additional rights”、“Dual BSD/GPL”、“Dual MPL/GPL”和“Proprietary”。
   大多数情况下，内核模块应遵循GPL兼容许可权。Linux2.6内核模块最常见的是以MODULE_LISENCE(“Dual BSD/GPL”)语句声明模块采用BSD/GPL双LISENCE。
4. 模块参数（可选）。
   模块参数是模块被加载的时候可以传递给它的值，它本身对应模块内部的全局变量。
5. 模块导出符号（可选）。
   内核模块可以导出符号（symbol，对应于函数或变量），这样其他模块可以使用本模块中的变量或函数。
6. 模块作者等信息声明（可选）。

4.3 模块加载函数

Linux内核模块加载函数一般以__init标识声明，典型的模块加载函数的形式如代码所示：

static int __init initialization_function(void)
{
    //初始化代码
}
module_init(initialization_function);

模块加载函数必须以“module_init(函数名)”的形式被指定。它返回整型值，若初始化成功，应返回0。而在初始化失败时，应该返回错误编码。在Linux内核里面，错误编码是一个负值，在<linux/error.h>中定义，包含-ENODEV、-ENOMEM之类的符号值。返回相应的错误编码是种非常好的习惯，因为只有这样，用户程序才可以利用perror等方法把它们转换成有意义的错误信息字符串。
在Linux2.6内核中，可以使用request_module(const char *fmt,…)函数加载内核模块，驱动开发人员可以通过调用

request_module(module_name);

或

request_module("char-major-%d-%d",MAJOR(dev),MINOR(dev));

来加载其他内核模块。
在Linux内核中，所有标识为__init的函数在连接的时候都放在.init.text这个区段内，此外，所有的__init函数在区段.initcall.init中还保存了一份函数指针，在初始化时内核会通过这些函数指针调用这些__init函数，并在初始化完成后释放init区段（包括.init.text，.initcall.init等）。

4.4 模块卸载函数

Linux内核模块函数一般以__exit标识声明，典型的模块卸载函数的形式如下所示:

static void __exit cleanup_function(void)
{
    //释放代码
}
module_exit(cleanup_function);

模块卸载函数在模块卸载的时候执行，不返回任何值，必须以“module_exit(函数名)”的形式来指定。
通常来说，模块卸载函数要完成与模块加载函数相反的功能，如下所示。

1. 若模块加载函数注册了XXX，则模块卸载函数应该注销XXX。
2. 若模块加载函数动态申请了内存，则模块卸载函数应释放该内存。
3. 若模块加载函数申请了硬件资源（中断、DMA通道、I/O端口和I/O内存等）的占用，则模块卸载函数应释放这些硬件资源。
4. 若模块加载函数开启了硬件，则模块卸载函数中一般要关闭硬件。

和__init一样，__exit也可以使对应函数在运行完成后自动回收内存。实际上，__init和__exit都是宏，其定义分别为：

#define __init__attribute__((__section__(".init.text")))

和

#ifdef MODULE
#define __exit__attribute__((__section__(".exit.text")))
#else
#define __exit__attribute_used____attribute__((__section__(".exit.text")))
#endif

数据也可以被定义为_initdata和_exitdata，这两个宏分别为：

#define __initdata__attribute__((__section__(".init.text")))

和

#define __exitdata__attribute__((__section__(".exit.text")))

4.5 模块参数

我们可以用“module_param(参数名，参数类型，参数读/写权限)”为模块定义一个参数，例如下列代码定义了一个整型参数和一个字符指针参数：

static char *book_name = "深入浅出Linux设备驱动";
static int num = 4000;
module_param(num,int,S_IRUGO);
module_param(book_name,charp,S_IRUGO);

在装载内核模块时，用户可以向模块传递参数，形式为“insmod（或modprobe）模块名 参数名=参数数值”，如果不传递，参数将使用模块内定义的默认值。
参数类型可以是byte、short、ushort、int、uint、long、ulong、charp（字符指针）、bool或invbool（布尔的反），在模块被编译时会将module_param中声明的类型与变量定义的类型进行比较，判断是否一致。
模块被加载后，在/sys/module/目录下将出现以此模块名命名的目录。当“参数读/写权限”为0时，表示此参数不存在sysfs文件系统下对应的文件节点，如果此模块存在“参数读/写权限”不为0的命令行参数，在此模块的目录下还将出现parameters目录，包含一系列以参数名命名的文件节点，这些文件的权限值就是传入module_param()的“参数读/写权限”，而文件的内容为参数的值。
除此之外，模块也可以拥有参数数组，形式为“module_param_array(数组名，数组类型，数组长，参数读/写权限)”。从2.6.0-2.6.10版本，需将数组长变量名赋给“数组长”，从2.6.10版本开始，需将数组长变量的指针赋给“数组长”，当不需要保存实际输入的数组元素个数时，可以设置“数组长”为NULL。
运行inmod或modprobe命令时，应使用逗号分隔输入的数组元素。
现在我们定义一个包含两个参数的模块，并观察模块加载时被传递参数和不传递参数时的输出。

#include <linux/init.h>
#include <linux/module.h>
MODULE_LISENCE("Dual BSD/GPL");

static char *book_name = "dissecting Linux Device Driver";
static int num = 4000;

static int book_init(void)
{
    printk(KERN_INFO"book name:%s\n",book_name);
    printk(KERN_INFO"book num:%d\n",num);
    return 0;
}

static void book_exit(void)
{
    printk(KERN_ALERT"Book module exit\n");
}

module_init(book_init);
module_exit(book_exit);
module_param(num,int,S_IRUGO);
module_param(book_name,charp,S_IRUGO);

MODULE_AUTHOR("Song Baohua,author@linuxdriver.cn");
MODULE_DESCRIPTION("A simple Module for testing module params");
MODULE_VERSION("V1.0");

对上述模块运行“insmod book.ko”命令加载，相应输出都为模块内的默认值，通过查看“var/log/messages”日志文件可以看到内核的输出，如下所示：

当用户运行“insmod book.ko book_name=’GoodBook’num=5000”命令时，输出的是用户传递的参数，如下所示：

4.6 导出符号

Linux2.6的“/proc/kallsyms”文件对应着内核符号表，它记录了符号以及符号所在的内存地址。
模块可以使用如下宏导出符号到内核符号表：

EXPORT_SYMBOL(符号名);
EXPORT_SYMBOL_GPL(符号名);

导出的符号将可以被其他模块使用，使用前声明一下即可。EXPORT_SYMBOL_GPL()只适合于包含GPL许可权的模块。下列代码给出了一个导出整数加、减运算符号的内核模块的例子（这些导出符号没有实际意义，只是为了演示）。

#include <linux/init.h>
#include <linux/module.h>
MODULE_LISENCE("Dual BSD/GPL");

int add_integar(int a,int b)
{
    return a+b;
}

int sub_integar(int a,int b)
{
    return a-b;
}

EXPORT_SYMBOL(add_integar);
EXPORT_SYMBOL(sub_integar);

从“/proc/kallsyms”文件中找出add_integar、sub_integar相关信息：

4.7 模块声明与描述

在Linux内核模块中，我们可以用MODULE_AUTHOR、MODULE_DESCROIPTION、MODULE_VERSION、MODULE_DEVICE_TABLE、MODULE_ALIAS分别声明模块的作者、描述、版本、设备表和别名，例如：

MODULE_AUTHOR(author);
MODULE_DESCROIPTION(description);
MODULE_VERSION(version_string);
MODULE_DEVICE_TABLE(table_info);
MODULE_ALIAS(alternate_name);

对于USB、PCI等设备驱动，通常会创建一个MODULE_DEVICE_TABLE，如下所示：

//对应此驱动的设备表
static struct usb_device_id skel_table[] = {
    {USB_DEVICE(USB_SKEL_VENDOR_ID,USB_SKEL_PRODUCT_ID)},
    {}//表结束
};
MODULE_DEVICE_TABLE(usb,skel_table);

此时，并不需要读者理解MODULE_DEVICE_TABLE的作用。

4.8 模块的使用计数

Linux2.4内核中，模块自身通过MOD_INC_USE_COUNT、MOD_DEC_USE_COUNT宏来管理自己被使用的计数。
Linux2.6内核提供了模块计数管理接口try_module_get(&module)和module_put(&module)。从而取代Linux2.4内核中的模块使用计数管理宏。模块的实用计数一般不必由模块自身管理，而且模块计数管理还考虑了SMP与PREEMPT机制的影响。

int try_module_get(struct module *module);

该函数用于增加模块使用计数；若返回0，表示调用失败，希望使用的模块没有被加载或正在被卸载中。

void module_put(struct module *module);

该函数用于减少模块使用计数。
try_module_get()与module_put()的引入与使用与Linux2.6内核下的设备模型密切相关。Linux2.6内核为不同类型的设备定义了struct module *owner域，用来指向管理此设备的模块。当开始使用某个设备时，内核使用try_module_get(dev->owner)去增加管理此设备的owner模块的使用计数；当不再使用此设备时，内核使用module_put(dev->owner)减少对管理此设备的owner模块的使用计数。这样，当设备在使用时，管理此设备的模块将不再被使用时，模块才允许被卸载。
在Linux2.6内核下，对于设备驱动工程师来说，很少需要亲自调用try_module_get()与module_put()，因此此时开发人员所写的驱动通常为支持某具体设备的owner模块，对此设备owner模块的计数管理由内核更底层的代码（如总线驱动或是此类设备公用的核心模块）来实现，从而简化了设备驱动的开发。

4.9 模块的编译

我们可以为之前的一份代码编写一份简单的Makefile，如下所示：

obj-m := hello.o

并使用如下命令编译Hello World模块，如下所示：

make -C /usr/src/linux-2.6.15.5/ M=/driver_study/ modules

如果当前处于模块所在的目录，则以下命令与上述命令相等：

[root@localhost driver_study]#make -C /usr/src/linux-2.6.15.5/ M=/driver_study/ modules
make: Entering directory '/usr/src/linux-2.6.15.5'
CC [M] /driver_study/hello.o
Building modules, stage 2.
MODPOST
CC     /driver_study/hello.mod.o
LD [M] /driver_study/hello.ko
make: Leaving directory '/usr/src/linux-2.6.15.5'

从中可以看出，编译过程中经历了这样的步骤：先进入Linux内核所在的目录，并编译出hello.o文件，运行MODPOST会生成临时的hello.mod.c文件，而后根据此文件编译出hello.mod.o，之后连接hello.o和hello.mod.o文件得到模块目标文件hello.ko，最后离开Linux内核所在的目录。
中间生成的hello.mod.c文件的源代码如下所示：

#include <linux/module.h>
#include <linux/vermagic.h>
#include <linux/compiler.h>
MODULE_INFO(vermagic,VERMAGIC_STRIGN)

struct module__this_module
__attribute__((section(".gnu.linkonce.this_module"))) = {
    .name = KBUILD_MODNAME,
    .init = init_module,
#ifdef CONFIG_MODULE_UNLOAD
    .exit = cleanup_module
#endif
};

static const char __module_depends[]
__attribute_used__
__attribute__((section(".modinfo"))) = 
"depends=";

hello.mod.o产生ELF（Linux所采用的可执行/可连接的文件格式）的两个节，即modinfo和.gnu.linkonce.this_module。
如果一个模块包括多个.c文件（如file1.c、file2.c），则应该以如下方式编写Makefile：

obj-m := modulename.o
module-objs := file1.o file2.o

4.10 模块与GPL

对于自己编写的驱动等内核代码，如果不编译为模块则无法绕开GPL，编译为模块后企业在产品中使用模块，则公司对外不再需要提供对应的源代码，为了使公司产品所使用的Linux操作系统支持模块，需要完成如下工作。

1. 在内核编译时应该选上“Enable loadable module support”，嵌入式产品一般不需要动态卸载模块，所以“可以卸载模块不用选”，当然选了也没有关系，如下图所示。
   
   如果有项目被选择“M”，则编译时除了make bzImage以外，也要make modules。
2. 将我们编译的内核模块.ko文件放置在目标文件系统的相关目录中。
3. 产品的文件系统中应该包含了支持新内核的insmod、lsmod、rmmod等工具，由于嵌入式产品中一般不需要建立模块间依赖关系，所以modprobe可以不要，一般也不需要卸载模块，所以rmmod也可以不要。
4. 在使用中用户可使用insmod命令手动记载模块，如insmod xxx.ko。
5. 但是一般而言，产品在启动过程中应该加载模块，在嵌入式Linux的启动过程中，加载企业自己的模块的最简单的方法是修改启动过程中的rc脚本，增加inmod /…/xxx.ko这样的命令。如某设备正在使用的Linux系统中包含如下rc脚本：

   mount /proc
   mount /var
   mount /dev/pts
   mkdir /var/log
   mkdir /var/run
   mkdir /var/ftp
   mkdir -p /var/spool/cron
   mkdir /var/config
   ...
   insmod /usr/lib/company_driver.ko 2> /dev/null
   /usr/bin/userprocess
   /var/config/rc

4.11 总结

本章主要讲解了Linux内核模块的概念和基本的编程方法。内核模块由加载/卸载函数、功能函数以及一些列声明组成，它可以被传入参数，也可以导出符号供其他模块使用。
由于Linux设备驱动以内核模块的形式而存在，因此，掌握这一章的内容是编写任何设备驱动所必须的。在具体的设备驱动开发中，将驱动编译为模块也有很强的工程意义，因为如果将正在开发中的驱动直接编译入内核，而开发过程中会不断修改驱动的代码，则需要不断地编译内核并重启Linux，但是如果编译为模块，则只需要rmmod并insmod即可，开发效率大为提高。