share/man/man9/panic.9

   1 .\"     $NetBSD: panic.9,v 1.2 1996/10/09 17:20:04 explorer Exp $
   2 .\"
   3 .\" Copyright (c) 1996 Michael Graff.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"      This product includes software developed by Michael Graff
  17 .\"      for the NetBSD Project.
  18 .\" 3. The name of the author may not be used to endorse or promote products
  19 .\"    derived from this software without specific prior written permission
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd April 23, 2015
  35 .Dt PANIC 9
  36 .Os
  37 .Sh NAME
  38 .Nm panic
  39 .Nd bring down system on fatal error
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/systm.h
  43 .Ft void
  44 .Fn panic "const char *fmt" ...
  45 .Ft void
  46 .Fn vpanic "const char *fmt" "va_list ap"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn panic
  50 and
  51 .Fn vpanic
  52 functions terminate the running system.
  53 The message
  54 .Fa fmt
  55 is a
  56 .Xr printf 3
  57 style format string.
  58 The message is printed to the console and the location
  59 .Fa panicstr
  60 is set to the address of the message text for retrieval from the OS
  61 core dump.
  62 .Pp
  63 If the kernel debugger is installed control is passed to it, otherwise
  64 an attempt to save a core dump of the OS to a configured dump device
  65 is made.
  66 .Pp
  67 If
  68 .Fn panic
  69 is called twice (from the disk sync routines, for example) the system is
  70 rebooted without syncing the disks.
  71 .Sh RETURN VALUES
  72 The
  73 .Fn panic
  74 function does not return.