include/llvm/CodeGen/SelectionDAGISel.h

   1 //===-- llvm/CodeGen/SelectionDAGISel.h - Common Base Class------*- C++ -*-===//
   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 file implements the SelectionDAGISel class, which is used as the common
  11 // base class for SelectionDAG-based instruction selectors.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CODEGEN_SELECTIONDAG_ISEL_H
  16 #define LLVM_CODEGEN_SELECTIONDAG_ISEL_H
  17
  18 #include "llvm/BasicBlock.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/Constant.h"
  21 #include "llvm/CodeGen/SelectionDAG.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23
  24 namespace llvm {
  25   class FastISel;
  26   class SelectionDAGBuilder;
  27   class SDValue;
  28   class MachineRegisterInfo;
  29   class MachineBasicBlock;
  30   class MachineFunction;
  31   class MachineInstr;
  32   class MachineModuleInfo;
  33   class DwarfWriter;
  34   class TargetLowering;
  35   class TargetInstrInfo;
  36   class FunctionLoweringInfo;
  37   class ScheduleHazardRecognizer;
  38   class GCFunctionInfo;
  39   class ScheduleDAGSDNodes;
  40
  41 /// SelectionDAGISel - This is the common base class used for SelectionDAG-based
  42 /// pattern-matching instruction selectors.
  43 class SelectionDAGISel : public MachineFunctionPass {
  44 public:
  45   const TargetMachine &TM;
  46   TargetLowering &TLI;
  47   FunctionLoweringInfo *FuncInfo;
  48   MachineFunction *MF;
  49   MachineRegisterInfo *RegInfo;
  50   SelectionDAG *CurDAG;
  51   SelectionDAGBuilder *SDB;
  52   MachineBasicBlock *BB;
  53   AliasAnalysis *AA;
  54   GCFunctionInfo *GFI;
  55   CodeGenOpt::Level OptLevel;
  56   static char ID;
  57
  58   explicit SelectionDAGISel(TargetMachine &tm,
  59                             CodeGenOpt::Level OL = CodeGenOpt::Default);
  60   virtual ~SelectionDAGISel();
  61
  62   TargetLowering &getTargetLowering() { return TLI; }
  63
  64   virtual void getAnalysisUsage(AnalysisUsage &AU) const;
  65
  66   virtual bool runOnMachineFunction(MachineFunction &MF);
  67
  68   unsigned MakeReg(EVT VT);
  69
  70   virtual void EmitFunctionEntryCode(Function &Fn, MachineFunction &MF) {}
  71   virtual void InstructionSelect() = 0;
  72
  73   void SelectRootInit() {
  74     DAGSize = CurDAG->AssignTopologicalOrder();
  75   }
  76
  77   /// SelectInlineAsmMemoryOperand - Select the specified address as a target
  78   /// addressing mode, according to the specified constraint code.  If this does
  79   /// not match or is not implemented, return true.  The resultant operands
  80   /// (which will appear in the machine instruction) should be added to the
  81   /// OutOps vector.
  82   virtual bool SelectInlineAsmMemoryOperand(const SDValue &Op,
  83                                             char ConstraintCode,
  84                                             std::vector<SDValue> &OutOps) {
  85     return true;
  86   }
  87
  88   /// IsProfitableToFold - Returns true if it's profitable to fold the specific
  89   /// operand node N of U during instruction selection that starts at Root.
  90   virtual bool IsProfitableToFold(SDValue N, SDNode *U, SDNode *Root) const;
  91
  92   /// IsLegalToFold - Returns true if the specific operand node N of
  93   /// U can be folded during instruction selection that starts at Root.
  94   virtual bool IsLegalToFold(SDValue N, SDNode *U, SDNode *Root) const;
  95
  96   /// CreateTargetHazardRecognizer - Return a newly allocated hazard recognizer
  97   /// to use for this target when scheduling the DAG.
  98   virtual ScheduleHazardRecognizer *CreateTargetHazardRecognizer();
  99
 100 protected:
 101   /// DAGSize - Size of DAG being instruction selected.
 102   ///
 103   unsigned DAGSize;
 104
 105   /// SelectInlineAsmMemoryOperands - Calls to this are automatically generated
 106   /// by tblgen.  Others should not call it.
 107   void SelectInlineAsmMemoryOperands(std::vector<SDValue> &Ops);
 108
 109   // Calls to these predicates are generated by tblgen.
 110   bool CheckAndMask(SDValue LHS, ConstantSDNode *RHS,
 111                     int64_t DesiredMaskS) const;
 112   bool CheckOrMask(SDValue LHS, ConstantSDNode *RHS,
 113                     int64_t DesiredMaskS) const;
 114
 115
 116   /// CheckPatternPredicate - This function is generated by tblgen in the
 117   /// target.  It runs the specified pattern predicate and returns true if it
 118   /// succeeds or false if it fails.  The number is a private implementation
 119   /// detail to the code tblgen produces.
 120   virtual bool CheckPatternPredicate(unsigned PredNo) const {
 121     assert(0 && "Tblgen should generate the implementation of this!");
 122     return 0;
 123   }
 124
 125   /// CheckNodePredicate - This function is generated by tblgen in the
 126   /// target.  It runs node predicate #PredNo and returns true if it succeeds or
 127   /// false if it fails.  The number is a private implementation
 128   /// detail to the code tblgen produces.
 129   virtual bool CheckNodePredicate(SDNode *N, unsigned PredNo) const {
 130     assert(0 && "Tblgen should generate the implementation of this!");
 131     return 0;
 132   }
 133
 134   virtual bool CheckComplexPattern(SDNode *Root, SDValue N, unsigned PatternNo,
 135                                    SmallVectorImpl<SDValue> &Result) {
 136     assert(0 && "Tblgen should generate the implementation of this!");
 137     return false;
 138   }
 139
 140   // Calls to these functions are generated by tblgen.
 141   SDNode *Select_INLINEASM(SDNode *N);
 142   SDNode *Select_UNDEF(SDNode *N);
 143   SDNode *Select_EH_LABEL(SDNode *N);
 144   void CannotYetSelect(SDNode *N);
 145   void CannotYetSelectIntrinsic(SDNode *N);
 146
 147 private:
 148   void SelectAllBasicBlocks(Function &Fn, MachineFunction &MF,
 149                             MachineModuleInfo *MMI,
 150                             DwarfWriter *DW,
 151                             const TargetInstrInfo &TII);
 152   void FinishBasicBlock();
 153
 154   void SelectBasicBlock(BasicBlock *LLVMBB,
 155                         BasicBlock::iterator Begin,
 156                         BasicBlock::iterator End,
 157                         bool &HadTailCall);
 158   void CodeGenAndEmitDAG();
 159   void LowerArguments(BasicBlock *BB);
 160
 161   void ShrinkDemandedOps();
 162   void ComputeLiveOutVRegInfo();
 163
 164   void HandlePHINodesInSuccessorBlocks(BasicBlock *LLVMBB);
 165
 166   bool HandlePHINodesInSuccessorBlocksFast(BasicBlock *LLVMBB, FastISel *F);
 167
 168   /// Create the scheduler. If a specific scheduler was specified
 169   /// via the SchedulerRegistry, use it, otherwise select the
 170   /// one preferred by the target.
 171   ///
 172   ScheduleDAGSDNodes *CreateScheduler();
 173 };
 174
 175 }
 176
 177 #endif /* LLVM_CODEGEN_SELECTIONDAG_ISEL_H */