share/man/man3/assert.3

   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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)assert.3    8.1 (Berkeley) 6/9/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd May 31, 2018
  32 .Dt ASSERT 3
  33 .Os
  34 .Sh NAME
  35 .Nm assert
  36 .Nd expression verification macro
  37 .Sh SYNOPSIS
  38 .In assert.h
  39 .Fn assert expression
  40 .Sh DESCRIPTION
  41 The
  42 .Fn assert
  43 macro tests the given
  44 .Ar expression
  45 and if it is false,
  46 the calling process is terminated.
  47 A diagnostic message is written to
  48 .Dv stderr
  49 and the function
  50 .Xr abort 3
  51 is called, effectively terminating the program.
  52 .Pp
  53 If
  54 .Ar expression
  55 is true,
  56 the
  57 .Fn assert
  58 macro does nothing.
  59 .Pp
  60 The
  61 .Fn assert
  62 macro
  63 may be removed at compile time by defining
  64 .Dv NDEBUG
  65 as a macro
  66 (e.g., by using the
  67 .Xr cc 1
  68 option
  69 .Fl D Ns Dv NDEBUG ) .
  70 Unlike most other include files,
  71 .In assert.h
  72 may be included multiple times.
  73 Each time whether or not
  74 .Dv NDEBUG
  75 is defined determines the behavior of assert from that point forward
  76 until the end of the unit or another include of
  77 .In assert.h .
  78 .Pp
  79 The
  80 .Fn assert
  81 macro should only be used for ensuring the developer's expectations
  82 hold true.
  83 It is not appropriate for regular run-time error detection.
  84 .Sh EXAMPLES
  85 The assertion:
  86 .Dl "assert(1 == 0);"
  87 generates a diagnostic message similar to the following:
  88 .Dl "Assertion failed: (1 == 0), function main, file main.c, line 100."
  89 .Pp
  90 The following assert tries to assert there was no partial read:
  91 .Dl "assert(read(fd, buf, nbytes) == nbytes);"
  92 However, there are two problems.
  93 First, it checks for normal conditions, rather than conditions that
  94 indicate a bug.
  95 Second, the code will disappear if
  96 .Dv NDEBUG
  97 is defined, changing the semantics of the program.
  98 .Sh SEE ALSO
  99 .Xr abort2 2 ,
 100 .Xr abort 3
 101 .Sh STANDARDS
 102 The
 103 .Fn assert
 104 macro conforms to
 105 .St -isoC-99 .
 106 .Sh HISTORY
 107 An
 108 .Nm
 109 macro appeared in
 110 .At v7 .