mono/mini/mini-gc.c

   1 /*
   2  * mini-gc.c: GC interface for the mono JIT
   3  *
   4  * Author:
   5  *   Zoltan Varga (vargaz@gmail.com)
   6  *
   7  * Copyright 2009 Novell, Inc (http://www.novell.com)
   8  * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
   9  */
  10
  11 #include "config.h"
  12 #include "mini-gc.h"
  13 #include <mono/metadata/gc-internal.h>
  14
  15 //#if 0
  16 #if defined(MONO_ARCH_GC_MAPS_SUPPORTED)
  17
  18 #include <mono/metadata/gc-internal.h>
  19 #include <mono/utils/mono-counters.h>
  20
  21 #if SIZEOF_VOID_P == 4
  22 typedef guint32 mword;
  23 #else
  24 typedef guint64 mword;
  25 #endif
  26
  27 #define SIZEOF_SLOT ((int)sizeof (mgreg_t))
  28
  29 #define GC_BITS_PER_WORD (sizeof (mword) * 8)
  30
  31 /* Contains state needed by the GC Map construction code */
  32 typedef struct {
  33         /*
  34          * This contains information about stack slots initialized in the prolog, encoded using
  35          * (slot_index << 16) | slot_type. The slot_index is relative to the CFA, i.e. 0
  36          * means cfa+0, 1 means cfa-4/8, etc.
  37          */
  38         GSList *stack_slots_from_cfa;
  39         /* Same for stack slots relative to the frame pointer */
  40         GSList *stack_slots_from_fp;
  41
  42         /* Number of slots in the map */
  43         int nslots;
  44         /* The number of registers in the map */
  45         int nregs;
  46         /* Min and Max offsets of the stack frame relative to fp */
  47         int min_offset, max_offset;
  48         /* Same for the locals area */
  49         int locals_min_offset, locals_max_offset;
  50
  51         /* The call sites where this frame can be stopped during GC */
  52         GCCallSite **callsites;
  53         /* The number of call sites */
  54         int ncallsites;
  55
  56         /*
  57          * The width of the stack bitmaps in bytes. This is not equal to the bitmap width at
  58      * runtime, since it includes columns which are 0.
  59          */
  60         int stack_bitmap_width;
  61         /*
  62          * A bitmap whose width equals nslots, and whose height equals ncallsites.
  63          * The bitmap contains a 1 if the corresponding stack slot has type SLOT_REF at the
  64          * given callsite.
  65          */
  66         guint8 *stack_ref_bitmap;
  67         /* Same for SLOT_PIN */
  68         guint8 *stack_pin_bitmap;
  69
  70         /*
  71          * Similar bitmaps for registers. These have width MONO_MAX_IREGS in bits.
  72          */
  73         int reg_bitmap_width;
  74         guint8 *reg_ref_bitmap;
  75         guint8 *reg_pin_bitmap;
  76 } MonoCompileGC;
  77
  78 #define ALIGN_TO(val,align) ((((mgreg_t)val) + ((align) - 1)) & ~((align) - 1))
  79
  80 #undef DEBUG
  81
  82 #if 0
  83 /* We don't support debug levels, its all-or-nothing */
  84 #define DEBUG(s) do { s; fflush (logfile); } while (0)
  85 #define DEBUG_ENABLED 1
  86 #else
  87 #define DEBUG(s)
  88 #endif
  89
  90 #ifdef DEBUG_ENABLED
  91 //#if 1
  92 #define DEBUG_PRECISE(s) do { s; } while (0)
  93 #define DEBUG_PRECISE_ENABLED
  94 #else
  95 #define DEBUG_PRECISE(s)
  96 #endif
  97
  98 /*
  99  * Contains information collected during the conservative stack marking pass,
 100  * used during the precise pass. This helps to avoid doing a stack walk twice, which
 101  * is expensive.
 102  */
 103 typedef struct {
 104         guint8 *bitmap;
 105         int nslots;
 106     int frame_start_offset;
 107         int nreg_locations;
 108         /* Relative to stack_start */
 109         int reg_locations [MONO_MAX_IREGS];
 110 #ifdef DEBUG_PRECISE_ENABLED
 111         MonoJitInfo *ji;
 112         gpointer fp;
 113         int regs [MONO_MAX_IREGS];
 114 #endif
 115 } FrameInfo;
 116
 117 /* Max number of frames stored in the TLS data */
 118 #define MAX_FRAMES 50
 119
 120 /*
 121  * Per-thread data kept by this module. This is stored in the GC and passed to us as
 122  * parameters, instead of being stored in a TLS variable, since during a collection,
 123  * only the collection thread is active.
 124  */
 125 typedef struct {
 126         MonoThreadUnwindState unwind_state;
 127         MonoThreadInfo *info;
 128         /* For debugging */
 129         mgreg_t tid;
 130         gpointer ref_to_track;
 131         /* Number of frames collected during the !precise pass */
 132         int nframes;
 133         FrameInfo frames [MAX_FRAMES];
 134 } TlsData;
 135
 136 /* These are constant so don't store them in the GC Maps */
 137 /* Number of registers stored in gc maps */
 138 #define NREGS MONO_MAX_IREGS
 139
 140 /*
 141  * The GC Map itself.
 142  * Contains information needed to mark a stack frame.
 143  * This is a transient structure, created from a compressed representation on-demand.
 144  */
 145 typedef struct {
 146         /*
 147          * The offsets of the GC tracked area inside the stack frame relative to the frame pointer.
 148          * This includes memory which is NOREF thus doesn't need GC maps.
 149          */
 150         int start_offset;
 151         int end_offset;
 152         /*
 153          * The offset relative to frame_offset where the the memory described by the GC maps
 154          * begins.
 155          */
 156         int map_offset;
 157         /* The number of stack slots in the map */
 158         int nslots;
 159         /* The frame pointer register */
 160         guint8 frame_reg;
 161         /* The size of each callsite table entry */
 162         guint8 callsite_entry_size;
 163         guint has_pin_slots : 1;
 164         guint has_ref_slots : 1;
 165         guint has_ref_regs : 1;
 166         guint has_pin_regs : 1;
 167
 168         /* The offsets below are into an external bitmaps array */
 169
 170         /*
 171          * A bitmap whose width is equal to bitmap_width, and whose height is equal to ncallsites.
 172          * The bitmap contains a 1 if the corresponding stack slot has type SLOT_REF at the
 173          * given callsite.
 174          */
 175         guint32 stack_ref_bitmap_offset;
 176         /*
 177          * Same for SLOT_PIN. It is possible that the same bit is set in both bitmaps at
 178      * different callsites, if the slot starts out as PIN, and later changes to REF.
 179          */
 180         guint32 stack_pin_bitmap_offset;
 181
 182         /*
 183          * Corresponding bitmaps for registers
 184          * These have width equal to the number of bits set in reg_ref_mask/reg_pin_mask.
 185          * FIXME: Merge these with the normal bitmaps, i.e. reserve the first x slots for them ?
 186          */
 187         guint32 reg_pin_bitmap_offset;
 188         guint32 reg_ref_bitmap_offset;
 189
 190         guint32 used_int_regs, reg_ref_mask, reg_pin_mask;
 191
 192         /* The number of bits set in the two masks above */
 193         guint8 nref_regs, npin_regs;
 194
 195         /*
 196          * A bit array marking slots which contain refs.
 197          * This is used only for debugging.
 198          */
 199         //guint8 *ref_slots;
 200
 201         /* Callsite offsets */
 202         /* These can take up a lot of space, so encode them compactly */
 203         union {
 204                 guint8 *offsets8;
 205                 guint16 *offsets16;
 206                 guint32 *offsets32;
 207         } callsites;
 208         int ncallsites;
 209 } GCMap;
 210
 211 /*
 212  * A compressed version of GCMap. This is what gets stored in MonoJitInfo.
 213  */
 214 typedef struct {
 215         //guint8 *ref_slots;
 216         //guint8 encoded_size;
 217
 218         /*
 219          * The arrays below are embedded after the struct.
 220          * Their address needs to be computed.
 221          */
 222
 223         /* The fixed fields of the GCMap encoded using LEB128 */
 224         guint8 encoded [MONO_ZERO_LEN_ARRAY];
 225
 226         /* An array of ncallsites entries, each entry is callsite_entry_size bytes long */
 227         guint8 callsites [MONO_ZERO_LEN_ARRAY];
 228
 229         /* The GC bitmaps */
 230         guint8 bitmaps [MONO_ZERO_LEN_ARRAY];
 231 } GCEncodedMap;
 232
 233 static int precise_frame_count [2], precise_frame_limit = -1;
 234 static gboolean precise_frame_limit_inited;
 235
 236 /* Stats */
 237 typedef struct {
 238         int scanned_stacks;
 239         int scanned;
 240         int scanned_precisely;
 241         int scanned_conservatively;
 242         int scanned_registers;
 243         int scanned_native;
 244         int scanned_other;
 245
 246         int all_slots;
 247         int noref_slots;
 248         int ref_slots;
 249         int pin_slots;
 250
 251         int gc_maps_size;
 252         int gc_callsites_size;
 253         int gc_callsites8_size;
 254         int gc_callsites16_size;
 255         int gc_callsites32_size;
 256         int gc_bitmaps_size;
 257         int gc_map_struct_size;
 258         int tlsdata_size;
 259 } JITGCStats;
 260
 261 static JITGCStats stats;
 262
 263 static FILE *logfile;
 264
 265 static gboolean enable_gc_maps_for_aot;
 266
 267 void
 268 mini_gc_enable_gc_maps_for_aot (void)
 269 {
 270         enable_gc_maps_for_aot = TRUE;
 271 }
 272
 273 // FIXME: Move these to a shared place
 274
 275 static inline void
 276 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
 277 {
 278         guint8 *p = buf;
 279
 280         do {
 281                 guint8 b = value & 0x7f;
 282                 value >>= 7;
 283                 if (value != 0) /* more bytes to come */
 284                         b |= 0x80;
 285                 *p ++ = b;
 286         } while (value);
 287
 288         *endbuf = p;
 289 }
 290
 291 static G_GNUC_UNUSED void
 292 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
 293 {
 294         gboolean more = 1;
 295         gboolean negative = (value < 0);
 296         guint32 size = 32;
 297         guint8 byte;
 298         guint8 *p = buf;
 299
 300         while (more) {
 301                 byte = value & 0x7f;
 302                 value >>= 7;
 303                 /* the following is unnecessary if the
 304                  * implementation of >>= uses an arithmetic rather
 305                  * than logical shift for a signed left operand
 306                  */
 307                 if (negative)
 308                         /* sign extend */
 309                         value |= - (1 <<(size - 7));
 310                 /* sign bit of byte is second high order bit (0x40) */
 311                 if ((value == 0 && !(byte & 0x40)) ||
 312                         (value == -1 && (byte & 0x40)))
 313                         more = 0;
 314                 else
 315                         byte |= 0x80;
 316                 *p ++= byte;
 317         }
 318
 319         *endbuf = p;
 320 }
 321
 322 static inline guint32
 323 decode_uleb128 (guint8 *buf, guint8 **endbuf)
 324 {
 325         guint8 *p = buf;
 326         guint32 res = 0;
 327         int shift = 0;
 328
 329         while (TRUE) {
 330                 guint8 b = *p;
 331                 p ++;
 332
 333                 res = res | (((int)(b & 0x7f)) << shift);
 334                 if (!(b & 0x80))
 335                         break;
 336                 shift += 7;
 337         }
 338
 339         *endbuf = p;
 340
 341         return res;
 342 }
 343
 344 static inline gint32
 345 decode_sleb128 (guint8 *buf, guint8 **endbuf)
 346 {
 347         guint8 *p = buf;
 348         gint32 res = 0;
 349         int shift = 0;
 350
 351         while (TRUE) {
 352                 guint8 b = *p;
 353                 p ++;
 354
 355                 res = res | (((int)(b & 0x7f)) << shift);
 356                 shift += 7;
 357                 if (!(b & 0x80)) {
 358                         if (shift < 32 && (b & 0x40))
 359                                 res |= - (1 << shift);
 360                         break;
 361                 }
 362         }
 363
 364         *endbuf = p;
 365
 366         return res;
 367 }
 368
 369 static int
 370 encode_frame_reg (int frame_reg)
 371 {
 372 #ifdef TARGET_AMD64
 373         if (frame_reg == AMD64_RSP)
 374                 return 0;
 375         else if (frame_reg == AMD64_RBP)
 376                 return 1;
 377 #elif defined(TARGET_X86)
 378         if (frame_reg == X86_EBP)
 379                 return 0;
 380         else if (frame_reg == X86_ESP)
 381                 return 1;
 382 #elif defined(TARGET_ARM)
 383         if (frame_reg == ARMREG_SP)
 384                 return 0;
 385         else if (frame_reg == ARMREG_FP)
 386                 return 1;
 387 #elif defined(TARGET_S390X)
 388         if (frame_reg == S390_SP)
 389                 return 0;
 390         else if (frame_reg == S390_FP)
 391                 return 1;
 392 #else
 393         NOT_IMPLEMENTED;
 394 #endif
 395         g_assert_not_reached ();
 396         return -1;
 397 }
 398
 399 static int
 400 decode_frame_reg (int encoded)
 401 {
 402 #ifdef TARGET_AMD64
 403         if (encoded == 0)
 404                 return AMD64_RSP;
 405         else if (encoded == 1)
 406                 return AMD64_RBP;
 407 #elif defined(TARGET_X86)
 408         if (encoded == 0)
 409                 return X86_EBP;
 410         else if (encoded == 1)
 411                 return X86_ESP;
 412 #elif defined(TARGET_ARM)
 413         if (encoded == 0)
 414                 return ARMREG_SP;
 415         else if (encoded == 1)
 416                 return ARMREG_FP;
 417 #elif defined(TARGET_S390X)
 418         if (encoded == 0)
 419                 return S390_SP;
 420         else if (encoded == 1)
 421                 return S390_FP;
 422 #else
 423         NOT_IMPLEMENTED;
 424 #endif
 425         g_assert_not_reached ();
 426         return -1;
 427 }
 428
 429 #ifdef TARGET_AMD64
 430 #ifdef HOST_WIN32
 431 static int callee_saved_regs [] = { AMD64_RBP, AMD64_RBX, AMD64_R12, AMD64_R13, AMD64_R14, AMD64_R15, AMD64_RDI, AMD64_RSI };
 432 #else
 433 static int callee_saved_regs [] = { AMD64_RBP, AMD64_RBX, AMD64_R12, AMD64_R13, AMD64_R14, AMD64_R15 };
 434 #endif
 435 #elif defined(TARGET_X86)
 436 static int callee_saved_regs [] = { X86_EBX, X86_ESI, X86_EDI };
 437 #elif defined(TARGET_ARM)
 438 static int callee_saved_regs [] = { ARMREG_V1, ARMREG_V2, ARMREG_V3, ARMREG_V4, ARMREG_V5, ARMREG_V7, ARMREG_FP };
 439 #elif defined(TARGET_S390X)
 440 static int callee_saved_regs [] = { s390_r6, s390_r7, s390_r8, s390_r9, s390_r10, s390_r11, s390_r12, s390_r13, s390_r14 };
 441 #endif
 442
 443 static guint32
 444 encode_regmask (guint32 regmask)
 445 {
 446         int i;
 447         guint32 res;
 448
 449         res = 0;
 450         for (i = 0; i < sizeof (callee_saved_regs) / sizeof (int); ++i) {
 451                 if (regmask & (1 << callee_saved_regs [i])) {
 452                         res |= (1 << i);
 453                         regmask -= (1 << callee_saved_regs [i]);
 454                 }
 455         }
 456         g_assert (regmask == 0);
 457         return res;
 458 }
 459
 460 static guint32
 461 decode_regmask (guint32 regmask)
 462 {
 463         int i;
 464         guint32 res;
 465
 466         res = 0;
 467         for (i = 0; i < sizeof (callee_saved_regs) / sizeof (int); ++i)
 468                 if (regmask & (1 << i))
 469                         res |= (1 << callee_saved_regs [i]);
 470         return res;
 471 }
 472
 473 /*
 474  * encode_gc_map:
 475  *
 476  *   Encode the fixed fields of MAP into a buffer pointed to by BUF.
 477  */
 478 static void
 479 encode_gc_map (GCMap *map, guint8 *buf, guint8 **endbuf)
 480 {
 481         guint32 flags, freg;
 482
 483         encode_sleb128 (map->start_offset / SIZEOF_SLOT, buf, &buf);
 484         encode_sleb128 (map->end_offset / SIZEOF_SLOT, buf, &buf);
 485         encode_sleb128 (map->map_offset / SIZEOF_SLOT, buf, &buf);
 486         encode_uleb128 (map->nslots, buf, &buf);
 487         g_assert (map->callsite_entry_size <= 4);
 488         freg = encode_frame_reg (map->frame_reg);
 489         g_assert (freg < 2);
 490         flags = (map->has_ref_slots ? 1 : 0) | (map->has_pin_slots ? 2 : 0) | (map->has_ref_regs ? 4 : 0) | (map->has_pin_regs ? 8 : 0) | ((map->callsite_entry_size - 1) << 4) | (freg << 6);
 491         encode_uleb128 (flags, buf, &buf);
 492         encode_uleb128 (encode_regmask (map->used_int_regs), buf, &buf);
 493         if (map->has_ref_regs)
 494                 encode_uleb128 (encode_regmask (map->reg_ref_mask), buf, &buf);
 495         if (map->has_pin_regs)
 496                 encode_uleb128 (encode_regmask (map->reg_pin_mask), buf, &buf);
 497         encode_uleb128 (map->ncallsites, buf, &buf);
 498
 499         *endbuf = buf;
 500 }
 501
 502 /*
 503  * decode_gc_map:
 504  *
 505  *   Decode the encoded GC map representation in BUF and store the result into MAP.
 506  */
 507 static void
 508 decode_gc_map (guint8 *buf, GCMap *map, guint8 **endbuf)
 509 {
 510         guint32 flags;
 511         int stack_bitmap_size, reg_ref_bitmap_size, reg_pin_bitmap_size, offset, freg;
 512         int i, n;
 513
 514         map->start_offset = decode_sleb128 (buf, &buf) * SIZEOF_SLOT;
 515         map->end_offset = decode_sleb128 (buf, &buf) * SIZEOF_SLOT;
 516         map->map_offset = decode_sleb128 (buf, &buf) * SIZEOF_SLOT;
 517         map->nslots = decode_uleb128 (buf, &buf);
 518         flags = decode_uleb128 (buf, &buf);
 519         map->has_ref_slots = (flags & 1) ? 1 : 0;
 520         map->has_pin_slots = (flags & 2) ? 1 : 0;
 521         map->has_ref_regs = (flags & 4) ? 1 : 0;
 522         map->has_pin_regs = (flags & 8) ? 1 : 0;
 523         map->callsite_entry_size = ((flags >> 4) & 0x3) + 1;
 524         freg = flags >> 6;
 525         map->frame_reg = decode_frame_reg (freg);
 526         map->used_int_regs = decode_regmask (decode_uleb128 (buf, &buf));
 527         if (map->has_ref_regs) {
 528                 map->reg_ref_mask = decode_regmask (decode_uleb128 (buf, &buf));
 529                 n = 0;
 530                 for (i = 0; i < NREGS; ++i)
 531                         if (map->reg_ref_mask & (1 << i))
 532                                 n ++;
 533                 map->nref_regs = n;
 534         }
 535         if (map->has_pin_regs) {
 536                 map->reg_pin_mask = decode_regmask (decode_uleb128 (buf, &buf));
 537                 n = 0;
 538                 for (i = 0; i < NREGS; ++i)
 539                         if (map->reg_pin_mask & (1 << i))
 540                                 n ++;
 541                 map->npin_regs = n;
 542         }
 543         map->ncallsites = decode_uleb128 (buf, &buf);
 544
 545         stack_bitmap_size = (ALIGN_TO (map->nslots, 8) / 8) * map->ncallsites;
 546         reg_ref_bitmap_size = (ALIGN_TO (map->nref_regs, 8) / 8) * map->ncallsites;
 547         reg_pin_bitmap_size = (ALIGN_TO (map->npin_regs, 8) / 8) * map->ncallsites;
 548         offset = 0;
 549         map->stack_ref_bitmap_offset = offset;
 550         if (map->has_ref_slots)
 551                 offset += stack_bitmap_size;
 552         map->stack_pin_bitmap_offset = offset;
 553         if (map->has_pin_slots)
 554                 offset += stack_bitmap_size;
 555         map->reg_ref_bitmap_offset = offset;
 556         if (map->has_ref_regs)
 557                 offset += reg_ref_bitmap_size;
 558         map->reg_pin_bitmap_offset = offset;
 559         if (map->has_pin_regs)
 560                 offset += reg_pin_bitmap_size;
 561
 562         *endbuf = buf;
 563 }
 564
 565 static gpointer
 566 thread_attach_func (void)
 567 {
 568         TlsData *tls;
 569
 570         tls = g_new0 (TlsData, 1);
 571         tls->tid = GetCurrentThreadId ();
 572         tls->info = mono_thread_info_current ();
 573         stats.tlsdata_size += sizeof (TlsData);
 574
 575         return tls;
 576 }
 577
 578 static void
 579 thread_detach_func (gpointer user_data)
 580 {
 581         TlsData *tls = user_data;
 582
 583         g_free (tls);
 584 }
 585
 586 static void
 587 thread_suspend_func (gpointer user_data, void *sigctx, MonoContext *ctx)
 588 {
 589         TlsData *tls = user_data;
 590
 591         if (!tls) {
 592                 /* Happens during startup */
 593                 return;
 594         }
 595
 596         if (tls->tid != GetCurrentThreadId ()) {
 597                 /* Happens on osx because threads are not suspended using signals */
 598                 gboolean res;
 599
 600                 g_assert (tls->info);
 601                 res = mono_thread_state_init_from_handle (&tls->unwind_state, (MonoNativeThreadId)tls->tid, tls->info->native_handle);
 602         } else {
 603                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_LMF] = mono_get_lmf ();
 604                 if (sigctx) {
 605 #ifdef MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX
 606                         mono_arch_sigctx_to_monoctx (sigctx, &tls->unwind_state.ctx);
 607                         tls->unwind_state.valid = TRUE;
 608 #else
 609                         tls->unwind_state.valid = FALSE;
 610 #endif
 611                 } else if (ctx) {
 612                         memcpy (&tls->unwind_state.ctx, ctx, sizeof (MonoContext));
 613                         tls->unwind_state.valid = TRUE;
 614                 } else {
 615                         tls->unwind_state.valid = FALSE;
 616                 }
 617                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_JIT_TLS] = mono_native_tls_get_value (mono_jit_tls_id);
 618                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_DOMAIN] = mono_domain_get ();
 619         }
 620
 621         if (!tls->unwind_state.unwind_data [MONO_UNWIND_DATA_DOMAIN]) {
 622                 /* Happens during startup */
 623                 tls->unwind_state.valid = FALSE;
 624                 return;
 625         }
 626 }
 627
 628 #define DEAD_REF ((gpointer)(gssize)0x2a2a2a2a2a2a2a2aULL)
 629
 630 static inline void
 631 set_bit (guint8 *bitmap, int width, int y, int x)
 632 {
 633         bitmap [(width * y) + (x / 8)] |= (1 << (x % 8));
 634 }
 635
 636 static inline void
 637 clear_bit (guint8 *bitmap, int width, int y, int x)
 638 {
 639         bitmap [(width * y) + (x / 8)] &= ~(1 << (x % 8));
 640 }
 641
 642 static inline int
 643 get_bit (guint8 *bitmap, int width, int y, int x)
 644 {
 645         return bitmap [(width * y) + (x / 8)] & (1 << (x % 8));
 646 }
 647
 648 static const char*
 649 slot_type_to_string (GCSlotType type)
 650 {
 651         switch (type) {
 652         case SLOT_REF:
 653                 return "ref";
 654         case SLOT_NOREF:
 655                 return "noref";
 656         case SLOT_PIN:
 657                 return "pin";
 658         default:
 659                 g_assert_not_reached ();
 660                 return NULL;
 661         }
 662 }
 663
 664 static inline mgreg_t
 665 get_frame_pointer (MonoContext *ctx, int frame_reg)
 666 {
 667 #if defined(TARGET_AMD64)
 668                 if (frame_reg == AMD64_RSP)
 669                         return ctx->rsp;
 670                 else if (frame_reg == AMD64_RBP)
 671                         return ctx->rbp;
 672 #elif defined(TARGET_X86)
 673                 if (frame_reg == X86_ESP)
 674                         return ctx->esp;
 675                 else if (frame_reg == X86_EBP)
 676                         return ctx->ebp;
 677 #elif defined(TARGET_ARM)
 678                 if (frame_reg == ARMREG_SP)
 679                         return (mgreg_t)MONO_CONTEXT_GET_SP (ctx);
 680                 else if (frame_reg == ARMREG_FP)
 681                         return (mgreg_t)MONO_CONTEXT_GET_BP (ctx);
 682 #elif defined(TARGET_S390X)
 683                 if (frame_reg == S390_SP)
 684                         return (mgreg_t)MONO_CONTEXT_GET_SP (ctx);
 685                 else if (frame_reg == S390_FP)
 686                         return (mgreg_t)MONO_CONTEXT_GET_BP (ctx);
 687 #endif
 688                 g_assert_not_reached ();
 689                 return 0;
 690 }
 691
 692 /*
 693  * conservatively_pass:
 694  *
 695  *   Mark a thread stack conservatively and collect information needed by the precise pass.
 696  */
 697 static void
 698 conservative_pass (TlsData *tls, guint8 *stack_start, guint8 *stack_end)
 699 {
 700         MonoJitInfo *ji;
 701         MonoContext ctx, new_ctx;
 702         MonoLMF *lmf;
 703         guint8 *stack_limit;
 704         gboolean last = TRUE;
 705         GCMap *map;
 706         GCMap map_tmp;
 707         GCEncodedMap *emap;
 708         guint8* fp, *p, *real_frame_start, *frame_start, *frame_end;
 709         int i, pc_offset, cindex, bitmap_width;
 710         int scanned = 0, scanned_precisely, scanned_conservatively, scanned_registers;
 711         gboolean res;
 712         StackFrameInfo frame;
 713         mgreg_t *reg_locations [MONO_MAX_IREGS];
 714         mgreg_t *new_reg_locations [MONO_MAX_IREGS];
 715         guint8 *bitmaps;
 716         FrameInfo *fi;
 717         guint32 precise_regmask;
 718
 719         if (tls) {
 720                 tls->nframes = 0;
 721                 tls->ref_to_track = NULL;
 722         }
 723
 724         /* tls == NULL can happen during startup */
 725         if (mono_thread_internal_current () == NULL || !tls) {
 726                 mono_gc_conservatively_scan_area (stack_start, stack_end);
 727                 stats.scanned_stacks += stack_end - stack_start;
 728                 return;
 729         }
 730
 731         lmf = tls->unwind_state.unwind_data [MONO_UNWIND_DATA_LMF];
 732         frame.domain = NULL;
 733
 734         /* Number of bytes scanned based on GC map data */
 735         scanned = 0;
 736         /* Number of bytes scanned precisely based on GC map data */
 737         scanned_precisely = 0;
 738         /* Number of bytes scanned conservatively based on GC map data */
 739         scanned_conservatively = 0;
 740         /* Number of bytes scanned conservatively in register save areas */
 741         scanned_registers = 0;
 742
 743         /* This is one past the last address which we have scanned */
 744         stack_limit = stack_start;
 745
 746         if (!tls->unwind_state.valid)
 747                 memset (&new_ctx, 0, sizeof (ctx));
 748         else
 749                 memcpy (&new_ctx, &tls->unwind_state.ctx, sizeof (MonoContext));
 750
 751         memset (reg_locations, 0, sizeof (reg_locations));
 752         memset (new_reg_locations, 0, sizeof (new_reg_locations));
 753
 754         while (TRUE) {
 755                 if (!tls->unwind_state.valid)
 756                         break;
 757
 758                 memcpy (&ctx, &new_ctx, sizeof (ctx));
 759
 760                 for (i = 0; i < MONO_MAX_IREGS; ++i) {
 761                         if (new_reg_locations [i]) {
 762                                 /*
 763                                  * If the current frame saves the register, it means it might modify its
 764                                  * value, thus the old location might not contain the same value, so
 765                                  * we have to mark it conservatively.
 766                                  */
 767                                 if (reg_locations [i]) {
 768                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 769                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 770                                         scanned_registers += SIZEOF_SLOT;
 771                                 }
 772
 773                                 reg_locations [i] = new_reg_locations [i];
 774
 775                                 DEBUG (fprintf (logfile, "\treg %s is now at location %p.\n", mono_arch_regname (i), reg_locations [i]));
 776                         }
 777                 }
 778
 779                 g_assert ((mgreg_t)stack_limit % SIZEOF_SLOT == 0);
 780
 781                 res = mono_find_jit_info_ext (frame.domain ? frame.domain : tls->unwind_state.unwind_data [MONO_UNWIND_DATA_DOMAIN], tls->unwind_state.unwind_data [MONO_UNWIND_DATA_JIT_TLS], NULL, &ctx, &new_ctx, NULL, &lmf, new_reg_locations, &frame);
 782                 if (!res)
 783                         break;
 784
 785                 ji = frame.ji;
 786
 787                 // FIXME: For skipped frames, scan the param area of the parent frame conservatively ?
 788
 789                 if (frame.type == FRAME_TYPE_MANAGED_TO_NATIVE) {
 790                         /*
 791                          * These frames are problematic for several reasons:
 792                          * - they are unwound through an LMF, and we have no precise register tracking for those.
 793                          * - the LMF might not contain a precise ip, so we can't compute the call site.
 794                          * - the LMF only unwinds to the wrapper frame, so we get these methods twice.
 795                          */
 796                         DEBUG (fprintf (logfile, "Mark(0): <Managed-to-native transition>\n"));
 797                         for (i = 0; i < MONO_MAX_IREGS; ++i) {
 798                                 if (reg_locations [i]) {
 799                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 800                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 801                                         scanned_registers += SIZEOF_SLOT;
 802                                 }
 803                                 reg_locations [i] = NULL;
 804                                 new_reg_locations [i] = NULL;
 805                         }
 806                         ctx = new_ctx;
 807                         continue;
 808                 }
 809
 810                 /* The last frame can be in any state so mark conservatively */
 811                 if (last) {
 812                         if (ji) {
 813                                 DEBUG (char *fname = mono_method_full_name (ji->method, TRUE); fprintf (logfile, "Mark(0): %s+0x%x (%p)\n", fname, pc_offset, (gpointer)MONO_CONTEXT_GET_IP (&ctx)); g_free (fname));
 814                         }
 815                         DEBUG (fprintf (logfile, "\t <Last frame>\n"));
 816                         last = FALSE;
 817                         /*
 818                          * new_reg_locations is not precise when a method is interrupted during its epilog, so clear it.
 819                          */
 820                         for (i = 0; i < MONO_MAX_IREGS; ++i) {
 821                                 if (reg_locations [i]) {
 822                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 823                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 824                                         scanned_registers += SIZEOF_SLOT;
 825                                 }
 826                                 if (new_reg_locations [i]) {
 827                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), new_reg_locations [i]));
 828                                         mono_gc_conservatively_scan_area (new_reg_locations [i], (char*)new_reg_locations [i] + SIZEOF_SLOT);
 829                                         scanned_registers += SIZEOF_SLOT;
 830                                 }
 831                                 reg_locations [i] = NULL;
 832                                 new_reg_locations [i] = NULL;
 833                         }
 834                         continue;
 835                 }
 836
 837                 pc_offset = (guint8*)MONO_CONTEXT_GET_IP (&ctx) - (guint8*)ji->code_start;
 838
 839                 /* These frames are very problematic */
 840                 if (ji->method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE) {
 841                         DEBUG (char *fname = mono_method_full_name (ji->method, TRUE); fprintf (logfile, "Mark(0): %s+0x%x (%p)\n", fname, pc_offset, (gpointer)MONO_CONTEXT_GET_IP (&ctx)); g_free (fname));
 842                         DEBUG (fprintf (logfile, "\tSkip.\n"));
 843                         continue;
 844                 }
 845
 846                 /* All the other frames are at a call site */
 847
 848                 if (tls->nframes == MAX_FRAMES) {
 849                         /*
 850                          * Can't save information since the array is full. So scan the rest of the
 851                          * stack conservatively.
 852                          */
 853                         DEBUG (fprintf (logfile, "Mark (0): Frame stack full.\n"));
 854                         break;
 855                 }
 856
 857                 /* Scan the frame of this method */
 858
 859                 /*
 860                  * A frame contains the following:
 861                  * - saved registers
 862                  * - saved args
 863                  * - locals
 864                  * - spill area
 865                  * - localloc-ed memory
 866                  */
 867                 g_assert (pc_offset >= 0);
 868
 869                 emap = ji->gc_info;
 870
 871                 if (!emap) {
 872                         DEBUG (char *fname = mono_method_full_name (ji->method, TRUE); fprintf (logfile, "Mark(0): %s+0x%x (%p)\n", fname, pc_offset, (gpointer)MONO_CONTEXT_GET_IP (&ctx)); g_free (fname));
 873                         DEBUG (fprintf (logfile, "\tNo GC Map.\n"));
 874                         continue;
 875                 }
 876
 877                 /* The embedded callsite table requires this */
 878                 g_assert (((mgreg_t)emap % 4) == 0);
 879
 880                 /*
 881                  * Debugging aid to control the number of frames scanned precisely
 882                  */
 883                 if (!precise_frame_limit_inited) {
 884                         if (getenv ("MONO_PRECISE_COUNT"))
 885                                 precise_frame_limit = atoi (getenv ("MONO_PRECISE_COUNT"));
 886                         precise_frame_limit_inited = TRUE;
 887                 }
 888
 889                 if (precise_frame_limit != -1) {
 890                         if (precise_frame_count [FALSE] == precise_frame_limit)
 891                                 printf ("LAST PRECISE FRAME: %s\n", mono_method_full_name (ji->method, TRUE));
 892                         if (precise_frame_count [FALSE] > precise_frame_limit)
 893                                 continue;
 894                 }
 895                 precise_frame_count [FALSE] ++;
 896
 897                 /* Decode the encoded GC map */
 898                 map = &map_tmp;
 899                 memset (map, 0, sizeof (GCMap));
 900                 decode_gc_map (&emap->encoded [0], map, &p);
 901                 p = (guint8*)ALIGN_TO (p, map->callsite_entry_size);
 902                 map->callsites.offsets8 = p;
 903                 p += map->callsite_entry_size * map->ncallsites;
 904                 bitmaps = p;
 905
 906                 fp = (guint8*)get_frame_pointer (&ctx, map->frame_reg);
 907
 908                 real_frame_start = fp + map->start_offset;
 909                 frame_start = fp + map->start_offset + map->map_offset;
 910                 frame_end = fp + map->end_offset;
 911
 912                 DEBUG (char *fname = mono_method_full_name (ji->method, TRUE); fprintf (logfile, "Mark(0): %s+0x%x (%p) limit=%p fp=%p frame=%p-%p (%d)\n", fname, pc_offset, (gpointer)MONO_CONTEXT_GET_IP (&ctx), stack_limit, fp, frame_start, frame_end, (int)(frame_end - frame_start)); g_free (fname));
 913
 914                 /* Find the callsite index */
 915                 if (map->callsite_entry_size == 1) {
 916                         for (i = 0; i < map->ncallsites; ++i)
 917                                 /* ip points inside the call instruction */
 918                                 if (map->callsites.offsets8 [i] == pc_offset + 1)
 919                                         break;
 920                 } else if (map->callsite_entry_size == 2) {
 921                         // FIXME: Use a binary search
 922                         for (i = 0; i < map->ncallsites; ++i)
 923                                 /* ip points inside the call instruction */
 924                                 if (map->callsites.offsets16 [i] == pc_offset + 1)
 925                                         break;
 926                 } else {
 927                         // FIXME: Use a binary search
 928                         for (i = 0; i < map->ncallsites; ++i)
 929                                 /* ip points inside the call instruction */
 930                                 if (map->callsites.offsets32 [i] == pc_offset + 1)
 931                                         break;
 932                 }
 933                 if (i == map->ncallsites) {
 934                         printf ("Unable to find ip offset 0x%x in callsite list of %s.\n", pc_offset + 1, mono_method_full_name (ji->method, TRUE));
 935                         g_assert_not_reached ();
 936                 }
 937                 cindex = i;
 938
 939                 /*
 940                  * This is not neccessary true on x86 because frames have a different size at each
 941                  * call site.
 942                  */
 943                 //g_assert (real_frame_start >= stack_limit);
 944
 945                 if (real_frame_start > stack_limit) {
 946                         /* This scans the previously skipped frames as well */
 947                         DEBUG (fprintf (logfile, "\tscan area %p-%p (%d).\n", stack_limit, real_frame_start, (int)(real_frame_start - stack_limit)));
 948                         mono_gc_conservatively_scan_area (stack_limit, real_frame_start);
 949                         stats.scanned_other += real_frame_start - stack_limit;
 950                 }
 951
 952                 /* Mark stack slots */
 953                 if (map->has_pin_slots) {
 954                         int bitmap_width = ALIGN_TO (map->nslots, 8) / 8;
 955                         guint8 *pin_bitmap = &bitmaps [map->stack_pin_bitmap_offset + (bitmap_width * cindex)];
 956                         guint8 *p;
 957                         gboolean pinned;
 958
 959                         p = frame_start;
 960                         for (i = 0; i < map->nslots; ++i) {
 961                                 pinned = pin_bitmap [i / 8] & (1 << (i % 8));
 962                                 if (pinned) {
 963                                         DEBUG (fprintf (logfile, "\tscan slot %s0x%x(fp)=%p.\n", (guint8*)p > (guint8*)fp ? "" : "-", ABS ((int)((gssize)p - (gssize)fp)), p));
 964                                         mono_gc_conservatively_scan_area (p, p + SIZEOF_SLOT);
 965                                         scanned_conservatively += SIZEOF_SLOT;
 966                                 } else {
 967                                         scanned_precisely += SIZEOF_SLOT;
 968                                 }
 969                                 p += SIZEOF_SLOT;
 970                         }
 971                 } else {
 972                         scanned_precisely += (map->nslots * SIZEOF_SLOT);
 973                 }
 974
 975                 /* The area outside of start-end is NOREF */
 976                 scanned_precisely += (map->end_offset - map->start_offset) - (map->nslots * SIZEOF_SLOT);
 977
 978                 /* Mark registers */
 979                 precise_regmask = map->used_int_regs | (1 << map->frame_reg);
 980                 if (map->has_pin_regs) {
 981                         int bitmap_width = ALIGN_TO (map->npin_regs, 8) / 8;
 982                         guint8 *pin_bitmap = &bitmaps [map->reg_pin_bitmap_offset + (bitmap_width * cindex)];
 983                         int bindex = 0;
 984                         for (i = 0; i < NREGS; ++i) {
 985                                 if (!(map->used_int_regs & (1 << i)))
 986                                         continue;
 987
 988                                 if (!(map->reg_pin_mask & (1 << i)))
 989                                         continue;
 990
 991                                 if (pin_bitmap [bindex / 8] & (1 << (bindex % 8))) {
 992                                         DEBUG (fprintf (logfile, "\treg %s saved at 0x%p is pinning.\n", mono_arch_regname (i), reg_locations [i]));
 993                                         precise_regmask &= ~(1 << i);
 994                                 }
 995                                 bindex ++;
 996                         }
 997                 }
 998
 999                 scanned += map->end_offset - map->start_offset;
