osfmk/kperf/kperf.h

   1 /*
   2  * Copyright (c) 2011 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_H__
  30 #define __KPERF_H__
  31
  32 #include <kern/thread.h>
  33
  34 /* The various trigger types supported by kperf */
  35 #define TRIGGER_TYPE_TIMER   (0)
  36 #define TRIGGER_TYPE_PMI     (1)
  37 #define TRIGGER_TYPE_TRACE   (2)
  38 #define TRIGGER_TYPE_CSWITCH (3)
  39
  40 /* Helpers to get and set AST bits on a thread */
  41 extern uint32_t kperf_get_thread_bits( thread_t thread );
  42 extern void     kperf_set_thread_bits( thread_t thread, uint32_t bits );
  43 extern void     kperf_set_thread_ast( thread_t thread );
  44
  45 /* Possible states of kperf sampling */
  46 #define KPERF_SAMPLING_OFF 0
  47 #define KPERF_SAMPLING_ON  1
  48 #define KPERF_SAMPLING_SHUTDOWN 2
  49
  50 /* Init kperf module. Must be called before use, can be called as many
  51  * times as you like.
  52  */
  53 extern int kperf_init(void);
  54
  55 /* Get and set sampling status */
  56 extern unsigned kperf_sampling_status(void);
  57 extern int kperf_sampling_enable(void);
  58 extern int kperf_sampling_disable(void);
  59
  60 /* kperf AST handler
  61  */
  62 extern void kperf_thread_ast_handler( thread_t thread );
  63
  64 /* kperf kdebug callback
  65  */
  66 extern void kperf_kdebug_callback(uint32_t debugid);
  67
  68 /* get and set whether we're recording stacks on interesting kdebug events */
  69 extern int kperf_kdbg_get_stacks(void);
  70 extern int kperf_kdbg_set_stacks(int);
  71
  72 /* get and set whether to trigger an action on signposts */
  73 extern int kperf_signpost_action_get(void);
  74 extern int kperf_signpost_action_set(int newval);
  75
  76 extern int kperf_cswitch_callback_set;
  77
  78 /* get and set whether to output tracepoints on context-switch */
  79 extern int kperf_kdbg_cswitch_get(void);
  80 extern int kperf_kdbg_cswitch_set(int newval);
  81
  82 /* get and set whether to trigger an action on context-switch */
  83 extern int kperf_cswitch_action_get(void);
  84 extern int kperf_cswitch_action_set(int newval);
  85
  86 /* given a task port, find out its pid */
  87 int kperf_port_to_pid(mach_port_name_t portname);
  88
  89 /* Check whether the current process has been blessed to allow access
  90  * to kperf facilities.
  91  */
  92 extern int kperf_access_check(void);
  93
  94 /* track recursion on kdebug tracepoint tracking */
  95 extern int kperf_kdbg_recurse(int step);
  96 #define KPERF_RECURSE_IN  (1)
  97 #define KPERF_RECURSE_OUT (-1)
  98
  99 /* context switch tracking */
 100 extern void kperf_switch_context( thread_t old, thread_t new );
 101
 102 /* bootstrap */
 103 extern void kperf_bootstrap(void);
 104
 105 #endif /* __KPERF_H__ */