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  */
  33
  34 #ifndef _SYS_RESOURCEVAR_H_
  35 #define _SYS_RESOURCEVAR_H_
  36
  37 #include <sys/resource.h>
  38 #include <sys/queue.h>
  39 #ifdef _KERNEL
  40 #include <sys/_lock.h>
  41 #include <sys/_mutex.h>
  42 #endif
  43
  44 /*
  45  * Kernel per-process accounting / statistics
  46  * (not necessarily resident except when running).
  47  *
  48  * Locking key:
  49  *      b - created at fork, never changes
  50  *      c - locked by proc mtx
  51  *      k - only accessed by curthread
  52  *      w - locked by proc itim lock
  53  *      w2 - locked by proc prof lock
  54  */
  55 struct pstats {
  56 #define pstat_startzero p_cru
  57         struct  rusage p_cru;           /* Stats for reaped children. */
  58         struct  itimerval p_timer[3];   /* (w) Virtual-time timers. */
  59 #define pstat_endzero   pstat_startcopy
  60
  61 #define pstat_startcopy p_prof
  62         struct uprof {                  /* Profile arguments. */
  63                 caddr_t pr_base;        /* (c + w2) Buffer base. */
  64                 u_long  pr_size;        /* (c + w2) Buffer size. */
  65                 u_long  pr_off;         /* (c + w2) PC offset. */
  66                 u_long  pr_scale;       /* (c + w2) PC scaling. */
  67         } p_prof;
  68 #define pstat_endcopy   p_start
  69         struct  timeval p_start;        /* (b) Starting time. */
  70 };
  71
  72 #ifdef _KERNEL
  73
  74 /*
  75  * Kernel shareable process resource limits.  Because this structure
  76  * is moderately large but changes infrequently, it is normally
  77  * shared copy-on-write after forks.
  78  */
  79 struct plimit {
  80         struct  rlimit pl_rlimit[RLIM_NLIMITS];
  81         int     pl_refcnt;              /* number of references */
  82 };
  83
  84 struct racct;
  85
  86 /*-
  87  * Per uid resource consumption.  This structure is used to track
  88  * the total resource consumption (process count, socket buffer size,
  89  * etc) for the uid and impose limits.
  90  *
  91  * Locking guide:
  92  * (a) Constant from inception
  93  * (b) Lockless, updated using atomics
  94  * (c) Locked by global uihashtbl_lock
  95  */
  96 struct uidinfo {
  97         LIST_ENTRY(uidinfo) ui_hash;    /* (c) hash chain of uidinfos */
  98         u_long ui_vmsize;       /* (b) pages of swap reservation by uid */
  99         long    ui_sbsize;              /* (b) socket buffer space consumed */
 100         long    ui_proccnt;             /* (b) number of processes */
 101         long    ui_ptscnt;              /* (b) number of pseudo-terminals */
 102         long    ui_kqcnt;               /* (b) number of kqueues */
 103         long    ui_umtxcnt;             /* (b) number of shared umtxs */
 104         uid_t   ui_uid;                 /* (a) uid */
 105         u_int   ui_ref;                 /* (b) reference count */
 106 #ifdef  RACCT
 107         struct racct *ui_racct;         /* (a) resource accounting */
 108 #endif
 109 };
 110
 111 struct proc;
 112 struct rusage_ext;
 113 struct thread;
 114
 115 void     addupc_intr(struct thread *td, uintfptr_t pc, u_int ticks);
 116 void     addupc_task(struct thread *td, uintfptr_t pc, u_int ticks);
 117 void     calccru(struct proc *p, struct timeval *up, struct timeval *sp);
 118 void     calcru(struct proc *p, struct timeval *up, struct timeval *sp);
 119 int      chgkqcnt(struct uidinfo *uip, int diff, rlim_t max);
 120 int      chgproccnt(struct uidinfo *uip, int diff, rlim_t maxval);
 121 int      chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
 122             rlim_t maxval);
 123 int      chgptscnt(struct uidinfo *uip, int diff, rlim_t maxval);
 124 int      chgumtxcnt(struct uidinfo *uip, int diff, rlim_t maxval);
 125 int      kern_proc_setrlimit(struct thread *td, struct proc *p, u_int which,
 126             struct rlimit *limp);
 127 struct plimit
 128         *lim_alloc(void);
 129 void     lim_copy(struct plimit *dst, struct plimit *src);
 130 rlim_t   lim_cur(struct thread *td, int which);
 131 #define lim_cur(td, which)      ({                                      \
 132         rlim_t _rlim;                                                   \
 133         struct thread *_td = (td);                                      \
 134         int _which = (which);                                           \
 135         if (__builtin_constant_p(which) && which != RLIMIT_DATA &&      \
 136             which != RLIMIT_STACK && which != RLIMIT_VMEM) {            \
 137                 _rlim = _td->td_limit->pl_rlimit[_which].rlim_cur;      \
 138         } else {                                                        \
 139                 _rlim = lim_cur(_td, _which);                           \
 140         }                                                               \
 141         _rlim;                                                          \
 142 })
 143
 144 rlim_t   lim_cur_proc(struct proc *p, int which);
 145 void     lim_fork(struct proc *p1, struct proc *p2);
 146 void     lim_free(struct plimit *limp);
 147 void     lim_freen(struct plimit *limp, int n);
 148 struct plimit
 149         *lim_hold(struct plimit *limp);
 150 rlim_t   lim_max(struct thread *td, int which);
 151 rlim_t   lim_max_proc(struct proc *p, int which);
 152 void     lim_rlimit(struct thread *td, int which, struct rlimit *rlp);
 153 void     lim_rlimit_proc(struct proc *p, int which, struct rlimit *rlp);
 154 void     ruadd(struct rusage *ru, struct rusage_ext *rux, struct rusage *ru2,
 155             struct rusage_ext *rux2);
 156 void     rucollect(struct rusage *ru, struct rusage *ru2);
 157 void     rufetch(struct proc *p, struct rusage *ru);
 158 void     rufetchcalc(struct proc *p, struct rusage *ru, struct timeval *up,
 159             struct timeval *sp);
 160 void     rufetchtd(struct thread *td, struct rusage *ru);
 161 void     ruxagg(struct proc *p, struct thread *td);
 162 void     ruxagg_locked(struct proc *p, struct thread *td);
 163 struct uidinfo
 164         *uifind(uid_t uid);
 165 void     uifree(struct uidinfo *uip);
 166 void     uihashinit(void);
 167 void     uihold(struct uidinfo *uip);
 168 #ifdef  RACCT
 169 void     ui_racct_foreach(void (*callback)(struct racct *racct,
 170             void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
 171             void *arg2, void *arg3);
 172 #endif
 173
 174 #endif /* _KERNEL */
 175 #endif /* !_SYS_RESOURCEVAR_H_ */