1 //===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the declaration of the Function class, which represents a
11 // single function/procedure in LLVM.
13 // A function basically consists of a list of basic blocks, a list of arguments,
14 // and a symbol table.
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_FUNCTION_H
19 #define LLVM_FUNCTION_H
21 #include "llvm/GlobalValue.h"
22 #include "llvm/BasicBlock.h"
23 #include "llvm/Argument.h"
24 #include "Support/Annotation.h"
30 // Traits for intrusive list of instructions...
31 template<> struct ilist_traits<BasicBlock>
32 : public SymbolTableListTraits<BasicBlock, Function, Function> {
34 // createNode is used to create a node that marks the end of the list...
35 static BasicBlock *createNode();
37 static iplist<BasicBlock> &getList(Function *F);
40 template<> struct ilist_traits<Argument>
41 : public SymbolTableListTraits<Argument, Function, Function> {
43 // createNode is used to create a node that marks the end of the list...
44 static Argument *createNode();
45 static iplist<Argument> &getList(Function *F);
48 class Function : public GlobalValue, public Annotable {
50 typedef iplist<Argument> ArgumentListType;
51 typedef iplist<BasicBlock> BasicBlockListType;
53 // BasicBlock iterators...
54 typedef BasicBlockListType::iterator iterator;
55 typedef BasicBlockListType::const_iterator const_iterator;
56 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
57 typedef std::reverse_iterator<iterator> reverse_iterator;
59 typedef ArgumentListType::iterator aiterator;
60 typedef ArgumentListType::const_iterator const_aiterator;
61 typedef std::reverse_iterator<const_aiterator> const_reverse_aiterator;
62 typedef std::reverse_iterator<aiterator> reverse_aiterator;
65 // Important things that make up a function!
66 BasicBlockListType BasicBlocks; // The basic blocks
67 ArgumentListType ArgumentList; // The formal arguments
71 friend class SymbolTableListTraits<Function, Module, Module>;
73 void setParent(Module *parent);
74 Function *Prev, *Next;
75 void setNext(Function *N) { Next = N; }
76 void setPrev(Function *N) { Prev = N; }
79 /// Function ctor - If the (optional) Module argument is specified, the
80 /// function is automatically inserted into the end of the function list for
83 Function(const FunctionType *Ty, LinkageTypes Linkage,
84 const std::string &N = "", Module *M = 0);
87 // Specialize setName to handle symbol table majik...
88 virtual void setName(const std::string &name, SymbolTable *ST = 0);
90 const Type *getReturnType() const; // Return the type of the ret val
91 const FunctionType *getFunctionType() const; // Return the FunctionType for me
93 /// isExternal - Is the body of this function unknown? (The basic block list
94 /// is empty if so.) This is true for external functions, defined as forward
97 virtual bool isExternal() const { return BasicBlocks.empty(); }
99 /// getIntrinsicID - This method returns the ID number of the specified
100 /// function, or Intrinsic::not_intrinsic if the function is not an
101 /// instrinsic, or if the pointer is null. This value is always defined to be
102 /// zero to allow easy checking for whether a function is intrinsic or not.
103 /// The particular intrinsic functions which correspond to this value are
104 /// defined in llvm/Intrinsics.h.
106 unsigned getIntrinsicID() const;
107 bool isIntrinsic() const { return getIntrinsicID() != 0; }
109 /// deleteBody - This method deletes the body of the function, and converts
110 /// the linkage to external.
114 setLinkage(ExternalLinkage);
117 // getNext/Prev - Return the next or previous function in the list. These
118 // methods should never be used directly, and are only used to implement the
119 // function list as part of the module.
121 Function *getNext() { return Next; }
122 const Function *getNext() const { return Next; }
123 Function *getPrev() { return Prev; }
124 const Function *getPrev() const { return Prev; }
126 /// Get the underlying elements of the Function... the basic block list is
127 /// empty for external functions.
129 const ArgumentListType &getArgumentList() const { return ArgumentList; }
130 ArgumentListType &getArgumentList() { return ArgumentList; }
132 const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
133 BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
135 const BasicBlock &getEntryBlock() const { return front(); }
136 BasicBlock &getEntryBlock() { return front(); }
138 //===--------------------------------------------------------------------===//
139 // Symbol Table Accessing functions...
141 /// getSymbolTable() - Return the symbol table...
143 inline SymbolTable &getSymbolTable() { return *SymTab; }
144 inline const SymbolTable &getSymbolTable() const { return *SymTab; }
147 //===--------------------------------------------------------------------===//
148 // BasicBlock iterator forwarding functions
150 iterator begin() { return BasicBlocks.begin(); }
151 const_iterator begin() const { return BasicBlocks.begin(); }
152 iterator end () { return BasicBlocks.end(); }
153 const_iterator end () const { return BasicBlocks.end(); }
155 reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
156 const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
157 reverse_iterator rend () { return BasicBlocks.rend(); }
158 const_reverse_iterator rend () const { return BasicBlocks.rend(); }
160 unsigned size() const { return BasicBlocks.size(); }
161 bool empty() const { return BasicBlocks.empty(); }
162 const BasicBlock &front() const { return BasicBlocks.front(); }
163 BasicBlock &front() { return BasicBlocks.front(); }
164 const BasicBlock &back() const { return BasicBlocks.back(); }
165 BasicBlock &back() { return BasicBlocks.back(); }
167 //===--------------------------------------------------------------------===//
168 // Argument iterator forwarding functions
170 aiterator abegin() { return ArgumentList.begin(); }
171 const_aiterator abegin() const { return ArgumentList.begin(); }
172 aiterator aend () { return ArgumentList.end(); }
173 const_aiterator aend () const { return ArgumentList.end(); }
175 reverse_aiterator arbegin() { return ArgumentList.rbegin(); }
176 const_reverse_aiterator arbegin() const { return ArgumentList.rbegin(); }
177 reverse_aiterator arend () { return ArgumentList.rend(); }
178 const_reverse_aiterator arend () const { return ArgumentList.rend(); }
180 unsigned asize() const { return ArgumentList.size(); }
181 bool aempty() const { return ArgumentList.empty(); }
182 const Argument &afront() const { return ArgumentList.front(); }
183 Argument &afront() { return ArgumentList.front(); }
184 const Argument &aback() const { return ArgumentList.back(); }
185 Argument &aback() { return ArgumentList.back(); }
187 virtual void print(std::ostream &OS) const { print(OS, 0); }
188 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
190 /// viewCFG - This function is meant for use from the debugger. You can just
191 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
192 /// program, displaying the CFG of the current function with the code for each
193 /// basic block inside. This depends on there being a 'dot' and 'gv' program
196 void viewCFG() const;
198 /// viewCFGOnly - This function is meant for use from the debugger. It works
199 /// just like viewCFG, but it does not include the contents of basic blocks
200 /// into the nodes, just the label. If you are only interested in the CFG
201 /// this can make the graph smaller.
203 void viewCFGOnly() const;
205 /// Methods for support type inquiry through isa, cast, and dyn_cast:
206 static inline bool classof(const Function *) { return true; }
207 static inline bool classof(const Value *V) {
208 return V->getValueType() == Value::FunctionVal;
211 /// dropAllReferences() - This method causes all the subinstructions to "let
212 /// go" of all references that they are maintaining. This allows one to
213 /// 'delete' a whole module at a time, even though there may be circular
214 /// references... first all references are dropped, and all use counts go to
215 /// zero. Then everything is deleted for real. Note that no operations are
216 /// valid on an object that has "dropped all references", except operator
219 /// Since no other object in the module can have references into the body of a
220 /// function, dropping all references deletes the entire body of the function,
221 /// including any contained basic blocks.
223 void dropAllReferences();
226 } // End llvm namespace