PTHREAD_SPIN_DESTROY(3)    POSIX Programmer's Manual   PTHREAD_SPIN_DESTROY(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_destroy, pthread_spin_init -- destroy or initialize a spin
       lock object

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_spin_destroy(pthread_spinlock_t *_l_o_c_k);
       int pthread_spin_init(pthread_spinlock_t *_l_o_c_k, int _p_s_h_a_r_e_d);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___s_p_i_n___d_e_s_t_r_o_y() function shall destroy the spin lock
       referenced by _l_o_c_k and release any resources used by the lock. The
       effect of subsequent use of the lock is undefined until the lock is
       reinitialized by another call to _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t().  The results are
       undefined if _p_t_h_r_e_a_d___s_p_i_n___d_e_s_t_r_o_y() is called when a thread holds the
       lock, or if this function is called with an uninitialized thread spin
       lock.

       The _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t() function shall allocate any resources required
       to use the spin lock referenced by _l_o_c_k and initialize the lock to an
       unlocked state.

       If the Thread Process-Shared Synchronization option is supported and
       the value of _p_s_h_a_r_e_d is PTHREAD_PROCESS_SHARED, the implementation
       shall permit the spin lock to be operated upon by any thread that has
       access to the memory where the spin lock is allocated, even if it is
       allocated in memory that is shared by multiple processes.

       See _S_e_c_t_i_o_n _2_._9_._9, _S_y_n_c_h_r_o_n_i_z_a_t_i_o_n _O_b_j_e_c_t _C_o_p_i_e_s _a_n_d _A_l_t_e_r_n_a_t_i_v_e
       _M_a_p_p_i_n_g_s for further requirements.

       The results are undefined if _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t() is called specifying
       an already initialized spin lock. The results are undefined if a spin
       lock is used without first being initialized.

       If the _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t() function fails, the lock is not initialized
       and the contents of _l_o_c_k are undefined.

       Only the object referenced by _l_o_c_k may be used for performing
       synchronization.

       The result of referring to copies of that object in calls to
       _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___l_o_c_k(), _p_t_h_r_e_a_d___s_p_i_n___t_r_y_l_o_c_k(), or
       _p_t_h_r_e_a_d___s_p_i_n___u_n_l_o_c_k() is undefined.

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___i_n_i_t() function shall fail if:

       EEAAGGAAIINN The system lacks the necessary resources to initialize another
              spin lock.

       EENNOOMMEEMM Insufficient memory exists to initialize 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
       None.

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___d_e_s_t_r_o_y() 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___d_e_s_t_r_o_y() or _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t() refers to a
       locked spin lock object, or detects that the value specified by the
       _l_o_c_k argument to _p_t_h_r_e_a_d___s_p_i_n___i_n_i_t() refers to an already initialized
       spin lock object, it is recommended that the function should fail and
       report an [[EEBBUUSSYY]] error.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___s_p_i_n___l_o_c_k(), _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, <<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_DESTROY(3)
