Linux模块编程框架

Linux是单内核系统，可通用计算平台的外围设备是频繁变化的，不可能将所有的(包括将来即将出现的)设备的驱动程序都一次性编译进内核，为了解决这个问题，Linux提出了可加载内核模块(Loadable Kernel Module,LKM)的概念，允许一个设备驱动通过模块加载的方式，在内核运行起来之后"融入"内核，加载进内核的模块和本身就编译进内核的模块一模一样。

一个程序在编译的地址的相对关系就已经确定了，运行的时候只是进行简单的偏移，为了使模块加载进内核后能够被放置在正确的地址，并正确的调用系统的运行的导出符号表，编译模块的时候必须要使用系统的编译地址，并调用系统编译出得静态的导出符号表。即模块必须使用系统的配置环境:Makefile+.config，一旦这两个文件任意一个发生了变化，都很可能导致模块的编译地址与系统的编译地址不匹配，造成运行时的错误甚至宕机。

导出符号表

从提供系统运行效率的角度，一个模块不是也不应该是完全独立的，即一个模块往往会调用其他模块提供的功能来实现自己的功能，这样做能更好实现系统的分工并提高效率。Linux为了实现模块间的相互调用，设计了导出符号表，每个模块都可以将自己的一个私有的标号导出到系统层级，以使该标号对其他模块可见，系统在编译一个模块的时候会自动导出这个模块的导出符号表到modules.syms文件(如果没有导出任何符号，可以为空)，并在加载一个模块的时候会自动将该模块的导出符号表与系统自身的导出符号表合并。一个系统的源码的导出符号表一般在源码顶层目录的modules.syms文件中，查看正在运行的系统导出符号表使用cat /proc/kallsyms。注意，正如前面解释的，我们的模块之所以能够正常运行，一个重要原因就是编译我们模块使用的符号地址就是编译内核时使用的符号地址，所以运行起来虽然地址会有偏移，但是模块中相关的符号的地址也会和内核地址一起偏移，也就还能找得到。基于这种思想，我们也可以直接查看系统当前运行的地址，将地址赋值给一个函数指针并使用，也是没有问题的，当然，这只是阐述原理，并不建议这么写模块。

下面这个例子可以看出编译出的地址和运行时的地址是不一样的：

导出符号表可以大大的提高系统的运行效率，这也是只有开源系统才能提供的一个强大的功能，但是，导出符号表的引入会导致一个小小的麻烦--模块的依赖，当我们使用lsmod的时候，就可以查看系统当前的模块，其最后两列分别是该模块被引用的次数以及引用该模块的内核模块，当一个模块被其他模块引用时，我们是不能进行卸载的，同样，如果模块A依赖于模块B，那么如果模块B不加载的时候模块A也加载不了。在编写多模块的时候尤其要注意这个问题，可以写一个脚本管理多个依赖模块。Linux内核使用两个宏来导出一个模块的符号

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

模块编译方法

借助内核的Makefile，编译出的XXX.ko（Kernel Object）就是可加载到该内核的外部模块，为了利用内核的Makefile，我们可以将编译外部模块的Makefile写成如下的格式：

ifneq ($(KERNELRELEASE),)
    export-objs = demo.o
    obj-m = extern.o
else
    KERNELDIR :=  /lib/modules/$(shell uname -r)/build
	PWD       := $(shell pwd)
all:
    $(MAKE) -C $(KERNELDIR) M=$(PWD) modules

clean:
	$(RM) .tmp_versions Module.symvers modules.order .tmp_versions .*.cmd *.o *.ko *.mod.c
endif

