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