]>
Commit | Line | Data |
---|---|---|
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 | #include <kern/locks.h> | |
34 | ||
35 | extern lck_grp_t kperf_lck_grp; | |
36 | ||
37 | /* the trigger types supported by kperf */ | |
38 | #define TRIGGER_TYPE_TIMER (0) | |
39 | #define TRIGGER_TYPE_PMI (1) | |
40 | #define TRIGGER_TYPE_KDEBUG (2) | |
41 | ||
42 | /* helpers to get and set AST flags on a thread */ | |
43 | uint32_t kperf_get_thread_flags(thread_t thread); | |
44 | void kperf_set_thread_flags(thread_t thread, uint32_t flags); | |
45 | ||
46 | /* | |
47 | * Get and set dirtiness of thread, so kperf can track whether the thread | |
48 | * has been dispatched since it last looked. | |
49 | */ | |
50 | boolean_t kperf_thread_get_dirty(thread_t thread); | |
51 | void kperf_thread_set_dirty(thread_t thread, boolean_t dirty); | |
52 | ||
53 | /* possible states of kperf sampling */ | |
54 | #define KPERF_SAMPLING_OFF (0) | |
55 | #define KPERF_SAMPLING_ON (1) | |
56 | #define KPERF_SAMPLING_SHUTDOWN (2) | |
57 | ||
58 | /* | |
59 | * Initialize kperf. Must be called before use and can be called multiple times. | |
60 | */ | |
61 | extern int kperf_init(void); | |
62 | ||
63 | /* get and set sampling status */ | |
64 | extern unsigned kperf_sampling_status(void); | |
65 | extern int kperf_sampling_enable(void); | |
66 | extern int kperf_sampling_disable(void); | |
67 | ||
68 | /* get a per-CPU sample buffer */ | |
69 | struct kperf_sample *kperf_intr_sample_buffer(void); | |
70 | ||
71 | /* | |
72 | * kperf AST handler | |
73 | */ | |
74 | extern __attribute__((noinline)) void kperf_thread_ast_handler(thread_t thread); | |
75 | ||
76 | /* | |
77 | * thread on core callback | |
78 | */ | |
79 | ||
80 | /* controls whether the callback is called on context switch */ | |
81 | extern boolean_t kperf_on_cpu_active; | |
82 | ||
83 | /* update whether the callback is set */ | |
84 | void kperf_on_cpu_update(void); | |
85 | ||
86 | /* handle a thread being switched on */ | |
87 | void kperf_on_cpu_internal(thread_t thread, thread_continue_t continuation, | |
88 | uintptr_t *starting_fp); | |
89 | ||
90 | /* for scheduler threads switching threads on */ | |
91 | static inline void | |
92 | kperf_on_cpu(thread_t thread, thread_continue_t continuation, | |
93 | uintptr_t *starting_fp) | |
94 | { | |
95 | if (__improbable(kperf_on_cpu_active)) { | |
96 | kperf_on_cpu_internal(thread, continuation, starting_fp); | |
97 | } | |
98 | } | |
99 | ||
100 | /* | |
101 | * kdebug callback | |
102 | */ | |
103 | ||
104 | /* controls whether the kdebug callback is called */ | |
105 | extern boolean_t kperf_kdebug_active; | |
106 | ||
107 | /* handle the kdebug event */ | |
108 | void kperf_kdebug_callback_internal(uint32_t debugid); | |
109 | ||
110 | /* handle a kdebug event */ | |
111 | void kperf_kdebug_handler(uint32_t debugid, uintptr_t *starting_fp); | |
112 | ||
113 | /* called inside of kernel_debug_internal */ | |
114 | static inline void | |
115 | kperf_kdebug_callback(uint32_t debugid, uintptr_t *starting_fp) | |
116 | { | |
117 | if (__improbable(kperf_kdebug_active)) { | |
118 | kperf_kdebug_handler(debugid, starting_fp); | |
119 | } | |
120 | } | |
121 | ||
122 | /* | |
123 | * Used by ktrace to reset kperf. ktrace_lock must be held. | |
124 | */ | |
125 | extern void kperf_reset(void); | |
126 | ||
127 | /* | |
128 | * Configure kperf from the kernel (e.g. during boot). | |
129 | */ | |
130 | void kperf_kernel_configure(const char *config); | |
131 | ||
132 | /* get and set whether we're recording stacks on interesting kdebug events */ | |
133 | extern int kperf_kdbg_get_stacks(void); | |
134 | extern int kperf_kdbg_set_stacks(int); | |
135 | ||
136 | extern int kperf_kdebug_cswitch; | |
137 | ||
138 | #if DEVELOPMENT || DEBUG | |
139 | extern _Atomic long long kperf_pending_ipis; | |
140 | #endif /* DEVELOPMENT || DEBUG */ | |
141 | ||
142 | /* get and set whether to output tracepoints on context-switch */ | |
143 | extern int kperf_kdbg_cswitch_get(void); | |
144 | extern int kperf_kdbg_cswitch_set(int newval); | |
145 | ||
146 | /* given a task port, find out its pid */ | |
147 | int kperf_port_to_pid(mach_port_name_t portname); | |
148 | ||
149 | #endif /* !defined(KPERF_H) */ |