xnu-4903.270.47.tar.gz

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

diff --git a/osfmk/kperf/action.h b/osfmk/kperf/action.h
index 01f103f5c1ce82ac9ab6263925040b34dbf0d6ac..420720b86ab6f2104fbc4889d1f9ad5f368edadc 100644 (file)
--- a/osfmk/kperf/action.h
+++ b/osfmk/kperf/action.h
@@ -1,8 +1,8 @@
 /*
 /*

- * Copyright (c) 2011 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2016 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
  * @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
  * 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.
  * 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.
  * 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,
  * 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,34 +22,74 @@
  * 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.
  * 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@
  */
 
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 

+#ifndef KPERF_ACTION_H
+#define KPERF_ACTION_H
+
+#include <mach/kern_return.h>
+#include <stdint.h>
+#include <stdbool.h>
+

 /* fwd decl */
 struct kperf_sample;
 struct kperf_context;
 
 /* bits for defining what to do on an action */
 /* fwd decl */
 struct kperf_sample;
 struct kperf_context;
 
 /* bits for defining what to do on an action */

-#define SAMPLER_TINFO      (1<<0)
-#define SAMPLER_TINFOEX    (1<<1)
-#define SAMPLER_KSTACK     (1<<2)
-#define SAMPLER_USTACK     (1<<3)
-#define SAMPLER_PMC_THREAD (1<<4)
-#define SAMPLER_PMC_CPU    (1<<5)
-#define SAMPLER_PMC_CONFIG (1<<6)
-#define SAMPLER_MEMINFO    (1<<7)
-
-/* flags for sample calls*/
-#define SAMPLE_FLAG_PEND_USER    (1<<0)
-#define SAMPLE_FLAG_IDLE_THREADS (1<<1)
-#define SAMPLE_FLAG_EMPTY_CALLSTACK (1<<2)
+#define SAMPLER_TH_INFO       (1U << 0)
+#define SAMPLER_TH_SNAPSHOT   (1U << 1)
+#define SAMPLER_KSTACK        (1U << 2)
+#define SAMPLER_USTACK        (1U << 3)
+#define SAMPLER_PMC_THREAD    (1U << 4)
+#define SAMPLER_PMC_CPU       (1U << 5)
+#define SAMPLER_PMC_CONFIG    (1U << 6)
+#define SAMPLER_MEMINFO       (1U << 7)
+#define SAMPLER_TH_SCHEDULING (1U << 8)
+#define SAMPLER_TH_DISPATCH   (1U << 9)
+#define SAMPLER_TK_SNAPSHOT   (1U << 10)
+#define SAMPLER_SYS_MEM       (1U << 11)
+#define SAMPLER_TH_INSCYC     (1U << 12)
+#define SAMPLER_TK_INFO       (1U << 13)
+
+#define SAMPLER_TASK_MASK (SAMPLER_MEMINFO | SAMPLER_TK_SNAPSHOT | \
+               SAMPLER_TK_INFO)
+#define SAMPLER_THREAD_MASK (SAMPLER_TH_INFO | SAMPLER_TH_SNAPSHOT | \
+               SAMPLER_KSTACK | SAMPLER_USTACK | SAMPLER_PMC_THREAD | \
+               SAMPLER_TH_SCHEDULING | SAMPLER_TH_DISPATCH | SAMPLER_TH_INSCYC)
+
+/* flags for sample calls */
+
+/* pend samplers requiring copyin until AST boundary */
+#define SAMPLE_FLAG_PEND_USER       (1U << 0)
+/* sample idle threads */
+#define SAMPLE_FLAG_IDLE_THREADS    (1U << 1)
+/* do not sample callstacks */
+#define SAMPLE_FLAG_EMPTY_CALLSTACK (1U << 2)
+/* use the continuation as a kernel backtrace */
+#define SAMPLE_FLAG_CONTINUATION    (1U << 3)
+/* sample is occurring outside of interrupt context */
+#define SAMPLE_FLAG_NON_INTERRUPT   (1U << 4)
+/* sample should include system samplers */
+#define SAMPLE_FLAG_SYSTEM          (1U << 5)
+/* sample should not include non-system samplers */
+#define SAMPLE_FLAG_ONLY_SYSTEM     (1U << 6)
+/* sample should only include task samplers */
+#define SAMPLE_FLAG_TASK_ONLY       (1U << 7)
+/* sample should only include thread samplers */
+#define SAMPLE_FLAG_THREAD_ONLY     (1U << 8)

 
 /*  Take a sample into "sbuf" using current thread "cur_thread" */
 
 /*  Take a sample into "sbuf" using current thread "cur_thread" */

