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
3429     bool     fgHasSwitch;  // any BBJ_SWITCH jumps?
3430     bool     fgHasPostfix; // any postfix ++/-- found?
3431     unsigned fgIncrCount;  // number of increment nodes found
3432
3433     BlockSet fgEnterBlks; // Set of blocks which have a special transfer of control; the "entry" blocks plus EH handler
3434                           // begin blocks.
3435
3436 #ifdef DEBUG
3437     bool fgReachabilitySetsValid; // Are the bbReach sets valid?
3438     bool fgEnterBlksSetValid;     // Is the fgEnterBlks set valid?
3439 #endif                            // DEBUG
3440
3441     bool fgRemoveRestOfBlock; // true if we know that we will throw
3442     bool fgStmtRemoved;       // true if we remove statements -> need new DFA
3443
3444     // There are two modes for ordering of the trees.
3445     //  - In FGOrderTree, the dominant ordering is the tree order, and the nodes contained in
3446     //    each tree and sub-tree are contiguous, and can be traversed (in gtNext/gtPrev order)
3447     //    by traversing the tree according to the order of the operands.
3448     //  - In FGOrderLinear, the dominant ordering is the linear order.
3449
3450     enum FlowGraphOrder
3451     {
3452         FGOrderTree,
3453         FGOrderLinear
3454     };
3455     FlowGraphOrder fgOrder;
3456
3457     // The following are boolean flags that keep track of the state of internal data structures
3458
3459     bool                 fgStmtListThreaded;
3460     bool                 fgCanRelocateEHRegions;   // true if we are allowed to relocate the EH regions
3461     bool                 fgEdgeWeightsComputed;    // true after we have called fgComputeEdgeWeights
3462     bool                 fgHaveValidEdgeWeights;   // true if we were successful in computing all of the edge weights
3463     bool                 fgSlopUsedInEdgeWeights;  // true if their was some slop used when computing the edge weights
3464     bool                 fgRangeUsedInEdgeWeights; // true if some of the edgeWeight are expressed in Min..Max form
3465     bool                 fgNeedsUpdateFlowGraph;   // true if we need to run fgUpdateFlowGraph
3466     BasicBlock::weight_t fgCalledWeight;           // count of the number of times this method was called
3467                                                    // This is derived from the profile data
3468                                                    // or is BB_UNITY_WEIGHT when we don't have profile data
3469
3470 #if FEATURE_EH_FUNCLETS
3471     bool fgFuncletsCreated; // true if the funclet creation phase has been run
3472 #endif                      // FEATURE_EH_FUNCLETS
3473
3474     bool fgGlobalMorph;  // indicates if we are during the global morphing phase
3475                          // since fgMorphTree can be called from several places
3476     bool fgExpandInline; // indicates that we are creating tree for the inliner
3477
3478     bool     impBoxTempInUse; // the temp below is valid and available
3479     unsigned impBoxTemp;      // a temporary that is used for boxing
3480
3481 #ifdef DEBUG
3482     bool jitFallbackCompile; // Are we doing a fallback compile? That is, have we executed a NO_WAY assert,
3483                              //   and we are trying to compile again in a "safer", minopts mode?
3484 #endif
3485
3486 #if defined(DEBUG)
3487     unsigned impInlinedCodeSize;
3488 #endif
3489
3490     //-------------------------------------------------------------------------
3491
3492     void fgInit();
3493
3494     void fgImport();
3495
3496     void fgInline();
3497
3498     void fgRemoveEmptyTry();
3499
3500     void fgRemoveEmptyFinally();
3501
3502     void fgCloneFinally();
3503
3504     void fgCleanupContinuation(BasicBlock* continuation);
3505
3506     GenTreePtr fgGetCritSectOfStaticMethod();
3507
3508 #if !defined(_TARGET_X86_)
3509
3510     void fgAddSyncMethodEnterExit();
3511
3512     GenTree* fgCreateMonitorTree(unsigned lvaMonitorBool, unsigned lvaThisVar, BasicBlock* block, bool enter);
3513
3514     void fgConvertSyncReturnToLeave(BasicBlock* block);
3515
3516 #endif // !_TARGET_X86_
3517
3518     void fgAddReversePInvokeEnterExit();
3519
3520     bool fgMoreThanOneReturnBlock();
3521
3522     // The number of separate return points in the method.
3523     unsigned fgReturnCount;
3524
3525     void fgAddInternal();
3526
3527     bool fgFoldConditional(BasicBlock* block);
3528
3529     void fgMorphStmts(BasicBlock* block, bool* mult, bool* lnot, bool* loadw);
3530     void fgMorphBlocks();
3531
3532     bool fgMorphBlockStmt(BasicBlock* block, GenTreeStmt* stmt DEBUGARG(const char* msg));
3533
3534     void fgCheckArgCnt();
3535     void fgSetOptions();
3536
3537 #ifdef DEBUG
3538     static fgWalkPreFn fgAssertNoQmark;
3539     void fgPreExpandQmarkChecks(GenTreePtr expr);
3540     void        fgPostExpandQmarkChecks();
3541     static void fgCheckQmarkAllowedForm(GenTreePtr tree);
3542 #endif
3543
3544     IL_OFFSET fgFindBlockILOffset(BasicBlock* block);
3545
3546     BasicBlock* fgSplitBlockAtBeginning(BasicBlock* curr);
3547     BasicBlock* fgSplitBlockAtEnd(BasicBlock* curr);
3548     BasicBlock* fgSplitBlockAfterStatement(BasicBlock* curr, GenTree* stmt);
3549     BasicBlock* fgSplitBlockAfterNode(BasicBlock* curr, GenTree* node); // for LIR
3550     BasicBlock* fgSplitEdge(BasicBlock* curr, BasicBlock* succ);
3551
3552     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block, IL_OFFSETX offs);
3553     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree);
3554     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block);
3555     GenTreeStmt* fgNewStmtFromTree(GenTreePtr tree, IL_OFFSETX offs);
3556
3557     GenTreePtr fgGetTopLevelQmark(GenTreePtr expr, GenTreePtr* ppDst = nullptr);
3558     void fgExpandQmarkForCastInstOf(BasicBlock* block, GenTreePtr stmt);
3559     void fgExpandQmarkStmt(BasicBlock* block, GenTreePtr expr);
3560     void fgExpandQmarkNodes();
3561
3562     void fgMorph();
3563
3564     // Do "simple lowering."  This functionality is (conceptually) part of "general"
3565     // lowering that is distributed between fgMorph and the lowering phase of LSRA.
3566     void fgSimpleLowering();
3567
3568     bool fgShouldCreateAssignOp(GenTreePtr tree, bool* bReverse);
3569
3570     GenTreePtr fgInitThisClass();
3571
3572     GenTreePtr fgGetStaticsCCtorHelper(CORINFO_CLASS_HANDLE cls, CorInfoHelpFunc helper);
3573
3574     GenTreePtr fgGetSharedCCtor(CORINFO_CLASS_HANDLE cls);
3575
3576     void fgLocalVarLiveness();
3577
3578     void fgLocalVarLivenessInit();
3579
3580 #ifdef LEGACY_BACKEND
3581     GenTreePtr fgLegacyPerStatementLocalVarLiveness(GenTreePtr startNode, GenTreePtr relopNode);
3582 #else
3583     void fgPerNodeLocalVarLiveness(GenTree* node);
3584 #endif
3585     void fgPerBlockLocalVarLiveness();
3586
3587     VARSET_VALRET_TP fgGetHandlerLiveVars(BasicBlock* block);
3588
3589     void fgLiveVarAnalysis(bool updateInternalOnly = false);
3590
3591     // This is used in the liveness computation, as a temporary.  When we use the
3592     // arbitrary-length VarSet representation, it is better not to allocate a new one
3593     // at each call.
3594     VARSET_TP fgMarkIntfUnionVS;
3595
3596     bool fgMarkIntf(VARSET_VALARG_TP varSet);
3597
3598     bool fgMarkIntf(VARSET_VALARG_TP varSet1, VARSET_VALARG_TP varSet2);
3599
3600     void fgUpdateRefCntForClone(BasicBlock* addedToBlock, GenTreePtr clonedTree);
3601
3602     void fgUpdateRefCntForExtract(GenTreePtr wholeTree, GenTreePtr keptTree);
3603
3604     void fgComputeLifeCall(VARSET_TP& life, GenTreeCall* call);
3605
3606     bool fgComputeLifeLocal(VARSET_TP& life, VARSET_TP& keepAliveVars, GenTree* lclVarNode, GenTree* node);
3607
3608     VARSET_VALRET_TP fgComputeLife(VARSET_VALARG_TP life,
3609                                    GenTreePtr       startNode,
3610                                    GenTreePtr       endNode,
3611                                    VARSET_VALARG_TP volatileVars,
3612                                    bool* pStmtInfoDirty DEBUGARG(bool* treeModf));
3613
3614     VARSET_VALRET_TP fgComputeLifeLIR(VARSET_VALARG_TP life, BasicBlock* block, VARSET_VALARG_TP volatileVars);
3615
3616     bool fgRemoveDeadStore(GenTree**  pTree,
3617                            LclVarDsc* varDsc,
3618                            VARSET_TP  life,
3619                            bool*      doAgain,
3620                            bool* pStmtInfoDirty DEBUGARG(bool* treeModf));
3621
3622     bool fgTryRemoveDeadLIRStore(LIR::Range& blockRange, GenTree* node, GenTree** next);
3623
3624     // For updating liveset during traversal AFTER fgComputeLife has completed
3625     VARSET_VALRET_TP fgGetVarBits(GenTreePtr tree);
3626     VARSET_VALRET_TP fgUpdateLiveSet(VARSET_VALARG_TP liveSet, GenTreePtr tree);
3627
3628     // Returns the set of live variables after endTree,
3629     // assuming that liveSet is the set of live variables BEFORE tree.
3630     // Requires that fgComputeLife has completed, and that tree is in the same
3631     // statement as endTree, and that it comes before endTree in execution order
3632
3633     VARSET_VALRET_TP fgUpdateLiveSet(VARSET_VALARG_TP liveSet, GenTreePtr tree, GenTreePtr endTree)
3634     {
3635         VARSET_TP VARSET_INIT(this, newLiveSet, liveSet);
3636         while (tree != nullptr && tree != endTree->gtNext)
3637         {
3638             VarSetOps::AssignNoCopy(this, newLiveSet, fgUpdateLiveSet(newLiveSet, tree));
3639             tree = tree->gtNext;
3640         }
3641         assert(tree == endTree->gtNext);
3642         return newLiveSet;
3643     }
3644
3645     void fgInterBlockLocalVarLiveness();
3646
3647     // The presence of "x op= y" operations presents some difficulties for SSA: this is both a use of some SSA name of
3648     // "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
3649     // whether to treat that as the use or def.  It chooses the "use", and thus the old SSA name.  This map allows us
3650     // to record/recover the "def" SSA number, given the lcl var node for "x" in such a tree.
3651     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, unsigned, JitSimplerHashBehavior> NodeToUnsignedMap;
3652     NodeToUnsignedMap* m_opAsgnVarDefSsaNums;
3653     NodeToUnsignedMap* GetOpAsgnVarDefSsaNums()
3654     {
3655         if (m_opAsgnVarDefSsaNums == nullptr)
3656         {
3657             m_opAsgnVarDefSsaNums = new (getAllocator()) NodeToUnsignedMap(getAllocator());
3658         }
3659         return m_opAsgnVarDefSsaNums;
3660     }
3661
3662     // Requires value numbering phase to have completed. Returns the value number ("gtVN") of the
3663     // "tree," EXCEPT in the case of GTF_VAR_USEASG, because the tree node's gtVN member is the
3664     // "use" VN. Performs a lookup into the map of (use asg tree -> def VN.) to return the "def's"
3665     // VN.
3666     inline ValueNum GetUseAsgDefVNOrTreeVN(GenTreePtr tree);
3667
3668     // Requires that "lcl" has the GTF_VAR_DEF flag set.  Returns the SSA number of "lcl".
3669     // Except: assumes that lcl is a def, and if it is
3670     // a def appearing in "lcl op= rhs" (GTF_VAR_USEASG), looks up and returns the SSA number for the "def",
3671     // rather than the "use" SSA number recorded in the tree "lcl".
3672     inline unsigned GetSsaNumForLocalVarDef(GenTreePtr lcl);
3673
3674     // Some assignments assign to a local "indirectly": they are part of a comma expression that takes the address
3675     // of the local (or a field thereof), assigns this address to a temp, and uses an indirection of this temp as
3676     // the LHS of the assignment.  This actually arises in exactly one situation.  At the source level we assign one
3677     // struct local to another: "s1 = s2".  This becomes a copyblk.  If "s2" is promoted into  field variables "s2f0",
3678     // ..."s2fn", then the copyblk will morph to a comma expression that takes the address of "s1" and does field-wise
3679     // assignments:
3680     //   (byref addrS1 = &s1,
3681     //    *(addrS1 * offsetof(f0)) = s2f0,
3682     //    ...
3683     //    *(addrS1 * offsetof(fn)) = s2fn)
3684     //
3685     // It would be a shame, given the simple form at the source level, to be unable to track the values in the
3686     // fields of "s1" after this.  But "s1" does not appear in the assignments that modify it.  How, then, to
3687     // give it SSA names and value numbers?
3688     //
3689     // The solution is to use the side table described below to annotate each of the field-wise assignments at the
3690     // end with an instance of the structure below, whose fields are described in the declaration.
3691     struct IndirectAssignmentAnnotation
3692     {
3693         unsigned      m_lclNum;   // The local num that is being indirectly assigned.
3694         FieldSeqNode* m_fieldSeq; // If the LHS of the struct assignment is itself a struct field dereference,
3695                                   // as in "s0.g = s2", then "m_lclNum" would be "s0", and "m_fieldSeq" would
3696                                   // be the singleton field sequence "g".  The individual assignments would
3697                                   // further append the fields of "s.g" to that.
3698         bool m_isEntire;          // True iff this assignment writes all of m_lclNum.  (This can occur if the
3699                                   // structure has a single field).
3700         unsigned m_defSsaNum;     // The new SSA number of "m_lclNum" after the assignment.
3701         unsigned m_useSsaNum;     // Only valid if "m_isEntire" is false; if so, the SSA number of "m_lclNum" before the
3702                                   // assignment.
3703
3704         IndirectAssignmentAnnotation(unsigned      lclNum,
3705                                      FieldSeqNode* fldSeq,
3706                                      bool          isEntire,
3707                                      unsigned      defSsaNum = SsaConfig::RESERVED_SSA_NUM,
3708                                      unsigned      useSsaNum = SsaConfig::RESERVED_SSA_NUM)
3709             : m_lclNum(lclNum), m_fieldSeq(fldSeq), m_isEntire(isEntire), m_defSsaNum(defSsaNum), m_useSsaNum(useSsaNum)
3710         {
3711         }
3712     };
3713     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, IndirectAssignmentAnnotation*, JitSimplerHashBehavior>
3714                           NodeToIndirAssignMap;
3715     NodeToIndirAssignMap* m_indirAssignMap;
3716     NodeToIndirAssignMap* GetIndirAssignMap()
3717     {
3718         if (m_indirAssignMap == nullptr)
3719         {
3720             // Create a CompAllocator that labels sub-structure with CMK_IndirAssignMap, and use that for allocation.
3721             IAllocator* ialloc = new (this, CMK_IndirAssignMap) CompAllocator(this, CMK_IndirAssignMap);
3722             m_indirAssignMap   = new (ialloc) NodeToIndirAssignMap(ialloc);
3723         }
3724         return m_indirAssignMap;
3725     }
3726
3727     // Performs SSA conversion.
3728     void fgSsaBuild();
3729
3730     // Reset any data structures to the state expected by "fgSsaBuild", so it can be run again.
3731     void fgResetForSsa();
3732
3733     unsigned fgSsaPassesCompleted; // Number of times fgSsaBuild has been run.
3734
3735     // Returns "true" iff lcl "lclNum" should be excluded from SSA.
3736     inline bool fgExcludeFromSsa(unsigned lclNum);
3737
3738     // The value numbers for this compilation.
3739     ValueNumStore* vnStore;
3740
3741 public:
3742     ValueNumStore* GetValueNumStore()
3743     {
3744         return vnStore;
3745     }
3746
3747     // Do value numbering (assign a value number to each
3748     // tree node).
3749     void fgValueNumber();
3750
3751     // Updates "fgCurHeap" via the assignment H[elemTypeEq][arrVN][inx][fldSeq] = rhsVN.
3752     // Assumes that "elemTypeEq" is the (equivalence class rep) of the array element type.
3753     // The 'indType' is the indirection type of the lhs of the assignment and will typically
3754     // match the element type of the array or fldSeq.  When this type doesn't match
3755     // or if the fldSeq is 'NotAField' we invalidate the array contents H[elemTypeEq][arrVN]
3756     //
3757     void fgValueNumberArrIndexAssign(CORINFO_CLASS_HANDLE elemTypeEq,
3758                                      ValueNum             arrVN,
3759                                      ValueNum             inxVN,
3760                                      FieldSeqNode*        fldSeq,
3761                                      ValueNum             rhsVN,
3762                                      var_types            indType);
3763
3764     // Requires that "tree" is a GT_IND marked as an array index, and that its address argument
3765     // has been parsed to yield the other input arguments.  If evaluation of the address
3766     // can raise exceptions, those should be captured in the exception set "excVN."
3767     // Assumes that "elemTypeEq" is the (equivalence class rep) of the array element type.
3768     // Marks "tree" with the VN for H[elemTypeEq][arrVN][inx][fldSeq] (for the liberal VN; a new unique
3769     // VN for the conservative VN.)  Also marks the tree's argument as the address of an array element.
3770     // The type tree->TypeGet() will typically match the element type of the array or fldSeq.
3771     // When this type doesn't match or if the fldSeq is 'NotAField' we return a new unique VN
3772     //
3773     ValueNum fgValueNumberArrIndexVal(GenTreePtr           tree,
3774                                       CORINFO_CLASS_HANDLE elemTypeEq,
3775                                       ValueNum             arrVN,
3776                                       ValueNum             inxVN,
3777                                       ValueNum             excVN,
3778                                       FieldSeqNode*        fldSeq);
3779
3780     // Requires "funcApp" to be a VNF_PtrToArrElem, and "addrXvn" to represent the exception set thrown
3781     // by evaluating the array index expression "tree".  Returns the value number resulting from
3782     // dereferencing the array in the current heap state.  If "tree" is non-null, it must be the
3783     // "GT_IND" that does the dereference, and it is given the returned value number.
3784     ValueNum fgValueNumberArrIndexVal(GenTreePtr tree, struct VNFuncApp* funcApp, ValueNum addrXvn);
3785
3786     unsigned fgVNPassesCompleted; // Number of times fgValueNumber has been run.
3787
3788     // Utility functions for fgValueNumber.
3789
3790     // Perform value-numbering for the trees in "blk".
3791     void fgValueNumberBlock(BasicBlock* blk);
3792
3793     // Requires that "entryBlock" is the entry block of loop "loopNum", and that "loopNum" is the
3794     // innermost loop of which "entryBlock" is the entry.  Returns the value number that should be
3795     // assumed for the heap at the start "entryBlk".
3796     ValueNum fgHeapVNForLoopSideEffects(BasicBlock* entryBlock, unsigned loopNum);
3797
3798     // Called when an operation (performed by "tree", described by "msg") may cause the global Heap to be mutated.
3799     void fgMutateHeap(GenTreePtr tree DEBUGARG(const char* msg));
3800
3801     // Tree caused an update in the current heap VN.  If "tree" has an associated heap SSA #, record that
3802     // value in that SSA #.
3803     void fgValueNumberRecordHeapSsa(GenTreePtr tree);
3804
3805     // The input 'tree' is a leaf node that is a constant
3806     // Assign the proper value number to the tree
3807     void fgValueNumberTreeConst(GenTreePtr tree);
3808
3809     // Assumes that all inputs to "tree" have had value numbers assigned; assigns a VN to tree.
3810     // (With some exceptions: the VN of the lhs of an assignment is assigned as part of the
3811     // assignment.)
3812     // If "evalAsgLhsInd" is true, evaluate a GT_IND node, even if it's labeled as the LHS of
3813     // an assignment.
3814     void fgValueNumberTree(GenTreePtr tree, bool evalAsgLhsInd = false);
3815
3816     // Does value-numbering for a block assignment.
3817     void fgValueNumberBlockAssignment(GenTreePtr tree, bool evalAsgLhsInd);
3818
3819     // Does value-numbering for a cast tree.
3820     void fgValueNumberCastTree(GenTreePtr tree);
3821
3822     // Does value-numbering for an intrinsic tree.
3823     void fgValueNumberIntrinsic(GenTreePtr tree);
3824
3825     // Does value-numbering for a call.  We interpret some helper calls.
3826     void fgValueNumberCall(GenTreeCall* call);
3827
3828     // The VN of some nodes in "args" may have changed -- reassign VNs to the arg list nodes.
3829     void fgUpdateArgListVNs(GenTreeArgList* args);
3830
3831     // Does value-numbering for a helper "call" that has a VN function symbol "vnf".
3832     void fgValueNumberHelperCallFunc(GenTreeCall* call, VNFunc vnf, ValueNumPair vnpExc);
3833
3834     // Requires "helpCall" to be a helper call.  Assigns it a value number;
3835     // we understand the semantics of some of the calls.  Returns "true" if
3836     // the call may modify the heap (we assume arbitrary memory side effects if so).
3837     bool fgValueNumberHelperCall(GenTreeCall* helpCall);
3838
3839     // Requires "helpFunc" to be pure.  Returns the corresponding VNFunc.
3840     VNFunc fgValueNumberHelperMethVNFunc(CorInfoHelpFunc helpFunc);
3841
3842     // This is the current value number for the "Heap" implicit variable while
3843     // doing value numbering.  This is the value number under the "liberal" interpretation
3844     // of heap values; the "conservative" interpretation needs no VN, since every access of
3845     // the heap yields an unknown value.
3846     ValueNum fgCurHeapVN;
3847
3848     // Return a "pseudo"-class handle for an array element type.  If "elemType" is TYP_STRUCT,
3849     // requires "elemStructType" to be non-null (and to have a low-order zero).  Otherwise, low order bit
3850     // is 1, and the rest is an encoding of "elemTyp".
3851     static CORINFO_CLASS_HANDLE EncodeElemType(var_types elemTyp, CORINFO_CLASS_HANDLE elemStructType)
3852     {
3853         if (elemStructType != nullptr)
3854         {
3855             assert(varTypeIsStruct(elemTyp) || elemTyp == TYP_REF || elemTyp == TYP_BYREF ||
3856                    varTypeIsIntegral(elemTyp));
3857             assert((size_t(elemStructType) & 0x1) == 0x0); // Make sure the encoding below is valid.
3858             return elemStructType;
3859         }
3860         else
3861         {
3862             elemTyp = varTypeUnsignedToSigned(elemTyp);
3863             return CORINFO_CLASS_HANDLE(size_t(elemTyp) << 1 | 0x1);
3864         }
3865     }
3866     // If "clsHnd" is the result of an "EncodePrim" call, returns true and sets "*pPrimType" to the
3867     // var_types it represents.  Otherwise, returns TYP_STRUCT (on the assumption that "clsHnd" is
3868     // the struct type of the element).
3869     static var_types DecodeElemType(CORINFO_CLASS_HANDLE clsHnd)
3870     {
3871         size_t clsHndVal = size_t(clsHnd);
3872         if (clsHndVal & 0x1)
3873         {
3874             return var_types(clsHndVal >> 1);
3875         }
3876         else
3877         {
3878             return TYP_STRUCT;
3879         }
3880     }
3881
3882     // Convert a BYTE which represents the VM's CorInfoGCtype to the JIT's var_types
3883     var_types getJitGCType(BYTE gcType);
3884
3885     enum structPassingKind
3886     {
3887         SPK_Unknown,       // Invalid value, never returned
3888         SPK_PrimitiveType, // The struct is passed/returned using a primitive type.
3889         SPK_ByValue,       // The struct is passed/returned by value (using the ABI rules)
3890                            //  for ARM64 and UNIX_X64 in multiple registers. (when all of the
3891                            //   parameters registers are used, then the stack will be used)
3892                            //  for X86 passed on the stack, for ARM32 passed in registers
3893                            //   or the stack or split between registers and the stack.
3894         SPK_ByValueAsHfa,  // The struct is passed/returned as an HFA in multiple registers.
3895         SPK_ByReference
3896     }; // The struct is passed/returned by reference to a copy/buffer.
3897
3898     // Get the "primitive" type that is is used when we are given a struct of size 'structSize'.
3899     // For pointer sized structs the 'clsHnd' is used to determine if the struct contains GC ref.
3900     // A "primitive" type is one of the scalar types: byte, short, int, long, ref, float, double
3901     // If we can't or shouldn't use a "primitive" type then TYP_UNKNOWN is returned.
3902     //
3903     var_types getPrimitiveTypeForStruct(unsigned structSize, CORINFO_CLASS_HANDLE clsHnd);
3904
3905     // Get the type that is used to pass values of the given struct type.
3906     // If you have already retrieved the struct size then pass it as the optional third argument
3907     //
3908     var_types getArgTypeForStruct(CORINFO_CLASS_HANDLE clsHnd,
3909                                   structPassingKind*   wbPassStruct,
3910                                   unsigned             structSize = 0);
3911
3912     // Get the type that is used to return values of the given struct type.
3913     // If you have already retrieved the struct size then pass it as the optional third argument
3914     //
3915     var_types getReturnTypeForStruct(CORINFO_CLASS_HANDLE clsHnd,
3916                                      structPassingKind*   wbPassStruct = nullptr,
3917                                      unsigned             structSize   = 0);
3918
3919 #ifdef DEBUG
3920     // Print a representation of "vnp" or "vn" on standard output.
3921     // If "level" is non-zero, we also print out a partial expansion of the value.
3922     void vnpPrint(ValueNumPair vnp, unsigned level);
3923     void vnPrint(ValueNum vn, unsigned level);
3924 #endif
3925
3926     // Dominator computation member functions
3927     // Not exposed outside Compiler
3928 protected:
3929     bool fgDominate(BasicBlock* b1, BasicBlock* b2); // Return true if b1 dominates b2
3930
3931     bool fgReachable(BasicBlock* b1, BasicBlock* b2); // Returns true if block b1 can reach block b2
3932
3933     void fgComputeDoms(); // Computes the immediate dominators for each basic block in the
3934                           // flow graph.  We first assume the fields bbIDom on each
3935                           // basic block are invalid. This computation is needed later
3936                           // by fgBuildDomTree to build the dominance tree structure.
3937                           // Based on: A Simple, Fast Dominance Algorithm
3938                           // by Keith D. Cooper, Timothy J. Harvey, and Ken Kennedy
3939
3940     BlockSet_ValRet_T fgGetDominatorSet(BasicBlock* block); // Returns a set of blocks that dominate the given block.
3941     // Note: this is relatively slow compared to calling fgDominate(),
3942     // especially if dealing with a single block versus block check.
3943
3944     void fgComputeReachabilitySets(); // Compute bbReach sets. (Also sets BBF_GC_SAFE_POINT flag on blocks.)
3945
3946     void fgComputeEnterBlocksSet(); // Compute the set of entry blocks, 'fgEnterBlks'.
3947
3948     bool fgRemoveUnreachableBlocks(); // Remove blocks determined to be unreachable by the bbReach sets.
3949
3950     void fgComputeReachability(); // Perform flow graph node reachability analysis.
3951
3952     BasicBlock* fgIntersectDom(BasicBlock* a, BasicBlock* b); // Intersect two immediate dominator sets.
3953
3954     void fgDfsInvPostOrder(); // In order to compute dominance using fgIntersectDom, the flow graph nodes must be
3955                               // processed in topological sort, this function takes care of that.
3956
3957     void fgDfsInvPostOrderHelper(BasicBlock* block, BlockSet& visited, unsigned* count);
3958
3959     BlockSet_ValRet_T fgDomFindStartNodes(); // Computes which basic blocks don't have incoming edges in the flow graph.
3960                                              // Returns this as a set.
3961
3962     BlockSet_ValRet_T fgDomTreeEntryNodes(BasicBlockList** domTree); // Computes which nodes in the dominance forest are
3963                                                                      // root nodes. Returns this as a set.
3964
3965 #ifdef DEBUG
3966     void fgDispDomTree(BasicBlockList** domTree); // Helper that prints out the Dominator Tree in debug builds.
3967 #endif                                            // DEBUG
3968
3969     void fgBuildDomTree(); // Once we compute all the immediate dominator sets for each node in the flow graph
3970                            // (performed by fgComputeDoms), this procedure builds the dominance tree represented
3971                            // adjacency lists.
3972
3973     // In order to speed up the queries of the form 'Does A dominates B', we can perform a DFS preorder and postorder
3974     // traversal of the dominance tree and the dominance query will become A dominates B iif preOrder(A) <= preOrder(B)
3975     // && postOrder(A) >= postOrder(B) making the computation O(1).
3976     void fgTraverseDomTree(unsigned bbNum, BasicBlockList** domTree, unsigned* preNum, unsigned* postNum);
3977
3978     // When the flow graph changes, we need to update the block numbers, predecessor lists, reachability sets, and
3979     // dominators.
3980     void fgUpdateChangedFlowGraph();
3981
3982 public:
3983     // Compute the predecessors of the blocks in the control flow graph.
3984     void fgComputePreds();
3985
3986     // Remove all predecessor information.
3987     void fgRemovePreds();
3988
3989     // Compute the cheap flow graph predecessors lists. This is used in some early phases
3990     // before the full predecessors lists are computed.
3991     void fgComputeCheapPreds();
3992
3993 private:
3994     void fgAddCheapPred(BasicBlock* block, BasicBlock* blockPred);
3995
3996     void fgRemoveCheapPred(BasicBlock* block, BasicBlock* blockPred);
3997
3998 public:
3999     enum GCPollType
4000     {
4001         GCPOLL_NONE,
4002         GCPOLL_CALL,
4003         GCPOLL_INLINE
4004     };
4005
4006     // Initialize the per-block variable sets (used for liveness analysis).
4007     void fgInitBlockVarSets();
4008
4009     // true if we've gone through and created GC Poll calls.
4010     bool fgGCPollsCreated;
4011     void fgMarkGCPollBlocks();
4012     void fgCreateGCPolls();
4013     bool fgCreateGCPoll(GCPollType pollType, BasicBlock* block);
4014
4015     // Requires that "block" is a block that returns from
4016     // a finally.  Returns the number of successors (jump targets of
4017     // of blocks in the covered "try" that did a "LEAVE".)
4018     unsigned fgNSuccsOfFinallyRet(BasicBlock* block);
4019
4020     // Requires that "block" is a block that returns (in the sense of BBJ_EHFINALLYRET) from
4021     // a finally.  Returns its "i"th successor (jump targets of
4022     // of blocks in the covered "try" that did a "LEAVE".)
4023     // Requires that "i" < fgNSuccsOfFinallyRet(block).
4024     BasicBlock* fgSuccOfFinallyRet(BasicBlock* block, unsigned i);
4025
4026 private:
4027     // Factor out common portions of the impls of the methods above.
4028     void fgSuccOfFinallyRetWork(BasicBlock* block, unsigned i, BasicBlock** bres, unsigned* nres);
4029
4030 public:
4031     // For many purposes, it is desirable to be able to enumerate the *distinct* targets of a switch statement,
4032     // skipping duplicate targets.  (E.g., in flow analyses that are only interested in the set of possible targets.)
4033     // SwitchUniqueSuccSet contains the non-duplicated switch targets.
4034     // (Code that modifies the jump table of a switch has an obligation to call Compiler::UpdateSwitchTableTarget,
4035     // which in turn will call the "UpdateTarget" method of this type if a SwitchUniqueSuccSet has already
4036     // been computed for the switch block.  If a switch block is deleted or is transformed into a non-switch,
4037     // we leave the entry associated with the block, but it will no longer be accessed.)
4038     struct SwitchUniqueSuccSet
4039     {
4040         unsigned     numDistinctSuccs; // Number of distinct targets of the switch.
4041         BasicBlock** nonDuplicates;    // Array of "numDistinctSuccs", containing all the distinct switch target
4042                                        // successors.
4043
4044         // The switch block "switchBlk" just had an entry with value "from" modified to the value "to".
4045         // Update "this" as necessary: if "from" is no longer an element of the jump table of "switchBlk",
4046         // remove it from "this", and ensure that "to" is a member.  Use "alloc" to do any required allocation.
4047         void UpdateTarget(IAllocator* alloc, BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to);
4048     };
4049
4050     typedef SimplerHashTable<BasicBlock*, PtrKeyFuncs<BasicBlock>, SwitchUniqueSuccSet, JitSimplerHashBehavior>
4051         BlockToSwitchDescMap;
4052
4053 private:
4054     // Maps BasicBlock*'s that end in switch statements to SwitchUniqueSuccSets that allow
4055     // iteration over only the distinct successors.
4056     BlockToSwitchDescMap* m_switchDescMap;
4057
4058 public:
4059     BlockToSwitchDescMap* GetSwitchDescMap()
4060     {
4061         if (m_switchDescMap == nullptr)
4062         {
4063             m_switchDescMap = new (getAllocator()) BlockToSwitchDescMap(getAllocator());
4064         }
4065         return m_switchDescMap;
4066     }
4067
4068     // Invalidate the map of unique switch block successors. For example, since the hash key of the map
4069     // depends on block numbers, we must invalidate the map when the blocks are renumbered, to ensure that
4070     // we don't accidentally look up and return the wrong switch data.
4071     void InvalidateUniqueSwitchSuccMap()
4072     {
4073         m_switchDescMap = nullptr;
4074     }
4075
4076     // Requires "switchBlock" to be a block that ends in a switch.  Returns
4077     // the corresponding SwitchUniqueSuccSet.
4078     SwitchUniqueSuccSet GetDescriptorForSwitch(BasicBlock* switchBlk);
4079
4080     // The switch block "switchBlk" just had an entry with value "from" modified to the value "to".
4081     // Update "this" as necessary: if "from" is no longer an element of the jump table of "switchBlk",
4082     // remove it from "this", and ensure that "to" is a member.
4083     void UpdateSwitchTableTarget(BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to);
4084
4085     // Remove the "SwitchUniqueSuccSet" of "switchBlk" in the BlockToSwitchDescMap.
4086     void fgInvalidateSwitchDescMapEntry(BasicBlock* switchBlk);
4087
4088     BasicBlock* fgFirstBlockOfHandler(BasicBlock* block);
4089
4090     flowList* fgGetPredForBlock(BasicBlock* block, BasicBlock* blockPred);
4091
4092     flowList* fgGetPredForBlock(BasicBlock* block, BasicBlock* blockPred, flowList*** ptrToPred);
4093
4094     flowList* fgSpliceOutPred(BasicBlock* block, BasicBlock* blockPred);
4095
4096     flowList* fgRemoveRefPred(BasicBlock* block, BasicBlock* blockPred);
4097
4098     flowList* fgRemoveAllRefPreds(BasicBlock* block, BasicBlock* blockPred);
4099
4100     flowList* fgRemoveAllRefPreds(BasicBlock* block, flowList** ptrToPred);
4101
4102     void fgRemoveBlockAsPred(BasicBlock* block);
4103
4104     void fgChangeSwitchBlock(BasicBlock* oldSwitchBlock, BasicBlock* newSwitchBlock);
4105
4106     void fgReplaceSwitchJumpTarget(BasicBlock* blockSwitch, BasicBlock* newTarget, BasicBlock* oldTarget);
4107
4108     void fgReplaceJumpTarget(BasicBlock* block, BasicBlock* newTarget, BasicBlock* oldTarget);
4109
4110     void fgReplacePred(BasicBlock* block, BasicBlock* oldPred, BasicBlock* newPred);
4111
4112     flowList* fgAddRefPred(BasicBlock* block,
4113                            BasicBlock* blockPred,
4114                            flowList*   oldEdge           = nullptr,
4115                            bool        initializingPreds = false); // Only set to 'true' when we are computing preds in
4116                                                                    // fgComputePreds()
4117
4118     void fgFindBasicBlocks();
4119
4120     bool fgIsBetterFallThrough(BasicBlock* bCur, BasicBlock* bAlt);
4121
4122     bool fgCheckEHCanInsertAfterBlock(BasicBlock* blk, unsigned regionIndex, bool putInTryRegion);
4123
4124     BasicBlock* fgFindInsertPoint(unsigned    regionIndex,
4125                                   bool        putInTryRegion,
4126                                   BasicBlock* startBlk,
4127                                   BasicBlock* endBlk,
4128                                   BasicBlock* nearBlk,
4129                                   BasicBlock* jumpBlk,
4130                                   bool        runRarely);
4131
4132     unsigned fgGetNestingLevel(BasicBlock* block, unsigned* pFinallyNesting = nullptr);
4133
4134     void fgRemoveEmptyBlocks();
4135
4136     void fgRemoveStmt(BasicBlock* block, GenTreePtr stmt, bool updateRefCnt = true);
4137
4138     bool fgCheckRemoveStmt(BasicBlock* block, GenTreePtr stmt);
4139
4140     void fgCreateLoopPreHeader(unsigned lnum);
4141
4142     void fgUnreachableBlock(BasicBlock* block);
4143
4144     void fgRemoveConditionalJump(BasicBlock* block);
4145
4146     BasicBlock* fgLastBBInMainFunction();
4147
4148     BasicBlock* fgEndBBAfterMainFunction();
4149
4150     void fgUnlinkRange(BasicBlock* bBeg, BasicBlock* bEnd);
4151
4152     void fgRemoveBlock(BasicBlock* block, bool unreachable);
4153
4154     bool fgCanCompactBlocks(BasicBlock* block, BasicBlock* bNext);
4155
4156     void fgCompactBlocks(BasicBlock* block, BasicBlock* bNext);
4157
4158     void fgUpdateLoopsAfterCompacting(BasicBlock* block, BasicBlock* bNext);
4159
4160     BasicBlock* fgConnectFallThrough(BasicBlock* bSrc, BasicBlock* bDst);
4161
4162     bool fgRenumberBlocks();
4163
4164     bool fgExpandRarelyRunBlocks();
4165
4166     bool fgEhAllowsMoveBlock(BasicBlock* bBefore, BasicBlock* bAfter);
4167
4168     void fgMoveBlocksAfter(BasicBlock* bStart, BasicBlock* bEnd, BasicBlock* insertAfterBlk);
4169
4170     enum FG_RELOCATE_TYPE
4171     {
4172         FG_RELOCATE_TRY,    // relocate the 'try' region
4173         FG_RELOCATE_HANDLER // relocate the handler region (including the filter if necessary)
4174     };
4175     BasicBlock* fgRelocateEHRange(unsigned regionIndex, FG_RELOCATE_TYPE relocateType);
4176
4177 #if FEATURE_EH_FUNCLETS
4178 #if defined(_TARGET_ARM_)
4179     void fgClearFinallyTargetBit(BasicBlock* block);
4180 #endif // defined(_TARGET_ARM_)
4181     bool fgIsIntraHandlerPred(BasicBlock* predBlock, BasicBlock* block);
4182     bool fgAnyIntraHandlerPreds(BasicBlock* block);
4183     void fgInsertFuncletPrologBlock(BasicBlock* block);
4184     void fgCreateFuncletPrologBlocks();
4185     void fgCreateFunclets();
4186 #else  // !FEATURE_EH_FUNCLETS
4187     bool fgRelocateEHRegions();
4188 #endif // !FEATURE_EH_FUNCLETS
4189
4190     bool fgOptimizeUncondBranchToSimpleCond(BasicBlock* block, BasicBlock* target);
4191
4192     bool fgBlockEndFavorsTailDuplication(BasicBlock* block);
4193
4194     bool fgBlockIsGoodTailDuplicationCandidate(BasicBlock* block);
4195
4196     bool fgOptimizeFallthroughTailDup(BasicBlock* block, BasicBlock* target);
4197
4198     bool fgOptimizeEmptyBlock(BasicBlock* block);
4199
4200     bool fgOptimizeBranchToEmptyUnconditional(BasicBlock* block, BasicBlock* bDest);
4201
4202     bool fgOptimizeBranch(BasicBlock* bJump);
4203
4204     bool fgOptimizeSwitchBranches(BasicBlock* block);
4205
4206     bool fgOptimizeBranchToNext(BasicBlock* block, BasicBlock* bNext, BasicBlock* bPrev);
4207
4208     bool fgOptimizeSwitchJumps();
4209 #ifdef DEBUG
4210     void fgPrintEdgeWeights();
4211 #endif
4212     void fgComputeEdgeWeights();
4213
4214     void fgReorderBlocks();
4215
4216     void fgDetermineFirstColdBlock();
4217
4218     bool fgIsForwardBranch(BasicBlock* bJump, BasicBlock* bSrc = nullptr);
4219
4220     bool fgUpdateFlowGraph(bool doTailDup = false);
4221
4222     void fgFindOperOrder();
4223
4224     // method that returns if you should split here
4225     typedef bool(fgSplitPredicate)(GenTree* tree, GenTree* parent, fgWalkData* data);
4226
4227     void fgSetBlockOrder();
4228
4229     void fgRemoveReturnBlock(BasicBlock* block);
4230
4231     /* Helper code that has been factored out */
4232     inline void fgConvertBBToThrowBB(BasicBlock* block);
4233
4234     bool fgCastNeeded(GenTreePtr tree, var_types toType);
4235     GenTreePtr fgDoNormalizeOnStore(GenTreePtr tree);
4236     GenTreePtr fgMakeTmpArgNode(
4237         unsigned tmpVarNum FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(const bool passedInRegisters));
4238
4239     // The following check for loops that don't execute calls
4240     bool fgLoopCallMarked;
4241
4242     void fgLoopCallTest(BasicBlock* srcBB, BasicBlock* dstBB);
4243     void fgLoopCallMark();
4244
4245     void fgMarkLoopHead(BasicBlock* block);
4246
4247     unsigned fgGetCodeEstimate(BasicBlock* block);
4248
4249 #if DUMP_FLOWGRAPHS
4250     const char* fgProcessEscapes(const char* nameIn, escapeMapping_t* map);
4251     FILE* fgOpenFlowGraphFile(bool* wbDontClose, Phases phase, LPCWSTR type);
4252     bool fgDumpFlowGraph(Phases phase);
4253
4254 #endif // DUMP_FLOWGRAPHS
4255
4256 #ifdef DEBUG
4257     void fgDispDoms();
4258     void fgDispReach();
4259     void fgDispBBLiveness(BasicBlock* block);
4260     void fgDispBBLiveness();
4261     void fgTableDispBasicBlock(BasicBlock* block, int ibcColWidth = 0);
4262     void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
4263     void fgDispBasicBlocks(bool dumpTrees = false);
4264     void fgDumpStmtTree(GenTreePtr stmt, unsigned blkNum);
4265     void fgDumpBlock(BasicBlock* block);
4266     void fgDumpTrees(BasicBlock* firstBlock, BasicBlock* lastBlock);
4267
4268     static fgWalkPreFn fgStress64RsltMulCB;
4269     void               fgStress64RsltMul();
4270     void               fgDebugCheckUpdate();
4271     void fgDebugCheckBBlist(bool checkBBNum = false, bool checkBBRefs = true);
4272     void fgDebugCheckBlockLinks();
4273     void fgDebugCheckLinks(bool morphTrees = false);
4274     void fgDebugCheckNodeLinks(BasicBlock* block, GenTreePtr stmt);
4275     void fgDebugCheckFlags(GenTreePtr tree);
4276     void fgDebugCheckFlagsHelper(GenTreePtr tree, unsigned treeFlags, unsigned chkFlags);
4277     void fgDebugCheckTryFinallyExits();
4278 #endif
4279
4280 #ifdef LEGACY_BACKEND
4281     static void fgOrderBlockOps(GenTreePtr  tree,
4282                                 regMaskTP   reg0,
4283                                 regMaskTP   reg1,
4284                                 regMaskTP   reg2,
4285                                 GenTreePtr* opsPtr,   // OUT
4286                                 regMaskTP*  regsPtr); // OUT
4287 #endif                                                // LEGACY_BACKEND
4288
4289     static GenTreePtr fgGetFirstNode(GenTreePtr tree);
4290     static bool fgTreeIsInStmt(GenTree* tree, GenTreeStmt* stmt);
4291
4292     inline bool fgIsInlining()
4293     {
4294         return fgExpandInline;
4295     }
4296
4297     void fgTraverseRPO();
4298
4299     //--------------------- Walking the trees in the IR -----------------------
4300
4301     struct fgWalkData
4302     {
4303         Compiler*     compiler;
4304         fgWalkPreFn*  wtprVisitorFn;
4305         fgWalkPostFn* wtpoVisitorFn;
4306         void*         pCallbackData; // user-provided data
4307         bool          wtprLclsOnly;  // whether to only visit lclvar nodes
4308         GenTreePtr    parent;        // parent of current node, provided to callback
4309         GenTreeStack* parentStack;   // stack of parent nodes, if asked for
4310 #ifdef DEBUG
4311         bool printModified; // callback can use this
4312 #endif
4313     };
4314
4315     template <bool      computeStack>
4316     static fgWalkResult fgWalkTreePreRec(GenTreePtr* pTree, fgWalkData* fgWalkPre);
4317
4318     // general purpose tree-walker that is capable of doing pre- and post- order
4319     // callbacks at the same time
4320     template <bool doPreOrder, bool doPostOrder>
4321     static fgWalkResult fgWalkTreeRec(GenTreePtr* pTree, fgWalkData* fgWalkPre);
4322
4323     fgWalkResult fgWalkTreePre(GenTreePtr*  pTree,
4324                                fgWalkPreFn* visitor,
4325                                void*        pCallBackData = nullptr,
4326                                bool         lclVarsOnly   = false,
4327                                bool         computeStack  = false);
4328
4329     fgWalkResult fgWalkTree(GenTreePtr*   pTree,
4330                             fgWalkPreFn*  preVisitor,
4331                             fgWalkPostFn* postVisitor,
4332                             void*         pCallBackData = nullptr);
4333
4334     void fgWalkAllTreesPre(fgWalkPreFn* visitor, void* pCallBackData);
4335
4336     //----- Postorder
4337
4338     template <bool      computeStack>
4339     static fgWalkResult fgWalkTreePostRec(GenTreePtr* pTree, fgWalkData* fgWalkPre);
4340
4341     fgWalkResult fgWalkTreePost(GenTreePtr*   pTree,
4342                                 fgWalkPostFn* visitor,
4343                                 void*         pCallBackData = nullptr,
4344                                 bool          computeStack  = false);
4345
4346     // An fgWalkPreFn that looks for expressions that have inline throws in
4347     // minopts mode. Basically it looks for tress with gtOverflowEx() or
4348     // GTF_IND_RNGCHK.  It returns WALK_ABORT if one is found.  It
4349     // returns WALK_SKIP_SUBTREES if GTF_EXCEPT is not set (assumes flags
4350     // properly propagated to parent trees).  It returns WALK_CONTINUE
4351     // otherwise.
4352     static fgWalkResult fgChkThrowCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4353     static fgWalkResult fgChkLocAllocCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4354     static fgWalkResult fgChkQmarkCB(GenTreePtr* pTree, Compiler::fgWalkData* data);
4355
4356     /**************************************************************************
4357      *                          PROTECTED
4358      *************************************************************************/
4359
4360 protected:
4361     friend class SsaBuilder;
4362     friend struct ValueNumberState;
4363
4364     //--------------------- Detect the basic blocks ---------------------------
4365
4366     BasicBlock** fgBBs; // Table of pointers to the BBs
4367
4368     void        fgInitBBLookup();
4369     BasicBlock* fgLookupBB(unsigned addr);
4370
4371     void fgMarkJumpTarget(BYTE* jumpTarget, IL_OFFSET offs);
4372
4373     void fgFindJumpTargets(const BYTE* codeAddr, IL_OFFSET codeSize, BYTE* jumpTarget);
4374
4375     void fgMarkBackwardJump(BasicBlock* startBlock, BasicBlock* endBlock);
4376
4377     void fgLinkBasicBlocks();
4378
4379     unsigned fgMakeBasicBlocks(const BYTE* codeAddr, IL_OFFSET codeSize, BYTE* jumpTarget);
4380
4381     void fgCheckBasicBlockControlFlow();
4382
4383     void fgControlFlowPermitted(BasicBlock* blkSrc,
4384                                 BasicBlock* blkDest,
4385                                 BOOL        IsLeave = false /* is the src a leave block */);
4386
4387     bool fgFlowToFirstBlockOfInnerTry(BasicBlock* blkSrc, BasicBlock* blkDest, bool sibling);
4388
4389     void fgObserveInlineConstants(OPCODE opcode, const FgStack& stack, bool isInlining);
4390
4391     void fgAdjustForAddressExposedOrWrittenThis();
4392
4393     bool                        fgProfileData_ILSizeMismatch;
4394     ICorJitInfo::ProfileBuffer* fgProfileBuffer;
4395     ULONG                       fgProfileBufferCount;
4396     ULONG                       fgNumProfileRuns;
4397
4398     unsigned fgStressBBProf()
4399     {
4400 #ifdef DEBUG
4401         unsigned result = JitConfig.JitStressBBProf();
4402         if (result == 0)
4403         {
4404             if (compStressCompile(STRESS_BB_PROFILE, 15))
4405             {
4406                 result = 1;
4407             }
4408         }
4409         return result;
4410 #else
4411         return 0;
4412 #endif
4413     }
4414
4415     bool fgHaveProfileData();
4416     bool fgGetProfileWeightForBasicBlock(IL_OFFSET offset, unsigned* weight);
4417
4418     bool fgIsUsingProfileWeights()
4419     {
4420         return (fgHaveProfileData() || fgStressBBProf());
4421     }
4422     void fgInstrumentMethod();
4423
4424 //-------- Insert a statement at the start or end of a basic block --------
4425
4426 #ifdef DEBUG
4427 public:
4428     static bool fgBlockContainsStatementBounded(BasicBlock* block, GenTree* stmt, bool answerOnBoundExceeded = true);
4429 #endif
4430
4431 public:
4432     GenTreeStmt* fgInsertStmtAtEnd(BasicBlock* block, GenTreePtr node);
4433
4434 public: // Used by linear scan register allocation
4435     GenTreeStmt* fgInsertStmtNearEnd(BasicBlock* block, GenTreePtr node);
4436
4437 private:
4438     GenTreePtr fgInsertStmtAtBeg(BasicBlock* block, GenTreePtr stmt);
4439     GenTreePtr fgInsertStmtAfter(BasicBlock* block, GenTreePtr insertionPoint, GenTreePtr stmt);
4440
4441 public: // Used by linear scan register allocation
4442     GenTreePtr fgInsertStmtBefore(BasicBlock* block, GenTreePtr insertionPoint, GenTreePtr stmt);
4443
4444 private:
4445     GenTreePtr fgInsertStmtListAfter(BasicBlock* block, GenTreePtr stmtAfter, GenTreePtr stmtList);
4446
4447     GenTreePtr fgMorphSplitTree(GenTree** splitPoint, GenTree* stmt, BasicBlock* blk);
4448
4449     //                  Create a new temporary variable to hold the result of *ppTree,
4450     //                  and transform the graph accordingly.
4451     GenTree* fgInsertCommaFormTemp(GenTree** ppTree, CORINFO_CLASS_HANDLE structType = nullptr);
4452     GenTree* fgMakeMultiUse(GenTree** ppTree);
4453
4454 private:
4455     //                  Recognize a bitwise rotation pattern and convert into a GT_ROL or a GT_ROR node.
4456     GenTreePtr fgRecognizeAndMorphBitwiseRotation(GenTreePtr tree);
4457     bool fgOperIsBitwiseRotationRoot(genTreeOps oper);
4458
4459     //-------- Determine the order in which the trees will be evaluated -------
4460
4461     unsigned fgTreeSeqNum;
4462     GenTree* fgTreeSeqLst;
4463     GenTree* fgTreeSeqBeg;
4464
4465     GenTree* fgSetTreeSeq(GenTree* tree, GenTree* prev = nullptr, bool isLIR = false);
4466     void fgSetTreeSeqHelper(GenTree* tree, bool isLIR);
4467     void fgSetTreeSeqFinish(GenTreePtr tree, bool isLIR);
4468     void fgSetStmtSeq(GenTree* tree);
4469     void fgSetBlockOrder(BasicBlock* block);
4470
4471     //------------------------- Morphing --------------------------------------
4472
4473     unsigned fgPtrArgCntCur;
4474     unsigned fgPtrArgCntMax;
4475     hashBv*  fgOutgoingArgTemps;
4476     hashBv*  fgCurrentlyInUseArgTemps;
4477
4478     bool compCanEncodePtrArgCntMax();
4479
4480     void fgSetRngChkTarget(GenTreePtr tree, bool delay = true);
4481
4482 #if REARRANGE_ADDS
4483     void fgMoveOpsLeft(GenTreePtr tree);
4484 #endif
4485
4486     bool fgIsCommaThrow(GenTreePtr tree, bool forFolding = false);
4487
4488     bool fgIsThrow(GenTreePtr tree);
4489
4490     bool fgInDifferentRegions(BasicBlock* blk1, BasicBlock* blk2);
4491     bool fgIsBlockCold(BasicBlock* block);
4492
4493     GenTreePtr fgMorphCastIntoHelper(GenTreePtr tree, int helper, GenTreePtr oper);
4494
4495     GenTreePtr fgMorphIntoHelperCall(GenTreePtr tree, int helper, GenTreeArgList* args);
4496
4497     GenTreePtr fgMorphStackArgForVarArgs(unsigned lclNum, var_types varType, unsigned lclOffs);
4498
4499     bool fgMorphRelopToQmark(GenTreePtr tree);
4500
4501     // A "MorphAddrContext" carries information from the surrounding context.  If we are evaluating a byref address,
4502     // it is useful to know whether the address will be immediately dereferenced, or whether the address value will
4503     // be used, perhaps by passing it as an argument to a called method.  This affects how null checking is done:
4504     // for sufficiently small offsets, we can rely on OS page protection to implicitly null-check addresses that we
4505     // know will be dereferenced.  To know that reliance on implicit null checking is sound, we must further know that
4506     // all offsets between the top-level indirection and the bottom are constant, and that their sum is sufficiently
4507     // small; hence the other fields of MorphAddrContext.
4508     enum MorphAddrContextKind
4509     {
4510         MACK_Ind,
4511         MACK_Addr,
4512     };
4513     struct MorphAddrContext
4514     {
4515         MorphAddrContextKind m_kind;
4516         bool                 m_allConstantOffsets; // Valid only for "m_kind == MACK_Ind".  True iff all offsets between
4517                                                    // top-level indirection and here have been constants.
4518         size_t m_totalOffset; // Valid only for "m_kind == MACK_Ind", and if "m_allConstantOffsets" is true.
4519                               // In that case, is the sum of those constant offsets.
4520
4521         MorphAddrContext(MorphAddrContextKind kind) : m_kind(kind), m_allConstantOffsets(true), m_totalOffset(0)
4522         {
4523         }
4524     };
4525
4526     // A MACK_CopyBlock context is immutable, so we can just make one of these and share it.
4527     static MorphAddrContext s_CopyBlockMAC;
4528
4529 #ifdef FEATURE_SIMD
4530     GenTreePtr fgCopySIMDNode(GenTreeSIMD* simdNode);
4531     GenTreePtr getSIMDStructFromField(GenTreePtr tree,
4532                                       var_types* baseTypeOut,
4533                                       unsigned*  indexOut,
4534                                       unsigned*  simdSizeOut,
4535                                       bool       ignoreUsedInSIMDIntrinsic = false);
4536     GenTreePtr fgMorphFieldAssignToSIMDIntrinsicSet(GenTreePtr tree);
4537     GenTreePtr fgMorphFieldToSIMDIntrinsicGet(GenTreePtr tree);
4538     bool fgMorphCombineSIMDFieldAssignments(BasicBlock* block, GenTreePtr stmt);
4539     void impMarkContiguousSIMDFieldAssignments(GenTreePtr stmt);
4540
4541     // fgPreviousCandidateSIMDFieldAsgStmt is only used for tracking previous simd field assignment
4542     // in function: Complier::impMarkContiguousSIMDFieldAssignments.
4543     GenTreePtr fgPreviousCandidateSIMDFieldAsgStmt;
4544
4545 #endif // FEATURE_SIMD
4546     GenTreePtr fgMorphArrayIndex(GenTreePtr tree);
4547     GenTreePtr fgMorphCast(GenTreePtr tree);
4548     GenTreePtr fgUnwrapProxy(GenTreePtr objRef);
4549     GenTreeCall* fgMorphArgs(GenTreeCall* call);
4550
4551     void fgMakeOutgoingStructArgCopy(GenTreeCall*         call,
4552                                      GenTree*             args,
4553                                      unsigned             argIndex,
4554                                      CORINFO_CLASS_HANDLE copyBlkClass FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(
4555                                          const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* structDescPtr));
4556
4557     void fgFixupStructReturn(GenTreePtr call);
4558     GenTreePtr fgMorphLocalVar(GenTreePtr tree);
4559     bool fgAddrCouldBeNull(GenTreePtr addr);
4560     GenTreePtr fgMorphField(GenTreePtr tree, MorphAddrContext* mac);
4561     bool fgCanFastTailCall(GenTreeCall* call);
4562     void fgMorphTailCall(GenTreeCall* call);
4563     void fgMorphRecursiveFastTailCallIntoLoop(BasicBlock* block, GenTreeCall* recursiveTailCall);
4564     GenTreePtr fgAssignRecursiveCallArgToCallerParam(GenTreePtr       arg,
4565                                                      fgArgTabEntryPtr argTabEntry,
4566                                                      BasicBlock*      block,
4567                                                      IL_OFFSETX       callILOffset,
4568                                                      GenTreePtr       tmpAssignmentInsertionPoint,
4569                                                      GenTreePtr       paramAssignmentInsertionPoint);
4570     static int fgEstimateCallStackSize(GenTreeCall* call);
4571     GenTreePtr fgMorphCall(GenTreeCall* call);
4572     void fgMorphCallInline(GenTreeCall* call, InlineResult* result);
4573     void fgMorphCallInlineHelper(GenTreeCall* call, InlineResult* result);
4574 #if DEBUG
4575     void fgNoteNonInlineCandidate(GenTreeStmt* stmt, GenTreeCall* call);
4576     static fgWalkPreFn fgFindNonInlineCandidate;
4577 #endif
4578     GenTreePtr fgOptimizeDelegateConstructor(GenTreePtr call, CORINFO_CONTEXT_HANDLE* ExactContextHnd);
4579     GenTreePtr fgMorphLeaf(GenTreePtr tree);
4580     void fgAssignSetVarDef(GenTreePtr tree);
4581     GenTreePtr fgMorphOneAsgBlockOp(GenTreePtr tree);
4582     GenTreePtr fgMorphInitBlock(GenTreePtr tree);
4583     GenTreePtr fgMorphBlkToInd(GenTreeBlk* tree, var_types type);
4584     GenTreePtr fgMorphGetStructAddr(GenTreePtr* pTree, CORINFO_CLASS_HANDLE clsHnd, bool isRValue = false);
4585     GenTreePtr fgMorphBlkNode(GenTreePtr tree, bool isDest);
4586     GenTreePtr fgMorphBlockOperand(GenTreePtr tree, var_types asgType, unsigned blockWidth, bool isDest);
4587     void fgMorphUnsafeBlk(GenTreeObj* obj);
4588     GenTreePtr fgMorphCopyBlock(GenTreePtr tree);
4589     GenTreePtr fgMorphForRegisterFP(GenTreePtr tree);
4590     GenTreePtr fgMorphSmpOp(GenTreePtr tree, MorphAddrContext* mac = nullptr);
4591     GenTreePtr fgMorphSmpOpPre(GenTreePtr tree);
4592     GenTreePtr fgMorphModToSubMulDiv(GenTreeOp* tree);
4593     GenTreePtr fgMorphSmpOpOptional(GenTreeOp* tree);
4594     GenTreePtr fgMorphRecognizeBoxNullable(GenTree* compare);
4595
4596     GenTreePtr fgMorphToEmulatedFP(GenTreePtr tree);
4597     GenTreePtr fgMorphConst(GenTreePtr tree);
4598
4599 public:
4600     GenTreePtr fgMorphTree(GenTreePtr tree, MorphAddrContext* mac = nullptr);
4601
4602 private:
4603 #if LOCAL_ASSERTION_PROP
4604     void fgKillDependentAssertionsSingle(unsigned lclNum DEBUGARG(GenTreePtr tree));
4605     void fgKillDependentAssertions(unsigned lclNum DEBUGARG(GenTreePtr tree));
4606 #endif
4607     void fgMorphTreeDone(GenTreePtr tree, GenTreePtr oldTree = nullptr DEBUGARG(int morphNum = 0));
4608
4609     GenTreeStmt* fgMorphStmt;
4610
4611     unsigned fgGetBigOffsetMorphingTemp(var_types type); // We cache one temp per type to be
4612                                                          // used when morphing big offset.
4613
4614     //----------------------- Liveness analysis -------------------------------
4615
4616     VARSET_TP fgCurUseSet; // vars used     by block (before an assignment)
4617     VARSET_TP fgCurDefSet; // vars assigned by block (before a use)
4618
4619     bool fgCurHeapUse;   // True iff the current basic block uses the heap before defining it.
4620     bool fgCurHeapDef;   // True iff the current basic block defines the heap.
4621     bool fgCurHeapHavoc; // True if  the current basic block is known to set the heap to a "havoc" value.
4622
4623     void fgMarkUseDef(GenTreeLclVarCommon* tree);
4624
4625     void fgBeginScopeLife(VARSET_TP* inScope, VarScopeDsc* var);
4626     void fgEndScopeLife(VARSET_TP* inScope, VarScopeDsc* var);
4627
4628     void fgMarkInScope(BasicBlock* block, VARSET_VALARG_TP inScope);
4629     void fgUnmarkInScope(BasicBlock* block, VARSET_VALARG_TP unmarkScope);
4630
4631     void fgExtendDbgScopes();
4632     void fgExtendDbgLifetimes();
4633
4634 #ifdef DEBUG
4635     void fgDispDebugScopes();
4636 #endif // DEBUG
4637
4638     //-------------------------------------------------------------------------
4639     //
4640     //  The following keeps track of any code we've added for things like array
4641     //  range checking or explicit calls to enable GC, and so on.
4642     //
4643 public:
4644     struct AddCodeDsc
4645     {
4646         AddCodeDsc*     acdNext;
4647         BasicBlock*     acdDstBlk; // block  to  which we jump
4648         unsigned        acdData;
4649         SpecialCodeKind acdKind; // what kind of a special block is this?
4650         unsigned short  acdStkLvl;
4651     };
4652
4653 private:
4654     static unsigned acdHelper(SpecialCodeKind codeKind);
4655
4656     AddCodeDsc* fgAddCodeList;
4657     bool        fgAddCodeModf;
4658     bool        fgRngChkThrowAdded;
4659     AddCodeDsc* fgExcptnTargetCache[SCK_COUNT];
4660
4661     BasicBlock* fgRngChkTarget(BasicBlock* block, unsigned stkDepth, SpecialCodeKind kind);
4662
4663     BasicBlock* fgAddCodeRef(BasicBlock* srcBlk, unsigned refData, SpecialCodeKind kind, unsigned stkDepth = 0);
4664
4665 public:
4666     AddCodeDsc* fgFindExcptnTarget(SpecialCodeKind kind, unsigned refData);
4667
4668 private:
4669     bool fgIsCodeAdded();
4670
4671     bool fgIsThrowHlpBlk(BasicBlock* block);
4672     unsigned fgThrowHlpBlkStkLevel(BasicBlock* block);
4673
4674     unsigned fgBigOffsetMorphingTemps[TYP_COUNT];
4675
4676     unsigned fgCheckInlineDepthAndRecursion(InlineInfo* inlineInfo);
4677     void fgInvokeInlineeCompiler(GenTreeCall* call, InlineResult* result);
4678     void fgInsertInlineeBlocks(InlineInfo* pInlineInfo);
4679     GenTreePtr fgInlinePrependStatements(InlineInfo* inlineInfo);
4680     void fgInlineAppendStatements(InlineInfo* inlineInfo, BasicBlock* block, GenTreePtr stmt);
4681
4682 #if FEATURE_MULTIREG_RET
4683     GenTreePtr fgGetStructAsStructPtr(GenTreePtr tree);
4684     GenTreePtr fgAssignStructInlineeToVar(GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd);
4685     void fgAttachStructInlineeToAsg(GenTreePtr tree, GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd);
4686 #endif // FEATURE_MULTIREG_RET
4687
4688     static fgWalkPreFn fgUpdateInlineReturnExpressionPlaceHolder;
4689
4690 #ifdef DEBUG
4691     static fgWalkPreFn fgDebugCheckInlineCandidates;
4692 #endif
4693
4694     void         fgPromoteStructs();
4695     fgWalkResult fgMorphStructField(GenTreePtr tree, fgWalkData* fgWalkPre);
4696     fgWalkResult fgMorphLocalField(GenTreePtr tree, fgWalkData* fgWalkPre);
4697     void fgMarkImplicitByRefArgs();
4698     bool fgMorphImplicitByRefArgs(GenTree** pTree, fgWalkData* fgWalkPre);
4699     static fgWalkPreFn  fgMarkAddrTakenLocalsPreCB;
4700     static fgWalkPostFn fgMarkAddrTakenLocalsPostCB;
4701     void                fgMarkAddressExposedLocals();
4702     bool fgNodesMayInterfere(GenTree* store, GenTree* load);
4703
4704     // Returns true if the type of tree is of size at least "width", or if "tree" is not a
4705     // local variable.
4706     bool fgFitsInOrNotLoc(GenTreePtr tree, unsigned width);
4707
4708     // The given local variable, required to be a struct variable, is being assigned via
4709     // a "lclField", to make it masquerade as an integral type in the ABI.  Make sure that
4710     // the variable is not enregistered, and is therefore not promoted independently.
4711     void fgLclFldAssign(unsigned lclNum);
4712
4713     static fgWalkPreFn gtHasLocalsWithAddrOpCB;
4714     bool gtCanOptimizeTypeEquality(GenTreePtr tree);
4715     bool gtIsTypeHandleToRuntimeTypeHelper(GenTreePtr tree);
4716     bool gtIsActiveCSE_Candidate(GenTreePtr tree);
4717
4718 #ifdef DEBUG
4719     bool fgPrintInlinedMethods;
4720 #endif
4721
4722     bool fgIsBigOffset(size_t offset);
4723
4724     // The following are used when morphing special cases of integer div/mod operations and also by codegen
4725     bool fgIsSignedDivOptimizable(GenTreePtr divisor);
4726     bool fgIsUnsignedDivOptimizable(GenTreePtr divisor);
4727     bool fgIsSignedModOptimizable(GenTreePtr divisor);
4728     bool fgIsUnsignedModOptimizable(GenTreePtr divisor);
4729
4730     /*
4731     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4732     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4733     XX                                                                           XX
4734     XX                           Optimizer                                       XX
4735     XX                                                                           XX
4736     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4737     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4738     */
4739
4740 public:
4741     void optInit();
4742
4743 protected:
4744     LclVarDsc* optIsTrackedLocal(GenTreePtr tree);
4745
4746 public:
4747     void optRemoveRangeCheck(
4748         GenTreePtr tree, GenTreePtr stmt, bool updateCSEcounts, unsigned sideEffFlags = 0, bool forceRemove = false);
4749     bool optIsRangeCheckRemovable(GenTreePtr tree);
4750
4751 protected:
4752     static fgWalkPreFn optValidRangeCheckIndex;
4753     static fgWalkPreFn optRemoveTreeVisitor; // Helper passed to Compiler::fgWalkAllTreesPre() to decrement the LclVar
4754                                              // usage counts
4755
4756     void optRemoveTree(GenTreePtr deadTree, GenTreePtr keepList);
4757
4758     /**************************************************************************
4759      *
4760      *************************************************************************/
4761
4762 protected:
4763     // Do hoisting for all loops.
4764     void optHoistLoopCode();
4765
4766     // To represent sets of VN's that have already been hoisted in outer loops.
4767     typedef SimplerHashTable<ValueNum, SmallPrimitiveKeyFuncs<ValueNum>, bool, JitSimplerHashBehavior> VNToBoolMap;
4768     typedef VNToBoolMap VNSet;
4769
4770     struct LoopHoistContext
4771     {
4772     private:
4773         // The set of variables hoisted in the current loop (or nullptr if there are none).
4774         VNSet* m_pHoistedInCurLoop;
4775
4776     public:
4777         // Value numbers of expressions that have been hoisted in parent loops in the loop nest.
4778         VNSet m_hoistedInParentLoops;
4779         // Value numbers of expressions that have been hoisted in the current (or most recent) loop in the nest.
4780         // Previous decisions on loop-invariance of value numbers in the current loop.
4781         VNToBoolMap m_curLoopVnInvariantCache;
4782
4783         VNSet* GetHoistedInCurLoop(Compiler* comp)
4784         {
4785             if (m_pHoistedInCurLoop == nullptr)
4786             {
4787                 m_pHoistedInCurLoop = new (comp->getAllocatorLoopHoist()) VNSet(comp->getAllocatorLoopHoist());
4788             }
4789             return m_pHoistedInCurLoop;
4790         }
4791
4792         VNSet* ExtractHoistedInCurLoop()
4793         {
4794             VNSet* res          = m_pHoistedInCurLoop;
4795             m_pHoistedInCurLoop = nullptr;
4796             return res;
4797         }
4798
4799         LoopHoistContext(Compiler* comp)
4800             : m_pHoistedInCurLoop(nullptr)
4801             , m_hoistedInParentLoops(comp->getAllocatorLoopHoist())
4802             , m_curLoopVnInvariantCache(comp->getAllocatorLoopHoist())
4803         {
4804         }
4805     };
4806
4807     // Do hoisting for loop "lnum" (an index into the optLoopTable), and all loops nested within it.
4808     // Tracks the expressions that have been hoisted by containing loops by temporary recording their
4809     // value numbers in "m_hoistedInParentLoops".  This set is not modified by the call.
4810     void optHoistLoopNest(unsigned lnum, LoopHoistContext* hoistCtxt);
4811
4812     // Do hoisting for a particular loop ("lnum" is an index into the optLoopTable.)
4813     // Assumes that expressions have been hoisted in containing loops if their value numbers are in
4814     // "m_hoistedInParentLoops".
4815     //
4816     void optHoistThisLoop(unsigned lnum, LoopHoistContext* hoistCtxt);
4817
4818     // Hoist all expressions in "blk" that are invariant in loop "lnum" (an index into the optLoopTable)
4819     // outside of that loop.  Exempt expressions whose value number is in "m_hoistedInParentLoops"; add VN's of hoisted
4820     // expressions to "hoistInLoop".
4821     void optHoistLoopExprsForBlock(BasicBlock* blk, unsigned lnum, LoopHoistContext* hoistCtxt);
4822
4823     // Return true if the tree looks profitable to hoist out of loop 'lnum'.
4824     bool optIsProfitableToHoistableTree(GenTreePtr tree, unsigned lnum);
4825
4826     // Hoist all proper sub-expressions of "tree" (which occurs in "stmt", which occurs in "blk")
4827     // that are invariant in loop "lnum" (an index into the optLoopTable)
4828     // outside of that loop.  Exempt expressions whose value number is in "hoistedInParents"; add VN's of hoisted
4829     // expressions to "hoistInLoop".
4830     // Returns "true" iff "tree" is loop-invariant (wrt "lnum").
4831     // Assumes that the value of "*firstBlockAndBeforeSideEffect" indicates that we're in the first block, and before
4832     // any possible globally visible side effects.  Assume is called in evaluation order, and updates this.
4833     bool optHoistLoopExprsForTree(GenTreePtr        tree,
4834                                   unsigned          lnum,
4835                                   LoopHoistContext* hoistCtxt,
4836                                   bool*             firstBlockAndBeforeSideEffect,
4837                                   bool*             pHoistable);
4838
4839     // Performs the hoisting 'tree' into the PreHeader for loop 'lnum'
4840     void optHoistCandidate(GenTreePtr tree, unsigned lnum, LoopHoistContext* hoistCtxt);
4841
4842     // Returns true iff the ValueNum "vn" represents a value that is loop-invariant in "lnum".
4843     //   Constants and init values are always loop invariant.
4844     //   VNPhi's connect VN's to the SSA definition, so we can know if the SSA def occurs in the loop.
4845     bool optVNIsLoopInvariant(ValueNum vn, unsigned lnum, VNToBoolMap* recordedVNs);
4846
4847     // Returns "true" iff "tree" is valid at the head of loop "lnum", in the context of the hoist substitution
4848     // "subst".  If "tree" is a local SSA var, it is valid if its SSA definition occurs outside of the loop, or
4849     // if it is in the domain of "subst" (meaning that it's definition has been previously hoisted, with a "standin"
4850     // local.)  If tree is a constant, it is valid.  Otherwise, if it is an operator, it is valid iff its children are.
4851     bool optTreeIsValidAtLoopHead(GenTreePtr tree, unsigned lnum);
4852
4853     // If "blk" is the entry block of a natural loop, returns true and sets "*pLnum" to the index of the loop
4854     // in the loop table.
4855     bool optBlockIsLoopEntry(BasicBlock* blk, unsigned* pLnum);
4856
4857     // Records the set of "side effects" of all loops: fields (object instance and static)
4858     // written to, and SZ-array element type equivalence classes updated.
4859     void optComputeLoopSideEffects();
4860
4861 private:
4862     // Requires "lnum" to be the index of an outermost loop in the loop table.  Traverses the body of that loop,
4863     // including all nested loops, and records the set of "side effects" of the loop: fields (object instance and
4864     // static) written to, and SZ-array element type equivalence classes updated.
4865     void optComputeLoopNestSideEffects(unsigned lnum);
4866
4867     // Add the side effects of "blk" (which is required to be within a loop) to all loops of which it is a part.
4868     void optComputeLoopSideEffectsOfBlock(BasicBlock* blk);
4869
4870     // Hoist the expression "expr" out of loop "lnum".
4871     void optPerformHoistExpr(GenTreePtr expr, unsigned lnum);
4872
4873 public:
4874     void optOptimizeBools();
4875
4876 private:
4877     GenTree* optIsBoolCond(GenTree* condBranch, GenTree** compPtr, bool* boolPtr);
4878 #ifdef DEBUG
4879     void optOptimizeBoolsGcStress(BasicBlock* condBlock);
4880 #endif
4881 public:
4882     void optOptimizeLayout(); // Optimize the BasicBlock layout of the method
4883
4884     void optOptimizeLoops(); // for "while-do" loops duplicates simple loop conditions and transforms
4885                              // the loop into a "do-while" loop
4886                              // Also finds all natural loops and records them in the loop table
4887
4888     // Optionally clone loops in the loop table.
4889     void optCloneLoops();
4890
4891     // Clone loop "loopInd" in the loop table.
4892     void optCloneLoop(unsigned loopInd, LoopCloneContext* context);
4893
4894     // Ensure that loop "loopInd" has a unique head block.  (If the existing entry has
4895     // non-loop predecessors other than the head entry, create a new, empty block that goes (only) to the entry,
4896     // and redirects the preds of the entry to this new block.)  Sets the weight of the newly created block to
4897     // "ambientWeight".
4898     void optEnsureUniqueHead(unsigned loopInd, unsigned ambientWeight);
4899
4900     void optUnrollLoops(); // Unrolls loops (needs to have cost info)
4901
4902 protected:
4903     // This enumeration describes what is killed by a call.
4904
4905     enum callInterf
4906     {
4907         CALLINT_NONE,       // no interference                               (most helpers)
4908         CALLINT_REF_INDIRS, // kills GC ref indirections                     (SETFIELD OBJ)
4909         CALLINT_SCL_INDIRS, // kills non GC ref indirections                 (SETFIELD non-OBJ)
4910         CALLINT_ALL_INDIRS, // kills both GC ref and non GC ref indirections (SETFIELD STRUCT)
4911         CALLINT_ALL,        // kills everything                              (normal method call)
4912     };
4913
4914 public:
4915     // A "LoopDsc" describes a ("natural") loop.  We (currently) require the body of a loop to be a contiguous (in
4916     // bbNext order) sequence of basic blocks.  (At times, we may require the blocks in a loop to be "properly numbered"
4917     // in bbNext order; we use comparisons on the bbNum to decide order.)
4918     // The blocks that define the body are
4919     //   first <= top <= entry <= bottom   .
4920     // The "head" of the loop is a block outside the loop that has "entry" as a successor. We only support loops with a
4921     // single 'head' block. The meanings of these blocks are given in the definitions below. Also see the picture at
4922     // Compiler::optFindNaturalLoops().
4923     struct LoopDsc
4924     {
4925         BasicBlock* lpHead;  // HEAD of the loop (not part of the looping of the loop) -- has ENTRY as a successor.
4926         BasicBlock* lpFirst; // FIRST block (in bbNext order) reachable within this loop.  (May be part of a nested
4927                              // loop, but not the outer loop.)
4928         BasicBlock* lpTop;   // loop TOP (the back edge from lpBottom reaches here) (in most cases FIRST and TOP are the
4929                              // same)
4930         BasicBlock* lpEntry; // the ENTRY in the loop (in most cases TOP or BOTTOM)
4931         BasicBlock* lpBottom; // loop BOTTOM (from here we have a back edge to the TOP)
4932         BasicBlock* lpExit;   // if a single exit loop this is the EXIT (in most cases BOTTOM)
4933
4934         callInterf   lpAsgCall;     // "callInterf" for calls in the loop
4935         ALLVARSET_TP lpAsgVars;     // set of vars assigned within the loop (all vars, not just tracked)
4936         varRefKinds  lpAsgInds : 8; // set of inds modified within the loop
4937
4938         unsigned short lpFlags; // Mask of the LPFLG_* constants
4939
4940         unsigned char lpExitCnt; // number of exits from the loop
4941
4942         unsigned char lpParent;  // The index of the most-nested loop that completely contains this one,
4943                                  // or else BasicBlock::NOT_IN_LOOP if no such loop exists.
4944         unsigned char lpChild;   // The index of a nested loop, or else BasicBlock::NOT_IN_LOOP if no child exists.
4945                                  // (Actually, an "immediately" nested loop --
4946                                  // no other child of this loop is a parent of lpChild.)
4947         unsigned char lpSibling; // The index of another loop that is an immediate child of lpParent,
4948                                  // or else BasicBlock::NOT_IN_LOOP.  One can enumerate all the children of a loop
4949                                  // by following "lpChild" then "lpSibling" links.
4950
4951 #define LPFLG_DO_WHILE 0x0001 // it's a do-while loop (i.e ENTRY is at the TOP)
4952 #define LPFLG_ONE_EXIT 0x0002 // the loop has only one exit
4953
4954 #define LPFLG_ITER 0x0004      // for (i = icon or lclVar; test_condition(); i++)
4955 #define LPFLG_HOISTABLE 0x0008 // the loop is in a form that is suitable for hoisting expressions
4956 #define LPFLG_CONST 0x0010     // for (i=icon;i<icon;i++){ ... } - constant loop
4957
4958 #define LPFLG_VAR_INIT 0x0020   // iterator is initialized with a local var (var # found in lpVarInit)
4959 #define LPFLG_CONST_INIT 0x0040 // iterator is initialized with a constant (found in lpConstInit)
4960
4961 #define LPFLG_VAR_LIMIT 0x0100    // iterator is compared with a local var (var # found in lpVarLimit)
4962 #define LPFLG_CONST_LIMIT 0x0200  // iterator is compared with a constant (found in lpConstLimit)
4963 #define LPFLG_ARRLEN_LIMIT 0x0400 // iterator is compared with a.len or a[i].len (found in lpArrLenLimit)
4964 #define LPFLG_SIMD_LIMIT 0x0080   // iterator is compared with Vector<T>.Count (found in lpConstLimit)
4965
4966 #define LPFLG_HAS_PREHEAD 0x0800 // lpHead is known to be a preHead for this loop
4967 #define LPFLG_REMOVED 0x1000     // has been removed from the loop table (unrolled or optimized away)
4968 #define LPFLG_DONT_UNROLL 0x2000 // do not unroll this loop
4969
4970 #define LPFLG_ASGVARS_YES 0x4000 // "lpAsgVars" has been  computed
4971 #define LPFLG_ASGVARS_INC 0x8000 // "lpAsgVars" is incomplete -- vars beyond those representable in an AllVarSet
4972                                  // type are assigned to.
4973
4974         bool lpLoopHasHeapHavoc; // The loop contains an operation that we assume has arbitrary heap side effects.
4975                                  // If this is set, the fields below may not be accurate (since they become irrelevant.)
4976         bool lpContainsCall;     // True if executing the loop body *may* execute a call
4977
4978         VARSET_TP lpVarInOut;  // The set of variables that are IN or OUT during the execution of this loop
4979         VARSET_TP lpVarUseDef; // The set of variables that are USE or DEF during the execution of this loop
4980
4981         int lpHoistedExprCount; // The register count for the non-FP expressions from inside this loop that have been
4982                                 // hoisted
4983         int lpLoopVarCount;     // The register count for the non-FP LclVars that are read/written inside this loop
4984         int lpVarInOutCount;    // The register count for the non-FP LclVars that are alive inside or accross this loop
4985
4986         int lpHoistedFPExprCount; // The register count for the FP expressions from inside this loop that have been
4987                                   // hoisted
4988         int lpLoopVarFPCount;     // The register count for the FP LclVars that are read/written inside this loop
4989         int lpVarInOutFPCount;    // The register count for the FP LclVars that are alive inside or accross this loop
4990
4991         typedef SimplerHashTable<CORINFO_FIELD_HANDLE,
4992                                  PtrKeyFuncs<struct CORINFO_FIELD_STRUCT_>,
4993                                  bool,
4994                                  JitSimplerHashBehavior>
4995                         FieldHandleSet;
4996         FieldHandleSet* lpFieldsModified; // This has entries (mappings to "true") for all static field and object
4997                                           // instance fields modified
4998                                           // in the loop.
4999
5000         typedef SimplerHashTable<CORINFO_CLASS_HANDLE,
5001                                  PtrKeyFuncs<struct CORINFO_CLASS_STRUCT_>,
5002                                  bool,
5003                                  JitSimplerHashBehavior>
5004                         ClassHandleSet;
5005         ClassHandleSet* lpArrayElemTypesModified; // Bits set indicate the set of sz array element types such that
5006                                                   // arrays of that type are modified
5007                                                   // in the loop.
5008
5009         // Adds the variable liveness information for 'blk' to 'this' LoopDsc
5010         void AddVariableLiveness(Compiler* comp, BasicBlock* blk);
5011
5012         inline void AddModifiedField(Compiler* comp, CORINFO_FIELD_HANDLE fldHnd);
5013         // This doesn't *always* take a class handle -- it can also take primitive types, encoded as class handles
5014         // (shifted left, with a low-order bit set to distinguish.)
5015         // Use the {Encode/Decode}ElemType methods to construct/destruct these.
5016         inline void AddModifiedElemType(Compiler* comp, CORINFO_CLASS_HANDLE structHnd);
5017
5018         /* The following values are set only for iterator loops, i.e. has the flag LPFLG_ITER set */
5019
5020         GenTreePtr lpIterTree;    // The "i <op>= const" tree
5021         unsigned   lpIterVar();   // iterator variable #
5022         int        lpIterConst(); // the constant with which the iterator is incremented
5023         genTreeOps lpIterOper();  // the type of the operation on the iterator (ASG_ADD, ASG_SUB, etc.)
5024         void       VERIFY_lpIterTree();
5025
5026         var_types lpIterOperType(); // For overflow instructions
5027
5028         union {
5029             int lpConstInit; // initial constant value of iterator                           : Valid if LPFLG_CONST_INIT
5030             unsigned lpVarInit; // initial local var number to which we initialize the iterator : Valid if
5031                                 // LPFLG_VAR_INIT
5032         };
5033
5034         /* The following is for LPFLG_ITER loops only (i.e. the loop condition is "i RELOP const or var" */
5035
5036         GenTreePtr lpTestTree;   // pointer to the node containing the loop test
5037         genTreeOps lpTestOper(); // the type of the comparison between the iterator and the limit (GT_LE, GT_GE, etc.)
5038         void       VERIFY_lpTestTree();
5039
5040         bool       lpIsReversed(); // true if the iterator node is the second operand in the loop condition
5041         GenTreePtr lpIterator();   // the iterator node in the loop test
5042         GenTreePtr lpLimit();      // the limit node in the loop test
5043
5044         int lpConstLimit();    // limit   constant value of iterator - loop condition is "i RELOP const" : Valid if
5045                                // LPFLG_CONST_LIMIT
5046         unsigned lpVarLimit(); // the lclVar # in the loop condition ( "i RELOP lclVar" )                : Valid if
5047                                // LPFLG_VAR_LIMIT
5048         bool lpArrLenLimit(Compiler* comp, ArrIndex* index); // The array length in the loop condition ( "i RELOP
5049                                                              // arr.len" or "i RELOP arr[i][j].len" )  : Valid if
5050                                                              // LPFLG_ARRLEN_LIMIT
5051
5052         // Returns "true" iff "*this" contains the blk.
5053         bool lpContains(BasicBlock* blk)
5054         {
5055             return lpFirst->bbNum <= blk->bbNum && blk->bbNum <= lpBottom->bbNum;
5056         }
5057         // Returns "true" iff "*this" (properly) contains the range [first, bottom] (allowing firsts
5058         // to be equal, but requiring bottoms to be different.)
5059         bool lpContains(BasicBlock* first, BasicBlock* bottom)
5060         {
5061             return lpFirst->bbNum <= first->bbNum && bottom->bbNum < lpBottom->bbNum;
5062         }
5063
5064         // Returns "true" iff "*this" (properly) contains "lp2" (allowing firsts to be equal, but requiring
5065         // bottoms to be different.)
5066         bool lpContains(const LoopDsc& lp2)
5067         {
5068             return lpContains(lp2.lpFirst, lp2.lpBottom);
5069         }
5070
5071         // Returns "true" iff "*this" is (properly) contained by the range [first, bottom]
5072         // (allowing firsts to be equal, but requiring bottoms to be different.)
5073         bool lpContainedBy(BasicBlock* first, BasicBlock* bottom)
5074         {
5075             return first->bbNum <= lpFirst->bbNum && lpBottom->bbNum < bottom->bbNum;
5076         }
5077
5078         // Returns "true" iff "*this" is (properly) contained by "lp2"
5079         // (allowing firsts to be equal, but requiring bottoms to be different.)
5080         bool lpContainedBy(const LoopDsc& lp2)
5081         {
5082             return lpContains(lp2.lpFirst, lp2.lpBottom);
5083         }
5084
5085         // Returns "true" iff "*this" is disjoint from the range [top, bottom].
5086         bool lpDisjoint(BasicBlock* first, BasicBlock* bottom)
5087         {
5088             return bottom->bbNum < lpFirst->bbNum || lpBottom->bbNum < first->bbNum;
5089         }
5090         // Returns "true" iff "*this" is disjoint from "lp2".
5091         bool lpDisjoint(const LoopDsc& lp2)
5092         {
5093             return lpDisjoint(lp2.lpFirst, lp2.lpBottom);
5094         }
5095         // Returns "true" iff the loop is well-formed (see code for defn).
5096         bool lpWellFormed()
5097         {
5098             return lpFirst->bbNum <= lpTop->bbNum && lpTop->bbNum <= lpEntry->bbNum &&
5099                    lpEntry->bbNum <= lpBottom->bbNum &&
5100                    (lpHead->bbNum < lpTop->bbNum || lpHead->bbNum > lpBottom->bbNum);
5101         }
5102     };
5103
5104 protected:
5105     bool fgMightHaveLoop(); // returns true if there are any backedges
5106     bool fgHasLoops;        // True if this method has any loops, set in fgComputeReachability
5107
5108 public:
5109     LoopDsc       optLoopTable[MAX_LOOP_NUM]; // loop descriptor table
5110     unsigned char optLoopCount;               // number of tracked loops
5111
5112 protected:
5113     unsigned optCallCount;         // number of calls made in the method
5114     unsigned optIndirectCallCount; // number of virtual, interface and indirect calls made in the method
5115     unsigned optNativeCallCount;   // number of Pinvoke/Native calls made in the method
5116     unsigned optLoopsCloned;       // number of loops cloned in the current method.
5117
5118 #ifdef DEBUG
5119     unsigned optFindLoopNumberFromBeginBlock(BasicBlock* begBlk);
5120     void optPrintLoopInfo(unsigned      loopNum,
5121                           BasicBlock*   lpHead,
5122                           BasicBlock*   lpFirst,
5123                           BasicBlock*   lpTop,
5124                           BasicBlock*   lpEntry,
5125                           BasicBlock*   lpBottom,
5126                           unsigned char lpExitCnt,
5127                           BasicBlock*   lpExit,
5128                           unsigned      parentLoop = BasicBlock::NOT_IN_LOOP);
5129     void optPrintLoopInfo(unsigned lnum);
5130     void optPrintLoopRecording(unsigned lnum);
5131
5132     void optCheckPreds();
5133 #endif
5134
5135     void optSetBlockWeights();
5136
5137     void optMarkLoopBlocks(BasicBlock* begBlk, BasicBlock* endBlk, bool excludeEndBlk);
5138
5139     void optUnmarkLoopBlocks(BasicBlock* begBlk, BasicBlock* endBlk);
5140
5141     void optUpdateLoopsBeforeRemoveBlock(BasicBlock* block, bool skipUnmarkLoop = false);
5142
5143     bool optIsLoopTestEvalIntoTemp(GenTreePtr test, GenTreePtr* newTest);
5144     unsigned optIsLoopIncrTree(GenTreePtr incr);
5145     bool optCheckIterInLoopTest(unsigned loopInd, GenTreePtr test, BasicBlock* from, BasicBlock* to, unsigned iterVar);
5146     bool optComputeIterInfo(GenTreePtr incr, BasicBlock* from, BasicBlock* to, unsigned* pIterVar);
5147     bool optPopulateInitInfo(unsigned loopInd, GenTreePtr init, unsigned iterVar);
5148     bool optExtractInitTestIncr(BasicBlock* head,
5149                                 BasicBlock* bottom,
5150                                 BasicBlock* exit,
5151                                 GenTreePtr* ppInit,
5152                                 GenTreePtr* ppTest,
5153                                 GenTreePtr* ppIncr);
5154
5155     void optRecordLoop(BasicBlock*   head,
5156                        BasicBlock*   first,
5157                        BasicBlock*   top,
5158                        BasicBlock*   entry,
5159                        BasicBlock*   bottom,
5160                        BasicBlock*   exit,
5161                        unsigned char exitCnt);
5162
5163     void optFindNaturalLoops();
5164
5165     // Ensures that all the loops in the loop nest rooted at "loopInd" (an index into the loop table) are 'canonical' --
5166     // each loop has a unique "top."  Returns "true" iff the flowgraph has been modified.
5167     bool optCanonicalizeLoopNest(unsigned char loopInd);
5168
5169     // Ensures that the loop "loopInd" (an index into the loop table) is 'canonical' -- it has a unique "top,"
5170     // unshared with any other loop.  Returns "true" iff the flowgraph has been modified
5171     bool optCanonicalizeLoop(unsigned char loopInd);
5172
5173     // Requires "l1" to be a valid loop table index, and not "BasicBlock::NOT_IN_LOOP".  Requires "l2" to be
5174     // a valid loop table index, or else "BasicBlock::NOT_IN_LOOP".  Returns true
5175     // iff "l2" is not NOT_IN_LOOP, and "l1" contains "l2".
5176     bool optLoopContains(unsigned l1, unsigned l2);
5177
5178     // Requires "loopInd" to be a valid index into the loop table.
5179     // Updates the loop table by changing loop "loopInd", whose head is required
5180     // to be "from", to be "to".  Also performs this transformation for any
5181     // loop nested in "loopInd" that shares the same head as "loopInd".
5182     void optUpdateLoopHead(unsigned loopInd, BasicBlock* from, BasicBlock* to);
5183
5184     // Updates the successors of "blk": if "blk2" is a successor of "blk", and there is a mapping for "blk2->blk3" in
5185     // "redirectMap", change "blk" so that "blk3" is this successor. Note that the predecessor lists are not updated.
5186     void optRedirectBlock(BasicBlock* blk, BlockToBlockMap* redirectMap);
5187
5188     // Marks the containsCall information to "lnum" and any parent loops.
5189     void AddContainsCallAllContainingLoops(unsigned lnum);
5190     // Adds the variable liveness information from 'blk' to "lnum" and any parent loops.
5191     void AddVariableLivenessAllContainingLoops(unsigned lnum, BasicBlock* blk);
5192     // Adds "fldHnd" to the set of modified fields of "lnum" and any parent loops.
5193     void AddModifiedFieldAllContainingLoops(unsigned lnum, CORINFO_FIELD_HANDLE fldHnd);
5194     // Adds "elemType" to the set of modified array element types of "lnum" and any parent loops.
5195     void AddModifiedElemTypeAllContainingLoops(unsigned lnum, CORINFO_CLASS_HANDLE elemType);
5196
5197     // Requires that "from" and "to" have the same "bbJumpKind" (perhaps because "to" is a clone
5198     // of "from".)  Copies the jump destination from "from" to "to".
5199     void optCopyBlkDest(BasicBlock* from, BasicBlock* to);
5200
5201     // The depth of the loop described by "lnum" (an index into the loop table.) (0 == top level)
5202     unsigned optLoopDepth(unsigned lnum)
5203     {
5204         unsigned par = optLoopTable[lnum].lpParent;
5205         if (par == BasicBlock::NOT_IN_LOOP)
5206         {
5207             return 0;
5208         }
5209         else
5210         {
5211             return 1 + optLoopDepth(par);
5212         }
5213     }
5214
5215     void fgOptWhileLoop(BasicBlock* block);
5216
5217     bool optComputeLoopRep(int        constInit,
5218                            int        constLimit,
5219                            int        iterInc,
5220                            genTreeOps iterOper,
5221                            var_types  iterType,
5222                            genTreeOps testOper,
5223                            bool       unsignedTest,
5224                            bool       dupCond,
5225                            unsigned*  iterCount);
5226 #if FEATURE_STACK_FP_X87
5227
5228 public:
5229     VARSET_TP optAllFloatVars; // mask of all tracked      FP variables
5230     VARSET_TP optAllFPregVars; // mask of all enregistered FP variables
5231     VARSET_TP optAllNonFPvars; // mask of all tracked  non-FP variables
5232 #endif                         // FEATURE_STACK_FP_X87
5233
5234 private:
5235     static fgWalkPreFn optIsVarAssgCB;
5236
5237 protected:
5238     bool optIsVarAssigned(BasicBlock* beg, BasicBlock* end, GenTreePtr skip, unsigned var);
5239
5240     bool optIsVarAssgLoop(unsigned lnum, unsigned var);
5241
5242     int optIsSetAssgLoop(unsigned lnum, ALLVARSET_VALARG_TP vars, varRefKinds inds = VR_NONE);
5243
5244     bool optNarrowTree(GenTreePtr tree, var_types srct, var_types dstt, ValueNumPair vnpNarrow, bool doit);
5245
5246     /**************************************************************************
5247      *                       Optimization conditions
5248      *************************************************************************/
5249
5250     bool optFastCodeOrBlendedLoop(BasicBlock::weight_t bbWeight);
5251     bool optPentium4(void);
5252     bool optAvoidIncDec(BasicBlock::weight_t bbWeight);
5253     bool optAvoidIntMult(void);
5254
5255 #if FEATURE_ANYCSE
5256
5257 protected:
5258     //  The following is the upper limit on how many expressions we'll keep track
5259     //  of for the CSE analysis.
5260     //
5261     static const unsigned MAX_CSE_CNT = EXPSET_SZ;
5262
5263     static const int MIN_CSE_COST = 2;
5264
5265     // Keeps tracked cse indices
5266     BitVecTraits* cseTraits;
5267     EXPSET_TP     cseFull;
5268     EXPSET_TP     cseEmpty;
5269
5270     /* Generic list of nodes - used by the CSE logic */
5271
5272     struct treeLst
5273     {
5274         treeLst*   tlNext;
5275         GenTreePtr tlTree;
5276     };
5277
5278     typedef struct treeLst* treeLstPtr;
5279
5280     struct treeStmtLst
5281     {
5282         treeStmtLst* tslNext;
5283         GenTreePtr   tslTree;  // tree node
5284         GenTreePtr   tslStmt;  // statement containing the tree
5285         BasicBlock*  tslBlock; // block containing the statement
5286     };
5287
5288     typedef struct treeStmtLst* treeStmtLstPtr;
5289
5290     // The following logic keeps track of expressions via a simple hash table.
5291
5292     struct CSEdsc
5293     {
5294         CSEdsc* csdNextInBucket; // used by the hash table
5295
5296         unsigned csdHashValue; // the orginal hashkey
5297
5298         unsigned csdIndex;          // 1..optCSECandidateCount
5299         char     csdLiveAcrossCall; // 0 or 1
5300
5301         unsigned short csdDefCount; // definition   count
5302         unsigned short csdUseCount; // use          count  (excluding the implicit uses at defs)
5303
5304         unsigned csdDefWtCnt; // weighted def count
5305         unsigned csdUseWtCnt; // weighted use count  (excluding the implicit uses at defs)
5306
5307         GenTreePtr  csdTree;  // treenode containing the 1st occurance
5308         GenTreePtr  csdStmt;  // stmt containing the 1st occurance
5309         BasicBlock* csdBlock; // block containing the 1st occurance
5310
5311         treeStmtLstPtr csdTreeList; // list of matching tree nodes: head
5312         treeStmtLstPtr csdTreeLast; // list of matching tree nodes: tail
5313     };
5314
5315     static const size_t s_optCSEhashSize;
5316     CSEdsc**            optCSEhash;
5317     CSEdsc**            optCSEtab;
5318
5319     void optCSEstop();
5320
5321     CSEdsc* optCSEfindDsc(unsigned index);
5322     void optUnmarkCSE(GenTreePtr tree);
5323
5324     // user defined callback data for the tree walk function optCSE_MaskHelper()
5325     struct optCSE_MaskData
5326     {
5327         EXPSET_TP CSE_defMask;
5328         EXPSET_TP CSE_useMask;
5329     };
5330
5331     // Treewalk helper for optCSE_DefMask and optCSE_UseMask
5332     static fgWalkPreFn optCSE_MaskHelper;
5333
5334     // This function walks all the node for an given tree
5335     // and return the mask of CSE definitions and uses for the tree
5336     //
5337     void optCSE_GetMaskData(GenTreePtr tree, optCSE_MaskData* pMaskData);
5338
5339     // Given a binary tree node return true if it is safe to swap the order of evaluation for op1 and op2.
5340     bool optCSE_canSwap(GenTree* firstNode, GenTree* secondNode);
5341     bool optCSE_canSwap(GenTree* tree);
5342
5343     static fgWalkPostFn optPropagateNonCSE;
5344     static fgWalkPreFn  optHasNonCSEChild;
5345
5346     static fgWalkPreFn optUnmarkCSEs;
5347
5348     static int __cdecl optCSEcostCmpEx(const void* op1, const void* op2);
5349     static int __cdecl optCSEcostCmpSz(const void* op1, const void* op2);
5350
5351     void optCleanupCSEs();
5352
5353 #ifdef DEBUG
5354     void optEnsureClearCSEInfo();
5355 #endif // DEBUG
5356
5357 #endif // FEATURE_ANYCSE
5358
5359 #if FEATURE_VALNUM_CSE
5360     /**************************************************************************
5361      *                   Value Number based CSEs
5362      *************************************************************************/
5363
5364 public:
5365     void optOptimizeValnumCSEs();
5366
5367 protected:
5368     void     optValnumCSE_Init();
5369     unsigned optValnumCSE_Index(GenTreePtr tree, GenTreePtr stmt);
5370     unsigned optValnumCSE_Locate();
5371     void     optValnumCSE_InitDataFlow();
5372     void     optValnumCSE_DataFlow();
5373     void     optValnumCSE_Availablity();
5374     void     optValnumCSE_Heuristic();
5375     void optValnumCSE_UnmarkCSEs(GenTreePtr deadTree, GenTreePtr keepList);
5376
5377 #endif // FEATURE_VALNUM_CSE
5378
5379 #if FEATURE_ANYCSE
5380     bool     optDoCSE;             // True when we have found a duplicate CSE tree
5381     bool     optValnumCSE_phase;   // True when we are executing the optValnumCSE_phase
5382     unsigned optCSECandidateTotal; // Grand total of CSE candidates for both Lexical and ValNum
5383     unsigned optCSECandidateCount; // Count of CSE's candidates, reset for Lexical and ValNum CSE's
5384     unsigned optCSEstart;          // The first local variable number that is a CSE
5385     unsigned optCSEcount;          // The total count of CSE's introduced.
5386     unsigned optCSEweight;         // The weight of the current block when we are
5387                                    // scanning for CSE expressions
5388
5389     bool optIsCSEcandidate(GenTreePtr tree);
5390
5391     // lclNumIsTrueCSE returns true if the LclVar was introduced by the CSE phase of the compiler
5392     //
5393     bool lclNumIsTrueCSE(unsigned lclNum) const
5394     {
5395         return ((optCSEcount > 0) && (lclNum >= optCSEstart) && (lclNum < optCSEstart + optCSEcount));
5396     }
5397
5398     //  lclNumIsCSE returns true if the LclVar should be treated like a CSE with regards to constant prop.
5399     //
5400     bool lclNumIsCSE(unsigned lclNum) const
5401     {
5402         return lvaTable[lclNum].lvIsCSE;
5403     }
5404
5405 #ifdef DEBUG
5406     bool optConfigDisableCSE();
5407     bool optConfigDisableCSE2();
5408 #endif
5409     void optOptimizeCSEs();
5410
5411 #endif // FEATURE_ANYCSE
5412
5413     struct isVarAssgDsc
5414     {
5415         GenTreePtr ivaSkip;
5416 #ifdef DEBUG
5417         void* ivaSelf;
5418 #endif
5419         unsigned     ivaVar;            // Variable we are interested in, or -1
5420         ALLVARSET_TP ivaMaskVal;        // Set of variables assigned to.  This is a set of all vars, not tracked vars.
5421         bool         ivaMaskIncomplete; // Variables not representable in ivaMaskVal were assigned to.
5422         varRefKinds  ivaMaskInd;        // What kind of indirect assignments are there?
5423         callInterf   ivaMaskCall;       // What kind of calls are there?
5424     };
5425
5426     static callInterf optCallInterf(GenTreePtr call);
5427
5428 public:
5429     // VN based copy propagation.
5430     typedef ArrayStack<GenTreePtr> GenTreePtrStack;
5431     typedef SimplerHashTable<unsigned, SmallPrimitiveKeyFuncs<unsigned>, GenTreePtrStack*, JitSimplerHashBehavior>
5432         LclNumToGenTreePtrStack;
5433
5434     // Kill set to track variables with intervening definitions.
5435     VARSET_TP optCopyPropKillSet;
5436
5437     // Copy propagation functions.
5438     void optCopyProp(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree, LclNumToGenTreePtrStack* curSsaName);
5439     void optBlockCopyPropPopStacks(BasicBlock* block, LclNumToGenTreePtrStack* curSsaName);
5440     void optBlockCopyProp(BasicBlock* block, LclNumToGenTreePtrStack* curSsaName);
5441     bool optIsSsaLocal(GenTreePtr tree);
5442     int optCopyProp_LclVarScore(LclVarDsc* lclVarDsc, LclVarDsc* copyVarDsc, bool preferOp2);
5443     void optVnCopyProp();
5444
5445     /**************************************************************************
5446     *               Early value propagation
5447     *************************************************************************/
5448     struct SSAName
5449     {
5450         unsigned m_lvNum;
5451         unsigned m_ssaNum;
5452
5453         SSAName(unsigned lvNum, unsigned ssaNum) : m_lvNum(lvNum), m_ssaNum(ssaNum)
5454         {
5455         }
5456
5457         static unsigned GetHashCode(SSAName ssaNm)
5458         {
5459             return (ssaNm.m_lvNum << 16) | (ssaNm.m_ssaNum);
5460         }
5461
5462         static bool Equals(SSAName ssaNm1, SSAName ssaNm2)
5463         {
5464             return (ssaNm1.m_lvNum == ssaNm2.m_lvNum) && (ssaNm1.m_ssaNum == ssaNm2.m_ssaNum);
5465         }
5466     };
5467
5468 #define OMF_HAS_NEWARRAY 0x00000001  // Method contains 'new' of an array
5469 #define OMF_HAS_NEWOBJ 0x00000002    // Method contains 'new' of an object type.
5470 #define OMF_HAS_ARRAYREF 0x00000004  // Method contains array element loads or stores.
5471 #define OMF_HAS_VTABLEREF 0x00000008 // Method contains method table reference.
5472 #define OMF_HAS_NULLCHECK 0x00000010 // Method contains null check.
5473
5474     unsigned optMethodFlags;
5475
5476     // Recursion bound controls how far we can go backwards tracking for a SSA value.
5477     // No throughput diff was found with backward walk bound between 3-8.
5478     static const int optEarlyPropRecurBound = 5;
5479
5480     enum class optPropKind
5481     {
5482         OPK_INVALID,
5483         OPK_ARRAYLEN,
5484         OPK_OBJ_GETTYPE,
5485         OPK_NULLCHECK
5486     };
5487
5488     bool gtIsVtableRef(GenTreePtr tree);
5489     GenTreePtr getArrayLengthFromAllocation(GenTreePtr tree);
5490     GenTreePtr getObjectHandleNodeFromAllocation(GenTreePtr tree);
5491     GenTreePtr optPropGetValueRec(unsigned lclNum, unsigned ssaNum, optPropKind valueKind, int walkDepth);
5492     GenTreePtr optPropGetValue(unsigned lclNum, unsigned ssaNum, optPropKind valueKind);
5493     bool optEarlyPropRewriteTree(GenTreePtr tree);
5494     bool optDoEarlyPropForBlock(BasicBlock* block);
5495     bool optDoEarlyPropForFunc();
5496     void optEarlyProp();
5497     void optFoldNullCheck(GenTreePtr tree);
5498     bool optCanMoveNullCheckPastTree(GenTreePtr tree, bool isInsideTry);
5499
5500 #if ASSERTION_PROP
5501     /**************************************************************************
5502      *               Value/Assertion propagation
5503      *************************************************************************/
5504 public:
5505     // Data structures for assertion prop
5506     BitVecTraits* apTraits;
5507     ASSERT_TP     apFull;
5508     ASSERT_TP     apEmpty;
5509
5510     enum optAssertionKind
5511     {
5512         OAK_INVALID,
5513         OAK_EQUAL,
5514         OAK_NOT_EQUAL,
5515         OAK_SUBRANGE,
5516         OAK_NO_THROW,
5517         OAK_COUNT
5518     };
5519
5520     enum optOp1Kind
5521     {
5522         O1K_INVALID,
5523         O1K_LCLVAR,
5524         O1K_ARR_BND,
5525         O1K_ARRLEN_OPER_BND,
5526         O1K_ARRLEN_LOOP_BND,
5527         O1K_CONSTANT_LOOP_BND,
5528         O1K_EXACT_TYPE,
5529         O1K_SUBTYPE,
5530         O1K_VALUE_NUMBER,
5531         O1K_COUNT
5532     };
5533
5534     enum optOp2Kind
5535     {
5536         O2K_INVALID,
5537         O2K_LCLVAR_COPY,
5538         O2K_IND_CNS_INT,
5539         O2K_CONST_INT,
5540         O2K_CONST_LONG,
5541         O2K_CONST_DOUBLE,
5542         O2K_ARR_LEN,
5543         O2K_SUBRANGE,
5544         O2K_COUNT
5545     };
5546     struct AssertionDsc
5547     {
5548         optAssertionKind assertionKind;
5549         struct SsaVar
5550         {
5551             unsigned lclNum; // assigned to or property of this local var number
5552             unsigned ssaNum;
5553         };
5554         struct ArrBnd
5555         {
5556             ValueNum vnIdx;
5557             ValueNum vnLen;
5558         };
5559         struct AssertionDscOp1
5560         {
5561             optOp1Kind kind; // a normal LclVar, or Exact-type or Subtype
5562             ValueNum   vn;
5563             union {
5564                 SsaVar lcl;
5565                 ArrBnd bnd;
5566             };
5567         } op1;
5568         struct AssertionDscOp2
5569         {
5570             optOp2Kind kind; // a const or copy assignment
5571             ValueNum   vn;
5572             struct IntVal
5573             {
5574                 ssize_t  iconVal;   // integer
5575                 unsigned iconFlags; // gtFlags
5576             };
5577             struct Range // integer subrange
5578             {
5579                 ssize_t loBound;
5580                 ssize_t hiBound;
5581             };
5582             union {
5583                 SsaVar  lcl;
5584                 IntVal  u1;
5585                 __int64 lconVal;
5586                 double  dconVal;
5587                 Range   u2;
5588             };
5589         } op2;
5590
5591         bool IsArrLenArithBound()
5592         {
5593             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) && op1.kind == O1K_ARRLEN_OPER_BND);
5594         }
5595         bool IsArrLenBound()
5596         {
5597             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) && op1.kind == O1K_ARRLEN_LOOP_BND);
5598         }
5599         bool IsConstantBound()
5600         {
5601             return ((assertionKind == OAK_EQUAL || assertionKind == OAK_NOT_EQUAL) &&
5602                     op1.kind == O1K_CONSTANT_LOOP_BND);
5603         }
5604         bool IsBoundsCheckNoThrow()
5605         {
5606             return ((assertionKind == OAK_NO_THROW) && (op1.kind == O1K_ARR_BND));
5607         }
5608
5609         bool IsCopyAssertion()
5610         {
5611             return ((assertionKind == OAK_EQUAL) && (op1.kind == O1K_LCLVAR) && (op2.kind == O2K_LCLVAR_COPY));
5612         }
5613
5614         static bool SameKind(AssertionDsc* a1, AssertionDsc* a2)
5615         {
5616             return a1->assertionKind == a2->assertionKind && a1->op1.kind == a2->op1.kind &&
5617                    a1->op2.kind == a2->op2.kind;
5618         }
5619
5620         static bool ComplementaryKind(optAssertionKind kind, optAssertionKind kind2)
5621         {
5622             if (kind == OAK_EQUAL)
5623             {
5624                 return kind2 == OAK_NOT_EQUAL;
5625             }
5626             else if (kind == OAK_NOT_EQUAL)
5627             {
5628                 return kind2 == OAK_EQUAL;
5629             }
5630             return false;
5631         }
5632
5633         static ssize_t GetLowerBoundForIntegralType(var_types type)
5634         {
5635             switch (type)
5636             {
5637                 case TYP_BYTE:
5638                     return SCHAR_MIN;
5639                 case TYP_SHORT:
5640                     return SHRT_MIN;
5641                 case TYP_INT:
5642                     return INT_MIN;
5643                 case TYP_BOOL:
5644                 case TYP_UBYTE:
5645                 case TYP_CHAR:
5646                 case TYP_USHORT:
5647                 case TYP_UINT:
5648                     return 0;
5649                 default:
5650                     unreached();
5651             }
5652         }
5653         static ssize_t GetUpperBoundForIntegralType(var_types type)
5654         {
5655             switch (type)
5656             {
5657                 case TYP_BOOL:
5658                     return 1;
5659                 case TYP_BYTE:
5660                     return SCHAR_MAX;
5661                 case TYP_SHORT:
5662                     return SHRT_MAX;
5663                 case TYP_INT:
5664                     return INT_MAX;
5665                 case TYP_UBYTE:
5666                     return UCHAR_MAX;
5667                 case TYP_CHAR:
5668                 case TYP_USHORT:
5669                     return USHRT_MAX;
5670                 case TYP_UINT:
5671                     return UINT_MAX;
5672                 default:
5673                     unreached();
5674             }
5675         }
5676
5677         bool HasSameOp1(AssertionDsc* that, bool vnBased)
5678         {
5679             return (op1.kind == that->op1.kind) &&
5680                    ((vnBased && (op1.vn == that->op1.vn)) || (!vnBased && (op1.lcl.lclNum == that->op1.lcl.lclNum)));
5681         }
5682
5683         bool HasSameOp2(AssertionDsc* that, bool vnBased)
5684         {
5685             if (op2.kind != that->op2.kind)
5686             {
5687                 return false;
5688             }
5689             switch (op2.kind)
5690             {
5691                 case O2K_IND_CNS_INT:
5692                 case O2K_CONST_INT:
5693                     return ((op2.u1.iconVal == that->op2.u1.iconVal) && (op2.u1.iconFlags == that->op2.u1.iconFlags));
5694
5695                 case O2K_CONST_LONG:
5696                     return (op2.lconVal == that->op2.lconVal);
5697
5698                 case O2K_CONST_DOUBLE:
5699                     // exact match because of positive and negative zero.
5700                     return (memcmp(&op2.dconVal, &that->op2.dconVal, sizeof(double)) == 0);
5701
5702                 case O2K_LCLVAR_COPY:
5703                 case O2K_ARR_LEN:
5704                     return (op2.lcl.lclNum == that->op2.lcl.lclNum) &&
5705                            (!vnBased || op2.lcl.ssaNum == that->op2.lcl.ssaNum);
5706
5707                 case O2K_SUBRANGE:
5708                     return ((op2.u2.loBound == that->op2.u2.loBound) && (op2.u2.hiBound == that->op2.u2.hiBound));
5709
5710                 case O2K_INVALID:
5711                     // we will return false
5712                     break;
5713
5714                 default:
5715                     assert(!"Unexpected value for op2.kind in AssertionDsc.");
5716                     break;
5717             }
5718             return false;
5719         }
5720
5721         bool Complementary(AssertionDsc* that, bool vnBased)
5722         {
5723             return ComplementaryKind(assertionKind, that->assertionKind) && HasSameOp1(that, vnBased) &&
5724                    HasSameOp2(that, vnBased);
5725         }
5726
5727         bool Equals(AssertionDsc* that, bool vnBased)
5728         {
5729             return (assertionKind == that->assertionKind) && HasSameOp1(that, vnBased) && HasSameOp2(that, vnBased);
5730         }
5731     };
5732
5733     typedef unsigned short AssertionIndex;
5734
5735 protected:
5736     static fgWalkPreFn optAddCopiesCallback;
5737     static fgWalkPreFn optVNAssertionPropCurStmtVisitor;
5738     unsigned           optAddCopyLclNum;
5739     GenTreePtr         optAddCopyAsgnNode;
5740
5741     bool optLocalAssertionProp;  // indicates that we are performing local assertion prop
5742     bool optAssertionPropagated; // set to true if we modified the trees
5743     bool optAssertionPropagatedCurrentStmt;
5744 #ifdef DEBUG
5745     GenTreePtr optAssertionPropCurrentTree;
5746 #endif
5747     AssertionIndex*         optComplementaryAssertionMap;
5748     ExpandArray<ASSERT_TP>* optAssertionDep; // table that holds dependent assertions (assertions
5749                                              // using the value of a local var) for each local var
5750     AssertionDsc*  optAssertionTabPrivate;   // table that holds info about value assignments
5751     AssertionIndex optAssertionCount;        // total number of assertions in the assertion table
5752     AssertionIndex optMaxAssertionCount;
5753
5754 public:
5755     void optVnNonNullPropCurStmt(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
5756     fgWalkResult optVNConstantPropCurStmt(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
5757     GenTreePtr optVNConstantPropOnRelOp(GenTreePtr tree);
5758     GenTreePtr optVNConstantPropOnJTrue(BasicBlock* block, GenTreePtr stmt, GenTreePtr test);
5759     GenTreePtr optVNConstantPropOnTree(BasicBlock* block, GenTreePtr stmt, GenTreePtr tree);
5760     GenTreePtr optPrepareTreeForReplacement(GenTreePtr extractTree, GenTreePtr replaceTree);
5761
5762     AssertionIndex GetAssertionCount()
5763     {
5764         return optAssertionCount;
5765     }
5766     ASSERT_TP* bbJtrueAssertionOut;
5767     typedef SimplerHashTable<ValueNum, SmallPrimitiveKeyFuncs<ValueNum>, ASSERT_TP, JitSimplerHashBehavior>
5768                           ValueNumToAssertsMap;
5769     ValueNumToAssertsMap* optValueNumToAsserts;
5770
5771     static const AssertionIndex NO_ASSERTION_INDEX = 0;
5772
5773     // Assertion prop helpers.
5774     ASSERT_TP& GetAssertionDep(unsigned lclNum);
5775     AssertionDsc* optGetAssertion(AssertionIndex assertIndex);
5776     void optAssertionInit(bool isLocalProp);
5777     void optAssertionTraitsInit(AssertionIndex assertionCount);
5778 #if LOCAL_ASSERTION_PROP
5779     void optAssertionReset(AssertionIndex limit);
5780     void optAssertionRemove(AssertionIndex index);
5781 #endif
5782
5783     // Assertion prop data flow functions.
5784     void       optAssertionPropMain();
5785     GenTreePtr optVNAssertionPropCurStmt(BasicBlock* block, GenTreePtr stmt);
5786     bool optIsTreeKnownIntValue(bool vnBased, GenTreePtr tree, ssize_t* pConstant, unsigned* pIconFlags);
5787     ASSERT_TP* optInitAssertionDataflowFlags();
5788     ASSERT_TP* optComputeAssertionGen();
5789
5790     // Assertion Gen functions.
5791     void optAssertionGen(GenTreePtr tree);
5792     AssertionIndex optAssertionGenPhiDefn(GenTreePtr tree);
5793     AssertionIndex optCreateJTrueBoundsAssertion(GenTreePtr tree);
5794     AssertionIndex optAssertionGenJtrue(GenTreePtr tree);
5795     AssertionIndex optCreateJtrueAssertions(GenTreePtr op1, GenTreePtr op2, Compiler::optAssertionKind assertionKind);
5796     AssertionIndex optFindComplementary(AssertionIndex assertionIndex);
5797     void optMapComplementary(AssertionIndex assertionIndex, AssertionIndex index);
5798
5799     // Assertion creation functions.
5800     AssertionIndex optCreateAssertion(GenTreePtr op1, GenTreePtr op2, optAssertionKind assertionKind);
5801     AssertionIndex optCreateAssertion(GenTreePtr       op1,
5802                                       GenTreePtr       op2,
5803                                       optAssertionKind assertionKind,
5804                                       AssertionDsc*    assertion);
5805     void optCreateComplementaryAssertion(AssertionIndex assertionIndex, GenTreePtr op1, GenTreePtr op2);
5806
5807     bool optAssertionVnInvolvesNan(AssertionDsc* assertion);
5808     AssertionIndex optAddAssertion(AssertionDsc* assertion);
5809     void optAddVnAssertionMapping(ValueNum vn, AssertionIndex index);
5810 #ifdef DEBUG
5811     void optPrintVnAssertionMapping();
5812 #endif
5813     ASSERT_TP optGetVnMappedAssertions(ValueNum vn);
5814
5815     // Used for respective assertion propagations.
5816     AssertionIndex optAssertionIsSubrange(GenTreePtr tree, var_types toType, ASSERT_VALARG_TP assertions);
5817     AssertionIndex optAssertionIsSubtype(GenTreePtr tree, GenTreePtr methodTableArg, ASSERT_VALARG_TP assertions);
5818     AssertionIndex optAssertionIsNonNullInternal(GenTreePtr op, ASSERT_VALARG_TP assertions);
5819     bool optAssertionIsNonNull(GenTreePtr       op,
5820                                ASSERT_VALARG_TP assertions DEBUGARG(bool* pVnBased) DEBUGARG(AssertionIndex* pIndex));
5821
5822     // Used for Relop propagation.
5823     AssertionIndex optGlobalAssertionIsEqualOrNotEqual(ASSERT_VALARG_TP assertions, GenTreePtr op1, GenTreePtr op2);
5824     AssertionIndex optLocalAssertionIsEqualOrNotEqual(
5825         optOp1Kind op1Kind, unsigned lclNum, optOp2Kind op2Kind, ssize_t cnsVal, ASSERT_VALARG_TP assertions);
5826
5827     // Assertion prop for lcl var functions.
5828     bool optAssertionProp_LclVarTypeCheck(GenTreePtr tree, LclVarDsc* lclVarDsc, LclVarDsc* copyVarDsc);
5829     GenTreePtr optCopyAssertionProp(AssertionDsc* curAssertion,
5830                                     GenTreePtr    tree,
5831                                     GenTreePtr stmt DEBUGARG(AssertionIndex index));
5832     GenTreePtr optConstantAssertionProp(AssertionDsc*    curAssertion,
5833                                         const GenTreePtr tree,
5834                                         const GenTreePtr stmt DEBUGARG(AssertionIndex index));
5835     GenTreePtr optVnConstantAssertionProp(const GenTreePtr tree, const GenTreePtr stmt);
5836
5837     // Assertion propagation functions.
5838     GenTreePtr optAssertionProp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5839     GenTreePtr optAssertionProp_LclVar(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5840     GenTreePtr optAssertionProp_Ind(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5841     GenTreePtr optAssertionProp_Cast(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5842     GenTreePtr optAssertionProp_Call(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5843     GenTreePtr optAssertionProp_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5844     GenTreePtr optAssertionProp_Comma(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5845     GenTreePtr optAssertionProp_BndsChk(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5846     GenTreePtr optAssertionPropGlobal_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5847     GenTreePtr optAssertionPropLocal_RelOp(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5848     GenTreePtr optAssertionProp_Update(const GenTreePtr newTree, const GenTreePtr tree, const GenTreePtr stmt);
5849     GenTreePtr optNonNullAssertionProp_Call(ASSERT_VALARG_TP assertions, const GenTreePtr tree, const GenTreePtr stmt);
5850
5851     // Implied assertion functions.
5852     void optImpliedAssertions(AssertionIndex assertionIndex, ASSERT_TP& activeAssertions);
5853     void optImpliedByTypeOfAssertions(ASSERT_TP& activeAssertions);
5854     void optImpliedByCopyAssertion(AssertionDsc* copyAssertion, AssertionDsc* depAssertion, ASSERT_TP& result);
5855     void optImpliedByConstAssertion(AssertionDsc* curAssertion, ASSERT_TP& result);
5856
5857     ASSERT_VALRET_TP optNewFullAssertSet();
5858     ASSERT_VALRET_TP optNewEmptyAssertSet();
5859
5860 #ifdef DEBUG
5861     void optPrintAssertion(AssertionDsc* newAssertion, AssertionIndex assertionIndex = 0);
5862     void optDebugCheckAssertion(AssertionDsc* assertion);
5863     void optDebugCheckAssertions(AssertionIndex AssertionIndex);
5864 #endif
5865     void optAddCopies();
5866 #endif // ASSERTION_PROP
5867
5868     /**************************************************************************
5869      *                          Range checks
5870      *************************************************************************/
5871
5872 public:
5873     struct LoopCloneVisitorInfo
5874     {
5875         LoopCloneContext* context;
5876         unsigned          loopNum;
5877         GenTreePtr        stmt;
5878         LoopCloneVisitorInfo(LoopCloneContext* context, unsigned loopNum, GenTreePtr stmt)
5879             : context(context), loopNum(loopNum), stmt(nullptr)
5880         {
5881         }
5882     };
5883
5884     bool optIsStackLocalInvariant(unsigned loopNum, unsigned lclNum);
5885     bool optExtractArrIndex(GenTreePtr tree, ArrIndex* result, unsigned lhsNum);
5886     bool optReconstructArrIndex(GenTreePtr tree, ArrIndex* result, unsigned lhsNum);
5887     bool optIdentifyLoopOptInfo(unsigned loopNum, LoopCloneContext* context);
5888     static fgWalkPreFn optCanOptimizeByLoopCloningVisitor;
5889     fgWalkResult optCanOptimizeByLoopCloning(GenTreePtr tree, LoopCloneVisitorInfo* info);
5890     void optObtainLoopCloningOpts(LoopCloneContext* context);
5891     bool optIsLoopClonable(unsigned loopInd);
5892
5893     bool optCanCloneLoops();
5894
5895 #ifdef DEBUG
5896     void optDebugLogLoopCloning(BasicBlock* block, GenTreePtr insertBefore);
5897 #endif
5898     void optPerformStaticOptimizations(unsigned loopNum, LoopCloneContext* context DEBUGARG(bool fastPath));
5899     bool optComputeDerefConditions(unsigned loopNum, LoopCloneContext* context);
5900     bool optDeriveLoopCloningConditions(unsigned loopNum, LoopCloneContext* context);
5901     BasicBlock* optInsertLoopChoiceConditions(LoopCloneContext* context,
5902                                               unsigned          loopNum,
5903                                               BasicBlock*       head,
5904                                               BasicBlock*       slow);
5905     void optInsertLoopCloningStress(BasicBlock* head);
5906
5907 #if COUNT_RANGECHECKS
5908     static unsigned optRangeChkRmv;
5909     static unsigned optRangeChkAll;
5910 #endif
5911
5912 protected:
5913     struct arraySizes
5914     {
5915         unsigned arrayVar;
5916         int      arrayDim;
5917
5918 #define MAX_ARRAYS 4 // a magic max number of arrays tracked for bounds check elimination
5919     };
5920
5921     struct RngChkDsc
5922     {
5923         RngChkDsc* rcdNextInBucket; // used by the hash table
5924
5925         unsigned short rcdHashValue; // to make matching faster
5926         unsigned short rcdIndex;     // 0..optRngChkCount-1
5927
5928         GenTreePtr rcdTree; // the array index tree
5929     };
5930
5931     unsigned            optRngChkCount;
5932     static const size_t optRngChkHashSize;
5933
5934     ssize_t optGetArrayRefScaleAndIndex(GenTreePtr mul, GenTreePtr* pIndex DEBUGARG(bool bRngChk));
5935     GenTreePtr optFindLocalInit(BasicBlock* block, GenTreePtr local, VARSET_TP* pKilledInOut, bool* isKilledAfterInit);
5936
5937     bool optReachWithoutCall(BasicBlock* srcBB, BasicBlock* dstBB);
5938
5939 protected:
5940     bool optLoopsMarked;
5941
5942     /*
5943     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5944     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5945     XX                                                                           XX
5946     XX                           RegAlloc                                        XX
5947     XX                                                                           XX
5948     XX  Does the register allocation and puts the remaining lclVars on the stack XX
5949     XX                                                                           XX
5950     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5951     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5952     */
5953
5954 public:
5955 #ifndef LEGACY_BACKEND
5956     bool doLSRA() const
5957     {
5958         return true;
5959     }
5960 #else  // LEGACY_BACKEND
5961     bool doLSRA() const
5962     {
5963         return false;
5964     }
5965 #endif // LEGACY_BACKEND
5966
5967 #ifdef LEGACY_BACKEND
5968     void raInit();
5969     void raAssignVars(); // register allocation
5970 #endif                   // LEGACY_BACKEND
5971
5972     VARSET_TP raRegVarsMask; // Set of all enregistered variables (not including FEATURE_STACK_FP_X87 enregistered
5973                              // variables)
5974     regNumber raUpdateRegStateForArg(RegState* regState, LclVarDsc* argDsc);
5975
5976     void raMarkStkVars();
5977
5978 protected:
5979     // Some things are used by both LSRA and regpredict allocators.
5980
5981     FrameType rpFrameType;
5982     bool      rpMustCreateEBPCalled; // Set to true after we have called rpMustCreateEBPFrame once
5983
5984 #ifdef LEGACY_BACKEND
5985     regMaskTP rpMaskPInvokeEpilogIntf; // pinvoke epilog trashes esi/edi holding stack args needed to setup tail call's
5986                                        // args
5987 #endif                                 // LEGACY_BACKEND
5988
5989     bool rpMustCreateEBPFrame(INDEBUG(const char** wbReason));
5990
5991 #if FEATURE_FP_REGALLOC
5992     enum enumConfigRegisterFP
5993     {
5994         CONFIG_REGISTER_FP_NONE         = 0x0,
5995         CONFIG_REGISTER_FP_CALLEE_TRASH = 0x1,
5996         CONFIG_REGISTER_FP_CALLEE_SAVED = 0x2,
5997         CONFIG_REGISTER_FP_FULL         = 0x3,
5998     };
5999     enumConfigRegisterFP raConfigRegisterFP();
6000 #endif // FEATURE_FP_REGALLOC
6001
6002 public:
6003     regMaskTP raConfigRestrictMaskFP();
6004
6005 private:
6006 #ifndef LEGACY_BACKEND
6007     LinearScanInterface* m_pLinearScan; // Linear Scan allocator
6008 #else                                   // LEGACY_BACKEND
6009     unsigned  raAvoidArgRegMask;       // Mask of incoming argument registers that we may need to avoid
6010     VARSET_TP raLclRegIntf[REG_COUNT]; // variable to register interference graph
6011     bool      raNewBlocks;             // True is we added killing blocks for FPU registers
6012     unsigned  rpPasses;                // Number of passes made by the register predicter
6013     unsigned  rpPassesMax;             // Maximum number of passes made by the register predicter
6014     unsigned  rpPassesPessimize;       // Number of passes non-pessimizing made by the register predicter
6015     unsigned rpStkPredict; // Weighted count of variables were predicted STK (lower means register allocation is better)
6016     unsigned rpPredictSpillCnt;     // Predicted number of integer spill tmps for the current tree
6017     regMaskTP rpPredictAssignMask;  // Mask of registers to consider in rpPredictAssignRegVars()
6018     VARSET_TP rpLastUseVars;        // Set of last use variables in rpPredictTreeRegUse
6019     VARSET_TP rpUseInPlace;         // Set of variables that we used in place
6020     int       rpAsgVarNum;          // VarNum for the target of GT_ASG node
6021     bool      rpPredictAssignAgain; // Must rerun the rpPredictAssignRegVars()
6022     bool      rpAddedVarIntf;       // Set to true if we need to add a new var intf
6023     bool      rpLostEnreg;          // Set to true if we lost an enregister var that had lvDependReg set
6024     bool      rpReverseEBPenreg;    // Decided to reverse the enregistration of EBP
6025 public:
6026     bool rpRegAllocDone; // Set to true after we have completed register allocation
6027 private:
6028     regMaskTP rpPredictMap[PREDICT_COUNT]; // Holds the regMaskTP for each of the enum values
6029
6030     void raSetupArgMasks(RegState* r);
6031
6032     const regNumber* raGetRegVarOrder(var_types regType, unsigned* wbVarOrderSize);
6033 #ifdef DEBUG
6034     void raDumpVarIntf(); // Dump the variable to variable interference graph
6035     void raDumpRegIntf(); // Dump the variable to register interference graph
6036 #endif
6037     void raAdjustVarIntf();
6038
6039     regMaskTP rpPredictRegMask(rpPredictReg predictReg, var_types type);
6040
6041     bool rpRecordRegIntf(regMaskTP regMask, VARSET_VALARG_TP life DEBUGARG(const char* msg));
6042
6043     bool rpRecordVarIntf(unsigned varNum, VARSET_VALARG_TP intfVar DEBUGARG(const char* msg));
6044     regMaskTP rpPredictRegPick(var_types type, rpPredictReg predictReg, regMaskTP lockedRegs);
6045
6046     regMaskTP rpPredictGrabReg(var_types type, rpPredictReg predictReg, regMaskTP lockedRegs);
6047
6048     static fgWalkPreFn rpMarkRegIntf;
6049
6050     regMaskTP rpPredictAddressMode(
6051         GenTreePtr tree, var_types type, regMaskTP lockedRegs, regMaskTP rsvdRegs, GenTreePtr lenCSE);
6052
6053     void rpPredictRefAssign(unsigned lclNum);
6054
6055     regMaskTP rpPredictBlkAsgRegUse(GenTreePtr tree, rpPredictReg predictReg, regMaskTP lockedRegs, regMaskTP rsvdRegs);
6056
6057     regMaskTP rpPredictTreeRegUse(GenTreePtr tree, rpPredictReg predictReg, regMaskTP lockedRegs, regMaskTP rsvdRegs);
6058
6059     regMaskTP rpPredictAssignRegVars(regMaskTP regAvail);
6060
6061     void rpPredictRegUse(); // Entry point
6062
6063     unsigned raPredictTreeRegUse(GenTreePtr tree);
6064     unsigned raPredictListRegUse(GenTreePtr list);
6065
6066     void raSetRegVarOrder(var_types  regType,
6067                           regNumber* customVarOrder,
6068                           unsigned*  customVarOrderSize,
6069                           regMaskTP  prefReg,
6070                           regMaskTP  avoidReg);
6071
6072     // We use (unsigned)-1 as an uninitialized sentinel for rpStkPredict and
6073     // also as the maximum value of lvRefCntWtd. Don't allow overflow, and
6074     // saturate at UINT_MAX - 1, to avoid using the sentinel.
6075     void raAddToStkPredict(unsigned val)
6076     {
6077         unsigned newStkPredict = rpStkPredict + val;
6078         if ((newStkPredict < rpStkPredict) || (newStkPredict == UINT_MAX))
6079             rpStkPredict = UINT_MAX - 1;
6080         else
6081             rpStkPredict = newStkPredict;
6082     }
6083
6084 #ifdef DEBUG
6085 #if !FEATURE_FP_REGALLOC
6086     void raDispFPlifeInfo();
6087 #endif
6088 #endif
6089
6090     regMaskTP genReturnRegForTree(GenTreePtr tree);
6091 #endif // LEGACY_BACKEND
6092
6093     /* raIsVarargsStackArg is called by raMaskStkVars and by
6094        lvaSortByRefCount.  It identifies the special case
6095        where a varargs function has a parameter passed on the
6096        stack, other than the special varargs handle.  Such parameters
6097        require special treatment, because they cannot be tracked
6098        by the GC (their offsets in the stack are not known
6099        at compile time).
6100     */
6101
6102     bool raIsVarargsStackArg(unsigned lclNum)
6103     {
6104 #ifdef _TARGET_X86_
6105
6106         LclVarDsc* varDsc = &lvaTable[lclNum];
6107
6108         assert(varDsc->lvIsParam);
6109
6110         return (info.compIsVarArgs && !varDsc->lvIsRegArg && (lclNum != lvaVarargsHandleArg));
6111
6112 #else // _TARGET_X86_
6113
6114         return false;
6115
6116 #endif // _TARGET_X86_
6117     }
6118
6119 #ifdef LEGACY_BACKEND
6120     // Records the current prediction, if it's better than any previous recorded prediction.
6121     void rpRecordPrediction();
6122     // Applies the best recorded prediction, if one exists and is better than the current prediction.
6123     void rpUseRecordedPredictionIfBetter();
6124
6125     // Data members used in the methods above.
6126     unsigned rpBestRecordedStkPredict;
6127     struct VarRegPrediction
6128     {
6129         bool           m_isEnregistered;
6130         regNumberSmall m_regNum;
6131         regNumberSmall m_otherReg;
6132     };
6133     VarRegPrediction* rpBestRecordedPrediction;
6134 #endif // LEGACY_BACKEND
6135
6136     /*
6137     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6138     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6139     XX                                                                           XX
6140     XX                           EEInterface                                     XX
6141     XX                                                                           XX
6142     XX   Get to the class and method info from the Execution Engine given        XX
6143     XX   tokens for the class and method                                         XX
6144     XX                                                                           XX
6145     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6146     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6147     */
6148
6149 public:
6150     /* These are the different addressing modes used to access a local var.
6151      * The JIT has to report the location of the locals back to the EE
6152      * for debugging purposes.
6153      */
6154
6155     enum siVarLocType
6156     {
6157         VLT_REG,
6158         VLT_REG_BYREF, // this type is currently only used for value types on X64
6159         VLT_REG_FP,
6160         VLT_STK,
6161         VLT_STK_BYREF, // this type is currently only used for value types on X64
6162         VLT_REG_REG,
6163         VLT_REG_STK,
6164         VLT_STK_REG,
6165         VLT_STK2,
6166         VLT_FPSTK,
6167         VLT_FIXED_VA,
6168
6169         VLT_COUNT,
6170         VLT_INVALID
6171     };
6172
6173     struct siVarLoc
6174     {
6175         siVarLocType vlType;
6176
6177         union {
6178             // VLT_REG/VLT_REG_FP -- Any pointer-sized enregistered value (TYP_INT, TYP_REF, etc)
6179             // eg. EAX
6180             // VLT_REG_BYREF -- the specified register contains the address of the variable
6181             // eg. [EAX]
6182
6183             struct
6184             {
6185                 regNumber vlrReg;
6186             } vlReg;
6187
6188             // VLT_STK       -- Any 32 bit value which is on the stack
6189             // eg. [ESP+0x20], or [EBP-0x28]
6190             // VLT_STK_BYREF -- the specified stack location contains the address of the variable
6191             // eg. mov EAX, [ESP+0x20]; [EAX]
6192
6193             struct
6194             {
6195                 regNumber     vlsBaseReg;
6196                 NATIVE_OFFSET vlsOffset;
6197             } vlStk;
6198
6199             // VLT_REG_REG -- TYP_LONG/TYP_DOUBLE with both DWords enregistered
6200             // eg. RBM_EAXEDX
6201
6202             struct
6203             {
6204                 regNumber vlrrReg1;
6205                 regNumber vlrrReg2;
6206             } vlRegReg;
6207
6208             // VLT_REG_STK -- Partly enregistered TYP_LONG/TYP_DOUBLE
6209             // eg { LowerDWord=EAX UpperDWord=[ESP+0x8] }
6210
6211             struct
6212             {
6213                 regNumber vlrsReg;
6214
6215                 struct
6216                 {
6217                     regNumber     vlrssBaseReg;
6218                     NATIVE_OFFSET vlrssOffset;
6219                 } vlrsStk;
6220             } vlRegStk;
6221
6222             // VLT_STK_REG -- Partly enregistered TYP_LONG/TYP_DOUBLE
6223             // eg { LowerDWord=[ESP+0x8] UpperDWord=EAX }
6224
6225             struct
6226             {
6227                 struct
6228                 {
6229                     regNumber     vlsrsBaseReg;
6230                     NATIVE_OFFSET vlsrsOffset;
6231                 } vlsrStk;
6232
6233                 regNumber vlsrReg;
6234             } vlStkReg;
6235
6236             // VLT_STK2 -- Any 64 bit value which is on the stack, in 2 successsive DWords
6237             // eg 2 DWords at [ESP+0x10]
6238
6239             struct
6240             {
6241                 regNumber     vls2BaseReg;
6242                 NATIVE_OFFSET vls2Offset;
6243             } vlStk2;
6244
6245             // VLT_FPSTK -- enregisterd TYP_DOUBLE (on the FP stack)
6246             // eg. ST(3). Actually it is ST("FPstkHeight - vpFpStk")
6247
6248             struct
6249             {
6250                 unsigned vlfReg;
6251             } vlFPstk;
6252
6253             // VLT_FIXED_VA -- fixed argument of a varargs function.
6254             // The argument location depends on the size of the variable
6255             // arguments (...). Inspecting the VARARGS_HANDLE indicates the
6256             // location of the first arg. This argument can then be accessed
6257             // relative to the position of the first arg
6258
6259             struct
6260             {
6261                 unsigned vlfvOffset;
6262             } vlFixedVarArg;
6263
6264             // VLT_MEMORY
6265
6266             struct
6267             {
6268                 void* rpValue; // pointer to the in-process
6269                                // location of the value.
6270             } vlMemory;
6271         };
6272
6273         // Helper functions
6274
6275         bool vlIsInReg(regNumber reg);
6276         bool vlIsOnStk(regNumber reg, signed offset);
6277     };
6278
6279     /*************************************************************************/
6280
6281 public:
6282     // Get handles
6283
6284     void eeGetCallInfo(CORINFO_RESOLVED_TOKEN* pResolvedToken,
6285                        CORINFO_RESOLVED_TOKEN* pConstrainedToken,
6286                        CORINFO_CALLINFO_FLAGS  flags,
6287                        CORINFO_CALL_INFO*      pResult);
6288     inline CORINFO_CALLINFO_FLAGS addVerifyFlag(CORINFO_CALLINFO_FLAGS flags);
6289
6290     void eeGetFieldInfo(CORINFO_RESOLVED_TOKEN* pResolvedToken,
6291                         CORINFO_ACCESS_FLAGS    flags,
6292                         CORINFO_FIELD_INFO*     pResult);
6293
6294     // Get the flags
6295
6296     BOOL eeIsValueClass(CORINFO_CLASS_HANDLE clsHnd);
6297
6298 #if defined(DEBUG) || defined(FEATURE_JIT_METHOD_PERF) || defined(FEATURE_SIMD) || defined(TRACK_LSRA_STATS)
6299
6300     bool IsSuperPMIException(unsigned code)
6301     {
6302         // Copied from NDP\clr\src\ToolBox\SuperPMI\SuperPMI-Shared\ErrorHandling.h
6303
6304         const unsigned EXCEPTIONCODE_DebugBreakorAV = 0xe0421000;
6305         const unsigned EXCEPTIONCODE_MC             = 0xe0422000;
6306         const unsigned EXCEPTIONCODE_LWM            = 0xe0423000;
6307         const unsigned EXCEPTIONCODE_SASM           = 0xe0424000;
6308         const unsigned EXCEPTIONCODE_SSYM           = 0xe0425000;
6309         const unsigned EXCEPTIONCODE_CALLUTILS      = 0xe0426000;
6310         const unsigned EXCEPTIONCODE_TYPEUTILS      = 0xe0427000;
6311         const unsigned EXCEPTIONCODE_ASSERT         = 0xe0440000;
6312
6313         switch (code)
6314         {
6315             case EXCEPTIONCODE_DebugBreakorAV:
6316             case EXCEPTIONCODE_MC:
6317             case EXCEPTIONCODE_LWM:
6318             case EXCEPTIONCODE_SASM:
6319             case EXCEPTIONCODE_SSYM:
6320             case EXCEPTIONCODE_CALLUTILS:
6321             case EXCEPTIONCODE_TYPEUTILS:
6322             case EXCEPTIONCODE_ASSERT:
6323                 return true;
6324             default:
6325                 return false;
6326         }
6327     }
6328
6329     const char* eeGetMethodName(CORINFO_METHOD_HANDLE hnd, const char** className);
6330     const char* eeGetMethodFullName(CORINFO_METHOD_HANDLE hnd);
6331
6332     bool eeIsNativeMethod(CORINFO_METHOD_HANDLE method);
6333     CORINFO_METHOD_HANDLE eeGetMethodHandleForNative(CORINFO_METHOD_HANDLE method);
6334 #endif
6335
6336     var_types eeGetArgType(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig);
6337     var_types eeGetArgType(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig, bool* isPinned);
6338     unsigned eeGetArgSize(CORINFO_ARG_LIST_HANDLE list, CORINFO_SIG_INFO* sig);
6339
6340     // VOM info, method sigs
6341
6342     void eeGetSig(unsigned               sigTok,
6343                   CORINFO_MODULE_HANDLE  scope,
6344                   CORINFO_CONTEXT_HANDLE context,
6345                   CORINFO_SIG_INFO*      retSig);
6346
6347     void eeGetCallSiteSig(unsigned               sigTok,
6348                           CORINFO_MODULE_HANDLE  scope,
6349                           CORINFO_CONTEXT_HANDLE context,
6350                           CORINFO_SIG_INFO*      retSig);
6351
6352     void eeGetMethodSig(CORINFO_METHOD_HANDLE methHnd, CORINFO_SIG_INFO* retSig, CORINFO_CLASS_HANDLE owner = nullptr);
6353
6354     // Method entry-points, instrs
6355
6356     void* eeGetFieldAddress(CORINFO_FIELD_HANDLE handle, void*** ppIndir);
6357
6358     CORINFO_METHOD_HANDLE eeMarkNativeTarget(CORINFO_METHOD_HANDLE method);
6359
6360     CORINFO_EE_INFO eeInfo;
6361     bool            eeInfoInitialized;
6362
6363     CORINFO_EE_INFO* eeGetEEInfo();
6364
6365     // Gets the offset of a SDArray's first element
6366     unsigned eeGetArrayDataOffset(var_types type);
6367     // Gets the offset of a MDArray's first element
6368     unsigned eeGetMDArrayDataOffset(var_types type, unsigned rank);
6369
6370     GenTreePtr eeGetPInvokeCookie(CORINFO_SIG_INFO* szMetaSig);
6371
6372     // Returns the page size for the target machine as reported by the EE.
6373     inline size_t eeGetPageSize()
6374     {
6375 #if COR_JIT_EE_VERSION > 460
6376         return eeGetEEInfo()->osPageSize;
6377 #else  // COR_JIT_EE_VERSION <= 460
6378         return CORINFO_PAGE_SIZE;
6379 #endif // COR_JIT_EE_VERSION > 460
6380     }
6381
6382     // Returns the frame size at which we will generate a loop to probe the stack.
6383     inline size_t getVeryLargeFrameSize()
6384     {
6385 #ifdef _TARGET_ARM_
6386         // The looping probe code is 40 bytes, whereas the straight-line probing for
6387         // the (0x2000..0x3000) case is 44, so use looping for anything 0x2000 bytes
6388         // or greater, to generate smaller code.
6389         return 2 * eeGetPageSize();
6390 #else
6391         return 3 * eeGetPageSize();
6392 #endif
6393     }
6394
6395     inline bool IsTargetAbi(CORINFO_RUNTIME_ABI abi)
6396     {
6397 #if COR_JIT_EE_VERSION > 460
6398         return eeGetEEInfo()->targetAbi == abi;
6399 #else
6400         return CORINFO_DESKTOP_ABI == abi;
6401 #endif
6402     }
6403
6404     inline bool generateCFIUnwindCodes()
6405     {
6406 #ifdef UNIX_AMD64_ABI
6407         return IsTargetAbi(CORINFO_CORERT_ABI);
6408 #else
6409         return false;
6410 #endif
6411     }
6412
6413     // Exceptions
6414
6415     unsigned eeGetEHcount(CORINFO_METHOD_HANDLE handle);
6416
6417     // Debugging support - Line number info
6418
6419     void eeGetStmtOffsets();
6420
6421     unsigned eeBoundariesCount;
6422
6423     struct boundariesDsc
6424     {
6425         UNATIVE_OFFSET nativeIP;
6426         IL_OFFSET      ilOffset;
6427         unsigned       sourceReason;
6428     } * eeBoundaries; // Boundaries to report to EE
6429     void eeSetLIcount(unsigned count);
6430     void eeSetLIinfo(unsigned which, UNATIVE_OFFSET offs, unsigned srcIP, bool stkEmpty, bool callInstruction);
6431     void eeSetLIdone();
6432
6433 #ifdef DEBUG
6434     static void eeDispILOffs(IL_OFFSET offs);
6435     static void eeDispLineInfo(const boundariesDsc* line);
6436     void eeDispLineInfos();
6437 #endif // DEBUG
6438
6439     // Debugging support - Local var info
6440
6441     void eeGetVars();
6442
6443     unsigned eeVarsCount;
6444
6445     struct VarResultInfo
6446     {
6447         UNATIVE_OFFSET startOffset;
6448         UNATIVE_OFFSET endOffset;
6449         DWORD          varNumber;
6450         siVarLoc       loc;
6451     } * eeVars;
6452     void eeSetLVcount(unsigned count);
6453     void eeSetLVinfo(unsigned        which,
6454                      UNATIVE_OFFSET  startOffs,
6455                      UNATIVE_OFFSET  length,
6456                      unsigned        varNum,
6457                      unsigned        LVnum,
6458                      VarName         namex,
6459                      bool            avail,
6460                      const siVarLoc& loc);
6461     void eeSetLVdone();
6462
6463 #ifdef DEBUG
6464     void eeDispVar(ICorDebugInfo::NativeVarInfo* var);
6465     void eeDispVars(CORINFO_METHOD_HANDLE ftn, ULONG32 cVars, ICorDebugInfo::NativeVarInfo* vars);
6466 #endif // DEBUG
6467
6468     // ICorJitInfo wrappers
6469
6470     void eeReserveUnwindInfo(BOOL isFunclet, BOOL isColdCode, ULONG unwindSize);
6471
6472     void eeAllocUnwindInfo(BYTE*          pHotCode,
6473                            BYTE*          pColdCode,
6474                            ULONG          startOffset,
6475                            ULONG          endOffset,
6476                            ULONG          unwindSize,
6477                            BYTE*          pUnwindBlock,
6478                            CorJitFuncKind funcKind);
6479
6480     void eeSetEHcount(unsigned cEH);
6481
6482     void eeSetEHinfo(unsigned EHnumber, const CORINFO_EH_CLAUSE* clause);
6483
6484     WORD eeGetRelocTypeHint(void* target);
6485
6486     // ICorStaticInfo wrapper functions
6487
6488     bool eeTryResolveToken(CORINFO_RESOLVED_TOKEN* resolvedToken);
6489
6490 #if defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
6491 #ifdef DEBUG
6492     static void dumpSystemVClassificationType(SystemVClassificationType ct);
6493 #endif // DEBUG
6494
6495     void eeGetSystemVAmd64PassStructInRegisterDescriptor(
6496         /*IN*/ CORINFO_CLASS_HANDLE                                  structHnd,
6497         /*OUT*/ SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* structPassInRegDescPtr);
6498 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
6499
6500     template <typename ParamType>
6501     bool eeRunWithErrorTrap(void (*function)(ParamType*), ParamType* param)
6502     {
6503         return eeRunWithErrorTrapImp(reinterpret_cast<void (*)(void*)>(function), reinterpret_cast<void*>(param));
6504     }
6505
6506     bool eeRunWithErrorTrapImp(void (*function)(void*), void* param);
6507
6508     // Utility functions
6509
6510     const char* eeGetFieldName(CORINFO_FIELD_HANDLE fieldHnd, const char** classNamePtr = nullptr);
6511
6512 #if defined(DEBUG)
6513     const wchar_t* eeGetCPString(size_t stringHandle);
6514 #endif
6515
6516     const char* eeGetClassName(CORINFO_CLASS_HANDLE clsHnd);
6517
6518     static CORINFO_METHOD_HANDLE eeFindHelper(unsigned helper);
6519     static CorInfoHelpFunc eeGetHelperNum(CORINFO_METHOD_HANDLE method);
6520
6521     static fgWalkPreFn CountSharedStaticHelper;
6522     static bool IsSharedStaticHelper(GenTreePtr tree);
6523     static bool IsTreeAlwaysHoistable(GenTreePtr tree);
6524
6525     static CORINFO_FIELD_HANDLE eeFindJitDataOffs(unsigned jitDataOffs);
6526     // returns true/false if 'field' is a Jit Data offset
6527     static bool eeIsJitDataOffs(CORINFO_FIELD_HANDLE field);
6528     // returns a number < 0 if 'field' is not a Jit Data offset, otherwise the data offset (limited to 2GB)
6529     static int eeGetJitDataOffs(CORINFO_FIELD_HANDLE field);
6530
6531     /*****************************************************************************/
6532
6533 public:
6534     void tmpInit();
6535
6536     enum TEMP_USAGE_TYPE
6537     {
6538         TEMP_USAGE_FREE,
6539         TEMP_USAGE_USED
6540     };
6541
6542     static var_types tmpNormalizeType(var_types type);
6543     TempDsc* tmpGetTemp(var_types type); // get temp for the given type
6544     void tmpRlsTemp(TempDsc* temp);
6545     TempDsc* tmpFindNum(int temp, TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6546
6547     void     tmpEnd();
6548     TempDsc* tmpListBeg(TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6549     TempDsc* tmpListNxt(TempDsc* curTemp, TEMP_USAGE_TYPE usageType = TEMP_USAGE_FREE) const;
6550     void tmpDone();
6551
6552 #ifdef DEBUG
6553     bool tmpAllFree() const;
6554 #endif // DEBUG
6555
6556 #ifndef LEGACY_BACKEND
6557     void tmpPreAllocateTemps(var_types type, unsigned count);
6558 #endif // !LEGACY_BACKEND
6559
6560 protected:
6561 #ifdef LEGACY_BACKEND
6562     unsigned tmpIntSpillMax;    // number of int-sized spill temps
6563     unsigned tmpDoubleSpillMax; // number of double-sized spill temps
6564 #endif                          // LEGACY_BACKEND
6565
6566     unsigned tmpCount; // Number of temps
6567     unsigned tmpSize;  // Size of all the temps
6568 #ifdef DEBUG
6569 public:
6570     // Used by RegSet::rsSpillChk()
6571     unsigned tmpGetCount; // Temps which haven't been released yet
6572 #endif
6573 private:
6574     static unsigned tmpSlot(unsigned size); // which slot in tmpFree[] or tmpUsed[] to use
6575
6576     TempDsc* tmpFree[TEMP_MAX_SIZE / sizeof(int)];
6577     TempDsc* tmpUsed[TEMP_MAX_SIZE / sizeof(int)];
6578
6579     /*
6580     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6581     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6582     XX                                                                           XX
6583     XX                           CodeGenerator                                   XX
6584     XX                                                                           XX
6585     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6586     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6587     */
6588
6589 public:
6590     CodeGenInterface* codeGen;
6591
6592     //  The following holds information about instr offsets in terms of generated code.
6593
6594     struct IPmappingDsc
6595     {
6596         IPmappingDsc* ipmdNext;      // next line# record
6597         IL_OFFSETX    ipmdILoffsx;   // the instr offset
6598         emitLocation  ipmdNativeLoc; // the emitter location of the native code corresponding to the IL offset
6599         bool          ipmdIsLabel;   // Can this code be a branch label?
6600     };
6601
6602     // Record the instr offset mapping to the generated code
6603
6604     IPmappingDsc* genIPmappingList;
6605     IPmappingDsc* genIPmappingLast;
6606
6607     // Managed RetVal - A side hash table meant to record the mapping from a
6608     // GT_CALL node to its IL offset.  This info is used to emit sequence points
6609     // that can be used by debugger to determine the native offset at which the
6610     // managed RetVal will be available.
6611     //
6612     // In fact we can store IL offset in a GT_CALL node.  This was ruled out in
6613     // favor of a side table for two reasons: 1) We need IL offset for only those
6614     // GT_CALL nodes (created during importation) that correspond to an IL call and
6615     // whose return type is other than TYP_VOID. 2) GT_CALL node is a frequently used
6616     // structure and IL offset is needed only when generating debuggable code. Therefore
6617     // it is desirable to avoid memory size penalty in retail scenarios.
6618     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, IL_OFFSETX, JitSimplerHashBehavior>
6619                            CallSiteILOffsetTable;
6620     CallSiteILOffsetTable* genCallSite2ILOffsetMap;
6621
6622     unsigned    genReturnLocal; // Local number for the return value when applicable.
6623     BasicBlock* genReturnBB;    // jumped to when not optimizing for speed.
6624
6625     // The following properties are part of CodeGenContext.  Getters are provided here for
6626     // convenience and backward compatibility, but the properties can only be set by invoking
6627     // the setter on CodeGenContext directly.
6628
6629     __declspec(property(get = getEmitter)) emitter* genEmitter;
6630     emitter* getEmitter()
6631     {
6632         return codeGen->getEmitter();
6633     }
6634
6635     const bool isFramePointerUsed()
6636     {
6637         return codeGen->isFramePointerUsed();
6638     }
6639
6640     __declspec(property(get = getInterruptible, put = setInterruptible)) bool genInterruptible;
6641     bool getInterruptible()
6642     {
6643         return codeGen->genInterruptible;
6644     }
6645     void setInterruptible(bool value)
6646     {
6647         codeGen->setInterruptible(value);
6648     }
6649
6650 #if DOUBLE_ALIGN
6651     const bool genDoubleAlign()
6652     {
6653         return codeGen->doDoubleAlign();
6654     }
6655     DWORD getCanDoubleAlign();
6656     bool shouldDoubleAlign(unsigned refCntStk,
6657                            unsigned refCntReg,
6658                            unsigned refCntWtdReg,
6659                            unsigned refCntStkParam,
6660                            unsigned refCntWtdStkDbl);
6661 #endif // DOUBLE_ALIGN
6662
6663     __declspec(property(get = getFullPtrRegMap, put = setFullPtrRegMap)) bool genFullPtrRegMap;
6664     bool getFullPtrRegMap()
6665     {
6666         return codeGen->genFullPtrRegMap;
6667     }
6668     void setFullPtrRegMap(bool value)
6669     {
6670         codeGen->setFullPtrRegMap(value);
6671     }
6672
6673 // Things that MAY belong either in CodeGen or CodeGenContext
6674
6675 #if FEATURE_EH_FUNCLETS
6676     FuncInfoDsc*   compFuncInfos;
6677     unsigned short compCurrFuncIdx;
6678     unsigned short compFuncInfoCount;
6679
6680     unsigned short compFuncCount()
6681     {
6682         assert(fgFuncletsCreated);
6683         return compFuncInfoCount;
6684     }
6685
6686 #else // !FEATURE_EH_FUNCLETS
6687
6688     // This is a no-op when there are no funclets!
6689     void genUpdateCurrentFunclet(BasicBlock* block)
6690     {
6691         return;
6692     }
6693
6694     FuncInfoDsc compFuncInfoRoot;
6695
6696     static const unsigned compCurrFuncIdx = 0;
6697
6698     unsigned short compFuncCount()
6699     {
6700         return 1;
6701     }
6702
6703 #endif // !FEATURE_EH_FUNCLETS
6704
6705     FuncInfoDsc* funCurrentFunc();
6706     void funSetCurrentFunc(unsigned funcIdx);
6707     FuncInfoDsc* funGetFunc(unsigned funcIdx);
6708     unsigned int funGetFuncIdx(BasicBlock* block);
6709
6710     // LIVENESS
6711
6712     VARSET_TP  compCurLife;     // current live variables
6713     GenTreePtr compCurLifeTree; // node after which compCurLife has been computed
6714
6715     template <bool ForCodeGen>
6716     void compChangeLife(VARSET_VALARG_TP newLife DEBUGARG(GenTreePtr tree));
6717
6718     void genChangeLife(VARSET_VALARG_TP newLife DEBUGARG(GenTreePtr tree))
6719     {
6720         compChangeLife</*ForCodeGen*/ true>(newLife DEBUGARG(tree));
6721     }
6722
6723     template <bool ForCodeGen>
6724     void compUpdateLife(GenTreePtr tree);
6725
6726     // Updates "compCurLife" to its state after evaluate of "true".  If "pLastUseVars" is
6727     // non-null, sets "*pLastUseVars" to the set of tracked variables for which "tree" was a last
6728     // use.  (Can be more than one var in the case of dependently promoted struct vars.)
6729     template <bool ForCodeGen>
6730     void compUpdateLifeVar(GenTreePtr tree, VARSET_TP* pLastUseVars = nullptr);
6731
6732     template <bool ForCodeGen>
6733     inline void compUpdateLife(VARSET_VALARG_TP newLife);
6734
6735     // Gets a register mask that represent the kill set for a helper call since
6736     // not all JIT Helper calls follow the standard ABI on the target architecture.
6737     regMaskTP compHelperCallKillSet(CorInfoHelpFunc helper);
6738
6739     // Gets a register mask that represent the kill set for a NoGC helper call.
6740     regMaskTP compNoGCHelperCallKillSet(CorInfoHelpFunc helper);
6741
6742 #ifdef _TARGET_ARM_
6743     // Requires that "varDsc" be a promoted struct local variable being passed as an argument, beginning at
6744     // "firstArgRegNum", which is assumed to have already been aligned to the register alignment restriction of the
6745     // struct type. Adds bits to "*pArgSkippedRegMask" for any argument registers *not* used in passing "varDsc" --
6746     // i.e., internal "holes" caused by internal alignment constraints.  For example, if the struct contained an int and
6747     // a double, and we at R0 (on ARM), then R1 would be skipped, and the bit for R1 would be added to the mask.
6748     void fgAddSkippedRegsInPromotedStructArg(LclVarDsc* varDsc, unsigned firstArgRegNum, regMaskTP* pArgSkippedRegMask);
6749 #endif // _TARGET_ARM_
6750
6751     // 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
6752     // node, else NULL.
6753     static GenTreePtr fgIsIndirOfAddrOfLocal(GenTreePtr tree);
6754
6755     // This is indexed by GT_OBJ nodes that are address of promoted struct variables, which
6756     // have been annotated with the GTF_VAR_DEATH flag.  If such a node is *not* mapped in this
6757     // table, one may assume that all the (tracked) field vars die at this point.  Otherwise,
6758     // the node maps to a pointer to a VARSET_TP, containing set bits for each of the tracked field
6759     // vars of the promoted struct local that go dead at the given node (the set bits are the bits
6760     // for the tracked var indices of the field vars, as in a live var set).
6761     NodeToVarsetPtrMap* m_promotedStructDeathVars;
6762
6763     NodeToVarsetPtrMap* GetPromotedStructDeathVars()
6764     {
6765         if (m_promotedStructDeathVars == nullptr)
6766         {
6767             m_promotedStructDeathVars = new (getAllocator()) NodeToVarsetPtrMap(getAllocator());
6768         }
6769         return m_promotedStructDeathVars;
6770     }
6771
6772 /*
6773 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6774 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6775 XX                                                                           XX
6776 XX                           UnwindInfo                                      XX
6777 XX                                                                           XX
6778 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6779 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6780 */
6781
6782 #if !defined(__GNUC__)
6783 #pragma region Unwind information
6784 #endif
6785
6786 public:
6787     //
6788     // Infrastructure functions: start/stop/reserve/emit.
6789     //
6790
6791     void unwindBegProlog();
6792     void unwindEndProlog();
6793     void unwindBegEpilog();
6794     void unwindEndEpilog();
6795     void unwindReserve();
6796     void unwindEmit(void* pHotCode, void* pColdCode);
6797
6798     //
6799     // Specific unwind information functions: called by code generation to indicate a particular
6800     // prolog or epilog unwindable instruction has been generated.
6801     //
6802
6803     void unwindPush(regNumber reg);
6804     void unwindAllocStack(unsigned size);
6805     void unwindSetFrameReg(regNumber reg, unsigned offset);
6806     void unwindSaveReg(regNumber reg, unsigned offset);
6807
6808 #if defined(_TARGET_ARM_)
6809     void unwindPushMaskInt(regMaskTP mask);
6810     void unwindPushMaskFloat(regMaskTP mask);
6811     void unwindPopMaskInt(regMaskTP mask);
6812     void unwindPopMaskFloat(regMaskTP mask);
6813     void unwindBranch16();                    // The epilog terminates with a 16-bit branch (e.g., "bx lr")
6814     void unwindNop(unsigned codeSizeInBytes); // Generate unwind NOP code. 'codeSizeInBytes' is 2 or 4 bytes. Only
6815                                               // called via unwindPadding().
6816     void unwindPadding(); // Generate a sequence of unwind NOP codes representing instructions between the last
6817                           // instruction and the current location.
6818 #endif                    // _TARGET_ARM_
6819
6820 #if defined(_TARGET_ARM64_)
6821     void unwindNop();
6822     void unwindPadding(); // Generate a sequence of unwind NOP codes representing instructions between the last
6823                           // instruction and the current location.
6824     void unwindSaveReg(regNumber reg, int offset);                                // str reg, [sp, #offset]
6825     void unwindSaveRegPreindexed(regNumber reg, int offset);                      // str reg, [sp, #offset]!
6826     void unwindSaveRegPair(regNumber reg1, regNumber reg2, int offset);           // stp reg1, reg2, [sp, #offset]
6827     void unwindSaveRegPairPreindexed(regNumber reg1, regNumber reg2, int offset); // stp reg1, reg2, [sp, #offset]!
6828     void unwindSaveNext();                                                        // unwind code: save_next
6829     void unwindReturn(regNumber reg);                                             // ret lr
6830 #endif                                                                            // defined(_TARGET_ARM64_)
6831
6832     //
6833     // Private "helper" functions for the unwind implementation.
6834     //
6835
6836 private:
6837 #if FEATURE_EH_FUNCLETS
6838     void unwindGetFuncLocations(FuncInfoDsc*             func,
6839                                 bool                     getHotSectionData,
6840                                 /* OUT */ emitLocation** ppStartLoc,
6841                                 /* OUT */ emitLocation** ppEndLoc);
6842 #endif // FEATURE_EH_FUNCLETS
6843
6844     void unwindReserveFunc(FuncInfoDsc* func);
6845     void unwindEmitFunc(FuncInfoDsc* func, void* pHotCode, void* pColdCode);
6846
6847 #if defined(_TARGET_AMD64_) || (defined(_TARGET_X86_) && FEATURE_EH_FUNCLETS)
6848
6849     void unwindReserveFuncHelper(FuncInfoDsc* func, bool isHotCode);
6850     void unwindEmitFuncHelper(FuncInfoDsc* func, void* pHotCode, void* pColdCode, bool isHotCode);
6851
6852 #endif // _TARGET_AMD64_ || (_TARGET_X86_ && FEATURE_EH_FUNCLETS)
6853
6854 #if defined(_TARGET_AMD64_)
6855
6856     UNATIVE_OFFSET unwindGetCurrentOffset(FuncInfoDsc* func);
6857
6858     void unwindBegPrologWindows();
6859     void unwindPushWindows(regNumber reg);
6860     void unwindAllocStackWindows(unsigned size);
6861     void unwindSetFrameRegWindows(regNumber reg, unsigned offset);
6862     void unwindSaveRegWindows(regNumber reg, unsigned offset);
6863
6864 #ifdef UNIX_AMD64_ABI
6865     void unwindBegPrologCFI();
6866     void unwindPushCFI(regNumber reg);
6867     void unwindAllocStackCFI(unsigned size);
6868     void unwindSetFrameRegCFI(regNumber reg, unsigned offset);
6869     void unwindSaveRegCFI(regNumber reg, unsigned offset);
6870     int mapRegNumToDwarfReg(regNumber reg);
6871     void createCfiCode(FuncInfoDsc* func, UCHAR codeOffset, UCHAR opcode, USHORT dwarfReg, INT offset = 0);
6872 #endif // UNIX_AMD64_ABI
6873 #elif defined(_TARGET_ARM_)
6874
6875     void unwindPushPopMaskInt(regMaskTP mask, bool useOpsize16);
6876     void unwindPushPopMaskFloat(regMaskTP mask);
6877     void unwindSplit(FuncInfoDsc* func);
6878
6879 #endif // _TARGET_ARM_
6880
6881 #if !defined(__GNUC__)
6882 #pragma endregion // Note: region is NOT under !defined(__GNUC__)
6883 #endif
6884
6885     /*
6886     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6887     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6888     XX                                                                           XX
6889     XX                               SIMD                                        XX
6890     XX                                                                           XX
6891     XX   Info about SIMD types, methods and the SIMD assembly (i.e. the assembly XX
6892     XX   that contains the distinguished, well-known SIMD type definitions).     XX
6893     XX                                                                           XX
6894     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6895     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6896     */
6897
6898     // Get highest available instruction set for floating point codegen
6899     InstructionSet getFloatingPointInstructionSet()
6900     {
6901 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
6902         if (canUseAVX())
6903         {
6904             return InstructionSet_AVX;
6905         }
6906
6907         if (CanUseSSE3_4())
6908         {
6909             return InstructionSet_SSE3_4;
6910         }
6911
6912         // min bar is SSE2
6913         assert(canUseSSE2());
6914         return InstructionSet_SSE2;
6915 #else
6916         assert(!"getFPInstructionSet() is not implemented for target arch");
6917         unreached();
6918         return InstructionSet_NONE;
6919 #endif
6920     }
6921
6922     // Get highest available instruction set for SIMD codegen
6923     InstructionSet getSIMDInstructionSet()
6924     {
6925 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
6926         return getFloatingPointInstructionSet();
6927 #else
6928         assert(!"Available instruction set(s) for SIMD codegen is not defined for target arch");
6929         unreached();
6930         return InstructionSet_NONE;
6931 #endif
6932     }
6933
6934 #ifdef FEATURE_SIMD
6935
6936     // Should we support SIMD intrinsics?
6937     bool featureSIMD;
6938
6939     // Have we identified any SIMD types?
6940     // This is currently used by struct promotion to avoid getting type information for a struct
6941     // field to see if it is a SIMD type, if we haven't seen any SIMD types or operations in
6942     // the method.
6943     bool _usesSIMDTypes;
6944     bool usesSIMDTypes()
6945     {
6946         return _usesSIMDTypes;
6947     }
6948     void setUsesSIMDTypes(bool value)
6949     {
6950         _usesSIMDTypes = value;
6951     }
6952
6953     // This is a temp lclVar allocated on the stack as TYP_SIMD.  It is used to implement intrinsics
6954     // that require indexed access to the individual fields of the vector, which is not well supported
6955     // by the hardware.  It is allocated when/if such situations are encountered during Lowering.
6956     unsigned lvaSIMDInitTempVarNum;
6957
6958     // SIMD Types
6959     CORINFO_CLASS_HANDLE SIMDFloatHandle;
6960     CORINFO_CLASS_HANDLE SIMDDoubleHandle;
6961     CORINFO_CLASS_HANDLE SIMDIntHandle;
6962     CORINFO_CLASS_HANDLE SIMDUShortHandle;
6963     CORINFO_CLASS_HANDLE SIMDUByteHandle;
6964     CORINFO_CLASS_HANDLE SIMDShortHandle;
6965     CORINFO_CLASS_HANDLE SIMDByteHandle;
6966     CORINFO_CLASS_HANDLE SIMDLongHandle;
6967     CORINFO_CLASS_HANDLE SIMDUIntHandle;
6968     CORINFO_CLASS_HANDLE SIMDULongHandle;
6969     CORINFO_CLASS_HANDLE SIMDVector2Handle;
6970     CORINFO_CLASS_HANDLE SIMDVector3Handle;
6971     CORINFO_CLASS_HANDLE SIMDVector4Handle;
6972     CORINFO_CLASS_HANDLE SIMDVectorHandle;
6973
6974     // Get the handle for a SIMD type.
6975     CORINFO_CLASS_HANDLE gtGetStructHandleForSIMD(var_types simdType, var_types simdBaseType)
6976     {
6977         if (simdBaseType == TYP_FLOAT)
6978         {
6979             switch (simdType)
6980             {
6981                 case TYP_SIMD8:
6982                     return SIMDVector2Handle;
6983                 case TYP_SIMD12:
6984                     return SIMDVector3Handle;
6985                 case TYP_SIMD16:
6986                     if ((getSIMDVectorType() == TYP_SIMD32) || (SIMDVector4Handle != NO_CLASS_HANDLE))
6987                     {
6988                         return SIMDVector4Handle;
6989                     }
6990                     break;
6991                 case TYP_SIMD32:
6992                     break;
6993                 default:
6994                     unreached();
6995             }
6996         }
6997         assert(simdType == getSIMDVectorType());
6998         switch (simdBaseType)
6999         {
7000             case TYP_FLOAT:
7001                 return SIMDFloatHandle;
7002             case TYP_DOUBLE:
7003                 return SIMDDoubleHandle;
7004             case TYP_INT:
7005                 return SIMDIntHandle;
7006             case TYP_CHAR:
7007                 return SIMDUShortHandle;
7008             case TYP_USHORT:
7009                 return SIMDUShortHandle;
7010             case TYP_UBYTE:
7011                 return SIMDUByteHandle;
7012             case TYP_SHORT:
7013                 return SIMDShortHandle;
7014             case TYP_BYTE:
7015                 return SIMDByteHandle;
7016             case TYP_LONG:
7017                 return SIMDLongHandle;
7018             case TYP_UINT:
7019                 return SIMDUIntHandle;
7020             case TYP_ULONG:
7021                 return SIMDULongHandle;
7022             default:
7023                 assert(!"Didn't find a class handle for simdType");
7024         }
7025         return NO_CLASS_HANDLE;
7026     }
7027
7028     // SIMD Methods
7029     CORINFO_METHOD_HANDLE SIMDVectorFloat_set_Item;
7030     CORINFO_METHOD_HANDLE SIMDVectorFloat_get_Length;
7031     CORINFO_METHOD_HANDLE SIMDVectorFloat_op_Addition;
7032
7033     // Returns true if the tree corresponds to a TYP_SIMD lcl var.
7034     // Note that both SIMD vector args and locals are mared as lvSIMDType = true, but
7035     // type of an arg node is TYP_BYREF and a local node is TYP_SIMD or TYP_STRUCT.
7036     bool isSIMDTypeLocal(GenTree* tree)
7037     {
7038         return tree->OperIsLocal() && lvaTable[tree->AsLclVarCommon()->gtLclNum].lvSIMDType;
7039     }
7040
7041     // Returns true if the type of the tree is a byref of TYP_SIMD
7042     bool isAddrOfSIMDType(GenTree* tree)
7043     {
7044         if (tree->TypeGet() == TYP_BYREF || tree->TypeGet() == TYP_I_IMPL)
7045         {
7046             switch (tree->OperGet())
7047             {
7048                 case GT_ADDR:
7049                     return varTypeIsSIMD(tree->gtGetOp1());
7050
7051                 case GT_LCL_VAR_ADDR:
7052                     return lvaTable[tree->AsLclVarCommon()->gtLclNum].lvSIMDType;
7053
7054                 default:
7055                     return isSIMDTypeLocal(tree);
7056             }
7057         }
7058
7059         return false;
7060     }
7061
7062     static bool isRelOpSIMDIntrinsic(SIMDIntrinsicID intrinsicId)
7063     {
7064         return (intrinsicId == SIMDIntrinsicEqual || intrinsicId == SIMDIntrinsicLessThan ||
7065                 intrinsicId == SIMDIntrinsicLessThanOrEqual || intrinsicId == SIMDIntrinsicGreaterThan ||
7066                 intrinsicId == SIMDIntrinsicGreaterThanOrEqual);
7067     }
7068
7069     // Returns base type of a TYP_SIMD local.
7070     // Returns TYP_UNKNOWN if the local is not TYP_SIMD.
7071     var_types getBaseTypeOfSIMDLocal(GenTree* tree)
7072     {
7073         if (isSIMDTypeLocal(tree))
7074         {
7075             return lvaTable[tree->AsLclVarCommon()->gtLclNum].lvBaseType;
7076         }
7077
7078         return TYP_UNKNOWN;
7079     }
7080
7081     bool isSIMDClass(CORINFO_CLASS_HANDLE clsHnd)
7082     {
7083         return info.compCompHnd->isInSIMDModule(clsHnd);
7084     }
7085
7086     bool isSIMDClass(typeInfo* pTypeInfo)
7087     {
7088         return pTypeInfo->IsStruct() && isSIMDClass(pTypeInfo->GetClassHandleForValueClass());
7089     }
7090
7091     // Get the base (element) type and size in bytes for a SIMD type. Returns TYP_UNKNOWN
7092     // if it is not a SIMD type or is an unsupported base type.
7093     var_types getBaseTypeAndSizeOfSIMDType(CORINFO_CLASS_HANDLE typeHnd, unsigned* sizeBytes = nullptr);
7094
7095     var_types getBaseTypeOfSIMDType(CORINFO_CLASS_HANDLE typeHnd)
7096     {
7097         return getBaseTypeAndSizeOfSIMDType(typeHnd, nullptr);
7098     }
7099
7100     // Get SIMD Intrinsic info given the method handle.
7101     // Also sets typeHnd, argCount, baseType and sizeBytes out params.
7102     const SIMDIntrinsicInfo* getSIMDIntrinsicInfo(CORINFO_CLASS_HANDLE* typeHnd,
7103                                                   CORINFO_METHOD_HANDLE methodHnd,
7104                                                   CORINFO_SIG_INFO*     sig,
7105                                                   bool                  isNewObj,
7106                                                   unsigned*             argCount,
7107                                                   var_types*            baseType,
7108                                                   unsigned*             sizeBytes);
7109
7110     // Pops and returns GenTree node from importers type stack.
7111     // Normalizes TYP_STRUCT value in case of GT_CALL, GT_RET_EXPR and arg nodes.
7112     GenTreePtr impSIMDPopStack(var_types type, bool expectAddr = false);
7113
7114     // Create a GT_SIMD tree for a Get property of SIMD vector with a fixed index.
7115     GenTreeSIMD* impSIMDGetFixed(var_types simdType, var_types baseType, unsigned simdSize, int index);
7116
7117     // Creates a GT_SIMD tree for Select operation
7118     GenTreePtr impSIMDSelect(CORINFO_CLASS_HANDLE typeHnd,
7119                              var_types            baseType,
7120                              unsigned             simdVectorSize,
7121                              GenTree*             op1,
7122                              GenTree*             op2,
7123                              GenTree*             op3);
7124
7125     // Creates a GT_SIMD tree for Min/Max operation
7126     GenTreePtr impSIMDMinMax(SIMDIntrinsicID      intrinsicId,
7127                              CORINFO_CLASS_HANDLE typeHnd,
7128                              var_types            baseType,
7129                              unsigned             simdVectorSize,
7130                              GenTree*             op1,
7131                              GenTree*             op2);
7132
7133     // Transforms operands and returns the SIMD intrinsic to be applied on
7134     // transformed operands to obtain given relop result.
7135     SIMDIntrinsicID impSIMDRelOp(SIMDIntrinsicID      relOpIntrinsicId,
7136                                  CORINFO_CLASS_HANDLE typeHnd,
7137                                  unsigned             simdVectorSize,
7138                                  var_types*           baseType,
7139                                  GenTree**            op1,
7140                                  GenTree**            op2);
7141
7142     // Creates a GT_SIMD tree for Abs intrinsic.
7143     GenTreePtr impSIMDAbs(CORINFO_CLASS_HANDLE typeHnd, var_types baseType, unsigned simdVectorSize, GenTree* op1);
7144
7145 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7146     // Transforms operands and returns the SIMD intrinsic to be applied on
7147     // transformed operands to obtain == comparison result.
7148     SIMDIntrinsicID impSIMDLongRelOpEqual(CORINFO_CLASS_HANDLE typeHnd,
7149                                           unsigned             simdVectorSize,
7150                                           GenTree**            op1,
7151                                           GenTree**            op2);
7152
7153     // Transforms operands and returns the SIMD intrinsic to be applied on
7154     // transformed operands to obtain > comparison result.
7155     SIMDIntrinsicID impSIMDLongRelOpGreaterThan(CORINFO_CLASS_HANDLE typeHnd,
7156                                                 unsigned             simdVectorSize,
7157                                                 GenTree**            op1,
7158                                                 GenTree**            op2);
7159
7160     // Transforms operands and returns the SIMD intrinsic to be applied on
7161     // transformed operands to obtain >= comparison result.
7162     SIMDIntrinsicID impSIMDLongRelOpGreaterThanOrEqual(CORINFO_CLASS_HANDLE typeHnd,
7163                                                        unsigned             simdVectorSize,
7164                                                        GenTree**            op1,
7165                                                        GenTree**            op2);
7166
7167     // Transforms operands and returns the SIMD intrinsic to be applied on
7168     // transformed operands to obtain >= comparison result in case of int32
7169     // and small int base type vectors.
7170     SIMDIntrinsicID impSIMDIntegralRelOpGreaterThanOrEqual(
7171         CORINFO_CLASS_HANDLE typeHnd, unsigned simdVectorSize, var_types baseType, GenTree** op1, GenTree** op2);
7172 #endif // defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7173
7174     void setLclRelatedToSIMDIntrinsic(GenTreePtr tree);
7175     bool areFieldsContiguous(GenTreePtr op1, GenTreePtr op2);
7176     bool areArrayElementsContiguous(GenTreePtr op1, GenTreePtr op2);
7177     bool areArgumentsContiguous(GenTreePtr op1, GenTreePtr op2);
7178     GenTreePtr createAddressNodeForSIMDInit(GenTreePtr tree, unsigned simdSize);
7179
7180     // check methodHnd to see if it is a SIMD method that is expanded as an intrinsic in the JIT.
7181     GenTreePtr impSIMDIntrinsic(OPCODE                opcode,
7182                                 GenTreePtr            newobjThis,
7183                                 CORINFO_CLASS_HANDLE  clsHnd,
7184                                 CORINFO_METHOD_HANDLE method,
7185                                 CORINFO_SIG_INFO*     sig,
7186                                 int                   memberRef);
7187
7188     GenTreePtr getOp1ForConstructor(OPCODE opcode, GenTreePtr newobjThis, CORINFO_CLASS_HANDLE clsHnd);
7189
7190     // Whether SIMD vector occupies part of SIMD register.
7191     // SSE2: vector2f/3f are considered sub register SIMD types.
7192     // AVX: vector2f, 3f and 4f are all considered sub register SIMD types.
7193     bool isSubRegisterSIMDType(CORINFO_CLASS_HANDLE typeHnd)
7194     {
7195         unsigned  sizeBytes = 0;
7196         var_types baseType  = getBaseTypeAndSizeOfSIMDType(typeHnd, &sizeBytes);
7197         return (baseType == TYP_FLOAT) && (sizeBytes < getSIMDVectorRegisterByteLength());
7198     }
7199
7200     bool isSubRegisterSIMDType(GenTreeSIMD* simdNode)
7201     {
7202         return (simdNode->gtSIMDSize < getSIMDVectorRegisterByteLength());
7203     }
7204
7205     // Get the type for the hardware SIMD vector.
7206     // This is the maximum SIMD type supported for this target.
7207     var_types getSIMDVectorType()
7208     {
7209 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7210         if (canUseAVX())
7211         {
7212             return TYP_SIMD32;
7213         }
7214         else
7215         {
7216             assert(canUseSSE2());
7217             return TYP_SIMD16;
7218         }
7219 #else
7220         assert(!"getSIMDVectorType() unimplemented on target arch");
7221         unreached();
7222 #endif
7223     }
7224
7225     // Get the size of the SIMD type in bytes
7226     int getSIMDTypeSizeInBytes(CORINFO_CLASS_HANDLE typeHnd)
7227     {
7228         unsigned sizeBytes = 0;
7229         (void)getBaseTypeAndSizeOfSIMDType(typeHnd, &sizeBytes);
7230         return sizeBytes;
7231     }
7232
7233     // Get the the number of elements of basetype of SIMD vector given by its size and baseType
7234     static int getSIMDVectorLength(unsigned simdSize, var_types baseType);
7235
7236     // Get the the number of elements of basetype of SIMD vector given by its type handle
7237     int getSIMDVectorLength(CORINFO_CLASS_HANDLE typeHnd);
7238
7239     // Get preferred alignment of SIMD type.
7240     int getSIMDTypeAlignment(var_types simdType);
7241
7242     // Get the number of bytes in a SIMD Vector for the current compilation.
7243     unsigned getSIMDVectorRegisterByteLength()
7244     {
7245 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7246         if (canUseAVX())
7247         {
7248             return YMM_REGSIZE_BYTES;
7249         }
7250         else
7251         {
7252             assert(canUseSSE2());
7253             return XMM_REGSIZE_BYTES;
7254         }
7255 #else
7256         assert(!"getSIMDVectorRegisterByteLength() unimplemented on target arch");
7257         unreached();
7258 #endif
7259     }
7260
7261     // The minimum and maximum possible number of bytes in a SIMD vector.
7262     unsigned int maxSIMDStructBytes()
7263     {
7264         return getSIMDVectorRegisterByteLength();
7265     }
7266     unsigned int minSIMDStructBytes()
7267     {
7268         return emitTypeSize(TYP_SIMD8);
7269     }
7270
7271 #ifdef FEATURE_AVX_SUPPORT
7272     // (maxPossibleSIMDStructBytes is for use in a context that requires a compile-time constant.)
7273     static const unsigned maxPossibleSIMDStructBytes = 32;
7274 #else  // !FEATURE_AVX_SUPPORT
7275     static const unsigned maxPossibleSIMDStructBytes = 16;
7276 #endif // !FEATURE_AVX_SUPPORT
7277
7278     // Returns the codegen type for a given SIMD size.
7279     var_types getSIMDTypeForSize(unsigned size)
7280     {
7281         var_types simdType = TYP_UNDEF;
7282         if (size == 8)
7283         {
7284             simdType = TYP_SIMD8;
7285         }
7286         else if (size == 12)
7287         {
7288             simdType = TYP_SIMD12;
7289         }
7290         else if (size == 16)
7291         {
7292             simdType = TYP_SIMD16;
7293         }
7294 #ifdef FEATURE_AVX_SUPPORT
7295         else if (size == 32)
7296         {
7297             simdType = TYP_SIMD32;
7298         }
7299 #endif // FEATURE_AVX_SUPPORT
7300         else
7301         {
7302             noway_assert(!"Unexpected size for SIMD type");
7303         }
7304         return simdType;
7305     }
7306
7307     unsigned getSIMDInitTempVarNum()
7308     {
7309         if (lvaSIMDInitTempVarNum == BAD_VAR_NUM)
7310         {
7311             lvaSIMDInitTempVarNum                  = lvaGrabTempWithImplicitUse(false DEBUGARG("SIMDInitTempVar"));
7312             lvaTable[lvaSIMDInitTempVarNum].lvType = getSIMDVectorType();
7313         }
7314         return lvaSIMDInitTempVarNum;
7315     }
7316
7317 #endif // FEATURE_SIMD
7318
7319 public:
7320     //------------------------------------------------------------------------
7321     // largestEnregisterableStruct: The size in bytes of the largest struct that can be enregistered.
7322     //
7323     // Notes: It is not guaranteed that the struct of this size or smaller WILL be a
7324     //        candidate for enregistration.
7325
7326     unsigned largestEnregisterableStructSize()
7327     {
7328 #ifdef FEATURE_SIMD
7329         unsigned vectorRegSize = getSIMDVectorRegisterByteLength();
7330         if (vectorRegSize > TARGET_POINTER_SIZE)
7331         {
7332             return vectorRegSize;
7333         }
7334         else
7335 #endif // FEATURE_SIMD
7336         {
7337             return TARGET_POINTER_SIZE;
7338         }
7339     }
7340
7341 private:
7342     // These routines need not be enclosed under FEATURE_SIMD since lvIsSIMDType()
7343     // is defined for both FEATURE_SIMD and !FEATURE_SIMD apropriately. The use
7344     // of this routines also avoids the need of #ifdef FEATURE_SIMD specific code.
7345
7346     // Is this var is of type simd struct?
7347     bool lclVarIsSIMDType(unsigned varNum)
7348     {
7349         LclVarDsc* varDsc = lvaTable + varNum;
7350         return varDsc->lvIsSIMDType();
7351     }
7352
7353     // Is this Local node a SIMD local?
7354     bool lclVarIsSIMDType(GenTreeLclVarCommon* lclVarTree)
7355     {
7356         return lclVarIsSIMDType(lclVarTree->gtLclNum);
7357     }
7358
7359     // Returns true if the TYP_SIMD locals on stack are aligned at their
7360     // preferred byte boundary specified by getSIMDTypeAlignment().
7361     //
7362     // As per the Intel manual, the preferred alignment for AVX vectors is 32-bytes. On Amd64,
7363     // RSP/EBP is aligned at 16-bytes, therefore to align SIMD types at 32-bytes we need even
7364     // RSP/EBP to be 32-byte aligned. It is not clear whether additional stack space used in
7365     // aligning stack is worth the benefit and for now will use 16-byte alignment for AVX
7366     // 256-bit vectors with unaligned load/stores to/from memory. On x86, the stack frame
7367     // is aligned to 4 bytes. We need to extend existing support for double (8-byte) alignment
7368     // to 16 or 32 byte alignment for frames with local SIMD vars, if that is determined to be
7369     // profitable.
7370     //
7371     bool isSIMDTypeLocalAligned(unsigned varNum)
7372     {
7373 #if defined(FEATURE_SIMD) && ALIGN_SIMD_TYPES
7374         if (lclVarIsSIMDType(varNum) && lvaTable[varNum].lvType != TYP_BYREF)
7375         {
7376             bool ebpBased;
7377             int  off = lvaFrameAddress(varNum, &ebpBased);
7378             // TODO-Cleanup: Can't this use the lvExactSize on the varDsc?
7379             int  alignment = getSIMDTypeAlignment(lvaTable[varNum].lvType);
7380             bool isAligned = (alignment <= STACK_ALIGN) && ((off % alignment) == 0);
7381             return isAligned;
7382         }
7383 #endif // FEATURE_SIMD
7384
7385         return false;
7386     }
7387
7388     // Whether SSE2 is available
7389     bool canUseSSE2() const
7390     {
7391 #ifdef _TARGET_XARCH_
7392         return opts.compCanUseSSE2;
7393 #else
7394         return false;
7395 #endif
7396     }
7397
7398     // Whether SSE3, SSE3, SSE4.1 and SSE4.2 is available
7399     bool CanUseSSE3_4() const
7400     {
7401 #ifdef _TARGET_XARCH_
7402         return opts.compCanUseSSE3_4;
7403 #else
7404         return false;
7405 #endif
7406     }
7407
7408     bool canUseAVX() const
7409     {
7410 #ifdef FEATURE_AVX_SUPPORT
7411         return opts.compCanUseAVX;
7412 #else
7413         return false;
7414 #endif
7415     }
7416
7417     /*
7418     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7419     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7420     XX                                                                           XX
7421     XX                           Compiler                                        XX
7422     XX                                                                           XX
7423     XX   Generic info about the compilation and the method being compiled.       XX
7424     XX   It is responsible for driving the other phases.                         XX
7425     XX   It is also responsible for all the memory management.                   XX
7426     XX                                                                           XX
7427     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7428     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7429     */
7430
7431 public:
7432     Compiler* InlineeCompiler; // The Compiler instance for the inlinee
7433
7434     InlineResult* compInlineResult; // The result of importing the inlinee method.
7435
7436     bool compDoAggressiveInlining; // If true, mark every method as CORINFO_FLG_FORCEINLINE
7437     bool compJmpOpUsed;            // Does the method do a JMP
7438     bool compLongUsed;             // Does the method use TYP_LONG
7439     bool compFloatingPointUsed;    // Does the method use TYP_FLOAT or TYP_DOUBLE
7440     bool compTailCallUsed;         // Does the method do a tailcall
7441     bool compLocallocUsed;         // Does the method use localloc.
7442     bool compQmarkUsed;            // Does the method use GT_QMARK/GT_COLON
7443     bool compQmarkRationalized;    // Is it allowed to use a GT_QMARK/GT_COLON node.
7444     bool compUnsafeCastUsed;       // Does the method use LDIND/STIND to cast between scalar/refernce types
7445
7446     // NOTE: These values are only reliable after
7447     //       the importing is completely finished.
7448
7449     ExpandArrayStack<GenTreePtr>* compQMarks; // The set of QMark nodes created in the current compilation, so
7450                                               // we can iterate over these efficiently.
7451
7452 #if CPU_USES_BLOCK_MOVE
7453     bool compBlkOpUsed; // Does the method do a COPYBLK or INITBLK
7454 #endif
7455
7456 #ifdef DEBUG
7457     // State information - which phases have completed?
7458     // These are kept together for easy discoverability
7459
7460     bool    bRangeAllowStress;
7461     bool    compCodeGenDone;
7462     int64_t compNumStatementLinksTraversed; // # of links traversed while doing debug checks
7463     bool    fgNormalizeEHDone;              // Has the flowgraph EH normalization phase been done?
7464     size_t  compSizeEstimate;               // The estimated size of the method as per `gtSetEvalOrder`.
7465     size_t  compCycleEstimate;              // The estimated cycle count of the method as per `gtSetEvalOrder`
7466 #endif                                      // DEBUG
7467
7468     bool fgLocalVarLivenessDone; // Note that this one is used outside of debug.
7469     bool fgLocalVarLivenessChanged;
7470 #if STACK_PROBES
7471     bool compStackProbePrologDone;
7472 #endif
7473 #ifndef LEGACY_BACKEND
7474     bool compLSRADone;
7475 #endif // !LEGACY_BACKEND
7476     bool compRationalIRForm;
7477
7478     bool compUsesThrowHelper; // There is a call to a THOROW_HELPER for the compiled method.
7479
7480     bool compGeneratingProlog;
7481     bool compGeneratingEpilog;
7482     bool compNeedsGSSecurityCookie; // There is an unsafe buffer (or localloc) on the stack.
7483                                     // Insert cookie on frame and code to check the cookie, like VC++ -GS.
7484     bool compGSReorderStackLayout;  // There is an unsafe buffer on the stack, reorder locals and make local
7485     // copies of susceptible parameters to avoid buffer overrun attacks through locals/params
7486     bool getNeedsGSSecurityCookie() const
7487     {
7488         return compNeedsGSSecurityCookie;
7489     }
7490     void setNeedsGSSecurityCookie()
7491     {
7492         compNeedsGSSecurityCookie = true;
7493     }
7494
7495     FrameLayoutState lvaDoneFrameLayout; // The highest frame layout state that we've completed. During
7496                                          // frame layout calculations, this is the level we are currently
7497                                          // computing.
7498
7499     //---------------------------- JITing options -----------------------------
7500
7501     enum codeOptimize
7502     {
7503         BLENDED_CODE,
7504         SMALL_CODE,
7505         FAST_CODE,
7506
7507         COUNT_OPT_CODE
7508     };
7509
7510     struct Options
7511     {
7512         JitFlags* jitFlags;  // all flags passed from the EE
7513         unsigned  compFlags; // method attributes
7514
7515         codeOptimize compCodeOpt; // what type of code optimizations
7516
7517         bool compUseFCOMI;
7518         bool compUseCMOV;
7519 #ifdef _TARGET_XARCH_
7520         bool compCanUseSSE2;   // Allow CodeGen to use "movq XMM" instructions
7521         bool compCanUseSSE3_4; // Allow CodeGen to use SSE3, SSSE3, SSE4.1 and SSE4.2 instructions
7522
7523 #ifdef FEATURE_AVX_SUPPORT
7524         bool compCanUseAVX; // Allow CodeGen to use AVX 256-bit vectors for SIMD operations
7525 #endif                      // FEATURE_AVX_SUPPORT
7526 #endif                      // _TARGET_XARCH_
7527
7528 // optimize maximally and/or favor speed over size?
7529
7530 #define DEFAULT_MIN_OPTS_CODE_SIZE 60000
7531 #define DEFAULT_MIN_OPTS_INSTR_COUNT 20000
7532 #define DEFAULT_MIN_OPTS_BB_COUNT 2000
7533 #define DEFAULT_MIN_OPTS_LV_NUM_COUNT 2000
7534 #define DEFAULT_MIN_OPTS_LV_REF_COUNT 8000
7535
7536 // Maximun number of locals before turning off the inlining
7537 #define MAX_LV_NUM_COUNT_FOR_INLINING 512
7538
7539         bool     compMinOpts;
7540         unsigned instrCount;
7541         unsigned lvRefCount;
7542         bool     compMinOptsIsSet;
7543 #ifdef DEBUG
7544         bool compMinOptsIsUsed;
7545
7546         inline bool MinOpts()
7547         {
7548             assert(compMinOptsIsSet);
7549             compMinOptsIsUsed = true;
7550             return compMinOpts;
7551         }
7552         inline bool IsMinOptsSet()
7553         {
7554             return compMinOptsIsSet;
7555         }
7556 #else  // !DEBUG
7557         inline bool MinOpts()
7558         {
7559             return compMinOpts;
7560         }
7561         inline bool IsMinOptsSet()
7562         {
7563             return compMinOptsIsSet;
7564         }
7565 #endif // !DEBUG
7566         inline void SetMinOpts(bool val)
7567         {
7568             assert(!compMinOptsIsUsed);
7569             assert(!compMinOptsIsSet || (compMinOpts == val));
7570             compMinOpts      = val;
7571             compMinOptsIsSet = true;
7572         }
7573
7574         // true if the CLFLG_* for an optimization is set.
7575         inline bool OptEnabled(unsigned optFlag)
7576         {
7577             return !!(compFlags & optFlag);
7578         }
7579
7580 #ifdef FEATURE_READYTORUN_COMPILER
7581         inline bool IsReadyToRun()
7582         {
7583             return jitFlags->IsSet(JitFlags::JIT_FLAG_READYTORUN);
7584         }
7585 #else
7586         inline bool IsReadyToRun()
7587         {
7588             return false;
7589         }
7590 #endif
7591
7592         // true if we should use the PINVOKE_{BEGIN,END} helpers instead of generating
7593         // PInvoke transitions inline (e.g. when targeting CoreRT).
7594         inline bool ShouldUsePInvokeHelpers()
7595         {
7596 #if COR_JIT_EE_VERSION > 460
7597             return jitFlags->IsSet(JitFlags::JIT_FLAG_USE_PINVOKE_HELPERS);
7598 #else
7599             return false;
7600 #endif
7601         }
7602
7603         // true if we should use insert the REVERSE_PINVOKE_{ENTER,EXIT} helpers in the method
7604         // prolog/epilog
7605         inline bool IsReversePInvoke()
7606         {
7607 #if COR_JIT_EE_VERSION > 460
7608             return jitFlags->IsSet(JitFlags::JIT_FLAG_REVERSE_PINVOKE);
7609 #else
7610             return false;
7611 #endif
7612         }
7613
7614         // true if we must generate code compatible with JIT32 quirks
7615         inline bool IsJit32Compat()
7616         {
7617 #if defined(_TARGET_X86_) && COR_JIT_EE_VERSION > 460
7618             return jitFlags->IsSet(JitFlags::JIT_FLAG_DESKTOP_QUIRKS);
7619 #else
7620             return false;
7621 #endif
7622         }
7623
7624         // true if we must generate code compatible with Jit64 quirks
7625         inline bool IsJit64Compat()
7626         {
7627 #if defined(_TARGET_AMD64_) && COR_JIT_EE_VERSION > 460
7628             return jitFlags->IsSet(JitFlags::JIT_FLAG_DESKTOP_QUIRKS);
7629 #elif defined(_TARGET_AMD64_) && !defined(FEATURE_CORECLR)
7630             return true;
7631 #else
7632             return false;
7633 #endif
7634         }
7635
7636         bool compScopeInfo; // Generate the LocalVar info ?
7637         bool compDbgCode;   // Generate debugger-friendly code?
7638         bool compDbgInfo;   // Gather debugging info?
7639         bool compDbgEnC;
7640
7641 #ifdef PROFILING_SUPPORTED
7642         bool compNoPInvokeInlineCB;
7643 #else
7644         static const bool compNoPInvokeInlineCB;
7645 #endif
7646
7647 #ifdef DEBUG
7648         bool compGcChecks;         // Check arguments and return values to ensure they are sane
7649         bool compStackCheckOnRet;  // Check ESP on return to ensure it is correct
7650         bool compStackCheckOnCall; // Check ESP after every call to ensure it is correct
7651
7652 #endif
7653
7654         bool compNeedSecurityCheck; // This flag really means where or not a security object needs
7655                                     // to be allocated on the stack.
7656                                     // It will be set to true in the following cases:
7657                                     //   1. When the method being compiled has a declarative security
7658                                     //        (i.e. when CORINFO_FLG_NOSECURITYWRAP is reset for the current method).
7659                                     //        This is also the case when we inject a prolog and epilog in the method.
7660                                     //   (or)
7661                                     //   2. When the method being compiled has imperative security (i.e. the method
7662                                     //        calls into another method that has CORINFO_FLG_SECURITYCHECK flag set).
7663                                     //   (or)
7664                                     //   3. When opts.compDbgEnC is true. (See also Compiler::compCompile).
7665                                     //
7666 // When this flag is set, jit will allocate a gc-reference local variable (lvaSecurityObject),
7667 // which gets reported as a GC root to stackwalker.
7668 // (See also ICodeManager::GetAddrOfSecurityObject.)
7669
7670 #if RELOC_SUPPORT
7671         bool compReloc;
7672 #endif
7673
7674 #ifdef DEBUG
7675 #if defined(_TARGET_XARCH_) && !defined(LEGACY_BACKEND)
7676         bool compEnablePCRelAddr; // Whether absolute addr be encoded as PC-rel offset by RyuJIT where possible
7677 #endif
7678 #endif // DEBUG
7679
7680 #ifdef UNIX_AMD64_ABI
7681         // This flag  is indicating if there is a need to align the frame.
7682         // On AMD64-Windows, if there are calls, 4 slots for the outgoing ars are allocated, except for
7683         // FastTailCall. This slots makes the frame size non-zero, so alignment logic will be called.
7684         // On AMD64-Unix, there are no such slots. There is a possibility to have calls in the method with frame size of
7685         // 0. The frame alignment logic won't kick in. This flags takes care of the AMD64-Unix case by remembering that
7686         // there are calls and making sure the frame alignment logic is executed.
7687         bool compNeedToAlignFrame;
7688 #endif // UNIX_AMD64_ABI
7689
7690         bool compProcedureSplitting; // Separate cold code from hot code
7691
7692         bool genFPorder; // Preserve FP order (operations are non-commutative)
7693         bool genFPopt;   // Can we do frame-pointer-omission optimization?
7694         bool altJit;     // True if we are an altjit and are compiling this method
7695
7696 #ifdef DEBUG
7697         bool optRepeat;                // Repeat optimizer phases k times
7698         bool compProcedureSplittingEH; // Separate cold code from hot code for functions with EH
7699         bool dspCode;                  // Display native code generated
7700         bool dspEHTable;               // Display the EH table reported to the VM
7701         bool dspInstrs;                // Display the IL instructions intermixed with the native code output
7702         bool dspEmit;                  // Display emitter output
7703         bool dspLines;                 // Display source-code lines intermixed with native code output
7704         bool dmpHex;                   // Display raw bytes in hex of native code output
7705         bool varNames;                 // Display variables names in native code output
7706         bool disAsm;                   // Display native code as it is generated
7707         bool disAsmSpilled;            // Display native code when any register spilling occurs
7708         bool disDiffable;              // Makes the Disassembly code 'diff-able'
7709         bool disAsm2;                  // Display native code after it is generated using external disassembler
7710         bool dspOrder;                 // Display names of each of the methods that we ngen/jit
7711         bool dspUnwind;                // Display the unwind info output
7712         bool dspDiffable;     // Makes the Jit Dump 'diff-able' (currently uses same COMPlus_* flag as disDiffable)
7713         bool compLongAddress; // Force using large pseudo instructions for long address
7714                               // (IF_LARGEJMP/IF_LARGEADR/IF_LARGLDC)
7715         bool dspGCtbls;       // Display the GC tables
7716 #endif
7717
7718 #ifdef LATE_DISASM
7719         bool doLateDisasm; // Run the late disassembler
7720 #endif                     // LATE_DISASM
7721
7722 #if DUMP_GC_TABLES && !defined(DEBUG) && defined(JIT32_GCENCODER)
7723 // Only the JIT32_GCENCODER implements GC dumping in non-DEBUG code.
7724 #pragma message("NOTE: this non-debug build has GC ptr table dumping always enabled!")
7725         static const bool dspGCtbls = true;
7726 #endif
7727
7728         // We need stack probes to guarantee that we won't trigger a stack overflow
7729         // when calling unmanaged code until they get a chance to set up a frame, because
7730         // the EE will have no idea where it is.
7731         //
7732         // We will only be doing this currently for hosted environments. Unfortunately
7733         // we need to take care of stubs, so potentially, we will have to do the probes
7734         // for any call. We have a plan for not needing for stubs though
7735         bool compNeedStackProbes;
7736
7737 #ifdef PROFILING_SUPPORTED
7738         // Whether to emit Enter/Leave/TailCall hooks using a dummy stub (DummyProfilerELTStub()).
7739         // This option helps make the JIT behave as if it is running under a profiler.
7740         bool compJitELTHookEnabled;
7741 #endif // PROFILING_SUPPORTED
7742
7743 #if FEATURE_TAILCALL_OPT
7744         // Whether opportunistic or implicit tail call optimization is enabled.
7745         bool compTailCallOpt;
7746         // Whether optimization of transforming a recursive tail call into a loop is enabled.
7747         bool compTailCallLoopOpt;
7748 #endif
7749
7750 #ifdef ARM_SOFTFP
7751         static const bool compUseSoftFP = true;
7752 #else // !ARM_SOFTFP
7753         static const bool compUseSoftFP = false;
7754 #endif
7755
7756         GCPollType compGCPollType;
7757     } opts;
7758
7759 #ifdef ALT_JIT
7760     static bool                s_pAltJitExcludeAssembliesListInitialized;
7761     static AssemblyNamesList2* s_pAltJitExcludeAssembliesList;
7762 #endif // ALT_JIT
7763
7764 #ifdef DEBUG
7765
7766     template <typename T>
7767     T dspPtr(T p)
7768     {
7769         return (p == ZERO) ? ZERO : (opts.dspDiffable ? T(0xD1FFAB1E) : p);
7770     }
7771
7772     template <typename T>
7773     T dspOffset(T o)
7774     {
7775         return (o == ZERO) ? ZERO : (opts.dspDiffable ? T(0xD1FFAB1E) : o);
7776     }
7777
7778     static int dspTreeID(GenTree* tree)
7779     {
7780         return tree->gtTreeID;
7781     }
7782     static void printTreeID(GenTree* tree)
7783     {
7784         if (tree == nullptr)
7785         {
7786             printf("[------]");
7787         }
7788         else
7789         {
7790             printf("[%06d]", dspTreeID(tree));
7791         }
7792     }
7793
7794 #endif // DEBUG
7795
7796 // clang-format off
7797 #define STRESS_MODES                                                                            \
7798                                                                                                 \
7799         STRESS_MODE(NONE)                                                                       \
7800                                                                                                 \
7801         /* "Variations" stress areas which we try to mix up with each other. */                 \
7802         /* These should not be exhaustively used as they might */                               \
7803         /* hide/trivialize other areas */                                                       \
7804                                                                                                 \
7805         STRESS_MODE(REGS) STRESS_MODE(DBL_ALN) STRESS_MODE(LCL_FLDS) STRESS_MODE(UNROLL_LOOPS)  \
7806         STRESS_MODE(MAKE_CSE) STRESS_MODE(LEGACY_INLINE) STRESS_MODE(CLONE_EXPR)                \
7807         STRESS_MODE(USE_FCOMI) STRESS_MODE(USE_CMOV) STRESS_MODE(FOLD)                          \
7808         STRESS_MODE(BB_PROFILE) STRESS_MODE(OPT_BOOLS_GC) STRESS_MODE(REMORPH_TREES)            \
7809         STRESS_MODE(64RSLT_MUL) STRESS_MODE(DO_WHILE_LOOPS) STRESS_MODE(MIN_OPTS)               \
7810         STRESS_MODE(REVERSE_FLAG)     /* Will set GTF_REVERSE_OPS whenever we can */            \
7811         STRESS_MODE(REVERSE_COMMA)    /* Will reverse commas created  with gtNewCommaNode */    \
7812         STRESS_MODE(TAILCALL)         /* Will make the call as a tailcall whenever legal */     \
7813         STRESS_MODE(CATCH_ARG)        /* Will spill catch arg */                                \
7814         STRESS_MODE(UNSAFE_BUFFER_CHECKS)                                                       \
7815         STRESS_MODE(NULL_OBJECT_CHECK)                                                          \
7816         STRESS_MODE(PINVOKE_RESTORE_ESP)                                                        \
7817         STRESS_MODE(RANDOM_INLINE)                                                              \
7818                                                                                                 \
7819         STRESS_MODE(GENERIC_VARN) STRESS_MODE(COUNT_VARN)                                       \
7820                                                                                                 \
7821         /* "Check" stress areas that can be exhaustively used if we */                          \
7822         /*  dont care about performance at all */                                               \
7823                                                                                                 \
7824         STRESS_MODE(FORCE_INLINE) /* Treat every method as AggressiveInlining */                \
7825         STRESS_MODE(CHK_FLOW_UPDATE)                                                            \
7826         STRESS_MODE(EMITTER) STRESS_MODE(CHK_REIMPORT) STRESS_MODE(FLATFP)                      \
7827                                                                                                 \
7828         STRESS_MODE(GENERIC_CHECK) STRESS_MODE(COUNT)                                           \
7829
7830     enum                compStressArea
7831     {
7832 #define STRESS_MODE(mode) STRESS_##mode,
7833         STRESS_MODES
7834 #undef STRESS_MODE
7835     };
7836 // clang-format on
7837
7838 #ifdef DEBUG
7839     static const LPCWSTR s_compStressModeNames[STRESS_COUNT + 1];
7840     BYTE                 compActiveStressModes[STRESS_COUNT];
7841 #endif // DEBUG
7842
7843 #define MAX_STRESS_WEIGHT 100
7844
7845     bool compStressCompile(compStressArea stressArea, unsigned weightPercentage);
7846
7847 #ifdef DEBUG
7848
7849     bool compInlineStress()
7850     {
7851         return compStressCompile(STRESS_LEGACY_INLINE, 50);
7852     }
7853
7854     bool compRandomInlineStress()
7855     {
7856         return compStressCompile(STRESS_RANDOM_INLINE, 50);
7857     }
7858
7859 #endif // DEBUG
7860
7861     bool compTailCallStress()
7862     {
7863 #ifdef DEBUG
7864         return (JitConfig.TailcallStress() != 0 || compStressCompile(STRESS_TAILCALL, 5));
7865 #else
7866         return false;
7867 #endif
7868     }
7869
7870     codeOptimize compCodeOpt()
7871     {
7872 #if 0
7873         // Switching between size & speed has measurable throughput impact
7874         // (3.5% on NGen mscorlib when measured). It used to be enabled for
7875         // DEBUG, but should generate identical code between CHK & RET builds,
7876         // so that's not acceptable.
7877         // TODO-Throughput: Figure out what to do about size vs. speed & throughput.
7878         //                  Investigate the cause of the throughput regression.
7879
7880         return opts.compCodeOpt;
7881 #else
7882         return BLENDED_CODE;
7883 #endif
7884     }
7885
7886     //--------------------- Info about the procedure --------------------------
7887
7888     struct Info
7889     {
7890         COMP_HANDLE           compCompHnd;
7891         CORINFO_MODULE_HANDLE compScopeHnd;
7892         CORINFO_CLASS_HANDLE  compClassHnd;
7893         CORINFO_METHOD_HANDLE compMethodHnd;
7894         CORINFO_METHOD_INFO*  compMethodInfo;
7895
7896         BOOL hasCircularClassConstraints;
7897         BOOL hasCircularMethodConstraints;
7898
7899 #if defined(DEBUG) || defined(LATE_DISASM)
7900         const char* compMethodName;
7901         const char* compClassName;
7902         const char* compFullName;
7903 #endif // defined(DEBUG) || defined(LATE_DISASM)
7904
7905 #if defined(DEBUG) || defined(INLINE_DATA)
7906         // Method hash is logcally const, but computed
7907         // on first demand.
7908         mutable unsigned compMethodHashPrivate;
7909         unsigned         compMethodHash() const;
7910 #endif // defined(DEBUG) || defined(INLINE_DATA)
7911
7912 #ifdef PSEUDORANDOM_NOP_INSERTION
7913         // things for pseudorandom nop insertion
7914         unsigned  compChecksum;
7915         CLRRandom compRNG;
7916 #endif
7917
7918         // The following holds the FLG_xxxx flags for the method we're compiling.
7919         unsigned compFlags;
7920
7921         // The following holds the class attributes for the method we're compiling.
7922         unsigned compClassAttr;
7923
7924         const BYTE*    compCode;
7925         IL_OFFSET      compILCodeSize;     // The IL code size
7926         UNATIVE_OFFSET compNativeCodeSize; // The native code size, after instructions are issued. This
7927                                            // is less than (compTotalHotCodeSize + compTotalColdCodeSize) only if:
7928         // (1) the code is not hot/cold split, and we issued less code than we expected, or
7929         // (2) the code is hot/cold split, and we issued less code than we expected
7930         // in the cold section (the hot section will always be padded out to compTotalHotCodeSize).
7931
7932         bool compIsStatic : 1;         // Is the method static (no 'this' pointer)?
7933         bool compIsVarArgs : 1;        // Does the method have varargs parameters?
7934         bool compIsContextful : 1;     // contextful method
7935         bool compInitMem : 1;          // Is the CORINFO_OPT_INIT_LOCALS bit set in the method info options?
7936         bool compUnwrapContextful : 1; // JIT should unwrap proxies when possible
7937         bool compProfilerCallback : 1; // JIT inserted a profiler Enter callback
7938         bool compPublishStubParam : 1; // EAX captured in prolog will be available through an instrinsic
7939         bool compRetBuffDefStack : 1;  // The ret buff argument definitely points into the stack.
7940
7941         var_types compRetType;       // Return type of the method as declared in IL
7942         var_types compRetNativeType; // Normalized return type as per target arch ABI
7943         unsigned  compILargsCount;   // Number of arguments (incl. implicit but not hidden)
7944         unsigned  compArgsCount;     // Number of arguments (incl. implicit and     hidden)
7945         unsigned  compRetBuffArg;    // position of hidden return param var (0, 1) (BAD_VAR_NUM means not present);
7946         int compTypeCtxtArg; // position of hidden param for type context for generic code (CORINFO_CALLCONV_PARAMTYPE)
7947         unsigned       compThisArg; // position of implicit this pointer param (not to be confused with lvaArg0Var)
7948         unsigned       compILlocalsCount; // Number of vars : args + locals (incl. implicit but not hidden)
7949         unsigned       compLocalsCount;   // Number of vars : args + locals (incl. implicit and     hidden)
7950         unsigned       compMaxStack;
7951         UNATIVE_OFFSET compTotalHotCodeSize;  // Total number of bytes of Hot Code in the method
7952         UNATIVE_OFFSET compTotalColdCodeSize; // Total number of bytes of Cold Code in the method
7953
7954         unsigned compCallUnmanaged;   // count of unmanaged calls
7955         unsigned compLvFrameListRoot; // lclNum for the Frame root
7956         unsigned compXcptnsCount;     // Number of exception-handling clauses read in the method's IL.
7957                                       // You should generally use compHndBBtabCount instead: it is the
7958                                       // current number of EH clauses (after additions like synchronized
7959                                       // methods and funclets, and removals like unreachable code deletion).
7960
7961         bool compMatchedVM; // true if the VM is "matched": either the JIT is a cross-compiler
7962                             // and the VM expects that, or the JIT is a "self-host" compiler
7963                             // (e.g., x86 hosted targeting x86) and the VM expects that.
7964
7965         /*  The following holds IL scope information about local variables.
7966          */
7967
7968         unsigned     compVarScopesCount;
7969         VarScopeDsc* compVarScopes;
7970
7971         /* The following holds information about instr offsets for
7972          * which we need to report IP-mappings
7973          */
7974
7975         IL_OFFSET*                   compStmtOffsets; // sorted
7976         unsigned                     compStmtOffsetsCount;
7977         ICorDebugInfo::BoundaryTypes compStmtOffsetsImplicit;
7978
7979 #define CPU_X86 0x0100 // The generic X86 CPU
7980 #define CPU_X86_PENTIUM_4 0x0110
7981
7982 #define CPU_X64 0x0200       // The generic x64 CPU
7983 #define CPU_AMD_X64 0x0210   // AMD x64 CPU
7984 #define CPU_INTEL_X64 0x0240 // Intel x64 CPU
7985
7986 #define CPU_ARM 0x0300 // The generic ARM CPU
7987
7988         unsigned genCPU; // What CPU are we running on
7989     } info;
7990
7991     // Returns true if the method being compiled returns a non-void and non-struct value.
7992     // Note that lvaInitTypeRef() normalizes compRetNativeType for struct returns in a
7993     // single register as per target arch ABI (e.g on Amd64 Windows structs of size 1, 2,
7994     // 4 or 8 gets normalized to TYP_BYTE/TYP_SHORT/TYP_INT/TYP_LONG; On Arm HFA structs).
7995     // Methods returning such structs are considered to return non-struct return value and
7996     // this method returns true in that case.
7997     bool compMethodReturnsNativeScalarType()
7998     {
7999         return (info.compRetType != TYP_VOID) && !varTypeIsStruct(info.compRetNativeType);
8000     }
8001
8002     // Returns true if the method being compiled returns RetBuf addr as its return value
8003     bool compMethodReturnsRetBufAddr()
8004     {
8005         // There are cases where implicit RetBuf argument should be explicitly returned in a register.
8006         // In such cases the return type is changed to TYP_BYREF and appropriate IR is generated.
8007         // These cases are:
8008         // 1. Profiler Leave calllback expects the address of retbuf as return value for
8009         //    methods with hidden RetBuf argument.  impReturnInstruction() when profiler
8010         //    callbacks are needed creates GT_RETURN(TYP_BYREF, op1 = Addr of RetBuf) for
8011         //    methods with hidden RetBufArg.
8012         //
8013         // 2. As per the System V ABI, the address of RetBuf needs to be returned by
8014         //    methods with hidden RetBufArg in RAX. In such case GT_RETURN is of TYP_BYREF,
8015         //    returning the address of RetBuf.
8016         //
8017         // 3. Windows 64-bit native calling convention also requires the address of RetBuff
8018         //    to be returned in RAX.
8019         CLANG_FORMAT_COMMENT_ANCHOR;
8020
8021 #ifdef _TARGET_AMD64_
8022         return (info.compRetBuffArg != BAD_VAR_NUM);
8023 #else  // !_TARGET_AMD64_
8024         return (compIsProfilerHookNeeded()) && (info.compRetBuffArg != BAD_VAR_NUM);
8025 #endif // !_TARGET_AMD64_
8026     }
8027
8028     // Returns true if the method returns a value in more than one return register
8029     // TODO-ARM-Bug: Deal with multi-register genReturnLocaled structs?
8030     // TODO-ARM64: Does this apply for ARM64 too?
8031     bool compMethodReturnsMultiRegRetType()
8032     {
8033 #if FEATURE_MULTIREG_RET
8034 #if defined(_TARGET_X86_)
8035         // On x86 only 64-bit longs are returned in multiple registers
8036         return varTypeIsLong(info.compRetNativeType);
8037 #else  // targets: X64-UNIX, ARM64 or ARM32
8038         // On all other targets that support multireg return values:
8039         // Methods returning a struct in multiple registers have a return value of TYP_STRUCT.
8040         // Such method's compRetNativeType is TYP_STRUCT without a hidden RetBufArg
8041         return varTypeIsStruct(info.compRetNativeType) && (info.compRetBuffArg == BAD_VAR_NUM);
8042 #endif // TARGET_XXX
8043
8044 #else // not FEATURE_MULTIREG_RET
8045
8046         // For this architecture there are no multireg returns
8047         return false;
8048
8049 #endif // FEATURE_MULTIREG_RET
8050     }
8051
8052 #if FEATURE_MULTIREG_ARGS
8053     // Given a GenTree node of TYP_STRUCT that represents a pass by value argument
8054     // return the gcPtr layout for the pointers sized fields
8055     void getStructGcPtrsFromOp(GenTreePtr op, BYTE* gcPtrsOut);
8056 #endif // FEATURE_MULTIREG_ARGS
8057
8058     // Returns true if the method being compiled returns a value
8059     bool compMethodHasRetVal()
8060     {
8061         return compMethodReturnsNativeScalarType() || compMethodReturnsRetBufAddr() ||
8062                compMethodReturnsMultiRegRetType();
8063     }
8064
8065 #if defined(DEBUG)
8066
8067     void compDispLocalVars();
8068
8069 #endif // DEBUG
8070
8071 //-------------------------- Global Compiler Data ------------------------------------
8072
8073 #ifdef DEBUG
8074     static unsigned s_compMethodsCount; // to produce unique label names
8075     unsigned        compGenTreeID;
8076 #endif
8077
8078     BasicBlock* compCurBB;   // the current basic block in process
8079     GenTreePtr  compCurStmt; // the current statement in process
8080 #ifdef DEBUG
8081     unsigned compCurStmtNum; // to give all statements an increasing StmtNum when printing dumps
8082 #endif
8083
8084     //  The following is used to create the 'method JIT info' block.
8085     size_t compInfoBlkSize;
8086     BYTE*  compInfoBlkAddr;
8087
8088     EHblkDsc* compHndBBtab;           // array of EH data
8089     unsigned  compHndBBtabCount;      // element count of used elements in EH data array
8090     unsigned  compHndBBtabAllocCount; // element count of allocated elements in EH data array
8091
8092 #if defined(_TARGET_X86_)
8093
8094     //-------------------------------------------------------------------------
8095     //  Tracking of region covered by the monitor in synchronized methods
8096     void* syncStartEmitCookie; // the emitter cookie for first instruction after the call to MON_ENTER
8097     void* syncEndEmitCookie;   // the emitter cookie for first instruction after the call to MON_EXIT
8098
8099 #endif // !_TARGET_X86_
8100
8101     Phases previousCompletedPhase; // the most recently completed phase
8102
8103     //-------------------------------------------------------------------------
8104     //  The following keeps track of how many bytes of local frame space we've
8105     //  grabbed so far in the current function, and how many argument bytes we
8106     //  need to pop when we return.
8107     //
8108
8109     unsigned compLclFrameSize; // secObject+lclBlk+locals+temps
8110
8111     // Count of callee-saved regs we pushed in the prolog.
8112     // Does not include EBP for isFramePointerUsed() and double-aligned frames.
8113     // In case of Amd64 this doesn't include float regs saved on stack.
8114     unsigned compCalleeRegsPushed;
8115
8116 #if defined(_TARGET_XARCH_) && !FEATURE_STACK_FP_X87
8117     // Mask of callee saved float regs on stack.
8118     regMaskTP compCalleeFPRegsSavedMask;
8119 #endif
8120 #ifdef _TARGET_AMD64_
8121 // Quirk for VS debug-launch scenario to work:
8122 // Bytes of padding between save-reg area and locals.
8123 #define VSQUIRK_STACK_PAD (2 * REGSIZE_BYTES)
8124     unsigned compVSQuirkStackPaddingNeeded;
8125     bool     compQuirkForPPPflag;
8126 #endif
8127
8128     unsigned compArgSize; // total size of arguments in bytes (including register args (lvIsRegArg))
8129
8130     unsigned compMapILargNum(unsigned ILargNum); // map accounting for hidden args
8131     unsigned compMapILvarNum(unsigned ILvarNum); // map accounting for hidden args
8132     unsigned compMap2ILvarNum(unsigned varNum);  // map accounting for hidden args
8133
8134     //-------------------------------------------------------------------------
8135
8136     static void compStartup();  // One-time initialization
8137     static void compShutdown(); // One-time finalization
8138
8139     void compInit(ArenaAllocator* pAlloc, InlineInfo* inlineInfo);
8140     void compDone();
8141
8142     static void compDisplayStaticSizes(FILE* fout);
8143
8144     //------------ Some utility functions --------------
8145
8146     void* compGetHelperFtn(CorInfoHelpFunc ftnNum,         /* IN  */
8147                            void**          ppIndirection); /* OUT */
8148
8149     // Several JIT/EE interface functions return a CorInfoType, and also return a
8150     // class handle as an out parameter if the type is a value class.  Returns the
8151     // size of the type these describe.
8152     unsigned compGetTypeSize(CorInfoType cit, CORINFO_CLASS_HANDLE clsHnd);
8153
8154 #ifdef DEBUG
8155     // Components used by the compiler may write unit test suites, and
8156     // have them run within this method.  They will be run only once per process, and only
8157     // in debug.  (Perhaps should be under the control of a COMPlus_ flag.)
8158     // These should fail by asserting.
8159     void compDoComponentUnitTestsOnce();
8160 #endif // DEBUG
8161
8162     int compCompile(CORINFO_METHOD_HANDLE methodHnd,
8163                     CORINFO_MODULE_HANDLE classPtr,
8164                     COMP_HANDLE           compHnd,
8165                     CORINFO_METHOD_INFO*  methodInfo,
8166                     void**                methodCodePtr,
8167                     ULONG*                methodCodeSize,
8168                     JitFlags*             compileFlags);
8169     void compCompileFinish();
8170     int compCompileHelper(CORINFO_MODULE_HANDLE            classPtr,
8171                           COMP_HANDLE                      compHnd,
8172                           CORINFO_METHOD_INFO*             methodInfo,
8173                           void**                           methodCodePtr,
8174                           ULONG*                           methodCodeSize,
8175                           JitFlags*                        compileFlags,
8176                           CorInfoInstantiationVerification instVerInfo);
8177
8178     ArenaAllocator* compGetAllocator();
8179
8180 #if MEASURE_MEM_ALLOC
8181
8182     static bool s_dspMemStats; // Display per-phase memory statistics for every function
8183
8184     struct MemStats
8185     {
8186         unsigned allocCnt;                 // # of allocs
8187         UINT64   allocSz;                  // total size of those alloc.
8188         UINT64   allocSzMax;               // Maximum single allocation.
8189         UINT64   allocSzByKind[CMK_Count]; // Classified by "kind".
8190         UINT64   nraTotalSizeAlloc;
8191         UINT64   nraTotalSizeUsed;
8192
8193         static const char* s_CompMemKindNames[]; // Names of the kinds.
8194
8195         MemStats() : allocCnt(0), allocSz(0), allocSzMax(0), nraTotalSizeAlloc(0), nraTotalSizeUsed(0)
8196         {
8197             for (int i = 0; i < CMK_Count; i++)
8198             {
8199                 allocSzByKind[i] = 0;
8200             }
8201         }
8202         MemStats(const MemStats& ms)
8203             : allocCnt(ms.allocCnt)
8204             , allocSz(ms.allocSz)
8205             , allocSzMax(ms.allocSzMax)
8206             , nraTotalSizeAlloc(ms.nraTotalSizeAlloc)
8207             , nraTotalSizeUsed(ms.nraTotalSizeUsed)
8208         {
8209             for (int i = 0; i < CMK_Count; i++)
8210             {
8211                 allocSzByKind[i] = ms.allocSzByKind[i];
8212             }
8213         }
8214
8215         // Until we have ubiquitous constructors.
8216         void Init()
8217         {
8218             this->MemStats::MemStats();
8219         }
8220
8221         void AddAlloc(size_t sz, CompMemKind cmk)
8222         {
8223             allocCnt += 1;
8224             allocSz += sz;
8225             if (sz > allocSzMax)
8226             {
8227                 allocSzMax = sz;
8228             }
8229             allocSzByKind[cmk] += sz;
8230         }
8231
8232         void Print(FILE* f);       // Print these stats to f.
8233         void PrintByKind(FILE* f); // Do just the by-kind histogram part.
8234     };
8235     MemStats genMemStats;
8236
8237     struct AggregateMemStats : public MemStats
8238     {
8239         unsigned nMethods;
8240
8241         AggregateMemStats() : MemStats(), nMethods(0)
8242         {
8243         }
8244
8245         void Add(const MemStats& ms)
8246         {
8247             nMethods++;
8248             allocCnt += ms.allocCnt;
8249             allocSz += ms.allocSz;
8250             allocSzMax = max(allocSzMax, ms.allocSzMax);
8251             for (int i = 0; i < CMK_Count; i++)
8252             {
8253                 allocSzByKind[i] += ms.allocSzByKind[i];
8254             }
8255             nraTotalSizeAlloc += ms.nraTotalSizeAlloc;
8256             nraTotalSizeUsed += ms.nraTotalSizeUsed;
8257         }
8258
8259         void Print(FILE* f); // Print these stats to jitstdout.
8260     };
8261
8262     static CritSecObject     s_memStatsLock;    // This lock protects the data structures below.
8263     static MemStats          s_maxCompMemStats; // Stats for the compilation with the largest amount allocated.
8264     static AggregateMemStats s_aggMemStats;     // Aggregates statistics for all compilations.
8265
8266 #endif // MEASURE_MEM_ALLOC
8267
8268 #if LOOP_HOIST_STATS
8269     unsigned m_loopsConsidered;
8270     bool     m_curLoopHasHoistedExpression;
8271     unsigned m_loopsWithHoistedExpressions;
8272     unsigned m_totalHoistedExpressions;
8273
8274     void AddLoopHoistStats();
8275     void PrintPerMethodLoopHoistStats();
8276
8277     static CritSecObject s_loopHoistStatsLock; // This lock protects the data structures below.
8278     static unsigned      s_loopsConsidered;
8279     static unsigned      s_loopsWithHoistedExpressions;
8280     static unsigned      s_totalHoistedExpressions;
8281
8282     static void PrintAggregateLoopHoistStats(FILE* f);
8283 #endif // LOOP_HOIST_STATS
8284
8285     void* compGetMemArray(size_t numElem, size_t elemSize, CompMemKind cmk = CMK_Unknown);
8286     void* compGetMemArrayA(size_t numElem, size_t elemSize, CompMemKind cmk = CMK_Unknown);
8287     void* compGetMem(size_t sz, CompMemKind cmk = CMK_Unknown);
8288     void* compGetMemA(size_t sz, CompMemKind cmk = CMK_Unknown);
8289     static void* compGetMemCallback(void*, size_t, CompMemKind cmk = CMK_Unknown);
8290     void compFreeMem(void*);
8291
8292     bool compIsForImportOnly();
8293     bool compIsForInlining();
8294     bool compDonotInline();
8295
8296 #ifdef DEBUG
8297     const char* compLocalVarName(unsigned varNum, unsigned offs);
8298     VarName compVarName(regNumber reg, bool isFloatReg = false);
8299     const char* compRegVarName(regNumber reg, bool displayVar = false, bool isFloatReg = false);
8300     const char* compRegPairName(regPairNo regPair);
8301     const char* compRegNameForSize(regNumber reg, size_t size);
8302     const char* compFPregVarName(unsigned fpReg, bool displayVar = false);
8303     void compDspSrcLinesByNativeIP(UNATIVE_OFFSET curIP);
8304     void compDspSrcLinesByLineNum(unsigned line, bool seek = false);
8305 #endif // DEBUG
8306
8307     //-------------------------------------------------------------------------
8308
8309     typedef ListNode<VarScopeDsc*> VarScopeListNode;
8310
8311     struct VarScopeMapInfo
8312     {
8313         VarScopeListNode*       head;
8314         VarScopeListNode*       tail;
8315         static VarScopeMapInfo* Create(VarScopeListNode* node, IAllocator* alloc)
8316         {
8317             VarScopeMapInfo* info = new (alloc) VarScopeMapInfo;
8318             info->head            = node;
8319             info->tail            = node;
8320             return info;
8321         }
8322     };
8323
8324     // Max value of scope count for which we would use linear search; for larger values we would use hashtable lookup.
8325     static const unsigned MAX_LINEAR_FIND_LCL_SCOPELIST = 32;
8326
8327     typedef SimplerHashTable<unsigned, SmallPrimitiveKeyFuncs<unsigned>, VarScopeMapInfo*, JitSimplerHashBehavior>
8328         VarNumToScopeDscMap;
8329
8330     // Map to keep variables' scope indexed by varNum containing it's scope dscs at the index.
8331     VarNumToScopeDscMap* compVarScopeMap;
8332
8333     VarScopeDsc* compFindLocalVar(unsigned varNum, unsigned lifeBeg, unsigned lifeEnd);
8334
8335     VarScopeDsc* compFindLocalVar(unsigned varNum, unsigned offs);
8336
8337     VarScopeDsc* compFindLocalVarLinear(unsigned varNum, unsigned offs);
8338
8339     void compInitVarScopeMap();
8340
8341     VarScopeDsc** compEnterScopeList; // List has the offsets where variables
8342                                       // enter scope, sorted by instr offset
8343     unsigned compNextEnterScope;
8344
8345     VarScopeDsc** compExitScopeList; // List has the offsets where variables
8346                                      // go out of scope, sorted by instr offset
8347     unsigned compNextExitScope;
8348
8349     void compInitScopeLists();
8350
8351     void compResetScopeLists();
8352
8353     VarScopeDsc* compGetNextEnterScope(unsigned offs, bool scan = false);
8354
8355     VarScopeDsc* compGetNextExitScope(unsigned offs, bool scan = false);
8356
8357     void compProcessScopesUntil(unsigned   offset,
8358                                 VARSET_TP* inScope,
8359                                 void (Compiler::*enterScopeFn)(VARSET_TP* inScope, VarScopeDsc*),
8360                                 void (Compiler::*exitScopeFn)(VARSET_TP* inScope, VarScopeDsc*));
8361
8362 #ifdef DEBUG
8363     void compDispScopeLists();
8364 #endif // DEBUG
8365
8366     bool compIsProfilerHookNeeded();
8367
8368     //-------------------------------------------------------------------------
8369     /*               Statistical Data Gathering                               */
8370
8371     void compJitStats(); // call this function and enable
8372                          // various ifdef's below for statistical data
8373
8374 #if CALL_ARG_STATS
8375     void        compCallArgStats();
8376     static void compDispCallArgStats(FILE* fout);
8377 #endif
8378
8379     //-------------------------------------------------------------------------
8380
8381 protected:
8382 #ifdef DEBUG
8383     bool skipMethod();
8384 #endif
8385
8386     ArenaAllocator* compAllocator;
8387
8388 public:
8389     // This one presents an implementation of the "IAllocator" abstract class that uses "compAllocator",
8390     // suitable for use by utilcode collection types.
8391     IAllocator* compAsIAllocator;
8392
8393 #if MEASURE_MEM_ALLOC
8394     IAllocator* compAsIAllocatorBitset;    // An allocator that uses the CMK_bitset tracker.
8395     IAllocator* compAsIAllocatorGC;        // An allocator that uses the CMK_GC tracker.
8396     IAllocator* compAsIAllocatorLoopHoist; // An allocator that uses the CMK_LoopHoist tracker.
8397 #ifdef DEBUG
8398     IAllocator* compAsIAllocatorDebugOnly; // An allocator that uses the CMK_DebugOnly tracker.
8399 #endif                                     // DEBUG
8400 #endif                                     // MEASURE_MEM_ALLOC
8401
8402     void compFunctionTraceStart();
8403     void compFunctionTraceEnd(void* methodCodePtr, ULONG methodCodeSize, bool isNYI);
8404
8405 protected:
8406     size_t compMaxUncheckedOffsetForNullObject;
8407
8408     void compInitOptions(JitFlags* compileFlags);
8409
8410     void compSetProcessor();
8411     void compInitDebuggingInfo();
8412     void compSetOptimizationLevel();
8413 #ifdef _TARGET_ARMARCH_
8414     bool compRsvdRegCheck(FrameLayoutState curState);
8415 #endif
8416     void compCompile(void** methodCodePtr, ULONG* methodCodeSize, JitFlags* compileFlags);
8417
8418     // Clear annotations produced during optimizations; to be used between iterations when repeating opts.
8419     void ResetOptAnnotations();
8420
8421     // Regenerate loop descriptors; to be used between iterations when repeating opts.
8422     void RecomputeLoopInfo();
8423
8424 #ifdef PROFILING_SUPPORTED
8425     // Data required for generating profiler Enter/Leave/TailCall hooks
8426
8427     bool  compProfilerHookNeeded; // Whether profiler Enter/Leave/TailCall hook needs to be generated for the method
8428     void* compProfilerMethHnd;    // Profiler handle of the method being compiled. Passed as param to ELT callbacks
8429     bool  compProfilerMethHndIndirected; // Whether compProfilerHandle is pointer to the handle or is an actual handle
8430 #endif
8431
8432 #ifdef _TARGET_AMD64_
8433     bool compQuirkForPPP(); // Check if this method should be Quirked for the PPP issue
8434 #endif
8435 public:
8436     // Assumes called as part of process shutdown; does any compiler-specific work associated with that.
8437     static void ProcessShutdownWork(ICorStaticInfo* statInfo);
8438
8439     IAllocator* getAllocator()
8440     {
8441         return compAsIAllocator;
8442     }
8443
8444 #if MEASURE_MEM_ALLOC
8445     IAllocator* getAllocatorBitset()
8446     {
8447         return compAsIAllocatorBitset;
8448     }
8449     IAllocator* getAllocatorGC()
8450     {
8451         return compAsIAllocatorGC;
8452     }
8453     IAllocator* getAllocatorLoopHoist()
8454     {
8455         return compAsIAllocatorLoopHoist;
8456     }
8457 #else  // !MEASURE_MEM_ALLOC
8458     IAllocator* getAllocatorBitset()
8459     {
8460         return compAsIAllocator;
8461     }
8462     IAllocator* getAllocatorGC()
8463     {
8464         return compAsIAllocator;
8465     }
8466     IAllocator* getAllocatorLoopHoist()
8467     {
8468         return compAsIAllocator;
8469     }
8470 #endif // !MEASURE_MEM_ALLOC
8471
8472 #ifdef DEBUG
8473     IAllocator* getAllocatorDebugOnly()
8474     {
8475 #if MEASURE_MEM_ALLOC
8476         return compAsIAllocatorDebugOnly;
8477 #else  // !MEASURE_MEM_ALLOC
8478         return compAsIAllocator;
8479 #endif // !MEASURE_MEM_ALLOC
8480     }
8481 #endif // DEBUG
8482
8483     /*
8484     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8485     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8486     XX                                                                           XX
8487     XX                           typeInfo                                        XX
8488     XX                                                                           XX
8489     XX   Checks for type compatibility and merges types                          XX
8490     XX                                                                           XX
8491     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8492     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8493     */
8494
8495 public:
8496     // Set to TRUE if verification cannot be skipped for this method
8497     // If we detect unverifiable code, we will lazily check
8498     // canSkipMethodVerification() to see if verification is REALLY needed.
8499     BOOL tiVerificationNeeded;
8500
8501     // It it initially TRUE, and it gets set to FALSE if we run into unverifiable code
8502     // Note that this is valid only if tiVerificationNeeded was ever TRUE.
8503     BOOL tiIsVerifiableCode;
8504
8505     // Set to TRUE if runtime callout is needed for this method
8506     BOOL tiRuntimeCalloutNeeded;
8507
8508     // Set to TRUE if security prolog/epilog callout is needed for this method
8509     // Note: This flag is different than compNeedSecurityCheck.
8510     //     compNeedSecurityCheck means whether or not a security object needs
8511     //         to be allocated on the stack, which is currently true for EnC as well.
8512     //     tiSecurityCalloutNeeded means whether or not security callouts need
8513     //         to be inserted in the jitted code.
8514     BOOL tiSecurityCalloutNeeded;
8515
8516     // Returns TRUE if child is equal to or a subtype of parent for merge purposes
8517     // This support is necessary to suport attributes that are not described in
8518     // for example, signatures. For example, the permanent home byref (byref that
8519     // points to the gc heap), isn't a property of method signatures, therefore,
8520     // it is safe to have mismatches here (that tiCompatibleWith will not flag),
8521     // but when deciding if we need to reimport a block, we need to take these
8522     // in account
8523     BOOL tiMergeCompatibleWith(const typeInfo& pChild, const typeInfo& pParent, bool normalisedForStack) const;
8524
8525     // Returns TRUE if child is equal to or a subtype of parent.
8526     // normalisedForStack indicates that both types are normalised for the stack
8527     BOOL tiCompatibleWith(const typeInfo& pChild, const typeInfo& pParent, bool normalisedForStack) const;
8528
8529     // Merges pDest and pSrc. Returns FALSE if merge is undefined.
8530     // *pDest is modified to represent the merged type.  Sets "*changed" to true
8531     // if this changes "*pDest".
8532     BOOL tiMergeToCommonParent(typeInfo* pDest, const typeInfo* pSrc, bool* changed) const;
8533
8534     // Set pDest from the primitive value type.
8535     // Eg. System.Int32 -> ELEMENT_TYPE_I4
8536
8537     BOOL tiFromPrimitiveValueClass(typeInfo* pDest, const typeInfo* pVC) const;
8538
8539 #ifdef DEBUG
8540     // <BUGNUM> VSW 471305
8541     // IJW allows assigning REF to BYREF. The following allows us to temporarily
8542     // bypass the assert check in gcMarkRegSetGCref and gcMarkRegSetByref
8543     // We use a "short" as we need to push/pop this scope.
8544     // </BUGNUM>
8545     short compRegSetCheckLevel;
8546 #endif
8547
8548     /*
8549     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8550     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8551     XX                                                                           XX
8552     XX                           IL verification stuff                           XX
8553     XX                                                                           XX
8554     XX                                                                           XX
8555     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8556     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8557     */
8558
8559 public:
8560     // The following is used to track liveness of local variables, initialization
8561     // of valueclass constructors, and type safe use of IL instructions.
8562
8563     // dynamic state info needed for verification
8564     EntryState verCurrentState;
8565
8566     // this ptr of object type .ctors are considered intited only after
8567     // the base class ctor is called, or an alternate ctor is called.
8568     // An uninited this ptr can be used to access fields, but cannot
8569     // be used to call a member function.
8570     BOOL verTrackObjCtorInitState;
8571
8572     void verInitBBEntryState(BasicBlock* block, EntryState* currentState);
8573
8574     // Requires that "tis" is not TIS_Bottom -- it's a definite init/uninit state.
8575     void verSetThisInit(BasicBlock* block, ThisInitState tis);
8576     void verInitCurrentState();
8577     void verResetCurrentState(BasicBlock* block, EntryState* currentState);
8578
8579     // Merges the current verification state into the entry state of "block", return FALSE if that merge fails,
8580     // TRUE if it succeeds.  Further sets "*changed" to true if this changes the entry state of "block".
8581     BOOL verMergeEntryStates(BasicBlock* block, bool* changed);
8582
8583     void verConvertBBToThrowVerificationException(BasicBlock* block DEBUGARG(bool logMsg));
8584     void verHandleVerificationFailure(BasicBlock* block DEBUGARG(bool logMsg));
8585     typeInfo verMakeTypeInfo(CORINFO_CLASS_HANDLE clsHnd,
8586                              bool bashStructToRef = false); // converts from jit type representation to typeInfo
8587     typeInfo verMakeTypeInfo(CorInfoType          ciType,
8588                              CORINFO_CLASS_HANDLE clsHnd); // converts from jit type representation to typeInfo
8589     BOOL verIsSDArray(typeInfo ti);
8590     typeInfo verGetArrayElemType(typeInfo ti);
8591
8592     typeInfo verParseArgSigToTypeInfo(CORINFO_SIG_INFO* sig, CORINFO_ARG_LIST_HANDLE args);
8593     BOOL verNeedsVerification();
8594     BOOL verIsByRefLike(const typeInfo& ti);
8595     BOOL verIsSafeToReturnByRef(const typeInfo& ti);
8596
8597     // generic type variables range over types that satisfy IsBoxable
8598     BOOL verIsBoxable(const typeInfo& ti);
8599
8600     void DECLSPEC_NORETURN verRaiseVerifyException(INDEBUG(const char* reason) DEBUGARG(const char* file)
8601                                                        DEBUGARG(unsigned line));
8602     void verRaiseVerifyExceptionIfNeeded(INDEBUG(const char* reason) DEBUGARG(const char* file)
8603                                              DEBUGARG(unsigned line));
8604     bool verCheckTailCallConstraint(OPCODE                  opcode,
8605                                     CORINFO_RESOLVED_TOKEN* pResolvedToken,
8606                                     CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken, // Is this a "constrained." call
8607                                                                                        // on a type parameter?
8608                                     bool speculative // If true, won't throw if verificatoin fails. Instead it will
8609                                                      // return false to the caller.
8610                                                      // If false, it will throw.
8611                                     );
8612     bool verIsBoxedValueType(typeInfo ti);
8613
8614     void verVerifyCall(OPCODE                  opcode,
8615                        CORINFO_RESOLVED_TOKEN* pResolvedToken,
8616                        CORINFO_RESOLVED_TOKEN* pConstrainedResolvedToken,
8617                        bool                    tailCall,
8618                        bool                    readonlyCall, // is this a "readonly." call?
8619                        const BYTE*             delegateCreateStart,
8620                        const BYTE*             codeAddr,
8621                        CORINFO_CALL_INFO* callInfo DEBUGARG(const char* methodName));
8622
8623     BOOL verCheckDelegateCreation(const BYTE* delegateCreateStart, const BYTE* codeAddr, mdMemberRef& targetMemberRef);
8624
8625     typeInfo verVerifySTIND(const typeInfo& ptr, const typeInfo& value, const typeInfo& instrType);
8626     typeInfo verVerifyLDIND(const typeInfo& ptr, const typeInfo& instrType);
8627     void verVerifyField(CORINFO_RESOLVED_TOKEN*   pResolvedToken,
8628                         const CORINFO_FIELD_INFO& fieldInfo,
8629                         const typeInfo*           tiThis,
8630                         BOOL                      mutator,
8631                         BOOL                      allowPlainStructAsThis = FALSE);
8632     void verVerifyCond(const typeInfo& tiOp1, const typeInfo& tiOp2, unsigned opcode);
8633     void verVerifyThisPtrInitialised();
8634     BOOL verIsCallToInitThisPtr(CORINFO_CLASS_HANDLE context, CORINFO_CLASS_HANDLE target);
8635
8636     // Register allocator
8637     void raInitStackFP();
8638     void raEnregisterVarsPrePassStackFP();
8639     void raSetRegLclBirthDeath(GenTreePtr tree, VARSET_VALARG_TP lastlife, bool fromLDOBJ);
8640     void raEnregisterVarsPostPassStackFP();
8641     void raGenerateFPRefCounts();
8642     void raEnregisterVarsStackFP();
8643     void raUpdateHeightsForVarsStackFP(VARSET_VALARG_TP mask);
8644
8645     regNumber raRegForVarStackFP(unsigned varTrackedIndex);
8646     void raAddPayloadStackFP(VARSET_VALARG_TP mask, unsigned weight);
8647
8648     // returns true if enregistering v1 would save more mem accesses than v2
8649     bool raVarIsGreaterValueStackFP(LclVarDsc* lv1, LclVarDsc* lv2);
8650
8651 #ifdef DEBUG
8652     void raDumpHeightsStackFP();
8653     void raDumpVariableRegIntfFloat();
8654 #endif
8655
8656 #if FEATURE_STACK_FP_X87
8657
8658     // Currently, we use FP transition blocks in only 2 situations:
8659     //
8660     //      -conditional jump on longs where FP stack differs with target: it's not strictly
8661     //       necessary, but its low frequency and the code would get complicated if we try to
8662     //       inline the FP stack adjustment, as we have a lot of special casing going on to try
8663     //       minimize the way we generate the jump code.
8664     //      -case statements of switch where the FP stack differs with the one of evaluating the switch () statement
8665     //       We do this as we want to codegen switch as a jumptable. Again, this is low frequency.
8666     //
8667     //      However, transition blocks have 2 problems
8668     //
8669     //          - Procedure splitting: current implementation of procedure splitting requires all basic blocks to
8670     //            be known at codegen time, as it generates all hot blocks first and cold blocks later. This ties
8671     //            us up in codegen and is a solvable problem (we could make procedure splitting generate blocks
8672     //            in the right place without preordering them), this causes us to have to generate the transition
8673     //            blocks in the cold area if we want procedure splitting.
8674     //
8675     //
8676     //          - Thread abort exceptions and transition blocks. Transition blocks were designed under the assumption
8677     //            that no exceptions can happen inside them. Unfortunately Thread.Abort can happen in any instruction,
8678     //            and if we have handlers we will have to try to call them. Fixing this the right way would imply
8679     //            having multiple try native code regions for a single try il region. This is doable and shouldnt be
8680     //            a big change in the exception.
8681     //
8682     //      Given the low frequency of the cases where we have transition blocks, I've decided to dumb down
8683     //      optimizations. For these 2 cases:
8684     //
8685     //          - When there is a chance that we will have FP transition blocks, we won't do procedure splitting.
8686     //          - When a method has a handler, it won't enregister any FP variables that go thru a conditional long or
8687     //          a switch statement.
8688     //
8689     //      If at any point we find we need to optimize this, we should throw work at unblocking the restrictions our
8690     //      current procedure splitting and exception code have.
8691     bool compMayHaveTransitionBlocks;
8692
8693     VARSET_TP raMaskDontEnregFloat; // mask for additional restrictions
8694
8695     VARSET_TP raLclRegIntfFloat[REG_FPCOUNT];
8696
8697     unsigned raCntStkStackFP;
8698     unsigned raCntWtdStkDblStackFP;
8699     unsigned raCntStkParamDblStackFP;
8700
8701     // Payload in mem accesses for enregistering a variable (we dont want to mix with refcounts)
8702     // TODO: Do we want to put this in LclVarDsc?
8703     unsigned raPayloadStackFP[lclMAX_TRACKED];
8704     unsigned raHeightsStackFP[lclMAX_TRACKED][FP_VIRTUALREGISTERS + 1];
8705 #ifdef DEBUG
8706     // Useful for debugging
8707     unsigned raHeightsNonWeightedStackFP[lclMAX_TRACKED][FP_VIRTUALREGISTERS + 1];
8708 #endif
8709 #endif // FEATURE_STACK_FP_X87
8710
8711 #ifdef DEBUG
8712     // One line log function. Default level is 0. Increasing it gives you
8713     // more log information
8714
8715     // levels are currently unused: #define JITDUMP(level,...)                     ();
8716     void JitLogEE(unsigned level, const char* fmt, ...);
8717
8718     bool compDebugBreak;
8719
8720     bool compJitHaltMethod();
8721
8722 #endif
8723
8724     /*
8725     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8726     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8727     XX                                                                           XX
8728     XX                   GS Security checks for unsafe buffers                   XX
8729     XX                                                                           XX
8730     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8731     XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8732     */
8733 public:
8734     struct ShadowParamVarInfo
8735     {
8736         FixedBitVect* assignGroup; // the closure set of variables whose values depend on each other
8737         unsigned      shadowCopy;  // Lcl var num, valid only if not set to NO_SHADOW_COPY
8738
8739         static bool mayNeedShadowCopy(LclVarDsc* varDsc)
8740         {
8741 #if defined(_TARGET_AMD64_) && !defined(LEGACY_BACKEND)
8742             // GS cookie logic to create shadow slots, create trees to copy reg args to shadow
8743             // slots and update all trees to refer to shadow slots is done immediately after
8744             // fgMorph().  Lsra could potentially mark a param as DoNotEnregister after JIT determines
8745             // not to shadow a parameter.  Also, LSRA could potentially spill a param which is passed
8746             // in register. Therefore, conservatively all params may need a shadow copy.  Note that
8747             // GS cookie logic further checks whether the param is a ptr or an unsafe buffer before
8748             // creating a shadow slot even though this routine returns true.
8749             //
8750             // TODO-AMD64-CQ: Revisit this conservative approach as it could create more shadow slots than
8751             // required. There are two cases under which a reg arg could potentially be used from its
8752             // home location:
8753             //   a) LSRA marks it as DoNotEnregister (see LinearScan::identifyCandidates())
8754             //   b) LSRA spills it
8755             //
8756             // Possible solution to address case (a)
8757             //   - The conditions under which LSRA marks a varDsc as DoNotEnregister could be checked
8758             //     in this routine.  Note that live out of exception handler is something we may not be
8759             //     able to do it here since GS cookie logic is invoked ahead of liveness computation.
8760             //     Therefore, for methods with exception handling and need GS cookie check we might have
8761             //     to take conservative approach.
8762             //
8763             // Possible solution to address case (b)
8764             //   - Whenver a parameter passed in an argument register needs to be spilled by LSRA, we
8765             //     create a new spill temp if the method needs GS cookie check.
8766             return varDsc->lvIsParam;
8767 #else // !(defined(_TARGET_AMD64_) && defined(LEGACY_BACKEND))
8768             return varDsc->lvIsParam && !varDsc->lvIsRegArg;
8769 #endif
8770         }
8771
8772 #ifdef DEBUG
8773         void Print()
8774         {
8775             printf("assignGroup [%p]; shadowCopy: [%d];\n", assignGroup, shadowCopy);
8776         }
8777 #endif
8778     };
8779
8780     GSCookie*           gsGlobalSecurityCookieAddr; // Address of global cookie for unsafe buffer checks
8781     GSCookie            gsGlobalSecurityCookieVal;  // Value of global cookie if addr is NULL
8782     ShadowParamVarInfo* gsShadowVarInfo;            // Table used by shadow param analysis code
8783
8784     void gsGSChecksInitCookie();   // Grabs cookie variable
8785     void gsCopyShadowParams();     // Identify vulnerable params and create dhadow copies
8786     bool gsFindVulnerableParams(); // Shadow param analysis code
8787     void gsParamsToShadows();      // Insert copy code and replave param uses by shadow
8788
8789     static fgWalkPreFn gsMarkPtrsAndAssignGroups; // Shadow param analysis tree-walk
8790     static fgWalkPreFn gsReplaceShadowParams;     // Shadow param replacement tree-walk
8791
8792 #define DEFAULT_MAX_INLINE_SIZE 100 // Methods with >  DEFAULT_MAX_INLINE_SIZE IL bytes will never be inlined.
8793                                     // This can be overwritten by setting complus_JITInlineSize env variable.
8794
8795 #define DEFAULT_MAX_INLINE_DEPTH 20 // Methods at more than this level deep will not be inlined
8796
8797 private:
8798 #ifdef FEATURE_JIT_METHOD_PERF
8799     JitTimer*                  pCompJitTimer;         // Timer data structure (by phases) for current compilation.
8800     static CompTimeSummaryInfo s_compJitTimerSummary; // Summary of the Timer information for the whole run.
8801
8802     static LPCWSTR JitTimeLogCsv();        // Retrieve the file name for CSV from ConfigDWORD.
8803     static LPCWSTR compJitTimeLogFilename; // If a log file for JIT time is desired, filename to write it to.
8804 #endif
8805     inline void EndPhase(Phases phase); // Indicate the end of the given phase.
8806
8807 #if MEASURE_CLRAPI_CALLS
8808     // Thin wrappers that call into JitTimer (if present).
8809     inline void CLRApiCallEnter(unsigned apix);
8810     inline void CLRApiCallLeave(unsigned apix);
8811
8812 public:
8813     inline void CLR_API_Enter(API_ICorJitInfo_Names ename);
8814     inline void CLR_API_Leave(API_ICorJitInfo_Names ename);
8815
8816 private:
8817 #endif
8818
8819 #if defined(DEBUG) || defined(INLINE_DATA) || defined(FEATURE_CLRSQM)
8820     // These variables are associated with maintaining SQM data about compile time.
8821     unsigned __int64 m_compCyclesAtEndOfInlining; // The thread-virtualized cycle count at the end of the inlining phase
8822                                                   // in the current compilation.
8823     unsigned __int64 m_compCycles;                // Net cycle count for current compilation
8824     DWORD m_compTickCountAtEndOfInlining; // The result of GetTickCount() (# ms since some epoch marker) at the end of
8825                                           // the inlining phase in the current compilation.
8826 #endif                                    // defined(DEBUG) || defined(INLINE_DATA) || defined(FEATURE_CLRSQM)
8827
8828     // Records the SQM-relevant (cycles and tick count).  Should be called after inlining is complete.
8829     // (We do this after inlining because this marks the last point at which the JIT is likely to cause
8830     // type-loading and class initialization).
8831     void RecordStateAtEndOfInlining();
8832     // Assumes being called at the end of compilation.  Update the SQM state.
8833     void RecordStateAtEndOfCompilation();
8834
8835 #ifdef FEATURE_CLRSQM
8836     // Does anything SQM related necessary at process shutdown time.
8837     static void ProcessShutdownSQMWork(ICorStaticInfo* statInfo);
8838 #endif // FEATURE_CLRSQM
8839
8840 public:
8841 #if FUNC_INFO_LOGGING
8842     static LPCWSTR compJitFuncInfoFilename; // If a log file for per-function information is required, this is the
8843                                             // filename to write it to.
8844     static FILE* compJitFuncInfoFile;       // And this is the actual FILE* to write to.
8845 #endif                                      // FUNC_INFO_LOGGING
8846
8847     Compiler* prevCompiler; // Previous compiler on stack for TLS Compiler* linked list for reentrant compilers.
8848
8849     // Is the compilation in a full trust context?
8850     bool compIsFullTrust();
8851
8852 #ifndef FEATURE_TRACELOGGING
8853     // Should we actually fire the noway assert body and the exception handler?
8854     bool compShouldThrowOnNoway();
8855 #else  // FEATURE_TRACELOGGING
8856     // Should we actually fire the noway assert body and the exception handler?
8857     bool compShouldThrowOnNoway(const char* filename, unsigned line);
8858
8859     // Telemetry instance to use per method compilation.
8860     JitTelemetry compJitTelemetry;
8861
8862     // Get common parameters that have to be logged with most telemetry data.
8863     void compGetTelemetryDefaults(const char** assemblyName,
8864                                   const char** scopeName,
8865                                   const char** methodName,
8866                                   unsigned*    methodHash);
8867 #endif // !FEATURE_TRACELOGGING
8868
8869 #ifdef DEBUG
8870 private:
8871     NodeToTestDataMap* m_nodeTestData;
8872
8873     static const unsigned FIRST_LOOP_HOIST_CSE_CLASS = 1000;
8874     unsigned              m_loopHoistCSEClass; // LoopHoist test annotations turn into CSE requirements; we
8875                                                // label them with CSE Class #'s starting at FIRST_LOOP_HOIST_CSE_CLASS.
8876                                                // Current kept in this.
8877 public:
8878     NodeToTestDataMap* GetNodeTestData()
8879     {
8880         Compiler* compRoot = impInlineRoot();
8881         if (compRoot->m_nodeTestData == nullptr)
8882         {
8883             compRoot->m_nodeTestData = new (getAllocatorDebugOnly()) NodeToTestDataMap(getAllocatorDebugOnly());
8884         }
8885         return compRoot->m_nodeTestData;
8886     }
8887
8888     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, int, JitSimplerHashBehavior> NodeToIntMap;
8889
8890     // Returns the set (i.e., the domain of the result map) of nodes that are keys in m_nodeTestData, and
8891     // currently occur in the AST graph.
8892     NodeToIntMap* FindReachableNodesInNodeTestData();
8893
8894     // Node "from" is being eliminated, and being replaced by node "to".  If "from" had any associated
8895     // test data, associate that data with "to".
8896     void TransferTestDataToNode(GenTreePtr from, GenTreePtr to);
8897
8898     // Requires that "to" is a clone of "from".  If any nodes in the "from" tree
8899     // have annotations, attach similar annotations to the corresponding nodes in "to".
8900     void CopyTestDataToCloneTree(GenTreePtr from, GenTreePtr to);
8901
8902     // These are the methods that test that the various conditions implied by the
8903     // test attributes are satisfied.
8904     void JitTestCheckSSA(); // SSA builder tests.
8905     void JitTestCheckVN();  // Value numbering tests.
8906 #endif                      // DEBUG
8907
8908     // The "FieldSeqStore", for canonicalizing field sequences.  See the definition of FieldSeqStore for
8909     // operations.
8910     FieldSeqStore* m_fieldSeqStore;
8911
8912     FieldSeqStore* GetFieldSeqStore()
8913     {
8914         Compiler* compRoot = impInlineRoot();
8915         if (compRoot->m_fieldSeqStore == nullptr)
8916         {
8917             // Create a CompAllocator that labels sub-structure with CMK_FieldSeqStore, and use that for allocation.
8918             IAllocator* ialloc        = new (this, CMK_FieldSeqStore) CompAllocator(this, CMK_FieldSeqStore);
8919             compRoot->m_fieldSeqStore = new (ialloc) FieldSeqStore(ialloc);
8920         }
8921         return compRoot->m_fieldSeqStore;
8922     }
8923
8924     typedef SimplerHashTable<GenTreePtr, PtrKeyFuncs<GenTree>, FieldSeqNode*, JitSimplerHashBehavior> NodeToFieldSeqMap;
8925
8926     // Some nodes of "TYP_BYREF" or "TYP_I_IMPL" actually represent the address of a field within a struct, but since
8927     // the offset of the field is zero, there's no "GT_ADD" node.  We normally attach a field sequence to the constant
8928     // that is added, but what do we do when that constant is zero, and is thus not present?  We use this mechanism to
8929     // attach the field sequence directly to the address node.
8930     NodeToFieldSeqMap* m_zeroOffsetFieldMap;
8931
8932     NodeToFieldSeqMap* GetZeroOffsetFieldMap()
8933     {
8934         // Don't need to worry about inlining here
8935         if (m_zeroOffsetFieldMap == nullptr)
8936         {
8937             // Create a CompAllocator that labels sub-structure with CMK_ZeroOffsetFieldMap, and use that for
8938             // allocation.
8939             IAllocator* ialloc   = new (this, CMK_ZeroOffsetFieldMap) CompAllocator(this, CMK_ZeroOffsetFieldMap);
8940             m_zeroOffsetFieldMap = new (ialloc) NodeToFieldSeqMap(ialloc);
8941         }
8942         return m_zeroOffsetFieldMap;
8943     }
8944
8945     // Requires that "op1" is a node of type "TYP_BYREF" or "TYP_I_IMPL".  We are dereferencing this with the fields in
8946     // "fieldSeq", whose offsets are required all to be zero.  Ensures that any field sequence annotation currently on
8947     // "op1" or its components is augmented by appending "fieldSeq".  In practice, if "op1" is a GT_LCL_FLD, it has
8948     // a field sequence as a member; otherwise, it may be the addition of an a byref and a constant, where the const
8949     // has a field sequence -- in this case "fieldSeq" is appended to that of the constant; otherwise, we
8950     // record the the field sequence using the ZeroOffsetFieldMap described above.
8951     //
8952     // One exception above is that "op1" is a node of type "TYP_REF" where "op1" is a GT_LCL_VAR.
8953     // This happens when System.Object vtable pointer is a regular field at offset 0 in System.Private.CoreLib in
8954     // CoreRT. Such case is handled same as the default case.
8955     void fgAddFieldSeqForZeroOffset(GenTreePtr op1, FieldSeqNode* fieldSeq);
8956
8957     typedef SimplerHashTable<const GenTree*, PtrKeyFuncs<GenTree>, ArrayInfo, JitSimplerHashBehavior>
8958                         NodeToArrayInfoMap;
8959     NodeToArrayInfoMap* m_arrayInfoMap;
8960
8961     NodeToArrayInfoMap* GetArrayInfoMap()
8962     {
8963         Compiler* compRoot = impInlineRoot();
8964         if (compRoot->m_arrayInfoMap == nullptr)
8965         {
8966             // Create a CompAllocator that labels sub-structure with CMK_ArrayInfoMap, and use that for allocation.
8967             IAllocator* ialloc       = new (this, CMK_ArrayInfoMap) CompAllocator(this, CMK_ArrayInfoMap);
8968             compRoot->m_arrayInfoMap = new (ialloc) NodeToArrayInfoMap(ialloc);
8969         }
8970         return compRoot->m_arrayInfoMap;
8971     }
8972
8973     NodeToUnsignedMap* m_heapSsaMap;
8974
8975     // In some cases, we want to assign intermediate SSA #'s to heap states, and know what nodes create those heap
8976     // states. (We do this for try blocks, where, if the try block doesn't do a call that loses track of the heap state,
8977     // all the possible heap states are possible initial states of the corresponding catch block(s).)
8978     NodeToUnsignedMap* GetHeapSsaMap()
8979     {
8980         Compiler* compRoot = impInlineRoot();
8981         if (compRoot->m_heapSsaMap == nullptr)
8982         {
8983             // Create a CompAllocator that labels sub-structure with CMK_ArrayInfoMap, and use that for allocation.
8984             IAllocator* ialloc     = new (this, CMK_ArrayInfoMap) CompAllocator(this, CMK_ArrayInfoMap);
8985             compRoot->m_heapSsaMap = new (ialloc) NodeToUnsignedMap(ialloc);
8986         }
8987         return compRoot->m_heapSsaMap;
8988     }
8989
8990     // The Refany type is the only struct type whose structure is implicitly assumed by IL.  We need its fields.
8991     CORINFO_CLASS_HANDLE m_refAnyClass;
8992     CORINFO_FIELD_HANDLE GetRefanyDataField()
8993     {
8994         if (m_refAnyClass == nullptr)
8995         {
8996             m_refAnyClass = info.compCompHnd->getBuiltinClass(CLASSID_TYPED_BYREF);
8997         }
8998         return info.compCompHnd->getFieldInClass(m_refAnyClass, 0);
8999     }
9000     CORINFO_FIELD_HANDLE GetRefanyTypeField()
9001     {
9002         if (m_refAnyClass == nullptr)
9003         {
9004             m_refAnyClass = info.compCompHnd->getBuiltinClass(CLASSID_TYPED_BYREF);
9005         }
9006         return info.compCompHnd->getFieldInClass(m_refAnyClass, 1);
9007     }
9008
9009 #if VARSET_COUNTOPS
9010     static BitSetSupport::BitSetOpCounter m_varsetOpCounter;
9011 #endif
9012 #if ALLVARSET_COUNTOPS
9013     static BitSetSupport::BitSetOpCounter m_allvarsetOpCounter;
9014 #endif
9015
9016     static HelperCallProperties s_helperCallProperties;
9017
9018 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
9019     static var_types GetTypeFromClassificationAndSizes(SystemVClassificationType classType, int size);
9020     static var_types GetEightByteType(const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR& structDesc,
9021                                       unsigned                                                   slotNum);
9022     static void GetStructTypeOffset(const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR& structDesc,
9023                                     var_types*                                                 type0,
9024                                     var_types*                                                 type1,
9025                                     unsigned __int8*                                           offset0,
9026                                     unsigned __int8*                                           offset1);
9027     void fgMorphSystemVStructArgs(GenTreeCall* call, bool hasStructArgument);
9028 #endif // defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
9029
9030     void fgMorphMultiregStructArgs(GenTreeCall* call);
9031     GenTreePtr fgMorphMultiregStructArg(GenTreePtr arg, fgArgTabEntryPtr fgEntryPtr);
9032
9033 }; // end of class Compiler
9034
9035 // Inline methods of CompAllocator.
9036 void* CompAllocator::Alloc(size_t sz)
9037 {
9038 #if MEASURE_MEM_ALLOC
9039     return m_comp->compGetMem(sz, m_cmk);
9040 #else
9041     return m_comp->compGetMem(sz);
9042 #endif
9043 }
9044
9045 void* CompAllocator::ArrayAlloc(size_t elems, size_t elemSize)
9046 {
9047 #if MEASURE_MEM_ALLOC
9048     return m_comp->compGetMemArray(elems, elemSize, m_cmk);
9049 #else
9050     return m_comp->compGetMemArray(elems, elemSize);
9051 #endif
9052 }
9053
9054 // LclVarDsc constructor. Uses Compiler, so must come after Compiler definition.
9055 inline LclVarDsc::LclVarDsc(Compiler* comp)
9056     : // Initialize the ArgRegs to REG_STK.
9057     // The morph will do the right thing to change
9058     // to the right register if passed in register.
9059     _lvArgReg(REG_STK)
9060     ,
9061 #if FEATURE_MULTIREG_ARGS
9062     _lvOtherArgReg(REG_STK)
9063     ,
9064 #endif // FEATURE_MULTIREG_ARGS
9065 #if ASSERTION_PROP
9066     lvRefBlks(BlockSetOps::UninitVal())
9067     ,
9068 #endif // ASSERTION_PROP
9069     lvPerSsaData(comp->getAllocator())
9070 {
9071 }
9072
9073 /*
9074 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9075 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9076 XX                                                                           XX
9077 XX                   Miscellaneous Compiler stuff                            XX
9078 XX                                                                           XX
9079 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9080 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9081 */
9082
9083 // Values used to mark the types a stack slot is used for
9084
9085 const unsigned TYPE_REF_INT      = 0x01; // slot used as a 32-bit int
9086 const unsigned TYPE_REF_LNG      = 0x02; // slot used as a 64-bit long
9087 const unsigned TYPE_REF_FLT      = 0x04; // slot used as a 32-bit float
9088 const unsigned TYPE_REF_DBL      = 0x08; // slot used as a 64-bit float
9089 const unsigned TYPE_REF_PTR      = 0x10; // slot used as a 32-bit pointer
9090 const unsigned TYPE_REF_BYR      = 0x20; // slot used as a byref pointer
9091 const unsigned TYPE_REF_STC      = 0x40; // slot used as a struct
9092 const unsigned TYPE_REF_TYPEMASK = 0x7F; // bits that represent the type
9093
9094 // const unsigned TYPE_REF_ADDR_TAKEN  = 0x80; // slots address was taken
9095
9096 /*****************************************************************************
9097  *
9098  *  Variables to keep track of total code amounts.
9099  */
9100
9101 #if DISPLAY_SIZES
9102
9103 extern size_t grossVMsize;
9104 extern size_t grossNCsize;
9105 extern size_t totalNCsize;
9106
9107 extern unsigned genMethodICnt;
9108 extern unsigned genMethodNCnt;
9109 extern size_t   gcHeaderISize;
9110 extern size_t   gcPtrMapISize;
9111 extern size_t   gcHeaderNSize;
9112 extern size_t   gcPtrMapNSize;
9113
9114 #endif // DISPLAY_SIZES
9115
9116 /*****************************************************************************
9117  *
9118  *  Variables to keep track of basic block counts (more data on 1 BB methods)
9119  */
9120
9121 #if COUNT_BASIC_BLOCKS
9122 extern Histogram bbCntTable;
9123 extern Histogram bbOneBBSizeTable;
9124 #endif
9125
9126 /*****************************************************************************
9127  *
9128  *  Used by optFindNaturalLoops to gather statistical information such as
9129  *   - total number of natural loops
9130  *   - number of loops with 1, 2, ... exit conditions
9131  *   - number of loops that have an iterator (for like)
9132  *   - number of loops that have a constant iterator
9133  */
9134
9135 #if COUNT_LOOPS
9136
9137 extern unsigned totalLoopMethods;        // counts the total number of methods that have natural loops
9138 extern unsigned maxLoopsPerMethod;       // counts the maximum number of loops a method has
9139 extern unsigned totalLoopOverflows;      // # of methods that identified more loops than we can represent
9140 extern unsigned totalLoopCount;          // counts the total number of natural loops
9141 extern unsigned totalUnnatLoopCount;     // counts the total number of (not-necessarily natural) loops
9142 extern unsigned totalUnnatLoopOverflows; // # of methods that identified more unnatural loops than we can represent
9143 extern unsigned iterLoopCount;           // counts the # of loops with an iterator (for like)
9144 extern unsigned simpleTestLoopCount;     // counts the # of loops with an iterator and a simple loop condition (iter <
9145                                          // const)
9146 extern unsigned  constIterLoopCount;     // counts the # of loops with a constant iterator (for like)
9147 extern bool      hasMethodLoops;         // flag to keep track if we already counted a method as having loops
9148 extern unsigned  loopsThisMethod;        // counts the number of loops in the current method
9149 extern bool      loopOverflowThisMethod; // True if we exceeded the max # of loops in the method.
9150 extern Histogram loopCountTable;         // Histogram of loop counts
9151 extern Histogram loopExitCountTable;     // Histogram of loop exit counts
9152
9153 #endif // COUNT_LOOPS
9154
9155 /*****************************************************************************
9156  * variables to keep track of how many iterations we go in a dataflow pass
9157  */
9158
9159 #if DATAFLOW_ITER
9160
9161 extern unsigned CSEiterCount; // counts the # of iteration for the CSE dataflow
9162 extern unsigned CFiterCount;  // counts the # of iteration for the Const Folding dataflow
9163
9164 #endif // DATAFLOW_ITER
9165
9166 #if MEASURE_BLOCK_SIZE
9167 extern size_t genFlowNodeSize;
9168 extern size_t genFlowNodeCnt;
9169 #endif // MEASURE_BLOCK_SIZE
9170
9171 #if MEASURE_NODE_SIZE
9172 struct NodeSizeStats
9173 {
9174     void Init()
9175     {
9176         genTreeNodeCnt        = 0;
9177         genTreeNodeSize       = 0;
9178         genTreeNodeActualSize = 0;
9179     }
9180
9181     size_t genTreeNodeCnt;
9182     size_t genTreeNodeSize;       // The size we allocate
9183     size_t genTreeNodeActualSize; // The actual size of the node. Note that the actual size will likely be smaller
9184                                   //   than the allocated size, but we sometimes use SetOper()/ChangeOper() to change
9185                                   //   a smaller node to a larger one. TODO-Cleanup: add stats on
9186                                   //   SetOper()/ChangeOper() usage to quanitfy this.
9187 };
9188 extern NodeSizeStats genNodeSizeStats;        // Total node size stats
9189 extern NodeSizeStats genNodeSizeStatsPerFunc; // Per-function node size stats
9190 extern Histogram     genTreeNcntHist;
9191 extern Histogram     genTreeNsizHist;
9192 #endif // MEASURE_NODE_SIZE
9193
9194 /*****************************************************************************
9195  *  Count fatal errors (including noway_asserts).
9196  */
9197
9198 #if MEASURE_FATAL
9199 extern unsigned fatal_badCode;
9200 extern unsigned fatal_noWay;
9201 extern unsigned fatal_NOMEM;
9202 extern unsigned fatal_noWayAssertBody;
9203 #ifdef DEBUG
9204 extern unsigned fatal_noWayAssertBodyArgs;
9205 #endif // DEBUG
9206 extern unsigned fatal_NYI;
9207 #endif // MEASURE_FATAL
9208
9209 /*****************************************************************************
9210  * Codegen
9211  */
9212
9213 #ifdef _TARGET_XARCH_
9214
9215 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_shl;
9216 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_shr;
9217 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_sar;
9218
9219 const instruction INS_AND             = INS_and;
9220 const instruction INS_OR              = INS_or;
9221 const instruction INS_XOR             = INS_xor;
9222 const instruction INS_NEG             = INS_neg;
9223 const instruction INS_TEST            = INS_test;
9224 const instruction INS_MUL             = INS_imul;
9225 const instruction INS_SIGNED_DIVIDE   = INS_idiv;
9226 const instruction INS_UNSIGNED_DIVIDE = INS_div;
9227 const instruction INS_BREAKPOINT      = INS_int3;
9228 const instruction INS_ADDC            = INS_adc;
9229 const instruction INS_SUBC            = INS_sbb;
9230 const instruction INS_NOT             = INS_not;
9231
9232 #endif
9233
9234 #ifdef _TARGET_ARM_
9235
9236 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_lsl;
9237 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_lsr;
9238 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_asr;
9239
9240 const instruction INS_AND             = INS_and;
9241 const instruction INS_OR              = INS_orr;
9242 const instruction INS_XOR             = INS_eor;
9243 const instruction INS_NEG             = INS_rsb;
9244 const instruction INS_TEST            = INS_tst;
9245 const instruction INS_MUL             = INS_mul;
9246 const instruction INS_SIGNED_DIVIDE   = INS_sdiv;
9247 const instruction INS_UNSIGNED_DIVIDE = INS_udiv;
9248 const instruction INS_BREAKPOINT      = INS_bkpt;
9249 const instruction INS_ADDC            = INS_adc;
9250 const instruction INS_SUBC            = INS_sbc;
9251 const instruction INS_NOT             = INS_mvn;
9252
9253 #endif
9254
9255 #ifdef _TARGET_ARM64_
9256
9257 const instruction INS_SHIFT_LEFT_LOGICAL  = INS_lsl;
9258 const instruction INS_SHIFT_RIGHT_LOGICAL = INS_lsr;
9259 const instruction INS_SHIFT_RIGHT_ARITHM  = INS_asr;
9260
9261 const instruction INS_AND             = INS_and;
9262 const instruction INS_OR              = INS_orr;
9263 const instruction INS_XOR             = INS_eor;
9264 const instruction INS_NEG             = INS_neg;
9265 const instruction INS_TEST            = INS_tst;
9266 const instruction INS_MUL             = INS_mul;
9267 const instruction INS_SIGNED_DIVIDE   = INS_sdiv;
9268 const instruction INS_UNSIGNED_DIVIDE = INS_udiv;
9269 const instruction INS_BREAKPOINT      = INS_bkpt;
9270 const instruction INS_ADDC            = INS_adc;
9271 const instruction INS_SUBC            = INS_sbc;
9272 const instruction INS_NOT             = INS_mvn;
9273
9274 #endif
9275
9276 /*****************************************************************************/
9277
9278 extern const BYTE genTypeSizes[];
9279 extern const BYTE genTypeAlignments[];
9280 extern const BYTE genTypeStSzs[];
9281 extern const BYTE genActualTypes[];
9282
9283 /*****************************************************************************/
9284
9285 // VERY_LARGE_FRAME_SIZE_REG_MASK is the set of registers we need to use for
9286 // the probing loop generated for very large stack frames (see `getVeryLargeFrameSize`).
9287
9288 #ifdef _TARGET_ARM_
9289 #define VERY_LARGE_FRAME_SIZE_REG_MASK (RBM_R4 | RBM_R5 | RBM_R6)
9290 #elif defined(_TARGET_ARM64_)
9291 #define VERY_LARGE_FRAME_SIZE_REG_MASK (RBM_R9 | RBM_R10 | RBM_R11)
9292 #endif
9293
9294 /*****************************************************************************/
9295
9296 #define REG_CORRUPT regNumber(REG_NA + 1)
9297 #define RBM_CORRUPT (RBM_ILLEGAL | regMaskTP(1))
9298 #define REG_PAIR_CORRUPT regPairNo(REG_PAIR_NONE + 1)
9299
9300 /*****************************************************************************/
9301
9302 extern BasicBlock dummyBB;
9303
9304 /*****************************************************************************/
9305 /*****************************************************************************/
9306
9307 // foreach_treenode_execution_order: An iterator that iterates through all the tree
9308 // nodes of a statement in execution order.
9309 //      __stmt: a GT_STMT type GenTree*
9310 //      __node: a GenTree*, already declared, that gets updated with each node in the statement, in execution order
9311
9312 #define foreach_treenode_execution_order(__node, __stmt)                                                               \
9313     for ((__node) = (__stmt)->gtStmt.gtStmtList; (__node); (__node) = (__node)->gtNext)
9314
9315 // foreach_block: An iterator over all blocks in the function.
9316 //    __compiler: the Compiler* object
9317 //    __block   : a BasicBlock*, already declared, that gets updated each iteration.
9318
9319 #define foreach_block(__compiler, __block)                                                                             \
9320     for ((__block) = (__compiler)->fgFirstBB; (__block); (__block) = (__block)->bbNext)
9321
9322 /*****************************************************************************/
9323 /*****************************************************************************/
9324
9325 #ifdef DEBUG
9326
9327 void dumpConvertedVarSet(Compiler* comp, VARSET_VALARG_TP vars);
9328
9329 /*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9330 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9331 XX                                                                           XX
9332 XX                          Debugging helpers                                XX
9333 XX                                                                           XX
9334 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9335 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9336 */
9337
9338 /*****************************************************************************/
9339 /* The following functions are intended to be called from the debugger, to dump
9340  * various data structures. The can be used in the debugger Watch or Quick Watch
9341  * windows. They are designed to be short to type and take as few arguments as
9342  * possible. The 'c' versions take a Compiler*, whereas the 'd' versions use the TlsCompiler.
9343  * See the function definition comment for more details.
9344  */
9345
9346 void cBlock(Compiler* comp, BasicBlock* block);
9347 void cBlocks(Compiler* comp);
9348 void cBlocksV(Compiler* comp);
9349 void cTree(Compiler* comp, GenTree* tree);
9350 void cTrees(Compiler* comp);
9351 void cEH(Compiler* comp);
9352 void cVar(Compiler* comp, unsigned lclNum);
9353 void cVarDsc(Compiler* comp, LclVarDsc* varDsc);
9354 void cVars(Compiler* comp);
9355 void cVarsFinal(Compiler* comp);
9356 void cBlockPreds(Compiler* comp, BasicBlock* block);
9357 void cReach(Compiler* comp);
9358 void cDoms(Compiler* comp);
9359 void cLiveness(Compiler* comp);
9360 void cCVarSet(Compiler* comp, VARSET_VALARG_TP vars);
9361
9362 void cFuncIR(Compiler* comp);
9363 void cBlockIR(Compiler* comp, BasicBlock* block);
9364 void cLoopIR(Compiler* comp, Compiler::LoopDsc* loop);
9365 void cTreeIR(Compiler* comp, GenTree* tree);
9366 int cTreeTypeIR(Compiler* comp, GenTree* tree);
9367 int cTreeKindsIR(Compiler* comp, GenTree* tree);
9368 int cTreeFlagsIR(Compiler* comp, GenTree* tree);
9369 int cOperandIR(Compiler* comp, GenTree* operand);
9370 int cLeafIR(Compiler* comp, GenTree* tree);
9371 int cIndirIR(Compiler* comp, GenTree* tree);
9372 int cListIR(Compiler* comp, GenTree* list);
9373 int cSsaNumIR(Compiler* comp, GenTree* tree);
9374 int cValNumIR(Compiler* comp, GenTree* tree);
9375 int cDependsIR(Compiler* comp, GenTree* comma, bool* first);
9376
9377 void dBlock(BasicBlock* block);
9378 void dBlocks();
9379 void dBlocksV();
9380 void dTree(GenTree* tree);
9381 void dTrees();
9382 void dEH();
9383 void dVar(unsigned lclNum);
9384 void dVarDsc(LclVarDsc* varDsc);
9385 void dVars();
9386 void dVarsFinal();
9387 void dBlockPreds(BasicBlock* block);
9388 void dReach();
9389 void dDoms();
9390 void dLiveness();
9391 void dCVarSet(VARSET_VALARG_TP vars);
9392
9393 void dVarSet(VARSET_VALARG_TP vars);
9394 void dRegMask(regMaskTP mask);
9395
9396 void dFuncIR();
9397 void dBlockIR(BasicBlock* block);
9398 void dTreeIR(GenTree* tree);
9399 void dLoopIR(Compiler::LoopDsc* loop);
9400 void dLoopNumIR(unsigned loopNum);
9401 int dTabStopIR(int curr, int tabstop);
9402 int dTreeTypeIR(GenTree* tree);
9403 int dTreeKindsIR(GenTree* tree);
9404 int dTreeFlagsIR(GenTree* tree);
9405 int dOperandIR(GenTree* operand);
9406 int dLeafIR(GenTree* tree);
9407 int dIndirIR(GenTree* tree);
9408 int dListIR(GenTree* list);
9409 int dSsaNumIR(GenTree* tree);
9410 int dValNumIR(GenTree* tree);
9411 int dDependsIR(GenTree* comma);
9412 void dFormatIR();
9413
9414 GenTree* dFindTree(GenTree* tree, unsigned id);
9415 GenTree* dFindTree(unsigned id);
9416 GenTreeStmt* dFindStmt(unsigned id);
9417 BasicBlock* dFindBlock(unsigned bbNum);
9418
9419 #endif // DEBUG
9420
9421 #include "compiler.hpp" // All the shared inline functions
9422
9423 /*****************************************************************************/
9424 #endif //_COMPILER_H_
9425 /*****************************************************************************/