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   DebugLoc DL;
  57   const TargetMachine &TM;
  58   const TargetData &TD;
  59   const TargetInstrInfo &TII;
  60   const TargetLowering &TLI;
  61
  62 public:
  63   /// startNewBlock - Set the current block to which generated machine
  64   /// instructions will be appended, and clear the local 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 machine
  72   /// instructions will be appended.
  73   ///
  74   void setCurrentBlock(MachineBasicBlock *mbb) {
  75     MBB = mbb;
  76   }
  77
  78   /// setCurDebugLoc - Set the current debug location information, which is used
  79   /// when creating a machine instruction.
  80   ///
  81   void setCurDebugLoc(DebugLoc dl) { DL = dl; }
  82
  83   /// getCurDebugLoc() - Return current debug location information.
  84   DebugLoc getCurDebugLoc() const { return DL; }
  85
  86   /// SelectInstruction - Do "fast" instruction selection for the given
  87   /// LLVM IR instruction, and append generated machine instructions to
  88   /// the current block. Return true if selection was successful.
  89   ///
  90   bool SelectInstruction(Instruction *I);
  91
  92   /// SelectOperator - Do "fast" instruction selection for the given
  93   /// LLVM IR operator (Instruction or ConstantExpr), and append
  94   /// generated machine instructions to the current block. Return true
  95   /// if selection was successful.
  96   ///
  97   bool SelectOperator(User *I, unsigned Opcode);
  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   /// TargetSelectInstruction - This method is called by target-independent
 127   /// code when the normal FastISel process fails to select an instruction.
 128   /// This gives targets a chance to emit code for anything that doesn't
 129   /// fit into FastISel's framework. It returns true if it was successful.
 130   ///
 131   virtual bool
 132   TargetSelectInstruction(Instruction *I) = 0;
 133
 134   /// FastEmit_r - This method is called by target-independent code
 135   /// to request that an instruction with the given type and opcode
 136   /// be emitted.
 137   virtual unsigned FastEmit_(MVT VT,
 138                              MVT RetVT,
 139                              unsigned Opcode);
 140
 141   /// FastEmit_r - This method is called by target-independent code
 142   /// to request that an instruction with the given type, opcode, and
 143   /// register operand be emitted.
 144   ///
 145   virtual unsigned FastEmit_r(MVT VT,
 146                               MVT RetVT,
 147                               unsigned Opcode, unsigned Op0);
 148
 149   /// FastEmit_rr - This method is called by target-independent code
 150   /// to request that an instruction with the given type, opcode, and
 151   /// register operands be emitted.
 152   ///
 153   virtual unsigned FastEmit_rr(MVT VT,
 154                                MVT RetVT,
 155                                unsigned Opcode,
 156                                unsigned Op0, unsigned Op1);
 157
 158   /// FastEmit_ri - This method is called by target-independent code
 159   /// to request that an instruction with the given type, opcode, and
 160   /// register and immediate operands be emitted.
 161   ///
 162   virtual unsigned FastEmit_ri(MVT VT,
 163                                MVT RetVT,
 164                                unsigned Opcode,
 165                                unsigned Op0, uint64_t Imm);
 166
 167   /// FastEmit_rf - This method is called by target-independent code
 168   /// to request that an instruction with the given type, opcode, and
 169   /// register and floating-point immediate operands be emitted.
 170   ///
 171   virtual unsigned FastEmit_rf(MVT VT,
 172                                MVT RetVT,
 173                                unsigned Opcode,
 174                                unsigned Op0, ConstantFP *FPImm);
 175
 176   /// FastEmit_rri - This method is called by target-independent code
 177   /// to request that an instruction with the given type, opcode, and
 178   /// register and immediate operands be emitted.
 179   ///
 180   virtual unsigned FastEmit_rri(MVT VT,
 181                                 MVT RetVT,
 182                                 unsigned Opcode,
 183                                 unsigned Op0, unsigned Op1, uint64_t Imm);
 184
 185   /// FastEmit_ri_ - This method is a wrapper of FastEmit_ri. It first tries
 186   /// to emit an instruction with an immediate operand using FastEmit_ri.
 187   /// If that fails, it materializes the immediate into a register and try
 188   /// FastEmit_rr instead.
 189   unsigned FastEmit_ri_(MVT VT,
 190                         unsigned Opcode,
 191                         unsigned Op0, uint64_t Imm,
 192                         MVT ImmType);
 193
 194   /// FastEmit_rf_ - This method is a wrapper of FastEmit_rf. It first tries
 195   /// to emit an instruction with an immediate operand using FastEmit_rf.
 196   /// If that fails, it materializes the immediate into a register and try
 197   /// FastEmit_rr instead.
 198   unsigned FastEmit_rf_(MVT VT,
 199                         unsigned Opcode,
 200                         unsigned Op0, ConstantFP *FPImm,
 201                         MVT ImmType);
 202
 203   /// FastEmit_i - This method is called by target-independent code
 204   /// to request that an instruction with the given type, opcode, and
 205   /// immediate operand be emitted.
 206   virtual unsigned FastEmit_i(MVT VT,
 207                               MVT RetVT,
 208                               unsigned Opcode,
 209                               uint64_t Imm);
 210
 211   /// FastEmit_f - This method is called by target-independent code
 212   /// to request that an instruction with the given type, opcode, and
 213   /// floating-point immediate operand be emitted.
 214   virtual unsigned FastEmit_f(MVT VT,
 215                               MVT RetVT,
 216                               unsigned Opcode,
 217                               ConstantFP *FPImm);
 218
 219   /// FastEmitInst_ - Emit a MachineInstr with no operands and a
 220   /// result register in the given register class.
 221   ///
 222   unsigned FastEmitInst_(unsigned MachineInstOpcode,
 223                          const TargetRegisterClass *RC);
 224
 225   /// FastEmitInst_r - Emit a MachineInstr with one register operand
 226   /// and a result register in the given register class.
 227   ///
 228   unsigned FastEmitInst_r(unsigned MachineInstOpcode,
 229                           const TargetRegisterClass *RC,
 230                           unsigned Op0);
 231
 232   /// FastEmitInst_rr - Emit a MachineInstr with two register operands
 233   /// and a result register in the given register class.
 234   ///
 235   unsigned FastEmitInst_rr(unsigned MachineInstOpcode,
 236                            const TargetRegisterClass *RC,
 237                            unsigned Op0, unsigned Op1);
 238
 239   /// FastEmitInst_ri - Emit a MachineInstr with two register operands
 240   /// and a result register in the given register class.
 241   ///
 242   unsigned FastEmitInst_ri(unsigned MachineInstOpcode,
 243                            const TargetRegisterClass *RC,
 244                            unsigned Op0, uint64_t Imm);
 245
 246   /// FastEmitInst_rf - Emit a MachineInstr with two register operands
 247   /// and a result register in the given register class.
 248   ///
 249   unsigned FastEmitInst_rf(unsigned MachineInstOpcode,
 250                            const TargetRegisterClass *RC,
 251                            unsigned Op0, ConstantFP *FPImm);
 252
 253   /// FastEmitInst_rri - Emit a MachineInstr with two register operands,
 254   /// an immediate, and a result register in the given register class.
 255   ///
 256   unsigned FastEmitInst_rri(unsigned MachineInstOpcode,
 257                             const TargetRegisterClass *RC,
 258                             unsigned Op0, unsigned Op1, uint64_t Imm);
 259
 260   /// FastEmitInst_i - Emit a MachineInstr with a single immediate
 261   /// operand, and a result register in the given register class.
 262   unsigned FastEmitInst_i(unsigned MachineInstrOpcode,
 263                           const TargetRegisterClass *RC,
 264                           uint64_t Imm);
 265
 266   /// FastEmitInst_extractsubreg - Emit a MachineInstr for an extract_subreg
 267   /// from a specified index of a superregister to a specified type.
 268   unsigned FastEmitInst_extractsubreg(MVT RetVT,
 269                                       unsigned Op0, uint32_t Idx);
 270
 271   /// FastEmitZExtFromI1 - Emit MachineInstrs to compute the value of Op
 272   /// with all but the least significant bit set to zero.
 273   unsigned FastEmitZExtFromI1(MVT VT,
 274                               unsigned Op);
 275
 276   /// FastEmitBranch - Emit an unconditional branch to the given block,
 277   /// unless it is the immediate (fall-through) successor, and update
 278   /// the CFG.
 279   void FastEmitBranch(MachineBasicBlock *MBB);
 280
 281   unsigned UpdateValueMap(Value* I, unsigned Reg);
 282
 283   unsigned createResultReg(const TargetRegisterClass *RC);
 284
 285   /// TargetMaterializeConstant - Emit a constant in a register using
 286   /// target-specific logic, such as constant pool loads.
 287   virtual unsigned TargetMaterializeConstant(Constant* C) {
 288     return 0;
 289   }
 290
 291   /// TargetMaterializeAlloca - Emit an alloca address in a register using
 292   /// target-specific logic.
 293   virtual unsigned TargetMaterializeAlloca(AllocaInst* C) {
 294     return 0;
 295   }
 296
 297 private:
 298   bool SelectBinaryOp(User *I, unsigned ISDOpcode);
 299
 300   bool SelectFNeg(User *I);
 301
 302   bool SelectGetElementPtr(User *I);
 303
 304   bool SelectCall(User *I);
 305
 306   bool SelectBitCast(User *I);
 307
 308   bool SelectCast(User *I, unsigned Opcode);
 309 };
 310
 311 }
 312
 313 #endif