xref: /freebsd/sys/sys/resourcevar.h (revision 91d5354a)
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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)resourcevar.h	8.4 (Berkeley) 1/9/95
34  * $FreeBSD$
35  */
36 
37 #ifndef	_SYS_RESOURCEVAR_H_
38 #define	_SYS_RESOURCEVAR_H_
39 
40 #include <sys/resource.h>
41 #include <sys/queue.h>
42 #ifdef _KERNEL
43 #include <sys/_lock.h>
44 #include <sys/_mutex.h>
45 #endif
46 
47 /*
48  * Kernel per-process accounting / statistics
49  * (not necessarily resident except when running).
50  */
51 struct pstats {
52 #define	pstat_startzero	p_ru
53 	struct	rusage p_ru;		/* stats for this proc */
54 	struct	rusage p_cru;		/* sum of stats for reaped children */
55 	struct	itimerval p_timer[3];	/* virtual-time timers */
56 #define	pstat_endzero	pstat_startcopy
57 
58 #define	pstat_startcopy	p_prof
59 	struct uprof {			/* profile arguments */
60 		caddr_t	pr_base;	/* buffer base */
61 		u_long	pr_size;	/* buffer size */
62 		u_long	pr_off;		/* pc offset */
63 		u_long	pr_scale;	/* pc scaling */
64 		u_long	pr_addr;	/* temp storage for addr until AST */
65 		u_int	pr_ticks;	/* temp storage for ticks until AST */
66 	} p_prof;
67 #define	pstat_endcopy	p_start
68 	struct	timeval p_start;	/* starting time */
69 };
70 
71 /*
72  * Kernel shareable process resource limits.  Because this structure
73  * is moderately large but changes infrequently, it is normally
74  * shared copy-on-write after forks.
75  */
76 struct plimit {
77 	struct	rlimit pl_rlimit[RLIM_NLIMITS];
78 	int	pl_refcnt;		/* number of references */
79 	struct	mtx pl_mtx;
80 };
81 
82 #ifdef _KERNEL
83 
84 /*
85  * Lock order for operations involving the plimit lock:
86  *      filedesc  <important to avoid deadlocks in the descriptor code>
87  *      proc
88  *      plimit
89  */
90 #define LIM_LOCK(lim)		mtx_lock(&(lim)->pl_mtx)
91 #define LIM_UNLOCK(lim)		mtx_unlock(&(lim)->pl_mtx)
92 #define LIM_LOCK_ASSERT(lim, f)	mtx_assert(&(lim)->pl_mtx, (f))
93 
94 /*
95  * Per uid resource consumption
96  */
97 struct uidinfo {
98 	LIST_ENTRY(uidinfo) ui_hash;
99 	rlim_t	ui_sbsize;		/* socket buffer space consumed */
100 	long	ui_proccnt;		/* number of processes */
101 	uid_t	ui_uid;			/* uid */
102 	u_int	ui_ref;			/* reference count */
103 	struct mtx	*ui_mtxp;	/* protect all counts/limits */
104 };
105 
106 #define	UIDINFO_LOCK(ui)	mtx_lock((ui)->ui_mtxp)
107 #define	UIDINFO_UNLOCK(ui)	mtx_unlock((ui)->ui_mtxp)
108 
109 struct thread;
110 struct kse;
111 struct proc;
112 
113 void	 addupc_intr(struct thread *td, uintptr_t pc, u_int ticks);
114 void	 addupc_task(struct thread *td, uintptr_t pc, u_int ticks);
115 void	 calcru(struct proc *p, struct timeval *up, struct timeval *sp,
116 	    struct timeval *ip);
117 int	 chgproccnt(struct uidinfo *uip, int diff, int max);
118 int	 chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
119 	    rlim_t max);
120 int	 fuswintr(void *base);
121 rlim_t	 lim_cur(struct proc *p, int which);
122 rlim_t	 lim_max(struct proc *p, int which);
123 void	 lim_rlimit(struct proc *p, int which, struct rlimit *rlp);
124 void	 lim_copy(struct plimit *dst, struct plimit *src);
125 void	 lim_free(struct plimit *limp);
126 struct plimit
127 	*lim_alloc(void);
128 struct plimit
129 	*lim_hold(struct plimit *limp);
130 void	 ruadd(struct rusage *ru, struct rusage *ru2);
131 int	 suswintr(void *base, int word);
132 struct uidinfo
133 	*uifind(uid_t uid);
134 void	 uihold(struct uidinfo *uip);
135 void	 uifree(struct uidinfo *uip);
136 void	uihashinit(void);
137 #endif
138 
139 #endif	/* !_SYS_RESOURCEVAR_H_ */
140