2 * debug-mini.c: Mini-specific debugging stuff.
5 * Martin Baulig (martin@ximian.com)
7 * (C) 2003 Ximian, Inc.
12 #include <mono/metadata/verify.h>
13 #include <mono/metadata/mono-config.h>
14 #include <mono/metadata/mono-debug.h>
15 #include <mono/metadata/appdomain.h>
16 /* mono-debug-debugger.h needs config.h to work... */
18 #include <mono/metadata/mono-debug-debugger.h>
20 #ifdef HAVE_VALGRIND_H
21 #include <valgrind/valgrind.h>
25 record_line_number (MonoDebugMethodJitInfo *jit, guint32 address, guint32 offset)
27 MonoDebugLineNumberEntry lne;
29 lne.address = address;
32 g_array_append_val (jit->line_numbers, lne);
37 MonoDebugMethodJitInfo *jit;
38 guint32 has_line_numbers;
39 guint32 breakpoint_id;
40 } MiniDebugMethodInfo;
43 mono_debug_init_method (MonoCompile *cfg, MonoBasicBlock *start_block, guint32 breakpoint_id)
45 MonoMethod *method = cfg->method;
46 MiniDebugMethodInfo *info;
48 if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
51 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
52 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
53 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL) ||
54 (method->flags & METHOD_ATTRIBUTE_ABSTRACT) ||
55 (method->wrapper_type != MONO_WRAPPER_NONE))
58 info = g_new0 (MiniDebugMethodInfo, 1);
59 info->breakpoint_id = breakpoint_id;
61 cfg->debug_info = info;
65 mono_debug_open_method (MonoCompile *cfg)
67 MiniDebugMethodInfo *info;
68 MonoDebugMethodJitInfo *jit;
69 MonoMethodHeader *header;
71 info = (MiniDebugMethodInfo *) cfg->debug_info;
75 mono_class_init (cfg->method->klass);
77 g_assert (((MonoMethodNormal*)cfg->method)->header);
78 header = ((MonoMethodNormal*)cfg->method)->header;
80 info->jit = jit = g_new0 (MonoDebugMethodJitInfo, 1);
81 jit->line_numbers = g_array_new (FALSE, TRUE, sizeof (MonoDebugLineNumberEntry));
82 jit->num_locals = header->num_locals;
83 jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
87 write_variable (MonoInst *inst, MonoDebugVarInfo *var)
89 if (inst->opcode == OP_REGVAR)
90 var->index = inst->dreg | MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER;
92 /* the debug interface needs fixing to allow 0(%base) address */
93 var->index = inst->inst_basereg | MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET;
94 var->offset = inst->inst_offset;
99 * mono_debug_add_vg_method:
101 * Register symbol information for the method with valgrind
104 mono_debug_add_vg_method (MonoMethod *method, MonoDebugMethodJitInfo *jit)
106 #ifdef VALGRIND_ADD_LINE_INFO
107 MonoMethodHeader *header;
109 char *filename = NULL;
110 guint32 address, line_number;
111 const char *full_name;
115 if (!RUNNING_ON_VALGRIND)
118 header = ((MonoMethodNormal*)method)->header;
120 full_name = mono_method_full_name (method, TRUE);
122 addresses = g_new0 (guint32, header->code_size + 1);
123 lines = g_new0 (guint32, header->code_size + 1);
126 * Very simple code to convert the addr->offset mappings that mono has
127 * into [addr-addr] ->line number mappings.
130 /* Create offset->line number mapping */
131 for (i = 0; i < header->code_size; ++i) {
134 fname = mono_debug_source_location_from_il_offset (method, i, &lines [i]);
139 /* Create address->offset mapping */
140 for (i = 0; i < jit->line_numbers->len; ++i) {
141 MonoDebugLineNumberEntry *lne = &g_array_index (jit->line_numbers, MonoDebugLineNumberEntry, i);
143 g_assert (lne->offset <= header->code_size);
145 if ((addresses [lne->offset] == 0) || (lne->address < addresses [lne->offset]))
146 addresses [lne->offset] = lne->address;
148 /* Fill out missing addresses */
150 for (i = 0; i < header->code_size; ++i) {
151 if (addresses [i] == 0)
152 addresses [i] = address;
154 address = addresses [i];
160 while (i < header->code_size) {
161 if (lines [i] == line_number)
164 if (line_number > 0) {
165 //g_assert (addresses [i] - 1 >= address);
167 if (addresses [i] - 1 >= address) {
168 VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + addresses [i] - 1, filename, line_number);
169 //printf ("[%d-%d] -> %d.\n", address, addresses [i] - 1, line_number);
172 address = addresses [i];
173 line_number = lines [i];
177 if (line_number > 0) {
178 VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + jit->code_size - 1, filename, line_number);
179 //printf ("[%d-%d] -> %d.\n", address, jit->code_size - 1, line_number);
182 VALGRIND_ADD_SYMBOL (jit->code_start, jit->code_size, full_name);
186 #endif /* VALGRIND_ADD_LINE_INFO */
190 mono_debug_close_method (MonoCompile *cfg)
192 MiniDebugMethodInfo *info;
193 MonoDebugMethodJitInfo *jit;
194 MonoMethodHeader *header;
198 info = (MiniDebugMethodInfo *) cfg->debug_info;
199 if (!info || !info->jit)
202 method = cfg->method;
203 header = ((MonoMethodNormal*)method)->header;
206 jit->code_start = cfg->native_code;
207 jit->epilogue_begin = cfg->epilog_begin;
208 jit->code_size = cfg->code_len;
210 record_line_number (jit, jit->epilogue_begin, header->code_size);
212 jit->num_params = method->signature->param_count;
213 jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
215 for (i = 0; i < jit->num_locals; i++)
216 write_variable (cfg->varinfo [cfg->locals_start + i], &jit->locals [i]);
218 if (method->signature->hasthis) {
219 jit->this_var = g_new0 (MonoDebugVarInfo, 1);
220 write_variable (cfg->varinfo [0], jit->this_var);
223 for (i = 0; i < jit->num_params; i++)
224 write_variable (cfg->varinfo [i + method->signature->hasthis], &jit->params [i]);
226 mono_debug_add_method (method, jit, cfg->domain);
228 mono_debug_add_vg_method (method, jit);
230 if (info->breakpoint_id)
231 mono_debugger_breakpoint_callback (method, info->breakpoint_id);
235 mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address)
237 MiniDebugMethodInfo *info;
238 MonoMethodHeader *header;
241 info = (MiniDebugMethodInfo *) cfg->debug_info;
242 if (!info || !info->jit || !ins->cil_code)
245 g_assert (((MonoMethodNormal*)cfg->method)->header);
246 header = ((MonoMethodNormal*)cfg->method)->header;
248 if ((ins->cil_code < header->code) ||
249 (ins->cil_code > header->code + header->code_size))
252 offset = ins->cil_code - header->code;
253 if (!info->has_line_numbers) {
254 info->jit->prologue_end = address;
255 info->has_line_numbers = TRUE;
258 record_line_number (info->jit, address, offset);
262 encode_value (gint32 value, char *buf, char **endbuf)
266 //printf ("ENCODE: %d 0x%x.\n", value, value);
269 * Same encoding as the one used in the metadata, extended to handle values
270 * greater than 0x1fffffff.
272 if ((value >= 0) && (value <= 127))
274 else if ((value >= 0) && (value <= 16384)) {
275 p [0] = 0x80 | (value >> 8);
276 p [1] = value & 0xff;
278 } else if ((value >= 0) && (value <= 0x1fffffff)) {
279 p [0] = (value >> 24) | 0xc0;
280 p [1] = (value >> 16) & 0xff;
281 p [2] = (value >> 8) & 0xff;
282 p [3] = value & 0xff;
287 p [1] = (value >> 24) & 0xff;
288 p [2] = (value >> 16) & 0xff;
289 p [3] = (value >> 8) & 0xff;
290 p [4] = value & 0xff;
298 decode_value (char *_ptr, char **rptr)
300 unsigned char *ptr = (unsigned char *) _ptr;
301 unsigned char b = *ptr;
304 if ((b & 0x80) == 0){
307 } else if ((b & 0x40) == 0){
308 len = ((b & 0x3f) << 8 | ptr [1]);
310 } else if (b != 0xff) {
311 len = ((b & 0x1f) << 24) |
318 len = (ptr [1] << 24) | (ptr [2] << 16) | (ptr [3] << 8) | ptr [4];
324 //printf ("DECODE: %d.\n", len);
329 serialize_variable (MonoDebugVarInfo *var, char *p, char **endbuf)
331 guint32 flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
334 case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
335 encode_value (var->index, p, &p);
337 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
338 encode_value (var->index, p, &p);
339 encode_value (var->offset, p, &p);
342 g_assert_not_reached ();
348 mono_debug_serialize_debug_info (MonoCompile *cfg,
349 guint8 **out_buf, guint32 *buf_len)
351 MiniDebugMethodInfo *info;
352 MonoDebugMethodJitInfo *jit;
353 guint32 size, prev_offset, prev_native_offset;
358 info = (MiniDebugMethodInfo *) cfg->debug_info;
359 if (!info || !info->jit) {
365 size = ((jit->num_params + jit->num_locals + 1) * 10) + (jit->line_numbers->len * 10) + 64;
366 p = buf = g_malloc (size);
367 encode_value (jit->epilogue_begin, p, &p);
368 encode_value (jit->prologue_end, p, &p);
369 encode_value (jit->code_size, p, &p);
371 for (i = 0; i < jit->num_params; ++i)
372 serialize_variable (&jit->params [i], p, &p);
374 if (cfg->method->signature->hasthis)
375 serialize_variable (jit->this_var, p, &p);
377 for (i = 0; i < jit->num_locals; i++)
378 serialize_variable (&jit->locals [i], p, &p);
380 encode_value (jit->line_numbers->len, p, &p);
383 prev_native_offset = 0;
384 for (i = 0; i < jit->line_numbers->len; ++i) {
385 /* Sometimes, the offset values are not in increasing order */
386 MonoDebugLineNumberEntry *lne = &g_array_index (jit->line_numbers,
387 MonoDebugLineNumberEntry,
389 encode_value (lne->offset - prev_offset, p, &p);
390 encode_value (lne->address - prev_native_offset, p, &p);
391 prev_offset = lne->offset;
392 prev_native_offset = lne->address;
395 g_assert (p - buf < size);
402 deserialize_variable (MonoDebugVarInfo *var, char *p, char **endbuf)
406 var->index = decode_value (p, &p);
408 flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
411 case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
413 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
414 var->offset = decode_value (p, &p);
417 g_assert_not_reached ();
422 static MonoDebugMethodJitInfo *
423 deserialize_debug_info (MonoMethod *method,
425 guint8 *buf, guint32 buf_len)
427 MonoMethodHeader *header;
428 MonoDebugMethodJitInfo *jit;
429 gint32 offset, native_offset, prev_offset, prev_native_offset, len;
433 g_assert (((MonoMethodNormal*)method)->header);
434 header = ((MonoMethodNormal*)method)->header;
436 jit = g_new0 (MonoDebugMethodJitInfo, 1);
437 jit->code_start = code_start;
438 jit->line_numbers = g_array_new (FALSE, TRUE, sizeof (MonoDebugLineNumberEntry));
439 jit->num_locals = header->num_locals;
440 jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
441 jit->num_params = method->signature->param_count;
442 jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
445 jit->epilogue_begin = decode_value (p, &p);
446 jit->prologue_end = decode_value (p, &p);
447 jit->code_size = decode_value (p, &p);
449 for (i = 0; i < jit->num_params; ++i)
450 deserialize_variable (&jit->params [i], p, &p);
452 if (method->signature->hasthis) {
453 jit->this_var = g_new0 (MonoDebugVarInfo, 1);
454 deserialize_variable (jit->this_var, p, &p);
457 for (i = 0; i < jit->num_locals; i++)
458 deserialize_variable (&jit->locals [i], p, &p);
460 len = decode_value (p, &p);
463 prev_native_offset = 0;
464 for (i = 0; i < len; ++i) {
465 offset = prev_offset + decode_value (p, &p);
466 native_offset = prev_native_offset + decode_value (p, &p);
467 record_line_number (jit, native_offset, offset);
468 prev_offset = offset;
469 prev_native_offset = native_offset;
476 mono_debug_add_aot_method (MonoDomain *domain,
477 MonoMethod *method, guint8 *code_start,
478 guint8 *debug_info, guint32 debug_info_len)
480 MonoDebugMethodJitInfo *jit;
482 if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
485 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
486 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
487 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL) ||
488 (method->flags & METHOD_ATTRIBUTE_ABSTRACT) ||
489 (method->wrapper_type != MONO_WRAPPER_NONE))
492 if (debug_info_len == 0)
495 jit = deserialize_debug_info (method, code_start,
499 mono_debug_add_method (method, jit, domain);
501 mono_debug_add_vg_method (method, jit);
505 mono_init_debugger (const char *file, const char *opt_flags)
511 g_set_prgname (file);
513 opt = mono_parse_default_optimizations (opt_flags);
514 opt |= MONO_OPT_SHARED;
516 mono_set_defaults (0, opt);
518 domain = mono_jit_init (file);
520 mono_config_parse (NULL);
522 error = mono_check_corlib_version ();
524 fprintf (stderr, "Corlib not in sync with this runtime: %s\n", error);
525 fprintf (stderr, "Download a newer corlib or a newer runtime at http://www.go-mono.com/daily.\n");