include/sys/proc.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 (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright 2018 Joyent, Inc.
  25  */
  26
  27 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  28 /*        All Rights Reserved   */
  29
  30 #ifndef _SYS_PROC_H
  31 #define _SYS_PROC_H
  32
  33 #include <sys/time.h>
  34 #include <sys/thread.h>
  35 #include <sys/cred.h>
  36 #include <sys/user.h>
  37 #include <sys/watchpoint.h>
  38 #include <sys/timer.h>
  39 #if defined(__x86)
  40 #include <sys/tss.h>
  41 #include <sys/segments.h>
  42 #endif
  43 #include <sys/utrap.h>
  44 #include <sys/model.h>
  45 #include <sys/refstr.h>
  46 #include <sys/avl.h>
  47 #include <sys/rctl.h>
  48 #include <sys/list.h>
  49 #include <sys/avl.h>
  50 #include <sys/door_impl.h>
  51 #include <sys/signalfd.h>
  52 #include <sys/secflags.h>
  53
  54 #ifdef  __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 /*
  59  * Profile arguments.
  60  */
  61 struct prof {
  62         void            *pr_base;       /* buffer base */
  63         uintptr_t       pr_off;         /* pc offset */
  64         size_t          pr_size;        /* buffer size */
  65         uint32_t        pr_scale;       /* pc scaling */
  66         long            pr_samples;     /* sample count */
  67 };
  68
  69 /*
  70  * An lwp directory entry.
  71  * If le_thread != NULL, this is an active lwp.
  72  * If le_thread == NULL, this is an unreaped zombie lwp.
  73  */
  74 typedef struct lwpent {
  75         kthread_t       *le_thread;     /* the active lwp, NULL if zombie */
  76         id_t            le_lwpid;       /* its lwpid (t->t_tid) */
  77         uint16_t        le_waiters;     /* total number of lwp_wait()ers */
  78         uint16_t        le_dwaiters;    /* number that are daemons */
  79         clock_t         le_start;       /* start time of this lwp */
  80         struct vnode    *le_trace;      /* pointer to /proc lwp vnode */
  81 } lwpent_t;
  82
  83 typedef struct pctxop {
  84         void    (*save_op)(void *);     /* function to invoke to save ctx */
  85         void    (*restore_op)(void *);  /* function to invoke to restore ctx */
  86         void    (*fork_op)(void *, void *); /* invoke to fork context */
  87         void    (*exit_op)(void *);     /* invoked during process exit */
  88         void    (*free_op)(void *, int); /* function which frees the context */
  89         void    *arg;                   /* argument to above functions */
  90         struct pctxop *next;            /* next pcontext ops */
  91 } pctxop_t;
  92
  93 /*
  94  * Elements of the lwp directory, p->p_lwpdir[].
  95  *
  96  * We allocate lwp directory entries separately from lwp directory
  97  * elements because the lwp directory must be allocated as an array.
  98  * The number of lwps can grow quite large and we want to keep the
  99  * size of the kmem_alloc()d directory as small as possible.
 100  *
 101  * If ld_entry == NULL, the entry is free and is on the free list,
 102  * p->p_lwpfree, linked through ld_next.  If ld_entry != NULL, the
 103  * entry is used and ld_next is the thread-id hash link pointer.
 104  */
 105 typedef struct lwpdir {
 106         struct lwpdir   *ld_next;       /* hash chain or free list */
 107         struct lwpent   *ld_entry;      /* lwp directory entry */
 108 } lwpdir_t;
 109
 110 /*
 111  * Element of the p_tidhash thread-id (lwpid) hash table.
 112  */
 113 typedef struct tidhash {
 114         kmutex_t        th_lock;
 115         lwpdir_t        *th_list;
 116 } tidhash_t;
 117
 118 /*
 119  * Retired tidhash hash tables.
 120  */
 121 typedef struct ret_tidhash {
 122         struct ret_tidhash      *rth_next;
 123         tidhash_t               *rth_tidhash;
 124         uint_t                  rth_tidhash_sz;
 125 } ret_tidhash_t;
 126
 127 struct pool;
 128 struct task;
 129 struct zone;
 130 struct brand;
 131 struct corectl_path;
 132 struct corectl_content;
 133
 134 /*
 135  * One structure allocated per active process.  Per-process data (user.h) is
 136  * also inside the proc structure.
 137  */
 138 typedef struct  proc {
 139         /*
 140          * Fields requiring no explicit locking
 141          */
 142         struct  vnode *p_exec;          /* pointer to a.out vnode */
 143         struct  as *p_as;               /* process address space pointer */
 144         struct  plock *p_lockp;         /* ptr to proc struct's mutex lock */
 145         kmutex_t p_crlock;              /* lock for p_cred */
 146         struct  cred    *p_cred;        /* process credentials */
 147         /*
 148          * Fields protected by pidlock
 149          */
 150         char    p_stat;                 /* status of process */
 151         char    p_wcode;                /* current wait code */
 152         ushort_t p_pidflag;             /* flags protected only by pidlock */
 153         int     p_wdata;                /* current wait return value */
 154         pid_t   p_ppid;                 /* process id of parent */
 155         struct  proc    *p_link;        /* forward link */
 156         struct  proc    *p_parent;      /* ptr to parent process */
 157         struct  proc    *p_child;       /* ptr to first child process */
 158         struct  proc    *p_sibling;     /* ptr to next sibling proc on chain */
 159         struct  proc    *p_psibling;    /* ptr to prev sibling proc on chain */
 160         struct  proc    *p_sibling_ns;  /* prt to siblings with new state */
 161         struct  proc    *p_child_ns;    /* prt to children with new state */
 162         struct  proc    *p_next;        /* active chain link next */
 163         struct  proc    *p_prev;        /* active chain link prev */
 164         struct  proc    *p_nextofkin;   /* gets accounting info at exit */
 165         struct  proc    *p_orphan;
 166         struct  proc    *p_nextorph;
 167         struct  proc    *p_pglink;      /* process group hash chain link next */
 168         struct  proc    *p_ppglink;     /* process group hash chain link prev */
 169         struct  sess    *p_sessp;       /* session information */
 170         struct  pid     *p_pidp;        /* process ID info */
 171         struct  pid     *p_pgidp;       /* process group ID info */
 172         /*
 173          * Fields protected by p_lock
 174          */
 175         kcondvar_t p_cv;                /* proc struct's condition variable */
 176         kcondvar_t p_flag_cv;
 177         kcondvar_t p_lwpexit;           /* waiting for some lwp to exit */
 178         kcondvar_t p_holdlwps;          /* process is waiting for its lwps */
 179                                         /* to to be held.  */
 180         uint_t  p_proc_flag;            /* /proc-related flags */
 181         uint_t  p_flag;                 /* protected while set. */
 182                                         /* flags defined below */
 183         clock_t p_utime;                /* user time, this process */
 184         clock_t p_stime;                /* system time, this process */
 185         clock_t p_cutime;               /* sum of children's user time */
 186         clock_t p_cstime;               /* sum of children's system time */
 187         avl_tree_t *p_segacct;          /* System V shared segment list */
 188         avl_tree_t *p_semacct;          /* System V semaphore undo list */
 189         caddr_t p_bssbase;              /* base addr of last bss below heap */
 190         caddr_t p_brkbase;              /* base addr of heap */
 191         size_t  p_brksize;              /* heap size in bytes */
 192         uint_t  p_brkpageszc;           /* preferred heap max page size code */
 193         /*
 194          * Per process signal stuff.
 195          */
 196         k_sigset_t p_sig;               /* signals pending to this process */
 197         k_sigset_t p_extsig;            /* signals sent from another contract */
 198         k_sigset_t p_ignore;            /* ignore when generated */
 199         k_sigset_t p_siginfo;           /* gets signal info with signal */
 200         void *p_sigfd;                  /* signalfd support state */
 201         struct sigqueue *p_sigqueue;    /* queued siginfo structures */
 202         struct sigqhdr *p_sigqhdr;      /* hdr to sigqueue structure pool */
 203         struct sigqhdr *p_signhdr;      /* hdr to signotify structure pool */
 204         uchar_t p_stopsig;              /* jobcontrol stop signal */
 205
 206         /*
 207          * Special per-process flag when set will fix misaligned memory
 208          * references.
 209          */
 210         char    p_fixalignment;
 211
 212         /*
 213          * Per process lwp and kernel thread stuff
 214          */
 215         id_t    p_lwpid;                /* most recently allocated lwpid */
 216         int     p_lwpcnt;               /* number of lwps in this process */
 217         int     p_lwprcnt;              /* number of not stopped lwps */
 218         int     p_lwpdaemon;            /* number of TP_DAEMON lwps */
 219         int     p_lwpwait;              /* number of lwps in lwp_wait() */
 220         int     p_lwpdwait;             /* number of daemons in lwp_wait() */
 221         int     p_zombcnt;              /* number of zombie lwps */
 222         kthread_t *p_tlist;             /* circular list of threads */
 223         lwpdir_t *p_lwpdir;             /* thread (lwp) directory */
 224         lwpdir_t *p_lwpfree;            /* p_lwpdir free list */
 225         tidhash_t *p_tidhash;           /* tid (lwpid) lookup hash table */
 226         uint_t  p_lwpdir_sz;            /* number of p_lwpdir[] entries */
 227         uint_t  p_tidhash_sz;           /* number of p_tidhash[] entries */
 228         ret_tidhash_t *p_ret_tidhash;   /* retired tidhash hash tables */
 229         uint64_t p_lgrpset;             /* unprotected hint of set of lgrps */
 230                                         /* on which process has threads */
 231         volatile lgrp_id_t  p_t1_lgrpid; /* main's thread lgroup id */
 232         volatile lgrp_id_t  p_tr_lgrpid; /* text replica's lgroup id */
 233 #if defined(_LP64)
 234         uintptr_t  p_lgrpres2;          /* reserved for lgrp migration */
 235 #endif
 236         /*
 237          * /proc (process filesystem) debugger interface stuff.
 238          */
 239         k_sigset_t p_sigmask;           /* mask of traced signals (/proc) */
 240         k_fltset_t p_fltmask;           /* mask of traced faults (/proc) */
 241         struct vnode *p_trace;          /* pointer to primary /proc vnode */
 242         struct vnode *p_plist;          /* list of /proc vnodes for process */
 243         kthread_t *p_agenttp;           /* thread ptr for /proc agent lwp */
 244         avl_tree_t p_warea;             /* list of watched areas */
 245         avl_tree_t p_wpage;             /* remembered watched pages (vfork) */
 246         watched_page_t *p_wprot;        /* pages that need to have prot set */
 247         int     p_mapcnt;               /* number of active pr_mappage()s */
 248         kmutex_t p_maplock;             /* lock for pr_mappage() */
 249         struct  proc  *p_rlink;         /* linked list for server */
 250         kcondvar_t p_srwchan_cv;
 251
 252         /*
 253          * Stack sizing and guard information.
 254          * Generally protected by as_rangelock()
 255          */
 256         size_t          p_stksize;      /* process stack size in bytes */
 257         uint_t          p_stkpageszc;   /* preferred stack max page size code */
 258         uintptr_t       p_stkg_start;   /* start of stack guard */
 259         uintptr_t       p_stkg_end;     /* end of stack guard */
 260
 261         /*
 262          * Microstate accounting, resource usage, and real-time profiling
 263          */
 264         hrtime_t p_mstart;              /* hi-res process start time */
 265         hrtime_t p_mterm;               /* hi-res process termination time */
 266         hrtime_t p_mlreal;              /* elapsed time sum over defunct lwps */
 267         hrtime_t p_acct[NMSTATES];      /* microstate sum over defunct lwps */
 268         hrtime_t p_cacct[NMSTATES];     /* microstate sum over child procs */
 269         struct lrusage p_ru;            /* lrusage sum over defunct lwps */
 270         struct lrusage p_cru;           /* lrusage sum over child procs */
 271         struct itimerval p_rprof_timer; /* ITIMER_REALPROF interval timer */
 272         uintptr_t p_rprof_cyclic;       /* ITIMER_REALPROF cyclic */
 273         uint_t  p_defunct;              /* number of defunct lwps */
 274         /*
 275          * profiling. A lock is used in the event of multiple lwp's
 276          * using the same profiling base/size.
 277          */
 278         kmutex_t p_pflock;              /* protects user profile arguments */
 279         struct prof p_prof;             /* profile arguments */
 280
 281         /*
 282          * Doors.
 283          */
 284         door_pool_t             p_server_threads; /* common thread pool */
 285         struct door_node        *p_door_list;   /* active doors */
 286         struct door_node        *p_unref_list;
 287         kcondvar_t              p_unref_cv;
 288         char                    p_unref_thread; /* unref thread created */
 289
 290         /*
 291          * Kernel probes
 292          */
 293         uchar_t                 p_tnf_flags;
 294
 295         /*
 296          * Solaris Audit
 297          */
 298         struct p_audit_data     *p_audit_data; /* per process audit structure */
 299
 300         pctxop_t        *p_pctx;
 301
 302 #if defined(__x86)
 303         /*
 304          * LDT support.
 305          */
 306         kmutex_t        p_ldtlock;      /* protects the following fields */
 307         user_desc_t     *p_ldt;         /* Pointer to private LDT */
 308         uint64_t        p_unused1;      /* no longer used */
 309         uint64_t        p_unused2;      /* no longer used */
 310         ushort_t        p_ldtlimit;     /* highest selector used */
 311 #endif
 312         size_t p_swrss;                 /* resident set size before last swap */
 313         struct aio      *p_aio;         /* pointer to async I/O struct */
 314         struct itimer   **p_itimer;     /* interval timers */
 315         timeout_id_t    p_alarmid;      /* alarm's timeout id */
 316         caddr_t         p_usrstack;     /* top of the process stack */
 317         uint_t          p_stkprot;      /* stack memory protection */
 318         uint_t          p_datprot;      /* data memory protection */
 319         model_t         p_model;        /* data model determined at exec time */
 320         struct lwpchan_data *p_lcp;     /* lwpchan cache */
 321         kmutex_t        p_lcp_lock;     /* protects assignments to p_lcp */
 322         utrap_handler_t *p_utraps;      /* pointer to user trap handlers */
 323         struct corectl_path     *p_corefile;    /* pattern for core file */
 324         struct task     *p_task;        /* our containing task */
 325         struct proc     *p_taskprev;    /* ptr to previous process in task */
 326         struct proc     *p_tasknext;    /* ptr to next process in task */
 327         kmutex_t        p_sc_lock;      /* protects p_pagep */
 328         struct sc_page_ctl *p_pagep;    /* list of process's shared pages */
 329         struct rctl_set *p_rctls;       /* resource controls for this process */
 330         rlim_t          p_stk_ctl;      /* currently enforced stack size */
 331         rlim_t          p_fsz_ctl;      /* currently enforced file size */
 332         rlim_t          p_vmem_ctl;     /* currently enforced addr-space size */
 333         rlim_t          p_fno_ctl;      /* currently enforced file-desc limit */
 334         pid_t           p_ancpid;       /* ancestor pid, used by exacct */
 335         struct itimerval p_realitimer;  /* real interval timer */
 336         timeout_id_t    p_itimerid;     /* real interval timer's timeout id */
 337         struct corectl_content *p_content;      /* content of core file */
 338
 339         avl_tree_t      p_ct_held;      /* held contracts */
 340         struct ct_equeue **p_ct_equeue; /* process-type event queues */
 341
 342         struct cont_process *p_ct_process; /* process contract */
 343         list_node_t     p_ct_member;    /* process contract membership */
 344         sigqueue_t      *p_killsqp;     /* sigqueue pointer for SIGKILL */
 345
 346         int             p_dtrace_probes; /* are there probes for this proc? */
 347         uint64_t        p_dtrace_count; /* number of DTrace tracepoints */
 348                                         /* (protected by P_PR_LOCK) */
 349         void            *p_dtrace_helpers; /* DTrace helpers, if any */
 350         struct pool     *p_pool;        /* pointer to containing pool */
 351         kcondvar_t      p_poolcv;       /* synchronization with pools */
 352         uint_t          p_poolcnt;      /* # threads inside pool barrier */
 353         uint_t          p_poolflag;     /* pool-related flags (see below) */
 354         uintptr_t       p_portcnt;      /* event ports counter */
 355         struct zone     *p_zone;        /* zone in which process lives */
 356         struct vnode    *p_execdir;     /* directory that p_exec came from */
 357         struct brand    *p_brand;       /* process's brand  */
 358         void            *p_brand_data;  /* per-process brand state */
 359         psecflags_t     p_secflags;     /* per-process security flags */
 360
 361         /* additional lock to protect p_sessp (but not its contents) */
 362         kmutex_t p_splock;
 363         rctl_qty_t      p_locked_mem;   /* locked memory charged to proc */
 364                                         /* protected by p_lock */
 365         rctl_qty_t      p_crypto_mem;   /* /dev/crypto memory charged to proc */
 366                                         /* protected by p_lock */
 367         clock_t p_ttime;                /* buffered task time */
 368
 369         /*
 370          * The user structure
 371          */
 372         struct user p_user;             /* (see sys/user.h) */
 373 } proc_t;
 374
 375 #define PROC_T                          /* headers relying on proc_t are OK */
 376
 377 #ifdef _KERNEL
 378
 379 /* active process chain */
 380
 381 extern proc_t *practive;
 382
 383 /* Well known processes */
 384
 385 extern proc_t *proc_sched;              /* memory scheduler */
 386 extern proc_t *proc_init;               /* init */
 387 extern proc_t *proc_pageout;            /* pageout daemon */
 388 extern proc_t *proc_fsflush;            /* filesystem sync-er */
 389
 390 #endif /* _KERNEL */
 391
 392 /*
 393  * Stuff to keep track of the number of processes each uid has.
 394  * It is tracked on a per-zone basis; that is, if users in different
 395  * zones have the same uid, they are tracked separately.
 396  *
 397  * A structure is allocated when a new <uid,zoneid> pair shows up
 398  * There is a hash to find each structure.
 399  */
 400 struct  upcount {
 401         struct  upcount *up_next;
 402         uid_t           up_uid;
 403         zoneid_t        up_zoneid;
 404         uint_t          up_count;
 405 };
 406
 407 /* process ID info */
 408
 409 struct pid {
 410         unsigned int pid_prinactive :1;
 411         unsigned int pid_pgorphaned :1;
 412         unsigned int pid_padding :6;    /* used to be pid_ref, now an int */
 413         unsigned int pid_prslot :24;
 414         pid_t pid_id;
 415         struct proc *pid_pglink;
 416         struct proc *pid_pgtail;
 417         struct pid *pid_link;
 418         uint_t pid_ref;
 419 };
 420
 421 #define p_pgrp p_pgidp->pid_id
 422 #define p_pid  p_pidp->pid_id
 423 #define p_slot p_pidp->pid_prslot
 424 #define p_detached p_pgidp->pid_pgorphaned
 425
 426 #define PID_HOLD(pidp)  ASSERT(MUTEX_HELD(&pidlock)); \
 427                         ++(pidp)->pid_ref;
 428 #define PID_RELE(pidp)  ASSERT(MUTEX_HELD(&pidlock)); \
 429                         (pidp)->pid_ref > 1 ? \
 430                                 --(pidp)->pid_ref : pid_rele(pidp);
 431
 432 /*
 433  * Structure containing persistent process lock.  The structure and
 434  * macro allow "mutex_enter(&p->p_lock)" to continue working.
 435  */
 436 struct plock {
 437         kmutex_t pl_lock;
 438 };
 439 #define p_lock  p_lockp->pl_lock
 440
 441 #ifdef _KERNEL
 442 extern proc_t p0;               /* process 0 */
 443 extern struct plock p0lock;     /* p0's plock */
 444 extern struct pid pid0;         /* p0's pid */
 445
 446 /* pid_allocate() flags */
 447 #define PID_ALLOC_PROC  0x0001  /* assign a /proc slot as well */
 448
 449 #endif /* _KERNEL */
 450
 451 /* stat codes */
 452
 453 #define SSLEEP  1               /* awaiting an event */
 454 #define SRUN    2               /* runnable */
 455 #define SZOMB   3               /* process terminated but not waited for */
 456 #define SSTOP   4               /* process stopped by debugger */
 457 #define SIDL    5               /* intermediate state in process creation */
 458 #define SONPROC 6               /* process is being run on a processor */
 459 #define SWAIT   7               /* process is waiting to become runnable */
 460
 461 /* p_pidflag codes */
 462 #define CLDPEND         0x0001  /* have yet to post a SIGCHLD to the parent */
 463 #define CLDCONT         0x0002  /* child has notified parent of CLD_CONTINUED */
 464 #define CLDNOSIGCHLD    0x0004  /* do not post SIGCHLD when child terminates */
 465 #define CLDWAITPID      0x0008  /* only waitid(P_PID, pid) can reap the child */
 466
 467 /* p_proc_flag codes -- these flags are mostly private to /proc */
 468 #define P_PR_TRACE      0x0001  /* signal, fault or syscall tracing via /proc */
 469 #define P_PR_PTRACE     0x0002  /* ptrace() compatibility mode */
 470 #define P_PR_FORK       0x0004  /* child inherits tracing flags */
 471 #define P_PR_LOCK       0x0008  /* process locked by /proc */
 472 #define P_PR_ASYNC      0x0010  /* asynchronous stopping via /proc */
 473 #define P_PR_EXEC       0x0020  /* process is in exec() */
 474 #define P_PR_BPTADJ     0x0040  /* adjust pc on breakpoint trap */
 475 #define P_PR_RUNLCL     0x0080  /* set process running on last /proc close */
 476 #define P_PR_KILLCL     0x0100  /* kill process on last /proc close */
 477
 478 /*
 479  * p_flag codes
 480  *
 481  * note that two of these flags, SMSACCT and SSYS, are exported to /proc's
 482  * psinfo_t.p_flag field.  Historically, all were, but since they are
 483  * implementation dependant, we only export the ones people have come to
 484  * rely upon.  Hence, the bit positions of SSYS and SMSACCT should not be
 485  * altered.
 486  */
 487 #define SSYS       0x00000001   /* system (resident) process */
 488 #define SEXITING   0x00000002   /* process is exiting */
 489 #define SITBUSY    0x00000004   /* setitimer(ITIMER_REAL) in progress */
 490 #define SFORKING   0x00000008   /* tells called functions that we're forking */
 491 #define SWATCHOK   0x00000010   /* proc in acceptable state for watchpoints */
 492 #define SKILLED    0x00000100   /* SIGKILL has been posted to the process */
 493 #define SSCONT     0x00000200   /* SIGCONT has been posted to the process */
 494 #define SZONETOP   0x00000400   /* process has no valid PPID in its zone */
 495 #define SEXTKILLED 0x00000800   /* SKILLED is from another contract */
 496 #define SUGID      0x00002000   /* process was result of set[ug]id exec */
 497 #define SEXECED    0x00004000   /* this process has execed */
 498 #define SJCTL      0x00010000   /* SIGCHLD sent when children stop/continue */
 499 #define SNOWAIT    0x00020000   /* children never become zombies */
 500 #define SVFORK     0x00040000   /* child of vfork that has not yet exec'd */
 501 #define SVFWAIT    0x00080000   /* parent of vfork waiting for child to exec */
 502 #define SEXITLWPS  0x00100000   /* have lwps exit within the process */
 503 #define SHOLDFORK  0x00200000   /* hold lwps where they're cloneable */
 504 #define SHOLDFORK1 0x00800000   /* hold lwps in place (not cloning) */
 505 #define SCOREDUMP  0x01000000   /* process is dumping core */
 506 #define SMSACCT    0x02000000   /* process is keeping micro-state accounting */
 507 #define SLWPWRAP   0x04000000   /* process has wrapped its lwp ids */
 508 #define SAUTOLPG   0x08000000   /* kernel controls page sizes */
 509 #define SNOCD      0x10000000   /* new creds from VSxID, do not coredump */
 510 #define SHOLDWATCH 0x20000000   /* hold lwps for watchpoint operation */
 511 #define SMSFORK    0x40000000   /* child inherits micro-state accounting */
 512 #define SDOCORE    0x80000000   /* process will attempt to dump core */
 513
 514 /*
 515  * p_poolflag codes
 516  *
 517  * These flags are used to synchronize with the pool subsystem to allow
 518  * re-binding of processes to new pools.
 519  */
 520 #define PBWAIT          0x0001  /* process should wait outside fork/exec/exit */
 521 #define PEXITED         0x0002  /* process exited and about to become zombie */
 522
 523 /* Macro to convert proc pointer to a user block pointer */
 524 #define PTOU(p)         (&(p)->p_user)
 525
 526 #define tracing(p, sig) (sigismember(&(p)->p_sigmask, sig))
 527
 528 /* Macro to reduce unnecessary calls to issig() */
 529
 530 #define ISSIG(t, why)   ISSIG_FAST(t, ttolwp(t), ttoproc(t), why)
 531
 532 /*
 533  * Fast version of ISSIG.
 534  *      1. uses register pointers to lwp and proc instead of reloading them.
 535  *      2. uses bit-wise OR of tests, since the usual case is that none of them
 536  *         are true, this saves orcc's and branches.
 537  *      3. load the signal flags instead of using sigisempty() macro which does
 538  *         a branch to convert to boolean.
 539  */
 540 #define ISSIG_FAST(t, lwp, p, why)              \
 541         (ISSIG_PENDING(t, lwp, p) && issig(why))
 542
 543 #define ISSIG_PENDING(t, lwp, p)                \
 544         ((lwp)->lwp_cursig |                    \
 545             sigcheck((p), (t)) |                \
 546             (p)->p_stopsig |                    \
 547             (t)->t_dtrace_stop |                \
 548             (t)->t_dtrace_sig |                 \
 549             ((t)->t_proc_flag & (TP_PRSTOP|TP_HOLDLWP|TP_CHKPT|TP_PAUSE)) | \
 550             ((p)->p_flag & (SEXITLWPS|SKILLED|SHOLDFORK1|SHOLDWATCH)))
 551
 552 #define ISSTOP(sig)      (u.u_signal[sig-1] == SIG_DFL && \
 553                                 sigismember(&stopdefault, sig))
 554
 555 #define ISHOLD(p)       ((p)->p_flag & SHOLDFORK)
 556
 557 #define MUSTRETURN(p, t)        (ISHOLD(p) | (t)->t_activefd.a_stale)
 558
 559 /*
 560  * Determine if there are any watchpoints active in the process.
 561  */
 562 #define pr_watch_active(p)      (avl_numnodes(&(p)->p_warea) != 0)
 563
 564 /* Reasons for calling issig() */
 565
 566 #define FORREAL         0       /* Usual side-effects */
 567 #define JUSTLOOKING     1       /* Don't stop the process */
 568
 569 /* 'what' values for stop(PR_SUSPENDED, what) */
 570 #define SUSPEND_NORMAL  0
 571 #define SUSPEND_PAUSE   1
 572
 573 /* pseudo-flag to lwp_create() */
 574 #define NOCLASS (-1)
 575
 576 /* unused scheduling class ID */
 577 #define CLASS_UNUSED    (-2)
 578
 579 /* LWP stats updated via lwp_stats_update() */
 580 typedef enum {
 581         LWP_STAT_INBLK,
 582         LWP_STAT_OUBLK,
 583         LWP_STAT_MSGRCV,
 584         LWP_STAT_MSGSND
 585 } lwp_stat_id_t;
 586
 587 typedef struct prkillinfo {
 588         int32_t prk_error;              /* errno */
 589         int32_t prk_pad;                /* pad */
 590         siginfo_t prk_info;             /* siginfo of killing signal */
 591 } prkillinfo_t;
 592
 593 #ifdef _KERNEL
 594
 595 /* user profiling functions */
 596
 597 extern void profil_tick(uintptr_t);
 598
 599 /* process management functions */
 600
 601 extern int newproc(void (*)(), caddr_t, id_t, int, struct contract **, pid_t);
 602 extern void vfwait(pid_t);
 603 extern void proc_detach(proc_t *);
 604 extern void freeproc(proc_t *);
 605 extern void setrun(kthread_t *);
 606 extern void setrun_locked(kthread_t *);
 607 extern void exit(int, int);
 608 extern int proc_exit(int, int);
 609 extern void proc_is_exiting(proc_t *);
 610 extern void relvm(void);
 611 extern void add_ns(proc_t *, proc_t *);
 612 extern void delete_ns(proc_t *, proc_t *);
 613 extern void upcount_inc(uid_t, zoneid_t);
 614 extern void upcount_dec(uid_t, zoneid_t);
 615 extern int upcount_get(uid_t, zoneid_t);
 616 #if defined(__x86)
 617 extern selector_t setup_thrptr(proc_t *, uintptr_t);
 618 extern void deferred_singlestep_trap(caddr_t);
 619 #endif
 620
 621 extern void sigcld(proc_t *, sigqueue_t *);
 622 extern void sigcld_delete(k_siginfo_t *);
 623 extern void sigcld_repost(void);
 624 extern int fsig(k_sigset_t *, kthread_t *);
 625 extern void psig(void);
 626 extern void stop(int, int);
 627 extern int stop_on_fault(uint_t, k_siginfo_t *);
 628 extern int issig(int);
 629 extern int jobstopped(proc_t *);
 630 extern void psignal(proc_t *, int);
 631 extern void tsignal(kthread_t *, int);
 632 extern void sigtoproc(proc_t *, kthread_t *, int);
 633 extern void trapsig(k_siginfo_t *, int);
 634 extern void realsigprof(int, int, int);
 635 extern int eat_signal(kthread_t *, int);
 636 extern int signal_is_blocked(kthread_t *, int);
 637 extern int sigcheck(proc_t *, kthread_t *);
 638 extern void sigdefault(proc_t *);
 639
 640 extern void pid_setmin(void);
 641 extern pid_t pid_allocate(proc_t *, pid_t, int);
 642 extern int pid_rele(struct pid *);
 643 extern void pid_exit(proc_t *, struct task *);
 644 extern void proc_entry_free(struct pid *);
 645 extern proc_t *prfind(pid_t);
 646 extern proc_t *prfind_zone(pid_t, zoneid_t);
 647 extern proc_t *pgfind(pid_t);
 648 extern proc_t *pgfind_zone(pid_t, zoneid_t);
 649 extern proc_t *sprlock(pid_t);
 650 extern proc_t *sprlock_zone(pid_t, zoneid_t);
 651 extern int sprtrylock_proc(proc_t *);
 652 extern void sprwaitlock_proc(proc_t *);
 653 extern void sprlock_proc(proc_t *);
 654 extern void sprunlock(proc_t *);
 655 extern void pid_init(void);
 656 extern proc_t *pid_entry(int);
 657 extern int pid_slot(proc_t *);
 658 extern void signal(pid_t, int);
 659 extern void prsignal(struct pid *, int);
 660 extern int uread(proc_t *, void *, size_t, uintptr_t);
 661 extern int uwrite(proc_t *, void *, size_t, uintptr_t);
 662
 663 extern void pgsignal(struct pid *, int);
 664 extern void pgjoin(proc_t *, struct pid *);
 665 extern void pgcreate(proc_t *);
 666 extern void pgexit(proc_t *);
 667 extern void pgdetach(proc_t *);
 668 extern int pgmembers(pid_t);
 669
 670 extern  void    init_mstate(kthread_t *, int);
 671 extern  int     new_mstate(kthread_t *, int);
 672 extern  void    restore_mstate(kthread_t *);
 673 extern  void    term_mstate(kthread_t *);
 674 extern  void    estimate_msacct(kthread_t *, hrtime_t);
 675 extern  void    disable_msacct(proc_t *);
 676 extern  hrtime_t mstate_aggr_state(proc_t *, int);
 677 extern  hrtime_t mstate_thread_onproc_time(kthread_t *);
 678 extern  void    mstate_systhread_times(kthread_t *, hrtime_t *, hrtime_t *);
 679 extern  void    syscall_mstate(int, int);
 680
 681 extern  uint_t  cpu_update_pct(kthread_t *, hrtime_t);
 682
 683 extern void     set_proc_pre_sys(proc_t *p);
 684 extern void     set_proc_post_sys(proc_t *p);
 685 extern void     set_proc_sys(proc_t *p);
 686 extern void     set_proc_ast(proc_t *p);
 687 extern void     set_all_proc_sys(void);
 688 extern void     set_all_zone_usr_proc_sys(zoneid_t);
 689
 690 /* thread function prototypes */
 691
 692 extern  kthread_t       *thread_create(
 693         caddr_t         stk,
 694         size_t          stksize,
 695         void            (*proc)(),
 696         void            *arg,
 697         size_t          len,
 698         proc_t          *pp,
 699         int             state,
 700         pri_t           pri);
 701 extern  void    thread_exit(void) __NORETURN;
 702 extern  void    thread_free(kthread_t *);
 703 extern  void    thread_rele(kthread_t *);
 704 extern  void    thread_join(kt_did_t);
 705 extern  int     reaper(void);
 706 extern  void    installctx(kthread_t *, void *, void (*)(), void (*)(),
 707     void (*)(), void (*)(), void (*)(), void (*)());
 708 extern  int     removectx(kthread_t *, void *, void (*)(), void (*)(),
 709     void (*)(), void (*)(), void (*)(), void (*)());
 710 extern  void    savectx(kthread_t *);
 711 extern  void    restorectx(kthread_t *);
 712 extern  void    forkctx(kthread_t *, kthread_t *);
 713 extern  void    lwp_createctx(kthread_t *, kthread_t *);
 714 extern  void    exitctx(kthread_t *);
 715 extern  void    freectx(kthread_t *, int);
 716 extern  void    installpctx(proc_t *, void *, void (*)(), void (*)(),
 717     void (*)(), void (*)(), void (*)());
 718 extern  int     removepctx(proc_t *, void *, void (*)(), void (*)(),
 719     void (*)(), void (*)(), void (*)());
 720 extern  void    savepctx(proc_t *);
 721 extern  void    restorepctx(proc_t *);
 722 extern  void    forkpctx(proc_t *, proc_t *);
 723 extern  void    exitpctx(proc_t *);
 724 extern  void    freepctx(proc_t *, int);
 725 extern  kthread_t *thread_unpin(void);
 726 extern  void    thread_init(void);
 727 extern  void    thread_load(kthread_t *, void (*)(), caddr_t, size_t);
 728
 729 extern  void    tsd_create(uint_t *, void (*)(void *));
 730 extern  void    tsd_destroy(uint_t *);
 731 extern  void    *tsd_getcreate(uint_t *, void (*)(void *), void *(*)(void));
 732 extern  void    *tsd_get(uint_t);
 733 extern  int     tsd_set(uint_t, void *);
 734 extern  void    tsd_exit(void);
 735 extern  void    *tsd_agent_get(kthread_t *, uint_t);
 736 extern  int     tsd_agent_set(kthread_t *, uint_t, void *);
 737
 738 /* lwp function prototypes */
 739
 740 extern kthread_t *lwp_kernel_create(proc_t *, void (*)(), void *, int, pri_t);
 741 extern  klwp_t          *lwp_create(
 742         void            (*proc)(),
 743         caddr_t         arg,
 744         size_t          len,
 745         proc_t          *p,
 746         int             state,
 747         int             pri,
 748         const k_sigset_t *smask,
 749         int             cid,
 750         id_t            lwpid);
 751 extern  kthread_t *idtot(proc_t *, id_t);
 752 extern  void    lwp_hash_in(proc_t *, lwpent_t *, tidhash_t *, uint_t, int);
 753 extern  void    lwp_hash_out(proc_t *, id_t);
 754 extern  lwpdir_t *lwp_hash_lookup(proc_t *, id_t);
 755 extern  lwpdir_t *lwp_hash_lookup_and_lock(proc_t *, id_t, kmutex_t **);
 756 extern  void    lwp_create_done(kthread_t *);
 757 extern  void    lwp_exit(void);
 758 extern  void    lwp_pcb_exit(void);
 759 extern  void    lwp_cleanup(void);
 760 extern  int     lwp_suspend(kthread_t *);
 761 extern  void    lwp_continue(kthread_t *);
 762 extern  void    holdlwp(void);
 763 extern  void    stoplwp(void);
 764 extern  int     holdlwps(int);
 765 extern  int     holdwatch(void);
 766 extern  void    pokelwps(proc_t *);
 767 extern  void    continuelwps(proc_t *);
 768 extern  int     exitlwps(int);
 769 extern  void    lwp_ctmpl_copy(klwp_t *, klwp_t *);
 770 extern  void    lwp_ctmpl_clear(klwp_t *);
 771 extern  klwp_t  *forklwp(klwp_t *, proc_t *, id_t);
 772 extern  void    lwp_load(klwp_t *, gregset_t, uintptr_t);
 773 extern  void    lwp_setrval(klwp_t *, int, int);
 774 extern  void    lwp_forkregs(klwp_t *, klwp_t *);
 775 extern  void    lwp_freeregs(klwp_t *, int);
 776 extern  caddr_t lwp_stk_init(klwp_t *, caddr_t);
 777 extern  void    lwp_stk_cache_init(void);
 778 extern  void    lwp_stk_fini(klwp_t *);
 779 extern  void    lwp_fp_init(klwp_t *);
 780 extern  void    lwp_installctx(klwp_t *);
 781 extern  void    lwp_rtt(void);
 782 extern  void    lwp_rtt_initial(void);
 783 extern  int     lwp_setprivate(klwp_t *, int, uintptr_t);
 784 extern  void    lwp_stat_update(lwp_stat_id_t, long);
 785 extern  void    lwp_attach_brand_hdlrs(klwp_t *);
 786 extern  void    lwp_detach_brand_hdlrs(klwp_t *);
 787
 788 #if defined(__sparcv9)
 789 extern  void    lwp_mmodel_newlwp(void);
 790 extern  void    lwp_mmodel_shared_as(caddr_t, size_t);
 791 #define LWP_MMODEL_NEWLWP()             lwp_mmodel_newlwp()
 792 #define LWP_MMODEL_SHARED_AS(addr, sz)  lwp_mmodel_shared_as((addr), (sz))
 793 #else
 794 #define LWP_MMODEL_NEWLWP()
 795 #define LWP_MMODEL_SHARED_AS(addr, sz)
 796 #endif
 797
 798 /*
 799  * Signal queue function prototypes. Must be here due to header ordering
 800  * dependencies.
 801  */
 802 extern void sigqfree(proc_t *);
 803 extern void siginfofree(sigqueue_t *);
 804 extern void sigdeq(proc_t *, kthread_t *, int, sigqueue_t **);
 805 extern void sigdelq(proc_t *, kthread_t *, int);
 806 extern void sigaddq(proc_t *, kthread_t *, k_siginfo_t *, int);
 807 extern void sigaddqa(proc_t *, kthread_t *, sigqueue_t *);
 808 extern void sigqsend(int, proc_t *, kthread_t *, sigqueue_t *);
 809 extern void sigdupq(proc_t *, proc_t *);
 810 extern int sigwillqueue(int, int);
 811 extern sigqhdr_t *sigqhdralloc(size_t, uint_t);
 812 extern sigqueue_t *sigqalloc(sigqhdr_t *);
 813 extern void sigqhdrfree(sigqhdr_t *);
 814 extern sigqueue_t *sigappend(k_sigset_t *, sigqueue_t *,
 815         k_sigset_t *, sigqueue_t *);
 816 extern sigqueue_t *sigprepend(k_sigset_t *, sigqueue_t *,
 817         k_sigset_t *, sigqueue_t *);
 818 extern void winfo(proc_t *, k_siginfo_t *, int);
 819 extern int wstat(int, int);
 820 extern int sendsig(int, k_siginfo_t *, void (*)());
 821 #if defined(_SYSCALL32_IMPL)
 822 extern int sendsig32(int, k_siginfo_t *, void (*)());
 823 #endif
 824
 825 #endif  /* _KERNEL */
 826
 827 #ifdef  __cplusplus
 828 }
 829 #endif
 830
 831 #endif  /* _SYS_PROC_H */