2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 The FreeBSD Foundation
7 * This software was developed by Edward Tomasz Napierala under sponsorship
8 * from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
35 * Resource accounting.
41 #include <sys/cdefs.h>
42 #include <sys/types.h>
43 #include <sys/queue.h>
44 #include <sys/stdint.h>
45 #include <sys/sysctl.h>
49 struct rctl_rule_link;
55 #define RACCT_UNDEFINED -1
61 #define RACCT_MEMLOCK 5
63 #define RACCT_NOFILE 7
68 #define RACCT_MSGQQUEUED 12
69 #define RACCT_MSGQSIZE 13
70 #define RACCT_NMSGQ 14
72 #define RACCT_NSEMOP 16
74 #define RACCT_SHMSIZE 18
75 #define RACCT_WALLCLOCK 19
76 #define RACCT_PCTCPU 20
77 #define RACCT_READBPS 21
78 #define RACCT_WRITEBPS 22
79 #define RACCT_READIOPS 23
80 #define RACCT_WRITEIOPS 24
81 #define RACCT_MAX RACCT_WRITEIOPS
84 * Resource properties.
86 #define RACCT_IN_MILLIONS 0x01
87 #define RACCT_RECLAIMABLE 0x02
88 #define RACCT_INHERITABLE 0x04
89 #define RACCT_DENIABLE 0x08
90 #define RACCT_SLOPPY 0x10
91 #define RACCT_DECAYING 0x20
93 extern int racct_types[];
94 extern bool racct_enable;
96 #define ASSERT_RACCT_ENABLED() KASSERT(racct_enable, \
97 ("%s called with !racct_enable", __func__))
100 * Amount stored in c_resources[] is 10**6 times bigger than what's
101 * visible to the userland. It gets fixed up when retrieving resource
102 * usage or adding rules.
104 #define RACCT_IS_IN_MILLIONS(X) \
105 ((X) != RACCT_UNDEFINED && (racct_types[(X)] & RACCT_IN_MILLIONS) != 0)
108 * Resource usage can drop, as opposed to only grow. When the process
109 * terminates, its resource usage is subtracted from the respective
110 * per-credential racct containers.
112 #define RACCT_IS_RECLAIMABLE(X) (racct_types[X] & RACCT_RECLAIMABLE)
115 * Children inherit resource usage.
117 #define RACCT_IS_INHERITABLE(X) (racct_types[X] & RACCT_INHERITABLE)
120 * racct_{add,set}(9) can actually return an error and not update resource
121 * usage counters. Note that even when resource is not deniable, allocating
122 * resource might cause signals to be sent by RCTL code.
124 #define RACCT_IS_DENIABLE(X) (racct_types[X] & RACCT_DENIABLE)
127 * Per-process resource usage information makes no sense, but per-credential
128 * one does. This kind of resources are usually allocated for process, but
129 * freed using credentials.
131 #define RACCT_IS_SLOPPY(X) (racct_types[X] & RACCT_SLOPPY)
134 * When a process terminates, its resource usage is not automatically
135 * subtracted from per-credential racct containers. Instead, the resource
136 * usage of per-credential racct containers decays in time.
137 * Resource usage can also drop for such resource.
139 #define RACCT_IS_DECAYING(X) (racct_types[X] & RACCT_DECAYING)
142 * Resource usage can drop, as opposed to only grow.
144 #define RACCT_CAN_DROP(X) (RACCT_IS_RECLAIMABLE(X) | RACCT_IS_DECAYING(X))
147 * The 'racct' structure defines resource consumption for a particular
148 * subject, such as process or jail.
150 * This structure must be filled with zeroes initially.
153 int64_t r_resources[RACCT_MAX + 1];
154 LIST_HEAD(, rctl_rule_link) r_rule_links;
157 SYSCTL_DECL(_kern_racct);
161 extern struct mtx racct_lock;
163 #define RACCT_LOCK() mtx_lock(&racct_lock)
164 #define RACCT_UNLOCK() mtx_unlock(&racct_lock)
165 #define RACCT_LOCK_ASSERT() mtx_assert(&racct_lock, MA_OWNED)
167 #define RACCT_ENABLED() __predict_false(racct_enable)
169 #define RACCT_PROC_LOCK(p) do { \
170 if (RACCT_ENABLED()) \
173 #define RACCT_PROC_UNLOCK(p) do { \
174 if (RACCT_ENABLED()) \
178 int racct_add(struct proc *p, int resource, uint64_t amount);
179 void racct_add_cred(struct ucred *cred, int resource, uint64_t amount);
180 void racct_add_force(struct proc *p, int resource, uint64_t amount);
181 void racct_add_buf(struct proc *p, const struct buf *bufp, int is_write);
182 int racct_set(struct proc *p, int resource, uint64_t amount);
183 int racct_set_unlocked(struct proc *p, int resource, uint64_t amount);
184 void racct_set_force(struct proc *p, int resource, uint64_t amount);
185 void racct_sub(struct proc *p, int resource, uint64_t amount);
186 void racct_sub_cred(struct ucred *cred, int resource, uint64_t amount);
187 uint64_t racct_get_limit(struct proc *p, int resource);
188 uint64_t racct_get_available(struct proc *p, int resource);
190 void racct_create(struct racct **racctp);
191 void racct_destroy(struct racct **racctp);
193 int racct_proc_fork(struct proc *parent, struct proc *child);
194 void racct_proc_fork_done(struct proc *child);
195 void racct_proc_exit(struct proc *p);
197 void racct_proc_ucred_changed(struct proc *p, struct ucred *oldcred,
198 struct ucred *newcred);
199 void racct_move(struct racct *dest, struct racct *src);
200 void racct_proc_throttled(struct proc *p);
201 void racct_proc_throttle(struct proc *p, int timeout);
205 #define RACCT_PROC_LOCK(p) do { } while (0)
206 #define RACCT_PROC_UNLOCK(p) do { } while (0)
209 racct_add(struct proc *p, int resource, uint64_t amount)
216 racct_add_cred(struct ucred *cred, int resource, uint64_t amount)
221 racct_add_force(struct proc *p, int resource, uint64_t amount)
226 racct_set(struct proc *p, int resource, uint64_t amount)
233 racct_set_force(struct proc *p, int resource, uint64_t amount)
238 racct_sub(struct proc *p, int resource, uint64_t amount)
243 racct_sub_cred(struct ucred *cred, int resource, uint64_t amount)
247 static inline uint64_t
248 racct_get_limit(struct proc *p, int resource)
254 static inline uint64_t
255 racct_get_available(struct proc *p, int resource)
261 #define racct_create(x)
262 #define racct_destroy(x)
265 racct_proc_fork(struct proc *parent, struct proc *child)
272 racct_proc_fork_done(struct proc *child)
277 racct_proc_exit(struct proc *p)
283 #endif /* !_RACCT_H_ */