getconf: don't include xpg4 bits, gcc7 includes xpg6 bits for us
[unleashed.git] / share / man / man3head / sched.h.3head
blob060cba30a63febefc82b15a576f84d16311bc1f9
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document.  The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
44 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
45 .\"
46 .TH SCHED.H 3HEAD "Apr 1, 2008"
47 .SH NAME
48 sched.h, sched \- execution scheduling
49 .SH SYNOPSIS
50 .LP
51 .nf
52 \fB#include <sched.h>\fR
53 .fi
55 .SH DESCRIPTION
56 .sp
57 .LP
58 The <\fBsched.h\fR> header defines the \fBsched_param\fR structure, which
59 contains the scheduling parameters required for implementation of each
60 supported scheduling policy. This structure contains the following member:
61 .sp
62 .in +2
63 .nf
64 int    sched_priority    process execution scheduling priority
65 .fi
66 .in -2
68 .sp
69 .LP
70 Each process is controlled by an associated scheduling policy and priority.
71 Associated with each policy is a priority range.  Each policy definition
72 specifies the minimum priority range for that policy. The priority ranges for
73 each policy may overlap the priority ranges of other policies.
74 .sp
75 .LP
76 The scheduling policies are indicated by the values of the following symbolic
77 constants:
78 .sp
79 .ne 2
80 .na
81 \fB\fBSCHED_OTHER\fR\fR
82 .ad
83 .RS 15n
84 Processes are scheduled according to the traditional Time-Sharing Class (TS)
85 policy as described in \fBpriocntl\fR(2).
86 .RE
88 .sp
89 .ne 2
90 .na
91 \fB\fBSCHED_FIFO\fR\fR
92 .ad
93 .RS 15n
94 Processes are scheduled in the Real-Time (RT) scheduling class, according to
95 the First-In-First-Out  (FIFO) policy. Processes scheduled to this policy, if
96 not preempted by a higher priority or interrupted by a signal, will proceed
97 until completion.
98 .RE
101 .ne 2
103 \fB\fBSCHED_RR\fR\fR
105 .RS 15n
106 Processes are scheduled in the Real-Time (RT) scheduling class, according to
107 the Round-Robin (RR) policy. Processes scheduled to this policy, if not
108 preempted by a higher priority or interrupted by a signal, will execute for a
109 time period, returned by \fBsched_rr_get_interval\fR(3C) or by the system.
113 .ne 2
115 \fB\fBSCHED_IA\fR\fR
117 .RS 15n
118 Processes are scheduled according to the Inter-Active Class (IA) policy as
119 described in \fBpriocntl\fR(2).
123 .ne 2
125 \fB\fBSCHED_FSS\fR\fR
127 .RS 15n
128 Processes are scheduled according to the Fair-Share Class (FSS) policy as
129 described in \fBpriocntl\fR(2).
133 .ne 2
135 \fB\fBSCHED_FX\fR\fR
137 .RS 15n
138 Processes are scheduled according to the Fixed-Priority Class (FX) policy as
139 described in \fBpriocntl\fR(2).
144 The values of these constants are distinct.
147 Inclusion of the \fB<sched.h>\fR header will make visible symbols defined in
148 the header \fB<time.h>\fR.
149 .SH SEE ALSO
152 \fBpriocntl\fR(2), \fBsched_get_priority_max\fR(3C),
153 \fBsched_get_priority_min\fR(3C), \fBsched_rr_get_interval\fR(3C),
154 \fBtime.h\fR(3HEAD)