2003-09-20 03:34:44 +00:00
|
|
|
//===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-04-09 19:36:56 +00:00
|
|
|
//
|
2013-01-20 05:03:39 +00:00
|
|
|
// This file declares the Argument class.
|
2002-04-09 19:36:56 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2013-01-10 00:45:19 +00:00
|
|
|
#ifndef LLVM_IR_ARGUMENT_H
|
|
|
|
#define LLVM_IR_ARGUMENT_H
|
2002-04-09 19:36:56 +00:00
|
|
|
|
2009-12-29 07:12:03 +00:00
|
|
|
#include "llvm/ADT/Twine.h"
|
2012-12-03 17:02:12 +00:00
|
|
|
#include "llvm/ADT/ilist_node.h"
|
2013-01-02 11:36:10 +00:00
|
|
|
#include "llvm/IR/Attributes.h"
|
|
|
|
#include "llvm/IR/Value.h"
|
2002-04-09 19:36:56 +00:00
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
namespace llvm {
|
|
|
|
|
2015-10-07 20:05:10 +00:00
|
|
|
template <typename NodeTy> class SymbolTableListTraits;
|
2004-03-11 23:42:24 +00:00
|
|
|
|
2013-01-20 05:03:39 +00: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 21:51:04 +00:00
|
|
|
class Argument : public Value, public ilist_node<Argument> {
|
2011-12-20 02:50:00 +00:00
|
|
|
virtual void anchor();
|
2002-04-09 19:36:56 +00:00
|
|
|
Function *Parent;
|
|
|
|
|
2015-10-07 20:05:10 +00:00
|
|
|
friend class SymbolTableListTraits<Argument>;
|
2002-09-06 21:31:57 +00:00
|
|
|
void setParent(Function *parent);
|
2002-04-09 19:36:56 +00:00
|
|
|
|
|
|
|
public:
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Constructor.
|
2002-09-06 21:31:57 +00:00
|
|
|
///
|
2013-01-20 05:03:39 +00:00
|
|
|
/// If \p F is specified, the argument is inserted at the end of the argument
|
|
|
|
/// list for \p F.
|
2014-04-09 06:08:46 +00:00
|
|
|
explicit Argument(Type *Ty, const Twine &Name = "", Function *F = nullptr);
|
2002-04-09 19:36:56 +00:00
|
|
|
|
|
|
|
inline const Function *getParent() const { return Parent; }
|
|
|
|
inline Function *getParent() { return Parent; }
|
2005-04-21 20:19:05 +00:00
|
|
|
|
2013-01-20 05:03:39 +00: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 17:47:11 +00:00
|
|
|
unsigned getArgNo() const;
|
2013-01-20 05:03:39 +00:00
|
|
|
|
2014-05-20 01:23:40 +00:00
|
|
|
/// \brief Return true if this argument has the nonnull attribute on it in
|
2014-07-18 15:51:28 +00:00
|
|
|
/// its containing function. Also returns true if at least one byte is known
|
|
|
|
/// to be dereferenceable and the pointer is in addrspace(0).
|
2014-05-20 01:23:40 +00:00
|
|
|
bool hasNonNullAttr() const;
|
|
|
|
|
2014-07-18 15:51:28 +00:00
|
|
|
/// \brief If this argument has the dereferenceable attribute on it in its
|
|
|
|
/// containing function, return the number of bytes known to be
|
|
|
|
/// dereferenceable. Otherwise, zero is returned.
|
|
|
|
uint64_t getDereferenceableBytes() const;
|
2015-09-22 11:14:12 +00:00
|
|
|
|
|
|
|
/// \brief If this argument has the dereferenceable_or_null attribute on
|
2015-05-06 17:41:54 +00:00
|
|
|
/// it in its containing function, return the number of bytes known to be
|
|
|
|
/// dereferenceable. Otherwise, zero is returned.
|
|
|
|
uint64_t getDereferenceableOrNullBytes() const;
|
2014-07-18 15:51:28 +00:00
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Return true if this argument has the byval attribute on it in its
|
|
|
|
/// containing function.
|
2008-01-24 17:47:11 +00:00
|
|
|
bool hasByValAttr() const;
|
2013-01-20 05:03:39 +00:00
|
|
|
|
2014-01-17 23:58:17 +00:00
|
|
|
/// \brief Return true if this argument has the byval attribute or inalloca
|
|
|
|
/// attribute on it in its containing function. These attributes both
|
|
|
|
/// represent arguments being passed by value.
|
|
|
|
bool hasByValOrInAllocaAttr() const;
|
|
|
|
|
2013-12-19 02:14:12 +00:00
|
|
|
/// \brief If this is a byval or inalloca argument, return its alignment.
|
2011-05-22 23:57:23 +00:00
|
|
|
unsigned getParamAlignment() const;
|
2008-01-24 17:47:11 +00:00
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Return true if this argument has the nest attribute on it in its
|
|
|
|
/// containing function.
|
2009-12-11 08:36:17 +00:00
|
|
|
bool hasNestAttr() const;
|
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Return true if this argument has the noalias attribute on it in its
|
|
|
|
/// containing function.
|
2008-01-24 17:47:11 +00:00
|
|
|
bool hasNoAliasAttr() const;
|
2013-01-20 05:03:39 +00:00
|
|
|
|
|
|
|
/// \brief Return true if this argument has the nocapture attribute on it in
|
|
|
|
/// its containing function.
|
2008-12-31 18:08:59 +00:00
|
|
|
bool hasNoCaptureAttr() const;
|
2013-01-20 05:03:39 +00:00
|
|
|
|
|
|
|
/// \brief Return true if this argument has the sret attribute on it in its
|
|
|
|
/// containing function.
|
2008-02-17 23:22:28 +00:00
|
|
|
bool hasStructRetAttr() const;
|
2008-04-28 17:37:06 +00:00
|
|
|
|
2013-04-20 05:14:40 +00:00
|
|
|
/// \brief Return true if this argument has the returned attribute on it in
|
|
|
|
/// its containing function.
|
|
|
|
bool hasReturnedAttr() const;
|
|
|
|
|
2013-07-06 00:29:58 +00:00
|
|
|
/// \brief Return true if this argument has the readonly or readnone attribute
|
|
|
|
/// on it in its containing function.
|
|
|
|
bool onlyReadsMemory() const;
|
|
|
|
|
2013-12-19 02:14:12 +00:00
|
|
|
/// \brief Return true if this argument has the inalloca attribute on it in
|
|
|
|
/// its containing function.
|
|
|
|
bool hasInAllocaAttr() const;
|
2013-07-06 00:29:58 +00:00
|
|
|
|
2014-08-05 05:43:41 +00:00
|
|
|
/// \brief Return true if this argument has the zext attribute on it in its
|
|
|
|
/// containing function.
|
|
|
|
bool hasZExtAttr() const;
|
|
|
|
|
|
|
|
/// \brief Return true if this argument has the sext attribute on it in its
|
|
|
|
/// containing function.
|
|
|
|
bool hasSExtAttr() const;
|
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Add a Attribute to an argument.
|
2013-01-23 06:14:59 +00:00
|
|
|
void addAttr(AttributeSet AS);
|
2013-01-20 05:03:39 +00:00
|
|
|
|
2016-03-14 01:37:29 +00:00
|
|
|
void addAttr(Attribute::AttrKind Kind) {
|
|
|
|
addAttr(AttributeSet::get(getContext(), getArgNo() + 1, Kind));
|
|
|
|
}
|
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Remove a Attribute from an argument.
|
2013-01-23 06:14:59 +00:00
|
|
|
void removeAttr(AttributeSet AS);
|
2008-04-28 17:37:06 +00:00
|
|
|
|
2016-03-14 01:37:29 +00:00
|
|
|
void removeAttr(Attribute::AttrKind Kind) {
|
|
|
|
removeAttr(AttributeSet::get(getContext(), getArgNo() + 1, Kind));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// \brief Checks if an argument has a given attribute.
|
|
|
|
bool hasAttribute(Attribute::AttrKind Kind) const;
|
|
|
|
|
2013-01-20 05:03:39 +00:00
|
|
|
/// \brief Method for support type inquiry through isa, cast, and
|
|
|
|
/// dyn_cast.
|
2002-04-09 19:36:56 +00:00
|
|
|
static inline bool classof(const Value *V) {
|
2007-04-13 18:12:09 +00:00
|
|
|
return V->getValueID() == ArgumentVal;
|
2002-04-09 19:36:56 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2015-06-23 09:49:53 +00:00
|
|
|
} // End llvm namespace
|
2003-11-11 22:41:34 +00:00
|
|
|
|
2002-04-09 19:36:56 +00:00
|
|
|
#endif
|