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 "llvm/Support/Annotation.h"
30 // Traits for intrusive list of instructions...
31 template<> struct ilist_traits<BasicBlock>
32 : public SymbolTableListTraits<BasicBlock, Function, Function> {
34 // createSentinal is used to create a node that marks the end of the list...
35 static BasicBlock *createSentinal();
36 static void destroySentinal(BasicBlock *BB) { delete BB; }
37 static iplist<BasicBlock> &getList(Function *F);
40 template<> struct ilist_traits<Argument>
41 : public SymbolTableListTraits<Argument, Function, Function> {
43 // createSentinal is used to create a node that marks the end of the list...
44 static Argument *createSentinal();
45 static void destroySentinal(Argument *A) { delete A; }
46 static iplist<Argument> &getList(Function *F);
49 class Function : public GlobalValue, public Annotable {
51 typedef iplist<Argument> ArgumentListType;
52 typedef iplist<BasicBlock> BasicBlockListType;
54 // BasicBlock iterators...
55 typedef BasicBlockListType::iterator iterator;
56 typedef BasicBlockListType::const_iterator const_iterator;
57 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
58 typedef std::reverse_iterator<iterator> reverse_iterator;
60 typedef ArgumentListType::iterator aiterator;
61 typedef ArgumentListType::const_iterator const_aiterator;
62 typedef std::reverse_iterator<const_aiterator> const_reverse_aiterator;
63 typedef std::reverse_iterator<aiterator> reverse_aiterator;
66 // Important things that make up a function!
67 BasicBlockListType BasicBlocks; // The basic blocks
68 ArgumentListType ArgumentList; // The formal arguments
72 friend class SymbolTableListTraits<Function, Module, Module>;
74 void setParent(Module *parent);
75 Function *Prev, *Next;
76 void setNext(Function *N) { Next = N; }
77 void setPrev(Function *N) { Prev = N; }
80 /// Function ctor - If the (optional) Module argument is specified, the
81 /// function is automatically inserted into the end of the function list for
84 Function(const FunctionType *Ty, LinkageTypes Linkage,
85 const std::string &N = "", Module *M = 0);
88 // Specialize setName to handle symbol table majik...
89 virtual void setName(const std::string &name, SymbolTable *ST = 0);
91 const Type *getReturnType() const; // Return the type of the ret val
92 const FunctionType *getFunctionType() const; // Return the FunctionType for me
94 /// isVarArg - Return true if this function takes a variable number of
96 bool isVarArg() const;
98 /// isExternal - Is the body of this function unknown? (The basic block list
99 /// is empty if so.) This is true for external functions, defined as forward
102 virtual bool isExternal() const { return BasicBlocks.empty(); }
104 /// getIntrinsicID - This method returns the ID number of the specified
105 /// function, or Intrinsic::not_intrinsic if the function is not an
106 /// instrinsic, or if the pointer is null. This value is always defined to be
107 /// zero to allow easy checking for whether a function is intrinsic or not.
108 /// The particular intrinsic functions which correspond to this value are
109 /// defined in llvm/Intrinsics.h.
111 unsigned getIntrinsicID() const;
112 bool isIntrinsic() const { return getIntrinsicID() != 0; }
114 /// renameLocalSymbols - This method goes through the Function's symbol table
115 /// and renames any symbols that conflict with symbols at global scope. This
116 /// is required before printing out to a textual form, to ensure that there is
117 /// no ambiguity when parsing.
118 void renameLocalSymbols();
121 /// deleteBody - This method deletes the body of the function, and converts
122 /// the linkage to external.
126 setLinkage(ExternalLinkage);
129 /// removeFromParent - This method unlinks 'this' from the containing module,
130 /// but does not delete it.
132 void removeFromParent();
134 /// eraseFromParent - This method unlinks 'this' from the containing module
137 void eraseFromParent();
140 // getNext/Prev - Return the next or previous function in the list. These
141 // methods should never be used directly, and are only used to implement the
142 // function list as part of the module.
144 Function *getNext() { return Next; }
145 const Function *getNext() const { return Next; }
146 Function *getPrev() { return Prev; }
147 const Function *getPrev() const { return Prev; }
149 /// Get the underlying elements of the Function... the basic block list is
150 /// empty for external functions.
152 const ArgumentListType &getArgumentList() const { return ArgumentList; }
153 ArgumentListType &getArgumentList() { return ArgumentList; }
155 const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
156 BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
158 const BasicBlock &getEntryBlock() const { return front(); }
159 BasicBlock &getEntryBlock() { return front(); }
161 //===--------------------------------------------------------------------===//
162 // Symbol Table Accessing functions...
164 /// getSymbolTable() - Return the symbol table...
166 inline SymbolTable &getSymbolTable() { return *SymTab; }
167 inline const SymbolTable &getSymbolTable() const { return *SymTab; }
170 //===--------------------------------------------------------------------===//
171 // BasicBlock iterator forwarding functions
173 iterator begin() { return BasicBlocks.begin(); }
174 const_iterator begin() const { return BasicBlocks.begin(); }
175 iterator end () { return BasicBlocks.end(); }
176 const_iterator end () const { return BasicBlocks.end(); }
178 reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
179 const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
180 reverse_iterator rend () { return BasicBlocks.rend(); }
181 const_reverse_iterator rend () const { return BasicBlocks.rend(); }
183 size_t size() const { return BasicBlocks.size(); }
184 bool empty() const { return BasicBlocks.empty(); }
185 const BasicBlock &front() const { return BasicBlocks.front(); }
186 BasicBlock &front() { return BasicBlocks.front(); }
187 const BasicBlock &back() const { return BasicBlocks.back(); }
188 BasicBlock &back() { return BasicBlocks.back(); }
190 //===--------------------------------------------------------------------===//
191 // Argument iterator forwarding functions
193 aiterator abegin() { return ArgumentList.begin(); }
194 const_aiterator abegin() const { return ArgumentList.begin(); }
195 aiterator aend () { return ArgumentList.end(); }
196 const_aiterator aend () const { return ArgumentList.end(); }
198 reverse_aiterator arbegin() { return ArgumentList.rbegin(); }
199 const_reverse_aiterator arbegin() const { return ArgumentList.rbegin(); }
200 reverse_aiterator arend () { return ArgumentList.rend(); }
201 const_reverse_aiterator arend () const { return ArgumentList.rend(); }
203 size_t asize() const { return ArgumentList.size(); }
204 bool aempty() const { return ArgumentList.empty(); }
205 const Argument &afront() const { return ArgumentList.front(); }
206 Argument &afront() { return ArgumentList.front(); }
207 const Argument &aback() const { return ArgumentList.back(); }
208 Argument &aback() { return ArgumentList.back(); }
210 virtual void print(std::ostream &OS) const { print(OS, 0); }
211 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
213 /// viewCFG - This function is meant for use from the debugger. You can just
214 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
215 /// program, displaying the CFG of the current function with the code for each
216 /// basic block inside. This depends on there being a 'dot' and 'gv' program
219 void viewCFG() const;
221 /// viewCFGOnly - This function is meant for use from the debugger. It works
222 /// just like viewCFG, but it does not include the contents of basic blocks
223 /// into the nodes, just the label. If you are only interested in the CFG
224 /// this can make the graph smaller.
226 void viewCFGOnly() const;
228 /// Methods for support type inquiry through isa, cast, and dyn_cast:
229 static inline bool classof(const Function *) { return true; }
230 static inline bool classof(const Value *V) {
231 return V->getValueType() == Value::FunctionVal;
234 /// dropAllReferences() - This method causes all the subinstructions to "let
235 /// go" of all references that they are maintaining. This allows one to
236 /// 'delete' a whole module at a time, even though there may be circular
237 /// references... first all references are dropped, and all use counts go to
238 /// zero. Then everything is deleted for real. Note that no operations are
239 /// valid on an object that has "dropped all references", except operator
242 /// Since no other object in the module can have references into the body of a
243 /// function, dropping all references deletes the entire body of the function,
244 /// including any contained basic blocks.
246 void dropAllReferences();
249 } // End llvm namespace