summaryrefslogtreecommitdiff
path: root/static/openbsd/man3/pthread_spin_lock.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
commita9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch)
tree9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man3/pthread_spin_lock.3
parent160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff)
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man3/pthread_spin_lock.3')
-rw-r--r--static/openbsd/man3/pthread_spin_lock.384
1 files changed, 84 insertions, 0 deletions
diff --git a/static/openbsd/man3/pthread_spin_lock.3 b/static/openbsd/man3/pthread_spin_lock.3
new file mode 100644
index 00000000..b62a26aa
--- /dev/null
+++ b/static/openbsd/man3/pthread_spin_lock.3
@@ -0,0 +1,84 @@
+.\" $OpenBSD: pthread_spin_lock.3,v 1.4 2025/06/07 00:16:52 schwarze Exp $
+.\"
+.\" Copyright (c) 2012 Paul Irofti <paul@irofti.net>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.\"
+.Dd $Mdocdate: June 7 2025 $
+.Dt PTHREAD_SPIN_LOCK 3
+.Os
+.Sh NAME
+.Nm pthread_spin_lock ,
+.Nm pthread_spin_trylock
+.Nd lock a spinlock object
+.Sh SYNOPSIS
+.Lb libpthread
+.In pthread.h
+.Ft int
+.Fn pthread_spin_lock "pthread_spinlock_t *lock"
+.Ft int
+.Fn pthread_spin_trylock "pthread_spinlock_t *lock"
+.Sh DESCRIPTION
+The
+.Fn pthread_spin_lock
+function locks the spinlock referenced by
+.Fa lock .
+The calling thread will acquire the lock if it's not owned by another thread.
+Otherwise it will spin until the lock becomes available.
+.Pp
+The
+.Fn pthread_spin_trylock
+function will acquire the lock if the
+.Fa lock
+is not owned by another thread.
+Otherwise it will fail.
+.Sh RETURN VALUES
+If successful,
+.Fn pthread_spin_lock
+and
+.Fn pthread_spin_trylock
+return zero; otherwise an error number is returned to indicate the error.
+.Sh ERRORS
+.Fn pthread_spin_lock
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The value specified by
+.Fa lock
+is invalid.
+.It Bq Er EDEADLK
+A deadlock condition was detected.
+.El
+.Pp
+.Fn pthread_spin_trylock
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The value specified by
+.Fa lock
+is invalid.
+.It Bq Er EBUSY
+The lock is still in use.
+.It Bq Er EDEADLK
+A deadlock condition was detected.
+.El
+.Sh SEE ALSO
+.Xr pthread_spin_init 3 ,
+.Xr pthread_spin_unlock 3
+.Sh STANDARDS
+.Fn pthread_spin_lock
+and
+.Fn pthread_spin_trylock
+conform to
+.St -p1003.1-2008 .