lib/libpthread/pthread_spin_unlock.3

   1 .\" $NetBSD: pthread_spin_unlock.3,v 1.7 2008/05/26 00:31:08 ad Exp $
   2 .\"
   3 .\" Copyright (c) 2002, 2008 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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 the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .Dd May 26, 2008
  26 .Dt PTHREAD_SPIN_UNLOCK 3
  27 .Os
  28 .Sh NAME
  29 .Nm pthread_spin_unlock
  30 .Nd release a spin lock
  31 .Sh LIBRARY
  32 .Lb libpthread
  33 .Sh SYNOPSIS
  34 .In pthread.h
  35 .Ft int
  36 .Fn pthread_spin_unlock "pthread_spinlock_t *lock"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn pthread_spin_unlock
  40 function is used to release the read/write lock previously obtained by
  41 .Fn pthread_spin_lock
  42 or
  43 .Fn pthread_spin_trylock .
  44 .Sh RETURN VALUES
  45 If successful, the
  46 .Fn pthread_spin_unlock
  47 function will return zero.
  48 Otherwise an error number will be returned to indicate the error.
  49 .Pp
  50 The results are undefined if
  51 .Fa lock
  52 is not held by the calling thread.
  53 .Sh ERRORS
  54 The
  55 .Fn pthread_spin_unlock
  56 function may fail if:
  57 .Bl -tag -width Er
  58 .It Bq Er EINVAL
  59 The value specified by
  60 .Fa lock
  61 is invalid.
  62 .El
  63 .Sh SEE ALSO
  64 .Xr pthread_spin_destroy 3 ,
  65 .Xr pthread_spin_init 3 ,
  66 .Xr pthread_spin_lock 3 ,
  67 .Xr pthread_spin_trylock 3
  68 .Sh STANDARDS
  69 .Fn pthread_rwlock_unlock
  70 conforms to
  71 .St -p1003.1-2001 .
  72 .Sh CAVEATS
  73 Applications using spinlocks are vulnerable to the effects of priority
  74 inversion.
  75 Applications using real-time threads
  76 .Pq Dv SCHED_FIFO , SCHED_RR
  77 should not use these interfaces.
  78 Outside carefully controlled environments, priority inversion with spinlocks
  79 can lead to system deadlock.
  80 Mutexes are preferable in nearly every possible use case.