1dump(9E)                      Driver Entry Points                     dump(9E)
2
3
4

NAME

6       dump - dump memory to device during system failure
7

SYNOPSIS

9       #include <sys/types.h>
10       #include <sys/ddi.h>
11       #include <sys/sunddi.h>
12
13
14
15       int dump(dev_t dev, caddr_t addr, daddr_t blkno, int nblk);
16
17

INTERFACE LEVEL

19       Solaris specific (Solaris DDI). This entry point is required. For driv‐
20       ers that do not implement dump() routines, nodev(9F) should be used.
21

ARGUMENTS

23       dev       Device number.
24
25
26       addr      Address for the beginning of the area to be dumped.
27
28
29       blkno     Block offset to dump memory.
30
31
32       nblk      Number of blocks to dump.
33
34

DESCRIPTION

36       dump() is used to dump a portion of virtual address space directly to a
37       device  in the case of system failure. It can also be used for checking
38       the state of the kernel during a checkpoint operation. The memory  area
39       to  be dumped is specified by addr (base address) and nblk (length). It
40       is dumped to the device specified by dev starting at offset blkno. Upon
41       completion dump() returns the status of the transfer.
42
43
44       When the system is panicking, the calls of functions scheduled by time‐
45       out(9F) and ddi_trigger_softintr(9F)  will  never  occur.  Neither  can
46       delay(9F)  be  relied  upon, since it is implemented via timeout(). See
47       ddi_in_panic(9F).
48
49
50       dump() is called at interrupt priority.
51

RETURN VALUES

53       dump() returns 0 on success, or the appropriate error number.
54

SEE ALSO

56       cpr(7), nodev(9F)
57
58
59       Writing Device Drivers
60
61
62
63SunOS 5.11                        9 Oct 2001                          dump(9E)