MachineBasicBlock.h revision 8e5f2c6f65841542e2a7092553fe42a00048e4c7
151a8d8528135ba4e3e4cf7cd711a9e47b19078a3Chris Lattner//===-- llvm/CodeGen/MachineBasicBlock.h ------------------------*- C++ -*-===// 2ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman// 36fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// The LLVM Compiler Infrastructure 46fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 7ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman// 86fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell//===----------------------------------------------------------------------===// 9ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman// 10e8b5413e5d0c7c0fc5b384e975c4ca87f4c00699Chris Lattner// Collect the sequence of machine instructions for a basic block. 11e8b5413e5d0c7c0fc5b384e975c4ca87f4c00699Chris Lattner// 1251a8d8528135ba4e3e4cf7cd711a9e47b19078a3Chris Lattner//===----------------------------------------------------------------------===// 13deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 14fce1143bcfa73f61845002fa50473d1a01384202Misha Brukman#ifndef LLVM_CODEGEN_MACHINEBASICBLOCK_H 15fce1143bcfa73f61845002fa50473d1a01384202Misha Brukman#define LLVM_CODEGEN_MACHINEBASICBLOCK_H 16deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 17c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos#include "llvm/CodeGen/MachineInstr.h" 18551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/GraphTraits.h" 19b5ebf15b2b2ce8989caf1a1114b05d80b0f9bd48Bill Wendling#include "llvm/Support/Streams.h" 20d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 21d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 225e61fa95196b85281eec655787e9c73267532bd1Chris Lattner class MachineFunction; 23d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 2494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenostemplate <> 258e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanstruct alist_traits<MachineInstr, MachineInstr> { 261fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattnerprotected: 278e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman // this is only set by the MachineBasicBlock owning the LiveList 2894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos friend class MachineBasicBlock; 298e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman MachineBasicBlock* Parent; 3094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 318e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef alist_iterator<MachineInstr> iterator; 3294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 338e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanpublic: 348e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman alist_traits<MachineInstr, MachineInstr>() : Parent(0) { } 3594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 36aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void addNodeToList(MachineInstr* N); 37aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void removeNodeFromList(MachineInstr* N); 388e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void transferNodesFromList(alist_traits &, iterator, iterator); 398e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void deleteNode(MachineInstr *N); 4094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos}; 4194dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 42aec11f1decda111112c39803cb89dace81cd0568Chris Lattnerclass BasicBlock; 43deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 44d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattnerclass MachineBasicBlock { 458e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef alist<MachineInstr> Instructions; 46c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos Instructions Insts; 471194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *BB; 48c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int Number; 49f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *xParent; 50f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner 5113d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// Predecessors/Successors - Keep track of the predecessor / successor 5213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// basicblocks. 5313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Predecessors; 5413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Successors; 5513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 5613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// LiveIns - Keep track of the physical registers that are livein of 5713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// the basicblock. 5813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<unsigned> LiveIns; 59fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 60fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// Alignment - Alignment of the basic block. Zero if the basic block does 61fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// not need to be aligned. 62fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned Alignment; 6330b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 6430b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// IsLandingPad - Indicate that this basic block is entered via an 6530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// exception handler. 6630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool IsLandingPad; 6713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 688e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman explicit MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb); 698e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 708e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman ~MachineBasicBlock() {} 7117fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner 728e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman // MachineBasicBlocks are allocated and owned by MachineFunction. 738e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman friend class MachineFunction; 74ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 758e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanpublic: 76d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// getBasicBlock - Return the LLVM basic block that this instance 77d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// corresponded to originally. 78d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// 791194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *getBasicBlock() const { return BB; } 805e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 815e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// getParent - Return the MachineFunction containing this basic block. 825e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// 83f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner const MachineFunction *getParent() const { return xParent; } 84f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *getParent() { return xParent; } 855e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 868e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::iterator iterator; 878e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::const_iterator const_iterator; 88deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 89deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<iterator> reverse_iterator; 90deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 9134cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned size() const { return (unsigned)Insts.size(); } 92deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve bool empty() const { return Insts.empty(); } 93deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 94c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& front() { return Insts.front(); } 95c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& back() { return Insts.back(); } 96deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 97deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator begin() { return Insts.begin(); } 98deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator begin() const { return Insts.begin(); } 99deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator end() { return Insts.end(); } 100deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator end() const { return Insts.end(); } 101deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rbegin() { return Insts.rbegin(); } 102deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rbegin() const { return Insts.rbegin(); } 103deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rend () { return Insts.rend(); } 104deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rend () const { return Insts.rend(); } 105deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 10676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG iterators 10776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator pred_iterator; 10876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator; 10976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator succ_iterator; 11076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator; 1116603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1126603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator; 1136603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1146603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator; 1156603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1166603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator; 1176603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1186603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator; 119ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 120cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_begin() { return Predecessors.begin(); } 121cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_begin() const { return Predecessors.begin(); } 122cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_end() { return Predecessors.end(); } 123cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_end() const { return Predecessors.end(); } 1246603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rbegin() 1256603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1266603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rbegin() const 1276603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1286603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rend() 1296603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 1306603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rend() const 1316603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 13234cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned pred_size() const { 13334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Predecessors.size(); 13434cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 135cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool pred_empty() const { return Predecessors.empty(); } 136cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_begin() { return Successors.begin(); } 137cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_begin() const { return Successors.begin(); } 138cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_end() { return Successors.end(); } 139cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_end() const { return Successors.end(); } 1406603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rbegin() 1416603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1426603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rbegin() const 1436603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1446603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rend() 1456603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 1466603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rend() const 1476603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 14834cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned succ_size() const { 14934cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Successors.size(); 15034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 151cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool succ_empty() const { return Successors.empty(); } 15276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 15313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // LiveIn management methods. 15413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 15513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// addLiveIn - Add the specified register as a live in. Note that it 15613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// is an error to add the same register to the same set more than once. 15713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); } 15813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 159b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// removeLiveIn - Remove the specified register from the live in set. 160b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// 161b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng void removeLiveIn(unsigned Reg); 162b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng 163a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// isLiveIn - Return true if the specified register is in the live in set. 164a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// 165a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng bool isLiveIn(unsigned Reg) const; 166a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng 16713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // Iteration support for live in sets. These sets are kept in sorted 16813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // order by their register number. 169b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::iterator livein_iterator; 170b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::const_iterator const_livein_iterator; 171b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_begin() { return LiveIns.begin(); } 172b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_begin() const { return LiveIns.begin(); } 173b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_end() { return LiveIns.end(); } 174b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_end() const { return LiveIns.end(); } 17513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng bool livein_empty() const { return LiveIns.empty(); } 17613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 177fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// getAlignment - Return alignment of the basic block. 178fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 179fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned getAlignment() const { return Alignment; } 180fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 181fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// setAlignment - Set alignment of the basic block. 182fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 183fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng void setAlignment(unsigned Align) { Alignment = Align; } 184fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 18530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// isLandingPad - Returns true if the block is a landing pad. That is 18630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 18730b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool isLandingPad() const { return IsLandingPad; } 18830b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 18930b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// setIsLandingPad - Indicates the block is a landing pad. That is 19030b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 19130b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey void setIsLandingPad() { IsLandingPad = true; } 19230b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 19334ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner // Code Layout methods. 19434ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 19534ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// moveBefore/moveAfter - move 'this' block before or after the specified 19634ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// block. This only moves the block, it does not modify the CFG or adjust 19734ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// potential fall-throughs at the end of the block. 19834ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveBefore(MachineBasicBlock *NewAfter); 19934ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveAfter(MachineBasicBlock *NewBefore); 20034ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 20176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG mutators 20234ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 20376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addSuccessor - Add succ as a successor of this MachineBasicBlock. 20476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// The Predecessors list of succ is automatically updated. 20576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2063dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addSuccessor(MachineBasicBlock *succ); 20776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 208dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove successor from the successors list of this 20976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. The Predecessors list of succ is automatically updated. 21076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2113dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removeSuccessor(MachineBasicBlock *succ); 212dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner 213dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove specified successor from the successors list of 214dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// this MachineBasicBlock. The Predecessors list of succ is automatically 2158a46d342d8cbca7c9c7be6c66007d41329babad0David Greene /// updated. Return the iterator to the element after the one removed. 216dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// 2178a46d342d8cbca7c9c7be6c66007d41329babad0David Greene succ_iterator removeSuccessor(succ_iterator I); 218cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner 21963307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// transferSuccessors - Transfers all the successors from MBB to this 22063307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// machine basic block (i.e., copies all the successors fromMBB and 22163307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// remove all the successors fromBB). 22263307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang void transferSuccessors(MachineBasicBlock *fromMBB); 22363307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang 224cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// isSuccessor - Return true if the specified MBB is a successor of this 225cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// block. 2264f098788d303bed05da6000f3ff24177aad56623Evan Cheng bool isSuccessor(MachineBasicBlock *MBB) const; 22776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 228743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// getFirstTerminator - returns an iterator to the first terminator 229743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// instruction of this basic block. If a terminator does not exist, 230743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// it returns end() 231743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos iterator getFirstTerminator(); 232743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos 2330bbcd6bfd1a90c2aa7386a88ba9fc9aba47d03a7Brian Gaeke void pop_front() { Insts.pop_front(); } 234f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void pop_back() { Insts.pop_back(); } 235deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void push_back(MachineInstr *MI) { Insts.push_back(MI); } 236deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve template<typename IT> 237deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); } 238deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); } 239deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 24046d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve // erase - Remove the specified element or range from the instruction list. 241c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos // These functions delete any instructions removed. 242deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve // 24346d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve iterator erase(iterator I) { return Insts.erase(I); } 244deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator erase(iterator I, iterator E) { return Insts.erase(I, E); } 24583706a5a3a6f19451765b743c5a72b62f74eb71aChris Lattner MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); } 246da44b151259525abc9c299f89b9532f3a9883b4eBrian Gaeke void clear() { Insts.clear(); } 247ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 248f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// splice - Take a block of instructions from MBB 'Other' in the range [From, 249f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// To), and insert them into this MBB right before 'where'. 250f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void splice(iterator where, MachineBasicBlock *Other, iterator From, 251f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner iterator To) { 252f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner Insts.splice(where, Other->Insts, From, To); 253f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner } 2548e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 2558e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// removeFromParent - This method unlinks 'this' from the containing 2568e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function, and returns it, but does not delete it. 2578e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman MachineBasicBlock *removeFromParent(); 2588e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2598e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// eraseFromParent - This method unlinks 'this' from the containing 2608e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function and deletes it. 2618e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void eraseFromParent(); 2628e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2630370fad74b48388412c52d1325512f2c218487faEvan Cheng /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to 2640370fad74b48388412c52d1325512f2c218487faEvan Cheng /// 'Old', change the code and CFG so that it branches to 'New' instead. 2650370fad74b48388412c52d1325512f2c218487faEvan Cheng void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New); 2660370fad74b48388412c52d1325512f2c218487faEvan Cheng 2672bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in 2682bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// the CFG to be inserted. If we have proven that MBB can only branch to 2692bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestA and DestB, remove any other MBB successors from the CFG. DestA and 2702bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestB can be null. Besides DestA and DestB, retain other edges leading 2712bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// to LandingPads (currently there can be only one; we don't check or require 2722bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// that here). Note it is possible that DestA and/or DestB are LandingPads. 2732bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool CorrectExtraCFGEdges(MachineBasicBlock *DestA, 2742bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng MachineBasicBlock *DestB, 2752bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool isCond); 2762bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng 277f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke // Debugging methods. 278f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void dump() const; 279f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void print(std::ostream &OS) const; 2805c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 281f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke 282da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// getNumber - MachineBasicBlocks are uniquely numbered at the function 283da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// level, unless they're not in a MachineFunction yet, in which case this 284da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// will return -1. 285da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// 286c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int getNumber() const { return Number; } 28720a6d8e63056cc2025e7143a5f7226e079e0bc80Chris Lattner void setNumber(int N) { Number = N; } 288c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke 2898e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattnerprivate: // Methods used to maintain doubly linked list of blocks... 2908e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman friend struct alist_traits<MachineBasicBlock>; 2918560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 2928560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke // Machine-CFG mutators 2938560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 2948560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock. 2958560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// Don't do this unless you know what you're doing, because it doesn't 2968560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// update pred's successors list. Use pred->addSuccessor instead. 2978560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 2983dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addPredecessor(MachineBasicBlock *pred); 2998560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3008560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// removePredecessor - Remove pred as a predecessor of this 3018560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// MachineBasicBlock. Don't do this unless you know what you're 3028560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// doing, because it doesn't update pred's successors list. Use 3038560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// pred->removeSuccessor instead. 3048560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3053dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removePredecessor(MachineBasicBlock *pred); 306deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve}; 307deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 3081ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattnerstd::ostream& operator<<(std::ostream &OS, const MachineBasicBlock &MBB); 3090aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3100aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3110aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// GraphTraits specializations for machine basic block graphs (machine-CFGs) 3120aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3130aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3140aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3150aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... 3160aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3170aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3180aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<MachineBasicBlock *> { 3190aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3200aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::succ_iterator ChildIteratorType; 3210aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3220aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; } 323ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3240aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3250aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 326ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3270aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3280aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3290aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3300aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3310aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<const MachineBasicBlock *> { 3320aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3330aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_succ_iterator ChildIteratorType; 3340aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3350aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; } 336ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3370aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3380aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 339ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3400aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3410aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3420aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3430aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3440aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3450aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... and to walk it 3460aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// in inverse order. Inverse order for a function is considered 3470aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// to be when traversing the predecessor edges of a MBB 3480aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// instead of the successor edges. 3490aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3500aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<MachineBasicBlock*> > { 3510aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3520aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::pred_iterator ChildIteratorType; 3530aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) { 3540aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return G.Graph; 3550aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 356ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3570aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3580aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 359ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3600aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3610aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3620aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3630aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3640aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<const MachineBasicBlock*> > { 3650aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3660aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_pred_iterator ChildIteratorType; 3670aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) { 368ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman return G.Graph; 3690aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 370ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3710aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3720aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 373ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3740aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3750aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3760aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3770aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 378d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 379deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 380deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve#endif 381