Define LFS types.
[kopensolaris-gnu/glibc.git] / bits / resource.h
1 /* Bit values & structures for resource limits.  4.4 BSD/generic GNU 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 /* These are the values for 4.4 BSD and GNU.  Earlier BSD systems have a
21    subset of these kinds of resource limit.  In systems where `getrlimit'
22    and `setrlimit' are not system calls, these are the values used by the C
23    library to emulate them.  */
24
25 /* Kinds of resource limit.  */
26 enum __rlimit_resource
27   {
28     /* Per-process CPU limit, in seconds.  */
29     RLIMIT_CPU,
30 #define RLIMIT_CPU      RLIMIT_CPU
31     /* Largest file that can be created, in bytes.  */
32     RLIMIT_FSIZE,
33 #define RLIMIT_FSIZE    RLIMIT_FSIZE
34     /* Maximum size of data segment, in bytes.  */
35     RLIMIT_DATA,
36 #define RLIMIT_DATA     RLIMIT_DATA
37     /* Maximum size of stack segment, in bytes.  */
38     RLIMIT_STACK,
39 #define RLIMIT_STACK    RLIMIT_STACK
40     /* Largest core file that can be created, in bytes.  */
41     RLIMIT_CORE,
42 #define RLIMIT_CORE     RLIMIT_CORE
43     /* Largest resident set size, in bytes.
44        This affects swapping; processes that are exceeding their
45        resident set size will be more likely to have physical memory
46        taken from them.  */
47     RLIMIT_RSS,
48 #define RLIMIT_RSS      RLIMIT_RSS
49     /* Locked-in-memory address space.  */
50     RLIMIT_MEMLOCK,
51 #define RLIMIT_MEMLOCK  RLIMIT_MEMLOCK
52     /* Number of processes.  */
53     RLIMIT_NPROC,
54 #define RLIMIT_NPROC    RLIMIT_NPROC
55     /* Number of open files.  */
56     RLIMIT_OFILE,
57     RLIMIT_NOFILE = RLIMIT_OFILE, /* Another name for the same thing.  */
58 #define RLIMIT_OFILE    RLIMIT_OFILE
59 #define RLIMIT_NOFILE   RLIMIT_NOFILE
60
61     RLIMIT_NLIMITS,             /* Number of limit flavors.  */
62     RLIM_NLIMITS = RLIMIT_NLIMITS, /* Traditional name for same.  */
63
64     RLIM_INFINITY = 0x7fffffff /* Value to indicate that there is no limit.  */
65 #define RLIM_INFINITY RLIM_INFINITY
66   };
67
68 /* Type for resource quantity measurement.  */
69 #ifndef __USE_FILE_OFFSET64
70 typedef __rlim_t rlim_t;
71 #else
72 typedef __rlim64_t rlim_t;
73 #endif
74 #ifdef __USE_LARGEFILE64
75 typedef __rlim64_t rlim64_t;
76 #endif
77
78 struct rlimit
79   {
80     /* The current (soft) limit.  */
81     rlim_t rlim_cur;
82     /* The hard limit.  */
83     rlim_t rlim_max;
84   };
85
86 #ifdef __USE_LARGEFILE64
87 struct rlimit64
88   {
89     /* The current (soft) limit.  */
90     rlim64_t rlim_cur;
91     /* The hard limit.  */
92     rlim64_t rlim_max;
93  };
94 #endif
95
96 /* Whose usage statistics do you want?  */
97 enum __rusage_who
98 /* The macro definitions are necessary because some programs want
99    to test for operating system features with #ifdef RUSAGE_SELF.
100    In ISO C the reflexive definition is a no-op.  */
101   {
102     /* The calling process.  */
103     RUSAGE_SELF = 0,
104 #define RUSAGE_SELF     RUSAGE_SELF
105     /* All of its terminated child processes.  */
106     RUSAGE_CHILDREN = -1
107 #define RUSAGE_CHILDREN RUSAGE_CHILDREN
108   };
109
110 #include <sys/time.h>           /* For `struct timeval'.  */
111
112 /* Structure which says how much of each resource has been used.  */
113 struct rusage
114   {
115     /* Total amount of user time used.  */
116     struct timeval ru_utime;
117     /* Total amount of system time used.  */
118     struct timeval ru_stime;
119     /* Maximum resident set size (in kilobytes).  */
120     long int ru_maxrss;
121     /* Amount of sharing of text segment memory
122        with other processes (kilobyte-seconds).  */
123     long int ru_ixrss;
124     /* Amount of data segment memory used (kilobyte-seconds).  */
125     long int ru_idrss;
126     /* Amount of stack memory used (kilobyte-seconds).  */
127     long int ru_isrss;
128     /* Number of soft page faults (i.e. those serviced by reclaiming
129        a page from the list of pages awaiting reallocation.  */
130     long int ru_minflt;
131     /* Number of hard page faults (i.e. those that required I/O).  */
132     long int ru_majflt;
133     /* Number of times a process was swapped out of physical memory.  */
134     long int ru_nswap;
135     /* Number of input operations via the file system.  Note: This
136        and `ru_oublock' do not include operations with the cache.  */
137     long int ru_inblock;
138     /* Number of output operations via the file system.  */
139     long int ru_oublock;
140     /* Number of IPC messages sent.  */
141     long int ru_msgsnd;
142     /* Number of IPC messages received.  */
143     long int ru_msgrcv;
144     /* Number of signals delivered.  */
145     long int ru_nsignals;
146     /* Number of voluntary context switches, i.e. because the process
147        gave up the process before it had to (usually to wait for some
148        resource to be available).  */
149     long int ru_nvcsw;
150     /* Number of involuntary context switches, i.e. a higher priority process
151        became runnable or the current process used up its time slice.  */
152     long int ru_nivcsw;
153   };
154
155 /* Priority limits.  */
156 #define PRIO_MIN        -20     /* Minimum priority a process can have.  */
157 #define PRIO_MAX        20      /* Maximum priority a process can have.  */
158
159 /* The type of the WHICH argument to `getpriority' and `setpriority',
160    indicating what flavor of entity the WHO argument specifies.  */
161 enum __priority_which
162   {
163     PRIO_PROCESS = 0,           /* WHO is a process ID.  */
164     PRIO_PGRP = 1,              /* WHO is a process group ID.  */
165     PRIO_USER = 2               /* WHO is a user ID.  */
166   };