linux kernel的cmdline參數解析原理分析
Kernel 版本:3.4.55
Kernel啟動時會解析cmdline,然後依據這些參數如console root來進行配置執行。
Cmdline是由bootloader傳給kernel。如uboot。將須要傳給kernel的參數做成一個tags鏈表放在ram中,將首地址傳給kernel,kernel解析tags來獲取cmdline等信息。
Uboot傳參給kernel以及kernel怎樣解析tags能夠看我的另一篇博文,鏈接例如以下:
http://blog.csdn.net/skyflying2012/article/details/35787971
依據我的思路(時間順序,怎樣開始,怎樣結束)。首先看kernel下2種參數的註冊。
第一種是kernel通用參數。如console=ttyS0,115200 root=/rdinit/init等。
這裏以console為例。
另外一種是kernel下各個driver中須要的參數,在寫driver中,假設須要一些啟動時可變參數。能夠在driver最後增加module_param()來註冊一個參數。kernel啟動時由cmdline指定該參數的值。
這裏以drivers/usb/gadget/serial.c中的use_acm參數為例(這個樣例有點偏。。由於近期在調試usb虛擬串口)
一 kernel通用參數
對於這類通用參數,kernel留出單獨一塊data段,叫.ini.setup段。在arch/arm/kernel/vmlinux.lds中:
.init.data : { *(.init.data) *(.cpuinit.data) *(.meminit.data) *(.init.rodata) *(.cpuinit.rodata) *(.meminit.rodata) . = ALIGN(32); __dtb_star . = ALIGN(16); __setup_start = .; *(.init.setup) __setup_end = .; __initcall_start = .; *(.initcallearly.init) __initcall0_start = .; *(.initcall0.init) *(.initcall0s.init) __initcall1_start = __con_initcall_start = .; *(.con_initcall.init) __con_initcall_end = .; __security_initcall_start = .; *(.security_initcall.init) __security_initcall_end = .; . = ALIGN(4); __initramfs_start = .; *(.init.ramfs) . = ALIGN(8); *(.init.ramfs.info) }
能夠看到init.setup段起始__setup_start和結束__setup_end。
.init.setup段中存放的就是kernel通用參數和相應處理函數的映射表。
在include/linux/init.h中
struct obs_kernel_param { const char *str; int (*setup_func)(char *); int early; }; /* * Only for really core code. See moduleparam.h for the normal way. * * Force the alignment so the compiler doesn‘t space elements of the * obs_kernel_param "array" too far apart in .init.setup. */ #define __setup_param(str, unique_id, fn, early) static const char __setup_str_##unique_id[] __initconst __aligned(1) = str; static struct obs_kernel_param __setup_##unique_id __used __section(.init.setup) __attribute__((aligned((sizeof(long))))) = { __setup_str_##unique_id, fn, early } #define __setup(str, fn) __setup_param(str, fn, fn, 0) /* NOTE: fn is as per module_param, not __setup! Emits warning if fn * returns non-zero. */ #define early_param(str, fn) __setup_param(str, fn, fn, 1)
能夠看出宏定義__setup以及early_param定義了obs_kernel_param結構體。該結構體存放參數和相應處理函數。存放在.init.setup段中。
能夠想象,假設多個文件裏調用該宏定義,在鏈接時就會依據鏈接順序將定義的obs_kernel_param放到.init.setup段中。
以console為例。在/kernel/printk.c中,例如以下:
static int __init console_setup(char *str) { ....... } __setup("console=", console_setup);
__setup宏定義展開,例如以下:
Static struct obs_kernel_param __setup_console_setup __used_section(.init.setup) __attribute__((aligned((sizeof(long)))) = { .name = “console=”, .setup_func = console_setup, .early = 0 }
__setup_console_setup編譯時就會鏈接到.init.setup段中,kernel執行時就會依據cmdline中的參數名與.init.setup段中obs_kernel_param的name對照。
匹配則調用console-setup來解析該參數,console_setup的參數就是cmdline中console的值,這是後面參數解析的大體過程了。
二 driver自己定義參數
對於driver自己定義參數。kernel留出rodata段一部分,叫__param段,在arch/arm/kernel/vmlinux.lds中。例如以下:
__param : AT(ADDR(__param) - 0) { __start___param = .; *(__param) __stop___param = .; }
該段放在.rodata段中。
那該段中存放的是什麽樣的數據呢?
Driver中使用module_param來註冊參數,跟蹤這個宏定義。終於就會找到對__param段的操作函數例如以下:
/* This is the fundamental function for registering boot/module parameters. */ #define __module_param_call(prefix, name, ops, arg, perm, level) /* Default value instead of permissions? */ static int __param_perm_check_##name __attribute__((unused)) = BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2)) + BUILD_BUG_ON_ZERO(sizeof(""prefix) > MAX_PARAM_PREFIX_LEN); static const char __param_str_##name[] = prefix #name; static struct kernel_param __moduleparam_const __param_##name __used __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) = { __param_str_##name, ops, perm, level, { arg } } ........ #define module_param(name, type, perm) module_param_named(name, name, type, perm) #define module_param_named(name, value, type, perm) param_check_##type(name, &(value)); module_param_cb(name, ?m_ops_##type, &value, perm); __MODULE_PARM_TYPE(name, #type) #define module_param_cb(name, ops, arg, perm) __module_param_call(MODULE_PARAM_PREFIX, name, ops, arg, perm, -1)
以driver/usb/gadget/serial.c中的use_acm為例,例如以下:
static bool use_acm = true; module_param(use_acm, bool, 0);
Module_param展開到__module_param_call。例如以下:
Static bool use_acm = true; Param_check_bool(use_acm, &(use_acm)); __module_param_call(MODULE_PARAM_PREFIX, use_acm, ?m_ops_bool, &(use_acm, 0, -1)); __MODULE_PARAM_TYPE(use_acm, bool);
將__module_param_call展開,能夠看到是定義了結構體kernel_param,例如以下:
Static struct kernel_param __moduleparam_const __param_use_acm __used __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) = { .name = MODULE_PARAM_PREFIX#use_acm, .ops = ?m_ops_bool, .Perm=0, .level = -1. .arg = &use_acm }
非常清楚,跟.init.setup段一樣,kernel鏈接時會依據鏈接順序將定義的kernel_param放在__param段中。
Kernel_param有3個成員變量須要註意:
(1)
ops=param_ops_bool,是kernel_param_ops結構體,定義例如以下:
struct kernel_param_ops param_ops_bool = { .set = param_set_bool, .get = param_get_bool, };
這2個成員函數分別去設置和獲取參數值
在kernel/param.c中能夠看到kernel默認支持的driver參數類型有bool byte short ushort int uint long ulong string(字符串) charp(字符串指針)array等。
對於默認支持的參數類型,param.c中提供了kernel_param_ops來處理相應類型的參數。
(2)
Arg = &use_acm,宏定義展開,能夠看到arg中存放use_acm的地址。
參數設置函數param_set_bool(const char *val, const struct kernel_param *kp)
將val值設置到kp->arg地址上。也就是改變了use_acm的值,從而到達傳遞參數的目的。
(3)
.name=MODULE_PARAM_PREFIX#use_acm,定義了該kernel_param的name。
MODULE_PARAM_PREFIX非常重要,定義在include/linux/moduleparam.h中:
* You can override this manually, but generally this should match the module name. */ #ifdef MODULE #define MODULE_PARAM_PREFIX /* empty */ #else #define MODULE_PARAM_PREFIX KBUILD_MODNAME "." #endif
假設我們是模塊編譯(make modules)。則MODULE_PARAM_PREFIX為empty。
在模塊傳參時,參數名為use_acm,如insmod g_serial.ko use_acm=0
正常編譯kernel,MODULE_PARAM_PREFIX為模塊名+”.”
假設我們在傳參時不知道自己的模塊名是什麽。能夠在自己的驅動中加打印,將MODULE_PARAM_PREFIX打印出來,來確定自己驅動的模塊名。
所以這裏將serial.c編入kernel,依據driver/usb/gadget/Makefile,例如以下:
g_serial-y := serial.o .... obj-$(CONFIG_USB_G_SERIAL) += g_serial.o
終於是生成g_serial.o,模塊名為g_serial.ko。.name = g_serial.use_acm。
kernel傳參時,該參數名為g_serial.use_acm
這樣處理防止kernel下眾多driver中出現重名的參數。
能夠看出,對於module_param註冊的參數。假設是kernel默認支持類型,kernel會提供參數處理函數。
假設不是kernel支持參數類型。則須要自己去實現param_ops##type了。
這個能夠看drivers/video/uvesafb.c中的scroll參數的註冊(又有點偏。。。
無意間找到的)。
參數註冊是在kernel編譯鏈接時完畢的(鏈接器將定義結構體放到.init.setup或__param中)
接下來須要分析kernel啟動時怎樣對傳入的cmdline進行分析。
三 kernel對cmdline的解析
依據我之前寫的博文可知,start_kernel中setup_arch中解析tags獲取cmdline,復制到boot_command_line中。我們接著往下看start_kernel。
調用setup_command_line,將cmdline拷貝2份,放在saved_command_line static_command_line。
以下調用parse_early_param(),例如以下:
void __init parse_early_options(char *cmdline) { parse_args("early options", cmdline, NULL, 0, 0, 0, do_early_param); } /* Arch code calls this early on, or if not, just before other parsing. */ void __init parse_early_param(void) { static __initdata int done = 0; static __initdata char tmp_cmdline[COMMAND_LINE_SIZE]; if (done) return; /* All fall through to do_early_param. */ strlcpy(tmp_cmdline, boot_command_line, COMMAND_LINE_SIZE); parse_early_options(tmp_cmdline); done = 1; } Parse_early_param拷貝cmdline到tmp_cmdline中一份。終於調用parse_args,例如以下: /* Args looks like "foo=bar,bar2 baz=fuz wiz". */ int parse_args(const char *name, char *args, const struct kernel_param *params, unsigned num, s16 min_level, s16 max_level, int (*unknown)(char *param, char *val)) { char *param, *val; pr_debug("Parsing ARGS: %s\n", args); /* Chew leading spaces */ args = skip_spaces(args); while (*args) { int ret; int irq_was_disabled; args = next_arg(args, ?m, &val); irq_was_disabled = irqs_disabled(); ret = parse_one(param, val, params, num, min_level, max_level, unknown); if (irq_was_disabled && !irqs_disabled()) { printk(KERN_WARNING "parse_args(): option ‘%s‘ enabled " "irq‘s!\n", param); } switch (ret) { case -ENOENT: printk(KERN_ERR "%s: Unknown parameter `%s‘\n", name, param); return ret; case -ENOSPC: printk(KERN_ERR "%s: `%s‘ too large for parameter `%s‘\n", name, val ?: "", param); return ret; case 0: break; default: printk(KERN_ERR "%s: `%s‘ invalid for parameter `%s‘\n", name, val ?: "", param); return ret; } } /* All parsed OK. */ return 0; } ..... void __init parse_early_options(char *cmdline) { parse_args("early options", cmdline, NULL, 0, 0, 0, do_early_param); }
Parse_args遍歷cmdline。依照空格分割獲取參數,對全部參數調用next_arg獲取參數名param和參數值val。
如console=ttyS0,115200。則param=console,val=ttyS0,115200。調用parse_one。例如以下:
static int parse_one(char *param, char *val, const struct kernel_param *params, unsigned num_params, s16 min_level, s16 max_level, int (*handle_unknown)(char *param, char *val)) { unsigned int i; int err; /* Find parameter */ for (i = 0; i < num_params; i++) { if (parameq(param, params[i].name)) { if (params[i].level < min_level || params[i].level > max_level) return 0; /* No one handled NULL, so do it here. */ if (!val && params[i].ops->set != param_set_bool && params[i].ops->set != param_set_bint) return -EINVAL; pr_debug("They are equal! Calling %p\n", params[i].ops->set); mutex_lock(?m_lock); err = params[i].ops->set(val, ?ms[i]); mutex_unlock(?m_lock); return err; } } if (handle_unknown) { pr_debug("Unknown argument: calling %p\n", handle_unknown); return handle_unknown(param, val); } pr_debug("Unknown argument `%s‘\n", param); return -ENOENT; }
由於從parse_early_options傳入的num_params=0,所以parse_one是直接走的最後handle_unknown函數。該函數是由parse-early_options傳入的do_early_param。例如以下:
static int __init do_early_param(char *param, char *val) { const struct obs_kernel_param *p; for (p = __setup_start; p < __setup_end; p++) { if ((p->early && parameq(param, p->str)) || (strcmp(param, "console") == 0 && strcmp(p->str, "earlycon") == 0) ) { if (p->setup_func(val) != 0) printk(KERN_WARNING "Malformed early option ‘%s‘\n", param); } } /* We accept everything at this stage. */ return 0; }
Do_early_param遍歷.init.setup段。假設有obs_kernel_param的early為1。或cmdline中有console參數而且obs_kernel_param有earlycon參數,則會調用該obs_kernel_param的setup函數來解析參數。
Do_early_param會對cmdline中優先級較高的參數進行解析。我翻了下kernel源代碼找到一個樣例。就是arch/arm/kernel/early_printk.c,利用cmdline參數earlyprintk來註冊最早的一個console,有興趣大家能夠參考下。
假設想kernel啟動中盡早打印輸出。方便調試。能夠註冊str為earlycon的obs_kernel_param。
在其setup參數處理函數中register_console。註冊一個早期的console。從而是printk信息正常打印。這個在後面我還會總結一篇kernel打印機制來說這個問題。
do_early_param是為kernel中須要盡早配置的功能(如earlyprintk earlycon)做cmdline的解析。
Do_early_param就說道這裏,該函數並沒有處理我們常常使用的kernel通用參數和driver自己定義參數。接著往下看。代碼例如以下:
setup_arch(&command_line); mm_init_owner(&init_mm, &init_task); mm_init_cpumask(&init_mm); setup_command_line(command_line); setup_nr_cpu_ids(); setup_per_cpu_areas(); smp_prepare_boot_cpu(); /* arch-specific boot-cpu hooks */ build_all_zonelists(NULL); page_alloc_init(); printk(KERN_NOTICE "Kernel command line: %s\n", boot_command_line); parse_early_param(); parse_args("Booting kernel", static_command_line, __start___param, __stop___param - __start___param, -1, -1, &unknown_bootoption);
Parse_early_param結束後,start_kernel調用了parse_args。這次調用,不像parse_early_param中調用parse_args那樣kernel_param指針都為NULL。而是指定了.__param段。
回到上面看parse_args函數,params參數為.__param段起始地址,num為kernel_param個數。
Min_level,max_level都為-1.unknown=unknown_bootoption
Parse_args還是像之前那樣。遍歷cmdline,分割獲取每一個參數的param和val,對每一個參數調用parse_one。
回看Parse_one函數源代碼:
(1)parse_one首先會遍歷.__param段中全部kernel_param,將其name與參數的param對照,同名則調用該kernel_param成員變量kernel_param_ops的set方法來設置參數值。
聯想前面講driver自己定義參數樣例use_acm,cmdline中有參數g_serial.use_acm=0,則在parse_one中遍歷匹配在serial.c中註冊的__param_use_acm,調用param_ops_bool的set函數,從而設置use_acm=0.
(2)假設parse_args傳給parse_one是kernel通用參數,如console=ttyS0,115200。則parse_one前面遍歷.__param段不會找到匹配的kernel_param。就走到後面調用handle_unknown。就是parse_args傳來的unknown_bootoption。代碼例如以下:
/* * Unknown boot options get handed to init, unless they look like * unused parameters (modprobe will find them in /proc/cmdline). */ static int __init unknown_bootoption(char *param, char *val) { repair_env_string(param, val); /* Handle obsolete-style parameters */ if (obsolete_checksetup(param)) return 0; /* Unused module parameter. */ if (strchr(param, ‘.‘) && (!val || strchr(param, ‘.‘) < val)) return 0; if (panic_later) return 0; if (val) { /* Environment option */ unsigned int i; for (i = 0; envp_init[i]; i++) { if (i == MAX_INIT_ENVS) { panic_later = "Too many boot env vars at `%s‘"; panic_param = param; } if (!strncmp(param, envp_init[i], val - param)) break; } envp_init[i] = param; } else {</span>
<span style="font-size:14px;"> /* Command line option */ unsigned int i; for (i = 0; argv_init[i]; i++) { if (i == MAX_INIT_ARGS) { panic_later = "Too many boot init vars at `%s‘"; panic_param = param; } } argv_init[i] = param; } return 0; }
首先repair_env_string會將param val又一次組合為param=val形式。
Obsolete_checksetup則遍歷-init_setup段全部obs_kernel_param,如有param->str與param匹配,則調用param_>setup進行參數值配置。
這裏須要註意的一點是repair_env_string將param又一次拼成了param=val形式。後面遍歷匹配都是匹配的”param=”而不是“param”。
如之前分析kernel通用參數所舉樣例,__setup(“console=”, console_setup)。
Console=ttyS0。115200,obsolete_checksetup是匹配前面console=,假設匹配,則跳過console=。獲取到其值ttyS0,115200。調用其詳細的setup函數來解析設置參數值。
能夠想象,parse_one對於parse_args傳來的每一個cmdline參數都會將.__param以及-init.setup段遍歷匹配,匹配到str或name一致,則調用其相應的set或setup函數進行參數值解析或設置。
Start_kernel中Parse_args結束,kernel的cmdline就解析完畢。
總結下kernel的參數解析:
(1)kernel編譯鏈接。利用.__param .init.setup段將kernel所需參數(driver及通用)和相應處理函數的映射表(obs_kernel_param kernel_param結構體)存放起來。
(2)Kernel啟動,do_early_param處理kernel早期使用的參數(如earlyprintk earlycon)
(3)parse_args對cmdline每一個參數都遍歷__param .init.setup進行匹配,匹配成功,則調用相應處理函數進行參數值的解析和設置。
另一點非常值得思考,kernel下對於這樣的映射處理函數表方式還有非常多使用。
比方之前博文中uboot傳參給kernel,kernel對於不同tags的處理函數也是以該種方式來映射的。
kernel下driver私有結構體的回調處理函數也有這個思想哇!
linux kernel的cmdline參數解析原理分析