usr/src/man/man3c/pthread_getschedparam.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_GETSCHEDPARAM 3C "Apr 1, 2008"
  13 .SH NAME
  14 pthread_getschedparam, pthread_setschedparam \- access dynamic thread
  15 scheduling parameters
  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_getschedparam\fR(\fBpthread_t\fR \fIthread\fR, \fBint *restrict\fR \fIpolicy\fR,
  23      \fBstruct sched_param *restrict\fR \fIparam\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_setschedparam\fR(\fBpthread_t\fR \fIthread\fR, \fBint\fR \fIpolicy\fR,
  29      \fBconst struct sched_param *\fR\fIparam\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBpthread_getschedparam()\fR and \fBpthread_setschedparam()\fR functions
  36 allow the scheduling policy and scheduling parameters of individual threads
  37 within a multithreaded process to be retrieved and set. Supported policies are
  38 :
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBSCHED_OTHER\fR\fR
  43 .ad
  44 .RS 15n
  45 traditional time-sharing scheduling class
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSCHED_FIFO\fR\fR
  52 .ad
  53 .RS 15n
  54 real-time class: run to completion
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBSCHED_RR\fR\fR
  61 .ad
  62 .RS 15n
  63 real-time class: round-robin
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBSCHED_IA\fR\fR
  70 .ad
  71 .RS 15n
  72 interactive time-sharing class
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBSCHED_FSS\fR\fR
  79 .ad
  80 .RS 15n
  81 fair-share scheduling class
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBSCHED_FX\fR\fR
  88 .ad
  89 .RS 15n
  90 fixed priority scheduling class
  91 .RE
  92
  93 .sp
  94 .LP
  95 See \fBpthreads\fR(5). The affected scheduling parameter is the
  96 \fIsched_priority\fR member of the \fBsched_param\fR structure.
  97 .sp
  98 .LP
  99 The \fBpthread_getschedparam()\fR function retrieves the scheduling policy and
 100 scheduling parameters for the thread whose thread \fBID\fR is given by
 101 \fIthread\fR and stores those values in \fIpolicy\fR and \fIparam\fR,
 102 respectively. The priority value returned from \fBpthread_getschedparam()\fR is
 103 the value specified by the most recent \fBpthread_setschedparam()\fR or
 104 \fBpthread_create()\fR call affecting the target thread, and does not reflect
 105 any temporary adjustments to its priority as a result of any priority
 106 inheritance or ceiling functions. The \fBpthread_setschedparam()\fR function
 107 sets the scheduling policy and associated scheduling parameters for the thread
 108 whose thread  \fBID\fR is given by \fIthread\fR to the policy and associated
 109 parameters provided in \fIpolicy\fR and \fIparam\fR, respectively.
 110 .sp
 111 .LP
 112 If the \fBpthread_setschedparam()\fR function fails, no scheduling parameters
 113 will be changed  for the target thread.
 114 .SH RETURN VALUES
 115 .sp
 116 .LP
 117 If successful, the \fBpthread_getschedparam()\fR and
 118 \fBpthread_setschedparam()\fR functions return  \fB0\fR. Otherwise, an error
 119 number is returned to indicate the error.
 120 .SH ERRORS
 121 .sp
 122 .LP
 123 The \fBpthread_getschedparam()\fR and \fBpthread_gsetschedparam()\fR functions
 124 will fail if:
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBESRCH\fR\fR
 129 .ad
 130 .RS 9n
 131 The value specified by \fIthread\fR does not refer to an existing thread.
 132 .RE
 133
 134 .sp
 135 .LP
 136 The \fBpthread_setschedparam()\fR function will fail if:
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBEINVAL\fR\fR
 141 .ad
 142 .RS 10n
 143 The value specified by \fIpolicy\fR or one of the scheduling parameters
 144 associated with the scheduling policy \fIpolicy\fR is invalid.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBEPERM\fR\fR
 151 .ad
 152 .RS 10n
 153 The caller does not have the appropriate permission to set either the
 154 scheduling parameters or the scheduling policy of the specified thread.
 155 .RE
 156
 157 .SH ATTRIBUTES
 158 .sp
 159 .LP
 160 See \fBattributes\fR(5) for descriptions of the following attributes:
 161 .sp
 162
 163 .sp
 164 .TS
 165 box;
 166 c | c
 167 l | l .
 168 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 169 _
 170 Interface Stability     Committed
 171 _
 172 MT-Level        MT-Safe
 173 _
 174 Standard        See \fBstandards\fR(5).
 175 .TE
 176
 177 .SH SEE ALSO
 178 .sp
 179 .LP
 180 \fBpthread_attr_init\fR(3C), \fBsched_getparam\fR(3C),
 181 \fBsched_get_priority_max\fR(3C)\fBsched_get_priority_max\fR(3C),
 182 \fBsched_get_priority_min\fR(3C), \fBsched_setparam\fR(3C),
 183 \fBsched_getscheduler\fR(3C), \fBsched_setscheduler\fR(3C),
 184 \fBattributes\fR(5), \fBpthreads\fR(5), \fBstandards\fR(5)