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 /* 340 * CPU type and subtype of binary slice executed in 341 * this process. Protected by proc lock. 342 */ 343 cpu_type_t p_cputype; 344 cpu_subtype_t p_cpusubtype; 345 346/* End area that is copied on creation. */ 347/* XXXXXXXXXXXXX End of BCOPY'ed on fork (AIOLOCK)XXXXXXXXXXXXXXXX */ 348#define p_endcopy p_aio_total_count 349 int p_aio_total_count; /* all allocated AIO requests for this proc */ 350 int p_aio_active_count; /* all unfinished AIO requests for this proc */ 351 TAILQ_HEAD( , aio_workq_entry ) p_aio_activeq; /* active async IO requests */ 352 TAILQ_HEAD( , aio_workq_entry ) p_aio_doneq; /* completed async IO requests */ 353 354 struct klist p_klist; /* knote list (PL ?)*/ 355 356 struct rusage_superset *p_ru; /* Exit information. (PL) */ 357 int p_sigwaitcnt; 358 thread_t p_signalholder; 359 thread_t p_transholder; 360 361 /* DEPRECATE following field */ 362 u_short p_acflag; /* Accounting flags. */ 363 volatile u_short p_vfs_iopolicy; /* VFS iopolicy flags. (atomic bit ops) */ 364 365 struct lctx *p_lctx; /* Pointer to login context. */ 366 LIST_ENTRY(proc) p_lclist; /* List of processes in lctx. */ 367 user_addr_t p_threadstart; /* pthread start fn */ 368 user_addr_t p_wqthread; /* pthread workqueue fn */ 369 int p_pthsize; /* pthread size */ 370 uint32_t p_pth_tsd_offset; /* offset from pthread_t to TSD for new threads */ 371 user_addr_t p_targconc; /* target concurrency ptr */ 372 user_addr_t p_stack_addr_hint; /* stack allocation hint for wq threads */ 373 void * p_wqptr; /* workq ptr */ 374 int p_wqsize; /* allocated size */ 375 boolean_t p_wqiniting; /* semaphore to serialze wq_open */ 376 lck_spin_t p_wqlock; /* lock to protect work queue */ 377 struct timeval p_start; /* starting time */ 378 void * p_rcall; 379 int p_ractive; 380 int p_idversion; /* version of process identity */ 381 void * p_pthhash; /* pthread waitqueue hash */ 382 volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */ 383 volatile uint64_t did_throttle __attribute__((aligned(8))); /* Counter for number of I/Os this proc throttled */ 384 385#if DIAGNOSTIC 386 unsigned int p_fdlock_pc[4]; 387 unsigned int p_fdunlock_pc[4]; 388#if SIGNAL_DEBUG 389 unsigned int lockpc[8]; 390 unsigned int unlockpc[8]; 391#endif /* SIGNAL_DEBUG */ 392#endif /* DIAGNOSTIC */ 393 uint64_t p_dispatchqueue_offset; 394 uint64_t p_dispatchqueue_serialno_offset; 395#if VM_PRESSURE_EVENTS 396 struct timeval vm_pressure_last_notify_tstamp; 397#endif 398 399#if CONFIG_MEMORYSTATUS 400 /* Fields protected by proc list lock */ 401 TAILQ_ENTRY(proc) p_memstat_list; /* priority bucket link */ 402 uint32_t p_memstat_state; /* state */ 403 int32_t p_memstat_effectivepriority; /* priority after transaction state accounted for */ 404 int32_t p_memstat_requestedpriority; /* active priority */ 405 uint32_t p_memstat_dirty; /* dirty state */ 406 uint64_t p_memstat_userdata; /* user state */ 407 uint64_t p_memstat_idledeadline; /* time at which process became clean */ 408#if CONFIG_JETSAM 409 int32_t p_memstat_memlimit; /* cached memory limit */ 410#endif 411#if CONFIG_FREEZE 412 uint32_t p_memstat_suspendedfootprint; /* footprint at time of suspensions */ 413#endif /* CONFIG_FREEZE */ 414#endif /* CONFIG_MEMORYSTATUS */ 415}; 416 417#define PGRPID_DEAD 0xdeaddead 418 419/* p_listflag */ 420#define P_LIST_DRAIN 0x00000001 421#define P_LIST_DRAINWAIT 0x00000002 422#define P_LIST_DRAINED 0x00000004 423#define P_LIST_DEAD 0x00000008 424#define P_LIST_WAITING 0x00000010 425#define P_LIST_EXITED 0x00000040 426#define P_LIST_CHILDDRSTART 0x00000080 427#define P_LIST_CHILDDRAINED 0x00000100 428#define P_LIST_CHILDDRWAIT 0x00000200 429#define P_LIST_CHILDLKWAIT 0x00000400 430#define P_LIST_DEADPARENT 0x00000800 431#define P_LIST_PARENTREFWAIT 0x00001000 432#define P_LIST_INCREATE 0x00002000 433/* 0x4000 & 0x8000 Not used */ 434#define P_LIST_INHASH 0x00010000 /* process is in hash */ 435#define P_LIST_INPGRP 0x00020000 /* process is in pgrp */ 436#define P_LIST_PGRPTRANS 0x00040000 /* pgrp is getting replaced */ 437#define P_LIST_PGRPTRWAIT 0x00080000 /* wait for pgrp replacement */ 438#define P_LIST_EXITCOUNT 0x00100000 /* counted for process exit */ 439 440 441/* local flags */ 442#define P_LDELAYTERM 0x00000001 /* */ 443#define P_LNOZOMB 0x00000002 /* */ 444#define P_LTERM 0x00000004 /* */ 445#define P_LEXIT 0x00000008 /* */ 446#define P_LPEXIT 0x00000010 447#define P_LTRANSCOMMIT 0x00000020 /* process is committed to trans */ 448#define P_LINTRANSIT 0x00000040 /* process in exec or in creation */ 449#define P_LTRANSWAIT 0x00000080 /* waiting for trans to complete */ 450#define P_LVFORK 0x00000100 /* parent proc of a vfork */ 451#define P_LINVFORK 0x00000200 /* child proc of a vfork */ 452#define P_LTRACED 0x00000400 /* */ 453#define P_LSIGEXC 0x00000800 /* */ 454#define P_LNOATTACH 0x00001000 /* */ 455#define P_LPPWAIT 0x00002000 /* */ 456#define P_LKQWDRAIN 0x00004000 457#define P_LKQWDRAINWAIT 0x00008000 458#define P_LKQWDEAD 0x00010000 459#define P_LLIMCHANGE 0x00020000 460#define P_LLIMWAIT 0x00040000 461#define P_LWAITED 0x00080000 462#define P_LINSIGNAL 0x00100000 463#define P_UNUSED 0x00200000 /* Unused */ 464#define P_LRAGE_VNODES 0x00400000 465#define P_LREGISTER 0x00800000 /* thread start fns registered */ 466#define P_LVMRSRCOWNER 0x01000000 /* can handle the resource ownership of */ 467/* old P_LPTERMINATE 0x02000000 */ 468#define P_LTERM_DECRYPTFAIL 0x04000000 /* process terminating due to key failure to decrypt */ 469#define P_LTERM_JETSAM 0x08000000 /* process is being jetsam'd */ 470#define P_JETSAM_VMPAGESHORTAGE 0x00000000 /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */ 471#define P_JETSAM_VMTHRASHING 0x10000000 /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */ 472#define P_JETSAM_HIWAT 0x20000000 /* jetsam: high water mark */ 473#define P_JETSAM_PID 0x30000000 /* jetsam: pid */ 474#define P_JETSAM_IDLEEXIT 0x40000000 /* jetsam: idle exit */ 475#define P_JETSAM_VNODE 0x50000000 /* jetsam: vnode kill */ 476#define P_JETSAM_FCTHRASHING 0x60000000 /* jetsam: lowest jetsam priority proc, killed due to filecache thrashing */ 477#define P_JETSAM_MASK 0x70000000 /* jetsam type mask */ 478 479/* Process control state for resource starvation */ 480#define P_PCTHROTTLE 1 481#define P_PCSUSP 2 482#define P_PCKILL 3 483#define P_PCMAX 3 484 485/* Process control action state on resrouce starvation */ 486#define PROC_ACTION_MASK 0xffff0000; 487#define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX) 488#define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX) 489#define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16))) 490#define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p)) 491 492/* additional process flags */ 493#define P_LADVLOCK 0x01 494 495/* p_vfs_iopolicy flags */ 496#define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY 0x0001 497 498/* defns for proc_iterate */ 499#define PROC_ALLPROCLIST 1 /* walk the allproc list (procs not exited yet) */ 500#define PROC_ZOMBPROCLIST 2 /* walk the zombie list */ 501#define PROC_NOWAITTRANS 4 /* do not wait for transitions (checkdirs only) */ 502 503/* defns for pgrp_iterate */ 504#define PGRP_DROPREF 1 505#define PGRP_BLOCKITERATE 2 506 507/* return values of the proc iteration callback routine */ 508#define PROC_RETURNED 0 509#define PROC_RETURNED_DONE 1 510#define PROC_CLAIMED 2 511#define PROC_CLAIMED_DONE 3 512 513/* process creation arguments */ 514#define PROC_CREATE_FORK 0 /* independent child (running) */ 515#define PROC_CREATE_SPAWN 1 /* independent child (suspended) */ 516#define PROC_CREATE_VFORK 2 /* child borrows context */ 517 518 519/* LP64 version of extern_proc. all pointers 520 * grow when we're dealing with a 64-bit process. 521 * WARNING - keep in sync with extern_proc 522 * but use native alignment of 64-bit process. 523 */ 524 525#ifdef KERNEL 526#include <sys/time.h> /* user_timeval, user_itimerval */ 527 528#pragma pack(4) 529struct user32_extern_proc { 530 union { 531 struct { 532 uint32_t __p_forw; /* Doubly-linked run/sleep queue. */ 533 uint32_t __p_back; 534 } p_st1; 535 struct user32_timeval __p_starttime; /* process start time */ 536 } p_un; 537 uint32_t p_vmspace; /* Address space. */ 538 uint32_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 539 int p_flag; /* P_* flags. */ 540 char p_stat; /* S* process status. */ 541 pid_t p_pid; /* Process identifier. */ 542 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 543 int p_dupfd; /* Sideways return value from fdopen. XXX */ 544 /* Mach related */ 545 uint32_t user_stack; /* where user stack was allocated */ 546 uint32_t exit_thread; /* XXX Which thread is exiting? */ 547 int p_debugger; /* allow to debug */ 548 boolean_t sigwait; /* indication to suspend */ 549 /* scheduling */ 550 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 551 int p_cpticks; /* Ticks of cpu time. */ 552 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 553 uint32_t p_wchan; /* Sleep address. */ 554 uint32_t p_wmesg; /* Reason for sleep. */ 555 u_int p_swtime; /* Time swapped in or out. */ 556 u_int p_slptime; /* Time since last blocked. */ 557 struct user32_itimerval p_realtimer; /* Alarm timer. */ 558 struct user32_timeval p_rtime; /* Real time. */ 559 u_quad_t p_uticks; /* Statclock hits in user mode. */ 560 u_quad_t p_sticks; /* Statclock hits in system mode. */ 561 u_quad_t p_iticks; /* Statclock hits processing intr. */ 562 int p_traceflag; /* Kernel trace points. */ 563 uint32_t p_tracep; /* Trace to vnode. */ 564 int p_siglist; /* DEPRECATED */ 565 uint32_t p_textvp; /* Vnode of executable. */ 566 int p_holdcnt; /* If non-zero, don't swap. */ 567 sigset_t p_sigmask; /* DEPRECATED. */ 568 sigset_t p_sigignore; /* Signals being ignored. */ 569 sigset_t p_sigcatch; /* Signals being caught by user. */ 570 u_char p_priority; /* Process priority. */ 571 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 572 char p_nice; /* Process "nice" value. */ 573 char p_comm[MAXCOMLEN+1]; 574 uint32_t p_pgrp; /* Pointer to process group. */ 575 uint32_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 576 u_short p_xstat; /* Exit status for wait; also stop signal. */ 577 u_short p_acflag; /* Accounting flags. */ 578 uint32_t p_ru; /* Exit information. XXX */ 579}; 580#pragma pack() 581struct user64_extern_proc { 582 union { 583 struct { 584 user_addr_t __p_forw; /* Doubly-linked run/sleep queue. */ 585 user_addr_t __p_back; 586 } p_st1; 587 struct user64_timeval __p_starttime; /* process start time */ 588 } p_un; 589 user_addr_t p_vmspace; /* Address space. */ 590 user_addr_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 591 int p_flag; /* P_* flags. */ 592 char p_stat; /* S* process status. */ 593 pid_t p_pid; /* Process identifier. */ 594 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 595 int p_dupfd; /* Sideways return value from fdopen. XXX */ 596 /* Mach related */ 597 user_addr_t user_stack __attribute((aligned(8))); /* where user stack was allocated */ 598 user_addr_t exit_thread; /* XXX Which thread is exiting? */ 599 int p_debugger; /* allow to debug */ 600 boolean_t sigwait; /* indication to suspend */ 601 /* scheduling */ 602 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 603 int p_cpticks; /* Ticks of cpu time. */ 604 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 605 user_addr_t p_wchan __attribute((aligned(8))); /* Sleep address. */ 606 user_addr_t p_wmesg; /* Reason for sleep. */ 607 u_int p_swtime; /* Time swapped in or out. */ 608 u_int p_slptime; /* Time since last blocked. */ 609 struct user64_itimerval p_realtimer; /* Alarm timer. */ 610 struct user64_timeval p_rtime; /* Real time. */ 611 u_quad_t p_uticks; /* Statclock hits in user mode. */ 612 u_quad_t p_sticks; /* Statclock hits in system mode. */ 613 u_quad_t p_iticks; /* Statclock hits processing intr. */ 614 int p_traceflag; /* Kernel trace points. */ 615 user_addr_t p_tracep __attribute((aligned(8))); /* Trace to vnode. */ 616 int p_siglist; /* DEPRECATED */ 617 user_addr_t p_textvp __attribute((aligned(8))); /* Vnode of executable. */ 618 int p_holdcnt; /* If non-zero, don't swap. */ 619 sigset_t p_sigmask; /* DEPRECATED. */ 620 sigset_t p_sigignore; /* Signals being ignored. */ 621 sigset_t p_sigcatch; /* Signals being caught by user. */ 622 u_char p_priority; /* Process priority. */ 623 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 624 char p_nice; /* Process "nice" value. */ 625 char p_comm[MAXCOMLEN+1]; 626 user_addr_t p_pgrp __attribute((aligned(8))); /* Pointer to process group. */ 627 user_addr_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 628 u_short p_xstat; /* Exit status for wait; also stop signal. */ 629 u_short p_acflag; /* Accounting flags. */ 630 user_addr_t p_ru __attribute((aligned(8))); /* Exit information. XXX */ 631}; 632#endif /* KERNEL */ 633 634/* 635 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 636 * as it is used to represent "no process group". 637 */ 638extern int nprocs, maxproc; /* Current and max number of procs. */ 639extern int maxprocperuid; /* Current number of procs per uid */ 640extern int hard_maxproc; /* hard limit */ 641extern unsigned int proc_shutdown_exitcount; 642 643#define PID_MAX 99999 644#define NO_PID 100000 645extern lck_mtx_t * proc_list_mlock; 646extern lck_mtx_t * proc_klist_mlock; 647 648#define BSD_SIMUL_EXECS 33 /* 32 , allow for rounding */ 649#define BSD_PAGEABLE_SIZE_PER_EXEC (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */ 650extern int execargs_cache_size; 651extern int execargs_free_count; 652extern vm_offset_t * execargs_cache; 653 654#define SESS_LEADER(p, sessp) ((sessp)->s_leader == (p)) 655 656/* Lock and unlock a login context. */ 657#define LCTX_LOCK(lc) lck_mtx_lock(&(lc)->lc_mtx) 658#define LCTX_UNLOCK(lc) lck_mtx_unlock(&(lc)->lc_mtx) 659#define LCTX_LOCKED(lc) 660#define LCTX_LOCK_ASSERT(lc, type) 661#define ALLLCTX_LOCK lck_mtx_lock(&alllctx_lock) 662#define ALLLCTX_UNLOCK lck_mtx_unlock(&alllctx_lock) 663extern lck_mtx_t alllctx_lock; 664extern lck_grp_t * lctx_lck_grp; 665extern lck_grp_attr_t * lctx_lck_grp_attr; 666extern lck_attr_t * lctx_lck_attr; 667 668#define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash]) 669extern LIST_HEAD(pidhashhead, proc) *pidhashtbl; 670extern u_long pidhash; 671 672#define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash]) 673extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl; 674extern u_long pgrphash; 675#define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash]) 676extern LIST_HEAD(sesshashhead, session) *sesshashtbl; 677extern u_long sesshash; 678 679extern lck_grp_t * proc_lck_grp; 680#if CONFIG_FINE_LOCK_GROUPS 681extern lck_grp_t * proc_mlock_grp; 682extern lck_grp_t * proc_fdmlock_grp; 683extern lck_grp_t * proc_slock_grp; 684#endif 685extern lck_grp_attr_t * proc_lck_grp_attr; 686extern lck_attr_t * proc_lck_attr; 687 688LIST_HEAD(proclist, proc); 689extern struct proclist allproc; /* List of all processes. */ 690extern struct proclist zombproc; /* List of zombie processes. */ 691extern struct proc *initproc; 692extern void procinit(void); 693extern void proc_lock(struct proc *); 694extern void proc_unlock(struct proc *); 695extern void proc_spinlock(struct proc *); 696extern void proc_spinunlock(struct proc *); 697extern void proc_list_lock(void); 698extern void proc_list_unlock(void); 699extern void proc_klist_lock(void); 700extern void proc_klist_unlock(void); 701extern void proc_fdlock(struct proc *); 702extern void proc_fdlock_spin(struct proc *); 703extern void proc_fdunlock(struct proc *); 704extern void proc_fdlock_assert(proc_t p, int assertflags); 705__private_extern__ int proc_core_name(const char *name, uid_t uid, pid_t pid, 706 char *cr_name, size_t cr_name_len); 707extern int isinferior(struct proc *, struct proc *); 708__private_extern__ struct proc *pzfind(pid_t); /* Find zombie by id. */ 709__private_extern__ struct proc *proc_find_zombref(pid_t); /* Find zombie by id. */ 710__private_extern__ void proc_drop_zombref(struct proc * p); /* Find zombie by id. */ 711 712 713extern struct lctx *lcfind(pid_t); /* Find a login context by id */ 714extern struct lctx *lccreate(void); /* Create a new login context */ 715 716extern int chgproccnt(uid_t uid, int diff); 717extern void enterlctx(struct proc *p, struct lctx *l, int create); 718extern void pinsertchild(struct proc *parent, struct proc *child); 719extern int enterpgrp(struct proc *p, pid_t pgid, int mksess); 720extern void fixjobc(struct proc *p, struct pgrp *pgrp, int entering); 721extern int inferior(struct proc *p); 722extern int leavepgrp(struct proc *p); 723extern void leavelctx(struct proc *p); 724extern void resetpriority(struct proc *); 725extern void setrunnable(struct proc *); 726extern void setrunqueue(struct proc *); 727extern int sleep(void *chan, int pri); 728extern int tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int)); 729extern int tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int)); 730extern int msleep0(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, int timo, int (*continuation)(int)); 731extern void vfork_return(struct proc *child, int32_t *retval, int rval); 732extern int exit1(struct proc *, int, int *); 733extern int exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int); 734extern int fork1(proc_t, thread_t *, int, coalition_t); 735extern void vfork_exit_internal(struct proc *p, int rv, int forced); 736extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked); 737extern int pgrp_iterate(struct pgrp * pgrp, int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 738extern int proc_iterate(int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 739extern int proc_rebootscan(int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg); 740extern int proc_childrenwalk(proc_t p, int (*callout)(proc_t , void *), void *arg); 741extern proc_t proc_findinternal(int pid, int locked); 742extern proc_t proc_findthread(thread_t thread); 743extern void proc_refdrain(proc_t); 744extern void proc_childdrainlocked(proc_t); 745extern void proc_childdrainstart(proc_t); 746extern void proc_childdrainend(proc_t); 747extern void proc_checkdeadrefs(proc_t); 748struct proc *pfind_locked(pid_t); 749extern struct pgrp *pgfind(pid_t); 750extern void pg_rele(struct pgrp * pgrp); 751extern struct session * session_find_internal(pid_t sessid); 752extern struct pgrp * proc_pgrp(proc_t); 753extern struct pgrp * tty_pgrp(struct tty * tp); 754extern struct pgrp * pgfind_internal(pid_t); 755extern struct session * proc_session(proc_t); 756extern void pgrp_lock(struct pgrp * pgrp); 757extern void pgrp_unlock(struct pgrp * pgrp); 758extern void session_lock(struct session * sess); 759extern void session_unlock(struct session * sess); 760extern struct session * pgrp_session(struct pgrp * pgrp); 761extern void session_rele(struct session *sess); 762extern int isbackground(proc_t p, struct tty *tp); 763extern proc_t proc_parent(proc_t); 764extern proc_t proc_parentholdref(proc_t); 765extern int proc_parentdropref(proc_t, int); 766int itimerfix(struct timeval *tv); 767int itimerdecr(struct proc * p, struct itimerval *itp, int usec); 768void proc_signalstart(struct proc *, int locked); 769void proc_signalend(struct proc *, int locked); 770int proc_transstart(struct proc *, int locked, int non_blocking); 771void proc_transcommit(struct proc *, int locked); 772void proc_transend(struct proc *, int locked); 773int proc_transwait(struct proc *, int locked); 774void proc_rele_locked(struct proc * p); 775struct proc *proc_ref_locked(struct proc * p); 776void proc_knote(struct proc * p, long hint); 777void proc_knote_drain(struct proc *p); 778void workqueue_init_lock(proc_t p); 779void workqueue_destroy_lock(proc_t p); 780void proc_setregister(proc_t p); 781void proc_resetregister(proc_t p); 782/* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */ 783thread_t proc_thread(proc_t); 784extern int proc_pendingsignals(proc_t, sigset_t); 785int proc_getpcontrol(int pid, int * pcontrolp); 786int proc_dopcontrol(proc_t p); 787int proc_resetpcontrol(int pid); 788#if PSYNCH 789void pth_proc_hashinit(proc_t); 790void pth_proc_hashdelete(proc_t); 791void pth_global_hashinit(void); 792extern thread_call_t psynch_thcall; 793void psynch_wq_cleanup(__unused void * param, __unused void * param1); 794extern lck_mtx_t * pthread_list_mlock; 795#endif /* PSYNCH */ 796struct uthread * current_uthread(void); 797 798/* return 1 if process is forcing case-sensitive HFS+ access, 0 for default */ 799extern int proc_is_forcing_hfs_case_sensitivity(proc_t); 800 801pid_t dtrace_proc_selfpid(void); 802pid_t dtrace_proc_selfppid(void); 803uid_t dtrace_proc_selfruid(void); 804#endif /* !_SYS_PROC_INTERNAL_H_ */ 805