xref: /freebsd/sys/sys/resourcevar.h (revision bed4c524)
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  */
53 struct 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  */
77 struct plimit {
78 	struct	rlimit pl_rlimit[RLIM_NLIMITS];
79 	int	pl_refcnt;		/* number of references */
80 };
81 
82 /*-
83  * Per uid resource consumption
84  *
85  * Locking guide:
86  * (a) Constant from inception
87  * (b) Lockless, updated using atomics
88  * (c) Locked by global uihashtbl_mtx
89  * (d) Locked by the ui_vmsize_mtx
90  */
91 struct uidinfo {
92 	LIST_ENTRY(uidinfo) ui_hash;	/* (c) hash chain of uidinfos */
93 	struct mtx ui_vmsize_mtx;
94 	vm_ooffset_t ui_vmsize;		/* (d) swap reservation by uid */
95 	long	ui_sbsize;		/* (b) socket buffer space consumed */
96 	long	ui_proccnt;		/* (b) number of processes */
97 	long	ui_ptscnt;		/* (b) number of pseudo-terminals */
98 	uid_t	ui_uid;			/* (a) uid */
99 	u_int	ui_ref;			/* (b) reference count */
100 };
101 
102 #define	UIDINFO_VMSIZE_LOCK(ui)		mtx_lock(&((ui)->ui_vmsize_mtx))
103 #define	UIDINFO_VMSIZE_UNLOCK(ui)	mtx_unlock(&((ui)->ui_vmsize_mtx))
104 
105 struct proc;
106 struct rusage_ext;
107 struct thread;
108 
109 void	 addupc_intr(struct thread *td, uintfptr_t pc, u_int ticks);
110 void	 addupc_task(struct thread *td, uintfptr_t pc, u_int ticks);
111 void	 calccru(struct proc *p, struct timeval *up, struct timeval *sp);
112 void	 calcru(struct proc *p, struct timeval *up, struct timeval *sp);
113 int	 chgproccnt(struct uidinfo *uip, int diff, rlim_t maxval);
114 int	 chgsbsize(struct uidinfo *uip, u_int *hiwat, u_int to,
115 	    rlim_t maxval);
116 int	 chgptscnt(struct uidinfo *uip, int diff, rlim_t maxval);
117 int	 fuswintr(void *base);
118 struct plimit
119 	*lim_alloc(void);
120 void	 lim_copy(struct plimit *dst, struct plimit *src);
121 rlim_t	 lim_cur(struct proc *p, int which);
122 void	 lim_fork(struct proc *p1, struct proc *p2);
123 void	 lim_free(struct plimit *limp);
124 struct plimit
125 	*lim_hold(struct plimit *limp);
126 rlim_t	 lim_max(struct proc *p, int which);
127 void	 lim_rlimit(struct proc *p, int which, struct rlimit *rlp);
128 void	 ruadd(struct rusage *ru, struct rusage_ext *rux, struct rusage *ru2,
129 	    struct rusage_ext *rux2);
130 void	 rucollect(struct rusage *ru, struct rusage *ru2);
131 void	 rufetch(struct proc *p, struct rusage *ru);
132 void	 rufetchcalc(struct proc *p, struct rusage *ru, struct timeval *up,
133 	    struct timeval *sp);
134 void	 ruxagg_locked(struct rusage_ext *rux, struct thread *td);
135 int	 suswintr(void *base, int word);
136 struct uidinfo
137 	*uifind(uid_t uid);
138 void	 uifree(struct uidinfo *uip);
139 void	 uihashinit(void);
140 void	 uihold(struct uidinfo *uip);
141 
142 #endif /* _KERNEL */
143 #endif /* !_SYS_RESOURCEVAR_H_ */
144