usr.sbin/rtprio/rtprio.1

   1 .\"
   2 .\" Copyright (c) 1994, Henrik Vestergaard Draboel
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by Henrik Vestergaard Draboel.
  16 .\" 4. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd July 23, 1994
  34 .Dt RTPRIO 1
  35 .Os
  36 .Sh NAME
  37 .Nm rtprio ,
  38 .Nm idprio
  39 .Nd execute, examine or modify a utility's or process's realtime
  40 or idletime scheduling priority
  41 .Sh SYNOPSIS
  42 .Nm [id|rt]prio
  43 .Nm [id|rt]prio
  44 .Oo Fl Oc Ns Ar pid
  45 .Nm [id|rt]prio
  46 .Ar priority
  47 .Ar command
  48 .Op args
  49 .Nm [id|rt]prio
  50 .Ar priority
  51 .Fl Ar pid
  52 .Nm [id|rt]prio
  53 .Fl t
  54 .Ar command
  55 .Op args
  56 .Nm [id|rt]prio
  57 .Fl t
  58 .Fl Ar pid
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 utility is used for controlling realtime process scheduling.
  63 .Pp
  64 The
  65 .Nm idprio
  66 utility is used for controlling idletime process scheduling, and can be called
  67 with the same options as
  68 .Nm .
  69 .Pp
  70 A process with a realtime priority is not subject to priority
  71 degradation, and will only be preempted by another process of equal or
  72 higher realtime priority.
  73 .Pp
  74 A process with an idle priority will run only when no other
  75 process is runnable and then only if its idle priority is equal or
  76 greater than all other runnable idle priority processes.
  77 .Pp
  78 Both
  79 .Nm
  80 or
  81 .Nm idprio
  82 when called without arguments will return the realtime priority
  83 of the current process.
  84 .Pp
  85 If
  86 .Nm
  87 is called with 1 argument, it will return the realtime priority
  88 of the process with the specified
  89 .Ar pid .
  90 .Pp
  91 If
  92 .Ar priority
  93 is specified, the process or program is run at that realtime priority.
  94 If
  95 .Fl t
  96 is specified, the process or program is run as a normal (non-realtime)
  97 process.
  98 .Pp
  99 If
 100 .Ar -pid
 101 is specified, the process with the process identifier
 102 .Ar pid
 103 will be modified, else if
 104 .Ar command
 105 is specified, that program is run with its arguments.
 106 .Pp
 107 .Ar Priority
 108 is an integer between 0 and RTP_PRIO_MAX (usually 31).
 109 0 is the
 110 highest priority
 111 .Pp
 112 .Ar Pid
 113 of 0 means "the current process".
 114 .Pp
 115 Only root is allowed to set realtime or idle priority for a process.
 116 .Sh DIAGNOSTICS
 117 If
 118 .Nm
 119 execute a command, the exit value is that of the command executed.
 120 In all other cases,
 121 .Nm
 122 exits 0 on success, and 1 for all other errors.
 123 .Sh EXAMPLES
 124 To see which realtime priority the current process is at:
 125 .Bd -literal -offset indent -compact
 126 .Sy "rtprio"
 127 .Ed
 128 .Pp
 129 To see which realtime priority of process
 130 .Em 1423 :
 131 .Bd -literal -offset indent -compact
 132 .Sy "rtprio 1423"
 133 .Ed
 134 .Pp
 135 To run
 136 .Xr cron 8
 137 at the lowest realtime priority:
 138 .Bd -literal -offset indent -compact
 139 .Sy "rtprio 31 cron"
 140 .Ed
 141 .Pp
 142 To change the realtime priority of process
 143 .Em 1423
 144 to
 145 .Em 16 :
 146 .Bd -literal -offset indent -compact
 147 .Sy "rtprio 16 -1423"
 148 .Ed
 149 .Pp
 150 To run
 151 .Xr tcpdump 1
 152 without realtime priority:
 153 .Bd -literal -offset indent -compact
 154 .Sy "rtprio -t tcpdump"
 155 .Ed
 156 .Pp
 157 To change the realtime priority of process
 158 .Em 1423
 159 to
 160 .Dv RTP_PRIO_NORMAL
 161 (non-realtime/normal priority):
 162 .Bd -literal -offset indent -compact
 163 .Sy "rtprio -t -1423"
 164 .Ed
 165 .Pp
 166 To make depend while not disturbing other machine usage:
 167 .Bd -literal -offset indent -compact
 168 .Sy "idprio 31 make depend"
 169 .Ed
 170 .Sh SEE ALSO
 171 .Xr nice 1 ,
 172 .Xr ps 1 ,
 173 .Xr rtprio 2 ,
 174 .Xr setpriority 2 ,
 175 .Xr nice 3 ,
 176 .Xr renice 8
 177 .Sh HISTORY
 178 The
 179 .Nm
 180 utility appeared in
 181 .Fx 2.0 ,
 182 but is similar to the HP-UX version.
 183 .Sh CAVEATS
 184 You can lock yourself out of the system by placing a cpu-heavy
 185 process in a realtime priority.
 186 .Sh BUGS
 187 There is no way to set/view the realtime priority of process 0
 188 (swapper) (see
 189 .Xr ps 1 ) .
 190 .Pp
 191 There is in
 192 .Fx
 193 no way to ensure that a process page is present in memory therefore
 194 the process may be stopped for pagein (see
 195 .Xr mprotect 2 ,
 196 .Xr madvise 2 ) .
 197 .Pp
 198 Under
 199 .Fx
 200 system calls are currently never preempted, therefore non-realtime
 201 processes can starve realtime processes, or idletime processes can
 202 starve normal priority processes.
 203 .Sh AUTHORS
 204 .An -nosplit
 205 .An Henrik Vestergaard Draboel Aq hvd@terry.ping.dk
 206 is the original author.
 207 This
 208 implementation in
 209 .Fx
 210 was substantially rewritten by
 211 .An David Greenman .