mono/mini/trace.c

   1 /*
   2  * trace.c: Tracing facilities for the Mono Runtime.
   3  *
   4  * Author:
   5  *   Paolo Molaro (lupus@ximian.com)
   6  *   Dietmar Maurer (dietmar@ximian.com)
   7  *
   8  * (C) 2002 Ximian, Inc.
   9  */
  10
  11 #include <config.h>
  12 #include <signal.h>
  13 #include <unistd.h>
  14 #include <string.h>
  15 #include "mini.h"
  16 #include <mono/metadata/debug-helpers.h>
  17 #include <mono/metadata/assembly.h>
  18 #include "trace.h"
  19
  20 static MonoTraceSpec trace_spec;
  21
  22 gboolean
  23 mono_trace_eval (MonoMethod *method)
  24 {
  25         int include = 0;
  26         int i;
  27
  28         for (i = 0; i < trace_spec.len; i++){
  29                 MonoTraceOperation *op = &trace_spec.ops [i];
  30                 int inc = 0;
  31
  32                 switch (op->op){
  33                 case MONO_TRACEOP_ALL:
  34                         inc = 1; break;
  35                 case MONO_TRACEOP_PROGRAM:
  36                         if (trace_spec.assembly && (method->klass->image == mono_assembly_get_image (trace_spec.assembly)))
  37                                 inc = 1; break;
  38                 case MONO_TRACEOP_METHOD:
  39                         if (mono_method_desc_full_match ((MonoMethodDesc *) op->data, method))
  40                                 inc = 1; break;
  41                 case MONO_TRACEOP_CLASS:
  42                         if (strcmp (method->klass->name_space, op->data) == 0)
  43                                 if (strcmp (method->klass->name, op->data2) == 0)
  44                                         inc = 1;
  45                         break;
  46                 case MONO_TRACEOP_ASSEMBLY:
  47                         if (strcmp (mono_image_get_name (method->klass->image), op->data) == 0)
  48                                 inc = 1; break;
  49                 case MONO_TRACEOP_NAMESPACE:
  50                         if (strcmp (method->klass->name_space, op->data) == 0)
  51                                 inc = 1;
  52                 }
  53                 if (op->exclude){
  54                         if (inc)
  55                                 include = 0;
  56                 } else if (inc)
  57                         include = 1;
  58         }
  59         return include;
  60 }
  61
  62 static int is_filenamechar (char p)
  63 {
  64         if (p >= 'A' && p <= 'Z')
  65                 return TRUE;
  66         if (p >= 'a' && p <= 'z')
  67                 return TRUE;
  68         if (p >= '0' && p <= '9')
  69                 return TRUE;
  70         if (p == '.' || p == ':' || p == '_')
  71                 return TRUE;
  72         return FALSE;
  73 }
  74
  75 static char *input;
  76 static char *value;
  77
  78 static void get_string (void)
  79 {
  80         char *start = input;
  81         while (is_filenamechar (*input)){
  82                 input++;
  83         }
  84         if (value != NULL)
  85                 g_free (value);
  86         value = g_malloc (input - start + 1);
  87         strncpy (value, start, input-start);
  88         value [input-start] = 0;
  89 }
  90
  91 enum Token {
  92         TOKEN_METHOD,
  93         TOKEN_CLASS,
  94         TOKEN_ALL,
  95         TOKEN_PROGRAM,
  96         TOKEN_NAMESPACE,
  97         TOKEN_STRING,
  98         TOKEN_EXCLUDE,
  99         TOKEN_DISABLED,
 100         TOKEN_SEPARATOR,
 101         TOKEN_END,
 102         TOKEN_ERROR
 103 };
 104
 105 static int
 106 get_token (void)
 107 {
 108         if (input [0] == '\0') {
 109                 return TOKEN_END;
 110         }
 111         if (input [0] == 'M' && input [1] == ':'){
 112                 input += 2;
 113                 get_string ();
 114                 return TOKEN_METHOD;
 115         }
 116         if (input [0] == 'N' && input [1] == ':'){
 117                 input += 2;
 118                 get_string ();
 119                 return TOKEN_NAMESPACE;
 120         }
 121         if (input [0] == 'T' && input [1] == ':'){
 122                 input += 2;
 123                 get_string ();
 124                 return TOKEN_CLASS;
 125         }
 126         if (is_filenamechar (*input)){
 127                 get_string ();
 128                 if (strcmp (value, "all") == 0)
 129                         return TOKEN_ALL;
 130                 if (strcmp (value, "program") == 0)
 131                         return TOKEN_PROGRAM;
 132                 if (strcmp (value, "disabled") == 0)
 133                         return TOKEN_DISABLED;
 134                 return TOKEN_STRING;
 135         }
 136         if (*input == '-'){
 137                 input++;
 138                 return TOKEN_EXCLUDE;
 139         }
 140         if (*input == ','){
 141                 input++;
 142                 return TOKEN_SEPARATOR;
 143         }
 144
 145         fprintf (stderr, "Syntax error at or around '%s'\n", input);
 146         return TOKEN_ERROR;
 147 }
 148
 149 static void
 150 cleanup (void)
 151 {
 152         if (value != NULL)
 153                 g_free (value);
 154 }
 155
 156 static int
 157 get_spec (int *last)
 158 {
 159         int token = get_token ();
 160         if (token == TOKEN_EXCLUDE){
 161                 token = get_spec (last);
 162                 if (token == TOKEN_EXCLUDE){
 163                         fprintf (stderr, "Expecting an expression");
 164                         return TOKEN_ERROR;
 165                 }
 166                 if (token == TOKEN_ERROR)
 167                         return token;
 168                 trace_spec.ops [(*last)-1].exclude = 1;
 169                 return TOKEN_SEPARATOR;
 170         }
 171         if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
 172                 return token;
 173
 174         if (token == TOKEN_METHOD){
 175                 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
 176                 if (desc == NULL){
 177                         fprintf (stderr, "Invalid method name: %s\n", value);
 178                         return TOKEN_ERROR;
 179                 }
 180                 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
 181                 trace_spec.ops [*last].data = desc;
 182         } else if (token == TOKEN_ALL)
 183                 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
 184         else if (token == TOKEN_PROGRAM)
 185                 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
 186         else if (token == TOKEN_NAMESPACE){
 187                 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
 188                 trace_spec.ops [*last].data = g_strdup (value);
 189         } else if (token == TOKEN_CLASS){
 190                 char *p = strrchr (value, '.');
 191                 if (p) {
 192                         *p++ = 0;
 193                         trace_spec.ops [*last].data = g_strdup (value);
 194                         trace_spec.ops [*last].data2 = g_strdup (p);
 195                 }
 196                 else {
 197                         trace_spec.ops [*last].data = g_strdup ("");
 198                         trace_spec.ops [*last].data2 = g_strdup (value);
 199                 }
 200                 trace_spec.ops [*last].op = MONO_TRACEOP_CLASS;
 201         } else if (token == TOKEN_STRING){
 202                 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
 203                 trace_spec.ops [*last].data = g_strdup (value);
 204         } else if (token == TOKEN_DISABLED) {
 205                 trace_spec.enabled = FALSE;
 206         } else {
 207                 fprintf (stderr, "Syntax error in trace option specification\n");
 208                 return TOKEN_ERROR;
 209         }
 210         (*last)++;
 211         return TOKEN_SEPARATOR;
 212 }
 213
 214 MonoTraceSpec *
 215 mono_trace_parse_options (char *options)
 216 {
 217         char *p = options;
 218         int size = 1;
 219         int last_used;
 220         int token;
 221
 222         trace_spec.enabled = TRUE;
 223         if (*p == 0){
 224                 trace_spec.len = 1;
 225                 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
 226                 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
 227                 return &trace_spec;
 228         }
 229
 230         for (p = options; *p != 0; p++)
 231                 if (*p == ',')
 232                         size++;
 233
 234         trace_spec.ops = g_new0 (MonoTraceOperation, size);
 235
 236         input = options;
 237         last_used = 0;
 238
 239         while ((token = (get_spec (&last_used))) != TOKEN_END){
 240                 if (token == TOKEN_ERROR)
 241                         return NULL;
 242                 if (token == TOKEN_SEPARATOR)
 243                         continue;
 244         }
 245         trace_spec.len = last_used;
 246         cleanup ();
 247         return &trace_spec;
 248 }
 249
 250 void
 251 mono_trace_set_assembly (MonoAssembly *assembly)
 252 {
 253         trace_spec.assembly = assembly;
 254 }
 255
 256 static int indent_level = 0;
 257
 258 static void indent (int diff) {
 259         int v;
 260         if (diff < 0)
 261                 indent_level += diff;
 262         v = indent_level;
 263         while (v-- > 0) {
 264                 printf (". ");
 265         }
 266         if (diff > 0)
 267                 indent_level += diff;
 268 }
 269
 270 static char *
 271 string_to_utf8 (MonoString *s)
 272 {
 273         char *as;
 274         GError *error = NULL;
 275
 276         g_assert (s);
 277
 278         if (!s->length)
 279                 return g_strdup ("");
 280
 281         as = g_utf16_to_utf8 (mono_string_chars (s), s->length, NULL, NULL, &error);
 282         if (error) {
 283                 /* Happens with StringBuilders */
 284                 g_error_free (error);
 285                 return g_strdup ("<INVALID UTF8>");
 286         }
 287         else
 288                 return as;
 289 }
 290
 291 void
 292 mono_trace_enter_method (MonoMethod *method, char *ebp)
 293 {
 294         int i, j;
 295         MonoClass *class;
 296         MonoObject *o;
 297         MonoJitArgumentInfo *arg_info;
 298         MonoMethodSignature *sig;
 299         char *fname;
 300
 301         if (!trace_spec.enabled)
 302                 return;
 303
 304         fname = mono_method_full_name (method, TRUE);
 305         indent (1);
 306         printf ("ENTER: %s(", fname);
 307         g_free (fname);
 308
 309         if (!ebp) {
 310                 printf (") ip: %p\n", __builtin_return_address (1));
 311                 return;
 312         }
 313         if ((GPOINTER_TO_INT (ebp) & (MONO_ARCH_FRAME_ALIGNMENT - 1)) != 0) {
 314                 g_error ("unaligned stack detected (%p)", ebp);
 315         }
 316
 317         sig = mono_method_signature (method);
 318
 319         arg_info = alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
 320
 321         mono_arch_get_argument_info (sig, sig->param_count, arg_info);
 322
 323         if (MONO_TYPE_ISSTRUCT (mono_method_signature (method)->ret)) {
 324                 g_assert (!mono_method_signature (method)->ret->byref);
 325
 326                 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
 327         }
 328
 329         if (mono_method_signature (method)->hasthis) {
 330                 gpointer *this = (gpointer *)(ebp + arg_info [0].offset);
 331                 if (method->klass->valuetype) {
 332                         printf ("value:%p, ", *this);
 333                 } else {
 334                         o = *((MonoObject **)this);
 335
 336                         if (o) {
 337                                 class = o->vtable->klass;
 338
 339                                 if (class == mono_defaults.string_class) {
 340                                         MonoString *s = (MonoString*)o;
 341                                         char *as = string_to_utf8 (s);
 342
 343                                         printf ("this:[STRING:%p:%s], ", o, as);
 344                                         g_free (as);
 345                                 } else {
 346                                         printf ("this:%p[%s.%s %s], ", o, class->name_space, class->name, o->vtable->domain->friendly_name);
 347                                 }
 348                         } else
 349                                 printf ("this:NULL, ");
 350                 }
 351         }
 352
 353         for (i = 0; i < mono_method_signature (method)->param_count; ++i) {
 354                 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
 355                 int size = arg_info [i + 1].size;
 356
 357                 MonoType *type = mono_method_signature (method)->params [i];
 358
 359                 if (type->byref) {
 360                         printf ("[BYREF:%p], ", *cpos);
 361                 } else switch (mono_type_get_underlying_type (type)->type) {
 362
 363                 case MONO_TYPE_I:
 364                 case MONO_TYPE_U:
 365                         printf ("%p, ", *((gpointer **)(cpos)));
 366                         break;
 367                 case MONO_TYPE_BOOLEAN:
 368                 case MONO_TYPE_CHAR:
 369                 case MONO_TYPE_I1:
 370                 case MONO_TYPE_U1:
 371                         printf ("%d, ", *((gint8 *)(cpos)));
 372                         break;
 373                 case MONO_TYPE_I2:
 374                 case MONO_TYPE_U2:
 375                         printf ("%d, ", *((gint16 *)(cpos)));
 376                         break;
 377                 case MONO_TYPE_I4:
 378                 case MONO_TYPE_U4:
 379                         printf ("%d, ", *((int *)(cpos)));
 380                         break;
 381                 case MONO_TYPE_STRING: {
 382                         MonoString *s = *((MonoString **)cpos);
 383                         if (s) {
 384                                 char *as;
 385
 386                                 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
 387                                 as = string_to_utf8 (s);
 388
 389                                 printf ("[STRING:%p:%s], ", s, as);
 390                                 g_free (as);
 391                         } else
 392                                 printf ("[STRING:null], ");
 393                         break;
 394                 }
 395                 case MONO_TYPE_CLASS:
 396                 case MONO_TYPE_OBJECT: {
 397                         o = *((MonoObject **)cpos);
 398                         if (o) {
 399                                 class = o->vtable->klass;
 400
 401                                 if (class == mono_defaults.string_class) {
 402                                         char *as = string_to_utf8 ((MonoString*)o);
 403
 404                                         printf ("[STRING:%p:%s], ", o, as);
 405                                         g_free (as);
 406                                 } else if (class == mono_defaults.int32_class) {
 407                                         printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
 408                                 } else
 409                                         printf ("[%s.%s:%p], ", class->name_space, class->name, o);
 410                         } else {
 411                                 printf ("%p, ", *((gpointer *)(cpos)));
 412                         }
 413                         break;
 414                 }
 415                 case MONO_TYPE_PTR:
 416                 case MONO_TYPE_FNPTR:
 417                 case MONO_TYPE_ARRAY:
 418                 case MONO_TYPE_SZARRAY:
 419                         printf ("%p, ", *((gpointer *)(cpos)));
 420                         break;
 421                 case MONO_TYPE_I8:
 422                 case MONO_TYPE_U8:
 423                         printf ("0x%016llx, ", (long long)*((gint64 *)(cpos)));
 424                         break;
 425                 case MONO_TYPE_R4:
 426                         printf ("%f, ", *((float *)(cpos)));
 427                         break;
 428                 case MONO_TYPE_R8:
 429                         printf ("%f, ", *((double *)(cpos)));
 430                         break;
 431                 case MONO_TYPE_VALUETYPE:
 432                         printf ("[");
 433                         for (j = 0; j < size; j++)
 434                                 printf ("%02x,", *((guint8*)cpos +j));
 435                         printf ("], ");
 436                         break;
 437                 default:
 438                         printf ("XX, ");
 439                 }
 440         }
 441
 442         printf (")\n");
 443         fflush (stdout);
 444 }
 445
 446 void
 447 mono_trace_leave_method (MonoMethod *method, ...)
 448 {
 449         MonoType *type;
 450         char *fname;
 451         va_list ap;
 452
 453         if (!trace_spec.enabled)
 454                 return;
 455
 456         va_start(ap, method);
 457
 458         fname = mono_method_full_name (method, TRUE);
 459         indent (-1);
 460         printf ("LEAVE: %s", fname);
 461         g_free (fname);
 462
 463         type = mono_method_signature (method)->ret;
 464
 465 handle_enum:
 466         switch (type->type) {
 467         case MONO_TYPE_VOID:
 468                 break;
 469         case MONO_TYPE_BOOLEAN: {
 470                 int eax = va_arg (ap, int);
 471                 if (eax)
 472                         printf ("TRUE:%d", eax);
 473                 else
 474                         printf ("FALSE");
 475
 476                 break;
 477         }
 478         case MONO_TYPE_CHAR:
 479         case MONO_TYPE_I1:
 480         case MONO_TYPE_U1:
 481         case MONO_TYPE_I2:
 482         case MONO_TYPE_U2:
 483         case MONO_TYPE_I4:
 484         case MONO_TYPE_U4:
 485         case MONO_TYPE_I:
 486         case MONO_TYPE_U: {
 487                 int eax = va_arg (ap, int);
 488                 printf ("result=%d", eax);
 489                 break;
 490         }
 491         case MONO_TYPE_STRING: {
 492                 MonoString *s = va_arg (ap, MonoString *);
 493 ;
 494                 if (s) {
 495                         char *as;
 496
 497                         g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
 498                         as = string_to_utf8 (s);
 499                         printf ("[STRING:%p:%s]", s, as);
 500                         g_free (as);
 501                 } else
 502                         printf ("[STRING:null], ");
 503                 break;
 504         }
 505         case MONO_TYPE_CLASS:
 506         case MONO_TYPE_OBJECT: {
 507                 MonoObject *o = va_arg (ap, MonoObject *);
 508
 509                 if (o) {
 510                         if (o->vtable->klass == mono_defaults.boolean_class) {
 511                                 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
 512                         } else if  (o->vtable->klass == mono_defaults.int32_class) {
 513                                 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
 514                         } else if  (o->vtable->klass == mono_defaults.int64_class) {
 515                                 printf ("[INT64:%p:%lld]", o, (long long)*((gint64 *)((char *)o + sizeof (MonoObject))));
 516                         } else
 517                                 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
 518                 } else
 519                         printf ("[OBJECT:%p]", o);
 520
 521                 break;
 522         }
 523         case MONO_TYPE_PTR:
 524         case MONO_TYPE_FNPTR:
 525         case MONO_TYPE_ARRAY:
 526         case MONO_TYPE_SZARRAY: {
 527                 gpointer p = va_arg (ap, gpointer);
 528                 printf ("result=%p", p);
 529                 break;
 530         }
 531         case MONO_TYPE_I8: {
 532                 gint64 l =  va_arg (ap, gint64);
 533                 printf ("lresult=0x%16llx", (long long)l);
 534                 break;
 535         }
 536         case MONO_TYPE_U8: {
 537                 gint64 l =  va_arg (ap, gint64);
 538                 printf ("lresult=0x%16llx", (long long)l);
 539                 break;
 540         }
 541         case MONO_TYPE_R4:
 542         case MONO_TYPE_R8: {
 543                 double f = va_arg (ap, double);
 544                 printf ("FP=%f\n", f);
 545                 break;
 546         }
 547         case MONO_TYPE_VALUETYPE:
 548                 if (type->data.klass->enumtype) {
 549                         type = type->data.klass->enum_basetype;
 550                         goto handle_enum;
 551                 } else {
 552                         guint8 *p = va_arg (ap, gpointer);
 553                         int j, size, align;
 554                         size = mono_type_size (type, &align);
 555                         printf ("[");
 556                         for (j = 0; p && j < size; j++)
 557                                 printf ("%02x,", p [j]);
 558                         printf ("]");
 559                 }
 560                 break;
 561         default:
 562                 printf ("(unknown return type %x)", mono_method_signature (method)->ret->type);
 563         }
 564
 565         //printf (" ip: %p\n", __builtin_return_address (1));
 566         printf ("\n");
 567         fflush (stdout);
 568 }
 569
 570 void
 571 mono_trace_enable (gboolean enable)
 572 {
 573         trace_spec.enabled = enable;
 574 }
 575
 576 gboolean
 577 mono_trace_is_enabled ()
 578 {
 579         return trace_spec.enabled;
 580 }
 581