1/* 2 * Copyright (c) 2000-2010 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */ 29/*- 30 * Copyright (c) 1986, 1989, 1991, 1993 31 * The Regents of the University of California. All rights reserved. 32 * (c) UNIX System Laboratories, Inc. 33 * All or some portions of this file are derived from material licensed 34 * to the University of California by American Telephone and Telegraph 35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 36 * the permission of UNIX System Laboratories, Inc. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. All advertising materials mentioning features or use of this software 47 * must display the following acknowledgement: 48 * This product includes software developed by the University of 49 * California, Berkeley and its contributors. 50 * 4. Neither the name of the University nor the names of its contributors 51 * may be used to endorse or promote products derived from this software 52 * without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 64 * SUCH DAMAGE. 65 * 66 * @(#)proc_internal.h 8.15 (Berkeley) 5/19/95 67 */ 68/* 69 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce 70 * support for mandatory and extensible security protections. This notice 71 * is included in support of clause 2.2 (b) of the Apple Public License, 72 * Version 2.0. 73 */ 74 75#ifndef _SYS_PROC_INTERNAL_H_ 76#define _SYS_PROC_INTERNAL_H_ 77 78#include <libkern/OSAtomic.h> 79#include <sys/proc.h> 80__BEGIN_DECLS 81#include <kern/locks.h> 82#if PSYNCH 83#include <kern/thread_call.h> 84#endif /* PSYNCH */ 85__END_DECLS 86 87#if DEBUG 88#define __PROC_INTERNAL_DEBUG 1 89#endif 90 91/* 92 * The short form for various locks that protect fields in the data structures. 93 * PL = Process Lock 94 * PGL = Process Group Lock 95 * PFDL = Process File Desc Lock 96 * PSL = Process Spin Lock 97 * PPL = Parent Process Lock (planed for later usage) 98 * LL = List Lock 99 * SL = Session Lock 100*/ 101struct label; 102 103/* 104 * Added by SPARTA, Inc. 105 */ 106/* 107 * Login context. 108 */ 109struct lctx { 110 LIST_ENTRY(lctx) lc_list; /* List of all login contexts. */ 111 LIST_HEAD(, proc) lc_members; /* Pointer to lc members. */ 112 int lc_mc; /* Member Count. */ 113 pid_t lc_id; /* Login context ID. */ 114 lck_mtx_t lc_mtx; /* Mutex to protect members */ 115 116 struct label *lc_label; /* Login context MAC label. */ 117}; 118 119/* 120 * One structure allocated per session. 121 */ 122struct session { 123 int s_count; /* Ref cnt; pgrps in session. (LL) */ 124 struct proc * s_leader; /* Session leader.(static) */ 125 struct vnode * s_ttyvp; /* Vnode of controlling terminal.(SL) */ 126 int s_ttyvid; /* Vnode id of the controlling terminal (SL) */ 127 struct tty * s_ttyp; /* Controlling terminal. (SL + ttyvp != NULL) */ 128 pid_t s_ttypgrpid; /* tty's pgrp id */ 129 pid_t s_sid; /* Session ID (static) */ 130 char s_login[MAXLOGNAME]; /* Setlogin() name.(SL) */ 131 int s_flags; /* Session flags (s_mlock) */ 132 LIST_ENTRY(session) s_hash; /* Hash chain.(LL) */ 133 lck_mtx_t s_mlock; /* mutex lock to protect session */ 134 int s_listflags; 135}; 136 137#define SESSION_NULL (struct session *)0 138 139/* 140 * accessor for s_ttyp which treats it as invalid if s_ttyvp is not valid; 141 * note that s_ttyp is not a reference in the session structre, so it can 142 * become invalid out from under the session if the device is closed, without 143 * this protection. We can't safely make it into a reference without reflexive 144 * close notification of tty devices through cdevsw[]. 145 * 146 * NB: <sys/tty.h> is not in scope and there is not typedef type enforcement, 147 * or '0' below would be 'TTY_NULL'. 148 */ 149#define SESSION_TP(sp) (((sp)->s_ttyvp != 0) ? (sp)->s_ttyp : 0) 150 151/* 152 * Session flags; used to tunnel information to lower layers and line 153 * disciplines, etc. 154 */ 155#define S_DEFAULT 0x00000000 /* No flags set */ 156#define S_NOCTTY 0x00000001 /* Do not associate controlling tty */ 157#define S_CTTYREF 0x00000010 /* vnode ref taken by cttyopen */ 158 159 160#define S_LIST_TERM 1 /* marked for termination */ 161#define S_LIST_DEAD 2 /* already dead */ 162/* 163 * One structure allocated per process group. 164 */ 165struct pgrp { 166 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. (LL) */ 167 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. (PGL) */ 168 struct session * pg_session; /* Pointer to session. (LL ) */ 169 pid_t pg_id; /* Pgrp id. (static) */ 170 int pg_jobc; /* # procs qualifying pgrp for job control (PGL) */ 171 int pg_membercnt; /* Number of processes in the pgrocess group (PGL) */ 172 int pg_refcount; /* number of current iterators (LL) */ 173 unsigned int pg_listflags; /* (LL) */ 174 lck_mtx_t pg_mlock; /* mutex lock to protect pgrp */ 175}; 176 177#define PGRP_FLAG_TERMINATE 1 178#define PGRP_FLAG_WAITTERMINATE 2 179#define PGRP_FLAG_DEAD 4 180#define PGRP_FLAG_ITERABEGIN 8 181#define PGRP_FLAG_ITERWAIT 0x10 182 183#define PGRP_NULL (struct pgrp *)0 184struct proc; 185 186#define PROC_NULL (struct proc *)0 187 188#define PROC_UPDATE_CREDS_ONPROC(p) { \ 189 p->p_uid = kauth_cred_getuid(p->p_ucred); \ 190 p->p_gid = kauth_cred_getgid(p->p_ucred); \ 191 p->p_ruid = kauth_cred_getruid(p->p_ucred); \ 192 p->p_rgid = kauth_cred_getrgid(p->p_ucred); \ 193 p->p_svuid = kauth_cred_getsvuid(p->p_ucred); \ 194 p->p_svgid = kauth_cred_getsvgid(p->p_ucred); \ 195 } 196/* 197 * Description of a process. 198 * 199 * This structure contains the information needed to manage a thread of 200 * control, known in UN*X as a process; it has references to substructures 201 * containing descriptions of things that the process uses, but may share 202 * with related processes. The process structure and the substructures 203 * are always addressible except for those marked "(PROC ONLY)" below, 204 * which might be addressible only on a processor on which the process 205 * is running. 206 */ 207struct proc { 208 LIST_ENTRY(proc) p_list; /* List of all processes. */ 209 210 pid_t p_pid; /* Process identifier. (static)*/ 211 void * task; /* corresponding task (static)*/ 212 struct proc * p_pptr; /* Pointer to parent process.(LL) */ 213 pid_t p_ppid; /* process's parent pid number */ 214 pid_t p_pgrpid; /* process group id of the process (LL)*/ 215 uid_t p_uid; 216 gid_t p_gid; 217 uid_t p_ruid; 218 gid_t p_rgid; 219 uid_t p_svuid; 220 gid_t p_svgid; 221 uint64_t p_uniqueid; /* process unique ID - incremented on fork/spawn/vfork, remains same across exec. */ 222 uint64_t p_puniqueid; /* parent's unique ID - set on fork/spawn/vfork, doesn't change if reparented. */ 223 224 lck_mtx_t p_mlock; /* mutex lock for proc */ 225 226 char p_stat; /* S* process status. (PL)*/ 227 char p_shutdownstate; 228 char p_kdebug; /* P_KDEBUG eq (CC)*/ 229 char p_btrace; /* P_BTRACE eq (CC)*/ 230 231 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp.(PGL) */ 232 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. (LL)*/ 233 LIST_HEAD(, proc) p_children; /* Pointer to list of children. (LL)*/ 234 TAILQ_HEAD( , uthread) p_uthlist; /* List of uthreads (PL) */ 235 236 LIST_ENTRY(proc) p_hash; /* Hash chain. (LL)*/ 237 TAILQ_HEAD( ,eventqelt) p_evlist; /* (PL) */ 238 239 lck_mtx_t p_fdmlock; /* proc lock to protect fdesc */ 240 241 /* substructures: */ 242 kauth_cred_t p_ucred; /* Process owner's identity. (PL) */ 243 struct filedesc *p_fd; /* Ptr to open files structure. (PFDL) */ 244 struct pstats *p_stats; /* Accounting/statistics (PL). */ 245 struct plimit *p_limit; /* Process limits.(PL) */ 246 247 struct sigacts *p_sigacts; /* Signal actions, state (PL) */ 248 int p_siglist; /* signals captured back from threads */ 249 lck_spin_t p_slock; /* spin lock for itimer/profil protection */ 250 251#define p_rlimit p_limit->pl_rlimit 252 253 struct plimit *p_olimit; /* old process limits - not inherited by child (PL) */ 254 unsigned int p_flag; /* P_* flags. (atomic bit ops) */ 255 unsigned int p_lflag; /* local flags (PL) */ 256 unsigned int p_listflag; /* list flags (LL) */ 257 unsigned int p_ladvflag; /* local adv flags (atomic) */ 258 int p_refcount; /* number of outstanding users(LL) */ 259 int p_childrencnt; /* children holding ref on parent (LL) */ 260 int p_parentref; /* children lookup ref on parent (LL) */ 261 262 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 263 u_int p_xstat; /* Exit status for wait; also stop signal. */ 264 265#ifdef _PROC_HAS_SCHEDINFO_ 266 /* may need cleanup, not used */ 267 u_int p_estcpu; /* Time averaged value of p_cpticks.(used by aio and proc_comapre) */ 268 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime (used by aio)*/ 269 u_int p_slptime; /* used by proc_compare */ 270#endif /* _PROC_HAS_SCHEDINFO_ */ 271 272 struct itimerval p_realtimer; /* Alarm timer. (PSL) */ 273 struct timeval p_rtime; /* Real time.(PSL) */ 274 struct itimerval p_vtimer_user; /* Virtual timers.(PSL) */ 275 struct itimerval p_vtimer_prof; /* (PSL) */ 276 277 struct timeval p_rlim_cpu; /* Remaining rlim cpu value.(PSL) */ 278 int p_debugger; /* NU 1: can exec set-bit programs if suser */ 279 boolean_t sigwait; /* indication to suspend (PL) */ 280 void *sigwait_thread; /* 'thread' holding sigwait(PL) */ 281 void *exit_thread; /* Which thread is exiting(PL) */ 282 int p_vforkcnt; /* number of outstanding vforks(PL) */ 283 void * p_vforkact; /* activation running this vfork proc)(static) */ 284 int p_fpdrainwait; /* (PFDL) */ 285 pid_t p_contproc; /* last PID to send us a SIGCONT (PL) */ 286 287 /* Following fields are info from SIGCHLD (PL) */ 288 pid_t si_pid; /* (PL) */ 289 u_int si_status; /* (PL) */ 290 u_int si_code; /* (PL) */ 291 uid_t si_uid; /* (PL) */ 292 293 void * vm_shm; /* (SYSV SHM Lock) for sysV shared memory */ 294 295#if CONFIG_DTRACE 296 user_addr_t p_dtrace_argv; /* (write once, read only after that) */ 297 user_addr_t p_dtrace_envp; /* (write once, read only after that) */ 298 lck_mtx_t p_dtrace_sprlock; /* sun proc lock emulation */ 299 int p_dtrace_probes; /* (PL) are there probes for this proc? */ 300 u_int p_dtrace_count; /* (sprlock) number of DTrace tracepoints */ 301 uint8_t p_dtrace_stop; /* indicates a DTrace-desired stop */ 302 struct dtrace_ptss_page* p_dtrace_ptss_pages; /* (sprlock) list of user ptss pages */ 303 struct dtrace_ptss_page_entry* p_dtrace_ptss_free_list; /* (atomic) list of individual ptss entries */ 304 struct dtrace_helpers* p_dtrace_helpers; /* (dtrace_lock) DTrace per-proc private */ 305 struct dof_ioctl_data* p_dtrace_lazy_dofs; /* (sprlock) unloaded dof_helper_t's */ 306#endif /* CONFIG_DTRACE */ 307 308/* XXXXXXXXXXXXX BCOPY'ed on fork XXXXXXXXXXXXXXXX */ 309/* The following fields are all copied upon creation in fork. */ 310#define p_startcopy p_argslen 311 312 u_int p_argslen; /* Length of process arguments. */ 313 int p_argc; /* saved argc for sysctl_procargs() */ 314 user_addr_t user_stack; /* where user stack was allocated */ 315 struct vnode *p_textvp; /* Vnode of executable. */ 316 off_t p_textoff; /* offset in executable vnode */ 317 318 sigset_t p_sigmask; /* DEPRECATED */ 319 sigset_t p_sigignore; /* Signals being ignored. (PL) */ 320 sigset_t p_sigcatch; /* Signals being caught by user.(PL) */ 321 322 u_char p_priority; /* (NU) Process priority. */ 323 u_char p_resv0; /* (NU) User-priority based on p_cpu and p_nice. */ 324 char p_nice; /* Process "nice" value.(PL) */ 325 u_char p_resv1; /* (NU) User-priority based on p_cpu and p_nice. */ 326 327#if CONFIG_MACF 328 int p_mac_enforce; /* MAC policy enforcement control */ 329#endif 330 331 char p_comm[MAXCOMLEN+1]; 332 char p_name[(2*MAXCOMLEN)+1]; /* PL */ 333 334 struct pgrp *p_pgrp; /* Pointer to process group. (LL) */ 335 uint32_t p_csflags; /* flags for codesign (PL) */ 336 uint32_t p_pcaction; /* action for process control on starvation */ 337 uint8_t p_uuid[16]; /* from LC_UUID load command */ 338 339/* End area that is copied on creation. */ 340/* XXXXXXXXXXXXX End of BCOPY'ed on fork (AIOLOCK)XXXXXXXXXXXXXXXX */ 341#define p_endcopy p_aio_total_count 342 int p_aio_total_count; /* all allocated AIO requests for this proc */ 343 int p_aio_active_count; /* all unfinished AIO requests for this proc */ 344 TAILQ_HEAD( , aio_workq_entry ) p_aio_activeq; /* active async IO requests */ 345 TAILQ_HEAD( , aio_workq_entry ) p_aio_doneq; /* completed async IO requests */ 346 347 struct klist p_klist; /* knote list (PL ?)*/ 348 349 struct rusage_superset *p_ru; /* Exit information. (PL) */ 350 int p_sigwaitcnt; 351 thread_t p_signalholder; 352 thread_t p_transholder; 353 354 /* DEPRECATE following field */ 355 u_short p_acflag; /* Accounting flags. */ 356 volatile u_short p_vfs_iopolicy; /* VFS iopolicy flags. */ 357 358 struct lctx *p_lctx; /* Pointer to login context. */ 359 LIST_ENTRY(proc) p_lclist; /* List of processes in lctx. */ 360 user_addr_t p_threadstart; /* pthread start fn */ 361 user_addr_t p_wqthread; /* pthread workqueue fn */ 362 int p_pthsize; /* pthread size */ 363 user_addr_t p_targconc; /* target concurrency ptr */ 364 void * p_wqptr; /* workq ptr */ 365 int p_wqsize; /* allocated size */ 366 boolean_t p_wqiniting; /* semaphore to serialze wq_open */ 367 lck_spin_t p_wqlock; /* lock to protect work queue */ 368 struct timeval p_start; /* starting time */ 369 void * p_rcall; 370 int p_ractive; 371 int p_idversion; /* version of process identity */ 372 void * p_pthhash; /* pthread waitqueue hash */ 373 volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */ 374 volatile uint64_t did_throttle __attribute__((aligned(8))); /* Counter for number of I/Os this proc throttled */ 375 376#if DIAGNOSTIC 377 unsigned int p_fdlock_pc[4]; 378 unsigned int p_fdunlock_pc[4]; 379#if SIGNAL_DEBUG 380 unsigned int lockpc[8]; 381 unsigned int unlockpc[8]; 382#endif /* SIGNAL_DEBUG */ 383#endif /* DIAGNOSTIC */ 384 uint64_t p_dispatchqueue_offset; 385 uint64_t p_dispatchqueue_serialno_offset; 386#if VM_PRESSURE_EVENTS 387 struct timeval vm_pressure_last_notify_tstamp; 388#endif 389 390#if CONFIG_MEMORYSTATUS 391 /* Fields protected by proc list lock */ 392 TAILQ_ENTRY(proc) p_memstat_list; /* priority bucket link */ 393 uint32_t p_memstat_state; /* state */ 394 int32_t p_memstat_effectivepriority; /* priority after transaction state accounted for */ 395 int32_t p_memstat_requestedpriority; /* active priority */ 396 uint64_t p_memstat_userdata; /* user state */ 397 uint32_t p_memstat_dirty; /* dirty state */ 398 uint64_t p_memstat_idledeadline; /* time at which process became clean */ 399#if CONFIG_JETSAM 400 int32_t p_memstat_memlimit; /* cached memory limit */ 401#endif 402#if CONFIG_FREEZE 403 uint32_t p_memstat_suspendedfootprint; /* footprint at time of suspensions */ 404#endif /* CONFIG_FREEZE */ 405#endif /* CONFIG_MEMORYSTATUS */ 406}; 407 408#define PGRPID_DEAD 0xdeaddead 409 410/* p_listflag */ 411#define P_LIST_DRAIN 0x00000001 412#define P_LIST_DRAINWAIT 0x00000002 413#define P_LIST_DRAINED 0x00000004 414#define P_LIST_DEAD 0x00000008 415#define P_LIST_WAITING 0x00000010 416#define P_LIST_EXITED 0x00000040 417#define P_LIST_CHILDDRSTART 0x00000080 418#define P_LIST_CHILDDRAINED 0x00000100 419#define P_LIST_CHILDDRWAIT 0x00000200 420#define P_LIST_CHILDLKWAIT 0x00000400 421#define P_LIST_DEADPARENT 0x00000800 422#define P_LIST_PARENTREFWAIT 0x00001000 423#define P_LIST_INCREATE 0x00002000 424/* 0x4000 & 0x8000 Not used */ 425#define P_LIST_INHASH 0x00010000 /* process is in hash */ 426#define P_LIST_INPGRP 0x00020000 /* process is in pgrp */ 427#define P_LIST_PGRPTRANS 0x00040000 /* pgrp is getting replaced */ 428#define P_LIST_PGRPTRWAIT 0x00080000 /* wait for pgrp replacement */ 429#define P_LIST_EXITCOUNT 0x00100000 /* counted for process exit */ 430 431 432/* local flags */ 433#define P_LDELAYTERM 0x00000001 /* */ 434#define P_LNOZOMB 0x00000002 /* */ 435#define P_LTERM 0x00000004 /* */ 436#define P_LEXIT 0x00000008 /* */ 437#define P_LPEXIT 0x00000010 438#define P_LTRANSCOMMIT 0x00000020 /* process is committed to trans */ 439#define P_LINTRANSIT 0x00000040 /* process in exec or in creation */ 440#define P_LTRANSWAIT 0x00000080 /* waiting for trans to complete */ 441#define P_LVFORK 0x00000100 /* parent proc of a vfork */ 442#define P_LINVFORK 0x00000200 /* child proc of a vfork */ 443#define P_LTRACED 0x00000400 /* */ 444#define P_LSIGEXC 0x00000800 /* */ 445#define P_LNOATTACH 0x00001000 /* */ 446#define P_LPPWAIT 0x00002000 /* */ 447#define P_LKQWDRAIN 0x00004000 448#define P_LKQWDRAINWAIT 0x00008000 449#define P_LKQWDEAD 0x00010000 450#define P_LLIMCHANGE 0x00020000 451#define P_LLIMWAIT 0x00040000 452#define P_LWAITED 0x00080000 453#define P_LINSIGNAL 0x00100000 454#define P_UNUSED 0x00200000 /* Unused */ 455#define P_LRAGE_VNODES 0x00400000 456#define P_LREGISTER 0x00800000 /* thread start fns registered */ 457#define P_LVMRSRCOWNER 0x01000000 /* can handle the resource ownership of */ 458/* old P_LPTERMINATE 0x02000000 */ 459#define P_LTERM_DECRYPTFAIL 0x04000000 /* process terminating due to key failure to decrypt */ 460#define P_LTERM_JETSAM 0x08000000 /* process is being jetsam'd */ 461#define P_JETSAM_VMPAGESHORTAGE 0x00000000 /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */ 462#define P_JETSAM_VMTHRASHING 0x10000000 /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */ 463#define P_JETSAM_HIWAT 0x20000000 /* jetsam: high water mark */ 464#define P_JETSAM_PID 0x30000000 /* jetsam: pid */ 465#define P_JETSAM_IDLEEXIT 0x40000000 /* jetsam: idle exit */ 466#define P_JETSAM_VNODE 0x50000000 /* jetsam: vnode kill */ 467#define P_JETSAM_MASK 0x70000000 /* jetsam type mask */ 468 469/* Process control state for resource starvation */ 470#define P_PCTHROTTLE 1 471#define P_PCSUSP 2 472#define P_PCKILL 3 473#define P_PCMAX 3 474 475/* Process control action state on resrouce starvation */ 476#define PROC_ACTION_MASK 0xffff0000; 477#define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX) 478#define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX) 479#define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16))) 480#define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p)) 481 482/* additional process flags */ 483#define P_LADVLOCK 0x01 484 485/* p_vfs_iopolicy flags */ 486#define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY 0x0001 487 488/* defns for proc_iterate */ 489#define PROC_ALLPROCLIST 1 /* walk the allproc list (procs not exited yet) */ 490#define PROC_ZOMBPROCLIST 2 /* walk the zombie list */ 491#define PROC_NOWAITTRANS 4 /* do not wait for transitions (checkdirs only) */ 492 493/* defns for pgrp_iterate */ 494#define PGRP_DROPREF 1 495#define PGRP_BLOCKITERATE 2 496 497/* return values of the proc iteration callback routine */ 498#define PROC_RETURNED 0 499#define PROC_RETURNED_DONE 1 500#define PROC_CLAIMED 2 501#define PROC_CLAIMED_DONE 3 502 503/* process creation arguments */ 504#define PROC_CREATE_FORK 0 /* independent child (running) */ 505#define PROC_CREATE_SPAWN 1 /* independent child (suspended) */ 506#define PROC_CREATE_VFORK 2 /* child borrows context */ 507 508 509/* LP64 version of extern_proc. all pointers 510 * grow when we're dealing with a 64-bit process. 511 * WARNING - keep in sync with extern_proc 512 * but use native alignment of 64-bit process. 513 */ 514 515#ifdef KERNEL 516#include <sys/time.h> /* user_timeval, user_itimerval */ 517 518#pragma pack(4) 519struct user32_extern_proc { 520 union { 521 struct { 522 uint32_t __p_forw; /* Doubly-linked run/sleep queue. */ 523 uint32_t __p_back; 524 } p_st1; 525 struct user32_timeval __p_starttime; /* process start time */ 526 } p_un; 527 uint32_t p_vmspace; /* Address space. */ 528 uint32_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 529 int p_flag; /* P_* flags. */ 530 char p_stat; /* S* process status. */ 531 pid_t p_pid; /* Process identifier. */ 532 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 533 int p_dupfd; /* Sideways return value from fdopen. XXX */ 534 /* Mach related */ 535 uint32_t user_stack; /* where user stack was allocated */ 536 uint32_t exit_thread; /* XXX Which thread is exiting? */ 537 int p_debugger; /* allow to debug */ 538 boolean_t sigwait; /* indication to suspend */ 539 /* scheduling */ 540 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 541 int p_cpticks; /* Ticks of cpu time. */ 542 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 543 uint32_t p_wchan; /* Sleep address. */ 544 uint32_t p_wmesg; /* Reason for sleep. */ 545 u_int p_swtime; /* Time swapped in or out. */ 546 u_int p_slptime; /* Time since last blocked. */ 547 struct user32_itimerval p_realtimer; /* Alarm timer. */ 548 struct user32_timeval p_rtime; /* Real time. */ 549 u_quad_t p_uticks; /* Statclock hits in user mode. */ 550 u_quad_t p_sticks; /* Statclock hits in system mode. */ 551 u_quad_t p_iticks; /* Statclock hits processing intr. */ 552 int p_traceflag; /* Kernel trace points. */ 553 uint32_t p_tracep; /* Trace to vnode. */ 554 int p_siglist; /* DEPRECATED */ 555 uint32_t p_textvp; /* Vnode of executable. */ 556 int p_holdcnt; /* If non-zero, don't swap. */ 557 sigset_t p_sigmask; /* DEPRECATED. */ 558 sigset_t p_sigignore; /* Signals being ignored. */ 559 sigset_t p_sigcatch; /* Signals being caught by user. */ 560 u_char p_priority; /* Process priority. */ 561 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 562 char p_nice; /* Process "nice" value. */ 563 char p_comm[MAXCOMLEN+1]; 564 uint32_t p_pgrp; /* Pointer to process group. */ 565 uint32_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 566 u_short p_xstat; /* Exit status for wait; also stop signal. */ 567 u_short p_acflag; /* Accounting flags. */ 568 uint32_t p_ru; /* Exit information. XXX */ 569}; 570#pragma pack() 571struct user64_extern_proc { 572 union { 573 struct { 574 user_addr_t __p_forw; /* Doubly-linked run/sleep queue. */ 575 user_addr_t __p_back; 576 } p_st1; 577 struct user64_timeval __p_starttime; /* process start time */ 578 } p_un; 579 user_addr_t p_vmspace; /* Address space. */ 580 user_addr_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 581 int p_flag; /* P_* flags. */ 582 char p_stat; /* S* process status. */ 583 pid_t p_pid; /* Process identifier. */ 584 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 585 int p_dupfd; /* Sideways return value from fdopen. XXX */ 586 /* Mach related */ 587 user_addr_t user_stack __attribute((aligned(8))); /* where user stack was allocated */ 588 user_addr_t exit_thread; /* XXX Which thread is exiting? */ 589 int p_debugger; /* allow to debug */ 590 boolean_t sigwait; /* indication to suspend */ 591 /* scheduling */ 592 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 593 int p_cpticks; /* Ticks of cpu time. */ 594 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 595 user_addr_t p_wchan __attribute((aligned(8))); /* Sleep address. */ 596 user_addr_t p_wmesg; /* Reason for sleep. */ 597 u_int p_swtime; /* Time swapped in or out. */ 598 u_int p_slptime; /* Time since last blocked. */ 599 struct user64_itimerval p_realtimer; /* Alarm timer. */ 600 struct user64_timeval p_rtime; /* Real time. */ 601 u_quad_t p_uticks; /* Statclock hits in user mode. */ 602 u_quad_t p_sticks; /* Statclock hits in system mode. */ 603 u_quad_t p_iticks; /* Statclock hits processing intr. */ 604 int p_traceflag; /* Kernel trace points. */ 605 user_addr_t p_tracep __attribute((aligned(8))); /* Trace to vnode. */ 606 int p_siglist; /* DEPRECATED */ 607 user_addr_t p_textvp __attribute((aligned(8))); /* Vnode of executable. */ 608 int p_holdcnt; /* If non-zero, don't swap. */ 609 sigset_t p_sigmask; /* DEPRECATED. */ 610 sigset_t p_sigignore; /* Signals being ignored. */ 611 sigset_t p_sigcatch; /* Signals being caught by user. */ 612 u_char p_priority; /* Process priority. */ 613 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 614 char p_nice; /* Process "nice" value. */ 615 char p_comm[MAXCOMLEN+1]; 616 user_addr_t p_pgrp __attribute((aligned(8))); /* Pointer to process group. */ 617 user_addr_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 618 u_short p_xstat; /* Exit status for wait; also stop signal. */ 619 u_short p_acflag; /* Accounting flags. */ 620 user_addr_t p_ru __attribute((aligned(8))); /* Exit information. XXX */ 621}; 622#endif /* KERNEL */ 623 624/* 625 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 626 * as it is used to represent "no process group". 627 */ 628extern int nprocs, maxproc; /* Current and max number of procs. */ 629extern int maxprocperuid; /* Current number of procs per uid */ 630extern int hard_maxproc; /* hard limit */ 631extern unsigned int proc_shutdown_exitcount; 632 633#define PID_MAX 99999 634#define NO_PID 100000 635extern lck_mtx_t * proc_list_mlock; 636extern lck_mtx_t * proc_klist_mlock; 637 638#define BSD_SIMUL_EXECS 33 /* 32 , allow for rounding */ 639#define BSD_PAGEABLE_SIZE_PER_EXEC (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */ 640extern int execargs_cache_size; 641extern int execargs_free_count; 642extern vm_offset_t * execargs_cache; 643 644#define SESS_LEADER(p, sessp) ((sessp)->s_leader == (p)) 645 646/* Lock and unlock a login context. */ 647#define LCTX_LOCK(lc) lck_mtx_lock(&(lc)->lc_mtx) 648#define LCTX_UNLOCK(lc) lck_mtx_unlock(&(lc)->lc_mtx) 649#define LCTX_LOCKED(lc) 650#define LCTX_LOCK_ASSERT(lc, type) 651#define ALLLCTX_LOCK lck_mtx_lock(&alllctx_lock) 652#define ALLLCTX_UNLOCK lck_mtx_unlock(&alllctx_lock) 653extern lck_mtx_t alllctx_lock; 654extern lck_grp_t * lctx_lck_grp; 655extern lck_grp_attr_t * lctx_lck_grp_attr; 656extern lck_attr_t * lctx_lck_attr; 657 658#define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash]) 659extern LIST_HEAD(pidhashhead, proc) *pidhashtbl; 660extern u_long pidhash; 661 662#define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash]) 663extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl; 664extern u_long pgrphash; 665#define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash]) 666extern LIST_HEAD(sesshashhead, session) *sesshashtbl; 667extern u_long sesshash; 668 669extern lck_grp_t * proc_lck_grp; 670#if CONFIG_FINE_LOCK_GROUPS 671extern lck_grp_t * proc_mlock_grp; 672extern lck_grp_t * proc_fdmlock_grp; 673extern lck_grp_t * proc_slock_grp; 674#endif 675extern lck_grp_attr_t * proc_lck_grp_attr; 676extern lck_attr_t * proc_lck_attr; 677 678LIST_HEAD(proclist, proc); 679extern struct proclist allproc; /* List of all processes. */ 680extern struct proclist zombproc; /* List of zombie processes. */ 681extern struct proc *initproc; 682extern void procinit(void); 683extern void proc_lock(struct proc *); 684extern void proc_unlock(struct proc *); 685extern void proc_spinlock(struct proc *); 686extern void proc_spinunlock(struct proc *); 687extern void proc_list_lock(void); 688extern void proc_list_unlock(void); 689extern void proc_klist_lock(void); 690extern void proc_klist_unlock(void); 691extern void proc_fdlock(struct proc *); 692extern void proc_fdlock_spin(struct proc *); 693extern void proc_fdunlock(struct proc *); 694extern void proc_fdlock_assert(proc_t p, int assertflags); 695__private_extern__ int proc_core_name(const char *name, uid_t uid, pid_t pid, 696 char *cr_name, size_t cr_name_len); 697extern int isinferior(struct proc *, struct proc *); 698__private_extern__ struct proc *pzfind(pid_t); /* Find zombie by id. */ 699__private_extern__ struct proc *proc_find_zombref(pid_t); /* Find zombie by id. */ 700__private_extern__ void proc_drop_zombref(struct proc * p); /* Find zombie by id. */ 701 702 703extern struct lctx *lcfind(pid_t); /* Find a login context by id */ 704extern struct lctx *lccreate(void); /* Create a new login context */ 705 706extern int chgproccnt(uid_t uid, int diff); 707extern void enterlctx(struct proc *p, struct lctx *l, int create); 708extern void pinsertchild(struct proc *parent, struct proc *child); 709extern int enterpgrp(struct proc *p, pid_t pgid, int mksess); 710extern void fixjobc(struct proc *p, struct pgrp *pgrp, int entering); 711extern int inferior(struct proc *p); 712extern int leavepgrp(struct proc *p); 713extern void leavelctx(struct proc *p); 714extern void resetpriority(struct proc *); 715extern void setrunnable(struct proc *); 716extern void setrunqueue(struct proc *); 717extern int sleep(void *chan, int pri); 718extern int tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int)); 719extern int tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int)); 720extern int msleep0(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, int timo, int (*continuation)(int)); 721extern void vfork_return(struct proc *child, int32_t *retval, int rval); 722extern int exit1(struct proc *, int, int *); 723extern int exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int); 724extern int fork1(proc_t, thread_t *, int); 725extern void vfork_exit_internal(struct proc *p, int rv, int forced); 726extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked); 727extern int pgrp_iterate(struct pgrp * pgrp, int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 728extern int proc_iterate(int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 729extern int proc_rebootscan(int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 730extern int proc_childrenwalk(proc_t p, int (*callout)(proc_t , void *), void *arg); 731extern proc_t proc_findinternal(int pid, int funneled); 732extern proc_t proc_findthread(thread_t thread); 733extern void proc_refdrain(proc_t); 734extern void proc_childdrainlocked(proc_t); 735extern void proc_childdrainstart(proc_t); 736extern void proc_childdrainend(proc_t); 737extern void proc_checkdeadrefs(proc_t); 738struct proc *pfind_locked(pid_t); 739extern struct pgrp *pgfind(pid_t); 740extern void pg_rele(struct pgrp * pgrp); 741extern struct session * session_find_internal(pid_t sessid); 742extern struct pgrp * proc_pgrp(proc_t); 743extern struct pgrp * tty_pgrp(struct tty * tp); 744extern struct pgrp * pgfind_internal(pid_t); 745extern struct session * proc_session(proc_t); 746extern void pgrp_lock(struct pgrp * pgrp); 747extern void pgrp_unlock(struct pgrp * pgrp); 748extern void session_lock(struct session * sess); 749extern void session_unlock(struct session * sess); 750extern struct session * pgrp_session(struct pgrp * pgrp); 751extern void session_rele(struct session *sess); 752extern int isbackground(proc_t p, struct tty *tp); 753extern proc_t proc_parent(proc_t); 754extern proc_t proc_parentholdref(proc_t); 755extern int proc_parentdropref(proc_t, int); 756int itimerfix(struct timeval *tv); 757int itimerdecr(struct proc * p, struct itimerval *itp, int usec); 758void proc_signalstart(struct proc *, int locked); 759void proc_signalend(struct proc *, int locked); 760int proc_transstart(struct proc *, int locked); 761void proc_transcommit(struct proc *, int locked); 762void proc_transend(struct proc *, int locked); 763int proc_transwait(struct proc *, int locked); 764void proc_rele_locked(struct proc * p); 765struct proc *proc_ref_locked(struct proc * p); 766void proc_knote(struct proc * p, long hint); 767void proc_knote_drain(struct proc *p); 768void workqueue_init_lock(proc_t p); 769void workqueue_destroy_lock(proc_t p); 770void proc_setregister(proc_t p); 771void proc_resetregister(proc_t p); 772/* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */ 773thread_t proc_thread(proc_t); 774extern int proc_pendingsignals(proc_t, sigset_t); 775int proc_getpcontrol(int pid, int * pcontrolp); 776int proc_dopcontrol(proc_t p, void *unused_arg); 777int proc_resetpcontrol(int pid); 778#if PSYNCH 779void pth_proc_hashinit(proc_t); 780void pth_proc_hashdelete(proc_t); 781void pth_global_hashinit(void); 782extern thread_call_t psynch_thcall; 783void psynch_wq_cleanup(__unused void * param, __unused void * param1); 784extern lck_mtx_t * pthread_list_mlock; 785#endif /* PSYNCH */ 786struct uthread * current_uthread(void); 787 788/* return 1 if process is forcing case-sensitive HFS+ access, 0 for default */ 789extern int proc_is_forcing_hfs_case_sensitivity(proc_t); 790 791pid_t dtrace_proc_selfpid(void); 792pid_t dtrace_proc_selfppid(void); 793uid_t dtrace_proc_selfruid(void); 794#endif /* !_SYS_PROC_INTERNAL_H_ */ 795