1 /*
2 * Copyright (c) 2023 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
31 #include <mach/kern_return.h>
32 #include <kern/kern_types.h>
33 #include <kern/kern_cdata.h>
34 #include <kern/thread.h>
35 #include <sys/cdefs.h>
36
37
38 #if CONFIG_EXCLAVES
39
40 __BEGIN_DECLS
41
42 /*
43 * Kick the collection thread to ensure it's running.
44 */
45 extern void exclaves_inspection_begin_collecting(void);
46 /*
47 * Wait for provided queue to drain.
48 */
49 extern void exclaves_inspection_wait_complete(queue_t exclaves_inspection_queue);
50
51 extern void exclaves_inspection_check_ast(void);
52 extern bool exclaves_inspection_is_initialized(void);
53
54 extern bool exclaves_stackshot_raw_addresses;
55 extern bool exclaves_stackshot_all_address_spaces;
56
57 extern lck_mtx_t exclaves_collect_mtx;
58 /*
59 * These waitlists are protected by exclaves_collect_mtx and should not be
60 * cleared other than by the dedicated `exclaves_collection_thread` thread.
61 */
62 extern queue_head_t exclaves_inspection_queue_stackshot;
63 extern queue_head_t exclaves_inspection_queue_kperf;
64
65 static inline void
exclaves_inspection_queue_add(queue_t queue,queue_entry_t elm)66 exclaves_inspection_queue_add(queue_t queue, queue_entry_t elm)
67 {
68 assert(queue == &exclaves_inspection_queue_stackshot || queue == &exclaves_inspection_queue_kperf);
69 lck_mtx_assert(&exclaves_collect_mtx, LCK_ASSERT_OWNED);
70
71 enqueue_head(queue, elm);
72 }
73
74 uint32_t exclaves_stack_offset(uintptr_t * out_addr, size_t nframes, bool slid_addresses);
75
76 struct exclaves_panic_stackshot {
77 uint8_t *stackshot_buffer;
78 uint64_t stackshot_buffer_size;
79 };
80
81 __enum_decl(exclaves_panic_ss_status_t, uint8_t, {
82 EXCLAVES_PANIC_STACKSHOT_UNKNOWN = 0,
83 EXCLAVES_PANIC_STACKSHOT_FOUND = 1,
84 EXCLAVES_PANIC_STACKSHOT_NOT_FOUND = 2,
85 EXCLAVES_PANIC_STACKSHOT_DECODE_FAILED = 3,
86 });
87
88 extern exclaves_panic_ss_status_t exclaves_panic_ss_status;
89
90 /* Attempt to read Exclave panic stackshot data */
91 void kdp_read_panic_exclaves_stackshot(struct exclaves_panic_stackshot *eps);
92
93 __END_DECLS
94
95 #endif /* CONFIG_EXCLAVES */
96