bsd/sys/user.h

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