include/llvm/CodeGen/MachineFunction.h

   1 //===-- llvm/CodeGen/MachineFunction.h --------------------------*- 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 // Collect native machine code for a function.  This class contains a list of
  11 // MachineBasicBlock instances that make up the current compiled function.
  12 //
  13 // This class also contains pointers to various classes which hold
  14 // target-specific information about the generated code.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_CODEGEN_MACHINEFUNCTION_H
  19 #define LLVM_CODEGEN_MACHINEFUNCTION_H
  20
  21 #include "llvm/ADT/ilist.h"
  22 #include "llvm/CodeGen/DebugLoc.h"
  23 #include "llvm/CodeGen/MachineBasicBlock.h"
  24 #include "llvm/Support/Annotation.h"
  25 #include "llvm/Support/Allocator.h"
  26 #include "llvm/Support/Recycler.h"
  27
  28 namespace llvm {
  29
  30 class Function;
  31 class MachineRegisterInfo;
  32 class MachineFrameInfo;
  33 class MachineConstantPool;
  34 class MachineJumpTableInfo;
  35 class TargetMachine;
  36 class TargetRegisterClass;
  37
  38 template <>
  39 struct ilist_traits<MachineBasicBlock>
  40     : public ilist_default_traits<MachineBasicBlock> {
  41   mutable ilist_node<MachineBasicBlock> Sentinel;
  42 public:
  43   MachineBasicBlock *createSentinel() const {
  44     return static_cast<MachineBasicBlock*>(&Sentinel);
  45   }
  46   void destroySentinel(MachineBasicBlock *) const {}
  47
  48   MachineBasicBlock *provideInitialHead() const { return createSentinel(); }
  49   MachineBasicBlock *ensureHead(MachineBasicBlock*) const {
  50     return createSentinel();
  51   }
  52   static void noteHead(MachineBasicBlock*, MachineBasicBlock*) {}
  53
  54   void addNodeToList(MachineBasicBlock* MBB);
  55   void removeNodeFromList(MachineBasicBlock* MBB);
  56   void deleteNode(MachineBasicBlock *MBB);
  57 private:
  58   void createNode(const MachineBasicBlock &);
  59 };
  60
  61 /// MachineFunctionInfo - This class can be derived from and used by targets to
  62 /// hold private target-specific information for each MachineFunction.  Objects
  63 /// of type are accessed/created with MF::getInfo and destroyed when the
  64 /// MachineFunction is destroyed.
  65 struct MachineFunctionInfo {
  66   virtual ~MachineFunctionInfo() {}
  67 };
  68
  69 class MachineFunction : private Annotation {
  70   const Function *Fn;
  71   const TargetMachine &Target;
  72
  73   // RegInfo - Information about each register in use in the function.
  74   MachineRegisterInfo *RegInfo;
  75
  76   // Used to keep track of target-specific per-machine function information for
  77   // the target implementation.
  78   MachineFunctionInfo *MFInfo;
  79
  80   // Keep track of objects allocated on the stack.
  81   MachineFrameInfo *FrameInfo;
  82
  83   // Keep track of constants which are spilled to memory
  84   MachineConstantPool *ConstantPool;
  85
  86   // Keep track of jump tables for switch instructions
  87   MachineJumpTableInfo *JumpTableInfo;
  88
  89   // Function-level unique numbering for MachineBasicBlocks.  When a
  90   // MachineBasicBlock is inserted into a MachineFunction is it automatically
  91   // numbered and this vector keeps track of the mapping from ID's to MBB's.
  92   std::vector<MachineBasicBlock*> MBBNumbering;
  93
  94   // Pool-allocate MachineFunction-lifetime and IR objects.
  95   BumpPtrAllocator Allocator;
  96
  97   // Allocation management for instructions in function.
  98   Recycler<MachineInstr> InstructionRecycler;
  99
 100   // Allocation management for basic blocks in function.
 101   Recycler<MachineBasicBlock> BasicBlockRecycler;
 102
 103   // List of machine basic blocks in function
 104   typedef ilist<MachineBasicBlock> BasicBlockListType;
 105   BasicBlockListType BasicBlocks;
 106
 107   // Default debug location. Used to print out the debug label at the beginning
 108   // of a function.
 109   DebugLoc DefaultDebugLoc;
 110
 111   // Tracks debug locations.
 112   DebugLocTracker DebugLocInfo;
 113
 114 public:
 115   MachineFunction(const Function *Fn, const TargetMachine &TM);
 116   ~MachineFunction();
 117
 118   /// getFunction - Return the LLVM function that this machine code represents
 119   ///
 120   const Function *getFunction() const { return Fn; }
 121
 122   /// getTarget - Return the target machine this machine code is compiled with
 123   ///
 124   const TargetMachine &getTarget() const { return Target; }
 125
 126   /// getRegInfo - Return information about the registers currently in use.
 127   ///
 128   MachineRegisterInfo &getRegInfo() { return *RegInfo; }
 129   const MachineRegisterInfo &getRegInfo() const { return *RegInfo; }
 130
 131   /// getFrameInfo - Return the frame info object for the current function.
 132   /// This object contains information about objects allocated on the stack
 133   /// frame of the current function in an abstract way.
 134   ///
 135   MachineFrameInfo *getFrameInfo() { return FrameInfo; }
 136   const MachineFrameInfo *getFrameInfo() const { return FrameInfo; }
 137
 138   /// getJumpTableInfo - Return the jump table info object for the current
 139   /// function.  This object contains information about jump tables for switch
 140   /// instructions in the current function.
 141   ///
 142   MachineJumpTableInfo *getJumpTableInfo() { return JumpTableInfo; }
 143   const MachineJumpTableInfo *getJumpTableInfo() const { return JumpTableInfo; }
 144
 145   /// getConstantPool - Return the constant pool object for the current
 146   /// function.
 147   ///
 148   MachineConstantPool *getConstantPool() { return ConstantPool; }
 149   const MachineConstantPool *getConstantPool() const { return ConstantPool; }
 150
 151   /// MachineFunctionInfo - Keep track of various per-function pieces of
 152   /// information for backends that would like to do so.
 153   ///
 154   template<typename Ty>
 155   Ty *getInfo() {
 156     if (!MFInfo) {
 157         // This should be just `new (Allocator.Allocate<Ty>()) Ty(*this)', but
 158         // that apparently breaks GCC 3.3.
 159         Ty *Loc = static_cast<Ty*>(Allocator.Allocate(sizeof(Ty),
 160                                                       AlignOf<Ty>::Alignment));
 161         MFInfo = new (Loc) Ty(*this);
 162     }
 163
 164     assert((void*)dynamic_cast<Ty*>(MFInfo) == (void*)MFInfo &&
 165            "Invalid concrete type or multiple inheritence for getInfo");
 166     return static_cast<Ty*>(MFInfo);
 167   }
 168
 169   template<typename Ty>
 170   const Ty *getInfo() const {
 171      return const_cast<MachineFunction*>(this)->getInfo<Ty>();
 172   }
 173
 174   /// getBlockNumbered - MachineBasicBlocks are automatically numbered when they
 175   /// are inserted into the machine function.  The block number for a machine
 176   /// basic block can be found by using the MBB::getBlockNumber method, this
 177   /// method provides the inverse mapping.
 178   ///
 179   MachineBasicBlock *getBlockNumbered(unsigned N) const {
 180     assert(N < MBBNumbering.size() && "Illegal block number");
 181     assert(MBBNumbering[N] && "Block was removed from the machine function!");
 182     return MBBNumbering[N];
 183   }
 184
 185   /// getNumBlockIDs - Return the number of MBB ID's allocated.
 186   ///
 187   unsigned getNumBlockIDs() const { return (unsigned)MBBNumbering.size(); }
 188
 189   /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
 190   /// recomputes them.  This guarantees that the MBB numbers are sequential,
 191   /// dense, and match the ordering of the blocks within the function.  If a
 192   /// specific MachineBasicBlock is specified, only that block and those after
 193   /// it are renumbered.
 194   void RenumberBlocks(MachineBasicBlock *MBBFrom = 0);
 195
 196   /// print - Print out the MachineFunction in a format suitable for debugging
 197   /// to the specified stream.
 198   ///
 199   void print(std::ostream &OS) const;
 200   void print(std::ostream *OS) const { if (OS) print(*OS); }
 201
 202   /// viewCFG - This function is meant for use from the debugger.  You can just
 203   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 204   /// program, displaying the CFG of the current function with the code for each
 205   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 206   /// in your path.
 207   ///
 208   void viewCFG() const;
 209
 210   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 211   /// just like viewCFG, but it does not include the contents of basic blocks
 212   /// into the nodes, just the label.  If you are only interested in the CFG
 213   /// this can make the graph smaller.
 214   ///
 215   void viewCFGOnly() const;
 216
 217   /// dump - Print the current MachineFunction to cerr, useful for debugger use.
 218   ///
 219   void dump() const;
 220
 221   /// construct - Allocate and initialize a MachineFunction for a given Function
 222   /// and Target
 223   ///
 224   static MachineFunction& construct(const Function *F, const TargetMachine &TM);
 225
 226   /// destruct - Destroy the MachineFunction corresponding to a given Function
 227   ///
 228   static void destruct(const Function *F);
 229
 230   /// get - Return a handle to a MachineFunction corresponding to the given
 231   /// Function.  This should not be called before "construct()" for a given
 232   /// Function.
 233   ///
 234   static MachineFunction& get(const Function *F);
 235
 236   // Provide accessors for the MachineBasicBlock list...
 237   typedef BasicBlockListType::iterator iterator;
 238   typedef BasicBlockListType::const_iterator const_iterator;
 239   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 240   typedef std::reverse_iterator<iterator>             reverse_iterator;
 241
 242   /// addLiveIn - Add the specified physical register as a live-in value and
 243   /// create a corresponding virtual register for it.
 244   unsigned addLiveIn(unsigned PReg, const TargetRegisterClass *RC);
 245
 246   //===--------------------------------------------------------------------===//
 247   // BasicBlock accessor functions.
 248   //
 249   iterator                 begin()       { return BasicBlocks.begin(); }
 250   const_iterator           begin() const { return BasicBlocks.begin(); }
 251   iterator                 end  ()       { return BasicBlocks.end();   }
 252   const_iterator           end  () const { return BasicBlocks.end();   }
 253
 254   reverse_iterator        rbegin()       { return BasicBlocks.rbegin(); }
 255   const_reverse_iterator  rbegin() const { return BasicBlocks.rbegin(); }
 256   reverse_iterator        rend  ()       { return BasicBlocks.rend();   }
 257   const_reverse_iterator  rend  () const { return BasicBlocks.rend();   }
 258
 259   unsigned                  size() const { return (unsigned)BasicBlocks.size();}
 260   bool                     empty() const { return BasicBlocks.empty(); }
 261   const MachineBasicBlock &front() const { return BasicBlocks.front(); }
 262         MachineBasicBlock &front()       { return BasicBlocks.front(); }
 263   const MachineBasicBlock & back() const { return BasicBlocks.back(); }
 264         MachineBasicBlock & back()       { return BasicBlocks.back(); }
 265
 266   void push_back (MachineBasicBlock *MBB) { BasicBlocks.push_back (MBB); }
 267   void push_front(MachineBasicBlock *MBB) { BasicBlocks.push_front(MBB); }
 268   void insert(iterator MBBI, MachineBasicBlock *MBB) {
 269     BasicBlocks.insert(MBBI, MBB);
 270   }
 271   void splice(iterator InsertPt, iterator MBBI) {
 272     BasicBlocks.splice(InsertPt, BasicBlocks, MBBI);
 273   }
 274
 275   void remove(iterator MBBI) {
 276     BasicBlocks.remove(MBBI);
 277   }
 278   void erase(iterator MBBI) {
 279     BasicBlocks.erase(MBBI);
 280   }
 281
 282   //===--------------------------------------------------------------------===//
 283   // Internal functions used to automatically number MachineBasicBlocks
 284   //
 285
 286   /// getNextMBBNumber - Returns the next unique number to be assigned
 287   /// to a MachineBasicBlock in this MachineFunction.
 288   ///
 289   unsigned addToMBBNumbering(MachineBasicBlock *MBB) {
 290     MBBNumbering.push_back(MBB);
 291     return (unsigned)MBBNumbering.size()-1;
 292   }
 293
 294   /// removeFromMBBNumbering - Remove the specific machine basic block from our
 295   /// tracker, this is only really to be used by the MachineBasicBlock
 296   /// implementation.
 297   void removeFromMBBNumbering(unsigned N) {
 298     assert(N < MBBNumbering.size() && "Illegal basic block #");
 299     MBBNumbering[N] = 0;
 300   }
 301
 302   /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
 303   /// of `new MachineInstr'.
 304   ///
 305   MachineInstr *CreateMachineInstr(const TargetInstrDesc &TID,
 306                                    DebugLoc DL,
 307                                    bool NoImp = false);
 308
 309   /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
 310   /// 'Orig' instruction, identical in all ways except the the instruction
 311   /// has no parent, prev, or next.
 312   ///
 313   MachineInstr *CloneMachineInstr(const MachineInstr *Orig);
 314
 315   /// DeleteMachineInstr - Delete the given MachineInstr.
 316   ///
 317   void DeleteMachineInstr(MachineInstr *MI);
 318
 319   /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
 320   /// instead of `new MachineBasicBlock'.
 321   ///
 322   MachineBasicBlock *CreateMachineBasicBlock(const BasicBlock *bb = 0);
 323
 324   /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
 325   ///
 326   void DeleteMachineBasicBlock(MachineBasicBlock *MBB);
 327
 328   //===--------------------------------------------------------------------===//
 329   // Debug location.
 330   //
 331
 332   /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
 333   /// source file, line, and column. If none currently exists, create a new
 334   /// DebugLocTuple, and insert it into the DebugIdMap.
 335   unsigned getOrCreateDebugLocID(GlobalVariable *CompileUnit,
 336                                  unsigned Line, unsigned Col);
 337
 338   /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
 339   DebugLocTuple getDebugLocTuple(DebugLoc DL) const;
 340
 341   /// getDefaultDebugLoc - Get the default debug location for the machine
 342   /// function.
 343   DebugLoc getDefaultDebugLoc() const { return DefaultDebugLoc; }
 344
 345   /// setDefaultDebugLoc - Get the default debug location for the machine
 346   /// function.
 347   void setDefaultDebugLoc(DebugLoc DL) { DefaultDebugLoc = DL; }
 348 };
 349
 350 //===--------------------------------------------------------------------===//
 351 // GraphTraits specializations for function basic block graphs (CFGs)
 352 //===--------------------------------------------------------------------===//
 353
 354 // Provide specializations of GraphTraits to be able to treat a
 355 // machine function as a graph of machine basic blocks... these are
 356 // the same as the machine basic block iterators, except that the root
 357 // node is implicitly the first node of the function.
 358 //
 359 template <> struct GraphTraits<MachineFunction*> :
 360   public GraphTraits<MachineBasicBlock*> {
 361   static NodeType *getEntryNode(MachineFunction *F) {
 362     return &F->front();
 363   }
 364
 365   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 366   typedef MachineFunction::iterator nodes_iterator;
 367   static nodes_iterator nodes_begin(MachineFunction *F) { return F->begin(); }
 368   static nodes_iterator nodes_end  (MachineFunction *F) { return F->end(); }
 369 };
 370 template <> struct GraphTraits<const MachineFunction*> :
 371   public GraphTraits<const MachineBasicBlock*> {
 372   static NodeType *getEntryNode(const MachineFunction *F) {
 373     return &F->front();
 374   }
 375
 376   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 377   typedef MachineFunction::const_iterator nodes_iterator;
 378   static nodes_iterator nodes_begin(const MachineFunction *F) {
 379     return F->begin();
 380   }
 381   static nodes_iterator nodes_end  (const MachineFunction *F) {
 382     return F->end();
 383   }
 384 };
 385
 386
 387 // Provide specializations of GraphTraits to be able to treat a function as a
 388 // graph of basic blocks... and to walk it in inverse order.  Inverse order for
 389 // a function is considered to be when traversing the predecessor edges of a BB
 390 // instead of the successor edges.
 391 //
 392 template <> struct GraphTraits<Inverse<MachineFunction*> > :
 393   public GraphTraits<Inverse<MachineBasicBlock*> > {
 394   static NodeType *getEntryNode(Inverse<MachineFunction*> G) {
 395     return &G.Graph->front();
 396   }
 397 };
 398 template <> struct GraphTraits<Inverse<const MachineFunction*> > :
 399   public GraphTraits<Inverse<const MachineBasicBlock*> > {
 400   static NodeType *getEntryNode(Inverse<const MachineFunction *> G) {
 401     return &G.Graph->front();
 402   }
 403 };
 404
 405 } // End llvm namespace
 406
 407 #endif