X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FBasicBlock.h;h=e545a575262a5d772821fa5df60a8c9a0e264826;hb=2542d9a18304d60576158e635f6123f60bbd80ba;hp=d7f286ec5616c088187466402517e1cf37869377;hpb=7b6f5a3ee9a68d0f6206b1695f71551a467e33c4;p=oota-llvm.git diff --git a/include/llvm/BasicBlock.h b/include/llvm/BasicBlock.h index d7f286ec561..e545a575262 100644 --- a/include/llvm/BasicBlock.h +++ b/include/llvm/BasicBlock.h @@ -1,77 +1,104 @@ //===-- llvm/BasicBlock.h - Represent a basic block in the VM ----*- C++ -*--=// -// -// This file contains the declaration of the BasicBlock class, which represents -// a single basic block in the VM. -// -// Note that basic blocks themselves are Def's, because they are referenced -// by instructions like branches and can go in switch tables and stuff... -// -// This may see wierd at first, but it's really pretty cool. :) -// -//===----------------------------------------------------------------------===// -// -// 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. -// +/// +/// \class BasicBlock +/// +/// This file contains the declaration of the BasicBlock class, which represents +/// a single basic block in the VM. +/// +/// 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 modification to a program. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_BASICBLOCK_H #define LLVM_BASICBLOCK_H -#include "llvm/Value.h" // Get the definition of Value -#include "llvm/ValueHolder.h" -#include "llvm/CFGdecls.h" +#include "llvm/Instruction.h" +#include "llvm/SymbolTableListTraits.h" +#include "Support/ilist" -class Instruction; -class Method; -class BasicBlock; class TerminatorInst; - -typedef UseTy BasicBlockUse; +template class SuccIterator; // Successor Iterator +template class PredIterator; + +template<> struct ilist_traits + : public SymbolTableListTraits { + // createNode is used to create a node that marks the end of the list... + static Instruction *createNode(); + static iplist &getList(BasicBlock *BB); +}; class BasicBlock : public Value { // Basic blocks are data objects also public: - typedef ValueHolder InstListType; + typedef iplist InstListType; private : InstListType InstList; + BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list + + void setParent(Function *parent); + void setNext(BasicBlock *N) { Next = N; } + void setPrev(BasicBlock *N) { Prev = N; } + friend class SymbolTableListTraits; - friend class ValueHolder; - void setParent(Method *parent); + BasicBlock(const BasicBlock &); // Do not implement + void operator=(const BasicBlock &); // Do not implement public: - // Instruction iterators... + /// Instruction iterators... typedef InstListType::iterator iterator; typedef InstListType::const_iterator const_iterator; - typedef reverse_iterator const_reverse_iterator; - typedef reverse_iterator reverse_iterator; + typedef std::reverse_iterator const_reverse_iterator; + typedef std::reverse_iterator reverse_iterator; - typedef cfg::succ_iterator succ_iterator; // Include CFG.h to use these - typedef cfg::pred_iterator pred_iterator; - typedef cfg::succ_const_iterator succ_const_iterator; - typedef cfg::pred_const_iterator pred_const_iterator; - - BasicBlock(const string &Name = "", Method *Parent = 0); + /// 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(); // Specialize setName to take care of symbol table majik - virtual void setName(const string &name); - - const Method *getParent() const { return (const Method*)InstList.getParent();} - Method *getParent() { return (Method*)InstList.getParent(); } - - // 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. - // + virtual void setName(const std::string &name, SymbolTable *ST = 0); + + /// getParent - Return the enclosing method, or null if none + /// + const Function *getParent() const { return InstList.getParent(); } + Function *getParent() { return InstList.getParent(); } + + // getNext/Prev - Return the next or previous basic block in the list. + BasicBlock *getNext() { return Next; } + const BasicBlock *getNext() const { return Next; } + 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. + /// 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(); } @@ -84,54 +111,62 @@ public: inline unsigned size() const { return InstList.size(); } inline bool empty() const { return InstList.empty(); } - inline const Instruction *front() const { return InstList.front(); } - inline Instruction *front() { return InstList.front(); } - 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. - // + inline const Instruction &front() const { return InstList.front(); } + inline Instruction &front() { return InstList.front(); } + 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. + /// const InstListType &getInstList() const { return InstList; } InstListType &getInstList() { return InstList; } - // hasConstantPoolReferences() - 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 hasConstantPoolReferences() 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. - // + virtual void print(std::ostream &OS) const; + + /// 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. + /// + 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. + /// 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). - // + /// 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); };