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
25 .\" $FreeBSD: src/share/man/man3/pthread_spin_init.3,v 1.3 2007/10/22 10:08:01 ru Exp $
28 .Dt PTHREAD_SPIN_INIT 3
31 .Nm pthread_spin_init , pthread_spin_destroy
32 .Nd "initialize or destroy a spin lock"
38 .Fn pthread_spin_init "pthread_spinlock_t *lock" "int pshared"
40 .Fn pthread_spin_destroy "pthread_spinlock_t *lock"
44 function will initialize
46 to an unlocked state and
47 allocate any resources necessary to begin using it.
51 .Dv PTHREAD_PROCESS_SHARED ,
53 whether belonging to the process in which the spinlock was created or not,
54 that has access to the memory area where
59 .Dv PTHREAD_PROCESS_PRIVATE ,
60 it can only be used by threads within the same process.
63 .Fn pthread_spin_destroy
66 and release any resources that may have been allocated on its behalf.
72 .Fn pthread_spin_destroy
74 Otherwise, an error number will be returned to indicate the error.
76 Neither of these functions will return
82 .Fn pthread_spin_destroy
83 functions will fail if:
86 An attempt to initialize or destroy
90 The value specified by
97 function will fail if:
100 Insufficient resources,
105 Insufficient memory to initialize
109 .Xr pthread_spin_lock 3 ,
110 .Xr pthread_spin_unlock 3
112 The implementation of
113 .Fn pthread_spin_init
114 does not fully conform to
119 if any value other than
120 .Dv PTHREAD_PROCESS_PRIVATE
121 is specified, it returns