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 genHWIntrinsicSimdUnaryOp(GenTreeHWIntrinsic* node);
 147 #endif // defined(_TARGET_XARCH_)
 148 #endif // FEATURE_HW_INTRINSICS
 149
 150 #if !defined(_TARGET_64BIT_)
 151
 152 // CodeGen for Long Ints
 153
 154 void genStoreLongLclVar(GenTree* treeNode);
 155
 156 #endif // !defined(_TARGET_64BIT_)
 157
 158 void genProduceReg(GenTree* tree);
 159 void genUnspillRegIfNeeded(GenTree* tree);
 160 regNumber genConsumeReg(GenTree* tree);
 161 void genCopyRegIfNeeded(GenTree* tree, regNumber needReg);
 162 void genConsumeRegAndCopy(GenTree* tree, regNumber needReg);
 163
 164 void genConsumeIfReg(GenTree* tree)
 165 {
 166     if (!tree->isContained())
 167     {
 168         (void)genConsumeReg(tree);
 169     }
 170 }
 171
 172 void genRegCopy(GenTree* tree);
 173 void genTransferRegGCState(regNumber dst, regNumber src);
 174 void genConsumeAddress(GenTree* addr);
 175 void genConsumeAddrMode(GenTreeAddrMode* mode);
 176 void genSetBlockSize(GenTreeBlk* blkNode, regNumber sizeReg);
 177 void genConsumeBlockSrc(GenTreeBlk* blkNode);
 178 void genSetBlockSrc(GenTreeBlk* blkNode, regNumber srcReg);
 179 void genConsumeBlockOp(GenTreeBlk* blkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 180
 181 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 182 void genConsumePutStructArgStk(GenTreePutArgStk* putArgStkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 183 #endif // FEATURE_PUT_STRUCT_ARG_STK
 184 #ifdef _TARGET_ARM_
 185 void genConsumeArgSplitStruct(GenTreePutArgSplit* putArgNode);
 186 #endif
 187
 188 void genConsumeRegs(GenTree* tree);
 189 void genConsumeOperands(GenTreeOp* tree);
 190 void genEmitGSCookieCheck(bool pushReg);
 191 void genSetRegToIcon(regNumber reg, ssize_t val, var_types type = TYP_INT, insFlags flags = INS_FLAGS_DONT_CARE);
 192 void genCodeForShift(GenTree* tree);
 193
 194 #if defined(_TARGET_X86_) || defined(_TARGET_ARM_)
 195 void genCodeForShiftLong(GenTree* tree);
 196 #endif
 197
 198 #ifdef _TARGET_XARCH_
 199 void genCodeForShiftRMW(GenTreeStoreInd* storeInd);
 200 void genCodeForBT(GenTreeOp* bt);
 201 #endif // _TARGET_XARCH_
 202
 203 void genCodeForCast(GenTreeOp* tree);
 204 void genCodeForLclAddr(GenTree* tree);
 205 void genCodeForIndexAddr(GenTreeIndexAddr* tree);
 206 void genCodeForIndir(GenTreeIndir* tree);
 207 void genCodeForNegNot(GenTree* tree);
 208 void genCodeForLclVar(GenTreeLclVar* tree);
 209 void genCodeForLclFld(GenTreeLclFld* tree);
 210 void genCodeForStoreLclFld(GenTreeLclFld* tree);
 211 void genCodeForStoreLclVar(GenTreeLclVar* tree);
 212 void genCodeForReturnTrap(GenTreeOp* tree);
 213 void genCodeForJcc(GenTreeCC* tree);
 214 void genCodeForSetcc(GenTreeCC* setcc);
 215 void genCodeForStoreInd(GenTreeStoreInd* tree);
 216 void genCodeForSwap(GenTreeOp* tree);
 217 void genCodeForCpObj(GenTreeObj* cpObjNode);
 218 void genCodeForCpBlk(GenTreeBlk* cpBlkNode);
 219 void genCodeForCpBlkRepMovs(GenTreeBlk* cpBlkNode);
 220 void genCodeForCpBlkUnroll(GenTreeBlk* cpBlkNode);
 221 void genCodeForPhysReg(GenTreePhysReg* tree);
 222 void genCodeForNullCheck(GenTreeOp* tree);
 223 void genCodeForCmpXchg(GenTreeCmpXchg* tree);
 224
 225 void genAlignStackBeforeCall(GenTreePutArgStk* putArgStk);
 226 void genAlignStackBeforeCall(GenTreeCall* call);
 227 void genRemoveAlignmentAfterCall(GenTreeCall* call, unsigned bias = 0);
 228
 229 #if defined(UNIX_X86_ABI)
 230
 231 unsigned curNestedAlignment; // Keep track of alignment adjustment required during codegen.
 232 unsigned maxNestedAlignment; // The maximum amount of alignment adjustment required.
 233
 234 void SubtractNestedAlignment(unsigned adjustment)
 235 {
 236     assert(curNestedAlignment >= adjustment);
 237     unsigned newNestedAlignment = curNestedAlignment - adjustment;
 238     if (curNestedAlignment != newNestedAlignment)
 239     {
 240         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 241     }
 242     curNestedAlignment = newNestedAlignment;
 243 }
 244
 245 void AddNestedAlignment(unsigned adjustment)
 246 {
 247     unsigned newNestedAlignment = curNestedAlignment + adjustment;
 248     if (curNestedAlignment != newNestedAlignment)
 249     {
 250         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 251     }
 252     curNestedAlignment = newNestedAlignment;
 253
 254     if (curNestedAlignment > maxNestedAlignment)
 255     {
 256         JITDUMP("Max stack nested alignment changed from %d to %d\n", maxNestedAlignment, curNestedAlignment);
 257         maxNestedAlignment = curNestedAlignment;
 258     }
 259 }
 260
 261 #endif
 262
 263 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 264 #ifdef _TARGET_X86_
 265 bool genAdjustStackForPutArgStk(GenTreePutArgStk* putArgStk);
 266 void genPushReg(var_types type, regNumber srcReg);
 267 void genPutArgStkFieldList(GenTreePutArgStk* putArgStk);
 268 #endif // _TARGET_X86_
 269
 270 void genPutStructArgStk(GenTreePutArgStk* treeNode);
 271
 272 unsigned genMove8IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 273 unsigned genMove4IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 274 unsigned genMove2IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 275 unsigned genMove1IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 276 void genStructPutArgRepMovs(GenTreePutArgStk* putArgStkNode);
 277 void genStructPutArgUnroll(GenTreePutArgStk* putArgStkNode);
 278 void genStoreRegToStackArg(var_types type, regNumber reg, int offset);
 279 #endif // FEATURE_PUT_STRUCT_ARG_STK
 280
 281 void genCodeForLoadOffset(instruction ins, emitAttr size, regNumber dst, GenTree* base, unsigned offset);
 282 void genCodeForStoreOffset(instruction ins, emitAttr size, regNumber src, GenTree* base, unsigned offset);
 283
 284 #ifdef _TARGET_ARM64_
 285 void genCodeForLoadPairOffset(regNumber dst, regNumber dst2, GenTree* base, unsigned offset);
 286 void genCodeForStorePairOffset(regNumber src, regNumber src2, GenTree* base, unsigned offset);
 287 #endif // _TARGET_ARM64_
 288
 289 void genCodeForStoreBlk(GenTreeBlk* storeBlkNode);
 290 void genCodeForInitBlk(GenTreeBlk* initBlkNode);
 291 void genCodeForInitBlkRepStos(GenTreeBlk* initBlkNode);
 292 void genCodeForInitBlkUnroll(GenTreeBlk* initBlkNode);
 293 void genJumpTable(GenTree* tree);
 294 void genTableBasedSwitch(GenTree* tree);
 295 void genCodeForArrIndex(GenTreeArrIndex* treeNode);
 296 void genCodeForArrOffset(GenTreeArrOffs* treeNode);
 297 instruction genGetInsForOper(genTreeOps oper, var_types type);
 298 bool genEmitOptimizedGCWriteBarrier(GCInfo::WriteBarrierForm writeBarrierForm, GenTree* addr, GenTree* data);
 299 void genCallInstruction(GenTreeCall* call);
 300 void genJmpMethod(GenTree* jmp);
 301 BasicBlock* genCallFinally(BasicBlock* block);
 302 void genCodeForJumpTrue(GenTree* tree);
 303 #ifdef _TARGET_ARM64_
 304 void genCodeForJumpCompare(GenTreeOp* tree);
 305 #endif // _TARGET_ARM64_
 306
 307 #if FEATURE_EH_FUNCLETS
 308 void genEHCatchRet(BasicBlock* block);
 309 #else  // !FEATURE_EH_FUNCLETS
 310 void genEHFinallyOrFilterRet(BasicBlock* block);
 311 #endif // !FEATURE_EH_FUNCLETS
 312
 313 void genMultiRegCallStoreToLocal(GenTree* treeNode);
 314
 315 // Deals with codegen for muti-register struct returns.
 316 bool isStructReturn(GenTree* treeNode);
 317 void genStructReturn(GenTree* treeNode);
 318
 319 void genReturn(GenTree* treeNode);
 320
 321 void genLclHeap(GenTree* tree);
 322
 323 bool genIsRegCandidateLocal(GenTree* tree)
 324 {
 325     if (!tree->IsLocal())
 326     {
 327         return false;
 328     }
 329     const LclVarDsc* varDsc = &compiler->lvaTable[tree->gtLclVarCommon.gtLclNum];
 330     return (varDsc->lvIsRegCandidate());
 331 }
 332
 333 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 334 #ifdef _TARGET_X86_
 335 bool m_pushStkArg;
 336 #else  // !_TARGET_X86_
 337 unsigned m_stkArgVarNum;
 338 unsigned m_stkArgOffset;
 339 #endif // !_TARGET_X86_
 340 #endif // !FEATURE_PUT_STRUCT_ARG_STK
 341
 342 #ifdef DEBUG
 343 GenTree* lastConsumedNode;
 344 void genNumberOperandUse(GenTree* const operand, int& useNum) const;
 345 void genCheckConsumeNode(GenTree* const node);
 346 #else  // !DEBUG
 347 inline void genCheckConsumeNode(GenTree* treeNode)
 348 {
 349 }
 350 #endif // DEBUG
 351
 352 #endif // !LEGACY_BACKEND