xref: /xnu-11417.121.6/osfmk/kern/panic_call.h (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1 /*
2  * Copyright (c) 2024 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 #pragma once
30 #include <sys/cdefs.h>
31 #include <stdint.h>
32 
33 __BEGIN_DECLS
34 
35 #ifdef KERNEL
36 __abortlike __printflike(1, 2)
37 extern void panic(const char *string, ...);
38 #endif /* KERNEL */
39 
40 #if KERNEL_PRIVATE
41 struct task;
42 struct thread;
43 struct proc;
44 
45 #if XNU_KERNEL_PRIVATE
46 #define panic(ex, ...)  ({ \
47 	__asm__("" ::: "memory"); \
48 	(panic)(ex " @%s:%d", ## __VA_ARGS__, __FILE_NAME__, __LINE__); \
49 })
50 #else /* else XNU_KERNEL_PRIVATE */
51 #define panic(ex, ...)  ({ \
52 	__asm__("" ::: "memory"); \
53 	(panic)(#ex " @%s:%d", ## __VA_ARGS__, __FILE_NAME__, __LINE__); \
54 })
55 #endif /* else XNU_KERNEL_PRIVATE*/
56 #define panic_plain(ex, ...)  (panic)(ex, ## __VA_ARGS__)
57 
58 __abortlike __printflike(4, 5)
59 void panic_with_options(unsigned int reason, void *ctx,
60     uint64_t debugger_options_mask, const char *str, ...);
61 __abortlike __printflike(5, 6)
62 void panic_with_options_and_initiator(const char* initiator, unsigned int reason, void *ctx,
63     uint64_t debugger_options_mask, const char *str, ...);
64 
65 #if XNU_KERNEL_PRIVATE && defined (__x86_64__)
66 __abortlike __printflike(5, 6)
67 void panic_with_thread_context(unsigned int reason, void *ctx,
68     uint64_t debugger_options_mask, struct thread* th, const char *str, ...);
69 #endif /* XNU_KERNEL_PRIVATE && defined (__x86_64__) */
70 
71 #endif /* KERNEL_PRIVATE */
72 
73 __END_DECLS
74