1.\"	$OpenBSD: pthread_spin_unlock.3,v 1.2 2013/06/05 03:44:50 tedu Exp $
2.\"
3.\" Copyright (c) 2012 Paul Irofti <pirofti@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\"
18.Dd $Mdocdate: June 5 2013 $
19.Dt PTHREAD_SPIN_UNLOCK 3
20.Os
21.Sh NAME
22.Nm pthread_spin_unlock
23.Nd unlock a spinlock object
24.Sh SYNOPSIS
25.In pthread.h
26.Ft int
27.Fn pthread_spin_unlock "pthread_spinlock_t *lock"
28.Sh DESCRIPTION
29The
30.Fn pthread_spin_unlock
31function releases the spin lock referenced by
32.Fa lock
33which was locked via the
34.Fn pthread_spin_lock
35or
36.Fn pthread_spin_trylock
37functions.
38.Sh RETURN VALUES
39If successful,
40.Fn pthread_spin_unlock
41returns zero; otherwise an error number is returned to indicate the error.
42.Sh ERRORS
43.Fn pthread_spin_unlock
44will fail if:
45.Bl -tag -width Er
46.It Bq Er EINVAL
47The value specified by
48.Fa lock
49is invalid.
50.It Bq Er EPERM
51The lock is not owned by the calling thread.
52.El
53.Sh SEE ALSO
54.Xr pthread_spin_init 3 ,
55.Xr pthread_spin_lock 3
56.Sh STANDARDS
57.Fn pthread_spin_unlock
58conforms to
59.St -p1003.1-2008 .
60