usr/src/man/man9e/dump.9e

   1 '\" te
   2 .\" Copyright (c) 1992, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DUMP 9E "Oct 9, 2001"
   7 .SH NAME
   8 dump \- dump memory to device during system failure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBint\fR \fBdump\fR(\fBdev_t\fR \fIdev\fR, \fBcaddr_t\fR \fIaddr\fR, \fBdaddr_t\fR \fIblkno\fR, \fBint\fR \fInblk\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Solaris specific (Solaris DDI). This entry point is \fBrequired\fR. For drivers
  25 that do not implement \fBdump()\fR routines, \fBnodev\fR(9F) should be used.
  26 .SH ARGUMENTS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIdev\fR \fR
  31 .ad
  32 .RS 10n
  33 Device number.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIaddr\fR \fR
  40 .ad
  41 .RS 10n
  42 Address for the beginning of the area to be dumped.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIblkno\fR \fR
  49 .ad
  50 .RS 10n
  51 Block offset to dump memory.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fInblk\fR \fR
  58 .ad
  59 .RS 10n
  60 Number of blocks to dump.
  61 .RE
  62
  63 .SH DESCRIPTION
  64 .sp
  65 .LP
  66 \fBdump()\fR is used to dump a portion of virtual address space directly to a
  67 device in the case of system failure. It can also be used for checking the
  68 state of the kernel during a checkpoint operation. The memory area to be dumped
  69 is specified by \fIaddr\fR (base address) and \fInblk\fR (length). It is dumped
  70 to the device specified by \fIdev\fR starting at offset \fIblkno\fR. Upon
  71 completion \fBdump()\fR returns the status of the transfer.
  72 .sp
  73 .LP
  74 When the system is panicking, the calls of functions scheduled by
  75 \fBtimeout\fR(9F) and \fBddi_trigger_softintr\fR(9F) will never occur. Neither
  76 can delay(9F) be relied upon, since it is implemented via \fBtimeout()\fR. See
  77 \fBddi_in_panic\fR(9F).
  78 .sp
  79 .LP
  80 \fBdump()\fR is called at interrupt priority.
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 \fBdump()\fR returns \fB0\fR on success, or the appropriate error number.
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBcpr\fR(7), \fBnodev\fR(9F)
  89 .sp
  90 .LP
  91 \fIWriting Device Drivers\fR