mono/utils/mono-state.h

   1 /**
   2  * \file
   3  * Support for cooperative creation of unmanaged state dumps
   4  *
   5  * Author:
   6  *   Alexander Kyte (alkyte@microsoft.com)
   7  *
   8  * (C) 2018 Microsoft, Inc.
   9  *
  10  */
  11 #ifndef __MONO_UTILS_NATIVE_STATE__
  12 #define __MONO_UTILS_NATIVE_STATE__
  13
  14 #ifndef DISABLE_CRASH_REPORTING
  15
  16 #include <mono/utils/mono-publib.h>
  17 #include <mono/utils/mono-context.h>
  18 #include <mono/metadata/threads-types.h>
  19 #include <mono/utils/json.h>
  20
  21 #define MONO_NATIVE_STATE_PROTOCOL_VERSION "0.0.2"
  22
  23 typedef enum {
  24         MonoSummaryNone = 0,
  25         MonoSummarySetup = 1,
  26         MonoSummarySuspendHandshake = 2,
  27         MonoSummaryDumpTraversal = 3,
  28         MonoSummaryStateWriter = 4,
  29         MonoSummaryMerpWriter = 5,
  30         MonoSummaryMerpInvoke = 6,
  31         MonoSummaryCleanup = 7,
  32         MonoSummaryDone = 8,
  33
  34         MonoSummaryDoubleFault = 9
  35 } MonoSummaryStage;
  36
  37 typedef struct {
  38         char *output_str;
  39         int len;
  40         int allocated_len;
  41         int indent;
  42 } MonoStateWriter;
  43
  44 // Logging
  45 gboolean
  46 mono_summarize_set_timeline_dir (const char *directory);
  47
  48 void
  49 mono_summarize_timeline_start (void);
  50
  51 void
  52 mono_summarize_timeline_phase_log (MonoSummaryStage stage);
  53
  54 void
  55 mono_summarize_double_fault_log (void);
  56
  57 MonoSummaryStage
  58 mono_summarize_timeline_read_level (const char *directory, gboolean clear);
  59
  60 // Json State Writer
  61
  62 /*
  63  * These use static memory, can only be called once
  64  */
  65
  66 void
  67 mono_summarize_native_state_begin (char *mem, int size);
  68
  69 char *
  70 mono_summarize_native_state_end (void);
  71
  72 void
  73 mono_summarize_native_state_add_thread (MonoThreadSummary *thread, MonoContext *ctx, gboolean crashing_thread);
  74
  75 /*
  76  * These use memory from the caller
  77  */
  78 void
  79 mono_state_writer_init (MonoStateWriter *writer, gchar *output_str, int len);
  80
  81 void
  82 mono_native_state_init (MonoStateWriter *writer);
  83
  84 char *
  85 mono_native_state_emit (MonoStateWriter *writer);
  86
  87 char *
  88 mono_native_state_free (MonoStateWriter *writer, gboolean free_data);
  89
  90 void
  91 mono_native_state_add_thread (MonoStateWriter *writer, MonoThreadSummary *thread, MonoContext *ctx, gboolean first_thread, gboolean crashing_thread);
  92
  93 void
  94 mono_crash_dump (const char *jsonFile, MonoStackHash *hashes);
  95
  96 #endif // DISABLE_CRASH_REPORTING
  97
  98 #endif // MONO_UTILS_NATIVE_STATE