Kernel/Traditional compilation - ArchWiki

Jump to content

# Kernel/Traditional compilation

From ArchWiki
< Kernel

This article is an introduction to building custom kernels from kernel.org sources. This method of compiling kernels is the traditional method common to all distributions. It can be, depending on your background, more complicated than using the Kernel/Arch build system. Consider the Arch build system tools are developed and maintained to make repeatable compilation tasks efficient and safe.

## Preparation

It is not necessary (or recommended) to use the root account or root privileges (i.e. via sudo) for kernel preparation.

### Install the core packages

Install the base-devel meta package, which pulls in necessary packages such as make and gcc. It is also recommended to install the following packages, as listed in the default Arch kernel PKGBUILD: xmlto, kmod, inetutils, bc, libelf, git, cpio, perl, tar, xz.

### Create a kernel compilation directory

It is recommended to create a separate build directory for your kernel(s). In this example, the directory `kernelbuild` will be created in the `home` directory:

    $ mkdir ~/kernelbuild

### Download the kernel source

Download the kernel source from https://www.kernel.org. This should be the tarball (.tar.xz) file for your chosen kernel.

It can be downloaded by simply right-clicking the `tar.xz` link in your browser and selecting `Save Link As...`, or any other number of ways via alternative graphical or command-line tools that utilise HTTP, TFTP, Rsync, or Git.

Note

- It is a good idea to verify the PGP signature of any downloaded kernel tarball. This ensures that it is legitimate and helps to build the Web of Trust. See kernel.org/signature.
- For certain releases (e.g. `-rc` releases), the downloaded archive and resulting directories will not strictly follow the `A.B.C` naming used in the examples of this page, adjust them to your needs.

In the following command-line commands, wget has been installed and is used inside the `~/kernelbuild` directory to obtain kernel A.B.C:

    $ cd ~/kernelbuild
    $ wget https://cdn.kernel.org/pub/linux/kernel/vA.x/linux-A.B.C.tar.xz

You should also verify the correctness of the download before trusting it. First grab the signature, then use that to grab the fingerprint of the signing key, then use the fingerprint to obtain the actual signing key:

    $ wget https://cdn.kernel.org/pub/linux/kernel/vA.x/linux-A.B.C.tar.sign
    $ gpg --list-packets linux-A.B.C.tar.sign | grep -i keyid | awk '{print $NF}' | xargs gpg --recv-keys

Note the signature was generated for the tar archive (i.e. extension `.tar`), not the compressed `.tar.xz` file that you have downloaded. You need to decompress the latter without untarring it. Verify that you have xz installed, then you can proceed like so:

    $ unxz linux-A.B.C.tar.xz
    $ gpg --verify linux-A.B.C.tar.sign linux-A.B.C.tar

Do not proceed if this does not result in output that includes the string "Good signature".

If `wget` was not used inside the build directory, it will be necessary to move the tarball into it, e.g.

    $ mv /path/to/linux-A.B.C.tar.xz ~/kernelbuild/

#### Semi-official kernel mirrors

This article or section needs expansion.

Reason: Instead of using semi-official mirrors, faster initial cloning can be achieved by using the official git bundles. (Discuss in Talk:Kernel/Traditional compilation)

Semi-official mirrors of some of the kernel.org Git repositories are provided by their respective maintainers. These tend to be faster to clone from than kernel.org.

- The mainline branch is mirrored on Linus Torvalds' GitHub account at https://github.com/torvalds/linux.git.
- The stable branches are mirrored on Greg Kroah-Hartman's GitHub account at https://github.com/gregkh/linux. [1]

### Unpack the kernel source

Within the build directory, unpack the kernel tarball:

    $ tar -xvf linux-A.B.C.tar

To be absolutely sure that no permission errors occur, chown needs to be run to transfer ownership of the folder to the current user.

To transfer ownership of a folder with every file in it to our user, run the chown command.

    $ chown -R $USER:$USER linux-A.B.C

This will transfer ownership of every file in the folder to you, so you do not encounter any errors related to permissions.

To finalise the preparation, ensure that the kernel tree is absolutely clean; do not rely on the source tree being clean after unpacking. To do so, first change into the new kernel source directory created, and then run the `make mrproper` command:

    $ cd linux-A.B.C
    $ make mrproper

Note The `mrproper` Make target depends on the `clean` target, and thus, it is not necessary to execute both. See [2] for reference.

## Kernel configuration

This is the most crucial step in customizing the default kernel to reflect your computer's precise specifications. Kernel configuration is set in its `.config` file, which includes the use of Kernel modules. By setting the options in `.config` properly, your kernel and computer will function most efficiently.

Note It is not necessary to use the root account or root privileges at this stage.

You can do a mixture of two things:

- Use the default Arch settings from an official kernel (recommended)
- Manually configure the kernel options (optional, advanced and not recommended)

