1/*
2 * Copyright (c) 2006, 2007, 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_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. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23#ifndef _LIBPROC_H_
24#define _LIBPROC_H_
25
26#include <sys/cdefs.h>
27#include <sys/param.h>
28#include <sys/types.h>
29#include <sys/stat.h>
30#include <sys/mount.h>
31#include <sys/resource.h>
32#include <stdint.h>
33#include <stdbool.h>
34#include <mach/message.h> /* for audit_token_t */
35
36#include <sys/proc_info.h>
37
38#include <Availability.h>
39#include <os/availability.h>
40
41/*
42 * This header file contains private interfaces to obtain process information.
43 * These interfaces are subject to change in future releases.
44 */
45
46/*!
47 * @define PROC_LISTPIDSPATH_PATH_IS_VOLUME
48 * @discussion This flag indicates that all processes that hold open
49 * file references on the volume associated with the specified
50 * path should be returned.
51 */
52#define PROC_LISTPIDSPATH_PATH_IS_VOLUME 1
53
54
55/*!
56 * @define PROC_LISTPIDSPATH_EXCLUDE_EVTONLY
57 * @discussion This flag indicates that file references that were opened
58 * with the O_EVTONLY flag should be excluded from the matching
59 * criteria.
60 */
61#define PROC_LISTPIDSPATH_EXCLUDE_EVTONLY 2
62
63__BEGIN_DECLS
64
65
66/*!
67 * @function proc_listpidspath
68 * @discussion A function which will search through the current
69 * processes looking for open file references which match
70 * a specified path or volume.
71 * @param type types of processes to be searched (see proc_listpids)
72 * @param typeinfo adjunct information for type
73 * @param path file or volume path
74 * @param pathflags flags to control which files should be considered
75 * during the process search.
76 * @param buffer a C array of int-sized values to be filled with
77 * process identifiers that hold an open file reference
78 * matching the specified path or volume. Pass NULL to
79 * obtain the minimum buffer size needed to hold the
80 * currently active processes.
81 * @param buffersize the size (in bytes) of the provided buffer.
82 * @result the number of bytes of data returned in the provided buffer;
83 * -1 if an error was encountered;
84 */
85int proc_listpidspath(uint32_t type,
86 uint32_t typeinfo,
87 const char *path,
88 uint32_t pathflags,
89 void *buffer,
90 int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
91
92int proc_listpids(uint32_t type, uint32_t typeinfo, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
93int proc_listallpids(void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
94int proc_listpgrppids(pid_t pgrpid, void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
95int proc_listchildpids(pid_t ppid, void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
96int proc_pidinfo(int pid, int flavor, uint64_t arg, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
97int proc_pidfdinfo(int pid, int fd, int flavor, void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
98int proc_pidfileportinfo(int pid, uint32_t fileport, int flavor, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
99int proc_name(int pid, void * buffer, uint32_t buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
100int proc_regionfilename(int pid, uint64_t address, void * buffer, uint32_t buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
101int proc_kmsgbuf(void * buffer, uint32_t buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
102int proc_pidpath(int pid, void * buffer, uint32_t buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
103int proc_pidpath_audittoken(audit_token_t *audittoken, void * buffer, uint32_t buffersize) API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
104int proc_libversion(int *major, int * minor) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
105
106/*
107 * Return resource usage information for the given pid, which can be a live process or a zombie.
108 *
109 * Returns 0 on success; or -1 on failure, with errno set to indicate the specific error.
110 */
111int proc_pid_rusage(int pid, int flavor, rusage_info_t *buffer) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0);
112
113/*
114 * A process can use the following api to set its own process control
115 * state on resoure starvation. The argument can have one of the PROC_SETPC_XX values
116 */
117#define PROC_SETPC_NONE 0
118#define PROC_SETPC_THROTTLEMEM 1
119#define PROC_SETPC_SUSPEND 2
120#define PROC_SETPC_TERMINATE 3
121
122int proc_setpcontrol(const int control) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
123int proc_setpcontrol(const int control);
124
125int proc_track_dirty(pid_t pid, uint32_t flags);
126int proc_set_dirty(pid_t pid, bool dirty);
127int proc_get_dirty(pid_t pid, uint32_t *flags);
128int proc_clear_dirty(pid_t pid, uint32_t flags);
129
130int proc_terminate(pid_t pid, int *sig);
131int proc_terminate_all_rsr(int sig);
132int proc_signal_with_audittoken(audit_token_t *audittoken, int sig);
133int proc_terminate_with_audittoken(audit_token_t *audittoken, int *sig);
134int proc_signal_delegate(audit_token_t instigator, audit_token_t target, int sig);
135int proc_terminate_delegate(audit_token_t instigator, audit_token_t target, int *sig);
136
137/*
138 * NO_SMT means that on an SMT CPU, this thread must be scheduled alone,
139 * with the paired CPU idle.
140 *
141 * Set NO_SMT on the current proc (all existing and future threads)
142 * This attribute is inherited on fork and exec
143 */
144int proc_set_no_smt(void) __API_AVAILABLE(macos(11.0));
145
146/* Set NO_SMT on the current thread */
147int proc_setthread_no_smt(void) __API_AVAILABLE(macos(11.0));
148
149/*
150 * CPU Security Mitigation APIs
151 *
152 * Set CPU security mitigation on the current proc (all existing and future threads)
153 * This attribute is inherited on fork and exec
154 */
155int proc_set_csm(uint32_t flags) __API_AVAILABLE(macos(11.0));
156
157/* Set CPU security mitigation on the current thread */
158int proc_setthread_csm(uint32_t flags) __API_AVAILABLE(macos(11.0));
159
160/*
161 * flags for CPU Security Mitigation APIs
162 * PROC_CSM_ALL should be used in most cases,
163 * the individual flags are provided only for performance evaluation etc
164 */
165#define PROC_CSM_ALL 0x0001 /* Set all available mitigations */
166#define PROC_CSM_NOSMT 0x0002 /* Set NO_SMT - see above */
167#define PROC_CSM_TECS 0x0004 /* Execute VERW on every return to user mode */
168
169int proc_udata_info(int pid, int flavor, void *buffer, int buffersize);
170
171__END_DECLS
172
173#endif /*_LIBPROC_H_ */