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/MachineBasicBlock.h"
  23 #include "llvm/IR/DebugLoc.h"
  24 #include "llvm/Support/Allocator.h"
  25 #include "llvm/Support/ArrayRecycler.h"
  26 #include "llvm/Support/Recycler.h"
  27
  28 namespace llvm {
  29
  30 class Value;
  31 class Function;
  32 class GCModuleInfo;
  33 class MachineRegisterInfo;
  34 class MachineFrameInfo;
  35 class MachineConstantPool;
  36 class MachineJumpTableInfo;
  37 class MachineModuleInfo;
  38 class MCContext;
  39 class Pass;
  40 class TargetMachine;
  41 class TargetRegisterClass;
  42 struct MachinePointerInfo;
  43
  44 template <>
  45 struct ilist_traits<MachineBasicBlock>
  46     : public ilist_default_traits<MachineBasicBlock> {
  47   mutable ilist_half_node<MachineBasicBlock> Sentinel;
  48 public:
  49   MachineBasicBlock *createSentinel() const {
  50     return static_cast<MachineBasicBlock*>(&Sentinel);
  51   }
  52   void destroySentinel(MachineBasicBlock *) const {}
  53
  54   MachineBasicBlock *provideInitialHead() const { return createSentinel(); }
  55   MachineBasicBlock *ensureHead(MachineBasicBlock*) const {
  56     return createSentinel();
  57   }
  58   static void noteHead(MachineBasicBlock*, MachineBasicBlock*) {}
  59
  60   void addNodeToList(MachineBasicBlock* MBB);
  61   void removeNodeFromList(MachineBasicBlock* MBB);
  62   void deleteNode(MachineBasicBlock *MBB);
  63 private:
  64   void createNode(const MachineBasicBlock &);
  65 };
  66
  67 /// MachineFunctionInfo - This class can be derived from and used by targets to
  68 /// hold private target-specific information for each MachineFunction.  Objects
  69 /// of type are accessed/created with MF::getInfo and destroyed when the
  70 /// MachineFunction is destroyed.
  71 struct MachineFunctionInfo {
  72   virtual ~MachineFunctionInfo();
  73 };
  74
  75 class MachineFunction {
  76   const Function *Fn;
  77   const TargetMachine &Target;
  78   MCContext &Ctx;
  79   MachineModuleInfo &MMI;
  80   GCModuleInfo *GMI;
  81
  82   // RegInfo - Information about each register in use in the function.
  83   MachineRegisterInfo *RegInfo;
  84
  85   // Used to keep track of target-specific per-machine function information for
  86   // the target implementation.
  87   MachineFunctionInfo *MFInfo;
  88
  89   // Keep track of objects allocated on the stack.
  90   MachineFrameInfo *FrameInfo;
  91
  92   // Keep track of constants which are spilled to memory
  93   MachineConstantPool *ConstantPool;
  94
  95   // Keep track of jump tables for switch instructions
  96   MachineJumpTableInfo *JumpTableInfo;
  97
  98   // Function-level unique numbering for MachineBasicBlocks.  When a
  99   // MachineBasicBlock is inserted into a MachineFunction is it automatically
 100   // numbered and this vector keeps track of the mapping from ID's to MBB's.
 101   std::vector<MachineBasicBlock*> MBBNumbering;
 102
 103   // Pool-allocate MachineFunction-lifetime and IR objects.
 104   BumpPtrAllocator Allocator;
 105
 106   // Allocation management for instructions in function.
 107   Recycler<MachineInstr> InstructionRecycler;
 108
 109   // Allocation management for operand arrays on instructions.
 110   ArrayRecycler<MachineOperand> OperandRecycler;
 111
 112   // Allocation management for basic blocks in function.
 113   Recycler<MachineBasicBlock> BasicBlockRecycler;
 114
 115   // List of machine basic blocks in function
 116   typedef ilist<MachineBasicBlock> BasicBlockListType;
 117   BasicBlockListType BasicBlocks;
 118
 119   /// FunctionNumber - This provides a unique ID for each function emitted in
 120   /// this translation unit.
 121   ///
 122   unsigned FunctionNumber;
 123
 124   /// Alignment - The alignment of the function.
 125   unsigned Alignment;
 126
 127   /// ExposesReturnsTwice - True if the function calls setjmp or related
 128   /// functions with attribute "returns twice", but doesn't have
 129   /// the attribute itself.
 130   /// This is used to limit optimizations which cannot reason
 131   /// about the control flow of such functions.
 132   bool ExposesReturnsTwice;
 133
 134   /// True if the function includes any inline assembly.
 135   bool HasInlineAsm;
 136
 137   MachineFunction(const MachineFunction &) LLVM_DELETED_FUNCTION;
 138   void operator=(const MachineFunction&) LLVM_DELETED_FUNCTION;
 139 public:
 140   MachineFunction(const Function *Fn, const TargetMachine &TM,
 141                   unsigned FunctionNum, MachineModuleInfo &MMI,
 142                   GCModuleInfo* GMI);
 143   ~MachineFunction();
 144
 145   MachineModuleInfo &getMMI() const { return MMI; }
 146   GCModuleInfo *getGMI() const { return GMI; }
 147   MCContext &getContext() const { return Ctx; }
 148
 149   /// getFunction - Return the LLVM function that this machine code represents
 150   ///
 151   const Function *getFunction() const { return Fn; }
 152
 153   /// getName - Return the name of the corresponding LLVM function.
 154   ///
 155   StringRef getName() const;
 156
 157   /// getFunctionNumber - Return a unique ID for the current function.
 158   ///
 159   unsigned getFunctionNumber() const { return FunctionNumber; }
 160
 161   /// getTarget - Return the target machine this machine code is compiled with
 162   ///
 163   const TargetMachine &getTarget() const { return Target; }
 164
 165   /// getRegInfo - Return information about the registers currently in use.
 166   ///
 167   MachineRegisterInfo &getRegInfo() { return *RegInfo; }
 168   const MachineRegisterInfo &getRegInfo() const { return *RegInfo; }
 169
 170   /// getFrameInfo - Return the frame info object for the current function.
 171   /// This object contains information about objects allocated on the stack
 172   /// frame of the current function in an abstract way.
 173   ///
 174   MachineFrameInfo *getFrameInfo() { return FrameInfo; }
 175   const MachineFrameInfo *getFrameInfo() const { return FrameInfo; }
 176
 177   /// getJumpTableInfo - Return the jump table info object for the current
 178   /// function.  This object contains information about jump tables in the
 179   /// current function.  If the current function has no jump tables, this will
 180   /// return null.
 181   const MachineJumpTableInfo *getJumpTableInfo() const { return JumpTableInfo; }
 182   MachineJumpTableInfo *getJumpTableInfo() { return JumpTableInfo; }
 183
 184   /// getOrCreateJumpTableInfo - Get the JumpTableInfo for this function, if it
 185   /// does already exist, allocate one.
 186   MachineJumpTableInfo *getOrCreateJumpTableInfo(unsigned JTEntryKind);
 187
 188
 189   /// getConstantPool - Return the constant pool object for the current
 190   /// function.
 191   ///
 192   MachineConstantPool *getConstantPool() { return ConstantPool; }
 193   const MachineConstantPool *getConstantPool() const { return ConstantPool; }
 194
 195   /// getAlignment - Return the alignment (log2, not bytes) of the function.
 196   ///
 197   unsigned getAlignment() const { return Alignment; }
 198
 199   /// setAlignment - Set the alignment (log2, not bytes) of the function.
 200   ///
 201   void setAlignment(unsigned A) { Alignment = A; }
 202
 203   /// ensureAlignment - Make sure the function is at least 1 << A bytes aligned.
 204   void ensureAlignment(unsigned A) {
 205     if (Alignment < A) Alignment = A;
 206   }
 207
 208   /// exposesReturnsTwice - Returns true if the function calls setjmp or
 209   /// any other similar functions with attribute "returns twice" without
 210   /// having the attribute itself.
 211   bool exposesReturnsTwice() const {
 212     return ExposesReturnsTwice;
 213   }
 214
 215   /// setCallsSetJmp - Set a flag that indicates if there's a call to
 216   /// a "returns twice" function.
 217   void setExposesReturnsTwice(bool B) {
 218     ExposesReturnsTwice = B;
 219   }
 220
 221   /// Returns true if the function contains any inline assembly.
 222   bool hasInlineAsm() const {
 223     return HasInlineAsm;
 224   }
 225
 226   /// Set a flag that indicates that the function contains inline assembly.
 227   void setHasInlineAsm(bool B) {
 228     HasInlineAsm = B;
 229   }
 230
 231   /// getInfo - Keep track of various per-function pieces of information for
 232   /// backends that would like to do so.
 233   ///
 234   template<typename Ty>
 235   Ty *getInfo() {
 236     if (!MFInfo)
 237       MFInfo = new (Allocator.Allocate<Ty>()) Ty(*this);
 238     return static_cast<Ty*>(MFInfo);
 239   }
 240
 241   template<typename Ty>
 242   const Ty *getInfo() const {
 243      return const_cast<MachineFunction*>(this)->getInfo<Ty>();
 244   }
 245
 246   /// getBlockNumbered - MachineBasicBlocks are automatically numbered when they
 247   /// are inserted into the machine function.  The block number for a machine
 248   /// basic block can be found by using the MBB::getBlockNumber method, this
 249   /// method provides the inverse mapping.
 250   ///
 251   MachineBasicBlock *getBlockNumbered(unsigned N) const {
 252     assert(N < MBBNumbering.size() && "Illegal block number");
 253     assert(MBBNumbering[N] && "Block was removed from the machine function!");
 254     return MBBNumbering[N];
 255   }
 256
 257   /// Should we be emitting segmented stack stuff for the function
 258   bool shouldSplitStack();
 259
 260   /// getNumBlockIDs - Return the number of MBB ID's allocated.
 261   ///
 262   unsigned getNumBlockIDs() const { return (unsigned)MBBNumbering.size(); }
 263
 264   /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
 265   /// recomputes them.  This guarantees that the MBB numbers are sequential,
 266   /// dense, and match the ordering of the blocks within the function.  If a
 267   /// specific MachineBasicBlock is specified, only that block and those after
 268   /// it are renumbered.
 269   void RenumberBlocks(MachineBasicBlock *MBBFrom = nullptr);
 270
 271   /// print - Print out the MachineFunction in a format suitable for debugging
 272   /// to the specified stream.
 273   ///
 274   void print(raw_ostream &OS, SlotIndexes* = nullptr) const;
 275
 276   /// viewCFG - This function is meant for use from the debugger.  You can just
 277   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 278   /// program, displaying the CFG of the current function with the code for each
 279   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 280   /// in your path.
 281   ///
 282   void viewCFG() const;
 283
 284   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 285   /// just like viewCFG, but it does not include the contents of basic blocks
 286   /// into the nodes, just the label.  If you are only interested in the CFG
 287   /// this can make the graph smaller.
 288   ///
 289   void viewCFGOnly() const;
 290
 291   /// dump - Print the current MachineFunction to cerr, useful for debugger use.
 292   ///
 293   void dump() const;
 294
 295   /// verify - Run the current MachineFunction through the machine code
 296   /// verifier, useful for debugger use.
 297   void verify(Pass *p = nullptr, const char *Banner = nullptr) const;
 298
 299   // Provide accessors for the MachineBasicBlock list...
 300   typedef BasicBlockListType::iterator iterator;
 301   typedef BasicBlockListType::const_iterator const_iterator;
 302   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 303   typedef std::reverse_iterator<iterator>             reverse_iterator;
 304
 305   /// addLiveIn - Add the specified physical register as a live-in value and
 306   /// create a corresponding virtual register for it.
 307   unsigned addLiveIn(unsigned PReg, const TargetRegisterClass *RC);
 308
 309   //===--------------------------------------------------------------------===//
 310   // BasicBlock accessor functions.
 311   //
 312   iterator                 begin()       { return BasicBlocks.begin(); }
 313   const_iterator           begin() const { return BasicBlocks.begin(); }
 314   iterator                 end  ()       { return BasicBlocks.end();   }
 315   const_iterator           end  () const { return BasicBlocks.end();   }
 316
 317   reverse_iterator        rbegin()       { return BasicBlocks.rbegin(); }
 318   const_reverse_iterator  rbegin() const { return BasicBlocks.rbegin(); }
 319   reverse_iterator        rend  ()       { return BasicBlocks.rend();   }
 320   const_reverse_iterator  rend  () const { return BasicBlocks.rend();   }
 321
 322   unsigned                  size() const { return (unsigned)BasicBlocks.size();}
 323   bool                     empty() const { return BasicBlocks.empty(); }
 324   const MachineBasicBlock &front() const { return BasicBlocks.front(); }
 325         MachineBasicBlock &front()       { return BasicBlocks.front(); }
 326   const MachineBasicBlock & back() const { return BasicBlocks.back(); }
 327         MachineBasicBlock & back()       { return BasicBlocks.back(); }
 328
 329   void push_back (MachineBasicBlock *MBB) { BasicBlocks.push_back (MBB); }
 330   void push_front(MachineBasicBlock *MBB) { BasicBlocks.push_front(MBB); }
 331   void insert(iterator MBBI, MachineBasicBlock *MBB) {
 332     BasicBlocks.insert(MBBI, MBB);
 333   }
 334   void splice(iterator InsertPt, iterator MBBI) {
 335     BasicBlocks.splice(InsertPt, BasicBlocks, MBBI);
 336   }
 337   void splice(iterator InsertPt, iterator MBBI, iterator MBBE) {
 338     BasicBlocks.splice(InsertPt, BasicBlocks, MBBI, MBBE);
 339   }
 340
 341   void remove(iterator MBBI) {
 342     BasicBlocks.remove(MBBI);
 343   }
 344   void erase(iterator MBBI) {
 345     BasicBlocks.erase(MBBI);
 346   }
 347
 348   //===--------------------------------------------------------------------===//
 349   // Internal functions used to automatically number MachineBasicBlocks
 350   //
 351
 352   /// \brief Adds the MBB to the internal numbering. Returns the unique number
 353   /// assigned to the MBB.
 354   ///
 355   unsigned addToMBBNumbering(MachineBasicBlock *MBB) {
 356     MBBNumbering.push_back(MBB);
 357     return (unsigned)MBBNumbering.size()-1;
 358   }
 359
 360   /// removeFromMBBNumbering - Remove the specific machine basic block from our
 361   /// tracker, this is only really to be used by the MachineBasicBlock
 362   /// implementation.
 363   void removeFromMBBNumbering(unsigned N) {
 364     assert(N < MBBNumbering.size() && "Illegal basic block #");
 365     MBBNumbering[N] = nullptr;
 366   }
 367
 368   /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
 369   /// of `new MachineInstr'.
 370   ///
 371   MachineInstr *CreateMachineInstr(const MCInstrDesc &MCID,
 372                                    DebugLoc DL,
 373                                    bool NoImp = false);
 374
 375   /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
 376   /// 'Orig' instruction, identical in all ways except the instruction
 377   /// has no parent, prev, or next.
 378   ///
 379   /// See also TargetInstrInfo::duplicate() for target-specific fixes to cloned
 380   /// instructions.
 381   MachineInstr *CloneMachineInstr(const MachineInstr *Orig);
 382
 383   /// DeleteMachineInstr - Delete the given MachineInstr.
 384   ///
 385   void DeleteMachineInstr(MachineInstr *MI);
 386
 387   /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
 388   /// instead of `new MachineBasicBlock'.
 389   ///
 390   MachineBasicBlock *CreateMachineBasicBlock(const BasicBlock *bb = nullptr);
 391
 392   /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
 393   ///
 394   void DeleteMachineBasicBlock(MachineBasicBlock *MBB);
 395
 396   /// getMachineMemOperand - Allocate a new MachineMemOperand.
 397   /// MachineMemOperands are owned by the MachineFunction and need not be
 398   /// explicitly deallocated.
 399   MachineMemOperand *getMachineMemOperand(MachinePointerInfo PtrInfo,
 400                                           unsigned f, uint64_t s,
 401                                           unsigned base_alignment,
 402                                           const MDNode *TBAAInfo = nullptr,
 403                                           const MDNode *Ranges = nullptr);
 404
 405   /// getMachineMemOperand - Allocate a new MachineMemOperand by copying
 406   /// an existing one, adjusting by an offset and using the given size.
 407   /// MachineMemOperands are owned by the MachineFunction and need not be
 408   /// explicitly deallocated.
 409   MachineMemOperand *getMachineMemOperand(const MachineMemOperand *MMO,
 410                                           int64_t Offset, uint64_t Size);
 411
 412   typedef ArrayRecycler<MachineOperand>::Capacity OperandCapacity;
 413
 414   /// Allocate an array of MachineOperands. This is only intended for use by
 415   /// internal MachineInstr functions.
 416   MachineOperand *allocateOperandArray(OperandCapacity Cap) {
 417     return OperandRecycler.allocate(Cap, Allocator);
 418   }
 419
 420   /// Dellocate an array of MachineOperands and recycle the memory. This is
 421   /// only intended for use by internal MachineInstr functions.
 422   /// Cap must be the same capacity that was used to allocate the array.
 423   void deallocateOperandArray(OperandCapacity Cap, MachineOperand *Array) {
 424     OperandRecycler.deallocate(Cap, Array);
 425   }
 426
 427   /// \brief Allocate and initialize a register mask with @p NumRegister bits.
 428   uint32_t *allocateRegisterMask(unsigned NumRegister) {
 429     unsigned Size = (NumRegister + 31) / 32;
 430     uint32_t *Mask = Allocator.Allocate<uint32_t>(Size);
 431     for (unsigned i = 0; i != Size; ++i)
 432       Mask[i] = 0;
 433     return Mask;
 434   }
 435
 436   /// allocateMemRefsArray - Allocate an array to hold MachineMemOperand
 437   /// pointers.  This array is owned by the MachineFunction.
 438   MachineInstr::mmo_iterator allocateMemRefsArray(unsigned long Num);
 439
 440   /// extractLoadMemRefs - Allocate an array and populate it with just the
 441   /// load information from the given MachineMemOperand sequence.
 442   std::pair<MachineInstr::mmo_iterator,
 443             MachineInstr::mmo_iterator>
 444     extractLoadMemRefs(MachineInstr::mmo_iterator Begin,
 445                        MachineInstr::mmo_iterator End);
 446
 447   /// extractStoreMemRefs - Allocate an array and populate it with just the
 448   /// store information from the given MachineMemOperand sequence.
 449   std::pair<MachineInstr::mmo_iterator,
 450             MachineInstr::mmo_iterator>
 451     extractStoreMemRefs(MachineInstr::mmo_iterator Begin,
 452                         MachineInstr::mmo_iterator End);
 453
 454   //===--------------------------------------------------------------------===//
 455   // Label Manipulation.
 456   //
 457
 458   /// getJTISymbol - Return the MCSymbol for the specified non-empty jump table.
 459   /// If isLinkerPrivate is specified, an 'l' label is returned, otherwise a
 460   /// normal 'L' label is returned.
 461   MCSymbol *getJTISymbol(unsigned JTI, MCContext &Ctx,
 462                          bool isLinkerPrivate = false) const;
 463
 464   /// getPICBaseSymbol - Return a function-local symbol to represent the PIC
 465   /// base.
 466   MCSymbol *getPICBaseSymbol() const;
 467 };
 468
 469 //===--------------------------------------------------------------------===//
 470 // GraphTraits specializations for function basic block graphs (CFGs)
 471 //===--------------------------------------------------------------------===//
 472
 473 // Provide specializations of GraphTraits to be able to treat a
 474 // machine function as a graph of machine basic blocks... these are
 475 // the same as the machine basic block iterators, except that the root
 476 // node is implicitly the first node of the function.
 477 //
 478 template <> struct GraphTraits<MachineFunction*> :
 479   public GraphTraits<MachineBasicBlock*> {
 480   static NodeType *getEntryNode(MachineFunction *F) {
 481     return &F->front();
 482   }
 483
 484   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 485   typedef MachineFunction::iterator nodes_iterator;
 486   static nodes_iterator nodes_begin(MachineFunction *F) { return F->begin(); }
 487   static nodes_iterator nodes_end  (MachineFunction *F) { return F->end(); }
 488   static unsigned       size       (MachineFunction *F) { return F->size(); }
 489 };
 490 template <> struct GraphTraits<const MachineFunction*> :
 491   public GraphTraits<const MachineBasicBlock*> {
 492   static NodeType *getEntryNode(const MachineFunction *F) {
 493     return &F->front();
 494   }
 495
 496   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 497   typedef MachineFunction::const_iterator nodes_iterator;
 498   static nodes_iterator nodes_begin(const MachineFunction *F) {
 499     return F->begin();
 500   }
 501   static nodes_iterator nodes_end  (const MachineFunction *F) {
 502     return F->end();
 503   }
 504   static unsigned       size       (const MachineFunction *F)  {
 505     return F->size();
 506   }
 507 };
 508
 509
 510 // Provide specializations of GraphTraits to be able to treat a function as a
 511 // graph of basic blocks... and to walk it in inverse order.  Inverse order for
 512 // a function is considered to be when traversing the predecessor edges of a BB
 513 // instead of the successor edges.
 514 //
 515 template <> struct GraphTraits<Inverse<MachineFunction*> > :
 516   public GraphTraits<Inverse<MachineBasicBlock*> > {
 517   static NodeType *getEntryNode(Inverse<MachineFunction*> G) {
 518     return &G.Graph->front();
 519   }
 520 };
 521 template <> struct GraphTraits<Inverse<const MachineFunction*> > :
 522   public GraphTraits<Inverse<const MachineBasicBlock*> > {
 523   static NodeType *getEntryNode(Inverse<const MachineFunction *> G) {
 524     return &G.Graph->front();
 525   }
 526 };
 527
 528 } // End llvm namespace
 529
 530 #endif