| 1 |
.. SPDX-License-Identifier: GPL-2.0 |
| 2 |
|
| 3 |
.. include:: ../disclaimer-zh_TW.rst |
| 4 |
|
| 5 |
:Original: Documentation/admin-guide/bootconfig.rst |
| 6 |
|
| 7 |
:譯者: 吳想成 Wu XiangCheng <[email protected]> |
| 8 |
|
| 9 |
======== |
| 10 |
引導配置 |
| 11 |
======== |
| 12 |
|
| 13 |
:作者: Masami Hiramatsu <[email protected]> |
| 14 |
|
| 15 |
概述 |
| 16 |
==== |
| 17 |
|
| 18 |
引導配置擴展了現有的內核命令行,以一種更有效率的方式在引導內核時進一步支持 |
| 19 |
鍵值數據。這允許管理員傳遞一份結構化關鍵字的配置文件。 |
| 20 |
|
| 21 |
配置文件語法 |
| 22 |
============ |
| 23 |
|
| 24 |
引導配置文件的語法採用非常簡單的鍵值結構。每個關鍵字由點連接的單詞組成,鍵 |
| 25 |
和值由 ``=`` 連接。值以分號( ``;`` )或換行符( ``\n`` )結尾。數組值中每 |
| 26 |
個元素由逗號( ``,`` )分隔。:: |
| 27 |
|
| 28 |
KEY[.WORD[...]] = VALUE[, VALUE2[...]][;] |
| 29 |
|
| 30 |
與內核命令行語法不同,逗號和 ``=`` 周圍允許有空格。 |
| 31 |
|
| 32 |
關鍵字只允許包含字母、數字、連字符( ``-`` )和下劃線( ``_`` )。值可包含 |
| 33 |
可打印字符和空格,但分號( ``;`` )、換行符( ``\n`` )、逗號( ``,`` )、 |
| 34 |
井號( ``#`` )和右大括號( ``}`` )等分隔符除外。 |
| 35 |
|
| 36 |
如果你需要在值中使用這些分隔符,可以用雙引號( ``"VALUE"`` )或單引號 |
| 37 |
( ``'VALUE'`` )括起來。注意,引號無法轉義。 |
| 38 |
|
| 39 |
鍵的值可以爲空或不存在。這些鍵用於檢查該鍵是否存在(類似布爾值)。 |
| 40 |
|
| 41 |
鍵值語法 |
| 42 |
-------- |
| 43 |
|
| 44 |
引導配置文件語法允許用戶通過大括號合併鍵名部分相同的關鍵字。例如:: |
| 45 |
|
| 46 |
foo.bar.baz = value1 |
| 47 |
foo.bar.qux.quux = value2 |
| 48 |
|
| 49 |
也可以寫成:: |
| 50 |
|
| 51 |
foo.bar { |
| 52 |
baz = value1 |
| 53 |
qux.quux = value2 |
| 54 |
} |
| 55 |
|
| 56 |
或者更緊湊一些,寫成:: |
| 57 |
|
| 58 |
foo.bar { baz = value1; qux.quux = value2 } |
| 59 |
|
| 60 |
在這兩種樣式中,引導解析時相同的關鍵字都會自動合併。因此可以追加類似的樹或 |
| 61 |
鍵值。 |
| 62 |
|
| 63 |
相同關鍵字的值 |
| 64 |
-------------- |
| 65 |
|
| 66 |
禁止兩個或多個值或數組共享同一個關鍵字。例如:: |
| 67 |
|
| 68 |
foo = bar, baz |
| 69 |
foo = qux # !錯誤! 我們不可以重定義相同的關鍵字 |
| 70 |
|
| 71 |
如果你想要更新值,必須顯式使用覆蓋操作符 ``:=`` 。例如:: |
| 72 |
|
| 73 |
foo = bar, baz |
| 74 |
foo := qux |
| 75 |
|
| 76 |
這樣 ``foo`` 關鍵字的值就變成了 ``qux`` 。這對於通過添加(部分)自定義引導 |
| 77 |
配置來覆蓋默認值非常有用,免於解析默認引導配置。 |
| 78 |
|
| 79 |
如果你想對現有關鍵字追加值作爲數組成員,可以使用 ``+=`` 操作符。例如:: |
| 80 |
|
| 81 |
foo = bar, baz |
| 82 |
foo += qux |
| 83 |
|
| 84 |
這樣, ``foo`` 關鍵字就同時擁有了 ``bar`` , ``baz`` 和 ``qux`` 。 |
| 85 |
|
| 86 |
此外,父關鍵字下可同時存在值和子關鍵字。 |
| 87 |
例如,下列配置是可行的。:: |
| 88 |
|
| 89 |
foo = value1 |
| 90 |
foo.bar = value2 |
| 91 |
foo := value3 # 這會更新foo的值。 |
| 92 |
|
| 93 |
注意,裸值不能直接放進結構化關鍵字中,必須在大括號外定義它。例如:: |
| 94 |
|
| 95 |
foo { |
| 96 |
bar = value1 |
| 97 |
bar { |
| 98 |
baz = value2 |
| 99 |
qux = value3 |
| 100 |
} |
| 101 |
} |
| 102 |
|
| 103 |
同時,關鍵字下值節點的順序是固定的。如果值和子關鍵字同時存在,值永遠是該關 |
| 104 |
鍵字的第一個子節點。因此如果用戶先指定子關鍵字,如:: |
| 105 |
|
| 106 |
foo.bar = value1 |
| 107 |
foo = value2 |
| 108 |
|
| 109 |
則在程序(和/proc/bootconfig)中,它會按如下顯示:: |
| 110 |
|
| 111 |
foo = value2 |
| 112 |
foo.bar = value1 |
| 113 |
|
| 114 |
註釋 |
| 115 |
---- |
| 116 |
|
| 117 |
配置語法接受shell腳本風格的註釋。註釋以井號( ``#`` )開始,到換行符 |
| 118 |
( ``\n`` )結束。 |
| 119 |
|
| 120 |
:: |
| 121 |
|
| 122 |
# comment line |
| 123 |
foo = value # value is set to foo. |
| 124 |
bar = 1, # 1st element |
| 125 |
2, # 2nd element |
| 126 |
3 # 3rd element |
| 127 |
|
| 128 |
會被解析爲:: |
| 129 |
|
| 130 |
foo = value |
| 131 |
bar = 1, 2, 3 |
| 132 |
|
| 133 |
注意你不能把註釋放在值和分隔符( ``,`` 或 ``;`` )之間。如下配置語法是錯誤的:: |
| 134 |
|
| 135 |
key = 1 # comment |
| 136 |
,2 |
| 137 |
|
| 138 |
|
| 139 |
/proc/bootconfig |
| 140 |
================ |
| 141 |
|
| 142 |
/proc/bootconfig是引導配置的用戶空間接口。與/proc/cmdline不同,此文件內容以 |
| 143 |
鍵值列表樣式顯示。 |
| 144 |
每個鍵值對一行,樣式如下:: |
| 145 |
|
| 146 |
KEY[.WORDS...] = "[VALUE]"[,"VALUE2"...] |
| 147 |
|
| 148 |
|
| 149 |
用引導配置引導內核 |
| 150 |
================== |
| 151 |
|
| 152 |
用引導配置引導內核有兩種方法:將引導配置附加到initrd鏡像或直接嵌入內核中。 |
| 153 |
|
| 154 |
*initrd: initial RAM disk,初始內存磁盤* |
| 155 |
|
| 156 |
將引導配置附加到initrd |
| 157 |
---------------------- |
| 158 |
|
| 159 |
由於默認情況下引導配置文件是用initrd加載的,因此它將被添加到initrd(initramfs) |
| 160 |
鏡像文件的末尾,其中包含填充、大小、校驗值和12字節幻數,如下所示:: |
| 161 |
|
| 162 |
[initrd][bootconfig][padding][size(le32)][checksum(le32)][#BOOTCONFIG\n] |
| 163 |
|
| 164 |
大小和校驗值爲小端序存放的32位無符號值。 |
| 165 |
|
| 166 |
當引導配置被加到initrd鏡像時,整個文件大小會對齊到4字節。空字符( ``\0`` ) |
| 167 |
會填補對齊空隙。因此 ``size`` 就是引導配置文件的長度+填充的字節。 |
| 168 |
|
| 169 |
Linux內核在內存中解碼initrd鏡像的最後部分以獲取引導配置數據。由於這種“揹負式” |
| 170 |
的方法,只要引導加載器傳遞了正確的initrd文件大小,就無需更改或更新引導加載器 |
| 171 |
和內核鏡像本身。如果引導加載器意外傳遞了更長的大小,內核將無法找到引導配置數 |
| 172 |
據。 |
| 173 |
|
| 174 |
Linux內核在tools/bootconfig下提供了 ``bootconfig`` 命令來完成此操作,管理員 |
| 175 |
可以用它從initrd鏡像中刪除或追加配置文件。你可以用以下命令來構建它:: |
| 176 |
|
| 177 |
# make -C tools/bootconfig |
| 178 |
|
| 179 |
要向initrd鏡像添加你的引導配置文件,請按如下命令操作(舊數據會自動移除):: |
| 180 |
|
| 181 |
# tools/bootconfig/bootconfig -a your-config /boot/initrd.img-X.Y.Z |
| 182 |
|
| 183 |
要從鏡像中移除配置,可以使用-d選項:: |
| 184 |
|
| 185 |
# tools/bootconfig/bootconfig -d /boot/initrd.img-X.Y.Z |
| 186 |
|
| 187 |
然後在內核命令行上添加 ``bootconfig`` 告訴內核去initrd文件末尾尋找內核配置。 |
| 188 |
|
| 189 |
將引導配置嵌入內核 |
| 190 |
------------------ |
| 191 |
|
| 192 |
如果你不能使用initrd,也可以通過Kconfig選項將引導配置文件嵌入內核中。在此情 |
| 193 |
況下,你需要用以下選項重新編譯內核:: |
| 194 |
|
| 195 |
CONFIG_BOOT_CONFIG_EMBED=y |
| 196 |
CONFIG_BOOT_CONFIG_EMBED_FILE="/引導配置/文件/的/路徑" |
| 197 |
|
| 198 |
``CONFIG_BOOT_CONFIG_EMBED_FILE`` 需要從源碼樹或對象樹開始的引導配置文件的 |
| 199 |
絕對/相對路徑。內核會將其嵌入作爲默認引導配置。 |
| 200 |
|
| 201 |
與將引導配置附加到initrd一樣,你也需要在內核命令行上添加 ``bootconfig`` 告訴 |
| 202 |
內核去啓用內嵌的引導配置。 |
| 203 |
|
| 204 |
注意,即使你已經設置了此選項,仍可用附加到initrd的其他引導配置覆蓋內嵌的引導 |
| 205 |
配置。 |
| 206 |
|
| 207 |
通過引導配置傳遞內核參數 |
| 208 |
======================== |
| 209 |
|
| 210 |
除了內核命令行,引導配置也可以用於傳遞內核參數。所有 ``kernel`` 關鍵字下的鍵 |
| 211 |
值對都將直接傳遞給內核命令行。此外, ``init`` 下的鍵值對將通過命令行傳遞給 |
| 212 |
init進程。參數按以下順序與用戶給定的內核命令行字符串相連,因此命令行參數可以 |
| 213 |
覆蓋引導配置參數(這取決於子系統如何處理參數,但通常前面的參數將被後面的參數 |
| 214 |
覆蓋):: |
| 215 |
|
| 216 |
[bootconfig params][cmdline params] -- [bootconfig init params][cmdline init params] |
| 217 |
|
| 218 |
如果引導配置文件給出的kernel/init參數是:: |
| 219 |
|
| 220 |
kernel { |
| 221 |
root = 01234567-89ab-cdef-0123-456789abcd |
| 222 |
} |
| 223 |
init { |
| 224 |
splash |
| 225 |
} |
| 226 |
|
| 227 |
這將被複制到內核命令行字符串中,如下所示:: |
| 228 |
|
| 229 |
root="01234567-89ab-cdef-0123-456789abcd" -- splash |
| 230 |
|
| 231 |
如果用戶給出的其他命令行是:: |
| 232 |
|
| 233 |
ro bootconfig -- quiet |
| 234 |
|
| 235 |
則最後的內核命令行如下:: |
| 236 |
|
| 237 |
root="01234567-89ab-cdef-0123-456789abcd" ro bootconfig -- splash quiet |
| 238 |
|
| 239 |
|
| 240 |
配置文件的限制 |
| 241 |
============== |
| 242 |
|
| 243 |
當前最大的配置大小是32KB,關鍵字總數(不是鍵值條目)必須少於1024個節點。 |
| 244 |
注意:這不是條目數而是節點數,條目必須消耗超過2個節點(一個關鍵字和一個值)。 |
| 245 |
所以從理論上講最多512個鍵值對。如果關鍵字平均包含3個單詞,則可有256個鍵值對。 |
| 246 |
在大多數情況下,配置項的數量將少於100個條目,小於8KB,因此這應該足夠了。如果 |
| 247 |
節點數超過1024,解析器將返回錯誤,即使文件大小小於32KB。(請注意,此最大尺寸 |
| 248 |
不包括填充的空字符。) |
| 249 |
無論如何,因爲 ``bootconfig`` 命令在附加啓動配置到initrd映像時會驗證它,用戶 |
| 250 |
可以在引導之前注意到它。 |
| 251 |
|
| 252 |
|
| 253 |
引導配置API |
| 254 |
=========== |
| 255 |
|
| 256 |
用戶可以查詢或遍歷鍵值對,也可以查找(前綴)根關鍵字節點,並在查找該節點下的 |
| 257 |
鍵值。 |
| 258 |
|
| 259 |
如果您有一個關鍵字字符串,則可以直接使用 xbc_find_value() 查詢該鍵的值。如果 |
| 260 |
你想知道引導配置裏有哪些關鍵字,可以使用 xbc_for_each_key_value() 迭代鍵值對。 |
| 261 |
請注意,您需要使用 xbc_array_for_each_value() 訪問數組的值,例如:: |
| 262 |
|
| 263 |
vnode = NULL; |
| 264 |
xbc_find_value("key.word", &vnode); |
| 265 |
if (vnode && xbc_node_is_array(vnode)) |
| 266 |
xbc_array_for_each_value(vnode, value) { |
| 267 |
printk("%s ", value); |
| 268 |
} |
| 269 |
|
| 270 |
如果您想查找具有前綴字符串的鍵,可以使用 xbc_find_node() 通過前綴字符串查找 |
| 271 |
節點,然後用 xbc_node_for_each_key_value() 迭代前綴節點下的鍵。 |
| 272 |
|
| 273 |
但最典型的用法是獲取前綴下的命名值或前綴下的命名數組,例如:: |
| 274 |
|
| 275 |
root = xbc_find_node("key.prefix"); |
| 276 |
value = xbc_node_find_value(root, "option", &vnode); |
| 277 |
... |
| 278 |
xbc_node_for_each_array_value(root, "array-option", value, anode) { |
| 279 |
... |
| 280 |
} |
| 281 |
|
| 282 |
這將訪問值“key.prefix.option”的值和“key.prefix.array-option”的數組。 |
| 283 |
|
| 284 |
鎖是不需要的,因爲在初始化之後配置只讀。如果需要修改,必須複製所有數據和關鍵字。 |
| 285 |
|
| 286 |
|
| 287 |
函數與結構體 |
| 288 |
============ |
| 289 |
|
| 290 |
相關定義的kernel-doc參見: |
| 291 |
|
| 292 |
- include/linux/bootconfig.h |
| 293 |
- lib/bootconfig.c |
| 294 |
|