bsd/sys/user.h

   1 /*
   2  * Copyright (c) 2000-2018 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/resource.h>
  79 #include <sys/resourcevar.h>
  80 #include <sys/signal.h>
  81 #include <sys/signalvar.h>
  82 #endif
  83 #include <sys/vm.h>             /* XXX */
  84 #include <sys/sysctl.h>
  85
  86 #ifdef KERNEL
  87 #ifdef BSD_KERNEL_PRIVATE
  88 #include <sys/pthread_internal.h> /* for uu_kwe entry */
  89 #include <sys/eventvar.h>
  90 #endif  /* BSD_KERNEL_PRIVATE */
  91 #ifdef __APPLE_API_PRIVATE
  92 #include <sys/eventvar.h>
  93
  94 #if !defined(__LP64__) || defined(XNU_KERNEL_PRIVATE)
  95 /*
  96  * VFS context structure (part of uthread)
  97  */
  98 struct vfs_context {
  99         thread_t        vc_thread;              /* pointer to Mach thread */
 100         kauth_cred_t    vc_ucred;               /* per thread credential */
 101 };
 102
 103 #endif /* !__LP64 || XNU_KERNEL_PRIVATE */
 104
 105 #ifdef BSD_KERNEL_PRIVATE
 106 /* XXX Deprecated: xnu source compatability */
 107 #define uu_ucred        uu_context.vc_ucred
 108
 109 struct label;           /* MAC label dummy struct */
 110
 111 #define MAXTHREADNAMESIZE 64
 112 /*
 113  *      Per-thread U area.
 114  */
 115
 116 struct uthread {
 117         /* syscall parameters, results and catches */
 118         u_int64_t uu_arg[8]; /* arguments to current system call */
 119         int uu_rval[2];
 120         char uu_cursig; /* p_cursig for exc. */
 121         unsigned int syscall_code; /* current syscall code */
 122
 123         /* thread exception handling */
 124         int     uu_exception;
 125         mach_exception_code_t uu_code;  /* ``code'' to trap */
 126         mach_exception_subcode_t uu_subcode;
 127
 128         /* support for syscalls which use continuations */
 129         union {
 130                 struct _select_data {
 131                         u_int64_t abstime;
 132                         uint64_t *wqp;
 133                         int count;
 134                         struct select_nocancel_args *args;  /* original syscall arguments */
 135                         int32_t *retval;                    /* place to store return val */
 136                 } uus_select_data;
 137
 138                 struct _kqueue_scan {
 139                         kevent_callback_t call;             /* per-event callback */
 140                         kqueue_continue_t cont;             /* whole call continuation */
 141                         filt_process_data_t process_data;   /* needed for filter processing */
 142                         uint64_t deadline;                  /* computed deadline for operation */
 143                         void *data;                         /* caller's private data */
 144                 } uus_kqueue_scan;                       /* saved state for kevent_scan() */
 145
 146                 struct _kevent {
 147                         struct _kqueue_scan scan;           /* space for the generic data */
 148                         struct fileproc *fp;                /* fileproc we hold iocount on */
 149                         int fd;                             /* fd for fileproc (if held) */
 150                         int eventcount;                     /* user-level event count */
 151                         int eventout;                       /* number of events output */
 152                         struct filt_process_s process_data; /* space for process data fed thru */
 153                         int32_t *retval;                    /* place to store return val */
 154                         user_addr_t eventlist;              /* user-level event list address */
 155                         uint64_t data_available;            /* [user/kernel] addr of in/out size */
 156                 } uus_kevent;                            /* saved state for kevent() */
 157
 158                 struct _kevent_register {
 159                         struct kevent_internal_s kev;       /* the kevent to maybe copy out */
 160                         struct knote *knote;                /* the knote used for the wait */
 161                         struct fileproc *fp;                /* fileproc we hold iocount on */
 162                         thread_t handoff_thread;            /* thread we handed off to, has +1 */
 163                         struct kqueue *kq;
 164                         int fd;                             /* fd for fileproc (if held) */
 165                         int eventcount;                     /* user-level event count */
 166                         int eventout;                       /* number of events output */
 167                         unsigned int flags;                 /* flags for kevent_copyout() */
 168                         int32_t *retval;                    /* place to store return val */
 169                         user_addr_t ueventlist;             /* the user-address to copyout to */
 170                 } uus_kevent_register;                   /* saved for EVFILT_WORKLOOP wait */
 171
 172                 struct _kauth {
 173                         user_addr_t message;                /* message in progress */
 174                 } uus_kauth;
 175
 176                 struct ksyn_waitq_element uus_kwe;       /* user for pthread synch */
 177
 178                 struct _waitid_data {
 179                         struct waitid_nocancel_args *args;  /* original syscall arguments */
 180                         int32_t *retval;                    /* place to store return val */
 181                 } uus_waitid_data;
 182
 183                 struct _wait4_data {
 184                         struct wait4_nocancel_args *args;   /* original syscall arguments */
 185                         int32_t *retval;                    /* place to store return val */
 186                 } uus_wait4_data;
 187
 188                 struct _workq_park_data {
 189                         uint64_t idle_stamp;
 190                         uint64_t workloop_params;
 191                         uint32_t fulfilled_snapshot;
 192                         uint32_t yields;
 193                         void *thread_request;                /* request being fulfilled, for tracing only */
 194                         uint32_t upcall_flags;
 195                         bool has_stack;
 196                         thread_qos_t qos;
 197                 } uus_workq_park_data;                   /* saved for parked workq threads */
 198
 199                 struct _ulock_wait_data {
 200                         thread_t owner_thread;
 201                         thread_t old_owner;
 202                         int32_t *retval;
 203                         uint flags;
 204                 } uus_ulock_wait_data;
 205         } uu_save;
 206
 207         /* Persistent memory allocations across system calls */
 208         struct _select {
 209                 u_int32_t       *ibits, *obits; /* bits to select on */
 210                 uint    nbytes; /* number of bytes in ibits and obits */
 211         } uu_select;                    /* saved state for select() */
 212
 213         /* internal support for continuation framework */
 214         int (*uu_continuation)(int);
 215         int uu_pri;
 216         int uu_timo;
 217         caddr_t uu_wchan;                       /* sleeping thread wait channel */
 218         const char *uu_wmesg;                   /* ... wait message */
 219         struct proc *uu_proc;
 220         thread_t uu_thread;
 221         void * uu_userstate;
 222         struct waitq_set *uu_wqset;             /* waitq state cached across select calls */
 223         size_t uu_wqstate_sz;                   /* ...size of uu_wqset buffer */
 224         int uu_flag;
 225         sigset_t uu_siglist;                            /* signals pending for the thread */
 226         sigset_t uu_sigwait;                            /*  sigwait on this thread*/
 227         sigset_t uu_sigmask;                            /* signal mask for the thread */
 228         sigset_t uu_oldmask;                            /* signal mask saved before sigpause */
 229         sigset_t uu_vforkmask;                          /* saved signal mask during vfork */
 230         struct vfs_context uu_context;                  /* thread + cred */
 231
 232         TAILQ_ENTRY(uthread) uu_list;           /* List of uthreads in proc */
 233
 234         struct kaudit_record    *uu_ar;                 /* audit record */
 235         struct task*    uu_aio_task;                    /* target task for async io */
 236
 237         lck_mtx_t       *uu_mtx;
 238
 239         lck_spin_t      uu_rethrottle_lock;     /* locks was_rethrottled and is_throttled */
 240         TAILQ_ENTRY(uthread) uu_throttlelist;   /* List of uthreads currently throttled */
 241         void    *       uu_throttle_info;       /* pointer to throttled I/Os info */
 242         int             uu_on_throttlelist;
 243         int             uu_lowpri_window;
 244         /* These boolean fields are protected by different locks */
 245         bool            uu_was_rethrottled;
 246         bool            uu_is_throttled;
 247         bool            uu_throttle_bc;
 248
 249         u_int32_t       uu_network_marks;       /* network control flow marks */
 250
 251         struct kern_sigaltstack uu_sigstk;
 252         vnode_t         uu_vreclaims;
 253         vnode_t         uu_cdir;                /* per thread CWD */
 254         int             uu_dupfd;               /* fd in fdesc_open/dupfdopen */
 255         int             uu_defer_reclaims;
 256
 257         /*
 258          * Bound kqueue request. This field is only cleared by the current thread,
 259          * hence can be dereferenced safely by the current thread without locks.
 260          */
 261         struct kqrequest *uu_kqr_bound;
 262         TAILQ_ENTRY(uthread) uu_workq_entry;
 263         mach_vm_offset_t uu_workq_stackaddr;
 264         mach_port_name_t uu_workq_thport;
 265         struct uu_workq_policy {
 266                 uint16_t qos_req : 4;         /* requested QoS */
 267                 uint16_t qos_max : 4;         /* current acked max qos */
 268                 uint16_t qos_override : 4;    /* received async override */
 269                 uint16_t qos_bucket : 4;      /* current acked bucket */
 270         } uu_workq_pri;
 271         uint8_t uu_workq_flags;
 272         kq_index_t uu_kqueue_override;
 273
 274 #ifdef JOE_DEBUG
 275         int             uu_iocount;
 276         int             uu_vpindex;
 277         void    *uu_vps[32];
 278         void    *uu_pcs[32][10];
 279 #endif
 280 #if CONFIG_WORKLOOP_DEBUG
 281 #define UU_KEVENT_HISTORY_COUNT 32
 282 #define UU_KEVENT_HISTORY_WRITE_ENTRY(uth, ...)  ({ \
 283                 struct uthread *__uth = (uth); \
 284                 unsigned int __index = __uth->uu_kevent_index++; \
 285                 __uth->uu_kevent_history[__index % UU_KEVENT_HISTORY_COUNT] = \
 286                                 (struct uu_kevent_history)__VA_ARGS__; \
 287         })
 288         struct uu_kevent_history {
 289                 uint64_t uu_kqid;
 290                 struct kqueue *uu_kq;
 291                 int uu_error, uu_nchanges, uu_nevents;
 292                 unsigned int uu_flags;
 293         } uu_kevent_history[UU_KEVENT_HISTORY_COUNT];
 294         unsigned int uu_kevent_index;
 295 #endif
 296         int             uu_proc_refcount;
 297 #if PROC_REF_DEBUG
 298 #define NUM_PROC_REFS_TO_TRACK 32
 299 #define PROC_REF_STACK_DEPTH 10
 300         int             uu_pindex;
 301         void    *       uu_proc_ps[NUM_PROC_REFS_TO_TRACK];
 302         uintptr_t       uu_proc_pcs[NUM_PROC_REFS_TO_TRACK][PROC_REF_STACK_DEPTH];
 303 #endif
 304
 305 #if CONFIG_DTRACE
 306         uint32_t        t_dtrace_errno; /* Most recent errno */
 307         siginfo_t       t_dtrace_siginfo;
 308         uint64_t        t_dtrace_resumepid; /* DTrace's pidresume() pid */
 309         uint8_t         t_dtrace_stop;  /* indicates a DTrace desired stop */
 310         uint8_t         t_dtrace_sig;   /* signal sent via DTrace's raise() */
 311
 312         union __tdu {
 313                 struct __tds {
 314                         uint8_t _t_dtrace_on;   /* hit a fasttrap tracepoint */
 315                         uint8_t _t_dtrace_step; /* about to return to kernel */
 316                         uint8_t _t_dtrace_ret;  /* handling a return probe */
 317                         uint8_t _t_dtrace_ast;  /* saved ast flag */
 318 #if __sol64 || defined(__APPLE__)
 319                         uint8_t _t_dtrace_reg;  /* modified register */
 320 #endif
 321                 } _tds;
 322                 u_int32_t _t_dtrace_ft;           /* bitwise or of these flags */
 323         } _tdu;
 324 #define t_dtrace_ft     _tdu._t_dtrace_ft
 325 #define t_dtrace_on     _tdu._tds._t_dtrace_on
 326 #define t_dtrace_step   _tdu._tds._t_dtrace_step
 327 #define t_dtrace_ret    _tdu._tds._t_dtrace_ret
 328 #define t_dtrace_ast    _tdu._tds._t_dtrace_ast
 329 #if __sol64 || defined(__APPLE__)
 330 #define t_dtrace_reg    _tdu._tds._t_dtrace_reg
 331 #endif
 332
 333         user_addr_t     t_dtrace_pc;    /* DTrace saved pc from fasttrap */
 334         user_addr_t     t_dtrace_npc;   /* DTrace next pc from fasttrap */
 335         user_addr_t     t_dtrace_scrpc; /* DTrace per-thread scratch location */
 336         user_addr_t     t_dtrace_astpc; /* DTrace return sequence location */
 337
 338         struct dtrace_ptss_page_entry*  t_dtrace_scratch; /* scratch space entry */
 339
 340 #if __sol64 || defined(__APPLE__)
 341         uint64_t        t_dtrace_regv;  /* DTrace saved reg from fasttrap */
 342 #endif
 343         void *t_dtrace_syscall_args;
 344 #endif /* CONFIG_DTRACE */
 345         char *pth_name;
 346
 347         /* Document Tracking struct used to track a "tombstone" for a document */
 348         struct doc_tombstone *t_tombstone;
 349
 350         struct os_reason *uu_exit_reason;
 351 };
 352
 353 typedef struct uthread * uthread_t;
 354
 355 /* Definition of uu_flag */
 356 #define UT_SAS_OLDMASK  0x00000001      /* need to restore mask before pause */
 357 #define UT_NO_SIGMASK   0x00000002      /* exited thread; invalid sigmask */
 358 #define UT_NOTCANCELPT  0x00000004             /* not a cancelation point */
 359 #define UT_CANCEL       0x00000008             /* thread marked for cancel */
 360 #define UT_CANCELED     0x00000010            /* thread cancelled */
 361 #define UT_CANCELDISABLE 0x00000020            /* thread cancel disabled */
 362 #define UT_ALTSTACK     0x00000040      /* this thread has alt stack for signals */
 363 #define UT_THROTTLE_IO  0x00000080      /* this thread issues throttle I/O */
 364 #define UT_PASSIVE_IO   0x00000100      /* this thread issues passive I/O */
 365 #define UT_PROCEXIT     0x00000200      /* this thread completed the  proc exit */
 366 #define UT_RAGE_VNODES  0x00000400      /* rapid age any vnodes created by this thread */
 367 #define UT_KERN_RAGE_VNODES     0x00000800      /* rapid age any vnodes created by this thread (kernel set) */
 368 /* 0x00001000 unused, used to be UT_BACKGROUND_TRAFFIC_MGT */
 369 #define UT_ATIME_UPDATE 0x00002000      /* don't update atime for files accessed by this thread */
 370 #define UT_VFORK        0x02000000      /* thread has vfork children */
 371 #define UT_SETUID       0x04000000      /* thread is settugid() */
 372 #define UT_WASSETUID    0x08000000      /* thread was settugid() (in vfork) */
 373 #define UT_VFORKING     0x10000000      /* thread in vfork() syscall */
 374
 375 #endif /* BSD_KERNEL_PRIVATE */
 376
 377 #endif /* __APPLE_API_PRIVATE */
 378
 379 #endif  /* KERNEL */
 380
 381 /*
 382  * Per process structure containing data that isn't needed in core
 383  * when the process isn't running (esp. when swapped out).
 384  * This structure may or may not be at the same kernel address
 385  * in all processes.
 386  */
 387
 388 struct  user {
 389         /* NOT USED ANYMORE */
 390 };
 391
 392 #endif  /* !_SYS_USER_H_ */