Merge pull request #20203 from AndyAyersMS/FixGtIndexAddrTest
[platform/upstream/coreclr.git] / src / jit / lower.cpp
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                               Lower                                       XX
9 XX                                                                           XX
10 XX  Preconditions:                                                           XX
11 XX                                                                           XX
12 XX  Postconditions (for the nodes currently handled):                        XX
13 XX    - All operands requiring a register are explicit in the graph          XX
14 XX                                                                           XX
15 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
16 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
17 */
18
19 #include "jitpch.h"
20 #ifdef _MSC_VER
21 #pragma hdrstop
22 #endif
23
24 #include "lower.h"
25
26 #if !defined(_TARGET_64BIT_)
27 #include "decomposelongs.h"
28 #endif // !defined(_TARGET_64BIT_)
29
30 //------------------------------------------------------------------------
31 // MakeSrcContained: Make "childNode" a contained node
32 //
33 // Arguments:
34 //    parentNode - is a non-leaf node that can contain its 'childNode'
35 //    childNode  - is an op that will now be contained by its parent.
36 //
37 // Notes:
38 //    If 'childNode' it has any existing sources, they will now be sources for the parent.
39 //
40 void Lowering::MakeSrcContained(GenTree* parentNode, GenTree* childNode)
41 {
42     assert(!parentNode->OperIsLeaf());
43     assert(childNode->canBeContained());
44     childNode->SetContained();
45     assert(childNode->isContained());
46 }
47
48 //------------------------------------------------------------------------
49 // CheckImmedAndMakeContained: Checks if the 'childNode' is a containable immediate
50 //    and, if so, makes it contained.
51 //
52 // Arguments:
53 //    parentNode - is any non-leaf node
54 //    childNode  - is an child op of 'parentNode'
55 //
56 // Return value:
57 //     true if we are able to make childNode a contained immediate
58 //
59 bool Lowering::CheckImmedAndMakeContained(GenTree* parentNode, GenTree* childNode)
60 {
61     assert(!parentNode->OperIsLeaf());
62     // If childNode is a containable immediate
63     if (IsContainableImmed(parentNode, childNode))
64     {
65         // then make it contained within the parentNode
66         MakeSrcContained(parentNode, childNode);
67         return true;
68     }
69     return false;
70 }
71
72 //------------------------------------------------------------------------
73 // IsSafeToContainMem: Checks for conflicts between childNode and parentNode,
74 // and returns 'true' iff memory operand childNode can be contained in parentNode.
75 //
76 // Arguments:
77 //    parentNode - any non-leaf node
78 //    childNode  - some node that is an input to `parentNode`
79 //
80 // Return value:
81 //    true if it is safe to make childNode a contained memory operand.
82 //
83 bool Lowering::IsSafeToContainMem(GenTree* parentNode, GenTree* childNode)
84 {
85     m_scratchSideEffects.Clear();
86     m_scratchSideEffects.AddNode(comp, childNode);
87
88     for (GenTree* node = childNode->gtNext; node != parentNode; node = node->gtNext)
89     {
90         if (m_scratchSideEffects.InterferesWith(comp, node, false))
91         {
92             return false;
93         }
94     }
95
96     return true;
97 }
98
99 //------------------------------------------------------------------------
100
101 // This is the main entry point for Lowering.
102 GenTree* Lowering::LowerNode(GenTree* node)
103 {
104     assert(node != nullptr);
105     switch (node->gtOper)
106     {
107         case GT_IND:
108             TryCreateAddrMode(LIR::Use(BlockRange(), &node->gtOp.gtOp1, node), true);
109             ContainCheckIndir(node->AsIndir());
110             break;
111
112         case GT_STOREIND:
113             TryCreateAddrMode(LIR::Use(BlockRange(), &node->gtOp.gtOp1, node), true);
114             if (!comp->codeGen->gcInfo.gcIsWriteBarrierStoreIndNode(node))
115             {
116                 LowerStoreIndir(node->AsIndir());
117             }
118             break;
119
120         case GT_ADD:
121         {
122             GenTree* afterTransform = LowerAdd(node);
123             if (afterTransform != nullptr)
124             {
125                 return afterTransform;
126             }
127             __fallthrough;
128         }
129
130 #if !defined(_TARGET_64BIT_)
131         case GT_ADD_LO:
132         case GT_ADD_HI:
133         case GT_SUB_LO:
134         case GT_SUB_HI:
135 #endif
136         case GT_SUB:
137         case GT_AND:
138         case GT_OR:
139         case GT_XOR:
140             ContainCheckBinary(node->AsOp());
141             break;
142
143         case GT_MUL:
144         case GT_MULHI:
145 #if defined(_TARGET_X86_)
146         case GT_MUL_LONG:
147 #endif
148             ContainCheckMul(node->AsOp());
149             break;
150
151         case GT_UDIV:
152         case GT_UMOD:
153             if (!LowerUnsignedDivOrMod(node->AsOp()))
154             {
155                 ContainCheckDivOrMod(node->AsOp());
156             }
157             break;
158
159         case GT_DIV:
160         case GT_MOD:
161             return LowerSignedDivOrMod(node);
162
163         case GT_SWITCH:
164             return LowerSwitch(node);
165
166         case GT_CALL:
167             LowerCall(node);
168             break;
169
170         case GT_LT:
171         case GT_LE:
172         case GT_GT:
173         case GT_GE:
174         case GT_EQ:
175         case GT_NE:
176         case GT_TEST_EQ:
177         case GT_TEST_NE:
178         case GT_CMP:
179             return LowerCompare(node);
180
181         case GT_JTRUE:
182             return LowerJTrue(node->AsOp());
183
184         case GT_JMP:
185             LowerJmpMethod(node);
186             break;
187
188         case GT_RETURN:
189             LowerRet(node);
190             break;
191
192         case GT_RETURNTRAP:
193             ContainCheckReturnTrap(node->AsOp());
194             break;
195
196         case GT_CAST:
197             LowerCast(node);
198             break;
199
200 #if defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
201         case GT_ARR_BOUNDS_CHECK:
202 #ifdef FEATURE_SIMD
203         case GT_SIMD_CHK:
204 #endif // FEATURE_SIMD
205 #ifdef FEATURE_HW_INTRINSICS
206         case GT_HW_INTRINSIC_CHK:
207 #endif // FEATURE_HW_INTRINSICS
208             ContainCheckBoundsChk(node->AsBoundsChk());
209             break;
210 #endif // _TARGET_XARCH_
211         case GT_ARR_ELEM:
212             return LowerArrElem(node);
213
214         case GT_ARR_OFFSET:
215             ContainCheckArrOffset(node->AsArrOffs());
216             break;
217
218         case GT_ROL:
219         case GT_ROR:
220             LowerRotate(node);
221             break;
222
223 #ifndef _TARGET_64BIT_
224         case GT_LSH_HI:
225         case GT_RSH_LO:
226             ContainCheckShiftRotate(node->AsOp());
227             break;
228 #endif // !_TARGET_64BIT_
229
230         case GT_LSH:
231         case GT_RSH:
232         case GT_RSZ:
233 #if defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
234             LowerShift(node->AsOp());
235 #else
236             ContainCheckShiftRotate(node->AsOp());
237 #endif
238             break;
239
240         case GT_STORE_BLK:
241         case GT_STORE_OBJ:
242         case GT_STORE_DYN_BLK:
243         {
244             GenTreeBlk* blkNode = node->AsBlk();
245             TryCreateAddrMode(LIR::Use(BlockRange(), &blkNode->Addr(), blkNode), false);
246             LowerBlockStore(blkNode);
247         }
248         break;
249
250         case GT_LCLHEAP:
251             ContainCheckLclHeap(node->AsOp());
252             break;
253
254 #ifdef _TARGET_XARCH_
255         case GT_INTRINSIC:
256             ContainCheckIntrinsic(node->AsOp());
257             break;
258 #endif // _TARGET_XARCH_
259
260 #ifdef FEATURE_SIMD
261         case GT_SIMD:
262             LowerSIMD(node->AsSIMD());
263             break;
264 #endif // FEATURE_SIMD
265
266 #ifdef FEATURE_HW_INTRINSICS
267         case GT_HWIntrinsic:
268             LowerHWIntrinsic(node->AsHWIntrinsic());
269             break;
270 #endif // FEATURE_HW_INTRINSICS
271
272         case GT_LCL_FLD:
273         {
274             // We should only encounter this for lclVars that are lvDoNotEnregister.
275             verifyLclFldDoNotEnregister(node->AsLclVarCommon()->gtLclNum);
276             break;
277         }
278
279         case GT_LCL_VAR:
280             WidenSIMD12IfNecessary(node->AsLclVarCommon());
281             break;
282
283         case GT_STORE_LCL_VAR:
284             WidenSIMD12IfNecessary(node->AsLclVarCommon());
285             __fallthrough;
286
287         case GT_STORE_LCL_FLD:
288         {
289 #if defined(_TARGET_AMD64_) && defined(FEATURE_SIMD)
290             GenTreeLclVarCommon* const store = node->AsLclVarCommon();
291             if ((store->TypeGet() == TYP_SIMD8) != (store->gtOp1->TypeGet() == TYP_SIMD8))
292             {
293                 GenTreeUnOp* bitcast =
294                     new (comp, GT_BITCAST) GenTreeOp(GT_BITCAST, store->TypeGet(), store->gtOp1, nullptr);
295                 store->gtOp1 = bitcast;
296                 BlockRange().InsertBefore(store, bitcast);
297             }
298 #endif // _TARGET_AMD64_
299             // TODO-1stClassStructs: Once we remove the requirement that all struct stores
300             // are block stores (GT_STORE_BLK or GT_STORE_OBJ), here is where we would put the local
301             // store under a block store if codegen will require it.
302             if ((node->TypeGet() == TYP_STRUCT) && (node->gtGetOp1()->OperGet() != GT_PHI))
303             {
304 #if FEATURE_MULTIREG_RET
305                 GenTree* src = node->gtGetOp1();
306                 assert((src->OperGet() == GT_CALL) && src->AsCall()->HasMultiRegRetVal());
307 #else  // !FEATURE_MULTIREG_RET
308                 assert(!"Unexpected struct local store in Lowering");
309 #endif // !FEATURE_MULTIREG_RET
310             }
311             LowerStoreLoc(node->AsLclVarCommon());
312             break;
313         }
314
315 #if defined(_TARGET_ARM64_)
316         case GT_CMPXCHG:
317             CheckImmedAndMakeContained(node, node->AsCmpXchg()->gtOpComparand);
318             break;
319
320         case GT_XADD:
321             CheckImmedAndMakeContained(node, node->gtOp.gtOp2);
322             break;
323 #elif defined(_TARGET_XARCH_)
324         case GT_XADD:
325             if (node->IsUnusedValue())
326             {
327                 node->ClearUnusedValue();
328                 // Make sure the types are identical, since the node type is changed to VOID
329                 // CodeGen relies on op2's type to determine the instruction size.
330                 // Note that the node type cannot be a small int but the data operand can.
331                 assert(genActualType(node->gtGetOp2()->TypeGet()) == node->TypeGet());
332                 node->SetOper(GT_LOCKADD);
333                 node->gtType = TYP_VOID;
334                 CheckImmedAndMakeContained(node, node->gtGetOp2());
335             }
336             break;
337 #endif
338
339 #ifndef _TARGET_ARM_
340         // TODO-ARM-CQ: We should contain this as long as the offset fits.
341         case GT_OBJ:
342             if (node->AsObj()->Addr()->OperIsLocalAddr())
343             {
344                 node->AsObj()->Addr()->SetContained();
345             }
346             break;
347 #endif // !_TARGET_ARM_
348
349         default:
350             break;
351     }
352
353     return node->gtNext;
354 }
355
356 /**  -- Switch Lowering --
357  * The main idea of switch lowering is to keep transparency of the register requirements of this node
358  * downstream in LSRA.  Given that the switch instruction is inherently a control statement which in the JIT
359  * is represented as a simple tree node, at the time we actually generate code for it we end up
360  * generating instructions that actually modify the flow of execution that imposes complicated
361  * register requirement and lifetimes.
362  *
363  * So, for the purpose of LSRA, we want to have a more detailed specification of what a switch node actually
364  * means and more importantly, which and when do we need a register for each instruction we want to issue
365  * to correctly allocate them downstream.
366  *
367  * For this purpose, this procedure performs switch lowering in two different ways:
368  *
369  * a) Represent the switch statement as a zero-index jump table construct.  This means that for every destination
370  *    of the switch, we will store this destination in an array of addresses and the code generator will issue
371  *    a data section where this array will live and will emit code that based on the switch index, will indirect and
372  *    jump to the destination specified in the jump table.
373  *
374  *    For this transformation we introduce a new GT node called GT_SWITCH_TABLE that is a specialization of the switch
375  *    node for jump table based switches.
376  *    The overall structure of a GT_SWITCH_TABLE is:
377  *
378  *    GT_SWITCH_TABLE
379  *           |_________ localVar   (a temporary local that holds the switch index)
380  *           |_________ jumpTable  (this is a special node that holds the address of the jump table array)
381  *
382  *     Now, the way we morph a GT_SWITCH node into this lowered switch table node form is the following:
383  *
384  *    Input:     GT_SWITCH (inside a basic block whose Branch Type is BBJ_SWITCH)
385  *                    |_____ expr (an arbitrarily complex GT_NODE that represents the switch index)
386  *
387  *    This gets transformed into the following statements inside a BBJ_COND basic block (the target would be
388  *    the default case of the switch in case the conditional is evaluated to true).
389  *
390  *     ----- original block, transformed
391  *     GT_STORE_LCL_VAR tempLocal (a new temporary local variable used to store the switch index)
392  *        |_____ expr      (the index expression)
393  *
394  *     GT_JTRUE
395  *        |_____ GT_COND
396  *                 |_____ GT_GE
397  *                           |___ Int_Constant  (This constant is the index of the default case
398  *                                               that happens to be the highest index in the jump table).
399  *                           |___ tempLocal     (The local variable were we stored the index expression).
400  *
401  *     ----- new basic block
402  *     GT_SWITCH_TABLE
403  *        |_____ tempLocal
404  *        |_____ jumpTable (a new jump table node that now LSRA can allocate registers for explicitly
405  *                          and LinearCodeGen will be responsible to generate downstream).
406  *
407  *     This way there are no implicit temporaries.
408  *
409  * b) For small-sized switches, we will actually morph them into a series of conditionals of the form
410  *     if (case falls into the default){ goto jumpTable[size]; // last entry in the jump table is the default case }
411  *     (For the default case conditional, we'll be constructing the exact same code as the jump table case one).
412  *     else if (case == firstCase){ goto jumpTable[1]; }
413  *     else if (case == secondCase) { goto jumptable[2]; } and so on.
414  *
415  *     This transformation is of course made in JIT-IR, not downstream to CodeGen level, so this way we no longer
416  *     require internal temporaries to maintain the index we're evaluating plus we're using existing code from
417  *     LinearCodeGen to implement this instead of implement all the control flow constructs using InstrDscs and
418  *     InstrGroups downstream.
419  */
420
421 GenTree* Lowering::LowerSwitch(GenTree* node)
422 {
423     unsigned     jumpCnt;
424     unsigned     targetCnt;
425     BasicBlock** jumpTab;
426
427     assert(node->gtOper == GT_SWITCH);
428
429     // The first step is to build the default case conditional construct that is
430     // shared between both kinds of expansion of the switch node.
431
432     // To avoid confusion, we'll alias m_block to originalSwitchBB
433     // that represents the node we're morphing.
434     BasicBlock* originalSwitchBB = m_block;
435     LIR::Range& switchBBRange    = LIR::AsRange(originalSwitchBB);
436
437     // jumpCnt is the number of elements in the jump table array.
438     // jumpTab is the actual pointer to the jump table array.
439     // targetCnt is the number of unique targets in the jump table array.
440     jumpCnt   = originalSwitchBB->bbJumpSwt->bbsCount;
441     jumpTab   = originalSwitchBB->bbJumpSwt->bbsDstTab;
442     targetCnt = originalSwitchBB->NumSucc(comp);
443
444 // GT_SWITCH must be a top-level node with no use.
445 #ifdef DEBUG
446     {
447         LIR::Use use;
448         assert(!switchBBRange.TryGetUse(node, &use));
449     }
450 #endif
451
452     JITDUMP("Lowering switch " FMT_BB ", %d cases\n", originalSwitchBB->bbNum, jumpCnt);
453
454     // Handle a degenerate case: if the switch has only a default case, just convert it
455     // to an unconditional branch. This should only happen in minopts or with debuggable
456     // code.
457     if (targetCnt == 1)
458     {
459         JITDUMP("Lowering switch " FMT_BB ": single target; converting to BBJ_ALWAYS\n", originalSwitchBB->bbNum);
460         noway_assert(comp->opts.MinOpts() || comp->opts.compDbgCode);
461         if (originalSwitchBB->bbNext == jumpTab[0])
462         {
463             originalSwitchBB->bbJumpKind = BBJ_NONE;
464             originalSwitchBB->bbJumpDest = nullptr;
465         }
466         else
467         {
468             originalSwitchBB->bbJumpKind = BBJ_ALWAYS;
469             originalSwitchBB->bbJumpDest = jumpTab[0];
470         }
471         // Remove extra predecessor links if there was more than one case.
472         for (unsigned i = 1; i < jumpCnt; ++i)
473         {
474             (void)comp->fgRemoveRefPred(jumpTab[i], originalSwitchBB);
475         }
476
477         // We have to get rid of the GT_SWITCH node but a child might have side effects so just assign
478         // the result of the child subtree to a temp.
479         GenTree* rhs = node->gtOp.gtOp1;
480
481         unsigned lclNum               = comp->lvaGrabTemp(true DEBUGARG("Lowering is creating a new local variable"));
482         comp->lvaTable[lclNum].lvType = rhs->TypeGet();
483
484         GenTreeLclVar* store =
485             new (comp, GT_STORE_LCL_VAR) GenTreeLclVar(GT_STORE_LCL_VAR, rhs->TypeGet(), lclNum, BAD_IL_OFFSET);
486         store->gtOp1   = rhs;
487         store->gtFlags = (rhs->gtFlags & GTF_COMMON_MASK);
488         store->gtFlags |= GTF_VAR_DEF;
489
490         switchBBRange.InsertAfter(node, store);
491         switchBBRange.Remove(node);
492
493         return store;
494     }
495
496     noway_assert(jumpCnt >= 2);
497
498     // Spill the argument to the switch node into a local so that it can be used later.
499     unsigned blockWeight = originalSwitchBB->getBBWeight(comp);
500
501     LIR::Use use(switchBBRange, &(node->gtOp.gtOp1), node);
502     ReplaceWithLclVar(use);
503
504     // GT_SWITCH(indexExpression) is now two statements:
505     //   1. a statement containing 'asg' (for temp = indexExpression)
506     //   2. and a statement with GT_SWITCH(temp)
507
508     assert(node->gtOper == GT_SWITCH);
509     GenTree* temp = node->gtOp.gtOp1;
510     assert(temp->gtOper == GT_LCL_VAR);
511     unsigned   tempLclNum  = temp->gtLclVarCommon.gtLclNum;
512     LclVarDsc* tempVarDsc  = comp->lvaTable + tempLclNum;
513     var_types  tempLclType = temp->TypeGet();
514
515     BasicBlock* defaultBB   = jumpTab[jumpCnt - 1];
516     BasicBlock* followingBB = originalSwitchBB->bbNext;
517
518     /* Is the number of cases right for a test and jump switch? */
519     const bool fFirstCaseFollows = (followingBB == jumpTab[0]);
520     const bool fDefaultFollows   = (followingBB == defaultBB);
521
522     unsigned minSwitchTabJumpCnt = 2; // table is better than just 2 cmp/jcc
523
524     // This means really just a single cmp/jcc (aka a simple if/else)
525     if (fFirstCaseFollows || fDefaultFollows)
526     {
527         minSwitchTabJumpCnt++;
528     }
529
530 #if defined(_TARGET_ARM_)
531     // On ARM for small switch tables we will
532     // generate a sequence of compare and branch instructions
533     // because the code to load the base of the switch
534     // table is huge and hideous due to the relocation... :(
535     minSwitchTabJumpCnt += 2;
536 #endif // _TARGET_ARM_
537
538     // Once we have the temporary variable, we construct the conditional branch for
539     // the default case.  As stated above, this conditional is being shared between
540     // both GT_SWITCH lowering code paths.
541     // This condition is of the form: if (temp > jumpTableLength - 2){ goto jumpTable[jumpTableLength - 1]; }
542     GenTree* gtDefaultCaseCond = comp->gtNewOperNode(GT_GT, TYP_INT, comp->gtNewLclvNode(tempLclNum, tempLclType),
543                                                      comp->gtNewIconNode(jumpCnt - 2, genActualType(tempLclType)));
544
545     // Make sure we perform an unsigned comparison, just in case the switch index in 'temp'
546     // is now less than zero 0 (that would also hit the default case).
547     gtDefaultCaseCond->gtFlags |= GTF_UNSIGNED;
548
549     GenTree* gtDefaultCaseJump = comp->gtNewOperNode(GT_JTRUE, TYP_VOID, gtDefaultCaseCond);
550     gtDefaultCaseJump->gtFlags = node->gtFlags;
551
552     LIR::Range condRange = LIR::SeqTree(comp, gtDefaultCaseJump);
553     switchBBRange.InsertAtEnd(std::move(condRange));
554
555     BasicBlock* afterDefaultCondBlock = comp->fgSplitBlockAfterNode(originalSwitchBB, condRange.LastNode());
556
557     // afterDefaultCondBlock is now the switch, and all the switch targets have it as a predecessor.
558     // originalSwitchBB is now a BBJ_NONE, and there is a predecessor edge in afterDefaultCondBlock
559     // representing the fall-through flow from originalSwitchBB.
560     assert(originalSwitchBB->bbJumpKind == BBJ_NONE);
561     assert(originalSwitchBB->bbNext == afterDefaultCondBlock);
562     assert(afterDefaultCondBlock->bbJumpKind == BBJ_SWITCH);
563     assert(afterDefaultCondBlock->bbJumpSwt->bbsHasDefault);
564     assert(afterDefaultCondBlock->isEmpty()); // Nothing here yet.
565
566     // The GT_SWITCH code is still in originalSwitchBB (it will be removed later).
567
568     // Turn originalSwitchBB into a BBJ_COND.
569     originalSwitchBB->bbJumpKind = BBJ_COND;
570     originalSwitchBB->bbJumpDest = jumpTab[jumpCnt - 1];
571
572     // Fix the pred for the default case: the default block target still has originalSwitchBB
573     // as a predecessor, but the fgSplitBlockAfterStatement() moved all predecessors to point
574     // to afterDefaultCondBlock.
575     flowList* oldEdge = comp->fgRemoveRefPred(jumpTab[jumpCnt - 1], afterDefaultCondBlock);
576     comp->fgAddRefPred(jumpTab[jumpCnt - 1], originalSwitchBB, oldEdge);
577
578     bool useJumpSequence = jumpCnt < minSwitchTabJumpCnt;
579
580 #if defined(_TARGET_UNIX_) && defined(_TARGET_ARM_)
581     // Force using an inlined jumping instead switch table generation.
582     // Switch jump table is generated with incorrect values in CoreRT case,
583     // so any large switch will crash after loading to PC any such value.
584     // I think this is due to the fact that we use absolute addressing
585     // instead of relative. But in CoreRT is used as a rule relative
586     // addressing when we generate an executable.
587     // See also https://github.com/dotnet/coreclr/issues/13194
588     // Also https://github.com/dotnet/coreclr/pull/13197
589     useJumpSequence = useJumpSequence || comp->IsTargetAbi(CORINFO_CORERT_ABI);
590 #endif // defined(_TARGET_UNIX_) && defined(_TARGET_ARM_)
591
592     // If we originally had 2 unique successors, check to see whether there is a unique
593     // non-default case, in which case we can eliminate the switch altogether.
594     // Note that the single unique successor case is handled above.
595     BasicBlock* uniqueSucc = nullptr;
596     if (targetCnt == 2)
597     {
598         uniqueSucc = jumpTab[0];
599         noway_assert(jumpCnt >= 2);
600         for (unsigned i = 1; i < jumpCnt - 1; i++)
601         {
602             if (jumpTab[i] != uniqueSucc)
603             {
604                 uniqueSucc = nullptr;
605                 break;
606             }
607         }
608     }
609     if (uniqueSucc != nullptr)
610     {
611         // If the unique successor immediately follows this block, we have nothing to do -
612         // it will simply fall-through after we remove the switch, below.
613         // Otherwise, make this a BBJ_ALWAYS.
614         // Now, fixup the predecessor links to uniqueSucc.  In the original jumpTab:
615         //   jumpTab[i-1] was the default target, which we handled above,
616         //   jumpTab[0] is the first target, and we'll leave that predecessor link.
617         // Remove any additional predecessor links to uniqueSucc.
618         for (unsigned i = 1; i < jumpCnt - 1; ++i)
619         {
620             assert(jumpTab[i] == uniqueSucc);
621             (void)comp->fgRemoveRefPred(uniqueSucc, afterDefaultCondBlock);
622         }
623         if (afterDefaultCondBlock->bbNext == uniqueSucc)
624         {
625             afterDefaultCondBlock->bbJumpKind = BBJ_NONE;
626             afterDefaultCondBlock->bbJumpDest = nullptr;
627         }
628         else
629         {
630             afterDefaultCondBlock->bbJumpKind = BBJ_ALWAYS;
631             afterDefaultCondBlock->bbJumpDest = uniqueSucc;
632         }
633     }
634     // If the number of possible destinations is small enough, we proceed to expand the switch
635     // into a series of conditional branches, otherwise we follow the jump table based switch
636     // transformation.
637     else if (useJumpSequence || comp->compStressCompile(Compiler::STRESS_SWITCH_CMP_BR_EXPANSION, 50))
638     {
639         // Lower the switch into a series of compare and branch IR trees.
640         //
641         // In this case we will morph the node in the following way:
642         // 1. Generate a JTRUE statement to evaluate the default case. (This happens above.)
643         // 2. Start splitting the switch basic block into subsequent basic blocks, each of which will contain
644         //    a statement that is responsible for performing a comparison of the table index and conditional
645         //    branch if equal.
646
647         JITDUMP("Lowering switch " FMT_BB ": using compare/branch expansion\n", originalSwitchBB->bbNum);
648
649         // We'll use 'afterDefaultCondBlock' for the first conditional. After that, we'll add new
650         // blocks. If we end up not needing it at all (say, if all the non-default cases just fall through),
651         // we'll delete it.
652         bool        fUsedAfterDefaultCondBlock = false;
653         BasicBlock* currentBlock               = afterDefaultCondBlock;
654         LIR::Range* currentBBRange             = &LIR::AsRange(currentBlock);
655
656         // Walk to entries 0 to jumpCnt - 1. If a case target follows, ignore it and let it fall through.
657         // If no case target follows, the last one doesn't need to be a compare/branch: it can be an
658         // unconditional branch.
659         bool fAnyTargetFollows = false;
660         for (unsigned i = 0; i < jumpCnt - 1; ++i)
661         {
662             assert(currentBlock != nullptr);
663
664             // Remove the switch from the predecessor list of this case target's block.
665             // We'll add the proper new predecessor edge later.
666             flowList* oldEdge = comp->fgRemoveRefPred(jumpTab[i], afterDefaultCondBlock);
667
668             if (jumpTab[i] == followingBB)
669             {
670                 // This case label follows the switch; let it fall through.
671                 fAnyTargetFollows = true;
672                 continue;
673             }
674
675             // We need a block to put in the new compare and/or branch.
676             // If we haven't used the afterDefaultCondBlock yet, then use that.
677             if (fUsedAfterDefaultCondBlock)
678             {
679                 BasicBlock* newBlock = comp->fgNewBBafter(BBJ_NONE, currentBlock, true);
680                 comp->fgAddRefPred(newBlock, currentBlock); // The fall-through predecessor.
681                 currentBlock   = newBlock;
682                 currentBBRange = &LIR::AsRange(currentBlock);
683             }
684             else
685             {
686                 assert(currentBlock == afterDefaultCondBlock);
687                 fUsedAfterDefaultCondBlock = true;
688             }
689
690             // We're going to have a branch, either a conditional or unconditional,
691             // to the target. Set the target.
692             currentBlock->bbJumpDest = jumpTab[i];
693
694             // Wire up the predecessor list for the "branch" case.
695             comp->fgAddRefPred(jumpTab[i], currentBlock, oldEdge);
696
697             if (!fAnyTargetFollows && (i == jumpCnt - 2))
698             {
699                 // We're processing the last one, and there is no fall through from any case
700                 // to the following block, so we can use an unconditional branch to the final
701                 // case: there is no need to compare against the case index, since it's
702                 // guaranteed to be taken (since the default case was handled first, above).
703
704                 currentBlock->bbJumpKind = BBJ_ALWAYS;
705             }
706             else
707             {
708                 // Otherwise, it's a conditional branch. Set the branch kind, then add the
709                 // condition statement.
710                 currentBlock->bbJumpKind = BBJ_COND;
711
712                 // Now, build the conditional statement for the current case that is
713                 // being evaluated:
714                 // GT_JTRUE
715                 //   |__ GT_COND
716                 //          |____GT_EQ
717                 //                 |____ (switchIndex) (The temp variable)
718                 //                 |____ (ICon)        (The actual case constant)
719                 GenTree* gtCaseCond = comp->gtNewOperNode(GT_EQ, TYP_INT, comp->gtNewLclvNode(tempLclNum, tempLclType),
720                                                           comp->gtNewIconNode(i, tempLclType));
721                 GenTree*   gtCaseBranch = comp->gtNewOperNode(GT_JTRUE, TYP_VOID, gtCaseCond);
722                 LIR::Range caseRange    = LIR::SeqTree(comp, gtCaseBranch);
723                 currentBBRange->InsertAtEnd(std::move(caseRange));
724             }
725         }
726
727         if (fAnyTargetFollows)
728         {
729             // There is a fall-through to the following block. In the loop
730             // above, we deleted all the predecessor edges from the switch.
731             // In this case, we need to add one back.
732             comp->fgAddRefPred(currentBlock->bbNext, currentBlock);
733         }
734
735         if (!fUsedAfterDefaultCondBlock)
736         {
737             // All the cases were fall-through! We don't need this block.
738             // Convert it from BBJ_SWITCH to BBJ_NONE and unset the BBF_DONT_REMOVE flag
739             // so fgRemoveBlock() doesn't complain.
740             JITDUMP("Lowering switch " FMT_BB ": all switch cases were fall-through\n", originalSwitchBB->bbNum);
741             assert(currentBlock == afterDefaultCondBlock);
742             assert(currentBlock->bbJumpKind == BBJ_SWITCH);
743             currentBlock->bbJumpKind = BBJ_NONE;
744             currentBlock->bbFlags &= ~BBF_DONT_REMOVE;
745             comp->fgRemoveBlock(currentBlock, /* unreachable */ false); // It's an empty block.
746         }
747     }
748     else
749     {
750         // At this point the default case has already been handled and we need to generate a jump
751         // table based switch or a bit test based switch at the end of afterDefaultCondBlock. Both
752         // switch variants need the switch value so create the necessary LclVar node here.
753         GenTree*    switchValue      = comp->gtNewLclvNode(tempLclNum, tempLclType);
754         LIR::Range& switchBlockRange = LIR::AsRange(afterDefaultCondBlock);
755         switchBlockRange.InsertAtEnd(switchValue);
756
757         // Try generating a bit test based switch first,
758         // if that's not possible a jump table based switch will be generated.
759         if (!TryLowerSwitchToBitTest(jumpTab, jumpCnt, targetCnt, afterDefaultCondBlock, switchValue))
760         {
761             JITDUMP("Lowering switch " FMT_BB ": using jump table expansion\n", originalSwitchBB->bbNum);
762
763 #ifdef _TARGET_64BIT_
764             if (tempLclType != TYP_I_IMPL)
765             {
766                 // SWITCH_TABLE expects the switch value (the index into the jump table) to be TYP_I_IMPL.
767                 // Note that the switch value is unsigned so the cast should be unsigned as well.
768                 switchValue = comp->gtNewCastNode(TYP_I_IMPL, switchValue, true, TYP_U_IMPL);
769                 switchBlockRange.InsertAtEnd(switchValue);
770             }
771 #endif
772
773             GenTree* switchTable = comp->gtNewJmpTableNode();
774             GenTree* switchJump  = comp->gtNewOperNode(GT_SWITCH_TABLE, TYP_VOID, switchValue, switchTable);
775             switchBlockRange.InsertAfter(switchValue, switchTable, switchJump);
776
777             // this block no longer branches to the default block
778             afterDefaultCondBlock->bbJumpSwt->removeDefault();
779         }
780
781         comp->fgInvalidateSwitchDescMapEntry(afterDefaultCondBlock);
782     }
783
784     GenTree* next = node->gtNext;
785
786     // Get rid of the GT_SWITCH(temp).
787     switchBBRange.Remove(node->gtOp.gtOp1);
788     switchBBRange.Remove(node);
789
790     return next;
791 }
792
793 //------------------------------------------------------------------------
794 // TryLowerSwitchToBitTest: Attempts to transform a jump table switch into a bit test.
795 //
796 // Arguments:
797 //    jumpTable - The jump table
798 //    jumpCount - The number of blocks in the jump table
799 //    targetCount - The number of distinct blocks in the jump table
800 //    bbSwitch - The switch block
801 //    switchValue - A LclVar node that provides the switch value
802 //
803 // Return value:
804 //    true if the switch has been lowered to a bit test
805 //
806 // Notes:
807 //    If the jump table contains less than 32 (64 on 64 bit targets) entries and there
808 //    are at most 2 distinct jump targets then the jump table can be converted to a word
809 //    of bits where a 0 bit corresponds to one jump target and a 1 bit corresponds to the
810 //    other jump target. Instead of the indirect jump a BT-JCC sequence is used to jump
811 //    to the appropriate target:
812 //        mov eax, 245 ; jump table converted to a "bit table"
813 //        bt  eax, ebx ; ebx is supposed to contain the switch value
814 //        jc target1
815 //      target0:
816 //        ...
817 //      target1:
818 //    Such code is both shorter and faster (in part due to the removal of a memory load)
819 //    than the traditional jump table base code. And of course, it also avoids the need
820 //    to emit the jump table itself that can reach up to 256 bytes (for 64 entries).
821 //
822 bool Lowering::TryLowerSwitchToBitTest(
823     BasicBlock* jumpTable[], unsigned jumpCount, unsigned targetCount, BasicBlock* bbSwitch, GenTree* switchValue)
824 {
825 #ifndef _TARGET_XARCH_
826     // Other architectures may use this if they substitute GT_BT with equivalent code.
827     return false;
828 #else
829     assert(jumpCount >= 2);
830     assert(targetCount >= 2);
831     assert(bbSwitch->bbJumpKind == BBJ_SWITCH);
832     assert(switchValue->OperIs(GT_LCL_VAR));
833
834     //
835     // Quick check to see if it's worth going through the jump table. The bit test switch supports
836     // up to 2 targets but targetCount also includes the default block so we need to allow 3 targets.
837     // We'll ensure that there are only 2 targets when building the bit table.
838     //
839
840     if (targetCount > 3)
841     {
842         return false;
843     }
844
845     //
846     // The number of bits in the bit table is the same as the number of jump table entries. But the
847     // jump table also includes the default target (at the end) so we need to ignore it. The default
848     // has already been handled by a JTRUE(GT(switchValue, jumpCount - 2)) that LowerSwitch generates.
849     //
850
851     const unsigned bitCount = jumpCount - 1;
852
853     if (bitCount > (genTypeSize(TYP_I_IMPL) * 8))
854     {
855         return false;
856     }
857
858     //
859     // Build a bit table where a bit set to 0 corresponds to bbCase0 and a bit set to 1 corresponds to
860     // bbCase1. Simply use the first block in the jump table as bbCase1, later we can invert the bit
861     // table and/or swap the blocks if it's beneficial.
862     //
863
864     BasicBlock* bbCase0  = nullptr;
865     BasicBlock* bbCase1  = jumpTable[0];
866     size_t      bitTable = 1;
867
868     for (unsigned bitIndex = 1; bitIndex < bitCount; bitIndex++)
869     {
870         if (jumpTable[bitIndex] == bbCase1)
871         {
872             bitTable |= (size_t(1) << bitIndex);
873         }
874         else if (bbCase0 == nullptr)
875         {
876             bbCase0 = jumpTable[bitIndex];
877         }
878         else if (jumpTable[bitIndex] != bbCase0)
879         {
880             // If it's neither bbCase0 nor bbCase1 then it means we have 3 targets. There can't be more
881             // than 3 because of the check at the start of the function.
882             assert(targetCount == 3);
883             return false;
884         }
885     }
886
887     //
888     // One of the case blocks has to follow the switch block. This requirement could be avoided
889     // by adding a BBJ_ALWAYS block after the switch block but doing that sometimes negatively
890     // impacts register allocation.
891     //
892
893     if ((bbSwitch->bbNext != bbCase0) && (bbSwitch->bbNext != bbCase1))
894     {
895         return false;
896     }
897
898 #ifdef _TARGET_64BIT_
899     //
900     // See if we can avoid a 8 byte immediate on 64 bit targets. If all upper 32 bits are 1
901     // then inverting the bit table will make them 0 so that the table now fits in 32 bits.
902     // Note that this does not change the number of bits in the bit table, it just takes
903     // advantage of the fact that loading a 32 bit immediate into a 64 bit register zero
904     // extends the immediate value to 64 bit.
905     //
906
907     if (~bitTable <= UINT32_MAX)
908     {
909         bitTable = ~bitTable;
910         std::swap(bbCase0, bbCase1);
911     }
912 #endif
913
914     //
915     // Rewire the blocks as needed and figure out the condition to use for JCC.
916     //
917
918     genTreeOps bbSwitchCondition = GT_NONE;
919     bbSwitch->bbJumpKind         = BBJ_COND;
920
921     comp->fgRemoveAllRefPreds(bbCase1, bbSwitch);
922     comp->fgRemoveAllRefPreds(bbCase0, bbSwitch);
923
924     if (bbSwitch->bbNext == bbCase0)
925     {
926         // GT_LT + GTF_UNSIGNED generates JC so we jump to bbCase1 when the bit is set
927         bbSwitchCondition    = GT_LT;
928         bbSwitch->bbJumpDest = bbCase1;
929
930         comp->fgAddRefPred(bbCase0, bbSwitch);
931         comp->fgAddRefPred(bbCase1, bbSwitch);
932     }
933     else
934     {
935         assert(bbSwitch->bbNext == bbCase1);
936
937         // GT_GE + GTF_UNSIGNED generates JNC so we jump to bbCase0 when the bit is not set
938         bbSwitchCondition    = GT_GE;
939         bbSwitch->bbJumpDest = bbCase0;
940
941         comp->fgAddRefPred(bbCase0, bbSwitch);
942         comp->fgAddRefPred(bbCase1, bbSwitch);
943     }
944
945     //
946     // Append BT(bitTable, switchValue) and JCC(condition) to the switch block.
947     //
948
949     var_types bitTableType = (bitCount <= (genTypeSize(TYP_INT) * 8)) ? TYP_INT : TYP_LONG;
950     GenTree*  bitTableIcon = comp->gtNewIconNode(bitTable, bitTableType);
951     GenTree*  bitTest      = comp->gtNewOperNode(GT_BT, TYP_VOID, bitTableIcon, switchValue);
952     bitTest->gtFlags |= GTF_SET_FLAGS;
953     GenTreeCC* jcc = new (comp, GT_JCC) GenTreeCC(GT_JCC, bbSwitchCondition);
954     jcc->gtFlags |= GTF_UNSIGNED | GTF_USE_FLAGS;
955
956     LIR::AsRange(bbSwitch).InsertAfter(switchValue, bitTableIcon, bitTest, jcc);
957
958     return true;
959 #endif // _TARGET_XARCH_
960 }
961
962 // NOTE: this method deliberately does not update the call arg table. It must only
963 // be used by NewPutArg and LowerArg; these functions are responsible for updating
964 // the call arg table as necessary.
965 void Lowering::ReplaceArgWithPutArgOrBitcast(GenTree** argSlot, GenTree* putArgOrBitcast)
966 {
967     assert(argSlot != nullptr);
968     assert(*argSlot != nullptr);
969     assert(putArgOrBitcast->OperIsPutArg() || putArgOrBitcast->OperIs(GT_BITCAST));
970
971     GenTree* arg = *argSlot;
972
973     // Replace the argument with the putarg/copy
974     *argSlot                    = putArgOrBitcast;
975     putArgOrBitcast->gtOp.gtOp1 = arg;
976
977     // Insert the putarg/copy into the block
978     BlockRange().InsertAfter(arg, putArgOrBitcast);
979 }
980
981 //------------------------------------------------------------------------
982 // NewPutArg: rewrites the tree to put an arg in a register or on the stack.
983 //
984 // Arguments:
985 //    call - the call whose arg is being rewritten.
986 //    arg  - the arg being rewritten.
987 //    info - the fgArgTabEntry information for the argument.
988 //    type - the type of the argument.
989 //
990 // Return Value:
991 //    The new tree that was created to put the arg in the right place
992 //    or the incoming arg if the arg tree was not rewritten.
993 //
994 // Assumptions:
995 //    call, arg, and info must be non-null.
996 //
997 // Notes:
998 //    For System V systems with native struct passing (i.e. UNIX_AMD64_ABI defined)
999 //    this method allocates a single GT_PUTARG_REG for 1 eightbyte structs and a GT_FIELD_LIST of two GT_PUTARG_REGs
1000 //    for two eightbyte structs.
1001 //
1002 //    For STK passed structs the method generates GT_PUTARG_STK tree. For System V systems with native struct passing
1003 //    (i.e. UNIX_AMD64_ABI defined) this method also sets the GC pointers count and the pointers
1004 //    layout object, so the codegen of the GT_PUTARG_STK could use this for optimizing copying to the stack by value.
1005 //    (using block copy primitives for non GC pointers and a single TARGET_POINTER_SIZE copy with recording GC info.)
1006 //
1007 GenTree* Lowering::NewPutArg(GenTreeCall* call, GenTree* arg, fgArgTabEntry* info, var_types type)
1008 {
1009     assert(call != nullptr);
1010     assert(arg != nullptr);
1011     assert(info != nullptr);
1012
1013     GenTree* putArg         = nullptr;
1014     bool     updateArgTable = true;
1015
1016     bool isOnStack = true;
1017     isOnStack      = info->regNum == REG_STK;
1018
1019 #ifdef _TARGET_ARMARCH_
1020     // Mark contained when we pass struct
1021     // GT_FIELD_LIST is always marked contained when it is generated
1022     if (type == TYP_STRUCT)
1023     {
1024         arg->SetContained();
1025         if ((arg->OperGet() == GT_OBJ) && (arg->AsObj()->Addr()->OperGet() == GT_LCL_VAR_ADDR))
1026         {
1027             MakeSrcContained(arg, arg->AsObj()->Addr());
1028         }
1029     }
1030 #endif
1031
1032 #if FEATURE_ARG_SPLIT
1033     // Struct can be split into register(s) and stack on ARM
1034     if (info->isSplit)
1035     {
1036         assert(arg->OperGet() == GT_OBJ || arg->OperGet() == GT_FIELD_LIST);
1037         // TODO: Need to check correctness for FastTailCall
1038         if (call->IsFastTailCall())
1039         {
1040 #ifdef _TARGET_ARM_
1041             NYI_ARM("lower: struct argument by fast tail call");
1042 #endif // _TARGET_ARM_
1043         }
1044
1045         putArg = new (comp, GT_PUTARG_SPLIT)
1046             GenTreePutArgSplit(arg, info->slotNum PUT_STRUCT_ARG_STK_ONLY_ARG(info->numSlots), info->numRegs,
1047                                call->IsFastTailCall(), call);
1048
1049         // If struct argument is morphed to GT_FIELD_LIST node(s),
1050         // we can know GC info by type of each GT_FIELD_LIST node.
1051         // So we skip setting GC Pointer info.
1052         //
1053         GenTreePutArgSplit* argSplit = putArg->AsPutArgSplit();
1054         for (unsigned regIndex = 0; regIndex < info->numRegs; regIndex++)
1055         {
1056             argSplit->SetRegNumByIdx(info->getRegNum(regIndex), regIndex);
1057         }
1058
1059         if (arg->OperGet() == GT_OBJ)
1060         {
1061             BYTE*       gcLayout = nullptr;
1062             unsigned    numRefs  = 0;
1063             GenTreeObj* argObj   = arg->AsObj();
1064
1065             if (argObj->IsGCInfoInitialized())
1066             {
1067                 gcLayout = argObj->gtGcPtrs;
1068                 numRefs  = argObj->GetGcPtrCount();
1069             }
1070             else
1071             {
1072                 // Set GC Pointer info
1073                 gcLayout = new (comp, CMK_Codegen) BYTE[info->numSlots + info->numRegs];
1074                 numRefs  = comp->info.compCompHnd->getClassGClayout(arg->gtObj.gtClass, gcLayout);
1075                 argSplit->setGcPointers(numRefs, gcLayout);
1076             }
1077
1078             // Set type of registers
1079             for (unsigned index = 0; index < info->numRegs; index++)
1080             {
1081                 var_types regType = comp->getJitGCType(gcLayout[index]);
1082                 // Account for the possibility that float fields may be passed in integer registers.
1083                 if (varTypeIsFloating(regType) && !genIsValidFloatReg(argSplit->GetRegNumByIdx(index)))
1084                 {
1085                     regType = (regType == TYP_FLOAT) ? TYP_INT : TYP_LONG;
1086                 }
1087                 argSplit->m_regType[index] = regType;
1088             }
1089         }
1090         else
1091         {
1092             GenTreeFieldList* fieldListPtr = arg->AsFieldList();
1093             for (unsigned index = 0; index < info->numRegs; fieldListPtr = fieldListPtr->Rest(), index++)
1094             {
1095                 var_types regType = fieldListPtr->gtGetOp1()->TypeGet();
1096                 // Account for the possibility that float fields may be passed in integer registers.
1097                 if (varTypeIsFloating(regType) && !genIsValidFloatReg(argSplit->GetRegNumByIdx(index)))
1098                 {
1099                     regType = (regType == TYP_FLOAT) ? TYP_INT : TYP_LONG;
1100                 }
1101                 argSplit->m_regType[index] = regType;
1102
1103                 // Clear the register assignments on the fieldList nodes, as these are contained.
1104                 fieldListPtr->gtRegNum = REG_NA;
1105             }
1106         }
1107     }
1108     else
1109 #endif // FEATURE_ARG_SPLIT
1110     {
1111         if (!isOnStack)
1112         {
1113 #if FEATURE_MULTIREG_ARGS
1114             if ((info->numRegs > 1) && (arg->OperGet() == GT_FIELD_LIST))
1115             {
1116                 assert(arg->OperGet() == GT_FIELD_LIST);
1117
1118                 assert(arg->AsFieldList()->IsFieldListHead());
1119                 unsigned int regIndex = 0;
1120                 for (GenTreeFieldList* fieldListPtr = arg->AsFieldList(); fieldListPtr != nullptr;
1121                      fieldListPtr                   = fieldListPtr->Rest())
1122                 {
1123                     regNumber argReg = info->getRegNum(regIndex);
1124                     GenTree*  curOp  = fieldListPtr->gtOp.gtOp1;
1125                     var_types curTyp = curOp->TypeGet();
1126
1127                     // Create a new GT_PUTARG_REG node with op1
1128                     GenTree* newOper = comp->gtNewPutArgReg(curTyp, curOp, argReg);
1129
1130                     // Splice in the new GT_PUTARG_REG node in the GT_FIELD_LIST
1131                     ReplaceArgWithPutArgOrBitcast(&fieldListPtr->gtOp.gtOp1, newOper);
1132                     regIndex++;
1133
1134                     // Initialize all the gtRegNum's since the list won't be traversed in an LIR traversal.
1135                     fieldListPtr->gtRegNum = REG_NA;
1136                 }
1137
1138                 // Just return arg. The GT_FIELD_LIST is not replaced.
1139                 // Nothing more to do.
1140                 return arg;
1141             }
1142             else
1143 #endif // FEATURE_MULTIREG_ARGS
1144             {
1145                 putArg = comp->gtNewPutArgReg(type, arg, info->regNum);
1146             }
1147         }
1148         else
1149         {
1150             // Mark this one as tail call arg if it is a fast tail call.
1151             // This provides the info to put this argument in in-coming arg area slot
1152             // instead of in out-going arg area slot.
1153
1154             // Make sure state is correct. The PUTARG_STK has TYP_VOID, as it doesn't produce
1155             // a result. So the type of its operand must be the correct type to push on the stack.
1156             // For a FIELD_LIST, this will be the type of the field (not the type of the arg),
1157             // but otherwise it is generally the type of the operand.
1158             info->checkIsStruct();
1159             if ((arg->OperGet() != GT_FIELD_LIST))
1160             {
1161 #if defined(FEATURE_SIMD) && defined(FEATURE_PUT_STRUCT_ARG_STK)
1162                 if (type == TYP_SIMD12)
1163                 {
1164                     assert(info->numSlots == 3);
1165                 }
1166                 else
1167 #endif // defined(FEATURE_SIMD) && defined(FEATURE_PUT_STRUCT_ARG_STK)
1168                 {
1169                     assert(genActualType(arg->TypeGet()) == type);
1170                 }
1171             }
1172
1173             putArg =
1174                 new (comp, GT_PUTARG_STK) GenTreePutArgStk(GT_PUTARG_STK, TYP_VOID, arg,
1175                                                            info->slotNum PUT_STRUCT_ARG_STK_ONLY_ARG(info->numSlots),
1176                                                            call->IsFastTailCall(), call);
1177
1178 #ifdef FEATURE_PUT_STRUCT_ARG_STK
1179             // If the ArgTabEntry indicates that this arg is a struct
1180             // get and store the number of slots that are references.
1181             // This is later used in the codegen for PUT_ARG_STK implementation
1182             // for struct to decide whether and how many single eight-byte copies
1183             // to be done (only for reference slots), so gcinfo is emitted.
1184             // For non-reference slots faster/smaller size instructions are used -
1185             // pair copying using XMM registers or rep mov instructions.
1186             if (info->isStruct)
1187             {
1188                 // We use GT_OBJ only for non-lclVar, non-SIMD, non-FIELD_LIST struct arguments.
1189                 if (arg->OperIsLocal())
1190                 {
1191                     // This must have a type with a known size (SIMD or has been morphed to a primitive type).
1192                     assert(arg->TypeGet() != TYP_STRUCT);
1193                 }
1194                 else if (arg->OperIs(GT_OBJ))
1195                 {
1196                     unsigned numRefs  = 0;
1197                     BYTE*    gcLayout = new (comp, CMK_Codegen) BYTE[info->numSlots];
1198                     assert(!varTypeIsSIMD(arg));
1199                     numRefs = comp->info.compCompHnd->getClassGClayout(arg->gtObj.gtClass, gcLayout);
1200                     putArg->AsPutArgStk()->setGcPointers(numRefs, gcLayout);
1201
1202 #ifdef _TARGET_X86_
1203                     // On x86 VM lies about the type of a struct containing a pointer sized
1204                     // integer field by returning the type of its field as the type of struct.
1205                     // Such struct can be passed in a register depending its position in
1206                     // parameter list.  VM does this unwrapping only one level and therefore
1207                     // a type like Struct Foo { Struct Bar { int f}} awlays needs to be
1208                     // passed on stack.  Also, VM doesn't lie about type of such a struct
1209                     // when it is a field of another struct.  That is VM doesn't lie about
1210                     // the type of Foo.Bar
1211                     //
1212                     // We now support the promotion of fields that are of type struct.
1213                     // However we only support a limited case where the struct field has a
1214                     // single field and that single field must be a scalar type. Say Foo.Bar
1215                     // field is getting passed as a parameter to a call, Since it is a TYP_STRUCT,
1216                     // as per x86 ABI it should always be passed on stack.  Therefore GenTree
1217                     // node under a PUTARG_STK could be GT_OBJ(GT_LCL_VAR_ADDR(v1)), where
1218                     // local v1 could be a promoted field standing for Foo.Bar.  Note that
1219                     // the type of v1 will be the type of field of Foo.Bar.f when Foo is
1220                     // promoted.  That is v1 will be a scalar type.  In this case we need to
1221                     // pass v1 on stack instead of in a register.
1222                     //
1223                     // TODO-PERF: replace GT_OBJ(GT_LCL_VAR_ADDR(v1)) with v1 if v1 is
1224                     // a scalar type and the width of GT_OBJ matches the type size of v1.
1225                     // Note that this cannot be done till call node arguments are morphed
1226                     // because we should not lose the fact that the type of argument is
1227                     // a struct so that the arg gets correctly marked to be passed on stack.
1228                     GenTree* objOp1 = arg->gtGetOp1();
1229                     if (objOp1->OperGet() == GT_LCL_VAR_ADDR)
1230                     {
1231                         unsigned lclNum = objOp1->AsLclVarCommon()->GetLclNum();
1232                         if (comp->lvaTable[lclNum].lvType != TYP_STRUCT)
1233                         {
1234                             comp->lvaSetVarDoNotEnregister(lclNum DEBUGARG(Compiler::DNER_VMNeedsStackAddr));
1235                         }
1236                     }
1237 #endif // _TARGET_X86_
1238                 }
1239                 else if (!arg->OperIs(GT_FIELD_LIST))
1240                 {
1241                     assert(varTypeIsSIMD(arg) || (info->numSlots == 1));
1242                 }
1243             }
1244 #endif // FEATURE_PUT_STRUCT_ARG_STK
1245         }
1246     }
1247
1248     JITDUMP("new node is : ");
1249     DISPNODE(putArg);
1250     JITDUMP("\n");
1251
1252     if (arg->gtFlags & GTF_LATE_ARG)
1253     {
1254         putArg->gtFlags |= GTF_LATE_ARG;
1255     }
1256     else if (updateArgTable)
1257     {
1258         info->node = putArg;
1259     }
1260     return putArg;
1261 }
1262
1263 //------------------------------------------------------------------------
1264 // LowerArg: Lower one argument of a call. This entails splicing a "putarg" node between
1265 // the argument evaluation and the call. This is the point at which the source is
1266 // consumed and the value transitions from control of the register allocator to the calling
1267 // convention.
1268 //
1269 // Arguments:
1270 //    call  - The call node
1271 //    ppArg - Pointer to the call argument pointer. We might replace the call argument by
1272 //            changing *ppArg.
1273 //
1274 // Return Value:
1275 //    None.
1276 //
1277 void Lowering::LowerArg(GenTreeCall* call, GenTree** ppArg)
1278 {
1279     GenTree* arg = *ppArg;
1280
1281     JITDUMP("lowering arg : ");
1282     DISPNODE(arg);
1283
1284     // No assignments should remain by Lowering.
1285     assert(!arg->OperIs(GT_ASG));
1286     assert(!arg->OperIsPutArgStk());
1287
1288     // Assignments/stores at this level are not really placing an argument.
1289     // They are setting up temporary locals that will later be placed into
1290     // outgoing regs or stack.
1291     // Note that atomic ops may be stores and still produce a value.
1292     if (!arg->IsValue())
1293     {
1294         assert((arg->OperIsStore() && !arg->IsValue()) || arg->IsArgPlaceHolderNode() || arg->IsNothingNode() ||
1295                arg->OperIsCopyBlkOp());
1296         return;
1297     }
1298
1299     fgArgTabEntry* info = comp->gtArgEntryByNode(call, arg);
1300     assert(info->node == arg);
1301     var_types type = arg->TypeGet();
1302
1303     if (varTypeIsSmall(type))
1304     {
1305         // Normalize 'type', it represents the item that we will be storing in the Outgoing Args
1306         type = TYP_INT;
1307     }
1308
1309 #if defined(FEATURE_SIMD)
1310 #if defined(_TARGET_X86_)
1311     // Non-param TYP_SIMD12 local var nodes are massaged in Lower to TYP_SIMD16 to match their
1312     // allocated size (see lvSize()). However, when passing the variables as arguments, and
1313     // storing the variables to the outgoing argument area on the stack, we must use their
1314     // actual TYP_SIMD12 type, so exactly 12 bytes is allocated and written.
1315     if (type == TYP_SIMD16)
1316     {
1317         if ((arg->OperGet() == GT_LCL_VAR) || (arg->OperGet() == GT_STORE_LCL_VAR))
1318         {
1319             unsigned   varNum = arg->AsLclVarCommon()->GetLclNum();
1320             LclVarDsc* varDsc = &comp->lvaTable[varNum];
1321             type              = varDsc->lvType;
1322         }
1323         else if (arg->OperGet() == GT_SIMD)
1324         {
1325             assert((arg->AsSIMD()->gtSIMDSize == 16) || (arg->AsSIMD()->gtSIMDSize == 12));
1326
1327             if (arg->AsSIMD()->gtSIMDSize == 12)
1328             {
1329                 type = TYP_SIMD12;
1330             }
1331         }
1332     }
1333 #elif defined(_TARGET_AMD64_)
1334     // TYP_SIMD8 parameters that are passed as longs
1335     if (type == TYP_SIMD8 && genIsValidIntReg(info->regNum))
1336     {
1337         GenTreeUnOp* bitcast = new (comp, GT_BITCAST) GenTreeOp(GT_BITCAST, TYP_LONG, arg, nullptr);
1338         BlockRange().InsertAfter(arg, bitcast);
1339
1340         info->node = *ppArg = arg = bitcast;
1341         type                      = TYP_LONG;
1342     }
1343 #endif // defined(_TARGET_X86_)
1344 #endif // defined(FEATURE_SIMD)
1345
1346     // If we hit this we are probably double-lowering.
1347     assert(!arg->OperIsPutArg());
1348
1349 #if !defined(_TARGET_64BIT_)
1350     if (varTypeIsLong(type))
1351     {
1352         bool isReg = (info->regNum != REG_STK);
1353         if (isReg)
1354         {
1355             noway_assert(arg->OperGet() == GT_LONG);
1356             assert(info->numRegs == 2);
1357
1358             GenTree* argLo = arg->gtGetOp1();
1359             GenTree* argHi = arg->gtGetOp2();
1360
1361             GenTreeFieldList* fieldList = new (comp, GT_FIELD_LIST) GenTreeFieldList(argLo, 0, TYP_INT, nullptr);
1362             // Only the first fieldList node (GTF_FIELD_LIST_HEAD) is in the instruction sequence.
1363             (void)new (comp, GT_FIELD_LIST) GenTreeFieldList(argHi, 4, TYP_INT, fieldList);
1364             GenTree* putArg = NewPutArg(call, fieldList, info, type);
1365
1366             BlockRange().InsertBefore(arg, putArg);
1367             BlockRange().Remove(arg);
1368             *ppArg     = fieldList;
1369             info->node = fieldList;
1370         }
1371         else
1372         {
1373             assert(arg->OperGet() == GT_LONG);
1374             // For longs, we will replace the GT_LONG with a GT_FIELD_LIST, and put that under a PUTARG_STK.
1375             // Although the hi argument needs to be pushed first, that will be handled by the general case,
1376             // in which the fields will be reversed.
1377             assert(info->numSlots == 2);
1378             GenTree*          argLo     = arg->gtGetOp1();
1379             GenTree*          argHi     = arg->gtGetOp2();
1380             GenTreeFieldList* fieldList = new (comp, GT_FIELD_LIST) GenTreeFieldList(argLo, 0, TYP_INT, nullptr);
1381             // Only the first fieldList node (GTF_FIELD_LIST_HEAD) is in the instruction sequence.
1382             (void)new (comp, GT_FIELD_LIST) GenTreeFieldList(argHi, 4, TYP_INT, fieldList);
1383             GenTree* putArg  = NewPutArg(call, fieldList, info, type);
1384             putArg->gtRegNum = info->regNum;
1385
1386             // We can't call ReplaceArgWithPutArgOrBitcast here because it presumes that we are keeping the original
1387             // arg.
1388             BlockRange().InsertBefore(arg, fieldList, putArg);
1389             BlockRange().Remove(arg);
1390             *ppArg = putArg;
1391         }
1392     }
1393     else
1394 #endif // !defined(_TARGET_64BIT_)
1395     {
1396
1397 #ifdef _TARGET_ARMARCH_
1398         if (call->IsVarargs() || comp->opts.compUseSoftFP)
1399         {
1400             // For vararg call or on armel, reg args should be all integer.
1401             // Insert copies as needed to move float value to integer register.
1402             GenTree* newNode = LowerFloatArg(ppArg, info);
1403             if (newNode != nullptr)
1404             {
1405                 type = newNode->TypeGet();
1406             }
1407         }
1408 #endif // _TARGET_ARMARCH_
1409
1410         GenTree* putArg = NewPutArg(call, arg, info, type);
1411
1412         // In the case of register passable struct (in one or two registers)
1413         // the NewPutArg returns a new node (GT_PUTARG_REG or a GT_FIELD_LIST with two GT_PUTARG_REGs.)
1414         // If an extra node is returned, splice it in the right place in the tree.
1415         if (arg != putArg)
1416         {
1417             ReplaceArgWithPutArgOrBitcast(ppArg, putArg);
1418         }
1419     }
1420 }
1421
1422 #ifdef _TARGET_ARMARCH_
1423 //------------------------------------------------------------------------
1424 // LowerFloatArg: Lower float call arguments on the arm platform.
1425 //
1426 // Arguments:
1427 //    arg  - The arg node
1428 //    info - call argument info
1429 //
1430 // Return Value:
1431 //    Return nullptr, if no transformation was done;
1432 //    return arg if there was in place transformation;
1433 //    return a new tree if the root was changed.
1434 //
1435 // Notes:
1436 //    This must handle scalar float arguments as well as GT_FIELD_LISTs
1437 //    with floating point fields.
1438 //
1439 GenTree* Lowering::LowerFloatArg(GenTree** pArg, fgArgTabEntry* info)
1440 {
1441     GenTree* arg = *pArg;
1442     if (info->regNum != REG_STK)
1443     {
1444         if (arg->OperIsFieldList())
1445         {
1446             GenTreeFieldList* currListNode  = arg->AsFieldList();
1447             regNumber         currRegNumber = info->regNum;
1448
1449             // Transform fields that are passed as registers in place.
1450             unsigned fieldRegCount;
1451             for (unsigned i = 0; i < info->numRegs; i += fieldRegCount)
1452             {
1453                 assert(currListNode != nullptr);
1454                 GenTree* node = currListNode->Current();
1455                 if (varTypeIsFloating(node))
1456                 {
1457                     GenTree* intNode = LowerFloatArgReg(node, currRegNumber);
1458                     assert(intNode != nullptr);
1459
1460                     ReplaceArgWithPutArgOrBitcast(currListNode->pCurrent(), intNode);
1461                     currListNode->ChangeType(intNode->TypeGet());
1462                 }
1463
1464                 if (node->TypeGet() == TYP_DOUBLE)
1465                 {
1466                     currRegNumber = REG_NEXT(REG_NEXT(currRegNumber));
1467                     fieldRegCount = 2;
1468                 }
1469                 else
1470                 {
1471                     currRegNumber = REG_NEXT(currRegNumber);
1472                     fieldRegCount = 1;
1473                 }
1474                 currListNode = currListNode->Rest();
1475             }
1476             // List fields were replaced in place.
1477             return arg;
1478         }
1479         else if (varTypeIsFloating(arg))
1480         {
1481             GenTree* intNode = LowerFloatArgReg(arg, info->regNum);
1482             assert(intNode != nullptr);
1483             ReplaceArgWithPutArgOrBitcast(pArg, intNode);
1484             return *pArg;
1485         }
1486     }
1487     return nullptr;
1488 }
1489
1490 //------------------------------------------------------------------------
1491 // LowerFloatArgReg: Lower the float call argument node that is passed via register.
1492 //
1493 // Arguments:
1494 //    arg    - The arg node
1495 //    regNum - register number
1496 //
1497 // Return Value:
1498 //    Return new bitcast node, that moves float to int register.
1499 //
1500 GenTree* Lowering::LowerFloatArgReg(GenTree* arg, regNumber regNum)
1501 {
1502     var_types floatType = arg->TypeGet();
1503     assert(varTypeIsFloating(floatType));
1504     var_types intType = (floatType == TYP_DOUBLE) ? TYP_LONG : TYP_INT;
1505     GenTree*  intArg  = comp->gtNewBitCastNode(intType, arg);
1506     intArg->gtRegNum  = regNum;
1507 #ifdef _TARGET_ARM_
1508     if (floatType == TYP_DOUBLE)
1509     {
1510         regNumber nextReg                  = REG_NEXT(regNum);
1511         intArg->AsMultiRegOp()->gtOtherReg = nextReg;
1512     }
1513 #endif
1514     return intArg;
1515 }
1516 #endif
1517
1518 // do lowering steps for each arg of a call
1519 void Lowering::LowerArgsForCall(GenTreeCall* call)
1520 {
1521     JITDUMP("objp:\n======\n");
1522     if (call->gtCallObjp)
1523     {
1524         LowerArg(call, &call->gtCallObjp);
1525     }
1526
1527     GenTreeArgList* args = call->gtCallArgs;
1528
1529     JITDUMP("\nargs:\n======\n");
1530     for (; args; args = args->Rest())
1531     {
1532         LowerArg(call, &args->Current());
1533     }
1534
1535     JITDUMP("\nlate:\n======\n");
1536     for (args = call->gtCallLateArgs; args; args = args->Rest())
1537     {
1538         LowerArg(call, &args->Current());
1539     }
1540 }
1541
1542 // helper that create a node representing a relocatable physical address computation
1543 GenTree* Lowering::AddrGen(ssize_t addr)
1544 {
1545     // this should end up in codegen as : instGen_Set_Reg_To_Imm(EA_HANDLE_CNS_RELOC, reg, addr)
1546     GenTree* result = comp->gtNewIconHandleNode(addr, GTF_ICON_FTN_ADDR);
1547     return result;
1548 }
1549
1550 // variant that takes a void*
1551 GenTree* Lowering::AddrGen(void* addr)
1552 {
1553     return AddrGen((ssize_t)addr);
1554 }
1555
1556 // do lowering steps for a call
1557 // this includes:
1558 //   - adding the placement nodes (either stack or register variety) for arguments
1559 //   - lowering the expression that calculates the target address
1560 //   - adding nodes for other operations that occur after the call sequence starts and before
1561 //        control transfer occurs (profiling and tail call helpers, pinvoke incantations)
1562 //
1563 void Lowering::LowerCall(GenTree* node)
1564 {
1565     GenTreeCall* call = node->AsCall();
1566
1567     JITDUMP("lowering call (before):\n");
1568     DISPTREERANGE(BlockRange(), call);
1569     JITDUMP("\n");
1570
1571     call->ClearOtherRegs();
1572     LowerArgsForCall(call);
1573
1574     // note that everything generated from this point on runs AFTER the outgoing args are placed
1575     GenTree* result = nullptr;
1576
1577     // for x86, this is where we record ESP for checking later to make sure stack is balanced
1578
1579     // Check for Delegate.Invoke(). If so, we inline it. We get the
1580     // target-object and target-function from the delegate-object, and do
1581     // an indirect call.
1582     if (call->IsDelegateInvoke())
1583     {
1584         result = LowerDelegateInvoke(call);
1585     }
1586     else
1587     {
1588         //  Virtual and interface calls
1589         switch (call->gtFlags & GTF_CALL_VIRT_KIND_MASK)
1590         {
1591             case GTF_CALL_VIRT_STUB:
1592                 result = LowerVirtualStubCall(call);
1593                 break;
1594
1595             case GTF_CALL_VIRT_VTABLE:
1596                 // stub dispatching is off or this is not a virtual call (could be a tailcall)
1597                 result = LowerVirtualVtableCall(call);
1598                 break;
1599
1600             case GTF_CALL_NONVIRT:
1601                 if (call->IsUnmanaged())
1602                 {
1603                     result = LowerNonvirtPinvokeCall(call);
1604                 }
1605                 else if (call->gtCallType == CT_INDIRECT)
1606                 {
1607                     result = LowerIndirectNonvirtCall(call);
1608                 }
1609                 else
1610                 {
1611                     result = LowerDirectCall(call);
1612                 }
1613                 break;
1614
1615             default:
1616                 noway_assert(!"strange call type");
1617                 break;
1618         }
1619     }
1620
1621     if (call->IsTailCallViaHelper())
1622     {
1623         // Either controlExpr or gtCallAddr must contain real call target.
1624         if (result == nullptr)
1625         {
1626             assert(call->gtCallType == CT_INDIRECT);
1627             assert(call->gtCallAddr != nullptr);
1628             result = call->gtCallAddr;
1629         }
1630
1631         result = LowerTailCallViaHelper(call, result);
1632     }
1633     else if (call->IsFastTailCall())
1634     {
1635         LowerFastTailCall(call);
1636     }
1637
1638     if (result != nullptr)
1639     {
1640         LIR::Range resultRange = LIR::SeqTree(comp, result);
1641
1642         JITDUMP("results of lowering call:\n");
1643         DISPRANGE(resultRange);
1644
1645         GenTree* insertionPoint = call;
1646         if (!call->IsTailCallViaHelper())
1647         {
1648             // The controlExpr should go before the gtCallCookie and the gtCallAddr, if they exist
1649             //
1650             // TODO-LIR: find out what's really required here, as this is currently a tree order
1651             // dependency.
1652             if (call->gtCallType == CT_INDIRECT)
1653             {
1654                 bool isClosed = false;
1655                 if (call->gtCallCookie != nullptr)
1656                 {
1657 #ifdef DEBUG
1658                     GenTree* firstCallAddrNode = BlockRange().GetTreeRange(call->gtCallAddr, &isClosed).FirstNode();
1659                     assert(isClosed);
1660                     assert(call->gtCallCookie->Precedes(firstCallAddrNode));
1661 #endif // DEBUG
1662
1663                     insertionPoint = BlockRange().GetTreeRange(call->gtCallCookie, &isClosed).FirstNode();
1664                     assert(isClosed);
1665                 }
1666                 else if (call->gtCallAddr != nullptr)
1667                 {
1668                     insertionPoint = BlockRange().GetTreeRange(call->gtCallAddr, &isClosed).FirstNode();
1669                     assert(isClosed);
1670                 }
1671             }
1672         }
1673
1674         ContainCheckRange(resultRange);
1675         BlockRange().InsertBefore(insertionPoint, std::move(resultRange));
1676
1677         call->gtControlExpr = result;
1678     }
1679
1680     if (comp->opts.IsJit64Compat())
1681     {
1682         CheckVSQuirkStackPaddingNeeded(call);
1683     }
1684
1685     ContainCheckCallOperands(call);
1686     JITDUMP("lowering call (after):\n");
1687     DISPTREERANGE(BlockRange(), call);
1688     JITDUMP("\n");
1689 }
1690
1691 // Though the below described issue gets fixed in intellitrace dll of VS2015 (a.k.a Dev14),
1692 // we still need this quirk for desktop so that older version of VS (e.g. VS2010/2012)
1693 // continues to work.
1694 // This quirk is excluded from other targets that have no back compat burden.
1695 //
1696 // Quirk for VS debug-launch scenario to work:
1697 // See if this is a PInvoke call with exactly one param that is the address of a struct local.
1698 // In such a case indicate to frame-layout logic to add 16-bytes of padding
1699 // between save-reg area and locals.  This is to protect against the buffer
1700 // overrun bug in microsoft.intellitrace.11.0.0.dll!ProfilerInterop.InitInterop().
1701 //
1702 // A work-around to this bug is to disable IntelliTrace debugging
1703 // (VS->Tools->Options->IntelliTrace->Enable IntelliTrace - uncheck this option).
1704 // The reason why this works on Jit64 is that at the point of AV the call stack is
1705 //
1706 // GetSystemInfo() Native call
1707 // IL_Stub generated for PInvoke declaration.
1708 // ProfilerInterface::InitInterop()
1709 // ProfilerInterface.Cctor()
1710 // VM asm worker
1711 //
1712 // The cctor body has just the call to InitInterop().  VM asm worker is holding
1713 // something in rbx that is used immediately after the Cctor call.  Jit64 generated
1714 // InitInterop() method is pushing the registers in the following order
1715 //
1716 //  rbx
1717 //  rbp
1718 //  rsi
1719 //  rdi
1720 //  r12
1721 //  r13
1722 //  Struct local
1723 //
1724 // Due to buffer overrun, rbx doesn't get impacted.  Whereas RyuJIT jitted code of
1725 // the same method is pushing regs in the following order
1726 //
1727 //  rbp
1728 //  rdi
1729 //  rsi
1730 //  rbx
1731 //  struct local
1732 //
1733 // Therefore as a fix, we add padding between save-reg area and locals to
1734 // make this scenario work against JB.
1735 //
1736 // Note: If this quirk gets broken due to other JIT optimizations, we should consider
1737 // more tolerant fix.  One such fix is to padd the struct.
1738 void Lowering::CheckVSQuirkStackPaddingNeeded(GenTreeCall* call)
1739 {
1740     assert(comp->opts.IsJit64Compat());
1741
1742 #ifdef _TARGET_AMD64_
1743     // Confine this to IL stub calls which aren't marked as unmanaged.
1744     if (call->IsPInvoke() && !call->IsUnmanaged())
1745     {
1746         bool     paddingNeeded  = false;
1747         GenTree* firstPutArgReg = nullptr;
1748         for (GenTreeArgList* args = call->gtCallLateArgs; args; args = args->Rest())
1749         {
1750             GenTree* tmp = args->Current();
1751             if (tmp->OperGet() == GT_PUTARG_REG)
1752             {
1753                 if (firstPutArgReg == nullptr)
1754                 {
1755                     firstPutArgReg = tmp;
1756                     GenTree* op1   = firstPutArgReg->gtOp.gtOp1;
1757
1758                     if (op1->OperGet() == GT_LCL_VAR_ADDR)
1759                     {
1760                         unsigned lclNum = op1->AsLclVarCommon()->GetLclNum();
1761                         // TODO-1stClassStructs: This is here to duplicate previous behavior,
1762                         // but is not needed because the scenario being quirked did not involve
1763                         // a SIMD or enregisterable struct.
1764                         // if(comp->lvaTable[lclNum].TypeGet() == TYP_STRUCT)
1765                         if (varTypeIsStruct(comp->lvaTable[lclNum].TypeGet()))
1766                         {
1767                             // First arg is addr of a struct local.
1768                             paddingNeeded = true;
1769                         }
1770                         else
1771                         {
1772                             // Not a struct local.
1773                             assert(paddingNeeded == false);
1774                             break;
1775                         }
1776                     }
1777                     else
1778                     {
1779                         // First arg is not a local var addr.
1780                         assert(paddingNeeded == false);
1781                         break;
1782                     }
1783                 }
1784                 else
1785                 {
1786                     // Has more than one arg.
1787                     paddingNeeded = false;
1788                     break;
1789                 }
1790             }
1791         }
1792
1793         if (paddingNeeded)
1794         {
1795             comp->compVSQuirkStackPaddingNeeded = VSQUIRK_STACK_PAD;
1796         }
1797     }
1798 #endif // _TARGET_AMD64_
1799 }
1800
1801 // Inserts profiler hook, GT_PROF_HOOK for a tail call node.
1802 //
1803 // AMD64:
1804 // We need to insert this after all nested calls, but before all the arguments to this call have been set up.
1805 // To do this, we look for the first GT_PUTARG_STK or GT_PUTARG_REG, and insert the hook immediately before
1806 // that. If there are no args, then it should be inserted before the call node.
1807 //
1808 // For example:
1809 //              *  stmtExpr  void  (top level) (IL 0x000...0x010)
1810 // arg0 SETUP   |  /--*  argPlace  ref    REG NA $c5
1811 // this in rcx  |  |     /--*  argPlace  ref    REG NA $c1
1812 //              |  |     |  /--*  call      ref    System.Globalization.CultureInfo.get_InvariantCulture $c2
1813 // arg1 SETUP   |  |     +--*  st.lclVar ref    V02 tmp1          REG NA $c2
1814 //              |  |     |  /--*  lclVar    ref    V02 tmp1         u : 2 (last use) REG NA $c2
1815 // arg1 in rdx  |  |     +--*  putarg_reg ref    REG NA
1816 //              |  |     |  /--*  lclVar    ref    V00 arg0         u : 2 (last use) REG NA $80
1817 // this in rcx  |  |     +--*  putarg_reg ref    REG NA
1818 //              |  |  /--*  call nullcheck ref    System.String.ToLower $c5
1819 //              |  |  {  *  stmtExpr  void  (embedded)(IL 0x000... ? ? ? )
1820 //              |  |  {  \--*  prof_hook void   REG NA
1821 // arg0 in rcx  |  +--*  putarg_reg ref    REG NA
1822 // control expr |  +--*  const(h)  long   0x7ffe8e910e98 ftn REG NA
1823 //              \--*  call      void   System.Runtime.Remoting.Identity.RemoveAppNameOrAppGuidIfNecessary $VN.Void
1824 //
1825 // In this case, the GT_PUTARG_REG src is a nested call. We need to put the instructions after that call
1826 // (as shown). We assume that of all the GT_PUTARG_*, only the first one can have a nested call.
1827 //
1828 // X86:
1829 // Insert the profiler hook immediately before the call. The profiler hook will preserve
1830 // all argument registers (ECX, EDX), but nothing else.
1831 //
1832 // Params:
1833 //    callNode        - tail call node
1834 //    insertionPoint  - if non-null, insert the profiler hook before this point.
1835 //                      If null, insert the profiler hook before args are setup
1836 //                      but after all arg side effects are computed.
1837 //
1838 void Lowering::InsertProfTailCallHook(GenTreeCall* call, GenTree* insertionPoint)
1839 {
1840     assert(call->IsTailCall());
1841     assert(comp->compIsProfilerHookNeeded());
1842
1843 #if defined(_TARGET_X86_)
1844
1845     if (insertionPoint == nullptr)
1846     {
1847         insertionPoint = call;
1848     }
1849
1850 #else // !defined(_TARGET_X86_)
1851
1852     if (insertionPoint == nullptr)
1853     {
1854         GenTree* tmp = nullptr;
1855         for (GenTreeArgList* args = call->gtCallArgs; args; args = args->Rest())
1856         {
1857             tmp = args->Current();
1858             assert(tmp->OperGet() != GT_PUTARG_REG); // We don't expect to see these in gtCallArgs
1859             if (tmp->OperGet() == GT_PUTARG_STK)
1860             {
1861                 // found it
1862                 insertionPoint = tmp;
1863                 break;
1864             }
1865         }
1866
1867         if (insertionPoint == nullptr)
1868         {
1869             for (GenTreeArgList* args = call->gtCallLateArgs; args; args = args->Rest())
1870             {
1871                 tmp = args->Current();
1872                 if ((tmp->OperGet() == GT_PUTARG_REG) || (tmp->OperGet() == GT_PUTARG_STK))
1873                 {
1874                     // found it
1875                     insertionPoint = tmp;
1876                     break;
1877                 }
1878             }
1879
1880             // If there are no args, insert before the call node
1881             if (insertionPoint == nullptr)
1882             {
1883                 insertionPoint = call;
1884             }
1885         }
1886     }
1887
1888 #endif // !defined(_TARGET_X86_)
1889
1890     assert(insertionPoint != nullptr);
1891     GenTree* profHookNode = new (comp, GT_PROF_HOOK) GenTree(GT_PROF_HOOK, TYP_VOID);
1892     BlockRange().InsertBefore(insertionPoint, profHookNode);
1893 }
1894
1895 // Lower fast tail call implemented as epilog+jmp.
1896 // Also inserts PInvoke method epilog if required.
1897 void Lowering::LowerFastTailCall(GenTreeCall* call)
1898 {
1899 #if FEATURE_FASTTAILCALL
1900     // Tail call restrictions i.e. conditions under which tail prefix is ignored.
1901     // Most of these checks are already done by importer or fgMorphTailCall().
1902     // This serves as a double sanity check.
1903     assert((comp->info.compFlags & CORINFO_FLG_SYNCH) == 0); // tail calls from synchronized methods
1904     assert(!comp->opts.compNeedSecurityCheck);               // tail call from methods that need security check
1905     assert(!call->IsUnmanaged());                            // tail calls to unamanaged methods
1906     assert(!comp->compLocallocUsed);                         // tail call from methods that also do localloc
1907
1908 #ifdef _TARGET_AMD64_
1909     assert(!comp->getNeedsGSSecurityCookie()); // jit64 compat: tail calls from methods that need GS check
1910 #endif                                         // _TARGET_AMD64_
1911
1912     // We expect to see a call that meets the following conditions
1913     assert(call->IsFastTailCall());
1914
1915     // VM cannot use return address hijacking when A() and B() tail call each
1916     // other in mutual recursion.  Therefore, this block is reachable through
1917     // a GC-safe point or the whole method is marked as fully interruptible.
1918     //
1919     // TODO-Cleanup:
1920     // optReachWithoutCall() depends on the fact that loop headers blocks
1921     // will have a block number > fgLastBB.  These loop headers gets added
1922     // after dominator computation and get skipped by OptReachWithoutCall().
1923     // The below condition cannot be asserted in lower because fgSimpleLowering()
1924     // can add a new basic block for range check failure which becomes
1925     // fgLastBB with block number > loop header block number.
1926     // assert((comp->compCurBB->bbFlags & BBF_GC_SAFE_POINT) ||
1927     //         !comp->optReachWithoutCall(comp->fgFirstBB, comp->compCurBB) || comp->genInterruptible);
1928
1929     // If PInvokes are in-lined, we have to remember to execute PInvoke method epilog anywhere that
1930     // a method returns.  This is a case of caller method has both PInvokes and tail calls.
1931     if (comp->info.compCallUnmanaged)
1932     {
1933         InsertPInvokeMethodEpilog(comp->compCurBB DEBUGARG(call));
1934     }
1935
1936     // Args for tail call are setup in incoming arg area.  The gc-ness of args of
1937     // caller and callee (which being tail called) may not match.  Therefore, everything
1938     // from arg setup until the epilog need to be non-interuptible by GC.  This is
1939     // achieved by inserting GT_START_NONGC before the very first GT_PUTARG_STK node
1940     // of call is setup.  Note that once a stack arg is setup, it cannot have nested
1941     // calls subsequently in execution order to setup other args, because the nested
1942     // call could over-write the stack arg that is setup earlier.
1943     GenTree*             firstPutArgStk = nullptr;
1944     GenTreeArgList*      args;
1945     ArrayStack<GenTree*> putargs(comp->getAllocator(CMK_ArrayStack));
1946
1947     for (args = call->gtCallArgs; args; args = args->Rest())
1948     {
1949         GenTree* tmp = args->Current();
1950         if (tmp->OperGet() == GT_PUTARG_STK)
1951         {
1952             putargs.Push(tmp);
1953         }
1954     }
1955
1956     for (args = call->gtCallLateArgs; args; args = args->Rest())
1957     {
1958         GenTree* tmp = args->Current();
1959         if (tmp->OperGet() == GT_PUTARG_STK)
1960         {
1961             putargs.Push(tmp);
1962         }
1963     }
1964
1965     if (putargs.Height() > 0)
1966     {
1967         firstPutArgStk = putargs.Bottom();
1968     }
1969
1970     // If we have a putarg_stk node, also count the number of non-standard args the
1971     // call node has.  Note that while determining whether a tail call can be fast
1972     // tail called, we don't count non-standard args (passed in R10 or R11) since they
1973     // don't contribute to outgoing arg space.  These non-standard args are not
1974     // accounted in caller's arg count but accounted in callee's arg count after
1975     // fgMorphArgs(). Therefore, exclude callee's non-standard args while mapping
1976     // callee's stack arg num to corresponding caller's stack arg num.
1977     unsigned calleeNonStandardArgCount = call->GetNonStandardAddedArgCount(comp);
1978
1979     // Say Caller(a, b, c, d, e) fast tail calls Callee(e, d, c, b, a)
1980     // i.e. passes its arguments in reverse to Callee. During call site
1981     // setup, after computing argument side effects, stack args are setup
1982     // first and reg args next.  In the above example, both Callers and
1983     // Callee stack args (e and a respectively) share the same stack slot
1984     // and are alive at the same time.  The act of setting up Callee's
1985     // stack arg will over-write the stack arg of Caller and if there are
1986     // further uses of Caller stack arg we have to make sure that we move
1987     // it to a temp before over-writing its slot and use temp in place of
1988     // the corresponding Caller stack arg.
1989     //
1990     // For the above example, conceptually this is what is done
1991     //       tmp = e;
1992     //       Stack slot of e  = a
1993     //       R9 = b, R8 = c, RDx = d
1994     //       RCX = tmp
1995     //
1996     // The below logic is meant to detect cases like this and introduce
1997     // temps to set up args correctly for Callee.
1998
1999     for (int i = 0; i < putargs.Height(); i++)
2000     {
2001         GenTree* putArgStkNode = putargs.Bottom(i);
2002
2003         assert(putArgStkNode->OperGet() == GT_PUTARG_STK);
2004
2005         // Get the caller arg num corresponding to this callee arg.
2006         // Note that these two args share the same stack slot. Therefore,
2007         // if there are further uses of corresponding caller arg, we need
2008         // to move it to a temp and use the temp in this call tree.
2009         //
2010         // Note that Caller is guaranteed to have a param corresponding to
2011         // this Callee's arg since fast tail call mechanism counts the
2012         // stack slots required for both Caller and Callee for passing params
2013         // and allow fast tail call only if stack slots required by Caller >=
2014         // Callee.
2015         fgArgTabEntry* argTabEntry = comp->gtArgEntryByNode(call, putArgStkNode);
2016         assert(argTabEntry);
2017         unsigned callerArgNum = argTabEntry->argNum - calleeNonStandardArgCount;
2018         noway_assert(callerArgNum < comp->info.compArgsCount);
2019
2020         unsigned   callerArgLclNum = callerArgNum;
2021         LclVarDsc* callerArgDsc    = comp->lvaTable + callerArgLclNum;
2022         if (callerArgDsc->lvPromoted)
2023         {
2024             callerArgLclNum =
2025                 callerArgDsc->lvFieldLclStart; // update the callerArgNum to the promoted struct field's lclNum
2026             callerArgDsc = comp->lvaTable + callerArgLclNum;
2027         }
2028         noway_assert(callerArgDsc->lvIsParam);
2029
2030         // Start searching in execution order list till we encounter call node
2031         unsigned  tmpLclNum = BAD_VAR_NUM;
2032         var_types tmpType   = TYP_UNDEF;
2033         for (GenTree* treeNode = putArgStkNode->gtNext; treeNode != call; treeNode = treeNode->gtNext)
2034         {
2035             if (treeNode->OperIsLocal() || treeNode->OperIsLocalAddr())
2036             {
2037                 // This should neither be a GT_REG_VAR nor GT_PHI_ARG.
2038                 assert((treeNode->OperGet() != GT_REG_VAR) && (treeNode->OperGet() != GT_PHI_ARG));
2039
2040                 GenTreeLclVarCommon* lcl    = treeNode->AsLclVarCommon();
2041                 LclVarDsc*           lclVar = &comp->lvaTable[lcl->gtLclNum];
2042
2043                 // Fast tail calling criteria permits passing of structs of size 1, 2, 4 and 8 as args.
2044                 // It is possible that the callerArgLclNum corresponds to such a struct whose stack slot
2045                 // is getting over-written by setting up of a stack arg and there are further uses of
2046                 // any of its fields if such a struct is type-dependently promoted.  In this case too
2047                 // we need to introduce a temp.
2048                 if ((lcl->gtLclNum == callerArgNum) || (lcl->gtLclNum == callerArgLclNum))
2049                 {
2050                     // Create tmp and use it in place of callerArgDsc
2051                     if (tmpLclNum == BAD_VAR_NUM)
2052                     {
2053                         // Set tmpType first before calling lvaGrabTemp, as that call invalidates callerArgDsc
2054                         tmpType   = genActualType(callerArgDsc->lvaArgType());
2055                         tmpLclNum = comp->lvaGrabTemp(
2056                             true DEBUGARG("Fast tail call lowering is creating a new local variable"));
2057
2058                         comp->lvaTable[tmpLclNum].lvType            = tmpType;
2059                         comp->lvaTable[tmpLclNum].lvDoNotEnregister = comp->lvaTable[lcl->gtLclNum].lvDoNotEnregister;
2060                     }
2061
2062                     lcl->SetLclNum(tmpLclNum);
2063                 }
2064             }
2065         }
2066
2067         // If we have created a temp, insert an embedded assignment stmnt before
2068         // the first putargStkNode i.e.
2069         //     tmpLcl = CallerArg
2070         if (tmpLclNum != BAD_VAR_NUM)
2071         {
2072             assert(tmpType != TYP_UNDEF);
2073             GenTreeLclVar* local =
2074                 new (comp, GT_LCL_VAR) GenTreeLclVar(GT_LCL_VAR, tmpType, callerArgLclNum, BAD_IL_OFFSET);
2075             GenTree* assignExpr = comp->gtNewTempAssign(tmpLclNum, local);
2076             ContainCheckRange(local, assignExpr);
2077             BlockRange().InsertBefore(firstPutArgStk, LIR::SeqTree(comp, assignExpr));
2078         }
2079     }
2080
2081     // Insert GT_START_NONGC node before the first GT_PUTARG_STK node.
2082     // Note that if there are no args to be setup on stack, no need to
2083     // insert GT_START_NONGC node.
2084     GenTree* startNonGCNode = nullptr;
2085     if (firstPutArgStk != nullptr)
2086     {
2087         startNonGCNode = new (comp, GT_START_NONGC) GenTree(GT_START_NONGC, TYP_VOID);
2088         BlockRange().InsertBefore(firstPutArgStk, startNonGCNode);
2089
2090         // Gc-interruptability in the following case:
2091         //     foo(a, b, c, d, e) { bar(a, b, c, d, e); }
2092         //     bar(a, b, c, d, e) { foo(a, b, d, d, e); }
2093         //
2094         // Since the instruction group starting from the instruction that sets up first
2095         // stack arg to the end of the tail call is marked as non-gc interruptible,
2096         // this will form a non-interruptible tight loop causing gc-starvation. To fix
2097         // this we insert GT_NO_OP as embedded stmt before GT_START_NONGC, if the method
2098         // has a single basic block and is not a GC-safe point.  The presence of a single
2099         // nop outside non-gc interruptible region will prevent gc starvation.
2100         if ((comp->fgBBcount == 1) && !(comp->compCurBB->bbFlags & BBF_GC_SAFE_POINT))
2101         {
2102             assert(comp->fgFirstBB == comp->compCurBB);
2103             GenTree* noOp = new (comp, GT_NO_OP) GenTree(GT_NO_OP, TYP_VOID);
2104             BlockRange().InsertBefore(startNonGCNode, noOp);
2105         }
2106     }
2107
2108     // Insert GT_PROF_HOOK node to emit profiler tail call hook. This should be
2109     // inserted before the args are setup but after the side effects of args are
2110     // computed. That is, GT_PROF_HOOK node needs to be inserted before GT_START_NONGC
2111     // node if one exists.
2112     if (comp->compIsProfilerHookNeeded())
2113     {
2114         InsertProfTailCallHook(call, startNonGCNode);
2115     }
2116
2117 #else // !FEATURE_FASTTAILCALL
2118
2119     // Platform choose not to implement fast tail call mechanism.
2120     // In such a case we should never be reaching this method as
2121     // the expectation is that IsTailCallViaHelper() will always
2122     // be true on such a platform.
2123     unreached();
2124 #endif
2125 }
2126
2127 //------------------------------------------------------------------------
2128 // LowerTailCallViaHelper: lower a call via the tailcall helper. Morph
2129 // has already inserted tailcall helper special arguments. This function
2130 // inserts actual data for some placeholders.
2131 //
2132 // For ARM32, AMD64, lower
2133 //      tail.call(void* copyRoutine, void* dummyArg, ...)
2134 // as
2135 //      Jit_TailCall(void* copyRoutine, void* callTarget, ...)
2136 //
2137 // For x86, lower
2138 //      tail.call(<function args>, int numberOfOldStackArgs, int dummyNumberOfNewStackArgs, int flags, void* dummyArg)
2139 // as
2140 //      JIT_TailCall(<function args>, int numberOfOldStackArgsWords, int numberOfNewStackArgsWords, int flags, void*
2141 //      callTarget)
2142 // Note that the special arguments are on the stack, whereas the function arguments follow the normal convention.
2143 //
2144 // Also inserts PInvoke method epilog if required.
2145 //
2146 // Arguments:
2147 //    call         -  The call node
2148 //    callTarget   -  The real call target. This is used to replace the dummyArg during lowering.
2149 //
2150 // Return Value:
2151 //    Returns control expression tree for making a call to helper Jit_TailCall.
2152 //
2153 GenTree* Lowering::LowerTailCallViaHelper(GenTreeCall* call, GenTree* callTarget)
2154 {
2155     // Tail call restrictions i.e. conditions under which tail prefix is ignored.
2156     // Most of these checks are already done by importer or fgMorphTailCall().
2157     // This serves as a double sanity check.
2158     assert((comp->info.compFlags & CORINFO_FLG_SYNCH) == 0); // tail calls from synchronized methods
2159     assert(!comp->opts.compNeedSecurityCheck);               // tail call from methods that need security check
2160     assert(!call->IsUnmanaged());                            // tail calls to unamanaged methods
2161     assert(!comp->compLocallocUsed);                         // tail call from methods that also do localloc
2162
2163 #ifdef _TARGET_AMD64_
2164     assert(!comp->getNeedsGSSecurityCookie()); // jit64 compat: tail calls from methods that need GS check
2165 #endif                                         // _TARGET_AMD64_
2166
2167     // We expect to see a call that meets the following conditions
2168     assert(call->IsTailCallViaHelper());
2169     assert(callTarget != nullptr);
2170
2171     // The TailCall helper call never returns to the caller and is not GC interruptible.
2172     // Therefore the block containing the tail call should be a GC safe point to avoid
2173     // GC starvation. It is legal for the block to be unmarked iff the entry block is a
2174     // GC safe point, as the entry block trivially dominates every reachable block.
2175     assert((comp->compCurBB->bbFlags & BBF_GC_SAFE_POINT) || (comp->fgFirstBB->bbFlags & BBF_GC_SAFE_POINT));
2176
2177     // If PInvokes are in-lined, we have to remember to execute PInvoke method epilog anywhere that
2178     // a method returns.  This is a case of caller method has both PInvokes and tail calls.
2179     if (comp->info.compCallUnmanaged)
2180     {
2181         InsertPInvokeMethodEpilog(comp->compCurBB DEBUGARG(call));
2182     }
2183
2184     // Remove gtCallAddr from execution order if present.
2185     if (call->gtCallType == CT_INDIRECT)
2186     {
2187         assert(call->gtCallAddr != nullptr);
2188
2189         bool               isClosed;
2190         LIR::ReadOnlyRange callAddrRange = BlockRange().GetTreeRange(call->gtCallAddr, &isClosed);
2191         assert(isClosed);
2192
2193         BlockRange().Remove(std::move(callAddrRange));
2194     }
2195
2196     // The callTarget tree needs to be sequenced.
2197     LIR::Range callTargetRange = LIR::SeqTree(comp, callTarget);
2198
2199 #if defined(_TARGET_AMD64_) || defined(_TARGET_ARM_)
2200
2201     // For ARM32 and AMD64, first argument is CopyRoutine and second argument is a place holder node.
2202     fgArgTabEntry* argEntry;
2203
2204 #ifdef DEBUG
2205     argEntry = comp->gtArgEntryByArgNum(call, 0);
2206     assert(argEntry != nullptr);
2207     assert(argEntry->node->gtOper == GT_PUTARG_REG);
2208     GenTree* firstArg = argEntry->node->gtOp.gtOp1;
2209     assert(firstArg->gtOper == GT_CNS_INT);
2210 #endif
2211
2212     // Replace second arg by callTarget.
2213     argEntry = comp->gtArgEntryByArgNum(call, 1);
2214     assert(argEntry != nullptr);
2215     assert(argEntry->node->gtOper == GT_PUTARG_REG);
2216     GenTree* secondArg = argEntry->node->gtOp.gtOp1;
2217
2218     ContainCheckRange(callTargetRange);
2219     BlockRange().InsertAfter(secondArg, std::move(callTargetRange));
2220
2221     bool               isClosed;
2222     LIR::ReadOnlyRange secondArgRange = BlockRange().GetTreeRange(secondArg, &isClosed);
2223     assert(isClosed);
2224
2225     BlockRange().Remove(std::move(secondArgRange));
2226
2227     argEntry->node->gtOp.gtOp1 = callTarget;
2228
2229 #elif defined(_TARGET_X86_)
2230
2231     // Verify the special args are what we expect, and replace the dummy args with real values.
2232     // We need to figure out the size of the outgoing stack arguments, not including the special args.
2233     // The number of 4-byte words is passed to the helper for the incoming and outgoing argument sizes.
2234     // This number is exactly the next slot number in the call's argument info struct.
2235     unsigned nNewStkArgsWords = call->fgArgInfo->GetNextSlotNum();
2236     assert(nNewStkArgsWords >= 4); // There must be at least the four special stack args.
2237     nNewStkArgsWords -= 4;
2238
2239     unsigned numArgs = call->fgArgInfo->ArgCount();
2240
2241     fgArgTabEntry* argEntry;
2242
2243     // arg 0 == callTarget.
2244     argEntry = comp->gtArgEntryByArgNum(call, numArgs - 1);
2245     assert(argEntry != nullptr);
2246     assert(argEntry->node->gtOper == GT_PUTARG_STK);
2247     GenTree* arg0 = argEntry->node->gtOp.gtOp1;
2248
2249     ContainCheckRange(callTargetRange);
2250     BlockRange().InsertAfter(arg0, std::move(callTargetRange));
2251
2252     bool               isClosed;
2253     LIR::ReadOnlyRange secondArgRange = BlockRange().GetTreeRange(arg0, &isClosed);
2254     assert(isClosed);
2255     BlockRange().Remove(std::move(secondArgRange));
2256
2257     argEntry->node->gtOp.gtOp1 = callTarget;
2258
2259     // arg 1 == flags
2260     argEntry = comp->gtArgEntryByArgNum(call, numArgs - 2);
2261     assert(argEntry != nullptr);
2262     assert(argEntry->node->gtOper == GT_PUTARG_STK);
2263     GenTree* arg1 = argEntry->node->gtOp.gtOp1;
2264     assert(arg1->gtOper == GT_CNS_INT);
2265
2266     ssize_t tailCallHelperFlags = 1 |                                  // always restore EDI,ESI,EBX
2267                                   (call->IsVirtualStub() ? 0x2 : 0x0); // Stub dispatch flag
2268     arg1->gtIntCon.gtIconVal = tailCallHelperFlags;
2269
2270     // arg 2 == numberOfNewStackArgsWords
2271     argEntry = comp->gtArgEntryByArgNum(call, numArgs - 3);
2272     assert(argEntry != nullptr);
2273     assert(argEntry->node->gtOper == GT_PUTARG_STK);
2274     GenTree* arg2 = argEntry->node->gtOp.gtOp1;
2275     assert(arg2->gtOper == GT_CNS_INT);
2276
2277     arg2->gtIntCon.gtIconVal = nNewStkArgsWords;
2278
2279 #ifdef DEBUG
2280     // arg 3 == numberOfOldStackArgsWords
2281     argEntry = comp->gtArgEntryByArgNum(call, numArgs - 4);
2282     assert(argEntry != nullptr);
2283     assert(argEntry->node->gtOper == GT_PUTARG_STK);
2284     GenTree* arg3 = argEntry->node->gtOp.gtOp1;
2285     assert(arg3->gtOper == GT_CNS_INT);
2286 #endif // DEBUG
2287
2288 #else
2289     NYI("LowerTailCallViaHelper");
2290 #endif // _TARGET_*
2291
2292     // Transform this call node into a call to Jit tail call helper.
2293     call->gtCallType    = CT_HELPER;
2294     call->gtCallMethHnd = comp->eeFindHelper(CORINFO_HELP_TAILCALL);
2295     call->gtFlags &= ~GTF_CALL_VIRT_KIND_MASK;
2296
2297     // Lower this as if it were a pure helper call.
2298     call->gtCallMoreFlags &= ~(GTF_CALL_M_TAILCALL | GTF_CALL_M_TAILCALL_VIA_HELPER);
2299     GenTree* result = LowerDirectCall(call);
2300
2301     // Now add back tail call flags for identifying this node as tail call dispatched via helper.
2302     call->gtCallMoreFlags |= GTF_CALL_M_TAILCALL | GTF_CALL_M_TAILCALL_VIA_HELPER;
2303
2304 #ifdef PROFILING_SUPPORTED
2305     // Insert profiler tail call hook if needed.
2306     // Since we don't know the insertion point, pass null for second param.
2307     if (comp->compIsProfilerHookNeeded())
2308     {
2309         InsertProfTailCallHook(call, nullptr);
2310     }
2311 #endif // PROFILING_SUPPORTED
2312
2313     assert(call->IsTailCallViaHelper());
2314
2315     return result;
2316 }
2317
2318 #ifndef _TARGET_64BIT_
2319 //------------------------------------------------------------------------
2320 // Lowering::DecomposeLongCompare: Decomposes a TYP_LONG compare node.
2321 //
2322 // Arguments:
2323 //    cmp - the compare node
2324 //
2325 // Return Value:
2326 //    The next node to lower.
2327 //
2328 // Notes:
2329 //    This is done during lowering because DecomposeLongs handles only nodes
2330 //    that produce TYP_LONG values. Compare nodes may consume TYP_LONG values
2331 //    but produce TYP_INT values.
2332 //
2333 GenTree* Lowering::DecomposeLongCompare(GenTree* cmp)
2334 {
2335     assert(cmp->gtGetOp1()->TypeGet() == TYP_LONG);
2336
2337     GenTree* src1 = cmp->gtGetOp1();
2338     GenTree* src2 = cmp->gtGetOp2();
2339     assert(src1->OperIs(GT_LONG));
2340     assert(src2->OperIs(GT_LONG));
2341     GenTree* loSrc1 = src1->gtGetOp1();
2342     GenTree* hiSrc1 = src1->gtGetOp2();
2343     GenTree* loSrc2 = src2->gtGetOp1();
2344     GenTree* hiSrc2 = src2->gtGetOp2();
2345     BlockRange().Remove(src1);
2346     BlockRange().Remove(src2);
2347
2348     genTreeOps condition = cmp->OperGet();
2349     GenTree*   loCmp;
2350     GenTree*   hiCmp;
2351
2352     if (cmp->OperIs(GT_EQ, GT_NE))
2353     {
2354         //
2355         // Transform (x EQ|NE y) into (((x.lo XOR y.lo) OR (x.hi XOR y.hi)) EQ|NE 0). If y is 0 then this can
2356         // be reduced to just ((x.lo OR x.hi) EQ|NE 0). The OR is expected to set the condition flags so we
2357         // don't need to generate a redundant compare against 0, we only generate a SETCC|JCC instruction.
2358         //
2359         // XOR is used rather than SUB because it is commutative and thus allows swapping the operands when
2360         // the first happens to be a constant. Usually only the second compare operand is a constant but it's
2361         // still possible to have a constant on the left side. For example, when src1 is a uint->ulong cast
2362         // then hiSrc1 would be 0.
2363         //
2364
2365         if (loSrc1->OperIs(GT_CNS_INT))
2366         {
2367             std::swap(loSrc1, loSrc2);
2368         }
2369
2370         if (loSrc2->IsIntegralConst(0))
2371         {
2372             BlockRange().Remove(loSrc2);
2373             loCmp = loSrc1;
2374         }
2375         else
2376         {
2377             loCmp = comp->gtNewOperNode(GT_XOR, TYP_INT, loSrc1, loSrc2);
2378             BlockRange().InsertBefore(cmp, loCmp);
2379             ContainCheckBinary(loCmp->AsOp());
2380         }
2381
2382         if (hiSrc1->OperIs(GT_CNS_INT))
2383         {
2384             std::swap(hiSrc1, hiSrc2);
2385         }
2386
2387         if (hiSrc2->IsIntegralConst(0))
2388         {
2389             BlockRange().Remove(hiSrc2);
2390             hiCmp = hiSrc1;
2391         }
2392         else
2393         {
2394             hiCmp = comp->gtNewOperNode(GT_XOR, TYP_INT, hiSrc1, hiSrc2);
2395             BlockRange().InsertBefore(cmp, hiCmp);
2396             ContainCheckBinary(hiCmp->AsOp());
2397         }
2398
2399         hiCmp = comp->gtNewOperNode(GT_OR, TYP_INT, loCmp, hiCmp);
2400         BlockRange().InsertBefore(cmp, hiCmp);
2401         ContainCheckBinary(hiCmp->AsOp());
2402     }
2403     else
2404     {
2405         assert(cmp->OperIs(GT_LT, GT_LE, GT_GE, GT_GT));
2406
2407         //
2408         // If the compare is signed then (x LT|GE y) can be transformed into ((x SUB y) LT|GE 0).
2409         // If the compare is unsigned we can still use SUB but we need to check the Carry flag,
2410         // not the actual result. In both cases we can simply check the appropiate condition flags
2411         // and ignore the actual result:
2412         //     SUB_LO loSrc1, loSrc2
2413         //     SUB_HI hiSrc1, hiSrc2
2414         //     SETCC|JCC (signed|unsigned LT|GE)
2415         // If loSrc2 happens to be 0 then the first SUB can be eliminated and the second one can
2416         // be turned into a CMP because the first SUB would have set carry to 0. This effectively
2417         // transforms a long compare against 0 into an int compare of the high part against 0.
2418         //
2419         // (x LE|GT y) can to be transformed into ((x SUB y) LE|GT 0) but checking that a long value
2420         // is greater than 0 is not so easy. We need to turn this into a positive/negative check
2421         // like the one we get for LT|GE compares, this can be achieved by swapping the compare:
2422         //     (x LE|GT y) becomes (y GE|LT x)
2423         //
2424         // Having to swap operands is problematic when the second operand is a constant. The constant
2425         // moves to the first operand where it cannot be contained and thus needs a register. This can
2426         // be avoided by changing the constant such that LE|GT becomes LT|GE:
2427         //     (x LE|GT 41) becomes (x LT|GE 42)
2428         //
2429
2430         if (cmp->OperIs(GT_LE, GT_GT))
2431         {
2432             bool mustSwap = true;
2433
2434             if (loSrc2->OperIs(GT_CNS_INT) && hiSrc2->OperIs(GT_CNS_INT))
2435             {
2436                 uint32_t loValue  = static_cast<uint32_t>(loSrc2->AsIntCon()->IconValue());
2437                 uint32_t hiValue  = static_cast<uint32_t>(hiSrc2->AsIntCon()->IconValue());
2438                 uint64_t value    = static_cast<uint64_t>(loValue) | (static_cast<uint64_t>(hiValue) << 32);
2439                 uint64_t maxValue = cmp->IsUnsigned() ? UINT64_MAX : INT64_MAX;
2440
2441                 if (value != maxValue)
2442                 {
2443                     value++;
2444                     loValue = value & UINT32_MAX;
2445                     hiValue = (value >> 32) & UINT32_MAX;
2446                     loSrc2->AsIntCon()->SetIconValue(loValue);
2447                     hiSrc2->AsIntCon()->SetIconValue(hiValue);
2448
2449                     condition = cmp->OperIs(GT_LE) ? GT_LT : GT_GE;
2450                     mustSwap  = false;
2451                 }
2452             }
2453
2454             if (mustSwap)
2455             {
2456                 std::swap(loSrc1, loSrc2);
2457                 std::swap(hiSrc1, hiSrc2);
2458                 condition = GenTree::SwapRelop(condition);
2459             }
2460         }
2461
2462         assert((condition == GT_LT) || (condition == GT_GE));
2463
2464         if (loSrc2->IsIntegralConst(0))
2465         {
2466             BlockRange().Remove(loSrc2);
2467
2468             // Very conservative dead code removal... but it helps.
2469
2470             if (loSrc1->OperIs(GT_CNS_INT, GT_LCL_VAR, GT_LCL_FLD))
2471             {
2472                 BlockRange().Remove(loSrc1);
2473             }
2474             else
2475             {
2476                 loSrc1->SetUnusedValue();
2477             }
2478
2479             hiCmp = comp->gtNewOperNode(GT_CMP, TYP_VOID, hiSrc1, hiSrc2);
2480             BlockRange().InsertBefore(cmp, hiCmp);
2481             ContainCheckCompare(hiCmp->AsOp());
2482         }
2483         else
2484         {
2485             loCmp = comp->gtNewOperNode(GT_CMP, TYP_VOID, loSrc1, loSrc2);
2486             hiCmp = comp->gtNewOperNode(GT_SUB_HI, TYP_INT, hiSrc1, hiSrc2);
2487             BlockRange().InsertBefore(cmp, loCmp, hiCmp);
2488             ContainCheckCompare(loCmp->AsOp());
2489             ContainCheckBinary(hiCmp->AsOp());
2490
2491             //
2492             // Try to move the first SUB_HI operands right in front of it, this allows using
2493             // a single temporary register instead of 2 (one for CMP and one for SUB_HI). Do
2494             // this only for locals as they won't change condition flags. Note that we could
2495             // move constants (except 0 which generates XOR reg, reg) but it's extremly rare
2496             // to have a constant as the first operand.
2497             //
2498
2499             if (hiSrc1->OperIs(GT_LCL_VAR, GT_LCL_FLD))
2500             {
2501                 BlockRange().Remove(hiSrc1);
2502                 BlockRange().InsertBefore(hiCmp, hiSrc1);
2503             }
2504         }
2505     }
2506
2507     hiCmp->gtFlags |= GTF_SET_FLAGS;
2508     if (hiCmp->IsValue())
2509     {
2510         hiCmp->SetUnusedValue();
2511     }
2512
2513     LIR::Use cmpUse;
2514     if (BlockRange().TryGetUse(cmp, &cmpUse) && cmpUse.User()->OperIs(GT_JTRUE))
2515     {
2516         BlockRange().Remove(cmp);
2517
2518         GenTree* jcc    = cmpUse.User();
2519         jcc->gtOp.gtOp1 = nullptr;
2520         jcc->ChangeOper(GT_JCC);
2521         jcc->gtFlags |= (cmp->gtFlags & GTF_UNSIGNED) | GTF_USE_FLAGS;
2522         jcc->AsCC()->gtCondition = condition;
2523     }
2524     else
2525     {
2526         cmp->gtOp.gtOp1 = nullptr;
2527         cmp->gtOp.gtOp2 = nullptr;
2528         cmp->ChangeOper(GT_SETCC);
2529         cmp->gtFlags |= GTF_USE_FLAGS;
2530         cmp->AsCC()->gtCondition = condition;
2531     }
2532
2533     return cmp->gtNext;
2534 }
2535 #endif // !_TARGET_64BIT_
2536
2537 //------------------------------------------------------------------------
2538 // Lowering::OptimizeConstCompare: Performs various "compare with const" optimizations.
2539 //
2540 // Arguments:
2541 //    cmp - the compare node
2542 //
2543 // Return Value:
2544 //    The original compare node if lowering should proceed as usual or the next node
2545 //    to lower if the compare node was changed in such a way that lowering is no
2546 //    longer needed.
2547 //
2548 // Notes:
2549 //    - Narrow operands to enable memory operand containment (XARCH specific).
2550 //    - Transform cmp(and(x, y), 0) into test(x, y) (XARCH/Arm64 specific but could
2551 //      be used for ARM as well if support for GT_TEST_EQ/GT_TEST_NE is added).
2552 //    - Transform TEST(x, LSH(1, y)) into BT(x, y) (XARCH specific)
2553 //    - Transform RELOP(OP, 0) into SETCC(OP) or JCC(OP) if OP can set the
2554 //      condition flags appropriately (XARCH/ARM64 specific but could be extended
2555 //      to ARM32 as well if ARM32 codegen supports GTF_SET_FLAGS).
2556 //
2557 GenTree* Lowering::OptimizeConstCompare(GenTree* cmp)
2558 {
2559     assert(cmp->gtGetOp2()->IsIntegralConst());
2560
2561 #if defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
2562     GenTree*       op1      = cmp->gtGetOp1();
2563     var_types      op1Type  = op1->TypeGet();
2564     GenTreeIntCon* op2      = cmp->gtGetOp2()->AsIntCon();
2565     ssize_t        op2Value = op2->IconValue();
2566
2567 #ifdef _TARGET_XARCH_
2568     if (IsContainableMemoryOp(op1) && varTypeIsSmall(op1Type) && genSmallTypeCanRepresentValue(op1Type, op2Value))
2569     {
2570         //
2571         // If op1's type is small then try to narrow op2 so it has the same type as op1.
2572         // Small types are usually used by memory loads and if both compare operands have
2573         // the same type then the memory load can be contained. In certain situations
2574         // (e.g "cmp ubyte, 200") we also get a smaller instruction encoding.
2575         //
2576
2577         op2->gtType = op1Type;
2578     }
2579     else
2580 #endif
2581         if (op1->OperIs(GT_CAST) && !op1->gtOverflow())
2582     {
2583         GenTreeCast* cast       = op1->AsCast();
2584         var_types    castToType = cast->CastToType();
2585         GenTree*     castOp     = cast->gtGetOp1();
2586
2587         if (((castToType == TYP_BOOL) || (castToType == TYP_UBYTE)) && FitsIn<UINT8>(op2Value))
2588         {
2589             //
2590             // Since we're going to remove the cast we need to be able to narrow the cast operand
2591             // to the cast type. This can be done safely only for certain opers (e.g AND, OR, XOR).
2592             // Some opers just can't be narrowed (e.g DIV, MUL) while other could be narrowed but
2593             // doing so would produce incorrect results (e.g. RSZ, RSH).
2594             //
2595             // The below list of handled opers is conservative but enough to handle the most common
2596             // situations. In particular this include CALL, sometimes the JIT unnecessarilly widens
2597             // the result of bool returning calls.
2598             //
2599             bool removeCast =
2600 #ifdef _TARGET_ARM64_
2601                 (op2Value == 0) && cmp->OperIs(GT_EQ, GT_NE, GT_GT) &&
2602 #endif
2603                 (castOp->OperIs(GT_CALL, GT_LCL_VAR) || castOp->OperIsLogical()
2604 #ifdef _TARGET_XARCH_
2605                  || IsContainableMemoryOp(castOp)
2606 #endif
2607                      );
2608
2609             if (removeCast)
2610             {
2611                 assert(!castOp->gtOverflowEx()); // Must not be an overflow checking operation
2612
2613 #ifdef _TARGET_ARM64_
2614                 bool cmpEq = cmp->OperIs(GT_EQ);
2615
2616                 cmp->SetOperRaw(cmpEq ? GT_TEST_EQ : GT_TEST_NE);
2617                 op2->SetIconValue(0xff);
2618                 op2->gtType = castOp->gtType;
2619 #else
2620                 castOp->gtType = castToType;
2621                 op2->gtType    = castToType;
2622 #endif
2623                 // If we have any contained memory ops on castOp, they must now not be contained.
2624                 if (castOp->OperIsLogical())
2625                 {
2626                     GenTree* op1 = castOp->gtGetOp1();
2627                     if ((op1 != nullptr) && !op1->IsCnsIntOrI())
2628                     {
2629                         op1->ClearContained();
2630                     }
2631                     GenTree* op2 = castOp->gtGetOp2();
2632                     if ((op2 != nullptr) && !op2->IsCnsIntOrI())
2633                     {
2634                         op2->ClearContained();
2635                     }
2636                 }
2637                 cmp->gtOp.gtOp1 = castOp;
2638
2639                 BlockRange().Remove(cast);
2640             }
2641         }
2642     }
2643     else if (op1->OperIs(GT_AND) && cmp->OperIs(GT_EQ, GT_NE))
2644     {
2645         //
2646         // Transform ((x AND y) EQ|NE 0) into (x TEST_EQ|TEST_NE y) when possible.
2647         //
2648
2649         GenTree* andOp1 = op1->gtGetOp1();
2650         GenTree* andOp2 = op1->gtGetOp2();
2651
2652         if (op2Value != 0)
2653         {
2654             //
2655             // If we don't have a 0 compare we can get one by transforming ((x AND mask) EQ|NE mask)
2656             // into ((x AND mask) NE|EQ 0) when mask is a single bit.
2657             //
2658
2659             if (isPow2(static_cast<size_t>(op2Value)) && andOp2->IsIntegralConst(op2Value))
2660             {
2661                 op2Value = 0;
2662                 op2->SetIconValue(0);
2663                 cmp->SetOperRaw(GenTree::ReverseRelop(cmp->OperGet()));
2664             }
2665         }
2666
2667         if (op2Value == 0)
2668         {
2669             BlockRange().Remove(op1);
2670             BlockRange().Remove(op2);
2671
2672             cmp->SetOperRaw(cmp->OperIs(GT_EQ) ? GT_TEST_EQ : GT_TEST_NE);
2673             cmp->gtOp.gtOp1 = andOp1;
2674             cmp->gtOp.gtOp2 = andOp2;
2675             // We will re-evaluate containment below
2676             andOp1->ClearContained();
2677             andOp2->ClearContained();
2678
2679 #ifdef _TARGET_XARCH_
2680             if (IsContainableMemoryOp(andOp1) && andOp2->IsIntegralConst())
2681             {
2682                 //
2683                 // For "test" we only care about the bits that are set in the second operand (mask).
2684                 // If the mask fits in a small type then we can narrow both operands to generate a "test"
2685                 // instruction with a smaller encoding ("test" does not have a r/m32, imm8 form) and avoid
2686                 // a widening load in some cases.
2687                 //
2688                 // For 16 bit operands we narrow only if the memory operand is already 16 bit. This matches
2689                 // the behavior of a previous implementation and avoids adding more cases where we generate
2690                 // 16 bit instructions that require a length changing prefix (0x66). These suffer from
2691                 // significant decoder stalls on Intel CPUs.
2692                 //
2693                 // We could also do this for 64 bit masks that fit into 32 bit but it doesn't help.
2694                 // In such cases morph narrows down the existing GT_AND by inserting a cast between it and
2695                 // the memory operand so we'd need to add more code to recognize and eliminate that cast.
2696                 //
2697
2698                 size_t mask = static_cast<size_t>(andOp2->AsIntCon()->IconValue());
2699
2700                 if (FitsIn<UINT8>(mask))
2701                 {
2702                     andOp1->gtType = TYP_UBYTE;
2703                     andOp2->gtType = TYP_UBYTE;
2704                 }
2705                 else if (FitsIn<UINT16>(mask) && genTypeSize(andOp1) == 2)
2706                 {
2707                     andOp1->gtType = TYP_USHORT;
2708                     andOp2->gtType = TYP_USHORT;
2709                 }
2710             }
2711 #endif
2712         }
2713     }
2714
2715     if (cmp->OperIs(GT_TEST_EQ, GT_TEST_NE))
2716     {
2717 #ifdef _TARGET_XARCH_
2718         //
2719         // Transform TEST_EQ|NE(x, LSH(1, y)) into BT(x, y) when possible. Using BT
2720         // results in smaller and faster code. It also doesn't have special register
2721         // requirements, unlike LSH that requires the shift count to be in ECX.
2722         // Note that BT has the same behavior as LSH when the bit index exceeds the
2723         // operand bit size - it uses (bit_index MOD bit_size).
2724         //
2725
2726         GenTree* lsh = cmp->gtGetOp2();
2727         LIR::Use cmpUse;
2728
2729         if (lsh->OperIs(GT_LSH) && varTypeIsIntOrI(lsh->TypeGet()) && lsh->gtGetOp1()->IsIntegralConst(1) &&
2730             BlockRange().TryGetUse(cmp, &cmpUse))
2731         {
2732             genTreeOps condition = cmp->OperIs(GT_TEST_NE) ? GT_LT : GT_GE;
2733
2734             cmp->SetOper(GT_BT);
2735             cmp->gtType = TYP_VOID;
2736             cmp->gtFlags |= GTF_SET_FLAGS;
2737             cmp->gtOp.gtOp2 = lsh->gtGetOp2();
2738             cmp->gtGetOp2()->ClearContained();
2739
2740             BlockRange().Remove(lsh->gtGetOp1());
2741             BlockRange().Remove(lsh);
2742
2743             GenTreeCC* cc;
2744
2745             if (cmpUse.User()->OperIs(GT_JTRUE))
2746             {
2747                 cmpUse.User()->ChangeOper(GT_JCC);
2748                 cc              = cmpUse.User()->AsCC();
2749                 cc->gtCondition = condition;
2750             }
2751             else
2752             {
2753                 cc = new (comp, GT_SETCC) GenTreeCC(GT_SETCC, condition, TYP_INT);
2754                 BlockRange().InsertAfter(cmp, cc);
2755                 cmpUse.ReplaceWith(comp, cc);
2756             }
2757
2758             cc->gtFlags |= GTF_USE_FLAGS | GTF_UNSIGNED;
2759
2760             return cmp->gtNext;
2761         }
2762 #endif // _TARGET_XARCH_
2763     }
2764     else if (cmp->OperIs(GT_EQ, GT_NE))
2765     {
2766         GenTree* op1 = cmp->gtGetOp1();
2767         GenTree* op2 = cmp->gtGetOp2();
2768
2769         // TODO-CQ: right now the below peep is inexpensive and gets the benefit in most
2770         // cases because in majority of cases op1, op2 and cmp would be in that order in
2771         // execution. In general we should be able to check that all the nodes that come
2772         // after op1 do not modify the flags so that it is safe to avoid generating a
2773         // test instruction.
2774
2775         if (op2->IsIntegralConst(0) && (op1->gtNext == op2) && (op2->gtNext == cmp) &&
2776 #ifdef _TARGET_XARCH_
2777             op1->OperIs(GT_AND, GT_OR, GT_XOR, GT_ADD, GT_SUB, GT_NEG))
2778 #else // _TARGET_ARM64_
2779             op1->OperIs(GT_AND, GT_ADD, GT_SUB))
2780 #endif
2781         {
2782             op1->gtFlags |= GTF_SET_FLAGS;
2783             op1->SetUnusedValue();
2784
2785             BlockRange().Remove(op2);
2786
2787             GenTree*   next = cmp->gtNext;
2788             GenTree*   cc;
2789             genTreeOps ccOp;
2790             LIR::Use   cmpUse;
2791
2792             // Fast check for the common case - relop used by a JTRUE that immediately follows it.
2793             if ((next != nullptr) && next->OperIs(GT_JTRUE) && (next->gtGetOp1() == cmp))
2794             {
2795                 cc   = next;
2796                 ccOp = GT_JCC;
2797                 next = nullptr;
2798                 BlockRange().Remove(cmp);
2799             }
2800             else if (BlockRange().TryGetUse(cmp, &cmpUse) && cmpUse.User()->OperIs(GT_JTRUE))
2801             {
2802                 cc   = cmpUse.User();
2803                 ccOp = GT_JCC;
2804                 next = nullptr;
2805                 BlockRange().Remove(cmp);
2806             }
2807             else // The relop is not used by a JTRUE or it is not used at all.
2808             {
2809                 // Transform the relop node it into a SETCC. If it's not used we could remove
2810                 // it completely but that means doing more work to handle a rare case.
2811                 cc   = cmp;
2812                 ccOp = GT_SETCC;
2813             }
2814
2815             genTreeOps condition = cmp->OperGet();
2816             cc->ChangeOper(ccOp);
2817             cc->AsCC()->gtCondition = condition;
2818             cc->gtFlags |= GTF_USE_FLAGS | (cmp->gtFlags & GTF_UNSIGNED);
2819
2820             return next;
2821         }
2822     }
2823 #endif // defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
2824
2825     return cmp;
2826 }
2827
2828 //------------------------------------------------------------------------
2829 // Lowering::LowerCompare: Lowers a compare node.
2830 //
2831 // Arguments:
2832 //    cmp - the compare node
2833 //
2834 // Return Value:
2835 //    The next node to lower.
2836 //
2837 GenTree* Lowering::LowerCompare(GenTree* cmp)
2838 {
2839 #ifndef _TARGET_64BIT_
2840     if (cmp->gtGetOp1()->TypeGet() == TYP_LONG)
2841     {
2842         return DecomposeLongCompare(cmp);
2843     }
2844 #endif
2845
2846     if (cmp->gtGetOp2()->IsIntegralConst() && !comp->opts.MinOpts())
2847     {
2848         GenTree* next = OptimizeConstCompare(cmp);
2849
2850         // If OptimizeConstCompare return the compare node as "next" then we need to continue lowering.
2851         if (next != cmp)
2852         {
2853             return next;
2854         }
2855     }
2856
2857 #ifdef _TARGET_XARCH_
2858     if (cmp->gtGetOp1()->TypeGet() == cmp->gtGetOp2()->TypeGet())
2859     {
2860         if (varTypeIsSmall(cmp->gtGetOp1()->TypeGet()) && varTypeIsUnsigned(cmp->gtGetOp1()->TypeGet()))
2861         {
2862             //
2863             // If both operands have the same type then codegen will use the common operand type to
2864             // determine the instruction type. For small types this would result in performing a
2865             // signed comparison of two small unsigned values without zero extending them to TYP_INT
2866             // which is incorrect. Note that making the comparison unsigned doesn't imply that codegen
2867             // has to generate a small comparison, it can still correctly generate a TYP_INT comparison.
2868             //
2869
2870             cmp->gtFlags |= GTF_UNSIGNED;
2871         }
2872     }
2873 #endif // _TARGET_XARCH_
2874     ContainCheckCompare(cmp->AsOp());
2875     return cmp->gtNext;
2876 }
2877
2878 //------------------------------------------------------------------------
2879 // Lowering::LowerJTrue: Lowers a JTRUE node.
2880 //
2881 // Arguments:
2882 //    jtrue - the JTRUE node
2883 //
2884 // Return Value:
2885 //    The next node to lower (usually nullptr).
2886 //
2887 // Notes:
2888 //    On ARM64 this may remove the JTRUE node and transform its associated
2889 //    relop into a JCMP node.
2890 //
2891 GenTree* Lowering::LowerJTrue(GenTreeOp* jtrue)
2892 {
2893 #ifdef _TARGET_ARM64_
2894     GenTree* relop    = jtrue->gtGetOp1();
2895     GenTree* relopOp2 = relop->gtOp.gtGetOp2();
2896
2897     if ((relop->gtNext == jtrue) && relopOp2->IsCnsIntOrI())
2898     {
2899         bool     useJCMP = false;
2900         unsigned flags   = 0;
2901
2902         if (relop->OperIs(GT_EQ, GT_NE) && relopOp2->IsIntegralConst(0))
2903         {
2904             // Codegen will use cbz or cbnz in codegen which do not affect the flag register
2905             flags   = relop->OperIs(GT_EQ) ? GTF_JCMP_EQ : 0;
2906             useJCMP = true;
2907         }
2908         else if (relop->OperIs(GT_TEST_EQ, GT_TEST_NE) && isPow2(relopOp2->AsIntCon()->IconValue()))
2909         {
2910             // Codegen will use tbz or tbnz in codegen which do not affect the flag register
2911             flags   = GTF_JCMP_TST | (relop->OperIs(GT_TEST_EQ) ? GTF_JCMP_EQ : 0);
2912             useJCMP = true;
2913         }
2914
2915         if (useJCMP)
2916         {
2917             relop->SetOper(GT_JCMP);
2918             relop->gtFlags &= ~(GTF_JCMP_TST | GTF_JCMP_EQ);
2919             relop->gtFlags |= flags;
2920             relop->gtType = TYP_VOID;
2921
2922             relopOp2->SetContained();
2923
2924             BlockRange().Remove(jtrue);
2925
2926             assert(relop->gtNext == nullptr);
2927             return nullptr;
2928         }
2929     }
2930 #endif // _TARGET_ARM64_
2931
2932     ContainCheckJTrue(jtrue);
2933
2934     assert(jtrue->gtNext == nullptr);
2935     return nullptr;
2936 }
2937
2938 // Lower "jmp <method>" tail call to insert PInvoke method epilog if required.
2939 void Lowering::LowerJmpMethod(GenTree* jmp)
2940 {
2941     assert(jmp->OperGet() == GT_JMP);
2942
2943     JITDUMP("lowering GT_JMP\n");
2944     DISPNODE(jmp);
2945     JITDUMP("============");
2946
2947     // If PInvokes are in-lined, we have to remember to execute PInvoke method epilog anywhere that
2948     // a method returns.
2949     if (comp->info.compCallUnmanaged)
2950     {
2951         InsertPInvokeMethodEpilog(comp->compCurBB DEBUGARG(jmp));
2952     }
2953 }
2954
2955 // Lower GT_RETURN node to insert PInvoke method epilog if required.
2956 void Lowering::LowerRet(GenTree* ret)
2957 {
2958     assert(ret->OperGet() == GT_RETURN);
2959
2960     JITDUMP("lowering GT_RETURN\n");
2961     DISPNODE(ret);
2962     JITDUMP("============");
2963
2964 #if defined(_TARGET_AMD64_) && defined(FEATURE_SIMD)
2965     GenTreeUnOp* const unOp = ret->AsUnOp();
2966     if ((unOp->TypeGet() == TYP_LONG) && (unOp->gtOp1->TypeGet() == TYP_SIMD8))
2967     {
2968         GenTreeUnOp* bitcast = new (comp, GT_BITCAST) GenTreeOp(GT_BITCAST, TYP_LONG, unOp->gtOp1, nullptr);
2969         unOp->gtOp1          = bitcast;
2970         BlockRange().InsertBefore(unOp, bitcast);
2971     }
2972 #endif // _TARGET_AMD64_
2973
2974     // Method doing PInvokes has exactly one return block unless it has tail calls.
2975     if (comp->info.compCallUnmanaged && (comp->compCurBB == comp->genReturnBB))
2976     {
2977         InsertPInvokeMethodEpilog(comp->compCurBB DEBUGARG(ret));
2978     }
2979     ContainCheckRet(ret->AsOp());
2980 }
2981
2982 GenTree* Lowering::LowerDirectCall(GenTreeCall* call)
2983 {
2984     noway_assert(call->gtCallType == CT_USER_FUNC || call->gtCallType == CT_HELPER);
2985
2986     // Don't support tail calling helper methods.
2987     // But we might encounter tail calls dispatched via JIT helper appear as a tail call to helper.
2988     noway_assert(!call->IsTailCall() || call->IsTailCallViaHelper() || call->gtCallType == CT_USER_FUNC);
2989
2990     // Non-virtual direct/indirect calls: Work out if the address of the
2991     // call is known at JIT time.  If not it is either an indirect call
2992     // or the address must be accessed via an single/double indirection.
2993
2994     void*           addr;
2995     InfoAccessType  accessType;
2996     CorInfoHelpFunc helperNum = comp->eeGetHelperNum(call->gtCallMethHnd);
2997
2998 #ifdef FEATURE_READYTORUN_COMPILER
2999     if (call->gtEntryPoint.addr != nullptr)
3000     {
3001         accessType = call->gtEntryPoint.accessType;
3002         addr       = call->gtEntryPoint.addr;
3003     }
3004     else
3005 #endif
3006         if (call->gtCallType == CT_HELPER)
3007     {
3008         noway_assert(helperNum != CORINFO_HELP_UNDEF);
3009
3010         // the convention on getHelperFtn seems to be (it's not documented)
3011         // that it returns an address or if it returns null, pAddr is set to
3012         // another address, which requires an indirection
3013         void* pAddr;
3014         addr = comp->info.compCompHnd->getHelperFtn(helperNum, (void**)&pAddr);
3015
3016         if (addr != nullptr)
3017         {
3018             assert(pAddr == nullptr);
3019             accessType = IAT_VALUE;
3020         }
3021         else
3022         {
3023             accessType = IAT_PVALUE;
3024             addr       = pAddr;
3025         }
3026     }
3027     else
3028     {
3029         noway_assert(helperNum == CORINFO_HELP_UNDEF);
3030
3031         CORINFO_ACCESS_FLAGS aflags = CORINFO_ACCESS_ANY;
3032
3033         if (call->IsSameThis())
3034         {
3035             aflags = (CORINFO_ACCESS_FLAGS)(aflags | CORINFO_ACCESS_THIS);
3036         }
3037
3038         if (!call->NeedsNullCheck())
3039         {
3040             aflags = (CORINFO_ACCESS_FLAGS)(aflags | CORINFO_ACCESS_NONNULL);
3041         }
3042
3043         CORINFO_CONST_LOOKUP addrInfo;
3044         comp->info.compCompHnd->getFunctionEntryPoint(call->gtCallMethHnd, &addrInfo, aflags);
3045
3046         accessType = addrInfo.accessType;
3047         addr       = addrInfo.addr;
3048     }
3049
3050     GenTree* result = nullptr;
3051     switch (accessType)
3052     {
3053         case IAT_VALUE:
3054             // Non-virtual direct call to known address
3055             if (!IsCallTargetInRange(addr) || call->IsTailCall())
3056             {
3057                 result = AddrGen(addr);
3058             }
3059             else
3060             {
3061                 // a direct call within range of hardware relative call instruction
3062                 // stash the address for codegen
3063                 call->gtDirectCallAddress = addr;
3064             }
3065             break;
3066
3067         case IAT_PVALUE:
3068         {
3069             // Non-virtual direct calls to addresses accessed by
3070             // a single indirection.
3071             GenTree* cellAddr = AddrGen(addr);
3072             GenTree* indir    = Ind(cellAddr);
3073             result            = indir;
3074             break;
3075         }
3076
3077         case IAT_PPVALUE:
3078             // Non-virtual direct calls to addresses accessed by
3079             // a double indirection.
3080             //
3081             // Double-indirection. Load the address into a register
3082             // and call indirectly through the register
3083             noway_assert(helperNum == CORINFO_HELP_UNDEF);
3084             result = AddrGen(addr);
3085             result = Ind(Ind(result));
3086             break;
3087
3088         case IAT_RELPVALUE:
3089         {
3090             // Non-virtual direct calls to addresses accessed by
3091             // a single relative indirection.
3092             GenTree* cellAddr = AddrGen(addr);
3093             GenTree* indir    = Ind(cellAddr);
3094             result            = comp->gtNewOperNode(GT_ADD, TYP_I_IMPL, indir, AddrGen(addr));
3095             break;
3096         }
3097
3098         default:
3099             noway_assert(!"Bad accessType");
3100             break;
3101     }
3102
3103     return result;
3104 }
3105
3106 GenTree* Lowering::LowerDelegateInvoke(GenTreeCall* call)
3107 {
3108     noway_assert(call->gtCallType == CT_USER_FUNC);
3109
3110     assert((comp->info.compCompHnd->getMethodAttribs(call->gtCallMethHnd) &
3111             (CORINFO_FLG_DELEGATE_INVOKE | CORINFO_FLG_FINAL)) == (CORINFO_FLG_DELEGATE_INVOKE | CORINFO_FLG_FINAL));
3112
3113     GenTree* thisArgNode;
3114     if (call->IsTailCallViaHelper())
3115     {
3116 #ifdef _TARGET_X86_ // x86 tailcall via helper follows normal calling convention, but with extra stack args.
3117         const unsigned argNum = 0;
3118 #else  // !_TARGET_X86_
3119         // In case of helper dispatched tail calls, "thisptr" will be the third arg.
3120         // The first two args are: real call target and addr of args copy routine.
3121         const unsigned argNum  = 2;
3122 #endif // !_TARGET_X86_
3123
3124         fgArgTabEntry* thisArgTabEntry = comp->gtArgEntryByArgNum(call, argNum);
3125         thisArgNode                    = thisArgTabEntry->node;
3126     }
3127     else
3128     {
3129         thisArgNode = comp->gtGetThisArg(call);
3130     }
3131
3132     assert(thisArgNode->gtOper == GT_PUTARG_REG);
3133     GenTree* originalThisExpr = thisArgNode->gtOp.gtOp1;
3134     GenTree* thisExpr         = originalThisExpr;
3135
3136     // We're going to use the 'this' expression multiple times, so make a local to copy it.
3137
3138     unsigned lclNum;
3139
3140 #ifdef _TARGET_X86_
3141     if (call->IsTailCallViaHelper() && originalThisExpr->IsLocal())
3142     {
3143         // For ordering purposes for the special tailcall arguments on x86, we forced the
3144         // 'this' pointer in this case to a local in Compiler::fgMorphTailCall().
3145         // We could possibly use this case to remove copies for all architectures and non-tailcall
3146         // calls by creating a new lcl var or lcl field reference, as is done in the
3147         // LowerVirtualVtableCall() code.
3148         assert(originalThisExpr->OperGet() == GT_LCL_VAR);
3149         lclNum = originalThisExpr->AsLclVarCommon()->GetLclNum();
3150     }
3151     else
3152 #endif // _TARGET_X86_
3153     {
3154         unsigned delegateInvokeTmp = comp->lvaGrabTemp(true DEBUGARG("delegate invoke call"));
3155
3156         LIR::Use thisExprUse(BlockRange(), &thisArgNode->gtOp.gtOp1, thisArgNode);
3157         ReplaceWithLclVar(thisExprUse, delegateInvokeTmp);
3158
3159         thisExpr = thisExprUse.Def(); // it's changed; reload it.
3160         lclNum   = delegateInvokeTmp;
3161     }
3162
3163     // replace original expression feeding into thisPtr with
3164     // [originalThis + offsetOfDelegateInstance]
3165
3166     GenTree* newThisAddr = new (comp, GT_LEA)
3167         GenTreeAddrMode(TYP_BYREF, thisExpr, nullptr, 0, comp->eeGetEEInfo()->offsetOfDelegateInstance);
3168
3169     GenTree* newThis = comp->gtNewOperNode(GT_IND, TYP_REF, newThisAddr);
3170
3171     BlockRange().InsertAfter(thisExpr, newThisAddr, newThis);
3172
3173     thisArgNode->gtOp.gtOp1 = newThis;
3174     ContainCheckIndir(newThis->AsIndir());
3175
3176     // the control target is
3177     // [originalThis + firstTgtOffs]
3178
3179     GenTree* base = new (comp, GT_LCL_VAR) GenTreeLclVar(originalThisExpr->TypeGet(), lclNum, BAD_IL_OFFSET);
3180
3181     unsigned targetOffs = comp->eeGetEEInfo()->offsetOfDelegateFirstTarget;
3182     GenTree* result     = new (comp, GT_LEA) GenTreeAddrMode(TYP_REF, base, nullptr, 0, targetOffs);
3183     GenTree* callTarget = Ind(result);
3184
3185     // don't need to sequence and insert this tree, caller will do it
3186
3187     return callTarget;
3188 }
3189
3190 GenTree* Lowering::LowerIndirectNonvirtCall(GenTreeCall* call)
3191 {
3192 #ifdef _TARGET_X86_
3193     if (call->gtCallCookie != nullptr)
3194     {
3195         NYI_X86("Morphing indirect non-virtual call with non-standard args");
3196     }
3197 #endif
3198
3199     // Indirect cookie calls gets transformed by fgMorphArgs as indirect call with non-standard args.
3200     // Hence we should never see this type of call in lower.
3201
3202     noway_assert(call->gtCallCookie == nullptr);
3203
3204     return nullptr;
3205 }
3206
3207 //------------------------------------------------------------------------
3208 // CreateReturnTrapSeq: Create a tree to perform a "return trap", used in PInvoke
3209 // epilogs to invoke a GC under a condition. The return trap checks some global
3210 // location (the runtime tells us where that is and how many indirections to make),
3211 // then, based on the result, conditionally calls a GC helper. We use a special node
3212 // for this because at this time (late in the compilation phases), introducing flow
3213 // is tedious/difficult.
3214 //
3215 // This is used for PInvoke inlining.
3216 //
3217 // Return Value:
3218 //    Code tree to perform the action.
3219 //
3220 GenTree* Lowering::CreateReturnTrapSeq()
3221 {
3222     // The GT_RETURNTRAP node expands to this:
3223     //    if (g_TrapReturningThreads)
3224     //    {
3225     //       RareDisablePreemptiveGC();
3226     //    }
3227
3228     // The only thing to do here is build up the expression that evaluates 'g_TrapReturningThreads'.
3229
3230     void* pAddrOfCaptureThreadGlobal = nullptr;
3231     LONG* addrOfCaptureThreadGlobal = comp->info.compCompHnd->getAddrOfCaptureThreadGlobal(&pAddrOfCaptureThreadGlobal);
3232
3233     GenTree* testTree;
3234     if (addrOfCaptureThreadGlobal != nullptr)
3235     {
3236         testTree = Ind(AddrGen(addrOfCaptureThreadGlobal));
3237     }
3238     else
3239     {
3240         testTree = Ind(Ind(AddrGen(pAddrOfCaptureThreadGlobal)));
3241     }
3242     return comp->gtNewOperNode(GT_RETURNTRAP, TYP_INT, testTree);
3243 }
3244
3245 //------------------------------------------------------------------------
3246 // SetGCState: Create a tree that stores the given constant (0 or 1) into the
3247 // thread's GC state field.
3248 //
3249 // This is used for PInvoke inlining.
3250 //
3251 // Arguments:
3252 //    state - constant (0 or 1) to store into the thread's GC state field.
3253 //
3254 // Return Value:
3255 //    Code tree to perform the action.
3256 //
3257 GenTree* Lowering::SetGCState(int state)
3258 {
3259     // Thread.offsetOfGcState = 0/1
3260
3261     assert(state == 0 || state == 1);
3262
3263     const CORINFO_EE_INFO* pInfo = comp->eeGetEEInfo();
3264
3265     GenTree* base = new (comp, GT_LCL_VAR) GenTreeLclVar(TYP_I_IMPL, comp->info.compLvFrameListRoot, -1);
3266
3267     GenTree* stateNode    = new (comp, GT_CNS_INT) GenTreeIntCon(TYP_BYTE, state);
3268     GenTree* addr         = new (comp, GT_LEA) GenTreeAddrMode(TYP_I_IMPL, base, nullptr, 1, pInfo->offsetOfGCState);
3269     GenTree* storeGcState = new (comp, GT_STOREIND) GenTreeStoreInd(TYP_BYTE, addr, stateNode);
3270     return storeGcState;
3271 }
3272
3273 //------------------------------------------------------------------------
3274 // CreateFrameLinkUpdate: Create a tree that either links or unlinks the
3275 // locally-allocated InlinedCallFrame from the Frame list.
3276 //
3277 // This is used for PInvoke inlining.
3278 //
3279 // Arguments:
3280 //    action - whether to link (push) or unlink (pop) the Frame
3281 //
3282 // Return Value:
3283 //    Code tree to perform the action.
3284 //
3285 GenTree* Lowering::CreateFrameLinkUpdate(FrameLinkAction action)
3286 {
3287     const CORINFO_EE_INFO*                       pInfo         = comp->eeGetEEInfo();
3288     const CORINFO_EE_INFO::InlinedCallFrameInfo& callFrameInfo = pInfo->inlinedCallFrameInfo;
3289
3290     GenTree* TCB = new (comp, GT_LCL_VAR) GenTreeLclVar(GT_LCL_VAR, TYP_I_IMPL, comp->info.compLvFrameListRoot,
3291                                                         (IL_OFFSET)-1); // cast to resolve ambiguity.
3292
3293     // Thread->m_pFrame
3294     GenTree* addr = new (comp, GT_LEA) GenTreeAddrMode(TYP_I_IMPL, TCB, nullptr, 1, pInfo->offsetOfThreadFrame);
3295
3296     GenTree* data = nullptr;
3297
3298     if (action == PushFrame)
3299     {
3300         // Thread->m_pFrame = &inlinedCallFrame;
3301         data = new (comp, GT_LCL_FLD_ADDR)
3302             GenTreeLclFld(GT_LCL_FLD_ADDR, TYP_BYREF, comp->lvaInlinedPInvokeFrameVar, callFrameInfo.offsetOfFrameVptr);
3303     }
3304     else
3305     {
3306         assert(action == PopFrame);
3307         // Thread->m_pFrame = inlinedCallFrame.m_pNext;
3308
3309         data = new (comp, GT_LCL_FLD) GenTreeLclFld(GT_LCL_FLD, TYP_BYREF, comp->lvaInlinedPInvokeFrameVar,
3310                                                     pInfo->inlinedCallFrameInfo.offsetOfFrameLink);
3311     }
3312     GenTree* storeInd = new (comp, GT_STOREIND) GenTreeStoreInd(TYP_I_IMPL, addr, data);
3313     return storeInd;
3314 }
3315
3316 //------------------------------------------------------------------------
3317 // InsertPInvokeMethodProlog: Create the code that runs at the start of
3318 // every method that has PInvoke calls.
3319 //
3320 // Initialize the TCB local and the InlinedCallFrame object. Then link ("push")
3321 // the InlinedCallFrame object on the Frame chain. The layout of InlinedCallFrame
3322 // is defined in vm/frames.h. See also vm/jitinterface.cpp for more information.
3323 // The offsets of these fields is returned by the VM in a call to ICorStaticInfo::getEEInfo().
3324 //
3325 // The (current) layout is as follows:
3326 //
3327 //  64-bit  32-bit                                    CORINFO_EE_INFO
3328 //  offset  offset  field name                        offset                  when set
3329 //  -----------------------------------------------------------------------------------------
3330 //  +00h    +00h    GS cookie                         offsetOfGSCookie
3331 //  +08h    +04h    vptr for class InlinedCallFrame   offsetOfFrameVptr       method prolog
3332 //  +10h    +08h    m_Next                            offsetOfFrameLink       method prolog
3333 //  +18h    +0Ch    m_Datum                           offsetOfCallTarget      call site
3334 //  +20h    n/a     m_StubSecretArg                                           not set by JIT
3335 //  +28h    +10h    m_pCallSiteSP                     offsetOfCallSiteSP      x86: call site, and zeroed in method
3336 //                                                                              prolog;
3337 //                                                                            non-x86: method prolog (SP remains
3338 //                                                                              constant in function, after prolog: no
3339 //                                                                              localloc and PInvoke in same function)
3340 //  +30h    +14h    m_pCallerReturnAddress            offsetOfReturnAddress   call site
3341 //  +38h    +18h    m_pCalleeSavedFP                  offsetOfCalleeSavedFP   not set by JIT
3342 //          +1Ch    JIT retval spill area (int)                               before call_gc    ???
3343 //          +20h    JIT retval spill area (long)                              before call_gc    ???
3344 //          +24h    Saved value of EBP                                        method prolog     ???
3345 //
3346 // Note that in the VM, InlinedCallFrame is a C++ class whose objects have a 'this' pointer that points
3347 // to the InlinedCallFrame vptr (the 2nd field listed above), and the GS cookie is stored *before*
3348 // the object. When we link the InlinedCallFrame onto the Frame chain, we must point at this location,
3349 // and not at the beginning of the InlinedCallFrame local, which is actually the GS cookie.
3350 //
3351 // Return Value:
3352 //    none
3353 //
3354 void Lowering::InsertPInvokeMethodProlog()
3355 {
3356     noway_assert(comp->info.compCallUnmanaged);
3357     noway_assert(comp->lvaInlinedPInvokeFrameVar != BAD_VAR_NUM);
3358
3359     if (comp->opts.ShouldUsePInvokeHelpers())
3360     {
3361         return;
3362     }
3363
3364     JITDUMP("======= Inserting PInvoke method prolog\n");
3365
3366     // The first BB must be a scratch BB in order for us to be able to safely insert the P/Invoke prolog.
3367     assert(comp->fgFirstBBisScratch());
3368
3369     LIR::Range& firstBlockRange = LIR::AsRange(comp->fgFirstBB);
3370
3371     const CORINFO_EE_INFO*                       pInfo         = comp->eeGetEEInfo();
3372     const CORINFO_EE_INFO::InlinedCallFrameInfo& callFrameInfo = pInfo->inlinedCallFrameInfo;
3373
3374     // First arg:  &compiler->lvaInlinedPInvokeFrameVar + callFrameInfo.offsetOfFrameVptr
3375
3376     GenTree* frameAddr = new (comp, GT_LCL_FLD_ADDR)
3377         GenTreeLclFld(GT_LCL_FLD_ADDR, TYP_BYREF, comp->lvaInlinedPInvokeFrameVar, callFrameInfo.offsetOfFrameVptr);
3378
3379     // Call runtime helper to fill in our InlinedCallFrame and push it on the Frame list:
3380     //     TCB = CORINFO_HELP_INIT_PINVOKE_FRAME(&symFrameStart, secretArg);
3381     // for x86, don't pass the secretArg.
3382     CLANG_FORMAT_COMMENT_ANCHOR;
3383
3384 #if defined(_TARGET_X86_) || defined(_TARGET_ARM_)
3385     GenTreeArgList* argList = comp->gtNewArgList(frameAddr);
3386 #else
3387     GenTreeArgList*    argList = comp->gtNewArgList(frameAddr, PhysReg(REG_SECRET_STUB_PARAM));
3388 #endif
3389
3390     GenTree* call = comp->gtNewHelperCallNode(CORINFO_HELP_INIT_PINVOKE_FRAME, TYP_I_IMPL, argList);
3391
3392     // some sanity checks on the frame list root vardsc
3393     LclVarDsc* varDsc = &comp->lvaTable[comp->info.compLvFrameListRoot];
3394     noway_assert(!varDsc->lvIsParam);
3395     noway_assert(varDsc->lvType == TYP_I_IMPL);
3396
3397     GenTree* store =
3398         new (comp, GT_STORE_LCL_VAR) GenTreeLclVar(GT_STORE_LCL_VAR, TYP_I_IMPL, comp->info.compLvFrameListRoot,
3399                                                    (IL_OFFSET)-1); // cast to resolve ambiguity.
3400     store->gtOp.gtOp1 = call;
3401     store->gtFlags |= GTF_VAR_DEF;
3402
3403     GenTree* const insertionPoint = firstBlockRange.FirstNonPhiOrCatchArgNode();
3404
3405     comp->fgMorphTree(store);
3406     firstBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, store));
3407     DISPTREERANGE(firstBlockRange, store);
3408
3409 #if !defined(_TARGET_X86_) && !defined(_TARGET_ARM_)
3410     // For x86, this step is done at the call site (due to stack pointer not being static in the function).
3411     // For arm32, CallSiteSP is set up by the call to CORINFO_HELP_INIT_PINVOKE_FRAME.
3412
3413     // --------------------------------------------------------
3414     // InlinedCallFrame.m_pCallSiteSP = @RSP;
3415
3416     GenTreeLclFld* storeSP = new (comp, GT_STORE_LCL_FLD)
3417         GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar, callFrameInfo.offsetOfCallSiteSP);
3418     storeSP->gtOp1 = PhysReg(REG_SPBASE);
3419     storeSP->gtFlags |= GTF_VAR_DEF;
3420
3421     firstBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, storeSP));
3422     DISPTREERANGE(firstBlockRange, storeSP);
3423
3424 #endif // !defined(_TARGET_X86_) && !defined(_TARGET_ARM_)
3425
3426 #if !defined(_TARGET_ARM_)
3427     // For arm32, CalleeSavedFP is set up by the call to CORINFO_HELP_INIT_PINVOKE_FRAME.
3428
3429     // --------------------------------------------------------
3430     // InlinedCallFrame.m_pCalleeSavedEBP = @RBP;
3431
3432     GenTreeLclFld* storeFP =
3433         new (comp, GT_STORE_LCL_FLD) GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar,
3434                                                    callFrameInfo.offsetOfCalleeSavedFP);
3435     storeFP->gtOp1 = PhysReg(REG_FPBASE);
3436     storeFP->gtFlags |= GTF_VAR_DEF;
3437
3438     firstBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, storeFP));
3439     DISPTREERANGE(firstBlockRange, storeFP);
3440 #endif // !defined(_TARGET_ARM_)
3441
3442     // --------------------------------------------------------
3443     // On 32-bit targets, CORINFO_HELP_INIT_PINVOKE_FRAME initializes the PInvoke frame and then pushes it onto
3444     // the current thread's Frame stack. On 64-bit targets, it only initializes the PInvoke frame.
3445     CLANG_FORMAT_COMMENT_ANCHOR;
3446
3447 #ifdef _TARGET_64BIT_
3448     if (comp->opts.jitFlags->IsSet(JitFlags::JIT_FLAG_IL_STUB))
3449     {
3450         // Push a frame - if we are NOT in an IL stub, this is done right before the call
3451         // The init routine sets InlinedCallFrame's m_pNext, so we just set the thead's top-of-stack
3452         GenTree* frameUpd = CreateFrameLinkUpdate(PushFrame);
3453         firstBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, frameUpd));
3454         ContainCheckStoreIndir(frameUpd->AsIndir());
3455         DISPTREERANGE(firstBlockRange, frameUpd);
3456     }
3457 #endif // _TARGET_64BIT_
3458 }
3459
3460 //------------------------------------------------------------------------
3461 // InsertPInvokeMethodEpilog: Code that needs to be run when exiting any method
3462 // that has PInvoke inlines. This needs to be inserted any place you can exit the
3463 // function: returns, tailcalls and jmps.
3464 //
3465 // Arguments:
3466 //    returnBB   -  basic block from which a method can return
3467 //    lastExpr   -  GenTree of the last top level stmnt of returnBB (debug only arg)
3468 //
3469 // Return Value:
3470 //    Code tree to perform the action.
3471 //
3472 void Lowering::InsertPInvokeMethodEpilog(BasicBlock* returnBB DEBUGARG(GenTree* lastExpr))
3473 {
3474     assert(returnBB != nullptr);
3475     assert(comp->info.compCallUnmanaged);
3476
3477     if (comp->opts.ShouldUsePInvokeHelpers())
3478     {
3479         return;
3480     }
3481
3482     JITDUMP("======= Inserting PInvoke method epilog\n");
3483
3484     // Method doing PInvoke calls has exactly one return block unless it has "jmp" or tail calls.
3485     assert(((returnBB == comp->genReturnBB) && (returnBB->bbJumpKind == BBJ_RETURN)) ||
3486            returnBB->endsWithTailCallOrJmp(comp));
3487
3488     LIR::Range& returnBlockRange = LIR::AsRange(returnBB);
3489
3490     GenTree* insertionPoint = returnBlockRange.LastNode();
3491     assert(insertionPoint == lastExpr);
3492
3493     // Note: PInvoke Method Epilog (PME) needs to be inserted just before GT_RETURN, GT_JMP or GT_CALL node in execution
3494     // order so that it is guaranteed that there will be no further PInvokes after that point in the method.
3495     //
3496     // Example1: GT_RETURN(op1) - say execution order is: Op1, GT_RETURN.  After inserting PME, execution order would be
3497     //           Op1, PME, GT_RETURN
3498     //
3499     // Example2: GT_CALL(arg side effect computing nodes, Stk Args Setup, Reg Args setup). The execution order would be
3500     //           arg side effect computing nodes, Stk Args setup, Reg Args setup, GT_CALL
3501     //           After inserting PME execution order would be:
3502     //           arg side effect computing nodes, Stk Args setup, Reg Args setup, PME, GT_CALL
3503     //
3504     // Example3: GT_JMP.  After inserting PME execution order would be: PME, GT_JMP
3505     //           That is after PME, args for GT_JMP call will be setup.
3506
3507     // TODO-Cleanup: setting GCState to 1 seems to be redundant as InsertPInvokeCallProlog will set it to zero before a
3508     // PInvoke call and InsertPInvokeCallEpilog() will set it back to 1 after the PInvoke.  Though this is redundant,
3509     // it is harmeless.
3510     // Note that liveness is artificially extending the life of compLvFrameListRoot var if the method being compiled has
3511     // PInvokes.  Deleting the below stmnt would cause an an assert in lsra.cpp::SetLastUses() since compLvFrameListRoot
3512     // will be live-in to a BBJ_RETURN block without any uses.  Long term we need to fix liveness for x64 case to
3513     // properly extend the life of compLvFrameListRoot var.
3514     //
3515     // Thread.offsetOfGcState = 0/1
3516     // That is [tcb + offsetOfGcState] = 1
3517     GenTree* storeGCState = SetGCState(1);
3518     returnBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, storeGCState));
3519     ContainCheckStoreIndir(storeGCState->AsIndir());
3520
3521     // Pop the frame if necessary. This always happens in the epilog on 32-bit targets. For 64-bit targets, we only do
3522     // this in the epilog for IL stubs; for non-IL stubs the frame is popped after every PInvoke call.
3523     CLANG_FORMAT_COMMENT_ANCHOR;
3524
3525 #ifdef _TARGET_64BIT_
3526     if (comp->opts.jitFlags->IsSet(JitFlags::JIT_FLAG_IL_STUB))
3527 #endif // _TARGET_64BIT_
3528     {
3529         GenTree* frameUpd = CreateFrameLinkUpdate(PopFrame);
3530         returnBlockRange.InsertBefore(insertionPoint, LIR::SeqTree(comp, frameUpd));
3531         ContainCheckStoreIndir(frameUpd->AsIndir());
3532     }
3533 }
3534
3535 //------------------------------------------------------------------------
3536 // InsertPInvokeCallProlog: Emit the call-site prolog for direct calls to unmanaged code.
3537 // It does all the necessary call-site setup of the InlinedCallFrame.
3538 //
3539 // Arguments:
3540 //    call - the call for which we are inserting the PInvoke prolog.
3541 //
3542 // Return Value:
3543 //    None.
3544 //
3545 void Lowering::InsertPInvokeCallProlog(GenTreeCall* call)
3546 {
3547     JITDUMP("======= Inserting PInvoke call prolog\n");
3548
3549     GenTree* insertBefore = call;
3550     if (call->gtCallType == CT_INDIRECT)
3551     {
3552         bool isClosed;
3553         insertBefore = BlockRange().GetTreeRange(call->gtCallAddr, &isClosed).FirstNode();
3554         assert(isClosed);
3555     }
3556
3557     const CORINFO_EE_INFO::InlinedCallFrameInfo& callFrameInfo = comp->eeGetEEInfo()->inlinedCallFrameInfo;
3558
3559     gtCallTypes callType = (gtCallTypes)call->gtCallType;
3560
3561     noway_assert(comp->lvaInlinedPInvokeFrameVar != BAD_VAR_NUM);
3562
3563     if (comp->opts.ShouldUsePInvokeHelpers())
3564     {
3565         // First argument is the address of the frame variable.
3566         GenTree* frameAddr = new (comp, GT_LCL_VAR_ADDR)
3567             GenTreeLclVar(GT_LCL_VAR_ADDR, TYP_BYREF, comp->lvaInlinedPInvokeFrameVar, BAD_IL_OFFSET);
3568
3569         // Insert call to CORINFO_HELP_JIT_PINVOKE_BEGIN
3570         GenTree* helperCall =
3571             comp->gtNewHelperCallNode(CORINFO_HELP_JIT_PINVOKE_BEGIN, TYP_VOID, comp->gtNewArgList(frameAddr));
3572
3573         comp->fgMorphTree(helperCall);
3574         BlockRange().InsertBefore(insertBefore, LIR::SeqTree(comp, helperCall));
3575         LowerNode(helperCall); // helper call is inserted before current node and should be lowered here.
3576         return;
3577     }
3578
3579     // Emit the following sequence:
3580     //
3581     // InlinedCallFrame.callTarget = methodHandle   // stored in m_Datum
3582     // InlinedCallFrame.m_pCallSiteSP = SP          // x86 only
3583     // InlinedCallFrame.m_pCallerReturnAddress = return address
3584     // Thread.gcState = 0
3585     // (non-stub) - update top Frame on TCB         // 64-bit targets only
3586
3587     // ----------------------------------------------------------------------------------
3588     // Setup InlinedCallFrame.callSiteTarget (which is how the JIT refers to it).
3589     // The actual field is InlinedCallFrame.m_Datum which has many different uses and meanings.
3590
3591     GenTree* src = nullptr;
3592
3593     if (callType == CT_INDIRECT)
3594     {
3595 #if !defined(_TARGET_64BIT_)
3596         // On 32-bit targets, indirect calls need the size of the stack args in InlinedCallFrame.m_Datum.
3597         const unsigned numStkArgBytes = call->fgArgInfo->GetNextSlotNum() * TARGET_POINTER_SIZE;
3598
3599         src = comp->gtNewIconNode(numStkArgBytes, TYP_INT);
3600 #else
3601         // On 64-bit targets, indirect calls may need the stub parameter value in InlinedCallFrame.m_Datum.
3602         // If the stub parameter value is not needed, m_Datum will be initialized by the VM.
3603         if (comp->info.compPublishStubParam)
3604         {
3605             src = comp->gtNewLclvNode(comp->lvaStubArgumentVar, TYP_I_IMPL);
3606         }
3607 #endif // !defined(_TARGET_64BIT_)
3608     }
3609     else
3610     {
3611         assert(callType == CT_USER_FUNC);
3612
3613         void*                 pEmbedMethodHandle = nullptr;
3614         CORINFO_METHOD_HANDLE embedMethodHandle =
3615             comp->info.compCompHnd->embedMethodHandle(call->gtCallMethHnd, &pEmbedMethodHandle);
3616
3617         noway_assert((!embedMethodHandle) != (!pEmbedMethodHandle));
3618
3619         if (embedMethodHandle != nullptr)
3620         {
3621             // InlinedCallFrame.callSiteTarget = methodHandle
3622             src = AddrGen(embedMethodHandle);
3623         }
3624         else
3625         {
3626             // InlinedCallFrame.callSiteTarget = *pEmbedMethodHandle
3627             src = Ind(AddrGen(pEmbedMethodHandle));
3628         }
3629     }
3630
3631     if (src != nullptr)
3632     {
3633         // Store into InlinedCallFrame.m_Datum, the offset of which is given by offsetOfCallTarget.
3634         GenTreeLclFld* store =
3635             new (comp, GT_STORE_LCL_FLD) GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar,
3636                                                        callFrameInfo.offsetOfCallTarget);
3637         store->gtOp1 = src;
3638         store->gtFlags |= GTF_VAR_DEF;
3639
3640         InsertTreeBeforeAndContainCheck(insertBefore, store);
3641     }
3642
3643 #ifdef _TARGET_X86_
3644
3645     // ----------------------------------------------------------------------------------
3646     // InlinedCallFrame.m_pCallSiteSP = SP
3647
3648     GenTreeLclFld* storeCallSiteSP = new (comp, GT_STORE_LCL_FLD)
3649         GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar, callFrameInfo.offsetOfCallSiteSP);
3650
3651     storeCallSiteSP->gtOp1 = PhysReg(REG_SPBASE);
3652     storeCallSiteSP->gtFlags |= GTF_VAR_DEF;
3653
3654     InsertTreeBeforeAndContainCheck(insertBefore, storeCallSiteSP);
3655
3656 #endif
3657
3658     // ----------------------------------------------------------------------------------
3659     // InlinedCallFrame.m_pCallerReturnAddress = &label (the address of the instruction immediately following the call)
3660
3661     GenTreeLclFld* storeLab =
3662         new (comp, GT_STORE_LCL_FLD) GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar,
3663                                                    callFrameInfo.offsetOfReturnAddress);
3664
3665     // We don't have a real label, and inserting one is hard (even if we made a special node),
3666     // so for now we will just 'know' what this means in codegen.
3667     GenTreeLabel* labelRef = new (comp, GT_LABEL) GenTreeLabel(nullptr);
3668     labelRef->gtType       = TYP_I_IMPL;
3669     storeLab->gtOp1        = labelRef;
3670     storeLab->gtFlags |= GTF_VAR_DEF;
3671
3672     InsertTreeBeforeAndContainCheck(insertBefore, storeLab);
3673
3674     // Push the PInvoke frame if necessary. On 32-bit targets this only happens in the method prolog if a method
3675     // contains PInvokes; on 64-bit targets this is necessary in non-stubs.
3676     CLANG_FORMAT_COMMENT_ANCHOR;
3677
3678 #ifdef _TARGET_64BIT_
3679     if (!comp->opts.jitFlags->IsSet(JitFlags::JIT_FLAG_IL_STUB))
3680     {
3681         // Set the TCB's frame to be the one we just created.
3682         // Note the init routine for the InlinedCallFrame (CORINFO_HELP_INIT_PINVOKE_FRAME)
3683         // has prepended it to the linked list to maintain the stack of Frames.
3684         //
3685         // Stubs do this once per stub, not once per call.
3686         GenTree* frameUpd = CreateFrameLinkUpdate(PushFrame);
3687         BlockRange().InsertBefore(insertBefore, LIR::SeqTree(comp, frameUpd));
3688         ContainCheckStoreIndir(frameUpd->AsIndir());
3689     }
3690 #endif // _TARGET_64BIT_
3691
3692     // IMPORTANT **** This instruction must come last!!! ****
3693     // It changes the thread's state to Preemptive mode
3694     // ----------------------------------------------------------------------------------
3695     //  [tcb + offsetOfGcState] = 0
3696
3697     GenTree* storeGCState = SetGCState(0);
3698     BlockRange().InsertBefore(insertBefore, LIR::SeqTree(comp, storeGCState));
3699     ContainCheckStoreIndir(storeGCState->AsIndir());
3700 }
3701
3702 //------------------------------------------------------------------------
3703 // InsertPInvokeCallEpilog: Insert the code that goes after every inlined pinvoke call.
3704 //
3705 // Arguments:
3706 //    call - the call for which we are inserting the PInvoke epilog.
3707 //
3708 // Return Value:
3709 //    None.
3710 //
3711 void Lowering::InsertPInvokeCallEpilog(GenTreeCall* call)
3712 {
3713     JITDUMP("======= Inserting PInvoke call epilog\n");
3714
3715     if (comp->opts.ShouldUsePInvokeHelpers())
3716     {
3717         noway_assert(comp->lvaInlinedPInvokeFrameVar != BAD_VAR_NUM);
3718
3719         // First argument is the address of the frame variable.
3720         GenTree* frameAddr =
3721             new (comp, GT_LCL_VAR) GenTreeLclVar(GT_LCL_VAR, TYP_BYREF, comp->lvaInlinedPInvokeFrameVar, BAD_IL_OFFSET);
3722         frameAddr->SetOperRaw(GT_LCL_VAR_ADDR);
3723
3724         // Insert call to CORINFO_HELP_JIT_PINVOKE_END
3725         GenTreeCall* helperCall =
3726             comp->gtNewHelperCallNode(CORINFO_HELP_JIT_PINVOKE_END, TYP_VOID, comp->gtNewArgList(frameAddr));
3727
3728         comp->fgMorphTree(helperCall);
3729         BlockRange().InsertAfter(call, LIR::SeqTree(comp, helperCall));
3730         ContainCheckCallOperands(helperCall);
3731         return;
3732     }
3733
3734     // gcstate = 1
3735     GenTree* insertionPoint = call->gtNext;
3736
3737     GenTree* tree = SetGCState(1);
3738     BlockRange().InsertBefore(insertionPoint, LIR::SeqTree(comp, tree));
3739     ContainCheckStoreIndir(tree->AsIndir());
3740
3741     tree = CreateReturnTrapSeq();
3742     BlockRange().InsertBefore(insertionPoint, LIR::SeqTree(comp, tree));
3743     ContainCheckReturnTrap(tree->AsOp());
3744
3745     // Pop the frame if necessary. On 32-bit targets this only happens in the method epilog; on 64-bit targets thi
3746     // happens after every PInvoke call in non-stubs. 32-bit targets instead mark the frame as inactive.
3747     CLANG_FORMAT_COMMENT_ANCHOR;
3748
3749 #ifdef _TARGET_64BIT_
3750     if (!comp->opts.jitFlags->IsSet(JitFlags::JIT_FLAG_IL_STUB))
3751     {
3752         tree = CreateFrameLinkUpdate(PopFrame);
3753         BlockRange().InsertBefore(insertionPoint, LIR::SeqTree(comp, tree));
3754         ContainCheckStoreIndir(tree->AsIndir());
3755     }
3756 #else
3757     const CORINFO_EE_INFO::InlinedCallFrameInfo& callFrameInfo = comp->eeGetEEInfo()->inlinedCallFrameInfo;
3758
3759     // ----------------------------------------------------------------------------------
3760     // InlinedCallFrame.m_pCallerReturnAddress = nullptr
3761
3762     GenTreeLclFld* const storeCallSiteTracker =
3763         new (comp, GT_STORE_LCL_FLD) GenTreeLclFld(GT_STORE_LCL_FLD, TYP_I_IMPL, comp->lvaInlinedPInvokeFrameVar,
3764                                                    callFrameInfo.offsetOfReturnAddress);
3765
3766     GenTreeIntCon* const constantZero = new (comp, GT_CNS_INT) GenTreeIntCon(TYP_I_IMPL, 0);
3767
3768     storeCallSiteTracker->gtOp1 = constantZero;
3769     storeCallSiteTracker->gtFlags |= GTF_VAR_DEF;
3770
3771     BlockRange().InsertBefore(insertionPoint, constantZero, storeCallSiteTracker);
3772     ContainCheckStoreLoc(storeCallSiteTracker);
3773 #endif // _TARGET_64BIT_
3774 }
3775
3776 //------------------------------------------------------------------------
3777 // LowerNonvirtPinvokeCall: Lower a non-virtual / indirect PInvoke call
3778 //
3779 // Arguments:
3780 //    call - The call to lower.
3781 //
3782 // Return Value:
3783 //    The lowered call tree.
3784 //
3785 GenTree* Lowering::LowerNonvirtPinvokeCall(GenTreeCall* call)
3786 {
3787     // PInvoke lowering varies depending on the flags passed in by the EE. By default,
3788     // GC transitions are generated inline; if CORJIT_FLAG_USE_PINVOKE_HELPERS is specified,
3789     // GC transitions are instead performed using helper calls. Examples of each case are given
3790     // below. Note that the data structure that is used to store information about a call frame
3791     // containing any P/Invoke calls is initialized in the method prolog (see
3792     // InsertPInvokeMethod{Prolog,Epilog} for details).
3793     //
3794     // Inline transitions:
3795     //     InlinedCallFrame inlinedCallFrame;
3796     //
3797     //     ...
3798     //
3799     //     // Set up frame information
3800     //     inlinedCallFrame.callTarget = methodHandle;      // stored in m_Datum
3801     //     inlinedCallFrame.m_pCallSiteSP = SP;             // x86 only
3802     //     inlinedCallFrame.m_pCallerReturnAddress = &label; (the address of the instruction immediately following the
3803     //     call)
3804     //     Thread.m_pFrame = &inlinedCallFrame; (non-IL-stub only)
3805     //
3806     //     // Switch the thread's GC mode to preemptive mode
3807     //     thread->m_fPreemptiveGCDisabled = 0;
3808     //
3809     //     // Call the unmanaged method
3810     //     target();
3811     //
3812     //     // Switch the thread's GC mode back to cooperative mode
3813     //     thread->m_fPreemptiveGCDisabled = 1;
3814     //
3815     //     // Rendezvous with a running collection if necessary
3816     //     if (g_TrapReturningThreads)
3817     //         RareDisablePreemptiveGC();
3818     //
3819     // Transistions using helpers:
3820     //
3821     //     OpaqueFrame opaqueFrame;
3822     //
3823     //     ...
3824     //
3825     //     // Call the JIT_PINVOKE_BEGIN helper
3826     //     JIT_PINVOKE_BEGIN(&opaqueFrame);
3827     //
3828     //     // Call the unmanaged method
3829     //     target();
3830     //
3831     //     // Call the JIT_PINVOKE_END helper
3832     //     JIT_PINVOKE_END(&opaqueFrame);
3833     //
3834     // Note that the JIT_PINVOKE_{BEGIN.END} helpers currently use the default calling convention for the target
3835     // platform. They may be changed in the future such that they preserve all register values.
3836
3837     GenTree* result = nullptr;
3838     void*    addr   = nullptr;
3839
3840     // assert we have seen one of these
3841     noway_assert(comp->info.compCallUnmanaged != 0);
3842
3843     // All code generated by this function must not contain the randomly-inserted NOPs
3844     // that we insert to inhibit JIT spraying in partial trust scenarios.
3845     // The PINVOKE_PROLOG op signals this to the code generator/emitter.
3846
3847     GenTree* prolog = new (comp, GT_NOP) GenTree(GT_PINVOKE_PROLOG, TYP_VOID);
3848     BlockRange().InsertBefore(call, prolog);
3849
3850     InsertPInvokeCallProlog(call);
3851
3852     if (call->gtCallType != CT_INDIRECT)
3853     {
3854         noway_assert(call->gtCallType == CT_USER_FUNC);
3855         CORINFO_METHOD_HANDLE methHnd = call->gtCallMethHnd;
3856
3857         CORINFO_CONST_LOOKUP lookup;
3858         comp->info.compCompHnd->getAddressOfPInvokeTarget(methHnd, &lookup);
3859
3860         void* addr = lookup.addr;
3861         switch (lookup.accessType)
3862         {
3863             case IAT_VALUE:
3864                 if (!IsCallTargetInRange(addr))
3865                 {
3866                     result = AddrGen(addr);
3867                 }
3868                 else
3869                 {
3870                     // a direct call within range of hardware relative call instruction
3871                     // stash the address for codegen
3872                     call->gtDirectCallAddress = addr;
3873 #ifdef FEATURE_READYTORUN_COMPILER
3874                     call->gtEntryPoint.addr       = nullptr;
3875                     call->gtEntryPoint.accessType = IAT_VALUE;
3876 #endif
3877                 }
3878                 break;
3879
3880             case IAT_PVALUE:
3881                 result = Ind(AddrGen(addr));
3882                 break;
3883
3884             case IAT_PPVALUE:
3885                 result = Ind(Ind(AddrGen(addr)));
3886                 break;
3887
3888             case IAT_RELPVALUE:
3889                 unreached();
3890         }
3891     }
3892
3893     InsertPInvokeCallEpilog(call);
3894
3895     return result;
3896 }
3897
3898 // Expand the code necessary to calculate the control target.
3899 // Returns: the expression needed to calculate the control target
3900 // May insert embedded statements
3901 GenTree* Lowering::LowerVirtualVtableCall(GenTreeCall* call)
3902 {
3903     noway_assert(call->gtCallType == CT_USER_FUNC);
3904
3905     // If this is a tail call via helper, thisPtr will be the third argument.
3906     int       thisPtrArgNum;
3907     regNumber thisPtrArgReg;
3908
3909 #ifndef _TARGET_X86_ // x86 tailcall via helper follows normal calling convention, but with extra stack args.
3910     if (call->IsTailCallViaHelper())
3911     {
3912         thisPtrArgNum = 2;
3913         thisPtrArgReg = REG_ARG_2;
3914     }
3915     else
3916 #endif // !_TARGET_X86_
3917     {
3918         thisPtrArgNum = 0;
3919         thisPtrArgReg = comp->codeGen->genGetThisArgReg(call);
3920     }
3921
3922     // get a reference to the thisPtr being passed
3923     fgArgTabEntry* argEntry = comp->gtArgEntryByArgNum(call, thisPtrArgNum);
3924     assert(argEntry->regNum == thisPtrArgReg);
3925     assert(argEntry->node->gtOper == GT_PUTARG_REG);
3926     GenTree* thisPtr = argEntry->node->gtOp.gtOp1;
3927
3928     // If what we are passing as the thisptr is not already a local, make a new local to place it in
3929     // because we will be creating expressions based on it.
3930     unsigned lclNum;
3931     if (thisPtr->IsLocal())
3932     {
3933         lclNum = thisPtr->gtLclVarCommon.gtLclNum;
3934     }
3935     else
3936     {
3937         // Split off the thisPtr and store to a temporary variable.
3938         if (vtableCallTemp == BAD_VAR_NUM)
3939         {
3940             vtableCallTemp = comp->lvaGrabTemp(true DEBUGARG("virtual vtable call"));
3941         }
3942
3943         LIR::Use thisPtrUse(BlockRange(), &(argEntry->node->gtOp.gtOp1), argEntry->node);
3944         ReplaceWithLclVar(thisPtrUse, vtableCallTemp);
3945
3946         lclNum = vtableCallTemp;
3947     }
3948
3949     // Get hold of the vtable offset (note: this might be expensive)
3950     unsigned vtabOffsOfIndirection;
3951     unsigned vtabOffsAfterIndirection;
3952     bool     isRelative;
3953     comp->info.compCompHnd->getMethodVTableOffset(call->gtCallMethHnd, &vtabOffsOfIndirection,
3954                                                   &vtabOffsAfterIndirection, &isRelative);
3955
3956     // If the thisPtr is a local field, then construct a local field type node
3957     GenTree* local;
3958     if (thisPtr->isLclField())
3959     {
3960         local = new (comp, GT_LCL_FLD)
3961             GenTreeLclFld(GT_LCL_FLD, thisPtr->TypeGet(), lclNum, thisPtr->AsLclFld()->gtLclOffs);
3962     }
3963     else
3964     {
3965         local = new (comp, GT_LCL_VAR) GenTreeLclVar(GT_LCL_VAR, thisPtr->TypeGet(), lclNum, BAD_IL_OFFSET);
3966     }
3967
3968     // pointer to virtual table = [REG_CALL_THIS + offs]
3969     GenTree* result = Ind(Offset(local, VPTR_OFFS));
3970
3971     // Get the appropriate vtable chunk
3972     if (vtabOffsOfIndirection != CORINFO_VIRTUALCALL_NO_CHUNK)
3973     {
3974         if (isRelative)
3975         {
3976             // MethodTable offset is a relative pointer.
3977             //
3978             // Additional temporary variable is used to store virtual table pointer.
3979             // Address of method is obtained by the next computations:
3980             //
3981             // Save relative offset to tmp (vtab is virtual table pointer, vtabOffsOfIndirection is offset of
3982             // vtable-1st-level-indirection):
3983             // tmp = vtab
3984             //
3985             // Save address of method to result (vtabOffsAfterIndirection is offset of vtable-2nd-level-indirection):
3986             // result = [tmp + vtabOffsOfIndirection + vtabOffsAfterIndirection + [tmp + vtabOffsOfIndirection]]
3987             //
3988             //
3989             // If relative pointers are also in second level indirection, additional temporary is used:
3990             // tmp1 = vtab
3991             // tmp2 = tmp1 + vtabOffsOfIndirection + vtabOffsAfterIndirection + [tmp1 + vtabOffsOfIndirection]
3992             // result = tmp2 + [tmp2]
3993             //
3994             unsigned lclNumTmp  = comp->lvaGrabTemp(true DEBUGARG("lclNumTmp"));
3995             unsigned lclNumTmp2 = comp->lvaGrabTemp(true DEBUGARG("lclNumTmp2"));
3996
3997             GenTree* lclvNodeStore = comp->gtNewTempAssign(lclNumTmp, result);
3998
3999             GenTree* tmpTree = comp->gtNewLclvNode(lclNumTmp, result->TypeGet());
4000             tmpTree          = Offset(tmpTree, vtabOffsOfIndirection);
4001
4002             tmpTree       = comp->gtNewOperNode(GT_IND, TYP_I_IMPL, tmpTree, false);
4003             GenTree* offs = comp->gtNewIconNode(vtabOffsOfIndirection + vtabOffsAfterIndirection, TYP_INT);
4004             result = comp->gtNewOperNode(GT_ADD, TYP_I_IMPL, comp->gtNewLclvNode(lclNumTmp, result->TypeGet()), offs);
4005
4006             GenTree* base           = OffsetByIndexWithScale(result, tmpTree, 1);
4007             GenTree* lclvNodeStore2 = comp->gtNewTempAssign(lclNumTmp2, base);
4008
4009             LIR::Range range = LIR::SeqTree(comp, lclvNodeStore);
4010             JITDUMP("result of obtaining pointer to virtual table:\n");
4011             DISPRANGE(range);
4012             BlockRange().InsertBefore(call, std::move(range));
4013
4014             LIR::Range range2 = LIR::SeqTree(comp, lclvNodeStore2);
4015             JITDUMP("result of obtaining pointer to virtual table 2nd level indirection:\n");
4016             DISPRANGE(range2);
4017             BlockRange().InsertAfter(lclvNodeStore, std::move(range2));
4018
4019             result = Ind(comp->gtNewLclvNode(lclNumTmp2, result->TypeGet()));
4020             result =
4021                 comp->gtNewOperNode(GT_ADD, TYP_I_IMPL, result, comp->gtNewLclvNode(lclNumTmp2, result->TypeGet()));
4022         }
4023         else
4024         {
4025             // result = [REG_CALL_IND_SCRATCH + vtabOffsOfIndirection]
4026             result = Ind(Offset(result, vtabOffsOfIndirection));
4027         }
4028     }
4029     else
4030     {
4031         assert(!isRelative);
4032     }
4033
4034     // Load the function address
4035     // result = [reg+vtabOffs]
4036     if (!isRelative)
4037     {
4038         result = Ind(Offset(result, vtabOffsAfterIndirection));
4039     }
4040
4041     return result;
4042 }
4043
4044 // Lower stub dispatched virtual calls.
4045 GenTree* Lowering::LowerVirtualStubCall(GenTreeCall* call)
4046 {
4047     assert(call->IsVirtualStub());
4048
4049     // An x86 JIT which uses full stub dispatch must generate only
4050     // the following stub dispatch calls:
4051     //
4052     // (1) isCallRelativeIndirect:
4053     //        call dword ptr [rel32]  ;  FF 15 ---rel32----
4054     // (2) isCallRelative:
4055     //        call abc                ;     E8 ---rel32----
4056     // (3) isCallRegisterIndirect:
4057     //     3-byte nop                 ;
4058     //     call dword ptr [eax]       ;     FF 10
4059     //
4060     // THIS IS VERY TIGHTLY TIED TO THE PREDICATES IN
4061     // vm\i386\cGenCpu.h, esp. isCallRegisterIndirect.
4062
4063     GenTree* result = nullptr;
4064
4065 #ifdef _TARGET_64BIT_
4066     // Non-tail calls: Jump Stubs are not taken into account by VM for mapping an AV into a NullRef
4067     // exception. Therefore, JIT needs to emit an explicit null check.  Note that Jit64 too generates
4068     // an explicit null check.
4069     //
4070     // Tail calls: fgMorphTailCall() materializes null check explicitly and hence no need to emit
4071     // null check.
4072
4073     // Non-64-bit: No need to null check the this pointer - the dispatch code will deal with this.
4074     // The VM considers exceptions that occur in stubs on 64-bit to be not managed exceptions and
4075     // it would be difficult to change this in a way so that it affects only the right stubs.
4076
4077     if (!call->IsTailCallViaHelper())
4078     {
4079         call->gtFlags |= GTF_CALL_NULLCHECK;
4080     }
4081 #endif
4082
4083     // This is code to set up an indirect call to a stub address computed
4084     // via dictionary lookup.
4085     if (call->gtCallType == CT_INDIRECT)
4086     {
4087         // The importer decided we needed a stub call via a computed
4088         // stub dispatch address, i.e. an address which came from a dictionary lookup.
4089         //   - The dictionary lookup produces an indirected address, suitable for call
4090         //     via "call [VirtualStubParam.reg]"
4091         //
4092         // This combination will only be generated for shared generic code and when
4093         // stub dispatch is active.
4094
4095         // fgMorphArgs will have created trees to pass the address in VirtualStubParam.reg.
4096         // All we have to do here is add an indirection to generate the actual call target.
4097
4098         GenTree* ind = Ind(call->gtCallAddr);
4099         BlockRange().InsertAfter(call->gtCallAddr, ind);
4100         call->gtCallAddr = ind;
4101
4102         ind->gtFlags |= GTF_IND_REQ_ADDR_IN_REG;
4103
4104         ContainCheckIndir(ind->AsIndir());
4105     }
4106     else
4107     {
4108         // Direct stub call.
4109         // Get stub addr. This will return NULL if virtual call stubs are not active
4110         void* stubAddr = call->gtStubCallStubAddr;
4111         noway_assert(stubAddr != nullptr);
4112
4113         // If not CT_INDIRECT,  then it should always be relative indir call.
4114         // This is ensured by VM.
4115         noway_assert(call->IsVirtualStubRelativeIndir());
4116
4117         // Direct stub calls, though the stubAddr itself may still need to be
4118         // accessed via an indirection.
4119         GenTree* addr = AddrGen(stubAddr);
4120
4121 #ifdef _TARGET_X86_
4122         // On x86, for tailcall via helper, the JIT_TailCall helper takes the stubAddr as
4123         // the target address, and we set a flag that it's a VSD call. The helper then
4124         // handles any necessary indirection.
4125         if (call->IsTailCallViaHelper())
4126         {
4127             result = addr;
4128         }
4129 #endif // _TARGET_X86_
4130
4131         if (result == nullptr)
4132         {
4133             result = Ind(addr);
4134         }
4135     }
4136
4137     // TODO-Cleanup: start emitting random NOPS
4138     return result;
4139 }
4140
4141 //------------------------------------------------------------------------
4142 // AddrModeCleanupHelper: Remove the nodes that are no longer used after an
4143 // addressing mode is constructed
4144 //
4145 // Arguments:
4146 //    addrMode - A pointer to a new GenTreeAddrMode
4147 //    node     - The node currently being considered for removal
4148 //
4149 // Return Value:
4150 //    None.
4151 //
4152 // Assumptions:
4153 //    'addrMode' and 'node' must be contained in the current block
4154 //
4155 void Lowering::AddrModeCleanupHelper(GenTreeAddrMode* addrMode, GenTree* node)
4156 {
4157     if (node == addrMode->Base() || node == addrMode->Index())
4158     {
4159         return;
4160     }
4161
4162     // TODO-LIR: change this to use the LIR mark bit and iterate instead of recursing
4163     node->VisitOperands([this, addrMode](GenTree* operand) -> GenTree::VisitResult {
4164         AddrModeCleanupHelper(addrMode, operand);
4165         return GenTree::VisitResult::Continue;
4166     });
4167
4168     BlockRange().Remove(node);
4169 }
4170
4171 //------------------------------------------------------------------------
4172 // Lowering::AreSourcesPossibleModifiedLocals:
4173 //    Given two nodes which will be used in an addressing mode (base,
4174 //    index), check to see if they are lclVar reads, and if so, walk
4175 //    backwards from the use until both reads have been visited to
4176 //    determine if they are potentially modified in that range.
4177 //
4178 // Arguments:
4179 //    addr - the node that uses the base and index nodes
4180 //    base - the base node
4181 //    index - the index node
4182 //
4183 // Returns: true if either the base or index may be modified between the
4184 //          node and addr.
4185 //
4186 bool Lowering::AreSourcesPossiblyModifiedLocals(GenTree* addr, GenTree* base, GenTree* index)
4187 {
4188     assert(addr != nullptr);
4189
4190     unsigned markCount = 0;
4191
4192     SideEffectSet baseSideEffects;
4193     if (base != nullptr)
4194     {
4195         if (base->OperIsLocalRead())
4196         {
4197             baseSideEffects.AddNode(comp, base);
4198         }
4199         else
4200         {
4201             base = nullptr;
4202         }
4203     }
4204
4205     SideEffectSet indexSideEffects;
4206     if (index != nullptr)
4207     {
4208         if (index->OperIsLocalRead())
4209         {
4210             indexSideEffects.AddNode(comp, index);
4211         }
4212         else
4213         {
4214             index = nullptr;
4215         }
4216     }
4217
4218     for (GenTree* cursor = addr;; cursor = cursor->gtPrev)
4219     {
4220         assert(cursor != nullptr);
4221
4222         if (cursor == base)
4223         {
4224             base = nullptr;
4225         }
4226
4227         if (cursor == index)
4228         {
4229             index = nullptr;
4230         }
4231
4232         if ((base == nullptr) && (index == nullptr))
4233         {
4234             return false;
4235         }
4236
4237         m_scratchSideEffects.Clear();
4238         m_scratchSideEffects.AddNode(comp, cursor);
4239         if ((base != nullptr) && m_scratchSideEffects.InterferesWith(baseSideEffects, false))
4240         {
4241             return true;
4242         }
4243
4244         if ((index != nullptr) && m_scratchSideEffects.InterferesWith(indexSideEffects, false))
4245         {
4246             return true;
4247         }
4248     }
4249 }
4250
4251 //------------------------------------------------------------------------
4252 // TryCreateAddrMode: recognize trees which can be implemented using an
4253 //    addressing mode and transform them to a GT_LEA
4254 //
4255 // Arguments:
4256 //    use:     the use of the address we want to transform
4257 //    isIndir: true if this addressing mode is the child of an indir
4258 //
4259 // Returns:
4260 //    The created LEA node or the original address node if an LEA could
4261 //    not be formed.
4262 //
4263 GenTree* Lowering::TryCreateAddrMode(LIR::Use&& use, bool isIndir)
4264 {
4265     GenTree* addr   = use.Def();
4266     GenTree* base   = nullptr;
4267     GenTree* index  = nullptr;
4268     unsigned scale  = 0;
4269     ssize_t  offset = 0;
4270     bool     rev    = false;
4271
4272     // TODO-1stClassStructs: This logic is here to preserve prior behavior. Note that previously
4273     // block ops were not considered for addressing modes, but an add under it may have been.
4274     // This should be replaced with logic that more carefully determines when an addressing mode
4275     // would be beneficial for a block op.
4276     if (isIndir)
4277     {
4278         GenTree* indir = use.User();
4279         if (indir->TypeGet() == TYP_STRUCT)
4280         {
4281             isIndir = false;
4282         }
4283         else if (varTypeIsStruct(indir))
4284         {
4285             // We can have an indirection on the rhs of a block copy (it is the source
4286             // object). This is not a "regular" indirection.
4287             // (Note that the user check could be costly.)
4288             LIR::Use indirUse;
4289             if (BlockRange().TryGetUse(indir, &indirUse) && indirUse.User()->OperIsIndir())
4290             {
4291                 isIndir = false;
4292             }
4293             else
4294             {
4295                 isIndir = !indir->OperIsBlk();
4296             }
4297         }
4298     }
4299
4300     // Find out if an addressing mode can be constructed
4301     bool doAddrMode = comp->codeGen->genCreateAddrMode(addr,   // address
4302                                                        true,   // fold
4303                                                        &rev,   // reverse ops
4304                                                        &base,  // base addr
4305                                                        &index, // index val
4306 #if SCALED_ADDR_MODES
4307                                                        &scale,   // scaling
4308 #endif                                                           // SCALED_ADDR_MODES
4309                                                        &offset); // displacement
4310
4311     if (scale == 0)
4312     {
4313         scale = 1;
4314     }
4315
4316     if (!isIndir)
4317     {
4318         // this is just a reg-const add
4319         if (index == nullptr)
4320         {
4321             return addr;
4322         }
4323
4324         // this is just a reg-reg add
4325         if (scale == 1 && offset == 0)
4326         {
4327             return addr;
4328         }
4329     }
4330
4331     // make sure there are not any side effects between def of leaves and use
4332     if (!doAddrMode || AreSourcesPossiblyModifiedLocals(addr, base, index))
4333     {
4334         JITDUMP("No addressing mode:\n  ");
4335         DISPNODE(addr);
4336         return addr;
4337     }
4338
4339     GenTree* arrLength = nullptr;
4340
4341     JITDUMP("Addressing mode:\n");
4342     JITDUMP("  Base\n    ");
4343     DISPNODE(base);
4344     if (index != nullptr)
4345     {
4346         JITDUMP("  + Index * %u + %d\n    ", scale, offset);
4347         DISPNODE(index);
4348     }
4349     else
4350     {
4351         JITDUMP("  + %d\n", offset);
4352     }
4353
4354     var_types addrModeType = addr->TypeGet();
4355     if (addrModeType == TYP_REF)
4356     {
4357         addrModeType = TYP_BYREF;
4358     }
4359
4360     GenTreeAddrMode* addrMode = new (comp, GT_LEA) GenTreeAddrMode(addrModeType, base, index, scale, offset);
4361
4362     // Neither the base nor the index should now be contained.
4363     if (base != nullptr)
4364     {
4365         base->ClearContained();
4366     }
4367     if (index != nullptr)
4368     {
4369         index->ClearContained();
4370     }
4371     addrMode->gtFlags |= (addr->gtFlags & GTF_IND_FLAGS);
4372     addrMode->gtFlags &= ~GTF_ALL_EFFECT; // LEAs are side-effect-free.
4373
4374     JITDUMP("New addressing mode node:\n");
4375     DISPNODE(addrMode);
4376     JITDUMP("\n");
4377
4378     BlockRange().InsertAfter(addr, addrMode);
4379
4380     // Now we need to remove all the nodes subsumed by the addrMode
4381     AddrModeCleanupHelper(addrMode, addr);
4382
4383     // Replace the original address node with the addrMode.
4384     use.ReplaceWith(comp, addrMode);
4385
4386     return addrMode;
4387 }
4388
4389 //------------------------------------------------------------------------
4390 // LowerAdd: turn this add into a GT_LEA if that would be profitable
4391 //
4392 // Arguments:
4393 //    node - the node we care about
4394 //
4395 // Returns:
4396 //    The next node to lower if we have transformed the ADD; nullptr otherwise.
4397 //
4398 GenTree* Lowering::LowerAdd(GenTree* node)
4399 {
4400     GenTree* next = node->gtNext;
4401
4402 #ifndef _TARGET_ARMARCH_
4403     if (varTypeIsIntegralOrI(node))
4404     {
4405         LIR::Use use;
4406         if (BlockRange().TryGetUse(node, &use))
4407         {
4408             // If this is a child of an indir, let the parent handle it.
4409             // If there is a chain of adds, only look at the topmost one.
4410             GenTree* parent = use.User();
4411             if (!parent->OperIsIndir() && (parent->gtOper != GT_ADD))
4412             {
4413                 GenTree* addr = TryCreateAddrMode(std::move(use), false);
4414                 if (addr != node)
4415                 {
4416                     return addr->gtNext;
4417                 }
4418             }
4419         }
4420     }
4421 #endif // !_TARGET_ARMARCH_
4422
4423     return nullptr;
4424 }
4425
4426 //------------------------------------------------------------------------
4427 // LowerUnsignedDivOrMod: Lowers a GT_UDIV/GT_UMOD node.
4428 //
4429 // Arguments:
4430 //    divMod - pointer to the GT_UDIV/GT_UMOD node to be lowered
4431 //
4432 // Return Value:
4433 //    Returns a boolean indicating whether the node was transformed.
4434 //
4435 // Notes:
4436 //    - Transform UDIV/UMOD by power of 2 into RSZ/AND
4437 //    - Transform UDIV by constant >= 2^(N-1) into GE
4438 //    - Transform UDIV/UMOD by constant >= 3 into "magic division"
4439 //
4440
4441 bool Lowering::LowerUnsignedDivOrMod(GenTreeOp* divMod)
4442 {
4443     assert(divMod->OperIs(GT_UDIV, GT_UMOD));
4444
4445 #if defined(USE_HELPERS_FOR_INT_DIV)
4446     if (!varTypeIsIntegral(divMod->TypeGet()))
4447     {
4448         assert(!"unreachable: integral GT_UDIV/GT_UMOD should get morphed into helper calls");
4449     }
4450     assert(varTypeIsFloating(divMod->TypeGet()));
4451 #endif // USE_HELPERS_FOR_INT_DIV
4452 #if defined(_TARGET_ARM64_)
4453     assert(divMod->OperGet() != GT_UMOD);
4454 #endif // _TARGET_ARM64_
4455
4456     GenTree* next     = divMod->gtNext;
4457     GenTree* dividend = divMod->gtGetOp1();
4458     GenTree* divisor  = divMod->gtGetOp2();
4459
4460 #if !defined(_TARGET_64BIT_)
4461     if (dividend->OperIs(GT_LONG))
4462     {
4463         return false;
4464     }
4465 #endif
4466
4467     if (!divisor->IsCnsIntOrI())
4468     {
4469         return false;
4470     }
4471
4472     if (dividend->IsCnsIntOrI())
4473     {
4474         // We shouldn't see a divmod with constant operands here but if we do then it's likely
4475         // because optimizations are disabled or it's a case that's supposed to throw an exception.
4476         // Don't optimize this.
4477         return false;
4478     }
4479
4480     const var_types type = divMod->TypeGet();
4481     assert((type == TYP_INT) || (type == TYP_I_IMPL));
4482
4483     size_t divisorValue = static_cast<size_t>(divisor->AsIntCon()->IconValue());
4484
4485     if (type == TYP_INT)
4486     {
4487         // Clear up the upper 32 bits of the value, they may be set to 1 because constants
4488         // are treated as signed and stored in ssize_t which is 64 bit in size on 64 bit targets.
4489         divisorValue &= UINT32_MAX;
4490     }
4491
4492     if (divisorValue == 0)
4493     {
4494         return false;
4495     }
4496
4497     const bool isDiv = divMod->OperIs(GT_UDIV);
4498
4499     if (isPow2(divisorValue))
4500     {
4501         genTreeOps newOper;
4502
4503         if (isDiv)
4504         {
4505             newOper      = GT_RSZ;
4506             divisorValue = genLog2(divisorValue);
4507         }
4508         else
4509         {
4510             newOper = GT_AND;
4511             divisorValue -= 1;
4512         }
4513
4514         divMod->SetOper(newOper);
4515         divisor->gtIntCon.SetIconValue(divisorValue);
4516         ContainCheckNode(divMod);
4517         return true;
4518     }
4519     if (isDiv)
4520     {
4521         // If the divisor is greater or equal than 2^(N - 1) then the result is 1
4522         // iff the dividend is greater or equal than the divisor.
4523         if (((type == TYP_INT) && (divisorValue > (UINT32_MAX / 2))) ||
4524             ((type == TYP_LONG) && (divisorValue > (UINT64_MAX / 2))))
4525         {
4526             divMod->SetOper(GT_GE);
4527             divMod->gtFlags |= GTF_UNSIGNED;
4528             ContainCheckNode(divMod);
4529             return true;
4530         }
4531     }
4532
4533 // TODO-ARM-CQ: Currently there's no GT_MULHI for ARM32
4534 #if defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
4535     if (!comp->opts.MinOpts() && (divisorValue >= 3))
4536     {
4537         size_t magic;
4538         bool   add;
4539         int    shift;
4540
4541         if (type == TYP_INT)
4542         {
4543             magic = MagicDivide::GetUnsigned32Magic(static_cast<uint32_t>(divisorValue), &add, &shift);
4544         }
4545         else
4546         {
4547 #ifdef _TARGET_64BIT_
4548             magic = MagicDivide::GetUnsigned64Magic(static_cast<uint64_t>(divisorValue), &add, &shift);
4549 #else
4550             unreached();
4551 #endif
4552         }
4553
4554         // Depending on the "add" flag returned by GetUnsignedMagicNumberForDivide we need to generate:
4555         // add == false (when divisor == 3 for example):
4556         //     div = (dividend MULHI magic) RSZ shift
4557         // add == true (when divisor == 7 for example):
4558         //     mulhi = dividend MULHI magic
4559         //     div   = (((dividend SUB mulhi) RSZ 1) ADD mulhi)) RSZ (shift - 1)
4560         const bool     requiresAdjustment       = add;
4561         const bool     requiresDividendMultiuse = requiresAdjustment || !isDiv;
4562         const unsigned curBBWeight              = m_block->getBBWeight(comp);
4563         unsigned       dividendLclNum           = BAD_VAR_NUM;
4564
4565         if (requiresDividendMultiuse)
4566         {
4567             LIR::Use dividendUse(BlockRange(), &divMod->gtOp1, divMod);
4568             dividendLclNum = ReplaceWithLclVar(dividendUse);
4569             dividend       = divMod->gtGetOp1();
4570         }
4571
4572         // Insert a new GT_MULHI node before the existing GT_UDIV/GT_UMOD node.
4573         // The existing node will later be transformed into a GT_RSZ/GT_SUB that
4574         // computes the final result. This way don't need to find and change the use
4575         // of the existing node.
4576         GenTree* mulhi = comp->gtNewOperNode(GT_MULHI, type, dividend, divisor);
4577         mulhi->gtFlags |= GTF_UNSIGNED;
4578         divisor->AsIntCon()->SetIconValue(magic);
4579         BlockRange().InsertBefore(divMod, mulhi);
4580         GenTree* firstNode = mulhi;
4581
4582         if (requiresAdjustment)
4583         {
4584             GenTree* dividend = comp->gtNewLclvNode(dividendLclNum, type);
4585             GenTree* sub      = comp->gtNewOperNode(GT_SUB, type, dividend, mulhi);
4586             BlockRange().InsertBefore(divMod, dividend, sub);
4587
4588             GenTree* one = comp->gtNewIconNode(1, TYP_INT);
4589             GenTree* rsz = comp->gtNewOperNode(GT_RSZ, type, sub, one);
4590             BlockRange().InsertBefore(divMod, one, rsz);
4591
4592             LIR::Use mulhiUse(BlockRange(), &sub->gtOp.gtOp2, sub);
4593             unsigned mulhiLclNum = ReplaceWithLclVar(mulhiUse);
4594
4595             GenTree* mulhiCopy = comp->gtNewLclvNode(mulhiLclNum, type);
4596             GenTree* add       = comp->gtNewOperNode(GT_ADD, type, rsz, mulhiCopy);
4597             BlockRange().InsertBefore(divMod, mulhiCopy, add);
4598
4599             mulhi = add;
4600             shift -= 1;
4601         }
4602
4603         GenTree* shiftBy = comp->gtNewIconNode(shift, TYP_INT);
4604         BlockRange().InsertBefore(divMod, shiftBy);
4605
4606         if (isDiv)
4607         {
4608             divMod->SetOper(GT_RSZ);
4609             divMod->gtOp1 = mulhi;
4610             divMod->gtOp2 = shiftBy;
4611         }
4612         else
4613         {
4614             GenTree* div = comp->gtNewOperNode(GT_RSZ, type, mulhi, shiftBy);
4615
4616             // divisor UMOD dividend = dividend SUB (div MUL divisor)
4617             GenTree* divisor  = comp->gtNewIconNode(divisorValue, type);
4618             GenTree* mul      = comp->gtNewOperNode(GT_MUL, type, div, divisor);
4619             GenTree* dividend = comp->gtNewLclvNode(dividendLclNum, type);
4620
4621             divMod->SetOper(GT_SUB);
4622             divMod->gtOp1 = dividend;
4623             divMod->gtOp2 = mul;
4624
4625             BlockRange().InsertBefore(divMod, div, divisor, mul, dividend);
4626         }
4627         ContainCheckRange(firstNode, divMod);
4628
4629         return true;
4630     }
4631 #endif
4632     return false;
4633 }
4634
4635 // LowerConstIntDivOrMod: Transform integer GT_DIV/GT_MOD nodes with a power of 2
4636 //     const divisor into equivalent but faster sequences.
4637 //
4638 // Arguments:
4639 //    node - pointer to the DIV or MOD node
4640 //
4641 // Returns:
4642 //    nullptr if no transformation is done, or the next node in the transformed node sequence that
4643 //    needs to be lowered.
4644 //
4645 GenTree* Lowering::LowerConstIntDivOrMod(GenTree* node)
4646 {
4647     assert((node->OperGet() == GT_DIV) || (node->OperGet() == GT_MOD));
4648     GenTree* divMod   = node;
4649     GenTree* dividend = divMod->gtGetOp1();
4650     GenTree* divisor  = divMod->gtGetOp2();
4651
4652     const var_types type = divMod->TypeGet();
4653     assert((type == TYP_INT) || (type == TYP_LONG));
4654
4655 #if defined(USE_HELPERS_FOR_INT_DIV)
4656     assert(!"unreachable: integral GT_DIV/GT_MOD should get morphed into helper calls");
4657 #endif // USE_HELPERS_FOR_INT_DIV
4658 #if defined(_TARGET_ARM64_)
4659     assert(node->OperGet() != GT_MOD);
4660 #endif // _TARGET_ARM64_
4661
4662     if (!divisor->IsCnsIntOrI())
4663     {
4664         return nullptr; // no transformations to make
4665     }
4666
4667     if (dividend->IsCnsIntOrI())
4668     {
4669         // We shouldn't see a divmod with constant operands here but if we do then it's likely
4670         // because optimizations are disabled or it's a case that's supposed to throw an exception.
4671         // Don't optimize this.
4672         return nullptr;
4673     }
4674
4675     ssize_t divisorValue = divisor->gtIntCon.IconValue();
4676
4677     if (divisorValue == -1 || divisorValue == 0)
4678     {
4679         // x / 0 and x % 0 can't be optimized because they are required to throw an exception.
4680
4681         // x / -1 can't be optimized because INT_MIN / -1 is required to throw an exception.
4682
4683         // x % -1 is always 0 and the IL spec says that the rem instruction "can" throw an exception if x is
4684         // the minimum representable integer. However, the C# spec says that an exception "is" thrown in this
4685         // case so optimizing this case would break C# code.
4686
4687         // A runtime check could be used to handle this case but it's probably too rare to matter.
4688         return nullptr;
4689     }
4690
4691     bool isDiv = divMod->OperGet() == GT_DIV;
4692
4693     if (isDiv)
4694     {
4695         if ((type == TYP_INT && divisorValue == INT_MIN) || (type == TYP_LONG && divisorValue == INT64_MIN))
4696         {
4697             // If the divisor is the minimum representable integer value then we can use a compare,
4698             // the result is 1 iff the dividend equals divisor.
4699             divMod->SetOper(GT_EQ);
4700             return node;
4701         }
4702     }
4703
4704     size_t absDivisorValue =
4705         (divisorValue == SSIZE_T_MIN) ? static_cast<size_t>(divisorValue) : static_cast<size_t>(abs(divisorValue));
4706
4707     if (!isPow2(absDivisorValue))
4708     {
4709         if (comp->opts.MinOpts())
4710         {
4711             return nullptr;
4712         }
4713
4714 #if defined(_TARGET_XARCH_) || defined(_TARGET_ARM64_)
4715         ssize_t magic;
4716         int     shift;
4717
4718         if (type == TYP_INT)
4719         {
4720             magic = MagicDivide::GetSigned32Magic(static_cast<int32_t>(divisorValue), &shift);
4721         }
4722         else
4723         {
4724 #ifdef _TARGET_64BIT_
4725             magic = MagicDivide::GetSigned64Magic(static_cast<int64_t>(divisorValue), &shift);
4726 #else  // !_TARGET_64BIT_
4727             unreached();
4728 #endif // !_TARGET_64BIT_
4729         }
4730
4731         divisor->gtIntConCommon.SetIconValue(magic);
4732
4733         // Insert a new GT_MULHI node in front of the existing GT_DIV/GT_MOD node.
4734         // The existing node will later be transformed into a GT_ADD/GT_SUB that
4735         // computes the final result. This way don't need to find and change the
4736         // use of the existing node.
4737         GenTree* mulhi = comp->gtNewOperNode(GT_MULHI, type, divisor, dividend);
4738         BlockRange().InsertBefore(divMod, mulhi);
4739
4740         // mulhi was the easy part. Now we need to generate different code depending
4741         // on the divisor value:
4742         // For 3 we need:
4743         //     div = signbit(mulhi) + mulhi
4744         // For 5 we need:
4745         //     div = signbit(mulhi) + sar(mulhi, 1) ; requires shift adjust
4746         // For 7 we need:
4747         //     mulhi += dividend                    ; requires add adjust
4748         //     div = signbit(mulhi) + sar(mulhi, 2) ; requires shift adjust
4749         // For -3 we need:
4750         //     mulhi -= dividend                    ; requires sub adjust
4751         //     div = signbit(mulhi) + sar(mulhi, 1) ; requires shift adjust
4752         bool     requiresAddSubAdjust     = signum(divisorValue) != signum(magic);
4753         bool     requiresShiftAdjust      = shift != 0;
4754         bool     requiresDividendMultiuse = requiresAddSubAdjust || !isDiv;
4755         unsigned curBBWeight              = comp->compCurBB->getBBWeight(comp);
4756         unsigned dividendLclNum           = BAD_VAR_NUM;
4757
4758         if (requiresDividendMultiuse)
4759         {
4760             LIR::Use dividendUse(BlockRange(), &mulhi->gtOp.gtOp2, mulhi);
4761             dividendLclNum = ReplaceWithLclVar(dividendUse);
4762         }
4763
4764         GenTree* adjusted;
4765
4766         if (requiresAddSubAdjust)
4767         {
4768             dividend = comp->gtNewLclvNode(dividendLclNum, type);
4769             adjusted = comp->gtNewOperNode(divisorValue > 0 ? GT_ADD : GT_SUB, type, mulhi, dividend);
4770             BlockRange().InsertBefore(divMod, dividend, adjusted);
4771         }
4772         else
4773         {
4774             adjusted = mulhi;
4775         }
4776
4777         GenTree* shiftBy = comp->gtNewIconNode(genTypeSize(type) * 8 - 1, type);
4778         GenTree* signBit = comp->gtNewOperNode(GT_RSZ, type, adjusted, shiftBy);
4779         BlockRange().InsertBefore(divMod, shiftBy, signBit);
4780
4781         LIR::Use adjustedUse(BlockRange(), &signBit->gtOp.gtOp1, signBit);
4782         unsigned adjustedLclNum = ReplaceWithLclVar(adjustedUse);
4783         adjusted                = comp->gtNewLclvNode(adjustedLclNum, type);
4784         BlockRange().InsertBefore(divMod, adjusted);
4785
4786         if (requiresShiftAdjust)
4787         {
4788             shiftBy  = comp->gtNewIconNode(shift, TYP_INT);
4789             adjusted = comp->gtNewOperNode(GT_RSH, type, adjusted, shiftBy);
4790             BlockRange().InsertBefore(divMod, shiftBy, adjusted);
4791         }
4792
4793         if (isDiv)
4794         {
4795             divMod->SetOperRaw(GT_ADD);
4796             divMod->gtOp.gtOp1 = adjusted;
4797             divMod->gtOp.gtOp2 = signBit;
4798         }
4799         else
4800         {
4801             GenTree* div = comp->gtNewOperNode(GT_ADD, type, adjusted, signBit);
4802
4803             dividend = comp->gtNewLclvNode(dividendLclNum, type);
4804
4805             // divisor % dividend = dividend - divisor x div
4806             GenTree* divisor = comp->gtNewIconNode(divisorValue, type);
4807             GenTree* mul     = comp->gtNewOperNode(GT_MUL, type, div, divisor);
4808             BlockRange().InsertBefore(divMod, dividend, div, divisor, mul);
4809
4810             divMod->SetOperRaw(GT_SUB);
4811             divMod->gtOp.gtOp1 = dividend;
4812             divMod->gtOp.gtOp2 = mul;
4813         }
4814
4815         return mulhi;
4816 #elif defined(_TARGET_ARM_)
4817         // Currently there's no GT_MULHI for ARM32
4818         return nullptr;
4819 #else
4820 #error Unsupported or unset target architecture
4821 #endif
4822     }
4823
4824     // We're committed to the conversion now. Go find the use if any.
4825     LIR::Use use;
4826     if (!BlockRange().TryGetUse(node, &use))
4827     {
4828         return nullptr;
4829     }
4830
4831     // We need to use the dividend node multiple times so its value needs to be
4832     // computed once and stored in a temp variable.
4833
4834     unsigned curBBWeight = comp->compCurBB->getBBWeight(comp);
4835
4836     LIR::Use opDividend(BlockRange(), &divMod->gtOp.gtOp1, divMod);
4837     ReplaceWithLclVar(opDividend);
4838
4839     dividend = divMod->gtGetOp1();
4840     assert(dividend->OperGet() == GT_LCL_VAR);
4841
4842     unsigned dividendLclNum = dividend->gtLclVar.gtLclNum;
4843
4844     GenTree* adjustment = comp->gtNewOperNode(GT_RSH, type, dividend, comp->gtNewIconNode(type == TYP_INT ? 31 : 63));
4845
4846     if (absDivisorValue == 2)
4847     {
4848         // If the divisor is +/-2 then we'd end up with a bitwise and between 0/-1 and 1.
4849         // We can get the same result by using GT_RSZ instead of GT_RSH.
4850         adjustment->SetOper(GT_RSZ);
4851     }
4852     else
4853     {
4854         adjustment = comp->gtNewOperNode(GT_AND, type, adjustment, comp->gtNewIconNode(absDivisorValue - 1, type));
4855     }
4856
4857     GenTree* adjustedDividend =
4858         comp->gtNewOperNode(GT_ADD, type, adjustment, comp->gtNewLclvNode(dividendLclNum, type));
4859
4860     GenTree* newDivMod;
4861
4862     if (isDiv)
4863     {
4864         // perform the division by right shifting the adjusted dividend
4865         divisor->gtIntCon.SetIconValue(genLog2(absDivisorValue));
4866
4867         newDivMod = comp->gtNewOperNode(GT_RSH, type, adjustedDividend, divisor);
4868         ContainCheckShiftRotate(newDivMod->AsOp());
4869
4870         if (divisorValue < 0)
4871         {
4872             // negate the result if the divisor is negative
4873             newDivMod = comp->gtNewOperNode(GT_NEG, type, newDivMod);
4874             ContainCheckNode(newDivMod);
4875         }
4876     }
4877     else
4878     {
4879         // divisor % dividend = dividend - divisor x (dividend / divisor)
4880         // divisor x (dividend / divisor) translates to (dividend >> log2(divisor)) << log2(divisor)
4881         // which simply discards the low log2(divisor) bits, that's just dividend & ~(divisor - 1)
4882         divisor->gtIntCon.SetIconValue(~(absDivisorValue - 1));
4883
4884         newDivMod = comp->gtNewOperNode(GT_SUB, type, comp->gtNewLclvNode(dividendLclNum, type),
4885                                         comp->gtNewOperNode(GT_AND, type, adjustedDividend, divisor));
4886     }
4887
4888     // Remove the divisor and dividend nodes from the linear order,
4889     // since we have reused them and will resequence the tree
4890     BlockRange().Remove(divisor);
4891     BlockRange().Remove(dividend);
4892
4893     // linearize and insert the new tree before the original divMod node
4894     InsertTreeBeforeAndContainCheck(divMod, newDivMod);
4895     BlockRange().Remove(divMod);
4896
4897     // replace the original divmod node with the new divmod tree
4898     use.ReplaceWith(comp, newDivMod);
4899
4900     return newDivMod->gtNext;
4901 }
4902 //------------------------------------------------------------------------
4903 // LowerSignedDivOrMod: transform integer GT_DIV/GT_MOD nodes with a power of 2
4904 // const divisor into equivalent but faster sequences.
4905 //
4906 // Arguments:
4907 //    node - the DIV or MOD node
4908 //
4909 // Returns:
4910 //    The next node to lower.
4911 //
4912 GenTree* Lowering::LowerSignedDivOrMod(GenTree* node)
4913 {
4914     assert((node->OperGet() == GT_DIV) || (node->OperGet() == GT_MOD));
4915     GenTree* next     = node->gtNext;
4916     GenTree* divMod   = node;
4917     GenTree* dividend = divMod->gtGetOp1();
4918     GenTree* divisor  = divMod->gtGetOp2();
4919
4920     if (varTypeIsIntegral(node->TypeGet()))
4921     {
4922         // LowerConstIntDivOrMod will return nullptr if it doesn't transform the node.
4923         GenTree* newNode = LowerConstIntDivOrMod(node);
4924         if (newNode != nullptr)
4925         {
4926             return newNode;
4927         }
4928     }
4929     ContainCheckDivOrMod(node->AsOp());
4930
4931     return next;
4932 }
4933
4934 //------------------------------------------------------------------------
4935 // LowerShift: Lower shift nodes
4936 //
4937 // Arguments:
4938 //    shift - the shift node (GT_LSH, GT_RSH or GT_RSZ)
4939 //
4940 // Notes:
4941 //    Remove unnecessary shift count masking, xarch shift instructions
4942 //    mask the shift count to 5 bits (or 6 bits for 64 bit operations).
4943
4944 void Lowering::LowerShift(GenTreeOp* shift)
4945 {
4946     assert(shift->OperIs(GT_LSH, GT_RSH, GT_RSZ));
4947
4948     size_t mask = 0x1f;
4949 #ifdef _TARGET_64BIT_
4950     if (varTypeIsLong(shift->TypeGet()))
4951     {
4952         mask = 0x3f;
4953     }
4954 #else
4955     assert(!varTypeIsLong(shift->TypeGet()));
4956 #endif
4957
4958     for (GenTree* andOp = shift->gtGetOp2(); andOp->OperIs(GT_AND); andOp = andOp->gtGetOp1())
4959     {
4960         GenTree* maskOp = andOp->gtGetOp2();
4961
4962         if (!maskOp->IsCnsIntOrI())
4963         {
4964             break;
4965         }
4966
4967         if ((static_cast<size_t>(maskOp->AsIntCon()->IconValue()) & mask) != mask)
4968         {
4969             break;
4970         }
4971
4972         shift->gtOp2 = andOp->gtGetOp1();
4973         BlockRange().Remove(andOp);
4974         BlockRange().Remove(maskOp);
4975         // The parent was replaced, clear contain and regOpt flag.
4976         shift->gtOp2->ClearContained();
4977     }
4978     ContainCheckShiftRotate(shift);
4979 }
4980
4981 void Lowering::WidenSIMD12IfNecessary(GenTreeLclVarCommon* node)
4982 {
4983 #ifdef FEATURE_SIMD
4984     if (node->TypeGet() == TYP_SIMD12)
4985     {
4986         // Assumption 1:
4987         // RyuJit backend depends on the assumption that on 64-Bit targets Vector3 size is rounded off
4988         // to TARGET_POINTER_SIZE and hence Vector3 locals on stack can be treated as TYP_SIMD16 for
4989         // reading and writing purposes.
4990         //
4991         // Assumption 2:
4992         // RyuJit backend is making another implicit assumption that Vector3 type args when passed in
4993         // registers or on stack, the upper most 4-bytes will be zero.
4994         //
4995         // For P/Invoke return and Reverse P/Invoke argument passing, native compiler doesn't guarantee
4996         // that upper 4-bytes of a Vector3 type struct is zero initialized and hence assumption 2 is
4997         // invalid.
4998         //
4999         // RyuJIT x64 Windows: arguments are treated as passed by ref and hence read/written just 12
5000         // bytes. In case of Vector3 returns, Caller allocates a zero initialized Vector3 local and
5001         // passes it retBuf arg and Callee method writes only 12 bytes to retBuf. For this reason,
5002         // there is no need to clear upper 4-bytes of Vector3 type args.
5003         //
5004         // RyuJIT x64 Unix: arguments are treated as passed by value and read/writen as if TYP_SIMD16.
5005         // Vector3 return values are returned two return registers and Caller assembles them into a
5006         // single xmm reg. Hence RyuJIT explicitly generates code to clears upper 4-bytes of Vector3
5007         // type args in prolog and Vector3 type return value of a call
5008         //
5009         // RyuJIT x86 Windows: all non-param Vector3 local vars are allocated as 16 bytes. Vector3 arguments
5010         // are pushed as 12 bytes. For return values, a 16-byte local is allocated and the address passed
5011         // as a return buffer pointer. The callee doesn't write the high 4 bytes, and we don't need to clear
5012         // it either.
5013
5014         unsigned   varNum = node->AsLclVarCommon()->GetLclNum();
5015         LclVarDsc* varDsc = &comp->lvaTable[varNum];
5016
5017         if (comp->lvaMapSimd12ToSimd16(varDsc))
5018         {
5019             JITDUMP("Mapping TYP_SIMD12 lclvar node to TYP_SIMD16:\n");
5020             DISPNODE(node);
5021             JITDUMP("============");
5022
5023             node->gtType = TYP_SIMD16;
5024         }
5025     }
5026 #endif // FEATURE_SIMD
5027 }
5028
5029 //------------------------------------------------------------------------
5030 // LowerArrElem: Lower a GT_ARR_ELEM node
5031 //
5032 // Arguments:
5033 //    node - the GT_ARR_ELEM node to lower.
5034 //
5035 // Return Value:
5036 //    The next node to lower.
5037 //
5038 // Assumptions:
5039 //    pTree points to a pointer to a GT_ARR_ELEM node.
5040 //
5041 // Notes:
5042 //    This performs the following lowering.  We start with a node of the form:
5043 //          /--*  <arrObj>
5044 //          +--*  <index0>
5045 //          +--*  <index1>
5046 //       /--*  arrMD&[,]
5047 //
5048 //    First, we create temps for arrObj if it is not already a lclVar, and for any of the index
5049 //    expressions that have side-effects.
5050 //    We then transform the tree into:
5051 //                      <offset is null - no accumulated offset for the first index>
5052 //                   /--*  <arrObj>
5053 //                   +--*  <index0>
5054 //                /--*  ArrIndex[i, ]
5055 //                +--*  <arrObj>
5056 //             /--|  arrOffs[i, ]
5057 //             |  +--*  <arrObj>
5058 //             |  +--*  <index1>
5059 //             +--*  ArrIndex[*,j]
5060 //             +--*  <arrObj>
5061 //          /--|  arrOffs[*,j]
5062 //          +--*  lclVar NewTemp
5063 //       /--*  lea (scale = element size, offset = offset of first element)
5064 //
5065 //    The new stmtExpr may be omitted if the <arrObj> is a lclVar.
5066 //    The new stmtExpr may be embedded if the <arrObj> is not the first tree in linear order for
5067 //    the statement containing the original arrMD.
5068 //    Note that the arrMDOffs is the INDEX of the lea, but is evaluated before the BASE (which is the second
5069 //    reference to NewTemp), because that provides more accurate lifetimes.
5070 //    There may be 1, 2 or 3 dimensions, with 1, 2 or 3 arrMDIdx nodes, respectively.
5071 //
5072 GenTree* Lowering::LowerArrElem(GenTree* node)
5073 {
5074     // This will assert if we don't have an ArrElem node
5075     GenTreeArrElem*     arrElem     = node->AsArrElem();
5076     const unsigned char rank        = arrElem->gtArrElem.gtArrRank;
5077     const unsigned      blockWeight = m_block->getBBWeight(comp);
5078
5079     JITDUMP("Lowering ArrElem\n");
5080     JITDUMP("============\n");
5081     DISPTREERANGE(BlockRange(), arrElem);
5082     JITDUMP("\n");
5083
5084     assert(arrElem->gtArrObj->TypeGet() == TYP_REF);
5085
5086     // We need to have the array object in a lclVar.
5087     if (!arrElem->gtArrObj->IsLocal())
5088     {
5089         LIR::Use arrObjUse(BlockRange(), &arrElem->gtArrObj, arrElem);
5090         ReplaceWithLclVar(arrObjUse);
5091     }
5092
5093     GenTree* arrObjNode = arrElem->gtArrObj;
5094     assert(arrObjNode->IsLocal());
5095
5096     LclVarDsc* const varDsc = &comp->lvaTable[arrElem->gtArrObj->AsLclVarCommon()->gtLclNum];
5097
5098     GenTree* insertionPoint = arrElem;
5099
5100     // The first ArrOffs node will have 0 for the offset of the previous dimension.
5101     GenTree* prevArrOffs = new (comp, GT_CNS_INT) GenTreeIntCon(TYP_I_IMPL, 0);
5102     BlockRange().InsertBefore(insertionPoint, prevArrOffs);
5103     GenTree* nextToLower = prevArrOffs;
5104
5105     for (unsigned char dim = 0; dim < rank; dim++)
5106     {
5107         GenTree* indexNode = arrElem->gtArrElem.gtArrInds[dim];
5108
5109         // Use the original arrObjNode on the 0th ArrIndex node, and clone it for subsequent ones.
5110         GenTree* idxArrObjNode;
5111         if (dim == 0)
5112         {
5113             idxArrObjNode = arrObjNode;
5114         }
5115         else
5116         {
5117             idxArrObjNode = comp->gtClone(arrObjNode);
5118             BlockRange().InsertBefore(insertionPoint, idxArrObjNode);
5119         }
5120
5121         // Next comes the GT_ARR_INDEX node.
5122         GenTreeArrIndex* arrMDIdx = new (comp, GT_ARR_INDEX)
5123             GenTreeArrIndex(TYP_INT, idxArrObjNode, indexNode, dim, rank, arrElem->gtArrElem.gtArrElemType);
5124         arrMDIdx->gtFlags |= ((idxArrObjNode->gtFlags | indexNode->gtFlags) & GTF_ALL_EFFECT);
5125         BlockRange().InsertBefore(insertionPoint, arrMDIdx);
5126
5127         GenTree* offsArrObjNode = comp->gtClone(arrObjNode);
5128         BlockRange().InsertBefore(insertionPoint, offsArrObjNode);
5129
5130         GenTreeArrOffs* arrOffs =
5131             new (comp, GT_ARR_OFFSET) GenTreeArrOffs(TYP_I_IMPL, prevArrOffs, arrMDIdx, offsArrObjNode, dim, rank,
5132                                                      arrElem->gtArrElem.gtArrElemType);
5133         arrOffs->gtFlags |= ((prevArrOffs->gtFlags | arrMDIdx->gtFlags | offsArrObjNode->gtFlags) & GTF_ALL_EFFECT);
5134         BlockRange().InsertBefore(insertionPoint, arrOffs);
5135
5136         prevArrOffs = arrOffs;
5137     }
5138
5139     // Generate the LEA and make it reverse evaluation, because we want to evaluate the index expression before the
5140     // base.
5141     unsigned scale  = arrElem->gtArrElem.gtArrElemSize;
5142     unsigned offset = comp->eeGetMDArrayDataOffset(arrElem->gtArrElem.gtArrElemType, arrElem->gtArrElem.gtArrRank);
5143
5144     GenTree* leaIndexNode = prevArrOffs;
5145     if (!jitIsScaleIndexMul(scale))
5146     {
5147         // We do the address arithmetic in TYP_I_IMPL, though note that the lower bounds and lengths in memory are
5148         // TYP_INT
5149         GenTree* scaleNode = new (comp, GT_CNS_INT) GenTreeIntCon(TYP_I_IMPL, scale);
5150         GenTree* mulNode   = new (comp, GT_MUL) GenTreeOp(GT_MUL, TYP_I_IMPL, leaIndexNode, scaleNode);
5151         BlockRange().InsertBefore(insertionPoint, scaleNode, mulNode);
5152         leaIndexNode = mulNode;
5153         scale        = 1;
5154     }
5155
5156     GenTree* leaBase = comp->gtClone(arrObjNode);
5157     BlockRange().InsertBefore(insertionPoint, leaBase);
5158
5159     GenTree* leaNode = new (comp, GT_LEA) GenTreeAddrMode(arrElem->TypeGet(), leaBase, leaIndexNode, scale, offset);
5160
5161     BlockRange().InsertBefore(insertionPoint, leaNode);
5162
5163     LIR::Use arrElemUse;
5164     if (BlockRange().TryGetUse(arrElem, &arrElemUse))
5165     {
5166         arrElemUse.ReplaceWith(comp, leaNode);
5167     }
5168     else
5169     {
5170         leaNode->SetUnusedValue();
5171     }
5172
5173     BlockRange().Remove(arrElem);
5174
5175     JITDUMP("Results of lowering ArrElem:\n");
5176     DISPTREERANGE(BlockRange(), leaNode);
5177     JITDUMP("\n\n");
5178
5179     return nextToLower;
5180 }
5181
5182 void Lowering::DoPhase()
5183 {
5184     // If we have any PInvoke calls, insert the one-time prolog code. We'll inserted the epilog code in the
5185     // appropriate spots later. NOTE: there is a minor optimization opportunity here, as we still create p/invoke
5186     // data structures and setup/teardown even if we've eliminated all p/invoke calls due to dead code elimination.
5187     if (comp->info.compCallUnmanaged)
5188     {
5189         InsertPInvokeMethodProlog();
5190     }
5191
5192 #if !defined(_TARGET_64BIT_)
5193     DecomposeLongs decomp(comp); // Initialize the long decomposition class.
5194     if (comp->compLongUsed)
5195     {
5196         decomp.PrepareForDecomposition();
5197     }
5198 #endif // !defined(_TARGET_64BIT_)
5199
5200     for (BasicBlock* block = comp->fgFirstBB; block; block = block->bbNext)
5201     {
5202         /* Make the block publicly available */
5203         comp->compCurBB = block;
5204
5205 #if !defined(_TARGET_64BIT_)
5206         if (comp->compLongUsed)
5207         {
5208             decomp.DecomposeBlock(block);
5209         }
5210 #endif //!_TARGET_64BIT_
5211
5212         LowerBlock(block);
5213     }
5214
5215 #ifdef DEBUG
5216     JITDUMP("Lower has completed modifying nodes.\n");
5217     if (VERBOSE)
5218     {
5219         comp->fgDispBasicBlocks(true);
5220     }
5221 #endif
5222
5223     // Recompute local var ref counts before potentially sorting for liveness.
5224     // Note this does minimal work in cases where we are not going to sort.
5225     const bool isRecompute    = true;
5226     const bool setSlotNumbers = false;
5227     comp->lvaComputeRefCounts(isRecompute, setSlotNumbers);
5228
5229     comp->fgLocalVarLiveness();
5230     // local var liveness can delete code, which may create empty blocks
5231     if (!comp->opts.MinOpts() && !comp->opts.compDbgCode)
5232     {
5233         comp->optLoopsMarked = false;
5234         bool modified        = comp->fgUpdateFlowGraph();
5235         if (modified)
5236         {
5237             JITDUMP("had to run another liveness pass:\n");
5238             comp->fgLocalVarLiveness();
5239         }
5240     }
5241
5242     // Recompute local var ref counts again after liveness to reflect
5243     // impact of any dead code removal. Note this may leave us with
5244     // tracked vars that have zero refs.
5245     comp->lvaComputeRefCounts(isRecompute, setSlotNumbers);
5246
5247 #ifdef DEBUG
5248     JITDUMP("Liveness pass finished after lowering, IR:\n");
5249     if (VERBOSE)
5250     {
5251         comp->fgDispBasicBlocks(true);
5252     }
5253
5254     for (BasicBlock* block = comp->fgFirstBB; block; block = block->bbNext)
5255     {
5256         assert(LIR::AsRange(block).CheckLIR(comp, true));
5257     }
5258 #endif
5259 }
5260
5261 #ifdef DEBUG
5262
5263 //------------------------------------------------------------------------
5264 // Lowering::CheckCallArg: check that a call argument is in an expected
5265 //                         form after lowering.
5266 //
5267 // Arguments:
5268 //   arg - the argument to check.
5269 //
5270 void Lowering::CheckCallArg(GenTree* arg)
5271 {
5272     if (!arg->IsValue() && !arg->OperIsPutArgStk())
5273     {
5274         assert((arg->OperIsStore() && !arg->IsValue()) || arg->IsArgPlaceHolderNode() || arg->IsNothingNode() ||
5275                arg->OperIsCopyBlkOp());
5276         return;
5277     }
5278
5279     switch (arg->OperGet())
5280     {
5281         case GT_FIELD_LIST:
5282         {
5283             GenTreeFieldList* list = arg->AsFieldList();
5284             assert(list->isContained());
5285             assert(list->IsFieldListHead());
5286
5287             for (; list != nullptr; list = list->Rest())
5288             {
5289                 assert(list->Current()->OperIsPutArg());
5290             }
5291         }
5292         break;
5293
5294         default:
5295             assert(arg->OperIsPutArg());
5296             break;
5297     }
5298 }
5299
5300 //------------------------------------------------------------------------
5301 // Lowering::CheckCall: check that a call is in an expected form after
5302 //                      lowering. Currently this amounts to checking its
5303 //                      arguments, but could be expanded to verify more
5304 //                      properties in the future.
5305 //
5306 // Arguments:
5307 //   call - the call to check.
5308 //
5309 void Lowering::CheckCall(GenTreeCall* call)
5310 {
5311     if (call->gtCallObjp != nullptr)
5312     {
5313         CheckCallArg(call->gtCallObjp);
5314     }
5315
5316     for (GenTreeArgList* args = call->gtCallArgs; args != nullptr; args = args->Rest())
5317     {
5318         CheckCallArg(args->Current());
5319     }
5320
5321     for (GenTreeArgList* args = call->gtCallLateArgs; args != nullptr; args = args->Rest())
5322     {
5323         CheckCallArg(args->Current());
5324     }
5325 }
5326
5327 //------------------------------------------------------------------------
5328 // Lowering::CheckNode: check that an LIR node is in an expected form
5329 //                      after lowering.
5330 //
5331 // Arguments:
5332 //   compiler - the compiler context.
5333 //   node - the node to check.
5334 //
5335 void Lowering::CheckNode(Compiler* compiler, GenTree* node)
5336 {
5337     switch (node->OperGet())
5338     {
5339         case GT_CALL:
5340             CheckCall(node->AsCall());
5341             break;
5342
5343 #ifdef FEATURE_SIMD
5344         case GT_SIMD:
5345             assert(node->TypeGet() != TYP_SIMD12);
5346             break;
5347 #ifdef _TARGET_64BIT_
5348         case GT_LCL_VAR:
5349         case GT_STORE_LCL_VAR:
5350         {
5351             unsigned   lclNum = node->AsLclVarCommon()->GetLclNum();
5352             LclVarDsc* lclVar = &compiler->lvaTable[lclNum];
5353             assert(node->TypeGet() != TYP_SIMD12 || compiler->lvaIsFieldOfDependentlyPromotedStruct(lclVar));
5354         }
5355         break;
5356 #endif // _TARGET_64BIT_
5357 #endif // SIMD
5358
5359         default:
5360             break;
5361     }
5362 }
5363
5364 //------------------------------------------------------------------------
5365 // Lowering::CheckBlock: check that the contents of an LIR block are in an
5366 //                       expected form after lowering.
5367 //
5368 // Arguments:
5369 //   compiler - the compiler context.
5370 //   block    - the block to check.
5371 //
5372 bool Lowering::CheckBlock(Compiler* compiler, BasicBlock* block)
5373 {
5374     assert(block->isEmpty() || block->IsLIR());
5375
5376     LIR::Range& blockRange = LIR::AsRange(block);
5377     for (GenTree* node : blockRange)
5378     {
5379         CheckNode(compiler, node);
5380     }
5381
5382     assert(blockRange.CheckLIR(compiler, true));
5383     return true;
5384 }
5385 #endif
5386
5387 void Lowering::LowerBlock(BasicBlock* block)
5388 {
5389     assert(block == comp->compCurBB); // compCurBB must already be set.
5390     assert(block->isEmpty() || block->IsLIR());
5391
5392     m_block = block;
5393
5394     // NOTE: some of the lowering methods insert calls before the node being
5395     // lowered (See e.g. InsertPInvoke{Method,Call}{Prolog,Epilog}). In
5396     // general, any code that is inserted before the current node should be
5397     // "pre-lowered" as they won't be subject to further processing.
5398     // Lowering::CheckBlock() runs some extra checks on call arguments in
5399     // order to help catch unlowered nodes.
5400
5401     GenTree* node = BlockRange().FirstNode();
5402     while (node != nullptr)
5403     {
5404         node = LowerNode(node);
5405     }
5406
5407     assert(CheckBlock(comp, block));
5408 }
5409
5410 /** Verifies if both of these trees represent the same indirection.
5411  * Used by Lower to annotate if CodeGen generate an instruction of the
5412  * form *addrMode BinOp= expr
5413  *
5414  * Preconditions: both trees are children of GT_INDs and their underlying children
5415  * have the same gtOper.
5416  *
5417  * This is a first iteration to actually recognize trees that can be code-generated
5418  * as a single read-modify-write instruction on AMD64/x86.  For now
5419  * this method only supports the recognition of simple addressing modes (through GT_LEA)
5420  * or local var indirections.  Local fields, array access and other more complex nodes are
5421  * not yet supported.
5422  *
5423  * TODO-CQ:  Perform tree recognition by using the Value Numbering Package, that way we can recognize
5424  * arbitrary complex trees and support much more addressing patterns.
5425  */
5426 bool Lowering::IndirsAreEquivalent(GenTree* candidate, GenTree* storeInd)
5427 {
5428     assert(candidate->OperGet() == GT_IND);
5429     assert(storeInd->OperGet() == GT_STOREIND);
5430
5431     // We should check the size of the indirections.  If they are
5432     // different, say because of a cast, then we can't call them equivalent.  Doing so could cause us
5433     // to drop a cast.
5434     // Signed-ness difference is okay and expected since a store indirection must always
5435     // be signed based on the CIL spec, but a load could be unsigned.
5436     if (genTypeSize(candidate->gtType) != genTypeSize(storeInd->gtType))
5437     {
5438         return false;
5439     }
5440
5441     GenTree* pTreeA = candidate->gtGetOp1();
5442     GenTree* pTreeB = storeInd->gtGetOp1();
5443
5444     // This method will be called by codegen (as well as during lowering).
5445     // After register allocation, the sources may have been spilled and reloaded
5446     // to a different register, indicated by an inserted GT_RELOAD node.
5447     pTreeA = pTreeA->gtSkipReloadOrCopy();
5448     pTreeB = pTreeB->gtSkipReloadOrCopy();
5449
5450     genTreeOps oper;
5451
5452     if (pTreeA->OperGet() != pTreeB->OperGet())
5453     {
5454         return false;
5455     }
5456
5457     oper = pTreeA->OperGet();
5458     switch (oper)
5459     {
5460         case GT_LCL_VAR:
5461         case GT_LCL_VAR_ADDR:
5462         case GT_CLS_VAR_ADDR:
5463         case GT_CNS_INT:
5464             return NodesAreEquivalentLeaves(pTreeA, pTreeB);
5465
5466         case GT_LEA:
5467         {
5468             GenTreeAddrMode* gtAddr1 = pTreeA->AsAddrMode();
5469             GenTreeAddrMode* gtAddr2 = pTreeB->AsAddrMode();
5470             return NodesAreEquivalentLeaves(gtAddr1->Base(), gtAddr2->Base()) &&
5471                    NodesAreEquivalentLeaves(gtAddr1->Index(), gtAddr2->Index()) &&
5472                    (gtAddr1->gtScale == gtAddr2->gtScale) && (gtAddr1->Offset() == gtAddr2->Offset());
5473         }
5474         default:
5475             // We don't handle anything that is not either a constant,
5476             // a local var or LEA.
5477             return false;
5478     }
5479 }
5480
5481 /** Test whether the two given nodes are the same leaves.
5482  *  Right now, only constant integers and local variables are supported
5483  */
5484 bool Lowering::NodesAreEquivalentLeaves(GenTree* tree1, GenTree* tree2)
5485 {
5486     if (tree1 == nullptr && tree2 == nullptr)
5487     {
5488         return true;
5489     }
5490
5491     // both null, they are equivalent, otherwise if either is null not equivalent
5492     if (tree1 == nullptr || tree2 == nullptr)
5493     {
5494         return false;
5495     }
5496
5497     tree1 = tree1->gtSkipReloadOrCopy();
5498     tree2 = tree2->gtSkipReloadOrCopy();
5499
5500     if (tree1->TypeGet() != tree2->TypeGet())
5501     {
5502         return false;
5503     }
5504
5505     if (tree1->OperGet() != tree2->OperGet())
5506     {
5507         return false;
5508     }
5509
5510     if (!tree1->OperIsLeaf() || !tree2->OperIsLeaf())
5511     {
5512         return false;
5513     }
5514
5515     switch (tree1->OperGet())
5516     {
5517         case GT_CNS_INT:
5518             return tree1->gtIntCon.gtIconVal == tree2->gtIntCon.gtIconVal &&
5519                    tree1->IsIconHandle() == tree2->IsIconHandle();
5520         case GT_LCL_VAR:
5521         case GT_LCL_VAR_ADDR:
5522             return tree1->gtLclVarCommon.gtLclNum == tree2->gtLclVarCommon.gtLclNum;
5523         case GT_CLS_VAR_ADDR:
5524             return tree1->gtClsVar.gtClsVarHnd == tree2->gtClsVar.gtClsVarHnd;
5525         default:
5526             return false;
5527     }
5528 }
5529
5530 //------------------------------------------------------------------------
5531 // Containment Analysis
5532 //------------------------------------------------------------------------
5533 void Lowering::ContainCheckNode(GenTree* node)
5534 {
5535     switch (node->gtOper)
5536     {
5537         case GT_STORE_LCL_VAR:
5538         case GT_STORE_LCL_FLD:
5539             ContainCheckStoreLoc(node->AsLclVarCommon());
5540             break;
5541
5542         case GT_EQ:
5543         case GT_NE:
5544         case GT_LT:
5545         case GT_LE:
5546         case GT_GE:
5547         case GT_GT:
5548         case GT_TEST_EQ:
5549         case GT_TEST_NE:
5550         case GT_CMP:
5551         case GT_JCMP:
5552             ContainCheckCompare(node->AsOp());
5553             break;
5554
5555         case GT_JTRUE:
5556             ContainCheckJTrue(node->AsOp());
5557             break;
5558
5559         case GT_ADD:
5560         case GT_SUB:
5561 #if !defined(_TARGET_64BIT_)
5562         case GT_ADD_LO:
5563         case GT_ADD_HI:
5564         case GT_SUB_LO:
5565         case GT_SUB_HI:
5566 #endif
5567         case GT_AND:
5568         case GT_OR:
5569         case GT_XOR:
5570             ContainCheckBinary(node->AsOp());
5571             break;
5572
5573 #if defined(_TARGET_X86_)
5574         case GT_MUL_LONG:
5575 #endif
5576         case GT_MUL:
5577         case GT_MULHI:
5578             ContainCheckMul(node->AsOp());
5579             break;
5580         case GT_DIV:
5581         case GT_MOD:
5582         case GT_UDIV:
5583         case GT_UMOD:
5584             ContainCheckDivOrMod(node->AsOp());
5585             break;
5586         case GT_LSH:
5587         case GT_RSH:
5588         case GT_RSZ:
5589         case GT_ROL:
5590         case GT_ROR:
5591 #ifndef _TARGET_64BIT_
5592         case GT_LSH_HI:
5593         case GT_RSH_LO:
5594 #endif
5595             ContainCheckShiftRotate(node->AsOp());
5596             break;
5597         case GT_ARR_OFFSET:
5598             ContainCheckArrOffset(node->AsArrOffs());
5599             break;
5600         case GT_LCLHEAP:
5601             ContainCheckLclHeap(node->AsOp());
5602             break;
5603         case GT_RETURN:
5604             ContainCheckRet(node->AsOp());
5605             break;
5606         case GT_RETURNTRAP:
5607             ContainCheckReturnTrap(node->AsOp());
5608             break;
5609         case GT_STOREIND:
5610             ContainCheckStoreIndir(node->AsIndir());
5611         case GT_IND:
5612             ContainCheckIndir(node->AsIndir());
5613             break;
5614         case GT_PUTARG_REG:
5615         case GT_PUTARG_STK:
5616 #if FEATURE_ARG_SPLIT
5617         case GT_PUTARG_SPLIT:
5618 #endif // FEATURE_ARG_SPLIT
5619             // The regNum must have been set by the lowering of the call.
5620             assert(node->gtRegNum != REG_NA);
5621             break;
5622 #ifdef _TARGET_XARCH_
5623         case GT_INTRINSIC:
5624             ContainCheckIntrinsic(node->AsOp());
5625             break;
5626 #endif // _TARGET_XARCH_
5627 #ifdef FEATURE_SIMD
5628         case GT_SIMD:
5629             ContainCheckSIMD(node->AsSIMD());
5630             break;
5631 #endif // FEATURE_SIMD
5632 #ifdef FEATURE_HW_INTRINSICS
5633         case GT_HWIntrinsic:
5634             ContainCheckHWIntrinsic(node->AsHWIntrinsic());
5635             break;
5636 #endif // FEATURE_HW_INTRINSICS
5637         default:
5638             break;
5639     }
5640 }
5641
5642 //------------------------------------------------------------------------
5643 // ContainCheckReturnTrap: determine whether the source of a RETURNTRAP should be contained.
5644 //
5645 // Arguments:
5646 //    node - pointer to the GT_RETURNTRAP node
5647 //
5648 void Lowering::ContainCheckReturnTrap(GenTreeOp* node)
5649 {
5650 #ifdef _TARGET_XARCH_
5651     assert(node->OperIs(GT_RETURNTRAP));
5652     // This just turns into a compare of its child with an int + a conditional call
5653     if (node->gtOp1->isIndir())
5654     {
5655         MakeSrcContained(node, node->gtOp1);
5656     }
5657 #endif // _TARGET_XARCH_
5658 }
5659
5660 //------------------------------------------------------------------------
5661 // ContainCheckArrOffset: determine whether the source of an ARR_OFFSET should be contained.
5662 //
5663 // Arguments:
5664 //    node - pointer to the GT_ARR_OFFSET node
5665 //
5666 void Lowering::ContainCheckArrOffset(GenTreeArrOffs* node)
5667 {
5668     assert(node->OperIs(GT_ARR_OFFSET));
5669     // we don't want to generate code for this
5670     if (node->gtOffset->IsIntegralConst(0))
5671     {
5672         MakeSrcContained(node, node->gtArrOffs.gtOffset);
5673     }
5674 }
5675
5676 //------------------------------------------------------------------------
5677 // ContainCheckLclHeap: determine whether the source of a GT_LCLHEAP node should be contained.
5678 //
5679 // Arguments:
5680 //    node - pointer to the node
5681 //
5682 void Lowering::ContainCheckLclHeap(GenTreeOp* node)
5683 {
5684     assert(node->OperIs(GT_LCLHEAP));
5685     GenTree* size = node->gtOp.gtOp1;
5686     if (size->IsCnsIntOrI())
5687     {
5688         MakeSrcContained(node, size);
5689     }
5690 }
5691
5692 //------------------------------------------------------------------------
5693 // ContainCheckRet: determine whether the source of a node should be contained.
5694 //
5695 // Arguments:
5696 //    node - pointer to the node
5697 //
5698 void Lowering::ContainCheckRet(GenTreeOp* ret)
5699 {
5700     assert(ret->OperIs(GT_RETURN));
5701
5702 #if !defined(_TARGET_64BIT_)
5703     if (ret->TypeGet() == TYP_LONG)
5704     {
5705         GenTree* op1 = ret->gtGetOp1();
5706         noway_assert(op1->OperGet() == GT_LONG);
5707         MakeSrcContained(ret, op1);
5708     }
5709 #endif // !defined(_TARGET_64BIT_)
5710 #if FEATURE_MULTIREG_RET
5711     if (varTypeIsStruct(ret))
5712     {
5713         GenTree* op1 = ret->gtGetOp1();
5714         // op1 must be either a lclvar or a multi-reg returning call
5715         if (op1->OperGet() == GT_LCL_VAR)
5716         {
5717             GenTreeLclVarCommon* lclVarCommon = op1->AsLclVarCommon();
5718             LclVarDsc*           varDsc       = &(comp->lvaTable[lclVarCommon->gtLclNum]);
5719             assert(varDsc->lvIsMultiRegRet);
5720
5721             // Mark var as contained if not enregistrable.
5722             if (!varTypeIsEnregisterableStruct(op1))
5723             {
5724                 MakeSrcContained(ret, op1);
5725             }
5726         }
5727     }
5728 #endif // FEATURE_MULTIREG_RET
5729 }
5730
5731 //------------------------------------------------------------------------
5732 // ContainCheckJTrue: determine whether the source of a JTRUE should be contained.
5733 //
5734 // Arguments:
5735 //    node - pointer to the node
5736 //
5737 void Lowering::ContainCheckJTrue(GenTreeOp* node)
5738 {
5739     // The compare does not need to be generated into a register.
5740     GenTree* cmp = node->gtGetOp1();
5741     cmp->gtType  = TYP_VOID;
5742     cmp->gtFlags |= GTF_SET_FLAGS;
5743 }