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