PTHREAD_MUTEX_GETPRIOCEILINGP(O3S)IX Programmer's MaPnTuHaRlEAD_MUTEX_GETPRIOCEILING(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_mutex_getprioceiling, pthread_mutex_setprioceiling -- get and
       set the priority ceiling of a mutex (RREEAALLTTIIMMEE TTHHRREEAADDSS)

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_mutex_getprioceiling(const pthread_mutex_t *restrict _m_u_t_e_x,
           int *restrict _p_r_i_o_c_e_i_l_i_n_g);
       int pthread_mutex_setprioceiling(pthread_mutex_t *restrict _m_u_t_e_x,
           int _p_r_i_o_c_e_i_l_i_n_g, int *restrict _o_l_d___c_e_i_l_i_n_g);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___m_u_t_e_x___g_e_t_p_r_i_o_c_e_i_l_i_n_g() function shall return the current
       priority ceiling of the mutex.

       The _p_t_h_r_e_a_d___m_u_t_e_x___s_e_t_p_r_i_o_c_e_i_l_i_n_g() function shall attempt to lock the
       mutex as if by a call to _p_t_h_r_e_a_d___m_u_t_e_x___l_o_c_k(), except that the process
       of locking the mutex need not adhere to the priority protect protocol.
       On acquiring the mutex it shall change the mutex's priority ceiling and
       then release the mutex as if by a call to _p_t_h_r_e_a_d___m_u_t_e_x___u_n_l_o_c_k().  When
       the change is successful, the previous value of the priority ceiling
       shall be returned in _o_l_d___c_e_i_l_i_n_g.

       If the _p_t_h_r_e_a_d___m_u_t_e_x___s_e_t_p_r_i_o_c_e_i_l_i_n_g() function fails, the mutex
       priority ceiling shall not be changed.

RREETTUURRNN VVAALLUUEE
       If successful, the _p_t_h_r_e_a_d___m_u_t_e_x___g_e_t_p_r_i_o_c_e_i_l_i_n_g() and
       _p_t_h_r_e_a_d___m_u_t_e_x___s_e_t_p_r_i_o_c_e_i_l_i_n_g() functions shall return zero; otherwise,
       an error number shall be returned to indicate the error.

EERRRROORRSS
       These functions shall fail if:

       EEIINNVVAALL The protocol attribute of _m_u_t_e_x is PTHREAD_PRIO_NONE.

       EEPPEERRMM  The implementation requires appropriate privileges to perform
              the operation and the caller does not have appropriate
              privileges.

       The _p_t_h_r_e_a_d___m_u_t_e_x___s_e_t_p_r_i_o_c_e_i_l_i_n_g() function shall fail if:

       EEAAGGAAIINN The mutex could not be acquired because the maximum number of
              recursive locks for _m_u_t_e_x has been exceeded.

       EEDDEEAADDLLKK
              The mutex type is PTHREAD_MUTEX_ERRORCHECK and the current
              thread already owns the mutex.

       EEIINNVVAALL The mutex was created with the protocol attribute having the
              value PTHREAD_PRIO_PROTECT and the calling thread's priority is
              higher than the mutex's current priority ceiling, and the
              implementation adheres to the priority protect protocol in the
              process of locking the mutex.

       EENNOOTTRREECCOOVVEERRAABBLLEE
              The mutex is a robust mutex and the state protected by the mutex
              is not recoverable.

       EEOOWWNNEERRDDEEAADD
              The mutex is a robust mutex and the process containing the
              previous owning thread terminated while holding the mutex lock.
              The mutex lock shall be acquired by the calling thread and it is
              up to the new owner to make the state consistent (see
              _p_t_h_r_e_a_d___m_u_t_e_x___l_o_c_k()).

       The _p_t_h_r_e_a_d___m_u_t_e_x___s_e_t_p_r_i_o_c_e_i_l_i_n_g() function may fail if:

       EEDDEEAADDLLKK
              A deadlock condition was detected.

       EEIINNVVAALL The priority requested by _p_r_i_o_c_e_i_l_i_n_g is out of range.

       EEOOWWNNEERRDDEEAADD
              The mutex is a robust mutex and the previous owning thread
              terminated while holding the mutex lock. The mutex lock shall be
              acquired by the calling thread and it is up to the new owner to
              make the state consistent (see _p_t_h_r_e_a_d___m_u_t_e_x___l_o_c_k()).

       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
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___m_u_t_e_x___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___m_u_t_e_x___l_o_c_k(),
       _p_t_h_r_e_a_d___m_u_t_e_x___t_i_m_e_d_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_MUTEX_GETPRIOCEILING(3)
