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