share/man/man3c/sched_setscheduler.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved.
   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 SCHED_SETSCHEDULER 3C "Apr 1, 2008"
  13 .SH NAME
  14 sched_setscheduler \- set scheduling policy and scheduling parameters
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sched.h>
  19
  20 \fBint\fR \fBsched_setscheduler\fR(\fBpid_t\fR \fIpid\fR, \fBint\fR \fIpolicy\fR,
  21      \fBconst struct sched_param *\fR\fIparam\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBsched_setscheduler()\fR function sets the scheduling policy and
  28 scheduling parameters of the process specified by \fIpid\fR to \fIpolicy\fR and
  29 the parameters specified in the \fBsched_param\fR structure pointed to by
  30 \fIparam\fR, respectively. The value of the \fBsched_priority\fR member in the
  31 \fBsched_param\fR structure is any integer within the inclusive priority range
  32 for the scheduling policy specified by \fIpolicy\fR. The
  33 \fBsched_setscheduler()\fR function ignores the other members of the
  34 \fBsched_param\fR structure. If the value of \fIpid\fR is negative, the
  35 behavior of the \fBsched_setscheduler()\fR function is unspecified.
  36 .sp
  37 .LP
  38 The possible values for the \fIpolicy\fR parameter are defined in the header
  39 <\fBsched.h\fR> (see \fBsched.h\fR(3HEAD)):
  40 .sp
  41 .LP
  42 If a process specified by \fIpid\fR exists and if the calling process has
  43 permission, the scheduling policy and scheduling parameters are set for the
  44 process whose process  \fBID\fR is equal to \fIpid.\fR The real or effective
  45 user  \fBID\fR of the calling process must match the real or saved (from
  46 \fBexec\fR(2)) user  \fBID\fR of the target process unless the effective user
  47 \fBID\fR of the calling process is 0. See \fBIntro\fR(2).
  48 .sp
  49 .LP
  50 If \fIpid\fR is 0, the scheduling policy and scheduling parameters are set for
  51 the calling process.
  52 .sp
  53 .LP
  54 To change the \fIpolicy\fR of any process to either of the real time policies
  55 \fBSCHED_FIFO\fR or \fBSCHED_RR\fR, the calling process must either have the
  56 \fBSCHED_FIFO\fR or \fBSCHED_RR\fR policy or have an effective user \fBID\fR of
  57 \fB0\fR.
  58 .sp
  59 .LP
  60 The \fBsched_setscheduler()\fR function is considered successful if it succeeds
  61 in setting the scheduling policy and scheduling parameters of the process
  62 specified by \fIpid\fR to the values specified by \fIpolicy\fR and the
  63 structure pointed to by \fIparam\fR, respectively.
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 Upon successful completion, the function returns the former scheduling policy
  68 of the specified process. If the \fBsched_setscheduler()\fR function fails to
  69 complete successfully, the policy and scheduling paramenters remain unchanged,
  70 and the function returns \(mi1 and sets \fBerrno\fR to indicate the error.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBsched_setscheduler()\fR function will fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEINVAL\fR\fR
  79 .ad
  80 .RS 10n
  81 The value of \fIpolicy\fR is invalid, or one or more of the parameters
  82 contained in \fIparam\fR is outside the valid range for the specified
  83 scheduling policy.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBEPERM\fR\fR
  90 .ad
  91 .RS 10n
  92 The requesting process does not have permission to set either or both of the
  93 scheduling parameters or the scheduling policy of the specified process.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBESRCH\fR\fR
 100 .ad
 101 .RS 10n
 102 No process can be found corresponding to that specified by \fIpid.\fR
 103 .RE
 104
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Committed
 119 _
 120 MT-Level        MT-Safe
 121 _
 122 Standard        See \fBstandards\fR(5).
 123 .TE
 124
 125 .SH SEE ALSO
 126 .sp
 127 .LP
 128 \fBpriocntl\fR(1), \fBIntro\fR(2), \fBexec\fR(2), \fBpriocntl\fR(2),
 129 \fBlibrt\fR(3LIB), \fBsched.h\fR(3HEAD), \fBsched_get_priority_max\fR(3C),
 130 \fBsched_getparam\fR(3C), \fBsched_getscheduler\fR(3C),
 131 \fBsched_setparam\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)