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                 tls->unwind_state.valid = FALSE;
 594                 return;
 595         }
 596
 597         if (tls->tid != GetCurrentThreadId ()) {
 598                 /* Happens on osx because threads are not suspended using signals */
 599                 gboolean res;
 600
 601                 g_assert (tls->info);
 602                 res = mono_thread_state_init_from_handle (&tls->unwind_state, (MonoNativeThreadId)tls->tid, tls->info->native_handle);
 603         } else {
 604                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_LMF] = mono_get_lmf ();
 605                 if (sigctx) {
 606                         mono_arch_sigctx_to_monoctx (sigctx, &tls->unwind_state.ctx);
 607                         tls->unwind_state.valid = TRUE;
 608                 } else if (ctx) {
 609                         memcpy (&tls->unwind_state.ctx, ctx, sizeof (MonoContext));
 610                         tls->unwind_state.valid = TRUE;
 611                 } else {
 612                         tls->unwind_state.valid = FALSE;
 613                 }
 614                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_JIT_TLS] = mono_native_tls_get_value (mono_jit_tls_id);
 615                 tls->unwind_state.unwind_data [MONO_UNWIND_DATA_DOMAIN] = mono_domain_get ();
 616         }
 617
 618         if (!tls->unwind_state.unwind_data [MONO_UNWIND_DATA_DOMAIN]) {
 619                 /* Happens during startup */
 620                 tls->unwind_state.valid = FALSE;
 621                 return;
 622         }
 623 }
 624
 625 #define DEAD_REF ((gpointer)(gssize)0x2a2a2a2a2a2a2a2aULL)
 626
 627 static inline void
 628 set_bit (guint8 *bitmap, int width, int y, int x)
 629 {
 630         bitmap [(width * y) + (x / 8)] |= (1 << (x % 8));
 631 }
 632
 633 static inline void
 634 clear_bit (guint8 *bitmap, int width, int y, int x)
 635 {
 636         bitmap [(width * y) + (x / 8)] &= ~(1 << (x % 8));
 637 }
 638
 639 static inline int
 640 get_bit (guint8 *bitmap, int width, int y, int x)
 641 {
 642         return bitmap [(width * y) + (x / 8)] & (1 << (x % 8));
 643 }
 644
 645 static const char*
 646 slot_type_to_string (GCSlotType type)
 647 {
 648         switch (type) {
 649         case SLOT_REF:
 650                 return "ref";
 651         case SLOT_NOREF:
 652                 return "noref";
 653         case SLOT_PIN:
 654                 return "pin";
 655         default:
 656                 g_assert_not_reached ();
 657                 return NULL;
 658         }
 659 }
 660
 661 static inline mgreg_t
 662 get_frame_pointer (MonoContext *ctx, int frame_reg)
 663 {
 664 #if defined(TARGET_AMD64)
 665                 if (frame_reg == AMD64_RSP)
 666                         return ctx->rsp;
 667                 else if (frame_reg == AMD64_RBP)
 668                         return ctx->rbp;
 669 #elif defined(TARGET_X86)
 670                 if (frame_reg == X86_ESP)
 671                         return ctx->esp;
 672                 else if (frame_reg == X86_EBP)
 673                         return ctx->ebp;
 674 #elif defined(TARGET_ARM)
 675                 if (frame_reg == ARMREG_SP)
 676                         return (mgreg_t)MONO_CONTEXT_GET_SP (ctx);
 677                 else if (frame_reg == ARMREG_FP)
 678                         return (mgreg_t)MONO_CONTEXT_GET_BP (ctx);
 679 #elif defined(TARGET_S390X)
 680                 if (frame_reg == S390_SP)
 681                         return (mgreg_t)MONO_CONTEXT_GET_SP (ctx);
 682                 else if (frame_reg == S390_FP)
 683                         return (mgreg_t)MONO_CONTEXT_GET_BP (ctx);
 684 #endif
 685                 g_assert_not_reached ();
 686                 return 0;
 687 }
 688
 689 /*
 690  * conservatively_pass:
 691  *
 692  *   Mark a thread stack conservatively and collect information needed by the precise pass.
 693  */
 694 static void
 695 conservative_pass (TlsData *tls, guint8 *stack_start, guint8 *stack_end)
 696 {
 697         MonoJitInfo *ji;
 698         MonoContext ctx, new_ctx;
 699         MonoLMF *lmf;
 700         guint8 *stack_limit;
 701         gboolean last = TRUE;
 702         GCMap *map;
 703         GCMap map_tmp;
 704         GCEncodedMap *emap;
 705         guint8* fp, *p, *real_frame_start, *frame_start, *frame_end;
 706         int i, pc_offset, cindex, bitmap_width;
 707         int scanned = 0, scanned_precisely, scanned_conservatively, scanned_registers;
 708         gboolean res;
 709         StackFrameInfo frame;
 710         mgreg_t *reg_locations [MONO_MAX_IREGS];
 711         mgreg_t *new_reg_locations [MONO_MAX_IREGS];
 712         guint8 *bitmaps;
 713         FrameInfo *fi;
 714         guint32 precise_regmask;
 715
 716         if (tls) {
 717                 tls->nframes = 0;
 718                 tls->ref_to_track = NULL;
 719         }
 720
 721         /* tls == NULL can happen during startup */
 722         if (mono_thread_internal_current () == NULL || !tls) {
 723                 mono_gc_conservatively_scan_area (stack_start, stack_end);
 724                 stats.scanned_stacks += stack_end - stack_start;
 725                 return;
 726         }
 727
 728         lmf = tls->unwind_state.unwind_data [MONO_UNWIND_DATA_LMF];
 729         frame.domain = NULL;
 730
 731         /* Number of bytes scanned based on GC map data */
 732         scanned = 0;
 733         /* Number of bytes scanned precisely based on GC map data */
 734         scanned_precisely = 0;
 735         /* Number of bytes scanned conservatively based on GC map data */
 736         scanned_conservatively = 0;
 737         /* Number of bytes scanned conservatively in register save areas */
 738         scanned_registers = 0;
 739
 740         /* This is one past the last address which we have scanned */
 741         stack_limit = stack_start;
 742
 743         if (!tls->unwind_state.valid)
 744                 memset (&new_ctx, 0, sizeof (ctx));
 745         else
 746                 memcpy (&new_ctx, &tls->unwind_state.ctx, sizeof (MonoContext));
 747
 748         memset (reg_locations, 0, sizeof (reg_locations));
 749         memset (new_reg_locations, 0, sizeof (new_reg_locations));
 750
 751         while (TRUE) {
 752                 if (!tls->unwind_state.valid)
 753                         break;
 754
 755                 memcpy (&ctx, &new_ctx, sizeof (ctx));
 756
 757                 for (i = 0; i < MONO_MAX_IREGS; ++i) {
 758                         if (new_reg_locations [i]) {
 759                                 /*
 760                                  * If the current frame saves the register, it means it might modify its
 761                                  * value, thus the old location might not contain the same value, so
 762                                  * we have to mark it conservatively.
 763                                  */
 764                                 if (reg_locations [i]) {
 765                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 766                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 767                                         scanned_registers += SIZEOF_SLOT;
 768                                 }
 769
 770                                 reg_locations [i] = new_reg_locations [i];
 771
 772                                 DEBUG (fprintf (logfile, "\treg %s is now at location %p.\n", mono_arch_regname (i), reg_locations [i]));
 773                         }
 774                 }
 775
 776                 g_assert ((mgreg_t)stack_limit % SIZEOF_SLOT == 0);
 777
 778                 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);
 779                 if (!res)
 780                         break;
 781
 782                 ji = frame.ji;
 783
 784                 // FIXME: For skipped frames, scan the param area of the parent frame conservatively ?
 785
 786                 if (frame.type == FRAME_TYPE_MANAGED_TO_NATIVE) {
 787                         /*
 788                          * These frames are problematic for several reasons:
 789                          * - they are unwound through an LMF, and we have no precise register tracking for those.
 790                          * - the LMF might not contain a precise ip, so we can't compute the call site.
 791                          * - the LMF only unwinds to the wrapper frame, so we get these methods twice.
 792                          */
 793                         DEBUG (fprintf (logfile, "Mark(0): <Managed-to-native transition>\n"));
 794                         for (i = 0; i < MONO_MAX_IREGS; ++i) {
 795                                 if (reg_locations [i]) {
 796                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 797                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 798                                         scanned_registers += SIZEOF_SLOT;
 799                                 }
 800                                 reg_locations [i] = NULL;
 801                                 new_reg_locations [i] = NULL;
 802                         }
 803                         ctx = new_ctx;
 804                         continue;
 805                 }
 806
 807                 /* The last frame can be in any state so mark conservatively */
 808                 if (last) {
 809                         if (ji) {
 810                                 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));
 811                         }
 812                         DEBUG (fprintf (logfile, "\t <Last frame>\n"));
 813                         last = FALSE;
 814                         /*
 815                          * new_reg_locations is not precise when a method is interrupted during its epilog, so clear it.
 816                          */
 817                         for (i = 0; i < MONO_MAX_IREGS; ++i) {
 818                                 if (reg_locations [i]) {
 819                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), reg_locations [i]));
 820                                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
 821                                         scanned_registers += SIZEOF_SLOT;
 822                                 }
 823                                 if (new_reg_locations [i]) {
 824                                         DEBUG (fprintf (logfile, "\tscan saved reg %s location %p.\n", mono_arch_regname (i), new_reg_locations [i]));
 825                                         mono_gc_conservatively_scan_area (new_reg_locations [i], (char*)new_reg_locations [i] + SIZEOF_SLOT);
 826                                         scanned_registers += SIZEOF_SLOT;
 827                                 }
 828                                 reg_locations [i] = NULL;
 829                                 new_reg_locations [i] = NULL;
 830                         }
 831                         continue;
 832                 }
 833
 834                 pc_offset = (guint8*)MONO_CONTEXT_GET_IP (&ctx) - (guint8*)ji->code_start;
 835
 836                 /* These frames are very problematic */
 837                 if (ji->method->wrapper_type == MONO_WRAPPER_MANAGED_TO_NATIVE) {
 838                         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));
 839                         DEBUG (fprintf (logfile, "\tSkip.\n"));
 840                         continue;
 841                 }
 842
 843                 /* All the other frames are at a call site */
 844
 845                 if (tls->nframes == MAX_FRAMES) {
 846                         /*
 847                          * Can't save information since the array is full. So scan the rest of the
 848                          * stack conservatively.
 849                          */
 850                         DEBUG (fprintf (logfile, "Mark (0): Frame stack full.\n"));
 851                         break;
 852                 }
 853
 854                 /* Scan the frame of this method */
 855
 856                 /*
 857                  * A frame contains the following:
 858                  * - saved registers
 859                  * - saved args
 860                  * - locals
 861                  * - spill area
 862                  * - localloc-ed memory
 863                  */
 864                 g_assert (pc_offset >= 0);
 865
 866                 emap = ji->gc_info;
 867
 868                 if (!emap) {
 869                         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));
 870                         DEBUG (fprintf (logfile, "\tNo GC Map.\n"));
 871                         continue;
 872                 }
 873
 874                 /* The embedded callsite table requires this */
 875                 g_assert (((mgreg_t)emap % 4) == 0);
 876
 877                 /*
 878                  * Debugging aid to control the number of frames scanned precisely
 879                  */
 880                 if (!precise_frame_limit_inited) {
 881                         if (getenv ("MONO_PRECISE_COUNT"))
 882                                 precise_frame_limit = atoi (getenv ("MONO_PRECISE_COUNT"));
 883                         precise_frame_limit_inited = TRUE;
 884                 }
 885
 886                 if (precise_frame_limit != -1) {
 887                         if (precise_frame_count [FALSE] == precise_frame_limit)
 888                                 printf ("LAST PRECISE FRAME: %s\n", mono_method_full_name (ji->method, TRUE));
 889                         if (precise_frame_count [FALSE] > precise_frame_limit)
 890                                 continue;
 891                 }
 892                 precise_frame_count [FALSE] ++;
 893
 894                 /* Decode the encoded GC map */
 895                 map = &map_tmp;
 896                 memset (map, 0, sizeof (GCMap));
 897                 decode_gc_map (&emap->encoded [0], map, &p);
 898                 p = (guint8*)ALIGN_TO (p, map->callsite_entry_size);
 899                 map->callsites.offsets8 = p;
 900                 p += map->callsite_entry_size * map->ncallsites;
 901                 bitmaps = p;
 902
 903                 fp = (guint8*)get_frame_pointer (&ctx, map->frame_reg);
 904
 905                 real_frame_start = fp + map->start_offset;
 906                 frame_start = fp + map->start_offset + map->map_offset;
 907                 frame_end = fp + map->end_offset;
 908
 909                 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));
 910
 911                 /* Find the callsite index */
 912                 if (map->callsite_entry_size == 1) {
 913                         for (i = 0; i < map->ncallsites; ++i)
 914                                 /* ip points inside the call instruction */
 915                                 if (map->callsites.offsets8 [i] == pc_offset + 1)
 916                                         break;
 917                 } else if (map->callsite_entry_size == 2) {
 918                         // FIXME: Use a binary search
 919                         for (i = 0; i < map->ncallsites; ++i)
 920                                 /* ip points inside the call instruction */
 921                                 if (map->callsites.offsets16 [i] == pc_offset + 1)
 922                                         break;
 923                 } else {
 924                         // FIXME: Use a binary search
 925                         for (i = 0; i < map->ncallsites; ++i)
 926                                 /* ip points inside the call instruction */
 927                                 if (map->callsites.offsets32 [i] == pc_offset + 1)
 928                                         break;
 929                 }
 930                 if (i == map->ncallsites) {
 931                         printf ("Unable to find ip offset 0x%x in callsite list of %s.\n", pc_offset + 1, mono_method_full_name (ji->method, TRUE));
 932                         g_assert_not_reached ();
 933                 }
 934                 cindex = i;
 935
 936                 /*
 937                  * This is not neccessary true on x86 because frames have a different size at each
 938                  * call site.
 939                  */
 940                 //g_assert (real_frame_start >= stack_limit);
 941
 942                 if (real_frame_start > stack_limit) {
 943                         /* This scans the previously skipped frames as well */
 944                         DEBUG (fprintf (logfile, "\tscan area %p-%p (%d).\n", stack_limit, real_frame_start, (int)(real_frame_start - stack_limit)));
 945                         mono_gc_conservatively_scan_area (stack_limit, real_frame_start);
 946                         stats.scanned_other += real_frame_start - stack_limit;
 947                 }
 948
 949                 /* Mark stack slots */
 950                 if (map->has_pin_slots) {
 951                         int bitmap_width = ALIGN_TO (map->nslots, 8) / 8;
 952                         guint8 *pin_bitmap = &bitmaps [map->stack_pin_bitmap_offset + (bitmap_width * cindex)];
 953                         guint8 *p;
 954                         gboolean pinned;
 955
 956                         p = frame_start;
 957                         for (i = 0; i < map->nslots; ++i) {
 958                                 pinned = pin_bitmap [i / 8] & (1 << (i % 8));
 959                                 if (pinned) {
 960                                         DEBUG (fprintf (logfile, "\tscan slot %s0x%x(fp)=%p.\n", (guint8*)p > (guint8*)fp ? "" : "-", ABS ((int)((gssize)p - (gssize)fp)), p));
 961                                         mono_gc_conservatively_scan_area (p, p + SIZEOF_SLOT);
 962                                         scanned_conservatively += SIZEOF_SLOT;
 963                                 } else {
 964                                         scanned_precisely += SIZEOF_SLOT;
 965                                 }
 966                                 p += SIZEOF_SLOT;
 967                         }
 968                 } else {
 969                         scanned_precisely += (map->nslots * SIZEOF_SLOT);
 970                 }
 971
 972                 /* The area outside of start-end is NOREF */
 973                 scanned_precisely += (map->end_offset - map->start_offset) - (map->nslots * SIZEOF_SLOT);
 974
 975                 /* Mark registers */
 976                 precise_regmask = map->used_int_regs | (1 << map->frame_reg);
 977                 if (map->has_pin_regs) {
 978                         int bitmap_width = ALIGN_TO (map->npin_regs, 8) / 8;
 979                         guint8 *pin_bitmap = &bitmaps [map->reg_pin_bitmap_offset + (bitmap_width * cindex)];
 980                         int bindex = 0;
 981                         for (i = 0; i < NREGS; ++i) {
 982                                 if (!(map->used_int_regs & (1 << i)))
 983                                         continue;
 984
 985                                 if (!(map->reg_pin_mask & (1 << i)))
 986                                         continue;
 987
 988                                 if (pin_bitmap [bindex / 8] & (1 << (bindex % 8))) {
 989                                         DEBUG (fprintf (logfile, "\treg %s saved at 0x%p is pinning.\n", mono_arch_regname (i), reg_locations [i]));
 990                                         precise_regmask &= ~(1 << i);
 991                                 }
 992                                 bindex ++;
 993                         }
 994                 }
 995
 996                 scanned += map->end_offset - map->start_offset;
 997
 998                 g_assert (scanned == scanned_precisely + scanned_conservatively);
 999
