xnu-1699.22.81.tar.gz

[apple/xnu.git] / bsd / sys / user.h

diff --git a/bsd/sys/user.h b/bsd/sys/user.h
index 8ab23ffc6887245542f673f8f5c401f480864cab..4a59aa866fa784c83acac40d9b06983fcdff3e34 100644 (file)
--- a/bsd/sys/user.h
+++ b/bsd/sys/user.h
@@ -1,16 +1,19 @@
 /*
 /*

- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2010 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 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
  * 
  * 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. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * 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.
+ * 
+ * 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
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER


@@ -20,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
  * 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 */
 /*
  */
 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
 /*


@@ -70,83 +73,199 @@
 #include <sys/ucred.h>
 #include <sys/uio.h>
 #endif
 #include <sys/ucred.h>
 #include <sys/uio.h>
 #endif

+#ifdef XNU_KERNEL_PRIVATE

 #include <sys/resourcevar.h>
 #include <sys/signalvar.h>
 #include <sys/resourcevar.h>
 #include <sys/signalvar.h>

+#endif

 #include <sys/vm.h>            /* XXX */
 #include <sys/sysctl.h>
 #include <sys/vm.h>            /* XXX */
 #include <sys/sysctl.h>

- 
-#ifdef KERNEL

 
 

+
+#ifdef KERNEL
+#ifdef BSD_KERNEL_PRIVATE
+#include <sys/pthread_internal.h> /* for uu_kwe entry */
+#endif  /* BSD_KERNEL_PRIVATE */

 #ifdef __APPLE_API_PRIVATE
 #ifdef __APPLE_API_PRIVATE

-struct nlminfo;
+#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
+
+#define MAXTHREADNAMESIZE 64

 /*
  *     Per-thread U area.
  */
 /*
  *     Per-thread U area.
  */

