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