PTHREAD_MUTEXATTR_GETPRIOCEIPLOISNIGX(3P)rogrammer'PsTHMRaEnAuDa_lMUTEXATTR_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_mutexattr_getprioceiling, pthread_mutexattr_setprioceiling --
       get and set the prioceiling attribute of the mutex attributes object
       (RREEAALLTTIIMMEE TTHHRREEAADDSS)

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t
           *restrict _a_t_t_r, int *restrict _p_r_i_o_c_e_i_l_i_n_g);
       int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *_a_t_t_r,
           int _p_r_i_o_c_e_i_l_i_n_g);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___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_a_t_t_r___s_e_t_p_r_i_o_c_e_i_l_i_n_g() functions, respectively, shall get
       and set the priority ceiling attribute of a mutex attributes object
       pointed to by _a_t_t_r which was previously created by the function
       _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___i_n_i_t().

       The _p_r_i_o_c_e_i_l_i_n_g attribute contains the priority ceiling of initialized
       mutexes. The values of _p_r_i_o_c_e_i_l_i_n_g are within the maximum range of
       priorities defined by SCHED_FIFO.

       The _p_r_i_o_c_e_i_l_i_n_g attribute defines the priority ceiling of initialized
       mutexes, which is the minimum priority level at which the critical
       section guarded by the mutex is executed. In order to avoid priority
       inversion, the priority ceiling of the mutex shall be set to a priority
       higher than or equal to the highest priority of all the threads that
       may lock that mutex. The values of _p_r_i_o_c_e_i_l_i_n_g are within the maximum
       range of priorities defined under the SCHED_FIFO scheduling policy.

       The behavior is undefined if the value specified by the _a_t_t_r argument
       to _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_r_i_o_c_e_i_l_i_n_g() or
       _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_r_i_o_c_e_i_l_i_n_g() does not refer to an initialized
       mutex attributes object.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, the _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___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_a_t_t_r___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 may fail if:

       EEIINNVVAALL The value specified by _p_r_i_o_c_e_i_l_i_n_g is invalid.

       EEPPEERRMM  The caller does not have the privilege to perform the operation.

       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 _a_t_t_r
       argument to _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_r_i_o_c_e_i_l_i_n_g() or
       _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_r_i_o_c_e_i_l_i_n_g() does not refer to an initialized
       mutex attributes 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___c_o_n_d___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___c_r_e_a_t_e(), _p_t_h_r_e_a_d___m_u_t_e_x___d_e_s_t_r_o_y()

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