xref: /illumos-gate/usr/src/man/man3c/pthread_attr_getschedpolicy.3c (revision 8a2b682e57a046b828f37bcde1776f131ef4629f)

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 SunOS 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]


Copyright 1991, 1992, 1994, The X/Open Company Ltd. All Rights Reserved.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

PTHREAD_ATTR_GETSCHEDPOLICY 3C "Apr 1, 2008"
NAME
pthread_attr_getschedpolicy, pthread_attr_setschedpolicy - get or set schedpolicy attribute
SYNOPSIS

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

int pthread_attr_getschedpolicy(const pthread_attr_t *restrict attr,
 int *restrict policy);

int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
DESCRIPTION

The functions pthread_attr_setschedpolicy() and pthread_attr_getschedpolicy(), respectively, set and get the schedpolicy attribute in the attr argument.

Supported values of policy include SCHED_FIFO, SCHED_RR and SCHED_OTHER, which are defined by the header <sched.h>. When threads executing with the scheduling policy SCHED_FIFO or SCHED_RR are waiting on a mutex, they acquire the mutex in priority order when the mutex is unlocked.

See sched.h(3HEAD) for a description of all defined policy values. Valid policy values can also be obtained from pthread_getschedparam(3C) and sched_getscheduler(3C).

RETURN VALUES

If successful, the pthread_attr_setschedpolicy() and pthread_attr_getschedpolicy() functions return 0. Otherwise, an error number is returned to indicate the error.

ERRORS

The pthread_attr_setschedpolicy() or pthread_attr_getschedpolicy() function may fail if: EINVAL

attr or policy is invalid.

USAGE

After these attributes have been set, a thread can be created with the specified attributes using pthread_create(). Using these routines does not affect the current running thread.

ATTRIBUTES

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

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

pthread_attr_init(3C), pthread_attr_setscope(3C), pthread_attr_setinheritsched(3C), pthread_attr_setschedparam(3C), pthread_create(3C), pthread_getschedparam(3C), sched.h(3HEAD), sched_getscheduler(3C), attributes(5), standards(5)