### Default Arch configuration

This method will create a `.config` file for the custom kernel using the default Arch kernel settings. If a stock Arch kernel is running, you can use the following command inside the custom kernel source directory:

    $ zcat /proc/config.gz > .config

Otherwise, the default configuration can be found online in the official Arch Linux kernel package.

Tip

- If you are upgrading kernels, some options may have changed or been removed. In this case, when running `make` under #Compilation, you will be asked to provide answers to every configuration option that has changed between versions. To accept the defaults without being prompted, run `make olddefconfig`.
- modprobed-db can be used to strip unneeded modules from the default Arch `.config`. Once a properly populated database obtained, run `make LSMOD=$HOME/.config/modprobed.db localmodconfig` to remove all the modules not present in the `modprobed.db` database.

Warning If you are compiling a kernel using your current `.config` file, do not forget to rename your kernel version "CONFIG_LOCALVERSION" in the new `.config` or in the General Setup > Local version - append to kernel release option using one of the user interfaces listed under #Advanced configuration. If you skip this, there is the risk of overwriting one of your existing kernels by mistake.

### Advanced configuration

Tip Unless you want to see a lot of extra messages when booting and shutting down with the custom kernel, it is a good idea to deactivate the relevant debugging options.

There are several tools available to fine-tune the kernel configuration, which provide an alternative to otherwise spending hours manually configuring each and every one of the options available during compilation.

Note Those tools listed below will provide you with three configuration options for each kernel feature: `y` for enabled, `n` for disabled, and `m` for enabled as kernel module (loaded when necessary).

Those tools are:

- `make nconfig`: Newer command-line ncurses interface superseding `menuconfig`
- `make xconfig`: User-friendly graphical interface that requires Qt to be installed as a dependency. This is the recommended method—especially for less experienced users—as it is easier to navigate, and information about each option is also displayed.
- `make gconfig`: Graphical configuration similar to xconfig but using GTK.

The chosen method should be run inside the kernel source directory, and all will either create a new `.config` file, or overwrite an existing one where present. All optional configurations will be automatically enabled, although any newer configuration options (i.e. with an older kernel `.config`) may not be automatically selected.

Once the changes have been made save the `.config` file. It is a good idea to make a backup copy outside the source directory. You may need to do this multiple times before you get all the options right.

If unsure, only change a few options between compilations. If you cannot boot your newly built kernel, see the list of necessary items here.

Running `lspci -k #` from live media lists names of kernel modules in use. Most importantly, you must maintain cgroups support. This is necessary for systemd. For more detailed information, see Gentoo:Kernel/Gentoo Kernel Configuration Guide and Gentoo:Intel#Kernel or Gentoo:Ryzen#Kernel for Intel or AMD Ryzen processors.

## Compilation

Tip If you want to have gcc optimize for your processor's instruction sets, edit `arch/x86/Makefile` within the kernel source directory:

- Look for `CONFIG_MK8,CONFIG_MPSC,CONFIG_MCORE2,CONFIG_MATOM,CONFIG_GENERIC_CPU` that you have chosen in `Processor type and features > Processor Family`
- Change the `call cc-options` flag from `-march=native` to the one that you have selected in Processor Family, e.g. `cflags-$(CONFIG_MK8) += $(call cc-option,-march=native)`. This is probably the best way to compile with `-march=native` as it works.

Compilation time will vary from as little as fifteen minutes to over an hour, depending on your kernel configuration and processor capability. Once the `.config` file has been set for the custom kernel, within the source directory run the following command to compile:

    $ make

Tip To compile faster, make can be run with the `-jX` argument, where `X` is an integer number of parallel jobs. The best results are often achieved using the number of CPU cores in the machine; for example, with a 2-core processor run `make -j2`. See Makepkg#Improving build times for more information.

Start from kernel version 6.11, a new make target `pacman-pkg` is added to build pacman packages directly. You can run the following command to build several `linux-upstream*.pkg.tar.zst` packages which can be installed with `pacman -U <packages>` later.

    $ make pacman-pkg

Installing kernel image and headers package is sufficient to use and test. Api and debug packages can be installed as needed. If one would like to change package name or other makepkg options, edit the file located at `scripts/package/PKGBUILD` in your kernel source directory.

## Installation

### Install the modules

Once the kernel has been compiled, the modules for it must follow. First build the modules:

    $ make modules

Then install the modules. As root or with root privileges, run the following command to do so:

    # make modules_install

This will copy the compiled modules into `/lib/modules/A.B.C/`. This keeps the modules for individual kernels used separated.

Tip If your system requires modules which are not distributed with the regular Linux kernel, you need to compile them for your custom kernel when it is finished. Such modules are typically those which you explicitly installed separately for your running system. See NVIDIA#Custom kernel for an example.

