1 //===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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/CallingConv.h"
23 #include "llvm/BasicBlock.h"
24 #include "llvm/Argument.h"
25 #include "llvm/Attributes.h"
26 #include "llvm/Support/Compiler.h"
33 // Traits for intrusive list of basic blocks...
34 template<> struct ilist_traits<BasicBlock>
35 : public SymbolTableListTraits<BasicBlock, Function> {
37 // createSentinel is used to get hold of the node that marks the end of the
38 // list... (same trick used here as in ilist_traits<Instruction>)
39 BasicBlock *createSentinel() const {
40 return static_cast<BasicBlock*>(&Sentinel);
42 static void destroySentinel(BasicBlock*) {}
44 BasicBlock *provideInitialHead() const { return createSentinel(); }
45 BasicBlock *ensureHead(BasicBlock*) const { return createSentinel(); }
46 static void noteHead(BasicBlock*, BasicBlock*) {}
48 static ValueSymbolTable *getSymTab(Function *ItemParent);
50 mutable ilist_half_node<BasicBlock> Sentinel;
53 template<> struct ilist_traits<Argument>
54 : public SymbolTableListTraits<Argument, Function> {
56 Argument *createSentinel() const {
57 return static_cast<Argument*>(&Sentinel);
59 static void destroySentinel(Argument*) {}
61 Argument *provideInitialHead() const { return createSentinel(); }
62 Argument *ensureHead(Argument*) const { return createSentinel(); }
63 static void noteHead(Argument*, Argument*) {}
65 static ValueSymbolTable *getSymTab(Function *ItemParent);
67 mutable ilist_half_node<Argument> Sentinel;
70 class Function : public GlobalValue,
71 public ilist_node<Function> {
73 typedef iplist<Argument> ArgumentListType;
74 typedef iplist<BasicBlock> BasicBlockListType;
76 // BasicBlock iterators...
77 typedef BasicBlockListType::iterator iterator;
78 typedef BasicBlockListType::const_iterator const_iterator;
80 typedef ArgumentListType::iterator arg_iterator;
81 typedef ArgumentListType::const_iterator const_arg_iterator;
84 // Important things that make up a function!
85 BasicBlockListType BasicBlocks; ///< The basic blocks
86 mutable ArgumentListType ArgumentList; ///< The formal arguments
87 ValueSymbolTable *SymTab; ///< Symbol table of args/instructions
88 AttrListPtr AttributeList; ///< Parameter attributes
90 // HasLazyArguments is stored in Value::SubclassData.
91 /*bool HasLazyArguments;*/
93 // The Calling Convention is stored in Value::SubclassData.
94 /*CallingConv::ID CallingConvention;*/
96 friend class SymbolTableListTraits<Function, Module>;
98 void setParent(Module *parent);
100 /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
101 /// built on demand, so that the list isn't allocated until the first client
102 /// needs it. The hasLazyArguments predicate returns true if the arg list
103 /// hasn't been set up yet.
104 bool hasLazyArguments() const {
105 return getSubclassDataFromValue() & 1;
107 void CheckLazyArguments() const {
108 if (hasLazyArguments())
109 BuildLazyArguments();
111 void BuildLazyArguments() const;
113 Function(const Function&) LLVM_DELETED_FUNCTION;
114 void operator=(const Function&) LLVM_DELETED_FUNCTION;
116 /// Function ctor - If the (optional) Module argument is specified, the
117 /// function is automatically inserted into the end of the function list for
120 Function(FunctionType *Ty, LinkageTypes Linkage,
121 const Twine &N = "", Module *M = 0);
124 static Function *Create(FunctionType *Ty, LinkageTypes Linkage,
125 const Twine &N = "", Module *M = 0) {
126 return new(0) Function(Ty, Linkage, N, M);
131 Type *getReturnType() const; // Return the type of the ret val
132 FunctionType *getFunctionType() const; // Return the FunctionType for me
134 /// getContext - Return a pointer to the LLVMContext associated with this
135 /// function, or NULL if this function is not bound to a context yet.
136 LLVMContext &getContext() const;
138 /// isVarArg - Return true if this function takes a variable number of
140 bool isVarArg() const;
142 /// getIntrinsicID - This method returns the ID number of the specified
143 /// function, or Intrinsic::not_intrinsic if the function is not an
144 /// instrinsic, or if the pointer is null. This value is always defined to be
145 /// zero to allow easy checking for whether a function is intrinsic or not.
146 /// The particular intrinsic functions which correspond to this value are
147 /// defined in llvm/Intrinsics.h.
149 unsigned getIntrinsicID() const LLVM_READONLY;
150 bool isIntrinsic() const { return getIntrinsicID() != 0; }
152 /// getCallingConv()/setCallingConv(CC) - These method get and set the
153 /// calling convention of this function. The enum values for the known
154 /// calling conventions are defined in CallingConv.h.
155 CallingConv::ID getCallingConv() const {
156 return static_cast<CallingConv::ID>(getSubclassDataFromValue() >> 1);
158 void setCallingConv(CallingConv::ID CC) {
159 setValueSubclassData((getSubclassDataFromValue() & 1) |
160 (static_cast<unsigned>(CC) << 1));
163 /// getAttributes - Return the attribute list for this Function.
165 const AttrListPtr &getAttributes() const { return AttributeList; }
167 /// setAttributes - Set the attribute list for this Function.
169 void setAttributes(const AttrListPtr &attrs) { AttributeList = attrs; }
171 /// getFnAttributes - Return the function attributes for querying.
173 Attributes getFnAttributes() const {
174 return AttributeList.getFnAttributes();
177 /// addFnAttr - Add function attributes to this function.
179 void addFnAttr(Attributes N) {
180 // Function Attributes are stored at ~0 index
181 addAttribute(~0U, N);
184 /// removeFnAttr - Remove function attributes from this function.
186 void removeFnAttr(Attributes N) {
187 // Function Attributes are stored at ~0 index
188 removeAttribute(~0U, N);
191 /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
192 /// to use during code generation.
194 const char *getGC() const;
195 void setGC(const char *Str);
199 /// getRetAttributes - Return the return attributes for querying.
200 Attributes getRetAttributes() const {
201 return AttributeList.getRetAttributes();
204 /// getParamAttributes - Return the parameter attributes for querying.
205 Attributes getParamAttributes(unsigned Idx) const {
206 return AttributeList.getParamAttributes(Idx);
209 /// @brief Determine whether the function has the given attribute.
210 bool paramHasAttr(unsigned i, Attributes attr) const {
211 return AttributeList.paramHasAttr(i, attr);
214 /// addAttribute - adds the attribute to the list of attributes.
215 void addAttribute(unsigned i, Attributes attr);
217 /// removeAttribute - removes the attribute from the list of attributes.
218 void removeAttribute(unsigned i, Attributes attr);
220 /// @brief Extract the alignment for a call or parameter (0=unknown).
221 unsigned getParamAlignment(unsigned i) const {
222 return AttributeList.getParamAlignment(i);
225 /// @brief Determine if the function does not access memory.
226 bool doesNotAccessMemory() const {
227 return getFnAttributes().hasReadNoneAttr();
229 void setDoesNotAccessMemory(bool DoesNotAccessMemory = true) {
230 if (DoesNotAccessMemory) addFnAttr(Attribute::ReadNone);
231 else removeFnAttr(Attribute::ReadNone);
234 /// @brief Determine if the function does not access or only reads memory.
235 bool onlyReadsMemory() const {
236 return doesNotAccessMemory() || getFnAttributes().hasReadOnlyAttr();
238 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
239 if (OnlyReadsMemory) addFnAttr(Attribute::ReadOnly);
240 else removeFnAttr(Attribute::ReadOnly | Attribute::ReadNone);
243 /// @brief Determine if the function cannot return.
244 bool doesNotReturn() const {
245 return getFnAttributes().hasNoReturnAttr();
247 void setDoesNotReturn(bool DoesNotReturn = true) {
248 if (DoesNotReturn) addFnAttr(Attribute::NoReturn);
249 else removeFnAttr(Attribute::NoReturn);
252 /// @brief Determine if the function cannot unwind.
253 bool doesNotThrow() const {
254 return getFnAttributes().hasNoUnwindAttr();
256 void setDoesNotThrow(bool DoesNotThrow = true) {
257 if (DoesNotThrow) addFnAttr(Attribute::NoUnwind);
258 else removeFnAttr(Attribute::NoUnwind);
261 /// @brief True if the ABI mandates (or the user requested) that this
262 /// function be in a unwind table.
263 bool hasUWTable() const {
264 return getFnAttributes().hasUWTableAttr();
266 void setHasUWTable(bool HasUWTable = true) {
268 addFnAttr(Attribute::UWTable);
270 removeFnAttr(Attribute::UWTable);
273 /// @brief True if this function needs an unwind table.
274 bool needsUnwindTableEntry() const {
275 return hasUWTable() || !doesNotThrow();
278 /// @brief Determine if the function returns a structure through first
279 /// pointer argument.
280 bool hasStructRetAttr() const {
281 return getParamAttributes(1).hasStructRetAttr();
284 /// @brief Determine if the parameter does not alias other parameters.
285 /// @param n The parameter to check. 1 is the first parameter, 0 is the return
286 bool doesNotAlias(unsigned n) const {
287 return n != 0 ? getParamAttributes(n).hasNoAliasAttr() :
288 AttributeList.getRetAttributes().hasNoAliasAttr();
290 void setDoesNotAlias(unsigned n, bool DoesNotAlias = true) {
291 if (DoesNotAlias) addAttribute(n, Attribute::NoAlias);
292 else removeAttribute(n, Attribute::NoAlias);
295 /// @brief Determine if the parameter can be captured.
296 /// @param n The parameter to check. 1 is the first parameter, 0 is the return
297 bool doesNotCapture(unsigned n) const {
298 return getParamAttributes(n).hasNoCaptureAttr();
300 void setDoesNotCapture(unsigned n, bool DoesNotCapture = true) {
301 if (DoesNotCapture) addAttribute(n, Attribute::NoCapture);
302 else removeAttribute(n, Attribute::NoCapture);
305 /// copyAttributesFrom - copy all additional attributes (those not needed to
306 /// create a Function) from the Function Src to this one.
307 void copyAttributesFrom(const GlobalValue *Src);
309 /// deleteBody - This method deletes the body of the function, and converts
310 /// the linkage to external.
314 setLinkage(ExternalLinkage);
317 /// removeFromParent - This method unlinks 'this' from the containing module,
318 /// but does not delete it.
320 virtual void removeFromParent();
322 /// eraseFromParent - This method unlinks 'this' from the containing module
325 virtual void eraseFromParent();
328 /// Get the underlying elements of the Function... the basic block list is
329 /// empty for external functions.
331 const ArgumentListType &getArgumentList() const {
332 CheckLazyArguments();
335 ArgumentListType &getArgumentList() {
336 CheckLazyArguments();
339 static iplist<Argument> Function::*getSublistAccess(Argument*) {
340 return &Function::ArgumentList;
343 const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
344 BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
345 static iplist<BasicBlock> Function::*getSublistAccess(BasicBlock*) {
346 return &Function::BasicBlocks;
349 const BasicBlock &getEntryBlock() const { return front(); }
350 BasicBlock &getEntryBlock() { return front(); }
352 //===--------------------------------------------------------------------===//
353 // Symbol Table Accessing functions...
355 /// getSymbolTable() - Return the symbol table...
357 inline ValueSymbolTable &getValueSymbolTable() { return *SymTab; }
358 inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
361 //===--------------------------------------------------------------------===//
362 // BasicBlock iterator forwarding functions
364 iterator begin() { return BasicBlocks.begin(); }
365 const_iterator begin() const { return BasicBlocks.begin(); }
366 iterator end () { return BasicBlocks.end(); }
367 const_iterator end () const { return BasicBlocks.end(); }
369 size_t size() const { return BasicBlocks.size(); }
370 bool empty() const { return BasicBlocks.empty(); }
371 const BasicBlock &front() const { return BasicBlocks.front(); }
372 BasicBlock &front() { return BasicBlocks.front(); }
373 const BasicBlock &back() const { return BasicBlocks.back(); }
374 BasicBlock &back() { return BasicBlocks.back(); }
376 //===--------------------------------------------------------------------===//
377 // Argument iterator forwarding functions
379 arg_iterator arg_begin() {
380 CheckLazyArguments();
381 return ArgumentList.begin();
383 const_arg_iterator arg_begin() const {
384 CheckLazyArguments();
385 return ArgumentList.begin();
387 arg_iterator arg_end() {
388 CheckLazyArguments();
389 return ArgumentList.end();
391 const_arg_iterator arg_end() const {
392 CheckLazyArguments();
393 return ArgumentList.end();
396 size_t arg_size() const;
397 bool arg_empty() const;
399 /// viewCFG - This function is meant for use from the debugger. You can just
400 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
401 /// program, displaying the CFG of the current function with the code for each
402 /// basic block inside. This depends on there being a 'dot' and 'gv' program
405 void viewCFG() const;
407 /// viewCFGOnly - This function is meant for use from the debugger. It works
408 /// just like viewCFG, but it does not include the contents of basic blocks
409 /// into the nodes, just the label. If you are only interested in the CFG
410 /// this can make the graph smaller.
412 void viewCFGOnly() const;
414 /// Methods for support type inquiry through isa, cast, and dyn_cast:
415 static inline bool classof(const Function *) { return true; }
416 static inline bool classof(const Value *V) {
417 return V->getValueID() == Value::FunctionVal;
420 /// dropAllReferences() - This method causes all the subinstructions to "let
421 /// go" of all references that they are maintaining. This allows one to
422 /// 'delete' a whole module at a time, even though there may be circular
423 /// references... first all references are dropped, and all use counts go to
424 /// zero. Then everything is deleted for real. Note that no operations are
425 /// valid on an object that has "dropped all references", except operator
428 /// Since no other object in the module can have references into the body of a
429 /// function, dropping all references deletes the entire body of the function,
430 /// including any contained basic blocks.
432 void dropAllReferences();
434 /// hasAddressTaken - returns true if there are any uses of this function
435 /// other than direct calls or invokes to it, or blockaddress expressions.
436 /// Optionally passes back an offending user for diagnostic purposes.
438 bool hasAddressTaken(const User** = 0) const;
440 /// isDefTriviallyDead - Return true if it is trivially safe to remove
441 /// this function definition from the module (because it isn't externally
442 /// visible, does not have its address taken, and has no callers). To make
443 /// this more accurate, call removeDeadConstantUsers first.
444 bool isDefTriviallyDead() const;
446 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
447 /// setjmp or other function that gcc recognizes as "returning twice".
448 bool callsFunctionThatReturnsTwice() const;
451 // Shadow Value::setValueSubclassData with a private forwarding method so that
452 // subclasses cannot accidentally use it.
453 void setValueSubclassData(unsigned short D) {
454 Value::setValueSubclassData(D);
458 inline ValueSymbolTable *
459 ilist_traits<BasicBlock>::getSymTab(Function *F) {
460 return F ? &F->getValueSymbolTable() : 0;
463 inline ValueSymbolTable *
464 ilist_traits<Argument>::getSymTab(Function *F) {
465 return F ? &F->getValueSymbolTable() : 0;
468 } // End llvm namespace