1 /* 2 * Copyright (c) 2000-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 #ifndef _KERN_STACKSHOT_H_ 30 #define _KERN_STACKSHOT_H_ 31 32 #include <stdint.h> 33 #include <kern/kern_types.h> 34 #include <kern/kern_cdata.h> 35 36 __BEGIN_DECLS 37 38 #ifdef XNU_KERNEL_PRIVATE 39 40 extern void kdp_snapshot_preflight(int pid, void * tracebuf, uint32_t tracebuf_size, 41 uint64_t flags, kcdata_descriptor_t data_p, uint64_t since_timestamp, uint32_t pagetable_mask); 42 extern uint32_t kdp_stack_snapshot_bytes_traced(void); 43 extern uint32_t kdp_stack_snapshot_bytes_uncompressed(void); 44 extern boolean_t stackshot_thread_is_idle_worker_unsafe(thread_t thread); 45 extern void stackshot_cpu_preflight(void); 46 extern void stackshot_aux_cpu_entry(void); 47 extern void stackshot_cpu_signal_panic(void); 48 extern kern_return_t kern_stack_snapshot_internal(int stackshot_config_version, void *stackshot_config, 49 size_t stackshot_config_size, boolean_t stackshot_from_user); 50 extern kern_return_t do_stackshot(void* context); 51 extern boolean_t stackshot_active(void); 52 extern boolean_t panic_stackshot_active(void); 53 extern kern_return_t do_panic_stackshot(void *context); 54 extern void * stackshot_alloc_with_size(size_t size, kern_return_t *err); 55 56 /* Allocates an array of elements of a type from the stackshot buffer. Works in regular & panic stackshots. */ 57 #define stackshot_alloc_arr(type, count, err) stackshot_alloc_with_size(sizeof(type) * (count), err) 58 59 /* Allocates an element with a type from the stackshot buffer. Works in regular & panic stackshot. */ 60 #define stackshot_alloc(type, err) stackshot_alloc_with_size(sizeof(type), err) 61 62 #endif /* XNU_KERNEL_PRIVATE */ 63 64 __END_DECLS 65 66 #endif /* _KERN_STACKSHOT_H_ */ 67