original/man2/getpriority.2

   1 .\" Copyright (c) 1980, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   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 the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)getpriority.2       6.9 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified 1996-07-01 by Andries Brouwer <aeb@cwi.nl>
  38 .\" Modified 1996-11-06 by Eric S. Raymond <esr@thyrsus.com>
  39 .\" Modified 2001-10-21 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"    Corrected statement under EPERM to clarify privileges required
  41 .\" Modified 2002-06-21 by Michael Kerrisk <mtk.manpages@gmail.com>
  42 .\"    Clarified meaning of 0 value for 'who' argument
  43 .\" Modified 2004-05-27 by Michael Kerrisk <mtk.manpages@gmail.com>
  44 .\"
  45 .TH GETPRIORITY 2 2014-08-19 "Linux" "Linux Programmer's Manual"
  46 .SH NAME
  47 getpriority, setpriority \- get/set program scheduling priority
  48 .SH SYNOPSIS
  49 .B #include <sys/time.h>
  50 .br
  51 .B #include <sys/resource.h>
  52 .sp
  53 .BI "int getpriority(int " which ", id_t " who );
  54 .br
  55 .BI "int setpriority(int " which ", id_t " who ", int " prio );
  56 .SH DESCRIPTION
  57 The scheduling priority of the process, process group, or user, as
  58 indicated by
  59 .I which
  60 and
  61 .I who
  62 is obtained with the
  63 .BR getpriority ()
  64 call and set with the
  65 .BR setpriority ()
  66 call.
  67
  68 The value
  69 .I which
  70 is one of
  71 .BR PRIO_PROCESS ,
  72 .BR PRIO_PGRP ,
  73 or
  74 .BR PRIO_USER ,
  75 and
  76 .I who
  77 is interpreted relative to
  78 .I which
  79 (a process identifier for
  80 .BR PRIO_PROCESS ,
  81 process group
  82 identifier for
  83 .BR PRIO_PGRP ,
  84 and a user ID for
  85 .BR PRIO_USER ).
  86 A zero value for
  87 .I who
  88 denotes (respectively) the calling process, the process group of the
  89 calling process, or the real user ID of the calling process.
  90 .I Prio
  91 is a value in the range \-20 to 19 (but see the Notes below).
  92 The default priority is 0;
  93 lower priorities cause more favorable scheduling.
  94
  95 The
  96 .BR getpriority ()
  97 call returns the highest priority (lowest numerical value)
  98 enjoyed by any of the specified processes.
  99 The
 100 .BR setpriority ()
 101 call sets the priorities of all of the specified processes
 102 to the specified value.
 103 Only the superuser may lower priorities.
 104 .SH RETURN VALUE
 105 Since
 106 .BR getpriority ()
 107 can legitimately return the value \-1, it is necessary
 108 to clear the external variable
 109 .I errno
 110 prior to the
 111 call, then check it afterward to determine
 112 if \-1 is an error or a legitimate value.
 113 The
 114 .BR setpriority ()
 115 call returns 0 if there is no error, or
 116 \-1 if there is.
 117 .SH ERRORS
 118 .TP
 119 .B EINVAL
 120 .I which
 121 was not one of
 122 .BR PRIO_PROCESS ,
 123 .BR PRIO_PGRP ,
 124 or
 125 .BR PRIO_USER .
 126 .TP
 127 .B ESRCH
 128 No process was located using the
 129 .I which
 130 and
 131 .I who
 132 values specified.
 133 .PP
 134 In addition to the errors indicated above,
 135 .BR setpriority ()
 136 may fail if:
 137 .TP
 138 .B EACCES
 139 The caller attempted to lower a process priority, but did not
 140 have the required privilege (on Linux: did not have the
 141 .B CAP_SYS_NICE
 142 capability).
 143 Since Linux 2.6.12, this error occurs only if the caller attempts
 144 to set a process priority outside the range of the
 145 .B RLIMIT_NICE
 146 soft resource limit of the target process; see
 147 .BR getrlimit (2)
 148 for details.
 149 .TP
 150 .B EPERM
 151 A process was located, but its effective user ID did not match
 152 either the effective or the real user ID of the caller,
 153 and was not privileged (on Linux: did not have the
 154 .B CAP_SYS_NICE
 155 capability).
 156 But see NOTES below.
 157 .SH CONFORMING TO
 158 SVr4, 4.4BSD (these function calls first appeared in 4.2BSD),
 159 POSIX.1-2001.
 160 .SH NOTES
 161 A child created by
 162 .BR fork (2)
 163 inherits its parent's nice value.
 164 The nice value is preserved across
 165 .BR execve (2).
 166
 167 The degree to which their relative nice value affects the scheduling of
 168 processes varies across UNIX systems, and,
 169 on Linux, across kernel versions.
 170 Starting with kernel 2.6.23, Linux adopted an algorithm that causes
 171 relative differences in nice values to have a much stronger effect.
 172 This causes very low nice values (+19) to truly provide little CPU
 173 to a process whenever there is any other
 174 higher priority load on the system,
 175 and makes high nice values (\-20) deliver most of the CPU to applications
 176 that require it (e.g., some audio applications).
 177
 178 The details on the condition for
 179 .B EPERM
 180 depend on the system.
 181 The above description is what POSIX.1-2001 says, and seems to be followed on
 182 all System\ V-like systems.
 183 Linux kernels before 2.6.12 required the real or
 184 effective user ID of the caller to match
 185 the real user of the process \fIwho\fP (instead of its effective user ID).
 186 Linux 2.6.12 and later require
 187 the effective user ID of the caller to match
 188 the real or effective user ID of the process \fIwho\fP.
 189 All BSD-like systems (SunOS 4.1.3, Ultrix 4.2,
 190 4.3BSD, FreeBSD 4.3, OpenBSD-2.5, ...) behave in the same
 191 manner as Linux 2.6.12 and later.
 192 .LP
 193 The actual priority range varies between kernel versions.
 194 Linux before 1.3.36 had \-infinity..15.
 195 Since kernel 1.3.43, Linux has the range \-20..19.
 196 On some other systems, the range of nice values is \-20..20.
 197
 198 Including
 199 .I <sys/time.h>
 200 is not required these days, but increases portability.
 201 (Indeed,
 202 .I <sys/resource.h>
 203 defines the
 204 .I rusage
 205 structure with fields of type
 206 .I struct timeval
 207 defined in
 208 .IR <sys/time.h> .)
 209 .\"
 210 .SS C library/kernel ABI differences
 211 Within the kernel, nice values are actually represented
 212 using the range 40..1
 213 (since negative numbers are error codes) and these are the values
 214 employed by the
 215 .BR setpriority ()
 216 and
 217 .BR getpriority ()
 218 system calls.
 219 The glibc wrapper functions for these system calls handle the
 220 translations between the user-land and kernel representations
 221 of the nice value according to the formula
 222 .IR "unice\ =\ 20\ \-\ knice" .
 223 (Thus, the kernels 40..1 range corresponds to the
 224 range \-20..19 as seen by user space.)
 225 .SH BUGS
 226 According to POSIX, the nice value is a per-process setting.
 227 However, under the current Linux/NPTL implementation of POSIX threads,
 228 the nice value is a per-thread attribute:
 229 different threads in the same process can have different nice values.
 230 Portable applications should avoid relying on the Linux behavior,
 231 which may be made standards conformant in the future.
 232 .SH SEE ALSO
 233 .BR nice (1),
 234 .BR renice (1),
 235 .BR fork (2),
 236 .BR capabilities (7),
 237 .BR sched (7)
 238
 239 .I Documentation/scheduler/sched-nice-design.txt
 240 in the Linux kernel source tree (since Linux 2.6.23)
 241 .SH COLOPHON
 242 This page is part of release 3.79 of the Linux
 243 .I man-pages
 244 project.
 245 A description of the project,
 246 information about reporting bugs,
 247 and the latest version of this page,
 248 can be found at
 249 \%http://www.kernel.org/doc/man\-pages/.