]>
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> |
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 | 82 | |
1c79356b | 83 | #ifdef KERNEL |
6d2010ae A |
84 | #ifdef BSD_KERNEL_PRIVATE |
85 | #include <sys/pthread_internal.h> /* for uu_kwe entry */ | |
86 | #endif /* BSD_KERNEL_PRIVATE */ | |
9bccf70c | 87 | #ifdef __APPLE_API_PRIVATE |
91447636 A |
88 | #include <sys/eventvar.h> |
89 | ||
b0d623f7 | 90 | #if !defined(__LP64__) || defined(XNU_KERNEL_PRIVATE) |
2d21ac55 A |
91 | /* |
92 | * VFS context structure (part of uthread) | |
93 | */ | |
94 | struct vfs_context { | |
95 | thread_t vc_thread; /* pointer to Mach thread */ | |
96 | kauth_cred_t vc_ucred; /* per thread credential */ | |
97 | }; | |
98 | ||
22ba694c A |
99 | /* |
100 | * struct representing a document "tombstone" that's recorded | |
101 | * when a thread manipulates files marked with a document-id. | |
102 | * if the thread recreates the same item, this tombstone is | |
103 | * used to preserve the document_id on the new file. | |
104 | * | |
105 | * It is a separate structure because of its size - we want to | |
106 | * allocate it on demand instead of just stuffing it into the | |
107 | * uthread structure. | |
108 | */ | |
109 | struct doc_tombstone { | |
110 | struct vnode *t_lastop_parent; | |
111 | struct vnode *t_lastop_item; | |
112 | uint32_t t_lastop_parent_vid; | |
113 | uint32_t t_lastop_item_vid; | |
114 | uint64_t t_lastop_fileid; | |
115 | uint64_t t_lastop_document_id; | |
116 | unsigned char t_lastop_filename[NAME_MAX+1]; | |
117 | }; | |
118 | ||
b0d623f7 A |
119 | #endif /* !__LP64 || XNU_KERNEL_PRIVATE */ |
120 | ||
121 | #ifdef BSD_KERNEL_PRIVATE | |
2d21ac55 A |
122 | /* XXX Deprecated: xnu source compatability */ |
123 | #define uu_ucred uu_context.vc_ucred | |
124 | ||
316670eb A |
125 | struct label; /* MAC label dummy struct */ |
126 | ||
b0d623f7 | 127 | #define MAXTHREADNAMESIZE 64 |
1c79356b A |
128 | /* |
129 | * Per-thread U area. | |
1c79356b | 130 | */ |
2d21ac55 | 131 | |
1c79356b | 132 | struct uthread { |
1c79356b | 133 | /* syscall parameters, results and catches */ |
d1ecb069 | 134 | u_int64_t uu_arg[8]; /* arguments to current system call */ |
1c79356b | 135 | int *uu_ap; /* pointer to arglist */ |
2d21ac55 | 136 | int uu_rval[2]; |
1c79356b A |
137 | |
138 | /* thread exception handling */ | |
2d21ac55 A |
139 | mach_exception_code_t uu_code; /* ``code'' to trap */ |
140 | mach_exception_subcode_t uu_subcode; | |
39236c6e | 141 | int uu_exception; |
91447636 | 142 | char uu_cursig; /* p_cursig for exc. */ |
2d21ac55 | 143 | /* support for syscalls which use continuations */ |
39236c6e A |
144 | union { |
145 | struct _select_data { | |
2d21ac55 | 146 | u_int64_t abstime; |
39236c6e | 147 | char * wql; |
2d21ac55 A |
148 | int poll; |
149 | int error; | |
150 | int count; | |
39236c6e | 151 | } ss_select_data; |
b0d623f7 | 152 | struct _kqueue_scan { |
91447636 | 153 | kevent_callback_t call; /* per-event callback */ |
b0d623f7 | 154 | kqueue_continue_t cont; /* whole call continuation */ |
91447636 A |
155 | uint64_t deadline; /* computed deadline for operation */ |
156 | void *data; /* caller's private data */ | |
b0d623f7 | 157 | } ss_kqueue_scan; /* saved state for kevent_scan() */ |
91447636 | 158 | struct _kevent { |
b0d623f7 | 159 | struct _kqueue_scan scan;/* space for the generic data */ |
91447636 A |
160 | struct fileproc *fp; /* fileproc we hold iocount on */ |
161 | int fd; /* filedescriptor for kq */ | |
b0d623f7 | 162 | int32_t *retval; /* place to store return val */ |
91447636 | 163 | user_addr_t eventlist; /* user-level event list address */ |
b0d623f7 | 164 | size_t eventsize; /* kevent or kevent64_s */ |
91447636 A |
165 | int eventcount; /* user-level event count */ |
166 | int eventout; /* number of events output */ | |
167 | } ss_kevent; /* saved state for kevent() */ | |
39236c6e A |
168 | |
169 | struct _kauth { | |
170 | user_addr_t message; /* message in progress */ | |
171 | } uu_kauth; | |
172 | ||
173 | struct ksyn_waitq_element uu_kwe; /* user for pthread synch */ | |
2d21ac55 | 174 | } uu_kevent; |
39236c6e A |
175 | |
176 | struct _select { | |
177 | u_int32_t *ibits, *obits; /* bits to select on */ | |
178 | uint nbytes; /* number of bytes in ibits and obits */ | |
179 | struct _select_data *data; | |
180 | } uu_select; /* saved state for select() */ | |
181 | ||
1c79356b A |
182 | /* internal support for continuation framework */ |
183 | int (*uu_continuation)(int); | |
184 | int uu_pri; | |
185 | int uu_timo; | |
2d21ac55 A |
186 | caddr_t uu_wchan; /* sleeping thread wait channel */ |
187 | const char *uu_wmesg; /* ... wait message */ | |
0b4e3aa0 | 188 | struct proc * uu_proc; |
316670eb | 189 | thread_t uu_thread; |
0b4e3aa0 | 190 | void * uu_userstate; |
2d21ac55 A |
191 | wait_queue_set_t uu_wqset; /* cached across select calls */ |
192 | size_t uu_allocsize; /* ...size of select cache */ | |
39236c6e | 193 | int uu_flag; |
9bccf70c A |
194 | sigset_t uu_siglist; /* signals pending for the thread */ |
195 | sigset_t uu_sigwait; /* sigwait on this thread*/ | |
196 | sigset_t uu_sigmask; /* signal mask for the thread */ | |
197 | sigset_t uu_oldmask; /* signal mask saved before sigpause */ | |
9bccf70c | 198 | sigset_t uu_vforkmask; /* saved signal mask during vfork */ |
39236c6e | 199 | struct vfs_context uu_context; /* thread + cred */ |
9bccf70c A |
200 | |
201 | TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */ | |
55e303ae | 202 | |
b0d623f7 | 203 | struct kaudit_record *uu_ar; /* audit record */ |
55e303ae | 204 | struct task* uu_aio_task; /* target task for async io */ |
316670eb | 205 | |
91447636 A |
206 | lck_mtx_t *uu_mtx; |
207 | ||
316670eb | 208 | TAILQ_ENTRY(uthread) uu_throttlelist; /* List of uthreads currently throttled */ |
39236c6e | 209 | void * uu_throttle_info; /* pointer to throttled I/Os info */ |
316670eb | 210 | int uu_on_throttlelist; |
593a1d5f | 211 | int uu_lowpri_window; |
6d2010ae | 212 | boolean_t uu_throttle_bc; |
39236c6e A |
213 | |
214 | u_int32_t uu_network_marks; /* network control flow marks */ | |
91447636 | 215 | |
b0d623f7 | 216 | struct kern_sigaltstack uu_sigstk; |
91447636 | 217 | vnode_t uu_vreclaims; |
2d21ac55 | 218 | vnode_t uu_cdir; /* per thread CWD */ |
39236c6e | 219 | int uu_notrigger; /* XXX - flag for autofs */ |
2d21ac55 | 220 | int uu_dupfd; /* fd in fdesc_open/dupfdopen */ |
39236c6e | 221 | int uu_defer_reclaims; |
2d21ac55 | 222 | |
91447636 A |
223 | #ifdef JOE_DEBUG |
224 | int uu_iocount; | |
225 | int uu_vpindex; | |
226 | void * uu_vps[32]; | |
6d2010ae | 227 | void * uu_pcs[32][10]; |
91447636 | 228 | #endif |
2d21ac55 A |
229 | #if CONFIG_DTRACE |
230 | uint32_t t_dtrace_errno; /* Most recent errno */ | |
39236c6e A |
231 | siginfo_t t_dtrace_siginfo; |
232 | uint64_t t_dtrace_resumepid; /* DTrace's pidresume() pid */ | |
6d2010ae | 233 | uint8_t t_dtrace_stop; /* indicates a DTrace desired stop */ |
2d21ac55 | 234 | uint8_t t_dtrace_sig; /* signal sent via DTrace's raise() */ |
316670eb | 235 | |
2d21ac55 A |
236 | union __tdu { |
237 | struct __tds { | |
238 | uint8_t _t_dtrace_on; /* hit a fasttrap tracepoint */ | |
239 | uint8_t _t_dtrace_step; /* about to return to kernel */ | |
240 | uint8_t _t_dtrace_ret; /* handling a return probe */ | |
241 | uint8_t _t_dtrace_ast; /* saved ast flag */ | |
242 | #if __sol64 || defined(__APPLE__) | |
243 | uint8_t _t_dtrace_reg; /* modified register */ | |
244 | #endif | |
245 | } _tds; | |
b0d623f7 | 246 | u_int32_t _t_dtrace_ft; /* bitwise or of these flags */ |
2d21ac55 A |
247 | } _tdu; |
248 | #define t_dtrace_ft _tdu._t_dtrace_ft | |
249 | #define t_dtrace_on _tdu._tds._t_dtrace_on | |
250 | #define t_dtrace_step _tdu._tds._t_dtrace_step | |
251 | #define t_dtrace_ret _tdu._tds._t_dtrace_ret | |
252 | #define t_dtrace_ast _tdu._tds._t_dtrace_ast | |
253 | #if __sol64 || defined(__APPLE__) | |
254 | #define t_dtrace_reg _tdu._tds._t_dtrace_reg | |
255 | #endif | |
256 | ||
257 | user_addr_t t_dtrace_pc; /* DTrace saved pc from fasttrap */ | |
258 | user_addr_t t_dtrace_npc; /* DTrace next pc from fasttrap */ | |
259 | user_addr_t t_dtrace_scrpc; /* DTrace per-thread scratch location */ | |
260 | user_addr_t t_dtrace_astpc; /* DTrace return sequence location */ | |
261 | ||
262 | struct dtrace_ptss_page_entry* t_dtrace_scratch; /* scratch space entry */ | |
263 | ||
264 | #if __sol64 || defined(__APPLE__) | |
265 | uint64_t t_dtrace_regv; /* DTrace saved reg from fasttrap */ | |
266 | #endif | |
316670eb | 267 | void * t_dtrace_syscall_args; |
2d21ac55 A |
268 | #endif /* CONFIG_DTRACE */ |
269 | void * uu_threadlist; | |
b0d623f7 | 270 | char * pth_name; |
316670eb | 271 | struct label * uu_label; /* MAC label */ |
22ba694c A |
272 | |
273 | /* Document Tracking struct used to track a "tombstone" for a document */ | |
274 | struct doc_tombstone *t_tombstone; | |
1c79356b | 275 | }; |
0b4e3aa0 | 276 | |
1c79356b | 277 | typedef struct uthread * uthread_t; |
9bccf70c A |
278 | |
279 | /* Definition of uu_flag */ | |
91447636 A |
280 | #define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */ |
281 | #define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */ | |
282 | #define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */ | |
283 | #define UT_CANCEL 0x00000008 /* thread marked for cancel */ | |
284 | #define UT_CANCELED 0x00000010 /* thread cancelled */ | |
285 | #define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */ | |
2d21ac55 A |
286 | #define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */ |
287 | #define UT_THROTTLE_IO 0x00000080 /* this thread issues throttle I/O */ | |
288 | #define UT_PASSIVE_IO 0x00000100 /* this thread issues passive I/O */ | |
289 | #define UT_PROCEXIT 0x00000200 /* this thread completed the proc exit */ | |
290 | #define UT_RAGE_VNODES 0x00000400 /* rapid age any vnodes created by this thread */ | |
316670eb | 291 | /* 0x00000800 unused, used to be UT_BACKGROUND */ |
39236c6e | 292 | /* 0x00001000 unused, used to be UT_BACKGROUND_TRAFFIC_MGT */ |
91447636 A |
293 | |
294 | #define UT_VFORK 0x02000000 /* thread has vfork children */ | |
295 | #define UT_SETUID 0x04000000 /* thread is settugid() */ | |
296 | #define UT_WASSETUID 0x08000000 /* thread was settugid() (in vfork) */ | |
39236c6e | 297 | #define UT_VFORKING 0x10000000 /* thread in vfork() syscall */ |
9bccf70c | 298 | |
2d21ac55 A |
299 | #endif /* BSD_KERNEL_PRIVATE */ |
300 | ||
9bccf70c A |
301 | #endif /* __APPLE_API_PRIVATE */ |
302 | ||
1c79356b A |
303 | #endif /* KERNEL */ |
304 | ||
305 | /* | |
306 | * Per process structure containing data that isn't needed in core | |
307 | * when the process isn't running (esp. when swapped out). | |
308 | * This structure may or may not be at the same kernel address | |
309 | * in all processes. | |
310 | */ | |
311 | ||
312 | struct user { | |
313 | /* NOT USED ANYMORE */ | |
314 | }; | |
315 | ||
316 | #endif /* !_SYS_USER_H_ */ |