pthread_spin_lock(3) — Linux manual page

pthread_spin_lock(3)    Library Functions Manual    pthread_spin_lock(3)

NAME

       pthread_spin_lock, pthread_spin_trylock, pthread_spin_unlock -
       lock and unlock a spin lock

LIBRARY

       POSIX threads library (libpthread, -lpthread)

SYNOPSIS

       #include <pthread.h>

       int pthread_spin_lock(pthread_spinlock_t *lock);
       int pthread_spin_trylock(pthread_spinlock_t *lock);
       int pthread_spin_unlock(pthread_spinlock_t *lock);

   Feature Test Macro Requirements for glibc (see
   feature_test_macros(7)):

       pthread_spin_lock(), pthread_spin_trylock():
           _POSIX_C_SOURCE >= 200112L

DESCRIPTION

       The pthread_spin_lock() function locks the spin lock referred to
       by lock.  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.

       Calling pthread_spin_lock() on a lock that is already held by the
       caller or a lock that has not been initialized with
       pthread_spin_init(3) results in undefined behavior.

       The pthread_spin_trylock() function is like pthread_spin_lock(),
       except that if the spin lock referred to by lock is currently
       locked, then, instead of spinning, the call returns immediately
       with the error EBUSY.

       The pthread_spin_unlock() function unlocks the spin lock referred
       to lock.  If any threads are spinning on the lock, one of those
       threads will then acquire the lock.

       Calling pthread_spin_unlock() on a lock that is not held by the
       caller results in undefined behavior.

RETURN VALUE

       On success, these functions return zero.  On failure, they return
       an error number.

ERRORS

       pthread_spin_lock() may fail with the following errors:

       EDEADLOCK
              The system detected a deadlock condition.

       pthread_spin_trylock() fails with the following errors:

       EBUSY  The spin lock is currently locked by another thread.

STANDARDS

       POSIX.1-2008.

HISTORY

       glibc 2.2.  POSIX.1-2001.

CAVEATS

       Applying any of the functions described on this page to an
       uninitialized spin lock results in undefined behavior.

       Carefully read NOTES in pthread_spin_init(3).

SEE ALSO

       pthread_spin_destroy(3), pthread_spin_init(3), pthreads(7)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02           pthread_spin_lock(3)

Pages that refer to this page: pthread_spin_init(3), pthreads(7)

---