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