+ 

 struct uthread {
 struct uthread {

-       int     *uu_ar0;                /* address of users saved R0 */
-

        /* syscall parameters, results and catches */
        /* syscall parameters, results and catches */

-       int     uu_arg[8];              /* arguments to current system call */
+       u_int64_t uu_arg[8]; /* arguments to current system call */

        int     *uu_ap;                 /* pointer to arglist */
     int uu_rval[2];
 
        /* thread exception handling */
        int     *uu_ap;                 /* pointer to arglist */
     int uu_rval[2];
 
        /* thread exception handling */

-       int     uu_code;                        /* ``code'' to trap */
-       char uu_cursig;                         /* p_cursig for exc. */
-       struct nlminfo *uu_nlminfo;     /* for rpc.lockd */
+       int     uu_exception;
+       mach_exception_code_t uu_code;  /* ``code'' to trap */
+       mach_exception_subcode_t uu_subcode;
+       char uu_cursig;                 /* p_cursig for exc. */

        /* support for syscalls which use continuations */
        /* support for syscalls which use continuations */

-       union {
-               struct _select {
+       struct _select {

                        u_int32_t       *ibits, *obits; /* bits to select on */
                        uint    nbytes; /* number of bytes in ibits and obits */
                        u_int64_t abstime;
                        int poll;
                        int error;
                        int count;
                        u_int32_t       *ibits, *obits; /* bits to select on */
                        uint    nbytes; /* number of bytes in ibits and obits */
                        u_int64_t abstime;
                        int poll;
                        int error;
                        int count;

-                       int nfcount;
+                       int _reserved1; // UNUSED: avoid changing size for now

                        char * wql;
                        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() */
+       /* to support kevent continuations */
+       union {
+               struct _kqueue_scan {
+                       kevent_callback_t call; /* per-event callback */
+                       kqueue_continue_t cont; /* whole call continuation */
+                       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;                  /* filedescriptor for kq */
+                       int32_t *retval;         /* place to store return val */
+                       user_addr_t eventlist;   /* user-level event list address */
+                       size_t eventsize;       /* kevent or kevent64_s */
+                       int eventcount;         /* user-level event count */
+                       int eventout;            /* number of events output */
+               } ss_kevent;                     /* saved state for kevent() */
+       } uu_kevent;
+       struct _kauth {
+               user_addr_t message;    /* message in progress */
+       } uu_kauth;

   /* internal support for continuation framework */
     int (*uu_continuation)(int);
     int uu_pri;
     int uu_timo;
   /* internal support for continuation framework */
     int (*uu_continuation)(int);
     int uu_pri;
     int uu_timo;

+       caddr_t uu_wchan;                       /* sleeping thread wait channel */
+       const char *uu_wmesg;                   /* ... wait message */

        int uu_flag;
        int uu_flag;

+#if CONFIG_EMBEDDED
+       int uu_iopol_disk;                      /* disk I/O policy */
+#endif /* CONFIG_EMBEDDED */

        struct proc * uu_proc;
        void * uu_userstate;
        struct proc * uu_proc;
        void * uu_userstate;

-       wait_queue_sub_t uu_wqsub;
+       wait_queue_set_t uu_wqset;                      /* cached across select calls */
+       size_t uu_allocsize;                            /* ...size of select cache */

        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_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 */

-       thread_act_t uu_act;
+       struct vfs_context uu_context;                  /* thread + cred */

        sigset_t  uu_vforkmask;                         /* saved signal mask during vfork */
 
        TAILQ_ENTRY(uthread) uu_list;           /* List of uthreads in proc */
 
        sigset_t  uu_vforkmask;                         /* saved signal mask during vfork */
 
        TAILQ_ENTRY(uthread) uu_list;           /* List of uthreads in proc */
 

-       struct kaudit_record            *uu_ar;         /* audit record */
+       struct kaudit_record    *uu_ar;                 /* audit record */

        struct task*    uu_aio_task;                    /* target task for async io */
        struct task*    uu_aio_task;                    /* target task for async io */

+
+       lck_mtx_t       *uu_mtx;
+
+       int             uu_lowpri_window;
+       boolean_t       uu_throttle_isssd;
+       boolean_t       uu_throttle_bc;
+       void    *       uu_throttle_info;       /* pointer to throttled I/Os info */
+
+       struct kern_sigaltstack uu_sigstk;
+        int            uu_defer_reclaims;
+        vnode_t                uu_vreclaims;
+       int             uu_notrigger;           /* XXX - flag for autofs */
+       vnode_t         uu_cdir;                /* per thread CWD */
+       int             uu_dupfd;               /* fd in fdesc_open/dupfdopen */
+
+#ifdef JOE_DEBUG
+        int            uu_iocount;
+        int            uu_vpindex;
+        void   *       uu_vps[32];
+        void    *       uu_pcs[32][10];
+#endif
+#if CONFIG_DTRACE
+       siginfo_t       t_dtrace_siginfo;
+       uint32_t        t_dtrace_errno; /* Most recent errno */
+        uint8_t         t_dtrace_stop;  /* indicates a DTrace desired stop */
+        uint8_t         t_dtrace_sig;   /* signal sent via DTrace's raise() */
+        uint64_t       t_dtrace_resumepid; /* DTrace's pidresume() pid */
+
+        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
+#endif /* CONFIG_DTRACE */
+       void *          uu_threadlist;
+       char *          pth_name;
+       struct ksyn_waitq_element  uu_kwe;              /* user for pthread synch */

 };
 
 typedef struct uthread * uthread_t;
 
 /* Definition of uu_flag */
 };
 
 typedef struct uthread * uthread_t;
 
 /* Definition of uu_flag */

-#define        USAS_OLDMASK    0x1             /* need to restore mask before pause */
-#define UNO_SIGMASK            0x2             /* exited thread; invalid sigmask */
-/* Kept same as in proc */
-#define P_VFORK     0x2000000   /* process has vfork children */
+#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 */       
+#if CONFIG_EMBEDDED
+#define UT_BACKGROUND  0x00000800      /* this thread is in background state */        
+#endif /* !CONFIG_EMBEDDED */
+#define UT_BACKGROUND_TRAFFIC_MGT      0x00001000 /* background traffic is regulated */
+
+#define        UT_VFORK        0x02000000      /* thread has vfork children */
+#define        UT_SETUID       0x04000000      /* thread is settugid() */
+#define UT_WASSETUID   0x08000000      /* thread was settugid() (in vfork) */
+
+#endif /* BSD_KERNEL_PRIVATE */

 
 #endif /* __APPLE_API_PRIVATE */
 
 
 #endif /* __APPLE_API_PRIVATE */