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