1 /* 2 * Copyright (c) 2011-2019 Apple Computer, 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 KPERF_CALLSTACK_H 30 #define KPERF_CALLSTACK_H 31 32 #define MAX_KCALLSTACK_FRAMES (128) 33 #define MAX_UCALLSTACK_FRAMES (256) 34 #define MAX_EXCALLSTACK_FRAMES (128) 35 36 /* the callstack contains valid data */ 37 #define CALLSTACK_VALID (1U << 0) 38 /* the callstack has been deferred */ 39 #define CALLSTACK_DEFERRED (1U << 1) 40 /* the callstack is 64-bit */ 41 #define CALLSTACK_64BIT (1U << 2) 42 /* the callstack is from the kernel */ 43 #define CALLSTACK_KERNEL (1U << 3) 44 /* the callstack was cut off */ 45 #define CALLSTACK_TRUNCATED (1U << 4) 46 /* the callstack is only holding a continuation "frame" */ 47 #define CALLSTACK_CONTINUATION (1U << 5) 48 /* the frames field is filled with uintptr_t, not uint64_t */ 49 #define CALLSTACK_KERNEL_WORDS (1U << 6) 50 /* the frames come from a translated task */ 51 #define CALLSTACK_TRANSLATED (1U << 7) 52 /* the last frame could be the real PC */ 53 #define CALLSTACK_FIXUP_PC (1U << 8) 54 /* the stack also contains an async stack */ 55 #define CALLSTACK_HAS_ASYNC (1U << 9) 56 57 struct kp_ucallstack { 58 uint32_t kpuc_flags; 59 uint32_t kpuc_nframes; 60 uint32_t kpuc_async_index; 61 uint32_t kpuc_async_nframes; 62 uintptr_t kpuc_frames[MAX_UCALLSTACK_FRAMES]; 63 }; 64 65 struct kp_kcallstack { 66 uint32_t kpkc_flags; 67 uint32_t kpkc_nframes; 68 union { 69 uintptr_t kpkc_word_frames[MAX_KCALLSTACK_FRAMES]; 70 uint64_t kpkc_frames[MAX_KCALLSTACK_FRAMES] __kernel_ptr_semantics; 71 }; 72 uint32_t kpkc_exclaves_offset; 73 }; 74 75 struct kperf_context; 76 77 void kperf_kcallstack_sample(struct kp_kcallstack *cs, struct kperf_context *); 78 void kperf_kcallstack_log(struct kp_kcallstack *cs); 79 void kperf_continuation_sample(struct kp_kcallstack *cs, struct kperf_context *); 80 void kperf_backtrace_sample(struct kp_kcallstack *cs, struct kperf_context *context); 81 82 void kperf_ucallstack_sample(struct kp_ucallstack *cs, struct kperf_context *); 83 int kperf_ucallstack_pend(struct kperf_context *, uint32_t depth, 84 unsigned int actionid); 85 void kperf_ucallstack_log(struct kp_ucallstack *cs); 86 87 #if CONFIG_EXCLAVES 88 #include <kern/exclaves.tightbeam.h> 89 void kperf_excallstack_log(const stackshottypes_ipcstackentry_s *ipcstack); 90 bool kperf_exclave_callstack_pend(struct kperf_context *context, unsigned int actionid); 91 #endif /* CONFIG_EXCLAVES */ 92 93 #endif /* !defined(KPERF_CALLSTACK_H) */ 94