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