src/jit/codegenlinear.h

   1 // Licensed to the .NET Foundation under one or more agreements.
   2 // The .NET Foundation licenses this file to you under the MIT license.
   3 // See the LICENSE file in the project root for more information.
   4
   5 //
   6 // This file contains the members of CodeGen that are defined and used
   7 // only by the RyuJIT backend.  It is included by CodeGen.h in the
   8 // definition of the CodeGen class.
   9 //
  10
  11 #ifndef LEGACY_BACKEND // Not necessary (it's this way in the #include location), but helpful to IntelliSense
  12
  13 void genSetRegToConst(regNumber targetReg, var_types targetType, GenTree* tree);
  14 void genCodeForTreeNode(GenTree* treeNode);
  15 void genCodeForBinary(GenTree* treeNode);
  16
  17 #if defined(_TARGET_X86_)
  18 void genCodeForLongUMod(GenTreeOp* node);
  19 #endif // _TARGET_X86_
  20
  21 void genCodeForDivMod(GenTreeOp* treeNode);
  22 void genCodeForMul(GenTreeOp* treeNode);
  23 void genCodeForMulHi(GenTreeOp* treeNode);
  24 void genLeaInstruction(GenTreeAddrMode* lea);
  25 void genSetRegToCond(regNumber dstReg, GenTree* tree);
  26
  27 #if defined(_TARGET_ARMARCH_)
  28 void genScaledAdd(emitAttr attr, regNumber targetReg, regNumber baseReg, regNumber indexReg, int scale);
  29 #endif // _TARGET_ARMARCH_
  30
  31 #if defined(_TARGET_ARM_)
  32 void genCodeForMulLong(GenTreeMultiRegOp* treeNode);
  33 #endif // _TARGET_ARM_
  34
  35 #if !defined(_TARGET_64BIT_)
  36 void genLongToIntCast(GenTree* treeNode);
  37 #endif
  38
  39 void genIntToIntCast(GenTree* treeNode);
  40 void genFloatToFloatCast(GenTree* treeNode);
  41 void genFloatToIntCast(GenTree* treeNode);
  42 void genIntToFloatCast(GenTree* treeNode);
  43 void genCkfinite(GenTree* treeNode);
  44 void genCodeForCompare(GenTreeOp* tree);
  45 void genIntrinsic(GenTree* treeNode);
  46 void genPutArgStk(GenTreePutArgStk* treeNode);
  47 void genPutArgReg(GenTreeOp* tree);
  48 #ifdef _TARGET_ARM_
  49 void genPutArgSplit(GenTreePutArgSplit* treeNode);
  50 #endif
  51
  52 #if defined(_TARGET_XARCH_)
  53 unsigned getBaseVarForPutArgStk(GenTree* treeNode);
  54 #endif // _TARGET_XARCH_
  55
  56 unsigned getFirstArgWithStackSlot();
  57
  58 void genCompareFloat(GenTree* treeNode);
  59 void genCompareInt(GenTree* treeNode);
  60
  61 #ifdef FEATURE_SIMD
  62 enum SIMDScalarMoveType
  63 {
  64     SMT_ZeroInitUpper,                  // zero initlaize target upper bits
  65     SMT_ZeroInitUpper_SrcHasUpperZeros, // zero initialize target upper bits; source upper bits are known to be zero
  66     SMT_PreserveUpper                   // preserve target upper bits
  67 };
  68
  69 #ifdef _TARGET_ARM64_
  70 insOpts genGetSimdInsOpt(bool is16B, var_types elementType);
  71 #endif
  72 instruction getOpForSIMDIntrinsic(SIMDIntrinsicID intrinsicId, var_types baseType, unsigned* ival = nullptr);
  73 void genSIMDScalarMove(
  74     var_types targetType, var_types type, regNumber target, regNumber src, SIMDScalarMoveType moveType);
  75 void genSIMDZero(var_types targetType, var_types baseType, regNumber targetReg);
  76 void genSIMDIntrinsicInit(GenTreeSIMD* simdNode);
  77 void genSIMDIntrinsicInitN(GenTreeSIMD* simdNode);
  78 void genSIMDIntrinsicInitArray(GenTreeSIMD* simdNode);
  79 void genSIMDIntrinsicUnOp(GenTreeSIMD* simdNode);
  80 void genSIMDIntrinsicBinOp(GenTreeSIMD* simdNode);
  81 void genSIMDIntrinsicRelOp(GenTreeSIMD* simdNode);
  82 void genSIMDIntrinsicDotProduct(GenTreeSIMD* simdNode);
  83 void genSIMDIntrinsicSetItem(GenTreeSIMD* simdNode);
  84 void genSIMDIntrinsicGetItem(GenTreeSIMD* simdNode);
  85 void genSIMDIntrinsicShuffleSSE2(GenTreeSIMD* simdNode);
  86 void genSIMDIntrinsicUpperSave(GenTreeSIMD* simdNode);
  87 void genSIMDIntrinsicUpperRestore(GenTreeSIMD* simdNode);
  88 void genSIMDLo64BitConvert(SIMDIntrinsicID intrinsicID,
  89                            var_types       simdType,
  90                            var_types       baseType,
  91                            regNumber       tmpReg,
  92                            regNumber       tmpIntReg,
  93                            regNumber       targetReg);
  94 void genSIMDIntrinsic32BitConvert(GenTreeSIMD* simdNode);
  95 void genSIMDIntrinsic64BitConvert(GenTreeSIMD* simdNode);
  96 void genSIMDIntrinsicNarrow(GenTreeSIMD* simdNode);
  97 void genSIMDExtractUpperHalf(GenTreeSIMD* simdNode, regNumber srcReg, regNumber tgtReg);
  98 void genSIMDIntrinsicWiden(GenTreeSIMD* simdNode);
  99 void genSIMDIntrinsic(GenTreeSIMD* simdNode);
 100 void genSIMDCheck(GenTree* treeNode);
 101
 102 // TYP_SIMD12 (i.e Vector3 of size 12 bytes) is not a hardware supported size and requires
 103 // two reads/writes on 64-bit targets. These routines abstract reading/writing of Vector3
 104 // values through an indirection. Note that Vector3 locals allocated on stack would have
 105 // their size rounded to TARGET_POINTER_SIZE (which is 8 bytes on 64-bit targets) and hence
 106 // Vector3 locals could be treated as TYP_SIMD16 while reading/writing.
 107 void genStoreIndTypeSIMD12(GenTree* treeNode);
 108 void genLoadIndTypeSIMD12(GenTree* treeNode);
 109 void genStoreLclTypeSIMD12(GenTree* treeNode);
 110 void genLoadLclTypeSIMD12(GenTree* treeNode);
 111 #ifdef _TARGET_X86_
 112 void genStoreSIMD12ToStack(regNumber operandReg, regNumber tmpReg);
 113 void genPutArgStkSIMD12(GenTree* treeNode);
 114 #endif // _TARGET_X86_
 115 #endif // FEATURE_SIMD
 116
 117 #ifdef FEATURE_HW_INTRINSICS
 118 void genHWIntrinsic(GenTreeHWIntrinsic* node);
 119 #if defined(_TARGET_XARCH_)
 120 void genHWIntrinsic_R_R_RM(GenTreeHWIntrinsic* node, instruction ins);
 121 void genHWIntrinsic_R_R_RM_I(GenTreeHWIntrinsic* node, instruction ins);
 122 void genSSEIntrinsic(GenTreeHWIntrinsic* node);
 123 void genSSE2Intrinsic(GenTreeHWIntrinsic* node);
 124 void genSSE3Intrinsic(GenTreeHWIntrinsic* node);
 125 void genSSSE3Intrinsic(GenTreeHWIntrinsic* node);
 126 void genSSE41Intrinsic(GenTreeHWIntrinsic* node);
 127 void genSSE42Intrinsic(GenTreeHWIntrinsic* node);
 128 void genAVXIntrinsic(GenTreeHWIntrinsic* node);
 129 void genAVX2Intrinsic(GenTreeHWIntrinsic* node);
 130 void genAESIntrinsic(GenTreeHWIntrinsic* node);
 131 void genBMI1Intrinsic(GenTreeHWIntrinsic* node);
 132 void genBMI2Intrinsic(GenTreeHWIntrinsic* node);
 133 void genFMAIntrinsic(GenTreeHWIntrinsic* node);
 134 void genLZCNTIntrinsic(GenTreeHWIntrinsic* node);
 135 void genPCLMULQDQIntrinsic(GenTreeHWIntrinsic* node);
 136 void genPOPCNTIntrinsic(GenTreeHWIntrinsic* node);
 137 #endif // defined(_TARGET_XARCH_)
 138 #if defined(_TARGET_ARM64_)
 139 instruction getOpForHWIntrinsic(GenTreeHWIntrinsic* node, var_types instrType);
 140 void genHWIntrinsicUnaryOp(GenTreeHWIntrinsic* node);
 141 void genHWIntrinsicCrcOp(GenTreeHWIntrinsic* node);
 142 void genHWIntrinsicSimdBinaryOp(GenTreeHWIntrinsic* node);
 143 void genHWIntrinsicSimdExtractOp(GenTreeHWIntrinsic* node);
 144 void genHWIntrinsicSimdInsertOp(GenTreeHWIntrinsic* node);
 145 void genHWIntrinsicSimdSelectOp(GenTreeHWIntrinsic* node);
 146 void genHWIntrinsicSimdSetAllOp(GenTreeHWIntrinsic* node);
 147 void genHWIntrinsicSimdUnaryOp(GenTreeHWIntrinsic* node);
 148 template <typename HWIntrinsicSwitchCaseBody>
 149 void genHWIntrinsicSwitchTable(regNumber swReg, regNumber tmpReg, int swMax, HWIntrinsicSwitchCaseBody emitSwCase);
 150 #endif // defined(_TARGET_XARCH_)
 151 #endif // FEATURE_HW_INTRINSICS
 152
 153 #if !defined(_TARGET_64BIT_)
 154
 155 // CodeGen for Long Ints
 156
 157 void genStoreLongLclVar(GenTree* treeNode);
 158
 159 #endif // !defined(_TARGET_64BIT_)
 160
 161 void genProduceReg(GenTree* tree);
 162 void genUnspillRegIfNeeded(GenTree* tree);
 163 regNumber genConsumeReg(GenTree* tree);
 164 void genCopyRegIfNeeded(GenTree* tree, regNumber needReg);
 165 void genConsumeRegAndCopy(GenTree* tree, regNumber needReg);
 166
 167 void genConsumeIfReg(GenTree* tree)
 168 {
 169     if (!tree->isContained())
 170     {
 171         (void)genConsumeReg(tree);
 172     }
 173 }
 174
 175 void genRegCopy(GenTree* tree);
 176 void genTransferRegGCState(regNumber dst, regNumber src);
 177 void genConsumeAddress(GenTree* addr);
 178 void genConsumeAddrMode(GenTreeAddrMode* mode);
 179 void genSetBlockSize(GenTreeBlk* blkNode, regNumber sizeReg);
 180 void genConsumeBlockSrc(GenTreeBlk* blkNode);
 181 void genSetBlockSrc(GenTreeBlk* blkNode, regNumber srcReg);
 182 void genConsumeBlockOp(GenTreeBlk* blkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 183
 184 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 185 void genConsumePutStructArgStk(GenTreePutArgStk* putArgStkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 186 #endif // FEATURE_PUT_STRUCT_ARG_STK
 187 #ifdef _TARGET_ARM_
 188 void genConsumeArgSplitStruct(GenTreePutArgSplit* putArgNode);
 189 #endif
 190
 191 void genConsumeRegs(GenTree* tree);
 192 void genConsumeOperands(GenTreeOp* tree);
 193 void genEmitGSCookieCheck(bool pushReg);
 194 void genSetRegToIcon(regNumber reg, ssize_t val, var_types type = TYP_INT, insFlags flags = INS_FLAGS_DONT_CARE);
 195 void genCodeForShift(GenTree* tree);
 196
 197 #if defined(_TARGET_X86_) || defined(_TARGET_ARM_)
 198 void genCodeForShiftLong(GenTree* tree);
 199 #endif
 200
 201 #ifdef _TARGET_XARCH_
 202 void genCodeForShiftRMW(GenTreeStoreInd* storeInd);
 203 void genCodeForBT(GenTreeOp* bt);
 204 #endif // _TARGET_XARCH_
 205
 206 void genCodeForCast(GenTreeOp* tree);
 207 void genCodeForLclAddr(GenTree* tree);
 208 void genCodeForIndexAddr(GenTreeIndexAddr* tree);
 209 void genCodeForIndir(GenTreeIndir* tree);
 210 void genCodeForNegNot(GenTree* tree);
 211 void genCodeForLclVar(GenTreeLclVar* tree);
 212 void genCodeForLclFld(GenTreeLclFld* tree);
 213 void genCodeForStoreLclFld(GenTreeLclFld* tree);
 214 void genCodeForStoreLclVar(GenTreeLclVar* tree);
 215 void genCodeForReturnTrap(GenTreeOp* tree);
 216 void genCodeForJcc(GenTreeCC* tree);
 217 void genCodeForSetcc(GenTreeCC* setcc);
 218 void genCodeForStoreInd(GenTreeStoreInd* tree);
 219 void genCodeForSwap(GenTreeOp* tree);
 220 void genCodeForCpObj(GenTreeObj* cpObjNode);
 221 void genCodeForCpBlk(GenTreeBlk* cpBlkNode);
 222 void genCodeForCpBlkRepMovs(GenTreeBlk* cpBlkNode);
 223 void genCodeForCpBlkUnroll(GenTreeBlk* cpBlkNode);
 224 void genCodeForPhysReg(GenTreePhysReg* tree);
 225 void genCodeForNullCheck(GenTreeOp* tree);
 226 void genCodeForCmpXchg(GenTreeCmpXchg* tree);
 227
 228 void genAlignStackBeforeCall(GenTreePutArgStk* putArgStk);
 229 void genAlignStackBeforeCall(GenTreeCall* call);
 230 void genRemoveAlignmentAfterCall(GenTreeCall* call, unsigned bias = 0);
 231
 232 #if defined(UNIX_X86_ABI)
 233
 234 unsigned curNestedAlignment; // Keep track of alignment adjustment required during codegen.
 235 unsigned maxNestedAlignment; // The maximum amount of alignment adjustment required.
 236
 237 void SubtractNestedAlignment(unsigned adjustment)
 238 {
 239     assert(curNestedAlignment >= adjustment);
 240     unsigned newNestedAlignment = curNestedAlignment - adjustment;
 241     if (curNestedAlignment != newNestedAlignment)
 242     {
 243         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 244     }
 245     curNestedAlignment = newNestedAlignment;
 246 }
 247
 248 void AddNestedAlignment(unsigned adjustment)
 249 {
 250     unsigned newNestedAlignment = curNestedAlignment + adjustment;
 251     if (curNestedAlignment != newNestedAlignment)
 252     {
 253         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 254     }
 255     curNestedAlignment = newNestedAlignment;
 256
 257     if (curNestedAlignment > maxNestedAlignment)
 258     {
 259         JITDUMP("Max stack nested alignment changed from %d to %d\n", maxNestedAlignment, curNestedAlignment);
 260         maxNestedAlignment = curNestedAlignment;
 261     }
 262 }
 263
 264 #endif
 265
 266 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 267 #ifdef _TARGET_X86_
 268 bool genAdjustStackForPutArgStk(GenTreePutArgStk* putArgStk);
 269 void genPushReg(var_types type, regNumber srcReg);
 270 void genPutArgStkFieldList(GenTreePutArgStk* putArgStk);
 271 #endif // _TARGET_X86_
 272
 273 void genPutStructArgStk(GenTreePutArgStk* treeNode);
 274
 275 unsigned genMove8IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 276 unsigned genMove4IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 277 unsigned genMove2IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 278 unsigned genMove1IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 279 void genStructPutArgRepMovs(GenTreePutArgStk* putArgStkNode);
 280 void genStructPutArgUnroll(GenTreePutArgStk* putArgStkNode);
 281 void genStoreRegToStackArg(var_types type, regNumber reg, int offset);
 282 #endif // FEATURE_PUT_STRUCT_ARG_STK
 283
 284 void genCodeForLoadOffset(instruction ins, emitAttr size, regNumber dst, GenTree* base, unsigned offset);
 285 void genCodeForStoreOffset(instruction ins, emitAttr size, regNumber src, GenTree* base, unsigned offset);
 286
 287 #ifdef _TARGET_ARM64_
 288 void genCodeForLoadPairOffset(regNumber dst, regNumber dst2, GenTree* base, unsigned offset);
 289 void genCodeForStorePairOffset(regNumber src, regNumber src2, GenTree* base, unsigned offset);
 290 #endif // _TARGET_ARM64_
 291
 292 void genCodeForStoreBlk(GenTreeBlk* storeBlkNode);
 293 void genCodeForInitBlk(GenTreeBlk* initBlkNode);
 294 void genCodeForInitBlkRepStos(GenTreeBlk* initBlkNode);
 295 void genCodeForInitBlkUnroll(GenTreeBlk* initBlkNode);
 296 void genJumpTable(GenTree* tree);
 297 void genTableBasedSwitch(GenTree* tree);
 298 void genCodeForArrIndex(GenTreeArrIndex* treeNode);
 299 void genCodeForArrOffset(GenTreeArrOffs* treeNode);
 300 instruction genGetInsForOper(genTreeOps oper, var_types type);
 301 bool genEmitOptimizedGCWriteBarrier(GCInfo::WriteBarrierForm writeBarrierForm, GenTree* addr, GenTree* data);
 302 void genCallInstruction(GenTreeCall* call);
 303 void genJmpMethod(GenTree* jmp);
 304 BasicBlock* genCallFinally(BasicBlock* block);
 305 void genCodeForJumpTrue(GenTree* tree);
 306 #ifdef _TARGET_ARM64_
 307 void genCodeForJumpCompare(GenTreeOp* tree);
 308 #endif // _TARGET_ARM64_
 309
 310 #if FEATURE_EH_FUNCLETS
 311 void genEHCatchRet(BasicBlock* block);
 312 #else  // !FEATURE_EH_FUNCLETS
 313 void genEHFinallyOrFilterRet(BasicBlock* block);
 314 #endif // !FEATURE_EH_FUNCLETS
 315
 316 void genMultiRegCallStoreToLocal(GenTree* treeNode);
 317
 318 // Deals with codegen for muti-register struct returns.
 319 bool isStructReturn(GenTree* treeNode);
 320 void genStructReturn(GenTree* treeNode);
 321
 322 void genReturn(GenTree* treeNode);
 323
 324 void genLclHeap(GenTree* tree);
 325
 326 bool genIsRegCandidateLocal(GenTree* tree)
 327 {
 328     if (!tree->IsLocal())
 329     {
 330         return false;
 331     }
 332     const LclVarDsc* varDsc = &compiler->lvaTable[tree->gtLclVarCommon.gtLclNum];
 333     return (varDsc->lvIsRegCandidate());
 334 }
 335
 336 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 337 #ifdef _TARGET_X86_
 338 bool m_pushStkArg;
 339 #else  // !_TARGET_X86_
 340 unsigned m_stkArgVarNum;
 341 unsigned m_stkArgOffset;
 342 #endif // !_TARGET_X86_
 343 #endif // !FEATURE_PUT_STRUCT_ARG_STK
 344
 345 #ifdef DEBUG
 346 GenTree* lastConsumedNode;
 347 void genNumberOperandUse(GenTree* const operand, int& useNum) const;
 348 void genCheckConsumeNode(GenTree* const node);
 349 #else  // !DEBUG
 350 inline void genCheckConsumeNode(GenTree* treeNode)
 351 {
 352 }
 353 #endif // DEBUG
 354
 355 #endif // !LEGACY_BACKEND