usr/src/uts/common/sys/procfs.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 /*
  23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26 /*
  27  * Copyright 2012 DEY Storage Systems, Inc.  All rights reserved.
  28  * Copyright 2018 Joyent, Inc.
  29  */
  30
  31 #ifndef _SYS_PROCFS_H
  32 #define _SYS_PROCFS_H
  33
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /*
  39  * This definition is temporary.  Structured proc is the preferred API,
  40  * and the older ioctl-based interface will be removed in a future version
  41  * of Solaris.  Until then, by default, including <sys/procfs.h> will
  42  * provide the older ioctl-based /proc definitions.  To get the structured
  43  * /proc definitions, either include <procfs.h> or define _STRUCTURED_PROC
  44  * to be 1 before including <sys/procfs.h>.
  45  */
  46 #ifndef _STRUCTURED_PROC
  47 #define _STRUCTURED_PROC        0
  48 #endif
  49
  50 #if !defined(_KERNEL) && _STRUCTURED_PROC == 0
  51
  52 #include <sys/old_procfs.h>
  53
  54 #else   /* !defined(_KERNEL) && _STRUCTURED_PROC == 0 */
  55
  56 #include <sys/feature_tests.h>
  57 #include <sys/types.h>
  58 #include <sys/time_impl.h>
  59 #include <sys/signal.h>
  60 #include <sys/siginfo.h>
  61 #include <sys/fault.h>
  62 #include <sys/syscall.h>
  63 #include <sys/pset.h>
  64 #include <sys/procfs_isa.h>
  65 #include <sys/priv.h>
  66 #include <sys/stat.h>
  67 #include <sys/param.h>
  68 #include <sys/secflags.h>
  69 #include <sys/thread.h>
  70
  71 /*
  72  * System call interfaces for /proc.
  73  */
  74
  75 /*
  76  * Control codes (long values) for messages written to ctl and lwpctl files.
  77  */
  78 #define PCNULL   0L     /* null request, advance to next message */
  79 #define PCSTOP   1L     /* direct process or lwp to stop and wait for stop */
  80 #define PCDSTOP  2L     /* direct process or lwp to stop */
  81 #define PCWSTOP  3L     /* wait for process or lwp to stop, no timeout */
  82 #define PCTWSTOP 4L     /* wait for stop, with long millisecond timeout arg */
  83 #define PCRUN    5L     /* make process/lwp runnable, w/ long flags argument */
  84 #define PCCSIG   6L     /* clear current signal from lwp */
  85 #define PCCFAULT 7L     /* clear current fault from lwp */
  86 #define PCSSIG   8L     /* set current signal from siginfo_t argument */
  87 #define PCKILL   9L     /* post a signal to process/lwp, long argument */
  88 #define PCUNKILL 10L    /* delete a pending signal from process/lwp, long arg */
  89 #define PCSHOLD  11L    /* set lwp signal mask from sigset_t argument */
  90 #define PCSTRACE 12L    /* set traced signal set from sigset_t argument */
  91 #define PCSFAULT 13L    /* set traced fault set from fltset_t argument */
  92 #define PCSENTRY 14L    /* set traced syscall entry set from sysset_t arg */
  93 #define PCSEXIT  15L    /* set traced syscall exit set from sysset_t arg */
  94 #define PCSET    16L    /* set modes from long argument */
  95 #define PCUNSET  17L    /* unset modes from long argument */
  96 #define PCSREG   18L    /* set lwp general registers from prgregset_t arg */
  97 #define PCSFPREG 19L    /* set lwp floating-point registers from prfpregset_t */
  98 #define PCSXREG  20L    /* set lwp extra registers from prxregset_t arg */
  99 #define PCNICE   21L    /* set nice priority from long argument */
 100 #define PCSVADDR 22L    /* set %pc virtual address from long argument */
 101 #define PCWATCH  23L    /* set/unset watched memory area from prwatch_t arg */
 102 #define PCAGENT  24L    /* create agent lwp with regs from prgregset_t arg */
 103 #define PCREAD   25L    /* read from the address space via priovec_t arg */
 104 #define PCWRITE  26L    /* write to the address space via priovec_t arg */
 105 #define PCSCRED  27L    /* set process credentials from prcred_t argument */
 106 #define PCSASRS  28L    /* set ancillary state registers from asrset_t arg */
 107 #define PCSPRIV  29L    /* set process privileges from prpriv_t argument */
 108 #define PCSZONE  30L    /* set zoneid from zoneid_t argument */
 109 #define PCSCREDX 31L    /* as PCSCRED but with supplemental groups */
 110 /*
 111  * PCRUN long operand flags.
 112  */
 113 #define PRCSIG          0x01    /* clear current signal, if any */
 114 #define PRCFAULT        0x02    /* clear current fault, if any */
 115 #define PRSTEP          0x04    /* direct the lwp to single-step */
 116 #define PRSABORT        0x08    /* abort syscall, if in syscall */
 117 #define PRSTOP          0x10    /* set directed stop request */
 118
 119 /*
 120  * lwp status file.  /proc/<pid>/lwp/<lwpid>/lwpstatus
 121  */
 122 #define PRCLSZ          8       /* maximum size of scheduling class name */
 123 #define PRSYSARGS       8       /* maximum number of syscall arguments */
 124 typedef struct lwpstatus {
 125         int     pr_flags;       /* flags (see below) */
 126         id_t    pr_lwpid;       /* specific lwp identifier */
 127         short   pr_why;         /* reason for lwp stop, if stopped */
 128         short   pr_what;        /* more detailed reason */
 129         short   pr_cursig;      /* current signal, if any */
 130         short   pr_pad1;
 131         siginfo_t pr_info;      /* info associated with signal or fault */
 132         sigset_t pr_lwppend;    /* set of signals pending to the lwp */
 133         sigset_t pr_lwphold;    /* set of signals blocked by the lwp */
 134         struct sigaction pr_action;     /* signal action for current signal */
 135         stack_t pr_altstack;    /* alternate signal stack info */
 136         uintptr_t pr_oldcontext;        /* address of previous ucontext */
 137         short   pr_syscall;     /* system call number (if in syscall) */
 138         short   pr_nsysarg;     /* number of arguments to this syscall */
 139         int     pr_errno;       /* errno for failed syscall, 0 if successful */
 140         long    pr_sysarg[PRSYSARGS];   /* arguments to this syscall */
 141         long    pr_rval1;       /* primary syscall return value */
 142         long    pr_rval2;       /* second syscall return value, if any */
 143         char    pr_clname[PRCLSZ];      /* scheduling class name */
 144         timestruc_t pr_tstamp;  /* real-time time stamp of stop */
 145         timestruc_t pr_utime;   /* lwp user cpu time */
 146         timestruc_t pr_stime;   /* lwp system cpu time */
 147         int     pr_filler[11 - 2 * sizeof (timestruc_t) / sizeof (int)];
 148         int     pr_errpriv;     /* missing privilege */
 149         uintptr_t pr_ustack;    /* address of stack boundary data (stack_t) */
 150         ulong_t pr_instr;       /* current instruction */
 151         prgregset_t pr_reg;     /* general registers */
 152         prfpregset_t pr_fpreg;  /* floating-point registers */
 153 } lwpstatus_t;
 154
 155 /*
 156  * process status file.  /proc/<pid>/status
 157  */
 158 typedef struct pstatus {
 159         int     pr_flags;       /* flags (see below) */
 160         int     pr_nlwp;        /* number of active lwps in the process */
 161         pid_t   pr_pid;         /* process id */
 162         pid_t   pr_ppid;        /* parent process id */
 163         pid_t   pr_pgid;        /* process group id */
 164         pid_t   pr_sid;         /* session id */
 165         id_t    pr_aslwpid;     /* historical; now always zero */
 166         id_t    pr_agentid;     /* lwp id of the /proc agent lwp, if any */
 167         sigset_t pr_sigpend;    /* set of process pending signals */
 168         uintptr_t pr_brkbase;   /* address of the process heap */
 169         size_t  pr_brksize;     /* size of the process heap, in bytes */
 170         uintptr_t pr_stkbase;   /* address of the process stack */
 171         size_t  pr_stksize;     /* size of the process stack, in bytes */
 172         timestruc_t pr_utime;   /* process user cpu time */
 173         timestruc_t pr_stime;   /* process system cpu time */
 174         timestruc_t pr_cutime;  /* sum of children's user times */
 175         timestruc_t pr_cstime;  /* sum of children's system times */
 176         sigset_t pr_sigtrace;   /* set of traced signals */
 177         fltset_t pr_flttrace;   /* set of traced faults */
 178         sysset_t pr_sysentry;   /* set of system calls traced on entry */
 179         sysset_t pr_sysexit;    /* set of system calls traced on exit */
 180         char    pr_dmodel;      /* data model of the process (see below) */
 181         char    pr_pad[3];
 182         taskid_t pr_taskid;     /* task id */
 183         projid_t pr_projid;     /* project id */
 184         int     pr_nzomb;       /* number of zombie lwps in the process */
 185         zoneid_t pr_zoneid;     /* zone id */
 186         int     pr_filler[15];  /* reserved for future use */
 187         lwpstatus_t pr_lwp;     /* status of the representative lwp */
 188 } pstatus_t;
 189
 190 /*
 191  * pr_flags (same values appear in both pstatus_t and lwpstatus_t pr_flags).
 192  *
 193  * These flags do *not* apply to psinfo_t.pr_flag or lwpsinfo_t.pr_flag
 194  * (which are both deprecated).
 195  */
 196 /* The following flags apply to the specific or representative lwp */
 197 #define PR_STOPPED 0x00000001   /* lwp is stopped */
 198 #define PR_ISTOP   0x00000002   /* lwp is stopped on an event of interest */
 199 #define PR_DSTOP   0x00000004   /* lwp has a stop directive in effect */
 200 #define PR_STEP    0x00000008   /* lwp has a single-step directive in effect */
 201 #define PR_ASLEEP  0x00000010   /* lwp is sleeping in a system call */
 202 #define PR_PCINVAL 0x00000020   /* contents of pr_instr undefined */
 203 #define PR_ASLWP   0x00000040   /* obsolete flag; never set */
 204 #define PR_AGENT   0x00000080   /* this lwp is the /proc agent lwp */
 205 #define PR_DETACH  0x00000100   /* this is a detached lwp */
 206 #define PR_DAEMON  0x00000200   /* this is a daemon lwp */
 207 #define PR_IDLE    0x00000400   /* lwp is a cpu's idle thread */
 208 /* The following flags apply to the process, not to an individual lwp */
 209 #define PR_ISSYS   0x00001000   /* this is a system process */
 210 #define PR_VFORKP  0x00002000   /* process is the parent of a vfork()d child */
 211 #define PR_ORPHAN  0x00004000   /* process's process group is orphaned */
 212 #define PR_NOSIGCHLD 0x00008000 /* process will not generate SIGCHLD on exit */
 213 #define PR_WAITPID 0x00010000   /* only waitid(P_PID, pid) can reap the child */
 214 /* The following process flags are modes settable by PCSET/PCUNSET */
 215 #define PR_FORK    0x00100000   /* inherit-on-fork is in effect */
 216 #define PR_RLC     0x00200000   /* run-on-last-close is in effect */
 217 #define PR_KLC     0x00400000   /* kill-on-last-close is in effect */
 218 #define PR_ASYNC   0x00800000   /* asynchronous-stop is in effect */
 219 #define PR_MSACCT  0x01000000   /* micro-state usage accounting is in effect */
 220 #define PR_BPTADJ  0x02000000   /* breakpoint trap pc adjustment is in effect */
 221 #define PR_PTRACE  0x04000000   /* ptrace-compatibility mode is in effect */
 222 #define PR_MSFORK  0x08000000   /* micro-state accounting inherited on fork */
 223
 224 /*
 225  * See <sys/procfs_isa.h> for possible values of pr_dmodel.
 226  */
 227
 228 /*
 229  * Reasons for stopping (pr_why).
 230  */
 231 #define PR_REQUESTED    1
 232 #define PR_SIGNALLED    2
 233 #define PR_SYSENTRY     3
 234 #define PR_SYSEXIT      4
 235 #define PR_JOBCONTROL   5
 236 #define PR_FAULTED      6
 237 #define PR_SUSPENDED    7
 238 #define PR_CHECKPOINT   8
 239
 240 /*
 241  * lwp ps(1) information file.  /proc/<pid>/lwp/<lwpid>/lwpsinfo
 242  */
 243 #define PRFNSZ          16      /* Maximum size of execed filename */
 244 typedef struct lwpsinfo {
 245         int     pr_flag;        /* lwp flags (DEPRECATED; do not use) */
 246         id_t    pr_lwpid;       /* lwp id */
 247         uintptr_t pr_addr;      /* internal address of lwp */
 248         uintptr_t pr_wchan;     /* wait addr for sleeping lwp */
 249         char    pr_stype;       /* synchronization event type */
 250         char    pr_state;       /* numeric lwp state */
 251         char    pr_sname;       /* printable character for pr_state */
 252         char    pr_nice;        /* nice for cpu usage */
 253         short   pr_syscall;     /* system call number (if in syscall) */
 254         char    pr_oldpri;      /* pre-SVR4, low value is high priority */
 255         char    pr_cpu;         /* pre-SVR4, cpu usage for scheduling */
 256         int     pr_pri;         /* priority, high value is high priority */
 257                         /* The following percent number is a 16-bit binary */
 258                         /* fraction [0 .. 1] with the binary point to the */
 259                         /* right of the high-order bit (1.0 == 0x8000) */
 260         ushort_t pr_pctcpu;     /* % of recent cpu time used by this lwp */
 261         ushort_t pr_pad;
 262         timestruc_t pr_start;   /* lwp start time, from the epoch */
 263         timestruc_t pr_time;    /* usr+sys cpu time for this lwp */
 264         char    pr_clname[PRCLSZ];      /* scheduling class name */
 265         char    pr_name[PRFNSZ];        /* name of system lwp */
 266         processorid_t pr_onpro;         /* processor which last ran this lwp */
 267         processorid_t pr_bindpro;       /* processor to which lwp is bound */
 268         psetid_t pr_bindpset;   /* processor set to which lwp is bound */
 269         int     pr_lgrp;        /* lwp home lgroup */
 270         int     pr_filler[4];   /* reserved for future use */
 271 } lwpsinfo_t;
 272
 273 /*
 274  * process ps(1) information file.  /proc/<pid>/psinfo
 275  */
 276 #define PRARGSZ         80      /* number of chars of arguments */
 277 typedef struct psinfo {
 278         int     pr_flag;        /* process flags (DEPRECATED; do not use) */
 279         int     pr_nlwp;        /* number of active lwps in the process */
 280         pid_t   pr_pid;         /* unique process id */
 281         pid_t   pr_ppid;        /* process id of parent */
 282         pid_t   pr_pgid;        /* pid of process group leader */
 283         pid_t   pr_sid;         /* session id */
 284         uid_t   pr_uid;         /* real user id */
 285         uid_t   pr_euid;        /* effective user id */
 286         gid_t   pr_gid;         /* real group id */
 287         gid_t   pr_egid;        /* effective group id */
 288         uintptr_t pr_addr;      /* address of process */
 289         size_t  pr_size;        /* size of process image in Kbytes */
 290         size_t  pr_rssize;      /* resident set size in Kbytes */
 291         size_t  pr_pad1;
 292         dev_t   pr_ttydev;      /* controlling tty device (or PRNODEV) */
 293                         /* The following percent numbers are 16-bit binary */
 294                         /* fractions [0 .. 1] with the binary point to the */
 295                         /* right of the high-order bit (1.0 == 0x8000) */
 296         ushort_t pr_pctcpu;     /* % of recent cpu time used by all lwps */
 297         ushort_t pr_pctmem;     /* % of system memory used by process */
 298         timestruc_t pr_start;   /* process start time, from the epoch */
 299         timestruc_t pr_time;    /* usr+sys cpu time for this process */
 300         timestruc_t pr_ctime;   /* usr+sys cpu time for reaped children */
 301         char    pr_fname[PRFNSZ];       /* name of execed file */
 302         char    pr_psargs[PRARGSZ];     /* initial characters of arg list */
 303         int     pr_wstat;       /* if zombie, the wait() status */
 304         int     pr_argc;        /* initial argument count */
 305         uintptr_t pr_argv;      /* address of initial argument vector */
 306         uintptr_t pr_envp;      /* address of initial environment vector */
 307         char    pr_dmodel;      /* data model of the process */
 308         char    pr_pad2[3];
 309         taskid_t pr_taskid;     /* task id */
 310         projid_t pr_projid;     /* project id */
 311         int     pr_nzomb;       /* number of zombie lwps in the process */
 312         poolid_t pr_poolid;     /* pool id */
 313         zoneid_t pr_zoneid;     /* zone id */
 314         id_t    pr_contract;    /* process contract */
 315         int     pr_filler[1];   /* reserved for future use */
 316         lwpsinfo_t pr_lwp;      /* information for representative lwp */
 317 } psinfo_t;
 318
 319 #define PRNODEV (dev_t)(-1)     /* non-existent device */
 320
 321 /*
 322  * Memory-map interface.  /proc/<pid>/map /proc/<pid>/rmap
 323  */
 324 #define PRMAPSZ 64
 325 typedef struct prmap {
 326         uintptr_t pr_vaddr;     /* virtual address of mapping */
 327         size_t  pr_size;        /* size of mapping in bytes */
 328         char    pr_mapname[PRMAPSZ];    /* name in /proc/<pid>/object */
 329         offset_t pr_offset;     /* offset into mapped object, if any */
 330         int     pr_mflags;      /* protection and attribute flags (see below) */
 331         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 332         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 333         int     pr_filler[1];   /* filler for future expansion */
 334 } prmap_t;
 335
 336 /*
 337  * HAT memory-map interface.  /proc/<pid>/xmap
 338  */
 339 typedef struct prxmap {
 340         uintptr_t pr_vaddr;     /* virtual address of mapping */
 341         size_t  pr_size;        /* size of mapping in bytes */
 342         char    pr_mapname[PRMAPSZ];    /* name in /proc/<pid>/object */
 343         offset_t pr_offset;     /* offset into mapped object, if any */
 344         int     pr_mflags;      /* protection and attribute flags (see below) */
 345         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 346         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 347         dev_t   pr_dev; /* st_dev from stat64() of mapped object, or PRNODEV */
 348         uint64_t pr_ino; /* st_ino from stat64() of mapped object, if any */
 349         size_t  pr_rss;         /* pages of resident memory */
 350         size_t  pr_anon;        /* pages of resident anonymous memory */
 351         size_t  pr_locked;      /* pages of locked memory */
 352         size_t  pr_pad;         /* currently unused */
 353         uint64_t pr_hatpagesize; /* pagesize of the hat mapping */
 354 #ifdef  _ILP32
 355         ulong_t pr_filler[6];   /* filler for future expansion */
 356 #else
 357         ulong_t pr_filler[7];   /* filler for future expansion */
 358 #endif
 359 } prxmap_t;
 360
 361
 362 /* Protection and attribute flags */
 363 #define MA_READ         0x04    /* readable by the traced process */
 364 #define MA_WRITE        0x02    /* writable by the traced process */
 365 #define MA_EXEC         0x01    /* executable by the traced process */
 366 #define MA_SHARED       0x08    /* changes are shared by mapped object */
 367 #define MA_ANON         0x40    /* anonymous memory (e.g. /dev/zero) */
 368 #define MA_ISM          0x80    /* intimate shared mem (shared MMU resources) */
 369 #define MA_NORESERVE    0x100   /* mapped with MAP_NORESERVE */
 370 #define MA_SHM          0x200   /* System V shared memory */
 371 #define MA_RESERVED1    0x400   /* reserved for future use */
 372
 373 /*
 374  * These are obsolete and unreliable.
 375  * They are included here only for historical compatibility.
 376  */
 377 #define MA_BREAK        0x10    /* grown by brk(2) */
 378 #define MA_STACK        0x20    /* grown automatically on stack faults */
 379
 380 /*
 381  * Process credentials.  PCSCRED and /proc/<pid>/cred
 382  */
 383 typedef struct prcred {
 384         uid_t   pr_euid;        /* effective user id */
 385         uid_t   pr_ruid;        /* real user id */
 386         uid_t   pr_suid;        /* saved user id (from exec) */
 387         gid_t   pr_egid;        /* effective group id */
 388         gid_t   pr_rgid;        /* real group id */
 389         gid_t   pr_sgid;        /* saved group id (from exec) */
 390         int     pr_ngroups;     /* number of supplementary groups */
 391         gid_t   pr_groups[1];   /* array of supplementary groups */
 392 } prcred_t;
 393
 394 /*
 395  * Process privileges.  PCSPRIV and /proc/<pid>/priv
 396  */
 397 typedef struct prpriv {
 398         uint32_t        pr_nsets;               /* number of privilege set */
 399         uint32_t        pr_setsize;             /* size of privilege set */
 400         uint32_t        pr_infosize;            /* size of supplementary data */
 401         priv_chunk_t    pr_sets[1];             /* array of sets */
 402 } prpriv_t;
 403
 404 #define PRSECFLAGS_VERSION_1            1
 405 #define PRSECFLAGS_VERSION_CURRENT      PRSECFLAGS_VERSION_1
 406 typedef struct prsecflags {
 407         uint32_t pr_version;
 408         char pr_pad[4];
 409         secflagset_t pr_effective;
 410         secflagset_t pr_inherit;
 411         secflagset_t pr_lower;
 412         secflagset_t pr_upper;
 413 } prsecflags_t;
 414
 415 /*
 416  * Watchpoint interface.  PCWATCH and /proc/<pid>/watch
 417  */
 418 typedef struct prwatch {
 419         uintptr_t pr_vaddr;     /* virtual address of watched area */
 420         size_t  pr_size;        /* size of watched area in bytes */
 421         int     pr_wflags;      /* watch type flags */
 422         int     pr_pad;
 423 } prwatch_t;
 424
 425 /* pr_wflags */
 426 #define WA_READ         0x04    /* trap on read access */
 427 #define WA_WRITE        0x02    /* trap on write access */
 428 #define WA_EXEC         0x01    /* trap on execute access */
 429 #define WA_TRAPAFTER    0x08    /* trap after instruction completes */
 430
 431 /*
 432  * PCREAD/PCWRITE I/O interface.
 433  */
 434 typedef struct priovec {
 435         void    *pio_base;      /* buffer in controlling process */
 436         size_t  pio_len;        /* size of read/write request */
 437         off_t   pio_offset;     /* virtual address in target process */
 438 } priovec_t;
 439
 440 /*
 441  * Resource usage.  /proc/<pid>/usage /proc/<pid>/lwp/<lwpid>/lwpusage
 442  */
 443 typedef struct prusage {
 444         id_t            pr_lwpid;       /* lwp id.  0: process or defunct */
 445         int             pr_count;       /* number of contributing lwps */
 446         timestruc_t     pr_tstamp;      /* current time stamp */
 447         timestruc_t     pr_create;      /* process/lwp creation time stamp */
 448         timestruc_t     pr_term;        /* process/lwp termination time stamp */
 449         timestruc_t     pr_rtime;       /* total lwp real (elapsed) time */
 450         timestruc_t     pr_utime;       /* user level cpu time */
 451         timestruc_t     pr_stime;       /* system call cpu time */
 452         timestruc_t     pr_ttime;       /* other system trap cpu time */
 453         timestruc_t     pr_tftime;      /* text page fault sleep time */
 454         timestruc_t     pr_dftime;      /* data page fault sleep time */
 455         timestruc_t     pr_kftime;      /* kernel page fault sleep time */
 456         timestruc_t     pr_ltime;       /* user lock wait sleep time */
 457         timestruc_t     pr_slptime;     /* all other sleep time */
 458         timestruc_t     pr_wtime;       /* wait-cpu (latency) time */
 459         timestruc_t     pr_stoptime;    /* stopped time */
 460         timestruc_t     filltime[6];    /* filler for future expansion */
 461         ulong_t         pr_minf;        /* minor page faults */
 462         ulong_t         pr_majf;        /* major page faults */
 463         ulong_t         pr_nswap;       /* swaps */
 464         ulong_t         pr_inblk;       /* input blocks */
 465         ulong_t         pr_oublk;       /* output blocks */
 466         ulong_t         pr_msnd;        /* messages sent */
 467         ulong_t         pr_mrcv;        /* messages received */
 468         ulong_t         pr_sigs;        /* signals received */
 469         ulong_t         pr_vctx;        /* voluntary context switches */
 470         ulong_t         pr_ictx;        /* involuntary context switches */
 471         ulong_t         pr_sysc;        /* system calls */
 472         ulong_t         pr_ioch;        /* chars read and written */
 473         ulong_t         filler[10];     /* filler for future expansion */
 474 } prusage_t;
 475
 476 /*
 477  * Page data file.  /proc/<pid>/pagedata
 478  */
 479
 480 /* page data file header */
 481 typedef struct prpageheader {
 482         timestruc_t     pr_tstamp;      /* real time stamp */
 483         long            pr_nmap;        /* number of address space mappings */
 484         long            pr_npage;       /* total number of pages */
 485 } prpageheader_t;
 486
 487 /* page data mapping header */
 488 typedef struct prasmap {
 489         uintptr_t pr_vaddr;     /* virtual address of mapping */
 490         size_t  pr_npage;       /* number of pages in mapping */
 491         char    pr_mapname[PRMAPSZ];    /* name in /proc/<pid>/object */
 492         offset_t pr_offset;     /* offset into mapped object, if any */
 493         int     pr_mflags;      /* protection and attribute flags */
 494         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 495         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 496         int     pr_filler[1];   /* filler for future expansion */
 497 } prasmap_t;
 498
 499 /*
 500  * pr_npage bytes (plus 0-7 null bytes to round up to an 8-byte boundary)
 501  * follow each mapping header, each containing zero or more of these flags.
 502  */
 503 #define PG_REFERENCED   0x02            /* page referenced since last read */
 504 #define PG_MODIFIED     0x01            /* page modified since last read */
 505 #define PG_HWMAPPED     0x04            /* page is present and mapped */
 506
 507 /*
 508  * Open files.  Only in core files (for now).  Note that we'd like to use
 509  * the stat or stat64 structure, but both of these structures are unfortunately
 510  * not consistent between 32 and 64 bit modes.  To keep our lives simpler, we
 511  * just define our own structure with types that are not sensitive to this
 512  * difference.  Also, it turns out that pfiles omits a lot of info from the
 513  * struct stat (e.g. times, device sizes, etc.) so we don't bother adding those
 514  * here.
 515  */
 516 typedef struct prfdinfo {
 517         int             pr_fd;
 518         mode_t          pr_mode;
 519
 520         uid_t           pr_uid;
 521         gid_t           pr_gid;
 522
 523         major_t         pr_major;       /* think stat.st_dev */
 524         minor_t         pr_minor;
 525
 526         major_t         pr_rmajor;      /* think stat.st_rdev */
 527         minor_t         pr_rminor;
 528
 529         ino64_t         pr_ino;
 530         off64_t         pr_offset;
 531         off64_t         pr_size;
 532
 533         int             pr_fileflags;   /* fcntl(F_GETXFL), etc */
 534         int             pr_fdflags;     /* fcntl(F_GETFD), etc. */
 535
 536         char            pr_path[MAXPATHLEN];
 537 } prfdinfo_t;
 538
 539 /*
 540  * Representation of LWP name in core files.  In /proc, we use a simple char
 541  * array, but in core files we need to make it easy to correlate the note back
 542  * to the right LWP.  For simplicity, we'll use 32/64 consistent types.
 543  */
 544 typedef struct prlwpname {
 545         uint64_t pr_lwpid;
 546         char pr_lwpname[THREAD_NAME_MAX];
 547 } prlwpname_t;
 548
 549 /*
 550  * Header for /proc/<pid>/lstatus /proc/<pid>/lpsinfo /proc/<pid>/lusage
 551  */
 552 typedef struct prheader {
 553         long    pr_nent;        /* number of entries */
 554         long    pr_entsize;     /* size of each entry, in bytes */
 555 } prheader_t;
 556
 557 /*
 558  * Macros for manipulating sets of flags.
 559  * sp must be a pointer to one of sigset_t, fltset_t, or sysset_t.
 560  * flag must be a member of the enumeration corresponding to *sp.
 561  */
 562
 563 /* turn on all flags in set */
 564 #define prfillset(sp) \
 565         { register int _i_ = sizeof (*(sp))/sizeof (uint32_t); \
 566                 while (_i_) ((uint32_t *)(sp))[--_i_] = (uint32_t)0xFFFFFFFF; }
 567
 568 /* turn off all flags in set */
 569 #define premptyset(sp) \
 570         { register int _i_ = sizeof (*(sp))/sizeof (uint32_t); \
 571                 while (_i_) ((uint32_t *)(sp))[--_i_] = (uint32_t)0; }
 572
 573 /* turn on specified flag in set */
 574 #define praddset(sp, flag) \
 575         ((void)(((unsigned)((flag)-1) < 32*sizeof (*(sp))/sizeof (uint32_t)) ? \
 576         (((uint32_t *)(sp))[((flag)-1)/32] |= (1U<<(((flag)-1)%32))) : 0))
 577
 578 /* turn off specified flag in set */
 579 #define prdelset(sp, flag) \
 580         ((void)(((unsigned)((flag)-1) < 32*sizeof (*(sp))/sizeof (uint32_t)) ? \
 581             (((uint32_t *)(sp))[((flag)-1)/32] &= ~(1U<<(((flag)-1)%32))) : 0))
 582
 583 /* query: != 0 iff flag is turned on in set */
 584 #define prismember(sp, flag) \
 585         (((unsigned)((flag)-1) < 32*sizeof (*(sp))/sizeof (uint32_t)) && \
 586             (((uint32_t *)(sp))[((flag)-1)/32] & (1U<<(((flag)-1)%32))))
 587
 588 #if defined(_SYSCALL32)
 589
 590 /*
 591  * dev32_t version of PRNODEV
 592  */
 593 #define PRNODEV32 (dev32_t)(-1)
 594
 595 /*
 596  * Kernel view of /proc structures for _ILP32 programs.
 597  */
 598
 599 /*
 600  * _ILP32 lwp status file.  /proc/<pid>/lwp/<lwpid>/lwpstatus
 601  */
 602 typedef struct lwpstatus32 {
 603         int     pr_flags;       /* flags */
 604         id32_t  pr_lwpid;       /* specific lwp identifier */
 605         short   pr_why;         /* reason for lwp stop, if stopped */
 606         short   pr_what;        /* more detailed reason */
 607         short   pr_cursig;      /* current signal, if any */
 608         short   pr_pad1;
 609         siginfo32_t pr_info;    /* info associated with signal or fault */
 610         sigset_t pr_lwppend;    /* set of signals pending to the lwp */
 611         sigset_t pr_lwphold;    /* set of signals blocked by the lwp */
 612         struct sigaction32 pr_action;   /* signal action for current signal */
 613         stack32_t pr_altstack;  /* alternate signal stack info */
 614         caddr32_t pr_oldcontext;        /* address of previous ucontext */
 615         short   pr_syscall;     /* system call number (if in syscall) */
 616         short   pr_nsysarg;     /* number of arguments to this syscall */
 617         int     pr_errno;       /* errno for failed syscall, 0 if successful */
 618         int32_t pr_sysarg[PRSYSARGS];   /* arguments to this syscall */
 619         int32_t pr_rval1;       /* primary syscall return value */
 620         int32_t pr_rval2;       /* second syscall return value, if any */
 621         char    pr_clname[PRCLSZ];      /* scheduling class name */
 622         timestruc32_t pr_tstamp;        /* real-time time stamp of stop */
 623         timestruc32_t pr_utime; /* lwp user cpu time */
 624         timestruc32_t pr_stime; /* lwp system cpu time */
 625         int     pr_filler[11 - 2 * sizeof (timestruc32_t) / sizeof (int)];
 626         int     pr_errpriv;     /* missing privilege */
 627         caddr32_t pr_ustack;    /* address of stack boundary data (stack32_t) */
 628         uint32_t pr_instr;      /* current instruction */
 629         prgregset32_t pr_reg;   /* general registers */
 630         prfpregset32_t pr_fpreg; /* floating-point registers */
 631 } lwpstatus32_t;
 632
 633 /*
 634  * _ILP32 process status file.  /proc/<pid>/status
 635  */
 636 typedef struct pstatus32 {
 637         int     pr_flags;       /* flags */
 638         int     pr_nlwp;        /* number of active lwps in the process */
 639         pid32_t pr_pid;         /* process id */
 640         pid32_t pr_ppid;        /* parent process id */
 641         pid32_t pr_pgid;        /* process group id */
 642         pid32_t pr_sid;         /* session id */
 643         id32_t  pr_aslwpid;     /* historical; now always zero */
 644         id32_t  pr_agentid;     /* lwp id of the /proc agent lwp, if any */
 645         sigset_t pr_sigpend;    /* set of process pending signals */
 646         caddr32_t pr_brkbase;   /* address of the process heap */
 647         size32_t pr_brksize;    /* size of the process heap, in bytes */
 648         caddr32_t pr_stkbase;   /* address of the process stack */
 649         size32_t pr_stksize;    /* size of the process stack, in bytes */
 650         timestruc32_t pr_utime; /* process user cpu time */
 651         timestruc32_t pr_stime; /* process system cpu time */
 652         timestruc32_t pr_cutime;        /* sum of children's user times */
 653         timestruc32_t pr_cstime;        /* sum of children's system times */
 654         sigset_t pr_sigtrace;   /* set of traced signals */
 655         fltset_t pr_flttrace;   /* set of traced faults */
 656         sysset_t pr_sysentry;   /* set of system calls traced on entry */
 657         sysset_t pr_sysexit;    /* set of system calls traced on exit */
 658         char    pr_dmodel;      /* data model of the process */
 659         char    pr_pad[3];
 660         id32_t  pr_taskid;      /* task id */
 661         id32_t  pr_projid;      /* project id */
 662         int     pr_nzomb;       /* number of zombie lwps in the process */
 663         id32_t  pr_zoneid;      /* zone id */
 664         int     pr_filler[15];  /* reserved for future use */
 665         lwpstatus32_t pr_lwp;   /* status of the representative lwp */
 666 } pstatus32_t;
 667
 668 /*
 669  * _ILP32 lwp ps(1) information file.  /proc/<pid>/lwp/<lwpid>/lwpsinfo
 670  */
 671 typedef struct lwpsinfo32 {
 672         int     pr_flag;        /* lwp flags */
 673         id32_t  pr_lwpid;       /* lwp id */
 674         caddr32_t pr_addr;      /* internal address of lwp */
 675         caddr32_t pr_wchan;     /* wait addr for sleeping lwp */
 676         char    pr_stype;       /* synchronization event type */
 677         char    pr_state;       /* numeric lwp state */
 678         char    pr_sname;       /* printable character for pr_state */
 679         char    pr_nice;        /* nice for cpu usage */
 680         short   pr_syscall;     /* system call number (if in syscall) */
 681         char    pr_oldpri;      /* pre-SVR4, low value is high priority */
 682         char    pr_cpu;         /* pre-SVR4, cpu usage for scheduling */
 683         int     pr_pri;         /* priority, high value is high priority */
 684                         /* The following percent number is a 16-bit binary */
 685                         /* fraction [0 .. 1] with the binary point to the */
 686                         /* right of the high-order bit (1.0 == 0x8000) */
 687         ushort_t pr_pctcpu;     /* % of recent cpu time used by this lwp */
 688         ushort_t pr_pad;
 689         timestruc32_t pr_start; /* lwp start time, from the epoch */
 690         timestruc32_t pr_time;  /* usr+sys cpu time for this lwp */
 691         char    pr_clname[PRCLSZ];      /* scheduling class name */
 692         char    pr_name[PRFNSZ];        /* name of system lwp */
 693         processorid_t pr_onpro;         /* processor which last ran this lwp */
 694         processorid_t pr_bindpro;       /* processor to which lwp is bound */
 695         psetid_t pr_bindpset;   /* processor set to which lwp is bound */
 696         int     pr_lgrp;        /* lwp home lgroup */
 697         int     pr_filler[4];   /* reserved for future use */
 698 } lwpsinfo32_t;
 699
 700 /*
 701  * _ILP32 process ps(1) information file.  /proc/<pid>/psinfo
 702  */
 703 typedef struct psinfo32 {
 704         int     pr_flag;        /* process flags */
 705         int     pr_nlwp;        /* number of active lwps in the process */
 706         pid32_t pr_pid;         /* unique process id */
 707         pid32_t pr_ppid;        /* process id of parent */
 708         pid32_t pr_pgid;        /* pid of process group leader */
 709         pid32_t pr_sid;         /* session id */
 710         uid32_t pr_uid;         /* real user id */
 711         uid32_t pr_euid;        /* effective user id */
 712         gid32_t pr_gid;         /* real group id */
 713         gid32_t pr_egid;        /* effective group id */
 714         caddr32_t pr_addr;      /* address of process */
 715         size32_t pr_size;       /* size of process image in Kbytes */
 716         size32_t pr_rssize;     /* resident set size in Kbytes */
 717         size32_t pr_pad1;
 718         dev32_t pr_ttydev;      /* controlling tty device (or PRNODEV) */
 719         ushort_t pr_pctcpu;     /* % of recent cpu time used by all lwps */
 720         ushort_t pr_pctmem;     /* % of system memory used by process */
 721         timestruc32_t pr_start; /* process start time, from the epoch */
 722         timestruc32_t pr_time;  /* usr+sys cpu time for this process */
 723         timestruc32_t pr_ctime; /* usr+sys cpu time for reaped children */
 724         char    pr_fname[PRFNSZ];       /* name of execed file */
 725         char    pr_psargs[PRARGSZ];     /* initial characters of arg list */
 726         int     pr_wstat;       /* if zombie, the wait() status */
 727         int     pr_argc;        /* initial argument count */
 728         caddr32_t pr_argv;      /* address of initial argument vector */
 729         caddr32_t pr_envp;      /* address of initial environment vector */
 730         char    pr_dmodel;      /* data model of the process */
 731         char    pr_pad2[3];
 732         id32_t  pr_taskid;      /* task id */
 733         id32_t  pr_projid;      /* project id */
 734         int     pr_nzomb;       /* number of zombie lwps in the process */
 735         id32_t  pr_poolid;      /* pool id */
 736         id32_t  pr_zoneid;      /* zone id */
 737         id32_t  pr_contract;    /* process contract */
 738         int     pr_filler[1];   /* reserved for future use */
 739         lwpsinfo32_t pr_lwp;    /* information for representative lwp */
 740 } psinfo32_t;
 741
 742 /*
 743  * _ILP32 Memory-management interface.  /proc/<pid>/map /proc/<pid>/rmap
 744  */
 745 typedef struct prmap32 {
 746         caddr32_t pr_vaddr;     /* virtual address of mapping */
 747         size32_t pr_size;       /* size of mapping in bytes */
 748         char    pr_mapname[64]; /* name in /proc/<pid>/object */
 749         offset_t pr_offset;     /* offset into mapped object, if any */
 750         int     pr_mflags;      /* protection and attribute flags */
 751         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 752         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 753         int     pr_filler[1];   /* filler for future expansion */
 754 } prmap32_t;
 755
 756 /*
 757  * _ILP32 HAT memory-map interface.  /proc/<pid>/xmap
 758  */
 759 typedef struct prxmap32 {
 760         caddr32_t pr_vaddr;     /* virtual address of mapping */
 761         size32_t pr_size;       /* size of mapping in bytes */
 762         char    pr_mapname[PRMAPSZ];    /* name in /proc/<pid>/object */
 763         offset_t pr_offset;     /* offset into mapped object, if any */
 764         int     pr_mflags;      /* protection and attribute flags (see below) */
 765         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 766         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 767         dev32_t pr_dev;  /* st_dev from stat64() of mapped object, or PRNODEV */
 768         uint64_t pr_ino; /* st_ino from stat64() of mapped object, if any */
 769         uint32_t pr_rss;        /* pages of resident memory */
 770         uint32_t pr_anon;       /* pages of resident anonymous memory */
 771         uint32_t pr_locked;     /* pages of locked memory */
 772         uint32_t pr_pad;        /* currently unused */
 773         uint64_t pr_hatpagesize; /* pagesize of the hat mapping */
 774         uint32_t pr_filler[6];  /* filler for future expansion */
 775 } prxmap32_t;
 776
 777 /*
 778  * _ILP32 Process credentials.  PCSCRED and /proc/<pid>/cred
 779  */
 780 typedef struct prcred32 {
 781         uid32_t pr_euid;        /* effective user id */
 782         uid32_t pr_ruid;        /* real user id */
 783         uid32_t pr_suid;        /* saved user id (from exec) */
 784         gid32_t pr_egid;        /* effective group id */
 785         gid32_t pr_rgid;        /* real group id */
 786         gid32_t pr_sgid;        /* saved group id (from exec) */
 787         int     pr_ngroups;     /* number of supplementary groups */
 788         gid32_t pr_groups[1];   /* array of supplementary groups */
 789 } prcred32_t;
 790
 791 /*
 792  * _ILP32 Watchpoint interface.  PCWATCH and /proc/<pid>/watch
 793  */
 794 typedef struct prwatch32 {
 795         caddr32_t pr_vaddr;     /* virtual address of watched area */
 796         size32_t pr_size;       /* size of watched area in bytes */
 797         int     pr_wflags;      /* watch type flags */
 798         int     pr_pad;
 799 } prwatch32_t;
 800
 801 /*
 802  * _ILP32 PCREAD/PCWRITE I/O interface.
 803  */
 804 typedef struct priovec32 {
 805         caddr32_t pio_base;     /* buffer in controlling process */
 806         size32_t pio_len;       /* size of read/write request */
 807         off32_t pio_offset;     /* virtual address in target process */
 808 } priovec32_t;
 809
 810 /*
 811  * _ILP32 Resource usage.  /proc/<pid>/usage /proc/<pid>/lwp/<lwpid>/lwpusage
 812  */
 813 typedef struct prusage32 {
 814         id32_t          pr_lwpid;       /* lwp id.  0: process or defunct */
 815         int32_t         pr_count;       /* number of contributing lwps */
 816         timestruc32_t   pr_tstamp;      /* current time stamp */
 817         timestruc32_t   pr_create;      /* process/lwp creation time stamp */
 818         timestruc32_t   pr_term;        /* process/lwp termination time stamp */
 819         timestruc32_t   pr_rtime;       /* total lwp real (elapsed) time */
 820         timestruc32_t   pr_utime;       /* user level cpu time */
 821         timestruc32_t   pr_stime;       /* system call cpu time */
 822         timestruc32_t   pr_ttime;       /* other system trap cpu time */
 823         timestruc32_t   pr_tftime;      /* text page fault sleep time */
 824         timestruc32_t   pr_dftime;      /* data page fault sleep time */
 825         timestruc32_t   pr_kftime;      /* kernel page fault sleep time */
 826         timestruc32_t   pr_ltime;       /* user lock wait sleep time */
 827         timestruc32_t   pr_slptime;     /* all other sleep time */
 828         timestruc32_t   pr_wtime;       /* wait-cpu (latency) time */
 829         timestruc32_t   pr_stoptime;    /* stopped time */
 830         timestruc32_t   filltime[6];    /* filler for future expansion */
 831         uint32_t        pr_minf;        /* minor page faults */
 832         uint32_t        pr_majf;        /* major page faults */
 833         uint32_t        pr_nswap;       /* swaps */
 834         uint32_t        pr_inblk;       /* input blocks */
 835         uint32_t        pr_oublk;       /* output blocks */
 836         uint32_t        pr_msnd;        /* messages sent */
 837         uint32_t        pr_mrcv;        /* messages received */
 838         uint32_t        pr_sigs;        /* signals received */
 839         uint32_t        pr_vctx;        /* voluntary context switches */
 840         uint32_t        pr_ictx;        /* involuntary context switches */
 841         uint32_t        pr_sysc;        /* system calls */
 842         uint32_t        pr_ioch;        /* chars read and written */
 843         uint32_t        filler[10];     /* filler for future expansion */
 844 } prusage32_t;
 845
 846 /*
 847  * _ILP32 Page data file.  /proc/<pid>/pagedata
 848  */
 849
 850 /* _ILP32 page data file header */
 851 typedef struct prpageheader32 {
 852         timestruc32_t   pr_tstamp;      /* real time stamp */
 853         int32_t         pr_nmap;        /* number of address space mappings */
 854         int32_t         pr_npage;       /* total number of pages */
 855 } prpageheader32_t;
 856
 857 /* _ILP32 page data mapping header */
 858 typedef struct prasmap32 {
 859         caddr32_t pr_vaddr;     /* virtual address of mapping */
 860         size32_t pr_npage;      /* number of pages in mapping */
 861         char    pr_mapname[64]; /* name in /proc/<pid>/object */
 862         offset_t pr_offset;     /* offset into mapped object, if any */
 863         int     pr_mflags;      /* protection and attribute flags */
 864         int     pr_pagesize;    /* pagesize (bytes) for this mapping */
 865         int     pr_shmid;       /* SysV shmid, -1 if not SysV shared memory */
 866         int     pr_filler[1];   /* filler for future expansion */
 867 } prasmap32_t;
 868
 869 /*
 870  * _ILP32 Header for /proc/<pid>/lstatus /proc/<pid>/lpsinfo /proc/<pid>/lusage
 871  */
 872 typedef struct prheader32 {
 873         int32_t pr_nent;        /* number of entries */
 874         int32_t pr_entsize;     /* size of each entry, in bytes */
 875 } prheader32_t;
 876
 877 #endif  /* _SYSCALL32 */
 878
 879 #endif  /* !_KERNEL && _STRUCTURED_PROC == 0 */
 880
 881 #ifdef  __cplusplus
 882 }
 883 #endif
 884
 885 #endif  /* _SYS_PROCFS_H */