fs: use kmem_cache_zalloc instead
[pv_ops_mirror.git] / Documentation / kdump / kdump.txt
blob2fedc081b4c8533e2897f1b456b406a0f2555c4b
1 ================================================================
2 Documentation for Kdump - The kexec-based Crash Dumping Solution
3 ================================================================
5 This document includes overview, setup and installation, and analysis
6 information.
8 Overview
9 ========
11 Kdump uses kexec to quickly boot to a dump-capture kernel whenever a
12 dump of the system kernel's memory needs to be taken (for example, when
13 the system panics). The system kernel's memory image is preserved across
14 the reboot and is accessible to the dump-capture kernel.
16 You can use common Linux commands, such as cp and scp, to copy the
17 memory image to a dump file on the local disk, or across the network to
18 a remote system.
20 Kdump and kexec are currently supported on the x86, x86_64, ppc64 and ia64
21 architectures.
23 When the system kernel boots, it reserves a small section of memory for
24 the dump-capture kernel. This ensures that ongoing Direct Memory Access
25 (DMA) from the system kernel does not corrupt the dump-capture kernel.
26 The kexec -p command loads the dump-capture kernel into this reserved
27 memory.
29 On x86 machines, the first 640 KB of physical memory is needed to boot,
30 regardless of where the kernel loads. Therefore, kexec backs up this
31 region just before rebooting into the dump-capture kernel.
33 Similarly on PPC64 machines first 32KB of physical memory is needed for
34 booting regardless of where the kernel is loaded and to support 64K page
35 size kexec backs up the first 64KB memory.
37 All of the necessary information about the system kernel's core image is
38 encoded in the ELF format, and stored in a reserved area of memory
39 before a crash. The physical address of the start of the ELF header is
40 passed to the dump-capture kernel through the elfcorehdr= boot
41 parameter.
43 With the dump-capture kernel, you can access the memory image, or "old
44 memory," in two ways:
46 - Through a /dev/oldmem device interface. A capture utility can read the
47   device file and write out the memory in raw format. This is a raw dump
48   of memory. Analysis and capture tools must be intelligent enough to
49   determine where to look for the right information.
51 - Through /proc/vmcore. This exports the dump as an ELF-format file that
52   you can write out using file copy commands such as cp or scp. Further,
53   you can use analysis tools such as the GNU Debugger (GDB) and the Crash
54   tool to debug the dump file. This method ensures that the dump pages are
55   correctly ordered.
58 Setup and Installation
59 ======================
61 Install kexec-tools
62 -------------------
64 1) Login as the root user.
66 2) Download the kexec-tools user-space package from the following URL:
68 http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/kexec-tools-testing.tar.gz
70 This is a symlink to the latest version, which at the time of writing is
71 20061214, the only release of kexec-tools-testing so far. As other versions
72 are made released, the older onese will remain available at
73 http://www.kernel.org/pub/linux/kernel/people/horms/kexec-tools/
75 Note: Latest kexec-tools-testing git tree is available at
77 git://git.kernel.org/pub/scm/linux/kernel/git/horms/kexec-tools-testing.git
79 http://www.kernel.org/git/?p=linux/kernel/git/horms/kexec-tools-testing.git;a=summary
81 3) Unpack the tarball with the tar command, as follows:
83    tar xvpzf kexec-tools-testing.tar.gz
85 4) Change to the kexec-tools directory, as follows:
87    cd kexec-tools-testing-VERSION
89 5) Configure the package, as follows:
91    ./configure
93 6) Compile the package, as follows:
95    make
97 7) Install the package, as follows:
99    make install
102 Build the system and dump-capture kernels
103 -----------------------------------------
104 There are two possible methods of using Kdump.
106 1) Build a separate custom dump-capture kernel for capturing the
107    kernel core dump.
109 2) Or use the system kernel binary itself as dump-capture kernel and there is
110    no need to build a separate dump-capture kernel. This is possible
111    only with the architecutres which support a relocatable kernel. As
112    of today i386 and ia64 architectures support relocatable kernel.
114 Building a relocatable kernel is advantageous from the point of view that
115 one does not have to build a second kernel for capturing the dump. But
116 at the same time one might want to build a custom dump capture kernel
117 suitable to his needs.
119 Following are the configuration setting required for system and
120 dump-capture kernels for enabling kdump support.
122 System kernel config options
123 ----------------------------
125 1) Enable "kexec system call" in "Processor type and features."
127    CONFIG_KEXEC=y
129 2) Enable "sysfs file system support" in "Filesystem" -> "Pseudo
130    filesystems." This is usually enabled by default.
132    CONFIG_SYSFS=y
134    Note that "sysfs file system support" might not appear in the "Pseudo
135    filesystems" menu if "Configure standard kernel features (for small
136    systems)" is not enabled in "General Setup." In this case, check the
137    .config file itself to ensure that sysfs is turned on, as follows:
139    grep 'CONFIG_SYSFS' .config
141 3) Enable "Compile the kernel with debug info" in "Kernel hacking."
143    CONFIG_DEBUG_INFO=Y
145    This causes the kernel to be built with debug symbols. The dump
146    analysis tools require a vmlinux with debug symbols in order to read
147    and analyze a dump file.
149 Dump-capture kernel config options (Arch Independent)
150 -----------------------------------------------------
152 1) Enable "kernel crash dumps" support under "Processor type and
153    features":
155    CONFIG_CRASH_DUMP=y
157 2) Enable "/proc/vmcore support" under "Filesystems" -> "Pseudo filesystems".
159    CONFIG_PROC_VMCORE=y
160    (CONFIG_PROC_VMCORE is set by default when CONFIG_CRASH_DUMP is selected.)
162 Dump-capture kernel config options (Arch Dependent, i386)
163 --------------------------------------------------------
164 1) On x86, enable high memory support under "Processor type and
165    features":
167    CONFIG_HIGHMEM64G=y
168    or
169    CONFIG_HIGHMEM4G
171 2) On x86 and x86_64, disable symmetric multi-processing support
172    under "Processor type and features":
174    CONFIG_SMP=n
176    (If CONFIG_SMP=y, then specify maxcpus=1 on the kernel command line
177    when loading the dump-capture kernel, see section "Load the Dump-capture
178    Kernel".)
180 3) If one wants to build and use a relocatable kernel,
181    Enable "Build a relocatable kernel" support under "Processor type and
182    features"
184    CONFIG_RELOCATABLE=y
186 4) Use a suitable value for "Physical address where the kernel is
187    loaded" (under "Processor type and features"). This only appears when
188    "kernel crash dumps" is enabled. A suitable value depends upon
189    whether kernel is relocatable or not.
191    If you are using a relocatable kernel use CONFIG_PHYSICAL_START=0x100000
192    This will compile the kernel for physical address 1MB, but given the fact
193    kernel is relocatable, it can be run from any physical address hence
194    kexec boot loader will load it in memory region reserved for dump-capture
195    kernel.
197    Otherwise it should be the start of memory region reserved for
198    second kernel using boot parameter "crashkernel=Y@X". Here X is
199    start of memory region reserved for dump-capture kernel.
200    Generally X is 16MB (0x1000000). So you can set
201    CONFIG_PHYSICAL_START=0x1000000
203 5) Make and install the kernel and its modules. DO NOT add this kernel
204    to the boot loader configuration files.
206 Dump-capture kernel config options (Arch Dependent, x86_64)
207 ----------------------------------------------------------
208 1) On x86 and x86_64, disable symmetric multi-processing support
209    under "Processor type and features":
211    CONFIG_SMP=n
213    (If CONFIG_SMP=y, then specify maxcpus=1 on the kernel command line
214    when loading the dump-capture kernel, see section "Load the Dump-capture
215    Kernel".)
217 2) Use a suitable value for "Physical address where the kernel is
218    loaded" (under "Processor type and features"). This only appears when
219    "kernel crash dumps" is enabled. By default this value is 0x1000000
220    (16MB). It should be the same as X in the "crashkernel=Y@X" boot
221    parameter.
223    For x86_64, normally "CONFIG_PHYSICAL_START=0x1000000".
225 3) Make and install the kernel and its modules. DO NOT add this kernel
226    to the boot loader configuration files.
228 Dump-capture kernel config options (Arch Dependent, ppc64)
229 ----------------------------------------------------------
231 *  Make and install the kernel and its modules. DO NOT add this kernel
232    to the boot loader configuration files.
234 Dump-capture kernel config options (Arch Dependent, ia64)
235 ----------------------------------------------------------
237 - No specific options are required to create a dump-capture kernel
238   for ia64, other than those specified in the arch idependent section
239   above. This means that it is possible to use the system kernel
240   as a dump-capture kernel if desired.
242   The crashkernel region can be automatically placed by the system
243   kernel at run time. This is done by specifying the base address as 0,
244   or omitting it all together.
246   crashkernel=256M@0
247   or
248   crashkernel=256M
250   If the start address is specified, note that the start address of the
251   kernel will be aligned to 64Mb, so if the start address is not then
252   any space below the alignment point will be wasted.
255 Boot into System Kernel
256 =======================
258 1) Update the boot loader (such as grub, yaboot, or lilo) configuration
259    files as necessary.
261 2) Boot the system kernel with the boot parameter "crashkernel=Y@X",
262    where Y specifies how much memory to reserve for the dump-capture kernel
263    and X specifies the beginning of this reserved memory. For example,
264    "crashkernel=64M@16M" tells the system kernel to reserve 64 MB of memory
265    starting at physical address 0x01000000 (16MB) for the dump-capture kernel.
267    On x86 and x86_64, use "crashkernel=64M@16M".
269    On ppc64, use "crashkernel=128M@32M".
271    On ia64, 256M@256M is a generous value that typically works.
272    The region may be automatically placed on ia64, see the
273    dump-capture kernel config option notes above.
275 Load the Dump-capture Kernel
276 ============================
278 After booting to the system kernel, dump-capture kernel needs to be
279 loaded.
281 Based on the architecture and type of image (relocatable or not), one
282 can choose to load the uncompressed vmlinux or compressed bzImage/vmlinuz
283 of dump-capture kernel. Following is the summary.
285 For i386:
286         - Use vmlinux if kernel is not relocatable.
287         - Use bzImage/vmlinuz if kernel is relocatable.
288 For x86_64:
289         - Use vmlinux
290 For ppc64:
291         - Use vmlinux
292 For ia64:
293         - Use vmlinux or vmlinuz.gz
296 If you are using a uncompressed vmlinux image then use following command
297 to load dump-capture kernel.
299    kexec -p <dump-capture-kernel-vmlinux-image> \
300    --initrd=<initrd-for-dump-capture-kernel> --args-linux \
301    --append="root=<root-dev> <arch-specific-options>"
303 If you are using a compressed bzImage/vmlinuz, then use following command
304 to load dump-capture kernel.
306    kexec -p <dump-capture-kernel-bzImage> \
307    --initrd=<initrd-for-dump-capture-kernel> \
308    --append="root=<root-dev> <arch-specific-options>"
310 Please note, that --args-linux does not need to be specified for ia64.
311 It is planned to make this a no-op on that architecture, but for now
312 it should be omitted
314 Following are the arch specific command line options to be used while
315 loading dump-capture kernel.
317 For i386, x86_64 and ia64:
318         "1 irqpoll maxcpus=1"
320 For ppc64:
321         "1 maxcpus=1 noirqdistrib"
324 Notes on loading the dump-capture kernel:
326 * By default, the ELF headers are stored in ELF64 format to support
327   systems with more than 4GB memory. The --elf32-core-headers option can
328   be used to force the generation of ELF32 headers. This is necessary
329   because GDB currently cannot open vmcore files with ELF64 headers on
330   32-bit systems. ELF32 headers can be used on non-PAE systems (that is,
331   less than 4GB of memory).
333 * The "irqpoll" boot parameter reduces driver initialization failures
334   due to shared interrupts in the dump-capture kernel.
336 * You must specify <root-dev> in the format corresponding to the root
337   device name in the output of mount command.
339 * Boot parameter "1" boots the dump-capture kernel into single-user
340   mode without networking. If you want networking, use "3".
342 * We generally don' have to bring up a SMP kernel just to capture the
343   dump. Hence generally it is useful either to build a UP dump-capture
344   kernel or specify maxcpus=1 option while loading dump-capture kernel.
346 Kernel Panic
347 ============
349 After successfully loading the dump-capture kernel as previously
350 described, the system will reboot into the dump-capture kernel if a
351 system crash is triggered.  Trigger points are located in panic(),
352 die(), die_nmi() and in the sysrq handler (ALT-SysRq-c).
354 The following conditions will execute a crash trigger point:
356 If a hard lockup is detected and "NMI watchdog" is configured, the system
357 will boot into the dump-capture kernel ( die_nmi() ).
359 If die() is called, and it happens to be a thread with pid 0 or 1, or die()
360 is called inside interrupt context or die() is called and panic_on_oops is set,
361 the system will boot into the dump-capture kernel.
363 On powererpc systems when a soft-reset is generated, die() is called by all cpus
364 and the system will boot into the dump-capture kernel.
366 For testing purposes, you can trigger a crash by using "ALT-SysRq-c",
367 "echo c > /proc/sysrq-trigger" or write a module to force the panic.
369 Write Out the Dump File
370 =======================
372 After the dump-capture kernel is booted, write out the dump file with
373 the following command:
375    cp /proc/vmcore <dump-file>
377 You can also access dumped memory as a /dev/oldmem device for a linear
378 and raw view. To create the device, use the following command:
380     mknod /dev/oldmem c 1 12
382 Use the dd command with suitable options for count, bs, and skip to
383 access specific portions of the dump.
385 To see the entire memory, use the following command:
387    dd if=/dev/oldmem of=oldmem.001
390 Analysis
391 ========
393 Before analyzing the dump image, you should reboot into a stable kernel.
395 You can do limited analysis using GDB on the dump file copied out of
396 /proc/vmcore. Use the debug vmlinux built with -g and run the following
397 command:
399    gdb vmlinux <dump-file>
401 Stack trace for the task on processor 0, register display, and memory
402 display work fine.
404 Note: GDB cannot analyze core files generated in ELF64 format for x86.
405 On systems with a maximum of 4GB of memory, you can generate
406 ELF32-format headers using the --elf32-core-headers kernel option on the
407 dump kernel.
409 You can also use the Crash utility to analyze dump files in Kdump
410 format. Crash is available on Dave Anderson's site at the following URL:
412    http://people.redhat.com/~anderson/
415 To Do
416 =====
418 1) Provide relocatable kernels for all architectures to help in maintaining
419    multiple kernels for crash_dump, and the same kernel as the system kernel
420    can be used to capture the dump.
423 Contact
424 =======
426 Vivek Goyal (vgoyal@in.ibm.com)
427 Maneesh Soni (maneesh@in.ibm.com)
430 Trademark
431 =========
433 Linux is a trademark of Linus Torvalds in the United States, other
434 countries, or both.