src/jit/emit.h

   1 // Licensed to the .NET Foundation under one or more agreements.
   2 // The .NET Foundation licenses this file to you under the MIT license.
   3 // See the LICENSE file in the project root for more information.
   4 /*****************************************************************************/
   5
   6 #ifndef _EMIT_H_
   7 #define _EMIT_H_
   8
   9 #include "instr.h"
  10
  11 #ifndef _GCINFO_H_
  12 #include "gcinfo.h"
  13 #endif
  14
  15 #include "jitgcinfo.h"
  16
  17 /*****************************************************************************/
  18 #ifdef TRANSLATE_PDB
  19 #ifndef _ADDRMAP_INCLUDED_
  20 #include "addrmap.h"
  21 #endif
  22 #ifndef _LOCALMAP_INCLUDED_
  23 #include "localmap.h"
  24 #endif
  25 #ifndef _PDBREWRITE_H_
  26 #include "pdbrewrite.h"
  27 #endif
  28 #endif // TRANSLATE_PDB
  29
  30 /*****************************************************************************/
  31 #ifdef _MSC_VER
  32 #pragma warning(disable : 4200) // allow arrays of 0 size inside structs
  33 #endif
  34 #define TRACK_GC_TEMP_LIFETIMES 0
  35
  36 /*****************************************************************************/
  37
  38 #if 0
  39 #define EMITVERBOSE 1
  40 #else
  41 #define EMITVERBOSE (emitComp->verbose)
  42 #endif
  43
  44 #if 0
  45 #define EMIT_GC_VERBOSE 0
  46 #else
  47 #define EMIT_GC_VERBOSE (emitComp->verbose)
  48 #endif
  49
  50 #if 1
  51 #define EMIT_INSTLIST_VERBOSE 0
  52 #else
  53 #define EMIT_INSTLIST_VERBOSE (emitComp->verbose)
  54 #endif
  55
  56 /*****************************************************************************/
  57
  58 #ifdef DEBUG
  59 #define DEBUG_EMIT 1
  60 #else
  61 #define DEBUG_EMIT 0
  62 #endif
  63
  64 #if EMITTER_STATS
  65 void emitterStats(FILE* fout);
  66 void emitterStaticStats(FILE* fout); // Static stats about the emitter (data structure offsets, sizes, etc.)
  67 #endif
  68
  69 void printRegMaskInt(regMaskTP mask);
  70
  71 /*****************************************************************************/
  72 /* Forward declarations */
  73
  74 class emitLocation;
  75 class emitter;
  76 struct insGroup;
  77
  78 typedef void (*emitSplitCallbackType)(void* context, emitLocation* emitLoc);
  79
  80 /*****************************************************************************/
  81
  82 //-----------------------------------------------------------------------------
  83
  84 inline bool needsGC(GCtype gcType)
  85 {
  86     if (gcType == GCT_NONE)
  87     {
  88         return false;
  89     }
  90     else
  91     {
  92         assert(gcType == GCT_GCREF || gcType == GCT_BYREF);
  93         return true;
  94     }
  95 }
  96
  97 //-----------------------------------------------------------------------------
  98
  99 #ifdef DEBUG
 100
 101 inline bool IsValidGCtype(GCtype gcType)
 102 {
 103     return (gcType == GCT_NONE || gcType == GCT_GCREF || gcType == GCT_BYREF);
 104 }
 105
 106 // Get a string name to represent the GC type
 107
 108 inline const char* GCtypeStr(GCtype gcType)
 109 {
 110     switch (gcType)
 111     {
 112         case GCT_NONE:
 113             return "npt";
 114         case GCT_GCREF:
 115             return "gcr";
 116         case GCT_BYREF:
 117             return "byr";
 118         default:
 119             assert(!"Invalid GCtype");
 120             return "err";
 121     }
 122 }
 123
 124 #endif // DEBUG
 125
 126 /*****************************************************************************/
 127
 128 #if DEBUG_EMIT
 129 #define INTERESTING_JUMP_NUM -1 // set to 0 to see all jump info
 130 //#define INTERESTING_JUMP_NUM    0
 131 #endif
 132
 133 /*****************************************************************************
 134  *
 135  *  Represent an emitter location.
 136  */
 137
 138 class emitLocation
 139 {
 140 public:
 141     emitLocation() : ig(nullptr), codePos(0)
 142     {
 143     }
 144
 145     emitLocation(insGroup* _ig) : ig(_ig), codePos(0)
 146     {
 147     }
 148
 149     emitLocation(void* emitCookie) : ig((insGroup*)emitCookie), codePos(0)
 150     {
 151     }
 152
 153     // A constructor for code that needs to call it explicitly.
 154     void Init()
 155     {
 156         this->emitLocation::emitLocation();
 157     }
 158
 159     void CaptureLocation(emitter* emit);
 160
 161     bool IsCurrentLocation(emitter* emit) const;
 162
 163     // This function is highly suspect, since it presumes knowledge of the codePos "cookie",
 164     // and doesn't look at the 'ig' pointer.
 165     bool IsOffsetZero() const
 166     {
 167         return (codePos == 0);
 168     }
 169
 170     UNATIVE_OFFSET CodeOffset(emitter* emit) const;
 171
 172     insGroup* GetIG() const
 173     {
 174         return ig;
 175     }
 176
 177     int GetInsNum() const;
 178
 179     bool operator!=(const emitLocation& other) const
 180     {
 181         return (ig != other.ig) || (codePos != other.codePos);
 182     }
 183
 184     bool operator==(const emitLocation& other) const
 185     {
 186         return !(*this != other);
 187     }
 188
 189     bool Valid() const
 190     {
 191         // Things we could validate:
 192         //   1. the instruction group pointer is non-nullptr.
 193         //   2. 'ig' is a legal pointer to an instruction group.
 194         //   3. 'codePos' is a legal offset into 'ig'.
 195         // Currently, we just do #1.
 196         // #2 and #3 should only be done in DEBUG, if they are implemented.
 197
 198         if (ig == nullptr)
 199         {
 200             return false;
 201         }
 202
 203         return true;
 204     }
 205
 206 #ifdef _TARGET_AMD64_
 207     UNATIVE_OFFSET GetFuncletPrologOffset(emitter* emit) const;
 208 #endif // _TARGET_AMD64_
 209
 210 #ifdef DEBUG
 211     void Print() const;
 212 #endif // DEBUG
 213
 214 private:
 215     insGroup* ig;      // the instruction group
 216     unsigned  codePos; // the code position within the IG (see emitCurOffset())
 217 };
 218
 219 /************************************************************************/
 220 /*          The following describes an instruction group                */
 221 /************************************************************************/
 222
 223 enum insGroupPlaceholderType : unsigned char
 224 {
 225     IGPT_PROLOG, // currently unused
 226     IGPT_EPILOG,
 227 #if FEATURE_EH_FUNCLETS
 228     IGPT_FUNCLET_PROLOG,
 229     IGPT_FUNCLET_EPILOG,
 230 #endif // FEATURE_EH_FUNCLETS
 231 };
 232
 233 #if defined(_MSC_VER) && defined(_TARGET_ARM_)
 234 // ARM aligns structures that contain 64-bit ints or doubles on 64-bit boundaries. This causes unwanted
 235 // padding to be added to the end, so sizeof() is unnecessarily big.
 236 #pragma pack(push)
 237 #pragma pack(4)
 238 #endif // defined(_MSC_VER) && defined(_TARGET_ARM_)
 239
 240 struct insPlaceholderGroupData
 241 {
 242     insGroup*               igPhNext;
 243     BasicBlock*             igPhBB;
 244     VARSET_TP               igPhInitGCrefVars;
 245     regMaskTP               igPhInitGCrefRegs;
 246     regMaskTP               igPhInitByrefRegs;
 247     VARSET_TP               igPhPrevGCrefVars;
 248     regMaskTP               igPhPrevGCrefRegs;
 249     regMaskTP               igPhPrevByrefRegs;
 250     insGroupPlaceholderType igPhType;
 251 }; // end of struct insPlaceholderGroupData
 252
 253 struct insGroup
 254 {
 255     insGroup* igNext;
 256
 257 #ifdef DEBUG
 258     insGroup* igSelf; // for consistency checking
 259 #endif
 260
 261     UNATIVE_OFFSET igNum;     // for ordering (and display) purposes
 262     UNATIVE_OFFSET igOffs;    // offset of this group within method
 263     unsigned int   igFuncIdx; // Which function/funclet does this belong to? (Index into Compiler::compFuncInfos array.)
 264     unsigned short igFlags;   // see IGF_xxx below
 265     unsigned short igSize;    // # of bytes of code in this group
 266
 267 #define IGF_GC_VARS 0x0001    // new set of live GC ref variables
 268 #define IGF_BYREF_REGS 0x0002 // new set of live by-ref registers
 269 #if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
 270 #define IGF_FINALLY_TARGET 0x0004 // this group is the start of a basic block that is returned to after a finally.
 271 #endif                            // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
 272 #define IGF_FUNCLET_PROLOG 0x0008 // this group belongs to a funclet prolog
 273 #define IGF_FUNCLET_EPILOG 0x0010 // this group belongs to a funclet epilog.
 274 #define IGF_EPILOG 0x0020         // this group belongs to a main function epilog
 275 #define IGF_NOGCINTERRUPT 0x0040  // this IG is is a no-interrupt region (prolog, epilog, etc.)
 276 #define IGF_UPD_ISZ 0x0080        // some instruction sizes updated
 277 #define IGF_PLACEHOLDER 0x0100    // this is a placeholder group, to be filled in later
 278 #define IGF_EMIT_ADD 0x0200       // this is a block added by the emitter
 279                                   // because the codegen block was too big. Also used for
 280                                   // placeholder IGs that aren't also labels.
 281
 282 // Mask of IGF_* flags that should be propagated to new blocks when they are created.
 283 // This allows prologs and epilogs to be any number of IGs, but still be
 284 // automatically marked properly.
 285 #if FEATURE_EH_FUNCLETS
 286 #ifdef DEBUG
 287 #define IGF_PROPAGATE_MASK (IGF_EPILOG | IGF_FUNCLET_PROLOG | IGF_FUNCLET_EPILOG)
 288 #else // DEBUG
 289 #define IGF_PROPAGATE_MASK (IGF_EPILOG | IGF_FUNCLET_PROLOG)
 290 #endif // DEBUG
 291 #else  // FEATURE_EH_FUNCLETS
 292 #define IGF_PROPAGATE_MASK (IGF_EPILOG)
 293 #endif // FEATURE_EH_FUNCLETS
 294
 295     // Try to do better packing based on how large regMaskSmall is (8, 16, or 64 bits).
 296     CLANG_FORMAT_COMMENT_ANCHOR;
 297 #if REGMASK_BITS <= 32
 298
 299     union {
 300         BYTE*                    igData;   // addr of instruction descriptors
 301         insPlaceholderGroupData* igPhData; // when igFlags & IGF_PLACEHOLDER
 302     };
 303
 304 #if EMIT_TRACK_STACK_DEPTH
 305     unsigned igStkLvl; // stack level on entry
 306 #endif
 307     regMaskSmall  igGCregs; // set of registers with live GC refs
 308     unsigned char igInsCnt; // # of instructions  in this group
 309
 310 #else // REGMASK_BITS
 311
 312     regMaskSmall igGCregs; // set of registers with live GC refs
 313
 314     union {
 315         BYTE*                    igData;   // addr of instruction descriptors
 316         insPlaceholderGroupData* igPhData; // when igFlags & IGF_PLACEHOLDER
 317     };
 318
 319 #if EMIT_TRACK_STACK_DEPTH
 320     unsigned igStkLvl; // stack level on entry
 321 #endif
 322
 323     unsigned char igInsCnt; // # of instructions  in this group
 324
 325 #endif // REGMASK_BITS
 326
 327     VARSET_VALRET_TP igGCvars() const
 328     {
 329         assert(igFlags & IGF_GC_VARS);
 330
 331         BYTE* ptr = (BYTE*)igData;
 332         ptr -= sizeof(VARSET_TP);
 333
 334         return *(VARSET_TP*)ptr;
 335     }
 336
 337     unsigned igByrefRegs() const
 338     {
 339         assert(igFlags & IGF_BYREF_REGS);
 340
 341         BYTE* ptr = (BYTE*)igData;
 342
 343         if (igFlags & IGF_GC_VARS)
 344         {
 345             ptr -= sizeof(VARSET_TP);
 346         }
 347
 348         ptr -= sizeof(unsigned);
 349
 350         return *(unsigned*)ptr;
 351     }
 352
 353 }; // end of struct insGroup
 354
 355 //  For AMD64 the maximum prolog/epilog size supported on the OS is 256 bytes
 356 //  Since it is incorrect for us to be jumping across funclet prolog/epilogs
 357 //  we will use the following estimate as the maximum placeholder size.
 358 //
 359 #define MAX_PLACEHOLDER_IG_SIZE 256
 360
 361 #if defined(_MSC_VER) && defined(_TARGET_ARM_)
 362 #pragma pack(pop)
 363 #endif // defined(_MSC_VER) && defined(_TARGET_ARM_)
 364
 365 /*****************************************************************************/
 366
 367 #define DEFINE_ID_OPS
 368 #include "emitfmts.h"
 369 #undef DEFINE_ID_OPS
 370
 371 enum LclVarAddrTag
 372 {
 373     LVA_STANDARD_ENCODING = 0,
 374     LVA_LARGE_OFFSET      = 1,
 375     LVA_COMPILER_TEMP     = 2,
 376     LVA_LARGE_VARNUM      = 3
 377 };
 378
 379 struct emitLclVarAddr
 380 {
 381     // Constructor
 382     void initLclVarAddr(int varNum, unsigned offset);
 383
 384     int lvaVarNum(); // Returns the variable to access. Note that it returns a negative number for compiler spill temps.
 385     unsigned lvaOffset(); // returns the offset into the variable to access
 386
 387     // This struct should be 32 bits in size for the release build.
 388     // We have this constraint because this type is used in a union
 389     // with several other pointer sized types in the instrDesc struct.
 390     //
 391 protected:
 392     unsigned _lvaVarNum : 15; // Usually the lvaVarNum
 393     unsigned _lvaExtra : 15;  // Usually the lvaOffset
 394     unsigned _lvaTag : 2;     // tag field to support larger varnums
 395 };
 396
 397 enum idAddrUnionTag
 398 {
 399     iaut_ALIGNED_POINTER = 0x0,
 400     iaut_DATA_OFFSET     = 0x1,
 401     iaut_INST_COUNT      = 0x2,
 402     iaut_UNUSED_TAG      = 0x3,
 403
 404     iaut_MASK  = 0x3,
 405     iaut_SHIFT = 2
 406 };
 407
 408 class emitter
 409 {
 410     friend class emitLocation;
 411     friend class Compiler;
 412     friend class CodeGen;
 413     friend class CodeGenInterface;
 414
 415 public:
 416     /*************************************************************************
 417      *
 418      *  Define the public entry points.
 419      */
 420
 421     // Constructor.
 422     emitter()
 423     {
 424 #ifdef DEBUG
 425         // There seem to be some cases where this is used without being initialized via CodeGen::inst_set_SV_var().
 426         emitVarRefOffs = 0;
 427 #endif // DEBUG
 428
 429 #ifdef _TARGET_XARCH_
 430         SetUseSSE3_4(false);
 431         SetUseAVX(false);
 432 #endif // _TARGET_XARCH_
 433     }
 434
 435 #include "emitpub.h"
 436
 437 protected:
 438     /************************************************************************/
 439     /*                        Miscellaneous stuff                           */
 440     /************************************************************************/
 441
 442     Compiler* emitComp;
 443     GCInfo*   gcInfo;
 444     CodeGen*  codeGen;
 445
 446     typedef GCInfo::varPtrDsc varPtrDsc;
 447     typedef GCInfo::regPtrDsc regPtrDsc;
 448     typedef GCInfo::CallDsc   callDsc;
 449
 450     void* emitGetMem(size_t sz);
 451
 452     enum opSize : unsigned
 453     {
 454         OPSZ1      = 0,
 455         OPSZ2      = 1,
 456         OPSZ4      = 2,
 457         OPSZ8      = 3,
 458         OPSZ16     = 4,
 459         OPSZ32     = 5,
 460         OPSZ_COUNT = 6,
 461 #ifdef _TARGET_AMD64_
 462         OPSZP = OPSZ8,
 463 #else
 464         OPSZP = OPSZ4,
 465 #endif
 466     };
 467
 468 #define OPSIZE_INVALID ((opSize)0xffff)
 469
 470     static const emitter::opSize emitSizeEncode[];
 471     static const emitAttr        emitSizeDecode[];
 472
 473     static emitter::opSize emitEncodeSize(emitAttr size);
 474     static emitAttr emitDecodeSize(emitter::opSize ensz);
 475
 476     // Currently, we only allow one IG for the prolog
 477     bool emitIGisInProlog(const insGroup* ig)
 478     {
 479         return ig == emitPrologIG;
 480     }
 481
 482     bool emitIGisInEpilog(const insGroup* ig)
 483     {
 484         return (ig != nullptr) && ((ig->igFlags & IGF_EPILOG) != 0);
 485     }
 486
 487 #if FEATURE_EH_FUNCLETS
 488
 489     bool emitIGisInFuncletProlog(const insGroup* ig)
 490     {
 491         return (ig != nullptr) && ((ig->igFlags & IGF_FUNCLET_PROLOG) != 0);
 492     }
 493
 494     bool emitIGisInFuncletEpilog(const insGroup* ig)
 495     {
 496         return (ig != nullptr) && ((ig->igFlags & IGF_FUNCLET_EPILOG) != 0);
 497     }
 498
 499 #endif // FEATURE_EH_FUNCLETS
 500
 501     // If "ig" corresponds to the start of a basic block that is the
 502     // target of a funclet return, generate GC information for it's start
 503     // address "cp", as if it were the return address of a call.
 504     void emitGenGCInfoIfFuncletRetTarget(insGroup* ig, BYTE* cp);
 505
 506     void emitRecomputeIGoffsets();
 507
 508     /************************************************************************/
 509     /*          The following describes a single instruction                */
 510     /************************************************************************/
 511
 512     enum insFormat : unsigned
 513     {
 514 #define IF_DEF(en, op1, op2) IF_##en,
 515 #include "emitfmts.h"
 516
 517         IF_COUNT
 518     };
 519
 520 #define AM_DISP_BITS ((sizeof(unsigned) * 8) - 2 * (REGNUM_BITS + 1) - 2)
 521 #define AM_DISP_BIG_VAL (-(1 << (AM_DISP_BITS - 1)))
 522 #define AM_DISP_MIN (-((1 << (AM_DISP_BITS - 1)) - 1))
 523 #define AM_DISP_MAX (+((1 << (AM_DISP_BITS - 1)) - 1))
 524
 525     struct emitAddrMode
 526     {
 527         regNumber       amBaseReg : REGNUM_BITS + 1;
 528         regNumber       amIndxReg : REGNUM_BITS + 1;
 529         emitter::opSize amScale : 2;
 530         int             amDisp : AM_DISP_BITS;
 531     };
 532
 533 #ifdef DEBUG // This information is used in DEBUG builds to display the method name for call instructions
 534
 535     struct instrDesc;
 536
 537     struct instrDescDebugInfo
 538     {
 539         unsigned idNum;
 540         size_t   idSize;       // size of the instruction descriptor
 541         unsigned idVarRefOffs; // IL offset for LclVar reference
 542         size_t   idMemCookie;  // for display of method name  (also used by switch table)
 543 #ifdef TRANSLATE_PDB
 544         unsigned int idilStart; // instruction descriptor source information for PDB translation
 545 #endif
 546         bool              idFinallyCall; // Branch instruction is a call to finally
 547         bool              idCatchRet;    // Instruction is for a catch 'return'
 548         CORINFO_SIG_INFO* idCallSig;     // Used to report native call site signatures to the EE
 549     };
 550
 551 #endif // DEBUG
 552
 553 #ifdef _TARGET_ARM_
 554     unsigned insEncodeSetFlags(insFlags sf);
 555
 556     enum insSize : unsigned
 557     {
 558         ISZ_16BIT,
 559         ISZ_32BIT,
 560         ISZ_48BIT // pseudo-instruction for conditional branch with imm24 range,
 561                   // encoded as IT of condition followed by an unconditional branch
 562     };
 563
 564     unsigned insEncodeShiftOpts(insOpts opt);
 565     unsigned insEncodePUW_G0(insOpts opt, int imm);
 566     unsigned insEncodePUW_H0(insOpts opt, int imm);
 567
 568 #endif // _TARGET_ARM_
 569
 570 #if defined(_TARGET_X86_) && defined(LEGACY_BACKEND)
 571 #define HAS_TINY_DESC 1
 572 #else
 573 #define HAS_TINY_DESC 0
 574 #endif
 575
 576     struct instrDescCns;
 577
 578     struct instrDesc
 579     {
 580     private:
 581 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
 582         // The assembly instruction
 583         instruction _idIns : 9;
 584 #else  // !defined(_TARGET_XARCH_) || defined(LEGACY_BACKEND)
 585         // The assembly instruction
 586         instruction _idIns : 8;
 587 #endif // !defined(_TARGET_XARCH_) || defined(LEGACY_BACKEND)
 588         // The format for the instruction
 589         insFormat _idInsFmt : 8;
 590
 591     public:
 592         instruction idIns() const
 593         {
 594             return _idIns;
 595         }
 596         void idIns(instruction ins)
 597         {
 598             _idIns = ins;
 599             assert(_idIns == ins);
 600         }
 601
 602         insFormat idInsFmt() const
 603         {
 604             return _idInsFmt;
 605         }
 606         void idInsFmt(insFormat insFmt)
 607         {
 608 #if defined(_TARGET_ARM64_)
 609             noway_assert(insFmt != IF_NONE); // Only the x86 emitter uses IF_NONE, it is invalid for ARM64 (and ARM32)
 610 #endif
 611             _idInsFmt = insFmt;
 612             assert(_idInsFmt == insFmt);
 613         }
 614
 615         /*
 616             The idReg1 and idReg2 fields hold the first and second register
 617             operand(s), whenever these are present. Note that the size of
 618             these fields ranges from 3 to 6 bits, and care needs to be taken
 619             to make sure all of these fields stay reasonably packed.
 620          */
 621
 622         void idSetRelocFlags(emitAttr attr)
 623         {
 624             _idCnsReloc = (EA_IS_CNS_RELOC(attr) ? 1 : 0);
 625             _idDspReloc = (EA_IS_DSP_RELOC(attr) ? 1 : 0);
 626         }
 627
 628         ////////////////////////////////////////////////////////////////////////
 629         // Space taken up to here:
 630         // x86:   16 bits
 631         // amd64: 17 bits
 632         // arm:   16 bits
 633         // arm64: 16 bits
 634
 635     private:
 636 #ifdef _TARGET_XARCH_
 637         unsigned _idCodeSize : 4; // size of instruction in bytes
 638 #endif
 639
 640 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
 641         opSize _idOpSize : 3; // operand size: 0=1 , 1=2 , 2=4 , 3=8, 4=16, 5=32
 642                               // At this point we have fully consumed first DWORD so that next field
 643                               // doesn't cross a byte boundary.
 644 #elif defined(_TARGET_ARM64_)
 645 // Moved the definition of '_idOpSize' later so that we don't cross a 32-bit boundary when laying out bitfields
 646 #else  // ARM or x86-LEGACY_BACKEND
 647         opSize _idOpSize : 2; // operand size: 0=1 , 1=2 , 2=4 , 3=8
 648 #endif // ARM or x86-LEGACY_BACKEND
 649
 650         // On Amd64, this is where the second DWORD begins
 651         // On System V a call could return a struct in 2 registers. The instrDescCGCA struct below has  member that
 652         // stores the GC-ness of the second register.
 653         // It is added to the instrDescCGCA and not here (the base struct) since it is not needed by all the
 654         // instructions. This struct (instrDesc) is very carefully kept to be no more than 128 bytes. There is no more
 655         // space to add members for keeping GC-ness of the second return registers. It will also bloat the base struct
 656         // unnecessarily since the GC-ness of the second register is only needed for call instructions.
 657         // The instrDescCGCA struct's member keeping the GC-ness of the first return register is _idcSecondRetRegGCType.
 658         GCtype _idGCref : 2; // GCref operand? (value is a "GCtype")
 659
 660         // Note that we use the _idReg1 and _idReg2 fields to hold
 661         // the live gcrefReg mask for the call instructions on x86/x64
 662         //
 663         regNumber _idReg1 : REGNUM_BITS; // register num
 664
 665         regNumber _idReg2 : REGNUM_BITS;
 666
 667         ////////////////////////////////////////////////////////////////////////
 668         // Space taken up to here:
 669         // x86:   30 bits
 670         // amd64: 38 bits
 671         // arm:   32 bits
 672         // arm64: 30 bits
 673         CLANG_FORMAT_COMMENT_ANCHOR;
 674
 675 #if HAS_TINY_DESC
 676         //
 677         // For x86 use last two bits to differentiate if we are tiny or small
 678         //
 679         unsigned _idTinyDsc : 1;  // is this a "tiny"  descriptor?
 680         unsigned _idSmallDsc : 1; // is this a "small" descriptor?
 681
 682 #else // !HAS_TINY_DESC
 683
 684         //
 685         // On x86/arm platforms we have used 32 bits so far (4 bytes)
 686         // On amd64 we have used 38 bits so far (4 bytes + 6 bits)
 687         //
 688
 689         //
 690         // For amd64 we just can't fit anything useful into a single DWORD
 691         // So we eliminate the notion of 'tiny', and have small (2 DWORDS)
 692         // or not small (which is bigger, just like x86)
 693         //
 694
 695         unsigned _idSmallDsc : 1;  // is this a "small" descriptor?
 696         unsigned _idLargeCns : 1;  // does a large constant     follow?
 697         unsigned _idLargeDsp : 1;  // does a large displacement follow?
 698         unsigned _idLargeCall : 1; // large call descriptor used
 699
 700         unsigned _idBound : 1;      // jump target / frame offset bound
 701         unsigned _idCallRegPtr : 1; // IL indirect calls: addr in reg
 702         unsigned _idCallAddr : 1;   // IL indirect calls: can make a direct call to iiaAddr
 703         unsigned _idNoGC : 1;       // Some helpers don't get recorded in GC tables
 704
 705 #ifdef _TARGET_ARM64_
 706         opSize   _idOpSize : 3;     // operand size: 0=1 , 1=2 , 2=4 , 3=8, 4=16
 707         insOpts  _idInsOpt : 6;     // options for instructions
 708         unsigned _idLclVar : 1;     // access a local on stack
 709 #endif
 710
 711 #ifdef _TARGET_ARM_
 712         insSize  _idInsSize : 2;    // size of instruction: 16, 32 or 48 bits
 713         insFlags _idInsFlags : 1;   // will this instruction set the flags
 714         unsigned _idLclVar : 1;     // access a local on stack
 715         unsigned _idLclFPBase : 1;  // access a local on stack - SP based offset
 716         insOpts  _idInsOpt : 3;     // options for Load/Store instructions
 717
 718 // For arm we have used 16 bits
 719 #define ID_EXTRA_BITFIELD_BITS (16)
 720
 721 #elif defined(_TARGET_ARM64_)
 722 // For Arm64, we have used 16 bits from the second DWORD.
 723 #define ID_EXTRA_BITFIELD_BITS (16)
 724 #elif defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
 725 // For xarch !LEGACY_BACKEND, we have used 14 bits from the second DWORD.
 726 #define ID_EXTRA_BITFIELD_BITS (14)
 727 #elif defined(_TARGET_X86_)
 728 // For x86, we have used 6 bits from the second DWORD.
 729 #define ID_EXTRA_BITFIELD_BITS (6)
 730 #else
 731 #error Unsupported or unset target architecture
 732 #endif
 733
 734         ////////////////////////////////////////////////////////////////////////
 735         // Space taken up to here:
 736         // x86:   38 bits  // if HAS_TINY_DESC is not defined (which it is)
 737         // amd64: 46 bits
 738         // arm:   48 bits
 739         // arm64: 48 bits
 740         CLANG_FORMAT_COMMENT_ANCHOR;
 741
 742         unsigned _idCnsReloc : 1; // LargeCns is an RVA and needs reloc tag
 743         unsigned _idDspReloc : 1; // LargeDsp is an RVA and needs reloc tag
 744
 745 #define ID_EXTRA_RELOC_BITS (2)
 746
 747         ////////////////////////////////////////////////////////////////////////
 748         // Space taken up to here:
 749         // x86:   40 bits
 750         // amd64: 48 bits
 751         // arm:   50 bits
 752         // arm64: 50 bits
 753         CLANG_FORMAT_COMMENT_ANCHOR;
 754
 755 #define ID_EXTRA_BITS (ID_EXTRA_RELOC_BITS + ID_EXTRA_BITFIELD_BITS)
 756
 757 /* Use whatever bits are left over for small constants */
 758
 759 #define ID_BIT_SMALL_CNS (32 - ID_EXTRA_BITS)
 760 #define ID_MIN_SMALL_CNS 0
 761 #define ID_MAX_SMALL_CNS (int)((1 << ID_BIT_SMALL_CNS) - 1U)
 762
 763         ////////////////////////////////////////////////////////////////////////
 764         // Small constant size:
 765         // x86:   24 bits
 766         // amd64: 16 bits
 767         // arm:   14 bits
 768         // arm64: 14 bits
 769
 770         unsigned _idSmallCns : ID_BIT_SMALL_CNS;
 771
 772         ////////////////////////////////////////////////////////////////////////
 773         // Space taken up to here: 64 bits, all architectures, by design.
 774         ////////////////////////////////////////////////////////////////////////
 775         CLANG_FORMAT_COMMENT_ANCHOR;
 776
 777 #endif // !HAS_TINY_DESC
 778
 779 #ifdef DEBUG
 780
 781         instrDescDebugInfo* _idDebugOnlyInfo;
 782
 783     public:
 784         instrDescDebugInfo* idDebugOnlyInfo() const
 785         {
 786             return _idDebugOnlyInfo;
 787         }
 788         void idDebugOnlyInfo(instrDescDebugInfo* info)
 789         {
 790             _idDebugOnlyInfo = info;
 791         }
 792
 793     private:
 794 #endif // DEBUG
 795
 796         //
 797         // This is the end of the smallest instrDesc we can allocate for all
 798         //   platforms.
 799         // Non-DEBUG sizes:
 800         //   x86: 32 bits, and it is called the 'tiny' descriptor.
 801         //   amd64/arm/arm64: 64 bits, and it is called the 'small' descriptor.
 802         // DEBUG sizes (includes one pointer):
 803         //   x86:   2 DWORDs, 64 bits
 804         //   amd64: 4 DWORDs, 128 bits
 805         //   arm:   3 DWORDs, 96 bits
 806         //   arm64: 4 DWORDs, 128 bits
 807         // There should no padding or alignment issues on any platform or
 808         //   configuration (including DEBUG which has 1 extra pointer).
 809         //
 810         CLANG_FORMAT_COMMENT_ANCHOR;
 811
 812 #if HAS_TINY_DESC
 813
 814         unsigned _idLargeCns : 1;  // does a large constant     follow?
 815         unsigned _idLargeDsp : 1;  // does a large displacement follow?
 816         unsigned _idLargeCall : 1; // large call descriptor used
 817         unsigned _idBound : 1;     // jump target / frame offset bound
 818
 819         unsigned _idCallRegPtr : 1; // IL indirect calls: addr in reg
 820         unsigned _idCallAddr : 1;   // IL indirect calls: can make a direct call to iiaAddr
 821         unsigned _idNoGC : 1;       // Some helpers don't get recorded in GC tables
 822
 823 #define ID_EXTRA_BITFIELD_BITS (7)
 824
 825         //
 826         // For x86, we are using  7 bits from the second DWORD for bitfields.
 827         //
 828
 829         unsigned _idCnsReloc : 1; // LargeCns is an RVA and needs reloc tag
 830         unsigned _idDspReloc : 1; // LargeDsp is an RVA and needs reloc tag
 831
 832 #define ID_EXTRA_RELOC_BITS (2)
 833
 834 #define ID_EXTRA_REG_BITS (0)
 835
 836 #define ID_EXTRA_BITS (ID_EXTRA_BITFIELD_BITS + ID_EXTRA_RELOC_BITS + ID_EXTRA_REG_BITS)
 837
 838 /* Use whatever bits are left over for small constants */
 839
 840 #define ID_BIT_SMALL_CNS (32 - ID_EXTRA_BITS)
 841 #define ID_MIN_SMALL_CNS 0
 842 #define ID_MAX_SMALL_CNS (int)((1 << ID_BIT_SMALL_CNS) - 1U)
 843
 844         // For x86 we have 23 bits remaining for the
 845         //   small constant in this extra DWORD.
 846
 847         unsigned _idSmallCns : ID_BIT_SMALL_CNS;
 848
 849 #endif // HAS_TINY_DESC
 850
 851 //
 852 // This is the end of the 'small' instrDesc which is the same on all
 853 //   platforms (except 64-bit DEBUG which is a little bigger).
 854 // Non-DEBUG sizes:
 855 //   x86/amd64/arm/arm64: 64 bits
 856 // DEBUG sizes (includes one pointer):
 857 //   x86:   2 DWORDs, 64 bits
 858 //   amd64: 4 DWORDs, 128 bits
 859 //   arm:   3 DWORDs, 96 bits
 860 //   arm64: 4 DWORDs, 128 bits
 861 // There should no padding or alignment issues on any platform or
 862 //   configuration (including DEBUG which has 1 extra pointer).
 863 //
 864
 865 /*
 866     If you add lots more fields that need to be cleared (such
 867     as various flags), you might need to update the body of
 868     emitter::emitAllocInstr() to clear them.
 869  */
 870
 871 #if DEBUG
 872 #define TINY_IDSC_DEBUG_EXTRA (sizeof(void*))
 873 #else
 874 #define TINY_IDSC_DEBUG_EXTRA (0)
 875 #endif
 876
 877 #if HAS_TINY_DESC
 878 #define TINY_IDSC_SIZE (4 + TINY_IDSC_DEBUG_EXTRA)
 879 #define SMALL_IDSC_SIZE (8 + TINY_IDSC_DEBUG_EXTRA)
 880 #else
 881 #define TINY_IDSC_SIZE (8 + TINY_IDSC_DEBUG_EXTRA)
 882 #define SMALL_IDSC_SIZE TINY_IDSC_SIZE
 883 #endif
 884
 885         void checkSizes();
 886
 887         union idAddrUnion {
 888 // TODO-Cleanup: We should really add a DEBUG-only tag to this union so we can add asserts
 889 // about reading what we think is here, to avoid unexpected corruption issues.
 890
 891 #ifndef _TARGET_ARM64_
 892             emitLclVarAddr iiaLclVar;
 893 #endif
 894             BasicBlock*  iiaBBlabel;
 895             insGroup*    iiaIGlabel;
 896             BYTE*        iiaAddr;
 897             emitAddrMode iiaAddrMode;
 898
 899             CORINFO_FIELD_HANDLE iiaFieldHnd; // iiaFieldHandle is also used to encode
 900                                               // an offset into the JIT data constant area
 901             bool iiaIsJitDataOffset() const;
 902             int  iiaGetJitDataOffset() const;
 903
 904 #ifdef _TARGET_ARMARCH_
 905
 906             // iiaEncodedInstrCount and its accessor functions are used to specify an instruction
 907             // count for jumps, instead of using a label and multiple blocks. This is used in the
 908             // prolog as well as for IF_LARGEJMP pseudo-branch instructions.
 909             int iiaEncodedInstrCount;
 910
 911             bool iiaHasInstrCount() const
 912             {
 913                 return (iiaEncodedInstrCount & iaut_MASK) == iaut_INST_COUNT;
 914             }
 915             int iiaGetInstrCount() const
 916             {
 917                 assert(iiaHasInstrCount());
 918                 return (iiaEncodedInstrCount >> iaut_SHIFT);
 919             }
 920             void iiaSetInstrCount(int count)
 921             {
 922                 assert(abs(count) < 10);
 923                 iiaEncodedInstrCount = (count << iaut_SHIFT) | iaut_INST_COUNT;
 924             }
 925
 926             struct
 927             {
 928 #ifdef _TARGET_ARM64_
 929                 // For 64-bit architecture this 32-bit structure can pack with these unsigned bit fields
 930                 emitLclVarAddr iiaLclVar;
 931                 unsigned       _idReg3Scaled : 1; // Reg3 is scaled by idOpSize bits
 932                 GCtype         _idGCref2 : 2;
 933 #endif
 934                 regNumber _idReg3 : REGNUM_BITS;
 935                 regNumber _idReg4 : REGNUM_BITS;
 936             };
 937 #elif defined(_TARGET_XARCH_)
 938             struct
 939             {
 940                 regNumber _idReg3 : REGNUM_BITS;
 941             };
 942 #endif // defined(_TARGET_XARCH_)
 943
 944         } _idAddrUnion;
 945
 946         /* Trivial wrappers to return properly typed enums */
 947     public:
 948 #if HAS_TINY_DESC
 949
 950         bool idIsTiny() const
 951         {
 952             return (_idTinyDsc != 0);
 953         }
 954         void idSetIsTiny()
 955         {
 956             _idTinyDsc = 1;
 957         }
 958
 959 #else
 960
 961         bool idIsTiny() const
 962         {
 963             return false;
 964         }
 965         void idSetIsTiny()
 966         {
 967             _idSmallDsc = 1;
 968         }
 969
 970 #endif // HAS_TINY_DESC
 971
 972         bool idIsSmallDsc() const
 973         {
 974             return (_idSmallDsc != 0);
 975         }
 976         void idSetIsSmallDsc()
 977         {
 978             _idSmallDsc = 1;
 979         }
 980
 981 #if defined(_TARGET_XARCH_)
 982
 983         unsigned idCodeSize() const
 984         {
 985             return _idCodeSize;
 986         }
 987         void idCodeSize(unsigned sz)
 988         {
 989             _idCodeSize = sz;
 990             assert(sz == _idCodeSize);
 991         }
 992
 993 #elif defined(_TARGET_ARM64_)
 994         unsigned idCodeSize() const
 995         {
 996             int size = 4;
 997             switch (idInsFmt())
 998             {
 999                 case IF_LARGEADR:
1000                 // adrp + add
1001                 case IF_LARGEJMP:
1002                     // b<cond> + b<uncond>
1003                     size = 8;
1004                     break;
1005                 case IF_LARGELDC:
1006                     if (isVectorRegister(idReg1()))
1007                     {
1008                         // adrp + ldr + fmov
1009                         size = 12;
1010                     }
1011                     else
1012                     {
1013                         // adrp + ldr
1014                         size = 8;
1015                     }
1016                     break;
1017                 default:
1018                     break;
1019             }
1020
1021             return size;
1022         }
1023
1024 #elif defined(_TARGET_ARM_)
1025
1026         bool idInstrIsT1() const
1027         {
1028             return (_idInsSize == ISZ_16BIT);
1029         }
1030         unsigned idCodeSize() const
1031         {
1032             unsigned result = (_idInsSize == ISZ_16BIT) ? 2 : (_idInsSize == ISZ_32BIT) ? 4 : 6;
1033             return result;
1034         }
1035         insSize idInsSize() const
1036         {
1037             return _idInsSize;
1038         }
1039         void idInsSize(insSize isz)
1040         {
1041             _idInsSize = isz;
1042             assert(isz == _idInsSize);
1043         }
1044         insFlags idInsFlags() const
1045         {
1046             return _idInsFlags;
1047         }
1048         void idInsFlags(insFlags sf)
1049         {
1050             _idInsFlags = sf;
1051             assert(sf == _idInsFlags);
1052         }
1053 #endif // _TARGET_ARM_
1054
1055         emitAttr idOpSize()
1056         {
1057             return emitDecodeSize(_idOpSize);
1058         }
1059         void idOpSize(emitAttr opsz)
1060         {
1061             _idOpSize = emitEncodeSize(opsz);
1062         }
1063
1064         GCtype idGCref() const
1065         {
1066             return (GCtype)_idGCref;
1067         }
1068         void idGCref(GCtype gctype)
1069         {
1070             _idGCref = gctype;
1071         }
1072
1073         regNumber idReg1() const
1074         {
1075             return _idReg1;
1076         }
1077         void idReg1(regNumber reg)
1078         {
1079             _idReg1 = reg;
1080             assert(reg == _idReg1);
1081         }
1082
1083 #ifdef _TARGET_ARM64_
1084         GCtype idGCrefReg2() const
1085         {
1086             assert(!idIsTiny());
1087             assert(!idIsSmallDsc());
1088             return (GCtype)idAddr()->_idGCref2;
1089         }
1090         void idGCrefReg2(GCtype gctype)
1091         {
1092             assert(!idIsTiny());
1093             assert(!idIsSmallDsc());
1094             idAddr()->_idGCref2 = gctype;
1095         }
1096 #endif // _TARGET_ARM64_
1097
1098         regNumber idReg2() const
1099         {
1100             return _idReg2;
1101         }
1102         void idReg2(regNumber reg)
1103         {
1104             _idReg2 = reg;
1105             assert(reg == _idReg2);
1106         }
1107
1108 #if defined(_TARGET_XARCH_)
1109         regNumber idReg3() const
1110         {
1111             assert(!idIsTiny());
1112             assert(!idIsSmallDsc());
1113             return idAddr()->_idReg3;
1114         }
1115         void idReg3(regNumber reg)
1116         {
1117             assert(!idIsTiny());
1118             assert(!idIsSmallDsc());
1119             idAddr()->_idReg3 = reg;
1120             assert(reg == idAddr()->_idReg3);
1121         }
1122 #endif // defined(_TARGET_XARCH_)
1123 #ifdef _TARGET_ARMARCH_
1124         insOpts idInsOpt() const
1125         {
1126             return (insOpts)_idInsOpt;
1127         }
1128         void idInsOpt(insOpts opt)
1129         {
1130             _idInsOpt = opt;
1131             assert(opt == _idInsOpt);
1132         }
1133
1134         regNumber idReg3() const
1135         {
1136             assert(!idIsTiny());
1137             assert(!idIsSmallDsc());
1138             return idAddr()->_idReg3;
1139         }
1140         void idReg3(regNumber reg)
1141         {
1142             assert(!idIsTiny());
1143             assert(!idIsSmallDsc());
1144             idAddr()->_idReg3 = reg;
1145             assert(reg == idAddr()->_idReg3);
1146         }
1147         regNumber idReg4() const
1148         {
1149             assert(!idIsTiny());
1150             assert(!idIsSmallDsc());
1151             return idAddr()->_idReg4;
1152         }
1153         void idReg4(regNumber reg)
1154         {
1155             assert(!idIsTiny());
1156             assert(!idIsSmallDsc());
1157             idAddr()->_idReg4 = reg;
1158             assert(reg == idAddr()->_idReg4);
1159         }
1160 #ifdef _TARGET_ARM64_
1161         bool idReg3Scaled() const
1162         {
1163             assert(!idIsTiny());
1164             assert(!idIsSmallDsc());
1165             return (idAddr()->_idReg3Scaled == 1);
1166         }
1167         void idReg3Scaled(bool val)
1168         {
1169             assert(!idIsTiny());
1170             assert(!idIsSmallDsc());
1171             idAddr()->_idReg3Scaled = val ? 1 : 0;
1172         }
1173 #endif // _TARGET_ARM64_
1174
1175 #endif // _TARGET_ARMARCH_
1176
1177         inline static bool fitsInSmallCns(ssize_t val)
1178         {
1179             return ((val >= ID_MIN_SMALL_CNS) && (val <= ID_MAX_SMALL_CNS));
1180         }
1181
1182         bool idIsLargeCns() const
1183         {
1184             assert(!idIsTiny());
1185             return _idLargeCns != 0;
1186         }
1187         void idSetIsLargeCns()
1188         {
1189             assert(!idIsTiny());
1190             _idLargeCns = 1;
1191         }
1192
1193         bool idIsLargeDsp() const
1194         {
1195             assert(!idIsTiny());
1196             return _idLargeDsp != 0;
1197         }
1198         void idSetIsLargeDsp()
1199         {
1200             assert(!idIsTiny());
1201             _idLargeDsp = 1;
1202         }
1203         void idSetIsSmallDsp()
1204         {
1205             assert(!idIsTiny());
1206             _idLargeDsp = 0;
1207         }
1208
1209         bool idIsLargeCall() const
1210         {
1211             assert(!idIsTiny());
1212             return _idLargeCall != 0;
1213         }
1214         void idSetIsLargeCall()
1215         {
1216             assert(!idIsTiny());
1217             _idLargeCall = 1;
1218         }
1219
1220         bool idIsBound() const
1221         {
1222             assert(!idIsTiny());
1223             return _idBound != 0;
1224         }
1225         void idSetIsBound()
1226         {
1227             assert(!idIsTiny());
1228             _idBound = 1;
1229         }
1230
1231         bool idIsCallRegPtr() const
1232         {
1233             assert(!idIsTiny());
1234             return _idCallRegPtr != 0;
1235         }
1236         void idSetIsCallRegPtr()
1237         {
1238             assert(!idIsTiny());
1239             _idCallRegPtr = 1;
1240         }
1241
1242         bool idIsCallAddr() const
1243         {
1244             assert(!idIsTiny());
1245             return _idCallAddr != 0;
1246         }
1247         void idSetIsCallAddr()
1248         {
1249             assert(!idIsTiny());
1250             _idCallAddr = 1;
1251         }
1252
1253         // Only call instructions that call helper functions may be marked as "IsNoGC", indicating
1254         // that a thread executing such a call cannot be stopped for GC.  Thus, in partially-interruptible
1255         // code, it is not necessary to generate GC info for a call so labeled.
1256         bool idIsNoGC() const
1257         {
1258             assert(!idIsTiny());
1259             return _idNoGC != 0;
1260         }
1261         void idSetIsNoGC(bool val)
1262         {
1263             assert(!idIsTiny());
1264             _idNoGC = val;
1265         }
1266
1267 #ifdef _TARGET_ARMARCH_
1268         bool idIsLclVar() const
1269         {
1270             return !idIsTiny() && _idLclVar != 0;
1271         }
1272         void idSetIsLclVar()
1273         {
1274             assert(!idIsTiny());
1275             _idLclVar = 1;
1276         }
1277 #endif // _TARGET_ARMARCH_
1278
1279 #if defined(_TARGET_ARM_)
1280         bool idIsLclFPBase() const
1281         {
1282             return !idIsTiny() && _idLclFPBase != 0;
1283         }
1284         void idSetIsLclFPBase()
1285         {
1286             assert(!idIsTiny());
1287             _idLclFPBase = 1;
1288         }
1289 #endif // defined(_TARGET_ARM_)
1290
1291         bool idIsCnsReloc() const
1292         {
1293             assert(!idIsTiny());
1294             return _idCnsReloc != 0;
1295         }
1296         void idSetIsCnsReloc()
1297         {
1298             assert(!idIsTiny());
1299             _idCnsReloc = 1;
1300         }
1301
1302         bool idIsDspReloc() const
1303         {
1304             assert(!idIsTiny());
1305             return _idDspReloc != 0;
1306         }
1307         void idSetIsDspReloc(bool val = true)
1308         {
1309             assert(!idIsTiny());
1310             _idDspReloc = val;
1311         }
1312         bool idIsReloc()
1313         {
1314             return idIsDspReloc() || idIsCnsReloc();
1315         }
1316
1317         unsigned idSmallCns() const
1318         {
1319             assert(!idIsTiny());
1320             return _idSmallCns;
1321         }
1322         void idSmallCns(size_t value)
1323         {
1324             assert(!idIsTiny());
1325             assert(fitsInSmallCns(value));
1326             _idSmallCns = value;
1327         }
1328
1329         inline const idAddrUnion* idAddr() const
1330         {
1331             assert(!idIsSmallDsc() && !idIsTiny());
1332             return &this->_idAddrUnion;
1333         }
1334
1335         inline idAddrUnion* idAddr()
1336         {
1337             assert(!idIsSmallDsc() && !idIsTiny());
1338             return &this->_idAddrUnion;
1339         }
1340     }; // End of  struct instrDesc
1341
1342     void dispIns(instrDesc* id);
1343
1344     void appendToCurIG(instrDesc* id);
1345
1346     /********************************************************************************************/
1347
1348     struct instrDescJmp : instrDesc
1349     {
1350         instrDescJmp* idjNext; // next jump in the group/method
1351         insGroup*     idjIG;   // containing group
1352
1353         union {
1354             BYTE* idjAddr; // address of jump ins (for patching)
1355         } idjTemp;
1356
1357         unsigned idjOffs : 30;    // Before jump emission, this is the byte offset within IG of the jump instruction.
1358                                   // After emission, for forward jumps, this is the target offset -- in bytes from the
1359                                   // beginning of the function -- of the target instruction of the jump, used to
1360                                   // determine if this jump needs to be patched.
1361         unsigned idjShort : 1;    // is the jump known to be a short  one?
1362         unsigned idjKeepLong : 1; // should the jump be kept long? (used for
1363                                   // hot to cold and cold to hot jumps)
1364     };
1365
1366 #if !defined(_TARGET_ARM64_) // This shouldn't be needed for ARM32, either, but I don't want to touch the ARM32 JIT.
1367     struct instrDescLbl : instrDescJmp
1368     {
1369         emitLclVarAddr dstLclVar;
1370     };
1371 #endif // !_TARGET_ARM64_
1372
1373     struct instrDescCns : instrDesc // large const
1374     {
1375         ssize_t idcCnsVal;
1376     };
1377
1378     struct instrDescDsp : instrDesc // large displacement
1379     {
1380         ssize_t iddDspVal;
1381     };
1382
1383     struct instrDescCnsDsp : instrDesc // large cons + disp
1384     {
1385         ssize_t iddcCnsVal;
1386         int     iddcDspVal;
1387     };
1388
1389     struct instrDescAmd : instrDesc // large addrmode disp
1390     {
1391         ssize_t idaAmdVal;
1392     };
1393
1394     struct instrDescCnsAmd : instrDesc // large cons + addrmode disp
1395     {
1396         ssize_t idacCnsVal;
1397         ssize_t idacAmdVal;
1398     };
1399
1400     struct instrDescCGCA : instrDesc // call with ...
1401     {
1402         VARSET_TP idcGCvars;    // ... updated GC vars or
1403         ssize_t   idcDisp;      // ... big addrmode disp
1404         regMaskTP idcGcrefRegs; // ... gcref registers
1405         regMaskTP idcByrefRegs; // ... byref registers
1406         unsigned  idcArgCnt;    // ... lots of args or (<0 ==> caller pops args)
1407
1408 #if MULTIREG_HAS_SECOND_GC_RET
1409         // This method handle the GC-ness of the second register in a 2 register returned struct on System V.
1410         GCtype idSecondGCref() const
1411         {
1412             return (GCtype)_idcSecondRetRegGCType;
1413         }
1414         void idSecondGCref(GCtype gctype)
1415         {
1416             _idcSecondRetRegGCType = gctype;
1417         }
1418
1419     private:
1420         // This member stores the GC-ness of the second register in a 2 register returned struct on System V.
1421         // It is added to the call struct since it is not needed by the base instrDesc struct, which keeps GC-ness
1422         // of the first register for the instCall nodes.
1423         // The base instrDesc is very carefully kept to be no more than 128 bytes. There is no more space to add members
1424         // for keeping GC-ness of the second return registers. It will also bloat the base struct unnecessarily
1425         // since the GC-ness of the second register is only needed for call instructions.
1426         // The base struct's member keeping the GC-ness of the first return register is _idGCref.
1427         GCtype _idcSecondRetRegGCType : 2; // ... GC type for the second return register.
1428 #endif                                     // MULTIREG_HAS_SECOND_GC_RET
1429     };
1430
1431     struct instrDescArmFP : instrDesc
1432     {
1433         regNumber r1;
1434         regNumber r2;
1435         regNumber r3;
1436     };
1437
1438     insUpdateModes emitInsUpdateMode(instruction ins);
1439     insFormat emitInsModeFormat(instruction ins, insFormat base);
1440
1441     static const BYTE emitInsModeFmtTab[];
1442 #ifdef DEBUG
1443     static const unsigned emitInsModeFmtCnt;
1444 #endif
1445
1446     size_t emitGetInstrDescSize(const instrDesc* id);
1447     size_t emitGetInstrDescSizeSC(const instrDesc* id);
1448
1449     ssize_t emitGetInsCns(instrDesc* id);
1450     ssize_t emitGetInsDsp(instrDesc* id);
1451     ssize_t emitGetInsAmd(instrDesc* id);
1452     ssize_t emitGetInsCnsDsp(instrDesc* id, ssize_t* dspPtr);
1453     ssize_t emitGetInsSC(instrDesc* id);
1454     ssize_t emitGetInsCIdisp(instrDesc* id);
1455     unsigned emitGetInsCIargs(instrDesc* id);
1456
1457     // Return the argument count for a direct call "id".
1458     int emitGetInsCDinfo(instrDesc* id);
1459
1460     unsigned emitInsCount;
1461
1462 /************************************************************************/
1463 /*           A few routines used for debug display purposes             */
1464 /************************************************************************/
1465
1466 #if defined(DEBUG) || EMITTER_STATS
1467
1468     static const char* emitIfName(unsigned f);
1469
1470 #endif // defined(DEBUG) || EMITTER_STATS
1471
1472 #ifdef DEBUG
1473
1474     unsigned emitVarRefOffs;
1475
1476     const char* emitRegName(regNumber reg, emitAttr size = EA_PTRSIZE, bool varName = true);
1477     const char* emitFloatRegName(regNumber reg, emitAttr size = EA_PTRSIZE, bool varName = true);
1478
1479     const char* emitFldName(CORINFO_FIELD_HANDLE fieldVal);
1480     const char* emitFncName(CORINFO_METHOD_HANDLE callVal);
1481
1482     void emitDispIGflags(unsigned flags);
1483     void emitDispIG(insGroup* ig, insGroup* igPrev = nullptr, bool verbose = false);
1484     void emitDispIGlist(bool verbose = false);
1485     void emitDispGCinfo();
1486     void emitDispClsVar(CORINFO_FIELD_HANDLE fldHnd, ssize_t offs, bool reloc = false);
1487     void emitDispFrameRef(int varx, int disp, int offs, bool asmfm);
1488     void emitDispInsOffs(unsigned offs, bool doffs);
1489     void emitDispInsHex(BYTE* code, size_t sz);
1490
1491 #else // !DEBUG
1492 #define emitVarRefOffs 0
1493 #endif // !DEBUG
1494
1495     /************************************************************************/
1496     /*                      Method prolog and epilog                        */
1497     /************************************************************************/
1498
1499     unsigned emitPrologEndPos;
1500
1501     unsigned       emitEpilogCnt;
1502     UNATIVE_OFFSET emitEpilogSize;
1503
1504 #ifdef _TARGET_XARCH_
1505
1506     void           emitStartExitSeq(); // Mark the start of the "return" sequence
1507     emitLocation   emitExitSeqBegLoc;
1508     UNATIVE_OFFSET emitExitSeqSize; // minimum size of any return sequence - the 'ret' after the epilog
1509
1510 #endif // _TARGET_XARCH_
1511
1512     insGroup* emitPlaceholderList; // per method placeholder list - head
1513     insGroup* emitPlaceholderLast; // per method placeholder list - tail
1514
1515 #ifdef JIT32_GCENCODER
1516
1517     // The x86 GC encoder needs to iterate over a list of epilogs to generate a table of
1518     // epilog offsets. Epilogs always start at the beginning of an IG, so save the first
1519     // IG of the epilog, and use it to find the epilog offset at the end of code generation.
1520     struct EpilogList
1521     {
1522         EpilogList*  elNext;
1523         emitLocation elLoc;
1524
1525         EpilogList() : elNext(nullptr), elLoc()
1526         {
1527         }
1528     };
1529
1530     EpilogList* emitEpilogList; // per method epilog list - head
1531     EpilogList* emitEpilogLast; // per method epilog list - tail
1532
1533 public:
1534     void emitStartEpilog();
1535
1536     bool emitHasEpilogEnd();
1537
1538     size_t emitGenEpilogLst(size_t (*fp)(void*, unsigned), void* cp);
1539
1540 #endif // JIT32_GCENCODER
1541
1542     void emitBegPrologEpilog(insGroup* igPh);
1543     void emitEndPrologEpilog();
1544
1545     void emitBegFnEpilog(insGroup* igPh);
1546     void emitEndFnEpilog();
1547
1548 #if FEATURE_EH_FUNCLETS
1549
1550     void emitBegFuncletProlog(insGroup* igPh);
1551     void emitEndFuncletProlog();
1552
1553     void emitBegFuncletEpilog(insGroup* igPh);
1554     void emitEndFuncletEpilog();
1555
1556 #endif // FEATURE_EH_FUNCLETS
1557
1558 /************************************************************************/
1559 /*           Members and methods used in PDB translation                */
1560 /************************************************************************/
1561
1562 #ifdef TRANSLATE_PDB
1563
1564     inline void SetIDSource(instrDesc* pID);
1565     void MapCode(int ilOffset, BYTE* imgDest);
1566     void MapFunc(int                imgOff,
1567                  int                procLen,
1568                  int                dbgStart,
1569                  int                dbgEnd,
1570                  short              frameReg,
1571                  int                stkAdjust,
1572                  int                lvaCount,
1573                  OptJit::LclVarDsc* lvaTable,
1574                  bool               framePtr);
1575
1576 private:
1577     int              emitInstrDescILBase; // code offset of IL that produced this instruction desctriptor
1578     int              emitInstrDescILBase; // code offset of IL that produced this instruction desctriptor
1579     static AddrMap*  emitPDBOffsetTable;  // translation table for mapping IL addresses to native addresses
1580     static LocalMap* emitPDBLocalTable;   // local symbol translation table
1581     static bool      emitIsPDBEnabled;    // flag to disable PDB translation code when a PDB is not found
1582     static BYTE*     emitILBaseOfCode;    // start of IL .text section
1583     static BYTE*     emitILMethodBase;    // beginning of IL method (start of header)
1584     static BYTE*     emitILMethodStart;   // beginning of IL method code (right after the header)
1585     static BYTE*     emitImgBaseOfCode;   // start of the image .text section
1586
1587 #endif
1588
1589     /************************************************************************/
1590     /*    Methods to record a code position and later convert to offset     */
1591     /************************************************************************/
1592
1593     unsigned emitFindInsNum(insGroup* ig, instrDesc* id);
1594     UNATIVE_OFFSET emitFindOffset(insGroup* ig, unsigned insNum);
1595
1596 /************************************************************************/
1597 /*        Members and methods used to issue (encode) instructions.      */
1598 /************************************************************************/
1599
1600 #ifdef DEBUG
1601     // If we have started issuing instructions from the list of instrDesc, this is set
1602     bool emitIssuing;
1603 #endif
1604
1605     BYTE* emitCodeBlock;     // Hot code block
1606     BYTE* emitColdCodeBlock; // Cold code block
1607     BYTE* emitConsBlock;     // Read-only (constant) data block
1608
1609     UNATIVE_OFFSET emitTotalHotCodeSize;
1610     UNATIVE_OFFSET emitTotalColdCodeSize;
1611
1612     UNATIVE_OFFSET emitCurCodeOffs(BYTE* dst)
1613     {
1614         size_t distance;
1615         if ((dst >= emitCodeBlock) && (dst <= (emitCodeBlock + emitTotalHotCodeSize)))
1616         {
1617             distance = (dst - emitCodeBlock);
1618         }
1619         else
1620         {
1621             assert(emitFirstColdIG);
1622             assert(emitColdCodeBlock);
1623             assert((dst >= emitColdCodeBlock) && (dst <= (emitColdCodeBlock + emitTotalColdCodeSize)));
1624
1625             distance = (dst - emitColdCodeBlock + emitTotalHotCodeSize);
1626         }
1627         noway_assert((UNATIVE_OFFSET)distance == distance);
1628         return (UNATIVE_OFFSET)distance;
1629     }
1630
1631     BYTE* emitOffsetToPtr(UNATIVE_OFFSET offset)
1632     {
1633         if (offset < emitTotalHotCodeSize)
1634         {
1635             return emitCodeBlock + offset;
1636         }
1637         else
1638         {
1639             assert(offset < (emitTotalHotCodeSize + emitTotalColdCodeSize));
1640
1641             return emitColdCodeBlock + (offset - emitTotalHotCodeSize);
1642         }
1643     }
1644
1645     BYTE* emitDataOffsetToPtr(UNATIVE_OFFSET offset)
1646     {
1647         assert(offset < emitDataSize());
1648         return emitConsBlock + offset;
1649     }
1650
1651     bool emitJumpCrossHotColdBoundary(size_t srcOffset, size_t dstOffset)
1652     {
1653         if (emitTotalColdCodeSize == 0)
1654         {
1655             return false;
1656         }
1657
1658         assert(srcOffset < (emitTotalHotCodeSize + emitTotalColdCodeSize));
1659         assert(dstOffset < (emitTotalHotCodeSize + emitTotalColdCodeSize));
1660
1661         return ((srcOffset < emitTotalHotCodeSize) != (dstOffset < emitTotalHotCodeSize));
1662     }
1663
1664     unsigned char emitOutputByte(BYTE* dst, ssize_t val);
1665     unsigned char emitOutputWord(BYTE* dst, ssize_t val);
1666     unsigned char emitOutputLong(BYTE* dst, ssize_t val);
1667     unsigned char emitOutputSizeT(BYTE* dst, ssize_t val);
1668
1669 #if !defined(LEGACY_BACKEND) && defined(_TARGET_X86_)
1670     unsigned char emitOutputByte(BYTE* dst, size_t val);
1671     unsigned char emitOutputWord(BYTE* dst, size_t val);
1672     unsigned char emitOutputLong(BYTE* dst, size_t val);
1673     unsigned char emitOutputSizeT(BYTE* dst, size_t val);
1674
1675     unsigned char emitOutputByte(BYTE* dst, unsigned __int64 val);
1676     unsigned char emitOutputWord(BYTE* dst, unsigned __int64 val);
1677     unsigned char emitOutputLong(BYTE* dst, unsigned __int64 val);
1678     unsigned char emitOutputSizeT(BYTE* dst, unsigned __int64 val);
1679 #endif // !defined(LEGACY_BACKEND) && defined(_TARGET_X86_)
1680
1681     size_t emitIssue1Instr(insGroup* ig, instrDesc* id, BYTE** dp);
1682     size_t emitOutputInstr(insGroup* ig, instrDesc* id, BYTE** dp);
1683
1684     bool emitHasFramePtr;
1685
1686 #ifdef PSEUDORANDOM_NOP_INSERTION
1687     bool emitInInstrumentation;
1688 #endif // PSEUDORANDOM_NOP_INSERTION
1689
1690     unsigned emitMaxTmpSize;
1691
1692 #ifdef LEGACY_BACKEND
1693     unsigned emitLclSize;
1694     unsigned emitGrowableMaxByteOffs;
1695     void emitTmpSizeChanged(unsigned tmpSize);
1696 #ifdef DEBUG
1697     unsigned emitMaxByteOffsIdNum;
1698 #endif // DEBUG
1699 #endif // LEGACY_BACKEND
1700
1701 #ifdef DEBUG
1702     bool emitChkAlign; // perform some alignment checks
1703 #endif
1704
1705     insGroup* emitCurIG;
1706
1707     void emitSetShortJump(instrDescJmp* id);
1708     void emitSetMediumJump(instrDescJmp* id);
1709     UNATIVE_OFFSET emitSizeOfJump(instrDescJmp* jmp);
1710     UNATIVE_OFFSET emitInstCodeSz(instrDesc* id);
1711
1712 #ifndef LEGACY_BACKEND
1713     CORINFO_FIELD_HANDLE emitFltOrDblConst(GenTreeDblCon* tree, emitAttr attr = EA_UNKNOWN);
1714     regNumber emitInsBinary(instruction ins, emitAttr attr, GenTree* dst, GenTree* src);
1715     regNumber emitInsTernary(instruction ins, emitAttr attr, GenTree* dst, GenTree* src1, GenTree* src2);
1716     void emitInsLoadInd(instruction ins, emitAttr attr, regNumber dstReg, GenTreeIndir* mem);
1717     void emitInsStoreInd(instruction ins, emitAttr attr, GenTreeStoreInd* mem);
1718     void emitInsStoreLcl(instruction ins, emitAttr attr, GenTreeLclVarCommon* varNode);
1719     insFormat emitMapFmtForIns(insFormat fmt, instruction ins);
1720     insFormat emitMapFmtAtoM(insFormat fmt);
1721     void emitHandleMemOp(GenTreeIndir* indir, instrDesc* id, insFormat fmt, instruction ins);
1722     void spillIntArgRegsToShadowSlots();
1723 #endif // !LEGACY_BACKEND
1724
1725 /************************************************************************/
1726 /*      The logic that creates and keeps track of instruction groups    */
1727 /************************************************************************/
1728
1729 #ifdef _TARGET_ARM_
1730 // The only place where this limited instruction group size is a problem is
1731 // in the prolog, where we only support a single instruction group. We should really fix that.
1732 // ARM can require a bigger prolog instruction group. One scenario is where a
1733 // function uses all the incoming integer and single-precision floating-point arguments,
1734 // and must store them all to the frame on entry. If the frame is very large, we generate
1735 // ugly code like "movw r10, 0x488; add r10, sp; vstr s0, [r10]" for each store, which
1736 // eats up our insGroup buffer.
1737 #define SC_IG_BUFFER_SIZE (100 * sizeof(instrDesc) + 14 * TINY_IDSC_SIZE)
1738 #else // !_TARGET_ARM_
1739 #define SC_IG_BUFFER_SIZE (50 * sizeof(instrDesc) + 14 * TINY_IDSC_SIZE)
1740 #endif // !_TARGET_ARM_
1741
1742     size_t emitIGbuffSize;
1743
1744     insGroup* emitIGlist; // first  instruction group
1745     insGroup* emitIGlast; // last   instruction group
1746     insGroup* emitIGthis; // issued instruction group
1747
1748     insGroup* emitPrologIG; // prolog instruction group
1749
1750     instrDescJmp* emitJumpList;       // list of local jumps in method
1751     instrDescJmp* emitJumpLast;       // last of local jumps in method
1752     void          emitJumpDistBind(); // Bind all the local jumps in method
1753
1754     void emitCheckFuncletBranch(instrDesc* jmp, insGroup* jmpIG); // Check for illegal branches between funclets
1755
1756     bool emitFwdJumps;   // forward jumps present?
1757     bool emitNoGCIG;     // Are we generating IGF_NOGCINTERRUPT insGroups (for prologs, epilogs, etc.)
1758     bool emitForceNewIG; // If we generate an instruction, and not another instruction group, force create a new emitAdd
1759                          // instruction group.
1760
1761     BYTE* emitCurIGfreeNext; // next available byte in buffer
1762     BYTE* emitCurIGfreeEndp; // one byte past the last available byte in buffer
1763     BYTE* emitCurIGfreeBase; // first byte address
1764
1765     unsigned       emitCurIGinsCnt;   // # of collected instr's in buffer
1766     unsigned       emitCurIGsize;     // estimated code size of current group in bytes
1767     UNATIVE_OFFSET emitCurCodeOffset; // current code offset within group
1768     UNATIVE_OFFSET emitTotalCodeSize; // bytes of code in entire method
1769
1770     insGroup* emitFirstColdIG; // first cold instruction group
1771
1772     void emitSetFirstColdIGCookie(void* bbEmitCookie)
1773     {
1774         emitFirstColdIG = (insGroup*)bbEmitCookie;
1775     }
1776
1777     int emitOffsAdj; // current code offset adjustment
1778
1779     instrDescJmp* emitCurIGjmpList; // list of jumps   in current IG
1780
1781     // emitPrev* and emitInit* are only used during code generation, not during
1782     // emission (issuing), to determine what GC values to store into an IG.
1783     // Note that only the Vars ones are actually used, apparently due to bugs
1784     // in that tracking. See emitSavIG(): the important use of ByrefRegs is commented
1785     // out, and GCrefRegs is always saved.
1786
1787     VARSET_TP emitPrevGCrefVars;
1788     regMaskTP emitPrevGCrefRegs;
1789     regMaskTP emitPrevByrefRegs;
1790
1791     VARSET_TP emitInitGCrefVars;
1792     regMaskTP emitInitGCrefRegs;
1793     regMaskTP emitInitByrefRegs;
1794
1795     // If this is set, we ignore comparing emitPrev* and emitInit* to determine
1796     // whether to save GC state (to save space in the IG), and always save it.
1797
1798     bool emitForceStoreGCState;
1799
1800     // emitThis* variables are used during emission, to track GC updates
1801     // on a per-instruction basis. During code generation, per-instruction
1802     // tracking is done with variables gcVarPtrSetCur, gcRegGCrefSetCur,
1803     // and gcRegByrefSetCur. However, these are also used for a slightly
1804     // different purpose during code generation: to try to minimize the
1805     // amount of GC data stored to an IG, by only storing deltas from what
1806     // we expect to see at an IG boundary. Also, only emitThisGCrefVars is
1807     // really the only one used; the others seem to be calculated, but not
1808     // used due to bugs.
1809
1810     VARSET_TP emitThisGCrefVars;
1811     regMaskTP emitThisGCrefRegs; // Current set of registers holding GC references
1812     regMaskTP emitThisByrefRegs; // Current set of registers holding BYREF references
1813
1814     bool emitThisGCrefVset; // Is "emitThisGCrefVars" up to date?
1815
1816     regNumber emitSyncThisObjReg; // where is "this" enregistered for synchronized methods?
1817
1818 #if MULTIREG_HAS_SECOND_GC_RET
1819     void emitSetSecondRetRegGCType(instrDescCGCA* id, emitAttr secondRetSize);
1820 #endif // MULTIREG_HAS_SECOND_GC_RET
1821
1822     static void emitEncodeCallGCregs(regMaskTP regs, instrDesc* id);
1823     static unsigned emitDecodeCallGCregs(instrDesc* id);
1824
1825     unsigned emitNxtIGnum;
1826
1827     // random nop insertion to break up nop sleds
1828     unsigned emitNextNop;
1829     bool     emitRandomNops;
1830     void     emitEnableRandomNops()
1831     {
1832         emitRandomNops = true;
1833     }
1834     void emitDisableRandomNops()
1835     {
1836         emitRandomNops = false;
1837     }
1838
1839     insGroup* emitAllocAndLinkIG();
1840     insGroup* emitAllocIG();
1841     void emitInitIG(insGroup* ig);
1842     void emitInsertIGAfter(insGroup* insertAfterIG, insGroup* ig);
1843
1844     void emitNewIG();
1845
1846 #if !defined(JIT32_GCENCODER)
1847     void emitDisableGC();
1848     void emitEnableGC();
1849 #endif // !defined(JIT32_GCENCODER)
1850
1851     void emitGenIG(insGroup* ig);
1852     insGroup* emitSavIG(bool emitAdd = false);
1853     void emitNxtIG(bool emitAdd = false);
1854
1855     bool emitCurIGnonEmpty()
1856     {
1857         return (emitCurIG && emitCurIGfreeNext > emitCurIGfreeBase);
1858     }
1859
1860     instrDesc* emitLastIns;
1861
1862 #ifdef DEBUG
1863     void emitCheckIGoffsets();
1864 #endif
1865
1866     // Terminates any in-progress instruction group, making the current IG a new empty one.
1867     // Mark this instruction group as having a label; return the the new instruction group.
1868     // Sets the emitter's record of the currently live GC variables
1869     // and registers.  The "isFinallyTarget" parameter indicates that the current location is
1870     // the start of a basic block that is returned to after a finally clause in non-exceptional execution.
1871     void* emitAddLabel(VARSET_VALARG_TP GCvars, regMaskTP gcrefRegs, regMaskTP byrefRegs, BOOL isFinallyTarget = FALSE);
1872
1873 #ifdef _TARGET_ARMARCH_
1874
1875     void emitGetInstrDescs(insGroup* ig, instrDesc** id, int* insCnt);
1876
1877     bool emitGetLocationInfo(emitLocation* emitLoc, insGroup** pig, instrDesc** pid, int* pinsRemaining = NULL);
1878
1879     bool emitNextID(insGroup*& ig, instrDesc*& id, int& insRemaining);
1880
1881     typedef void (*emitProcessInstrFunc_t)(instrDesc* id, void* context);
1882
1883     void emitWalkIDs(emitLocation* locFrom, emitProcessInstrFunc_t processFunc, void* context);
1884
1885     static void emitGenerateUnwindNop(instrDesc* id, void* context);
1886
1887 #endif // _TARGET_ARMARCH_
1888
1889 #if defined(_TARGET_ARM_)
1890     emitter::insFormat emitInsFormat(instruction ins);
1891     size_t emitInsCode(instruction ins, insFormat fmt);
1892 #endif
1893
1894 #ifdef _TARGET_X86_
1895     void emitMarkStackLvl(unsigned stackLevel);
1896 #endif
1897
1898     int emitNextRandomNop();
1899
1900     void* emitAllocInstr(size_t sz, emitAttr attr);
1901
1902     instrDesc* emitAllocInstr(emitAttr attr)
1903     {
1904         return (instrDesc*)emitAllocInstr(sizeof(instrDesc), attr);
1905     }
1906
1907     instrDescJmp* emitAllocInstrJmp()
1908     {
1909         return (instrDescJmp*)emitAllocInstr(sizeof(instrDescJmp), EA_1BYTE);
1910     }
1911
1912 #if !defined(_TARGET_ARM64_)
1913     instrDescLbl* emitAllocInstrLbl()
1914     {
1915         return (instrDescLbl*)emitAllocInstr(sizeof(instrDescLbl), EA_4BYTE);
1916     }
1917 #endif // !_TARGET_ARM64_
1918
1919     instrDescCns* emitAllocInstrCns(emitAttr attr)
1920     {
1921         return (instrDescCns*)emitAllocInstr(sizeof(instrDescCns), attr);
1922     }
1923     instrDescCns* emitAllocInstrCns(emitAttr attr, int cns)
1924     {
1925         instrDescCns* result = (instrDescCns*)emitAllocInstr(sizeof(instrDescCns), attr);
1926         result->idSetIsLargeCns();
1927         result->idcCnsVal = cns;
1928         return result;
1929     }
1930
1931     instrDescDsp* emitAllocInstrDsp(emitAttr attr)
1932     {
1933         return (instrDescDsp*)emitAllocInstr(sizeof(instrDescDsp), attr);
1934     }
1935
1936     instrDescCnsDsp* emitAllocInstrCnsDsp(emitAttr attr)
1937     {
1938         return (instrDescCnsDsp*)emitAllocInstr(sizeof(instrDescCnsDsp), attr);
1939     }
1940
1941     instrDescAmd* emitAllocInstrAmd(emitAttr attr)
1942     {
1943         return (instrDescAmd*)emitAllocInstr(sizeof(instrDescAmd), attr);
1944     }
1945
1946     instrDescCnsAmd* emitAllocInstrCnsAmd(emitAttr attr)
1947     {
1948         return (instrDescCnsAmd*)emitAllocInstr(sizeof(instrDescCnsAmd), attr);
1949     }
1950
1951     instrDescCGCA* emitAllocInstrCGCA(emitAttr attr)
1952     {
1953         return (instrDescCGCA*)emitAllocInstr(sizeof(instrDescCGCA), attr);
1954     }
1955
1956     instrDesc* emitNewInstrTiny(emitAttr attr);
1957     instrDesc* emitNewInstrSmall(emitAttr attr);
1958     instrDesc* emitNewInstr(emitAttr attr = EA_4BYTE);
1959     instrDesc* emitNewInstrSC(emitAttr attr, ssize_t cns);
1960     instrDesc* emitNewInstrCns(emitAttr attr, ssize_t cns);
1961     instrDesc* emitNewInstrDsp(emitAttr attr, ssize_t dsp);
1962     instrDesc* emitNewInstrCnsDsp(emitAttr attr, ssize_t cns, int dsp);
1963     instrDescJmp* emitNewInstrJmp();
1964
1965 #if !defined(_TARGET_ARM64_)
1966     instrDescLbl* emitNewInstrLbl();
1967 #endif // !_TARGET_ARM64_
1968
1969     static const BYTE emitFmtToOps[];
1970
1971 #ifdef DEBUG
1972     static const unsigned emitFmtCount;
1973 #endif
1974
1975     bool emitIsTinyInsDsc(instrDesc* id);
1976     bool emitIsScnsInsDsc(instrDesc* id);
1977
1978     size_t emitSizeOfInsDsc(instrDesc* id);
1979
1980     /************************************************************************/
1981     /*        The following keeps track of stack-based GC values            */
1982     /************************************************************************/
1983
1984     unsigned emitTrkVarCnt;
1985     int*     emitGCrFrameOffsTab; // Offsets of tracked stack ptr vars (varTrkIndex -> stkOffs)
1986
1987     unsigned    emitGCrFrameOffsCnt; // Number of       tracked stack ptr vars
1988     int         emitGCrFrameOffsMin; // Min offset of a tracked stack ptr var
1989     int         emitGCrFrameOffsMax; // Max offset of a tracked stack ptr var
1990     bool        emitContTrkPtrLcls;  // All lcl between emitGCrFrameOffsMin/Max are only tracked stack ptr vars
1991     varPtrDsc** emitGCrFrameLiveTab; // Cache of currently live varPtrs (stkOffs -> varPtrDsc)
1992
1993     int emitArgFrameOffsMin;
1994     int emitArgFrameOffsMax;
1995
1996     int emitLclFrameOffsMin;
1997     int emitLclFrameOffsMax;
1998
1999     int emitSyncThisObjOffs; // what is the offset of "this" for synchronized methods?
2000
2001 public:
2002     void emitSetFrameRangeGCRs(int offsLo, int offsHi);
2003     void emitSetFrameRangeLcls(int offsLo, int offsHi);
2004     void emitSetFrameRangeArgs(int offsLo, int offsHi);
2005
2006     static instruction emitJumpKindToIns(emitJumpKind jumpKind);
2007     static emitJumpKind emitInsToJumpKind(instruction ins);
2008     static emitJumpKind emitReverseJumpKind(emitJumpKind jumpKind);
2009
2010 #ifdef _TARGET_ARM_
2011     static unsigned emitJumpKindCondCode(emitJumpKind jumpKind);
2012 #endif
2013
2014 #ifdef DEBUG
2015     void emitInsSanityCheck(instrDesc* id);
2016 #endif
2017
2018 #ifdef _TARGET_ARMARCH_
2019     // Returns true if instruction "id->idIns()" writes to a register that might be used to contain a GC
2020     // pointer. This exempts the SP and PC registers, and floating point registers. Memory access
2021     // instructions that pre- or post-increment their memory address registers are *not* considered to write
2022     // to GC registers, even if that memory address is a by-ref: such an instruction cannot change the GC
2023     // status of that register, since it must be a byref before and remains one after.
2024     //
2025     // This may return false positives.
2026     bool emitInsMayWriteToGCReg(instrDesc* id);
2027
2028     // Returns "true" if instruction "id->idIns()" writes to a LclVar stack location.
2029     bool emitInsWritesToLclVarStackLoc(instrDesc* id);
2030
2031     // Returns true if the instruction may write to more than one register.
2032     bool emitInsMayWriteMultipleRegs(instrDesc* id);
2033
2034     // Returns "true" if instruction "id->idIns()" writes to a LclVar stack slot pair.
2035     bool emitInsWritesToLclVarStackLocPair(instrDesc* id);
2036 #endif // _TARGET_ARMARCH_
2037
2038     /************************************************************************/
2039     /*    The following is used to distinguish helper vs non-helper calls   */
2040     /************************************************************************/
2041
2042     static bool emitNoGChelper(unsigned IHX);
2043
2044     /************************************************************************/
2045     /*         The following logic keeps track of live GC ref values        */
2046     /************************************************************************/
2047
2048     bool emitFullArgInfo; // full arg info (including non-ptr arg)?
2049     bool emitFullGCinfo;  // full GC pointer maps?
2050     bool emitFullyInt;    // fully interruptible code?
2051
2052 #if EMIT_TRACK_STACK_DEPTH
2053     unsigned emitCntStackDepth; // 0 in prolog/epilog, One DWORD elsewhere
2054     unsigned emitMaxStackDepth; // actual computed max. stack depth
2055 #endif
2056
2057     /* Stack modelling wrt GC */
2058
2059     bool emitSimpleStkUsed; // using the "simple" stack table?
2060
2061     union {
2062         struct // if emitSimpleStkUsed==true
2063         {
2064 #define BITS_IN_BYTE (8)
2065 #define MAX_SIMPLE_STK_DEPTH (BITS_IN_BYTE * sizeof(unsigned))
2066
2067             unsigned emitSimpleStkMask;      // bit per pushed dword (if it fits. Lowest bit <==> last pushed arg)
2068             unsigned emitSimpleByrefStkMask; // byref qualifier for emitSimpleStkMask
2069         } u1;
2070
2071         struct // if emitSimpleStkUsed==false
2072         {
2073             BYTE   emitArgTrackLcl[16]; // small local table to avoid malloc
2074             BYTE*  emitArgTrackTab;     // base of the argument tracking stack
2075             BYTE*  emitArgTrackTop;     // top  of the argument tracking stack
2076             USHORT emitGcArgTrackCnt;   // count of pending arg records (stk-depth for frameless methods, gc ptrs on stk
2077                                         // for framed methods)
2078         } u2;
2079     };
2080
2081     unsigned emitCurStackLvl; // amount of bytes pushed on stack
2082
2083 #if EMIT_TRACK_STACK_DEPTH
2084     /* Functions for stack tracking */
2085
2086     void emitStackPush(BYTE* addr, GCtype gcType);
2087
2088     void emitStackPushN(BYTE* addr, unsigned count);
2089
2090     void emitStackPop(BYTE* addr, bool isCall, unsigned char callInstrSize, unsigned count = 1);
2091
2092     void emitStackKillArgs(BYTE* addr, unsigned count, unsigned char callInstrSize);
2093
2094     void emitRecordGCcall(BYTE* codePos, unsigned char callInstrSize);
2095
2096     // Helpers for the above
2097
2098     void emitStackPushLargeStk(BYTE* addr, GCtype gcType, unsigned count = 1);
2099     void emitStackPopLargeStk(BYTE* addr, bool isCall, unsigned char callInstrSize, unsigned count = 1);
2100 #endif // EMIT_TRACK_STACK_DEPTH
2101
2102     /* Liveness of stack variables, and registers */
2103
2104     void emitUpdateLiveGCvars(int offs, BYTE* addr, bool birth);
2105     void emitUpdateLiveGCvars(VARSET_VALARG_TP vars, BYTE* addr);
2106     void emitUpdateLiveGCregs(GCtype gcType, regMaskTP regs, BYTE* addr);
2107
2108 #ifdef DEBUG
2109     const char* emitGetFrameReg();
2110     void emitDispRegSet(regMaskTP regs);
2111     void emitDispVarSet();
2112 #endif
2113
2114     void emitGCregLiveUpd(GCtype gcType, regNumber reg, BYTE* addr);
2115     void emitGCregLiveSet(GCtype gcType, regMaskTP mask, BYTE* addr, bool isThis);
2116     void emitGCregDeadUpdMask(regMaskTP, BYTE* addr);
2117     void emitGCregDeadUpd(regNumber reg, BYTE* addr);
2118     void emitGCregDeadSet(GCtype gcType, regMaskTP mask, BYTE* addr);
2119
2120     void emitGCvarLiveUpd(int offs, int varNum, GCtype gcType, BYTE* addr);
2121     void emitGCvarLiveSet(int offs, GCtype gcType, BYTE* addr, ssize_t disp = -1);
2122     void emitGCvarDeadUpd(int offs, BYTE* addr);
2123     void emitGCvarDeadSet(int offs, BYTE* addr, ssize_t disp = -1);
2124
2125     GCtype emitRegGCtype(regNumber reg);
2126
2127     // We have a mixture of code emission methods, some of which return the size of the emitted instruction,
2128     // requiring the caller to add this to the current code pointer (dst += <call to emit code>), others of which
2129     // return the updated code pointer (dst = <call to emit code>).  Sometimes we'd like to get the size of
2130     // the generated instruction for the latter style.  This method accomplishes that --
2131     // "emitCodeWithInstructionSize(dst, <call to emitCode>, &instrSize)" will do the call, and set
2132     // "*instrSize" to the after-before code pointer difference.  Returns the result of the call.  (And
2133     // asserts that the instruction size fits in an unsigned char.)
2134     static BYTE* emitCodeWithInstructionSize(BYTE* codePtrBefore, BYTE* newCodePointer, unsigned char* instrSize);
2135
2136     /************************************************************************/
2137     /*      The following logic keeps track of initialized data sections    */
2138     /************************************************************************/
2139
2140     /* One of these is allocated for every blob of initialized data */
2141
2142     struct dataSection
2143     {
2144         enum sectionType
2145         {
2146             data,
2147             blockAbsoluteAddr,
2148             blockRelative32
2149         };
2150
2151         dataSection*   dsNext;
2152         UNATIVE_OFFSET dsSize;
2153         sectionType    dsType;
2154         // variable-sized array used to store the constant data
2155         // or BasicBlock* array in the block cases.
2156         BYTE dsCont[0];
2157     };
2158
2159     /* These describe the entire initialized/uninitialized data sections */
2160
2161     struct dataSecDsc
2162     {
2163         dataSection*   dsdList;
2164         dataSection*   dsdLast;
2165         UNATIVE_OFFSET dsdOffs;
2166     };
2167
2168     dataSecDsc emitConsDsc;
2169
2170     dataSection* emitDataSecCur;
2171
2172     void emitOutputDataSec(dataSecDsc* sec, BYTE* dst);
2173
2174     /************************************************************************/
2175     /*              Handles to the current class and method.                */
2176     /************************************************************************/
2177
2178     COMP_HANDLE emitCmpHandle;
2179
2180     /************************************************************************/
2181     /*               Helpers for interface to EE                            */
2182     /************************************************************************/
2183
2184     void emitRecordRelocation(void* location,       /* IN */
2185                               void* target,         /* IN */
2186                               WORD  fRelocType,     /* IN */
2187                               WORD  slotNum   = 0,  /* IN */
2188                               INT32 addlDelta = 0); /* IN */
2189
2190 #ifdef _TARGET_ARM_
2191     void emitHandlePCRelativeMov32(void* location, /* IN */
2192                                    void* target);  /* IN */
2193 #endif
2194
2195     void emitRecordCallSite(ULONG                 instrOffset,   /* IN */
2196                             CORINFO_SIG_INFO*     callSig,       /* IN */
2197                             CORINFO_METHOD_HANDLE methodHandle); /* IN */
2198
2199 #ifdef DEBUG
2200     // This is a scratch buffer used to minimize the number of sig info structs
2201     // we have to allocate for recordCallSite.
2202     CORINFO_SIG_INFO* emitScratchSigInfo;
2203 #endif // DEBUG
2204
2205 /************************************************************************/
2206 /*               Logic to collect and display statistics                */
2207 /************************************************************************/
2208
2209 #if EMITTER_STATS
2210
2211     friend void emitterStats(FILE* fout);
2212     friend void emitterStaticStats(FILE* fout);
2213
2214     static size_t emitSizeMethod;
2215
2216     static unsigned emitTotalInsCnt;
2217
2218     static unsigned emitTotalIGcnt;   // total number of insGroup allocated
2219     static unsigned emitTotalPhIGcnt; // total number of insPlaceholderGroupData allocated
2220     static unsigned emitTotalIGicnt;
2221     static size_t   emitTotalIGsize;
2222     static unsigned emitTotalIGmcnt; // total method count
2223     static unsigned emitTotalIGjmps;
2224     static unsigned emitTotalIGptrs;
2225
2226     static size_t emitTotMemAlloc;
2227
2228     static unsigned emitSmallDspCnt;
2229     static unsigned emitLargeDspCnt;
2230
2231     static unsigned emitSmallCnsCnt;
2232 #define SMALL_CNS_TSZ 256
2233     static unsigned emitSmallCns[SMALL_CNS_TSZ];
2234     static unsigned emitLargeCnsCnt;
2235
2236     static unsigned emitIFcounts[IF_COUNT];
2237
2238 #endif // EMITTER_STATS
2239
2240 /*************************************************************************
2241  *
2242  *  Define any target-dependent emitter members.
2243  */
2244
2245 #include "emitdef.h"
2246
2247     // It would be better if this were a constructor, but that would entail revamping the allocation
2248     // infrastructure of the entire JIT...
2249     void Init()
2250     {
2251         VarSetOps::AssignNoCopy(emitComp, emitPrevGCrefVars, VarSetOps::MakeEmpty(emitComp));
2252         VarSetOps::AssignNoCopy(emitComp, emitInitGCrefVars, VarSetOps::MakeEmpty(emitComp));
2253         VarSetOps::AssignNoCopy(emitComp, emitThisGCrefVars, VarSetOps::MakeEmpty(emitComp));
2254     }
2255 };
2256
2257 /*****************************************************************************
2258  *
2259  *  Define any target-dependent inlines.
2260  */
2261
2262 #include "emitinl.h"
2263
2264 inline void emitter::instrDesc::checkSizes()
2265 {
2266 #ifdef DEBUG
2267 #if HAS_TINY_DESC
2268     C_ASSERT(TINY_IDSC_SIZE == (offsetof(instrDesc, _idDebugOnlyInfo) + sizeof(instrDescDebugInfo*)));
2269 #else // !tiny
2270     C_ASSERT(SMALL_IDSC_SIZE == (offsetof(instrDesc, _idDebugOnlyInfo) + sizeof(instrDescDebugInfo*)));
2271 #endif
2272 #endif
2273     C_ASSERT(SMALL_IDSC_SIZE == offsetof(instrDesc, _idAddrUnion));
2274 }
2275
2276 /*****************************************************************************
2277  *
2278  *  Returns true if the given instruction descriptor is a "tiny" or a "small
2279  *  constant" one (i.e. one of the descriptors that don't have all instrDesc
2280  *  fields allocated).
2281  */
2282
2283 inline bool emitter::emitIsTinyInsDsc(instrDesc* id)
2284 {
2285     return id->idIsTiny();
2286 }
2287
2288 inline bool emitter::emitIsScnsInsDsc(instrDesc* id)
2289 {
2290     return id->idIsSmallDsc();
2291 }
2292
2293 /*****************************************************************************
2294  *
2295  *  Given an instruction, return its "update mode" (RD/WR/RW).
2296  */
2297
2298 inline insUpdateModes emitter::emitInsUpdateMode(instruction ins)
2299 {
2300 #ifdef DEBUG
2301     assert((unsigned)ins < emitInsModeFmtCnt);
2302 #endif
2303     return (insUpdateModes)emitInsModeFmtTab[ins];
2304 }
2305
2306 /*****************************************************************************
2307  *
2308  *  Return the number of epilog blocks generated so far.
2309  */
2310
2311 inline unsigned emitter::emitGetEpilogCnt()
2312 {
2313     return emitEpilogCnt;
2314 }
2315
2316 /*****************************************************************************
2317  *
2318  *  Return the current size of the specified data section.
2319  */
2320
2321 inline UNATIVE_OFFSET emitter::emitDataSize()
2322 {
2323     return emitConsDsc.dsdOffs;
2324 }
2325
2326 /*****************************************************************************
2327  *
2328  *  Return a handle to the current position in the output stream. This can
2329  *  be later converted to an actual code offset in bytes.
2330  */
2331
2332 inline void* emitter::emitCurBlock()
2333 {
2334     return emitCurIG;
2335 }
2336
2337 /*****************************************************************************
2338  *
2339  *  The emitCurOffset() method returns a cookie that identifies the current
2340  *  position in the instruction stream. Due to things like scheduling (and
2341  *  the fact that the final size of some instructions cannot be known until
2342  *  the end of code generation), we return a value with the instruction number
2343  *  and its estimated offset to the caller.
2344  */
2345
2346 inline unsigned emitGetInsNumFromCodePos(unsigned codePos)
2347 {
2348     return (codePos & 0xFFFF);
2349 }
2350
2351 inline unsigned emitGetInsOfsFromCodePos(unsigned codePos)
2352 {
2353     return (codePos >> 16);
2354 }
2355
2356 inline unsigned emitter::emitCurOffset()
2357 {
2358     unsigned codePos = emitCurIGinsCnt + (emitCurIGsize << 16);
2359
2360     assert(emitGetInsOfsFromCodePos(codePos) == emitCurIGsize);
2361     assert(emitGetInsNumFromCodePos(codePos) == emitCurIGinsCnt);
2362
2363     // printf("[IG=%02u;ID=%03u;OF=%04X] => %08X\n", emitCurIG->igNum, emitCurIGinsCnt, emitCurIGsize, codePos);
2364
2365     return codePos;
2366 }
2367
2368 extern const unsigned short emitTypeSizes[TYP_COUNT];
2369
2370 template <class T>
2371 inline emitAttr emitTypeSize(T type)
2372 {
2373     assert(TypeGet(type) < TYP_COUNT);
2374     assert(emitTypeSizes[TypeGet(type)] > 0);
2375     return (emitAttr)emitTypeSizes[TypeGet(type)];
2376 }
2377
2378 extern const unsigned short emitTypeActSz[TYP_COUNT];
2379
2380 template <class T>
2381 inline emitAttr emitActualTypeSize(T type)
2382 {
2383     assert(TypeGet(type) < TYP_COUNT);
2384     assert(emitTypeActSz[TypeGet(type)] > 0);
2385     return (emitAttr)emitTypeActSz[TypeGet(type)];
2386 }
2387
2388 /*****************************************************************************
2389  *
2390  *  Convert between an operand size in bytes and a smaller encoding used for
2391  *  storage in instruction descriptors.
2392  */
2393
2394 /* static */ inline emitter::opSize emitter::emitEncodeSize(emitAttr size)
2395 {
2396     assert(size == EA_1BYTE || size == EA_2BYTE || size == EA_4BYTE || size == EA_8BYTE || size == EA_16BYTE ||
2397            size == EA_32BYTE);
2398
2399     return emitSizeEncode[((int)size) - 1];
2400 }
2401
2402 /* static */ inline emitAttr emitter::emitDecodeSize(emitter::opSize ensz)
2403 {
2404     assert(((unsigned)ensz) < OPSZ_COUNT);
2405
2406     return emitSizeDecode[ensz];
2407 }
2408
2409 /*****************************************************************************
2410  *
2411  *  Little helpers to allocate various flavors of instructions.
2412  */
2413
2414 inline emitter::instrDesc* emitter::emitNewInstrTiny(emitAttr attr)
2415 {
2416     instrDesc* id;
2417
2418     id = (instrDesc*)emitAllocInstr(TINY_IDSC_SIZE, attr);
2419     id->idSetIsTiny();
2420
2421     return id;
2422 }
2423
2424 inline emitter::instrDesc* emitter::emitNewInstrSmall(emitAttr attr)
2425 {
2426     instrDesc* id;
2427
2428     // This is larger than the Tiny Descr
2429     id = (instrDesc*)emitAllocInstr(SMALL_IDSC_SIZE, attr);
2430     id->idSetIsSmallDsc();
2431
2432     return id;
2433 }
2434
2435 inline emitter::instrDesc* emitter::emitNewInstr(emitAttr attr)
2436 {
2437     // This is larger than the Small Descr
2438     return emitAllocInstr(attr);
2439 }
2440
2441 inline emitter::instrDescJmp* emitter::emitNewInstrJmp()
2442 {
2443     return emitAllocInstrJmp();
2444 }
2445
2446 #if !defined(_TARGET_ARM64_)
2447 inline emitter::instrDescLbl* emitter::emitNewInstrLbl()
2448 {
2449     return emitAllocInstrLbl();
2450 }
2451 #endif // !_TARGET_ARM64_
2452
2453 inline emitter::instrDesc* emitter::emitNewInstrDsp(emitAttr attr, ssize_t dsp)
2454 {
2455     if (dsp == 0)
2456     {
2457         instrDesc* id = emitAllocInstr(attr);
2458
2459 #if EMITTER_STATS
2460         emitSmallDspCnt++;
2461 #endif
2462
2463         return id;
2464     }
2465     else
2466     {
2467         instrDescDsp* id = emitAllocInstrDsp(attr);
2468
2469         id->idSetIsLargeDsp();
2470         id->iddDspVal = dsp;
2471
2472 #if EMITTER_STATS
2473         emitLargeDspCnt++;
2474 #endif
2475
2476         return id;
2477     }
2478 }
2479
2480 /*****************************************************************************
2481  *
2482  *  Allocate an instruction descriptor for an instruction with a constant operand.
2483  *  The instruction descriptor uses the idAddrUnion to save additional info
2484  *  so the smallest size that this can be is sizeof(instrDesc).
2485  *  Note that this very similar to emitter::emitNewInstrSC(), except it never
2486  *  allocates a small descriptor.
2487  */
2488 inline emitter::instrDesc* emitter::emitNewInstrCns(emitAttr attr, ssize_t cns)
2489 {
2490     if (instrDesc::fitsInSmallCns(cns))
2491     {
2492         instrDesc* id = emitAllocInstr(attr);
2493
2494         id->idSmallCns(cns);
2495
2496 #if EMITTER_STATS
2497         emitSmallCnsCnt++;
2498         if (cns - ID_MIN_SMALL_CNS >= SMALL_CNS_TSZ)
2499             emitSmallCns[SMALL_CNS_TSZ - 1]++;
2500         else
2501             emitSmallCns[cns - ID_MIN_SMALL_CNS]++;
2502 #endif
2503
2504         return id;
2505     }
2506     else
2507     {
2508         instrDescCns* id = emitAllocInstrCns(attr);
2509
2510         id->idSetIsLargeCns();
2511         id->idcCnsVal = cns;
2512
2513 #if EMITTER_STATS
2514         emitLargeCnsCnt++;
2515 #endif
2516
2517         return id;
2518     }
2519 }
2520
2521 /*****************************************************************************
2522  *
2523  *  Get the instrDesc size, general purpose version
2524  *
2525  */
2526
2527 inline size_t emitter::emitGetInstrDescSize(const instrDesc* id)
2528 {
2529     if (id->idIsTiny())
2530     {
2531         return TINY_IDSC_SIZE;
2532     }
2533
2534     if (id->idIsSmallDsc())
2535     {
2536         return SMALL_IDSC_SIZE;
2537     }
2538
2539     if (id->idIsLargeCns())
2540     {
2541         return sizeof(instrDescCns);
2542     }
2543
2544     return sizeof(instrDesc);
2545 }
2546
2547 /*****************************************************************************
2548  *
2549  *  Allocate an instruction descriptor for an instruction with a small integer
2550  *  constant operand. This is the same as emitNewInstrCns() except that here
2551  *  any constant that is small enough for instrDesc::fitsInSmallCns() only gets
2552  *  allocated SMALL_IDSC_SIZE bytes (and is thus a small descriptor, whereas
2553  *  emitNewInstrCns() always allocates at least sizeof(instrDesc).
2554  */
2555
2556 inline emitter::instrDesc* emitter::emitNewInstrSC(emitAttr attr, ssize_t cns)
2557 {
2558     instrDesc* id;
2559
2560     if (instrDesc::fitsInSmallCns(cns))
2561     {
2562         id = (instrDesc*)emitAllocInstr(SMALL_IDSC_SIZE, attr);
2563
2564         id->idSmallCns(cns);
2565         id->idSetIsSmallDsc();
2566     }
2567     else
2568     {
2569         id = (instrDesc*)emitAllocInstr(sizeof(instrDescCns), attr);
2570
2571         id->idSetIsLargeCns();
2572         ((instrDescCns*)id)->idcCnsVal = cns;
2573     }
2574
2575     return id;
2576 }
2577
2578 /*****************************************************************************
2579  *
2580  *  Get the instrDesc size for something that contains a constant
2581  */
2582
2583 inline size_t emitter::emitGetInstrDescSizeSC(const instrDesc* id)
2584 {
2585     if (id->idIsSmallDsc())
2586     {
2587         return SMALL_IDSC_SIZE;
2588     }
2589     else if (id->idIsLargeCns())
2590     {
2591         return sizeof(instrDescCns);
2592     }
2593     else
2594     {
2595         return sizeof(instrDesc);
2596     }
2597 }
2598
2599 /*****************************************************************************
2600  *
2601  *  The following helpers should be used to access the various values that
2602  *  get stored in different places within the instruction descriptor.
2603  */
2604
2605 inline ssize_t emitter::emitGetInsCns(instrDesc* id)
2606 {
2607     return id->idIsLargeCns() ? ((instrDescCns*)id)->idcCnsVal : id->idSmallCns();
2608 }
2609
2610 inline ssize_t emitter::emitGetInsDsp(instrDesc* id)
2611 {
2612     if (id->idIsLargeDsp())
2613     {
2614         if (id->idIsLargeCns())
2615         {
2616             return ((instrDescCnsDsp*)id)->iddcDspVal;
2617         }
2618         return ((instrDescDsp*)id)->iddDspVal;
2619     }
2620     return 0;
2621 }
2622
2623 inline ssize_t emitter::emitGetInsCnsDsp(instrDesc* id, ssize_t* dspPtr)
2624 {
2625     if (id->idIsLargeCns())
2626     {
2627         if (id->idIsLargeDsp())
2628         {
2629             *dspPtr = ((instrDescCnsDsp*)id)->iddcDspVal;
2630             return ((instrDescCnsDsp*)id)->iddcCnsVal;
2631         }
2632         else
2633         {
2634             *dspPtr = 0;
2635             return ((instrDescCns*)id)->idcCnsVal;
2636         }
2637     }
2638     else
2639     {
2640         if (id->idIsLargeDsp())
2641         {
2642             *dspPtr = ((instrDescDsp*)id)->iddDspVal;
2643             return id->idSmallCns();
2644         }
2645         else
2646         {
2647             *dspPtr = 0;
2648             return id->idSmallCns();
2649         }
2650     }
2651 }
2652
2653 /*****************************************************************************
2654  *
2655  *  Get hold of the argument count for an indirect call.
2656  */
2657
2658 inline unsigned emitter::emitGetInsCIargs(instrDesc* id)
2659 {
2660     if (id->idIsLargeCall())
2661     {
2662         return ((instrDescCGCA*)id)->idcArgCnt;
2663     }
2664     else
2665     {
2666         assert(id->idIsLargeDsp() == false);
2667         assert(id->idIsLargeCns() == false);
2668
2669         ssize_t cns = emitGetInsCns(id);
2670         assert((unsigned)cns == (size_t)cns);
2671         return (unsigned)cns;
2672     }
2673 }
2674
2675 /*****************************************************************************
2676  *
2677  *  Returns true if the given register contains a live GC ref.
2678  */
2679
2680 inline GCtype emitter::emitRegGCtype(regNumber reg)
2681 {
2682     assert(emitIssuing);
2683
2684     if ((emitThisGCrefRegs & genRegMask(reg)) != 0)
2685     {
2686         return GCT_GCREF;
2687     }
2688     else if ((emitThisByrefRegs & genRegMask(reg)) != 0)
2689     {
2690         return GCT_BYREF;
2691     }
2692     else
2693     {
2694         return GCT_NONE;
2695     }
2696 }
2697
2698 #ifdef DEBUG
2699
2700 #if EMIT_TRACK_STACK_DEPTH
2701 #define CHECK_STACK_DEPTH() assert((int)emitCurStackLvl >= 0)
2702 #else
2703 #define CHECK_STACK_DEPTH()
2704 #endif
2705
2706 #endif // DEBUG
2707
2708 /*****************************************************************************
2709  *
2710  *  Return true when a given code offset is properly aligned for the target
2711  */
2712
2713 inline bool IsCodeAligned(UNATIVE_OFFSET offset)
2714 {
2715     return ((offset & (CODE_ALIGN - 1)) == 0);
2716 }
2717
2718 // Static:
2719 inline BYTE* emitter::emitCodeWithInstructionSize(BYTE* codePtrBefore, BYTE* newCodePointer, unsigned char* instrSize)
2720 {
2721     // DLD: Perhaps this method should return the instruction size, and we should do dst += <that size>
2722     // as is done in other cases?
2723     assert(newCodePointer >= codePtrBefore);
2724     ClrSafeInt<unsigned char> callInstrSizeSafe = ClrSafeInt<unsigned char>(newCodePointer - codePtrBefore);
2725     assert(!callInstrSizeSafe.IsOverflow());
2726     *instrSize = callInstrSizeSafe.Value();
2727     return newCodePointer;
2728 }
2729
2730 /*****************************************************************************
2731  *
2732  *  Add a new IG to the current list, and get it ready to receive code.
2733  */
2734
2735 inline void emitter::emitNewIG()
2736 {
2737     insGroup* ig = emitAllocAndLinkIG();
2738
2739     /* It's linked in. Now, set it up to accept code */
2740
2741     emitGenIG(ig);
2742 }
2743
2744 #if !defined(JIT32_GCENCODER)
2745 // Start a new instruction group that is not interruptable
2746 inline void emitter::emitDisableGC()
2747 {
2748     emitNoGCIG = true;
2749
2750     if (emitCurIGnonEmpty())
2751     {
2752         emitNxtIG(true);
2753     }
2754     else
2755     {
2756         emitCurIG->igFlags |= IGF_NOGCINTERRUPT;
2757     }
2758 }
2759
2760 // Start a new instruction group that is interruptable
2761 inline void emitter::emitEnableGC()
2762 {
2763     emitNoGCIG = false;
2764
2765     // The next time an instruction needs to be generated, force a new instruction group.
2766     // It will be an emitAdd group in that case. Note that the next thing we see might be
2767     // a label, which will force a non-emitAdd group.
2768     //
2769     // Note that we can't just create a new instruction group here, because we don't know
2770     // if there are going to be any instructions added to it, and we don't support empty
2771     // instruction groups.
2772     emitForceNewIG = true;
2773 }
2774 #endif // !defined(JIT32_GCENCODER)
2775
2776 /*****************************************************************************/
2777 #endif // _EMIT_H_
2778 /*****************************************************************************/