MachineBasicBlock.h revision 6d1b89e74f98470d05666ca9f59a8ec5d04b5eb4
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: 299c01f2dd0b20e09f4edef832620a188eda62ff5aDan Gohman mutable ilist_node<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: 36c7f6b8c5d40e17bf43fd3a1549d7d89c9da735e1Gabor Greif MachineInstr *createSentinel() const { 37c7f6b8c5d40e17bf43fd3a1549d7d89c9da735e1Gabor Greif return static_cast<MachineInstr*>(&Sentinel); 38c7f6b8c5d40e17bf43fd3a1549d7d89c9da735e1Gabor Greif } 39fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void destroySentinel(MachineInstr *) const {} 4094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 41c23b8719ef9d6b1220e854b37d40e9e1c48a82bcGabor Greif MachineInstr *provideInitialHead() const { return createSentinel(); } 42c23b8719ef9d6b1220e854b37d40e9e1c48a82bcGabor Greif MachineInstr *ensureHead(MachineInstr*) const { return createSentinel(); } 43f3841fcbd587c31aa9842b3f33bd57de40c9f443Gabor Greif static void noteHead(MachineInstr*, MachineInstr*) {} 44c23b8719ef9d6b1220e854b37d40e9e1c48a82bcGabor Greif 45aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void addNodeToList(MachineInstr* N); 46aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void removeNodeFromList(MachineInstr* N); 47fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void transferNodesFromList(ilist_traits &SrcTraits, 48fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman ilist_iterator<MachineInstr> first, 49fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman ilist_iterator<MachineInstr> last); 508e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void deleteNode(MachineInstr *N); 51fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanprivate: 52fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void createNode(const MachineInstr &); 5394dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos}; 5494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 55fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanclass MachineBasicBlock : public ilist_node<MachineBasicBlock> { 56fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman typedef ilist<MachineInstr> Instructions; 57c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos Instructions Insts; 581194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *BB; 59c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int Number; 60f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *xParent; 61f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner 6213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// Predecessors/Successors - Keep track of the predecessor / successor 6313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// basicblocks. 6413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Predecessors; 6513d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<MachineBasicBlock *> Successors; 6613d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 6713d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// LiveIns - Keep track of the physical registers that are livein of 6813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// the basicblock. 6913d828567812041c1ca1817f4b66fce840903a1fEvan Cheng std::vector<unsigned> LiveIns; 70fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 71fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// Alignment - Alignment of the basic block. Zero if the basic block does 72fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// not need to be aligned. 73fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned Alignment; 7430b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 7530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// IsLandingPad - Indicate that this basic block is entered via an 7630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// exception handler. 7730b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool IsLandingPad; 7813d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 79fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman // Intrusive list support 80fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman MachineBasicBlock() {} 81fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman 828e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman explicit MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb); 838e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 842c3f7ae3843bdc9dcfe85393e178211976c1f9bdDan Gohman ~MachineBasicBlock(); 8517fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner 868e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman // MachineBasicBlocks are allocated and owned by MachineFunction. 878e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman friend class MachineFunction; 88ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 898e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohmanpublic: 90d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// getBasicBlock - Return the LLVM basic block that this instance 91d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// corresponded to originally. 92d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// 931194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *getBasicBlock() const { return BB; } 945e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 955e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// getParent - Return the MachineFunction containing this basic block. 965e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// 97f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner const MachineFunction *getParent() const { return xParent; } 98f20c1a497fe3922ac718429d65a5fe396890575eChris Lattner MachineFunction *getParent() { return xParent; } 995e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 1008e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::iterator iterator; 1018e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman typedef Instructions::const_iterator const_iterator; 102deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 103deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<iterator> reverse_iterator; 104deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 10534cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned size() const { return (unsigned)Insts.size(); } 106deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve bool empty() const { return Insts.empty(); } 107deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 108c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& front() { return Insts.front(); } 109c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& back() { return Insts.back(); } 1108e8b8a223c2b0e69f44c0639f846260c8011668fDan Gohman const MachineInstr& front() const { return Insts.front(); } 1118e8b8a223c2b0e69f44c0639f846260c8011668fDan Gohman const MachineInstr& back() const { return Insts.back(); } 112deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 113deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator begin() { return Insts.begin(); } 114deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator begin() const { return Insts.begin(); } 115deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator end() { return Insts.end(); } 116deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator end() const { return Insts.end(); } 117deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rbegin() { return Insts.rbegin(); } 118deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rbegin() const { return Insts.rbegin(); } 119deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rend () { return Insts.rend(); } 120deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rend () const { return Insts.rend(); } 121deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 12276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG iterators 12376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator pred_iterator; 12476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator; 12576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator succ_iterator; 12676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator; 1276603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1286603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator; 1296603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1306603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator; 1316603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::reverse_iterator 1326603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator; 1336603d7ec67e64b987451975771759ade4e9f19baEvan Cheng typedef std::vector<MachineBasicBlock *>::const_reverse_iterator 1346603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator; 135ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 136cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_begin() { return Predecessors.begin(); } 137cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_begin() const { return Predecessors.begin(); } 138cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner pred_iterator pred_end() { return Predecessors.end(); } 139cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_pred_iterator pred_end() const { return Predecessors.end(); } 1406603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rbegin() 1416603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1426603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rbegin() const 1436603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rbegin();} 1446603d7ec67e64b987451975771759ade4e9f19baEvan Cheng pred_reverse_iterator pred_rend() 1456603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 1466603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_pred_reverse_iterator pred_rend() const 1476603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Predecessors.rend(); } 14834cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned pred_size() const { 14934cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Predecessors.size(); 15034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 151cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool pred_empty() const { return Predecessors.empty(); } 152cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_begin() { return Successors.begin(); } 153cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_begin() const { return Successors.begin(); } 154cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner succ_iterator succ_end() { return Successors.end(); } 155cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner const_succ_iterator succ_end() const { return Successors.end(); } 1566603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rbegin() 1576603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1586603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rbegin() const 1596603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rbegin(); } 1606603d7ec67e64b987451975771759ade4e9f19baEvan Cheng succ_reverse_iterator succ_rend() 1616603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 1626603d7ec67e64b987451975771759ade4e9f19baEvan Cheng const_succ_reverse_iterator succ_rend() const 1636603d7ec67e64b987451975771759ade4e9f19baEvan Cheng { return Successors.rend(); } 16434cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned succ_size() const { 16534cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return (unsigned)Successors.size(); 16634cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 167cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner bool succ_empty() const { return Successors.empty(); } 16876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 16913d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // LiveIn management methods. 17013d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 17113d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// addLiveIn - Add the specified register as a live in. Note that it 17213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng /// is an error to add the same register to the same set more than once. 17313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng void addLiveIn(unsigned Reg) { LiveIns.push_back(Reg); } 17413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 175b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// removeLiveIn - Remove the specified register from the live in set. 176b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng /// 177b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng void removeLiveIn(unsigned Reg); 178b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng 179a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// isLiveIn - Return true if the specified register is in the live in set. 180a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng /// 181a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng bool isLiveIn(unsigned Reg) const; 182a971dbdde27fd4ff53dbebdd4aaf87826d081aa2Evan Cheng 18313d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // Iteration support for live in sets. These sets are kept in sorted 18413d828567812041c1ca1817f4b66fce840903a1fEvan Cheng // order by their register number. 185b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::iterator livein_iterator; 186b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng typedef std::vector<unsigned>::const_iterator const_livein_iterator; 187b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_begin() { return LiveIns.begin(); } 188b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_begin() const { return LiveIns.begin(); } 189b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng livein_iterator livein_end() { return LiveIns.end(); } 190b371f457b0ea4a652a9f526ba4375c80ae542252Evan Cheng const_livein_iterator livein_end() const { return LiveIns.end(); } 19113d828567812041c1ca1817f4b66fce840903a1fEvan Cheng bool livein_empty() const { return LiveIns.empty(); } 19213d828567812041c1ca1817f4b66fce840903a1fEvan Cheng 193fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// getAlignment - Return alignment of the basic block. 194fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 195fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng unsigned getAlignment() const { return Alignment; } 196fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 197fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// setAlignment - Set alignment of the basic block. 198fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng /// 199fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng void setAlignment(unsigned Align) { Alignment = Align; } 200fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng 20130b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// isLandingPad - Returns true if the block is a landing pad. That is 20230b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 20330b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey bool isLandingPad() const { return IsLandingPad; } 20430b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 20530b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// setIsLandingPad - Indicates the block is a landing pad. That is 20630b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey /// this basic block is entered via an exception handler. 20730b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey void setIsLandingPad() { IsLandingPad = true; } 20830b8e51addc23fb317c03d093a25828d3d5be45aJim Laskey 20934ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner // Code Layout methods. 21034ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21134ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// moveBefore/moveAfter - move 'this' block before or after the specified 21234ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// block. This only moves the block, it does not modify the CFG or adjust 21334ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner /// potential fall-throughs at the end of the block. 21434ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveBefore(MachineBasicBlock *NewAfter); 21534ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner void moveAfter(MachineBasicBlock *NewBefore); 21634ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG mutators 21834ea07692f4cd7c007f1c5062bcebb6d03131077Chris Lattner 21976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addSuccessor - Add succ as a successor of this MachineBasicBlock. 22076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// The Predecessors list of succ is automatically updated. 22176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2223dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addSuccessor(MachineBasicBlock *succ); 22376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 224dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove successor from the successors list of this 22576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. The Predecessors list of succ is automatically updated. 22676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 2273dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removeSuccessor(MachineBasicBlock *succ); 228dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner 229dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// removeSuccessor - Remove specified successor from the successors list of 230dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// this MachineBasicBlock. The Predecessors list of succ is automatically 2318a46d342d8cbca7c9c7be6c66007d41329babad0David Greene /// updated. Return the iterator to the element after the one removed. 232dc4a4922d32b470acd68498d41e3b8130cf1e74eChris Lattner /// 2338a46d342d8cbca7c9c7be6c66007d41329babad0David Greene succ_iterator removeSuccessor(succ_iterator I); 234cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner 23563307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// transferSuccessors - Transfers all the successors from MBB to this 23663307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// machine basic block (i.e., copies all the successors fromMBB and 23763307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang /// remove all the successors fromBB). 23863307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang void transferSuccessors(MachineBasicBlock *fromMBB); 23963307c335aa08b0d6a75f81d64d79af7e90eb78bMon P Wang 240cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// isSuccessor - Return true if the specified MBB is a successor of this 241cd5bad37112ba22f4c546e5443714570b4104bb6Chris Lattner /// block. 2426d1b89e74f98470d05666ca9f59a8ec5d04b5eb4Dan Gohman bool isSuccessor(const MachineBasicBlock *MBB) const; 24376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 2446ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// isLayoutSuccessor - Return true if the specified MBB will be emitted 2456ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// immediately after this block, such that if this block exits by 2466ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// falling through, control will transfer to the specified MBB. Note 2476ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// that MBB need not be a successor at all, for example if this block 2486ade6f55a836129af634074e96f660ff23f59a30Dan Gohman /// ends with an unconditional branch to some other block. 2496d1b89e74f98470d05666ca9f59a8ec5d04b5eb4Dan Gohman bool isLayoutSuccessor(const MachineBasicBlock *MBB) const; 2506ade6f55a836129af634074e96f660ff23f59a30Dan Gohman 251743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// getFirstTerminator - returns an iterator to the first terminator 252743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// instruction of this basic block. If a terminator does not exist, 253743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// it returns end() 254743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos iterator getFirstTerminator(); 255743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos 2560bbcd6bfd1a90c2aa7386a88ba9fc9aba47d03a7Brian Gaeke void pop_front() { Insts.pop_front(); } 257f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void pop_back() { Insts.pop_back(); } 258deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void push_back(MachineInstr *MI) { Insts.push_back(MI); } 259deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve template<typename IT> 260deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); } 261deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); } 262deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 26346d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve // erase - Remove the specified element or range from the instruction list. 264c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos // These functions delete any instructions removed. 265deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve // 26646d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve iterator erase(iterator I) { return Insts.erase(I); } 267deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator erase(iterator I, iterator E) { return Insts.erase(I, E); } 26883706a5a3a6f19451765b743c5a72b62f74eb71aChris Lattner MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); } 269da44b151259525abc9c299f89b9532f3a9883b4eBrian Gaeke void clear() { Insts.clear(); } 270ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman 271c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman /// splice - Take an instruction from MBB 'Other' at the position From, 272c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman /// and insert it into this MBB right before 'where'. 273c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman void splice(iterator where, MachineBasicBlock *Other, iterator From) { 274c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman Insts.splice(where, Other->Insts, From); 275c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman } 276c475c3608a5f0fc0c6bd43da04ae786649690070Dan Gohman 277f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// splice - Take a block of instructions from MBB 'Other' in the range [From, 278f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner /// To), and insert them into this MBB right before 'where'. 279f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner void splice(iterator where, MachineBasicBlock *Other, iterator From, 280f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner iterator To) { 281f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner Insts.splice(where, Other->Insts, From, To); 282f24d879520a615a03f19ced3c7491f7b51934d1cChris Lattner } 2838e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 2848e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// removeFromParent - This method unlinks 'this' from the containing 2858e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function, and returns it, but does not delete it. 2868e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman MachineBasicBlock *removeFromParent(); 2878e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2888e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// eraseFromParent - This method unlinks 'this' from the containing 2898e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman /// function and deletes it. 2908e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman void eraseFromParent(); 2918e5f2c6f65841542e2a7092553fe42a00048e4c7Dan Gohman 2920370fad74b48388412c52d1325512f2c218487faEvan Cheng /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to 2930370fad74b48388412c52d1325512f2c218487faEvan Cheng /// 'Old', change the code and CFG so that it branches to 'New' instead. 2940370fad74b48388412c52d1325512f2c218487faEvan Cheng void ReplaceUsesOfBlockWith(MachineBasicBlock *Old, MachineBasicBlock *New); 2950370fad74b48388412c52d1325512f2c218487faEvan Cheng 2962bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in 2972bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// the CFG to be inserted. If we have proven that MBB can only branch to 2982bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestA and DestB, remove any other MBB successors from the CFG. DestA and 2992bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// DestB can be null. Besides DestA and DestB, retain other edges leading 3002bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// to LandingPads (currently there can be only one; we don't check or require 3012bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng /// that here). Note it is possible that DestA and/or DestB are LandingPads. 3022bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool CorrectExtraCFGEdges(MachineBasicBlock *DestA, 3032bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng MachineBasicBlock *DestB, 3042bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng bool isCond); 3052bdb7d0cc88881857073b36f4a09ebe2f2008c24Evan Cheng 306f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke // Debugging methods. 307f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void dump() const; 308f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void print(std::ostream &OS) const; 3095c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 310f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke 311da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// getNumber - MachineBasicBlocks are uniquely numbered at the function 312da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// level, unless they're not in a MachineFunction yet, in which case this 313da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// will return -1. 314da86bdc75c8d36cb7b1f4e785a3749d7c8f8e638Brian Gaeke /// 315c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke int getNumber() const { return Number; } 31620a6d8e63056cc2025e7143a5f7226e079e0bc80Chris Lattner void setNumber(int N) { Number = N; } 317c07d8d8a26f63dfc54dbd0e1ff776763ec6443adBrian Gaeke 3188e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattnerprivate: // Methods used to maintain doubly linked list of blocks... 319fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman friend struct ilist_traits<MachineBasicBlock>; 3208560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3218560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke // Machine-CFG mutators 3228560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3238560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock. 3248560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// Don't do this unless you know what you're doing, because it doesn't 3258560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// update pred's successors list. Use pred->addSuccessor instead. 3268560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3273dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void addPredecessor(MachineBasicBlock *pred); 3288560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke 3298560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// removePredecessor - Remove pred as a predecessor of this 3308560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// MachineBasicBlock. Don't do this unless you know what you're 3318560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// doing, because it doesn't update pred's successors list. Use 3328560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// pred->removeSuccessor instead. 3338560af4f5fe589cf792bd44617c2308c4f087ba8Brian Gaeke /// 3343dfbb558b5e74554104710ed16807fe74ec220a3Chris Lattner void removePredecessor(MachineBasicBlock *pred); 335deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve}; 336deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 3371ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattnerstd::ostream& operator<<(std::ostream &OS, const MachineBasicBlock &MBB); 3380aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3390aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3400aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// GraphTraits specializations for machine basic block graphs (machine-CFGs) 3410aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner//===--------------------------------------------------------------------===// 3420aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3430aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3440aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... 3450aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3460aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3470aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<MachineBasicBlock *> { 3480aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3490aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::succ_iterator ChildIteratorType; 3500aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3510aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(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 Lattnertemplate <> struct GraphTraits<const MachineBasicBlock *> { 3610aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3620aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_succ_iterator ChildIteratorType; 3630aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3640aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; } 365ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3660aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_begin(); 3670aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 368ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3690aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->succ_end(); 3700aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3710aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3720aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3730aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// Provide specializations of GraphTraits to be able to treat a 3740aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// MachineFunction as a graph of MachineBasicBlocks... and to walk it 3750aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// in inverse order. Inverse order for a function is considered 3760aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// to be when traversing the predecessor edges of a MBB 3770aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// instead of the successor edges. 3780aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner// 3790aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<MachineBasicBlock*> > { 3800aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock NodeType; 3810aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::pred_iterator ChildIteratorType; 3820aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) { 3830aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return G.Graph; 3840aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 385ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 3860aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 3870aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 388ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 3890aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 3900aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 3910aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 3920aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 3930aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattnertemplate <> struct GraphTraits<Inverse<const MachineBasicBlock*> > { 3940aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef const MachineBasicBlock NodeType; 3950aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner typedef MachineBasicBlock::const_pred_iterator ChildIteratorType; 3960aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) { 397ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman return G.Graph; 3980aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 399ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_begin(NodeType *N) { 4000aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_begin(); 4010aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 402ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman static inline ChildIteratorType child_end(NodeType *N) { 4030aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner return N->pred_end(); 4040aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner } 4050aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner}; 4060aef12a7a96968a80c38144dfc0a7ae6a9152db9Chris Lattner 407d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 408deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 409deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve#endif 410