1/*-
2 * Copyright (c) 1991, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)resourcevar.h	8.4 (Berkeley) 1/9/95
30 * $FreeBSD$
31 */
32
33#ifndef	_SYS_RESOURCEVAR_H_
34#define	_SYS_RESOURCEVAR_H_
35
36#include <sys/resource.h>
37#include <sys/queue.h>
38#ifdef _KERNEL
39#include <sys/_lock.h>
40#include <sys/_mutex.h>
41#endif
42
43/*
44 * Kernel per-process accounting / statistics
45 * (not necessarily resident except when running).
46 *
47 * Locking key:
48 *      b - created at fork, never changes
49 *      c - locked by proc mtx
50 *      j - locked by proc slock
51 *      k - only accessed by curthread
52 */
53struct pstats {
54#define	pstat_startzero	p_cru
55	struct	rusage p_cru;		/* Stats for reaped children. */
56	struct	itimerval p_timer[3];	/* (j) 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 + j) Buffer base. */
62		u_long	pr_size;	/* (c + j) Buffer size. */
63		u_long	pr_off;		/* (c + j) PC offset. */
64		u_long	pr_scale;	/* (c + j) 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 racct;
83
84/*-
85 * Per uid resource consumption.  This structure is used to track
86 * the total resource consumption (process count, socket buffer size,
87 * etc) for the uid and impose limits.
88 *
89 * Locking guide:
90 * (a) Constant from inception
91 * (b) Lockless, updated using atomics
92 * (c) Locked by global uihashtbl_mtx
93 * (d) Locked by the ui_vmsize_mtx
94 */
95struct uidinfo {
96	LIST_ENTRY(uidinfo) ui_hash;	/* (c) hash chain of uidinfos */
97	struct mtx ui_vmsize_mtx;
98	vm_ooffset_t ui_vmsize;		/* (d) 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	uid_t	ui_uid;			/* (a) uid */
103	u_int	ui_ref;			/* (b) reference count */
104	struct racct *ui_racct;		/* (a) resource accounting */
105};
106
107#define	UIDINFO_VMSIZE_LOCK(ui)		mtx_lock(&((ui)->ui_vmsize_mtx))
108#define	UIDINFO_VMSIZE_UNLOCK(ui)	mtx_unlock(&((ui)->ui_vmsize_mtx))
109
110struct proc;
111struct rusage_ext;
112struct thread;
113
114void	 addupc_intr(struct thread *td, uintfptr_t pc, u_int ticks);
115void	 addupc_task(struct thread *td, uintfptr_t pc, u_int ticks);
116void	 calccru(struct proc *p, struct timeval *up, struct timeval *sp);
117void	 calcru(struct proc *p, struct timeval *up, struct timeval *sp);
118int	 chgproccnt(struct uidinfo *uip, int diff, rlim_t maxval);
119int	 chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
120	    rlim_t maxval);
121int	 chgptscnt(struct uidinfo *uip, int diff, rlim_t maxval);
122int	 fuswintr(void *base);
123int	 kern_proc_setrlimit(struct thread *td, struct proc *p, u_int which,
124	    struct rlimit *limp);
125struct plimit
126	*lim_alloc(void);
127void	 lim_copy(struct plimit *dst, struct plimit *src);
128rlim_t	 lim_cur(struct proc *p, int which);
129void	 lim_fork(struct proc *p1, struct proc *p2);
130void	 lim_free(struct plimit *limp);
131struct plimit
132	*lim_hold(struct plimit *limp);
133rlim_t	 lim_max(struct proc *p, int which);
134void	 lim_rlimit(struct proc *p, int which, struct rlimit *rlp);
135void	 ruadd(struct rusage *ru, struct rusage_ext *rux, struct rusage *ru2,
136	    struct rusage_ext *rux2);
137void	 rucollect(struct rusage *ru, struct rusage *ru2);
138void	 rufetch(struct proc *p, struct rusage *ru);
139void	 rufetchcalc(struct proc *p, struct rusage *ru, struct timeval *up,
140	    struct timeval *sp);
141void	 rufetchtd(struct thread *td, struct rusage *ru);
142void	 ruxagg(struct proc *p, struct thread *td);
143int	 suswintr(void *base, int word);
144struct uidinfo
145	*uifind(uid_t uid);
146void	 uifree(struct uidinfo *uip);
147void	 uihashinit(void);
148void	 uihold(struct uidinfo *uip);
149void	 ui_racct_foreach(void (*callback)(struct racct *racct,
150	    void *arg2, void *arg3), void *arg2, void *arg3);
151
152#endif /* _KERNEL */
153#endif /* !_SYS_RESOURCEVAR_H_ */
154