2 * This header is only installed for use by the debugger:
3 * the structures and the API declared here are not supported.
6 #ifndef __MONO_DEBUG_H__
7 #define __MONO_DEBUG_H__
9 #include <mono/utils/mono-publib.h>
10 #include <mono/metadata/image.h>
11 #include <mono/metadata/appdomain.h>
15 typedef struct _MonoSymbolTable MonoSymbolTable;
16 typedef struct _MonoDebugDataTable MonoDebugDataTable;
18 typedef struct _MonoSymbolFile MonoSymbolFile;
19 typedef struct _MonoPPDBFile MonoPPDBFile;
21 typedef struct _MonoDebugHandle MonoDebugHandle;
23 typedef struct _MonoDebugLineNumberEntry MonoDebugLineNumberEntry;
25 typedef struct _MonoDebugVarInfo MonoDebugVarInfo;
26 typedef struct _MonoDebugMethodJitInfo MonoDebugMethodJitInfo;
27 typedef struct _MonoDebugMethodAddress MonoDebugMethodAddress;
28 typedef struct _MonoDebugMethodAddressList MonoDebugMethodAddressList;
29 typedef struct _MonoDebugClassEntry MonoDebugClassEntry;
31 typedef struct _MonoDebugMethodInfo MonoDebugMethodInfo;
32 typedef struct _MonoDebugLocalsInfo MonoDebugLocalsInfo;
33 typedef struct _MonoDebugSourceLocation MonoDebugSourceLocation;
35 typedef struct _MonoDebugList MonoDebugList;
38 MONO_DEBUG_FORMAT_NONE,
39 MONO_DEBUG_FORMAT_MONO,
40 /* Deprecated, the mdb debugger is not longer supported. */
41 MONO_DEBUG_FORMAT_DEBUGGER
46 * We intentionally do not use GList here since the debugger needs to know about
47 * the layout of the fields.
49 struct _MonoDebugList {
54 struct _MonoSymbolTable {
60 * Corlib and metadata info.
62 MonoDebugHandle *corlib;
63 MonoDebugDataTable *global_data_table;
64 MonoDebugList *data_tables;
69 MonoDebugList *symbol_files;
72 struct _MonoDebugHandle {
76 MonoDebugDataTable *type_table;
77 MonoSymbolFile *symfile;
81 struct _MonoDebugMethodJitInfo {
82 const mono_byte *code_start;
84 uint32_t prologue_end;
85 uint32_t epilogue_begin;
86 const mono_byte *wrapper_addr;
87 uint32_t num_line_numbers;
88 MonoDebugLineNumberEntry *line_numbers;
89 uint32_t has_var_info;
91 MonoDebugVarInfo *this_var;
92 MonoDebugVarInfo *params;
94 MonoDebugVarInfo *locals;
95 MonoDebugVarInfo *gsharedvt_info_var;
96 MonoDebugVarInfo *gsharedvt_locals_var;
99 struct _MonoDebugMethodAddressList {
102 mono_byte data [MONO_ZERO_LEN_ARRAY];
105 struct _MonoDebugSourceLocation {
107 uint32_t row, column;
111 MONO_API mono_bool mono_debug_enabled (void);
114 * These bits of the MonoDebugLocalInfo's "index" field are flags specifying
115 * where the variable is actually stored.
117 * See relocate_variable() in debug-symfile.c for more info.
119 #define MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS 0xf0000000
121 /* The variable is in register "index". */
122 #define MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER 0
124 /* The variable is at offset "offset" from register "index". */
125 #define MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET 0x10000000
127 /* The variable is in the two registers "offset" and "index". */
128 #define MONO_DEBUG_VAR_ADDRESS_MODE_TWO_REGISTERS 0x20000000
130 /* The variable is dead. */
131 #define MONO_DEBUG_VAR_ADDRESS_MODE_DEAD 0x30000000
133 /* Same as REGOFFSET, but do an indirection */
134 #define MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET_INDIR 0x40000000
136 /* gsharedvt local */
137 #define MONO_DEBUG_VAR_ADDRESS_MODE_GSHAREDVT_LOCAL 0x50000000
139 /* variable is a vt address */
140 #define MONO_DEBUG_VAR_ADDRESS_MODE_VTADDR 0x60000000
142 struct _MonoDebugVarInfo {
146 uint32_t begin_scope;
151 #define MONO_DEBUGGER_MAJOR_VERSION 81
152 #define MONO_DEBUGGER_MINOR_VERSION 6
153 #define MONO_DEBUGGER_MAGIC 0x7aff65af4253d427ULL
155 MONO_API void mono_debug_init (MonoDebugFormat format);
156 MONO_API void mono_debug_open_image_from_memory (MonoImage *image, const mono_byte *raw_contents, int size);
157 MONO_API void mono_debug_cleanup (void);
159 MONO_API void mono_debug_close_image (MonoImage *image);
161 MONO_API void mono_debug_domain_unload (MonoDomain *domain);
162 MONO_API void mono_debug_domain_create (MonoDomain *domain);
164 MONO_API MonoDebugMethodAddress *
165 mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit, MonoDomain *domain);
168 mono_debug_remove_method (MonoMethod *method, MonoDomain *domain);
170 MONO_API MonoDebugMethodInfo *
171 mono_debug_lookup_method (MonoMethod *method);
173 MONO_API MonoDebugMethodAddressList *
174 mono_debug_lookup_method_addresses (MonoMethod *method);
176 MONO_API MonoDebugMethodJitInfo*
177 mono_debug_find_method (MonoMethod *method, MonoDomain *domain);
180 mono_debug_free_method_jit_info (MonoDebugMethodJitInfo *jit);
184 mono_debug_add_delegate_trampoline (void* code, int size);
186 MONO_API MonoDebugLocalsInfo*
187 mono_debug_lookup_locals (MonoMethod *method);
189 MonoDebugSourceLocation *
190 mono_debug_method_lookup_location (MonoDebugMethodInfo *minfo, int il_offset);
193 * Line number support.
196 MONO_API MonoDebugSourceLocation *
197 mono_debug_lookup_source_location (MonoMethod *method, uint32_t address, MonoDomain *domain);
200 mono_debug_il_offset_from_address (MonoMethod *method, MonoDomain *domain, uint32_t native_offset);
203 mono_debug_free_source_location (MonoDebugSourceLocation *location);
206 mono_debug_print_stack_frame (MonoMethod *method, uint32_t native_offset, MonoDomain *domain);
209 * Mono Debugger support functions
211 * These methods are used by the JIT while running inside the Mono Debugger.
214 MONO_API int mono_debugger_method_has_breakpoint (MonoMethod *method);
215 MONO_API int mono_debugger_insert_breakpoint (const char *method_name, mono_bool include_namespace);
217 MONO_API void mono_set_is_debugger_attached (mono_bool attached);
218 MONO_API mono_bool mono_is_debugger_attached (void);
222 #endif /* __MONO_DEBUG_H__ */