1000                 stack_limit = frame_end;
1001
1002                 /* Save information for the precise pass */
1003                 fi = &tls->frames [tls->nframes];
1004                 fi->nslots = map->nslots;
1005                 bitmap_width = ALIGN_TO (map->nslots, 8) / 8;
1006                 if (map->has_ref_slots)
1007                         fi->bitmap = &bitmaps [map->stack_ref_bitmap_offset + (bitmap_width * cindex)];
1008                 else
1009                         fi->bitmap = NULL;
1010                 fi->frame_start_offset = frame_start - stack_start;
1011                 fi->nreg_locations = 0;
1012                 DEBUG_PRECISE (fi->ji = ji);
1013                 DEBUG_PRECISE (fi->fp = fp);
1014
1015                 if (map->has_ref_regs) {
1016                         int bitmap_width = ALIGN_TO (map->nref_regs, 8) / 8;
1017                         guint8 *ref_bitmap = &bitmaps [map->reg_ref_bitmap_offset + (bitmap_width * cindex)];
1018                         int bindex = 0;
1019                         for (i = 0; i < NREGS; ++i) {
1020                                 if (!(map->reg_ref_mask & (1 << i)))
1021                                         continue;
1022
1023                                 if (reg_locations [i] && (ref_bitmap [bindex / 8] & (1 << (bindex % 8)))) {
1024                                         DEBUG_PRECISE (fi->regs [fi->nreg_locations] = i);
1025                                         DEBUG (fprintf (logfile, "\treg %s saved at 0x%p is ref.\n", mono_arch_regname (i), reg_locations [i]));
1026                                         fi->reg_locations [fi->nreg_locations] = (guint8*)reg_locations [i] - stack_start;
1027                                         fi->nreg_locations ++;
1028                                 }
1029                                 bindex ++;
1030                         }
1031                 }
1032
1033                 /*
1034                  * Clear locations of precisely tracked registers.
1035                  */
1036                 if (precise_regmask) {
1037                         for (i = 0; i < NREGS; ++i) {
1038                                 if (precise_regmask & (1 << i)) {
1039                                         /*
1040                                          * The method uses this register, and we have precise info for it.
1041                                          * This means the location will be scanned precisely.
1042                                          * Tell the code at the beginning of the loop that this location is
1043                                          * processed.
1044                                          */
1045                                         if (reg_locations [i])
1046                                                 DEBUG (fprintf (logfile, "\treg %s at location %p (==%p) is precise.\n", mono_arch_regname (i), reg_locations [i], (gpointer)*reg_locations [i]));
1047                                         reg_locations [i] = NULL;
1048                                 }
1049                         }
1050                 }
1051
1052                 tls->nframes ++;
1053         }
1054
1055         /* Scan the remaining register save locations */
1056         for (i = 0; i < MONO_MAX_IREGS; ++i) {
1057                 if (reg_locations [i]) {
1058                         DEBUG (fprintf (logfile, "\tscan saved reg location %p.\n", reg_locations [i]));
1059                         mono_gc_conservatively_scan_area (reg_locations [i], (char*)reg_locations [i] + SIZEOF_SLOT);
1060                         scanned_registers += SIZEOF_SLOT;
1061                 }
1062                 if (new_reg_locations [i]) {
1063                         DEBUG (fprintf (logfile, "\tscan saved reg location %p.\n", new_reg_locations [i]));
1064                         mono_gc_conservatively_scan_area (new_reg_locations [i], (char*)new_reg_locations [i] + SIZEOF_SLOT);
1065                         scanned_registers += SIZEOF_SLOT;
1066                 }
1067         }
1068
1069         if (stack_limit < stack_end) {
1070                 DEBUG (fprintf (logfile, "\tscan remaining stack %p-%p (%d).\n", stack_limit, stack_end, (int)(stack_end - stack_limit)));
1071                 mono_gc_conservatively_scan_area (stack_limit, stack_end);
1072                 stats.scanned_native += stack_end - stack_limit;
1073         }
1074
1075         DEBUG (fprintf (logfile, "Marked %d bytes, p=%d,c=%d out of %d.\n", scanned, scanned_precisely, scanned_conservatively, (int)(stack_end - stack_start)));
1076
1077         stats.scanned_stacks += stack_end - stack_start;
1078         stats.scanned += scanned;
1079         stats.scanned_precisely += scanned_precisely;
1080         stats.scanned_conservatively += scanned_conservatively;
1081         stats.scanned_registers += scanned_registers;
1082
1083         //mono_gc_conservatively_scan_area (stack_start, stack_end);
1084 }
1085
1086 /*
1087  * precise_pass:
1088  *
1089  *   Mark a thread stack precisely based on information saved during the conservative
1090  * pass.
1091  */
1092 static void
1093 precise_pass (TlsData *tls, guint8 *stack_start, guint8 *stack_end)
1094 {
1095         int findex, i;
1096         FrameInfo *fi;
1097         guint8 *frame_start;
1098
1099         if (!tls)
1100                 return;
1101
1102         if (!tls->unwind_state.valid)
1103                 return;
1104
1105         for (findex = 0; findex < tls->nframes; findex ++) {
1106                 /* Load information saved by the !precise pass */
1107                 fi = &tls->frames [findex];
1108                 frame_start = stack_start + fi->frame_start_offset;
1109
1110                 DEBUG (char *fname = mono_method_full_name (fi->ji->method, TRUE); fprintf (logfile, "Mark(1): %s\n", fname); g_free (fname));
1111
1112                 /*
1113                  * FIXME: Add a function to mark using a bitmap, to avoid doing a
1114                  * call for each object.
1115                  */
1116
1117                 /* Mark stack slots */
1118                 if (fi->bitmap) {
1119                         guint8 *ref_bitmap = fi->bitmap;
1120                         gboolean live;
1121
1122                         for (i = 0; i < fi->nslots; ++i) {
1123                                 MonoObject **ptr = (MonoObject**)(frame_start + (i * SIZEOF_SLOT));
1124
1125                                 live = ref_bitmap [i / 8] & (1 << (i % 8));
1126
1127                                 if (live) {
1128                                         MonoObject *obj = *ptr;
1129                                         if (obj) {
1130                                                 DEBUG (fprintf (logfile, "\tref %s0x%x(fp)=%p: %p ->", (guint8*)ptr >= (guint8*)fi->fp ? "" : "-", ABS ((int)((gssize)ptr - (gssize)fi->fp)), ptr, obj));
1131                                                 *ptr = mono_gc_scan_object (obj);
1132                                                 DEBUG (fprintf (logfile, " %p.\n", *ptr));
1133                                         } else {
1134                                                 DEBUG (fprintf (logfile, "\tref %s0x%x(fp)=%p: %p.\n", (guint8*)ptr >= (guint8*)fi->fp ? "" : "-", ABS ((int)((gssize)ptr - (gssize)fi->fp)), ptr, obj));
1135                                         }
1136                                 } else {
1137 #if 0
1138                                         /*
1139                                          * This is disabled because the pointer takes up a lot of space.
1140                                          * Stack slots might be shared between ref and non-ref variables ?
1141                                          */
1142                                         if (map->ref_slots [i / 8] & (1 << (i % 8))) {
1143                                                 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));
1144                                                 /*
1145                                                  * Fail fast if the live range is incorrect, and
1146                                                  * the JITted code tries to access this object
1147                                                  */
1148                                                 *ptr = DEAD_REF;
1149                                         }
1150 #endif
1151                                 }
1152                         }
1153                 }
1154
1155                 /* Mark registers */
1156
1157                 /*
1158                  * Registers are different from stack slots, they have no address where they
1159                  * are stored. Instead, some frame below this frame in the stack saves them
1160                  * in its prolog to the stack. We can mark this location precisely.
1161                  */
1162                 for (i = 0; i < fi->nreg_locations; ++i) {
1163                         /*
1164                          * reg_locations [i] contains the address of the stack slot where
1165                          * a reg was last saved, so mark that slot.
1166                          */
1167                         MonoObject **ptr = (MonoObject**)((guint8*)stack_start + fi->reg_locations [i]);
1168                         MonoObject *obj = *ptr;
1169
1170                         if (obj) {
1171                                 DEBUG (fprintf (logfile, "\treg %s saved at %p: %p ->", mono_arch_regname (fi->regs [i]), ptr, obj));
1172                                 *ptr = mono_gc_scan_object (obj);
1173                                 DEBUG (fprintf (logfile, " %p.\n", *ptr));
1174                         } else {
1175                                 DEBUG (fprintf (logfile, "\treg %s saved at %p: %p\n", mono_arch_regname (fi->regs [i]), ptr, obj));
1176                         }
1177                 }
1178         }
1179
1180         /*
1181          * Debugging aid to check for missed refs.
1182          */
1183         if (tls->ref_to_track) {
1184                 mgreg_t *p;
1185
1186                 for (p = (mgreg_t*)stack_start; p < (mgreg_t*)stack_end; ++p)
1187                         if (*p == (mgreg_t)tls->ref_to_track)
1188                                 printf ("REF AT %p.\n", p);
1189         }
1190 }
1191
1192 /*
1193  * thread_mark_func:
1194  *
1195  *   This is called by the GC twice to mark a thread stack. PRECISE is FALSE at the first
1196  * call, and TRUE at the second. USER_DATA points to a TlsData
1197  * structure filled up by thread_suspend_func.
1198  */
1199 static void
1200 thread_mark_func (gpointer user_data, guint8 *stack_start, guint8 *stack_end, gboolean precise)
1201 {
1202         TlsData *tls = user_data;
1203
1204         DEBUG (fprintf (logfile, "****************************************\n"));
1205         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));
1206         DEBUG (fprintf (logfile, "****************************************\n"));
1207
1208         if (!precise)
1209                 conservative_pass (tls, stack_start, stack_end);
1210         else
1211                 precise_pass (tls, stack_start, stack_end);
1212 }
1213
1214 #ifndef DISABLE_JIT
1215
1216 static void
1217 mini_gc_init_gc_map (MonoCompile *cfg)
1218 {
1219         if (COMPILE_LLVM (cfg))
1220                 return;
1221
1222         if (!mono_gc_is_moving ())
1223                 return;
1224
1225         if (cfg->compile_aot) {
1226                 if (!enable_gc_maps_for_aot)
1227                         return;
1228         } else if (!mono_gc_precise_stack_mark_enabled ())
1229                 return;
1230
1231 #if 1
1232         /* Debugging support */
1233         {
1234                 static int precise_count;
1235
1236                 precise_count ++;
1237                 if (getenv ("MONO_GCMAP_COUNT")) {
1238                         if (precise_count == atoi (getenv ("MONO_GCMAP_COUNT")))
1239                                 printf ("LAST: %s\n", mono_method_full_name (cfg->method, TRUE));
1240                         if (precise_count > atoi (getenv ("MONO_GCMAP_COUNT")))
1241                                 return;
1242                 }
1243         }
1244 #endif
1245
1246         cfg->compute_gc_maps = TRUE;
1247
1248         cfg->gc_info = mono_mempool_alloc0 (cfg->mempool, sizeof (MonoCompileGC));
1249 }
1250
1251 /*
1252  * mini_gc_set_slot_type_from_fp:
1253  *
1254  *   Set the GC slot type of the stack slot identified by SLOT_OFFSET, which should be
1255  * relative to the frame pointer. By default, all stack slots are type PIN, so there is no
1256  * need to call this function for those slots.
1257  */
1258 void
1259 mini_gc_set_slot_type_from_fp (MonoCompile *cfg, int slot_offset, GCSlotType type)
1260 {
1261         MonoCompileGC *gcfg = (MonoCompileGC*)cfg->gc_info;
1262
1263         if (!cfg->compute_gc_maps)
1264                 return;
1265
1266         g_assert (slot_offset % SIZEOF_SLOT == 0);
1267
1268         gcfg->stack_slots_from_fp = g_slist_prepend_mempool (cfg->mempool, gcfg->stack_slots_from_fp, GINT_TO_POINTER (((slot_offset) << 16) | type));
1269 }
1270
1271 /*
1272  * mini_gc_set_slot_type_from_cfa:
1273  *
1274  *   Set the GC slot type of the stack slot identified by SLOT_OFFSET, which should be
1275  * relative to the DWARF CFA value. This should be called from mono_arch_emit_prolog ().
1276  * If type is STACK_REF, the slot is assumed to be live from the end of the prolog until
1277  * the end of the method. By default, all stack slots are type PIN, so there is no need to
1278  * call this function for those slots.
1279  */
1280 void
1281 mini_gc_set_slot_type_from_cfa (MonoCompile *cfg, int slot_offset, GCSlotType type)
1282 {
1283         MonoCompileGC *gcfg = (MonoCompileGC*)cfg->gc_info;
1284         int slot = - (slot_offset / SIZEOF_SLOT);
1285
1286         if (!cfg->compute_gc_maps)
1287                 return;
1288
1289         g_assert (slot_offset <= 0);
1290         g_assert (slot_offset % SIZEOF_SLOT == 0);
1291
1292         gcfg->stack_slots_from_cfa = g_slist_prepend_mempool (cfg->mempool, gcfg->stack_slots_from_cfa, GUINT_TO_POINTER (((slot) << 16) | type));
1293 }
1294
1295 static inline int
1296 fp_offset_to_slot (MonoCompile *cfg, int offset)
1297 {
1298         MonoCompileGC *gcfg = cfg->gc_info;
1299
1300         return (offset - gcfg->min_offset) / SIZEOF_SLOT;
1301 }
1302
1303 static inline int
1304 slot_to_fp_offset (MonoCompile *cfg, int slot)
1305 {
1306         MonoCompileGC *gcfg = cfg->gc_info;
1307
1308         return (slot * SIZEOF_SLOT) + gcfg->min_offset;
1309 }
1310
1311 static inline MONO_ALWAYS_INLINE void
1312 set_slot (MonoCompileGC *gcfg, int slot, int callsite_index, GCSlotType type)
1313 {
1314         g_assert (slot >= 0 && slot < gcfg->nslots);
1315
1316         if (type == SLOT_PIN) {
1317                 clear_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1318                 set_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1319         } else if (type == SLOT_REF) {
1320                 set_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1321                 clear_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, slot, callsite_index);
1322         } else if (type == SLOT_NOREF) {
1323                 clear_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         }
1326 }
1327
1328 static inline void
1329 set_slot_everywhere (MonoCompileGC *gcfg, int slot, GCSlotType type)
1330 {
1331         int width, pos;
1332         guint8 *ref_bitmap, *pin_bitmap;
1333
1334         /*
1335         int cindex;
1336
1337         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1338                 set_slot (gcfg, slot, cindex, type);
1339         */
1340         ref_bitmap = gcfg->stack_ref_bitmap;
1341         pin_bitmap = gcfg->stack_pin_bitmap;
1342         width = gcfg->stack_bitmap_width;
1343         pos = width * slot;
1344
1345         if (type == SLOT_PIN) {
1346                 memset (ref_bitmap + pos, 0, width);
1347                 memset (pin_bitmap + pos, 0xff, width);
1348         } else if (type == SLOT_REF) {
1349                 memset (ref_bitmap + pos, 0xff, width);
1350                 memset (pin_bitmap + pos, 0, width);
1351         } else if (type == SLOT_NOREF) {
1352                 memset (ref_bitmap + pos, 0, width);
1353                 memset (pin_bitmap + pos, 0, width);
1354         }
1355 }
1356
1357 static inline void
1358 set_slot_in_range (MonoCompileGC *gcfg, int slot, int from, int to, GCSlotType type)
1359 {
1360         int cindex;
1361
1362         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1363                 int callsite_offset = gcfg->callsites [cindex]->pc_offset;
1364                 if (callsite_offset >= from && callsite_offset < to)
1365                         set_slot (gcfg, slot, cindex, type);
1366         }
1367 }
1368
1369 static inline void
1370 set_reg_slot (MonoCompileGC *gcfg, int slot, int callsite_index, GCSlotType type)
1371 {
1372         g_assert (slot >= 0 && slot < gcfg->nregs);
1373
1374         if (type == SLOT_PIN) {
1375                 clear_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1376                 set_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1377         } else if (type == SLOT_REF) {
1378                 set_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1379                 clear_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, slot, callsite_index);
1380         } else if (type == SLOT_NOREF) {
1381                 clear_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         }
1384 }
1385
1386 static inline void
1387 set_reg_slot_everywhere (MonoCompileGC *gcfg, int slot, GCSlotType type)
1388 {
1389         int cindex;
1390
1391         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1392                 set_reg_slot (gcfg, slot, cindex, type);
1393 }
1394
1395 static inline void
1396 set_reg_slot_in_range (MonoCompileGC *gcfg, int slot, int from, int to, GCSlotType type)
1397 {
1398         int cindex;
1399
1400         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1401                 int callsite_offset = gcfg->callsites [cindex]->pc_offset;
1402                 if (callsite_offset >= from && callsite_offset < to)
1403                         set_reg_slot (gcfg, slot, cindex, type);
1404         }
1405 }
1406
1407 static void
1408 process_spill_slots (MonoCompile *cfg)
1409 {
1410         MonoCompileGC *gcfg = cfg->gc_info;
1411         MonoBasicBlock *bb;
1412         GSList *l;
1413         int i;
1414
1415         /* Mark all ref/pin spill slots as NOREF by default outside of their live range */
1416         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
1417                 for (l = bb->spill_slot_defs; l; l = l->next) {
1418                         MonoInst *def = l->data;
1419                         int spill_slot = def->inst_c0;
1420                         int bank = def->inst_c1;
1421                         int offset = cfg->spill_info [bank][spill_slot].offset;
1422                         int slot = fp_offset_to_slot (cfg, offset);
1423
1424                         if (bank == MONO_REG_INT_MP || bank == MONO_REG_INT_REF)
1425                                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1426                 }
1427         }
1428
1429         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
1430                 for (l = bb->spill_slot_defs; l; l = l->next) {
1431                         MonoInst *def = l->data;
1432                         int spill_slot = def->inst_c0;
1433                         int bank = def->inst_c1;
1434                         int offset = cfg->spill_info [bank][spill_slot].offset;
1435                         int slot = fp_offset_to_slot (cfg, offset);
1436                         GCSlotType type;
1437
1438                         if (bank == MONO_REG_INT_MP)
1439                                 type = SLOT_PIN;
1440                         else
1441                                 type = SLOT_REF;
1442
1443                         /*
1444                          * Extend the live interval for the GC tracked spill slots
1445                          * defined in this bblock.
1446                          * FIXME: This is not needed.
1447                          */
1448                         set_slot_in_range (gcfg, slot, def->backend.pc_offset, bb->native_offset + bb->native_length, type);
1449
1450                         if (cfg->verbose_level > 1)
1451                                 printf ("\t%s spill slot at %s0x%x(fp) (slot = %d)\n", slot_type_to_string (type), offset >= 0 ? "" : "-", ABS (offset), slot);
1452                 }
1453         }
1454
1455         /* Set fp spill slots to NOREF */
1456         for (i = 0; i < cfg->spill_info_len [MONO_REG_DOUBLE]; ++i) {
1457                 int offset = cfg->spill_info [MONO_REG_DOUBLE][i].offset;
1458                 int slot;
1459
1460                 if (offset == -1)
1461                         continue;
1462
1463                 slot = fp_offset_to_slot (cfg, offset);
1464
1465                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1466                 /* FIXME: 32 bit */
1467                 if (cfg->verbose_level > 1)
1468                         printf ("\tfp spill slot at %s0x%x(fp) (slot = %d)\n", offset >= 0 ? "" : "-", ABS (offset), slot);
1469         }
1470
1471         /* Set int spill slots to NOREF */
1472         for (i = 0; i < cfg->spill_info_len [MONO_REG_INT]; ++i) {
1473                 int offset = cfg->spill_info [MONO_REG_INT][i].offset;
1474                 int slot;
1475
1476                 if (offset == -1)
1477                         continue;
1478
1479                 slot = fp_offset_to_slot (cfg, offset);
1480
1481                 set_slot_everywhere (gcfg, slot, SLOT_NOREF);
1482                 if (cfg->verbose_level > 1)
1483                         printf ("\tint spill slot at %s0x%x(fp) (slot = %d)\n", offset >= 0 ? "" : "-", ABS (offset), slot);
1484         }
1485 }
1486
1487 /*
1488  * process_other_slots:
1489  *
1490  *   Process stack slots registered using mini_gc_set_slot_type_... ().
1491  */
1492 static void
1493 process_other_slots (MonoCompile *cfg)
1494 {
1495         MonoCompileGC *gcfg = cfg->gc_info;
1496         GSList *l;
1497
1498         /* Relative to the CFA */
1499         for (l = gcfg->stack_slots_from_cfa; l; l = l->next) {
1500                 guint data = GPOINTER_TO_UINT (l->data);
1501                 int cfa_slot = data >> 16;
1502                 GCSlotType type = data & 0xff;
1503                 int slot;
1504
1505                 /*
1506                  * Map the cfa relative slot to an fp relative slot.
1507                  * slot_addr == cfa - <cfa_slot>*4/8
1508                  * fp + cfa_offset == cfa
1509                  * -> slot_addr == fp + (cfa_offset - <cfa_slot>*4/8)
1510                  */
1511                 slot = (cfg->cfa_offset / SIZEOF_SLOT) - cfa_slot - (gcfg->min_offset / SIZEOF_SLOT);
1512
1513                 set_slot_everywhere (gcfg, slot, type);
1514
1515                 if (cfg->verbose_level > 1) {
1516                         int fp_offset = slot_to_fp_offset (cfg, slot);
1517                         if (type == SLOT_NOREF)
1518                                 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));
1519                 }
1520         }
1521
1522         /* Relative to the FP */
1523         for (l = gcfg->stack_slots_from_fp; l; l = l->next) {
1524                 gint data = GPOINTER_TO_INT (l->data);
1525                 int offset = data >> 16;
1526                 GCSlotType type = data & 0xff;
1527                 int slot;
1528
1529                 slot = fp_offset_to_slot (cfg, offset);
1530
1531                 set_slot_everywhere (gcfg, slot, type);
1532
1533                 /* Liveness for these slots is handled by process_spill_slots () */
1534
1535                 if (cfg->verbose_level > 1) {
1536                         if (type == SLOT_REF)
1537                                 printf ("\tref slot at fp+0x%x (slot = %d)\n", offset, slot);
1538                         else if (type == SLOT_NOREF)
1539                                 printf ("\tnoref slot at 0x%x(fp) (slot = %d)\n", offset, slot);
1540                 }
1541         }
1542 }
1543
1544 static gsize*
1545 get_vtype_bitmap (MonoType *t, int *numbits)
1546 {
1547         MonoClass *klass = mono_class_from_mono_type (t);
1548
1549         if (klass->generic_container || mono_class_is_open_constructed_type (t)) {
1550                 /* FIXME: Generic sharing */
1551                 return NULL;
1552         } else {
1553                 mono_class_compute_gc_descriptor (klass);
1554
1555                 return mono_gc_get_bitmap_for_descr (klass->gc_descr, numbits);
1556         }
1557 }
1558
1559 static inline const char*
1560 get_offset_sign (int offset)
1561 {
1562         return offset < 0 ? "-" : "+";
1563 }
1564
1565 static inline int
1566 get_offset_val (int offset)
1567 {
1568         return offset < 0 ? (- offset) : offset;
1569 }
1570
1571 static void
1572 process_variables (MonoCompile *cfg)
1573 {
1574         MonoCompileGC *gcfg = cfg->gc_info;
1575         MonoMethodSignature *sig = mono_method_signature (cfg->method);
1576         int i, locals_min_slot, locals_max_slot, cindex;
1577         MonoBasicBlock *bb;
1578         MonoInst *tmp;
1579         int *pc_offsets;
1580         int locals_min_offset = gcfg->locals_min_offset;
1581         int locals_max_offset = gcfg->locals_max_offset;
1582
1583         /* Slots for locals are NOREF by default */
1584         locals_min_slot = (locals_min_offset - gcfg->min_offset) / SIZEOF_SLOT;
1585         locals_max_slot = (locals_max_offset - gcfg->min_offset) / SIZEOF_SLOT;
1586         for (i = locals_min_slot; i < locals_max_slot; ++i) {
1587                 set_slot_everywhere (gcfg, i, SLOT_NOREF);
1588         }
1589
1590         /*
1591          * Compute the offset where variables are initialized in the first bblock, if any.
1592          */
1593         pc_offsets = g_new0 (int, cfg->next_vreg);
1594
1595         bb = cfg->bb_entry->next_bb;
1596         MONO_BB_FOR_EACH_INS (bb, tmp) {
1597                 if (tmp->opcode == OP_GC_LIVENESS_DEF) {
1598                         int vreg = tmp->inst_c1;
1599                         if (pc_offsets [vreg] == 0) {
1600                                 g_assert (tmp->backend.pc_offset > 0);
1601                                 pc_offsets [vreg] = tmp->backend.pc_offset;
1602                         }
1603                 }
1604         }
1605
1606         /*
1607          * Stack slots holding arguments are initialized in the prolog.
1608          * This means we can treat them alive for the whole method.
1609          */
1610         for (i = 0; i < cfg->num_varinfo; i++) {
1611                 MonoInst *ins = cfg->varinfo [i];
1612                 MonoType *t = ins->inst_vtype;
1613                 MonoMethodVar *vmv;
1614                 guint32 pos;
1615                 gboolean byref, is_this = FALSE;
1616                 gboolean is_arg = i < cfg->locals_start;
1617
1618                 if (ins == cfg->ret) {
1619                         if (!(ins->opcode == OP_REGOFFSET && MONO_TYPE_ISSTRUCT (t)))
1620                                 continue;
1621                 }
1622
1623                 vmv = MONO_VARINFO (cfg, i);
1624
1625                 /* For some reason, 'this' is byref */
1626                 if (sig->hasthis && ins == cfg->args [0] && !cfg->method->klass->valuetype) {
1627                         t = &cfg->method->klass->byval_arg;
1628                         is_this = TRUE;
1629                 }
1630
1631                 byref = t->byref;
1632
1633                 if (ins->opcode == OP_REGVAR) {
1634                         int hreg;
1635                         GCSlotType slot_type;
1636
1637                         t = mini_type_get_underlying_type (NULL, t);
1638
1639                         hreg = ins->dreg;
1640                         g_assert (hreg < MONO_MAX_IREGS);
1641
1642                         if (byref)
1643                                 slot_type = SLOT_PIN;
1644                         else
1645                                 slot_type = mini_type_is_reference (cfg, t) ? SLOT_REF : SLOT_NOREF;
1646
1647                         if (slot_type == SLOT_PIN) {
1648                                 /* These have no live interval, be conservative */
1649                                 set_reg_slot_everywhere (gcfg, hreg, slot_type);
1650                         } else {
1651                                 /*
1652                                  * Unlike variables allocated to the stack, we generate liveness info
1653                                  * for noref vars in registers in mono_spill_global_vars (), because
1654                                  * knowing that a register doesn't contain a ref allows us to mark its save
1655                                  * locations precisely.
1656                                  */
1657                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1658                                         if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1659                                                 set_reg_slot (gcfg, hreg, cindex, slot_type);
1660                         }
1661
1662                         if (cfg->verbose_level > 1) {
1663                                 printf ("\t%s %sreg %s(R%d)\n", slot_type_to_string (slot_type), is_arg ? "arg " : "", mono_arch_regname (hreg), vmv->vreg);
1664                         }
1665
1666                         continue;
1667                 }
1668
1669                 if (ins->opcode != OP_REGOFFSET)
1670                         continue;
1671
1672                 if (ins->inst_offset % SIZEOF_SLOT != 0)
1673                         continue;
1674
1675                 pos = fp_offset_to_slot (cfg, ins->inst_offset);
1676
1677                 if (is_arg && ins->flags & MONO_INST_IS_DEAD) {
1678                         /* These do not get stored in the prolog */
1679                         set_slot_everywhere (gcfg, pos, SLOT_NOREF);
1680
1681                         if (cfg->verbose_level > 1) {
1682                                 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));
1683                         }
1684                         continue;
1685                 }
1686
1687                 if (MONO_TYPE_ISSTRUCT (t)) {
1688                         int numbits = 0, j;
1689                         gsize *bitmap = NULL;
1690                         gboolean pin = FALSE;
1691                         int size;
1692                         int size_in_slots;
1693
1694                         if (ins->backend.is_pinvoke)
1695                                 size = mono_class_native_size (ins->klass, NULL);
1696                         else
1697                                 size = mono_class_value_size (ins->klass, NULL);
1698                         size_in_slots = ALIGN_TO (size, SIZEOF_SLOT) / SIZEOF_SLOT;
1699
1700                         if (cfg->verbose_level > 1)
1701                                 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));
1702
1703                         if (!ins->klass->has_references) {
1704                                 if (is_arg) {
1705                                         for (j = 0; j < size_in_slots; ++j)
1706                                                 set_slot_everywhere (gcfg, pos + j, SLOT_NOREF);
1707                                 }
1708                                 continue;
1709                         }
1710
1711                         bitmap = get_vtype_bitmap (t, &numbits);
1712                         if (!bitmap)
1713                                 pin = TRUE;
1714
1715                         /*
1716                          * Most vtypes are marked volatile because of the LDADDR instructions,
1717                          * and they have no liveness information since they are decomposed
1718                          * before the liveness pass. We emit OP_GC_LIVENESS_DEF instructions for
1719                          * them during VZERO decomposition.
1720                          */
1721                         if (!is_arg) {
1722                                 if (!pc_offsets [vmv->vreg])
1723                                         pin = TRUE;
1724
1725                                 if (ins->backend.is_pinvoke)
1726                                         pin = TRUE;
1727                         }
1728
1729                         if (bitmap) {
1730                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1731                                         if (gcfg->callsites [cindex]->pc_offset > pc_offsets [vmv->vreg]) {
1732                                                 for (j = 0; j < numbits; ++j) {
1733                                                         if (bitmap [j / GC_BITS_PER_WORD] & ((gsize)1 << (j % GC_BITS_PER_WORD))) {
1734                                                                 /* The descriptor is for the boxed object */
1735                                                                 set_slot (gcfg, (pos + j - (sizeof (MonoObject) / SIZEOF_SLOT)), cindex, pin ? SLOT_PIN : SLOT_REF);
1736                                                         }
1737                                                 }
1738                                         }
1739                                 }
1740
1741                                 if (cfg->verbose_level > 1) {
1742                                         for (j = 0; j < numbits; ++j) {
1743                                                 if (bitmap [j / GC_BITS_PER_WORD] & ((gsize)1 << (j % GC_BITS_PER_WORD)))
1744                                                         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)));
1745                                         }
1746                                 }
1747                         } else {
1748                                 if (cfg->verbose_level > 1)
1749                                         printf ("\t\tpinned\n");
1750                                 for (j = 0; j < size_in_slots; ++j) {
1751                                         set_slot_everywhere (gcfg, pos + j, SLOT_PIN);
1752                                 }
1753                         }
1754
1755                         g_free (bitmap);
1756
1757                         continue;
1758                 }
1759
1760                 if (!is_arg && (ins->inst_offset < gcfg->min_offset || ins->inst_offset >= gcfg->max_offset))
1761                         /* Vret addr etc. */
1762                         continue;
1763
1764                 if (t->byref) {
1765                         if (is_arg) {
1766                                 set_slot_everywhere (gcfg, pos, SLOT_PIN);
1767                         } else {
1768                                 for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1769                                         if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1770                                                 set_slot (gcfg, pos, cindex, SLOT_PIN);
1771                         }
1772                         if (cfg->verbose_level > 1)
1773                                 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));
1774                         continue;
1775                 }
1776
1777                 /*
1778                  * This is currently disabled, but could be enabled to debug crashes.
1779                  */
1780 #if 0
1781                 if (t->type == MONO_TYPE_I) {
1782                         /*
1783                          * Variables created in mono_handle_global_vregs have type I, but they
1784                          * could hold GC refs since the vregs they were created from might not been
1785                          * marked as holding a GC ref. So be conservative.
1786                          */
1787                         set_slot_everywhere (gcfg, pos, SLOT_PIN);
1788                         continue;
1789                 }
1790 #endif
1791
1792                 t = mini_type_get_underlying_type (NULL, t);
1793
1794                 if (!mini_type_is_reference (cfg, t)) {
1795                         set_slot_everywhere (gcfg, pos, SLOT_NOREF);
1796                         if (cfg->verbose_level > 1)
1797                                 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));
1798                         if (!t->byref && sizeof (mgreg_t) == 4 && (t->type == MONO_TYPE_I8 || t->type == MONO_TYPE_U8 || t->type == MONO_TYPE_R8)) {
1799                                 set_slot_everywhere (gcfg, pos + 1, SLOT_NOREF);
1800                                 if (cfg->verbose_level > 1)
1801                                         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));
1802                         }
1803                         continue;
1804                 }
1805
1806                 /* 'this' is marked INDIRECT for gshared methods */
1807                 if (ins->flags & (MONO_INST_VOLATILE | MONO_INST_INDIRECT) && !is_this) {
1808                         /*
1809                          * For volatile variables, treat them alive from the point they are
1810                          * initialized in the first bblock until the end of the method.
1811                          */
1812                         if (is_arg) {
1813                                 set_slot_everywhere (gcfg, pos, SLOT_REF);
1814                         } else if (pc_offsets [vmv->vreg]) {
1815                                 set_slot_in_range (gcfg, pos, 0, pc_offsets [vmv->vreg], SLOT_PIN);
1816                                 set_slot_in_range (gcfg, pos, pc_offsets [vmv->vreg], cfg->code_size, SLOT_REF);
1817                         } else {
1818                                 set_slot_everywhere (gcfg, pos, SLOT_PIN);
1819                         }
1820                         if (cfg->verbose_level > 1)
1821                                 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));
1822                         continue;
1823                 }
1824
1825                 if (is_arg) {
1826                         /* Live for the whole method */
1827                         set_slot_everywhere (gcfg, pos, SLOT_REF);
1828                 } else {
1829                         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex)
1830                                 if (gcfg->callsites [cindex]->liveness [i / 8] & (1 << (i % 8)))
1831                                         set_slot (gcfg, pos, cindex, SLOT_REF);
1832                 }
1833
1834                 if (cfg->verbose_level > 1) {
1835                         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));
1836                 }
1837         }
1838
1839         g_free (pc_offsets);
1840 }
1841
1842 static int
1843 sp_offset_to_fp_offset (MonoCompile *cfg, int sp_offset)
1844 {
1845         /*
1846          * Convert a sp relative offset to a slot index. This is
1847          * platform specific.
1848          */
1849 #ifdef TARGET_AMD64
1850         /* fp = sp + offset */
1851         g_assert (cfg->frame_reg == AMD64_RBP);
1852         return (- cfg->arch.sp_fp_offset + sp_offset);
1853 #elif defined(TARGET_X86)
1854         /* The offset is computed from the sp at the start of the call sequence */
1855         g_assert (cfg->frame_reg == X86_EBP);
1856         return (- cfg->arch.sp_fp_offset - sp_offset);
1857 #else
1858         NOT_IMPLEMENTED;
1859         return -1;
1860 #endif
1861 }
1862
1863 static void
1864 process_param_area_slots (MonoCompile *cfg)
1865 {
1866         MonoCompileGC *gcfg = cfg->gc_info;
1867         int cindex, i;
1868         gboolean *is_param;
1869
1870         /*
1871          * These slots are used for passing parameters during calls. They are sp relative, not
1872          * fp relative, so they are harder to handle.
1873          */
1874         if (cfg->flags & MONO_CFG_HAS_ALLOCA)
1875                 /* The distance between fp and sp is not constant */
1876                 return;
1877
1878         is_param = mono_mempool_alloc0 (cfg->mempool, gcfg->nslots * sizeof (gboolean));
1879
1880         for (cindex = 0; cindex < gcfg->ncallsites; ++cindex) {
1881                 GCCallSite *callsite = gcfg->callsites [cindex];
1882                 GSList *l;
1883
1884                 for (l = callsite->param_slots; l; l = l->next) {
1885                         MonoInst *def = l->data;
1886                         MonoType *t = def->inst_vtype;
1887                         int sp_offset = def->inst_offset;
1888                         int fp_offset = sp_offset_to_fp_offset (cfg, sp_offset);
1889                         int slot = fp_offset_to_slot (cfg, fp_offset);
1890                         guint32 align;
1891                         guint32 size;
1892
1893                         if (MONO_TYPE_ISSTRUCT (t)) {
1894                                 size = mini_type_stack_size_full (cfg->generic_sharing_context, t, &align, FALSE);
1895                         } else {
1896                                 size = sizeof (mgreg_t);
1897                         }
1898
1899                         for (i = 0; i < size / sizeof (mgreg_t); ++i) {
1900                                 g_assert (slot + i >= 0 && slot + i < gcfg->nslots);
1901                                 is_param [slot + i] = TRUE;
1902                         }
1903                 }
1904         }
1905
1906         /* All param area slots are noref by default */
1907         for (i = 0; i < gcfg->nslots; ++i) {
1908                 if (is_param [i])
1909                         set_slot_everywhere (gcfg, i, SLOT_NOREF);
1910         }
1911
1912         /*
1913          * We treat param area slots as being part of the callee's frame, to be able to handle tail calls which overwrite
1914          * the argument area of the caller.
1915          */
1916 }
1917
1918 static void
1919 process_finally_clauses (MonoCompile *cfg)
1920 {
1921         MonoCompileGC *gcfg = cfg->gc_info;
1922         GCCallSite **callsites;
1923         int ncallsites;
1924         gboolean has_finally;
1925         int i, j, nslots, nregs;
1926
1927         ncallsites = gcfg->ncallsites;
1928         nslots = gcfg->nslots;
1929         nregs = gcfg->nregs;
1930         callsites = gcfg->callsites;
1931
1932         /*
1933          * The calls to the finally clauses don't show up in the cfg. See
1934          * test_0_liveness_8 ().
1935          * Variables accessed inside the finally clause are already marked VOLATILE by
1936          * mono_liveness_handle_exception_clauses (). Variables not accessed inside the finally clause have
1937          * correct liveness outside the finally clause. So mark them PIN inside the finally clauses.
1938          */
1939         has_finally = FALSE;
1940         for (i = 0; i < cfg->header->num_clauses; ++i) {
1941                 MonoExceptionClause *clause = &cfg->header->clauses [i];
1942
1943                 if (clause->flags == MONO_EXCEPTION_CLAUSE_FINALLY) {
1944                         has_finally = TRUE;
1945                 }
1946         }
1947         if (has_finally) {
1948                 if (cfg->verbose_level > 1)
1949                         printf ("\tMethod has finally clauses, pessimizing live ranges.\n");
1950                 for (j = 0; j < ncallsites; ++j) {
1951                         MonoBasicBlock *bb = callsites [j]->bb;
1952                         MonoExceptionClause *clause;
1953                         gboolean is_in_finally = FALSE;
1954
1955                         for (i = 0; i < cfg->header->num_clauses; ++i) {
1956                                 clause = &cfg->header->clauses [i];
1957
1958                                 if (MONO_OFFSET_IN_HANDLER (clause, bb->real_offset)) {
1959                                         if (clause->flags == MONO_EXCEPTION_CLAUSE_FINALLY) {
1960                                                 is_in_finally = TRUE;
1961                                                 break;
1962                                         }
1963                                 }
1964                         }
1965
1966                         if (is_in_finally) {
1967                                 for (i = 0; i < nslots; ++i)
1968                                         set_slot (gcfg, i, j, SLOT_PIN);
1969                                 for (i = 0; i < nregs; ++i)
1970                                         set_reg_slot (gcfg, i, j, SLOT_PIN);
1971                         }
1972                 }
1973         }
1974 }
1975
1976 static void
1977 compute_frame_size (MonoCompile *cfg)
1978 {
1979         int i, locals_min_offset, locals_max_offset, cfa_min_offset, cfa_max_offset;
1980         int min_offset, max_offset;
1981         MonoCompileGC *gcfg = cfg->gc_info;
1982         MonoMethodSignature *sig = mono_method_signature (cfg->method);
1983         GSList *l;
1984
1985         /* Compute min/max offsets from the fp */
1986
1987         /* Locals */
1988 #if defined(TARGET_AMD64) || defined(TARGET_X86) || defined(TARGET_ARM) || defined(TARGET_S390X)
1989         locals_min_offset = ALIGN_TO (cfg->locals_min_stack_offset, SIZEOF_SLOT);
1990         locals_max_offset = cfg->locals_max_stack_offset;
1991 #else
1992         /* min/max stack offset needs to be computed in mono_arch_allocate_vars () */
1993         NOT_IMPLEMENTED;
1994 #endif
1995
1996         locals_min_offset = ALIGN_TO (locals_min_offset, SIZEOF_SLOT);
1997         locals_max_offset = ALIGN_TO (locals_max_offset, SIZEOF_SLOT);
1998
1999         min_offset = locals_min_offset;
2000         max_offset = locals_max_offset;
2001
2002         /* Arguments */
2003         for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
2004                 MonoInst *ins = cfg->args [i];
2005
2006                 if (ins->opcode == OP_REGOFFSET) {
2007                         int size, size_in_slots;
2008                         size = mini_type_stack_size_full (cfg->generic_sharing_context, ins->inst_vtype, NULL, ins->backend.is_pinvoke);
2009                         size_in_slots = ALIGN_TO (size, SIZEOF_SLOT) / SIZEOF_SLOT;
2010
2011                         min_offset = MIN (min_offset, ins->inst_offset);
2012                         max_offset = MAX ((int)max_offset, (int)(ins->inst_offset + (size_in_slots * SIZEOF_SLOT)));
2013                 }
2014         }
2015
2016         /* Cfa slots */
2017         g_assert (cfg->frame_reg == cfg->cfa_reg);
2018         g_assert (cfg->cfa_offset > 0);
2019         cfa_min_offset = 0;
2020         cfa_max_offset = cfg->cfa_offset;
2021
2022         min_offset = MIN (min_offset, cfa_min_offset);
2023         max_offset = MAX (max_offset, cfa_max_offset);
2024
2025         /* Fp relative slots */
2026         for (l = gcfg->stack_slots_from_fp; l; l = l->next) {
2027                 gint data = GPOINTER_TO_INT (l->data);
2028                 int offset = data >> 16;
2029
2030                 min_offset = MIN (min_offset, offset);
2031         }
2032
2033         /* Spill slots */
2034         if (!(cfg->flags & MONO_CFG_HAS_SPILLUP)) {
2035                 int stack_offset = ALIGN_TO (cfg->stack_offset, SIZEOF_SLOT);
2036                 min_offset = MIN (min_offset, (-stack_offset));
2037         }
2038
2039         /* Param area slots */
2040 #ifdef TARGET_AMD64
2041         min_offset = MIN (min_offset, -cfg->arch.sp_fp_offset);
2042 #elif defined(TARGET_X86)
2043         min_offset = MIN (min_offset, - (cfg->arch.sp_fp_offset + cfg->arch.param_area_size));
2044 #elif defined(TARGET_ARM)
2045         // FIXME:
2046 #elif defined(TARGET_s390X)
2047         // FIXME:
2048 #else
2049         NOT_IMPLEMENTED;
2050 #endif
2051
2052         gcfg->min_offset = min_offset;
2053         gcfg->max_offset = max_offset;
2054         gcfg->locals_min_offset = locals_min_offset;
2055         gcfg->locals_max_offset = locals_max_offset;
2056 }
2057
2058 static void
2059 init_gcfg (MonoCompile *cfg)
2060 {
2061         int i, nregs, nslots;
2062         MonoCompileGC *gcfg = cfg->gc_info;
2063         GCCallSite **callsites;
2064         int ncallsites;
2065         MonoBasicBlock *bb;
2066         GSList *l;
2067
2068         /*
2069          * Collect callsites
2070          */
2071         ncallsites = 0;
2072         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
2073                 ncallsites += g_slist_length (bb->gc_callsites);
2074         }
2075         callsites = mono_mempool_alloc0 (cfg->mempool, ncallsites * sizeof (GCCallSite*));
2076         i = 0;
2077         for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
2078                 for (l = bb->gc_callsites; l; l = l->next)
2079                         callsites [i++] = l->data;
2080         }
2081
2082         /* The callsites should already be ordered by pc offset */
2083         for (i = 1; i < ncallsites; ++i)
2084                 g_assert (callsites [i - 1]->pc_offset < callsites [i]->pc_offset);
2085
2086         /*
2087          * The stack frame looks like this:
2088          *
2089          * <fp + max_offset> == cfa ->  <end of previous frame>
2090          *                              <other stack slots>
2091          *                              <locals>
2092          *                              <other stack slots>
2093          * fp + min_offset          ->
2094          * ...
2095          * fp                       ->
2096          */
2097
2098         if (cfg->verbose_level > 1)
2099                 printf ("GC Map for %s: 0x%x-0x%x\n", mono_method_full_name (cfg->method, TRUE), gcfg->min_offset, gcfg->max_offset);
2100
2101         nslots = (gcfg->max_offset - gcfg->min_offset) / SIZEOF_SLOT;
2102         nregs = NREGS;
2103
2104         gcfg->nslots = nslots;
2105         gcfg->nregs = nregs;
2106         gcfg->callsites = callsites;
2107         gcfg->ncallsites = ncallsites;
2108         gcfg->stack_bitmap_width = ALIGN_TO (ncallsites, 8) / 8;
2109         gcfg->reg_bitmap_width = ALIGN_TO (ncallsites, 8) / 8;
2110         gcfg->stack_ref_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->stack_bitmap_width * nslots);
2111         gcfg->stack_pin_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->stack_bitmap_width * nslots);
2112         gcfg->reg_ref_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->reg_bitmap_width * nregs);
2113         gcfg->reg_pin_bitmap = mono_mempool_alloc0 (cfg->mempool, gcfg->reg_bitmap_width * nregs);
2114
2115         /* All slots start out as PIN */
2116         memset (gcfg->stack_pin_bitmap, 0xff, gcfg->stack_bitmap_width * nregs);
2117         for (i = 0; i < nregs; ++i) {
2118                 /*
2119                  * By default, registers are NOREF.
2120                  * It is possible for a callee to save them before being defined in this method,
2121                  * but the saved value is dead too, so it doesn't need to be marked.
2122                  */
2123                 if ((cfg->used_int_regs & (1 << i)))
2124                         set_reg_slot_everywhere (gcfg, i, SLOT_NOREF);
2125         }
2126 }
2127
2128 static inline gboolean
2129 has_bit_set (guint8 *bitmap, int width, int slot)
2130 {
2131         int i;
2132         int pos = width * slot;
2133
2134         for (i = 0; i < width; ++i) {
2135                 if (bitmap [pos + i])
2136                         break;
2137         }
2138         return i < width;
2139 }
2140
2141 static void
2142 create_map (MonoCompile *cfg)
2143 {
2144         GCMap *map;
2145         int i, j, nregs, nslots, nref_regs, npin_regs, alloc_size, bitmaps_size, bitmaps_offset;
2146         int ntypes [16];
2147         int stack_bitmap_width, stack_bitmap_size, reg_ref_bitmap_width, reg_ref_bitmap_size;
2148         int reg_pin_bitmap_width, reg_pin_bitmap_size, bindex;
2149         int start, end;
2150         gboolean has_ref_slots, has_pin_slots, has_ref_regs, has_pin_regs;
2151         MonoCompileGC *gcfg = cfg->gc_info;
2152         GCCallSite **callsites;
2153         int ncallsites;
2154         guint8 *bitmap, *bitmaps;
2155         guint32 reg_ref_mask, reg_pin_mask;
2156
2157         ncallsites = gcfg->ncallsites;
2158         nslots = gcfg->nslots;
2159         nregs = gcfg->nregs;
2160         callsites = gcfg->callsites;
2161
2162         /*
2163          * Compute the real size of the bitmap i.e. ignore NOREF columns at the beginning and at
2164          * the end. Also, compute whenever the map needs ref/pin bitmaps, and collect stats.
2165          */
2166         has_ref_slots = FALSE;
2167         has_pin_slots = FALSE;
2168         start = -1;
2169         end = -1;
2170         memset (ntypes, 0, sizeof (ntypes));
2171         for (i = 0; i < nslots; ++i) {
2172                 gboolean has_ref = FALSE;
2173                 gboolean has_pin = FALSE;
2174
2175                 if (has_bit_set (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, i))
2176                         has_pin = TRUE;
2177                 if (has_bit_set (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, i))
2178                         has_ref = TRUE;
2179
2180                 if (has_ref)
2181                         has_ref_slots = TRUE;
2182                 if (has_pin)
2183                         has_pin_slots = TRUE;
2184
2185                 if (has_ref)
2186                         ntypes [SLOT_REF] ++;
2187                 else if (has_pin)
2188                         ntypes [SLOT_PIN] ++;
2189                 else
2190                         ntypes [SLOT_NOREF] ++;
2191
2192                 if (has_ref || has_pin) {
2193                         if (start == -1)
2194                                 start = i;
2195                         end = i + 1;
2196                 }
2197         }
2198         if (start == -1) {
2199                 start = end = nslots;
2200         } else {
2201                 g_assert (start != -1);
2202                 g_assert (start < end);
2203         }
2204
2205         has_ref_regs = FALSE;
2206         has_pin_regs = FALSE;
2207         reg_ref_mask = 0;
2208         reg_pin_mask = 0;
2209         nref_regs = 0;
2210         npin_regs = 0;
2211         for (i = 0; i < nregs; ++i) {
2212                 gboolean has_ref = FALSE;
2213                 gboolean has_pin = FALSE;
2214
2215                 if (!(cfg->used_int_regs & (1 << i)))
2216                         continue;
2217
2218                 if (has_bit_set (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, i))
2219                         has_pin = TRUE;
2220                 if (has_bit_set (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, i))
2221                         has_ref = TRUE;
2222
2223                 if (has_ref) {
2224                         reg_ref_mask |= (1 << i);
2225                         has_ref_regs = TRUE;
2226                         nref_regs ++;
2227                 }
2228                 if (has_pin) {
2229                         reg_pin_mask |= (1 << i);
2230                         has_pin_regs = TRUE;
2231                         npin_regs ++;
2232                 }
2233         }
2234
2235         if (cfg->verbose_level > 1)
2236                 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);
2237
2238         /* Create the GC Map */
2239
2240         /* The work bitmaps have one row for each slot, since this is how we access them during construction */
2241         stack_bitmap_width = ALIGN_TO (end - start, 8) / 8;
2242         stack_bitmap_size = stack_bitmap_width * ncallsites;
2243         reg_ref_bitmap_width = ALIGN_TO (nref_regs, 8) / 8;
2244         reg_ref_bitmap_size = reg_ref_bitmap_width * ncallsites;
2245         reg_pin_bitmap_width = ALIGN_TO (npin_regs, 8) / 8;
2246         reg_pin_bitmap_size = reg_pin_bitmap_width * ncallsites;
2247         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);
2248
2249         map = mono_mempool_alloc0 (cfg->mempool, sizeof (GCMap));
2250
2251         map->frame_reg = cfg->frame_reg;
2252         map->start_offset = gcfg->min_offset;
2253         map->end_offset = gcfg->min_offset + (nslots * SIZEOF_SLOT);
2254         map->map_offset = start * SIZEOF_SLOT;
2255         map->nslots = end - start;
2256         map->has_ref_slots = has_ref_slots;
2257         map->has_pin_slots = has_pin_slots;
2258         map->has_ref_regs = has_ref_regs;
2259         map->has_pin_regs = has_pin_regs;
2260         g_assert (nregs < 32);
2261         map->used_int_regs = cfg->used_int_regs;
2262         map->reg_ref_mask = reg_ref_mask;
2263         map->reg_pin_mask = reg_pin_mask;
2264         map->nref_regs = nref_regs;
2265         map->npin_regs = npin_regs;
2266
2267         bitmaps = mono_mempool_alloc0 (cfg->mempool, bitmaps_size);
2268
2269         bitmaps_offset = 0;
2270         if (has_ref_slots) {
2271                 map->stack_ref_bitmap_offset = bitmaps_offset;
2272                 bitmaps_offset += stack_bitmap_size;
2273
2274                 bitmap = &bitmaps [map->stack_ref_bitmap_offset];
2275                 for (i = 0; i < nslots; ++i) {
2276                         for (j = 0; j < ncallsites; ++j) {
2277                                 if (get_bit (gcfg->stack_ref_bitmap, gcfg->stack_bitmap_width, i, j))
2278                                         set_bit (bitmap, stack_bitmap_width, j, i - start);
2279                         }
2280                 }
2281         }
2282         if (has_pin_slots) {
2283                 map->stack_pin_bitmap_offset = bitmaps_offset;
2284                 bitmaps_offset += stack_bitmap_size;
2285
2286                 bitmap = &bitmaps [map->stack_pin_bitmap_offset];
2287                 for (i = 0; i < nslots; ++i) {
2288                         for (j = 0; j < ncallsites; ++j) {
2289                                 if (get_bit (gcfg->stack_pin_bitmap, gcfg->stack_bitmap_width, i, j))
2290                                         set_bit (bitmap, stack_bitmap_width, j, i - start);
2291                         }
2292                 }
2293         }
2294         if (has_ref_regs) {
2295                 map->reg_ref_bitmap_offset = bitmaps_offset;
2296                 bitmaps_offset += reg_ref_bitmap_size;
2297
2298                 bitmap = &bitmaps [map->reg_ref_bitmap_offset];
2299                 bindex = 0;
2300                 for (i = 0; i < nregs; ++i) {
2301                         if (reg_ref_mask & (1 << i)) {
2302                                 for (j = 0; j < ncallsites; ++j) {
2303                                         if (get_bit (gcfg->reg_ref_bitmap, gcfg->reg_bitmap_width, i, j))
2304                                                 set_bit (bitmap, reg_ref_bitmap_width, j, bindex);
2305                                 }
2306                                 bindex ++;
2307                         }
2308                 }
2309         }
2310         if (has_pin_regs) {
2311                 map->reg_pin_bitmap_offset = bitmaps_offset;
2312                 bitmaps_offset += reg_pin_bitmap_size;
2313
2314                 bitmap = &bitmaps [map->reg_pin_bitmap_offset];
2315                 bindex = 0;
2316                 for (i = 0; i < nregs; ++i) {
2317                         if (reg_pin_mask & (1 << i)) {
2318                                 for (j = 0; j < ncallsites; ++j) {
2319                                         if (get_bit (gcfg->reg_pin_bitmap, gcfg->reg_bitmap_width, i, j))
2320                                                 set_bit (bitmap, reg_pin_bitmap_width, j, bindex);
2321                                 }
2322                                 bindex ++;
2323                         }
2324                 }
2325         }
2326
2327         /* Call sites */
2328         map->ncallsites = ncallsites;
2329         if (cfg->code_len < 256)
2330                 map->callsite_entry_size = 1;
2331         else if (cfg->code_len < 65536)
2332                 map->callsite_entry_size = 2;
2333         else
2334                 map->callsite_entry_size = 4;
2335
2336         /* Encode the GC Map */
2337         {
2338                 guint8 buf [256];
2339                 guint8 *endbuf;
2340                 GCEncodedMap *emap;
2341                 int encoded_size;
2342                 guint8 *p;
2343
2344                 encode_gc_map (map, buf, &endbuf);
2345                 g_assert (endbuf - buf < 256);
2346
2347                 encoded_size = endbuf - buf;
2348                 alloc_size = sizeof (GCEncodedMap) + ALIGN_TO (encoded_size, map->callsite_entry_size) + (map->callsite_entry_size * map->ncallsites) + bitmaps_size;
2349
2350                 emap = mono_domain_alloc0 (cfg->domain, alloc_size);
2351                 //emap->ref_slots = map->ref_slots;
2352
2353                 /* Encoded fixed fields */
2354                 p = &emap->encoded [0];
2355                 //emap->encoded_size = encoded_size;
2356                 memcpy (p, buf, encoded_size);
2357                 p += encoded_size;
2358
2359                 /* Callsite table */
2360                 p = (guint8*)ALIGN_TO ((mgreg_t)p, map->callsite_entry_size);
2361                 if (map->callsite_entry_size == 1) {
2362                         guint8 *offsets = p;
2363                         for (i = 0; i < ncallsites; ++i)
2364                                 offsets [i] = callsites [i]->pc_offset;
2365                         stats.gc_callsites8_size += ncallsites * sizeof (guint8);
2366                 } else if (map->callsite_entry_size == 2) {
2367                         guint16 *offsets = (guint16*)p;
2368                         for (i = 0; i < ncallsites; ++i)
2369                                 offsets [i] = callsites [i]->pc_offset;
2370                         stats.gc_callsites16_size += ncallsites * sizeof (guint16);
2371                 } else {
2372                         guint32 *offsets = (guint32*)p;
2373                         for (i = 0; i < ncallsites; ++i)
2374                                 offsets [i] = callsites [i]->pc_offset;
2375                         stats.gc_callsites32_size += ncallsites * sizeof (guint32);
2376                 }
2377                 p += ncallsites * map->callsite_entry_size;
2378
2379                 /* Bitmaps */
2380                 memcpy (p, bitmaps, bitmaps_size);
2381                 p += bitmaps_size;
2382
2383                 g_assert ((guint8*)p - (guint8*)emap <= alloc_size);
2384
2385                 stats.gc_maps_size += alloc_size;
2386                 stats.gc_callsites_size += ncallsites * map->callsite_entry_size;
2387                 stats.gc_bitmaps_size += bitmaps_size;
2388                 stats.gc_map_struct_size += sizeof (GCEncodedMap) + encoded_size;
2389
2390                 cfg->jit_info->gc_info = emap;
2391
2392                 cfg->gc_map = (guint8*)emap;
2393                 cfg->gc_map_size = alloc_size;
2394         }
2395
2396         stats.all_slots += nslots;
2397         stats.ref_slots += ntypes [SLOT_REF];
2398         stats.noref_slots += ntypes [SLOT_NOREF];
2399         stats.pin_slots += ntypes [SLOT_PIN];
2400 }
2401
2402 void
2403 mini_gc_create_gc_map (MonoCompile *cfg)
2404 {
2405         if (!cfg->compute_gc_maps)
2406                 return;
2407
2408         /*
2409          * During marking, all frames except the top frame are at a call site, and we mark the
2410          * top frame conservatively. This means that we only need to compute and record
2411          * GC maps for call sites.
2412          */
2413
2414         if (!(cfg->comp_done & MONO_COMP_LIVENESS))
2415                 /* Without liveness info, the live ranges are not precise enough */
2416                 return;
2417
2418         mono_analyze_liveness_gc (cfg);
2419
2420         compute_frame_size (cfg);
2421
2422         init_gcfg (cfg);
2423
2424         process_spill_slots (cfg);
2425         process_other_slots (cfg);
2426         process_param_area_slots (cfg);
2427         process_variables (cfg);
2428         process_finally_clauses (cfg);
2429
2430         create_map (cfg);
2431 }
2432
2433 #endif /* DISABLE_JIT */
2434
2435 static void
2436 parse_debug_options (void)
2437 {
2438         char **opts, **ptr;
2439         char *env;
2440
2441         env = getenv ("MONO_GCMAP_DEBUG");
2442         if (!env)
2443                 return;
2444
2445         opts = g_strsplit (env, ",", -1);
2446         for (ptr = opts; ptr && *ptr; ptr ++) {
2447                 /* No options yet */
2448                 fprintf (stderr, "Invalid format for the MONO_GCMAP_DEBUG env variable: '%s'\n", env);
2449                 exit (1);
2450         }
2451         g_strfreev (opts);
2452 }
2453
2454 void
2455 mini_gc_init (void)
2456 {
2457         MonoGCCallbacks cb;
2458
2459         memset (&cb, 0, sizeof (cb));
2460         cb.thread_attach_func = thread_attach_func;
2461         cb.thread_detach_func = thread_detach_func;
2462         cb.thread_suspend_func = thread_suspend_func;
2463         /* Comment this out to disable precise stack marking */
2464         cb.thread_mark_func = thread_mark_func;
2465         mono_gc_set_gc_callbacks (&cb);
2466
2467         logfile = mono_gc_get_logfile ();
2468
2469         parse_debug_options ();
2470
2471         mono_counters_register ("GC Maps size",
2472                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_maps_size);
2473         mono_counters_register ("GC Call Sites size",
2474                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites_size);
2475         mono_counters_register ("GC Bitmaps size",
2476                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_bitmaps_size);
2477         mono_counters_register ("GC Map struct size",
2478                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_map_struct_size);
2479         mono_counters_register ("GC Call Sites encoded using 8 bits",
2480                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites8_size);
2481         mono_counters_register ("GC Call Sites encoded using 16 bits",
2482                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites16_size);
2483         mono_counters_register ("GC Call Sites encoded using 32 bits",
2484                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.gc_callsites32_size);
2485
2486         mono_counters_register ("GC Map slots (all)",
2487                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.all_slots);
2488         mono_counters_register ("GC Map slots (ref)",
2489                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.ref_slots);
2490         mono_counters_register ("GC Map slots (noref)",
2491                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.noref_slots);
2492         mono_counters_register ("GC Map slots (pin)",
2493                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.pin_slots);
2494
2495         mono_counters_register ("GC TLS Data size",
2496                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.tlsdata_size);
2497
2498         mono_counters_register ("Stack space scanned (all)",
2499                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_stacks);
2500         mono_counters_register ("Stack space scanned (native)",
2501                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_native);
2502         mono_counters_register ("Stack space scanned (other)",
2503                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_other);
2504         mono_counters_register ("Stack space scanned (using GC Maps)",
2505                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned);
2506         mono_counters_register ("Stack space scanned (precise)",
2507                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_precisely);
2508         mono_counters_register ("Stack space scanned (pin)",
2509                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_conservatively);
2510         mono_counters_register ("Stack space scanned (pin registers)",
2511                                                         MONO_COUNTER_GC | MONO_COUNTER_INT, &stats.scanned_registers);
2512 }
2513
2514 #else
2515
2516 void
2517 mini_gc_enable_gc_maps_for_aot (void)
2518 {
2519 }
2520
2521 void
2522 mini_gc_init (void)
2523 {
2524 }
2525
2526 #ifndef DISABLE_JIT
2527
2528 static void
2529 mini_gc_init_gc_map (MonoCompile *cfg)
2530 {
2531 }
2532
2533 void
2534 mini_gc_create_gc_map (MonoCompile *cfg)
2535 {
2536 }
2537
2538 void
2539 mini_gc_set_slot_type_from_fp (MonoCompile *cfg, int slot_offset, GCSlotType type)
2540 {
2541 }
2542
2543 void
2544 mini_gc_set_slot_type_from_cfa (MonoCompile *cfg, int slot_offset, GCSlotType type)
2545 {
2546 }
2547
2548 #endif /* DISABLE_JIT */
2549
2550 void
2551 mini_gc_enable_gc_maps_for_aot (void)
2552 {
2553 }
2554
2555 #endif
2556
2557 #ifndef DISABLE_JIT
2558
2559 /*
2560  * mini_gc_init_cfg:
2561  *
2562  *   Set GC specific options in CFG.
2563  */
2564 void
2565 mini_gc_init_cfg (MonoCompile *cfg)
2566 {
2567         if (mono_gc_is_moving ()) {
2568                 cfg->disable_ref_noref_stack_slot_share = TRUE;
2569                 cfg->gen_write_barriers = TRUE;
2570         }
2571
2572         mini_gc_init_gc_map (cfg);
2573 }
2574
2575 #endif /* DISABLE_JIT */
2576
2577 /*
2578  * Problems with the current code:
2579  * - the stack walk is slow
2580  * - vtypes/refs used in EH regions are treated conservatively
2581  * - if the code is finished, less pinning will be done, causing problems because
2582  *   we promote all surviving objects to old-gen.
2583  * - the unwind code can't handle a method stopped inside a finally region, it thinks the caller is
2584  *   another method, but in reality it is either the exception handling code or the CALL_HANDLER opcode.
2585  *   This manifests in "Unable to find ip offset x in callsite list" assertions.
2586  * - the unwind code also can't handle frames which are in the epilog, since the unwind info is not
2587  *   precise there.
2588  */
2589
2590 /*
2591  * Ideas for creating smaller GC maps:
2592  * - remove empty columns from the bitmaps. This requires adding a mask bit array for
2593  *   each bitmap.
2594  * - merge reg and stack slot bitmaps, so the unused bits at the end of the reg bitmap are
2595  *   not wasted.
2596  * - if the bitmap width is not a multiple of 8, the remaining bits are wasted.
2597  * - group ref and non-ref stack slots together in mono_allocate_stack_slots ().
2598  * - add an index for the callsite table so that each entry can be encoded as a 1 byte difference
2599  *   from an index entry.
2600  */