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 (method->klass->image == mono_assembly_get_image (trace_spec.assembly))
  37                                 inc = 1; break;
  38                 case MONO_TRACEOP_METHOD:
  39                         if (mono_method_desc_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 == '.' || p == ':')
  69                 return TRUE;
  70         return FALSE;
  71 }
  72
  73 static char *input;
  74 static char *value;
  75
  76 static void get_string (void)
  77 {
  78         char *start = input;
  79         while (is_filenamechar (*input)){
  80                 input++;
  81         }
  82         if (value != NULL)
  83                 g_free (value);
  84         value = g_malloc (input - start + 1);
  85         strncpy (value, start, input-start);
  86         value [input-start] = 0;
  87 }
  88
  89 enum Token {
  90         TOKEN_METHOD,
  91         TOKEN_CLASS,
  92         TOKEN_ALL,
  93         TOKEN_PROGRAM,
  94         TOKEN_NAMESPACE,
  95         TOKEN_STRING,
  96         TOKEN_EXCLUDE,
  97         TOKEN_SEPARATOR,
  98         TOKEN_END,
  99         TOKEN_ERROR
 100 };
 101
 102 static int
 103 get_token (void)
 104 {
 105         while (*input != 0){
 106                 if (input [0] == 'M' && input [1] == ':'){
 107                         input += 2;
 108                         get_string ();
 109                         return TOKEN_METHOD;
 110                 }
 111                 if (input [0] == 'N' && input [1] == ':'){
 112                         input += 2;
 113                         get_string ();
 114                         return TOKEN_NAMESPACE;
 115                 }
 116                 if (input [0] == 'T' && input [1] == ':'){
 117                         input += 2;
 118                         get_string ();
 119                         return TOKEN_CLASS;
 120                 }
 121                 if (is_filenamechar (*input)){
 122                         get_string ();
 123                         if (strcmp (value, "all") == 0)
 124                                 return TOKEN_ALL;
 125                         if (strcmp (value, "program") == 0)
 126                                 return TOKEN_PROGRAM;
 127                         return TOKEN_STRING;
 128                 }
 129                 if (*input == '-'){
 130                         input++;
 131                         return TOKEN_EXCLUDE;
 132                 }
 133                 if (*input == ','){
 134                         input++;
 135                         return TOKEN_SEPARATOR;
 136                 }
 137                 input++;
 138
 139         }
 140         return TOKEN_END;
 141 }
 142
 143 static void
 144 cleanup (void)
 145 {
 146         if (value != NULL)
 147                 g_free (value);
 148 }
 149
 150 static int
 151 get_spec (int *last)
 152 {
 153         int token = get_token ();
 154         if (token == TOKEN_EXCLUDE){
 155                 token = get_spec (last);
 156                 if (token == TOKEN_EXCLUDE){
 157                         fprintf (stderr, "Expecting an expression");
 158                         return TOKEN_ERROR;
 159                 }
 160                 if (token == TOKEN_ERROR)
 161                         return token;
 162                 trace_spec.ops [(*last)-1].exclude = 1;
 163                 return TOKEN_SEPARATOR;
 164         }
 165         if (token == TOKEN_END || token == TOKEN_SEPARATOR || token == TOKEN_ERROR)
 166                 return token;
 167
 168         if (token == TOKEN_METHOD){
 169                 MonoMethodDesc *desc = mono_method_desc_new (value, TRUE);
 170                 if (desc == NULL){
 171                         fprintf (stderr, "Invalid method name: %s\n", value);
 172                         return TOKEN_ERROR;
 173                 }
 174                 trace_spec.ops [*last].op = MONO_TRACEOP_METHOD;
 175                 trace_spec.ops [*last].data = desc;
 176         } else if (token == TOKEN_ALL)
 177                 trace_spec.ops [*last].op = MONO_TRACEOP_ALL;
 178         else if (token == TOKEN_PROGRAM)
 179                 trace_spec.ops [*last].op = MONO_TRACEOP_PROGRAM;
 180         else if (token == TOKEN_NAMESPACE){
 181                 trace_spec.ops [*last].op = MONO_TRACEOP_NAMESPACE;
 182                 trace_spec.ops [*last].data = g_strdup (value);
 183         } else if (token == TOKEN_CLASS){
 184                 char *p = strrchr (value, '.');
 185                 *p++ = 0;
 186                 trace_spec.ops [*last].op = MONO_TRACEOP_CLASS;
 187                 trace_spec.ops [*last].data = g_strdup (value);
 188                 trace_spec.ops [*last].data2 = g_strdup (p);
 189         } else if (token == TOKEN_STRING){
 190                 trace_spec.ops [*last].op = MONO_TRACEOP_ASSEMBLY;
 191                 trace_spec.ops [*last].data = g_strdup (value);
 192         }
 193         else {
 194                 fprintf (stderr, "Syntax error in trace option specification\n");
 195                 return TOKEN_ERROR;
 196         }
 197         (*last)++;
 198         return TOKEN_SEPARATOR;
 199 }
 200
 201 MonoTraceSpec *
 202 mono_trace_parse_options (MonoAssembly *assembly, char *options)
 203 {
 204         char *p = options;
 205         int size = 1;
 206         int last_used;
 207         int token;
 208
 209         trace_spec.assembly = assembly;
 210
 211         if (*p == 0){
 212                 trace_spec.len = 1;
 213                 trace_spec.ops = g_new0 (MonoTraceOperation, 1);
 214                 trace_spec.ops [0].op = MONO_TRACEOP_ALL;
 215                 return &trace_spec;
 216         }
 217
 218         for (p = options; *p != 0; p++)
 219                 if (*p == ',')
 220                         size++;
 221
 222         trace_spec.ops = g_new0 (MonoTraceOperation, size);
 223
 224         input = options;
 225         last_used = 0;
 226
 227         while ((token = (get_spec (&last_used))) != TOKEN_END){
 228                 if (token == TOKEN_ERROR)
 229                         return NULL;
 230                 if (token == TOKEN_SEPARATOR)
 231                         continue;
 232         }
 233         trace_spec.len = last_used;
 234         cleanup ();
 235         return &trace_spec;
 236 }
 237
 238 static int indent_level = 0;
 239
 240 static void indent (int diff) {
 241         int v;
 242         if (diff < 0)
 243                 indent_level += diff;
 244         v = indent_level;
 245         while (v-- > 0) {
 246                 printf (". ");
 247         }
 248         if (diff > 0)
 249                 indent_level += diff;
 250 }
 251
 252 static gboolean enable_trace = TRUE;
 253
 254 void
 255 mono_trace_enter_method (MonoMethod *method, char *ebp)
 256 {
 257         int i, j;
 258         MonoClass *class;
 259         MonoObject *o;
 260         MonoJitArgumentInfo *arg_info;
 261         MonoMethodSignature *sig;
 262         char *fname;
 263
 264         if (!enable_trace)
 265                 return;
 266
 267         fname = mono_method_full_name (method, TRUE);
 268         indent (1);
 269         printf ("ENTER: %s(", fname);
 270         g_free (fname);
 271
 272         if (!ebp) {
 273                 printf (") ip: %p\n", __builtin_return_address (1));
 274                 return;
 275         }
 276         if (((int)ebp & (MONO_ARCH_FRAME_ALIGNMENT - 1)) != 0) {
 277                 g_error ("unaligned stack detected (%p)", ebp);
 278         }
 279
 280         sig = method->signature;
 281
 282         arg_info = alloca (sizeof (MonoJitArgumentInfo) * (sig->param_count + 1));
 283
 284         mono_arch_get_argument_info (sig, sig->param_count, arg_info);
 285
 286         if (MONO_TYPE_ISSTRUCT (method->signature->ret)) {
 287                 g_assert (!method->signature->ret->byref);
 288
 289                 printf ("VALUERET:%p, ", *((gpointer *)(ebp + 8)));
 290         }
 291
 292         if (method->signature->hasthis) {
 293                 gpointer *this = (gpointer *)(ebp + arg_info [0].offset);
 294                 if (method->klass->valuetype) {
 295                         printf ("value:%p, ", *this);
 296                 } else {
 297                         o = *((MonoObject **)this);
 298
 299                         if (o) {
 300                                 class = o->vtable->klass;
 301
 302                                 if (class == mono_defaults.string_class) {
 303                                         printf ("this:[STRING:%p:%s], ", o, mono_string_to_utf8 ((MonoString *)o));
 304                                 } else {
 305                                         printf ("this:%p[%s.%s %s], ", o, class->name_space, class->name, o->vtable->domain->friendly_name);
 306                                 }
 307                         } else
 308                                 printf ("this:NULL, ");
 309                 }
 310         }
 311
 312         for (i = 0; i < method->signature->param_count; ++i) {
 313                 gpointer *cpos = (gpointer *)(ebp + arg_info [i + 1].offset);
 314                 int size = arg_info [i + 1].size;
 315
 316                 MonoType *type = method->signature->params [i];
 317
 318                 if (type->byref) {
 319                         printf ("[BYREF:%p], ", *cpos);
 320                 } else switch (type->type) {
 321
 322                 case MONO_TYPE_I:
 323                 case MONO_TYPE_U:
 324                         printf ("%p, ", (gpointer)*((int *)(cpos)));
 325                         break;
 326                 case MONO_TYPE_BOOLEAN:
 327                 case MONO_TYPE_CHAR:
 328                 case MONO_TYPE_I1:
 329                 case MONO_TYPE_U1:
 330                         printf ("%d, ", *((gint8 *)(cpos)));
 331                         break;
 332                 case MONO_TYPE_I2:
 333                 case MONO_TYPE_U2:
 334                         printf ("%d, ", *((gint16 *)(cpos)));
 335                         break;
 336                 case MONO_TYPE_I4:
 337                 case MONO_TYPE_U4:
 338                         printf ("%d, ", *((int *)(cpos)));
 339                         break;
 340                 case MONO_TYPE_STRING: {
 341                         MonoString *s = *((MonoString **)cpos);
 342                         if (s) {
 343                                 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
 344                                 printf ("[STRING:%p:%s], ", s, mono_string_to_utf8 (s));
 345                         } else
 346                                 printf ("[STRING:null], ");
 347                         break;
 348                 }
 349                 case MONO_TYPE_CLASS:
 350                 case MONO_TYPE_OBJECT: {
 351                         o = *((MonoObject **)cpos);
 352                         if (o) {
 353                                 class = o->vtable->klass;
 354
 355                                 if (class == mono_defaults.string_class) {
 356                                         printf ("[STRING:%p:%s], ", o, mono_string_to_utf8 ((MonoString *)o));
 357                                 } else if (class == mono_defaults.int32_class) {
 358                                         printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
 359                                 } else
 360                                         printf ("[%s.%s:%p], ", class->name_space, class->name, o);
 361                         } else {
 362                                 printf ("%p, ", *((gpointer *)(cpos)));
 363                         }
 364                         break;
 365                 }
 366                 case MONO_TYPE_PTR:
 367                 case MONO_TYPE_FNPTR:
 368                 case MONO_TYPE_ARRAY:
 369                 case MONO_TYPE_SZARRAY:
 370                         printf ("%p, ", *((gpointer *)(cpos)));
 371                         break;
 372                 case MONO_TYPE_I8:
 373                 case MONO_TYPE_U8:
 374                         printf ("0x%016llx, ", *((gint64 *)(cpos)));
 375                         break;
 376                 case MONO_TYPE_R4:
 377                         printf ("%f, ", *((float *)(cpos)));
 378                         break;
 379                 case MONO_TYPE_R8:
 380                         printf ("%f, ", *((double *)(cpos)));
 381                         break;
 382                 case MONO_TYPE_VALUETYPE:
 383                         printf ("[");
 384                         for (j = 0; j < size; j++)
 385                                 printf ("%02x,", *((guint8*)cpos +j));
 386                         printf ("], ");
 387                         break;
 388                 default:
 389                         printf ("XX, ");
 390                 }
 391         }
 392
 393         printf (")\n");
 394 }
 395
 396 void
 397 mono_trace_leave_method (MonoMethod *method, ...)
 398 {
 399         MonoType *type;
 400         char *fname;
 401         va_list ap;
 402
 403         if (!enable_trace)
 404                 return;
 405
 406         va_start(ap, method);
 407
 408         fname = mono_method_full_name (method, TRUE);
 409         indent (-1);
 410         printf ("LEAVE: %s", fname);
 411         g_free (fname);
 412
 413         type = method->signature->ret;
 414
 415 handle_enum:
 416         switch (type->type) {
 417         case MONO_TYPE_VOID:
 418                 break;
 419         case MONO_TYPE_BOOLEAN: {
 420                 int eax = va_arg (ap, int);
 421                 if (eax)
 422                         printf ("TRUE:%d", eax);
 423                 else
 424                         printf ("FALSE");
 425
 426                 break;
 427         }
 428         case MONO_TYPE_CHAR:
 429         case MONO_TYPE_I1:
 430         case MONO_TYPE_U1:
 431         case MONO_TYPE_I2:
 432         case MONO_TYPE_U2:
 433         case MONO_TYPE_I4:
 434         case MONO_TYPE_U4:
 435         case MONO_TYPE_I:
 436         case MONO_TYPE_U: {
 437                 int eax = va_arg (ap, int);
 438                 printf ("result=%d", eax);
 439                 break;
 440         }
 441         case MONO_TYPE_STRING: {
 442                 MonoString *s = va_arg (ap, MonoString *);
 443 ;
 444                 if (s) {
 445                         g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
 446                         printf ("[STRING:%p:%s]", s, mono_string_to_utf8 (s));
 447                 } else
 448                         printf ("[STRING:null], ");
 449                 break;
 450         }
 451         case MONO_TYPE_CLASS:
 452         case MONO_TYPE_OBJECT: {
 453                 MonoObject *o = va_arg (ap, MonoObject *);
 454
 455                 if (o) {
 456                         if (o->vtable->klass == mono_defaults.boolean_class) {
 457                                 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
 458                         } else if  (o->vtable->klass == mono_defaults.int32_class) {
 459                                 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
 460                         } else if  (o->vtable->klass == mono_defaults.int64_class) {
 461                                 printf ("[INT64:%p:%lld]", o, *((gint64 *)((char *)o + sizeof (MonoObject))));
 462                         } else
 463                                 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
 464                 } else
 465                         printf ("[OBJECT:%p]", o);
 466
 467                 break;
 468         }
 469         case MONO_TYPE_PTR:
 470         case MONO_TYPE_FNPTR:
 471         case MONO_TYPE_ARRAY:
 472         case MONO_TYPE_SZARRAY: {
 473                 gpointer p = va_arg (ap, gpointer);
 474                 printf ("result=%p", p);
 475                 break;
 476         }
 477         case MONO_TYPE_I8: {
 478                 gint64 l =  va_arg (ap, gint64);
 479                 printf ("lresult=0x%16llx", l);
 480                 break;
 481         }
 482         case MONO_TYPE_U8: {
 483                 gint64 l =  va_arg (ap, gint64);
 484                 printf ("lresult=0x%16llx", l);
 485                 break;
 486         }
 487         case MONO_TYPE_R4:
 488         case MONO_TYPE_R8: {
 489                 double f = va_arg (ap, double);
 490                 printf ("FP=%f\n", f);
 491                 break;
 492         }
 493         case MONO_TYPE_VALUETYPE:
 494                 if (type->data.klass->enumtype) {
 495                         type = type->data.klass->enum_basetype;
 496                         goto handle_enum;
 497                 } else {
 498                         guint8 *p = va_arg (ap, gpointer);
 499                         int j, size, align;
 500                         size = mono_type_size (type, &align);
 501                         printf ("[");
 502                         for (j = 0; p && j < size; j++)
 503                                 printf ("%02x,", p [j]);
 504                         printf ("]");
 505                 }
 506                 break;
 507         default:
 508                 printf ("(unknown return type %x)", method->signature->ret->type);
 509         }
 510
 511         //printf (" ip: %p\n", __builtin_return_address (1));
 512         printf ("\n");
 513 }