include/sys/user.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  27 /*        All Rights Reserved   */
  28 /*
  29  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
  30  * Copyright 2016 Joyent, Inc.
  31  */
  32
  33
  34 #ifndef _SYS_USER_H
  35 #define _SYS_USER_H
  36
  37 #include <sys/types.h>
  38 #include <sys/signal.h>
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /*
  45  * struct exdata is visible in and out of the kernel. This is because it
  46  * is referenced in <sys/core.h> which doesn't have this kind of magic.
  47  */
  48 struct exdata {
  49         struct vnode    *vp;
  50         size_t  ux_tsize;       /* text size */
  51         size_t  ux_dsize;       /* data size */
  52         size_t  ux_bsize;       /* bss size */
  53         size_t  ux_lsize;       /* lib size */
  54         long    ux_nshlibs;     /* number of shared libs needed */
  55         short   ux_mach;        /* machine type */
  56         short   ux_mag;         /* magic number MUST be here */
  57         off_t   ux_toffset;     /* file offset to raw text */
  58         off_t   ux_doffset;     /* file offset to raw data */
  59         off_t   ux_loffset;     /* file offset to lib sctn */
  60         caddr_t ux_txtorg;      /* start addr of text in mem */
  61         caddr_t ux_datorg;      /* start addr of data in mem */
  62         caddr_t ux_entloc;      /* entry location */
  63 };
  64
  65 #ifdef  __cplusplus
  66 }
  67 #endif
  68
  69 #if defined(_KERNEL) || defined(_KMEMUSER)
  70
  71 #include <sys/param.h>
  72 #include <sys/pcb.h>
  73 #include <sys/siginfo.h>
  74 #include <sys/resource.h>
  75 #include <sys/time.h>
  76 #include <sys/auxv.h>
  77 #include <sys/errno.h>
  78 #include <sys/t_lock.h>
  79 #include <sys/refstr.h>
  80
  81 #ifdef  __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 /*
  86  * Entry in the per-process list of open files.
  87  * Note: only certain fields are copied in flist_grow() and flist_fork().
  88  * This is indicated in brackets in the structure member comments.
  89  */
  90 typedef struct uf_entry {
  91         kmutex_t        uf_lock;        /* per-fd lock [never copied] */
  92         struct file     *uf_file;       /* file pointer [grow, fork] */
  93         struct fpollinfo *uf_fpollinfo; /* poll state [grow] */
  94         int             uf_refcnt;      /* LWPs accessing this file [grow] */
  95         int             uf_alloc;       /* right subtree allocs [grow, fork] */
  96         short           uf_flag;        /* fcntl F_GETFD flags [grow, fork] */
  97         short           uf_busy;        /* file is allocated [grow, fork] */
  98         kcondvar_t      uf_wanted_cv;   /* waiting for setf() [never copied] */
  99         kcondvar_t      uf_closing_cv;  /* waiting for close() [never copied] */
 100         struct portfd   *uf_portfd;     /* associated with port [grow] */
 101         /* Avoid false sharing - pad to coherency granularity (64 bytes) */
 102         char            uf_pad[64 - sizeof (kmutex_t) - 2 * sizeof (void*) -
 103                 2 * sizeof (int) - 2 * sizeof (short) -
 104                 2 * sizeof (kcondvar_t) - sizeof (struct portfd *)];
 105 } uf_entry_t;
 106
 107 /*
 108  * Retired file lists -- see flist_grow() for details.
 109  */
 110 typedef struct uf_rlist {
 111         struct uf_rlist *ur_next;
 112         uf_entry_t      *ur_list;
 113         int             ur_nfiles;
 114 } uf_rlist_t;
 115
 116 /*
 117  * Per-process file information.
 118  */
 119 typedef struct uf_info {
 120         kmutex_t        fi_lock;        /* see below */
 121         int             fi_badfd;       /* bad file descriptor # */
 122         int             fi_action;      /* action to take on bad fd use */
 123         int             fi_nfiles;      /* number of entries in fi_list[] */
 124         uf_entry_t *volatile fi_list;   /* current file list */
 125         uf_rlist_t      *fi_rlist;      /* retired file lists */
 126 } uf_info_t;
 127
 128 /*
 129  * File list locking.
 130  *
 131  * Each process has a list of open files, fi_list, indexed by fd.
 132  * fi_list is an array of uf_entry_t structures, each with its own lock.
 133  * One might think that the correct way to lock a file descriptor would be:
 134  *
 135  *      ufp = fip->fi_list[fd];
 136  *      mutex_enter(&ufp->uf_lock);
 137  *
 138  * However, that construct is only safe if fi_lock is already held.  If not,
 139  * fi_list can change in the window between loading ufp and entering uf_lock.
 140  * The UF_ENTER() macro deals with this possibility.  UF_ENTER(ufp, fip, fd)
 141  * locks fd and sets ufp to fd's uf_entry.  The locking rules are as follows:
 142  *
 143  * (1) fi_lock protects fi_list and fi_nfiles.  It also protects the
 144  *     uf_alloc and uf_busy fields of every fd's ufp; see fd_find() for
 145  *     details on file descriptor allocation.
 146  *
 147  * (2) UF_ENTER(ufp, fip, fd) locks descriptor fd and sets ufp to point
 148  *     to the uf_entry_t for fd.  UF_ENTER() protects all fields in ufp
 149  *     except uf_alloc and uf_busy.  UF_ENTER(ufp, fip, fd) also prevents
 150  *     ufp->uf_alloc, ufp->uf_busy, fip->fi_list and fip->fi_nfiles from
 151  *     changing.
 152  *
 153  * (3) The lock ordering is (1), (2).
 154  *
 155  * (4) Note that fip->fi_list and fip->fi_nfiles cannot change while *any*
 156  *     file list lock is held.  Thus flist_grow() must acquire all such
 157  *     locks -- fi_lock and every fd's uf_lock -- to install a new file list.
 158  */
 159 #define UF_ENTER(ufp, fip, fd)                                  \
 160         for (;;) {                                              \
 161                 uf_entry_t *_flist = (fip)->fi_list;            \
 162                 ufp = &_flist[fd];                              \
 163                 ASSERT((fd) < (fip)->fi_nfiles);                \
 164                 mutex_enter(&ufp->uf_lock);                     \
 165                 if (_flist == (fip)->fi_list)                   \
 166                         break;                                  \
 167                 mutex_exit(&ufp->uf_lock);                      \
 168         }
 169
 170 #define UF_EXIT(ufp)    mutex_exit(&ufp->uf_lock)
 171
 172 #define PSARGSZ         80      /* Space for exec arguments (used by ps(1)) */
 173 #define MAXCOMLEN       16      /* <= MAXNAMLEN, >= sizeof (ac_comm) */
 174
 175 typedef struct {                /* kernel syscall set type */
 176         uint_t  word[9];        /* space for syscall numbers [1..288] */
 177 } k_sysset_t;
 178
 179 /*
 180  * __KERN_NAUXV_IMPL is defined as a convenience sizing mechanism
 181  * for the portions of the kernel that care about aux vectors.
 182  *
 183  * Applications that need to know how many aux vectors the kernel
 184  * supplies should use the proc(4) interface to read /proc/PID/auxv.
 185  *
 186  * This value should not be changed in a patch.
 187  */
 188 #if defined(__sparc)
 189 #define __KERN_NAUXV_IMPL 20
 190 #elif defined(__i386) || defined(__amd64)
 191 #define __KERN_NAUXV_IMPL 22
 192 #endif
 193
 194 struct execsw;
 195
 196 /*
 197  * The user structure; one allocated per process.  Contains all the
 198  * per-process data that doesn't need to be referenced while the
 199  * process is swapped.
 200  */
 201 typedef struct  user {
 202         /*
 203          * These fields are initialized at process creation time and never
 204          * modified.  They can be accessed without acquiring locks.
 205          */
 206         struct execsw *u_execsw;        /* pointer to exec switch entry */
 207         auxv_t  u_auxv[__KERN_NAUXV_IMPL]; /* aux vector from exec */
 208         timestruc_t u_start;            /* hrestime at process start */
 209         clock_t u_ticks;                /* lbolt at process start */
 210         char    u_comm[MAXCOMLEN + 1];  /* executable file name from exec */
 211         char    u_psargs[PSARGSZ];      /* arguments from exec */
 212         int     u_argc;                 /* value of argc passed to main() */
 213         uintptr_t u_argv;               /* value of argv passed to main() */
 214         uintptr_t u_envp;               /* value of envp passed to main() */
 215         uintptr_t u_commpagep;          /* address of mapped comm page */
 216
 217         /*
 218          * These fields are protected by p_lock:
 219          */
 220         struct vnode *u_cdir;           /* current directory */
 221         struct vnode *u_rdir;           /* root directory */
 222         uint64_t u_mem;                 /* accumulated memory usage */
 223         size_t  u_mem_max;              /* peak RSS (K) */
 224         mode_t  u_cmask;                /* mask for file creation */
 225         char    u_acflag;               /* accounting flag */
 226         char    u_systrap;              /* /proc: any syscall mask bits set? */
 227         char    u_flags;                /* extra flags */
 228         refstr_t *u_cwd;                /* cached string for cwd */
 229
 230         k_sysset_t u_entrymask;         /* /proc syscall stop-on-entry mask */
 231         k_sysset_t u_exitmask;          /* /proc syscall stop-on-exit mask */
 232         k_sigset_t u_signodefer;        /* signals defered when caught */
 233         k_sigset_t u_sigonstack;        /* signals taken on alternate stack */
 234         k_sigset_t u_sigresethand;      /* signals reset when caught */
 235         k_sigset_t u_sigrestart;        /* signals that restart system calls */
 236         k_sigset_t u_sigmask[MAXSIG];   /* signals held while in catcher */
 237         void    (*u_signal[MAXSIG])();  /* Disposition of signals */
 238
 239         /*
 240          * Resource controls provide the backend for process resource limits,
 241          * the interfaces for which are maintained for compatibility.  To
 242          * preserve the behaviour associated with the RLIM_SAVED_CUR and
 243          * RLIM_SAVED_MAX tokens, we retain the "saved" rlimits.
 244          */
 245         struct rlimit64 u_saved_rlimit[RLIM_NSAVED];
 246
 247         uf_info_t       u_finfo;        /* open file information */
 248 } user_t;
 249
 250 #include <sys/proc.h>                   /* cannot include before user defined */
 251
 252 #ifdef  _KERNEL
 253 #define P_FINFO(p)      (&(p)->p_user.u_finfo)
 254 #endif  /* _KERNEL */
 255
 256 #ifdef  __cplusplus
 257 }
 258 #endif
 259
 260 #else   /* defined(_KERNEL) || defined(_KMEMUSER) */
 261
 262 /*
 263  * Here, we define a fake version of struct user for programs
 264  * (debuggers) that use ptrace() to read and modify the saved
 265  * registers directly in the u-area.  ptrace() has been removed
 266  * from the operating system and now exists as a library function
 267  * in libc, built on the /proc process filesystem.  The ptrace()
 268  * library function provides access only to the members of the
 269  * fake struct user defined here.
 270  *
 271  * User-level programs that must know the real contents of struct
 272  * user will have to define _KMEMUSER before including <sys/user.h>.
 273  * Such programs also become machine specific. Carefully consider
 274  * the consequences of your actions.
 275  */
 276
 277 #include <sys/regset.h>
 278
 279 #ifdef  __cplusplus
 280 extern "C" {
 281 #endif
 282
 283 #define PSARGSZ         80      /* Space for exec arguments (used by ps(1)) */
 284
 285 typedef struct  user {
 286         gregset_t       u_reg;          /* user's saved registers */
 287         greg_t          *u_ar0;         /* address of user's saved R0 */
 288         char    u_psargs[PSARGSZ];      /* arguments from exec */
 289         void    (*u_signal[MAXSIG])();  /* Disposition of signals */
 290         int             u_code;         /* fault code on trap */
 291         caddr_t         u_addr;         /* fault PC on trap */
 292 } user_t;
 293
 294 #ifdef  __cplusplus
 295 }
 296 #endif
 297
 298 #endif  /* defined(_KERNEL) || defined(_KMEMUSER) */
 299
 300 #endif  /* _SYS_USER_H */