3 * Tracing facilities for the Mono Runtime.
6 * Paolo Molaro (lupus@ximian.com)
7 * Dietmar Maurer (dietmar@ximian.com)
9 * (C) 2002 Ximian, Inc.
10 * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
11 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
23 #include <mono/metadata/debug-helpers.h>
24 #include <mono/metadata/assembly.h>
25 #include <mono/utils/mono-time.h>
26 #include <mono/utils/mono-memory-model.h>
29 #if defined (HOST_ANDROID) || (defined (TARGET_IOS) && defined (TARGET_IOS))
31 # define printf(...) g_log("mono", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
33 # define fprintf(__ignore, ...) g_log ("mono-gc", G_LOG_LEVEL_MESSAGE, __VA_ARGS__)
38 #define RETURN_ADDRESS_N(N) (__builtin_extract_return_addr (__builtin_return_address (N)))
39 #define RETURN_ADDRESS() RETURN_ADDRESS_N(0)
41 #elif defined(_MSC_VER)
44 #pragma intrinsic(_ReturnAddress)
46 #define RETURN_ADDRESS() _ReturnAddress()
47 #define RETURN_ADDRESS_N(N) NULL
51 #error "Missing return address intrinsics implementation"
55 static MonoTraceSpec trace_spec;
57 static volatile gint32 output_lock = 0;
60 mono_trace_eval_exception (MonoClass *klass)
68 for (i = 0; i < trace_spec.len; i++) {
69 MonoTraceOperation *op = &trace_spec.ops [i];
73 case MONO_TRACEOP_EXCEPTION:
74 if (strcmp ("", op->data) == 0 && strcmp ("all", op->data2) == 0)
76 else if (strcmp ("", op->data) == 0 || strcmp (klass->name_space, op->data) == 0)
77 if (strcmp (klass->name, op->data2) == 0)
94 mono_trace_eval (MonoMethod *method)
99 for (i = 0; i < trace_spec.len; i++){
100 MonoTraceOperation *op = &trace_spec.ops [i];
104 case MONO_TRACEOP_ALL:
107 case MONO_TRACEOP_PROGRAM:
108 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
111 case MONO_TRACEOP_WRAPPER:
112 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
113 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
116 case MONO_TRACEOP_METHOD:
117 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
120 case MONO_TRACEOP_CLASS:
121 if (strcmp (method->klass->name_space, op->data) == 0)
122 if (strcmp (method->klass->name, op->data2) == 0)
125 case MONO_TRACEOP_ASSEMBLY:
126 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
129 case MONO_TRACEOP_NAMESPACE:
130 if (strcmp (method->klass->name_space, op->data) == 0)
133 case MONO_TRACEOP_EXCEPTION:
146 static int is_filenamechar (char p)
148 if (p >= 'A' && p <= 'Z')
150 if (p >= 'a' && p <= 'z')
152 if (p >= '0' && p <= '9')
154 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
162 static void get_string (void)
165 while (is_filenamechar (*input)){
170 size_t len = input - start;
171 value = (char *)g_malloc (len + 1);
172 memcpy (value, start, len);
195 while (input [0] == '+')
198 if (input [0] == '\0') {
201 if (input [0] == 'M' && input [1] == ':'){
206 if (input [0] == 'N' && input [1] == ':'){
209 return TOKEN_NAMESPACE;
211 if (input [0] == 'T' && input [1] == ':'){
216 if (input [0] == 'E' && input [1] == ':'){
219 return TOKEN_EXCEPTION;
223 return TOKEN_EXCLUDE;
225 if (is_filenamechar (*input)){
227 if (strcmp (value, "all") == 0)
229 if (strcmp (value, "program") == 0)
230 return TOKEN_PROGRAM;
231 if (strcmp (value, "wrapper") == 0)
232 return TOKEN_WRAPPER;
233 if (strcmp (value, "disabled") == 0)
234 return TOKEN_DISABLED;
239 return TOKEN_SEPARATOR;
242 fprintf (stderr, "Syntax error at or around '%s'\n", input);
256 int token = get_token ();
257 if (token == TOKEN_EXCLUDE){
258 token = get_spec (last);
259 if (token == TOKEN_EXCLUDE){
260 fprintf (stderr, "Expecting an expression");
263 if (token == TOKEN_ERROR)
265 trace_spec.ops [(*last)-1].exclude = 1;
266 return TOKEN_SEPARATOR;
268 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
271 if (token == TOKEN_METHOD){
272 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
274 fprintf (stderr, "Invalid method name: %s\n", value);
277 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
278 trace_spec.ops [*last].data = desc;
279 } else if (token == TOKEN_ALL)
280 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
281 else if (token == TOKEN_PROGRAM)
282 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
283 else if (token == TOKEN_WRAPPER)
284 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
285 else if (token == TOKEN_NAMESPACE){
286 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
287 trace_spec.ops [*last].data = g_strdup (value);
288 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
289 char *p = strrchr (value, '.');
292 trace_spec.ops [*last].data = g_strdup (value);
293 trace_spec.ops [*last].data2 = g_strdup (p);
296 trace_spec.ops [*last].data = g_strdup ("");
297 trace_spec.ops [*last].data2 = g_strdup (value);
299 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
300 } else if (token == TOKEN_STRING){
301 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
302 trace_spec.ops [*last].data = g_strdup (value);
303 } else if (token == TOKEN_DISABLED) {
304 trace_spec.enabled = FALSE;
306 fprintf (stderr, "Syntax error in trace option specification\n");
310 return TOKEN_SEPARATOR;
314 mono_trace_parse_options (const char *options)
316 char *p = (char*)options;
321 trace_spec.enabled = TRUE;
324 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
325 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
329 for (p = (char*)options; *p != 0; p++)
333 trace_spec.ops = g_new0 (MonoTraceOperation, size);
335 input = (char*)options;
338 while ((token = (get_spec (&last_used))) != TOKEN_END){
339 if (token == TOKEN_ERROR)
341 if (token == TOKEN_SEPARATOR)
344 trace_spec.len = last_used;
350 mono_trace_set_assembly (MonoAssembly *assembly)
352 trace_spec.assembly = assembly;
356 #ifdef HAVE_KW_THREAD
359 int indent_level = 0;
360 static guint64 start_time = 0;
362 static double seconds_since_start (void)
364 guint64 diff = mono_100ns_ticks () - start_time;
365 return diff/10000000.0;
368 static void indent (int diff) {
370 indent_level += diff;
372 start_time = mono_100ns_ticks ();
373 printf ("[%p: %.5f %d] ", (void*)mono_native_thread_id_get (), seconds_since_start (), indent_level);
375 indent_level += diff;
379 string_to_utf8 (MonoString *s)
382 GError *error = NULL;
387 return g_strdup ("");
389 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
391 /* Happens with StringBuilders */
392 g_error_free (error);
393 return g_strdup ("<INVALID UTF8>");
400 * cpos (ebp + arg_info[n].offset) points to the beginning of the
401 * stack slot for this argument. On little-endian systems, we can
402 * simply dereference it. On big-endian systems, we need to adjust
403 * cpos upward first if the datatype we're referencing is smaller than
404 * a stack slot. Also - one can't assume that gpointer is also the
405 * size of a stack slot - use SIZEOF_REGISTER instead. The following
406 * helper macro tries to keep down the mess of all the pointer
409 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
410 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
412 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
416 mono_trace_enter_method (MonoMethod *method, char *ebp)
421 MonoJitArgumentInfo *arg_info;
422 MonoMethodSignature *sig;
424 MonoGenericSharingContext *gsctx = NULL;
426 if (!trace_spec.enabled)
429 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
430 mono_thread_info_yield ();
432 fname = mono_method_full_name (method, TRUE);
434 printf ("ENTER: %s(", fname);
438 printf (") ip: %p\n", RETURN_ADDRESS_N (1));
442 sig = mono_method_signature (method);
444 arg_info = (MonoJitArgumentInfo *)alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
446 if (method->is_inflated) {
447 /* FIXME: Might be better to pass the ji itself */
448 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
450 gsctx = mono_jit_info_get_generic_sharing_context (ji);
451 if (gsctx && gsctx->is_gsharedvt) {
452 /* Needs a ctx to get precise method */
453 printf (") <gsharedvt>\n");
459 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
461 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
462 g_assert (!mono_method_signature (method)->ret->byref);
464 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
467 if (mono_method_signature (method)->hasthis) {
468 gpointer *this_obj = (gpointer *)(ebp + arg_info [0].offset);
469 if (method->klass->valuetype) {
470 printf ("value:%p, ", *arg_in_stack_slot(this_obj, gpointer *));
472 o = *arg_in_stack_slot(this_obj, MonoObject *);
475 klass = o->vtable->klass;
477 if (klass == mono_defaults.string_class) {
478 MonoString *s = (MonoString*)o;
479 char *as = string_to_utf8 (s);
481 printf ("this:[STRING:%p:%s], ", o, as);
484 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
487 printf ("this:NULL, ");
491 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
492 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
493 int size = arg_info [i + 1].size;
495 MonoType *type = mono_method_signature (method)->params [i];
498 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
499 } else switch (mini_get_underlying_type (type)->type) {
503 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
505 case MONO_TYPE_BOOLEAN:
509 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
513 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
517 printf ("%d, ", *arg_in_stack_slot(cpos, int));
519 case MONO_TYPE_STRING: {
520 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
524 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
525 as = string_to_utf8 (s);
527 printf ("[STRING:%p:%s], ", s, as);
530 printf ("[STRING:null], ");
533 case MONO_TYPE_CLASS:
534 case MONO_TYPE_OBJECT: {
535 o = *arg_in_stack_slot(cpos, MonoObject *);
537 klass = o->vtable->klass;
539 if (klass == mono_defaults.string_class) {
540 char *as = string_to_utf8 ((MonoString*)o);
542 printf ("[STRING:%p:%s], ", o, as);
544 } else if (klass == mono_defaults.int32_class) {
545 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
546 } else if (klass == mono_defaults.runtimetype_class) {
547 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
549 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
551 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
556 case MONO_TYPE_FNPTR:
557 case MONO_TYPE_ARRAY:
558 case MONO_TYPE_SZARRAY:
559 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
563 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
566 printf ("%f, ", *arg_in_stack_slot(cpos, float));
569 printf ("%f, ", *arg_in_stack_slot(cpos, double));
571 case MONO_TYPE_VALUETYPE:
573 for (j = 0; j < size; j++)
574 printf ("%02x,", *((guint8*)cpos +j));
586 mono_atomic_store_release (&output_lock, 0);
590 mono_trace_leave_method (MonoMethod *method, ...)
595 MonoGenericSharingContext *gsctx;
597 if (!trace_spec.enabled)
600 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
601 mono_thread_info_yield ();
603 va_start(ap, method);
605 fname = mono_method_full_name (method, TRUE);
607 printf ("LEAVE: %s", fname);
610 if (method->is_inflated) {
611 /* FIXME: Might be better to pass the ji itself */
612 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)RETURN_ADDRESS (), NULL);
614 gsctx = mono_jit_info_get_generic_sharing_context (ji);
615 if (gsctx && gsctx->is_gsharedvt) {
616 /* Needs a ctx to get precise method */
617 printf (") <gsharedvt>\n");
623 type = mini_get_underlying_type (mono_method_signature (method)->ret);
625 switch (type->type) {
628 case MONO_TYPE_BOOLEAN: {
629 int eax = va_arg (ap, int);
631 printf ("TRUE:%d", eax);
646 int eax = va_arg (ap, int);
647 printf ("result=%d", eax);
650 case MONO_TYPE_STRING: {
651 MonoString *s = va_arg (ap, MonoString *);
656 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
657 as = string_to_utf8 (s);
658 printf ("[STRING:%p:%s]", s, as);
661 printf ("[STRING:null], ");
664 case MONO_TYPE_CLASS:
665 case MONO_TYPE_OBJECT: {
666 MonoObject *o = va_arg (ap, MonoObject *);
669 if (o->vtable->klass == mono_defaults.boolean_class) {
670 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
671 } else if (o->vtable->klass == mono_defaults.int32_class) {
672 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
673 } else if (o->vtable->klass == mono_defaults.int64_class) {
674 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
676 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
678 printf ("[OBJECT:%p]", o);
683 case MONO_TYPE_FNPTR:
684 case MONO_TYPE_ARRAY:
685 case MONO_TYPE_SZARRAY: {
686 gpointer p = va_arg (ap, gpointer);
687 printf ("result=%p", p);
691 gint64 l = va_arg (ap, gint64);
692 printf ("lresult=0x%16llx", (long long)l);
696 gint64 l = va_arg (ap, gint64);
697 printf ("lresult=0x%16llx", (long long)l);
702 double f = va_arg (ap, double);
706 case MONO_TYPE_VALUETYPE: {
707 guint8 *p = (guint8 *)va_arg (ap, gpointer);
709 size = mono_type_size (type, &align);
711 for (j = 0; p && j < size; j++)
712 printf ("%02x,", p [j]);
717 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
720 //printf (" ip: %p\n", RETURN_ADDRESS_N (1));
725 mono_atomic_store_release (&output_lock, 0);
729 mono_trace_enable (gboolean enable)
731 trace_spec.enabled = enable;
735 mono_trace_is_enabled ()
737 return trace_spec.enabled;