xref: /dragonfly/sys/sys/resource.h (revision 277350a0)
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: src/sys/sys/resource.h,v 1.12.2.2 2002/08/20 18:42:20 dillon Exp $
31  */
32 
33 #ifndef _SYS_RESOURCE_H_
34 #define	_SYS_RESOURCE_H_
35 
36 #include <sys/cdefs.h>
37 #ifndef _SYS_TYPES_H_
38 #include <sys/types.h>
39 #endif
40 #include <sys/_timeval.h>
41 
42 /*
43  * Process priority specifications to get/setpriority.
44  */
45 #define	PRIO_MIN	-20
46 #define	PRIO_MAX	20
47 
48 #if __BSD_VISIBLE
49 #define	IOPRIO_MIN	1
50 #define	IOPRIO_MAX	10
51 #endif
52 
53 #define	PRIO_PROCESS	0
54 #define	PRIO_PGRP	1
55 #define	PRIO_USER	2
56 
57 /*
58  * Resource utilization information.
59  */
60 
61 #define	RUSAGE_SELF	0
62 #define	RUSAGE_CHILDREN	-1
63 
64 struct	rusage {
65 	struct timeval ru_utime;	/* user time used */
66 	struct timeval ru_stime;	/* system time used */
67 	long	ru_maxrss;		/* max resident set size */
68 #define	ru_first	ru_ixrss
69 	long	ru_ixrss;		/* integral shared memory size */
70 	long	ru_idrss;		/* integral unshared data " */
71 	long	ru_isrss;		/* integral unshared stack " */
72 	long	ru_minflt;		/* page reclaims */
73 	long	ru_majflt;		/* page faults */
74 	long	ru_nswap;		/* swaps */
75 	long	ru_inblock;		/* block input operations */
76 	long	ru_oublock;		/* block output operations */
77 	long	ru_msgsnd;		/* messages sent */
78 	long	ru_msgrcv;		/* messages received */
79 	long	ru_nsignals;		/* signals received */
80 	long	ru_nvcsw;		/* voluntary context switches */
81 	long	ru_nivcsw;		/* involuntary " */
82 #define	ru_last		ru_nivcsw
83 };
84 
85 /*
86  * Resource limits
87  */
88 #define	RLIMIT_CPU	0		/* cpu time in milliseconds */
89 #define	RLIMIT_FSIZE	1		/* maximum file size */
90 #define	RLIMIT_DATA	2		/* data size */
91 #define	RLIMIT_STACK	3		/* stack size */
92 #define	RLIMIT_CORE	4		/* core file size */
93 #define	RLIMIT_RSS	5		/* resident set size */
94 #define	RLIMIT_MEMLOCK	6		/* locked-in-memory address space */
95 #define	RLIMIT_NPROC	7		/* number of processes */
96 #define	RLIMIT_NOFILE	8		/* number of open files */
97 #define	RLIMIT_SBSIZE	9		/* maximum size of all socket buffers */
98 #define	RLIMIT_VMEM	10		/* virtual process size (inclusive of mmap) */
99 #define	RLIMIT_AS       RLIMIT_VMEM     /* standard name for address space size */
100 #define	RLIMIT_POSIXLOCKS 11		/* maximum number of POSIX locks per user */
101 
102 #define	RLIM_NLIMITS	12		/* number of resource limits */
103 
104 #define	RLIM_INFINITY	((rlim_t)(((u_quad_t)1 << 63) - 1))	/* no limit */
105 #define	RLIM_SAVED_MAX	RLIM_INFINITY	/* unrepresentable hard limit */
106 #define	RLIM_SAVED_CUR	RLIM_INFINITY	/* unrepresentable soft limit */
107 
108 /*
109  * Resource limit string identifiers
110  */
111 #ifdef _RLIMIT_IDENT
112 static char *rlimit_ident[] = {
113 	"cpu",
114 	"fsize",
115 	"data",
116 	"stack",
117 	"core",
118 	"rss",
119 	"memlock",
120 	"nproc",
121 	"nofile",
122 	"sbsize",
123 	"vmem",
124 	"posixlock",
125 };
126 #endif
127 
128 struct rlimit {
129 	rlim_t	rlim_cur;		/* current (soft) limit */
130 	rlim_t	rlim_max;		/* maximum value for rlim_cur */
131 };
132 
133 #if __BSD_VISIBLE
134 struct orlimit {
135 	int32_t	rlim_cur;		/* current (soft) limit */
136 	int32_t	rlim_max;		/* maximum value for rlim_cur */
137 };
138 
139 struct loadavg {
140 	fixpt_t	ldavg[3];
141 	long	fscale;
142 };
143 
144 /*
145  * CPU state fields as reported by the sysctl kern.cp_time
146  */
147 #define	CP_USER         0
148 #define	CP_NICE         1
149 #define	CP_SYS          2
150 #define	CP_INTR         3
151 #define	CP_IDLE         4
152 #define	CPUSTATES       5
153 #endif /* __BSD_VISIBLE */
154 
155 #ifdef _KERNEL
156 extern struct loadavg averunnable;
157 
158 int	dosetrlimit(u_int which, struct rlimit *limp);
159 #else
160 __BEGIN_DECLS
161 int	getpriority(int, int);
162 int	getrlimit(int, struct rlimit *);
163 int	getrusage(int, struct rusage *);
164 int	setpriority(int, int, int);
165 int	setrlimit(int, const struct rlimit *);
166 #if __BSD_VISIBLE
167 int	ioprio_get(int, int);
168 int	ioprio_set(int, int, int);
169 #endif
170 __END_DECLS
171 #endif	/* _KERNEL */
172 
173 #endif	/* !_SYS_RESOURCE_H_ */
174