lib/libpthread/pthread_spin_init.3

   1 .\" $NetBSD: pthread_spin_init.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_INIT 3
  27 .Os
  28 .Sh NAME
  29 .Nm pthread_spin_init
  30 .Nd initialize a spin lock
  31 .Sh LIBRARY
  32 .Lb libpthread
  33 .Sh SYNOPSIS
  34 .In pthread.h
  35 .Ft int
  36 .Fn pthread_spin_init "pthread_spinlock_t *lock" "int pshared"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn pthread_spin_init
  40 function is used to initialize a spinlock.
  41 The
  42 .Fa pshared
  43 parameter is currently unused and all spinlocks exhibit the
  44 .Dv PTHREAD_PROCESS_SHARED
  45 property.
  46 .Pp
  47 The results of calling
  48 .Fn pthread_spin_init
  49 with an already initialized lock are undefined.
  50 .Sh RETURN VALUES
  51 If successful, the
  52 .Fn pthread_spin_init
  53 function will return zero.
  54 Otherwise an error number will be returned to indicate the error.
  55 .Sh ERRORS
  56 The
  57 .Fn pthread_spin_init
  58 function shall fail if:
  59 .Bl -tag -width Er
  60 .It Bq Er ENOMEM
  61 Insufficient memory exists to initialize the lock.
  62 .El
  63 .Pp
  64 The
  65 .Fn pthread_spin_init
  66 function may fail if:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 The
  70 .Fa lock
  71 parameter was NULL or the
  72 .Fa pshared
  73 parameter was neither
  74 .Dv PTHREAD_PROCESS_SHARED
  75 nor
  76 .Dv PTHREAD_PROCESS_PRIVATE .
  77 .El
  78 .Sh SEE ALSO
  79 .Xr pthread_spin_destroy 3 ,
  80 .Xr pthread_spin_lock 3 ,
  81 .Xr pthread_spin_trylock 3 ,
  82 .Xr pthread_spin_unlock 3
  83 .Sh STANDARDS
  84 .Fn pthread_spin_init
  85 conforms to
  86 .St -p1003.1-2001 .
  87 .Sh CAVEATS
  88 Applications using spinlocks are vulnerable to the effects of priority
  89 inversion.
  90 Applications using real-time threads
  91 .Pq Dv SCHED_FIFO , SCHED_RR
  92 should not use these interfaces.
  93 Outside carefully controlled environments, priority inversion with spinlocks
  94 can lead to system deadlock.
  95 Mutexes are preferable in nearly every possible use case.