MachineBasicBlock.h revision 76456bc40c79fcae4da52d34f96c079d9759257c
151a8d8528135ba4e3e4cf7cd711a9e47b19078a3Chris Lattner//===-- llvm/CodeGen/MachineBasicBlock.h ------------------------*- C++ -*-===// 2deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve// 36fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// The LLVM Compiler Infrastructure 46fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 56fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// This file was developed by the LLVM research group and is distributed under 66fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// the University of Illinois Open Source License. See LICENSE.TXT for details. 76fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 86fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell//===----------------------------------------------------------------------===// 96fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 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" 1894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos#include "Support/ilist" 19f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke#include <iosfwd> 20d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 21d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 225e61fa95196b85281eec655787e9c73267532bd1Chris Lattner class MachineFunction; 23d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 2494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos// ilist_traits 2594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenostemplate <> 265e61fa95196b85281eec655787e9c73267532bd1Chris Lattnerclass ilist_traits<MachineInstr> { 2794dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos // this is only set by the MachineBasicBlock owning the ilist 2894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos friend class MachineBasicBlock; 2994dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos MachineBasicBlock* parent; 3094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 3194dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenospublic: 3294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos ilist_traits<MachineInstr>() : parent(0) { } 3394dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 3494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static MachineInstr* getPrev(MachineInstr* N) { return N->prev; } 3594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static MachineInstr* getNext(MachineInstr* N) { return N->next; } 3694dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 3794dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static const MachineInstr* 3894dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos getPrev(const MachineInstr* N) { return N->prev; } 3994dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 4094dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static const MachineInstr* 4194dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos getNext(const MachineInstr* N) { return N->next; } 4294dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 4394dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static void setPrev(MachineInstr* N, MachineInstr* prev) { N->prev = prev; } 4494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos static void setNext(MachineInstr* N, MachineInstr* next) { N->next = next; } 4594dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 46aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos static MachineInstr* createNode(); 47aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void addNodeToList(MachineInstr* N); 48aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void removeNodeFromList(MachineInstr* N); 49aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos void transferNodesFromList( 50aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos iplist<MachineInstr, ilist_traits<MachineInstr> >& toList, 51aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos ilist_iterator<MachineInstr> first, 52aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos ilist_iterator<MachineInstr> last); 5394dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos}; 5494dc07728f091c652f0a8059aba6dce5018485eeAlkis Evlogimenos 55aec11f1decda111112c39803cb89dace81cd0568Chris Lattnerclass BasicBlock; 56deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 57d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattnerclass MachineBasicBlock { 58c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenospublic: 59c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr> Instructions; 60c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos Instructions Insts; 618e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *Prev, *Next; 621194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *BB; 6376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::vector<MachineBasicBlock *> Predecessors; 6476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::vector<MachineBasicBlock *> Successors; 6576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 66deb9654056939a12981446f6ed1139dca3412746Vikram S. Advepublic: 67ab8672c8bb83e722b856eac67863542ea7e0cbb2Alkis Evlogimenos MachineBasicBlock(const BasicBlock *bb = 0) : Prev(0), Next(0), BB(bb) { 68ab8672c8bb83e722b856eac67863542ea7e0cbb2Alkis Evlogimenos Insts.parent = this; 69ab8672c8bb83e722b856eac67863542ea7e0cbb2Alkis Evlogimenos } 70fce1143bcfa73f61845002fa50473d1a01384202Misha Brukman ~MachineBasicBlock() {} 71deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 72d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// getBasicBlock - Return the LLVM basic block that this instance 73d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// corresponded to originally. 74d0aa0cdbc6fee00f2b2019633a9b9d00d301ac68Chris Lattner /// 751194e9501984daf0d3237ed1bf18a156173e7fd4Chris Lattner const BasicBlock *getBasicBlock() const { return BB; } 765e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 775e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// getParent - Return the MachineFunction containing this basic block. 785e61fa95196b85281eec655787e9c73267532bd1Chris Lattner /// 795e61fa95196b85281eec655787e9c73267532bd1Chris Lattner const MachineFunction *getParent() const; 805e61fa95196b85281eec655787e9c73267532bd1Chris Lattner 81c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr>::iterator iterator; 82c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos typedef ilist<MachineInstr>::const_iterator const_iterator; 83deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 84deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve typedef std::reverse_iterator<iterator> reverse_iterator; 85deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 86deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve unsigned size() const { return Insts.size(); } 87deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve bool empty() const { return Insts.empty(); } 88deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 89c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& front() { return Insts.front(); } 90c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos MachineInstr& back() { return Insts.back(); } 91deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 92deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator begin() { return Insts.begin(); } 93deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator begin() const { return Insts.begin(); } 94deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator end() { return Insts.end(); } 95deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_iterator end() const { return Insts.end(); } 96deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rbegin() { return Insts.rbegin(); } 97deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rbegin() const { return Insts.rbegin(); } 98deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve reverse_iterator rend () { return Insts.rend(); } 99deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve const_reverse_iterator rend () const { return Insts.rend(); } 100deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 10176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG iterators 10276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator pred_iterator; 10376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator; 10476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::iterator succ_iterator; 10576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator; 10676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 10776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke pred_iterator pred_begin() { return Predecessors.begin (); } 10876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke const_pred_iterator pred_begin() const { return Predecessors.begin (); } 10976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke pred_iterator pred_end() { return Predecessors.end (); } 11076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke const_pred_iterator pred_end() const { return Predecessors.end (); } 11176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke succ_iterator succ_begin() { return Successors.begin (); } 11276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke const_succ_iterator succ_begin() const { return Successors.begin (); } 11376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke succ_iterator succ_end() { return Successors.end (); } 11476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke const_succ_iterator succ_end() const { return Successors.end (); } 11576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 11676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke // Machine-CFG mutators 11776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 11876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addSuccessor - Add succ as a successor of this MachineBasicBlock. 11976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// The Predecessors list of succ is automatically updated. 12076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 12176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke void addSuccessor (MachineBasicBlock *succ) { 12276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke Successors.push_back (succ); 12376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke assert (std::find (Successors.begin (), Successors.end (), succ) 12476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke == Successors.end () 12576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke && "Trying to addSuccessor a MBB which is already my successor"); 12676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke succ->addPredecessor (this); 12776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke } 12876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 12976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// removeSuccessor - Remove succ from the successors list of this 13076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. The Predecessors list of succ is automatically updated. 13176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 13276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke void removeSuccessor (MachineBasicBlock *succ) { 13376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke succ->removePredecessor (this); 13476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::vector<MachineBasicBlock *>::iterator goner = 13576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::find (Successors.begin(), Successors.end (), succ); 13676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke assert (goner != Successors.end () 13776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke && "Trying to removeSuccessor a MBB which isn't my successor"); 13876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke Successors.erase (goner); 13976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke } 14076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 14176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock. 14276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// Don't do this unless you know what you're doing, because it doesn't 14376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// update pred's successors list. Use pred->addSuccessor instead. 14476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 14576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke void addPredecessor (MachineBasicBlock *pred) { 14676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke Predecessors.push_back (pred); 14776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke assert(std::find (Predecessors.begin (), Predecessors.end (), pred) 14876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke == Predecessors.end () 14976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke && "Trying to addPredecessor a MBB which is already my predecessor"); 15076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke } 15176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 15276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// removePredecessor - Remove pred as a predecessor of this 15376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// MachineBasicBlock. Don't do this unless you know what you're 15476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// doing, because it doesn't update pred's successors list. Use 15576456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// pred->removeSuccessor instead. 15676456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke /// 15776456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke void removePredecessor (MachineBasicBlock *pred) { 15876456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::vector<MachineBasicBlock *>::iterator goner = 15976456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke std::find (Predecessors.begin(), Predecessors.end (), pred); 16076456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke assert (goner != Predecessors.end () 16176456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke && "Trying to removePredecessor a MBB which isn't my predecessor"); 16276456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke Predecessors.erase (goner); 16376456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke } 16476456bc40c79fcae4da52d34f96c079d9759257cBrian Gaeke 165743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// getFirstTerminator - returns an iterator to the first terminator 166743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// instruction of this basic block. If a terminator does not exist, 167743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos /// it returns end() 168743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos iterator getFirstTerminator(); 169743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos 170deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void push_back(MachineInstr *MI) { Insts.push_back(MI); } 171deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve template<typename IT> 172deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); } 173deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); } 174deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 17546d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve // erase - Remove the specified element or range from the instruction list. 176c0b9dc5be79f009d260edb5cd5e1d8346587aaa2Alkis Evlogimenos // These functions delete any instructions removed. 177deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve // 17846d6a1aeb549a2e4ccd982a1a2cefda541d79c52Vikram S. Adve iterator erase(iterator I) { return Insts.erase(I); } 179deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve iterator erase(iterator I, iterator E) { return Insts.erase(I, E); } 18083706a5a3a6f19451765b743c5a72b62f74eb71aChris Lattner MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); } 181da44b151259525abc9c299f89b9532f3a9883b4eBrian Gaeke void clear() { Insts.clear(); } 1828e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 183f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke // Debugging methods. 184f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void dump() const; 185f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke void print(std::ostream &OS) const; 186f13a3f4dd1eaa89ca9a64a1e820b089facca3366Brian Gaeke 1878e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattnerprivate: // Methods used to maintain doubly linked list of blocks... 1888e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner friend class ilist_traits<MachineBasicBlock>; 1898e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner 1908e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *getPrev() const { return Prev; } 1918e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner MachineBasicBlock *getNext() const { return Next; } 1928e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner void setPrev(MachineBasicBlock *P) { Prev = P; } 1938e7ae9860bd1f29c95e4e10fe151a22aaafafef9Chris Lattner void setNext(MachineBasicBlock *N) { Next = N; } 194deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve}; 195deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 196d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 197deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve 198deb9654056939a12981446f6ed1139dca3412746Vikram S. Adve#endif 199