lib/libpthread/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: src/lib/libc_r/man/pthread_schedparam.3,v 1.2.2.5 2001/12/17 10:08:26 ru Exp $
  29 .\" $DragonFly: src/lib/libc_r/man/pthread_schedparam.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  30 .Dd April 15, 2009
  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 .Sh SYNOPSIS
  40 .In pthread.h
  41 .Ft int
  42 .Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param"
  43 .Ft int
  44 .Fn pthread_getschedparam "pthread_t thread" "int *policy" "struct sched_param *param"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn pthread_setschedparam
  48 and
  49 .Fn pthread_getschedparam
  50 functions set and get the scheduling parameters of individual threads.
  51 The scheduling policy for a thread can either be
  52 .Dv SCHED_FIFO
  53 (first in, first out) or
  54 .Dv SCHED_RR
  55 (round-robin).
  56 The thread priority (accessed via
  57 .Va param->sched_priority )
  58 must be at least
  59 .Dv PTHREAD_MIN_PRIORITY
  60 and no more than
  61 .Dv PTHREAD_MAX_PRIORITY .
  62 .Sh RETURN VALUES
  63 If successful, these functions return 0.
  64 Otherwise, an error number is returned to indicate the error.
  65 .Sh ERRORS
  66 .Fn pthread_setschedparam
  67 will fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er EINVAL
  70 Invalid value for
  71 .Va policy .
  72 .It Bq Er ENOTSUP
  73 Invalid value for scheduling parameters.
  74 .It Bq Er ESRCH
  75 Non-existent thread
  76 .Va thread .
  77 .El
  78 .Pp
  79 .Fn pthread_getschedparam
  80 will fail if:
  81 .Bl -tag -width Er
  82 .It Bq Er ESRCH
  83 Non-existent thread
  84 .Va thread .
  85 .El
  86 .Sh STANDARDS
  87 .Fn pthread_setschedparam
  88 and
  89 .Fn pthread_getschedparam
  90 conform to
  91 .St -susv2