bsd/sys/user.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  31 /*
  32  * Copyright (c) 1982, 1986, 1989, 1991, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)user.h      8.2 (Berkeley) 9/23/93
  64  */
  65
  66 #ifndef _SYS_USER_H_
  67 #define _SYS_USER_H_
  68
  69 #include <sys/appleapiopts.h>
  70 #ifndef KERNEL
  71 /* stuff that *used* to be included by user.h, or is now needed */
  72 #include <errno.h>
  73 #include <sys/time.h>
  74 #include <sys/resource.h>
  75 #include <sys/ucred.h>
  76 #include <sys/uio.h>
  77 #endif
  78 #include <sys/resourcevar.h>
  79 #ifdef KERNEL_PRIVATE
  80 #include <sys/signalvar.h>
  81 #endif
  82 #include <sys/vm.h>             /* XXX */
  83 #include <sys/sysctl.h>
  84
  85 #ifdef KERNEL
  86 #ifdef __APPLE_API_PRIVATE
  87 #include <sys/eventvar.h>
  88
  89 /*
  90  *      Per-thread U area.
  91  */
  92 struct uthread {
  93         /* syscall parameters, results and catches */
  94         u_int64_t uu_arg[8]; /* arguments to current system call */
  95         int     *uu_ap;                 /* pointer to arglist */
  96         int uu_rval[2];
  97
  98         /* thread exception handling */
  99         int     uu_exception;
 100         int     uu_code;                        /* ``code'' to trap */
 101         int     uu_subcode;
 102         char uu_cursig;                 /* p_cursig for exc. */
 103         /* support for select - across system calls */
 104         struct _select {
 105                 u_int32_t       *ibits, *obits; /* bits to select on */
 106                 uint    nbytes; /* number of bytes in ibits and obits */
 107                 wait_queue_set_t wqset;  /* cached across select calls */
 108                 size_t allocsize;                /* ...size of select cache */
 109                 u_int64_t abstime;
 110                 int poll;
 111                 int error;
 112                 int count;
 113                 char * wql;
 114         } uu_select;                    /* saved state for select() */
 115         /* to support continuations */
 116         union {
 117                 int uu_nfs_myiod;    /* saved state for nfsd */
 118                 struct _kevent_scan {
 119                         kevent_callback_t call; /* per-event callback */
 120                         kevent_continue_t cont; /* whole call continuation */
 121                         uint64_t deadline;      /* computed deadline for operation */
 122                         void *data;             /* caller's private data */
 123                 } ss_kevent_scan;               /* saved state for kevent_scan() */
 124                 struct _kevent {
 125                         struct _kevent_scan scan;/* space for the generic data */
 126                         struct fileproc *fp;     /* fileproc we hold iocount on */
 127                         int fd;                  /* filedescriptor for kq */
 128                         register_t *retval;      /* place to store return val */
 129                         user_addr_t eventlist;   /* user-level event list address */
 130                         int eventcount;         /* user-level event count */
 131                         int eventout;            /* number of events output */
 132                 } ss_kevent;                     /* saved state for kevent() */
 133         } uu_state;
 134   /* internal support for continuation framework */
 135     int (*uu_continuation)(int);
 136     int uu_pri;
 137     int uu_timo;
 138         int uu_flag;
 139         struct proc * uu_proc;
 140         void * uu_userstate;
 141         sigset_t uu_siglist;                            /* signals pending for the thread */
 142         sigset_t  uu_sigwait;                           /*  sigwait on this thread*/
 143         sigset_t  uu_sigmask;                           /* signal mask for the thread */
 144         sigset_t  uu_oldmask;                           /* signal mask saved before sigpause */
 145         thread_t uu_act;
 146         sigset_t  uu_vforkmask;                         /* saved signal mask during vfork */
 147
 148         TAILQ_ENTRY(uthread) uu_list;           /* List of uthreads in proc */
 149
 150         struct kaudit_record            *uu_ar;         /* audit record */
 151         struct task*    uu_aio_task;                    /* target task for async io */
 152
 153   /* network support for dlil layer locking */
 154         u_int32_t       dlil_incremented_read;
 155         lck_mtx_t       *uu_mtx;
 156
 157         int             uu_lowpri_delay;
 158
 159         struct ucred    *uu_ucred;              /* per thread credential */
 160         int             uu_defer_reclaims;
 161         vnode_t         uu_vreclaims;
 162                 struct user_sigaltstack uu_sigstk;
 163 #ifdef JOE_DEBUG
 164         int             uu_iocount;
 165         int             uu_vpindex;
 166         void    *       uu_vps[32];
 167 #endif
 168 };
 169
 170 typedef struct uthread * uthread_t;
 171
 172 /* Definition of uu_flag */
 173 #define UT_SAS_OLDMASK  0x00000001      /* need to restore mask before pause */
 174 #define UT_NO_SIGMASK   0x00000002      /* exited thread; invalid sigmask */
 175 #define UT_NOTCANCELPT  0x00000004             /* not a cancelation point */
 176 #define UT_CANCEL       0x00000008             /* thread marked for cancel */
 177 #define UT_CANCELED     0x00000010            /* thread cancelled */
 178 #define UT_CANCELDISABLE 0x00000020            /* thread cancel disabled */
 179 #define UT_ALTSTACK 0x00000040  /* this thread has alt stack for signals */
 180
 181 #define UT_VFORK        0x02000000      /* thread has vfork children */
 182 #define UT_SETUID       0x04000000      /* thread is settugid() */
 183 #define UT_WASSETUID    0x08000000      /* thread was settugid() (in vfork) */
 184
 185 #endif /* __APPLE_API_PRIVATE */
 186
 187 #endif  /* KERNEL */
 188
 189 /*
 190  * Per process structure containing data that isn't needed in core
 191  * when the process isn't running (esp. when swapped out).
 192  * This structure may or may not be at the same kernel address
 193  * in all processes.
 194  */
 195
 196 struct  user {
 197   /* NOT USED ANYMORE */
 198 };
 199
 200 #endif  /* !_SYS_USER_H_ */