bsd/sys/user.h

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