1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2011-2019 Apple Computer, Inc. All rights reserved. 3*43a90889SApple OSS Distributions * 4*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*43a90889SApple OSS Distributions * 6*43a90889SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*43a90889SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*43a90889SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*43a90889SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*43a90889SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*43a90889SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*43a90889SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*43a90889SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*43a90889SApple OSS Distributions * 15*43a90889SApple OSS Distributions * Please obtain a copy of the License at 16*43a90889SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*43a90889SApple OSS Distributions * 18*43a90889SApple OSS Distributions * The Original Code and all software distributed under the License are 19*43a90889SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*43a90889SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*43a90889SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*43a90889SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*43a90889SApple OSS Distributions * Please see the License for the specific language governing rights and 24*43a90889SApple OSS Distributions * limitations under the License. 25*43a90889SApple OSS Distributions * 26*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*43a90889SApple OSS Distributions */ 28*43a90889SApple OSS Distributions 29*43a90889SApple OSS Distributions #ifndef KPERF_CALLSTACK_H 30*43a90889SApple OSS Distributions #define KPERF_CALLSTACK_H 31*43a90889SApple OSS Distributions 32*43a90889SApple OSS Distributions #define MAX_KCALLSTACK_FRAMES (128) 33*43a90889SApple OSS Distributions #define MAX_UCALLSTACK_FRAMES (256) 34*43a90889SApple OSS Distributions #define MAX_EXCALLSTACK_FRAMES (128) 35*43a90889SApple OSS Distributions 36*43a90889SApple OSS Distributions /* the callstack contains valid data */ 37*43a90889SApple OSS Distributions #define CALLSTACK_VALID (1U << 0) 38*43a90889SApple OSS Distributions /* the callstack has been deferred */ 39*43a90889SApple OSS Distributions #define CALLSTACK_DEFERRED (1U << 1) 40*43a90889SApple OSS Distributions /* the callstack is 64-bit */ 41*43a90889SApple OSS Distributions #define CALLSTACK_64BIT (1U << 2) 42*43a90889SApple OSS Distributions /* the callstack is from the kernel */ 43*43a90889SApple OSS Distributions #define CALLSTACK_KERNEL (1U << 3) 44*43a90889SApple OSS Distributions /* the callstack was cut off */ 45*43a90889SApple OSS Distributions #define CALLSTACK_TRUNCATED (1U << 4) 46*43a90889SApple OSS Distributions /* the callstack is only holding a continuation "frame" */ 47*43a90889SApple OSS Distributions #define CALLSTACK_CONTINUATION (1U << 5) 48*43a90889SApple OSS Distributions /* the frames field is filled with uintptr_t, not uint64_t */ 49*43a90889SApple OSS Distributions #define CALLSTACK_KERNEL_WORDS (1U << 6) 50*43a90889SApple OSS Distributions /* the frames come from a translated task */ 51*43a90889SApple OSS Distributions #define CALLSTACK_TRANSLATED (1U << 7) 52*43a90889SApple OSS Distributions /* the last frame could be the real PC */ 53*43a90889SApple OSS Distributions #define CALLSTACK_FIXUP_PC (1U << 8) 54*43a90889SApple OSS Distributions /* the stack also contains an async stack */ 55*43a90889SApple OSS Distributions #define CALLSTACK_HAS_ASYNC (1U << 9) 56*43a90889SApple OSS Distributions 57*43a90889SApple OSS Distributions struct kp_ucallstack { 58*43a90889SApple OSS Distributions uint32_t kpuc_flags; 59*43a90889SApple OSS Distributions uint32_t kpuc_nframes; 60*43a90889SApple OSS Distributions uint32_t kpuc_async_index; 61*43a90889SApple OSS Distributions uint32_t kpuc_async_nframes; 62*43a90889SApple OSS Distributions uintptr_t kpuc_frames[MAX_UCALLSTACK_FRAMES]; 63*43a90889SApple OSS Distributions }; 64*43a90889SApple OSS Distributions 65*43a90889SApple OSS Distributions struct kp_kcallstack { 66*43a90889SApple OSS Distributions uint32_t kpkc_flags; 67*43a90889SApple OSS Distributions uint32_t kpkc_nframes; 68*43a90889SApple OSS Distributions union { 69*43a90889SApple OSS Distributions uintptr_t kpkc_word_frames[MAX_KCALLSTACK_FRAMES]; 70*43a90889SApple OSS Distributions uint64_t kpkc_frames[MAX_KCALLSTACK_FRAMES] __kernel_ptr_semantics; 71*43a90889SApple OSS Distributions }; 72*43a90889SApple OSS Distributions uint32_t kpkc_exclaves_offset; 73*43a90889SApple OSS Distributions }; 74*43a90889SApple OSS Distributions 75*43a90889SApple OSS Distributions struct kperf_context; 76*43a90889SApple OSS Distributions 77*43a90889SApple OSS Distributions void kperf_kcallstack_sample(struct kp_kcallstack *cs, struct kperf_context *); 78*43a90889SApple OSS Distributions void kperf_kcallstack_log(struct kp_kcallstack *cs); 79*43a90889SApple OSS Distributions void kperf_continuation_sample(struct kp_kcallstack *cs, struct kperf_context *); 80*43a90889SApple OSS Distributions void kperf_backtrace_sample(struct kp_kcallstack *cs, struct kperf_context *context); 81*43a90889SApple OSS Distributions 82*43a90889SApple OSS Distributions void kperf_ucallstack_sample(struct kp_ucallstack *cs, struct kperf_context *); 83*43a90889SApple OSS Distributions int kperf_ucallstack_pend(struct kperf_context *, uint32_t depth, 84*43a90889SApple OSS Distributions unsigned int actionid); 85*43a90889SApple OSS Distributions void kperf_ucallstack_log(struct kp_ucallstack *cs); 86*43a90889SApple OSS Distributions 87*43a90889SApple OSS Distributions #if CONFIG_EXCLAVES 88*43a90889SApple OSS Distributions #include <kern/exclaves.tightbeam.h> 89*43a90889SApple OSS Distributions void kperf_excallstack_log(const stackshottypes_ipcstackentry_s *ipcstack); 90*43a90889SApple OSS Distributions bool kperf_exclave_callstack_pend(struct kperf_context *context, unsigned int actionid); 91*43a90889SApple OSS Distributions #endif /* CONFIG_EXCLAVES */ 92*43a90889SApple OSS Distributions 93*43a90889SApple OSS Distributions #endif /* !defined(KPERF_CALLSTACK_H) */ 94