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