-//===-- llvm/Method.h - Class to represent a single VM method ----*- C++ -*--=//
+//===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===//
//
-// This file contains the declaration of the Method class, which represents a
-// single Method/function/procedure in the VM.
+// The LLVM Compiler Infrastructure
//
-// Note that basic blocks themselves are Def's, because they are referenced
-// by instructions like calls and can go in virtual function tables and stuff.
+// 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,
+// and a symbol table.
//
//===----------------------------------------------------------------------===//
-#ifndef LLVM_METHOD_H
-#define LLVM_METHOD_H
+#ifndef LLVM_FUNCTION_H
+#define LLVM_FUNCTION_H
-#include "llvm/SymTabValue.h"
-#include "llvm/BasicBlock.h"
#include "llvm/GlobalValue.h"
+#include "llvm/BasicBlock.h"
+#include "llvm/Argument.h"
+#include "llvm/ParameterAttributes.h"
+#include "llvm/Support/Annotation.h"
+
+namespace llvm {
+
+class FunctionType;
+class ParamAttrsList;
-class Instruction;
-class BasicBlock;
-class MethodArgument;
-class MethodType;
-class Module;
+// Traits for intrusive list of instructions...
+template<> struct ilist_traits<BasicBlock>
+ : public SymbolTableListTraits<BasicBlock, Function> {
-class Method : public GlobalValue, public SymTabValue {
+ // 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> {
+
+ // 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, public Annotable {
+protected:
+ static void destroyThis(Function*v);
+ friend class Value;
public:
- typedef ValueHolder<MethodArgument, Method, Method> ArgumentListType;
- typedef ValueHolder<BasicBlock , Method, Method> BasicBlocksType;
+ typedef iplist<Argument> ArgumentListType;
+ typedef iplist<BasicBlock> BasicBlockListType;
// BasicBlock iterators...
- typedef BasicBlocksType::iterator iterator;
- typedef BasicBlocksType::const_iterator const_iterator;
- typedef reverse_iterator<const_iterator> const_reverse_iterator;
- typedef reverse_iterator<iterator> reverse_iterator;
+ typedef BasicBlockListType::iterator iterator;
+ typedef BasicBlockListType::const_iterator const_iterator;
-private:
+ typedef ArgumentListType::iterator arg_iterator;
+ typedef ArgumentListType::const_iterator const_arg_iterator;
- // Important things that make up a method!
- BasicBlocksType BasicBlocks; // The basic blocks
- ArgumentListType ArgumentList; // The formal arguments
+private:
+ // Important things that make up a function!
+ BasicBlockListType BasicBlocks; ///< The basic blocks
+ mutable ArgumentListType ArgumentList; ///< The formal arguments
+ ValueSymbolTable *SymTab; ///< Symbol table of args/instructions
+ const ParamAttrsList *ParamAttrs; ///< Parameter attributes
+
+ // The Calling Convention is stored in Value::SubclassData.
+ /*unsigned CallingConvention;*/
- Module *Parent; // The module that contains this method
+ friend class SymbolTableListTraits<Function, Module>;
- friend class ValueHolder<Method, Module, Module>;
void setParent(Module *parent);
+ Function *Prev, *Next;
+ void setNext(Function *N) { Next = N; }
+ void setPrev(Function *N) { Prev = N; }
+ // 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; }
+
+ /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
+ /// built on demand, so that the list isn't allocated until the first client
+ /// needs it. The hasLazyArguments predicate returns true if the arg list
+ /// hasn't been set up yet.
+ bool hasLazyArguments() const {
+ return SubclassData & 1;
+ }
+ void CheckLazyArguments() const {
+ if (hasLazyArguments())
+ BuildLazyArguments();
+ }
+ void BuildLazyArguments() const;
public:
- Method(const MethodType *Ty, const string &Name = "");
- ~Method();
+ /// 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);
+
+ const Type *getReturnType() const; // Return the type of the ret val
+ const FunctionType *getFunctionType() const; // Return the FunctionType for me
+
+ /// 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 isDeclaration() 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(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 >> 1; }
+ void setCallingConv(unsigned CC) {
+ SubclassData = (SubclassData & 1) | (CC << 1);
+ }
+
+ /// 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(const ParamAttrsList *attrs);
+
+ /// @brief Determine whether the function has the given attribute.
+ bool paramHasAttr(uint16_t i, ParameterAttributes attr) const {
+ return ParamAttrs && ParamAttrs->paramHasAttr(i, attr);
+ }
+
+ /// @brief Determine if the function does not access memory.
+ bool doesNotAccessMemory() const {
+ return paramHasAttr(0, ParamAttr::ReadNone);
+ }
- // Specialize setName to handle symbol table majik...
- virtual void setName(const string &name, SymbolTable *ST = 0);
+ /// @brief Determine if the function does not access or only reads memory.
+ bool onlyReadsMemory() const {
+ return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
+ }
- const Type *getReturnType() const; // Return the return type of method
- const MethodType *getMethodType() const; // Return the MethodType for me
+ /// @brief Determine if the function returns a structure.
+ bool isStructReturn() const {
+ return paramHasAttr(1, ParamAttr::StructRet);
+ }
- // Is the body of this method unknown? (the basic block list is empty if so)
- // this is true for external methods, defined as forward "declare"ations
- bool isExternal() const { return BasicBlocks.empty(); }
+ /// 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();
- // Get the class structure that this method is contained inside of...
- inline Module *getParent() { return Parent; }
- inline const Module *getParent() const { return Parent; }
+ /// eraseFromParent - This method unlinks 'this' from the containing module
+ /// and deletes it.
+ ///
+ void eraseFromParent();
- // Get the underlying elements of the Method...
- inline const ArgumentListType &getArgumentList() const{ return ArgumentList; }
- inline ArgumentListType &getArgumentList() { return ArgumentList; }
- inline const BasicBlocksType &getBasicBlocks() const { return BasicBlocks; }
- inline BasicBlocksType &getBasicBlocks() { return BasicBlocks; }
+ /// Get the underlying elements of the Function... the basic block list is
+ /// empty for external functions.
+ ///
+ const ArgumentListType &getArgumentList() const {
+ CheckLazyArguments();
+ return ArgumentList;
+ }
+ ArgumentListType &getArgumentList() {
+ CheckLazyArguments();
+ return ArgumentList;
+ }
+
+ const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
+ BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
+ const BasicBlock &getEntryBlock() const { return front(); }
+ BasicBlock &getEntryBlock() { return front(); }
//===--------------------------------------------------------------------===//
- // BasicBlock iterator forwarding functions
- //
- inline iterator begin() { return BasicBlocks.begin(); }
- inline const_iterator begin() const { return BasicBlocks.begin(); }
- inline iterator end () { return BasicBlocks.end(); }
- inline const_iterator end () const { return BasicBlocks.end(); }
-
- inline reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
- inline const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
- inline reverse_iterator rend () { return BasicBlocks.rend(); }
- inline const_reverse_iterator rend () const { return BasicBlocks.rend(); }
-
- inline unsigned size() const { return BasicBlocks.size(); }
- inline bool empty() const { return BasicBlocks.empty(); }
- inline const BasicBlock *front() const { return BasicBlocks.front(); }
- inline BasicBlock *front() { return BasicBlocks.front(); }
- inline const BasicBlock *back() const { return BasicBlocks.back(); }
- inline BasicBlock *back() { return BasicBlocks.back(); }
-
-
- // Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const Method *T) { return true; }
- static inline bool classof(const Value *V) {
- return V->getValueType() == Value::MethodVal;
- }
+ // Symbol Table Accessing functions...
+
+ /// getSymbolTable() - Return the symbol table...
+ ///
+ inline ValueSymbolTable &getValueSymbolTable() { return *SymTab; }
+ inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
- // 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();
//===--------------------------------------------------------------------===//
- // Method Instruction iterator code
+ // BasicBlock iterator forwarding functions
+ //
+ iterator begin() { return BasicBlocks.begin(); }
+ const_iterator begin() const { return BasicBlocks.begin(); }
+ iterator end () { return BasicBlocks.end(); }
+ const_iterator end () const { return BasicBlocks.end(); }
+
+ 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(); }
+
//===--------------------------------------------------------------------===//
- //
- template <class _BB_t, class _BB_i_t, class _BI_t, class _II_t>
- class InstIterator;
- typedef InstIterator<BasicBlocksType, iterator,
- BasicBlock::iterator, Instruction*> inst_iterator;
- typedef InstIterator<const BasicBlocksType, const_iterator,
- BasicBlock::const_iterator,
- const Instruction*> inst_const_iterator;
-
- // This inner class is used to implement inst_begin() & inst_end() for
- // inst_iterator and inst_const_iterator's.
+ // Argument iterator forwarding functions
//
- template <class _BB_t, class _BB_i_t, class _BI_t, class _II_t>
- class InstIterator {
- typedef _BB_t BBty;
- typedef _BB_i_t BBIty;
- typedef _BI_t BIty;
- typedef _II_t IIty;
- _BB_t &BBs; // BasicBlocksType
- _BB_i_t BB; // BasicBlocksType::iterator
- _BI_t BI; // BasicBlock::iterator
- public:
- typedef bidirectional_iterator_tag iterator_category;
-
- template<class M> InstIterator(M &m)
- : BBs(m.getBasicBlocks()), BB(BBs.begin()) { // begin ctor
- if (BB != BBs.end()) {
- BI = (*BB)->begin();
- resyncInstructionIterator();
- }
- }
-
- template<class M> InstIterator(M &m, bool)
- : BBs(m.getBasicBlocks()), BB(BBs.end()) { // end ctor
- }
-
- // Accessors to get at the underlying iterators...
- inline BBIty &getBasicBlockIterator() { return BB; }
- inline BIty &getInstructionIterator() { return BI; }
-
- inline IIty operator*() const { return *BI; }
- inline IIty operator->() const { return operator*(); }
-
- inline bool operator==(const InstIterator &y) const {
- return BB == y.BB && (BI == y.BI || BB == BBs.end());
- }
- inline bool operator!=(const InstIterator& y) const {
- return !operator==(y);
- }
-
- // resyncInstructionIterator - This should be called if the
- // InstructionIterator is modified outside of our control. This resynchs
- // the internals of the InstIterator to a consistent state.
- //
- inline void resyncInstructionIterator() {
- // The only way that the II could be broken is if it is now pointing to
- // the end() of the current BasicBlock and there are successor BBs.
- while (BI == (*BB)->end()) {
- ++BB;
- if (BB == BBs.end()) break;
- BI = (*BB)->begin();
- }
- }
-
- InstIterator& operator++() {
- ++BI;
- resyncInstructionIterator(); // Make sure it is still valid.
- return *this;
- }
- inline InstIterator operator++(int) {
- InstIterator tmp = *this; ++*this; return tmp;
- }
-
- InstIterator& operator--() {
- while (BB == BBs.end() || BI == (*BB)->begin()) {
- --BB;
- BI = (*BB)->end();
- }
- --BI;
- return *this;
- }
- inline InstIterator operator--(int) {
- InstIterator tmp = *this; --*this; return tmp;
- }
-
- inline bool atEnd() const { return BB == BBs.end(); }
- };
-
- inline inst_iterator inst_begin() { return inst_iterator(*this); }
- inline inst_iterator inst_end() { return inst_iterator(*this, true); }
- inline inst_const_iterator inst_begin() const { return inst_const_iterator(*this); }
- inline inst_const_iterator inst_end() const { return inst_const_iterator(*this, true); }
-};
+ arg_iterator arg_begin() {
+ CheckLazyArguments();
+ return ArgumentList.begin();
+ }
+ const_arg_iterator arg_begin() const {
+ CheckLazyArguments();
+ return ArgumentList.begin();
+ }
+ arg_iterator arg_end() {
+ CheckLazyArguments();
+ return ArgumentList.end();
+ }
+ const_arg_iterator arg_end() const {
+ CheckLazyArguments();
+ return ArgumentList.end();
+ }
-// Provide specializations of GraphTraits to be able to treat a method as a
-// graph of basic blocks... these are the same as the basic block iterators,
-// except that the root node is implicitly the first node of the method.
-//
-template <> struct GraphTraits<Method*> : public GraphTraits<BasicBlock*> {
- static NodeType *getEntryNode(Method *M) { return M->front(); }
-};
-template <> struct GraphTraits<const Method*> :
- public GraphTraits<const BasicBlock*> {
- static NodeType *getEntryNode(const Method *M) { return M->front(); }
-};
+ size_t arg_size() const;
+ bool arg_empty() const;
+
+ 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;
+
+ /// 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->getValueID() == Value::FunctionVal;
+ }
-// Provide specializations of GraphTraits to be able to treat a method as a
-// graph of basic blocks... and to walk it in inverse order. Inverse order for
-// a method is considered to be when traversing the predecessor edges of a BB
-// instead of the successor edges.
-//
-template <> struct GraphTraits<Inverse<Method*> > :
- public GraphTraits<Inverse<BasicBlock*> > {
- static NodeType *getEntryNode(Inverse<Method *> G) { return G.Graph->front();}
-};
-template <> struct GraphTraits<Inverse<const Method*> > :
- public GraphTraits<Inverse<const BasicBlock*> > {
- static NodeType *getEntryNode(Inverse<const Method *> G) {
- return G.Graph->front();
+ /// 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();
+
+ 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));
}
};
+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