ad9df3c81d7ce003eaafadbef6b2af1bf02b65ea
[mono.git] / mono / metadata / mono-debug.h
1 /*
2  * This header is only installed for use by the debugger:
3  * the structures and the API declared here are not supported.
4  */
5
6 #ifndef __MONO_DEBUG_H__
7 #define __MONO_DEBUG_H__
8
9 #include <mono/utils/mono-publib.h>
10 #include <mono/metadata/image.h>
11 #include <mono/metadata/appdomain.h>
12
13 typedef struct _MonoSymbolTable                 MonoSymbolTable;
14 typedef struct _MonoDebugDataTable              MonoDebugDataTable;
15
16 typedef struct _MonoSymbolFile                  MonoSymbolFile;
17
18 typedef struct _MonoDebugHandle                 MonoDebugHandle;
19
20 typedef struct _MonoDebugLineNumberEntry        MonoDebugLineNumberEntry;
21
22 typedef struct _MonoDebugVarInfo                MonoDebugVarInfo;
23 typedef struct _MonoDebugMethodJitInfo          MonoDebugMethodJitInfo;
24 typedef struct _MonoDebugMethodAddress          MonoDebugMethodAddress;
25 typedef struct _MonoDebugMethodAddressList      MonoDebugMethodAddressList;
26 typedef struct _MonoDebugClassEntry             MonoDebugClassEntry;
27
28 typedef struct _MonoDebugMethodInfo             MonoDebugMethodInfo;
29 typedef struct _MonoDebugLocalsInfo             MonoDebugLocalsInfo;
30 typedef struct _MonoDebugSourceLocation         MonoDebugSourceLocation;
31
32 typedef struct _MonoDebugList                   MonoDebugList;
33
34 typedef enum {
35         MONO_DEBUG_FORMAT_NONE,
36         MONO_DEBUG_FORMAT_MONO,
37         MONO_DEBUG_FORMAT_DEBUGGER
38 } MonoDebugFormat;
39
40 /*
41  * NOTE:
42  * We intentionally do not use GList here since the debugger needs to know about
43  * the layout of the fields.
44 */
45 struct _MonoDebugList {
46         MonoDebugList *next;
47         const void* data;
48 };
49
50 struct _MonoSymbolTable {
51         uint64_t magic;
52         uint32_t version;
53         uint32_t total_size;
54
55         /*
56          * Corlib and metadata info.
57          */
58         MonoDebugHandle *corlib;
59         MonoDebugDataTable *global_data_table;
60         MonoDebugList *data_tables;
61
62         /*
63          * The symbol files.
64          */
65         MonoDebugList *symbol_files;
66 };
67
68 struct _MonoDebugHandle {
69         uint32_t index;
70         char *image_file;
71         MonoImage *image;
72         MonoDebugDataTable *type_table;
73         MonoSymbolFile *symfile;
74 };
75
76 struct _MonoDebugMethodJitInfo {
77         const mono_byte *code_start;
78         uint32_t code_size;
79         uint32_t prologue_end;
80         uint32_t epilogue_begin;
81         const mono_byte *wrapper_addr;
82         uint32_t num_line_numbers;
83         MonoDebugLineNumberEntry *line_numbers;
84         uint32_t num_params;
85         MonoDebugVarInfo *this_var;
86         MonoDebugVarInfo *params;
87         uint32_t num_locals;
88         MonoDebugVarInfo *locals;
89 };
90
91 struct _MonoDebugMethodAddressList {
92         uint32_t size;
93         uint32_t count;
94         mono_byte data [MONO_ZERO_LEN_ARRAY];
95 };
96
97 struct _MonoDebugSourceLocation {
98         char *source_file;
99         uint32_t row, column;
100         uint32_t il_offset;
101 };
102
103 /*
104  * These bits of the MonoDebugLocalInfo's "index" field are flags specifying
105  * where the variable is actually stored.
106  *
107  * See relocate_variable() in debug-symfile.c for more info.
108  */
109 #define MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS               0xf0000000
110
111 /* The variable is in register "index". */
112 #define MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER            0
113
114 /* The variable is at offset "offset" from register "index". */
115 #define MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET           0x10000000
116
117 /* The variable is in the two registers "offset" and "index". */
118 #define MONO_DEBUG_VAR_ADDRESS_MODE_TWO_REGISTERS       0x20000000
119
120 /* The variable is dead. */
121 #define MONO_DEBUG_VAR_ADDRESS_MODE_DEAD                0x30000000
122
123 struct _MonoDebugVarInfo {
124         uint32_t index;
125         uint32_t offset;
126         uint32_t size;
127         uint32_t begin_scope;
128         uint32_t end_scope;
129         MonoType *type;
130 };
131
132 #define MONO_DEBUGGER_MAJOR_VERSION                     81
133 #define MONO_DEBUGGER_MINOR_VERSION                     5
134 #define MONO_DEBUGGER_MAGIC                             0x7aff65af4253d427ULL
135
136 extern MonoSymbolTable *mono_symbol_table;
137 extern MonoDebugFormat mono_debug_format;
138 extern int32_t mono_debug_debugger_version;
139 extern int32_t _mono_debug_using_mono_debugger;
140
141 void mono_debug_list_add (MonoDebugList **list, const void* data);
142 void mono_debug_list_remove (MonoDebugList **list, const void* data);
143
144 void mono_debug_init (MonoDebugFormat format);
145 void mono_debug_open_image_from_memory (MonoImage *image, const mono_byte *raw_contents, int size);
146 void mono_debug_cleanup (void);
147
148 void mono_debug_close_image (MonoImage *image);
149
150 void mono_debug_domain_unload (MonoDomain *domain);
151 void mono_debug_domain_create (MonoDomain *domain);
152
153 mono_bool mono_debug_using_mono_debugger (void);
154
155 MonoDebugMethodAddress *
156 mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit, MonoDomain *domain);
157
158 MonoDebugMethodInfo *
159 mono_debug_lookup_method (MonoMethod *method);
160
161 MonoDebugMethodAddressList *
162 mono_debug_lookup_method_addresses (MonoMethod *method);
163
164 MonoDebugMethodJitInfo*
165 mono_debug_find_method (MonoMethod *method, MonoDomain *domain);
166
167 void
168 mono_debug_free_method_jit_info (MonoDebugMethodJitInfo *jit);
169
170
171 void
172 mono_debug_add_delegate_trampoline (void* code, int size);
173
174 MonoDebugLocalsInfo*
175 mono_debug_lookup_locals (MonoMethod *method);
176
177 /*
178  * Line number support.
179  */
180
181 MonoDebugSourceLocation *
182 mono_debug_lookup_source_location (MonoMethod *method, uint32_t address, MonoDomain *domain);
183
184 int32_t
185 mono_debug_il_offset_from_address (MonoMethod *method, MonoDomain *domain, uint32_t native_offset);
186
187 void
188 mono_debug_free_source_location (MonoDebugSourceLocation *location);
189
190 char *
191 mono_debug_print_stack_frame (MonoMethod *method, uint32_t native_offset, MonoDomain *domain);
192
193 /*
194  * Mono Debugger support functions
195  *
196  * These methods are used by the JIT while running inside the Mono Debugger.
197  */
198
199 int             mono_debugger_method_has_breakpoint       (MonoMethod *method);
200 int             mono_debugger_insert_breakpoint           (const char *method_name, mono_bool include_namespace);
201
202 void mono_set_is_debugger_attached (mono_bool attached);
203 mono_bool mono_is_debugger_attached (void);
204
205 #endif /* __MONO_DEBUG_H__ */