]>
Commit | Line | Data |
---|---|---|
1c79356b | 1 | /* |
39236c6e | 2 | * Copyright (c) 2000-2012 Apple Inc. All rights reserved. |
5d5c5d0d | 3 | * |
2d21ac55 | 4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
1c79356b | 5 | * |
2d21ac55 A |
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. | |
8f6c56a5 | 14 | * |
2d21ac55 A |
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 | |
8f6c56a5 A |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
2d21ac55 A |
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. | |
8f6c56a5 | 25 | * |
2d21ac55 | 26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ |
1c79356b A |
27 | */ |
28 | /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */ | |
29 | /* | |
30 | * Copyright (c) 1982, 1986, 1989, 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 | * @(#)user.h 8.2 (Berkeley) 9/23/93 | |
62 | */ | |
63 | ||
64 | #ifndef _SYS_USER_H_ | |
65 | #define _SYS_USER_H_ | |
66 | ||
9bccf70c | 67 | #include <sys/appleapiopts.h> |
3e170ce0 | 68 | struct waitq_set; |
1c79356b A |
69 | #ifndef KERNEL |
70 | /* stuff that *used* to be included by user.h, or is now needed */ | |
71 | #include <errno.h> | |
72 | #include <sys/time.h> | |
73 | #include <sys/resource.h> | |
74 | #include <sys/ucred.h> | |
75 | #include <sys/uio.h> | |
76 | #endif | |
b0d623f7 | 77 | #ifdef XNU_KERNEL_PRIVATE |
1c79356b A |
78 | #include <sys/resourcevar.h> |
79 | #include <sys/signalvar.h> | |
91447636 | 80 | #endif |
1c79356b A |
81 | #include <sys/vm.h> /* XXX */ |
82 | #include <sys/sysctl.h> | |
6d2010ae | 83 | |
1c79356b | 84 | #ifdef KERNEL |
6d2010ae A |
85 | #ifdef BSD_KERNEL_PRIVATE |
86 | #include <sys/pthread_internal.h> /* for uu_kwe entry */ | |
87 | #endif /* BSD_KERNEL_PRIVATE */ | |
9bccf70c | 88 | #ifdef __APPLE_API_PRIVATE |
91447636 A |
89 | #include <sys/eventvar.h> |
90 | ||
b0d623f7 | 91 | #if !defined(__LP64__) || defined(XNU_KERNEL_PRIVATE) |
2d21ac55 A |
92 | /* |
93 | * VFS context structure (part of uthread) | |
94 | */ | |
95 | struct vfs_context { | |
96 | thread_t vc_thread; /* pointer to Mach thread */ | |
97 | kauth_cred_t vc_ucred; /* per thread credential */ | |
98 | }; | |
99 | ||
b0d623f7 A |
100 | #endif /* !__LP64 || XNU_KERNEL_PRIVATE */ |
101 | ||
102 | #ifdef BSD_KERNEL_PRIVATE | |
2d21ac55 A |
103 | /* XXX Deprecated: xnu source compatability */ |
104 | #define uu_ucred uu_context.vc_ucred | |
105 | ||
316670eb A |
106 | struct label; /* MAC label dummy struct */ |
107 | ||
b0d623f7 | 108 | #define MAXTHREADNAMESIZE 64 |
1c79356b A |
109 | /* |
110 | * Per-thread U area. | |
1c79356b | 111 | */ |
2d21ac55 | 112 | |
1c79356b | 113 | struct uthread { |
1c79356b | 114 | /* syscall parameters, results and catches */ |
d1ecb069 | 115 | u_int64_t uu_arg[8]; /* arguments to current system call */ |
2d21ac55 | 116 | int uu_rval[2]; |
fe8ab488 | 117 | unsigned int syscall_code; /* current syscall code */ |
1c79356b A |
118 | |
119 | /* thread exception handling */ | |
2d21ac55 A |
120 | mach_exception_code_t uu_code; /* ``code'' to trap */ |
121 | mach_exception_subcode_t uu_subcode; | |
39236c6e | 122 | int uu_exception; |
91447636 | 123 | char uu_cursig; /* p_cursig for exc. */ |
2d21ac55 | 124 | /* support for syscalls which use continuations */ |
39236c6e A |
125 | union { |
126 | struct _select_data { | |
2d21ac55 | 127 | u_int64_t abstime; |
3e170ce0 | 128 | uint64_t *wqp; |
2d21ac55 | 129 | int count; |
39037602 A |
130 | struct select_nocancel_args *args; /* original syscall arguments */ |
131 | int32_t *retval; /* place to store return val */ | |
39236c6e | 132 | } ss_select_data; |
b0d623f7 | 133 | struct _kqueue_scan { |
39037602 A |
134 | kevent_callback_t call; /* per-event callback */ |
135 | kqueue_continue_t cont; /* whole call continuation */ | |
136 | filt_process_data_t process_data; /* needed for filter processing */ | |
137 | uint8_t servicer_qos_index; /* requested qos index of servicer */ | |
138 | uint64_t deadline; /* computed deadline for operation */ | |
139 | void *data; /* caller's private data */ | |
140 | } ss_kqueue_scan; /* saved state for kevent_scan() */ | |
91447636 | 141 | struct _kevent { |
39037602 A |
142 | struct _kqueue_scan scan; /* space for the generic data */ |
143 | struct fileproc *fp; /* fileproc we hold iocount on */ | |
144 | int fd; /* filedescriptor for kq */ | |
145 | int eventcount; /* user-level event count */ | |
146 | int eventout; /* number of events output */ | |
147 | struct filt_process_s process_data; /* space for process data fed thru */ | |
148 | int32_t *retval; /* place to store return val */ | |
149 | user_addr_t eventlist; /* user-level event list address */ | |
150 | uint64_t data_available; /* [user/kernel] addr of in/out size */ | |
91447636 | 151 | } ss_kevent; /* saved state for kevent() */ |
39236c6e A |
152 | |
153 | struct _kauth { | |
154 | user_addr_t message; /* message in progress */ | |
155 | } uu_kauth; | |
156 | ||
157 | struct ksyn_waitq_element uu_kwe; /* user for pthread synch */ | |
fe8ab488 A |
158 | |
159 | struct _waitid_data { | |
160 | struct waitid_nocancel_args *args; /* original syscall arguments */ | |
161 | int32_t *retval; /* place to store return val */ | |
162 | } uu_waitid_data; | |
163 | ||
164 | struct _wait4_data { | |
165 | struct wait4_nocancel_args *args; /* original syscall arguments */ | |
166 | int32_t *retval; /* place to store return val */ | |
167 | } uu_wait4_data; | |
2d21ac55 | 168 | } uu_kevent; |
39236c6e | 169 | |
fe8ab488 | 170 | /* Persistent memory allocations across system calls */ |
39236c6e A |
171 | struct _select { |
172 | u_int32_t *ibits, *obits; /* bits to select on */ | |
173 | uint nbytes; /* number of bytes in ibits and obits */ | |
39236c6e A |
174 | } uu_select; /* saved state for select() */ |
175 | ||
1c79356b A |
176 | /* internal support for continuation framework */ |
177 | int (*uu_continuation)(int); | |
178 | int uu_pri; | |
179 | int uu_timo; | |
2d21ac55 A |
180 | caddr_t uu_wchan; /* sleeping thread wait channel */ |
181 | const char *uu_wmesg; /* ... wait message */ | |
0b4e3aa0 | 182 | struct proc * uu_proc; |
316670eb | 183 | thread_t uu_thread; |
0b4e3aa0 | 184 | void * uu_userstate; |
3e170ce0 A |
185 | struct waitq_set *uu_wqset; /* waitq state cached across select calls */ |
186 | size_t uu_wqstate_sz; /* ...size of uu_wqset buffer */ | |
39236c6e | 187 | int uu_flag; |
9bccf70c A |
188 | sigset_t uu_siglist; /* signals pending for the thread */ |
189 | sigset_t uu_sigwait; /* sigwait on this thread*/ | |
190 | sigset_t uu_sigmask; /* signal mask for the thread */ | |
191 | sigset_t uu_oldmask; /* signal mask saved before sigpause */ | |
9bccf70c | 192 | sigset_t uu_vforkmask; /* saved signal mask during vfork */ |
39236c6e | 193 | struct vfs_context uu_context; /* thread + cred */ |
9bccf70c A |
194 | |
195 | TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */ | |
55e303ae | 196 | |
b0d623f7 | 197 | struct kaudit_record *uu_ar; /* audit record */ |
55e303ae | 198 | struct task* uu_aio_task; /* target task for async io */ |
316670eb | 199 | |
91447636 A |
200 | lck_mtx_t *uu_mtx; |
201 | ||
39037602 | 202 | lck_spin_t uu_rethrottle_lock; /* locks was_rethrottled and is_throttled */ |
316670eb | 203 | TAILQ_ENTRY(uthread) uu_throttlelist; /* List of uthreads currently throttled */ |
39236c6e | 204 | void * uu_throttle_info; /* pointer to throttled I/Os info */ |
316670eb | 205 | int uu_on_throttlelist; |
593a1d5f | 206 | int uu_lowpri_window; |
39037602 A |
207 | boolean_t uu_was_rethrottled; |
208 | boolean_t uu_is_throttled; | |
6d2010ae | 209 | boolean_t uu_throttle_bc; |
39236c6e A |
210 | |
211 | u_int32_t uu_network_marks; /* network control flow marks */ | |
91447636 | 212 | |
b0d623f7 | 213 | struct kern_sigaltstack uu_sigstk; |
91447636 | 214 | vnode_t uu_vreclaims; |
2d21ac55 A |
215 | vnode_t uu_cdir; /* per thread CWD */ |
216 | int uu_dupfd; /* fd in fdesc_open/dupfdopen */ | |
39236c6e | 217 | int uu_defer_reclaims; |
2d21ac55 | 218 | |
39037602 A |
219 | unsigned int uu_kqueue_bound; /* qos index we are bound to service */ |
220 | unsigned int uu_kqueue_flags; /* if so, the flags being using */ | |
221 | ||
91447636 A |
222 | #ifdef JOE_DEBUG |
223 | int uu_iocount; | |
224 | int uu_vpindex; | |
225 | void * uu_vps[32]; | |
6d2010ae | 226 | void * uu_pcs[32][10]; |
91447636 | 227 | #endif |
3e170ce0 A |
228 | |
229 | #if PROC_REF_DEBUG | |
230 | #define NUM_PROC_REFS_TO_TRACK 32 | |
231 | #define PROC_REF_STACK_DEPTH 10 | |
232 | int uu_proc_refcount; | |
233 | int uu_pindex; | |
234 | void * uu_proc_ps[NUM_PROC_REFS_TO_TRACK]; | |
235 | uintptr_t uu_proc_pcs[NUM_PROC_REFS_TO_TRACK][PROC_REF_STACK_DEPTH]; | |
236 | #endif | |
237 | ||
2d21ac55 A |
238 | #if CONFIG_DTRACE |
239 | uint32_t t_dtrace_errno; /* Most recent errno */ | |
39236c6e A |
240 | siginfo_t t_dtrace_siginfo; |
241 | uint64_t t_dtrace_resumepid; /* DTrace's pidresume() pid */ | |
6d2010ae | 242 | uint8_t t_dtrace_stop; /* indicates a DTrace desired stop */ |
2d21ac55 | 243 | uint8_t t_dtrace_sig; /* signal sent via DTrace's raise() */ |
316670eb | 244 | |
2d21ac55 A |
245 | union __tdu { |
246 | struct __tds { | |
247 | uint8_t _t_dtrace_on; /* hit a fasttrap tracepoint */ | |
248 | uint8_t _t_dtrace_step; /* about to return to kernel */ | |
249 | uint8_t _t_dtrace_ret; /* handling a return probe */ | |
250 | uint8_t _t_dtrace_ast; /* saved ast flag */ | |
251 | #if __sol64 || defined(__APPLE__) | |
252 | uint8_t _t_dtrace_reg; /* modified register */ | |
253 | #endif | |
254 | } _tds; | |
b0d623f7 | 255 | u_int32_t _t_dtrace_ft; /* bitwise or of these flags */ |
2d21ac55 A |
256 | } _tdu; |
257 | #define t_dtrace_ft _tdu._t_dtrace_ft | |
258 | #define t_dtrace_on _tdu._tds._t_dtrace_on | |
259 | #define t_dtrace_step _tdu._tds._t_dtrace_step | |
260 | #define t_dtrace_ret _tdu._tds._t_dtrace_ret | |
261 | #define t_dtrace_ast _tdu._tds._t_dtrace_ast | |
262 | #if __sol64 || defined(__APPLE__) | |
263 | #define t_dtrace_reg _tdu._tds._t_dtrace_reg | |
264 | #endif | |
265 | ||
266 | user_addr_t t_dtrace_pc; /* DTrace saved pc from fasttrap */ | |
267 | user_addr_t t_dtrace_npc; /* DTrace next pc from fasttrap */ | |
268 | user_addr_t t_dtrace_scrpc; /* DTrace per-thread scratch location */ | |
269 | user_addr_t t_dtrace_astpc; /* DTrace return sequence location */ | |
270 | ||
271 | struct dtrace_ptss_page_entry* t_dtrace_scratch; /* scratch space entry */ | |
272 | ||
273 | #if __sol64 || defined(__APPLE__) | |
274 | uint64_t t_dtrace_regv; /* DTrace saved reg from fasttrap */ | |
275 | #endif | |
316670eb | 276 | void * t_dtrace_syscall_args; |
2d21ac55 A |
277 | #endif /* CONFIG_DTRACE */ |
278 | void * uu_threadlist; | |
b0d623f7 | 279 | char * pth_name; |
22ba694c A |
280 | |
281 | /* Document Tracking struct used to track a "tombstone" for a document */ | |
282 | struct doc_tombstone *t_tombstone; | |
39037602 A |
283 | |
284 | struct os_reason *uu_exit_reason; | |
1c79356b | 285 | }; |
0b4e3aa0 | 286 | |
1c79356b | 287 | typedef struct uthread * uthread_t; |
9bccf70c A |
288 | |
289 | /* Definition of uu_flag */ | |
91447636 A |
290 | #define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */ |
291 | #define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */ | |
292 | #define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */ | |
293 | #define UT_CANCEL 0x00000008 /* thread marked for cancel */ | |
294 | #define UT_CANCELED 0x00000010 /* thread cancelled */ | |
295 | #define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */ | |
2d21ac55 A |
296 | #define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */ |
297 | #define UT_THROTTLE_IO 0x00000080 /* this thread issues throttle I/O */ | |
298 | #define UT_PASSIVE_IO 0x00000100 /* this thread issues passive I/O */ | |
299 | #define UT_PROCEXIT 0x00000200 /* this thread completed the proc exit */ | |
300 | #define UT_RAGE_VNODES 0x00000400 /* rapid age any vnodes created by this thread */ | |
316670eb | 301 | /* 0x00000800 unused, used to be UT_BACKGROUND */ |
39236c6e | 302 | /* 0x00001000 unused, used to be UT_BACKGROUND_TRAFFIC_MGT */ |
91447636 A |
303 | |
304 | #define UT_VFORK 0x02000000 /* thread has vfork children */ | |
305 | #define UT_SETUID 0x04000000 /* thread is settugid() */ | |
306 | #define UT_WASSETUID 0x08000000 /* thread was settugid() (in vfork) */ | |
39236c6e | 307 | #define UT_VFORKING 0x10000000 /* thread in vfork() syscall */ |
9bccf70c | 308 | |
2d21ac55 A |
309 | #endif /* BSD_KERNEL_PRIVATE */ |
310 | ||
9bccf70c A |
311 | #endif /* __APPLE_API_PRIVATE */ |
312 | ||
1c79356b A |
313 | #endif /* KERNEL */ |
314 | ||
315 | /* | |
316 | * Per process structure containing data that isn't needed in core | |
317 | * when the process isn't running (esp. when swapped out). | |
318 | * This structure may or may not be at the same kernel address | |
319 | * in all processes. | |
320 | */ | |
321 | ||
322 | struct user { | |
323 | /* NOT USED ANYMORE */ | |
324 | }; | |
325 | ||
326 | #endif /* !_SYS_USER_H_ */ |