-//===-- llvm/Function.h - Class to represent a single VM function -*- C++ -*-=//
+//===-- llvm/Function.h - Class to represent a single function --*- 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 Function class, which represents a
-// single function/procedure in the VM.
+// single function/procedure in LLVM.
//
-// Note that BasicBlock's in the Function are Value's, because they are
-// referenced by instructions like calls and can go into virtual function tables
-// and stuff.
+// A function basically consists of a list of basic blocks, a list of arguments,
+// and a symbol table.
//
//===----------------------------------------------------------------------===//
#include "llvm/GlobalValue.h"
#include "llvm/BasicBlock.h"
#include "llvm/Argument.h"
+#include "llvm/Support/Annotation.h"
+
+namespace llvm {
class FunctionType;
: public SymbolTableListTraits<BasicBlock, Function, Function> {
// createNode is used to create a node that marks the end of the list...
- static BasicBlock *createNode() { return new BasicBlock(); }
+ static BasicBlock *createNode();
static iplist<BasicBlock> &getList(Function *F);
};
static iplist<Argument> &getList(Function *F);
};
-class Function : public GlobalValue {
+class Function : public GlobalValue, public Annotable {
public:
typedef iplist<Argument> ArgumentListType;
typedef iplist<BasicBlock> BasicBlockListType;
typedef std::reverse_iterator<aiterator> reverse_aiterator;
private:
-
// Important things that make up a function!
- BasicBlockListType BasicBlocks; // The basic blocks
+ BasicBlockListType BasicBlocks; // The basic blocks
ArgumentListType ArgumentList; // The formal arguments
- SymbolTable *SymTab, *ParentSymTab;
+ SymbolTable *SymTab;
friend class SymbolTableListTraits<Function, Module, Module>;
void setPrev(Function *N) { Prev = N; }
public:
- Function(const FunctionType *Ty, bool isInternal, const std::string &N = "");
+ /// Function ctor - If the (optional) Module argument is specified, the
+ /// function is automatically inserted into the end of the function list for
+ /// the module.
+ ///
+ Function(const FunctionType *Ty, LinkageTypes Linkage,
+ const std::string &N = "", Module *M = 0);
~Function();
// Specialize setName to handle symbol table majik...
const Type *getReturnType() const; // Return the type of the ret val
const FunctionType *getFunctionType() const; // Return the FunctionType for me
- // Is the body of this function unknown? (the basic block list is empty if so)
- // this is true for external functions, defined as forward "declare"ations
- bool isExternal() const { return BasicBlocks.empty(); }
+ /// isExternal - Is the body of this function unknown? (The basic block list
+ /// is empty if so.) This is true for external functions, defined as forward
+ /// "declare"ations
+ ///
+ virtual bool isExternal() const { return BasicBlocks.empty(); }
+
+ /// getIntrinsicID - This method returns the ID number of the specified
+ /// function, or Intrinsic::not_intrinsic if the function is not an
+ /// instrinsic, or if the pointer is null. This value is always defined to be
+ /// zero to allow easy checking for whether a function is intrinsic or not.
+ /// The particular intrinsic functions which correspond to this value are
+ /// defined in llvm/Intrinsics.h.
+ ///
+ unsigned getIntrinsicID() const;
+ bool isIntrinsic() const { return getIntrinsicID() != 0; }
+
+ /// renameLocalSymbols - This method goes through the Function's symbol table
+ /// and renames any symbols that conflict with symbols at global scope. This
+ /// is required before printing out to a textual form, to ensure that there is
+ /// no ambiguity when parsing.
+ void renameLocalSymbols();
+
+
+ /// deleteBody - This method deletes the body of the function, and converts
+ /// the linkage to external.
+ ///
+ void deleteBody() {
+ dropAllReferences();
+ setLinkage(ExternalLinkage);
+ }
+
+ /// removeFromParent - This method unlinks 'this' from the containing module,
+ /// but does not delete it.
+ ///
+ void removeFromParent();
+
+ /// eraseFromParent - This method unlinks 'this' from the containing module
+ /// and deletes it.
+ ///
+ void eraseFromParent();
+
- // getNext/Prev - Return the next or previous instruction in the list. The
- // last node in the list is a terminator instruction.
+ // getNext/Prev - Return the next or previous function in the list. These
+ // methods should never be used directly, and are only used to implement the
+ // function list as part of the module.
+ //
Function *getNext() { return Next; }
const Function *getNext() const { return Next; }
Function *getPrev() { return Prev; }
const Function *getPrev() const { return Prev; }
- // Get the underlying elements of the Function... both the argument list and
- // basic block list are empty for external functions.
- //
+ /// Get the underlying elements of the Function... the basic block list is
+ /// empty for external functions.
+ ///
const ArgumentListType &getArgumentList() const { return ArgumentList; }
ArgumentListType &getArgumentList() { return ArgumentList; }
const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
- const BasicBlock &getEntryNode() const { return front(); }
- BasicBlock &getEntryNode() { return front(); }
+ const BasicBlock &getEntryBlock() const { return front(); }
+ BasicBlock &getEntryBlock() { return front(); }
//===--------------------------------------------------------------------===//
// Symbol Table Accessing functions...
- // hasSymbolTable() - Returns true if there is a symbol table allocated to
- // this object AND if there is at least one name in it!
- //
- bool hasSymbolTable() const;
-
- // CAUTION: The current symbol table may be null if there are no names (ie,
- // the symbol table is empty)
- //
- inline SymbolTable *getSymbolTable() { return SymTab; }
- inline const SymbolTable *getSymbolTable() const { return SymTab; }
-
- // getSymbolTableSure is guaranteed to not return a null pointer, because if
- // the function does not already have a symtab, one is created. Use this if
- // you intend to put something into the symbol table for the function.
- //
- SymbolTable *getSymbolTableSure(); // Implemented in Value.cpp
+ /// getSymbolTable() - Return the symbol table...
+ ///
+ inline SymbolTable &getSymbolTable() { return *SymTab; }
+ inline const SymbolTable &getSymbolTable() const { return *SymTab; }
//===--------------------------------------------------------------------===//
reverse_iterator rend () { return BasicBlocks.rend(); }
const_reverse_iterator rend () const { return BasicBlocks.rend(); }
- unsigned size() const { return BasicBlocks.size(); }
+ size_t size() const { return BasicBlocks.size(); }
bool empty() const { return BasicBlocks.empty(); }
const BasicBlock &front() const { return BasicBlocks.front(); }
BasicBlock &front() { return BasicBlocks.front(); }
- const BasicBlock &back() const { return BasicBlocks.back(); }
- BasicBlock &back() { return BasicBlocks.back(); }
+ const BasicBlock &back() const { return BasicBlocks.back(); }
+ BasicBlock &back() { return BasicBlocks.back(); }
//===--------------------------------------------------------------------===//
// Argument iterator forwarding functions
reverse_aiterator arend () { return ArgumentList.rend(); }
const_reverse_aiterator arend () const { return ArgumentList.rend(); }
- unsigned asize() const { return ArgumentList.size(); }
- bool aempty() const { return ArgumentList.empty(); }
- const Argument &afront() const { return ArgumentList.front(); }
- Argument &afront() { return ArgumentList.front(); }
- const Argument &aback() const { return ArgumentList.back(); }
- Argument &aback() { return ArgumentList.back(); }
-
- virtual void print(std::ostream &OS) const;
-
- // Methods for support type inquiry through isa, cast, and dyn_cast:
+ size_t asize() const { return ArgumentList.size(); }
+ bool aempty() const { return ArgumentList.empty(); }
+ const Argument &afront() const { return ArgumentList.front(); }
+ Argument &afront() { return ArgumentList.front(); }
+ const Argument &aback() const { return ArgumentList.back(); }
+ Argument &aback() { return ArgumentList.back(); }
+
+ virtual void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
+
+ /// viewCFG - This function is meant for use from the debugger. You can just
+ /// say 'call F->viewCFG()' and a ghostview window should pop up from the
+ /// program, displaying the CFG of the current function with the code for each
+ /// basic block inside. This depends on there being a 'dot' and 'gv' program
+ /// in your path.
+ ///
+ void viewCFG() const;
+
+ /// viewCFGOnly - This function is meant for use from the debugger. It works
+ /// just like viewCFG, but it does not include the contents of basic blocks
+ /// into the nodes, just the label. If you are only interested in the CFG
+ /// this can make the graph smaller.
+ ///
+ void viewCFGOnly() const;
+
+ /// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Function *) { return true; }
static inline bool classof(const Value *V) {
return V->getValueType() == Value::FunctionVal;
}
- // 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 method causes all the subinstructions to "let
+ /// go" of all references that they are maintaining. This allows one to
+ /// 'delete' a whole module 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 deleted for real. Note that no operations are
+ /// valid on an object that has "dropped all references", except operator
+ /// delete.
+ ///
+ /// Since no other object in the module can have references into the body of a
+ /// function, dropping all references deletes the entire body of the function,
+ /// including any contained basic blocks.
+ ///
void dropAllReferences();
};
+} // End llvm namespace
+
#endif