xref: /freebsd/sys/sys/resource.h (revision 42249ef2)
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  *	@(#)resource.h	8.4 (Berkeley) 1/9/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _SYS_RESOURCE_H_
36 #define	_SYS_RESOURCE_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/_timeval.h>
40 #include <sys/_types.h>
41 
42 #ifndef _ID_T_DECLARED
43 typedef	__id_t		id_t;
44 #define	_ID_T_DECLARED
45 #endif
46 
47 #ifndef _RLIM_T_DECLARED
48 typedef	__rlim_t	rlim_t;
49 #define	_RLIM_T_DECLARED
50 #endif
51 
52 /*
53  * Process priority specifications to get/setpriority.
54  */
55 #define	PRIO_MIN	-20
56 #define	PRIO_MAX	20
57 
58 #define	PRIO_PROCESS	0
59 #define	PRIO_PGRP	1
60 #define	PRIO_USER	2
61 
62 /*
63  * Resource utilization information.
64  *
65  * All fields are only modified by curthread and
66  * no locks are required to read.
67  */
68 
69 #define	RUSAGE_SELF	0
70 #define	RUSAGE_CHILDREN	-1
71 #define	RUSAGE_THREAD	1
72 
73 struct rusage {
74 	struct timeval ru_utime;	/* user time used */
75 	struct timeval ru_stime;	/* system time used */
76 	long	ru_maxrss;		/* max resident set size */
77 #define	ru_first	ru_ixrss
78 	long	ru_ixrss;		/* integral shared memory size */
79 	long	ru_idrss;		/* integral unshared data " */
80 	long	ru_isrss;		/* integral unshared stack " */
81 	long	ru_minflt;		/* page reclaims */
82 	long	ru_majflt;		/* page faults */
83 	long	ru_nswap;		/* swaps */
84 	long	ru_inblock;		/* block input operations */
85 	long	ru_oublock;		/* block output operations */
86 	long	ru_msgsnd;		/* messages sent */
87 	long	ru_msgrcv;		/* messages received */
88 	long	ru_nsignals;		/* signals received */
89 	long	ru_nvcsw;		/* voluntary context switches */
90 	long	ru_nivcsw;		/* involuntary " */
91 #define	ru_last		ru_nivcsw
92 };
93 
94 #if __BSD_VISIBLE
95 struct __wrusage {
96 	struct rusage	wru_self;
97 	struct rusage	wru_children;
98 };
99 #endif
100 
101 /*
102  * Resource limits
103  */
104 #define	RLIMIT_CPU	0		/* maximum cpu time in seconds */
105 #define	RLIMIT_FSIZE	1		/* maximum file size */
106 #define	RLIMIT_DATA	2		/* data size */
107 #define	RLIMIT_STACK	3		/* stack size */
108 #define	RLIMIT_CORE	4		/* core file size */
109 #define	RLIMIT_RSS	5		/* resident set size */
110 #define	RLIMIT_MEMLOCK	6		/* locked-in-memory address space */
111 #define	RLIMIT_NPROC	7		/* number of processes */
112 #define	RLIMIT_NOFILE	8		/* number of open files */
113 #define	RLIMIT_SBSIZE	9		/* maximum size of all socket buffers */
114 #define	RLIMIT_VMEM	10		/* virtual process size (incl. mmap) */
115 #define	RLIMIT_AS	RLIMIT_VMEM	/* standard name for RLIMIT_VMEM */
116 #define	RLIMIT_NPTS	11		/* pseudo-terminals */
117 #define	RLIMIT_SWAP	12		/* swap used */
118 #define	RLIMIT_KQUEUES	13		/* kqueues allocated */
119 #define	RLIMIT_UMTXP	14		/* process-shared umtx */
120 
121 #define	RLIM_NLIMITS	15		/* number of resource limits */
122 
123 #define	RLIM_INFINITY	((rlim_t)(((__uint64_t)1 << 63) - 1))
124 #define	RLIM_SAVED_MAX	RLIM_INFINITY
125 #define	RLIM_SAVED_CUR	RLIM_INFINITY
126 
127 /*
128  * Resource limit string identifiers
129  */
130 
131 #ifdef _RLIMIT_IDENT
132 static const char *rlimit_ident[RLIM_NLIMITS] = {
133 	"cpu",
134 	"fsize",
135 	"data",
136 	"stack",
137 	"core",
138 	"rss",
139 	"memlock",
140 	"nproc",
141 	"nofile",
142 	"sbsize",
143 	"vmem",
144 	"npts",
145 	"swap",
146 	"kqueues",
147 	"umtx",
148 };
149 #endif
150 
151 struct rlimit {
152 	rlim_t	rlim_cur;		/* current (soft) limit */
153 	rlim_t	rlim_max;		/* maximum value for rlim_cur */
154 };
155 
156 #if __BSD_VISIBLE
157 
158 struct orlimit {
159 	__int32_t	rlim_cur;	/* current (soft) limit */
160 	__int32_t	rlim_max;	/* maximum value for rlim_cur */
161 };
162 
163 struct loadavg {
164 	__fixpt_t	ldavg[3];
165 	long		fscale;
166 };
167 
168 #define	CP_USER		0
169 #define	CP_NICE		1
170 #define	CP_SYS		2
171 #define	CP_INTR		3
172 #define	CP_IDLE		4
173 #define	CPUSTATES	5
174 
175 #endif	/* __BSD_VISIBLE */
176 
177 #ifdef _KERNEL
178 
179 extern struct loadavg averunnable;
180 void	read_cpu_time(long *cp_time);	/* Writes array of CPUSTATES */
181 
182 #else
183 
184 __BEGIN_DECLS
185 /* XXX 2nd arg to [gs]etpriority() should be an id_t */
186 int	getpriority(int, int);
187 int	getrlimit(int, struct rlimit *);
188 int	getrusage(int, struct rusage *);
189 int	setpriority(int, int, int);
190 int	setrlimit(int, const struct rlimit *);
191 __END_DECLS
192 
193 #endif	/* _KERNEL */
194 #endif	/* !_SYS_RESOURCE_H_ */
195