-extern kern_return_t kperf_sample(struct kperf_sample *sbuf,
-                                  struct kperf_context*,
-                                  unsigned actionid,
-                                  unsigned sample_flags);
+kern_return_t kperf_sample(struct kperf_sample *sbuf,
+    struct kperf_context *ctx,
+    unsigned actionid,
+    unsigned sample_flags);
+
+/* Whether the action provided samples non-system values. */
+bool kperf_action_has_non_system(unsigned actionid);
+bool kperf_action_has_thread(unsigned int actionid);
+bool kperf_action_has_task(unsigned int actionid);

 
 /* return codes from taking a sample
  * either keep trigger, or something went wrong (or we're shutting down)
 
 /* return codes from taking a sample
  * either keep trigger, or something went wrong (or we're shutting down)


@@ -59,26 +99,31 @@ extern kern_return_t kperf_sample(struct kperf_sample *sbuf,
 #define SAMPLE_SHUTDOWN (1)
 #define SAMPLE_OFF      (2)
 
 #define SAMPLE_SHUTDOWN (1)
 #define SAMPLE_OFF      (2)
 

-/* Get the sample buffer to use from interrupt handler context. Only
- * valid in interrupt contexts.
- */
-extern struct kperf_sample* kperf_intr_sample_buffer(void);
+void kperf_action_reset(void);

 
 /* Interface functions  */
 
 /* Interface functions  */

-extern unsigned kperf_action_get_count(void);
-extern int kperf_action_set_count(unsigned count);
-
-extern int kperf_action_set_samplers(unsigned actionid,
-                                     uint32_t samplers);
-extern int kperf_action_get_samplers(unsigned actionid,
-                                     uint32_t *samplers_out);
-
-extern int kperf_action_set_userdata(unsigned actionid,
-                                     uint32_t userdata);
-extern int kperf_action_get_userdata(unsigned actionid,
-                                     uint32_t *userdata_out);
-
-extern int kperf_action_set_filter(unsigned actionid,
-                                   int pid);
-extern int kperf_action_get_filter(unsigned actionid,
-                                   int *pid_out);
+unsigned kperf_action_get_count(void);
+int kperf_action_set_count(unsigned count);
+
+int kperf_action_set_samplers(unsigned int actionid, uint32_t samplers);
+int kperf_action_get_samplers(unsigned int actionid, uint32_t *samplers_out);
+
+int kperf_action_set_userdata(unsigned int actionid, uint32_t userdata);
+int kperf_action_get_userdata(unsigned int actionid, uint32_t *userdata_out);
+
+int kperf_action_set_ucallstack_depth(unsigned int actionid, uint32_t depth);
+int kperf_action_get_ucallstack_depth(unsigned int actionid, uint32_t * depth_out);
+int kperf_action_set_kcallstack_depth(unsigned int actionid, uint32_t depth);
+int kperf_action_get_kcallstack_depth(unsigned int actionid, uint32_t * depth_out);
+
+int kperf_action_set_filter(unsigned int actionid, int pid);
+int kperf_action_get_filter(unsigned int actionid, int *pid_out);
+
+void kperf_kdebug_handler(uint32_t debugid, uintptr_t *starting_fp);
+
+/* whether to output tracepoints on context-switch */
+extern int kperf_kdebug_cswitch;
+int kperf_kdbg_cswitch_get(void);
+int kperf_kdbg_cswitch_set(int newval);
+
+#endif /* !defined(KPERF_ACTION_H) */