1 /*-
2 * Copyright (c) 2010 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Edward Tomasz Napierala under sponsorship
6 * from the FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 * $FreeBSD$
30 */
31
32 /*
33 * Resource accounting.
34 */
35
36 #ifndef _RACCT_H_
37 #define _RACCT_H_
38
39 #include <sys/cdefs.h>
40 #include <sys/types.h>
41 #include <sys/queue.h>
42 #include <sys/stdint.h>
43 #include <sys/sysctl.h>
44
45 struct proc;
46 struct rctl_rule_link;
47 struct ucred;
48
49 /*
50 * Resources.
51 */
52 #define RACCT_UNDEFINED -1
53 #define RACCT_CPU 0
54 #define RACCT_DATA 1
55 #define RACCT_STACK 2
56 #define RACCT_CORE 3
57 #define RACCT_RSS 4
58 #define RACCT_MEMLOCK 5
59 #define RACCT_NPROC 6
60 #define RACCT_NOFILE 7
61 #define RACCT_VMEM 8
62 #define RACCT_NPTS 9
63 #define RACCT_SWAP 10
64 #define RACCT_NTHR 11
65 #define RACCT_MSGQQUEUED 12
66 #define RACCT_MSGQSIZE 13
67 #define RACCT_NMSGQ 14
68 #define RACCT_NSEM 15
69 #define RACCT_NSEMOP 16
70 #define RACCT_NSHM 17
71 #define RACCT_SHMSIZE 18
72 #define RACCT_WALLCLOCK 19
73 #define RACCT_PCTCPU 20
74 #define RACCT_MAX RACCT_PCTCPU
75
76 /*
77 * Resource properties.
78 */
79 #define RACCT_IN_MILLIONS 0x01
80 #define RACCT_RECLAIMABLE 0x02
81 #define RACCT_INHERITABLE 0x04
82 #define RACCT_DENIABLE 0x08
83 #define RACCT_SLOPPY 0x10
84 #define RACCT_DECAYING 0x20
85
86 extern int racct_types[];
87 extern int racct_enable;
88
89 #define ASSERT_RACCT_ENABLED() KASSERT(racct_enable, \
90 ("%s called with !racct_enable", __func__))
91
92 /*
93 * Amount stored in c_resources[] is 10**6 times bigger than what's
94 * visible to the userland. It gets fixed up when retrieving resource
95 * usage or adding rules.
96 */
97 #define RACCT_IS_IN_MILLIONS(X) (racct_types[X] & RACCT_IN_MILLIONS)
98
99 /*
100 * Resource usage can drop, as opposed to only grow. When the process
101 * terminates, its resource usage is freed from the respective
102 * per-credential racct containers.
103 */
104 #define RACCT_IS_RECLAIMABLE(X) (racct_types[X] & RACCT_RECLAIMABLE)
105
106 /*
107 * Children inherit resource usage.
108 */
109 #define RACCT_IS_INHERITABLE(X) (racct_types[X] & RACCT_INHERITABLE)
110
111 /*
112 * racct_{add,set}(9) can actually return an error and not update resource
113 * usage counters. Note that even when resource is not deniable, allocating
114 * resource might cause signals to be sent by RCTL code.
115 */
116 #define RACCT_IS_DENIABLE(X) (racct_types[X] & RACCT_DENIABLE)
117
118 /*
119 * Per-process resource usage information makes no sense, but per-credential
120 * one does. This kind of resources are usually allocated for process, but
121 * freed using credentials.
122 */
123 #define RACCT_IS_SLOPPY(X) (racct_types[X] & RACCT_SLOPPY)
124
125 /*
126 * When a process terminates, its resource usage is not automatically
127 * subtracted from per-credential racct containers. Instead, the resource
128 * usage of per-credential racct containers decays in time.
129 * Resource usage can olso drop for such resource.
130 * So far, the only such resource is RACCT_PCTCPU.
131 */
132 #define RACCT_IS_DECAYING(X) (racct_types[X] & RACCT_DECAYING)
133
134 /*
135 * Resource usage can drop, as opposed to only grow.
136 */
137 #define RACCT_CAN_DROP(X) (RACCT_IS_RECLAIMABLE(X) | RACCT_IS_DECAYING(X))
138
139 /*
140 * The 'racct' structure defines resource consumption for a particular
141 * subject, such as process or jail.
142 *
143 * This structure must be filled with zeroes initially.
144 */
145 struct racct {
146 int64_t r_resources[RACCT_MAX + 1];
147 LIST_HEAD(, rctl_rule_link) r_rule_links;
148 };
149
150 SYSCTL_DECL(_kern_racct);
151
152 #ifdef RACCT
153
154 int racct_add(struct proc *p, int resource, uint64_t amount);
155 void racct_add_cred(struct ucred *cred, int resource, uint64_t amount);
156 void racct_add_force(struct proc *p, int resource, uint64_t amount);
157 int racct_set(struct proc *p, int resource, uint64_t amount);
158 void racct_set_force(struct proc *p, int resource, uint64_t amount);
159 void racct_sub(struct proc *p, int resource, uint64_t amount);
160 void racct_sub_cred(struct ucred *cred, int resource, uint64_t amount);
161 uint64_t racct_get_limit(struct proc *p, int resource);
162 uint64_t racct_get_available(struct proc *p, int resource);
163
164 void racct_create(struct racct **racctp);
165 void racct_destroy(struct racct **racctp);
166
167 int racct_proc_fork(struct proc *parent, struct proc *child);
168 void racct_proc_fork_done(struct proc *child);
169 void racct_proc_exit(struct proc *p);
170
171 void racct_proc_ucred_changed(struct proc *p, struct ucred *oldcred,
172 struct ucred *newcred);
173 void racct_move(struct racct *dest, struct racct *src);
174
175 #else
176
177 static inline int
racct_add(struct proc * p,int resource,uint64_t amount)178 racct_add(struct proc *p, int resource, uint64_t amount)
179 {
180
181 return (0);
182 }
183
184 static inline void
racct_add_cred(struct ucred * cred,int resource,uint64_t amount)185 racct_add_cred(struct ucred *cred, int resource, uint64_t amount)
186 {
187 }
188
189 static inline void
racct_add_force(struct proc * p,int resource,uint64_t amount)190 racct_add_force(struct proc *p, int resource, uint64_t amount)
191 {
192 }
193
194 static inline int
racct_set(struct proc * p,int resource,uint64_t amount)195 racct_set(struct proc *p, int resource, uint64_t amount)
196 {
197
198 return (0);
199 }
200
201 static inline void
racct_set_force(struct proc * p,int resource,uint64_t amount)202 racct_set_force(struct proc *p, int resource, uint64_t amount)
203 {
204 }
205
206 static inline void
racct_sub(struct proc * p,int resource,uint64_t amount)207 racct_sub(struct proc *p, int resource, uint64_t amount)
208 {
209 }
210
211 static inline void
racct_sub_cred(struct ucred * cred,int resource,uint64_t amount)212 racct_sub_cred(struct ucred *cred, int resource, uint64_t amount)
213 {
214 }
215
216 static inline uint64_t
racct_get_limit(struct proc * p,int resource)217 racct_get_limit(struct proc *p, int resource)
218 {
219
220 return (UINT64_MAX);
221 }
222
223 static inline uint64_t
racct_get_available(struct proc * p,int resource)224 racct_get_available(struct proc *p, int resource)
225 {
226
227 return (UINT64_MAX);
228 }
229
230 #define racct_create(x)
231 #define racct_destroy(x)
232
233 static inline int
racct_proc_fork(struct proc * parent,struct proc * child)234 racct_proc_fork(struct proc *parent, struct proc *child)
235 {
236
237 return (0);
238 }
239
240 static inline void
racct_proc_fork_done(struct proc * child)241 racct_proc_fork_done(struct proc *child)
242 {
243 }
244
245 static inline void
racct_proc_exit(struct proc * p)246 racct_proc_exit(struct proc *p)
247 {
248 }
249
250 #endif
251
252 #endif /* !_RACCT_H_ */
253