MachineBasicBlock.h revision 6ade6f55a836129af634074e96f660ff23f59a30
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 { 22fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman 23fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanclass BasicBlock; 24fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanclass MachineFunction; 25d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 2694dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenostemplate <> 278e4018e2de52c534405d7155c7009d0b35afb861Cedric Venetstruct ilist_traits<MachineInstr> : public ilist_default_traits<MachineInstr> { 288e4018e2de52c534405d7155c7009d0b35afb861Cedric Venetprivate: 29fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman mutable MachineInstr Sentinel; 30fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman 318e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman // this is only set by the MachineBasicBlock owning the LiveList 3294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos friend class MachineBasicBlock; 338e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman MachineBasicBlock* Parent; 3494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 358e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanpublic: 36fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman MachineInstr *createSentinel() const { return &Sentinel; } 37fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void destroySentinel(MachineInstr *) const {} 3894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 39aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void addNodeToList(MachineInstr* N); 40aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void removeNodeFromList(MachineInstr* N); 41fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void transferNodesFromList(ilist_traits &SrcTraits, 42fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman ilist_iterator<MachineInstr> first, 43fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman ilist_iterator<MachineInstr> last); 448e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void deleteNode(MachineInstr *N); 45fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanprivate: 46fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void createNode(const MachineInstr &); 4794dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos}; 4894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 49fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanclass MachineBasicBlock : public ilist_node<MachineBasicBlock> { 50fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman typedef ilist<MachineInstr> Instructions; 51c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos Instructions Insts; 521194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *BB; 53c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int Number; 54f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *xParent; 55f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner 5613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// Predecessors/Successors - Keep track of the predecessor / successor 5713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// basicblocks. 5813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Predecessors; 5913d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Successors; 6013d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 6113d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// LiveIns - Keep track of the physical registers that are livein of 6213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// the basicblock. 6313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<unsigned> LiveIns; 64fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 65fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// Alignment - Alignment of the basic block. Zero if the basic block does 66fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// not need to be aligned. 67fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned Alignment; 6830b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 6930b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// IsLandingPad - Indicate that this basic block is entered via an 7030b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// exception handler. 7130b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool IsLandingPad; 7213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 73fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman // Intrusive list support 748e4018e2de52c534405d7155c7009d0b35afb861Cedric Venet friend struct ilist_sentinel_traits<MachineBasicBlock>; 75fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman MachineBasicBlock() {} 76fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman 778e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman explicit MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb); 788e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 792c3f7ae3843bdc9dcfe85393e178211976c1f9bdDan Gohman ~MachineBasicBlock(); 8017fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner 818e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman // MachineBasicBlocks are allocated and owned by MachineFunction. 828e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman friend class MachineFunction; 83ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 848e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanpublic: 85d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// getBasicBlock - Return the LLVM basic block that this instance 86d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// corresponded to originally. 87d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// 881194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *getBasicBlock() const { return BB; } 895e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 905e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// getParent - Return the MachineFunction containing this basic block. 915e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// 92f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner const MachineFunction *getParent() const { return xParent; } 93f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *getParent() { return xParent; } 945e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 958e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::iterator iterator; 968e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::const_iterator const_iterator; 97deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 98deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<iterator> reverse_iterator; 99deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 10034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned size() const { return (unsigned)Insts.size(); } 101deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve bool empty() const { return Insts.empty(); } 102deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 103c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& front() { return Insts.front(); } 104c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& back() { return Insts.back(); } 105deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 106deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator begin() { return Insts.begin(); } 107deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator begin() const { return Insts.begin(); } 108deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator end() { return Insts.end(); } 109deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator end() const { return Insts.end(); } 110deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rbegin() { return Insts.rbegin(); } 111deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rbegin() const { return Insts.rbegin(); } 112deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rend () { return Insts.rend(); } 113deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rend () const { return Insts.rend(); } 114deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 11576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG iterators 11676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator pred_iterator; 11776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator; 11876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator succ_iterator; 11976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator; 1206603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1216603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator; 1226603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1236603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator; 1246603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1256603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator; 1266603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1276603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator; 128ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 129cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_begin() { return Predecessors.begin(); } 130cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_begin() const { return Predecessors.begin(); } 131cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_end() { return Predecessors.end(); } 132cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_end() const { return Predecessors.end(); } 1336603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rbegin() 1346603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1356603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rbegin() const 1366603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1376603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rend() 1386603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 1396603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rend() const 1406603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 14134cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned pred_size() const { 14234cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Predecessors.size(); 14334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 144cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool pred_empty() const { return Predecessors.empty(); } 145cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_begin() { return Successors.begin(); } 146cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_begin() const { return Successors.begin(); } 147cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_end() { return Successors.end(); } 148cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_end() const { return Successors.end(); } 1496603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rbegin() 1506603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1516603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rbegin() const 1526603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1536603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rend() 1546603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 1556603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rend() const 1566603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 15734cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned succ_size() const { 15834cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Successors.size(); 15934cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 160cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool succ_empty() const { return Successors.empty(); } 16176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 16213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // LiveIn management methods. 16313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 16413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// addLiveIn - Add the specified register as a live in. Note that it 16513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// is an error to add the same register to the same set more than once. 16613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); } 16713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 168b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// removeLiveIn - Remove the specified register from the live in set. 169b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// 170b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng void removeLiveIn(unsigned Reg); 171b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng 172a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// isLiveIn - Return true if the specified register is in the live in set. 173a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// 174a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng bool isLiveIn(unsigned Reg) const; 175a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng 17613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // Iteration support for live in sets. These sets are kept in sorted 17713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // order by their register number. 178b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::iterator livein_iterator; 179b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::const_iterator const_livein_iterator; 180b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_begin() { return LiveIns.begin(); } 181b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_begin() const { return LiveIns.begin(); } 182b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_end() { return LiveIns.end(); } 183b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_end() const { return LiveIns.end(); } 18413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng bool livein_empty() const { return LiveIns.empty(); } 18513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 186fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// getAlignment - Return alignment of the basic block. 187fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 188fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned getAlignment() const { return Alignment; } 189fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 190fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// setAlignment - Set alignment of the basic block. 191fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 192fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng void setAlignment(unsigned Align) { Alignment = Align; } 193fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 19430b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// isLandingPad - Returns true if the block is a landing pad. That is 19530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 19630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool isLandingPad() const { return IsLandingPad; } 19730b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 19830b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// setIsLandingPad - Indicates the block is a landing pad. That is 19930b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 20030b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey void setIsLandingPad() { IsLandingPad = true; } 20130b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 20234ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner // Code Layout methods. 20334ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 20434ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// moveBefore/moveAfter - move 'this' block before or after the specified 20534ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// block. This only moves the block, it does not modify the CFG or adjust 20634ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// potential fall-throughs at the end of the block. 20734ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveBefore(MachineBasicBlock *NewAfter); 20834ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveAfter(MachineBasicBlock *NewBefore); 20934ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG mutators 21134ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addSuccessor - Add succ as a successor of this MachineBasicBlock. 21376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// The Predecessors list of succ is automatically updated. 21476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2153dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addSuccessor(MachineBasicBlock *succ); 21676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 217dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove successor from the successors list of this 21876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. The Predecessors list of succ is automatically updated. 21976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2203dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removeSuccessor(MachineBasicBlock *succ); 221dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner 222dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove specified successor from the successors list of 223dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// this MachineBasicBlock. The Predecessors list of succ is automatically 2248a46d342d8cbca7c9c7be6c66007d41329babad0David Greene /// updated. Return the iterator to the element after the one removed. 225dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// 2268a46d342d8cbca7c9c7be6c66007d41329babad0David Greene succ_iterator removeSuccessor(succ_iterator I); 227cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner 22863307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// transferSuccessors - Transfers all the successors from MBB to this 22963307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// machine basic block (i.e., copies all the successors fromMBB and 23063307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// remove all the successors fromBB). 23163307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang void transferSuccessors(MachineBasicBlock *fromMBB); 23263307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang 233cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// isSuccessor - Return true if the specified MBB is a successor of this 234cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// block. 2354f098788d303bed05da6000f3ff24177aad56623Evan Cheng bool isSuccessor(MachineBasicBlock *MBB) const; 23676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 2376ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// isLayoutSuccessor - Return true if the specified MBB will be emitted 2386ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// immediately after this block, such that if this block exits by 2396ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// falling through, control will transfer to the specified MBB. Note 2406ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// that MBB need not be a successor at all, for example if this block 2416ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// ends with an unconditional branch to some other block. 2426ade6f55a836129af634074e96f660ff23f59a30Dan Gohman bool isLayoutSuccessor(MachineBasicBlock *MBB) const; 2436ade6f55a836129af634074e96f660ff23f59a30Dan Gohman 244743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// getFirstTerminator - returns an iterator to the first terminator 245743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// instruction of this basic block. If a terminator does not exist, 246743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// it returns end() 247743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos iterator getFirstTerminator(); 248743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos 2490bbcd6bfd1a90c2aa7386a88ba9fc9aba47d03a7Brian Gaeke void pop_front() { Insts.pop_front(); } 250f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void pop_back() { Insts.pop_back(); } 251deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void push_back(MachineInstr *MI) { Insts.push_back(MI); } 252deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve template<typename IT> 253deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); } 254deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); } 255deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 25646d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve // erase - Remove the specified element or range from the instruction list. 257c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos // These functions delete any instructions removed. 258deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve // 25946d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve iterator erase(iterator I) { return Insts.erase(I); } 260deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator erase(iterator I, iterator E) { return Insts.erase(I, E); } 26183706a5a3a6f19451765b743c5a72b62f74eb71aChris Lattner MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); } 262da44b151259525abc9c299f89b9532f3a9883b4eBrian Gaeke void clear() { Insts.clear(); } 263ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 264f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// splice - Take a block of instructions from MBB 'Other' in the range [From, 265f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// To), and insert them into this MBB right before 'where'. 266f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void splice(iterator where, MachineBasicBlock *Other, iterator From, 267f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner iterator To) { 268f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner Insts.splice(where, Other->Insts, From, To); 269f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner } 2708e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 2718e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// removeFromParent - This method unlinks 'this' from the containing 2728e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function, and returns it, but does not delete it. 2738e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman MachineBasicBlock *removeFromParent(); 2748e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2758e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// eraseFromParent - This method unlinks 'this' from the containing 2768e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function and deletes it. 2778e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void eraseFromParent(); 2788e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2790370fad74b48388412c52d1325512f2c218487faEvan Cheng /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to 2800370fad74b48388412c52d1325512f2c218487faEvan Cheng /// 'Old', change the code and CFG so that it branches to 'New' instead. 2810370fad74b48388412c52d1325512f2c218487faEvan Cheng void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New); 2820370fad74b48388412c52d1325512f2c218487faEvan Cheng 2832bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in 2842bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// the CFG to be inserted. If we have proven that MBB can only branch to 2852bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestA and DestB, remove any other MBB successors from the CFG. DestA and 2862bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestB can be null. Besides DestA and DestB, retain other edges leading 2872bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// to LandingPads (currently there can be only one; we don't check or require 2882bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// that here). Note it is possible that DestA and/or DestB are LandingPads. 2892bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool CorrectExtraCFGEdges(MachineBasicBlock *DestA, 2902bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng MachineBasicBlock *DestB, 2912bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool isCond); 2922bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng 293f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke // Debugging methods. 294f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void dump() const; 295f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void print(std::ostream &OS) const; 2965c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 297f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke 298da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// getNumber - MachineBasicBlocks are uniquely numbered at the function 299da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// level, unless they're not in a MachineFunction yet, in which case this 300da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// will return -1. 301da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// 302c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int getNumber() const { return Number; } 30320a6d8e63056cc2025e7143a5f7226e079e0bc80Chris Lattner void setNumber(int N) { Number = N; } 304c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke 3058e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattnerprivate: // Methods used to maintain doubly linked list of blocks... 306fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman friend struct ilist_traits<MachineBasicBlock>; 3078560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3088560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke // Machine-CFG mutators 3098560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3108560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock. 3118560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// Don't do this unless you know what you're doing, because it doesn't 3128560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// update pred's successors list. Use pred->addSuccessor instead. 3138560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3143dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addPredecessor(MachineBasicBlock *pred); 3158560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3168560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// removePredecessor - Remove pred as a predecessor of this 3178560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// MachineBasicBlock. Don't do this unless you know what you're 3188560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// doing, because it doesn't update pred's successors list. Use 3198560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// pred->removeSuccessor instead. 3208560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3213dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removePredecessor(MachineBasicBlock *pred); 322deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve}; 323deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 3241ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattnerstd::ostream& operator<<(std::ostream &OS, const MachineBasicBlock &MBB); 3250aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3260aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3270aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// GraphTraits specializations for machine basic block graphs (machine-CFGs) 3280aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3290aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3300aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3310aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... 3320aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3330aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3340aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<MachineBasicBlock *> { 3350aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3360aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::succ_iterator ChildIteratorType; 3370aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3380aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; } 339ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3400aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3410aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 342ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3430aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3440aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3450aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3460aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3470aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<const MachineBasicBlock *> { 3480aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3490aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_succ_iterator ChildIteratorType; 3500aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3510aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; } 352ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3530aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3540aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 355ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3560aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3570aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3580aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3590aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3600aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3610aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... and to walk it 3620aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// in inverse order. Inverse order for a function is considered 3630aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// to be when traversing the predecessor edges of a MBB 3640aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// instead of the successor edges. 3650aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3660aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<MachineBasicBlock*> > { 3670aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3680aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::pred_iterator ChildIteratorType; 3690aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) { 3700aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return G.Graph; 3710aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 372ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3730aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3740aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 375ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3760aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3770aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3780aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3790aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3800aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<const MachineBasicBlock*> > { 3810aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3820aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_pred_iterator ChildIteratorType; 3830aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) { 384ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman return G.Graph; 3850aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 386ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3870aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3880aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 389ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3900aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3910aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3920aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3930aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 394d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 395deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 396deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve#endif 397