mono/metadata/method-builder.c

   1 /*
   2  * method-builder.c: Functions for creating IL methods at runtime.
   3  *
   4  * Author:
   5  *   Paolo Molaro (lupus@ximian.com)
   6  *
   7  * (C) 2002 Ximian, Inc.  http://www.ximian.com
   8  *
   9  */
  10
  11 #include "config.h"
  12 #include "loader.h"
  13 #include "mono/metadata/method-builder.h"
  14 #include "mono/metadata/tabledefs.h"
  15 #include "mono/metadata/exception.h"
  16 #include "mono/metadata/appdomain.h"
  17 #include "mono/metadata/debug-helpers.h"
  18 #include "mono/metadata/metadata-internals.h"
  19 #include "mono/metadata/domain-internals.h"
  20 #include <string.h>
  21 #include <errno.h>
  22
  23 /* #define DEBUG_RUNTIME_CODE */
  24
  25 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
  26         a = i,
  27
  28 enum {
  29 #include "mono/cil/opcode.def"
  30         LAST = 0xff
  31 };
  32 #undef OPDEF
  33
  34 #ifdef DEBUG_RUNTIME_CODE
  35 static char*
  36 indenter (MonoDisHelper *dh, MonoMethod *method, guint32 ip_offset)
  37 {
  38         return g_strdup (" ");
  39 }
  40
  41 static MonoDisHelper marshal_dh = {
  42         "\n",
  43         "IL_%04x: ",
  44         "IL_%04x",
  45         indenter,
  46         NULL,
  47         NULL
  48 };
  49 #endif
  50
  51 static MonoMethodBuilder *
  52 mono_mb_new_base (MonoClass *klass, MonoWrapperType type)
  53 {
  54         MonoMethodBuilder *mb;
  55         MonoMethod *m;
  56
  57         g_assert (klass != NULL);
  58
  59         mb = g_new0 (MonoMethodBuilder, 1);
  60
  61         mb->method = m = (MonoMethod *)g_new0 (MonoMethodWrapper, 1);
  62
  63         m->klass = klass;
  64         m->inline_info = 1;
  65         m->wrapper_type = type;
  66
  67         mb->code_size = 40;
  68         mb->code = g_malloc (mb->code_size);
  69         /* placeholder for the wrapper always at index 1 */
  70         mono_mb_add_data (mb, NULL);
  71
  72         return mb;
  73 }
  74
  75 MonoMethodBuilder *
  76 mono_mb_new_no_dup_name (MonoClass *klass, const char *name, MonoWrapperType type)
  77 {
  78         MonoMethodBuilder *mb = mono_mb_new_base (klass, type);
  79         mb->name = (char*)name;
  80         mb->no_dup_name = TRUE;
  81         return mb;
  82 }
  83
  84 MonoMethodBuilder *
  85 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type)
  86 {
  87         MonoMethodBuilder *mb = mono_mb_new_base (klass, type);
  88         mb->name = g_strdup (name);
  89         return mb;
  90 }
  91
  92 void
  93 mono_mb_free (MonoMethodBuilder *mb)
  94 {
  95         g_list_free (mb->locals_list);
  96         if (!mb->dynamic) {
  97                 g_free (mb->method);
  98                 if (!mb->no_dup_name)
  99                         g_free (mb->name);
 100                 g_free (mb->code);
 101         }
 102         g_free (mb);
 103 }
 104
 105 int
 106 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type)
 107 {
 108         int res;
 109
 110         g_assert (mb != NULL);
 111         g_assert (type != NULL);
 112
 113         res = mb->locals;
 114         mb->locals_list = g_list_append (mb->locals_list, type);
 115         mb->locals++;
 116
 117         return res;
 118 }
 119
 120 /**
 121  * mono_mb_create_method:
 122  *
 123  * Create a MonoMethod from this method builder.
 124  * Returns: the newly created method.
 125  *
 126  * LOCKING: Takes the loader lock.
 127  */
 128 MonoMethod *
 129 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack)
 130 {
 131         MonoMethodHeader *header;
 132         MonoMethodWrapper *mw;
 133         MonoImage *image;
 134         MonoMethod *method;
 135         GList *l;
 136         int i;
 137
 138         g_assert (mb != NULL);
 139
 140         image = mb->method->klass->image;
 141
 142         mono_loader_lock ();
 143         if (mb->dynamic) {
 144                 method = mb->method;
 145
 146                 method->name = mb->name;
 147                 method->dynamic = TRUE;
 148
 149                 ((MonoMethodNormal *)method)->header = header = (MonoMethodHeader *)
 150                         g_malloc0 (sizeof (MonoMethodHeader) + mb->locals * sizeof (MonoType *));
 151
 152                 header->code = mb->code;
 153
 154                 for (i = 0, l = mb->locals_list; l; l = l->next, i++) {
 155                         header->locals [i] = mono_metadata_type_dup (NULL, (MonoType*)l->data);
 156                 }
 157         } else {
 158                 /* Realloc the method info into a mempool */
 159
 160                 method = mono_image_alloc0 (image, sizeof (MonoMethodWrapper));
 161                 memcpy (method, mb->method, sizeof (MonoMethodWrapper));
 162
 163                 if (mb->no_dup_name)
 164                         method->name = mb->name;
 165                 else
 166                         method->name = mono_image_strdup (image, mb->name);
 167
 168                 ((MonoMethodNormal *)method)->header = header = (MonoMethodHeader *)
 169                         mono_image_alloc0 (image, sizeof (MonoMethodHeader) + mb->locals * sizeof (MonoType *));
 170
 171                 header->code = mono_image_alloc (image, mb->pos);
 172                 memcpy ((char*)header->code, mb->code, mb->pos);
 173
 174                 for (i = 0, l = mb->locals_list; l; l = l->next, i++) {
 175                         header->locals [i] = (MonoType *)l->data;
 176                 }
 177         }
 178
 179         if (max_stack < 8)
 180                 max_stack = 8;
 181
 182         header->max_stack = max_stack;
 183
 184         method->signature = signature;
 185
 186         header->code_size = mb->pos;
 187         header->num_locals = mb->locals;
 188         header->init_locals = TRUE;
 189
 190         mw = (MonoMethodWrapper*) mb->method;
 191         i = g_list_length (mw->method_data);
 192         if (i) {
 193                 GList *tmp;
 194                 void **data;
 195                 l = g_list_reverse (mw->method_data);
 196                 if (method->dynamic)
 197                         data = g_malloc (sizeof (gpointer) * (i + 1));
 198                 else
 199                         data = mono_image_alloc (image, sizeof (gpointer) * (i + 1));
 200                 /* store the size in the first element */
 201                 data [0] = GUINT_TO_POINTER (i);
 202                 i = 1;
 203                 for (tmp = l; tmp; tmp = tmp->next) {
 204                         data [i++] = tmp->data;
 205                 }
 206                 g_list_free (l);
 207
 208                 ((MonoMethodWrapper*)method)->method_data = data;
 209         }
 210         /*{
 211                 static int total_code = 0;
 212                 static int total_alloc = 0;
 213                 total_code += mb->pos;
 214                 total_alloc += mb->code_size;
 215                 g_print ("code size: %d of %d (allocated: %d)\n", mb->pos, total_code, total_alloc);
 216         }*/
 217
 218 #ifdef DEBUG_RUNTIME_CODE
 219         printf ("RUNTIME CODE FOR %s\n", mono_method_full_name (method, TRUE));
 220         printf ("%s\n", mono_disasm_code (&marshal_dh, method, mb->code, mb->code + mb->pos));
 221 #endif
 222
 223         mono_loader_unlock ();
 224         return method;
 225 }
 226
 227 guint32
 228 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data)
 229 {
 230         MonoMethodWrapper *mw;
 231
 232         g_assert (mb != NULL);
 233
 234         mw = (MonoMethodWrapper *)mb->method;
 235
 236         /* one O(n) is enough */
 237         mw->method_data = g_list_prepend (mw->method_data, data);
 238
 239         return g_list_length (mw->method_data);
 240 }
 241
 242 void
 243 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value)
 244 {
 245         mb->code [pos] = value & 0xff;
 246         mb->code [pos + 1] = (value >> 8) & 0xff;
 247         mb->code [pos + 2] = (value >> 16) & 0xff;
 248         mb->code [pos + 3] = (value >> 24) & 0xff;
 249 }
 250
 251 void
 252 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value)
 253 {
 254         *((gint8 *)(&mb->code [pos])) = value;
 255 }
 256
 257 void
 258 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op)
 259 {
 260         if (mb->pos >= mb->code_size) {
 261                 mb->code_size += mb->code_size >> 1;
 262                 mb->code = g_realloc (mb->code, mb->code_size);
 263         }
 264
 265         mb->code [mb->pos++] = op;
 266 }
 267
 268 void
 269 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset)
 270 {
 271         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 272         mono_mb_emit_byte (mb, CEE_MONO_OBJADDR);
 273
 274         if (offset) {
 275                 mono_mb_emit_icon (mb, offset);
 276                 mono_mb_emit_byte (mb, CEE_ADD);
 277         }
 278 }
 279
 280 void
 281 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data)
 282 {
 283         if ((mb->pos + 4) >= mb->code_size) {
 284                 mb->code_size += mb->code_size >> 1;
 285                 mb->code = g_realloc (mb->code, mb->code_size);
 286         }
 287
 288         mono_mb_patch_addr (mb, mb->pos, data);
 289         mb->pos += 4;
 290 }
 291
 292 void
 293 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data)
 294 {
 295         if ((mb->pos + 2) >= mb->code_size) {
 296                 mb->code_size += mb->code_size >> 1;
 297                 mb->code = g_realloc (mb->code, mb->code_size);
 298         }
 299
 300         mb->code [mb->pos] = data & 0xff;
 301         mb->code [mb->pos + 1] = (data >> 8) & 0xff;
 302         mb->pos += 2;
 303 }
 304
 305 void
 306 mono_mb_emit_op (MonoMethodBuilder *mb, guint8 op, gpointer data)
 307 {
 308         mono_mb_emit_byte (mb, op);
 309         mono_mb_emit_i4 (mb, mono_mb_add_data (mb, data));
 310 }
 311
 312 void
 313 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str)
 314 {
 315         mono_mb_emit_op (mb, CEE_LDSTR, str);
 316 }
 317
 318 void
 319 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum)
 320 {
 321         if (argnum < 4) {
 322                 mono_mb_emit_byte (mb, CEE_LDARG_0 + argnum);
 323         } else if (argnum < 256) {
 324                 mono_mb_emit_byte (mb, CEE_LDARG_S);
 325                 mono_mb_emit_byte (mb, argnum);
 326         } else {
 327                 mono_mb_emit_byte (mb, CEE_PREFIX1);
 328                 mono_mb_emit_byte (mb, CEE_LDARG);
 329                 mono_mb_emit_i2 (mb, argnum);
 330         }
 331 }
 332
 333 void
 334 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum)
 335 {
 336         if (argnum < 256) {
 337                 mono_mb_emit_byte (mb, CEE_LDARGA_S);
 338                 mono_mb_emit_byte (mb, argnum);
 339         } else {
 340                 mono_mb_emit_byte (mb, CEE_PREFIX1);
 341                 mono_mb_emit_byte (mb, CEE_LDARGA);
 342                 mono_mb_emit_i2 (mb, argnum);
 343         }
 344 }
 345
 346 void
 347 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum)
 348 {
 349         if (locnum < 256) {
 350                 mono_mb_emit_byte (mb, CEE_LDLOCA_S);
 351                 mono_mb_emit_byte (mb, locnum);
 352         } else {
 353                 mono_mb_emit_byte (mb, CEE_PREFIX1);
 354                 mono_mb_emit_byte (mb, CEE_LDLOCA);
 355                 mono_mb_emit_i2 (mb, locnum);
 356         }
 357 }
 358
 359 void
 360 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num)
 361 {
 362         if (num < 4) {
 363                 mono_mb_emit_byte (mb, CEE_LDLOC_0 + num);
 364         } else if (num < 256) {
 365                 mono_mb_emit_byte (mb, CEE_LDLOC_S);
 366                 mono_mb_emit_byte (mb, num);
 367         } else {
 368                 mono_mb_emit_byte (mb, CEE_PREFIX1);
 369                 mono_mb_emit_byte (mb, CEE_LDLOC);
 370                 mono_mb_emit_i2 (mb, num);
 371         }
 372 }
 373
 374 void
 375 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num)
 376 {
 377         if (num < 4) {
 378                 mono_mb_emit_byte (mb, CEE_STLOC_0 + num);
 379         } else if (num < 256) {
 380                 mono_mb_emit_byte (mb, CEE_STLOC_S);
 381                 mono_mb_emit_byte (mb, num);
 382         } else {
 383                 mono_mb_emit_byte (mb, CEE_PREFIX1);
 384                 mono_mb_emit_byte (mb, CEE_STLOC);
 385                 mono_mb_emit_i2 (mb, num);
 386         }
 387 }
 388
 389 void
 390 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value)
 391 {
 392         if (value >= -1 && value < 8) {
 393                 mono_mb_emit_byte (mb, CEE_LDC_I4_0 + value);
 394         } else if (value >= -128 && value <= 127) {
 395                 mono_mb_emit_byte (mb, CEE_LDC_I4_S);
 396                 mono_mb_emit_byte (mb, value);
 397         } else {
 398                 mono_mb_emit_byte (mb, CEE_LDC_I4);
 399                 mono_mb_emit_i4 (mb, value);
 400         }
 401 }
 402
 403 int
 404 mono_mb_get_label (MonoMethodBuilder *mb)
 405 {
 406         return mb->pos;
 407 }
 408
 409 int
 410 mono_mb_get_pos (MonoMethodBuilder *mb)
 411 {
 412         return mb->pos;
 413 }
 414
 415 guint32
 416 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op)
 417 {
 418         guint32 res;
 419         mono_mb_emit_byte (mb, op);
 420         res = mb->pos;
 421         mono_mb_emit_i4 (mb, 0);
 422         return res;
 423 }
 424
 425 guint32
 426 mono_mb_emit_short_branch (MonoMethodBuilder *mb, guint8 op)
 427 {
 428         guint32 res;
 429         mono_mb_emit_byte (mb, op);
 430         res = mb->pos;
 431         mono_mb_emit_byte (mb, 0);
 432
 433         return res;
 434 }
 435
 436 void
 437 mono_mb_emit_branch_label (MonoMethodBuilder *mb, guint8 op, guint32 label)
 438 {
 439         mono_mb_emit_byte (mb, op);
 440         mono_mb_emit_i4 (mb, label - (mb->pos + 4));
 441 }
 442
 443 void
 444 mono_mb_patch_branch (MonoMethodBuilder *mb, guint32 pos)
 445 {
 446         mono_mb_patch_addr (mb, pos, mb->pos - (pos + 4));
 447 }
 448
 449 void
 450 mono_mb_patch_short_branch (MonoMethodBuilder *mb, guint32 pos)
 451 {
 452         mono_mb_patch_addr_s (mb, pos, mb->pos - (pos + 1));
 453 }
 454
 455 void
 456 mono_mb_emit_ptr (MonoMethodBuilder *mb, gpointer ptr)
 457 {
 458         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 459         mono_mb_emit_op (mb, CEE_MONO_LDPTR, ptr);
 460 }
 461
 462 void
 463 mono_mb_emit_calli (MonoMethodBuilder *mb, MonoMethodSignature *sig)
 464 {
 465         mono_mb_emit_op (mb, CEE_CALLI, sig);
 466 }
 467
 468 void
 469 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig)
 470 {
 471         mono_mb_emit_op (mb, CEE_CALL, method);
 472 }
 473
 474 void
 475 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func)
 476 {
 477         mono_mb_emit_ptr (mb, func);
 478         mono_mb_emit_calli (mb, sig);
 479 }
 480
 481 void
 482 mono_mb_emit_icall (MonoMethodBuilder *mb, gpointer func)
 483 {
 484         mono_mb_emit_byte (mb, MONO_CUSTOM_PREFIX);
 485         mono_mb_emit_op (mb, CEE_MONO_ICALL, func);
 486 }
 487
 488 void
 489 mono_mb_emit_exception_full (MonoMethodBuilder *mb, const char *exc_nspace, const char *exc_name, const char *msg)
 490 {
 491         MonoMethod *ctor = NULL;
 492
 493         MonoClass *mme = mono_class_from_name (mono_defaults.corlib, exc_nspace, exc_name);
 494         mono_class_init (mme);
 495         ctor = mono_class_get_method_from_name (mme, ".ctor", 0);
 496         g_assert (ctor);
 497         mono_mb_emit_op (mb, CEE_NEWOBJ, ctor);
 498         if (msg != NULL) {
 499                 mono_mb_emit_byte (mb, CEE_DUP);
 500                 mono_mb_emit_ldflda (mb, G_STRUCT_OFFSET (MonoException, message));
 501                 mono_mb_emit_ldstr (mb, (char*)msg);
 502                 mono_mb_emit_byte (mb, CEE_STIND_REF);
 503         }
 504         mono_mb_emit_byte (mb, CEE_THROW);
 505 }
 506
 507 void
 508 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg)
 509 {
 510         mono_mb_emit_exception_full (mb, "System", exc_name, msg);
 511 }
 512
 513 void
 514 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr)
 515 {
 516         mono_mb_emit_ldloc (mb, local);
 517         mono_mb_emit_icon (mb, incr);
 518         mono_mb_emit_byte (mb, CEE_ADD);
 519         mono_mb_emit_stloc (mb, local);
 520 }