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/CodeGen/ValueTypes.h"
  19 #include "llvm/CodeGen/MachineBasicBlock.h"
  20
  21 namespace llvm {
  22
  23 class AllocaInst;
  24 class ConstantFP;
  25 class FunctionLoweringInfo;
  26 class Instruction;
  27 class MachineBasicBlock;
  28 class MachineConstantPool;
  29 class MachineFunction;
  30 class MachineInstr;
  31 class MachineFrameInfo;
  32 class MachineRegisterInfo;
  33 class TargetData;
  34 class TargetInstrInfo;
  35 class TargetLowering;
  36 class TargetMachine;
  37 class TargetRegisterClass;
  38 class TargetRegisterInfo;
  39 class LoadInst;
  40
  41 /// FastISel - This is a fast-path instruction selection class that
  42 /// generates poor code and doesn't support illegal types or non-trivial
  43 /// lowering, but runs quickly.
  44 class FastISel {
  45 protected:
  46   DenseMap<const Value *, unsigned> LocalValueMap;
  47   FunctionLoweringInfo &FuncInfo;
  48   MachineRegisterInfo &MRI;
  49   MachineFrameInfo &MFI;
  50   MachineConstantPool &MCP;
  51   DebugLoc DL;
  52   const TargetMachine &TM;
  53   const TargetData &TD;
  54   const TargetInstrInfo &TII;
  55   const TargetLowering &TLI;
  56   const TargetRegisterInfo &TRI;
  57   MachineInstr *LastLocalValue;
  58
  59 public:
  60   /// getLastLocalValue - Return the position of the last instruction
  61   /// emitted for materializing constants for use in the current block.
  62   MachineInstr *getLastLocalValue() { return LastLocalValue; }
  63
  64   /// setLastLocalValue - Update the position of the last instruction
  65   /// emitted for materializing constants for use in the current block.
  66   void setLastLocalValue(MachineInstr *I) { LastLocalValue = I; }
  67
  68   /// startNewBlock - Set the current block to which generated machine
  69   /// instructions will be appended, and clear the local CSE map.
  70   ///
  71   void startNewBlock();
  72
  73   /// getCurDebugLoc() - Return current debug location information.
  74   DebugLoc getCurDebugLoc() const { return DL; }
  75
  76   /// SelectInstruction - Do "fast" instruction selection for the given
  77   /// LLVM IR instruction, and append generated machine instructions to
  78   /// the current block. Return true if selection was successful.
  79   ///
  80   bool SelectInstruction(const Instruction *I);
  81
  82   /// SelectOperator - Do "fast" instruction selection for the given
  83   /// LLVM IR operator (Instruction or ConstantExpr), and append
  84   /// generated machine instructions to the current block. Return true
  85   /// if selection was successful.
  86   ///
  87   bool SelectOperator(const User *I, unsigned Opcode);
  88
  89   /// getRegForValue - Create a virtual register and arrange for it to
  90   /// be assigned the value for the given LLVM value.
  91   unsigned getRegForValue(const Value *V);
  92
  93   /// lookUpRegForValue - Look up the value to see if its value is already
  94   /// cached in a register. It may be defined by instructions across blocks or
  95   /// defined locally.
  96   unsigned lookUpRegForValue(const Value *V);
  97
  98   /// getRegForGEPIndex - This is a wrapper around getRegForValue that also
  99   /// takes care of truncating or sign-extending the given getelementptr
 100   /// index value.
 101   std::pair<unsigned, bool> getRegForGEPIndex(const Value *V);
 102
 103   /// TryToFoldLoad - The specified machine instr operand is a vreg, and that
 104   /// vreg is being provided by the specified load instruction.  If possible,
 105   /// try to fold the load as an operand to the instruction, returning true if
 106   /// possible.
 107   virtual bool TryToFoldLoad(MachineInstr * /*MI*/, unsigned /*OpNo*/,
 108                              const LoadInst * /*LI*/) {
 109     return false;
 110   }
 111
 112   /// recomputeInsertPt - Reset InsertPt to prepare for inserting instructions
 113   /// into the current block.
 114   void recomputeInsertPt();
 115
 116   struct SavePoint {
 117     MachineBasicBlock::iterator InsertPt;
 118     DebugLoc DL;
 119   };
 120
 121   /// recomputeDebugLocForMaterializedRegs - Recompute debug location for
 122   /// very first instruction in a basic block.
 123   void recomputeDebugLocForMaterializedRegs();
 124
 125   /// enterLocalValueArea - Prepare InsertPt to begin inserting instructions
 126   /// into the local value area and return the old insert position.
 127   SavePoint enterLocalValueArea();
 128
 129   /// leaveLocalValueArea - Reset InsertPt to the given old insert position.
 130   void leaveLocalValueArea(SavePoint Old);
 131
 132   virtual ~FastISel();
 133
 134 protected:
 135   explicit FastISel(FunctionLoweringInfo &funcInfo);
 136
 137   /// TargetSelectInstruction - This method is called by target-independent
 138   /// code when the normal FastISel process fails to select an instruction.
 139   /// This gives targets a chance to emit code for anything that doesn't
 140   /// fit into FastISel's framework. It returns true if it was successful.
 141   ///
 142   virtual bool
 143   TargetSelectInstruction(const Instruction *I) = 0;
 144
 145   /// FastEmit_r - This method is called by target-independent code
 146   /// to request that an instruction with the given type and opcode
 147   /// be emitted.
 148   virtual unsigned FastEmit_(MVT VT,
 149                              MVT RetVT,
 150                              unsigned Opcode);
 151
 152   /// FastEmit_r - This method is called by target-independent code
 153   /// to request that an instruction with the given type, opcode, and
 154   /// register operand be emitted.
 155   ///
 156   virtual unsigned FastEmit_r(MVT VT,
 157                               MVT RetVT,
 158                               unsigned Opcode,
 159                               unsigned Op0, bool Op0IsKill);
 160
 161   /// FastEmit_rr - This method is called by target-independent code
 162   /// to request that an instruction with the given type, opcode, and
 163   /// register operands be emitted.
 164   ///
 165   virtual unsigned FastEmit_rr(MVT VT,
 166                                MVT RetVT,
 167                                unsigned Opcode,
 168                                unsigned Op0, bool Op0IsKill,
 169                                unsigned Op1, bool Op1IsKill);
 170
 171   /// FastEmit_ri - This method is called by target-independent code
 172   /// to request that an instruction with the given type, opcode, and
 173   /// register and immediate operands be emitted.
 174   ///
 175   virtual unsigned FastEmit_ri(MVT VT,
 176                                MVT RetVT,
 177                                unsigned Opcode,
 178                                unsigned Op0, bool Op0IsKill,
 179                                uint64_t Imm);
 180
 181   /// FastEmit_rf - This method is called by target-independent code
 182   /// to request that an instruction with the given type, opcode, and
 183   /// register and floating-point immediate operands be emitted.
 184   ///
 185   virtual unsigned FastEmit_rf(MVT VT,
 186                                MVT RetVT,
 187                                unsigned Opcode,
 188                                unsigned Op0, bool Op0IsKill,
 189                                const ConstantFP *FPImm);
 190
 191   /// FastEmit_rri - This method is called by target-independent code
 192   /// to request that an instruction with the given type, opcode, and
 193   /// register and immediate operands be emitted.
 194   ///
 195   virtual unsigned FastEmit_rri(MVT VT,
 196                                 MVT RetVT,
 197                                 unsigned Opcode,
 198                                 unsigned Op0, bool Op0IsKill,
 199                                 unsigned Op1, bool Op1IsKill,
 200                                 uint64_t Imm);
 201
 202   /// FastEmit_ri_ - This method is a wrapper of FastEmit_ri. It first tries
 203   /// to emit an instruction with an immediate operand using FastEmit_ri.
 204   /// If that fails, it materializes the immediate into a register and try
 205   /// FastEmit_rr instead.
 206   unsigned FastEmit_ri_(MVT VT,
 207                         unsigned Opcode,
 208                         unsigned Op0, bool Op0IsKill,
 209                         uint64_t Imm, MVT ImmType);
 210
 211   /// FastEmit_i - This method is called by target-independent code
 212   /// to request that an instruction with the given type, opcode, and
 213   /// immediate operand be emitted.
 214   virtual unsigned FastEmit_i(MVT VT,
 215                               MVT RetVT,
 216                               unsigned Opcode,
 217                               uint64_t Imm);
 218
 219   /// FastEmit_f - This method is called by target-independent code
 220   /// to request that an instruction with the given type, opcode, and
 221   /// floating-point immediate operand be emitted.
 222   virtual unsigned FastEmit_f(MVT VT,
 223                               MVT RetVT,
 224                               unsigned Opcode,
 225                               const ConstantFP *FPImm);
 226
 227   /// FastEmitInst_ - Emit a MachineInstr with no operands and a
 228   /// result register in the given register class.
 229   ///
 230   unsigned FastEmitInst_(unsigned MachineInstOpcode,
 231                          const TargetRegisterClass *RC);
 232
 233   /// FastEmitInst_r - Emit a MachineInstr with one register operand
 234   /// and a result register in the given register class.
 235   ///
 236   unsigned FastEmitInst_r(unsigned MachineInstOpcode,
 237                           const TargetRegisterClass *RC,
 238                           unsigned Op0, bool Op0IsKill);
 239
 240   /// FastEmitInst_rr - Emit a MachineInstr with two register operands
 241   /// and a result register in the given register class.
 242   ///
 243   unsigned FastEmitInst_rr(unsigned MachineInstOpcode,
 244                            const TargetRegisterClass *RC,
 245                            unsigned Op0, bool Op0IsKill,
 246                            unsigned Op1, bool Op1IsKill);
 247
 248   /// FastEmitInst_rrr - Emit a MachineInstr with three register operands
 249   /// and a result register in the given register class.
 250   ///
 251   unsigned FastEmitInst_rrr(unsigned MachineInstOpcode,
 252                            const TargetRegisterClass *RC,
 253                            unsigned Op0, bool Op0IsKill,
 254                            unsigned Op1, bool Op1IsKill,
 255                            unsigned Op2, bool Op2IsKill);
 256
 257   /// FastEmitInst_ri - Emit a MachineInstr with a register operand,
 258   /// an immediate, and a result register in the given register class.
 259   ///
 260   unsigned FastEmitInst_ri(unsigned MachineInstOpcode,
 261                            const TargetRegisterClass *RC,
 262                            unsigned Op0, bool Op0IsKill,
 263                            uint64_t Imm);
 264
 265   /// FastEmitInst_rii - Emit a MachineInstr with one register operand
 266   /// and two immediate operands.
 267   ///
 268   unsigned FastEmitInst_rii(unsigned MachineInstOpcode,
 269                            const TargetRegisterClass *RC,
 270                            unsigned Op0, bool Op0IsKill,
 271                            uint64_t Imm1, uint64_t Imm2);
 272
 273   /// FastEmitInst_rf - Emit a MachineInstr with two register operands
 274   /// and a result register in the given register class.
 275   ///
 276   unsigned FastEmitInst_rf(unsigned MachineInstOpcode,
 277                            const TargetRegisterClass *RC,
 278                            unsigned Op0, bool Op0IsKill,
 279                            const ConstantFP *FPImm);
 280
 281   /// FastEmitInst_rri - Emit a MachineInstr with two register operands,
 282   /// an immediate, and a result register in the given register class.
 283   ///
 284   unsigned FastEmitInst_rri(unsigned MachineInstOpcode,
 285                             const TargetRegisterClass *RC,
 286                             unsigned Op0, bool Op0IsKill,
 287                             unsigned Op1, bool Op1IsKill,
 288                             uint64_t Imm);
 289
 290   /// FastEmitInst_i - Emit a MachineInstr with a single immediate
 291   /// operand, and a result register in the given register class.
 292   unsigned FastEmitInst_i(unsigned MachineInstrOpcode,
 293                           const TargetRegisterClass *RC,
 294                           uint64_t Imm);
 295
 296   /// FastEmitInst_ii - Emit a MachineInstr with a two immediate operands.
 297   unsigned FastEmitInst_ii(unsigned MachineInstrOpcode,
 298                           const TargetRegisterClass *RC,
 299                           uint64_t Imm1, uint64_t Imm2);
 300
 301   /// FastEmitInst_extractsubreg - Emit a MachineInstr for an extract_subreg
 302   /// from a specified index of a superregister to a specified type.
 303   unsigned FastEmitInst_extractsubreg(MVT RetVT,
 304                                       unsigned Op0, bool Op0IsKill,
 305                                       uint32_t Idx);
 306
 307   /// FastEmitZExtFromI1 - Emit MachineInstrs to compute the value of Op
 308   /// with all but the least significant bit set to zero.
 309   unsigned FastEmitZExtFromI1(MVT VT,
 310                               unsigned Op0, bool Op0IsKill);
 311
 312   /// FastEmitBranch - Emit an unconditional branch to the given block,
 313   /// unless it is the immediate (fall-through) successor, and update
 314   /// the CFG.
 315   void FastEmitBranch(MachineBasicBlock *MBB, DebugLoc DL);
 316
 317   void UpdateValueMap(const Value* I, unsigned Reg, unsigned NumRegs = 1);
 318
 319   unsigned createResultReg(const TargetRegisterClass *RC);
 320
 321   /// TargetMaterializeConstant - Emit a constant in a register using
 322   /// target-specific logic, such as constant pool loads.
 323   virtual unsigned TargetMaterializeConstant(const Constant* C) {
 324     return 0;
 325   }
 326
 327   /// TargetMaterializeAlloca - Emit an alloca address in a register using
 328   /// target-specific logic.
 329   virtual unsigned TargetMaterializeAlloca(const AllocaInst* C) {
 330     return 0;
 331   }
 332
 333   virtual unsigned TargetMaterializeFloatZero(const ConstantFP* CF) {
 334     return 0;
 335   }
 336
 337 private:
 338   bool SelectBinaryOp(const User *I, unsigned ISDOpcode);
 339
 340   bool SelectFNeg(const User *I);
 341
 342   bool SelectGetElementPtr(const User *I);
 343
 344   bool SelectCall(const User *I);
 345
 346   bool SelectBitCast(const User *I);
 347
 348   bool SelectCast(const User *I, unsigned Opcode);
 349
 350   bool SelectExtractValue(const User *I);
 351
 352   /// HandlePHINodesInSuccessorBlocks - Handle PHI nodes in successor blocks.
 353   /// Emit code to ensure constants are copied into registers when needed.
 354   /// Remember the virtual registers that need to be added to the Machine PHI
 355   /// nodes as input.  We cannot just directly add them, because expansion
 356   /// might result in multiple MBB's for one BB.  As such, the start of the
 357   /// BB might correspond to a different MBB than the end.
 358   bool HandlePHINodesInSuccessorBlocks(const BasicBlock *LLVMBB);
 359
 360   /// materializeRegForValue - Helper for getRegForVale. This function is
 361   /// called when the value isn't already available in a register and must
 362   /// be materialized with new instructions.
 363   unsigned materializeRegForValue(const Value *V, MVT VT);
 364
 365   /// hasTrivialKill - Test whether the given value has exactly one use.
 366   bool hasTrivialKill(const Value *V) const;
 367 };
 368
 369 }
 370
 371 #endif