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>
24 #include <mono/utils/mono-memory-model.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)
42 #pragma intrinsic(_ReturnAddress)
44 #define RETURN_ADDRESS() _ReturnAddress()
45 #define RETURN_ADDRESS_N(N) NULL
49 #error "Missing return address intrinsics implementation"
53 static MonoTraceSpec trace_spec;
55 static volatile gint32 output_lock = 0;
58 mono_trace_eval_exception (MonoClass *klass)
66 for (i = 0; i < trace_spec.len; i++) {
67 MonoTraceOperation *op = &trace_spec.ops [i];
71 case MONO_TRACEOP_EXCEPTION:
72 if (strcmp ("", op->data) == 0 && strcmp ("all", op->data2) == 0)
74 else if (strcmp ("", op->data) == 0 || strcmp (klass->name_space, op->data) == 0)
75 if (strcmp (klass->name, op->data2) == 0)
92 mono_trace_eval (MonoMethod *method)
97 for (i = 0; i < trace_spec.len; i++){
98 MonoTraceOperation *op = &trace_spec.ops [i];
102 case MONO_TRACEOP_ALL:
104 case MONO_TRACEOP_PROGRAM:
105 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
107 case MONO_TRACEOP_WRAPPER:
108 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
109 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
111 case MONO_TRACEOP_METHOD:
112 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
114 case MONO_TRACEOP_CLASS:
115 if (strcmp (method->klass->name_space, op->data) == 0)
116 if (strcmp (method->klass->name, op->data2) == 0)
119 case MONO_TRACEOP_ASSEMBLY:
120 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
122 case MONO_TRACEOP_NAMESPACE:
123 if (strcmp (method->klass->name_space, op->data) == 0)
125 case MONO_TRACEOP_EXCEPTION:
137 static int is_filenamechar (char p)
139 if (p >= 'A' && p <= 'Z')
141 if (p >= 'a' && p <= 'z')
143 if (p >= '0' && p <= '9')
145 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
153 static void get_string (void)
156 while (is_filenamechar (*input)){
161 value = g_malloc (input - start + 1);
162 strncpy (value, start, input-start);
163 value [input-start] = 0;
185 while (input [0] == '+')
188 if (input [0] == '\0') {
191 if (input [0] == 'M' && input [1] == ':'){
196 if (input [0] == 'N' && input [1] == ':'){
199 return TOKEN_NAMESPACE;
201 if (input [0] == 'T' && input [1] == ':'){
206 if (input [0] == 'E' && input [1] == ':'){
209 return TOKEN_EXCEPTION;
213 return TOKEN_EXCLUDE;
215 if (is_filenamechar (*input)){
217 if (strcmp (value, "all") == 0)
219 if (strcmp (value, "program") == 0)
220 return TOKEN_PROGRAM;
221 if (strcmp (value, "wrapper") == 0)
222 return TOKEN_WRAPPER;
223 if (strcmp (value, "disabled") == 0)
224 return TOKEN_DISABLED;
229 return TOKEN_SEPARATOR;
232 fprintf (stderr, "Syntax error at or around '%s'\n", input);
246 int token = get_token ();
247 if (token == TOKEN_EXCLUDE){
248 token = get_spec (last);
249 if (token == TOKEN_EXCLUDE){
250 fprintf (stderr, "Expecting an expression");
253 if (token == TOKEN_ERROR)
255 trace_spec.ops [(*last)-1].exclude = 1;
256 return TOKEN_SEPARATOR;
258 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
261 if (token == TOKEN_METHOD){
262 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
264 fprintf (stderr, "Invalid method name: %s\n", value);
267 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
268 trace_spec.ops [*last].data = desc;
269 } else if (token == TOKEN_ALL)
270 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
271 else if (token == TOKEN_PROGRAM)
272 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
273 else if (token == TOKEN_WRAPPER)
274 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
275 else if (token == TOKEN_NAMESPACE){
276 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
277 trace_spec.ops [*last].data = g_strdup (value);
278 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
279 char *p = strrchr (value, '.');
282 trace_spec.ops [*last].data = g_strdup (value);
283 trace_spec.ops [*last].data2 = g_strdup (p);
286 trace_spec.ops [*last].data = g_strdup ("");
287 trace_spec.ops [*last].data2 = g_strdup (value);
289 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
290 } else if (token == TOKEN_STRING){
291 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
292 trace_spec.ops [*last].data = g_strdup (value);
293 } else if (token == TOKEN_DISABLED) {
294 trace_spec.enabled = FALSE;
296 fprintf (stderr, "Syntax error in trace option specification\n");
300 return TOKEN_SEPARATOR;
304 mono_trace_parse_options (const char *options)
306 char *p = (char*)options;
311 trace_spec.enabled = TRUE;
314 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
315 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
319 for (p = (char*)options; *p != 0; p++)
323 trace_spec.ops = g_new0 (MonoTraceOperation, size);
325 input = (char*)options;
328 while ((token = (get_spec (&last_used))) != TOKEN_END){
329 if (token == TOKEN_ERROR)
331 if (token == TOKEN_SEPARATOR)
334 trace_spec.len = last_used;
340 mono_trace_set_assembly (MonoAssembly *assembly)
342 trace_spec.assembly = assembly;
346 #ifdef HAVE_KW_THREAD
349 int indent_level = 0;
350 static guint64 start_time = 0;
352 static double seconds_since_start (void)
354 guint64 diff = mono_100ns_ticks () - start_time;
355 return diff/10000000.0;
358 static void indent (int diff) {
360 indent_level += diff;
362 start_time = mono_100ns_ticks ();
363 printf ("[%p: %.5f %d] ", (void*)mono_native_thread_id_get (), seconds_since_start (), indent_level);
365 indent_level += diff;
369 string_to_utf8 (MonoString *s)
372 GError *error = NULL;
377 return g_strdup ("");
379 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
381 /* Happens with StringBuilders */
382 g_error_free (error);
383 return g_strdup ("<INVALID UTF8>");
390 * cpos (ebp + arg_info[n].offset) points to the beginning of the
391 * stack slot for this argument. On little-endian systems, we can
392 * simply dereference it. On big-endian systems, we need to adjust
393 * cpos upward first if the datatype we're referencing is smaller than
394 * a stack slot. Also - one can't assume that gpointer is also the
395 * size of a stack slot - use SIZEOF_REGISTER instead. The following
396 * helper macro tries to keep down the mess of all the pointer
399 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
400 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
402 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
406 mono_trace_enter_method (MonoMethod *method, char *ebp)
411 MonoJitArgumentInfo *arg_info;
412 MonoMethodSignature *sig;
414 MonoGenericSharingContext *gsctx = NULL;
416 if (!trace_spec.enabled)
419 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
420 mono_thread_info_yield ();
422 fname = mono_method_full_name (method, TRUE);
424 printf ("ENTER: %s(", fname);
428 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
432 sig = mono_method_signature (method);
434 arg_info = alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
436 if (method->is_inflated) {
437 /* FIXME: Might be better to pass the ji itself */
438 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
440 gsctx = mono_jit_info_get_generic_sharing_context (ji);
441 if (gsctx && gsctx->is_gsharedvt) {
442 /* Needs a ctx to get precise method */
443 printf (") <gsharedvt>\n");
449 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
451 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
452 g_assert (!mono_method_signature (method)->ret->byref);
454 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
457 if (mono_method_signature (method)->hasthis) {
458 gpointer *this = (gpointer *)(ebp + arg_info [0].offset);
459 if (method->klass->valuetype) {
460 printf ("value:%p, ", *arg_in_stack_slot(this, gpointer *));
462 o = *arg_in_stack_slot(this, MonoObject *);
465 klass = o->vtable->klass;
467 if (klass == mono_defaults.string_class) {
468 MonoString *s = (MonoString*)o;
469 char *as = string_to_utf8 (s);
471 printf ("this:[STRING:%p:%s], ", o, as);
474 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
477 printf ("this:NULL, ");
481 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
482 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
483 int size = arg_info [i + 1].size;
485 MonoType *type = mono_method_signature (method)->params [i];
488 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
489 } else switch (mini_get_underlying_type (type)->type) {
493 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
495 case MONO_TYPE_BOOLEAN:
499 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
503 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
507 printf ("%d, ", *arg_in_stack_slot(cpos, int));
509 case MONO_TYPE_STRING: {
510 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
514 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
515 as = string_to_utf8 (s);
517 printf ("[STRING:%p:%s], ", s, as);
520 printf ("[STRING:null], ");
523 case MONO_TYPE_CLASS:
524 case MONO_TYPE_OBJECT: {
525 o = *arg_in_stack_slot(cpos, MonoObject *);
527 klass = o->vtable->klass;
529 if (klass == mono_defaults.string_class) {
530 char *as = string_to_utf8 ((MonoString*)o);
532 printf ("[STRING:%p:%s], ", o, as);
534 } else if (klass == mono_defaults.int32_class) {
535 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
536 } else if (klass == mono_defaults.monotype_class) {
537 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
539 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
541 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
546 case MONO_TYPE_FNPTR:
547 case MONO_TYPE_ARRAY:
548 case MONO_TYPE_SZARRAY:
549 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
553 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
556 printf ("%f, ", *arg_in_stack_slot(cpos, float));
559 printf ("%f, ", *arg_in_stack_slot(cpos, double));
561 case MONO_TYPE_VALUETYPE:
563 for (j = 0; j < size; j++)
564 printf ("%02x,", *((guint8*)cpos +j));
576 mono_atomic_store_release (&output_lock, 0);
580 mono_trace_leave_method (MonoMethod *method, ...)
585 MonoGenericSharingContext *gsctx;
587 if (!trace_spec.enabled)
590 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
591 mono_thread_info_yield ();
593 va_start(ap, method);
595 fname = mono_method_full_name (method, TRUE);
597 printf ("LEAVE: %s", fname);
600 if (method->is_inflated) {
601 /* FIXME: Might be better to pass the ji itself */
602 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), RETURN_ADDRESS (), NULL);
604 gsctx = mono_jit_info_get_generic_sharing_context (ji);
605 if (gsctx && gsctx->is_gsharedvt) {
606 /* Needs a ctx to get precise method */
607 printf (") <gsharedvt>\n");
613 type = mini_get_underlying_type (mono_method_signature (method)->ret);
615 switch (type->type) {
618 case MONO_TYPE_BOOLEAN: {
619 int eax = va_arg (ap, int);
621 printf ("TRUE:%d", eax);
636 int eax = va_arg (ap, int);
637 printf ("result=%d", eax);
640 case MONO_TYPE_STRING: {
641 MonoString *s = va_arg (ap, MonoString *);
646 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
647 as = string_to_utf8 (s);
648 printf ("[STRING:%p:%s]", s, as);
651 printf ("[STRING:null], ");
654 case MONO_TYPE_CLASS:
655 case MONO_TYPE_OBJECT: {
656 MonoObject *o = va_arg (ap, MonoObject *);
659 if (o->vtable->klass == mono_defaults.boolean_class) {
660 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
661 } else if (o->vtable->klass == mono_defaults.int32_class) {
662 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
663 } else if (o->vtable->klass == mono_defaults.int64_class) {
664 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
666 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
668 printf ("[OBJECT:%p]", o);
673 case MONO_TYPE_FNPTR:
674 case MONO_TYPE_ARRAY:
675 case MONO_TYPE_SZARRAY: {
676 gpointer p = va_arg (ap, gpointer);
677 printf ("result=%p", p);
681 gint64 l = va_arg (ap, gint64);
682 printf ("lresult=0x%16llx", (long long)l);
686 gint64 l = va_arg (ap, gint64);
687 printf ("lresult=0x%16llx", (long long)l);
692 double f = va_arg (ap, double);
696 case MONO_TYPE_VALUETYPE: {
697 guint8 *p = va_arg (ap, gpointer);
699 size = mono_type_size (type, &align);
701 for (j = 0; p && j < size; j++)
702 printf ("%02x,", p [j]);
707 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
710 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
715 mono_atomic_store_release (&output_lock, 0);
719 mono_trace_enable (gboolean enable)
721 trace_spec.enabled = enable;
725 mono_trace_is_enabled ()
727 return trace_spec.enabled;