include/llvm/CodeGen/MachineFunction.h

   1 //===-- llvm/CodeGen/MachineFunction.h --------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/Support/Annotation.h"
  23
  24 namespace llvm {
  25
  26 class Function;
  27 class TargetMachine;
  28 class SSARegMap;
  29 class MachineFrameInfo;
  30 class MachineConstantPool;
  31
  32 // ilist_traits
  33 template <>
  34 struct ilist_traits<MachineBasicBlock> {
  35   // this is only set by the MachineFunction owning the ilist
  36   friend class MachineFunction;
  37   MachineFunction* Parent;
  38
  39 public:
  40   ilist_traits<MachineBasicBlock>() : Parent(0) { }
  41
  42   static MachineBasicBlock* getPrev(MachineBasicBlock* N) { return N->Prev; }
  43   static MachineBasicBlock* getNext(MachineBasicBlock* N) { return N->Next; }
  44
  45   static const MachineBasicBlock*
  46   getPrev(const MachineBasicBlock* N) { return N->Prev; }
  47
  48   static const MachineBasicBlock*
  49   getNext(const MachineBasicBlock* N) { return N->Next; }
  50
  51   static void setPrev(MachineBasicBlock* N, MachineBasicBlock* prev) {
  52     N->Prev = prev;
  53   }
  54   static void setNext(MachineBasicBlock* N, MachineBasicBlock* next) {
  55     N->Next = next;
  56   }
  57
  58   static MachineBasicBlock* createSentinel();
  59   static void destroySentinel(MachineBasicBlock *MBB) { delete MBB; }
  60   void addNodeToList(MachineBasicBlock* N);
  61   void removeNodeFromList(MachineBasicBlock* N);
  62   void transferNodesFromList(iplist<MachineBasicBlock,
  63                                     ilist_traits<MachineBasicBlock> > &toList,
  64                              ilist_iterator<MachineBasicBlock> first,
  65                              ilist_iterator<MachineBasicBlock> last);
  66 };
  67
  68 /// MachineFunctionInfo - This class can be derived from and used by targets to
  69 /// hold private target-specific information for each MachineFunction.  Objects
  70 /// of type are accessed/created with MF::getInfo and destroyed when the
  71 /// MachineFunction is destroyed.
  72 struct MachineFunctionInfo {
  73   virtual ~MachineFunctionInfo() {};
  74 };
  75
  76 class MachineFunction : private Annotation {
  77   const Function *Fn;
  78   const TargetMachine &Target;
  79
  80   // List of machine basic blocks in function
  81   ilist<MachineBasicBlock> BasicBlocks;
  82
  83   // Keeping track of mapping from SSA values to registers
  84   SSARegMap *SSARegMapping;
  85
  86   // Used to keep track of target-specific per-machine function information for
  87   // the target implementation.
  88   MachineFunctionInfo *MFInfo;
  89
  90   // Keep track of objects allocated on the stack.
  91   MachineFrameInfo *FrameInfo;
  92
  93   // Keep track of constants which are spilled to memory
  94   MachineConstantPool *ConstantPool;
  95
  96   // Function-level unique numbering for MachineBasicBlocks.  When a
  97   // MachineBasicBlock is inserted into a MachineFunction is it automatically
  98   // numbered and this vector keeps track of the mapping from ID's to MBB's.
  99   std::vector<MachineBasicBlock*> MBBNumbering;
 100
 101   /// UsedPhysRegs - This is a new[]'d array of bools that is computed and set
 102   /// by the register allocator, and must be kept up to date by passes that run
 103   /// after register allocation (though most don't modify this).  This is used
 104   /// so that the code generator knows which callee save registers to save and
 105   /// for other target specific uses.
 106   bool *UsedPhysRegs;
 107
 108 public:
 109   MachineFunction(const Function *Fn, const TargetMachine &TM);
 110   ~MachineFunction();
 111
 112   /// getFunction - Return the LLVM function that this machine code represents
 113   ///
 114   const Function *getFunction() const { return Fn; }
 115
 116   /// getTarget - Return the target machine this machine code is compiled with
 117   ///
 118   const TargetMachine &getTarget() const { return Target; }
 119
 120   /// SSARegMap Interface... Keep track of information about each SSA virtual
 121   /// register, such as which register class it belongs to.
 122   ///
 123   SSARegMap *getSSARegMap() const { return SSARegMapping; }
 124   void clearSSARegMap();
 125
 126   /// getFrameInfo - Return the frame info object for the current function.
 127   /// This object contains information about objects allocated on the stack
 128   /// frame of the current function in an abstract way.
 129   ///
 130   MachineFrameInfo *getFrameInfo() const { return FrameInfo; }
 131
 132   /// getConstantPool - Return the constant pool object for the current
 133   /// function.
 134   ///
 135   MachineConstantPool *getConstantPool() const { return ConstantPool; }
 136
 137   /// MachineFunctionInfo - Keep track of various per-function pieces of
 138   /// information for the sparc backend.
 139   ///
 140   template<typename Ty>
 141   Ty *getInfo() {
 142     if (!MFInfo) MFInfo = new Ty(*this);
 143
 144     assert((void*)dynamic_cast<Ty*>(MFInfo) == (void*)MFInfo &&
 145            "Invalid concrete type or multiple inheritence for getInfo");
 146     return static_cast<Ty*>(MFInfo);
 147   }
 148
 149   /// setUsedPhysRegs - The register allocator should call this to initialized
 150   /// the UsedPhysRegs set.  This should be passed a new[]'d array with entries
 151   /// for all of the physical registers that the target supports.  Each array
 152   /// entry should be set to true iff the physical register is used within the
 153   /// function.
 154   void setUsedPhysRegs(bool *UPR) { UsedPhysRegs = UPR; }
 155
 156   /// getUsedPhysregs - This returns the UsedPhysRegs array.  This returns null
 157   /// before register allocation.
 158   bool *getUsedPhysregs() { return UsedPhysRegs; }
 159   const bool *getUsedPhysregs() const { return UsedPhysRegs; }
 160
 161   /// isPhysRegUsed - Return true if the specified register is used in this
 162   /// function.  This only works after register allocation.
 163   bool isPhysRegUsed(unsigned Reg) { return UsedPhysRegs[Reg]; }
 164
 165   /// changePhyRegUsed - This method allows code that runs after register
 166   /// allocation to keep the PhysRegsUsed array up-to-date.
 167   void changePhyRegUsed(unsigned Reg, bool State) { UsedPhysRegs[Reg] = State; }
 168
 169   /// getBlockNumbered - MachineBasicBlocks are automatically numbered when they
 170   /// are inserted into the machine function.  The block number for a machine
 171   /// basic block can be found by using the MBB::getBlockNumber method, this
 172   /// method provides the inverse mapping.
 173   ///
 174   MachineBasicBlock *getBlockNumbered(unsigned N) {
 175     assert(N < MBBNumbering.size() && "Illegal block number");
 176     assert(MBBNumbering[N] && "Block was removed from the machine function!");
 177     return MBBNumbering[N];
 178   }
 179
 180   /// getLastBlock - Returns the MachineBasicBlock with the greatest number
 181   MachineBasicBlock *getLastBlock() {
 182     return MBBNumbering.back();
 183   }
 184   const MachineBasicBlock *getLastBlock() const {
 185     return MBBNumbering.back();
 186   }
 187
 188   /// print - Print out the MachineFunction in a format suitable for debugging
 189   /// to the specified stream.
 190   ///
 191   void print(std::ostream &OS) const;
 192
 193   /// viewCFG - This function is meant for use from the debugger.  You can just
 194   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 195   /// program, displaying the CFG of the current function with the code for each
 196   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 197   /// in your path.
 198   ///
 199   void viewCFG() const;
 200
 201   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 202   /// just like viewCFG, but it does not include the contents of basic blocks
 203   /// into the nodes, just the label.  If you are only interested in the CFG
 204   /// this can make the graph smaller.
 205   ///
 206   void viewCFGOnly() const;
 207
 208   /// dump - Print the current MachineFunction to cerr, useful for debugger use.
 209   ///
 210   void dump() const;
 211
 212   /// construct - Allocate and initialize a MachineFunction for a given Function
 213   /// and Target
 214   ///
 215   static MachineFunction& construct(const Function *F, const TargetMachine &TM);
 216
 217   /// destruct - Destroy the MachineFunction corresponding to a given Function
 218   ///
 219   static void destruct(const Function *F);
 220
 221   /// get - Return a handle to a MachineFunction corresponding to the given
 222   /// Function.  This should not be called before "construct()" for a given
 223   /// Function.
 224   ///
 225   static MachineFunction& get(const Function *F);
 226
 227   // Provide accessors for the MachineBasicBlock list...
 228   typedef ilist<MachineBasicBlock> BasicBlockListType;
 229   typedef BasicBlockListType::iterator iterator;
 230   typedef BasicBlockListType::const_iterator const_iterator;
 231   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 232   typedef std::reverse_iterator<iterator>             reverse_iterator;
 233
 234   // Provide accessors for basic blocks...
 235   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 236         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 237
 238   //===--------------------------------------------------------------------===//
 239   // BasicBlock iterator forwarding functions
 240   //
 241   iterator                 begin()       { return BasicBlocks.begin(); }
 242   const_iterator           begin() const { return BasicBlocks.begin(); }
 243   iterator                 end  ()       { return BasicBlocks.end();   }
 244   const_iterator           end  () const { return BasicBlocks.end();   }
 245
 246   reverse_iterator        rbegin()       { return BasicBlocks.rbegin(); }
 247   const_reverse_iterator  rbegin() const { return BasicBlocks.rbegin(); }
 248   reverse_iterator        rend  ()       { return BasicBlocks.rend();   }
 249   const_reverse_iterator  rend  () const { return BasicBlocks.rend();   }
 250
 251   unsigned                  size() const { return BasicBlocks.size(); }
 252   bool                     empty() const { return BasicBlocks.empty(); }
 253   const MachineBasicBlock &front() const { return BasicBlocks.front(); }
 254         MachineBasicBlock &front()       { return BasicBlocks.front(); }
 255   const MachineBasicBlock & back() const { return BasicBlocks.back(); }
 256         MachineBasicBlock & back()       { return BasicBlocks.back(); }
 257
 258   //===--------------------------------------------------------------------===//
 259   // Internal functions used to automatically number MachineBasicBlocks
 260   //
 261
 262   /// getNextMBBNumber - Returns the next unique number to be assigned
 263   /// to a MachineBasicBlock in this MachineFunction.
 264   ///
 265   unsigned addToMBBNumbering(MachineBasicBlock *MBB) {
 266     MBBNumbering.push_back(MBB);
 267     return MBBNumbering.size()-1;
 268   }
 269
 270   /// removeFromMBBNumbering - Remove the specific machine basic block from our
 271   /// tracker, this is only really to be used by the MachineBasicBlock
 272   /// implementation.
 273   void removeFromMBBNumbering(unsigned N) {
 274     assert(N < MBBNumbering.size() && "Illegal basic block #");
 275     MBBNumbering[N] = 0;
 276   }
 277 };
 278
 279 //===--------------------------------------------------------------------===//
 280 // GraphTraits specializations for function basic block graphs (CFGs)
 281 //===--------------------------------------------------------------------===//
 282
 283 // Provide specializations of GraphTraits to be able to treat a
 284 // machine function as a graph of machine basic blocks... these are
 285 // the same as the machine basic block iterators, except that the root
 286 // node is implicitly the first node of the function.
 287 //
 288 template <> struct GraphTraits<MachineFunction*> :
 289   public GraphTraits<MachineBasicBlock*> {
 290   static NodeType *getEntryNode(MachineFunction *F) {
 291     return &F->front();
 292   }
 293
 294   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 295   typedef MachineFunction::iterator nodes_iterator;
 296   static nodes_iterator nodes_begin(MachineFunction *F) { return F->begin(); }
 297   static nodes_iterator nodes_end  (MachineFunction *F) { return F->end(); }
 298 };
 299 template <> struct GraphTraits<const MachineFunction*> :
 300   public GraphTraits<const MachineBasicBlock*> {
 301   static NodeType *getEntryNode(const MachineFunction *F) {
 302     return &F->front();
 303   }
 304
 305   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 306   typedef MachineFunction::const_iterator nodes_iterator;
 307   static nodes_iterator nodes_begin(const MachineFunction *F) { return F->begin(); }
 308   static nodes_iterator nodes_end  (const MachineFunction *F) { return F->end(); }
 309 };
 310
 311
 312 // Provide specializations of GraphTraits to be able to treat a function as a
 313 // graph of basic blocks... and to walk it in inverse order.  Inverse order for
 314 // a function is considered to be when traversing the predecessor edges of a BB
 315 // instead of the successor edges.
 316 //
 317 template <> struct GraphTraits<Inverse<MachineFunction*> > :
 318   public GraphTraits<Inverse<MachineBasicBlock*> > {
 319   static NodeType *getEntryNode(Inverse<MachineFunction*> G) {
 320     return &G.Graph->front();
 321   }
 322 };
 323 template <> struct GraphTraits<Inverse<const MachineFunction*> > :
 324   public GraphTraits<Inverse<const MachineBasicBlock*> > {
 325   static NodeType *getEntryNode(Inverse<const MachineFunction *> G) {
 326     return &G.Graph->front();
 327   }
 328 };
 329
 330 } // End llvm namespace
 331
 332 #endif