101 lines
3.0 KiB
Groff
101 lines
3.0 KiB
Groff
.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice(s), this list of conditions and the following disclaimer as
|
|
.\" the first lines of this file unmodified other than the possible
|
|
.\" addition of one or more copyright notices.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice(s), this list of conditions and the following disclaimer in
|
|
.\" the documentation and/or other materials provided with the
|
|
.\" distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
|
|
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
|
|
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
|
.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd October 16, 2006
|
|
.Dt PTHREAD_SCHEDPARAM 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm pthread_setschedparam ,
|
|
.Nm pthread_getschedparam
|
|
.Nd thread scheduling parameter manipulation
|
|
.Sh LIBRARY
|
|
.Lb libpthread
|
|
.Sh SYNOPSIS
|
|
.In pthread.h
|
|
.Ft int
|
|
.Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param"
|
|
.Ft int
|
|
.Fn pthread_getschedparam "pthread_t thread" "int *policy" "struct sched_param *param"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn pthread_setschedparam
|
|
and
|
|
.Fn pthread_getschedparam
|
|
functions set and get the scheduling parameters of individual threads.
|
|
The scheduling policy for a thread can either be
|
|
.Dv SCHED_FIFO
|
|
(first in, first out),
|
|
.Dv SCHED_RR
|
|
(round-robin), or
|
|
.Dv SCHED_OTHER
|
|
(timesharing).
|
|
Valid thread priorities (accessed via
|
|
.Va param->sched_priority )
|
|
must be within the range returned by the
|
|
.Xr sched_get_priority_min 2
|
|
and
|
|
.Xr sched_get_priority_max 2
|
|
system calls.
|
|
.Sh RETURN VALUES
|
|
If successful, these functions return 0.
|
|
Otherwise, an error number is returned to indicate the error.
|
|
.Sh ERRORS
|
|
The
|
|
.Fn pthread_setschedparam
|
|
function will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa policy .
|
|
.It Bq Er ENOTSUP
|
|
Invalid value for scheduling parameters.
|
|
.It Bq Er ESRCH
|
|
Non-existent thread
|
|
.Fa thread .
|
|
.El
|
|
.Pp
|
|
The
|
|
.Fn pthread_getschedparam
|
|
function will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er ESRCH
|
|
Non-existent thread
|
|
.Fa thread .
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr sched_get_priority_max 2 ,
|
|
.Xr sched_get_priority_min 2
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn pthread_setschedparam
|
|
and
|
|
.Fn pthread_getschedparam
|
|
functions conform to
|
|
.St -susv2 .
|