man2/getrlimit.2

   1 .\" Copyright (c) 1992 Drew Eckhardt, March 28, 1992
   2 .\" and Copyright (c) 2002, 2004, 2005, 2008, 2010 Michael Kerrisk
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Modified by Michael Haardt <michael@moria.de>
  27 .\" Modified 1993-07-23 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified 1996-01-13 by Arnt Gulbrandsen <agulbra@troll.no>
  29 .\" Modified 1996-01-22 by aeb, following a remark by
  30 .\"          Tigran Aivazian <tigran@sco.com>
  31 .\" Modified 1996-04-14 by aeb, following a remark by
  32 .\"          Robert Bihlmeyer <robbe@orcus.ping.at>
  33 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  34 .\" Modified 2001-05-04 by aeb, following a remark by
  35 .\"          Håvard Lygre <hklygre@online.no>
  36 .\" Modified 2001-04-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  37 .\" Modified 2002-06-13 by Michael Kerrisk <mtk.manpages@gmail.com>
  38 .\"     Added note on nonstandard behavior when SIGCHLD is ignored.
  39 .\" Modified 2002-07-09 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"     Enhanced descriptions of 'resource' values
  41 .\" Modified 2003-11-28 by aeb, added RLIMIT_CORE
  42 .\" Modified 2004-03-26 by aeb, added RLIMIT_AS
  43 .\" Modified 2004-06-16 by Michael Kerrisk <mtk.manpages@gmail.com>
  44 .\"     Added notes on CAP_SYS_RESOURCE
  45 .\"
  46 .\" 2004-11-16 -- mtk: the getrlimit.2 page, which formally included
  47 .\" coverage of getrusage(2), has been split, so that the latter
  48 .\" is now covered in its own getrusage.2.
  49 .\"
  50 .\" Modified 2004-11-16, mtk: A few other minor changes
  51 .\" Modified 2004-11-23, mtk
  52 .\"     Added notes on RLIMIT_MEMLOCK, RLIMIT_NPROC, and RLIMIT_RSS
  53 .\"             to "CONFORMING TO"
  54 .\" Modified 2004-11-25, mtk
  55 .\"     Rewrote discussion on RLIMIT_MEMLOCK to incorporate kernel
  56 .\"             2.6.9 changes.
  57 .\"     Added note on RLIMIT_CPU error in older kernels
  58 .\" 2004-11-03, mtk, Added RLIMIT_SIGPENDING
  59 .\" 2005-07-13, mtk, documented RLIMIT_MSGQUEUE limit.
  60 .\" 2005-07-28, mtk, Added descriptions of RLIMIT_NICE and RLIMIT_RTPRIO
  61 .\" 2008-05-07, mtk / Peter Zijlstra, Added description of RLIMIT_RTTIME
  62 .\" 2010-11-06, mtk: Added documentation of prlimit()
  63 .\"
  64 .TH GETRLIMIT 2 2016-10-08 "Linux" "Linux Programmer's Manual"
  65 .SH NAME
  66 getrlimit, setrlimit, prlimit \- get/set resource limits
  67 .SH SYNOPSIS
  68 .B #include <sys/time.h>
  69 .br
  70 .B #include <sys/resource.h>
  71 .sp
  72 .BI "int getrlimit(int " resource ", struct rlimit *" rlim );
  73 .br
  74 .BI "int setrlimit(int " resource ", const struct rlimit *" rlim );
  75 .sp
  76 .BI "int prlimit(pid_t "  pid ", int " resource \
  77 ", const struct rlimit *" new_limit ,
  78 .br
  79 .BI "            struct rlimit *" old_limit );
  80 .sp
  81 .in -4n
  82 Feature Test Macro Requirements for glibc (see
  83 .BR feature_test_macros (7)):
  84 .in
  85 .sp
  86 .BR prlimit ():
  87 _GNU_SOURCE
  88 .SH DESCRIPTION
  89 The
  90 .BR getrlimit ()
  91 and
  92 .BR setrlimit ()
  93 system calls get and set resource limits respectively.
  94 Each resource has an associated soft and hard limit, as defined by the
  95 .I rlimit
  96 structure:
  97 .PP
  98 .in +4n
  99 .nf
 100 struct rlimit {
 101     rlim_t rlim_cur;  /* Soft limit */
 102     rlim_t rlim_max;  /* Hard limit (ceiling for rlim_cur) */
 103 };
 104
 105 .fi
 106 .in
 107 The soft limit is the value that the kernel enforces for the
 108 corresponding resource.
 109 The hard limit acts as a ceiling for the soft limit:
 110 an unprivileged process may set only its soft limit to a value in the
 111 range from 0 up to the hard limit, and (irreversibly) lower its hard limit.
 112 A privileged process (under Linux: one with the
 113 .B CAP_SYS_RESOURCE
 114 capability) may make arbitrary changes to either limit value.
 115 .PP
 116 The value
 117 .B RLIM_INFINITY
 118 denotes no limit on a resource (both in the structure returned by
 119 .BR getrlimit ()
 120 and in the structure passed to
 121 .BR setrlimit ()).
 122 .PP
 123 The
 124 .I resource
 125 argument must be one of:
 126 .TP
 127 .B RLIMIT_AS
 128 The maximum size of the process's virtual memory (address space) in bytes.
 129 .\" since 2.0.27 / 2.1.12
 130 This limit affects calls to
 131 .BR brk (2),
 132 .BR mmap (2),
 133 and
 134 .BR mremap (2),
 135 which fail with the error
 136 .B ENOMEM
 137 upon exceeding this limit.
 138 Also automatic stack expansion will fail
 139 (and generate a
 140 .B SIGSEGV
 141 that kills the process if no alternate stack
 142 has been made available via
 143 .BR sigaltstack (2)).
 144 Since the value is a \fIlong\fP, on machines with a 32-bit \fIlong\fP
 145 either this limit is at most 2 GiB, or this resource is unlimited.
 146 .TP
 147 .B RLIMIT_CORE
 148 Maximum size of a
 149 .I core
 150 file (see
 151 .BR core (5)).
 152 When 0 no core dump files are created.
 153 When nonzero, larger dumps are truncated to this size.
 154 .TP
 155 .B RLIMIT_CPU
 156 CPU time limit in seconds.
 157 When the process reaches the soft limit, it is sent a
 158 .B SIGXCPU
 159 signal.
 160 The default action for this signal is to terminate the process.
 161 However, the signal can be caught, and the handler can return control to
 162 the main program.
 163 If the process continues to consume CPU time, it will be sent
 164 .B SIGXCPU
 165 once per second until the hard limit is reached, at which time
 166 it is sent
 167 .BR SIGKILL .
 168 (This latter point describes Linux behavior.
 169 Implementations vary in how they treat processes which continue to
 170 consume CPU time after reaching the soft limit.
 171 Portable applications that need to catch this signal should
 172 perform an orderly termination upon first receipt of
 173 .BR SIGXCPU .)
 174 .TP
 175 .B RLIMIT_DATA
 176 The maximum size of the process's data segment (initialized data,
 177 uninitialized data, and heap).
 178 This limit affects calls to
 179 .BR brk (2)
 180 and
 181 .BR sbrk (2),
 182 which fail with the error
 183 .B ENOMEM
 184 upon encountering the soft limit of this resource.
 185 .TP
 186 .B RLIMIT_FSIZE
 187 The maximum size of files that the process may create.
 188 Attempts to extend a file beyond this limit result in delivery of a
 189 .B SIGXFSZ
 190 signal.
 191 By default, this signal terminates a process, but a process can
 192 catch this signal instead, in which case the relevant system call (e.g.,
 193 .BR write (2),
 194 .BR truncate (2))
 195 fails with the error
 196 .BR EFBIG .
 197 .TP
 198 .BR RLIMIT_LOCKS " (Early Linux 2.4 only)"
 199 .\" to be precise: Linux 2.4.0-test9; no longer in 2.4.25 / 2.5.65
 200 A limit on the combined number of
 201 .BR flock (2)
 202 locks and
 203 .BR fcntl (2)
 204 leases that this process may establish.
 205 .TP
 206 .B RLIMIT_MEMLOCK
 207 The maximum number of bytes of memory that may be locked
 208 into RAM.
 209 In effect this limit is rounded down to the nearest multiple
 210 of the system page size.
 211 This limit affects
 212 .BR mlock (2)
 213 and
 214 .BR mlockall (2)
 215 and the
 216 .BR mmap (2)
 217 .B MAP_LOCKED
 218 operation.
 219 Since Linux 2.6.9 it also affects the
 220 .BR shmctl (2)
 221 .B SHM_LOCK
 222 operation, where it sets a maximum on the total bytes in
 223 shared memory segments (see
 224 .BR shmget (2))
 225 that may be locked by the real user ID of the calling process.
 226 The
 227 .BR shmctl (2)
 228 .B SHM_LOCK
 229 locks are accounted for separately from the per-process memory
 230 locks established by
 231 .BR mlock (2),
 232 .BR mlockall (2),
 233 and
 234 .BR mmap (2)
 235 .BR MAP_LOCKED ;
 236 a process can lock bytes up to this limit in each of these
 237 two categories.
 238 In Linux kernels before 2.6.9, this limit controlled the amount of
 239 memory that could be locked by a privileged process.
 240 Since Linux 2.6.9, no limits are placed on the amount of memory
 241 that a privileged process may lock, and this limit instead governs
 242 the amount of memory that an unprivileged process may lock.
 243 .TP
 244 .BR RLIMIT_MSGQUEUE " (since Linux 2.6.8)"
 245 Specifies the limit on the number of bytes that can be allocated
 246 for POSIX message queues for the real user ID of the calling process.
 247 This limit is enforced for
 248 .BR mq_open (3).
 249 Each message queue that the user creates counts (until it is removed)
 250 against this limit according to the formula:
 251 .nf
 252
 253     Since Linux 3.5:
 254         bytes = attr.mq_maxmsg * sizeof(struct msg_msg) +
 255                 min(attr.mq_maxmsg, MQ_PRIO_MAX) *
 256                       sizeof(struct posix_msg_tree_node)+
 257                                 /* For overhead */
 258                 attr.mq_maxmsg * attr.mq_msgsize;
 259                                 /* For message data */
 260
 261     Linux 3.4 and earlier:
 262         bytes = attr.mq_maxmsg * sizeof(struct msg_msg *) +
 263                                 /* For overhead */
 264                 attr.mq_maxmsg * attr.mq_msgsize;
 265                                 /* For message data */
 266
 267 .fi
 268 where
 269 .I attr
 270 is the
 271 .I mq_attr
 272 structure specified as the fourth argument to
 273 .BR mq_open (3),
 274 and the
 275 .I msg_msg
 276 and
 277 .I posix_msg_tree_node
 278 structures are kernel-internal structures.
 279
 280 The "overhead" addend in the formula accounts for overhead
 281 bytes required by the implementation
 282 and ensures that the user cannot
 283 create an unlimited number of zero-length messages (such messages
 284 nevertheless each consume some system memory for bookkeeping overhead).
 285 .TP
 286 .BR RLIMIT_NICE " (since Linux 2.6.12, but see BUGS below)"
 287 Specifies a ceiling to which the process's nice value can be raised using
 288 .BR setpriority (2)
 289 or
 290 .BR nice (2).
 291 The actual ceiling for the nice value is calculated as
 292 .IR "20\ \-\ rlim_cur" .
 293 (This strangeness occurs because negative numbers cannot be specified
 294 as resource limit values, since they typically have special meanings.
 295 For example,
 296 .B RLIM_INFINITY
 297 typically is the same as \-1.)
 298 .TP
 299 .B RLIMIT_NOFILE
 300 Specifies a value one greater than the maximum file descriptor number
 301 that can be opened by this process.
 302 Attempts
 303 .RB ( open (2),
 304 .BR pipe (2),
 305 .BR dup (2),
 306 etc.)
 307 to exceed this limit yield the error
 308 .BR EMFILE .
 309 (Historically, this limit was named
 310 .B RLIMIT_OFILE
 311 on BSD.)
 312 .TP
 313 .B RLIMIT_NPROC
 314 The maximum number of processes (or, more precisely on Linux, threads)
 315 that can be created for the real user ID of the calling process.
 316 Upon encountering this limit,
 317 .BR fork (2)
 318 fails with the error
 319 .BR EAGAIN .
 320 This limit is not enforced for processes that have either the
 321 .B CAP_SYS_ADMIN
 322 or the
 323 .B CAP_SYS_RESOURCE
 324 capability.
 325 .TP
 326 .B RLIMIT_RSS
 327 Specifies the limit (in bytes) of the process's resident set
 328 (the number of virtual pages resident in RAM).
 329 This limit has effect only in Linux 2.4.x, x < 30, and there
 330 affects only calls to
 331 .BR madvise (2)
 332 specifying
 333 .BR MADV_WILLNEED .
 334 .\" As at kernel 2.6.12, this limit still does nothing in 2.6 though
 335 .\" talk of making it do something has surfaced from time to time in LKML
 336 .\"       -- MTK, Jul 05
 337 .TP
 338 .BR RLIMIT_RTPRIO " (since Linux 2.6.12, but see BUGS)"
 339 Specifies a ceiling on the real-time priority that may be set for
 340 this process using
 341 .BR sched_setscheduler (2)
 342 and
 343 .BR sched_setparam (2).
 344 .TP
 345 .BR RLIMIT_RTTIME " (since Linux 2.6.25)"
 346 Specifies a limit (in microseconds)
 347 on the amount of CPU time that a process scheduled
 348 under a real-time scheduling policy may consume without making a blocking
 349 system call.
 350 For the purpose of this limit,
 351 each time a process makes a blocking system call,
 352 the count of its consumed CPU time is reset to zero.
 353 The CPU time count is not reset if the process continues trying to
 354 use the CPU but is preempted, its time slice expires, or it calls
 355 .BR sched_yield (2).
 356
 357 Upon reaching the soft limit, the process is sent a
 358 .B SIGXCPU
 359 signal.
 360 If the process catches or ignores this signal and
 361 continues consuming CPU time, then
 362 .B SIGXCPU
 363 will be generated once each second until the hard limit is reached,
 364 at which point the process is sent a
 365 .B SIGKILL
 366 signal.
 367
 368 The intended use of this limit is to stop a runaway
 369 real-time process from locking up the system.
 370 .TP
 371 .BR RLIMIT_SIGPENDING " (since Linux 2.6.8)"
 372 Specifies the limit on the number of signals
 373 that may be queued for the real user ID of the calling process.
 374 Both standard and real-time signals are counted for the purpose of
 375 checking this limit.
 376 However, the limit is enforced only for
 377 .BR sigqueue (3);
 378 it is always possible to use
 379 .BR kill (2)
 380 to queue one instance of any of the signals that are not already
 381 queued to the process.
 382 .\" This replaces the /proc/sys/kernel/rtsig-max system-wide limit
 383 .\" that was present in kernels <= 2.6.7.  MTK Dec 04
 384 .TP
 385 .B RLIMIT_STACK
 386 The maximum size of the process stack, in bytes.
 387 Upon reaching this limit, a
 388 .B SIGSEGV
 389 signal is generated.
 390 To handle this signal, a process must employ an alternate signal stack
 391 .RB ( sigaltstack (2)).
 392
 393 Since Linux 2.6.23,
 394 this limit also determines the amount of space used for the process's
 395 command-line arguments and environment variables; for details, see
 396 .BR execve (2).
 397 .SS prlimit()
 398 .\" commit c022a0acad534fd5f5d5f17280f6d4d135e74e81
 399 .\" Author: Jiri Slaby <jslaby@suse.cz>
 400 .\" Date:   Tue May 4 18:03:50 2010 +0200
 401 .\"
 402 .\"     rlimits: implement prlimit64 syscall
 403 .\"
 404 .\" commit 6a1d5e2c85d06da35cdfd93f1a27675bfdc3ad8c
 405 .\" Author: Jiri Slaby <jslaby@suse.cz>
 406 .\" Date:   Wed Mar 24 17:06:58 2010 +0100
 407 .\"
 408 .\"     rlimits: add rlimit64 structure
 409 .\"
 410 The Linux-specific
 411 .BR prlimit ()
 412 system call combines and extends the functionality of
 413 .BR setrlimit ()
 414 and
 415 .BR getrlimit ().
 416 It can be used to both set and get the resource limits of an arbitrary process.
 417
 418 The
 419 .I resource
 420 argument has the same meaning as for
 421 .BR setrlimit ()
 422 and
 423 .BR getrlimit ().
 424
 425 If the
 426 .IR new_limit
 427 argument is a not NULL, then the
 428 .I rlimit
 429 structure to which it points is used to set new values for
 430 the soft and hard limits for
 431 .IR resource .
 432 If the
 433 .IR old_limit
 434 argument is a not NULL, then a successful call to
 435 .BR prlimit ()
 436 places the previous soft and hard limits for
 437 .I resource
 438 in the
 439 .I rlimit
 440 structure pointed to by
 441 .IR old_limit .
 442
 443 The
 444 .I pid
 445 argument specifies the ID of the process on which the call is to operate.
 446 If
 447 .I pid
 448 is 0, then the call applies to the calling process.
 449 To set or get the resources of a process other than itself,
 450 the caller must have the
 451 .B CAP_SYS_RESOURCE
 452 capability in the user namespace of the process
 453 whose resource limits are being changed, or the
 454 real, effective, and saved set user IDs of the target process
 455 must match the real user ID of the caller
 456 .I and
 457 the real, effective, and saved set group IDs of the target process
 458 must match the real group ID of the caller.
 459 .\" FIXME . this permission check is strange
 460 .\" Asked about this on LKML, 7 Nov 2010
 461 .\"     "Inconsistent credential checking in prlimit() syscall"
 462 .SH RETURN VALUE
 463 On success, these system calls return 0.
 464 On error, \-1 is returned, and
 465 .I errno
 466 is set appropriately.
 467 .SH ERRORS
 468 .TP
 469 .B EFAULT
 470 A pointer argument points to a location
 471 outside the accessible address space.
 472 .TP
 473 .B EINVAL
 474 The value specified in
 475 .I resource
 476 is not valid;
 477 or, for
 478 .BR setrlimit ()
 479 or
 480 .BR prlimit ():
 481 .I rlim\->rlim_cur
 482 was greater than
 483 .IR rlim\->rlim_max .
 484 .TP
 485 .B EPERM
 486 An unprivileged process tried to raise the hard limit; the
 487 .B CAP_SYS_RESOURCE
 488 capability is required to do this.
 489 .TP
 490 .B EPERM
 491 The caller tried to increase the hard
 492 .B RLIMIT_NOFILE
 493 limit above the maximum defined by
 494 .IR /proc/sys/fs/nr_open
 495 (see
 496 .BR proc (5))
 497 .TP
 498 .B EPERM
 499 .RB ( prlimit ())
 500 The calling process did not have permission to set limits
 501 for the process specified by
 502 .IR pid .
 503 .TP
 504 .B ESRCH
 505 Could not find a process with the ID specified in
 506 .IR pid .
 507 .SH VERSIONS
 508 The
 509 .BR prlimit ()
 510 system call is available since Linux 2.6.36.
 511 Library support is available since glibc 2.13.
 512 .SH ATTRIBUTES
 513 For an explanation of the terms used in this section, see
 514 .BR attributes (7).
 515 .TS
 516 allbox;
 517 lbw35 lb lb
 518 l l l.
 519 Interface       Attribute       Value
 520 T{
 521 .BR getrlimit (),
 522 .BR setrlimit (),
 523 .BR prlimit ()
 524 T}      Thread safety   MT-Safe
 525 .TE
 526
 527 .SH CONFORMING TO
 528 .BR getrlimit (),
 529 .BR setrlimit ():
 530 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
 531 .br
 532 .BR prlimit ():
 533 Linux-specific.
 534
 535 .B RLIMIT_MEMLOCK
 536 and
 537 .B RLIMIT_NPROC
 538 derive from BSD and are not specified in POSIX.1;
 539 they are present on the BSDs and Linux, but on few other implementations.
 540 .B RLIMIT_RSS
 541 derives from BSD and is not specified in POSIX.1;
 542 it is nevertheless present on most implementations.
 543 .BR RLIMIT_MSGQUEUE ,
 544 .BR RLIMIT_NICE ,
 545 .BR RLIMIT_RTPRIO ,
 546 .BR RLIMIT_RTTIME ,
 547 and
 548 .B RLIMIT_SIGPENDING
 549 are Linux-specific.
 550 .SH NOTES
 551 A child process created via
 552 .BR fork (2)
 553 inherits its parent's resource limits.
 554 Resource limits are preserved across
 555 .BR execve (2).
 556
 557 Lowering the soft limit for a resource below the process's
 558 current consumption of that resource will succeed
 559 (but will prevent the process from further increasing
 560 its consumption of the resource).
 561
 562 One can set the resource limits of the shell using the built-in
 563 .IR ulimit
 564 command
 565 .RI ( limit
 566 in
 567 .BR csh (1)).
 568 The shell's resource limits are inherited by the processes that
 569 it creates to execute commands.
 570
 571 Since Linux 2.6.24, the resource limits of any process can be inspected via
 572 .IR /proc/[pid]/limits ;
 573 see
 574 .BR proc (5).
 575
 576 Ancient systems provided a
 577 .BR vlimit ()
 578 function with a similar purpose to
 579 .BR setrlimit ().
 580 For backward compatibility, glibc also provides
 581 .BR vlimit ().
 582 All new applications should be written using
 583 .BR setrlimit ().
 584 .SS C library/ kernel ABI differences
 585 Since version 2.13, the glibc
 586 .BR getrlimit ()
 587 and
 588 .BR setrlimit ()
 589 wrapper functions no longer invoke the corresponding system calls,
 590 but instead employ
 591 .BR prlimit (),
 592 for the reasons described in BUGS.
 593
 594 The name of the glibc wrapper function is
 595 .BR prlimit ();
 596 the underlying system call is
 597 .BR prlimit64 ().
 598 .SH BUGS
 599 In older Linux kernels, the
 600 .B SIGXCPU
 601 and
 602 .B SIGKILL
 603 signals delivered when a process encountered the soft and hard
 604 .B RLIMIT_CPU
 605 limits were delivered one (CPU) second later than they should have been.
 606 This was fixed in kernel 2.6.8.
 607
 608 In 2.6.x kernels before 2.6.17, a
 609 .B RLIMIT_CPU
 610 limit of 0 is wrongly treated as "no limit" (like
 611 .BR RLIM_INFINITY ).
 612 Since Linux 2.6.17, setting a limit of 0 does have an effect,
 613 but is actually treated as a limit of 1 second.
 614 .\" see http://marc.theaimsgroup.com/?l=linux-kernel&m=114008066530167&w=2
 615
 616 A kernel bug means that
 617 .\" See https://lwn.net/Articles/145008/
 618 .B RLIMIT_RTPRIO
 619 does not work in kernel 2.6.12; the problem is fixed in kernel 2.6.13.
 620
 621 In kernel 2.6.12, there was an off-by-one mismatch
 622 between the priority ranges returned by
 623 .BR getpriority (2)
 624 and
 625 .BR RLIMIT_NICE .
 626 This had the effect that the actual ceiling for the nice value
 627 was calculated as
 628 .IR "19\ \-\ rlim_cur" .
 629 This was fixed in kernel 2.6.13.
 630 .\" see http://marc.theaimsgroup.com/?l=linux-kernel&m=112256338703880&w=2
 631
 632 Since Linux 2.6.12,
 633 .\" The relevant patch, sent to LKML, seems to be
 634 .\" http://thread.gmane.org/gmane.linux.kernel/273462
 635 .\" From: Roland McGrath <roland <at> redhat.com>
 636 .\" Subject: [PATCH 7/7] make RLIMIT_CPU/SIGXCPU per-process
 637 .\" Date: 2005-01-23 23:27:46 GMT
 638 if a process reaches its soft
 639 .BR RLIMIT_CPU
 640 limit and has a handler installed for
 641 .BR SIGXCPU ,
 642 then, in addition to invoking the signal handler,
 643 the kernel increases the soft limit by one second.
 644 This behavior repeats if the process continues to consume CPU time,
 645 until the hard limit is reached,
 646 at which point the process is killed.
 647 Other implementations
 648 .\" Tested Solaris 10, FreeBSD 9, OpenBSD 5.0
 649 do not change the
 650 .BR RLIMIT_CPU
 651 soft limit in this manner,
 652 and the Linux behavior is probably not standards conformant;
 653 portable applications should avoid relying on this Linux-specific behavior.
 654 .\" FIXME . https://bugzilla.kernel.org/show_bug.cgi?id=50951
 655 The Linux-specific
 656 .BR RLIMIT_RTTIME
 657 limit exhibits the same behavior when the soft limit is encountered.
 658
 659 Kernels before 2.4.22 did not diagnose the error
 660 .B EINVAL
 661 for
 662 .BR setrlimit ()
 663 when
 664 .I rlim\->rlim_cur
 665 was greater than
 666 .IR rlim\->rlim_max .
 667 .\"
 668 .SS Representation of """large""" resource limit values on 32-bit platforms
 669 The glibc
 670 .BR getrlimit ()
 671 and
 672 .BR setrlimit ()
 673 wrapper functions use a 64-bit
 674 .IR rlim_t
 675 data type, even on 32-bit platforms.
 676 However, the
 677 .I rlim_t
 678 data type used in the
 679 .BR getrlimit ()
 680 and
 681 .BR setrlimit ()
 682 system calls is a (32-bit)
 683 .IR "unsigned long" .
 684 Furthermore, in Linux versions before 2.6.36,
 685 the kernel represents resource limits on 32-bit platforms as
 686 .IR "unsigned long" .
 687 However, a 32-bit data type is not wide enough.
 688 .\" https://bugzilla.kernel.org/show_bug.cgi?id=5042
 689 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=12201
 690 The most pertinent limit here is
 691 .BR RLIMIT_FSIZE ,
 692 which specifies the maximum size to which a file can grow:
 693 to be useful, this limit must be represented using a type
 694 that is as wide as the type used to
 695 represent file offsets\(emthat is, as wide as a 64-bit
 696 .BR off_t
 697 (assuming a program compiled with
 698 .IR _FILE_OFFSET_BITS=64 ).
 699
 700 To work around this kernel limitation,
 701 if a program tried to set a resource limit to a value larger than
 702 can be represented in a 32-bit
 703 .IR "unsigned long" ,
 704 then the glibc
 705 .BR setrlimit ()
 706 wrapper function silently converted the limit value to
 707 .BR RLIM_INFINITY .
 708 In other words, the requested resource limit setting was silently ignored.
 709
 710 This problem was addressed in Linux 2.6.36 with two principal changes:
 711 .IP * 3
 712 the addition of a new kernel representation of resource limits that
 713 uses 64 bits, even on 32-bit platforms;
 714 .IP *
 715 the addition of the
 716 .BR prlimit ()
 717 system call, which employs 64-bit values for its resource limit arguments.
 718 .PP
 719 Since version 2.13,
 720 .\" https://www.sourceware.org/bugzilla/show_bug.cgi?id=12201
 721 glibc works around the limitations of the
 722 .BR getrlimit ()
 723 and
 724 .BR setrlimit ()
 725 system calls by implementing
 726 .BR setrlimit ()
 727 and
 728 .BR getrlimit ()
 729 as wrapper functions that call
 730 .BR prlimit ().
 731 .SH EXAMPLE
 732 The program below demonstrates the use of
 733 .BR prlimit ().
 734 .PP
 735 .nf
 736 #define _GNU_SOURCE
 737 #define _FILE_OFFSET_BITS 64
 738 #include <stdio.h>
 739 #include <time.h>
 740 #include <stdlib.h>
 741 #include <unistd.h>
 742 #include <sys/resource.h>
 743
 744 #define errExit(msg)    do { perror(msg); exit(EXIT_FAILURE); \\
 745                         } while (0)
 746
 747 int
 748 main(int argc, char *argv[])
 749 {
 750     struct rlimit old, new;
 751     struct rlimit *newp;
 752     pid_t pid;
 753
 754     if (!(argc == 2 || argc == 4)) {
 755         fprintf(stderr, "Usage: %s <pid> [<new\-soft\-limit> "
 756                 "<new\-hard\-limit>]\\n", argv[0]);
 757         exit(EXIT_FAILURE);
 758     }
 759
 760     pid = atoi(argv[1]);        /* PID of target process */
 761
 762     newp = NULL;
 763     if (argc == 4) {
 764         new.rlim_cur = atoi(argv[2]);
 765         new.rlim_max = atoi(argv[3]);
 766         newp = &new;
 767     }
 768
 769     /* Set CPU time limit of target process; retrieve and display
 770        previous limit */
 771
 772     if (prlimit(pid, RLIMIT_CPU, newp, &old) == \-1)
 773         errExit("prlimit\-1");
 774     printf("Previous limits: soft=%lld; hard=%lld\\n",
 775             (long long) old.rlim_cur, (long long) old.rlim_max);
 776
 777     /* Retrieve and display new CPU time limit */
 778
 779     if (prlimit(pid, RLIMIT_CPU, NULL, &old) == \-1)
 780         errExit("prlimit\-2");
 781     printf("New limits: soft=%lld; hard=%lld\\n",
 782             (long long) old.rlim_cur, (long long) old.rlim_max);
 783
 784     exit(EXIT_FAILURE);
 785 }
 786 .fi
 787 .SH SEE ALSO
 788 .BR prlimit (1),
 789 .BR dup (2),
 790 .BR fcntl (2),
 791 .BR fork (2),
 792 .BR getrusage (2),
 793 .BR mlock (2),
 794 .BR mmap (2),
 795 .BR open (2),
 796 .BR quotactl (2),
 797 .BR sbrk (2),
 798 .BR shmctl (2),
 799 .BR malloc (3),
 800 .BR sigqueue (3),
 801 .BR ulimit (3),
 802 .BR core (5),
 803 .BR capabilities (7),
 804 .BR cgroups (7),
 805 .BR signal (7)