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