man2/nice.2

   1 .\" Copyright (c) 1992 Drew Eckhardt <drew@cs.colorado.edu>, March 28, 1992
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified by Michael Haardt <michael@moria.de>
  26 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  27 .\" Modified 1996-11-04 by Eric S. Raymond <esr@thyrsus.com>
  28 .\" Modified 2001-06-04 by aeb
  29 .\" Modified 2004-05-27 by Michael Kerrisk <mtk.manpages@gmail.com>
  30 .\"
  31 .TH NICE 2 2016-12-12 "Linux" "Linux Programmer's Manual"
  32 .SH NAME
  33 nice \- change process priority
  34 .SH SYNOPSIS
  35 .B #include <unistd.h>
  36 .sp
  37 .BI "int nice(int " inc );
  38 .sp
  39 .in -4n
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .in
  43 .sp
  44 .BR nice ():
  45 _XOPEN_SOURCE
  46     || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  47     || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  48 .SH DESCRIPTION
  49 .BR nice ()
  50 adds
  51 .I inc
  52 to the nice value for the calling thread.
  53 (A higher nice value means a low priority.)
  54
  55 The range of the nice value is +19 (low priority) to \-20 (high priority).
  56 Attempts to set a nice value outside the range are clamped to the range.
  57
  58 Traditionally, only a privileged process could lower the nice value
  59 (i.e., set a higher priority).
  60 However, since Linux 2.6.12, an unprivileged process can decrease
  61 the nice value of a target process that has a suitable
  62 .BR RLIMIT_NICE
  63 soft limit; see
  64 .BR getrlimit (2)
  65 for details.
  66 .SH RETURN VALUE
  67 On success, the new nice value is returned (but see NOTES below).
  68 On error, \-1 is returned, and
  69 .I errno
  70 is set appropriately.
  71
  72 A successful call can legitimately return \-1.
  73 To detect an error, set
  74 .I errno
  75 to 0 before the call, and check whether it is nonzero after
  76 .BR nice ()
  77 returns \-1.
  78 .SH ERRORS
  79 .TP
  80 .B EPERM
  81 The calling process attempted to increase its priority by
  82 supplying a negative
  83 .I inc
  84 but has insufficient privileges.
  85 Under Linux, the
  86 .B CAP_SYS_NICE
  87 capability is required.
  88 (But see the discussion of the
  89 .B RLIMIT_NICE
  90 resource limit in
  91 .BR setrlimit (2).)
  92 .SH CONFORMING TO
  93 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
  94 However, the raw system call and (g)libc
  95 (earlier than glibc 2.2.4) return value is nonstandard, see below.
  96 .\" SVr4 documents an additional
  97 .\" .B EINVAL
  98 .\" error code.
  99 .SH NOTES
 100 For further details on the nice value, see
 101 .BR sched (7).
 102
 103 .IR Note :
 104 the addition of the "autogroup" feature in Linux 2.6.38 means that
 105 the nice value no longer has its traditional effect in many circumstances.
 106 For details, see
 107 .BR sched (7).
 108 .\"
 109 .SS C library/kernel differences
 110 POSIX.1 specifies that
 111 .BR nice ()
 112 should return the new nice value.
 113 However, the raw Linux system call returns 0 on success.
 114 Likewise, the
 115 .BR nice ()
 116 wrapper function provided in glibc 2.2.3 and earlier returns 0 on success.
 117
 118 Since glibc 2.2.4, the
 119 .BR nice ()
 120 wrapper function provided by glibc provides conformance to POSIX.1 by calling
 121 .BR getpriority (2)
 122 to obtain the new nice value, which is then returned to the caller.
 123 .SH SEE ALSO
 124 .BR nice (1),
 125 .BR renice (1),
 126 .BR fork (2),
 127 .BR getpriority (2),
 128 .BR getrlimit (2),
 129 .BR setpriority (2),
 130 .BR capabilities (7),
 131 .BR sched (7)