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 instruction getOpForSIMDIntrinsic(SIMDIntrinsicID intrinsicId, var_types baseType, unsigned* ival = nullptr);
  70 void genSIMDScalarMove(
  71     var_types targetType, var_types type, regNumber target, regNumber src, SIMDScalarMoveType moveType);
  72 void genSIMDZero(var_types targetType, var_types baseType, regNumber targetReg);
  73 void genSIMDIntrinsicInit(GenTreeSIMD* simdNode);
  74 void genSIMDIntrinsicInitN(GenTreeSIMD* simdNode);
  75 void genSIMDIntrinsicInitArray(GenTreeSIMD* simdNode);
  76 void genSIMDIntrinsicUnOp(GenTreeSIMD* simdNode);
  77 void genSIMDIntrinsicBinOp(GenTreeSIMD* simdNode);
  78 void genSIMDIntrinsicRelOp(GenTreeSIMD* simdNode);
  79 void genSIMDIntrinsicDotProduct(GenTreeSIMD* simdNode);
  80 void genSIMDIntrinsicSetItem(GenTreeSIMD* simdNode);
  81 void genSIMDIntrinsicGetItem(GenTreeSIMD* simdNode);
  82 void genSIMDIntrinsicShuffleSSE2(GenTreeSIMD* simdNode);
  83 void genSIMDIntrinsicUpperSave(GenTreeSIMD* simdNode);
  84 void genSIMDIntrinsicUpperRestore(GenTreeSIMD* simdNode);
  85 void genSIMDLo64BitConvert(SIMDIntrinsicID intrinsicID,
  86                            var_types       simdType,
  87                            var_types       baseType,
  88                            regNumber       tmpReg,
  89                            regNumber       tmpIntReg,
  90                            regNumber       targetReg);
  91 void genSIMDIntrinsic32BitConvert(GenTreeSIMD* simdNode);
  92 void genSIMDIntrinsic64BitConvert(GenTreeSIMD* simdNode);
  93 void genSIMDIntrinsicNarrow(GenTreeSIMD* simdNode);
  94 void genSIMDExtractUpperHalf(GenTreeSIMD* simdNode, regNumber srcReg, regNumber tgtReg);
  95 void genSIMDIntrinsicWiden(GenTreeSIMD* simdNode);
  96 void genSIMDIntrinsic(GenTreeSIMD* simdNode);
  97 void genSIMDCheck(GenTree* treeNode);
  98
  99 // TYP_SIMD12 (i.e Vector3 of size 12 bytes) is not a hardware supported size and requires
 100 // two reads/writes on 64-bit targets. These routines abstract reading/writing of Vector3
 101 // values through an indirection. Note that Vector3 locals allocated on stack would have
 102 // their size rounded to TARGET_POINTER_SIZE (which is 8 bytes on 64-bit targets) and hence
 103 // Vector3 locals could be treated as TYP_SIMD16 while reading/writing.
 104 void genStoreIndTypeSIMD12(GenTree* treeNode);
 105 void genLoadIndTypeSIMD12(GenTree* treeNode);
 106 void genStoreLclTypeSIMD12(GenTree* treeNode);
 107 void genLoadLclTypeSIMD12(GenTree* treeNode);
 108 #ifdef _TARGET_X86_
 109 void genStoreSIMD12ToStack(regNumber operandReg, regNumber tmpReg);
 110 void genPutArgStkSIMD12(GenTree* treeNode);
 111 #endif // _TARGET_X86_
 112 #endif // FEATURE_SIMD
 113
 114 #if !defined(_TARGET_64BIT_)
 115
 116 // CodeGen for Long Ints
 117
 118 void genStoreLongLclVar(GenTree* treeNode);
 119
 120 #endif // !defined(_TARGET_64BIT_)
 121
 122 void genProduceReg(GenTree* tree);
 123 void genUnspillRegIfNeeded(GenTree* tree);
 124 regNumber genConsumeReg(GenTree* tree);
 125 void genCopyRegIfNeeded(GenTree* tree, regNumber needReg);
 126 void genConsumeRegAndCopy(GenTree* tree, regNumber needReg);
 127
 128 void genConsumeIfReg(GenTreePtr tree)
 129 {
 130     if (!tree->isContained())
 131     {
 132         (void)genConsumeReg(tree);
 133     }
 134 }
 135
 136 void genRegCopy(GenTreePtr tree);
 137 void genTransferRegGCState(regNumber dst, regNumber src);
 138 void genConsumeAddress(GenTree* addr);
 139 void genConsumeAddrMode(GenTreeAddrMode* mode);
 140 void genSetBlockSize(GenTreeBlk* blkNode, regNumber sizeReg);
 141 void genConsumeBlockSrc(GenTreeBlk* blkNode);
 142 void genSetBlockSrc(GenTreeBlk* blkNode, regNumber srcReg);
 143 void genConsumeBlockOp(GenTreeBlk* blkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 144
 145 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 146 void genConsumePutStructArgStk(GenTreePutArgStk* putArgStkNode, regNumber dstReg, regNumber srcReg, regNumber sizeReg);
 147 #endif // FEATURE_PUT_STRUCT_ARG_STK
 148 #ifdef _TARGET_ARM_
 149 void genConsumeArgSplitStruct(GenTreePutArgSplit* putArgNode);
 150 #endif
 151
 152 void genConsumeRegs(GenTree* tree);
 153 void genConsumeOperands(GenTreeOp* tree);
 154 void genEmitGSCookieCheck(bool pushReg);
 155 void genSetRegToIcon(regNumber reg, ssize_t val, var_types type = TYP_INT, insFlags flags = INS_FLAGS_DONT_CARE);
 156 void genCodeForShift(GenTreePtr tree);
 157
 158 #if defined(_TARGET_X86_) || defined(_TARGET_ARM_)
 159 void genCodeForShiftLong(GenTreePtr tree);
 160 #endif
 161
 162 #ifdef _TARGET_XARCH_
 163 void genCodeForShiftRMW(GenTreeStoreInd* storeInd);
 164 void genCodeForBT(GenTreeOp* bt);
 165 #endif // _TARGET_XARCH_
 166
 167 void genCodeForCast(GenTreeOp* tree);
 168 void genCodeForLclAddr(GenTree* tree);
 169 void genCodeForIndexAddr(GenTreeIndexAddr* tree);
 170 void genCodeForIndir(GenTreeIndir* tree);
 171 void genCodeForNegNot(GenTree* tree);
 172 void genCodeForLclVar(GenTreeLclVar* tree);
 173 void genCodeForLclFld(GenTreeLclFld* tree);
 174 void genCodeForStoreLclFld(GenTreeLclFld* tree);
 175 void genCodeForStoreLclVar(GenTreeLclVar* tree);
 176 void genCodeForReturnTrap(GenTreeOp* tree);
 177 void genCodeForJcc(GenTreeCC* tree);
 178 void genCodeForSetcc(GenTreeCC* setcc);
 179 void genCodeForStoreInd(GenTreeStoreInd* tree);
 180 void genCodeForSwap(GenTreeOp* tree);
 181 void genCodeForCpObj(GenTreeObj* cpObjNode);
 182 void genCodeForCpBlk(GenTreeBlk* cpBlkNode);
 183 void genCodeForCpBlkRepMovs(GenTreeBlk* cpBlkNode);
 184 void genCodeForCpBlkUnroll(GenTreeBlk* cpBlkNode);
 185 void genCodeForPhysReg(GenTreePhysReg* tree);
 186 void genCodeForNullCheck(GenTreeOp* tree);
 187 void genCodeForCmpXchg(GenTreeCmpXchg* tree);
 188
 189 void genAlignStackBeforeCall(GenTreePutArgStk* putArgStk);
 190 void genAlignStackBeforeCall(GenTreeCall* call);
 191 void genRemoveAlignmentAfterCall(GenTreeCall* call, unsigned bias = 0);
 192
 193 #if defined(UNIX_X86_ABI)
 194
 195 unsigned curNestedAlignment; // Keep track of alignment adjustment required during codegen.
 196 unsigned maxNestedAlignment; // The maximum amount of alignment adjustment required.
 197
 198 void SubtractNestedAlignment(unsigned adjustment)
 199 {
 200     assert(curNestedAlignment >= adjustment);
 201     unsigned newNestedAlignment = curNestedAlignment - adjustment;
 202     if (curNestedAlignment != newNestedAlignment)
 203     {
 204         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 205     }
 206     curNestedAlignment = newNestedAlignment;
 207 }
 208
 209 void AddNestedAlignment(unsigned adjustment)
 210 {
 211     unsigned newNestedAlignment = curNestedAlignment + adjustment;
 212     if (curNestedAlignment != newNestedAlignment)
 213     {
 214         JITDUMP("Adjusting stack nested alignment from %d to %d\n", curNestedAlignment, newNestedAlignment);
 215     }
 216     curNestedAlignment = newNestedAlignment;
 217
 218     if (curNestedAlignment > maxNestedAlignment)
 219     {
 220         JITDUMP("Max stack nested alignment changed from %d to %d\n", maxNestedAlignment, curNestedAlignment);
 221         maxNestedAlignment = curNestedAlignment;
 222     }
 223 }
 224
 225 #endif
 226
 227 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 228 #ifdef _TARGET_X86_
 229 bool genAdjustStackForPutArgStk(GenTreePutArgStk* putArgStk);
 230 void genPushReg(var_types type, regNumber srcReg);
 231 void genPutArgStkFieldList(GenTreePutArgStk* putArgStk);
 232 #endif // _TARGET_X86_
 233
 234 void genPutStructArgStk(GenTreePutArgStk* treeNode);
 235
 236 unsigned genMove8IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 237 unsigned genMove4IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 238 unsigned genMove2IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 239 unsigned genMove1IfNeeded(unsigned size, regNumber tmpReg, GenTree* srcAddr, unsigned offset);
 240 void genStructPutArgRepMovs(GenTreePutArgStk* putArgStkNode);
 241 void genStructPutArgUnroll(GenTreePutArgStk* putArgStkNode);
 242 void genStoreRegToStackArg(var_types type, regNumber reg, int offset);
 243 #endif // FEATURE_PUT_STRUCT_ARG_STK
 244
 245 void genCodeForLoadOffset(instruction ins, emitAttr size, regNumber dst, GenTree* base, unsigned offset);
 246 void genCodeForStoreOffset(instruction ins, emitAttr size, regNumber src, GenTree* base, unsigned offset);
 247
 248 #ifdef _TARGET_ARM64_
 249 void genCodeForLoadPairOffset(regNumber dst, regNumber dst2, GenTree* base, unsigned offset);
 250 void genCodeForStorePairOffset(regNumber src, regNumber src2, GenTree* base, unsigned offset);
 251 #endif // _TARGET_ARM64_
 252
 253 void genCodeForStoreBlk(GenTreeBlk* storeBlkNode);
 254 void genCodeForInitBlk(GenTreeBlk* initBlkNode);
 255 void genCodeForInitBlkRepStos(GenTreeBlk* initBlkNode);
 256 void genCodeForInitBlkUnroll(GenTreeBlk* initBlkNode);
 257 void genJumpTable(GenTree* tree);
 258 void genTableBasedSwitch(GenTree* tree);
 259 void genCodeForArrIndex(GenTreeArrIndex* treeNode);
 260 void genCodeForArrOffset(GenTreeArrOffs* treeNode);
 261 instruction genGetInsForOper(genTreeOps oper, var_types type);
 262 bool genEmitOptimizedGCWriteBarrier(GCInfo::WriteBarrierForm writeBarrierForm, GenTree* addr, GenTree* data);
 263 void genCallInstruction(GenTreeCall* call);
 264 void genJmpMethod(GenTreePtr jmp);
 265 BasicBlock* genCallFinally(BasicBlock* block);
 266 void genCodeForJumpTrue(GenTreePtr tree);
 267 #ifdef _TARGET_ARM64_
 268 void genCodeForJumpCompare(GenTreeOp* tree);
 269 #endif // _TARGET_ARM64_
 270
 271 #if FEATURE_EH_FUNCLETS
 272 void genEHCatchRet(BasicBlock* block);
 273 #else  // !FEATURE_EH_FUNCLETS
 274 void genEHFinallyOrFilterRet(BasicBlock* block);
 275 #endif // !FEATURE_EH_FUNCLETS
 276
 277 void genMultiRegCallStoreToLocal(GenTreePtr treeNode);
 278
 279 // Deals with codegen for muti-register struct returns.
 280 bool isStructReturn(GenTreePtr treeNode);
 281 void genStructReturn(GenTreePtr treeNode);
 282
 283 void genReturn(GenTreePtr treeNode);
 284
 285 void genLclHeap(GenTreePtr tree);
 286
 287 bool genIsRegCandidateLocal(GenTreePtr tree)
 288 {
 289     if (!tree->IsLocal())
 290     {
 291         return false;
 292     }
 293     const LclVarDsc* varDsc = &compiler->lvaTable[tree->gtLclVarCommon.gtLclNum];
 294     return (varDsc->lvIsRegCandidate());
 295 }
 296
 297 #ifdef FEATURE_PUT_STRUCT_ARG_STK
 298 #ifdef _TARGET_X86_
 299 bool m_pushStkArg;
 300 #else  // !_TARGET_X86_
 301 unsigned m_stkArgVarNum;
 302 unsigned m_stkArgOffset;
 303 #endif // !_TARGET_X86_
 304 #endif // !FEATURE_PUT_STRUCT_ARG_STK
 305
 306 #ifdef DEBUG
 307 GenTree* lastConsumedNode;
 308 void genNumberOperandUse(GenTree* const operand, int& useNum) const;
 309 void genCheckConsumeNode(GenTree* const node);
 310 #else  // !DEBUG
 311 inline void genCheckConsumeNode(GenTree* treeNode)
 312 {
 313 }
 314 #endif // DEBUG
 315
 316 #endif // !LEGACY_BACKEND