2003-02-24 20:35:45 +00:00
|
|
|
//===-- llvm/Support/CallSite.h - Abstract Call & Invoke instrs -*- C++ -*-===//
|
2005-04-21 20:48:15 +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:48:15 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2003-02-24 20:35:45 +00:00
|
|
|
//
|
|
|
|
// This file defines the CallSite class, which is a handy wrapper for code that
|
2010-04-01 08:21:08 +00:00
|
|
|
// wants to treat Call and Invoke instructions in a generic way. When in non-
|
|
|
|
// mutation context (e.g. an analysis) ImmutableCallSite should be used.
|
|
|
|
// Finally, when some degree of customization is necessary between these two
|
|
|
|
// extremes, CallSiteBase<> can be supplied with fine-tuned parameters.
|
2003-02-24 20:35:45 +00:00
|
|
|
//
|
2010-04-01 08:21:08 +00:00
|
|
|
// NOTE: These classes are supposed to have "value semantics". So they should be
|
|
|
|
// passed by value, not by reference; they should not be "new"ed or "delete"d.
|
|
|
|
// They are efficiently copyable, assignable and constructable, with cost
|
|
|
|
// equivalent to copying a pointer (notice that they have only a single data
|
|
|
|
// member). The internal representation carries a flag which indicates which of
|
|
|
|
// the two variants is enclosed. This allows for cheaper checks when various
|
|
|
|
// accessors of CallSite are employed.
|
2003-11-07 19:25:22 +00:00
|
|
|
//
|
2003-02-24 20:35:45 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_SUPPORT_CALLSITE_H
|
|
|
|
#define LLVM_SUPPORT_CALLSITE_H
|
|
|
|
|
2009-01-11 22:33:22 +00:00
|
|
|
#include "llvm/ADT/PointerIntPair.h"
|
2013-01-02 11:36:10 +00:00
|
|
|
#include "llvm/IR/Attributes.h"
|
|
|
|
#include "llvm/IR/CallingConv.h"
|
|
|
|
#include "llvm/IR/Instructions.h"
|
2003-02-24 20:35:45 +00:00
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
namespace llvm {
|
|
|
|
|
2003-02-24 20:35:45 +00:00
|
|
|
class CallInst;
|
|
|
|
class InvokeInst;
|
|
|
|
|
2010-04-01 08:21:08 +00:00
|
|
|
template <typename FunTy = const Function,
|
|
|
|
typename ValTy = const Value,
|
|
|
|
typename UserTy = const User,
|
|
|
|
typename InstrTy = const Instruction,
|
|
|
|
typename CallTy = const CallInst,
|
|
|
|
typename InvokeTy = const InvokeInst,
|
|
|
|
typename IterTy = User::const_op_iterator>
|
|
|
|
class CallSiteBase {
|
|
|
|
protected:
|
|
|
|
PointerIntPair<InstrTy*, 1, bool> I;
|
2003-02-24 20:35:45 +00:00
|
|
|
public:
|
2010-04-01 08:21:08 +00:00
|
|
|
CallSiteBase() : I(0, false) {}
|
2010-07-28 10:44:59 +00:00
|
|
|
CallSiteBase(CallTy *CI) : I(CI, true) { assert(CI); }
|
|
|
|
CallSiteBase(InvokeTy *II) : I(II, false) { assert(II); }
|
2010-04-01 08:21:08 +00:00
|
|
|
CallSiteBase(ValTy *II) { *this = get(II); }
|
2010-09-18 11:48:36 +00:00
|
|
|
protected:
|
2010-04-01 08:21:08 +00:00
|
|
|
/// CallSiteBase::get - This static method is sort of like a constructor. It
|
|
|
|
/// will create an appropriate call site for a Call or Invoke instruction, but
|
|
|
|
/// it can also create a null initialized CallSiteBase object for something
|
|
|
|
/// which is NOT a call site.
|
2003-06-17 22:16:59 +00:00
|
|
|
///
|
2010-04-01 08:21:08 +00:00
|
|
|
static CallSiteBase get(ValTy *V) {
|
|
|
|
if (InstrTy *II = dyn_cast<InstrTy>(V)) {
|
|
|
|
if (II->getOpcode() == Instruction::Call)
|
2010-07-27 21:46:11 +00:00
|
|
|
return CallSiteBase(static_cast<CallTy*>(II));
|
2010-04-01 08:21:08 +00:00
|
|
|
else if (II->getOpcode() == Instruction::Invoke)
|
2010-07-27 21:46:11 +00:00
|
|
|
return CallSiteBase(static_cast<InvokeTy*>(II));
|
2003-06-17 22:16:59 +00:00
|
|
|
}
|
2010-04-01 08:21:08 +00:00
|
|
|
return CallSiteBase();
|
2003-06-17 22:16:59 +00:00
|
|
|
}
|
2010-09-18 11:48:36 +00:00
|
|
|
public:
|
2009-01-11 22:33:22 +00:00
|
|
|
/// isCall - true if a CallInst is enclosed.
|
|
|
|
/// Note that !isCall() does not mean it is an InvokeInst enclosed,
|
|
|
|
/// it also could signify a NULL Instruction pointer.
|
|
|
|
bool isCall() const { return I.getInt(); }
|
|
|
|
|
|
|
|
/// isInvoke - true if a InvokeInst is enclosed.
|
|
|
|
///
|
|
|
|
bool isInvoke() const { return getInstruction() && !I.getInt(); }
|
2003-11-05 20:25:33 +00:00
|
|
|
|
2010-04-01 08:21:08 +00:00
|
|
|
InstrTy *getInstruction() const { return I.getPointer(); }
|
|
|
|
InstrTy *operator->() const { return I.getPointer(); }
|
|
|
|
operator bool() const { return I.getPointer(); }
|
2004-05-23 08:02:45 +00:00
|
|
|
|
2012-09-05 19:16:22 +00:00
|
|
|
/// getCalledValue - Return the pointer to function that is being called.
|
2003-02-24 20:35:45 +00:00
|
|
|
///
|
2010-04-01 08:21:08 +00:00
|
|
|
ValTy *getCalledValue() const {
|
2009-01-11 22:33:22 +00:00
|
|
|
assert(getInstruction() && "Not a call or invoke instruction!");
|
2010-03-24 13:21:49 +00:00
|
|
|
return *getCallee();
|
2003-10-23 19:33:49 +00:00
|
|
|
}
|
2003-02-24 20:35:45 +00:00
|
|
|
|
|
|
|
/// getCalledFunction - Return the function being called if this is a direct
|
|
|
|
/// call, otherwise return null (if it's an indirect call).
|
|
|
|
///
|
2010-04-01 08:21:08 +00:00
|
|
|
FunTy *getCalledFunction() const {
|
|
|
|
return dyn_cast<FunTy>(getCalledValue());
|
2004-11-18 17:46:57 +00:00
|
|
|
}
|
2003-02-24 20:35:45 +00:00
|
|
|
|
2012-09-05 19:16:22 +00:00
|
|
|
/// setCalledFunction - Set the callee to the specified value.
|
2003-06-17 22:16:59 +00:00
|
|
|
///
|
|
|
|
void setCalledFunction(Value *V) {
|
2009-01-11 22:33:22 +00:00
|
|
|
assert(getInstruction() && "Not a call or invoke instruction!");
|
2010-03-24 13:21:49 +00:00
|
|
|
*getCallee() = V;
|
2003-06-17 22:16:59 +00:00
|
|
|
}
|
|
|
|
|
2010-04-01 08:21:08 +00:00
|
|
|
/// isCallee - Determine whether the passed iterator points to the
|
|
|
|
/// callee operand's Use.
|
|
|
|
///
|
|
|
|
bool isCallee(value_use_iterator<UserTy> UI) const {
|
|
|
|
return getCallee() == &UI.getUse();
|
|
|
|
}
|
|
|
|
|
|
|
|
ValTy *getArgument(unsigned ArgNo) const {
|
2004-11-13 23:28:10 +00:00
|
|
|
assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
|
2010-07-29 23:35:00 +00:00
|
|
|
return *(arg_begin() + ArgNo);
|
2004-11-13 23:28:10 +00:00
|
|
|
}
|
|
|
|
|
2008-02-18 00:10:55 +00:00
|
|
|
void setArgument(unsigned ArgNo, Value* newVal) {
|
2009-01-11 22:33:22 +00:00
|
|
|
assert(getInstruction() && "Not a call or invoke instruction!");
|
2008-02-18 00:10:55 +00:00
|
|
|
assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
|
2010-07-29 23:35:00 +00:00
|
|
|
getInstruction()->setOperand(ArgNo, newVal);
|
2008-02-18 00:10:55 +00:00
|
|
|
}
|
2008-07-08 08:50:32 +00:00
|
|
|
|
2010-03-24 13:21:49 +00:00
|
|
|
/// Given a value use iterator, returns the argument that corresponds to it.
|
|
|
|
/// Iterator must actually correspond to an argument.
|
2010-04-01 08:21:08 +00:00
|
|
|
unsigned getArgumentNo(value_use_iterator<UserTy> I) const {
|
2010-03-24 13:21:49 +00:00
|
|
|
assert(getInstruction() && "Not a call or invoke instruction!");
|
|
|
|
assert(arg_begin() <= &I.getUse() && &I.getUse() < arg_end()
|
|
|
|
&& "Argument # out of range!");
|
|
|
|
return &I.getUse() - arg_begin();
|
|
|
|
}
|
|
|
|
|
2003-02-24 20:35:45 +00:00
|
|
|
/// arg_iterator - The type of iterator to use when looping over actual
|
2012-09-05 19:16:22 +00:00
|
|
|
/// arguments at this call site.
|
2010-04-01 08:21:08 +00:00
|
|
|
typedef IterTy arg_iterator;
|
2003-02-24 20:35:45 +00:00
|
|
|
|
|
|
|
/// arg_begin/arg_end - Return iterators corresponding to the actual argument
|
|
|
|
/// list for a call site.
|
2010-04-01 08:21:08 +00:00
|
|
|
IterTy arg_begin() const {
|
2009-01-11 22:33:22 +00:00
|
|
|
assert(getInstruction() && "Not a call or invoke instruction!");
|
2009-01-11 22:39:04 +00:00
|
|
|
// Skip non-arguments
|
2010-07-29 23:35:00 +00:00
|
|
|
return (*this)->op_begin();
|
2003-02-24 20:35:45 +00:00
|
|
|
}
|
2008-07-08 08:50:32 +00:00
|
|
|
|
2010-04-01 08:21:08 +00:00
|
|
|
IterTy arg_end() const { return (*this)->op_end() - getArgumentEndOffset(); }
|
2007-10-01 16:01:23 +00:00
|
|
|
bool arg_empty() const { return arg_end() == arg_begin(); }
|
2004-06-05 00:17:13 +00:00
|
|
|
unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
|
2010-04-01 08:21:08 +00:00
|
|
|
|
2010-04-14 20:31:28 +00:00
|
|
|
/// getType - Return the type of the instruction that generated this call site
|
|
|
|
///
|
2011-07-18 04:54:35 +00:00
|
|
|
Type *getType() const { return (*this)->getType(); }
|
2010-04-14 20:31:28 +00:00
|
|
|
|
|
|
|
/// getCaller - Return the caller function for this call site
|
|
|
|
///
|
2010-04-14 20:49:44 +00:00
|
|
|
FunTy *getCaller() const { return (*this)->getParent()->getParent(); }
|
2010-04-14 20:31:28 +00:00
|
|
|
|
2010-04-14 21:47:32 +00:00
|
|
|
#define CALLSITE_DELEGATE_GETTER(METHOD) \
|
|
|
|
InstrTy *II = getInstruction(); \
|
|
|
|
return isCall() \
|
|
|
|
? cast<CallInst>(II)->METHOD \
|
|
|
|
: cast<InvokeInst>(II)->METHOD
|
|
|
|
|
|
|
|
#define CALLSITE_DELEGATE_SETTER(METHOD) \
|
|
|
|
InstrTy *II = getInstruction(); \
|
|
|
|
if (isCall()) \
|
|
|
|
cast<CallInst>(II)->METHOD; \
|
|
|
|
else \
|
|
|
|
cast<InvokeInst>(II)->METHOD
|
|
|
|
|
|
|
|
/// getCallingConv/setCallingConv - get or set the calling convention of the
|
|
|
|
/// call.
|
|
|
|
CallingConv::ID getCallingConv() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(getCallingConv());
|
|
|
|
}
|
|
|
|
void setCallingConv(CallingConv::ID CC) {
|
|
|
|
CALLSITE_DELEGATE_SETTER(setCallingConv(CC));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// getAttributes/setAttributes - get or set the parameter attributes of
|
|
|
|
/// the call.
|
2012-12-07 23:16:57 +00:00
|
|
|
const AttributeSet &getAttributes() const {
|
2010-04-14 21:47:32 +00:00
|
|
|
CALLSITE_DELEGATE_GETTER(getAttributes());
|
|
|
|
}
|
2012-12-07 23:16:57 +00:00
|
|
|
void setAttributes(const AttributeSet &PAL) {
|
2010-04-14 21:47:32 +00:00
|
|
|
CALLSITE_DELEGATE_SETTER(setAttributes(PAL));
|
|
|
|
}
|
|
|
|
|
2012-06-25 16:16:58 +00:00
|
|
|
/// \brief Return true if this function has the given attribute.
|
2012-12-22 00:37:52 +00:00
|
|
|
bool hasFnAttr(Attribute::AttrKind A) const {
|
2012-10-09 21:49:51 +00:00
|
|
|
CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
|
2012-06-25 16:16:58 +00:00
|
|
|
}
|
|
|
|
|
2012-10-09 21:38:14 +00:00
|
|
|
/// \brief Return true if the call or the callee has the given attribute.
|
2012-12-22 00:37:52 +00:00
|
|
|
bool paramHasAttr(unsigned i, Attribute::AttrKind A) const {
|
2012-10-09 21:38:14 +00:00
|
|
|
CALLSITE_DELEGATE_GETTER(paramHasAttr(i, A));
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Extract the alignment for a call or parameter (0=unknown).
|
|
|
|
uint16_t getParamAlignment(uint16_t i) const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(getParamAlignment(i));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Return true if the call should not be inlined.
|
|
|
|
bool isNoInline() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(isNoInline());
|
|
|
|
}
|
|
|
|
void setIsNoInline(bool Value = true) {
|
2010-07-06 03:52:37 +00:00
|
|
|
CALLSITE_DELEGATE_SETTER(setIsNoInline(Value));
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
2010-07-06 03:52:37 +00:00
|
|
|
|
2010-04-14 21:47:32 +00:00
|
|
|
/// @brief Determine if the call does not access memory.
|
|
|
|
bool doesNotAccessMemory() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(doesNotAccessMemory());
|
|
|
|
}
|
2012-10-09 23:40:31 +00:00
|
|
|
void setDoesNotAccessMemory() {
|
|
|
|
CALLSITE_DELEGATE_SETTER(setDoesNotAccessMemory());
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Determine if the call does not access or only reads memory.
|
|
|
|
bool onlyReadsMemory() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(onlyReadsMemory());
|
|
|
|
}
|
2012-10-09 23:40:31 +00:00
|
|
|
void setOnlyReadsMemory() {
|
|
|
|
CALLSITE_DELEGATE_SETTER(setOnlyReadsMemory());
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Determine if the call cannot return.
|
|
|
|
bool doesNotReturn() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(doesNotReturn());
|
|
|
|
}
|
2012-10-09 23:40:31 +00:00
|
|
|
void setDoesNotReturn() {
|
|
|
|
CALLSITE_DELEGATE_SETTER(setDoesNotReturn());
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Determine if the call cannot unwind.
|
|
|
|
bool doesNotThrow() const {
|
|
|
|
CALLSITE_DELEGATE_GETTER(doesNotThrow());
|
|
|
|
}
|
2012-10-09 23:40:31 +00:00
|
|
|
void setDoesNotThrow() {
|
|
|
|
CALLSITE_DELEGATE_SETTER(setDoesNotThrow());
|
2010-04-14 21:47:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#undef CALLSITE_DELEGATE_GETTER
|
|
|
|
#undef CALLSITE_DELEGATE_SETTER
|
|
|
|
|
2011-11-20 19:09:04 +00:00
|
|
|
/// @brief Determine whether this argument is not captured.
|
|
|
|
bool doesNotCapture(unsigned ArgNo) const {
|
2012-12-19 07:18:57 +00:00
|
|
|
return paramHasAttr(ArgNo + 1, Attribute::NoCapture);
|
2011-11-20 19:09:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// @brief Determine whether this argument is passed by value.
|
|
|
|
bool isByValArgument(unsigned ArgNo) const {
|
2012-12-19 07:18:57 +00:00
|
|
|
return paramHasAttr(ArgNo + 1, Attribute::ByVal);
|
2011-11-20 19:09:04 +00:00
|
|
|
}
|
|
|
|
|
2010-04-14 21:47:32 +00:00
|
|
|
/// hasArgument - Returns true if this CallSite passes the given Value* as an
|
|
|
|
/// argument to the called function.
|
|
|
|
bool hasArgument(const Value *Arg) const {
|
|
|
|
for (arg_iterator AI = this->arg_begin(), E = this->arg_end(); AI != E;
|
|
|
|
++AI)
|
|
|
|
if (AI->get() == Arg)
|
|
|
|
return true;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2008-07-08 08:50:32 +00:00
|
|
|
private:
|
2010-03-24 13:21:49 +00:00
|
|
|
unsigned getArgumentEndOffset() const {
|
|
|
|
if (isCall())
|
2010-07-16 09:38:02 +00:00
|
|
|
return 1; // Skip Callee
|
2010-03-24 13:21:49 +00:00
|
|
|
else
|
2010-07-16 09:38:02 +00:00
|
|
|
return 3; // Skip BB, BB, Callee
|
2010-03-24 13:21:49 +00:00
|
|
|
}
|
|
|
|
|
2010-04-01 08:21:08 +00:00
|
|
|
IterTy getCallee() const {
|
2010-08-05 21:25:49 +00:00
|
|
|
if (isCall()) // Skip Callee
|
|
|
|
return cast<CallInst>(getInstruction())->op_end() - 1;
|
|
|
|
else // Skip BB, BB, Callee
|
|
|
|
return cast<InvokeInst>(getInstruction())->op_end() - 3;
|
2010-04-01 08:21:08 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class CallSite : public CallSiteBase<Function, Value, User, Instruction,
|
|
|
|
CallInst, InvokeInst, User::op_iterator> {
|
|
|
|
typedef CallSiteBase<Function, Value, User, Instruction,
|
2010-04-09 01:19:28 +00:00
|
|
|
CallInst, InvokeInst, User::op_iterator> Base;
|
2010-04-01 08:21:08 +00:00
|
|
|
public:
|
|
|
|
CallSite() {}
|
2010-04-09 01:19:28 +00:00
|
|
|
CallSite(Base B) : Base(B) {}
|
2010-07-27 22:53:28 +00:00
|
|
|
CallSite(Value* V) : Base(V) {}
|
2010-04-09 01:19:28 +00:00
|
|
|
CallSite(CallInst *CI) : Base(CI) {}
|
|
|
|
CallSite(InvokeInst *II) : Base(II) {}
|
|
|
|
CallSite(Instruction *II) : Base(II) {}
|
2010-04-01 08:21:08 +00:00
|
|
|
|
|
|
|
bool operator==(const CallSite &CS) const { return I == CS.I; }
|
|
|
|
bool operator!=(const CallSite &CS) const { return I != CS.I; }
|
|
|
|
bool operator<(const CallSite &CS) const {
|
|
|
|
return getInstruction() < CS.getInstruction();
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
2010-03-24 13:21:49 +00:00
|
|
|
User::op_iterator getCallee() const;
|
2003-02-24 20:35:45 +00:00
|
|
|
};
|
|
|
|
|
2010-08-03 21:48:53 +00:00
|
|
|
/// ImmutableCallSite - establish a view to a call site for examination
|
|
|
|
class ImmutableCallSite : public CallSiteBase<> {
|
|
|
|
typedef CallSiteBase<> Base;
|
|
|
|
public:
|
|
|
|
ImmutableCallSite(const Value* V) : Base(V) {}
|
|
|
|
ImmutableCallSite(const CallInst *CI) : Base(CI) {}
|
|
|
|
ImmutableCallSite(const InvokeInst *II) : Base(II) {}
|
|
|
|
ImmutableCallSite(const Instruction *II) : Base(II) {}
|
|
|
|
ImmutableCallSite(CallSite CS) : Base(CS.getInstruction()) {}
|
|
|
|
};
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2003-02-24 20:35:45 +00:00
|
|
|
#endif
|