1/*
2 * Copyright (c) 2000-2018 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 <kern/smr.h>
79#include <kern/kalloc.h>
80#include <libkern/OSAtomic.h>
81#include <sys/cdefs.h>
82#include <sys/filedesc.h>
83#include <sys/proc.h>
84#include <sys/proc_ro.h>
85#include <sys/signalvar.h>
86#include <mach/resource_monitors.h> // command/proc_name_t
87
88__BEGIN_DECLS
89#include <kern/locks.h>
90#if PSYNCH
91#include <kern/thread_call.h>
92#endif /* PSYNCH */
93__END_DECLS
94
95#if DEBUG
96#define __PROC_INTERNAL_DEBUG 1
97#endif
98
99/*
100 * The short form for various locks that protect fields in the data structures.
101 * PL = Process Lock
102 * PGL = Process Group Lock
103 * PUCL = Process User Credentials Lock
104 * PSL = Process Spin Lock
105 * LL = List Lock
106 * SL = Session Lock
107 * TTYL = TTY Lock
108 *
109 * C = constant/static
110 */
111struct label;
112
113/*
114 * Flags kept in the low bits of `struct session::s_refcount`
115 */
116__options_decl(session_ref_bits_t, uint32_t, {
117 S_DEFAULT = 0x00,
118 S_NOCTTY = 0x01, /* Do not associate controlling tty */
119 S_CTTYREF = 0x02, /* vnode ref taken by cttyopen */
120});
121#define SESSION_REF_BITS 4 /* 2 is enough, 4 is easier in hex */
122#define SESSION_REF_MASK ((1u << PGRP_REF_BITS) - 1)
123
124#define SESSION_NULL ((struct session *)NULL)
125
126/*!
127 * @struct session
128 *
129 * @brief
130 * Structure to keep track of process sessions
131 *
132 * @discussion
133 * Sessions hang (with +1's) from:
134 * - process groups (@c pgrp::pg_session)
135 * - ttys (@c tty::t_session)
136 *
137 * Lock ordering: TTYL > LL > SL
138 */
139struct session {
140 lck_mtx_t s_mlock; /* session lock */
141 LIST_ENTRY(session) s_hash; /* (LL) hash linkage */
142 struct proc *s_leader; /* (C) session leader */
143 struct vnode *s_ttyvp; /* (SL) Vnode of controlling terminal */
144 struct tty *s_ttyp; /* (SL) Controlling terminal */
145 uint32_t s_ttyvid; /* (SL) Vnode id of the controlling terminal */
146 pid_t s_ttypgrpid; /* (SL) tty's pgrp id */
147 dev_t _Atomic s_ttydev; /* (SL) tty's device */
148 pid_t s_sid; /* (C) Session ID */
149 os_ref_atomic_t s_refcount;
150 char s_login[MAXLOGNAME]; /* (SL) Setlogin() name */
151};
152
153
154/*
155 * Flags for pg_refcnt
156 */
157__options_decl(pggrp_ref_bits_t, uint32_t, {
158 PGRP_REF_NONE = 0x00,
159 PGRP_REF_EMPTY = 0x01, /* the process group has no members */
160});
161#define PGRP_REF_BITS 1
162#define PGRP_REF_MASK ((1u << PGRP_REF_BITS) - 1)
163
164#define PGRP_NULL ((struct pgrp *)NULL)
165
166/*!
167 * @struct pgrp
168 *
169 * @abstract
170 * Describes a process group membership.
171 *
172 * @discussion
173 * <b>locking rules</b>
174 *
175 * Process groups have a static ID (@c pg_id) and session (@c pg_session),
176 * and groups hold a reference on their session.
177 *
178 * Process group membership is protected by the @c pgrp_lock().
179 *
180 * Lock ordering: TTYL > LL > PGL
181 *
182 * <b>lifetime</b>
183 * Process groups are refcounted, with a packed bit that tracks whether
184 * the group is orphaned (has no members), which prevents it
185 * from being looked up.
186 *
187 * Process groups are retired through @c smr_proc_task_call().
188 *
189 * Process groups are hashed in a global hash table that can be consulted
190 * while holding the @c proc_list_lock() with @c pghash_find_locked()
191 * or using hazard pointers with @c pgrp_find().
192 */
193struct pgrp {
194 union {
195 lck_mtx_t pg_mlock; /* process group lock (PGL) */
196 struct smr_node pg_smr_node;
197 };
198 struct smrq_slink pg_hash; /* hash chain (PLL) */
199 LIST_HEAD(, proc) pg_members; /* group members (PGL) */
200 struct session *pg_session; /* session (static) */
201 pid_t pg_id; /* group ID (static) */
202 int pg_jobc; /* # procs qualifying pgrp for job control (PGL) */
203 os_ref_atomic_t pg_refcount;
204 os_ref_atomic_t pg_hashref;
205};
206
207
208__options_decl(proc_ref_bits_t, uint32_t, {
209 P_REF_NONE = 0x00u,
210 P_REF_NEW = 0x01u, /* the proc is being initialized */
211 P_REF_DEAD = 0x02u, /* the proc is becoming a zombie */
212 P_REF_WILL_EXEC = 0x04u, /* see proc_refdrain_will_exec() */
213 P_REF_IN_EXEC = 0x08u, /* see proc_refdrain_will_exec() */
214 P_REF_DRAINING = 0x10u, /* someone is in proc_refdrain() */
215 P_REF_SHADOW = 0x20u, /* the proc is shadow proc in exec */
216 P_REF_PROC_HOLD = 0x40u, /* the proc has ref on the proc task combined struct */
217 P_REF_TASK_HOLD = 0x80u, /* the task has ref on the proc task combined struct */
218});
219#define P_REF_BITS 8
220#define P_REF_MASK ((1u << P_REF_BITS) - 1)
221
222/*
223 * Kernel signal definitions and data structures,
224 * not exported to user programs.
225 */
226struct sigacts;
227
228/*
229 * Process signal actions and state, needed only within the process
230 * (not necessarily resident).
231 */
232struct sigacts {
233 user_addr_t ps_sigact[NSIG]; /* disposition of signals */
234 user_addr_t ps_trampact[NSIG]; /* disposition of signals */
235 sigset_t ps_catchmask[NSIG]; /* signals to be blocked */
236 sigset_t ps_sigonstack; /* signals to take on sigstack */
237 sigset_t ps_sigintr; /* signals that interrupt syscalls */
238 sigset_t ps_sigreset; /* signals that reset when caught */
239 sigset_t ps_signodefer; /* signals not masked while handled */
240 sigset_t ps_siginfo; /* signals that want SA_SIGINFO args */
241 sigset_t ps_oldmask; /* saved mask from before sigpause */
242 _Atomic uint32_t ps_sigreturn_validation; /* sigreturn argument validation state */
243 int ps_flags; /* signal flags, below */
244 int ps_sig; /* for core dump/debugger XXX */
245 int ps_code; /* for core dump/debugger XXX */
246 int ps_addr; /* for core dump/debugger XXX */
247};
248
249#define PROC_NULL ((struct proc *)NULL)
250
251/*
252 * Description of a process.
253 *
254 * This structure contains the information needed to manage a thread of
255 * control, known in UN*X as a process; it has references to substructures
256 * containing descriptions of things that the process uses, but may share
257 * with related processes. The process structure and the substructures
258 * are always addressible except for those marked "(PROC ONLY)" below,
259 * which might be addressible only on a processor on which the process
260 * is running.
261 */
262struct proc {
263 union {
264 LIST_ENTRY(proc) p_list; /* List of all processes. */
265 struct smr_node p_smr_node;
266 };
267 struct proc * XNU_PTRAUTH_SIGNED_PTR("proc.p_pptr") p_pptr; /* Pointer to parent process.(LL) */
268 proc_ro_t p_proc_ro;
269 pid_t p_ppid; /* process's parent pid number */
270 pid_t p_original_ppid; /* process's original parent pid number, doesn't change if reparented */
271 pid_t p_pgrpid; /* process group id of the process (LL)*/
272 uid_t p_uid;
273 gid_t p_gid;
274 uid_t p_ruid;
275 gid_t p_rgid;
276 uid_t p_svuid;
277 gid_t p_svgid;
278 pid_t p_sessionid;
279 uint64_t p_puniqueid; /* parent's unique ID - set on fork/spawn, doesn't change if reparented. */
280
281 lck_mtx_t p_mlock; /* mutex lock for proc */
282 pid_t p_pid; /* Process identifier for proc_find. (static)*/
283 char p_stat; /* S* process status. (PL)*/
284 char p_shutdownstate;
285 char p_kdebug; /* P_KDEBUG eq (CC)*/
286 char p_btrace; /* P_BTRACE eq (CC)*/
287
288 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp (PGL) */
289 LIST_ENTRY(proc) p_sibling; /* List of sibling processes (LL)*/
290 LIST_HEAD(, proc) p_children; /* Pointer to list of children (LL)*/
291 TAILQ_HEAD(, uthread) p_uthlist; /* List of uthreads (PL) */
292
293 struct smrq_slink p_hash; /* Hash chain (LL)*/
294
295#if CONFIG_PERSONAS
296 struct persona *p_persona;
297 LIST_ENTRY(proc) p_persona_list;
298#endif
299
300 lck_mtx_t p_ucred_mlock; /* mutex lock to protect p_ucred */
301#if CONFIG_AUDIT
302 lck_mtx_t p_audit_mlock; /* mutex lock to protect audit sessions */
303#endif /* CONFIG_AUDIT */
304
305 /* substructures: */
306 struct filedesc p_fd; /* open files structure */
307 struct pstats *p_stats; /* Accounting/statistics (PL) */
308 SMR_POINTER(struct plimit *) p_limit;/* Process limits (PL) */
309 SMR_POINTER(struct pgrp *XNU_PTRAUTH_SIGNED_PTR("proc.p_pgrp")) p_pgrp; /* Pointer to process group. (LL) */
310
311 struct sigacts p_sigacts;
312 lck_spin_t p_slock; /* spin lock for itimer/profil protection */
313
314 int p_siglist; /* signals captured back from threads */
315 unsigned int p_flag; /* P_* flags. (atomic bit ops) */
316 unsigned int p_lflag; /* local flags (PL) */
317 unsigned int p_listflag; /* list flags (LL) */
318 unsigned int p_ladvflag; /* local adv flags (atomic) */
319 os_ref_atomic_t p_refcount; /* number of outstanding users */
320 os_ref_atomic_t p_waitref; /* number of users pending transition */
321 int p_childrencnt; /* children holding ref on parent (LL) */
322 int p_parentref; /* children lookup ref on parent (LL) */
323 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
324 u_int p_xstat; /* Exit status for wait; also stop signal. */
325 int p_aio_total_count; /* all allocated AIO requests for this proc */
326
327#ifdef _PROC_HAS_SCHEDINFO_
328 /* may need cleanup, not used */
329 u_int p_estcpu; /* Time averaged value of p_cpticks.(used by aio and proc_comapre) */
330 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime (used by aio)*/
331 u_int p_slptime; /* used by proc_compare */
332#endif /* _PROC_HAS_SCHEDINFO_ */
333
334 struct itimerval p_realtimer; /* Alarm timer. (PSL) */
335 struct timeval p_rtime; /* Real time.(PSL) */
336 struct itimerval p_vtimer_user; /* Virtual timers.(PSL) */
337 struct itimerval p_vtimer_prof; /* (PSL) */
338
339 struct timeval p_rlim_cpu; /* Remaining rlim cpu value.(PSL) */
340 int p_debugger; /* NU 1: can exec set-bit programs if suser */
341 boolean_t sigwait; /* indication to suspend (PL) */
342 void *sigwait_thread; /* 'thread' holding sigwait(PL) */
343 void *exit_thread; /* Which thread is exiting(PL) */
344 /* Following fields are info from SIGCHLD (PL) */
345 pid_t si_pid; /* (PL) */
346 u_int si_status; /* (PL) */
347 u_int si_code; /* (PL) */
348 uid_t si_uid; /* (PL) */
349
350 void * vm_shm; /* (SYSV SHM Lock) for sysV shared memory */
351 int p_ractive;
352 /* cached proc-specific data required for corpse inspection */
353 pid_t p_responsible_pid; /* pid responsible for this process */
354
355#if CONFIG_DTRACE
356 int p_dtrace_probes; /* (PL) are there probes for this proc? */
357 u_int p_dtrace_count; /* (sprlock) number of DTrace tracepoints */
358 uint8_t p_dtrace_stop; /* indicates a DTrace-desired stop */
359 user_addr_t p_dtrace_argv; /* (write once, read only after that) */
360 user_addr_t p_dtrace_envp; /* (write once, read only after that) */
361 lck_mtx_t p_dtrace_sprlock; /* sun proc lock emulation */
362 struct dtrace_ptss_page* p_dtrace_ptss_pages; /* (sprlock) list of user ptss pages */
363 struct dtrace_ptss_page_entry* p_dtrace_ptss_free_list; /* (atomic) list of individual ptss entries */
364 struct dtrace_helpers* p_dtrace_helpers; /* (dtrace_lock) DTrace per-proc private */
365 struct dof_ioctl_data* p_dtrace_lazy_dofs; /* (sprlock) unloaded dof_helper_t's */
366#endif /* CONFIG_DTRACE */
367
368 __xnu_struct_group(proc_forkcopy_data, p_forkcopy, {
369 u_int p_argslen; /* Length of process arguments. */
370 int p_argc; /* saved argc for sysctl_procargs() */
371 user_addr_t user_stack; /* where user stack was allocated */
372 struct vnode * XNU_PTRAUTH_SIGNED_PTR("proc.p_textvp") p_textvp; /* Vnode of executable. */
373 off_t p_textoff; /* offset in executable vnode */
374
375 sigset_t p_sigmask; /* DEPRECATED */
376 sigset_t p_sigignore; /* Signals being ignored. (PL) */
377 sigset_t p_sigcatch; /* Signals being caught by user.(PL) */
378 sigset_t p_workq_allow_sigmask; /* Signals allowed for workq threads. Updates protected by proc_lock. */
379
380 u_char p_priority; /* (NU) Process priority. */
381 u_char p_resv0; /* (NU) User-priority based on p_cpu and p_nice. */
382 char p_nice; /* Process "nice" value.(PL) */
383 u_char p_resv1; /* (NU) User-priority based on p_cpu and p_nice. */
384
385 // types currently in sys/param.h
386 command_t p_comm;
387 proc_name_t p_name; /* can be changed by the process */
388 uint8_t p_xhighbits; /* Stores the top byte of exit status to avoid truncation*/
389 pid_t p_contproc; /* last PID to send us a SIGCONT (PL) */
390
391 uint32_t p_pcaction; /* action for process control on starvation */
392 uint8_t p_uuid[16]; /* from LC_UUID load command */
393
394 uint8_t p_responsible_uuid[16]; /* UUID of pid responsible for this process */
395
396 /*
397 * CPU type and subtype of binary slice executed in
398 * this process. Protected by proc lock.
399 */
400 cpu_type_t p_cputype;
401 cpu_subtype_t p_cpusubtype;
402 });
403
404 TAILQ_HEAD(, aio_workq_entry ) p_aio_activeq; /* active async IO requests */
405 TAILQ_HEAD(, aio_workq_entry ) p_aio_doneq; /* completed async IO requests */
406
407 struct klist p_klist; /* knote list (PL ?)*/
408
409 struct rusage_superset *p_ru; /* Exit information. (PL) */
410 thread_t p_signalholder;
411 thread_t p_transholder;
412 int p_sigwaitcnt;
413 /* DEPRECATE following field */
414 u_short p_acflag; /* Accounting flags. */
415 volatile u_short p_vfs_iopolicy; /* VFS iopolicy flags. (atomic bit ops) */
416
417 user_addr_t p_threadstart; /* pthread start fn */
418 user_addr_t p_wqthread; /* pthread workqueue fn */
419 int p_pthsize; /* pthread size */
420 uint32_t p_pth_tsd_offset; /* offset from pthread_t to TSD for new threads */
421 user_addr_t p_stack_addr_hint; /* stack allocation hint for wq threads */
422 struct workqueue *_Atomic p_wqptr; /* workq ptr */
423
424 struct timeval p_start; /* starting time */
425 void * p_rcall;
426 void * p_pthhash; /* pthread waitqueue hash */
427 volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */
428 volatile uint64_t did_throttle __attribute__((aligned(8))); /* Counter for number of I/Os this proc throttled */
429
430#if DIAGNOSTIC
431 unsigned int p_fdlock_pc[4];
432 unsigned int p_fdunlock_pc[4];
433#if SIGNAL_DEBUG
434 unsigned int lockpc[8];
435 unsigned int unlockpc[8];
436#endif /* SIGNAL_DEBUG */
437#endif /* DIAGNOSTIC */
438 uint64_t p_dispatchqueue_offset;
439 uint64_t p_dispatchqueue_serialno_offset;
440 uint64_t p_dispatchqueue_label_offset;
441 uint64_t p_return_to_kernel_offset;
442 uint64_t p_mach_thread_self_offset;
443 /* The offset is set to 0 if userspace is not requesting for this feature */
444 uint64_t p_pthread_wq_quantum_offset;
445#if VM_PRESSURE_EVENTS
446 struct timeval vm_pressure_last_notify_tstamp;
447#endif
448 uint8_t p_crash_behavior; /* bit fields to control behavior on crash. See spawn.h POSIX_SPAWN_PANIC* */
449 bool p_posix_spawn_failed; /* indicates that a posix_spawn failed */
450 bool p_disallow_map_with_linking; /* used to prevent dyld's map_with_linking() usage after startup */
451
452#if CONFIG_MEMORYSTATUS
453#if CONFIG_FREEZE
454 uint8_t p_memstat_freeze_skip_reason; /* memorystaus_freeze_skipped_reason_t. Protected by the freezer mutex. */
455#endif /* CONFIG_FREEZE */
456 /* Fields protected by proc list lock */
457 uint32_t p_memstat_state; /* state. Also used as a wakeup channel when the memstat's LOCKED bit changes */
458 int32_t p_memstat_effectivepriority; /* priority after transaction state accounted for */
459 int32_t p_memstat_requestedpriority; /* active priority */
460 int32_t p_memstat_assertionpriority; /* assertion driven priority */
461 uint32_t p_memstat_dirty; /* dirty state */
462 TAILQ_ENTRY(proc) p_memstat_list; /* priority bucket link */
463 uint64_t p_memstat_userdata; /* user state */
464 uint64_t p_memstat_idledeadline; /* time at which process became clean */
465 uint64_t p_memstat_idle_start; /* abstime process transitions into the idle band */
466 uint64_t p_memstat_idle_delta; /* abstime delta spent in idle band */
467 int32_t p_memstat_memlimit; /* cached memory limit, toggles between active and inactive limits */
468 int32_t p_memstat_memlimit_active; /* memory limit enforced when process is in active jetsam state */
469 int32_t p_memstat_memlimit_inactive; /* memory limit enforced when process is in inactive jetsam state */
470 int32_t p_memstat_relaunch_flags; /* flags indicating relaunch behavior for the process */
471#if CONFIG_FREEZE
472 uint32_t p_memstat_freeze_sharedanon_pages; /* shared pages left behind after freeze */
473 uint32_t p_memstat_frozen_count;
474 uint32_t p_memstat_thaw_count;
475 uint32_t p_memstat_last_thaw_interval; /* In which freezer interval was this last thawed? */
476#endif /* CONFIG_FREEZE */
477#endif /* CONFIG_MEMORYSTATUS */
478
479 _Atomic uint32_t p_user_faults; /* count the number of user faults generated */
480
481 uint32_t p_memlimit_increase; /* byte increase for memory limit for dyld SPI rdar://problem/49950264, structure packing 32-bit and 64-bit */
482
483 uint64_t p_crash_behavior_deadline; /* mach_continuous_time deadline. After this timestamp p_crash_behavior is invalid */
484
485 uint32_t p_crash_count; /* Consecutive crash count threshold */
486 uint32_t p_throttle_timeout; /* Exponential backoff throttle */
487
488 struct os_reason *p_exit_reason;
489
490#if CONFIG_PROC_UDATA_STORAGE
491 uint64_t p_user_data; /* general-purpose storage for userland-provided data */
492#endif /* CONFIG_PROC_UDATA_STORAGE */
493
494 char * p_subsystem_root_path;
495};
496
497/*
498 * Identify a process uniquely.
499 * proc_ident's fields match 1-1 with those in struct proc.
500 */
501struct proc_ident {
502 uint64_t p_uniqueid;
503 pid_t p_pid;
504 int p_idversion;
505};
506
507#define PGRPID_DEAD 0xdeaddead
508
509/* p_listflag */
510#define P_LIST_WAITING 0x00000010
511#define P_LIST_CHILDDRSTART 0x00000080
512#define P_LIST_CHILDDRAINED 0x00000100
513#define P_LIST_CHILDDRWAIT 0x00000200
514#define P_LIST_CHILDLKWAIT 0x00000400
515#define P_LIST_DEADPARENT 0x00000800
516#define P_LIST_PARENTREFWAIT 0x00001000
517#define P_LIST_EXITCOUNT 0x00100000 /* counted for process exit */
518
519/* local flags */
520#define P_LDELAYTERM 0x00000001 /* */
521#define P_LHASTASK 0x00000002 /* process points to a task */
522#define P_LTERM 0x00000004 /* */
523#define P_LEXIT 0x00000008 /* */
524#define P_LPEXIT 0x00000010
525#define P_LTRANSCOMMIT 0x00000020 /* process is committed to trans */
526#define P_LINTRANSIT 0x00000040 /* process in exec or in creation */
527#define P_LTRANSWAIT 0x00000080 /* waiting for trans to complete */
528#define P_LTRACED 0x00000400 /* */
529#define P_LSIGEXC 0x00000800 /* */
530#define P_LNOATTACH 0x00001000 /* */
531#define P_LPPWAIT 0x00002000 /* */
532#define P_LPTHREADJITALLOWLIST 0x00004000 /* process has pthread JIT write function allowlist */
533#define P_LPTHREADJITFREEZELATE 0x00008000 /* process JIT function allowlist is frozen late */
534#define P_LTRACE_WAIT 0x00010000 /* wait for flag to be cleared before starting ptrace */
535#define P_LLIMCHANGE 0x00020000 /* process is changing its plimit (rlim_cur, rlim_max) */
536#define P_LLIMWAIT 0x00040000
537#define P_LWAITED 0x00080000
538#define P_LINSIGNAL 0x00100000
539#define P_LCUSTOM_STACK 0x00200000 /* process is using custom stack size */
540#define P_LRAGE_VNODES 0x00400000
541#define P_LREGISTER 0x00800000 /* thread start fns registered */
542#define P_LVMRSRCOWNER 0x01000000 /* can handle the resource ownership of */
543#define P_LTERM_DECRYPTFAIL 0x04000000 /* process terminating due to key failure to decrypt */
544#define P_LTERM_JETSAM 0x08000000 /* process is being jetsam'd */
545
546#define P_JETSAM_VMPAGESHORTAGE 0x00000000 /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */
547#define P_JETSAM_VMTHRASHING 0x10000000 /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */
548#define P_JETSAM_HIWAT 0x20000000 /* jetsam: high water mark */
549#define P_JETSAM_PID 0x30000000 /* jetsam: pid */
550#define P_JETSAM_IDLEEXIT 0x40000000 /* jetsam: idle exit */
551#define P_JETSAM_VNODE 0x50000000 /* jetsam: vnode kill */
552#define P_JETSAM_FCTHRASHING 0x60000000 /* jetsam: lowest jetsam priority proc, killed due to filecache thrashing */
553#define P_JETSAM_MASK 0x70000000 /* jetsam type mask */
554#define P_LNSPACE_RESOLVER 0x80000000 /* process is the namespace resolver */
555
556/* Process control state for resource starvation */
557#define P_PCTHROTTLE 1
558#define P_PCSUSP 2
559#define P_PCKILL 3
560#define P_PCMAX 3
561
562/* Process control action state on resrouce starvation */
563#define PROC_ACTION_MASK 0xffff0000;
564#define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX)
565#define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX)
566#define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16)))
567#define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p))
568
569/* Process exit reason macros */
570#define PROC_HAS_EXITREASON(p) (p->p_exit_reason != OS_REASON_NULL)
571#define PROC_EXITREASON_FLAGS(p) p->p_exit_reason->osr_flags
572
573/* additional process flags */
574#define P_LADVLOCK 0x01
575#define P_LXBKIDLEINPROG 0x02
576#define P_RSR 0x04
577
578/* p_vfs_iopolicy flags */
579#define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY 0x0001
580#define P_VFS_IOPOLICY_ATIME_UPDATES 0x0002
581#define P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES 0x0004
582#define P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME 0x0008
583#define P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE 0x0010
584#define P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION 0x0020
585#define P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS 0x0040
586#define P_VFS_IOPOLICY_SKIP_MTIME_UPDATE 0x0080
587#define P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES 0x0100
588#define P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY 0x0200
589#define P_VFS_IOPOLICY_ALTLINK 0x0400
590#define P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE 0x0800
591
592#define P_VFS_IOPOLICY_INHERITED_MASK \
593 (P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY | \
594 P_VFS_IOPOLICY_ATIME_UPDATES | \
595 P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES | \
596 P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME | \
597 P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE | \
598 P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION | \
599 P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS | \
600 P_VFS_IOPOLICY_SKIP_MTIME_UPDATE | \
601 P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY | \
602 P_VFS_IOPOLICY_ALTLINK | \
603 P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE)
604
605#define P_VFS_IOPOLICY_VALID_MASK \
606 (P_VFS_IOPOLICY_INHERITED_MASK | \
607 P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES)
608
609/* process creation arguments */
610#define PROC_CREATE_FORK 0 /* independent child (running) */
611#define PROC_CREATE_SPAWN 1 /* independent child (suspended) */
612
613/* LP64 version of extern_proc. all pointers
614 * grow when we're dealing with a 64-bit process.
615 * WARNING - keep in sync with extern_proc
616 * but use native alignment of 64-bit process.
617 */
618
619#ifdef KERNEL
620#include <sys/time.h> /* user_timeval, user_itimerval */
621
622/*
623 * This packing is required to ensure symmetry between userspace and kernelspace
624 * when the kernel is 64-bit and the user application is 32-bit. All currently
625 * supported ARM slices (arm64/armv7k/arm64_32) contain the same struct
626 * alignment ABI so this packing isn't needed for ARM.
627 */
628#if defined(__x86_64__)
629#pragma pack(4)
630#endif
631struct user32_extern_proc {
632 union {
633 struct {
634 uint32_t __p_forw; /* Doubly-linked run/sleep queue. */
635 uint32_t __p_back;
636 } p_st1;
637 struct user32_timeval __p_starttime; /* process start time */
638 } p_un;
639 uint32_t p_vmspace; /* Address space. */
640 uint32_t p_sigacts; /* Signal actions, state (PROC ONLY). */
641 int p_flag; /* P_* flags. */
642 char p_stat; /* S* process status. */
643 pid_t p_pid; /* Process identifier. */
644 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
645 int p_dupfd; /* Sideways return value from fdopen. XXX */
646 /* Mach related */
647 uint32_t user_stack; /* where user stack was allocated */
648 uint32_t exit_thread; /* XXX Which thread is exiting? */
649 int p_debugger; /* allow to debug */
650 boolean_t sigwait; /* indication to suspend */
651 /* scheduling */
652 u_int p_estcpu; /* Time averaged value of p_cpticks. */
653 int p_cpticks; /* Ticks of cpu time. */
654 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
655 uint32_t p_wchan; /* Sleep address. */
656 uint32_t p_wmesg; /* Reason for sleep. */
657 u_int p_swtime; /* Time swapped in or out. */
658 u_int p_slptime; /* Time since last blocked. */
659 struct user32_itimerval p_realtimer; /* Alarm timer. */
660 struct user32_timeval p_rtime; /* Real time. */
661 u_quad_t p_uticks; /* Statclock hits in user mode. */
662 u_quad_t p_sticks; /* Statclock hits in system mode. */
663 u_quad_t p_iticks; /* Statclock hits processing intr. */
664 int p_traceflag; /* Kernel trace points. */
665 uint32_t p_tracep; /* Trace to vnode. */
666 int p_siglist; /* DEPRECATED */
667 uint32_t p_textvp; /* Vnode of executable. */
668 int p_holdcnt; /* If non-zero, don't swap. */
669 sigset_t p_sigmask; /* DEPRECATED. */
670 sigset_t p_sigignore; /* Signals being ignored. */
671 sigset_t p_sigcatch; /* Signals being caught by user. */
672 u_char p_priority; /* Process priority. */
673 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
674 char p_nice; /* Process "nice" value. */
675 char p_comm[MAXCOMLEN + 1];
676 uint32_t p_pgrp; /* Pointer to process group. */
677 uint32_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
678 u_short p_xstat; /* Exit status for wait; also stop signal. */
679 u_short p_acflag; /* Accounting flags. */
680 uint32_t p_ru; /* Exit information. XXX */
681};
682#pragma pack()
683struct user64_extern_proc {
684 union {
685 struct {
686 user_addr_t __p_forw; /* Doubly-linked run/sleep queue. */
687 user_addr_t __p_back;
688 } p_st1;
689 struct user64_timeval __p_starttime; /* process start time */
690 } p_un;
691 user_addr_t p_vmspace; /* Address space. */
692 user_addr_t p_sigacts; /* Signal actions, state (PROC ONLY). */
693 int p_flag; /* P_* flags. */
694 char p_stat; /* S* process status. */
695 pid_t p_pid; /* Process identifier. */
696 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
697 int p_dupfd; /* Sideways return value from fdopen. XXX */
698 /* Mach related */
699 user_addr_t user_stack __attribute((aligned(8))); /* where user stack was allocated */
700 user_addr_t exit_thread; /* XXX Which thread is exiting? */
701 int p_debugger; /* allow to debug */
702 boolean_t sigwait; /* indication to suspend */
703 /* scheduling */
704 u_int p_estcpu; /* Time averaged value of p_cpticks. */
705 int p_cpticks; /* Ticks of cpu time. */
706 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
707 user_addr_t p_wchan __attribute((aligned(8))); /* Sleep address. */
708 user_addr_t p_wmesg; /* Reason for sleep. */
709 u_int p_swtime; /* Time swapped in or out. */
710 u_int p_slptime; /* Time since last blocked. */
711 struct user64_itimerval p_realtimer; /* Alarm timer. */
712 struct user64_timeval p_rtime; /* Real time. */
713 u_quad_t p_uticks; /* Statclock hits in user mode. */
714 u_quad_t p_sticks; /* Statclock hits in system mode. */
715 u_quad_t p_iticks; /* Statclock hits processing intr. */
716 int p_traceflag; /* Kernel trace points. */
717 user_addr_t p_tracep __attribute((aligned(8))); /* Trace to vnode. */
718 int p_siglist; /* DEPRECATED */
719 user_addr_t p_textvp __attribute((aligned(8))); /* Vnode of executable. */
720 int p_holdcnt; /* If non-zero, don't swap. */
721 sigset_t p_sigmask; /* DEPRECATED. */
722 sigset_t p_sigignore; /* Signals being ignored. */
723 sigset_t p_sigcatch; /* Signals being caught by user. */
724 u_char p_priority; /* Process priority. */
725 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
726 char p_nice; /* Process "nice" value. */
727 char p_comm[MAXCOMLEN + 1];
728 user_addr_t p_pgrp __attribute((aligned(8))); /* Pointer to process group. */
729 user_addr_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
730 u_short p_xstat; /* Exit status for wait; also stop signal. */
731 u_short p_acflag; /* Accounting flags. */
732 user_addr_t p_ru __attribute((aligned(8))); /* Exit information. XXX */
733};
734#endif /* KERNEL */
735
736#pragma GCC visibility push(hidden)
737
738extern struct vfs_context vfs_context0;
739
740/*
741 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
742 * as it is used to represent "no process group".
743 */
744extern int nprocs, maxproc; /* Current and max number of procs. */
745extern int maxprocperuid; /* Current number of procs per uid */
746extern int hard_maxproc; /* hard limit */
747extern unsigned int proc_shutdown_exitcount;
748
749#define PID_MAX 99999
750#define NO_PID 100000
751extern lck_mtx_t proc_list_mlock;
752
753#define BSD_SIMUL_EXECS 33 /* 32 , allow for rounding */
754#define BSD_PAGEABLE_SIZE_PER_EXEC (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */
755extern int execargs_cache_size;
756extern int execargs_free_count;
757extern vm_offset_t * execargs_cache;
758
759#define SESS_LEADER(p, sessp) ((sessp)->s_leader == (p))
760
761#define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash])
762extern LIST_HEAD(sesshashhead, session) * sesshashtbl;
763extern u_long sesshash;
764
765extern lck_attr_t proc_lck_attr;
766extern lck_grp_t proc_fdmlock_grp;
767extern lck_grp_t proc_lck_grp;
768extern lck_grp_t proc_kqhashlock_grp;
769extern lck_grp_t proc_knhashlock_grp;
770extern lck_grp_t proc_slock_grp;
771extern lck_grp_t proc_mlock_grp;
772extern lck_grp_t proc_ucred_mlock_grp;
773extern lck_grp_t proc_dirslock_grp;
774
775LIST_HEAD(proclist, proc);
776extern struct proclist allproc; /* List of all processes. */
777extern struct proclist zombproc; /* List of zombie processes. */
778
779#if CONFIG_COREDUMP
780extern const char * defaultcorefiledir;
781extern const char * defaultdrivercorefiledir;
782extern char corefilename[MAXPATHLEN + 1];
783extern char drivercorefilename[MAXPATHLEN + 1];
784extern int do_coredump;
785extern int sugid_coredump;
786#endif
787
788__options_decl(cloneproc_flags_t, uint32_t, {
789 CLONEPROC_SPAWN = 0,
790 CLONEPROC_FORK = 0x0001,
791 CLONEPROC_INITPROC = 0x0002,
792 CLONEPROC_EXEC = 0x0004,
793});
794
795extern thread_t cloneproc(task_t, coalition_t *, proc_t, cloneproc_flags_t);
796extern struct proc * XNU_PTRAUTH_SIGNED_PTR("initproc") initproc;
797extern void proc_lock(struct proc *);
798extern void proc_unlock(struct proc *);
799extern void proc_spinlock(struct proc *);
800extern void proc_spinunlock(struct proc *);
801extern void proc_list_lock(void);
802extern void proc_list_unlock(void);
803extern void proc_klist_lock(void);
804extern void proc_klist_unlock(void);
805extern void proc_fdlock(struct proc *);
806extern void proc_fdlock_spin(struct proc *);
807extern void proc_fdunlock(struct proc *);
808extern void proc_fdlock_assert(proc_t p, int assertflags);
809extern void proc_dirs_lock_shared(struct proc *);
810extern void proc_dirs_unlock_shared(struct proc *);
811extern void proc_dirs_lock_exclusive(struct proc *);
812extern void proc_dirs_unlock_exclusive(struct proc *);
813extern void proc_ucred_lock(struct proc *);
814extern void proc_ucred_unlock(struct proc *);
815extern void proc_update_creds_onproc(struct proc *, kauth_cred_t cred);
816extern kauth_cred_t proc_ucred_locked(proc_t p);
817extern kauth_cred_t proc_ucred_smr(proc_t p);
818extern kauth_cred_t proc_ucred_unsafe(proc_t p) __exported;
819#if CONFIG_COREDUMP
820__private_extern__ int proc_core_name(const char *format, const char *name, uid_t uid, pid_t pid,
821 char *cr_name, size_t cr_name_len);
822#endif
823extern int isinferior(struct proc *, struct proc *);
824__private_extern__ struct proc *pzfind(pid_t); /* Find zombie by id. */
825__private_extern__ struct proc *proc_find_zombref(pid_t); /* Find zombie by id. */
826__private_extern__ void proc_drop_zombref(struct proc * p); /* Find zombie by id. */
827
828extern size_t chgproccnt(uid_t uid, int diff);
829extern void pinsertchild(struct proc *parent, struct proc *child, bool in_exec);
830extern void p_reparentallchildren(proc_t old_proc, proc_t new_proc);
831extern int setsid_internal(struct proc *p);
832#ifndef __cplusplus
833extern void setlogin_internal(proc_t p, const char login[static MAXLOGNAME]);
834#endif // __cplusplus
835extern int setgroups_internal(proc_t p, u_int gidsetsize, gid_t *gidset, uid_t gmuid);
836extern int enterpgrp(struct proc *p, pid_t pgid, int mksess);
837extern void fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
838extern int inferior(struct proc *p);
839extern void resetpriority(struct proc *);
840extern void setrunnable(struct proc *);
841extern void setrunqueue(struct proc *);
842extern int sleep(void *chan, int pri) __exported;
843extern int tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int));
844extern int tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int));
845extern int exit1(struct proc *, int, int *);
846extern int exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int);
847extern int exit_with_reason(struct proc *, int, int *, boolean_t, boolean_t, int, struct os_reason *);
848extern int fork1(proc_t, thread_t *, int, coalition_t *);
849extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked);
850
851extern bool proc_list_exited(proc_t p);
852extern proc_t proc_find_locked(int pid);
853extern proc_t proc_find_noref_smr(int pid);
854extern bool proc_is_shadow(proc_t p);
855extern proc_t proc_findthread(thread_t thread);
856extern void proc_refdrain(proc_t);
857extern proc_t proc_refdrain_will_exec(proc_t p);
858extern void proc_refwake_did_exec(proc_t p);
859extern void proc_childdrainlocked(proc_t);
860extern void proc_childdrainstart(proc_t);
861extern void proc_childdrainend(proc_t);
862extern void proc_checkdeadrefs(proc_t);
863struct proc *phash_find_locked(pid_t);
864extern void phash_insert_locked(struct proc *);
865extern void phash_remove_locked(struct proc *);
866extern void phash_replace_locked(struct proc *old_proc, struct proc *new_proc);
867extern bool pghash_exists_locked(pid_t);
868extern void pghash_insert_locked(struct pgrp *);
869extern struct pgrp *pgrp_find(pid_t);
870extern void pgrp_rele(struct pgrp * pgrp);
871extern struct session * session_find_internal(pid_t sessid);
872extern struct pgrp *proc_pgrp(proc_t, struct session **);
873extern struct pgrp *pgrp_leave_locked(struct proc *p);
874extern struct pgrp *pgrp_enter_locked(struct proc *parent, struct proc *p);
875extern struct pgrp *tty_pgrp_locked(struct tty * tp);
876struct pgrp *pgrp_alloc(pid_t pgid, pggrp_ref_bits_t bits);
877extern void pgrp_lock(struct pgrp * pgrp);
878extern void pgrp_unlock(struct pgrp * pgrp);
879extern struct session *session_find_locked(pid_t sessid);
880extern void session_replace_leader(struct proc *old_proc, struct proc *new_proc);
881extern struct session *session_alloc(struct proc *leader);
882extern void session_lock(struct session * sess);
883extern void session_unlock(struct session * sess);
884extern struct session *session_ref(struct session *sess);
885extern void session_rele(struct session *sess);
886extern struct tty *session_set_tty_locked(struct session *sessp, struct tty *);
887extern struct tty *session_clear_tty_locked(struct session *sess);
888extern struct tty *session_tty(struct session *sess);
889extern proc_t proc_parentholdref(proc_t);
890extern int proc_parentdropref(proc_t, int);
891int itimerfix(struct timeval *tv);
892int itimerdecr(struct proc * p, struct itimerval *itp, int usec);
893void proc_free_realitimer(proc_t proc);
894void proc_inherit_itimers(struct proc *old_proc, struct proc *new_proc);
895int timespec_is_valid(const struct timespec *);
896void proc_signalstart(struct proc *, int locked);
897void proc_signalend(struct proc *, int locked);
898int proc_transstart(struct proc *, int locked, int non_blocking);
899void proc_transcommit(struct proc *, int locked);
900void proc_transend(struct proc *, int locked);
901int proc_transwait(struct proc *, int locked);
902struct proc *proc_ref(struct proc *p, int locked);
903void proc_wait_release(struct proc *p);
904void proc_knote(struct proc * p, long hint);
905void proc_transfer_knotes(struct proc *old_proc, struct proc *new_proc);
906void proc_knote_drain(struct proc *p);
907void proc_setregister(proc_t p);
908void proc_resetregister(proc_t p);
909bool proc_get_pthread_jit_allowlist(proc_t p, bool *late_out);
910void proc_set_pthread_jit_allowlist(proc_t p, bool late);
911/* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */
912thread_t proc_thread(proc_t);
913extern int proc_pendingsignals(proc_t, sigset_t);
914int proc_getpcontrol(int pid, int * pcontrolp);
915int proc_dopcontrol(proc_t p);
916int proc_resetpcontrol(int pid);
917#if PSYNCH
918void pth_proc_hashinit(proc_t);
919void pth_proc_hashdelete(proc_t);
920void pth_global_hashinit(void);
921extern thread_call_t psynch_thcall;
922void psynch_wq_cleanup(__unused void * param, __unused void * param1);
923extern lck_mtx_t * pthread_list_mlock;
924#endif /* PSYNCH */
925struct uthread *current_uthread(void) __pure2;
926
927extern void proc_set_task(proc_t, task_t);
928extern task_t proc_get_task_raw(proc_t proc);
929extern proc_t task_get_proc_raw(task_t task);
930extern void proc_ref_hold_proc_task_struct(proc_t proc);
931extern void proc_release_proc_task_struct(proc_t proc);
932extern void task_ref_hold_proc_task_struct(task_t task);
933extern void task_release_proc_task_struct(task_t task);
934extern void proc_setpidversion(proc_t, int);
935extern uint64_t proc_getcsflags(proc_t);
936extern void proc_csflags_update(proc_t, uint64_t);
937extern void proc_csflags_set(proc_t, uint64_t);
938extern void proc_csflags_clear(proc_t, uint64_t);
939extern uint8_t *proc_syscall_filter_mask(proc_t);
940extern void proc_syscall_filter_mask_set(proc_t, uint8_t *);
941extern pid_t proc_getpid(proc_t);
942extern void proc_setplatformdata(proc_t, uint32_t, uint32_t, uint32_t);
943extern void proc_set_sigact(proc_t, int, user_addr_t);
944extern void proc_set_trampact(proc_t, int, user_addr_t);
945extern void proc_set_sigact_trampact(proc_t, int, user_addr_t, user_addr_t);
946extern void proc_reset_sigact(proc_t, sigset_t);
947extern void proc_setexecutableuuid(proc_t, const uuid_t);
948extern const unsigned char *proc_executableuuid_addr(proc_t);
949extern void proc_getresponsibleuuid(proc_t, unsigned char *, unsigned long);
950extern void proc_setresponsibleuuid(proc_t target_proc, unsigned char *responsible_uuid, unsigned long size);
951
952#pragma mark - process iteration
953
954/*
955 * ALLPROC_FOREACH cannot be used to access the task, as the field may be
956 * swapped out during exec. With `proc_iterate`, find threads by iterating the
957 * `p_uthlist` field of the proc, under the `proc_lock`.
958 */
959
960#define ALLPROC_FOREACH(var) \
961 LIST_FOREACH((var), &allproc, p_list)
962
963#define ZOMBPROC_FOREACH(var) \
964 LIST_FOREACH((var), &zombproc, p_list)
965
966#define PGMEMBERS_FOREACH(group, var) \
967 LIST_FOREACH((var), &((struct pgrp *)(group))->pg_members, p_pglist)
968
969#define PCHILDREN_FOREACH(parent, var) \
970 LIST_FOREACH((var), &(((struct proc *)(parent))->p_children), p_sibling)
971
972typedef int (*proc_iterate_fn_t)(proc_t, void *);
973
974/*
975 * These are the only valid return values of `callout` functions provided to
976 * process iterators.
977 *
978 * CLAIMED returns expect the caller to call proc_rele on the proc. DONE
979 * returns stop iterating processes early.
980 */
981#define PROC_RETURNED (0)
982#define PROC_RETURNED_DONE (1)
983#define PROC_CLAIMED (2)
984#define PROC_CLAIMED_DONE (3)
985
986/*
987 * pgrp_iterate walks the provided process group, calling `filterfn` with
988 * `filterarg` for each process. For processes where `filterfn` returned
989 * non-zero, `callout` is called with `arg`.
990 *
991 * `PGMEMBERS_FOREACH` might also be used under the pgrp_lock to achieve a
992 * similar effect.
993 */
994
995extern void pgrp_iterate(struct pgrp *pgrp, proc_iterate_fn_t callout,
996 void *arg, bool (^filterfn)(proc_t));
997
998/*
999 * proc_iterate walks the `allproc` and/or `zombproc` lists, calling `filterfn`
1000 * with `filterarg` for each process. For processes where `filterfn` returned
1001 * non-zero, `callout` is called with `arg`. If the `PROC_NOWAITTRANS` flag is
1002 * unset, this function waits for transitions.
1003 *
1004 * `ALLPROC_FOREACH` or `ZOMBPROC_FOREACH` might also be used under the
1005 * `proc_list_lock` to achieve a similar effect.
1006 */
1007#define PROC_ALLPROCLIST (1U << 0) /* walk the allproc list (processes not yet exited) */
1008#define PROC_ZOMBPROCLIST (1U << 1) /* walk the zombie list */
1009#define PROC_NOWAITTRANS (1U << 2) /* do not wait for transitions (checkdirs only) */
1010
1011extern void proc_iterate(unsigned int flags, proc_iterate_fn_t callout,
1012 void *arg, proc_iterate_fn_t filterfn, void *filterarg);
1013
1014/*
1015 * proc_childrenwalk walks the children of process `p`, calling `callout` for
1016 * each one.
1017 *
1018 * `PCHILDREN_FOREACH` might also be used under the `proc_list_lock` to achieve
1019 * a similar effect.
1020 */
1021extern void proc_childrenwalk(proc_t p, proc_iterate_fn_t callout, void *arg);
1022
1023/*
1024 * proc_rebootscan should only be used by kern_shutdown.c
1025 */
1026extern void proc_rebootscan(proc_iterate_fn_t callout, void *arg,
1027 proc_iterate_fn_t filterfn, void *filterarg);
1028
1029pid_t dtrace_proc_selfpid(void);
1030pid_t dtrace_proc_selfppid(void);
1031uid_t dtrace_proc_selfruid(void);
1032
1033os_refgrp_decl_extern(p_refgrp);
1034KALLOC_TYPE_DECLARE(proc_stats_zone);
1035ZONE_DECLARE_ID(ZONE_ID_PROC_TASK, struct proc);
1036extern zone_t proc_task_zone;
1037
1038extern struct proc_ident proc_ident(proc_t p);
1039
1040#if CONFIG_PROC_RESOURCE_LIMITS
1041int proc_set_filedesc_limits(proc_t p, int soft_limit, int hard_limit);
1042int proc_set_kqworkloop_limits(proc_t p, int soft_limit, int hard_limit);
1043#endif /* CONFIG_PROC_RESOURCE_LIMITS */
1044
1045/*
1046 * True if the process ignores file permissions in case it owns the
1047 * file/directory
1048 */
1049bool proc_ignores_node_permissions(proc_t proc);
1050
1051#pragma GCC visibility pop
1052#endif /* !_SYS_PROC_INTERNAL_H_ */
1053