]> git.saurik.com Git - apple/xnu.git/blob - bsd/sys/reason.h
xnu-3789.41.3.tar.gz
[apple/xnu.git] / bsd / sys / reason.h
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
43 typedef struct os_reason {
44 decl_lck_mtx_data(, osr_lock)
45 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
59 void os_reason_init(void);
60
61 os_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);
63 char *launchd_exit_reason_get_string_desc(os_reason_t exit_reason);
64
65 /* The blocking allocation is currently not exported to KEXTs */
66 int os_reason_alloc_buffer(os_reason_t cur_reason, uint32_t osr_bufsize);
67
68 #else /* XNU_KERNEL_PRIVATE */
69
70 typedef void * os_reason_t;
71
72 #endif /* XNU_KERNEL_PRIVATE */
73
74 os_reason_t os_reason_create(uint32_t osr_namespace, uint64_t osr_code);
75 int os_reason_alloc_buffer_noblock(os_reason_t cur_reason, uint32_t osr_bufsize);
76 struct kcdata_descriptor * os_reason_get_kcdata_descriptor(os_reason_t cur_reason);
77 void os_reason_ref(os_reason_t cur_reason);
78 void 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
101 /*
102 * Update whenever new OS_REASON namespaces are added.
103 */
104 #define OS_REASON_MAX_VALID_NAMESPACE OS_REASON_AGGREGATED
105
106 #define OS_REASON_BUFFER_MAX_SIZE 5120
107
108 #define OS_REASON_FLAG_NO_CRASH_REPORT 0x1 /* Don't create a crash report */
109 #define OS_REASON_FLAG_GENERATE_CRASH_REPORT 0x2 /* Create a crash report - the default for userspace requests */
110 #define OS_REASON_FLAG_FROM_USERSPACE 0x4 /* Reason created from a userspace syscall */
111 #define OS_REASON_FLAG_FAILED_DATA_COPYIN 0x8 /* We failed to copyin data from userspace */
112 #define OS_REASON_FLAG_PAYLOAD_TRUNCATED 0x10 /* The payload was truncated because it was longer than allowed */
113 #define OS_REASON_FLAG_BAD_PARAMS 0x20 /* Invalid parameters were passed involved with creating this reason */
114 #define OS_REASON_FLAG_CONSISTENT_FAILURE 0x40 /* Whatever caused this reason to be created will happen again */
115 #define OS_REASON_FLAG_ONE_TIME_FAILURE 0x80 /* Whatever caused this reason to be created was a one time issue */
116
117 /*
118 * Set of flags that are allowed to be passed from userspace
119 */
120 #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)
121
122 /*
123 * Macros to encode the exit reason namespace and first 32 bits of code in exception code
124 * which is used by Report Crash as a hint. It should be only used as a hint since it
125 * looses higher 32 bits of exit reason code.
126 */
127 #define ENCODE_OSR_NAMESPACE_TO_MACH_EXCEPTION_CODE(code, osr_namespace) \
128 (code) = (code) | (((osr_namespace) & ((uint64_t)UINT32_MAX)) << 32)
129 #define ENCODE_OSR_CODE_TO_MACH_EXCEPTION_CODE(code, osr_code) \
130 (code) = (code) | ((osr_code) & ((uint64_t)UINT32_MAX))
131
132 #ifndef KERNEL
133 /*
134 * abort_with_reason: Used to exit the current process and pass along
135 * specific information about why it is being terminated.
136 *
137 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason
138 * args->reason_code - code in the specified namespace for the reason
139 * args->reason_string - additional string formatted information about the request
140 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above).
141 *
142 * Outputs: Does not return.
143 */
144 void abort_with_reason(uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags) __attribute__((noreturn));
145
146 /*
147 * abort_with_payload: Used to exit the current process and pass along
148 * specific information about why it is being terminated. The payload pointer
149 * should point to structured data that can be interpreted by the consumer of
150 * exit reason information.
151 *
152 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason
153 * args->reason_code - code in the specified namespace for the reason
154 * args->payload - pointer to payload structure in user space
155 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN)
156 * args->reason_string - additional string formatted information about the request
157 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above).
158 *
159 * Outputs: Does not return.
160 */
161 void abort_with_payload(uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size, const char *reason_string,
162 uint64_t reason_flags) __attribute__((noreturn));
163
164 /*
165 * terminate_with_reason: Used to terminate a specific process and pass along
166 * specific information about why it is being terminated.
167 *
168 * Inputs: args->pid - the PID of the process to be terminated
169 * args->reason_namespace - OS_REASON namespace specified for the reason
170 * args->reason_code - code in the specified namespace for the reason
171 * args->reason_string - additional string formatted information about the request
172 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above)
173 *
174 * Outputs: EINVAL if the PID requested is the same as that of the calling process, invalid or the namespace provided is invalid.
175 * ESRCH if we couldn't find a live process with the requested PID
176 * EPERM if the caller is not privileged enough to kill the process with the requested PID
177 * returns 0 otherwise
178 */
179 int terminate_with_reason(int pid, uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags);
180
181 /*
182 * terminate_with_payload: Used to terminate a specific process and pass along
183 * specific information about why it is being terminated. The payload pointer
184 * should point to structured data that can be interpreted by the consumer of
185 * exit reason information.
186 *
187 * Inputs: args->pid - the PID of the process to be terminated.
188 * args->reason_namespace - OS_REASON namespace specified for the reason
189 * args->reason_code - code in the specified namespace for the reason
190 * args->payload - pointer to payload structure in user space
191 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN)
192 * args->reason_string - additional string formatted information about the request
193 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above)
194 *
195 * Outputs: EINVAL if the PID requested is the same as that of the calling process, is invalid or the namespace provided is invalid.
196 * ESRCH if we couldn't find a live process with the requested PID
197 * EPERM if the caller is not privileged enough to kill the process with the requested PID
198 * returns 0 otherwise
199 */
200 int terminate_with_payload(int pid, uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size,
201 const char *reason_string, uint64_t reason_flags);
202 #endif /* KERNEL */
203
204 /*
205 * codesigning exit reasons
206 */
207 #define CODESIGNING_EXIT_REASON_TASKGATED_INVALID_SIG 1
208 #define CODESIGNING_EXIT_REASON_INVALID_PAGE 2
209 #define CODESIGNING_EXIT_REASON_TASK_ACCESS_PORT 3
210
211 /*
212 * exec path specific exit reasons
213 */
214 #define EXEC_EXIT_REASON_BAD_MACHO 1
215 #define EXEC_EXIT_REASON_SUGID_FAILURE 2
216 #define EXEC_EXIT_REASON_ACTV_THREADSTATE 3
217 #define EXEC_EXIT_REASON_STACK_ALLOC 4
218 #define EXEC_EXIT_REASON_APPLE_STRING_INIT 5
219 #define EXEC_EXIT_REASON_COPYOUT_STRINGS 6
220 #define EXEC_EXIT_REASON_COPYOUT_DYNLINKER 7
221 #define EXEC_EXIT_REASON_SECURITY_POLICY 8
222 #define EXEC_EXIT_REASON_TASKGATED_OTHER 9
223 #define EXEC_EXIT_REASON_FAIRPLAY_DECRYPT 10
224 #define EXEC_EXIT_REASON_DECRYPT 11
225 #define EXEC_EXIT_REASON_UPX 12
226
227 __END_DECLS
228
229 #endif /* _REASON_H_ */