1*0a13b6c3SWu XiangCheng.. SPDX-License-Identifier: GPL-2.0 2*0a13b6c3SWu XiangCheng 3*0a13b6c3SWu XiangCheng.. include:: ../disclaimer-zh_CN.rst 4*0a13b6c3SWu XiangCheng 5*0a13b6c3SWu XiangCheng:Original: Documentation/admin-guide/bootconfig.rst 6*0a13b6c3SWu XiangCheng 7*0a13b6c3SWu XiangCheng:译者: 吴想成 Wu XiangCheng <bobwxc@email.cn> 8*0a13b6c3SWu XiangCheng 9*0a13b6c3SWu XiangCheng======== 10*0a13b6c3SWu XiangCheng引导配置 11*0a13b6c3SWu XiangCheng======== 12*0a13b6c3SWu XiangCheng 13*0a13b6c3SWu XiangCheng:作者: Masami Hiramatsu <mhiramat@kernel.org> 14*0a13b6c3SWu XiangCheng 15*0a13b6c3SWu XiangCheng概述 16*0a13b6c3SWu XiangCheng==== 17*0a13b6c3SWu XiangCheng 18*0a13b6c3SWu XiangCheng引导配置扩展了现有的内核命令行,以一种更有效率的方式在引导内核时进一步支持 19*0a13b6c3SWu XiangCheng键值数据。这允许管理员传递一份结构化关键字的配置文件。 20*0a13b6c3SWu XiangCheng 21*0a13b6c3SWu XiangCheng配置文件语法 22*0a13b6c3SWu XiangCheng============ 23*0a13b6c3SWu XiangCheng 24*0a13b6c3SWu XiangCheng引导配置文件的语法采用非常简单的键值结构。每个关键字由点连接的单词组成,键 25*0a13b6c3SWu XiangCheng和值由 ``=`` 连接。值以分号( ``;`` )或换行符( ``\n`` )结尾。数组值中每 26*0a13b6c3SWu XiangCheng个元素由逗号( ``,`` )分隔。:: 27*0a13b6c3SWu XiangCheng 28*0a13b6c3SWu XiangCheng KEY[.WORD[...]] = VALUE[, VALUE2[...]][;] 29*0a13b6c3SWu XiangCheng 30*0a13b6c3SWu XiangCheng与内核命令行语法不同,逗号和 ``=`` 周围允许有空格。 31*0a13b6c3SWu XiangCheng 32*0a13b6c3SWu XiangCheng关键字只允许包含字母、数字、连字符( ``-`` )和下划线( ``_`` )。值可包含 33*0a13b6c3SWu XiangCheng可打印字符和空格,但分号( ``;`` )、换行符( ``\n`` )、逗号( ``,`` )、 34*0a13b6c3SWu XiangCheng井号( ``#`` )和右大括号( ``}`` )等分隔符除外。 35*0a13b6c3SWu XiangCheng 36*0a13b6c3SWu XiangCheng如果你需要在值中使用这些分隔符,可以用双引号( ``"VALUE"`` )或单引号 37*0a13b6c3SWu XiangCheng( ``'VALUE'`` )括起来。注意,引号无法转义。 38*0a13b6c3SWu XiangCheng 39*0a13b6c3SWu XiangCheng键的值可以为空或不存在。这些键用于检查该键是否存在(类似布尔值)。 40*0a13b6c3SWu XiangCheng 41*0a13b6c3SWu XiangCheng键值语法 42*0a13b6c3SWu XiangCheng-------- 43*0a13b6c3SWu XiangCheng 44*0a13b6c3SWu XiangCheng引导配置文件语法允许用户通过大括号合并键名部分相同的关键字。例如:: 45*0a13b6c3SWu XiangCheng 46*0a13b6c3SWu XiangCheng foo.bar.baz = value1 47*0a13b6c3SWu XiangCheng foo.bar.qux.quux = value2 48*0a13b6c3SWu XiangCheng 49*0a13b6c3SWu XiangCheng也可以写成:: 50*0a13b6c3SWu XiangCheng 51*0a13b6c3SWu XiangCheng foo.bar { 52*0a13b6c3SWu XiangCheng baz = value1 53*0a13b6c3SWu XiangCheng qux.quux = value2 54*0a13b6c3SWu XiangCheng } 55*0a13b6c3SWu XiangCheng 56*0a13b6c3SWu XiangCheng或者更紧凑一些,写成:: 57*0a13b6c3SWu XiangCheng 58*0a13b6c3SWu XiangCheng foo.bar { baz = value1; qux.quux = value2 } 59*0a13b6c3SWu XiangCheng 60*0a13b6c3SWu XiangCheng在这两种样式中,引导解析时相同的关键字都会自动合并。因此可以追加类似的树或 61*0a13b6c3SWu XiangCheng键值。 62*0a13b6c3SWu XiangCheng 63*0a13b6c3SWu XiangCheng相同关键字的值 64*0a13b6c3SWu XiangCheng-------------- 65*0a13b6c3SWu XiangCheng 66*0a13b6c3SWu XiangCheng禁止两个或多个值或数组共享同一个关键字。例如:: 67*0a13b6c3SWu XiangCheng 68*0a13b6c3SWu XiangCheng foo = bar, baz 69*0a13b6c3SWu XiangCheng foo = qux # !错误! 我们不可以重定义相同的关键字 70*0a13b6c3SWu XiangCheng 71*0a13b6c3SWu XiangCheng如果你想要更新值,必须显式使用覆盖操作符 ``:=`` 。例如:: 72*0a13b6c3SWu XiangCheng 73*0a13b6c3SWu XiangCheng foo = bar, baz 74*0a13b6c3SWu XiangCheng foo := qux 75*0a13b6c3SWu XiangCheng 76*0a13b6c3SWu XiangCheng这样 ``foo`` 关键字的值就变成了 ``qux`` 。这对于通过添加(部分)自定义引导 77*0a13b6c3SWu XiangCheng配置来覆盖默认值非常有用,免于解析默认引导配置。 78*0a13b6c3SWu XiangCheng 79*0a13b6c3SWu XiangCheng如果你想对现有关键字追加值作为数组成员,可以使用 ``+=`` 操作符。例如:: 80*0a13b6c3SWu XiangCheng 81*0a13b6c3SWu XiangCheng foo = bar, baz 82*0a13b6c3SWu XiangCheng foo += qux 83*0a13b6c3SWu XiangCheng 84*0a13b6c3SWu XiangCheng这样, ``foo`` 关键字就同时拥有了 ``bar`` , ``baz`` 和 ``qux`` 。 85*0a13b6c3SWu XiangCheng 86*0a13b6c3SWu XiangCheng此外,父关键字下可同时存在值和子关键字。 87*0a13b6c3SWu XiangCheng例如,下列配置是可行的。:: 88*0a13b6c3SWu XiangCheng 89*0a13b6c3SWu XiangCheng foo = value1 90*0a13b6c3SWu XiangCheng foo.bar = value2 91*0a13b6c3SWu XiangCheng foo := value3 # 这会更新foo的值。 92*0a13b6c3SWu XiangCheng 93*0a13b6c3SWu XiangCheng注意,裸值不能直接放进结构化关键字中,必须在大括号外定义它。例如:: 94*0a13b6c3SWu XiangCheng 95*0a13b6c3SWu XiangCheng foo { 96*0a13b6c3SWu XiangCheng bar = value1 97*0a13b6c3SWu XiangCheng bar { 98*0a13b6c3SWu XiangCheng baz = value2 99*0a13b6c3SWu XiangCheng qux = value3 100*0a13b6c3SWu XiangCheng } 101*0a13b6c3SWu XiangCheng } 102*0a13b6c3SWu XiangCheng 103*0a13b6c3SWu XiangCheng同时,关键字下值节点的顺序是固定的。如果值和子关键字同时存在,值永远是该关 104*0a13b6c3SWu XiangCheng键字的第一个子节点。因此如果用户先指定子关键字,如:: 105*0a13b6c3SWu XiangCheng 106*0a13b6c3SWu XiangCheng foo.bar = value1 107*0a13b6c3SWu XiangCheng foo = value2 108*0a13b6c3SWu XiangCheng 109*0a13b6c3SWu XiangCheng则在程序(和/proc/bootconfig)中,它会按如下显示:: 110*0a13b6c3SWu XiangCheng 111*0a13b6c3SWu XiangCheng foo = value2 112*0a13b6c3SWu XiangCheng foo.bar = value1 113*0a13b6c3SWu XiangCheng 114*0a13b6c3SWu XiangCheng注释 115*0a13b6c3SWu XiangCheng---- 116*0a13b6c3SWu XiangCheng 117*0a13b6c3SWu XiangCheng配置语法接受shell脚本风格的注释。注释以井号( ``#`` )开始,到换行符 118*0a13b6c3SWu XiangCheng( ``\n`` )结束。 119*0a13b6c3SWu XiangCheng 120*0a13b6c3SWu XiangCheng:: 121*0a13b6c3SWu XiangCheng 122*0a13b6c3SWu XiangCheng # comment line 123*0a13b6c3SWu XiangCheng foo = value # value is set to foo. 124*0a13b6c3SWu XiangCheng bar = 1, # 1st element 125*0a13b6c3SWu XiangCheng 2, # 2nd element 126*0a13b6c3SWu XiangCheng 3 # 3rd element 127*0a13b6c3SWu XiangCheng 128*0a13b6c3SWu XiangCheng会被解析为:: 129*0a13b6c3SWu XiangCheng 130*0a13b6c3SWu XiangCheng foo = value 131*0a13b6c3SWu XiangCheng bar = 1, 2, 3 132*0a13b6c3SWu XiangCheng 133*0a13b6c3SWu XiangCheng注意你不能把注释放在值和分隔符( ``,`` 或 ``;`` )之间。如下配置语法是错误的:: 134*0a13b6c3SWu XiangCheng 135*0a13b6c3SWu XiangCheng key = 1 # comment 136*0a13b6c3SWu XiangCheng ,2 137*0a13b6c3SWu XiangCheng 138*0a13b6c3SWu XiangCheng 139*0a13b6c3SWu XiangCheng/proc/bootconfig 140*0a13b6c3SWu XiangCheng================ 141*0a13b6c3SWu XiangCheng 142*0a13b6c3SWu XiangCheng/proc/bootconfig是引导配置的用户空间接口。与/proc/cmdline不同,此文件内容以 143*0a13b6c3SWu XiangCheng键值列表样式显示。 144*0a13b6c3SWu XiangCheng每个键值对一行,样式如下:: 145*0a13b6c3SWu XiangCheng 146*0a13b6c3SWu XiangCheng KEY[.WORDS...] = "[VALUE]"[,"VALUE2"...] 147*0a13b6c3SWu XiangCheng 148*0a13b6c3SWu XiangCheng 149*0a13b6c3SWu XiangCheng用引导配置引导内核 150*0a13b6c3SWu XiangCheng================== 151*0a13b6c3SWu XiangCheng 152*0a13b6c3SWu XiangCheng用引导配置引导内核有两种方法:将引导配置附加到initrd镜像或直接嵌入内核中。 153*0a13b6c3SWu XiangCheng 154*0a13b6c3SWu XiangCheng*initrd: initial RAM disk,初始内存磁盘* 155*0a13b6c3SWu XiangCheng 156*0a13b6c3SWu XiangCheng将引导配置附加到initrd 157*0a13b6c3SWu XiangCheng---------------------- 158*0a13b6c3SWu XiangCheng 159*0a13b6c3SWu XiangCheng由于默认情况下引导配置文件是用initrd加载的,因此它将被添加到initrd(initramfs) 160*0a13b6c3SWu XiangCheng镜像文件的末尾,其中包含填充、大小、校验值和12字节幻数,如下所示:: 161*0a13b6c3SWu XiangCheng 162*0a13b6c3SWu XiangCheng [initrd][bootconfig][padding][size(le32)][checksum(le32)][#BOOTCONFIG\n] 163*0a13b6c3SWu XiangCheng 164*0a13b6c3SWu XiangCheng大小和校验值为小端序存放的32位无符号值。 165*0a13b6c3SWu XiangCheng 166*0a13b6c3SWu XiangCheng当引导配置被加到initrd镜像时,整个文件大小会对齐到4字节。空字符( ``\0`` ) 167*0a13b6c3SWu XiangCheng会填补对齐空隙。因此 ``size`` 就是引导配置文件的长度+填充的字节。 168*0a13b6c3SWu XiangCheng 169*0a13b6c3SWu XiangChengLinux内核在内存中解码initrd镜像的最后部分以获取引导配置数据。由于这种“背负式” 170*0a13b6c3SWu XiangCheng的方法,只要引导加载器传递了正确的initrd文件大小,就无需更改或更新引导加载器 171*0a13b6c3SWu XiangCheng和内核镜像本身。如果引导加载器意外传递了更长的大小,内核将无法找到引导配置数 172*0a13b6c3SWu XiangCheng据。 173*0a13b6c3SWu XiangCheng 174*0a13b6c3SWu XiangChengLinux内核在tools/bootconfig下提供了 ``bootconfig`` 命令来完成此操作,管理员 175*0a13b6c3SWu XiangCheng可以用它从initrd镜像中删除或追加配置文件。你可以用以下命令来构建它:: 176*0a13b6c3SWu XiangCheng 177*0a13b6c3SWu XiangCheng # make -C tools/bootconfig 178*0a13b6c3SWu XiangCheng 179*0a13b6c3SWu XiangCheng要向initrd镜像添加你的引导配置文件,请按如下命令操作(旧数据会自动移除):: 180*0a13b6c3SWu XiangCheng 181*0a13b6c3SWu XiangCheng # tools/bootconfig/bootconfig -a your-config /boot/initrd.img-X.Y.Z 182*0a13b6c3SWu XiangCheng 183*0a13b6c3SWu XiangCheng要从镜像中移除配置,可以使用-d选项:: 184*0a13b6c3SWu XiangCheng 185*0a13b6c3SWu XiangCheng # tools/bootconfig/bootconfig -d /boot/initrd.img-X.Y.Z 186*0a13b6c3SWu XiangCheng 187*0a13b6c3SWu XiangCheng然后在内核命令行上添加 ``bootconfig`` 告诉内核去initrd文件末尾寻找内核配置。 188*0a13b6c3SWu XiangCheng 189*0a13b6c3SWu XiangCheng将引导配置嵌入内核 190*0a13b6c3SWu XiangCheng------------------ 191*0a13b6c3SWu XiangCheng 192*0a13b6c3SWu XiangCheng如果你不能使用initrd,也可以通过Kconfig选项将引导配置文件嵌入内核中。在此情 193*0a13b6c3SWu XiangCheng况下,你需要用以下选项重新编译内核:: 194*0a13b6c3SWu XiangCheng 195*0a13b6c3SWu XiangCheng CONFIG_BOOT_CONFIG_EMBED=y 196*0a13b6c3SWu XiangCheng CONFIG_BOOT_CONFIG_EMBED_FILE="/引导配置/文件/的/路径" 197*0a13b6c3SWu XiangCheng 198*0a13b6c3SWu XiangCheng``CONFIG_BOOT_CONFIG_EMBED_FILE`` 需要从源码树或对象树开始的引导配置文件的 199*0a13b6c3SWu XiangCheng绝对/相对路径。内核会将其嵌入作为默认引导配置。 200*0a13b6c3SWu XiangCheng 201*0a13b6c3SWu XiangCheng与将引导配置附加到initrd一样,你也需要在内核命令行上添加 ``bootconfig`` 告诉 202*0a13b6c3SWu XiangCheng内核去启用内嵌的引导配置。 203*0a13b6c3SWu XiangCheng 204*0a13b6c3SWu XiangCheng注意,即使你已经设置了此选项,仍可用附加到initrd的其他引导配置覆盖内嵌的引导 205*0a13b6c3SWu XiangCheng配置。 206*0a13b6c3SWu XiangCheng 207*0a13b6c3SWu XiangCheng通过引导配置传递内核参数 208*0a13b6c3SWu XiangCheng======================== 209*0a13b6c3SWu XiangCheng 210*0a13b6c3SWu XiangCheng除了内核命令行,引导配置也可以用于传递内核参数。所有 ``kernel`` 关键字下的键 211*0a13b6c3SWu XiangCheng值对都将直接传递给内核命令行。此外, ``init`` 下的键值对将通过命令行传递给 212*0a13b6c3SWu XiangChenginit进程。参数按以下顺序与用户给定的内核命令行字符串相连,因此命令行参数可以 213*0a13b6c3SWu XiangCheng覆盖引导配置参数(这取决于子系统如何处理参数,但通常前面的参数将被后面的参数 214*0a13b6c3SWu XiangCheng覆盖):: 215*0a13b6c3SWu XiangCheng 216*0a13b6c3SWu XiangCheng [bootconfig params][cmdline params] -- [bootconfig init params][cmdline init params] 217*0a13b6c3SWu XiangCheng 218*0a13b6c3SWu XiangCheng如果引导配置文件给出的kernel/init参数是:: 219*0a13b6c3SWu XiangCheng 220*0a13b6c3SWu XiangCheng kernel { 221*0a13b6c3SWu XiangCheng root = 01234567-89ab-cdef-0123-456789abcd 222*0a13b6c3SWu XiangCheng } 223*0a13b6c3SWu XiangCheng init { 224*0a13b6c3SWu XiangCheng splash 225*0a13b6c3SWu XiangCheng } 226*0a13b6c3SWu XiangCheng 227*0a13b6c3SWu XiangCheng这将被复制到内核命令行字符串中,如下所示:: 228*0a13b6c3SWu XiangCheng 229*0a13b6c3SWu XiangCheng root="01234567-89ab-cdef-0123-456789abcd" -- splash 230*0a13b6c3SWu XiangCheng 231*0a13b6c3SWu XiangCheng如果用户给出的其他命令行是:: 232*0a13b6c3SWu XiangCheng 233*0a13b6c3SWu XiangCheng ro bootconfig -- quiet 234*0a13b6c3SWu XiangCheng 235*0a13b6c3SWu XiangCheng则最后的内核命令行如下:: 236*0a13b6c3SWu XiangCheng 237*0a13b6c3SWu XiangCheng root="01234567-89ab-cdef-0123-456789abcd" ro bootconfig -- splash quiet 238*0a13b6c3SWu XiangCheng 239*0a13b6c3SWu XiangCheng 240*0a13b6c3SWu XiangCheng配置文件的限制 241*0a13b6c3SWu XiangCheng============== 242*0a13b6c3SWu XiangCheng 243*0a13b6c3SWu XiangCheng当前最大的配置大小是32KB,关键字总数(不是键值条目)必须少于1024个节点。 244*0a13b6c3SWu XiangCheng注意:这不是条目数而是节点数,条目必须消耗超过2个节点(一个关键字和一个值)。 245*0a13b6c3SWu XiangCheng所以从理论上讲最多512个键值对。如果关键字平均包含3个单词,则可有256个键值对。 246*0a13b6c3SWu XiangCheng在大多数情况下,配置项的数量将少于100个条目,小于8KB,因此这应该足够了。如果 247*0a13b6c3SWu XiangCheng节点数超过1024,解析器将返回错误,即使文件大小小于32KB。(请注意,此最大尺寸 248*0a13b6c3SWu XiangCheng不包括填充的空字符。) 249*0a13b6c3SWu XiangCheng无论如何,因为 ``bootconfig`` 命令在附加启动配置到initrd映像时会验证它,用户 250*0a13b6c3SWu XiangCheng可以在引导之前注意到它。 251*0a13b6c3SWu XiangCheng 252*0a13b6c3SWu XiangCheng 253*0a13b6c3SWu XiangCheng引导配置API 254*0a13b6c3SWu XiangCheng=========== 255*0a13b6c3SWu XiangCheng 256*0a13b6c3SWu XiangCheng用户可以查询或遍历键值对,也可以查找(前缀)根关键字节点,并在查找该节点下的 257*0a13b6c3SWu XiangCheng键值。 258*0a13b6c3SWu XiangCheng 259*0a13b6c3SWu XiangCheng如果您有一个关键字字符串,则可以直接使用 xbc_find_value() 查询该键的值。如果 260*0a13b6c3SWu XiangCheng你想知道引导配置里有哪些关键字,可以使用 xbc_for_each_key_value() 迭代键值对。 261*0a13b6c3SWu XiangCheng请注意,您需要使用 xbc_array_for_each_value() 访问数组的值,例如:: 262*0a13b6c3SWu XiangCheng 263*0a13b6c3SWu XiangCheng vnode = NULL; 264*0a13b6c3SWu XiangCheng xbc_find_value("key.word", &vnode); 265*0a13b6c3SWu XiangCheng if (vnode && xbc_node_is_array(vnode)) 266*0a13b6c3SWu XiangCheng xbc_array_for_each_value(vnode, value) { 267*0a13b6c3SWu XiangCheng printk("%s ", value); 268*0a13b6c3SWu XiangCheng } 269*0a13b6c3SWu XiangCheng 270*0a13b6c3SWu XiangCheng如果您想查找具有前缀字符串的键,可以使用 xbc_find_node() 通过前缀字符串查找 271*0a13b6c3SWu XiangCheng节点,然后用 xbc_node_for_each_key_value() 迭代前缀节点下的键。 272*0a13b6c3SWu XiangCheng 273*0a13b6c3SWu XiangCheng但最典型的用法是获取前缀下的命名值或前缀下的命名数组,例如:: 274*0a13b6c3SWu XiangCheng 275*0a13b6c3SWu XiangCheng root = xbc_find_node("key.prefix"); 276*0a13b6c3SWu XiangCheng value = xbc_node_find_value(root, "option", &vnode); 277*0a13b6c3SWu XiangCheng ... 278*0a13b6c3SWu XiangCheng xbc_node_for_each_array_value(root, "array-option", value, anode) { 279*0a13b6c3SWu XiangCheng ... 280*0a13b6c3SWu XiangCheng } 281*0a13b6c3SWu XiangCheng 282*0a13b6c3SWu XiangCheng这将访问值“key.prefix.option”的值和“key.prefix.array-option”的数组。 283*0a13b6c3SWu XiangCheng 284*0a13b6c3SWu XiangCheng锁是不需要的,因为在初始化之后配置只读。如果需要修改,必须复制所有数据和关键字。 285*0a13b6c3SWu XiangCheng 286*0a13b6c3SWu XiangCheng 287*0a13b6c3SWu XiangCheng函数与结构体 288*0a13b6c3SWu XiangCheng============ 289*0a13b6c3SWu XiangCheng 290*0a13b6c3SWu XiangCheng相关定义的kernel-doc参见: 291*0a13b6c3SWu XiangCheng 292*0a13b6c3SWu XiangCheng - include/linux/bootconfig.h 293*0a13b6c3SWu XiangCheng - lib/bootconfig.c 294