X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FBasicBlock.h;h=510124374263cc2552a939f8b25d5715a246bdaf;hb=440f87eea20f11ea86822816fae965956795d6d3;hp=2ea5e6ad5536a3db079b6de9414bfb9d0b9fcc10;hpb=08272fbdb2dd227346789d9d9c4243dffe1ea3a6;p=oota-llvm.git diff --git a/include/llvm/BasicBlock.h b/include/llvm/BasicBlock.h index 2ea5e6ad553..51012437426 100644 --- a/include/llvm/BasicBlock.h +++ b/include/llvm/BasicBlock.h @@ -1,4 +1,12 @@ -//===-- llvm/BasicBlock.h - Represent a basic block in the VM ----*- C++ -*--=// +//===-- llvm/BasicBlock.h - Represent a basic block in the VM ---*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file was developed by the LLVM research group and is distributed under +// the University of Illinois Open Source License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// // // This file contains the declaration of the BasicBlock class, which represents // a single basic block in the VM. @@ -6,14 +14,14 @@ // Note that basic blocks themselves are Value's, because they are referenced // by instructions like branches and can go in switch tables and stuff... // -//===----------------------------------------------------------------------===// +///===---------------------------------------------------------------------===// // // Note that well formed basic blocks are formed of a list of instructions // followed by a single TerminatorInst instruction. TerminatorInst's may not // occur in the middle of basic blocks, and must terminate the blocks. // // This code allows malformed basic blocks to occur, because it may be useful -// in the intermediate stage of analysis or modification of a program. +// in the intermediate stage modification to a program. // //===----------------------------------------------------------------------===// @@ -24,6 +32,8 @@ #include "llvm/SymbolTableListTraits.h" #include "Support/ilist" +namespace llvm { + class TerminatorInst; template class SuccIterator; // Successor Iterator template class PredIterator; @@ -35,14 +45,13 @@ template<> struct ilist_traits static iplist &getList(BasicBlock *BB); }; -class BasicBlock : public Value { // Basic blocks are data objects also -public: +struct BasicBlock : public Value { // Basic blocks are data objects also typedef iplist InstListType; private : InstListType InstList; BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list - void setParent(Function *parent) { InstList.setParent(parent); } + void setParent(Function *parent); void setNext(BasicBlock *N) { Next = N; } void setPrev(BasicBlock *N) { Prev = N; } friend class SymbolTableListTraits; @@ -51,20 +60,27 @@ private : void operator=(const BasicBlock &); // Do not implement public: - // Instruction iterators... + /// Instruction iterators... typedef InstListType::iterator iterator; typedef InstListType::const_iterator const_iterator; typedef std::reverse_iterator const_reverse_iterator; typedef std::reverse_iterator reverse_iterator; - // Ctor, dtor + /// BasicBlock ctor - If the function parameter is specified, the basic block + /// is automatically inserted at the end of the function. + /// BasicBlock(const std::string &Name = "", Function *Parent = 0); + + /// BasicBlock ctor - If the InsertBefore parameter is specified, the basic + /// block is automatically inserted right before the specified block. + BasicBlock(const std::string &Name, BasicBlock *InsertBefore); ~BasicBlock(); // Specialize setName to take care of symbol table majik virtual void setName(const std::string &name, SymbolTable *ST = 0); - // getParent - Return the enclosing method, or null if none + /// getParent - Return the enclosing method, or null if none + /// const Function *getParent() const { return InstList.getParent(); } Function *getParent() { return InstList.getParent(); } @@ -74,26 +90,16 @@ public: BasicBlock *getPrev() { return Prev; } const BasicBlock *getPrev() const { return Prev; } - // getTerminator() - If this is a well formed basic block, then this returns - // a pointer to the terminator instruction. If it is not, then you get a null - // pointer back. - // + /// getTerminator() - If this is a well formed basic block, then this returns + /// a pointer to the terminator instruction. If it is not, then you get a + /// null pointer back. + /// TerminatorInst *getTerminator(); const TerminatorInst *const getTerminator() const; - // Provide a scoped predecessor and successor iterator - typedef PredIterator pred_iterator; - typedef PredIterator pred_const_iterator; - - typedef SuccIterator succ_iterator; - typedef SuccIterator succ_const_iterator; - - //===--------------------------------------------------------------------===// - // Instruction iterator methods - // + /// Instruction iterator methods + /// inline iterator begin() { return InstList.begin(); } inline const_iterator begin() const { return InstList.begin(); } inline iterator end () { return InstList.end(); } @@ -111,58 +117,61 @@ public: inline const Instruction &back() const { return InstList.back(); } inline Instruction &back() { return InstList.back(); } - // getInstList() - Return the underlying instruction list container. You need - // to access it directly if you want to modify it currently. - // + /// getInstList() - Return the underlying instruction list container. You + /// need to access it directly if you want to modify it currently. + /// const InstListType &getInstList() const { return InstList; } InstListType &getInstList() { return InstList; } - virtual void print(std::ostream &OS) const; + virtual void print(std::ostream &OS) const { print(OS, 0); } + void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const; - // Methods for support type inquiry through isa, cast, and dyn_cast: + /// Methods for support type inquiry through isa, cast, and dyn_cast: static inline bool classof(const BasicBlock *BB) { return true; } static inline bool classof(const Value *V) { return V->getValueType() == Value::BasicBlockVal; } - // hasConstantReferences() - This predicate is true if there is a - // reference to this basic block in the constant pool for this method. For - // example, if a block is reached through a switch table, that table resides - // in the constant pool, and the basic block is reference from it. - // + /// hasConstantReferences() - This predicate is true if there is a + /// reference to this basic block in the constant pool for this method. For + /// example, if a block is reached through a switch table, that table resides + /// in the constant pool, and the basic block is reference from it. + /// bool hasConstantReferences() const; - // dropAllReferences() - This function causes all the subinstructions to "let - // go" of all references that they are maintaining. This allows one to - // 'delete' a whole class at a time, even though there may be circular - // references... first all references are dropped, and all use counts go to - // zero. Then everything is delete'd for real. Note that no operations are - // valid on an object that has "dropped all references", except operator - // delete. - // + /// dropAllReferences() - This function causes all the subinstructions to "let + /// go" of all references that they are maintaining. This allows one to + /// 'delete' a whole class at a time, even though there may be circular + /// references... first all references are dropped, and all use counts go to + /// zero. Then everything is delete'd for real. Note that no operations are + /// valid on an object that has "dropped all references", except operator + /// delete. + /// void dropAllReferences(); - // removePredecessor - This method is used to notify a BasicBlock that the - // specified Predecessor of the block is no longer able to reach it. This is - // actually not used to update the Predecessor list, but is actually used to - // update the PHI nodes that reside in the block. Note that this should be - // called while the predecessor still refers to this block. - // + /// removePredecessor - This method is used to notify a BasicBlock that the + /// specified Predecessor of the block is no longer able to reach it. This is + /// actually not used to update the Predecessor list, but is actually used to + /// update the PHI nodes that reside in the block. Note that this should be + /// called while the predecessor still refers to this block. + /// void removePredecessor(BasicBlock *Pred); - // splitBasicBlock - This splits a basic block into two at the specified - // instruction. Note that all instructions BEFORE the specified iterator stay - // as part of the original basic block, an unconditional branch is added to - // the new BB, and the rest of the instructions in the BB are moved to the new - // BB, including the old terminator. The newly formed BasicBlock is returned. - // This function invalidates the specified iterator. - // - // Note that this only works on well formed basic blocks (must have a - // terminator), and 'I' must not be the end of instruction list (which would - // cause a degenerate basic block to be formed, having a terminator inside of - // the basic block). - // - BasicBlock *splitBasicBlock(iterator I); + /// splitBasicBlock - This splits a basic block into two at the specified + /// instruction. Note that all instructions BEFORE the specified iterator + /// stay as part of the original basic block, an unconditional branch is added + /// to the new BB, and the rest of the instructions in the BB are moved to the + /// new BB, including the old terminator. The newly formed BasicBlock is + /// returned. This function invalidates the specified iterator. + /// + /// Note that this only works on well formed basic blocks (must have a + /// terminator), and 'I' must not be the end of instruction list (which would + /// cause a degenerate basic block to be formed, having a terminator inside of + /// the basic block). + /// + BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = ""); }; +} // End llvm namespace + #endif