]>
Commit | Line | Data |
---|---|---|
1c79356b | 1 | /* |
6d2010ae | 2 | * Copyright (c) 2000-2010 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> |
1c79356b A |
68 | #ifndef KERNEL |
69 | /* stuff that *used* to be included by user.h, or is now needed */ | |
70 | #include <errno.h> | |
71 | #include <sys/time.h> | |
72 | #include <sys/resource.h> | |
73 | #include <sys/ucred.h> | |
74 | #include <sys/uio.h> | |
75 | #endif | |
b0d623f7 | 76 | #ifdef XNU_KERNEL_PRIVATE |
1c79356b A |
77 | #include <sys/resourcevar.h> |
78 | #include <sys/signalvar.h> | |
91447636 | 79 | #endif |
1c79356b A |
80 | #include <sys/vm.h> /* XXX */ |
81 | #include <sys/sysctl.h> | |
6d2010ae A |
82 | |
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 | ||
b0d623f7 | 106 | #define MAXTHREADNAMESIZE 64 |
1c79356b A |
107 | /* |
108 | * Per-thread U area. | |
1c79356b | 109 | */ |
2d21ac55 | 110 | |
1c79356b | 111 | struct uthread { |
1c79356b | 112 | /* syscall parameters, results and catches */ |
d1ecb069 | 113 | u_int64_t uu_arg[8]; /* arguments to current system call */ |
1c79356b | 114 | int *uu_ap; /* pointer to arglist */ |
2d21ac55 | 115 | int uu_rval[2]; |
1c79356b A |
116 | |
117 | /* thread exception handling */ | |
0c530ab8 | 118 | int uu_exception; |
2d21ac55 A |
119 | mach_exception_code_t uu_code; /* ``code'' to trap */ |
120 | mach_exception_subcode_t uu_subcode; | |
91447636 | 121 | char uu_cursig; /* p_cursig for exc. */ |
2d21ac55 | 122 | /* support for syscalls which use continuations */ |
91447636 | 123 | struct _select { |
2d21ac55 A |
124 | u_int32_t *ibits, *obits; /* bits to select on */ |
125 | uint nbytes; /* number of bytes in ibits and obits */ | |
126 | u_int64_t abstime; | |
127 | int poll; | |
128 | int error; | |
129 | int count; | |
6d2010ae | 130 | int _reserved1; // UNUSED: avoid changing size for now |
2d21ac55 | 131 | char * wql; |
91447636 | 132 | } uu_select; /* saved state for select() */ |
2d21ac55 | 133 | /* to support kevent continuations */ |
1c79356b | 134 | union { |
b0d623f7 | 135 | struct _kqueue_scan { |
91447636 | 136 | kevent_callback_t call; /* per-event callback */ |
b0d623f7 | 137 | kqueue_continue_t cont; /* whole call continuation */ |
91447636 A |
138 | uint64_t deadline; /* computed deadline for operation */ |
139 | void *data; /* caller's private data */ | |
b0d623f7 | 140 | } ss_kqueue_scan; /* saved state for kevent_scan() */ |
91447636 | 141 | struct _kevent { |
b0d623f7 | 142 | struct _kqueue_scan scan;/* space for the generic data */ |
91447636 A |
143 | struct fileproc *fp; /* fileproc we hold iocount on */ |
144 | int fd; /* filedescriptor for kq */ | |
b0d623f7 | 145 | int32_t *retval; /* place to store return val */ |
91447636 | 146 | user_addr_t eventlist; /* user-level event list address */ |
b0d623f7 | 147 | size_t eventsize; /* kevent or kevent64_s */ |
91447636 A |
148 | int eventcount; /* user-level event count */ |
149 | int eventout; /* number of events output */ | |
150 | } ss_kevent; /* saved state for kevent() */ | |
2d21ac55 A |
151 | } uu_kevent; |
152 | struct _kauth { | |
153 | user_addr_t message; /* message in progress */ | |
154 | } uu_kauth; | |
1c79356b A |
155 | /* internal support for continuation framework */ |
156 | int (*uu_continuation)(int); | |
157 | int uu_pri; | |
158 | int uu_timo; | |
2d21ac55 A |
159 | caddr_t uu_wchan; /* sleeping thread wait channel */ |
160 | const char *uu_wmesg; /* ... wait message */ | |
0b4e3aa0 | 161 | int uu_flag; |
6d2010ae | 162 | #if CONFIG_EMBEDDED |
2d21ac55 | 163 | int uu_iopol_disk; /* disk I/O policy */ |
6d2010ae | 164 | #endif /* CONFIG_EMBEDDED */ |
0b4e3aa0 A |
165 | struct proc * uu_proc; |
166 | void * uu_userstate; | |
2d21ac55 A |
167 | wait_queue_set_t uu_wqset; /* cached across select calls */ |
168 | size_t uu_allocsize; /* ...size of select cache */ | |
9bccf70c A |
169 | sigset_t uu_siglist; /* signals pending for the thread */ |
170 | sigset_t uu_sigwait; /* sigwait on this thread*/ | |
171 | sigset_t uu_sigmask; /* signal mask for the thread */ | |
172 | sigset_t uu_oldmask; /* signal mask saved before sigpause */ | |
2d21ac55 | 173 | struct vfs_context uu_context; /* thread + cred */ |
9bccf70c A |
174 | sigset_t uu_vforkmask; /* saved signal mask during vfork */ |
175 | ||
176 | TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */ | |
55e303ae | 177 | |
b0d623f7 | 178 | struct kaudit_record *uu_ar; /* audit record */ |
55e303ae | 179 | struct task* uu_aio_task; /* target task for async io */ |
6d2010ae | 180 | |
91447636 A |
181 | lck_mtx_t *uu_mtx; |
182 | ||
593a1d5f | 183 | int uu_lowpri_window; |
6d2010ae A |
184 | boolean_t uu_throttle_isssd; |
185 | boolean_t uu_throttle_bc; | |
b0d623f7 | 186 | void * uu_throttle_info; /* pointer to throttled I/Os info */ |
91447636 | 187 | |
b0d623f7 | 188 | struct kern_sigaltstack uu_sigstk; |
91447636 A |
189 | int uu_defer_reclaims; |
190 | vnode_t uu_vreclaims; | |
2d21ac55 A |
191 | int uu_notrigger; /* XXX - flag for autofs */ |
192 | vnode_t uu_cdir; /* per thread CWD */ | |
193 | int uu_dupfd; /* fd in fdesc_open/dupfdopen */ | |
194 | ||
91447636 A |
195 | #ifdef JOE_DEBUG |
196 | int uu_iocount; | |
197 | int uu_vpindex; | |
198 | void * uu_vps[32]; | |
6d2010ae | 199 | void * uu_pcs[32][10]; |
91447636 | 200 | #endif |
2d21ac55 | 201 | #if CONFIG_DTRACE |
b0d623f7 | 202 | siginfo_t t_dtrace_siginfo; |
2d21ac55 | 203 | uint32_t t_dtrace_errno; /* Most recent errno */ |
6d2010ae | 204 | uint8_t t_dtrace_stop; /* indicates a DTrace desired stop */ |
2d21ac55 | 205 | uint8_t t_dtrace_sig; /* signal sent via DTrace's raise() */ |
6d2010ae | 206 | uint64_t t_dtrace_resumepid; /* DTrace's pidresume() pid */ |
2d21ac55 A |
207 | |
208 | union __tdu { | |
209 | struct __tds { | |
210 | uint8_t _t_dtrace_on; /* hit a fasttrap tracepoint */ | |
211 | uint8_t _t_dtrace_step; /* about to return to kernel */ | |
212 | uint8_t _t_dtrace_ret; /* handling a return probe */ | |
213 | uint8_t _t_dtrace_ast; /* saved ast flag */ | |
214 | #if __sol64 || defined(__APPLE__) | |
215 | uint8_t _t_dtrace_reg; /* modified register */ | |
216 | #endif | |
217 | } _tds; | |
b0d623f7 | 218 | u_int32_t _t_dtrace_ft; /* bitwise or of these flags */ |
2d21ac55 A |
219 | } _tdu; |
220 | #define t_dtrace_ft _tdu._t_dtrace_ft | |
221 | #define t_dtrace_on _tdu._tds._t_dtrace_on | |
222 | #define t_dtrace_step _tdu._tds._t_dtrace_step | |
223 | #define t_dtrace_ret _tdu._tds._t_dtrace_ret | |
224 | #define t_dtrace_ast _tdu._tds._t_dtrace_ast | |
225 | #if __sol64 || defined(__APPLE__) | |
226 | #define t_dtrace_reg _tdu._tds._t_dtrace_reg | |
227 | #endif | |
228 | ||
229 | user_addr_t t_dtrace_pc; /* DTrace saved pc from fasttrap */ | |
230 | user_addr_t t_dtrace_npc; /* DTrace next pc from fasttrap */ | |
231 | user_addr_t t_dtrace_scrpc; /* DTrace per-thread scratch location */ | |
232 | user_addr_t t_dtrace_astpc; /* DTrace return sequence location */ | |
233 | ||
234 | struct dtrace_ptss_page_entry* t_dtrace_scratch; /* scratch space entry */ | |
235 | ||
236 | #if __sol64 || defined(__APPLE__) | |
237 | uint64_t t_dtrace_regv; /* DTrace saved reg from fasttrap */ | |
238 | #endif | |
239 | #endif /* CONFIG_DTRACE */ | |
240 | void * uu_threadlist; | |
b0d623f7 | 241 | char * pth_name; |
6d2010ae | 242 | struct ksyn_waitq_element uu_kwe; /* user for pthread synch */ |
1c79356b | 243 | }; |
0b4e3aa0 | 244 | |
1c79356b | 245 | typedef struct uthread * uthread_t; |
9bccf70c A |
246 | |
247 | /* Definition of uu_flag */ | |
91447636 A |
248 | #define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */ |
249 | #define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */ | |
250 | #define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */ | |
251 | #define UT_CANCEL 0x00000008 /* thread marked for cancel */ | |
252 | #define UT_CANCELED 0x00000010 /* thread cancelled */ | |
253 | #define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */ | |
2d21ac55 A |
254 | #define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */ |
255 | #define UT_THROTTLE_IO 0x00000080 /* this thread issues throttle I/O */ | |
256 | #define UT_PASSIVE_IO 0x00000100 /* this thread issues passive I/O */ | |
257 | #define UT_PROCEXIT 0x00000200 /* this thread completed the proc exit */ | |
258 | #define UT_RAGE_VNODES 0x00000400 /* rapid age any vnodes created by this thread */ | |
6d2010ae | 259 | #if CONFIG_EMBEDDED |
2d21ac55 | 260 | #define UT_BACKGROUND 0x00000800 /* this thread is in background state */ |
6d2010ae | 261 | #endif /* !CONFIG_EMBEDDED */ |
d1ecb069 | 262 | #define UT_BACKGROUND_TRAFFIC_MGT 0x00001000 /* background traffic is regulated */ |
91447636 A |
263 | |
264 | #define UT_VFORK 0x02000000 /* thread has vfork children */ | |
265 | #define UT_SETUID 0x04000000 /* thread is settugid() */ | |
266 | #define UT_WASSETUID 0x08000000 /* thread was settugid() (in vfork) */ | |
9bccf70c | 267 | |
2d21ac55 A |
268 | #endif /* BSD_KERNEL_PRIVATE */ |
269 | ||
9bccf70c A |
270 | #endif /* __APPLE_API_PRIVATE */ |
271 | ||
1c79356b A |
272 | #endif /* KERNEL */ |
273 | ||
274 | /* | |
275 | * Per process structure containing data that isn't needed in core | |
276 | * when the process isn't running (esp. when swapped out). | |
277 | * This structure may or may not be at the same kernel address | |
278 | * in all processes. | |
279 | */ | |
280 | ||
281 | struct user { | |
282 | /* NOT USED ANYMORE */ | |
283 | }; | |
284 | ||
285 | #endif /* !_SYS_USER_H_ */ |