source: chapter10/kernel.xml@ 3d99820

12.0 12.0-rc1 12.1 12.1-rc1 multilib trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/update-glibc
Last change on this file since 3d99820 was 70bf551, checked in by Xi Ruoyao <xry111@…>, 10 months ago

kernel: Use new kernel configuration rendering method

Import kernel-config infrastructure from BLFS and use it for kernel
configuration. Note that kernel-config.py is slightly different from
BLFS: we need role="nodump" for <screen> here.

  • Property mode set to 100644
File size: 21.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-bootable-kernel" role="wrap">
9 <?dbhtml filename="kernel.html"?>
10
11 <sect1info condition="script">
12 <productname>kernel</productname>
13 <productnumber>&linux-version;</productnumber>
14 <address>&linux-url;</address>
15 </sect1info>
16
17 <title>Linux-&linux-version;</title>
18
19 <indexterm zone="ch-bootable-kernel">
20 <primary sortas="a-Linux">Linux</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Linux package contains the Linux kernel.</para>
27
28 <segmentedlist>
29 <segtitle>&buildtime;</segtitle>
30 <segtitle>&diskspace;</segtitle>
31
32 <seglistitem>
33 <seg>&linux-knl-sbu;</seg>
34 <seg>&linux-knl-du;</seg>
35 </seglistitem>
36 </segmentedlist>
37
38 </sect2>
39
40 <sect2 role="installation">
41 <title>Installation of the kernel</title>
42
43 <para>Building the kernel involves a few steps&mdash;configuration,
44 compilation, and installation. Read the <filename>README</filename> file
45 in the kernel source tree for alternative methods to the way this book
46 configures the kernel.</para>
47
48 <important>
49 <para>
50 Building the linux kernel for the first time is one of the most
51 challenging tasks in LFS. Getting it right depends on the specific
52 hardware for the target system and your specific needs. There are
53 almost 12,000 configuration items that are available for the kernel
54 although only about a third of them are needed for most computers. The
55 LFS editors recommend that users not familiar with this process follow
56 the procedures below fairly closely. The objective is to get an
57 initial system to a point where you can log in at the command line when
58 you reboot later in <xref linkend="ch-finish-reboot"/>. At this point
59 optimization and customization is not a goal.
60 </para>
61
62
63 <para>
64 For general information on kernel configuration see <ulink
65 url="&hints-root;kernel-configuration.txt"/>. Additional information
66 about configuring and building the kernel can be found at <ulink
67 url="&anduin-sources;/kernel-nutshell/"/>.
68 These references are a bit
69 dated, but still give a reasonable overview of the process.
70 </para>
71
72 <para>
73 If all else fails, you can ask for help on the <ulink
74 url="https://www.linuxfromscratch.org/mail.html">lfs-support</ulink>
75 mailing list. Note that subscribing is required in order for the list
76 to avoid spam.
77 </para>
78 </important>
79
80 <para>Prepare for compilation by running the following command:</para>
81
82<screen><userinput remap="pre">make mrproper</userinput></screen>
83
84 <para>This ensures that the kernel tree is absolutely clean. The
85 kernel team recommends that this command be issued prior to each
86 kernel compilation. Do not rely on the source tree being clean after
87 un-tarring.</para>
88
89 <para>There are several ways to configure the kernel options. Usually,
90 This is done through a menu-driven interface, for example:</para>
91
92<screen role="nodump"><userinput>make menuconfig</userinput></screen>
93
94 <variablelist>
95 <title>The meaning of optional make environment variables:</title>
96
97 <varlistentry>
98 <term><parameter>LANG=&lt;host_LANG_value&gt; LC_ALL=</parameter></term>
99 <listitem>
100 <para>This establishes the locale setting to the one used on the
101 host. This may be needed for a proper menuconfig ncurses interface
102 line drawing on a UTF-8 linux text console.</para>
103
104 <para>If used, be sure to replace
105 <replaceable>&lt;host_LANG_value&gt;</replaceable> by the value of
106 the <envar>$LANG</envar> variable from your host. You can
107 alternatively use instead the host's value of <envar>$LC_ALL</envar>
108 or <envar>$LC_CTYPE</envar>.</para>
109 </listitem>
110 </varlistentry>
111
112 <varlistentry>
113 <term><command>make menuconfig</command></term>
114 <listitem>
115 <para>This launches an ncurses menu-driven interface. For other
116 (graphical) interfaces, type <command>make help</command>.</para>
117 </listitem>
118 </varlistentry>
119 </variablelist>
120
121 <!-- Support for compiling a keymap into the kernel is deliberately removed -->
122
123
124 <note>
125 <para>A good starting place for setting up the kernel configuration is to
126 run <command>make defconfig</command>. This will set the base
127 configuration to a good state that takes your current system architecture
128 into account.</para>
129
130 <para>Be sure to enable/disable/set the following features or the system might
131 not work correctly or boot at all:</para>
132
133 <!-- To editors: for updating kernel configuration, edit
134 kernel/*.toml and regenerate kernel/*.xml with
135 "make -C kernel KERNEL_TREE=</usr/src/linux-&linux-version> -->
136
137 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
138 href="kernel/sysv.xml"/>
139
140 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
141 href="kernel/systemd.xml"/>
142
143 <para>Enable some additional features if you are building a 64-bit
144 system. If you are using menuconfig, enable them in the order of
145 <parameter>CONFIG_PCI_MSI</parameter> first, then
146 <parameter>CONFIG_IRQ_REMAP</parameter>, at last
147 <parameter>CONFIG_X86_X2APIC</parameter> because an option only
148 shows up after its dependencies are selected.</para>
149
150 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
151 href="kernel/x2apic.xml"/>
152
153 <para>If you are building a 32-bit system running on a hardware
154 with RAM more than 4GB, adjust the configuration so the kernel will
155 be able to use up to 64GB physical RAM:</para>
156
157 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
158 href="kernel/highmem.xml"/>
159
160 <para>If the partition for the LFS system is in a NVME SSD (i. e. the
161 device node for the partition is <filename>/dev/nvme*</filename>
162 instead of <filename>/dev/sd*</filename>), enable NVME support or
163 the LFS system won't boot:</para>
164
165 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
166 href="kernel/nvme.xml"/>
167 </note>
168
169 <note revision="systemd">
170 <para>While "The IPv6 Protocol" is not strictly
171 required, it is highly recommended by the systemd developers.</para>
172 </note>
173
174 <para>There are several other options that may be desired
175 depending on the requirements for the system. For a list of options needed
176 for BLFS packages, see the <ulink
177 url="&lfs-root;blfs/view/&short-version;/longindex.html#kernel-config-index">BLFS
178 Index of Kernel Settings</ulink>.</para>
179
180 <note>
181 <para>If your host hardware is using UEFI and you wish to boot the
182 LFS system with it, you should adjust some kernel configuration
183 following <ulink url="&blfs-book;postlfs/grub-setup.html#uefi-kernel">
184 the BLFS page</ulink> <emphasis role='bold'>even if you'll use the
185 UEFI bootloader from the host distro</emphasis>.</para>
186 </note>
187
188 <variablelist>
189 <title>The rationale for the above configuration items:</title>
190
191 <varlistentry>
192 <term><parameter>Randomize the address of the kernel image (KASLR)</parameter></term>
193 <listitem>
194 <para>Enable ASLR for kernel image, to mitigate some attacks based
195 on fixed addresses of sensitive data or code in the kernel.</para>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry>
200 <term>
201 <parameter>
202 Compile the kernel with warnings as errors
203 </parameter>
204 </term>
205 <listitem>
206 <para>This may cause building failure if the compiler and/or
207 configuration are different from those of the kernel
208 developers.</para>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry>
213 <term>
214 <parameter>
215 Enable kernel headers through /sys/kernel/kheaders.tar.xz
216 </parameter>
217 </term>
218 <listitem>
219 <para>This will require <command>cpio</command> building the kernel.
220 <command>cpio</command> is not installed by LFS.</para>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry>
225 <term>
226 <parameter>
227 Configure standard kernel features (expert users)
228 </parameter>
229 </term>
230 <listitem>
231 <para>This will make some options show up in the configuration
232 interface but changing those options may be dangerous. Do not use
233 this unless you know what you are doing.</para>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry>
238 <term><parameter>Strong Stack Protector</parameter></term>
239 <listitem>
240 <para>Enable SSP for the kernel. We've enabled it for the entire
241 userspace with <parameter>--enable-default-ssp</parameter>
242 configuring GCC, but the kernel does not use GCC default setting
243 for SSP. We enable it explicitly here.</para>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry>
248 <term><parameter>Support for uevent helper</parameter></term>
249 <listitem>
250 <para>Having this option set may interfere with device
251 management when using Udev.</para>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry>
256 <term><parameter>Maintain a devtmpfs</parameter></term>
257 <listitem>
258 <para>This will create automated device nodes which are populated by the
259 kernel, even without Udev running. Udev then runs on top of this,
260 managing permissions and adding symlinks. This configuration
261 item is required for all users of Udev.</para>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry>
266 <term><parameter>Automount devtmpfs at /dev</parameter></term>
267 <listitem>
268 <para>This will mount the kernel view of the devices on /dev
269 upon switching to root filesystem just before starting
270 init.</para>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry>
275 <term><parameter>Framebuffer Console support</parameter></term>
276 <listitem>
277 <para>This is needed to display the Linux console on a frame
278 buffer device. To allow the kernel to print debug messages at an
279 early boot stage, it shouldn't be built as a kernel module
280 unless an initramfs will be used. And, if
281 <option>CONFIG_DRM</option> (Direct Rendering Manager) is enabled,
282 it's likely <option>CONFIG_DRM_FBDEV_EMULATION</option> (Enable
283 legacy fbdev support for your modesetting driver) should be
284 enabled as well.</para>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry>
289 <term><parameter>Support x2apic</parameter></term>
290 <listitem>
291 <para>Support running the interrupt controller of 64-bit x86
292 processors in x2APIC mode. x2APIC may be enabled by firmware on
293 64-bit x86 systems, and a kernel without this option enabled will
294 panic on boot if x2APIC is enabled by firmware. This option has
295 has no effect, but also does no harm if x2APIC is disabled by the
296 firmware.</para>
297 </listitem>
298 </varlistentry>
299
300 </variablelist>
301
302 <para>Alternatively, <command>make oldconfig</command> may be more
303 appropriate in some situations. See the <filename>README</filename>
304 file for more information.</para>
305
306 <para>If desired, skip kernel configuration by copying the kernel
307 config file, <filename>.config</filename>, from the host system
308 (assuming it is available) to the unpacked <filename
309 class="directory">linux-&linux-version;</filename> directory. However,
310 we do not recommend this option. It is often better to explore all the
311 configuration menus and create the kernel configuration from
312 scratch.</para>
313
314 <para>Compile the kernel image and modules:</para>
315
316<screen><userinput remap="make">make</userinput></screen>
317
318 <para>If using kernel modules, module configuration in <filename
319 class="directory">/etc/modprobe.d</filename> may be required.
320 Information pertaining to modules and kernel configuration is
321 located in <xref linkend="ch-config-udev"/> and in the kernel
322 documentation in the <filename
323 class="directory">linux-&linux-version;/Documentation</filename> directory.
324 Also, <filename>modprobe.d(5)</filename> may be of interest.</para>
325
326 <para>Unless module support has been disabled in the kernel configuration,
327 install the modules with:</para>
328
329<screen><userinput remap="install">make modules_install</userinput></screen>
330
331 <para>After kernel compilation is complete, additional steps are
332 required to complete the installation. Some files need to be copied to
333 the <filename class="directory">/boot</filename> directory.</para>
334
335 <caution>
336 <para>If you've decided to use a separate &boot-dir; partition for the
337 LFS system (maybe sharing a &boot-dir; partition with the host
338 distro) , the files copied below should go there. The easiest way to
339 do that is to create the entry for &boot-dir; in &fstab; first (read
340 the previous section for details), then issue the following command
341 as the &root; user in the
342 <emphasis>chroot environment</emphasis>:</para>
343
344<screen role="nodump"><userinput>mount /boot</userinput></screen>
345
346 <para>The path to the device node is omitted in the command because
347 <command>mount</command> can read it from &fstab;.</para>
348 </caution>
349
350 <para>The path to the kernel image may vary depending on the platform being
351 used. The filename below can be changed to suit your taste, but the stem of
352 the filename should be <emphasis>vmlinuz</emphasis> to be compatible with
353 the automatic setup of the boot process described in the next section. The
354 following command assumes an x86 architecture:</para>
355
356<screen><userinput remap="install">cp -iv arch/x86/boot/bzImage /boot/vmlinuz-&linux-version;-lfs-&version;</userinput></screen>
357
358 <para><filename>System.map</filename> is a symbol file for the kernel.
359 It maps the function entry points of every function in the kernel API,
360 as well as the addresses of the kernel data structures for the running
361 kernel. It is used as a resource when investigating kernel problems.
362 Issue the following command to install the map file:</para>
363
364<screen><userinput remap="install">cp -iv System.map /boot/System.map-&linux-version;</userinput></screen>
365
366 <para>The kernel configuration file <filename>.config</filename>
367 produced by the <command>make menuconfig</command> step
368 above contains all the configuration selections for the kernel
369 that was just compiled. It is a good idea to keep this file for future
370 reference:</para>
371
372<screen><userinput remap="install">cp -iv .config /boot/config-&linux-version;</userinput></screen>
373
374 <para>Install the documentation for the Linux kernel:</para>
375
376<screen><userinput remap="install">cp -r Documentation -T /usr/share/doc/linux-&linux-version;</userinput></screen>
377
378 <para>It is important to note that the files in the kernel source
379 directory are not owned by <emphasis>root</emphasis>. Whenever a
380 package is unpacked as user <emphasis>root</emphasis> (like we did
381 inside chroot), the files have the user and group IDs of whatever
382 they were on the packager's computer. This is usually not a problem
383 for any other package to be installed because the source tree is
384 removed after the installation. However, the Linux source tree is
385 often retained for a long time. Because of this, there is a chance
386 that whatever user ID the packager used will be assigned to somebody
387 on the machine. That person would then have write access to the kernel
388 source.</para>
389
390 <note>
391 <para>In many cases, the configuration of the kernel will need to be
392 updated for packages that will be installed later in BLFS. Unlike
393 other packages, it is not necessary to remove the kernel source tree
394 after the newly built kernel is installed.</para>
395
396 <para>If the kernel source tree is going to be retained, run
397 <command>chown -R 0:0</command> on the <filename
398 class="directory">linux-&linux-version;</filename> directory to ensure
399 all files are owned by user <emphasis>root</emphasis>.</para>
400 </note>
401
402 <warning>
403 <para>Some kernel documentation recommends creating a symlink from
404 <filename class="symlink">/usr/src/linux</filename> pointing to the kernel
405 source directory. This is specific to kernels prior to the 2.6 series and
406 <emphasis>must not</emphasis> be created on an LFS system as it can cause
407 problems for packages you may wish to build once your base LFS system is
408 complete.</para>
409 </warning>
410
411 <warning>
412 <para>The headers in the system's <filename
413 class="directory">include</filename> directory (<filename
414 class="directory">/usr/include</filename>) should
415 <emphasis>always</emphasis> be the ones against which Glibc was compiled,
416 that is, the sanitised headers installed in <xref
417 linkend="ch-tools-linux-headers"/>. Therefore, they should
418 <emphasis>never</emphasis> be replaced by either the raw kernel headers
419 or any other kernel sanitized headers.</para>
420 </warning>
421
422 </sect2>
423
424 <sect2 id="conf-modprobe" role="configuration">
425 <title>Configuring Linux Module Load Order</title>
426
427 <indexterm zone="conf-modprobe">
428 <primary sortas="e-/etc/modprobe.d/usb.conf">/etc/modprobe.d/usb.conf</primary>
429 </indexterm>
430
431 <para>Most of the time Linux modules are loaded automatically, but
432 sometimes it needs some specific direction. The program that loads
433 modules, <command>modprobe</command> or <command>insmod</command>, uses
434 <filename>/etc/modprobe.d/usb.conf</filename> for this purpose. This file
435 needs to be created so that if the USB drivers (ehci_hcd, ohci_hcd and
436 uhci_hcd) have been built as modules, they will be loaded in the correct
437 order; ehci_hcd needs to be loaded prior to ohci_hcd and uhci_hcd in order
438 to avoid a warning being output at boot time.</para>
439
440 <para>Create a new file <filename>/etc/modprobe.d/usb.conf</filename> by running
441 the following:</para>
442
443<screen><userinput>install -v -m755 -d /etc/modprobe.d
444cat &gt; /etc/modprobe.d/usb.conf &lt;&lt; "EOF"
445<literal># Begin /etc/modprobe.d/usb.conf
446
447install ohci_hcd /sbin/modprobe ehci_hcd ; /sbin/modprobe -i ohci_hcd ; true
448install uhci_hcd /sbin/modprobe ehci_hcd ; /sbin/modprobe -i uhci_hcd ; true
449
450# End /etc/modprobe.d/usb.conf</literal>
451EOF</userinput></screen>
452
453 </sect2>
454
455 <sect2 id="contents-kernel" role="content">
456 <title>Contents of Linux</title>
457
458 <segmentedlist>
459 <segtitle>Installed files</segtitle>
460 <segtitle>Installed directories</segtitle>
461
462 <seglistitem>
463 <seg>config-&linux-version;,
464 vmlinuz-&linux-version;-lfs-&version;,
465 and System.map-&linux-version;</seg>
466 <seg>/lib/modules, /usr/share/doc/linux-&linux-version;</seg>
467 </seglistitem>
468 </segmentedlist>
469
470 <variablelist>
471 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
472 <?dbfo list-presentation="list"?>
473 <?dbhtml list-presentation="table"?>
474
475 <varlistentry id="config">
476 <term><filename>config-&linux-version;</filename></term>
477 <listitem>
478 <para>Contains all the configuration selections for the kernel</para>
479 <indexterm zone="ch-bootable-kernel config">
480 <primary sortas="e-/boot/config">/boot/config-&linux-version;</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="lfskernel">
486 <term><filename>vmlinuz-&linux-version;-lfs-&version;</filename></term>
487 <listitem>
488 <para>The engine of the Linux system. When turning on the computer,
489 the kernel is the first part of the operating system that gets loaded.
490 It detects and initializes all components of the computer's hardware,
491 then makes these components available as a tree of files to the
492 software and turns a single CPU into a multitasking machine capable
493 of running scores of programs seemingly at the same time</para>
494 <indexterm zone="ch-bootable-kernel lfskernel">
495 <primary sortas="b-lfskernel">lfskernel-&linux-version;</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="System.map">
501 <term><filename>System.map-&linux-version;</filename></term>
502 <listitem>
503 <para>A list of addresses and symbols; it maps the entry points and
504 addresses of all the functions and data structures in the
505 kernel</para>
506 <indexterm zone="ch-bootable-kernel System.map">
507 <primary sortas="e-/boot/System.map">/boot/System.map-&linux-version;</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 </variablelist>
513
514 </sect2>
515
516</sect1>
Note: See TracBrowser for help on using the repository browser.