mono/profiler/log.h

   1 #ifndef __MONO_PROFLOG_H__
   2 #define __MONO_PROFLOG_H__
   3
   4 #include <glib.h>
   5 #define MONO_PROFILER_UNSTABLE_GC_ROOTS
   6 #include <mono/metadata/profiler.h>
   7
   8 #define BUF_ID 0x4D504C01
   9 #define LOG_HEADER_ID 0x4D505A01
  10 #define LOG_VERSION_MAJOR 2
  11 #define LOG_VERSION_MINOR 0
  12 #define LOG_DATA_VERSION 14
  13
  14 /*
  15  * Changes in major/minor versions:
  16  * version 1.0: removed sysid field from header
  17  *              added args, arch, os fields to header
  18  *
  19  * Changes in data versions:
  20  * version 2: added offsets in heap walk
  21  * version 3: added GC roots
  22  * version 4: added sample/statistical profiling
  23  * version 5: added counters sampling
  24  * version 6: added optional backtrace in sampling info
  25  * version 8: added TYPE_RUNTIME and JIT helpers/trampolines
  26  * version 9: added MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING
  27  * version 10: added TYPE_COVERAGE
  28  * version 11: added thread ID to TYPE_SAMPLE_HIT
  29                added more load/unload events
  30                    unload for class
  31                    unload for image
  32                    load/unload for appdomain
  33                    load/unload for contexts
  34                    load/unload/name for assemblies
  35                removed TYPE_LOAD_ERR flag (profiler never generated it, now removed from the format itself)
  36                added TYPE_GC_HANDLE_{CREATED,DESTROYED}_BT
  37                TYPE_JIT events are no longer guaranteed to have code start/size info (can be zero)
  38  * version 12: added MONO_COUNTER_PROFILER
  39  * version 13: added MONO_GC_EVENT_{PRE_STOP_WORLD_LOCKED,POST_START_WORLD_UNLOCKED}
  40                added TYPE_META + TYPE_SYNC_POINT
  41                removed il and native offset in TYPE_SAMPLE_HIT
  42                methods in backtraces are now encoded as proper method pointers
  43                removed flags in backtrace format
  44                removed flags in metadata events
  45                changed the following fields to a single byte rather than leb128
  46                    TYPE_GC_EVENT: event_type, generation
  47                    TYPE_HEAP_ROOT: root_type
  48                    TYPE_JITHELPER: type
  49                    TYPE_SAMPLE_HIT: sample_type
  50                    TYPE_CLAUSE: clause_type
  51                    TYPE_SAMPLE_COUNTERS_DESC: type, unit, variance
  52                    TYPE_SAMPLE_COUNTERS: type
  53                added time fields to all events that were missing one
  54                    TYPE_HEAP_OBJECT
  55                    TYPE_HEAP_ROOT
  56                    TYPE_SAMPLE_USYM
  57                    TYPE_SAMPLE_COUNTERS_DESC
  58                    TYPE_COVERAGE_METHOD
  59                    TYPE_COVERAGE_STATEMENT
  60                    TYPE_COVERAGE_CLASS
  61                    TYPE_COVERAGE_ASSEMBLY
  62                moved the time field in TYPE_SAMPLE_HIT to right after the event byte, now encoded as a regular time field
  63                changed the time field in TYPE_SAMPLE_COUNTERS to be encoded as a regular time field (in nanoseconds)
  64                added TYPE_GC_FINALIZE_{START,END,OBJECT_START,OBJECT_END}
  65  * version 14: added event field to TYPE_MONITOR instead of encoding it in the extended info
  66                all TYPE_MONITOR events can now contain backtraces
  67                changed address field in TYPE_SAMPLE_UBIN to be based on ptr_base
  68                added an image pointer field to assembly load events
  69                added an exception object field to TYPE_CLAUSE
  70                class unload events no longer exist (they were never emitted)
  71                removed type field from TYPE_SAMPLE_HIT
  72  */
  73
  74 enum {
  75         TYPE_ALLOC,
  76         TYPE_GC,
  77         TYPE_METADATA,
  78         TYPE_METHOD,
  79         TYPE_EXCEPTION,
  80         TYPE_MONITOR,
  81         TYPE_HEAP,
  82         TYPE_SAMPLE,
  83         TYPE_RUNTIME,
  84         TYPE_COVERAGE,
  85         TYPE_META,
  86         /* extended type for TYPE_HEAP */
  87         TYPE_HEAP_START  = 0 << 4,
  88         TYPE_HEAP_END    = 1 << 4,
  89         TYPE_HEAP_OBJECT = 2 << 4,
  90         TYPE_HEAP_ROOT   = 3 << 4,
  91         /* extended type for TYPE_METADATA */
  92         TYPE_END_LOAD     = 2 << 4,
  93         TYPE_END_UNLOAD   = 4 << 4,
  94         /* extended type for TYPE_GC */
  95         TYPE_GC_EVENT  = 1 << 4,
  96         TYPE_GC_RESIZE = 2 << 4,
  97         TYPE_GC_MOVE   = 3 << 4,
  98         TYPE_GC_HANDLE_CREATED      = 4 << 4,
  99         TYPE_GC_HANDLE_DESTROYED    = 5 << 4,
 100         TYPE_GC_HANDLE_CREATED_BT   = 6 << 4,
 101         TYPE_GC_HANDLE_DESTROYED_BT = 7 << 4,
 102         TYPE_GC_FINALIZE_START = 8 << 4,
 103         TYPE_GC_FINALIZE_END = 9 << 4,
 104         TYPE_GC_FINALIZE_OBJECT_START = 10 << 4,
 105         TYPE_GC_FINALIZE_OBJECT_END = 11 << 4,
 106         /* extended type for TYPE_METHOD */
 107         TYPE_LEAVE     = 1 << 4,
 108         TYPE_ENTER     = 2 << 4,
 109         TYPE_EXC_LEAVE = 3 << 4,
 110         TYPE_JIT       = 4 << 4,
 111         /* extended type for TYPE_EXCEPTION */
 112         TYPE_THROW_NO_BT = 0 << 7,
 113         TYPE_THROW_BT    = 1 << 7,
 114         TYPE_CLAUSE      = 1 << 4,
 115         /* extended type for TYPE_ALLOC */
 116         TYPE_ALLOC_NO_BT  = 0 << 4,
 117         TYPE_ALLOC_BT     = 1 << 4,
 118         /* extended type for TYPE_MONITOR */
 119         TYPE_MONITOR_NO_BT  = 0 << 7,
 120         TYPE_MONITOR_BT     = 1 << 7,
 121         /* extended type for TYPE_SAMPLE */
 122         TYPE_SAMPLE_HIT           = 0 << 4,
 123         TYPE_SAMPLE_USYM          = 1 << 4,
 124         TYPE_SAMPLE_UBIN          = 2 << 4,
 125         TYPE_SAMPLE_COUNTERS_DESC = 3 << 4,
 126         TYPE_SAMPLE_COUNTERS      = 4 << 4,
 127         /* extended type for TYPE_RUNTIME */
 128         TYPE_JITHELPER = 1 << 4,
 129         /* extended type for TYPE_COVERAGE */
 130         TYPE_COVERAGE_ASSEMBLY = 0 << 4,
 131         TYPE_COVERAGE_METHOD   = 1 << 4,
 132         TYPE_COVERAGE_STATEMENT = 2 << 4,
 133         TYPE_COVERAGE_CLASS = 3 << 4,
 134         /* extended type for TYPE_META */
 135         TYPE_SYNC_POINT = 0 << 4,
 136 };
 137
 138 enum {
 139         /* metadata type byte for TYPE_METADATA */
 140         TYPE_CLASS    = 1,
 141         TYPE_IMAGE    = 2,
 142         TYPE_ASSEMBLY = 3,
 143         TYPE_DOMAIN   = 4,
 144         TYPE_THREAD   = 5,
 145         TYPE_CONTEXT  = 6,
 146 };
 147
 148 typedef enum {
 149         SYNC_POINT_PERIODIC = 0,
 150         SYNC_POINT_WORLD_STOP = 1,
 151         SYNC_POINT_WORLD_START = 2,
 152 } MonoProfilerSyncPointType;
 153
 154 typedef enum {
 155         MONO_PROFILER_MONITOR_CONTENTION = 1,
 156         MONO_PROFILER_MONITOR_DONE = 2,
 157         MONO_PROFILER_MONITOR_FAIL = 3,
 158 } MonoProfilerMonitorEvent;
 159
 160 enum {
 161         MONO_PROFILER_GC_HANDLE_CREATED = 0,
 162         MONO_PROFILER_GC_HANDLE_DESTROYED = 1,
 163 };
 164
 165 typedef enum {
 166         MONO_PROFILER_HEAPSHOT_NONE = 0,
 167         MONO_PROFILER_HEAPSHOT_MAJOR = 1,
 168         MONO_PROFILER_HEAPSHOT_ON_DEMAND = 2,
 169         MONO_PROFILER_HEAPSHOT_X_GC = 3,
 170         MONO_PROFILER_HEAPSHOT_X_MS = 4,
 171 } MonoProfilerHeapshotMode;
 172
 173 // If you alter MAX_FRAMES, you may need to alter SAMPLE_BLOCK_SIZE too.
 174 #define MAX_FRAMES 32
 175
 176 //The following flags control emitting individual events
 177 #define PROFLOG_EXCEPTION_EVENTS (1 << 0)
 178 #define PROFLOG_MONITOR_EVENTS (1 << 1)
 179 #define PROFLOG_GC_EVENTS (1 << 2)
 180 #define PROFLOG_GC_ALLOCATION_EVENTS (1 << 3)
 181 #define PROFLOG_GC_MOVE_EVENTS (1 << 4)
 182 #define PROFLOG_GC_ROOT_EVENTS (1 << 5)
 183 #define PROFLOG_GC_HANDLE_EVENTS (1 << 6)
 184 #define PROFLOG_FINALIZATION_EVENTS (1 << 7)
 185 #define PROFLOG_COUNTER_EVENTS (1 << 8)
 186 #define PROFLOG_SAMPLE_EVENTS (1 << 9)
 187 #define PROFLOG_JIT_EVENTS (1 << 10)
 188
 189 #define PROFLOG_ALLOC_ALIAS (PROFLOG_GC_EVENTS | PROFLOG_GC_ALLOCATION_EVENTS | PROFLOG_GC_MOVE_EVENTS)
 190 #define PROFLOG_HEAPSHOT_ALIAS (PROFLOG_GC_EVENTS | PROFLOG_GC_ROOT_EVENTS)
 191 #define PROFLOG_LEGACY_ALIAS (PROFLOG_EXCEPTION_EVENTS | PROFLOG_MONITOR_EVENTS | PROFLOG_GC_EVENTS | PROFLOG_GC_MOVE_EVENTS | PROFLOG_GC_ROOT_EVENTS | PROFLOG_GC_HANDLE_EVENTS | PROFLOG_FINALIZATION_EVENTS | PROFLOG_COUNTER_EVENTS)
 192
 193 typedef struct {
 194         //Events explicitly enabled
 195         int enable_mask;
 196
 197         //Events explicitly disabled
 198         int disable_mask;
 199
 200         // Actual mask the profiler should use. Can be changed at runtime.
 201         int effective_mask;
 202
 203         // Whether to do method prologue/epilogue instrumentation. Only used at startup.
 204         gboolean enter_leave;
 205
 206         // Whether to collect code coverage by instrumenting basic blocks.
 207         gboolean collect_coverage;
 208
 209         //Emit a report at the end of execution
 210         gboolean do_report;
 211
 212         //Enable profiler internal debugging
 213         gboolean do_debug;
 214
 215         //Where to compress the output file
 216         gboolean use_zip;
 217
 218         // Heapshot mode (every major, on demand, XXgc, XXms). Can be changed at runtime.
 219         MonoProfilerHeapshotMode hs_mode;
 220
 221         // Heapshot frequency in milliseconds (for MONO_HEAPSHOT_X_MS). Can be changed at runtime.
 222         unsigned int hs_freq_ms;
 223
 224         // Heapshot frequency in number of collections (for MONO_HEAPSHOT_X_GC). Can be changed at runtime.
 225         unsigned int hs_freq_gc;
 226
 227         // Sample frequency in Hertz. Only used at startup.
 228         int sample_freq;
 229
 230         // Maximum number of frames to collect. Can be changed at runtime.
 231         int num_frames;
 232
 233         // Max depth to record enter/leave events. Can be changed at runtime.
 234         int max_call_depth;
 235
 236         //Name of the generated mlpd file
 237         const char *output_filename;
 238
 239         //Filter files used by the code coverage mode
 240         GPtrArray *cov_filter_files;
 241
 242         // Port to listen for profiling commands (e.g. "heapshot" for on-demand heapshot).
 243         int command_port;
 244
 245         // Maximum number of SampleHit structures. We'll drop samples if this number is not sufficient.
 246         int max_allocated_sample_hits;
 247
 248         // Sample mode. Only used at startup.
 249         MonoProfilerSampleMode sampling_mode;
 250 } ProfilerConfig;
 251
 252 void proflog_parse_args (ProfilerConfig *config, const char *desc);
 253
 254 #endif /* __MONO_PROFLOG_H__ */