sys/sys/resourcevar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)resourcevar.h       8.4 (Berkeley) 1/9/95
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_RESOURCEVAR_H_
  36 #define _SYS_RESOURCEVAR_H_
  37
  38 #include <sys/resource.h>
  39 #include <sys/queue.h>
  40 #ifdef _KERNEL
  41 #include <sys/_lock.h>
  42 #include <sys/_mutex.h>
  43 #endif
  44
  45 /*
  46  * Kernel per-process accounting / statistics
  47  * (not necessarily resident except when running).
  48  *
  49  * Locking key:
  50  *      b - created at fork, never changes
  51  *      c - locked by proc mtx
  52  *      k - only accessed by curthread
  53  *      w - locked by proc itim lock
  54  *      w2 - locked by proc prof lock
  55  */
  56 struct pstats {
  57 #define pstat_startzero p_cru
  58         struct  rusage p_cru;           /* Stats for reaped children. */
  59         struct  itimerval p_timer[3];   /* (w) Virtual-time timers. */
  60 #define pstat_endzero   pstat_startcopy
  61
  62 #define pstat_startcopy p_prof
  63         struct uprof {                  /* Profile arguments. */
  64                 caddr_t pr_base;        /* (c + w2) Buffer base. */
  65                 u_long  pr_size;        /* (c + w2) Buffer size. */
  66                 u_long  pr_off;         /* (c + w2) PC offset. */
  67                 u_long  pr_scale;       /* (c + w2) PC scaling. */
  68         } p_prof;
  69 #define pstat_endcopy   p_start
  70         struct  timeval p_start;        /* (b) Starting time. */
  71 };
  72
  73 #ifdef _KERNEL
  74
  75 /*
  76  * Kernel shareable process resource limits.  Because this structure
  77  * is moderately large but changes infrequently, it is normally
  78  * shared copy-on-write after forks.
  79  */
  80 struct plimit {
  81         struct  rlimit pl_rlimit[RLIM_NLIMITS];
  82         int     pl_refcnt;              /* number of references */
  83 };
  84
  85 struct limbatch {
  86         struct plimit *limp;
  87         int count;
  88 };
  89
  90 static inline void
  91 limbatch_prep(struct limbatch *lb)
  92 {
  93         lb->limp = NULL;
  94         lb->count = 0;
  95 }
  96
  97 void    limbatch_add(struct limbatch *lb, struct thread *td);
  98
  99 static inline void
 100 limbatch_process(struct limbatch *lb __unused)
 101 {
 102
 103 }
 104
 105 void    limbatch_final(struct limbatch *lb);
 106
 107 struct racct;
 108
 109 /*-
 110  * Per uid resource consumption.  This structure is used to track
 111  * the total resource consumption (process count, socket buffer size,
 112  * etc) for the uid and impose limits.
 113  *
 114  * Locking guide:
 115  * (a) Constant from inception
 116  * (b) Lockless, updated using atomics
 117  * (c) Locked by global uihashtbl_lock
 118  */
 119 struct uidinfo {
 120         LIST_ENTRY(uidinfo) ui_hash;    /* (c) hash chain of uidinfos */
 121         u_long ui_vmsize;       /* (b) pages of swap reservation by uid */
 122         long    ui_sbsize;              /* (b) socket buffer space consumed */
 123         long    ui_proccnt;             /* (b) number of processes */
 124         long    ui_ptscnt;              /* (b) number of pseudo-terminals */
 125         long    ui_kqcnt;               /* (b) number of kqueues */
 126         long    ui_umtxcnt;             /* (b) number of shared umtxs */
 127         uid_t   ui_uid;                 /* (a) uid */
 128         u_int   ui_ref;                 /* (b) reference count */
 129 #ifdef  RACCT
 130         struct racct *ui_racct;         /* (a) resource accounting */
 131 #endif
 132 };
 133
 134 struct proc;
 135 struct rusage_ext;
 136 struct thread;
 137
 138 void     addupc_intr(struct thread *td, uintfptr_t pc, u_int ticks);
 139 void     addupc_task(struct thread *td, uintfptr_t pc, u_int ticks);
 140 void     calccru(struct proc *p, struct timeval *up, struct timeval *sp);
 141 void     calcru(struct proc *p, struct timeval *up, struct timeval *sp);
 142 int      chgkqcnt(struct uidinfo *uip, int diff, rlim_t max);
 143 int      chgproccnt(struct uidinfo *uip, int diff, rlim_t maxval);
 144 int      chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
 145             rlim_t maxval);
 146 int      chgptscnt(struct uidinfo *uip, int diff, rlim_t maxval);
 147 int      chgumtxcnt(struct uidinfo *uip, int diff, rlim_t maxval);
 148 int      kern_proc_setrlimit(struct thread *td, struct proc *p, u_int which,
 149             struct rlimit *limp);
 150 struct plimit
 151         *lim_alloc(void);
 152 void     lim_copy(struct plimit *dst, struct plimit *src);
 153 rlim_t   lim_cur(struct thread *td, int which);
 154 #define lim_cur(td, which)      ({                                      \
 155         rlim_t _rlim;                                                   \
 156         struct thread *_td = (td);                                      \
 157         int _which = (which);                                           \
 158         if (__builtin_constant_p(which) && which != RLIMIT_DATA &&      \
 159             which != RLIMIT_STACK && which != RLIMIT_VMEM) {            \
 160                 _rlim = _td->td_limit->pl_rlimit[_which].rlim_cur;      \
 161         } else {                                                        \
 162                 _rlim = lim_cur(_td, _which);                           \
 163         }                                                               \
 164         _rlim;                                                          \
 165 })
 166
 167 rlim_t   lim_cur_proc(struct proc *p, int which);
 168 void     lim_fork(struct proc *p1, struct proc *p2);
 169 void     lim_free(struct plimit *limp);
 170 void     lim_freen(struct plimit *limp, int n);
 171 struct plimit
 172         *lim_hold(struct plimit *limp);
 173 struct plimit
 174         *lim_cowsync(void);
 175 rlim_t   lim_max(struct thread *td, int which);
 176 rlim_t   lim_max_proc(struct proc *p, int which);
 177 void     lim_rlimit(struct thread *td, int which, struct rlimit *rlp);
 178 void     lim_rlimit_proc(struct proc *p, int which, struct rlimit *rlp);
 179 void     ruadd(struct rusage *ru, struct rusage_ext *rux, struct rusage *ru2,
 180             struct rusage_ext *rux2);
 181 void     rucollect(struct rusage *ru, struct rusage *ru2);
 182 void     rufetch(struct proc *p, struct rusage *ru);
 183 void     rufetchcalc(struct proc *p, struct rusage *ru, struct timeval *up,
 184             struct timeval *sp);
 185 void     rufetchtd(struct thread *td, struct rusage *ru);
 186 void     ruxagg(struct proc *p, struct thread *td);
 187 void     ruxagg_locked(struct proc *p, struct thread *td);
 188 struct uidinfo
 189         *uifind(uid_t uid);
 190 void     uifree(struct uidinfo *uip);
 191 void     uihashinit(void);
 192 void     uihold(struct uidinfo *uip);
 193 #ifdef  RACCT
 194 void     ui_racct_foreach(void (*callback)(struct racct *racct,
 195             void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
 196             void *arg2, void *arg3);
 197 #endif
 198
 199 #endif /* _KERNEL */
 200 #endif /* !_SYS_RESOURCEVAR_H_ */