share/man/man3/pthread_schedparam.3

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