xref: /freebsd/share/man/man3/assert.3 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)assert.3	8.1 (Berkeley) 6/9/93
33.\"	$Id: assert.3,v 1.3 1997/03/07 03:27:51 jmg Exp $
34.\"
35.Dd June 9, 1993
36.Dt ASSERT 3
37.Os
38.Sh NAME
39.Nm assert
40.Nd expression verification macro
41.Sh SYNOPSIS
42.Fd #include <assert.h>
43.Fn assert expression
44.Sh DESCRIPTION
45The
46.Fn assert
47macro tests the given
48.Ar expression
49and if it is false,
50the calling process is terminated.
51A
52diagnostic message is written to the
53.Em stderr
54and the function
55.Xr abort 3
56is called effectively terminating the program.
57.Pp
58If
59.Ar expression
60is true,
61the
62.Fn assert
63macro does nothing.
64.Pp
65The
66.Fn assert
67macro
68may be removed at compile time with
69the
70.Fl NDEBUG
71option, see
72.Xr cc 1 .
73.Sh DIAGNOSTICS
74The following diagnostic message is written to
75.Em stderr
76if
77.Ar expression
78is false:
79.Bd -literal -offset indent
80"assertion \e"%s\e" failed: file \e"%s\e", line %d\n", \e
81		    "expression", __FILE__, __LINE__);
82.Ed
83.Sh SEE ALSO
84.Xr abort 3
85.Sh HISTORY
86A
87.Nm assert
88macro appeared in
89.At v6 .
90