master
  1/* Bit values & structures for resource limits.  Linux version.
  2   Copyright (C) 1994-2025 Free Software Foundation, Inc.
  3   This file is part of the GNU C Library.
  4
  5   The GNU C Library is free software; you can redistribute it and/or
  6   modify it under the terms of the GNU Lesser General Public
  7   License as published by the Free Software Foundation; either
  8   version 2.1 of the License, or (at your option) any later version.
  9
 10   The GNU C Library is distributed in the hope that it will be useful,
 11   but WITHOUT ANY WARRANTY; without even the implied warranty of
 12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 13   Lesser General Public License for more details.
 14
 15   You should have received a copy of the GNU Lesser General Public
 16   License along with the GNU C Library; if not, see
 17   <https://www.gnu.org/licenses/>.  */
 18
 19#ifndef _SYS_RESOURCE_H
 20# error "Never use <bits/resource.h> directly; include <sys/resource.h> instead."
 21#endif
 22
 23#include <bits/types.h>
 24
 25/* Transmute defines to enumerations.  The macro re-definitions are
 26   necessary because some programs want to test for operating system
 27   features with #ifdef RUSAGE_SELF.  In ISO C the reflexive
 28   definition is a no-op.  */
 29
 30/* Kinds of resource limit.  */
 31enum __rlimit_resource
 32{
 33  /* Per-process CPU limit, in seconds.  */
 34  RLIMIT_CPU = 0,
 35#define RLIMIT_CPU RLIMIT_CPU
 36
 37  /* Largest file that can be created, in bytes.  */
 38  RLIMIT_FSIZE = 1,
 39#define	RLIMIT_FSIZE RLIMIT_FSIZE
 40
 41  /* Maximum size of data segment, in bytes.  */
 42  RLIMIT_DATA = 2,
 43#define	RLIMIT_DATA RLIMIT_DATA
 44
 45  /* Maximum size of stack segment, in bytes.  */
 46  RLIMIT_STACK = 3,
 47#define	RLIMIT_STACK RLIMIT_STACK
 48
 49  /* Largest core file that can be created, in bytes.  */
 50  RLIMIT_CORE = 4,
 51#define	RLIMIT_CORE RLIMIT_CORE
 52
 53  /* Largest resident set size, in bytes.
 54     This affects swapping; processes that are exceeding their
 55     resident set size will be more likely to have physical memory
 56     taken from them.  */
 57  __RLIMIT_RSS = 5,
 58#define	RLIMIT_RSS __RLIMIT_RSS
 59
 60  /* Number of open files.  */
 61  RLIMIT_NOFILE = 7,
 62  __RLIMIT_OFILE = RLIMIT_NOFILE, /* BSD name for same.  */
 63#define RLIMIT_NOFILE RLIMIT_NOFILE
 64#define RLIMIT_OFILE __RLIMIT_OFILE
 65
 66  /* Address space limit.  */
 67  RLIMIT_AS = 9,
 68#define RLIMIT_AS RLIMIT_AS
 69
 70  /* Number of processes.  */
 71  __RLIMIT_NPROC = 6,
 72#define RLIMIT_NPROC __RLIMIT_NPROC
 73
 74  /* Locked-in-memory address space.  */
 75  __RLIMIT_MEMLOCK = 8,
 76#define RLIMIT_MEMLOCK __RLIMIT_MEMLOCK
 77
 78  /* Maximum number of file locks.  */
 79  __RLIMIT_LOCKS = 10,
 80#define RLIMIT_LOCKS __RLIMIT_LOCKS
 81
 82  /* Maximum number of pending signals.  */
 83  __RLIMIT_SIGPENDING = 11,
 84#define RLIMIT_SIGPENDING __RLIMIT_SIGPENDING
 85
 86  /* Maximum bytes in POSIX message queues.  */
 87  __RLIMIT_MSGQUEUE = 12,
 88#define RLIMIT_MSGQUEUE __RLIMIT_MSGQUEUE
 89
 90  /* Maximum nice priority allowed to raise to.
 91     Nice levels 19 .. -20 correspond to 0 .. 39
 92     values of this resource limit.  */
 93  __RLIMIT_NICE = 13,
 94#define RLIMIT_NICE __RLIMIT_NICE
 95
 96  /* Maximum realtime priority allowed for non-priviledged
 97     processes.  */
 98  __RLIMIT_RTPRIO = 14,
 99#define RLIMIT_RTPRIO __RLIMIT_RTPRIO
100
101  /* Maximum CPU time in microseconds that a process scheduled under a real-time
102     scheduling policy may consume without making a blocking system
103     call before being forcibly descheduled.  */
104  __RLIMIT_RTTIME = 15,
105#define RLIMIT_RTTIME __RLIMIT_RTTIME
106
107  __RLIMIT_NLIMITS = 16,
108  __RLIM_NLIMITS = __RLIMIT_NLIMITS
109#define RLIMIT_NLIMITS __RLIMIT_NLIMITS
110#define RLIM_NLIMITS __RLIM_NLIMITS
111};
112
113/* Value to indicate that there is no limit.  */
114#ifndef __USE_FILE_OFFSET64
115# define RLIM_INFINITY ((__rlim_t) -1)
116#else
117# define RLIM_INFINITY 0xffffffffffffffffuLL
118#endif
119
120#ifdef __USE_LARGEFILE64
121# define RLIM64_INFINITY 0xffffffffffffffffuLL
122#endif
123
124/* We can represent all limits.  */
125#define RLIM_SAVED_MAX	RLIM_INFINITY
126#define RLIM_SAVED_CUR	RLIM_INFINITY
127
128
129/* Type for resource quantity measurement.  */
130#ifndef __USE_FILE_OFFSET64
131typedef __rlim_t rlim_t;
132#else
133typedef __rlim64_t rlim_t;
134#endif
135#ifdef __USE_LARGEFILE64
136typedef __rlim64_t rlim64_t;
137#endif
138
139struct rlimit
140  {
141    /* The current (soft) limit.  */
142    rlim_t rlim_cur;
143    /* The hard limit.  */
144    rlim_t rlim_max;
145  };
146
147#ifdef __USE_LARGEFILE64
148struct rlimit64
149  {
150    /* The current (soft) limit.  */
151    rlim64_t rlim_cur;
152    /* The hard limit.  */
153    rlim64_t rlim_max;
154 };
155#endif
156
157/* Whose usage statistics do you want?  */
158enum __rusage_who
159{
160  /* The calling process.  */
161  RUSAGE_SELF = 0,
162#define RUSAGE_SELF RUSAGE_SELF
163
164  /* All of its terminated child processes.  */
165  RUSAGE_CHILDREN = -1
166#define RUSAGE_CHILDREN RUSAGE_CHILDREN
167
168#ifdef __USE_GNU
169  ,
170  /* The calling thread.  */
171  RUSAGE_THREAD = 1
172# define RUSAGE_THREAD RUSAGE_THREAD
173  /* Name for the same functionality on Solaris.  */
174# define RUSAGE_LWP RUSAGE_THREAD
175#endif
176};
177
178#include <bits/types/struct_timeval.h>
179#include <bits/types/struct_rusage.h>
180
181/* Priority limits.  */
182#define PRIO_MIN	-20	/* Minimum priority a process can have.  */
183#define PRIO_MAX	20	/* Maximum priority a process can have.  */
184
185/* The type of the WHICH argument to `getpriority' and `setpriority',
186   indicating what flavor of entity the WHO argument specifies.  */
187enum __priority_which
188{
189  PRIO_PROCESS = 0,		/* WHO is a process ID.  */
190#define PRIO_PROCESS PRIO_PROCESS
191  PRIO_PGRP = 1,		/* WHO is a process group ID.  */
192#define PRIO_PGRP PRIO_PGRP
193  PRIO_USER = 2			/* WHO is a user ID.  */
194#define PRIO_USER PRIO_USER
195};
196
197
198__BEGIN_DECLS
199
200#ifdef __USE_GNU
201/* Modify and return resource limits of a process atomically.  */
202# ifndef __USE_FILE_OFFSET64
203extern int prlimit (__pid_t __pid, enum __rlimit_resource __resource,
204		    const struct rlimit *__new_limit,
205		    struct rlimit *__old_limit) __THROW;
206# else
207#  ifdef __REDIRECT_NTH
208extern int __REDIRECT_NTH (prlimit, (__pid_t __pid,
209				     enum __rlimit_resource __resource,
210				     const struct rlimit *__new_limit,
211				     struct rlimit *__old_limit), prlimit64);
212#  else
213#   define prlimit prlimit64
214#  endif
215# endif
216# ifdef __USE_LARGEFILE64
217extern int prlimit64 (__pid_t __pid, enum __rlimit_resource __resource,
218		      const struct rlimit64 *__new_limit,
219		      struct rlimit64 *__old_limit) __THROW;
220# endif
221#endif
222
223__END_DECLS