MachineBasicBlock.h revision 63307c335aa08b0d6a75f81d64d79af7e90eb78b
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" 19551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/ilist" 20b5ebf15b2b2ce8989caf1a1114b05d80b0f9bd48Bill Wendling#include "llvm/Support/Streams.h" 21d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 22d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 235e61fa95196b85281eec655787e9c73267532bd1Chris Lattner class MachineFunction; 24d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 2594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos// ilist_traits 2694dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenostemplate <> 271fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattnerstruct ilist_traits<MachineInstr> { 281fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattnerprotected: 2994dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos // this is only set by the MachineBasicBlock owning the ilist 3094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos friend class MachineBasicBlock; 3194dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos MachineBasicBlock* parent; 3294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 3394dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenospublic: 3494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos ilist_traits<MachineInstr>() : parent(0) { } 3594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 36f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner static MachineInstr* getPrev(MachineInstr* N) { return N->Prev; } 37f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner static MachineInstr* getNext(MachineInstr* N) { return N->Next; } 3894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 3994dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static const MachineInstr* 40f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner getPrev(const MachineInstr* N) { return N->Prev; } 4194dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 4294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static const MachineInstr* 43f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner getNext(const MachineInstr* N) { return N->Next; } 4494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 45f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner static void setPrev(MachineInstr* N, MachineInstr* prev) { N->Prev = prev; } 46f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner static void setNext(MachineInstr* N, MachineInstr* next) { N->Next = next; } 4794dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 48bbec41dbaca7ced24f77ec7173f0c1e317aae908Chris Lattner static MachineInstr* createSentinel(); 49bbec41dbaca7ced24f77ec7173f0c1e317aae908Chris Lattner static void destroySentinel(MachineInstr *MI) { delete MI; } 50aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void addNodeToList(MachineInstr* N); 51aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void removeNodeFromList(MachineInstr* N); 52aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void transferNodesFromList( 53aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos iplist<MachineInstr, ilist_traits<MachineInstr> >& toList, 54aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos ilist_iterator<MachineInstr> first, 55aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos ilist_iterator<MachineInstr> last); 5694dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos}; 5794dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 58aec11f1decda111112c39803cb89dace81cd0568Chris Lattnerclass BasicBlock; 59deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 60d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattnerclass MachineBasicBlock { 61c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr> Instructions; 62c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos Instructions Insts; 638e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *Prev, *Next; 641194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *BB; 65c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int Number; 66f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *xParent; 67f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner 68f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner void setParent(MachineFunction *P) { xParent = P; } 6976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 7013d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// Predecessors/Successors - Keep track of the predecessor / successor 7113d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// basicblocks. 7213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Predecessors; 7313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Successors; 7413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 7513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// LiveIns - Keep track of the physical registers that are livein of 7613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// the basicblock. 7713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<unsigned> LiveIns; 78fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 79fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// Alignment - Alignment of the basic block. Zero if the basic block does 80fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// not need to be aligned. 81fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned Alignment; 8230b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 8330b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// IsLandingPad - Indicate that this basic block is entered via an 8430b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// exception handler. 8530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool IsLandingPad; 8613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 87deb9654056939a12981446f6ed1139dca3412746Vikram S. Advepublic: 88f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner explicit MachineBasicBlock(const BasicBlock *bb = 0) 89fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng : Prev(0), Next(0), BB(bb), Number(-1), xParent(0), 90fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng Alignment(0), IsLandingPad(false) { 91ab8672c8bb83e722b856eac67863542ea7e0cbb2Alkis Evlogimenos Insts.parent = this; 92ab8672c8bb83e722b856eac67863542ea7e0cbb2Alkis Evlogimenos } 9317fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner 9417fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner ~MachineBasicBlock(); 95ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 96d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// getBasicBlock - Return the LLVM basic block that this instance 97d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// corresponded to originally. 98d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// 991194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *getBasicBlock() const { return BB; } 1005e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 1015e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// getParent - Return the MachineFunction containing this basic block. 1025e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// 103f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner const MachineFunction *getParent() const { return xParent; } 104f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *getParent() { return xParent; } 1055e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 106c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr>::iterator iterator; 107c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr>::const_iterator const_iterator; 108deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 109deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<iterator> reverse_iterator; 110deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 11134cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned size() const { return (unsigned)Insts.size(); } 112deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve bool empty() const { return Insts.empty(); } 113deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 114c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& front() { return Insts.front(); } 115c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& back() { return Insts.back(); } 116deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 117deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator begin() { return Insts.begin(); } 118deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator begin() const { return Insts.begin(); } 119deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator end() { return Insts.end(); } 120deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator end() const { return Insts.end(); } 121deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rbegin() { return Insts.rbegin(); } 122deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rbegin() const { return Insts.rbegin(); } 123deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rend () { return Insts.rend(); } 124deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rend () const { return Insts.rend(); } 125deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 12676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG iterators 12776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator pred_iterator; 12876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator; 12976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator succ_iterator; 13076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator; 1316603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1326603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator; 1336603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1346603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator; 1356603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1366603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator; 1376603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1386603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator; 139ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 140cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_begin() { return Predecessors.begin(); } 141cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_begin() const { return Predecessors.begin(); } 142cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_end() { return Predecessors.end(); } 143cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_end() const { return Predecessors.end(); } 1446603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rbegin() 1456603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1466603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rbegin() const 1476603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1486603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rend() 1496603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 1506603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rend() const 1516603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 15234cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned pred_size() const { 15334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Predecessors.size(); 15434cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 155cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool pred_empty() const { return Predecessors.empty(); } 156cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_begin() { return Successors.begin(); } 157cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_begin() const { return Successors.begin(); } 158cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_end() { return Successors.end(); } 159cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_end() const { return Successors.end(); } 1606603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rbegin() 1616603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1626603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rbegin() const 1636603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1646603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rend() 1656603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 1666603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rend() const 1676603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 16834cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned succ_size() const { 16934cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Successors.size(); 17034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 171cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool succ_empty() const { return Successors.empty(); } 17276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 17313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // LiveIn management methods. 17413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 17513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// addLiveIn - Add the specified register as a live in. Note that it 17613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// is an error to add the same register to the same set more than once. 17713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); } 17813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 179b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// removeLiveIn - Remove the specified register from the live in set. 180b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// 181b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng void removeLiveIn(unsigned Reg); 182b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng 183a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// isLiveIn - Return true if the specified register is in the live in set. 184a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// 185a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng bool isLiveIn(unsigned Reg) const; 186a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng 18713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // Iteration support for live in sets. These sets are kept in sorted 18813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // order by their register number. 189b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::iterator livein_iterator; 190b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::const_iterator const_livein_iterator; 191b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_begin() { return LiveIns.begin(); } 192b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_begin() const { return LiveIns.begin(); } 193b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_end() { return LiveIns.end(); } 194b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_end() const { return LiveIns.end(); } 19513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng bool livein_empty() const { return LiveIns.empty(); } 19613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 197fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// getAlignment - Return alignment of the basic block. 198fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 199fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned getAlignment() const { return Alignment; } 200fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 201fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// setAlignment - Set alignment of the basic block. 202fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 203fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng void setAlignment(unsigned Align) { Alignment = Align; } 204fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 20530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// isLandingPad - Returns true if the block is a landing pad. That is 20630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 20730b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool isLandingPad() const { return IsLandingPad; } 20830b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 20930b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// setIsLandingPad - Indicates the block is a landing pad. That is 21030b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 21130b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey void setIsLandingPad() { IsLandingPad = true; } 21230b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 21334ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner // Code Layout methods. 21434ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21534ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// moveBefore/moveAfter - move 'this' block before or after the specified 21634ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// block. This only moves the block, it does not modify the CFG or adjust 21734ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// potential fall-throughs at the end of the block. 21834ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveBefore(MachineBasicBlock *NewAfter); 21934ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveAfter(MachineBasicBlock *NewBefore); 22034ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 22176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG mutators 22234ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 22376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addSuccessor - Add succ as a successor of this MachineBasicBlock. 22476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// The Predecessors list of succ is automatically updated. 22576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2263dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addSuccessor(MachineBasicBlock *succ); 22776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 228dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove successor from the successors list of this 22976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. The Predecessors list of succ is automatically updated. 23076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2313dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removeSuccessor(MachineBasicBlock *succ); 232dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner 233dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove specified successor from the successors list of 234dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// this MachineBasicBlock. The Predecessors list of succ is automatically 2358a46d342d8cbca7c9c7be6c66007d41329babad0David Greene /// updated. Return the iterator to the element after the one removed. 236dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// 2378a46d342d8cbca7c9c7be6c66007d41329babad0David Greene succ_iterator removeSuccessor(succ_iterator I); 238cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner 23963307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// transferSuccessors - Transfers all the successors from MBB to this 24063307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// machine basic block (i.e., copies all the successors fromMBB and 24163307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// remove all the successors fromBB). 24263307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang void transferSuccessors(MachineBasicBlock *fromMBB); 24363307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang 244cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// isSuccessor - Return true if the specified MBB is a successor of this 245cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// block. 2464f098788d303bed05da6000f3ff24177aad56623Evan Cheng bool isSuccessor(MachineBasicBlock *MBB) const; 24776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 248743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// getFirstTerminator - returns an iterator to the first terminator 249743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// instruction of this basic block. If a terminator does not exist, 250743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// it returns end() 251743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos iterator getFirstTerminator(); 252743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos 2530bbcd6bfd1a90c2aa7386a88ba9fc9aba47d03a7Brian Gaeke void pop_front() { Insts.pop_front(); } 254f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void pop_back() { Insts.pop_back(); } 255deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void push_back(MachineInstr *MI) { Insts.push_back(MI); } 256deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve template<typename IT> 257deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); } 258deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); } 259deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 26046d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve // erase - Remove the specified element or range from the instruction list. 261c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos // These functions delete any instructions removed. 262deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve // 26346d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve iterator erase(iterator I) { return Insts.erase(I); } 264deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator erase(iterator I, iterator E) { return Insts.erase(I, E); } 26583706a5a3a6f19451765b743c5a72b62f74eb71aChris Lattner MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); } 266da44b151259525abc9c299f89b9532f3a9883b4eBrian Gaeke void clear() { Insts.clear(); } 267ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 268f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// splice - Take a block of instructions from MBB 'Other' in the range [From, 269f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// To), and insert them into this MBB right before 'where'. 270f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void splice(iterator where, MachineBasicBlock *Other, iterator From, 271f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner iterator To) { 272f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner Insts.splice(where, Other->Insts, From, To); 273f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner } 2748e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 2750370fad74b48388412c52d1325512f2c218487faEvan Cheng /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to 2760370fad74b48388412c52d1325512f2c218487faEvan Cheng /// 'Old', change the code and CFG so that it branches to 'New' instead. 2770370fad74b48388412c52d1325512f2c218487faEvan Cheng void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New); 2780370fad74b48388412c52d1325512f2c218487faEvan Cheng 2792bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in 2802bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// the CFG to be inserted. If we have proven that MBB can only branch to 2812bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestA and DestB, remove any other MBB successors from the CFG. DestA and 2822bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestB can be null. Besides DestA and DestB, retain other edges leading 2832bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// to LandingPads (currently there can be only one; we don't check or require 2842bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// that here). Note it is possible that DestA and/or DestB are LandingPads. 2852bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool CorrectExtraCFGEdges(MachineBasicBlock *DestA, 2862bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng MachineBasicBlock *DestB, 2872bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool isCond); 2882bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng 289f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke // Debugging methods. 290f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void dump() const; 291f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void print(std::ostream &OS) const; 2925c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 293f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke 294da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// getNumber - MachineBasicBlocks are uniquely numbered at the function 295da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// level, unless they're not in a MachineFunction yet, in which case this 296da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// will return -1. 297da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// 298c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int getNumber() const { return Number; } 29920a6d8e63056cc2025e7143a5f7226e079e0bc80Chris Lattner void setNumber(int N) { Number = N; } 300c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke 3018e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattnerprivate: // Methods used to maintain doubly linked list of blocks... 3021fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattner friend struct ilist_traits<MachineBasicBlock>; 3038e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 3048e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *getPrev() const { return Prev; } 3058e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *getNext() const { return Next; } 3068e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner void setPrev(MachineBasicBlock *P) { Prev = P; } 3078e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner void setNext(MachineBasicBlock *N) { Next = N; } 3088560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3098560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke // Machine-CFG mutators 3108560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3118560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock. 3128560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// Don't do this unless you know what you're doing, because it doesn't 3138560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// update pred's successors list. Use pred->addSuccessor instead. 3148560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3153dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addPredecessor(MachineBasicBlock *pred); 3168560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3178560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// removePredecessor - Remove pred as a predecessor of this 3188560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// MachineBasicBlock. Don't do this unless you know what you're 3198560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// doing, because it doesn't update pred's successors list. Use 3208560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// pred->removeSuccessor instead. 3218560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3223dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removePredecessor(MachineBasicBlock *pred); 323deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve}; 324deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 3251ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattnerstd::ostream& operator<<(std::ostream &OS, const MachineBasicBlock &MBB); 3260aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3270aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3280aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// GraphTraits specializations for machine basic block graphs (machine-CFGs) 3290aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3300aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3310aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3320aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... 3330aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3340aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3350aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<MachineBasicBlock *> { 3360aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3370aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::succ_iterator ChildIteratorType; 3380aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3390aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; } 340ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3410aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3420aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 343ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3440aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3450aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3460aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3470aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3480aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<const MachineBasicBlock *> { 3490aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3500aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_succ_iterator ChildIteratorType; 3510aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3520aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; } 353ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3540aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3550aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 356ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3570aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3580aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3590aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3600aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3610aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3620aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... and to walk it 3630aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// in inverse order. Inverse order for a function is considered 3640aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// to be when traversing the predecessor edges of a MBB 3650aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// instead of the successor edges. 3660aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3670aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<MachineBasicBlock*> > { 3680aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3690aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::pred_iterator ChildIteratorType; 3700aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) { 3710aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return G.Graph; 3720aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 373ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3740aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3750aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 376ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3770aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3780aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3790aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3800aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3810aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<const MachineBasicBlock*> > { 3820aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3830aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_pred_iterator ChildIteratorType; 3840aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) { 385ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman return G.Graph; 3860aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 387ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3880aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3890aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 390ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3910aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3920aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3930aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3940aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 395d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 396deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 397deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve#endif 398