share/man/man9f/ddi_in_panic.9f

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc.
   3 .\" All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DDI_IN_PANIC 9F "Jun 23, 1997"
   8 .SH NAME
   9 ddi_in_panic \- determine if system is in panic state
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBint\fR \fBddi_in_panic\fR(\fBvoid\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Solaris DDI specific (Solaris DDI).
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 Drivers controlling devices on which the system may write a kernel crash dump
  29 in the event of a panic can call \fBddi_in_panic()\fR to determine if the
  30 system is panicking.
  31 .sp
  32 .LP
  33 When the system is panicking, the calls of functions scheduled by
  34 \fBtimeout\fR(9F) and \fBddi_trigger_softintr\fR(9F) will never occur. Neither
  35 can  \fBdelay\fR(9F) be relied upon, since it is implemented via
  36 \fBtimeout\fR(9F).
  37 .sp
  38 .LP
  39 Drivers that need to enforce a time delay such as  \fBSCSI \fRbus reset delay
  40 time must busy-wait when the system is panicking.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 \fBddi_in_panic()\fR returns  \fB1\fR if the system is in panic,  or   \fB0\fR
  45 otherwise.
  46 .SH CONTEXT
  47 .sp
  48 .LP
  49 \fBddi_in_panic()\fR may be called from any context.
  50 .SH SEE ALSO
  51 .sp
  52 .LP
  53 \fBdump\fR(9E), \fBdelay\fR(9F), \fBddi_trigger_softintr\fR(9F),
  54 \fBtimeout\fR(9F)
  55 .sp
  56 .LP
  57 \fIWriting Device Drivers\fR