freebsd-skq/share/man/man9/KASSERT.9

.\" -*- nroff -*-
.\"
.\" Copyright (c) 2000 Jonathan M. Bresler
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 14, 2000
.Dt KASSERT 9
.Os
.Sh NAME
.Nm KASSERT
.Nd kernel expression verification macro
.Sh SYNOPSIS
.Cd "options INVARIANTS"
.Pp
.In sys/param.h
.In sys/systm.h
.Fn KASSERT expression msg
.Sh DESCRIPTION
In a kernel compiled with
.Cd "options INVARIANTS" ,
the
.Fn KASSERT
macro tests the given
.Fa expression
and if it is false,
calls the
.Xr panic 9
function, terminating the running system.
.Pp
In a kernel that does not have
.Cd "options INVARIANTS" ,
the
.Fn KASSERT
macro is defined to be a no-op.
The
second argument is a
.Xr printf 9
format string and its arguments,
enclosed in parentheses.
.Sh EXAMPLES
The kernel function
.Fn vput
must not be called with a
.Dv NULL
pointer.
.Bd -literal -offset indent
void
vput(vp)
        struct vnode *vp;
{
	struct proc *p = curproc;
	KASSERT(vp != NULL, ("vput: null vp"));
	...
}
.Ed
.Sh SEE ALSO
.Xr config 8 ,
.Xr panic 9
.Sh AUTHORS
This manual page was written by
.An Jonathan M. Bresler Aq Mt jmb@FreeBSD.org .
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.\" -- nroff --`
			`.\"`
Assorted bag o' fixes: fix Jonathan's name, fix copyright date, man -> manual, add const before char *msg, add email address. 2000-03-21 13:18:40 +00:00			`.\" Copyright (c) 2000 Jonathan M. Bresler`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.\"`
			`.\" All rights reserved.`
			`.\"`
			`.\" This program is free software.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd January 14, 2000`
			`.Dt KASSERT 9`
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors) 2010-04-14 19:08:06 +00:00			`.Os`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Sh NAME`
			`.Nm KASSERT`
			`.Nd kernel expression verification macro`
			`.Sh SYNOPSIS`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`.Cd "options INVARIANTS"`
			`.Pp`
Update function definitions and required include files to reflect the current state of the system. Approved by: alfred 2001-12-26 23:14:04 +00:00			`.In sys/param.h`
			`.In sys/systm.h`
			`.Fn KASSERT expression msg`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Sh DESCRIPTION`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`In a kernel compiled with`
			`.Cd "options INVARIANTS" ,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`the`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Fn KASSERT`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`macro tests the given`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`.Fa expression`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`and if it is false,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`calls the`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`.Xr panic 9`
			`function, terminating the running system.`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Pp`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`In a kernel that does not have`
			`.Cd "options INVARIANTS" ,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`the`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Fn KASSERT`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`macro is defined to be a no-op.`
Remove a bogus NOTES section. Move that content elsewhere. Approved by: des (mentor), re (scottl) 2003-05-16 19:54:20 +00:00			`The`
			`second argument is a`
			`.Xr printf 9`
			`format string and its arguments,`
			`enclosed in parentheses.`
Fix EXAMPLE -> EXAMPLES. Add Xr's for SPLASSERT and CONDSPLASSERT. 2000-03-21 13:21:36 +00:00			`.Sh EXAMPLES`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`The kernel function`
			`.Fn vput`
mdoc(7) police: - logically sort the SYNOPSIS section - add missing markup bits - "brackets" -> "parentheses" 2002-01-10 09:20:07 +00:00			`must not be called with a`
			`.Dv NULL`
			`pointer.`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Bd -literal -offset indent`
			`void`
			`vput(vp)`
			`struct vnode *vp;`
			`{`
			`struct proc *p = curproc;`
			`KASSERT(vp != NULL, ("vput: null vp"));`
			`...`
			`}`
			`.Ed`
			`.Sh SEE ALSO`
			`.Xr config 8 ,`
Remove trailing comma. 2000-03-21 17:34:56 +00:00			`.Xr panic 9`
Document the KASSERT() macro. 2000-01-14 21:41:09 +00:00			`.Sh AUTHORS`
Assorted bag o' fixes: fix Jonathan's name, fix copyright date, man -> manual, add const before char *msg, add email address. 2000-03-21 13:18:40 +00:00			`This manual page was written by`
use .Mt to mark up email addresses consistently (part6) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:44:30 +00:00			`.An Jonathan M. Bresler Aq Mt jmb@FreeBSD.org .`