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