Linux内核模块参数传递与sysfs文件系统
嵌入式技术
1368人已加入
描述
一、前言
Linux应用开发中，为使应用程序更加灵活地执行用户的预期功能，我们有时候会通过命令行传递一些参数到main函数中，使得代码逻辑可以依据参数执行不同的任务。同样，Linux内核也提供了类似main函数传参的内核传参机制，编写内核程序时只要实现传参接口，用户在加载内核模块时即可传入指定参数，使得内核模块更加灵活。
二、内核模块传参
1、内核模块传参意义
内核模块传参会使得程序更加灵活，可以向上适配复杂的应用程序，向下兼容不同硬件设备；同时，通过参数选择，可以避免重新编译内核模块，省时省力；另外，通过内核模块传递参数也能更好地兼容和迭代产品。
2、内核传参实现
内核支持传递的参数类型包含了C语言中常用的数据类型。
- 基本类型，字符型（char）、布尔型（bool）、整型（int）、长整型（long）、短整型（short），以及相关的无符号整型（unsigned）、字符指针（charp，内存为用户提供的字符串分配，即char *）、颠倒了值的bool类型（invbool）
- 数组（array）
- 字符串（string）
实现内核模块传参，只需在内核模块程序中调用module_param系列宏即可，module_param系列宏位于“/include/linux/moduleparam.h”中定义，包括module_param_array、module_param_string、module_param_cb。
#define module_param(name, type, perm) module_param_named(name, name, type, perm)
#define module_param_array(name, type, nump, perm) module_param_array_named(name, name, type, nump, perm)
#define module_param_string(name, string, len, perm) static const struct kparam_string __param_string_##name = { len, string }; __module_param_call(MODULE_PARAM_PREFIX, name, ¶m_ops_string, .str = &__param_string_##name, perm, -1, 0); __MODULE_PARM_TYPE(name, "string")
#define module_param_cb(name, ops, arg, perm) __module_param_call(MODULE_PARAM_PREFIX, name, ops, arg, perm, -1, 0)
module_param用于处理基本类型参数，module_param_array用于处理数组类型参数，module_param_string用于处理字符串类型参数。
1）基本类型
module_param(name, type, perm)
name，内核模块程序中的变量名称，同时又是用户传入参数时的名称type，参数类型，见上面perm，该参数指定sysfs中相应文件的访问权限，访问权限与linux文件访问权限相同的方式管理，位于"/include/linux/stat.h"定义，一般使用S_IRUGO；也可以直接用数字表示，如0444表示S_IRUGO
/* include/linux/stat.h */
#define S_IRWXUGO (S_IRWXU|S_IRWXG|S_IRWXO) /* 所有用户可读、写、执行 */
#define S_IALLUGO (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)/* 所有用户可读、写、执行*/
#define S_IRUGO (S_IRUSR|S_IRGRP|S_IROTH) /* 所有用户可读 */
#define S_IWUGO (S_IWUSR|S_IWGRP|S_IWOTH) /* 所有用户可写 */
#define S_IXUGO (S_IXUSR|S_IXGRP|S_IXOTH) /* 所有用户可执行 */
/* include/uapi/linux/stat.h */
/* 三者分别表示用于者权限、用户组权限、其他访问者权限
* bit[0]、bit[1]、bit[2]分别表示可执行、可写、可读属性
*/
#define S_IRWXU 00700
#define S_IRUSR 00400
#define S_IWUSR 00200
#define S_IXUSR 00100
#define S_IRWXG 00070
#define S_IRGRP 00040
#define S_IWGRP 00020
#define S_IXGRP 00010
#define S_IRWXO 00007
#define S_IROTH 00004
#define S_IWOTH 00002
#define S_IXOTH 00001
- S_I：只是一个前缀
- R：读。W：写。X：执行
- USR：用户。GRP：组。UGO：用户、组和其他
示例：
static int mode = 1;
static char *p = NULL;
module_param(mode, int , S_IRUGO); /* int型 */
module_param(p, charp, S_IRUGO); /* 指针 */
注：必须写在模块源文件的开头部分（mode和*p是全局的）；该宏不会声明变量，因此在使用宏之前，必须声明变量
2）数组类型
module_param_array(name, type, nump, perm)
name，内核模块程序中数组名称，同时又是用户传入参数时的名称type，数组类型，int、char等nump，指针，指向一个整数，其值表示有多少个参数存放在数组name中,用来接收用户实际传递的数组成员的个数，内核接收到实际用户传递的个数赋值到nump对应地址空间perm，该参数指定sysfs访问权限，位于"/include/linux/stat.h"定义，一般使用S_IRUGO；也可以直接用数字表示，如0444表示S_IRUGO
示例：
static int array[3] = {0};
static int array_size;
module_param_array(array, int, &array_size, S_IRUGO);
3）字符串类型
module_param_string(name, string, len, perm)
name，外部的参数名，可以与内核模块程序中变量名称string相同string，内部的变量名len，以string命名的buffer大小（可以小于buffer的大小，但是没有意义）perm，该参数指定sysfs访问权限(perm为零表示完全关闭相对应的sysfs项)，位于"/include/linux/stat.h"定义，一般使用S_IRUGO；也可以直接用数字表示，如0444表示S_IRUGO
示例：
static char string[6] = {0};
module_param_string(usestr, string, sizeof(string), S_IRUGO);
4）参数回调类型
module_param_cb(name, ops, arg, perm)
name，内核模块程序中的变量名称，同时又是用户传入参数时的名称ops, 指针变量，指向被自定义的回调函数初始化的kernel_param_ops变量arg, 指针变量，指向内核模块程序中的变量名称，保存用户传入的参数值perm, 该参数指定sysfs访问权限，位于"/include/linux/stat.h"定义，一般使用S_IRUGO；也可以直接用数字表示，如0444表示S_IRUGO
这个宏用于在参数（参数）发生变化时注册回调。例如，我使用 module_param 创建了一个参数debug，一旦我加载带有 debug=0 的simple模块，它将创建一个 sysfs 条目。并且我们想在不重新加载模块的情况下打开调试消息，我们可以使用该文件：
[root@localhost tmp23]# ls -l /sys/module/simple/parameters/debug
-rw-r--r-- 1 root root 4096 May 23 14:46 /sys/module/simple/parameters/debug
当 sysfs 的值改变时（你可以使用 echo 1 > /sys/module/ 改变），我们可以通过回调得到通知。如果您想在值发生变化时收到通知，我们需要将我们的处理函数注册到它的文件操作结构中，即下面数据结构：
struct kernel_param_ops {
int (*set)(const char *val, const struct kernel_param *kp);
int (*get)(char *buffer, const struct kernel_param *kp);
void (*free)(void *arg);
}
注: module_param_array和module_param调用的是默认的回调函数， module_param_cb支持自定义回调函数
示例：
/*----------------------Module_param_cb()--------------------------------*/
static int debug= 0;
int custom_callback_function(const char *val, const struct kernel_param *kp)
{
int res = param_set_int(val, kp); // Use for write variable
if(res==0) {
printk(KERN_INFO "Call back function called...
");
printk(KERN_INFO "New value of debug = %d
", debug);
return 0;
}
return -1;
}
const struct kernel_param_ops my_param_ops =
{
.set = &custom_callback_function, // Use our setter ...
.get = ¶m_get_int, // .. and standard getter
};
module_param_cb(debug, &my_param_ops, &debug, S_IRUGO|S_IWUSR );
执行echo 1 > /sys/module/simple/parameters/debug后，您可以看到调试变量发生了变化:
[root@localhost ~]# dmesg
[891496.255781] hello... debug=0
[891555.726272] Call back function called...
[891555.726277] New value of debug = 1
5）参数描述
用户向内核模块传递参数时，参数较多的情况下，开发工程师不易全部记住；因此，一般都会增加准确、清晰的参数描述信息，描述不同参数代表的含义，用户调用时首先查询驱动模块的参数描叙信息，进而有目的地传入具体参数。参数描述信息通过MODULE_PARM_DESC宏实现，该宏位于“/include/linux/moduleparam.h”中定义
#define MODULE_PARM_DESC(_parm, desc) __MODULE_INFO(parm, _parm, #_parm ":" desc)
_parm，参数名称desc，描述信息，字符串类型
示例：
static int mode = 0;
module_param(mode, int , S_IRUGO);
MODULE_PARM_DESC(mode, "0:mode0; 1:mode1; 2:mode2");
module_param()和module_param_array()的作用就是让那些全局变量对 insmod 可见，使模块装载时可重新赋值module_param_array()宏的第三个参数用来记录用户 insmod 时提供的给这个数组的元素个数，NULL 表示不关心用户提供的个数module_param()和module_param_array()最后一个参数权限值不能包含让普通用户也有写权限，否则编译报错。这点可参考linux/moduleparam.h中__module_param_call()宏的定义- 字符串数组中的字符串似乎不能包含逗号或者空格，否则一个字符串会被解析成两个或多个
3、内核模块传参实例
编写一个基本的Linux内核模块程序，实现命令行往内核模块传递参数的功能，加载内核模块时传入指定参数。
内核模块源码如下：
#include < linux/module.h >
#include < linux/moduleparam.h >
#include < linux/init.h >
#include < linux/kernel.h >
/*传递整型类型数据*/
static int irq=10;
module_param(irq,int,0660);
MODULE_PARM_DESC(irq,"Interrupt range:1-32");
static int debug=0;
module_param(debug,int,0660);
MODULE_PARM_DESC(debug,"0:non debug mode; 1:debug mode");
/*传递指针类型数据*/
static char *devname = "simpdev";
module_param(devname,charp,0660);
MODULE_PARM_DESC(devname,"device name");
/*
传递数组类型数据
module_param_array(数组名, 元素类型, 元素个数（取地址）, 权限);
*/
static int array[3];
static int count;
module_param_array(array, int, &count, 0660);
MODULE_PARM_DESC(array,"set array value");
/*
传递字符串: module_param_string
(传递参数时的字符串名称, 字符串名称, 字符串大小, 权限);
*/
static char string[20] = {0};
module_param_string(mystr, string, sizeof(string), 0660);
MODULE_PARM_DESC(mystr, "string variable of demonstration");
static int simple_init(void)
{
int i=0;
printk(KERN_WARNING "hello... irq=%d name=%s debug=%d
",irq,devname,debug);
for(i=0;i< 3; i++)
{
printk("array[%d]:%d
", i, array[i]);
}
printk("count=%d
",count);
printk("string=%s
", string);
return 0;
}
static void simple_cleanup(void)
{
printk(KERN_WARNING "bye... irq=%d name=%s debug=%d,count=%d, string=%s
",irq,devname,debug,count,string);
}
module_init(simple_init);
module_exit(simple_cleanup);
MODULE_LICENSE("GPL");