source: chapter10/kernel.xml@ c4b61b1

xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1
Last change on this file since c4b61b1 was c4b61b1, checked in by Xi Ruoyao <xry111@…>, 10 months ago

loongarch: kernel: Disable relaxation for building a module

Link: https://git.kernel.org/torvalds/c/03c53eb90c0c

  • Property mode set to 100644
File size: 20.4 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>If the partition for the LFS system is in a NVME SSD (i. e. the
144 device node for the partition is <filename>/dev/nvme*</filename>
145 instead of <filename>/dev/sd*</filename>), enable NVME support or
146 the LFS system won't boot:</para>
147
148 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
149 href="kernel/nvme.xml"/>
150 </note>
151
152 <note revision="systemd">
153 <para>While "The IPv6 Protocol" is not strictly
154 required, it is highly recommended by the systemd developers.</para>
155 </note>
156
157 <para>There are several other options that may be desired
158 depending on the requirements for the system. For a list of options needed
159 for BLFS packages, see the <ulink
160 url="&lfs-root;blfs/view/&short-version;/longindex.html#kernel-config-index">BLFS
161 Index of Kernel Settings</ulink>.</para>
162
163 <note>
164 <para>If your host hardware is using UEFI and you wish to boot the
165 LFS system with it, you should adjust some kernel configuration
166 following <ulink url="&blfs-book;postlfs/grub-setup.html#uefi-kernel">
167 the BLFS page</ulink> <emphasis role='bold'>even if you'll use the
168 UEFI bootloader from the host distro</emphasis>.</para>
169 </note>
170
171 <variablelist>
172 <title>The rationale for the above configuration items:</title>
173
174 <varlistentry>
175 <term><parameter>Randomize the address of the kernel image (KASLR)</parameter></term>
176 <listitem>
177 <para>Enable ASLR for kernel image, to mitigate some attacks based
178 on fixed addresses of sensitive data or code in the kernel.</para>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry>
183 <term>
184 <parameter>
185 Compile the kernel with warnings as errors
186 </parameter>
187 </term>
188 <listitem>
189 <para>This may cause building failure if the compiler and/or
190 configuration are different from those of the kernel
191 developers.</para>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry>
196 <term>
197 <parameter>
198 Enable kernel headers through /sys/kernel/kheaders.tar.xz
199 </parameter>
200 </term>
201 <listitem>
202 <para>This will require <command>cpio</command> building the kernel.
203 <command>cpio</command> is not installed by LFS.</para>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry>
208 <term>
209 <parameter>
210 Configure standard kernel features (expert users)
211 </parameter>
212 </term>
213 <listitem>
214 <para>This will make some options show up in the configuration
215 interface but changing those options may be dangerous. Do not use
216 this unless you know what you are doing.</para>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry>
221 <term><parameter>Strong Stack Protector</parameter></term>
222 <listitem>
223 <para>Enable SSP for the kernel. We've enabled it for the entire
224 userspace with <parameter>--enable-default-ssp</parameter>
225 configuring GCC, but the kernel does not use GCC default setting
226 for SSP. We enable it explicitly here.</para>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry>
231 <term><parameter>Support for uevent helper</parameter></term>
232 <listitem>
233 <para>Having this option set may interfere with device
234 management when using Udev.</para>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry>
239 <term><parameter>Maintain a devtmpfs</parameter></term>
240 <listitem>
241 <para>This will create automated device nodes which are populated by the
242 kernel, even without Udev running. Udev then runs on top of this,
243 managing permissions and adding symlinks. This configuration
244 item is required for all users of Udev.</para>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry>
249 <term><parameter>Automount devtmpfs at /dev</parameter></term>
250 <listitem>
251 <para>This will mount the kernel view of the devices on /dev
252 upon switching to root filesystem just before starting
253 init.</para>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry>
258 <term><parameter>Enable the generic EFI decompressor</parameter></term>
259 <listitem>
260 <para>Create the bootable image as an EFI application that carries
261 the actual kernel image in compressed form. It can make the
262 bootable image 50% smaller.</para>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry>
267 <term><parameter>Framebuffer Console support</parameter></term>
268 <listitem>
269 <para>This is needed to display the Linux console on a frame
270 buffer device. To allow the kernel to print debug messages at an
271 early boot stage, it shouldn't be built as a kernel module
272 unless an initramfs will be used. And, if
273 <option>CONFIG_DRM</option> (Direct Rendering Manager) is enabled,
274 it's likely <option>CONFIG_DRM_FBDEV_EMULATION</option> (Enable
275 legacy fbdev support for your modesetting driver) should be
276 enabled as well.</para>
277 </listitem>
278 </varlistentry>
279
280 </variablelist>
281
282 <para>Alternatively, <command>make oldconfig</command> may be more
283 appropriate in some situations. See the <filename>README</filename>
284 file for more information.</para>
285
286 <para>If desired, skip kernel configuration by copying the kernel
287 config file, <filename>.config</filename>, from the host system
288 (assuming it is available) to the unpacked <filename
289 class="directory">linux-&linux-version;</filename> directory. However,
290 we do not recommend this option. It is often better to explore all the
291 configuration menus and create the kernel configuration from
292 scratch.</para>
293
294 <para>Fix an issue causing all kernel modules built with Binutils-2.41
295 or later not loadable:</para>
296
297<screen><userinput remap="pre">cat &gt;&gt; arch/loongarch/Makefile &lt;&lt; EOF
298<literal>KBUILD_AFLAGS_MODULE += -Wa,-mno-relax
299KBUILD_CFLAGS_MODULE += -Wa,-mno-relax</literal>
300EOF</userinput></screen>
301
302 <para>Compile the kernel image and modules:</para>
303
304<screen><userinput remap="make">make</userinput></screen>
305
306 <para>If using kernel modules, module configuration in <filename
307 class="directory">/etc/modprobe.d</filename> may be required.
308 Information pertaining to modules and kernel configuration is
309 located in <xref linkend="ch-config-udev"/> and in the kernel
310 documentation in the <filename
311 class="directory">linux-&linux-version;/Documentation</filename> directory.
312 Also, <filename>modprobe.d(5)</filename> may be of interest.</para>
313
314 <para>Unless module support has been disabled in the kernel configuration,
315 install the modules with:</para>
316
317<screen><userinput remap="install">make modules_install</userinput></screen>
318
319 <para>After kernel compilation is complete, additional steps are
320 required to complete the installation. Some files need to be copied to
321 the <filename class="directory">/boot</filename> directory.</para>
322
323 <caution>
324 <para>If you've decided to use a separate &boot-dir; partition for the
325 LFS system (maybe sharing a &boot-dir; partition with the host
326 distro) , the files copied below should go there. The easiest way to
327 do that is to create the entry for &boot-dir; in &fstab; first (read
328 the previous section for details), then issue the following command
329 as the &root; user in the
330 <emphasis>chroot environment</emphasis>:</para>
331
332<screen role="nodump"><userinput>mount /boot</userinput></screen>
333
334 <para>The path to the device node is omitted in the command because
335 <command>mount</command> can read it from &fstab;.</para>
336 </caution>
337
338 <para>The path to the kernel image may vary depending on the platform being
339 used. The filename below can be changed to suit your taste, but the stem of
340 the filename should be <emphasis>vmlinuz</emphasis> to be compatible with
341 the automatic setup of the boot process described in the next section. The
342 following command assumes a LoongArch platform with an EFI boot loader
343 (for example, GRUB built in &ch-final;):</para>
344
345<screen><userinput remap="install">cp -iv arch/loongarch/boot/vmlinuz.efi /boot/vmlinuz-&linux-version;-lfs-&version;</userinput></screen>
346
347 <para><filename>System.map</filename> is a symbol file for the kernel.
348 It maps the function entry points of every function in the kernel API,
349 as well as the addresses of the kernel data structures for the running
350 kernel. It is used as a resource when investigating kernel problems.
351 Issue the following command to install the map file:</para>
352
353<screen><userinput remap="install">cp -iv System.map /boot/System.map-&linux-version;</userinput></screen>
354
355 <para>The kernel configuration file <filename>.config</filename>
356 produced by the <command>make menuconfig</command> step
357 above contains all the configuration selections for the kernel
358 that was just compiled. It is a good idea to keep this file for future
359 reference:</para>
360
361<screen><userinput remap="install">cp -iv .config /boot/config-&linux-version;</userinput></screen>
362
363 <para>Install the documentation for the Linux kernel:</para>
364
365<screen><userinput remap="install">cp -r Documentation -T /usr/share/doc/linux-&linux-version;</userinput></screen>
366
367 <para>It is important to note that the files in the kernel source
368 directory are not owned by <emphasis>root</emphasis>. Whenever a
369 package is unpacked as user <emphasis>root</emphasis> (like we did
370 inside chroot), the files have the user and group IDs of whatever
371 they were on the packager's computer. This is usually not a problem
372 for any other package to be installed because the source tree is
373 removed after the installation. However, the Linux source tree is
374 often retained for a long time. Because of this, there is a chance
375 that whatever user ID the packager used will be assigned to somebody
376 on the machine. That person would then have write access to the kernel
377 source.</para>
378
379 <note>
380 <para>In many cases, the configuration of the kernel will need to be
381 updated for packages that will be installed later in BLFS. Unlike
382 other packages, it is not necessary to remove the kernel source tree
383 after the newly built kernel is installed.</para>
384
385 <para>If the kernel source tree is going to be retained, run
386 <command>chown -R 0:0</command> on the <filename
387 class="directory">linux-&linux-version;</filename> directory to ensure
388 all files are owned by user <emphasis>root</emphasis>.</para>
389 </note>
390
391 <warning>
392 <para>Some kernel documentation recommends creating a symlink from
393 <filename class="symlink">/usr/src/linux</filename> pointing to the kernel
394 source directory. This is specific to kernels prior to the 2.6 series and
395 <emphasis>must not</emphasis> be created on an LFS system as it can cause
396 problems for packages you may wish to build once your base LFS system is
397 complete.</para>
398 </warning>
399
400 <warning>
401 <para>The headers in the system's <filename
402 class="directory">include</filename> directory (<filename
403 class="directory">/usr/include</filename>) should
404 <emphasis>always</emphasis> be the ones against which Glibc was compiled,
405 that is, the sanitised headers installed in <xref
406 linkend="ch-tools-linux-headers"/>. Therefore, they should
407 <emphasis>never</emphasis> be replaced by either the raw kernel headers
408 or any other kernel sanitized headers.</para>
409 </warning>
410
411 </sect2>
412
413 <sect2 id="conf-modprobe" role="configuration">
414 <title>Configuring Linux Module Load Order</title>
415
416 <indexterm zone="conf-modprobe">
417 <primary sortas="e-/etc/modprobe.d/usb.conf">/etc/modprobe.d/usb.conf</primary>
418 </indexterm>
419
420 <para>Most of the time Linux modules are loaded automatically, but
421 sometimes it needs some specific direction. The program that loads
422 modules, <command>modprobe</command> or <command>insmod</command>, uses
423 <filename>/etc/modprobe.d/usb.conf</filename> for this purpose. This file
424 needs to be created so that if the USB drivers (ehci_hcd, ohci_hcd and
425 uhci_hcd) have been built as modules, they will be loaded in the correct
426 order; ehci_hcd needs to be loaded prior to ohci_hcd and uhci_hcd in order
427 to avoid a warning being output at boot time.</para>
428
429 <para>Create a new file <filename>/etc/modprobe.d/usb.conf</filename> by running
430 the following:</para>
431
432<screen><userinput>install -v -m755 -d /etc/modprobe.d
433cat &gt; /etc/modprobe.d/usb.conf &lt;&lt; "EOF"
434<literal># Begin /etc/modprobe.d/usb.conf
435
436install ohci_hcd /sbin/modprobe ehci_hcd ; /sbin/modprobe -i ohci_hcd ; true
437install uhci_hcd /sbin/modprobe ehci_hcd ; /sbin/modprobe -i uhci_hcd ; true
438
439# End /etc/modprobe.d/usb.conf</literal>
440EOF</userinput></screen>
441
442 </sect2>
443
444 <sect2 id="contents-kernel" role="content">
445 <title>Contents of Linux</title>
446
447 <segmentedlist>
448 <segtitle>Installed files</segtitle>
449 <segtitle>Installed directories</segtitle>
450
451 <seglistitem>
452 <seg>config-&linux-version;,
453 vmlinuz-&linux-version;-lfs-&version;,
454 and System.map-&linux-version;</seg>
455 <seg>/lib/modules, /usr/share/doc/linux-&linux-version;</seg>
456 </seglistitem>
457 </segmentedlist>
458
459 <variablelist>
460 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
461 <?dbfo list-presentation="list"?>
462 <?dbhtml list-presentation="table"?>
463
464 <varlistentry id="config">
465 <term><filename>config-&linux-version;</filename></term>
466 <listitem>
467 <para>Contains all the configuration selections for the kernel</para>
468 <indexterm zone="ch-bootable-kernel config">
469 <primary sortas="e-/boot/config">/boot/config-&linux-version;</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="lfskernel">
475 <term><filename>vmlinuz-&linux-version;-lfs-&version;</filename></term>
476 <listitem>
477 <para>The engine of the Linux system. When turning on the computer,
478 the kernel is the first part of the operating system that gets loaded.
479 It detects and initializes all components of the computer's hardware,
480 then makes these components available as a tree of files to the
481 software and turns a single CPU into a multitasking machine capable
482 of running scores of programs seemingly at the same time</para>
483 <indexterm zone="ch-bootable-kernel lfskernel">
484 <primary sortas="b-lfskernel">lfskernel-&linux-version;</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="System.map">
490 <term><filename>System.map-&linux-version;</filename></term>
491 <listitem>
492 <para>A list of addresses and symbols; it maps the entry points and
493 addresses of all the functions and data structures in the
494 kernel</para>
495 <indexterm zone="ch-bootable-kernel System.map">
496 <primary sortas="e-/boot/System.map">/boot/System.map-&linux-version;</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500
501 </variablelist>
502
503 </sect2>
504
505</sect1>
Note: See TracBrowser for help on using the repository browser.