Issue error message if the header is used directly.
[kopensolaris-gnu/glibc.git] / sysdeps / unix / sysv / linux / bits / resource.h
1 /* Bit values & structures for resource limits.  Linux version.
2    Copyright (C) 1994, 1996, 1997 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 Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    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    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef _SYS_RESOURCE_H
21 # error "Never use <bits/resource.h> directly; include <sys/resource.h> instead."
22 #endif
23
24 #include <asm/resource.h>
25 #include <bits/types.h>
26
27 /* Transmute defines to enumerations.  The macro re-definitions are
28    necessary because some programs want to test for operating system
29    features with #ifdef RUSAGE_SELF.  In ISO C the reflexive
30    definition is a no-op.  */
31
32 /* Kinds of resource limit.  */
33 enum __rlimit_resource
34 {
35   /* Per-process CPU limit, in seconds.  */
36   _RLIMIT_CPU = RLIMIT_CPU,
37 #undef RLIMIT_CPU
38   RLIMIT_CPU = _RLIMIT_CPU,
39 #define RLIMIT_CPU RLIMIT_CPU
40
41   /* Largest file that can be created, in bytes.  */
42   _RLIMIT_FSIZE = RLIMIT_FSIZE,
43 #undef RLIMIT_FSIZE
44   RLIMIT_FSIZE = _RLIMIT_FSIZE,
45 #define RLIMIT_FSIZE RLIMIT_FSIZE
46
47   /* Maximum size of data segment, in bytes.  */
48   _RLIMIT_DATA = RLIMIT_DATA,
49 #undef RLIMIT_DATA
50   RLIMIT_DATA = _RLIMIT_DATA,
51 #define RLIMIT_DATA RLIMIT_DATA
52
53   /* Maximum size of stack segment, in bytes.  */
54   _RLIMIT_STACK = RLIMIT_STACK,
55 #undef RLIMIT_STACK
56   RLIMIT_STACK = _RLIMIT_STACK,
57 #define RLIMIT_STACK RLIMIT_STACK
58
59   /* Largest core file that can be created, in bytes.  */
60   _RLIMIT_CORE = RLIMIT_CORE,
61 #undef RLIMIT_CORE
62   RLIMIT_CORE = _RLIMIT_CORE,
63 #define RLIMIT_CORE RLIMIT_CORE
64
65   /* Largest resident set size, in bytes.
66      This affects swapping; processes that are exceeding their
67      resident set size will be more likely to have physical memory
68      taken from them.  */
69   _RLIMIT_RSS = RLIMIT_RSS,
70 #undef RLIMIT_RSS
71   RLIMIT_RSS = _RLIMIT_RSS,
72 #define RLIMIT_RSS RLIMIT_RSS
73
74   /* Number of open files.  */
75   _RLIMIT_NOFILE = RLIMIT_NOFILE,
76 #undef RLIMIT_NOFILE
77   RLIMIT_NOFILE = _RLIMIT_NOFILE,
78   RLIMIT_OFILE = RLIMIT_NOFILE, /* BSD name for same.  */
79 #define RLIMIT_NOFILE RLIMIT_NOFILE
80 #define RLIMIT_OFILE RLIMIT_OFILE
81
82   /* Address space limit (?) */
83   _RLIMIT_AS = RLIMIT_AS,
84 #undef RLIMIT_AS
85   RLIMIT_AS = _RLIMIT_AS,
86 #define RLIMIT_AS RLIMIT_AS
87
88   /* Number of processes.  */
89   _RLIMIT_NPROC = RLIMIT_NPROC,
90 #undef RLIMIT_NPROC
91   RLIMIT_NPROC = _RLIMIT_NPROC,
92 #define RLIMIT_NPROC RLIMIT_NPROC
93
94   /* Locked-in-memory address space.  */
95   _RLIMIT_MEMLOCK = RLIMIT_MEMLOCK,
96 #undef RLIMIT_MEMLOCK
97   RLIMIT_MEMLOCK = _RLIMIT_MEMLOCK,
98 #define RLIMIT_MEMLOCK RLIMIT_MEMLOCK
99
100   RLIMIT_NLIMITS = RLIM_NLIMITS,
101 #undef RLIM_NLIMITS
102   RLIM_NLIMITS = RLIMIT_NLIMITS,
103 #define RLIMIT_NLIMITS RLIMIT_NLIMITS
104 #define RLIM_NLIMITS RLIM_NLIMITS
105
106   /* Value to indicate that there is no limit.  */
107   RLIM_INFINITY = (long int)(~0UL >> 1)
108 #define RLIM_INFINITY RLIM_INFINITY
109 };
110
111 /* Type for resource quantity measurement.  */
112 #ifndef __USE_FILE_OFFSET64
113 typedef __rlim_t rlim_t;
114 #else
115 typedef __rlim64_t rlim_t;
116 #endif
117 #ifdef __USE_LARGEFILE64
118 typedef __rlim64_t rlim64_t;
119 #endif
120
121 struct rlimit
122   {
123     /* The current (soft) limit.  */
124     rlim_t rlim_cur;
125     /* The hard limit.  */
126     rlim_t rlim_max;
127   };
128
129 #ifdef __USE_LARGEFILE64
130 struct rlimit64
131   {
132     /* The current (soft) limit.  */
133     rlim64_t rlim_cur;
134     /* The hard limit.  */
135     rlim64_t rlim_max;
136  };
137 #endif
138
139 /* Whose usage statistics do you want?  */
140 enum __rusage_who
141 {
142   /* The calling process.  */
143   RUSAGE_SELF = 0,
144 #define RUSAGE_SELF RUSAGE_SELF
145
146   /* All of its terminated child processes.  */
147   RUSAGE_CHILDREN = -1,
148 #define RUSAGE_CHILDREN RUSAGE_CHILDREN
149
150   /* Both.  */
151   RUSAGE_BOTH = -2
152 #define RUSAGE_BOTH RUSAGE_BOTH
153 };
154
155 #define __need_timeval
156 #include <bits/time.h>          /* For `struct timeval'.  */
157
158 /* Structure which says how much of each resource has been used.  */
159 struct rusage
160   {
161     /* Total amount of user time used.  */
162     struct timeval ru_utime;
163     /* Total amount of system time used.  */
164     struct timeval ru_stime;
165     /* Maximum resident set size (in kilobytes).  */
166     long int ru_maxrss;
167     /* Amount of sharing of text segment memory
168        with other processes (kilobyte-seconds).  */
169     long int ru_ixrss;
170     /* Amount of data segment memory used (kilobyte-seconds).  */
171     long int ru_idrss;
172     /* Amount of stack memory used (kilobyte-seconds).  */
173     long int ru_isrss;
174     /* Number of soft page faults (i.e. those serviced by reclaiming
175        a page from the list of pages awaiting reallocation.  */
176     long int ru_minflt;
177     /* Number of hard page faults (i.e. those that required I/O).  */
178     long int ru_majflt;
179     /* Number of times a process was swapped out of physical memory.  */
180     long int ru_nswap;
181     /* Number of input operations via the file system.  Note: This
182        and `ru_oublock' do not include operations with the cache.  */
183     long int ru_inblock;
184     /* Number of output operations via the file system.  */
185     long int ru_oublock;
186     /* Number of IPC messages sent.  */
187     long int ru_msgsnd;
188     /* Number of IPC messages received.  */
189     long int ru_msgrcv;
190     /* Number of signals delivered.  */
191     long int ru_nsignals;
192     /* Number of voluntary context switches, i.e. because the process
193        gave up the process before it had to (usually to wait for some
194        resource to be available).  */
195     long int ru_nvcsw;
196     /* Number of involuntary context switches, i.e. a higher priority process
197        became runnable or the current process used up its time slice.  */
198     long int ru_nivcsw;
199   };
200
201 /* Priority limits.  */
202 #define PRIO_MIN        -20     /* Minimum priority a process can have.  */
203 #define PRIO_MAX        20      /* Maximum priority a process can have.  */
204
205 /* The type of the WHICH argument to `getpriority' and `setpriority',
206    indicating what flavor of entity the WHO argument specifies.  */
207 enum __priority_which
208 {
209   PRIO_PROCESS = 0,             /* WHO is a process ID.  */
210   PRIO_PGRP = 1,                /* WHO is a process group ID.  */
211   PRIO_USER = 2                 /* WHO is a user ID.  */
212 };