share/man/man9/SPLASSERT.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2000 Jonathan M. Bresler
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 14, 2000
  32 .Os
  33 .Dt SPLASSERT 9
  34 .Sh NAME
  35 .Nm SPLASSERT
  36 .Nd kernel spl level verification macro
  37 .Sh SYNOPSIS
  38 .Cd options INVARIANTS
  39 .Cd options INVARIANT_SUPPORT
  40 .Fn SPLASSERT "level, const char *msg"
  41 .Sh DESCRIPTION
  42 In a kernel compiled with both "options INVARIANTS"
  43 and "options INVARIANT_SUPPORT",
  44 the
  45 .Fn SPLASSERT
  46 macro compares the current spl level of the kernel with the spl
  47 .Ar level
  48 specified in the macro
  49 .Fn SPLASSERT .
  50 If the specified
  51 .Ar level
  52 is not active
  53 .Fn SPLASSERT
  54 calls the
  55 .Fn KASSERT
  56 macro with the
  57 .Ar msg,
  58 terminating the running system.
  59 .Pp
  60 In a kernel that does not have both "options INVARIANTS"
  61 and "options INVARIANT_SUPPORT",
  62 the
  63 .Fn SPLASSERT
  64 macro is defined to be a no-op.
  65 .Pp
  66 The behaviour of
  67 .Fn SPLASSERT
  68 is tunable by means of the
  69 .Xr sysctl 8
  70 knob kern.splassertmode.
  71 When set to 0 the
  72 .Fn SPLASSERT
  73 macro is defined to be a no-op.
  74 When set to 1 the
  75 .Fn SPLASSERT
  76 macro is defined to log information to the console.
  77 When set to 2 the
  78 .Fn SPLASSERT
  79 macro is defined to
  80 .Xr panic 9 .
  81 .Sh EXAMPLES
  82 The kernel function
  83 .Fn rtalloc
  84 must be called at
  85 .Fn splnet :
  86 .Bd -literal -offset indent
  87 void
  88 rtalloc(ro)
  89         register struct route *ro;
  90 {
  91         SPLASSERT(net, "rtalloc()");
  92         rtalloc_ign(ro, 0UL);
  93 }
  94 .Ed
  95 .Pp
  96 .Sh SEE ALSO
  97 .Xr config 8 ,
  98 .Xr CONDSPLASSERT 9 ,
  99 .Xr KASSERT 9 ,
 100 .Xr panic 9
 101 .Sh AUTHORS
 102 This manual page was written by
 103 .An Jonathan M. Bresler
 104 .Aq jmb@FreeBSD.org .