1 .\" Copyright (c) 2004 Michael Telahun Makonnen
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .Dt PTHREAD_SPIN_LOCK 3
29 .Nm pthread_spin_lock , pthread_spin_trylock , pthread_spin_unlock
30 .Nd "lock or unlock a spin lock"
36 .Fn pthread_spin_lock "pthread_spinlock_t *lock"
38 .Fn pthread_spin_trylock "pthread_spinlock_t *lock"
40 .Fn pthread_spin_unlock "pthread_spinlock_t *lock"
46 if it is not currently owned by another thread.
47 If the lock cannot be acquired immediately, it will
48 spin attempting to acquire the lock (it will not sleep) until
52 .Fn pthread_spin_trylock
53 function is the same as
55 except that if it cannot acquire
57 immediately it will return with an error.
60 .Fn pthread_spin_unlock
63 which must have been previously locked by a call to
66 .Fn pthread_spin_trylock .
68 If successful, all these functions will return zero.
69 Otherwise, an error number will be returned to indicate the error.
71 None of these functions will return
75 .Fn pthread_spin_lock ,
76 .Fn pthread_spin_trylock
78 .Fn pthread_spin_unlock
79 functions will fail if:
82 The value specified by
84 is invalid or is not initialized.
92 The calling thread already owns the lock.
96 .Fn pthread_spin_trylock
97 function will fail if:
100 Another thread currently holds
105 .Fn pthread_spin_unlock
106 function may fail if:
109 The calling thread does not own
113 .Xr pthread_spin_destroy 3 ,
114 .Xr pthread_spin_init 3
117 .Fn pthread_spin_lock ,
118 .Fn pthread_spin_trylock
120 .Fn pthread_spin_unlock
121 functions first appeared in
130 The implementation of
131 .Fn pthread_spin_lock ,
132 .Fn pthread_spin_trylock
134 .Fn pthread_spin_unlock
135 is expected to conform to