lib/CodeGen/SelectionDAG/SelectionDAGBuilder.h

   1 //===-- SelectionDAGBuilder.h - Selection-DAG building --------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This implements routines for translating from LLVM IR into SelectionDAG IR.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef SELECTIONDAGBUILDER_H
  15 #define SELECTIONDAGBUILDER_H
  16
  17 #include "llvm/Constants.h"
  18 #include "llvm/CodeGen/SelectionDAG.h"
  19 #include "llvm/ADT/APInt.h"
  20 #include "llvm/ADT/DenseMap.h"
  21 #ifndef NDEBUG
  22 #include "llvm/ADT/SmallSet.h"
  23 #endif
  24 #include "llvm/CodeGen/SelectionDAGNodes.h"
  25 #include "llvm/CodeGen/ValueTypes.h"
  26 #include "llvm/Support/CallSite.h"
  27 #include "llvm/Support/ErrorHandling.h"
  28 #include <vector>
  29 #include <set>
  30
  31 namespace llvm {
  32
  33 class AliasAnalysis;
  34 class AllocaInst;
  35 class BasicBlock;
  36 class BitCastInst;
  37 class BranchInst;
  38 class CallInst;
  39 class ExtractElementInst;
  40 class ExtractValueInst;
  41 class FCmpInst;
  42 class FPExtInst;
  43 class FPToSIInst;
  44 class FPToUIInst;
  45 class FPTruncInst;
  46 class Function;
  47 class FunctionLoweringInfo;
  48 class GetElementPtrInst;
  49 class GCFunctionInfo;
  50 class ICmpInst;
  51 class IntToPtrInst;
  52 class IndirectBrInst;
  53 class InvokeInst;
  54 class InsertElementInst;
  55 class InsertValueInst;
  56 class Instruction;
  57 class LoadInst;
  58 class MachineBasicBlock;
  59 class MachineInstr;
  60 class MachineRegisterInfo;
  61 class PHINode;
  62 class PtrToIntInst;
  63 class ReturnInst;
  64 class SDISelAsmOperandInfo;
  65 class SExtInst;
  66 class SelectInst;
  67 class ShuffleVectorInst;
  68 class SIToFPInst;
  69 class StoreInst;
  70 class SwitchInst;
  71 class TargetData;
  72 class TargetLowering;
  73 class TruncInst;
  74 class UIToFPInst;
  75 class UnreachableInst;
  76 class UnwindInst;
  77 class VAArgInst;
  78 class ZExtInst;
  79
  80 //===----------------------------------------------------------------------===//
  81 /// SelectionDAGBuilder - This is the common target-independent lowering
  82 /// implementation that is parameterized by a TargetLowering object.
  83 ///
  84 class SelectionDAGBuilder {
  85   /// CurDebugLoc - current file + line number.  Changes as we build the DAG.
  86   DebugLoc CurDebugLoc;
  87
  88   DenseMap<const Value*, SDValue> NodeMap;
  89
  90 public:
  91   /// PendingLoads - Loads are not emitted to the program immediately.  We bunch
  92   /// them up and then emit token factor nodes when possible.  This allows us to
  93   /// get simple disambiguation between loads without worrying about alias
  94   /// analysis.
  95   SmallVector<SDValue, 8> PendingLoads;
  96 private:
  97
  98   /// PendingExports - CopyToReg nodes that copy values to virtual registers
  99   /// for export to other blocks need to be emitted before any terminator
 100   /// instruction, but they have no other ordering requirements. We bunch them
 101   /// up and the emit a single tokenfactor for them just before terminator
 102   /// instructions.
 103   SmallVector<SDValue, 8> PendingExports;
 104
 105   /// SDNodeOrder - A unique monotonically increasing number used to order the
 106   /// SDNodes we create.
 107   unsigned SDNodeOrder;
 108
 109   /// Case - A struct to record the Value for a switch case, and the
 110   /// case's target basic block.
 111   struct Case {
 112     Constant* Low;
 113     Constant* High;
 114     MachineBasicBlock* BB;
 115
 116     Case() : Low(0), High(0), BB(0) { }
 117     Case(Constant* low, Constant* high, MachineBasicBlock* bb) :
 118       Low(low), High(high), BB(bb) { }
 119     APInt size() const {
 120       const APInt &rHigh = cast<ConstantInt>(High)->getValue();
 121       const APInt &rLow  = cast<ConstantInt>(Low)->getValue();
 122       return (rHigh - rLow + 1ULL);
 123     }
 124   };
 125
 126   struct CaseBits {
 127     uint64_t Mask;
 128     MachineBasicBlock* BB;
 129     unsigned Bits;
 130
 131     CaseBits(uint64_t mask, MachineBasicBlock* bb, unsigned bits):
 132       Mask(mask), BB(bb), Bits(bits) { }
 133   };
 134
 135   typedef std::vector<Case>           CaseVector;
 136   typedef std::vector<CaseBits>       CaseBitsVector;
 137   typedef CaseVector::iterator        CaseItr;
 138   typedef std::pair<CaseItr, CaseItr> CaseRange;
 139
 140   /// CaseRec - A struct with ctor used in lowering switches to a binary tree
 141   /// of conditional branches.
 142   struct CaseRec {
 143     CaseRec(MachineBasicBlock *bb, const Constant *lt, const Constant *ge,
 144             CaseRange r) :
 145     CaseBB(bb), LT(lt), GE(ge), Range(r) {}
 146
 147     /// CaseBB - The MBB in which to emit the compare and branch
 148     MachineBasicBlock *CaseBB;
 149     /// LT, GE - If nonzero, we know the current case value must be less-than or
 150     /// greater-than-or-equal-to these Constants.
 151     const Constant *LT;
 152     const Constant *GE;
 153     /// Range - A pair of iterators representing the range of case values to be
 154     /// processed at this point in the binary search tree.
 155     CaseRange Range;
 156   };
 157
 158   typedef std::vector<CaseRec> CaseRecVector;
 159
 160   /// The comparison function for sorting the switch case values in the vector.
 161   /// WARNING: Case ranges should be disjoint!
 162   struct CaseCmp {
 163     bool operator()(const Case &C1, const Case &C2) {
 164       assert(isa<ConstantInt>(C1.Low) && isa<ConstantInt>(C2.High));
 165       const ConstantInt* CI1 = cast<const ConstantInt>(C1.Low);
 166       const ConstantInt* CI2 = cast<const ConstantInt>(C2.High);
 167       return CI1->getValue().slt(CI2->getValue());
 168     }
 169   };
 170
 171   struct CaseBitsCmp {
 172     bool operator()(const CaseBits &C1, const CaseBits &C2) {
 173       return C1.Bits > C2.Bits;
 174     }
 175   };
 176
 177   size_t Clusterify(CaseVector &Cases, const SwitchInst &SI);
 178
 179   /// CaseBlock - This structure is used to communicate between
 180   /// SelectionDAGBuilder and SDISel for the code generation of additional basic
 181   /// blocks needed by multi-case switch statements.
 182   struct CaseBlock {
 183     CaseBlock(ISD::CondCode cc, const Value *cmplhs, const Value *cmprhs,
 184               const Value *cmpmiddle,
 185               MachineBasicBlock *truebb, MachineBasicBlock *falsebb,
 186               MachineBasicBlock *me)
 187       : CC(cc), CmpLHS(cmplhs), CmpMHS(cmpmiddle), CmpRHS(cmprhs),
 188         TrueBB(truebb), FalseBB(falsebb), ThisBB(me) {}
 189     // CC - the condition code to use for the case block's setcc node
 190     ISD::CondCode CC;
 191     // CmpLHS/CmpRHS/CmpMHS - The LHS/MHS/RHS of the comparison to emit.
 192     // Emit by default LHS op RHS. MHS is used for range comparisons:
 193     // If MHS is not null: (LHS <= MHS) and (MHS <= RHS).
 194     const Value *CmpLHS, *CmpMHS, *CmpRHS;
 195     // TrueBB/FalseBB - the block to branch to if the setcc is true/false.
 196     MachineBasicBlock *TrueBB, *FalseBB;
 197     // ThisBB - the block into which to emit the code for the setcc and branches
 198     MachineBasicBlock *ThisBB;
 199   };
 200   struct JumpTable {
 201     JumpTable(unsigned R, unsigned J, MachineBasicBlock *M,
 202               MachineBasicBlock *D): Reg(R), JTI(J), MBB(M), Default(D) {}
 203
 204     /// Reg - the virtual register containing the index of the jump table entry
 205     //. to jump to.
 206     unsigned Reg;
 207     /// JTI - the JumpTableIndex for this jump table in the function.
 208     unsigned JTI;
 209     /// MBB - the MBB into which to emit the code for the indirect jump.
 210     MachineBasicBlock *MBB;
 211     /// Default - the MBB of the default bb, which is a successor of the range
 212     /// check MBB.  This is when updating PHI nodes in successors.
 213     MachineBasicBlock *Default;
 214   };
 215   struct JumpTableHeader {
 216     JumpTableHeader(APInt F, APInt L, const Value *SV, MachineBasicBlock *H,
 217                     bool E = false):
 218       First(F), Last(L), SValue(SV), HeaderBB(H), Emitted(E) {}
 219     APInt First;
 220     APInt Last;
 221     const Value *SValue;
 222     MachineBasicBlock *HeaderBB;
 223     bool Emitted;
 224   };
 225   typedef std::pair<JumpTableHeader, JumpTable> JumpTableBlock;
 226
 227   struct BitTestCase {
 228     BitTestCase(uint64_t M, MachineBasicBlock* T, MachineBasicBlock* Tr):
 229       Mask(M), ThisBB(T), TargetBB(Tr) { }
 230     uint64_t Mask;
 231     MachineBasicBlock *ThisBB;
 232     MachineBasicBlock *TargetBB;
 233   };
 234
 235   typedef SmallVector<BitTestCase, 3> BitTestInfo;
 236
 237   struct BitTestBlock {
 238     BitTestBlock(APInt F, APInt R, const Value* SV,
 239                  unsigned Rg, bool E,
 240                  MachineBasicBlock* P, MachineBasicBlock* D,
 241                  const BitTestInfo& C):
 242       First(F), Range(R), SValue(SV), Reg(Rg), Emitted(E),
 243       Parent(P), Default(D), Cases(C) { }
 244     APInt First;
 245     APInt Range;
 246     const Value *SValue;
 247     unsigned Reg;
 248     bool Emitted;
 249     MachineBasicBlock *Parent;
 250     MachineBasicBlock *Default;
 251     BitTestInfo Cases;
 252   };
 253
 254 public:
 255   // TLI - This is information that describes the available target features we
 256   // need for lowering.  This indicates when operations are unavailable,
 257   // implemented with a libcall, etc.
 258   const TargetMachine &TM;
 259   const TargetLowering &TLI;
 260   SelectionDAG &DAG;
 261   const TargetData *TD;
 262   AliasAnalysis *AA;
 263
 264   /// SwitchCases - Vector of CaseBlock structures used to communicate
 265   /// SwitchInst code generation information.
 266   std::vector<CaseBlock> SwitchCases;
 267   /// JTCases - Vector of JumpTable structures used to communicate
 268   /// SwitchInst code generation information.
 269   std::vector<JumpTableBlock> JTCases;
 270   /// BitTestCases - Vector of BitTestBlock structures used to communicate
 271   /// SwitchInst code generation information.
 272   std::vector<BitTestBlock> BitTestCases;
 273
 274   /// EdgeMapping - If an edge from CurMBB to any MBB is changed (e.g. due to
 275   /// scheduler custom lowering), track the change here.
 276   DenseMap<MachineBasicBlock*, MachineBasicBlock*> EdgeMapping;
 277
 278   // Emit PHI-node-operand constants only once even if used by multiple
 279   // PHI nodes.
 280   DenseMap<const Constant *, unsigned> ConstantsOut;
 281
 282   /// FuncInfo - Information about the function as a whole.
 283   ///
 284   FunctionLoweringInfo &FuncInfo;
 285
 286   /// OptLevel - What optimization level we're generating code for.
 287   ///
 288   CodeGenOpt::Level OptLevel;
 289
 290   /// GFI - Garbage collection metadata for the function.
 291   GCFunctionInfo *GFI;
 292
 293   /// HasTailCall - This is set to true if a call in the current
 294   /// block has been translated as a tail call. In this case,
 295   /// no subsequent DAG nodes should be created.
 296   ///
 297   bool HasTailCall;
 298
 299   LLVMContext *Context;
 300
 301   SelectionDAGBuilder(SelectionDAG &dag, FunctionLoweringInfo &funcinfo,
 302                       CodeGenOpt::Level ol)
 303     : SDNodeOrder(0), TM(dag.getTarget()), TLI(dag.getTargetLoweringInfo()),
 304       DAG(dag), FuncInfo(funcinfo), OptLevel(ol),
 305       HasTailCall(false), Context(dag.getContext()) {
 306   }
 307
 308   void init(GCFunctionInfo *gfi, AliasAnalysis &aa);
 309
 310   /// clear - Clear out the current SelectionDAG and the associated
 311   /// state and prepare this SelectionDAGBuilder object to be used
 312   /// for a new block. This doesn't clear out information about
 313   /// additional blocks that are needed to complete switch lowering
 314   /// or PHI node updating; that information is cleared out as it is
 315   /// consumed.
 316   void clear();
 317
 318   /// getRoot - Return the current virtual root of the Selection DAG,
 319   /// flushing any PendingLoad items. This must be done before emitting
 320   /// a store or any other node that may need to be ordered after any
 321   /// prior load instructions.
 322   ///
 323   SDValue getRoot();
 324
 325   /// getControlRoot - Similar to getRoot, but instead of flushing all the
 326   /// PendingLoad items, flush all the PendingExports items. It is necessary
 327   /// to do this before emitting a terminator instruction.
 328   ///
 329   SDValue getControlRoot();
 330
 331   DebugLoc getCurDebugLoc() const { return CurDebugLoc; }
 332
 333   unsigned getSDNodeOrder() const { return SDNodeOrder; }
 334
 335   void CopyValueToVirtualRegister(const Value *V, unsigned Reg);
 336
 337   /// AssignOrderingToNode - Assign an ordering to the node. The order is gotten
 338   /// from how the code appeared in the source. The ordering is used by the
 339   /// scheduler to effectively turn off scheduling.
 340   void AssignOrderingToNode(const SDNode *Node);
 341
 342   void visit(const Instruction &I);
 343
 344   void visit(unsigned Opcode, const User &I);
 345
 346   SDValue getValue(const Value *V);
 347
 348   void setValue(const Value *V, SDValue NewN) {
 349     SDValue &N = NodeMap[V];
 350     assert(N.getNode() == 0 && "Already set a value for this node!");
 351     N = NewN;
 352   }
 353
 354   void GetRegistersForValue(SDISelAsmOperandInfo &OpInfo,
 355                             std::set<unsigned> &OutputRegs,
 356                             std::set<unsigned> &InputRegs);
 357
 358   void FindMergedConditions(const Value *Cond, MachineBasicBlock *TBB,
 359                             MachineBasicBlock *FBB, MachineBasicBlock *CurBB,
 360                             MachineBasicBlock *SwitchBB, unsigned Opc);
 361   void EmitBranchForMergedCondition(const Value *Cond, MachineBasicBlock *TBB,
 362                                     MachineBasicBlock *FBB,
 363                                     MachineBasicBlock *CurBB,
 364                                     MachineBasicBlock *SwitchBB);
 365   bool ShouldEmitAsBranches(const std::vector<CaseBlock> &Cases);
 366   bool isExportableFromCurrentBlock(const Value *V, const BasicBlock *FromBB);
 367   void CopyToExportRegsIfNeeded(const Value *V);
 368   void ExportFromCurrentBlock(const Value *V);
 369   void LowerCallTo(ImmutableCallSite CS, SDValue Callee, bool IsTailCall,
 370                    MachineBasicBlock *LandingPad = NULL);
 371
 372 private:
 373   // Terminator instructions.
 374   void visitRet(const ReturnInst &I);
 375   void visitBr(const BranchInst &I);
 376   void visitSwitch(const SwitchInst &I);
 377   void visitIndirectBr(const IndirectBrInst &I);
 378   void visitUnreachable(const UnreachableInst &I) { /* noop */ }
 379
 380   // Helpers for visitSwitch
 381   bool handleSmallSwitchRange(CaseRec& CR,
 382                               CaseRecVector& WorkList,
 383                               const Value* SV,
 384                               MachineBasicBlock* Default,
 385                               MachineBasicBlock *SwitchBB);
 386   bool handleJTSwitchCase(CaseRec& CR,
 387                           CaseRecVector& WorkList,
 388                           const Value* SV,
 389                           MachineBasicBlock* Default,
 390                           MachineBasicBlock *SwitchBB);
 391   bool handleBTSplitSwitchCase(CaseRec& CR,
 392                                CaseRecVector& WorkList,
 393                                const Value* SV,
 394                                MachineBasicBlock* Default,
 395                                MachineBasicBlock *SwitchBB);
 396   bool handleBitTestsSwitchCase(CaseRec& CR,
 397                                 CaseRecVector& WorkList,
 398                                 const Value* SV,
 399                                 MachineBasicBlock* Default,
 400                                 MachineBasicBlock *SwitchBB);
 401 public:
 402   void visitSwitchCase(CaseBlock &CB,
 403                        MachineBasicBlock *SwitchBB);
 404   void visitBitTestHeader(BitTestBlock &B, MachineBasicBlock *SwitchBB);
 405   void visitBitTestCase(MachineBasicBlock* NextMBB,
 406                         unsigned Reg,
 407                         BitTestCase &B,
 408                         MachineBasicBlock *SwitchBB);
 409   void visitJumpTable(JumpTable &JT);
 410   void visitJumpTableHeader(JumpTable &JT, JumpTableHeader &JTH,
 411                             MachineBasicBlock *SwitchBB);
 412
 413 private:
 414   // These all get lowered before this pass.
 415   void visitInvoke(const InvokeInst &I);
 416   void visitUnwind(const UnwindInst &I);
 417
 418   void visitBinary(const User &I, unsigned OpCode);
 419   void visitShift(const User &I, unsigned Opcode);
 420   void visitAdd(const User &I)  { visitBinary(I, ISD::ADD); }
 421   void visitFAdd(const User &I) { visitBinary(I, ISD::FADD); }
 422   void visitSub(const User &I)  { visitBinary(I, ISD::SUB); }
 423   void visitFSub(const User &I);
 424   void visitMul(const User &I)  { visitBinary(I, ISD::MUL); }
 425   void visitFMul(const User &I) { visitBinary(I, ISD::FMUL); }
 426   void visitURem(const User &I) { visitBinary(I, ISD::UREM); }
 427   void visitSRem(const User &I) { visitBinary(I, ISD::SREM); }
 428   void visitFRem(const User &I) { visitBinary(I, ISD::FREM); }
 429   void visitUDiv(const User &I) { visitBinary(I, ISD::UDIV); }
 430   void visitSDiv(const User &I) { visitBinary(I, ISD::SDIV); }
 431   void visitFDiv(const User &I) { visitBinary(I, ISD::FDIV); }
 432   void visitAnd (const User &I) { visitBinary(I, ISD::AND); }
 433   void visitOr  (const User &I) { visitBinary(I, ISD::OR); }
 434   void visitXor (const User &I) { visitBinary(I, ISD::XOR); }
 435   void visitShl (const User &I) { visitShift(I, ISD::SHL); }
 436   void visitLShr(const User &I) { visitShift(I, ISD::SRL); }
 437   void visitAShr(const User &I) { visitShift(I, ISD::SRA); }
 438   void visitICmp(const User &I);
 439   void visitFCmp(const User &I);
 440   // Visit the conversion instructions
 441   void visitTrunc(const User &I);
 442   void visitZExt(const User &I);
 443   void visitSExt(const User &I);
 444   void visitFPTrunc(const User &I);
 445   void visitFPExt(const User &I);
 446   void visitFPToUI(const User &I);
 447   void visitFPToSI(const User &I);
 448   void visitUIToFP(const User &I);
 449   void visitSIToFP(const User &I);
 450   void visitPtrToInt(const User &I);
 451   void visitIntToPtr(const User &I);
 452   void visitBitCast(const User &I);
 453
 454   void visitExtractElement(const User &I);
 455   void visitInsertElement(const User &I);
 456   void visitShuffleVector(const User &I);
 457
 458   void visitExtractValue(const ExtractValueInst &I);
 459   void visitInsertValue(const InsertValueInst &I);
 460
 461   void visitGetElementPtr(const User &I);
 462   void visitSelect(const User &I);
 463
 464   void visitAlloca(const AllocaInst &I);
 465   void visitLoad(const LoadInst &I);
 466   void visitStore(const StoreInst &I);
 467   void visitPHI(const PHINode &I);
 468   void visitCall(const CallInst &I);
 469   bool visitMemCmpCall(const CallInst &I);
 470
 471   void visitInlineAsm(ImmutableCallSite CS);
 472   const char *visitIntrinsicCall(const CallInst &I, unsigned Intrinsic);
 473   void visitTargetIntrinsic(const CallInst &I, unsigned Intrinsic);
 474
 475   void visitPow(const CallInst &I);
 476   void visitExp2(const CallInst &I);
 477   void visitExp(const CallInst &I);
 478   void visitLog(const CallInst &I);
 479   void visitLog2(const CallInst &I);
 480   void visitLog10(const CallInst &I);
 481
 482   void visitVAStart(const CallInst &I);
 483   void visitVAArg(const VAArgInst &I);
 484   void visitVAEnd(const CallInst &I);
 485   void visitVACopy(const CallInst &I);
 486
 487   void visitUserOp1(const Instruction &I) {
 488     llvm_unreachable("UserOp1 should not exist at instruction selection time!");
 489   }
 490   void visitUserOp2(const Instruction &I) {
 491     llvm_unreachable("UserOp2 should not exist at instruction selection time!");
 492   }
 493
 494   const char *implVisitBinaryAtomic(const CallInst& I, ISD::NodeType Op);
 495   const char *implVisitAluOverflow(const CallInst &I, ISD::NodeType Op);
 496 };
 497
 498 } // end namespace llvm
 499
 500 #endif