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