Documentation/admin-guide/bootconfig.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 .. _bootconfig:
   4
   5 ==================
   6 Boot Configuration
   7 ==================
   8
   9 :Author: Masami Hiramatsu <mhiramat@kernel.org>
  10
  11 Overview
  12 ========
  13
  14 The boot configuration expands the current kernel command line to support
  15 additional key-value data when booting the kernel in an efficient way.
  16 This allows administrators to pass a structured-Key config file.
  17
  18 Config File Syntax
  19 ==================
  20
  21 The boot config syntax is a simple structured key-value. Each key consists
  22 of dot-connected-words, and key and value are connected by ``=``. The value
  23 has to be terminated by semi-colon (``;``) or newline (``\n``).
  24 For array value, array entries are separated by comma (``,``). ::
  25
  26   KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
  27
  28 Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
  29
  30 Each key word must contain only alphabets, numbers, dash (``-``) or underscore
  31 (``_``). And each value only contains printable characters or spaces except
  32 for delimiters such as semi-colon (``;``), new-line (``\n``), comma (``,``),
  33 hash (``#``) and closing brace (``}``).
  34
  35 If you want to use those delimiters in a value, you can use either double-
  36 quotes (``"VALUE"``) or single-quotes (``'VALUE'``) to quote it. Note that
  37 you can not escape these quotes.
  38
  39 There can be a key which doesn't have value or has an empty value. Those keys
  40 are used for checking if the key exists or not (like a boolean).
  41
  42 Key-Value Syntax
  43 ----------------
  44
  45 The boot config file syntax allows user to merge partially same word keys
  46 by brace. For example::
  47
  48  foo.bar.baz = value1
  49  foo.bar.qux.quux = value2
  50
  51 These can be written also in::
  52
  53  foo.bar {
  54     baz = value1
  55     qux.quux = value2
  56  }
  57
  58 Or more shorter, written as following::
  59
  60  foo.bar { baz = value1; qux.quux = value2 }
  61
  62 In both styles, same key words are automatically merged when parsing it
  63 at boot time. So you can append similar trees or key-values.
  64
  65 Same-key Values
  66 ---------------
  67
  68 It is prohibited that two or more values or arrays share a same-key.
  69 For example,::
  70
  71  foo = bar, baz
  72  foo = qux  # !ERROR! we can not re-define same key
  73
  74 If you want to update the value, you must use the override operator
  75 ``:=`` explicitly. For example::
  76
  77  foo = bar, baz
  78  foo := qux
  79
  80 then, the ``qux`` is assigned to ``foo`` key. This is useful for
  81 overriding the default value by adding (partial) custom bootconfigs
  82 without parsing the default bootconfig.
  83
  84 If you want to append the value to existing key as an array member,
  85 you can use ``+=`` operator. For example::
  86
  87  foo = bar, baz
  88  foo += qux
  89
  90 In this case, the key ``foo`` has ``bar``, ``baz`` and ``qux``.
  91
  92 However, a sub-key and a value can not co-exist under a parent key.
  93 For example, following config is NOT allowed.::
  94
  95  foo = value1
  96  foo.bar = value2 # !ERROR! subkey "bar" and value "value1" can NOT co-exist
  97  foo.bar := value2 # !ERROR! even with the override operator, this is NOT allowed.
  98
  99
 100 Comments
 101 --------
 102
 103 The config syntax accepts shell-script style comments. The comments starting
 104 with hash ("#") until newline ("\n") will be ignored.
 105
 106 ::
 107
 108  # comment line
 109  foo = value # value is set to foo.
 110  bar = 1, # 1st element
 111        2, # 2nd element
 112        3  # 3rd element
 113
 114 This is parsed as below::
 115
 116  foo = value
 117  bar = 1, 2, 3
 118
 119 Note that you can not put a comment between value and delimiter(``,`` or
 120 ``;``). This means following config has a syntax error ::
 121
 122  key = 1 # comment
 123        ,2
 124
 125
 126 /proc/bootconfig
 127 ================
 128
 129 /proc/bootconfig is a user-space interface of the boot config.
 130 Unlike /proc/cmdline, this file shows the key-value style list.
 131 Each key-value pair is shown in each line with following style::
 132
 133  KEY[.WORDS...] = "[VALUE]"[,"VALUE2"...]
 134
 135
 136 Boot Kernel With a Boot Config
 137 ==============================
 138
 139 Since the boot configuration file is loaded with initrd, it will be added
 140 to the end of the initrd (initramfs) image file with padding, size,
 141 checksum and 12-byte magic word as below.
 142
 143 [initrd][bootconfig][padding][size(le32)][checksum(le32)][#BOOTCONFIG\n]
 144
 145 The size and checksum fields are unsigned 32bit little endian value.
 146
 147 When the boot configuration is added to the initrd image, the total
 148 file size is aligned to 4 bytes. To fill the gap, null characters
 149 (``\0``) will be added. Thus the ``size`` is the length of the bootconfig
 150 file + padding bytes.
 151
 152 The Linux kernel decodes the last part of the initrd image in memory to
 153 get the boot configuration data.
 154 Because of this "piggyback" method, there is no need to change or
 155 update the boot loader and the kernel image itself as long as the boot
 156 loader passes the correct initrd file size. If by any chance, the boot
 157 loader passes a longer size, the kernel feils to find the bootconfig data.
 158
 159 To do this operation, Linux kernel provides "bootconfig" command under
 160 tools/bootconfig, which allows admin to apply or delete the config file
 161 to/from initrd image. You can build it by the following command::
 162
 163  # make -C tools/bootconfig
 164
 165 To add your boot config file to initrd image, run bootconfig as below
 166 (Old data is removed automatically if exists)::
 167
 168  # tools/bootconfig/bootconfig -a your-config /boot/initrd.img-X.Y.Z
 169
 170 To remove the config from the image, you can use -d option as below::
 171
 172  # tools/bootconfig/bootconfig -d /boot/initrd.img-X.Y.Z
 173
 174 Then add "bootconfig" on the normal kernel command line to tell the
 175 kernel to look for the bootconfig at the end of the initrd file.
 176
 177 Config File Limitation
 178 ======================
 179
 180 Currently the maximum config size size is 32KB and the total key-words (not
 181 key-value entries) must be under 1024 nodes.
 182 Note: this is not the number of entries but nodes, an entry must consume
 183 more than 2 nodes (a key-word and a value). So theoretically, it will be
 184 up to 512 key-value pairs. If keys contains 3 words in average, it can
 185 contain 256 key-value pairs. In most cases, the number of config items
 186 will be under 100 entries and smaller than 8KB, so it would be enough.
 187 If the node number exceeds 1024, parser returns an error even if the file
 188 size is smaller than 32KB. (Note that this maximum size is not including
 189 the padding null characters.)
 190 Anyway, since bootconfig command verifies it when appending a boot config
 191 to initrd image, user can notice it before boot.
 192
 193
 194 Bootconfig APIs
 195 ===============
 196
 197 User can query or loop on key-value pairs, also it is possible to find
 198 a root (prefix) key node and find key-values under that node.
 199
 200 If you have a key string, you can query the value directly with the key
 201 using xbc_find_value(). If you want to know what keys exist in the boot
 202 config, you can use xbc_for_each_key_value() to iterate key-value pairs.
 203 Note that you need to use xbc_array_for_each_value() for accessing
 204 each array's value, e.g.::
 205
 206  vnode = NULL;
 207  xbc_find_value("key.word", &vnode);
 208  if (vnode && xbc_node_is_array(vnode))
 209     xbc_array_for_each_value(vnode, value) {
 210       printk("%s ", value);
 211     }
 212
 213 If you want to focus on keys which have a prefix string, you can use
 214 xbc_find_node() to find a node by the prefix string, and iterate
 215 keys under the prefix node with xbc_node_for_each_key_value().
 216
 217 But the most typical usage is to get the named value under prefix
 218 or get the named array under prefix as below::
 219
 220  root = xbc_find_node("key.prefix");
 221  value = xbc_node_find_value(root, "option", &vnode);
 222  ...
 223  xbc_node_for_each_array_value(root, "array-option", value, anode) {
 224     ...
 225  }
 226
 227 This accesses a value of "key.prefix.option" and an array of
 228 "key.prefix.array-option".
 229
 230 Locking is not needed, since after initialization, the config becomes
 231 read-only. All data and keys must be copied if you need to modify it.
 232
 233
 234 Functions and structures
 235 ========================
 236
 237 .. kernel-doc:: include/linux/bootconfig.h
 238 .. kernel-doc:: lib/bootconfig.c
 239