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__)
36 static MonoTraceSpec trace_spec;
38 static volatile gint32 output_lock = 0;
41 mono_trace_eval_exception (MonoClass *klass)
49 for (i = 0; i < trace_spec.len; i++) {
50 MonoTraceOperation *op = &trace_spec.ops [i];
54 case MONO_TRACEOP_EXCEPTION:
55 if (strcmp ("", op->data) == 0 && strcmp ("all", op->data2) == 0)
57 else if (strcmp ("", op->data) == 0 || strcmp (klass->name_space, op->data) == 0)
58 if (strcmp (klass->name, op->data2) == 0)
75 mono_trace_eval (MonoMethod *method)
80 for (i = 0; i < trace_spec.len; i++){
81 MonoTraceOperation *op = &trace_spec.ops [i];
85 case MONO_TRACEOP_ALL:
88 case MONO_TRACEOP_PROGRAM:
89 if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
92 case MONO_TRACEOP_WRAPPER:
93 if ((method->wrapper_type == MONO_WRAPPER_NATIVE_TO_MANAGED) ||
94 (method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE))
97 case MONO_TRACEOP_METHOD:
98 if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
101 case MONO_TRACEOP_CLASS:
102 if (strcmp (method->klass->name_space, op->data) == 0)
103 if (strcmp (method->klass->name, op->data2) == 0)
106 case MONO_TRACEOP_ASSEMBLY:
107 if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
110 case MONO_TRACEOP_NAMESPACE:
111 if (strcmp (method->klass->name_space, op->data) == 0)
114 case MONO_TRACEOP_EXCEPTION:
127 static int is_filenamechar (char p)
129 if (p >= 'A' && p <= 'Z')
131 if (p >= 'a' && p <= 'z')
133 if (p >= '0' && p <= '9')
135 if (p == '.' || p == ':' || p == '_' || p == '-' || p == '`')
143 static void get_string (void)
146 while (is_filenamechar (*input)){
151 size_t len = input - start;
152 value = (char *)g_malloc (len + 1);
153 memcpy (value, start, len);
176 while (input [0] == '+')
179 if (input [0] == '\0') {
182 if (input [0] == 'M' && input [1] == ':'){
187 if (input [0] == 'N' && input [1] == ':'){
190 return TOKEN_NAMESPACE;
192 if (input [0] == 'T' && input [1] == ':'){
197 if (input [0] == 'E' && input [1] == ':'){
200 return TOKEN_EXCEPTION;
204 return TOKEN_EXCLUDE;
206 if (is_filenamechar (*input)){
208 if (strcmp (value, "all") == 0)
210 if (strcmp (value, "program") == 0)
211 return TOKEN_PROGRAM;
212 if (strcmp (value, "wrapper") == 0)
213 return TOKEN_WRAPPER;
214 if (strcmp (value, "disabled") == 0)
215 return TOKEN_DISABLED;
220 return TOKEN_SEPARATOR;
223 fprintf (stderr, "Syntax error at or around '%s'\n", input);
237 int token = get_token ();
238 if (token == TOKEN_EXCLUDE){
239 token = get_spec (last);
240 if (token == TOKEN_EXCLUDE){
241 fprintf (stderr, "Expecting an expression");
244 if (token == TOKEN_ERROR)
246 trace_spec.ops [(*last)-1].exclude = 1;
247 return TOKEN_SEPARATOR;
249 if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
252 if (token == TOKEN_METHOD){
253 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
255 fprintf (stderr, "Invalid method name: %s\n", value);
258 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
259 trace_spec.ops [*last].data = desc;
260 } else if (token == TOKEN_ALL)
261 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
262 else if (token == TOKEN_PROGRAM)
263 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
264 else if (token == TOKEN_WRAPPER)
265 trace_spec.ops [*last].op = MONO_TRACEOP_WRAPPER;
266 else if (token == TOKEN_NAMESPACE){
267 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
268 trace_spec.ops [*last].data = g_strdup (value);
269 } else if (token == TOKEN_CLASS || token == TOKEN_EXCEPTION){
270 char *p = strrchr (value, '.');
273 trace_spec.ops [*last].data = g_strdup (value);
274 trace_spec.ops [*last].data2 = g_strdup (p);
277 trace_spec.ops [*last].data = g_strdup ("");
278 trace_spec.ops [*last].data2 = g_strdup (value);
280 trace_spec.ops [*last].op = token == TOKEN_CLASS ? MONO_TRACEOP_CLASS : MONO_TRACEOP_EXCEPTION;
281 } else if (token == TOKEN_STRING){
282 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
283 trace_spec.ops [*last].data = g_strdup (value);
284 } else if (token == TOKEN_DISABLED) {
285 trace_spec.enabled = FALSE;
287 fprintf (stderr, "Syntax error in trace option specification\n");
291 return TOKEN_SEPARATOR;
295 mono_trace_parse_options (const char *options)
297 char *p = (char*)options;
302 trace_spec.enabled = TRUE;
305 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
306 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
310 for (p = (char*)options; *p != 0; p++)
314 trace_spec.ops = g_new0 (MonoTraceOperation, size);
316 input = (char*)options;
319 while ((token = (get_spec (&last_used))) != TOKEN_END){
320 if (token == TOKEN_ERROR)
322 if (token == TOKEN_SEPARATOR)
325 trace_spec.len = last_used;
331 mono_trace_set_assembly (MonoAssembly *assembly)
333 trace_spec.assembly = assembly;
337 #ifdef HAVE_KW_THREAD
340 int indent_level = 0;
341 static guint64 start_time = 0;
343 static double seconds_since_start (void)
345 guint64 diff = mono_100ns_ticks () - start_time;
346 return diff/10000000.0;
349 static void indent (int diff) {
351 indent_level += diff;
353 start_time = mono_100ns_ticks ();
354 printf ("[%p: %.5f %d] ", (void*)mono_native_thread_id_get (), seconds_since_start (), indent_level);
356 indent_level += diff;
360 string_to_utf8 (MonoString *s)
363 GError *error = NULL;
368 return g_strdup ("");
370 as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
372 /* Happens with StringBuilders */
373 g_error_free (error);
374 return g_strdup ("<INVALID UTF8>");
381 * cpos (ebp + arg_info[n].offset) points to the beginning of the
382 * stack slot for this argument. On little-endian systems, we can
383 * simply dereference it. On big-endian systems, we need to adjust
384 * cpos upward first if the datatype we're referencing is smaller than
385 * a stack slot. Also - one can't assume that gpointer is also the
386 * size of a stack slot - use SIZEOF_REGISTER instead. The following
387 * helper macro tries to keep down the mess of all the pointer
390 #if (G_BYTE_ORDER == G_LITTLE_ENDIAN)
391 #define arg_in_stack_slot(cpos, type) ((type *)(cpos))
393 #define arg_in_stack_slot(cpos, type) ((type *)((sizeof(type) < SIZEOF_REGISTER) ? (((gssize)(cpos)) + SIZEOF_REGISTER - sizeof(type)) : (gssize)(cpos)))
397 mono_trace_enter_method (MonoMethod *method, char *ebp)
402 MonoJitArgumentInfo *arg_info;
403 MonoMethodSignature *sig;
405 MonoGenericSharingContext *gsctx = NULL;
407 if (!trace_spec.enabled)
410 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
411 mono_thread_info_yield ();
413 fname = mono_method_full_name (method, TRUE);
415 printf ("ENTER: %s(", fname);
419 printf (") ip: %p\n", MONO_RETURN_ADDRESS_N (1));
423 sig = mono_method_signature (method);
425 arg_info = (MonoJitArgumentInfo *)alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
427 if (method->is_inflated) {
428 /* FIXME: Might be better to pass the ji itself */
429 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)MONO_RETURN_ADDRESS (), NULL);
431 gsctx = mono_jit_info_get_generic_sharing_context (ji);
432 if (gsctx && gsctx->is_gsharedvt) {
433 /* Needs a ctx to get precise method */
434 printf (") <gsharedvt>\n");
440 mono_arch_get_argument_info (sig, sig->param_count, arg_info);
442 if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
443 g_assert (!mono_method_signature (method)->ret->byref);
445 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
448 if (mono_method_signature (method)->hasthis) {
449 gpointer *this_obj = (gpointer *)(ebp + arg_info [0].offset);
450 if (method->klass->valuetype) {
451 printf ("value:%p, ", *arg_in_stack_slot(this_obj, gpointer *));
453 o = *arg_in_stack_slot(this_obj, MonoObject *);
456 klass = o->vtable->klass;
458 if (klass == mono_defaults.string_class) {
459 MonoString *s = (MonoString*)o;
460 char *as = string_to_utf8 (s);
462 printf ("this:[STRING:%p:%s], ", o, as);
465 printf ("this:%p[%s.%s %s], ", o, klass->name_space, klass->name, o->vtable->domain->friendly_name);
468 printf ("this:NULL, ");
472 for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
473 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
474 int size = arg_info [i + 1].size;
476 MonoType *type = mono_method_signature (method)->params [i];
479 printf ("[BYREF:%p], ", *arg_in_stack_slot(cpos, gpointer *));
480 } else switch (mini_get_underlying_type (type)->type) {
484 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer *));
486 case MONO_TYPE_BOOLEAN:
490 printf ("%d, ", *arg_in_stack_slot(cpos, gint8));
494 printf ("%d, ", *arg_in_stack_slot(cpos, gint16));
498 printf ("%d, ", *arg_in_stack_slot(cpos, int));
500 case MONO_TYPE_STRING: {
501 MonoString *s = *arg_in_stack_slot(cpos, MonoString *);
505 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
506 as = string_to_utf8 (s);
508 printf ("[STRING:%p:%s], ", s, as);
511 printf ("[STRING:null], ");
514 case MONO_TYPE_CLASS:
515 case MONO_TYPE_OBJECT: {
516 o = *arg_in_stack_slot(cpos, MonoObject *);
518 klass = o->vtable->klass;
520 if (klass == mono_defaults.string_class) {
521 char *as = string_to_utf8 ((MonoString*)o);
523 printf ("[STRING:%p:%s], ", o, as);
525 } else if (klass == mono_defaults.int32_class) {
526 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
527 } else if (klass == mono_defaults.runtimetype_class) {
528 printf ("[TYPE:%s], ", mono_type_full_name (((MonoReflectionType*)o)->type));
530 printf ("[%s.%s:%p], ", klass->name_space, klass->name, o);
532 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
537 case MONO_TYPE_FNPTR:
538 case MONO_TYPE_ARRAY:
539 case MONO_TYPE_SZARRAY:
540 printf ("%p, ", *arg_in_stack_slot(cpos, gpointer));
544 printf ("0x%016llx, ", (long long)*arg_in_stack_slot(cpos, gint64));
547 printf ("%f, ", *arg_in_stack_slot(cpos, float));
550 printf ("%f, ", *arg_in_stack_slot(cpos, double));
552 case MONO_TYPE_VALUETYPE:
554 for (j = 0; j < size; j++)
555 printf ("%02x,", *((guint8*)cpos +j));
567 mono_atomic_store_release (&output_lock, 0);
571 mono_trace_leave_method (MonoMethod *method, ...)
576 MonoGenericSharingContext *gsctx;
578 if (!trace_spec.enabled)
581 while (output_lock != 0 || InterlockedCompareExchange (&output_lock, 1, 0) != 0)
582 mono_thread_info_yield ();
584 va_start(ap, method);
586 fname = mono_method_full_name (method, TRUE);
588 printf ("LEAVE: %s", fname);
591 if (method->is_inflated) {
592 /* FIXME: Might be better to pass the ji itself */
593 MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (char *)MONO_RETURN_ADDRESS (), NULL);
595 gsctx = mono_jit_info_get_generic_sharing_context (ji);
596 if (gsctx && gsctx->is_gsharedvt) {
597 /* Needs a ctx to get precise method */
598 printf (") <gsharedvt>\n");
604 type = mini_get_underlying_type (mono_method_signature (method)->ret);
606 switch (type->type) {
609 case MONO_TYPE_BOOLEAN: {
610 int eax = va_arg (ap, int);
612 printf ("TRUE:%d", eax);
627 int eax = va_arg (ap, int);
628 printf ("result=%d", eax);
631 case MONO_TYPE_STRING: {
632 MonoString *s = va_arg (ap, MonoString *);
637 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
638 as = string_to_utf8 (s);
639 printf ("[STRING:%p:%s]", s, as);
642 printf ("[STRING:null], ");
645 case MONO_TYPE_CLASS:
646 case MONO_TYPE_OBJECT: {
647 MonoObject *o = va_arg (ap, MonoObject *);
650 if (o->vtable->klass == mono_defaults.boolean_class) {
651 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
652 } else if (o->vtable->klass == mono_defaults.int32_class) {
653 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
654 } else if (o->vtable->klass == mono_defaults.int64_class) {
655 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
657 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
659 printf ("[OBJECT:%p]", o);
664 case MONO_TYPE_FNPTR:
665 case MONO_TYPE_ARRAY:
666 case MONO_TYPE_SZARRAY: {
667 gpointer p = va_arg (ap, gpointer);
668 printf ("result=%p", p);
672 gint64 l = va_arg (ap, gint64);
673 printf ("lresult=0x%16llx", (long long)l);
677 gint64 l = va_arg (ap, gint64);
678 printf ("lresult=0x%16llx", (long long)l);
683 double f = va_arg (ap, double);
687 case MONO_TYPE_VALUETYPE: {
688 guint8 *p = (guint8 *)va_arg (ap, gpointer);
690 size = mono_type_size (type, &align);
692 for (j = 0; p && j < size; j++)
693 printf ("%02x,", p [j]);
698 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
701 //printf (" ip: %p\n", MONO_RETURN_ADDRESS_N (1));
706 mono_atomic_store_release (&output_lock, 0);
710 mono_trace_enable (gboolean enable)
712 trace_spec.enabled = enable;
716 mono_trace_is_enabled ()
718 return trace_spec.enabled;