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