/*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
*
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
*
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
#ifndef _SYS_USER_H_
#define _SYS_USER_H_
+#include <sys/appleapiopts.h>
+struct waitq_set;
#ifndef KERNEL
/* stuff that *used* to be included by user.h, or is now needed */
#include <errno.h>
#include <sys/ucred.h>
#include <sys/uio.h>
#endif
+#ifdef XNU_KERNEL_PRIVATE
+#include <sys/resource.h>
#include <sys/resourcevar.h>
+#include <sys/signal.h>
#include <sys/signalvar.h>
+#endif
#include <sys/vm.h> /* XXX */
#include <sys/sysctl.h>
-
+
#ifdef KERNEL
+#ifdef BSD_KERNEL_PRIVATE
+#include <sys/pthread_internal.h> /* for uu_kwe entry */
+#include <sys/eventvar.h>
+#endif /* BSD_KERNEL_PRIVATE */
+#ifdef __APPLE_API_PRIVATE
+#include <sys/eventvar.h>
+
+#if !defined(__LP64__) || defined(XNU_KERNEL_PRIVATE)
+/*
+ * VFS context structure (part of uthread)
+ */
+struct vfs_context {
+ thread_t vc_thread; /* pointer to Mach thread */
+ kauth_cred_t vc_ucred; /* per thread credential */
+};
+
+#endif /* !__LP64 || XNU_KERNEL_PRIVATE */
+
+#ifdef BSD_KERNEL_PRIVATE
+/* XXX Deprecated: xnu source compatability */
+#define uu_ucred uu_context.vc_ucred
+
+struct label; /* MAC label dummy struct */
+
+#define MAXTHREADNAMESIZE 64
/*
* Per-thread U area.
- *
- * It is likely that this structure contains no fields that must be
- * saved between system calls.
- *
- * WARNING: IF THE SIZE OF THIS STRUCT CHANGES YOU MUST CHANGE THE
- * CONSTANT IN struct thread_act.bsd_space
*/
+
struct uthread {
- int *uu_ar0; /* address of users saved R0 */
-
/* syscall parameters, results and catches */
- int uu_arg[8]; /* arguments to current system call */
- int *uu_ap; /* pointer to arglist */
+ u_int64_t uu_arg[8]; /* arguments to current system call */
int uu_rval[2];
+ unsigned int syscall_code; /* current syscall code */
/* thread exception handling */
- int uu_code; /* ``code'' to trap */
- char uu_cursig; /* p_cursig for exc. */
- int uu_sig; /* p_sig for exc. */
-
+ mach_exception_code_t uu_code; /* ``code'' to trap */
+ mach_exception_subcode_t uu_subcode;
+ int uu_exception;
+ char uu_cursig; /* p_cursig for exc. */
/* support for syscalls which use continuations */
union {
- struct _select {
+ struct _select_data {
+ u_int64_t abstime;
+ uint64_t *wqp;
+ int count;
+ struct select_nocancel_args *args; /* original syscall arguments */
+ int32_t *retval; /* place to store return val */
+ } ss_select_data;
+ struct _kqueue_scan {
+ kevent_callback_t call; /* per-event callback */
+ kqueue_continue_t cont; /* whole call continuation */
+ filt_process_data_t process_data; /* needed for filter processing */
+ uint64_t deadline; /* computed deadline for operation */
+ void *data; /* caller's private data */
+ } ss_kqueue_scan; /* saved state for kevent_scan() */
+ struct _kevent {
+ struct _kqueue_scan scan; /* space for the generic data */
+ struct fileproc *fp; /* fileproc we hold iocount on */
+ int fd; /* fd for fileproc (if held) */
+ int eventcount; /* user-level event count */
+ int eventout; /* number of events output */
+ struct filt_process_s process_data; /* space for process data fed thru */
+ int32_t *retval; /* place to store return val */
+ user_addr_t eventlist; /* user-level event list address */
+ uint64_t data_available; /* [user/kernel] addr of in/out size */
+ } ss_kevent; /* saved state for kevent() */
+
+ struct _kauth {
+ user_addr_t message; /* message in progress */
+ } uu_kauth;
+
+ struct ksyn_waitq_element uu_kwe; /* user for pthread synch */
+
+ struct _waitid_data {
+ struct waitid_nocancel_args *args; /* original syscall arguments */
+ int32_t *retval; /* place to store return val */
+ } uu_waitid_data;
+
+ struct _wait4_data {
+ struct wait4_nocancel_args *args; /* original syscall arguments */
+ int32_t *retval; /* place to store return val */
+ } uu_wait4_data;
+ } uu_kevent;
+
+ /* Persistent memory allocations across system calls */
+ struct _select {
u_int32_t *ibits, *obits; /* bits to select on */
uint nbytes; /* number of bytes in ibits and obits */
- struct timeval atv;
- int poll;
- int error;
- int count;
- int nfcount;
- char * wql;
- int allocsize; /* select allocated size */
- } ss_select; /* saved state for select() */
- struct _wait {
- int f;
- } ss_wait; /* saved state for wait?() */
- struct _owait {
- int pid;
- int *status;
- int options;
- struct rusage *rusage;
- } ss_owait;
- int uu_nfs_myiod; /* saved state for nfsd */
- } uu_state;
+ } uu_select; /* saved state for select() */
/* internal support for continuation framework */
int (*uu_continuation)(int);
int uu_pri;
int uu_timo;
- int uu_flag;
+ caddr_t uu_wchan; /* sleeping thread wait channel */
+ const char *uu_wmesg; /* ... wait message */
struct proc * uu_proc;
+ thread_t uu_thread;
void * uu_userstate;
- wait_queue_sub_t uu_wqsub;
+ struct waitq_set *uu_wqset; /* waitq state cached across select calls */
+ size_t uu_wqstate_sz; /* ...size of uu_wqset buffer */
+ int uu_flag;
+ sigset_t uu_siglist; /* signals pending for the thread */
+ sigset_t uu_sigwait; /* sigwait on this thread*/
+ sigset_t uu_sigmask; /* signal mask for the thread */
+ sigset_t uu_oldmask; /* signal mask saved before sigpause */
+ sigset_t uu_vforkmask; /* saved signal mask during vfork */
+ struct vfs_context uu_context; /* thread + cred */
+
+ TAILQ_ENTRY(uthread) uu_list; /* List of uthreads in proc */
+
+ struct kaudit_record *uu_ar; /* audit record */
+ struct task* uu_aio_task; /* target task for async io */
+
+ lck_mtx_t *uu_mtx;
+
+ lck_spin_t uu_rethrottle_lock; /* locks was_rethrottled and is_throttled */
+ TAILQ_ENTRY(uthread) uu_throttlelist; /* List of uthreads currently throttled */
+ void * uu_throttle_info; /* pointer to throttled I/Os info */
+ int uu_on_throttlelist;
+ int uu_lowpri_window;
+ boolean_t uu_was_rethrottled;
+ boolean_t uu_is_throttled;
+ boolean_t uu_throttle_bc;
+
+ u_int32_t uu_network_marks; /* network control flow marks */
+
+ struct kern_sigaltstack uu_sigstk;
+ vnode_t uu_vreclaims;
+ vnode_t uu_cdir; /* per thread CWD */
+ int uu_dupfd; /* fd in fdesc_open/dupfdopen */
+ int uu_defer_reclaims;
+
+ struct kqueue *uu_kqueue_bound; /* kqueue we are bound to service */
+ unsigned int uu_kqueue_qos_index; /* qos index we are bound to service */
+ unsigned int uu_kqueue_flags; /* the flags we are using */
+ boolean_t uu_kqueue_override_is_sync; /* sync qos override applied to servicer */
+
+#ifdef JOE_DEBUG
+ int uu_iocount;
+ int uu_vpindex;
+ void * uu_vps[32];
+ void * uu_pcs[32][10];
+#endif
+ int uu_proc_refcount;
+#if PROC_REF_DEBUG
+#define NUM_PROC_REFS_TO_TRACK 32
+#define PROC_REF_STACK_DEPTH 10
+ int uu_pindex;
+ void * uu_proc_ps[NUM_PROC_REFS_TO_TRACK];
+ uintptr_t uu_proc_pcs[NUM_PROC_REFS_TO_TRACK][PROC_REF_STACK_DEPTH];
+#endif
+
+#if CONFIG_DTRACE
+ uint32_t t_dtrace_errno; /* Most recent errno */
+ siginfo_t t_dtrace_siginfo;
+ uint64_t t_dtrace_resumepid; /* DTrace's pidresume() pid */
+ uint8_t t_dtrace_stop; /* indicates a DTrace desired stop */
+ uint8_t t_dtrace_sig; /* signal sent via DTrace's raise() */
+
+ union __tdu {
+ struct __tds {
+ uint8_t _t_dtrace_on; /* hit a fasttrap tracepoint */
+ uint8_t _t_dtrace_step; /* about to return to kernel */
+ uint8_t _t_dtrace_ret; /* handling a return probe */
+ uint8_t _t_dtrace_ast; /* saved ast flag */
+#if __sol64 || defined(__APPLE__)
+ uint8_t _t_dtrace_reg; /* modified register */
+#endif
+ } _tds;
+ u_int32_t _t_dtrace_ft; /* bitwise or of these flags */
+ } _tdu;
+#define t_dtrace_ft _tdu._t_dtrace_ft
+#define t_dtrace_on _tdu._tds._t_dtrace_on
+#define t_dtrace_step _tdu._tds._t_dtrace_step
+#define t_dtrace_ret _tdu._tds._t_dtrace_ret
+#define t_dtrace_ast _tdu._tds._t_dtrace_ast
+#if __sol64 || defined(__APPLE__)
+#define t_dtrace_reg _tdu._tds._t_dtrace_reg
+#endif
+
+ user_addr_t t_dtrace_pc; /* DTrace saved pc from fasttrap */
+ user_addr_t t_dtrace_npc; /* DTrace next pc from fasttrap */
+ user_addr_t t_dtrace_scrpc; /* DTrace per-thread scratch location */
+ user_addr_t t_dtrace_astpc; /* DTrace return sequence location */
+
+ struct dtrace_ptss_page_entry* t_dtrace_scratch; /* scratch space entry */
+
+#if __sol64 || defined(__APPLE__)
+ uint64_t t_dtrace_regv; /* DTrace saved reg from fasttrap */
+#endif
+ void * t_dtrace_syscall_args;
+#endif /* CONFIG_DTRACE */
+ void * uu_threadlist;
+ char * pth_name;
+
+ /* Document Tracking struct used to track a "tombstone" for a document */
+ struct doc_tombstone *t_tombstone;
+
+ struct os_reason *uu_exit_reason;
};
typedef struct uthread * uthread_t;
+
+/* Definition of uu_flag */
+#define UT_SAS_OLDMASK 0x00000001 /* need to restore mask before pause */
+#define UT_NO_SIGMASK 0x00000002 /* exited thread; invalid sigmask */
+#define UT_NOTCANCELPT 0x00000004 /* not a cancelation point */
+#define UT_CANCEL 0x00000008 /* thread marked for cancel */
+#define UT_CANCELED 0x00000010 /* thread cancelled */
+#define UT_CANCELDISABLE 0x00000020 /* thread cancel disabled */
+#define UT_ALTSTACK 0x00000040 /* this thread has alt stack for signals */
+#define UT_THROTTLE_IO 0x00000080 /* this thread issues throttle I/O */
+#define UT_PASSIVE_IO 0x00000100 /* this thread issues passive I/O */
+#define UT_PROCEXIT 0x00000200 /* this thread completed the proc exit */
+#define UT_RAGE_VNODES 0x00000400 /* rapid age any vnodes created by this thread */
+/* 0x00000800 unused, used to be UT_BACKGROUND */
+/* 0x00001000 unused, used to be UT_BACKGROUND_TRAFFIC_MGT */
+
+#define UT_VFORK 0x02000000 /* thread has vfork children */
+#define UT_SETUID 0x04000000 /* thread is settugid() */
+#define UT_WASSETUID 0x08000000 /* thread was settugid() (in vfork) */
+#define UT_VFORKING 0x10000000 /* thread in vfork() syscall */
+
+#endif /* BSD_KERNEL_PRIVATE */
+
+#endif /* __APPLE_API_PRIVATE */
+
#endif /* KERNEL */
/*