lib/libc/sys/umtx.2

   1 .\" Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   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 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .Dd January 15, 2015
  34 .Dt UMTX 2
  35 .Os
  36 .Sh NAME
  37 .Nm umtx_sleep ,
  38 .Nm umtx_wakeup
  39 .Nd kernel support for userland mutexes
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In unistd.h
  44 .Ft int
  45 .Fn umtx_sleep "volatile const int *ptr" "int value" "int timeout"
  46 .Ft int
  47 .Fn umtx_wakeup "volatile const int *ptr" "int count"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn umtx_sleep
  51 system call will put the calling process to sleep for
  52 .Fa timeout
  53 microseconds if the contents of the specified pointer matches
  54 the specified value.
  55 Specifying a timeout of 0 indicates an indefinite timeout.
  56 The comparison is not atomic with the sleep but is properly
  57 interlocked against another process calling
  58 .Fn umtx_wakeup .
  59 In particular, while it is possible for two userland threads to race, one
  60 going to sleep simultaneously with another releasing the mutex, this condition
  61 is caught when the second userland thread calls
  62 .Fn umtx_wakeup
  63 after releasing the contended mutex.
  64 .Pp
  65 The
  66 .Fa timeout
  67 has no specific limitation other than what fits in the signed integer.
  68 A negative timeout will return
  69 .Er EINVAL .
  70 .Pp
  71 WARNING! In order to properly interlock against
  72 .Fn fork ,
  73 this function will
  74 do an atomic read-modify-write on the underlying memory by atomically
  75 adding the value 0 to it.
  76 .Pp
  77 The
  78 .Fn umtx_wakeup
  79 system call will wakeup the specified number of processes sleeping
  80 in
  81 .Fn umtx_sleep
  82 on the specified user address.
  83 A count of 0 will wake up all sleeping processes.
  84 This function may wake up more processes then the specified
  85 count but will never wake up fewer processes (unless there are simply not
  86 that many currently sleeping on the address).
  87 The current
  88 .Dx
  89 implementation optimized the count = 1 case but otherwise just wakes up
  90 all processes sleeping on the address.
  91 .Pp
  92 Kernel support for userland mutexes is based on the physical memory backing
  93 the user address.
  94 That is, the kernel will typically construct a sleep id based on the
  95 underlying physical memory address.
  96 Two userland programs may use this facility through
  97 .Fn mmap ,
  98 .Fn sysv ,
  99 .Fn rfork ,
 100 or light weight process-based shared memory.
 101 It is important to note that the kernel does not
 102 take responsibility for adjusting the contents of the mutex or for the
 103 userland implementation of the mutex.
 104 .Pp
 105 .Fn umtx_sleep
 106 does not restart in case of a signal, even if the signal specifies
 107 that system calls should restart.
 108 .Pp
 109 Various operating system events can cause
 110 .Fn umtx_sleep
 111 to return prematurely, with the contents of the mutex unchanged relative
 112 to the compare value.
 113 Callers must be able to deal with such returns.
 114 .Sh RETURN VALUES
 115 .Fn umtx_sleep
 116 will return 0 if it successfully slept and was then woken up.
 117 Otherwise it will return -1 and set
 118 .Va errno
 119 as shown below.
 120 .Pp
 121 .Fn umtx_wakeup
 122 will generally return 0 unless the address is bad.
 123 .Sh EXAMPLES
 124 .Bd -literal -compact
 125
 126 void
 127 userland_get_mutex(struct umtx *mtx)
 128 {
 129         int v;
 130
 131         v = mtx->lock;
 132         for (;;) {
 133                 if (v == 0) {
 134                         if (atomic_fcmpset_int(&mtx->lock, &v, 1))
 135                                 break;
 136                 } else if (atomic_fcmpset_int(&mtx->lock, &v, 2)) {
 137                         umtx_sleep(&mtx->lock, 2, 0);
 138                 }
 139         }
 140 }
 141
 142 void
 143 userland_rel_mutex(struct umtx *mtx)
 144 {
 145     int v;
 146
 147     v = atomic_swap_int(&mtx->lock, 0);
 148     if (v == 2)
 149             umtx_wakeup(&mtx->lock, 1);
 150 }
 151 .Ed
 152 .Sh WARNINGS
 153 This function can return -1 with errno set to
 154 .Er EWOULDBLOCK
 155 early and even if no timeout is specified due to the kernel failsafe
 156 timeout activating.
 157 The caller is advised to track the timeout independently using
 158 .Fn clock_gettime .
 159 .Pp
 160 This function can return -1 with errno set to
 161 .Er EINTR
 162 and it is up to the caller to loop if the caller's own API disallows
 163 returning
 164 .Er EINTR .
 165 .Pp
 166 This function can also return -1 with errno set to
 167 .Er EBUSY
 168 due to internal kernel effects.
 169 .Pp
 170 This function can return without error when woken up via internal
 171 kernel effects and not necessarily just by a
 172 .Fn umtx_wakeup
 173 call.
 174 .Pp
 175 Because the kernel will always use the underlying physical address
 176 for its tsleep/wakeup id (e.g. which is required to properly supported
 177 memory-mapped locks shared between processes), certain actions taken by
 178 the program and/or by the kernel can disrupt synchronization between
 179 .Fn umtx_sleep
 180 and
 181 .Fn umtx_wakeup .
 182 The kernel is responsible for handling
 183 .Fn fork
 184 actions, and will typically wakeup all blocked
 185 .Fn umtx_sleep
 186 for all threads of a process upon any thread forking.
 187 However, other actions such as pagein and pageout can also desynchronize
 188 sleeps and wakeups.
 189 To deal with these actions, the kernel typically implements a failsafe
 190 timeout of around 2 seconds for
 191 .Fn umtx_sleep .
 192 To properly resynchronize the physical address, ALL threads blocking on
 193 the address should perform a modifying operation on the underlying memory
 194 before re-entering the wait state,
 195 or otherwise be willing to incur the failsafe timeout as their recovery
 196 mechanism.
 197 .Sh ERRORS
 198 .Bl -tag -width Er
 199 .It Bq Er EBUSY
 200 The contents of
 201 .Fa *ptr
 202 possibly did not match
 203 .Fa value
 204 .It Bq Er EWOULDBLOCK
 205 The specified timeout occurred,
 206 or a kernel-defined failsafe timeout occurred,
 207 or the kernel requires a retry due to a copy-on-write / fork operation.
 208 Callers should not assume that the precise requested timeout occurred
 209 when this error is returned, and this error can be returned even
 210 when no timeout is specified.
 211 .It Bq Er EINTR
 212 The
 213 .Fn umtx_sleep
 214 call was interrupted by a signal.
 215 .It Bq Er EINVAL
 216 An invalid parameter (typically an invalid timeout) was specified.
 217 .El
 218 .Sh SEE ALSO
 219 .Xr tls 2
 220 .Sh HISTORY
 221 The
 222 .Fn umtx_sleep ,
 223 and
 224 .Fn umtx_wakeup
 225 function calls first appeared in
 226 .Dx 1.1 .