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)
10 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
22 #include <mono/metadata/debug-helpers.h>
23 #include <mono/metadata/assembly.h>
24 #include <mono/utils/mono-time.h>
25 #include <mono/utils/mono-memory-model.h>
28 #if defined (PLATFORM_ANDROID) || (defined (TARGET_IOS) && defined (TARGET_IOS))
30 # define printf(...) g_log("mono", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
32 # define fprintf(__ignore, ...) g_log ("mono-gc", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
37 #define RETURN_ADDRESS_N(N) (__builtin_extract_return_addr (__builtin_return_address (N)))
38 #define RETURN_ADDRESS() RETURN_ADDRESS_N(0)
40 #elif defined(_MSC_VER)
43 #pragma intrinsic(_ReturnAddress)
45 #define RETURN_ADDRESS() _ReturnAddress()
46 #define RETURN_ADDRESS_N(N) NULL
50 #error "Missing return address intrinsics implementation"
54 static MonoTraceSpec trace_spec;
56 static volatile gint32 output_lock = 0;
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:
106 case MONO_TRACEOP_PROGRAM:
107 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
110 case MONO_TRACEOP_WRAPPER:
111 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
112 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
115 case MONO_TRACEOP_METHOD:
116 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
119 case MONO_TRACEOP_CLASS:
120 if (strcmp (method->klass->name_space, op->data) == 0)
121 if (strcmp (method->klass->name, op->data2) == 0)
124 case MONO_TRACEOP_ASSEMBLY:
125 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
128 case MONO_TRACEOP_NAMESPACE:
129 if (strcmp (method->klass->name_space, op->data) == 0)
132 case MONO_TRACEOP_EXCEPTION:
144 static int is_filenamechar (char p)
146 if (p >= 'A' && p <= 'Z')
148 if (p >= 'a' && p <= 'z')
150 if (p >= '0' && p <= '9')
152 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
160 static void get_string (void)
163 while (is_filenamechar (*input)){
168 value = (char *)g_malloc (input - start + 1);
169 strncpy (value, start, input-start);
170 value [input-start] = 0;
192 while (input [0] == '+')
195 if (input [0] == '\0') {
198 if (input [0] == 'M' && input [1] == ':'){
203 if (input [0] == 'N' && input [1] == ':'){
206 return TOKEN_NAMESPACE;
208 if (input [0] == 'T' && input [1] == ':'){
213 if (input [0] == 'E' && input [1] == ':'){
216 return TOKEN_EXCEPTION;
220 return TOKEN_EXCLUDE;
222 if (is_filenamechar (*input)){
224 if (strcmp (value, "all") == 0)
226 if (strcmp (value, "program") == 0)
227 return TOKEN_PROGRAM;
228 if (strcmp (value, "wrapper") == 0)
229 return TOKEN_WRAPPER;
230 if (strcmp (value, "disabled") == 0)
231 return TOKEN_DISABLED;
236 return TOKEN_SEPARATOR;
239 fprintf (stderr, "Syntax error at or around '%s'\n", input);
253 int token = get_token ();
254 if (token == TOKEN_EXCLUDE){
255 token = get_spec (last);
256 if (token == TOKEN_EXCLUDE){
257 fprintf (stderr, "Expecting an expression");
260 if (token == TOKEN_ERROR)
262 trace_spec.ops [(*last)-1].exclude = 1;
263 return TOKEN_SEPARATOR;
265 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
268 if (token == TOKEN_METHOD){
269 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
271 fprintf (stderr, "Invalid method name: %s\n", value);
274 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
275 trace_spec.ops [*last].data = desc;
276 } else if (token == TOKEN_ALL)
277 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
278 else if (token == TOKEN_PROGRAM)
279 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
280 else if (token == TOKEN_WRAPPER)
281 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
282 else if (token == TOKEN_NAMESPACE){
283 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
284 trace_spec.ops [*last].data = g_strdup (value);
285 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
286 char *p = strrchr (value, '.');
289 trace_spec.ops [*last].data = g_strdup (value);
290 trace_spec.ops [*last].data2 = g_strdup (p);
293 trace_spec.ops [*last].data = g_strdup ("");
294 trace_spec.ops [*last].data2 = g_strdup (value);
296 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
297 } else if (token == TOKEN_STRING){
298 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
299 trace_spec.ops [*last].data = g_strdup (value);
300 } else if (token == TOKEN_DISABLED) {
301 trace_spec.enabled = FALSE;
303 fprintf (stderr, "Syntax error in trace option specification\n");
307 return TOKEN_SEPARATOR;
311 mono_trace_parse_options (const char *options)
313 char *p = (char*)options;
318 trace_spec.enabled = TRUE;
321 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
322 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
326 for (p = (char*)options; *p != 0; p++)
330 trace_spec.ops = g_new0 (MonoTraceOperation, size);
332 input = (char*)options;
335 while ((token = (get_spec (&last_used))) != TOKEN_END){
336 if (token == TOKEN_ERROR)
338 if (token == TOKEN_SEPARATOR)
341 trace_spec.len = last_used;
347 mono_trace_set_assembly (MonoAssembly *assembly)
349 trace_spec.assembly = assembly;
353 #ifdef HAVE_KW_THREAD
356 int indent_level = 0;
357 static guint64 start_time = 0;
359 static double seconds_since_start (void)
361 guint64 diff = mono_100ns_ticks () - start_time;
362 return diff/10000000.0;
365 static void indent (int diff) {
367 indent_level += diff;
369 start_time = mono_100ns_ticks ();
370 printf ("[%p: %.5f %d] ", (void*)mono_native_thread_id_get (), seconds_since_start (), indent_level);
372 indent_level += diff;
376 string_to_utf8 (MonoString *s)
379 GError *error = NULL;
384 return g_strdup ("");
386 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
388 /* Happens with StringBuilders */
389 g_error_free (error);
390 return g_strdup ("<INVALID UTF8>");
397 * cpos (ebp + arg_info[n].offset) points to the beginning of the
398 * stack slot for this argument. On little-endian systems, we can
399 * simply dereference it. On big-endian systems, we need to adjust
400 * cpos upward first if the datatype we're referencing is smaller than
401 * a stack slot. Also - one can't assume that gpointer is also the
402 * size of a stack slot - use SIZEOF_REGISTER instead. The following
403 * helper macro tries to keep down the mess of all the pointer
406 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
407 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
409 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
413 mono_trace_enter_method (MonoMethod *method, char *ebp)
418 MonoJitArgumentInfo *arg_info;
419 MonoMethodSignature *sig;
421 MonoGenericSharingContext *gsctx = NULL;
423 if (!trace_spec.enabled)
426 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
427 mono_thread_info_yield ();
429 fname = mono_method_full_name (method, TRUE);
431 printf ("ENTER: %s(", fname);
435 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
439 sig = mono_method_signature (method);
441 arg_info = (MonoJitArgumentInfo *)alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
443 if (method->is_inflated) {
444 /* FIXME: Might be better to pass the ji itself */
445 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
447 gsctx = mono_jit_info_get_generic_sharing_context (ji);
448 if (gsctx && gsctx->is_gsharedvt) {
449 /* Needs a ctx to get precise method */
450 printf (") <gsharedvt>\n");
456 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
458 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
459 g_assert (!mono_method_signature (method)->ret->byref);
461 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
464 if (mono_method_signature (method)->hasthis) {
465 gpointer *this_obj = (gpointer *)(ebp + arg_info [0].offset);
466 if (method->klass->valuetype) {
467 printf ("value:%p, ", *arg_in_stack_slot(this_obj, gpointer *));
469 o = *arg_in_stack_slot(this_obj, MonoObject *);
472 klass = o->vtable->klass;
474 if (klass == mono_defaults.string_class) {
475 MonoString *s = (MonoString*)o;
476 char *as = string_to_utf8 (s);
478 printf ("this:[STRING:%p:%s], ", o, as);
481 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
484 printf ("this:NULL, ");
488 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
489 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
490 int size = arg_info [i + 1].size;
492 MonoType *type = mono_method_signature (method)->params [i];
495 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
496 } else switch (mini_get_underlying_type (type)->type) {
500 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
502 case MONO_TYPE_BOOLEAN:
506 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
510 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
514 printf ("%d, ", *arg_in_stack_slot(cpos, int));
516 case MONO_TYPE_STRING: {
517 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
521 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
522 as = string_to_utf8 (s);
524 printf ("[STRING:%p:%s], ", s, as);
527 printf ("[STRING:null], ");
530 case MONO_TYPE_CLASS:
531 case MONO_TYPE_OBJECT: {
532 o = *arg_in_stack_slot(cpos, MonoObject *);
534 klass = o->vtable->klass;
536 if (klass == mono_defaults.string_class) {
537 char *as = string_to_utf8 ((MonoString*)o);
539 printf ("[STRING:%p:%s], ", o, as);
541 } else if (klass == mono_defaults.int32_class) {
542 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
543 } else if (klass == mono_defaults.runtimetype_class) {
544 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
546 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
548 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
553 case MONO_TYPE_FNPTR:
554 case MONO_TYPE_ARRAY:
555 case MONO_TYPE_SZARRAY:
556 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
560 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
563 printf ("%f, ", *arg_in_stack_slot(cpos, float));
566 printf ("%f, ", *arg_in_stack_slot(cpos, double));
568 case MONO_TYPE_VALUETYPE:
570 for (j = 0; j < size; j++)
571 printf ("%02x,", *((guint8*)cpos +j));
583 mono_atomic_store_release (&output_lock, 0);
587 mono_trace_leave_method (MonoMethod *method, ...)
592 MonoGenericSharingContext *gsctx;
594 if (!trace_spec.enabled)
597 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
598 mono_thread_info_yield ();
600 va_start(ap, method);
602 fname = mono_method_full_name (method, TRUE);
604 printf ("LEAVE: %s", fname);
607 if (method->is_inflated) {
608 /* FIXME: Might be better to pass the ji itself */
609 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
611 gsctx = mono_jit_info_get_generic_sharing_context (ji);
612 if (gsctx && gsctx->is_gsharedvt) {
613 /* Needs a ctx to get precise method */
614 printf (") <gsharedvt>\n");
620 type = mini_get_underlying_type (mono_method_signature (method)->ret);
622 switch (type->type) {
625 case MONO_TYPE_BOOLEAN: {
626 int eax = va_arg (ap, int);
628 printf ("TRUE:%d", eax);
643 int eax = va_arg (ap, int);
644 printf ("result=%d", eax);
647 case MONO_TYPE_STRING: {
648 MonoString *s = va_arg (ap, MonoString *);
653 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
654 as = string_to_utf8 (s);
655 printf ("[STRING:%p:%s]", s, as);
658 printf ("[STRING:null], ");
661 case MONO_TYPE_CLASS:
662 case MONO_TYPE_OBJECT: {
663 MonoObject *o = va_arg (ap, MonoObject *);
666 if (o->vtable->klass == mono_defaults.boolean_class) {
667 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
668 } else if (o->vtable->klass == mono_defaults.int32_class) {
669 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
670 } else if (o->vtable->klass == mono_defaults.int64_class) {
671 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
673 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
675 printf ("[OBJECT:%p]", o);
680 case MONO_TYPE_FNPTR:
681 case MONO_TYPE_ARRAY:
682 case MONO_TYPE_SZARRAY: {
683 gpointer p = va_arg (ap, gpointer);
684 printf ("result=%p", p);
688 gint64 l = va_arg (ap, gint64);
689 printf ("lresult=0x%16llx", (long long)l);
693 gint64 l = va_arg (ap, gint64);
694 printf ("lresult=0x%16llx", (long long)l);
699 double f = va_arg (ap, double);
703 case MONO_TYPE_VALUETYPE: {
704 guint8 *p = (guint8 *)va_arg (ap, gpointer);
706 size = mono_type_size (type, &align);
708 for (j = 0; p && j < size; j++)
709 printf ("%02x,", p [j]);
714 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
717 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
722 mono_atomic_store_release (&output_lock, 0);
726 mono_trace_enable (gboolean enable)
728 trace_spec.enabled = enable;
732 mono_trace_is_enabled ()
734 return trace_spec.enabled;