这个简单的Makfile是利用ubuntu主机的源码Makefile来编译模块，学习模块编程的开始阶段在主机进行编译调试更方便一点，下面我解释一下这个Makefile，首先，我们的思路还是通过内核的Makefile来准备我们的模块，而内核的Makefile一旦执行，就会给KERNELRELEASE这个变量赋值，所以第一次进入我们这个Makfile的时候，这个变量还是空，所以执行else的部分——给相关的变量赋值，make默认编译第一个目标all，make -C $(KERNELRELEASE)就是进入到KERNELRELEASE指定的目录并执行里面的Makefile，显然，这就是我们内核源码的顶层Makefile，接下来的选项M=$(PWD) modules都是传入这个顶层Makefile的参数，表示我要编译一个模块，这个模块位于M指定的目录，所以内核会进行相关的配置并最终进入到"这个模块所在的目录"，此时，我们的这个Makefile会再被进入一次，这一次是从内核Makefile中跳入这里的，，KERNELRELEASE已经被定义过，内核Makefile想要的就是obj-m后面指定的要编译的目标文件，所以内核Makfile就会找到我们写的模块源文件进行编译。如此我们就得到了能在ubuntu下执行的xxx.ko文件，如果需要在开发板上运行，只需要将内核路径改成开发板运行系统的源码路径即可，同时记得要导出相关的环境变量( ARCH, CROSS_COMPILE )

注册/注销模块

Linux为每个模块都预留了相应的地址，注册模块即让该模块对内核可见，这也是模块工作的先决条件。注册之后，我们就可以通过查看内核输出信息dmesg命令来查看模块的运行情况。经常使用内核函数printk()来输出系统信息进行打印调试。使用insmod XXX.ko加载一个模块,使用rmmod XXX.ko卸载一个模块，使用lsmod查看当前系统中的模块及其引用情况

insmod使用的是init_module()系统调用，这个系统调用的实现是sys_init_module()

rmmod使用delete_module()系统调用，这个系统调用的实现是sys_delete_module()

模块的程序框架

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

/* 构造/析构函数 */
static int __init mydemo_init(void)
{
	//构造设备/驱动对象
	//初始化设备/驱动对象
	//注册设备/驱动对象
	//必要的硬件初始化
}
static void __exit mydemo_exit(void)
{
	//回收资源
	//注销设备/驱动对象
}	

/* 加载/卸载模块 */
module_init(mydemo_init);
module_exit(mydemo_exit);					

/* 授权 */
MODULE_LICENSE("GPL");
MODULE_AUTHOR("XJ");
MODULE_DESCRIPTIPON("mymydemo");

/* 导出符号 */
EXPORT_SYMBOL(data);

注意这里的授权是必须的，如果一个模块没有授权，那么很多需要该授权的函数甚至都不能使用，同理，不合适的授权也会导致模块运行或加载的错误，所以初学者一定不要忽视这个授权，相关授权的选项在"linux/module.h"中，这里我把相关的说明贴出来供大家参考

/*
 * The following license idents are currently accepted as indicating free
 * software modules
 *
 *	"GPL"				[GNU Public License v2 or later]
 *	"GPL v2"			[GNU Public License v2]
 *	"GPL and additional rights"	[GNU Public License v2 rights and more]
 *	"Dual BSD/GPL"			[GNU Public License v2
 *					 or BSD license choice]
 *	"Dual MIT/GPL"			[GNU Public License v2
 *					 or MIT license choice]
 *	"Dual MPL/GPL"			[GNU Public License v2
 *					 or Mozilla license choice]
 *
 * The following other idents are available
 *
 *	"Proprietary"			[Non free products]
 */

另一个细节是Linux内核源码的默认头文件路径是顶层目录的include目录，所以包含头文件的时候include可以省略，

第一个Linux模块

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

static int __init demo_init(void)
{
	printk(KERN_INFO"demo_init:%s,%s,%d"__FILE__,__func__,__LINE__);
	return 0;
}

static void __exit demo_exit(void)
{
	printk(KERN_INFO"demo_exit:%s,%s,%d"__FILE__,__func__,__LINE__);
}

module_init(demo_init);
module_exit(demo_exit);

MODULE_LICENSE("GPL");

执行insmod xjDemo.ko，查看执行结果

模块传参

我们编写的模块还可以在insmod的时候传入参数，Linux提供了几个宏（函数）用于接收外部的参数。模块内部使用这些函数，只需执行insmod xjDemo.ko num=2，insmod mydemo.ko i=10，insmod mydemo.ko extstr="hello" 等命令就可以将参数传入模块

module_param(num,type,perm);    //接收一个传入的int数据
module_param(num,type,perm);    //接收一个传入的charp数据
module_param_array(num,type,nump,perm);               //接收一个数组
module_param_string(name,string,len,perm);            //接收一个字符串
MODULE_PARAM_DESC("parameter description");