xref: /netbsd-src/share/man/man9/KASSERT.9 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\"     $NetBSD: KASSERT.9,v 1.7 2008/07/11 13:20:17 gdt Exp $
2.\"
3.\" Copyright (c) 2006 Igor Sobrado
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd December 10, 2006
28.Dt KASSERT 9
29.Os
30.Sh NAME
31.Nm KASSERT ,
32.Nm KDASSERT
33.Nd kernel expression verification macros
34.Sh SYNOPSIS
35.Ft void
36.Fn KASSERT expression
37.Ft void
38.Fn KDASSERT expression
39.Sh DESCRIPTION
40These machine independent assertion-checking macros cause a kernel
41.Xr panic 9
42if the given
43.Ar expression
44evaluates to false.
45.Pp
46.Fn KASSERT
47tests are included only in kernels compiled with the
48.Dv DIAGNOSTIC
49configuration option.
50In a kernel that does not have this configuration option, the
51.Fn KASSERT
52macro is defined to be a no-op.
53.Pp
54.Fn KDASSERT
55tests are included only in kernels compiled with the
56.Dv DEBUG
57configuration option.
58.Fn KDASSERT
59and
60.Fn KASSERT
61are identical except for the controlling option
62.Pf ( Dv DEBUG
63vs
64.Dv DIAGNOSTIC ) .
65.Pp
66The panic message will display the style of assertion (debugging
67vs. diagnostic), the expression that failed and the filename, and line
68number the failure happened on.
69.Sh SEE ALSO
70.Xr config 1 ,
71.Xr panic 9 ,
72.Xr printf 9
73.Sh AUTHORS
74These macros were written by
75.An Chris G. Demetriou
76.Aq cgd@netbsd.org .
77