PTHREAD_RWLOCK_RDLOCK(3)   POSIX Programmer's Manual  PTHREAD_RWLOCK_RDLOCK(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_rwlock_rdlock, pthread_rwlock_tryrdlock -- lock a read-write
       lock object for reading

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_rwlock_rdlock(pthread_rwlock_t *_r_w_l_o_c_k);
       int pthread_rwlock_tryrdlock(pthread_rwlock_t *_r_w_l_o_c_k);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function shall apply a read lock to the
       read-write lock referenced by _r_w_l_o_c_k.  The calling thread acquires the
       read lock if a writer does not hold the lock and there are no writers
       blocked on the lock.

       If the Thread Execution Scheduling option is supported, and the threads
       involved in the lock are executing with the scheduling policies
       SCHED_FIFO or SCHED_RR, the calling thread shall not acquire the lock
       if a writer holds the lock or if writers of higher or equal priority
       are blocked on the lock; otherwise, the calling thread shall acquire
       the lock.

       If the Thread Execution Scheduling option is supported, and the threads
       involved in the lock are executing with the SCHED_SPORADIC scheduling
       policy, the calling thread shall not acquire the lock if a writer holds
       the lock or if writers of higher or equal priority are blocked on the
       lock; otherwise, the calling thread shall acquire the lock.

       If the Thread Execution Scheduling option is not supported, it is
       implementation-defined whether the calling thread acquires the lock
       when a writer does not hold the lock and there are writers blocked on
       the lock. If a writer holds the lock, the calling thread shall not
       acquire the read lock. If the read lock is not acquired, the calling
       thread shall block until it can acquire the lock. The calling thread
       may deadlock if at the time the call is made it holds a write lock.

       A thread may hold multiple concurrent read locks on _r_w_l_o_c_k (that is,
       successfully call the _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function _n times). If so,
       the application shall ensure that the thread performs matching unlocks
       (that is, it calls the _p_t_h_r_e_a_d___r_w_l_o_c_k___u_n_l_o_c_k() function _n times).

       The maximum number of simultaneous read locks that an implementation
       guarantees can be applied to a read-write lock shall be implementation-
       defined. The _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function may fail if this maximum
       would be exceeded.

       The _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() function shall apply a read lock as in
       the _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function, with the exception that the
       function shall fail if the equivalent _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() call
       would have blocked the calling thread. In no case shall the
       _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() function ever block; it always either
       acquires the lock or fails and returns immediately.

       Results are undefined if any of these functions are called with an
       uninitialized read-write lock.

       If a signal is delivered to a thread waiting for a read-write lock for
       reading, upon return from the signal handler the thread resumes waiting
       for the read-write lock for reading as if it was not interrupted.

RREETTUURRNN VVAALLUUEE
       If successful, the _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function shall return zero;
       otherwise, an error number shall be returned to indicate the error.

       The _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() function shall return zero if the lock
       for reading on the read-write lock object referenced by _r_w_l_o_c_k is
       acquired. Otherwise, an error number shall be returned to indicate the
       error.

EERRRROORRSS
       The _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() function shall fail if:

       EEBBUUSSYY  The read-write lock could not be acquired for reading because a
              writer holds the lock or a writer with the appropriate priority
              was blocked on it.

       The _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() and _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() functions
       may fail if:

       EEAAGGAAIINN The read lock could not be acquired because the maximum number
              of read locks for _r_w_l_o_c_k has been exceeded.

       The _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() function may fail if:

       EEDDEEAADDLLKK
              A deadlock condition was detected or the current thread already
              owns the read-write lock for writing.

       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 these functions may be subject to priority
       inversion, as discussed in the Base Definitions volume of POSIX.1-2008,
       _S_e_c_t_i_o_n _3_._2_8_7, _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 _r_w_l_o_c_k
       argument to _p_t_h_r_e_a_d___r_w_l_o_c_k___r_d_l_o_c_k() or _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_r_d_l_o_c_k() does
       not refer to an initialized read-write lock object, it is recommended
       that the function should fail and report an [[EEIINNVVAALL]] error.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___r_w_l_o_c_k___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___r_w_l_o_c_k___t_i_m_e_d_r_d_l_o_c_k(),
       _p_t_h_r_e_a_d___r_w_l_o_c_k___t_i_m_e_d_w_r_l_o_c_k(), _p_t_h_r_e_a_d___r_w_l_o_c_k___t_r_y_w_r_l_o_c_k(),
       _p_t_h_r_e_a_d___r_w_l_o_c_k___u_n_l_o_c_k()

       The Base Definitions volume of POSIX.1-2008, _S_e_c_t_i_o_n _3_._2_8_7, _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_1, _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, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/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                  2013             PTHREAD_RWLOCK_RDLOCK(3)
