/*
- * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2018 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
- *
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- *
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- *
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*-
#include <sys/lock.h>
#include <sys/param.h>
#include <sys/event.h>
+#include <sys/time.h>
#ifdef KERNEL
#include <sys/kernel_types.h>
+#include <uuid/uuid.h>
#endif
#include <mach/boolean.h>
#ifdef XNU_KERNEL_PRIVATE
-#define PROC_DEF_ENABLED
-#else
-#ifndef KERNEL
-#define PROC_DEF_ENABLED
-#endif
+#include <mach/coalition.h> /* COALITION_NUM_TYPES */
#endif
-#ifdef PROC_DEF_ENABLED
+#if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL)
struct session;
struct pgrp;
u_quad_t p_iticks; /* Statclock hits processing intr. */
int p_traceflag; /* Kernel trace points. */
struct vnode *p_tracep; /* Trace to vnode. */
- int p_siglist; /* DEPRECATED */
+ int p_siglist; /* DEPRECATED. */
struct vnode *p_textvp; /* Vnode of executable. */
int p_holdcnt; /* If non-zero, don't swap. */
sigset_t p_sigmask; /* DEPRECATED. */
#define SSTOP 4 /* Process debugging or suspension. */
#define SZOMB 5 /* Awaiting collection by parent. */
-/* These flags are kept in p_flags. */
+/* These flags are kept in extern_proc.p_flag. */
#define P_ADVLOCK 0x00000001 /* Process may hold POSIX adv. lock */
#define P_CONTROLT 0x00000002 /* Has a controlling terminal */
#define P_LP64 0x00000004 /* Process is LP64 */
#define P_TIMEOUT 0x00000400 /* Timing out during sleep */
#define P_TRACED 0x00000800 /* Debugged process being traced */
-#define P_WAITED 0x00001000 /* Debugging prc has waited for child */
-#define P_WEXIT 0x00002000 /* Working on exiting. */
+#define P_DISABLE_ASLR 0x00001000 /* Disable address space layout randomization */
+#define P_WEXIT 0x00002000 /* Working on exiting */
#define P_EXEC 0x00004000 /* Process called exec. */
/* Should be moved to machine-dependent areas. */
#define P_OWEUPC 0x00008000 /* Owe process an addupc() call at next ast. */
#define P_AFFINITY 0x00010000 /* xxx */
-#define P_CLASSIC 0x00020000 /* xxx */
-/*
-#define P_FSTRACE 0x10000 / * tracing via file system (elsewhere?) * /
-#define P_SSTEP 0x20000 / * process needs single-step fixup ??? * /
-*/
+#define P_TRANSLATED 0x00020000 /* xxx */
+#define P_CLASSIC P_TRANSLATED /* xxx */
-#define P_WAITING 0x00040000 /* process has a wait() in progress */
-#define P_KDEBUG 0x00080000 /* kdebug tracing on for this process */
+#define P_DELAYIDLESLEEP 0x00040000 /* Process is marked to delay idle sleep on disk IO */
+#define P_CHECKOPENEVT 0x00080000 /* check if a vnode has the OPENEVT flag set on open */
-#define P_TTYSLEEP 0x00100000 /* blocked due to SIGTTOU or SIGTTIN */
+#define P_DEPENDENCY_CAPABLE 0x00100000 /* process is ok to call vfs_markdependency() */
#define P_REBOOT 0x00200000 /* Process called reboot() */
-#define P_TBE 0x00400000 /* Process is TBE */
-#define P_SIGEXC 0x00800000 /* signal exceptions */
+#define P_RESV6 0x00400000 /* used to be P_TBE */
+#define P_RESV7 0x00800000 /* (P_SIGEXC)signal exceptions */
-#define P_BTRACE 0x01000000 /* process is being branch traced */
-#define P_VFORK 0x02000000 /* process has vfork children */
-#define P_NOATTACH 0x04000000
-#define P_INVFORK 0x08000000 /* proc in vfork */
+#define P_THCWD 0x01000000 /* process has thread cwd */
+#define P_RESV9 0x02000000 /* (P_VFORK)process has vfork children */
+#define P_ADOPTPERSONA 0x04000000 /* process adopted a persona (used to be P_NOATTACH) */
+#define P_RESV11 0x08000000 /* (P_INVFORK) proc in vfork */
#define P_NOSHLIB 0x10000000 /* no shared libs are in use for proc */
/* flag set on exec */
#define P_FSTRACE 0 /* Obsolete: retained for compilation */
#define P_SSTEP 0 /* Obsolete: retained for compilation */
-#endif /* PROC_DEF_ENABLED */
+#define P_DIRTY_TRACK 0x00000001 /* track dirty state */
+#define P_DIRTY_ALLOW_IDLE_EXIT 0x00000002 /* process can be idle-exited when clean */
+#define P_DIRTY_DEFER 0x00000004 /* defer initial opt-in to idle-exit */
+#define P_DIRTY 0x00000008 /* process is dirty */
+#define P_DIRTY_SHUTDOWN 0x00000010 /* process is dirty during shutdown */
+#define P_DIRTY_TERMINATED 0x00000020 /* process has been marked for termination */
+#define P_DIRTY_BUSY 0x00000040 /* serialization flag */
+#define P_DIRTY_MARKED 0x00000080 /* marked dirty previously */
+#define P_DIRTY_AGING_IN_PROGRESS 0x00000100 /* aging in one of the 'aging bands' */
+#define P_DIRTY_LAUNCH_IN_PROGRESS 0x00000200 /* launch is in progress */
+#define P_DIRTY_DEFER_ALWAYS 0x00000400 /* defer going to idle-exit after every dirty->clean transition.
+ * For legacy jetsam policy only. This is the default with the other policies.*/
+
+#define P_DIRTY_IS_DIRTY (P_DIRTY | P_DIRTY_SHUTDOWN)
+#define P_DIRTY_IDLE_EXIT_ENABLED (P_DIRTY_TRACK|P_DIRTY_ALLOW_IDLE_EXIT)
+
+#endif /* XNU_KERNEL_PRIVATE || !KERNEL */
#ifdef KERNEL
__BEGIN_DECLS
extern proc_t kernproc;
-extern int proc_is_classic(struct proc *p);
-struct proc *current_proc_EXTERNAL(void);
+extern int proc_is_classic(proc_t p);
+proc_t current_proc_EXTERNAL(void);
extern int msleep(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, struct timespec * ts );
-extern void unsleep(struct proc *);
extern void wakeup(void *chan);
extern void wakeup_one(caddr_t chan);
extern int proc_selfpid(void);
/* this routine returns the pid of the parent of the current process */
extern int proc_selfppid(void);
+/* this routine returns the csflags of the current process */
+extern int proc_selfcsflags(void);
/* this routine returns sends a signal signum to the process identified by the pid */
extern void proc_signal(int pid, int signum);
/* 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. */
extern int proc_issignal(int pid, sigset_t mask);
/* this routine returns 1 if the pid1 is inferior of pid2 */
extern int proc_isinferior(int pid1, int pid2);
-/* this routine copies the process's name of the executable to the passed in buffer. It
- * is always null terminated. The size of the buffer is to be passed in as well. This
- * routine is to be used typically for debugging
+/* this routine copies the process's name of the executable to the passed in buffer. It
+ * is always null terminated. The size of the buffer is to be passed in as well. This
+ * routine is to be used typically for debugging
*/
void proc_name(int pid, char * buf, int size);
+/* returns the 32-byte name if it exists, otherwise returns the 16-byte name */
+extern char *proc_best_name(proc_t p);
/* This routine is simillar to proc_name except it returns for current process */
void proc_selfname(char * buf, int size);
extern int proc_ppid(proc_t);
/* returns 1 if the process is marked for no remote hangs */
extern int proc_noremotehang(proc_t);
-/* returns 1 is the process is marked for force quota */
+/* returns 1 if the process is marked for force quota */
extern int proc_forcequota(proc_t);
+/* returns 1 if the process is chrooted */
+extern int proc_chrooted(proc_t);
+/* returns TRUE if a sync EXC_RESOURCE should be sent for the process */
+extern boolean_t proc_send_synchronous_EXC_RESOURCE(proc_t p);
-/* this routine returns 1 if the process is running with 64bit address space, else 0 */
+/* this routine returns 1 if the process is running with a 64bit address space, else 0 */
extern int proc_is64bit(proc_t);
+/* this routine returns 1 if the process is running with a 64bit register state, else 0 */
+extern int proc_is64bit_data(proc_t);
/* is this process exiting? */
extern int proc_exiting(proc_t);
-/* this routine returns error is the process is not one with super user privileges */
-int proc_suser(struct proc *p);
-/* returns the ucred assicaited with the process; temporary api */
-struct ucred * proc_ucred(struct proc *p);
+/* returns whether the process has started down proc_exit() */
+extern int proc_in_teardown(proc_t);
+/* this routine returns error if the process is not one with super user privileges */
+int proc_suser(proc_t p);
+/* returns the cred assicaited with the process; temporary api */
+kauth_cred_t proc_ucred(proc_t p);
+/* returns 1 if the process is tainted by uid or gid changes,e else 0 */
+extern int proc_issetugid(proc_t p);
+
+extern int proc_tbe(proc_t);
+
+/*!
+ @function proc_selfpgrpid
+ @abstract Get the process group id for the current process, as with proc_pgrpid().
+ @return pgrpid of current process.
+ */
+pid_t proc_selfpgrpid(void);
-/* LP64todo - figure out how to identify 64-bit processes if NULL procp */
-extern int IS_64BIT_PROCESS(proc_t);
-extern int proc_pendingsignals(struct proc *, sigset_t);
-extern int proc_tbe(struct proc *);
+/*!
+ @function proc_pgrpid
+ @abstract Get the process group id for the passed-in process.
+ @param p Process whose pgrpid to grab.
+ @return pgrpid for "p".
+ */
+pid_t proc_pgrpid(proc_t p);
#ifdef KERNEL_PRIVATE
+// mark a process as being allowed to call vfs_markdependency()
+void bsd_set_dependency_capable(task_t task);
+#ifdef __arm__
+static inline int IS_64BIT_PROCESS(__unused proc_t p) { return 0; }
+#else
+extern int IS_64BIT_PROCESS(proc_t);
+#endif /* __arm__ */
+
extern int tsleep(void *chan, int pri, const char *wmesg, int timo);
extern int msleep1(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, u_int64_t timo);
+
+task_t proc_task(proc_t);
+extern int proc_pidversion(proc_t);
+extern uint32_t proc_persona_id(proc_t);
+extern uint32_t proc_getuid(proc_t);
+extern uint32_t proc_getgid(proc_t);
+extern int proc_getcdhash(proc_t, unsigned char *);
+
+/*!
+ @function proc_pidbackgrounded
+ @abstract KPI to determine if a process is currently backgrounded.
+ @discussion The process may move into or out of background state at any time,
+ so be prepared for this value to be outdated immediately.
+ @param pid PID of the process to be queried.
+ @param state Pointer to a value which will be set to 1 if the process
+ is currently backgrounded, 0 otherwise.
+ @return ESRCH if pid cannot be found or has started exiting.
+
+ EINVAL if state is NULL.
+ */
+extern int proc_pidbackgrounded(pid_t pid, uint32_t* state);
+
+/*
+ * This returns an unique 64bit id of a given process.
+ * Caller needs to hold proper reference on the
+ * passed in process strucutre.
+ */
+extern uint64_t proc_uniqueid(proc_t);
+
+extern void proc_set_responsible_pid(proc_t target_proc, pid_t responsible_pid);
+
+/* return 1 if process is forcing case-sensitive HFS+ access, 0 for default */
+extern int proc_is_forcing_hfs_case_sensitivity(proc_t);
+
+#endif /* KERNEL_PRIVATE */
+
+#ifdef XNU_KERNEL_PRIVATE
+
+/* unique 64bit id for process's original parent */
+extern uint64_t proc_puniqueid(proc_t);
+
+extern void proc_getexecutableuuid(proc_t, unsigned char *, unsigned long);
+extern int proc_get_originatorbgstate(uint32_t *is_backgrounded);
+
+/* Kernel interface to get the uuid of the originator of the work.*/
+extern int proc_pidoriginatoruuid(uuid_t uuid_buf, uint32_t buffersize);
+
+extern uint64_t proc_was_throttled(proc_t);
+extern uint64_t proc_did_throttle(proc_t);
+
+extern void proc_coalitionids(proc_t, uint64_t [COALITION_NUM_TYPES]);
+
+#ifdef CONFIG_32BIT_TELEMETRY
+extern void proc_log_32bit_telemetry(proc_t p);
+#endif /* CONFIG_32BIT_TELEMETRY */
+extern uint64_t get_current_unique_pid(void);
+#endif /* XNU_KERNEL_PRIVATE*/
+
+#ifdef KERNEL_PRIVATE
+extern vnode_t proc_getexecutablevnode(proc_t); /* Returned with iocount, use vnode_put() to drop */
+extern int networking_memstatus_callout(proc_t p, uint32_t);
#endif
__END_DECLS
#endif /* KERNEL */
+#ifdef PRIVATE
+
+/* Values for pid_shutdown_sockets */
+#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_SVC 0x00000001
+#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_ALL 0x00000002
+
+#ifdef KERNEL
+#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_INTERNAL 0x10000000
+#define SHUTDOWN_SOCKET_LEVEL_NECP 0x20000000
+#define SHUTDOWN_SOCKET_LEVEL_CONTENT_FILTER 0x40000000
+#endif
+
+#ifndef KERNEL
+
+__BEGIN_DECLS
+
+int pid_suspend(int pid);
+int pid_resume(int pid);
+
+#if defined(__arm__) || defined(__arm64__)
+int pid_hibernate(int pid);
+#endif /* defined(__arm__) || defined(__arm64__) */
+int pid_shutdown_sockets(int pid, int level);
+int pid_shutdown_networking(int pid, int level);
+__END_DECLS
+
+#endif /* !KERNEL */
+#endif /* PRIVATE */
+
#endif /* !_SYS_PROC_H_ */