1/*
2 * Copyright (c) 2016 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
29#ifndef _REASON_H_
30#define _REASON_H_
31
32#include <stdint.h>
33
34__BEGIN_DECLS
35
36#ifdef KERNEL_PRIVATE
37
38#include <kern/kern_cdata.h>
39
40#ifdef XNU_KERNEL_PRIVATE
41#include <kern/locks.h>
42
43typedef struct os_reason {
44 decl_lck_mtx_data(, osr_lock)
45 unsigned int osr_refcount;
46 uint32_t osr_namespace;
47 uint64_t osr_code;
48 uint64_t osr_flags;
49 uint32_t osr_bufsize;
50 struct kcdata_descriptor osr_kcd_descriptor;
51 char *osr_kcd_buf;
52} *os_reason_t;
53
54#define OS_REASON_NULL ((os_reason_t) 0)
55
56/* We only include 800 bytes of the exit reason description to not blow through the panic buffer */
57#define LAUNCHD_PANIC_REASON_STRING_MAXLEN "800"
58
59void os_reason_init(void);
60
61os_reason_t build_userspace_exit_reason(uint32_t reason_namespace, uint64_t reason_code, user_addr_t payload, uint32_t payload_size,
62 user_addr_t reason_string, uint64_t reason_flags);
63char *launchd_exit_reason_get_string_desc(os_reason_t exit_reason);
64
65/* The blocking allocation is currently not exported to KEXTs */
66int os_reason_alloc_buffer(os_reason_t cur_reason, uint32_t osr_bufsize);
67
68#else /* XNU_KERNEL_PRIVATE */
69
70typedef void * os_reason_t;
71
72#endif /* XNU_KERNEL_PRIVATE */
73
74os_reason_t os_reason_create(uint32_t osr_namespace, uint64_t osr_code);
75int os_reason_alloc_buffer_noblock(os_reason_t cur_reason, uint32_t osr_bufsize);
76struct kcdata_descriptor * os_reason_get_kcdata_descriptor(os_reason_t cur_reason);
77void os_reason_ref(os_reason_t cur_reason);
78void os_reason_free(os_reason_t cur_reason);
79
80#endif /* KERNEL_PRIVATE */
81
82/*
83 * Reason namespaces.
84 */
85#define OS_REASON_INVALID 0
86#define OS_REASON_JETSAM 1
87#define OS_REASON_SIGNAL 2
88#define OS_REASON_CODESIGNING 3
89#define OS_REASON_HANGTRACER 4
90#define OS_REASON_TEST 5
91#define OS_REASON_DYLD 6
92#define OS_REASON_LIBXPC 7
93#define OS_REASON_OBJC 8
94#define OS_REASON_EXEC 9
95#define OS_REASON_SPRINGBOARD 10
96#define OS_REASON_TCC 11
97#define OS_REASON_REPORTCRASH 12
98#define OS_REASON_COREANIMATION 13
99#define OS_REASON_AGGREGATED 14
100#define OS_REASON_ASSERTIOND 15
101#define OS_REASON_SKYWALK 16
102#define OS_REASON_SETTINGS 17
103#define OS_REASON_LIBSYSTEM 18
104#define OS_REASON_FOUNDATION 19
105#define OS_REASON_WATCHDOG 20
106#define OS_REASON_METAL 21
107#define OS_REASON_WATCHKIT 22
108#define OS_REASON_GUARD 23
109#define OS_REASON_ANALYTICS 24
110
111/*
112 * Update whenever new OS_REASON namespaces are added.
113 */
114#define OS_REASON_MAX_VALID_NAMESPACE OS_REASON_ANALYTICS
115
116#define OS_REASON_BUFFER_MAX_SIZE 5120
117
118#define OS_REASON_FLAG_NO_CRASH_REPORT 0x1 /* Don't create a crash report */
119#define OS_REASON_FLAG_GENERATE_CRASH_REPORT 0x2 /* Create a crash report - the default for userspace requests */
120#define OS_REASON_FLAG_FROM_USERSPACE 0x4 /* Reason created from a userspace syscall */
121#define OS_REASON_FLAG_FAILED_DATA_COPYIN 0x8 /* We failed to copyin data from userspace */
122#define OS_REASON_FLAG_PAYLOAD_TRUNCATED 0x10 /* The payload was truncated because it was longer than allowed */
123#define OS_REASON_FLAG_BAD_PARAMS 0x20 /* Invalid parameters were passed involved with creating this reason */
124#define OS_REASON_FLAG_CONSISTENT_FAILURE 0x40 /* Whatever caused this reason to be created will happen again */
125#define OS_REASON_FLAG_ONE_TIME_FAILURE 0x80 /* Whatever caused this reason to be created was a one time issue */
126#define OS_REASON_FLAG_NO_CRASHED_TID 0x100 /* Don't include the TID that processed the exit in the crash report */
127#define OS_REASON_FLAG_ABORT 0x200 /* Reason created from abort_* rather than terminate_* */
128
129/*
130 * Set of flags that are allowed to be passed from userspace
131 */
132#define OS_REASON_FLAG_MASK_ALLOWED_FROM_USER (OS_REASON_FLAG_CONSISTENT_FAILURE | OS_REASON_FLAG_ONE_TIME_FAILURE | OS_REASON_FLAG_NO_CRASH_REPORT | OS_REASON_FLAG_ABORT)
133
134/*
135 * Macros to encode the exit reason namespace and first 32 bits of code in exception code
136 * which is used by Report Crash as a hint. It should be only used as a hint since it
137 * looses higher 32 bits of exit reason code.
138 */
139#define ENCODE_OSR_NAMESPACE_TO_MACH_EXCEPTION_CODE(code, osr_namespace) \
140 (code) = (code) | (((osr_namespace) & ((uint64_t)UINT32_MAX)) << 32)
141#define ENCODE_OSR_CODE_TO_MACH_EXCEPTION_CODE(code, osr_code) \
142 (code) = (code) | ((osr_code) & ((uint64_t)UINT32_MAX))
143
144#ifndef KERNEL
145/*
146 * abort_with_reason: Used to exit the current process and pass along
147 * specific information about why it is being terminated.
148 *
149 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason
150 * args->reason_code - code in the specified namespace for the reason
151 * args->reason_string - additional string formatted information about the request
152 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above).
153 *
154 * Outputs: Does not return.
155 */
156void abort_with_reason(uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags) __attribute__((noreturn));
157
158/*
159 * abort_with_payload: Used to exit the current process and pass along
160 * specific information about why it is being terminated. The payload pointer
161 * should point to structured data that can be interpreted by the consumer of
162 * exit reason information.
163 *
164 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason
165 * args->reason_code - code in the specified namespace for the reason
166 * args->payload - pointer to payload structure in user space
167 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN)
168 * args->reason_string - additional string formatted information about the request
169 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above).
170 *
171 * Outputs: Does not return.
172 */
173void abort_with_payload(uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size, const char *reason_string,
174 uint64_t reason_flags) __attribute__((noreturn));
175
176/*
177 * terminate_with_reason: Used to terminate a specific process and pass along
178 * specific information about why it is being terminated.
179 *
180 * Inputs: args->pid - the PID of the process to be terminated
181 * args->reason_namespace - OS_REASON namespace specified for the reason
182 * args->reason_code - code in the specified namespace for the reason
183 * args->reason_string - additional string formatted information about the request
184 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above)
185 *
186 * Outputs: EINVAL if the PID requested is the same as that of the calling process, invalid or the namespace provided is invalid.
187 * ESRCH if we couldn't find a live process with the requested PID
188 * EPERM if the caller is not privileged enough to kill the process with the requested PID
189 * returns 0 otherwise
190 */
191int terminate_with_reason(int pid, uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags);
192
193/*
194 * terminate_with_payload: Used to terminate a specific process and pass along
195 * specific information about why it is being terminated. The payload pointer
196 * should point to structured data that can be interpreted by the consumer of
197 * exit reason information.
198 *
199 * Inputs: args->pid - the PID of the process to be terminated.
200 * args->reason_namespace - OS_REASON namespace specified for the reason
201 * args->reason_code - code in the specified namespace for the reason
202 * args->payload - pointer to payload structure in user space
203 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN)
204 * args->reason_string - additional string formatted information about the request
205 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above)
206 *
207 * Outputs: EINVAL if the PID requested is the same as that of the calling process, is invalid or the namespace provided is invalid.
208 * ESRCH if we couldn't find a live process with the requested PID
209 * EPERM if the caller is not privileged enough to kill the process with the requested PID
210 * returns 0 otherwise
211 */
212int terminate_with_payload(int pid, uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size,
213 const char *reason_string, uint64_t reason_flags);
214#endif /* KERNEL */
215
216/*
217 * codesigning exit reasons
218 */
219#define CODESIGNING_EXIT_REASON_TASKGATED_INVALID_SIG 1
220#define CODESIGNING_EXIT_REASON_INVALID_PAGE 2
221#define CODESIGNING_EXIT_REASON_TASK_ACCESS_PORT 3
222
223/*
224 * exec path specific exit reasons
225 */
226#define EXEC_EXIT_REASON_BAD_MACHO 1
227#define EXEC_EXIT_REASON_SUGID_FAILURE 2
228#define EXEC_EXIT_REASON_ACTV_THREADSTATE 3
229#define EXEC_EXIT_REASON_STACK_ALLOC 4
230#define EXEC_EXIT_REASON_APPLE_STRING_INIT 5
231#define EXEC_EXIT_REASON_COPYOUT_STRINGS 6
232#define EXEC_EXIT_REASON_COPYOUT_DYNLINKER 7
233#define EXEC_EXIT_REASON_SECURITY_POLICY 8
234#define EXEC_EXIT_REASON_TASKGATED_OTHER 9
235#define EXEC_EXIT_REASON_FAIRPLAY_DECRYPT 10
236#define EXEC_EXIT_REASON_DECRYPT 11
237#define EXEC_EXIT_REASON_UPX 12
238#define EXEC_EXIT_REASON_NO32EXEC 13
239
240/*
241 * guard reasons
242 */
243#define GUARD_REASON_VNODE 1
244#define GUARD_REASON_VIRT_MEMORY 2
245#define GUARD_REASON_MACH_PORT 3
246
247__END_DECLS
248
249#endif /* _REASON_H_ */
250