2 * debug-mini.c: Mini-specific debugging stuff.
5 * Martin Baulig (martin@ximian.com)
7 * (C) 2003 Ximian, Inc.
13 #include <mono/metadata/verify.h>
14 #include <mono/metadata/mono-config.h>
15 #include <mono/metadata/mono-debug.h>
16 #include <mono/metadata/appdomain.h>
17 #include <mono/metadata/threads-types.h>
19 #include <mono/metadata/mono-debug-debugger.h>
21 #include <mono/utils/valgrind.h>
26 } MiniDebugBreakpointInfo;
30 MonoDebugMethodJitInfo *jit;
32 guint32 has_line_numbers;
33 guint32 breakpoint_id;
34 } MiniDebugMethodInfo;
37 record_line_number (MiniDebugMethodInfo *info, guint32 address, guint32 offset)
39 MonoDebugLineNumberEntry lne;
41 lne.native_offset = address;
42 lne.il_offset = offset;
44 g_array_append_val (info->line_numbers, lne);
49 mono_debug_init_method (MonoCompile *cfg, MonoBasicBlock *start_block, guint32 breakpoint_id)
51 MiniDebugMethodInfo *info;
53 if (!mono_debug_enabled ())
56 info = g_new0 (MiniDebugMethodInfo, 1);
57 info->breakpoint_id = breakpoint_id;
59 cfg->debug_info = info;
63 mono_debug_open_method (MonoCompile *cfg)
65 MiniDebugMethodInfo *info;
66 MonoDebugMethodJitInfo *jit;
67 MonoMethodHeader *header;
69 info = (MiniDebugMethodInfo *) cfg->debug_info;
73 mono_class_init (cfg->method->klass);
78 info->jit = jit = g_new0 (MonoDebugMethodJitInfo, 1);
79 info->line_numbers = g_array_new (FALSE, TRUE, sizeof (MonoDebugLineNumberEntry));
80 jit->num_locals = header->num_locals;
81 jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
85 write_variable (MonoInst *inst, MonoDebugVarInfo *var)
87 var->type = inst->inst_vtype;
89 if (inst->opcode == OP_REGVAR)
90 var->index = inst->dreg | MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER;
91 else if (inst->flags & MONO_INST_IS_DEAD)
92 var->index = MONO_DEBUG_VAR_ADDRESS_MODE_DEAD;
93 else if (inst->opcode == OP_REGOFFSET) {
94 /* the debug interface needs fixing to allow 0(%base) address */
95 var->index = inst->inst_basereg | MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET;
96 var->offset = inst->inst_offset;
97 } else if (inst->opcode == OP_GSHAREDVT_ARG_REGOFFSET) {
98 var->index = inst->inst_basereg | MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET_INDIR;
99 var->offset = inst->inst_offset;
100 } else if (inst->opcode == OP_GSHAREDVT_LOCAL) {
101 var->index = inst->inst_imm | MONO_DEBUG_VAR_ADDRESS_MODE_GSHAREDVT_LOCAL;
102 } else if (inst->opcode == OP_VTARG_ADDR) {
105 vtaddr = inst->inst_left;
106 g_assert (vtaddr->opcode == OP_REGOFFSET);
107 var->offset = vtaddr->inst_offset;
108 var->index = vtaddr->inst_basereg | MONO_DEBUG_VAR_ADDRESS_MODE_VTADDR;
110 g_assert_not_reached ();
115 * mono_debug_add_vg_method:
117 * Register symbol information for the method with valgrind
120 mono_debug_add_vg_method (MonoMethod *method, MonoDebugMethodJitInfo *jit)
122 #ifdef VALGRIND_ADD_LINE_INFO
123 MonoMethodHeader *header;
124 MonoDebugMethodInfo *minfo;
126 char *filename = NULL;
127 guint32 address, line_number;
128 const char *full_name;
132 if (!RUNNING_ON_VALGRIND)
135 header = mono_method_get_header (method);
137 full_name = mono_method_full_name (method, TRUE);
139 addresses = g_new0 (guint32, header->code_size + 1);
140 lines = g_new0 (guint32, header->code_size + 1);
143 * Very simple code to convert the addr->offset mappings that mono has
144 * into [addr-addr] ->line number mappings.
147 minfo = mono_debug_lookup_method (method);
149 /* Create offset->line number mapping */
150 for (i = 0; i < header->code_size; ++i) {
151 MonoDebugSourceLocation *location;
153 location = mono_debug_symfile_lookup_location (minfo, i);
157 lines [i] = location.row;
159 filename = location.source_file;
161 mono_debug_free_source_location (location);
165 /* Create address->offset mapping */
166 for (i = 0; i < jit->num_line_numbers; ++i) {
167 MonoDebugLineNumberEntry *lne = jit->line_numbers [i];
169 g_assert (lne->offset <= header->code_size);
171 if ((addresses [lne->offset] == 0) || (lne->address < addresses [lne->offset]))
172 addresses [lne->offset] = lne->address;
174 /* Fill out missing addresses */
176 for (i = 0; i < header->code_size; ++i) {
177 if (addresses [i] == 0)
178 addresses [i] = address;
180 address = addresses [i];
186 while (i < header->code_size) {
187 if (lines [i] == line_number)
190 if (line_number > 0) {
191 //g_assert (addresses [i] - 1 >= address);
193 if (addresses [i] - 1 >= address) {
194 VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + addresses [i] - 1, filename, line_number);
195 //printf ("[%d-%d] -> %d.\n", address, addresses [i] - 1, line_number);
198 address = addresses [i];
199 line_number = lines [i];
203 if (line_number > 0) {
204 VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + jit->code_size - 1, filename, line_number);
205 //printf ("[%d-%d] -> %d.\n", address, jit->code_size - 1, line_number);
208 VALGRIND_ADD_SYMBOL (jit->code_start, jit->code_size, full_name);
212 mono_metadata_free_mh (header);
213 #endif /* VALGRIND_ADD_LINE_INFO */
217 mono_debug_close_method (MonoCompile *cfg)
219 MiniDebugMethodInfo *info;
220 MonoDebugMethodJitInfo *jit;
221 MonoMethodHeader *header;
222 MonoMethodSignature *sig;
223 MonoDebugMethodAddress *debug_info;
227 info = (MiniDebugMethodInfo *) cfg->debug_info;
228 if (!info || !info->jit) {
234 method = cfg->method;
235 header = cfg->header;
236 sig = mono_method_signature (method);
239 jit->code_start = cfg->native_code;
240 jit->epilogue_begin = cfg->epilog_begin;
241 jit->code_size = cfg->code_len;
243 if (jit->epilogue_begin)
244 record_line_number (info, jit->epilogue_begin, header->code_size);
246 jit->num_params = sig->param_count;
247 jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
249 for (i = 0; i < jit->num_locals; i++)
250 write_variable (cfg->locals [i], &jit->locals [i]);
253 jit->this_var = g_new0 (MonoDebugVarInfo, 1);
254 write_variable (cfg->args [0], jit->this_var);
257 for (i = 0; i < jit->num_params; i++)
258 write_variable (cfg->args [i + sig->hasthis], &jit->params [i]);
260 if (cfg->gsharedvt_info_var) {
261 jit->gsharedvt_info_var = g_new0 (MonoDebugVarInfo, 1);
262 jit->gsharedvt_locals_var = g_new0 (MonoDebugVarInfo, 1);
263 write_variable (cfg->gsharedvt_info_var, jit->gsharedvt_info_var);
264 write_variable (cfg->gsharedvt_locals_var, jit->gsharedvt_locals_var);
267 jit->num_line_numbers = info->line_numbers->len;
268 jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
270 for (i = 0; i < jit->num_line_numbers; i++)
271 jit->line_numbers [i] = g_array_index (info->line_numbers, MonoDebugLineNumberEntry, i);
273 debug_info = mono_debug_add_method (cfg->method_to_register, jit, cfg->domain);
275 mono_debug_add_vg_method (method, jit);
277 mono_debug_free_method_jit_info (jit);
278 mono_debug_free_method (cfg);
282 mono_debug_free_method (MonoCompile *cfg)
284 MiniDebugMethodInfo *info;
286 info = (MiniDebugMethodInfo *) cfg->debug_info;
288 if (info->line_numbers)
289 g_array_free (info->line_numbers, TRUE);
291 cfg->debug_info = NULL;
296 mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address)
298 MiniDebugMethodInfo *info;
299 MonoMethodHeader *header;
302 info = (MiniDebugMethodInfo *) cfg->debug_info;
303 if (!info || !info->jit || !ins->cil_code)
306 header = cfg->header;
309 if ((ins->cil_code < header->code) ||
310 (ins->cil_code > header->code + header->code_size))
313 offset = ins->cil_code - header->code;
314 if (!info->has_line_numbers) {
315 info->jit->prologue_end = address;
316 info->has_line_numbers = TRUE;
319 record_line_number (info, address, offset);
323 mono_debug_open_block (MonoCompile *cfg, MonoBasicBlock *bb, guint32 address)
325 MiniDebugMethodInfo *info;
326 MonoMethodHeader *header;
329 info = (MiniDebugMethodInfo *) cfg->debug_info;
330 if (!info || !info->jit || !bb->cil_code)
333 header = cfg->header;
336 if ((bb->cil_code < header->code) ||
337 (bb->cil_code > header->code + header->code_size))
340 offset = bb->cil_code - header->code;
341 if (!info->has_line_numbers) {
342 info->jit->prologue_end = address;
343 info->has_line_numbers = TRUE;
346 record_line_number (info, address, offset);
350 encode_value (gint32 value, guint8 *buf, guint8 **endbuf)
354 //printf ("ENCODE: %d 0x%x.\n", value, value);
357 * Same encoding as the one used in the metadata, extended to handle values
358 * greater than 0x1fffffff.
360 if ((value >= 0) && (value <= 127))
362 else if ((value >= 0) && (value <= 16383)) {
363 p [0] = 0x80 | (value >> 8);
364 p [1] = value & 0xff;
366 } else if ((value >= 0) && (value <= 0x1fffffff)) {
367 p [0] = (value >> 24) | 0xc0;
368 p [1] = (value >> 16) & 0xff;
369 p [2] = (value >> 8) & 0xff;
370 p [3] = value & 0xff;
375 p [1] = (value >> 24) & 0xff;
376 p [2] = (value >> 16) & 0xff;
377 p [3] = (value >> 8) & 0xff;
378 p [4] = value & 0xff;
386 decode_value (guint8 *ptr, guint8 **rptr)
391 if ((b & 0x80) == 0){
394 } else if ((b & 0x40) == 0){
395 len = ((b & 0x3f) << 8 | ptr [1]);
397 } else if (b != 0xff) {
398 len = ((b & 0x1f) << 24) |
405 len = (ptr [1] << 24) | (ptr [2] << 16) | (ptr [3] << 8) | ptr [4];
411 //printf ("DECODE: %d.\n", len);
416 serialize_variable (MonoDebugVarInfo *var, guint8 *p, guint8 **endbuf)
418 guint32 flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
420 encode_value (var->index, p, &p);
423 case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
425 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
426 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET_INDIR:
427 case MONO_DEBUG_VAR_ADDRESS_MODE_VTADDR:
428 encode_value (var->offset, p, &p);
430 case MONO_DEBUG_VAR_ADDRESS_MODE_GSHAREDVT_LOCAL:
431 case MONO_DEBUG_VAR_ADDRESS_MODE_DEAD:
434 g_assert_not_reached ();
440 mono_debug_serialize_debug_info (MonoCompile *cfg, guint8 **out_buf, guint32 *buf_len)
442 MonoDebugMethodJitInfo *jit;
443 guint32 size, prev_offset, prev_native_offset;
447 /* Can't use cfg->debug_info as it is freed by close_method () */
448 jit = mono_debug_find_method (cfg->method, mono_domain_get ());
454 size = ((jit->num_params + jit->num_locals + 1) * 10) + (jit->num_line_numbers * 10) + 64;
455 p = buf = g_malloc (size);
456 encode_value (jit->epilogue_begin, p, &p);
457 encode_value (jit->prologue_end, p, &p);
458 encode_value (jit->code_size, p, &p);
460 for (i = 0; i < jit->num_params; ++i)
461 serialize_variable (&jit->params [i], p, &p);
463 if (mono_method_signature (cfg->method)->hasthis)
464 serialize_variable (jit->this_var, p, &p);
466 for (i = 0; i < jit->num_locals; i++)
467 serialize_variable (&jit->locals [i], p, &p);
469 if (jit->gsharedvt_info_var) {
470 encode_value (1, p, &p);
471 serialize_variable (jit->gsharedvt_info_var, p, &p);
472 serialize_variable (jit->gsharedvt_locals_var, p, &p);
474 encode_value (0, p, &p);
477 encode_value (jit->num_line_numbers, p, &p);
480 prev_native_offset = 0;
481 for (i = 0; i < jit->num_line_numbers; ++i) {
482 /* Sometimes, the offset values are not in increasing order */
483 MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
484 encode_value (lne->il_offset - prev_offset, p, &p);
485 encode_value (lne->native_offset - prev_native_offset, p, &p);
486 prev_offset = lne->il_offset;
487 prev_native_offset = lne->native_offset;
490 g_assert (p - buf < size);
497 deserialize_variable (MonoDebugVarInfo *var, guint8 *p, guint8 **endbuf)
501 var->index = decode_value (p, &p);
503 flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
506 case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
508 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
509 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET_INDIR:
510 case MONO_DEBUG_VAR_ADDRESS_MODE_VTADDR:
511 var->offset = decode_value (p, &p);
513 case MONO_DEBUG_VAR_ADDRESS_MODE_GSHAREDVT_LOCAL:
514 case MONO_DEBUG_VAR_ADDRESS_MODE_DEAD:
517 g_assert_not_reached ();
522 static MonoDebugMethodJitInfo *
523 deserialize_debug_info (MonoMethod *method, guint8 *code_start, guint8 *buf, guint32 buf_len)
525 MonoMethodHeader *header;
526 gint32 offset, native_offset, prev_offset, prev_native_offset;
527 MonoDebugMethodJitInfo *jit;
531 header = mono_method_get_header (method);
534 jit = g_new0 (MonoDebugMethodJitInfo, 1);
535 jit->code_start = code_start;
536 jit->num_locals = header->num_locals;
537 jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
538 jit->num_params = mono_method_signature (method)->param_count;
539 jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
542 jit->epilogue_begin = decode_value (p, &p);
543 jit->prologue_end = decode_value (p, &p);
544 jit->code_size = decode_value (p, &p);
546 for (i = 0; i < jit->num_params; ++i)
547 deserialize_variable (&jit->params [i], p, &p);
549 if (mono_method_signature (method)->hasthis) {
550 jit->this_var = g_new0 (MonoDebugVarInfo, 1);
551 deserialize_variable (jit->this_var, p, &p);
554 for (i = 0; i < jit->num_locals; i++)
555 deserialize_variable (&jit->locals [i], p, &p);
557 if (decode_value (p, &p)) {
558 jit->gsharedvt_info_var = g_new0 (MonoDebugVarInfo, 1);
559 jit->gsharedvt_locals_var = g_new0 (MonoDebugVarInfo, 1);
560 deserialize_variable (jit->gsharedvt_info_var, p, &p);
561 deserialize_variable (jit->gsharedvt_locals_var, p, &p);
564 jit->num_line_numbers = decode_value (p, &p);
565 jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
568 prev_native_offset = 0;
569 for (i = 0; i < jit->num_line_numbers; ++i) {
570 MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
572 offset = prev_offset + decode_value (p, &p);
573 native_offset = prev_native_offset + decode_value (p, &p);
575 lne->native_offset = native_offset;
576 lne->il_offset = offset;
578 prev_offset = offset;
579 prev_native_offset = native_offset;
582 mono_metadata_free_mh (header);
587 mono_debug_add_aot_method (MonoDomain *domain, MonoMethod *method, guint8 *code_start,
588 guint8 *debug_info, guint32 debug_info_len)
590 MonoDebugMethodJitInfo *jit;
592 if (!mono_debug_enabled ())
595 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
596 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
597 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL) ||
598 (method->flags & METHOD_ATTRIBUTE_ABSTRACT) ||
599 (method->wrapper_type != MONO_WRAPPER_NONE))
602 if (debug_info_len == 0)
605 jit = deserialize_debug_info (method, code_start, debug_info, debug_info_len);
607 mono_debug_add_method (method, jit, domain);
609 mono_debug_add_vg_method (method, jit);
611 mono_debug_free_method_jit_info (jit);
615 print_var_info (MonoDebugVarInfo *info, int idx, const char *name, const char *type)
617 switch (info->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS) {
618 case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
619 g_print ("%s %s (%d) in register %s\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)));
621 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
622 g_print ("%s %s (%d) in memory: base register %s + %d\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)), info->offset);
624 case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET_INDIR:
625 g_print ("%s %s (%d) in indir memory: base register %s + %d\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)), info->offset);
627 case MONO_DEBUG_VAR_ADDRESS_MODE_GSHAREDVT_LOCAL:
628 g_print ("%s %s (%d) gsharedvt local.\n", type, name, idx);
630 case MONO_DEBUG_VAR_ADDRESS_MODE_VTADDR:
631 g_print ("%s %s (%d) vt address: base register %s + %d\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)), info->offset);
633 case MONO_DEBUG_VAR_ADDRESS_MODE_TWO_REGISTERS:
635 g_assert_not_reached ();
640 * mono_debug_print_locals:
642 * Prints to stdout the information about the local variables in
643 * a method (if @only_arguments is false) or about the arguments.
644 * The information includes the storage info (where the variable
645 * lives, in a register or in memory).
646 * The method is found by looking up what method has been emitted at
647 * the instruction address @ip.
648 * This is for use inside a debugger.
651 mono_debug_print_vars (gpointer ip, gboolean only_arguments)
653 MonoDomain *domain = mono_domain_get ();
654 MonoJitInfo *ji = mono_jit_info_table_find (domain, ip);
655 MonoDebugMethodJitInfo *jit;
661 jit = mono_debug_find_method (jinfo_get_method (ji), domain);
665 if (only_arguments) {
667 names = g_new (char *, jit->num_params);
668 mono_method_get_param_names (jinfo_get_method (ji), (const char **) names);
670 print_var_info (jit->this_var, 0, "this", "Arg");
671 for (i = 0; i < jit->num_params; ++i) {
672 print_var_info (&jit->params [i], i, names [i]? names [i]: "unknown name", "Arg");
676 for (i = 0; i < jit->num_locals; ++i) {
677 print_var_info (&jit->locals [i], i, "", "Local");
680 mono_debug_free_method_jit_info (jit);
684 * The old Debugger breakpoint interface.
686 * This interface is used to insert breakpoints on methods which are not yet JITed.
687 * The debugging code keeps a list of all such breakpoints and automatically inserts the
688 * breakpoint when the method is JITed.
691 static GPtrArray *breakpoints;
694 mono_debugger_insert_breakpoint_full (MonoMethodDesc *desc)
696 static int last_breakpoint_id = 0;
697 MiniDebugBreakpointInfo *info;
699 info = g_new0 (MiniDebugBreakpointInfo, 1);
701 info->index = ++last_breakpoint_id;
704 breakpoints = g_ptr_array_new ();
706 g_ptr_array_add (breakpoints, info);
711 /*FIXME This is part of the public API by accident, remove it from there when possible. */
713 mono_debugger_insert_breakpoint (const gchar *method_name, gboolean include_namespace)
715 MonoMethodDesc *desc;
717 desc = mono_method_desc_new (method_name, include_namespace);
721 return mono_debugger_insert_breakpoint_full (desc);
724 /*FIXME This is part of the public API by accident, remove it from there when possible. */
726 mono_debugger_method_has_breakpoint (MonoMethod *method)
733 for (i = 0; i < breakpoints->len; i++) {
734 MiniDebugBreakpointInfo *info = g_ptr_array_index (breakpoints, i);
736 if (!mono_method_desc_full_match (info->desc, method))