module_param&&MODULE_PARM_DESC

原創

2020-02-22 20:57

在用戶態下編程可以通過main()的來傳遞命令行參數，而編寫一個內核模塊則通過module_param ()
module_param宏是Linux 2.6內核中新增的，該宏被定義在include/linux/moduleparam.h文件中，具體定義如下：
#define module_param(name, type, perm)
module_param_named(name, name, type, perm)

其中使用了 3 個參數:要傳遞的參數變量名, 變量的數據類型, 以及訪問參數的權限。
module_param (name,type,perm);
module_param 使用了 3 個參數: 變量名, 它的類型, 以及一個權限掩碼用來做一個輔助的 sysfs 入口(啥意思). 這個宏定義應當放在任何函數之外, 典型地是出現在源文件的前面.定義如：
static char *whom = "world";
static int howmany = 1;
module_param (howmany, int, S_IRUGO);
module_param (whom, charp, S_IRUGO);
模塊參數支持許多類型:
bool
invbool
一個布爾型( true 或者 false)值(相關的變量應當是 int 類型). invbool 類型顛倒了值, 所以真值變成 false, 反之亦然.
charp
一個字符指針值. 內存爲用戶提供的字串分配, 指針因此設置.
int
long
short
uint
ulong
ushort
基本的變長整型值. 以 u 開頭的是無符號值.

數組參數, 用逗號間隔的列表提供的值, 模塊加載者也支持. 聲明一個數組參數, 使用:

module_param _array(name,type,num,perm);
這裏 name 是你的數組的名子(也是參數名),
type 是數組元素的類型,
num 是一個整型變量,
perm 是通常的權限值.
如果數組參數在加載時設置, num 被設置成提供的數的個數. 模塊加載者拒絕比數組能放下的多的值.

perm參數的作用是什麼？
最後的 module_param 字段是一個權限值; 你應當使用中定義的值. 這個值控制誰可以存取這些模塊參數在 sysfs 中的表示.如果 perm 被設爲 0, 就根本沒有 sysfs 項. 否則, 它出現在 /sys/module下面, 帶有給定的權限. 使用 S_IRUGO 作爲參數可以被所有人讀取, 但是不能改變; S_IRUGO|S_IWUSR 允許 root 來改變參數. 注意, 如果一個參數被 sysfs 修改, 你的模塊看到的參數值也改變了, 但是你的模塊沒有任何其他的通知. 你應當不要使模塊參數可寫, 除非你準備好檢測這個改變並且因而作出反應.
perm參數的作用是什麼？
最後的 module_param 字段是一個權限值,表示此參數在sysfs文件系統中所對應的文件節點的屬性。你應當使用中定義的值. 這個值控制誰可以存取這些模塊參數在 sysfs 中的表示.當perm爲0時，表示此參數不存在 sysfs文件系統下對應的文件節點。否則, 模塊被加載後，在/sys/module/ 目錄下將出現以此模塊名命名的目錄, 帶有給定的權限.。
權限在include/linux/stat.h中有定義
比如：
#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_IRUGO 作爲參數可以被所有人讀取, 但是不能改變; S_IRUGO|S_IWUSR 允許 root 來改變參數. 注意, 如果一個參數被 sysfs 修改, 你的模塊看到的參數值也改變了, 但是你的模塊沒有任何其他的通知. 你應當不要使模塊參數可寫, 除非你準備好檢測這個改變並且因而作出反應.

通過宏MODULE_PARM_DESC()對參數進行說明：
static unsigned short size = 1;
module_param(size, ushort, 0644);
MODULE_PARM_DESC(size, “The size in inches of the fishing pole”
“connected to this computer.” );

module_param() 和module_param_array() 的作用就是讓那些全局變量對insmod 可見，使模塊裝載時可重新賦值。

module_param_array() 宏的第三個參數用來記錄用戶insmod 時提供的給這個數組的元素個數，NULL 表示不關心用戶提供的個數

module_param() 和module_param_array() 最後一個參數權限值不能包含讓普通用戶也有寫權限，否則編譯報錯。這點可參考linux/moduleparam.h 中__module_param_call() 宏的定義。

字符串數組中的字符串似乎不能包含逗號，否則一個字符串會被解析成兩個

一個測試用例：parm_hello.c

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

#defineMAX_ARRAY 6

staticintint_var=0;
staticconstchar*str_var="default";
static int int_array[6];
intnarr;

module_param(int_var,int,0644);
MODULE_PARM_DESC(int_var,"A integer variable");

module_param(str_var,charp,0644);
MODULE_PARM_DESC(str_var,"A string variable");

module_param_array(int_array,int,&narr,0644);
MODULE_PARM_DESC(int_array,"A integer array");

staticint__init hello_init(void)
{
       inti;
       printk(KERN_ALERT"Hello, world.\n");
       printk(KERN_ALERT"int_var %d.\n",int_var);
       printk(KERN_ALERT"str_var %s.\n",str_var);

       for(i=0;i<narr;i++){
               printk("int_array[%d] = %d\n",i,int_array[i]);
       }
       return0;
}

staticvoid__exit hello_exit(void)
{
       printk(KERN_ALERT"Bye, world.\n");
}
module_init(hello_init);
module_exit(hello_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("kelly");
MODULE_DEION("This module is a example.");

測試：insmod parm_hello.ko int_var=100 str_var=hello int_array=100,200