xref: /illumos-gate/usr/src/man/man3c/sched_setscheduler.3c (revision 598f4ceed9327d2d6c2325dd67cae3aa06f7fea6)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved.
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]
SCHED_SETSCHEDULER 3C "Apr 1, 2008"
NAME
sched_setscheduler - set scheduling policy and scheduling parameters
SYNOPSIS

#include <sched.h>

int sched_setscheduler(pid_t pid, int policy,
 const struct sched_param *param);
DESCRIPTION

The sched_setscheduler() function sets the scheduling policy and scheduling parameters of the process specified by pid to policy and the parameters specified in the sched_param structure pointed to by param, respectively. The value of the sched_priority member in the sched_param structure is any integer within the inclusive priority range for the scheduling policy specified by policy. The sched_setscheduler() function ignores the other members of the sched_param structure. If the value of pid is negative, the behavior of the sched_setscheduler() function is unspecified.

The possible values for the policy parameter are defined in the header <sched.h> (see sched.h(3HEAD)):

If a process specified by pid exists and if the calling process has permission, the scheduling policy and scheduling parameters are set for the process whose process ID is equal to pid. The real or effective user ID of the calling process must match the real or saved (from exec(2)) user ID of the target process unless the effective user ID of the calling process is 0. See Intro(2).

If pid is 0, the scheduling policy and scheduling parameters are set for the calling process.

To change the policy of any process to either of the real time policies SCHED_FIFO or SCHED_RR, the calling process must either have the SCHED_FIFO or SCHED_RR policy or have an effective user ID of 0.

The sched_setscheduler() function is considered successful if it succeeds in setting the scheduling policy and scheduling parameters of the process specified by pid to the values specified by policy and the structure pointed to by param, respectively.

RETURN VALUES

Upon successful completion, the function returns the former scheduling policy of the specified process. If the sched_setscheduler() function fails to complete successfully, the policy and scheduling paramenters remain unchanged, and the function returns -1 and sets errno to indicate the error.

ERRORS

The sched_setscheduler() function will fail if: EINVAL

The value of policy is invalid, or one or more of the parameters contained in param is outside the valid range for the specified scheduling policy.

EPERM

The requesting process does not have permission to set either or both of the scheduling parameters or the scheduling policy of the specified process.

ESRCH

No process can be found corresponding to that specified by pid.

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

priocntl(1), Intro(2), exec(2), priocntl(2), librt(3LIB), sched.h(3HEAD), sched_get_priority_max(3C), sched_getparam(3C), sched_getscheduler(3C), sched_setparam(3C), attributes(5), standards(5)