1.\" $OpenBSD: pthread_schedparam.3,v 1.6 2015/11/10 23:48:18 jmc Exp $
2.\" Copyright (C) 2000 Jason Evans <jasone@freebsd.org>.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice(s), this list of conditions and the following disclaimer as
10.\"    the first lines of this file unmodified other than the possible
11.\"    addition of one or more copyright notices.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice(s), this list of conditions and the following disclaimer in
14.\"    the documentation and/or other materials provided with the
15.\"    distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
18.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
21.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD: src/lib/libc_r/man/pthread_schedparam.3,v 1.4 2001/07/15 07:53:27 dd Exp $
30.Dd $Mdocdate: November 10 2015 $
31.Dt PTHREAD_SETSCHEDPARAM 3
32.Os
33.Sh NAME
34.Nm pthread_setschedparam ,
35.Nm pthread_getschedparam
36.Nd thread scheduling parameter manipulation
37.Sh SYNOPSIS
38.In pthread.h
39.Ft int
40.Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param"
41.Ft int
42.Fn pthread_getschedparam "pthread_t thread" "int *policy" "struct sched_param *param"
43.Sh DESCRIPTION
44The
45.Fn pthread_setschedparam
46and
47.Fn pthread_getschedparam
48functions set and get the scheduling parameters of individual threads.
49The scheduling policy for a thread can either be
50.Dv SCHED_FIFO
51(first in, first out) or
52.Dv SCHED_RR
53(round-robin).
54The thread priority (accessed via
55.Va param->sched_priority )
56must be within the range returned by the
57.Fn sched_get_priority_min
58and
59.Fn sched_get_priority_max
60functions.
61.Sh RETURN VALUES
62If successful, these functions return 0.
63Otherwise, an error number is returned to indicate the error.
64.Sh ERRORS
65.Fn pthread_setschedparam
66will fail if:
67.Bl -tag -width Er
68.It Bq Er EINVAL
69Invalid value for
70.Va policy .
71.It Bq Er ENOTSUP
72Invalid value for scheduling parameters.
73.It Bq Er ESRCH
74Non-existent thread
75.Va thread .
76.El
77.Pp
78.Fn pthread_getschedparam
79will fail if:
80.Bl -tag -width Er
81.It Bq Er ESRCH
82Non-existent thread
83.Va thread .
84.El
85.Sh SEE ALSO
86.Xr sched_get_priority_max 3
87.Sh STANDARDS
88.Fn pthread_setschedparam
89and
90.Fn pthread_getschedparam
91conform to
92.St -susv2
93