xref: /xnu-12377.41.6/libkern/os/reason_private.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1 /*
2  * Copyright (c) 2017 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 OS_REASON_PRIVATE_H
30 #define OS_REASON_PRIVATE_H
31 
32 #include <sys/reason.h>
33 #include <os/base.h>
34 
35 __BEGIN_DECLS
36 
37 #ifndef KERNEL
38 
39 /*
40  * similar to abort_with_payload, but for faults.
41  *
42  * [EBUSY]   too many corpses are being generated at the moment
43  * [EQFULL]  the process used all its user fault quota
44  * [ENOTSUP] generating simulated abort with reason is disabled
45  * [EPERM]   generating simulated abort with reason for this namespace is not turned on
46  */
47 int
48 os_fault_with_payload(uint32_t reason_namespace, uint64_t reason_code,
49     void *payload, uint32_t payload_size, const char *reason_string,
50     uint64_t reason_flags) __attribute__((cold));
51 
52 #endif // !KERNEL
53 
54 /*
55  * Codes in the OS_REASON_LIBSYSTEM namespace
56  */
57 
58 OS_ENUM(os_reason_libsystem_code, uint64_t,
59     OS_REASON_LIBSYSTEM_CODE_WORKLOOP_OWNERSHIP_LEAK = 1,
60     OS_REASON_LIBSYSTEM_CODE_FAULT = 2, /* generic fault with old-style os_log_fault payload */
61     OS_REASON_LIBSYSTEM_CODE_SECINIT_INITIALIZER = 3,
62     OS_REASON_LIBSYSTEM_CODE_PTHREAD_CORRUPTION = 4,
63     OS_REASON_LIBSYSTEM_CODE_OS_LOG_FAULT = 5, /* generated _only_ by os_log_fault in libtrace */
64     );
65 
66 __END_DECLS
67 
68 #endif // OS_REASON_PRIVATE_H
69