1 #ifndef __MONO_PROFILER_H__
2 #define __MONO_PROFILER_H__
4 #include <mono/metadata/object.h>
5 #include <mono/metadata/appdomain.h>
9 #define MONO_PROFILER_MAX_STAT_CALL_CHAIN_DEPTH 128
12 MONO_PROFILE_NONE = 0,
13 MONO_PROFILE_APPDOMAIN_EVENTS = 1 << 0,
14 MONO_PROFILE_ASSEMBLY_EVENTS = 1 << 1,
15 MONO_PROFILE_MODULE_EVENTS = 1 << 2,
16 MONO_PROFILE_CLASS_EVENTS = 1 << 3,
17 MONO_PROFILE_JIT_COMPILATION = 1 << 4,
18 MONO_PROFILE_INLINING = 1 << 5,
19 MONO_PROFILE_EXCEPTIONS = 1 << 6,
20 MONO_PROFILE_ALLOCATIONS = 1 << 7,
21 MONO_PROFILE_GC = 1 << 8,
22 MONO_PROFILE_THREADS = 1 << 9,
23 MONO_PROFILE_REMOTING = 1 << 10,
24 MONO_PROFILE_TRANSITIONS = 1 << 11,
25 MONO_PROFILE_ENTER_LEAVE = 1 << 12,
26 MONO_PROFILE_COVERAGE = 1 << 13,
27 MONO_PROFILE_INS_COVERAGE = 1 << 14,
28 MONO_PROFILE_STATISTICAL = 1 << 15,
29 MONO_PROFILE_METHOD_EVENTS = 1 << 16,
30 MONO_PROFILE_MONITOR_EVENTS = 1 << 17,
31 MONO_PROFILE_IOMAP_EVENTS = 1 << 18, /* this should likely be removed, too */
32 MONO_PROFILE_GC_MOVES = 1 << 19,
33 MONO_PROFILE_GC_ROOTS = 1 << 20
43 MONO_GC_EVENT_MARK_START,
44 MONO_GC_EVENT_MARK_END,
45 MONO_GC_EVENT_RECLAIM_START,
46 MONO_GC_EVENT_RECLAIM_END,
48 MONO_GC_EVENT_PRE_STOP_WORLD,
49 MONO_GC_EVENT_POST_STOP_WORLD,
50 MONO_GC_EVENT_PRE_START_WORLD,
51 MONO_GC_EVENT_POST_START_WORLD
62 } MonoProfileCoverageEntry;
64 /* executable code buffer info */
66 MONO_PROFILER_CODE_BUFFER_UNKNOWN,
67 MONO_PROFILER_CODE_BUFFER_METHOD,
68 MONO_PROFILER_CODE_BUFFER_LAST
69 } MonoProfilerCodeBufferType;
71 typedef struct _MonoProfiler MonoProfiler;
74 MONO_PROFILER_MONITOR_CONTENTION = 1,
75 MONO_PROFILER_MONITOR_DONE = 2,
76 MONO_PROFILER_MONITOR_FAIL = 3
77 } MonoProfilerMonitorEvent;
80 MONO_PROFILER_CALL_CHAIN_NONE = 0,
81 MONO_PROFILER_CALL_CHAIN_NATIVE = 1,
82 MONO_PROFILER_CALL_CHAIN_GLIBC = 2,
83 MONO_PROFILER_CALL_CHAIN_MANAGED = 3,
84 MONO_PROFILER_CALL_CHAIN_INVALID = 4
85 } MonoProfilerCallChainStrategy;
88 MONO_PROFILER_GC_HANDLE_CREATED,
89 MONO_PROFILER_GC_HANDLE_DESTROYED
90 } MonoProfileGCHandleEvent;
93 MONO_PROFILE_GC_ROOT_PINNING = 1 << 8,
94 MONO_PROFILE_GC_ROOT_WEAKREF = 2 << 8,
95 MONO_PROFILE_GC_ROOT_INTERIOR = 4 << 8,
96 /* the above are flags, the type is in the low 2 bytes */
97 MONO_PROFILE_GC_ROOT_STACK = 0,
98 MONO_PROFILE_GC_ROOT_FINALIZER = 1,
99 MONO_PROFILE_GC_ROOT_HANDLE = 2,
100 MONO_PROFILE_GC_ROOT_OTHER = 3,
101 MONO_PROFILE_GC_ROOT_MISC = 4, /* could be stack, handle, etc. */
102 MONO_PROFILE_GC_ROOT_TYPEMASK = 0xff
103 } MonoProfileGCRootType;
106 * Functions that the runtime will call on the profiler.
109 typedef void (*MonoProfileFunc) (MonoProfiler *prof);
111 typedef void (*MonoProfileAppDomainFunc) (MonoProfiler *prof, MonoDomain *domain);
112 typedef void (*MonoProfileMethodFunc) (MonoProfiler *prof, MonoMethod *method);
113 typedef void (*MonoProfileClassFunc) (MonoProfiler *prof, MonoClass *klass);
114 typedef void (*MonoProfileModuleFunc) (MonoProfiler *prof, MonoImage *module);
115 typedef void (*MonoProfileAssemblyFunc) (MonoProfiler *prof, MonoAssembly *assembly);
116 typedef void (*MonoProfileMonitorFunc) (MonoProfiler *prof, MonoObject *obj, MonoProfilerMonitorEvent event);
118 typedef void (*MonoProfileExceptionFunc) (MonoProfiler *prof, MonoObject *object);
119 typedef void (*MonoProfileExceptionClauseFunc) (MonoProfiler *prof, MonoMethod *method, int clause_type, int clause_num);
121 typedef void (*MonoProfileAppDomainResult)(MonoProfiler *prof, MonoDomain *domain, int result);
122 typedef void (*MonoProfileMethodResult) (MonoProfiler *prof, MonoMethod *method, int result);
123 typedef void (*MonoProfileJitResult) (MonoProfiler *prof, MonoMethod *method, MonoJitInfo* jinfo, int result);
124 typedef void (*MonoProfileClassResult) (MonoProfiler *prof, MonoClass *klass, int result);
125 typedef void (*MonoProfileModuleResult) (MonoProfiler *prof, MonoImage *module, int result);
126 typedef void (*MonoProfileAssemblyResult) (MonoProfiler *prof, MonoAssembly *assembly, int result);
128 typedef void (*MonoProfileMethodInline) (MonoProfiler *prof, MonoMethod *parent, MonoMethod *child, int *ok);
130 typedef void (*MonoProfileThreadFunc) (MonoProfiler *prof, uintptr_t tid);
131 typedef void (*MonoProfileThreadNameFunc) (MonoProfiler *prof, uintptr_t tid, const char *name);
132 typedef void (*MonoProfileAllocFunc) (MonoProfiler *prof, MonoObject *obj, MonoClass *klass);
133 typedef void (*MonoProfileStatFunc) (MonoProfiler *prof, mono_byte *ip, void *context);
134 typedef void (*MonoProfileStatCallChainFunc) (MonoProfiler *prof, int call_chain_depth, mono_byte **ip, void *context);
135 typedef void (*MonoProfileGCFunc) (MonoProfiler *prof, MonoGCEvent event, int generation);
136 typedef void (*MonoProfileGCMoveFunc) (MonoProfiler *prof, void **objects, int num);
137 typedef void (*MonoProfileGCResizeFunc) (MonoProfiler *prof, int64_t new_size);
138 typedef void (*MonoProfileGCHandleFunc) (MonoProfiler *prof, int op, int type, uintptr_t handle, MonoObject *obj);
139 typedef void (*MonoProfileGCRootFunc) (MonoProfiler *prof, int num_roots, void **objects, int *root_types, uintptr_t *extra_info);
141 typedef void (*MonoProfileIomapFunc) (MonoProfiler *prof, const char *report, const char *pathname, const char *new_pathname);
143 typedef mono_bool (*MonoProfileCoverageFilterFunc) (MonoProfiler *prof, MonoMethod *method);
145 typedef void (*MonoProfileCoverageFunc) (MonoProfiler *prof, const MonoProfileCoverageEntry *entry);
147 typedef void (*MonoProfilerCodeChunkNew) (MonoProfiler *prof, void* chunk, int size);
148 typedef void (*MonoProfilerCodeChunkDestroy) (MonoProfiler *prof, void* chunk);
149 typedef void (*MonoProfilerCodeBufferNew) (MonoProfiler *prof, void* buffer, int size, MonoProfilerCodeBufferType type, void *data);
152 * Function the profiler may call.
154 void mono_profiler_install (MonoProfiler *prof, MonoProfileFunc shutdown_callback);
155 void mono_profiler_set_events (MonoProfileFlags events);
157 MonoProfileFlags mono_profiler_get_events (void);
159 void mono_profiler_install_appdomain (MonoProfileAppDomainFunc start_load, MonoProfileAppDomainResult end_load,
160 MonoProfileAppDomainFunc start_unload, MonoProfileAppDomainFunc end_unload);
161 void mono_profiler_install_assembly (MonoProfileAssemblyFunc start_load, MonoProfileAssemblyResult end_load,
162 MonoProfileAssemblyFunc start_unload, MonoProfileAssemblyFunc end_unload);
163 void mono_profiler_install_module (MonoProfileModuleFunc start_load, MonoProfileModuleResult end_load,
164 MonoProfileModuleFunc start_unload, MonoProfileModuleFunc end_unload);
165 void mono_profiler_install_class (MonoProfileClassFunc start_load, MonoProfileClassResult end_load,
166 MonoProfileClassFunc start_unload, MonoProfileClassFunc end_unload);
168 void mono_profiler_install_jit_compile (MonoProfileMethodFunc start, MonoProfileMethodResult end);
169 void mono_profiler_install_jit_end (MonoProfileJitResult end);
170 void mono_profiler_install_method_free (MonoProfileMethodFunc callback);
171 void mono_profiler_install_method_invoke (MonoProfileMethodFunc start, MonoProfileMethodFunc end);
172 void mono_profiler_install_enter_leave (MonoProfileMethodFunc enter, MonoProfileMethodFunc fleave);
173 void mono_profiler_install_thread (MonoProfileThreadFunc start, MonoProfileThreadFunc end);
174 void mono_profiler_install_thread_name (MonoProfileThreadNameFunc thread_name_cb);
175 void mono_profiler_install_transition (MonoProfileMethodResult callback);
176 void mono_profiler_install_allocation (MonoProfileAllocFunc callback);
177 void mono_profiler_install_monitor (MonoProfileMonitorFunc callback);
178 void mono_profiler_install_statistical (MonoProfileStatFunc callback);
179 void mono_profiler_install_statistical_call_chain (MonoProfileStatCallChainFunc callback, int call_chain_depth, MonoProfilerCallChainStrategy call_chain_strategy);
180 void mono_profiler_install_exception (MonoProfileExceptionFunc throw_callback, MonoProfileMethodFunc exc_method_leave, MonoProfileExceptionClauseFunc clause_callback);
181 void mono_profiler_install_coverage_filter (MonoProfileCoverageFilterFunc callback);
182 void mono_profiler_coverage_get (MonoProfiler *prof, MonoMethod *method, MonoProfileCoverageFunc func);
183 void mono_profiler_install_gc (MonoProfileGCFunc callback, MonoProfileGCResizeFunc heap_resize_callback);
184 void mono_profiler_install_gc_moves (MonoProfileGCMoveFunc callback);
185 void mono_profiler_install_gc_roots (MonoProfileGCHandleFunc handle_callback, MonoProfileGCRootFunc roots_callback);
186 void mono_profiler_install_runtime_initialized (MonoProfileFunc runtime_initialized_callback);
188 void mono_profiler_install_code_chunk_new (MonoProfilerCodeChunkNew callback);
189 void mono_profiler_install_code_chunk_destroy (MonoProfilerCodeChunkDestroy callback);
190 void mono_profiler_install_code_buffer_new (MonoProfilerCodeBufferNew callback);
192 void mono_profiler_install_iomap (MonoProfileIomapFunc callback);
194 void mono_profiler_load (const char *desc);
198 #endif /* __MONO_PROFILER_H__ */