xref: /xnu-11417.121.6/libkern/os/reason_private.h (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1*a1e26a70SApple OSS Distributions /*
2*a1e26a70SApple OSS Distributions  * Copyright (c) 2017 Apple Inc. All rights reserved.
3*a1e26a70SApple OSS Distributions  *
4*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*a1e26a70SApple OSS Distributions  *
6*a1e26a70SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*a1e26a70SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*a1e26a70SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*a1e26a70SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*a1e26a70SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*a1e26a70SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*a1e26a70SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*a1e26a70SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*a1e26a70SApple OSS Distributions  *
15*a1e26a70SApple OSS Distributions  * Please obtain a copy of the License at
16*a1e26a70SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*a1e26a70SApple OSS Distributions  *
18*a1e26a70SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*a1e26a70SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*a1e26a70SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*a1e26a70SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*a1e26a70SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*a1e26a70SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*a1e26a70SApple OSS Distributions  * limitations under the License.
25*a1e26a70SApple OSS Distributions  *
26*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*a1e26a70SApple OSS Distributions  */
28*a1e26a70SApple OSS Distributions 
29*a1e26a70SApple OSS Distributions #ifndef OS_REASON_PRIVATE_H
30*a1e26a70SApple OSS Distributions #define OS_REASON_PRIVATE_H
31*a1e26a70SApple OSS Distributions 
32*a1e26a70SApple OSS Distributions #include <sys/reason.h>
33*a1e26a70SApple OSS Distributions #include <os/base.h>
34*a1e26a70SApple OSS Distributions 
35*a1e26a70SApple OSS Distributions __BEGIN_DECLS
36*a1e26a70SApple OSS Distributions 
37*a1e26a70SApple OSS Distributions #ifndef KERNEL
38*a1e26a70SApple OSS Distributions 
39*a1e26a70SApple OSS Distributions /*
40*a1e26a70SApple OSS Distributions  * similar to abort_with_payload, but for faults.
41*a1e26a70SApple OSS Distributions  *
42*a1e26a70SApple OSS Distributions  * [EBUSY]   too many corpses are being generated at the moment
43*a1e26a70SApple OSS Distributions  * [EQFULL]  the process used all its user fault quota
44*a1e26a70SApple OSS Distributions  * [ENOTSUP] generating simulated abort with reason is disabled
45*a1e26a70SApple OSS Distributions  * [EPERM]   generating simulated abort with reason for this namespace is not turned on
46*a1e26a70SApple OSS Distributions  */
47*a1e26a70SApple OSS Distributions int
48*a1e26a70SApple OSS Distributions os_fault_with_payload(uint32_t reason_namespace, uint64_t reason_code,
49*a1e26a70SApple OSS Distributions     void *payload, uint32_t payload_size, const char *reason_string,
50*a1e26a70SApple OSS Distributions     uint64_t reason_flags) __attribute__((cold));
51*a1e26a70SApple OSS Distributions 
52*a1e26a70SApple OSS Distributions #endif // !KERNEL
53*a1e26a70SApple OSS Distributions 
54*a1e26a70SApple OSS Distributions /*
55*a1e26a70SApple OSS Distributions  * Codes in the OS_REASON_LIBSYSTEM namespace
56*a1e26a70SApple OSS Distributions  */
57*a1e26a70SApple OSS Distributions 
58*a1e26a70SApple OSS Distributions OS_ENUM(os_reason_libsystem_code, uint64_t,
59*a1e26a70SApple OSS Distributions     OS_REASON_LIBSYSTEM_CODE_WORKLOOP_OWNERSHIP_LEAK = 1,
60*a1e26a70SApple OSS Distributions     OS_REASON_LIBSYSTEM_CODE_FAULT = 2, /* generic fault with old-style os_log_fault payload */
61*a1e26a70SApple OSS Distributions     OS_REASON_LIBSYSTEM_CODE_SECINIT_INITIALIZER = 3,
62*a1e26a70SApple OSS Distributions     OS_REASON_LIBSYSTEM_CODE_PTHREAD_CORRUPTION = 4,
63*a1e26a70SApple OSS Distributions     OS_REASON_LIBSYSTEM_CODE_OS_LOG_FAULT = 5, /* generated _only_ by os_log_fault in libtrace */
64*a1e26a70SApple OSS Distributions     );
65*a1e26a70SApple OSS Distributions 
66*a1e26a70SApple OSS Distributions __END_DECLS
67*a1e26a70SApple OSS Distributions 
68*a1e26a70SApple OSS Distributions #endif // OS_REASON_PRIVATE_H
69