share/man/man3c/pthread_mutex_getprioceiling.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_MUTEX_GETPRIOCEILING 3C "Apr 1, 2008"
  13 .SH NAME
  14 pthread_mutex_getprioceiling, pthread_mutex_setprioceiling \- change priority
  15 ceiling of a mutex
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_mutex_getprioceiling\fR(\fBconst pthread_mutex_t *restrict\fR \fImutex\fR,
  23      \fBint *restrict\fR \fIprioceiling\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_mutex_setprioceiling\fR(\fBpthread_mutex_t *restrict\fR \fImutex\fR,
  29      \fBint\fR \fIprioceiling\fR, \fBint *restrict\fR \fIold_ceiling\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBpthread_mutex_getprioceiling()\fR function returns the current priority
  36 ceiling of the mutex.
  37 .sp
  38 .LP
  39 The \fBpthread_mutex_setprioceiling()\fR function either locks the mutex if it
  40 is unlocked, or blocks until it can successfully lock the mutex, then it
  41 changes the mutex's priority ceiling and releases the mutex. When the change is
  42 successful, the previous value of the priority ceiling is returned in
  43 \fIold_ceiling\fR. The process of locking the mutex need not adhere to the
  44 priority protect protocol.
  45 .sp
  46 .LP
  47 If the \fBpthread_mutex_setprioceiling()\fR function fails, the mutex priority
  48 ceiling is not changed.
  49 .sp
  50 .LP
  51 The ceiling value should be drawn from the range of priorities for the
  52 \fBSCHED_FIFO\fR policy. When a thread acquires such a mutex, the policy of the
  53 thread at mutex acquisition should match that from which the ceiling value was
  54 derived (\fBSCHED_FIFO\fR, in this case).    If a thread changes its scheduling
  55 policy while holding a ceiling mutex, the  behavior of
  56 \fBpthread_mutex_lock()\fR and \fBpthread_mutex_unlock()\fR on this mutex is
  57 undefined. See \fBpthread_mutex_lock\fR(3C).
  58 .sp
  59 .LP
  60 The ceiling value should not be treated as a persistent value resident in a
  61 \fBpthread_mutex_t\fR that is valid across upgrades of Solaris. The semantics
  62 of the actual ceiling value are determined by the existing priority range for
  63 the \fBSCHED_FIFO\fR policy, as returned  by the \fBsched_get_priority_min()\fR
  64 and \fBsched_get_priority_max()\fR functions (see
  65 \fBsched_get_priority_min\fR(3C)) when called on the version of Solaris on
  66 which the ceiling value is being utilized.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Upon successful completion, the \fBpthread_mutex_getprioceiling()\fR and
  71 \fBpthread_mutex_setprioceiling()\fR functions return  \fB0\fR. Otherwise, an
  72 error number is returned to indicate the error.
  73 .SH ERRORS
  74 .sp
  75 .LP
  76 The  \fBpthread_mutex_getprioceiling()\fR and
  77 \fBpthread_mutex_setprioceiling()\fR functions may fail if:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEINVAL\fR\fR
  82 .ad
  83 .RS 10n
  84 The value specified by \fImutex\fR does not refer to a currently existing
  85 mutex.
  86 .RE
  87
  88 .sp
  89 .LP
  90 The \fBpthread_mutex_setprioceiling()\fR function will fail if:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBEINVAL\fR\fR
  95 .ad
  96 .RS 10n
  97 The mutex was not initialized with its \fIprotocol\fR attribute having the
  98 value of \fBPTHREAD_PRIO_PROTECT\fR.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBEINVAL\fR\fR
 105 .ad
 106 .RS 10n
 107 The priority requested by \fIprioceiling\fR is out of range.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEPERM\fR\fR
 114 .ad
 115 .RS 10n
 116 The caller does not have the privilege to perform the operation.
 117 .RE
 118
 119 .SH ATTRIBUTES
 120 .sp
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 Interface Stability     Committed
 133 _
 134 MT-Level        MT-Safe
 135 _
 136 Standard        See \fBstandards\fR(5).
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBpthread_mutex_init\fR(3C), \fBpthread_mutex_lock\fR(3C),
 143 \fBsched_get_priority_min\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)