//
// 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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
#include "llvm/BasicBlock.h"
#include "llvm/Argument.h"
#include "llvm/Support/Annotation.h"
+#include "llvm/ParameterAttributes.h"
namespace llvm {
class FunctionType;
-class ParamAttrsList;
// Traits for intrusive list of instructions...
template<> struct ilist_traits<BasicBlock>
static int getListOffset();
};
-class Function : public GlobalValue, public Annotable {
+typedef unsigned FunctionNotes;
+const FunctionNotes FN_NOTE_None = 0;
+const FunctionNotes FN_NOTE_NoInline = 1<<0;
+const FunctionNotes FN_NOTE_AlwaysInline = 1<<1;
+const FunctionNotes FN_NOTE_OptimizeForSize = 1<<2;
+
+class Function : public GlobalValue, public Annotable,
+ public ilist_node<Function> {
public:
typedef iplist<Argument> ArgumentListType;
typedef iplist<BasicBlock> BasicBlockListType;
private:
// Important things that make up a function!
- BasicBlockListType BasicBlocks; ///< The basic blocks
- ArgumentListType ArgumentList; ///< The formal arguments
- ValueSymbolTable *SymTab; ///< Symbol table of args/instructions
- ParamAttrsList *ParamAttrs; ///< Parameter attributes
+ BasicBlockListType BasicBlocks; ///< The basic blocks
+ mutable ArgumentListType ArgumentList; ///< The formal arguments
+ ValueSymbolTable *SymTab; ///< Symbol table of args/instructions
+ PAListPtr ParamAttrs; ///< Parameter attributes
+ FunctionNotes Notes; ///< Function properties
-
// The Calling Convention is stored in Value::SubclassData.
/*unsigned CallingConvention;*/
friend class SymbolTableListTraits<Function, Module>;
void setParent(Module *parent);
- Function *Prev, *Next;
- void setNext(Function *N) { Next = N; }
- void setPrev(Function *N) { Prev = N; }
-public:
+ /// 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;
+
+ Function(const Function&); // DO NOT IMPLEMENT
+ void operator=(const Function&); // DO NOT IMPLEMENT
+
/// 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);
+
+public:
+ static Function *Create(const FunctionType *Ty, LinkageTypes Linkage,
+ const std::string &N = "", Module *M = 0) {
+ return new(0) Function(Ty, Linkage, N, M);
+ }
+
~Function();
const Type *getReturnType() const; // Return the type of the ret val
/// 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; }
+ unsigned getCallingConv() const { return SubclassData >> 1; }
+ void setCallingConv(unsigned CC) {
+ SubclassData = (SubclassData & 1) | (CC << 1);
+ }
+
+ /// getParamAttrs - Return the parameter attributes for this Function.
+ ///
+ const PAListPtr &getParamAttrs() const { return ParamAttrs; }
+
+ /// setParamAttrs - Set the parameter attributes for this Function.
+ ///
+ void setParamAttrs(const PAListPtr &attrs) { ParamAttrs = attrs; }
+
+ /// getNotes - Return function notes
+ ///
+ const FunctionNotes &getNotes() const { return Notes; }
- /// 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; }
+ /// setNotes - Set notes for this function
+ ///
+ void setNotes(const FunctionNotes P) { Notes = Notes | P;}
+
+ /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
+ /// to use during code generation.
+ bool hasGC() const;
+ const char *getGC() const;
+ void setGC(const char *Str);
+ void clearGC();
+
+ /// @brief Determine whether the function has the given attribute.
+ bool paramHasAttr(unsigned i, ParameterAttributes attr) const {
+ return ParamAttrs.paramHasAttr(i, attr);
+ }
+
+ /// addParamAttr - adds the attribute to the list of attributes.
+ void addParamAttr(unsigned i, ParameterAttributes attr);
+
+ /// removeParamAttr - removes the attribute from the list of attributes.
+ void removeParamAttr(unsigned i, ParameterAttributes attr);
- /// Sets the parameter attributes for this Function. To construct a
- /// ParamAttrsList, see ParameterAttributes.h
- /// @brief Set the parameter attributes.
- void setParamAttrs(ParamAttrsList *attrs);
+ /// @brief Extract the alignment for a call or parameter (0=unknown).
+ unsigned getParamAlignment(unsigned i) const {
+ return ParamAttrs.getParamAlignment(i);
+ }
+
+ /// @brief Determine if the function does not access memory.
+ bool doesNotAccessMemory() const {
+ return paramHasAttr(0, ParamAttr::ReadNone);
+ }
+ void setDoesNotAccessMemory(bool DoesNotAccessMemory = true) {
+ if (DoesNotAccessMemory) addParamAttr(0, ParamAttr::ReadNone);
+ else removeParamAttr(0, ParamAttr::ReadNone);
+ }
+
+ /// @brief Determine if the function does not access or only reads memory.
+ bool onlyReadsMemory() const {
+ return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
+ }
+ void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
+ if (OnlyReadsMemory) addParamAttr(0, ParamAttr::ReadOnly);
+ else removeParamAttr(0, ParamAttr::ReadOnly | ParamAttr::ReadNone);
+ }
+
+ /// @brief Determine if the function cannot return.
+ bool doesNotReturn() const {
+ return paramHasAttr(0, ParamAttr::NoReturn);
+ }
+ void setDoesNotReturn(bool DoesNotReturn = true) {
+ if (DoesNotReturn) addParamAttr(0, ParamAttr::NoReturn);
+ else removeParamAttr(0, ParamAttr::NoReturn);
+ }
+
+ /// @brief Determine if the function cannot unwind.
+ bool doesNotThrow() const {
+ return paramHasAttr(0, ParamAttr::NoUnwind);
+ }
+ void setDoesNotThrow(bool DoesNotThrow = true) {
+ if (DoesNotThrow) addParamAttr(0, ParamAttr::NoUnwind);
+ else removeParamAttr(0, ParamAttr::NoUnwind);
+ }
+
+ /// @brief Determine if the function returns a structure through first
+ /// pointer argument.
+ bool hasStructRetAttr() const {
+ return paramHasAttr(1, ParamAttr::StructRet);
+ }
+
+ /// copyAttributesFrom - copy all additional attributes (those not needed to
+ /// create a Function) from the Function Src to this one.
+ void copyAttributesFrom(const GlobalValue *Src);
/// deleteBody - This method deletes the body of the function, and converts
/// the linkage to external.
/// Get the underlying elements of the Function... the basic block list is
/// empty for external functions.
///
- const ArgumentListType &getArgumentList() const { return ArgumentList; }
- ArgumentListType &getArgumentList() { return ArgumentList; }
+ const ArgumentListType &getArgumentList() const {
+ CheckLazyArguments();
+ return ArgumentList;
+ }
+ ArgumentListType &getArgumentList() {
+ CheckLazyArguments();
+ return ArgumentList;
+ }
const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
BasicBlockListType &getBasicBlockList() { return BasicBlocks; }
//===--------------------------------------------------------------------===//
// Argument iterator forwarding functions
//
- 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(); }
+ 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();
+ }
- 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;
+ size_t arg_size() const;
+ bool arg_empty() 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
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 *
projects / oota-llvm.git / blobdiff