xref: /netbsd-src/share/man/man9/panic.9 (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1.\"     $NetBSD: panic.9,v 1.12 2002/02/13 08:18:47 ross 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.\" 4. 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.Dd May 26, 2000
33.Dt PANIC 9
34.Os
35.Sh NAME
36.Nm panic
37.Nd Bring down system on fatal error
38.Sh SYNOPSIS
39.Fd #include \*[Lt]sys/types.h\*[Gt]
40.Fd #include \*[Lt]sys/systm.h\*[Gt]
41.Ft void
42.Fn panic "const char *fmt, ..."
43.Sh DESCRIPTION
44The
45.Fn panic
46function terminates the
47.Nx
48system.
49The message
50.Fa fmt
51is a
52.Xr printf 3
53style format string which is printed to the console and saved in the
54variable
55.Va panicstr
56for later retrieval via core dump inspection.
57.Pp
58If a kernel debugger is installed, control is passed to it after the
59message is printed. If the kernel debugger is
60.Xr ddb 4 ,
61control is only passed if the value of the
62.Em ddb.onpanic
63.Xr sysctl 3
64is
65.Dq 1 ,
66otherwise, a
67.Xr ddb 4 -specific
68function is used to print the kernel stack trace, and then control returns
69to
70.Fn panic .
71.Pp
72If control remains in
73.Fn panic ,
74an attempt is made to save an image of system memory on the
75configured dump device.
76.Pp
77If during the process of handling the panic,
78.Fn panic
79is called again
80.Pq "from the filesystem synchronization routines, for example" ,
81the system is rebooted immediately without synchronizing any filesystems.
82.Sh RETURN VALUES
83The
84.Fn panic
85function does not return.
86.Sh SEE ALSO
87.Xr sysctl 3 ,
88.Xr ddb 4 ,
89.Xr ipkdb 4 ,
90.Xr options 4 ,
91.Xr savecore 8 ,
92.Xr swapctl 8 ,
93.Xr sysctl 8
94