Skip to content

Commit 7d4c738

Browse files
Michael HolzheuMartin Schwidefsky
Michael Holzheu
authored and
Martin Schwidefsky
committedMay 20, 2014
s390/zfcpdump: Update documentation in zfcpdump.txt
Do the following changes: - Document new /proc/vmcore interface - Document partition dump external initramfs with s390-tools-1.24.0 - Remove initramfs config file because initramfs is now built automatically in s390-tools - Replace description of kernel config options with "make zfcpdump_defconfig" - Some editorial changes Signed-off-by: Michael Holzheu <holzheu@linux.vnet.ibm.com> Signed-off-by: Martin Schwidefsky <schwidefsky@de.ibm.com>
1 parent bf28a59 commit 7d4c738

File tree

1 file changed

+18
-53
lines changed

1 file changed

+18
-53
lines changed
 

‎Documentation/s390/zfcpdump.txt

+18-53
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
s390 SCSI dump tool (zfcpdump)
1+
The s390 SCSI dump tool (zfcpdump)
22

33
System z machines (z900 or higher) provide hardware support for creating system
44
dumps on SCSI disks. The dump process is initiated by booting a dump tool, which
55
has to create a dump of the current (probably crashed) Linux image. In order to
66
not overwrite memory of the crashed Linux with data of the dump tool, the
7-
hardware saves some memory plus the register sets of the boot cpu before the
7+
hardware saves some memory plus the register sets of the boot CPU before the
88
dump tool is loaded. There exists an SCLP hardware interface to obtain the saved
99
memory afterwards. Currently 32 MB are saved.
1010

1111
This zfcpdump implementation consists of a Linux dump kernel together with
12-
a userspace dump tool, which are loaded together into the saved memory region
12+
a user space dump tool, which are loaded together into the saved memory region
1313
below 32 MB. zfcpdump is installed on a SCSI disk using zipl (as contained in
1414
the s390-tools package) to make the device bootable. The operator of a Linux
1515
system can then trigger a SCSI dump by booting the SCSI disk, where zfcpdump
@@ -19,68 +19,33 @@ The kernel part of zfcpdump is implemented as a debugfs file under "zcore/mem",
1919
which exports memory and registers of the crashed Linux in an s390
2020
standalone dump format. It can be used in the same way as e.g. /dev/mem. The
2121
dump format defines a 4K header followed by plain uncompressed memory. The
22-
register sets are stored in the prefix pages of the respective cpus. To build a
22+
register sets are stored in the prefix pages of the respective CPUs. To build a
2323
dump enabled kernel with the zcore driver, the kernel config option
2424
CONFIG_CRASH_DUMP has to be set. When reading from "zcore/mem", the part of
2525
memory, which has been saved by hardware is read by the driver via the SCLP
2626
hardware interface. The second part is just copied from the non overwritten real
2727
memory.
2828

29-
The userspace application of zfcpdump can reside e.g. in an intitramfs or an
30-
initrd. It reads from zcore/mem and writes the system dump to a file on a
31-
SCSI disk.
29+
Since kernel version 3.12 also the /proc/vmcore file can also be used to access
30+
the dump.
3231

33-
To build a zfcpdump kernel use the following settings in your kernel
34-
configuration:
35-
* CONFIG_CRASH_DUMP=y
36-
* Enable ZFCP driver
37-
* Enable SCSI driver
38-
* Enable ext2 and ext3 filesystems
39-
* Disable as many features as possible to keep the kernel small.
40-
E.g. network support is not needed at all.
32+
To get a valid zfcpdump kernel configuration use "make zfcpdump_defconfig".
4133

42-
To use the zfcpdump userspace application in an initramfs you have to do the
43-
following:
34+
The s390 zipl tool looks for the zfcpdump kernel and optional initrd/initramfs
35+
under the following locations:
4436

45-
* Copy the zfcpdump executable somewhere into your Linux tree.
46-
E.g. to "arch/s390/boot/zfcpdump. If you do not want to include
47-
shared libraries, compile the tool with the "-static" gcc option.
48-
* If you want to include e2fsck, add it to your source tree, too. The zfcpdump
49-
application attempts to start /sbin/e2fsck from the ramdisk.
50-
* Use an initramfs config file like the following:
37+
* kernel: <zfcpdump directory>/zfcpdump.image
38+
* ramdisk: <zfcpdump directory>/zfcpdump.rd
5139

52-
dir /dev 755 0 0
53-
nod /dev/console 644 0 0 c 5 1
54-
nod /dev/null 644 0 0 c 1 3
55-
nod /dev/sda1 644 0 0 b 8 1
56-
nod /dev/sda2 644 0 0 b 8 2
57-
nod /dev/sda3 644 0 0 b 8 3
58-
nod /dev/sda4 644 0 0 b 8 4
59-
nod /dev/sda5 644 0 0 b 8 5
60-
nod /dev/sda6 644 0 0 b 8 6
61-
nod /dev/sda7 644 0 0 b 8 7
62-
nod /dev/sda8 644 0 0 b 8 8
63-
nod /dev/sda9 644 0 0 b 8 9
64-
nod /dev/sda10 644 0 0 b 8 10
65-
nod /dev/sda11 644 0 0 b 8 11
66-
nod /dev/sda12 644 0 0 b 8 12
67-
nod /dev/sda13 644 0 0 b 8 13
68-
nod /dev/sda14 644 0 0 b 8 14
69-
nod /dev/sda15 644 0 0 b 8 15
70-
file /init arch/s390/boot/zfcpdump 755 0 0
71-
file /sbin/e2fsck arch/s390/boot/e2fsck 755 0 0
72-
dir /proc 755 0 0
73-
dir /sys 755 0 0
74-
dir /mnt 755 0 0
75-
dir /sbin 755 0 0
40+
The zfcpdump directory is defined in the s390-tools package.
7641

77-
* Issue "make image" to build the zfcpdump image with initramfs.
42+
The user space application of zfcpdump can reside in an intitramfs or an
43+
initrd. It can also be included in a built-in kernel initramfs. The application
44+
reads from /proc/vmcore or zcore/mem and writes the system dump to a SCSI disk.
7845

79-
In a Linux distribution the zfcpdump enabled kernel image must be copied to
80-
/usr/share/zfcpdump/zfcpdump.image, where the s390 zipl tool is looking for the
81-
dump kernel when preparing a SCSI dump disk.
82-
83-
If you use a ramdisk copy it to "/usr/share/zfcpdump/zfcpdump.rd".
46+
The s390-tools package version 1.24.0 and above builds an external zfcpdump
47+
initramfs with a user space application that writes the dump to a SCSI
48+
partition.
8449

8550
For more information on how to use zfcpdump refer to the s390 'Using the Dump
8651
Tools book', which is available from

0 commit comments

Comments
 (0)
Please sign in to comment.