share/man/man9/spinlock.9

   1 .\"
   2 .\" Copyright (c) 2006 The DragonFly Project.  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 .\"
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $DragonFly: src/share/man/man9/spinlock.9,v 1.4 2006/06/01 17:17:35 dillon Exp $
  32 .\"
  33 .Dd May 27, 2006
  34 .Os
  35 .Dt SPINLOCK 9
  36 .Sh NAME
  37 .Nm spin_init ,
  38 .Nm spin_lock_rd ,
  39 .Nm spin_lock_rd_quick ,
  40 .Nm spin_lock_wr ,
  41 .Nm spin_lock_wr_quick ,
  42 .Nm spin_trylock_wr ,
  43 .Nm spin_uninit ,
  44 .Nm spin_unlock_rd ,
  45 .Nm spin_unlock_rd_quick ,
  46 .Nm spin_unlock_wr ,
  47 .Nm spin_unlock_wr_quick
  48 .Nd core spinlocks
  49 .Sh SYNOPSIS
  50 .In sys/spinlock.h
  51 .In sys/spinlock2.h
  52 .Ft void
  53 .Fn spin_init "struct spinlock *mtx"
  54 .Ft void
  55 .Fn spin_uninit "struct spinlock *mtx"
  56 .Ft void
  57 .Fn spin_lock_rd "struct spinlock *mtx"
  58 .Ft void
  59 .Fn spin_lock_rd_quick "globaldata_t gd" "struct spinlock *mtx"
  60 .Ft void
  61 .Fn spin_unlock_rd "struct spinlock *mtx"
  62 .Ft void
  63 .Fn spin_unlock_rd_quick "globaldata_t gd" "struct spinlock *mtx"
  64 .Ft void
  65 .Fn spin_lock_wr "struct spinlock *mtx"
  66 .Ft void
  67 .Fn spin_lock_wr_quick "globaldata_t gd" "struct spinlock *mtx"
  68 .Ft boolean_t
  69 .Fn spin_trylock_wr "struct spinlock *mtx"
  70 .Ft void
  71 .Fn spin_unlock_wr "struct spinlock *mtx"
  72 .Ft void
  73 .Fn spin_unlock_wr_quick "globaldata_t gd" "struct spinlock *mtx"
  74 .Sh DESCRIPTION
  75 The
  76 .Fa spinlock
  77 structure and call API are defined in the
  78 .In sys/spinlock.h
  79 and
  80 .In sys/spinlock2.h
  81 header files, respectively.
  82 .Pp
  83 The
  84 .Fn spin_init
  85 function initializes a new
  86 .Fa spinlock
  87 structure for use.
  88 The structure is cleaned up with
  89 .Fn spin_uninit
  90 when it is no longer needed.
  91 .Pp
  92 The
  93 .Fn spin_lock_rd
  94 function obtains a shared
  95 .Em read-only
  96 spinlock.
  97 A thread may hold only one shared lock at a time, and may not acquire any
  98 new exclusive locks while holding a shared lock (but may already be holding
  99 some).  A shared spinlock can be held by multiple CPUs concurrently.
 100 If a thread attempts to obtain an exclusive spinlock while shared
 101 references from other cpus exist it will spin until the shared references
 102 go away.
 103 No new shared references will be allowed (that is, new shared requests
 104 will also spin) while the exclusive spinlock is being acquired.
 105 If you have the current CPU's
 106 .Fa globaldata
 107 pointer in hand you can call
 108 .Fn spin_lock_rd_quick ,
 109 but most code will just call the normal version.
 110 Shared spinlocks reserve a bit in the spinlock's memory for each CPU
 111 and do not clear the bit once set.
 112 This means that once set, a shared spinlock does not need to issue a
 113 locked read-modify-write bus cycle to the spinlock's memory, which in
 114 turn greatly reduces conflicts between CPU caches.
 115 The bit is cleared via a different mechanism only when an exclusive
 116 spinlock is acquired.
 117 The result is extremely low overheads even when a shared spinlock is
 118 being operated upon concurrently by multiple CPUs.
 119 .Pp
 120 A previously obtained shared spinlock is released by calling either
 121 .Fn spin_unlock_rd
 122 or
 123 .Fn spin_unlock_rd_quick .
 124 .Pp
 125 The
 126 .Fn spin_lock_wr
 127 function obtains an exclusive
 128 .Em read-write
 129 spinlock.
 130 A thread may hold any number of exclusive spinlocks but should always
 131 be mindful of ordering deadlocks.  Exclusive spinlocks can only be safely
 132 acquired if no shared spinlocks are held.
 133 The
 134 .Fn spin_trylock_wr
 135 function will return
 136 .Dv TRUE
 137 if the spinlock was successfully obtained and
 138 .Dv FALSE
 139 if it wasn't.
 140 If you have the current CPU's
 141 .Fa globaldata
 142 pointer in hand you can call
 143 .Fn spin_lock_wr_quick ,
 144 but most code will just call the normal version.
 145 A spinlock used only for exclusive access has about the same overhead
 146 as a mutex based on a locked bus cycle.
 147 When used in a mixed shared/exclusive environment, however, additional
 148 overhead may be incurred to obtain the exclusive spinlock.
 149 Because shared spinlocks are left intact even after released (to
 150 optimize shared spinlock performance), the exclusive spinlock code
 151 must run through any shared bits it finds in the spinlock, clear them,
 152 and check the related CPU's
 153 .Fa globaldata
 154 structure to determine whether it needs to spin or not.
 155 .Pp
 156 A previously obtained exclusive spinlock is released by calling either
 157 .Fn spin_unlock_wr
 158 or
 159 .Fn spin_unlock_wr_quick .
 160 .Sh IMPLEMENTATION NOTES
 161 A thread may not hold any spinlock across a blocking condition or
 162 thread switch.
 163 LWKT tokens should be used for situations where you want an exclusive
 164 run-time lock that will survive a blocking condition or thread switch.
 165 Tokens will be automatically unlocked when a thread switches away and
 166 relocked when the thread is switched back in.
 167 If you want a lock that survives a blocking condition or thread switch
 168 without being released, use
 169 .Xr lockmgr 9
 170 locks or LWKT reader/writer locks.
 171 .Pp
 172 .Dx Ap s
 173 core spinlocks should only be used around small contained sections of
 174 code.
 175 For example, to manage a reference count or to implement higher level
 176 locking mechanisms.
 177 Both the token code and the
 178 .Xr lockmgr 9
 179 code use exclusive spinlocks internally.
 180 Core spinlocks should not be used around large chunks of code.
 181 .Pp
 182 Holding one or more spinlocks will disable thread preemption by
 183 another thread (e.g. preemption by an interrupt thread), but will not
 184 disable FAST interrupts or IPIs.
 185 If you wish to disable FAST interrupts and IPIs you need to enter a
 186 critical section prior to obtaining the spinlock.
 187 .Pp
 188 Currently, FAST interrupts, including IPI messages, are not allowed to
 189 acquire any spinlocks.  It is possible to work around this if
 190 mycpu->gd_spinlocks_wr and mycpu->gd_spinlocks_rd are both 0.  If one
 191 or the other is not zero, the FAST interrupt or IPI cannot acquire
 192 any spinlocks without risking a deadlock, even if the spinlocks in
 193 question are not related.
 194 .Pp
 195 A thread may hold any number of exclusive
 196 .Em read-write
 197 spinlocks.
 198 However, a thread may only hold one shared
 199 .Em read-only
 200 spinlock, and may not acquire any new exclusive locks while it is holding
 201 that one shared lock.  This requirement is due to the method exclusive
 202 spinlocks use to determine when they can clear cached shared bits in
 203 the lock.  If an exclusive lock is acquired while holding shared locks,
 204 a deadlock can occur even if the locks are unrelated.
 205 Always be mindful of potential deadlocks.
 206 .Pp
 207 Spinlocks spin.
 208 A thread will not block, switch away, or lose its critical section
 209 while obtaining or releasing a spinlock.
 210 Spinlocks do not use IPIs or other mechanisms.
 211 They are considered to be a very low level mechanism.
 212 .Pp
 213 If a spinlock can not be obtained after one second a warning will be
 214 printed on the console.
 215 If a system panic occurs, spinlocks will succeed after one second in
 216 order to allow the panic operation to proceed.
 217 .Pp
 218 If you have a complex structure such as a
 219 .Xr vnode 9
 220 which contains a token or
 221 .Xr lockmgr 9
 222 lock, it is legal to directly access the internal spinlock embedded
 223 in those structures for other purposes as long as the spinlock is not
 224 held when you issue the token or lockmgr operation.
 225 .Sh SEE ALSO
 226 .Xr lockmgr 9 ,
 227 .Xr lwkt 9
 228 .Sh HISTORY
 229 A
 230 .Nm spinlock
 231 implementation first appeared in
 232 .Dx 1.3 .
 233 .Sh AUTHORS
 234 .An -nosplit
 235 The original
 236 .Nm spinlock
 237 implementation was written by
 238 .An Jeffrey M. Hsu
 239 and was later extended by
 240 .An Matthew Dillon .
 241 This manual page was written by
 242 .An Matthew Dillon
 243 and
 244 .An Sascha Wildner .