share/man/man9/atomic.9

   1 .\" Copyright (c) 2000-2001 John H. Baldwin <jhb@FreeBSD.org>
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD: src/share/man/man9/atomic.9,v 1.17 2010/05/27 13:56:27 uqs Exp $
  25 .\"
  26 .Dd June 13, 2012
  27 .Dt ATOMIC 9
  28 .Os
  29 .Sh NAME
  30 .Nm atomic_add ,
  31 .Nm atomic_clear ,
  32 .Nm atomic_cmpset ,
  33 .Nm atomic_fetchadd ,
  34 .Nm atomic_load ,
  35 .Nm atomic_readandclear ,
  36 .Nm atomic_set ,
  37 .Nm atomic_subtract ,
  38 .Nm atomic_store
  39 .Nd atomic operations
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In machine/atomic.h
  43 .Ft void
  44 .Fn atomic_add_[acq_|rel_]<type> "volatile <type> *p" "<type> v"
  45 .Ft void
  46 .Fn atomic_clear_[acq_|rel_]<type> "volatile <type> *p" "<type> v"
  47 .Ft int
  48 .Fo atomic_cmpset_[acq_|rel_]<type>
  49 .Fa "volatile <type> *dst"
  50 .Fa "<type> old"
  51 .Fa "<type> new"
  52 .Fc
  53 .Ft <type>
  54 .Fn atomic_fetchadd_<type> "volatile <type> *p" "<type> v"
  55 .Ft <type>
  56 .Fn atomic_load_acq_<type> "volatile <type> *p"
  57 .Ft <type>
  58 .Fn atomic_readandclear_<type> "volatile <type> *p"
  59 .Ft void
  60 .Fn atomic_set_[acq_|rel_]<type> "volatile <type> *p" "<type> v"
  61 .Ft void
  62 .Fn atomic_subtract_[acq_|rel_]<type> "volatile <type> *p" "<type> v"
  63 .Ft void
  64 .Fn atomic_store_rel_<type> "volatile <type> *p" "<type> v"
  65 .Sh DESCRIPTION
  66 Each of the atomic operations is guaranteed to be atomic in the presence of
  67 interrupts.
  68 They can be used to implement reference counts or as building blocks for more
  69 advanced synchronization primitives such as mutexes.
  70 .Ss Types
  71 Each atomic operation operates on a specific
  72 .Fa type .
  73 The type to use is indicated in the function name.
  74 The available types that can be used are:
  75 .Pp
  76 .Bl -tag -offset indent -width short -compact
  77 .It Li cpumask
  78 CPU mask (cpumask_t)
  79 .It Li int
  80 unsigned integer
  81 .It Li long
  82 unsigned long integer
  83 .It Li ptr
  84 unsigned integer the size of a pointer
  85 .It Li 32
  86 unsigned 32-bit integer
  87 .\".It Li 64
  88 .\"unsigned 64-bit integer
  89 .El
  90 .Pp
  91 For example, the function to atomically add two integers is called
  92 .Fn atomic_add_int .
  93 .Pp
  94 Certain architectures also provide operations for types smaller than
  95 .Dq Li int .
  96 .Pp
  97 .Bl -tag -offset indent -width short -compact
  98 .It Li char
  99 unsigned character
 100 .It Li short
 101 unsigned short integer
 102 .It Li 8
 103 unsigned 8-bit integer
 104 .It Li 16
 105 unsigned 16-bit integer
 106 .El
 107 .Pp
 108 These must not be used in MI code because the instructions to implement them
 109 efficiently may not be available.
 110 .Ss Memory Barriers
 111 Memory barriers are used to guarantee the order of data accesses in
 112 two ways.
 113 First, they specify hints to the compiler to not re-order or optimize the
 114 operations.
 115 Second, on architectures that do not guarantee ordered data accesses,
 116 special instructions or special variants of instructions are used to indicate
 117 to the processor that data accesses need to occur in a certain order.
 118 As a result, most of the atomic operations have three variants in order to
 119 include optional memory barriers.
 120 The first form just performs the operation without any explicit barriers.
 121 The second form uses a read memory barrier, and the third variant uses a write
 122 memory barrier.
 123 .Pp
 124 The second variant of each operation includes a read memory barrier.
 125 This barrier ensures that the effects of this operation are completed before the
 126 effects of any later data accesses.
 127 As a result, the operation is said to have acquire semantics as it acquires a
 128 pseudo-lock requiring further operations to wait until it has completed.
 129 To denote this, the suffix
 130 .Dq Li _acq
 131 is inserted into the function name immediately prior to the
 132 .Dq Li _ Ns Aq Fa type
 133 suffix.
 134 For example, to subtract two integers ensuring that any later writes will
 135 happen after the subtraction is performed, use
 136 .Fn atomic_subtract_acq_int .
 137 .Pp
 138 The third variant of each operation includes a write memory barrier.
 139 This ensures that all effects of all previous data accesses are completed
 140 before this operation takes place.
 141 As a result, the operation is said to have release semantics as it releases
 142 any pending data accesses to be completed before its operation is performed.
 143 To denote this, the suffix
 144 .Dq Li _rel
 145 is inserted into the function name immediately prior to the
 146 .Dq Li _ Ns Aq Fa type
 147 suffix.
 148 For example, to add two long integers ensuring that all previous
 149 writes will happen first, use
 150 .Fn atomic_add_rel_long .
 151 .Pp
 152 A practical example of using memory barriers is to ensure that data accesses
 153 that are protected by a lock are all performed while the lock is held.
 154 To achieve this, one would use a read barrier when acquiring the lock to
 155 guarantee that the lock is held before any protected operations are performed.
 156 Finally, one would use a write barrier when releasing the lock to ensure that
 157 all of the protected operations are completed before the lock is released.
 158 .Ss Multiple Processors
 159 The current set of atomic operations do not necessarily guarantee atomicity
 160 across multiple processors.
 161 To guarantee atomicity across processors, not only does the individual
 162 operation need to be atomic on the processor performing the operation, but
 163 the result of the operation needs to be pushed out to stable storage and the
 164 caches of all other processors on the system need to invalidate any cache
 165 lines that include the affected memory region.
 166 .Ss Semantics
 167 This section describes the semantics of each operation using a C like notation.
 168 .Bl -hang
 169 .It Fn atomic_add p v
 170 .Bd -literal -compact
 171 *p += v;
 172 .Ed
 173 .El
 174 .Pp
 175 The
 176 .Fn atomic_add
 177 functions are not implemented for the type
 178 .Dq Li cpumask .
 179 .Bl -hang
 180 .It Fn atomic_clear p v
 181 .Bd -literal -compact
 182 *p &= ~v;
 183 .Ed
 184 .It Fn atomic_cmpset dst old new
 185 .Bd -literal -compact
 186 if (*dst == old) {
 187         *dst = new;
 188         return 1;
 189 } else {
 190         return 0;
 191 }
 192 .Ed
 193 .El
 194 .Pp
 195 The
 196 .Fn atomic_cmpset
 197 functions are not implemented for the types
 198 .Dq Li char ,
 199 .Dq Li short ,
 200 .Dq Li 8 ,
 201 and
 202 .Dq Li 16 .
 203 .Bl -hang
 204 .It Fn atomic_fetchadd p v
 205 .Bd -literal -compact
 206 tmp = *p;
 207 *p += v;
 208 return tmp;
 209 .Ed
 210 .El
 211 .Pp
 212 The
 213 .Fn atomic_fetchadd
 214 functions are only implemented for the types
 215 .Dq Li int ,
 216 .Dq Li long
 217 and
 218 .Dq Li 32
 219 and do not have any variants with memory barriers at this time.
 220 .Bl -hang
 221 .It Fn atomic_load addr
 222 .Bd -literal -compact
 223 return (*addr)
 224 .Ed
 225 .El
 226 .Pp
 227 The
 228 .Fn atomic_load
 229 functions are only provided with acquire memory barriers.
 230 .Bl -hang
 231 .It Fn atomic_readandclear addr
 232 .Bd -literal -compact
 233 temp = *addr;
 234 *addr = 0;
 235 return (temp);
 236 .Ed
 237 .El
 238 .Pp
 239 The
 240 .Fn atomic_readandclear
 241 functions are not implemented for the types
 242 .Dq Li char ,
 243 .Dq Li short ,
 244 .Dq Li ptr ,
 245 .Dq Li 8 ,
 246 .Dq Li 16 ,
 247 and
 248 .Dq Li cpumask
 249 and do
 250 not have any variants with memory barriers at this time.
 251 .Bl -hang
 252 .It Fn atomic_set p v
 253 .Bd -literal -compact
 254 *p |= v;
 255 .Ed
 256 .It Fn atomic_subtract p v
 257 .Bd -literal -compact
 258 *p -= v;
 259 .Ed
 260 .El
 261 .Pp
 262 The
 263 .Fn atomic_subtract
 264 functions are not implemented for the type
 265 .Dq Li cpumask .
 266 .Bl -hang
 267 .It Fn atomic_store p v
 268 .Bd -literal -compact
 269 *p = v;
 270 .Ed
 271 .El
 272 .Pp
 273 The
 274 .Fn atomic_store
 275 functions are only provided with release memory barriers.
 276 .Sh RETURN VALUES
 277 The
 278 .Fn atomic_cmpset
 279 function
 280 returns the result of the compare operation.
 281 The
 282 .Fn atomic_fetchadd ,
 283 .Fn atomic_load ,
 284 and
 285 .Fn atomic_readandclear
 286 functions
 287 return the value at the specified address.
 288 .\".Sh EXAMPLES
 289 .\"This example uses the
 290 .\".Fn atomic_cmpset_acq_ptr
 291 .\"and
 292 .\".Fn atomic_set_ptr
 293 .\"functions to obtain a sleep mutex and handle recursion.
 294 .\"Since the
 295 .\".Va mtx_lock
 296 .\"member of a
 297 .\".Vt "struct mtx"
 298 .\"is a pointer, the
 299 .\".Dq Li ptr
 300 .\"type is used.
 301 .\".Bd -literal
 302 .\"/* Try to obtain mtx_lock once. */
 303 .\"#define _obtain_lock(mp, tid)                                                \\
 304 .\"     atomic_cmpset_acq_ptr(&(mp)->mtx_lock, MTX_UNOWNED, (tid))
 305 .\"
 306 .\"/* Get a sleep lock, deal with recursion inline. */
 307 .\"#define _get_sleep_lock(mp, tid, opts, file, line) do {                      \\
 308 .\"     uintptr_t _tid = (uintptr_t)(tid);                              \\
 309 .\"                                                                     \\
 310 .\"     if (!_obtain_lock(mp, tid)) {                                   \\
 311 .\"             if (((mp)->mtx_lock & MTX_FLAGMASK) != _tid)            \\
 312 .\"                     _mtx_lock_sleep((mp), _tid, (opts), (file), (line));\\
 313 .\"             else {                                                  \\
 314 .\"                     atomic_set_ptr(&(mp)->mtx_lock, MTX_RECURSE);   \\
 315 .\"                     (mp)->mtx_recurse++;                            \\
 316 .\"             }                                                       \\
 317 .\"     }                                                               \\
 318 .\"} while (0)
 319 .\".Ed
 320 .Sh HISTORY
 321 The
 322 .Fn atomic_add ,
 323 .Fn atomic_clear ,
 324 .Fn atomic_set ,
 325 and
 326 .Fn atomic_subtract
 327 operations were first introduced in
 328 .Fx 3.0 .
 329 This first set only supported the types
 330 .Dq Li char ,
 331 .Dq Li short ,
 332 .Dq Li int ,
 333 and
 334 .Dq Li long .
 335 The
 336 .Fn atomic_cmpset ,
 337 .Fn atomic_load ,
 338 .Fn atomic_readandclear ,
 339 and
 340 .Fn atomic_store
 341 operations were added in
 342 .Fx 5.0 .
 343 The types
 344 .Dq Li 8 ,
 345 .Dq Li 16 ,
 346 .Dq Li 32 ,
 347 .\".Dq Li 64 ,
 348 and
 349 .Dq Li ptr
 350 and all of the acquire and release variants
 351 were added in
 352 .Fx 5.0
 353 as well.
 354 The
 355 .Fn atomic_fetchadd
 356 operations were added in
 357 .Fx 6.0 .