Sync usage with man page.
[netbsd-mini2440.git] / lib / libpthread / pthread_spin_destroy.3
blob3131fd9b02d9cdd215ded56306d1365d31f0da48
1 .\" $NetBSD: pthread_spin_destroy.3,v 1.5 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_DESTROY 3
27 .Os
28 .Sh NAME
29 .Nm pthread_spin_destroy
30 .Nd destroy a spin lock
31 .Sh LIBRARY
32 .Lb libpthread
33 .Sh SYNOPSIS
34 .In pthread.h
35 .Ft int
36 .Fn pthread_spin_destroy "pthread_spinlock_t *lock"
37 .Sh DESCRIPTION
38 The
39 .Fn pthread_spin_destroy
40 function is used to destroy a spin lock previously created with
41 .Fn pthread_spin_init .
42 .Sh RETURN VALUES
43 If successful, the
44 .Fn pthread_spin_destroy
45 function will return zero.
46 Otherwise an error number will be returned to indicate the error.
47 .Sh ERRORS
48 The
49 .Fn pthread_spin_destroy
50 function may fail if:
51 .Bl -tag -width Er
52 .It Bq Er EBUSY
53 The system has detected an attempt to destroy the object referenced by
54 .Fa lock
55 while it is locked.
56 .It Bq Er EINVAL
57 The value specified by
58 .Fa lock
59 is invalid.
60 .El
61 .Sh SEE ALSO
62 .Xr pthread_spin_init 3 ,
63 .Xr pthread_spin_lock 3 ,
64 .Xr pthread_spin_trylock 3 ,
65 .Xr pthread_spin_unlock 3
66 .Sh STANDARDS
67 .Fn pthread_spin_destroy
68 conforms to
69 .St -p1003.1-2001 .
70 .Sh CAVEATS
71 Applications using spinlocks are vulnerable to the effects of priority
72 inversion.
73 Applications using real-time threads
74 .Pq Dv SCHED_FIFO , SCHED_RR
75 should not use these interfaces.
76 Outside carefully controlled environments, priority inversion with spinlocks
77 can lead to system deadlock.
78 Mutexes are preferable in nearly every possible use case.