1000
1001                 g_assert (scanned == scanned_precisely + scanned_conservatively);
1002
1003                 stack_limit = frame_end;
1004
1005                 /* Save information for the precise pass */
1006                 fi = &tls->frames [tls->nframes];
1007                 fi->nslots = map->nslots;
1008                 bitmap_width = ALIGN_TO (map->nslots, 8) / 8;
1009                 if (map->has_ref_slots)
1010                         fi->bitmap = &bitmaps [map->stack_ref_bitmap_offset + (bitmap_width * cindex)];
1011                 else
1012                         fi->bitmap = NULL;
1013                 fi->frame_start_offset = frame_start - stack_start;
1014                 fi->nreg_locations = 0;
1015                 DEBUG_PRECISE (fi->ji = ji);
1016                 DEBUG_PRECISE (fi->fp = fp);
1017
1018                 if (map->has_ref_regs) {
1019                         int bitmap_width = ALIGN_TO (map->nref_regs, 8) / 8;
1020                         guint8 *ref_bitmap = &bitmaps [map->reg_ref_bitmap_offset + (bitmap_width * cindex)];
1021                         int bindex = 0;
1022                         for (i = 0; i < NREGS; ++i) {
1023                                 if (!(map->reg_ref_mask & (1 << i)))
1024                                         continue;
1025
1026                                 if (reg_locations [i] && (ref_bitmap [bindex / 8] & (1 << (bindex % 8)))) {
1027                                         DEBUG_PRECISE (fi->regs [fi->nreg_locations] = i);
1028                                         DEBUG (fprintf (logfile, "\treg %s saved at 0x%p is ref.\n", mono_arch_regname (i), reg_locations [i]));
1029                                         fi->reg_locations [fi->nreg_locations] = (guint8*)reg_locations [i] - stack_start;
1030                                         fi->nreg_locations ++;
1031                                 }
1032                                 bindex ++;
1033                         }
1034                 }
1035
1036                 /*
1037                  * Clear locations of precisely tracked registers.
1038                  */
1039                 if (precise_regmask) {
1040                         for (i = 0; i < NREGS; ++i) {
1041                                 if (precise_regmask & (1 << i)) {
1042                                         /*
1043                                          * The method uses this register, and we have precise info for it.
1044                                          * This means the location will be scanned precisely.
1045                                          * Tell the code at the beginning of the loop that this location is
1046                                          * processed.
1047                                          */
1048                                         if (reg_locations [i])
1049                                                 DEBUG (fprintf (logfile, "\treg %s at location %p (==%p) is precise.\n", mono_arch_regname (i), reg_locations [i], (gpointer)*reg_locations [i]));
1050                                         reg_locations [i] = NULL;
1051                                 }
1052                         }
1053                 }
1054
1055                 tls->nframes ++;
1056         }
1057
1058         /* Scan the remaining register save locations */
1059         for (i = 0; i < MONO_MAX_IREGS; ++i) {
1060                 if (reg_locations [i]) {
1061                         DEBUG (fprintf (logfile, "\tscan saved reg location %p.\n", reg_locations [i]));
1062                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
1063                         scanned_registers += SIZEOF_SLOT;
1064                 }
1065                 if (new_reg_locations [i]) {
1066                         DEBUG (fprintf (logfile, "\tscan saved reg location %p.\n", new_reg_locations [i]));
1067                         mono_gc_conservatively_scan_area (new_reg_locations [i], (char*)new_reg_locations [i] + SIZEOF_SLOT);
1068                         scanned_registers += SIZEOF_SLOT;
1069                 }
1070         }
1071
1072         if (stack_limit < stack_end) {
1073                 DEBUG (fprintf (logfile, "\tscan remaining stack %p-%p (%d).\n", stack_limit, stack_end, (int)(stack_end - stack_limit)));
1074                 mono_gc_conservatively_scan_area (stack_limit, stack_end);
1075                 stats.scanned_native += stack_end - stack_limit;
1076         }
1077
1078         DEBUG (fprintf (logfile, "Marked %d bytes, p=%d,c=%d out of %d.\n", scanned, scanned_precisely, scanned_conservatively, (int)(stack_end - stack_start)));
1079
1080         stats.scanned_stacks += stack_end - stack_start;
1081         stats.scanned += scanned;
1082         stats.scanned_precisely += scanned_precisely;
1083         stats.scanned_conservatively += scanned_conservatively;
1084         stats.scanned_registers += scanned_registers;
1085
1086         //mono_gc_conservatively_scan_area (stack_start, stack_end);
1087 }
1088
1089 /*
1090  * precise_pass:
1091  *
1092  *   Mark a thread stack precisely based on information saved during the conservative
1093  * pass.
1094  */
1095 static void
1096 precise_pass (TlsData *tls, guint8 *stack_start, guint8 *stack_end)
1097 {
1098         int findex, i;
1099         FrameInfo *fi;
1100         guint8 *frame_start;
1101
1102         if (!tls)
1103                 return;
1104
1105         if (!tls->unwind_state.valid)
1106                 return;
1107
1108         for (findex = 0; findex < tls->nframes; findex ++) {
1109                 /* Load information saved by the !precise pass */
1110                 fi = &tls->frames [findex];
1111                 frame_start = stack_start + fi->frame_start_offset;
1112
1113                 DEBUG (char *fname = mono_method_full_name (fi->ji->method, TRUE); fprintf (logfile, "Mark(1): %s\n", fname); g_free (fname));
1114
1115                 /*
1116                  * FIXME: Add a function to mark using a bitmap, to avoid doing a
1117                  * call for each object.
1118                  */
1119
1120                 /* Mark stack slots */
1121                 if (fi->bitmap) {
1122                         guint8 *ref_bitmap = fi->bitmap;
1123                         gboolean live;
1124
1125                         for (i = 0; i < fi->nslots; ++i) {
1126                                 MonoObject **ptr = (MonoObject**)(frame_start + (i * SIZEOF_SLOT));
1127
1128                                 live = ref_bitmap [i / 8] & (1 << (i % 8));
1129
1130                                 if (live) {
1131                                         MonoObject *obj = *ptr;
1132                                         if (obj) {
1133                                                 DEBUG (fprintf (logfile, "\tref %s0x%x(fp)=%p: %p ->", (guint8*)ptr >= (guint8*)fi->fp ? "" : "-", ABS ((int)((gssize)ptr - (gssize)fi->fp)), ptr, obj));
1134                                                 *ptr = mono_gc_scan_object (obj);
1135                                                 DEBUG (fprintf (logfile, " %p.\n", *ptr));
1136                                         } else {
1137                                                 DEBUG (fprintf (logfile, "\tref %s0x%x(fp)=%p: %p.\n", (guint8*)ptr >= (guint8*)fi->fp ? "" : "-", ABS ((int)((gssize)ptr - (gssize)fi->fp)), ptr, obj));
1138                                         }
1139                                 } else {
1140 #if 0
1141                                         /*
1142                                          * This is disabled because the pointer takes up a lot of space.
1143                                          * Stack slots might be shared between ref and non-ref variables ?
1144                                          */
1145                                         if (map->ref_slots [i / 8] & (1 << (i % 8))) {
1146                                                 DEBUG (fprintf (logfile, "\tref %s0x%x(fp)=%p: dead (%p)\n", (guint8*)ptr >= (guint8*)fi->fp ? "" : "-", ABS ((int)((gssize)ptr - (gssize)fi->fp)), ptr, *ptr));
1147                                                 /*
1148                                                  * Fail fast if the live range is incorrect, and
1149                                                  * the JITted code tries to access this object
1150                                                  */
1151                                                 *ptr = DEAD_REF;
1152                                         }
1153 #endif
1154                                 }
1155                         }
1156                 }
1157
1158                 /* Mark registers */
1159
1160                 /*
1161                  * Registers are different from stack slots, they have no address where they
1162                  * are stored. Instead, some frame below this frame in the stack saves them
1163                  * in its prolog to the stack. We can mark this location precisely.
1164                  */
1165                 for (i = 0; i < fi->nreg_locations; ++i) {
1166                         /*
1167                          * reg_locations [i] contains the address of the stack slot where
1168                          * a reg was last saved, so mark that slot.
1169                          */
1170                         MonoObject **ptr = (MonoObject**)((guint8*)stack_start + fi->reg_locations [i]);
1171                         MonoObject *obj = *ptr;
1172
1173                         if (obj) {
1174                                 DEBUG (fprintf (logfile, "\treg %s saved at %p: %p ->", mono_arch_regname (fi->regs [i]), ptr, obj));
1175                                 *ptr = mono_gc_scan_object (obj);
1176                                 DEBUG (fprintf (logfile, " %p.\n", *ptr));
1177                         } else {
1178                                 DEBUG (fprintf (logfile, "\treg %s saved at %p: %p\n", mono_arch_regname (fi->regs [i]), ptr, obj));
1179                         }
1180                 }
1181         }
1182
1183         /*
1184          * Debugging aid to check for missed refs.
1185          */
1186         if (tls->ref_to_track) {
1187                 mgreg_t *p;
1188
1189                 for (p = (mgreg_t*)stack_start; p < (mgreg_t*)stack_end; ++p)
1190                         if (*p == (mgreg_t)tls->ref_to_track)
1191                                 printf ("REF AT %p.\n", p);
1192         }
1193 }
1194
1195 /*
1196  * thread_mark_func:
1197  *
1198  *   This is called by the GC twice to mark a thread stack. PRECISE is FALSE at the first
1199  * call, and TRUE at the second. USER_DATA points to a TlsData
1200  * structure filled up by thread_suspend_func.
1201  */
1202 static void
1203 thread_mark_func (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise)
1204 {
1205         TlsData *tls = user_data;
1206
1207         DEBUG (fprintf (logfile, "****************************************\n"));
1208         DEBUG (fprintf (logfile, "*** %s stack marking for thread %p (%p-%p) ***\n", precise ? "Precise" : "Conservative", tls ? GUINT_TO_POINTER (tls->tid) : NULL, stack_start, stack_end));
1209         DEBUG (fprintf (logfile, "****************************************\n"));
1210
1211         if (!precise)
1212                 conservative_pass (tls, stack_start, stack_end);
1213         else
1214                 precise_pass (tls, stack_start, stack_end);
1215 }
1216
1217 #ifndef DISABLE_JIT
1218
1219 static void
1220 mini_gc_init_gc_map (MonoCompile *cfg)
1221 {
1222         if (COMPILE_LLVM (cfg))
1223                 return;
1224
1225         if (!mono_gc_is_moving ())
1226                 return;
1227
1228         if (cfg->compile_aot) {
1229                 if (!enable_gc_maps_for_aot)
1230                         return;
1231         } else if (!mono_gc_precise_stack_mark_enabled ())
1232                 return;
1233
1234 #if 1
1235         /* Debugging support */
1236         {
1237                 static int precise_count;
1238
1239                 precise_count ++;
1240                 if (getenv ("MONO_GCMAP_COUNT")) {
1241                         if (precise_count == atoi (getenv ("MONO_GCMAP_COUNT")))
1242                                 printf ("LAST: %s\n", mono_method_full_name (cfg->method, TRUE));
1243                         if (precise_count > atoi (getenv ("MONO_GCMAP_COUNT")))
1244                                 return;
1245                 }
1246         }
1247 #endif
1248
1249         cfg->compute_gc_maps = TRUE;
1250
1251         cfg->gc_info = mono_mempool_alloc0 (cfg->mempool, sizeof (MonoCompileGC));
1252 }
1253
1254 /*
1255  * mini_gc_set_slot_type_from_fp:
1256  *
1257  *   Set the GC slot type of the stack slot identified by SLOT_OFFSET, which should be
1258  * relative to the frame pointer. By default, all stack slots are type PIN, so there is no
1259  * need to call this function for those slots.
1260  */
1261 void
1262 mini_gc_set_slot_type_from_fp (MonoCompile *cfg, int slot_offset, GCSlotType type)
1263 {
1264         MonoCompileGC *gcfg = (MonoCompileGC*)cfg->gc_info;
1265
1266         if (!cfg->compute_gc_maps)
1267                 return;
1268
1269         g_assert (slot_offset % SIZEOF_SLOT == 0);
1270
1271         gcfg->stack_slots_from_fp = g_slist_prepend_mempool (cfg->mempool, gcfg->stack_slots_from_fp, GINT_TO_POINTER (((slot_offset) << 16) | type));
1272 }
1273
1274 /*
1275  * mini_gc_set_slot_type_from_cfa:
1276  *
1277  *   Set the GC slot type of the stack slot identified by SLOT_OFFSET, which should be
1278  * relative to the DWARF CFA value. This should be called from mono_arch_emit_prolog ().
1279  * If type is STACK_REF, the slot is assumed to be live from the end of the prolog until
1280  * the end of the method. By default, all stack slots are type PIN, so there is no need to
1281  * call this function for those slots.
1282  */
1283 void
1284 mini_gc_set_slot_type_from_cfa (MonoCompile *cfg, int slot_offset, GCSlotType type)
1285 {
1286         MonoCompileGC *gcfg = (MonoCompileGC*)cfg->gc_info;
1287         int slot = - (slot_offset / SIZEOF_SLOT);
1288
1289         if (!cfg->compute_gc_maps)
1290                 return;
1291
1292         g_assert (slot_offset <= 0);
1293         g_assert (slot_offset % SIZEOF_SLOT == 0);
1294
1295         gcfg->stack_slots_from_cfa = g_slist_prepend_mempool (cfg->mempool, gcfg->stack_slots_from_cfa, GUINT_TO_POINTER (((slot) << 16) | type));
1296 }
1297
1298 static inline int
1299 fp_offset_to_slot (MonoCompile *cfg, int offset)
1300 {
1301         MonoCompileGC *gcfg = cfg->gc_info;
1302
1303         return (offset - gcfg->min_offset) / SIZEOF_SLOT;
1304 }
1305
1306 static inline int
1307 slot_to_fp_offset (MonoCompile *cfg, int slot)
1308 {
1309         MonoCompileGC *gcfg = cfg->gc_info;
1310
1311         return (slot * SIZEOF_SLOT) + gcfg->min_offset;
1312 }
1313
1314 static inline MONO_ALWAYS_INLINE void
1315 set_slot (MonoCompileGC *gcfg, int slot, int callsite_index, GCSlotType type)
1316 {
1317         g_assert (slot >= 0 && slot < gcfg->nslots);
1318
1319         if (type == SLOT_PIN) {
1320                 clear_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1321                 set_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1322         } else if (type == SLOT_REF) {
1323                 set_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1324                 clear_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1325         } else if (type == SLOT_NOREF) {
1326                 clear_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1327                 clear_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1328         }
1329 }
1330
1331 static inline void
1332 set_slot_everywhere (MonoCompileGC *gcfg, int slot, GCSlotType type)
1333 {
1334         int width, pos;
1335         guint8 *ref_bitmap, *pin_bitmap;
1336
1337         /*
1338         int cindex;
1339
1340         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1341                 set_slot (gcfg, slot, cindex, type);
1342         */
1343         ref_bitmap = gcfg->stack_ref_bitmap;
1344         pin_bitmap = gcfg->stack_pin_bitmap;
1345         width = gcfg->stack_bitmap_width;
1346         pos = width * slot;
1347
1348         if (type == SLOT_PIN) {
1349                 memset (ref_bitmap + pos, 0, width);
1350                 memset (pin_bitmap + pos, 0xff, width);
1351         } else if (type == SLOT_REF) {
1352                 memset (ref_bitmap + pos, 0xff, width);
1353                 memset (pin_bitmap + pos, 0, width);
1354         } else if (type == SLOT_NOREF) {
1355                 memset (ref_bitmap + pos, 0, width);
1356                 memset (pin_bitmap + pos, 0, width);
1357         }
1358 }
1359
1360 static inline void
1361 set_slot_in_range (MonoCompileGC *gcfg, int slot, int from, int to, GCSlotType type)
1362 {
1363         int cindex;
1364
1365         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1366                 int callsite_offset = gcfg->callsites [cindex]->pc_offset;
1367                 if (callsite_offset >= from && callsite_offset < to)
1368                         set_slot (gcfg, slot, cindex, type);
1369         }
1370 }
1371
1372 static inline void
1373 set_reg_slot (MonoCompileGC *gcfg, int slot, int callsite_index, GCSlotType type)
1374 {
1375         g_assert (slot >= 0 && slot < gcfg->nregs);
1376
1377         if (type == SLOT_PIN) {
1378                 clear_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1379                 set_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1380         } else if (type == SLOT_REF) {
1381                 set_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1382                 clear_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1383         } else if (type == SLOT_NOREF) {
1384                 clear_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1385                 clear_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1386         }
1387 }
1388
1389 static inline void
1390 set_reg_slot_everywhere (MonoCompileGC *gcfg, int slot, GCSlotType type)
1391 {
1392         int cindex;
1393
1394         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1395                 set_reg_slot (gcfg, slot, cindex, type);
1396 }
1397
1398 static inline void
1399 set_reg_slot_in_range (MonoCompileGC *gcfg, int slot, int from, int to, GCSlotType type)
1400 {
1401         int cindex;
1402
1403         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1404                 int callsite_offset = gcfg->callsites [cindex]->pc_offset;
1405                 if (callsite_offset >= from && callsite_offset < to)
1406                         set_reg_slot (gcfg, slot, cindex, type);
1407         }
1408 }
1409
1410 static void
1411 process_spill_slots (MonoCompile *cfg)
1412 {
1413         MonoCompileGC *gcfg = cfg->gc_info;
1414         MonoBasicBlock *bb;
1415         GSList *l;
1416         int i;
1417
1418         /* Mark all ref/pin spill slots as NOREF by default outside of their live range */
1419         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
1420                 for (l = bb->spill_slot_defs; l; l = l->next) {
1421                         MonoInst *def = l->data;
1422                         int spill_slot = def->inst_c0;
1423                         int bank = def->inst_c1;
1424                         int offset = cfg->spill_info [bank][spill_slot].offset;
1425                         int slot = fp_offset_to_slot (cfg, offset);
1426
1427                         if (bank == MONO_REG_INT_MP || bank == MONO_REG_INT_REF)
1428                                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1429                 }
1430         }
1431
1432         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
1433                 for (l = bb->spill_slot_defs; l; l = l->next) {
1434                         MonoInst *def = l->data;
1435                         int spill_slot = def->inst_c0;
1436                         int bank = def->inst_c1;
1437                         int offset = cfg->spill_info [bank][spill_slot].offset;
1438                         int slot = fp_offset_to_slot (cfg, offset);
1439                         GCSlotType type;
1440
1441                         if (bank == MONO_REG_INT_MP)
1442                                 type = SLOT_PIN;
1443                         else
1444                                 type = SLOT_REF;
1445
1446                         /*
1447                          * Extend the live interval for the GC tracked spill slots
1448                          * defined in this bblock.
1449                          * FIXME: This is not needed.
1450                          */
1451                         set_slot_in_range (gcfg, slot, def->backend.pc_offset, bb->native_offset + bb->native_length, type);
1452
1453                         if (cfg->verbose_level > 1)
1454                                 printf ("\t%s spill slot at %s0x%x(fp) (slot = %d)\n", slot_type_to_string (type), offset >= 0 ? "" : "-", ABS (offset), slot);
1455                 }
1456         }
1457
1458         /* Set fp spill slots to NOREF */
1459         for (i = 0; i < cfg->spill_info_len [MONO_REG_DOUBLE]; ++i) {
1460                 int offset = cfg->spill_info [MONO_REG_DOUBLE][i].offset;
1461                 int slot;
1462
1463                 if (offset == -1)
1464                         continue;
1465
1466                 slot = fp_offset_to_slot (cfg, offset);
1467
1468                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1469                 /* FIXME: 32 bit */
1470                 if (cfg->verbose_level > 1)
1471                         printf ("\tfp spill slot at %s0x%x(fp) (slot = %d)\n", offset >= 0 ? "" : "-", ABS (offset), slot);
1472         }
1473
1474         /* Set int spill slots to NOREF */
1475         for (i = 0; i < cfg->spill_info_len [MONO_REG_INT]; ++i) {
1476                 int offset = cfg->spill_info [MONO_REG_INT][i].offset;
1477                 int slot;
1478
1479                 if (offset == -1)
1480                         continue;
1481
1482                 slot = fp_offset_to_slot (cfg, offset);
1483
1484                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1485                 if (cfg->verbose_level > 1)
1486                         printf ("\tint spill slot at %s0x%x(fp) (slot = %d)\n", offset >= 0 ? "" : "-", ABS (offset), slot);
1487         }
1488 }
1489
1490 /*
1491  * process_other_slots:
1492  *
1493  *   Process stack slots registered using mini_gc_set_slot_type_... ().
1494  */
1495 static void
1496 process_other_slots (MonoCompile *cfg)
1497 {
1498         MonoCompileGC *gcfg = cfg->gc_info;
1499         GSList *l;
1500
1501         /* Relative to the CFA */
1502         for (l = gcfg->stack_slots_from_cfa; l; l = l->next) {
1503                 guint data = GPOINTER_TO_UINT (l->data);
1504                 int cfa_slot = data >> 16;
1505                 GCSlotType type = data & 0xff;
1506                 int slot;
1507
1508                 /*
1509                  * Map the cfa relative slot to an fp relative slot.
1510                  * slot_addr == cfa - <cfa_slot>*4/8
1511                  * fp + cfa_offset == cfa
1512                  * -> slot_addr == fp + (cfa_offset - <cfa_slot>*4/8)
1513                  */
1514                 slot = (cfg->cfa_offset / SIZEOF_SLOT) - cfa_slot - (gcfg->min_offset / SIZEOF_SLOT);
1515
1516                 set_slot_everywhere (gcfg, slot, type);
1517
1518                 if (cfg->verbose_level > 1) {
1519                         int fp_offset = slot_to_fp_offset (cfg, slot);
1520                         if (type == SLOT_NOREF)
1521                                 printf ("\tnoref slot at %s0x%x(fp) (slot = %d) (cfa - 0x%x)\n", fp_offset >= 0 ? "" : "-", ABS (fp_offset), slot, (int)(cfa_slot * SIZEOF_SLOT));
1522                 }
1523         }
1524
1525         /* Relative to the FP */
1526         for (l = gcfg->stack_slots_from_fp; l; l = l->next) {
1527                 gint data = GPOINTER_TO_INT (l->data);
1528                 int offset = data >> 16;
1529                 GCSlotType type = data & 0xff;
1530                 int slot;
1531
1532                 slot = fp_offset_to_slot (cfg, offset);
1533
1534                 set_slot_everywhere (gcfg, slot, type);
1535
1536                 /* Liveness for these slots is handled by process_spill_slots () */
1537
1538                 if (cfg->verbose_level > 1) {
1539                         if (type == SLOT_REF)
1540                                 printf ("\tref slot at fp+0x%x (slot = %d)\n", offset, slot);
1541                         else if (type == SLOT_NOREF)
1542                                 printf ("\tnoref slot at 0x%x(fp) (slot = %d)\n", offset, slot);
1543                 }
1544         }
1545 }
1546
1547 static gsize*
1548 get_vtype_bitmap (MonoType *t, int *numbits)
1549 {
1550         MonoClass *klass = mono_class_from_mono_type (t);
1551
1552         if (klass->generic_container || mono_class_is_open_constructed_type (t)) {
1553                 /* FIXME: Generic sharing */
1554                 return NULL;
1555         } else {
1556                 mono_class_compute_gc_descriptor (klass);
1557
1558                 return mono_gc_get_bitmap_for_descr (klass->gc_descr, numbits);
1559         }
1560 }
1561
1562 static inline const char*
1563 get_offset_sign (int offset)
1564 {
1565         return offset < 0 ? "-" : "+";
1566 }
1567
1568 static inline int
1569 get_offset_val (int offset)
1570 {
1571         return offset < 0 ? (- offset) : offset;
1572 }
1573
1574 static void
1575 process_variables (MonoCompile *cfg)
1576 {
1577         MonoCompileGC *gcfg = cfg->gc_info;
1578         MonoMethodSignature *sig = mono_method_signature (cfg->method);
1579         int i, locals_min_slot, locals_max_slot, cindex;
1580         MonoBasicBlock *bb;
1581         MonoInst *tmp;
1582         int *pc_offsets;
1583         int locals_min_offset = gcfg->locals_min_offset;
1584         int locals_max_offset = gcfg->locals_max_offset;
1585
1586         /* Slots for locals are NOREF by default */
1587         locals_min_slot = (locals_min_offset - gcfg->min_offset) / SIZEOF_SLOT;
1588         locals_max_slot = (locals_max_offset - gcfg->min_offset) / SIZEOF_SLOT;
1589         for (i = locals_min_slot; i < locals_max_slot; ++i) {
1590                 set_slot_everywhere (gcfg, i, SLOT_NOREF);
1591         }
1592
1593         /*
1594          * Compute the offset where variables are initialized in the first bblock, if any.
1595          */
1596         pc_offsets = g_new0 (int, cfg->next_vreg);
1597
1598         bb = cfg->bb_entry->next_bb;
1599         MONO_BB_FOR_EACH_INS (bb, tmp) {
1600                 if (tmp->opcode == OP_GC_LIVENESS_DEF) {
1601                         int vreg = tmp->inst_c1;
1602                         if (pc_offsets [vreg] == 0) {
1603                                 g_assert (tmp->backend.pc_offset > 0);
1604                                 pc_offsets [vreg] = tmp->backend.pc_offset;
1605                         }
1606                 }
1607         }
1608
1609         /*
1610          * Stack slots holding arguments are initialized in the prolog.
1611          * This means we can treat them alive for the whole method.
1612          */
1613         for (i = 0; i < cfg->num_varinfo; i++) {
1614                 MonoInst *ins = cfg->varinfo [i];
1615                 MonoType *t = ins->inst_vtype;
1616                 MonoMethodVar *vmv;
1617                 guint32 pos;
1618                 gboolean byref, is_this = FALSE;
1619                 gboolean is_arg = i < cfg->locals_start;
1620
1621                 if (ins == cfg->ret) {
1622                         if (!(ins->opcode == OP_REGOFFSET && MONO_TYPE_ISSTRUCT (t)))
1623                                 continue;
1624                 }
1625
1626                 vmv = MONO_VARINFO (cfg, i);
1627
1628                 /* For some reason, 'this' is byref */
1629                 if (sig->hasthis && ins == cfg->args [0] && !cfg->method->klass->valuetype) {
1630                         t = &cfg->method->klass->byval_arg;
1631                         is_this = TRUE;
1632                 }
1633
1634                 byref = t->byref;
1635
1636                 if (ins->opcode == OP_REGVAR) {
1637                         int hreg;
1638                         GCSlotType slot_type;
1639
1640                         t = mini_type_get_underlying_type (NULL, t);
1641
1642                         hreg = ins->dreg;
1643                         g_assert (hreg < MONO_MAX_IREGS);
1644
1645                         if (byref)
1646                                 slot_type = SLOT_PIN;
1647                         else
1648                                 slot_type = mini_type_is_reference (cfg, t) ? SLOT_REF : SLOT_NOREF;
1649
1650                         if (slot_type == SLOT_PIN) {
1651                                 /* These have no live interval, be conservative */
1652                                 set_reg_slot_everywhere (gcfg, hreg, slot_type);
1653                         } else {
1654                                 /*
1655                                  * Unlike variables allocated to the stack, we generate liveness info
1656                                  * for noref vars in registers in mono_spill_global_vars (), because
1657                                  * knowing that a register doesn't contain a ref allows us to mark its save
1658                                  * locations precisely.
1659                                  */
1660                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1661                                         if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1662                                                 set_reg_slot (gcfg, hreg, cindex, slot_type);
1663                         }
1664
1665                         if (cfg->verbose_level > 1) {
1666                                 printf ("\t%s %sreg %s(R%d)\n", slot_type_to_string (slot_type), is_arg ? "arg " : "", mono_arch_regname (hreg), vmv->vreg);
1667                         }
1668
1669                         continue;
1670                 }
1671
1672                 if (ins->opcode != OP_REGOFFSET)
1673                         continue;
1674
1675                 if (ins->inst_offset % SIZEOF_SLOT != 0)
1676                         continue;
1677
1678                 pos = fp_offset_to_slot (cfg, ins->inst_offset);
1679
1680                 if (is_arg && ins->flags & MONO_INST_IS_DEAD) {
1681                         /* These do not get stored in the prolog */
1682                         set_slot_everywhere (gcfg, pos, SLOT_NOREF);
1683
1684                         if (cfg->verbose_level > 1) {
1685                                 printf ("\tdead arg at fp%s0x%x (slot = %d): %s\n", get_offset_sign (ins->inst_offset), get_offset_val (ins->inst_offset), pos, mono_type_full_name (ins->inst_vtype));
1686                         }
1687                         continue;
1688                 }
1689
1690                 if (MONO_TYPE_ISSTRUCT (t)) {
1691                         int numbits = 0, j;
1692                         gsize *bitmap = NULL;
1693                         gboolean pin = FALSE;
1694                         int size;
1695                         int size_in_slots;
1696
1697                         if (ins->backend.is_pinvoke)
1698                                 size = mono_class_native_size (ins->klass, NULL);
1699                         else
1700                                 size = mono_class_value_size (ins->klass, NULL);
1701                         size_in_slots = ALIGN_TO (size, SIZEOF_SLOT) / SIZEOF_SLOT;
1702
1703                         if (cfg->verbose_level > 1)
1704                                 printf ("\tvtype R%d at %s0x%x(fp)-%s0x%x(fp) (slot %d-%d): %s\n", vmv->vreg, get_offset_sign (ins->inst_offset), get_offset_val (ins->inst_offset), get_offset_sign (ins->inst_offset), get_offset_val (ins->inst_offset + (size_in_slots * SIZEOF_SLOT)), pos, pos + size_in_slots, mono_type_full_name (ins->inst_vtype));
1705
1706                         if (!ins->klass->has_references) {
1707                                 if (is_arg) {
1708                                         for (j = 0; j < size_in_slots; ++j)
1709                                                 set_slot_everywhere (gcfg, pos + j, SLOT_NOREF);
1710                                 }
1711                                 continue;
1712                         }
1713
1714                         bitmap = get_vtype_bitmap (t, &numbits);
1715                         if (!bitmap)
1716                                 pin = TRUE;
1717
1718                         /*
1719                          * Most vtypes are marked volatile because of the LDADDR instructions,
1720                          * and they have no liveness information since they are decomposed
1721                          * before the liveness pass. We emit OP_GC_LIVENESS_DEF instructions for
1722                          * them during VZERO decomposition.
1723                          */
1724                         if (!is_arg) {
1725                                 if (!pc_offsets [vmv->vreg])
1726                                         pin = TRUE;
1727
1728                                 if (ins->backend.is_pinvoke)
1729                                         pin = TRUE;
1730                         }
1731
1732                         if (bitmap) {
1733                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1734                                         if (gcfg->callsites [cindex]->pc_offset > pc_offsets [vmv->vreg]) {
1735                                                 for (j = 0; j < numbits; ++j) {
1736                                                         if (bitmap [j / GC_BITS_PER_WORD] & ((gsize)1 << (j % GC_BITS_PER_WORD))) {
1737                                                                 /* The descriptor is for the boxed object */
1738                                                                 set_slot (gcfg, (pos + j - (sizeof (MonoObject) / SIZEOF_SLOT)), cindex, pin ? SLOT_PIN : SLOT_REF);
1739                                                         }
1740                                                 }
1741                                         }
1742                                 }
1743
1744                                 if (cfg->verbose_level > 1) {
1745                                         for (j = 0; j < numbits; ++j) {
1746                                                 if (bitmap [j / GC_BITS_PER_WORD] & ((gsize)1 << (j % GC_BITS_PER_WORD)))
1747                                                         printf ("\t\t%s slot at 0x%x(fp) (slot = %d)\n", pin ? "pin" : "ref", (int)(ins->inst_offset + (j * SIZEOF_SLOT)), (int)(pos + j - (sizeof (MonoObject) / SIZEOF_SLOT)));
1748                                         }
1749                                 }
1750                         } else {
1751                                 if (cfg->verbose_level > 1)
1752                                         printf ("\t\tpinned\n");
1753                                 for (j = 0; j < size_in_slots; ++j) {
1754                                         set_slot_everywhere (gcfg, pos + j, SLOT_PIN);
1755                                 }
1756                         }
1757
1758                         g_free (bitmap);
1759
1760                         continue;
1761                 }
1762
1763                 if (!is_arg && (ins->inst_offset < gcfg->min_offset || ins->inst_offset >= gcfg->max_offset))
1764                         /* Vret addr etc. */
1765                         continue;
1766
1767                 if (t->byref) {
1768                         if (is_arg) {
1769                                 set_slot_everywhere (gcfg, pos, SLOT_PIN);
1770                         } else {
1771                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1772                                         if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1773                                                 set_slot (gcfg, pos, cindex, SLOT_PIN);
1774                         }
1775                         if (cfg->verbose_level > 1)
1776                                 printf ("\tbyref at %s0x%x(fp) (R%d, slot = %d): %s\n", ins->inst_offset < 0 ? "-" : "", (ins->inst_offset < 0) ? -(int)ins->inst_offset : (int)ins->inst_offset, vmv->vreg, pos, mono_type_full_name (ins->inst_vtype));
1777                         continue;
1778                 }
1779
1780                 /*
1781                  * This is currently disabled, but could be enabled to debug crashes.
1782                  */
1783 #if 0
1784                 if (t->type == MONO_TYPE_I) {
1785                         /*
1786                          * Variables created in mono_handle_global_vregs have type I, but they
1787                          * could hold GC refs since the vregs they were created from might not been
1788                          * marked as holding a GC ref. So be conservative.
1789                          */
1790                         set_slot_everywhere (gcfg, pos, SLOT_PIN);
1791                         continue;
1792                 }
1793 #endif
1794
1795                 t = mini_type_get_underlying_type (NULL, t);
1796
1797                 if (!mini_type_is_reference (cfg, t)) {
1798                         set_slot_everywhere (gcfg, pos, SLOT_NOREF);
1799                         if (cfg->verbose_level > 1)
1800                                 printf ("\tnoref%s at %s0x%x(fp) (R%d, slot = %d): %s\n", (is_arg ? " arg" : ""), ins->inst_offset < 0 ? "-" : "", (ins->inst_offset < 0) ? -(int)ins->inst_offset : (int)ins->inst_offset, vmv->vreg, pos, mono_type_full_name (ins->inst_vtype));
1801                         if (!t->byref && sizeof (mgreg_t) == 4 && (t->type == MONO_TYPE_I8 || t->type == MONO_TYPE_U8 || t->type == MONO_TYPE_R8)) {
1802                                 set_slot_everywhere (gcfg, pos + 1, SLOT_NOREF);
1803                                 if (cfg->verbose_level > 1)
1804                                         printf ("\tnoref at %s0x%x(fp) (R%d, slot = %d): %s\n", ins->inst_offset < 0 ? "-" : "", (ins->inst_offset < 0) ? -(int)(ins->inst_offset + 4) : (int)ins->inst_offset + 4, vmv->vreg, pos + 1, mono_type_full_name (ins->inst_vtype));
1805                         }
1806                         continue;
1807                 }
1808
1809                 /* 'this' is marked INDIRECT for gshared methods */
1810                 if (ins->flags & (MONO_INST_VOLATILE | MONO_INST_INDIRECT) && !is_this) {
1811                         /*
1812                          * For volatile variables, treat them alive from the point they are
1813                          * initialized in the first bblock until the end of the method.
1814                          */
1815                         if (is_arg) {
1816                                 set_slot_everywhere (gcfg, pos, SLOT_REF);
1817                         } else if (pc_offsets [vmv->vreg]) {
1818                                 set_slot_in_range (gcfg, pos, 0, pc_offsets [vmv->vreg], SLOT_PIN);
1819                                 set_slot_in_range (gcfg, pos, pc_offsets [vmv->vreg], cfg->code_size, SLOT_REF);
1820                         } else {
1821                                 set_slot_everywhere (gcfg, pos, SLOT_PIN);
1822                         }
1823                         if (cfg->verbose_level > 1)
1824                                 printf ("\tvolatile ref at %s0x%x(fp) (R%d, slot = %d): %s\n", ins->inst_offset < 0 ? "-" : "", (ins->inst_offset < 0) ? -(int)ins->inst_offset : (int)ins->inst_offset, vmv->vreg, pos, mono_type_full_name (ins->inst_vtype));
1825                         continue;
1826                 }
1827
1828                 if (is_arg) {
1829                         /* Live for the whole method */
1830                         set_slot_everywhere (gcfg, pos, SLOT_REF);
1831                 } else {
1832                         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1833                                 if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1834                                         set_slot (gcfg, pos, cindex, SLOT_REF);
1835                 }
1836
1837                 if (cfg->verbose_level > 1) {
1838                         printf ("\tref%s at %s0x%x(fp) (R%d, slot = %d): %s\n", (is_arg ? " arg" : ""), ins->inst_offset < 0 ? "-" : "", (ins->inst_offset < 0) ? -(int)ins->inst_offset : (int)ins->inst_offset, vmv->vreg, pos, mono_type_full_name (ins->inst_vtype));
1839                 }
1840         }
1841
1842         g_free (pc_offsets);
1843 }
1844
1845 static int
1846 sp_offset_to_fp_offset (MonoCompile *cfg, int sp_offset)
1847 {
1848         /*
1849          * Convert a sp relative offset to a slot index. This is
1850          * platform specific.
1851          */
1852 #ifdef TARGET_AMD64
1853         /* fp = sp + offset */
1854         g_assert (cfg->frame_reg == AMD64_RBP);
1855         return (- cfg->arch.sp_fp_offset + sp_offset);
1856 #elif defined(TARGET_X86)
1857         /* The offset is computed from the sp at the start of the call sequence */
1858         g_assert (cfg->frame_reg == X86_EBP);
1859         return (- cfg->arch.sp_fp_offset - sp_offset);
1860 #else
1861         NOT_IMPLEMENTED;
1862         return -1;
1863 #endif
1864 }
1865
1866 static void
1867 process_param_area_slots (MonoCompile *cfg)
1868 {
1869         MonoCompileGC *gcfg = cfg->gc_info;
1870         int cindex, i;
1871         gboolean *is_param;
1872
1873         /*
1874          * These slots are used for passing parameters during calls. They are sp relative, not
1875          * fp relative, so they are harder to handle.
1876          */
1877         if (cfg->flags & MONO_CFG_HAS_ALLOCA)
1878                 /* The distance between fp and sp is not constant */
1879                 return;
1880
1881         is_param = mono_mempool_alloc0 (cfg->mempool, gcfg->nslots * sizeof (gboolean));
1882
1883         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1884                 GCCallSite *callsite = gcfg->callsites [cindex];
1885                 GSList *l;
1886
1887                 for (l = callsite->param_slots; l; l = l->next) {
1888                         MonoInst *def = l->data;
1889                         MonoType *t = def->inst_vtype;
1890                         int sp_offset = def->inst_offset;
1891                         int fp_offset = sp_offset_to_fp_offset (cfg, sp_offset);
1892                         int slot = fp_offset_to_slot (cfg, fp_offset);
1893                         guint32 align;
1894                         guint32 size;
1895
1896                         if (MONO_TYPE_ISSTRUCT (t)) {
1897                                 size = mini_type_stack_size_full (cfg->generic_sharing_context, t, &align, FALSE);
1898                         } else {
1899                                 size = sizeof (mgreg_t);
1900                         }
1901
1902                         for (i = 0; i < size / sizeof (mgreg_t); ++i) {
1903                                 g_assert (slot + i >= 0 && slot + i < gcfg->nslots);
1904                                 is_param [slot + i] = TRUE;
1905                         }
1906                 }
1907         }
1908
1909         /* All param area slots are noref by default */
1910         for (i = 0; i < gcfg->nslots; ++i) {
1911                 if (is_param [i])
1912                         set_slot_everywhere (gcfg, i, SLOT_NOREF);
1913         }
1914
1915         /*
1916          * We treat param area slots as being part of the callee's frame, to be able to handle tail calls which overwrite
1917          * the argument area of the caller.
1918          */
1919 }
1920
1921 static void
1922 process_finally_clauses (MonoCompile *cfg)
1923 {
1924         MonoCompileGC *gcfg = cfg->gc_info;
1925         GCCallSite **callsites;
1926         int ncallsites;
1927         gboolean has_finally;
1928         int i, j, nslots, nregs;
1929
1930         ncallsites = gcfg->ncallsites;
1931         nslots = gcfg->nslots;
1932         nregs = gcfg->nregs;
1933         callsites = gcfg->callsites;
1934
1935         /*
1936          * The calls to the finally clauses don't show up in the cfg. See
1937          * test_0_liveness_8 ().
1938          * Variables accessed inside the finally clause are already marked VOLATILE by
1939          * mono_liveness_handle_exception_clauses (). Variables not accessed inside the finally clause have
1940          * correct liveness outside the finally clause. So mark them PIN inside the finally clauses.
1941          */
1942         has_finally = FALSE;
1943         for (i = 0; i < cfg->header->num_clauses; ++i) {
1944                 MonoExceptionClause *clause = &cfg->header->clauses [i];
1945
1946                 if (clause->flags == MONO_EXCEPTION_CLAUSE_FINALLY) {
1947                         has_finally = TRUE;
1948                 }
1949         }
1950         if (has_finally) {
1951                 if (cfg->verbose_level > 1)
1952                         printf ("\tMethod has finally clauses, pessimizing live ranges.\n");
1953                 for (j = 0; j < ncallsites; ++j) {
1954                         MonoBasicBlock *bb = callsites [j]->bb;
1955                         MonoExceptionClause *clause;
1956                         gboolean is_in_finally = FALSE;
1957
1958                         for (i = 0; i < cfg->header->num_clauses; ++i) {
1959                                 clause = &cfg->header->clauses [i];
1960
1961                                 if (MONO_OFFSET_IN_HANDLER (clause, bb->real_offset)) {
1962                                         if (clause->flags == MONO_EXCEPTION_CLAUSE_FINALLY) {
1963                                                 is_in_finally = TRUE;
1964                                                 break;
1965                                         }
1966                                 }
1967                         }
1968
1969                         if (is_in_finally) {
1970                                 for (i = 0; i < nslots; ++i)
1971                                         set_slot (gcfg, i, j, SLOT_PIN);
1972                                 for (i = 0; i < nregs; ++i)
1973                                         set_reg_slot (gcfg, i, j, SLOT_PIN);
1974                         }
1975                 }
1976         }
1977 }
1978
1979 static void
1980 compute_frame_size (MonoCompile *cfg)
1981 {
1982         int i, locals_min_offset, locals_max_offset, cfa_min_offset, cfa_max_offset;
1983         int min_offset, max_offset;
1984         MonoCompileGC *gcfg = cfg->gc_info;
1985         MonoMethodSignature *sig = mono_method_signature (cfg->method);
1986         GSList *l;
1987
1988         /* Compute min/max offsets from the fp */
1989
1990         /* Locals */
1991 #if defined(TARGET_AMD64) || defined(TARGET_X86) || defined(TARGET_ARM) || defined(TARGET_S390X)
1992         locals_min_offset = ALIGN_TO (cfg->locals_min_stack_offset, SIZEOF_SLOT);
1993         locals_max_offset = cfg->locals_max_stack_offset;
1994 #else
1995         /* min/max stack offset needs to be computed in mono_arch_allocate_vars () */
1996         NOT_IMPLEMENTED;
1997 #endif
1998
1999         locals_min_offset = ALIGN_TO (locals_min_offset, SIZEOF_SLOT);
2000         locals_max_offset = ALIGN_TO (locals_max_offset, SIZEOF_SLOT);
2001
2002         min_offset = locals_min_offset;
2003         max_offset = locals_max_offset;
2004
2005         /* Arguments */
2006         for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
2007                 MonoInst *ins = cfg->args [i];
2008
2009                 if (ins->opcode == OP_REGOFFSET) {
2010                         int size, size_in_slots;
2011                         size = mini_type_stack_size_full (cfg->generic_sharing_context, ins->inst_vtype, NULL, ins->backend.is_pinvoke);
2012                         size_in_slots = ALIGN_TO (size, SIZEOF_SLOT) / SIZEOF_SLOT;
2013
2014                         min_offset = MIN (min_offset, ins->inst_offset);
2015                         max_offset = MAX ((int)max_offset, (int)(ins->inst_offset + (size_in_slots * SIZEOF_SLOT)));
2016                 }
2017         }
2018
2019         /* Cfa slots */
2020         g_assert (cfg->frame_reg == cfg->cfa_reg);
2021         g_assert (cfg->cfa_offset > 0);
2022         cfa_min_offset = 0;
2023         cfa_max_offset = cfg->cfa_offset;
2024
2025         min_offset = MIN (min_offset, cfa_min_offset);
2026         max_offset = MAX (max_offset, cfa_max_offset);
2027
2028         /* Fp relative slots */
2029         for (l = gcfg->stack_slots_from_fp; l; l = l->next) {
2030                 gint data = GPOINTER_TO_INT (l->data);
2031                 int offset = data >> 16;
2032
2033                 min_offset = MIN (min_offset, offset);
2034         }
2035
2036         /* Spill slots */
2037         if (!(cfg->flags & MONO_CFG_HAS_SPILLUP)) {
2038                 int stack_offset = ALIGN_TO (cfg->stack_offset, SIZEOF_SLOT);
2039                 min_offset = MIN (min_offset, (-stack_offset));
2040         }
2041
2042         /* Param area slots */
2043 #ifdef TARGET_AMD64
2044         min_offset = MIN (min_offset, -cfg->arch.sp_fp_offset);
2045 #elif defined(TARGET_X86)
2046         min_offset = MIN (min_offset, - (cfg->arch.sp_fp_offset + cfg->arch.param_area_size));
2047 #elif defined(TARGET_ARM)
2048         // FIXME:
2049 #elif defined(TARGET_s390X)
2050         // FIXME:
2051 #else
2052         NOT_IMPLEMENTED;
2053 #endif
2054
2055         gcfg->min_offset = min_offset;
2056         gcfg->max_offset = max_offset;
2057         gcfg->locals_min_offset = locals_min_offset;
2058         gcfg->locals_max_offset = locals_max_offset;
2059 }
2060
2061 static void
2062 init_gcfg (MonoCompile *cfg)
2063 {
2064         int i, nregs, nslots;
2065         MonoCompileGC *gcfg = cfg->gc_info;
2066         GCCallSite **callsites;
2067         int ncallsites;
2068         MonoBasicBlock *bb;
2069         GSList *l;
2070
2071         /*
2072          * Collect callsites
2073          */
2074         ncallsites = 0;
2075         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
2076                 ncallsites += g_slist_length (bb->gc_callsites);
2077         }
2078         callsites = mono_mempool_alloc0 (cfg->mempool, ncallsites * sizeof (GCCallSite*));
2079         i = 0;
2080         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
2081                 for (l = bb->gc_callsites; l; l = l->next)
2082                         callsites [i++] = l->data;
2083         }
2084
2085         /* The callsites should already be ordered by pc offset */
2086         for (i = 1; i < ncallsites; ++i)
2087                 g_assert (callsites [i - 1]->pc_offset < callsites [i]->pc_offset);
2088
2089         /*
2090          * The stack frame looks like this:
2091          *
2092          * <fp + max_offset> == cfa ->  <end of previous frame>
2093          *                              <other stack slots>
2094          *                              <locals>
2095          *                              <other stack slots>
2096          * fp + min_offset          ->
2097          * ...
2098          * fp                       ->
2099          */
2100
2101         if (cfg->verbose_level > 1)
2102                 printf ("GC Map for %s: 0x%x-0x%x\n", mono_method_full_name (cfg->method, TRUE), gcfg->min_offset, gcfg->max_offset);
2103
2104         nslots = (gcfg->max_offset - gcfg->min_offset) / SIZEOF_SLOT;
2105         nregs = NREGS;
2106
2107         gcfg->nslots = nslots;
2108         gcfg->nregs = nregs;
2109         gcfg->callsites = callsites;
2110         gcfg->ncallsites = ncallsites;
2111         gcfg->stack_bitmap_width = ALIGN_TO (ncallsites, 8) / 8;
2112         gcfg->reg_bitmap_width = ALIGN_TO (ncallsites, 8) / 8;
2113         gcfg->stack_ref_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->stack_bitmap_width * nslots);
2114         gcfg->stack_pin_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->stack_bitmap_width * nslots);
2115         gcfg->reg_ref_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->reg_bitmap_width * nregs);
2116         gcfg->reg_pin_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->reg_bitmap_width * nregs);
2117
2118         /* All slots start out as PIN */
2119         memset (gcfg->stack_pin_bitmap, 0xff, gcfg->stack_bitmap_width * nregs);
2120         for (i = 0; i < nregs; ++i) {
2121                 /*
2122                  * By default, registers are NOREF.
2123                  * It is possible for a callee to save them before being defined in this method,
2124                  * but the saved value is dead too, so it doesn't need to be marked.
2125                  */
2126                 if ((cfg->used_int_regs & (1 << i)))
2127                         set_reg_slot_everywhere (gcfg, i, SLOT_NOREF);
2128         }
2129 }
2130
2131 static inline gboolean
2132 has_bit_set (guint8 *bitmap, int width, int slot)
2133 {
2134         int i;
2135         int pos = width * slot;
2136
2137         for (i = 0; i < width; ++i) {
2138                 if (bitmap [pos + i])
2139                         break;
2140         }
2141         return i < width;
2142 }
2143
2144 static void
2145 create_map (MonoCompile *cfg)
2146 {
2147         GCMap *map;
2148         int i, j, nregs, nslots, nref_regs, npin_regs, alloc_size, bitmaps_size, bitmaps_offset;
2149         int ntypes [16];
2150         int stack_bitmap_width, stack_bitmap_size, reg_ref_bitmap_width, reg_ref_bitmap_size;
2151         int reg_pin_bitmap_width, reg_pin_bitmap_size, bindex;
2152         int start, end;
2153         gboolean has_ref_slots, has_pin_slots, has_ref_regs, has_pin_regs;
2154         MonoCompileGC *gcfg = cfg->gc_info;
2155         GCCallSite **callsites;
2156         int ncallsites;
2157         guint8 *bitmap, *bitmaps;
2158         guint32 reg_ref_mask, reg_pin_mask;
2159
2160         ncallsites = gcfg->ncallsites;
2161         nslots = gcfg->nslots;
2162         nregs = gcfg->nregs;
2163         callsites = gcfg->callsites;
2164
2165         /*
2166          * Compute the real size of the bitmap i.e. ignore NOREF columns at the beginning and at
2167          * the end. Also, compute whenever the map needs ref/pin bitmaps, and collect stats.
2168          */
2169         has_ref_slots = FALSE;
2170         has_pin_slots = FALSE;
2171         start = -1;
2172         end = -1;
2173         memset (ntypes, 0, sizeof (ntypes));
2174         for (i = 0; i < nslots; ++i) {
2175                 gboolean has_ref = FALSE;
2176                 gboolean has_pin = FALSE;
2177
2178                 if (has_bit_set (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, i))
2179                         has_pin = TRUE;
2180                 if (has_bit_set (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, i))
2181                         has_ref = TRUE;
2182
2183                 if (has_ref)
2184                         has_ref_slots = TRUE;
2185                 if (has_pin)
2186                         has_pin_slots = TRUE;
2187
2188                 if (has_ref)
2189                         ntypes [SLOT_REF] ++;
2190                 else if (has_pin)
2191                         ntypes [SLOT_PIN] ++;
2192                 else
2193                         ntypes [SLOT_NOREF] ++;
2194
2195                 if (has_ref || has_pin) {
2196                         if (start == -1)
2197                                 start = i;
2198                         end = i + 1;
2199                 }
2200         }
2201         if (start == -1) {
2202                 start = end = nslots;
2203         } else {
2204                 g_assert (start != -1);
2205                 g_assert (start < end);
2206         }
2207
2208         has_ref_regs = FALSE;
2209         has_pin_regs = FALSE;
2210         reg_ref_mask = 0;
2211         reg_pin_mask = 0;
2212         nref_regs = 0;
2213         npin_regs = 0;
2214         for (i = 0; i < nregs; ++i) {
2215                 gboolean has_ref = FALSE;
2216                 gboolean has_pin = FALSE;
2217
2218                 if (!(cfg->used_int_regs & (1 << i)))
2219                         continue;
2220
2221                 if (has_bit_set (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, i))
2222                         has_pin = TRUE;
2223                 if (has_bit_set (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, i))
2224                         has_ref = TRUE;
2225
2226                 if (has_ref) {
2227                         reg_ref_mask |= (1 << i);
2228                         has_ref_regs = TRUE;
2229                         nref_regs ++;
2230                 }
2231                 if (has_pin) {
2232                         reg_pin_mask |= (1 << i);
2233                         has_pin_regs = TRUE;
2234                         npin_regs ++;
2235                 }
2236         }
2237
2238         if (cfg->verbose_level > 1)
2239                 printf ("Slots: %d Start: %d End: %d Refs: %d NoRefs: %d Pin: %d Callsites: %d\n", nslots, start, end, ntypes [SLOT_REF], ntypes [SLOT_NOREF], ntypes [SLOT_PIN], ncallsites);
2240
2241         /* Create the GC Map */
2242
2243         /* The work bitmaps have one row for each slot, since this is how we access them during construction */
2244         stack_bitmap_width = ALIGN_TO (end - start, 8) / 8;
2245         stack_bitmap_size = stack_bitmap_width * ncallsites;
2246         reg_ref_bitmap_width = ALIGN_TO (nref_regs, 8) / 8;
2247         reg_ref_bitmap_size = reg_ref_bitmap_width * ncallsites;
2248         reg_pin_bitmap_width = ALIGN_TO (npin_regs, 8) / 8;
2249         reg_pin_bitmap_size = reg_pin_bitmap_width * ncallsites;
2250         bitmaps_size = (has_ref_slots ? stack_bitmap_size : 0) + (has_pin_slots ? stack_bitmap_size : 0) + (has_ref_regs ? reg_ref_bitmap_size : 0) + (has_pin_regs ? reg_pin_bitmap_size : 0);
2251
2252         map = mono_mempool_alloc0 (cfg->mempool, sizeof (GCMap));
2253
2254         map->frame_reg = cfg->frame_reg;
2255         map->start_offset = gcfg->min_offset;
2256         map->end_offset = gcfg->min_offset + (nslots * SIZEOF_SLOT);
2257         map->map_offset = start * SIZEOF_SLOT;
2258         map->nslots = end - start;
2259         map->has_ref_slots = has_ref_slots;
2260         map->has_pin_slots = has_pin_slots;
2261         map->has_ref_regs = has_ref_regs;
2262         map->has_pin_regs = has_pin_regs;
2263         g_assert (nregs < 32);
2264         map->used_int_regs = cfg->used_int_regs;
2265         map->reg_ref_mask = reg_ref_mask;
2266         map->reg_pin_mask = reg_pin_mask;
2267         map->nref_regs = nref_regs;
2268         map->npin_regs = npin_regs;
2269
2270         bitmaps = mono_mempool_alloc0 (cfg->mempool, bitmaps_size);
2271
2272         bitmaps_offset = 0;
2273         if (has_ref_slots) {
2274                 map->stack_ref_bitmap_offset = bitmaps_offset;
2275                 bitmaps_offset += stack_bitmap_size;
2276
2277                 bitmap = &bitmaps [map->stack_ref_bitmap_offset];
2278                 for (i = 0; i < nslots; ++i) {
2279                         for (j = 0; j < ncallsites; ++j) {
2280                                 if (get_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, i, j))
2281                                         set_bit (bitmap, stack_bitmap_width, j, i - start);
2282                         }
2283                 }
2284         }
2285         if (has_pin_slots) {
2286                 map->stack_pin_bitmap_offset = bitmaps_offset;
2287                 bitmaps_offset += stack_bitmap_size;
2288
2289                 bitmap = &bitmaps [map->stack_pin_bitmap_offset];
2290                 for (i = 0; i < nslots; ++i) {
2291                         for (j = 0; j < ncallsites; ++j) {
2292                                 if (get_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, i, j))
2293                                         set_bit (bitmap, stack_bitmap_width, j, i - start);
2294                         }
2295                 }
2296         }
2297         if (has_ref_regs) {
2298                 map->reg_ref_bitmap_offset = bitmaps_offset;
2299                 bitmaps_offset += reg_ref_bitmap_size;
2300
2301                 bitmap = &bitmaps [map->reg_ref_bitmap_offset];
2302                 bindex = 0;
2303                 for (i = 0; i < nregs; ++i) {
2304                         if (reg_ref_mask & (1 << i)) {
2305                                 for (j = 0; j < ncallsites; ++j) {
2306                                         if (get_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, i, j))
2307                                                 set_bit (bitmap, reg_ref_bitmap_width, j, bindex);
2308                                 }
2309                                 bindex ++;
2310                         }
2311                 }
2312         }
2313         if (has_pin_regs) {
2314                 map->reg_pin_bitmap_offset = bitmaps_offset;
2315                 bitmaps_offset += reg_pin_bitmap_size;
2316
2317                 bitmap = &bitmaps [map->reg_pin_bitmap_offset];
2318                 bindex = 0;
2319                 for (i = 0; i < nregs; ++i) {
2320                         if (reg_pin_mask & (1 << i)) {
2321                                 for (j = 0; j < ncallsites; ++j) {
2322                                         if (get_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, i, j))
2323                                                 set_bit (bitmap, reg_pin_bitmap_width, j, bindex);
2324                                 }
2325                                 bindex ++;
2326                         }
2327                 }
2328         }
2329
2330         /* Call sites */
2331         map->ncallsites = ncallsites;
2332         if (cfg->code_len < 256)
2333                 map->callsite_entry_size = 1;
2334         else if (cfg->code_len < 65536)
2335                 map->callsite_entry_size = 2;
2336         else
2337                 map->callsite_entry_size = 4;
2338
2339         /* Encode the GC Map */
2340         {
2341                 guint8 buf [256];
2342                 guint8 *endbuf;
2343                 GCEncodedMap *emap;
2344                 int encoded_size;
2345                 guint8 *p;
2346
2347                 encode_gc_map (map, buf, &endbuf);
2348                 g_assert (endbuf - buf < 256);
2349
2350                 encoded_size = endbuf - buf;
2351                 alloc_size = sizeof (GCEncodedMap) + ALIGN_TO (encoded_size, map->callsite_entry_size) + (map->callsite_entry_size * map->ncallsites) + bitmaps_size;
2352
2353                 emap = mono_domain_alloc0 (cfg->domain, alloc_size);
2354                 //emap->ref_slots = map->ref_slots;
2355
2356                 /* Encoded fixed fields */
2357                 p = &emap->encoded [0];
2358                 //emap->encoded_size = encoded_size;
2359                 memcpy (p, buf, encoded_size);
2360                 p += encoded_size;
2361
2362                 /* Callsite table */
2363                 p = (guint8*)ALIGN_TO ((mgreg_t)p, map->callsite_entry_size);
2364                 if (map->callsite_entry_size == 1) {
2365                         guint8 *offsets = p;
2366                         for (i = 0; i < ncallsites; ++i)
2367                                 offsets [i] = callsites [i]->pc_offset;
2368                         stats.gc_callsites8_size += ncallsites * sizeof (guint8);
2369                 } else if (map->callsite_entry_size == 2) {
2370                         guint16 *offsets = (guint16*)p;
2371                         for (i = 0; i < ncallsites; ++i)
2372                                 offsets [i] = callsites [i]->pc_offset;
2373                         stats.gc_callsites16_size += ncallsites * sizeof (guint16);
2374                 } else {
2375                         guint32 *offsets = (guint32*)p;
2376                         for (i = 0; i < ncallsites; ++i)
2377                                 offsets [i] = callsites [i]->pc_offset;
2378                         stats.gc_callsites32_size += ncallsites * sizeof (guint32);
2379                 }
2380                 p += ncallsites * map->callsite_entry_size;
2381
2382                 /* Bitmaps */
2383                 memcpy (p, bitmaps, bitmaps_size);
2384                 p += bitmaps_size;
2385
2386                 g_assert ((guint8*)p - (guint8*)emap <= alloc_size);
2387
2388                 stats.gc_maps_size += alloc_size;
2389                 stats.gc_callsites_size += ncallsites * map->callsite_entry_size;
2390                 stats.gc_bitmaps_size += bitmaps_size;
2391                 stats.gc_map_struct_size += sizeof (GCEncodedMap) + encoded_size;
2392
2393                 cfg->jit_info->gc_info = emap;
2394
2395                 cfg->gc_map = (guint8*)emap;
2396                 cfg->gc_map_size = alloc_size;
2397         }
2398
2399         stats.all_slots += nslots;
2400         stats.ref_slots += ntypes [SLOT_REF];
2401         stats.noref_slots += ntypes [SLOT_NOREF];
2402         stats.pin_slots += ntypes [SLOT_PIN];
2403 }
2404
2405 void
2406 mini_gc_create_gc_map (MonoCompile *cfg)
2407 {
2408         if (!cfg->compute_gc_maps)
2409                 return;
2410
2411         /*
2412          * During marking, all frames except the top frame are at a call site, and we mark the
2413          * top frame conservatively. This means that we only need to compute and record
2414          * GC maps for call sites.
2415          */
2416
2417         if (!(cfg->comp_done & MONO_COMP_LIVENESS))
2418                 /* Without liveness info, the live ranges are not precise enough */
2419                 return;
2420
2421         mono_analyze_liveness_gc (cfg);
2422
2423         compute_frame_size (cfg);
2424
2425         init_gcfg (cfg);
2426
2427         process_spill_slots (cfg);
2428         process_other_slots (cfg);
2429         process_param_area_slots (cfg);
2430         process_variables (cfg);
2431         process_finally_clauses (cfg);
2432
2433         create_map (cfg);
2434 }
2435
2436 #endif /* DISABLE_JIT */
2437
2438 static void
2439 parse_debug_options (void)
2440 {
2441         char **opts, **ptr;
2442         char *env;
2443
2444         env = getenv ("MONO_GCMAP_DEBUG");
2445         if (!env)
2446                 return;
2447
2448         opts = g_strsplit (env, ",", -1);
2449         for (ptr = opts; ptr && *ptr; ptr ++) {
2450                 /* No options yet */
2451                 fprintf (stderr, "Invalid format for the MONO_GCMAP_DEBUG env variable: '%s'\n", env);
2452                 exit (1);
2453         }
2454         g_strfreev (opts);
2455 }
2456
2457 void
2458 mini_gc_init (void)
2459 {
2460         MonoGCCallbacks cb;
2461
2462         memset (&cb, 0, sizeof (cb));
2463         cb.thread_attach_func = thread_attach_func;
2464         cb.thread_detach_func = thread_detach_func;
2465         cb.thread_suspend_func = thread_suspend_func;
2466         /* Comment this out to disable precise stack marking */
2467         cb.thread_mark_func = thread_mark_func;
2468         mono_gc_set_gc_callbacks (&cb);
2469
2470         logfile = mono_gc_get_logfile ();
2471
2472         parse_debug_options ();
2473
2474         mono_counters_register ("GC Maps size",
2475                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_maps_size);
2476         mono_counters_register ("GC Call Sites size",
2477                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites_size);
2478         mono_counters_register ("GC Bitmaps size",
2479                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_bitmaps_size);
2480         mono_counters_register ("GC Map struct size",
2481                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_map_struct_size);
2482         mono_counters_register ("GC Call Sites encoded using 8 bits",
2483                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites8_size);
2484         mono_counters_register ("GC Call Sites encoded using 16 bits",
2485                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites16_size);
2486         mono_counters_register ("GC Call Sites encoded using 32 bits",
2487                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites32_size);
2488
2489         mono_counters_register ("GC Map slots (all)",
2490                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.all_slots);
2491         mono_counters_register ("GC Map slots (ref)",
2492                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.ref_slots);
2493         mono_counters_register ("GC Map slots (noref)",
2494                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.noref_slots);
2495         mono_counters_register ("GC Map slots (pin)",
2496                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.pin_slots);
2497
2498         mono_counters_register ("GC TLS Data size",
2499                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.tlsdata_size);
2500
2501         mono_counters_register ("Stack space scanned (all)",
2502                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_stacks);
2503         mono_counters_register ("Stack space scanned (native)",
2504                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_native);
2505         mono_counters_register ("Stack space scanned (other)",
2506                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_other);
2507         mono_counters_register ("Stack space scanned (using GC Maps)",
2508                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned);
2509         mono_counters_register ("Stack space scanned (precise)",
2510                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_precisely);
2511         mono_counters_register ("Stack space scanned (pin)",
2512                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_conservatively);
2513         mono_counters_register ("Stack space scanned (pin registers)",
2514                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_registers);
2515 }
2516
2517 #else
2518
2519 void
2520 mini_gc_enable_gc_maps_for_aot (void)
2521 {
2522 }
2523
2524 void
2525 mini_gc_init (void)
2526 {
2527 }
2528
2529 #ifndef DISABLE_JIT
2530
2531 static void
2532 mini_gc_init_gc_map (MonoCompile *cfg)
2533 {
2534 }
2535
2536 void
2537 mini_gc_create_gc_map (MonoCompile *cfg)
2538 {
2539 }
2540
2541 void
2542 mini_gc_set_slot_type_from_fp (MonoCompile *cfg, int slot_offset, GCSlotType type)
2543 {
2544 }
2545
2546 void
2547 mini_gc_set_slot_type_from_cfa (MonoCompile *cfg, int slot_offset, GCSlotType type)
2548 {
2549 }
2550
2551 #endif /* DISABLE_JIT */
2552
2553 #endif
2554
2555 #ifndef DISABLE_JIT
2556
2557 /*
2558  * mini_gc_init_cfg:
2559  *
2560  *   Set GC specific options in CFG.
2561  */
2562 void
2563 mini_gc_init_cfg (MonoCompile *cfg)
2564 {
2565         if (mono_gc_is_moving ()) {
2566                 cfg->disable_ref_noref_stack_slot_share = TRUE;
2567                 cfg->gen_write_barriers = TRUE;
2568         }
2569
2570         mini_gc_init_gc_map (cfg);
2571 }
2572
2573 #endif /* DISABLE_JIT */
2574
2575 /*
2576  * Problems with the current code:
2577  * - the stack walk is slow
2578  * - vtypes/refs used in EH regions are treated conservatively
2579  * - if the code is finished, less pinning will be done, causing problems because
2580  *   we promote all surviving objects to old-gen.
2581  * - the unwind code can't handle a method stopped inside a finally region, it thinks the caller is
2582  *   another method, but in reality it is either the exception handling code or the CALL_HANDLER opcode.
2583  *   This manifests in "Unable to find ip offset x in callsite list" assertions.
2584  * - the unwind code also can't handle frames which are in the epilog, since the unwind info is not
2585  *   precise there.
2586  */
2587
2588 /*
2589  * Ideas for creating smaller GC maps:
2590  * - remove empty columns from the bitmaps. This requires adding a mask bit array for
2591  *   each bitmap.
2592  * - merge reg and stack slot bitmaps, so the unused bits at the end of the reg bitmap are
2593  *   not wasted.
2594  * - if the bitmap width is not a multiple of 8, the remaining bits are wasted.
2595  * - group ref and non-ref stack slots together in mono_allocate_stack_slots ().
2596  * - add an index for the callsite table so that each entry can be encoded as a 1 byte difference
2597  *   from an index entry.
2598  */