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