1 | /* |
2 | * Copyright (c) 2000-2018 Apple 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) 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 | |
67 | #include <sys/appleapiopts.h> |
68 | struct waitq_set; |
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 |
77 | #ifdef XNU_KERNEL_PRIVATE |
78 | #include <sys/resource.h> |
79 | #include <sys/resourcevar.h> |
80 | #include <sys/signal.h> |
81 | #include <sys/signalvar.h> |
82 | #endif |
83 | #include <sys/vm.h> /* XXX */ |
84 | #include <sys/sysctl.h> |
85 | |
86 | #ifdef KERNEL |
87 | #ifdef BSD_KERNEL_PRIVATE |
88 | #include <sys/pthread_internal.h> /* for uu_kwe entry */ |
89 | #include <sys/eventvar.h> |
90 | #include <kern/btlog.h> |
91 | #endif /* BSD_KERNEL_PRIVATE */ |
92 | #ifdef __APPLE_API_PRIVATE |
93 | #include <sys/eventvar.h> |
94 | |
95 | #if !defined(__LP64__) || defined(XNU_KERNEL_PRIVATE) |
96 | /* |
97 | * VFS context structure (part of uthread) |
98 | */ |
99 | struct vfs_context { |
100 | thread_t vc_thread; /* pointer to Mach thread */ |
101 | kauth_cred_t vc_ucred; /* per thread credential */ |
102 | }; |
103 | |
104 | #endif /* !__LP64 || XNU_KERNEL_PRIVATE */ |
105 | |
106 | #ifdef BSD_KERNEL_PRIVATE |
107 | struct label; /* MAC label dummy struct */ |
108 | |
109 | #define MAXTHREADNAMESIZE 64 |
110 | /* |
111 | * Per-thread U area. |
112 | */ |
113 | |
114 | #if PROC_REF_DEBUG |
115 | struct uthread_proc_ref_info { |
116 | #define NUM_PROC_REFS_TO_TRACK 31 |
117 | uint32_t upri_pindex; |
118 | btref_t upri_proc_stacks[NUM_PROC_REFS_TO_TRACK]; |
119 | void * upri_proc_ps[NUM_PROC_REFS_TO_TRACK]; |
120 | }; |
121 | #endif /* PROC_REF_DEBUG */ |
122 | |
123 | struct uthread { |
124 | /* syscall parameters, results and catches */ |
125 | u_int64_t uu_arg[8]; /* arguments to current system call */ |
126 | int uu_rval[2]; |
127 | char uu_cursig; /* p_cursig for exc. */ |
128 | /* |
129 | * uu_workq_pthread_kill_allowed is not modified under a lock and thus |
130 | * relies on single copy atomicity and cannot be changed to a bitfield. |
131 | */ |
132 | bool uu_workq_pthread_kill_allowed; |
133 | uint16_t syscall_code; /* current syscall code */ |
134 | |
135 | /* thread exception handling */ |
136 | int uu_exception; |
137 | mach_exception_code_t uu_code; /* ``code'' to trap */ |
138 | mach_exception_subcode_t uu_subcode; |
139 | |
140 | /* support for syscalls which use continuations */ |
141 | union { |
142 | struct _select_data { |
143 | u_int64_t abstime; |
144 | int count; |
145 | struct select_nocancel_args *args; /* original syscall arguments */ |
146 | int32_t *retval; /* place to store return val */ |
147 | } uus_select_data; |
148 | |
149 | struct kevent_ctx_s uus_kevent; |
150 | |
151 | struct _kevent_register { |
152 | struct kevent_qos_s kev; /* the kevent to maybe copy out */ |
153 | thread_t handoff_thread; /* thread we handed off to, has +1 */ |
154 | struct kqworkloop *kqwl; |
155 | int eventout; /* number of events output */ |
156 | user_addr_t ueventlist; /* the user-address to copyout to */ |
157 | } uus_kevent_register; /* saved for EVFILT_WORKLOOP wait */ |
158 | |
159 | struct _kauth { |
160 | user_addr_t message; /* message in progress */ |
161 | } uus_kauth; |
162 | |
163 | struct ksyn_waitq_element uus_kwe; /* user for pthread synch */ |
164 | |
165 | struct _waitid_data { |
166 | struct waitid_nocancel_args *args; /* original syscall arguments */ |
167 | int32_t *retval; /* place to store return val */ |
168 | } uus_waitid_data; |
169 | |
170 | struct _wait4_data { |
171 | struct wait4_nocancel_args *args; /* original syscall arguments */ |
172 | int32_t *retval; /* place to store return val */ |
173 | } uus_wait4_data; |
174 | |
175 | struct _workq_park_data { |
176 | uint64_t idle_stamp; |
177 | uint64_t workloop_params; |
178 | uint32_t fulfilled_snapshot; |
179 | uint32_t yields; |
180 | void *thread_request; /* request being fulfilled, for tracing only */ |
181 | uint32_t upcall_flags; |
182 | bool has_stack; |
183 | thread_qos_t qos; |
184 | } uus_workq_park_data; /* saved for parked workq threads */ |
185 | |
186 | struct _ulock_wait_data { |
187 | struct ull *ull; |
188 | thread_t owner_thread; |
189 | thread_t old_owner; |
190 | int32_t *retval; |
191 | uint flags; |
192 | } uus_ulock_wait_data; |
193 | |
194 | struct _bsdthread_terminate { |
195 | user_addr_t ulock_addr; |
196 | mach_port_name_t kport; |
197 | } uus_bsdthread_terminate; |
198 | |
199 | struct _exec_data { |
200 | struct image_params *imgp; |
201 | } uus_exec_data; |
202 | } uu_save; |
203 | |
204 | /* Persistent memory allocations across system calls */ |
205 | struct _select { |
206 | u_int32_t *ibits, *obits; /* bits to select on */ |
207 | uint nbytes; /* number of bytes in ibits and obits */ |
208 | } uu_select; /* saved state for select() */ |
209 | |
210 | void * uu_userstate; |
211 | struct select_set *uu_selset; /* waitq state cached across select calls */ |
212 | int uu_flag; |
213 | sigset_t uu_siglist; /* signals pending for the thread */ |
214 | sigset_t uu_sigwait; /* sigwait on this thread*/ |
215 | sigset_t uu_sigmask; /* signal mask for the thread */ |
216 | sigset_t uu_oldmask; /* signal mask saved before sigpause */ |
217 | user_addr_t uu_sigreturn_token; /* random token used to validate sigreturn arguments */ |
218 | uint32_t uu_sigreturn_diversifier; /* random diversifier used to validate user signed sigreturn pc/lr */ |
219 | int uu_pending_sigreturn; /* Pending sigreturn count */ |
220 | |
221 | TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */ |
222 | |
223 | #if CONFIG_AUDIT |
224 | struct kaudit_record *uu_ar; /* audit record */ |
225 | #endif |
226 | struct task *uu_aio_task; /* target task for async io */ |
227 | |
228 | union { |
229 | lck_mtx_t *uu_mtx; |
230 | struct knote_lock_ctx *uu_knlock; |
231 | }; |
232 | |
233 | lck_spin_t uu_rethrottle_lock; /* locks was_rethrottled and is_throttled */ |
234 | TAILQ_ENTRY(uthread) uu_throttlelist; /* List of uthreads currently throttled */ |
235 | void * uu_throttle_info; /* pointer to throttled I/Os info */ |
236 | int8_t uu_on_throttlelist; |
237 | bool uu_lowpri_window; |
238 | /* These boolean fields are protected by different locks */ |
239 | bool uu_was_rethrottled; |
240 | bool uu_is_throttled; |
241 | bool uu_throttle_bc; |
242 | bool uu_defer_reclaims; |
243 | |
244 | /* internal support for continuation framework */ |
245 | uint16_t uu_pri; /* pri | PCATCH | PVFS, ... */ |
246 | caddr_t uu_wchan; /* sleeping thread wait channel */ |
247 | int (*uu_continuation)(int); |
248 | const char *uu_wmesg; /* ... wait message */ |
249 | |
250 | struct kern_sigaltstack uu_sigstk; |
251 | vnode_t uu_vreclaims; |
252 | vnode_t uu_cdir; /* per thread CWD */ |
253 | int uu_dupfd; /* fd in fdesc_open/dupfdopen */ |
254 | |
255 | u_int32_t uu_network_marks; /* network control flow marks */ |
256 | |
257 | /* |
258 | * Bound kqueue request. This field is only cleared by the current thread, |
259 | * hence can be dereferenced safely by the current thread without locks. |
260 | */ |
261 | struct workq_threadreq_s *uu_kqr_bound; |
262 | TAILQ_ENTRY(uthread) uu_workq_entry; |
263 | vm_offset_t uu_workq_stackaddr; |
264 | mach_port_name_t uu_workq_thport; |
265 | struct uu_workq_policy { |
266 | /* Requested QoS. |
267 | * |
268 | * - Modified on self during qos updates, or on idle threads we are setting |
269 | * up to run (eg. creator, threads for dispatch apply, etc) while holding |
270 | * wq lock |
271 | * - Read from self |
272 | * |
273 | * Synchronization is subtle since it's generally on self but when |
274 | * modifying on non-self threads, we rely on the fact that they are |
275 | * previously idle and therefore, not modifying it on self at the same time |
276 | * until they take the wq lock. |
277 | */ |
278 | uint16_t qos_req : 4; |
279 | /* Current acked max qos - from kevent. |
280 | * |
281 | * Synchronized by being modified on self. Also generally under the wq lock |
282 | * but that's more of a happy coincidence. |
283 | */ |
284 | uint16_t qos_max : 4; |
285 | /* Async QoS override received - workqueue override |
286 | * |
287 | * Synchronized with the thread mutex and wq lock since it can be modified |
288 | * by another thread. |
289 | */ |
290 | uint16_t qos_override : 4; |
291 | /* Current acked bucket. |
292 | * |
293 | * Synchronized by only being read or written on self. |
294 | */ |
295 | uint16_t qos_bucket : 4; |
296 | } uu_workq_pri; |
297 | |
298 | uint16_t uu_workq_flags; |
299 | kq_index_t uu_kqueue_override; |
300 | |
301 | #ifdef CONFIG_IOCOUNT_TRACE |
302 | int uu_iocount; |
303 | int uu_vpindex; |
304 | void *uu_vps[32]; |
305 | void *uu_pcs[32][10]; |
306 | #endif |
307 | #if CONFIG_WORKLOOP_DEBUG |
308 | #define UU_KEVENT_HISTORY_COUNT 32 |
309 | #define UU_KEVENT_HISTORY_WRITE_ENTRY(uth, ...) ({ \ |
310 | struct uthread *__uth = (uth); \ |
311 | unsigned int __index = __uth->uu_kevent_index++; \ |
312 | __uth->uu_kevent_history[__index % UU_KEVENT_HISTORY_COUNT] = \ |
313 | (struct uu_kevent_history)__VA_ARGS__; \ |
314 | }) |
315 | struct uu_kevent_history { |
316 | uint64_t uu_kqid; |
317 | struct kqueue *uu_kq; |
318 | int uu_error, uu_nchanges, uu_nevents; |
319 | unsigned int uu_flags; |
320 | } uu_kevent_history[UU_KEVENT_HISTORY_COUNT]; |
321 | unsigned int uu_kevent_index; |
322 | #endif |
323 | int uu_proc_refcount; |
324 | #if PROC_REF_DEBUG |
325 | struct uthread_proc_ref_info *uu_proc_ref_info; |
326 | #endif |
327 | |
328 | #if CONFIG_DTRACE |
329 | uint32_t t_dtrace_errno; /* Most recent errno */ |
330 | siginfo_t t_dtrace_siginfo; |
331 | uint64_t t_dtrace_resumepid; /* DTrace's pidresume() pid */ |
332 | uint8_t t_dtrace_stop; /* indicates a DTrace desired stop */ |
333 | uint8_t t_dtrace_sig; /* signal sent via DTrace's raise() */ |
334 | |
335 | union __tdu { |
336 | struct __tds { |
337 | uint8_t _t_dtrace_on; /* hit a fasttrap tracepoint */ |
338 | uint8_t _t_dtrace_step; /* about to return to kernel */ |
339 | uint8_t _t_dtrace_ret; /* handling a return probe */ |
340 | uint8_t _t_dtrace_ast; /* saved ast flag */ |
341 | #if __sol64 || defined(__APPLE__) |
342 | uint8_t _t_dtrace_reg; /* modified register */ |
343 | #endif |
344 | } _tds; |
345 | u_int32_t _t_dtrace_ft; /* bitwise or of these flags */ |
346 | } _tdu; |
347 | #define t_dtrace_ft _tdu._t_dtrace_ft |
348 | #define t_dtrace_on _tdu._tds._t_dtrace_on |
349 | #define t_dtrace_step _tdu._tds._t_dtrace_step |
350 | #define t_dtrace_ret _tdu._tds._t_dtrace_ret |
351 | #define t_dtrace_ast _tdu._tds._t_dtrace_ast |
352 | #if __sol64 || defined(__APPLE__) |
353 | #define t_dtrace_reg _tdu._tds._t_dtrace_reg |
354 | #endif |
355 | |
356 | user_addr_t t_dtrace_pc; /* DTrace saved pc from fasttrap */ |
357 | user_addr_t t_dtrace_npc; /* DTrace next pc from fasttrap */ |
358 | user_addr_t t_dtrace_scrpc; /* DTrace per-thread scratch location */ |
359 | user_addr_t t_dtrace_astpc; /* DTrace return sequence location */ |
360 | |
361 | struct dtrace_ptss_page_entry* t_dtrace_scratch; /* scratch space entry */ |
362 | |
363 | #if __sol64 || defined(__APPLE__) |
364 | uint64_t t_dtrace_regv; /* DTrace saved reg from fasttrap */ |
365 | #endif |
366 | void *t_dtrace_syscall_args; |
367 | #endif /* CONFIG_DTRACE */ |
368 | char *pth_name; |
369 | |
370 | /* Document Tracking struct used to track a "tombstone" for a document */ |
371 | struct doc_tombstone *t_tombstone; |
372 | |
373 | /* Field to be used by filesystems */ |
374 | uint64_t t_fs_private; |
375 | |
376 | struct os_reason *uu_exit_reason; |
377 | |
378 | #if CONFIG_DEBUG_SYSCALL_REJECTION |
379 | uint64_t syscall_rejection_flags; /* flags for syscall rejection behavior */ |
380 | uint64_t *syscall_rejection_mask; /* mach_trap_count + nsysent bits */ |
381 | uint64_t *syscall_rejection_once_mask; /* mach_trap_count + nsysent bits */ |
382 | #endif /* CONFIG_DEBUG_SYSCALL_REJECTION */ |
383 | }; |
384 | |
385 | typedef struct uthread * uthread_t; |
386 | |
387 | /* Definition of uu_flag */ |
388 | #define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */ |
389 | #define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */ |
390 | #define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */ |
391 | #define UT_CANCEL 0x00000008 /* thread marked for cancel */ |
392 | #define UT_CANCELED 0x00000010 /* thread cancelled */ |
393 | #define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */ |
394 | #define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */ |
395 | #define UT_THROTTLE_IO 0x00000080 /* this thread issues throttle I/O */ |
396 | #define UT_PASSIVE_IO 0x00000100 /* this thread issues passive I/O */ |
397 | #define UT_PROCEXIT 0x00000200 /* this thread completed the proc exit */ |
398 | #define UT_RAGE_VNODES 0x00000400 /* rapid age any vnodes created by this thread */ |
399 | #define UT_KERN_RAGE_VNODES 0x00000800 /* rapid age any vnodes created by this thread (kernel set) */ |
400 | #define UT_NSPACE_NODATALESSFAULTS 0x00001000 /* thread does not materialize dataless files */ |
401 | #define UT_ATIME_UPDATE 0x00002000 /* don't update atime for files accessed by this thread */ |
402 | #define UT_NSPACE_FORCEDATALESSFAULTS 0x00004000 /* thread always materializes dataless files */ |
403 | #define UT_LP64 0x00010000 /* denormalized P_LP64 bit from proc */ |
404 | #define UT_FS_BLKSIZE_NOCACHE_WRITES 0x00020000 /* thread wants sub pagesize directIO writes */ |
405 | |
406 | #endif /* BSD_KERNEL_PRIVATE */ |
407 | |
408 | #endif /* __APPLE_API_PRIVATE */ |
409 | |
410 | #endif /* KERNEL */ |
411 | |
412 | /* |
413 | * Per process structure containing data that isn't needed in core |
414 | * when the process isn't running (esp. when swapped out). |
415 | * This structure may or may not be at the same kernel address |
416 | * in all processes. |
417 | */ |
418 | |
419 | struct user { |
420 | /* NOT USED ANYMORE */ |
421 | }; |
422 | |
423 | #endif /* !_SYS_USER_H_ */ |
424 | |