src/jit/gentree.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                          GenTree                                          XX
   9 XX                                                                           XX
  10 XX  This is the node in the semantic tree graph. It represents the operation XX
  11 XX  corresponding to the node, and other information during code-gen.        XX
  12 XX                                                                           XX
  13 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  14 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  15 */
  16
  17 /*****************************************************************************/
  18 #ifndef _GENTREE_H_
  19 #define _GENTREE_H_
  20 /*****************************************************************************/
  21
  22 #include "vartype.h"    // For "var_types"
  23 #include "target.h"     // For "regNumber"
  24 #include "ssaconfig.h"  // For "SsaConfig::RESERVED_SSA_NUM"
  25 #include "reglist.h"
  26 #include "valuenumtype.h"
  27 #include "simplerhash.h"
  28 #include "nodeinfo.h"
  29 #include "simd.h"
  30
  31 // Debugging GenTree is much easier if we add a magic virtual function to make the debugger able to figure out what type it's got.
  32 // This is enabled by default in DEBUG. To enable it in RET builds (temporarily!), you need to change the build to define DEBUGGABLE_GENTREE=1,
  33 // as well as pass /OPT:NOICF to the linker (or else all the vtables get merged, making the debugging value supplied by them useless).
  34 // See protojit.nativeproj for a commented example of setting the build flags correctly.
  35 #ifndef DEBUGGABLE_GENTREE
  36 #ifdef DEBUG
  37 #define DEBUGGABLE_GENTREE  1
  38 #else // !DEBUG
  39 #define DEBUGGABLE_GENTREE  0
  40 #endif // !DEBUG
  41 #endif // !DEBUGGABLE_GENTREE
  42
  43 // The SpecialCodeKind enum is used to indicate the type of special (unique)
  44 // target block that will be targeted by an instruction.
  45 // These are used by:
  46 //   GenTreeBoundsChk nodes (SCK_RNGCHK_FAIL, SCK_ARG_EXCPN, SCK_ARG_RNG_EXCPN)
  47 //     - these nodes have a field (gtThrowKind) to indicate which kind
  48 //   GenTreeOps nodes, for which codegen will generate the branch
  49 //     - it will use the appropriate kind based on the opcode, though it's not
  50 //       clear why SCK_OVERFLOW == SCK_ARITH_EXCPN
  51 // SCK_PAUSE_EXEC is not currently used.
  52 //
  53 enum        SpecialCodeKind
  54 {
  55     SCK_NONE,
  56     SCK_RNGCHK_FAIL,                // target when range check fails
  57     SCK_PAUSE_EXEC,                 // target to stop (e.g. to allow GC)
  58     SCK_DIV_BY_ZERO,                // target for divide by zero (Not used on X86/X64)
  59     SCK_ARITH_EXCPN,                // target on arithmetic exception
  60     SCK_OVERFLOW = SCK_ARITH_EXCPN, // target on overflow
  61     SCK_ARG_EXCPN,                  // target on ArgumentException (currently used only for SIMD intrinsics)
  62     SCK_ARG_RNG_EXCPN,              // target on ArgumentOutOfRangeException (currently used only for SIMD intrinsics)
  63     SCK_COUNT
  64 };
  65
  66 /*****************************************************************************/
  67
  68 DECLARE_TYPED_ENUM(genTreeOps,BYTE)
  69 {
  70     #define GTNODE(en,sn,cm,ok) GT_ ## en,
  71     #include "gtlist.h"
  72
  73     GT_COUNT,
  74
  75     // GT_CNS_NATIVELONG is the gtOper symbol for GT_CNS_LNG or GT_CNS_INT, depending on the target.
  76     // For the 64-bit targets we will only use GT_CNS_INT as it used to represent all the possible sizes
  77     // For the 32-bit targets we use a GT_CNS_LNG to hold a 64-bit integer constant and GT_CNS_INT for all others.
  78     // In the future when we retarget the JIT for x86 we should consider eliminating GT_CNS_LNG
  79     //
  80 #ifdef _TARGET_64BIT_
  81     GT_CNS_NATIVELONG = GT_CNS_INT,
  82 #else
  83     GT_CNS_NATIVELONG = GT_CNS_LNG,
  84 #endif
  85 }
  86 END_DECLARE_TYPED_ENUM(genTreeOps,BYTE)
  87
  88 /*****************************************************************************
  89  *
  90  *  The following enum defines a set of bit flags that can be used
  91  *  to classify expression tree nodes. Note that some operators will
  92  *  have more than one bit set, as follows:
  93  *
  94  *          GTK_CONST    implies    GTK_LEAF
  95  *          GTK_RELOP    implies    GTK_BINOP
  96  *          GTK_LOGOP    implies    GTK_BINOP
  97  */
  98
  99 enum genTreeKinds
 100 {
 101     GTK_SPECIAL = 0x0000,       // unclassified operator (special handling reqd)
 102
 103     GTK_CONST   = 0x0001,       // constant     operator
 104     GTK_LEAF    = 0x0002,       // leaf         operator
 105     GTK_UNOP    = 0x0004,       // unary        operator
 106     GTK_BINOP   = 0x0008,       // binary       operator
 107     GTK_RELOP   = 0x0010,       // comparison   operator
 108     GTK_LOGOP   = 0x0020,       // logical      operator
 109     GTK_ASGOP   = 0x0040,       // assignment   operator
 110
 111     GTK_KINDMASK= 0x007F,       // operator kind mask
 112
 113     GTK_COMMUTE = 0x0080,       // commutative  operator
 114
 115     GTK_EXOP    = 0x0100,       // Indicates that an oper for a node type that extends GenTreeOp (or GenTreeUnOp)
 116                                 // by adding non-node fields to unary or binary operator.
 117
 118     GTK_LOCAL   = 0x0200,       // is a local access (load, store, phi)
 119
 120     /* Define composite value(s) */
 121
 122     GTK_SMPOP   = (GTK_UNOP|GTK_BINOP|GTK_RELOP|GTK_LOGOP)
 123 };
 124
 125 /*****************************************************************************/
 126
 127 #define SMALL_TREE_NODES    1
 128
 129 /*****************************************************************************/
 130
 131 DECLARE_TYPED_ENUM(gtCallTypes,BYTE)
 132 {
 133     CT_USER_FUNC,       // User function
 134     CT_HELPER,          // Jit-helper
 135     CT_INDIRECT,        // Indirect call
 136
 137     CT_COUNT            // fake entry (must be last)
 138 }
 139 END_DECLARE_TYPED_ENUM(gtCallTypes,BYTE)
 140
 141
 142 /*****************************************************************************/
 143
 144 struct                  BasicBlock;
 145
 146 struct                  InlineCandidateInfo;
 147
 148 /*****************************************************************************/
 149
 150 // GT_FIELD nodes will be lowered into more "code-gen-able" representations, like
 151 // GT_IND's of addresses, or GT_LCL_FLD nodes.  We'd like to preserve the more abstract
 152 // information, and will therefore annotate such lowered nodes with FieldSeq's.  A FieldSeq
 153 // represents a (possibly) empty sequence of fields.  The fields are in the order
 154 // in which they are dereferenced.  The first field may be an object field or a struct field;
 155 // all subsequent fields must be struct fields.
 156 struct FieldSeqNode
 157 {
 158     CORINFO_FIELD_HANDLE m_fieldHnd;
 159     FieldSeqNode*        m_next;
 160
 161     FieldSeqNode(CORINFO_FIELD_HANDLE fieldHnd, FieldSeqNode* next) : m_fieldHnd(fieldHnd), m_next(next) {}
 162
 163     // returns true when this is the pseudo #FirstElem field sequence
 164     bool IsFirstElemFieldSeq();
 165
 166     // returns true when this is the pseudo #ConstantIndex field sequence
 167     bool IsConstantIndexFieldSeq();
 168
 169     // returns true when this is the the pseudo #FirstElem field sequence or the pseudo #ConstantIndex field sequence
 170     bool IsPseudoField();
 171
 172     // Make sure this provides methods that allow it to be used as a KeyFuncs type in SimplerHash.
 173     static int GetHashCode(FieldSeqNode fsn)
 174     {
 175         return static_cast<int>(reinterpret_cast<intptr_t>(fsn.m_fieldHnd)) ^ static_cast<int>(reinterpret_cast<intptr_t>(fsn.m_next));
 176     }
 177
 178     static bool Equals(FieldSeqNode fsn1, FieldSeqNode fsn2)
 179     {
 180         return fsn1.m_fieldHnd == fsn2.m_fieldHnd && fsn1.m_next == fsn2.m_next;
 181     }
 182 };
 183
 184 // This class canonicalizes field sequences.
 185 class FieldSeqStore
 186 {
 187     typedef SimplerHashTable<FieldSeqNode, /*KeyFuncs*/FieldSeqNode, FieldSeqNode*, JitSimplerHashBehavior> FieldSeqNodeCanonMap;
 188
 189     IAllocator*           m_alloc;
 190     FieldSeqNodeCanonMap* m_canonMap;
 191
 192     static FieldSeqNode   s_notAField;  // No value, just exists to provide an address.
 193
 194     // Dummy variables to provide the addresses for the "pseudo field handle" statics below.
 195     static int FirstElemPseudoFieldStruct;
 196     static int ConstantIndexPseudoFieldStruct;
 197
 198 public:
 199     FieldSeqStore(IAllocator* alloc);
 200
 201     // Returns the (canonical in the store) singleton field sequence for the given handle.
 202     FieldSeqNode* CreateSingleton(CORINFO_FIELD_HANDLE fieldHnd);
 203
 204     // This is a special distinguished FieldSeqNode indicating that a constant does *not*
 205     // represent a valid field sequence.  This is "infectious", in the sense that appending it
 206     // (on either side) to any field sequence yields the "NotAField()" sequence.
 207     static FieldSeqNode* NotAField() { return &s_notAField; }
 208
 209     // Returns the (canonical in the store) field sequence representing the concatenation of
 210     // the sequences represented by "a" and "b".  Assumes that "a" and "b" are canonical; that is,
 211     // they are the results of CreateSingleton, NotAField, or Append calls.  If either of the arguments
 212     // are the "NotAField" value, so is the result.
 213     FieldSeqNode* Append(FieldSeqNode* a, FieldSeqNode* b);
 214
 215     // We have a few "pseudo" field handles:
 216
 217     // This treats the constant offset of the first element of something as if it were a field.
 218     // Works for method table offsets of boxed structs, or first elem offset of arrays/strings.
 219     static CORINFO_FIELD_HANDLE FirstElemPseudoField;
 220
 221     // If there is a constant index, we make a psuedo field to correspond to the constant added to
 222     // offset of the indexed field.  This keeps the field sequence structure "normalized", especially in the
 223     // case where the element type is a struct, so we might add a further struct field offset.
 224     static CORINFO_FIELD_HANDLE ConstantIndexPseudoField;
 225
 226     static bool IsPseudoField(CORINFO_FIELD_HANDLE hnd)
 227     {
 228         return hnd == FirstElemPseudoField || hnd == ConstantIndexPseudoField;
 229     }
 230 };
 231
 232
 233
 234 /*****************************************************************************/
 235
 236 typedef struct GenTree *  GenTreePtr;
 237 struct GenTreeArgList;
 238
 239 // Forward declarations of the subtypes
 240 #define GTSTRUCT_0(fn, en)                struct GenTree##fn;
 241 #define GTSTRUCT_1(fn, en)                struct GenTree##fn;
 242 #define GTSTRUCT_2(fn, en, en2)           struct GenTree##fn;
 243 #define GTSTRUCT_3(fn, en, en2, en3)      struct GenTree##fn;
 244 #define GTSTRUCT_4(fn, en, en2, en3, en4) struct GenTree##fn;
 245 #define GTSTRUCT_N(fn, ...) struct GenTree##fn;
 246 #include "gtstructs.h"
 247
 248 /*****************************************************************************/
 249
 250 #ifndef _HOST_64BIT_
 251 #include <pshpack4.h>
 252 #endif
 253
 254 struct GenTree
 255 {
 256     // We use GT_STRUCT_0 only for the category of simple ops.
 257 #define GTSTRUCT_0(fn, en)           GenTree##fn* As##fn() \
 258                                      { \
 259                                          assert(this->OperIsSimple()); \
 260                                          return reinterpret_cast<GenTree##fn*>(this); \
 261                                      } \
 262                                      GenTree##fn& As##fn##Ref() { return *As##fn(); } \
 263                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 264 #define GTSTRUCT_1(fn, en)           GenTree##fn* As##fn() \
 265                                      { \
 266                                          assert(this->gtOper == en); \
 267                                          return reinterpret_cast<GenTree##fn*>(this); \
 268                                      } \
 269                                      GenTree##fn& As##fn##Ref() { return *As##fn(); } \
 270                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 271 #define GTSTRUCT_2(fn, en, en2)      GenTree##fn* As##fn() \
 272                                      { \
 273                                          assert(this->gtOper == en || this->gtOper == en2); \
 274                                          return reinterpret_cast<GenTree##fn*>(this); \
 275                                      } \
 276                                      GenTree##fn& As##fn##Ref() { return *As##fn(); } \
 277                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 278 #define GTSTRUCT_3(fn, en, en2, en3) GenTree##fn* As##fn() \
 279                                      { \
 280                                          assert(this->gtOper == en || this->gtOper == en2 || this->gtOper == en3); \
 281                                          return reinterpret_cast<GenTree##fn*>(this); \
 282                                      } \
 283                                      GenTree##fn& As##fn##Ref() { return *As##fn(); } \
 284                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 285
 286 #define GTSTRUCT_4(fn, en, en2, en3, en4) GenTree##fn* As##fn() \
 287                                      { \
 288                                          assert(this->gtOper == en || this->gtOper == en2 || this->gtOper == en3 || this->gtOper == en4); \
 289                                          return reinterpret_cast<GenTree##fn*>(this); \
 290                                      } \
 291                                      GenTree##fn& As##fn##Ref() { return *As##fn(); } \
 292                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 293
 294 #ifdef DEBUG
 295 // VC does not optimize out this loop in retail even though the value it computes is unused
 296 // so we need a separate version for non-debug
 297 #define GTSTRUCT_N(fn, ...)          GenTree##fn* As##fn() \
 298                                      { \
 299                                          genTreeOps validOps[] = {__VA_ARGS__}; \
 300                                          bool found = false;            \
 301                                          for (unsigned i=0; i<ArrLen(validOps); i++) { \
 302                                              if (this->gtOper == validOps[i]) \
 303                                              {                          \
 304                                                  found = true;          \
 305                                                  break;                 \
 306                                              }                          \
 307                                          }                              \
 308                                          assert(found);                 \
 309                                          return reinterpret_cast<GenTree##fn*>(this); \
 310                                      }                                  \
 311                                      GenTree##fn& As##fn##Ref() { return *As##fn(); }                    \
 312                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 313 #else
 314 #define GTSTRUCT_N(fn, ...)          GenTree##fn* As##fn()    \
 315                                      { \
 316                                          return reinterpret_cast<GenTree##fn*>(this); \
 317                                      }                                  \
 318                                      GenTree##fn& As##fn##Ref() { return *As##fn(); }                    \
 319                                      __declspec(property(get=As##fn##Ref)) GenTree##fn& gt##fn;
 320 #endif
 321
 322 #include "gtstructs.h"
 323
 324     genTreeOps          gtOper;       // enum subtype BYTE
 325     var_types           gtType;       // enum subtype BYTE
 326
 327     genTreeOps          OperGet() const { return gtOper; }
 328     var_types           TypeGet() const { return gtType; }
 329
 330 #ifdef DEBUG
 331     genTreeOps          gtOperSave;   // Only used to save gtOper when we destroy a node, to aid debugging.
 332 #endif
 333
 334 #if FEATURE_ANYCSE
 335
 336 #define NO_CSE           (0)
 337
 338 #define IS_CSE_INDEX(x)  (x != 0)
 339 #define IS_CSE_USE(x)    (x > 0)
 340 #define IS_CSE_DEF(x)    (x < 0)
 341 #define GET_CSE_INDEX(x) ((x > 0) ? x : -x)
 342 #define TO_CSE_DEF(x)    (-x)
 343
 344     signed char       gtCSEnum;        // 0 or the CSE index (negated if def)
 345                                        // valid only for CSE expressions
 346
 347 #endif // FEATURE_ANYCSE
 348
 349 #if ASSERTION_PROP
 350     unsigned short     gtAssertionNum;  // 0 or Assertion table index
 351                                         // valid only for non-GT_STMT nodes
 352
 353     bool         HasAssertion() const             { return gtAssertionNum != 0; }
 354     void         ClearAssertion()                 { gtAssertionNum = 0;         }
 355
 356     unsigned short GetAssertion() const             { return gtAssertionNum;  }
 357     void           SetAssertion(unsigned short value) { assert((unsigned short)value == value); gtAssertionNum = (unsigned short)value; }
 358
 359 #endif
 360
 361 #if FEATURE_STACK_FP_X87
 362     unsigned char       gtFPlvl;        // x87 stack depth at this node
 363     void                gtCopyFPlvl(GenTree * other) { gtFPlvl = other->gtFPlvl; }
 364     void                gtSetFPlvl(unsigned level) { noway_assert(FitsIn<unsigned char>(level)); gtFPlvl = (unsigned char)level; }
 365 #else // FEATURE_STACK_FP_X87
 366     void                gtCopyFPlvl(GenTree * other) { }
 367     void                gtSetFPlvl(unsigned level) { }
 368 #endif // FEATURE_STACK_FP_X87
 369
 370     //
 371     // Cost metrics on the node. Don't allow direct access to the variable for setting.
 372     //
 373
 374 public:
 375
 376 #ifdef DEBUG
 377     // You are not allowed to read the cost values before they have been set in gtSetEvalOrder().
 378     // Keep track of whether the costs have been initialized, and assert if they are read before being initialized.
 379     // Obviously, this information does need to be initialized when a node is created.
 380     // This is public so the dumpers can see it.
 381
 382     bool gtCostsInitialized;
 383 #endif // DEBUG
 384
 385 #define MAX_COST        UCHAR_MAX
 386 #define IND_COST_EX     3             // execution cost for an indirection
 387
 388     __declspec(property(get=GetCostEx))
 389     unsigned char    gtCostEx;     // estimate of expression execution cost
 390
 391     __declspec(property(get=GetCostSz))
 392     unsigned char    gtCostSz;     // estimate of expression code size cost
 393
 394     unsigned char GetCostEx() const { assert(gtCostsInitialized); return _gtCostEx; }
 395     unsigned char GetCostSz() const { assert(gtCostsInitialized); return _gtCostSz; }
 396
 397     // Set the costs. They are always both set at the same time.
 398     // Don't use the "put" property: force calling this function, to make it more obvious in the few places
 399     // that set the values.
 400     // Note that costs are only set in gtSetEvalOrder() and its callees.
 401     void            SetCosts(unsigned costEx, unsigned costSz)
 402     {
 403         assert(costEx != (unsigned)-1); // looks bogus
 404         assert(costSz != (unsigned)-1); // looks bogus
 405         INDEBUG(gtCostsInitialized = true;)
 406
 407         _gtCostEx = (costEx > MAX_COST) ? MAX_COST : (unsigned char)costEx;
 408         _gtCostSz = (costSz > MAX_COST) ? MAX_COST : (unsigned char)costSz;
 409     }
 410
 411     // Opimized copy function, to avoid the SetCosts() function comparisons, and make it more clear that a node copy is happening.
 412     void            CopyCosts(const GenTree* const tree)
 413     {
 414         INDEBUG(gtCostsInitialized = tree->gtCostsInitialized;) // If the 'tree' costs aren't initialized, we'll hit an assert below.
 415         _gtCostEx = tree->gtCostEx;
 416         _gtCostSz = tree->gtCostSz;
 417     }
 418
 419     // Same as CopyCosts, but avoids asserts if the costs we are copying have not been initialized.
 420     // This is because the importer, for example, clones nodes, before these costs have been initialized.
 421     // Note that we directly access the 'tree' costs, not going through the accessor functions (either
 422     // directly or through the properties).
 423     void            CopyRawCosts(const GenTree* const tree)
 424     {
 425         INDEBUG(gtCostsInitialized = tree->gtCostsInitialized;)
 426         _gtCostEx = tree->_gtCostEx;
 427         _gtCostSz = tree->_gtCostSz;
 428     }
 429
 430 private:
 431
 432     unsigned char    _gtCostEx;     // estimate of expression execution cost
 433     unsigned char    _gtCostSz;     // estimate of expression code size cost
 434
 435     //
 436     // Register or register pair number of the node.
 437     //
 438
 439 #ifdef DEBUG
 440 public:
 441     enum genRegTag
 442     {
 443         GT_REGTAG_NONE,     // Nothing has been assigned to _gtRegNum/_gtRegPair
 444         GT_REGTAG_REG,      // _gtRegNum  has been assigned
 445 #if CPU_LONG_USES_REGPAIR
 446         GT_REGTAG_REGPAIR   // _gtRegPair has been assigned
 447 #endif
 448     };
 449     genRegTag GetRegTag() const
 450     {
 451 #if CPU_LONG_USES_REGPAIR
 452         assert(gtRegTag == GT_REGTAG_NONE || gtRegTag == GT_REGTAG_REG || gtRegTag == GT_REGTAG_REGPAIR);
 453 #else
 454         assert(gtRegTag == GT_REGTAG_NONE || gtRegTag == GT_REGTAG_REG);
 455 #endif
 456         return gtRegTag;
 457     }
 458 private:
 459     genRegTag           gtRegTag; // What is in _gtRegNum/_gtRegPair?
 460 #endif // DEBUG
 461
 462 private:
 463
 464     union
 465     {
 466         // NOTE: After LSRA, one of these values may be valid even if GTF_REG_VAL is not set in gtFlags.
 467         // They store the register assigned to the node. If a register is not assigned, _gtRegNum is set to REG_NA
 468         // or _gtRegPair is set to REG_PAIR_NONE, depending on the node type.
 469         regNumberSmall   _gtRegNum;     // which register      the value is in
 470         regPairNoSmall   _gtRegPair;    // which register pair the value is in
 471     };
 472
 473 public:
 474
 475     // The register number is stored in a small format (8 bits), but the getters return and the setters take
 476     // a full-size (unsigned) format, to localize the casts here.
 477
 478     __declspec(property(get=GetRegNum,put=SetRegNum))
 479     regNumber           gtRegNum;
 480
 481     // for codegen purposes, is this node a subnode of its parent
 482     bool isContained() const;
 483
 484     bool isContainedIndir() const;
 485
 486     bool isIndirAddrMode();
 487
 488     bool isIndir() const;
 489
 490     bool isContainedIntOrIImmed() const     { return isContained() && IsCnsIntOrI(); }
 491
 492     bool isContainedFltOrDblImmed() const   { return isContained() && (OperGet() == GT_CNS_DBL); }
 493
 494     bool isLclField() const                 { return OperGet() == GT_LCL_FLD || OperGet() == GT_STORE_LCL_FLD; }
 495
 496     bool isContainedLclField() const        { return isContained() && isLclField(); }
 497
 498     // Indicates whether it is a memory op.
 499     // Right now it includes Indir and LclField ops.
 500     bool isMemoryOp() const                 { return isIndir() || isLclField(); }
 501
 502     bool isContainedMemoryOp() const        { return isContained() && isMemoryOp(); }
 503
 504     regNumber GetRegNum() const
 505     {
 506         assert((gtRegTag == GT_REGTAG_REG) ||
 507                (gtRegTag == GT_REGTAG_NONE)); // TODO-Cleanup: get rid of the NONE case, and fix everyplace that reads undefined values
 508         regNumber reg = (regNumber) _gtRegNum;
 509         assert((gtRegTag == GT_REGTAG_NONE) || // TODO-Cleanup: get rid of the NONE case, and fix everyplace that reads undefined values
 510                (reg >= REG_FIRST &&
 511                 reg <= REG_COUNT));
 512         return reg;
 513     }
 514
 515     void SetRegNum(regNumber reg)
 516     {
 517         assert(reg >= REG_FIRST &&
 518                reg <= REG_COUNT);
 519         // Make sure the upper bits of _gtRegPair are clear
 520         _gtRegPair = (regPairNoSmall) 0;
 521         _gtRegNum = (regNumberSmall) reg;
 522         INDEBUG(gtRegTag = GT_REGTAG_REG;)
 523         assert(_gtRegNum == reg);
 524     }
 525
 526 #if CPU_LONG_USES_REGPAIR
 527     __declspec(property(get=GetRegPair,put=SetRegPair))
 528     regPairNo           gtRegPair;
 529
 530     regPairNo GetRegPair() const
 531     {
 532         assert((gtRegTag == GT_REGTAG_REGPAIR) ||
 533                (gtRegTag == GT_REGTAG_NONE)); // TODO-Cleanup: get rid of the NONE case, and fix everyplace that reads undefined values
 534         regPairNo regPair = (regPairNo) _gtRegPair;
 535         assert((gtRegTag == GT_REGTAG_NONE) || // TODO-Cleanup: get rid of the NONE case, and fix everyplace that reads undefined values
 536                (regPair >= REG_PAIR_FIRST &&
 537                 regPair <= REG_PAIR_LAST) ||
 538                (regPair == REG_PAIR_NONE));     // allow initializing to an undefined value
 539         return regPair;
 540     }
 541
 542     void SetRegPair(regPairNo regPair)
 543     {
 544         assert((regPair >= REG_PAIR_FIRST &&
 545                 regPair <= REG_PAIR_LAST) ||
 546                (regPair == REG_PAIR_NONE));     // allow initializing to an undefined value
 547         _gtRegPair = (regPairNoSmall) regPair;
 548         INDEBUG(gtRegTag = GT_REGTAG_REGPAIR;)
 549         assert(_gtRegPair == regPair);
 550     }
 551 #endif
 552
 553     // Copy the _gtRegNum/_gtRegPair/gtRegTag fields
 554     void CopyReg(GenTreePtr from);
 555
 556     void gtClearReg(Compiler* compiler);
 557
 558     bool gtHasReg() const;
 559
 560     regMaskTP gtGetRegMask() const;
 561
 562     unsigned            gtFlags;        // see GTF_xxxx below
 563
 564     ValueNumPair        gtVNPair;
 565
 566     regMaskSmall        gtRsvdRegs;     // set of fixed trashed  registers
 567 #ifdef LEGACY_BACKEND
 568     regMaskSmall        gtUsedRegs;     // set of used (trashed) registers
 569 #endif // LEGACY_BACKEND
 570
 571 #ifndef LEGACY_BACKEND
 572     TreeNodeInfo        gtLsraInfo;
 573 #endif // !LEGACY_BACKEND
 574
 575     void                SetVNsFromNode(GenTreePtr tree)
 576     {
 577         gtVNPair = tree->gtVNPair;
 578     }
 579
 580     ValueNum            GetVN(ValueNumKind vnk) const
 581     {
 582         if (vnk == VNK_Liberal)
 583         {
 584             return gtVNPair.GetLiberal();
 585         }
 586         else
 587         {
 588             assert(vnk == VNK_Conservative);
 589             return gtVNPair.GetConservative();
 590         }
 591     }
 592     void                SetVN(ValueNumKind vnk, ValueNum vn)
 593     {
 594         if (vnk == VNK_Liberal)
 595         {
 596             return gtVNPair.SetLiberal(vn);
 597         }
 598         else
 599         {
 600             assert(vnk == VNK_Conservative);
 601             return gtVNPair.SetConservative(vn);
 602         }
 603     }
 604     void                SetVNs(ValueNumPair vnp)
 605     {
 606         gtVNPair = vnp;
 607     }
 608     void                ClearVN()
 609     {
 610         gtVNPair = ValueNumPair();          // Initializes both elements to "NoVN".
 611     }
 612
 613     //---------------------------------------------------------------------
 614     //  The first set of flags can be used with a large set of nodes, and
 615     //  thus they must all have distinct values. That is, one can test any
 616     //  expression node for one of these flags.
 617     //---------------------------------------------------------------------
 618
 619     #define GTF_ASG             0x00000001  // sub-expression contains an assignment
 620     #define GTF_CALL            0x00000002  // sub-expression contains a  func. call
 621     #define GTF_EXCEPT          0x00000004  // sub-expression might throw an exception
 622     #define GTF_GLOB_REF        0x00000008  // sub-expression uses global variable(s)
 623     #define GTF_ORDER_SIDEEFF   0x00000010  // sub-expression has a re-ordering side effect
 624
 625     // If you set these flags, make sure that code:gtExtractSideEffList knows how to find the tree,
 626     // otherwise the C# (run csc /o-)
 627     // var v = side_eff_operation
 628     // with no use of v will drop your tree on the floor.
 629     #define GTF_PERSISTENT_SIDE_EFFECTS (GTF_ASG|GTF_CALL)
 630     #define GTF_SIDE_EFFECT     (GTF_PERSISTENT_SIDE_EFFECTS|GTF_EXCEPT)
 631     #define GTF_GLOB_EFFECT     (GTF_SIDE_EFFECT|GTF_GLOB_REF)
 632     #define GTF_ALL_EFFECT      (GTF_GLOB_EFFECT|GTF_ORDER_SIDEEFF)
 633
 634     // The extra flag GTF_DEAD is used to tell the consumer of these flags
 635     // that we are calling in the context of performing a CSE, thus we
 636     // should allow the run-once side effects of running a class constructor.
 637     //
 638     #define GTF_PERSISTENT_SIDE_EFFECTS_IN_CSE (GTF_ASG|GTF_CALL|GTF_DEAD)
 639
 640     // Can any side-effects be observed externally, say by a caller method?
 641     // For assignments, only assignments to global memory can be observed
 642     // externally, whereas simple assignments to local variables can not.
 643     //
 644     // Be careful when using this inside a "try" protected region as the
 645     // order of assignments to local variables would need to be preserved
 646     // wrt side effects if the variables are alive on entry to the
 647     // "catch/finally" region. In such cases, even assignments to locals
 648     // will have to be restricted.
 649     #define GTF_GLOBALLY_VISIBLE_SIDE_EFFECTS(flags)                    \
 650         (((flags) & (GTF_CALL|GTF_EXCEPT))                   ||         \
 651          (((flags) & (GTF_ASG|GTF_GLOB_REF)) == (GTF_ASG|GTF_GLOB_REF)))
 652
 653     #define GTF_REVERSE_OPS     0x00000020  // operand op2 should be evaluated before op1 (normally, op1 is evaluated first and op2 is evaluated second)
 654     #define GTF_REG_VAL         0x00000040  // operand is sitting in a register (or part of a TYP_LONG operand is sitting in a register)
 655
 656     #define GTF_SPILLED         0x00000080  // the value   has been spilled
 657     #define GTF_SPILLED_OPER    0x00000100  //   op1 has been spilled
 658
 659 #ifdef LEGACY_BACKEND
 660     #define GTF_SPILLED_OP2     0x00000200  //   op2 has been spilled
 661 #endif // LEGACY_BACKEND
 662
 663 #ifdef DEBUG
 664 #ifndef LEGACY_BACKEND
 665     #define GTF_MORPHED         0x00000200  // the node has been morphed (in the global morphing phase)
 666 #else // LEGACY_BACKEND
 667     // For LEGACY_BACKEND, 0x00000200 is in use, but we can use the same value as GTF_SPILLED since we
 668     // don't call gtSetEvalOrder(), which clears GTF_MORPHED, after GTF_SPILLED has been set.
 669     #define GTF_MORPHED         0x00000080  // the node has been morphed (in the global morphing phase)
 670 #endif // LEGACY_BACKEND
 671 #endif // DEBUG
 672
 673     #define GTF_REDINDEX_CHECK  0x00000100  // Used for redundant range checks. Disjoint from GTF_SPILLED_OPER
 674
 675     #define GTF_ZSF_SET         0x00000400  // the zero(ZF) and sign(SF) flags set to the operand
 676 #if FEATURE_SET_FLAGS
 677     #define GTF_SET_FLAGS       0x00000800  // Requires that codegen for this node set the flags
 678                                             // Use gtSetFlags() to check this flags
 679 #endif
 680     #define GTF_IND_NONFAULTING 0x00000800  // An indir that cannot fault.  GTF_SET_FLAGS is not used on indirs
 681
 682 #if FEATURE_ANYCSE
 683     #define GTF_DEAD            0x00001000  // this node won't be used any more
 684 #endif // FEATURE_ANYCSE
 685
 686     #define GTF_MAKE_CSE        0x00002000  // Hoisted Expression: try hard to make this into CSE  (see optPerformHoistExpr)
 687     #define GTF_DONT_CSE        0x00004000  // don't bother CSE'ing this expr
 688     #define GTF_COLON_COND      0x00008000  // this node is conditionally executed (part of ? :)
 689
 690 #if defined(DEBUG) && SMALL_TREE_NODES
 691     #define GTF_NODE_LARGE      0x00010000
 692     #define GTF_NODE_SMALL      0x00020000
 693
 694     // Property of the node itself, not the gtOper
 695     #define GTF_NODE_MASK       (GTF_COLON_COND | GTF_MORPHED   | GTF_NODE_SMALL | GTF_NODE_LARGE )
 696 #else
 697     #define GTF_NODE_MASK       (GTF_COLON_COND)
 698 #endif
 699
 700     #define GTF_BOOLEAN         0x00040000  // value is known to be 0/1
 701
 702     #define GTF_SMALL_OK        0x00080000  // actual small int sufficient
 703
 704     #define GTF_UNSIGNED        0x00100000  // with GT_CAST:   the source operand is an unsigned type
 705                                             // with operators: the specified node is an unsigned operator
 706
 707     #define GTF_LATE_ARG        0x00200000  // the specified node is evaluated to a temp in the arg list, and this temp is added to gtCallLateArgs.
 708
 709     #define GTF_SPILL           0x00400000  // needs to be spilled here
 710     #define GTF_SPILL_HIGH      0x00040000  // shared with GTF_BOOLEAN
 711
 712     #define GTF_COMMON_MASK     0x007FFFFF  // mask of all the flags above
 713
 714     #define GTF_REUSE_REG_VAL   0x00800000  // This is set by the register allocator on nodes whose value already exists in the
 715                                             // register assigned to this node, so the code generator does not have to generate
 716                                             // code to produce the value.
 717                                             // It is currently used only on constant nodes.
 718                                             // It CANNOT be set on var (GT_LCL*) nodes, or on indir (GT_IND or GT_STOREIND) nodes, since
 719                                             // 1) it is not needed for lclVars and is highly unlikely to be useful for indir nodes, and
 720                                             // 2) it conflicts with GTFD_VAR_CSE_REF for lclVars (though this is debug only, and
 721                                             //    GTF_IND_ARR_INDEX for indirs.
 722
 723     //---------------------------------------------------------------------
 724     //  The following flags can be used only with a small set of nodes, and
 725     //  thus their values need not be distinct (other than within the set
 726     //  that goes with a particular node/nodes, of course). That is, one can
 727     //  only test for one of these flags if the 'gtOper' value is tested as
 728     //  well to make sure it's the right operator for the particular flag.
 729     //---------------------------------------------------------------------
 730
 731     // NB: GTF_VAR_* and GTF_REG_* share the same namespace of flags, because
 732     // GT_LCL_VAR nodes may be changed to GT_REG_VAR nodes without resetting
 733     // the flags. These are also used by GT_LCL_FLD.
 734     #define GTF_VAR_DEF         0x80000000  // GT_LCL_VAR -- this is a definition
 735     #define GTF_VAR_USEASG      0x40000000  // GT_LCL_VAR -- this is a use/def for a x<op>=y
 736     #define GTF_VAR_USEDEF      0x20000000  // GT_LCL_VAR -- this is a use/def as in x=x+y (only the lhs x is tagged)
 737     #define GTF_VAR_CAST        0x10000000  // GT_LCL_VAR -- has been explictly cast (variable node may not be type of local)
 738     #define GTF_VAR_ITERATOR    0x08000000  // GT_LCL_VAR -- this is a iterator reference in the loop condition
 739     #define GTF_VAR_CLONED      0x01000000  // GT_LCL_VAR -- this node has been cloned or is a clone
 740                                             // Relevant for inlining optimizations (see fgInlinePrependStatements)
 741
 742     // TODO-Cleanup: Currently, GTF_REG_BIRTH is used only by stackfp
 743     //         We should consider using it more generally for VAR_BIRTH, instead of
 744     //         GTF_VAR_DEF && !GTF_VAR_USEASG
 745     #define GTF_REG_BIRTH       0x04000000  // GT_REG_VAR -- enregistered variable born here
 746     #define GTF_VAR_DEATH       0x02000000  // GT_LCL_VAR, GT_REG_VAR -- variable dies here (last use)
 747
 748     #define GTF_VAR_ARR_INDEX   0x00000020  // The variable is part of (the index portion of) an array index expression.
 749                                             // Shares a value with GTF_REVERSE_OPS, which is meaningless for local var.
 750
 751     #define GTF_LIVENESS_MASK   (GTF_VAR_DEF|GTF_VAR_USEASG|GTF_VAR_USEDEF|GTF_REG_BIRTH|GTF_VAR_DEATH)
 752
 753     #define GTF_CALL_UNMANAGED  0x80000000  // GT_CALL    -- direct call to unmanaged code
 754     #define GTF_CALL_INLINE_CANDIDATE 0x40000000 // GT_CALL -- this call has been marked as an inline candidate
 755 //
 756     #define GTF_CALL_VIRT_KIND_MASK  0x30000000
 757     #define GTF_CALL_NONVIRT         0x00000000  // GT_CALL    -- a non virtual call
 758     #define GTF_CALL_VIRT_STUB       0x10000000  // GT_CALL    -- a stub-dispatch virtual call
 759     #define GTF_CALL_VIRT_VTABLE     0x20000000  // GT_CALL    -- a  vtable-based virtual call
 760
 761     #define GTF_CALL_NULLCHECK  0x08000000  // GT_CALL    -- must check instance pointer for null
 762     #define GTF_CALL_POP_ARGS   0x04000000  // GT_CALL    -- caller pop arguments?
 763     #define GTF_CALL_HOISTABLE  0x02000000  // GT_CALL    -- call is hoistable
 764     #define GTF_CALL_REG_SAVE   0x01000000  // GT_CALL    -- This call preserves all integer regs
 765                                             // For additional flags for GT_CALL node see GTF_CALL_M_
 766
 767 #ifdef DEBUG
 768     #define GTFD_VAR_CSE_REF    0x00800000  // GT_LCL_VAR -- This is a CSE LCL_VAR node
 769 #endif
 770
 771     #define GTF_NOP_DEATH         0x40000000  // GT_NOP     -- operand dies here
 772
 773     #define GTF_FLD_NULLCHECK     0x80000000  // GT_FIELD -- need to nullcheck the "this" pointer
 774     #define GTF_FLD_VOLATILE      0x40000000  // GT_FIELD/GT_CLS_VAR -- same as GTF_IND_VOLATILE
 775
 776     #define GTF_INX_RNGCHK        0x80000000  // GT_INDEX -- the array reference should be range-checked.
 777     #define GTF_INX_REFARR_LAYOUT 0x20000000  // GT_INDEX -- same as GTF_IND_REFARR_LAYOUT
 778     #define GTF_INX_STRING_LAYOUT 0x40000000  // GT_INDEX -- this uses the special string array layout
 779
 780     #define GTF_IND_VOLATILE      0x40000000  // GT_IND   -- the load or store must use volatile sematics (this is a nop on X86)
 781     #define GTF_IND_REFARR_LAYOUT 0x20000000  // GT_IND   -- the array holds object refs (only effects layout of Arrays)
 782     #define GTF_IND_TGTANYWHERE   0x10000000  // GT_IND   -- the target could be anywhere
 783     #define GTF_IND_TLS_REF       0x08000000  // GT_IND   -- the target is accessed via TLS
 784     #define GTF_IND_ASG_LHS       0x04000000  // GT_IND   -- this GT_IND node is (the effective val) of the LHS of an assignment; don't evaluate it independently.
 785     #define GTF_IND_UNALIGNED     0x02000000  // GT_IND   -- the load or store is unaligned (we assume worst case alignment of 1 byte)
 786     #define GTF_IND_INVARIANT     0x01000000  // GT_IND   -- the target is invariant (a prejit indirection)
 787     #define GTF_IND_ARR_LEN       0x80000000  // GT_IND   -- the indirection represents an array length (of the REF contribution to its argument).
 788     #define GTF_IND_ARR_INDEX     0x00800000  // GT_IND   -- the indirection represents an (SZ) array index (this shares the same value as GTFD_VAR_CSE_REF,
 789                                               //             but is disjoint because a GT_LCL_VAR is never an ind (GT_IND or GT_STOREIND)
 790
 791     #define GTF_IND_FLAGS         (GTF_IND_VOLATILE|GTF_IND_REFARR_LAYOUT|GTF_IND_TGTANYWHERE|GTF_IND_NONFAULTING|\
 792                                    GTF_IND_TLS_REF|GTF_IND_UNALIGNED|GTF_IND_INVARIANT|GTF_IND_ARR_INDEX)
 793
 794     #define GTF_CLS_VAR_ASG_LHS   0x04000000  // GT_CLS_VAR   -- this GT_CLS_VAR node is (the effective val) of the LHS of an assignment; don't evaluate it independently.
 795
 796     #define GTF_ADDR_ONSTACK      0x80000000  // GT_ADDR    -- this expression is guaranteed to be on the stack
 797
 798
 799     #define GTF_ADDRMODE_NO_CSE 0x80000000  // GT_ADD/GT_MUL/GT_LSH -- Do not CSE this node only, forms complex addressing mode
 800
 801     #define GTF_MUL_64RSLT      0x40000000  // GT_MUL     -- produce 64-bit result
 802
 803     #define GTF_MOD_INT_RESULT  0x80000000  // GT_MOD,    -- the real tree represented by this
 804                                             // GT_UMOD       node evaluates to an int even though
 805                                             //               its type is long.  The result is
 806                                             //               placed in the low member of the
 807                                             //               reg pair
 808
 809     #define GTF_RELOP_NAN_UN    0x80000000  // GT_<relop> -- Is branch taken if ops are NaN?
 810     #define GTF_RELOP_JMP_USED  0x40000000  // GT_<relop> -- result of compare used for jump or ?:
 811     #define GTF_RELOP_QMARK     0x20000000  // GT_<relop> -- the node is the condition for ?:
 812     #define GTF_RELOP_SMALL     0x10000000  // GT_<relop> -- We should use a byte or short sized compare (op1->gtType is the small type)
 813     #define GTF_RELOP_ZTT       0x08000000  // GT_<relop> -- Loop test cloned for converting while-loops into do-while with explicit "loop test" in the header block.
 814
 815     #define GTF_QMARK_CAST_INSTOF 0x80000000  // GT_QMARK   -- Is this a top (not nested) level qmark created for castclass or instanceof?
 816
 817     #define GTF_BOX_VALUE 0x80000000  // GT_BOX   -- "box" is on a value type
 818
 819     #define GTF_ICON_HDL_MASK   0xF0000000  // Bits used by handle types below
 820
 821     #define GTF_ICON_SCOPE_HDL  0x10000000  // GT_CNS_INT -- constant is a scope handle
 822     #define GTF_ICON_CLASS_HDL  0x20000000  // GT_CNS_INT -- constant is a class handle
 823     #define GTF_ICON_METHOD_HDL 0x30000000  // GT_CNS_INT -- constant is a method handle
 824     #define GTF_ICON_FIELD_HDL  0x40000000  // GT_CNS_INT -- constant is a field handle
 825     #define GTF_ICON_STATIC_HDL 0x50000000  // GT_CNS_INT -- constant is a handle to static data
 826     #define GTF_ICON_STR_HDL    0x60000000  // GT_CNS_INT -- constant is a string handle
 827     #define GTF_ICON_PSTR_HDL   0x70000000  // GT_CNS_INT -- constant is a ptr to a string handle
 828     #define GTF_ICON_PTR_HDL    0x80000000  // GT_CNS_INT -- constant is a ldptr handle
 829     #define GTF_ICON_VARG_HDL   0x90000000  // GT_CNS_INT -- constant is a var arg cookie handle
 830     #define GTF_ICON_PINVKI_HDL 0xA0000000  // GT_CNS_INT -- constant is a pinvoke calli handle
 831     #define GTF_ICON_TOKEN_HDL  0xB0000000  // GT_CNS_INT -- constant is a token handle
 832     #define GTF_ICON_TLS_HDL    0xC0000000  // GT_CNS_INT -- constant is a TLS ref with offset
 833     #define GTF_ICON_FTN_ADDR   0xD0000000  // GT_CNS_INT -- constant is a function address
 834     #define GTF_ICON_CIDMID_HDL 0xE0000000  // GT_CNS_INT -- constant is a class or module ID handle
 835     #define GTF_ICON_BBC_PTR    0xF0000000  // GT_CNS_INT -- constant is a basic block count pointer
 836
 837     #define GTF_ICON_FIELD_OFF  0x08000000  // GT_CNS_INT -- constant is a field offset
 838
 839     #define GTF_BLK_HASGCPTR    0x80000000  // GT_COPYBLK -- This struct copy will copy GC Pointers
 840     #define GTF_BLK_VOLATILE    0x40000000  // GT_INITBLK/GT_COPYBLK -- is a volatile block operation
 841     #define GTF_BLK_UNALIGNED   0x02000000  // GT_INITBLK/GT_COPYBLK -- is an unaligned block operation
 842
 843     #define GTF_OVERFLOW        0x10000000  // GT_ADD, GT_SUB, GT_MUL, - Need overflow check
 844                                             // GT_ASG_ADD, GT_ASG_SUB,
 845                                             // GT_CAST
 846                                             // Use gtOverflow(Ex)() to check this flag
 847
 848     #define GTF_NO_OP_NO        0x80000000  // GT_NO_OP   --Have the codegenerator generate a special nop
 849
 850     //----------------------------------------------------------------
 851
 852     #define GTF_STMT_CMPADD     0x80000000  // GT_STMT    -- added by compiler
 853     #define GTF_STMT_HAS_CSE    0x40000000  // GT_STMT    -- CSE def or use was subsituted
 854     #define GTF_STMT_TOP_LEVEL  0x20000000  // GT_STMT    -- Top-level statement - true iff gtStmtList->gtPrev == nullptr
 855                                             //               True for all stmts when in FGOrderTree
 856     #define GTF_STMT_SKIP_LOWER 0x10000000  // GT_STMT    -- Skip lowering if we already lowered an embedded stmt.
 857
 858     //----------------------------------------------------------------
 859
 860     GenTreePtr          gtNext;
 861     GenTreePtr          gtPrev;
 862
 863 #ifdef DEBUG
 864     unsigned            gtTreeID;
 865     unsigned            gtSeqNum;       // liveness traversal order within the current statement
 866 #endif
 867
 868     static
 869     const unsigned short   gtOperKindTable[];
 870
 871     static
 872     unsigned        OperKind(unsigned gtOper)
 873     {
 874         assert(gtOper < GT_COUNT);
 875
 876         return  gtOperKindTable[gtOper];
 877     }
 878
 879     unsigned        OperKind() const
 880     {
 881         assert(gtOper < GT_COUNT);
 882
 883         return  gtOperKindTable[gtOper];
 884     }
 885
 886     static bool     IsExOp(unsigned opKind)
 887     {
 888         return (opKind & GTK_EXOP) != 0;
 889     }
 890     // Returns the operKind with the GTK_EX_OP bit removed (the
 891     // kind of operator, unary or binary, that is extended).
 892     static unsigned StripExOp(unsigned opKind)
 893     {
 894         return opKind & ~GTK_EXOP;
 895     }
 896
 897     static
 898     bool            OperIsConst(genTreeOps gtOper)
 899     {
 900         return  (OperKind(gtOper) & GTK_CONST  ) != 0;
 901     }
 902
 903     bool            OperIsConst() const
 904     {
 905         return  (OperKind(gtOper) & GTK_CONST  ) != 0;
 906     }
 907
 908     static
 909     bool            OperIsLeaf(genTreeOps gtOper)
 910     {
 911         return  (OperKind(gtOper) & GTK_LEAF   ) != 0;
 912     }
 913
 914     bool            OperIsLeaf() const
 915     {
 916         return  (OperKind(gtOper) & GTK_LEAF   ) != 0;
 917     }
 918
 919     static
 920     bool            OperIsCompare(genTreeOps gtOper)
 921     {
 922         return  (OperKind(gtOper) & GTK_RELOP  ) != 0;
 923     }
 924
 925     static
 926     bool            OperIsLocal(genTreeOps gtOper)
 927     {
 928         bool result = (OperKind(gtOper) & GTK_LOCAL) != 0;
 929         assert(result ==
 930                (gtOper == GT_LCL_VAR ||
 931                 gtOper == GT_PHI_ARG ||
 932                 gtOper == GT_REG_VAR ||
 933                 gtOper == GT_LCL_FLD ||
 934                 gtOper == GT_STORE_LCL_VAR ||
 935                 gtOper == GT_STORE_LCL_FLD));
 936         return result;
 937     }
 938
 939     static
 940     bool            OperIsBlkOp(genTreeOps gtOper)
 941     {
 942         return (gtOper == GT_INITBLK ||
 943                 gtOper == GT_COPYBLK ||
 944                 gtOper == GT_COPYOBJ);
 945     }
 946
 947     static
 948     bool            OperIsCopyBlkOp(genTreeOps gtOper)
 949     {
 950         return (gtOper == GT_COPYOBJ || gtOper == GT_COPYBLK);
 951     }
 952
 953
 954     static
 955     bool            OperIsLocalAddr(genTreeOps gtOper)
 956     {
 957         return (gtOper == GT_LCL_VAR_ADDR ||
 958                 gtOper == GT_LCL_FLD_ADDR);
 959     }
 960
 961     static
 962     bool           OperIsScalarLocal(genTreeOps gtOper)
 963     {
 964         return (gtOper == GT_LCL_VAR ||
 965                 gtOper == GT_REG_VAR ||
 966                 gtOper == GT_STORE_LCL_VAR);
 967     }
 968
 969     static
 970     bool            OperIsNonPhiLocal(genTreeOps gtOper)
 971     {
 972         return OperIsLocal(gtOper) && (gtOper != GT_PHI_ARG);
 973     }
 974
 975     static
 976     bool            OperIsLocalRead(genTreeOps gtOper)
 977     {
 978         return (OperIsLocal(gtOper) && !OperIsLocalStore(gtOper));
 979     }
 980
 981     static
 982     bool            OperIsLocalStore(genTreeOps gtOper)
 983     {
 984         return (gtOper == GT_STORE_LCL_VAR ||
 985                 gtOper == GT_STORE_LCL_FLD);
 986
 987     }
 988
 989     static
 990     bool            OperIsAddrMode(genTreeOps gtOper)
 991     {
 992         return (gtOper == GT_LEA);
 993     }
 994
 995     bool            OperIsBlkOp() const
 996     {
 997         return OperIsBlkOp(OperGet());
 998     }
 999
1000     bool            OperIsCopyBlkOp() const
1001     {
1002         return OperIsCopyBlkOp(OperGet());
1003     }
1004
1005     bool            OperIsPutArgStk() const
1006     {
1007         return gtOper == GT_PUTARG_STK;
1008     }
1009
1010     bool            OperIsAddrMode() const
1011     {
1012         return OperIsAddrMode(OperGet());
1013     }
1014
1015     bool            OperIsLocal() const
1016     {
1017         return OperIsLocal(OperGet());
1018     }
1019
1020     bool            OperIsLocalAddr() const
1021     {
1022         return OperIsLocalAddr(OperGet());
1023     }
1024
1025     bool            OperIsScalarLocal() const
1026     {
1027         return OperIsScalarLocal(OperGet());
1028     }
1029
1030     bool            OperIsNonPhiLocal() const
1031     {
1032         return OperIsNonPhiLocal(OperGet());
1033     }
1034
1035     bool            OperIsLocalStore() const
1036     {
1037         return OperIsLocalStore(OperGet());
1038     }
1039
1040     bool            OperIsLocalRead() const
1041     {
1042         return OperIsLocalRead(OperGet());
1043     }
1044
1045     bool            OperIsCompare()
1046     {
1047         return  (OperKind(gtOper) & GTK_RELOP  ) != 0;
1048     }
1049
1050     static
1051     bool            OperIsLogical(genTreeOps gtOper)
1052     {
1053         return  (OperKind(gtOper) & GTK_LOGOP  ) != 0;
1054     }
1055
1056     bool            OperIsLogical() const
1057     {
1058         return  (OperKind(gtOper) & GTK_LOGOP  ) != 0;
1059     }
1060
1061     static
1062     bool            OperIsShift(genTreeOps gtOper)
1063     {
1064         return (gtOper == GT_LSH) ||
1065                (gtOper == GT_RSH) ||
1066                (gtOper == GT_RSZ);
1067     }
1068
1069     bool            OperIsShift() const
1070     {
1071         return OperIsShift(OperGet());
1072     }
1073
1074     static
1075     bool            OperIsRotate(genTreeOps gtOper)
1076     {
1077         return (gtOper == GT_ROL) ||
1078                (gtOper == GT_ROR);
1079     }
1080
1081     bool            OperIsRotate() const
1082     {
1083         return OperIsRotate(OperGet());
1084     }
1085
1086     static
1087     bool            OperIsShiftOrRotate(genTreeOps gtOper)
1088     {
1089         return OperIsShift(gtOper) ||
1090                OperIsRotate(gtOper);
1091     }
1092
1093     bool            OperIsShiftOrRotate() const
1094     {
1095         return OperIsShiftOrRotate(OperGet());
1096     }
1097
1098     bool            OperIsArithmetic() const
1099     {
1100         genTreeOps op = OperGet();
1101         return     op==GT_ADD
1102                 || op==GT_SUB
1103                 || op==GT_MUL
1104                 || op==GT_DIV
1105                 || op==GT_MOD
1106
1107                 || op==GT_UDIV
1108                 || op==GT_UMOD
1109
1110                 || op==GT_OR
1111                 || op==GT_XOR
1112                 || op==GT_AND
1113
1114                 || OperIsShiftOrRotate(op);
1115     }
1116
1117 #if !defined(LEGACY_BACKEND) && !defined(_TARGET_64BIT_)
1118     static
1119     bool            OperIsHigh(genTreeOps gtOper)
1120     {
1121         switch (gtOper)
1122         {
1123         case GT_ADD_HI:
1124         case GT_SUB_HI:
1125         case GT_MUL_HI:
1126         case GT_DIV_HI:
1127         case GT_MOD_HI:
1128             return true;
1129         default:
1130             return false;
1131         }
1132     }
1133
1134     bool            OperIsHigh() const
1135     {
1136         return OperIsHigh(OperGet());
1137     }
1138 #endif // !defined(LEGACY_BACKEND) && !defined(_TARGET_64BIT_)
1139
1140     static
1141     bool            OperIsUnary(genTreeOps gtOper)
1142     {
1143         return  (OperKind(gtOper) & GTK_UNOP   ) != 0;
1144     }
1145
1146     bool            OperIsUnary() const
1147     {
1148         return   OperIsUnary(gtOper);
1149     }
1150
1151     static
1152     bool            OperIsBinary(genTreeOps gtOper)
1153     {
1154         return  (OperKind(gtOper) & GTK_BINOP  ) != 0;
1155     }
1156
1157     bool            OperIsBinary() const
1158     {
1159         return   OperIsBinary(gtOper);
1160     }
1161
1162     static
1163     bool            OperIsSimple(genTreeOps gtOper)
1164     {
1165         return (OperKind(gtOper) & GTK_SMPOP  ) != 0;
1166     }
1167
1168     static
1169     bool            OperIsSpecial(genTreeOps gtOper)
1170     {
1171         return  ((OperKind(gtOper) & GTK_KINDMASK) == GTK_SPECIAL);
1172     }
1173
1174     bool            OperIsSimple() const
1175     {
1176         return  OperIsSimple(gtOper);
1177     }
1178
1179 #ifdef FEATURE_SIMD
1180     bool             isCommutativeSIMDIntrinsic();
1181 #else // !
1182     bool             isCommutativeSIMDIntrinsic()
1183     {
1184         return false;
1185     }
1186 #endif // FEATURE_SIMD
1187
1188     static
1189     bool            OperIsCommutative(genTreeOps gtOper)
1190     {
1191         return  (OperKind(gtOper) & GTK_COMMUTE) != 0;
1192     }
1193
1194     bool            OperIsCommutative()
1195     {
1196         return OperIsCommutative(gtOper) || (OperIsSIMD(gtOper) && isCommutativeSIMDIntrinsic());
1197     }
1198
1199     static
1200     bool            OperIsAssignment(genTreeOps gtOper)
1201     {
1202         return  (OperKind(gtOper) & GTK_ASGOP) != 0;
1203     }
1204
1205     bool            OperIsAssignment() const
1206     {
1207         return  OperIsAssignment(gtOper);
1208     }
1209
1210     static
1211     bool            OperIsIndir(genTreeOps gtOper)
1212     {
1213         return  gtOper == GT_IND || gtOper == GT_STOREIND || gtOper == GT_NULLCHECK;
1214     }
1215
1216     bool            OperIsIndir() const
1217     {
1218         return  OperIsIndir(gtOper);
1219     }
1220
1221     static
1222     bool            OperIsImplicitIndir(genTreeOps gtOper)
1223     {
1224         switch (gtOper)
1225         {
1226         case GT_LOCKADD:
1227         case GT_XADD:
1228         case GT_CMPXCHG:
1229         case GT_COPYBLK:
1230         case GT_COPYOBJ:
1231         case GT_INITBLK:
1232         case GT_OBJ:
1233         case GT_BOX:
1234         case GT_ARR_INDEX:
1235         case GT_ARR_ELEM:
1236         case GT_ARR_OFFSET:
1237             return true;
1238         default:
1239             return false;
1240         }
1241     }
1242
1243     bool            OperIsImplicitIndir() const
1244     {
1245         return  OperIsImplicitIndir(gtOper);
1246     }
1247
1248     bool            OperIsStore() const
1249     {
1250         return OperIsStore(gtOper);
1251     }
1252
1253     static
1254     bool            OperIsStore(genTreeOps gtOper)
1255     {
1256         return (gtOper == GT_STOREIND
1257                 || gtOper == GT_STORE_LCL_VAR
1258                 || gtOper == GT_STORE_LCL_FLD
1259                 || gtOper == GT_STORE_CLS_VAR);
1260     }
1261
1262     static
1263     bool            OperIsAtomicOp(genTreeOps gtOper)
1264     {
1265         return  (gtOper == GT_XADD
1266                  || gtOper == GT_XCHG
1267                  || gtOper == GT_LOCKADD
1268                  || gtOper == GT_CMPXCHG);
1269     }
1270
1271     bool            OperIsAtomicOp()
1272     {
1273         return  OperIsAtomicOp(gtOper);
1274     }
1275
1276     // This is basically here for cleaner FEATURE_SIMD #ifdefs.
1277     static
1278     bool            OperIsSIMD(genTreeOps gtOper)
1279     {
1280 #ifdef FEATURE_SIMD
1281         return gtOper == GT_SIMD;
1282 #else // !FEATURE_SIMD
1283         return false;
1284 #endif // !FEATURE_SIMD
1285     }
1286
1287     bool            OperIsSIMD()
1288     {
1289         return OperIsSIMD(gtOper);
1290     }
1291
1292     // Requires that "op" is an op= operator.  Returns
1293     // the corresponding "op".
1294     static
1295     genTreeOps      OpAsgToOper(genTreeOps op);
1296
1297 #ifdef DEBUG
1298     bool            NullOp1Legal() const
1299     {
1300         assert(OperIsSimple(gtOper));
1301         switch (gtOper)
1302         {
1303         case GT_PHI: case GT_LEA: case GT_RETFILT: case GT_NOP:
1304             return true;
1305         case GT_RETURN:
1306             return gtType == TYP_VOID;
1307         default:
1308             return false;
1309         }
1310     }
1311
1312     bool            NullOp2Legal() const
1313     {
1314         assert(OperIsSimple(gtOper));
1315         if (!OperIsBinary(gtOper))
1316         {
1317             return true;
1318         }
1319         switch (gtOper)
1320         {
1321         case GT_LIST:
1322         case GT_INTRINSIC:
1323         case GT_LEA:
1324         case GT_STOREIND:
1325         case GT_INITBLK:
1326         case GT_COPYBLK:
1327         case GT_COPYOBJ:
1328 #ifdef FEATURE_SIMD
1329         case GT_SIMD:
1330 #endif // !FEATURE_SIMD
1331             return true;
1332         default:
1333             return false;
1334         }
1335     }
1336
1337     static
1338     inline bool RequiresNonNullOp2(genTreeOps oper);
1339     bool IsListForMultiRegArg();
1340 #endif // DEBUG
1341
1342     inline bool IsFPZero();
1343     inline bool IsIntegralConst(ssize_t constVal);
1344
1345     inline bool IsBoxedValue();
1346
1347     bool IsList() const
1348     {
1349         return gtOper == GT_LIST;
1350     }
1351
1352     inline GenTreePtr MoveNext();
1353
1354     inline GenTreePtr Current();
1355
1356     inline GenTreePtr *pCurrent();
1357
1358     inline GenTreePtr gtGetOp1();
1359
1360     inline GenTreePtr gtGetOp2();
1361
1362     // Given a tree node, if this is a child of that node, return the pointer to the child node so that it
1363     // can be modified; otherwise, return null.
1364     GenTreePtr*       gtGetChildPointer(GenTreePtr parent);
1365
1366     // Get the parent of this node, and optionally capture the pointer to the child so that it can be modified.
1367     GenTreePtr        gtGetParent(GenTreePtr** parentChildPtrPtr);
1368
1369     inline GenTreePtr gtEffectiveVal(bool commaOnly = false);
1370
1371     // Return the child of this node if it is a GT_RELOAD or GT_COPY; otherwise simply return the node itself
1372     inline GenTree*   gtSkipReloadOrCopy();
1373
1374     // Returns true if it is a call node returning its value in more than one register
1375     inline bool     IsMultiRegCall() const;
1376
1377     // Returns true if it is a GT_COPY or GT_RELOAD node
1378     inline bool     IsCopyOrReload() const;
1379
1380     // Returns true if it is a GT_COPY or GT_RELOAD of a multi-reg call node
1381     inline bool     IsCopyOrReloadOfMultiRegCall() const;
1382
1383     bool            OperMayThrow();
1384
1385     unsigned        GetScaleIndexMul();
1386     unsigned        GetScaleIndexShf();
1387     unsigned        GetScaledIndex();
1388
1389     // Returns true if "addr" is a GT_ADD node, at least one of whose arguments is an integer
1390     // (<= 32 bit) constant.  If it returns true, it sets "*offset" to (one of the) constant value(s), and
1391     // "*addr" to the other argument.
1392     bool            IsAddWithI32Const(GenTreePtr* addr, int* offset);
1393
1394     // Insert 'node' after this node in execution order.
1395     void            InsertAfterSelf(GenTree* node, GenTreeStmt* stmt = nullptr);
1396
1397 public:
1398
1399 #if SMALL_TREE_NODES
1400     static
1401     unsigned char   s_gtNodeSizes[];
1402 #endif
1403
1404     static
1405     void            InitNodeSize();
1406
1407     size_t          GetNodeSize() const;
1408
1409     bool            IsNodeProperlySized() const;
1410
1411     void            CopyFrom(const GenTree* src, Compiler* comp);
1412
1413     static
1414     genTreeOps      ReverseRelop(genTreeOps relop);
1415
1416     static
1417     genTreeOps      SwapRelop(genTreeOps relop);
1418
1419     //---------------------------------------------------------------------
1420
1421     static
1422     bool            Compare(GenTreePtr op1, GenTreePtr op2, bool swapOK = false);
1423
1424     //---------------------------------------------------------------------
1425     #ifdef DEBUG
1426     //---------------------------------------------------------------------
1427
1428     static
1429     const   char *  NodeName(genTreeOps op);
1430
1431     static
1432     const   char *  OpName(genTreeOps op);
1433
1434     //---------------------------------------------------------------------
1435     #endif
1436     //---------------------------------------------------------------------
1437
1438     bool                        IsNothingNode       () const;
1439     void                        gtBashToNOP         ();
1440
1441     // Value number update action enumeration
1442     enum ValueNumberUpdate
1443     {
1444         CLEAR_VN,       // Clear value number
1445         PRESERVE_VN     // Preserve value number
1446     };
1447
1448     void                        SetOper(genTreeOps oper, ValueNumberUpdate vnUpdate = CLEAR_VN);  // set gtOper
1449     void                        SetOperResetFlags   (genTreeOps oper);  // set gtOper and reset flags
1450
1451     void                        ChangeOperConst     (genTreeOps oper);  // ChangeOper(constOper)
1452     // set gtOper and only keep GTF_COMMON_MASK flags
1453     void                        ChangeOper(genTreeOps oper, ValueNumberUpdate vnUpdate = CLEAR_VN);
1454     void                        ChangeOperUnchecked (genTreeOps oper);
1455
1456     bool IsLocal() const
1457     {
1458         return OperIsLocal(OperGet());
1459     }
1460
1461     // Returns "true" iff 'this' is a GT_LCL_FLD or GT_STORE_LCL_FLD on which the type
1462     // is not the same size as the type of the GT_LCL_VAR.
1463     bool IsPartialLclFld(Compiler* comp);
1464
1465     // Returns "true" iff "this" defines a local variable.  Requires "comp" to be the
1466     // current compilation.  If returns "true", sets "*pLclVarTree" to the
1467     // tree for the local that is defined, and, if "pIsEntire" is non-null, sets "*pIsEntire" to
1468     // true or false, depending on whether the assignment writes to the entirety of the local
1469     // variable, or just a portion of it.
1470     bool DefinesLocal(Compiler* comp, GenTreeLclVarCommon** pLclVarTree, bool* pIsEntire = nullptr);
1471
1472     // Returns true if "this" represents the address of a local, or a field of a local.  If returns true, sets
1473     // "*pLclVarTree" to the node indicating the local variable.  If the address is that of a field of this node,
1474     // sets "*pFldSeq" to the field sequence representing that field, else null.
1475     bool IsLocalAddrExpr(Compiler* comp, GenTreeLclVarCommon** pLclVarTree, FieldSeqNode** pFldSeq);
1476
1477     // Simpler variant of the above which just returns the local node if this is an expression that
1478     // yields an address into a local
1479     GenTreeLclVarCommon* IsLocalAddrExpr();
1480
1481     // Determine whether this is an assignment tree of the form X = X (op) Y,
1482     // where Y is an arbitrary tree, and X is a lclVar.
1483     unsigned             IsLclVarUpdateTree(GenTree** otherTree, genTreeOps *updateOper);
1484
1485     // If returns "true", "this" may represent the address of a static or instance field
1486     // (or a field of such a field, in the case of an object field of type struct).
1487     // If returns "true", then either "*pObj" is set to the object reference,
1488     // or "*pStatic" is set to the baseAddr or offset to be added to the "*pFldSeq"
1489     // Only one of "*pObj" or "*pStatic" will be set, the other one will be null.
1490     // The boolean return value only indicates that "this" *may* be a field address
1491     // -- the field sequence must also be checked.
1492     // If it is a field address, the field sequence will be a sequence of length >= 1,
1493     // starting with an instance or static field, and optionally continuing with struct fields.
1494     bool IsFieldAddr(Compiler* comp, GenTreePtr* pObj, GenTreePtr* pStatic, FieldSeqNode** pFldSeq);
1495
1496     // Requires "this" to be the address of an array (the child of a GT_IND labeled with GTF_IND_ARR_INDEX).
1497     // Sets "pArr" to the node representing the array (either an array object pointer, or perhaps a byref to the some element).
1498     // Sets "*pArrayType" to the class handle for the array type.
1499     // Sets "*inxVN" to the value number inferred for the array index.
1500     // Sets "*pFldSeq" to the sequence, if any, of struct fields used to index into the array element.
1501     void ParseArrayAddress(Compiler* comp,
1502                            struct ArrayInfo* arrayInfo,
1503                            GenTreePtr* pArr,
1504                            ValueNum* pInxVN,
1505                            FieldSeqNode** pFldSeq);
1506
1507     // Helper method for the above.
1508     void ParseArrayAddressWork(Compiler* comp, ssize_t inputMul, GenTreePtr* pArr, ValueNum* pInxVN, ssize_t* pOffset, FieldSeqNode** pFldSeq);
1509
1510     // Requires "this" to be a GT_IND.  Requires the outermost caller to set "*pFldSeq" to nullptr.
1511     // Returns true if it is an array index expression, or access to a (sequence of) struct field(s)
1512     // within a struct array element.  If it returns true, sets *arrayInfo to the array information, and sets *pFldSeq to the sequence
1513     // of struct field accesses.
1514     bool ParseArrayElemForm(Compiler* comp, ArrayInfo* arrayInfo, FieldSeqNode** pFldSeq);
1515
1516     // Requires "this" to be the address of a (possible) array element (or struct field within that).
1517     // If it is, sets "*arrayInfo" to the array access info, "*pFldSeq" to the sequence of struct fields
1518     // accessed within the array element, and returns true.  If not, returns "false".
1519     bool ParseArrayElemAddrForm(Compiler* comp, ArrayInfo* arrayInfo, FieldSeqNode** pFldSeq);
1520
1521     // Requires "this" to be an int expression.  If it is a sequence of one or more integer constants added together,
1522     // returns true and sets "*pFldSeq" to the sequence of fields with which those constants are annotated.
1523     bool ParseOffsetForm(Compiler* comp, FieldSeqNode** pFldSeq);
1524
1525     // Labels "*this" as an array index expression: label all constants and variables that could contribute, as part of an affine expression, to the value of the
1526     // of the index.
1527     void LabelIndex(Compiler* comp, bool isConst = true);
1528
1529     // Assumes that "this" occurs in a context where it is being dereferenced as the LHS of an assignment-like
1530     // statement (assignment, initblk, or copyblk).  The "width" should be the number of bytes copied by the
1531     // operation.  Returns "true" if "this" is an address of (or within)
1532     // a local variable; sets "*pLclVarTree" to that local variable instance; and, if "pIsEntire" is non-null,
1533     // sets "*pIsEntire" to true if this assignment writes the full width of the local.
1534     bool DefinesLocalAddr(Compiler* comp, unsigned width, GenTreeLclVarCommon** pLclVarTree, bool* pIsEntire);
1535
1536     bool                        IsRegVar            () const
1537     {
1538         return OperGet() == GT_REG_VAR?true:false;
1539     }
1540     bool                        InReg() const
1541     {
1542         return (gtFlags & GTF_REG_VAL)?true:false;
1543     }
1544     void                        SetInReg()
1545     {
1546         gtFlags |= GTF_REG_VAL;
1547     }
1548
1549     regNumber                   GetReg() const
1550     {
1551         return InReg() ? gtRegNum : REG_NA;
1552     }
1553     bool                        IsRegVarDeath       () const
1554     {
1555         assert(OperGet() == GT_REG_VAR);
1556         return (gtFlags & GTF_VAR_DEATH)?true:false;
1557     }
1558     bool                        IsRegVarBirth       () const
1559     {
1560         assert(OperGet() == GT_REG_VAR);
1561         return (gtFlags & GTF_REG_BIRTH)?true:false;
1562     }
1563     bool                        IsReverseOp() const
1564     {
1565         return (gtFlags & GTF_REVERSE_OPS)?true:false;
1566     }
1567
1568     inline bool                 IsCnsIntOrI         () const;
1569
1570     inline bool                 IsIntegralConst     () const;
1571
1572     inline bool                 IsIntCnsFitsInI32   ();
1573
1574     inline bool                 IsCnsFltOrDbl() const;
1575
1576     inline bool                 IsCnsNonZeroFltOrDbl();
1577
1578     bool                        IsIconHandle        () const
1579     {
1580         assert(gtOper == GT_CNS_INT);
1581         return (gtFlags & GTF_ICON_HDL_MASK) ? true : false;
1582     }
1583
1584     bool                        IsIconHandle        (unsigned handleType) const
1585     {
1586         assert(gtOper == GT_CNS_INT);
1587         assert((handleType & GTF_ICON_HDL_MASK) != 0);      // check that handleType is one of the valid GTF_ICON_* values
1588         assert((handleType & ~GTF_ICON_HDL_MASK) == 0);
1589         return (gtFlags & GTF_ICON_HDL_MASK) == handleType;
1590     }
1591
1592     // Return just the part of the flags corresponding to the GTF_ICON_*_HDL flag. For example,
1593     // GTF_ICON_SCOPE_HDL. The tree node must be a const int, but it might not be a handle, in which
1594     // case we'll return zero.
1595     unsigned                    GetIconHandleFlag   () const
1596     {
1597         assert(gtOper == GT_CNS_INT);
1598         return (gtFlags & GTF_ICON_HDL_MASK);
1599     }
1600
1601     // Mark this node as no longer being a handle; clear its GTF_ICON_*_HDL bits.
1602     void                        ClearIconHandleMask()
1603     {
1604         assert(gtOper == GT_CNS_INT);
1605         gtFlags &= ~GTF_ICON_HDL_MASK;
1606     }
1607
1608     // Return true if the two GT_CNS_INT trees have the same handle flag (GTF_ICON_*_HDL).
1609     static bool                 SameIconHandleFlag(GenTree* t1, GenTree* t2)
1610     {
1611         return t1->GetIconHandleFlag() == t2->GetIconHandleFlag();
1612     }
1613
1614     bool                        IsArgPlaceHolderNode() const { return OperGet() == GT_ARGPLACE; }
1615     bool                        IsCall              () const { return OperGet() == GT_CALL; }
1616     bool                        IsStatement         () const { return OperGet() == GT_STMT; }
1617     inline bool                 IsHelperCall        ();
1618
1619     bool                        IsVarAddr           () const;
1620     bool                        gtOverflow          () const;
1621     bool                        gtOverflowEx        () const;
1622     bool                        gtSetFlags          () const;
1623     bool                        gtRequestSetFlags   ();
1624 #ifdef DEBUG
1625     bool                        gtIsValid64RsltMul  ();
1626     static int                  gtDispFlags         (unsigned flags);
1627 #endif
1628
1629     // cast operations
1630     inline var_types            CastFromType();
1631     inline var_types&           CastToType();
1632
1633     // Returns "true" iff "*this" is an assignment (GT_ASG) tree that defines an SSA name (lcl = phi(...));
1634     bool IsPhiDefn();
1635
1636     // Returns "true" iff "*this" is a statement containing an assignment that defines an SSA name (lcl = phi(...));
1637     bool IsPhiDefnStmt();
1638
1639     // Can't use an assignment operator, because we need the extra "comp" argument
1640     // (to provide the allocator necessary for the VarSet assignment).
1641     // TODO-Cleanup: Not really needed now, w/o liveset on tree nodes
1642     void CopyTo(class Compiler* comp, const GenTree& gt);
1643
1644     // Like the above, excepts assumes copying from small node to small node.
1645     // (Following the code it replaces, it does *not* copy the GenTree fields,
1646     // which CopyTo does.)
1647     void CopyToSmall(const GenTree& gt);
1648
1649     // Because of the fact that we hid the assignment operator of "BitSet" (in DEBUG),
1650     // we can't synthesize an assignment operator.
1651     // TODO-Cleanup: Could change this w/o liveset on tree nodes
1652     // (This is also necessary for the VTable trick.)
1653     GenTree() {}
1654
1655     // Returns the number of children of the current node.
1656     unsigned NumChildren();
1657
1658     // Requires "childNum < NumChildren()".  Returns the "n"th child of "this."
1659     GenTreePtr GetChild(unsigned childNum);
1660
1661     // The maximum possible # of children of any node.
1662     static const int MAX_CHILDREN = 6;
1663
1664     bool IsReuseRegVal() const
1665     {
1666         // This can be extended to non-constant nodes, but not to local or indir nodes.
1667         if(OperIsConst() && ((gtFlags & GTF_REUSE_REG_VAL) != 0))
1668         {
1669             return true;
1670         }
1671         return false;
1672     }
1673     void SetReuseRegVal()
1674     {
1675         assert(OperIsConst());
1676         gtFlags |= GTF_REUSE_REG_VAL;
1677     }
1678     void ResetReuseRegVal()
1679     {
1680         assert(OperIsConst());
1681         gtFlags &= ~GTF_REUSE_REG_VAL;
1682     }
1683
1684 #ifdef DEBUG
1685   private:
1686     GenTree& operator=(const GenTree& gt) {
1687         assert(!"Don't copy");
1688         return *this;
1689     }
1690 #endif // DEBUG
1691
1692 #if DEBUGGABLE_GENTREE
1693     // In DEBUG builds, add a dummy virtual method, to give the debugger run-time type information.
1694     virtual void DummyVirt() {}
1695
1696     typedef void* VtablePtr;
1697
1698     VtablePtr GetVtableForOper(genTreeOps oper);
1699     void SetVtableForOper(genTreeOps oper);
1700
1701     static VtablePtr s_vtablesForOpers[GT_COUNT];
1702     static VtablePtr s_vtableForOp;
1703 #endif // DEBUGGABLE_GENTREE
1704
1705   public:
1706     inline void* operator new(size_t sz, class Compiler*, genTreeOps oper);
1707
1708     inline GenTree(genTreeOps oper, var_types type
1709                    DEBUGARG(bool largeNode = false));
1710 };
1711
1712
1713 /*****************************************************************************/
1714 // In the current design, we never instantiate GenTreeUnOp: it exists only to be
1715 // used as a base class.  For unary operators, we instantiate GenTreeOp, with a NULL second
1716 // argument.  We check that this is true dynamically.  We could tighten this and get static
1717 // checking, but that would entail accessing the first child of a unary operator via something
1718 // like gtUnOp.gtOp1 instead of gtOp.gtOp1.
1719 struct GenTreeUnOp: public GenTree
1720 {
1721     GenTreePtr      gtOp1;
1722
1723 protected:
1724     GenTreeUnOp(genTreeOps oper, var_types type
1725                 DEBUGARG(bool largeNode = false)) :
1726         GenTree(oper, type
1727                 DEBUGARG(largeNode)),
1728         gtOp1(nullptr)
1729         {}
1730
1731     GenTreeUnOp(genTreeOps oper, var_types type, GenTreePtr op1
1732                 DEBUGARG(bool largeNode = false)) :
1733         GenTree(oper, type
1734                 DEBUGARG(largeNode)),
1735         gtOp1(op1)
1736         {
1737             assert(op1 != nullptr || NullOp1Legal());
1738             if (op1 != nullptr)  // Propagate effects flags from child.
1739                 gtFlags |= op1->gtFlags & GTF_ALL_EFFECT;
1740         }
1741
1742 #if DEBUGGABLE_GENTREE
1743     GenTreeUnOp() : GenTree(), gtOp1(nullptr) {}
1744 #endif
1745 };
1746
1747 struct GenTreeOp: public GenTreeUnOp
1748 {
1749     GenTreePtr      gtOp2;
1750
1751     GenTreeOp(genTreeOps oper, var_types type, GenTreePtr op1, GenTreePtr op2
1752               DEBUGARG(bool largeNode = false)) :
1753         GenTreeUnOp(oper, type, op1
1754                     DEBUGARG(largeNode)),
1755         gtOp2(op2)
1756         {
1757             // comparisons are always integral types
1758             assert(!GenTree::OperIsCompare(oper) || varTypeIsIntegral(type));
1759             // Binary operators, with a few exceptions, require a non-nullptr
1760             // second argument.
1761             assert(op2 != nullptr || NullOp2Legal());
1762             // Unary operators, on the other hand, require a null second argument.
1763             assert(!OperIsUnary(oper) || op2 == nullptr);
1764             // Propagate effects flags from child.  (UnOp handled this for first child.)
1765             if (op2 != nullptr)
1766             {
1767                 gtFlags |= op2->gtFlags & GTF_ALL_EFFECT;
1768             }
1769         }
1770
1771     // A small set of types are unary operators with optional arguments.  We use
1772     // this constructor to build those.
1773     GenTreeOp(genTreeOps oper, var_types type
1774               DEBUGARG(bool largeNode = false)) :
1775         GenTreeUnOp(oper, type
1776                     DEBUGARG(largeNode)),
1777         gtOp2(nullptr)
1778         {
1779             // Unary operators with optional arguments:
1780             assert(oper == GT_NOP     ||
1781                    oper == GT_RETURN  ||
1782                    oper == GT_RETFILT ||
1783                    OperIsBlkOp(oper));
1784         }
1785
1786 #if DEBUGGABLE_GENTREE
1787     GenTreeOp() : GenTreeUnOp(), gtOp2(nullptr) {}
1788 #endif
1789 };
1790
1791
1792 struct GenTreeVal: public GenTree
1793 {
1794     size_t          gtVal1;
1795
1796     GenTreeVal(genTreeOps oper, var_types type, ssize_t val) :
1797         GenTree(oper, type),
1798         gtVal1(val)
1799         {}
1800 #if DEBUGGABLE_GENTREE
1801     GenTreeVal() : GenTree() {}
1802 #endif
1803 };
1804
1805 struct GenTreeIntConCommon: public GenTree
1806 {
1807     inline INT64   LngValue();
1808     inline void    SetLngValue(INT64 val);
1809     inline ssize_t IconValue();
1810     inline void SetIconValue(ssize_t val);
1811
1812     GenTreeIntConCommon(genTreeOps oper, var_types type
1813                         DEBUGARG(bool largeNode = false)) :
1814         GenTree(oper, type
1815                 DEBUGARG(largeNode))
1816         {}
1817
1818         bool FitsInI32()
1819         {
1820             return FitsInI32(IconValue());
1821         }
1822
1823         static bool FitsInI32(ssize_t val)
1824         {
1825 #ifdef _TARGET_64BIT_
1826             return (int)val == val;
1827 #else
1828             return true;
1829 #endif
1830         }
1831
1832         bool ImmedValNeedsReloc(Compiler* comp);
1833         bool GenTreeIntConCommon::ImmedValCanBeFolded(Compiler* comp, genTreeOps op);
1834
1835 #ifdef _TARGET_XARCH_
1836         bool FitsInAddrBase(Compiler* comp);
1837         bool AddrNeedsReloc(Compiler* comp);
1838 #endif
1839
1840 #if DEBUGGABLE_GENTREE
1841     GenTreeIntConCommon() : GenTree() {}
1842 #endif
1843 };
1844
1845 // node representing a read from a physical register
1846 struct GenTreePhysReg: public GenTree
1847 {
1848     // physregs need a field beyond gtRegNum because
1849     // gtRegNum indicates the destination (and can be changed)
1850     // whereas reg indicates the source
1851     regNumber gtSrcReg;
1852     GenTreePhysReg(regNumber r, var_types type=TYP_I_IMPL) :
1853         GenTree(GT_PHYSREG, type), gtSrcReg(r)
1854     {
1855     }
1856 #if DEBUGGABLE_GENTREE
1857     GenTreePhysReg() : GenTree() {}
1858 #endif
1859 };
1860
1861 #ifndef LEGACY_BACKEND
1862 // gtJumpTable - Switch Jump Table
1863 //
1864 // This node stores a DWORD constant that represents the
1865 // absolute address of a jump table for switches.  The code
1866 // generator uses this table to code the destination for every case
1867 // in an array of addresses which starting position is stored in
1868 // this constant.
1869 struct GenTreeJumpTable : public GenTreeIntConCommon
1870 {
1871     ssize_t        gtJumpTableAddr;
1872
1873     GenTreeJumpTable(var_types type
1874                   DEBUGARG(bool largeNode = false)) :
1875         GenTreeIntConCommon(GT_JMPTABLE, type
1876                             DEBUGARG(largeNode))
1877         {}
1878 #if DEBUGGABLE_GENTREE
1879     GenTreeJumpTable() : GenTreeIntConCommon() {}
1880 #endif // DEBUG
1881 };
1882 #endif // !LEGACY_BACKEND
1883
1884 /* gtIntCon -- integer constant (GT_CNS_INT) */
1885 struct GenTreeIntCon: public GenTreeIntConCommon
1886 {
1887     /*
1888      * This is the GT_CNS_INT struct definition.
1889      * It's used to hold for both int constants and pointer handle constants.
1890      * For the 64-bit targets we will only use GT_CNS_INT as it used to represent all the possible sizes
1891      * For the 32-bit targets we use a GT_CNS_LNG to hold a 64-bit integer constant and GT_CNS_INT for all others.
1892      * In the future when we retarget the JIT for x86 we should consider eliminating GT_CNS_LNG
1893      */
1894     ssize_t         gtIconVal;   // Must overlap and have the same offset with the gtIconVal field in GenTreeLngCon below.
1895
1896     /* The InitializeArray intrinsic needs to go back to the newarray statement
1897        to find the class handle of the array so that we can get its size.  However,
1898        in ngen mode, the handle in that statement does not correspond to the compile
1899        time handle (rather it lets you get a handle at run-time).  In that case, we also
1900        need to store a compile time handle, which goes in this gtCompileTimeHandle field.
1901     */
1902     ssize_t         gtCompileTimeHandle;
1903
1904     // TODO-Cleanup: It's not clear what characterizes the cases where the field
1905     // above is used.  It may be that its uses and those of the "gtFieldSeq" field below
1906     // are mutually exclusive, and they could be put in a union.  Or else we should separate
1907     // this type into three subtypes.
1908
1909     // If this constant represents the offset of one or more fields, "gtFieldSeq" represents that
1910     // sequence of fields.
1911     FieldSeqNode*   gtFieldSeq;
1912
1913 #if defined (LATE_DISASM)
1914
1915     /*  If the constant was morphed from some other node,
1916         these fields enable us to get back to what the node
1917         originally represented. See use of gtNewIconHandleNode()
1918      */
1919
1920     union
1921     {
1922         /* Template struct - The significant field of the other
1923          * structs should overlap exactly with this struct
1924          */
1925
1926         struct
1927         {
1928             unsigned        gtIconHdl1;
1929             void *          gtIconHdl2;
1930         }
1931                             gtIconHdl;
1932
1933         /* GT_FIELD, etc */
1934
1935         struct
1936         {
1937             unsigned                gtIconCPX;
1938             CORINFO_CLASS_HANDLE    gtIconCls;
1939         }
1940                                     gtIconFld;
1941     };
1942 #endif
1943
1944     GenTreeIntCon(var_types type, ssize_t value
1945                   DEBUGARG(bool largeNode = false)) :
1946         GenTreeIntConCommon(GT_CNS_INT, type
1947                             DEBUGARG(largeNode)),
1948         gtIconVal(value),
1949         gtCompileTimeHandle(0),
1950         gtFieldSeq(FieldSeqStore::NotAField())
1951         {}
1952
1953     GenTreeIntCon(var_types type, ssize_t value, FieldSeqNode* fields
1954                   DEBUGARG(bool largeNode = false)) :
1955         GenTreeIntConCommon(GT_CNS_INT, type
1956                             DEBUGARG(largeNode)),
1957         gtIconVal(value),
1958         gtCompileTimeHandle(0),
1959         gtFieldSeq(fields)
1960         {
1961             assert(fields != NULL);
1962         }
1963
1964 #ifdef _TARGET_64BIT_
1965     void TruncateOrSignExtend32()
1966     {
1967         if (gtFlags & GTF_UNSIGNED)
1968         {
1969             gtIconVal = UINT32(gtIconVal);
1970         }
1971         else
1972         {
1973             gtIconVal = INT32(gtIconVal);
1974         }
1975     }
1976 #endif // _TARGET_64BIT_
1977
1978 #if DEBUGGABLE_GENTREE
1979     GenTreeIntCon() : GenTreeIntConCommon() {}
1980 #endif
1981 };
1982
1983
1984 /* gtLngCon -- long    constant (GT_CNS_LNG) */
1985
1986 struct GenTreeLngCon: public GenTreeIntConCommon
1987 {
1988     INT64 gtLconVal;   // Must overlap and have the same offset with the gtIconVal field in GenTreeIntCon above.
1989     INT32 LoVal()
1990     {
1991         return (INT32)(gtLconVal & 0xffffffff);
1992     }
1993
1994     INT32 HiVal()
1995     {
1996         return (INT32)(gtLconVal >> 32);;
1997     }
1998
1999     GenTreeLngCon(INT64 val) :
2000         GenTreeIntConCommon(GT_CNS_NATIVELONG, TYP_LONG)
2001         { SetLngValue(val); }
2002 #if DEBUGGABLE_GENTREE
2003     GenTreeLngCon() : GenTreeIntConCommon() {}
2004 #endif
2005 };
2006
2007
2008 inline INT64 GenTreeIntConCommon::LngValue()
2009 {
2010 #ifndef _TARGET_64BIT_
2011     assert(gtOper == GT_CNS_LNG);
2012     return AsLngCon()->gtLconVal;
2013 #else
2014     return IconValue();
2015 #endif
2016 }
2017
2018 inline void GenTreeIntConCommon::SetLngValue(INT64 val)
2019 {
2020 #ifndef _TARGET_64BIT_
2021     assert(gtOper == GT_CNS_LNG);
2022     AsLngCon()->gtLconVal = val;
2023 #else
2024     // Compile time asserts that these two fields overlap and have the same offsets:  gtIconVal and gtLconVal
2025     C_ASSERT(offsetof(GenTreeLngCon, gtLconVal) == offsetof(GenTreeIntCon, gtIconVal));
2026     C_ASSERT(sizeof(AsLngCon()->gtLconVal) == sizeof(AsIntCon()->gtIconVal));
2027
2028     SetIconValue(ssize_t(val));
2029 #endif
2030 }
2031
2032 inline ssize_t GenTreeIntConCommon::IconValue()
2033 {
2034     assert(gtOper == GT_CNS_INT);   //  We should never see a GT_CNS_LNG for a 64-bit target!
2035     return AsIntCon()->gtIconVal;
2036 }
2037
2038 inline void GenTreeIntConCommon::SetIconValue(ssize_t val)
2039 {
2040     assert(gtOper == GT_CNS_INT);   //  We should never see a GT_CNS_LNG for a 64-bit target!
2041     AsIntCon()->gtIconVal = val;
2042 }
2043
2044 /* gtDblCon -- double  constant (GT_CNS_DBL) */
2045
2046 struct GenTreeDblCon: public GenTree
2047 {
2048     double          gtDconVal;
2049
2050     bool            isBitwiseEqual(GenTreeDblCon* other)
2051     {
2052         unsigned __int64 bits = *(unsigned __int64 *)(&gtDconVal);
2053         unsigned __int64 otherBits = *(unsigned __int64 *)(&(other->gtDconVal));
2054         return (bits == otherBits);
2055     }
2056
2057     GenTreeDblCon(double val) :
2058         GenTree(GT_CNS_DBL, TYP_DOUBLE),
2059         gtDconVal(val)
2060         {}
2061 #if DEBUGGABLE_GENTREE
2062     GenTreeDblCon() : GenTree() {}
2063 #endif
2064 };
2065
2066
2067 /* gtStrCon -- string  constant (GT_CNS_STR) */
2068
2069 struct GenTreeStrCon: public GenTree
2070 {
2071     unsigned              gtSconCPX;
2072     CORINFO_MODULE_HANDLE gtScpHnd;
2073
2074     // Because this node can come from an inlined method we need to
2075     // have the scope handle, since it will become a helper call.
2076     GenTreeStrCon(unsigned sconCPX, CORINFO_MODULE_HANDLE mod
2077                   DEBUGARG(bool largeNode = false)) :
2078         GenTree(GT_CNS_STR, TYP_REF
2079                 DEBUGARG(largeNode)),
2080         gtSconCPX(sconCPX), gtScpHnd(mod)
2081         {}
2082 #if DEBUGGABLE_GENTREE
2083     GenTreeStrCon() : GenTree() {}
2084 #endif
2085 };
2086
2087 // Common supertype of LCL_VAR, LCL_FLD, REG_VAR, PHI_ARG
2088 // This inherits from UnOp because lclvar stores are Unops
2089 struct GenTreeLclVarCommon: public GenTreeUnOp
2090 {
2091 private:
2092     unsigned        _gtLclNum;      // The local number. An index into the Compiler::lvaTable array.
2093     unsigned        _gtSsaNum;      // The SSA number.
2094
2095 public:
2096     GenTreeLclVarCommon(genTreeOps oper, var_types type, unsigned lclNum
2097                         DEBUGARG(bool largeNode = false)) :
2098         GenTreeUnOp(oper, type
2099                 DEBUGARG(largeNode))
2100     {
2101         SetLclNum(lclNum);
2102     }
2103
2104     unsigned GetLclNum() const
2105     {
2106         return _gtLclNum;
2107     }
2108     __declspec(property(get=GetLclNum))  unsigned  gtLclNum;
2109
2110     void SetLclNum(unsigned lclNum)
2111     {
2112         _gtLclNum = lclNum;
2113         _gtSsaNum = SsaConfig::RESERVED_SSA_NUM;
2114     }
2115
2116     unsigned GetSsaNum() const
2117     {
2118         return _gtSsaNum;
2119     }
2120     __declspec(property(get=GetSsaNum))  unsigned  gtSsaNum;
2121
2122     void SetSsaNum(unsigned ssaNum)
2123     {
2124         _gtSsaNum = ssaNum;
2125     }
2126
2127     bool HasSsaName()
2128     {
2129         return (gtSsaNum != SsaConfig::RESERVED_SSA_NUM);
2130     }
2131
2132 #if DEBUGGABLE_GENTREE
2133     GenTreeLclVarCommon() : GenTreeUnOp() {}
2134 #endif
2135 };
2136
2137 // gtLclVar -- load/store/addr of local variable
2138
2139 struct GenTreeLclVar: public GenTreeLclVarCommon
2140 {
2141     IL_OFFSET       gtLclILoffs;    // instr offset of ref (only for debug info)
2142
2143     GenTreeLclVar(var_types type, unsigned lclNum, IL_OFFSET ilOffs
2144                   DEBUGARG(bool largeNode = false)) :
2145         GenTreeLclVarCommon(GT_LCL_VAR, type, lclNum
2146                             DEBUGARG(largeNode)),
2147             gtLclILoffs(ilOffs)
2148             {}
2149
2150     GenTreeLclVar(genTreeOps oper, var_types type, unsigned lclNum, IL_OFFSET ilOffs
2151               DEBUGARG(bool largeNode = false)) :
2152         GenTreeLclVarCommon(oper, type, lclNum
2153                             DEBUGARG(largeNode)),
2154             gtLclILoffs(ilOffs)
2155             {
2156                 assert(OperIsLocal(oper) || OperIsLocalAddr(oper));
2157             }
2158
2159 #if DEBUGGABLE_GENTREE
2160     GenTreeLclVar() : GenTreeLclVarCommon() {}
2161 #endif
2162 };
2163
2164 // gtLclFld -- load/store/addr of local variable field
2165
2166 struct GenTreeLclFld: public GenTreeLclVarCommon
2167 {
2168     unsigned        gtLclOffs;      // offset into the variable to access
2169
2170     FieldSeqNode*   gtFieldSeq;     // This LclFld node represents some sequences of accesses.
2171
2172     // old/FE style constructor where load/store/addr share same opcode
2173     GenTreeLclFld(var_types type, unsigned lclNum, unsigned lclOffs) :
2174         GenTreeLclVarCommon(GT_LCL_FLD, type, lclNum),
2175         gtLclOffs(lclOffs), gtFieldSeq(NULL)
2176         {
2177             assert(sizeof(*this) <= s_gtNodeSizes[GT_LCL_FLD]);
2178         }
2179
2180
2181     GenTreeLclFld(genTreeOps oper, var_types type, unsigned lclNum, unsigned lclOffs) :
2182         GenTreeLclVarCommon(oper, type, lclNum),
2183         gtLclOffs(lclOffs), gtFieldSeq(NULL)
2184         {
2185             assert(sizeof(*this) <= s_gtNodeSizes[GT_LCL_FLD]);
2186         }
2187 #if DEBUGGABLE_GENTREE
2188     GenTreeLclFld() : GenTreeLclVarCommon() {}
2189 #endif
2190 };
2191
2192 struct GenTreeRegVar: public GenTreeLclVarCommon
2193 {
2194     // TODO-Cleanup: Note that the base class GenTree already has a gtRegNum field.
2195     // It's not clear exactly why a GT_REG_VAR has a separate field. When
2196     // GT_REG_VAR is created, the two are identical. It appears that they may
2197     // or may not remain so. In particular, there is a comment in stackfp.cpp
2198     // that states:
2199     //
2200     //      There used to be an assertion: assert(src->gtRegNum == src->gtRegVar.gtRegNum, ...)
2201     //      here, but there's actually no reason to assume that.  AFAICT, for FP vars under stack FP,
2202     //      src->gtRegVar.gtRegNum is the allocated stack pseudo-register, but src->gtRegNum is the
2203     //      FP stack position into which that is loaded to represent a particular use of the variable.
2204     //
2205     // It might be the case that only for stackfp do they ever differ.
2206     //
2207     // The following might be possible: the GT_REG_VAR node has a last use prior to a complex
2208     // subtree being evaluated. It could then be spilled from the register. Later,
2209     // it could be unspilled into a different register, which would be recorded at
2210     // the unspill time in the GenTree::gtRegNum, whereas GenTreeRegVar::gtRegNum
2211     // is left alone. It's not clear why that is useful.
2212     //
2213     // Assuming there is a particular use, like stack fp, that requires it, maybe we
2214     // can get rid of GT_REG_VAR and just leave it as GT_LCL_VAR, using the base class gtRegNum field.
2215     // If we need it for stackfp, we could add a GenTreeStackFPRegVar type, which carries both the
2216     // pieces of information, in a clearer and more specific way (in particular, with
2217     // a different member name).
2218     //
2219
2220 private:
2221
2222     regNumberSmall  _gtRegNum;
2223
2224 public:
2225
2226     GenTreeRegVar(var_types type, unsigned lclNum, regNumber regNum) :
2227         GenTreeLclVarCommon(GT_REG_VAR, type, lclNum
2228                             )
2229         {
2230             gtRegNum = regNum;
2231         }
2232
2233     // The register number is stored in a small format (8 bits), but the getters return and the setters take
2234     // a full-size (unsigned) format, to localize the casts here.
2235
2236     __declspec(property(get=GetRegNum,put=SetRegNum))
2237     regNumber           gtRegNum;
2238
2239     regNumber GetRegNum() const
2240     {
2241         return (regNumber) _gtRegNum;
2242     }
2243
2244     void SetRegNum(regNumber reg)
2245     {
2246         _gtRegNum = (regNumberSmall) reg;
2247         assert(_gtRegNum == reg);
2248     }
2249
2250 #if DEBUGGABLE_GENTREE
2251     GenTreeRegVar() : GenTreeLclVarCommon() {}
2252 #endif
2253 };
2254
2255 /* gtCast -- conversion to a different type  (GT_CAST) */
2256
2257 struct GenTreeCast: public GenTreeOp
2258 {
2259     GenTreePtr&     CastOp() { return gtOp1; }
2260     var_types       gtCastType;
2261
2262     GenTreeCast(var_types type, GenTreePtr op, var_types castType
2263                 DEBUGARG(bool largeNode = false)) :
2264         GenTreeOp(GT_CAST, type, op, nullptr
2265                     DEBUGARG(largeNode)),
2266         gtCastType(castType)
2267         {}
2268 #if DEBUGGABLE_GENTREE
2269     GenTreeCast() : GenTreeOp() {}
2270 #endif
2271 };
2272
2273
2274 // GT_BOX nodes are place markers for boxed values.  The "real" tree
2275 // for most purposes is in gtBoxOp.
2276 struct GenTreeBox: public GenTreeUnOp
2277 {
2278     // An expanded helper call to implement the "box" if we don't get
2279     // rid of it any other way.  Must be in same position as op1.
2280
2281     GenTreePtr&      BoxOp() { return gtOp1; }
2282     // This is the statement that contains the assignment tree when the node is an inlined GT_BOX on a value
2283     // type
2284     GenTreePtr       gtAsgStmtWhenInlinedBoxValue;
2285
2286     GenTreeBox(var_types type, GenTreePtr boxOp, GenTreePtr asgStmtWhenInlinedBoxValue) :
2287         GenTreeUnOp(GT_BOX, type, boxOp),
2288         gtAsgStmtWhenInlinedBoxValue(asgStmtWhenInlinedBoxValue)
2289         {}
2290 #if DEBUGGABLE_GENTREE
2291     GenTreeBox() : GenTreeUnOp() {}
2292 #endif
2293 };
2294
2295
2296
2297 /* gtField  -- data member ref  (GT_FIELD) */
2298
2299 struct GenTreeField: public GenTree
2300 {
2301     GenTreePtr      gtFldObj;
2302     CORINFO_FIELD_HANDLE    gtFldHnd;
2303     DWORD           gtFldOffset;
2304     bool            gtFldMayOverlap;
2305 #ifdef FEATURE_READYTORUN_COMPILER
2306     CORINFO_CONST_LOOKUP gtFieldLookup;
2307 #endif
2308
2309     GenTreeField(var_types type) :
2310         GenTree(GT_FIELD, type
2311                 )
2312     {
2313         gtFldMayOverlap = false;
2314     }
2315 #if DEBUGGABLE_GENTREE
2316     GenTreeField() : GenTree() {}
2317 #endif
2318 };
2319
2320 // Represents the Argument list of a call node, as a Lisp-style linked list.
2321 // (Originally I had hoped that this could have *only* the m_arg/m_rest fields, but it turns out
2322 // that enough of the GenTree mechanism is used that it makes sense just to make it a subtype.  But
2323 // note that in many ways, this is *not* a "real" node of the tree, but rather a mechanism for
2324 // giving call nodes a flexible number of children.  GenTreeArgListNodes never evaluate to registers,
2325 // for example.)
2326
2327 // Note that while this extends GenTreeOp, it is *not* an EXOP.  We don't add any new fields, and one
2328 // is free to allocate a GenTreeOp of type GT_LIST.  If you use this type, you get the convenient Current/Rest
2329 // method names for the arguments.
2330 struct GenTreeArgList: public GenTreeOp
2331 {
2332     GenTreePtr&      Current() { return gtOp1; }
2333     GenTreeArgList*& Rest()    { assert(gtOp2 == NULL || gtOp2->OperGet() == GT_LIST); return *reinterpret_cast<GenTreeArgList**>(&gtOp2); }
2334
2335 #if DEBUGGABLE_GENTREE
2336     GenTreeArgList() : GenTreeOp() {}
2337 #endif
2338
2339     GenTreeArgList(GenTreePtr arg) :
2340         GenTreeArgList(arg, nullptr) {}
2341
2342     GenTreeArgList(GenTreePtr arg, GenTreeArgList* rest) :
2343         GenTreeOp(GT_LIST, TYP_VOID, arg, rest)
2344     {
2345         // With structs passed in multiple args we could have an arg
2346         // GT_LIST containing a list of LCL_FLDs, see IsListForMultiRegArg()
2347         //
2348         assert((arg != nullptr) && ((!arg->IsList()) || (arg->IsListForMultiRegArg())));
2349         gtFlags |=  arg->gtFlags & GTF_ALL_EFFECT;
2350         if (rest != NULL)
2351         {
2352             gtFlags |= rest->gtFlags & GTF_ALL_EFFECT;
2353         }
2354     }
2355 };
2356
2357 // There was quite a bit of confusion in the code base about which of gtOp1 and gtOp2 was the
2358 // 'then' and 'else' clause of a colon node.  Adding these accessors, while not enforcing anything,
2359 // at least *allows* the programmer to be obviously correct.
2360 // However, these conventions seem backward.
2361 // TODO-Cleanup: If we could get these accessors used everywhere, then we could switch them.
2362 struct GenTreeColon: public GenTreeOp
2363 {
2364     GenTreePtr&      ThenNode() { return gtOp2; }
2365     GenTreePtr&      ElseNode() { return gtOp1; }
2366
2367 #if DEBUGGABLE_GENTREE
2368     GenTreeColon() : GenTreeOp() {}
2369 #endif
2370
2371     GenTreeColon(var_types typ, GenTreePtr thenNode, GenTreePtr elseNode) :
2372         GenTreeOp(GT_COLON, typ, elseNode, thenNode)
2373         {}
2374 };
2375
2376 // gtCall   -- method call      (GT_CALL)
2377 typedef class fgArgInfo *  fgArgInfoPtr;
2378 enum class InlineObservation;
2379
2380 // Return type descriptor of a GT_CALL node.
2381 // x64 Unix, Arm64, Arm32 and x86 allow a value to be returned in multiple
2382 // registers. For such calls this struct provides the following info
2383 // on their return type
2384 //    - type of value returned in each return register
2385 //    - ABI return register numbers in which the value is returned
2386 //    - count of return registers in which the value is returned
2387 //
2388 // TODO-ARM: Update this to meet the needs of Arm64 and Arm32
2389 //
2390 // TODO-AllArch: Right now it is used for describing multi-reg returned types.
2391 // Eventually we would want to use it for describing even single-reg
2392 // returned types (e.g. structs returned in single register x64/arm).
2393 // This would allow us not to lie or normalize single struct return
2394 // values in importer/morph.
2395 struct ReturnTypeDesc
2396 {
2397 private:
2398     var_types m_regType0;
2399     var_types m_regType1;
2400
2401 #ifdef DEBUG
2402     bool m_inited;
2403 #endif
2404
2405 public:
2406     ReturnTypeDesc()
2407     {
2408         Reset();
2409     }
2410
2411     // Initialize type descriptor given its type handle
2412     void Initialize(Compiler* comp, CORINFO_CLASS_HANDLE retClsHnd);
2413
2414     // Reset type descriptor to defaults
2415     void Reset()
2416     {
2417         m_regType0 = TYP_UNKNOWN;
2418         m_regType1 = TYP_UNKNOWN;
2419
2420 #ifdef DEBUG
2421         m_inited = false;
2422 #endif
2423     }
2424
2425     //--------------------------------------------------------------------------------------------
2426     // GetReturnRegCount:  Get the count of return registers in which the return value is returned.
2427     //
2428     // Arguments:
2429     //    None
2430     //
2431     // Return Value:
2432     //   Count of return registers.
2433     //   Returns 0 if the return type is not returned in registers.
2434     unsigned GetReturnRegCount() const
2435     {
2436         assert(m_inited);
2437
2438         int regCount = 0;
2439         if (m_regType0 != TYP_UNKNOWN)
2440         {
2441             ++regCount;
2442
2443             if (m_regType1 != TYP_UNKNOWN)
2444             {
2445                 ++regCount;
2446             }
2447         }
2448         else
2449         {
2450             // If regType0 is TYP_UNKNOWN then regType1 must also be TYP_UNKNOWN.
2451             assert(m_regType1 == TYP_UNKNOWN);
2452         }
2453         return regCount;
2454     }
2455
2456     //-----------------------------------------------------------------------
2457     // IsMultiRegRetType: check whether the type is returned in multiple
2458     // return registers.
2459     //
2460     // Arguments:
2461     //    None
2462     //
2463     // Return Value:
2464     //    Returns true if the type is returned in multiple return registers.
2465     //    False otherwise.
2466     bool IsMultiRegRetType() const
2467     {
2468         return GetReturnRegCount() > 1;
2469     }
2470
2471     //--------------------------------------------------------------------------
2472     // GetReturnRegType:  Get var_type of the return register specified by index.
2473     //
2474     // Arguments:
2475     //    index - Index of the return register.
2476     //            First return register will have an index 0 and so on.
2477     //
2478     // Return Value:
2479     //    var_type of the return register specified by its index.
2480     //    Return TYP_UNKNOWN if index > number of return registers.
2481     var_types GetReturnRegType(unsigned index)
2482     {
2483         assert(index < GetReturnRegCount());
2484
2485         if (index == 0)
2486         {
2487             return m_regType0;
2488         }
2489         else if (index == 1)
2490         {
2491             return m_regType1;
2492         }
2493
2494         return TYP_UNKNOWN;
2495     }
2496
2497     // Get ith ABI return register
2498     regNumber GetABIReturnReg(unsigned idx);
2499
2500     // Get reg mask of ABI return registers
2501     regMaskTP GetABIReturnRegs();
2502 };
2503
2504 struct GenTreeCall final : public GenTree
2505 {
2506     GenTreePtr        gtCallObjp;             // The instance argument ('this' pointer)
2507     GenTreeArgList*   gtCallArgs;             // The list of arguments in original evaluation order
2508     GenTreeArgList*   gtCallLateArgs;         // On x86:     The register arguments in an optimal order
2509                                               // On ARM/x64: - also includes any outgoing arg space arguments
2510                                               //             - that were evaluated into a temp LclVar
2511     fgArgInfoPtr      fgArgInfo;
2512
2513 #if !FEATURE_FIXED_OUT_ARGS
2514     int               regArgListCount;
2515     regList           regArgList;
2516 #endif
2517
2518     // TODO-Throughput: Revisit this (this used to be only defined if
2519     // FEATURE_FIXED_OUT_ARGS was enabled, so this makes GenTreeCall 4 bytes bigger on x86).
2520     CORINFO_SIG_INFO* callSig;                // Used by tail calls and to register callsites with the EE
2521
2522 #ifdef LEGACY_BACKEND
2523     regMaskTP         gtCallRegUsedMask;      // mask of registers used to pass parameters
2524 #endif // LEGACY_BACKEND
2525
2526     // State required to support multi-reg returning call nodes.
2527     // For now it is enabled only for x64 unix.
2528     //
2529     // TODO-AllArch: enable for all call nodes to unify single-reg and multi-reg returns.
2530 #if FEATURE_MULTIREG_RET
2531     ReturnTypeDesc    gtReturnTypeDesc;
2532
2533     // gtRegNum would always be the first return reg.
2534     // The following array holds the other reg numbers of multi-reg return.
2535     regNumber         gtOtherRegs[MAX_RET_REG_COUNT - 1];
2536
2537     // GTF_SPILL or GTF_SPILLED flag on a multi-reg call node indicates that one or
2538     // more of its result regs are in that state.  The spill flag of each of the
2539     // return register is stored in the below array.
2540     unsigned          gtSpillFlags[MAX_RET_REG_COUNT];
2541 #endif
2542
2543     //-----------------------------------------------------------------------
2544     // GetReturnTypeDesc: get the type descriptor of return value of the call
2545     //
2546     // Arguments:
2547     //    None
2548     //
2549     // Returns
2550     //    Type descriptor of the value returned by call
2551     //
2552     // Note:
2553     //    Right now implemented only for x64 unix and yet to be
2554     //    implemented for other multi-reg target arch (Arm64/Arm32/x86).
2555     //
2556     // TODO-AllArch: enable for all call nodes to unify single-reg and multi-reg returns.
2557     ReturnTypeDesc*   GetReturnTypeDesc()
2558     {
2559 #if FEATURE_MULTIREG_RET
2560         return &gtReturnTypeDesc;
2561 #else
2562         return nullptr;
2563 #endif
2564     }
2565
2566     //---------------------------------------------------------------------------
2567     // GetRegNumByIdx: get ith return register allocated to this call node.
2568     //
2569     // Arguments:
2570     //     idx   -   index of the return register
2571     //
2572     // Return Value:
2573     //     Return regNumber of ith return register of call node.
2574     //     Returns REG_NA if there is no valid return register for the given index.
2575     //
2576     regNumber  GetRegNumByIdx(unsigned idx) const
2577     {
2578         assert(idx < MAX_RET_REG_COUNT);
2579
2580         if (idx == 0)
2581         {
2582             return gtRegNum;
2583         }
2584
2585 #if FEATURE_MULTIREG_RET
2586         return gtOtherRegs[idx-1];
2587 #else
2588         return REG_NA;
2589 #endif
2590     }
2591
2592     //----------------------------------------------------------------------
2593     // SetRegNumByIdx: set ith return register of this call node
2594     //
2595     // Arguments:
2596     //    reg    -   reg number
2597     //    idx    -   index of the return register
2598     //
2599     // Return Value:
2600     //    None
2601     //
2602     void  SetRegNumByIdx(regNumber reg, unsigned idx)
2603     {
2604         assert(idx < MAX_RET_REG_COUNT);
2605
2606         if (idx == 0)
2607         {
2608             gtRegNum = reg;
2609         }
2610 #if FEATURE_MULTIREG_RET
2611         else
2612         {
2613             gtOtherRegs[idx - 1] = reg;
2614             assert(gtOtherRegs[idx - 1] == reg);
2615         }
2616 #else
2617         unreached();
2618 #endif
2619     }
2620
2621     //----------------------------------------------------------------------------
2622     // ClearOtherRegs: clear multi-reg state to indicate no regs are allocated
2623     //
2624     // Arguments:
2625     //    None
2626     //
2627     // Return Value:
2628     //    None
2629     //
2630     void  ClearOtherRegs()
2631     {
2632 #if FEATURE_MULTIREG_RET
2633         for (unsigned i = 0; i < MAX_RET_REG_COUNT - 1; ++i)
2634         {
2635             gtOtherRegs[i] = REG_NA;
2636         }
2637 #endif
2638     }
2639
2640     //----------------------------------------------------------------------------
2641     // CopyOtherRegs: copy multi-reg state from the given call node to this node
2642     //
2643     // Arguments:
2644     //    fromCall  -  GenTreeCall node from which to copy multi-reg state
2645     //
2646     // Return Value:
2647     //    None
2648     //
2649     void CopyOtherRegs(GenTreeCall* fromCall)
2650     {
2651 #if FEATURE_MULTIREG_RET
2652         for (unsigned i = 0; i < MAX_RET_REG_COUNT - 1; ++i)
2653         {
2654             this->gtOtherRegs[i] = fromCall->gtOtherRegs[i];
2655         }
2656 #endif
2657     }
2658
2659     // Get reg mask of all the valid registers of gtOtherRegs array
2660     regMaskTP  GetOtherRegMask() const;
2661
2662     //----------------------------------------------------------------------
2663     // GetRegSpillFlagByIdx: get spill flag associated with the return register
2664     // specified by its index.
2665     //
2666     // Arguments:
2667     //    idx  -  Position or index of the return register
2668     //
2669     // Return Value:
2670     //    Returns GTF_* flags associated with.
2671     unsigned GetRegSpillFlagByIdx(unsigned idx) const
2672     {
2673         assert(idx < MAX_RET_REG_COUNT);
2674
2675 #if FEATURE_MULTIREG_RET
2676         return gtSpillFlags[idx];
2677 #else
2678         assert(!"unreached");
2679         return 0;
2680 #endif
2681     }
2682
2683     //----------------------------------------------------------------------
2684     // SetRegSpillFlagByIdx: set spill flags for the return register
2685     // specified by its index.
2686     //
2687     // Arguments:
2688     //    flags  -  GTF_* flags
2689     //    idx    -  Position or index of the return register
2690     //
2691     // Return Value:
2692     //    None
2693     void SetRegSpillFlagByIdx(unsigned flags, unsigned idx)
2694     {
2695         assert(idx < MAX_RET_REG_COUNT);
2696
2697 #if FEATURE_MULTIREG_RET
2698         gtSpillFlags[idx] = flags;
2699 #else
2700         unreached();
2701 #endif
2702     }
2703
2704     //-------------------------------------------------------------------
2705     // clearOtherRegFlags: clear GTF_* flags associated with gtOtherRegs
2706     //
2707     // Arguments:
2708     //     None
2709     //
2710     // Return Value:
2711     //     None
2712     void ClearOtherRegFlags()
2713     {
2714 #if FEATURE_MULTIREG_RET
2715         for (unsigned i = 0; i < MAX_RET_REG_COUNT; ++i)
2716         {
2717             gtSpillFlags[i] = 0;
2718         }
2719 #endif
2720     }
2721
2722     //-------------------------------------------------------------------------
2723     // CopyOtherRegFlags: copy GTF_* flags associated with gtOtherRegs from
2724     // the given call node.
2725     //
2726     // Arguments:
2727     //    fromCall  -  GenTreeCall node from which to copy
2728     //
2729     // Return Value:
2730     //    None
2731     //
2732     void CopyOtherRegFlags(GenTreeCall* fromCall)
2733     {
2734 #if FEATURE_MULTIREG_RET
2735         for (unsigned i = 0; i < MAX_RET_REG_COUNT; ++i)
2736         {
2737             this->gtSpillFlags[i] = fromCall->gtSpillFlags[i];
2738         }
2739 #endif
2740     }
2741
2742 #define     GTF_CALL_M_EXPLICIT_TAILCALL       0x0001  // GT_CALL -- the call is "tail" prefixed and importer has performed tail call checks
2743 #define     GTF_CALL_M_TAILCALL                0x0002  // GT_CALL -- the call is a tailcall
2744 #define     GTF_CALL_M_VARARGS                 0x0004  // GT_CALL -- the call uses varargs ABI
2745 #define     GTF_CALL_M_RETBUFFARG              0x0008  // GT_CALL -- first parameter is the return buffer argument
2746 #define     GTF_CALL_M_DELEGATE_INV            0x0010  // GT_CALL -- call to Delegate.Invoke
2747 #define     GTF_CALL_M_NOGCCHECK               0x0020  // GT_CALL -- not a call for computing full interruptability
2748 #define     GTF_CALL_M_SPECIAL_INTRINSIC       0x0040  // GT_CALL -- function that could be optimized as an intrinsic
2749                                                        // in special cases. Used to optimize fast way out in morphing
2750 #define     GTF_CALL_M_UNMGD_THISCALL          0x0080  // "this" pointer (first argument) should be enregistered (only for GTF_CALL_UNMANAGED)
2751 #define     GTF_CALL_M_VIRTSTUB_REL_INDIRECT   0x0080  // the virtstub is indirected through a relative address (only for GTF_CALL_VIRT_STUB)
2752 #define     GTF_CALL_M_NONVIRT_SAME_THIS       0x0080  // callee "this" pointer is equal to caller this pointer (only for GTF_CALL_NONVIRT)
2753 #define     GTF_CALL_M_FRAME_VAR_DEATH         0x0100  // GT_CALL -- the compLvFrameListRoot variable dies here (last use)
2754
2755 #ifndef LEGACY_BACKEND
2756 #define     GTF_CALL_M_TAILCALL_VIA_HELPER     0x0200  // GT_CALL -- call is a tail call dispatched via tail call JIT helper.
2757 #endif // !LEGACY_BACKEND
2758
2759 #if FEATURE_TAILCALL_OPT
2760 #define     GTF_CALL_M_IMPLICIT_TAILCALL       0x0400  // GT_CALL -- call is an opportunistic tail call and importer has performed tail call checks
2761 #define     GTF_CALL_M_TAILCALL_TO_LOOP        0x0800  // GT_CALL -- call is a fast recursive tail call that can be converted into a loop
2762 #endif
2763
2764 #define     GTF_CALL_M_PINVOKE                 0x1000  // GT_CALL -- call is a pinvoke.  This mirrors VM flag CORINFO_FLG_PINVOKE.
2765                                                        // A call marked as Pinvoke is not necessarily a GT_CALL_UNMANAGED. For e.g.
2766                                                        // an IL Stub dynamically generated for a PInvoke declaration is flagged as
2767                                                        // a Pinvoke but not as an unmanaged call. See impCheckForPInvokeCall() to
2768                                                        // know when these flags are set.
2769
2770 #define     GTF_CALL_M_R2R_REL_INDIRECT        0x2000  // GT_CALL -- ready to run call is indirected through a relative address
2771
2772     bool IsUnmanaged()       { return (gtFlags & GTF_CALL_UNMANAGED) != 0; }
2773     bool NeedsNullCheck()    { return (gtFlags & GTF_CALL_NULLCHECK) != 0; }
2774     bool CallerPop()         { return (gtFlags & GTF_CALL_POP_ARGS) != 0;  }
2775     bool IsVirtual()         { return (gtFlags & GTF_CALL_VIRT_KIND_MASK) != GTF_CALL_NONVIRT; }
2776     bool IsVirtualStub()     { return (gtFlags & GTF_CALL_VIRT_KIND_MASK) == GTF_CALL_VIRT_STUB; }
2777     bool IsVirtualVtable()   { return (gtFlags & GTF_CALL_VIRT_KIND_MASK) == GTF_CALL_VIRT_VTABLE; }
2778     bool IsInlineCandidate() { return (gtFlags & GTF_CALL_INLINE_CANDIDATE) != 0; }
2779
2780 #ifndef LEGACY_BACKEND
2781     // Whether the method has non-standard args (i.e. passed in R10 or R11)
2782     // See fgMorphArgs() to know the call types for which non-standard args are inserted.
2783     bool HasNonStandardArgs()  { return IsUnmanaged() || (gtCallType == CT_INDIRECT && (IsVirtualStub() || gtCallCookie)); }
2784
2785     // Get the count of non-standard arg count
2786     int  GetNonStandardArgCount()
2787     {
2788         if (IsUnmanaged())
2789         {
2790             // R11 = PInvoke cookie param
2791             return 1;
2792         }
2793         else if (gtCallType == CT_INDIRECT)
2794         {
2795             if (IsVirtualStub())
2796             {
2797                 // R11 = Virtual stub param
2798                 return 1;
2799             }
2800             else if (gtCallCookie != nullptr)
2801             {
2802                 // R10 = PInvoke target param
2803                 // R11 = PInvoke cookie param
2804                 return 2;
2805             }
2806         }
2807
2808         return 0;
2809     }
2810 #endif // !LEGACY_BACKEND
2811
2812     // Returns true if this call uses a retBuf argument and its calling convention
2813     bool HasRetBufArg() const
2814     {
2815          return (gtCallMoreFlags & GTF_CALL_M_RETBUFFARG) != 0;
2816     }
2817
2818     //-------------------------------------------------------------------------
2819     // TreatAsHasRetBufArg:
2820     //
2821     // Arguments:
2822     //     compiler, the compiler instance so that we can call eeGetHelperNum
2823     //
2824     // Return Value:
2825     //     Returns true if we treat the call as if it has a retBuf argument
2826     //     This method may actually have a retBuf argument
2827     //     or it could be a JIT helper that we are still transforming during
2828     //     the importer phase.
2829     //
2830     // Notes:
2831     //     On ARM64 marking the method with the GTF_CALL_M_RETBUFFARG flag
2832     //     will make HasRetBufArg() return true, but will also force the
2833     //     use of register x8 to pass the RetBuf argument.
2834     //
2835     bool TreatAsHasRetBufArg(Compiler* compiler);
2836
2837     //-----------------------------------------------------------------------------------------
2838     // HasMultiRegRetVal: whether the call node returns its value in multiple return registers.
2839     //
2840     // Arguments:
2841     //     None
2842     //
2843     // Return Value:
2844     //     True if the call is returning a multi-reg return value. False otherwise.
2845     //
2846     // Note:
2847     //     This is implemented only for x64 Unix and yet to be implemented for
2848     //     other multi-reg return target arch (arm64/arm32/x86).
2849     //
2850     // TODO-ARM: Implement this routine for Arm64 and Arm32
2851     bool HasMultiRegRetVal() const
2852     {
2853 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
2854         return varTypeIsStruct(gtType) && !HasRetBufArg();
2855 #elif defined(_TARGET_X86_) && !defined(LEGACY_BACKEND)
2856         // LEGACY_BACKEND does not use multi reg returns for calls with long return types
2857         return varTypeIsLong(gtType);
2858 #else
2859         return false;
2860 #endif
2861     }
2862
2863     // Returns true if VM has flagged this method as CORINFO_FLG_PINVOKE.
2864     bool IsPInvoke()                { return (gtCallMoreFlags & GTF_CALL_M_PINVOKE) != 0; }
2865
2866     // Note that the distinction of whether tail prefixed or an implicit tail call
2867     // is maintained on a call node till fgMorphCall() after which it will be
2868     // either a tail call (i.e. IsTailCall() is true) or a non-tail call.
2869     bool IsTailPrefixedCall()       { return (gtCallMoreFlags & GTF_CALL_M_EXPLICIT_TAILCALL) != 0; }
2870
2871     // This method returning "true" implies that tail call flowgraph morhphing has
2872     // performed final checks and committed to making a tail call.
2873     bool IsTailCall()               { return (gtCallMoreFlags & GTF_CALL_M_TAILCALL) != 0; }
2874
2875     // This method returning "true" implies that importer has performed tail call checks
2876     // and providing a hint that this can be converted to a tail call.
2877     bool CanTailCall()              { return IsTailPrefixedCall() || IsImplicitTailCall(); }
2878
2879 #ifndef LEGACY_BACKEND
2880     bool IsTailCallViaHelper()      { return IsTailCall() && (gtCallMoreFlags & GTF_CALL_M_TAILCALL_VIA_HELPER); }
2881 #else // LEGACY_BACKEND
2882     bool IsTailCallViaHelper()      { return true; }
2883 #endif // LEGACY_BACKEND
2884
2885 #if FEATURE_FASTTAILCALL
2886     bool IsFastTailCall()           { return IsTailCall() && !(gtCallMoreFlags & GTF_CALL_M_TAILCALL_VIA_HELPER); }
2887 #else // !FEATURE_FASTTAILCALL
2888     bool IsFastTailCall()           { return false; }
2889 #endif // !FEATURE_FASTTAILCALL
2890
2891 #if FEATURE_TAILCALL_OPT
2892     // Returns true if this is marked for opportunistic tail calling.
2893     // That is, can be tail called though not explicitly prefixed with "tail" prefix.
2894     bool IsImplicitTailCall()       { return (gtCallMoreFlags & GTF_CALL_M_IMPLICIT_TAILCALL) != 0; }
2895     bool IsTailCallConvertibleToLoop() { return (gtCallMoreFlags & GTF_CALL_M_TAILCALL_TO_LOOP) != 0; }
2896 #else // !FEATURE_TAILCALL_OPT
2897     bool IsImplicitTailCall()       { return false; }
2898     bool IsTailCallConvertibleToLoop() { return false; }
2899 #endif // !FEATURE_TAILCALL_OPT
2900
2901     bool IsSameThis()      { return (gtCallMoreFlags & GTF_CALL_M_NONVIRT_SAME_THIS) != 0; }
2902     bool IsDelegateInvoke(){ return (gtCallMoreFlags & GTF_CALL_M_DELEGATE_INV) != 0; }
2903     bool IsVirtualStubRelativeIndir() { return (gtCallMoreFlags & GTF_CALL_M_VIRTSTUB_REL_INDIRECT) != 0; }
2904 #ifdef FEATURE_READYTORUN_COMPILER
2905     bool IsR2RRelativeIndir() { return (gtCallMoreFlags & GTF_CALL_M_R2R_REL_INDIRECT) != 0; }
2906     void setEntryPoint(CORINFO_CONST_LOOKUP entryPoint) {
2907         gtEntryPoint = entryPoint;
2908         if (gtEntryPoint.accessType == IAT_PVALUE)
2909         {
2910             gtCallMoreFlags |= GTF_CALL_M_R2R_REL_INDIRECT;
2911         }
2912     }
2913 #endif // FEATURE_READYTORUN_COMPILER
2914     bool IsVarargs()       { return (gtCallMoreFlags & GTF_CALL_M_VARARGS) != 0; }
2915
2916     unsigned short  gtCallMoreFlags;        // in addition to gtFlags
2917
2918     unsigned char   gtCallType   :3;        // value from the gtCallTypes enumeration
2919     unsigned char   gtReturnType :5;        // exact return type
2920
2921     CORINFO_CLASS_HANDLE    gtRetClsHnd;    // The return type handle of the call if it is a struct; always available
2922
2923     union
2924     {
2925         // only used for CALLI unmanaged calls (CT_INDIRECT)
2926         GenTreePtr      gtCallCookie;
2927         // gtInlineCandidateInfo is only used when inlining methods
2928         InlineCandidateInfo* gtInlineCandidateInfo;
2929         void* gtStubCallStubAddr;             // GTF_CALL_VIRT_STUB - these are never inlined
2930         CORINFO_GENERIC_HANDLE compileTimeHelperArgumentHandle; // Used to track type handle argument of dynamic helpers
2931         void* gtDirectCallAddress; // Used to pass direct call address between lower and codegen
2932     };
2933
2934     // expression evaluated after args are placed which determines the control target
2935     GenTree * gtControlExpr;
2936
2937     union
2938     {
2939         CORINFO_METHOD_HANDLE gtCallMethHnd;  // CT_USER_FUNC
2940         GenTreePtr  gtCallAddr;               // CT_INDIRECT
2941     };
2942
2943 #ifdef FEATURE_READYTORUN_COMPILER
2944     // Call target lookup info for method call from a Ready To Run module
2945     CORINFO_CONST_LOOKUP gtEntryPoint;
2946 #endif
2947
2948 #if defined(DEBUG) || defined(INLINE_DATA)
2949     // For non-inline candidates, track the first observation
2950     // that blocks candidacy.
2951     InlineObservation gtInlineObservation;
2952
2953     // IL offset of the call wrt its parent method.
2954     IL_OFFSET gtRawILOffset;
2955 #endif // defined(DEBUG) || defined(INLINE_DATA)
2956
2957     GenTreeCall(var_types type) :
2958         GenTree(GT_CALL, type)
2959     {
2960     }
2961 #if DEBUGGABLE_GENTREE
2962     GenTreeCall() : GenTree()
2963     {
2964     }
2965 #endif
2966 };
2967
2968 struct GenTreeCmpXchg: public GenTree
2969 {
2970     GenTreePtr      gtOpLocation;
2971     GenTreePtr      gtOpValue;
2972     GenTreePtr      gtOpComparand;
2973
2974     GenTreeCmpXchg(var_types type, GenTreePtr loc, GenTreePtr val, GenTreePtr comparand) :
2975         GenTree(GT_CMPXCHG, type),
2976         gtOpLocation(loc), gtOpValue(val),  gtOpComparand(comparand)
2977         {
2978             // There's no reason to do a compare-exchange on a local location, so we'll assume that all of these
2979             // have global effects.
2980             gtFlags |= GTF_GLOB_EFFECT;
2981         }
2982 #if DEBUGGABLE_GENTREE
2983     GenTreeCmpXchg() : GenTree() {}
2984 #endif
2985 };
2986
2987
2988
2989 struct GenTreeFptrVal: public GenTree
2990 {
2991     CORINFO_METHOD_HANDLE gtFptrMethod;
2992
2993 #ifdef FEATURE_READYTORUN_COMPILER
2994     CORINFO_CONST_LOOKUP gtEntryPoint;
2995     CORINFO_RESOLVED_TOKEN* gtLdftnResolvedToken;
2996 #endif
2997
2998     GenTreeFptrVal(var_types type, CORINFO_METHOD_HANDLE meth) :
2999         GenTree(GT_FTN_ADDR, type),
3000         gtFptrMethod(meth)
3001         {}
3002 #if DEBUGGABLE_GENTREE
3003     GenTreeFptrVal() : GenTree() {}
3004 #endif
3005 };
3006
3007 /* gtQmark */
3008 struct GenTreeQmark : public GenTreeOp
3009 {
3010     // Livesets on entry to then and else subtrees
3011     VARSET_TP       gtThenLiveSet;
3012     VARSET_TP       gtElseLiveSet;
3013
3014     // The "Compiler*" argument is not a DEBUGARG here because we use it to keep track of the set of
3015     // (possible) QMark nodes.
3016     GenTreeQmark(var_types type, GenTreePtr cond, GenTreePtr colonOp, class Compiler* comp);
3017
3018 #if DEBUGGABLE_GENTREE
3019     GenTreeQmark() : GenTreeOp(GT_QMARK, TYP_INT, NULL, NULL) {}
3020 #endif
3021 };
3022
3023 /* gtIntrinsic   -- intrinsic   (possibly-binary op [NULL op2 is allowed] with an additional field) */
3024
3025 struct GenTreeIntrinsic: public GenTreeOp
3026 {
3027     CorInfoIntrinsics     gtIntrinsicId;
3028     CORINFO_METHOD_HANDLE gtMethodHandle;    // Method handle of the method which is treated as an intrinsic.
3029
3030 #ifdef FEATURE_READYTORUN_COMPILER
3031     // Call target lookup info for method call from a Ready To Run module
3032     CORINFO_CONST_LOOKUP gtEntryPoint;
3033 #endif
3034
3035     GenTreeIntrinsic(var_types type, GenTreePtr op1, CorInfoIntrinsics intrinsicId, CORINFO_METHOD_HANDLE methodHandle) :
3036         GenTreeOp(GT_INTRINSIC, type, op1, NULL),
3037         gtIntrinsicId(intrinsicId),
3038         gtMethodHandle(methodHandle)
3039         {}
3040
3041     GenTreeIntrinsic(var_types type, GenTreePtr op1, GenTreePtr op2, CorInfoIntrinsics intrinsicId, CORINFO_METHOD_HANDLE methodHandle) :
3042         GenTreeOp(GT_INTRINSIC, type, op1, op2),
3043         gtIntrinsicId(intrinsicId),
3044         gtMethodHandle(methodHandle)
3045         {}
3046
3047 #if DEBUGGABLE_GENTREE
3048     GenTreeIntrinsic() : GenTreeOp() {}
3049 #endif
3050 };
3051
3052 #ifdef FEATURE_SIMD
3053
3054 /* gtSIMD   -- SIMD intrinsic   (possibly-binary op [NULL op2 is allowed] with additional fields) */
3055 struct GenTreeSIMD: public GenTreeOp
3056 {
3057     SIMDIntrinsicID         gtSIMDIntrinsicID;  // operation Id
3058     var_types               gtSIMDBaseType;     // SIMD vector base type
3059     unsigned                gtSIMDSize;         // SIMD vector size in bytes
3060
3061     GenTreeSIMD(var_types type, GenTreePtr op1, SIMDIntrinsicID simdIntrinsicID, var_types baseType, unsigned size) :
3062         GenTreeOp(GT_SIMD, type, op1, nullptr),
3063         gtSIMDIntrinsicID(simdIntrinsicID),
3064         gtSIMDBaseType(baseType),
3065         gtSIMDSize(size)
3066         {}
3067
3068     GenTreeSIMD(var_types type, GenTreePtr op1, GenTreePtr op2, SIMDIntrinsicID simdIntrinsicID, var_types baseType, unsigned size) :
3069         GenTreeOp(GT_SIMD, type, op1, op2),
3070         gtSIMDIntrinsicID(simdIntrinsicID),
3071         gtSIMDBaseType(baseType),
3072         gtSIMDSize(size)
3073         {}
3074
3075 #if DEBUGGABLE_GENTREE
3076     GenTreeSIMD() : GenTreeOp() {}
3077 #endif
3078 };
3079 #endif // FEATURE_SIMD
3080
3081 /* gtIndex -- array access */
3082
3083 struct GenTreeIndex: public GenTreeOp
3084 {
3085     GenTreePtr&     Arr()   { return gtOp1; }
3086     GenTreePtr&     Index() { return gtOp2; }
3087
3088     unsigned        gtIndElemSize;  // size of elements in the array
3089     CORINFO_CLASS_HANDLE gtStructElemClass;   // If the element type is a struct, this is the struct type.
3090
3091     GenTreeIndex(var_types type, GenTreePtr arr, GenTreePtr ind, unsigned indElemSize) :
3092         GenTreeOp(GT_INDEX, type, arr, ind),
3093         gtIndElemSize(indElemSize),
3094         gtStructElemClass(nullptr)  // We always initialize this after construction.
3095         {
3096 #ifdef DEBUG
3097             if (JitConfig.JitSkipArrayBoundCheck() == 1)
3098             {
3099                 // Skip bounds check
3100             }
3101             else
3102 #endif
3103             {
3104                 // Do bounds check
3105                 gtFlags |= GTF_INX_RNGCHK;
3106             }
3107
3108             if (type == TYP_REF)
3109             {
3110                 gtFlags |= GTF_INX_REFARR_LAYOUT;
3111             }
3112
3113             gtFlags |= GTF_EXCEPT|GTF_GLOB_REF;
3114         }
3115 #if DEBUGGABLE_GENTREE
3116     GenTreeIndex() : GenTreeOp() {}
3117 #endif
3118 };
3119
3120 /* gtArrLen -- array length (GT_ARR_LENGTH)
3121    GT_ARR_LENGTH is used for "arr.length" */
3122
3123 struct GenTreeArrLen: public GenTreeUnOp
3124 {
3125     GenTreePtr&     ArrRef() { return gtOp1; }   // the array address node
3126 private:
3127     int             gtArrLenOffset; // constant to add to "gtArrRef" to get the address of the array length.
3128
3129 public:
3130     inline int      ArrLenOffset() {
3131         return gtArrLenOffset;
3132     }
3133
3134     GenTreeArrLen(var_types type, GenTreePtr arrRef, int lenOffset) :
3135         GenTreeUnOp(GT_ARR_LENGTH, type, arrRef),
3136         gtArrLenOffset(lenOffset)
3137         {}
3138
3139 #if DEBUGGABLE_GENTREE
3140     GenTreeArrLen() : GenTreeUnOp() {}
3141 #endif
3142 };
3143
3144 // This takes:
3145 // - a comparison value (generally an array length),
3146 // - an index value, and
3147 // - the label to jump to if the index is out of range.
3148 // - the "kind" of the throw block to branch to on failure
3149 // It generates no result.
3150
3151 struct GenTreeBoundsChk: public GenTree
3152 {
3153     GenTreePtr              gtArrLen;       // An expression for the length of the array being indexed.
3154     GenTreePtr              gtIndex;        // The index expression.
3155
3156     GenTreePtr              gtIndRngFailBB; // Label to jump to for array-index-out-of-range
3157     SpecialCodeKind         gtThrowKind;    // Kind of throw block to branch to on failure
3158
3159     /* Only out-of-ranges at same stack depth can jump to the same label (finding return address is easier)
3160        For delayed calling of fgSetRngChkTarget() so that the
3161        optimizer has a chance of eliminating some of the rng checks */
3162     unsigned        gtStkDepth;
3163
3164     GenTreeBoundsChk(genTreeOps oper, var_types type, GenTreePtr arrLen, GenTreePtr index, SpecialCodeKind kind) :
3165         GenTree(oper, type),
3166         gtArrLen(arrLen), gtIndex(index),
3167         gtIndRngFailBB(NULL),
3168         gtThrowKind(kind),
3169         gtStkDepth(0)
3170         {
3171             // Effects flags propagate upwards.
3172             gtFlags |= (arrLen->gtFlags & GTF_ALL_EFFECT);
3173             gtFlags |= GTF_EXCEPT;
3174         }
3175 #if DEBUGGABLE_GENTREE
3176     GenTreeBoundsChk() : GenTree() {}
3177 #endif
3178
3179     // If the gtArrLen is really an array length, returns array reference, else "NULL".
3180     GenTreePtr GetArray()
3181     {
3182         if (gtArrLen->OperGet() == GT_ARR_LENGTH)
3183         {
3184             return gtArrLen->gtArrLen.ArrRef();
3185         }
3186         else
3187         {
3188             return NULL;
3189         }
3190     }
3191 };
3192
3193 // gtArrElem -- general array element (GT_ARR_ELEM), for non "SZ_ARRAYS"
3194 //              -- multidimensional arrays, or 1-d arrays with non-zero lower bounds.
3195
3196 struct GenTreeArrElem: public GenTree
3197 {
3198     GenTreePtr      gtArrObj;
3199
3200     #define         GT_ARR_MAX_RANK 3
3201     GenTreePtr      gtArrInds[GT_ARR_MAX_RANK]; // Indices
3202     unsigned char   gtArrRank;                  // Rank of the array
3203
3204     unsigned char   gtArrElemSize;              // !!! Caution, this is an "unsigned char", it is used only
3205                                                 // on the optimization path of array intrisics.
3206                                                 // It stores the size of array elements WHEN it can fit
3207                                                 // into an "unsigned char".
3208                                                 // This has caused VSW 571394.
3209     var_types       gtArrElemType;              // The array element type
3210
3211     // Requires that "inds" is a pointer to an array of "rank" GenTreePtrs for the indices.
3212     GenTreeArrElem(var_types type, GenTreePtr arr, unsigned char rank, unsigned char elemSize, var_types elemType, GenTreePtr* inds) :
3213         GenTree(GT_ARR_ELEM, type),
3214         gtArrObj(arr), gtArrRank(rank), gtArrElemSize(elemSize), gtArrElemType(elemType)
3215         {
3216             for (unsigned char i = 0; i < rank; i++) gtArrInds[i] = inds[i];
3217             gtFlags |= GTF_EXCEPT;
3218         }
3219 #if DEBUGGABLE_GENTREE
3220     GenTreeArrElem() : GenTree() {}
3221 #endif
3222 };
3223
3224 //--------------------------------------------
3225 //
3226 // GenTreeArrIndex (gtArrIndex): Expression to bounds-check the index for one dimension of a
3227 //    multi-dimensional or non-zero-based array., and compute the effective index
3228 //    (i.e. subtracting the lower bound).
3229 //
3230 // Notes:
3231 //    This node is similar in some ways to GenTreeBoundsChk, which ONLY performs the check.
3232 //    The reason that this node incorporates the check into the effective index computation is
3233 //    to avoid duplicating the codegen, as the effective index is required to compute the
3234 //    offset anyway.
3235 //    TODO-CQ: Enable optimization of the lower bound and length by replacing this:
3236 //                /--*  <arrObj>
3237 //                +--*  <index0>
3238 //             +--* ArrIndex[i, ]
3239 //    with something like:
3240 //                   /--*  <arrObj>
3241 //                /--*  ArrLowerBound[i, ]
3242 //                |  /--*  <arrObj>
3243 //                +--*  ArrLen[i, ]    (either generalize GT_ARR_LENGTH or add a new node)
3244 //                +--*  <index0>
3245 //             +--* ArrIndex[i, ]
3246 //    Which could, for example, be optimized to the following when known to be within bounds:
3247 //                /--*  TempForLowerBoundDim0
3248 //                +--*  <index0>
3249 //             +--* - (GT_SUB)
3250 //
3251 struct GenTreeArrIndex: public GenTreeOp
3252 {
3253     // The array object - may be any expression producing an Array reference, but is likely to be a lclVar.
3254     GenTreePtr&     ArrObj()    { return gtOp1; }
3255     // The index expression - may be any integral expression.
3256     GenTreePtr&     IndexExpr() { return gtOp2; }
3257     unsigned char   gtCurrDim;      // The current dimension
3258     unsigned char   gtArrRank;      // Rank of the array
3259     var_types       gtArrElemType;  // The array element type
3260
3261     GenTreeArrIndex(var_types type, GenTreePtr arrObj, GenTreePtr indexExpr,
3262                   unsigned char currDim, unsigned char arrRank, var_types elemType) :
3263         GenTreeOp(GT_ARR_INDEX, type, arrObj, indexExpr),
3264                   gtCurrDim(currDim), gtArrRank(arrRank), gtArrElemType(elemType)
3265     {
3266         gtFlags |= GTF_EXCEPT;
3267     }
3268 #if DEBUGGABLE_GENTREE
3269 protected:
3270     friend GenTree;
3271     // Used only for GenTree::GetVtableForOper()
3272     GenTreeArrIndex() : GenTreeOp() {}
3273 #endif
3274 };
3275
3276 // Represents either an InitBlk, InitObj, CpBlk or CpObj
3277 // MSIL OpCode.
3278 struct GenTreeBlkOp : public GenTreeOp
3279 {
3280 public:
3281     // The destination for the CpBlk/CpObj/InitBlk/InitObj to copy bits to
3282     GenTreePtr Dest()         {
3283                                 assert(gtOp1->gtOper == GT_LIST);
3284                                 return gtOp1->gtOp.gtOp1;
3285                               }
3286
3287     // True if this BlkOpNode is a volatile memory operation.
3288     bool IsVolatile() const { return (gtFlags & GTF_BLK_VOLATILE) != 0; }
3289
3290     // Instruction selection: during codegen time, what code sequence we will be using
3291     // to encode this operation.
3292     enum
3293     {
3294         BlkOpKindInvalid,
3295         BlkOpKindHelper,
3296         BlkOpKindRepInstr,
3297         BlkOpKindUnroll,
3298     } gtBlkOpKind;
3299
3300     bool gtBlkOpGcUnsafe;
3301
3302     GenTreeBlkOp(genTreeOps oper) :
3303         GenTreeOp(oper, TYP_VOID DEBUGARG(true)),
3304             gtBlkOpKind(BlkOpKindInvalid),
3305             gtBlkOpGcUnsafe(false)
3306     {
3307         assert(OperIsBlkOp(oper));
3308     }
3309
3310 #if DEBUGGABLE_GENTREE
3311 protected:
3312     friend GenTree;
3313     GenTreeBlkOp() : GenTreeOp(){}
3314 #endif // DEBUGGABLE_GENTREE
3315 };
3316
3317 // gtObj  -- 'object' (GT_OBJ). */
3318
3319 struct GenTreeObj: public GenTreeUnOp
3320 {
3321     // The address of the block.
3322     GenTreePtr&     Addr()          { return gtOp1; }
3323
3324     CORINFO_CLASS_HANDLE gtClass;   // the class of the object
3325
3326     GenTreeObj(var_types type, GenTreePtr addr, CORINFO_CLASS_HANDLE cls) :
3327         GenTreeUnOp(GT_OBJ, type, addr),
3328         gtClass(cls)
3329         {
3330             gtFlags |= GTF_GLOB_REF; // An Obj is always a global reference.
3331         }
3332
3333 #if DEBUGGABLE_GENTREE
3334     GenTreeObj() : GenTreeUnOp() {}
3335 #endif
3336 };
3337
3338 // Represents a CpObj MSIL Node.
3339 struct GenTreeCpObj : public GenTreeBlkOp
3340 {
3341 public:
3342     // The source for the CpBlk/CpObj to copy bits from
3343     GenTreePtr Source()       {
3344         assert(gtOper == GT_COPYOBJ && gtOp1->gtOper == GT_LIST);
3345         return gtOp1->gtOp.gtOp2;
3346     }
3347
3348     // In the case of CopyObj, this is the class token that represents the type that is being copied.
3349     GenTreePtr ClsTok() { return gtOp2; }
3350
3351     // If non-null, this array represents the gc-layout of the class that is being copied
3352     // with CpObj.
3353     BYTE*       gtGcPtrs;
3354
3355     // If non-zero, this is the number of slots in the class layout that
3356     // contain gc-pointers.
3357     unsigned    gtGcPtrCount;
3358
3359     // If non-zero, the number of pointer-sized slots that constitutes the class token in CpObj.
3360     unsigned    gtSlots;
3361
3362     GenTreeCpObj(unsigned gcPtrCount, unsigned gtSlots, BYTE* gtGcPtrs) :
3363         GenTreeBlkOp(GT_COPYOBJ),
3364         gtGcPtrs(gtGcPtrs),
3365         gtGcPtrCount(gcPtrCount),
3366         gtSlots(gtSlots){ }
3367
3368 #if DEBUGGABLE_GENTREE
3369 protected:
3370     friend GenTree;
3371     GenTreeCpObj() : GenTreeBlkOp(),
3372         gtGcPtrs(nullptr),
3373         gtGcPtrCount(0),
3374         gtSlots(0) {}
3375 #endif // DEBUGGABLE_GENTREE
3376 };
3377
3378 // Represents either an InitBlk or InitObj MSIL OpCode.
3379 struct GenTreeInitBlk : public GenTreeBlkOp
3380 {
3381 public:
3382
3383     // The value used to fill the destination buffer.
3384     GenTreePtr InitVal() { assert(gtOp1->gtOper == GT_LIST);
3385                            return gtOp1->gtOp.gtOp2; }
3386
3387     // The size of the buffer to be copied.
3388     GenTreePtr Size()    { return gtOp2; }
3389
3390     GenTreeInitBlk() : GenTreeBlkOp(GT_INITBLK){}
3391
3392 #if DEBUGGABLE_GENTREE
3393 protected:
3394     friend GenTree;
3395 #endif // DEBUGGABLE_GENTREE
3396 };
3397
3398 // Represents a CpBlk or CpObj with no GC-pointers MSIL OpCode.
3399 struct GenTreeCpBlk : public GenTreeBlkOp
3400 {
3401 public:
3402
3403     // The value used to fill the destination buffer.
3404     // The source for the CpBlk/CpObj to copy bits from
3405     GenTreePtr Source() { assert(gtOp1->gtOper == GT_LIST);
3406                           return gtOp1->gtOp.gtOp2; }
3407
3408     // The size of the buffer to be copied.
3409     GenTreePtr Size()   { return gtOp2; }
3410
3411     GenTreeCpBlk() : GenTreeBlkOp(GT_COPYBLK){}
3412
3413 #if DEBUGGABLE_GENTREE
3414 protected:
3415     friend GenTree;
3416 #endif // DEBUGGABLE_GENTREE
3417 };
3418
3419 //--------------------------------------------
3420 //
3421 // GenTreeArrOffset (gtArrOffset): Expression to compute the accumulated offset for the address
3422 //    of an element of a multi-dimensional or non-zero-based array.
3423 //
3424 // Notes:
3425 //    The result of this expression is (gtOffset * dimSize) + gtIndex
3426 //    where dimSize is the length/stride/size of the dimension, and is obtained from gtArrObj.
3427 //    This node is generated in conjunction with the GenTreeArrIndex node, which computes the
3428 //    effective index for a single dimension.  The sub-trees can be separately optimized, e.g.
3429 //    within a loop body where the expression for the 0th dimension may be invariant.
3430 //
3431 //    Here is an example of how the tree might look for a two-dimension array reference:
3432 //                /--*  const 0
3433 //                |  /--* <arrObj>
3434 //                |  +--* <index0>
3435 //                +--* ArrIndex[i, ]
3436 //                +--*  <arrObj>
3437 //             /--| arrOffs[i, ]
3438 //             |  +--*  <arrObj>
3439 //             |  +--*  <index1>
3440 //             +--* ArrIndex[*,j]
3441 //             +--*  <arrObj>
3442 //          /--| arrOffs[*,j]
3443 //    TODO-CQ: see comment on GenTreeArrIndex for how its representation may change.  When that
3444 //    is done, we will also want to replace the <arrObj> argument to arrOffs with the
3445 //    ArrLen as for GenTreeArrIndex.
3446 //
3447 struct GenTreeArrOffs: public GenTree
3448 {
3449     GenTreePtr      gtOffset;       // The accumulated offset for lower dimensions - must be TYP_I_IMPL, and
3450                                     // will either be a CSE temp, the constant 0, or another GenTreeArrOffs node.
3451     GenTreePtr      gtIndex;        // The effective index for the current dimension - must be non-negative
3452                                     // and can be any expression (though it is likely to be either a GenTreeArrIndex,
3453                                     // node, a lclVar, or a constant).
3454     GenTreePtr      gtArrObj;       // The array object - may be any expression producing an Array reference,
3455                                     // but is likely to be a lclVar.
3456     unsigned char   gtCurrDim;      // The current dimension
3457     unsigned char   gtArrRank;      // Rank of the array
3458     var_types       gtArrElemType;  // The array element type
3459
3460     GenTreeArrOffs(var_types type, GenTreePtr offset, GenTreePtr index, GenTreePtr arrObj,
3461                    unsigned char currDim, unsigned char rank, var_types elemType) :
3462         GenTree(GT_ARR_OFFSET, type), gtOffset(offset), gtIndex(index), gtArrObj(arrObj),
3463                 gtCurrDim(currDim), gtArrRank(rank), gtArrElemType(elemType)
3464     {
3465         assert(index->gtFlags & GTF_EXCEPT);
3466         gtFlags |= GTF_EXCEPT;
3467     }
3468 #if DEBUGGABLE_GENTREE
3469     GenTreeArrOffs() : GenTree() {}
3470 #endif
3471 };
3472
3473 /* gtAddrMode -- Target-specific canonicalized addressing expression (GT_LEA) */
3474
3475 struct GenTreeAddrMode: public GenTreeOp
3476 {
3477     // Address is Base + Index*Scale + Offset.
3478     // These are the legal patterns:
3479     //
3480     //      Base                                // Base != nullptr && Index == nullptr && Scale == 0 && Offset == 0
3481     //      Base + Index*Scale                  // Base != nullptr && Index != nullptr && Scale != 0 && Offset == 0
3482     //      Base + Offset                       // Base != nullptr && Index == nullptr && Scale == 0 && Offset != 0
3483     //      Base + Index*Scale + Offset         // Base != nullptr && Index != nullptr && Scale != 0 && Offset != 0
3484     //             Index*Scale                  // Base == nullptr && Index != nullptr && Scale >  1 && Offset == 0
3485     //             Index*Scale + Offset         // Base == nullptr && Index != nullptr && Scale >  1 && Offset != 0
3486     //                           Offset         // Base == nullptr && Index == nullptr && Scale == 0 && Offset != 0
3487     //
3488     // So, for example:
3489     //      1. Base + Index is legal with Scale==1
3490     //      2. If Index is null, Scale should be zero (or unintialized / unused)
3491     //      3. If Scale==1, then we should have "Base" instead of "Index*Scale", and "Base + Offset" instead of "Index*Scale + Offset".
3492
3493     // First operand is base address/pointer
3494     bool            HasBase() const     { return gtOp1 != nullptr; }
3495     GenTreePtr&     Base()              { return gtOp1; }
3496
3497     // Second operand is scaled index value
3498     bool            HasIndex() const    { return gtOp2 != nullptr; }
3499     GenTreePtr&     Index()             { return gtOp2; }
3500
3501     unsigned        gtScale;        // The scale factor
3502     unsigned        gtOffset;       // The offset to add
3503
3504     GenTreeAddrMode(var_types type, GenTreePtr base, GenTreePtr index,
3505                     unsigned scale, unsigned offset) :
3506         GenTreeOp(GT_LEA, type, base, index )
3507     {
3508         gtScale = scale;
3509         gtOffset = offset;
3510     }
3511 #if DEBUGGABLE_GENTREE
3512 protected:
3513     friend GenTree;
3514     // Used only for GenTree::GetVtableForOper()
3515     GenTreeAddrMode() : GenTreeOp() {}
3516 #endif
3517 };
3518
3519 // Indir is just an op, no additional data, but some additional abstractions
3520 struct GenTreeIndir: public GenTreeOp
3521 {
3522     // like an assign, op1 is the destination
3523     GenTreePtr&     Addr()      { return gtOp1; }
3524
3525     // these methods provide an interface to the indirection node which
3526     bool            HasBase();
3527     bool            HasIndex();
3528     GenTree*        Base();
3529     GenTree*        Index();
3530     unsigned        Scale();
3531     size_t          Offset();
3532
3533     GenTreeIndir(genTreeOps oper, var_types type, GenTree *addr, GenTree *data) :
3534     GenTreeOp(oper, type, addr, data)
3535     {
3536     }
3537
3538 #if DEBUGGABLE_GENTREE
3539 protected:
3540     friend GenTree;
3541     // Used only for GenTree::GetVtableForOper()
3542     GenTreeIndir() : GenTreeOp() {}
3543 #endif
3544 };
3545
3546 // Read-modify-write status of a RMW memory op rooted at a storeInd
3547 enum  RMWStatus {
3548     STOREIND_RMW_STATUS_UNKNOWN,  // RMW status of storeInd unknown
3549                                   // Default status unless modified by IsRMWMemOpRootedAtStoreInd()
3550
3551     // One of these denote storeind is a RMW memory operation.
3552     STOREIND_RMW_DST_IS_OP1,       // StoreInd is known to be a RMW memory op and dst candidate is op1
3553     STOREIND_RMW_DST_IS_OP2,       // StoreInd is known to be a RMW memory op and dst candidate is op2
3554
3555     // One of these denote the reason for storeind is marked as non-RMW operation
3556     STOREIND_RMW_UNSUPPORTED_ADDR, // Addr mode is not yet supported for RMW memory
3557     STOREIND_RMW_UNSUPPORTED_OPER, // Operation is not supported for RMW memory
3558     STOREIND_RMW_UNSUPPORTED_TYPE, // Type is not supported for RMW memory
3559     STOREIND_RMW_INDIR_UNEQUAL     // Indir to read value is not equivalent to indir that writes the value
3560 };
3561
3562 // StoreInd is just a BinOp, with additional RMW status
3563 struct GenTreeStoreInd: public GenTreeIndir
3564 {
3565 #if !CPU_LOAD_STORE_ARCH
3566     // The below flag is set and used during lowering
3567     RMWStatus  gtRMWStatus;
3568
3569     bool  IsRMWStatusUnknown() { return gtRMWStatus == STOREIND_RMW_STATUS_UNKNOWN; }
3570     bool  IsNonRMWMemoryOp() {
3571         return gtRMWStatus == STOREIND_RMW_UNSUPPORTED_ADDR ||
3572                gtRMWStatus == STOREIND_RMW_UNSUPPORTED_OPER ||
3573                gtRMWStatus == STOREIND_RMW_UNSUPPORTED_TYPE ||
3574                gtRMWStatus == STOREIND_RMW_INDIR_UNEQUAL;
3575     }
3576     bool  IsRMWMemoryOp() { return gtRMWStatus == STOREIND_RMW_DST_IS_OP1 || gtRMWStatus == STOREIND_RMW_DST_IS_OP2; }
3577     bool  IsRMWDstOp1() { return gtRMWStatus == STOREIND_RMW_DST_IS_OP1; }
3578     bool  IsRMWDstOp2() { return gtRMWStatus == STOREIND_RMW_DST_IS_OP2; }
3579 #endif //!CPU_LOAD_STORE_ARCH
3580
3581     RMWStatus GetRMWStatus() {
3582 #if !CPU_LOAD_STORE_ARCH
3583         return gtRMWStatus;
3584 #else
3585         return STOREIND_RMW_STATUS_UNKNOWN;
3586 #endif
3587     }
3588
3589     void SetRMWStatusDefault()
3590     {
3591 #if !CPU_LOAD_STORE_ARCH
3592         gtRMWStatus = STOREIND_RMW_STATUS_UNKNOWN;
3593 #endif
3594     }
3595
3596     void SetRMWStatus(RMWStatus status)
3597     {
3598 #if !CPU_LOAD_STORE_ARCH
3599         gtRMWStatus = status;
3600 #endif
3601     }
3602
3603     GenTreePtr&     Data()      { return gtOp2; }
3604
3605     GenTreeStoreInd(var_types type, GenTree *destPtr, GenTree *data) :
3606     GenTreeIndir(GT_STOREIND, type, destPtr, data)
3607     {
3608         SetRMWStatusDefault();
3609     }
3610
3611 #if DEBUGGABLE_GENTREE
3612 protected:
3613     friend GenTree;
3614     // Used only for GenTree::GetVtableForOper()
3615     GenTreeStoreInd() : GenTreeIndir() { SetRMWStatusDefault(); }
3616 #endif
3617 };
3618
3619
3620 /* gtRetExp -- Place holder for the return expression from an inline candidate (GT_RET_EXPR) */
3621
3622 struct GenTreeRetExpr: public GenTree
3623 {
3624     GenTreePtr      gtInlineCandidate;
3625
3626     CORINFO_CLASS_HANDLE gtRetClsHnd;
3627
3628     GenTreeRetExpr(var_types type) :
3629         GenTree(GT_RET_EXPR, type)
3630         {}
3631 #if DEBUGGABLE_GENTREE
3632     GenTreeRetExpr() : GenTree() {}
3633 #endif
3634 };
3635
3636
3637 /* gtStmt   -- 'statement expr' (GT_STMT) */
3638
3639 class InlineContext;
3640
3641 struct GenTreeStmt: public GenTree
3642 {
3643     GenTreePtr      gtStmtExpr;      // root of the expression tree
3644     GenTreePtr      gtStmtList;      // first node (for forward walks)
3645     InlineContext*  gtInlineContext; // The inline context for this statement.
3646
3647 #if defined(DEBUGGING_SUPPORT) || defined(DEBUG)
3648     IL_OFFSETX      gtStmtILoffsx;   // instr offset (if available)
3649 #endif
3650
3651 #ifdef DEBUG
3652     IL_OFFSET       gtStmtLastILoffs;// instr offset at end of stmt
3653 #endif
3654
3655     bool            gtStmtIsTopLevel()
3656     {
3657         return (gtFlags & GTF_STMT_TOP_LEVEL) != 0;
3658     }
3659
3660     bool            gtStmtIsEmbedded()
3661     {
3662         return !gtStmtIsTopLevel();
3663     }
3664
3665     // Return the next statement, if it is embedded, otherwise nullptr
3666     GenTreeStmt*    gtStmtNextIfEmbedded()
3667     {
3668         GenTree* nextStmt = gtNext;
3669         if (nextStmt != nullptr && nextStmt->gtStmt.gtStmtIsEmbedded())
3670         {
3671             return nextStmt->AsStmt();
3672         }
3673         else
3674         {
3675             return nullptr;
3676         }
3677     }
3678
3679     GenTree*    gtStmtNextTopLevelStmt()
3680     {
3681         GenTree* nextStmt = gtNext;
3682         while (nextStmt != nullptr && nextStmt->gtStmt.gtStmtIsEmbedded())
3683         {
3684             nextStmt = nextStmt->gtNext;
3685         }
3686         return nextStmt;
3687     }
3688
3689     __declspec(property(get=getNextStmt))
3690     GenTreeStmt* gtNextStmt;
3691
3692     __declspec(property(get=getPrevStmt))
3693     GenTreeStmt* gtPrevStmt;
3694
3695     GenTreeStmt* getNextStmt()
3696     {
3697         if (gtNext == nullptr)
3698             return nullptr;
3699         else
3700             return gtNext->AsStmt();
3701     }
3702
3703     GenTreeStmt* getPrevStmt()
3704     {
3705         if (gtPrev == nullptr)
3706             return nullptr;
3707         else
3708             return gtPrev->AsStmt();
3709     }
3710
3711     GenTreeStmt(GenTreePtr expr, IL_OFFSETX offset)
3712         : GenTree(GT_STMT, TYP_VOID)
3713         , gtStmtExpr(expr)
3714         , gtStmtList(nullptr)
3715         , gtInlineContext(nullptr)
3716 #if defined(DEBUGGING_SUPPORT) || defined(DEBUG)
3717         , gtStmtILoffsx(offset)
3718 #endif
3719 #ifdef DEBUG
3720         , gtStmtLastILoffs(BAD_IL_OFFSET)
3721 #endif
3722     {
3723         // Statements can't have statements as part of their expression tree.
3724         assert(expr->gtOper != GT_STMT);
3725
3726         gtFlags |= GTF_STMT_TOP_LEVEL;
3727
3728         // Set the statement to have the same costs as the top node of the tree.
3729         // This is used long before costs have been assigned, so we need to copy
3730         // the raw costs.
3731         CopyRawCosts(expr);
3732     }
3733
3734 #if DEBUGGABLE_GENTREE
3735     GenTreeStmt() : GenTree(GT_STMT, TYP_VOID) {}
3736 #endif
3737 };
3738
3739
3740
3741
3742 /*  NOTE: Any tree nodes that are larger than 8 bytes (two ints or
3743     pointers) must be flagged as 'large' in GenTree::InitNodeSize().
3744  */
3745
3746
3747 /* gtClsVar -- 'static data member' (GT_CLS_VAR) */
3748
3749 struct GenTreeClsVar: public GenTree
3750 {
3751     CORINFO_FIELD_HANDLE    gtClsVarHnd;
3752     FieldSeqNode*           gtFieldSeq;
3753
3754     GenTreeClsVar(var_types type, CORINFO_FIELD_HANDLE clsVarHnd, FieldSeqNode* fldSeq) :
3755         GenTree(GT_CLS_VAR, type),
3756         gtClsVarHnd(clsVarHnd),
3757         gtFieldSeq(fldSeq)
3758         {
3759             gtFlags |= GTF_GLOB_REF;
3760         }
3761 #if DEBUGGABLE_GENTREE
3762     GenTreeClsVar() : GenTree() {}
3763 #endif
3764 };
3765
3766 /* gtArgPlace -- 'register argument placeholder' (GT_ARGPLACE) */
3767
3768 struct GenTreeArgPlace: public GenTree
3769 {
3770     CORINFO_CLASS_HANDLE    gtArgPlaceClsHnd;    // Needed when we have a TYP_STRUCT argument
3771
3772     GenTreeArgPlace(var_types type, CORINFO_CLASS_HANDLE clsHnd) :
3773         GenTree(GT_ARGPLACE, type),
3774         gtArgPlaceClsHnd(clsHnd)
3775         {}
3776 #if DEBUGGABLE_GENTREE
3777     GenTreeArgPlace() : GenTree() {}
3778 #endif
3779 };
3780
3781 /* gtLabel  -- code label target    (GT_LABEL) */
3782
3783 struct GenTreeLabel: public GenTree
3784 {
3785     BasicBlock* gtLabBB;
3786
3787     GenTreeLabel(BasicBlock* bb) :
3788         GenTree(GT_LABEL, TYP_VOID),
3789         gtLabBB(bb)
3790         {}
3791 #if DEBUGGABLE_GENTREE
3792     GenTreeLabel() : GenTree() {}
3793 #endif
3794 };
3795
3796 /* gtPhiArg -- phi node rhs argument, var = phi(phiarg, phiarg, phiarg...); GT_PHI_ARG */
3797 struct GenTreePhiArg: public GenTreeLclVarCommon
3798 {
3799     BasicBlock  *   gtPredBB;
3800
3801     GenTreePhiArg(var_types type, unsigned lclNum, unsigned snum, BasicBlock* block)
3802         : GenTreeLclVarCommon(GT_PHI_ARG, type, lclNum)
3803         , gtPredBB(block)
3804     {
3805         SetSsaNum(snum);
3806     }
3807
3808 #if DEBUGGABLE_GENTREE
3809     GenTreePhiArg() : GenTreeLclVarCommon() {}
3810 #endif
3811 };
3812
3813 /* gtPutArgStk -- Argument passed on stack */
3814
3815 struct GenTreePutArgStk: public GenTreeUnOp
3816 {
3817     unsigned gtSlotNum;        // Slot number of the argument to be passed on stack
3818
3819 #if FEATURE_FASTTAILCALL
3820     bool putInIncomingArgArea;    // Whether this arg needs to be placed in incoming arg area.
3821                                   // By default this is false and will be placed in out-going arg area.
3822                                   // Fast tail calls set this to true.
3823                                   // In future if we need to add more such bool fields consider bit fields.
3824
3825     GenTreePutArgStk(
3826             genTreeOps oper,
3827             var_types type,
3828             unsigned slotNum
3829             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(unsigned numSlots)
3830             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(bool isStruct),
3831             bool _putInIncomingArgArea = false
3832             DEBUGARG(GenTreePtr callNode = NULL)
3833             DEBUGARG(bool largeNode = false))
3834         :
3835         GenTreeUnOp(oper, type DEBUGARG(largeNode)),
3836         gtSlotNum(slotNum),
3837         putInIncomingArgArea(_putInIncomingArgArea)
3838 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3839         , gtPutArgStkKind(PutArgStkKindInvalid),
3840         gtNumSlots(numSlots),
3841         gtIsStruct(isStruct),
3842         gtNumberReferenceSlots(0),
3843         gtGcPtrs(nullptr)
3844 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3845     {
3846 #ifdef DEBUG
3847         gtCall = callNode;
3848 #endif
3849     }
3850
3851
3852     GenTreePutArgStk(
3853             genTreeOps oper,
3854             var_types type,
3855             GenTreePtr op1,
3856             unsigned slotNum
3857             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(unsigned numSlots)
3858             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(bool isStruct),
3859             bool _putInIncomingArgArea = false
3860             DEBUGARG(GenTreePtr callNode = NULL)
3861             DEBUGARG(bool largeNode = false))
3862         :
3863         GenTreeUnOp(oper, type, op1 DEBUGARG(largeNode)),
3864         gtSlotNum(slotNum),
3865         putInIncomingArgArea(_putInIncomingArgArea)
3866 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3867         , gtPutArgStkKind(PutArgStkKindInvalid),
3868         gtNumSlots(numSlots),
3869         gtIsStruct(isStruct),
3870         gtNumberReferenceSlots(0),
3871         gtGcPtrs(nullptr)
3872 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3873     {
3874 #ifdef DEBUG
3875         gtCall = callNode;
3876 #endif
3877     }
3878
3879 #else  // !FEATURE_FASTTAILCALL
3880
3881     GenTreePutArgStk(
3882             genTreeOps oper,
3883             var_types type,
3884             unsigned slotNum
3885             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(unsigned numSlots)
3886             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(bool isStruct)
3887             DEBUGARG(GenTreePtr callNode = NULL)
3888             DEBUGARG(bool largeNode = false))
3889         :
3890         GenTreeUnOp(oper, type DEBUGARG(largeNode)),
3891         gtSlotNum(slotNum)
3892 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3893         , gtPutArgStkKind(PutArgStkKindInvalid),
3894         gtNumSlots(numSlots),
3895         gtIsStruct(isStruct),
3896         gtNumberReferenceSlots(0),
3897         gtGcPtrs(nullptr)
3898 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3899     {
3900 #ifdef DEBUG
3901         gtCall = callNode;
3902 #endif
3903     }
3904
3905
3906     GenTreePutArgStk(
3907             genTreeOps oper,
3908             var_types type,
3909             GenTreePtr op1,
3910             unsigned slotNum
3911             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(unsigned numSlots)
3912             FEATURE_UNIX_AMD64_STRUCT_PASSING_ONLY_ARG(bool isStruct)
3913             DEBUGARG(GenTreePtr callNode = NULL)
3914             DEBUGARG(bool largeNode = false))
3915         :
3916         GenTreeUnOp(oper, type, op1 DEBUGARG(largeNode)),
3917         gtSlotNum(slotNum)
3918 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3919         , gtPutArgStkKind(PutArgStkKindInvalid),
3920         gtNumSlots(numSlots),
3921         gtIsStruct(isStruct),
3922         gtNumberReferenceSlots(0),
3923         gtGcPtrs(nullptr)
3924 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3925     {
3926 #ifdef DEBUG
3927         gtCall = callNode;
3928 #endif
3929     }
3930 #endif // FEATURE_FASTTAILCALL
3931
3932     unsigned getArgOffset() { return gtSlotNum * TARGET_POINTER_SIZE; }
3933
3934 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3935     unsigned getArgSize() { return gtNumSlots * TARGET_POINTER_SIZE; }
3936 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3937
3938 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3939     //------------------------------------------------------------------------
3940     // setGcPointers: Sets the number of references and the layout of the struct object returned by the VM.
3941     //
3942     // Arguments:
3943     //    numPointers - Number of pointer references.
3944     //    pointers    - layout of the struct (with pointers marked.)
3945     //
3946     // Return Value:
3947     //    None
3948     //
3949     // Notes:
3950     //    This data is used in the codegen for GT_PUTARG_STK to decide how to copy the struct to the stack by value.
3951     //    If no pointer references are used, block copying instructions are used.
3952     //    Otherwise the pointer reference slots are copied atomically in a way that gcinfo is emitted.
3953     //    Any non pointer references between the pointer reference slots are copied in block fashion.
3954     //
3955     void setGcPointers(unsigned numPointers, BYTE* pointers)
3956     {
3957         gtNumberReferenceSlots = numPointers;
3958         gtGcPtrs = pointers;
3959     }
3960 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3961
3962 #ifdef DEBUG
3963     GenTreePtr      gtCall;                // the call node to which this argument belongs
3964 #endif
3965
3966 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
3967     // Instruction selection: during codegen time, what code sequence we will be using
3968     // to encode this operation.
3969
3970     enum PutArgStkKind : __int8
3971     {
3972         PutArgStkKindInvalid,
3973         PutArgStkKindRepInstr,
3974         PutArgStkKindUnroll,
3975     };
3976
3977     PutArgStkKind gtPutArgStkKind;
3978
3979     unsigned gtNumSlots;              // Number of slots for the argument to be passed on stack
3980     bool     gtIsStruct;              // This stack arg is a struct.
3981     unsigned gtNumberReferenceSlots;  // Number of reference slots.
3982     BYTE*    gtGcPtrs;                // gcPointers
3983 #endif // FEATURE_UNIX_AMD64_STRUCT_PASSING
3984
3985 #if DEBUGGABLE_GENTREE
3986     GenTreePutArgStk() : GenTreeUnOp() {}
3987 #endif
3988 };
3989
3990 // Represents GT_COPY or GT_RELOAD node
3991 struct GenTreeCopyOrReload : public GenTreeUnOp
3992 {
3993     // State required to support copy/reload of a multi-reg call node.
3994     // First register is is always given by gtRegNum.
3995     //
3996 #if FEATURE_MULTIREG_RET
3997     regNumber gtOtherRegs[MAX_RET_REG_COUNT - 1];
3998 #endif
3999
4000     //----------------------------------------------------------
4001     // ClearOtherRegs: set gtOtherRegs to REG_NA.
4002     //
4003     // Arguments:
4004     //    None
4005     //
4006     // Return Value:
4007     //    None
4008     //
4009     void ClearOtherRegs()
4010     {
4011 #if FEATURE_MULTIREG_RET
4012         for (unsigned i = 0; i < MAX_RET_REG_COUNT - 1; ++i)
4013         {
4014             gtOtherRegs[i] = REG_NA;
4015         }
4016 #endif
4017     }
4018
4019     //-----------------------------------------------------------
4020     // GetRegNumByIdx: Get regNumber of ith position.
4021     //
4022     // Arguments:
4023     //    idx   -   register position.
4024     //
4025     // Return Value:
4026     //    Returns regNumber assigned to ith position.
4027     //
4028     regNumber GetRegNumByIdx(unsigned idx) const
4029     {
4030         assert(idx < MAX_RET_REG_COUNT);
4031
4032         if (idx == 0)
4033         {
4034             return gtRegNum;
4035         }
4036
4037 #if FEATURE_MULTIREG_RET
4038         return gtOtherRegs[idx - 1];
4039 #else
4040         return REG_NA;
4041 #endif
4042     }
4043
4044     //-----------------------------------------------------------
4045     // SetRegNumByIdx: Set the regNumber for ith position.
4046     //
4047     // Arguments:
4048     //    reg   -   reg number
4049     //    idx   -   register position.
4050     //
4051     // Return Value:
4052     //    None.
4053     //
4054     // TODO-ARM: Implement this routine for Arm64 and Arm32
4055     // TODO-X86: Implement this routine for x86
4056     void SetRegNumByIdx(regNumber reg, unsigned idx)
4057     {
4058         assert(idx < MAX_RET_REG_COUNT);
4059
4060         if (idx == 0)
4061         {
4062             gtRegNum = reg;
4063         }
4064 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
4065         else
4066         {
4067             gtOtherRegs[idx - 1] = reg;
4068             assert(gtOtherRegs[idx - 1] == reg);
4069         }
4070 #else
4071         else
4072         {
4073             unreached();
4074         }
4075 #endif
4076     }
4077
4078     //----------------------------------------------------------------------------
4079     // CopyOtherRegs: copy multi-reg state from the given copy/reload node to this
4080     // node.
4081     //
4082     // Arguments:
4083     //    from  -  GenTree node from which to copy multi-reg state
4084     //
4085     // Return Value:
4086     //    None
4087     //
4088     // TODO-ARM: Implement this routine for Arm64 and Arm32
4089     // TODO-X86: Implement this routine for x86
4090     void CopyOtherRegs(GenTreeCopyOrReload* from)
4091     {
4092         assert(OperGet() == from->OperGet());
4093
4094 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
4095         for (unsigned i = 0; i < MAX_RET_REG_COUNT - 1; ++i)
4096         {
4097             gtOtherRegs[i] = from->gtOtherRegs[i];
4098         }
4099 #endif
4100     }
4101
4102     GenTreeCopyOrReload(genTreeOps oper,
4103         var_types type,
4104         GenTree* op1) : GenTreeUnOp(oper, type, op1)
4105     {
4106         gtRegNum = REG_NA;
4107         ClearOtherRegs();
4108     }
4109
4110 #if DEBUGGABLE_GENTREE
4111     GenTreeCopyOrReload() : GenTreeUnOp() {}
4112 #endif
4113 };
4114
4115 //------------------------------------------------------------------------
4116 // Deferred inline functions of GenTree -- these need the subtypes above to
4117 // be defined already.
4118 //------------------------------------------------------------------------
4119
4120 //------------------------------------------------------------------------
4121 // IsFPZero: Checks whether this is a floating point constant with value 0.0
4122 //
4123 // Return Value:
4124 //    Returns true iff the tree is an GT_CNS_DBL, with value of 0.0.
4125
4126 inline bool GenTree::IsFPZero()
4127 {
4128     if ((gtOper == GT_CNS_DBL) && (gtDblCon.gtDconVal == 0.0))
4129         return true;
4130     return false;
4131 }
4132
4133 //------------------------------------------------------------------------
4134 // IsIntegralConst: Checks whether this is a constant node with the given value
4135 //
4136 // Arguments:
4137 //    constVal - the value of interest
4138 //
4139 // Return Value:
4140 //    Returns true iff the tree is an integral constant opcode, with
4141 //    the given value.
4142 //
4143 // Notes:
4144 //    Like gtIconVal, the argument is of ssize_t, so cannot check for
4145 //    long constants in a target-independent way.
4146
4147 inline bool GenTree::IsIntegralConst(ssize_t constVal)
4148
4149 {
4150     if ((gtOper == GT_CNS_INT) && (gtIntConCommon.IconValue() == constVal))
4151         return true;
4152
4153     if ((gtOper == GT_CNS_LNG) && (gtIntConCommon.LngValue() == constVal))
4154         return true;
4155
4156     return false;
4157 }
4158
4159 inline bool GenTree::IsBoxedValue()
4160 {
4161     assert(gtOper != GT_BOX || gtBox.BoxOp() != NULL);
4162     return (gtOper == GT_BOX) && (gtFlags & GTF_BOX_VALUE);
4163 }
4164
4165 inline GenTreePtr GenTree::MoveNext()
4166 {
4167     assert(IsList());
4168     return gtOp.gtOp2;
4169 }
4170
4171 #ifdef DEBUG
4172 //------------------------------------------------------------------------
4173 // IsListForMultiRegArg: Given an GenTree node that represents an argument
4174 //                       enforce (or don't enforce) the following invariant.
4175 //
4176 // For LEGACY_BACKEND or architectures that don't support MultiReg args
4177 // we don't allow a GT_LIST at all.
4178 //
4179 // Currently for AMD64 UNIX we allow a limited case where a GT_LIST is
4180 // allowed but every element must be a GT_LCL_FLD.
4181 //
4182 // For the future targets that allow for Multireg args (and this includes
4183 //  the current ARM64 target) we allow a GT_LIST of arbitrary nodes, these
4184 //  would typically start out as GT_LCL_VARs or GT_LCL_FLDS or GT_INDs,
4185 //  but could be changed into constants or GT_COMMA trees by the later
4186 //  optimization phases.
4187 //
4188 // Arguments:
4189 //    instance method for a GenTree node
4190 //
4191 // Return values:
4192 //    true:      the GenTree node is accepted as a valid argument
4193 //    false:     the GenTree node is not accepted as a valid argumeny
4194 //
4195 inline bool GenTree::IsListForMultiRegArg()
4196 {
4197     if (!IsList())
4198     {
4199         // We don't have a GT_LIST, so just return true.
4200         return true;
4201     }
4202     else  // We do have a GT_LIST
4203     {
4204 #if defined(LEGACY_BACKEND) || !FEATURE_MULTIREG_ARGS
4205
4206         // Not allowed to have a GT_LIST for an argument
4207         // unless we have a RyuJIT backend and FEATURE_MULTIREG_ARGS
4208
4209         return false;
4210
4211 #else  // we have RyuJIT backend and FEATURE_MULTIREG_ARGS
4212
4213 #ifdef FEATURE_UNIX_AMD64_STRUCT_PASSING
4214         // For UNIX ABI we currently only allow a GT_LIST of GT_LCL_FLDs nodes
4215         GenTree* gtListPtr = this;
4216         while (gtListPtr != nullptr)
4217         {
4218             // ToDo: fix UNIX_AMD64 so that we do not generate this kind of a List
4219             //  Note the list as currently created is malformed, as the last entry is a nullptr
4220             if (gtListPtr->Current() == nullptr)
4221                 break;
4222
4223             // Only a list of GT_LCL_FLDs is allowed
4224             if (gtListPtr->Current()->OperGet() != GT_LCL_FLD)
4225             {
4226                 return false;
4227             }
4228             gtListPtr = gtListPtr->MoveNext();
4229         }
4230 #endif  // FEATURE_UNIX_AMD64_STRUCT_PASSING
4231
4232         // Note that for non-UNIX ABI the GT_LIST may contain any node
4233         //
4234         // We allow this GT_LIST as an argument
4235         return true;
4236
4237 #endif  // RyuJIT backend and FEATURE_MULTIREG_ARGS
4238     }
4239 }
4240 #endif // DEBUG
4241
4242 inline GenTreePtr GenTree::Current()
4243 {
4244     assert(IsList());
4245     return gtOp.gtOp1;
4246 }
4247
4248 inline GenTreePtr *GenTree::pCurrent()
4249 {
4250     assert(IsList());
4251     return &(gtOp.gtOp1);
4252 }
4253
4254 inline GenTreePtr      GenTree::gtGetOp1()
4255 {
4256     return gtOp.gtOp1;
4257 }
4258
4259 #ifdef DEBUG
4260 /* static */
4261 inline bool GenTree::RequiresNonNullOp2(genTreeOps oper)
4262 {
4263     switch (oper)
4264     {
4265     case GT_ADD:
4266     case GT_SUB:
4267     case GT_MUL:
4268     case GT_DIV:
4269     case GT_MOD:
4270     case GT_UDIV:
4271     case GT_UMOD:
4272     case GT_OR:
4273     case GT_XOR:
4274     case GT_AND:
4275     case GT_LSH:
4276     case GT_RSH:
4277     case GT_RSZ:
4278     case GT_ROL:
4279     case GT_ROR:
4280     case GT_INDEX:
4281     case GT_ASG:
4282     case GT_ASG_ADD:
4283     case GT_ASG_SUB:
4284     case GT_ASG_MUL:
4285     case GT_ASG_DIV:
4286     case GT_ASG_MOD:
4287     case GT_ASG_UDIV:
4288     case GT_ASG_UMOD:
4289     case GT_ASG_OR:
4290     case GT_ASG_XOR:
4291     case GT_ASG_AND:
4292     case GT_ASG_LSH:
4293     case GT_ASG_RSH:
4294     case GT_ASG_RSZ:
4295     case GT_EQ:
4296     case GT_NE:
4297     case GT_LT:
4298     case GT_LE:
4299     case GT_GE:
4300     case GT_GT:
4301     case GT_COMMA:
4302     case GT_QMARK:
4303     case GT_COLON:
4304     case GT_MKREFANY:
4305     case GT_INITBLK:
4306     case GT_COPYBLK:
4307         return true;
4308     default:
4309         return false;
4310     }
4311 }
4312 #endif // DEBUG
4313
4314 inline GenTreePtr      GenTree::gtGetOp2()
4315 {
4316     /* gtOp.gtOp2 is only valid for GTK_BINOP nodes. */
4317
4318     GenTreePtr op2 = OperIsBinary() ? gtOp.gtOp2 : nullptr;
4319
4320     // This documents the genTreeOps for which gtOp.gtOp2 cannot be nullptr.
4321     // This helps prefix in its analyis of code which calls gtGetOp2()
4322
4323     assert((op2 != nullptr) || !RequiresNonNullOp2(gtOper));
4324
4325     return op2;
4326 }
4327
4328 inline GenTreePtr      GenTree::gtEffectiveVal(bool commaOnly)
4329 {
4330     switch (gtOper)
4331     {
4332     case GT_COMMA:
4333         return gtOp.gtOp2->gtEffectiveVal(commaOnly);
4334
4335     case GT_NOP:
4336         if (!commaOnly && gtOp.gtOp1 != NULL)
4337             return gtOp.gtOp1->gtEffectiveVal();
4338         break;
4339
4340     default:
4341         break;
4342     }
4343
4344     return this;
4345 }
4346
4347 inline GenTree*         GenTree::gtSkipReloadOrCopy()
4348 {
4349     // There can be only one reload or copy (we can't have a reload/copy of a reload/copy)
4350     if (gtOper == GT_RELOAD || gtOper == GT_COPY)
4351     {
4352         assert(gtGetOp1()->OperGet() != GT_RELOAD && gtGetOp1()->OperGet() != GT_COPY);
4353         return gtGetOp1();
4354     }
4355     return this;
4356 }
4357
4358 //-----------------------------------------------------------------------------------
4359 // IsMultiRegCall: whether a call node returning its value in more than one register
4360 //
4361 // Arguments:
4362 //     None
4363 //
4364 // Return Value:
4365 //     Returns true if this GenTree is a multi register returning call
4366 inline bool  GenTree::IsMultiRegCall() const
4367 {
4368     if (this->IsCall())
4369     {
4370         // We cannot use AsCall() as it is not declared const
4371         const GenTreeCall* call = reinterpret_cast<const GenTreeCall *>(this);
4372         return call->HasMultiRegRetVal();
4373     }
4374
4375     return false;
4376 }
4377
4378 //-------------------------------------------------------------------------
4379 // IsCopyOrReload: whether this is a GT_COPY or GT_RELOAD node.
4380 //
4381 // Arguments:
4382 //     None
4383 //
4384 // Return Value:
4385 //     Returns true if this GenTree is a copy or reload node.
4386 inline bool GenTree::IsCopyOrReload() const
4387 {
4388     return (gtOper == GT_COPY || gtOper == GT_RELOAD);
4389 }
4390
4391 //-----------------------------------------------------------------------------------
4392 // IsCopyOrReloadOfMultiRegCall: whether this is a GT_COPY or GT_RELOAD of a multi-reg
4393 // call node.
4394 //
4395 // Arguments:
4396 //     None
4397 //
4398 // Return Value:
4399 //     Returns true if this GenTree is a copy or reload of multi-reg call node.
4400 inline bool GenTree::IsCopyOrReloadOfMultiRegCall() const
4401 {
4402     if (IsCopyOrReload())
4403     {
4404         GenTree* t = const_cast<GenTree*>(this);
4405         return t->gtGetOp1()->IsMultiRegCall();
4406     }
4407
4408     return false;
4409 }
4410
4411 inline bool GenTree::IsCnsIntOrI() const
4412 {
4413     return (gtOper == GT_CNS_INT);
4414 }
4415
4416 inline bool GenTree::IsIntegralConst() const
4417 {
4418 #ifdef _TARGET_64BIT_
4419     return IsCnsIntOrI();
4420 #else // !_TARGET_64BIT_
4421     return ((gtOper == GT_CNS_INT) || (gtOper == GT_CNS_LNG));
4422 #endif // !_TARGET_64BIT_
4423 }
4424
4425 inline bool GenTree::IsIntCnsFitsInI32()
4426 {
4427 #ifdef _TARGET_64BIT_
4428     return IsCnsIntOrI() && ((int)gtIntConCommon.IconValue() == gtIntConCommon.IconValue());
4429 #else // !_TARGET_64BIT_
4430     return IsCnsIntOrI();
4431 #endif // !_TARGET_64BIT_
4432 }
4433
4434 inline bool GenTree::IsCnsFltOrDbl() const
4435 {
4436     return OperGet() == GT_CNS_DBL;
4437 }
4438
4439 inline bool GenTree::IsCnsNonZeroFltOrDbl()
4440 {
4441     if (OperGet() == GT_CNS_DBL)
4442     {
4443         double constValue = gtDblCon.gtDconVal;
4444         return *(__int64*)&constValue != 0;
4445     }
4446
4447     return false;
4448 }
4449
4450 inline bool GenTree::IsHelperCall() { return OperGet() == GT_CALL && gtCall.gtCallType == CT_HELPER; }
4451
4452 inline var_types GenTree::CastFromType() { return this->gtCast.CastOp()->TypeGet(); }
4453 inline var_types& GenTree::CastToType()  { return this->gtCast.gtCastType; }
4454
4455
4456 /*****************************************************************************/
4457
4458 #ifndef _HOST_64BIT_
4459 #include <poppack.h>
4460 #endif
4461
4462 /*****************************************************************************/
4463
4464 #if     SMALL_TREE_NODES
4465
4466 // In debug, on some platforms (e.g., when LATE_DISASM is defined), GenTreeIntCon is bigger than GenTreeLclFld.
4467 const
4468 size_t              TREE_NODE_SZ_SMALL = max(sizeof(GenTreeIntCon), sizeof(GenTreeLclFld));
4469
4470 #endif // SMALL_TREE_NODES
4471
4472 const
4473 size_t              TREE_NODE_SZ_LARGE = sizeof(GenTreeCall);
4474
4475 /*****************************************************************************
4476  * Types returned by GenTree::lvaLclVarRefs()
4477  */
4478
4479 enum varRefKinds
4480 {
4481     VR_INVARIANT  = 0x00,      // an invariant value
4482     VR_NONE       = 0x00,
4483     VR_IND_REF    = 0x01,      // an object reference
4484     VR_IND_SCL    = 0x02,      // a non-object reference
4485     VR_GLB_VAR    = 0x04,      // a global (clsVar)
4486 };
4487 // Add a temp define to avoid merge conflict.
4488 #define VR_IND_PTR VR_IND_REF
4489
4490 /*****************************************************************************/
4491 #endif  // !GENTREE_H
4492 /*****************************************************************************/
4493