share/man/man9/kpreempt.9

   1 .\"     $NetBSD: kpreempt.9,v 1.1 2008/05/06 08:34:35 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2008 YAMAMOTO Takashi,
   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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd December 21, 2008
  29 .Dt KPREEMPT 9
  30 .Os
  31 .\" ------------------------------------------------------------
  32 .Sh NAME
  33 .Nm kpreempt
  34 .Nd control kernel preemption
  35 .\" ------------------------------------------------------------
  36 .Sh SYNOPSIS
  37 .In sys/systm.h
  38 .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  39 .Ft void
  40 .Fn kpreempt_disable \
  41 "void"
  42 .Ft void
  43 .Fn kpreempt_enable \
  44 "void"
  45 .Ft bool
  46 .Fn kpreempt_disabled \
  47 "void"
  48 .\" ------------------------------------------------------------
  49 .Sh DESCRIPTION
  50 These functions are used to control kernel preemption of the calling LWP.
  51 .Pp
  52 On architectures where kernel preemption is not supported natively, these
  53 functions may still be used.
  54 .Pp
  55 .Fn kpreempt_disable
  56 disables kernel preemption of the calling LWP.
  57 Note that disabling kernel preemption can prevent LWPs with higher priorities
  58 from running.
  59 .Pp
  60 .Fn kpreempt_enable
  61 enables kernel preemption of the calling LWP, which was previously disabled by
  62 .Fn kpreempt_disable .
  63 .Pp
  64 .Fn kpreempt_disable
  65 and
  66 .Fn kpreempt_enable
  67 can be nested.
  68 .Pp
  69 .Fn kpreempt_disabled
  70 returns
  71 .Dv true
  72 if preemption of the calling LWP is disabled.
  73 It's for diagnostic purpose.
  74 .\" ------------------------------------------------------------
  75 .\" .Sh RETURN VALUES
  76 .\" ------------------------------------------------------------
  77 .Sh SEE ALSO
  78 .Xr intro 9 ,
  79 .Xr spl 9