2 * trace.c: Tracing facilities for the Mono Runtime.
5 * Paolo Molaro (lupus@ximian.com)
6 * Dietmar Maurer (dietmar@ximian.com)
8 * (C) 2002 Ximian, Inc.
9 * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
21 #include <mono/metadata/debug-helpers.h>
22 #include <mono/metadata/assembly.h>
23 #include <mono/utils/mono-time.h>
26 #if defined (PLATFORM_ANDROID) || (defined (TARGET_IOS) && defined (TARGET_IOS))
28 # define printf(...) g_log("mono", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
30 # define fprintf(__ignore, ...) g_log ("mono-gc", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
35 #define RETURN_ADDRESS_N(N) (__builtin_extract_return_addr (__builtin_return_address (N)))
36 #define RETURN_ADDRESS() RETURN_ADDRESS_N(0)
38 #elif defined(_MSC_VER)
41 #pragma intrinsic(_ReturnAddress)
43 #define RETURN_ADDRESS() _ReturnAddress()
44 #define RETURN_ADDRESS_N(N) NULL
48 #error "Missing return address intrinsics implementation"
52 static MonoTraceSpec trace_spec;
55 mono_trace_eval_exception (MonoClass *klass)
63 for (i = 0; i < trace_spec.len; i++) {
64 MonoTraceOperation *op = &trace_spec.ops [i];
68 case MONO_TRACEOP_EXCEPTION:
69 if (strcmp ("", op->data) == 0 && strcmp ("all", op->data2) == 0)
71 else if (strcmp ("", op->data) == 0 || strcmp (klass->name_space, op->data) == 0)
72 if (strcmp (klass->name, op->data2) == 0)
89 mono_trace_eval (MonoMethod *method)
94 for (i = 0; i < trace_spec.len; i++){
95 MonoTraceOperation *op = &trace_spec.ops [i];
99 case MONO_TRACEOP_ALL:
101 case MONO_TRACEOP_PROGRAM:
102 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
104 case MONO_TRACEOP_WRAPPER:
105 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
106 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
108 case MONO_TRACEOP_METHOD:
109 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
111 case MONO_TRACEOP_CLASS:
112 if (strcmp (method->klass->name_space, op->data) == 0)
113 if (strcmp (method->klass->name, op->data2) == 0)
116 case MONO_TRACEOP_ASSEMBLY:
117 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
119 case MONO_TRACEOP_NAMESPACE:
120 if (strcmp (method->klass->name_space, op->data) == 0)
122 case MONO_TRACEOP_EXCEPTION:
134 static int is_filenamechar (char p)
136 if (p >= 'A' && p <= 'Z')
138 if (p >= 'a' && p <= 'z')
140 if (p >= '0' && p <= '9')
142 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
150 static void get_string (void)
153 while (is_filenamechar (*input)){
158 value = g_malloc (input - start + 1);
159 strncpy (value, start, input-start);
160 value [input-start] = 0;
182 while (input [0] == '+')
185 if (input [0] == '\0') {
188 if (input [0] == 'M' && input [1] == ':'){
193 if (input [0] == 'N' && input [1] == ':'){
196 return TOKEN_NAMESPACE;
198 if (input [0] == 'T' && input [1] == ':'){
203 if (input [0] == 'E' && input [1] == ':'){
206 return TOKEN_EXCEPTION;
210 return TOKEN_EXCLUDE;
212 if (is_filenamechar (*input)){
214 if (strcmp (value, "all") == 0)
216 if (strcmp (value, "program") == 0)
217 return TOKEN_PROGRAM;
218 if (strcmp (value, "wrapper") == 0)
219 return TOKEN_WRAPPER;
220 if (strcmp (value, "disabled") == 0)
221 return TOKEN_DISABLED;
226 return TOKEN_SEPARATOR;
229 fprintf (stderr, "Syntax error at or around '%s'\n", input);
243 int token = get_token ();
244 if (token == TOKEN_EXCLUDE){
245 token = get_spec (last);
246 if (token == TOKEN_EXCLUDE){
247 fprintf (stderr, "Expecting an expression");
250 if (token == TOKEN_ERROR)
252 trace_spec.ops [(*last)-1].exclude = 1;
253 return TOKEN_SEPARATOR;
255 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
258 if (token == TOKEN_METHOD){
259 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
261 fprintf (stderr, "Invalid method name: %s\n", value);
264 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
265 trace_spec.ops [*last].data = desc;
266 } else if (token == TOKEN_ALL)
267 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
268 else if (token == TOKEN_PROGRAM)
269 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
270 else if (token == TOKEN_WRAPPER)
271 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
272 else if (token == TOKEN_NAMESPACE){
273 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
274 trace_spec.ops [*last].data = g_strdup (value);
275 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
276 char *p = strrchr (value, '.');
279 trace_spec.ops [*last].data = g_strdup (value);
280 trace_spec.ops [*last].data2 = g_strdup (p);
283 trace_spec.ops [*last].data = g_strdup ("");
284 trace_spec.ops [*last].data2 = g_strdup (value);
286 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
287 } else if (token == TOKEN_STRING){
288 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
289 trace_spec.ops [*last].data = g_strdup (value);
290 } else if (token == TOKEN_DISABLED) {
291 trace_spec.enabled = FALSE;
293 fprintf (stderr, "Syntax error in trace option specification\n");
297 return TOKEN_SEPARATOR;
301 mono_trace_parse_options (const char *options)
303 char *p = (char*)options;
308 trace_spec.enabled = TRUE;
311 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
312 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
316 for (p = (char*)options; *p != 0; p++)
320 trace_spec.ops = g_new0 (MonoTraceOperation, size);
322 input = (char*)options;
325 while ((token = (get_spec (&last_used))) != TOKEN_END){
326 if (token == TOKEN_ERROR)
328 if (token == TOKEN_SEPARATOR)
331 trace_spec.len = last_used;
337 mono_trace_set_assembly (MonoAssembly *assembly)
339 trace_spec.assembly = assembly;
343 #ifdef HAVE_KW_THREAD
346 int indent_level = 0;
347 static guint64 start_time = 0;
349 static double seconds_since_start (void)
351 guint64 diff = mono_100ns_ticks () - start_time;
352 return diff/10000000.0;
355 static void indent (int diff) {
357 indent_level += diff;
359 start_time = mono_100ns_ticks ();
360 printf ("[%p: %.5f %d] ", (void*)GetCurrentThreadId (), seconds_since_start (), indent_level);
362 indent_level += diff;
366 string_to_utf8 (MonoString *s)
369 GError *error = NULL;
374 return g_strdup ("");
376 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
378 /* Happens with StringBuilders */
379 g_error_free (error);
380 return g_strdup ("<INVALID UTF8>");
387 * cpos (ebp + arg_info[n].offset) points to the beginning of the
388 * stack slot for this argument. On little-endian systems, we can
389 * simply dereference it. On big-endian systems, we need to adjust
390 * cpos upward first if the datatype we're referencing is smaller than
391 * a stack slot. Also - one can't assume that gpointer is also the
392 * size of a stack slot - use SIZEOF_REGISTER instead. The following
393 * helper macro tries to keep down the mess of all the pointer
396 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
397 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
399 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
403 mono_trace_enter_method (MonoMethod *method, char *ebp)
408 MonoJitArgumentInfo *arg_info;
409 MonoMethodSignature *sig;
411 MonoGenericSharingContext *gsctx = NULL;
413 if (!trace_spec.enabled)
416 fname = mono_method_full_name (method, TRUE);
418 printf ("ENTER: %s(", fname);
422 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
426 sig = mono_method_signature (method);
428 arg_info = alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
430 if (method->is_inflated) {
431 /* FIXME: Might be better to pass the ji itself */
432 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
434 gsctx = mono_jit_info_get_generic_sharing_context (ji);
435 if (gsctx && gsctx->is_gsharedvt) {
436 /* Needs a ctx to get precise method */
437 printf (") <gsharedvt>\n");
443 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
445 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
446 g_assert (!mono_method_signature (method)->ret->byref);
448 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
451 if (mono_method_signature (method)->hasthis) {
452 gpointer *this = (gpointer *)(ebp + arg_info [0].offset);
453 if (method->klass->valuetype) {
454 printf ("value:%p, ", *arg_in_stack_slot(this, gpointer *));
456 o = *arg_in_stack_slot(this, MonoObject *);
459 klass = o->vtable->klass;
461 if (klass == mono_defaults.string_class) {
462 MonoString *s = (MonoString*)o;
463 char *as = string_to_utf8 (s);
465 printf ("this:[STRING:%p:%s], ", o, as);
468 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
471 printf ("this:NULL, ");
475 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
476 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
477 int size = arg_info [i + 1].size;
479 MonoType *type = mono_method_signature (method)->params [i];
482 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
483 } else switch (mono_type_get_underlying_type (type)->type) {
487 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
489 case MONO_TYPE_BOOLEAN:
493 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
497 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
501 printf ("%d, ", *arg_in_stack_slot(cpos, int));
503 case MONO_TYPE_STRING: {
504 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
508 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
509 as = string_to_utf8 (s);
511 printf ("[STRING:%p:%s], ", s, as);
514 printf ("[STRING:null], ");
517 case MONO_TYPE_CLASS:
518 case MONO_TYPE_OBJECT: {
519 o = *arg_in_stack_slot(cpos, MonoObject *);
521 klass = o->vtable->klass;
523 if (klass == mono_defaults.string_class) {
524 char *as = string_to_utf8 ((MonoString*)o);
526 printf ("[STRING:%p:%s], ", o, as);
528 } else if (klass == mono_defaults.int32_class) {
529 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
530 } else if (klass == mono_defaults.monotype_class) {
531 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
533 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
535 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
540 case MONO_TYPE_FNPTR:
541 case MONO_TYPE_ARRAY:
542 case MONO_TYPE_SZARRAY:
543 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
547 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
550 printf ("%f, ", *arg_in_stack_slot(cpos, float));
553 printf ("%f, ", *arg_in_stack_slot(cpos, double));
555 case MONO_TYPE_VALUETYPE:
557 for (j = 0; j < size; j++)
558 printf ("%02x,", *((guint8*)cpos +j));
571 mono_trace_leave_method (MonoMethod *method, ...)
576 MonoGenericSharingContext *gsctx;
578 if (!trace_spec.enabled)
581 va_start(ap, method);
583 fname = mono_method_full_name (method, TRUE);
585 printf ("LEAVE: %s", fname);
588 if (method->is_inflated) {
589 /* FIXME: Might be better to pass the ji itself */
590 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
592 gsctx = mono_jit_info_get_generic_sharing_context (ji);
593 if (gsctx && gsctx->is_gsharedvt) {
594 /* Needs a ctx to get precise method */
595 printf (") <gsharedvt>\n");
601 type = mono_method_signature (method)->ret;
604 switch (type->type) {
607 case MONO_TYPE_BOOLEAN: {
608 int eax = va_arg (ap, int);
610 printf ("TRUE:%d", eax);
625 int eax = va_arg (ap, int);
626 printf ("result=%d", eax);
629 case MONO_TYPE_STRING: {
630 MonoString *s = va_arg (ap, MonoString *);
635 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
636 as = string_to_utf8 (s);
637 printf ("[STRING:%p:%s]", s, as);
640 printf ("[STRING:null], ");
643 case MONO_TYPE_CLASS:
644 case MONO_TYPE_OBJECT: {
645 MonoObject *o = va_arg (ap, MonoObject *);
648 if (o->vtable->klass == mono_defaults.boolean_class) {
649 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
650 } else if (o->vtable->klass == mono_defaults.int32_class) {
651 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
652 } else if (o->vtable->klass == mono_defaults.int64_class) {
653 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
655 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
657 printf ("[OBJECT:%p]", o);
662 case MONO_TYPE_FNPTR:
663 case MONO_TYPE_ARRAY:
664 case MONO_TYPE_SZARRAY: {
665 gpointer p = va_arg (ap, gpointer);
666 printf ("result=%p", p);
670 gint64 l = va_arg (ap, gint64);
671 printf ("lresult=0x%16llx", (long long)l);
675 gint64 l = va_arg (ap, gint64);
676 printf ("lresult=0x%16llx", (long long)l);
681 double f = va_arg (ap, double);
685 case MONO_TYPE_VALUETYPE:
686 if (type->data.klass->enumtype) {
687 type = mono_class_enum_basetype (type->data.klass);
690 guint8 *p = va_arg (ap, gpointer);
692 size = mono_type_size (type, &align);
694 for (j = 0; p && j < size; j++)
695 printf ("%02x,", p [j]);
700 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
703 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
709 mono_trace_enable (gboolean enable)
711 trace_spec.enabled = enable;
715 mono_trace_is_enabled ()
717 return trace_spec.enabled;