### Copy the kernel to /boot directory

Note Ensure that the `bzImage` kernel file has been copied from the appropriate directory for your system architecture. See below.

The kernel compilation process will generate a compressed `bzImage` (big zImage) of that kernel, if it does not, you may have to run

    $ make bzImage

This file must be copied to the `/boot` directory and renamed in the process. Provided the name is prefixed with `vmlinuz-`, you may name the kernel as you wish. In the examples below, the installed and compiled A.B.C kernel has been copied over and renamed to `vmlinuz-linuxAB`:

    # cp -v arch/x86/boot/bzImage /boot/vmlinuz-linuxAB

### Make initial RAM file system

Note You are free to name the initramfs image file whatever you wish when generating it. However, it is recommended to use the `linuxmajor_revisionminor_revision` convention. This convention will make it easier to maintain multiple kernels, regularly use mkinitcpio, and build third-party modules.
Tip If you are using the LILO boot loader and it cannot communicate with the kernel device-mapper driver, you have to run `modprobe dm-mod` first.

If you do not know what making an initial RAM file system is, see Initramfs on Wikipedia and mkinitcpio.

#### Automated preset method

An existing mkinitcpio preset can be copied and modified so that the custom kernel initramfs images can be generated in the same way as for an official kernel. This is useful where intending to recompile the kernel (e.g. where updated). In the example below, the preset file for the stock Arch kernel will be copied and modified for kernel A.B.C, installed above.

First, copy the existing preset file, renaming it to match the name of the custom kernel specified as a suffix to `/boot/vmlinuz-` when copying the `bzImage`:

    # cp /etc/mkinitcpio.d/linux.preset /etc/mkinitcpio.d/linuxAB.preset

Second, edit the file and amend for the custom kernel. Note (again) that the `ALL_kver=` parameter also matches the name of the custom kernel specified when copying the `bzImage`:

    /etc/mkinitcpio.d/linuxAB.preset

    ...
    ALL_kver="/boot/vmlinuz-linuxAB"
    ...
    default_image="/boot/initramfs-linuxAB.img"
    ...
    fallback_image="/boot/initramfs-linuxAB-fallback.img"

Finally, generate the initramfs images for the custom kernel in the same way as for an official kernel:

    # mkinitcpio -p linuxAB

#### Manual method

Rather than use a preset file, mkinitcpio can also be used to generate an initramfs file manually. The syntax of the command is:

    # mkinitcpio -k kernel_version -g /boot/initramfs-file_name.img

- `-k` (`--kernel kernel_version`): Specifies the modules to use when generating the initramfs image. The `kernel_version` name will be the same as the name the modules directory for it, located in `/usr/lib/modules/` (alternatively, a path to the kernel image can be used).
- `-g` (`--generate file_name`): Specifies the name of the initramfs file to generate in the `/boot` directory. Again, using the naming convention mentioned above is recommended.

For example, the command for the A.B.C custom kernel installed above would be:

    # mkinitcpio -k A.B.C -g /boot/initramfs-linuxAB.img

### Copy System.map

The `System.map` file is not required for booting Linux. It is a type of "phone directory" list of functions in a particular build of a kernel. The `System.map` contains a list of kernel symbols (i.e function names, variable names etc) and their corresponding addresses. This "symbol-name to address mapping" is used by:

- Some processes like klogd, ksymoops, etc.
- By OOPS handler when information has to be dumped to the screen during a kernel crash (i.e info like in which function it has crashed).

Tip EFI system partitions are formatted using FAT32, which does not support symlinks.

If your `/boot` is on a filesystem which supports symlinks (i.e. not FAT32), copy `System.map` to `/boot`, appending your kernel's name to the destination file. Then create a symlink from `/boot/System.map` to point to `/boot/System.map-linuxAB`:

    # cp System.map /boot/System.map-linuxAB
    # ln -sf /boot/System.map-linuxAB /boot/System.map

After completing all steps above, you should have the following 3 files and 1 soft symlink in your `/boot` directory along with any other previously existing files:

- Kernel: `vmlinuz-linuxAB`
- Initramfs: `initramfs-linuxAB.img`
- System Map: `System.map-linuxAB`
- System Map kernel symlink: `System.map` (which symlinks to `System.map-linuxAB`)

## Boot loader configuration

Add an entry for your new kernel in your boot loader configuration file. See Arch boot process#Feature comparison for possible boot loaders, their wiki articles and other information.

Tip Kernel sources include a script to automate the process for LILO: it can be safely ignored if you are using an other boot loader.

## See also

- https://cateee.net/lkddb/web-lkddb/ includes a comprehensive list of the kernel configuration strings and accompanying text, sorted alphabetically.

Category:

- Kernel

Hidden category:

- Pages or sections flagged with Template:Expansion

Kernel/Traditional compilation
Add topic