te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
Copyright 1991, 1992, 1994, The X/Open Company Ltd.
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
pthread_mutexattr_getprotocol, pthread_mutexattr_setprotocol - get or set protocol attribute of mutex attribute object

cc -mt [ flag... ] file... -lpthread [ library... ]
#include <pthread.h> 

int pthread_mutexattr_getprotocol(
 const pthread_mutexattr_t *restrict attr,
 int *restrict protocol);

int pthread_mutexattr_setprotocol(pthread_mutexattr_t *attr,
 int protocol);

The pthread_mutexattr_setprotocol() and pthread_mutexattr_getprotocol() functions, respectively, set and get the protocol attribute of a mutex attribute object pointed to by attr, which was previously created by the pthread_mutexattr_init() function.

The protocol attribute defines the protocol to be followed in utilizing mutexes. The value of protocol may be one of PTHREAD_PRIO_NONE, PTHREAD_PRIO_INHERIT, or PTHREAD_PRIO_PROTECT, which are defined by the header <pthread.h>.

When a thread owns a mutex with the PTHREAD_PRIO_NONE protocol attribute, its priority and scheduling are not affected by its mutex ownership.

When a thread is blocking higher priority threads because of owning one or more mutexes with the PTHREAD_PRIO_INHERIT protocol attribute, it executes at the higher of its priority or the priority of the highest priority thread waiting on any of the mutexes owned by this thread and initialized with this protocol.

When a thread owns one or more mutexes initialized with the PTHREAD_PRIO_PROTECT protocol, it executes at the higher of its priority or the highest of the priority ceilings of all the mutexes owned by this thread and initialized with this attribute, regardless of whether other threads are blocked on any of these mutexes.

While a thread is holding a mutex that has been initialized with the PRIO_INHERIT or PRIO_PROTECT protocol attributes, it will not be subject to being moved to the tail of the scheduling queue at its priority in the event that its original priority is changed, such as by a call to sched_setparam(). Likewise, when a thread unlocks a mutex that has been initialized with the PRIO_INHERIT or PRIO_PROTECT protocol attributes, it will not be subject to being moved to the tail of the scheduling queue at its priority in the event that its original priority is changed.

If a thread simultaneously owns several mutexes initialized with different protocols, it will execute at the highest of the priorities that it would have obtained by each of these protocols.

If a thread makes a call to pthread_mutex_lock() for a mutex that was initialized with the protocol attribute PTHREAD_PRIO_INHERIT, and if the calling thread becomes blocked because the mutex is owned by another thread, then the owner thread inherits the priority level of the calling thread for as long as it continues to own the mutex. The implementation updates its execution priority to the maximum of its assigned priority and all its inherited priorities. Furthermore, if this owner thread becomes blocked on another mutex, the same priority inheritance effect will be propagated to the other owner thread, in a recursive manner.

A thread that uses mutexes initialized with the PTHREAD_PRIO_INHERIT or PTHREAD_PRIO_PROTECT protocol attribute values should have its scheduling policy equal to SCHED_FIFO or SCHED_RR (see pthread_attr_getschedparam(3C) and pthread_getschedparam(3C)).

If a thread with scheduling policy equal to SCHED_OTHER uses a mutex initialized with the PTHREAD_PRIO_INHERIT or PTHREAD_PRIO_PROTECT protocol attribute value, the effect on the thread's scheduling and priority is unspecified.

The _POSIX_THREAD_PRIO_INHERIT and _POSIX_THREAD_PRIO_PROTECT options are designed to provide features to solve priority inversion due to mutexes. A priority inheritance or priority ceiling mutex is designed to minimize the dispatch latency of a high priority thread when a low priority thread is holding a mutex required by the high priority thread. This is a specific need for the realtime application domain.

Threads created by realtime applications need to be such that their priorities can influence their access to system resources (CPU resources, at least), in competition with all threads running on the system.

Upon successful completion, the pthread_mutexattr_getprotocol() and pthread_mutexattr_setprotocol() functions return 0. Otherwise, an error number is returned to indicate the error.

The pthread_mutexattr_getprotocol() and pthread_mutexattr_setprotocol() functions will fail if:

EINVAL

ENOSYS

ENOTSUP

The pthread_mutexattr_getprotocol() and pthread_mutexattr_setprotocol() functions may fail if:

EINVAL

EPERM

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Committed
MT-Level	MT-Safe
Standard	See standards(5).

pthread_attr_getschedparam(3C), pthread_mutex_init(3C), pthread_mutexattr_init(3C), sched_setparam(3C), sched_setscheduler(3C), attributes(5), standards(5)