include/llvm/CodeGen/FastISel.h

   1 //===-- FastISel.h - Definition of the FastISel class ---------------------===//
   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 defines the FastISel class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_FASTISEL_H
  15 #define LLVM_CODEGEN_FASTISEL_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/SmallSet.h"
  19 #include "llvm/CodeGen/SelectionDAGNodes.h"
  20
  21 namespace llvm {
  22
  23 class AllocaInst;
  24 class ConstantFP;
  25 class Instruction;
  26 class MachineBasicBlock;
  27 class MachineConstantPool;
  28 class MachineFunction;
  29 class MachineFrameInfo;
  30 class MachineModuleInfo;
  31 class MachineRegisterInfo;
  32 class TargetData;
  33 class TargetInstrInfo;
  34 class TargetLowering;
  35 class TargetMachine;
  36 class TargetRegisterClass;
  37
  38 /// FastISel - This is a fast-path instruction selection class that
  39 /// generates poor code and doesn't support illegal types or non-trivial
  40 /// lowering, but runs quickly.
  41 class FastISel {
  42 protected:
  43   MachineBasicBlock *MBB;
  44   DenseMap<const Value *, unsigned> LocalValueMap;
  45   DenseMap<const Value *, unsigned> &ValueMap;
  46   DenseMap<const BasicBlock *, MachineBasicBlock *> &MBBMap;
  47   DenseMap<const AllocaInst *, int> &StaticAllocaMap;
  48 #ifndef NDEBUG
  49   SmallSet<Instruction*, 8> &CatchInfoLost;
  50 #endif
  51   MachineFunction &MF;
  52   MachineModuleInfo *MMI;
  53   MachineRegisterInfo &MRI;
  54   MachineFrameInfo &MFI;
  55   MachineConstantPool &MCP;
  56   const TargetMachine &TM;
  57   const TargetData &TD;
  58   const TargetInstrInfo &TII;
  59   const TargetLowering &TLI;
  60
  61 public:
  62   /// startNewBlock - Set the current block, to which generated
  63   /// machine instructions will be appended, and clear the local
  64   /// CSE map.
  65   ///
  66   void startNewBlock(MachineBasicBlock *mbb) {
  67     setCurrentBlock(mbb);
  68     LocalValueMap.clear();
  69   }
  70
  71   /// setCurrentBlock - Set the current block, to which generated
  72   /// machine instructions will be appended.
  73   ///
  74   void setCurrentBlock(MachineBasicBlock *mbb) {
  75     MBB = mbb;
  76   }
  77
  78   /// SelectInstruction - Do "fast" instruction selection for the given
  79   /// LLVM IR instruction, and append generated machine instructions to
  80   /// the current block. Return true if selection was successful.
  81   ///
  82   bool SelectInstruction(Instruction *I);
  83
  84   /// SelectInstruction - Do "fast" instruction selection for the given
  85   /// LLVM IR operator (Instruction or ConstantExpr), and append
  86   /// generated machine instructions to the current block. Return true
  87   /// if selection was successful.
  88   ///
  89   bool SelectOperator(User *I, unsigned Opcode);
  90
  91   /// TargetSelectInstruction - This method is called by target-independent
  92   /// code when the normal FastISel process fails to select an instruction.
  93   /// This gives targets a chance to emit code for anything that doesn't
  94   /// fit into FastISel's framework. It returns true if it was successful.
  95   ///
  96   virtual bool
  97   TargetSelectInstruction(Instruction *I) = 0;
  98
  99   /// getRegForValue - Create a virtual register and arrange for it to
 100   /// be assigned the value for the given LLVM value.
 101   unsigned getRegForValue(Value *V);
 102
 103   /// lookUpRegForValue - Look up the value to see if its value is already
 104   /// cached in a register. It may be defined by instructions across blocks or
 105   /// defined locally.
 106   unsigned lookUpRegForValue(Value *V);
 107
 108   /// getRegForGEPIndex - This is a wrapper around getRegForValue that also
 109   /// takes care of truncating or sign-extending the given getelementptr
 110   /// index value.
 111   unsigned getRegForGEPIndex(Value *V);
 112
 113   virtual ~FastISel();
 114
 115 protected:
 116   FastISel(MachineFunction &mf,
 117            MachineModuleInfo *mmi,
 118            DenseMap<const Value *, unsigned> &vm,
 119            DenseMap<const BasicBlock *, MachineBasicBlock *> &bm,
 120            DenseMap<const AllocaInst *, int> &am
 121 #ifndef NDEBUG
 122            , SmallSet<Instruction*, 8> &cil
 123 #endif
 124            );
 125
 126   /// FastEmit_r - This method is called by target-independent code
 127   /// to request that an instruction with the given type and opcode
 128   /// be emitted.
 129   virtual unsigned FastEmit_(MVT::SimpleValueType VT,
 130                              MVT::SimpleValueType RetVT,
 131                              ISD::NodeType Opcode);
 132
 133   /// FastEmit_r - This method is called by target-independent code
 134   /// to request that an instruction with the given type, opcode, and
 135   /// register operand be emitted.
 136   ///
 137   virtual unsigned FastEmit_r(MVT::SimpleValueType VT,
 138                               MVT::SimpleValueType RetVT,
 139                               ISD::NodeType Opcode, unsigned Op0);
 140
 141   /// FastEmit_rr - This method is called by target-independent code
 142   /// to request that an instruction with the given type, opcode, and
 143   /// register operands be emitted.
 144   ///
 145   virtual unsigned FastEmit_rr(MVT::SimpleValueType VT,
 146                                MVT::SimpleValueType RetVT,
 147                                ISD::NodeType Opcode,
 148                                unsigned Op0, unsigned Op1);
 149
 150   /// FastEmit_ri - This method is called by target-independent code
 151   /// to request that an instruction with the given type, opcode, and
 152   /// register and immediate operands be emitted.
 153   ///
 154   virtual unsigned FastEmit_ri(MVT::SimpleValueType VT,
 155                                MVT::SimpleValueType RetVT,
 156                                ISD::NodeType Opcode,
 157                                unsigned Op0, uint64_t Imm);
 158
 159   /// FastEmit_rf - This method is called by target-independent code
 160   /// to request that an instruction with the given type, opcode, and
 161   /// register and floating-point immediate operands be emitted.
 162   ///
 163   virtual unsigned FastEmit_rf(MVT::SimpleValueType VT,
 164                                MVT::SimpleValueType RetVT,
 165                                ISD::NodeType Opcode,
 166                                unsigned Op0, ConstantFP *FPImm);
 167
 168   /// FastEmit_rri - This method is called by target-independent code
 169   /// to request that an instruction with the given type, opcode, and
 170   /// register and immediate operands be emitted.
 171   ///
 172   virtual unsigned FastEmit_rri(MVT::SimpleValueType VT,
 173                                 MVT::SimpleValueType RetVT,
 174                                 ISD::NodeType Opcode,
 175                                 unsigned Op0, unsigned Op1, uint64_t Imm);
 176
 177   /// FastEmit_ri_ - This method is a wrapper of FastEmit_ri. It first tries
 178   /// to emit an instruction with an immediate operand using FastEmit_ri.
 179   /// If that fails, it materializes the immediate into a register and try
 180   /// FastEmit_rr instead.
 181   unsigned FastEmit_ri_(MVT::SimpleValueType VT,
 182                         ISD::NodeType Opcode,
 183                         unsigned Op0, uint64_t Imm,
 184                         MVT::SimpleValueType ImmType);
 185
 186   /// FastEmit_rf_ - This method is a wrapper of FastEmit_rf. It first tries
 187   /// to emit an instruction with an immediate operand using FastEmit_rf.
 188   /// If that fails, it materializes the immediate into a register and try
 189   /// FastEmit_rr instead.
 190   unsigned FastEmit_rf_(MVT::SimpleValueType VT,
 191                         ISD::NodeType Opcode,
 192                         unsigned Op0, ConstantFP *FPImm,
 193                         MVT::SimpleValueType ImmType);
 194
 195   /// FastEmit_i - This method is called by target-independent code
 196   /// to request that an instruction with the given type, opcode, and
 197   /// immediate operand be emitted.
 198   virtual unsigned FastEmit_i(MVT::SimpleValueType VT,
 199                               MVT::SimpleValueType RetVT,
 200                               ISD::NodeType Opcode,
 201                               uint64_t Imm);
 202
 203   /// FastEmit_f - This method is called by target-independent code
 204   /// to request that an instruction with the given type, opcode, and
 205   /// floating-point immediate operand be emitted.
 206   virtual unsigned FastEmit_f(MVT::SimpleValueType VT,
 207                               MVT::SimpleValueType RetVT,
 208                               ISD::NodeType Opcode,
 209                               ConstantFP *FPImm);
 210
 211   /// FastEmitInst_ - Emit a MachineInstr with no operands and a
 212   /// result register in the given register class.
 213   ///
 214   unsigned FastEmitInst_(unsigned MachineInstOpcode,
 215                          const TargetRegisterClass *RC);
 216
 217   /// FastEmitInst_r - Emit a MachineInstr with one register operand
 218   /// and a result register in the given register class.
 219   ///
 220   unsigned FastEmitInst_r(unsigned MachineInstOpcode,
 221                           const TargetRegisterClass *RC,
 222                           unsigned Op0);
 223
 224   /// FastEmitInst_rr - Emit a MachineInstr with two register operands
 225   /// and a result register in the given register class.
 226   ///
 227   unsigned FastEmitInst_rr(unsigned MachineInstOpcode,
 228                            const TargetRegisterClass *RC,
 229                            unsigned Op0, unsigned Op1);
 230
 231   /// FastEmitInst_ri - Emit a MachineInstr with two register operands
 232   /// and a result register in the given register class.
 233   ///
 234   unsigned FastEmitInst_ri(unsigned MachineInstOpcode,
 235                            const TargetRegisterClass *RC,
 236                            unsigned Op0, uint64_t Imm);
 237
 238   /// FastEmitInst_rf - Emit a MachineInstr with two register operands
 239   /// and a result register in the given register class.
 240   ///
 241   unsigned FastEmitInst_rf(unsigned MachineInstOpcode,
 242                            const TargetRegisterClass *RC,
 243                            unsigned Op0, ConstantFP *FPImm);
 244
 245   /// FastEmitInst_rri - Emit a MachineInstr with two register operands,
 246   /// an immediate, and a result register in the given register class.
 247   ///
 248   unsigned FastEmitInst_rri(unsigned MachineInstOpcode,
 249                             const TargetRegisterClass *RC,
 250                             unsigned Op0, unsigned Op1, uint64_t Imm);
 251
 252   /// FastEmitInst_i - Emit a MachineInstr with a single immediate
 253   /// operand, and a result register in the given register class.
 254   unsigned FastEmitInst_i(unsigned MachineInstrOpcode,
 255                           const TargetRegisterClass *RC,
 256                           uint64_t Imm);
 257
 258   /// FastEmitInst_extractsubreg - Emit a MachineInstr for an extract_subreg
 259   /// from a specified index of a superregister.
 260   unsigned FastEmitInst_extractsubreg(unsigned Op0, uint32_t Idx);
 261
 262   /// FastEmitBranch - Emit an unconditional branch to the given block,
 263   /// unless it is the immediate (fall-through) successor, and update
 264   /// the CFG.
 265   void FastEmitBranch(MachineBasicBlock *MBB);
 266
 267   void UpdateValueMap(Value* I, unsigned Reg);
 268
 269   unsigned createResultReg(const TargetRegisterClass *RC);
 270
 271   /// TargetMaterializeConstant - Emit a constant in a register using
 272   /// target-specific logic, such as constant pool loads.
 273   virtual unsigned TargetMaterializeConstant(Constant* C) {
 274     return 0;
 275   }
 276
 277   /// TargetMaterializeAlloca - Emit an alloca address in a register using
 278   /// target-specific logic.
 279   virtual unsigned TargetMaterializeAlloca(AllocaInst* C) {
 280     return 0;
 281   }
 282
 283 private:
 284   bool SelectBinaryOp(User *I, ISD::NodeType ISDOpcode);
 285
 286   bool SelectGetElementPtr(User *I);
 287
 288   bool SelectCall(User *I);
 289
 290   bool SelectBitCast(User *I);
 291
 292   bool SelectCast(User *I, ISD::NodeType Opcode);
 293 };
 294
 295 }
 296
 297 #endif