xref: /xnu-10063.121.3/bsd/sys/resourcevar.h (revision 2c2f96dc2b9a4408a43d3150ae9c105355ca3daa)
1 /*
2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
29 /*
30  * Copyright (c) 1991, 1993
31  *	The Regents of the University of California.  All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  * 1. Redistributions of source code must retain the above copyright
37  *    notice, this list of conditions and the following disclaimer.
38  * 2. Redistributions in binary form must reproduce the above copyright
39  *    notice, this list of conditions and the following disclaimer in the
40  *    documentation and/or other materials provided with the distribution.
41  * 3. All advertising materials mentioning features or use of this software
42  *    must display the following acknowledgement:
43  *	This product includes software developed by the University of
44  *	California, Berkeley and its contributors.
45  * 4. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)resourcevar.h	8.4 (Berkeley) 1/9/95
62  */
63 
64 #ifndef _SYS_RESOURCEVAR_H_
65 #define _SYS_RESOURCEVAR_H_
66 
67 #include <sys/appleapiopts.h>
68 #include <sys/resource.h>
69 #include <sys/_types/_caddr_t.h>
70 #ifdef XNU_KERNEL_PRIVATE
71 #include <kern/smr_types.h>
72 #include <os/refcnt.h>
73 #endif
74 
75 /*
76  * Kernel per-process accounting / statistics
77  * (not necessarily resident except when running).
78  */
79 struct pstats {
80 	struct  rusage            p_ru;         /* stats for this proc */
81 	struct  rusage            p_cru;        /* (PL) sum of stats for reaped children */
82 
83 	struct uprof {                  /* profile arguments */
84 		struct uprof *pr_next;  /* multiple prof buffers allowed */
85 		caddr_t pr_base;        /* buffer base */
86 		u_int32_t       pr_size;        /* buffer size */
87 		u_int32_t       pr_off;         /* pc offset */
88 		u_int32_t       pr_scale;       /* pc scaling */
89 		u_int32_t       pr_addr;        /* temp storage for addr until AST */
90 		u_int32_t       pr_ticks;       /* temp storage for ticks until AST */
91 	} p_prof;
92 
93 	uint64_t ps_start;              /* starting time ; compat only */
94 #ifdef XNU_KERNEL_PRIVATE
95 	struct  rusage_info_child ri_child;     /* (PL) sum of additional stats for reaped children (proc_pid_rusage) */
96 	struct user_uprof {                         /* profile arguments */
97 		struct user_uprof *pr_next;  /* multiple prof buffers allowed */
98 		user_addr_t         pr_base;    /* buffer base */
99 		user_size_t         pr_size;    /* buffer size */
100 		user_ulong_t    pr_off;         /* pc offset */
101 		user_ulong_t    pr_scale;       /* pc scaling */
102 		user_ulong_t    pr_addr;        /* temp storage for addr until AST */
103 		user_ulong_t    pr_ticks;       /* temp storage for ticks until AST */
104 	} user_p_prof;
105 #endif // XNU_KERNEL_PRIVATE
106 };
107 
108 #ifdef XNU_KERNEL_PRIVATE
109 #pragma GCC visibility push(hidden)
110 /*
111  * Kernel shareable process resource limits:
112  * Because this structure is moderately large but changed infrequently, it is normally
113  * shared copy-on-write after a fork. The pl_refcnt variable records the number of
114  * "processes" (NOT threads) currently sharing the plimit. A plimit is freed when the
115  * last referencing process exits the system. The refcnt of the plimit is a race-free
116  * _Atomic variable. We allocate new plimits in proc_limitupdate and free them
117  * in proc_limitdrop/proc_limitupdate.
118  */
119 struct plimit {
120 	struct smr_node  pl_node;
121 	struct rlimit    pl_rlimit[RLIM_NLIMITS];
122 	os_refcnt_t      pl_refcnt;
123 };
124 struct proc;
125 
126 void calcru(struct proc *p, struct timeval *up, struct timeval *sp, struct timeval *ip);
127 void ruadd(struct rusage *ru, struct rusage *ru2);
128 void update_rusage_info_child(struct rusage_info_child *ru, rusage_info_current *ru_current);
129 struct rlimit proc_limitget(struct proc *p, int which);
130 void proc_limitfork(struct proc *parent, struct proc *child);
131 void proc_limitdrop(struct proc *p);
132 rlim_t proc_limitgetcur(struct proc *p, int which);
133 void proc_limitsetcur_fsize(struct proc *p, rlim_t value);
134 int proc_limitgetcur_nofile(struct proc *p);
135 
136 void gather_rusage_info(struct proc *p, rusage_info_current *ru, int flavor);
137 int proc_get_rusage(struct proc *proc, int flavor, user_addr_t buffer, int is_zombie);
138 int iopolicysys_vfs_materialize_dataless_files(struct proc *p, int cmd, int scope,
139     int policy, struct _iopol_param_t *iop_param);
140 
141 #pragma GCC visibility pop
142 #endif /* XNU_KERNEL_PRIVATE */
143 #endif  /* !_SYS_RESOURCEVAR_H_ */
144