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