//===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===//
//
-// This file contains the declaration of the Function class, which represents a
+// 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 LLVM.
//
// A function basically consists of a list of basic blocks, a list of arguments,
#include "llvm/GlobalValue.h"
#include "llvm/BasicBlock.h"
#include "llvm/Argument.h"
+#include "llvm/Support/Annotation.h"
+
+namespace llvm {
class FunctionType;
+class ParamAttrsList;
// Traits for intrusive list of instructions...
template<> struct ilist_traits<BasicBlock>
- : public SymbolTableListTraits<BasicBlock, Function, Function> {
-
- // createNode is used to create a node that marks the end of the list...
- static BasicBlock *createNode();
+ : public SymbolTableListTraits<BasicBlock, Function> {
+ // createSentinel is used to create a node that marks the end of the list...
+ static BasicBlock *createSentinel();
+ static void destroySentinel(BasicBlock *BB) { delete BB; }
static iplist<BasicBlock> &getList(Function *F);
+ static ValueSymbolTable *getSymTab(Function *ItemParent);
+ static int getListOffset();
};
template<> struct ilist_traits<Argument>
- : public SymbolTableListTraits<Argument, Function, Function> {
+ : public SymbolTableListTraits<Argument, Function> {
- // createNode is used to create a node that marks the end of the list...
- static Argument *createNode();
+ // createSentinel is used to create a node that marks the end of the list...
+ static Argument *createSentinel();
+ static void destroySentinel(Argument *A) { delete A; }
static iplist<Argument> &getList(Function *F);
+ static ValueSymbolTable *getSymTab(Function *ItemParent);
+ static int getListOffset();
};
-class Function : public GlobalValue {
+class Function : public GlobalValue, public Annotable {
public:
typedef iplist<Argument> ArgumentListType;
typedef iplist<BasicBlock> BasicBlockListType;
// BasicBlock iterators...
typedef BasicBlockListType::iterator iterator;
typedef BasicBlockListType::const_iterator const_iterator;
- typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
- typedef std::reverse_iterator<iterator> reverse_iterator;
- typedef ArgumentListType::iterator aiterator;
- typedef ArgumentListType::const_iterator const_aiterator;
- typedef std::reverse_iterator<const_aiterator> const_reverse_aiterator;
- typedef std::reverse_iterator<aiterator> reverse_aiterator;
+ typedef ArgumentListType::iterator arg_iterator;
+ typedef ArgumentListType::const_iterator const_arg_iterator;
private:
-
// Important things that make up a function!
- BasicBlockListType BasicBlocks; // The basic blocks
- ArgumentListType ArgumentList; // The formal arguments
+ BasicBlockListType BasicBlocks; ///< The basic blocks
+ ArgumentListType ArgumentList; ///< The formal arguments
+ ValueSymbolTable *SymTab; ///< Symbol table of args/instructions
+ ParamAttrsList *ParamAttrs; ///< Parameter attributes
- SymbolTable *SymTab;
- friend class SymbolTableListTraits<Function, Module, Module>;
+ // The Calling Convention is stored in Value::SubclassData.
+ /*unsigned CallingConvention;*/
+
+ friend class SymbolTableListTraits<Function, Module>;
void setParent(Module *parent);
Function *Prev, *Next;
const std::string &N = "", Module *M = 0);
~Function();
- // Specialize setName to handle symbol table majik...
- virtual void setName(const std::string &name, SymbolTable *ST = 0);
-
const Type *getReturnType() const; // Return the type of the ret val
const FunctionType *getFunctionType() const; // Return the FunctionType for me
- /// 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
+ /// isVarArg - Return true if this function takes a variable number of
+ /// arguments.
+ bool isVarArg() const;
+
+ /// isDeclaration - Is the body of this function unknown? (The basic block
+ /// list is empty if so.) This is true for function declarations, but not
+ /// true for function definitions.
///
- virtual bool isExternal() const { return BasicBlocks.empty(); }
+ virtual bool isDeclaration() const { return BasicBlocks.empty(); }
/// getIntrinsicID - This method returns the ID number of the specified
- /// function, or LLVMIntrinsic::not_intrinsic if the function is not an
+ /// 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;
+ unsigned getIntrinsicID(bool noAssert = false) const;
bool isIntrinsic() const { return getIntrinsicID() != 0; }
+ /// getCallingConv()/setCallingConv(uint) - These method get and set the
+ /// calling convention of this function. The enum values for the known
+ /// calling conventions are defined in CallingConv.h.
+ unsigned getCallingConv() const { return SubclassData; }
+ void setCallingConv(unsigned CC) { SubclassData = CC; }
+
+ /// Obtains a constant pointer to the ParamAttrsList object which holds the
+ /// parameter attributes information, if any.
+ /// @returns 0 if no parameter attributes have been set.
+ /// @brief Get the parameter attributes.
+ const ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
+
+ /// Sets the parameter attributes for this Function. To construct a
+ /// ParamAttrsList, see ParameterAttributes.h
+ /// @brief Set the parameter attributes.
+ void setParamAttrs(ParamAttrsList *attrs) { ParamAttrs = attrs; }
+
/// deleteBody - This method deletes the body of the function, and converts
/// the linkage to external.
+ ///
void deleteBody() {
dropAllReferences();
setLinkage(ExternalLinkage);
}
- // 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; }
+ /// 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();
+
/// Get the underlying elements of the Function... the basic block list is
/// empty for external functions.
/// getSymbolTable() - Return the symbol table...
///
- inline SymbolTable &getSymbolTable() { return *SymTab; }
- inline const SymbolTable &getSymbolTable() const { return *SymTab; }
+ inline ValueSymbolTable &getValueSymbolTable() { return *SymTab; }
+ inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
+
-
//===--------------------------------------------------------------------===//
// BasicBlock iterator forwarding functions
//
iterator end () { return BasicBlocks.end(); }
const_iterator end () const { return BasicBlocks.end(); }
- reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
- const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
- 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
//
- aiterator abegin() { return ArgumentList.begin(); }
- const_aiterator abegin() const { return ArgumentList.begin(); }
- aiterator aend () { return ArgumentList.end(); }
- const_aiterator aend () const { return ArgumentList.end(); }
-
- reverse_aiterator arbegin() { return ArgumentList.rbegin(); }
- const_reverse_aiterator arbegin() const { return ArgumentList.rbegin(); }
- 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(); }
+ arg_iterator arg_begin() { return ArgumentList.begin(); }
+ const_arg_iterator arg_begin() const { return ArgumentList.begin(); }
+ arg_iterator arg_end () { return ArgumentList.end(); }
+ const_arg_iterator arg_end () const { return ArgumentList.end(); }
+
+ size_t arg_size () const { return ArgumentList.size(); }
+ bool arg_empty() const { return ArgumentList.empty(); }
+
+ virtual void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream *OS) const { if (OS) print(*OS); }
+ 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;
- virtual void print(std::ostream &OS) 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;
+ return V->getValueID() == Value::FunctionVal;
}
/// 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 delete'd for real. Note that no operations are
- /// valid on an object that has "dropped all references", except operator
+ /// 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
/// including any contained basic blocks.
///
void dropAllReferences();
+
+ static unsigned getBasicBlockListOffset() {
+ Function *Obj = 0;
+ return unsigned(reinterpret_cast<uintptr_t>(&Obj->BasicBlocks));
+ }
+ static unsigned getArgumentListOffset() {
+ Function *Obj = 0;
+ return unsigned(reinterpret_cast<uintptr_t>(&Obj->ArgumentList));
+ }
+private:
+ // 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; }
};
+inline ValueSymbolTable *
+ilist_traits<BasicBlock>::getSymTab(Function *F) {
+ return F ? &F->getValueSymbolTable() : 0;
+}
+
+inline ValueSymbolTable *
+ilist_traits<Argument>::getSymTab(Function *F) {
+ return F ? &F->getValueSymbolTable() : 0;
+}
+
+inline int
+ilist_traits<BasicBlock>::getListOffset() {
+ return Function::getBasicBlockListOffset();
+}
+
+inline int
+ilist_traits<Argument>::getListOffset() {
+ return Function::getArgumentListOffset();
+}
+
+
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff