PTHREAD_BARRIER_DESTROY(3) POSIX Programmer's ManualPTHREAD_BARRIER_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_barrier_destroy, pthread_barrier_init -- destroy and initialize
       a barrier object

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_barrier_destroy(pthread_barrier_t *_b_a_r_r_i_e_r);
       int pthread_barrier_init(pthread_barrier_t *restrict _b_a_r_r_i_e_r,
           const pthread_barrierattr_t *restrict _a_t_t_r, unsigned _c_o_u_n_t);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___b_a_r_r_i_e_r___d_e_s_t_r_o_y() function shall destroy the barrier
       referenced by _b_a_r_r_i_e_r and release any resources used by the barrier.
       The effect of subsequent use of the barrier is undefined until the
       barrier is reinitialized by another call to _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t().  An
       implementation may use this function to set _b_a_r_r_i_e_r to an invalid
       value. The results are undefined if _p_t_h_r_e_a_d___b_a_r_r_i_e_r___d_e_s_t_r_o_y() is called
       when any thread is blocked on the barrier, or if this function is
       called with an uninitialized barrier.

       The _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() function shall allocate any resources
       required to use the barrier referenced by _b_a_r_r_i_e_r and shall initialize
       the barrier with attributes referenced by _a_t_t_r.  If _a_t_t_r is NULL, the
       default barrier attributes shall be used; the effect is the same as
       passing the address of a default barrier attributes object. The results
       are undefined if _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() is called when any thread is
       blocked on the barrier (that is, has not returned from the
       _p_t_h_r_e_a_d___b_a_r_r_i_e_r___w_a_i_t() call). The results are undefined if a barrier is
       used without first being initialized. The results are undefined if
       _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() is called specifying an already initialized
       barrier.

       The _c_o_u_n_t argument specifies the number of threads that must call
       _p_t_h_r_e_a_d___b_a_r_r_i_e_r___w_a_i_t() before any of them successfully return from the
       call. The value specified by _c_o_u_n_t must be greater than zero.

       If the _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() function fails, the barrier shall not be
       initialized and the contents of _b_a_r_r_i_e_r are undefined.

       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.

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

       EEAAGGAAIINN The system lacks the necessary resources to initialize another
              barrier.

       EEIINNVVAALL The value specified by _c_o_u_n_t is equal to zero.

       EENNOOMMEEMM Insufficient memory exists to initialize the barrier.

       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 _b_a_r_r_i_e_r
       argument to _p_t_h_r_e_a_d___b_a_r_r_i_e_r___d_e_s_t_r_o_y() does not refer to an initialized
       barrier object, it is recommended that the function should fail and
       report an [[EEIINNVVAALL]] error.

       If an implementation detects that the value specified by the _a_t_t_r
       argument to _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() does not refer to an initialized
       barrier attributes object, it is recommended that the function should
       fail and report an [[EEIINNVVAALL]] error.

       If an implementation detects that the value specified by the _b_a_r_r_i_e_r
       argument to _p_t_h_r_e_a_d___b_a_r_r_i_e_r___d_e_s_t_r_o_y() or _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() refers
       to a barrier that is in use (for example, in a _p_t_h_r_e_a_d___b_a_r_r_i_e_r___w_a_i_t()
       call) by another thread, or detects that the value specified by the
       _b_a_r_r_i_e_r argument to _p_t_h_r_e_a_d___b_a_r_r_i_e_r___i_n_i_t() refers to an already
       initialized barrier 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___b_a_r_r_i_e_r___w_a_i_t()

       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_BARRIER_DESTROY(3)
