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