- mkinitcpio
- Contents
- Installation
- Image creation and activation
- Automated generation
- Manual generation
- Customized generation
- Configuration
- MODULES
- BINARIES and FILES
- HOOKS
- Build hooks
- Runtime hooks
- Common hooks
- COMPRESSION
- COMPRESSION_OPTIONS
- Runtime customization
- init from base hook
- Using RAID
- Using net
- Using LVM
- Using encrypted root
- /usr as a separate partition
- Troubleshooting
- Extracting the image
- Recompressing a modified extracted image
- «/dev must be mounted» when it already is
- Possibly missing firmware for module XXXX
- No PS/2 controller found
- Standard rescue procedures
- Boot succeeds on one machine and fails on another
mkinitcpio
mkinitcpio is a Bash script used to create an initial ramdisk environment. From the mkinitcpio(8) man page:
The initial ramdisk is in essence a very small environment (early userspace) which loads various kernel modules and sets up necessary things before handing over control to init . This makes it possible to have, for example, encrypted root file systems and root file systems on a software RAID array. mkinitcpio allows for easy extension with custom hooks, has autodetection at runtime, and many other features.
Traditionally, the kernel was responsible for all hardware detection and initialization tasks early in the boot process before mounting the root file system and passing control to init . However, as technology advances, these tasks have become increasingly complex.
Nowadays, the root file system may be on a wide range of hardware, from SCSI to SATA to USB drives, controlled by a variety of drive controllers from different manufacturers. Additionally, the root file system may be encrypted or compressed; within a software RAID array or a logical volume group. The simple way to handle that complexity is to pass management into userspace: an initial ramdisk. See also: /dev/brain0 » Blog Archive » Early Userspace in Arch Linux.
mkinitcpio has been developed by the Arch Linux developers and from community contributions. See the public Git repository.
Contents
Installation
Install the mkinitcpio package, which is a dependency of the linux package, so most users will already have it installed.
Advanced users may wish to install the latest development version of mkinitcpio from Git with the mkinitcpio-git AUR package.
Image creation and activation
Automated generation
Every time a kernel is installed or upgraded, a pacman hook automatically generates a .preset file saved in /etc/mkinitcpio.d/ . For example linux.preset for the official stable linux kernel package. A preset is simply a list of information required to create initial ramdisk images, instead of manually specifying the various parameters and the location of the output files. By default, it contains the instructions to create two images:
- the default ramdisk image created following the directives specified in the mkinitcpio #Configuration, and
- the fallback ramdisk image, same as above except that the autodetect hook is skipped during creation, thus including a full range of modules which supports most systems.
After creating the preset, the pacman hook calls the mkinitcpio script which generates the two images, using the information provided in the preset.
Manual generation
To run the script manually, refer to the mkinitcpio(8) manual page for instructions. In particular, to (re-)generate the preset provided by a kernel package, use the -p / —preset option followed by the preset to utilize. For example, for the linux package, use the command:
To (re-)generate all existing presets, use the -P / —allpresets switch. This is typically used to regenerate all the initramfs images after a change of the global #Configuration:
Users may create any number of initramfs images with a variety of different configurations. The desired image must be specified in the respective boot loader configuration file.
Customized generation
Users can generate an image using an alternative configuration file. For example, the following will generate an initial ramdisk image according to the directions in /etc/mkinitcpio-custom.conf and save it as /boot/initramfs-custom.img .
If generating an image for a kernel other than the one currently running, add the kernel release version to the command line. The installed kernel releases can be found in /usr/lib/modules/ , the syntax is consistent with the output of the command uname -r for each kernel.
Configuration
The primary configuration file for mkinitcpio is /etc/mkinitcpio.conf . Additionally, preset definitions are provided by kernel packages in the /etc/mkinitcpio.d directory (e.g. /etc/mkinitcpio.d/linux.preset ).
Users can modify six variables within the configuration file, see mkinitcpio.conf(5) for more details:
MODULES Kernel modules to be loaded before any boot hooks are run. BINARIES Additional binaries to be included in the initramfs image. FILES Additional files to be included in the initramfs image. HOOKS Hooks are scripts that execute in the initial ramdisk. COMPRESSION Used to compress the initramfs image. COMPRESSION_OPTIONS Extra arguments to pass to the COMPRESSION program. Usage of this setting is strongly discouraged. mkinitcpio will handle special requirements for compressors (e.g. passing —check=crc32 to xz), and misusage can easily lead to an unbootable system.
MODULES
The MODULES array is used to specify modules to load before anything else is done.
Modules suffixed with a ? will not throw errors if they are not found. This might be useful for custom kernels that compile in modules which are listed explicitly in a hook or configuration file.
BINARIES and FILES
These options allow users to add files to the image. Both BINARIES and FILES are added before hooks are run, and may be used to override files used or provided by a hook. BINARIES are auto-located within a standard PATH and are dependency-parsed, meaning any required libraries will also be added. FILES are added as-is. For example:
Note that as both BINARIES and FILES are Bash arrays, multiple entries can be added delimited with spaces.
HOOKS
The HOOKS array is the most important setting in the file. Hooks are small scripts which describe what will be added to the image. For some hooks, they will also contain a runtime component which provides additional behavior, such as starting a daemon, or assembling a stacked block device. Hooks are referred to by their name, and executed in the order they exist in the HOOKS array of the configuration file.
The default HOOKS setting should be sufficient for most simple, single disk setups. For root devices which are stacked or multi-block devices such as LVM, RAID, or dm-crypt, see the respective wiki pages for further necessary configuration.
Build hooks
Build hooks are found in /usr/lib/initcpio/install/ , custom build hooks can be placed in /etc/initcpio/install/ . These files are sourced by the bash shell during runtime of mkinitcpio and should contain two functions: build and help . The build function describes the modules, files, and binaries which will be added to the image. An API, documented by mkinitcpio(8) , serves to facilitate the addition of these items. The help function outputs a description of what the hook accomplishes.
For a list of all available hooks:
Use mkinitcpio’s -H / —hookhelp option to output help for a specific hook, for example:
Runtime hooks
Runtime hooks are found in /usr/lib/initcpio/hooks/ , custom runtime hooks can be placed in /etc/initcpio/hooks/ . For any runtime hook, there should always be a build hook of the same name, which calls add_runscript to add the runtime hook to the image. These files are sourced by the busybox ash shell during early userspace. With the exception of cleanup hooks, they will always be run in the order listed in the HOOKS setting. Runtime hooks may contain several functions:
run_earlyhook : Functions of this name will be run once the API file systems have been mounted and the kernel command line has been parsed. This is generally where additional daemons, such as udev, which are needed for the early boot process are started from.
run_hook : Functions of this name are run shortly after the early hooks. This is the most common hook point, and operations such as assembly of stacked block devices should take place here.
run_latehook : Functions of this name are run after the root device has been mounted. This should be used, sparingly, for further setup of the root device, or for mounting other file systems, such as /usr .
run_cleanuphook : Functions of this name are run as late as possible, and in the reverse order of how they are listed in the HOOKS array in the configuration file. These hooks should be used for any last minute cleanup, such as shutting down any daemons started by an early hook.
Common hooks
A table of common hooks and how they affect image creation and runtime follows. Note that this table is not complete, as packages can provide custom hooks.
This article or section needs expansion.
busybox init | systemd init | Build hook | Runtime hook (busybox init only) |
---|---|---|---|
base | Sets up all initial directories and installs base utilities and libraries. Always keep this hook as the first hook unless you know what you are doing, as it provides critical busybox init when not using systemd hook. Provides a busybox recovery shell when using systemd hook. |
The use of this hook requires the rw parameter to be set on the kernel command line (discussion). See fsck#Boot time checking for more details.
COMPRESSION
The kernel supports several formats for compression of the initramfs: gzip , bzip2 , lzma, xz , lzo , lz4 and zstd . mkinitcpio uses zstd compressed images by default, note that the zstd compression runs in multi-threading mode (with the -T0 option which spawns as many threads as detected cores).
The provided mkinitcpio.conf has the various COMPRESSION options commented out. Uncomment one if you wish to switch to another compression method and make sure you have the corresponding compression utility installed. If none is specified, the zstd default method is used. If you wish to create an uncompressed image, specify COMPRESSION=cat in the config file or use -z cat on the command line.
COMPRESSION_OPTIONS
These are additional flags passed to the program specified by COMPRESSION , such as:
Runtime customization
This article or section needs expansion.
Runtime configuration options can be passed to init and certain hooks via the kernel command line. Kernel command-line parameters are often supplied by the bootloader. The options discussed below can be appended to the kernel command line to alter default behavior. See Kernel parameters and Arch boot process for more information.
init from base hook
See Boot debugging and mkinitcpio(8) for other parameters.
Using RAID
Using net
net requires the mkinitcpio-nfs-utils package.
Comprehensive and up-to-date information can be found in the official kernel documentation.
This parameter tells the kernel how to configure IP addresses of devices and also how to set up the IP routing table. It can take up to nine arguments separated by colons: ip= : : : : : :: : .
If this parameter is missing from the kernel command line, all fields are assumed to be empty, and the defaults mentioned in the kernel documentation apply. In general this means that the kernel tries to configure everything using autoconfiguration.
For parameters explanation, see the kernel documentation.
If you have multiple network cards, this parameter can include the MAC address of the interface you are booting from. This is often useful as interface numbering may change, or in conjunction with pxelinux IPAPPEND 2 or IPAPPEND 3 option. If not given, eth0 will be used.
If the nfsroot parameter is NOT given on the command line, the default /tftpboot/%s will be used.
Run mkinitcpio -H net for parameter explanation.
Using LVM
Using encrypted root
If using an encrypted root see dm-crypt/System configuration#mkinitcpio for detailed information on which hooks to include.
/usr as a separate partition
If you keep /usr as a separate partition, you must adhere to the following requirements:
- Add the fsck hook, mark /usr with a passno of 2 in /etc/fstab to run the check on the partition at startup. While recommended for everyone, it is mandatory if you want your /usr partition to be fsck’ed at boot-up. Without this hook, /usr will never be fsck’d.
- If not using the systemd hook, add the usr hook. This will mount the /usr partition after root is mounted.
Troubleshooting
Extracting the image
If you are curious about what is inside the initramfs image, you can extract it and poke at the files inside of it.
The initramfs image is an SVR4 CPIO archive, generated via the find and bsdcpio commands, optionally compressed with a compression scheme understood by the kernel. For more information on the compression schemes, see #COMPRESSION.
mkinitcpio includes a utility called lsinitcpio which will list and/or extract the contents of initramfs images.
You can list the files in the image with:
And to extract them all in the current directory:
You can also get a more human-friendly listing of the important parts in the image:
Recompressing a modified extracted image
Invoke the build_image function of the /usr/bin/mkinitcpio script with parameters
It can be done by creating a new script with the contents of the build_image function and running it with the above parameters. This will compress the contents present in the current directory in a file named outfile .
«/dev must be mounted» when it already is
The test used by mkinitcpio to determine if /dev is mounted is to see if /dev/fd/ is there. If everything else looks fine, it can be «created» manually by:
(Obviously, /proc must be mounted as well. mkinitcpio requires that anyway, and that is the next thing it will check.)
Possibly missing firmware for module XXXX
When initramfs are being rebuild after a kernel update, you might get these or similar warnings:
These appear to most Arch Linux users, as the firmware is not included in the linux-firmware package. If you do not use hardware which uses these firmwares you can safely ignore this message. Currently, the only solution for suppressing warnings for wd719x and aic94xx modules is actually installing firmware packages for them. For aic94xx, install aic94xx-firmware AUR . For wd719x, install wd719x-firmware AUR . For xhci_pci, install upd72020x-fw AUR . See related discussion here.
Most common firmware files can be acquired by installing the linux-firmware package. For other packages proving firmware, try searching for the module name in the official repositories or AUR.
No PS/2 controller found
On some motherboards (mostly ancient ones, but also a few new ones), the i8042 controller cannot be automatically detected. It is rare, but some people will surely be without keyboard. You can detect this situation in advance. If you have a PS/2 port and get i8042: PNP: No PS/2 controller found. Probing ports directly message, add atkbd to the MODULES array.
Standard rescue procedures
With an improper initial ram-disk a system often is unbootable. So follow a system rescue procedure like below:
Boot succeeds on one machine and fails on another
mkinitcpio’s autodetect hook filters unneeded kernel modules in the primary initramfs scanning /sys and the modules loaded at the time it is run. If you transfer your /boot directory to another machine and the boot sequence fails during early userspace, it may be because the new hardware is not detected due to missing kernel modules. Note that USB 2.0 and 3.0 need different kernel modules.
To fix, first try choosing the fallback image from your bootloader, as it is not filtered by autodetect . Once booted, run mkinitcpio on the new machine to rebuild the primary image with the correct modules. If the fallback image fails, try booting into an Arch Linux live CD/USB, chroot into the installation, and run mkinitcpio on the new machine. As a last resort, try manually adding modules to the initramfs.
Источник