PTHREAD_SPIN_LOCK(3)       POSIX Programmer's Manual      PTHREAD_SPIN_LOCK(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       pthread_spin_lock, pthread_spin_trylock -- lock a spin lock object

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_spin_lock(pthread_spinlock_t *_l_o_c_k);
       int pthread_spin_trylock(pthread_spinlock_t *_l_o_c_k);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k() function shall lock the spin lock referenced by
       _l_o_c_k.  The calling thread shall acquire the lock if it is not held by
       another thread. Otherwise, the thread shall spin (that is, shall not
       return from the _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k() call) until the lock becomes
       available. The results are undefined if the calling thread holds the
       lock at the time the call is made. The _p_t_h_r_e_a_d___s_p_i_n___t_r_y_l_o_c_k() function
       shall lock the spin lock referenced by _l_o_c_k if it is not held by any
       thread. Otherwise, the function shall fail.

       The results are undefined if any of these functions is called with an
       uninitialized spin lock.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, these functions shall return zero;
       otherwise, an error number shall be returned to indicate the error.

EERRRROORRSS
       The _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k() function may fail if:

       EEDDEEAADDLLKK
              A deadlock condition was detected.

       The _p_t_h_r_e_a_d___s_p_i_n___t_r_y_l_o_c_k() function shall fail if:

       EEBBUUSSYY  A thread currently holds the lock.

       These functions shall not return an error code of [[EEIINNTTRR]].

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       Applications using this function may be subject to priority inversion,
       as discussed in the Base Definitions volume of POSIX.1-2017, _S_e_c_t_i_o_n
       _3_._2_9_1, _P_r_i_o_r_i_t_y _I_n_v_e_r_s_i_o_n.

RRAATTIIOONNAALLEE
       If an implementation detects that the value specified by the _l_o_c_k
       argument to _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k() or _p_t_h_r_e_a_d___s_p_i_n___t_r_y_l_o_c_k() does not
       refer to an initialized spin lock object, it is recommended that the
       function should fail and report an [[EEIINNVVAALL]] error.

       If an implementation detects that the value specified by the _l_o_c_k
       argument to _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k() refers to a spin lock object for which
       the calling thread already holds the lock, it is recommended that the
       function should fail and report an [[EEDDEEAADDLLKK]] error.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___s_p_i_n___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___s_p_i_n___u_n_l_o_c_k()

       The Base Definitions volume of POSIX.1-2017, _S_e_c_t_i_o_n _3_._2_9_1, _P_r_i_o_r_i_t_y
       _I_n_v_e_r_s_i_o_n, _S_e_c_t_i_o_n _4_._1_2, _M_e_m_o_r_y _S_y_n_c_h_r_o_n_i_z_a_t_i_o_n, <<pptthhrreeaadd..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                 PTHREAD_SPIN_LOCK(3)
