lib/libc/sys/rtprio.2

   1 .\" Copyright (c) 1994, Henrik Vestergaard Draboel
   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, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Henrik Vestergaard Draboel.
  15 .\" 4. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD: src/lib/libc/sys/rtprio.2,v 1.13.2.9 2001/12/14 18:34:01 ru Exp $
  31 .\"
  32 .Dd July 23, 1994
  33 .Dt RTPRIO 2
  34 .Os
  35 .Sh NAME
  36 .Nm rtprio
  37 .Nd examine or modify a process realtime or idle priority
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/rtprio.h
  43 .Ft int
  44 .Fn rtprio "int function" "pid_t pid" "struct rtprio *rtp"
  45 .Sh DESCRIPTION
  46 .Fn rtprio
  47 is used to lookup or change the realtime or idle priority of a process.
  48 .Pp
  49 .Fa function
  50 specifies the operation to be performed.
  51 RTP_LOOKUP to lookup the current priority,
  52 and RTP_SET to set the priority.
  53 .Fa pid
  54 specifies the process to be used, 0 for the current process.
  55 .Pp
  56 .Fa *rtp
  57 is a pointer to a struct rtprio which is used to specify the priority and priority type.
  58 This structure has the following form:
  59 .Bd -literal
  60 struct rtprio {
  61         u_short type;
  62         u_short prio;
  63 };
  64 .Ed
  65 .Pp
  66 The value of the
  67 .Nm type
  68 field may be RTP_PRIO_REALTIME for realtime priorities,
  69 RTP_PRIO_NORMAL for normal priorities, and RTP_PRIO_IDLE for idle priorities.
  70 The priority specified by the
  71 .Nm prio
  72 field ranges between 0 and
  73 .Dv RTP_PRIO_MAX (usually 31) .
  74 0 is the highest possible priority.
  75 .Pp
  76 Realtime and idle priority is inherited through fork() and exec().
  77 .Pp
  78 A realtime process can only be preempted by a process of equal or
  79 higher priority, or by an interrupt; idle priority processes will run only
  80 when no other real/normal priority process is runnable.
  81 Higher real/idle priority processes
  82 preempt lower real/idle priority processes.
  83 Processes of equal real/idle priority are run round-robin.
  84 .Sh RETURN VALUES
  85 .Rv -std rtprio
  86 .Sh ERRORS
  87 .Fn rtprio
  88 will fail if
  89 .Bl -tag -width Er
  90 .It Bq Er EINVAL
  91 The specified
  92 .Fa prio
  93 was out of range.
  94 .It Bq Er EPERM
  95 The calling process is not allowed to set the realtime priority.
  96 Only
  97 root is allowed to change the realtime priority of any process, and non-root
  98 may only change the idle priority of the current process.
  99 .It Bq Er ESRCH
 100 The specified process was not found.
 101 .El
 102 .Sh AUTHORS
 103 .An -nosplit
 104 The original author was
 105 .An Henrik Vestergaard Draboel Aq hvd@terry.ping.dk .
 106 This implementation in
 107 .Fx
 108 was substantially rewritten by
 109 .An David Greenman .
 110 .Sh SEE ALSO
 111 .Xr nice 1 ,
 112 .Xr ps 1 ,
 113 .Xr rtprio 1 ,
 114 .Xr setpriority 2 ,
 115 .Xr nice 3 ,
 116 .Xr renice 8