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