1 #ifndef __MONO_PROFLOG_H__
2 #define __MONO_PROFLOG_H__
5 #include <mono/metadata/profiler.h>
7 #define BUF_ID 0x4D504C01
8 #define LOG_HEADER_ID 0x4D505A01
9 #define LOG_VERSION_MAJOR 1
10 #define LOG_VERSION_MINOR 1
11 #define LOG_DATA_VERSION 13
14 * Changes in major/minor versions:
15 * version 1.0: removed sysid field from header
16 * added args, arch, os fields to header
18 * Changes in data versions:
19 * version 2: added offsets in heap walk
20 * version 3: added GC roots
21 * version 4: added sample/statistical profiling
22 * version 5: added counters sampling
23 * version 6: added optional backtrace in sampling info
24 * version 8: added TYPE_RUNTIME and JIT helpers/trampolines
25 * version 9: added MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING
26 * version 10: added TYPE_COVERAGE
27 * version 11: added thread ID to TYPE_SAMPLE_HIT
28 added more load/unload events
31 load/unload for appdomain
32 load/unload for contexts
33 load/unload/name for assemblies
34 removed TYPE_LOAD_ERR flag (profiler never generated it, now removed from the format itself)
35 added TYPE_GC_HANDLE_{CREATED,DESTROYED}_BT
36 TYPE_JIT events are no longer guaranteed to have code start/size info (can be zero)
37 * version 12: added MONO_COUNTER_PROFILER
38 * version 13: added MONO_GC_EVENT_{PRE_STOP_WORLD_LOCKED,POST_START_WORLD_UNLOCKED}
39 added TYPE_META + TYPE_SYNC_POINT
40 removed il and native offset in TYPE_SAMPLE_HIT
41 methods in backtraces are now encoded as proper method pointers
42 removed flags in backtrace format
43 removed flags in metadata events
44 changed the following fields to a single byte rather than leb128
45 TYPE_GC_EVENT: event_type, generation
46 TYPE_HEAP_ROOT: root_type
48 TYPE_SAMPLE_HIT: sample_type
49 TYPE_CLAUSE: clause_type
50 TYPE_SAMPLE_COUNTERS_DESC: type, unit, variance
51 TYPE_SAMPLE_COUNTERS: type
52 added time fields to all events that were missing one
56 TYPE_SAMPLE_COUNTERS_DESC
58 TYPE_COVERAGE_STATEMENT
60 TYPE_COVERAGE_ASSEMBLY
61 moved the time field in TYPE_SAMPLE_HIT to right after the event byte, now encoded as a regular time field
62 changed the time field in TYPE_SAMPLE_COUNTERS to be encoded as a regular time field (in nanoseconds)
63 added TYPE_GC_FINALIZE_{START,END,OBJECT_START,OBJECT_END}
78 /* extended type for TYPE_HEAP */
79 TYPE_HEAP_START
= 0 << 4,
80 TYPE_HEAP_END
= 1 << 4,
81 TYPE_HEAP_OBJECT
= 2 << 4,
82 TYPE_HEAP_ROOT
= 3 << 4,
83 /* extended type for TYPE_METADATA */
84 TYPE_END_LOAD
= 2 << 4,
85 TYPE_END_UNLOAD
= 4 << 4,
86 /* extended type for TYPE_GC */
87 TYPE_GC_EVENT
= 1 << 4,
88 TYPE_GC_RESIZE
= 2 << 4,
89 TYPE_GC_MOVE
= 3 << 4,
90 TYPE_GC_HANDLE_CREATED
= 4 << 4,
91 TYPE_GC_HANDLE_DESTROYED
= 5 << 4,
92 TYPE_GC_HANDLE_CREATED_BT
= 6 << 4,
93 TYPE_GC_HANDLE_DESTROYED_BT
= 7 << 4,
94 TYPE_GC_FINALIZE_START
= 8 << 4,
95 TYPE_GC_FINALIZE_END
= 9 << 4,
96 TYPE_GC_FINALIZE_OBJECT_START
= 10 << 4,
97 TYPE_GC_FINALIZE_OBJECT_END
= 11 << 4,
98 /* extended type for TYPE_METHOD */
101 TYPE_EXC_LEAVE
= 3 << 4,
103 /* extended type for TYPE_EXCEPTION */
104 TYPE_THROW_NO_BT
= 0 << 7,
105 TYPE_THROW_BT
= 1 << 7,
106 TYPE_CLAUSE
= 1 << 4,
107 /* extended type for TYPE_ALLOC */
108 TYPE_ALLOC_NO_BT
= 0 << 4,
109 TYPE_ALLOC_BT
= 1 << 4,
110 /* extended type for TYPE_MONITOR */
111 TYPE_MONITOR_NO_BT
= 0 << 7,
112 TYPE_MONITOR_BT
= 1 << 7,
113 /* extended type for TYPE_SAMPLE */
114 TYPE_SAMPLE_HIT
= 0 << 4,
115 TYPE_SAMPLE_USYM
= 1 << 4,
116 TYPE_SAMPLE_UBIN
= 2 << 4,
117 TYPE_SAMPLE_COUNTERS_DESC
= 3 << 4,
118 TYPE_SAMPLE_COUNTERS
= 4 << 4,
119 /* extended type for TYPE_RUNTIME */
120 TYPE_JITHELPER
= 1 << 4,
121 /* extended type for TYPE_COVERAGE */
122 TYPE_COVERAGE_ASSEMBLY
= 0 << 4,
123 TYPE_COVERAGE_METHOD
= 1 << 4,
124 TYPE_COVERAGE_STATEMENT
= 2 << 4,
125 TYPE_COVERAGE_CLASS
= 3 << 4,
126 /* extended type for TYPE_META */
127 TYPE_SYNC_POINT
= 0 << 4,
132 /* metadata type byte for TYPE_METADATA */
143 SYNC_POINT_WORLD_STOP
,
144 SYNC_POINT_WORLD_START
145 } MonoProfilerSyncPointType
;
148 // Unless you have compiled with --enable-perf-events, only SAMPLE_CYCLES is available
155 SAMPLE_BRANCH_MISSES
,
160 // If you alter MAX_FRAMES, you may need to alter SAMPLE_BLOCK_SIZE too.
161 #define MAX_FRAMES 32
163 //The following flags control emitting individual events
164 #define PROFLOG_DOMAIN_EVENTS (1 << 0)
165 #define PROFLOG_ASSEMBLY_EVENTS (1 << 1)
166 #define PROFLOG_MODULE_EVENTS (1 << 2)
167 #define PROFLOG_CLASS_EVENTS (1 << 3)
168 #define PROFLOG_JIT_COMPILATION_EVENTS (1 << 4)
169 #define PROFLOG_EXCEPTION_EVENTS (1 << 5)
170 #define PROFLOG_ALLOCATION_EVENTS (1 << 6)
171 #define PROFLOG_GC_EVENTS (1 << 7)
172 #define PROFLOG_THREAD_EVENTS (1 << 8)
173 //This generate enter/leave events
174 #define PROFLOG_CALL_EVENTS (1 << 9)
175 #define PROFLOG_INS_COVERAGE_EVENTS (1 << 10)
176 #define PROFLOG_SAMPLING_EVENTS (1 << 11)
177 #define PROFLOG_MONITOR_EVENTS (1 << 12)
178 #define PROFLOG_GC_MOVES_EVENTS (1 << 13)
180 #define PROFLOG_GC_ROOT_EVENTS (1 << 14)
181 #define PROFLOG_CONTEXT_EVENTS (1 << 15)
182 #define PROFLOG_FINALIZATION_EVENTS (1 << 16)
183 #define PROFLOG_COUNTER_EVENTS (1 << 17)
184 #define PROFLOG_GC_HANDLE_EVENTS (1 << 18)
186 //The following flags control whole subsystems
187 //Enables code coverage generation
188 #define PROFLOG_CODE_COV_FEATURE (1 << 19)
189 //This enables sampling to be generated
190 #define PROFLOG_SAMPLING_FEATURE (1 << 20)
191 //This enable heap dumping during GCs and filter GCRoots and GCHandle events outside of the dumped collections
192 #define PROFLOG_HEAPSHOT_FEATURE (1 << 21)
196 //The follow flags are the common aliases we want ppl to use
197 #define PROFLOG_TYPELOADING_ALIAS (PROFLOG_DOMAIN_EVENTS | PROFLOG_ASSEMBLY_EVENTS | PROFLOG_MODULE_EVENTS | PROFLOG_CLASS_EVENTS)
198 #define PROFLOG_CODECOV_ALIAS (PROFLOG_GC_EVENTS | PROFLOG_THREAD_EVENTS | PROFLOG_CALL_EVENTS | PROFLOG_INS_COVERAGE_EVENTS | PROFLOG_CODE_COV_FEATURE)
199 #define PROFLOG_PERF_SAMPLING_ALIAS (PROFLOG_TYPELOADING_ALIAS | PROFLOG_THREAD_EVENTS | PROFLOG_SAMPLING_EVENTS | PROFLOG_SAMPLING_FEATURE)
200 #define PROFLOG_GC_ALLOC_ALIAS (PROFLOG_TYPELOADING_ALIAS | PROFLOG_THREAD_EVENTS | PROFLOG_GC_EVENTS | PROFLOG_ALLOCATION_EVENTS)
201 #define PROFLOG_HEAPSHOT_ALIAS (PROFLOG_TYPELOADING_ALIAS | PROFLOG_THREAD_EVENTS | PROFLOG_GC_EVENTS | PROFLOG_GC_ROOT_EVENTS | PROFLOG_HEAPSHOT_FEATURE)
202 #define PROFLOG_LEGACY_ALIAS (PROFLOG_TYPELOADING_ALIAS | PROFLOG_GC_EVENTS | PROFLOG_THREAD_EVENTS | PROFLOG_JIT_COMPILATION_EVENTS | PROFLOG_EXCEPTION_EVENTS | PROFLOG_MONITOR_EVENTS | PROFLOG_GC_ROOT_EVENTS | PROFLOG_CONTEXT_EVENTS | PROFLOG_FINALIZATION_EVENTS | PROFLOG_COUNTER_EVENTS)
206 //Events explicitly enabled
208 //Events explicitly disabled
211 //Actual mask the profiler should use
214 //Emit a report at the end of execution
217 //Enable profiler internal debugging
220 //Enable code coverage specific debugging
221 gboolean debug_coverage
;
223 //Where to compress the output file
226 //If true, don't generate stacktraces
229 //If true, emit coverage but don't emit enter/exit events - this happens cuz they share an event
230 gboolean only_coverage
;
232 //If true, heapshots are generated on demand only
233 gboolean hs_mode_ondemand
;
235 //HeapShort frequency in milliseconds
236 unsigned int hs_mode_ms
;
238 //HeapShort frequency in number of collections
239 unsigned int hs_mode_gc
;
241 //Sample frequency in Hertz
244 //Maximum number of frames to collect
247 //Max depth to record enter/leave events
250 //Name of the generated mlpd file
251 const char *output_filename
;
253 //Filter files used by the code coverage mode
254 GPtrArray
*cov_filter_files
;
256 //Port to listen for profiling commands
259 //Max size of the sample hit buffer, we'll drop frames if it's reached
260 int max_allocated_sample_hits
;
262 MonoProfileSamplingMode sampling_mode
;
265 void proflog_parse_args (ProfilerConfig
*config
, const char *desc
);
267 #endif /* __MONO_PROFLOG_H__ */