xnu-4570.71.2.tar.gz

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

diff --git a/osfmk/kperf/kperf.h b/osfmk/kperf/kperf.h
index 12b168acd8498d6cb3b234667bfa5872c328cbe3..040d032c1e6260c979206e4ccef710955474447d 100644 (file)
--- a/osfmk/kperf/kperf.h
+++ b/osfmk/kperf/kperf.h
@@ -26,64 +26,124 @@
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
-#ifndef __KPERF_H__
-#define __KPERF_H__
-
-/* The various trigger types supported by kperf */
-#define TRIGGER_TYPE_TIMER (0)
-#define TRIGGER_TYPE_PMI   (1)
-#define TRIGGER_TYPE_TRACE (2)
-
-/* Helpers to get and set AST bits on a thread */
-extern uint32_t kperf_get_thread_bits( thread_t thread );
-extern void     kperf_set_thread_bits( thread_t thread, uint32_t bits );
-extern void     kperf_set_thread_ast( thread_t thread );
-
-/* Possible states of kperf sampling */
-#define KPERF_SAMPLING_OFF 0
-#define KPERF_SAMPLING_ON  1
-#define KPERF_SAMPLING_SHUTDOWN 2
-
-/* Init kperf module. Must be called before use, can be called as many
- * times as you like.
+#ifndef KPERF_H
+#define KPERF_H
+
+#include <kern/thread.h>
+#include <kern/locks.h>
+
+extern lck_grp_t kperf_lck_grp;
+
+/* the trigger types supported by kperf */
+#define TRIGGER_TYPE_TIMER  (0)
+#define TRIGGER_TYPE_PMI    (1)
+#define TRIGGER_TYPE_KDEBUG (2)
+
+/* helpers to get and set AST flags on a thread */
+uint32_t kperf_get_thread_flags(thread_t thread);
+void kperf_set_thread_flags(thread_t thread, uint32_t flags);
+
+/*
+ * Get and set dirtiness of thread, so kperf can track whether the thread
+ * has been dispatched since it last looked.
+ */
+boolean_t kperf_thread_get_dirty(thread_t thread);
+void kperf_thread_set_dirty(thread_t thread, boolean_t dirty);
+
+/* possible states of kperf sampling */
+#define KPERF_SAMPLING_OFF      (0)
+#define KPERF_SAMPLING_ON       (1)
+#define KPERF_SAMPLING_SHUTDOWN (2)
+
+/*
+ * Initialize kperf.  Must be called before use and can be called multiple times.
  */
 extern int kperf_init(void);
 
-/* Get and set sampling status */
+/* get and set sampling status */
 extern unsigned kperf_sampling_status(void);
 extern int kperf_sampling_enable(void);
 extern int kperf_sampling_disable(void);
 
-/* kperf AST handler
+/* get a per-CPU sample buffer */
+struct kperf_sample *kperf_intr_sample_buffer(void);
+
+/*
+ * kperf AST handler
+ */
+extern __attribute__((noinline)) void kperf_thread_ast_handler(thread_t thread);
+
+/*
+ * thread on core callback
+ */
+
+/* controls whether the callback is called on context switch */
+extern boolean_t kperf_on_cpu_active;
+
+/* update whether the callback is set */
+void kperf_on_cpu_update(void);
+
+/* handle a thread being switched on */
+void kperf_on_cpu_internal(thread_t thread, thread_continue_t continuation,
+                           uintptr_t *starting_fp);
+
+/* for scheduler threads switching threads on */
+static inline void
+kperf_on_cpu(thread_t thread, thread_continue_t continuation,
+             uintptr_t *starting_fp)
+{
+       if (__improbable(kperf_on_cpu_active)) {
+               kperf_on_cpu_internal(thread, continuation, starting_fp);
+       }
+}
+
+/*
+ * kdebug callback
+ */
+
+/* controls whether the kdebug callback is called */
+extern boolean_t kperf_kdebug_active;
+
+/* handle the kdebug event */
+void kperf_kdebug_callback_internal(uint32_t debugid);
+
+/* handle a kdebug event */
+void kperf_kdebug_handler(uint32_t debugid, uintptr_t *starting_fp);
+
+/* called inside of kernel_debug_internal */
+static inline void
+kperf_kdebug_callback(uint32_t debugid, uintptr_t *starting_fp)
+{
+       if (__improbable(kperf_kdebug_active)) {
+               kperf_kdebug_handler(debugid, starting_fp);
+       }
+}
+
+/*
+ * Used by ktrace to reset kperf.  ktrace_lock must be held.
  */
-extern void kperf_thread_ast_handler( thread_t thread );
+extern void kperf_reset(void);
 
-/* kperf kdebug callback
+/*
+ * Configure kperf from the kernel (e.g. during boot).
  */
-extern void kperf_kdebug_callback(uint32_t debugid);
+void kperf_kernel_configure(const char *config);
 
 /* get and set whether we're recording stacks on interesting kdebug events */
 extern int kperf_kdbg_get_stacks(void);
 extern int kperf_kdbg_set_stacks(int);
 
-/* given a task port, find out its pid */
-int kperf_port_to_pid(mach_port_name_t portname);
+extern int kperf_kdebug_cswitch;
 
-/* Check whether the current process has been blessed to allow access
- * to kperf facilities.
- */
-extern int kperf_access_check(void);
-
-/* track recursion on kdebug tracepoint tracking */
-extern int kperf_kdbg_recurse(int step);
-#define KPERF_RECURSE_IN  (1)
-#define KPERF_RECURSE_out (-1)
+#if DEVELOPMENT || DEBUG
+extern _Atomic long long kperf_pending_ipis;
+#endif /* DEVELOPMENT || DEBUG */
 
-/* context switch tracking */
-extern int  kperf_cswitch_hook;
-extern void kperf_switch_context( thread_t old, thread_t new );
+/* get and set whether to output tracepoints on context-switch */
+extern int kperf_kdbg_cswitch_get(void);
+extern int kperf_kdbg_cswitch_set(int newval);
 
-/* bootstrap */
-extern void kperf_bootstrap(void);
+/* given a task port, find out its pid */
+int kperf_port_to_pid(mach_port_name_t portname);
 
-#endif /* __KPERF_H__ */
+#endif /* !defined(KPERF_H) */