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