include/llvm/CodeGen/MachineBasicBlock.h

   1 //===-- llvm/CodeGen/MachineBasicBlock.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 the sequence of machine instructions for a basic block.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_MACHINEBASICBLOCK_H
  15 #define LLVM_CODEGEN_MACHINEBASICBLOCK_H
  16
  17 #include "llvm/ADT/GraphTraits.h"
  18 #include "llvm/CodeGen/MachineInstr.h"
  19 #include "llvm/Support/DataTypes.h"
  20 #include <functional>
  21
  22 namespace llvm {
  23
  24 class Pass;
  25 class BasicBlock;
  26 class MachineFunction;
  27 class MCSymbol;
  28 class SlotIndexes;
  29 class StringRef;
  30 class raw_ostream;
  31 class MachineBranchProbabilityInfo;
  32
  33 template <>
  34 struct ilist_traits<MachineInstr> : public ilist_default_traits<MachineInstr> {
  35 private:
  36   mutable ilist_half_node<MachineInstr> Sentinel;
  37
  38   // this is only set by the MachineBasicBlock owning the LiveList
  39   friend class MachineBasicBlock;
  40   MachineBasicBlock* Parent;
  41
  42 public:
  43   MachineInstr *createSentinel() const {
  44     return static_cast<MachineInstr*>(&Sentinel);
  45   }
  46   void destroySentinel(MachineInstr *) const {}
  47
  48   MachineInstr *provideInitialHead() const { return createSentinel(); }
  49   MachineInstr *ensureHead(MachineInstr*) const { return createSentinel(); }
  50   static void noteHead(MachineInstr*, MachineInstr*) {}
  51
  52   void addNodeToList(MachineInstr* N);
  53   void removeNodeFromList(MachineInstr* N);
  54   void transferNodesFromList(ilist_traits &SrcTraits,
  55                              ilist_iterator<MachineInstr> first,
  56                              ilist_iterator<MachineInstr> last);
  57   void deleteNode(MachineInstr *N);
  58 private:
  59   void createNode(const MachineInstr &);
  60 };
  61
  62 class MachineBasicBlock : public ilist_node<MachineBasicBlock> {
  63   typedef ilist<MachineInstr> Instructions;
  64   Instructions Insts;
  65   const BasicBlock *BB;
  66   int Number;
  67   MachineFunction *xParent;
  68
  69   /// Predecessors/Successors - Keep track of the predecessor / successor
  70   /// basicblocks.
  71   std::vector<MachineBasicBlock *> Predecessors;
  72   std::vector<MachineBasicBlock *> Successors;
  73
  74   /// Weights - Keep track of the weights to the successors. This vector
  75   /// has the same order as Successors, or it is empty if we don't use it
  76   /// (disable optimization).
  77   std::vector<uint32_t> Weights;
  78   typedef std::vector<uint32_t>::iterator weight_iterator;
  79   typedef std::vector<uint32_t>::const_iterator const_weight_iterator;
  80
  81   /// LiveIns - Keep track of the physical registers that are livein of
  82   /// the basicblock.
  83   std::vector<unsigned> LiveIns;
  84
  85   /// Alignment - Alignment of the basic block. Zero if the basic block does
  86   /// not need to be aligned.
  87   /// The alignment is specified as log2(bytes).
  88   unsigned Alignment;
  89
  90   /// IsLandingPad - Indicate that this basic block is entered via an
  91   /// exception handler.
  92   bool IsLandingPad;
  93
  94   /// AddressTaken - Indicate that this basic block is potentially the
  95   /// target of an indirect branch.
  96   bool AddressTaken;
  97
  98   /// \brief since getSymbol is a relatively heavy-weight operation, the symbol
  99   /// is only computed once and is cached.
 100   mutable MCSymbol *CachedMCSymbol;
 101
 102   // Intrusive list support
 103   MachineBasicBlock() {}
 104
 105   explicit MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb);
 106
 107   ~MachineBasicBlock();
 108
 109   // MachineBasicBlocks are allocated and owned by MachineFunction.
 110   friend class MachineFunction;
 111
 112 public:
 113   /// getBasicBlock - Return the LLVM basic block that this instance
 114   /// corresponded to originally. Note that this may be NULL if this instance
 115   /// does not correspond directly to an LLVM basic block.
 116   ///
 117   const BasicBlock *getBasicBlock() const { return BB; }
 118
 119   /// getName - Return the name of the corresponding LLVM basic block, or
 120   /// "(null)".
 121   StringRef getName() const;
 122
 123   /// getFullName - Return a formatted string to identify this block and its
 124   /// parent function.
 125   std::string getFullName() const;
 126
 127   /// hasAddressTaken - Test whether this block is potentially the target
 128   /// of an indirect branch.
 129   bool hasAddressTaken() const { return AddressTaken; }
 130
 131   /// setHasAddressTaken - Set this block to reflect that it potentially
 132   /// is the target of an indirect branch.
 133   void setHasAddressTaken() { AddressTaken = true; }
 134
 135   /// getParent - Return the MachineFunction containing this basic block.
 136   ///
 137   const MachineFunction *getParent() const { return xParent; }
 138   MachineFunction *getParent() { return xParent; }
 139
 140
 141   /// bundle_iterator - MachineBasicBlock iterator that automatically skips over
 142   /// MIs that are inside bundles (i.e. walk top level MIs only).
 143   template<typename Ty, typename IterTy>
 144   class bundle_iterator
 145     : public std::iterator<std::bidirectional_iterator_tag, Ty, ptrdiff_t> {
 146     IterTy MII;
 147
 148   public:
 149     bundle_iterator(IterTy mii) : MII(mii) {}
 150
 151     bundle_iterator(Ty &mi) : MII(mi) {
 152       assert(!mi.isBundledWithPred() &&
 153              "It's not legal to initialize bundle_iterator with a bundled MI");
 154     }
 155     bundle_iterator(Ty *mi) : MII(mi) {
 156       assert((!mi || !mi->isBundledWithPred()) &&
 157              "It's not legal to initialize bundle_iterator with a bundled MI");
 158     }
 159     // Template allows conversion from const to nonconst.
 160     template<class OtherTy, class OtherIterTy>
 161     bundle_iterator(const bundle_iterator<OtherTy, OtherIterTy> &I)
 162       : MII(I.getInstrIterator()) {}
 163     bundle_iterator() : MII(nullptr) {}
 164
 165     Ty &operator*() const { return *MII; }
 166     Ty *operator->() const { return &operator*(); }
 167
 168     operator Ty*() const { return MII; }
 169
 170     bool operator==(const bundle_iterator &x) const {
 171       return MII == x.MII;
 172     }
 173     bool operator!=(const bundle_iterator &x) const {
 174       return !operator==(x);
 175     }
 176
 177     // Increment and decrement operators...
 178     bundle_iterator &operator--() {      // predecrement - Back up
 179       do --MII;
 180       while (MII->isBundledWithPred());
 181       return *this;
 182     }
 183     bundle_iterator &operator++() {      // preincrement - Advance
 184       while (MII->isBundledWithSucc())
 185         ++MII;
 186       ++MII;
 187       return *this;
 188     }
 189     bundle_iterator operator--(int) {    // postdecrement operators...
 190       bundle_iterator tmp = *this;
 191       --*this;
 192       return tmp;
 193     }
 194     bundle_iterator operator++(int) {    // postincrement operators...
 195       bundle_iterator tmp = *this;
 196       ++*this;
 197       return tmp;
 198     }
 199
 200     IterTy getInstrIterator() const {
 201       return MII;
 202     }
 203   };
 204
 205   typedef Instructions::iterator                                 instr_iterator;
 206   typedef Instructions::const_iterator                     const_instr_iterator;
 207   typedef std::reverse_iterator<instr_iterator>          reverse_instr_iterator;
 208   typedef
 209   std::reverse_iterator<const_instr_iterator>      const_reverse_instr_iterator;
 210
 211   typedef
 212   bundle_iterator<MachineInstr,instr_iterator>                         iterator;
 213   typedef
 214   bundle_iterator<const MachineInstr,const_instr_iterator>       const_iterator;
 215   typedef std::reverse_iterator<const_iterator>          const_reverse_iterator;
 216   typedef std::reverse_iterator<iterator>                      reverse_iterator;
 217
 218
 219   unsigned size() const { return (unsigned)Insts.size(); }
 220   bool empty() const { return Insts.empty(); }
 221
 222   MachineInstr       &instr_front()       { return Insts.front(); }
 223   MachineInstr       &instr_back()        { return Insts.back();  }
 224   const MachineInstr &instr_front() const { return Insts.front(); }
 225   const MachineInstr &instr_back()  const { return Insts.back();  }
 226
 227   MachineInstr       &front()             { return Insts.front(); }
 228   MachineInstr       &back()              { return *--end();      }
 229   const MachineInstr &front()       const { return Insts.front(); }
 230   const MachineInstr &back()        const { return *--end();      }
 231
 232   instr_iterator                instr_begin()       { return Insts.begin();  }
 233   const_instr_iterator          instr_begin() const { return Insts.begin();  }
 234   instr_iterator                  instr_end()       { return Insts.end();    }
 235   const_instr_iterator            instr_end() const { return Insts.end();    }
 236   reverse_instr_iterator       instr_rbegin()       { return Insts.rbegin(); }
 237   const_reverse_instr_iterator instr_rbegin() const { return Insts.rbegin(); }
 238   reverse_instr_iterator       instr_rend  ()       { return Insts.rend();   }
 239   const_reverse_instr_iterator instr_rend  () const { return Insts.rend();   }
 240
 241   iterator                begin()       { return instr_begin();  }
 242   const_iterator          begin() const { return instr_begin();  }
 243   iterator                end  ()       { return instr_end();    }
 244   const_iterator          end  () const { return instr_end();    }
 245   reverse_iterator       rbegin()       { return instr_rbegin(); }
 246   const_reverse_iterator rbegin() const { return instr_rbegin(); }
 247   reverse_iterator       rend  ()       { return instr_rend();   }
 248   const_reverse_iterator rend  () const { return instr_rend();   }
 249
 250   inline iterator_range<iterator> terminators() {
 251     return iterator_range<iterator>(getFirstTerminator(), end());
 252   }
 253   inline iterator_range<const_iterator> terminators() const {
 254     return iterator_range<const_iterator>(getFirstTerminator(), end());
 255   }
 256
 257   // Machine-CFG iterators
 258   typedef std::vector<MachineBasicBlock *>::iterator       pred_iterator;
 259   typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator;
 260   typedef std::vector<MachineBasicBlock *>::iterator       succ_iterator;
 261   typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator;
 262   typedef std::vector<MachineBasicBlock *>::reverse_iterator
 263                                                          pred_reverse_iterator;
 264   typedef std::vector<MachineBasicBlock *>::const_reverse_iterator
 265                                                    const_pred_reverse_iterator;
 266   typedef std::vector<MachineBasicBlock *>::reverse_iterator
 267                                                          succ_reverse_iterator;
 268   typedef std::vector<MachineBasicBlock *>::const_reverse_iterator
 269                                                    const_succ_reverse_iterator;
 270   pred_iterator        pred_begin()       { return Predecessors.begin(); }
 271   const_pred_iterator  pred_begin() const { return Predecessors.begin(); }
 272   pred_iterator        pred_end()         { return Predecessors.end();   }
 273   const_pred_iterator  pred_end()   const { return Predecessors.end();   }
 274   pred_reverse_iterator        pred_rbegin()
 275                                           { return Predecessors.rbegin();}
 276   const_pred_reverse_iterator  pred_rbegin() const
 277                                           { return Predecessors.rbegin();}
 278   pred_reverse_iterator        pred_rend()
 279                                           { return Predecessors.rend();  }
 280   const_pred_reverse_iterator  pred_rend()   const
 281                                           { return Predecessors.rend();  }
 282   unsigned             pred_size()  const {
 283     return (unsigned)Predecessors.size();
 284   }
 285   bool                 pred_empty() const { return Predecessors.empty(); }
 286   succ_iterator        succ_begin()       { return Successors.begin();   }
 287   const_succ_iterator  succ_begin() const { return Successors.begin();   }
 288   succ_iterator        succ_end()         { return Successors.end();     }
 289   const_succ_iterator  succ_end()   const { return Successors.end();     }
 290   succ_reverse_iterator        succ_rbegin()
 291                                           { return Successors.rbegin();  }
 292   const_succ_reverse_iterator  succ_rbegin() const
 293                                           { return Successors.rbegin();  }
 294   succ_reverse_iterator        succ_rend()
 295                                           { return Successors.rend();    }
 296   const_succ_reverse_iterator  succ_rend()   const
 297                                           { return Successors.rend();    }
 298   unsigned             succ_size()  const {
 299     return (unsigned)Successors.size();
 300   }
 301   bool                 succ_empty() const { return Successors.empty();   }
 302
 303   inline iterator_range<pred_iterator> predecessors() {
 304     return iterator_range<pred_iterator>(pred_begin(), pred_end());
 305   }
 306   inline iterator_range<const_pred_iterator> predecessors() const {
 307     return iterator_range<const_pred_iterator>(pred_begin(), pred_end());
 308   }
 309   inline iterator_range<succ_iterator> successors() {
 310     return iterator_range<succ_iterator>(succ_begin(), succ_end());
 311   }
 312   inline iterator_range<const_succ_iterator> successors() const {
 313     return iterator_range<const_succ_iterator>(succ_begin(), succ_end());
 314   }
 315
 316   // LiveIn management methods.
 317
 318   /// Adds the specified register as a live in. Note that it is an error to add
 319   /// the same register to the same set more than once unless the intention is
 320   /// to call sortUniqueLiveIns after all registers are added.
 321   void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); }
 322
 323   /// Sorts and uniques the LiveIns vector. It can be significantly faster to do
 324   /// this than repeatedly calling isLiveIn before calling addLiveIn for every
 325   /// LiveIn insertion.
 326   void sortUniqueLiveIns() {
 327     std::sort(LiveIns.begin(), LiveIns.end());
 328     LiveIns.erase(std::unique(LiveIns.begin(), LiveIns.end()), LiveIns.end());
 329   }
 330
 331   /// Add PhysReg as live in to this block, and ensure that there is a copy of
 332   /// PhysReg to a virtual register of class RC. Return the virtual register
 333   /// that is a copy of the live in PhysReg.
 334   unsigned addLiveIn(unsigned PhysReg, const TargetRegisterClass *RC);
 335
 336   /// removeLiveIn - Remove the specified register from the live in set.
 337   ///
 338   void removeLiveIn(unsigned Reg);
 339
 340   /// isLiveIn - Return true if the specified register is in the live in set.
 341   ///
 342   bool isLiveIn(unsigned Reg) const;
 343
 344   // Iteration support for live in sets.  These sets are kept in sorted
 345   // order by their register number.
 346   typedef std::vector<unsigned>::const_iterator livein_iterator;
 347   livein_iterator livein_begin() const { return LiveIns.begin(); }
 348   livein_iterator livein_end()   const { return LiveIns.end(); }
 349   bool            livein_empty() const { return LiveIns.empty(); }
 350
 351   /// getAlignment - Return alignment of the basic block.
 352   /// The alignment is specified as log2(bytes).
 353   ///
 354   unsigned getAlignment() const { return Alignment; }
 355
 356   /// setAlignment - Set alignment of the basic block.
 357   /// The alignment is specified as log2(bytes).
 358   ///
 359   void setAlignment(unsigned Align) { Alignment = Align; }
 360
 361   /// isLandingPad - Returns true if the block is a landing pad. That is
 362   /// this basic block is entered via an exception handler.
 363   bool isLandingPad() const { return IsLandingPad; }
 364
 365   /// setIsLandingPad - Indicates the block is a landing pad.  That is
 366   /// this basic block is entered via an exception handler.
 367   void setIsLandingPad(bool V = true) { IsLandingPad = V; }
 368
 369   /// getLandingPadSuccessor - If this block has a successor that is a landing
 370   /// pad, return it. Otherwise return NULL.
 371   const MachineBasicBlock *getLandingPadSuccessor() const;
 372
 373   // Code Layout methods.
 374
 375   /// moveBefore/moveAfter - move 'this' block before or after the specified
 376   /// block.  This only moves the block, it does not modify the CFG or adjust
 377   /// potential fall-throughs at the end of the block.
 378   void moveBefore(MachineBasicBlock *NewAfter);
 379   void moveAfter(MachineBasicBlock *NewBefore);
 380
 381   /// updateTerminator - Update the terminator instructions in block to account
 382   /// for changes to the layout. If the block previously used a fallthrough,
 383   /// it may now need a branch, and if it previously used branching it may now
 384   /// be able to use a fallthrough.
 385   void updateTerminator();
 386
 387   // Machine-CFG mutators
 388
 389   /// addSuccessor - Add succ as a successor of this MachineBasicBlock.
 390   /// The Predecessors list of succ is automatically updated. WEIGHT
 391   /// parameter is stored in Weights list and it may be used by
 392   /// MachineBranchProbabilityInfo analysis to calculate branch probability.
 393   ///
 394   /// Note that duplicate Machine CFG edges are not allowed.
 395   ///
 396   void addSuccessor(MachineBasicBlock *succ, uint32_t weight = 0);
 397
 398   /// Set successor weight of a given iterator.
 399   void setSuccWeight(succ_iterator I, uint32_t weight);
 400
 401   /// removeSuccessor - Remove successor from the successors list of this
 402   /// MachineBasicBlock. The Predecessors list of succ is automatically updated.
 403   ///
 404   void removeSuccessor(MachineBasicBlock *succ);
 405
 406   /// removeSuccessor - Remove specified successor from the successors list of
 407   /// this MachineBasicBlock. The Predecessors list of succ is automatically
 408   /// updated.  Return the iterator to the element after the one removed.
 409   ///
 410   succ_iterator removeSuccessor(succ_iterator I);
 411
 412   /// replaceSuccessor - Replace successor OLD with NEW and update weight info.
 413   ///
 414   void replaceSuccessor(MachineBasicBlock *Old, MachineBasicBlock *New);
 415
 416
 417   /// transferSuccessors - Transfers all the successors from MBB to this
 418   /// machine basic block (i.e., copies all the successors fromMBB and
 419   /// remove all the successors from fromMBB).
 420   void transferSuccessors(MachineBasicBlock *fromMBB);
 421
 422   /// transferSuccessorsAndUpdatePHIs - Transfers all the successors, as
 423   /// in transferSuccessors, and update PHI operands in the successor blocks
 424   /// which refer to fromMBB to refer to this.
 425   void transferSuccessorsAndUpdatePHIs(MachineBasicBlock *fromMBB);
 426
 427   /// isPredecessor - Return true if the specified MBB is a predecessor of this
 428   /// block.
 429   bool isPredecessor(const MachineBasicBlock *MBB) const;
 430
 431   /// isSuccessor - Return true if the specified MBB is a successor of this
 432   /// block.
 433   bool isSuccessor(const MachineBasicBlock *MBB) const;
 434
 435   /// isLayoutSuccessor - Return true if the specified MBB will be emitted
 436   /// immediately after this block, such that if this block exits by
 437   /// falling through, control will transfer to the specified MBB. Note
 438   /// that MBB need not be a successor at all, for example if this block
 439   /// ends with an unconditional branch to some other block.
 440   bool isLayoutSuccessor(const MachineBasicBlock *MBB) const;
 441
 442   /// canFallThrough - Return true if the block can implicitly transfer
 443   /// control to the block after it by falling off the end of it.  This should
 444   /// return false if it can reach the block after it, but it uses an explicit
 445   /// branch to do so (e.g., a table jump).  True is a conservative answer.
 446   bool canFallThrough();
 447
 448   /// Returns a pointer to the first instruction in this block that is not a
 449   /// PHINode instruction. When adding instructions to the beginning of the
 450   /// basic block, they should be added before the returned value, not before
 451   /// the first instruction, which might be PHI.
 452   /// Returns end() is there's no non-PHI instruction.
 453   iterator getFirstNonPHI();
 454
 455   /// SkipPHIsAndLabels - Return the first instruction in MBB after I that is
 456   /// not a PHI or a label. This is the correct point to insert copies at the
 457   /// beginning of a basic block.
 458   iterator SkipPHIsAndLabels(iterator I);
 459
 460   /// getFirstTerminator - returns an iterator to the first terminator
 461   /// instruction of this basic block. If a terminator does not exist,
 462   /// it returns end()
 463   iterator getFirstTerminator();
 464   const_iterator getFirstTerminator() const;
 465
 466   /// getFirstInstrTerminator - Same getFirstTerminator but it ignores bundles
 467   /// and return an instr_iterator instead.
 468   instr_iterator getFirstInstrTerminator();
 469
 470   /// getLastNonDebugInstr - returns an iterator to the last non-debug
 471   /// instruction in the basic block, or end()
 472   iterator getLastNonDebugInstr();
 473   const_iterator getLastNonDebugInstr() const;
 474
 475   /// SplitCriticalEdge - Split the critical edge from this block to the
 476   /// given successor block, and return the newly created block, or null
 477   /// if splitting is not possible.
 478   ///
 479   /// This function updates LiveVariables, MachineDominatorTree, and
 480   /// MachineLoopInfo, as applicable.
 481   MachineBasicBlock *SplitCriticalEdge(MachineBasicBlock *Succ, Pass *P);
 482
 483   void pop_front() { Insts.pop_front(); }
 484   void pop_back() { Insts.pop_back(); }
 485   void push_back(MachineInstr *MI) { Insts.push_back(MI); }
 486
 487   /// Insert MI into the instruction list before I, possibly inside a bundle.
 488   ///
 489   /// If the insertion point is inside a bundle, MI will be added to the bundle,
 490   /// otherwise MI will not be added to any bundle. That means this function
 491   /// alone can't be used to prepend or append instructions to bundles. See
 492   /// MIBundleBuilder::insert() for a more reliable way of doing that.
 493   instr_iterator insert(instr_iterator I, MachineInstr *M);
 494
 495   /// Insert a range of instructions into the instruction list before I.
 496   template<typename IT>
 497   void insert(iterator I, IT S, IT E) {
 498     assert((I == end() || I->getParent() == this) &&
 499            "iterator points outside of basic block");
 500     Insts.insert(I.getInstrIterator(), S, E);
 501   }
 502
 503   /// Insert MI into the instruction list before I.
 504   iterator insert(iterator I, MachineInstr *MI) {
 505     assert((I == end() || I->getParent() == this) &&
 506            "iterator points outside of basic block");
 507     assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() &&
 508            "Cannot insert instruction with bundle flags");
 509     return Insts.insert(I.getInstrIterator(), MI);
 510   }
 511
 512   /// Insert MI into the instruction list after I.
 513   iterator insertAfter(iterator I, MachineInstr *MI) {
 514     assert((I == end() || I->getParent() == this) &&
 515            "iterator points outside of basic block");
 516     assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() &&
 517            "Cannot insert instruction with bundle flags");
 518     return Insts.insertAfter(I.getInstrIterator(), MI);
 519   }
 520
 521   /// Remove an instruction from the instruction list and delete it.
 522   ///
 523   /// If the instruction is part of a bundle, the other instructions in the
 524   /// bundle will still be bundled after removing the single instruction.
 525   instr_iterator erase(instr_iterator I);
 526
 527   /// Remove an instruction from the instruction list and delete it.
 528   ///
 529   /// If the instruction is part of a bundle, the other instructions in the
 530   /// bundle will still be bundled after removing the single instruction.
 531   instr_iterator erase_instr(MachineInstr *I) {
 532     return erase(instr_iterator(I));
 533   }
 534
 535   /// Remove a range of instructions from the instruction list and delete them.
 536   iterator erase(iterator I, iterator E) {
 537     return Insts.erase(I.getInstrIterator(), E.getInstrIterator());
 538   }
 539
 540   /// Remove an instruction or bundle from the instruction list and delete it.
 541   ///
 542   /// If I points to a bundle of instructions, they are all erased.
 543   iterator erase(iterator I) {
 544     return erase(I, std::next(I));
 545   }
 546
 547   /// Remove an instruction from the instruction list and delete it.
 548   ///
 549   /// If I is the head of a bundle of instructions, the whole bundle will be
 550   /// erased.
 551   iterator erase(MachineInstr *I) {
 552     return erase(iterator(I));
 553   }
 554
 555   /// Remove the unbundled instruction from the instruction list without
 556   /// deleting it.
 557   ///
 558   /// This function can not be used to remove bundled instructions, use
 559   /// remove_instr to remove individual instructions from a bundle.
 560   MachineInstr *remove(MachineInstr *I) {
 561     assert(!I->isBundled() && "Cannot remove bundled instructions");
 562     return Insts.remove(I);
 563   }
 564
 565   /// Remove the possibly bundled instruction from the instruction list
 566   /// without deleting it.
 567   ///
 568   /// If the instruction is part of a bundle, the other instructions in the
 569   /// bundle will still be bundled after removing the single instruction.
 570   MachineInstr *remove_instr(MachineInstr *I);
 571
 572   void clear() {
 573     Insts.clear();
 574   }
 575
 576   /// Take an instruction from MBB 'Other' at the position From, and insert it
 577   /// into this MBB right before 'Where'.
 578   ///
 579   /// If From points to a bundle of instructions, the whole bundle is moved.
 580   void splice(iterator Where, MachineBasicBlock *Other, iterator From) {
 581     // The range splice() doesn't allow noop moves, but this one does.
 582     if (Where != From)
 583       splice(Where, Other, From, std::next(From));
 584   }
 585
 586   /// Take a block of instructions from MBB 'Other' in the range [From, To),
 587   /// and insert them into this MBB right before 'Where'.
 588   ///
 589   /// The instruction at 'Where' must not be included in the range of
 590   /// instructions to move.
 591   void splice(iterator Where, MachineBasicBlock *Other,
 592               iterator From, iterator To) {
 593     Insts.splice(Where.getInstrIterator(), Other->Insts,
 594                  From.getInstrIterator(), To.getInstrIterator());
 595   }
 596
 597   /// removeFromParent - This method unlinks 'this' from the containing
 598   /// function, and returns it, but does not delete it.
 599   MachineBasicBlock *removeFromParent();
 600
 601   /// eraseFromParent - This method unlinks 'this' from the containing
 602   /// function and deletes it.
 603   void eraseFromParent();
 604
 605   /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to
 606   /// 'Old', change the code and CFG so that it branches to 'New' instead.
 607   void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New);
 608
 609   /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in
 610   /// the CFG to be inserted.  If we have proven that MBB can only branch to
 611   /// DestA and DestB, remove any other MBB successors from the CFG. DestA and
 612   /// DestB can be null. Besides DestA and DestB, retain other edges leading
 613   /// to LandingPads (currently there can be only one; we don't check or require
 614   /// that here). Note it is possible that DestA and/or DestB are LandingPads.
 615   bool CorrectExtraCFGEdges(MachineBasicBlock *DestA,
 616                             MachineBasicBlock *DestB,
 617                             bool isCond);
 618
 619   /// findDebugLoc - find the next valid DebugLoc starting at MBBI, skipping
 620   /// any DBG_VALUE instructions.  Return UnknownLoc if there is none.
 621   DebugLoc findDebugLoc(instr_iterator MBBI);
 622   DebugLoc findDebugLoc(iterator MBBI) {
 623     return findDebugLoc(MBBI.getInstrIterator());
 624   }
 625
 626   /// Possible outcome of a register liveness query to computeRegisterLiveness()
 627   enum LivenessQueryResult {
 628     LQR_Live,            ///< Register is known to be live.
 629     LQR_OverlappingLive, ///< Register itself is not live, but some overlapping
 630                          ///< register is.
 631     LQR_Dead,            ///< Register is known to be dead.
 632     LQR_Unknown          ///< Register liveness not decidable from local
 633                          ///< neighborhood.
 634   };
 635
 636   /// Return whether (physical) register \p Reg has been <def>ined and not
 637   /// <kill>ed as of just before \p Before.
 638   ///
 639   /// Search is localised to a neighborhood of \p Neighborhood instructions
 640   /// before (searching for defs or kills) and \p Neighborhood instructions
 641   /// after (searching just for defs) \p Before.
 642   ///
 643   /// \p Reg must be a physical register.
 644   LivenessQueryResult computeRegisterLiveness(const TargetRegisterInfo *TRI,
 645                                               unsigned Reg,
 646                                               const_iterator Before,
 647                                               unsigned Neighborhood=10) const;
 648
 649   // Debugging methods.
 650   void dump() const;
 651   void print(raw_ostream &OS, SlotIndexes* = nullptr) const;
 652
 653   // Printing method used by LoopInfo.
 654   void printAsOperand(raw_ostream &OS, bool PrintType = true) const;
 655
 656   /// getNumber - MachineBasicBlocks are uniquely numbered at the function
 657   /// level, unless they're not in a MachineFunction yet, in which case this
 658   /// will return -1.
 659   ///
 660   int getNumber() const { return Number; }
 661   void setNumber(int N) { Number = N; }
 662
 663   /// getSymbol - Return the MCSymbol for this basic block.
 664   ///
 665   MCSymbol *getSymbol() const;
 666
 667
 668 private:
 669   /// getWeightIterator - Return weight iterator corresponding to the I
 670   /// successor iterator.
 671   weight_iterator getWeightIterator(succ_iterator I);
 672   const_weight_iterator getWeightIterator(const_succ_iterator I) const;
 673
 674   friend class MachineBranchProbabilityInfo;
 675
 676   /// getSuccWeight - Return weight of the edge from this block to MBB. This
 677   /// method should NOT be called directly, but by using getEdgeWeight method
 678   /// from MachineBranchProbabilityInfo class.
 679   uint32_t getSuccWeight(const_succ_iterator Succ) const;
 680
 681
 682   // Methods used to maintain doubly linked list of blocks...
 683   friend struct ilist_traits<MachineBasicBlock>;
 684
 685   // Machine-CFG mutators
 686
 687   /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock.
 688   /// Don't do this unless you know what you're doing, because it doesn't
 689   /// update pred's successors list. Use pred->addSuccessor instead.
 690   ///
 691   void addPredecessor(MachineBasicBlock *pred);
 692
 693   /// removePredecessor - Remove pred as a predecessor of this
 694   /// MachineBasicBlock. Don't do this unless you know what you're
 695   /// doing, because it doesn't update pred's successors list. Use
 696   /// pred->removeSuccessor instead.
 697   ///
 698   void removePredecessor(MachineBasicBlock *pred);
 699 };
 700
 701 raw_ostream& operator<<(raw_ostream &OS, const MachineBasicBlock &MBB);
 702
 703 // This is useful when building IndexedMaps keyed on basic block pointers.
 704 struct MBB2NumberFunctor :
 705   public std::unary_function<const MachineBasicBlock*, unsigned> {
 706   unsigned operator()(const MachineBasicBlock *MBB) const {
 707     return MBB->getNumber();
 708   }
 709 };
 710
 711 //===--------------------------------------------------------------------===//
 712 // GraphTraits specializations for machine basic block graphs (machine-CFGs)
 713 //===--------------------------------------------------------------------===//
 714
 715 // Provide specializations of GraphTraits to be able to treat a
 716 // MachineFunction as a graph of MachineBasicBlocks...
 717 //
 718
 719 template <> struct GraphTraits<MachineBasicBlock *> {
 720   typedef MachineBasicBlock NodeType;
 721   typedef MachineBasicBlock::succ_iterator ChildIteratorType;
 722
 723   static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; }
 724   static inline ChildIteratorType child_begin(NodeType *N) {
 725     return N->succ_begin();
 726   }
 727   static inline ChildIteratorType child_end(NodeType *N) {
 728     return N->succ_end();
 729   }
 730 };
 731
 732 template <> struct GraphTraits<const MachineBasicBlock *> {
 733   typedef const MachineBasicBlock NodeType;
 734   typedef MachineBasicBlock::const_succ_iterator ChildIteratorType;
 735
 736   static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; }
 737   static inline ChildIteratorType child_begin(NodeType *N) {
 738     return N->succ_begin();
 739   }
 740   static inline ChildIteratorType child_end(NodeType *N) {
 741     return N->succ_end();
 742   }
 743 };
 744
 745 // Provide specializations of GraphTraits to be able to treat a
 746 // MachineFunction as a graph of MachineBasicBlocks... and to walk it
 747 // in inverse order.  Inverse order for a function is considered
 748 // to be when traversing the predecessor edges of a MBB
 749 // instead of the successor edges.
 750 //
 751 template <> struct GraphTraits<Inverse<MachineBasicBlock*> > {
 752   typedef MachineBasicBlock NodeType;
 753   typedef MachineBasicBlock::pred_iterator ChildIteratorType;
 754   static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) {
 755     return G.Graph;
 756   }
 757   static inline ChildIteratorType child_begin(NodeType *N) {
 758     return N->pred_begin();
 759   }
 760   static inline ChildIteratorType child_end(NodeType *N) {
 761     return N->pred_end();
 762   }
 763 };
 764
 765 template <> struct GraphTraits<Inverse<const MachineBasicBlock*> > {
 766   typedef const MachineBasicBlock NodeType;
 767   typedef MachineBasicBlock::const_pred_iterator ChildIteratorType;
 768   static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) {
 769     return G.Graph;
 770   }
 771   static inline ChildIteratorType child_begin(NodeType *N) {
 772     return N->pred_begin();
 773   }
 774   static inline ChildIteratorType child_end(NodeType *N) {
 775     return N->pred_end();
 776   }
 777 };
 778
 779
 780
 781 /// MachineInstrSpan provides an interface to get an iteration range
 782 /// containing the instruction it was initialized with, along with all
 783 /// those instructions inserted prior to or following that instruction
 784 /// at some point after the MachineInstrSpan is constructed.
 785 class MachineInstrSpan {
 786   MachineBasicBlock &MBB;
 787   MachineBasicBlock::iterator I, B, E;
 788 public:
 789   MachineInstrSpan(MachineBasicBlock::iterator I)
 790     : MBB(*I->getParent()),
 791       I(I),
 792       B(I == MBB.begin() ? MBB.end() : std::prev(I)),
 793       E(std::next(I)) {}
 794
 795   MachineBasicBlock::iterator begin() {
 796     return B == MBB.end() ? MBB.begin() : std::next(B);
 797   }
 798   MachineBasicBlock::iterator end() { return E; }
 799   bool empty() { return begin() == end(); }
 800
 801   MachineBasicBlock::iterator getInitial() { return I; }
 802 };
 803
 804 } // namespace llvm
 805
 806 #endif