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