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)
22 #include <mono/metadata/debug-helpers.h>
23 #include <mono/metadata/assembly.h>
24 #include <mono/utils/mono-time.h>
27 #if defined (PLATFORM_ANDROID) || (defined (TARGET_IOS) && defined (TARGET_IOS))
29 # define printf(...) g_log("mono", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
31 # define fprintf(__ignore, ...) g_log ("mono-gc", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
36 #define RETURN_ADDRESS_N(N) (__builtin_extract_return_addr (__builtin_return_address (N)))
37 #define RETURN_ADDRESS() RETURN_ADDRESS_N(0)
39 #elif defined(_MSC_VER)
44 void *_ReturnAddress(void);
45 #pragma intrinsic(_ReturnAddress)
46 #define RETURN_ADDRESS() _ReturnAddress()
47 #define RETURN_ADDRESS_N(N) NULL
51 #define RETURN_ADDRESS() NULL
52 #define RETURN_ADDRESS_N(N) NULL
56 static MonoTraceSpec trace_spec;
59 mono_trace_eval_exception (MonoClass *klass)
67 for (i = 0; i < trace_spec.len; i++) {
68 MonoTraceOperation *op = &trace_spec.ops [i];
72 case MONO_TRACEOP_EXCEPTION:
73 if (strcmp ("", op->data) == 0 && strcmp ("all", op->data2) == 0)
75 else if (strcmp ("", op->data) == 0 || strcmp (klass->name_space, op->data) == 0)
76 if (strcmp (klass->name, op->data2) == 0)
93 mono_trace_eval (MonoMethod *method)
98 for (i = 0; i < trace_spec.len; i++){
99 MonoTraceOperation *op = &trace_spec.ops [i];
103 case MONO_TRACEOP_ALL:
105 case MONO_TRACEOP_PROGRAM:
106 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
108 case MONO_TRACEOP_WRAPPER:
109 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
110 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
112 case MONO_TRACEOP_METHOD:
113 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
115 case MONO_TRACEOP_CLASS:
116 if (strcmp (method->klass->name_space, op->data) == 0)
117 if (strcmp (method->klass->name, op->data2) == 0)
120 case MONO_TRACEOP_ASSEMBLY:
121 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
123 case MONO_TRACEOP_NAMESPACE:
124 if (strcmp (method->klass->name_space, op->data) == 0)
126 case MONO_TRACEOP_EXCEPTION:
138 static int is_filenamechar (char p)
140 if (p >= 'A' && p <= 'Z')
142 if (p >= 'a' && p <= 'z')
144 if (p >= '0' && p <= '9')
146 if (p == '.' || p == ':' || p == '_' || p == '-')
154 static void get_string (void)
157 while (is_filenamechar (*input)){
162 value = g_malloc (input - start + 1);
163 strncpy (value, start, input-start);
164 value [input-start] = 0;
186 while (input [0] == '+')
189 if (input [0] == '\0') {
192 if (input [0] == 'M' && input [1] == ':'){
197 if (input [0] == 'N' && input [1] == ':'){
200 return TOKEN_NAMESPACE;
202 if (input [0] == 'T' && input [1] == ':'){
207 if (input [0] == 'E' && input [1] == ':'){
210 return TOKEN_EXCEPTION;
214 return TOKEN_EXCLUDE;
216 if (is_filenamechar (*input)){
218 if (strcmp (value, "all") == 0)
220 if (strcmp (value, "program") == 0)
221 return TOKEN_PROGRAM;
222 if (strcmp (value, "wrapper") == 0)
223 return TOKEN_WRAPPER;
224 if (strcmp (value, "disabled") == 0)
225 return TOKEN_DISABLED;
230 return TOKEN_SEPARATOR;
233 fprintf (stderr, "Syntax error at or around '%s'\n", input);
247 int token = get_token ();
248 if (token == TOKEN_EXCLUDE){
249 token = get_spec (last);
250 if (token == TOKEN_EXCLUDE){
251 fprintf (stderr, "Expecting an expression");
254 if (token == TOKEN_ERROR)
256 trace_spec.ops [(*last)-1].exclude = 1;
257 return TOKEN_SEPARATOR;
259 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
262 if (token == TOKEN_METHOD){
263 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
265 fprintf (stderr, "Invalid method name: %s\n", value);
268 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
269 trace_spec.ops [*last].data = desc;
270 } else if (token == TOKEN_ALL)
271 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
272 else if (token == TOKEN_PROGRAM)
273 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
274 else if (token == TOKEN_WRAPPER)
275 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
276 else if (token == TOKEN_NAMESPACE){
277 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
278 trace_spec.ops [*last].data = g_strdup (value);
279 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
280 char *p = strrchr (value, '.');
283 trace_spec.ops [*last].data = g_strdup (value);
284 trace_spec.ops [*last].data2 = g_strdup (p);
287 trace_spec.ops [*last].data = g_strdup ("");
288 trace_spec.ops [*last].data2 = g_strdup (value);
290 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
291 } else if (token == TOKEN_STRING){
292 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
293 trace_spec.ops [*last].data = g_strdup (value);
294 } else if (token == TOKEN_DISABLED) {
295 trace_spec.enabled = FALSE;
297 fprintf (stderr, "Syntax error in trace option specification\n");
301 return TOKEN_SEPARATOR;
305 mono_trace_parse_options (const char *options)
307 char *p = (char*)options;
312 trace_spec.enabled = TRUE;
315 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
316 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
320 for (p = (char*)options; *p != 0; p++)
324 trace_spec.ops = g_new0 (MonoTraceOperation, size);
326 input = (char*)options;
329 while ((token = (get_spec (&last_used))) != TOKEN_END){
330 if (token == TOKEN_ERROR)
332 if (token == TOKEN_SEPARATOR)
335 trace_spec.len = last_used;
341 mono_trace_set_assembly (MonoAssembly *assembly)
343 trace_spec.assembly = assembly;
347 #ifdef HAVE_KW_THREAD
350 int indent_level = 0;
351 static guint64 start_time = 0;
353 static double seconds_since_start (void)
355 guint64 diff = mono_100ns_ticks () - start_time;
356 return diff/10000000.0;
359 static void indent (int diff) {
361 indent_level += diff;
363 start_time = mono_100ns_ticks ();
364 printf ("[%p: %.5f %d] ", (void*)GetCurrentThreadId (), seconds_since_start (), indent_level);
366 indent_level += diff;
370 string_to_utf8 (MonoString *s)
373 GError *error = NULL;
378 return g_strdup ("");
380 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
382 /* Happens with StringBuilders */
383 g_error_free (error);
384 return g_strdup ("<INVALID UTF8>");
391 * cpos (ebp + arg_info[n].offset) points to the beginning of the
392 * stack slot for this argument. On little-endian systems, we can
393 * simply dereference it. On big-endian systems, we need to adjust
394 * cpos upward first if the datatype we're referencing is smaller than
395 * a stack slot. Also - one can't assume that gpointer is also the
396 * size of a stack slot - use SIZEOF_REGISTER instead. The following
397 * helper macro tries to keep down the mess of all the pointer
400 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
401 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
403 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
407 mono_trace_enter_method (MonoMethod *method, char *ebp)
412 MonoJitArgumentInfo *arg_info;
413 MonoMethodSignature *sig;
415 MonoGenericSharingContext *gsctx = NULL;
417 if (!trace_spec.enabled)
420 fname = mono_method_full_name (method, TRUE);
422 printf ("ENTER: %s(", fname);
426 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
430 sig = mono_method_signature (method);
432 arg_info = alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
434 if (method->is_inflated) {
435 /* FIXME: Might be better to pass the ji itself */
436 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
438 gsctx = mono_jit_info_get_generic_sharing_context (ji);
439 if (gsctx && (gsctx->var_is_vt || gsctx->mvar_is_vt)) {
440 /* Needs a ctx to get precise method */
441 printf (") <gsharedvt>\n");
447 mono_arch_get_argument_info (gsctx, sig, sig->param_count, arg_info);
449 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
450 g_assert (!mono_method_signature (method)->ret->byref);
452 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
455 if (mono_method_signature (method)->hasthis) {
456 gpointer *this = (gpointer *)(ebp + arg_info [0].offset);
457 if (method->klass->valuetype) {
458 printf ("value:%p, ", *arg_in_stack_slot(this, gpointer *));
460 o = *arg_in_stack_slot(this, MonoObject *);
463 class = o->vtable->klass;
465 if (class == mono_defaults.string_class) {
466 MonoString *s = (MonoString*)o;
467 char *as = string_to_utf8 (s);
469 printf ("this:[STRING:%p:%s], ", o, as);
472 printf ("this:%p[%s.%s %s], ", o, class->name_space, class->name, o->vtable->domain->friendly_name);
475 printf ("this:NULL, ");
479 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
480 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
481 int size = arg_info [i + 1].size;
483 MonoType *type = mono_method_signature (method)->params [i];
486 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
487 } else switch (mono_type_get_underlying_type (type)->type) {
491 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
493 case MONO_TYPE_BOOLEAN:
497 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
501 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
505 printf ("%d, ", *arg_in_stack_slot(cpos, int));
507 case MONO_TYPE_STRING: {
508 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
512 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
513 as = string_to_utf8 (s);
515 printf ("[STRING:%p:%s], ", s, as);
518 printf ("[STRING:null], ");
521 case MONO_TYPE_CLASS:
522 case MONO_TYPE_OBJECT: {
523 o = *arg_in_stack_slot(cpos, MonoObject *);
525 class = o->vtable->klass;
527 if (class == mono_defaults.string_class) {
528 char *as = string_to_utf8 ((MonoString*)o);
530 printf ("[STRING:%p:%s], ", o, as);
532 } else if (class == mono_defaults.int32_class) {
533 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
534 } else if (class == mono_defaults.monotype_class) {
535 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
537 printf ("[%s.%s:%p], ", class->name_space, class->name, o);
539 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
544 case MONO_TYPE_FNPTR:
545 case MONO_TYPE_ARRAY:
546 case MONO_TYPE_SZARRAY:
547 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
551 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
554 printf ("%f, ", *arg_in_stack_slot(cpos, float));
557 printf ("%f, ", *arg_in_stack_slot(cpos, double));
559 case MONO_TYPE_VALUETYPE:
561 for (j = 0; j < size; j++)
562 printf ("%02x,", *((guint8*)cpos +j));
575 mono_trace_leave_method (MonoMethod *method, ...)
580 MonoGenericSharingContext *gsctx;
582 if (!trace_spec.enabled)
585 va_start(ap, method);
587 fname = mono_method_full_name (method, TRUE);
589 printf ("LEAVE: %s", fname);
592 if (method->is_inflated) {
593 /* FIXME: Might be better to pass the ji itself */
594 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
596 gsctx = mono_jit_info_get_generic_sharing_context (ji);
597 if (gsctx && (gsctx->var_is_vt || gsctx->mvar_is_vt)) {
598 /* Needs a ctx to get precise method */
599 printf (") <gsharedvt>\n");
605 type = mono_method_signature (method)->ret;
608 switch (type->type) {
611 case MONO_TYPE_BOOLEAN: {
612 int eax = va_arg (ap, int);
614 printf ("TRUE:%d", eax);
629 int eax = va_arg (ap, int);
630 printf ("result=%d", eax);
633 case MONO_TYPE_STRING: {
634 MonoString *s = va_arg (ap, MonoString *);
639 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
640 as = string_to_utf8 (s);
641 printf ("[STRING:%p:%s]", s, as);
644 printf ("[STRING:null], ");
647 case MONO_TYPE_CLASS:
648 case MONO_TYPE_OBJECT: {
649 MonoObject *o = va_arg (ap, MonoObject *);
652 if (o->vtable->klass == mono_defaults.boolean_class) {
653 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
654 } else if (o->vtable->klass == mono_defaults.int32_class) {
655 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
656 } else if (o->vtable->klass == mono_defaults.int64_class) {
657 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
659 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
661 printf ("[OBJECT:%p]", o);
666 case MONO_TYPE_FNPTR:
667 case MONO_TYPE_ARRAY:
668 case MONO_TYPE_SZARRAY: {
669 gpointer p = va_arg (ap, gpointer);
670 printf ("result=%p", p);
674 gint64 l = va_arg (ap, gint64);
675 printf ("lresult=0x%16llx", (long long)l);
679 gint64 l = va_arg (ap, gint64);
680 printf ("lresult=0x%16llx", (long long)l);
685 double f = va_arg (ap, double);
689 case MONO_TYPE_VALUETYPE:
690 if (type->data.klass->enumtype) {
691 type = mono_class_enum_basetype (type->data.klass);
694 guint8 *p = va_arg (ap, gpointer);
696 size = mono_type_size (type, &align);
698 for (j = 0; p && j < size; j++)
699 printf ("%02x,", p [j]);
704 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
707 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
713 mono_trace_enable (gboolean enable)
715 trace_spec.enabled = enable;
719 mono_trace_is_enabled ()
721 return trace_spec.enabled;