2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2010 The FreeBSD Foundation
6 * This software was developed by Edward Tomasz Napierala under sponsorship
7 * from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 #include "opt_sched.h"
34 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/eventhandler.h>
39 #include <sys/kernel.h>
40 #include <sys/kthread.h>
42 #include <sys/loginclass.h>
43 #include <sys/malloc.h>
44 #include <sys/mutex.h>
46 #include <sys/racct.h>
47 #include <sys/resourcevar.h>
49 #include <sys/sched.h>
53 #include <sys/sysctl.h>
54 #include <sys/sysproto.h>
55 #include <sys/umtxvar.h>
56 #include <machine/smp.h>
64 FEATURE(racct, "Resource Accounting");
67 * Do not block processes that have their %cpu usage <= pcpu_threshold.
69 static int pcpu_threshold = 1;
70 #ifdef RACCT_DEFAULT_TO_DISABLED
71 bool __read_frequently racct_enable = false;
73 bool __read_frequently racct_enable = true;
76 SYSCTL_NODE(_kern, OID_AUTO, racct, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
77 "Resource Accounting");
78 SYSCTL_BOOL(_kern_racct, OID_AUTO, enable, CTLFLAG_RDTUN, &racct_enable,
79 0, "Enable RACCT/RCTL");
80 SYSCTL_UINT(_kern_racct, OID_AUTO, pcpu_threshold, CTLFLAG_RW, &pcpu_threshold,
81 0, "Processes with higher %cpu usage than this value can be throttled.");
84 * How many seconds it takes to use the scheduler %cpu calculations. When a
85 * process starts, we compute its %cpu usage by dividing its runtime by the
86 * process wall clock time. After RACCT_PCPU_SECS pass, we use the value
87 * provided by the scheduler.
89 #define RACCT_PCPU_SECS 3
91 struct mtx racct_lock;
92 MTX_SYSINIT(racct_lock, &racct_lock, "racct lock", MTX_DEF);
94 static uma_zone_t racct_zone;
96 static void racct_sub_racct(struct racct *dest, const struct racct *src);
97 static void racct_sub_cred_locked(struct ucred *cred, int resource,
99 static void racct_add_cred_locked(struct ucred *cred, int resource,
102 SDT_PROVIDER_DEFINE(racct);
103 SDT_PROBE_DEFINE3(racct, , rusage, add,
104 "struct proc *", "int", "uint64_t");
105 SDT_PROBE_DEFINE3(racct, , rusage, add__failure,
106 "struct proc *", "int", "uint64_t");
107 SDT_PROBE_DEFINE3(racct, , rusage, add__buf,
108 "struct proc *", "const struct buf *", "int");
109 SDT_PROBE_DEFINE3(racct, , rusage, add__cred,
110 "struct ucred *", "int", "uint64_t");
111 SDT_PROBE_DEFINE3(racct, , rusage, add__force,
112 "struct proc *", "int", "uint64_t");
113 SDT_PROBE_DEFINE3(racct, , rusage, set,
114 "struct proc *", "int", "uint64_t");
115 SDT_PROBE_DEFINE3(racct, , rusage, set__failure,
116 "struct proc *", "int", "uint64_t");
117 SDT_PROBE_DEFINE3(racct, , rusage, set__force,
118 "struct proc *", "int", "uint64_t");
119 SDT_PROBE_DEFINE3(racct, , rusage, sub,
120 "struct proc *", "int", "uint64_t");
121 SDT_PROBE_DEFINE3(racct, , rusage, sub__cred,
122 "struct ucred *", "int", "uint64_t");
123 SDT_PROBE_DEFINE1(racct, , racct, create,
125 SDT_PROBE_DEFINE1(racct, , racct, destroy,
127 SDT_PROBE_DEFINE2(racct, , racct, join,
128 "struct racct *", "struct racct *");
129 SDT_PROBE_DEFINE2(racct, , racct, join__failure,
130 "struct racct *", "struct racct *");
131 SDT_PROBE_DEFINE2(racct, , racct, leave,
132 "struct racct *", "struct racct *");
134 int racct_types[] = {
138 RACCT_RECLAIMABLE | RACCT_INHERITABLE | RACCT_DENIABLE,
140 RACCT_RECLAIMABLE | RACCT_INHERITABLE | RACCT_DENIABLE,
146 RACCT_RECLAIMABLE | RACCT_DENIABLE,
148 RACCT_RECLAIMABLE | RACCT_DENIABLE,
150 RACCT_RECLAIMABLE | RACCT_INHERITABLE | RACCT_DENIABLE,
152 RACCT_RECLAIMABLE | RACCT_INHERITABLE | RACCT_DENIABLE,
154 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
156 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
158 RACCT_RECLAIMABLE | RACCT_DENIABLE,
160 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
162 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
164 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
166 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
168 RACCT_RECLAIMABLE | RACCT_INHERITABLE | RACCT_DENIABLE,
170 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
172 RACCT_RECLAIMABLE | RACCT_DENIABLE | RACCT_SLOPPY,
176 RACCT_DECAYING | RACCT_DENIABLE | RACCT_IN_MILLIONS,
186 static const fixpt_t RACCT_DECAY_FACTOR = 0.3 * FSCALE;
190 * Contains intermediate values for %cpu calculations to avoid using floating
191 * point in the kernel.
192 * ccpu_exp[k] = FSCALE * (ccpu/FSCALE)^k = FSCALE * exp(-k/20)
193 * It is needed only for the 4BSD scheduler, because in ULE, the ccpu equals to
194 * zero so the calculations are more straightforward.
196 fixpt_t ccpu_exp[] = {
198 [1] = FSCALE * 0.95122942450071400909,
199 [2] = FSCALE * 0.90483741803595957316,
200 [3] = FSCALE * 0.86070797642505780722,
201 [4] = FSCALE * 0.81873075307798185866,
202 [5] = FSCALE * 0.77880078307140486824,
203 [6] = FSCALE * 0.74081822068171786606,
204 [7] = FSCALE * 0.70468808971871343435,
205 [8] = FSCALE * 0.67032004603563930074,
206 [9] = FSCALE * 0.63762815162177329314,
207 [10] = FSCALE * 0.60653065971263342360,
208 [11] = FSCALE * 0.57694981038048669531,
209 [12] = FSCALE * 0.54881163609402643262,
210 [13] = FSCALE * 0.52204577676101604789,
211 [14] = FSCALE * 0.49658530379140951470,
212 [15] = FSCALE * 0.47236655274101470713,
213 [16] = FSCALE * 0.44932896411722159143,
214 [17] = FSCALE * 0.42741493194872666992,
215 [18] = FSCALE * 0.40656965974059911188,
216 [19] = FSCALE * 0.38674102345450120691,
217 [20] = FSCALE * 0.36787944117144232159,
218 [21] = FSCALE * 0.34993774911115535467,
219 [22] = FSCALE * 0.33287108369807955328,
220 [23] = FSCALE * 0.31663676937905321821,
221 [24] = FSCALE * 0.30119421191220209664,
222 [25] = FSCALE * 0.28650479686019010032,
223 [26] = FSCALE * 0.27253179303401260312,
224 [27] = FSCALE * 0.25924026064589150757,
225 [28] = FSCALE * 0.24659696394160647693,
226 [29] = FSCALE * 0.23457028809379765313,
227 [30] = FSCALE * 0.22313016014842982893,
228 [31] = FSCALE * 0.21224797382674305771,
229 [32] = FSCALE * 0.20189651799465540848,
230 [33] = FSCALE * 0.19204990862075411423,
231 [34] = FSCALE * 0.18268352405273465022,
232 [35] = FSCALE * 0.17377394345044512668,
233 [36] = FSCALE * 0.16529888822158653829,
234 [37] = FSCALE * 0.15723716631362761621,
235 [38] = FSCALE * 0.14956861922263505264,
236 [39] = FSCALE * 0.14227407158651357185,
237 [40] = FSCALE * 0.13533528323661269189,
238 [41] = FSCALE * 0.12873490358780421886,
239 [42] = FSCALE * 0.12245642825298191021,
240 [43] = FSCALE * 0.11648415777349695786,
241 [44] = FSCALE * 0.11080315836233388333,
242 [45] = FSCALE * 0.10539922456186433678,
243 [46] = FSCALE * 0.10025884372280373372,
244 [47] = FSCALE * 0.09536916221554961888,
245 [48] = FSCALE * 0.09071795328941250337,
246 [49] = FSCALE * 0.08629358649937051097,
247 [50] = FSCALE * 0.08208499862389879516,
248 [51] = FSCALE * 0.07808166600115315231,
249 [52] = FSCALE * 0.07427357821433388042,
250 [53] = FSCALE * 0.07065121306042958674,
251 [54] = FSCALE * 0.06720551273974976512,
252 [55] = FSCALE * 0.06392786120670757270,
253 [56] = FSCALE * 0.06081006262521796499,
254 [57] = FSCALE * 0.05784432087483846296,
255 [58] = FSCALE * 0.05502322005640722902,
256 [59] = FSCALE * 0.05233970594843239308,
257 [60] = FSCALE * 0.04978706836786394297,
258 [61] = FSCALE * 0.04735892439114092119,
259 [62] = FSCALE * 0.04504920239355780606,
260 [63] = FSCALE * 0.04285212686704017991,
261 [64] = FSCALE * 0.04076220397836621516,
262 [65] = FSCALE * 0.03877420783172200988,
263 [66] = FSCALE * 0.03688316740124000544,
264 [67] = FSCALE * 0.03508435410084502588,
265 [68] = FSCALE * 0.03337326996032607948,
266 [69] = FSCALE * 0.03174563637806794323,
267 [70] = FSCALE * 0.03019738342231850073,
268 [71] = FSCALE * 0.02872463965423942912,
269 [72] = FSCALE * 0.02732372244729256080,
270 [73] = FSCALE * 0.02599112877875534358,
271 [74] = FSCALE * 0.02472352647033939120,
272 [75] = FSCALE * 0.02351774585600910823,
273 [76] = FSCALE * 0.02237077185616559577,
274 [77] = FSCALE * 0.02127973643837716938,
275 [78] = FSCALE * 0.02024191144580438847,
276 [79] = FSCALE * 0.01925470177538692429,
277 [80] = FSCALE * 0.01831563888873418029,
278 [81] = FSCALE * 0.01742237463949351138,
279 [82] = FSCALE * 0.01657267540176124754,
280 [83] = FSCALE * 0.01576441648485449082,
281 [84] = FSCALE * 0.01499557682047770621,
282 [85] = FSCALE * 0.01426423390899925527,
283 [86] = FSCALE * 0.01356855901220093175,
284 [87] = FSCALE * 0.01290681258047986886,
285 [88] = FSCALE * 0.01227733990306844117,
286 [89] = FSCALE * 0.01167856697039544521,
287 [90] = FSCALE * 0.01110899653824230649,
288 [91] = FSCALE * 0.01056720438385265337,
289 [92] = FSCALE * 0.01005183574463358164,
290 [93] = FSCALE * 0.00956160193054350793,
291 [94] = FSCALE * 0.00909527710169581709,
292 [95] = FSCALE * 0.00865169520312063417,
293 [96] = FSCALE * 0.00822974704902002884,
294 [97] = FSCALE * 0.00782837754922577143,
295 [98] = FSCALE * 0.00744658307092434051,
296 [99] = FSCALE * 0.00708340892905212004,
297 [100] = FSCALE * 0.00673794699908546709,
298 [101] = FSCALE * 0.00640933344625638184,
299 [102] = FSCALE * 0.00609674656551563610,
300 [103] = FSCALE * 0.00579940472684214321,
301 [104] = FSCALE * 0.00551656442076077241,
302 [105] = FSCALE * 0.00524751839918138427,
303 [106] = FSCALE * 0.00499159390691021621,
304 [107] = FSCALE * 0.00474815099941147558,
305 [108] = FSCALE * 0.00451658094261266798,
306 [109] = FSCALE * 0.00429630469075234057,
307 [110] = FSCALE * 0.00408677143846406699,
311 #define CCPU_EXP_MAX 110
314 * This function is analogical to the getpcpu() function in the ps(1) command.
315 * They should both calculate in the same way so that the racct %cpu
316 * calculations are consistent with the values showed by the ps(1) tool.
317 * The calculations are more complex in the 4BSD scheduler because of the value
318 * of the ccpu variable. In ULE it is defined to be zero which saves us some
322 racct_getpcpu(struct proc *p, u_int pcpu)
326 fixpt_t pctcpu, pctcpu_next;
335 ASSERT_RACCT_ENABLED();
338 * If the process is swapped out, we count its %cpu usage as zero.
339 * This behaviour is consistent with the userland ps(1) tool.
341 if ((p->p_flag & P_INMEM) == 0)
343 swtime = (ticks - p->p_swtick) / hz;
346 * For short-lived processes, the sched_pctcpu() returns small
347 * values even for cpu intensive processes. Therefore we use
348 * our own estimate in this case.
350 if (swtime < RACCT_PCPU_SECS)
354 FOREACH_THREAD_IN_PROC(p, td) {
355 if (td == PCPU_GET(idlethread))
359 STAILQ_FOREACH(pc, &cpuhead, pc_allcpu) {
360 if (td == pc->pc_idlethread) {
370 pctcpu = sched_pctcpu(td);
371 /* Count also the yet unfinished second. */
372 pctcpu_next = (pctcpu * ccpu_exp[1]) >> FSHIFT;
373 pctcpu_next += sched_pctcpu_delta(td);
374 p_pctcpu += max(pctcpu, pctcpu_next);
377 * In ULE the %cpu statistics are updated on every
378 * sched_pctcpu() call. So special calculations to
379 * account for the latest (unfinished) second are
382 p_pctcpu += sched_pctcpu(td);
388 if (swtime <= CCPU_EXP_MAX)
389 return ((100 * (uint64_t)p_pctcpu * 1000000) /
390 (FSCALE - ccpu_exp[swtime]));
393 return ((100 * (uint64_t)p_pctcpu * 1000000) / FSCALE);
397 racct_add_racct(struct racct *dest, const struct racct *src)
401 ASSERT_RACCT_ENABLED();
405 * Update resource usage in dest.
407 for (i = 0; i <= RACCT_MAX; i++) {
408 KASSERT(dest->r_resources[i] >= 0,
409 ("%s: resource %d propagation meltdown: dest < 0",
411 KASSERT(src->r_resources[i] >= 0,
412 ("%s: resource %d propagation meltdown: src < 0",
414 dest->r_resources[i] += src->r_resources[i];
419 racct_sub_racct(struct racct *dest, const struct racct *src)
423 ASSERT_RACCT_ENABLED();
427 * Update resource usage in dest.
429 for (i = 0; i <= RACCT_MAX; i++) {
430 if (!RACCT_IS_SLOPPY(i) && !RACCT_IS_DECAYING(i)) {
431 KASSERT(dest->r_resources[i] >= 0,
432 ("%s: resource %d propagation meltdown: dest < 0",
434 KASSERT(src->r_resources[i] >= 0,
435 ("%s: resource %d propagation meltdown: src < 0",
437 KASSERT(src->r_resources[i] <= dest->r_resources[i],
438 ("%s: resource %d propagation meltdown: src > dest",
441 if (RACCT_CAN_DROP(i)) {
442 dest->r_resources[i] -= src->r_resources[i];
443 if (dest->r_resources[i] < 0)
444 dest->r_resources[i] = 0;
450 racct_create(struct racct **racctp)
456 SDT_PROBE1(racct, , racct, create, racctp);
458 KASSERT(*racctp == NULL, ("racct already allocated"));
460 *racctp = uma_zalloc(racct_zone, M_WAITOK | M_ZERO);
464 racct_destroy_locked(struct racct **racctp)
469 ASSERT_RACCT_ENABLED();
471 SDT_PROBE1(racct, , racct, destroy, racctp);
474 KASSERT(racctp != NULL, ("NULL racctp"));
475 KASSERT(*racctp != NULL, ("NULL racct"));
479 for (i = 0; i <= RACCT_MAX; i++) {
480 if (RACCT_IS_SLOPPY(i))
482 if (!RACCT_IS_RECLAIMABLE(i))
484 KASSERT(racct->r_resources[i] == 0,
485 ("destroying non-empty racct: "
486 "%ju allocated for resource %d\n",
487 racct->r_resources[i], i));
489 uma_zfree(racct_zone, racct);
494 racct_destroy(struct racct **racct)
501 racct_destroy_locked(racct);
506 * Increase consumption of 'resource' by 'amount' for 'racct',
507 * but not its parents. Differently from other cases, 'amount' here
508 * may be less than zero.
511 racct_adjust_resource(struct racct *racct, int resource,
515 ASSERT_RACCT_ENABLED();
517 KASSERT(racct != NULL, ("NULL racct"));
519 racct->r_resources[resource] += amount;
520 if (racct->r_resources[resource] < 0) {
521 KASSERT(RACCT_IS_SLOPPY(resource) || RACCT_IS_DECAYING(resource),
522 ("%s: resource %d usage < 0", __func__, resource));
523 racct->r_resources[resource] = 0;
527 * There are some cases where the racct %cpu resource would grow
528 * beyond 100% per core. For example in racct_proc_exit() we add
529 * the process %cpu usage to the ucred racct containers. If too
530 * many processes terminated in a short time span, the ucred %cpu
531 * resource could grow too much. Also, the 4BSD scheduler sometimes
532 * returns for a thread more than 100% cpu usage. So we set a sane
533 * boundary here to 100% * the maximum number of CPUs.
535 if ((resource == RACCT_PCTCPU) &&
536 (racct->r_resources[RACCT_PCTCPU] > 100 * 1000000 * (int64_t)MAXCPU))
537 racct->r_resources[RACCT_PCTCPU] = 100 * 1000000 * (int64_t)MAXCPU;
541 racct_add_locked(struct proc *p, int resource, uint64_t amount, int force)
547 ASSERT_RACCT_ENABLED();
550 * We need proc lock to dereference p->p_ucred.
552 PROC_LOCK_ASSERT(p, MA_OWNED);
555 error = rctl_enforce(p, resource, amount);
556 if (error && !force && RACCT_IS_DENIABLE(resource)) {
557 SDT_PROBE3(racct, , rusage, add__failure, p, resource, amount);
561 racct_adjust_resource(p->p_racct, resource, amount);
562 racct_add_cred_locked(p->p_ucred, resource, amount);
568 * Increase allocation of 'resource' by 'amount' for process 'p'.
569 * Return 0 if it's below limits, or errno, if it's not.
572 racct_add(struct proc *p, int resource, uint64_t amount)
579 SDT_PROBE3(racct, , rusage, add, p, resource, amount);
582 error = racct_add_locked(p, resource, amount, 0);
588 * Increase allocation of 'resource' by 'amount' for process 'p'.
589 * Doesn't check for limits and never fails.
592 racct_add_force(struct proc *p, int resource, uint64_t amount)
598 SDT_PROBE3(racct, , rusage, add__force, p, resource, amount);
601 racct_add_locked(p, resource, amount, 1);
606 racct_add_cred_locked(struct ucred *cred, int resource, uint64_t amount)
610 ASSERT_RACCT_ENABLED();
612 racct_adjust_resource(cred->cr_ruidinfo->ui_racct, resource, amount);
613 for (pr = cred->cr_prison; pr != NULL; pr = pr->pr_parent)
614 racct_adjust_resource(pr->pr_prison_racct->prr_racct, resource,
616 racct_adjust_resource(cred->cr_loginclass->lc_racct, resource, amount);
620 * Increase allocation of 'resource' by 'amount' for credential 'cred'.
621 * Doesn't check for limits and never fails.
624 racct_add_cred(struct ucred *cred, int resource, uint64_t amount)
630 SDT_PROBE3(racct, , rusage, add__cred, cred, resource, amount);
633 racct_add_cred_locked(cred, resource, amount);
638 * Account for disk IO resource consumption. Checks for limits,
639 * but never fails, due to disk limits being undeniable.
642 racct_add_buf(struct proc *p, const struct buf *bp, int is_write)
645 ASSERT_RACCT_ENABLED();
646 PROC_LOCK_ASSERT(p, MA_OWNED);
648 SDT_PROBE3(racct, , rusage, add__buf, p, bp, is_write);
652 racct_add_locked(curproc, RACCT_WRITEBPS, bp->b_bcount, 1);
653 racct_add_locked(curproc, RACCT_WRITEIOPS, 1, 1);
655 racct_add_locked(curproc, RACCT_READBPS, bp->b_bcount, 1);
656 racct_add_locked(curproc, RACCT_READIOPS, 1, 1);
662 racct_set_locked(struct proc *p, int resource, uint64_t amount, int force)
664 int64_t old_amount, decayed_amount, diff_proc, diff_cred;
669 ASSERT_RACCT_ENABLED();
672 * We need proc lock to dereference p->p_ucred.
674 PROC_LOCK_ASSERT(p, MA_OWNED);
676 old_amount = p->p_racct->r_resources[resource];
678 * The diffs may be negative.
680 diff_proc = amount - old_amount;
681 if (resource == RACCT_PCTCPU) {
683 * Resources in per-credential racct containers may decay.
684 * If this is the case, we need to calculate the difference
685 * between the new amount and the proportional value of the
686 * old amount that has decayed in the ucred racct containers.
688 decayed_amount = old_amount * RACCT_DECAY_FACTOR / FSCALE;
689 diff_cred = amount - decayed_amount;
691 diff_cred = diff_proc;
693 KASSERT(diff_proc >= 0 || RACCT_CAN_DROP(resource),
694 ("%s: usage of non-droppable resource %d dropping", __func__,
699 error = rctl_enforce(p, resource, diff_proc);
700 if (error && !force && RACCT_IS_DENIABLE(resource)) {
701 SDT_PROBE3(racct, , rusage, set__failure, p, resource,
707 racct_adjust_resource(p->p_racct, resource, diff_proc);
709 racct_add_cred_locked(p->p_ucred, resource, diff_cred);
710 else if (diff_cred < 0)
711 racct_sub_cred_locked(p->p_ucred, resource, -diff_cred);
717 * Set allocation of 'resource' to 'amount' for process 'p'.
718 * Return 0 if it's below limits, or errno, if it's not.
720 * Note that decreasing the allocation always returns 0,
721 * even if it's above the limit.
724 racct_set_unlocked(struct proc *p, int resource, uint64_t amount)
728 ASSERT_RACCT_ENABLED();
730 error = racct_set(p, resource, amount);
736 racct_set(struct proc *p, int resource, uint64_t amount)
743 SDT_PROBE3(racct, , rusage, set__force, p, resource, amount);
746 error = racct_set_locked(p, resource, amount, 0);
752 racct_set_force(struct proc *p, int resource, uint64_t amount)
758 SDT_PROBE3(racct, , rusage, set, p, resource, amount);
761 racct_set_locked(p, resource, amount, 1);
766 * Returns amount of 'resource' the process 'p' can keep allocated.
767 * Allocating more than that would be denied, unless the resource
768 * is marked undeniable. Amount of already allocated resource does
772 racct_get_limit(struct proc *p, int resource)
781 available = rctl_get_limit(p, resource);
792 * Returns amount of 'resource' the process 'p' can keep allocated.
793 * Allocating more than that would be denied, unless the resource
794 * is marked undeniable. Amount of already allocated resource does
798 racct_get_available(struct proc *p, int resource)
807 available = rctl_get_available(p, resource);
818 * Returns amount of the %cpu resource that process 'p' can add to its %cpu
819 * utilization. Adding more than that would lead to the process being
823 racct_pcpu_available(struct proc *p)
828 ASSERT_RACCT_ENABLED();
831 available = rctl_pcpu_available(p);
842 * Decrease allocation of 'resource' by 'amount' for process 'p'.
845 racct_sub(struct proc *p, int resource, uint64_t amount)
851 SDT_PROBE3(racct, , rusage, sub, p, resource, amount);
854 * We need proc lock to dereference p->p_ucred.
856 PROC_LOCK_ASSERT(p, MA_OWNED);
857 KASSERT(RACCT_CAN_DROP(resource),
858 ("%s: called for non-droppable resource %d", __func__, resource));
861 KASSERT(amount <= p->p_racct->r_resources[resource],
862 ("%s: freeing %ju of resource %d, which is more "
863 "than allocated %jd for %s (pid %d)", __func__, amount, resource,
864 (intmax_t)p->p_racct->r_resources[resource], p->p_comm, p->p_pid));
866 racct_adjust_resource(p->p_racct, resource, -amount);
867 racct_sub_cred_locked(p->p_ucred, resource, amount);
872 racct_sub_cred_locked(struct ucred *cred, int resource, uint64_t amount)
876 ASSERT_RACCT_ENABLED();
878 racct_adjust_resource(cred->cr_ruidinfo->ui_racct, resource, -amount);
879 for (pr = cred->cr_prison; pr != NULL; pr = pr->pr_parent)
880 racct_adjust_resource(pr->pr_prison_racct->prr_racct, resource,
882 racct_adjust_resource(cred->cr_loginclass->lc_racct, resource, -amount);
886 * Decrease allocation of 'resource' by 'amount' for credential 'cred'.
889 racct_sub_cred(struct ucred *cred, int resource, uint64_t amount)
895 SDT_PROBE3(racct, , rusage, sub__cred, cred, resource, amount);
898 KASSERT(RACCT_CAN_DROP(resource),
899 ("%s: called for resource %d which can not drop", __func__,
904 racct_sub_cred_locked(cred, resource, amount);
909 * Inherit resource usage information from the parent process.
912 racct_proc_fork(struct proc *parent, struct proc *child)
920 * Create racct for the child process.
922 racct_create(&child->p_racct);
929 error = rctl_proc_fork(parent, child);
934 /* Init process cpu time. */
935 child->p_prev_runtime = 0;
936 child->p_throttled = 0;
939 * Inherit resource usage.
941 for (i = 0; i <= RACCT_MAX; i++) {
942 if (parent->p_racct->r_resources[i] == 0 ||
943 !RACCT_IS_INHERITABLE(i))
946 error = racct_set_locked(child, i,
947 parent->p_racct->r_resources[i], 0);
952 error = racct_add_locked(child, RACCT_NPROC, 1, 0);
953 error += racct_add_locked(child, RACCT_NTHR, 1, 0);
961 racct_proc_exit(child);
967 * Called at the end of fork1(), to handle rules that require the process
968 * to be fully initialized.
971 racct_proc_fork_done(struct proc *child)
980 rctl_enforce(child, RACCT_NPROC, 0);
981 rctl_enforce(child, RACCT_NTHR, 0);
988 racct_proc_exit(struct proc *p)
990 struct timeval wallclock;
991 uint64_t pct_estimate, pct, runtime;
999 * We don't need to calculate rux, proc_reap() has already done this.
1001 runtime = cputick2usec(p->p_rux.rux_runtime);
1003 KASSERT(runtime >= p->p_prev_runtime, ("runtime < p_prev_runtime"));
1005 if (runtime < p->p_prev_runtime)
1006 runtime = p->p_prev_runtime;
1008 microuptime(&wallclock);
1009 timevalsub(&wallclock, &p->p_stats->p_start);
1010 if (wallclock.tv_sec > 0 || wallclock.tv_usec > 0) {
1011 pct_estimate = (1000000 * runtime * 100) /
1012 ((uint64_t)wallclock.tv_sec * 1000000 +
1016 pct = racct_getpcpu(p, pct_estimate);
1019 racct_set_locked(p, RACCT_CPU, runtime, 0);
1020 racct_add_cred_locked(p->p_ucred, RACCT_PCTCPU, pct);
1022 KASSERT(p->p_racct->r_resources[RACCT_RSS] == 0,
1023 ("process reaped with %ju allocated for RSS\n",
1024 p->p_racct->r_resources[RACCT_RSS]));
1025 for (i = 0; i <= RACCT_MAX; i++) {
1026 if (p->p_racct->r_resources[i] == 0)
1028 if (!RACCT_IS_RECLAIMABLE(i))
1030 racct_set_locked(p, i, 0, 0);
1034 rctl_racct_release(p->p_racct);
1036 racct_destroy_locked(&p->p_racct);
1042 * Called after credentials change, to move resource utilisation
1046 racct_proc_ucred_changed(struct proc *p, struct ucred *oldcred,
1047 struct ucred *newcred)
1049 struct uidinfo *olduip, *newuip;
1050 struct loginclass *oldlc, *newlc;
1051 struct prison *oldpr, *newpr, *pr;
1056 PROC_LOCK_ASSERT(p, MA_OWNED);
1058 newuip = newcred->cr_ruidinfo;
1059 olduip = oldcred->cr_ruidinfo;
1060 newlc = newcred->cr_loginclass;
1061 oldlc = oldcred->cr_loginclass;
1062 newpr = newcred->cr_prison;
1063 oldpr = oldcred->cr_prison;
1066 if (newuip != olduip) {
1067 racct_sub_racct(olduip->ui_racct, p->p_racct);
1068 racct_add_racct(newuip->ui_racct, p->p_racct);
1070 if (newlc != oldlc) {
1071 racct_sub_racct(oldlc->lc_racct, p->p_racct);
1072 racct_add_racct(newlc->lc_racct, p->p_racct);
1074 if (newpr != oldpr) {
1075 for (pr = oldpr; pr != NULL; pr = pr->pr_parent)
1076 racct_sub_racct(pr->pr_prison_racct->prr_racct,
1078 for (pr = newpr; pr != NULL; pr = pr->pr_parent)
1079 racct_add_racct(pr->pr_prison_racct->prr_racct,
1086 racct_move(struct racct *dest, struct racct *src)
1089 ASSERT_RACCT_ENABLED();
1092 racct_add_racct(dest, src);
1093 racct_sub_racct(src, src);
1098 ast_racct(struct thread *td, int tda __unused)
1102 ASSERT_RACCT_ENABLED();
1105 if (p->p_throttled == 0)
1109 while (p->p_throttled != 0) {
1110 msleep(p->p_racct, &p->p_mtx, 0, "racct",
1111 p->p_throttled < 0 ? 0 : p->p_throttled);
1112 if (p->p_throttled > 0)
1119 * Make the process sleep in userret() for 'timeout' ticks. Setting
1120 * timeout to -1 makes it sleep until woken up by racct_proc_wakeup().
1123 racct_proc_throttle(struct proc *p, int timeout)
1130 KASSERT(timeout != 0, ("timeout %d", timeout));
1131 ASSERT_RACCT_ENABLED();
1132 PROC_LOCK_ASSERT(p, MA_OWNED);
1135 * Do not block kernel processes. Also do not block processes with
1136 * low %cpu utilization to improve interactivity.
1138 if ((p->p_flag & (P_SYSTEM | P_KPROC)) != 0)
1141 if (p->p_throttled < 0 || (timeout > 0 && p->p_throttled > timeout))
1144 p->p_throttled = timeout;
1146 FOREACH_THREAD_IN_PROC(p, td) {
1148 ast_sched_locked(td, TDA_RACCT);
1150 switch (TD_GET_STATE(td)) {
1153 * If the thread is on the scheduler run-queue, we can
1154 * not just remove it from there. So we set the flag
1155 * TDA_SCHED for the thread, so that once it is
1156 * running, it is taken off the cpu as soon as possible.
1158 ast_sched_locked(td, TDA_SCHED);
1162 * If the thread is running, we request a context
1163 * switch for it by setting the TDA_SCHED flag.
1165 ast_sched_locked(td, TDA_SCHED);
1167 cpuid = td->td_oncpu;
1168 if ((cpuid != NOCPU) && (td != curthread))
1169 ipi_cpu(cpuid, IPI_AST);
1180 racct_proc_wakeup(struct proc *p)
1183 ASSERT_RACCT_ENABLED();
1185 PROC_LOCK_ASSERT(p, MA_OWNED);
1187 if (p->p_throttled != 0) {
1194 racct_decay_callback(struct racct *racct, void *dummy1, void *dummy2)
1196 int64_t r_old, r_new;
1198 ASSERT_RACCT_ENABLED();
1199 RACCT_LOCK_ASSERT();
1202 rctl_throttle_decay(racct, RACCT_READBPS);
1203 rctl_throttle_decay(racct, RACCT_WRITEBPS);
1204 rctl_throttle_decay(racct, RACCT_READIOPS);
1205 rctl_throttle_decay(racct, RACCT_WRITEIOPS);
1208 r_old = racct->r_resources[RACCT_PCTCPU];
1210 /* If there is nothing to decay, just exit. */
1214 r_new = r_old * RACCT_DECAY_FACTOR / FSCALE;
1215 racct->r_resources[RACCT_PCTCPU] = r_new;
1219 racct_decay_pre(void)
1226 racct_decay_post(void)
1236 ASSERT_RACCT_ENABLED();
1238 ui_racct_foreach(racct_decay_callback, racct_decay_pre,
1239 racct_decay_post, NULL, NULL);
1240 loginclass_racct_foreach(racct_decay_callback, racct_decay_pre,
1241 racct_decay_post, NULL, NULL);
1242 prison_racct_foreach(racct_decay_callback, racct_decay_pre,
1243 racct_decay_post, NULL, NULL);
1251 struct timeval wallclock;
1252 uint64_t pct, pct_estimate, runtime;
1254 ASSERT_RACCT_ENABLED();
1259 sx_slock(&allproc_lock);
1261 FOREACH_PROC_IN_SYSTEM(p) {
1263 if (p->p_state != PRS_NORMAL) {
1264 if (p->p_state == PRS_ZOMBIE)
1265 racct_set(p, RACCT_PCTCPU, 0);
1270 microuptime(&wallclock);
1271 timevalsub(&wallclock, &p->p_stats->p_start);
1273 FOREACH_THREAD_IN_PROC(p, td)
1275 runtime = cputick2usec(p->p_rux.rux_runtime);
1278 KASSERT(runtime >= p->p_prev_runtime,
1279 ("runtime < p_prev_runtime"));
1281 if (runtime < p->p_prev_runtime)
1282 runtime = p->p_prev_runtime;
1284 p->p_prev_runtime = runtime;
1285 if (wallclock.tv_sec > 0 || wallclock.tv_usec > 0) {
1286 pct_estimate = (1000000 * runtime * 100) /
1287 ((uint64_t)wallclock.tv_sec * 1000000 +
1291 pct = racct_getpcpu(p, pct_estimate);
1294 rctl_throttle_decay(p->p_racct, RACCT_READBPS);
1295 rctl_throttle_decay(p->p_racct, RACCT_WRITEBPS);
1296 rctl_throttle_decay(p->p_racct, RACCT_READIOPS);
1297 rctl_throttle_decay(p->p_racct, RACCT_WRITEIOPS);
1299 racct_set_locked(p, RACCT_PCTCPU, pct, 1);
1300 racct_set_locked(p, RACCT_CPU, runtime, 0);
1301 racct_set_locked(p, RACCT_WALLCLOCK,
1302 (uint64_t)wallclock.tv_sec * 1000000 +
1303 wallclock.tv_usec, 0);
1309 * To ensure that processes are throttled in a fair way, we need
1310 * to iterate over all processes again and check the limits
1311 * for %cpu resource only after ucred racct containers have been
1314 FOREACH_PROC_IN_SYSTEM(p) {
1316 if (p->p_state != PRS_NORMAL) {
1321 if (racct_pcpu_available(p) <= 0) {
1322 if (p->p_racct->r_resources[RACCT_PCTCPU] >
1324 racct_proc_throttle(p, -1);
1325 } else if (p->p_throttled == -1) {
1326 racct_proc_wakeup(p);
1330 sx_sunlock(&allproc_lock);
1335 static struct kproc_desc racctd_kp = {
1347 kproc_start(&racctd_kp);
1349 SYSINIT(racctd, SI_SUB_RACCTD, SI_ORDER_FIRST, racctd_init, NULL);
1357 racct_zone = uma_zcreate("racct", sizeof(struct racct),
1358 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1359 ast_register(TDA_RACCT, ASTR_ASTF_REQUIRED, 0, ast_racct);
1362 * XXX: Move this somewhere.
1364 prison0.pr_prison_racct = prison_racct_find("0");
1366 SYSINIT(racct, SI_SUB_RACCT, SI_ORDER_FIRST, racct_init, NULL);