blob: 447f767c646276551570baa9de4dd19ccda95c61 [file] [log] [blame]
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +01001.. SPDX-License-Identifier: GPL-2.0
2
3===========================
4Ramfs, rootfs and initramfs
5===========================
6
Rob Landley7f46a242005-11-07 01:01:09 -08007October 17, 2005
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +01008
Randy Dunlapbd415b52023-05-07 22:59:28 -07009:Author: Rob Landley <rob@landley.net>
Rob Landley7f46a242005-11-07 01:01:09 -080010
11What is ramfs?
12--------------
13
14Ramfs is a very simple filesystem that exports Linux's disk caching
15mechanisms (the page cache and dentry cache) as a dynamically resizable
Randy Dunlap18107322007-10-16 23:29:29 -070016RAM-based filesystem.
Rob Landley7f46a242005-11-07 01:01:09 -080017
18Normally all files are cached in memory by Linux. Pages of data read from
19backing store (usually the block device the filesystem is mounted on) are kept
20around in case it's needed again, but marked as clean (freeable) in case the
21Virtual Memory system needs the memory for something else. Similarly, data
22written to files is marked clean as soon as it has been written to backing
23store, but kept around for caching purposes until the VM reallocates the
24memory. A similar mechanism (the dentry cache) greatly speeds up access to
25directories.
26
27With ramfs, there is no backing store. Files written into ramfs allocate
28dentries and page cache as usual, but there's nowhere to write them to.
29This means the pages are never marked clean, so they can't be freed by the
30VM when it's looking to recycle memory.
31
32The amount of code required to implement ramfs is tiny, because all the
33work is done by the existing Linux caching infrastructure. Basically,
34you're mounting the disk cache as a filesystem. Because of this, ramfs is not
35an optional component removable via menuconfig, since there would be negligible
36space savings.
37
38ramfs and ramdisk:
39------------------
40
41The older "ram disk" mechanism created a synthetic block device out of
Randy Dunlap18107322007-10-16 23:29:29 -070042an area of RAM and used it as backing store for a filesystem. This block
Rob Landley7f46a242005-11-07 01:01:09 -080043device was of fixed size, so the filesystem mounted on it was of fixed
44size. Using a ram disk also required unnecessarily copying memory from the
45fake block device into the page cache (and copying changes back out), as well
46as creating and destroying dentries. Plus it needed a filesystem driver
47(such as ext2) to format and interpret this data.
48
49Compared to ramfs, this wastes memory (and memory bus bandwidth), creates
50unnecessary work for the CPU, and pollutes the CPU caches. (There are tricks
51to avoid this copying by playing with the page tables, but they're unpleasantly
52complicated and turn out to be about as expensive as the copying anyway.)
53More to the point, all the work ramfs is doing has to happen _anyway_,
Randy Dunlap18107322007-10-16 23:29:29 -070054since all file access goes through the page and dentry caches. The RAM
55disk is simply unnecessary; ramfs is internally much simpler.
Rob Landley7f46a242005-11-07 01:01:09 -080056
57Another reason ramdisks are semi-obsolete is that the introduction of
58loopback devices offered a more flexible and convenient way to create
59synthetic block devices, now from files instead of from chunks of memory.
60See losetup (8) for details.
61
62ramfs and tmpfs:
63----------------
64
65One downside of ramfs is you can keep writing data into it until you fill
66up all memory, and the VM can't free it because the VM thinks that files
67should get written to backing store (rather than swap space), but ramfs hasn't
68got any backing store. Because of this, only root (or a trusted user) should
69be allowed write access to a ramfs mount.
70
71A ramfs derivative called tmpfs was created to add size limits, and the ability
72to write the data to swap space. Normal users can be allowed write access to
Mauro Carvalho Chehab0c1bc6b2020-04-14 18:48:37 +020073tmpfs mounts. See Documentation/filesystems/tmpfs.rst for more information.
Rob Landley7f46a242005-11-07 01:01:09 -080074
75What is rootfs?
76---------------
77
Rob Landleye7b69052006-06-25 05:49:00 -070078Rootfs is a special instance of ramfs (or tmpfs, if that's enabled), which is
79always present in 2.6 systems. You can't unmount rootfs for approximately the
80same reason you can't kill the init process; rather than having special code
81to check for and handle an empty list, it's smaller and simpler for the kernel
82to just make sure certain lists can't become empty.
Rob Landley7f46a242005-11-07 01:01:09 -080083
Rob Landleye7b69052006-06-25 05:49:00 -070084Most systems just mount another filesystem over rootfs and ignore it. The
Rob Landley7f46a242005-11-07 01:01:09 -080085amount of space an empty instance of ramfs takes up is tiny.
86
Rob Landley6e19ede2013-09-11 14:26:13 -070087If CONFIG_TMPFS is enabled, rootfs will use tmpfs instead of ramfs by
88default. To force ramfs, add "rootfstype=ramfs" to the kernel command
89line.
90
Rob Landley7f46a242005-11-07 01:01:09 -080091What is initramfs?
92------------------
93
94All 2.6 Linux kernels contain a gzipped "cpio" format archive, which is
95extracted into rootfs when the kernel boots up. After extracting, the kernel
96checks to see if rootfs contains a file "init", and if so it executes it as PID
971. If found, this init process is responsible for bringing the system the
98rest of the way up, including locating and mounting the real root device (if
99any). If rootfs does not contain an init program after the embedded cpio
100archive is extracted into it, the kernel will fall through to the older code
101to locate and mount a root partition, then exec some variant of /sbin/init
102out of that.
103
104All this differs from the old initrd in several ways:
105
Rob Landleye7b69052006-06-25 05:49:00 -0700106 - The old initrd was always a separate file, while the initramfs archive is
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100107 linked into the linux kernel image. (The directory ``linux-*/usr`` is
108 devoted to generating this archive during the build.)
Rob Landley7f46a242005-11-07 01:01:09 -0800109
110 - The old initrd file was a gzipped filesystem image (in some file format,
Rob Landleye7b69052006-06-25 05:49:00 -0700111 such as ext2, that needed a driver built into the kernel), while the new
Rob Landley7f46a242005-11-07 01:01:09 -0800112 initramfs archive is a gzipped cpio archive (like tar only simpler,
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100113 see cpio(1) and Documentation/driver-api/early-userspace/buffer-format.rst).
114 The kernel's cpio extraction code is not only extremely small, it's also
Randy Dunlap18107322007-10-16 23:29:29 -0700115 __init text and data that can be discarded during the boot process.
Rob Landley7f46a242005-11-07 01:01:09 -0800116
117 - The program run by the old initrd (which was called /initrd, not /init) did
118 some setup and then returned to the kernel, while the init program from
119 initramfs is not expected to return to the kernel. (If /init needs to hand
120 off control it can overmount / with a new root device and exec another init
121 program. See the switch_root utility, below.)
122
123 - When switching another root device, initrd would pivot_root and then
124 umount the ramdisk. But initramfs is rootfs: you can neither pivot_root
125 rootfs, nor unmount it. Instead delete everything out of rootfs to
126 free up the space (find -xdev / -exec rm '{}' ';'), overmount rootfs
127 with the new root (cd /newmount; mount --move . /; chroot .), attach
128 stdin/stdout/stderr to the new /dev/console, and exec the new init.
129
Denis Cheng33b13022008-02-03 14:50:11 +0200130 Since this is a remarkably persnickety process (and involves deleting
Rob Landley7f46a242005-11-07 01:01:09 -0800131 commands before you can run them), the klibc package introduced a helper
132 program (utils/run_init.c) to do all this for you. Most other packages
133 (such as busybox) have named this command "switch_root".
134
135Populating initramfs:
136---------------------
137
138The 2.6 kernel build process always creates a gzipped cpio format initramfs
139archive and links it into the resulting kernel binary. By default, this
Rob Landleye7b69052006-06-25 05:49:00 -0700140archive is empty (consuming 134 bytes on x86).
141
frans1838e392008-11-22 15:39:06 +0100142The config option CONFIG_INITRAMFS_SOURCE (in General Setup in menuconfig,
143and living in usr/Kconfig) can be used to specify a source for the
144initramfs archive, which will automatically be incorporated into the
145resulting binary. This option can point to an existing gzipped cpio
146archive, a directory containing files to be archived, or a text file
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100147specification such as the following example::
Rob Landley7f46a242005-11-07 01:01:09 -0800148
149 dir /dev 755 0 0
150 nod /dev/console 644 0 0 c 5 1
151 nod /dev/loop0 644 0 0 b 7 0
152 dir /bin 755 1000 1000
153 slink /bin/sh busybox 777 0 0
154 file /bin/busybox initramfs/busybox 755 0 0
155 dir /proc 755 0 0
156 dir /sys 755 0 0
157 dir /mnt 755 0 0
158 file /init initramfs/init.sh 755 0 0
159
Rob Landley99aef422006-01-08 01:03:43 -0800160Run "usr/gen_init_cpio" (after the kernel build) to get a usage message
161documenting the above file format.
162
Rob Landleye7b69052006-06-25 05:49:00 -0700163One advantage of the configuration file is that root access is not required to
Rob Landley7f46a242005-11-07 01:01:09 -0800164set permissions or create device nodes in the new archive. (Note that those
165two example "file" entries expect to find files named "init.sh" and "busybox" in
166a directory called "initramfs", under the linux-2.6.* directory. See
Mauro Carvalho Chehabec4b78a2019-06-18 15:00:25 -0300167Documentation/driver-api/early-userspace/early_userspace_support.rst for more details.)
Rob Landley7f46a242005-11-07 01:01:09 -0800168
Rob Landleye7b69052006-06-25 05:49:00 -0700169The kernel does not depend on external cpio tools. If you specify a
170directory instead of a configuration file, the kernel's build infrastructure
171creates a configuration file from that directory (usr/Makefile calls
Robert Richter5e60f362021-07-15 11:26:02 +0200172usr/gen_initramfs.sh), and proceeds to package up that directory
Rob Landleye7b69052006-06-25 05:49:00 -0700173using the config file (by feeding it to usr/gen_init_cpio, which is created
174from usr/gen_init_cpio.c). The kernel's build-time cpio creation code is
175entirely self-contained, and the kernel's boot-time extractor is also
176(obviously) self-contained.
177
178The one thing you might need external cpio utilities installed for is creating
179or extracting your own preprepared cpio files to feed to the kernel build
180(instead of a config file or directory).
181
182The following command line can extract a cpio image (either by the above script
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100183or by the kernel build) back into its component files::
Rob Landley99aef422006-01-08 01:03:43 -0800184
185 cpio -i -d -H newc -F initramfs_data.cpio --no-absolute-filenames
186
Rob Landleye7b69052006-06-25 05:49:00 -0700187The following shell script can create a prebuilt cpio archive you can
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100188use in place of the above config file::
Rob Landleye7b69052006-06-25 05:49:00 -0700189
190 #!/bin/sh
191
192 # Copyright 2006 Rob Landley <rob@landley.net> and TimeSys Corporation.
193 # Licensed under GPL version 2
194
195 if [ $# -ne 2 ]
196 then
197 echo "usage: mkinitramfs directory imagename.cpio.gz"
198 exit 1
199 fi
200
201 if [ -d "$1" ]
202 then
203 echo "creating $2 from $1"
204 (cd "$1"; find . | cpio -o -H newc | gzip) > "$2"
205 else
206 echo "First argument must be a directory"
207 exit 1
208 fi
209
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100210.. Note::
211
212 The cpio man page contains some bad advice that will break your initramfs
213 archive if you follow it. It says "A typical way to generate the list
214 of filenames is with the find command; you should give find the -depth
215 option to minimize problems with permissions on directories that are
216 unwritable or not searchable." Don't do this when creating
217 initramfs.cpio.gz images, it won't work. The Linux kernel cpio extractor
218 won't create files in a directory that doesn't exist, so the directory
219 entries must go before the files that go in those directories.
220 The above script gets them in the right order.
Rob Landleye7b69052006-06-25 05:49:00 -0700221
222External initramfs images:
223--------------------------
224
225If the kernel has initrd support enabled, an external cpio.gz archive can also
226be passed into a 2.6 kernel in place of an initrd. In this case, the kernel
227will autodetect the type (initramfs, not initrd) and extract the external cpio
228archive into rootfs before trying to run /init.
229
230This has the memory efficiency advantages of initramfs (no ramdisk block
231device) but the separate packaging of initrd (which is nice if you have
232non-GPL code you'd like to run from initramfs, without conflating it with
233the GPL licensed Linux kernel binary).
234
Randy Dunlap18107322007-10-16 23:29:29 -0700235It can also be used to supplement the kernel's built-in initramfs image. The
Rob Landleye7b69052006-06-25 05:49:00 -0700236files in the external archive will overwrite any conflicting files in
237the built-in initramfs archive. Some distributors also prefer to customize
238a single kernel image with task-specific initramfs images, without recompiling.
239
Rob Landley99aef422006-01-08 01:03:43 -0800240Contents of initramfs:
241----------------------
242
Rob Landleye7b69052006-06-25 05:49:00 -0700243An initramfs archive is a complete self-contained root filesystem for Linux.
Rob Landley7f46a242005-11-07 01:01:09 -0800244If you don't already understand what shared libraries, devices, and paths
245you need to get a minimal root filesystem up and running, here are some
246references:
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100247
Alexander A. Klimovc69f22f22020-06-21 15:35:52 +0200248- https://www.tldp.org/HOWTO/Bootdisk-HOWTO/
249- https://www.tldp.org/HOWTO/From-PowerUp-To-Bash-Prompt-HOWTO.html
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100250- http://www.linuxfromscratch.org/lfs/view/stable/
Rob Landley7f46a242005-11-07 01:01:09 -0800251
Alexander A. Klimovc69f22f22020-06-21 15:35:52 +0200252The "klibc" package (https://www.kernel.org/pub/linux/libs/klibc) is
Rob Landley7f46a242005-11-07 01:01:09 -0800253designed to be a tiny C library to statically link early userspace
254code against, along with some related utilities. It is BSD licensed.
255
Alexander A. Klimovc69f22f22020-06-21 15:35:52 +0200256I use uClibc (https://www.uclibc.org) and busybox (https://www.busybox.net)
Rob Landley99aef422006-01-08 01:03:43 -0800257myself. These are LGPL and GPL, respectively. (A self-contained initramfs
Rob Landleye7b69052006-06-25 05:49:00 -0700258package is planned for the busybox 1.3 release.)
Rob Landley7f46a242005-11-07 01:01:09 -0800259
260In theory you could use glibc, but that's not well suited for small embedded
261uses like this. (A "hello world" program statically linked against glibc is
262over 400k. With uClibc it's 7k. Also note that glibc dlopens libnss to do
263name lookups, even when otherwise statically linked.)
264
Rob Landleye7b69052006-06-25 05:49:00 -0700265A good first step is to get initramfs to run a statically linked "hello world"
266program as init, and test it under an emulator like qemu (www.qemu.org) or
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100267User Mode Linux, like so::
Rob Landleye7b69052006-06-25 05:49:00 -0700268
269 cat > hello.c << EOF
270 #include <stdio.h>
271 #include <unistd.h>
272
273 int main(int argc, char *argv[])
274 {
275 printf("Hello world!\n");
276 sleep(999999999);
277 }
278 EOF
fransdd1c53a2008-10-15 22:01:30 -0700279 gcc -static hello.c -o init
Rob Landleye7b69052006-06-25 05:49:00 -0700280 echo init | cpio -o -H newc | gzip > test.cpio.gz
281 # Testing external initramfs using the initrd loading mechanism.
282 qemu -kernel /boot/vmlinuz -initrd test.cpio.gz /dev/zero
283
284When debugging a normal root filesystem, it's nice to be able to boot with
285"init=/bin/sh". The initramfs equivalent is "rdinit=/bin/sh", and it's
286just as useful.
287
Rob Landley99aef422006-01-08 01:03:43 -0800288Why cpio rather than tar?
289-------------------------
290
291This decision was made back in December, 2001. The discussion started here:
292
293 http://www.uwsg.iu.edu/hypermail/linux/kernel/0112.2/1538.html
294
295And spawned a second thread (specifically on tar vs cpio), starting here:
296
297 http://www.uwsg.iu.edu/hypermail/linux/kernel/0112.2/1587.html
298
299The quick and dirty summary version (which is no substitute for reading
300the above threads) is:
301
3021) cpio is a standard. It's decades old (from the AT&T days), and already
303 widely used on Linux (inside RPM, Red Hat's device driver disks). Here's
304 a Linux Journal article about it from 1996:
305
306 http://www.linuxjournal.com/article/1213
307
308 It's not as popular as tar because the traditional cpio command line tools
309 require _truly_hideous_ command line arguments. But that says nothing
310 either way about the archive format, and there are alternative tools,
311 such as:
312
Masanari Iida1f8ee462012-02-13 22:42:58 +0900313 http://freecode.com/projects/afio
Rob Landley99aef422006-01-08 01:03:43 -0800314
3152) The cpio archive format chosen by the kernel is simpler and cleaner (and
316 thus easier to create and parse) than any of the (literally dozens of)
317 various tar archive formats. The complete initramfs archive format is
318 explained in buffer-format.txt, created in usr/gen_init_cpio.c, and
319 extracted in init/initramfs.c. All three together come to less than 26k
320 total of human-readable text.
321
3223) The GNU project standardizing on tar is approximately as relevant as
323 Windows standardizing on zip. Linux is not part of either, and is free
324 to make its own technical decisions.
325
3264) Since this is a kernel internal format, it could easily have been
327 something brand new. The kernel provides its own tools to create and
328 extract this format anyway. Using an existing standard was preferable,
329 but not essential.
330
3315) Al Viro made the decision (quote: "tar is ugly as hell and not going to be
332 supported on the kernel side"):
333
334 http://www.uwsg.iu.edu/hypermail/linux/kernel/0112.2/1540.html
335
336 explained his reasoning:
337
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100338 - http://www.uwsg.iu.edu/hypermail/linux/kernel/0112.2/1550.html
339 - http://www.uwsg.iu.edu/hypermail/linux/kernel/0112.2/1638.html
Rob Landley99aef422006-01-08 01:03:43 -0800340
341 and, most importantly, designed and implemented the initramfs code.
342
Rob Landley7f46a242005-11-07 01:01:09 -0800343Future directions:
344------------------
345
Rob Landleye7b69052006-06-25 05:49:00 -0700346Today (2.6.16), initramfs is always compiled in, but not always used. The
Rob Landley7f46a242005-11-07 01:01:09 -0800347kernel falls back to legacy boot code that is reached only if initramfs does
348not contain an /init program. The fallback is legacy code, there to ensure a
349smooth transition and allowing early boot functionality to gradually move to
350"early userspace" (I.E. initramfs).
351
352The move to early userspace is necessary because finding and mounting the real
353root device is complex. Root partitions can span multiple devices (raid or
354separate journal). They can be out on the network (requiring dhcp, setting a
Randy Dunlap18107322007-10-16 23:29:29 -0700355specific MAC address, logging into a server, etc). They can live on removable
Rob Landley7f46a242005-11-07 01:01:09 -0800356media, with dynamically allocated major/minor numbers and persistent naming
357issues requiring a full udev implementation to sort out. They can be
358compressed, encrypted, copy-on-write, loopback mounted, strangely partitioned,
359and so on.
360
361This kind of complexity (which inevitably includes policy) is rightly handled
362in userspace. Both klibc and busybox/uClibc are working on simple initramfs
Rob Landleye7b69052006-06-25 05:49:00 -0700363packages to drop into a kernel build.
Rob Landley7f46a242005-11-07 01:01:09 -0800364
Rob Landleye7b69052006-06-25 05:49:00 -0700365The klibc package has now been accepted into Andrew Morton's 2.6.17-mm tree.
366The kernel's current early boot code (partition detection, etc) will probably
367be migrated into a default initramfs, automatically created and used by the
368kernel build.