xref: /freebsd/sys/sys/resource.h (revision b0b1dbdd)
1 /*-
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)resource.h	8.4 (Berkeley) 1/9/95
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_RESOURCE_H_
34 #define	_SYS_RESOURCE_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/_timeval.h>
38 #include <sys/_types.h>
39 
40 #ifndef _ID_T_DECLARED
41 typedef	__id_t		id_t;
42 #define	_ID_T_DECLARED
43 #endif
44 
45 #ifndef _RLIM_T_DECLARED
46 typedef	__rlim_t	rlim_t;
47 #define	_RLIM_T_DECLARED
48 #endif
49 
50 /*
51  * Process priority specifications to get/setpriority.
52  */
53 #define	PRIO_MIN	-20
54 #define	PRIO_MAX	20
55 
56 #define	PRIO_PROCESS	0
57 #define	PRIO_PGRP	1
58 #define	PRIO_USER	2
59 
60 /*
61  * Resource utilization information.
62  *
63  * All fields are only modified by curthread and
64  * no locks are required to read.
65  */
66 
67 #define	RUSAGE_SELF	0
68 #define	RUSAGE_CHILDREN	-1
69 #define	RUSAGE_THREAD	1
70 
71 struct rusage {
72 	struct timeval ru_utime;	/* user time used */
73 	struct timeval ru_stime;	/* system time used */
74 	long	ru_maxrss;		/* max resident set size */
75 #define	ru_first	ru_ixrss
76 	long	ru_ixrss;		/* integral shared memory size */
77 	long	ru_idrss;		/* integral unshared data " */
78 	long	ru_isrss;		/* integral unshared stack " */
79 	long	ru_minflt;		/* page reclaims */
80 	long	ru_majflt;		/* page faults */
81 	long	ru_nswap;		/* swaps */
82 	long	ru_inblock;		/* block input operations */
83 	long	ru_oublock;		/* block output operations */
84 	long	ru_msgsnd;		/* messages sent */
85 	long	ru_msgrcv;		/* messages received */
86 	long	ru_nsignals;		/* signals received */
87 	long	ru_nvcsw;		/* voluntary context switches */
88 	long	ru_nivcsw;		/* involuntary " */
89 #define	ru_last		ru_nivcsw
90 };
91 
92 #if __BSD_VISIBLE
93 struct __wrusage {
94 	struct rusage	wru_self;
95 	struct rusage	wru_children;
96 };
97 #endif
98 
99 /*
100  * Resource limits
101  */
102 #define	RLIMIT_CPU	0		/* maximum cpu time in seconds */
103 #define	RLIMIT_FSIZE	1		/* maximum file size */
104 #define	RLIMIT_DATA	2		/* data size */
105 #define	RLIMIT_STACK	3		/* stack size */
106 #define	RLIMIT_CORE	4		/* core file size */
107 #define	RLIMIT_RSS	5		/* resident set size */
108 #define	RLIMIT_MEMLOCK	6		/* locked-in-memory address space */
109 #define	RLIMIT_NPROC	7		/* number of processes */
110 #define	RLIMIT_NOFILE	8		/* number of open files */
111 #define	RLIMIT_SBSIZE	9		/* maximum size of all socket buffers */
112 #define	RLIMIT_VMEM	10		/* virtual process size (incl. mmap) */
113 #define	RLIMIT_AS	RLIMIT_VMEM	/* standard name for RLIMIT_VMEM */
114 #define	RLIMIT_NPTS	11		/* pseudo-terminals */
115 #define	RLIMIT_SWAP	12		/* swap used */
116 #define	RLIMIT_KQUEUES	13		/* kqueues allocated */
117 #define	RLIMIT_UMTXP	14		/* process-shared umtx */
118 
119 #define	RLIM_NLIMITS	15		/* number of resource limits */
120 
121 #define	RLIM_INFINITY	((rlim_t)(((__uint64_t)1 << 63) - 1))
122 #define	RLIM_SAVED_MAX	RLIM_INFINITY
123 #define	RLIM_SAVED_CUR	RLIM_INFINITY
124 
125 /*
126  * Resource limit string identifiers
127  */
128 
129 #ifdef _RLIMIT_IDENT
130 static const char *rlimit_ident[RLIM_NLIMITS] = {
131 	"cpu",
132 	"fsize",
133 	"data",
134 	"stack",
135 	"core",
136 	"rss",
137 	"memlock",
138 	"nproc",
139 	"nofile",
140 	"sbsize",
141 	"vmem",
142 	"npts",
143 	"swap",
144 	"kqueues",
145 	"umtx",
146 };
147 #endif
148 
149 struct rlimit {
150 	rlim_t	rlim_cur;		/* current (soft) limit */
151 	rlim_t	rlim_max;		/* maximum value for rlim_cur */
152 };
153 
154 #if __BSD_VISIBLE
155 
156 struct orlimit {
157 	__int32_t	rlim_cur;	/* current (soft) limit */
158 	__int32_t	rlim_max;	/* maximum value for rlim_cur */
159 };
160 
161 struct loadavg {
162 	__fixpt_t	ldavg[3];
163 	long		fscale;
164 };
165 
166 #define	CP_USER		0
167 #define	CP_NICE		1
168 #define	CP_SYS		2
169 #define	CP_INTR		3
170 #define	CP_IDLE		4
171 #define	CPUSTATES	5
172 
173 #endif	/* __BSD_VISIBLE */
174 
175 #ifdef _KERNEL
176 
177 extern struct loadavg averunnable;
178 void	read_cpu_time(long *cp_time);	/* Writes array of CPUSTATES */
179 
180 #else
181 
182 __BEGIN_DECLS
183 /* XXX 2nd arg to [gs]etpriority() should be an id_t */
184 int	getpriority(int, int);
185 int	getrlimit(int, struct rlimit *);
186 int	getrusage(int, struct rusage *);
187 int	setpriority(int, int, int);
188 int	setrlimit(int, const struct rlimit *);
189 __END_DECLS
190 
191 #endif	/* _KERNEL */
192 #endif	/* !_SYS_RESOURCE_H_ */
193