[PATCH] devfs: Last little devfs cleanups throughout the kernel tree.
[linux-2.6.git] / Documentation / initrd.txt
1 Using the initial RAM disk (initrd)
2 ===================================
3
4 Written 1996,2000 by Werner Almesberger <werner.almesberger@epfl.ch> and
5                      Hans Lermen <lermen@fgan.de>
6
7
8 initrd provides the capability to load a RAM disk by the boot loader.
9 This RAM disk can then be mounted as the root file system and programs
10 can be run from it. Afterwards, a new root file system can be mounted
11 from a different device. The previous root (from initrd) is then moved
12 to a directory and can be subsequently unmounted.
13
14 initrd is mainly designed to allow system startup to occur in two phases,
15 where the kernel comes up with a minimum set of compiled-in drivers, and
16 where additional modules are loaded from initrd.
17
18 This document gives a brief overview of the use of initrd. A more detailed
19 discussion of the boot process can be found in [1].
20
21
22 Operation
23 ---------
24
25 When using initrd, the system typically boots as follows:
26
27   1) the boot loader loads the kernel and the initial RAM disk
28   2) the kernel converts initrd into a "normal" RAM disk and
29      frees the memory used by initrd
30   3) initrd is mounted read-write as root
31   4) /linuxrc is executed (this can be any valid executable, including
32      shell scripts; it is run with uid 0 and can do basically everything
33      init can do)
34   5) linuxrc mounts the "real" root file system
35   6) linuxrc places the root file system at the root directory using the
36      pivot_root system call
37   7) the usual boot sequence (e.g. invocation of /sbin/init) is performed
38      on the root file system
39   8) the initrd file system is removed
40
41 Note that changing the root directory does not involve unmounting it.
42 It is therefore possible to leave processes running on initrd during that
43 procedure. Also note that file systems mounted under initrd continue to
44 be accessible.
45
46
47 Boot command-line options
48 -------------------------
49
50 initrd adds the following new options:
51
52   initrd=<path>    (e.g. LOADLIN)
53
54     Loads the specified file as the initial RAM disk. When using LILO, you
55     have to specify the RAM disk image file in /etc/lilo.conf, using the
56     INITRD configuration variable.
57
58   noinitrd
59
60     initrd data is preserved but it is not converted to a RAM disk and
61     the "normal" root file system is mounted. initrd data can be read
62     from /dev/initrd. Note that the data in initrd can have any structure
63     in this case and doesn't necessarily have to be a file system image.
64     This option is used mainly for debugging.
65
66     Note: /dev/initrd is read-only and it can only be used once. As soon
67     as the last process has closed it, all data is freed and /dev/initrd
68     can't be opened anymore.
69
70   root=/dev/ram0
71
72     initrd is mounted as root, and the normal boot procedure is followed,
73     with the RAM disk still mounted as root.
74
75
76 Installation
77 ------------
78
79 First, a directory for the initrd file system has to be created on the
80 "normal" root file system, e.g.
81
82 # mkdir /initrd
83
84 The name is not relevant. More details can be found on the pivot_root(2)
85 man page.
86
87 If the root file system is created during the boot procedure (i.e. if
88 you're building an install floppy), the root file system creation
89 procedure should create the /initrd directory.
90
91 If initrd will not be mounted in some cases, its content is still
92 accessible if the following device has been created:
93
94 # mknod /dev/initrd b 1 250 
95 # chmod 400 /dev/initrd
96
97 Second, the kernel has to be compiled with RAM disk support and with
98 support for the initial RAM disk enabled. Also, at least all components
99 needed to execute programs from initrd (e.g. executable format and file
100 system) must be compiled into the kernel.
101
102 Third, you have to create the RAM disk image. This is done by creating a
103 file system on a block device, copying files to it as needed, and then
104 copying the content of the block device to the initrd file. With recent
105 kernels, at least three types of devices are suitable for that:
106
107  - a floppy disk (works everywhere but it's painfully slow)
108  - a RAM disk (fast, but allocates physical memory)
109  - a loopback device (the most elegant solution)
110
111 We'll describe the loopback device method:
112
113  1) make sure loopback block devices are configured into the kernel
114  2) create an empty file system of the appropriate size, e.g.
115     # dd if=/dev/zero of=initrd bs=300k count=1
116     # mke2fs -F -m0 initrd
117     (if space is critical, you may want to use the Minix FS instead of Ext2)
118  3) mount the file system, e.g.
119     # mount -t ext2 -o loop initrd /mnt
120  4) create the console device:
121     # mkdir /mnt/dev
122     # mknod /mnt/dev/console c 5 1
123  5) copy all the files that are needed to properly use the initrd
124     environment. Don't forget the most important file, /linuxrc
125     Note that /linuxrc's permissions must include "x" (execute).
126  6) correct operation the initrd environment can frequently be tested
127     even without rebooting with the command
128     # chroot /mnt /linuxrc
129     This is of course limited to initrds that do not interfere with the
130     general system state (e.g. by reconfiguring network interfaces,
131     overwriting mounted devices, trying to start already running demons,
132     etc. Note however that it is usually possible to use pivot_root in
133     such a chroot'ed initrd environment.)
134  7) unmount the file system
135     # umount /mnt
136  8) the initrd is now in the file "initrd". Optionally, it can now be
137     compressed
138     # gzip -9 initrd
139
140 For experimenting with initrd, you may want to take a rescue floppy and
141 only add a symbolic link from /linuxrc to /bin/sh. Alternatively, you
142 can try the experimental newlib environment [2] to create a small
143 initrd.
144
145 Finally, you have to boot the kernel and load initrd. Almost all Linux
146 boot loaders support initrd. Since the boot process is still compatible
147 with an older mechanism, the following boot command line parameters
148 have to be given:
149
150   root=/dev/ram0 init=/linuxrc rw
151
152 (rw is only necessary if writing to the initrd file system.)
153
154 With LOADLIN, you simply execute
155
156      LOADLIN <kernel> initrd=<disk_image>
157 e.g. LOADLIN C:\LINUX\BZIMAGE initrd=C:\LINUX\INITRD.GZ root=/dev/ram0
158        init=/linuxrc rw
159
160 With LILO, you add the option INITRD=<path> to either the global section
161 or to the section of the respective kernel in /etc/lilo.conf, and pass
162 the options using APPEND, e.g.
163
164   image = /bzImage
165     initrd = /boot/initrd.gz
166     append = "root=/dev/ram0 init=/linuxrc rw"
167
168 and run /sbin/lilo
169
170 For other boot loaders, please refer to the respective documentation.
171
172 Now you can boot and enjoy using initrd.
173
174
175 Changing the root device
176 ------------------------
177
178 When finished with its duties, linuxrc typically changes the root device
179 and proceeds with starting the Linux system on the "real" root device.
180
181 The procedure involves the following steps:
182  - mounting the new root file system
183  - turning it into the root file system
184  - removing all accesses to the old (initrd) root file system
185  - unmounting the initrd file system and de-allocating the RAM disk
186
187 Mounting the new root file system is easy: it just needs to be mounted on
188 a directory under the current root. Example:
189
190 # mkdir /new-root
191 # mount -o ro /dev/hda1 /new-root
192
193 The root change is accomplished with the pivot_root system call, which
194 is also available via the pivot_root utility (see pivot_root(8) man
195 page; pivot_root is distributed with util-linux version 2.10h or higher
196 [3]). pivot_root moves the current root to a directory under the new
197 root, and puts the new root at its place. The directory for the old root
198 must exist before calling pivot_root. Example:
199
200 # cd /new-root
201 # mkdir initrd
202 # pivot_root . initrd
203
204 Now, the linuxrc process may still access the old root via its
205 executable, shared libraries, standard input/output/error, and its
206 current root directory. All these references are dropped by the
207 following command:
208
209 # exec chroot . what-follows <dev/console >dev/console 2>&1
210
211 Where what-follows is a program under the new root, e.g. /sbin/init
212 If the new root file system will be used with udev and has no valid
213 /dev directory, udev must be initialized before invoking chroot in order
214 to provide /dev/console.
215
216 Note: implementation details of pivot_root may change with time. In order
217 to ensure compatibility, the following points should be observed:
218
219  - before calling pivot_root, the current directory of the invoking
220    process should point to the new root directory
221  - use . as the first argument, and the _relative_ path of the directory
222    for the old root as the second argument
223  - a chroot program must be available under the old and the new root
224  - chroot to the new root afterwards
225  - use relative paths for dev/console in the exec command
226
227 Now, the initrd can be unmounted and the memory allocated by the RAM
228 disk can be freed:
229
230 # umount /initrd
231 # blockdev --flushbufs /dev/ram0
232
233 It is also possible to use initrd with an NFS-mounted root, see the
234 pivot_root(8) man page for details.
235
236 Note: if linuxrc or any program exec'ed from it terminates for some
237 reason, the old change_root mechanism is invoked (see section "Obsolete
238 root change mechanism").
239
240
241 Usage scenarios
242 ---------------
243
244 The main motivation for implementing initrd was to allow for modular
245 kernel configuration at system installation. The procedure would work
246 as follows:
247
248   1) system boots from floppy or other media with a minimal kernel
249      (e.g. support for RAM disks, initrd, a.out, and the Ext2 FS) and
250      loads initrd
251   2) /linuxrc determines what is needed to (1) mount the "real" root FS
252      (i.e. device type, device drivers, file system) and (2) the
253      distribution media (e.g. CD-ROM, network, tape, ...). This can be
254      done by asking the user, by auto-probing, or by using a hybrid
255      approach.
256   3) /linuxrc loads the necessary kernel modules
257   4) /linuxrc creates and populates the root file system (this doesn't
258      have to be a very usable system yet)
259   5) /linuxrc invokes pivot_root to change the root file system and
260      execs - via chroot - a program that continues the installation
261   6) the boot loader is installed
262   7) the boot loader is configured to load an initrd with the set of
263      modules that was used to bring up the system (e.g. /initrd can be
264      modified, then unmounted, and finally, the image is written from
265      /dev/ram0 or /dev/rd/0 to a file)
266   8) now the system is bootable and additional installation tasks can be
267      performed
268
269 The key role of initrd here is to re-use the configuration data during
270 normal system operation without requiring the use of a bloated "generic"
271 kernel or re-compiling or re-linking the kernel.
272
273 A second scenario is for installations where Linux runs on systems with
274 different hardware configurations in a single administrative domain. In
275 such cases, it is desirable to generate only a small set of kernels
276 (ideally only one) and to keep the system-specific part of configuration
277 information as small as possible. In this case, a common initrd could be
278 generated with all the necessary modules. Then, only /linuxrc or a file
279 read by it would have to be different.
280
281 A third scenario are more convenient recovery disks, because information
282 like the location of the root FS partition doesn't have to be provided at
283 boot time, but the system loaded from initrd can invoke a user-friendly
284 dialog and it can also perform some sanity checks (or even some form of
285 auto-detection).
286
287 Last not least, CD-ROM distributors may use it for better installation
288 from CD, e.g. by using a boot floppy and bootstrapping a bigger RAM disk
289 via initrd from CD; or by booting via a loader like LOADLIN or directly
290 from the CD-ROM, and loading the RAM disk from CD without need of
291 floppies. 
292
293
294 Obsolete root change mechanism
295 ------------------------------
296
297 The following mechanism was used before the introduction of pivot_root.
298 Current kernels still support it, but you should _not_ rely on its
299 continued availability.
300
301 It works by mounting the "real" root device (i.e. the one set with rdev
302 in the kernel image or with root=... at the boot command line) as the
303 root file system when linuxrc exits. The initrd file system is then
304 unmounted, or, if it is still busy, moved to a directory /initrd, if
305 such a directory exists on the new root file system.
306
307 In order to use this mechanism, you do not have to specify the boot
308 command options root, init, or rw. (If specified, they will affect
309 the real root file system, not the initrd environment.)
310   
311 If /proc is mounted, the "real" root device can be changed from within
312 linuxrc by writing the number of the new root FS device to the special
313 file /proc/sys/kernel/real-root-dev, e.g.
314
315   # echo 0x301 >/proc/sys/kernel/real-root-dev
316
317 Note that the mechanism is incompatible with NFS and similar file
318 systems.
319
320 This old, deprecated mechanism is commonly called "change_root", while
321 the new, supported mechanism is called "pivot_root".
322
323
324 Resources
325 ---------
326
327 [1] Almesberger, Werner; "Booting Linux: The History and the Future"
328     http://www.almesberger.net/cv/papers/ols2k-9.ps.gz
329 [2] newlib package (experimental), with initrd example
330     http://sources.redhat.com/newlib/
331 [3] Brouwer, Andries; "util-linux: Miscellaneous utilities for Linux"
332     ftp://ftp.win.tue.nl/pub/linux-local/utils/util-linux/