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