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.h 8.15 (Berkeley) 5/19/95
67 */
68
69 #ifndef _SYS_PROC_H_
70 #define _SYS_PROC_H_
71
72 #include <sys/appleapiopts.h>
73 #include <sys/cdefs.h>
74 #include <sys/select.h> /* For struct selinfo. */
75 #include <sys/queue.h>
76 #include <sys/lock.h>
77 #include <sys/param.h>
78 #include <sys/event.h>
79 #include <sys/time.h>
80 #ifdef KERNEL
81 #include <sys/kernel_types.h>
82 #include <uuid/uuid.h>
83 #endif
84 #include <mach/boolean.h>
85
86 #ifdef XNU_KERNEL_PRIVATE
87 #include <mach/coalition.h> /* COALITION_NUM_TYPES */
88 #include <sys/codesign.h>
89 #endif
90
91 #ifndef KERNEL
92 #include <Availability.h>
93 #endif
94
95 #if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL)
96
97 struct session;
98 struct pgrp;
99 struct proc;
100
101 /* Exported fields for kern sysctls */
102 struct extern_proc {
103 union {
104 struct {
105 struct proc *__p_forw; /* Doubly-linked run/sleep queue. */
106 struct proc *__p_back;
107 } p_st1;
108 struct timeval __p_starttime; /* process start time */
109 } p_un;
110 #define p_forw p_un.p_st1.__p_forw
111 #define p_back p_un.p_st1.__p_back
112 #define p_starttime p_un.__p_starttime
113 struct vmspace *p_vmspace; /* Address space. */
114 struct sigacts *p_sigacts; /* Signal actions, state (PROC ONLY). */
115 int p_flag; /* P_* flags. */
116 char p_stat; /* S* process status. */
117 pid_t p_pid; /* Process identifier. */
118 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
119 int p_dupfd; /* Sideways return value from fdopen. XXX */
120 /* Mach related */
121 caddr_t user_stack; /* where user stack was allocated */
122 void *exit_thread; /* XXX Which thread is exiting? */
123 int p_debugger; /* allow to debug */
124 boolean_t sigwait; /* indication to suspend */
125 /* scheduling */
126 u_int p_estcpu; /* Time averaged value of p_cpticks. */
127 int p_cpticks; /* Ticks of cpu time. */
128 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
129 void *p_wchan; /* Sleep address. */
130 char *p_wmesg; /* Reason for sleep. */
131 u_int p_swtime; /* Time swapped in or out. */
132 u_int p_slptime; /* Time since last blocked. */
133 struct itimerval p_realtimer; /* Alarm timer. */
134 struct timeval p_rtime; /* Real time. */
135 u_quad_t p_uticks; /* Statclock hits in user mode. */
136 u_quad_t p_sticks; /* Statclock hits in system mode. */
137 u_quad_t p_iticks; /* Statclock hits processing intr. */
138 int p_traceflag; /* Kernel trace points. */
139 struct vnode *p_tracep; /* Trace to vnode. */
140 int p_siglist; /* DEPRECATED. */
141 struct vnode *p_textvp; /* Vnode of executable. */
142 int p_holdcnt; /* If non-zero, don't swap. */
143 sigset_t p_sigmask; /* DEPRECATED. */
144 sigset_t p_sigignore; /* Signals being ignored. */
145 sigset_t p_sigcatch; /* Signals being caught by user. */
146 u_char p_priority; /* Process priority. */
147 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
148 char p_nice; /* Process "nice" value. */
149 char p_comm[MAXCOMLEN + 1];
150 struct pgrp *p_pgrp; /* Pointer to process group. */
151 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
152 u_short p_xstat; /* Exit status for wait; also stop signal. */
153 u_short p_acflag; /* Accounting flags. */
154 struct rusage *p_ru; /* Exit information. XXX */
155 };
156
157
158 /* Status values. */
159 #define SIDL 1 /* Process being created by fork. */
160 #define SRUN 2 /* Currently runnable. */
161 #define SSLEEP 3 /* Sleeping on an address. */
162 #define SSTOP 4 /* Process debugging or suspension. */
163 #define SZOMB 5 /* Awaiting collection by parent. */
164
165 /* These flags are kept in extern_proc.p_flag. */
166 #define P_ADVLOCK 0x00000001 /* Process may hold POSIX adv. lock */
167 #define P_CONTROLT 0x00000002 /* Has a controlling terminal */
168 #define P_LP64 0x00000004 /* Process is LP64 */
169 #define P_NOCLDSTOP 0x00000008 /* No SIGCHLD when children stop */
170
171 #define P_PPWAIT 0x00000010 /* Parent waiting for chld exec/exit */
172 #define P_PROFIL 0x00000020 /* Has started profiling */
173 #define P_SELECT 0x00000040 /* Selecting; wakeup/waiting danger */
174 #define P_CONTINUED 0x00000080 /* Process was stopped and continued */
175
176 #define P_SUGID 0x00000100 /* Has set privileges since last exec */
177 #define P_SYSTEM 0x00000200 /* Sys proc: no sigs, stats or swap */
178 #define P_TIMEOUT 0x00000400 /* Timing out during sleep */
179 #define P_TRACED 0x00000800 /* Debugged process being traced */
180
181 #define P_DISABLE_ASLR 0x00001000 /* Disable address space layout randomization */
182 #define P_WEXIT 0x00002000 /* Working on exiting */
183 #define P_EXEC 0x00004000 /* Process called exec. */
184
185 /* Should be moved to machine-dependent areas. */
186 #define P_OWEUPC 0x00008000 /* Owe process an addupc() call at next ast. */
187
188 #define P_AFFINITY 0x00010000 /* xxx */
189 #define P_TRANSLATED 0x00020000 /* xxx */
190 #define P_CLASSIC P_TRANSLATED /* xxx */
191
192 #define P_DELAYIDLESLEEP 0x00040000 /* Process is marked to delay idle sleep on disk IO */
193 #define P_CHECKOPENEVT 0x00080000 /* check if a vnode has the OPENEVT flag set on open */
194
195 #define P_DEPENDENCY_CAPABLE 0x00100000 /* process is ok to call vfs_markdependency() */
196 #define P_REBOOT 0x00200000 /* Process called reboot() */
197 #define P_RESV6 0x00400000 /* used to be P_TBE */
198 #define P_RESV7 0x00800000 /* (P_SIGEXC)signal exceptions */
199
200 #define P_THCWD 0x01000000 /* process has thread cwd */
201 #define P_RESV9 0x02000000 /* (P_VFORK)process has vfork children */
202 #define P_ADOPTPERSONA 0x04000000 /* process adopted a persona (used to be P_NOATTACH) */
203 #define P_RESV11 0x08000000 /* (P_INVFORK) proc in vfork */
204
205 #define P_NOSHLIB 0x10000000 /* no shared libs are in use for proc */
206 /* flag set on exec */
207 #define P_FORCEQUOTA 0x20000000 /* Force quota for root */
208 #define P_NOCLDWAIT 0x40000000 /* No zombies when chil procs exit */
209 #define P_NOREMOTEHANG 0x80000000 /* Don't hang on remote FS ops */
210
211 #define P_INMEM 0 /* Obsolete: retained for compilation */
212 #define P_NOSWAP 0 /* Obsolete: retained for compilation */
213 #define P_PHYSIO 0 /* Obsolete: retained for compilation */
214 #define P_FSTRACE 0 /* Obsolete: retained for compilation */
215 #define P_SSTEP 0 /* Obsolete: retained for compilation */
216
217 #define P_DIRTY_TRACK 0x00000001 /* track dirty state */
218 #define P_DIRTY_ALLOW_IDLE_EXIT 0x00000002 /* process can be idle-exited when clean */
219 #define P_DIRTY_DEFER 0x00000004 /* defer initial opt-in to idle-exit */
220 #define P_DIRTY 0x00000008 /* process is dirty */
221 #define P_DIRTY_SHUTDOWN 0x00000010 /* process is dirty during shutdown */
222 #define P_DIRTY_TERMINATED 0x00000020 /* process has been marked for termination */
223 #define P_DIRTY_BUSY 0x00000040 /* serialization flag */
224 #define P_DIRTY_MARKED 0x00000080 /* marked dirty previously */
225 #define P_DIRTY_AGING_IN_PROGRESS 0x00000100 /* aging in one of the 'aging bands' */
226 #define P_DIRTY_LAUNCH_IN_PROGRESS 0x00000200 /* launch is in progress */
227 #define P_DIRTY_DEFER_ALWAYS 0x00000400 /* defer going to idle-exit after every dirty->clean transition.
228 * For legacy jetsam policy only. This is the default with the other policies.*/
229
230 #define P_DIRTY_IS_DIRTY (P_DIRTY | P_DIRTY_SHUTDOWN)
231 #define P_DIRTY_IDLE_EXIT_ENABLED (P_DIRTY_TRACK|P_DIRTY_ALLOW_IDLE_EXIT)
232
233 #endif /* XNU_KERNEL_PRIVATE || !KERNEL */
234
235 #ifdef KERNEL
236 __BEGIN_DECLS
237
238 extern proc_t kernproc;
239
240 extern int proc_is_classic(proc_t p);
241 extern bool proc_is_exotic(proc_t p);
242 extern bool proc_is_alien(proc_t p);
243 proc_t current_proc_EXTERNAL(void);
244
245 #if XNU_KERNEL_PRIVATE
246
247 extern bool proc_is_driver(proc_t p);
248 extern bool proc_is_third_party_debuggable_driver(proc_t p);
249
250 #endif /* XNU_KERNEL_PRIVATE */
251
252 #if KERNEL_PRIVATE
253 /*
254 * Identify a process uniquely.
255 * proc_ident's fields match 1-1 with those in struct proc.
256 */
257 struct proc_ident {
258 uint64_t p_uniqueid;
259 pid_t p_pid;
260 int p_idversion;
261 };
262
263 /* obtain a proc_ident from a proc_ref */
264 extern struct proc_ident proc_ident(proc_t p);
265 #else
266 struct proc_ident;
267 #endif /* KERNEL_PRIVATE */
268
269 /*
270 * __unsafe_indexable is a workaround for
271 * rdar://88409003 (PredefinedExpr trips C string detection)
272 */
273 extern int msleep(void *chan, lck_mtx_t *mtx, int pri, const char *__unsafe_indexable wmesg, struct timespec * ts );
274 extern int msleep0(void *chan, lck_mtx_t *mtx, int pri, const char *__unsafe_indexable wmesg, int timo, int (*continuation)(int));
275 extern void wakeup(void *chan);
276 extern void wakeup_one(caddr_t chan);
277
278 /* proc kpis */
279 /* this routine returns the pid of the current process */
280 extern int proc_selfpid(void);
281 /* this routine returns the pid of the parent of the current process */
282 extern int proc_selfppid(void);
283 /* this routine returns the csflags of the current process */
284 extern uint64_t proc_selfcsflags(void);
285 /* this routine populates the given flags param with the csflags of the given process. Returns 0 on success, -1 on error. */
286 extern int proc_csflags(proc_t p, uint64_t* flags);
287 /* this routine returns sends a signal signum to the process identified by the pid */
288 extern void proc_signal(int pid, int signum);
289 /* this routine checks whether any signal identified by the mask are pending in the process identified by the pid. The check is on all threads of the process. */
290 extern int proc_issignal(int pid, sigset_t mask);
291 /* this routine returns 1 if the pid1 is inferior of pid2 */
292 extern int proc_isinferior(int pid1, int pid2);
293 /* this routine copies the process's name of the executable to the passed in buffer. It
294 * is always null terminated. The size of the buffer is to be passed in as well. This
295 * routine is to be used typically for debugging
296 */
297 void proc_name(int pid, char * buf, int size);
298 /* returns the 32-byte name if it exists, otherwise returns the 16-byte name */
299 #ifdef XNU_KERNEL_PRIVATE
300 extern const char *proc_best_name(proc_t p);
301 #else
302 extern char *proc_best_name(proc_t p);
303 #endif
304 /* this routine is similar to proc_name except it returns for current process */
305 void proc_selfname(char * buf, int size);
306
307 /* find a process with a given pid. This comes with a reference which needs to be dropped by proc_rele */
308 extern proc_t proc_find(int pid);
309 /* find a process with a given process identity */
310 extern proc_t proc_find_ident(struct proc_ident const *i);
311 /* find a process with a given audit token */
312 extern proc_t proc_find_audit_token(const audit_token_t token);
313 /* returns a handle to current process which is referenced. The reference needs to be dropped with proc_rele */
314 extern proc_t proc_self(void);
315 /* releases the held reference on the process */
316 extern int proc_rele(proc_t p);
317 /* returns the pid of the given process */
318 extern int proc_pid(proc_t);
319 /* returns the pid of the parent of a given process */
320 extern int proc_ppid(proc_t);
321 /* returns the original pid of the parent of a given process */
322 extern int proc_original_ppid(proc_t);
323 /* returns the pid version of the original parent of a given process */
324 extern int proc_orig_ppidversion(proc_t);
325 /* returns the start time of the given process */
326 extern int proc_starttime(proc_t, struct timeval *);
327 /* returns whether the given process is on simulated platform */
328 extern boolean_t proc_is_simulated(const proc_t);
329 /* returns the platform (macos, ios, watchos, tvos, ...) of the given process */
330 extern uint32_t proc_platform(const proc_t);
331 /* returns the minimum sdk version used by the current process */
332 extern uint32_t proc_min_sdk(proc_t);
333 /* returns the sdk version used by the current process */
334 extern uint32_t proc_sdk(proc_t);
335 /* returns 1 if the process is marked for no remote hangs */
336 extern int proc_noremotehang(proc_t);
337 /* returns 1 if the process is marked for force quota */
338 extern int proc_forcequota(proc_t);
339 /* returns 1 if the process is chrooted */
340 extern int proc_chrooted(proc_t);
341 /* returns TRUE if a sync EXC_RESOURCE should be sent for the process */
342 extern boolean_t proc_send_synchronous_EXC_RESOURCE(proc_t p);
343
344 /* this routine returns 1 if the process is running with a 64bit address space, else 0 */
345 extern int proc_is64bit(proc_t);
346 /* this routine returns 1 if the process is running with a 64bit register state, else 0 */
347 extern int proc_is64bit_data(proc_t);
348 /* this routine returns 1 if the process is initproc */
349 extern int proc_isinitproc(proc_t);
350 /* is this process exiting? */
351 extern int proc_exiting(proc_t);
352 /* returns whether the process has started down proc_exit() */
353 extern int proc_in_teardown(proc_t);
354 /* this routine returns error if the process is not one with super user privileges */
355 extern int proc_suser(proc_t p);
356
357 /* returns the cred assicaited with the process; temporary api */
358 #if !BSD_KERNEL_PRIVATE
359 __deprecated_msg("proc_ucred is unsafe, use kauth_cred_proc_ref() or current_cached_proc_cred()")
360 kauth_cred_t proc_ucred(proc_t p);
361 #endif
362
363 /* returns 1 if the process is tainted by uid or gid changes,e else 0 */
364 extern int proc_issetugid(proc_t p);
365
366 extern int proc_tbe(proc_t);
367
368 /*!
369 * @function proc_gettty
370 * @abstract Copies the associated tty vnode for a given process if it exists. The caller needs to decrement the iocount of the vnode.
371 * @return 0 on success. ENOENT if the process has no associated TTY. EINVAL if arguments are NULL or vnode_getwithvid fails.
372 */
373 extern int proc_gettty(proc_t p, vnode_t *vp);
374
375 /* this routine populates the associated tty device for a given process if it exists, returns 0 on success or else returns EINVAL */
376 extern int proc_gettty_dev(proc_t p, dev_t *dev);
377
378 /*!
379 * @function proc_selfpgrpid
380 * @abstract Get the process group id for the current process, as with proc_pgrpid().
381 * @return pgrpid of current process.
382 */
383 pid_t proc_selfpgrpid(void);
384
385 /*!
386 * @function proc_pgrpid
387 * @abstract Get the process group id for the passed-in process.
388 * @param p Process whose pgrpid to grab.
389 * @return pgrpid for "p".
390 */
391 pid_t proc_pgrpid(proc_t p);
392
393 /*!
394 * @function proc_sessionid
395 * @abstract Get the process session id for the passed-in process.
396 * @param p Process whose session id to grab.
397 * @return session id of current process.
398 */
399 pid_t proc_sessionid(proc_t p);
400
401 #ifdef KERNEL_PRIVATE
402 // mark a process as being allowed to call vfs_markdependency()
403 void bsd_set_dependency_capable(task_t task);
404 #ifdef __arm__
405 static inline int
IS_64BIT_PROCESS(__unused proc_t p)406 IS_64BIT_PROCESS(__unused proc_t p)
407 {
408 return 0;
409 }
410 #else
411 extern int IS_64BIT_PROCESS(proc_t);
412 #endif /* __arm__ */
413
414 extern int tsleep(void *chan, int pri, const char *wmesg, int timo);
415 extern int msleep1(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, u_int64_t timo);
416
417 task_t proc_task(proc_t);
418 extern int proc_pidversion(proc_t);
419 extern proc_t proc_parent(proc_t);
420 extern void proc_parent_audit_token(proc_t, audit_token_t *);
421 extern uint32_t proc_persona_id(proc_t);
422 extern uint32_t proc_getuid(proc_t);
423 extern uint32_t proc_getgid(proc_t);
424 extern int proc_getcdhash(proc_t, unsigned char *);
425
426 /*!
427 * @function proc_pidbackgrounded
428 * @abstract KPI to determine if a process is currently backgrounded.
429 * @discussion The process may move into or out of background state at any time,
430 * so be prepared for this value to be outdated immediately.
431 * @param pid PID of the process to be queried.
432 * @param state Pointer to a value which will be set to 1 if the process
433 * is currently backgrounded, 0 otherwise.
434 * @return ESRCH if pid cannot be found or has started exiting.
435 *
436 * EINVAL if state is NULL.
437 */
438 extern int proc_pidbackgrounded(pid_t pid, uint32_t* state);
439
440 /*
441 * This returns an unique 64bit id of a given process.
442 * Caller needs to hold proper reference on the
443 * passed in process strucutre.
444 */
445 extern uint64_t proc_uniqueid(proc_t);
446
447 /* unique 64bit id for process's original parent */
448 extern uint64_t proc_puniqueid(proc_t);
449
450 extern void proc_set_responsible_pid(proc_t target_proc, pid_t responsible_pid);
451
452 /* return 1 if process is forcing case-sensitive HFS+ access, 0 for default */
453 extern int proc_is_forcing_hfs_case_sensitivity(proc_t);
454
455 /* returns 1 if the process is parent of a vfork */
456 extern int proc_lvfork(proc_t);
457
458 /* increments process block output operations counter. returns original value if valid long pointer was passed */
459 extern int proc_increment_ru_oublock(proc_t, long *);
460
461 /* Check if process is aborted, but not killed by a signal or is not the exiting thread or is not attempting to dump core */
462 extern int proc_isabortedsignal(proc_t);
463
464 /* return true if the process is translated, false for default */
465 extern boolean_t proc_is_translated(proc_t);
466
467 /* return true if this is an x86_64 process running under translation */
468 extern bool proc_is_x86_64_compat(proc_t);
469
470 /* true if the process ignores errors from content protection APIs */
471 extern bool proc_ignores_content_protection(proc_t proc);
472
473 /* true if the file system shouldn't update mtime for operations by the process */
474 extern bool proc_skip_mtime_update(proc_t proc);
475
476 /* true if syscalls support long paths */
477 extern bool proc_support_long_paths(proc_t proc);
478
479 /* return true if the process is flagged as allow-low-space */
480 extern bool proc_allow_low_space_writes(proc_t p);
481
482 /* return true if process needs to use alternative extended attribute for symlinks */
483 bool proc_use_alternative_symlink_ea(proc_t p);
484
485 /* return true if rsr is set for process */
486 bool proc_is_rsr(proc_t p);
487
488 /*
489 * Return true if the process disallows read or write access for files that
490 * it opens with O_EVTONLY.
491 */
492 extern bool proc_disallow_rw_for_o_evtonly(proc_t p);
493
494 /*!
495 * @function proc_exitstatus
496 * @abstract KPI to determine a process's exit status.
497 * @discussion This function is not safe to call if the process could be
498 * concurrently stopped or started, but it can be called from a
499 * mpo_proc_notify_exit callback.
500 * @param p The process to be queried.
501 * @return Value in the same format as wait()'s output parameter.
502 */
503 extern int proc_exitstatus(proc_t p);
504
505 /*!
506 * @function proc_is_zombie
507 * @abstract KPI to determine if the provided process is a zombie
508 * @discussion This lookup is atomic and safe to call with either a proc ref or
509 * or a zombie ref.
510 * @param p The process to be queried.
511 * @return Boolean indicating whether the process has been removed from the primary proclist
512 * and moved to the zombproc list.
513 */
514 extern bool proc_is_zombie(proc_t p);
515
516 #endif /* KERNEL_PRIVATE */
517
518 #ifdef XNU_KERNEL_PRIVATE
519
520 extern void proc_getexecutableuuid(proc_t, unsigned char *, unsigned long);
521 extern int proc_get_originatorbgstate(uint32_t *is_backgrounded);
522
523 /* Kernel interface to get the uuid of the originator of the work.*/
524 extern int proc_pidoriginatoruuid(uuid_t uuid_buf, uint32_t buffersize);
525
526 extern uint64_t proc_was_throttled(proc_t);
527 extern uint64_t proc_did_throttle(proc_t);
528 extern bool proc_is_traced(proc_t p);
529
530 extern void proc_coalitionids(proc_t, uint64_t[COALITION_NUM_TYPES]);
531
532 extern uint64_t get_current_unique_pid(void);
533 #endif /* XNU_KERNEL_PRIVATE*/
534
535 #ifdef KERNEL_PRIVATE
536 /* If buf argument is NULL, the necessary length to allocate will be set in buflen */
537 extern int proc_selfexecutableargs(uint8_t *buf, size_t *buflen);
538 extern off_t proc_getexecutableoffset(proc_t p);
539 extern vnode_t proc_getexecutablevnode(proc_t); /* Returned with iocount, use vnode_put() to drop */
540 extern vnode_t proc_getexecutablevnode_noblock(proc_t); /* Returned with iocount, use vnode_put() to drop */
541
542 /* System call filtering for BSD syscalls, mach traps and kobject routines. */
543 #define SYSCALL_MASK_UNIX 0
544 #define SYSCALL_MASK_MACH 1
545 #define SYSCALL_MASK_KOBJ 2
546
547 #define SYSCALL_FILTER_CALLBACK_VERSION 1
548 typedef int (*syscall_filter_cbfunc_t)(proc_t p, int num);
549 typedef int (*kobject_filter_cbfunc_t)(proc_t p, int msgid, int idx);
550 struct syscall_filter_callbacks {
551 int version;
552 const syscall_filter_cbfunc_t unix_filter_cbfunc;
553 const syscall_filter_cbfunc_t mach_filter_cbfunc;
554 const kobject_filter_cbfunc_t kobj_filter_cbfunc;
555 };
556 typedef struct syscall_filter_callbacks * syscall_filter_cbs_t;
557
558 extern int proc_set_syscall_filter_callbacks(syscall_filter_cbs_t callback);
559 extern int proc_set_syscall_filter_index(int which, int num, int index);
560 extern size_t proc_get_syscall_filter_mask_size(int which);
561 extern unsigned char *proc_get_syscall_filter_mask(proc_t p, int which);
562 extern int proc_set_syscall_filter_mask(proc_t p, int which, unsigned char *maskptr, size_t masklen);
563
564 extern int proc_set_filter_message_flag(proc_t p, boolean_t flag);
565 extern int proc_get_filter_message_flag(proc_t p, boolean_t *flag);
566
567 #endif /* KERNEL_PRIVATE */
568
569 __END_DECLS
570
571 #endif /* KERNEL */
572
573 #ifdef PRIVATE
574
575 /* Values for pid_shutdown_sockets */
576 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_SVC 0x00000001
577 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_ALL 0x00000002
578
579 #ifdef KERNEL
580 #define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_INTERNAL 0x10000000
581 #define SHUTDOWN_SOCKET_LEVEL_NECP 0x20000000
582 #define SHUTDOWN_SOCKET_LEVEL_CONTENT_FILTER 0x40000000
583 #endif
584
585 #ifndef KERNEL
586
587 __BEGIN_DECLS
588
589 int pid_suspend(int pid);
590 int pid_resume(int pid);
591 __API_AVAILABLE(macos(11.3), ios(14.5), tvos(14.5), watchos(7.3))
592 int task_inspect_for_pid(unsigned int target_tport, int pid, unsigned int *t); /* Returns task inspect port */
593 __API_AVAILABLE(macos(11.3), ios(14.5), tvos(14.5), watchos(7.3))
594 int task_read_for_pid(unsigned int target_tport, int pid, unsigned int *t); /* Returns task read port */
595
596 #if defined(__arm__) || defined(__arm64__)
597 int pid_hibernate(int pid);
598 #endif /* defined(__arm__) || defined(__arm64__) */
599 int pid_shutdown_sockets(int pid, int level);
600 int pid_shutdown_networking(int pid, int level);
601 __END_DECLS
602
603 #endif /* !KERNEL */
604
605 /* Entitlement to allow non-root processes to suspend/resume any task */
606 #define PROCESS_RESUME_SUSPEND_ENTITLEMENT "com.apple.private.process.suspend-resume.any"
607
608 #endif /* PRIVATE */
609
610 #endif /* !_SYS_PROC_H_ */
611