1 //===-- llvm/CodeGen/MachineBasicBlock.h ------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Collect the sequence of machine instructions for a basic block.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_MACHINEBASICBLOCK_H
15 #define LLVM_CODEGEN_MACHINEBASICBLOCK_H
17 #include "llvm/ADT/GraphTraits.h"
18 #include "llvm/CodeGen/MachineInstr.h"
19 #include "llvm/Support/DataTypes.h"
26 class MachineFunction;
31 class MachineBranchProbabilityInfo;
34 struct ilist_traits<MachineInstr> : public ilist_default_traits<MachineInstr> {
36 mutable ilist_half_node<MachineInstr> Sentinel;
38 // this is only set by the MachineBasicBlock owning the LiveList
39 friend class MachineBasicBlock;
40 MachineBasicBlock* Parent;
43 MachineInstr *createSentinel() const {
44 return static_cast<MachineInstr*>(&Sentinel);
46 void destroySentinel(MachineInstr *) const {}
48 MachineInstr *provideInitialHead() const { return createSentinel(); }
49 MachineInstr *ensureHead(MachineInstr*) const { return createSentinel(); }
50 static void noteHead(MachineInstr*, MachineInstr*) {}
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);
59 void createNode(const MachineInstr &);
62 class MachineBasicBlock : public ilist_node<MachineBasicBlock> {
63 typedef ilist<MachineInstr> Instructions;
67 MachineFunction *xParent;
69 /// Predecessors/Successors - Keep track of the predecessor / successor
71 std::vector<MachineBasicBlock *> Predecessors;
72 std::vector<MachineBasicBlock *> Successors;
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;
81 /// LiveIns - Keep track of the physical registers that are livein of
83 std::vector<unsigned> LiveIns;
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).
90 /// IsLandingPad - Indicate that this basic block is entered via an
91 /// exception handler.
94 /// AddressTaken - Indicate that this basic block is potentially the
95 /// target of an indirect branch.
98 /// \brief since getSymbol is a relatively heavy-weight operation, the symbol
99 /// is only computed once and is cached.
100 mutable MCSymbol *CachedMCSymbol;
102 // Intrusive list support
103 MachineBasicBlock() {}
105 explicit MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb);
107 ~MachineBasicBlock();
109 // MachineBasicBlocks are allocated and owned by MachineFunction.
110 friend class MachineFunction;
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.
117 const BasicBlock *getBasicBlock() const { return BB; }
119 /// getName - Return the name of the corresponding LLVM basic block, or
121 StringRef getName() const;
123 /// getFullName - Return a formatted string to identify this block and its
125 std::string getFullName() const;
127 /// hasAddressTaken - Test whether this block is potentially the target
128 /// of an indirect branch.
129 bool hasAddressTaken() const { return AddressTaken; }
131 /// setHasAddressTaken - Set this block to reflect that it potentially
132 /// is the target of an indirect branch.
133 void setHasAddressTaken() { AddressTaken = true; }
135 /// getParent - Return the MachineFunction containing this basic block.
137 const MachineFunction *getParent() const { return xParent; }
138 MachineFunction *getParent() { return xParent; }
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> {
149 bundle_iterator(IterTy mii) : MII(mii) {}
151 bundle_iterator(Ty &mi) : MII(mi) {
152 assert(!mi.isBundledWithPred() &&
153 "It's not legal to initialize bundle_iterator with a bundled MI");
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");
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) {}
165 Ty &operator*() const { return *MII; }
166 Ty *operator->() const { return &operator*(); }
168 operator Ty*() const { return MII; }
170 bool operator==(const bundle_iterator &x) const {
173 bool operator!=(const bundle_iterator &x) const {
174 return !operator==(x);
177 // Increment and decrement operators...
178 bundle_iterator &operator--() { // predecrement - Back up
180 while (MII->isBundledWithPred());
183 bundle_iterator &operator++() { // preincrement - Advance
184 while (MII->isBundledWithSucc())
189 bundle_iterator operator--(int) { // postdecrement operators...
190 bundle_iterator tmp = *this;
194 bundle_iterator operator++(int) { // postincrement operators...
195 bundle_iterator tmp = *this;
200 IterTy getInstrIterator() const {
205 typedef Instructions::iterator instr_iterator;
206 typedef Instructions::const_iterator const_instr_iterator;
207 typedef std::reverse_iterator<instr_iterator> reverse_instr_iterator;
209 std::reverse_iterator<const_instr_iterator> const_reverse_instr_iterator;
212 bundle_iterator<MachineInstr,instr_iterator> iterator;
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;
219 unsigned size() const { return (unsigned)Insts.size(); }
220 bool empty() const { return Insts.empty(); }
222 MachineInstr& front() { return Insts.front(); }
223 MachineInstr& back() { return Insts.back(); }
224 const MachineInstr& front() const { return Insts.front(); }
225 const MachineInstr& back() const { return Insts.back(); }
227 instr_iterator instr_begin() { return Insts.begin(); }
228 const_instr_iterator instr_begin() const { return Insts.begin(); }
229 instr_iterator instr_end() { return Insts.end(); }
230 const_instr_iterator instr_end() const { return Insts.end(); }
231 reverse_instr_iterator instr_rbegin() { return Insts.rbegin(); }
232 const_reverse_instr_iterator instr_rbegin() const { return Insts.rbegin(); }
233 reverse_instr_iterator instr_rend () { return Insts.rend(); }
234 const_reverse_instr_iterator instr_rend () const { return Insts.rend(); }
236 iterator begin() { return instr_begin(); }
237 const_iterator begin() const { return instr_begin(); }
238 iterator end () { return instr_end(); }
239 const_iterator end () const { return instr_end(); }
240 reverse_iterator rbegin() { return instr_rbegin(); }
241 const_reverse_iterator rbegin() const { return instr_rbegin(); }
242 reverse_iterator rend () { return instr_rend(); }
243 const_reverse_iterator rend () const { return instr_rend(); }
245 inline iterator_range<iterator> terminators() {
246 return iterator_range<iterator>(getFirstTerminator(), end());
248 inline iterator_range<const_iterator> terminators() const {
249 return iterator_range<const_iterator>(getFirstTerminator(), end());
252 // Machine-CFG iterators
253 typedef std::vector<MachineBasicBlock *>::iterator pred_iterator;
254 typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator;
255 typedef std::vector<MachineBasicBlock *>::iterator succ_iterator;
256 typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator;
257 typedef std::vector<MachineBasicBlock *>::reverse_iterator
258 pred_reverse_iterator;
259 typedef std::vector<MachineBasicBlock *>::const_reverse_iterator
260 const_pred_reverse_iterator;
261 typedef std::vector<MachineBasicBlock *>::reverse_iterator
262 succ_reverse_iterator;
263 typedef std::vector<MachineBasicBlock *>::const_reverse_iterator
264 const_succ_reverse_iterator;
265 pred_iterator pred_begin() { return Predecessors.begin(); }
266 const_pred_iterator pred_begin() const { return Predecessors.begin(); }
267 pred_iterator pred_end() { return Predecessors.end(); }
268 const_pred_iterator pred_end() const { return Predecessors.end(); }
269 pred_reverse_iterator pred_rbegin()
270 { return Predecessors.rbegin();}
271 const_pred_reverse_iterator pred_rbegin() const
272 { return Predecessors.rbegin();}
273 pred_reverse_iterator pred_rend()
274 { return Predecessors.rend(); }
275 const_pred_reverse_iterator pred_rend() const
276 { return Predecessors.rend(); }
277 unsigned pred_size() const {
278 return (unsigned)Predecessors.size();
280 bool pred_empty() const { return Predecessors.empty(); }
281 succ_iterator succ_begin() { return Successors.begin(); }
282 const_succ_iterator succ_begin() const { return Successors.begin(); }
283 succ_iterator succ_end() { return Successors.end(); }
284 const_succ_iterator succ_end() const { return Successors.end(); }
285 succ_reverse_iterator succ_rbegin()
286 { return Successors.rbegin(); }
287 const_succ_reverse_iterator succ_rbegin() const
288 { return Successors.rbegin(); }
289 succ_reverse_iterator succ_rend()
290 { return Successors.rend(); }
291 const_succ_reverse_iterator succ_rend() const
292 { return Successors.rend(); }
293 unsigned succ_size() const {
294 return (unsigned)Successors.size();
296 bool succ_empty() const { return Successors.empty(); }
298 inline iterator_range<pred_iterator> predecessors() {
299 return iterator_range<pred_iterator>(pred_begin(), pred_end());
301 inline iterator_range<const_pred_iterator> predecessors() const {
302 return iterator_range<const_pred_iterator>(pred_begin(), pred_end());
304 inline iterator_range<succ_iterator> successors() {
305 return iterator_range<succ_iterator>(succ_begin(), succ_end());
307 inline iterator_range<const_succ_iterator> successors() const {
308 return iterator_range<const_succ_iterator>(succ_begin(), succ_end());
311 // LiveIn management methods.
313 /// addLiveIn - Add the specified register as a live in. Note that it
314 /// is an error to add the same register to the same set more than once.
315 void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); }
317 /// Add PhysReg as live in to this block, and ensure that there is a copy of
318 /// PhysReg to a virtual register of class RC. Return the virtual register
319 /// that is a copy of the live in PhysReg.
320 unsigned addLiveIn(unsigned PhysReg, const TargetRegisterClass *RC);
322 /// removeLiveIn - Remove the specified register from the live in set.
324 void removeLiveIn(unsigned Reg);
326 /// isLiveIn - Return true if the specified register is in the live in set.
328 bool isLiveIn(unsigned Reg) const;
330 // Iteration support for live in sets. These sets are kept in sorted
331 // order by their register number.
332 typedef std::vector<unsigned>::const_iterator livein_iterator;
333 livein_iterator livein_begin() const { return LiveIns.begin(); }
334 livein_iterator livein_end() const { return LiveIns.end(); }
335 bool livein_empty() const { return LiveIns.empty(); }
337 /// getAlignment - Return alignment of the basic block.
338 /// The alignment is specified as log2(bytes).
340 unsigned getAlignment() const { return Alignment; }
342 /// setAlignment - Set alignment of the basic block.
343 /// The alignment is specified as log2(bytes).
345 void setAlignment(unsigned Align) { Alignment = Align; }
347 /// isLandingPad - Returns true if the block is a landing pad. That is
348 /// this basic block is entered via an exception handler.
349 bool isLandingPad() const { return IsLandingPad; }
351 /// setIsLandingPad - Indicates the block is a landing pad. That is
352 /// this basic block is entered via an exception handler.
353 void setIsLandingPad(bool V = true) { IsLandingPad = V; }
355 /// getLandingPadSuccessor - If this block has a successor that is a landing
356 /// pad, return it. Otherwise return NULL.
357 const MachineBasicBlock *getLandingPadSuccessor() const;
359 // Code Layout methods.
361 /// moveBefore/moveAfter - move 'this' block before or after the specified
362 /// block. This only moves the block, it does not modify the CFG or adjust
363 /// potential fall-throughs at the end of the block.
364 void moveBefore(MachineBasicBlock *NewAfter);
365 void moveAfter(MachineBasicBlock *NewBefore);
367 /// updateTerminator - Update the terminator instructions in block to account
368 /// for changes to the layout. If the block previously used a fallthrough,
369 /// it may now need a branch, and if it previously used branching it may now
370 /// be able to use a fallthrough.
371 void updateTerminator();
373 // Machine-CFG mutators
375 /// addSuccessor - Add succ as a successor of this MachineBasicBlock.
376 /// The Predecessors list of succ is automatically updated. WEIGHT
377 /// parameter is stored in Weights list and it may be used by
378 /// MachineBranchProbabilityInfo analysis to calculate branch probability.
380 /// Note that duplicate Machine CFG edges are not allowed.
382 void addSuccessor(MachineBasicBlock *succ, uint32_t weight = 0);
384 /// Set successor weight of a given iterator.
385 void setSuccWeight(succ_iterator I, uint32_t weight);
387 /// removeSuccessor - Remove successor from the successors list of this
388 /// MachineBasicBlock. The Predecessors list of succ is automatically updated.
390 void removeSuccessor(MachineBasicBlock *succ);
392 /// removeSuccessor - Remove specified successor from the successors list of
393 /// this MachineBasicBlock. The Predecessors list of succ is automatically
394 /// updated. Return the iterator to the element after the one removed.
396 succ_iterator removeSuccessor(succ_iterator I);
398 /// replaceSuccessor - Replace successor OLD with NEW and update weight info.
400 void replaceSuccessor(MachineBasicBlock *Old, MachineBasicBlock *New);
403 /// transferSuccessors - Transfers all the successors from MBB to this
404 /// machine basic block (i.e., copies all the successors fromMBB and
405 /// remove all the successors from fromMBB).
406 void transferSuccessors(MachineBasicBlock *fromMBB);
408 /// transferSuccessorsAndUpdatePHIs - Transfers all the successors, as
409 /// in transferSuccessors, and update PHI operands in the successor blocks
410 /// which refer to fromMBB to refer to this.
411 void transferSuccessorsAndUpdatePHIs(MachineBasicBlock *fromMBB);
413 /// isPredecessor - Return true if the specified MBB is a predecessor of this
415 bool isPredecessor(const MachineBasicBlock *MBB) const;
417 /// isSuccessor - Return true if the specified MBB is a successor of this
419 bool isSuccessor(const MachineBasicBlock *MBB) const;
421 /// isLayoutSuccessor - Return true if the specified MBB will be emitted
422 /// immediately after this block, such that if this block exits by
423 /// falling through, control will transfer to the specified MBB. Note
424 /// that MBB need not be a successor at all, for example if this block
425 /// ends with an unconditional branch to some other block.
426 bool isLayoutSuccessor(const MachineBasicBlock *MBB) const;
428 /// canFallThrough - Return true if the block can implicitly transfer
429 /// control to the block after it by falling off the end of it. This should
430 /// return false if it can reach the block after it, but it uses an explicit
431 /// branch to do so (e.g., a table jump). True is a conservative answer.
432 bool canFallThrough();
434 /// Returns a pointer to the first instruction in this block that is not a
435 /// PHINode instruction. When adding instructions to the beginning of the
436 /// basic block, they should be added before the returned value, not before
437 /// the first instruction, which might be PHI.
438 /// Returns end() is there's no non-PHI instruction.
439 iterator getFirstNonPHI();
441 /// SkipPHIsAndLabels - Return the first instruction in MBB after I that is
442 /// not a PHI or a label. This is the correct point to insert copies at the
443 /// beginning of a basic block.
444 iterator SkipPHIsAndLabels(iterator I);
446 /// getFirstTerminator - returns an iterator to the first terminator
447 /// instruction of this basic block. If a terminator does not exist,
449 iterator getFirstTerminator();
450 const_iterator getFirstTerminator() const;
452 /// getFirstInstrTerminator - Same getFirstTerminator but it ignores bundles
453 /// and return an instr_iterator instead.
454 instr_iterator getFirstInstrTerminator();
456 /// getLastNonDebugInstr - returns an iterator to the last non-debug
457 /// instruction in the basic block, or end()
458 iterator getLastNonDebugInstr();
459 const_iterator getLastNonDebugInstr() const;
461 /// SplitCriticalEdge - Split the critical edge from this block to the
462 /// given successor block, and return the newly created block, or null
463 /// if splitting is not possible.
465 /// This function updates LiveVariables, MachineDominatorTree, and
466 /// MachineLoopInfo, as applicable.
467 MachineBasicBlock *SplitCriticalEdge(MachineBasicBlock *Succ, Pass *P);
469 void pop_front() { Insts.pop_front(); }
470 void pop_back() { Insts.pop_back(); }
471 void push_back(MachineInstr *MI) { Insts.push_back(MI); }
473 /// Insert MI into the instruction list before I, possibly inside a bundle.
475 /// If the insertion point is inside a bundle, MI will be added to the bundle,
476 /// otherwise MI will not be added to any bundle. That means this function
477 /// alone can't be used to prepend or append instructions to bundles. See
478 /// MIBundleBuilder::insert() for a more reliable way of doing that.
479 instr_iterator insert(instr_iterator I, MachineInstr *M);
481 /// Insert a range of instructions into the instruction list before I.
482 template<typename IT>
483 void insert(iterator I, IT S, IT E) {
484 Insts.insert(I.getInstrIterator(), S, E);
487 /// Insert MI into the instruction list before I.
488 iterator insert(iterator I, MachineInstr *MI) {
489 assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() &&
490 "Cannot insert instruction with bundle flags");
491 return Insts.insert(I.getInstrIterator(), MI);
494 /// Insert MI into the instruction list after I.
495 iterator insertAfter(iterator I, MachineInstr *MI) {
496 assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() &&
497 "Cannot insert instruction with bundle flags");
498 return Insts.insertAfter(I.getInstrIterator(), MI);
501 /// Remove an instruction from the instruction list and delete it.
503 /// If the instruction is part of a bundle, the other instructions in the
504 /// bundle will still be bundled after removing the single instruction.
505 instr_iterator erase(instr_iterator I);
507 /// Remove an instruction from the instruction list and delete it.
509 /// If the instruction is part of a bundle, the other instructions in the
510 /// bundle will still be bundled after removing the single instruction.
511 instr_iterator erase_instr(MachineInstr *I) {
512 return erase(instr_iterator(I));
515 /// Remove a range of instructions from the instruction list and delete them.
516 iterator erase(iterator I, iterator E) {
517 return Insts.erase(I.getInstrIterator(), E.getInstrIterator());
520 /// Remove an instruction or bundle from the instruction list and delete it.
522 /// If I points to a bundle of instructions, they are all erased.
523 iterator erase(iterator I) {
524 return erase(I, std::next(I));
527 /// Remove an instruction from the instruction list and delete it.
529 /// If I is the head of a bundle of instructions, the whole bundle will be
531 iterator erase(MachineInstr *I) {
532 return erase(iterator(I));
535 /// Remove the unbundled instruction from the instruction list without
538 /// This function can not be used to remove bundled instructions, use
539 /// remove_instr to remove individual instructions from a bundle.
540 MachineInstr *remove(MachineInstr *I) {
541 assert(!I->isBundled() && "Cannot remove bundled instructions");
542 return Insts.remove(I);
545 /// Remove the possibly bundled instruction from the instruction list
546 /// without deleting it.
548 /// If the instruction is part of a bundle, the other instructions in the
549 /// bundle will still be bundled after removing the single instruction.
550 MachineInstr *remove_instr(MachineInstr *I);
556 /// Take an instruction from MBB 'Other' at the position From, and insert it
557 /// into this MBB right before 'Where'.
559 /// If From points to a bundle of instructions, the whole bundle is moved.
560 void splice(iterator Where, MachineBasicBlock *Other, iterator From) {
561 // The range splice() doesn't allow noop moves, but this one does.
563 splice(Where, Other, From, std::next(From));
566 /// Take a block of instructions from MBB 'Other' in the range [From, To),
567 /// and insert them into this MBB right before 'Where'.
569 /// The instruction at 'Where' must not be included in the range of
570 /// instructions to move.
571 void splice(iterator Where, MachineBasicBlock *Other,
572 iterator From, iterator To) {
573 Insts.splice(Where.getInstrIterator(), Other->Insts,
574 From.getInstrIterator(), To.getInstrIterator());
577 /// removeFromParent - This method unlinks 'this' from the containing
578 /// function, and returns it, but does not delete it.
579 MachineBasicBlock *removeFromParent();
581 /// eraseFromParent - This method unlinks 'this' from the containing
582 /// function and deletes it.
583 void eraseFromParent();
585 /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to
586 /// 'Old', change the code and CFG so that it branches to 'New' instead.
587 void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New);
589 /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in
590 /// the CFG to be inserted. If we have proven that MBB can only branch to
591 /// DestA and DestB, remove any other MBB successors from the CFG. DestA and
592 /// DestB can be null. Besides DestA and DestB, retain other edges leading
593 /// to LandingPads (currently there can be only one; we don't check or require
594 /// that here). Note it is possible that DestA and/or DestB are LandingPads.
595 bool CorrectExtraCFGEdges(MachineBasicBlock *DestA,
596 MachineBasicBlock *DestB,
599 /// findDebugLoc - find the next valid DebugLoc starting at MBBI, skipping
600 /// any DBG_VALUE instructions. Return UnknownLoc if there is none.
601 DebugLoc findDebugLoc(instr_iterator MBBI);
602 DebugLoc findDebugLoc(iterator MBBI) {
603 return findDebugLoc(MBBI.getInstrIterator());
606 /// Possible outcome of a register liveness query to computeRegisterLiveness()
607 enum LivenessQueryResult {
608 LQR_Live, ///< Register is known to be live.
609 LQR_OverlappingLive, ///< Register itself is not live, but some overlapping
611 LQR_Dead, ///< Register is known to be dead.
612 LQR_Unknown ///< Register liveness not decidable from local
616 /// computeRegisterLiveness - Return whether (physical) register \c Reg
617 /// has been <def>ined and not <kill>ed as of just before \c MI.
619 /// Search is localised to a neighborhood of
620 /// \c Neighborhood instructions before (searching for defs or kills) and
621 /// Neighborhood instructions after (searching just for defs) MI.
623 /// \c Reg must be a physical register.
624 LivenessQueryResult computeRegisterLiveness(const TargetRegisterInfo *TRI,
625 unsigned Reg, MachineInstr *MI,
626 unsigned Neighborhood=10);
628 // Debugging methods.
630 void print(raw_ostream &OS, SlotIndexes* = nullptr) const;
632 // Printing method used by LoopInfo.
633 void printAsOperand(raw_ostream &OS, bool PrintType = true);
635 /// getNumber - MachineBasicBlocks are uniquely numbered at the function
636 /// level, unless they're not in a MachineFunction yet, in which case this
639 int getNumber() const { return Number; }
640 void setNumber(int N) { Number = N; }
642 /// getSymbol - Return the MCSymbol for this basic block.
644 MCSymbol *getSymbol() const;
648 /// getWeightIterator - Return weight iterator corresponding to the I
649 /// successor iterator.
650 weight_iterator getWeightIterator(succ_iterator I);
651 const_weight_iterator getWeightIterator(const_succ_iterator I) const;
653 friend class MachineBranchProbabilityInfo;
655 /// getSuccWeight - Return weight of the edge from this block to MBB. This
656 /// method should NOT be called directly, but by using getEdgeWeight method
657 /// from MachineBranchProbabilityInfo class.
658 uint32_t getSuccWeight(const_succ_iterator Succ) const;
661 // Methods used to maintain doubly linked list of blocks...
662 friend struct ilist_traits<MachineBasicBlock>;
664 // Machine-CFG mutators
666 /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock.
667 /// Don't do this unless you know what you're doing, because it doesn't
668 /// update pred's successors list. Use pred->addSuccessor instead.
670 void addPredecessor(MachineBasicBlock *pred);
672 /// removePredecessor - Remove pred as a predecessor of this
673 /// MachineBasicBlock. Don't do this unless you know what you're
674 /// doing, because it doesn't update pred's successors list. Use
675 /// pred->removeSuccessor instead.
677 void removePredecessor(MachineBasicBlock *pred);
680 raw_ostream& operator<<(raw_ostream &OS, const MachineBasicBlock &MBB);
682 // This is useful when building IndexedMaps keyed on basic block pointers.
683 struct MBB2NumberFunctor :
684 public std::unary_function<const MachineBasicBlock*, unsigned> {
685 unsigned operator()(const MachineBasicBlock *MBB) const {
686 return MBB->getNumber();
690 //===--------------------------------------------------------------------===//
691 // GraphTraits specializations for machine basic block graphs (machine-CFGs)
692 //===--------------------------------------------------------------------===//
694 // Provide specializations of GraphTraits to be able to treat a
695 // MachineFunction as a graph of MachineBasicBlocks...
698 template <> struct GraphTraits<MachineBasicBlock *> {
699 typedef MachineBasicBlock NodeType;
700 typedef MachineBasicBlock::succ_iterator ChildIteratorType;
702 static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; }
703 static inline ChildIteratorType child_begin(NodeType *N) {
704 return N->succ_begin();
706 static inline ChildIteratorType child_end(NodeType *N) {
707 return N->succ_end();
711 template <> struct GraphTraits<const MachineBasicBlock *> {
712 typedef const MachineBasicBlock NodeType;
713 typedef MachineBasicBlock::const_succ_iterator ChildIteratorType;
715 static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; }
716 static inline ChildIteratorType child_begin(NodeType *N) {
717 return N->succ_begin();
719 static inline ChildIteratorType child_end(NodeType *N) {
720 return N->succ_end();
724 // Provide specializations of GraphTraits to be able to treat a
725 // MachineFunction as a graph of MachineBasicBlocks... and to walk it
726 // in inverse order. Inverse order for a function is considered
727 // to be when traversing the predecessor edges of a MBB
728 // instead of the successor edges.
730 template <> struct GraphTraits<Inverse<MachineBasicBlock*> > {
731 typedef MachineBasicBlock NodeType;
732 typedef MachineBasicBlock::pred_iterator ChildIteratorType;
733 static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) {
736 static inline ChildIteratorType child_begin(NodeType *N) {
737 return N->pred_begin();
739 static inline ChildIteratorType child_end(NodeType *N) {
740 return N->pred_end();
744 template <> struct GraphTraits<Inverse<const MachineBasicBlock*> > {
745 typedef const MachineBasicBlock NodeType;
746 typedef MachineBasicBlock::const_pred_iterator ChildIteratorType;
747 static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) {
750 static inline ChildIteratorType child_begin(NodeType *N) {
751 return N->pred_begin();
753 static inline ChildIteratorType child_end(NodeType *N) {
754 return N->pred_end();
760 /// MachineInstrSpan provides an interface to get an iteration range
761 /// containing the instruction it was initialized with, along with all
762 /// those instructions inserted prior to or following that instruction
763 /// at some point after the MachineInstrSpan is constructed.
764 class MachineInstrSpan {
765 MachineBasicBlock &MBB;
766 MachineBasicBlock::iterator I, B, E;
768 MachineInstrSpan(MachineBasicBlock::iterator I)
769 : MBB(*I->getParent()),
771 B(I == MBB.begin() ? MBB.end() : std::prev(I)),
774 MachineBasicBlock::iterator begin() {
775 return B == MBB.end() ? MBB.begin() : std::next(B);
777 MachineBasicBlock::iterator end() { return E; }
778 bool empty() { return begin() == end(); }
780 MachineBasicBlock::iterator getInitial() { return I; }
783 } // End llvm namespace