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/CodeGen/MachineBasicBlock.h"
  22 #include "llvm/ADT/ilist.h"
  23 #include "llvm/Support/DebugLoc.h"
  24 #include "llvm/Support/Allocator.h"
  25 #include "llvm/Support/Recycler.h"
  26 #include <map>
  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 {
  70   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   // The alignment of the function.
 115   unsigned Alignment;
 116
 117 public:
 118   MachineFunction(Function *Fn, const TargetMachine &TM);
 119   ~MachineFunction();
 120
 121   /// getFunction - Return the LLVM function that this machine code represents
 122   ///
 123   Function *getFunction() const { return Fn; }
 124
 125   /// getTarget - Return the target machine this machine code is compiled with
 126   ///
 127   const TargetMachine &getTarget() const { return Target; }
 128
 129   /// getRegInfo - Return information about the registers currently in use.
 130   ///
 131   MachineRegisterInfo &getRegInfo() { return *RegInfo; }
 132   const MachineRegisterInfo &getRegInfo() const { return *RegInfo; }
 133
 134   /// getFrameInfo - Return the frame info object for the current function.
 135   /// This object contains information about objects allocated on the stack
 136   /// frame of the current function in an abstract way.
 137   ///
 138   MachineFrameInfo *getFrameInfo() { return FrameInfo; }
 139   const MachineFrameInfo *getFrameInfo() const { return FrameInfo; }
 140
 141   /// getJumpTableInfo - Return the jump table info object for the current
 142   /// function.  This object contains information about jump tables for switch
 143   /// instructions in the current function.
 144   ///
 145   MachineJumpTableInfo *getJumpTableInfo() { return JumpTableInfo; }
 146   const MachineJumpTableInfo *getJumpTableInfo() const { return JumpTableInfo; }
 147
 148   /// getConstantPool - Return the constant pool object for the current
 149   /// function.
 150   ///
 151   MachineConstantPool *getConstantPool() { return ConstantPool; }
 152   const MachineConstantPool *getConstantPool() const { return ConstantPool; }
 153
 154   /// getAlignment - Return the alignment (log2, not bytes) of the function.
 155   ///
 156   unsigned getAlignment() const { return Alignment; }
 157
 158   /// setAlignment - Set the alignment (log2, not bytes) of the function.
 159   ///
 160   void setAlignment(unsigned A) { Alignment = A; }
 161
 162   /// MachineFunctionInfo - Keep track of various per-function pieces of
 163   /// information for backends that would like to do so.
 164   ///
 165   template<typename Ty>
 166   Ty *getInfo() {
 167     if (!MFInfo) {
 168         // This should be just `new (Allocator.Allocate<Ty>()) Ty(*this)', but
 169         // that apparently breaks GCC 3.3.
 170         Ty *Loc = static_cast<Ty*>(Allocator.Allocate(sizeof(Ty),
 171                                                       AlignOf<Ty>::Alignment));
 172         MFInfo = new (Loc) Ty(*this);
 173     }
 174
 175     assert((void*)dynamic_cast<Ty*>(MFInfo) == (void*)MFInfo &&
 176            "Invalid concrete type or multiple inheritence for getInfo");
 177     return static_cast<Ty*>(MFInfo);
 178   }
 179
 180   template<typename Ty>
 181   const Ty *getInfo() const {
 182      return const_cast<MachineFunction*>(this)->getInfo<Ty>();
 183   }
 184
 185   /// getBlockNumbered - MachineBasicBlocks are automatically numbered when they
 186   /// are inserted into the machine function.  The block number for a machine
 187   /// basic block can be found by using the MBB::getBlockNumber method, this
 188   /// method provides the inverse mapping.
 189   ///
 190   MachineBasicBlock *getBlockNumbered(unsigned N) const {
 191     assert(N < MBBNumbering.size() && "Illegal block number");
 192     assert(MBBNumbering[N] && "Block was removed from the machine function!");
 193     return MBBNumbering[N];
 194   }
 195
 196   /// getNumBlockIDs - Return the number of MBB ID's allocated.
 197   ///
 198   unsigned getNumBlockIDs() const { return (unsigned)MBBNumbering.size(); }
 199
 200   /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
 201   /// recomputes them.  This guarantees that the MBB numbers are sequential,
 202   /// dense, and match the ordering of the blocks within the function.  If a
 203   /// specific MachineBasicBlock is specified, only that block and those after
 204   /// it are renumbered.
 205   void RenumberBlocks(MachineBasicBlock *MBBFrom = 0);
 206
 207   /// print - Print out the MachineFunction in a format suitable for debugging
 208   /// to the specified stream.
 209   ///
 210   void print(raw_ostream &OS) const;
 211
 212   /// viewCFG - This function is meant for use from the debugger.  You can just
 213   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 214   /// program, displaying the CFG of the current function with the code for each
 215   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 216   /// in your path.
 217   ///
 218   void viewCFG() const;
 219
 220   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 221   /// just like viewCFG, but it does not include the contents of basic blocks
 222   /// into the nodes, just the label.  If you are only interested in the CFG
 223   /// this can make the graph smaller.
 224   ///
 225   void viewCFGOnly() const;
 226
 227   /// dump - Print the current MachineFunction to cerr, useful for debugger use.
 228   ///
 229   void dump() const;
 230
 231   // Provide accessors for the MachineBasicBlock list...
 232   typedef BasicBlockListType::iterator iterator;
 233   typedef BasicBlockListType::const_iterator const_iterator;
 234   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 235   typedef std::reverse_iterator<iterator>             reverse_iterator;
 236
 237   /// addLiveIn - Add the specified physical register as a live-in value and
 238   /// create a corresponding virtual register for it.
 239   unsigned addLiveIn(unsigned PReg, const TargetRegisterClass *RC);
 240
 241   //===--------------------------------------------------------------------===//
 242   // BasicBlock accessor functions.
 243   //
 244   iterator                 begin()       { return BasicBlocks.begin(); }
 245   const_iterator           begin() const { return BasicBlocks.begin(); }
 246   iterator                 end  ()       { return BasicBlocks.end();   }
 247   const_iterator           end  () const { return BasicBlocks.end();   }
 248
 249   reverse_iterator        rbegin()       { return BasicBlocks.rbegin(); }
 250   const_reverse_iterator  rbegin() const { return BasicBlocks.rbegin(); }
 251   reverse_iterator        rend  ()       { return BasicBlocks.rend();   }
 252   const_reverse_iterator  rend  () const { return BasicBlocks.rend();   }
 253
 254   unsigned                  size() const { return (unsigned)BasicBlocks.size();}
 255   bool                     empty() const { return BasicBlocks.empty(); }
 256   const MachineBasicBlock &front() const { return BasicBlocks.front(); }
 257         MachineBasicBlock &front()       { return BasicBlocks.front(); }
 258   const MachineBasicBlock & back() const { return BasicBlocks.back(); }
 259         MachineBasicBlock & back()       { return BasicBlocks.back(); }
 260
 261   void push_back (MachineBasicBlock *MBB) { BasicBlocks.push_back (MBB); }
 262   void push_front(MachineBasicBlock *MBB) { BasicBlocks.push_front(MBB); }
 263   void insert(iterator MBBI, MachineBasicBlock *MBB) {
 264     BasicBlocks.insert(MBBI, MBB);
 265   }
 266   void splice(iterator InsertPt, iterator MBBI) {
 267     BasicBlocks.splice(InsertPt, BasicBlocks, MBBI);
 268   }
 269
 270   void remove(iterator MBBI) {
 271     BasicBlocks.remove(MBBI);
 272   }
 273   void erase(iterator MBBI) {
 274     BasicBlocks.erase(MBBI);
 275   }
 276
 277   //===--------------------------------------------------------------------===//
 278   // Internal functions used to automatically number MachineBasicBlocks
 279   //
 280
 281   /// getNextMBBNumber - Returns the next unique number to be assigned
 282   /// to a MachineBasicBlock in this MachineFunction.
 283   ///
 284   unsigned addToMBBNumbering(MachineBasicBlock *MBB) {
 285     MBBNumbering.push_back(MBB);
 286     return (unsigned)MBBNumbering.size()-1;
 287   }
 288
 289   /// removeFromMBBNumbering - Remove the specific machine basic block from our
 290   /// tracker, this is only really to be used by the MachineBasicBlock
 291   /// implementation.
 292   void removeFromMBBNumbering(unsigned N) {
 293     assert(N < MBBNumbering.size() && "Illegal basic block #");
 294     MBBNumbering[N] = 0;
 295   }
 296
 297   /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
 298   /// of `new MachineInstr'.
 299   ///
 300   MachineInstr *CreateMachineInstr(const TargetInstrDesc &TID,
 301                                    DebugLoc DL,
 302                                    bool NoImp = false);
 303
 304   /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
 305   /// 'Orig' instruction, identical in all ways except the the instruction
 306   /// has no parent, prev, or next.
 307   ///
 308   MachineInstr *CloneMachineInstr(const MachineInstr *Orig);
 309
 310   /// DeleteMachineInstr - Delete the given MachineInstr.
 311   ///
 312   void DeleteMachineInstr(MachineInstr *MI);
 313
 314   /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
 315   /// instead of `new MachineBasicBlock'.
 316   ///
 317   MachineBasicBlock *CreateMachineBasicBlock(const BasicBlock *bb = 0);
 318
 319   /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
 320   ///
 321   void DeleteMachineBasicBlock(MachineBasicBlock *MBB);
 322
 323   //===--------------------------------------------------------------------===//
 324   // Debug location.
 325   //
 326
 327   /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
 328   /// source file, line, and column. If none currently exists, create a new
 329   /// DebugLocTuple, and insert it into the DebugIdMap.
 330   unsigned getOrCreateDebugLocID(GlobalVariable *CompileUnit,
 331                                  unsigned Line, unsigned Col);
 332
 333   /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
 334   DebugLocTuple getDebugLocTuple(DebugLoc DL) const;
 335
 336   /// getDefaultDebugLoc - Get the default debug location for the machine
 337   /// function.
 338   DebugLoc getDefaultDebugLoc() const { return DefaultDebugLoc; }
 339
 340   /// setDefaultDebugLoc - Get the default debug location for the machine
 341   /// function.
 342   void setDefaultDebugLoc(DebugLoc DL) { DefaultDebugLoc = DL; }
 343
 344   /// getDebugLocInfo - Get the debug info location tracker.
 345   DebugLocTracker &getDebugLocInfo() { return DebugLocInfo; }
 346 };
 347
 348 //===--------------------------------------------------------------------===//
 349 // GraphTraits specializations for function basic block graphs (CFGs)
 350 //===--------------------------------------------------------------------===//
 351
 352 // Provide specializations of GraphTraits to be able to treat a
 353 // machine function as a graph of machine basic blocks... these are
 354 // the same as the machine basic block iterators, except that the root
 355 // node is implicitly the first node of the function.
 356 //
 357 template <> struct GraphTraits<MachineFunction*> :
 358   public GraphTraits<MachineBasicBlock*> {
 359   static NodeType *getEntryNode(MachineFunction *F) {
 360     return &F->front();
 361   }
 362
 363   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 364   typedef MachineFunction::iterator nodes_iterator;
 365   static nodes_iterator nodes_begin(MachineFunction *F) { return F->begin(); }
 366   static nodes_iterator nodes_end  (MachineFunction *F) { return F->end(); }
 367 };
 368 template <> struct GraphTraits<const MachineFunction*> :
 369   public GraphTraits<const MachineBasicBlock*> {
 370   static NodeType *getEntryNode(const MachineFunction *F) {
 371     return &F->front();
 372   }
 373
 374   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 375   typedef MachineFunction::const_iterator nodes_iterator;
 376   static nodes_iterator nodes_begin(const MachineFunction *F) {
 377     return F->begin();
 378   }
 379   static nodes_iterator nodes_end  (const MachineFunction *F) {
 380     return F->end();
 381   }
 382 };
 383
 384
 385 // Provide specializations of GraphTraits to be able to treat a function as a
 386 // graph of basic blocks... and to walk it in inverse order.  Inverse order for
 387 // a function is considered to be when traversing the predecessor edges of a BB
 388 // instead of the successor edges.
 389 //
 390 template <> struct GraphTraits<Inverse<MachineFunction*> > :
 391   public GraphTraits<Inverse<MachineBasicBlock*> > {
 392   static NodeType *getEntryNode(Inverse<MachineFunction*> G) {
 393     return &G.Graph->front();
 394   }
 395 };
 396 template <> struct GraphTraits<Inverse<const MachineFunction*> > :
 397   public GraphTraits<Inverse<const MachineBasicBlock*> > {
 398   static NodeType *getEntryNode(Inverse<const MachineFunction *> G) {
 399     return &G.Graph->front();
 400   }
 401 };
 402
 403 } // End llvm namespace
 404
 405 #endif