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
28 .Dt PTHREAD_SPIN_LOCK 3
31 .Nm pthread_spin_lock , pthread_spin_trylock , pthread_spin_unlock
32 .Nd "lock or unlock a spin lock"
39 .Fn pthread_spin_lock "pthread_spinlock_t *lock"
41 .Fn pthread_spin_trylock "pthread_spinlock_t *lock"
43 .Fn pthread_spin_unlock "pthread_spinlock_t *lock"
49 if it is not currently owned by another thread.
50 If the lock cannot be acquired immediately, it will
51 spin attempting to acquire the lock (it will not sleep) until
55 .Fn pthread_spin_trylock
56 function is the same as
58 except that if it cannot acquire
60 immediately it will return with an error.
63 .Fn pthread_spin_unlock
66 which must have been previously locked by a call to
69 .Fn pthread_spin_trylock .
71 If successful, all these functions will return zero.
72 Otherwise, an error number will be returned to indicate the error.
74 None of these functions will return
78 .Fn pthread_spin_lock ,
79 .Fn pthread_spin_trylock
81 .Fn pthread_spin_unlock
82 functions will fail if:
85 The value specified by
87 is invalid or is not initialized.
95 The calling thread already owns the lock.
99 .Fn pthread_spin_trylock
100 function will fail if:
103 Another thread currently holds
108 .Fn pthread_spin_unlock
109 function may fail if:
112 The calling thread does not own
116 .Xr pthread_spin_destroy 3 ,
117 .Xr pthread_spin_init 3
120 .Fn pthread_spin_lock ,
121 .Fn pthread_spin_trylock
123 .Fn pthread_spin_unlock
124 functions first appeared in
133 The implementation of
134 .Fn pthread_spin_lock ,
135 .Fn pthread_spin_trylock
137 .Fn pthread_spin_unlock
138 is expected to conform to