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 racct;
  86
  87 /*-
  88  * Per uid resource consumption.  This structure is used to track
  89  * the total resource consumption (process count, socket buffer size,
  90  * etc) for the uid and impose limits.
  91  *
  92  * Locking guide:
  93  * (a) Constant from inception
  94  * (b) Lockless, updated using atomics
  95  * (c) Locked by global uihashtbl_lock
  96  */
  97 struct uidinfo {
  98         LIST_ENTRY(uidinfo) ui_hash;    /* (c) hash chain of uidinfos */
  99         u_long ui_vmsize;       /* (b) pages of swap reservation by uid */
 100         long    ui_sbsize;              /* (b) socket buffer space consumed */
 101         long    ui_proccnt;             /* (b) number of processes */
 102         long    ui_ptscnt;              /* (b) number of pseudo-terminals */
 103         long    ui_kqcnt;               /* (b) number of kqueues */
 104         long    ui_umtxcnt;             /* (b) number of shared umtxs */
 105         uid_t   ui_uid;                 /* (a) uid */
 106         u_int   ui_ref;                 /* (b) reference count */
 107 #ifdef  RACCT
 108         struct racct *ui_racct;         /* (a) resource accounting */
 109 #endif
 110 };
 111
 112 struct proc;
 113 struct rusage_ext;
 114 struct thread;
 115
 116 void     addupc_intr(struct thread *td, uintfptr_t pc, u_int ticks);
 117 void     addupc_task(struct thread *td, uintfptr_t pc, u_int ticks);
 118 void     calccru(struct proc *p, struct timeval *up, struct timeval *sp);
 119 void     calcru(struct proc *p, struct timeval *up, struct timeval *sp);
 120 int      chgkqcnt(struct uidinfo *uip, int diff, rlim_t max);
 121 int      chgproccnt(struct uidinfo *uip, int diff, rlim_t maxval);
 122 int      chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
 123             rlim_t maxval);
 124 int      chgptscnt(struct uidinfo *uip, int diff, rlim_t maxval);
 125 int      chgumtxcnt(struct uidinfo *uip, int diff, rlim_t maxval);
 126 int      kern_proc_setrlimit(struct thread *td, struct proc *p, u_int which,
 127             struct rlimit *limp);
 128 struct plimit
 129         *lim_alloc(void);
 130 void     lim_copy(struct plimit *dst, struct plimit *src);
 131 rlim_t   lim_cur(struct thread *td, int which);
 132 #define lim_cur(td, which)      ({                                      \
 133         rlim_t _rlim;                                                   \
 134         struct thread *_td = (td);                                      \
 135         int _which = (which);                                           \
 136         if (__builtin_constant_p(which) && which != RLIMIT_DATA &&      \
 137             which != RLIMIT_STACK && which != RLIMIT_VMEM) {            \
 138                 _rlim = td->td_limit->pl_rlimit[which].rlim_cur;        \
 139         } else {                                                        \
 140                 _rlim = lim_cur(_td, _which);                           \
 141         }                                                               \
 142         _rlim;                                                          \
 143 })
 144
 145 rlim_t   lim_cur_proc(struct proc *p, int which);
 146 void     lim_fork(struct proc *p1, struct proc *p2);
 147 void     lim_free(struct plimit *limp);
 148 void     lim_freen(struct plimit *limp, int n);
 149 struct plimit
 150         *lim_hold(struct plimit *limp);
 151 rlim_t   lim_max(struct thread *td, int which);
 152 rlim_t   lim_max_proc(struct proc *p, int which);
 153 void     lim_rlimit(struct thread *td, int which, struct rlimit *rlp);
 154 void     lim_rlimit_proc(struct proc *p, int which, struct rlimit *rlp);
 155 void     ruadd(struct rusage *ru, struct rusage_ext *rux, struct rusage *ru2,
 156             struct rusage_ext *rux2);
 157 void     rucollect(struct rusage *ru, struct rusage *ru2);
 158 void     rufetch(struct proc *p, struct rusage *ru);
 159 void     rufetchcalc(struct proc *p, struct rusage *ru, struct timeval *up,
 160             struct timeval *sp);
 161 void     rufetchtd(struct thread *td, struct rusage *ru);
 162 void     ruxagg(struct proc *p, struct thread *td);
 163 void     ruxagg_locked(struct proc *p, struct thread *td);
 164 struct uidinfo
 165         *uifind(uid_t uid);
 166 void     uifree(struct uidinfo *uip);
 167 void     uihashinit(void);
 168 void     uihold(struct uidinfo *uip);
 169 #ifdef  RACCT
 170 void     ui_racct_foreach(void (*callback)(struct racct *racct,
 171             void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
 172             void *arg2, void *arg3);
 173 #endif
 174
 175 #endif /* _KERNEL */
 176 #endif /* !_SYS_RESOURCEVAR_H_ */