2003-09-20 05:34:44 +02:00
|
|
|
//===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
|
2005-04-21 22:19:05 +02:00
|
|
|
//
|
2003-10-20 22:19:47 +02:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:59:42 +01:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 22:19:05 +02:00
|
|
|
//
|
2003-10-20 22:19:47 +02:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-04-09 21:36:56 +02:00
|
|
|
//
|
2013-01-20 06:03:39 +01:00
|
|
|
// This file declares the Argument class.
|
2002-04-09 21:36:56 +02:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2013-01-10 01:45:19 +01:00
|
|
|
#ifndef LLVM_IR_ARGUMENT_H
|
|
|
|
#define LLVM_IR_ARGUMENT_H
|
2002-04-09 21:36:56 +02:00
|
|
|
|
2009-12-29 08:12:03 +01:00
|
|
|
#include "llvm/ADT/Twine.h"
|
2012-12-03 18:02:12 +01:00
|
|
|
#include "llvm/ADT/ilist_node.h"
|
2013-01-02 12:36:10 +01:00
|
|
|
#include "llvm/IR/Attributes.h"
|
|
|
|
#include "llvm/IR/Value.h"
|
2002-04-09 21:36:56 +02:00
|
|
|
|
2003-11-11 23:41:34 +01:00
|
|
|
namespace llvm {
|
|
|
|
|
2007-04-17 05:26:42 +02:00
|
|
|
template<typename ValueSubClass, typename ItemParentClass>
|
|
|
|
class SymbolTableListTraits;
|
2004-03-12 00:42:24 +01:00
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief LLVM Argument representation
|
|
|
|
///
|
|
|
|
/// This class represents an incoming formal argument to a Function. A formal
|
|
|
|
/// argument, since it is ``formal'', does not contain an actual value but
|
|
|
|
/// instead represents the type, argument number, and attributes of an argument
|
|
|
|
/// for a specific function. When used in the body of said function, the
|
|
|
|
/// argument of course represents the value of the actual argument that the
|
|
|
|
/// function was called with.
|
2008-07-28 23:51:04 +02:00
|
|
|
class Argument : public Value, public ilist_node<Argument> {
|
2011-12-20 03:50:00 +01:00
|
|
|
virtual void anchor();
|
2002-04-09 21:36:56 +02:00
|
|
|
Function *Parent;
|
|
|
|
|
2007-04-17 05:26:42 +02:00
|
|
|
friend class SymbolTableListTraits<Argument, Function>;
|
2002-09-06 23:31:57 +02:00
|
|
|
void setParent(Function *parent);
|
2002-04-09 21:36:56 +02:00
|
|
|
|
|
|
|
public:
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Constructor.
|
2002-09-06 23:31:57 +02:00
|
|
|
///
|
2013-01-20 06:03:39 +01:00
|
|
|
/// If \p F is specified, the argument is inserted at the end of the argument
|
|
|
|
/// list for \p F.
|
2011-07-18 06:54:35 +02:00
|
|
|
explicit Argument(Type *Ty, const Twine &Name = "", Function *F = 0);
|
2002-04-09 21:36:56 +02:00
|
|
|
|
|
|
|
inline const Function *getParent() const { return Parent; }
|
|
|
|
inline Function *getParent() { return Parent; }
|
2005-04-21 22:19:05 +02:00
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Return the index of this formal argument in its containing
|
|
|
|
/// function.
|
|
|
|
///
|
|
|
|
/// For example in "void foo(int a, float b)" a is 0 and b is 1.
|
2008-01-24 18:47:11 +01:00
|
|
|
unsigned getArgNo() const;
|
2013-01-20 06:03:39 +01:00
|
|
|
|
|
|
|
/// \brief Return true if this argument has the byval attribute on it in its
|
|
|
|
/// containing function.
|
2008-01-24 18:47:11 +01:00
|
|
|
bool hasByValAttr() const;
|
2013-01-20 06:03:39 +01:00
|
|
|
|
|
|
|
/// \brief If this is a byval argument, return its alignment.
|
2011-05-23 01:57:23 +02:00
|
|
|
unsigned getParamAlignment() const;
|
2008-01-24 18:47:11 +01:00
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Return true if this argument has the nest attribute on it in its
|
|
|
|
/// containing function.
|
2009-12-11 09:36:17 +01:00
|
|
|
bool hasNestAttr() const;
|
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Return true if this argument has the noalias attribute on it in its
|
|
|
|
/// containing function.
|
2008-01-24 18:47:11 +01:00
|
|
|
bool hasNoAliasAttr() const;
|
2013-01-20 06:03:39 +01:00
|
|
|
|
|
|
|
/// \brief Return true if this argument has the nocapture attribute on it in
|
|
|
|
/// its containing function.
|
2008-12-31 19:08:59 +01:00
|
|
|
bool hasNoCaptureAttr() const;
|
2013-01-20 06:03:39 +01:00
|
|
|
|
|
|
|
/// \brief Return true if this argument has the sret attribute on it in its
|
|
|
|
/// containing function.
|
2008-02-18 00:22:28 +01:00
|
|
|
bool hasStructRetAttr() const;
|
2008-04-28 19:37:06 +02:00
|
|
|
|
2013-04-20 07:14:40 +02:00
|
|
|
/// \brief Return true if this argument has the returned attribute on it in
|
|
|
|
/// its containing function.
|
|
|
|
bool hasReturnedAttr() const;
|
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Add a Attribute to an argument.
|
2013-01-23 07:14:59 +01:00
|
|
|
void addAttr(AttributeSet AS);
|
2013-01-20 06:03:39 +01:00
|
|
|
|
|
|
|
/// \brief Remove a Attribute from an argument.
|
2013-01-23 07:14:59 +01:00
|
|
|
void removeAttr(AttributeSet AS);
|
2008-04-28 19:37:06 +02:00
|
|
|
|
2013-01-20 06:03:39 +01:00
|
|
|
/// \brief Method for support type inquiry through isa, cast, and
|
|
|
|
/// dyn_cast.
|
2002-04-09 21:36:56 +02:00
|
|
|
static inline bool classof(const Value *V) {
|
2007-04-13 20:12:09 +02:00
|
|
|
return V->getValueID() == ArgumentVal;
|
2002-04-09 21:36:56 +02:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2003-11-11 23:41:34 +01:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-04-09 21:36:56 +02:00
|
|
|
#endif
|