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 .Dd May 1, 2000
  30 .Dt PTHREAD_SCHEDPARAM 3
  31 .Os
  32 .Sh NAME
  33 .Nm pthread_setschedparam ,
  34 .Nm pthread_getschedparam
  35 .Nd thread scheduling parameter manipulation
  36 .Sh LIBRARY
  37 .Lb libc_r
  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) or
  55 .Dv SCHED_RR
  56 (round-robin).
  57 The thread priority (accessed via
  58 .Va param->sched_priority )
  59 must be at least
  60 .Dv PTHREAD_MIN_PRIORITY
  61 and no more than
  62 .Dv PTHREAD_MAX_PRIORITY .
  63 .Sh RETURN VALUES
  64 If successful, these functions return 0.
  65 Otherwise, an error number is returned to indicate the error.
  66 .Sh ERRORS
  67 The
  68 .Fn pthread_setschedparam
  69 function will fail if:
  70 .Bl -tag -width Er
  71 .It Bq Er EINVAL
  72 Invalid value for
  73 .Va policy .
  74 .It Bq Er ENOTSUP
  75 Invalid value for scheduling parameters.
  76 .It Bq Er ESRCH
  77 Non-existent thread
  78 .Va thread .
  79 .El
  80 .Pp
  81 The
  82 .Fn pthread_getschedparam
  83 function will fail if:
  84 .Bl -tag -width Er
  85 .It Bq Er ESRCH
  86 Non-existent thread
  87 .Va thread .
  88 .El
  89 .Sh STANDARDS
  90 The
  91 .Fn pthread_setschedparam
  92 and
  93 .Fn pthread_getschedparam
  94 functions conform to
  95 .St -susv2