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:
145 static int is_filenamechar (char p)
147 if (p >= 'A' && p <= 'Z')
149 if (p >= 'a' && p <= 'z')
151 if (p >= '0' && p <= '9')
153 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
161 static void get_string (void)
164 while (is_filenamechar (*input)){
169 size_t len = input - start;
170 value = (char *)g_malloc (len + 1);
171 memcpy (value, start, len);
194 while (input [0] == '+')
197 if (input [0] == '\0') {
200 if (input [0] == 'M' && input [1] == ':'){
205 if (input [0] == 'N' && input [1] == ':'){
208 return TOKEN_NAMESPACE;
210 if (input [0] == 'T' && input [1] == ':'){
215 if (input [0] == 'E' && input [1] == ':'){
218 return TOKEN_EXCEPTION;
222 return TOKEN_EXCLUDE;
224 if (is_filenamechar (*input)){
226 if (strcmp (value, "all") == 0)
228 if (strcmp (value, "program") == 0)
229 return TOKEN_PROGRAM;
230 if (strcmp (value, "wrapper") == 0)
231 return TOKEN_WRAPPER;
232 if (strcmp (value, "disabled") == 0)
233 return TOKEN_DISABLED;
238 return TOKEN_SEPARATOR;
241 fprintf (stderr, "Syntax error at or around '%s'\n", input);
255 int token = get_token ();
256 if (token == TOKEN_EXCLUDE){
257 token = get_spec (last);
258 if (token == TOKEN_EXCLUDE){
259 fprintf (stderr, "Expecting an expression");
262 if (token == TOKEN_ERROR)
264 trace_spec.ops [(*last)-1].exclude = 1;
265 return TOKEN_SEPARATOR;
267 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
270 if (token == TOKEN_METHOD){
271 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
273 fprintf (stderr, "Invalid method name: %s\n", value);
276 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
277 trace_spec.ops [*last].data = desc;
278 } else if (token == TOKEN_ALL)
279 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
280 else if (token == TOKEN_PROGRAM)
281 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
282 else if (token == TOKEN_WRAPPER)
283 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
284 else if (token == TOKEN_NAMESPACE){
285 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
286 trace_spec.ops [*last].data = g_strdup (value);
287 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
288 char *p = strrchr (value, '.');
291 trace_spec.ops [*last].data = g_strdup (value);
292 trace_spec.ops [*last].data2 = g_strdup (p);
295 trace_spec.ops [*last].data = g_strdup ("");
296 trace_spec.ops [*last].data2 = g_strdup (value);
298 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
299 } else if (token == TOKEN_STRING){
300 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
301 trace_spec.ops [*last].data = g_strdup (value);
302 } else if (token == TOKEN_DISABLED) {
303 trace_spec.enabled = FALSE;
305 fprintf (stderr, "Syntax error in trace option specification\n");
309 return TOKEN_SEPARATOR;
313 mono_trace_parse_options (const char *options)
315 char *p = (char*)options;
320 trace_spec.enabled = TRUE;
323 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
324 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
328 for (p = (char*)options; *p != 0; p++)
332 trace_spec.ops = g_new0 (MonoTraceOperation, size);
334 input = (char*)options;
337 while ((token = (get_spec (&last_used))) != TOKEN_END){
338 if (token == TOKEN_ERROR)
340 if (token == TOKEN_SEPARATOR)
343 trace_spec.len = last_used;
349 mono_trace_set_assembly (MonoAssembly *assembly)
351 trace_spec.assembly = assembly;
355 #ifdef HAVE_KW_THREAD
358 int indent_level = 0;
359 static guint64 start_time = 0;
361 static double seconds_since_start (void)
363 guint64 diff = mono_100ns_ticks () - start_time;
364 return diff/10000000.0;
367 static void indent (int diff) {
369 indent_level += diff;
371 start_time = mono_100ns_ticks ();
372 printf ("[%p: %.5f %d] ", (void*)mono_native_thread_id_get (), seconds_since_start (), indent_level);
374 indent_level += diff;
378 string_to_utf8 (MonoString *s)
381 GError *error = NULL;
386 return g_strdup ("");
388 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
390 /* Happens with StringBuilders */
391 g_error_free (error);
392 return g_strdup ("<INVALID UTF8>");
399 * cpos (ebp + arg_info[n].offset) points to the beginning of the
400 * stack slot for this argument. On little-endian systems, we can
401 * simply dereference it. On big-endian systems, we need to adjust
402 * cpos upward first if the datatype we're referencing is smaller than
403 * a stack slot. Also - one can't assume that gpointer is also the
404 * size of a stack slot - use SIZEOF_REGISTER instead. The following
405 * helper macro tries to keep down the mess of all the pointer
408 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
409 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
411 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
415 mono_trace_enter_method (MonoMethod *method, char *ebp)
420 MonoJitArgumentInfo *arg_info;
421 MonoMethodSignature *sig;
423 MonoGenericSharingContext *gsctx = NULL;
425 if (!trace_spec.enabled)
428 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
429 mono_thread_info_yield ();
431 fname = mono_method_full_name (method, TRUE);
433 printf ("ENTER: %s(", fname);
437 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
441 sig = mono_method_signature (method);
443 arg_info = (MonoJitArgumentInfo *)alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
445 if (method->is_inflated) {
446 /* FIXME: Might be better to pass the ji itself */
447 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
449 gsctx = mono_jit_info_get_generic_sharing_context (ji);
450 if (gsctx && gsctx->is_gsharedvt) {
451 /* Needs a ctx to get precise method */
452 printf (") <gsharedvt>\n");
458 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
460 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
461 g_assert (!mono_method_signature (method)->ret->byref);
463 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
466 if (mono_method_signature (method)->hasthis) {
467 gpointer *this_obj = (gpointer *)(ebp + arg_info [0].offset);
468 if (method->klass->valuetype) {
469 printf ("value:%p, ", *arg_in_stack_slot(this_obj, gpointer *));
471 o = *arg_in_stack_slot(this_obj, MonoObject *);
474 klass = o->vtable->klass;
476 if (klass == mono_defaults.string_class) {
477 MonoString *s = (MonoString*)o;
478 char *as = string_to_utf8 (s);
480 printf ("this:[STRING:%p:%s], ", o, as);
483 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
486 printf ("this:NULL, ");
490 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
491 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
492 int size = arg_info [i + 1].size;
494 MonoType *type = mono_method_signature (method)->params [i];
497 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
498 } else switch (mini_get_underlying_type (type)->type) {
502 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
504 case MONO_TYPE_BOOLEAN:
508 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
512 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
516 printf ("%d, ", *arg_in_stack_slot(cpos, int));
518 case MONO_TYPE_STRING: {
519 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
523 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
524 as = string_to_utf8 (s);
526 printf ("[STRING:%p:%s], ", s, as);
529 printf ("[STRING:null], ");
532 case MONO_TYPE_CLASS:
533 case MONO_TYPE_OBJECT: {
534 o = *arg_in_stack_slot(cpos, MonoObject *);
536 klass = o->vtable->klass;
538 if (klass == mono_defaults.string_class) {
539 char *as = string_to_utf8 ((MonoString*)o);
541 printf ("[STRING:%p:%s], ", o, as);
543 } else if (klass == mono_defaults.int32_class) {
544 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
545 } else if (klass == mono_defaults.runtimetype_class) {
546 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
548 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
550 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
555 case MONO_TYPE_FNPTR:
556 case MONO_TYPE_ARRAY:
557 case MONO_TYPE_SZARRAY:
558 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
562 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
565 printf ("%f, ", *arg_in_stack_slot(cpos, float));
568 printf ("%f, ", *arg_in_stack_slot(cpos, double));
570 case MONO_TYPE_VALUETYPE:
572 for (j = 0; j < size; j++)
573 printf ("%02x,", *((guint8*)cpos +j));
585 mono_atomic_store_release (&output_lock, 0);
589 mono_trace_leave_method (MonoMethod *method, ...)
594 MonoGenericSharingContext *gsctx;
596 if (!trace_spec.enabled)
599 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
600 mono_thread_info_yield ();
602 va_start(ap, method);
604 fname = mono_method_full_name (method, TRUE);
606 printf ("LEAVE: %s", fname);
609 if (method->is_inflated) {
610 /* FIXME: Might be better to pass the ji itself */
611 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
613 gsctx = mono_jit_info_get_generic_sharing_context (ji);
614 if (gsctx && gsctx->is_gsharedvt) {
615 /* Needs a ctx to get precise method */
616 printf (") <gsharedvt>\n");
622 type = mini_get_underlying_type (mono_method_signature (method)->ret);
624 switch (type->type) {
627 case MONO_TYPE_BOOLEAN: {
628 int eax = va_arg (ap, int);
630 printf ("TRUE:%d", eax);
645 int eax = va_arg (ap, int);
646 printf ("result=%d", eax);
649 case MONO_TYPE_STRING: {
650 MonoString *s = va_arg (ap, MonoString *);
655 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
656 as = string_to_utf8 (s);
657 printf ("[STRING:%p:%s]", s, as);
660 printf ("[STRING:null], ");
663 case MONO_TYPE_CLASS:
664 case MONO_TYPE_OBJECT: {
665 MonoObject *o = va_arg (ap, MonoObject *);
668 if (o->vtable->klass == mono_defaults.boolean_class) {
669 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
670 } else if (o->vtable->klass == mono_defaults.int32_class) {
671 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
672 } else if (o->vtable->klass == mono_defaults.int64_class) {
673 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
675 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
677 printf ("[OBJECT:%p]", o);
682 case MONO_TYPE_FNPTR:
683 case MONO_TYPE_ARRAY:
684 case MONO_TYPE_SZARRAY: {
685 gpointer p = va_arg (ap, gpointer);
686 printf ("result=%p", p);
690 gint64 l = va_arg (ap, gint64);
691 printf ("lresult=0x%16llx", (long long)l);
695 gint64 l = va_arg (ap, gint64);
696 printf ("lresult=0x%16llx", (long long)l);
701 double f = va_arg (ap, double);
705 case MONO_TYPE_VALUETYPE: {
706 guint8 *p = (guint8 *)va_arg (ap, gpointer);
708 size = mono_type_size (type, &align);
710 for (j = 0; p && j < size; j++)
711 printf ("%02x,", p [j]);
716 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
719 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
724 mono_atomic_store_release (&output_lock, 0);
728 mono_trace_enable (gboolean enable)
730 trace_spec.enabled = enable;
734 mono_trace_is_enabled ()
736 return trace_spec.enabled;