xnu-6153.141.1.tar.gz

[apple/xnu.git] / osfmk / kperf / callstack.h

diff --git a/osfmk/kperf/callstack.h b/osfmk/kperf/callstack.h
index 3bfd96422f4835bd7d2c089e176f7320510be20d..e4a0cd5e0273de98b0251bf32ddddf29264b9bbd 100644 (file)
--- a/osfmk/kperf/callstack.h
+++ b/osfmk/kperf/callstack.h
@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 2011 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2011-2019 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- * 
+ *
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
@@ -11,10 +11,10 @@
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
- * 
+ *
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
- * 
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -22,36 +22,56 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
+ *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
-#ifndef __AP_CALLSTACK_H__
-#define __AP_CALLSTACK_H__
+#ifndef KPERF_CALLSTACK_H
+#define KPERF_CALLSTACK_H
 
-#define MAX_CALLSTACK_FRAMES (128)
+#define MAX_KCALLSTACK_FRAMES (128)
+#define MAX_UCALLSTACK_FRAMES (256)
 
-#define CALLSTACK_VALID     (1<<0)
-#define CALLSTACK_DEFERRED  (1<<1)
-#define CALLSTACK_64BIT     (1<<2)
-#define CALLSTACK_KERNEL    (1<<3)
-#define CALLSTACK_TRUNCATED (1<<4)
+/* the callstack contains valid data */
+#define CALLSTACK_VALID        (1U << 0)
+/* the callstack has been deferred */
+#define CALLSTACK_DEFERRED     (1U << 1)
+/* the callstack is 64-bit */
+#define CALLSTACK_64BIT        (1U << 2)
+/* the callstack is from the kernel */
+#define CALLSTACK_KERNEL       (1U << 3)
+/* the callstack was cut off */
+#define CALLSTACK_TRUNCATED    (1U << 4)
+/* the callstack is only holding a continuation "frame" */
+#define CALLSTACK_CONTINUATION (1U << 5)
+/* the frames field is filled with uintptr_t, not uint64_t */
+#define CALLSTACK_KERNEL_WORDS (1U << 6)
 
-struct callstack
-{
-       uint32_t flags;
-       uint32_t nframes;
-       uint64_t frames[MAX_CALLSTACK_FRAMES];
+struct kp_ucallstack {
+       uint32_t kpuc_flags;
+       uint32_t kpuc_nframes;
+       uintptr_t kpuc_frames[MAX_UCALLSTACK_FRAMES];
 };
 
-struct kperf_context;
+struct kp_kcallstack {
+       uint32_t kpkc_flags;
+       uint32_t kpkc_nframes;
+       union {
+               uintptr_t kpkc_word_frames[MAX_KCALLSTACK_FRAMES];
+               uint64_t kpkc_frames[MAX_KCALLSTACK_FRAMES];
+       };
+};
 
-extern void kperf_kcallstack_sample( struct callstack *cs, struct kperf_context * );
-extern void kperf_kcallstack_log( struct callstack *cs );
+struct kperf_context;
 
-extern void kperf_ucallstack_sample( struct callstack *cs, struct kperf_context * );
-extern int kperf_ucallstack_pend( struct kperf_context * );
-extern void kperf_ucallstack_log( struct callstack *cs );
+void kperf_kcallstack_sample(struct kp_kcallstack *cs, struct kperf_context *);
+void kperf_kcallstack_log(struct kp_kcallstack *cs);
+void kperf_continuation_sample(struct kp_kcallstack *cs, struct kperf_context *);
+void kperf_backtrace_sample(struct kp_kcallstack *cs, struct kperf_context *context);
 
+void kperf_ucallstack_sample(struct kp_ucallstack *cs, struct kperf_context *);
+int kperf_ucallstack_pend(struct kperf_context *, uint32_t depth,
+    unsigned int actionid);
+void kperf_ucallstack_log(struct kp_ucallstack *cs);
 
-#endif /* __AP_CALLSTACK_H__ */
+#endif /* !defined(KPERF_CALLSTACK_H) */