src/jit/compiler.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 /*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7 XX                                                                           XX
   8 XX                           Compiler                                        XX
   9 XX                                                                           XX
  10 XX  Represents the method data we are currently JIT-compiling.               XX
  11 XX  An instance of this class is created for every method we JIT.            XX
  12 XX  This contains all the info needed for the method. So allocating a        XX
  13 XX  a new instance per method makes it thread-safe.                          XX
  14 XX  It should be used to do all the memory management for the compiler run.  XX
  15 XX                                                                           XX
  16 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  17 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  18 */
  19
  20 /*****************************************************************************/
  21 #ifndef _COMPILER_H_
  22 #define _COMPILER_H_
  23 /*****************************************************************************/
  24
  25 #include "jit.h"
  26 #include "opcode.h"
  27 #include "varset.h"
  28 #include "gentree.h"
  29 #include "lir.h"
  30 #include "block.h"
  31 #include "inline.h"
  32 #include "jiteh.h"
  33 #include "instr.h"
  34 #include "regalloc.h"
  35 #include "sm.h"
  36 #include "simplerhash.h"
  37 #include "cycletimer.h"
  38 #include "blockset.h"
  39 #include "jitstd.h"
  40 #include "arraystack.h"
  41 #include "hashbv.h"
  42 #include "fp.h"
  43 #include "expandarray.h"
  44 #include "tinyarray.h"
  45 #include "valuenum.h"
  46 #include "reglist.h"
  47 #include "jittelemetry.h"
  48 #ifdef LATE_DISASM
  49 #include "disasm.h"
  50 #endif
  51
  52 #include "codegeninterface.h"
  53 #include "regset.h"
  54 #include "jitgcinfo.h"
  55
  56 #if DUMP_GC_TABLES && defined(JIT32_GCENCODER)
  57 #include "gcdump.h"
  58 #endif
  59
  60 #include "emit.h"
  61
  62 #include "simd.h"
  63
  64 // This is only used locally in the JIT to indicate that
  65 // a verification block should be inserted
  66 #define SEH_VERIFICATION_EXCEPTION 0xe0564552 // VER
  67
  68 /*****************************************************************************
  69  *                  Forward declarations
  70  */
  71
  72 struct InfoHdr;            // defined in GCInfo.h
  73 struct escapeMapping_t;    // defined in flowgraph.cpp
  74 class emitter;             // defined in emit.h
  75 struct ShadowParamVarInfo; // defined in GSChecks.cpp
  76 struct InitVarDscInfo;     // defined in register_arg_convention.h
  77 class FgStack;             // defined in flowgraph.cpp
  78 #if FEATURE_STACK_FP_X87
  79 struct FlatFPStateX87; // defined in fp.h
  80 #endif
  81 #if FEATURE_ANYCSE
  82 class CSE_DataFlow; // defined in OptCSE.cpp
  83 #endif
  84 #ifdef DEBUG
  85 struct IndentStack;
  86 #endif
  87
  88 #ifndef LEGACY_BACKEND
  89 class Lowering; // defined in lower.h
  90 #endif
  91
  92 // The following are defined in this file, Compiler.h
  93
  94 class Compiler;
  95
  96 /*****************************************************************************
  97  *                  Unwind info
  98  */
  99
 100 #include "unwind.h"
 101
 102 /*****************************************************************************/
 103
 104 //
 105 // Declare global operator new overloads that use the Compiler::compGetMem() function for allocation.
 106 //
 107
 108 // Or the more-general IAllocator interface.
 109 void* __cdecl operator new(size_t n, IAllocator* alloc);
 110 void* __cdecl operator new[](size_t n, IAllocator* alloc);
 111
 112 // I wanted to make the second argument optional, with default = CMK_Unknown, but that
 113 // caused these to be ambiguous with the global placement new operators.
 114 void* __cdecl operator new(size_t n, Compiler* context, CompMemKind cmk);
 115 void* __cdecl operator new[](size_t n, Compiler* context, CompMemKind cmk);
 116 void* __cdecl operator new(size_t n, void* p, const jitstd::placement_t& syntax_difference);
 117
 118 // Requires the definitions of "operator new" so including "LoopCloning.h" after the definitions.
 119 #include "loopcloning.h"
 120
 121 /*****************************************************************************/
 122
 123 /* This is included here and not earlier as it needs the definition of "CSE"
 124  * which is defined in the section above */
 125
 126 /*****************************************************************************/
 127
 128 unsigned genLog2(unsigned value);
 129 unsigned genLog2(unsigned __int64 value);
 130
 131 var_types genActualType(var_types type);
 132 var_types genUnsignedType(var_types type);
 133 var_types genSignedType(var_types type);
 134
 135 unsigned ReinterpretHexAsDecimal(unsigned);
 136
 137 /*****************************************************************************/
 138
 139 #ifdef FEATURE_SIMD
 140 #ifdef FEATURE_AVX_SUPPORT
 141 const unsigned TEMP_MAX_SIZE = YMM_REGSIZE_BYTES;
 142 #else  // !FEATURE_AVX_SUPPORT
 143 const unsigned TEMP_MAX_SIZE = XMM_REGSIZE_BYTES;
 144 #endif // !FEATURE_AVX_SUPPORT
 145 #else  // !FEATURE_SIMD
 146 const unsigned TEMP_MAX_SIZE = sizeof(double);
 147 #endif // !FEATURE_SIMD
 148 const unsigned TEMP_SLOT_COUNT = (TEMP_MAX_SIZE / sizeof(int));
 149
 150 const unsigned FLG_CCTOR = (CORINFO_FLG_CONSTRUCTOR | CORINFO_FLG_STATIC);
 151
 152 #ifdef DEBUG
 153 const int BAD_STK_OFFS = 0xBAADF00D; // for LclVarDsc::lvStkOffs
 154 #endif
 155
 156 // The following holds the Local var info (scope information)
 157 typedef const char* VarName; // Actual ASCII string
 158 struct VarScopeDsc
 159 {
 160     IL_OFFSET vsdLifeBeg; // instr offset of beg of life
 161     IL_OFFSET vsdLifeEnd; // instr offset of end of life
 162     unsigned  vsdVarNum;  // (remapped) LclVarDsc number
 163
 164 #ifdef DEBUG
 165     VarName vsdName; // name of the var
 166 #endif
 167
 168     unsigned vsdLVnum; // 'which' in eeGetLVinfo().
 169                        // Also, it is the index of this entry in the info.compVarScopes array,
 170                        // which is useful since the array is also accessed via the
 171                        // compEnterScopeList and compExitScopeList sorted arrays.
 172 };
 173
 174 /*****************************************************************************
 175  *
 176  *  The following holds the local variable counts and the descriptor table.
 177  */
 178
 179 // This is the location of a definition.
 180 struct DefLoc
 181 {
 182     BasicBlock* m_blk;
 183     GenTreePtr  m_tree;
 184
 185     DefLoc() : m_blk(nullptr), m_tree(nullptr)
 186     {
 187     }
 188 };
 189
 190 // This class encapsulates all info about a local variable that may vary for different SSA names
 191 // in the family.
 192 class LclSsaVarDsc
 193 {
 194 public:
 195     ValueNumPair m_vnPair;
 196     DefLoc       m_defLoc;
 197
 198     LclSsaVarDsc()
 199     {
 200     }
 201 };
 202
 203 typedef ExpandArray<LclSsaVarDsc> PerSsaArray;
 204
 205 class LclVarDsc
 206 {
 207 public:
 208     // The constructor. Most things can just be zero'ed.
 209     LclVarDsc(Compiler* comp);
 210
 211     // note this only packs because var_types is a typedef of unsigned char
 212     var_types lvType : 5; // TYP_INT/LONG/FLOAT/DOUBLE/REF
 213
 214     unsigned char lvIsParam : 1;           // is this a parameter?
 215     unsigned char lvIsRegArg : 1;          // is this a register argument?
 216     unsigned char lvFramePointerBased : 1; // 0 = off of REG_SPBASE (e.g., ESP), 1 = off of REG_FPBASE (e.g., EBP)
 217
 218     unsigned char lvStructGcCount : 3; // if struct, how many GC pointer (stop counting at 7). The only use of values >1
 219                                        // is to help determine whether to use block init in the prolog.
 220     unsigned char lvOnFrame : 1;       // (part of) the variable lives on the frame
 221     unsigned char lvDependReg : 1;     // did the predictor depend upon this being enregistered
 222     unsigned char lvRegister : 1;      // assigned to live in a register? For RyuJIT backend, this is only set if the
 223                                        // variable is in the same register for the entire function.
 224     unsigned char lvTracked : 1;       // is this a tracked variable?
 225     bool          lvTrackedNonStruct()
 226     {
 227         return lvTracked && lvType != TYP_STRUCT;
 228     }
 229     unsigned char lvPinned : 1; // is this a pinned variable?
 230
 231     unsigned char lvMustInit : 1;    // must be initialized
 232     unsigned char lvAddrExposed : 1; // The address of this variable is "exposed" -- passed as an argument, stored in a
 233                                      // global location, etc.
 234                                      // We cannot reason reliably about the value of the variable.
 235     unsigned char lvDoNotEnregister : 1; // Do not enregister this variable.
 236     unsigned char lvFieldAccessed : 1;   // The var is a struct local, and a field of the variable is accessed.  Affects
 237                                          // struct promotion.
 238
 239 #ifdef DEBUG
 240     // These further document the reasons for setting "lvDoNotEnregister".  (Note that "lvAddrExposed" is one of the
 241     // reasons;
 242     // also, lvType == TYP_STRUCT prevents enregistration.  At least one of the reasons should be true.
 243     unsigned char lvVMNeedsStackAddr : 1; // The VM may have access to a stack-relative address of the variable, and
 244                                           // read/write its value.
 245     unsigned char lvLiveInOutOfHndlr : 1; // The variable was live in or out of an exception handler, and this required
 246                                           // the variable to be
 247                                           // in the stack (at least at those boundaries.)
 248     unsigned char lvLclFieldExpr : 1;     // The variable is not a struct, but was accessed like one (e.g., reading a
 249                                           // particular byte from an int).
 250     unsigned char lvLclBlockOpAddr : 1;   // The variable was written to via a block operation that took its address.
 251     unsigned char lvLiveAcrossUCall : 1;  // The variable is live across an unmanaged call.
 252 #endif
 253     unsigned char lvIsCSE : 1;       // Indicates if this LclVar is a CSE variable.
 254     unsigned char lvRefAssign : 1;   // involved in pointer assignment
 255     unsigned char lvHasLdAddrOp : 1; // has ldloca or ldarga opcode on this local.
 256     unsigned char lvStackByref : 1;  // This is a compiler temporary of TYP_BYREF that is known to point into our local
 257                                      // stack frame.
 258
 259     unsigned char lvHasILStoreOp : 1;         // there is at least one STLOC or STARG on this local
 260     unsigned char lvHasMultipleILStoreOp : 1; // there is more than one STLOC on this local
 261
 262     unsigned char lvIsTemp : 1; // Short-lifetime compiler temp (if lvIsParam is false), or implicit byref parameter
 263                                 // (if lvIsParam is true)
 264 #if OPT_BOOL_OPS
 265     unsigned char lvIsBoolean : 1; // set if variable is boolean
 266 #endif
 267     unsigned char lvRngOptDone : 1; // considered for range check opt?
 268     unsigned char lvLoopInc : 1;    // incremented in the loop?
 269     unsigned char lvLoopAsg : 1;    // reassigned  in the loop (other than a monotonic inc/dec for the index var)?
 270     unsigned char lvArrIndx : 1;    // used as an array index?
 271     unsigned char lvArrIndxOff : 1; // used as an array index with an offset?
 272     unsigned char lvArrIndxDom : 1; // index dominates loop exit
 273 #if ASSERTION_PROP
 274     unsigned char lvSingleDef : 1;    // variable has a single def
 275     unsigned char lvDisqualify : 1;   // variable is no longer OK for add copy optimization
 276     unsigned char lvVolatileHint : 1; // hint for AssertionProp
 277 #endif
 278
 279     unsigned char lvSpilled : 1; // enregistered variable was spilled
 280 #ifndef _TARGET_64BIT_
 281     unsigned char lvStructDoubleAlign : 1; // Must we double align this struct?
 282 #endif                                     // !_TARGET_64BIT_
 283 #ifdef _TARGET_64BIT_
 284     unsigned char lvQuirkToLong : 1; // Quirk to allocate this LclVar as a 64-bit long
 285 #endif
 286 #ifdef DEBUG
 287     unsigned char lvKeepType : 1;       // Don't change the type of this variable
 288     unsigned char lvNoLclFldStress : 1; // Can't apply local field stress on this one
 289 #endif
 290     unsigned char lvIsPtr : 1; // Might this be used in an address computation? (used by buffer overflow security
 291                                // checks)
 292     unsigned char lvIsUnsafeBuffer : 1; // Does this contain an unsafe buffer requiring buffer overflow security checks?
 293     unsigned char lvPromoted : 1; // True when this local is a promoted struct, a normed struct, or a "split" long on a
 294                                   // 32-bit target.  For implicit byref parameters, this gets hijacked between
 295                                   // fgRetypeImplicitByRefArgs and fgMarkDemotedImplicitByRefArgs to indicate whether
 296                                   // references to the arg are being rewritten as references to a promoted shadow local.
 297     unsigned char lvIsStructField : 1;          // Is this local var a field of a promoted struct local?
 298     unsigned char lvContainsFloatingFields : 1; // Does this struct contains floating point fields?
 299     unsigned char lvOverlappingFields : 1;      // True when we have a struct with possibly overlapping fields
 300     unsigned char lvContainsHoles : 1;          // True when we have a promoted struct that contains holes
 301     unsigned char lvCustomLayout : 1;           // True when this struct has "CustomLayout"
 302
 303     unsigned char lvIsMultiRegArg : 1; // true if this is a multireg LclVar struct used in an argument context
 304     unsigned char lvIsMultiRegRet : 1; // true if this is a multireg LclVar struct assigned from a multireg call
 305
 306 #ifdef FEATURE_HFA
 307     unsigned char _lvIsHfa : 1;          // Is this a struct variable who's class handle is an HFA type
 308     unsigned char _lvIsHfaRegArg : 1;    // Is this a HFA argument variable?    // TODO-CLEANUP: Remove this and replace
 309                                          // with (lvIsRegArg && lvIsHfa())
 310     unsigned char _lvHfaTypeIsFloat : 1; // Is the HFA type float or double?
 311 #endif                                   // FEATURE_HFA
 312
 313 #ifdef DEBUG
 314     // TODO-Cleanup: See the note on lvSize() - this flag is only in use by asserts that are checking for struct
 315     // types, and is needed because of cases where TYP_STRUCT is bashed to an integral type.
 316     // Consider cleaning this up so this workaround is not required.
 317     unsigned char lvUnusedStruct : 1; // All references to this promoted struct are through its field locals.
 318                                       // I.e. there is no longer any reference to the struct directly.
 319                                       // In this case we can simply remove this struct local.
 320 #endif
 321 #ifndef LEGACY_BACKEND
 322     unsigned char lvLRACandidate : 1; // Tracked for linear scan register allocation purposes
 323 #endif                                // !LEGACY_BACKEND
 324
 325 #ifdef FEATURE_SIMD
 326     // Note that both SIMD vector args and locals are marked as lvSIMDType = true, but the
 327     // type of an arg node is TYP_BYREF and a local node is TYP_SIMD*.
 328     unsigned char lvSIMDType : 1;            // This is a SIMD struct
 329     unsigned char lvUsedInSIMDIntrinsic : 1; // This tells lclvar is used for simd intrinsic
 330     var_types     lvBaseType : 5;            // Note: this only packs because var_types is a typedef of unsigned char
 331 #endif                                       // FEATURE_SIMD
 332     unsigned char lvRegStruct : 1;           // This is a reg-sized non-field-addressed struct.
 333
 334     unsigned char lvClassIsExact : 1; // lvClassHandle is the exact type
 335
 336 #ifdef DEBUG
 337     unsigned char lvClassInfoUpdated : 1; // true if this var has updated class handle or exactness
 338 #endif
 339
 340     union {
 341         unsigned lvFieldLclStart; // The index of the local var representing the first field in the promoted struct
 342                                   // local.  For implicit byref parameters, this gets hijacked between
 343                                   // fgRetypeImplicitByRefArgs and fgMarkDemotedImplicitByRefArgs to point to the
 344                                   // struct local created to model the parameter's struct promotion, if any.
 345         unsigned lvParentLcl; // The index of the local var representing the parent (i.e. the promoted struct local).
 346                               // Valid on promoted struct local fields.
 347     };
 348
 349     unsigned char lvFieldCnt; //  Number of fields in the promoted VarDsc.
 350     unsigned char lvFldOffset;
 351     unsigned char lvFldOrdinal;
 352
 353 #if FEATURE_MULTIREG_ARGS
 354     regNumber lvRegNumForSlot(unsigned slotNum)
 355     {
 356         if (slotNum == 0)
 357         {
 358             return lvArgReg;
 359         }
 360         else if (slotNum == 1)
 361         {
 362             return lvOtherArgReg;
 363         }
 364         else
 365         {
 366             assert(false && "Invalid slotNum!");
 367         }
 368
 369         unreached();
 370     }
 371 #endif // FEATURE_MULTIREG_ARGS
 372
 373     bool lvIsHfa() const
 374     {
 375 #ifdef FEATURE_HFA
 376         return _lvIsHfa;
 377 #else
 378         return false;
 379 #endif
 380     }
 381
 382     void lvSetIsHfa()
 383     {
 384 #ifdef FEATURE_HFA
 385         _lvIsHfa = true;
 386 #endif
 387     }
 388
 389     bool lvIsHfaRegArg() const
 390     {
 391 #ifdef FEATURE_HFA
 392         return _lvIsHfaRegArg;
 393 #else
 394         return false;
 395 #endif
 396     }
 397
 398     void lvSetIsHfaRegArg(bool value = true)
 399     {
 400 #ifdef FEATURE_HFA
 401         _lvIsHfaRegArg = value;
 402 #endif
 403     }
 404
 405     bool lvHfaTypeIsFloat() const
 406     {
 407 #ifdef FEATURE_HFA
 408         return _lvHfaTypeIsFloat;
 409 #else
 410         return false;
 411 #endif
 412     }
 413
 414     void lvSetHfaTypeIsFloat(bool value)
 415     {
 416 #ifdef FEATURE_HFA
 417         _lvHfaTypeIsFloat = value;
 418 #endif
 419     }
 420
 421     // on Arm64 - Returns 1-4 indicating the number of register slots used by the HFA
 422     // on Arm32 - Returns the total number of single FP register slots used by the HFA, max is 8
 423     //
 424     unsigned lvHfaSlots() const
 425     {
 426         assert(lvIsHfa());
 427         assert(lvType == TYP_STRUCT);
 428 #ifdef _TARGET_ARM_
 429         return lvExactSize / sizeof(float);
 430 #else  //  _TARGET_ARM64_
 431         if (lvHfaTypeIsFloat())
 432         {
 433             return lvExactSize / sizeof(float);
 434         }
 435         else
 436         {
 437             return lvExactSize / sizeof(double);
 438         }
 439 #endif //  _TARGET_ARM64_
 440     }
 441
 442     // lvIsMultiRegArgOrRet()
 443     //     returns true if this is a multireg LclVar struct used in an argument context
 444     //               or if this is a multireg LclVar struct assigned from a multireg call
 445     bool lvIsMultiRegArgOrRet()
 446     {
 447         return lvIsMultiRegArg || lvIsMultiRegRet;
 448     }
 449
 450 private:
 451     regNumberSmall _lvRegNum; // Used to store the register this variable is in (or, the low register of a
 452                               // register pair). For LEGACY_BACKEND, this is only set if lvRegister is
 453                               // non-zero. For non-LEGACY_BACKEND, it is set during codegen any time the
 454                               // variable is enregistered (in non-LEGACY_BACKEND, lvRegister is only set
 455                               // to non-zero if the variable gets the same register assignment for its entire
 456                               // lifetime).
 457 #if !defined(_TARGET_64BIT_)
 458     regNumberSmall _lvOtherReg; // Used for "upper half" of long var.
 459 #endif                          // !defined(_TARGET_64BIT_)
 460
 461     regNumberSmall _lvArgReg; // The register in which this argument is passed.
 462
 463 #if FEATURE_MULTIREG_ARGS
 464     regNumberSmall _lvOtherArgReg; // Used for the second part of the struct passed in a register.
 465                                    // Note this is defined but not used by ARM32
 466 #endif                             // FEATURE_MULTIREG_ARGS
 467
 468 #ifndef LEGACY_BACKEND
 469     union {
 470         regNumberSmall _lvArgInitReg;     // the register      into which the argument is moved at entry
 471         regPairNoSmall _lvArgInitRegPair; // the register pair into which the argument is moved at entry
 472     };
 473 #endif // !LEGACY_BACKEND
 474
 475 public:
 476     // The register number is stored in a small format (8 bits), but the getters return and the setters take
 477     // a full-size (unsigned) format, to localize the casts here.
 478
 479     /////////////////////
 480
 481     __declspec(property(get = GetRegNum, put = SetRegNum)) regNumber lvRegNum;
 482
 483     regNumber GetRegNum() const
 484     {
 485         return (regNumber)_lvRegNum;
 486     }
 487
 488     void SetRegNum(regNumber reg)
 489     {
 490         _lvRegNum = (regNumberSmall)reg;
 491         assert(_lvRegNum == reg);
 492     }
 493
 494 /////////////////////
 495
 496 #if defined(_TARGET_64BIT_)
 497     __declspec(property(get = GetOtherReg, put = SetOtherReg)) regNumber lvOtherReg;
 498
 499     regNumber GetOtherReg() const
 500     {
 501         assert(!"shouldn't get here"); // can't use "unreached();" because it's NORETURN, which causes C4072
 502                                        // "unreachable code" warnings
 503         return REG_NA;
 504     }
 505
 506     void SetOtherReg(regNumber reg)
 507     {
 508         assert(!"shouldn't get here"); // can't use "unreached();" because it's NORETURN, which causes C4072
 509                                        // "unreachable code" warnings
 510     }
 511 #else  // !_TARGET_64BIT_
 512     __declspec(property(get = GetOtherReg, put = SetOtherReg)) regNumber lvOtherReg;
 513
 514     regNumber GetOtherReg() const
 515     {
 516         return (regNumber)_lvOtherReg;
 517     }
 518
 519     void SetOtherReg(regNumber reg)
 520     {
 521         _lvOtherReg = (regNumberSmall)reg;
 522         assert(_lvOtherReg == reg);
 523     }
 524 #endif // !_TARGET_64BIT_
 525
 526     /////////////////////
 527
 528     __declspec(property(get = GetArgReg, put = SetArgReg)) regNumber lvArgReg;
 529
 530     regNumber GetArgReg() const
 531     {
 532         return (regNumber)_lvArgReg;
 533     }
 534
 535     void SetArgReg(regNumber reg)
 536     {
 537         _lvArgReg = (regNumberSmall)reg;
 538         assert(_lvArgReg == reg);
 539     }
 540
 541 #if FEATURE_MULTIREG_ARGS
 542     __declspec(property(get = GetOtherArgReg, put = SetOtherArgReg)) regNumber lvOtherArgReg;
 543
 544     regNumber GetOtherArgReg() const
 545     {
 546         return (regNumber)_lvOtherArgReg;
 547     }
 548
 549     void SetOtherArgReg(regNumber reg)
 550     {
 551         _lvOtherArgReg = (regNumberSmall)reg;
 552         assert(_lvOtherArgReg == reg);
 553     }
 554 #endif // FEATURE_MULTIREG_ARGS
 555
 556 #ifdef FEATURE_SIMD
 557     // Is this is a SIMD struct?
 558     bool lvIsSIMDType() const
 559     {
 560         return lvSIMDType;
 561     }
 562
 563     // Is this is a SIMD struct which is used for SIMD intrinsic?
 564     bool lvIsUsedInSIMDIntrinsic() const
 565     {
 566         return lvUsedInSIMDIntrinsic;
 567     }
 568 #else
 569     // If feature_simd not enabled, return false
 570     bool lvIsSIMDType() const
 571     {
 572         return false;
 573     }
 574     bool lvIsUsedInSIMDIntrinsic() const
 575     {
 576         return false;
 577     }
 578 #endif
 579
 580 /////////////////////
 581
 582 #ifndef LEGACY_BACKEND
 583     __declspec(property(get = GetArgInitReg, put = SetArgInitReg)) regNumber lvArgInitReg;
 584
 585     regNumber GetArgInitReg() const
 586     {
 587         return (regNumber)_lvArgInitReg;
 588     }
 589
 590     void SetArgInitReg(regNumber reg)
 591     {
 592         _lvArgInitReg = (regNumberSmall)reg;
 593         assert(_lvArgInitReg == reg);
 594     }
 595
 596     /////////////////////
 597
 598     __declspec(property(get = GetArgInitRegPair, put = SetArgInitRegPair)) regPairNo lvArgInitRegPair;
 599
 600     regPairNo GetArgInitRegPair() const
 601     {
 602         regPairNo regPair = (regPairNo)_lvArgInitRegPair;
 603         assert(regPair >= REG_PAIR_FIRST && regPair <= REG_PAIR_LAST);
 604         return regPair;
 605     }
 606
 607     void SetArgInitRegPair(regPairNo regPair)
 608     {
 609         assert(regPair >= REG_PAIR_FIRST && regPair <= REG_PAIR_LAST);
 610         _lvArgInitRegPair = (regPairNoSmall)regPair;
 611         assert(_lvArgInitRegPair == regPair);
 612     }
 613
 614     /////////////////////
 615
 616     bool lvIsRegCandidate() const
 617     {
 618         return lvLRACandidate != 0;
 619     }
 620
 621     bool lvIsInReg() const
 622     {
 623         return lvIsRegCandidate() && (lvRegNum != REG_STK);
 624     }
 625
 626 #else // LEGACY_BACKEND
 627
 628     bool lvIsRegCandidate() const
 629     {
 630         return lvTracked != 0;
 631     }
 632
 633     bool lvIsInReg() const
 634     {
 635         return lvRegister != 0;
 636     }
 637
 638 #endif // LEGACY_BACKEND
 639
 640     regMaskTP lvRegMask() const
 641     {
 642         regMaskTP regMask = RBM_NONE;
 643         if (varTypeIsFloating(TypeGet()))
 644         {
 645             if (lvRegNum != REG_STK)
 646             {
 647                 regMask = genRegMaskFloat(lvRegNum, TypeGet());
 648             }
 649         }
 650         else
 651         {
 652             if (lvRegNum != REG_STK)
 653             {
 654                 regMask = genRegMask(lvRegNum);
 655             }
 656
 657             // For longs we may have two regs
 658             if (isRegPairType(lvType) && lvOtherReg != REG_STK)
 659             {
 660                 regMask |= genRegMask(lvOtherReg);
 661             }
 662         }
 663         return regMask;
 664     }
 665
 666     regMaskSmall lvPrefReg; // set of regs it prefers to live in
 667
 668     unsigned short lvVarIndex; // variable tracking index
 669     unsigned short lvRefCnt;   // unweighted (real) reference count.  For implicit by reference
 670                                // parameters, this gets hijacked from fgMarkImplicitByRefArgs
 671                                // through fgMarkDemotedImplicitByRefArgs, to provide a static
 672                                // appearance count (computed during address-exposed analysis)
 673                                // that fgMakeOutgoingStructArgCopy consults during global morph
 674                                // to determine if eliding its copy is legal.
 675     unsigned lvRefCntWtd;      // weighted reference count
 676     int      lvStkOffs;        // stack offset of home
 677     unsigned lvExactSize;      // (exact) size of the type in bytes
 678
 679     // Is this a promoted struct?
 680     // This method returns true only for structs (including SIMD structs), not for
 681     // locals that are split on a 32-bit target.
 682     // It is only necessary to use this:
 683     //   1) if only structs are wanted, and
 684     //   2) if Lowering has already been done.
 685     // Otherwise lvPromoted is valid.
 686     bool lvPromotedStruct()
 687     {
 688 #if !defined(_TARGET_64BIT_)
 689         return (lvPromoted && !varTypeIsLong(lvType));
 690 #else  // defined(_TARGET_64BIT_)
 691         return lvPromoted;
 692 #endif // defined(_TARGET_64BIT_)
 693     }
 694
 695     unsigned lvSize() const // Size needed for storage representation. Only used for structs or TYP_BLK.
 696     {
 697         // TODO-Review: Sometimes we get called on ARM with HFA struct variables that have been promoted,
 698         // where the struct itself is no longer used because all access is via its member fields.
 699         // When that happens, the struct is marked as unused and its type has been changed to
 700         // TYP_INT (to keep the GC tracking code from looking at it).
 701         // See Compiler::raAssignVars() for details. For example:
 702         //      N002 (  4,  3) [00EA067C] -------------               return    struct $346
 703         //      N001 (  3,  2) [00EA0628] -------------                  lclVar    struct(U) V03 loc2
 704         //                                                                        float  V03.f1 (offs=0x00) -> V12 tmp7
 705         //                                                                        f8 (last use) (last use) $345
 706         // Here, the "struct(U)" shows that the "V03 loc2" variable is unused. Not shown is that V03
 707         // is now TYP_INT in the local variable table. It's not really unused, because it's in the tree.
 708
 709         assert(varTypeIsStruct(lvType) || (lvType == TYP_BLK) || (lvPromoted && lvUnusedStruct));
 710
 711 #if defined(FEATURE_SIMD) && !defined(_TARGET_64BIT_)
 712         // For 32-bit architectures, we make local variable SIMD12 types 16 bytes instead of just 12. We can't do
 713         // this for arguments, which must be passed according the defined ABI. We don't want to do this for
 714         // dependently promoted struct fields, but we don't know that here. See lvaMapSimd12ToSimd16().
 715         if ((lvType == TYP_SIMD12) && !lvIsParam)
 716         {
 717             assert(lvExactSize == 12);
 718             return 16;
 719         }
 720 #endif // defined(FEATURE_SIMD) && !defined(_TARGET_64BIT_)
 721
 722         return (unsigned)(roundUp(lvExactSize, TARGET_POINTER_SIZE));
 723     }
 724
 725     const size_t lvArgStackSize() const;
 726
 727     unsigned lvSlotNum; // original slot # (if remapped)
 728
 729     typeInfo lvVerTypeInfo; // type info needed for verification
 730
 731     CORINFO_CLASS_HANDLE lvClassHnd; // class handle for the local, or null if not known
 732
 733     CORINFO_FIELD_HANDLE lvFieldHnd; // field handle for promoted struct fields
 734
 735     BYTE* lvGcLayout; // GC layout info for structs
 736
 737 #if ASSERTION_PROP
 738     BlockSet   lvRefBlks;          // Set of blocks that contain refs
 739     GenTreePtr lvDefStmt;          // Pointer to the statement with the single definition
 740     void       lvaDisqualifyVar(); // Call to disqualify a local variable from use in optAddCopies
 741 #endif
 742     var_types TypeGet() const
 743     {
 744         return (var_types)lvType;
 745     }
 746     bool lvStackAligned() const
 747     {
 748         assert(lvIsStructField);
 749         return ((lvFldOffset % sizeof(void*)) == 0);
 750     }
 751     bool lvNormalizeOnLoad() const
 752     {
 753         return varTypeIsSmall(TypeGet()) &&
 754                // lvIsStructField is treated the same as the aliased local, see fgDoNormalizeOnStore.
 755                (lvIsParam || lvAddrExposed || lvIsStructField);
 756     }
 757
 758     bool lvNormalizeOnStore()
 759     {
 760         return varTypeIsSmall(TypeGet()) &&
 761                // lvIsStructField is treated the same as the aliased local, see fgDoNormalizeOnStore.
 762                !(lvIsParam || lvAddrExposed || lvIsStructField);
 763     }
 764
 765     void lvaResetSortAgainFlag(Compiler* pComp);
 766     void decRefCnts(BasicBlock::weight_t weight, Compiler* pComp, bool propagate = true);
 767     void incRefCnts(BasicBlock::weight_t weight, Compiler* pComp, bool propagate = true);
 768     void setPrefReg(regNumber regNum, Compiler* pComp);
 769     void addPrefReg(regMaskTP regMask, Compiler* pComp);
 770     bool IsFloatRegType() const
 771     {
 772         return isFloatRegType(lvType) || lvIsHfaRegArg();
 773     }
 774     var_types GetHfaType() const
 775     {
 776         return lvIsHfa() ? (lvHfaTypeIsFloat() ? TYP_FLOAT : TYP_DOUBLE) : TYP_UNDEF;
 777     }
 778     void SetHfaType(var_types type)
 779     {
 780         assert(varTypeIsFloating(type));
 781         lvSetHfaTypeIsFloat(type == TYP_FLOAT);
 782     }
 783
 784 #ifndef LEGACY_BACKEND
 785     var_types lvaArgType();
 786 #endif
 787
 788     PerSsaArray lvPerSsaData;
 789
 790 #ifdef DEBUG
 791     // Keep track of the # of SsaNames, for a bounds check.
 792     unsigned lvNumSsaNames;
 793 #endif
 794
 795     // Returns the address of the per-Ssa data for the given ssaNum (which is required
 796     // not to be the SsaConfig::RESERVED_SSA_NUM, which indicates that the variable is
 797     // not an SSA variable).
 798     LclSsaVarDsc* GetPerSsaData(unsigned ssaNum)
 799     {
 800         assert(ssaNum != SsaConfig::RESERVED_SSA_NUM);
 801         assert(SsaConfig::RESERVED_SSA_NUM == 0);
 802         unsigned zeroBased = ssaNum - SsaConfig::UNINIT_SSA_NUM;
 803         assert(zeroBased < lvNumSsaNames);
 804         return &lvPerSsaData.GetRef(zeroBased);
 805     }
 806
 807 #ifdef DEBUG
 808 public:
 809     void PrintVarReg() const
 810     {
 811         if (isRegPairType(TypeGet()))
 812         {
 813             printf("%s:%s", getRegName(lvOtherReg), // hi32
 814                    getRegName(lvRegNum));           // lo32
 815         }
 816         else
 817         {
 818             printf("%s", getRegName(lvRegNum));
 819         }
 820     }
 821 #endif // DEBUG
 822
 823 }; // class LclVarDsc
 824
 825 /*
 826 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 827 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 828 XX                                                                           XX
 829 XX                           TempsInfo                                       XX
 830 XX                                                                           XX
 831 XX  The temporary lclVars allocated by the compiler for code generation      XX
 832 XX                                                                           XX
 833 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 834 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 835 */
 836
 837 /*****************************************************************************
 838  *
 839  *  The following keeps track of temporaries allocated in the stack frame
 840  *  during code-generation (after register allocation). These spill-temps are
 841  *  only used if we run out of registers while evaluating a tree.
 842  *
 843  *  These are different from the more common temps allocated by lvaGrabTemp().
 844  */
 845
 846 class TempDsc
 847 {
 848 public:
 849     TempDsc* tdNext;
 850
 851 private:
 852     int tdOffs;
 853 #ifdef DEBUG
 854     static const int BAD_TEMP_OFFSET = 0xDDDDDDDD; // used as a sentinel "bad value" for tdOffs in DEBUG
 855 #endif                                             // DEBUG
 856
 857     int       tdNum;
 858     BYTE      tdSize;
 859     var_types tdType;
 860
 861 public:
 862     TempDsc(int _tdNum, unsigned _tdSize, var_types _tdType) : tdNum(_tdNum), tdSize((BYTE)_tdSize), tdType(_tdType)
 863     {
 864 #ifdef DEBUG
 865         assert(tdNum <
 866                0); // temps must have a negative number (so they have a different number from all local variables)
 867         tdOffs = BAD_TEMP_OFFSET;
 868 #endif // DEBUG
 869         if (tdNum != _tdNum)
 870         {
 871             IMPL_LIMITATION("too many spill temps");
 872         }
 873     }
 874
 875 #ifdef DEBUG
 876     bool tdLegalOffset() const
 877     {
 878         return tdOffs != BAD_TEMP_OFFSET;
 879     }
 880 #endif // DEBUG
 881
 882     int tdTempOffs() const
 883     {
 884         assert(tdLegalOffset());
 885         return tdOffs;
 886     }
 887     void tdSetTempOffs(int offs)
 888     {
 889         tdOffs = offs;
 890         assert(tdLegalOffset());
 891     }
 892     void tdAdjustTempOffs(int offs)
 893     {
 894         tdOffs += offs;
 895         assert(tdLegalOffset());
 896     }
 897
 898     int tdTempNum() const
 899     {
 900         assert(tdNum < 0);
 901         return tdNum;
 902     }
 903     unsigned tdTempSize() const
 904     {
 905         return tdSize;
 906     }
 907     var_types tdTempType() const
 908     {
 909         return tdType;
 910     }
 911 };
 912
 913 // interface to hide linearscan implementation from rest of compiler
 914 class LinearScanInterface
 915 {
 916 public:
 917     virtual void doLinearScan()                                = 0;
 918     virtual void recordVarLocationsAtStartOfBB(BasicBlock* bb) = 0;
 919     virtual bool willEnregisterLocalVars() const               = 0;
 920 };
 921
 922 LinearScanInterface* getLinearScanAllocator(Compiler* comp);
 923
 924 // Information about arrays: their element type and size, and the offset of the first element.
 925 // We label GT_IND's that are array indices with GTF_IND_ARR_INDEX, and, for such nodes,
 926 // associate an array info via the map retrieved by GetArrayInfoMap().  This information is used,
 927 // for example, in value numbering of array index expressions.
 928 struct ArrayInfo
 929 {
 930     var_types            m_elemType;
 931     CORINFO_CLASS_HANDLE m_elemStructType;
 932     unsigned             m_elemSize;
 933     unsigned             m_elemOffset;
 934
 935     ArrayInfo() : m_elemType(TYP_UNDEF), m_elemStructType(nullptr), m_elemSize(0), m_elemOffset(0)
 936     {
 937     }
 938
 939     ArrayInfo(var_types elemType, unsigned elemSize, unsigned elemOffset, CORINFO_CLASS_HANDLE elemStructType)
 940         : m_elemType(elemType), m_elemStructType(elemStructType), m_elemSize(elemSize), m_elemOffset(elemOffset)
 941     {
 942     }
 943 };
 944
 945 // This enumeration names the phases into which we divide compilation.  The phases should completely
 946 // partition a compilation.
 947 enum Phases
 948 {
 949 #define CompPhaseNameMacro(enum_nm, string_nm, short_nm, hasChildren, parent, measureIR) enum_nm,
 950 #include "compphases.h"
 951     PHASE_NUMBER_OF
 952 };
 953
 954 extern const char*   PhaseNames[];
 955 extern const char*   PhaseEnums[];
 956 extern const LPCWSTR PhaseShortNames[];
 957
 958 // The following enum provides a simple 1:1 mapping to CLR API's
 959 enum API_ICorJitInfo_Names
 960 {
 961 #define DEF_CLR_API(name) API_##name,
 962 #include "ICorJitInfo_API_names.h"
 963     API_COUNT
 964 };
 965
 966 //---------------------------------------------------------------
 967 // Compilation time.
 968 //
 969
 970 // A "CompTimeInfo" is a structure for tracking the compilation time of one or more methods.
 971 // We divide a compilation into a sequence of contiguous phases, and track the total (per-thread) cycles
 972 // of the compilation, as well as the cycles for each phase.  We also track the number of bytecodes.
 973 // If there is a failure in reading a timer at any point, the "CompTimeInfo" becomes invalid, as indicated
 974 // by "m_timerFailure" being true.
 975 // If FEATURE_JIT_METHOD_PERF is not set, we define a minimal form of this, enough to let other code compile.
 976 struct CompTimeInfo
 977 {
 978 #ifdef FEATURE_JIT_METHOD_PERF
 979     // The string names of the phases.
 980     static const char* PhaseNames[];
 981
 982     static bool PhaseHasChildren[];
 983     static int  PhaseParent[];
 984     static bool PhaseReportsIRSize[];
 985
 986     unsigned         m_byteCodeBytes;
 987     unsigned __int64 m_totalCycles;
 988     unsigned __int64 m_invokesByPhase[PHASE_NUMBER_OF];
 989     unsigned __int64 m_cyclesByPhase[PHASE_NUMBER_OF];
 990 #if MEASURE_CLRAPI_CALLS
 991     unsigned __int64 m_CLRinvokesByPhase[PHASE_NUMBER_OF];
 992     unsigned __int64 m_CLRcyclesByPhase[PHASE_NUMBER_OF];
 993 #endif
 994
 995     unsigned m_nodeCountAfterPhase[PHASE_NUMBER_OF];
 996
 997     // For better documentation, we call EndPhase on
 998     // non-leaf phases.  We should also call EndPhase on the
 999     // last leaf subphase; obviously, the elapsed cycles between the EndPhase
1000     // for the last leaf subphase and the EndPhase for an ancestor should be very small.
1001     // We add all such "redundant end phase" intervals to this variable below; we print
1002     // it out in a report, so we can verify that it is, indeed, very small.  If it ever
1003     // isn't, this means that we're doing something significant between the end of the last
1004     // declared subphase and the end of its parent.
1005     unsigned __int64 m_parentPhaseEndSlop;
1006     bool             m_timerFailure;
1007
1008 #if MEASURE_CLRAPI_CALLS
1009     // The following measures the time spent inside each individual CLR API call.
1010     unsigned         m_allClrAPIcalls;
1011     unsigned         m_perClrAPIcalls[API_ICorJitInfo_Names::API_COUNT];
1012     unsigned __int64 m_allClrAPIcycles;
1013     unsigned __int64 m_perClrAPIcycles[API_ICorJitInfo_Names::API_COUNT];
1014     unsigned __int32 m_maxClrAPIcycles[API_ICorJitInfo_Names::API_COUNT];
1015 #endif // MEASURE_CLRAPI_CALLS
1016
1017     CompTimeInfo(unsigned byteCodeBytes);
1018 #endif
1019 };
1020
1021 #ifdef FEATURE_JIT_METHOD_PERF
1022
1023 #if MEASURE_CLRAPI_CALLS
1024 struct WrapICorJitInfo;
1025 #endif
1026
1027 // This class summarizes the JIT time information over the course of a run: the number of methods compiled,
1028 // and the total and maximum timings.  (These are instances of the "CompTimeInfo" type described above).
1029 // The operation of adding a single method's timing to the summary may be performed concurrently by several
1030 // threads, so it is protected by a lock.
1031 // This class is intended to be used as a singleton type, with only a single instance.
1032 class CompTimeSummaryInfo
1033 {
1034     // This lock protects the fields of all CompTimeSummaryInfo(s) (of which we expect there to be one).
1035     static CritSecObject s_compTimeSummaryLock;
1036
1037     int          m_numMethods;
1038     int          m_totMethods;
1039     CompTimeInfo m_total;
1040     CompTimeInfo m_maximum;
1041
1042     int          m_numFilteredMethods;
1043     CompTimeInfo m_filtered;
1044
1045     // This method computes the number of cycles/sec for the current machine.  The cycles are those counted
1046     // by GetThreadCycleTime; we assume that these are of equal duration, though that is not necessarily true.
1047     // If any OS interaction fails, returns 0.0.
1048     double CyclesPerSecond();
1049
1050     // This can use what ever data you want to determine if the value to be added
1051     // belongs in the filtered section (it's always included in the unfiltered section)
1052     bool IncludedInFilteredData(CompTimeInfo& info);
1053
1054 public:
1055     // This is the unique CompTimeSummaryInfo object for this instance of the runtime.
1056     static CompTimeSummaryInfo s_compTimeSummary;
1057
1058     CompTimeSummaryInfo()
1059         : m_numMethods(0), m_totMethods(0), m_total(0), m_maximum(0), m_numFilteredMethods(0), m_filtered(0)
1060     {
1061     }
1062
1063     // Assumes that "info" is a completed CompTimeInfo for a compilation; adds it to the summary.
1064     // This is thread safe.
1065     void AddInfo(CompTimeInfo& info, bool includePhases);
1066
1067     // Print the summary information to "f".
1068     // This is not thread-safe; assumed to be called by only one thread.
1069     void Print(FILE* f);
1070 };
1071
1072 // A JitTimer encapsulates a CompTimeInfo for a single compilation. It also tracks the start of compilation,
1073 // and when the current phase started.  This is intended to be part of a Compilation object.  This is
1074 // disabled (FEATURE_JIT_METHOD_PERF not defined) when FEATURE_CORECLR is set, or on non-windows platforms.
1075 //
1076 class JitTimer
1077 {
1078     unsigned __int64 m_start;         // Start of the compilation.
1079     unsigned __int64 m_curPhaseStart; // Start of the current phase.
1080 #if MEASURE_CLRAPI_CALLS
1081     unsigned __int64 m_CLRcallStart;   // Start of the current CLR API call (if any).
1082     unsigned __int64 m_CLRcallInvokes; // CLR API invokes under current outer so far
1083     unsigned __int64 m_CLRcallCycles;  // CLR API  cycles under current outer so far.
1084     int              m_CLRcallAPInum;  // The enum/index of the current CLR API call (or -1).
1085     static double    s_cyclesPerSec;   // Cached for speedier measurements
1086 #endif
1087 #ifdef DEBUG
1088     Phases m_lastPhase; // The last phase that was completed (or (Phases)-1 to start).
1089 #endif
1090     CompTimeInfo m_info; // The CompTimeInfo for this compilation.
1091
1092     static CritSecObject s_csvLock; // Lock to protect the time log file.
1093     void PrintCsvMethodStats(Compiler* comp);
1094
1095 private:
1096     void* operator new(size_t);
1097     void* operator new[](size_t);
1098     void operator delete(void*);
1099     void operator delete[](void*);
1100
1101 public:
1102     // Initialized the timer instance
1103     JitTimer(unsigned byteCodeSize);
1104
1105     static JitTimer* Create(Compiler* comp, unsigned byteCodeSize)
1106     {
1107         return ::new (comp, CMK_Unknown) JitTimer(byteCodeSize);
1108     }
1109
1110     static void PrintCsvHeader();
1111
1112     // Ends the current phase (argument is for a redundant check).
1113     void EndPhase(Compiler* compiler, Phases phase);
1114
1115 #if MEASURE_CLRAPI_CALLS
1116     // Start and end a timed CLR API call.
1117     void CLRApiCallEnter(unsigned apix);
1118     void CLRApiCallLeave(unsigned apix);
1119 #endif // MEASURE_CLRAPI_CALLS
1120
1121     // Completes the timing of the current method, which is assumed to have "byteCodeBytes" bytes of bytecode,
1122     // and adds it to "sum".
1123     void Terminate(Compiler* comp, CompTimeSummaryInfo& sum, bool includePhases);
1124
1125     // Attempts to query the cycle counter of the current thread.  If successful, returns "true" and sets
1126     // *cycles to the cycle counter value.  Otherwise, returns false and sets the "m_timerFailure" flag of
1127     // "m_info" to true.
1128     bool GetThreadCycles(unsigned __int64* cycles)
1129     {
1130         bool res = CycleTimer::GetThreadCyclesS(cycles);
1131         if (!res)
1132         {
1133             m_info.m_timerFailure = true;
1134         }
1135         return res;
1136     }
1137 };
1138 #endif // FEATURE_JIT_METHOD_PERF
1139
1140 //------------------- Function/Funclet info -------------------------------
1141 enum FuncKind : BYTE
1142 {
1143     FUNC_ROOT,    // The main/root function (always id==0)
1144     FUNC_HANDLER, // a funclet associated with an EH handler (finally, fault, catch, filter handler)
1145     FUNC_FILTER,  // a funclet associated with an EH filter
1146     FUNC_COUNT
1147 };
1148
1149 class emitLocation;
1150
1151 struct FuncInfoDsc
1152 {
1153     FuncKind       funKind;
1154     BYTE           funFlags;   // Currently unused, just here for padding
1155     unsigned short funEHIndex; // index, into the ebd table, of innermost EH clause corresponding to this
1156                                // funclet. It is only valid if funKind field indicates this is a
1157                                // EH-related funclet: FUNC_HANDLER or FUNC_FILTER
1158
1159 #if defined(_TARGET_AMD64_)
1160
1161     // TODO-AMD64-Throughput: make the AMD64 info more like the ARM info to avoid having this large static array.
1162     emitLocation* startLoc;
1163     emitLocation* endLoc;
1164     emitLocation* coldStartLoc; // locations for the cold section, if there is one.
1165     emitLocation* coldEndLoc;
1166     UNWIND_INFO   unwindHeader;
1167     // Maximum of 255 UNWIND_CODE 'nodes' and then the unwind header. If there are an odd
1168     // number of codes, the VM or Zapper will 4-byte align the whole thing.
1169     BYTE     unwindCodes[offsetof(UNWIND_INFO, UnwindCode) + (0xFF * sizeof(UNWIND_CODE))];
1170     unsigned unwindCodeSlot;
1171
1172 #ifdef UNIX_AMD64_ABI
1173     jitstd::vector<CFI_CODE>* cfiCodes;
1174 #endif // UNIX_AMD64_ABI
1175
1176 #elif defined(_TARGET_ARMARCH_)
1177
1178     UnwindInfo  uwi;     // Unwind information for this function/funclet's hot  section
1179     UnwindInfo* uwiCold; // Unwind information for this function/funclet's cold section
1180                          //   Note: we only have a pointer here instead of the actual object,
1181                          //   to save memory in the JIT case (compared to the NGEN case),
1182                          //   where we don't have any cold section.
1183                          //   Note 2: we currently don't support hot/cold splitting in functions
1184                          //   with EH, so uwiCold will be NULL for all funclets.
1185
1186 #endif // _TARGET_ARMARCH_
1187
1188     // Eventually we may want to move rsModifiedRegsMask, lvaOutgoingArgSize, and anything else
1189     // that isn't shared between the main function body and funclets.
1190 };
1191
1192 struct fgArgTabEntry
1193 {
1194
1195 #if defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
1196     fgArgTabEntry()
1197     {
1198         otherRegNum = REG_NA;
1199         isStruct    = false; // is this a struct arg
1200     }
1201 #endif // defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
1202
1203     GenTreePtr node; // Initially points at the Op1 field of 'parent', but if the argument is replaced with an GT_ASG or
1204                      // placeholder
1205                      //  it will point at the actual argument in the gtCallLateArgs list.
1206     GenTreePtr parent; // Points at the GT_LIST node in the gtCallArgs for this argument
1207
1208     unsigned argNum; // The original argument number, also specifies the required argument evaluation order from the IL
1209
1210     regNumber regNum; // The (first) register to use when passing this argument, set to REG_STK for arguments passed on
1211                       // the stack
1212     unsigned numRegs; // Count of number of registers that this argument uses
1213
1214     // A slot is a pointer sized region in the OutArg area.
1215     unsigned slotNum;  // When an argument is passed in the OutArg area this is the slot number in the OutArg area
1216     unsigned numSlots; // Count of number of slots that this argument uses
1217
1218     unsigned alignment;  // 1 or 2 (slots/registers)
1219     unsigned lateArgInx; // index into gtCallLateArgs list
1220     unsigned tmpNum;     // the LclVar number if we had to force evaluation of this arg
1221
1222     bool isSplit : 1;       // True when this argument is split between the registers and OutArg area
1223     bool needTmp : 1;       // True when we force this argument's evaluation into a temp LclVar
1224     bool needPlace : 1;     // True when we must replace this argument with a placeholder node
1225     bool isTmp : 1;         // True when we setup a temp LclVar for this argument due to size issues with the struct
1226     bool processed : 1;     // True when we have decided the evaluation order for this argument in the gtCallLateArgs
1227     bool isHfaRegArg : 1;   // True when the argument is passed as a HFA in FP registers.
1228     bool isBackFilled : 1;  // True when the argument fills a register slot skipped due to alignment requirements of
1229                             // previous arguments.
1230     bool isNonStandard : 1; // True if it is an arg that is passed in a reg other than a standard arg reg, or is forced
1231                             // to be on the stack despite its arg list position.
1232
1233 #if defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
1234     bool isStruct : 1; // True if this is a struct arg
1235
1236     regNumber otherRegNum; // The (second) register to use when passing this argument.
1237
1238     SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR structDesc;
1239 #elif !defined(_TARGET_64BIT_)
1240     __declspec(property(get = getIsStruct)) bool isStruct;
1241     bool getIsStruct()
1242     {
1243         return varTypeIsStruct(node);
1244     }
1245 #endif // !_TARGET_64BIT_
1246
1247 #ifdef _TARGET_ARM_
1248     void SetIsHfaRegArg(bool hfaRegArg)
1249     {
1250         isHfaRegArg = hfaRegArg;
1251     }
1252
1253     void SetIsBackFilled(bool backFilled)
1254     {
1255         isBackFilled = backFilled;
1256     }
1257
1258     bool IsBackFilled() const
1259     {
1260         return isBackFilled;
1261     }
1262 #else  // !_TARGET_ARM_
1263     // To make the callers easier, we allow these calls (and the isHfaRegArg and isBackFilled data members) for all
1264     // platforms.
1265     void SetIsHfaRegArg(bool hfaRegArg)
1266     {
1267     }
1268
1269     void SetIsBackFilled(bool backFilled)
1270     {
1271     }
1272
1273     bool IsBackFilled() const
1274     {
1275         return false;
1276     }
1277 #endif // !_TARGET_ARM_
1278
1279 #ifdef DEBUG
1280     void Dump();
1281 #endif
1282 };
1283 typedef struct fgArgTabEntry* fgArgTabEntryPtr;
1284
1285 //-------------------------------------------------------------------------
1286 //
1287 //  The class fgArgInfo is used to handle the arguments
1288 //  when morphing a GT_CALL node.
1289 //
1290
1291 class fgArgInfo
1292 {
1293     Compiler*    compiler;    // Back pointer to the compiler instance so that we can allocate memory
1294     GenTreeCall* callTree;    // Back pointer to the GT_CALL node for this fgArgInfo
1295     unsigned     argCount;    // Updatable arg count value
1296     unsigned     nextSlotNum; // Updatable slot count value
1297     unsigned     stkLevel;    // Stack depth when we make this call (for x86)
1298
1299 #if defined(UNIX_X86_ABI)
1300     bool     alignmentDone; // Updateable flag, set to 'true' after we've done any required alignment.
1301     unsigned stkSizeBytes;  // Size of stack used by this call, in bytes. Calculated during fgMorphArgs().
1302     unsigned padStkAlign;   // Stack alignment in bytes required before arguments are pushed for this call.
1303                             // Computed dynamically during codegen, based on stkSizeBytes and the current
1304                             // stack level (genStackLevel) when the first stack adjustment is made for
1305                             // this call.
1306 #endif
1307
1308 #if FEATURE_FIXED_OUT_ARGS
1309     unsigned outArgSize; // Size of the out arg area for the call, will be at least MIN_ARG_AREA_FOR_CALL
1310 #endif
1311
1312     unsigned          argTableSize; // size of argTable array (equal to the argCount when done with fgMorphArgs)
1313     bool              hasRegArgs;   // true if we have one or more register arguments
1314     bool              hasStackArgs; // true if we have one or more stack arguments
1315     bool              argsComplete; // marker for state
1316     bool              argsSorted;   // marker for state
1317     fgArgTabEntryPtr* argTable;     // variable sized array of per argument descrption: (i.e. argTable[argTableSize])
1318
1319 private:
1320     void AddArg(fgArgTabEntryPtr curArgTabEntry);
1321
1322 public:
1323     fgArgInfo(Compiler* comp, GenTreeCall* call, unsigned argCount);
1324     fgArgInfo(GenTreeCall* newCall, GenTreeCall* oldCall);
1325
1326     fgArgTabEntryPtr AddRegArg(
1327         unsigned argNum, GenTreePtr node, GenTreePtr parent, regNumber regNum, unsigned numRegs, unsigned alignment);
1328
1329 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
1330     fgArgTabEntryPtr AddRegArg(
1331         unsigned                                                         argNum,
1332         GenTreePtr                                                       node,
1333         GenTreePtr                                                       parent,
1334         regNumber                                                        regNum,
1335         unsigned                                                         numRegs,
1336         unsigned                                                         alignment,
1337         const bool                                                       isStruct,
1338         const regNumber                                                  otherRegNum   = REG_NA,
1339         const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* const structDescPtr = nullptr);
1340 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
1341
1342     fgArgTabEntryPtr AddStkArg(unsigned   argNum,
1343                                GenTreePtr node,
1344                                GenTreePtr parent,
1345                                unsigned   numSlots,
1346                                unsigned alignment FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(const bool isStruct));
1347
1348     void             RemorphReset();
1349     fgArgTabEntryPtr RemorphRegArg(
1350         unsigned argNum, GenTreePtr node, GenTreePtr parent, regNumber regNum, unsigned numRegs, unsigned alignment);
1351
1352     void RemorphStkArg(unsigned argNum, GenTreePtr node, GenTreePtr parent, unsigned numSlots, unsigned alignment);
1353
1354     void SplitArg(unsigned argNum, unsigned numRegs, unsigned numSlots);
1355
1356     void EvalToTmp(unsigned argNum, unsigned tmpNum, GenTreePtr newNode);
1357
1358     void ArgsComplete();
1359
1360     void SortArgs();
1361
1362     void EvalArgsToTemps();
1363
1364     void RecordStkLevel(unsigned stkLvl);
1365     unsigned RetrieveStkLevel();
1366
1367     unsigned ArgCount()
1368     {
1369         return argCount;
1370     }
1371     fgArgTabEntryPtr* ArgTable()
1372     {
1373         return argTable;
1374     }
1375     unsigned GetNextSlotNum()
1376     {
1377         return nextSlotNum;
1378     }
1379     bool HasRegArgs()
1380     {
1381         return hasRegArgs;
1382     }
1383     bool HasStackArgs()
1384     {
1385         return hasStackArgs;
1386     }
1387     bool AreArgsComplete() const
1388     {
1389         return argsComplete;
1390     }
1391 #if FEATURE_FIXED_OUT_ARGS
1392     unsigned GetOutArgSize() const
1393     {
1394         return outArgSize;
1395     }
1396     void SetOutArgSize(unsigned newVal)
1397     {
1398         outArgSize = newVal;
1399     }
1400 #endif // FEATURE_FIXED_OUT_ARGS
1401
1402     void ComputeStackAlignment(unsigned curStackLevelInBytes)
1403     {
1404 #if defined(UNIX_X86_ABI)
1405         padStkAlign = AlignmentPad(curStackLevelInBytes, STACK_ALIGN);
1406 #endif // defined(UNIX_X86_ABI)
1407     }
1408
1409     void SetStkSizeBytes(unsigned newStkSizeBytes)
1410     {
1411 #if defined(UNIX_X86_ABI)
1412         stkSizeBytes = newStkSizeBytes;
1413 #endif // defined(UNIX_X86_ABI)
1414     }
1415
1416 #if defined(UNIX_X86_ABI)
1417     unsigned GetStkAlign()
1418     {
1419         return padStkAlign;
1420     }
1421     unsigned GetStkSizeBytes() const
1422     {
1423         return stkSizeBytes;
1424     }
1425     bool IsStkAlignmentDone() const
1426     {
1427         return alignmentDone;
1428     }
1429     void SetStkAlignmentDone()
1430     {
1431         alignmentDone = true;
1432     }
1433 #endif // defined(UNIX_X86_ABI)
1434
1435     // Get the late arg for arg at position argIndex.  Caller must ensure this position has a late arg.
1436     GenTreePtr GetLateArg(unsigned argIndex);
1437 };
1438
1439 #ifdef DEBUG
1440 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1441 // We have the ability to mark source expressions with "Test Labels."
1442 // These drive assertions within the JIT, or internal JIT testing.  For example, we could label expressions
1443 // that should be CSE defs, and other expressions that should uses of those defs, with a shared label.
1444
1445 enum TestLabel // This must be kept identical to System.Runtime.CompilerServices.JitTestLabel.TestLabel.
1446 {
1447     TL_SsaName,
1448     TL_VN,        // Defines a "VN equivalence class".  (For full VN, including exceptions thrown).
1449     TL_VNNorm,    // Like above, but uses the non-exceptional value of the expression.
1450     TL_CSE_Def,   //  This must be identified in the JIT as a CSE def
1451     TL_CSE_Use,   //  This must be identified in the JIT as a CSE use
1452     TL_LoopHoist, // Expression must (or must not) be hoisted out of the loop.
1453 };
1454
1455 struct TestLabelAndNum
1456 {
1457     TestLabel m_tl;
1458     ssize_t   m_num;
1459
1460     TestLabelAndNum() : m_tl(TestLabel(0)), m_num(0)
1461     {
1462     }
1463 };
1464
1465 typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, TestLabelAndNum, JitSimplerHashBehavior> NodeToTestDataMap;
1466
1467 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1468 #endif // DEBUG
1469
1470 // This class implements the "IAllocator" interface, so that we can use
1471 // utilcode collection classes in the JIT, and have them use the JIT's allocator.
1472
1473 class CompAllocator : public IAllocator
1474 {
1475     Compiler* m_comp;
1476 #if MEASURE_MEM_ALLOC
1477     CompMemKind m_cmk;
1478 #endif
1479 public:
1480     CompAllocator(Compiler* comp, CompMemKind cmk)
1481         : m_comp(comp)
1482 #if MEASURE_MEM_ALLOC
1483         , m_cmk(cmk)
1484 #endif
1485     {
1486     }
1487
1488     inline void* Alloc(size_t sz);
1489
1490     inline void* ArrayAlloc(size_t elems, size_t elemSize);
1491
1492     // For the compiler's no-release allocator, free operations are no-ops.
1493     void Free(void* p)
1494     {
1495     }
1496 };
1497
1498 /*
1499 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1500 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1501 XX                                                                           XX
1502 XX   The big guy. The sections are currently organized as :                  XX
1503 XX                                                                           XX
1504 XX    o  GenTree and BasicBlock                                              XX
1505 XX    o  LclVarsInfo                                                         XX
1506 XX    o  Importer                                                            XX
1507 XX    o  FlowGraph                                                           XX
1508 XX    o  Optimizer                                                           XX
1509 XX    o  RegAlloc                                                            XX
1510 XX    o  EEInterface                                                         XX
1511 XX    o  TempsInfo                                                           XX
1512 XX    o  RegSet                                                              XX
1513 XX    o  GCInfo                                                              XX
1514 XX    o  Instruction                                                         XX
1515 XX    o  ScopeInfo                                                           XX
1516 XX    o  PrologScopeInfo                                                     XX
1517 XX    o  CodeGenerator                                                       XX
1518 XX    o  UnwindInfo                                                          XX
1519 XX    o  Compiler                                                            XX
1520 XX    o  typeInfo                                                            XX
1521 XX                                                                           XX
1522 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1523 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1524 */
1525
1526 class Compiler
1527 {
1528     friend class emitter;
1529     friend class UnwindInfo;
1530     friend class UnwindFragmentInfo;
1531     friend class UnwindEpilogInfo;
1532     friend class JitTimer;
1533     friend class LinearScan;
1534     friend class fgArgInfo;
1535     friend class Rationalizer;
1536     friend class Phase;
1537     friend class Lowering;
1538     friend class CSE_DataFlow;
1539     friend class CSE_Heuristic;
1540     friend class CodeGenInterface;
1541     friend class CodeGen;
1542     friend class LclVarDsc;
1543     friend class TempDsc;
1544     friend class LIR;
1545     friend class ObjectAllocator;
1546
1547 #ifndef _TARGET_64BIT_
1548     friend class DecomposeLongs;
1549 #endif // !_TARGET_64BIT_
1550
1551     /*
1552     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1553     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1554     XX                                                                           XX
1555     XX  Misc structs definitions                                                 XX
1556     XX                                                                           XX
1557     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1558     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1559     */
1560
1561 public:
1562     hashBvGlobalData hbvGlobalData; // Used by the hashBv bitvector package.
1563
1564 #ifdef DEBUG
1565     bool    verbose;
1566     bool    dumpIR;
1567     bool    dumpIRNodes;
1568     bool    dumpIRTypes;
1569     bool    dumpIRKinds;
1570     bool    dumpIRLocals;
1571     bool    dumpIRRegs;
1572     bool    dumpIRSsa;
1573     bool    dumpIRValnums;
1574     bool    dumpIRCosts;
1575     bool    dumpIRFlags;
1576     bool    dumpIRNoLists;
1577     bool    dumpIRNoLeafs;
1578     bool    dumpIRNoStmts;
1579     bool    dumpIRTrees;
1580     bool    dumpIRLinear;
1581     bool    dumpIRDataflow;
1582     bool    dumpIRBlockHeaders;
1583     bool    dumpIRExit;
1584     LPCWSTR dumpIRPhase;
1585     LPCWSTR dumpIRFormat;
1586     bool    verboseTrees;
1587     bool    shouldUseVerboseTrees();
1588     bool    asciiTrees; // If true, dump trees using only ASCII characters
1589     bool    shouldDumpASCIITrees();
1590     bool    verboseSsa; // If true, produce especially verbose dump output in SSA construction.
1591     bool    shouldUseVerboseSsa();
1592     bool    treesBeforeAfterMorph; // If true, print trees before/after morphing (paired by an intra-compilation id:
1593     int     morphNum; // This counts the the trees that have been morphed, allowing us to label each uniquely.
1594
1595     const char* VarNameToStr(VarName name)
1596     {
1597         return name;
1598     }
1599
1600     DWORD expensiveDebugCheckLevel;
1601 #endif
1602
1603 #if FEATURE_MULTIREG_RET
1604     GenTreePtr impAssignMultiRegTypeToVar(GenTreePtr op, CORINFO_CLASS_HANDLE hClass);
1605 #endif // FEATURE_MULTIREG_RET
1606
1607 #ifdef ARM_SOFTFP
1608     bool isSingleFloat32Struct(CORINFO_CLASS_HANDLE hClass);
1609 #endif // ARM_SOFTFP
1610
1611     //-------------------------------------------------------------------------
1612     // Functions to handle homogeneous floating-point aggregates (HFAs) in ARM.
1613     // HFAs are one to four element structs where each element is the same
1614     // type, either all float or all double. They are treated specially
1615     // in the ARM Procedure Call Standard, specifically, they are passed in
1616     // floating-point registers instead of the general purpose registers.
1617     //
1618
1619     bool IsHfa(CORINFO_CLASS_HANDLE hClass);
1620     bool IsHfa(GenTreePtr tree);
1621
1622     var_types GetHfaType(GenTreePtr tree);
1623     unsigned GetHfaCount(GenTreePtr tree);
1624
1625     var_types GetHfaType(CORINFO_CLASS_HANDLE hClass);
1626     unsigned GetHfaCount(CORINFO_CLASS_HANDLE hClass);
1627
1628     bool IsMultiRegPassedType(CORINFO_CLASS_HANDLE hClass);
1629     bool IsMultiRegReturnedType(CORINFO_CLASS_HANDLE hClass);
1630
1631     //-------------------------------------------------------------------------
1632     // The following is used for validating format of EH table
1633     //
1634
1635     struct EHNodeDsc;
1636     typedef struct EHNodeDsc* pEHNodeDsc;
1637
1638     EHNodeDsc* ehnTree; // root of the tree comprising the EHnodes.
1639     EHNodeDsc* ehnNext; // root of the tree comprising the EHnodes.
1640
1641     struct EHNodeDsc
1642     {
1643         enum EHBlockType
1644         {
1645             TryNode,
1646             FilterNode,
1647             HandlerNode,
1648             FinallyNode,
1649             FaultNode
1650         };
1651
1652         EHBlockType ehnBlockType;   // kind of EH block
1653         IL_OFFSET   ehnStartOffset; // IL offset of start of the EH block
1654         IL_OFFSET ehnEndOffset; // IL offset past end of the EH block. (TODO: looks like verInsertEhNode() sets this to
1655                                 // the last IL offset, not "one past the last one", i.e., the range Start to End is
1656                                 // inclusive).
1657         pEHNodeDsc ehnNext;     // next (non-nested) block in sequential order
1658         pEHNodeDsc ehnChild;    // leftmost nested block
1659         union {
1660             pEHNodeDsc ehnTryNode;     // for filters and handlers, the corresponding try node
1661             pEHNodeDsc ehnHandlerNode; // for a try node, the corresponding handler node
1662         };
1663         pEHNodeDsc ehnFilterNode; // if this is a try node and has a filter, otherwise 0
1664         pEHNodeDsc ehnEquivalent; // if blockType=tryNode, start offset and end offset is same,
1665
1666         inline void ehnSetTryNodeType()
1667         {
1668             ehnBlockType = TryNode;
1669         }
1670         inline void ehnSetFilterNodeType()
1671         {
1672             ehnBlockType = FilterNode;
1673         }
1674         inline void ehnSetHandlerNodeType()
1675         {
1676             ehnBlockType = HandlerNode;
1677         }
1678         inline void ehnSetFinallyNodeType()
1679         {
1680             ehnBlockType = FinallyNode;
1681         }
1682         inline void ehnSetFaultNodeType()
1683         {
1684             ehnBlockType = FaultNode;
1685         }
1686
1687         inline BOOL ehnIsTryBlock()
1688         {
1689             return ehnBlockType == TryNode;
1690         }
1691         inline BOOL ehnIsFilterBlock()
1692         {
1693             return ehnBlockType == FilterNode;
1694         }
1695         inline BOOL ehnIsHandlerBlock()
1696         {
1697             return ehnBlockType == HandlerNode;
1698         }
1699         inline BOOL ehnIsFinallyBlock()
1700         {
1701             return ehnBlockType == FinallyNode;
1702         }
1703         inline BOOL ehnIsFaultBlock()
1704         {
1705             return ehnBlockType == FaultNode;
1706         }
1707
1708         // returns true if there is any overlap between the two nodes
1709         static inline BOOL ehnIsOverlap(pEHNodeDsc node1, pEHNodeDsc node2)
1710         {
1711             if (node1->ehnStartOffset < node2->ehnStartOffset)
1712             {
1713                 return (node1->ehnEndOffset >= node2->ehnStartOffset);
1714             }
1715             else
1716             {
1717                 return (node1->ehnStartOffset <= node2->ehnEndOffset);
1718             }
1719         }
1720
1721         // fails with BADCODE if inner is not completely nested inside outer
1722         static inline BOOL ehnIsNested(pEHNodeDsc inner, pEHNodeDsc outer)
1723         {
1724             return ((inner->ehnStartOffset >= outer->ehnStartOffset) && (inner->ehnEndOffset <= outer->ehnEndOffset));
1725         }
1726     };
1727
1728 //-------------------------------------------------------------------------
1729 // Exception handling functions
1730 //
1731
1732 #if !FEATURE_EH_FUNCLETS
1733
1734     bool ehNeedsShadowSPslots()
1735     {
1736         return (info.compXcptnsCount || opts.compDbgEnC);
1737     }
1738
1739     // 0 for methods with no EH
1740     // 1 for methods with non-nested EH, or where only the try blocks are nested
1741     // 2 for a method with a catch within a catch
1742     // etc.
1743     unsigned ehMaxHndNestingCount;
1744
1745 #endif // !FEATURE_EH_FUNCLETS
1746
1747     static bool jitIsBetween(unsigned value, unsigned start, unsigned end);
1748     static bool jitIsBetweenInclusive(unsigned value, unsigned start, unsigned end);
1749
1750     bool bbInCatchHandlerILRange(BasicBlock* blk);
1751     bool bbInFilterILRange(BasicBlock* blk);
1752     bool bbInTryRegions(unsigned regionIndex, BasicBlock* blk);
1753     bool bbInExnFlowRegions(unsigned regionIndex, BasicBlock* blk);
1754     bool bbInHandlerRegions(unsigned regionIndex, BasicBlock* blk);
1755     bool bbInCatchHandlerRegions(BasicBlock* tryBlk, BasicBlock* hndBlk);
1756     unsigned short bbFindInnermostCommonTryRegion(BasicBlock* bbOne, BasicBlock* bbTwo);
1757
1758     unsigned short bbFindInnermostTryRegionContainingHandlerRegion(unsigned handlerIndex);
1759     unsigned short bbFindInnermostHandlerRegionContainingTryRegion(unsigned tryIndex);
1760
1761     // Returns true if "block" is the start of a try region.
1762     bool bbIsTryBeg(BasicBlock* block);
1763
1764     // Returns true if "block" is the start of a handler or filter region.
1765     bool bbIsHandlerBeg(BasicBlock* block);
1766
1767     // Returns true iff "block" is where control flows if an exception is raised in the
1768     // try region, and sets "*regionIndex" to the index of the try for the handler.
1769     // Differs from "IsHandlerBeg" in the case of filters, where this is true for the first
1770     // block of the filter, but not for the filter's handler.
1771     bool bbIsExFlowBlock(BasicBlock* block, unsigned* regionIndex);
1772
1773     bool ehHasCallableHandlers();
1774
1775     // Return the EH descriptor for the given region index.
1776     EHblkDsc* ehGetDsc(unsigned regionIndex);
1777
1778     // Return the EH index given a region descriptor.
1779     unsigned ehGetIndex(EHblkDsc* ehDsc);
1780
1781     // Return the EH descriptor index of the enclosing try, for the given region index.
1782     unsigned ehGetEnclosingTryIndex(unsigned regionIndex);
1783
1784     // Return the EH descriptor index of the enclosing handler, for the given region index.
1785     unsigned ehGetEnclosingHndIndex(unsigned regionIndex);
1786
1787     // Return the EH descriptor for the most nested 'try' region this BasicBlock is a member of (or nullptr if this
1788     // block is not in a 'try' region).
1789     EHblkDsc* ehGetBlockTryDsc(BasicBlock* block);
1790
1791     // Return the EH descriptor for the most nested filter or handler region this BasicBlock is a member of (or nullptr
1792     // if this block is not in a filter or handler region).
1793     EHblkDsc* ehGetBlockHndDsc(BasicBlock* block);
1794
1795     // Return the EH descriptor for the most nested region that may handle exceptions raised in this BasicBlock (or
1796     // nullptr if this block's exceptions propagate to caller).
1797     EHblkDsc* ehGetBlockExnFlowDsc(BasicBlock* block);
1798
1799     EHblkDsc* ehIsBlockTryLast(BasicBlock* block);
1800     EHblkDsc* ehIsBlockHndLast(BasicBlock* block);
1801     bool ehIsBlockEHLast(BasicBlock* block);
1802
1803     bool ehBlockHasExnFlowDsc(BasicBlock* block);
1804
1805     // Return the region index of the most nested EH region this block is in.
1806     unsigned ehGetMostNestedRegionIndex(BasicBlock* block, bool* inTryRegion);
1807
1808     // Find the true enclosing try index, ignoring 'mutual protect' try. Uses IL ranges to check.
1809     unsigned ehTrueEnclosingTryIndexIL(unsigned regionIndex);
1810
1811     // Return the index of the most nested enclosing region for a particular EH region. Returns NO_ENCLOSING_INDEX
1812     // if there is no enclosing region. If the returned index is not NO_ENCLOSING_INDEX, then '*inTryRegion'
1813     // is set to 'true' if the enclosing region is a 'try', or 'false' if the enclosing region is a handler.
1814     // (It can never be a filter.)
1815     unsigned ehGetEnclosingRegionIndex(unsigned regionIndex, bool* inTryRegion);
1816
1817     // A block has been deleted. Update the EH table appropriately.
1818     void ehUpdateForDeletedBlock(BasicBlock* block);
1819
1820     // Determine whether a block can be deleted while preserving the EH normalization rules.
1821     bool ehCanDeleteEmptyBlock(BasicBlock* block);
1822
1823     // Update the 'last' pointers in the EH table to reflect new or deleted blocks in an EH region.
1824     void ehUpdateLastBlocks(BasicBlock* oldLast, BasicBlock* newLast);
1825
1826     // For a finally handler, find the region index that the BBJ_CALLFINALLY lives in that calls the handler,
1827     // or NO_ENCLOSING_INDEX if the BBJ_CALLFINALLY lives in the main function body. Normally, the index
1828     // is the same index as the handler (and the BBJ_CALLFINALLY lives in the 'try' region), but for AMD64 the
1829     // BBJ_CALLFINALLY lives in the enclosing try or handler region, whichever is more nested, or the main function
1830     // body. If the returned index is not NO_ENCLOSING_INDEX, then '*inTryRegion' is set to 'true' if the
1831     // BBJ_CALLFINALLY lives in the returned index's 'try' region, or 'false' if lives in the handler region. (It never
1832     // lives in a filter.)
1833     unsigned ehGetCallFinallyRegionIndex(unsigned finallyIndex, bool* inTryRegion);
1834
1835     // Find the range of basic blocks in which all BBJ_CALLFINALLY will be found that target the 'finallyIndex' region's
1836     // handler. Set begBlk to the first block, and endBlk to the block after the last block of the range
1837     // (nullptr if the last block is the last block in the program).
1838     // Precondition: 'finallyIndex' is the EH region of a try/finally clause.
1839     void ehGetCallFinallyBlockRange(unsigned finallyIndex, BasicBlock** begBlk, BasicBlock** endBlk);
1840
1841 #ifdef DEBUG
1842     // Given a BBJ_CALLFINALLY block and the EH region index of the finally it is calling, return
1843     // 'true' if the BBJ_CALLFINALLY is in the correct EH region.
1844     bool ehCallFinallyInCorrectRegion(BasicBlock* blockCallFinally, unsigned finallyIndex);
1845 #endif // DEBUG
1846
1847 #if FEATURE_EH_FUNCLETS
1848     // Do we need a PSPSym in the main function? For codegen purposes, we only need one
1849     // if there is a filter that protects a region with a nested EH clause (such as a
1850     // try/catch nested in the 'try' body of a try/filter/filter-handler). See
1851     // genFuncletProlog() for more details. However, the VM seems to use it for more
1852     // purposes, maybe including debugging. Until we are sure otherwise, always create
1853     // a PSPSym for functions with any EH.
1854     bool ehNeedsPSPSym() const
1855     {
1856 #ifdef _TARGET_X86_
1857         return false;
1858 #else  // _TARGET_X86_
1859         return compHndBBtabCount > 0;
1860 #endif // _TARGET_X86_
1861     }
1862
1863     bool     ehAnyFunclets();  // Are there any funclets in this function?
1864     unsigned ehFuncletCount(); // Return the count of funclets in the function
1865
1866     unsigned bbThrowIndex(BasicBlock* blk); // Get the index to use as the cache key for sharing throw blocks
1867 #else                                       // !FEATURE_EH_FUNCLETS
1868     bool ehAnyFunclets()
1869     {
1870         return false;
1871     }
1872     unsigned ehFuncletCount()
1873     {
1874         return 0;
1875     }
1876
1877     unsigned bbThrowIndex(BasicBlock* blk)
1878     {
1879         return blk->bbTryIndex;
1880     } // Get the index to use as the cache key for sharing throw blocks
1881 #endif                                      // !FEATURE_EH_FUNCLETS
1882
1883     // Returns a flowList representing the "EH predecessors" of "blk".  These are the normal predecessors of
1884     // "blk", plus one special case: if "blk" is the first block of a handler, considers the predecessor(s) of the first
1885     // first block of the corresponding try region to be "EH predecessors".  (If there is a single such predecessor,
1886     // for example, we want to consider that the immediate dominator of the catch clause start block, so it's
1887     // convenient to also consider it a predecessor.)
1888     flowList* BlockPredsWithEH(BasicBlock* blk);
1889
1890     // This table is useful for memoization of the method above.
1891     typedef SimplerHashTable<BasicBlock*, PtrKeyFuncs<BasicBlock>, flowList*, JitSimplerHashBehavior>
1892                         BlockToFlowListMap;
1893     BlockToFlowListMap* m_blockToEHPreds;
1894     BlockToFlowListMap* GetBlockToEHPreds()
1895     {
1896         if (m_blockToEHPreds == nullptr)
1897         {
1898             m_blockToEHPreds = new (getAllocator()) BlockToFlowListMap(getAllocator());
1899         }
1900         return m_blockToEHPreds;
1901     }
1902
1903     void* ehEmitCookie(BasicBlock* block);
1904     UNATIVE_OFFSET ehCodeOffset(BasicBlock* block);
1905
1906     EHblkDsc* ehInitHndRange(BasicBlock* src, IL_OFFSET* hndBeg, IL_OFFSET* hndEnd, bool* inFilter);
1907
1908     EHblkDsc* ehInitTryRange(BasicBlock* src, IL_OFFSET* tryBeg, IL_OFFSET* tryEnd);
1909
1910     EHblkDsc* ehInitHndBlockRange(BasicBlock* blk, BasicBlock** hndBeg, BasicBlock** hndLast, bool* inFilter);
1911
1912     EHblkDsc* ehInitTryBlockRange(BasicBlock* blk, BasicBlock** tryBeg, BasicBlock** tryLast);
1913
1914     void fgSetTryEnd(EHblkDsc* handlerTab, BasicBlock* newTryLast);
1915
1916     void fgSetHndEnd(EHblkDsc* handlerTab, BasicBlock* newHndLast);
1917
1918     void fgSkipRmvdBlocks(EHblkDsc* handlerTab);
1919
1920     void fgAllocEHTable();
1921
1922     void fgRemoveEHTableEntry(unsigned XTnum);
1923
1924 #if FEATURE_EH_FUNCLETS
1925
1926     EHblkDsc* fgAddEHTableEntry(unsigned XTnum);
1927
1928 #endif // FEATURE_EH_FUNCLETS
1929
1930 #if !FEATURE_EH
1931     void fgRemoveEH();
1932 #endif // !FEATURE_EH
1933
1934     void fgSortEHTable();
1935
1936     // Causes the EH table to obey some well-formedness conditions, by inserting
1937     // empty BB's when necessary:
1938     //   * No block is both the first block of a handler and the first block of a try.
1939     //   * No block is the first block of multiple 'try' regions.
1940     //   * No block is the last block of multiple EH regions.
1941     void fgNormalizeEH();
1942     bool fgNormalizeEHCase1();
1943     bool fgNormalizeEHCase2();
1944     bool fgNormalizeEHCase3();
1945
1946 #ifdef DEBUG
1947     void dispIncomingEHClause(unsigned num, const CORINFO_EH_CLAUSE& clause);
1948     void dispOutgoingEHClause(unsigned num, const CORINFO_EH_CLAUSE& clause);
1949     void fgVerifyHandlerTab();
1950     void fgDispHandlerTab();
1951 #endif // DEBUG
1952
1953     bool fgNeedToSortEHTable;
1954
1955     void verInitEHTree(unsigned numEHClauses);
1956     void verInsertEhNode(CORINFO_EH_CLAUSE* clause, EHblkDsc* handlerTab);
1957     void verInsertEhNodeInTree(EHNodeDsc** ppRoot, EHNodeDsc* node);
1958     void verInsertEhNodeParent(EHNodeDsc** ppRoot, EHNodeDsc* node);
1959     void verCheckNestingLevel(EHNodeDsc* initRoot);
1960
1961     /*
1962     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1963     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1964     XX                                                                           XX
1965     XX                        GenTree and BasicBlock                             XX
1966     XX                                                                           XX
1967     XX  Functions to allocate and display the GenTrees and BasicBlocks           XX
1968     XX                                                                           XX
1969     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1970     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1971     */
1972
1973     // Functions to create nodes
1974     GenTreeStmt* gtNewStmt(GenTreePtr expr = nullptr, IL_OFFSETX offset = BAD_IL_OFFSET);
1975
1976     // For unary opers.
1977     GenTreePtr gtNewOperNode(genTreeOps oper, var_types type, GenTreePtr op1, bool doSimplifications = TRUE);
1978
1979     // For binary opers.
1980     GenTreePtr gtNewOperNode(genTreeOps oper, var_types type, GenTreePtr op1, GenTreePtr op2);
1981
1982     GenTreePtr gtNewQmarkNode(var_types type, GenTreePtr cond, GenTreePtr colon);
1983
1984     GenTreePtr gtNewLargeOperNode(genTreeOps oper,
1985                                   var_types  type = TYP_I_IMPL,
1986                                   GenTreePtr op1  = nullptr,
1987                                   GenTreePtr op2  = nullptr);
1988
1989     GenTreeIntCon* gtNewIconNode(ssize_t value, var_types type = TYP_INT);
1990
1991     GenTree* gtNewPhysRegNode(regNumber reg, var_types type);
1992
1993     GenTreePtr gtNewJmpTableNode();
1994     GenTreePtr gtNewIconHandleNode(
1995         size_t value, unsigned flags, FieldSeqNode* fields = nullptr, unsigned handle1 = 0, void* handle2 = nullptr);
1996
1997     unsigned gtTokenToIconFlags(unsigned token);
1998
1999     GenTreePtr gtNewIconEmbHndNode(void*    value,
2000                                    void*    pValue,
2001                                    unsigned flags,
2002                                    unsigned handle1           = 0,
2003                                    void*    handle2           = nullptr,
2004                                    void*    compileTimeHandle = nullptr);
2005
2006     GenTreePtr gtNewIconEmbScpHndNode(CORINFO_MODULE_HANDLE scpHnd, unsigned hnd1 = 0, void* hnd2 = nullptr);
2007     GenTreePtr gtNewIconEmbClsHndNode(CORINFO_CLASS_HANDLE clsHnd, unsigned hnd1 = 0, void* hnd2 = nullptr);
2008     GenTreePtr gtNewIconEmbMethHndNode(CORINFO_METHOD_HANDLE methHnd, unsigned hnd1 = 0, void* hnd2 = nullptr);
2009     GenTreePtr gtNewIconEmbFldHndNode(CORINFO_FIELD_HANDLE fldHnd, unsigned hnd1 = 0, void* hnd2 = nullptr);
2010
2011     GenTreePtr gtNewStringLiteralNode(InfoAccessType iat, void* pValue);
2012
2013     GenTreePtr gtNewLconNode(__int64 value);
2014
2015     GenTreePtr gtNewDconNode(double value);
2016
2017     GenTreePtr gtNewSconNode(int CPX, CORINFO_MODULE_HANDLE scpHandle);
2018
2019     GenTreePtr gtNewZeroConNode(var_types type);
2020
2021     GenTreePtr gtNewOneConNode(var_types type);
2022
2023 #ifdef FEATURE_SIMD
2024     GenTreePtr gtNewSIMDVectorZero(var_types simdType, var_types baseType, unsigned size);
2025     GenTreePtr gtNewSIMDVectorOne(var_types simdType, var_types baseType, unsigned size);
2026 #endif
2027
2028     GenTreeBlk* gtNewBlkOpNode(
2029         genTreeOps oper, GenTreePtr dst, GenTreePtr srcOrFillVal, GenTreePtr sizeOrClsTok, bool isVolatile);
2030
2031     GenTree* gtNewBlkOpNode(GenTreePtr dst, GenTreePtr srcOrFillVal, unsigned size, bool isVolatile, bool isCopyBlock);
2032
2033     GenTree* gtNewPutArgReg(var_types type, GenTreePtr arg, regNumber argReg);
2034
2035 protected:
2036     void gtBlockOpInit(GenTreePtr result, GenTreePtr dst, GenTreePtr srcOrFillVal, bool isVolatile);
2037
2038 public:
2039     GenTree* gtNewObjNode(CORINFO_CLASS_HANDLE structHnd, GenTreePtr addr);
2040     void gtSetObjGcInfo(GenTreeObj* objNode);
2041     GenTree* gtNewStructVal(CORINFO_CLASS_HANDLE structHnd, GenTreePtr addr);
2042     GenTree* gtNewBlockVal(GenTreePtr addr, unsigned size);
2043
2044     GenTree* gtNewCpObjNode(GenTreePtr dst, GenTreePtr src, CORINFO_CLASS_HANDLE structHnd, bool isVolatile);
2045
2046     GenTreeArgList* gtNewListNode(GenTreePtr op1, GenTreeArgList* op2);
2047
2048     GenTreeCall* gtNewCallNode(gtCallTypes           callType,
2049                                CORINFO_METHOD_HANDLE handle,
2050                                var_types             type,
2051                                GenTreeArgList*       args,
2052                                IL_OFFSETX            ilOffset = BAD_IL_OFFSET);
2053
2054     GenTreeCall* gtNewIndCallNode(GenTreePtr      addr,
2055                                   var_types       type,
2056                                   GenTreeArgList* args,
2057                                   IL_OFFSETX      ilOffset = BAD_IL_OFFSET);
2058
2059     GenTreeCall* gtNewHelperCallNode(unsigned helper, var_types type, GenTreeArgList* args = nullptr);
2060
2061     GenTreePtr gtNewLclvNode(unsigned lnum, var_types type, IL_OFFSETX ILoffs = BAD_IL_OFFSET);
2062
2063 #ifdef FEATURE_SIMD
2064     GenTreeSIMD* gtNewSIMDNode(
2065         var_types type, GenTreePtr op1, SIMDIntrinsicID simdIntrinsicID, var_types baseType, unsigned size);
2066     GenTreeSIMD* gtNewSIMDNode(var_types       type,
2067                                GenTreePtr      op1,
2068                                GenTreePtr      op2,
2069                                SIMDIntrinsicID simdIntrinsicID,
2070                                var_types       baseType,
2071                                unsigned        size);
2072     void SetOpLclRelatedToSIMDIntrinsic(GenTreePtr op);
2073 #endif
2074
2075     GenTreePtr gtNewLclLNode(unsigned lnum, var_types type, IL_OFFSETX ILoffs = BAD_IL_OFFSET);
2076     GenTreeLclFld* gtNewLclFldNode(unsigned lnum, var_types type, unsigned offset);
2077     GenTreePtr gtNewInlineCandidateReturnExpr(GenTreePtr inlineCandidate, var_types type);
2078
2079     GenTreePtr gtNewCodeRef(BasicBlock* block);
2080
2081     GenTreePtr gtNewFieldRef(
2082         var_types typ, CORINFO_FIELD_HANDLE fldHnd, GenTreePtr obj = nullptr, DWORD offset = 0, bool nullcheck = false);
2083
2084     GenTreePtr gtNewIndexRef(var_types typ, GenTreePtr arrayOp, GenTreePtr indexOp);
2085
2086     GenTreeArrLen* gtNewArrLen(var_types typ, GenTree* arrayOp, int lenOffset);
2087
2088     GenTree* gtNewIndir(var_types typ, GenTree* addr);
2089
2090     GenTreeArgList* gtNewArgList(GenTreePtr op);
2091     GenTreeArgList* gtNewArgList(GenTreePtr op1, GenTreePtr op2);
2092     GenTreeArgList* gtNewArgList(GenTreePtr op1, GenTreePtr op2, GenTreePtr op3);
2093
2094     static fgArgTabEntryPtr gtArgEntryByArgNum(GenTreeCall* call, unsigned argNum);
2095     static fgArgTabEntryPtr gtArgEntryByNode(GenTreeCall* call, GenTreePtr node);
2096     fgArgTabEntryPtr gtArgEntryByLateArgIndex(GenTreeCall* call, unsigned lateArgInx);
2097     bool gtArgIsThisPtr(fgArgTabEntryPtr argEntry);
2098
2099     GenTreePtr gtNewAssignNode(GenTreePtr dst, GenTreePtr src);
2100
2101     GenTreePtr gtNewTempAssign(unsigned tmp, GenTreePtr val);
2102
2103     GenTreePtr gtNewRefCOMfield(GenTreePtr              objPtr,
2104                                 CORINFO_RESOLVED_TOKEN* pResolvedToken,
2105                                 CORINFO_ACCESS_FLAGS    access,
2106                                 CORINFO_FIELD_INFO*     pFieldInfo,
2107                                 var_types               lclTyp,
2108                                 CORINFO_CLASS_HANDLE    structType,
2109                                 GenTreePtr              assg);
2110
2111     GenTreePtr gtNewNothingNode();
2112
2113     GenTreePtr gtNewArgPlaceHolderNode(var_types type, CORINFO_CLASS_HANDLE clsHnd);
2114
2115     GenTreePtr gtUnusedValNode(GenTreePtr expr);
2116
2117     GenTreePtr gtNewCastNode(var_types typ, GenTreePtr op1, var_types castType);
2118
2119     GenTreePtr gtNewCastNodeL(var_types typ, GenTreePtr op1, var_types castType);
2120
2121     GenTreePtr gtNewAllocObjNode(unsigned int helper, CORINFO_CLASS_HANDLE clsHnd, var_types type, GenTreePtr op1);
2122
2123     //------------------------------------------------------------------------
2124     // Other GenTree functions
2125
2126     GenTreePtr gtClone(GenTree* tree, bool complexOK = false);
2127
2128     // If `tree` is a lclVar with lclNum `varNum`, return an IntCns with value `varVal`; otherwise,
2129     // create a copy of `tree`, adding specified flags, replacing uses of lclVar `deepVarNum` with
2130     // IntCnses with value `deepVarVal`.
2131     GenTreePtr gtCloneExpr(
2132         GenTree* tree, unsigned addFlags, unsigned varNum, int varVal, unsigned deepVarNum, int deepVarVal);
2133
2134     // Create a copy of `tree`, optionally adding specifed flags, and optionally mapping uses of local
2135     // `varNum` to int constants with value `varVal`.
2136     GenTreePtr gtCloneExpr(GenTree* tree, unsigned addFlags = 0, unsigned varNum = (unsigned)-1, int varVal = 0)
2137     {
2138         return gtCloneExpr(tree, addFlags, varNum, varVal, varNum, varVal);
2139     }
2140
2141     GenTreePtr gtReplaceTree(GenTreePtr stmt, GenTreePtr tree, GenTreePtr replacementTree);
2142
2143     void gtUpdateSideEffects(GenTree* stmt, GenTree* tree);
2144
2145     void gtUpdateTreeAncestorsSideEffects(GenTree* tree);
2146
2147     void gtUpdateStmtSideEffects(GenTree* stmt);
2148
2149     void gtResetNodeSideEffects(GenTree* tree);
2150
2151     // Returns "true" iff the complexity (not formally defined, but first interpretation
2152     // is #of nodes in subtree) of "tree" is greater than "limit".
2153     // (This is somewhat redundant with the "gtCostEx/gtCostSz" fields, but can be used
2154     // before they have been set.)
2155     bool gtComplexityExceeds(GenTreePtr* tree, unsigned limit);
2156
2157     bool gtCompareTree(GenTree* op1, GenTree* op2);
2158
2159     GenTreePtr gtReverseCond(GenTree* tree);
2160
2161     bool gtHasRef(GenTree* tree, ssize_t lclNum, bool defOnly);
2162
2163     bool gtHasLocalsWithAddrOp(GenTreePtr tree);
2164
2165     unsigned gtSetListOrder(GenTree* list, bool regs, bool isListCallArgs);
2166
2167     void gtWalkOp(GenTree** op1, GenTree** op2, GenTree* adr, bool constOnly);
2168
2169 #ifdef DEBUG
2170     unsigned gtHashValue(GenTree* tree);
2171
2172     GenTreePtr gtWalkOpEffectiveVal(GenTreePtr op);
2173 #endif
2174
2175     void gtPrepareCost(GenTree* tree);
2176     bool gtIsLikelyRegVar(GenTree* tree);
2177
2178     unsigned gtSetEvalOrderAndRestoreFPstkLevel(GenTree* tree);
2179
2180     // Returns true iff the secondNode can be swapped with firstNode.
2181     bool gtCanSwapOrder(GenTree* firstNode, GenTree* secondNode);
2182
2183     unsigned gtSetEvalOrder(GenTree* tree);
2184
2185 #if FEATURE_STACK_FP_X87
2186     bool gtFPstLvlRedo;
2187     void gtComputeFPlvls(GenTreePtr tree);
2188 #endif // FEATURE_STACK_FP_X87
2189
2190     void gtSetStmtInfo(GenTree* stmt);
2191
2192     // Returns "true" iff "node" has any of the side effects in "flags".
2193     bool gtNodeHasSideEffects(GenTreePtr node, unsigned flags);
2194
2195     // Returns "true" iff "tree" or its (transitive) children have any of the side effects in "flags".
2196     bool gtTreeHasSideEffects(GenTreePtr tree, unsigned flags);
2197
2198     // Appends 'expr' in front of 'list'
2199     //    'list' will typically start off as 'nullptr'
2200     //    when 'list' is non-null a GT_COMMA node is used to insert 'expr'
2201     GenTreePtr gtBuildCommaList(GenTreePtr list, GenTreePtr expr);
2202
2203     void gtExtractSideEffList(GenTreePtr  expr,
2204                               GenTreePtr* pList,
2205                               unsigned    flags      = GTF_SIDE_EFFECT,
2206                               bool        ignoreRoot = false);
2207
2208     GenTreePtr gtGetThisArg(GenTreeCall* call);
2209
2210     // Static fields of struct types (and sometimes the types that those are reduced to) are represented by having the
2211     // static field contain an object pointer to the boxed struct.  This simplifies the GC implementation...but
2212     // complicates the JIT somewhat.  This predicate returns "true" iff a node with type "fieldNodeType", representing
2213     // the given "fldHnd", is such an object pointer.
2214     bool gtIsStaticFieldPtrToBoxedStruct(var_types fieldNodeType, CORINFO_FIELD_HANDLE fldHnd);
2215
2216     // Return true if call is a recursive call; return false otherwise.
2217     // Note when inlining, this looks for calls back to the root method.
2218     bool gtIsRecursiveCall(GenTreeCall* call)
2219     {
2220         return (call->gtCallMethHnd == impInlineRoot()->info.compMethodHnd);
2221     }
2222
2223     //-------------------------------------------------------------------------
2224
2225     GenTreePtr gtFoldExpr(GenTreePtr tree);
2226     GenTreePtr
2227 #ifdef __clang__
2228         // TODO-Amd64-Unix: Remove this when the clang optimizer is fixed and/or the method implementation is
2229         // refactored in a simpler code. This is a workaround for a bug in the clang-3.5 optimizer. The issue is that in
2230         // release build the optimizer is mistyping (or just wrongly decides to use 32 bit operation for a corner case
2231         // of MIN_LONG) the args of the (ltemp / lval2) to int (it does a 32 bit div operation instead of 64 bit) - see
2232         // the implementation of the method in gentree.cpp. For the case of lval1 and lval2 equal to MIN_LONG
2233         // (0x8000000000000000) this results in raising a SIGFPE. The method implementation is rather complex. Disable
2234         // optimizations for now.
2235         __attribute__((optnone))
2236 #endif // __clang__
2237         gtFoldExprConst(GenTreePtr tree);
2238     GenTreePtr gtFoldExprSpecial(GenTreePtr tree);
2239     GenTreePtr gtFoldExprCompare(GenTreePtr tree);
2240     bool gtTryRemoveBoxUpstreamEffects(GenTreePtr tree);
2241
2242     //-------------------------------------------------------------------------
2243     // Get the handle, if any.
2244     CORINFO_CLASS_HANDLE gtGetStructHandleIfPresent(GenTreePtr tree);
2245     // Get the handle, and assert if not found.
2246     CORINFO_CLASS_HANDLE gtGetStructHandle(GenTreePtr tree);
2247     // Get the handle for a ref type.
2248     CORINFO_CLASS_HANDLE gtGetClassHandle(GenTreePtr tree, bool* isExact, bool* isNonNull);
2249
2250 //-------------------------------------------------------------------------
2251 // Functions to display the trees
2252
2253 #ifdef DEBUG
2254     void gtDispNode(GenTreePtr tree, IndentStack* indentStack, __in_z const char* msg, bool isLIR);
2255
2256     void gtDispVN(GenTreePtr tree);
2257     void gtDispConst(GenTreePtr tree);
2258     void gtDispLeaf(GenTreePtr tree, IndentStack* indentStack);
2259     void gtDispNodeName(GenTreePtr tree);
2260     void gtDispRegVal(GenTreePtr tree);
2261
2262     enum IndentInfo
2263     {
2264         IINone,
2265         IIArc,
2266         IIArcTop,
2267         IIArcBottom,
2268         IIEmbedded,
2269         IIError,
2270         IndentInfoCount
2271     };
2272     void gtDispChild(GenTreePtr           child,
2273                      IndentStack*         indentStack,
2274                      IndentInfo           arcType,
2275                      __in_opt const char* msg     = nullptr,
2276                      bool                 topOnly = false);
2277     void gtDispTree(GenTreePtr           tree,
2278                     IndentStack*         indentStack = nullptr,
2279                     __in_opt const char* msg         = nullptr,
2280                     bool                 topOnly     = false,
2281                     bool                 isLIR       = false);
2282     void gtGetLclVarNameInfo(unsigned lclNum, const char** ilKindOut, const char** ilNameOut, unsigned* ilNumOut);
2283     int gtGetLclVarName(unsigned lclNum, char* buf, unsigned buf_remaining);
2284     char* gtGetLclVarName(unsigned lclNum);
2285     void gtDispLclVar(unsigned varNum, bool padForBiggestDisp = true);
2286     void gtDispTreeList(GenTreePtr tree, IndentStack* indentStack = nullptr);
2287     void gtGetArgMsg(GenTreeCall* call, GenTreePtr arg, unsigned argNum, int listCount, char* bufp, unsigned bufLength);
2288     void gtGetLateArgMsg(GenTreeCall* call, GenTreePtr arg, int argNum, int listCount, char* bufp, unsigned bufLength);
2289     void gtDispArgList(GenTreeCall* call, IndentStack* indentStack);
2290     void gtDispFieldSeq(FieldSeqNode* pfsn);
2291
2292     void gtDispRange(LIR::ReadOnlyRange const& range);
2293
2294     void gtDispTreeRange(LIR::Range& containingRange, GenTree* tree);
2295
2296     void gtDispLIRNode(GenTree* node, const char* prefixMsg = nullptr);
2297 #endif
2298
2299     // For tree walks
2300
2301     enum fgWalkResult
2302     {
2303         WALK_CONTINUE,
2304         WALK_SKIP_SUBTREES,
2305         WALK_ABORT
2306     };
2307     struct fgWalkData;
2308     typedef fgWalkResult(fgWalkPreFn)(GenTreePtr* pTree, fgWalkData* data);
2309     typedef fgWalkResult(fgWalkPostFn)(GenTreePtr* pTree, fgWalkData* data);
2310
2311 #ifdef DEBUG
2312     static fgWalkPreFn gtAssertColonCond;
2313 #endif
2314     static fgWalkPreFn gtMarkColonCond;
2315     static fgWalkPreFn gtClearColonCond;
2316
2317     GenTreePtr* gtFindLink(GenTreePtr stmt, GenTreePtr node);
2318     bool gtHasCatchArg(GenTreePtr tree);
2319     bool gtHasUnmanagedCall(GenTreePtr tree);
2320
2321     typedef ArrayStack<GenTree*> GenTreeStack;
2322
2323     static bool gtHasCallOnStack(GenTreeStack* parentStack);
2324     void gtCheckQuirkAddrExposedLclVar(GenTreePtr argTree, GenTreeStack* parentStack);
2325
2326 //=========================================================================
2327 // BasicBlock functions
2328 #ifdef DEBUG
2329     // This is a debug flag we will use to assert when creating block during codegen
2330     // as this interferes with procedure splitting. If you know what you're doing, set
2331     // it to true before creating the block. (DEBUG only)
2332     bool fgSafeBasicBlockCreation;
2333 #endif
2334
2335     BasicBlock* bbNewBasicBlock(BBjumpKinds jumpKind);
2336
2337     /*
2338     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2339     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2340     XX                                                                           XX
2341     XX                           LclVarsInfo                                     XX
2342     XX                                                                           XX
2343     XX   The variables to be used by the code generator.                         XX
2344     XX                                                                           XX
2345     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2346     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2347     */
2348
2349     //
2350     // For both PROMOTION_TYPE_NONE and PROMOTION_TYPE_DEPENDENT the struct will
2351     // be placed in the stack frame and it's fields must be laid out sequentially.
2352     //
2353     // For PROMOTION_TYPE_INDEPENDENT each of the struct's fields is replaced by
2354     //  a local variable that can be enregistered or placed in the stack frame.
2355     //  The fields do not need to be laid out sequentially
2356     //
2357     enum lvaPromotionType
2358     {
2359         PROMOTION_TYPE_NONE,        // The struct local is not promoted
2360         PROMOTION_TYPE_INDEPENDENT, // The struct local is promoted,
2361                                     //   and its field locals are independent of its parent struct local.
2362         PROMOTION_TYPE_DEPENDENT    // The struct local is promoted,
2363                                     //   but its field locals depend on its parent struct local.
2364     };
2365
2366     static int __cdecl RefCntCmp(const void* op1, const void* op2);
2367     static int __cdecl WtdRefCntCmp(const void* op1, const void* op2);
2368
2369     /*****************************************************************************/
2370
2371     enum FrameLayoutState
2372     {
2373         NO_FRAME_LAYOUT,
2374         INITIAL_FRAME_LAYOUT,
2375         PRE_REGALLOC_FRAME_LAYOUT,
2376         REGALLOC_FRAME_LAYOUT,
2377         TENTATIVE_FRAME_LAYOUT,
2378         FINAL_FRAME_LAYOUT
2379     };
2380
2381 public:
2382     bool     lvaRefCountingStarted; // Set to true when we have started counting the local vars
2383     bool     lvaLocalVarRefCounted; // Set to true after we have called lvaMarkLocalVars()
2384     bool     lvaSortAgain;          // true: We need to sort the lvaTable
2385     bool     lvaTrackedFixed;       // true: We cannot add new 'tracked' variable
2386     unsigned lvaCount;              // total number of locals
2387
2388     unsigned   lvaRefCount; // total number of references to locals
2389     LclVarDsc* lvaTable;    // variable descriptor table
2390     unsigned   lvaTableCnt; // lvaTable size (>= lvaCount)
2391
2392     LclVarDsc** lvaRefSorted; // table sorted by refcount
2393
2394     unsigned short lvaTrackedCount;       // actual # of locals being tracked
2395     unsigned lvaTrackedCountInSizeTUnits; // min # of size_t's sufficient to hold a bit for all the locals being tracked
2396
2397 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
2398     // Only for AMD64 System V cache the first caller stack homed argument.
2399     unsigned lvaFirstStackIncomingArgNum; // First argument with stack slot in the caller.
2400 #endif                                    // !FEATURE_UNIX_AMD64_STRUCT_PASSING
2401
2402 #ifdef DEBUG
2403     VARSET_TP lvaTrackedVars; // set of tracked variables
2404 #endif
2405 #ifndef _TARGET_64BIT_
2406     VARSET_TP lvaLongVars; // set of long (64-bit) variables
2407 #endif
2408     VARSET_TP lvaFloatVars; // set of floating-point (32-bit and 64-bit) variables
2409
2410     unsigned lvaCurEpoch; // VarSets are relative to a specific set of tracked var indices.
2411                           // It that changes, this changes.  VarSets from different epochs
2412                           // cannot be meaningfully combined.
2413
2414     unsigned GetCurLVEpoch()
2415     {
2416         return lvaCurEpoch;
2417     }
2418
2419     // reverse map of tracked number to var number
2420     unsigned lvaTrackedToVarNum[lclMAX_TRACKED];
2421
2422 #ifdef LEGACY_BACKEND
2423     // variable interference graph
2424     VARSET_TP lvaVarIntf[lclMAX_TRACKED];
2425 #endif
2426
2427     // variable preference graph
2428     VARSET_TP lvaVarPref[lclMAX_TRACKED];
2429
2430 #if DOUBLE_ALIGN
2431 #ifdef DEBUG
2432     // # of procs compiled a with double-aligned stack
2433     static unsigned s_lvaDoubleAlignedProcsCount;
2434 #endif
2435 #endif
2436
2437     // Getters and setters for address-exposed and do-not-enregister local var properties.
2438     bool lvaVarAddrExposed(unsigned varNum);
2439     void lvaSetVarAddrExposed(unsigned varNum);
2440     bool lvaVarDoNotEnregister(unsigned varNum);
2441 #ifdef DEBUG
2442     // Reasons why we can't enregister.  Some of these correspond to debug properties of local vars.
2443     enum DoNotEnregisterReason
2444     {
2445         DNER_AddrExposed,
2446         DNER_IsStruct,
2447         DNER_LocalField,
2448         DNER_VMNeedsStackAddr,
2449         DNER_LiveInOutOfHandler,
2450         DNER_LiveAcrossUnmanagedCall,
2451         DNER_BlockOp,     // Is read or written via a block operation that explicitly takes the address.
2452         DNER_IsStructArg, // Is a struct passed as an argument in a way that requires a stack location.
2453         DNER_DepField,    // It is a field of a dependently promoted struct
2454         DNER_NoRegVars,   // opts.compFlags & CLFLG_REGVAR is not set
2455         DNER_MinOptsGC,   // It is a GC Ref and we are compiling MinOpts
2456 #if !defined(LEGACY_BACKEND) && !defined(_TARGET_64BIT_)
2457         DNER_LongParamField, // It is a decomposed field of a long parameter.
2458 #endif
2459 #ifdef JIT32_GCENCODER
2460         DNER_PinningRef,
2461 #endif
2462     };
2463 #endif
2464     void lvaSetVarDoNotEnregister(unsigned varNum DEBUGARG(DoNotEnregisterReason reason));
2465
2466     unsigned lvaVarargsHandleArg;
2467 #ifdef _TARGET_X86_
2468     unsigned lvaVarargsBaseOfStkArgs; // Pointer (computed based on incoming varargs handle) to the start of the stack
2469                                       // arguments
2470 #endif                                // _TARGET_X86_
2471
2472     unsigned lvaInlinedPInvokeFrameVar; // variable representing the InlinedCallFrame
2473     unsigned lvaReversePInvokeFrameVar; // variable representing the reverse PInvoke frame
2474 #if FEATURE_FIXED_OUT_ARGS
2475     unsigned lvaPInvokeFrameRegSaveVar; // variable representing the RegSave for PInvoke inlining.
2476 #endif
2477     unsigned lvaMonAcquired; // boolean variable introduced into in synchronized methods
2478                              // that tracks whether the lock has been taken
2479
2480     unsigned lvaArg0Var; // The lclNum of arg0. Normally this will be info.compThisArg.
2481                          // However, if there is a "ldarga 0" or "starg 0" in the IL,
2482                          // we will redirect all "ldarg(a) 0" and "starg 0" to this temp.
2483
2484     unsigned lvaInlineeReturnSpillTemp; // The temp to spill the non-VOID return expression
2485                                         // in case there are multiple BBJ_RETURN blocks in the inlinee.
2486
2487 #if FEATURE_FIXED_OUT_ARGS
2488     unsigned            lvaOutgoingArgSpaceVar;  // dummy TYP_LCLBLK var for fixed outgoing argument space
2489     PhasedVar<unsigned> lvaOutgoingArgSpaceSize; // size of fixed outgoing argument space
2490 #endif                                           // FEATURE_FIXED_OUT_ARGS
2491
2492 #ifdef _TARGET_ARM_
2493     // On architectures whose ABIs allow structs to be passed in registers, struct promotion will sometimes
2494     // require us to "rematerialize" a struct from it's separate constituent field variables.  Packing several sub-word
2495     // field variables into an argument register is a hard problem.  It's easier to reserve a word of memory into which
2496     // such field can be copied, after which the assembled memory word can be read into the register.  We will allocate
2497     // this variable to be this scratch word whenever struct promotion occurs.
2498     unsigned lvaPromotedStructAssemblyScratchVar;
2499 #endif // _TARGET_ARM_
2500
2501 #ifdef DEBUG
2502     unsigned lvaReturnEspCheck; // confirms ESP not corrupted on return
2503     unsigned lvaCallEspCheck;   // confirms ESP not corrupted after a call
2504 #endif
2505
2506     unsigned lvaGenericsContextUseCount;
2507
2508     bool lvaKeepAliveAndReportThis(); // Synchronized instance method of a reference type, or
2509                                       // CORINFO_GENERICS_CTXT_FROM_THIS?
2510     bool lvaReportParamTypeArg();     // Exceptions and CORINFO_GENERICS_CTXT_FROM_PARAMTYPEARG?
2511
2512 //-------------------------------------------------------------------------
2513 // All these frame offsets are inter-related and must be kept in sync
2514
2515 #if !FEATURE_EH_FUNCLETS
2516     // This is used for the callable handlers
2517     unsigned lvaShadowSPslotsVar; // TYP_BLK variable for all the shadow SP slots
2518 #endif                            // FEATURE_EH_FUNCLETS
2519
2520     unsigned lvaCachedGenericContextArgOffs;
2521     unsigned lvaCachedGenericContextArgOffset(); // For CORINFO_CALLCONV_PARAMTYPE and if generic context is passed as
2522                                                  // THIS pointer
2523
2524     unsigned lvaLocAllocSPvar; // variable which has the result of the last alloca/localloc
2525
2526     unsigned lvaNewObjArrayArgs; // variable with arguments for new MD array helper
2527
2528     // TODO-Review: Prior to reg predict we reserve 24 bytes for Spill temps.
2529     //              after the reg predict we will use a computed maxTmpSize
2530     //              which is based upon the number of spill temps predicted by reg predict
2531     //              All this is necessary because if we under-estimate the size of the spill
2532     //              temps we could fail when encoding instructions that reference stack offsets for ARM.
2533     //
2534     // Pre codegen max spill temp size.
2535     static const unsigned MAX_SPILL_TEMP_SIZE = 24;
2536
2537     //-------------------------------------------------------------------------
2538
2539     unsigned lvaGetMaxSpillTempSize();
2540 #ifdef _TARGET_ARM_
2541     bool lvaIsPreSpilled(unsigned lclNum, regMaskTP preSpillMask);
2542 #endif // _TARGET_ARM_
2543     void lvaAssignFrameOffsets(FrameLayoutState curState);
2544     void lvaFixVirtualFrameOffsets();
2545
2546 #ifndef LEGACY_BACKEND
2547     void lvaUpdateArgsWithInitialReg();
2548 #endif // !LEGACY_BACKEND
2549
2550     void lvaAssignVirtualFrameOffsetsToArgs();
2551 #ifdef UNIX_AMD64_ABI
2552     int lvaAssignVirtualFrameOffsetToArg(unsigned lclNum, unsigned argSize, int argOffs, int* callerArgOffset);
2553 #else  // !UNIX_AMD64_ABI
2554     int lvaAssignVirtualFrameOffsetToArg(unsigned lclNum, unsigned argSize, int argOffs);
2555 #endif // !UNIX_AMD64_ABI
2556     void lvaAssignVirtualFrameOffsetsToLocals();
2557     int lvaAllocLocalAndSetVirtualOffset(unsigned lclNum, unsigned size, int stkOffs);
2558 #ifdef _TARGET_AMD64_
2559     // Returns true if compCalleeRegsPushed (including RBP if used as frame pointer) is even.
2560     bool lvaIsCalleeSavedIntRegCountEven();
2561 #endif
2562     void lvaAlignFrame();
2563     void lvaAssignFrameOffsetsToPromotedStructs();
2564     int lvaAllocateTemps(int stkOffs, bool mustDoubleAlign);
2565
2566 #ifdef DEBUG
2567     void lvaDumpRegLocation(unsigned lclNum);
2568     void lvaDumpFrameLocation(unsigned lclNum);
2569     void lvaDumpEntry(unsigned lclNum, FrameLayoutState curState, size_t refCntWtdWidth = 6);
2570     void lvaTableDump(FrameLayoutState curState = NO_FRAME_LAYOUT); // NO_FRAME_LAYOUT means use the current frame
2571                                                                     // layout state defined by lvaDoneFrameLayout
2572 #endif
2573
2574 // Limit frames size to 1GB. The maximum is 2GB in theory - make it intentionally smaller
2575 // to avoid bugs from borderline cases.
2576 #define MAX_FrameSize 0x3FFFFFFF
2577     void lvaIncrementFrameSize(unsigned size);
2578
2579     unsigned lvaFrameSize(FrameLayoutState curState);
2580
2581     // Returns the caller-SP-relative offset for the SP/FP relative offset determined by FP based.
2582     int lvaToCallerSPRelativeOffset(int offs, bool isFpBased);
2583
2584     // Returns the caller-SP-relative offset for the local variable "varNum."
2585     int lvaGetCallerSPRelativeOffset(unsigned varNum);
2586
2587     // Returns the SP-relative offset for the local variable "varNum". Illegal to ask this for functions with localloc.
2588     int lvaGetSPRelativeOffset(unsigned varNum);
2589
2590     int lvaToInitialSPRelativeOffset(unsigned offset, bool isFpBased);
2591     int lvaGetInitialSPRelativeOffset(unsigned varNum);
2592
2593     //------------------------ For splitting types ----------------------------
2594
2595     void lvaInitTypeRef();
2596
2597     void lvaInitArgs(InitVarDscInfo* varDscInfo);
2598     void lvaInitThisPtr(InitVarDscInfo* varDscInfo);
2599     void lvaInitRetBuffArg(InitVarDscInfo* varDscInfo);
2600     void lvaInitUserArgs(InitVarDscInfo* varDscInfo);
2601     void lvaInitGenericsCtxt(InitVarDscInfo* varDscInfo);
2602     void lvaInitVarArgsHandle(InitVarDscInfo* varDscInfo);
2603
2604     void lvaInitVarDsc(LclVarDsc*              varDsc,
2605                        unsigned                varNum,
2606                        CorInfoType             corInfoType,
2607                        CORINFO_CLASS_HANDLE    typeHnd,
2608                        CORINFO_ARG_LIST_HANDLE varList,
2609                        CORINFO_SIG_INFO*       varSig);
2610
2611     static unsigned lvaTypeRefMask(var_types type);
2612
2613     var_types lvaGetActualType(unsigned lclNum);
2614     var_types lvaGetRealType(unsigned lclNum);
2615
2616     //-------------------------------------------------------------------------
2617
2618     void lvaInit();
2619
2620     unsigned lvaLclSize(unsigned varNum);
2621     unsigned lvaLclExactSize(unsigned varNum);
2622
2623     bool lvaLclVarRefs(GenTreePtr tree, GenTreePtr* findPtr, varRefKinds* refsPtr, void* result);
2624
2625     // Call lvaLclVarRefs on "true"; accumulate "*result" into whichever of
2626     // "allVars" and "trkdVars" is indiated by the nullness of "findPtr"; return
2627     // the return result.
2628     bool lvaLclVarRefsAccum(
2629         GenTreePtr tree, GenTreePtr* findPtr, varRefKinds* refsPtr, ALLVARSET_TP* allVars, VARSET_TP* trkdVars);
2630
2631     // If "findPtr" is non-NULL, assumes "result" is an "ALLVARSET_TP*", and
2632     // (destructively) unions "allVars" into "*result".  Otherwise, assumes "result" is a "VARSET_TP*",
2633     // and (destructively) unions "trkedVars" into "*result".
2634     void lvaLclVarRefsAccumIntoRes(GenTreePtr*         findPtr,
2635                                    void*               result,
2636                                    ALLVARSET_VALARG_TP allVars,
2637                                    VARSET_VALARG_TP    trkdVars);
2638
2639     bool lvaHaveManyLocals() const;
2640
2641     unsigned lvaGrabTemp(bool shortLifetime DEBUGARG(const char* reason));
2642     unsigned lvaGrabTemps(unsigned cnt DEBUGARG(const char* reason));
2643     unsigned lvaGrabTempWithImplicitUse(bool shortLifetime DEBUGARG(const char* reason));
2644
2645     void lvaSortOnly();
2646     void lvaSortByRefCount();
2647     void lvaDumpRefCounts();
2648
2649     void lvaMarkLocalVars(BasicBlock* block);
2650
2651     void lvaMarkLocalVars(); // Local variable ref-counting
2652
2653     void lvaAllocOutgoingArgSpaceVar(); // Set up lvaOutgoingArgSpaceVar
2654
2655     VARSET_VALRET_TP lvaStmtLclMask(GenTreePtr stmt);
2656
2657     void lvaIncRefCnts(GenTreePtr tree);
2658     void lvaDecRefCnts(GenTreePtr tree);
2659
2660     void lvaDecRefCnts(BasicBlock* basicBlock, GenTreePtr tree);
2661     void lvaRecursiveDecRefCounts(GenTreePtr tree);
2662     void lvaRecursiveIncRefCounts(GenTreePtr tree);
2663
2664 #ifdef DEBUG
2665     struct lvaStressLclFldArgs
2666     {
2667         Compiler* m_pCompiler;
2668         bool      m_bFirstPass;
2669     };
2670
2671     static fgWalkPreFn lvaStressLclFldCB;
2672     void               lvaStressLclFld();
2673
2674     void lvaDispVarSet(VARSET_VALARG_TP set, VARSET_VALARG_TP allVars);
2675     void lvaDispVarSet(VARSET_VALARG_TP set);
2676
2677 #endif
2678
2679 #ifdef _TARGET_ARM_
2680     int lvaFrameAddress(int varNum, bool mustBeFPBased, regNumber* pBaseReg, int addrModeOffset);
2681 #else
2682     int lvaFrameAddress(int varNum, bool* pFPbased);
2683 #endif
2684
2685     bool lvaIsParameter(unsigned varNum);
2686     bool lvaIsRegArgument(unsigned varNum);
2687     BOOL lvaIsOriginalThisArg(unsigned varNum); // Is this varNum the original this argument?
2688     BOOL lvaIsOriginalThisReadOnly();           // return TRUE if there is no place in the code
2689                                                 // that writes to arg0
2690
2691     // Struct parameters that are passed by reference are marked as both lvIsParam and lvIsTemp
2692     // (this is an overload of lvIsTemp because there are no temp parameters).
2693     // For x64 this is 3, 5, 6, 7, >8 byte structs that are passed by reference.
2694     // For ARM64, this is structs larger than 16 bytes that are passed by reference.
2695     bool lvaIsImplicitByRefLocal(unsigned varNum)
2696     {
2697 #if defined(_TARGET_AMD64_) || defined(_TARGET_ARM64_)
2698         LclVarDsc* varDsc = &(lvaTable[varNum]);
2699         if (varDsc->lvIsParam && varDsc->lvIsTemp)
2700         {
2701             assert(varTypeIsStruct(varDsc) || (varDsc->lvType == TYP_BYREF));
2702             return true;
2703         }
2704 #endif // defined(_TARGET_AMD64_) || defined(_TARGET_ARM64_)
2705         return false;
2706     }
2707
2708     // Returns true if this local var is a multireg struct
2709     bool lvaIsMultiregStruct(LclVarDsc* varDsc);
2710
2711     // If the local is a TYP_STRUCT, get/set a class handle describing it
2712     CORINFO_CLASS_HANDLE lvaGetStruct(unsigned varNum);
2713     void lvaSetStruct(unsigned varNum, CORINFO_CLASS_HANDLE typeHnd, bool unsafeValueClsCheck, bool setTypeInfo = true);
2714
2715     // If the local is TYP_REF, set or update the associated class information.
2716     void lvaSetClass(unsigned varNum, CORINFO_CLASS_HANDLE clsHnd, bool isExact = false);
2717     void lvaSetClass(unsigned varNum, GenTreePtr tree, CORINFO_CLASS_HANDLE stackHandle = nullptr);
2718     void lvaUpdateClass(unsigned varNum, CORINFO_CLASS_HANDLE clsHnd, bool isExact = false);
2719     void lvaUpdateClass(unsigned varNum, GenTreePtr tree, CORINFO_CLASS_HANDLE stackHandle = nullptr);
2720
2721 #define MAX_NumOfFieldsInPromotableStruct 4 // Maximum number of fields in promotable struct
2722
2723     // Info about struct fields
2724     struct lvaStructFieldInfo
2725     {
2726         CORINFO_FIELD_HANDLE fldHnd;
2727         unsigned char        fldOffset;
2728         unsigned char        fldOrdinal;
2729         var_types            fldType;
2730         unsigned             fldSize;
2731         CORINFO_CLASS_HANDLE fldTypeHnd;
2732     };
2733
2734     // Info about struct to be promoted.
2735     struct lvaStructPromotionInfo
2736     {
2737         CORINFO_CLASS_HANDLE typeHnd;
2738         bool                 canPromote;
2739         bool                 requiresScratchVar;
2740         bool                 containsHoles;
2741         bool                 customLayout;
2742         unsigned char        fieldCnt;
2743         lvaStructFieldInfo   fields[MAX_NumOfFieldsInPromotableStruct];
2744
2745         lvaStructPromotionInfo()
2746             : typeHnd(nullptr), canPromote(false), requiresScratchVar(false), containsHoles(false), customLayout(false)
2747         {
2748         }
2749     };
2750
2751     static int __cdecl lvaFieldOffsetCmp(const void* field1, const void* field2);
2752     void lvaCanPromoteStructType(CORINFO_CLASS_HANDLE    typeHnd,
2753                                  lvaStructPromotionInfo* StructPromotionInfo,
2754                                  bool                    sortFields);
2755     void lvaCanPromoteStructVar(unsigned lclNum, lvaStructPromotionInfo* StructPromotionInfo);
2756     bool lvaShouldPromoteStructVar(unsigned lclNum, lvaStructPromotionInfo* structPromotionInfo);
2757     void lvaPromoteStructVar(unsigned lclNum, lvaStructPromotionInfo* StructPromotionInfo);
2758 #if !defined(_TARGET_64BIT_)
2759     void lvaPromoteLongVars();
2760 #endif // !defined(_TARGET_64BIT_)
2761     unsigned lvaGetFieldLocal(LclVarDsc* varDsc, unsigned int fldOffset);
2762     lvaPromotionType lvaGetPromotionType(const LclVarDsc* varDsc);
2763     lvaPromotionType lvaGetPromotionType(unsigned varNum);
2764     lvaPromotionType lvaGetParentPromotionType(const LclVarDsc* varDsc);
2765     lvaPromotionType lvaGetParentPromotionType(unsigned varNum);
2766     bool lvaIsFieldOfDependentlyPromotedStruct(const LclVarDsc* varDsc);
2767     bool lvaIsGCTracked(const LclVarDsc* varDsc);
2768
2769 #if defined(FEATURE_SIMD)
2770     bool lvaMapSimd12ToSimd16(const LclVarDsc* varDsc)
2771     {
2772         assert(varDsc->lvType == TYP_SIMD12);
2773         assert(varDsc->lvExactSize == 12);
2774
2775 #if defined(_TARGET_64BIT_)
2776         assert(varDsc->lvSize() == 16);
2777 #endif // defined(_TARGET_64BIT_)
2778
2779         // We make local variable SIMD12 types 16 bytes instead of just 12. lvSize()
2780         // already does this calculation. However, we also need to prevent mapping types if the var is a
2781         // dependently promoted struct field, which must remain its exact size within its parent struct.
2782         // However, we don't know this until late, so we may have already pretended the field is bigger
2783         // before that.
2784         if ((varDsc->lvSize() == 16) && !lvaIsFieldOfDependentlyPromotedStruct(varDsc))
2785         {
2786             return true;
2787         }
2788         else
2789         {
2790             return false;
2791         }
2792     }
2793 #endif // defined(FEATURE_SIMD)
2794
2795     BYTE* lvaGetGcLayout(unsigned varNum);
2796     bool lvaTypeIsGC(unsigned varNum);
2797     unsigned lvaGSSecurityCookie; // LclVar number
2798     bool     lvaTempsHaveLargerOffsetThanVars();
2799
2800     unsigned lvaSecurityObject;  // variable representing the security object on the stack
2801     unsigned lvaStubArgumentVar; // variable representing the secret stub argument coming in EAX
2802
2803 #if FEATURE_EH_FUNCLETS
2804     unsigned lvaPSPSym; // variable representing the PSPSym
2805 #endif
2806
2807     InlineInfo*     impInlineInfo;
2808     InlineStrategy* m_inlineStrategy;
2809
2810     // The Compiler* that is the root of the inlining tree of which "this" is a member.
2811     Compiler* impInlineRoot();
2812
2813 #if defined(DEBUG) || defined(INLINE_DATA)
2814     unsigned __int64 getInlineCycleCount()
2815     {
2816         return m_compCycles;
2817     }
2818 #endif // defined(DEBUG) || defined(INLINE_DATA)
2819
2820     bool fgNoStructPromotion;      // Set to TRUE to turn off struct promotion for this method.
2821     bool fgNoStructParamPromotion; // Set to TRUE to turn off struct promotion for parameters this method.
2822
2823     //=========================================================================
2824     //                          PROTECTED
2825     //=========================================================================
2826
2827 protected:
2828 //---------------- Local variable ref-counting ----------------------------
2829
2830 #if ASSERTION_PROP
2831     BasicBlock* lvaMarkRefsCurBlock;
2832     GenTreePtr  lvaMarkRefsCurStmt;
2833 #endif
2834     BasicBlock::weight_t lvaMarkRefsWeight;
2835
2836     void lvaMarkLclRefs(GenTreePtr tree);
2837
2838     bool IsDominatedByExceptionalEntry(BasicBlock* block);
2839     void SetVolatileHint(LclVarDsc* varDsc);
2840
2841     // Keeps the mapping from SSA #'s to VN's for the implicit memory variables.
2842     PerSsaArray lvMemoryPerSsaData;
2843     unsigned    lvMemoryNumSsaNames;
2844
2845 public:
2846     // Returns the address of the per-Ssa data for memory at the given ssaNum (which is required
2847     // not to be the SsaConfig::RESERVED_SSA_NUM, which indicates that the variable is
2848     // not an SSA variable).
2849     LclSsaVarDsc* GetMemoryPerSsaData(unsigned ssaNum)
2850     {
2851         assert(ssaNum != SsaConfig::RESERVED_SSA_NUM);
2852         assert(SsaConfig::RESERVED_SSA_NUM == 0);
2853         ssaNum--;
2854         assert(ssaNum < lvMemoryNumSsaNames);
2855         return &lvMemoryPerSsaData.GetRef(ssaNum);
2856     }
2857
2858     /*
2859     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2860     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2861     XX                                                                           XX
2862     XX                           Importer                                        XX
2863     XX                                                                           XX
2864     XX   Imports the given method and converts it to semantic trees              XX
2865     XX                                                                           XX
2866     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2867     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2868     */
2869
2870 public:
2871     void impInit();
2872
2873     void impImport(BasicBlock* method);
2874
2875     CORINFO_CLASS_HANDLE impGetRefAnyClass();
2876     CORINFO_CLASS_HANDLE impGetRuntimeArgumentHandle();
2877     CORINFO_CLASS_HANDLE impGetTypeHandleClass();
2878     CORINFO_CLASS_HANDLE impGetStringClass();
2879     CORINFO_CLASS_HANDLE impGetObjectClass();
2880
2881     //=========================================================================
2882     //                          PROTECTED
2883     //=========================================================================
2884
2885 protected:
2886     //-------------------- Stack manipulation ---------------------------------
2887
2888     unsigned impStkSize; // Size of the full stack
2889
2890 #define SMALL_STACK_SIZE 16 // number of elements in impSmallStack
2891
2892     StackEntry impSmallStack[SMALL_STACK_SIZE]; // Use this array if possible
2893
2894     struct SavedStack // used to save/restore stack contents.
2895     {
2896         unsigned    ssDepth; // number of values on stack
2897         StackEntry* ssTrees; // saved tree values
2898     };
2899
2900     bool impIsPrimitive(CorInfoType type);
2901     bool impILConsumesAddr(const BYTE* codeAddr, CORINFO_METHOD_HANDLE fncHandle, CORINFO_MODULE_HANDLE scpHandle);
2902
2903     void impResolveToken(const BYTE* addr, CORINFO_RESOLVED_TOKEN* pResolvedToken, CorInfoTokenKind kind);
2904
2905     void impPushOnStack(GenTreePtr tree, typeInfo ti);
2906     void        impPushNullObjRefOnStack();
2907     StackEntry  impPopStack();
2908     StackEntry& impStackTop(unsigned n = 0);
2909     unsigned impStackHeight();
2910
2911     void impSaveStackState(SavedStack* savePtr, bool copy);
2912     void impRestoreStackState(SavedStack* savePtr);
2913
2914     GenTreePtr impImportLdvirtftn(GenTreePtr              thisPtr,
2915                                   CORINFO_RESOLVED_TOKEN* pResolvedToken,
2916                                   CORINFO_CALL_INFO*      pCallInfo);
2917
2918     void impImportAndPushBox(CORINFO_RESOLVED_TOKEN* pResolvedToken);
2919
2920     void impImportNewObjArray(CORINFO_RESOLVED_TOKEN* pResolvedToken, CORINFO_CALL_INFO* pCallInfo);
2921
2922     bool impCanPInvokeInline();
2923     bool impCanPInvokeInlineCallSite(BasicBlock* block);
2924     void impCheckForPInvokeCall(
2925         GenTreeCall* call, CORINFO_METHOD_HANDLE methHnd, CORINFO_SIG_INFO* sig, unsigned mflags, BasicBlock* block);
2926     GenTreeCall* impImportIndirectCall(CORINFO_SIG_INFO* sig, IL_OFFSETX ilOffset = BAD_IL_OFFSET);
2927     void impPopArgsForUnmanagedCall(GenTreePtr call, CORINFO_SIG_INFO* sig);
2928
2929     void impInsertHelperCall(CORINFO_HELPER_DESC* helperCall);
2930     void impHandleAccessAllowed(CorInfoIsAccessAllowedResult result, CORINFO_HELPER_DESC* helperCall);
2931     void impHandleAccessAllowedInternal(CorInfoIsAccessAllowedResult result, CORINFO_HELPER_DESC* helperCall);
2932
2933     var_types impImportCall(OPCODE                  opcode,
2934                             CORINFO_RESOLVED_TOKEN* pResolvedToken,
2935                             CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken, // Is this a "constrained." call on a
2936                                                                                // type parameter?
2937                             GenTreePtr         newobjThis,
2938                             int                prefixFlags,
2939                             CORINFO_CALL_INFO* callInfo,
2940                             IL_OFFSET          rawILOffset);
2941
2942     void impDevirtualizeCall(GenTreeCall*            call,
2943                              GenTreePtr              thisObj,
2944                              CORINFO_METHOD_HANDLE*  method,
2945                              unsigned*               methodFlags,
2946                              CORINFO_CONTEXT_HANDLE* contextHandle,
2947                              CORINFO_CONTEXT_HANDLE* exactContextHandle);
2948
2949     bool impMethodInfo_hasRetBuffArg(CORINFO_METHOD_INFO* methInfo);
2950
2951     GenTreePtr impFixupCallStructReturn(GenTreeCall* call, CORINFO_CLASS_HANDLE retClsHnd);
2952
2953     GenTreePtr impFixupStructReturnType(GenTreePtr op, CORINFO_CLASS_HANDLE retClsHnd);
2954
2955 #ifdef DEBUG
2956     var_types impImportJitTestLabelMark(int numArgs);
2957 #endif // DEBUG
2958
2959     GenTreePtr impInitClass(CORINFO_RESOLVED_TOKEN* pResolvedToken);
2960
2961     GenTreePtr impImportStaticReadOnlyField(void* fldAddr, var_types lclTyp);
2962
2963     GenTreePtr impImportStaticFieldAccess(CORINFO_RESOLVED_TOKEN* pResolvedToken,
2964                                           CORINFO_ACCESS_FLAGS    access,
2965                                           CORINFO_FIELD_INFO*     pFieldInfo,
2966                                           var_types               lclTyp);
2967
2968     static void impBashVarAddrsToI(GenTreePtr tree1, GenTreePtr tree2 = nullptr);
2969
2970     GenTreePtr impImplicitIorI4Cast(GenTreePtr tree, var_types dstTyp);
2971
2972     GenTreePtr impImplicitR4orR8Cast(GenTreePtr tree, var_types dstTyp);
2973
2974     void impImportLeave(BasicBlock* block);
2975     void impResetLeaveBlock(BasicBlock* block, unsigned jmpAddr);
2976     GenTreePtr impIntrinsic(GenTreePtr            newobjThis,
2977                             CORINFO_CLASS_HANDLE  clsHnd,
2978                             CORINFO_METHOD_HANDLE method,
2979                             CORINFO_SIG_INFO*     sig,
2980                             int                   memberRef,
2981                             bool                  readonlyCall,
2982                             bool                  tailCall,
2983                             CorInfoIntrinsics*    pIntrinsicID);
2984     GenTreePtr impArrayAccessIntrinsic(CORINFO_CLASS_HANDLE clsHnd,
2985                                        CORINFO_SIG_INFO*    sig,
2986                                        int                  memberRef,
2987                                        bool                 readonlyCall,
2988                                        CorInfoIntrinsics    intrinsicID);
2989     GenTreePtr impInitializeArrayIntrinsic(CORINFO_SIG_INFO* sig);
2990
2991     GenTreePtr impMethodPointer(CORINFO_RESOLVED_TOKEN* pResolvedToken, CORINFO_CALL_INFO* pCallInfo);
2992
2993     GenTreePtr impTransformThis(GenTreePtr              thisPtr,
2994                                 CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken,
2995                                 CORINFO_THIS_TRANSFORM  transform);
2996
2997     //----------------- Manipulating the trees and stmts ----------------------
2998
2999     GenTreePtr impTreeList; // Trees for the BB being imported
3000     GenTreePtr impTreeLast; // The last tree for the current BB
3001
3002     enum
3003     {
3004         CHECK_SPILL_ALL  = -1,
3005         CHECK_SPILL_NONE = -2
3006     };
3007
3008 public:
3009     void impBeginTreeList();
3010     void impEndTreeList(BasicBlock* block, GenTreePtr firstStmt, GenTreePtr lastStmt);
3011     void impEndTreeList(BasicBlock* block);
3012     void impAppendStmtCheck(GenTreePtr stmt, unsigned chkLevel);
3013     void impAppendStmt(GenTreePtr stmt, unsigned chkLevel);
3014     void impInsertStmtBefore(GenTreePtr stmt, GenTreePtr stmtBefore);
3015     GenTreePtr impAppendTree(GenTreePtr tree, unsigned chkLevel, IL_OFFSETX offset);
3016     void impInsertTreeBefore(GenTreePtr tree, IL_OFFSETX offset, GenTreePtr stmtBefore);
3017     void impAssignTempGen(unsigned    tmp,
3018                           GenTreePtr  val,
3019                           unsigned    curLevel,
3020                           GenTreePtr* pAfterStmt = nullptr,
3021                           IL_OFFSETX  ilOffset   = BAD_IL_OFFSET,
3022                           BasicBlock* block      = nullptr);
3023     void impAssignTempGen(unsigned             tmpNum,
3024                           GenTreePtr           val,
3025                           CORINFO_CLASS_HANDLE structHnd,
3026                           unsigned             curLevel,
3027                           GenTreePtr*          pAfterStmt = nullptr,
3028                           IL_OFFSETX           ilOffset   = BAD_IL_OFFSET,
3029                           BasicBlock*          block      = nullptr);
3030     GenTreePtr impCloneExpr(GenTreePtr           tree,
3031                             GenTreePtr*          clone,
3032                             CORINFO_CLASS_HANDLE structHnd,
3033                             unsigned             curLevel,
3034                             GenTreePtr* pAfterStmt DEBUGARG(const char* reason));
3035     GenTreePtr impAssignStruct(GenTreePtr           dest,
3036                                GenTreePtr           src,
3037                                CORINFO_CLASS_HANDLE structHnd,
3038                                unsigned             curLevel,
3039                                GenTreePtr*          pAfterStmt = nullptr,
3040                                BasicBlock*          block      = nullptr);
3041     GenTreePtr impAssignStructPtr(GenTreePtr           dest,
3042                                   GenTreePtr           src,
3043                                   CORINFO_CLASS_HANDLE structHnd,
3044                                   unsigned             curLevel,
3045                                   GenTreePtr*          pAfterStmt = nullptr,
3046                                   BasicBlock*          block      = nullptr);
3047
3048     GenTreePtr impGetStructAddr(GenTreePtr           structVal,
3049                                 CORINFO_CLASS_HANDLE structHnd,
3050                                 unsigned             curLevel,
3051                                 bool                 willDeref);
3052
3053     var_types impNormStructType(CORINFO_CLASS_HANDLE structHnd,
3054                                 BYTE*                gcLayout     = nullptr,
3055                                 unsigned*            numGCVars    = nullptr,
3056                                 var_types*           simdBaseType = nullptr);
3057
3058     GenTreePtr impNormStructVal(GenTreePtr           structVal,
3059                                 CORINFO_CLASS_HANDLE structHnd,
3060                                 unsigned             curLevel,
3061                                 bool                 forceNormalization = false);
3062
3063     GenTreePtr impTokenToHandle(CORINFO_RESOLVED_TOKEN* pResolvedToken,
3064                                 BOOL*                   pRuntimeLookup    = nullptr,
3065                                 BOOL                    mustRestoreHandle = FALSE,
3066                                 BOOL                    importParent      = FALSE);
3067
3068     GenTreePtr impParentClassTokenToHandle(CORINFO_RESOLVED_TOKEN* pResolvedToken,
3069                                            BOOL*                   pRuntimeLookup    = nullptr,
3070                                            BOOL                    mustRestoreHandle = FALSE)
3071     {
3072         return impTokenToHandle(pResolvedToken, pRuntimeLookup, mustRestoreHandle, TRUE);
3073     }
3074
3075     GenTreePtr impLookupToTree(CORINFO_RESOLVED_TOKEN* pResolvedToken,
3076                                CORINFO_LOOKUP*         pLookup,
3077                                unsigned                flags,
3078                                void*                   compileTimeHandle);
3079
3080     GenTreePtr getRuntimeContextTree(CORINFO_RUNTIME_LOOKUP_KIND kind);
3081
3082     GenTreePtr impRuntimeLookupToTree(CORINFO_RESOLVED_TOKEN* pResolvedToken,
3083                                       CORINFO_LOOKUP*         pLookup,
3084                                       void*                   compileTimeHandle);
3085
3086     GenTreePtr impReadyToRunLookupToTree(CORINFO_CONST_LOOKUP* pLookup, unsigned flags, void* compileTimeHandle);
3087
3088     GenTreeCall* impReadyToRunHelperToTree(CORINFO_RESOLVED_TOKEN* pResolvedToken,
3089                                            CorInfoHelpFunc         helper,
3090                                            var_types               type,
3091                                            GenTreeArgList*         arg                = nullptr,
3092                                            CORINFO_LOOKUP_KIND*    pGenericLookupKind = nullptr);
3093
3094     GenTreePtr impCastClassOrIsInstToTree(GenTreePtr              op1,
3095                                           GenTreePtr              op2,
3096                                           CORINFO_RESOLVED_TOKEN* pResolvedToken,
3097                                           bool                    isCastClass);
3098
3099     bool VarTypeIsMultiByteAndCanEnreg(var_types            type,
3100                                        CORINFO_CLASS_HANDLE typeClass,
3101                                        unsigned*            typeSize,
3102                                        bool                 forReturn);
3103
3104     static bool IsIntrinsicImplementedByUserCall(CorInfoIntrinsics intrinsicId);
3105     static bool IsTargetIntrinsic(CorInfoIntrinsics intrinsicId);
3106     static bool IsMathIntrinsic(CorInfoIntrinsics intrinsicId);
3107     static bool IsMathIntrinsic(GenTreePtr tree);
3108
3109 private:
3110     //----------------- Importing the method ----------------------------------
3111
3112     CORINFO_CONTEXT_HANDLE impTokenLookupContextHandle; // The context used for looking up tokens.
3113
3114 #ifdef DEBUG
3115     unsigned    impCurOpcOffs;
3116     const char* impCurOpcName;
3117     bool        impNestedStackSpill;
3118
3119     // For displaying instrs with generated native code (-n:B)
3120     GenTreePtr impLastILoffsStmt; // oldest stmt added for which we did not gtStmtLastILoffs
3121     void       impNoteLastILoffs();
3122 #endif
3123
3124     /* IL offset of the stmt currently being imported. It gets set to
3125        BAD_IL_OFFSET after it has been set in the appended trees. Then it gets
3126        updated at IL offsets for which we have to report mapping info.
3127        It also includes flag bits, so use jitGetILoffs()
3128        to get the actual IL offset value.
3129     */
3130
3131     IL_OFFSETX impCurStmtOffs;
3132     void impCurStmtOffsSet(IL_OFFSET offs);
3133
3134     void impNoteBranchOffs();
3135
3136     unsigned impInitBlockLineInfo();
3137
3138     GenTreePtr impCheckForNullPointer(GenTreePtr obj);
3139     bool impIsThis(GenTreePtr obj);
3140     bool impIsLDFTN_TOKEN(const BYTE* delegateCreateStart, const BYTE* newobjCodeAddr);
3141     bool impIsDUP_LDVIRTFTN_TOKEN(const BYTE* delegateCreateStart, const BYTE* newobjCodeAddr);
3142     bool impIsAnySTLOC(OPCODE opcode)
3143     {
3144         return ((opcode == CEE_STLOC) || (opcode == CEE_STLOC_S) ||
3145                 ((opcode >= CEE_STLOC_0) && (opcode <= CEE_STLOC_3)));
3146     }
3147
3148     GenTreeArgList* impPopList(unsigned count, CORINFO_SIG_INFO* sig, GenTreeArgList* prefixTree = nullptr);
3149
3150     GenTreeArgList* impPopRevList(unsigned count, CORINFO_SIG_INFO* sig, unsigned skipReverseCount = 0);
3151
3152     /*
3153      * Get current IL offset with stack-empty info incoporated
3154      */
3155     IL_OFFSETX impCurILOffset(IL_OFFSET offs, bool callInstruction = false);
3156
3157     //---------------- Spilling the importer stack ----------------------------
3158
3159     // The maximum number of bytes of IL processed without clean stack state.
3160     // It allows to limit the maximum tree size and depth.
3161     static const unsigned MAX_TREE_SIZE = 200;
3162     bool impCanSpillNow(OPCODE prevOpcode);
3163
3164     struct PendingDsc
3165     {
3166         PendingDsc*   pdNext;
3167         BasicBlock*   pdBB;
3168         SavedStack    pdSavedStack;
3169         ThisInitState pdThisPtrInit;
3170     };
3171
3172     PendingDsc* impPendingList; // list of BBs currently waiting to be imported.
3173     PendingDsc* impPendingFree; // Freed up dscs that can be reused
3174
3175     // We keep a byte-per-block map (dynamically extended) in the top-level Compiler object of a compilation.
3176     ExpandArray<BYTE> impPendingBlockMembers;
3177
3178     // Return the byte for "b" (allocating/extending impPendingBlockMembers if necessary.)
3179     // Operates on the map in the top-level ancestor.
3180     BYTE impGetPendingBlockMember(BasicBlock* blk)
3181     {
3182         return impInlineRoot()->impPendingBlockMembers.Get(blk->bbInd());
3183     }
3184
3185     // Set the byte for "b" to "val" (allocating/extending impPendingBlockMembers if necessary.)
3186     // Operates on the map in the top-level ancestor.
3187     void impSetPendingBlockMember(BasicBlock* blk, BYTE val)
3188     {
3189         impInlineRoot()->impPendingBlockMembers.Set(blk->bbInd(), val);
3190     }
3191
3192     bool impCanReimport;
3193
3194     bool impSpillStackEntry(unsigned level,
3195                             unsigned varNum
3196 #ifdef DEBUG
3197                             ,
3198                             bool        bAssertOnRecursion,
3199                             const char* reason
3200 #endif
3201                             );
3202
3203     void impSpillStackEnsure(bool spillLeaves = false);
3204     void impEvalSideEffects();
3205     void impSpillSpecialSideEff();
3206     void impSpillSideEffects(bool spillGlobEffects, unsigned chkLevel DEBUGARG(const char* reason));
3207     void               impSpillValueClasses();
3208     void               impSpillEvalStack();
3209     static fgWalkPreFn impFindValueClasses;
3210     void impSpillLclRefs(ssize_t lclNum);
3211
3212     BasicBlock* impPushCatchArgOnStack(BasicBlock* hndBlk, CORINFO_CLASS_HANDLE clsHnd, bool isSingleBlockFilter);
3213
3214     void impImportBlockCode(BasicBlock* block);
3215
3216     void impReimportMarkBlock(BasicBlock* block);
3217     void impReimportMarkSuccessors(BasicBlock* block);
3218
3219     void impVerifyEHBlock(BasicBlock* block, bool isTryStart);
3220
3221     void impImportBlockPending(BasicBlock* block);
3222
3223     // Similar to impImportBlockPending, but assumes that block has already been imported once and is being
3224     // reimported for some reason.  It specifically does *not* look at verCurrentState to set the EntryState
3225     // for the block, but instead, just re-uses the block's existing EntryState.
3226     void impReimportBlockPending(BasicBlock* block);
3227
3228     var_types impGetByRefResultType(genTreeOps oper, bool fUnsigned, GenTreePtr* pOp1, GenTreePtr* pOp2);
3229
3230     void impImportBlock(BasicBlock* block);
3231
3232     // Assumes that "block" is a basic block that completes with a non-empty stack. We will assign the values
3233     // on the stack to local variables (the "spill temp" variables). The successor blocks will assume that
3234     // its incoming stack contents are in those locals. This requires "block" and its successors to agree on
3235     // the variables that will be used -- and for all the predecessors of those successors, and the
3236     // successors of those predecessors, etc. Call such a set of blocks closed under alternating
3237     // successor/predecessor edges a "spill clique." A block is a "predecessor" or "successor" member of the
3238     // clique (or, conceivably, both). Each block has a specified sequence of incoming and outgoing spill
3239     // temps. If "block" already has its outgoing spill temps assigned (they are always a contiguous series
3240     // of local variable numbers, so we represent them with the base local variable number), returns that.
3241     // Otherwise, picks a set of spill temps, and propagates this choice to all blocks in the spill clique of
3242     // which "block" is a member (asserting, in debug mode, that no block in this clique had its spill temps
3243     // chosen already. More precisely, that the incoming or outgoing spill temps are not chosen, depending
3244     // on which kind of member of the clique the block is).
3245     unsigned impGetSpillTmpBase(BasicBlock* block);
3246
3247     // Assumes that "block" is a basic block that completes with a non-empty stack. We have previously
3248     // assigned the values on the stack to local variables (the "spill temp" variables). The successor blocks
3249     // will assume that its incoming stack contents are in those locals. This requires "block" and its
3250     // successors to agree on the variables and their types that will be used.  The CLI spec allows implicit
3251     // conversions between 'int' and 'native int' or 'float' and 'double' stack types. So one predecessor can
3252     // push an int and another can push a native int.  For 64-bit we have chosen to implement this by typing
3253     // the "spill temp" as native int, and then importing (or re-importing as needed) so that all the
3254     // predecessors in the "spill clique" push a native int (sign-extending if needed), and all the
3255     // successors receive a native int. Similarly float and double are unified to double.
3256     // This routine is called after a type-mismatch is detected, and it will walk the spill clique to mark
3257     // blocks for re-importation as appropriate (both successors, so they get the right incoming type, and
3258     // predecessors, so they insert an upcast if needed).
3259     void impReimportSpillClique(BasicBlock* block);
3260
3261     // When we compute a "spill clique" (see above) these byte-maps are allocated to have a byte per basic
3262     // block, and represent the predecessor and successor members of the clique currently being computed.
3263     // *** Access to these will need to be locked in a parallel compiler.
3264     ExpandArray<BYTE> impSpillCliquePredMembers;
3265     ExpandArray<BYTE> impSpillCliqueSuccMembers;
3266
3267     enum SpillCliqueDir
3268     {
3269         SpillCliquePred,
3270         SpillCliqueSucc
3271     };
3272
3273     // Abstract class for receiving a callback while walking a spill clique
3274     class SpillCliqueWalker
3275     {
3276     public:
3277         virtual void Visit(SpillCliqueDir predOrSucc, BasicBlock* blk) = 0;
3278     };
3279
3280     // This class is used for setting the bbStkTempsIn and bbStkTempsOut on the blocks within a spill clique
3281     class SetSpillTempsBase : public SpillCliqueWalker
3282     {
3283         unsigned m_baseTmp;
3284
3285     public:
3286         SetSpillTempsBase(unsigned baseTmp) : m_baseTmp(baseTmp)
3287         {
3288         }
3289         virtual void Visit(SpillCliqueDir predOrSucc, BasicBlock* blk);
3290     };
3291
3292     // This class is used for implementing impReimportSpillClique part on each block within the spill clique
3293     class ReimportSpillClique : public SpillCliqueWalker
3294     {
3295         Compiler* m_pComp;
3296
3297     public:
3298         ReimportSpillClique(Compiler* pComp) : m_pComp(pComp)
3299         {
3300         }
3301         virtual void Visit(SpillCliqueDir predOrSucc, BasicBlock* blk);
3302     };
3303
3304     // This is the heart of the algorithm for walking spill cliques. It invokes callback->Visit for each
3305     // predecessor or successor within the spill clique
3306     void impWalkSpillCliqueFromPred(BasicBlock* pred, SpillCliqueWalker* callback);
3307
3308     // For a BasicBlock that has already been imported, the EntryState has an array of GenTrees for the
3309     // incoming locals. This walks that list an resets the types of the GenTrees to match the types of
3310     // the VarDscs. They get out of sync when we have int/native int issues (see impReimportSpillClique).
3311     void impRetypeEntryStateTemps(BasicBlock* blk);
3312
3313     BYTE impSpillCliqueGetMember(SpillCliqueDir predOrSucc, BasicBlock* blk);
3314     void impSpillCliqueSetMember(SpillCliqueDir predOrSucc, BasicBlock* blk, BYTE val);
3315
3316     void impPushVar(GenTree* op, typeInfo tiRetVal);
3317     void impLoadVar(unsigned lclNum, IL_OFFSET offset, typeInfo tiRetVal);
3318     void impLoadVar(unsigned lclNum, IL_OFFSET offset)
3319     {
3320         impLoadVar(lclNum, offset, lvaTable[lclNum].lvVerTypeInfo);
3321     }
3322     void impLoadArg(unsigned ilArgNum, IL_OFFSET offset);
3323     void impLoadLoc(unsigned ilLclNum, IL_OFFSET offset);
3324     bool impReturnInstruction(BasicBlock* block, int prefixFlags, OPCODE& opcode);
3325
3326 #ifdef _TARGET_ARM_
3327     void impMarkLclDstNotPromotable(unsigned tmpNum, GenTreePtr op, CORINFO_CLASS_HANDLE hClass);
3328 #endif
3329
3330     // A free list of linked list nodes used to represent to-do stacks of basic blocks.
3331     struct BlockListNode
3332     {
3333         BasicBlock*    m_blk;
3334         BlockListNode* m_next;
3335         BlockListNode(BasicBlock* blk, BlockListNode* next = nullptr) : m_blk(blk), m_next(next)
3336         {
3337         }
3338         void* operator new(size_t sz, Compiler* comp);
3339     };
3340     BlockListNode* impBlockListNodeFreeList;
3341
3342     BlockListNode* AllocBlockListNode();
3343     void FreeBlockListNode(BlockListNode* node);
3344
3345     bool impIsValueType(typeInfo* pTypeInfo);
3346     var_types mangleVarArgsType(var_types type);
3347
3348 #if FEATURE_VARARG
3349     regNumber getCallArgIntRegister(regNumber floatReg);
3350     regNumber getCallArgFloatRegister(regNumber intReg);
3351 #endif // FEATURE_VARARG
3352
3353 #if defined(DEBUG)
3354     static unsigned jitTotalMethodCompiled;
3355 #endif
3356
3357 #ifdef DEBUG
3358     static LONG jitNestingLevel;
3359 #endif // DEBUG
3360
3361     static BOOL impIsAddressInLocal(GenTreePtr tree, GenTreePtr* lclVarTreeOut);
3362
3363     void impMakeDiscretionaryInlineObservations(InlineInfo* pInlineInfo, InlineResult* inlineResult);
3364
3365     // STATIC inlining decision based on the IL code.
3366     void impCanInlineIL(CORINFO_METHOD_HANDLE fncHandle,
3367                         CORINFO_METHOD_INFO*  methInfo,
3368                         bool                  forceInline,
3369                         InlineResult*         inlineResult);
3370
3371     void impCheckCanInline(GenTreePtr             call,
3372                            CORINFO_METHOD_HANDLE  fncHandle,
3373                            unsigned               methAttr,
3374                            CORINFO_CONTEXT_HANDLE exactContextHnd,
3375                            InlineCandidateInfo**  ppInlineCandidateInfo,
3376                            InlineResult*          inlineResult);
3377
3378     void impInlineRecordArgInfo(InlineInfo*   pInlineInfo,
3379                                 GenTreePtr    curArgVal,
3380                                 unsigned      argNum,
3381                                 InlineResult* inlineResult);
3382
3383     void impInlineInitVars(InlineInfo* pInlineInfo);
3384
3385     unsigned impInlineFetchLocal(unsigned lclNum DEBUGARG(const char* reason));
3386
3387     GenTreePtr impInlineFetchArg(unsigned lclNum, InlArgInfo* inlArgInfo, InlLclVarInfo* lclTypeInfo);
3388
3389     BOOL impInlineIsThis(GenTreePtr tree, InlArgInfo* inlArgInfo);
3390
3391     BOOL impInlineIsGuaranteedThisDerefBeforeAnySideEffects(GenTreePtr  additionalTreesToBeEvaluatedBefore,
3392                                                             GenTreePtr  variableBeingDereferenced,
3393                                                             InlArgInfo* inlArgInfo);
3394
3395     void impMarkInlineCandidate(GenTreePtr             call,
3396                                 CORINFO_CONTEXT_HANDLE exactContextHnd,
3397                                 bool                   exactContextNeedsRuntimeLookup,
3398                                 CORINFO_CALL_INFO*     callInfo);
3399
3400     bool impTailCallRetTypeCompatible(var_types            callerRetType,
3401                                       CORINFO_CLASS_HANDLE callerRetTypeClass,
3402                                       var_types            calleeRetType,
3403                                       CORINFO_CLASS_HANDLE calleeRetTypeClass);
3404
3405     bool impIsTailCallILPattern(bool        tailPrefixed,
3406                                 OPCODE      curOpcode,
3407                                 const BYTE* codeAddrOfNextOpcode,
3408                                 const BYTE* codeEnd,
3409                                 bool        isRecursive,
3410                                 bool*       IsCallPopRet = nullptr);
3411
3412     bool impIsImplicitTailCallCandidate(
3413         OPCODE curOpcode, const BYTE* codeAddrOfNextOpcode, const BYTE* codeEnd, int prefixFlags, bool isRecursive);
3414
3415     CORINFO_RESOLVED_TOKEN* impAllocateToken(CORINFO_RESOLVED_TOKEN token);
3416
3417     /*
3418     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3419     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3420     XX                                                                           XX
3421     XX                           FlowGraph                                       XX
3422     XX                                                                           XX
3423     XX   Info about the basic-blocks, their contents and the flow analysis       XX
3424     XX                                                                           XX
3425     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3426     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3427     */
3428
3429 public:
3430     BasicBlock* fgFirstBB;        // Beginning of the basic block list
3431     BasicBlock* fgLastBB;         // End of the basic block list
3432     BasicBlock* fgFirstColdBlock; // First block to be placed in the cold section
3433 #if FEATURE_EH_FUNCLETS
3434     BasicBlock* fgFirstFuncletBB; // First block of outlined funclets (to allow block insertion before the funclets)
3435 #endif
3436     BasicBlock* fgFirstBBScratch;   // Block inserted for initialization stuff. Is nullptr if no such block has been
3437                                     // created.
3438     BasicBlockList* fgReturnBlocks; // list of BBJ_RETURN blocks
3439     unsigned        fgEdgeCount;    // # of control flow edges between the BBs
3440     unsigned        fgBBcount;      // # of BBs in the method
3441 #ifdef DEBUG
3442     unsigned fgBBcountAtCodegen; // # of BBs in the method at the start of codegen
3443 #endif
3444     unsigned     fgBBNumMax;       // The max bbNum that has been assigned to basic blocks
3445     unsigned     fgDomBBcount;     // # of BBs for which we have dominator and reachability information
3446     BasicBlock** fgBBInvPostOrder; // The flow graph stored in an array sorted in topological order, needed to compute
3447                                    // dominance. Indexed by block number. Size: fgBBNumMax + 1.
3448
3449     // After the dominance tree is computed, we cache a DFS preorder number and DFS postorder number to compute
3450     // dominance queries in O(1). fgDomTreePreOrder and fgDomTreePostOrder are arrays giving the block's preorder and
3451     // postorder number, respectively. The arrays are indexed by basic block number. (Note that blocks are numbered
3452     // starting from one. Thus, we always waste element zero. This makes debugging easier and makes the code less likely
3453     // to suffer from bugs stemming from forgetting to add or subtract one from the block number to form an array
3454     // index). The arrays are of size fgBBNumMax + 1.
3455     unsigned* fgDomTreePreOrder;
3456     unsigned* fgDomTreePostOrder;
3457
3458     bool fgBBVarSetsInited;
3459
3460     // Allocate array like T* a = new T[fgBBNumMax + 1];
3461     // Using helper so we don't keep forgetting +1.
3462     template <typename T>
3463     T* fgAllocateTypeForEachBlk(CompMemKind cmk = CMK_Unknown)
3464     {
3465         return (T*)compGetMem((fgBBNumMax + 1) * sizeof(T), cmk);
3466     }
3467
3468     // BlockSets are relative to a specific set of BasicBlock numbers. If that changes
3469     // (if the blocks are renumbered), this changes. BlockSets from different epochs
3470     // cannot be meaningfully combined. Note that new blocks can be created with higher
3471     // block numbers without changing the basic block epoch. These blocks *cannot*
3472     // participate in a block set until the blocks are all renumbered, causing the epoch
3473     // to change. This is useful if continuing to use previous block sets is valuable.
3474     // If the epoch is zero, then it is uninitialized, and block sets can't be used.
3475     unsigned fgCurBBEpoch;
3476
3477     unsigned GetCurBasicBlockEpoch()
3478     {
3479         return fgCurBBEpoch;
3480     }
3481
3482     // The number of basic blocks in the current epoch. When the blocks are renumbered,
3483     // this is fgBBcount. As blocks are added, fgBBcount increases, fgCurBBEpochSize remains
3484     // the same, until a new BasicBlock epoch is created, such as when the blocks are all renumbered.
3485     unsigned fgCurBBEpochSize;
3486
3487     // The number of "size_t" elements required to hold a bitset large enough for fgCurBBEpochSize
3488     // bits. This is precomputed to avoid doing math every time BasicBlockBitSetTraits::GetArrSize() is called.
3489     unsigned fgBBSetCountInSizeTUnits;
3490
3491     void NewBasicBlockEpoch()
3492     {
3493         INDEBUG(unsigned oldEpochArrSize = fgBBSetCountInSizeTUnits);
3494
3495         // We have a new epoch. Compute and cache the size needed for new BlockSets.
3496         fgCurBBEpoch++;
3497         fgCurBBEpochSize = fgBBNumMax + 1;
3498         fgBBSetCountInSizeTUnits =
3499             unsigned(roundUp(fgCurBBEpochSize, sizeof(size_t) * 8)) / unsigned(sizeof(size_t) * 8);
3500
3501 #ifdef DEBUG
3502         // All BlockSet objects are now invalid!
3503         fgReachabilitySetsValid = false; // the bbReach sets are now invalid!
3504         fgEnterBlksSetValid     = false; // the fgEnterBlks set is now invalid!
3505
3506         if (verbose)
3507         {
3508             unsigned epochArrSize = BasicBlockBitSetTraits::GetArrSize(this, sizeof(size_t));
3509             printf("\nNew BlockSet epoch %d, # of blocks (including unused BB00): %u, bitset array size: %u (%s)",
3510                    fgCurBBEpoch, fgCurBBEpochSize, epochArrSize, (epochArrSize <= 1) ? "short" : "long");
3511             if ((fgCurBBEpoch != 1) && ((oldEpochArrSize <= 1) != (epochArrSize <= 1)))
3512             {
3513                 // If we're not just establishing the first epoch, and the epoch array size has changed such that we're
3514                 // going to change our bitset representation from short (just a size_t bitset) to long (a pointer to an
3515                 // array of size_t bitsets), then print that out.
3516                 printf("; NOTE: BlockSet size was previously %s!", (oldEpochArrSize <= 1) ? "short" : "long");
3517             }
3518             printf("\n");
3519         }
3520 #endif // DEBUG
3521     }
3522
3523     void EnsureBasicBlockEpoch()
3524     {
3525         if (fgCurBBEpochSize != fgBBNumMax + 1)
3526         {
3527             NewBasicBlockEpoch();
3528         }
3529     }
3530
3531     BasicBlock* fgNewBasicBlock(BBjumpKinds jumpKind);
3532     void fgEnsureFirstBBisScratch();
3533     bool fgFirstBBisScratch();
3534     bool fgBBisScratch(BasicBlock* block);
3535
3536     void fgExtendEHRegionBefore(BasicBlock* block);
3537     void fgExtendEHRegionAfter(BasicBlock* block);
3538
3539     BasicBlock* fgNewBBbefore(BBjumpKinds jumpKind, BasicBlock* block, bool extendRegion);
3540
3541     BasicBlock* fgNewBBafter(BBjumpKinds jumpKind, BasicBlock* block, bool extendRegion);
3542
3543     BasicBlock* fgNewBBinRegion(BBjumpKinds jumpKind,
3544                                 unsigned    tryIndex,
3545                                 unsigned    hndIndex,
3546                                 BasicBlock* nearBlk,
3547                                 bool        putInFilter = false,
3548                                 bool        runRarely   = false,
3549                                 bool        insertAtEnd = false);
3550
3551     BasicBlock* fgNewBBinRegion(BBjumpKinds jumpKind,
3552                                 BasicBlock* srcBlk,
3553                                 bool        runRarely   = false,
3554                                 bool        insertAtEnd = false);
3555
3556     BasicBlock* fgNewBBinRegion(BBjumpKinds jumpKind);
3557
3558     BasicBlock* fgNewBBinRegionWorker(BBjumpKinds jumpKind,
3559                                       BasicBlock* afterBlk,
3560                                       unsigned    xcptnIndex,
3561                                       bool        putInTryRegion);
3562
3563     void fgInsertBBbefore(BasicBlock* insertBeforeBlk, BasicBlock* newBlk);
3564     void fgInsertBBafter(BasicBlock* insertAfterBlk, BasicBlock* newBlk);
3565     void fgUnlinkBlock(BasicBlock* block);
3566
3567     unsigned fgMeasureIR();
3568
3569 #if OPT_BOOL_OPS // Used to detect multiple logical "not" assignments.
3570     bool fgMultipleNots;
3571 #endif
3572
3573     bool fgModified;         // True if the flow graph has been modified recently
3574     bool fgComputePredsDone; // Have we computed the bbPreds list
3575     bool fgCheapPredsValid;  // Is the bbCheapPreds list valid?
3576     bool fgDomsComputed;     // Have we computed the dominator sets?
3577     bool fgOptimizedFinally; // Did we optimize any try-finallys?
3578
3579     bool     fgHasSwitch;  // any BBJ_SWITCH jumps?
3580     bool     fgHasPostfix; // any postfix ++/-- found?
3581     unsigned fgIncrCount;  // number of increment nodes found
3582
3583     BlockSet fgEnterBlks; // Set of blocks which have a special transfer of control; the "entry" blocks plus EH handler
3584                           // begin blocks.
3585
3586 #ifdef DEBUG
3587     bool fgReachabilitySetsValid; // Are the bbReach sets valid?
3588     bool fgEnterBlksSetValid;     // Is the fgEnterBlks set valid?
3589 #endif                            // DEBUG
3590
3591     bool fgRemoveRestOfBlock; // true if we know that we will throw
3592     bool fgStmtRemoved;       // true if we remove statements -> need new DFA
3593
3594     // There are two modes for ordering of the trees.
3595     //  - In FGOrderTree, the dominant ordering is the tree order, and the nodes contained in
3596     //    each tree and sub-tree are contiguous, and can be traversed (in gtNext/gtPrev order)
3597     //    by traversing the tree according to the order of the operands.
3598     //  - In FGOrderLinear, the dominant ordering is the linear order.
3599
3600     enum FlowGraphOrder
3601     {
3602         FGOrderTree,
3603         FGOrderLinear
3604     };
3605     FlowGraphOrder fgOrder;
3606
3607     // The following are boolean flags that keep track of the state of internal data structures
3608
3609     bool                 fgStmtListThreaded;
3610     bool                 fgCanRelocateEHRegions;   // true if we are allowed to relocate the EH regions
3611     bool                 fgEdgeWeightsComputed;    // true after we have called fgComputeEdgeWeights
3612     bool                 fgHaveValidEdgeWeights;   // true if we were successful in computing all of the edge weights
3613     bool                 fgSlopUsedInEdgeWeights;  // true if their was some slop used when computing the edge weights
3614     bool                 fgRangeUsedInEdgeWeights; // true if some of the edgeWeight are expressed in Min..Max form
3615     bool                 fgNeedsUpdateFlowGraph;   // true if we need to run fgUpdateFlowGraph
3616     BasicBlock::weight_t fgCalledCount;            // count of the number of times this method was called
3617                                                    // This is derived from the profile data
3618                                                    // or is BB_UNITY_WEIGHT when we don't have profile data
3619
3620 #if FEATURE_EH_FUNCLETS
3621     bool fgFuncletsCreated; // true if the funclet creation phase has been run
3622 #endif                      // FEATURE_EH_FUNCLETS
3623
3624     bool fgGlobalMorph; // indicates if we are during the global morphing phase
3625                         // since fgMorphTree can be called from several places
3626
3627     bool     impBoxTempInUse; // the temp below is valid and available
3628     unsigned impBoxTemp;      // a temporary that is used for boxing
3629
3630 #ifdef DEBUG
3631     bool jitFallbackCompile; // Are we doing a fallback compile? That is, have we executed a NO_WAY assert,
3632                              //   and we are trying to compile again in a "safer", minopts mode?
3633 #endif
3634
3635 #if defined(DEBUG)
3636     unsigned impInlinedCodeSize;
3637 #endif
3638
3639     //-------------------------------------------------------------------------
3640
3641     void fgInit();
3642
3643     void fgImport();
3644
3645     void fgTransformFatCalli();
3646
3647     void fgInline();
3648
3649     void fgRemoveEmptyTry();
3650
3651     void fgRemoveEmptyFinally();
3652
3653     void fgMergeFinallyChains();
3654
3655     void fgCloneFinally();
3656
3657     void fgCleanupContinuation(BasicBlock* continuation);
3658
3659     void fgUpdateFinallyTargetFlags();
3660
3661     void fgClearAllFinallyTargetBits();
3662
3663     void fgAddFinallyTargetFlags();
3664
3665 #if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
3666     // Sometimes we need to defer updating the BBF_FINALLY_TARGET bit. fgNeedToAddFinallyTargetBits signals
3667     // when this is necessary.
3668     bool fgNeedToAddFinallyTargetBits;
3669 #endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
3670
3671     bool fgRetargetBranchesToCanonicalCallFinally(BasicBlock*      block,
3672                                                   BasicBlock*      handler,
3673                                                   BlockToBlockMap& continuationMap);
3674
3675     GenTreePtr fgGetCritSectOfStaticMethod();
3676
3677 #if FEATURE_EH_FUNCLETS
3678
3679     void fgAddSyncMethodEnterExit();
3680
3681     GenTree* fgCreateMonitorTree(unsigned lvaMonitorBool, unsigned lvaThisVar, BasicBlock* block, bool enter);
3682
3683     void fgConvertSyncReturnToLeave(BasicBlock* block);
3684
3685 #endif // FEATURE_EH_FUNCLETS
3686
3687     void fgAddReversePInvokeEnterExit();
3688
3689     bool fgMoreThanOneReturnBlock();
3690
3691     // The number of separate return points in the method.
3692     unsigned fgReturnCount;
3693
3694     void fgAddInternal();
3695
3696     bool fgFoldConditional(BasicBlock* block);
3697
3698     void fgMorphStmts(BasicBlock* block, bool* mult, bool* lnot, bool* loadw);
3699     void fgMorphBlocks();
3700
3701     bool fgMorphBlockStmt(BasicBlock* block, GenTreeStmt* stmt DEBUGARG(const char* msg));
3702
3703     void fgCheckArgCnt();
3704     void fgSetOptions();
3705
3706 #ifdef DEBUG
3707     static fgWalkPreFn fgAssertNoQmark;
3708     void fgPreExpandQmarkChecks(GenTreePtr expr);
3709     void        fgPostExpandQmarkChecks();
3710     static void fgCheckQmarkAllowedForm(GenTreePtr tree);
3711 #endif
3712
3713     IL_OFFSET fgFindBlockILOffset(BasicBlock* block);
3714
3715     BasicBlock* fgSplitBlockAtBeginning(BasicBlock* curr);
3716     BasicBlock* fgSplitBlockAtEnd(BasicBlock* curr);
3717     BasicBlock* fgSplitBlockAfterStatement(BasicBlock* curr, GenTree* stmt);
3718     BasicBlock* fgSplitBlockAfterNode(BasicBlock* curr, GenTree* node); // for LIR
3719     BasicBlock* fgSplitEdge(BasicBlock* curr, BasicBlock* succ);
3720
3721     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block, IL_OFFSETX offs);
3722     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree);
3723     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block);
3724     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, IL_OFFSETX offs);
3725
3726     GenTreePtr fgGetTopLevelQmark(GenTreePtr expr, GenTreePtr* ppDst = nullptr);
3727     void fgExpandQmarkForCastInstOf(BasicBlock* block, GenTreePtr stmt);
3728     void fgExpandQmarkStmt(BasicBlock* block, GenTreePtr expr);
3729     void fgExpandQmarkNodes();
3730
3731     void fgMorph();
3732
3733     // Do "simple lowering."  This functionality is (conceptually) part of "general"
3734     // lowering that is distributed between fgMorph and the lowering phase of LSRA.
3735     void fgSimpleLowering();
3736
3737     bool fgShouldCreateAssignOp(GenTreePtr tree, bool* bReverse);
3738
3739     GenTreePtr fgInitThisClass();
3740
3741     GenTreeCall* fgGetStaticsCCtorHelper(CORINFO_CLASS_HANDLE cls, CorInfoHelpFunc helper);
3742
3743     GenTreeCall* fgGetSharedCCtor(CORINFO_CLASS_HANDLE cls);
3744
3745     inline bool backendRequiresLocalVarLifetimes()
3746     {
3747 #if defined(LEGACY_BACKEND)
3748         return true;
3749 #else
3750         return !opts.MinOpts() || m_pLinearScan->willEnregisterLocalVars();
3751 #endif
3752     }
3753
3754     void fgLocalVarLiveness();
3755
3756     void fgLocalVarLivenessInit();
3757
3758 #ifdef LEGACY_BACKEND
3759     GenTreePtr fgLegacyPerStatementLocalVarLiveness(GenTreePtr startNode, GenTreePtr relopNode);
3760 #else
3761     void fgPerNodeLocalVarLiveness(GenTree* node);
3762 #endif
3763     void fgPerBlockLocalVarLiveness();
3764
3765     VARSET_VALRET_TP fgGetHandlerLiveVars(BasicBlock* block);
3766
3767     void fgLiveVarAnalysis(bool updateInternalOnly = false);
3768
3769     // This is used in the liveness computation, as a temporary.  When we use the
3770     // arbitrary-length VarSet representation, it is better not to allocate a new one
3771     // at each call.
3772     VARSET_TP fgMarkIntfUnionVS;
3773
3774     bool fgMarkIntf(VARSET_VALARG_TP varSet);
3775
3776     bool fgMarkIntf(VARSET_VALARG_TP varSet1, VARSET_VALARG_TP varSet2);
3777
3778     bool fgMarkIntf(VARSET_VALARG_TP varSet1, unsigned varIndex);
3779
3780     void fgUpdateRefCntForClone(BasicBlock* addedToBlock, GenTreePtr clonedTree);
3781
3782     void fgUpdateRefCntForExtract(GenTreePtr wholeTree, GenTreePtr keptTree);
3783
3784     void fgComputeLifeCall(VARSET_TP& life, GenTreeCall* call);
3785
3786     void fgComputeLifeTrackedLocalUse(VARSET_TP& life, LclVarDsc& varDsc, GenTreeLclVarCommon* node);
3787     bool fgComputeLifeTrackedLocalDef(VARSET_TP&           life,
3788                                       VARSET_VALARG_TP     keepAliveVars,
3789                                       LclVarDsc&           varDsc,
3790                                       GenTreeLclVarCommon* node);
3791     void fgComputeLifeUntrackedLocal(VARSET_TP&           life,
3792                                      VARSET_VALARG_TP     keepAliveVars,
3793                                      LclVarDsc&           varDsc,
3794                                      GenTreeLclVarCommon* lclVarNode,
3795                                      GenTree*             node);
3796     bool fgComputeLifeLocal(VARSET_TP& life, VARSET_VALARG_TP keepAliveVars, GenTree* lclVarNode, GenTree* node);
3797
3798     void fgComputeLife(VARSET_TP&       life,
3799                        GenTreePtr       startNode,
3800                        GenTreePtr       endNode,
3801                        VARSET_VALARG_TP volatileVars,
3802                        bool* pStmtInfoDirty DEBUGARG(bool* treeModf));
3803
3804     void fgComputeLifeLIR(VARSET_TP& life, BasicBlock* block, VARSET_VALARG_TP volatileVars);
3805
3806     bool fgRemoveDeadStore(GenTree**        pTree,
3807                            LclVarDsc*       varDsc,
3808                            VARSET_VALARG_TP life,
3809                            bool*            doAgain,
3810                            bool* pStmtInfoDirty DEBUGARG(bool* treeModf));
3811
3812     // For updating liveset during traversal AFTER fgComputeLife has completed
3813     VARSET_VALRET_TP fgGetVarBits(GenTreePtr tree);
3814     VARSET_VALRET_TP fgUpdateLiveSet(VARSET_VALARG_TP liveSet, GenTreePtr tree);
3815
3816     // Returns the set of live variables after endTree,
3817     // assuming that liveSet is the set of live variables BEFORE tree.
3818     // Requires that fgComputeLife has completed, and that tree is in the same
3819     // statement as endTree, and that it comes before endTree in execution order
3820
3821     VARSET_VALRET_TP fgUpdateLiveSet(VARSET_VALARG_TP liveSet, GenTreePtr tree, GenTreePtr endTree)
3822     {
3823         VARSET_TP newLiveSet(VarSetOps::MakeCopy(this, liveSet));
3824         while (tree != nullptr && tree != endTree->gtNext)
3825         {
3826             VarSetOps::AssignNoCopy(this, newLiveSet, fgUpdateLiveSet(newLiveSet, tree));
3827             tree = tree->gtNext;
3828         }
3829         assert(tree == endTree->gtNext);
3830         return newLiveSet;
3831     }
3832
3833     void fgInterBlockLocalVarLiveness();
3834
3835     // The presence of "x op= y" operations presents some difficulties for SSA: this is both a use of some SSA name of
3836     // "x", and a def of a new SSA name for "x".  The tree only has one local variable for "x", so it has to choose
3837     // whether to treat that as the use or def.  It chooses the "use", and thus the old SSA name.  This map allows us
3838     // to record/recover the "def" SSA number, given the lcl var node for "x" in such a tree.
3839     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, unsigned, JitSimplerHashBehavior> NodeToUnsignedMap;
3840     NodeToUnsignedMap* m_opAsgnVarDefSsaNums;
3841     NodeToUnsignedMap* GetOpAsgnVarDefSsaNums()
3842     {
3843         if (m_opAsgnVarDefSsaNums == nullptr)
3844         {
3845             m_opAsgnVarDefSsaNums = new (getAllocator()) NodeToUnsignedMap(getAllocator());
3846         }
3847         return m_opAsgnVarDefSsaNums;
3848     }
3849
3850     // Requires value numbering phase to have completed. Returns the value number ("gtVN") of the
3851     // "tree," EXCEPT in the case of GTF_VAR_USEASG, because the tree node's gtVN member is the
3852     // "use" VN. Performs a lookup into the map of (use asg tree -> def VN.) to return the "def's"
3853     // VN.
3854     inline ValueNum GetUseAsgDefVNOrTreeVN(GenTreePtr tree);
3855
3856     // Requires that "lcl" has the GTF_VAR_DEF flag set.  Returns the SSA number of "lcl".
3857     // Except: assumes that lcl is a def, and if it is
3858     // a def appearing in "lcl op= rhs" (GTF_VAR_USEASG), looks up and returns the SSA number for the "def",
3859     // rather than the "use" SSA number recorded in the tree "lcl".
3860     inline unsigned GetSsaNumForLocalVarDef(GenTreePtr lcl);
3861
3862     // Some assignments assign to a local "indirectly": they are part of a comma expression that takes the address
3863     // of the local (or a field thereof), assigns this address to a temp, and uses an indirection of this temp as
3864     // the LHS of the assignment.  This actually arises in exactly one situation.  At the source level we assign one
3865     // struct local to another: "s1 = s2".  This becomes a copyblk.  If "s2" is promoted into  field variables "s2f0",
3866     // ..."s2fn", then the copyblk will morph to a comma expression that takes the address of "s1" and does field-wise
3867     // assignments:
3868     //   (byref addrS1 = &s1,
3869     //    *(addrS1 * offsetof(f0)) = s2f0,
3870     //    ...
3871     //    *(addrS1 * offsetof(fn)) = s2fn)
3872     //
3873     // It would be a shame, given the simple form at the source level, to be unable to track the values in the
3874     // fields of "s1" after this.  But "s1" does not appear in the assignments that modify it.  How, then, to
3875     // give it SSA names and value numbers?
3876     //
3877     // The solution is to use the side table described below to annotate each of the field-wise assignments at the
3878     // end with an instance of the structure below, whose fields are described in the declaration.
3879     struct IndirectAssignmentAnnotation
3880     {
3881         unsigned      m_lclNum;   // The local num that is being indirectly assigned.
3882         FieldSeqNode* m_fieldSeq; // If the LHS of the struct assignment is itself a struct field dereference,
3883                                   // as in "s0.g = s2", then "m_lclNum" would be "s0", and "m_fieldSeq" would
3884                                   // be the singleton field sequence "g".  The individual assignments would
3885                                   // further append the fields of "s.g" to that.
3886         bool m_isEntire;          // True iff this assignment writes all of m_lclNum.  (This can occur if the
3887                                   // structure has a single field).
3888         unsigned m_defSsaNum;     // The new SSA number of "m_lclNum" after the assignment.
3889         unsigned m_useSsaNum;     // Only valid if "m_isEntire" is false; if so, the SSA number of "m_lclNum" before the
3890                                   // assignment.
3891
3892         IndirectAssignmentAnnotation(unsigned      lclNum,
3893                                      FieldSeqNode* fldSeq,
3894                                      bool          isEntire,
3895                                      unsigned      defSsaNum = SsaConfig::RESERVED_SSA_NUM,
3896                                      unsigned      useSsaNum = SsaConfig::RESERVED_SSA_NUM)
3897             : m_lclNum(lclNum), m_fieldSeq(fldSeq), m_isEntire(isEntire), m_defSsaNum(defSsaNum), m_useSsaNum(useSsaNum)
3898         {
3899         }
3900     };
3901     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, IndirectAssignmentAnnotation*, JitSimplerHashBehavior>
3902                           NodeToIndirAssignMap;
3903     NodeToIndirAssignMap* m_indirAssignMap;
3904     NodeToIndirAssignMap* GetIndirAssignMap()
3905     {
3906         if (m_indirAssignMap == nullptr)
3907         {
3908             // Create a CompAllocator that labels sub-structure with CMK_IndirAssignMap, and use that for allocation.
3909             IAllocator* ialloc = new (this, CMK_IndirAssignMap) CompAllocator(this, CMK_IndirAssignMap);
3910             m_indirAssignMap   = new (ialloc) NodeToIndirAssignMap(ialloc);
3911         }
3912         return m_indirAssignMap;
3913     }
3914
3915     // Performs SSA conversion.
3916     void fgSsaBuild();
3917
3918     // Reset any data structures to the state expected by "fgSsaBuild", so it can be run again.
3919     void fgResetForSsa();
3920
3921     unsigned fgSsaPassesCompleted; // Number of times fgSsaBuild has been run.
3922
3923     // Returns "true" iff lcl "lclNum" should be excluded from SSA.
3924     inline bool fgExcludeFromSsa(unsigned lclNum);
3925
3926     // The value numbers for this compilation.
3927     ValueNumStore* vnStore;
3928
3929 public:
3930     ValueNumStore* GetValueNumStore()
3931     {
3932         return vnStore;
3933     }
3934
3935     // Do value numbering (assign a value number to each
3936     // tree node).
3937     void fgValueNumber();
3938
3939     // Computes new GcHeap VN via the assignment H[elemTypeEq][arrVN][inx][fldSeq] = rhsVN.
3940     // Assumes that "elemTypeEq" is the (equivalence class rep) of the array element type.
3941     // The 'indType' is the indirection type of the lhs of the assignment and will typically
3942     // match the element type of the array or fldSeq.  When this type doesn't match
3943     // or if the fldSeq is 'NotAField' we invalidate the array contents H[elemTypeEq][arrVN]
3944     //
3945     ValueNum fgValueNumberArrIndexAssign(CORINFO_CLASS_HANDLE elemTypeEq,
3946                                          ValueNum             arrVN,
3947                                          ValueNum             inxVN,
3948                                          FieldSeqNode*        fldSeq,
3949                                          ValueNum             rhsVN,
3950                                          var_types            indType);
3951
3952     // Requires that "tree" is a GT_IND marked as an array index, and that its address argument
3953     // has been parsed to yield the other input arguments.  If evaluation of the address
3954     // can raise exceptions, those should be captured in the exception set "excVN."
3955     // Assumes that "elemTypeEq" is the (equivalence class rep) of the array element type.
3956     // Marks "tree" with the VN for H[elemTypeEq][arrVN][inx][fldSeq] (for the liberal VN; a new unique
3957     // VN for the conservative VN.)  Also marks the tree's argument as the address of an array element.
3958     // The type tree->TypeGet() will typically match the element type of the array or fldSeq.
3959     // When this type doesn't match or if the fldSeq is 'NotAField' we return a new unique VN
3960     //
3961     ValueNum fgValueNumberArrIndexVal(GenTreePtr           tree,
3962                                       CORINFO_CLASS_HANDLE elemTypeEq,
3963                                       ValueNum             arrVN,
3964                                       ValueNum             inxVN,
3965                                       ValueNum             excVN,
3966                                       FieldSeqNode*        fldSeq);
3967
3968     // Requires "funcApp" to be a VNF_PtrToArrElem, and "addrXvn" to represent the exception set thrown
3969     // by evaluating the array index expression "tree".  Returns the value number resulting from
3970     // dereferencing the array in the current GcHeap state.  If "tree" is non-null, it must be the
3971     // "GT_IND" that does the dereference, and it is given the returned value number.
3972     ValueNum fgValueNumberArrIndexVal(GenTreePtr tree, struct VNFuncApp* funcApp, ValueNum addrXvn);
3973
3974     // Compute the value number for a byref-exposed load of the given type via the given pointerVN.
3975     ValueNum fgValueNumberByrefExposedLoad(var_types type, ValueNum pointerVN);
3976
3977     unsigned fgVNPassesCompleted; // Number of times fgValueNumber has been run.
3978
3979     // Utility functions for fgValueNumber.
3980
3981     // Perform value-numbering for the trees in "blk".
3982     void fgValueNumberBlock(BasicBlock* blk);
3983
3984     // Requires that "entryBlock" is the entry block of loop "loopNum", and that "loopNum" is the
3985     // innermost loop of which "entryBlock" is the entry.  Returns the value number that should be
3986     // assumed for the memoryKind at the start "entryBlk".
3987     ValueNum fgMemoryVNForLoopSideEffects(MemoryKind memoryKind, BasicBlock* entryBlock, unsigned loopNum);
3988
3989     // Called when an operation (performed by "tree", described by "msg") may cause the GcHeap to be mutated.
3990     // As GcHeap is a subset of ByrefExposed, this will also annotate the ByrefExposed mutation.
3991     void fgMutateGcHeap(GenTreePtr tree DEBUGARG(const char* msg));
3992
3993     // Called when an operation (performed by "tree", described by "msg") may cause an address-exposed local to be
3994     // mutated.
3995     void fgMutateAddressExposedLocal(GenTreePtr tree DEBUGARG(const char* msg));
3996
3997     // For a GC heap store at curTree, record the new curMemoryVN's and update curTree's MemorySsaMap.
3998     // As GcHeap is a subset of ByrefExposed, this will also record the ByrefExposed store.
3999     void recordGcHeapStore(GenTreePtr curTree, ValueNum gcHeapVN DEBUGARG(const char* msg));
4000
4001     // For a store to an address-exposed local at curTree, record the new curMemoryVN and update curTree's MemorySsaMap.
4002     void recordAddressExposedLocalStore(GenTreePtr curTree, ValueNum memoryVN DEBUGARG(const char* msg));
4003
4004     // Tree caused an update in the current memory VN.  If "tree" has an associated heap SSA #, record that
4005     // value in that SSA #.
4006     void fgValueNumberRecordMemorySsa(MemoryKind memoryKind, GenTreePtr tree);
4007
4008     // The input 'tree' is a leaf node that is a constant
4009     // Assign the proper value number to the tree
4010     void fgValueNumberTreeConst(GenTreePtr tree);
4011
4012     // Assumes that all inputs to "tree" have had value numbers assigned; assigns a VN to tree.
4013     // (With some exceptions: the VN of the lhs of an assignment is assigned as part of the
4014     // assignment.)
4015     // If "evalAsgLhsInd" is true, evaluate a GT_IND node, even if it's labeled as the LHS of
4016     // an assignment.
4017     void fgValueNumberTree(GenTreePtr tree, bool evalAsgLhsInd = false);
4018
4019     // Does value-numbering for a block assignment.
4020     void fgValueNumberBlockAssignment(GenTreePtr tree, bool evalAsgLhsInd);
4021
4022     // Does value-numbering for a cast tree.
4023     void fgValueNumberCastTree(GenTreePtr tree);
4024
4025     // Does value-numbering for an intrinsic tree.
4026     void fgValueNumberIntrinsic(GenTreePtr tree);
4027
4028     // Does value-numbering for a call.  We interpret some helper calls.
4029     void fgValueNumberCall(GenTreeCall* call);
4030
4031     // The VN of some nodes in "args" may have changed -- reassign VNs to the arg list nodes.
4032     void fgUpdateArgListVNs(GenTreeArgList* args);
4033
4034     // Does value-numbering for a helper "call" that has a VN function symbol "vnf".
4035     void fgValueNumberHelperCallFunc(GenTreeCall* call, VNFunc vnf, ValueNumPair vnpExc);
4036
4037     // Requires "helpCall" to be a helper call.  Assigns it a value number;
4038     // we understand the semantics of some of the calls.  Returns "true" if
4039     // the call may modify the heap (we assume arbitrary memory side effects if so).
4040     bool fgValueNumberHelperCall(GenTreeCall* helpCall);
4041
4042     // Requires "helpFunc" to be pure.  Returns the corresponding VNFunc.
4043     VNFunc fgValueNumberHelperMethVNFunc(CorInfoHelpFunc helpFunc);
4044
4045     // These are the current value number for the memory implicit variables while
4046     // doing value numbering.  These are the value numbers under the "liberal" interpretation
4047     // of memory values; the "conservative" interpretation needs no VN, since every access of
4048     // memory yields an unknown value.
4049     ValueNum fgCurMemoryVN[MemoryKindCount];
4050
4051     // Return a "pseudo"-class handle for an array element type.  If "elemType" is TYP_STRUCT,
4052     // requires "elemStructType" to be non-null (and to have a low-order zero).  Otherwise, low order bit
4053     // is 1, and the rest is an encoding of "elemTyp".
4054     static CORINFO_CLASS_HANDLE EncodeElemType(var_types elemTyp, CORINFO_CLASS_HANDLE elemStructType)
4055     {
4056         if (elemStructType != nullptr)
4057         {
4058             assert(varTypeIsStruct(elemTyp) || elemTyp == TYP_REF || elemTyp == TYP_BYREF ||
4059                    varTypeIsIntegral(elemTyp));
4060             assert((size_t(elemStructType) & 0x1) == 0x0); // Make sure the encoding below is valid.
4061             return elemStructType;
4062         }
4063         else
4064         {
4065             elemTyp = varTypeUnsignedToSigned(elemTyp);
4066             return CORINFO_CLASS_HANDLE(size_t(elemTyp) << 1 | 0x1);
4067         }
4068     }
4069     // If "clsHnd" is the result of an "EncodePrim" call, returns true and sets "*pPrimType" to the
4070     // var_types it represents.  Otherwise, returns TYP_STRUCT (on the assumption that "clsHnd" is
4071     // the struct type of the element).
4072     static var_types DecodeElemType(CORINFO_CLASS_HANDLE clsHnd)
4073     {
4074         size_t clsHndVal = size_t(clsHnd);
4075         if (clsHndVal & 0x1)
4076         {
4077             return var_types(clsHndVal >> 1);
4078         }
4079         else
4080         {
4081             return TYP_STRUCT;
4082         }
4083     }
4084
4085     // Convert a BYTE which represents the VM's CorInfoGCtype to the JIT's var_types
4086     var_types getJitGCType(BYTE gcType);
4087
4088     enum structPassingKind
4089     {
4090         SPK_Unknown,       // Invalid value, never returned
4091         SPK_PrimitiveType, // The struct is passed/returned using a primitive type.
4092         SPK_ByValue,       // The struct is passed/returned by value (using the ABI rules)
4093                            //  for ARM64 and UNIX_X64 in multiple registers. (when all of the
4094                            //   parameters registers are used, then the stack will be used)
4095                            //  for X86 passed on the stack, for ARM32 passed in registers
4096                            //   or the stack or split between registers and the stack.
4097         SPK_ByValueAsHfa,  // The struct is passed/returned as an HFA in multiple registers.
4098         SPK_ByReference
4099     }; // The struct is passed/returned by reference to a copy/buffer.
4100
4101     // Get the "primitive" type that is is used when we are given a struct of size 'structSize'.
4102     // For pointer sized structs the 'clsHnd' is used to determine if the struct contains GC ref.
4103     // A "primitive" type is one of the scalar types: byte, short, int, long, ref, float, double
4104     // If we can't or shouldn't use a "primitive" type then TYP_UNKNOWN is returned.
4105     //
4106     var_types getPrimitiveTypeForStruct(unsigned structSize, CORINFO_CLASS_HANDLE clsHnd);
4107
4108     // Get the type that is used to pass values of the given struct type.
4109     // If you have already retrieved the struct size then pass it as the optional third argument
4110     //
4111     var_types getArgTypeForStruct(CORINFO_CLASS_HANDLE clsHnd,
4112                                   structPassingKind*   wbPassStruct,
4113                                   unsigned             structSize = 0);
4114
4115     // Get the type that is used to return values of the given struct type.
4116     // If you have already retrieved the struct size then pass it as the optional third argument
4117     //
4118     var_types getReturnTypeForStruct(CORINFO_CLASS_HANDLE clsHnd,
4119                                      structPassingKind*   wbPassStruct = nullptr,
4120                                      unsigned             structSize   = 0);
4121
4122 #ifdef DEBUG
4123     // Print a representation of "vnp" or "vn" on standard output.
4124     // If "level" is non-zero, we also print out a partial expansion of the value.
4125     void vnpPrint(ValueNumPair vnp, unsigned level);
4126     void vnPrint(ValueNum vn, unsigned level);
4127 #endif
4128
4129     bool fgDominate(BasicBlock* b1, BasicBlock* b2); // Return true if b1 dominates b2
4130
4131     // Dominator computation member functions
4132     // Not exposed outside Compiler
4133 protected:
4134     bool fgReachable(BasicBlock* b1, BasicBlock* b2); // Returns true if block b1 can reach block b2
4135
4136     void fgComputeDoms(); // Computes the immediate dominators for each basic block in the
4137                           // flow graph.  We first assume the fields bbIDom on each
4138                           // basic block are invalid. This computation is needed later
4139                           // by fgBuildDomTree to build the dominance tree structure.
4140                           // Based on: A Simple, Fast Dominance Algorithm
4141                           // by Keith D. Cooper, Timothy J. Harvey, and Ken Kennedy
4142
4143     void fgCompDominatedByExceptionalEntryBlocks();
4144
4145     BlockSet_ValRet_T fgGetDominatorSet(BasicBlock* block); // Returns a set of blocks that dominate the given block.
4146     // Note: this is relatively slow compared to calling fgDominate(),
4147     // especially if dealing with a single block versus block check.
4148
4149     void fgComputeReachabilitySets(); // Compute bbReach sets. (Also sets BBF_GC_SAFE_POINT flag on blocks.)
4150
4151     void fgComputeEnterBlocksSet(); // Compute the set of entry blocks, 'fgEnterBlks'.
4152
4153     bool fgRemoveUnreachableBlocks(); // Remove blocks determined to be unreachable by the bbReach sets.
4154
4155     void fgComputeReachability(); // Perform flow graph node reachability analysis.
4156
4157     BasicBlock* fgIntersectDom(BasicBlock* a, BasicBlock* b); // Intersect two immediate dominator sets.
4158
4159     void fgDfsInvPostOrder(); // In order to compute dominance using fgIntersectDom, the flow graph nodes must be
4160                               // processed in topological sort, this function takes care of that.
4161
4162     void fgDfsInvPostOrderHelper(BasicBlock* block, BlockSet& visited, unsigned* count);
4163
4164     BlockSet_ValRet_T fgDomFindStartNodes(); // Computes which basic blocks don't have incoming edges in the flow graph.
4165                                              // Returns this as a set.
4166
4167     BlockSet_ValRet_T fgDomTreeEntryNodes(BasicBlockList** domTree); // Computes which nodes in the dominance forest are
4168                                                                      // root nodes. Returns this as a set.
4169
4170 #ifdef DEBUG
4171     void fgDispDomTree(BasicBlockList** domTree); // Helper that prints out the Dominator Tree in debug builds.
4172 #endif                                            // DEBUG
4173
4174     void fgBuildDomTree(); // Once we compute all the immediate dominator sets for each node in the flow graph
4175                            // (performed by fgComputeDoms), this procedure builds the dominance tree represented
4176                            // adjacency lists.
4177
4178     // In order to speed up the queries of the form 'Does A dominates B', we can perform a DFS preorder and postorder
4179     // traversal of the dominance tree and the dominance query will become A dominates B iif preOrder(A) <= preOrder(B)
4180     // && postOrder(A) >= postOrder(B) making the computation O(1).
4181     void fgTraverseDomTree(unsigned bbNum, BasicBlockList** domTree, unsigned* preNum, unsigned* postNum);
4182
4183     // When the flow graph changes, we need to update the block numbers, predecessor lists, reachability sets, and
4184     // dominators.
4185     void fgUpdateChangedFlowGraph();
4186
4187 public:
4188     // Compute the predecessors of the blocks in the control flow graph.
4189     void fgComputePreds();
4190
4191     // Remove all predecessor information.
4192     void fgRemovePreds();
4193
4194     // Compute the cheap flow graph predecessors lists. This is used in some early phases
4195     // before the full predecessors lists are computed.
4196     void fgComputeCheapPreds();
4197
4198 private:
4199     void fgAddCheapPred(BasicBlock* block, BasicBlock* blockPred);
4200
4201     void fgRemoveCheapPred(BasicBlock* block, BasicBlock* blockPred);
4202
4203 public:
4204     enum GCPollType
4205     {
4206         GCPOLL_NONE,
4207         GCPOLL_CALL,
4208         GCPOLL_INLINE
4209     };
4210
4211     // Initialize the per-block variable sets (used for liveness analysis).
4212     void fgInitBlockVarSets();
4213
4214     // true if we've gone through and created GC Poll calls.
4215     bool fgGCPollsCreated;
4216     void fgMarkGCPollBlocks();
4217     void fgCreateGCPolls();
4218     bool fgCreateGCPoll(GCPollType pollType, BasicBlock* block);
4219
4220     // Requires that "block" is a block that returns from
4221     // a finally.  Returns the number of successors (jump targets of
4222     // of blocks in the covered "try" that did a "LEAVE".)
4223     unsigned fgNSuccsOfFinallyRet(BasicBlock* block);
4224
4225     // Requires that "block" is a block that returns (in the sense of BBJ_EHFINALLYRET) from
4226     // a finally.  Returns its "i"th successor (jump targets of
4227     // of blocks in the covered "try" that did a "LEAVE".)
4228     // Requires that "i" < fgNSuccsOfFinallyRet(block).
4229     BasicBlock* fgSuccOfFinallyRet(BasicBlock* block, unsigned i);
4230
4231 private:
4232     // Factor out common portions of the impls of the methods above.
4233     void fgSuccOfFinallyRetWork(BasicBlock* block, unsigned i, BasicBlock** bres, unsigned* nres);
4234
4235 public:
4236     // For many purposes, it is desirable to be able to enumerate the *distinct* targets of a switch statement,
4237     // skipping duplicate targets.  (E.g., in flow analyses that are only interested in the set of possible targets.)
4238     // SwitchUniqueSuccSet contains the non-duplicated switch targets.
4239     // (Code that modifies the jump table of a switch has an obligation to call Compiler::UpdateSwitchTableTarget,
4240     // which in turn will call the "UpdateTarget" method of this type if a SwitchUniqueSuccSet has already
4241     // been computed for the switch block.  If a switch block is deleted or is transformed into a non-switch,
4242     // we leave the entry associated with the block, but it will no longer be accessed.)
4243     struct SwitchUniqueSuccSet
4244     {
4245         unsigned     numDistinctSuccs; // Number of distinct targets of the switch.
4246         BasicBlock** nonDuplicates;    // Array of "numDistinctSuccs", containing all the distinct switch target
4247                                        // successors.
4248
4249         // The switch block "switchBlk" just had an entry with value "from" modified to the value "to".
4250         // Update "this" as necessary: if "from" is no longer an element of the jump table of "switchBlk",
4251         // remove it from "this", and ensure that "to" is a member.  Use "alloc" to do any required allocation.
4252         void UpdateTarget(IAllocator* alloc, BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to);
4253     };
4254
4255     typedef SimplerHashTable<BasicBlock*, PtrKeyFuncs<BasicBlock>, SwitchUniqueSuccSet, JitSimplerHashBehavior>
4256         BlockToSwitchDescMap;
4257
4258 private:
4259     // Maps BasicBlock*'s that end in switch statements to SwitchUniqueSuccSets that allow
4260     // iteration over only the distinct successors.
4261     BlockToSwitchDescMap* m_switchDescMap;
4262
4263 public:
4264     BlockToSwitchDescMap* GetSwitchDescMap()
4265     {
4266         if (m_switchDescMap == nullptr)
4267         {
4268             m_switchDescMap = new (getAllocator()) BlockToSwitchDescMap(getAllocator());
4269         }
4270         return m_switchDescMap;
4271     }
4272
4273     // Invalidate the map of unique switch block successors. For example, since the hash key of the map
4274     // depends on block numbers, we must invalidate the map when the blocks are renumbered, to ensure that
4275     // we don't accidentally look up and return the wrong switch data.
4276     void InvalidateUniqueSwitchSuccMap()
4277     {
4278         m_switchDescMap = nullptr;
4279     }
4280
4281     // Requires "switchBlock" to be a block that ends in a switch.  Returns
4282     // the corresponding SwitchUniqueSuccSet.
4283     SwitchUniqueSuccSet GetDescriptorForSwitch(BasicBlock* switchBlk);
4284
4285     // The switch block "switchBlk" just had an entry with value "from" modified to the value "to".
4286     // Update "this" as necessary: if "from" is no longer an element of the jump table of "switchBlk",
4287     // remove it from "this", and ensure that "to" is a member.
4288     void UpdateSwitchTableTarget(BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to);
4289
4290     // Remove the "SwitchUniqueSuccSet" of "switchBlk" in the BlockToSwitchDescMap.
4291     void fgInvalidateSwitchDescMapEntry(BasicBlock* switchBlk);
4292
4293     BasicBlock* fgFirstBlockOfHandler(BasicBlock* block);
4294
4295     flowList* fgGetPredForBlock(BasicBlock* block, BasicBlock* blockPred);
4296
4297     flowList* fgGetPredForBlock(BasicBlock* block, BasicBlock* blockPred, flowList*** ptrToPred);
4298
4299     flowList* fgSpliceOutPred(BasicBlock* block, BasicBlock* blockPred);
4300
4301     flowList* fgRemoveRefPred(BasicBlock* block, BasicBlock* blockPred);
4302
4303     flowList* fgRemoveAllRefPreds(BasicBlock* block, BasicBlock* blockPred);
4304
4305     flowList* fgRemoveAllRefPreds(BasicBlock* block, flowList** ptrToPred);
4306
4307     void fgRemoveBlockAsPred(BasicBlock* block);
4308
4309     void fgChangeSwitchBlock(BasicBlock* oldSwitchBlock, BasicBlock* newSwitchBlock);
4310
4311     void fgReplaceSwitchJumpTarget(BasicBlock* blockSwitch, BasicBlock* newTarget, BasicBlock* oldTarget);
4312
4313     void fgReplaceJumpTarget(BasicBlock* block, BasicBlock* newTarget, BasicBlock* oldTarget);
4314
4315     void fgReplacePred(BasicBlock* block, BasicBlock* oldPred, BasicBlock* newPred);
4316
4317     flowList* fgAddRefPred(BasicBlock* block,
4318                            BasicBlock* blockPred,
4319                            flowList*   oldEdge           = nullptr,
4320                            bool        initializingPreds = false); // Only set to 'true' when we are computing preds in
4321                                                                    // fgComputePreds()
4322
4323     void fgFindBasicBlocks();
4324
4325     bool fgIsBetterFallThrough(BasicBlock* bCur, BasicBlock* bAlt);
4326
4327     bool fgCheckEHCanInsertAfterBlock(BasicBlock* blk, unsigned regionIndex, bool putInTryRegion);
4328
4329     BasicBlock* fgFindInsertPoint(unsigned    regionIndex,
4330                                   bool        putInTryRegion,
4331                                   BasicBlock* startBlk,
4332                                   BasicBlock* endBlk,
4333                                   BasicBlock* nearBlk,
4334                                   BasicBlock* jumpBlk,
4335                                   bool        runRarely);
4336
4337     unsigned fgGetNestingLevel(BasicBlock* block, unsigned* pFinallyNesting = nullptr);
4338
4339     void fgRemoveEmptyBlocks();
4340
4341     void fgRemoveStmt(BasicBlock* block, GenTreePtr stmt, bool updateRefCnt = true);
4342
4343     bool fgCheckRemoveStmt(BasicBlock* block, GenTreePtr stmt);
4344
4345     void fgCreateLoopPreHeader(unsigned lnum);
4346
4347     void fgUnreachableBlock(BasicBlock* block);
4348
4349     void fgRemoveConditionalJump(BasicBlock* block);
4350
4351     BasicBlock* fgLastBBInMainFunction();
4352
4353     BasicBlock* fgEndBBAfterMainFunction();
4354
4355     void fgUnlinkRange(BasicBlock* bBeg, BasicBlock* bEnd);
4356
4357     void fgRemoveBlock(BasicBlock* block, bool unreachable);
4358
4359     bool fgCanCompactBlocks(BasicBlock* block, BasicBlock* bNext);
4360
4361     void fgCompactBlocks(BasicBlock* block, BasicBlock* bNext);
4362
4363     void fgUpdateLoopsAfterCompacting(BasicBlock* block, BasicBlock* bNext);
4364
4365     BasicBlock* fgConnectFallThrough(BasicBlock* bSrc, BasicBlock* bDst);
4366
4367     bool fgRenumberBlocks();
4368
4369     bool fgExpandRarelyRunBlocks();
4370
4371     bool fgEhAllowsMoveBlock(BasicBlock* bBefore, BasicBlock* bAfter);
4372
4373     void fgMoveBlocksAfter(BasicBlock* bStart, BasicBlock* bEnd, BasicBlock* insertAfterBlk);
4374
4375     enum FG_RELOCATE_TYPE
4376     {
4377         FG_RELOCATE_TRY,    // relocate the 'try' region
4378         FG_RELOCATE_HANDLER // relocate the handler region (including the filter if necessary)
4379     };
4380     BasicBlock* fgRelocateEHRange(unsigned regionIndex, FG_RELOCATE_TYPE relocateType);
4381
4382 #if FEATURE_EH_FUNCLETS
4383 #if defined(_TARGET_ARM_)
4384     void fgClearFinallyTargetBit(BasicBlock* block);
4385 #endif // defined(_TARGET_ARM_)
4386     bool fgIsIntraHandlerPred(BasicBlock* predBlock, BasicBlock* block);
4387     bool fgAnyIntraHandlerPreds(BasicBlock* block);
4388     void fgInsertFuncletPrologBlock(BasicBlock* block);
4389     void fgCreateFuncletPrologBlocks();
4390     void fgCreateFunclets();
4391 #else  // !FEATURE_EH_FUNCLETS
4392     bool fgRelocateEHRegions();
4393 #endif // !FEATURE_EH_FUNCLETS
4394
4395     bool fgOptimizeUncondBranchToSimpleCond(BasicBlock* block, BasicBlock* target);
4396
4397     bool fgBlockEndFavorsTailDuplication(BasicBlock* block);
4398
4399     bool fgBlockIsGoodTailDuplicationCandidate(BasicBlock* block);
4400
4401     bool fgOptimizeFallthroughTailDup(BasicBlock* block, BasicBlock* target);
4402
4403     bool fgOptimizeEmptyBlock(BasicBlock* block);
4404
4405     bool fgOptimizeBranchToEmptyUnconditional(BasicBlock* block, BasicBlock* bDest);
4406
4407     bool fgOptimizeBranch(BasicBlock* bJump);
4408
4409     bool fgOptimizeSwitchBranches(BasicBlock* block);
4410
4411     bool fgOptimizeBranchToNext(BasicBlock* block, BasicBlock* bNext, BasicBlock* bPrev);
4412
4413     bool fgOptimizeSwitchJumps();
4414 #ifdef DEBUG
4415     void fgPrintEdgeWeights();
4416 #endif
4417     void fgComputeEdgeWeights();
4418
4419     void fgReorderBlocks();
4420
4421     void fgDetermineFirstColdBlock();
4422
4423     bool fgIsForwardBranch(BasicBlock* bJump, BasicBlock* bSrc = nullptr);
4424
4425     bool fgUpdateFlowGraph(bool doTailDup = false);
4426
4427     void fgFindOperOrder();
4428
4429     // method that returns if you should split here
4430     typedef bool(fgSplitPredicate)(GenTree* tree, GenTree* parent, fgWalkData* data);
4431
4432     void fgSetBlockOrder();
4433
4434     void fgRemoveReturnBlock(BasicBlock* block);
4435
4436     /* Helper code that has been factored out */
4437     inline void fgConvertBBToThrowBB(BasicBlock* block);
4438
4439     bool fgCastNeeded(GenTreePtr tree, var_types toType);
4440     GenTreePtr fgDoNormalizeOnStore(GenTreePtr tree);
4441     GenTreePtr fgMakeTmpArgNode(
4442         unsigned tmpVarNum FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(const bool passedInRegisters));
4443
4444     // The following check for loops that don't execute calls
4445     bool fgLoopCallMarked;
4446
4447     void fgLoopCallTest(BasicBlock* srcBB, BasicBlock* dstBB);
4448     void fgLoopCallMark();
4449
4450     void fgMarkLoopHead(BasicBlock* block);
4451
4452     unsigned fgGetCodeEstimate(BasicBlock* block);
4453
4454 #if DUMP_FLOWGRAPHS
4455     const char* fgProcessEscapes(const char* nameIn, escapeMapping_t* map);
4456     FILE* fgOpenFlowGraphFile(bool* wbDontClose, Phases phase, LPCWSTR type);
4457     bool fgDumpFlowGraph(Phases phase);
4458
4459 #endif // DUMP_FLOWGRAPHS
4460
4461 #ifdef DEBUG
4462     void fgDispDoms();
4463     void fgDispReach();
4464     void fgDispBBLiveness(BasicBlock* block);
4465     void fgDispBBLiveness();
4466     void fgTableDispBasicBlock(BasicBlock* block, int ibcColWidth = 0);
4467     void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
4468     void fgDispBasicBlocks(bool dumpTrees = false);
4469     void fgDumpStmtTree(GenTreePtr stmt, unsigned bbNum);
4470     void fgDumpBlock(BasicBlock* block);
4471     void fgDumpTrees(BasicBlock* firstBlock, BasicBlock* lastBlock);
4472
4473     static fgWalkPreFn fgStress64RsltMulCB;
4474     void               fgStress64RsltMul();
4475     void               fgDebugCheckUpdate();
4476     void fgDebugCheckBBlist(bool checkBBNum = false, bool checkBBRefs = true);
4477     void fgDebugCheckBlockLinks();
4478     void fgDebugCheckLinks(bool morphTrees = false);
4479     void fgDebugCheckNodeLinks(BasicBlock* block, GenTreePtr stmt);
4480     void fgDebugCheckFlags(GenTreePtr tree);
4481     void fgDebugCheckFlagsHelper(GenTreePtr tree, unsigned treeFlags, unsigned chkFlags);
4482     void fgDebugCheckTryFinallyExits();
4483 #endif
4484
4485 #ifdef LEGACY_BACKEND
4486     static void fgOrderBlockOps(GenTreePtr  tree,
4487                                 regMaskTP   reg0,
4488                                 regMaskTP   reg1,
4489                                 regMaskTP   reg2,
4490                                 GenTreePtr* opsPtr,   // OUT
4491                                 regMaskTP*  regsPtr); // OUT
4492 #endif                                                // LEGACY_BACKEND
4493
4494     static GenTreePtr fgGetFirstNode(GenTreePtr tree);
4495     static bool fgTreeIsInStmt(GenTree* tree, GenTreeStmt* stmt);
4496     void fgTraverseRPO();
4497
4498     //--------------------- Walking the trees in the IR -----------------------
4499
4500     struct fgWalkData
4501     {
4502         Compiler*     compiler;
4503         fgWalkPreFn*  wtprVisitorFn;
4504         fgWalkPostFn* wtpoVisitorFn;
4505         void*         pCallbackData; // user-provided data
4506         bool          wtprLclsOnly;  // whether to only visit lclvar nodes
4507         GenTreePtr    parent;        // parent of current node, provided to callback
4508         GenTreeStack* parentStack;   // stack of parent nodes, if asked for
4509 #ifdef DEBUG
4510         bool printModified; // callback can use this
4511 #endif
4512     };
4513
4514     fgWalkResult fgWalkTreePre(GenTreePtr*  pTree,
4515                                fgWalkPreFn* visitor,
4516                                void*        pCallBackData = nullptr,
4517                                bool         lclVarsOnly   = false,
4518                                bool         computeStack  = false);
4519
4520     fgWalkResult fgWalkTree(GenTreePtr*   pTree,
4521                             fgWalkPreFn*  preVisitor,
4522                             fgWalkPostFn* postVisitor,
4523                             void*         pCallBackData = nullptr);
4524
4525     void fgWalkAllTreesPre(fgWalkPreFn* visitor, void* pCallBackData);
4526
4527     //----- Postorder
4528
4529     fgWalkResult fgWalkTreePost(GenTreePtr*   pTree,
4530                                 fgWalkPostFn* visitor,
4531                                 void*         pCallBackData = nullptr,
4532                                 bool          computeStack  = false);
4533
4534     // An fgWalkPreFn that looks for expressions that have inline throws in
4535     // minopts mode. Basically it looks for tress with gtOverflowEx() or
4536     // GTF_IND_RNGCHK.  It returns WALK_ABORT if one is found.  It
4537     // returns WALK_SKIP_SUBTREES if GTF_EXCEPT is not set (assumes flags
4538     // properly propagated to parent trees).  It returns WALK_CONTINUE
4539     // otherwise.
4540     static fgWalkResult fgChkThrowCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4541     static fgWalkResult fgChkLocAllocCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4542     static fgWalkResult fgChkQmarkCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4543
4544     /**************************************************************************
4545      *                          PROTECTED
4546      *************************************************************************/
4547
4548 protected:
4549     friend class SsaBuilder;
4550     friend struct ValueNumberState;
4551
4552     //--------------------- Detect the basic blocks ---------------------------
4553
4554     BasicBlock** fgBBs; // Table of pointers to the BBs
4555
4556     void        fgInitBBLookup();
4557     BasicBlock* fgLookupBB(unsigned addr);
4558
4559     void fgMarkJumpTarget(BYTE* jumpTarget, IL_OFFSET offs);
4560
4561     void fgFindJumpTargets(const BYTE* codeAddr, IL_OFFSET codeSize, BYTE* jumpTarget);
4562
4563     void fgMarkBackwardJump(BasicBlock* startBlock, BasicBlock* endBlock);
4564
4565     void fgLinkBasicBlocks();
4566
4567     unsigned fgMakeBasicBlocks(const BYTE* codeAddr, IL_OFFSET codeSize, BYTE* jumpTarget);
4568
4569     void fgCheckBasicBlockControlFlow();
4570
4571     void fgControlFlowPermitted(BasicBlock* blkSrc,
4572                                 BasicBlock* blkDest,
4573                                 BOOL        IsLeave = false /* is the src a leave block */);
4574
4575     bool fgFlowToFirstBlockOfInnerTry(BasicBlock* blkSrc, BasicBlock* blkDest, bool sibling);
4576
4577     void fgObserveInlineConstants(OPCODE opcode, const FgStack& stack, bool isInlining);
4578
4579     void fgAdjustForAddressExposedOrWrittenThis();
4580
4581     bool                        fgProfileData_ILSizeMismatch;
4582     ICorJitInfo::ProfileBuffer* fgProfileBuffer;
4583     ULONG                       fgProfileBufferCount;
4584     ULONG                       fgNumProfileRuns;
4585
4586     unsigned fgStressBBProf()
4587     {
4588 #ifdef DEBUG
4589         unsigned result = JitConfig.JitStressBBProf();
4590         if (result == 0)
4591         {
4592             if (compStressCompile(STRESS_BB_PROFILE, 15))
4593             {
4594                 result = 1;
4595             }
4596         }
4597         return result;
4598 #else
4599         return 0;
4600 #endif
4601     }
4602
4603     bool fgHaveProfileData();
4604     bool fgGetProfileWeightForBasicBlock(IL_OFFSET offset, unsigned* weight);
4605     void fgInstrumentMethod();
4606
4607 public:
4608     // fgIsUsingProfileWeights - returns true if we have real profile data for this method
4609     //                           or if we have some fake profile data for the stress mode
4610     bool fgIsUsingProfileWeights()
4611     {
4612         return (fgHaveProfileData() || fgStressBBProf());
4613     }
4614
4615     // fgProfileRunsCount - returns total number of scenario runs for the profile data
4616     //                      or BB_UNITY_WEIGHT when we aren't using profile data.
4617     unsigned fgProfileRunsCount()
4618     {
4619         return fgIsUsingProfileWeights() ? fgNumProfileRuns : BB_UNITY_WEIGHT;
4620     }
4621
4622 //-------- Insert a statement at the start or end of a basic block --------
4623
4624 #ifdef DEBUG
4625 public:
4626     static bool fgBlockContainsStatementBounded(BasicBlock* block, GenTree* stmt, bool answerOnBoundExceeded = true);
4627 #endif
4628
4629 public:
4630     GenTreeStmt* fgInsertStmtAtEnd(BasicBlock* block, GenTreePtr node);
4631
4632 public: // Used by linear scan register allocation
4633     GenTreeStmt* fgInsertStmtNearEnd(BasicBlock* block, GenTreePtr node);
4634
4635 private:
4636     GenTreePtr fgInsertStmtAtBeg(BasicBlock* block, GenTreePtr stmt);
4637     GenTreePtr fgInsertStmtAfter(BasicBlock* block, GenTreePtr insertionPoint, GenTreePtr stmt);
4638
4639 public: // Used by linear scan register allocation
4640     GenTreePtr fgInsertStmtBefore(BasicBlock* block, GenTreePtr insertionPoint, GenTreePtr stmt);
4641
4642 private:
4643     GenTreePtr fgInsertStmtListAfter(BasicBlock* block, GenTreePtr stmtAfter, GenTreePtr stmtList);
4644
4645     GenTreePtr fgMorphSplitTree(GenTree** splitPoint, GenTree* stmt, BasicBlock* blk);
4646
4647     //                  Create a new temporary variable to hold the result of *ppTree,
4648     //                  and transform the graph accordingly.
4649     GenTree* fgInsertCommaFormTemp(GenTree** ppTree, CORINFO_CLASS_HANDLE structType = nullptr);
4650     GenTree* fgMakeMultiUse(GenTree** ppTree);
4651
4652 private:
4653     //                  Recognize a bitwise rotation pattern and convert into a GT_ROL or a GT_ROR node.
4654     GenTreePtr fgRecognizeAndMorphBitwiseRotation(GenTreePtr tree);
4655     bool fgOperIsBitwiseRotationRoot(genTreeOps oper);
4656
4657     //-------- Determine the order in which the trees will be evaluated -------
4658
4659     unsigned fgTreeSeqNum;
4660     GenTree* fgTreeSeqLst;
4661     GenTree* fgTreeSeqBeg;
4662
4663     GenTree* fgSetTreeSeq(GenTree* tree, GenTree* prev = nullptr, bool isLIR = false);
4664     void fgSetTreeSeqHelper(GenTree* tree, bool isLIR);
4665     void fgSetTreeSeqFinish(GenTreePtr tree, bool isLIR);
4666     void fgSetStmtSeq(GenTree* tree);
4667     void fgSetBlockOrder(BasicBlock* block);
4668
4669     //------------------------- Morphing --------------------------------------
4670
4671     unsigned fgPtrArgCntCur;
4672     unsigned fgPtrArgCntMax;
4673     hashBv*  fgOutgoingArgTemps;
4674     hashBv*  fgCurrentlyInUseArgTemps;
4675
4676     bool compCanEncodePtrArgCntMax();
4677
4678     void fgSetRngChkTarget(GenTreePtr tree, bool delay = true);
4679
4680     BasicBlock* fgSetRngChkTargetInner(SpecialCodeKind kind, bool delay, unsigned* stkDepth);
4681
4682 #if REARRANGE_ADDS
4683     void fgMoveOpsLeft(GenTreePtr tree);
4684 #endif
4685
4686     bool fgIsCommaThrow(GenTreePtr tree, bool forFolding = false);
4687
4688     bool fgIsThrow(GenTreePtr tree);
4689
4690     bool fgInDifferentRegions(BasicBlock* blk1, BasicBlock* blk2);
4691     bool fgIsBlockCold(BasicBlock* block);
4692
4693     GenTreePtr fgMorphCastIntoHelper(GenTreePtr tree, int helper, GenTreePtr oper);
4694
4695     GenTreePtr fgMorphIntoHelperCall(GenTreePtr tree, int helper, GenTreeArgList* args);
4696
4697     GenTreePtr fgMorphStackArgForVarArgs(unsigned lclNum, var_types varType, unsigned lclOffs);
4698
4699     bool fgMorphRelopToQmark(GenTreePtr tree);
4700
4701     // A "MorphAddrContext" carries information from the surrounding context.  If we are evaluating a byref address,
4702     // it is useful to know whether the address will be immediately dereferenced, or whether the address value will
4703     // be used, perhaps by passing it as an argument to a called method.  This affects how null checking is done:
4704     // for sufficiently small offsets, we can rely on OS page protection to implicitly null-check addresses that we
4705     // know will be dereferenced.  To know that reliance on implicit null checking is sound, we must further know that
4706     // all offsets between the top-level indirection and the bottom are constant, and that their sum is sufficiently
4707     // small; hence the other fields of MorphAddrContext.
4708     enum MorphAddrContextKind
4709     {
4710         MACK_Ind,
4711         MACK_Addr,
4712     };
4713     struct MorphAddrContext
4714     {
4715         MorphAddrContextKind m_kind;
4716         bool                 m_allConstantOffsets; // Valid only for "m_kind == MACK_Ind".  True iff all offsets between
4717                                                    // top-level indirection and here have been constants.
4718         size_t m_totalOffset; // Valid only for "m_kind == MACK_Ind", and if "m_allConstantOffsets" is true.
4719                               // In that case, is the sum of those constant offsets.
4720
4721         MorphAddrContext(MorphAddrContextKind kind) : m_kind(kind), m_allConstantOffsets(true), m_totalOffset(0)
4722         {
4723         }
4724     };
4725
4726     // A MACK_CopyBlock context is immutable, so we can just make one of these and share it.
4727     static MorphAddrContext s_CopyBlockMAC;
4728
4729 #ifdef FEATURE_SIMD
4730     GenTreePtr getSIMDStructFromField(GenTreePtr tree,
4731                                       var_types* baseTypeOut,
4732                                       unsigned*  indexOut,
4733                                       unsigned*  simdSizeOut,
4734                                       bool       ignoreUsedInSIMDIntrinsic = false);
4735     GenTreePtr fgMorphFieldAssignToSIMDIntrinsicSet(GenTreePtr tree);
4736     GenTreePtr fgMorphFieldToSIMDIntrinsicGet(GenTreePtr tree);
4737     bool fgMorphCombineSIMDFieldAssignments(BasicBlock* block, GenTreePtr stmt);
4738     void impMarkContiguousSIMDFieldAssignments(GenTreePtr stmt);
4739
4740     // fgPreviousCandidateSIMDFieldAsgStmt is only used for tracking previous simd field assignment
4741     // in function: Complier::impMarkContiguousSIMDFieldAssignments.
4742     GenTreePtr fgPreviousCandidateSIMDFieldAsgStmt;
4743
4744 #endif // FEATURE_SIMD
4745     GenTreePtr fgMorphArrayIndex(GenTreePtr tree);
4746     GenTreePtr fgMorphCast(GenTreePtr tree);
4747     GenTreePtr fgUnwrapProxy(GenTreePtr objRef);
4748     GenTreeCall* fgMorphArgs(GenTreeCall* call);
4749
4750     void fgMakeOutgoingStructArgCopy(GenTreeCall*         call,
4751                                      GenTree*             args,
4752                                      unsigned             argIndex,
4753                                      CORINFO_CLASS_HANDLE copyBlkClass FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(
4754                                          const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* structDescPtr));
4755
4756     void fgFixupStructReturn(GenTreePtr call);
4757     GenTreePtr fgMorphLocalVar(GenTreePtr tree, bool forceRemorph);
4758
4759 public:
4760     bool fgAddrCouldBeNull(GenTreePtr addr);
4761
4762 private:
4763     GenTreePtr fgMorphField(GenTreePtr tree, MorphAddrContext* mac);
4764     bool fgCanFastTailCall(GenTreeCall* call);
4765     void fgMorphTailCall(GenTreeCall* call);
4766     void fgMorphRecursiveFastTailCallIntoLoop(BasicBlock* block, GenTreeCall* recursiveTailCall);
4767     GenTreePtr fgAssignRecursiveCallArgToCallerParam(GenTreePtr       arg,
4768                                                      fgArgTabEntryPtr argTabEntry,
4769                                                      BasicBlock*      block,
4770                                                      IL_OFFSETX       callILOffset,
4771                                                      GenTreePtr       tmpAssignmentInsertionPoint,
4772                                                      GenTreePtr       paramAssignmentInsertionPoint);
4773     static int fgEstimateCallStackSize(GenTreeCall* call);
4774     GenTreePtr fgMorphCall(GenTreeCall* call);
4775     void fgMorphCallInline(GenTreeCall* call, InlineResult* result);
4776     void fgMorphCallInlineHelper(GenTreeCall* call, InlineResult* result);
4777 #if DEBUG
4778     void fgNoteNonInlineCandidate(GenTreeStmt* stmt, GenTreeCall* call);
4779     static fgWalkPreFn fgFindNonInlineCandidate;
4780 #endif
4781     GenTreePtr fgOptimizeDelegateConstructor(GenTreeCall*            call,
4782                                              CORINFO_CONTEXT_HANDLE* ExactContextHnd,
4783                                              CORINFO_RESOLVED_TOKEN* ldftnToken);
4784     GenTreePtr fgMorphLeaf(GenTreePtr tree);
4785     void fgAssignSetVarDef(GenTreePtr tree);
4786     GenTreePtr fgMorphOneAsgBlockOp(GenTreePtr tree);
4787     GenTreePtr fgMorphInitBlock(GenTreePtr tree);
4788     GenTreePtr fgMorphBlkToInd(GenTreeBlk* tree, var_types type);
4789     GenTreePtr fgMorphGetStructAddr(GenTreePtr* pTree, CORINFO_CLASS_HANDLE clsHnd, bool isRValue = false);
4790     GenTreePtr fgMorphBlkNode(GenTreePtr tree, bool isDest);
4791     GenTreePtr fgMorphBlockOperand(GenTreePtr tree, var_types asgType, unsigned blockWidth, bool isDest);
4792     void fgMorphUnsafeBlk(GenTreeObj* obj);
4793     GenTreePtr fgMorphCopyBlock(GenTreePtr tree);
4794     GenTreePtr fgMorphForRegisterFP(GenTreePtr tree);
4795     GenTreePtr fgMorphSmpOp(GenTreePtr tree, MorphAddrContext* mac = nullptr);
4796     GenTreePtr fgMorphSmpOpPre(GenTreePtr tree);
4797     GenTreePtr fgMorphModToSubMulDiv(GenTreeOp* tree);
4798     GenTreePtr fgMorphSmpOpOptional(GenTreeOp* tree);
4799     GenTreePtr fgMorphRecognizeBoxNullable(GenTree* compare);
4800
4801     GenTreePtr fgMorphToEmulatedFP(GenTreePtr tree);
4802     GenTreePtr fgMorphConst(GenTreePtr tree);
4803
4804 public:
4805     GenTreePtr fgMorphTree(GenTreePtr tree, MorphAddrContext* mac = nullptr);
4806
4807 private:
4808 #if LOCAL_ASSERTION_PROP
4809     void fgKillDependentAssertionsSingle(unsigned lclNum DEBUGARG(GenTreePtr tree));
4810     void fgKillDependentAssertions(unsigned lclNum DEBUGARG(GenTreePtr tree));
4811 #endif
4812     void fgMorphTreeDone(GenTreePtr tree, GenTreePtr oldTree = nullptr DEBUGARG(int morphNum = 0));
4813
4814     GenTreeStmt* fgMorphStmt;
4815
4816     unsigned fgGetBigOffsetMorphingTemp(var_types type); // We cache one temp per type to be
4817                                                          // used when morphing big offset.
4818
4819     //----------------------- Liveness analysis -------------------------------
4820
4821     VARSET_TP fgCurUseSet; // vars used     by block (before an assignment)
4822     VARSET_TP fgCurDefSet; // vars assigned by block (before a use)
4823
4824     MemoryKindSet fgCurMemoryUse;   // True iff the current basic block uses memory.
4825     MemoryKindSet fgCurMemoryDef;   // True iff the current basic block modifies memory.
4826     MemoryKindSet fgCurMemoryHavoc; // True if  the current basic block is known to set memory to a "havoc" value.
4827
4828     bool byrefStatesMatchGcHeapStates; // True iff GcHeap and ByrefExposed memory have all the same def points.
4829
4830     void fgMarkUseDef(GenTreeLclVarCommon* tree);
4831
4832     void fgBeginScopeLife(VARSET_TP* inScope, VarScopeDsc* var);
4833     void fgEndScopeLife(VARSET_TP* inScope, VarScopeDsc* var);
4834
4835     void fgMarkInScope(BasicBlock* block, VARSET_VALARG_TP inScope);
4836     void fgUnmarkInScope(BasicBlock* block, VARSET_VALARG_TP unmarkScope);
4837
4838     void fgExtendDbgScopes();
4839     void fgExtendDbgLifetimes();
4840
4841 #ifdef DEBUG
4842     void fgDispDebugScopes();
4843 #endif // DEBUG
4844
4845     //-------------------------------------------------------------------------
4846     //
4847     //  The following keeps track of any code we've added for things like array
4848     //  range checking or explicit calls to enable GC, and so on.
4849     //
4850 public:
4851     struct AddCodeDsc
4852     {
4853         AddCodeDsc*     acdNext;
4854         BasicBlock*     acdDstBlk; // block  to  which we jump
4855         unsigned        acdData;
4856         SpecialCodeKind acdKind; // what kind of a special block is this?
4857         unsigned short  acdStkLvl;
4858     };
4859
4860 private:
4861     static unsigned acdHelper(SpecialCodeKind codeKind);
4862
4863     AddCodeDsc* fgAddCodeList;
4864     bool        fgAddCodeModf;
4865     bool        fgRngChkThrowAdded;
4866     AddCodeDsc* fgExcptnTargetCache[SCK_COUNT];
4867
4868     BasicBlock* fgRngChkTarget(BasicBlock* block, unsigned stkDepth, SpecialCodeKind kind);
4869
4870     BasicBlock* fgAddCodeRef(BasicBlock* srcBlk, unsigned refData, SpecialCodeKind kind, unsigned stkDepth = 0);
4871
4872 public:
4873     AddCodeDsc* fgFindExcptnTarget(SpecialCodeKind kind, unsigned refData);
4874
4875 private:
4876     bool fgIsCodeAdded();
4877
4878     bool fgIsThrowHlpBlk(BasicBlock* block);
4879     unsigned fgThrowHlpBlkStkLevel(BasicBlock* block);
4880
4881     unsigned fgBigOffsetMorphingTemps[TYP_COUNT];
4882
4883     unsigned fgCheckInlineDepthAndRecursion(InlineInfo* inlineInfo);
4884     void fgInvokeInlineeCompiler(GenTreeCall* call, InlineResult* result);
4885     void fgInsertInlineeBlocks(InlineInfo* pInlineInfo);
4886     GenTreePtr fgInlinePrependStatements(InlineInfo* inlineInfo);
4887     void fgInlineAppendStatements(InlineInfo* inlineInfo, BasicBlock* block, GenTreePtr stmt);
4888
4889 #if FEATURE_MULTIREG_RET
4890     GenTreePtr fgGetStructAsStructPtr(GenTreePtr tree);
4891     GenTreePtr fgAssignStructInlineeToVar(GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd);
4892     void fgAttachStructInlineeToAsg(GenTreePtr tree, GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd);
4893 #endif // FEATURE_MULTIREG_RET
4894
4895     static fgWalkPreFn fgUpdateInlineReturnExpressionPlaceHolder;
4896
4897 #ifdef DEBUG
4898     static fgWalkPreFn fgDebugCheckInlineCandidates;
4899
4900     void               CheckNoFatPointerCandidatesLeft();
4901     static fgWalkPreFn fgDebugCheckFatPointerCandidates;
4902 #endif
4903
4904     void         fgPromoteStructs();
4905     fgWalkResult fgMorphStructField(GenTreePtr tree, fgWalkData* fgWalkPre);
4906     fgWalkResult fgMorphLocalField(GenTreePtr tree, fgWalkData* fgWalkPre);
4907
4908     // Identify which parameters are implicit byrefs, and flag their LclVarDscs.
4909     void fgMarkImplicitByRefArgs();
4910
4911     // Change implicit byrefs' types from struct to pointer, and for any that were
4912     // promoted, create new promoted struct temps.
4913     void fgRetypeImplicitByRefArgs();
4914
4915     // Rewrite appearances of implicit byrefs (manifest the implied additional level of indirection).
4916     bool fgMorphImplicitByRefArgs(GenTreePtr tree);
4917     GenTreePtr fgMorphImplicitByRefArgs(GenTreePtr tree, bool isAddr);
4918
4919     // Clear up annotations for any struct promotion temps created for implicit byrefs.
4920     void fgMarkDemotedImplicitByRefArgs();
4921
4922     static fgWalkPreFn  fgMarkAddrTakenLocalsPreCB;
4923     static fgWalkPostFn fgMarkAddrTakenLocalsPostCB;
4924     void                fgMarkAddressExposedLocals();
4925     bool fgNodesMayInterfere(GenTree* store, GenTree* load);
4926
4927     static fgWalkPreFn  fgUpdateSideEffectsPre;
4928     static fgWalkPostFn fgUpdateSideEffectsPost;
4929
4930     // Returns true if the type of tree is of size at least "width", or if "tree" is not a
4931     // local variable.
4932     bool fgFitsInOrNotLoc(GenTreePtr tree, unsigned width);
4933
4934     // The given local variable, required to be a struct variable, is being assigned via
4935     // a "lclField", to make it masquerade as an integral type in the ABI.  Make sure that
4936     // the variable is not enregistered, and is therefore not promoted independently.
4937     void fgLclFldAssign(unsigned lclNum);
4938
4939     static fgWalkPreFn gtHasLocalsWithAddrOpCB;
4940     bool gtCanOptimizeTypeEquality(GenTreePtr tree);
4941     bool gtIsTypeHandleToRuntimeTypeHelper(GenTreeCall* call);
4942     bool gtIsActiveCSE_Candidate(GenTreePtr tree);
4943
4944 #ifdef DEBUG
4945     bool fgPrintInlinedMethods;
4946 #endif
4947
4948     bool fgIsBigOffset(size_t offset);
4949
4950     // The following are used when morphing special cases of integer div/mod operations and also by codegen
4951     bool fgIsSignedDivOptimizable(GenTreePtr divisor);
4952     bool fgIsUnsignedDivOptimizable(GenTreePtr divisor);
4953     bool fgIsSignedModOptimizable(GenTreePtr divisor);
4954     bool fgIsUnsignedModOptimizable(GenTreePtr divisor);
4955
4956     /*
4957     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4958     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4959     XX                                                                           XX
4960     XX                           Optimizer                                       XX
4961     XX                                                                           XX
4962     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4963     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4964     */
4965
4966 public:
4967     void optInit();
4968
4969 protected:
4970     LclVarDsc* optIsTrackedLocal(GenTreePtr tree);
4971
4972 public:
4973     void optRemoveRangeCheck(GenTreePtr tree, GenTreePtr stmt);
4974     bool optIsRangeCheckRemovable(GenTreePtr tree);
4975
4976 protected:
4977     static fgWalkPreFn optValidRangeCheckIndex;
4978     static fgWalkPreFn optRemoveTreeVisitor; // Helper passed to Compiler::fgWalkAllTreesPre() to decrement the LclVar
4979                                              // usage counts
4980
4981     void optRemoveTree(GenTreePtr deadTree, GenTreePtr keepList);
4982
4983     /**************************************************************************
4984      *
4985      *************************************************************************/
4986
4987 protected:
4988     // Do hoisting for all loops.
4989     void optHoistLoopCode();
4990
4991     // To represent sets of VN's that have already been hoisted in outer loops.
4992     typedef SimplerHashTable<ValueNum, SmallPrimitiveKeyFuncs<ValueNum>, bool, JitSimplerHashBehavior> VNToBoolMap;
4993     typedef VNToBoolMap VNSet;
4994
4995     struct LoopHoistContext
4996     {
4997     private:
4998         // The set of variables hoisted in the current loop (or nullptr if there are none).
4999         VNSet* m_pHoistedInCurLoop;
5000
5001     public:
5002         // Value numbers of expressions that have been hoisted in parent loops in the loop nest.
5003         VNSet m_hoistedInParentLoops;
5004         // Value numbers of expressions that have been hoisted in the current (or most recent) loop in the nest.
5005         // Previous decisions on loop-invariance of value numbers in the current loop.
5006         VNToBoolMap m_curLoopVnInvariantCache;
5007
5008         VNSet* GetHoistedInCurLoop(Compiler* comp)
5009         {
5010             if (m_pHoistedInCurLoop == nullptr)
5011             {
5012                 m_pHoistedInCurLoop = new (comp->getAllocatorLoopHoist()) VNSet(comp->getAllocatorLoopHoist());
5013             }
5014             return m_pHoistedInCurLoop;
5015         }
5016
5017         VNSet* ExtractHoistedInCurLoop()
5018         {
5019             VNSet* res          = m_pHoistedInCurLoop;
5020             m_pHoistedInCurLoop = nullptr;
5021             return res;
5022         }
5023
5024         LoopHoistContext(Compiler* comp)
5025             : m_pHoistedInCurLoop(nullptr)
5026             , m_hoistedInParentLoops(comp->getAllocatorLoopHoist())
5027             , m_curLoopVnInvariantCache(comp->getAllocatorLoopHoist())
5028         {
5029         }
5030     };
5031
5032     // Do hoisting for loop "lnum" (an index into the optLoopTable), and all loops nested within it.
5033     // Tracks the expressions that have been hoisted by containing loops by temporary recording their
5034     // value numbers in "m_hoistedInParentLoops".  This set is not modified by the call.
5035     void optHoistLoopNest(unsigned lnum, LoopHoistContext* hoistCtxt);
5036
5037     // Do hoisting for a particular loop ("lnum" is an index into the optLoopTable.)
5038     // Assumes that expressions have been hoisted in containing loops if their value numbers are in
5039     // "m_hoistedInParentLoops".
5040     //
5041     void optHoistThisLoop(unsigned lnum, LoopHoistContext* hoistCtxt);
5042
5043     // Hoist all expressions in "blk" that are invariant in loop "lnum" (an index into the optLoopTable)
5044     // outside of that loop.  Exempt expressions whose value number is in "m_hoistedInParentLoops"; add VN's of hoisted
5045     // expressions to "hoistInLoop".
5046     void optHoistLoopExprsForBlock(BasicBlock* blk, unsigned lnum, LoopHoistContext* hoistCtxt);
5047
5048     // Return true if the tree looks profitable to hoist out of loop 'lnum'.
5049     bool optIsProfitableToHoistableTree(GenTreePtr tree, unsigned lnum);
5050
5051     // Hoist all proper sub-expressions of "tree" (which occurs in "stmt", which occurs in "blk")
5052     // that are invariant in loop "lnum" (an index into the optLoopTable)
5053     // outside of that loop.  Exempt expressions whose value number is in "hoistedInParents"; add VN's of hoisted
5054     // expressions to "hoistInLoop".
5055     // Returns "true" iff "tree" is loop-invariant (wrt "lnum").
5056     // Assumes that the value of "*firstBlockAndBeforeSideEffect" indicates that we're in the first block, and before
5057     // any possible globally visible side effects.  Assume is called in evaluation order, and updates this.
5058     bool optHoistLoopExprsForTree(GenTreePtr        tree,
5059                                   unsigned          lnum,
5060                                   LoopHoistContext* hoistCtxt,
5061                                   bool*             firstBlockAndBeforeSideEffect,
5062                                   bool*             pHoistable,
5063                                   bool*             pCctorDependent);
5064
5065     // Performs the hoisting 'tree' into the PreHeader for loop 'lnum'
5066     void optHoistCandidate(GenTreePtr tree, unsigned lnum, LoopHoistContext* hoistCtxt);
5067
5068     // Returns true iff the ValueNum "vn" represents a value that is loop-invariant in "lnum".
5069     //   Constants and init values are always loop invariant.
5070     //   VNPhi's connect VN's to the SSA definition, so we can know if the SSA def occurs in the loop.
5071     bool optVNIsLoopInvariant(ValueNum vn, unsigned lnum, VNToBoolMap* recordedVNs);
5072
5073     // Returns "true" iff "tree" is valid at the head of loop "lnum", in the context of the hoist substitution
5074     // "subst".  If "tree" is a local SSA var, it is valid if its SSA definition occurs outside of the loop, or
5075     // if it is in the domain of "subst" (meaning that it's definition has been previously hoisted, with a "standin"
5076     // local.)  If tree is a constant, it is valid.  Otherwise, if it is an operator, it is valid iff its children are.
5077     bool optTreeIsValidAtLoopHead(GenTreePtr tree, unsigned lnum);
5078
5079     // If "blk" is the entry block of a natural loop, returns true and sets "*pLnum" to the index of the loop
5080     // in the loop table.
5081     bool optBlockIsLoopEntry(BasicBlock* blk, unsigned* pLnum);
5082
5083     // Records the set of "side effects" of all loops: fields (object instance and static)
5084     // written to, and SZ-array element type equivalence classes updated.
5085     void optComputeLoopSideEffects();
5086
5087 private:
5088     // Requires "lnum" to be the index of an outermost loop in the loop table.  Traverses the body of that loop,
5089     // including all nested loops, and records the set of "side effects" of the loop: fields (object instance and
5090     // static) written to, and SZ-array element type equivalence classes updated.
5091     void optComputeLoopNestSideEffects(unsigned lnum);
5092
5093     // Add the side effects of "blk" (which is required to be within a loop) to all loops of which it is a part.
5094     void optComputeLoopSideEffectsOfBlock(BasicBlock* blk);
5095
5096     // Hoist the expression "expr" out of loop "lnum".
5097     void optPerformHoistExpr(GenTreePtr expr, unsigned lnum);
5098
5099 public:
5100     void optOptimizeBools();
5101
5102 private:
5103     GenTree* optIsBoolCond(GenTree* condBranch, GenTree** compPtr, bool* boolPtr);
5104 #ifdef DEBUG
5105     void optOptimizeBoolsGcStress(BasicBlock* condBlock);
5106 #endif
5107 public:
5108     void optOptimizeLayout(); // Optimize the BasicBlock layout of the method
5109
5110     void optOptimizeLoops(); // for "while-do" loops duplicates simple loop conditions and transforms
5111                              // the loop into a "do-while" loop
5112                              // Also finds all natural loops and records them in the loop table
5113
5114     // Optionally clone loops in the loop table.
5115     void optCloneLoops();
5116
5117     // Clone loop "loopInd" in the loop table.
5118     void optCloneLoop(unsigned loopInd, LoopCloneContext* context);
5119
5120     // Ensure that loop "loopInd" has a unique head block.  (If the existing entry has
5121     // non-loop predecessors other than the head entry, create a new, empty block that goes (only) to the entry,
5122     // and redirects the preds of the entry to this new block.)  Sets the weight of the newly created block to
5123     // "ambientWeight".
5124     void optEnsureUniqueHead(unsigned loopInd, unsigned ambientWeight);
5125
5126     void optUnrollLoops(); // Unrolls loops (needs to have cost info)
5127
5128 protected:
5129     // This enumeration describes what is killed by a call.
5130
5131     enum callInterf
5132     {
5133         CALLINT_NONE,       // no interference                               (most helpers)
5134         CALLINT_REF_INDIRS, // kills GC ref indirections                     (SETFIELD OBJ)
5135         CALLINT_SCL_INDIRS, // kills non GC ref indirections                 (SETFIELD non-OBJ)
5136         CALLINT_ALL_INDIRS, // kills both GC ref and non GC ref indirections (SETFIELD STRUCT)
5137         CALLINT_ALL,        // kills everything                              (normal method call)
5138     };
5139
5140 public:
5141     // A "LoopDsc" describes a ("natural") loop.  We (currently) require the body of a loop to be a contiguous (in
5142     // bbNext order) sequence of basic blocks.  (At times, we may require the blocks in a loop to be "properly numbered"
5143     // in bbNext order; we use comparisons on the bbNum to decide order.)
5144     // The blocks that define the body are
5145     //   first <= top <= entry <= bottom   .
5146     // The "head" of the loop is a block outside the loop that has "entry" as a successor. We only support loops with a
5147     // single 'head' block. The meanings of these blocks are given in the definitions below. Also see the picture at
5148     // Compiler::optFindNaturalLoops().
5149     struct LoopDsc
5150     {
5151         BasicBlock* lpHead;  // HEAD of the loop (not part of the looping of the loop) -- has ENTRY as a successor.
5152         BasicBlock* lpFirst; // FIRST block (in bbNext order) reachable within this loop.  (May be part of a nested
5153                              // loop, but not the outer loop.)
5154         BasicBlock* lpTop;   // loop TOP (the back edge from lpBottom reaches here) (in most cases FIRST and TOP are the
5155                              // same)
5156         BasicBlock* lpEntry; // the ENTRY in the loop (in most cases TOP or BOTTOM)
5157         BasicBlock* lpBottom; // loop BOTTOM (from here we have a back edge to the TOP)
5158         BasicBlock* lpExit;   // if a single exit loop this is the EXIT (in most cases BOTTOM)
5159
5160         callInterf   lpAsgCall;     // "callInterf" for calls in the loop
5161         ALLVARSET_TP lpAsgVars;     // set of vars assigned within the loop (all vars, not just tracked)
5162         varRefKinds  lpAsgInds : 8; // set of inds modified within the loop
5163
5164         unsigned short lpFlags; // Mask of the LPFLG_* constants
5165
5166         unsigned char lpExitCnt; // number of exits from the loop
5167
5168         unsigned char lpParent;  // The index of the most-nested loop that completely contains this one,
5169                                  // or else BasicBlock::NOT_IN_LOOP if no such loop exists.
5170         unsigned char lpChild;   // The index of a nested loop, or else BasicBlock::NOT_IN_LOOP if no child exists.
5171                                  // (Actually, an "immediately" nested loop --
5172                                  // no other child of this loop is a parent of lpChild.)
5173         unsigned char lpSibling; // The index of another loop that is an immediate child of lpParent,
5174                                  // or else BasicBlock::NOT_IN_LOOP.  One can enumerate all the children of a loop
5175                                  // by following "lpChild" then "lpSibling" links.
5176
5177 #define LPFLG_DO_WHILE 0x0001 // it's a do-while loop (i.e ENTRY is at the TOP)
5178 #define LPFLG_ONE_EXIT 0x0002 // the loop has only one exit
5179
5180 #define LPFLG_ITER 0x0004      // for (i = icon or lclVar; test_condition(); i++)
5181 #define LPFLG_HOISTABLE 0x0008 // the loop is in a form that is suitable for hoisting expressions
5182 #define LPFLG_CONST 0x0010     // for (i=icon;i<icon;i++){ ... } - constant loop
5183
5184 #define LPFLG_VAR_INIT 0x0020   // iterator is initialized with a local var (var # found in lpVarInit)
5185 #define LPFLG_CONST_INIT 0x0040 // iterator is initialized with a constant (found in lpConstInit)
5186
5187 #define LPFLG_VAR_LIMIT 0x0100    // iterator is compared with a local var (var # found in lpVarLimit)
5188 #define LPFLG_CONST_LIMIT 0x0200  // iterator is compared with a constant (found in lpConstLimit)
5189 #define LPFLG_ARRLEN_LIMIT 0x0400 // iterator is compared with a.len or a[i].len (found in lpArrLenLimit)
5190 #define LPFLG_SIMD_LIMIT 0x0080   // iterator is compared with Vector<T>.Count (found in lpConstLimit)
5191
5192 #define LPFLG_HAS_PREHEAD 0x0800 // lpHead is known to be a preHead for this loop
5193 #define LPFLG_REMOVED 0x1000     // has been removed from the loop table (unrolled or optimized away)
5194 #define LPFLG_DONT_UNROLL 0x2000 // do not unroll this loop
5195
5196 #define LPFLG_ASGVARS_YES 0x4000 // "lpAsgVars" has been  computed
5197 #define LPFLG_ASGVARS_INC 0x8000 // "lpAsgVars" is incomplete -- vars beyond those representable in an AllVarSet
5198                                  // type are assigned to.
5199
5200         bool lpLoopHasMemoryHavoc[MemoryKindCount]; // The loop contains an operation that we assume has arbitrary
5201                                                     // memory side effects.  If this is set, the fields below
5202                                                     // may not be accurate (since they become irrelevant.)
5203         bool lpContainsCall;                        // True if executing the loop body *may* execute a call
5204
5205         VARSET_TP lpVarInOut;  // The set of variables that are IN or OUT during the execution of this loop
5206         VARSET_TP lpVarUseDef; // The set of variables that are USE or DEF during the execution of this loop
5207
5208         int lpHoistedExprCount; // The register count for the non-FP expressions from inside this loop that have been
5209                                 // hoisted
5210         int lpLoopVarCount;     // The register count for the non-FP LclVars that are read/written inside this loop
5211         int lpVarInOutCount;    // The register count for the non-FP LclVars that are alive inside or accross this loop
5212
5213         int lpHoistedFPExprCount; // The register count for the FP expressions from inside this loop that have been
5214                                   // hoisted
5215         int lpLoopVarFPCount;     // The register count for the FP LclVars that are read/written inside this loop
5216         int lpVarInOutFPCount;    // The register count for the FP LclVars that are alive inside or accross this loop
5217
5218         typedef SimplerHashTable<CORINFO_FIELD_HANDLE,
5219                                  PtrKeyFuncs<struct CORINFO_FIELD_STRUCT_>,
5220                                  bool,
5221                                  JitSimplerHashBehavior>
5222                         FieldHandleSet;
5223         FieldHandleSet* lpFieldsModified; // This has entries (mappings to "true") for all static field and object
5224                                           // instance fields modified
5225                                           // in the loop.
5226
5227         typedef SimplerHashTable<CORINFO_CLASS_HANDLE,
5228                                  PtrKeyFuncs<struct CORINFO_CLASS_STRUCT_>,
5229                                  bool,
5230                                  JitSimplerHashBehavior>
5231                         ClassHandleSet;
5232         ClassHandleSet* lpArrayElemTypesModified; // Bits set indicate the set of sz array element types such that
5233                                                   // arrays of that type are modified
5234                                                   // in the loop.
5235
5236         // Adds the variable liveness information for 'blk' to 'this' LoopDsc
5237         void AddVariableLiveness(Compiler* comp, BasicBlock* blk);
5238
5239         inline void AddModifiedField(Compiler* comp, CORINFO_FIELD_HANDLE fldHnd);
5240         // This doesn't *always* take a class handle -- it can also take primitive types, encoded as class handles
5241         // (shifted left, with a low-order bit set to distinguish.)
5242         // Use the {Encode/Decode}ElemType methods to construct/destruct these.
5243         inline void AddModifiedElemType(Compiler* comp, CORINFO_CLASS_HANDLE structHnd);
5244
5245         /* The following values are set only for iterator loops, i.e. has the flag LPFLG_ITER set */
5246
5247         GenTreePtr lpIterTree;    // The "i <op>= const" tree
5248         unsigned   lpIterVar();   // iterator variable #
5249         int        lpIterConst(); // the constant with which the iterator is incremented
5250         genTreeOps lpIterOper();  // the type of the operation on the iterator (ASG_ADD, ASG_SUB, etc.)
5251         void       VERIFY_lpIterTree();
5252
5253         var_types lpIterOperType(); // For overflow instructions
5254
5255         union {
5256             int lpConstInit; // initial constant value of iterator                           : Valid if LPFLG_CONST_INIT
5257             unsigned lpVarInit; // initial local var number to which we initialize the iterator : Valid if
5258                                 // LPFLG_VAR_INIT
5259         };
5260
5261         /* The following is for LPFLG_ITER loops only (i.e. the loop condition is "i RELOP const or var" */
5262
5263         GenTreePtr lpTestTree;   // pointer to the node containing the loop test
5264         genTreeOps lpTestOper(); // the type of the comparison between the iterator and the limit (GT_LE, GT_GE, etc.)
5265         void       VERIFY_lpTestTree();
5266
5267         bool       lpIsReversed(); // true if the iterator node is the second operand in the loop condition
5268         GenTreePtr lpIterator();   // the iterator node in the loop test
5269         GenTreePtr lpLimit();      // the limit node in the loop test
5270
5271         int lpConstLimit();    // limit   constant value of iterator - loop condition is "i RELOP const" : Valid if
5272                                // LPFLG_CONST_LIMIT
5273         unsigned lpVarLimit(); // the lclVar # in the loop condition ( "i RELOP lclVar" )                : Valid if
5274                                // LPFLG_VAR_LIMIT
5275         bool lpArrLenLimit(Compiler* comp, ArrIndex* index); // The array length in the loop condition ( "i RELOP
5276                                                              // arr.len" or "i RELOP arr[i][j].len" )  : Valid if
5277                                                              // LPFLG_ARRLEN_LIMIT
5278
5279         // Returns "true" iff "*this" contains the blk.
5280         bool lpContains(BasicBlock* blk)
5281         {
5282             return lpFirst->bbNum <= blk->bbNum && blk->bbNum <= lpBottom->bbNum;
5283         }
5284         // Returns "true" iff "*this" (properly) contains the range [first, bottom] (allowing firsts
5285         // to be equal, but requiring bottoms to be different.)
5286         bool lpContains(BasicBlock* first, BasicBlock* bottom)
5287         {
5288             return lpFirst->bbNum <= first->bbNum && bottom->bbNum < lpBottom->bbNum;
5289         }
5290
5291         // Returns "true" iff "*this" (properly) contains "lp2" (allowing firsts to be equal, but requiring
5292         // bottoms to be different.)
5293         bool lpContains(const LoopDsc& lp2)
5294         {
5295             return lpContains(lp2.lpFirst, lp2.lpBottom);
5296         }
5297
5298         // Returns "true" iff "*this" is (properly) contained by the range [first, bottom]
5299         // (allowing firsts to be equal, but requiring bottoms to be different.)
5300         bool lpContainedBy(BasicBlock* first, BasicBlock* bottom)
5301         {
5302             return first->bbNum <= lpFirst->bbNum && lpBottom->bbNum < bottom->bbNum;
5303         }
5304
5305         // Returns "true" iff "*this" is (properly) contained by "lp2"
5306         // (allowing firsts to be equal, but requiring bottoms to be different.)
5307         bool lpContainedBy(const LoopDsc& lp2)
5308         {
5309             return lpContains(lp2.lpFirst, lp2.lpBottom);
5310         }
5311
5312         // Returns "true" iff "*this" is disjoint from the range [top, bottom].
5313         bool lpDisjoint(BasicBlock* first, BasicBlock* bottom)
5314         {
5315             return bottom->bbNum < lpFirst->bbNum || lpBottom->bbNum < first->bbNum;
5316         }
5317         // Returns "true" iff "*this" is disjoint from "lp2".
5318         bool lpDisjoint(const LoopDsc& lp2)
5319         {
5320             return lpDisjoint(lp2.lpFirst, lp2.lpBottom);
5321         }
5322         // Returns "true" iff the loop is well-formed (see code for defn).
5323         bool lpWellFormed()
5324         {
5325             return lpFirst->bbNum <= lpTop->bbNum && lpTop->bbNum <= lpEntry->bbNum &&
5326                    lpEntry->bbNum <= lpBottom->bbNum &&
5327                    (lpHead->bbNum < lpTop->bbNum || lpHead->bbNum > lpBottom->bbNum);
5328         }
5329     };
5330
5331 protected:
5332     bool fgMightHaveLoop(); // returns true if there are any backedges
5333     bool fgHasLoops;        // True if this method has any loops, set in fgComputeReachability
5334
5335 public:
5336     LoopDsc       optLoopTable[MAX_LOOP_NUM]; // loop descriptor table
5337     unsigned char optLoopCount;               // number of tracked loops
5338
5339     bool optRecordLoop(BasicBlock*   head,
5340                        BasicBlock*   first,
5341                        BasicBlock*   top,
5342                        BasicBlock*   entry,
5343                        BasicBlock*   bottom,
5344                        BasicBlock*   exit,
5345                        unsigned char exitCnt);
5346
5347 protected:
5348     unsigned optCallCount;         // number of calls made in the method
5349     unsigned optIndirectCallCount; // number of virtual, interface and indirect calls made in the method
5350     unsigned optNativeCallCount;   // number of Pinvoke/Native calls made in the method
5351     unsigned optLoopsCloned;       // number of loops cloned in the current method.
5352
5353 #ifdef DEBUG
5354     unsigned optFindLoopNumberFromBeginBlock(BasicBlock* begBlk);
5355     void optPrintLoopInfo(unsigned      loopNum,
5356                           BasicBlock*   lpHead,
5357                           BasicBlock*   lpFirst,
5358                           BasicBlock*   lpTop,
5359                           BasicBlock*   lpEntry,
5360                           BasicBlock*   lpBottom,
5361                           unsigned char lpExitCnt,
5362                           BasicBlock*   lpExit,
5363                           unsigned      parentLoop = BasicBlock::NOT_IN_LOOP);
5364     void optPrintLoopInfo(unsigned lnum);
5365     void optPrintLoopRecording(unsigned lnum);
5366
5367     void optCheckPreds();
5368 #endif
5369
5370     void optSetBlockWeights();
5371
5372     void optMarkLoopBlocks(BasicBlock* begBlk, BasicBlock* endBlk, bool excludeEndBlk);
5373
5374     void optUnmarkLoopBlocks(BasicBlock* begBlk, BasicBlock* endBlk);
5375
5376     void optUpdateLoopsBeforeRemoveBlock(BasicBlock* block, bool skipUnmarkLoop = false);
5377
5378     bool optIsLoopTestEvalIntoTemp(GenTreePtr test, GenTreePtr* newTest);
5379     unsigned optIsLoopIncrTree(GenTreePtr incr);
5380     bool optCheckIterInLoopTest(unsigned loopInd, GenTreePtr test, BasicBlock* from, BasicBlock* to, unsigned iterVar);
5381     bool optComputeIterInfo(GenTreePtr incr, BasicBlock* from, BasicBlock* to, unsigned* pIterVar);
5382     bool optPopulateInitInfo(unsigned loopInd, GenTreePtr init, unsigned iterVar);
5383     bool optExtractInitTestIncr(BasicBlock* head,
5384                                 BasicBlock* bottom,
5385                                 BasicBlock* exit,
5386                                 GenTreePtr* ppInit,
5387                                 GenTreePtr* ppTest,
5388                                 GenTreePtr* ppIncr);
5389
5390     void optFindNaturalLoops();
5391
5392     // Ensures that all the loops in the loop nest rooted at "loopInd" (an index into the loop table) are 'canonical' --
5393     // each loop has a unique "top."  Returns "true" iff the flowgraph has been modified.
5394     bool optCanonicalizeLoopNest(unsigned char loopInd);
5395
5396     // Ensures that the loop "loopInd" (an index into the loop table) is 'canonical' -- it has a unique "top,"
5397     // unshared with any other loop.  Returns "true" iff the flowgraph has been modified
5398     bool optCanonicalizeLoop(unsigned char loopInd);
5399
5400     // Requires "l1" to be a valid loop table index, and not "BasicBlock::NOT_IN_LOOP".  Requires "l2" to be
5401     // a valid loop table index, or else "BasicBlock::NOT_IN_LOOP".  Returns true
5402     // iff "l2" is not NOT_IN_LOOP, and "l1" contains "l2".
5403     bool optLoopContains(unsigned l1, unsigned l2);
5404
5405     // Requires "loopInd" to be a valid index into the loop table.
5406     // Updates the loop table by changing loop "loopInd", whose head is required
5407     // to be "from", to be "to".  Also performs this transformation for any
5408     // loop nested in "loopInd" that shares the same head as "loopInd".
5409     void optUpdateLoopHead(unsigned loopInd, BasicBlock* from, BasicBlock* to);
5410
5411     // Updates the successors of "blk": if "blk2" is a successor of "blk", and there is a mapping for "blk2->blk3" in
5412     // "redirectMap", change "blk" so that "blk3" is this successor. Note that the predecessor lists are not updated.
5413     void optRedirectBlock(BasicBlock* blk, BlockToBlockMap* redirectMap);
5414
5415     // Marks the containsCall information to "lnum" and any parent loops.
5416     void AddContainsCallAllContainingLoops(unsigned lnum);
5417     // Adds the variable liveness information from 'blk' to "lnum" and any parent loops.
5418     void AddVariableLivenessAllContainingLoops(unsigned lnum, BasicBlock* blk);
5419     // Adds "fldHnd" to the set of modified fields of "lnum" and any parent loops.
5420     void AddModifiedFieldAllContainingLoops(unsigned lnum, CORINFO_FIELD_HANDLE fldHnd);
5421     // Adds "elemType" to the set of modified array element types of "lnum" and any parent loops.
5422     void AddModifiedElemTypeAllContainingLoops(unsigned lnum, CORINFO_CLASS_HANDLE elemType);
5423
5424     // Requires that "from" and "to" have the same "bbJumpKind" (perhaps because "to" is a clone
5425     // of "from".)  Copies the jump destination from "from" to "to".
5426     void optCopyBlkDest(BasicBlock* from, BasicBlock* to);
5427
5428     // The depth of the loop described by "lnum" (an index into the loop table.) (0 == top level)
5429     unsigned optLoopDepth(unsigned lnum)
5430     {
5431         unsigned par = optLoopTable[lnum].lpParent;
5432         if (par == BasicBlock::NOT_IN_LOOP)
5433         {
5434             return 0;
5435         }
5436         else
5437         {
5438             return 1 + optLoopDepth(par);
5439         }
5440     }
5441
5442     void fgOptWhileLoop(BasicBlock* block);
5443
5444     bool optComputeLoopRep(int        constInit,
5445                            int        constLimit,
5446                            int        iterInc,
5447                            genTreeOps iterOper,
5448                            var_types  iterType,
5449                            genTreeOps testOper,
5450                            bool       unsignedTest,
5451                            bool       dupCond,
5452                            unsigned*  iterCount);
5453 #if FEATURE_STACK_FP_X87
5454
5455 public:
5456     VARSET_TP optAllFloatVars; // mask of all tracked      FP variables
5457     VARSET_TP optAllFPregVars; // mask of all enregistered FP variables
5458     VARSET_TP optAllNonFPvars; // mask of all tracked  non-FP variables
5459 #endif                         // FEATURE_STACK_FP_X87
5460
5461 private:
5462     static fgWalkPreFn optIsVarAssgCB;
5463
5464 protected:
5465     bool optIsVarAssigned(BasicBlock* beg, BasicBlock* end, GenTreePtr skip, unsigned var);
5466
5467     bool optIsVarAssgLoop(unsigned lnum, unsigned var);
5468
5469     int optIsSetAssgLoop(unsigned lnum, ALLVARSET_VALARG_TP vars, varRefKinds inds = VR_NONE);
5470
5471     bool optNarrowTree(GenTreePtr tree, var_types srct, var_types dstt, ValueNumPair vnpNarrow, bool doit);
5472
5473     /**************************************************************************
5474      *                       Optimization conditions
5475      *************************************************************************/
5476
5477     bool optFastCodeOrBlendedLoop(BasicBlock::weight_t bbWeight);
5478     bool optPentium4(void);
5479     bool optAvoidIncDec(BasicBlock::weight_t bbWeight);
5480     bool optAvoidIntMult(void);
5481
5482 #if FEATURE_ANYCSE
5483
5484 protected:
5485     //  The following is the upper limit on how many expressions we'll keep track
5486     //  of for the CSE analysis.
5487     //
5488     static const unsigned MAX_CSE_CNT = EXPSET_SZ;
5489
5490     static const int MIN_CSE_COST = 2;
5491
5492     // Keeps tracked cse indices
5493     BitVecTraits* cseTraits;
5494     EXPSET_TP     cseFull;
5495
5496     /* Generic list of nodes - used by the CSE logic */
5497
5498     struct treeLst
5499     {
5500         treeLst*   tlNext;
5501         GenTreePtr tlTree;
5502     };
5503
5504     typedef struct treeLst* treeLstPtr;
5505
5506     struct treeStmtLst
5507     {
5508         treeStmtLst* tslNext;
5509         GenTreePtr   tslTree;  // tree node
5510         GenTreePtr   tslStmt;  // statement containing the tree
5511         BasicBlock*  tslBlock; // block containing the statement
5512     };
5513
5514     typedef struct treeStmtLst* treeStmtLstPtr;
5515
5516     // The following logic keeps track of expressions via a simple hash table.
5517
5518     struct CSEdsc
5519     {
5520         CSEdsc* csdNextInBucket; // used by the hash table
5521
5522         unsigned csdHashValue; // the orginal hashkey
5523
5524         unsigned csdIndex;          // 1..optCSECandidateCount
5525         char     csdLiveAcrossCall; // 0 or 1
5526
5527         unsigned short csdDefCount; // definition   count
5528         unsigned short csdUseCount; // use          count  (excluding the implicit uses at defs)
5529
5530         unsigned csdDefWtCnt; // weighted def count
5531         unsigned csdUseWtCnt; // weighted use count  (excluding the implicit uses at defs)
5532
5533         GenTreePtr  csdTree;  // treenode containing the 1st occurance
5534         GenTreePtr  csdStmt;  // stmt containing the 1st occurance
5535         BasicBlock* csdBlock; // block containing the 1st occurance
5536
5537         treeStmtLstPtr csdTreeList; // list of matching tree nodes: head
5538         treeStmtLstPtr csdTreeLast; // list of matching tree nodes: tail
5539
5540         ValueNum defConservativeVN; // if all def occurrences share the same conservative value
5541                                     // number, this will reflect it; otherwise, NoVN.
5542     };
5543
5544     static const size_t s_optCSEhashSize;
5545     CSEdsc**            optCSEhash;
5546     CSEdsc**            optCSEtab;
5547
5548     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, GenTreePtr, JitSimplerHashBehavior> NodeToNodeMap;
5549
5550     NodeToNodeMap* optCseCheckedBoundMap; // Maps bound nodes to ancestor compares that should be
5551                                           // re-numbered with the bound to improve range check elimination
5552
5553     // Given a compare, look for a cse candidate checked bound feeding it and add a map entry if found.
5554     void optCseUpdateCheckedBoundMap(GenTreePtr compare);
5555
5556     void optCSEstop();
5557
5558     CSEdsc* optCSEfindDsc(unsigned index);
5559     void optUnmarkCSE(GenTreePtr tree);
5560
5561     // user defined callback data for the tree walk function optCSE_MaskHelper()
5562     struct optCSE_MaskData
5563     {
5564         EXPSET_TP CSE_defMask;
5565         EXPSET_TP CSE_useMask;
5566     };
5567
5568     // Treewalk helper for optCSE_DefMask and optCSE_UseMask
5569     static fgWalkPreFn optCSE_MaskHelper;
5570
5571     // This function walks all the node for an given tree
5572     // and return the mask of CSE definitions and uses for the tree
5573     //
5574     void optCSE_GetMaskData(GenTreePtr tree, optCSE_MaskData* pMaskData);
5575
5576     // Given a binary tree node return true if it is safe to swap the order of evaluation for op1 and op2.
5577     bool optCSE_canSwap(GenTree* firstNode, GenTree* secondNode);
5578     bool optCSE_canSwap(GenTree* tree);
5579
5580     static fgWalkPostFn optPropagateNonCSE;
5581     static fgWalkPreFn  optHasNonCSEChild;
5582
5583     static fgWalkPreFn optUnmarkCSEs;
5584
5585     static int __cdecl optCSEcostCmpEx(const void* op1, const void* op2);
5586     static int __cdecl optCSEcostCmpSz(const void* op1, const void* op2);
5587
5588     void optCleanupCSEs();
5589
5590 #ifdef DEBUG
5591     void optEnsureClearCSEInfo();
5592 #endif // DEBUG
5593
5594 #endif // FEATURE_ANYCSE
5595
5596 #if FEATURE_VALNUM_CSE
5597     /**************************************************************************
5598      *                   Value Number based CSEs
5599      *************************************************************************/
5600
5601 public:
5602     void optOptimizeValnumCSEs();
5603
5604 protected:
5605     void     optValnumCSE_Init();
5606     unsigned optValnumCSE_Index(GenTreePtr tree, GenTreePtr stmt);
5607     unsigned optValnumCSE_Locate();
5608     void     optValnumCSE_InitDataFlow();
5609     void     optValnumCSE_DataFlow();
5610     void     optValnumCSE_Availablity();
5611     void     optValnumCSE_Heuristic();
5612     void optValnumCSE_UnmarkCSEs(GenTreePtr deadTree, GenTreePtr keepList);
5613
5614 #endif // FEATURE_VALNUM_CSE
5615
5616 #if FEATURE_ANYCSE
5617     bool     optDoCSE;             // True when we have found a duplicate CSE tree
5618     bool     optValnumCSE_phase;   // True when we are executing the optValnumCSE_phase
5619     unsigned optCSECandidateTotal; // Grand total of CSE candidates for both Lexical and ValNum
5620     unsigned optCSECandidateCount; // Count of CSE's candidates, reset for Lexical and ValNum CSE's
5621     unsigned optCSEstart;          // The first local variable number that is a CSE
5622     unsigned optCSEcount;          // The total count of CSE's introduced.
5623     unsigned optCSEweight;         // The weight of the current block when we are
5624                                    // scanning for CSE expressions
5625
5626     bool optIsCSEcandidate(GenTreePtr tree);
5627
5628     // lclNumIsTrueCSE returns true if the LclVar was introduced by the CSE phase of the compiler
5629     //
5630     bool lclNumIsTrueCSE(unsigned lclNum) const
5631     {
5632         return ((optCSEcount > 0) && (lclNum >= optCSEstart) && (lclNum < optCSEstart + optCSEcount));
5633     }
5634
5635     //  lclNumIsCSE returns true if the LclVar should be treated like a CSE with regards to constant prop.
5636     //
5637     bool lclNumIsCSE(unsigned lclNum) const
5638     {
5639         return lvaTable[lclNum].lvIsCSE;
5640     }
5641
5642 #ifdef DEBUG
5643     bool optConfigDisableCSE();
5644     bool optConfigDisableCSE2();
5645 #endif
5646     void optOptimizeCSEs();
5647
5648 #endif // FEATURE_ANYCSE
5649
5650     struct isVarAssgDsc
5651     {
5652         GenTreePtr ivaSkip;
5653 #ifdef DEBUG
5654         void* ivaSelf;
5655 #endif
5656         unsigned     ivaVar;            // Variable we are interested in, or -1
5657         ALLVARSET_TP ivaMaskVal;        // Set of variables assigned to.  This is a set of all vars, not tracked vars.
5658         bool         ivaMaskIncomplete; // Variables not representable in ivaMaskVal were assigned to.
5659         varRefKinds  ivaMaskInd;        // What kind of indirect assignments are there?
5660         callInterf   ivaMaskCall;       // What kind of calls are there?
5661     };
5662
5663     static callInterf optCallInterf(GenTreeCall* call);
5664
5665 public:
5666     // VN based copy propagation.
5667     typedef ArrayStack<GenTreePtr> GenTreePtrStack;
5668     typedef SimplerHashTable<unsigned, SmallPrimitiveKeyFuncs<unsigned>, GenTreePtrStack*, JitSimplerHashBehavior>
5669         LclNumToGenTreePtrStack;
5670
5671     // Kill set to track variables with intervening definitions.
5672     VARSET_TP optCopyPropKillSet;
5673
5674     // Copy propagation functions.
5675     void optCopyProp(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree, LclNumToGenTreePtrStack* curSsaName);
5676     void optBlockCopyPropPopStacks(BasicBlock* block, LclNumToGenTreePtrStack* curSsaName);
5677     void optBlockCopyProp(BasicBlock* block, LclNumToGenTreePtrStack* curSsaName);
5678     bool optIsSsaLocal(GenTreePtr tree);
5679     int optCopyProp_LclVarScore(LclVarDsc* lclVarDsc, LclVarDsc* copyVarDsc, bool preferOp2);
5680     void optVnCopyProp();
5681
5682     /**************************************************************************
5683     *               Early value propagation
5684     *************************************************************************/
5685     struct SSAName
5686     {
5687         unsigned m_lvNum;
5688         unsigned m_ssaNum;
5689
5690         SSAName(unsigned lvNum, unsigned ssaNum) : m_lvNum(lvNum), m_ssaNum(ssaNum)
5691         {
5692         }
5693
5694         static unsigned GetHashCode(SSAName ssaNm)
5695         {
5696             return (ssaNm.m_lvNum << 16) | (ssaNm.m_ssaNum);
5697         }
5698
5699         static bool Equals(SSAName ssaNm1, SSAName ssaNm2)
5700         {
5701             return (ssaNm1.m_lvNum == ssaNm2.m_lvNum) && (ssaNm1.m_ssaNum == ssaNm2.m_ssaNum);
5702         }
5703     };
5704
5705 #define OMF_HAS_NEWARRAY 0x00000001   // Method contains 'new' of an array
5706 #define OMF_HAS_NEWOBJ 0x00000002     // Method contains 'new' of an object type.
5707 #define OMF_HAS_ARRAYREF 0x00000004   // Method contains array element loads or stores.
5708 #define OMF_HAS_VTABLEREF 0x00000008  // Method contains method table reference.
5709 #define OMF_HAS_NULLCHECK 0x00000010  // Method contains null check.
5710 #define OMF_HAS_FATPOINTER 0x00000020 // Method contains call, that needs fat pointer transformation.
5711
5712     bool doesMethodHaveFatPointer()
5713     {
5714         return (optMethodFlags & OMF_HAS_FATPOINTER) != 0;
5715     }
5716
5717     void setMethodHasFatPointer()
5718     {
5719         optMethodFlags |= OMF_HAS_FATPOINTER;
5720     }
5721
5722     void clearMethodHasFatPointer()
5723     {
5724         optMethodFlags &= ~OMF_HAS_FATPOINTER;
5725     }
5726
5727     void addFatPointerCandidate(GenTreeCall* call)
5728     {
5729         setMethodHasFatPointer();
5730         call->SetFatPointerCandidate();
5731     }
5732
5733     unsigned optMethodFlags;
5734
5735     // Recursion bound controls how far we can go backwards tracking for a SSA value.
5736     // No throughput diff was found with backward walk bound between 3-8.
5737     static const int optEarlyPropRecurBound = 5;
5738
5739     enum class optPropKind
5740     {
5741         OPK_INVALID,
5742         OPK_ARRAYLEN,
5743         OPK_OBJ_GETTYPE,
5744         OPK_NULLCHECK
5745     };
5746
5747     bool gtIsVtableRef(GenTreePtr tree);
5748     GenTreePtr getArrayLengthFromAllocation(GenTreePtr tree);
5749     GenTreePtr getObjectHandleNodeFromAllocation(GenTreePtr tree);
5750     GenTreePtr optPropGetValueRec(unsigned lclNum, unsigned ssaNum, optPropKind valueKind, int walkDepth);
5751     GenTreePtr optPropGetValue(unsigned lclNum, unsigned ssaNum, optPropKind valueKind);
5752     bool optEarlyPropRewriteTree(GenTreePtr tree);
5753     bool optDoEarlyPropForBlock(BasicBlock* block);
5754     bool optDoEarlyPropForFunc();
5755     void optEarlyProp();
5756     void optFoldNullCheck(GenTreePtr tree);
5757     bool optCanMoveNullCheckPastTree(GenTreePtr tree, bool isInsideTry);
5758
5759 #if ASSERTION_PROP
5760     /**************************************************************************
5761      *               Value/Assertion propagation
5762      *************************************************************************/
5763 public:
5764     // Data structures for assertion prop
5765     BitVecTraits* apTraits;
5766     ASSERT_TP     apFull;
5767
5768     enum optAssertionKind
5769     {
5770         OAK_INVALID,
5771         OAK_EQUAL,
5772         OAK_NOT_EQUAL,
5773         OAK_SUBRANGE,
5774         OAK_NO_THROW,
5775         OAK_COUNT
5776     };
5777
5778     enum optOp1Kind
5779     {
5780         O1K_INVALID,
5781         O1K_LCLVAR,
5782         O1K_ARR_BND,
5783         O1K_BOUND_OPER_BND,
5784         O1K_BOUND_LOOP_BND,
5785         O1K_CONSTANT_LOOP_BND,
5786         O1K_EXACT_TYPE,
5787         O1K_SUBTYPE,
5788         O1K_VALUE_NUMBER,
5789         O1K_COUNT
5790     };
5791
5792     enum optOp2Kind
5793     {
5794         O2K_INVALID,
5795         O2K_LCLVAR_COPY,
5796         O2K_IND_CNS_INT,
5797         O2K_CONST_INT,
5798         O2K_CONST_LONG,
5799         O2K_CONST_DOUBLE,
5800         O2K_ARR_LEN,
5801         O2K_SUBRANGE,
5802         O2K_COUNT
5803     };
5804     struct AssertionDsc
5805     {
5806         optAssertionKind assertionKind;
5807         struct SsaVar
5808         {
5809             unsigned lclNum; // assigned to or property of this local var number
5810             unsigned ssaNum;
5811         };
5812         struct ArrBnd
5813         {
5814             ValueNum vnIdx;
5815             ValueNum vnLen;
5816         };
5817         struct AssertionDscOp1
5818         {
5819             optOp1Kind kind; // a normal LclVar, or Exact-type or Subtype
5820             ValueNum   vn;
5821             union {
5822                 SsaVar lcl;
5823                 ArrBnd bnd;
5824             };
5825         } op1;
5826         struct AssertionDscOp2
5827         {
5828             optOp2Kind kind; // a const or copy assignment
5829             ValueNum   vn;
5830             struct IntVal
5831             {
5832                 ssize_t  iconVal;   // integer
5833                 unsigned iconFlags; // gtFlags
5834             };
5835             struct Range // integer subrange
5836             {
5837                 ssize_t loBound;
5838                 ssize_t hiBound;
5839             };
5840             union {
5841                 SsaVar  lcl;
5842                 IntVal  u1;
5843                 __int64 lconVal;
5844                 double  dconVal;
5845                 Range   u2;
5846             };
5847         } op2;
5848
5849         bool IsCheckedBoundArithBound()
5850         {
5851             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) && op1.kind == O1K_BOUND_OPER_BND);
5852         }
5853         bool IsCheckedBoundBound()
5854         {
5855             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) && op1.kind == O1K_BOUND_LOOP_BND);
5856         }
5857         bool IsConstantBound()
5858         {
5859             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) &&
5860                     op1.kind == O1K_CONSTANT_LOOP_BND);
5861         }
5862         bool IsBoundsCheckNoThrow()
5863         {
5864             return ((assertionKind == OAK_NO_THROW) && (op1.kind == O1K_ARR_BND));
5865         }
5866
5867         bool IsCopyAssertion()
5868         {
5869             return ((assertionKind == OAK_EQUAL) && (op1.kind == O1K_LCLVAR) && (op2.kind == O2K_LCLVAR_COPY));
5870         }
5871
5872         static bool SameKind(AssertionDsc* a1, AssertionDsc* a2)
5873         {
5874             return a1->assertionKind == a2->assertionKind && a1->op1.kind == a2->op1.kind &&
5875                    a1->op2.kind == a2->op2.kind;
5876         }
5877
5878         static bool ComplementaryKind(optAssertionKind kind, optAssertionKind kind2)
5879         {
5880             if (kind == OAK_EQUAL)
5881             {
5882                 return kind2 == OAK_NOT_EQUAL;
5883             }
5884             else if (kind == OAK_NOT_EQUAL)
5885             {
5886                 return kind2 == OAK_EQUAL;
5887             }
5888             return false;
5889         }
5890
5891         static ssize_t GetLowerBoundForIntegralType(var_types type)
5892         {
5893             switch (type)
5894             {
5895                 case TYP_BYTE:
5896                     return SCHAR_MIN;
5897                 case TYP_SHORT:
5898                     return SHRT_MIN;
5899                 case TYP_INT:
5900                     return INT_MIN;
5901                 case TYP_BOOL:
5902                 case TYP_UBYTE:
5903                 case TYP_CHAR:
5904                 case TYP_USHORT:
5905                 case TYP_UINT:
5906                     return 0;
5907                 default:
5908                     unreached();
5909             }
5910         }
5911         static ssize_t GetUpperBoundForIntegralType(var_types type)
5912         {
5913             switch (type)
5914             {
5915                 case TYP_BOOL:
5916                     return 1;
5917                 case TYP_BYTE:
5918                     return SCHAR_MAX;
5919                 case TYP_SHORT:
5920                     return SHRT_MAX;
5921                 case TYP_INT:
5922                     return INT_MAX;
5923                 case TYP_UBYTE:
5924                     return UCHAR_MAX;
5925                 case TYP_CHAR:
5926                 case TYP_USHORT:
5927                     return USHRT_MAX;
5928                 case TYP_UINT:
5929                     return UINT_MAX;
5930                 default:
5931                     unreached();
5932             }
5933         }
5934
5935         bool HasSameOp1(AssertionDsc* that, bool vnBased)
5936         {
5937             if (op1.kind != that->op1.kind)
5938             {
5939                 return false;
5940             }
5941             else if (op1.kind == O1K_ARR_BND)
5942             {
5943                 assert(vnBased);
5944                 return (op1.bnd.vnIdx == that->op1.bnd.vnIdx) && (op1.bnd.vnLen == that->op1.bnd.vnLen);
5945             }
5946             else
5947             {
5948                 return ((vnBased && (op1.vn == that->op1.vn)) ||
5949                         (!vnBased && (op1.lcl.lclNum == that->op1.lcl.lclNum)));
5950             }
5951         }
5952
5953         bool HasSameOp2(AssertionDsc* that, bool vnBased)
5954         {
5955             if (op2.kind != that->op2.kind)
5956             {
5957                 return false;
5958             }
5959             switch (op2.kind)
5960             {
5961                 case O2K_IND_CNS_INT:
5962                 case O2K_CONST_INT:
5963                     return ((op2.u1.iconVal == that->op2.u1.iconVal) && (op2.u1.iconFlags == that->op2.u1.iconFlags));
5964
5965                 case O2K_CONST_LONG:
5966                     return (op2.lconVal == that->op2.lconVal);
5967
5968                 case O2K_CONST_DOUBLE:
5969                     // exact match because of positive and negative zero.
5970                     return (memcmp(&op2.dconVal, &that->op2.dconVal, sizeof(double)) == 0);
5971
5972                 case O2K_LCLVAR_COPY:
5973                 case O2K_ARR_LEN:
5974                     return (op2.lcl.lclNum == that->op2.lcl.lclNum) &&
5975                            (!vnBased || op2.lcl.ssaNum == that->op2.lcl.ssaNum);
5976
5977                 case O2K_SUBRANGE:
5978                     return ((op2.u2.loBound == that->op2.u2.loBound) && (op2.u2.hiBound == that->op2.u2.hiBound));
5979
5980                 case O2K_INVALID:
5981                     // we will return false
5982                     break;
5983
5984                 default:
5985                     assert(!"Unexpected value for op2.kind in AssertionDsc.");
5986                     break;
5987             }
5988             return false;
5989         }
5990
5991         bool Complementary(AssertionDsc* that, bool vnBased)
5992         {
5993             return ComplementaryKind(assertionKind, that->assertionKind) && HasSameOp1(that, vnBased) &&
5994                    HasSameOp2(that, vnBased);
5995         }
5996
5997         bool Equals(AssertionDsc* that, bool vnBased)
5998         {
5999             if (assertionKind != that->assertionKind)
6000             {
6001                 return false;
6002             }
6003             else if (assertionKind == OAK_NO_THROW)
6004             {
6005                 assert(op2.kind == O2K_INVALID);
6006                 return HasSameOp1(that, vnBased);
6007             }
6008             else
6009             {
6010                 return HasSameOp1(that, vnBased) && HasSameOp2(that, vnBased);
6011             }
6012         }
6013     };
6014
6015 protected:
6016     static fgWalkPreFn optAddCopiesCallback;
6017     static fgWalkPreFn optVNAssertionPropCurStmtVisitor;
6018     unsigned           optAddCopyLclNum;
6019     GenTreePtr         optAddCopyAsgnNode;
6020
6021     bool optLocalAssertionProp;  // indicates that we are performing local assertion prop
6022     bool optAssertionPropagated; // set to true if we modified the trees
6023     bool optAssertionPropagatedCurrentStmt;
6024 #ifdef DEBUG
6025     GenTreePtr optAssertionPropCurrentTree;
6026 #endif
6027     AssertionIndex*         optComplementaryAssertionMap;
6028     ExpandArray<ASSERT_TP>* optAssertionDep; // table that holds dependent assertions (assertions
6029                                              // using the value of a local var) for each local var
6030     AssertionDsc*  optAssertionTabPrivate;   // table that holds info about value assignments
6031     AssertionIndex optAssertionCount;        // total number of assertions in the assertion table
6032     AssertionIndex optMaxAssertionCount;
6033
6034 public:
6035     void optVnNonNullPropCurStmt(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
6036     fgWalkResult optVNConstantPropCurStmt(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
6037     GenTreePtr optVNConstantPropOnRelOp(GenTreePtr tree);
6038     GenTreePtr optVNConstantPropOnJTrue(BasicBlock* block, GenTreePtr stmt, GenTreePtr test);
6039     GenTreePtr optVNConstantPropOnTree(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
6040     GenTreePtr optPrepareTreeForReplacement(GenTreePtr extractTree, GenTreePtr replaceTree);
6041
6042     AssertionIndex GetAssertionCount()
6043     {
6044         return optAssertionCount;
6045     }
6046     ASSERT_TP* bbJtrueAssertionOut;
6047     typedef SimplerHashTable<ValueNum, SmallPrimitiveKeyFuncs<ValueNum>, ASSERT_TP, JitSimplerHashBehavior>
6048                           ValueNumToAssertsMap;
6049     ValueNumToAssertsMap* optValueNumToAsserts;
6050
6051     // Assertion prop helpers.
6052     ASSERT_TP& GetAssertionDep(unsigned lclNum);
6053     AssertionDsc* optGetAssertion(AssertionIndex assertIndex);
6054     void optAssertionInit(bool isLocalProp);
6055     void optAssertionTraitsInit(AssertionIndex assertionCount);
6056 #if LOCAL_ASSERTION_PROP
6057     void optAssertionReset(AssertionIndex limit);
6058     void optAssertionRemove(AssertionIndex index);
6059 #endif
6060
6061     // Assertion prop data flow functions.
6062     void       optAssertionPropMain();
6063     GenTreePtr optVNAssertionPropCurStmt(BasicBlock* block, GenTreePtr stmt);
6064     bool optIsTreeKnownIntValue(bool vnBased, GenTreePtr tree, ssize_t* pConstant, unsigned* pIconFlags);
6065     ASSERT_TP* optInitAssertionDataflowFlags();
6066     ASSERT_TP* optComputeAssertionGen();
6067
6068     // Assertion Gen functions.
6069     void optAssertionGen(GenTreePtr tree);
6070     AssertionIndex optAssertionGenPhiDefn(GenTreePtr tree);
6071     AssertionInfo optCreateJTrueBoundsAssertion(GenTreePtr tree);
6072     AssertionInfo optAssertionGenJtrue(GenTreePtr tree);
6073     AssertionIndex optCreateJtrueAssertions(GenTreePtr op1, GenTreePtr op2, Compiler::optAssertionKind assertionKind);
6074     AssertionIndex optFindComplementary(AssertionIndex assertionIndex);
6075     void optMapComplementary(AssertionIndex assertionIndex, AssertionIndex index);
6076
6077     // Assertion creation functions.
6078     AssertionIndex optCreateAssertion(GenTreePtr op1, GenTreePtr op2, optAssertionKind assertionKind);
6079     AssertionIndex optCreateAssertion(GenTreePtr       op1,
6080                                       GenTreePtr       op2,
6081                                       optAssertionKind assertionKind,
6082                                       AssertionDsc*    assertion);
6083     void optCreateComplementaryAssertion(AssertionIndex assertionIndex, GenTreePtr op1, GenTreePtr op2);
6084
6085     bool optAssertionVnInvolvesNan(AssertionDsc* assertion);
6086     AssertionIndex optAddAssertion(AssertionDsc* assertion);
6087     void optAddVnAssertionMapping(ValueNum vn, AssertionIndex index);
6088 #ifdef DEBUG
6089     void optPrintVnAssertionMapping();
6090 #endif
6091     ASSERT_TP optGetVnMappedAssertions(ValueNum vn);
6092
6093     // Used for respective assertion propagations.
6094     AssertionIndex optAssertionIsSubrange(GenTreePtr tree, var_types toType, ASSERT_VALARG_TP assertions);
6095     AssertionIndex optAssertionIsSubtype(GenTreePtr tree, GenTreePtr methodTableArg, ASSERT_VALARG_TP assertions);
6096     AssertionIndex optAssertionIsNonNullInternal(GenTreePtr op, ASSERT_VALARG_TP assertions);
6097     bool optAssertionIsNonNull(GenTreePtr       op,
6098                                ASSERT_VALARG_TP assertions DEBUGARG(bool* pVnBased) DEBUGARG(AssertionIndex* pIndex));
6099
6100     // Used for Relop propagation.
6101     AssertionIndex optGlobalAssertionIsEqualOrNotEqual(ASSERT_VALARG_TP assertions, GenTreePtr op1, GenTreePtr op2);
6102     AssertionIndex optLocalAssertionIsEqualOrNotEqual(
6103         optOp1Kind op1Kind, unsigned lclNum, optOp2Kind op2Kind, ssize_t cnsVal, ASSERT_VALARG_TP assertions);
6104
6105     // Assertion prop for lcl var functions.
6106     bool optAssertionProp_LclVarTypeCheck(GenTreePtr tree, LclVarDsc* lclVarDsc, LclVarDsc* copyVarDsc);
6107     GenTreePtr optCopyAssertionProp(AssertionDsc* curAssertion,
6108                                     GenTreePtr    tree,
6109                                     GenTreePtr stmt DEBUGARG(AssertionIndex index));
6110     GenTreePtr optConstantAssertionProp(AssertionDsc*    curAssertion,
6111                                         const GenTreePtr tree,
6112                                         const GenTreePtr stmt DEBUGARG(AssertionIndex index));
6113     GenTreePtr optVnConstantAssertionProp(const GenTreePtr tree, const GenTreePtr stmt);
6114
6115     // Assertion propagation functions.
6116     GenTreePtr optAssertionProp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6117     GenTreePtr optAssertionProp_LclVar(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6118     GenTreePtr optAssertionProp_Ind(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6119     GenTreePtr optAssertionProp_Cast(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6120     GenTreePtr optAssertionProp_Call(ASSERT_VALARG_TP assertions, GenTreeCall* call, const GenTreePtr stmt);
6121     GenTreePtr optAssertionProp_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6122     GenTreePtr optAssertionProp_Comma(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6123     GenTreePtr optAssertionProp_BndsChk(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6124     GenTreePtr optAssertionPropGlobal_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6125     GenTreePtr optAssertionPropLocal_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
6126     GenTreePtr optAssertionProp_Update(const GenTreePtr newTree, const GenTreePtr tree, const GenTreePtr stmt);
6127     GenTreePtr optNonNullAssertionProp_Call(ASSERT_VALARG_TP assertions, GenTreeCall* call, const GenTreePtr stmt);
6128
6129     // Implied assertion functions.
6130     void optImpliedAssertions(AssertionIndex assertionIndex, ASSERT_TP& activeAssertions);
6131     void optImpliedByTypeOfAssertions(ASSERT_TP& activeAssertions);
6132     void optImpliedByCopyAssertion(AssertionDsc* copyAssertion, AssertionDsc* depAssertion, ASSERT_TP& result);
6133     void optImpliedByConstAssertion(AssertionDsc* curAssertion, ASSERT_TP& result);
6134
6135 #ifdef DEBUG
6136     void optPrintAssertion(AssertionDsc* newAssertion, AssertionIndex assertionIndex = 0);
6137     void optDebugCheckAssertion(AssertionDsc* assertion);
6138     void optDebugCheckAssertions(AssertionIndex AssertionIndex);
6139 #endif
6140     void optAddCopies();
6141 #endif // ASSERTION_PROP
6142
6143     /**************************************************************************
6144      *                          Range checks
6145      *************************************************************************/
6146
6147 public:
6148     struct LoopCloneVisitorInfo
6149     {
6150         LoopCloneContext* context;
6151         unsigned          loopNum;
6152         GenTreePtr        stmt;
6153         LoopCloneVisitorInfo(LoopCloneContext* context, unsigned loopNum, GenTreePtr stmt)
6154             : context(context), loopNum(loopNum), stmt(nullptr)
6155         {
6156         }
6157     };
6158
6159     bool optIsStackLocalInvariant(unsigned loopNum, unsigned lclNum);
6160     bool optExtractArrIndex(GenTreePtr tree, ArrIndex* result, unsigned lhsNum);
6161     bool optReconstructArrIndex(GenTreePtr tree, ArrIndex* result, unsigned lhsNum);
6162     bool optIdentifyLoopOptInfo(unsigned loopNum, LoopCloneContext* context);
6163     static fgWalkPreFn optCanOptimizeByLoopCloningVisitor;
6164     fgWalkResult optCanOptimizeByLoopCloning(GenTreePtr tree, LoopCloneVisitorInfo* info);
6165     void optObtainLoopCloningOpts(LoopCloneContext* context);
6166     bool optIsLoopClonable(unsigned loopInd);
6167
6168     bool optCanCloneLoops();
6169
6170 #ifdef DEBUG
6171     void optDebugLogLoopCloning(BasicBlock* block, GenTreePtr insertBefore);
6172 #endif
6173     void optPerformStaticOptimizations(unsigned loopNum, LoopCloneContext* context DEBUGARG(bool fastPath));
6174     bool optComputeDerefConditions(unsigned loopNum, LoopCloneContext* context);
6175     bool optDeriveLoopCloningConditions(unsigned loopNum, LoopCloneContext* context);
6176     BasicBlock* optInsertLoopChoiceConditions(LoopCloneContext* context,
6177                                               unsigned          loopNum,
6178                                               BasicBlock*       head,
6179                                               BasicBlock*       slow);
6180     void optInsertLoopCloningStress(BasicBlock* head);
6181
6182 #if COUNT_RANGECHECKS
6183     static unsigned optRangeChkRmv;
6184     static unsigned optRangeChkAll;
6185 #endif
6186
6187 protected:
6188     struct arraySizes
6189     {
6190         unsigned arrayVar;
6191         int      arrayDim;
6192
6193 #define MAX_ARRAYS 4 // a magic max number of arrays tracked for bounds check elimination
6194     };
6195
6196     struct RngChkDsc
6197     {
6198         RngChkDsc* rcdNextInBucket; // used by the hash table
6199
6200         unsigned short rcdHashValue; // to make matching faster
6201         unsigned short rcdIndex;     // 0..optRngChkCount-1
6202
6203         GenTreePtr rcdTree; // the array index tree
6204     };
6205
6206     unsigned            optRngChkCount;
6207     static const size_t optRngChkHashSize;
6208
6209     ssize_t optGetArrayRefScaleAndIndex(GenTreePtr mul, GenTreePtr* pIndex DEBUGARG(bool bRngChk));
6210     GenTreePtr optFindLocalInit(BasicBlock* block, GenTreePtr local, VARSET_TP* pKilledInOut, bool* isKilledAfterInit);
6211
6212     bool optReachWithoutCall(BasicBlock* srcBB, BasicBlock* dstBB);
6213
6214 protected:
6215     bool optLoopsMarked;
6216
6217     /*
6218     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6219     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6220     XX                                                                           XX
6221     XX                           RegAlloc                                        XX
6222     XX                                                                           XX
6223     XX  Does the register allocation and puts the remaining lclVars on the stack XX
6224     XX                                                                           XX
6225     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6226     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6227     */
6228
6229 public:
6230 #ifndef LEGACY_BACKEND
6231     bool doLSRA() const
6232     {
6233         return true;
6234     }
6235 #else  // LEGACY_BACKEND
6236     bool doLSRA() const
6237     {
6238         return false;
6239     }
6240 #endif // LEGACY_BACKEND
6241
6242 #ifdef LEGACY_BACKEND
6243     void raInit();
6244     void raAssignVars(); // register allocation
6245 #endif                   // LEGACY_BACKEND
6246
6247     VARSET_TP raRegVarsMask; // Set of all enregistered variables (not including FEATURE_STACK_FP_X87 enregistered
6248                              // variables)
6249     regNumber raUpdateRegStateForArg(RegState* regState, LclVarDsc* argDsc);
6250
6251     void raMarkStkVars();
6252
6253 protected:
6254     // Some things are used by both LSRA and regpredict allocators.
6255
6256     FrameType rpFrameType;
6257     bool      rpMustCreateEBPCalled; // Set to true after we have called rpMustCreateEBPFrame once
6258
6259 #ifdef LEGACY_BACKEND
6260     regMaskTP rpMaskPInvokeEpilogIntf; // pinvoke epilog trashes esi/edi holding stack args needed to setup tail call's
6261                                        // args
6262 #endif                                 // LEGACY_BACKEND
6263
6264     bool rpMustCreateEBPFrame(INDEBUG(const char** wbReason));
6265
6266 #if FEATURE_FP_REGALLOC
6267     enum enumConfigRegisterFP
6268     {
6269         CONFIG_REGISTER_FP_NONE         = 0x0,
6270         CONFIG_REGISTER_FP_CALLEE_TRASH = 0x1,
6271         CONFIG_REGISTER_FP_CALLEE_SAVED = 0x2,
6272         CONFIG_REGISTER_FP_FULL         = 0x3,
6273     };
6274     enumConfigRegisterFP raConfigRegisterFP();
6275 #endif // FEATURE_FP_REGALLOC
6276
6277 public:
6278     regMaskTP raConfigRestrictMaskFP();
6279
6280 private:
6281 #ifndef LEGACY_BACKEND
6282     Lowering*            m_pLowering;   // Lowering; needed to Lower IR that's added or modified after Lowering.
6283     LinearScanInterface* m_pLinearScan; // Linear Scan allocator
6284 #else                                   // LEGACY_BACKEND
6285     unsigned  raAvoidArgRegMask;       // Mask of incoming argument registers that we may need to avoid
6286     VARSET_TP raLclRegIntf[REG_COUNT]; // variable to register interference graph
6287     bool      raNewBlocks;             // True is we added killing blocks for FPU registers
6288     unsigned  rpPasses;                // Number of passes made by the register predicter
6289     unsigned  rpPassesMax;             // Maximum number of passes made by the register predicter
6290     unsigned  rpPassesPessimize;       // Number of passes non-pessimizing made by the register predicter
6291     unsigned rpStkPredict; // Weighted count of variables were predicted STK (lower means register allocation is better)
6292     unsigned rpPredictSpillCnt;     // Predicted number of integer spill tmps for the current tree
6293     regMaskTP rpPredictAssignMask;  // Mask of registers to consider in rpPredictAssignRegVars()
6294     VARSET_TP rpLastUseVars;        // Set of last use variables in rpPredictTreeRegUse
6295     VARSET_TP rpUseInPlace;         // Set of variables that we used in place
6296     int       rpAsgVarNum;          // VarNum for the target of GT_ASG node
6297     bool      rpPredictAssignAgain; // Must rerun the rpPredictAssignRegVars()
6298     bool      rpAddedVarIntf;       // Set to true if we need to add a new var intf
6299     bool      rpLostEnreg;          // Set to true if we lost an enregister var that had lvDependReg set
6300     bool      rpReverseEBPenreg;    // Decided to reverse the enregistration of EBP
6301 public:
6302     bool rpRegAllocDone; // Set to true after we have completed register allocation
6303 private:
6304     regMaskTP rpPredictMap[PREDICT_COUNT]; // Holds the regMaskTP for each of the enum values
6305
6306     void raSetupArgMasks(RegState* r);
6307
6308     const regNumber* raGetRegVarOrder(var_types regType, unsigned* wbVarOrderSize);
6309 #ifdef DEBUG
6310     void raDumpVarIntf(); // Dump the variable to variable interference graph
6311     void raDumpRegIntf(); // Dump the variable to register interference graph
6312 #endif
6313     void raAdjustVarIntf();
6314
6315     regMaskTP rpPredictRegMask(rpPredictReg predictReg, var_types type);
6316
6317     bool rpRecordRegIntf(regMaskTP regMask, VARSET_VALARG_TP life DEBUGARG(const char* msg));
6318
6319     bool rpRecordVarIntf(unsigned varNum, VARSET_VALARG_TP intfVar DEBUGARG(const char* msg));
6320     regMaskTP rpPredictRegPick(var_types type, rpPredictReg predictReg, regMaskTP lockedRegs);
6321
6322     regMaskTP rpPredictGrabReg(var_types type, rpPredictReg predictReg, regMaskTP lockedRegs);
6323
6324     static fgWalkPreFn rpMarkRegIntf;
6325
6326     regMaskTP rpPredictAddressMode(
6327         GenTreePtr tree, var_types type, regMaskTP lockedRegs, regMaskTP rsvdRegs, GenTreePtr lenCSE);
6328
6329     void rpPredictRefAssign(unsigned lclNum);
6330
6331     regMaskTP rpPredictBlkAsgRegUse(GenTreePtr tree, rpPredictReg predictReg, regMaskTP lockedRegs, regMaskTP rsvdRegs);
6332
6333     regMaskTP rpPredictTreeRegUse(GenTreePtr tree, rpPredictReg predictReg, regMaskTP lockedRegs, regMaskTP rsvdRegs);
6334
6335     regMaskTP rpPredictAssignRegVars(regMaskTP regAvail);
6336
6337     void rpPredictRegUse(); // Entry point
6338
6339     unsigned raPredictTreeRegUse(GenTreePtr tree);
6340     unsigned raPredictListRegUse(GenTreePtr list);
6341
6342     void raSetRegVarOrder(var_types  regType,
6343                           regNumber* customVarOrder,
6344                           unsigned*  customVarOrderSize,
6345                           regMaskTP  prefReg,
6346                           regMaskTP  avoidReg);
6347
6348     // We use (unsigned)-1 as an uninitialized sentinel for rpStkPredict and
6349     // also as the maximum value of lvRefCntWtd. Don't allow overflow, and
6350     // saturate at UINT_MAX - 1, to avoid using the sentinel.
6351     void raAddToStkPredict(unsigned val)
6352     {
6353         unsigned newStkPredict = rpStkPredict + val;
6354         if ((newStkPredict < rpStkPredict) || (newStkPredict == UINT_MAX))
6355             rpStkPredict = UINT_MAX - 1;
6356         else
6357             rpStkPredict = newStkPredict;
6358     }
6359
6360 #ifdef DEBUG
6361 #if !FEATURE_FP_REGALLOC
6362     void raDispFPlifeInfo();
6363 #endif
6364 #endif
6365
6366     regMaskTP genReturnRegForTree(GenTreePtr tree);
6367 #endif // LEGACY_BACKEND
6368
6369     /* raIsVarargsStackArg is called by raMaskStkVars and by
6370        lvaSortByRefCount.  It identifies the special case
6371        where a varargs function has a parameter passed on the
6372        stack, other than the special varargs handle.  Such parameters
6373        require special treatment, because they cannot be tracked
6374        by the GC (their offsets in the stack are not known
6375        at compile time).
6376     */
6377
6378     bool raIsVarargsStackArg(unsigned lclNum)
6379     {
6380 #ifdef _TARGET_X86_
6381
6382         LclVarDsc* varDsc = &lvaTable[lclNum];
6383
6384         assert(varDsc->lvIsParam);
6385
6386         return (info.compIsVarArgs && !varDsc->lvIsRegArg && (lclNum != lvaVarargsHandleArg));
6387
6388 #else // _TARGET_X86_
6389
6390         return false;
6391
6392 #endif // _TARGET_X86_
6393     }
6394
6395 #ifdef LEGACY_BACKEND
6396     // Records the current prediction, if it's better than any previous recorded prediction.
6397     void rpRecordPrediction();
6398     // Applies the best recorded prediction, if one exists and is better than the current prediction.
6399     void rpUseRecordedPredictionIfBetter();
6400
6401     // Data members used in the methods above.
6402     unsigned rpBestRecordedStkPredict;
6403     struct VarRegPrediction
6404     {
6405         bool           m_isEnregistered;
6406         regNumberSmall m_regNum;
6407         regNumberSmall m_otherReg;
6408     };
6409     VarRegPrediction* rpBestRecordedPrediction;
6410 #endif // LEGACY_BACKEND
6411
6412     /*
6413     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6414     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6415     XX                                                                           XX
6416     XX                           EEInterface                                     XX
6417     XX                                                                           XX
6418     XX   Get to the class and method info from the Execution Engine given        XX
6419     XX   tokens for the class and method                                         XX
6420     XX                                                                           XX
6421     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6422     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6423     */
6424
6425 public:
6426     /* These are the different addressing modes used to access a local var.
6427      * The JIT has to report the location of the locals back to the EE
6428      * for debugging purposes.
6429      */
6430
6431     enum siVarLocType
6432     {
6433         VLT_REG,
6434         VLT_REG_BYREF, // this type is currently only used for value types on X64
6435         VLT_REG_FP,
6436         VLT_STK,
6437         VLT_STK_BYREF, // this type is currently only used for value types on X64
6438         VLT_REG_REG,
6439         VLT_REG_STK,
6440         VLT_STK_REG,
6441         VLT_STK2,
6442         VLT_FPSTK,
6443         VLT_FIXED_VA,
6444
6445         VLT_COUNT,
6446         VLT_INVALID
6447     };
6448
6449     struct siVarLoc
6450     {
6451         siVarLocType vlType;
6452
6453         union {
6454             // VLT_REG/VLT_REG_FP -- Any pointer-sized enregistered value (TYP_INT, TYP_REF, etc)
6455             // eg. EAX
6456             // VLT_REG_BYREF -- the specified register contains the address of the variable
6457             // eg. [EAX]
6458
6459             struct
6460             {
6461                 regNumber vlrReg;
6462             } vlReg;
6463
6464             // VLT_STK       -- Any 32 bit value which is on the stack
6465             // eg. [ESP+0x20], or [EBP-0x28]
6466             // VLT_STK_BYREF -- the specified stack location contains the address of the variable
6467             // eg. mov EAX, [ESP+0x20]; [EAX]
6468
6469             struct
6470             {
6471                 regNumber     vlsBaseReg;
6472                 NATIVE_OFFSET vlsOffset;
6473             } vlStk;
6474
6475             // VLT_REG_REG -- TYP_LONG/TYP_DOUBLE with both DWords enregistered
6476             // eg. RBM_EAXEDX
6477
6478             struct
6479             {
6480                 regNumber vlrrReg1;
6481                 regNumber vlrrReg2;
6482             } vlRegReg;
6483
6484             // VLT_REG_STK -- Partly enregistered TYP_LONG/TYP_DOUBLE
6485             // eg { LowerDWord=EAX UpperDWord=[ESP+0x8] }
6486
6487             struct
6488             {
6489                 regNumber vlrsReg;
6490
6491                 struct
6492                 {
6493                     regNumber     vlrssBaseReg;
6494                     NATIVE_OFFSET vlrssOffset;
6495                 } vlrsStk;
6496             } vlRegStk;
6497
6498             // VLT_STK_REG -- Partly enregistered TYP_LONG/TYP_DOUBLE
6499             // eg { LowerDWord=[ESP+0x8] UpperDWord=EAX }
6500
6501             struct
6502             {
6503                 struct
6504                 {
6505                     regNumber     vlsrsBaseReg;
6506                     NATIVE_OFFSET vlsrsOffset;
6507                 } vlsrStk;
6508
6509                 regNumber vlsrReg;
6510             } vlStkReg;
6511
6512             // VLT_STK2 -- Any 64 bit value which is on the stack, in 2 successsive DWords
6513             // eg 2 DWords at [ESP+0x10]
6514
6515             struct
6516             {
6517                 regNumber     vls2BaseReg;
6518                 NATIVE_OFFSET vls2Offset;
6519             } vlStk2;
6520
6521             // VLT_FPSTK -- enregisterd TYP_DOUBLE (on the FP stack)
6522             // eg. ST(3). Actually it is ST("FPstkHeight - vpFpStk")
6523
6524             struct
6525             {
6526                 unsigned vlfReg;
6527             } vlFPstk;
6528
6529             // VLT_FIXED_VA -- fixed argument of a varargs function.
6530             // The argument location depends on the size of the variable
6531             // arguments (...). Inspecting the VARARGS_HANDLE indicates the
6532             // location of the first arg. This argument can then be accessed
6533             // relative to the position of the first arg
6534
6535             struct
6536             {
6537                 unsigned vlfvOffset;
6538             } vlFixedVarArg;
6539
6540             // VLT_MEMORY
6541
6542             struct
6543             {
6544                 void* rpValue; // pointer to the in-process
6545                                // location of the value.
6546             } vlMemory;
6547         };
6548
6549         // Helper functions
6550
6551         bool vlIsInReg(regNumber reg);
6552         bool vlIsOnStk(regNumber reg, signed offset);
6553     };
6554
6555     /*************************************************************************/
6556
6557 public:
6558     // Get handles
6559
6560     void eeGetCallInfo(CORINFO_RESOLVED_TOKEN* pResolvedToken,
6561                        CORINFO_RESOLVED_TOKEN* pConstrainedToken,
6562                        CORINFO_CALLINFO_FLAGS  flags,
6563                        CORINFO_CALL_INFO*      pResult);
6564     inline CORINFO_CALLINFO_FLAGS addVerifyFlag(CORINFO_CALLINFO_FLAGS flags);
6565
6566     void eeGetFieldInfo(CORINFO_RESOLVED_TOKEN* pResolvedToken,
6567                         CORINFO_ACCESS_FLAGS    flags,
6568                         CORINFO_FIELD_INFO*     pResult);
6569
6570     // Get the flags
6571
6572     BOOL eeIsValueClass(CORINFO_CLASS_HANDLE clsHnd);
6573
6574 #if defined(DEBUG) || defined(FEATURE_JIT_METHOD_PERF) || defined(FEATURE_SIMD) || defined(TRACK_LSRA_STATS)
6575
6576     bool IsSuperPMIException(unsigned code)
6577     {
6578         // Copied from NDP\clr\src\ToolBox\SuperPMI\SuperPMI-Shared\ErrorHandling.h
6579
6580         const unsigned EXCEPTIONCODE_DebugBreakorAV = 0xe0421000;
6581         const unsigned EXCEPTIONCODE_MC             = 0xe0422000;
6582         const unsigned EXCEPTIONCODE_LWM            = 0xe0423000;
6583         const unsigned EXCEPTIONCODE_SASM           = 0xe0424000;
6584         const unsigned EXCEPTIONCODE_SSYM           = 0xe0425000;
6585         const unsigned EXCEPTIONCODE_CALLUTILS      = 0xe0426000;
6586         const unsigned EXCEPTIONCODE_TYPEUTILS      = 0xe0427000;
6587         const unsigned EXCEPTIONCODE_ASSERT         = 0xe0440000;
6588
6589         switch (code)
6590         {
6591             case EXCEPTIONCODE_DebugBreakorAV:
6592             case EXCEPTIONCODE_MC:
6593             case EXCEPTIONCODE_LWM:
6594             case EXCEPTIONCODE_SASM:
6595             case EXCEPTIONCODE_SSYM:
6596             case EXCEPTIONCODE_CALLUTILS:
6597             case EXCEPTIONCODE_TYPEUTILS:
6598             case EXCEPTIONCODE_ASSERT:
6599                 return true;
6600             default:
6601                 return false;
6602         }
6603     }
6604
6605     const char* eeGetMethodName(CORINFO_METHOD_HANDLE hnd, const char** className);
6606     const char* eeGetMethodFullName(CORINFO_METHOD_HANDLE hnd);
6607
6608     bool eeIsNativeMethod(CORINFO_METHOD_HANDLE method);
6609     CORINFO_METHOD_HANDLE eeGetMethodHandleForNative(CORINFO_METHOD_HANDLE method);
6610 #endif
6611
6612     var_types eeGetArgType(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig);
6613     var_types eeGetArgType(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig, bool* isPinned);
6614     unsigned eeGetArgSize(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig);
6615
6616     // VOM info, method sigs
6617
6618     void eeGetSig(unsigned               sigTok,
6619                   CORINFO_MODULE_HANDLE  scope,
6620                   CORINFO_CONTEXT_HANDLE context,
6621                   CORINFO_SIG_INFO*      retSig);
6622
6623     void eeGetCallSiteSig(unsigned               sigTok,
6624                           CORINFO_MODULE_HANDLE  scope,
6625                           CORINFO_CONTEXT_HANDLE context,
6626                           CORINFO_SIG_INFO*      retSig);
6627
6628     void eeGetMethodSig(CORINFO_METHOD_HANDLE methHnd, CORINFO_SIG_INFO* retSig, CORINFO_CLASS_HANDLE owner = nullptr);
6629
6630     // Method entry-points, instrs
6631
6632     void* eeGetFieldAddress(CORINFO_FIELD_HANDLE handle, void*** ppIndir);
6633
6634     CORINFO_METHOD_HANDLE eeMarkNativeTarget(CORINFO_METHOD_HANDLE method);
6635
6636     CORINFO_EE_INFO eeInfo;
6637     bool            eeInfoInitialized;
6638
6639     CORINFO_EE_INFO* eeGetEEInfo();
6640
6641     // Gets the offset of a SDArray's first element
6642     unsigned eeGetArrayDataOffset(var_types type);
6643     // Gets the offset of a MDArray's first element
6644     unsigned eeGetMDArrayDataOffset(var_types type, unsigned rank);
6645
6646     GenTreePtr eeGetPInvokeCookie(CORINFO_SIG_INFO* szMetaSig);
6647
6648     // Returns the page size for the target machine as reported by the EE.
6649     inline size_t eeGetPageSize()
6650     {
6651         return eeGetEEInfo()->osPageSize;
6652     }
6653
6654     // Returns the frame size at which we will generate a loop to probe the stack.
6655     inline size_t getVeryLargeFrameSize()
6656     {
6657 #ifdef _TARGET_ARM_
6658         // The looping probe code is 40 bytes, whereas the straight-line probing for
6659         // the (0x2000..0x3000) case is 44, so use looping for anything 0x2000 bytes
6660         // or greater, to generate smaller code.
6661         return 2 * eeGetPageSize();
6662 #else
6663         return 3 * eeGetPageSize();
6664 #endif
6665     }
6666
6667     //------------------------------------------------------------------------
6668     // VirtualStubParam: virtual stub dispatch extra parameter (slot address).
6669     //
6670     // It represents Abi and target specific registers for the parameter.
6671     //
6672     class VirtualStubParamInfo
6673     {
6674     public:
6675         VirtualStubParamInfo(bool isCoreRTABI)
6676         {
6677 #if defined(_TARGET_X86_)
6678             reg     = REG_EAX;
6679             regMask = RBM_EAX;
6680 #elif defined(_TARGET_AMD64_)
6681             if (isCoreRTABI)
6682             {
6683                 reg     = REG_R10;
6684                 regMask = RBM_R10;
6685             }
6686             else
6687             {
6688                 reg     = REG_R11;
6689                 regMask = RBM_R11;
6690             }
6691 #elif defined(_TARGET_ARM_)
6692             if (isCoreRTABI)
6693             {
6694                 reg     = REG_R12;
6695                 regMask = RBM_R12;
6696             }
6697             else
6698             {
6699                 reg     = REG_R4;
6700                 regMask = RBM_R4;
6701             }
6702 #elif defined(_TARGET_ARM64_)
6703             reg     = REG_R11;
6704             regMask = RBM_R11;
6705 #else
6706 #error Unsupported or unset target architecture
6707 #endif
6708
6709 #ifdef LEGACY_BACKEND
6710 #if defined(_TARGET_X86_)
6711             predict = PREDICT_REG_EAX;
6712 #elif defined(_TARGET_ARM_)
6713             predict = PREDICT_REG_R4;
6714 #else
6715 #error Unsupported or unset target architecture
6716 #endif
6717 #endif // LEGACY_BACKEND
6718         }
6719
6720         regNumber GetReg() const
6721         {
6722             return reg;
6723         }
6724
6725         _regMask_enum GetRegMask() const
6726         {
6727             return regMask;
6728         }
6729
6730 #ifdef LEGACY_BACKEND
6731         rpPredictReg GetPredict() const
6732         {
6733             return predict;
6734         }
6735 #endif
6736
6737     private:
6738         regNumber     reg;
6739         _regMask_enum regMask;
6740
6741 #ifdef LEGACY_BACKEND
6742         rpPredictReg predict;
6743 #endif
6744     };
6745
6746     VirtualStubParamInfo* virtualStubParamInfo;
6747
6748     inline bool IsTargetAbi(CORINFO_RUNTIME_ABI abi)
6749     {
6750         return eeGetEEInfo()->targetAbi == abi;
6751     }
6752
6753     inline bool generateCFIUnwindCodes()
6754     {
6755 #ifdef UNIX_AMD64_ABI
6756         return IsTargetAbi(CORINFO_CORERT_ABI);
6757 #else
6758         return false;
6759 #endif
6760     }
6761
6762     // Exceptions
6763
6764     unsigned eeGetEHcount(CORINFO_METHOD_HANDLE handle);
6765
6766     // Debugging support - Line number info
6767
6768     void eeGetStmtOffsets();
6769
6770     unsigned eeBoundariesCount;
6771
6772     struct boundariesDsc
6773     {
6774         UNATIVE_OFFSET nativeIP;
6775         IL_OFFSET      ilOffset;
6776         unsigned       sourceReason;
6777     } * eeBoundaries; // Boundaries to report to EE
6778     void eeSetLIcount(unsigned count);
6779     void eeSetLIinfo(unsigned which, UNATIVE_OFFSET offs, unsigned srcIP, bool stkEmpty, bool callInstruction);
6780     void eeSetLIdone();
6781
6782 #ifdef DEBUG
6783     static void eeDispILOffs(IL_OFFSET offs);
6784     static void eeDispLineInfo(const boundariesDsc* line);
6785     void eeDispLineInfos();
6786 #endif // DEBUG
6787
6788     // Debugging support - Local var info
6789
6790     void eeGetVars();
6791
6792     unsigned eeVarsCount;
6793
6794     struct VarResultInfo
6795     {
6796         UNATIVE_OFFSET startOffset;
6797         UNATIVE_OFFSET endOffset;
6798         DWORD          varNumber;
6799         siVarLoc       loc;
6800     } * eeVars;
6801     void eeSetLVcount(unsigned count);
6802     void eeSetLVinfo(unsigned        which,
6803                      UNATIVE_OFFSET  startOffs,
6804                      UNATIVE_OFFSET  length,
6805                      unsigned        varNum,
6806                      unsigned        LVnum,
6807                      VarName         namex,
6808                      bool            avail,
6809                      const siVarLoc& loc);
6810     void eeSetLVdone();
6811
6812 #ifdef DEBUG
6813     void eeDispVar(ICorDebugInfo::NativeVarInfo* var);
6814     void eeDispVars(CORINFO_METHOD_HANDLE ftn, ULONG32 cVars, ICorDebugInfo::NativeVarInfo* vars);
6815 #endif // DEBUG
6816
6817     // ICorJitInfo wrappers
6818
6819     void eeReserveUnwindInfo(BOOL isFunclet, BOOL isColdCode, ULONG unwindSize);
6820
6821     void eeAllocUnwindInfo(BYTE*          pHotCode,
6822                            BYTE*          pColdCode,
6823                            ULONG          startOffset,
6824                            ULONG          endOffset,
6825                            ULONG          unwindSize,
6826                            BYTE*          pUnwindBlock,
6827                            CorJitFuncKind funcKind);
6828
6829     void eeSetEHcount(unsigned cEH);
6830
6831     void eeSetEHinfo(unsigned EHnumber, const CORINFO_EH_CLAUSE* clause);
6832
6833     WORD eeGetRelocTypeHint(void* target);
6834
6835     // ICorStaticInfo wrapper functions
6836
6837     bool eeTryResolveToken(CORINFO_RESOLVED_TOKEN* resolvedToken);
6838
6839 #if defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
6840 #ifdef DEBUG
6841     static void dumpSystemVClassificationType(SystemVClassificationType ct);
6842 #endif // DEBUG
6843
6844     void eeGetSystemVAmd64PassStructInRegisterDescriptor(
6845         /*IN*/ CORINFO_CLASS_HANDLE                                  structHnd,
6846         /*OUT*/ SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* structPassInRegDescPtr);
6847 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
6848
6849     template <typename ParamType>
6850     bool eeRunWithErrorTrap(void (*function)(ParamType*), ParamType* param)
6851     {
6852         return eeRunWithErrorTrapImp(reinterpret_cast<void (*)(void*)>(function), reinterpret_cast<void*>(param));
6853     }
6854
6855     bool eeRunWithErrorTrapImp(void (*function)(void*), void* param);
6856
6857     // Utility functions
6858
6859     const char* eeGetFieldName(CORINFO_FIELD_HANDLE fieldHnd, const char** classNamePtr = nullptr);
6860
6861 #if defined(DEBUG)
6862     const wchar_t* eeGetCPString(size_t stringHandle);
6863 #endif
6864
6865     const char* eeGetClassName(CORINFO_CLASS_HANDLE clsHnd);
6866
6867     static CORINFO_METHOD_HANDLE eeFindHelper(unsigned helper);
6868     static CorInfoHelpFunc eeGetHelperNum(CORINFO_METHOD_HANDLE method);
6869
6870     static fgWalkPreFn CountSharedStaticHelper;
6871     static bool IsSharedStaticHelper(GenTreePtr tree);
6872     static bool IsTreeAlwaysHoistable(GenTreePtr tree);
6873     static bool IsGcSafePoint(GenTreePtr tree);
6874
6875     static CORINFO_FIELD_HANDLE eeFindJitDataOffs(unsigned jitDataOffs);
6876     // returns true/false if 'field' is a Jit Data offset
6877     static bool eeIsJitDataOffs(CORINFO_FIELD_HANDLE field);
6878     // returns a number < 0 if 'field' is not a Jit Data offset, otherwise the data offset (limited to 2GB)
6879     static int eeGetJitDataOffs(CORINFO_FIELD_HANDLE field);
6880
6881     /*****************************************************************************/
6882
6883 public:
6884     void tmpInit();
6885
6886     enum TEMP_USAGE_TYPE
6887     {
6888         TEMP_USAGE_FREE,
6889         TEMP_USAGE_USED
6890     };
6891
6892     static var_types tmpNormalizeType(var_types type);
6893     TempDsc* tmpGetTemp(var_types type); // get temp for the given type
6894     void tmpRlsTemp(TempDsc* temp);
6895     TempDsc* tmpFindNum(int temp, TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6896
6897     void     tmpEnd();
6898     TempDsc* tmpListBeg(TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6899     TempDsc* tmpListNxt(TempDsc* curTemp, TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6900     void tmpDone();
6901
6902 #ifdef DEBUG
6903     bool tmpAllFree() const;
6904 #endif // DEBUG
6905
6906 #ifndef LEGACY_BACKEND
6907     void tmpPreAllocateTemps(var_types type, unsigned count);
6908 #endif // !LEGACY_BACKEND
6909
6910 protected:
6911 #ifdef LEGACY_BACKEND
6912     unsigned tmpIntSpillMax;    // number of int-sized spill temps
6913     unsigned tmpDoubleSpillMax; // number of double-sized spill temps
6914 #endif                          // LEGACY_BACKEND
6915
6916     unsigned tmpCount; // Number of temps
6917     unsigned tmpSize;  // Size of all the temps
6918 #ifdef DEBUG
6919 public:
6920     // Used by RegSet::rsSpillChk()
6921     unsigned tmpGetCount; // Temps which haven't been released yet
6922 #endif
6923 private:
6924     static unsigned tmpSlot(unsigned size); // which slot in tmpFree[] or tmpUsed[] to use
6925
6926     TempDsc* tmpFree[TEMP_MAX_SIZE / sizeof(int)];
6927     TempDsc* tmpUsed[TEMP_MAX_SIZE / sizeof(int)];
6928
6929     /*
6930     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6931     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6932     XX                                                                           XX
6933     XX                           CodeGenerator                                   XX
6934     XX                                                                           XX
6935     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6936     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6937     */
6938
6939 public:
6940     CodeGenInterface* codeGen;
6941
6942     //  The following holds information about instr offsets in terms of generated code.
6943
6944     struct IPmappingDsc
6945     {
6946         IPmappingDsc* ipmdNext;      // next line# record
6947         IL_OFFSETX    ipmdILoffsx;   // the instr offset
6948         emitLocation  ipmdNativeLoc; // the emitter location of the native code corresponding to the IL offset
6949         bool          ipmdIsLabel;   // Can this code be a branch label?
6950     };
6951
6952     // Record the instr offset mapping to the generated code
6953
6954     IPmappingDsc* genIPmappingList;
6955     IPmappingDsc* genIPmappingLast;
6956
6957     // Managed RetVal - A side hash table meant to record the mapping from a
6958     // GT_CALL node to its IL offset.  This info is used to emit sequence points
6959     // that can be used by debugger to determine the native offset at which the
6960     // managed RetVal will be available.
6961     //
6962     // In fact we can store IL offset in a GT_CALL node.  This was ruled out in
6963     // favor of a side table for two reasons: 1) We need IL offset for only those
6964     // GT_CALL nodes (created during importation) that correspond to an IL call and
6965     // whose return type is other than TYP_VOID. 2) GT_CALL node is a frequently used
6966     // structure and IL offset is needed only when generating debuggable code. Therefore
6967     // it is desirable to avoid memory size penalty in retail scenarios.
6968     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, IL_OFFSETX, JitSimplerHashBehavior>
6969                            CallSiteILOffsetTable;
6970     CallSiteILOffsetTable* genCallSite2ILOffsetMap;
6971
6972     unsigned    genReturnLocal; // Local number for the return value when applicable.
6973     BasicBlock* genReturnBB;    // jumped to when not optimizing for speed.
6974
6975     // The following properties are part of CodeGenContext.  Getters are provided here for
6976     // convenience and backward compatibility, but the properties can only be set by invoking
6977     // the setter on CodeGenContext directly.
6978
6979     __declspec(property(get = getEmitter)) emitter* genEmitter;
6980     emitter* getEmitter()
6981     {
6982         return codeGen->getEmitter();
6983     }
6984
6985     const bool isFramePointerUsed()
6986     {
6987         return codeGen->isFramePointerUsed();
6988     }
6989
6990     __declspec(property(get = getInterruptible, put = setInterruptible)) bool genInterruptible;
6991     bool getInterruptible()
6992     {
6993         return codeGen->genInterruptible;
6994     }
6995     void setInterruptible(bool value)
6996     {
6997         codeGen->setInterruptible(value);
6998     }
6999
7000 #if DOUBLE_ALIGN
7001     const bool genDoubleAlign()
7002     {
7003         return codeGen->doDoubleAlign();
7004     }
7005     DWORD getCanDoubleAlign();
7006     bool shouldDoubleAlign(unsigned refCntStk,
7007                            unsigned refCntReg,
7008                            unsigned refCntWtdReg,
7009                            unsigned refCntStkParam,
7010                            unsigned refCntWtdStkDbl);
7011 #endif // DOUBLE_ALIGN
7012
7013     __declspec(property(get = getFullPtrRegMap, put = setFullPtrRegMap)) bool genFullPtrRegMap;
7014     bool getFullPtrRegMap()
7015     {
7016         return codeGen->genFullPtrRegMap;
7017     }
7018     void setFullPtrRegMap(bool value)
7019     {
7020         codeGen->setFullPtrRegMap(value);
7021     }
7022
7023 // Things that MAY belong either in CodeGen or CodeGenContext
7024
7025 #if FEATURE_EH_FUNCLETS
7026     FuncInfoDsc*   compFuncInfos;
7027     unsigned short compCurrFuncIdx;
7028     unsigned short compFuncInfoCount;
7029
7030     unsigned short compFuncCount()
7031     {
7032         assert(fgFuncletsCreated);
7033         return compFuncInfoCount;
7034     }
7035
7036 #else // !FEATURE_EH_FUNCLETS
7037
7038     // This is a no-op when there are no funclets!
7039     void genUpdateCurrentFunclet(BasicBlock* block)
7040     {
7041         return;
7042     }
7043
7044     FuncInfoDsc compFuncInfoRoot;
7045
7046     static const unsigned compCurrFuncIdx = 0;
7047
7048     unsigned short compFuncCount()
7049     {
7050         return 1;
7051     }
7052
7053 #endif // !FEATURE_EH_FUNCLETS
7054
7055     FuncInfoDsc* funCurrentFunc();
7056     void funSetCurrentFunc(unsigned funcIdx);
7057     FuncInfoDsc* funGetFunc(unsigned funcIdx);
7058     unsigned int funGetFuncIdx(BasicBlock* block);
7059
7060     // LIVENESS
7061
7062     VARSET_TP  compCurLife;     // current live variables
7063     GenTreePtr compCurLifeTree; // node after which compCurLife has been computed
7064
7065     template <bool ForCodeGen>
7066     void compChangeLife(VARSET_VALARG_TP newLife DEBUGARG(GenTreePtr tree));
7067
7068     void genChangeLife(VARSET_VALARG_TP newLife DEBUGARG(GenTreePtr tree))
7069     {
7070         compChangeLife</*ForCodeGen*/ true>(newLife DEBUGARG(tree));
7071     }
7072
7073     template <bool ForCodeGen>
7074     void compUpdateLife(GenTreePtr tree);
7075
7076     // Updates "compCurLife" to its state after evaluate of "true".  If "pLastUseVars" is
7077     // non-null, sets "*pLastUseVars" to the set of tracked variables for which "tree" was a last
7078     // use.  (Can be more than one var in the case of dependently promoted struct vars.)
7079     template <bool ForCodeGen>
7080     void compUpdateLifeVar(GenTreePtr tree, VARSET_TP* pLastUseVars = nullptr);
7081
7082     template <bool ForCodeGen>
7083     inline void compUpdateLife(VARSET_VALARG_TP newLife);
7084
7085     // Gets a register mask that represent the kill set for a helper call since
7086     // not all JIT Helper calls follow the standard ABI on the target architecture.
7087     regMaskTP compHelperCallKillSet(CorInfoHelpFunc helper);
7088
7089     // Gets a register mask that represent the kill set for a NoGC helper call.
7090     regMaskTP compNoGCHelperCallKillSet(CorInfoHelpFunc helper);
7091
7092 #ifdef _TARGET_ARM_
7093     // Requires that "varDsc" be a promoted struct local variable being passed as an argument, beginning at
7094     // "firstArgRegNum", which is assumed to have already been aligned to the register alignment restriction of the
7095     // struct type. Adds bits to "*pArgSkippedRegMask" for any argument registers *not* used in passing "varDsc" --
7096     // i.e., internal "holes" caused by internal alignment constraints.  For example, if the struct contained an int and
7097     // a double, and we at R0 (on ARM), then R1 would be skipped, and the bit for R1 would be added to the mask.
7098     void fgAddSkippedRegsInPromotedStructArg(LclVarDsc* varDsc, unsigned firstArgRegNum, regMaskTP* pArgSkippedRegMask);
7099 #endif // _TARGET_ARM_
7100
7101     // If "tree" is a indirection (GT_IND, or GT_OBJ) whose arg is an ADDR, whose arg is a LCL_VAR, return that LCL_VAR
7102     // node, else NULL.
7103     static GenTreePtr fgIsIndirOfAddrOfLocal(GenTreePtr tree);
7104
7105     // This is indexed by GT_OBJ nodes that are address of promoted struct variables, which
7106     // have been annotated with the GTF_VAR_DEATH flag.  If such a node is *not* mapped in this
7107     // table, one may assume that all the (tracked) field vars die at this point.  Otherwise,
7108     // the node maps to a pointer to a VARSET_TP, containing set bits for each of the tracked field
7109     // vars of the promoted struct local that go dead at the given node (the set bits are the bits
7110     // for the tracked var indices of the field vars, as in a live var set).
7111     NodeToVarsetPtrMap* m_promotedStructDeathVars;
7112
7113     NodeToVarsetPtrMap* GetPromotedStructDeathVars()
7114     {
7115         if (m_promotedStructDeathVars == nullptr)
7116         {
7117             m_promotedStructDeathVars = new (getAllocator()) NodeToVarsetPtrMap(getAllocator());
7118         }
7119         return m_promotedStructDeathVars;
7120     }
7121
7122 /*
7123 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7124 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7125 XX                                                                           XX
7126 XX                           UnwindInfo                                      XX
7127 XX                                                                           XX
7128 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7129 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7130 */
7131
7132 #if !defined(__GNUC__)
7133 #pragma region Unwind information
7134 #endif
7135
7136 public:
7137     //
7138     // Infrastructure functions: start/stop/reserve/emit.
7139     //
7140
7141     void unwindBegProlog();
7142     void unwindEndProlog();
7143     void unwindBegEpilog();
7144     void unwindEndEpilog();
7145     void unwindReserve();
7146     void unwindEmit(void* pHotCode, void* pColdCode);
7147
7148     //
7149     // Specific unwind information functions: called by code generation to indicate a particular
7150     // prolog or epilog unwindable instruction has been generated.
7151     //
7152
7153     void unwindPush(regNumber reg);
7154     void unwindAllocStack(unsigned size);
7155     void unwindSetFrameReg(regNumber reg, unsigned offset);
7156     void unwindSaveReg(regNumber reg, unsigned offset);
7157
7158 #if defined(_TARGET_ARM_)
7159     void unwindPushMaskInt(regMaskTP mask);
7160     void unwindPushMaskFloat(regMaskTP mask);
7161     void unwindPopMaskInt(regMaskTP mask);
7162     void unwindPopMaskFloat(regMaskTP mask);
7163     void unwindBranch16();                    // The epilog terminates with a 16-bit branch (e.g., "bx lr")
7164     void unwindNop(unsigned codeSizeInBytes); // Generate unwind NOP code. 'codeSizeInBytes' is 2 or 4 bytes. Only
7165                                               // called via unwindPadding().
7166     void unwindPadding(); // Generate a sequence of unwind NOP codes representing instructions between the last
7167                           // instruction and the current location.
7168 #endif                    // _TARGET_ARM_
7169
7170 #if defined(_TARGET_ARM64_)
7171     void unwindNop();
7172     void unwindPadding(); // Generate a sequence of unwind NOP codes representing instructions between the last
7173                           // instruction and the current location.
7174     void unwindSaveReg(regNumber reg, int offset);                                // str reg, [sp, #offset]
7175     void unwindSaveRegPreindexed(regNumber reg, int offset);                      // str reg, [sp, #offset]!
7176     void unwindSaveRegPair(regNumber reg1, regNumber reg2, int offset);           // stp reg1, reg2, [sp, #offset]
7177     void unwindSaveRegPairPreindexed(regNumber reg1, regNumber reg2, int offset); // stp reg1, reg2, [sp, #offset]!
7178     void unwindSaveNext();                                                        // unwind code: save_next
7179     void unwindReturn(regNumber reg);                                             // ret lr
7180 #endif                                                                            // defined(_TARGET_ARM64_)
7181
7182     //
7183     // Private "helper" functions for the unwind implementation.
7184     //
7185
7186 private:
7187 #if FEATURE_EH_FUNCLETS
7188     void unwindGetFuncLocations(FuncInfoDsc*             func,
7189                                 bool                     getHotSectionData,
7190                                 /* OUT */ emitLocation** ppStartLoc,
7191                                 /* OUT */ emitLocation** ppEndLoc);
7192 #endif // FEATURE_EH_FUNCLETS
7193
7194     void unwindReserveFunc(FuncInfoDsc* func);
7195     void unwindEmitFunc(FuncInfoDsc* func, void* pHotCode, void* pColdCode);
7196
7197 #if defined(_TARGET_AMD64_) || (defined(_TARGET_X86_) && FEATURE_EH_FUNCLETS)
7198
7199     void unwindReserveFuncHelper(FuncInfoDsc* func, bool isHotCode);
7200     void unwindEmitFuncHelper(FuncInfoDsc* func, void* pHotCode, void* pColdCode, bool isHotCode);
7201
7202 #endif // _TARGET_AMD64_ || (_TARGET_X86_ && FEATURE_EH_FUNCLETS)
7203
7204 #if defined(_TARGET_AMD64_)
7205
7206     UNATIVE_OFFSET unwindGetCurrentOffset(FuncInfoDsc* func);
7207
7208     void unwindBegPrologWindows();
7209     void unwindPushWindows(regNumber reg);
7210     void unwindAllocStackWindows(unsigned size);
7211     void unwindSetFrameRegWindows(regNumber reg, unsigned offset);
7212     void unwindSaveRegWindows(regNumber reg, unsigned offset);
7213
7214 #ifdef UNIX_AMD64_ABI
7215     void unwindBegPrologCFI();
7216     void unwindPushCFI(regNumber reg);
7217     void unwindAllocStackCFI(unsigned size);
7218     void unwindSetFrameRegCFI(regNumber reg, unsigned offset);
7219     void unwindSaveRegCFI(regNumber reg, unsigned offset);
7220     int mapRegNumToDwarfReg(regNumber reg);
7221     void createCfiCode(FuncInfoDsc* func, UCHAR codeOffset, UCHAR opcode, USHORT dwarfReg, INT offset = 0);
7222 #endif // UNIX_AMD64_ABI
7223 #elif defined(_TARGET_ARM_)
7224
7225     void unwindPushPopMaskInt(regMaskTP mask, bool useOpsize16);
7226     void unwindPushPopMaskFloat(regMaskTP mask);
7227     void unwindSplit(FuncInfoDsc* func);
7228
7229 #endif // _TARGET_ARM_
7230
7231 #if !defined(__GNUC__)
7232 #pragma endregion // Note: region is NOT under !defined(__GNUC__)
7233 #endif
7234
7235     /*
7236     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7237     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7238     XX                                                                           XX
7239     XX                               SIMD                                        XX
7240     XX                                                                           XX
7241     XX   Info about SIMD types, methods and the SIMD assembly (i.e. the assembly XX
7242     XX   that contains the distinguished, well-known SIMD type definitions).     XX
7243     XX                                                                           XX
7244     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7245     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7246     */
7247
7248     // Get highest available instruction set for floating point codegen
7249     InstructionSet getFloatingPointInstructionSet()
7250     {
7251 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7252         if (canUseAVX())
7253         {
7254             return InstructionSet_AVX;
7255         }
7256
7257         if (CanUseSSE3_4())
7258         {
7259             return InstructionSet_SSE3_4;
7260         }
7261
7262         // min bar is SSE2
7263         assert(canUseSSE2());
7264         return InstructionSet_SSE2;
7265 #else
7266         assert(!"getFPInstructionSet() is not implemented for target arch");
7267         unreached();
7268         return InstructionSet_NONE;
7269 #endif
7270     }
7271
7272     // Get highest available instruction set for SIMD codegen
7273     InstructionSet getSIMDInstructionSet()
7274     {
7275 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7276         return getFloatingPointInstructionSet();
7277 #else
7278         assert(!"Available instruction set(s) for SIMD codegen is not defined for target arch");
7279         unreached();
7280         return InstructionSet_NONE;
7281 #endif
7282     }
7283
7284 #ifdef FEATURE_SIMD
7285
7286     // Should we support SIMD intrinsics?
7287     bool featureSIMD;
7288
7289     // Have we identified any SIMD types?
7290     // This is currently used by struct promotion to avoid getting type information for a struct
7291     // field to see if it is a SIMD type, if we haven't seen any SIMD types or operations in
7292     // the method.
7293     bool _usesSIMDTypes;
7294     bool usesSIMDTypes()
7295     {
7296         return _usesSIMDTypes;
7297     }
7298     void setUsesSIMDTypes(bool value)
7299     {
7300         _usesSIMDTypes = value;
7301     }
7302
7303     // This is a temp lclVar allocated on the stack as TYP_SIMD.  It is used to implement intrinsics
7304     // that require indexed access to the individual fields of the vector, which is not well supported
7305     // by the hardware.  It is allocated when/if such situations are encountered during Lowering.
7306     unsigned lvaSIMDInitTempVarNum;
7307
7308     // SIMD Types
7309     CORINFO_CLASS_HANDLE SIMDFloatHandle;
7310     CORINFO_CLASS_HANDLE SIMDDoubleHandle;
7311     CORINFO_CLASS_HANDLE SIMDIntHandle;
7312     CORINFO_CLASS_HANDLE SIMDUShortHandle;
7313     CORINFO_CLASS_HANDLE SIMDUByteHandle;
7314     CORINFO_CLASS_HANDLE SIMDShortHandle;
7315     CORINFO_CLASS_HANDLE SIMDByteHandle;
7316     CORINFO_CLASS_HANDLE SIMDLongHandle;
7317     CORINFO_CLASS_HANDLE SIMDUIntHandle;
7318     CORINFO_CLASS_HANDLE SIMDULongHandle;
7319     CORINFO_CLASS_HANDLE SIMDVector2Handle;
7320     CORINFO_CLASS_HANDLE SIMDVector3Handle;
7321     CORINFO_CLASS_HANDLE SIMDVector4Handle;
7322     CORINFO_CLASS_HANDLE SIMDVectorHandle;
7323
7324     // Get the handle for a SIMD type.
7325     CORINFO_CLASS_HANDLE gtGetStructHandleForSIMD(var_types simdType, var_types simdBaseType)
7326     {
7327         if (simdBaseType == TYP_FLOAT)
7328         {
7329             switch (simdType)
7330             {
7331                 case TYP_SIMD8:
7332                     return SIMDVector2Handle;
7333                 case TYP_SIMD12:
7334                     return SIMDVector3Handle;
7335                 case TYP_SIMD16:
7336                     if ((getSIMDVectorType() == TYP_SIMD32) || (SIMDVector4Handle != NO_CLASS_HANDLE))
7337                     {
7338                         return SIMDVector4Handle;
7339                     }
7340                     break;
7341                 case TYP_SIMD32:
7342                     break;
7343                 default:
7344                     unreached();
7345             }
7346         }
7347         assert(simdType == getSIMDVectorType());
7348         switch (simdBaseType)
7349         {
7350             case TYP_FLOAT:
7351                 return SIMDFloatHandle;
7352             case TYP_DOUBLE:
7353                 return SIMDDoubleHandle;
7354             case TYP_INT:
7355                 return SIMDIntHandle;
7356             case TYP_CHAR:
7357                 return SIMDUShortHandle;
7358             case TYP_USHORT:
7359                 return SIMDUShortHandle;
7360             case TYP_UBYTE:
7361                 return SIMDUByteHandle;
7362             case TYP_SHORT:
7363                 return SIMDShortHandle;
7364             case TYP_BYTE:
7365                 return SIMDByteHandle;
7366             case TYP_LONG:
7367                 return SIMDLongHandle;
7368             case TYP_UINT:
7369                 return SIMDUIntHandle;
7370             case TYP_ULONG:
7371                 return SIMDULongHandle;
7372             default:
7373                 assert(!"Didn't find a class handle for simdType");
7374         }
7375         return NO_CLASS_HANDLE;
7376     }
7377
7378     // SIMD Methods
7379     CORINFO_METHOD_HANDLE SIMDVectorFloat_set_Item;
7380     CORINFO_METHOD_HANDLE SIMDVectorFloat_get_Length;
7381     CORINFO_METHOD_HANDLE SIMDVectorFloat_op_Addition;
7382
7383     // Returns true if the tree corresponds to a TYP_SIMD lcl var.
7384     // Note that both SIMD vector args and locals are mared as lvSIMDType = true, but
7385     // type of an arg node is TYP_BYREF and a local node is TYP_SIMD or TYP_STRUCT.
7386     bool isSIMDTypeLocal(GenTree* tree)
7387     {
7388         return tree->OperIsLocal() && lvaTable[tree->AsLclVarCommon()->gtLclNum].lvSIMDType;
7389     }
7390
7391     // Returns true if the type of the tree is a byref of TYP_SIMD
7392     bool isAddrOfSIMDType(GenTree* tree)
7393     {
7394         if (tree->TypeGet() == TYP_BYREF || tree->TypeGet() == TYP_I_IMPL)
7395         {
7396             switch (tree->OperGet())
7397             {
7398                 case GT_ADDR:
7399                     return varTypeIsSIMD(tree->gtGetOp1());
7400
7401                 case GT_LCL_VAR_ADDR:
7402                     return lvaTable[tree->AsLclVarCommon()->gtLclNum].lvSIMDType;
7403
7404                 default:
7405                     return isSIMDTypeLocal(tree);
7406             }
7407         }
7408
7409         return false;
7410     }
7411
7412     static bool isRelOpSIMDIntrinsic(SIMDIntrinsicID intrinsicId)
7413     {
7414         return (intrinsicId == SIMDIntrinsicEqual || intrinsicId == SIMDIntrinsicLessThan ||
7415                 intrinsicId == SIMDIntrinsicLessThanOrEqual || intrinsicId == SIMDIntrinsicGreaterThan ||
7416                 intrinsicId == SIMDIntrinsicGreaterThanOrEqual);
7417     }
7418
7419     // Returns base type of a TYP_SIMD local.
7420     // Returns TYP_UNKNOWN if the local is not TYP_SIMD.
7421     var_types getBaseTypeOfSIMDLocal(GenTree* tree)
7422     {
7423         if (isSIMDTypeLocal(tree))
7424         {
7425             return lvaTable[tree->AsLclVarCommon()->gtLclNum].lvBaseType;
7426         }
7427
7428         return TYP_UNKNOWN;
7429     }
7430
7431     bool isSIMDClass(CORINFO_CLASS_HANDLE clsHnd)
7432     {
7433         return info.compCompHnd->isInSIMDModule(clsHnd);
7434     }
7435
7436     bool isSIMDClass(typeInfo* pTypeInfo)
7437     {
7438         return pTypeInfo->IsStruct() && isSIMDClass(pTypeInfo->GetClassHandleForValueClass());
7439     }
7440
7441     // Get the base (element) type and size in bytes for a SIMD type. Returns TYP_UNKNOWN
7442     // if it is not a SIMD type or is an unsupported base type.
7443     var_types getBaseTypeAndSizeOfSIMDType(CORINFO_CLASS_HANDLE typeHnd, unsigned* sizeBytes = nullptr);
7444
7445     var_types getBaseTypeOfSIMDType(CORINFO_CLASS_HANDLE typeHnd)
7446     {
7447         return getBaseTypeAndSizeOfSIMDType(typeHnd, nullptr);
7448     }
7449
7450     // Get SIMD Intrinsic info given the method handle.
7451     // Also sets typeHnd, argCount, baseType and sizeBytes out params.
7452     const SIMDIntrinsicInfo* getSIMDIntrinsicInfo(CORINFO_CLASS_HANDLE* typeHnd,
7453                                                   CORINFO_METHOD_HANDLE methodHnd,
7454                                                   CORINFO_SIG_INFO*     sig,
7455                                                   bool                  isNewObj,
7456                                                   unsigned*             argCount,
7457                                                   var_types*            baseType,
7458                                                   unsigned*             sizeBytes);
7459
7460     // Pops and returns GenTree node from importers type stack.
7461     // Normalizes TYP_STRUCT value in case of GT_CALL, GT_RET_EXPR and arg nodes.
7462     GenTreePtr impSIMDPopStack(var_types type, bool expectAddr = false);
7463
7464     // Create a GT_SIMD tree for a Get property of SIMD vector with a fixed index.
7465     GenTreeSIMD* impSIMDGetFixed(var_types simdType, var_types baseType, unsigned simdSize, int index);
7466
7467     // Creates a GT_SIMD tree for Select operation
7468     GenTreePtr impSIMDSelect(CORINFO_CLASS_HANDLE typeHnd,
7469                              var_types            baseType,
7470                              unsigned             simdVectorSize,
7471                              GenTree*             op1,
7472                              GenTree*             op2,
7473                              GenTree*             op3);
7474
7475     // Creates a GT_SIMD tree for Min/Max operation
7476     GenTreePtr impSIMDMinMax(SIMDIntrinsicID      intrinsicId,
7477                              CORINFO_CLASS_HANDLE typeHnd,
7478                              var_types            baseType,
7479                              unsigned             simdVectorSize,
7480                              GenTree*             op1,
7481                              GenTree*             op2);
7482
7483     // Transforms operands and returns the SIMD intrinsic to be applied on
7484     // transformed operands to obtain given relop result.
7485     SIMDIntrinsicID impSIMDRelOp(SIMDIntrinsicID      relOpIntrinsicId,
7486                                  CORINFO_CLASS_HANDLE typeHnd,
7487                                  unsigned             simdVectorSize,
7488                                  var_types*           baseType,
7489                                  GenTree**            op1,
7490                                  GenTree**            op2);
7491
7492     // Creates a GT_SIMD tree for Abs intrinsic.
7493     GenTreePtr impSIMDAbs(CORINFO_CLASS_HANDLE typeHnd, var_types baseType, unsigned simdVectorSize, GenTree* op1);
7494
7495 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7496     // Transforms operands and returns the SIMD intrinsic to be applied on
7497     // transformed operands to obtain == comparison result.
7498     SIMDIntrinsicID impSIMDLongRelOpEqual(CORINFO_CLASS_HANDLE typeHnd,
7499                                           unsigned             simdVectorSize,
7500                                           GenTree**            op1,
7501                                           GenTree**            op2);
7502
7503     // Transforms operands and returns the SIMD intrinsic to be applied on
7504     // transformed operands to obtain > comparison result.
7505     SIMDIntrinsicID impSIMDLongRelOpGreaterThan(CORINFO_CLASS_HANDLE typeHnd,
7506                                                 unsigned             simdVectorSize,
7507                                                 GenTree**            op1,
7508                                                 GenTree**            op2);
7509
7510     // Transforms operands and returns the SIMD intrinsic to be applied on
7511     // transformed operands to obtain >= comparison result.
7512     SIMDIntrinsicID impSIMDLongRelOpGreaterThanOrEqual(CORINFO_CLASS_HANDLE typeHnd,
7513                                                        unsigned             simdVectorSize,
7514                                                        GenTree**            op1,
7515                                                        GenTree**            op2);
7516
7517     // Transforms operands and returns the SIMD intrinsic to be applied on
7518     // transformed operands to obtain >= comparison result in case of int32
7519     // and small int base type vectors.
7520     SIMDIntrinsicID impSIMDIntegralRelOpGreaterThanOrEqual(
7521         CORINFO_CLASS_HANDLE typeHnd, unsigned simdVectorSize, var_types baseType, GenTree** op1, GenTree** op2);
7522 #endif // defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7523
7524     void setLclRelatedToSIMDIntrinsic(GenTreePtr tree);
7525     bool areFieldsContiguous(GenTreePtr op1, GenTreePtr op2);
7526     bool areArrayElementsContiguous(GenTreePtr op1, GenTreePtr op2);
7527     bool areArgumentsContiguous(GenTreePtr op1, GenTreePtr op2);
7528     GenTreePtr createAddressNodeForSIMDInit(GenTreePtr tree, unsigned simdSize);
7529
7530     // check methodHnd to see if it is a SIMD method that is expanded as an intrinsic in the JIT.
7531     GenTreePtr impSIMDIntrinsic(OPCODE                opcode,
7532                                 GenTreePtr            newobjThis,
7533                                 CORINFO_CLASS_HANDLE  clsHnd,
7534                                 CORINFO_METHOD_HANDLE method,
7535                                 CORINFO_SIG_INFO*     sig,
7536                                 int                   memberRef);
7537
7538     GenTreePtr getOp1ForConstructor(OPCODE opcode, GenTreePtr newobjThis, CORINFO_CLASS_HANDLE clsHnd);
7539
7540     // Whether SIMD vector occupies part of SIMD register.
7541     // SSE2: vector2f/3f are considered sub register SIMD types.
7542     // AVX: vector2f, 3f and 4f are all considered sub register SIMD types.
7543     bool isSubRegisterSIMDType(CORINFO_CLASS_HANDLE typeHnd)
7544     {
7545         unsigned  sizeBytes = 0;
7546         var_types baseType  = getBaseTypeAndSizeOfSIMDType(typeHnd, &sizeBytes);
7547         return (baseType == TYP_FLOAT) && (sizeBytes < getSIMDVectorRegisterByteLength());
7548     }
7549
7550     bool isSubRegisterSIMDType(GenTreeSIMD* simdNode)
7551     {
7552         return (simdNode->gtSIMDSize < getSIMDVectorRegisterByteLength());
7553     }
7554
7555     // Get the type for the hardware SIMD vector.
7556     // This is the maximum SIMD type supported for this target.
7557     var_types getSIMDVectorType()
7558     {
7559 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7560         if (canUseAVX())
7561         {
7562             return TYP_SIMD32;
7563         }
7564         else
7565         {
7566             assert(canUseSSE2());
7567             return TYP_SIMD16;
7568         }
7569 #else
7570         assert(!"getSIMDVectorType() unimplemented on target arch");
7571         unreached();
7572 #endif
7573     }
7574
7575     // Get the size of the SIMD type in bytes
7576     int getSIMDTypeSizeInBytes(CORINFO_CLASS_HANDLE typeHnd)
7577     {
7578         unsigned sizeBytes = 0;
7579         (void)getBaseTypeAndSizeOfSIMDType(typeHnd, &sizeBytes);
7580         return sizeBytes;
7581     }
7582
7583     // Get the the number of elements of basetype of SIMD vector given by its size and baseType
7584     static int getSIMDVectorLength(unsigned simdSize, var_types baseType);
7585
7586     // Get the the number of elements of basetype of SIMD vector given by its type handle
7587     int getSIMDVectorLength(CORINFO_CLASS_HANDLE typeHnd);
7588
7589     // Get preferred alignment of SIMD type.
7590     int getSIMDTypeAlignment(var_types simdType);
7591
7592     // Get the number of bytes in a SIMD Vector for the current compilation.
7593     unsigned getSIMDVectorRegisterByteLength()
7594     {
7595 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7596         if (canUseAVX())
7597         {
7598             return YMM_REGSIZE_BYTES;
7599         }
7600         else
7601         {
7602             assert(canUseSSE2());
7603             return XMM_REGSIZE_BYTES;
7604         }
7605 #else
7606         assert(!"getSIMDVectorRegisterByteLength() unimplemented on target arch");
7607         unreached();
7608 #endif
7609     }
7610
7611     // The minimum and maximum possible number of bytes in a SIMD vector.
7612     unsigned int maxSIMDStructBytes()
7613     {
7614         return getSIMDVectorRegisterByteLength();
7615     }
7616     unsigned int minSIMDStructBytes()
7617     {
7618         return emitTypeSize(TYP_SIMD8);
7619     }
7620
7621 #ifdef FEATURE_AVX_SUPPORT
7622     // (maxPossibleSIMDStructBytes is for use in a context that requires a compile-time constant.)
7623     static const unsigned maxPossibleSIMDStructBytes = 32;
7624 #else  // !FEATURE_AVX_SUPPORT
7625     static const unsigned maxPossibleSIMDStructBytes = 16;
7626 #endif // !FEATURE_AVX_SUPPORT
7627
7628     // Returns the codegen type for a given SIMD size.
7629     var_types getSIMDTypeForSize(unsigned size)
7630     {
7631         var_types simdType = TYP_UNDEF;
7632         if (size == 8)
7633         {
7634             simdType = TYP_SIMD8;
7635         }
7636         else if (size == 12)
7637         {
7638             simdType = TYP_SIMD12;
7639         }
7640         else if (size == 16)
7641         {
7642             simdType = TYP_SIMD16;
7643         }
7644 #ifdef FEATURE_AVX_SUPPORT
7645         else if (size == 32)
7646         {
7647             simdType = TYP_SIMD32;
7648         }
7649 #endif // FEATURE_AVX_SUPPORT
7650         else
7651         {
7652             noway_assert(!"Unexpected size for SIMD type");
7653         }
7654         return simdType;
7655     }
7656
7657     unsigned getSIMDInitTempVarNum()
7658     {
7659         if (lvaSIMDInitTempVarNum == BAD_VAR_NUM)
7660         {
7661             lvaSIMDInitTempVarNum                  = lvaGrabTempWithImplicitUse(false DEBUGARG("SIMDInitTempVar"));
7662             lvaTable[lvaSIMDInitTempVarNum].lvType = getSIMDVectorType();
7663         }
7664         return lvaSIMDInitTempVarNum;
7665     }
7666
7667 #endif // FEATURE_SIMD
7668
7669 public:
7670     //------------------------------------------------------------------------
7671     // largestEnregisterableStruct: The size in bytes of the largest struct that can be enregistered.
7672     //
7673     // Notes: It is not guaranteed that the struct of this size or smaller WILL be a
7674     //        candidate for enregistration.
7675
7676     unsigned largestEnregisterableStructSize()
7677     {
7678 #ifdef FEATURE_SIMD
7679         unsigned vectorRegSize = getSIMDVectorRegisterByteLength();
7680         if (vectorRegSize > TARGET_POINTER_SIZE)
7681         {
7682             return vectorRegSize;
7683         }
7684         else
7685 #endif // FEATURE_SIMD
7686         {
7687             return TARGET_POINTER_SIZE;
7688         }
7689     }
7690
7691 private:
7692     // These routines need not be enclosed under FEATURE_SIMD since lvIsSIMDType()
7693     // is defined for both FEATURE_SIMD and !FEATURE_SIMD apropriately. The use
7694     // of this routines also avoids the need of #ifdef FEATURE_SIMD specific code.
7695
7696     // Is this var is of type simd struct?
7697     bool lclVarIsSIMDType(unsigned varNum)
7698     {
7699         LclVarDsc* varDsc = lvaTable + varNum;
7700         return varDsc->lvIsSIMDType();
7701     }
7702
7703     // Is this Local node a SIMD local?
7704     bool lclVarIsSIMDType(GenTreeLclVarCommon* lclVarTree)
7705     {
7706         return lclVarIsSIMDType(lclVarTree->gtLclNum);
7707     }
7708
7709     // Returns true if the TYP_SIMD locals on stack are aligned at their
7710     // preferred byte boundary specified by getSIMDTypeAlignment().
7711     //
7712     // As per the Intel manual, the preferred alignment for AVX vectors is 32-bytes. On Amd64,
7713     // RSP/EBP is aligned at 16-bytes, therefore to align SIMD types at 32-bytes we need even
7714     // RSP/EBP to be 32-byte aligned. It is not clear whether additional stack space used in
7715     // aligning stack is worth the benefit and for now will use 16-byte alignment for AVX
7716     // 256-bit vectors with unaligned load/stores to/from memory. On x86, the stack frame
7717     // is aligned to 4 bytes. We need to extend existing support for double (8-byte) alignment
7718     // to 16 or 32 byte alignment for frames with local SIMD vars, if that is determined to be
7719     // profitable.
7720     //
7721     bool isSIMDTypeLocalAligned(unsigned varNum)
7722     {
7723 #if defined(FEATURE_SIMD) && ALIGN_SIMD_TYPES
7724         if (lclVarIsSIMDType(varNum) && lvaTable[varNum].lvType != TYP_BYREF)
7725         {
7726             bool ebpBased;
7727             int  off = lvaFrameAddress(varNum, &ebpBased);
7728             // TODO-Cleanup: Can't this use the lvExactSize on the varDsc?
7729             int  alignment = getSIMDTypeAlignment(lvaTable[varNum].lvType);
7730             bool isAligned = (alignment <= STACK_ALIGN) && ((off % alignment) == 0);
7731             return isAligned;
7732         }
7733 #endif // FEATURE_SIMD
7734
7735         return false;
7736     }
7737
7738     // Whether SSE2 is available
7739     bool canUseSSE2() const
7740     {
7741 #ifdef _TARGET_XARCH_
7742         return opts.compCanUseSSE2;
7743 #else
7744         return false;
7745 #endif
7746     }
7747
7748     // Whether SSE3, SSE3, SSE4.1 and SSE4.2 is available
7749     bool CanUseSSE3_4() const
7750     {
7751 #ifdef _TARGET_XARCH_
7752         return opts.compCanUseSSE3_4;
7753 #else
7754         return false;
7755 #endif
7756     }
7757
7758     bool canUseAVX() const
7759     {
7760 #ifdef FEATURE_AVX_SUPPORT
7761         return opts.compCanUseAVX;
7762 #else
7763         return false;
7764 #endif
7765     }
7766
7767     /*
7768     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7769     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7770     XX                                                                           XX
7771     XX                           Compiler                                        XX
7772     XX                                                                           XX
7773     XX   Generic info about the compilation and the method being compiled.       XX
7774     XX   It is responsible for driving the other phases.                         XX
7775     XX   It is also responsible for all the memory management.                   XX
7776     XX                                                                           XX
7777     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7778     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7779     */
7780
7781 public:
7782     Compiler* InlineeCompiler; // The Compiler instance for the inlinee
7783
7784     InlineResult* compInlineResult; // The result of importing the inlinee method.
7785
7786     bool compDoAggressiveInlining; // If true, mark every method as CORINFO_FLG_FORCEINLINE
7787     bool compJmpOpUsed;            // Does the method do a JMP
7788     bool compLongUsed;             // Does the method use TYP_LONG
7789     bool compFloatingPointUsed;    // Does the method use TYP_FLOAT or TYP_DOUBLE
7790     bool compTailCallUsed;         // Does the method do a tailcall
7791     bool compLocallocUsed;         // Does the method use localloc.
7792     bool compQmarkUsed;            // Does the method use GT_QMARK/GT_COLON
7793     bool compQmarkRationalized;    // Is it allowed to use a GT_QMARK/GT_COLON node.
7794     bool compUnsafeCastUsed;       // Does the method use LDIND/STIND to cast between scalar/refernce types
7795
7796 // NOTE: These values are only reliable after
7797 //       the importing is completely finished.
7798
7799 #ifdef LEGACY_BACKEND
7800     ExpandArrayStack<GenTreePtr>* compQMarks; // The set of QMark nodes created in the current compilation, so
7801                                               // we can iterate over these efficiently.
7802 #endif
7803
7804 #if CPU_USES_BLOCK_MOVE
7805     bool compBlkOpUsed; // Does the method do a COPYBLK or INITBLK
7806 #endif
7807
7808 #ifdef DEBUG
7809     // State information - which phases have completed?
7810     // These are kept together for easy discoverability
7811
7812     bool    bRangeAllowStress;
7813     bool    compCodeGenDone;
7814     int64_t compNumStatementLinksTraversed; // # of links traversed while doing debug checks
7815     bool    fgNormalizeEHDone;              // Has the flowgraph EH normalization phase been done?
7816     size_t  compSizeEstimate;               // The estimated size of the method as per `gtSetEvalOrder`.
7817     size_t  compCycleEstimate;              // The estimated cycle count of the method as per `gtSetEvalOrder`
7818 #endif                                      // DEBUG
7819
7820     bool fgLocalVarLivenessDone; // Note that this one is used outside of debug.
7821     bool fgLocalVarLivenessChanged;
7822 #if STACK_PROBES
7823     bool compStackProbePrologDone;
7824 #endif
7825 #ifndef LEGACY_BACKEND
7826     bool compLSRADone;
7827 #endif // !LEGACY_BACKEND
7828     bool compRationalIRForm;
7829
7830     bool compUsesThrowHelper; // There is a call to a THOROW_HELPER for the compiled method.
7831
7832     bool compGeneratingProlog;
7833     bool compGeneratingEpilog;
7834     bool compNeedsGSSecurityCookie; // There is an unsafe buffer (or localloc) on the stack.
7835                                     // Insert cookie on frame and code to check the cookie, like VC++ -GS.
7836     bool compGSReorderStackLayout;  // There is an unsafe buffer on the stack, reorder locals and make local
7837     // copies of susceptible parameters to avoid buffer overrun attacks through locals/params
7838     bool getNeedsGSSecurityCookie() const
7839     {
7840         return compNeedsGSSecurityCookie;
7841     }
7842     void setNeedsGSSecurityCookie()
7843     {
7844         compNeedsGSSecurityCookie = true;
7845     }
7846
7847     FrameLayoutState lvaDoneFrameLayout; // The highest frame layout state that we've completed. During
7848                                          // frame layout calculations, this is the level we are currently
7849                                          // computing.
7850
7851     //---------------------------- JITing options -----------------------------
7852
7853     enum codeOptimize
7854     {
7855         BLENDED_CODE,
7856         SMALL_CODE,
7857         FAST_CODE,
7858
7859         COUNT_OPT_CODE
7860     };
7861
7862     struct Options
7863     {
7864         JitFlags* jitFlags;  // all flags passed from the EE
7865         unsigned  compFlags; // method attributes
7866
7867         codeOptimize compCodeOpt; // what type of code optimizations
7868
7869         bool compUseFCOMI;
7870         bool compUseCMOV;
7871 #ifdef _TARGET_XARCH_
7872         bool compCanUseSSE2;   // Allow CodeGen to use "movq XMM" instructions
7873         bool compCanUseSSE3_4; // Allow CodeGen to use SSE3, SSSE3, SSE4.1 and SSE4.2 instructions
7874
7875 #ifdef FEATURE_AVX_SUPPORT
7876         bool compCanUseAVX; // Allow CodeGen to use AVX 256-bit vectors for SIMD operations
7877 #endif                      // FEATURE_AVX_SUPPORT
7878 #endif                      // _TARGET_XARCH_
7879
7880 // optimize maximally and/or favor speed over size?
7881
7882 #define DEFAULT_MIN_OPTS_CODE_SIZE 60000
7883 #define DEFAULT_MIN_OPTS_INSTR_COUNT 20000
7884 #define DEFAULT_MIN_OPTS_BB_COUNT 2000
7885 #define DEFAULT_MIN_OPTS_LV_NUM_COUNT 2000
7886 #define DEFAULT_MIN_OPTS_LV_REF_COUNT 8000
7887
7888 // Maximun number of locals before turning off the inlining
7889 #define MAX_LV_NUM_COUNT_FOR_INLINING 512
7890
7891         bool     compMinOpts;
7892         unsigned instrCount;
7893         unsigned lvRefCount;
7894         bool     compMinOptsIsSet;
7895 #ifdef DEBUG
7896         bool compMinOptsIsUsed;
7897
7898         inline bool MinOpts()
7899         {
7900             assert(compMinOptsIsSet);
7901             compMinOptsIsUsed = true;
7902             return compMinOpts;
7903         }
7904         inline bool IsMinOptsSet()
7905         {
7906             return compMinOptsIsSet;
7907         }
7908 #else  // !DEBUG
7909         inline bool MinOpts()
7910         {
7911             return compMinOpts;
7912         }
7913         inline bool IsMinOptsSet()
7914         {
7915             return compMinOptsIsSet;
7916         }
7917 #endif // !DEBUG
7918         inline void SetMinOpts(bool val)
7919         {
7920             assert(!compMinOptsIsUsed);
7921             assert(!compMinOptsIsSet || (compMinOpts == val));
7922             compMinOpts      = val;
7923             compMinOptsIsSet = true;
7924         }
7925
7926         // true if the CLFLG_* for an optimization is set.
7927         inline bool OptEnabled(unsigned optFlag)
7928         {
7929             return !!(compFlags & optFlag);
7930         }
7931
7932 #ifdef FEATURE_READYTORUN_COMPILER
7933         inline bool IsReadyToRun()
7934         {
7935             return jitFlags->IsSet(JitFlags::JIT_FLAG_READYTORUN);
7936         }
7937 #else
7938         inline bool IsReadyToRun()
7939         {
7940             return false;
7941         }
7942 #endif
7943
7944         // true if we should use the PINVOKE_{BEGIN,END} helpers instead of generating
7945         // PInvoke transitions inline (e.g. when targeting CoreRT).
7946         inline bool ShouldUsePInvokeHelpers()
7947         {
7948             return jitFlags->IsSet(JitFlags::JIT_FLAG_USE_PINVOKE_HELPERS);
7949         }
7950
7951         // true if we should use insert the REVERSE_PINVOKE_{ENTER,EXIT} helpers in the method
7952         // prolog/epilog
7953         inline bool IsReversePInvoke()
7954         {
7955             return jitFlags->IsSet(JitFlags::JIT_FLAG_REVERSE_PINVOKE);
7956         }
7957
7958         // true if we must generate code compatible with JIT32 quirks
7959         inline bool IsJit32Compat()
7960         {
7961 #if defined(_TARGET_X86_)
7962             return jitFlags->IsSet(JitFlags::JIT_FLAG_DESKTOP_QUIRKS);
7963 #else
7964             return false;
7965 #endif
7966         }
7967
7968         // true if we must generate code compatible with Jit64 quirks
7969         inline bool IsJit64Compat()
7970         {
7971 #if defined(_TARGET_AMD64_)
7972             return jitFlags->IsSet(JitFlags::JIT_FLAG_DESKTOP_QUIRKS);
7973 #elif !defined(FEATURE_CORECLR)
7974             return true;
7975 #else
7976             return false;
7977 #endif
7978         }
7979
7980         bool compScopeInfo; // Generate the LocalVar info ?
7981         bool compDbgCode;   // Generate debugger-friendly code?
7982         bool compDbgInfo;   // Gather debugging info?
7983         bool compDbgEnC;
7984
7985 #ifdef PROFILING_SUPPORTED
7986         bool compNoPInvokeInlineCB;
7987 #else
7988         static const bool compNoPInvokeInlineCB;
7989 #endif
7990
7991 #ifdef DEBUG
7992         bool compGcChecks;         // Check arguments and return values to ensure they are sane
7993         bool compStackCheckOnRet;  // Check ESP on return to ensure it is correct
7994         bool compStackCheckOnCall; // Check ESP after every call to ensure it is correct
7995
7996 #endif
7997
7998         bool compNeedSecurityCheck; // This flag really means where or not a security object needs
7999                                     // to be allocated on the stack.
8000                                     // It will be set to true in the following cases:
8001                                     //   1. When the method being compiled has a declarative security
8002                                     //        (i.e. when CORINFO_FLG_NOSECURITYWRAP is reset for the current method).
8003                                     //        This is also the case when we inject a prolog and epilog in the method.
8004                                     //   (or)
8005                                     //   2. When the method being compiled has imperative security (i.e. the method
8006                                     //        calls into another method that has CORINFO_FLG_SECURITYCHECK flag set).
8007                                     //   (or)
8008                                     //   3. When opts.compDbgEnC is true. (See also Compiler::compCompile).
8009                                     //
8010         // When this flag is set, jit will allocate a gc-reference local variable (lvaSecurityObject),
8011         // which gets reported as a GC root to stackwalker.
8012         // (See also ICodeManager::GetAddrOfSecurityObject.)
8013
8014         bool compReloc;
8015
8016 #ifdef DEBUG
8017 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
8018         bool compEnablePCRelAddr; // Whether absolute addr be encoded as PC-rel offset by RyuJIT where possible
8019 #endif
8020 #endif // DEBUG
8021
8022 #ifdef UNIX_AMD64_ABI
8023         // This flag  is indicating if there is a need to align the frame.
8024         // On AMD64-Windows, if there are calls, 4 slots for the outgoing ars are allocated, except for
8025         // FastTailCall. This slots makes the frame size non-zero, so alignment logic will be called.
8026         // On AMD64-Unix, there are no such slots. There is a possibility to have calls in the method with frame size of
8027         // 0. The frame alignment logic won't kick in. This flags takes care of the AMD64-Unix case by remembering that
8028         // there are calls and making sure the frame alignment logic is executed.
8029         bool compNeedToAlignFrame;
8030 #endif // UNIX_AMD64_ABI
8031
8032         bool compProcedureSplitting; // Separate cold code from hot code
8033
8034         bool genFPorder; // Preserve FP order (operations are non-commutative)
8035         bool genFPopt;   // Can we do frame-pointer-omission optimization?
8036         bool altJit;     // True if we are an altjit and are compiling this method
8037
8038 #ifdef OPT_CONFIG
8039         bool optRepeat; // Repeat optimizer phases k times
8040 #endif
8041
8042 #ifdef DEBUG
8043         bool compProcedureSplittingEH; // Separate cold code from hot code for functions with EH
8044         bool dspCode;                  // Display native code generated
8045         bool dspEHTable;               // Display the EH table reported to the VM
8046         bool dspInstrs;                // Display the IL instructions intermixed with the native code output
8047         bool dspEmit;                  // Display emitter output
8048         bool dspLines;                 // Display source-code lines intermixed with native code output
8049         bool dmpHex;                   // Display raw bytes in hex of native code output
8050         bool varNames;                 // Display variables names in native code output
8051         bool disAsm;                   // Display native code as it is generated
8052         bool disAsmSpilled;            // Display native code when any register spilling occurs
8053         bool disDiffable;              // Makes the Disassembly code 'diff-able'
8054         bool disAsm2;                  // Display native code after it is generated using external disassembler
8055         bool dspOrder;                 // Display names of each of the methods that we ngen/jit
8056         bool dspUnwind;                // Display the unwind info output
8057         bool dspDiffable;     // Makes the Jit Dump 'diff-able' (currently uses same COMPlus_* flag as disDiffable)
8058         bool compLongAddress; // Force using large pseudo instructions for long address
8059                               // (IF_LARGEJMP/IF_LARGEADR/IF_LARGLDC)
8060         bool dspGCtbls;       // Display the GC tables
8061 #endif
8062
8063 #ifdef LATE_DISASM
8064         bool doLateDisasm; // Run the late disassembler
8065 #endif                     // LATE_DISASM
8066
8067 #if DUMP_GC_TABLES && !defined(DEBUG) && defined(JIT32_GCENCODER)
8068 // Only the JIT32_GCENCODER implements GC dumping in non-DEBUG code.
8069 #pragma message("NOTE: this non-debug build has GC ptr table dumping always enabled!")
8070         static const bool dspGCtbls = true;
8071 #endif
8072
8073         // We need stack probes to guarantee that we won't trigger a stack overflow
8074         // when calling unmanaged code until they get a chance to set up a frame, because
8075         // the EE will have no idea where it is.
8076         //
8077         // We will only be doing this currently for hosted environments. Unfortunately
8078         // we need to take care of stubs, so potentially, we will have to do the probes
8079         // for any call. We have a plan for not needing for stubs though
8080         bool compNeedStackProbes;
8081
8082 #ifdef PROFILING_SUPPORTED
8083         // Whether to emit Enter/Leave/TailCall hooks using a dummy stub (DummyProfilerELTStub()).
8084         // This option helps make the JIT behave as if it is running under a profiler.
8085         bool compJitELTHookEnabled;
8086 #endif // PROFILING_SUPPORTED
8087
8088 #if FEATURE_TAILCALL_OPT
8089         // Whether opportunistic or implicit tail call optimization is enabled.
8090         bool compTailCallOpt;
8091         // Whether optimization of transforming a recursive tail call into a loop is enabled.
8092         bool compTailCallLoopOpt;
8093 #endif
8094
8095 #ifdef ARM_SOFTFP
8096         static const bool compUseSoftFP = true;
8097 #else // !ARM_SOFTFP
8098         static const bool compUseSoftFP = false;
8099 #endif
8100
8101         GCPollType compGCPollType;
8102     } opts;
8103
8104 #ifdef ALT_JIT
8105     static bool                s_pAltJitExcludeAssembliesListInitialized;
8106     static AssemblyNamesList2* s_pAltJitExcludeAssembliesList;
8107 #endif // ALT_JIT
8108
8109 #ifdef DEBUG
8110
8111     template <typename T>
8112     T dspPtr(T p)
8113     {
8114         return (p == ZERO) ? ZERO : (opts.dspDiffable ? T(0xD1FFAB1E) : p);
8115     }
8116
8117     template <typename T>
8118     T dspOffset(T o)
8119     {
8120         return (o == ZERO) ? ZERO : (opts.dspDiffable ? T(0xD1FFAB1E) : o);
8121     }
8122
8123     static int dspTreeID(GenTree* tree)
8124     {
8125         return tree->gtTreeID;
8126     }
8127     static void printTreeID(GenTree* tree)
8128     {
8129         if (tree == nullptr)
8130         {
8131             printf("[------]");
8132         }
8133         else
8134         {
8135             printf("[%06d]", dspTreeID(tree));
8136         }
8137     }
8138
8139 #endif // DEBUG
8140
8141 // clang-format off
8142 #define STRESS_MODES                                                                            \
8143                                                                                                 \
8144         STRESS_MODE(NONE)                                                                       \
8145                                                                                                 \
8146         /* "Variations" stress areas which we try to mix up with each other. */                 \
8147         /* These should not be exhaustively used as they might */                               \
8148         /* hide/trivialize other areas */                                                       \
8149                                                                                                 \
8150         STRESS_MODE(REGS)                                                                       \
8151         STRESS_MODE(DBL_ALN)                                                                    \
8152         STRESS_MODE(LCL_FLDS)                                                                   \
8153         STRESS_MODE(UNROLL_LOOPS)                                                               \
8154         STRESS_MODE(MAKE_CSE)                                                                   \
8155         STRESS_MODE(LEGACY_INLINE)                                                              \
8156         STRESS_MODE(CLONE_EXPR)                                                                 \
8157         STRESS_MODE(USE_FCOMI)                                                                  \
8158         STRESS_MODE(USE_CMOV)                                                                   \
8159         STRESS_MODE(FOLD)                                                                       \
8160         STRESS_MODE(BB_PROFILE)                                                                 \
8161         STRESS_MODE(OPT_BOOLS_GC)                                                               \
8162         STRESS_MODE(REMORPH_TREES)                                                              \
8163         STRESS_MODE(64RSLT_MUL)                                                                 \
8164         STRESS_MODE(DO_WHILE_LOOPS)                                                             \
8165         STRESS_MODE(MIN_OPTS)                                                                   \
8166         STRESS_MODE(REVERSE_FLAG)     /* Will set GTF_REVERSE_OPS whenever we can */            \
8167         STRESS_MODE(REVERSE_COMMA)    /* Will reverse commas created  with gtNewCommaNode */    \
8168         STRESS_MODE(TAILCALL)         /* Will make the call as a tailcall whenever legal */     \
8169         STRESS_MODE(CATCH_ARG)        /* Will spill catch arg */                                \
8170         STRESS_MODE(UNSAFE_BUFFER_CHECKS)                                                       \
8171         STRESS_MODE(NULL_OBJECT_CHECK)                                                          \
8172         STRESS_MODE(PINVOKE_RESTORE_ESP)                                                        \
8173         STRESS_MODE(RANDOM_INLINE)                                                              \
8174         STRESS_MODE(SWITCH_CMP_BR_EXPANSION)                                                    \
8175         STRESS_MODE(GENERIC_VARN)                                                               \
8176                                                                                                 \
8177         /* After COUNT_VARN, stress level 2 does all of these all the time */                   \
8178                                                                                                 \
8179         STRESS_MODE(COUNT_VARN)                                                                 \
8180                                                                                                 \
8181         /* "Check" stress areas that can be exhaustively used if we */                          \
8182         /*  dont care about performance at all */                                               \
8183                                                                                                 \
8184         STRESS_MODE(FORCE_INLINE) /* Treat every method as AggressiveInlining */                \
8185         STRESS_MODE(CHK_FLOW_UPDATE)                                                            \
8186         STRESS_MODE(EMITTER)                                                                    \
8187         STRESS_MODE(CHK_REIMPORT)                                                               \
8188         STRESS_MODE(FLATFP)                                                                     \
8189         STRESS_MODE(GENERIC_CHECK)                                                              \
8190         STRESS_MODE(COUNT)
8191
8192     enum                compStressArea
8193     {
8194 #define STRESS_MODE(mode) STRESS_##mode,
8195         STRESS_MODES
8196 #undef STRESS_MODE
8197     };
8198 // clang-format on
8199
8200 #ifdef DEBUG
8201     static const LPCWSTR s_compStressModeNames[STRESS_COUNT + 1];
8202     BYTE                 compActiveStressModes[STRESS_COUNT];
8203 #endif // DEBUG
8204
8205 #define MAX_STRESS_WEIGHT 100
8206
8207     bool compStressCompile(compStressArea stressArea, unsigned weightPercentage);
8208
8209 #ifdef DEBUG
8210
8211     bool compInlineStress()
8212     {
8213         return compStressCompile(STRESS_LEGACY_INLINE, 50);
8214     }
8215
8216     bool compRandomInlineStress()
8217     {
8218         return compStressCompile(STRESS_RANDOM_INLINE, 50);
8219     }
8220
8221 #endif // DEBUG
8222
8223     bool compTailCallStress()
8224     {
8225 #ifdef DEBUG
8226         return (JitConfig.TailcallStress() != 0 || compStressCompile(STRESS_TAILCALL, 5));
8227 #else
8228         return false;
8229 #endif
8230     }
8231
8232     codeOptimize compCodeOpt()
8233     {
8234 #if 0
8235         // Switching between size & speed has measurable throughput impact
8236         // (3.5% on NGen mscorlib when measured). It used to be enabled for
8237         // DEBUG, but should generate identical code between CHK & RET builds,
8238         // so that's not acceptable.
8239         // TODO-Throughput: Figure out what to do about size vs. speed & throughput.
8240         //                  Investigate the cause of the throughput regression.
8241
8242         return opts.compCodeOpt;
8243 #else
8244         return BLENDED_CODE;
8245 #endif
8246     }
8247
8248     //--------------------- Info about the procedure --------------------------
8249
8250     struct Info
8251     {
8252         COMP_HANDLE           compCompHnd;
8253         CORINFO_MODULE_HANDLE compScopeHnd;
8254         CORINFO_CLASS_HANDLE  compClassHnd;
8255         CORINFO_METHOD_HANDLE compMethodHnd;
8256         CORINFO_METHOD_INFO*  compMethodInfo;
8257
8258         BOOL hasCircularClassConstraints;
8259         BOOL hasCircularMethodConstraints;
8260
8261 #if defined(DEBUG) || defined(LATE_DISASM)
8262         const char* compMethodName;
8263         const char* compClassName;
8264         const char* compFullName;
8265 #endif // defined(DEBUG) || defined(LATE_DISASM)
8266
8267 #if defined(DEBUG) || defined(INLINE_DATA)
8268         // Method hash is logcally const, but computed
8269         // on first demand.
8270         mutable unsigned compMethodHashPrivate;
8271         unsigned         compMethodHash() const;
8272 #endif // defined(DEBUG) || defined(INLINE_DATA)
8273
8274 #ifdef PSEUDORANDOM_NOP_INSERTION
8275         // things for pseudorandom nop insertion
8276         unsigned  compChecksum;
8277         CLRRandom compRNG;
8278 #endif
8279
8280         // The following holds the FLG_xxxx flags for the method we're compiling.
8281         unsigned compFlags;
8282
8283         // The following holds the class attributes for the method we're compiling.
8284         unsigned compClassAttr;
8285
8286         const BYTE*    compCode;
8287         IL_OFFSET      compILCodeSize;     // The IL code size
8288         UNATIVE_OFFSET compNativeCodeSize; // The native code size, after instructions are issued. This
8289                                            // is less than (compTotalHotCodeSize + compTotalColdCodeSize) only if:
8290         // (1) the code is not hot/cold split, and we issued less code than we expected, or
8291         // (2) the code is hot/cold split, and we issued less code than we expected
8292         // in the cold section (the hot section will always be padded out to compTotalHotCodeSize).
8293
8294         bool compIsStatic : 1;         // Is the method static (no 'this' pointer)?
8295         bool compIsVarArgs : 1;        // Does the method have varargs parameters?
8296         bool compIsContextful : 1;     // contextful method
8297         bool compInitMem : 1;          // Is the CORINFO_OPT_INIT_LOCALS bit set in the method info options?
8298         bool compUnwrapContextful : 1; // JIT should unwrap proxies when possible
8299         bool compProfilerCallback : 1; // JIT inserted a profiler Enter callback
8300         bool compPublishStubParam : 1; // EAX captured in prolog will be available through an instrinsic
8301         bool compRetBuffDefStack : 1;  // The ret buff argument definitely points into the stack.
8302
8303         var_types compRetType;       // Return type of the method as declared in IL
8304         var_types compRetNativeType; // Normalized return type as per target arch ABI
8305         unsigned  compILargsCount;   // Number of arguments (incl. implicit but not hidden)
8306         unsigned  compArgsCount;     // Number of arguments (incl. implicit and     hidden)
8307
8308 #if FEATURE_FASTTAILCALL
8309         unsigned compArgRegCount;      // Number of incoming integer argument registers used for incoming arguments
8310         unsigned compFloatArgRegCount; // Number of incoming floating argument registers used for incoming arguments
8311         size_t   compArgStackSize;     // Incoming argument stack size in bytes
8312 #endif                                 // FEATURE_FASTTAILCALL
8313
8314         unsigned compRetBuffArg; // position of hidden return param var (0, 1) (BAD_VAR_NUM means not present);
8315         int compTypeCtxtArg; // position of hidden param for type context for generic code (CORINFO_CALLCONV_PARAMTYPE)
8316         unsigned       compThisArg; // position of implicit this pointer param (not to be confused with lvaArg0Var)
8317         unsigned       compILlocalsCount; // Number of vars : args + locals (incl. implicit but not hidden)
8318         unsigned       compLocalsCount;   // Number of vars : args + locals (incl. implicit and     hidden)
8319         unsigned       compMaxStack;
8320         UNATIVE_OFFSET compTotalHotCodeSize;  // Total number of bytes of Hot Code in the method
8321         UNATIVE_OFFSET compTotalColdCodeSize; // Total number of bytes of Cold Code in the method
8322
8323         unsigned compCallUnmanaged;   // count of unmanaged calls
8324         unsigned compLvFrameListRoot; // lclNum for the Frame root
8325         unsigned compXcptnsCount;     // Number of exception-handling clauses read in the method's IL.
8326                                       // You should generally use compHndBBtabCount instead: it is the
8327                                       // current number of EH clauses (after additions like synchronized
8328                                       // methods and funclets, and removals like unreachable code deletion).
8329
8330         bool compMatchedVM; // true if the VM is "matched": either the JIT is a cross-compiler
8331                             // and the VM expects that, or the JIT is a "self-host" compiler
8332                             // (e.g., x86 hosted targeting x86) and the VM expects that.
8333
8334         /*  The following holds IL scope information about local variables.
8335          */
8336
8337         unsigned     compVarScopesCount;
8338         VarScopeDsc* compVarScopes;
8339
8340         /* The following holds information about instr offsets for
8341          * which we need to report IP-mappings
8342          */
8343
8344         IL_OFFSET*                   compStmtOffsets; // sorted
8345         unsigned                     compStmtOffsetsCount;
8346         ICorDebugInfo::BoundaryTypes compStmtOffsetsImplicit;
8347
8348 #define CPU_X86 0x0100 // The generic X86 CPU
8349 #define CPU_X86_PENTIUM_4 0x0110
8350
8351 #define CPU_X64 0x0200       // The generic x64 CPU
8352 #define CPU_AMD_X64 0x0210   // AMD x64 CPU
8353 #define CPU_INTEL_X64 0x0240 // Intel x64 CPU
8354
8355 #define CPU_ARM 0x0300 // The generic ARM CPU
8356
8357         unsigned genCPU; // What CPU are we running on
8358     } info;
8359
8360     // Returns true if the method being compiled returns a non-void and non-struct value.
8361     // Note that lvaInitTypeRef() normalizes compRetNativeType for struct returns in a
8362     // single register as per target arch ABI (e.g on Amd64 Windows structs of size 1, 2,
8363     // 4 or 8 gets normalized to TYP_BYTE/TYP_SHORT/TYP_INT/TYP_LONG; On Arm HFA structs).
8364     // Methods returning such structs are considered to return non-struct return value and
8365     // this method returns true in that case.
8366     bool compMethodReturnsNativeScalarType()
8367     {
8368         return (info.compRetType != TYP_VOID) && !varTypeIsStruct(info.compRetNativeType);
8369     }
8370
8371     // Returns true if the method being compiled returns RetBuf addr as its return value
8372     bool compMethodReturnsRetBufAddr()
8373     {
8374         // There are cases where implicit RetBuf argument should be explicitly returned in a register.
8375         // In such cases the return type is changed to TYP_BYREF and appropriate IR is generated.
8376         // These cases are:
8377         // 1. Profiler Leave calllback expects the address of retbuf as return value for
8378         //    methods with hidden RetBuf argument.  impReturnInstruction() when profiler
8379         //    callbacks are needed creates GT_RETURN(TYP_BYREF, op1 = Addr of RetBuf) for
8380         //    methods with hidden RetBufArg.
8381         //
8382         // 2. As per the System V ABI, the address of RetBuf needs to be returned by
8383         //    methods with hidden RetBufArg in RAX. In such case GT_RETURN is of TYP_BYREF,
8384         //    returning the address of RetBuf.
8385         //
8386         // 3. Windows 64-bit native calling convention also requires the address of RetBuff
8387         //    to be returned in RAX.
8388         CLANG_FORMAT_COMMENT_ANCHOR;
8389
8390 #ifdef _TARGET_AMD64_
8391         return (info.compRetBuffArg != BAD_VAR_NUM);
8392 #else  // !_TARGET_AMD64_
8393         return (compIsProfilerHookNeeded()) && (info.compRetBuffArg != BAD_VAR_NUM);
8394 #endif // !_TARGET_AMD64_
8395     }
8396
8397     // Returns true if the method returns a value in more than one return register
8398     // TODO-ARM-Bug: Deal with multi-register genReturnLocaled structs?
8399     // TODO-ARM64: Does this apply for ARM64 too?
8400     bool compMethodReturnsMultiRegRetType()
8401     {
8402 #if FEATURE_MULTIREG_RET
8403 #if defined(_TARGET_X86_)
8404         // On x86 only 64-bit longs are returned in multiple registers
8405         return varTypeIsLong(info.compRetNativeType);
8406 #else  // targets: X64-UNIX, ARM64 or ARM32
8407         // On all other targets that support multireg return values:
8408         // Methods returning a struct in multiple registers have a return value of TYP_STRUCT.
8409         // Such method's compRetNativeType is TYP_STRUCT without a hidden RetBufArg
8410         return varTypeIsStruct(info.compRetNativeType) && (info.compRetBuffArg == BAD_VAR_NUM);
8411 #endif // TARGET_XXX
8412
8413 #else // not FEATURE_MULTIREG_RET
8414
8415         // For this architecture there are no multireg returns
8416         return false;
8417
8418 #endif // FEATURE_MULTIREG_RET
8419     }
8420
8421 #if FEATURE_MULTIREG_ARGS
8422     // Given a GenTree node of TYP_STRUCT that represents a pass by value argument
8423     // return the gcPtr layout for the pointers sized fields
8424     void getStructGcPtrsFromOp(GenTreePtr op, BYTE* gcPtrsOut);
8425 #endif // FEATURE_MULTIREG_ARGS
8426
8427     // Returns true if the method being compiled returns a value
8428     bool compMethodHasRetVal()
8429     {
8430         return compMethodReturnsNativeScalarType() || compMethodReturnsRetBufAddr() ||
8431                compMethodReturnsMultiRegRetType();
8432     }
8433
8434 #if defined(DEBUG)
8435
8436     void compDispLocalVars();
8437
8438 #endif // DEBUG
8439
8440 //-------------------------- Global Compiler Data ------------------------------------
8441
8442 #ifdef DEBUG
8443     static unsigned s_compMethodsCount; // to produce unique label names
8444     unsigned        compGenTreeID;
8445     unsigned        compBasicBlockID;
8446 #endif
8447
8448     BasicBlock* compCurBB;   // the current basic block in process
8449     GenTreePtr  compCurStmt; // the current statement in process
8450 #ifdef DEBUG
8451     unsigned compCurStmtNum; // to give all statements an increasing StmtNum when printing dumps
8452 #endif
8453
8454     //  The following is used to create the 'method JIT info' block.
8455     size_t compInfoBlkSize;
8456     BYTE*  compInfoBlkAddr;
8457
8458     EHblkDsc* compHndBBtab;           // array of EH data
8459     unsigned  compHndBBtabCount;      // element count of used elements in EH data array
8460     unsigned  compHndBBtabAllocCount; // element count of allocated elements in EH data array
8461
8462 #if defined(_TARGET_X86_)
8463
8464     //-------------------------------------------------------------------------
8465     //  Tracking of region covered by the monitor in synchronized methods
8466     void* syncStartEmitCookie; // the emitter cookie for first instruction after the call to MON_ENTER
8467     void* syncEndEmitCookie;   // the emitter cookie for first instruction after the call to MON_EXIT
8468
8469 #endif // !_TARGET_X86_
8470
8471     Phases previousCompletedPhase; // the most recently completed phase
8472
8473     //-------------------------------------------------------------------------
8474     //  The following keeps track of how many bytes of local frame space we've
8475     //  grabbed so far in the current function, and how many argument bytes we
8476     //  need to pop when we return.
8477     //
8478
8479     unsigned compLclFrameSize; // secObject+lclBlk+locals+temps
8480
8481     // Count of callee-saved regs we pushed in the prolog.
8482     // Does not include EBP for isFramePointerUsed() and double-aligned frames.
8483     // In case of Amd64 this doesn't include float regs saved on stack.
8484     unsigned compCalleeRegsPushed;
8485
8486 #if defined(_TARGET_XARCH_) && !FEATURE_STACK_FP_X87
8487     // Mask of callee saved float regs on stack.
8488     regMaskTP compCalleeFPRegsSavedMask;
8489 #endif
8490 #ifdef _TARGET_AMD64_
8491 // Quirk for VS debug-launch scenario to work:
8492 // Bytes of padding between save-reg area and locals.
8493 #define VSQUIRK_STACK_PAD (2 * REGSIZE_BYTES)
8494     unsigned compVSQuirkStackPaddingNeeded;
8495     bool     compQuirkForPPPflag;
8496 #endif
8497
8498     unsigned compArgSize; // total size of arguments in bytes (including register args (lvIsRegArg))
8499
8500     unsigned compMapILargNum(unsigned ILargNum); // map accounting for hidden args
8501     unsigned compMapILvarNum(unsigned ILvarNum); // map accounting for hidden args
8502     unsigned compMap2ILvarNum(unsigned varNum);  // map accounting for hidden args
8503
8504     //-------------------------------------------------------------------------
8505
8506     static void compStartup();  // One-time initialization
8507     static void compShutdown(); // One-time finalization
8508
8509     void compInit(ArenaAllocator* pAlloc, InlineInfo* inlineInfo);
8510     void compDone();
8511
8512     static void compDisplayStaticSizes(FILE* fout);
8513
8514     //------------ Some utility functions --------------
8515
8516     void* compGetHelperFtn(CorInfoHelpFunc ftnNum,         /* IN  */
8517                            void**          ppIndirection); /* OUT */
8518
8519     // Several JIT/EE interface functions return a CorInfoType, and also return a
8520     // class handle as an out parameter if the type is a value class.  Returns the
8521     // size of the type these describe.
8522     unsigned compGetTypeSize(CorInfoType cit, CORINFO_CLASS_HANDLE clsHnd);
8523
8524 #ifdef DEBUG
8525     // Components used by the compiler may write unit test suites, and
8526     // have them run within this method.  They will be run only once per process, and only
8527     // in debug.  (Perhaps should be under the control of a COMPlus_ flag.)
8528     // These should fail by asserting.
8529     void compDoComponentUnitTestsOnce();
8530 #endif // DEBUG
8531
8532     int compCompile(CORINFO_METHOD_HANDLE methodHnd,
8533                     CORINFO_MODULE_HANDLE classPtr,
8534                     COMP_HANDLE           compHnd,
8535                     CORINFO_METHOD_INFO*  methodInfo,
8536                     void**                methodCodePtr,
8537                     ULONG*                methodCodeSize,
8538                     JitFlags*             compileFlags);
8539     void compCompileFinish();
8540     int compCompileHelper(CORINFO_MODULE_HANDLE            classPtr,
8541                           COMP_HANDLE                      compHnd,
8542                           CORINFO_METHOD_INFO*             methodInfo,
8543                           void**                           methodCodePtr,
8544                           ULONG*                           methodCodeSize,
8545                           JitFlags*                        compileFlags,
8546                           CorInfoInstantiationVerification instVerInfo);
8547
8548     ArenaAllocator* compGetAllocator();
8549
8550 #if MEASURE_MEM_ALLOC
8551
8552     static bool s_dspMemStats; // Display per-phase memory statistics for every function
8553
8554     struct MemStats
8555     {
8556         unsigned allocCnt;                 // # of allocs
8557         UINT64   allocSz;                  // total size of those alloc.
8558         UINT64   allocSzMax;               // Maximum single allocation.
8559         UINT64   allocSzByKind[CMK_Count]; // Classified by "kind".
8560         UINT64   nraTotalSizeAlloc;
8561         UINT64   nraTotalSizeUsed;
8562
8563         static const char* s_CompMemKindNames[]; // Names of the kinds.
8564
8565         MemStats() : allocCnt(0), allocSz(0), allocSzMax(0), nraTotalSizeAlloc(0), nraTotalSizeUsed(0)
8566         {
8567             for (int i = 0; i < CMK_Count; i++)
8568             {
8569                 allocSzByKind[i] = 0;
8570             }
8571         }
8572         MemStats(const MemStats& ms)
8573             : allocCnt(ms.allocCnt)
8574             , allocSz(ms.allocSz)
8575             , allocSzMax(ms.allocSzMax)
8576             , nraTotalSizeAlloc(ms.nraTotalSizeAlloc)
8577             , nraTotalSizeUsed(ms.nraTotalSizeUsed)
8578         {
8579             for (int i = 0; i < CMK_Count; i++)
8580             {
8581                 allocSzByKind[i] = ms.allocSzByKind[i];
8582             }
8583         }
8584
8585         // Until we have ubiquitous constructors.
8586         void Init()
8587         {
8588             this->MemStats::MemStats();
8589         }
8590
8591         void AddAlloc(size_t sz, CompMemKind cmk)
8592         {
8593             allocCnt += 1;
8594             allocSz += sz;
8595             if (sz > allocSzMax)
8596             {
8597                 allocSzMax = sz;
8598             }
8599             allocSzByKind[cmk] += sz;
8600         }
8601
8602         void Print(FILE* f);       // Print these stats to f.
8603         void PrintByKind(FILE* f); // Do just the by-kind histogram part.
8604     };
8605     MemStats genMemStats;
8606
8607     struct AggregateMemStats : public MemStats
8608     {
8609         unsigned nMethods;
8610
8611         AggregateMemStats() : MemStats(), nMethods(0)
8612         {
8613         }
8614
8615         void Add(const MemStats& ms)
8616         {
8617             nMethods++;
8618             allocCnt += ms.allocCnt;
8619             allocSz += ms.allocSz;
8620             allocSzMax = max(allocSzMax, ms.allocSzMax);
8621             for (int i = 0; i < CMK_Count; i++)
8622             {
8623                 allocSzByKind[i] += ms.allocSzByKind[i];
8624             }
8625             nraTotalSizeAlloc += ms.nraTotalSizeAlloc;
8626             nraTotalSizeUsed += ms.nraTotalSizeUsed;
8627         }
8628
8629         void Print(FILE* f); // Print these stats to jitstdout.
8630     };
8631
8632     static CritSecObject     s_memStatsLock;    // This lock protects the data structures below.
8633     static MemStats          s_maxCompMemStats; // Stats for the compilation with the largest amount allocated.
8634     static AggregateMemStats s_aggMemStats;     // Aggregates statistics for all compilations.
8635
8636 #endif // MEASURE_MEM_ALLOC
8637
8638 #if LOOP_HOIST_STATS
8639     unsigned m_loopsConsidered;
8640     bool     m_curLoopHasHoistedExpression;
8641     unsigned m_loopsWithHoistedExpressions;
8642     unsigned m_totalHoistedExpressions;
8643
8644     void AddLoopHoistStats();
8645     void PrintPerMethodLoopHoistStats();
8646
8647     static CritSecObject s_loopHoistStatsLock; // This lock protects the data structures below.
8648     static unsigned      s_loopsConsidered;
8649     static unsigned      s_loopsWithHoistedExpressions;
8650     static unsigned      s_totalHoistedExpressions;
8651
8652     static void PrintAggregateLoopHoistStats(FILE* f);
8653 #endif // LOOP_HOIST_STATS
8654
8655     void* compGetMemArray(size_t numElem, size_t elemSize, CompMemKind cmk = CMK_Unknown);
8656     void* compGetMemArrayA(size_t numElem, size_t elemSize, CompMemKind cmk = CMK_Unknown);
8657     void* compGetMem(size_t sz, CompMemKind cmk = CMK_Unknown);
8658     void* compGetMemA(size_t sz, CompMemKind cmk = CMK_Unknown);
8659     static void* compGetMemCallback(void*, size_t, CompMemKind cmk = CMK_Unknown);
8660     void compFreeMem(void*);
8661
8662     bool compIsForImportOnly();
8663     bool compIsForInlining();
8664     bool compDonotInline();
8665
8666 #ifdef DEBUG
8667     const char* compLocalVarName(unsigned varNum, unsigned offs);
8668     VarName compVarName(regNumber reg, bool isFloatReg = false);
8669     const char* compRegVarName(regNumber reg, bool displayVar = false, bool isFloatReg = false);
8670     const char* compRegPairName(regPairNo regPair);
8671     const char* compRegNameForSize(regNumber reg, size_t size);
8672     const char* compFPregVarName(unsigned fpReg, bool displayVar = false);
8673     void compDspSrcLinesByNativeIP(UNATIVE_OFFSET curIP);
8674     void compDspSrcLinesByLineNum(unsigned line, bool seek = false);
8675 #endif // DEBUG
8676
8677     //-------------------------------------------------------------------------
8678
8679     typedef ListNode<VarScopeDsc*> VarScopeListNode;
8680
8681     struct VarScopeMapInfo
8682     {
8683         VarScopeListNode*       head;
8684         VarScopeListNode*       tail;
8685         static VarScopeMapInfo* Create(VarScopeListNode* node, IAllocator* alloc)
8686         {
8687             VarScopeMapInfo* info = new (alloc) VarScopeMapInfo;
8688             info->head            = node;
8689             info->tail            = node;
8690             return info;
8691         }
8692     };
8693
8694     // Max value of scope count for which we would use linear search; for larger values we would use hashtable lookup.
8695     static const unsigned MAX_LINEAR_FIND_LCL_SCOPELIST = 32;
8696
8697     typedef SimplerHashTable<unsigned, SmallPrimitiveKeyFuncs<unsigned>, VarScopeMapInfo*, JitSimplerHashBehavior>
8698         VarNumToScopeDscMap;
8699
8700     // Map to keep variables' scope indexed by varNum containing it's scope dscs at the index.
8701     VarNumToScopeDscMap* compVarScopeMap;
8702
8703     VarScopeDsc* compFindLocalVar(unsigned varNum, unsigned lifeBeg, unsigned lifeEnd);
8704
8705     VarScopeDsc* compFindLocalVar(unsigned varNum, unsigned offs);
8706
8707     VarScopeDsc* compFindLocalVarLinear(unsigned varNum, unsigned offs);
8708
8709     void compInitVarScopeMap();
8710
8711     VarScopeDsc** compEnterScopeList; // List has the offsets where variables
8712                                       // enter scope, sorted by instr offset
8713     unsigned compNextEnterScope;
8714
8715     VarScopeDsc** compExitScopeList; // List has the offsets where variables
8716                                      // go out of scope, sorted by instr offset
8717     unsigned compNextExitScope;
8718
8719     void compInitScopeLists();
8720
8721     void compResetScopeLists();
8722
8723     VarScopeDsc* compGetNextEnterScope(unsigned offs, bool scan = false);
8724
8725     VarScopeDsc* compGetNextExitScope(unsigned offs, bool scan = false);
8726
8727     void compProcessScopesUntil(unsigned   offset,
8728                                 VARSET_TP* inScope,
8729                                 void (Compiler::*enterScopeFn)(VARSET_TP* inScope, VarScopeDsc*),
8730                                 void (Compiler::*exitScopeFn)(VARSET_TP* inScope, VarScopeDsc*));
8731
8732 #ifdef DEBUG
8733     void compDispScopeLists();
8734 #endif // DEBUG
8735
8736     bool compIsProfilerHookNeeded();
8737
8738     //-------------------------------------------------------------------------
8739     /*               Statistical Data Gathering                               */
8740
8741     void compJitStats(); // call this function and enable
8742                          // various ifdef's below for statistical data
8743
8744 #if CALL_ARG_STATS
8745     void        compCallArgStats();
8746     static void compDispCallArgStats(FILE* fout);
8747 #endif
8748
8749     //-------------------------------------------------------------------------
8750
8751 protected:
8752 #ifdef DEBUG
8753     bool skipMethod();
8754 #endif
8755
8756     ArenaAllocator* compAllocator;
8757
8758 public:
8759     // This one presents an implementation of the "IAllocator" abstract class that uses "compAllocator",
8760     // suitable for use by utilcode collection types.
8761     IAllocator* compAsIAllocator;
8762
8763 #if MEASURE_MEM_ALLOC
8764     IAllocator* compAsIAllocatorBitset;    // An allocator that uses the CMK_bitset tracker.
8765     IAllocator* compAsIAllocatorGC;        // An allocator that uses the CMK_GC tracker.
8766     IAllocator* compAsIAllocatorLoopHoist; // An allocator that uses the CMK_LoopHoist tracker.
8767 #ifdef DEBUG
8768     IAllocator* compAsIAllocatorDebugOnly; // An allocator that uses the CMK_DebugOnly tracker.
8769 #endif                                     // DEBUG
8770 #endif                                     // MEASURE_MEM_ALLOC
8771
8772     void compFunctionTraceStart();
8773     void compFunctionTraceEnd(void* methodCodePtr, ULONG methodCodeSize, bool isNYI);
8774
8775 protected:
8776     size_t compMaxUncheckedOffsetForNullObject;
8777
8778     void compInitOptions(JitFlags* compileFlags);
8779
8780     void compSetProcessor();
8781     void compInitDebuggingInfo();
8782     void compSetOptimizationLevel();
8783 #ifdef _TARGET_ARMARCH_
8784     bool compRsvdRegCheck(FrameLayoutState curState);
8785 #endif
8786     void compCompile(void** methodCodePtr, ULONG* methodCodeSize, JitFlags* compileFlags);
8787
8788     // Clear annotations produced during optimizations; to be used between iterations when repeating opts.
8789     void ResetOptAnnotations();
8790
8791     // Regenerate loop descriptors; to be used between iterations when repeating opts.
8792     void RecomputeLoopInfo();
8793
8794 #ifdef PROFILING_SUPPORTED
8795     // Data required for generating profiler Enter/Leave/TailCall hooks
8796
8797     bool  compProfilerHookNeeded; // Whether profiler Enter/Leave/TailCall hook needs to be generated for the method
8798     void* compProfilerMethHnd;    // Profiler handle of the method being compiled. Passed as param to ELT callbacks
8799     bool  compProfilerMethHndIndirected; // Whether compProfilerHandle is pointer to the handle or is an actual handle
8800 #endif
8801
8802 #ifdef _TARGET_AMD64_
8803     bool compQuirkForPPP(); // Check if this method should be Quirked for the PPP issue
8804 #endif
8805 public:
8806     // Assumes called as part of process shutdown; does any compiler-specific work associated with that.
8807     static void ProcessShutdownWork(ICorStaticInfo* statInfo);
8808
8809     IAllocator* getAllocator()
8810     {
8811         return compAsIAllocator;
8812     }
8813
8814 #if MEASURE_MEM_ALLOC
8815     IAllocator* getAllocatorBitset()
8816     {
8817         return compAsIAllocatorBitset;
8818     }
8819     IAllocator* getAllocatorGC()
8820     {
8821         return compAsIAllocatorGC;
8822     }
8823     IAllocator* getAllocatorLoopHoist()
8824     {
8825         return compAsIAllocatorLoopHoist;
8826     }
8827 #else  // !MEASURE_MEM_ALLOC
8828     IAllocator* getAllocatorBitset()
8829     {
8830         return compAsIAllocator;
8831     }
8832     IAllocator* getAllocatorGC()
8833     {
8834         return compAsIAllocator;
8835     }
8836     IAllocator* getAllocatorLoopHoist()
8837     {
8838         return compAsIAllocator;
8839     }
8840 #endif // !MEASURE_MEM_ALLOC
8841
8842 #ifdef DEBUG
8843     IAllocator* getAllocatorDebugOnly()
8844     {
8845 #if MEASURE_MEM_ALLOC
8846         return compAsIAllocatorDebugOnly;
8847 #else  // !MEASURE_MEM_ALLOC
8848         return compAsIAllocator;
8849 #endif // !MEASURE_MEM_ALLOC
8850     }
8851 #endif // DEBUG
8852
8853     /*
8854     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8855     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8856     XX                                                                           XX
8857     XX                           typeInfo                                        XX
8858     XX                                                                           XX
8859     XX   Checks for type compatibility and merges types                          XX
8860     XX                                                                           XX
8861     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8862     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8863     */
8864
8865 public:
8866     // Set to TRUE if verification cannot be skipped for this method
8867     // If we detect unverifiable code, we will lazily check
8868     // canSkipMethodVerification() to see if verification is REALLY needed.
8869     BOOL tiVerificationNeeded;
8870
8871     // It it initially TRUE, and it gets set to FALSE if we run into unverifiable code
8872     // Note that this is valid only if tiVerificationNeeded was ever TRUE.
8873     BOOL tiIsVerifiableCode;
8874
8875     // Set to TRUE if runtime callout is needed for this method
8876     BOOL tiRuntimeCalloutNeeded;
8877
8878     // Set to TRUE if security prolog/epilog callout is needed for this method
8879     // Note: This flag is different than compNeedSecurityCheck.
8880     //     compNeedSecurityCheck means whether or not a security object needs
8881     //         to be allocated on the stack, which is currently true for EnC as well.
8882     //     tiSecurityCalloutNeeded means whether or not security callouts need
8883     //         to be inserted in the jitted code.
8884     BOOL tiSecurityCalloutNeeded;
8885
8886     // Returns TRUE if child is equal to or a subtype of parent for merge purposes
8887     // This support is necessary to suport attributes that are not described in
8888     // for example, signatures. For example, the permanent home byref (byref that
8889     // points to the gc heap), isn't a property of method signatures, therefore,
8890     // it is safe to have mismatches here (that tiCompatibleWith will not flag),
8891     // but when deciding if we need to reimport a block, we need to take these
8892     // in account
8893     BOOL tiMergeCompatibleWith(const typeInfo& pChild, const typeInfo& pParent, bool normalisedForStack) const;
8894
8895     // Returns TRUE if child is equal to or a subtype of parent.
8896     // normalisedForStack indicates that both types are normalised for the stack
8897     BOOL tiCompatibleWith(const typeInfo& pChild, const typeInfo& pParent, bool normalisedForStack) const;
8898
8899     // Merges pDest and pSrc. Returns FALSE if merge is undefined.
8900     // *pDest is modified to represent the merged type.  Sets "*changed" to true
8901     // if this changes "*pDest".
8902     BOOL tiMergeToCommonParent(typeInfo* pDest, const typeInfo* pSrc, bool* changed) const;
8903
8904     // Set pDest from the primitive value type.
8905     // Eg. System.Int32 -> ELEMENT_TYPE_I4
8906
8907     BOOL tiFromPrimitiveValueClass(typeInfo* pDest, const typeInfo* pVC) const;
8908
8909 #ifdef DEBUG
8910     // <BUGNUM> VSW 471305
8911     // IJW allows assigning REF to BYREF. The following allows us to temporarily
8912     // bypass the assert check in gcMarkRegSetGCref and gcMarkRegSetByref
8913     // We use a "short" as we need to push/pop this scope.
8914     // </BUGNUM>
8915     short compRegSetCheckLevel;
8916 #endif
8917
8918     /*
8919     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8920     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8921     XX                                                                           XX
8922     XX                           IL verification stuff                           XX
8923     XX                                                                           XX
8924     XX                                                                           XX
8925     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8926     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8927     */
8928
8929 public:
8930     // The following is used to track liveness of local variables, initialization
8931     // of valueclass constructors, and type safe use of IL instructions.
8932
8933     // dynamic state info needed for verification
8934     EntryState verCurrentState;
8935
8936     // this ptr of object type .ctors are considered intited only after
8937     // the base class ctor is called, or an alternate ctor is called.
8938     // An uninited this ptr can be used to access fields, but cannot
8939     // be used to call a member function.
8940     BOOL verTrackObjCtorInitState;
8941
8942     void verInitBBEntryState(BasicBlock* block, EntryState* currentState);
8943
8944     // Requires that "tis" is not TIS_Bottom -- it's a definite init/uninit state.
8945     void verSetThisInit(BasicBlock* block, ThisInitState tis);
8946     void verInitCurrentState();
8947     void verResetCurrentState(BasicBlock* block, EntryState* currentState);
8948
8949     // Merges the current verification state into the entry state of "block", return FALSE if that merge fails,
8950     // TRUE if it succeeds.  Further sets "*changed" to true if this changes the entry state of "block".
8951     BOOL verMergeEntryStates(BasicBlock* block, bool* changed);
8952
8953     void verConvertBBToThrowVerificationException(BasicBlock* block DEBUGARG(bool logMsg));
8954     void verHandleVerificationFailure(BasicBlock* block DEBUGARG(bool logMsg));
8955     typeInfo verMakeTypeInfo(CORINFO_CLASS_HANDLE clsHnd,
8956                              bool bashStructToRef = false); // converts from jit type representation to typeInfo
8957     typeInfo verMakeTypeInfo(CorInfoType          ciType,
8958                              CORINFO_CLASS_HANDLE clsHnd); // converts from jit type representation to typeInfo
8959     BOOL verIsSDArray(typeInfo ti);
8960     typeInfo verGetArrayElemType(typeInfo ti);
8961
8962     typeInfo verParseArgSigToTypeInfo(CORINFO_SIG_INFO* sig, CORINFO_ARG_LIST_HANDLE args);
8963     BOOL verNeedsVerification();
8964     BOOL verIsByRefLike(const typeInfo& ti);
8965     BOOL verIsSafeToReturnByRef(const typeInfo& ti);
8966
8967     // generic type variables range over types that satisfy IsBoxable
8968     BOOL verIsBoxable(const typeInfo& ti);
8969
8970     void DECLSPEC_NORETURN verRaiseVerifyException(INDEBUG(const char* reason) DEBUGARG(const char* file)
8971                                                        DEBUGARG(unsigned line));
8972     void verRaiseVerifyExceptionIfNeeded(INDEBUG(const char* reason) DEBUGARG(const char* file)
8973                                              DEBUGARG(unsigned line));
8974     bool verCheckTailCallConstraint(OPCODE                  opcode,
8975                                     CORINFO_RESOLVED_TOKEN* pResolvedToken,
8976                                     CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken, // Is this a "constrained." call
8977                                                                                        // on a type parameter?
8978                                     bool speculative // If true, won't throw if verificatoin fails. Instead it will
8979                                                      // return false to the caller.
8980                                                      // If false, it will throw.
8981                                     );
8982     bool verIsBoxedValueType(typeInfo ti);
8983
8984     void verVerifyCall(OPCODE                  opcode,
8985                        CORINFO_RESOLVED_TOKEN* pResolvedToken,
8986                        CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken,
8987                        bool                    tailCall,
8988                        bool                    readonlyCall, // is this a "readonly." call?
8989                        const BYTE*             delegateCreateStart,
8990                        const BYTE*             codeAddr,
8991                        CORINFO_CALL_INFO* callInfo DEBUGARG(const char* methodName));
8992
8993     BOOL verCheckDelegateCreation(const BYTE* delegateCreateStart, const BYTE* codeAddr, mdMemberRef& targetMemberRef);
8994
8995     typeInfo verVerifySTIND(const typeInfo& ptr, const typeInfo& value, const typeInfo& instrType);
8996     typeInfo verVerifyLDIND(const typeInfo& ptr, const typeInfo& instrType);
8997     void verVerifyField(CORINFO_RESOLVED_TOKEN*   pResolvedToken,
8998                         const CORINFO_FIELD_INFO& fieldInfo,
8999                         const typeInfo*           tiThis,
9000                         BOOL                      mutator,
9001                         BOOL                      allowPlainStructAsThis = FALSE);
9002     void verVerifyCond(const typeInfo& tiOp1, const typeInfo& tiOp2, unsigned opcode);
9003     void verVerifyThisPtrInitialised();
9004     BOOL verIsCallToInitThisPtr(CORINFO_CLASS_HANDLE context, CORINFO_CLASS_HANDLE target);
9005
9006     // Register allocator
9007     void raInitStackFP();
9008     void raEnregisterVarsPrePassStackFP();
9009     void raSetRegLclBirthDeath(GenTreePtr tree, VARSET_VALARG_TP lastlife, bool fromLDOBJ);
9010     void raEnregisterVarsPostPassStackFP();
9011     void raGenerateFPRefCounts();
9012     void raEnregisterVarsStackFP();
9013     void raUpdateHeightsForVarsStackFP(VARSET_VALARG_TP mask);
9014
9015     regNumber raRegForVarStackFP(unsigned varTrackedIndex);
9016     void raAddPayloadStackFP(VARSET_VALARG_TP mask, unsigned weight);
9017
9018     // returns true if enregistering v1 would save more mem accesses than v2
9019     bool raVarIsGreaterValueStackFP(LclVarDsc* lv1, LclVarDsc* lv2);
9020
9021 #ifdef DEBUG
9022     void raDumpHeightsStackFP();
9023     void raDumpVariableRegIntfFloat();
9024 #endif
9025
9026 #if FEATURE_STACK_FP_X87
9027
9028     // Currently, we use FP transition blocks in only 2 situations:
9029     //
9030     //      -conditional jump on longs where FP stack differs with target: it's not strictly
9031     //       necessary, but its low frequency and the code would get complicated if we try to
9032     //       inline the FP stack adjustment, as we have a lot of special casing going on to try
9033     //       minimize the way we generate the jump code.
9034     //      -case statements of switch where the FP stack differs with the one of evaluating the switch () statement
9035     //       We do this as we want to codegen switch as a jumptable. Again, this is low frequency.
9036     //
9037     //      However, transition blocks have 2 problems
9038     //
9039     //          - Procedure splitting: current implementation of procedure splitting requires all basic blocks to
9040     //            be known at codegen time, as it generates all hot blocks first and cold blocks later. This ties
9041     //            us up in codegen and is a solvable problem (we could make procedure splitting generate blocks
9042     //            in the right place without preordering them), this causes us to have to generate the transition
9043     //            blocks in the cold area if we want procedure splitting.
9044     //
9045     //
9046     //          - Thread abort exceptions and transition blocks. Transition blocks were designed under the assumption
9047     //            that no exceptions can happen inside them. Unfortunately Thread.Abort can happen in any instruction,
9048     //            and if we have handlers we will have to try to call them. Fixing this the right way would imply
9049     //            having multiple try native code regions for a single try il region. This is doable and shouldnt be
9050     //            a big change in the exception.
9051     //
9052     //      Given the low frequency of the cases where we have transition blocks, I've decided to dumb down
9053     //      optimizations. For these 2 cases:
9054     //
9055     //          - When there is a chance that we will have FP transition blocks, we won't do procedure splitting.
9056     //          - When a method has a handler, it won't enregister any FP variables that go thru a conditional long or
9057     //          a switch statement.
9058     //
9059     //      If at any point we find we need to optimize this, we should throw work at unblocking the restrictions our
9060     //      current procedure splitting and exception code have.
9061     bool compMayHaveTransitionBlocks;
9062
9063     VARSET_TP raMaskDontEnregFloat; // mask for additional restrictions
9064
9065     VARSET_TP raLclRegIntfFloat[REG_FPCOUNT];
9066
9067     unsigned raCntStkStackFP;
9068     unsigned raCntWtdStkDblStackFP;
9069     unsigned raCntStkParamDblStackFP;
9070
9071     // Payload in mem accesses for enregistering a variable (we dont want to mix with refcounts)
9072     // TODO: Do we want to put this in LclVarDsc?
9073     unsigned raPayloadStackFP[lclMAX_TRACKED];
9074     unsigned raHeightsStackFP[lclMAX_TRACKED][FP_VIRTUALREGISTERS + 1];
9075 #ifdef DEBUG
9076     // Useful for debugging
9077     unsigned raHeightsNonWeightedStackFP[lclMAX_TRACKED][FP_VIRTUALREGISTERS + 1];
9078 #endif
9079 #endif // FEATURE_STACK_FP_X87
9080
9081 #ifdef DEBUG
9082     // One line log function. Default level is 0. Increasing it gives you
9083     // more log information
9084
9085     // levels are currently unused: #define JITDUMP(level,...)                     ();
9086     void JitLogEE(unsigned level, const char* fmt, ...);
9087
9088     bool compDebugBreak;
9089
9090     bool compJitHaltMethod();
9091
9092 #endif
9093
9094     /*
9095     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9096     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9097     XX                                                                           XX
9098     XX                   GS Security checks for unsafe buffers                   XX
9099     XX                                                                           XX
9100     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9101     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9102     */
9103 public:
9104     struct ShadowParamVarInfo
9105     {
9106         FixedBitVect* assignGroup; // the closure set of variables whose values depend on each other
9107         unsigned      shadowCopy;  // Lcl var num, valid only if not set to NO_SHADOW_COPY
9108
9109         static bool mayNeedShadowCopy(LclVarDsc* varDsc)
9110         {
9111 #if defined(_TARGET_AMD64_) && !defined(LEGACY_BACKEND)
9112             // GS cookie logic to create shadow slots, create trees to copy reg args to shadow
9113             // slots and update all trees to refer to shadow slots is done immediately after
9114             // fgMorph().  Lsra could potentially mark a param as DoNotEnregister after JIT determines
9115             // not to shadow a parameter.  Also, LSRA could potentially spill a param which is passed
9116             // in register. Therefore, conservatively all params may need a shadow copy.  Note that
9117             // GS cookie logic further checks whether the param is a ptr or an unsafe buffer before
9118             // creating a shadow slot even though this routine returns true.
9119             //
9120             // TODO-AMD64-CQ: Revisit this conservative approach as it could create more shadow slots than
9121             // required. There are two cases under which a reg arg could potentially be used from its
9122             // home location:
9123             //   a) LSRA marks it as DoNotEnregister (see LinearScan::identifyCandidates())
9124             //   b) LSRA spills it
9125             //
9126             // Possible solution to address case (a)
9127             //   - The conditions under which LSRA marks a varDsc as DoNotEnregister could be checked
9128             //     in this routine.  Note that live out of exception handler is something we may not be
9129             //     able to do it here since GS cookie logic is invoked ahead of liveness computation.
9130             //     Therefore, for methods with exception handling and need GS cookie check we might have
9131             //     to take conservative approach.
9132             //
9133             // Possible solution to address case (b)
9134             //   - Whenver a parameter passed in an argument register needs to be spilled by LSRA, we
9135             //     create a new spill temp if the method needs GS cookie check.
9136             return varDsc->lvIsParam;
9137 #else // !(defined(_TARGET_AMD64_) && defined(LEGACY_BACKEND))
9138             return varDsc->lvIsParam && !varDsc->lvIsRegArg;
9139 #endif
9140         }
9141
9142 #ifdef DEBUG
9143         void Print()
9144         {
9145             printf("assignGroup [%p]; shadowCopy: [%d];\n", assignGroup, shadowCopy);
9146         }
9147 #endif
9148     };
9149
9150     GSCookie*           gsGlobalSecurityCookieAddr; // Address of global cookie for unsafe buffer checks
9151     GSCookie            gsGlobalSecurityCookieVal;  // Value of global cookie if addr is NULL
9152     ShadowParamVarInfo* gsShadowVarInfo;            // Table used by shadow param analysis code
9153
9154     void gsGSChecksInitCookie();   // Grabs cookie variable
9155     void gsCopyShadowParams();     // Identify vulnerable params and create dhadow copies
9156     bool gsFindVulnerableParams(); // Shadow param analysis code
9157     void gsParamsToShadows();      // Insert copy code and replave param uses by shadow
9158
9159     static fgWalkPreFn gsMarkPtrsAndAssignGroups; // Shadow param analysis tree-walk
9160     static fgWalkPreFn gsReplaceShadowParams;     // Shadow param replacement tree-walk
9161
9162 #define DEFAULT_MAX_INLINE_SIZE 100 // Methods with >  DEFAULT_MAX_INLINE_SIZE IL bytes will never be inlined.
9163                                     // This can be overwritten by setting complus_JITInlineSize env variable.
9164
9165 #define DEFAULT_MAX_INLINE_DEPTH 20 // Methods at more than this level deep will not be inlined
9166
9167 private:
9168 #ifdef FEATURE_JIT_METHOD_PERF
9169     JitTimer*                  pCompJitTimer;         // Timer data structure (by phases) for current compilation.
9170     static CompTimeSummaryInfo s_compJitTimerSummary; // Summary of the Timer information for the whole run.
9171
9172     static LPCWSTR JitTimeLogCsv();        // Retrieve the file name for CSV from ConfigDWORD.
9173     static LPCWSTR compJitTimeLogFilename; // If a log file for JIT time is desired, filename to write it to.
9174 #endif
9175     inline void EndPhase(Phases phase); // Indicate the end of the given phase.
9176
9177 #if MEASURE_CLRAPI_CALLS
9178     // Thin wrappers that call into JitTimer (if present).
9179     inline void CLRApiCallEnter(unsigned apix);
9180     inline void CLRApiCallLeave(unsigned apix);
9181
9182 public:
9183     inline void CLR_API_Enter(API_ICorJitInfo_Names ename);
9184     inline void CLR_API_Leave(API_ICorJitInfo_Names ename);
9185
9186 private:
9187 #endif
9188
9189 #if defined(DEBUG) || defined(INLINE_DATA) || defined(FEATURE_CLRSQM)
9190     // These variables are associated with maintaining SQM data about compile time.
9191     unsigned __int64 m_compCyclesAtEndOfInlining; // The thread-virtualized cycle count at the end of the inlining phase
9192                                                   // in the current compilation.
9193     unsigned __int64 m_compCycles;                // Net cycle count for current compilation
9194     DWORD m_compTickCountAtEndOfInlining; // The result of GetTickCount() (# ms since some epoch marker) at the end of
9195                                           // the inlining phase in the current compilation.
9196 #endif                                    // defined(DEBUG) || defined(INLINE_DATA) || defined(FEATURE_CLRSQM)
9197
9198     // Records the SQM-relevant (cycles and tick count).  Should be called after inlining is complete.
9199     // (We do this after inlining because this marks the last point at which the JIT is likely to cause
9200     // type-loading and class initialization).
9201     void RecordStateAtEndOfInlining();
9202     // Assumes being called at the end of compilation.  Update the SQM state.
9203     void RecordStateAtEndOfCompilation();
9204
9205 #ifdef FEATURE_CLRSQM
9206     // Does anything SQM related necessary at process shutdown time.
9207     static void ProcessShutdownSQMWork(ICorStaticInfo* statInfo);
9208 #endif // FEATURE_CLRSQM
9209
9210 public:
9211 #if FUNC_INFO_LOGGING
9212     static LPCWSTR compJitFuncInfoFilename; // If a log file for per-function information is required, this is the
9213                                             // filename to write it to.
9214     static FILE* compJitFuncInfoFile;       // And this is the actual FILE* to write to.
9215 #endif                                      // FUNC_INFO_LOGGING
9216
9217     Compiler* prevCompiler; // Previous compiler on stack for TLS Compiler* linked list for reentrant compilers.
9218
9219     // Is the compilation in a full trust context?
9220     bool compIsFullTrust();
9221
9222 #if MEASURE_NOWAY
9223     void RecordNowayAssert(const char* filename, unsigned line, const char* condStr);
9224 #endif // MEASURE_NOWAY
9225
9226 #ifndef FEATURE_TRACELOGGING
9227     // Should we actually fire the noway assert body and the exception handler?
9228     bool compShouldThrowOnNoway();
9229 #else  // FEATURE_TRACELOGGING
9230     // Should we actually fire the noway assert body and the exception handler?
9231     bool compShouldThrowOnNoway(const char* filename, unsigned line);
9232
9233     // Telemetry instance to use per method compilation.
9234     JitTelemetry compJitTelemetry;
9235
9236     // Get common parameters that have to be logged with most telemetry data.
9237     void compGetTelemetryDefaults(const char** assemblyName,
9238                                   const char** scopeName,
9239                                   const char** methodName,
9240                                   unsigned*    methodHash);
9241 #endif // !FEATURE_TRACELOGGING
9242
9243 #ifdef DEBUG
9244 private:
9245     NodeToTestDataMap* m_nodeTestData;
9246
9247     static const unsigned FIRST_LOOP_HOIST_CSE_CLASS = 1000;
9248     unsigned              m_loopHoistCSEClass; // LoopHoist test annotations turn into CSE requirements; we
9249                                                // label them with CSE Class #'s starting at FIRST_LOOP_HOIST_CSE_CLASS.
9250                                                // Current kept in this.
9251 public:
9252     NodeToTestDataMap* GetNodeTestData()
9253     {
9254         Compiler* compRoot = impInlineRoot();
9255         if (compRoot->m_nodeTestData == nullptr)
9256         {
9257             compRoot->m_nodeTestData = new (getAllocatorDebugOnly()) NodeToTestDataMap(getAllocatorDebugOnly());
9258         }
9259         return compRoot->m_nodeTestData;
9260     }
9261
9262     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, int, JitSimplerHashBehavior> NodeToIntMap;
9263
9264     // Returns the set (i.e., the domain of the result map) of nodes that are keys in m_nodeTestData, and
9265     // currently occur in the AST graph.
9266     NodeToIntMap* FindReachableNodesInNodeTestData();
9267
9268     // Node "from" is being eliminated, and being replaced by node "to".  If "from" had any associated
9269     // test data, associate that data with "to".
9270     void TransferTestDataToNode(GenTreePtr from, GenTreePtr to);
9271
9272     // Requires that "to" is a clone of "from".  If any nodes in the "from" tree
9273     // have annotations, attach similar annotations to the corresponding nodes in "to".
9274     void CopyTestDataToCloneTree(GenTreePtr from, GenTreePtr to);
9275
9276     // These are the methods that test that the various conditions implied by the
9277     // test attributes are satisfied.
9278     void JitTestCheckSSA(); // SSA builder tests.
9279     void JitTestCheckVN();  // Value numbering tests.
9280 #endif                      // DEBUG
9281
9282     // The "FieldSeqStore", for canonicalizing field sequences.  See the definition of FieldSeqStore for
9283     // operations.
9284     FieldSeqStore* m_fieldSeqStore;
9285
9286     FieldSeqStore* GetFieldSeqStore()
9287     {
9288         Compiler* compRoot = impInlineRoot();
9289         if (compRoot->m_fieldSeqStore == nullptr)
9290         {
9291             // Create a CompAllocator that labels sub-structure with CMK_FieldSeqStore, and use that for allocation.
9292             IAllocator* ialloc        = new (this, CMK_FieldSeqStore) CompAllocator(this, CMK_FieldSeqStore);
9293             compRoot->m_fieldSeqStore = new (ialloc) FieldSeqStore(ialloc);
9294         }
9295         return compRoot->m_fieldSeqStore;
9296     }
9297
9298     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, FieldSeqNode*, JitSimplerHashBehavior> NodeToFieldSeqMap;
9299
9300     // Some nodes of "TYP_BYREF" or "TYP_I_IMPL" actually represent the address of a field within a struct, but since
9301     // the offset of the field is zero, there's no "GT_ADD" node.  We normally attach a field sequence to the constant
9302     // that is added, but what do we do when that constant is zero, and is thus not present?  We use this mechanism to
9303     // attach the field sequence directly to the address node.
9304     NodeToFieldSeqMap* m_zeroOffsetFieldMap;
9305
9306     NodeToFieldSeqMap* GetZeroOffsetFieldMap()
9307     {
9308         // Don't need to worry about inlining here
9309         if (m_zeroOffsetFieldMap == nullptr)
9310         {
9311             // Create a CompAllocator that labels sub-structure with CMK_ZeroOffsetFieldMap, and use that for
9312             // allocation.
9313             IAllocator* ialloc   = new (this, CMK_ZeroOffsetFieldMap) CompAllocator(this, CMK_ZeroOffsetFieldMap);
9314             m_zeroOffsetFieldMap = new (ialloc) NodeToFieldSeqMap(ialloc);
9315         }
9316         return m_zeroOffsetFieldMap;
9317     }
9318
9319     // Requires that "op1" is a node of type "TYP_BYREF" or "TYP_I_IMPL".  We are dereferencing this with the fields in
9320     // "fieldSeq", whose offsets are required all to be zero.  Ensures that any field sequence annotation currently on
9321     // "op1" or its components is augmented by appending "fieldSeq".  In practice, if "op1" is a GT_LCL_FLD, it has
9322     // a field sequence as a member; otherwise, it may be the addition of an a byref and a constant, where the const
9323     // has a field sequence -- in this case "fieldSeq" is appended to that of the constant; otherwise, we
9324     // record the the field sequence using the ZeroOffsetFieldMap described above.
9325     //
9326     // One exception above is that "op1" is a node of type "TYP_REF" where "op1" is a GT_LCL_VAR.
9327     // This happens when System.Object vtable pointer is a regular field at offset 0 in System.Private.CoreLib in
9328     // CoreRT. Such case is handled same as the default case.
9329     void fgAddFieldSeqForZeroOffset(GenTreePtr op1, FieldSeqNode* fieldSeq);
9330
9331     typedef SimplerHashTable<const GenTree*, PtrKeyFuncs<GenTree>, ArrayInfo, JitSimplerHashBehavior>
9332                         NodeToArrayInfoMap;
9333     NodeToArrayInfoMap* m_arrayInfoMap;
9334
9335     NodeToArrayInfoMap* GetArrayInfoMap()
9336     {
9337         Compiler* compRoot = impInlineRoot();
9338         if (compRoot->m_arrayInfoMap == nullptr)
9339         {
9340             // Create a CompAllocator that labels sub-structure with CMK_ArrayInfoMap, and use that for allocation.
9341             IAllocator* ialloc       = new (this, CMK_ArrayInfoMap) CompAllocator(this, CMK_ArrayInfoMap);
9342             compRoot->m_arrayInfoMap = new (ialloc) NodeToArrayInfoMap(ialloc);
9343         }
9344         return compRoot->m_arrayInfoMap;
9345     }
9346
9347     //-----------------------------------------------------------------------------------------------------------------
9348     // Compiler::TryGetArrayInfo:
9349     //    Given an indirection node, checks to see whether or not that indirection represents an array access, and
9350     //    if so returns information about the array.
9351     //
9352     // Arguments:
9353     //    indir           - The `GT_IND` node.
9354     //    arrayInfo (out) - Information about the accessed array if this function returns true. Undefined otherwise.
9355     //
9356     // Returns:
9357     //    True if the `GT_IND` node represents an array access; false otherwise.
9358     inline bool TryGetArrayInfo(GenTreeIndir* indir, ArrayInfo* arrayInfo)
9359     {
9360         if ((indir->gtFlags & GTF_IND_ARR_INDEX) == 0)
9361         {
9362             return false;
9363         }
9364
9365         if (indir->gtOp1->OperIs(GT_INDEX_ADDR))
9366         {
9367             GenTreeIndexAddr* const indexAddr = indir->gtOp1->AsIndexAddr();
9368             *arrayInfo = ArrayInfo(indexAddr->gtElemType, indexAddr->gtElemSize, indexAddr->gtElemOffset,
9369                                    indexAddr->gtStructElemClass);
9370             return true;
9371         }
9372
9373         bool found = GetArrayInfoMap()->Lookup(indir, arrayInfo);
9374         assert(found);
9375         return true;
9376     }
9377
9378     NodeToUnsignedMap* m_memorySsaMap[MemoryKindCount];
9379
9380     // In some cases, we want to assign intermediate SSA #'s to memory states, and know what nodes create those memory
9381     // states. (We do this for try blocks, where, if the try block doesn't do a call that loses track of the memory
9382     // state, all the possible memory states are possible initial states of the corresponding catch block(s).)
9383     NodeToUnsignedMap* GetMemorySsaMap(MemoryKind memoryKind)
9384     {
9385         if (memoryKind == GcHeap && byrefStatesMatchGcHeapStates)
9386         {
9387             // Use the same map for GCHeap and ByrefExposed when their states match.
9388             memoryKind = ByrefExposed;
9389         }
9390
9391         assert(memoryKind < MemoryKindCount);
9392         Compiler* compRoot = impInlineRoot();
9393         if (compRoot->m_memorySsaMap[memoryKind] == nullptr)
9394         {
9395             // Create a CompAllocator that labels sub-structure with CMK_ArrayInfoMap, and use that for allocation.
9396             IAllocator* ialloc                   = new (this, CMK_ArrayInfoMap) CompAllocator(this, CMK_ArrayInfoMap);
9397             compRoot->m_memorySsaMap[memoryKind] = new (ialloc) NodeToUnsignedMap(ialloc);
9398         }
9399         return compRoot->m_memorySsaMap[memoryKind];
9400     }
9401
9402     // The Refany type is the only struct type whose structure is implicitly assumed by IL.  We need its fields.
9403     CORINFO_CLASS_HANDLE m_refAnyClass;
9404     CORINFO_FIELD_HANDLE GetRefanyDataField()
9405     {
9406         if (m_refAnyClass == nullptr)
9407         {
9408             m_refAnyClass = info.compCompHnd->getBuiltinClass(CLASSID_TYPED_BYREF);
9409         }
9410         return info.compCompHnd->getFieldInClass(m_refAnyClass, 0);
9411     }
9412     CORINFO_FIELD_HANDLE GetRefanyTypeField()
9413     {
9414         if (m_refAnyClass == nullptr)
9415         {
9416             m_refAnyClass = info.compCompHnd->getBuiltinClass(CLASSID_TYPED_BYREF);
9417         }
9418         return info.compCompHnd->getFieldInClass(m_refAnyClass, 1);
9419     }
9420
9421 #if VARSET_COUNTOPS
9422     static BitSetSupport::BitSetOpCounter m_varsetOpCounter;
9423 #endif
9424 #if ALLVARSET_COUNTOPS
9425     static BitSetSupport::BitSetOpCounter m_allvarsetOpCounter;
9426 #endif
9427
9428     static HelperCallProperties s_helperCallProperties;
9429
9430 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
9431     static var_types GetTypeFromClassificationAndSizes(SystemVClassificationType classType, int size);
9432     static var_types GetEightByteType(const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR& structDesc,
9433                                       unsigned                                                   slotNum);
9434     static void GetStructTypeOffset(const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR& structDesc,
9435                                     var_types*                                                 type0,
9436                                     var_types*                                                 type1,
9437                                     unsigned __int8*                                           offset0,
9438                                     unsigned __int8*                                           offset1);
9439     void fgMorphSystemVStructArgs(GenTreeCall* call, bool hasStructArgument);
9440 #endif // defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
9441
9442     void fgMorphMultiregStructArgs(GenTreeCall* call);
9443     GenTreePtr fgMorphMultiregStructArg(GenTreePtr arg, fgArgTabEntryPtr fgEntryPtr);
9444
9445 }; // end of class Compiler
9446
9447 // Inline methods of CompAllocator.
9448 void* CompAllocator::Alloc(size_t sz)
9449 {
9450 #if MEASURE_MEM_ALLOC
9451     return m_comp->compGetMem(sz, m_cmk);
9452 #else
9453     return m_comp->compGetMem(sz);
9454 #endif
9455 }
9456
9457 void* CompAllocator::ArrayAlloc(size_t elems, size_t elemSize)
9458 {
9459 #if MEASURE_MEM_ALLOC
9460     return m_comp->compGetMemArray(elems, elemSize, m_cmk);
9461 #else
9462     return m_comp->compGetMemArray(elems, elemSize);
9463 #endif
9464 }
9465
9466 // LclVarDsc constructor. Uses Compiler, so must come after Compiler definition.
9467 inline LclVarDsc::LclVarDsc(Compiler* comp)
9468     : // Initialize the ArgRegs to REG_STK.
9469     // The morph will do the right thing to change
9470     // to the right register if passed in register.
9471     _lvArgReg(REG_STK)
9472     ,
9473 #if FEATURE_MULTIREG_ARGS
9474     _lvOtherArgReg(REG_STK)
9475     ,
9476 #endif // FEATURE_MULTIREG_ARGS
9477 #if ASSERTION_PROP
9478     lvRefBlks(BlockSetOps::UninitVal())
9479     ,
9480 #endif // ASSERTION_PROP
9481     lvPerSsaData(comp->getAllocator())
9482 {
9483 }
9484
9485 //---------------------------------------------------------------------------------------------------------------------
9486 // GenTreeVisitor: a flexible tree walker implemented using the curiosly-recurring-template pattern.
9487 //
9488 // This class implements a configurable walker for IR trees. There are five configuration options (defaults values are
9489 // shown in parentheses):
9490 //
9491 // - ComputeStack (false): when true, the walker will push each node onto the `m_ancestors` stack. "Ancestors" is a bit
9492 //                         of a misnomer, as the first entry will always be the current node.
9493 //
9494 // - DoPreOrder (false): when true, the walker will invoke `TVisitor::PreOrderVisit` with the current node as an
9495 //                       argument before visiting the node's operands.
9496 //
9497 // - DoPostOrder (false): when true, the walker will invoke `TVisitor::PostOrderVisit` with the current node as an
9498 //                        argument after visiting the node's operands.
9499 //
9500 // - DoLclVarsOnly (false): when true, the walker will only invoke `TVisitor::PreOrderVisit` for lclVar nodes.
9501 //                          `DoPreOrder` must be true if this option is true.
9502 //
9503 // - UseExecutionOrder (false): when true, then walker will visit a node's operands in execution order (e.g. if a
9504 //                              binary operator has the `GTF_REVERSE_OPS` flag set, the second operand will be
9505 //                              visited before the first).
9506 //
9507 // At least one of `DoPreOrder` and `DoPostOrder` must be specified.
9508 //
9509 // A simple pre-order visitor might look something like the following:
9510 //
9511 //     class CountingVisitor final : public GenTreeVisitor<CountingVisitor>
9512 //     {
9513 //     public:
9514 //         enum
9515 //         {
9516 //             DoPreOrder = true
9517 //         };
9518 //
9519 //         unsigned m_count;
9520 //
9521 //         CountingVisitor(Compiler* compiler)
9522 //             : GenTreeVisitor<CountingVisitor>(compiler), m_count(0)
9523 //         {
9524 //         }
9525 //
9526 //         Compiler::fgWalkResult PreOrderVisit(GenTree* node)
9527 //         {
9528 //             m_count++;
9529 //         }
9530 //     };
9531 //
9532 // This visitor would then be used like so:
9533 //
9534 //     CountingVisitor countingVisitor(compiler);
9535 //     countingVisitor.WalkTree(root);
9536 //
9537 template <typename TVisitor>
9538 class GenTreeVisitor
9539 {
9540 protected:
9541     typedef Compiler::fgWalkResult fgWalkResult;
9542
9543     enum
9544     {
9545         ComputeStack      = false,
9546         DoPreOrder        = false,
9547         DoPostOrder       = false,
9548         DoLclVarsOnly     = false,
9549         UseExecutionOrder = false,
9550     };
9551
9552     Compiler*            m_compiler;
9553     ArrayStack<GenTree*> m_ancestors;
9554
9555     GenTreeVisitor(Compiler* compiler) : m_compiler(compiler), m_ancestors(compiler)
9556     {
9557         assert(compiler != nullptr);
9558
9559         static_assert_no_msg(TVisitor::DoPreOrder || TVisitor::DoPostOrder);
9560         static_assert_no_msg(!TVisitor::DoLclVarsOnly || TVisitor::DoPreOrder);
9561     }
9562
9563     fgWalkResult PreOrderVisit(GenTree** use, GenTree* user)
9564     {
9565         return fgWalkResult::WALK_CONTINUE;
9566     }
9567
9568     fgWalkResult PostOrderVisit(GenTree** use, GenTree* user)
9569     {
9570         return fgWalkResult::WALK_CONTINUE;
9571     }
9572
9573 public:
9574     fgWalkResult WalkTree(GenTree** use, GenTree* user)
9575     {
9576         assert(use != nullptr);
9577
9578         GenTree* node = *use;
9579
9580         if (TVisitor::ComputeStack)
9581         {
9582             m_ancestors.Push(node);
9583         }
9584
9585         fgWalkResult result = fgWalkResult::WALK_CONTINUE;
9586         if (TVisitor::DoPreOrder && !TVisitor::DoLclVarsOnly)
9587         {
9588             result = reinterpret_cast<TVisitor*>(this)->PreOrderVisit(use, user);
9589             if (result == fgWalkResult::WALK_ABORT)
9590             {
9591                 return result;
9592             }
9593
9594             node = *use;
9595             if ((node == nullptr) || (result == fgWalkResult::WALK_SKIP_SUBTREES))
9596             {
9597                 goto DONE;
9598             }
9599         }
9600
9601         switch (node->OperGet())
9602         {
9603             // Leaf lclVars
9604             case GT_LCL_VAR:
9605             case GT_LCL_FLD:
9606             case GT_LCL_VAR_ADDR:
9607             case GT_LCL_FLD_ADDR:
9608                 if (TVisitor::DoLclVarsOnly)
9609                 {
9610                     result = reinterpret_cast<TVisitor*>(this)->PreOrderVisit(use, user);
9611                     if (result == fgWalkResult::WALK_ABORT)
9612                     {
9613                         return result;
9614                     }
9615                 }
9616                 __fallthrough;
9617
9618             // Leaf nodes
9619             case GT_CATCH_ARG:
9620             case GT_LABEL:
9621             case GT_FTN_ADDR:
9622             case GT_RET_EXPR:
9623             case GT_CNS_INT:
9624             case GT_CNS_LNG:
9625             case GT_CNS_DBL:
9626             case GT_CNS_STR:
9627             case GT_MEMORYBARRIER:
9628             case GT_JMP:
9629             case GT_JCC:
9630             case GT_SETCC:
9631             case GT_NO_OP:
9632             case GT_START_NONGC:
9633             case GT_PROF_HOOK:
9634 #if !FEATURE_EH_FUNCLETS
9635             case GT_END_LFIN:
9636 #endif // !FEATURE_EH_FUNCLETS
9637             case GT_PHI_ARG:
9638 #ifndef LEGACY_BACKEND
9639             case GT_JMPTABLE:
9640 #endif // LEGACY_BACKEND
9641             case GT_REG_VAR:
9642             case GT_CLS_VAR:
9643             case GT_CLS_VAR_ADDR:
9644             case GT_ARGPLACE:
9645             case GT_PHYSREG:
9646             case GT_EMITNOP:
9647             case GT_PINVOKE_PROLOG:
9648             case GT_PINVOKE_EPILOG:
9649             case GT_IL_OFFSET:
9650                 break;
9651
9652             // Lclvar unary operators
9653             case GT_STORE_LCL_VAR:
9654             case GT_STORE_LCL_FLD:
9655                 if (TVisitor::DoLclVarsOnly)
9656                 {
9657                     result = reinterpret_cast<TVisitor*>(this)->PreOrderVisit(use, user);
9658                     if (result == fgWalkResult::WALK_ABORT)
9659                     {
9660                         return result;
9661                     }
9662                 }
9663                 __fallthrough;
9664
9665             // Standard unary operators
9666             case GT_NOT:
9667             case GT_NEG:
9668             case GT_COPY:
9669             case GT_RELOAD:
9670             case GT_ARR_LENGTH:
9671             case GT_CAST:
9672             case GT_BITCAST:
9673             case GT_CKFINITE:
9674             case GT_LCLHEAP:
9675             case GT_ADDR:
9676             case GT_IND:
9677             case GT_OBJ:
9678             case GT_BLK:
9679             case GT_BOX:
9680             case GT_ALLOCOBJ:
9681             case GT_INIT_VAL:
9682             case GT_JTRUE:
9683             case GT_SWITCH:
9684             case GT_NULLCHECK:
9685             case GT_PUTARG_REG:
9686             case GT_PUTARG_STK:
9687             case GT_RETURNTRAP:
9688             case GT_NOP:
9689             case GT_RETURN:
9690             case GT_RETFILT:
9691             case GT_PHI:
9692             {
9693                 GenTreeUnOp* const unOp = node->AsUnOp();
9694                 if (unOp->gtOp1 != nullptr)
9695                 {
9696                     result = WalkTree(&unOp->gtOp1, unOp);
9697                     if (result == fgWalkResult::WALK_ABORT)
9698                     {
9699                         return result;
9700                     }
9701                 }
9702                 break;
9703             }
9704
9705             // Special nodes
9706             case GT_CMPXCHG:
9707             {
9708                 GenTreeCmpXchg* const cmpXchg = node->AsCmpXchg();
9709
9710                 result = WalkTree(&cmpXchg->gtOpComparand, cmpXchg);
9711                 if (result == fgWalkResult::WALK_ABORT)
9712                 {
9713                     return result;
9714                 }
9715                 result = WalkTree(&cmpXchg->gtOpValue, cmpXchg);
9716                 if (result == fgWalkResult::WALK_ABORT)
9717                 {
9718                     return result;
9719                 }
9720                 result = WalkTree(&cmpXchg->gtOpLocation, cmpXchg);
9721                 if (result == fgWalkResult::WALK_ABORT)
9722                 {
9723                     return result;
9724                 }
9725                 break;
9726             }
9727
9728             case GT_ARR_BOUNDS_CHECK:
9729 #ifdef FEATURE_SIMD
9730             case GT_SIMD_CHK:
9731 #endif // FEATURE_SIMD
9732             {
9733                 GenTreeBoundsChk* const boundsChk = node->AsBoundsChk();
9734
9735                 result = WalkTree(&boundsChk->gtIndex, boundsChk);
9736                 if (result == fgWalkResult::WALK_ABORT)
9737                 {
9738                     return result;
9739                 }
9740                 result = WalkTree(&boundsChk->gtArrLen, boundsChk);
9741                 if (result == fgWalkResult::WALK_ABORT)
9742                 {
9743                     return result;
9744                 }
9745                 break;
9746             }
9747
9748             case GT_FIELD:
9749             {
9750                 GenTreeField* const field = node->AsField();
9751
9752                 if (field->gtFldObj != nullptr)
9753                 {
9754                     result = WalkTree(&field->gtFldObj, field);
9755                     if (result == fgWalkResult::WALK_ABORT)
9756                     {
9757                         return result;
9758                     }
9759                 }
9760                 break;
9761             }
9762
9763             case GT_ARR_ELEM:
9764             {
9765                 GenTreeArrElem* const arrElem = node->AsArrElem();
9766
9767                 result = WalkTree(&arrElem->gtArrObj, arrElem);
9768                 if (result == fgWalkResult::WALK_ABORT)
9769                 {
9770                     return result;
9771                 }
9772
9773                 const unsigned rank = arrElem->gtArrRank;
9774                 for (unsigned dim = 0; dim < rank; dim++)
9775                 {
9776                     result = WalkTree(&arrElem->gtArrInds[dim], arrElem);
9777                     if (result == fgWalkResult::WALK_ABORT)
9778                     {
9779                         return result;
9780                     }
9781                 }
9782                 break;
9783             }
9784
9785             case GT_ARR_OFFSET:
9786             {
9787                 GenTreeArrOffs* const arrOffs = node->AsArrOffs();
9788
9789                 result = WalkTree(&arrOffs->gtOffset, arrOffs);
9790                 if (result == fgWalkResult::WALK_ABORT)
9791                 {
9792                     return result;
9793                 }
9794                 result = WalkTree(&arrOffs->gtIndex, arrOffs);
9795                 if (result == fgWalkResult::WALK_ABORT)
9796                 {
9797                     return result;
9798                 }
9799                 result = WalkTree(&arrOffs->gtArrObj, arrOffs);
9800                 if (result == fgWalkResult::WALK_ABORT)
9801                 {
9802                     return result;
9803                 }
9804                 break;
9805             }
9806
9807             case GT_DYN_BLK:
9808             {
9809                 GenTreeDynBlk* const dynBlock = node->AsDynBlk();
9810
9811                 GenTree** op1Use = &dynBlock->gtOp1;
9812                 GenTree** op2Use = &dynBlock->gtDynamicSize;
9813
9814                 if (TVisitor::UseExecutionOrder && dynBlock->gtEvalSizeFirst)
9815                 {
9816                     std::swap(op1Use, op2Use);
9817                 }
9818
9819                 result = WalkTree(op1Use, dynBlock);
9820                 if (result == fgWalkResult::WALK_ABORT)
9821                 {
9822                     return result;
9823                 }
9824                 result = WalkTree(op2Use, dynBlock);
9825                 if (result == fgWalkResult::WALK_ABORT)
9826                 {
9827                     return result;
9828                 }
9829                 break;
9830             }
9831
9832             case GT_STORE_DYN_BLK:
9833             {
9834                 GenTreeDynBlk* const dynBlock = node->AsDynBlk();
9835
9836                 GenTree** op1Use = &dynBlock->gtOp1;
9837                 GenTree** op2Use = &dynBlock->gtOp2;
9838                 GenTree** op3Use = &dynBlock->gtDynamicSize;
9839
9840                 if (TVisitor::UseExecutionOrder)
9841                 {
9842                     if (dynBlock->IsReverseOp())
9843                     {
9844                         std::swap(op1Use, op2Use);
9845                     }
9846                     if (dynBlock->gtEvalSizeFirst)
9847                     {
9848                         std::swap(op3Use, op2Use);
9849                         std::swap(op2Use, op1Use);
9850                     }
9851                 }
9852
9853                 result = WalkTree(op1Use, dynBlock);
9854                 if (result == fgWalkResult::WALK_ABORT)
9855                 {
9856                     return result;
9857                 }
9858                 result = WalkTree(op2Use, dynBlock);
9859                 if (result == fgWalkResult::WALK_ABORT)
9860                 {
9861                     return result;
9862                 }
9863                 result = WalkTree(op3Use, dynBlock);
9864                 if (result == fgWalkResult::WALK_ABORT)
9865                 {
9866                     return result;
9867                 }
9868                 break;
9869             }
9870
9871             case GT_CALL:
9872             {
9873                 GenTreeCall* const call = node->AsCall();
9874
9875                 if (call->gtCallObjp != nullptr)
9876                 {
9877                     result = WalkTree(&call->gtCallObjp, call);
9878                     if (result == fgWalkResult::WALK_ABORT)
9879                     {
9880                         return result;
9881                     }
9882                 }
9883
9884                 for (GenTreeArgList* args = call->gtCallArgs; args != nullptr; args = args->Rest())
9885                 {
9886                     result = WalkTree(args->pCurrent(), call);
9887                     if (result == fgWalkResult::WALK_ABORT)
9888                     {
9889                         return result;
9890                     }
9891                 }
9892
9893                 for (GenTreeArgList* args = call->gtCallLateArgs; args != nullptr; args = args->Rest())
9894                 {
9895                     result = WalkTree(args->pCurrent(), call);
9896                     if (result == fgWalkResult::WALK_ABORT)
9897                     {
9898                         return result;
9899                     }
9900                 }
9901
9902                 if (call->gtCallType == CT_INDIRECT)
9903                 {
9904                     if (call->gtCallCookie != nullptr)
9905                     {
9906                         result = WalkTree(&call->gtCallCookie, call);
9907                         if (result == fgWalkResult::WALK_ABORT)
9908                         {
9909                             return result;
9910                         }
9911                     }
9912
9913                     result = WalkTree(&call->gtCallAddr, call);
9914                     if (result == fgWalkResult::WALK_ABORT)
9915                     {
9916                         return result;
9917                     }
9918                 }
9919
9920                 if (call->gtControlExpr != nullptr)
9921                 {
9922                     result = WalkTree(&call->gtControlExpr, call);
9923                     if (result == fgWalkResult::WALK_ABORT)
9924                     {
9925                         return result;
9926                     }
9927                 }
9928
9929                 break;
9930             }
9931
9932             // Binary nodes
9933             default:
9934             {
9935                 assert(node->OperIsBinary());
9936
9937                 GenTreeOp* const op = node->AsOp();
9938
9939                 GenTree** op1Use = &op->gtOp1;
9940                 GenTree** op2Use = &op->gtOp2;
9941
9942                 if (TVisitor::UseExecutionOrder && node->IsReverseOp())
9943                 {
9944                     std::swap(op1Use, op2Use);
9945                 }
9946
9947                 if (*op1Use != nullptr)
9948                 {
9949                     result = WalkTree(op1Use, op);
9950                     if (result == fgWalkResult::WALK_ABORT)
9951                     {
9952                         return result;
9953                     }
9954                 }
9955
9956                 if (*op2Use != nullptr)
9957                 {
9958                     result = WalkTree(op2Use, op);
9959                     if (result == fgWalkResult::WALK_ABORT)
9960                     {
9961                         return result;
9962                     }
9963                 }
9964                 break;
9965             }
9966         }
9967
9968     DONE:
9969         // Finally, visit the current node
9970         if (TVisitor::DoPostOrder)
9971         {
9972             result = reinterpret_cast<TVisitor*>(this)->PostOrderVisit(use, user);
9973         }
9974
9975         if (TVisitor::ComputeStack)
9976         {
9977             m_ancestors.Pop();
9978         }
9979
9980         return result;
9981     }
9982 };
9983
9984 template <bool computeStack, bool doPreOrder, bool doPostOrder, bool doLclVarsOnly, bool useExecutionOrder>
9985 class GenericTreeWalker final
9986     : public GenTreeVisitor<GenericTreeWalker<computeStack, doPreOrder, doPostOrder, doLclVarsOnly, useExecutionOrder>>
9987 {
9988 public:
9989     enum
9990     {
9991         ComputeStack      = computeStack,
9992         DoPreOrder        = doPreOrder,
9993         DoPostOrder       = doPostOrder,
9994         DoLclVarsOnly     = doLclVarsOnly,
9995         UseExecutionOrder = useExecutionOrder,
9996     };
9997
9998 private:
9999     Compiler::fgWalkData* m_walkData;
10000
10001 public:
10002     GenericTreeWalker(Compiler::fgWalkData* walkData)
10003         : GenTreeVisitor<GenericTreeWalker<computeStack, doPreOrder, doPostOrder, doLclVarsOnly, useExecutionOrder>>(
10004               walkData->compiler)
10005         , m_walkData(walkData)
10006     {
10007         assert(walkData != nullptr);
10008
10009         if (computeStack)
10010         {
10011             walkData->parentStack = &this->m_ancestors;
10012         }
10013     }
10014
10015     Compiler::fgWalkResult PreOrderVisit(GenTree** use, GenTree* user)
10016     {
10017         m_walkData->parent = user;
10018         return m_walkData->wtprVisitorFn(use, m_walkData);
10019     }
10020
10021     Compiler::fgWalkResult PostOrderVisit(GenTree** use, GenTree* user)
10022     {
10023         m_walkData->parent = user;
10024         return m_walkData->wtpoVisitorFn(use, m_walkData);
10025     }
10026 };
10027
10028 class IncLclVarRefCountsVisitor final : public GenTreeVisitor<IncLclVarRefCountsVisitor>
10029 {
10030 public:
10031     enum
10032     {
10033         DoPreOrder    = true,
10034         DoLclVarsOnly = true
10035     };
10036
10037     IncLclVarRefCountsVisitor(Compiler* compiler);
10038     Compiler::fgWalkResult PreOrderVisit(GenTree** use, GenTree* user);
10039
10040     static Compiler::fgWalkResult WalkTree(Compiler* compiler, GenTree* tree);
10041 };
10042
10043 class DecLclVarRefCountsVisitor final : public GenTreeVisitor<DecLclVarRefCountsVisitor>
10044 {
10045 public:
10046     enum
10047     {
10048         DoPreOrder    = true,
10049         DoLclVarsOnly = true
10050     };
10051
10052     DecLclVarRefCountsVisitor(Compiler* compiler);
10053     Compiler::fgWalkResult PreOrderVisit(GenTree** use, GenTree* user);
10054
10055     static Compiler::fgWalkResult WalkTree(Compiler* compiler, GenTree* tree);
10056 };
10057
10058 /*
10059 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10060 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10061 XX                                                                           XX
10062 XX                   Miscellaneous Compiler stuff                            XX
10063 XX                                                                           XX
10064 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10065 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10066 */
10067
10068 // Values used to mark the types a stack slot is used for
10069
10070 const unsigned TYPE_REF_INT      = 0x01; // slot used as a 32-bit int
10071 const unsigned TYPE_REF_LNG      = 0x02; // slot used as a 64-bit long
10072 const unsigned TYPE_REF_FLT      = 0x04; // slot used as a 32-bit float
10073 const unsigned TYPE_REF_DBL      = 0x08; // slot used as a 64-bit float
10074 const unsigned TYPE_REF_PTR      = 0x10; // slot used as a 32-bit pointer
10075 const unsigned TYPE_REF_BYR      = 0x20; // slot used as a byref pointer
10076 const unsigned TYPE_REF_STC      = 0x40; // slot used as a struct
10077 const unsigned TYPE_REF_TYPEMASK = 0x7F; // bits that represent the type
10078
10079 // const unsigned TYPE_REF_ADDR_TAKEN  = 0x80; // slots address was taken
10080
10081 /*****************************************************************************
10082  *
10083  *  Variables to keep track of total code amounts.
10084  */
10085
10086 #if DISPLAY_SIZES
10087
10088 extern size_t grossVMsize;
10089 extern size_t grossNCsize;
10090 extern size_t totalNCsize;
10091
10092 extern unsigned genMethodICnt;
10093 extern unsigned genMethodNCnt;
10094 extern size_t   gcHeaderISize;
10095 extern size_t   gcPtrMapISize;
10096 extern size_t   gcHeaderNSize;
10097 extern size_t   gcPtrMapNSize;
10098
10099 #endif // DISPLAY_SIZES
10100
10101 /*****************************************************************************
10102  *
10103  *  Variables to keep track of basic block counts (more data on 1 BB methods)
10104  */
10105
10106 #if COUNT_BASIC_BLOCKS
10107 extern Histogram bbCntTable;
10108 extern Histogram bbOneBBSizeTable;
10109 #endif
10110
10111 /*****************************************************************************
10112  *
10113  *  Used by optFindNaturalLoops to gather statistical information such as
10114  *   - total number of natural loops
10115  *   - number of loops with 1, 2, ... exit conditions
10116  *   - number of loops that have an iterator (for like)
10117  *   - number of loops that have a constant iterator
10118  */
10119
10120 #if COUNT_LOOPS
10121
10122 extern unsigned totalLoopMethods;        // counts the total number of methods that have natural loops
10123 extern unsigned maxLoopsPerMethod;       // counts the maximum number of loops a method has
10124 extern unsigned totalLoopOverflows;      // # of methods that identified more loops than we can represent
10125 extern unsigned totalLoopCount;          // counts the total number of natural loops
10126 extern unsigned totalUnnatLoopCount;     // counts the total number of (not-necessarily natural) loops
10127 extern unsigned totalUnnatLoopOverflows; // # of methods that identified more unnatural loops than we can represent
10128 extern unsigned iterLoopCount;           // counts the # of loops with an iterator (for like)
10129 extern unsigned simpleTestLoopCount;     // counts the # of loops with an iterator and a simple loop condition (iter <
10130                                          // const)
10131 extern unsigned  constIterLoopCount;     // counts the # of loops with a constant iterator (for like)
10132 extern bool      hasMethodLoops;         // flag to keep track if we already counted a method as having loops
10133 extern unsigned  loopsThisMethod;        // counts the number of loops in the current method
10134 extern bool      loopOverflowThisMethod; // True if we exceeded the max # of loops in the method.
10135 extern Histogram loopCountTable;         // Histogram of loop counts
10136 extern Histogram loopExitCountTable;     // Histogram of loop exit counts
10137
10138 #endif // COUNT_LOOPS
10139
10140 /*****************************************************************************
10141  * variables to keep track of how many iterations we go in a dataflow pass
10142  */
10143
10144 #if DATAFLOW_ITER
10145
10146 extern unsigned CSEiterCount; // counts the # of iteration for the CSE dataflow
10147 extern unsigned CFiterCount;  // counts the # of iteration for the Const Folding dataflow
10148
10149 #endif // DATAFLOW_ITER
10150
10151 #if MEASURE_BLOCK_SIZE
10152 extern size_t genFlowNodeSize;
10153 extern size_t genFlowNodeCnt;
10154 #endif // MEASURE_BLOCK_SIZE
10155
10156 #if MEASURE_NODE_SIZE
10157 struct NodeSizeStats
10158 {
10159     void Init()
10160     {
10161         genTreeNodeCnt        = 0;
10162         genTreeNodeSize       = 0;
10163         genTreeNodeActualSize = 0;
10164     }
10165
10166     // Count of tree nodes allocated.
10167     unsigned __int64 genTreeNodeCnt;
10168
10169     // The size we allocate.
10170     unsigned __int64 genTreeNodeSize;
10171
10172     // The actual size of the node. Note that the actual size will likely be smaller
10173     // than the allocated size, but we sometimes use SetOper()/ChangeOper() to change
10174     // a smaller node to a larger one. TODO-Cleanup: add stats on
10175     // SetOper()/ChangeOper() usage to quantify this.
10176     unsigned __int64 genTreeNodeActualSize;
10177 };
10178 extern NodeSizeStats genNodeSizeStats;        // Total node size stats
10179 extern NodeSizeStats genNodeSizeStatsPerFunc; // Per-function node size stats
10180 extern Histogram     genTreeNcntHist;
10181 extern Histogram     genTreeNsizHist;
10182 #endif // MEASURE_NODE_SIZE
10183
10184 /*****************************************************************************
10185  *  Count fatal errors (including noway_asserts).
10186  */
10187
10188 #if MEASURE_FATAL
10189 extern unsigned fatal_badCode;
10190 extern unsigned fatal_noWay;
10191 extern unsigned fatal_NOMEM;
10192 extern unsigned fatal_noWayAssertBody;
10193 #ifdef DEBUG
10194 extern unsigned fatal_noWayAssertBodyArgs;
10195 #endif // DEBUG
10196 extern unsigned fatal_NYI;
10197 #endif // MEASURE_FATAL
10198
10199 /*****************************************************************************
10200  * Codegen
10201  */
10202
10203 #ifdef _TARGET_XARCH_
10204
10205 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_shl;
10206 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_shr;
10207 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_sar;
10208
10209 const instruction INS_AND             = INS_and;
10210 const instruction INS_OR              = INS_or;
10211 const instruction INS_XOR             = INS_xor;
10212 const instruction INS_NEG             = INS_neg;
10213 const instruction INS_TEST            = INS_test;
10214 const instruction INS_MUL             = INS_imul;
10215 const instruction INS_SIGNED_DIVIDE   = INS_idiv;
10216 const instruction INS_UNSIGNED_DIVIDE = INS_div;
10217 const instruction INS_BREAKPOINT      = INS_int3;
10218 const instruction INS_ADDC            = INS_adc;
10219 const instruction INS_SUBC            = INS_sbb;
10220 const instruction INS_NOT             = INS_not;
10221
10222 #endif
10223
10224 #ifdef _TARGET_ARM_
10225
10226 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_lsl;
10227 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_lsr;
10228 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_asr;
10229
10230 const instruction INS_AND             = INS_and;
10231 const instruction INS_OR              = INS_orr;
10232 const instruction INS_XOR             = INS_eor;
10233 const instruction INS_NEG             = INS_rsb;
10234 const instruction INS_TEST            = INS_tst;
10235 const instruction INS_MUL             = INS_mul;
10236 const instruction INS_MULADD          = INS_mla;
10237 const instruction INS_SIGNED_DIVIDE   = INS_sdiv;
10238 const instruction INS_UNSIGNED_DIVIDE = INS_udiv;
10239 const instruction INS_BREAKPOINT      = INS_bkpt;
10240 const instruction INS_ADDC            = INS_adc;
10241 const instruction INS_SUBC            = INS_sbc;
10242 const instruction INS_NOT             = INS_mvn;
10243
10244 const instruction INS_ABS   = INS_vabs;
10245 const instruction INS_ROUND = INS_invalid;
10246 const instruction INS_SQRT  = INS_vsqrt;
10247
10248 #endif
10249
10250 #ifdef _TARGET_ARM64_
10251
10252 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_lsl;
10253 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_lsr;
10254 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_asr;
10255
10256 const instruction INS_AND             = INS_and;
10257 const instruction INS_OR              = INS_orr;
10258 const instruction INS_XOR             = INS_eor;
10259 const instruction INS_NEG             = INS_neg;
10260 const instruction INS_TEST            = INS_tst;
10261 const instruction INS_MUL             = INS_mul;
10262 const instruction INS_MULADD          = INS_madd;
10263 const instruction INS_SIGNED_DIVIDE   = INS_sdiv;
10264 const instruction INS_UNSIGNED_DIVIDE = INS_udiv;
10265 const instruction INS_BREAKPOINT      = INS_bkpt;
10266 const instruction INS_ADDC            = INS_adc;
10267 const instruction INS_SUBC            = INS_sbc;
10268 const instruction INS_NOT             = INS_mvn;
10269
10270 const instruction INS_ABS   = INS_fabs;
10271 const instruction INS_ROUND = INS_frintn;
10272 const instruction INS_SQRT  = INS_fsqrt;
10273
10274 #endif
10275
10276 /*****************************************************************************/
10277
10278 extern const BYTE genTypeSizes[];
10279 extern const BYTE genTypeAlignments[];
10280 extern const BYTE genTypeStSzs[];
10281 extern const BYTE genActualTypes[];
10282
10283 /*****************************************************************************/
10284
10285 // VERY_LARGE_FRAME_SIZE_REG_MASK is the set of registers we need to use for
10286 // the probing loop generated for very large stack frames (see `getVeryLargeFrameSize`).
10287
10288 #ifdef _TARGET_ARM_
10289 #define VERY_LARGE_FRAME_SIZE_REG_MASK (RBM_R4 | RBM_R5 | RBM_R6)
10290 #elif defined(_TARGET_ARM64_)
10291 #define VERY_LARGE_FRAME_SIZE_REG_MASK (RBM_R9 | RBM_R10 | RBM_R11)
10292 #endif
10293
10294 /*****************************************************************************/
10295
10296 #define REG_CORRUPT regNumber(REG_NA + 1)
10297 #define RBM_CORRUPT (RBM_ILLEGAL | regMaskTP(1))
10298 #define REG_PAIR_CORRUPT regPairNo(REG_PAIR_NONE + 1)
10299
10300 /*****************************************************************************/
10301
10302 extern BasicBlock dummyBB;
10303
10304 /*****************************************************************************/
10305 /*****************************************************************************/
10306
10307 // foreach_treenode_execution_order: An iterator that iterates through all the tree
10308 // nodes of a statement in execution order.
10309 //      __stmt: a GT_STMT type GenTree*
10310 //      __node: a GenTree*, already declared, that gets updated with each node in the statement, in execution order
10311
10312 #define foreach_treenode_execution_order(__node, __stmt)                                                               \
10313     for ((__node) = (__stmt)->gtStmt.gtStmtList; (__node); (__node) = (__node)->gtNext)
10314
10315 // foreach_block: An iterator over all blocks in the function.
10316 //    __compiler: the Compiler* object
10317 //    __block   : a BasicBlock*, already declared, that gets updated each iteration.
10318
10319 #define foreach_block(__compiler, __block)                                                                             \
10320     for ((__block) = (__compiler)->fgFirstBB; (__block); (__block) = (__block)->bbNext)
10321
10322 /*****************************************************************************/
10323 /*****************************************************************************/
10324
10325 #ifdef DEBUG
10326
10327 void dumpConvertedVarSet(Compiler* comp, VARSET_VALARG_TP vars);
10328
10329 /*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10330 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10331 XX                                                                           XX
10332 XX                          Debugging helpers                                XX
10333 XX                                                                           XX
10334 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10335 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10336 */
10337
10338 /*****************************************************************************/
10339 /* The following functions are intended to be called from the debugger, to dump
10340  * various data structures. The can be used in the debugger Watch or Quick Watch
10341  * windows. They are designed to be short to type and take as few arguments as
10342  * possible. The 'c' versions take a Compiler*, whereas the 'd' versions use the TlsCompiler.
10343  * See the function definition comment for more details.
10344  */
10345
10346 void cBlock(Compiler* comp, BasicBlock* block);
10347 void cBlocks(Compiler* comp);
10348 void cBlocksV(Compiler* comp);
10349 void cTree(Compiler* comp, GenTree* tree);
10350 void cTrees(Compiler* comp);
10351 void cEH(Compiler* comp);
10352 void cVar(Compiler* comp, unsigned lclNum);
10353 void cVarDsc(Compiler* comp, LclVarDsc* varDsc);
10354 void cVars(Compiler* comp);
10355 void cVarsFinal(Compiler* comp);
10356 void cBlockPreds(Compiler* comp, BasicBlock* block);
10357 void cReach(Compiler* comp);
10358 void cDoms(Compiler* comp);
10359 void cLiveness(Compiler* comp);
10360 void cCVarSet(Compiler* comp, VARSET_VALARG_TP vars);
10361
10362 void cFuncIR(Compiler* comp);
10363 void cBlockIR(Compiler* comp, BasicBlock* block);
10364 void cLoopIR(Compiler* comp, Compiler::LoopDsc* loop);
10365 void cTreeIR(Compiler* comp, GenTree* tree);
10366 int cTreeTypeIR(Compiler* comp, GenTree* tree);
10367 int cTreeKindsIR(Compiler* comp, GenTree* tree);
10368 int cTreeFlagsIR(Compiler* comp, GenTree* tree);
10369 int cOperandIR(Compiler* comp, GenTree* operand);
10370 int cLeafIR(Compiler* comp, GenTree* tree);
10371 int cIndirIR(Compiler* comp, GenTree* tree);
10372 int cListIR(Compiler* comp, GenTree* list);
10373 int cSsaNumIR(Compiler* comp, GenTree* tree);
10374 int cValNumIR(Compiler* comp, GenTree* tree);
10375 int cDependsIR(Compiler* comp, GenTree* comma, bool* first);
10376
10377 void dBlock(BasicBlock* block);
10378 void dBlocks();
10379 void dBlocksV();
10380 void dTree(GenTree* tree);
10381 void dTrees();
10382 void dEH();
10383 void dVar(unsigned lclNum);
10384 void dVarDsc(LclVarDsc* varDsc);
10385 void dVars();
10386 void dVarsFinal();
10387 void dBlockPreds(BasicBlock* block);
10388 void dReach();
10389 void dDoms();
10390 void dLiveness();
10391 void dCVarSet(VARSET_VALARG_TP vars);
10392
10393 void dVarSet(VARSET_VALARG_TP vars);
10394 void dRegMask(regMaskTP mask);
10395
10396 void dFuncIR();
10397 void dBlockIR(BasicBlock* block);
10398 void dTreeIR(GenTree* tree);
10399 void dLoopIR(Compiler::LoopDsc* loop);
10400 void dLoopNumIR(unsigned loopNum);
10401 int dTabStopIR(int curr, int tabstop);
10402 int dTreeTypeIR(GenTree* tree);
10403 int dTreeKindsIR(GenTree* tree);
10404 int dTreeFlagsIR(GenTree* tree);
10405 int dOperandIR(GenTree* operand);
10406 int dLeafIR(GenTree* tree);
10407 int dIndirIR(GenTree* tree);
10408 int dListIR(GenTree* list);
10409 int dSsaNumIR(GenTree* tree);
10410 int dValNumIR(GenTree* tree);
10411 int dDependsIR(GenTree* comma);
10412 void dFormatIR();
10413
10414 GenTree* dFindTree(GenTree* tree, unsigned id);
10415 GenTree* dFindTree(unsigned id);
10416 GenTreeStmt* dFindStmt(unsigned id);
10417 BasicBlock* dFindBlock(unsigned bbNum);
10418
10419 #endif // DEBUG
10420
10421 #include "compiler.hpp" // All the shared inline functions
10422
10423 /*****************************************************************************/
10424 #endif //_COMPILER_H_
10425 /*****************************************************************************/