198 lines
4.5 KiB
HTML
198 lines
4.5 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PTHREAD_SPIN_LOCK</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PTHREAD_SPIN_LOCK</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-30<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
pthread_spin_lock, pthread_spin_trylock, pthread_spin_unlock -
|
|
lock and unlock a spin lock
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/pthread.h">pthread.h</A>></B>
|
|
|
|
<B>int pthread_spin_lock(pthread_spinlock_t *</B><I>lock</I><B>);</B>
|
|
<B>int pthread_spin_trylock(pthread_spinlock_t *</B><I>lock</I><B>);</B>
|
|
<B>int pthread_spin_unlock(pthread_spinlock_t *</B><I>lock</I><B>);</B>
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
Compile and link with <I>-pthread</I>.
|
|
<P>
|
|
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
|
|
|
|
|
|
<P>
|
|
|
|
<B>pthread_spin_lock</B>(),
|
|
|
|
<B>pthread_spin_trylock</B>():
|
|
|
|
<BR>
|
|
|
|
<DL COMPACT><DT id="1"><DD>
|
|
|
|
_POSIX_C_SOURCE >= 200112L
|
|
</DL>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>pthread_spin_lock</B>()
|
|
|
|
function locks the spin lock referred to by
|
|
<I>lock</I>.
|
|
|
|
If the spin lock is currently unlocked,
|
|
the calling thread acquires the lock immediately.
|
|
If the spin lock is currently locked by another thread,
|
|
the calling thread spins, testing the lock until it becomes available,
|
|
at which point the calling thread acquires the lock.
|
|
<P>
|
|
|
|
Calling
|
|
<B>pthread_spin_lock</B>()
|
|
|
|
on a lock that is already held by the caller
|
|
or a lock that has not been initialized with
|
|
<B><A HREF="/cgi-bin/man/man2html?3+pthread_spin_init">pthread_spin_init</A></B>(3)
|
|
|
|
results in undefined behavior.
|
|
<P>
|
|
|
|
The
|
|
<B>pthread_spin_trylock</B>()
|
|
|
|
function is like
|
|
<B>pthread_spin_lock</B>(),
|
|
|
|
except that if the spin lock referred to by
|
|
<I>lock</I>
|
|
|
|
is currently locked,
|
|
then, instead of spinning, the call returns immediately with the error
|
|
<B>EBUSY</B>.
|
|
|
|
<P>
|
|
|
|
The
|
|
<B>pthread_spin_unlock</B>()
|
|
|
|
function unlocks the spin lock referred to
|
|
<I>lock</I>.
|
|
|
|
If any threads are spinning on the lock,
|
|
one of those threads will then acquire the lock.
|
|
<P>
|
|
|
|
Calling
|
|
<B>pthread_spin_unlock</B>()
|
|
|
|
on a lock that is not held by the caller results in undefined behavior.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
On success, these functions return zero.
|
|
On failure, they return an error number.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
<B>pthread_spin_lock</B>()
|
|
|
|
may fail with the following errors:
|
|
<DL COMPACT>
|
|
<DT id="2"><B>EDEADLOCK</B>
|
|
|
|
<DD>
|
|
|
|
The system detected a deadlock condition.
|
|
</DL>
|
|
<P>
|
|
|
|
<B>pthread_spin_trylock</B>()
|
|
|
|
fails with the following errors:
|
|
<DL COMPACT>
|
|
<DT id="3"><B>EBUSY</B>
|
|
|
|
<DD>
|
|
The spin lock is currently locked by another thread.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>VERSIONS</H2>
|
|
|
|
These functions first appeared in glibc in version 2.2.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
Applying any of the functions described on this page to
|
|
an uninitialized spin lock results in undefined behavior.
|
|
<P>
|
|
|
|
Carefully read NOTES in
|
|
<B><A HREF="/cgi-bin/man/man2html?3+pthread_spin_init">pthread_spin_init</A></B>(3).
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+pthread_spin_destroy">pthread_spin_destroy</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+pthread_spin_init">pthread_spin_init</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+pthreads">pthreads</A></B>(7)
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="7"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="8"><A HREF="#lbAF">ERRORS</A><DD>
|
|
<DT id="9"><A HREF="#lbAG">VERSIONS</A><DD>
|
|
<DT id="10"><A HREF="#lbAH">CONFORMING TO</A><DD>
|
|
<DT id="11"><A HREF="#lbAI">NOTES</A><DD>
|
|
<DT id="12"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="13"><A HREF="#lbAK">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:53 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|