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