1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2010 The FreeBSD Foundation 5 * 6 * This software was developed by Edward Tomasz Napierala under sponsorship 7 * from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 /* 32 * Resource accounting. 33 */ 34 35 #ifndef _RACCT_H_ 36 #define _RACCT_H_ 37 38 #include <sys/types.h> 39 #include <sys/queue.h> 40 #include <sys/stdint.h> 41 #include <sys/sysctl.h> 42 43 struct buf; 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_READBPS 21 74 #define RACCT_WRITEBPS 22 75 #define RACCT_READIOPS 23 76 #define RACCT_WRITEIOPS 24 77 #define RACCT_MAX RACCT_WRITEIOPS 78 79 /* 80 * Resource properties. 81 */ 82 #define RACCT_IN_MILLIONS 0x01 83 #define RACCT_RECLAIMABLE 0x02 84 #define RACCT_INHERITABLE 0x04 85 #define RACCT_DENIABLE 0x08 86 #define RACCT_SLOPPY 0x10 87 #define RACCT_DECAYING 0x20 88 89 extern int racct_types[]; 90 extern bool racct_enable; 91 92 #define ASSERT_RACCT_ENABLED() KASSERT(racct_enable, \ 93 ("%s called with !racct_enable", __func__)) 94 95 /* 96 * Amount stored in c_resources[] is 10**6 times bigger than what's 97 * visible to the userland. It gets fixed up when retrieving resource 98 * usage or adding rules. 99 */ 100 #define RACCT_IS_IN_MILLIONS(X) \ 101 ((X) != RACCT_UNDEFINED && (racct_types[(X)] & RACCT_IN_MILLIONS) != 0) 102 103 /* 104 * Resource usage can drop, as opposed to only grow. When the process 105 * terminates, its resource usage is subtracted from the respective 106 * per-credential racct containers. 107 */ 108 #define RACCT_IS_RECLAIMABLE(X) (racct_types[X] & RACCT_RECLAIMABLE) 109 110 /* 111 * Children inherit resource usage. 112 */ 113 #define RACCT_IS_INHERITABLE(X) (racct_types[X] & RACCT_INHERITABLE) 114 115 /* 116 * racct_{add,set}(9) can actually return an error and not update resource 117 * usage counters. Note that even when resource is not deniable, allocating 118 * resource might cause signals to be sent by RCTL code. 119 */ 120 #define RACCT_IS_DENIABLE(X) (racct_types[X] & RACCT_DENIABLE) 121 122 /* 123 * Per-process resource usage information makes no sense, but per-credential 124 * one does. This kind of resources are usually allocated for process, but 125 * freed using credentials. 126 */ 127 #define RACCT_IS_SLOPPY(X) (racct_types[X] & RACCT_SLOPPY) 128 129 /* 130 * When a process terminates, its resource usage is not automatically 131 * subtracted from per-credential racct containers. Instead, the resource 132 * usage of per-credential racct containers decays in time. 133 * Resource usage can also drop for such resource. 134 */ 135 #define RACCT_IS_DECAYING(X) (racct_types[X] & RACCT_DECAYING) 136 137 /* 138 * Resource usage can drop, as opposed to only grow. 139 */ 140 #define RACCT_CAN_DROP(X) (RACCT_IS_RECLAIMABLE(X) | RACCT_IS_DECAYING(X)) 141 142 /* 143 * The 'racct' structure defines resource consumption for a particular 144 * subject, such as process or jail. 145 * 146 * This structure must be filled with zeroes initially. 147 */ 148 struct racct { 149 int64_t r_resources[RACCT_MAX + 1]; 150 LIST_HEAD(, rctl_rule_link) r_rule_links; 151 }; 152 153 SYSCTL_DECL(_kern_racct); 154 155 #ifdef RACCT 156 157 extern struct mtx racct_lock; 158 159 #define RACCT_LOCK() mtx_lock(&racct_lock) 160 #define RACCT_UNLOCK() mtx_unlock(&racct_lock) 161 #define RACCT_LOCK_ASSERT() mtx_assert(&racct_lock, MA_OWNED) 162 163 #define RACCT_ENABLED() __predict_false(racct_enable) 164 165 #define RACCT_PROC_LOCK(p) do { \ 166 if (RACCT_ENABLED()) \ 167 PROC_LOCK(p); \ 168 } while (0) 169 #define RACCT_PROC_UNLOCK(p) do { \ 170 if (RACCT_ENABLED()) \ 171 PROC_UNLOCK(p); \ 172 } while (0) 173 174 int racct_add(struct proc *p, int resource, uint64_t amount); 175 void racct_add_cred(struct ucred *cred, int resource, uint64_t amount); 176 void racct_add_force(struct proc *p, int resource, uint64_t amount); 177 void racct_add_buf(struct proc *p, const struct buf *bufp, int is_write); 178 int racct_set(struct proc *p, int resource, uint64_t amount); 179 int racct_set_unlocked(struct proc *p, int resource, uint64_t amount); 180 void racct_set_force(struct proc *p, int resource, uint64_t amount); 181 void racct_sub(struct proc *p, int resource, uint64_t amount); 182 void racct_sub_cred(struct ucred *cred, int resource, uint64_t amount); 183 uint64_t racct_get_limit(struct proc *p, int resource); 184 uint64_t racct_get_available(struct proc *p, int resource); 185 186 void racct_create(struct racct **racctp); 187 void racct_destroy(struct racct **racctp); 188 189 int racct_proc_fork(struct proc *parent, struct proc *child); 190 void racct_proc_fork_done(struct proc *child); 191 void racct_proc_exit(struct proc *p); 192 193 void racct_proc_ucred_changed(struct proc *p, struct ucred *oldcred, 194 struct ucred *newcred); 195 void racct_move(struct racct *dest, struct racct *src); 196 void racct_proc_throttle(struct proc *p, int timeout); 197 198 #else 199 200 #define RACCT_PROC_LOCK(p) do { } while (0) 201 #define RACCT_PROC_UNLOCK(p) do { } while (0) 202 203 static inline int 204 racct_add(struct proc *p, int resource, uint64_t amount) 205 { 206 207 return (0); 208 } 209 210 static inline void 211 racct_add_cred(struct ucred *cred, int resource, uint64_t amount) 212 { 213 } 214 215 static inline void 216 racct_add_force(struct proc *p, int resource, uint64_t amount) 217 { 218 } 219 220 static inline int 221 racct_set(struct proc *p, int resource, uint64_t amount) 222 { 223 224 return (0); 225 } 226 227 static inline void 228 racct_set_force(struct proc *p, int resource, uint64_t amount) 229 { 230 } 231 232 static inline void 233 racct_sub(struct proc *p, int resource, uint64_t amount) 234 { 235 } 236 237 static inline void 238 racct_sub_cred(struct ucred *cred, int resource, uint64_t amount) 239 { 240 } 241 242 static inline uint64_t 243 racct_get_limit(struct proc *p, int resource) 244 { 245 246 return (UINT64_MAX); 247 } 248 249 static inline uint64_t 250 racct_get_available(struct proc *p, int resource) 251 { 252 253 return (UINT64_MAX); 254 } 255 256 #define racct_create(x) 257 #define racct_destroy(x) 258 259 static inline int 260 racct_proc_fork(struct proc *parent, struct proc *child) 261 { 262 263 return (0); 264 } 265 266 static inline void 267 racct_proc_fork_done(struct proc *child) 268 { 269 } 270 271 static inline void 272 racct_proc_exit(struct proc *p) 273 { 274 } 275 276 #endif 277 278 #endif /* !_RACCT_H_ */ 279