man/pthread_getschedparam.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 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
  44 The
  45 .Fn pthread_setschedparam
  46 and
  47 .Fn pthread_getschedparam
  48 functions set and get the scheduling parameters of individual threads.
  49 The scheduling policy for a thread can either be
  50 .Dv SCHED_FIFO
  51 (first in, first out),
  52 .Dv SCHED_RR
  53 (round-robin), or
  54 .Dv SCHED_OTHER
  55 (timesharing).
  56 Valid thread priorities (accessed via
  57 .Va param->sched_priority )
  58 must be within the range returned by the
  59 .Xr sched_get_priority_min 2
  60 and
  61 .Xr sched_get_priority_max 2
  62 system calls.
  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 .Fa policy .
  74 .It Bq Er ENOTSUP
  75 Invalid value for scheduling parameters.
  76 .It Bq Er ESRCH
  77 Non-existent thread
  78 .Fa 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 .Fa thread .
  88 .El
  89 .Sh SEE ALSO
  90 .Xr sched_get_priority_max 2 ,
  91 .Xr sched_get_priority_min 2
  92 .Sh STANDARDS
  93 The
  94 .Fn pthread_setschedparam
  95 and
  96 .Fn pthread_getschedparam
  97 functions conform to
  98 .St -susv2 .