share/man/man9/spl.9

   1 .\"
   2 .\" Copyright (c) 1996 Joerg Wunsch
   3 .\"
   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 DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/spl.9,v 1.8.2.5 2001/12/17 11:30:19 ru Exp $
  27 .\"
  28 .Dd July 21, 1996
  29 .Os
  30 .Dt SPL 9
  31 .Sh NAME
  32 .Nm splbio ,
  33 .Nm splclock ,
  34 .Nm splhigh ,
  35 .Nm splimp ,
  36 .Nm splnet ,
  37 .Nm splsoftclock ,
  38 .Nm splsofttty ,
  39 .Nm splstatclock ,
  40 .Nm spltty ,
  41 .Nm splvm ,
  42 .Nm spl0 ,
  43 .Nm splx
  44 .Nd manipulate interrupt priorities
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In sys/systm.h
  48 .Ft intrmask_t
  49 .Fn splbio "void"
  50 .Ft intrmask_t
  51 .Fn splclock "void"
  52 .Ft intrmask_t
  53 .Fn splhigh "void"
  54 .Ft intrmask_t
  55 .Fn splimp "void"
  56 .Ft intrmask_t
  57 .Fn splnet "void"
  58 .Ft intrmask_t
  59 .Fn splsoftclock "void"
  60 .Ft intrmask_t
  61 .Fn splsofttty "void"
  62 .Ft intrmask_t
  63 .Fn splstatclock "void"
  64 .Ft intrmask_t
  65 .Fn spltty "void"
  66 .Ft void
  67 .Fn spl0 "void"
  68 .Ft void
  69 .Fn splx "intrmask_t ipl"
  70 .Sh DESCRIPTION
  71 The
  72 .Fn spl
  73 function family sets the interrupt priority
  74 .Dq level
  75 of the CPU.
  76 This prevents interrupt handlers of the blocked priority level from
  77 being run.  This is used in the
  78 .Dq synchronous
  79 part of a driver (the part that runs on behalf of the user process) to
  80 examine or modify data areas that might be examined or modified by
  81 interrupt handlers.
  82 .Pp
  83 Each driver that uses interrupts is normally assigned to an interrupt
  84 priority group by a keyword in its config line.
  85 For example:
  86 .Bd -literal -offset indent
  87 device foo0 at isa? port 0x0815 irq 12 tty
  88 .Ed
  89 .Pp
  90 assigns interrupt 12 to the
  91 .Dq tty
  92 priority group.  The system automatically arranges for interrupts in
  93 the
  94 .Em xxx
  95 group to be called at a priority >=
  96 .Ns spl Ns Em xxx
  97 \&().
  98 .Pp
  99 The function
 100 .Fn splx
 101 sets the interrupt priority to an absolute value.  The intent is that
 102 the value returned by the other functions should be saved in a local
 103 variable, and later passed to
 104 .Fn splx
 105 in order to restore the previous priority.
 106 .Pp
 107 The function
 108 .Fn spl0
 109 lowers the priority to a value where all interrupt handlers are
 110 unblocked, but ASTs (asynchronous system traps) remain blocked until
 111 the system is about to return to user mode.
 112 .Pp
 113 The traditional assignment of the various device drivers to the
 114 interrupt priority groups can be roughly classified as:
 115 .Bl -tag -width Fn
 116 .It Fn splnet
 117 All network interface drivers.
 118 .It Fn splbio
 119 All
 120 .Em buffered IO
 121 (i.e., disk and the like) drivers.
 122 .It Fn spltty
 123 Basically, all non-network communications devices, but effectively
 124 used for all drivers that are neither network nor disks.
 125 .El
 126 .Sh RETURN VALUES
 127 All functions except
 128 .Fn splx
 129 and
 130 .Fn spl0
 131 return the previous priority value.
 132 .Sh EXAMPLES
 133 This is a typical example demonstrating the usage:
 134 .Bd -literal
 135 struct foo_softc {
 136         ...
 137         int flags;
 138 #define FOO_ASLEEP      1
 139 #define FOO_READY       2
 140
 141 } foo_softc[NFOO];
 142
 143 int
 144 foowrite(...)
 145 {
 146         struct foo_softc *sc;
 147         int s, error;
 148
 149         ...
 150         s = spltty();
 151         if (!(sc->flags & FOO_READY)) {
 152                 /* Not ready, must sleep on resource. */
 153                 sc->flags |= FOO_ASLEEP;
 154                 error = tsleep(sc, PZERO, "foordy", 0);
 155                 sc->flags &= ~FOO_ASLEEP;
 156         }
 157         sc->flags &= ~FOO_READY;
 158         splx(s);
 159
 160         ...
 161 }
 162
 163 void
 164 foointr(...)
 165 {
 166         struct foo_softc *sc;
 167
 168         ...
 169         sc->flags |= FOO_READY;
 170         if (sc->flags & FOO_ASLEEP)
 171                 /* Somebody was waiting for us, awake him. */
 172                 wakeup(sc);
 173         ...
 174 }
 175
 176 .Ed
 177 Note that the interrupt handler should
 178 .Em never
 179 reduce the priority level.  It is automatically called as it had
 180 raised the interrupt priority to its own level, i.e. further interrupts
 181 of the same group are being blocked.
 182 .Sh HISTORY
 183 The interrupt priority levels appeared in a very early version of
 184 Unix.  They have been traditionally known by number instead of by
 185 names, and were inclusive up to higher priority levels (i.e., priority
 186 5 has been blocking everything up to level 5).  This is no longer the
 187 case in
 188 .Fx .
 189 The traditional name
 190 .Ql level
 191 for them is still reflected in the letter
 192 .Ql l
 193 of the respective functions and variables, although they are not
 194 really levels anymore, but rather different (partially inclusive)
 195 sets of functions to be blocked during some periods of the life of
 196 the system.  The historical number scheme can be considered as a
 197 simple linearly ordered set of interrupt priority groups.
 198 .Sh AUTHORS
 199 This man page was written by
 200 .An J\(:org Wunsch .