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