[profiler] Add GC finalization events to the format.
[mono.git] / mono / profiler / proflog.h
1 #ifndef __MONO_PROFLOG_H__
2 #define __MONO_PROFLOG_H__
3
4 #define BUF_ID 0x4D504C01
5 #define LOG_HEADER_ID 0x4D505A01
6 #define LOG_VERSION_MAJOR 0
7 #define LOG_VERSION_MINOR 4
8 #define LOG_DATA_VERSION 13
9 /*
10  * Changes in data versions:
11  * version 2: added offsets in heap walk
12  * version 3: added GC roots
13  * version 4: added sample/statistical profiling
14  * version 5: added counters sampling
15  * version 6: added optional backtrace in sampling info
16  * version 8: added TYPE_RUNTIME and JIT helpers/trampolines
17  * version 9: added MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING
18  * version 10: added TYPE_COVERAGE
19  * version 11: added thread ID to TYPE_SAMPLE_HIT
20                added more load/unload events
21                    unload for class
22                    unload for image
23                    load/unload for appdomain
24                    load/unload for contexts
25                    load/unload/name for assemblies
26                removed TYPE_LOAD_ERR flag (profiler never generated it, now removed from the format itself)
27                added TYPE_GC_HANDLE_{CREATED,DESTROYED}_BT
28                TYPE_JIT events are no longer guaranteed to have code start/size info (can be zero)
29  * version 12: added MONO_COUNTER_PROFILER
30  * version 13: added MONO_GC_EVENT_{PRE_STOP_WORLD_LOCKED,POST_START_WORLD_UNLOCKED}
31                added TYPE_META + TYPE_SYNC_POINT
32                removed il and native offset in TYPE_SAMPLE_HIT
33                methods in backtraces are now encoded as proper method pointers
34                removed flags in backtrace format
35                removed flags in metadata events
36                changed the following fields to a single byte rather than leb128
37                    TYPE_GC_EVENT: event_type, generation
38                    TYPE_HEAP_ROOT: root_type
39                    TYPE_JITHELPER: type
40                    TYPE_SAMPLE_HIT: sample_type
41                    TYPE_CLAUSE: clause_type
42                    TYPE_SAMPLE_COUNTERS_DESC: type, unit, variance
43                    TYPE_SAMPLE_COUNTERS: type
44                added time fields to all events that were missing one
45                    TYPE_HEAP_OBJECT
46                    TYPE_HEAP_ROOT
47                    TYPE_SAMPLE_USYM
48                    TYPE_SAMPLE_COUNTERS_DESC
49                    TYPE_COVERAGE_METHOD
50                    TYPE_COVERAGE_STATEMENT
51                    TYPE_COVERAGE_CLASS
52                    TYPE_COVERAGE_ASSEMBLY
53                moved the time field in TYPE_SAMPLE_HIT to right after the event byte, now encoded as a regular time field
54                changed the time field in TYPE_SAMPLE_COUNTERS to be encoded as a regular time field (in nanoseconds)
55                added TYPE_GC_FINALIZE_{START,END,OBJECT_START,OBJECT_END}
56  */
57
58 enum {
59         TYPE_ALLOC,
60         TYPE_GC,
61         TYPE_METADATA,
62         TYPE_METHOD,
63         TYPE_EXCEPTION,
64         TYPE_MONITOR,
65         TYPE_HEAP,
66         TYPE_SAMPLE,
67         TYPE_RUNTIME,
68         TYPE_COVERAGE,
69         TYPE_META,
70         /* extended type for TYPE_HEAP */
71         TYPE_HEAP_START  = 0 << 4,
72         TYPE_HEAP_END    = 1 << 4,
73         TYPE_HEAP_OBJECT = 2 << 4,
74         TYPE_HEAP_ROOT   = 3 << 4,
75         /* extended type for TYPE_METADATA */
76         TYPE_END_LOAD     = 2 << 4,
77         TYPE_END_UNLOAD   = 4 << 4,
78         /* metadata type byte for TYPE_METADATA */
79         TYPE_CLASS     = 1,
80         TYPE_IMAGE     = 2,
81         TYPE_ASSEMBLY  = 3,
82         TYPE_DOMAIN    = 4,
83         TYPE_THREAD    = 5,
84         TYPE_CONTEXT   = 6,
85         /* extended type for TYPE_GC */
86         TYPE_GC_EVENT  = 1 << 4,
87         TYPE_GC_RESIZE = 2 << 4,
88         TYPE_GC_MOVE   = 3 << 4,
89         TYPE_GC_HANDLE_CREATED      = 4 << 4,
90         TYPE_GC_HANDLE_DESTROYED    = 5 << 4,
91         TYPE_GC_HANDLE_CREATED_BT   = 6 << 4,
92         TYPE_GC_HANDLE_DESTROYED_BT = 7 << 4,
93         TYPE_GC_FINALIZE_START = 8 << 4,
94         TYPE_GC_FINALIZE_END = 9 << 4,
95         TYPE_GC_FINALIZE_OBJECT_START = 10 << 4,
96         TYPE_GC_FINALIZE_OBJECT_END = 11 << 4,
97         /* extended type for TYPE_METHOD */
98         TYPE_LEAVE     = 1 << 4,
99         TYPE_ENTER     = 2 << 4,
100         TYPE_EXC_LEAVE = 3 << 4,
101         TYPE_JIT       = 4 << 4,
102         /* extended type for TYPE_EXCEPTION */
103         TYPE_THROW        = 0 << 4,
104         TYPE_CLAUSE       = 1 << 4,
105         TYPE_EXCEPTION_BT = 1 << 7,
106         /* extended type for TYPE_ALLOC */
107         TYPE_ALLOC_NO_BT  = 0 << 4,
108         TYPE_ALLOC_BT     = 1 << 4,
109         /* extended type for TYPE_MONITOR */
110         TYPE_MONITOR_NO_BT  = 0 << 7,
111         TYPE_MONITOR_BT     = 1 << 7,
112         /* extended type for TYPE_SAMPLE */
113         TYPE_SAMPLE_HIT           = 0 << 4,
114         TYPE_SAMPLE_USYM          = 1 << 4,
115         TYPE_SAMPLE_UBIN          = 2 << 4,
116         TYPE_SAMPLE_COUNTERS_DESC = 3 << 4,
117         TYPE_SAMPLE_COUNTERS      = 4 << 4,
118         /* extended type for TYPE_RUNTIME */
119         TYPE_JITHELPER = 1 << 4,
120         /* extended type for TYPE_COVERAGE */
121         TYPE_COVERAGE_ASSEMBLY = 0 << 4,
122         TYPE_COVERAGE_METHOD   = 1 << 4,
123         TYPE_COVERAGE_STATEMENT = 2 << 4,
124         TYPE_COVERAGE_CLASS = 3 << 4,
125         /* extended type for TYPE_META */
126         TYPE_SYNC_POINT = 0 << 4,
127         TYPE_END
128 };
129
130 typedef enum {
131         SYNC_POINT_PERIODIC,
132         SYNC_POINT_WORLD_STOP,
133         SYNC_POINT_WORLD_START
134 } MonoProfilerSyncPointType;
135
136 // Sampling sources
137 // Unless you have compiled with --enable-perf-events, only SAMPLE_CYCLES is available
138 enum {
139         SAMPLE_CYCLES = 1,
140         SAMPLE_INSTRUCTIONS,
141         SAMPLE_CACHE_MISSES,
142         SAMPLE_CACHE_REFS,
143         SAMPLE_BRANCHES,
144         SAMPLE_BRANCH_MISSES,
145         SAMPLE_LAST
146 };
147
148 #endif /* __MONO_PROFLOG_H__ */