1 ============================================== 1 ================================================================
2 Documentation for Kdump - The kexec-based Cras 2 Documentation for Kdump - The kexec-based Crash Dumping Solution
3 ============================================== 3 ================================================================
4 4
5 This document includes overview, setup, instal 5 This document includes overview, setup, installation, and analysis
6 information. 6 information.
7 7
8 Overview 8 Overview
9 ======== 9 ========
10 10
11 Kdump uses kexec to quickly boot to a dump-cap 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 12 dump of the system kernel's memory needs to be taken (for example, when
13 the system panics). The system kernel's memory 13 the system panics). The system kernel's memory image is preserved across
14 the reboot and is accessible to the dump-captu 14 the reboot and is accessible to the dump-capture kernel.
15 15
16 You can use common commands, such as cp, scp o 16 You can use common commands, such as cp, scp or makedumpfile to copy
17 the memory image to a dump file on the local d 17 the memory image to a dump file on the local disk, or across the network
18 to a remote system. 18 to a remote system.
19 19
20 Kdump and kexec are currently supported on the 20 Kdump and kexec are currently supported on the x86, x86_64, ppc64,
21 s390x, arm and arm64 architectures. 21 s390x, arm and arm64 architectures.
22 22
23 When the system kernel boots, it reserves a sm 23 When the system kernel boots, it reserves a small section of memory for
24 the dump-capture kernel. This ensures that ong 24 the dump-capture kernel. This ensures that ongoing Direct Memory Access
25 (DMA) from the system kernel does not corrupt 25 (DMA) from the system kernel does not corrupt the dump-capture kernel.
26 The kexec -p command loads the dump-capture ke 26 The kexec -p command loads the dump-capture kernel into this reserved
27 memory. 27 memory.
28 28
29 On x86 machines, the first 640 KB of physical 29 On x86 machines, the first 640 KB of physical memory is needed for boot,
30 regardless of where the kernel loads. For simp 30 regardless of where the kernel loads. For simpler handling, the whole
31 low 1M is reserved to avoid any later kernel o 31 low 1M is reserved to avoid any later kernel or device driver writing
32 data into this area. Like this, the low 1M can 32 data into this area. Like this, the low 1M can be reused as system RAM
33 by kdump kernel without extra handling. 33 by kdump kernel without extra handling.
34 34
35 On PPC64 machines first 32KB of physical memor 35 On PPC64 machines first 32KB of physical memory is needed for booting
36 regardless of where the kernel is loaded and t 36 regardless of where the kernel is loaded and to support 64K page size
37 kexec backs up the first 64KB memory. 37 kexec backs up the first 64KB memory.
38 38
39 For s390x, when kdump is triggered, the crashk 39 For s390x, when kdump is triggered, the crashkernel region is exchanged
40 with the region [0, crashkernel region size] a 40 with the region [0, crashkernel region size] and then the kdump kernel
41 runs in [0, crashkernel region size]. Therefor 41 runs in [0, crashkernel region size]. Therefore no relocatable kernel is
42 needed for s390x. 42 needed for s390x.
43 43
44 All of the necessary information about the sys 44 All of the necessary information about the system kernel's core image is
45 encoded in the ELF format, and stored in a res 45 encoded in the ELF format, and stored in a reserved area of memory
46 before a crash. The physical address of the st 46 before a crash. The physical address of the start of the ELF header is
47 passed to the dump-capture kernel through the 47 passed to the dump-capture kernel through the elfcorehdr= boot
48 parameter. Optionally the size of the ELF head 48 parameter. Optionally the size of the ELF header can also be passed
49 when using the elfcorehdr=[size[KMG]@]offset[K 49 when using the elfcorehdr=[size[KMG]@]offset[KMG] syntax.
50 50
51 With the dump-capture kernel, you can access t 51 With the dump-capture kernel, you can access the memory image through
52 /proc/vmcore. This exports the dump as an ELF- 52 /proc/vmcore. This exports the dump as an ELF-format file that you can
53 write out using file copy commands such as cp 53 write out using file copy commands such as cp or scp. You can also use
54 makedumpfile utility to analyze and write out 54 makedumpfile utility to analyze and write out filtered contents with
55 options, e.g with '-d 31' it will only write o 55 options, e.g with '-d 31' it will only write out kernel data. Further,
56 you can use analysis tools such as the GNU Deb 56 you can use analysis tools such as the GNU Debugger (GDB) and the Crash
57 tool to debug the dump file. This method ensur 57 tool to debug the dump file. This method ensures that the dump pages are
58 correctly ordered. 58 correctly ordered.
59 59
60 Setup and Installation 60 Setup and Installation
61 ====================== 61 ======================
62 62
63 Install kexec-tools 63 Install kexec-tools
64 ------------------- 64 -------------------
65 65
66 1) Login as the root user. 66 1) Login as the root user.
67 67
68 2) Download the kexec-tools user-space package 68 2) Download the kexec-tools user-space package from the following URL:
69 69
70 http://kernel.org/pub/linux/utils/kernel/kexec 70 http://kernel.org/pub/linux/utils/kernel/kexec/kexec-tools.tar.gz
71 71
72 This is a symlink to the latest version. 72 This is a symlink to the latest version.
73 73
74 The latest kexec-tools git tree is available a 74 The latest kexec-tools git tree is available at:
75 75
76 - git://git.kernel.org/pub/scm/utils/kernel/ke 76 - git://git.kernel.org/pub/scm/utils/kernel/kexec/kexec-tools.git
77 - http://www.kernel.org/pub/scm/utils/kernel/k 77 - http://www.kernel.org/pub/scm/utils/kernel/kexec/kexec-tools.git
78 78
79 There is also a gitweb interface available at 79 There is also a gitweb interface available at
80 http://www.kernel.org/git/?p=utils/kernel/kexe 80 http://www.kernel.org/git/?p=utils/kernel/kexec/kexec-tools.git
81 81
82 More information about kexec-tools can be foun 82 More information about kexec-tools can be found at
83 http://horms.net/projects/kexec/ 83 http://horms.net/projects/kexec/
84 84
85 3) Unpack the tarball with the tar command, as 85 3) Unpack the tarball with the tar command, as follows::
86 86
87 tar xvpzf kexec-tools.tar.gz 87 tar xvpzf kexec-tools.tar.gz
88 88
89 4) Change to the kexec-tools directory, as fol 89 4) Change to the kexec-tools directory, as follows::
90 90
91 cd kexec-tools-VERSION 91 cd kexec-tools-VERSION
92 92
93 5) Configure the package, as follows:: 93 5) Configure the package, as follows::
94 94
95 ./configure 95 ./configure
96 96
97 6) Compile the package, as follows:: 97 6) Compile the package, as follows::
98 98
99 make 99 make
100 100
101 7) Install the package, as follows:: 101 7) Install the package, as follows::
102 102
103 make install 103 make install
104 104
105 105
106 Build the system and dump-capture kernels 106 Build the system and dump-capture kernels
107 ----------------------------------------- 107 -----------------------------------------
108 There are two possible methods of using Kdump. 108 There are two possible methods of using Kdump.
109 109
110 1) Build a separate custom dump-capture kernel 110 1) Build a separate custom dump-capture kernel for capturing the
111 kernel core dump. 111 kernel core dump.
112 112
113 2) Or use the system kernel binary itself as d 113 2) Or use the system kernel binary itself as dump-capture kernel and there is
114 no need to build a separate dump-capture ke 114 no need to build a separate dump-capture kernel. This is possible
115 only with the architectures which support a 115 only with the architectures which support a relocatable kernel. As
116 of today, i386, x86_64, ppc64, arm and arm6 116 of today, i386, x86_64, ppc64, arm and arm64 architectures support
117 relocatable kernel. 117 relocatable kernel.
118 118
119 Building a relocatable kernel is advantageous 119 Building a relocatable kernel is advantageous from the point of view that
120 one does not have to build a second kernel for 120 one does not have to build a second kernel for capturing the dump. But
121 at the same time one might want to build a cus 121 at the same time one might want to build a custom dump capture kernel
122 suitable to his needs. 122 suitable to his needs.
123 123
124 Following are the configuration setting requir 124 Following are the configuration setting required for system and
125 dump-capture kernels for enabling kdump suppor 125 dump-capture kernels for enabling kdump support.
126 126
127 System kernel config options 127 System kernel config options
128 ---------------------------- 128 ----------------------------
129 129
130 1) Enable "kexec system call" or "kexec file b 130 1) Enable "kexec system call" or "kexec file based system call" in
131 "Processor type and features.":: 131 "Processor type and features."::
132 132
133 CONFIG_KEXEC=y or CONFIG_KEXEC_FILE=y 133 CONFIG_KEXEC=y or CONFIG_KEXEC_FILE=y
134 134
135 And both of them will select KEXEC_CORE:: 135 And both of them will select KEXEC_CORE::
136 136
137 CONFIG_KEXEC_CORE=y 137 CONFIG_KEXEC_CORE=y
138 138
>> 139 Subsequently, CRASH_CORE is selected by KEXEC_CORE::
>> 140
>> 141 CONFIG_CRASH_CORE=y
>> 142
139 2) Enable "sysfs file system support" in "File 143 2) Enable "sysfs file system support" in "Filesystem" -> "Pseudo
140 filesystems." This is usually enabled by de 144 filesystems." This is usually enabled by default::
141 145
142 CONFIG_SYSFS=y 146 CONFIG_SYSFS=y
143 147
144 Note that "sysfs file system support" might 148 Note that "sysfs file system support" might not appear in the "Pseudo
145 filesystems" menu if "Configure standard ke 149 filesystems" menu if "Configure standard kernel features (expert users)"
146 is not enabled in "General Setup." In this 150 is not enabled in "General Setup." In this case, check the .config file
147 itself to ensure that sysfs is turned on, a 151 itself to ensure that sysfs is turned on, as follows::
148 152
149 grep 'CONFIG_SYSFS' .config 153 grep 'CONFIG_SYSFS' .config
150 154
151 3) Enable "Compile the kernel with debug info" 155 3) Enable "Compile the kernel with debug info" in "Kernel hacking."::
152 156
153 CONFIG_DEBUG_INFO=Y 157 CONFIG_DEBUG_INFO=Y
154 158
155 This causes the kernel to be built with deb 159 This causes the kernel to be built with debug symbols. The dump
156 analysis tools require a vmlinux with debug 160 analysis tools require a vmlinux with debug symbols in order to read
157 and analyze a dump file. 161 and analyze a dump file.
158 162
159 Dump-capture kernel config options (Arch Indep 163 Dump-capture kernel config options (Arch Independent)
160 ---------------------------------------------- 164 -----------------------------------------------------
161 165
162 1) Enable "kernel crash dumps" support under " 166 1) Enable "kernel crash dumps" support under "Processor type and
163 features":: 167 features"::
164 168
165 CONFIG_CRASH_DUMP=y 169 CONFIG_CRASH_DUMP=y
166 170
167 And this will select VMCORE_INFO and CRASH_ <<
168 CONFIG_VMCORE_INFO=y <<
169 CONFIG_CRASH_RESERVE=y <<
170 <<
171 2) Enable "/proc/vmcore support" under "Filesy 171 2) Enable "/proc/vmcore support" under "Filesystems" -> "Pseudo filesystems"::
172 172
173 CONFIG_PROC_VMCORE=y 173 CONFIG_PROC_VMCORE=y
174 174
175 (CONFIG_PROC_VMCORE is set by default when 175 (CONFIG_PROC_VMCORE is set by default when CONFIG_CRASH_DUMP is selected.)
176 176
177 Dump-capture kernel config options (Arch Depen 177 Dump-capture kernel config options (Arch Dependent, i386 and x86_64)
178 ---------------------------------------------- 178 --------------------------------------------------------------------
179 179
180 1) On i386, enable high memory support under " 180 1) On i386, enable high memory support under "Processor type and
181 features":: 181 features"::
182 182
183 CONFIG_HIGHMEM64G=y 183 CONFIG_HIGHMEM64G=y
184 184
185 or:: 185 or::
186 186
187 CONFIG_HIGHMEM4G 187 CONFIG_HIGHMEM4G
188 188
189 2) With CONFIG_SMP=y, usually nr_cpus=1 need s 189 2) With CONFIG_SMP=y, usually nr_cpus=1 need specified on the kernel
190 command line when loading the dump-capture 190 command line when loading the dump-capture kernel because one
191 CPU is enough for kdump kernel to dump vmco 191 CPU is enough for kdump kernel to dump vmcore on most of systems.
192 192
193 However, you can also specify nr_cpus=X to 193 However, you can also specify nr_cpus=X to enable multiple processors
194 in kdump kernel. !! 194 in kdump kernel. In this case, "disable_cpu_apicid=" is needed to
>> 195 tell kdump kernel which cpu is 1st kernel's BSP. Please refer to
>> 196 admin-guide/kernel-parameters.txt for more details.
195 197
196 With CONFIG_SMP=n, the above things are not 198 With CONFIG_SMP=n, the above things are not related.
197 199
198 3) A relocatable kernel is suggested to be bui 200 3) A relocatable kernel is suggested to be built by default. If not yet,
199 enable "Build a relocatable kernel" support 201 enable "Build a relocatable kernel" support under "Processor type and
200 features":: 202 features"::
201 203
202 CONFIG_RELOCATABLE=y 204 CONFIG_RELOCATABLE=y
203 205
204 4) Use a suitable value for "Physical address 206 4) Use a suitable value for "Physical address where the kernel is
205 loaded" (under "Processor type and features 207 loaded" (under "Processor type and features"). This only appears when
206 "kernel crash dumps" is enabled. A suitable 208 "kernel crash dumps" is enabled. A suitable value depends upon
207 whether kernel is relocatable or not. 209 whether kernel is relocatable or not.
208 210
209 If you are using a relocatable kernel use C 211 If you are using a relocatable kernel use CONFIG_PHYSICAL_START=0x100000
210 This will compile the kernel for physical a 212 This will compile the kernel for physical address 1MB, but given the fact
211 kernel is relocatable, it can be run from a 213 kernel is relocatable, it can be run from any physical address hence
212 kexec boot loader will load it in memory re 214 kexec boot loader will load it in memory region reserved for dump-capture
213 kernel. 215 kernel.
214 216
215 Otherwise it should be the start of memory 217 Otherwise it should be the start of memory region reserved for
216 second kernel using boot parameter "crashke 218 second kernel using boot parameter "crashkernel=Y@X". Here X is
217 start of memory region reserved for dump-ca 219 start of memory region reserved for dump-capture kernel.
218 Generally X is 16MB (0x1000000). So you can 220 Generally X is 16MB (0x1000000). So you can set
219 CONFIG_PHYSICAL_START=0x1000000 221 CONFIG_PHYSICAL_START=0x1000000
220 222
221 5) Make and install the kernel and its modules 223 5) Make and install the kernel and its modules. DO NOT add this kernel
222 to the boot loader configuration files. 224 to the boot loader configuration files.
223 225
224 Dump-capture kernel config options (Arch Depen 226 Dump-capture kernel config options (Arch Dependent, ppc64)
225 ---------------------------------------------- 227 ----------------------------------------------------------
226 228
227 1) Enable "Build a kdump crash kernel" support 229 1) Enable "Build a kdump crash kernel" support under "Kernel" options::
228 230
229 CONFIG_CRASH_DUMP=y 231 CONFIG_CRASH_DUMP=y
230 232
231 2) Enable "Build a relocatable kernel" suppo 233 2) Enable "Build a relocatable kernel" support::
232 234
233 CONFIG_RELOCATABLE=y 235 CONFIG_RELOCATABLE=y
234 236
235 Make and install the kernel and its modules 237 Make and install the kernel and its modules.
236 238
237 Dump-capture kernel config options (Arch Depen 239 Dump-capture kernel config options (Arch Dependent, arm)
238 ---------------------------------------------- 240 ----------------------------------------------------------
239 241
240 - To use a relocatable kernel, 242 - To use a relocatable kernel,
241 Enable "AUTO_ZRELADDR" support under "Boot 243 Enable "AUTO_ZRELADDR" support under "Boot" options::
242 244
243 AUTO_ZRELADDR=y 245 AUTO_ZRELADDR=y
244 246
245 Dump-capture kernel config options (Arch Depen 247 Dump-capture kernel config options (Arch Dependent, arm64)
246 ---------------------------------------------- 248 ----------------------------------------------------------
247 249
248 - Please note that kvm of the dump-capture ker 250 - Please note that kvm of the dump-capture kernel will not be enabled
249 on non-VHE systems even if it is configured. 251 on non-VHE systems even if it is configured. This is because the CPU
250 will not be reset to EL2 on panic. 252 will not be reset to EL2 on panic.
251 253
252 crashkernel syntax 254 crashkernel syntax
253 =========================== 255 ===========================
254 1) crashkernel=size@offset 256 1) crashkernel=size@offset
255 257
256 Here 'size' specifies how much memory to re 258 Here 'size' specifies how much memory to reserve for the dump-capture kernel
257 and 'offset' specifies the beginning of thi 259 and 'offset' specifies the beginning of this reserved memory. For example,
258 "crashkernel=64M@16M" tells the system kern 260 "crashkernel=64M@16M" tells the system kernel to reserve 64 MB of memory
259 starting at physical address 0x01000000 (16 261 starting at physical address 0x01000000 (16MB) for the dump-capture kernel.
260 262
261 The crashkernel region can be automatically 263 The crashkernel region can be automatically placed by the system
262 kernel at run time. This is done by specify 264 kernel at run time. This is done by specifying the base address as 0,
263 or omitting it all together:: 265 or omitting it all together::
264 266
265 crashkernel=256M@0 267 crashkernel=256M@0
266 268
267 or:: 269 or::
268 270
269 crashkernel=256M 271 crashkernel=256M
270 272
271 If the start address is specified, note tha 273 If the start address is specified, note that the start address of the
272 kernel will be aligned to a value (which is 274 kernel will be aligned to a value (which is Arch dependent), so if the
273 start address is not then any space below t 275 start address is not then any space below the alignment point will be
274 wasted. 276 wasted.
275 277
276 2) range1:size1[,range2:size2,...][@offset] 278 2) range1:size1[,range2:size2,...][@offset]
277 279
278 While the "crashkernel=size[@offset]" synta 280 While the "crashkernel=size[@offset]" syntax is sufficient for most
279 configurations, sometimes it's handy to hav 281 configurations, sometimes it's handy to have the reserved memory dependent
280 on the value of System RAM -- that's mostly 282 on the value of System RAM -- that's mostly for distributors that pre-setup
281 the kernel command line to avoid a unbootab 283 the kernel command line to avoid a unbootable system after some memory has
282 been removed from the machine. 284 been removed from the machine.
283 285
284 The syntax is:: 286 The syntax is::
285 287
286 crashkernel=<range1>:<size1>[,<range2>: 288 crashkernel=<range1>:<size1>[,<range2>:<size2>,...][@offset]
287 range=start-[end] 289 range=start-[end]
288 290
289 For example:: 291 For example::
290 292
291 crashkernel=512M-2G:64M,2G-:128M 293 crashkernel=512M-2G:64M,2G-:128M
292 294
293 This would mean: 295 This would mean:
294 296
295 1) if the RAM is smaller than 512M, the 297 1) if the RAM is smaller than 512M, then don't reserve anything
296 (this is the "rescue" case) 298 (this is the "rescue" case)
297 2) if the RAM size is between 512M and 299 2) if the RAM size is between 512M and 2G (exclusive), then reserve 64M
298 3) if the RAM size is larger than 2G, t 300 3) if the RAM size is larger than 2G, then reserve 128M
299 301
300 3) crashkernel=size,high and crashkernel=size, 302 3) crashkernel=size,high and crashkernel=size,low
301 303
302 If memory above 4G is preferred, crashkerne 304 If memory above 4G is preferred, crashkernel=size,high can be used to
303 fulfill that. With it, physical memory is a 305 fulfill that. With it, physical memory is allowed to be allocated from top,
304 so could be above 4G if system has more tha 306 so could be above 4G if system has more than 4G RAM installed. Otherwise,
305 memory region will be allocated below 4G if 307 memory region will be allocated below 4G if available.
306 308
307 When crashkernel=X,high is passed, kernel c 309 When crashkernel=X,high is passed, kernel could allocate physical memory
308 region above 4G, low memory under 4G is nee 310 region above 4G, low memory under 4G is needed in this case. There are
309 three ways to get low memory: 311 three ways to get low memory:
310 312
311 1) Kernel will allocate at least 256M me 313 1) Kernel will allocate at least 256M memory below 4G automatically
312 if crashkernel=Y,low is not specified 314 if crashkernel=Y,low is not specified.
313 2) Let user specify low memory size inst 315 2) Let user specify low memory size instead.
314 3) Specified value 0 will disable low me 316 3) Specified value 0 will disable low memory allocation::
315 317
316 crashkernel=0,low 318 crashkernel=0,low
317 319
318 Boot into System Kernel 320 Boot into System Kernel
319 ----------------------- 321 -----------------------
320 1) Update the boot loader (such as grub, yaboo 322 1) Update the boot loader (such as grub, yaboot, or lilo) configuration
321 files as necessary. 323 files as necessary.
322 324
323 2) Boot the system kernel with the boot parame 325 2) Boot the system kernel with the boot parameter "crashkernel=Y@X".
324 326
325 On x86 and x86_64, use "crashkernel=Y[@X]". 327 On x86 and x86_64, use "crashkernel=Y[@X]". Most of the time, the
326 start address 'X' is not necessary, kernel 328 start address 'X' is not necessary, kernel will search a suitable
327 area. Unless an explicit start address is e 329 area. Unless an explicit start address is expected.
328 330
329 On ppc64, use "crashkernel=128M@32M". 331 On ppc64, use "crashkernel=128M@32M".
330 332
331 On s390x, typically use "crashkernel=xxM". 333 On s390x, typically use "crashkernel=xxM". The value of xx is dependent
332 on the memory consumption of the kdump syst 334 on the memory consumption of the kdump system. In general this is not
333 dependent on the memory size of the product 335 dependent on the memory size of the production system.
334 336
335 On arm, the use of "crashkernel=Y@X" is no 337 On arm, the use of "crashkernel=Y@X" is no longer necessary; the
336 kernel will automatically locate the crash 338 kernel will automatically locate the crash kernel image within the
337 first 512MB of RAM if X is not given. 339 first 512MB of RAM if X is not given.
338 340
339 On arm64, use "crashkernel=Y[@X]". Note th 341 On arm64, use "crashkernel=Y[@X]". Note that the start address of
340 the kernel, X if explicitly specified, must 342 the kernel, X if explicitly specified, must be aligned to 2MiB (0x200000).
341 343
342 Load the Dump-capture Kernel 344 Load the Dump-capture Kernel
343 ============================ 345 ============================
344 346
345 After booting to the system kernel, dump-captu 347 After booting to the system kernel, dump-capture kernel needs to be
346 loaded. 348 loaded.
347 349
348 Based on the architecture and type of image (r 350 Based on the architecture and type of image (relocatable or not), one
349 can choose to load the uncompressed vmlinux or 351 can choose to load the uncompressed vmlinux or compressed bzImage/vmlinuz
350 of dump-capture kernel. Following is the summa 352 of dump-capture kernel. Following is the summary.
351 353
352 For i386 and x86_64: 354 For i386 and x86_64:
353 355
354 - Use bzImage/vmlinuz if kernel is rel 356 - Use bzImage/vmlinuz if kernel is relocatable.
355 - Use vmlinux if kernel is not relocat 357 - Use vmlinux if kernel is not relocatable.
356 358
357 For ppc64: 359 For ppc64:
358 360
359 - Use vmlinux 361 - Use vmlinux
360 362
361 For s390x: 363 For s390x:
362 364
363 - Use image or bzImage 365 - Use image or bzImage
364 366
365 For arm: 367 For arm:
366 368
367 - Use zImage 369 - Use zImage
368 370
369 For arm64: 371 For arm64:
370 372
371 - Use vmlinux or Image 373 - Use vmlinux or Image
372 374
373 If you are using an uncompressed vmlinux image 375 If you are using an uncompressed vmlinux image then use following command
374 to load dump-capture kernel:: 376 to load dump-capture kernel::
375 377
376 kexec -p <dump-capture-kernel-vmlinux-image 378 kexec -p <dump-capture-kernel-vmlinux-image> \
377 --initrd=<initrd-for-dump-capture-kernel> - 379 --initrd=<initrd-for-dump-capture-kernel> --args-linux \
378 --append="root=<root-dev> <arch-specific-op 380 --append="root=<root-dev> <arch-specific-options>"
379 381
380 If you are using a compressed bzImage/vmlinuz, 382 If you are using a compressed bzImage/vmlinuz, then use following command
381 to load dump-capture kernel:: 383 to load dump-capture kernel::
382 384
383 kexec -p <dump-capture-kernel-bzImage> \ 385 kexec -p <dump-capture-kernel-bzImage> \
384 --initrd=<initrd-for-dump-capture-kernel> \ 386 --initrd=<initrd-for-dump-capture-kernel> \
385 --append="root=<root-dev> <arch-specific-op 387 --append="root=<root-dev> <arch-specific-options>"
386 388
387 If you are using a compressed zImage, then use 389 If you are using a compressed zImage, then use following command
388 to load dump-capture kernel:: 390 to load dump-capture kernel::
389 391
390 kexec --type zImage -p <dump-capture-kernel 392 kexec --type zImage -p <dump-capture-kernel-bzImage> \
391 --initrd=<initrd-for-dump-capture-kernel> \ 393 --initrd=<initrd-for-dump-capture-kernel> \
392 --dtb=<dtb-for-dump-capture-kernel> \ 394 --dtb=<dtb-for-dump-capture-kernel> \
393 --append="root=<root-dev> <arch-specific-op 395 --append="root=<root-dev> <arch-specific-options>"
394 396
395 If you are using an uncompressed Image, then u 397 If you are using an uncompressed Image, then use following command
396 to load dump-capture kernel:: 398 to load dump-capture kernel::
397 399
398 kexec -p <dump-capture-kernel-Image> \ 400 kexec -p <dump-capture-kernel-Image> \
399 --initrd=<initrd-for-dump-capture-kernel> \ 401 --initrd=<initrd-for-dump-capture-kernel> \
400 --append="root=<root-dev> <arch-specific-op 402 --append="root=<root-dev> <arch-specific-options>"
401 403
402 Following are the arch specific command line o 404 Following are the arch specific command line options to be used while
403 loading dump-capture kernel. 405 loading dump-capture kernel.
404 406
405 For i386 and x86_64: 407 For i386 and x86_64:
406 408
407 "1 irqpoll nr_cpus=1 reset_devices" 409 "1 irqpoll nr_cpus=1 reset_devices"
408 410
409 For ppc64: 411 For ppc64:
410 412
411 "1 maxcpus=1 noirqdistrib reset_device 413 "1 maxcpus=1 noirqdistrib reset_devices"
412 414
413 For s390x: 415 For s390x:
414 416
415 "1 nr_cpus=1 cgroup_disable=memory" 417 "1 nr_cpus=1 cgroup_disable=memory"
416 418
417 For arm: 419 For arm:
418 420
419 "1 maxcpus=1 reset_devices" 421 "1 maxcpus=1 reset_devices"
420 422
421 For arm64: 423 For arm64:
422 424
423 "1 nr_cpus=1 reset_devices" 425 "1 nr_cpus=1 reset_devices"
424 426
425 Notes on loading the dump-capture kernel: 427 Notes on loading the dump-capture kernel:
426 428
427 * By default, the ELF headers are stored in EL 429 * By default, the ELF headers are stored in ELF64 format to support
428 systems with more than 4GB memory. On i386, 430 systems with more than 4GB memory. On i386, kexec automatically checks if
429 the physical RAM size exceeds the 4 GB limit 431 the physical RAM size exceeds the 4 GB limit and if not, uses ELF32.
430 So, on non-PAE systems, ELF32 is always used 432 So, on non-PAE systems, ELF32 is always used.
431 433
432 The --elf32-core-headers option can be used 434 The --elf32-core-headers option can be used to force the generation of ELF32
433 headers. This is necessary because GDB curre 435 headers. This is necessary because GDB currently cannot open vmcore files
434 with ELF64 headers on 32-bit systems. 436 with ELF64 headers on 32-bit systems.
435 437
436 * The "irqpoll" boot parameter reduces driver 438 * The "irqpoll" boot parameter reduces driver initialization failures
437 due to shared interrupts in the dump-capture 439 due to shared interrupts in the dump-capture kernel.
438 440
439 * You must specify <root-dev> in the format co 441 * You must specify <root-dev> in the format corresponding to the root
440 device name in the output of mount command. 442 device name in the output of mount command.
441 443
442 * Boot parameter "1" boots the dump-capture ke 444 * Boot parameter "1" boots the dump-capture kernel into single-user
443 mode without networking. If you want network 445 mode without networking. If you want networking, use "3".
444 446
445 * We generally don't have to bring up a SMP ke 447 * We generally don't have to bring up a SMP kernel just to capture the
446 dump. Hence generally it is useful either to 448 dump. Hence generally it is useful either to build a UP dump-capture
447 kernel or specify maxcpus=1 option while loa 449 kernel or specify maxcpus=1 option while loading dump-capture kernel.
448 Note, though maxcpus always works, you had b 450 Note, though maxcpus always works, you had better replace it with
449 nr_cpus to save memory if supported by the c 451 nr_cpus to save memory if supported by the current ARCH, such as x86.
450 452
451 * You should enable multi-cpu support in dump- 453 * You should enable multi-cpu support in dump-capture kernel if you intend
452 to use multi-thread programs with it, such a 454 to use multi-thread programs with it, such as parallel dump feature of
453 makedumpfile. Otherwise, the multi-thread pr 455 makedumpfile. Otherwise, the multi-thread program may have a great
454 performance degradation. To enable multi-cpu 456 performance degradation. To enable multi-cpu support, you should bring up an
455 SMP dump-capture kernel and specify maxcpus/ !! 457 SMP dump-capture kernel and specify maxcpus/nr_cpus, disable_cpu_apicid=[X]
>> 458 options while loading it.
456 459
457 * For s390x there are two kdump modes: If a EL 460 * For s390x there are two kdump modes: If a ELF header is specified with
458 the elfcorehdr= kernel parameter, it is used 461 the elfcorehdr= kernel parameter, it is used by the kdump kernel as it
459 is done on all other architectures. If no el 462 is done on all other architectures. If no elfcorehdr= kernel parameter is
460 specified, the s390x kdump kernel dynamicall 463 specified, the s390x kdump kernel dynamically creates the header. The
461 second mode has the advantage that for CPU a 464 second mode has the advantage that for CPU and memory hotplug, kdump has
462 not to be reloaded with kexec_load(). 465 not to be reloaded with kexec_load().
463 466
464 * For s390x systems with many attached devices 467 * For s390x systems with many attached devices the "cio_ignore" kernel
465 parameter should be used for the kdump kerne 468 parameter should be used for the kdump kernel in order to prevent allocation
466 of kernel memory for devices that are not re 469 of kernel memory for devices that are not relevant for kdump. The same
467 applies to systems that use SCSI/FCP devices 470 applies to systems that use SCSI/FCP devices. In that case the
468 "allow_lun_scan" zfcp module parameter shoul 471 "allow_lun_scan" zfcp module parameter should be set to zero before
469 setting FCP devices online. 472 setting FCP devices online.
470 473
471 Kernel Panic 474 Kernel Panic
472 ============ 475 ============
473 476
474 After successfully loading the dump-capture ke 477 After successfully loading the dump-capture kernel as previously
475 described, the system will reboot into the dum 478 described, the system will reboot into the dump-capture kernel if a
476 system crash is triggered. Trigger points are 479 system crash is triggered. Trigger points are located in panic(),
477 die(), die_nmi() and in the sysrq handler (ALT 480 die(), die_nmi() and in the sysrq handler (ALT-SysRq-c).
478 481
479 The following conditions will execute a crash 482 The following conditions will execute a crash trigger point:
480 483
481 If a hard lockup is detected and "NMI watchdog 484 If a hard lockup is detected and "NMI watchdog" is configured, the system
482 will boot into the dump-capture kernel ( die_n 485 will boot into the dump-capture kernel ( die_nmi() ).
483 486
484 If die() is called, and it happens to be a thr 487 If die() is called, and it happens to be a thread with pid 0 or 1, or die()
485 is called inside interrupt context or die() is 488 is called inside interrupt context or die() is called and panic_on_oops is set,
486 the system will boot into the dump-capture ker 489 the system will boot into the dump-capture kernel.
487 490
488 On powerpc systems when a soft-reset is genera 491 On powerpc systems when a soft-reset is generated, die() is called by all cpus
489 and the system will boot into the dump-capture 492 and the system will boot into the dump-capture kernel.
490 493
491 For testing purposes, you can trigger a crash 494 For testing purposes, you can trigger a crash by using "ALT-SysRq-c",
492 "echo c > /proc/sysrq-trigger" or write a modu 495 "echo c > /proc/sysrq-trigger" or write a module to force the panic.
493 496
494 Write Out the Dump File 497 Write Out the Dump File
495 ======================= 498 =======================
496 499
497 After the dump-capture kernel is booted, write 500 After the dump-capture kernel is booted, write out the dump file with
498 the following command:: 501 the following command::
499 502
500 cp /proc/vmcore <dump-file> 503 cp /proc/vmcore <dump-file>
501 504
502 or use scp to write out the dump file between 505 or use scp to write out the dump file between hosts on a network, e.g::
503 506
504 scp /proc/vmcore remote_username@remote_ip: 507 scp /proc/vmcore remote_username@remote_ip:<dump-file>
505 508
506 You can also use makedumpfile utility to write 509 You can also use makedumpfile utility to write out the dump file
507 with specified options to filter out unwanted 510 with specified options to filter out unwanted contents, e.g::
508 511
509 makedumpfile -l --message-level 1 -d 31 /pr 512 makedumpfile -l --message-level 1 -d 31 /proc/vmcore <dump-file>
510 513
511 Analysis 514 Analysis
512 ======== 515 ========
513 516
514 Before analyzing the dump image, you should re 517 Before analyzing the dump image, you should reboot into a stable kernel.
515 518
516 You can do limited analysis using GDB on the d 519 You can do limited analysis using GDB on the dump file copied out of
517 /proc/vmcore. Use the debug vmlinux built with 520 /proc/vmcore. Use the debug vmlinux built with -g and run the following
518 command:: 521 command::
519 522
520 gdb vmlinux <dump-file> 523 gdb vmlinux <dump-file>
521 524
522 Stack trace for the task on processor 0, regis 525 Stack trace for the task on processor 0, register display, and memory
523 display work fine. 526 display work fine.
524 527
525 Note: GDB cannot analyze core files generated 528 Note: GDB cannot analyze core files generated in ELF64 format for x86.
526 On systems with a maximum of 4GB of memory, yo 529 On systems with a maximum of 4GB of memory, you can generate
527 ELF32-format headers using the --elf32-core-he 530 ELF32-format headers using the --elf32-core-headers kernel option on the
528 dump kernel. 531 dump kernel.
529 532
530 You can also use the Crash utility to analyze 533 You can also use the Crash utility to analyze dump files in Kdump
531 format. Crash is available at the following UR 534 format. Crash is available at the following URL:
532 535
533 https://github.com/crash-utility/crash 536 https://github.com/crash-utility/crash
534 537
535 Crash document can be found at: 538 Crash document can be found at:
536 https://crash-utility.github.io/ 539 https://crash-utility.github.io/
537 540
538 Trigger Kdump on WARN() 541 Trigger Kdump on WARN()
539 ======================= 542 =======================
540 543
541 The kernel parameter, panic_on_warn, calls pan 544 The kernel parameter, panic_on_warn, calls panic() in all WARN() paths. This
542 will cause a kdump to occur at the panic() cal 545 will cause a kdump to occur at the panic() call. In cases where a user wants
543 to specify this during runtime, /proc/sys/kern 546 to specify this during runtime, /proc/sys/kernel/panic_on_warn can be set to 1
544 to achieve the same behaviour. 547 to achieve the same behaviour.
545 548
546 Trigger Kdump on add_taint() 549 Trigger Kdump on add_taint()
547 ============================ 550 ============================
548 551
549 The kernel parameter panic_on_taint facilitate 552 The kernel parameter panic_on_taint facilitates a conditional call to panic()
550 from within add_taint() whenever the value set 553 from within add_taint() whenever the value set in this bitmask matches with the
551 bit flag being set by add_taint(). 554 bit flag being set by add_taint().
552 This will cause a kdump to occur at the add_ta 555 This will cause a kdump to occur at the add_taint()->panic() call.
553 556
554 Contact 557 Contact
555 ======= 558 =======
556 559
557 - kexec@lists.infradead.org 560 - kexec@lists.infradead.org
558 561
559 GDB macros 562 GDB macros
560 ========== 563 ==========
561 564
562 .. include:: gdbmacros.txt 565 .. include:: gdbmacros.txt
563 :literal: 566 :literal:
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.