1 //===- CallSite.h - Abstract Call & Invoke instrs ---------------*- 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 defines the CallSite class, which is a handy wrapper for code that
11 // wants to treat Call and Invoke instructions in a generic way. When in non-
12 // mutation context (e.g. an analysis) ImmutableCallSite should be used.
13 // Finally, when some degree of customization is necessary between these two
14 // extremes, CallSiteBase<> can be supplied with fine-tuned parameters.
16 // NOTE: These classes are supposed to have "value semantics". So they should be
17 // passed by value, not by reference; they should not be "new"ed or "delete"d.
18 // They are efficiently copyable, assignable and constructable, with cost
19 // equivalent to copying a pointer (notice that they have only a single data
20 // member). The internal representation carries a flag which indicates which of
21 // the two variants is enclosed. This allows for cheaper checks when various
22 // accessors of CallSite are employed.
24 //===----------------------------------------------------------------------===//
26 #ifndef LLVM_IR_CALLSITE_H
27 #define LLVM_IR_CALLSITE_H
29 #include "llvm/ADT/PointerIntPair.h"
30 #include "llvm/ADT/iterator_range.h"
31 #include "llvm/IR/Attributes.h"
32 #include "llvm/IR/CallingConv.h"
33 #include "llvm/IR/Instructions.h"
40 template <typename FunTy = const Function,
41 typename BBTy = const BasicBlock,
42 typename ValTy = const Value,
43 typename UserTy = const User,
44 typename UseTy = const Use,
45 typename InstrTy = const Instruction,
46 typename CallTy = const CallInst,
47 typename InvokeTy = const InvokeInst,
48 typename IterTy = User::const_op_iterator>
51 PointerIntPair<InstrTy*, 1, bool> I;
53 CallSiteBase() : I(nullptr, false) {}
54 CallSiteBase(CallTy *CI) : I(CI, true) { assert(CI); }
55 CallSiteBase(InvokeTy *II) : I(II, false) { assert(II); }
56 explicit CallSiteBase(ValTy *II) { *this = get(II); }
59 /// CallSiteBase::get - This static method is sort of like a constructor. It
60 /// will create an appropriate call site for a Call or Invoke instruction, but
61 /// it can also create a null initialized CallSiteBase object for something
62 /// which is NOT a call site.
64 static CallSiteBase get(ValTy *V) {
65 if (InstrTy *II = dyn_cast<InstrTy>(V)) {
66 if (II->getOpcode() == Instruction::Call)
67 return CallSiteBase(static_cast<CallTy*>(II));
68 else if (II->getOpcode() == Instruction::Invoke)
69 return CallSiteBase(static_cast<InvokeTy*>(II));
71 return CallSiteBase();
75 /// isCall - true if a CallInst is enclosed.
76 /// Note that !isCall() does not mean it is an InvokeInst enclosed,
77 /// it also could signify a NULL Instruction pointer.
78 bool isCall() const { return I.getInt(); }
80 /// isInvoke - true if a InvokeInst is enclosed.
82 bool isInvoke() const { return getInstruction() && !I.getInt(); }
84 InstrTy *getInstruction() const { return I.getPointer(); }
85 InstrTy *operator->() const { return I.getPointer(); }
86 explicit operator bool() const { return I.getPointer(); }
88 /// Get the basic block containing the call site
89 BBTy* getParent() const { return getInstruction()->getParent(); }
91 /// getCalledValue - Return the pointer to function that is being called.
93 ValTy *getCalledValue() const {
94 assert(getInstruction() && "Not a call or invoke instruction!");
98 /// getCalledFunction - Return the function being called if this is a direct
99 /// call, otherwise return null (if it's an indirect call).
101 FunTy *getCalledFunction() const {
102 return dyn_cast<FunTy>(getCalledValue());
105 /// setCalledFunction - Set the callee to the specified value.
107 void setCalledFunction(Value *V) {
108 assert(getInstruction() && "Not a call or invoke instruction!");
112 /// isCallee - Determine whether the passed iterator points to the
113 /// callee operand's Use.
114 bool isCallee(Value::const_user_iterator UI) const {
115 return isCallee(&UI.getUse());
118 /// Determine whether this Use is the callee operand's Use.
119 bool isCallee(const Use *U) const { return getCallee() == U; }
121 /// \brief Determine whether the passed iterator points to an argument
123 bool isArgOperand(Value::const_user_iterator UI) const {
124 return isArgOperand(&UI.getUse());
127 /// \brief Determine whether the passed use points to an argument operand.
128 bool isArgOperand(const Use *U) const {
129 assert(getInstruction() == U->getUser());
130 return arg_begin() <= U && U < arg_end();
133 /// \brief Determine whether the passed iterator points to a bundle operand.
134 bool isBundleOperand(Value::const_user_iterator UI) const {
135 return isBundleOperand(&UI.getUse());
138 /// \brief Determine whether the passed use points to a bundle operand.
139 bool isBundleOperand(const Use *U) const {
140 assert(getInstruction() == U->getUser());
141 if (!hasOperandBundles())
143 unsigned OperandNo = U - (*this)->op_begin();
144 return getBundleOperandsStartIndex() <= OperandNo &&
145 OperandNo < getBundleOperandsEndIndex();
148 /// \brief Determine whether the passed iterator points to a data operand.
149 bool isDataOperand(Value::const_user_iterator UI) const {
150 return isDataOperand(&UI.getUse());
153 /// \brief Determine whether the passed use points to a data operand.
154 bool isDataOperand(const Use *U) const {
155 return data_operands_begin() <= U && U < data_operands_end();
158 ValTy *getArgument(unsigned ArgNo) const {
159 assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
160 return *(arg_begin() + ArgNo);
163 void setArgument(unsigned ArgNo, Value* newVal) {
164 assert(getInstruction() && "Not a call or invoke instruction!");
165 assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
166 getInstruction()->setOperand(ArgNo, newVal);
169 /// Given a value use iterator, returns the argument that corresponds to it.
170 /// Iterator must actually correspond to an argument.
171 unsigned getArgumentNo(Value::const_user_iterator I) const {
172 return getArgumentNo(&I.getUse());
175 /// Given a use for an argument, get the argument number that corresponds to
177 unsigned getArgumentNo(const Use *U) const {
178 assert(getInstruction() && "Not a call or invoke instruction!");
179 assert(isArgOperand(U) && "Argument # out of range!");
180 return U - arg_begin();
183 /// arg_iterator - The type of iterator to use when looping over actual
184 /// arguments at this call site.
185 typedef IterTy arg_iterator;
187 iterator_range<IterTy> args() const {
188 return make_range(arg_begin(), arg_end());
190 bool arg_empty() const { return arg_end() == arg_begin(); }
191 unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
193 /// Given a value use iterator, returns the data operand that corresponds to
195 /// Iterator must actually correspond to a data operand.
196 unsigned getDataOperandNo(Value::const_user_iterator UI) const {
197 return getDataOperandNo(&UI.getUse());
200 /// Given a use for a data operand, get the data operand number that
201 /// corresponds to it.
202 unsigned getDataOperandNo(const Use *U) const {
203 assert(getInstruction() && "Not a call or invoke instruction!");
204 assert(isDataOperand(U) && "Data operand # out of range!");
205 return U - data_operands_begin();
208 /// Type of iterator to use when looping over data operands at this call site
210 typedef IterTy data_operand_iterator;
212 /// data_operands_begin/data_operands_end - Return iterators iterating over
213 /// the call / invoke argument list and bundle operands. For invokes, this is
214 /// the set of instruction operands except the invoke target and the two
215 /// successor blocks; and for calls this is the set of instruction operands
216 /// except the call target.
218 IterTy data_operands_begin() const {
219 assert(getInstruction() && "Not a call or invoke instruction!");
220 return (*this)->op_begin();
222 IterTy data_operands_end() const {
223 assert(getInstruction() && "Not a call or invoke instruction!");
224 return (*this)->op_end() - (isCall() ? 1 : 3);
226 iterator_range<IterTy> data_ops() const {
227 return make_range(data_operands_begin(), data_operands_end());
229 bool data_operands_empty() const {
230 return data_operands_end() == data_operands_begin();
232 unsigned data_operands_size() const {
233 return std::distance(data_operands_begin(), data_operands_end());
236 /// getType - Return the type of the instruction that generated this call site
238 Type *getType() const { return (*this)->getType(); }
240 /// getCaller - Return the caller function for this call site
242 FunTy *getCaller() const { return (*this)->getParent()->getParent(); }
244 /// \brief Tests if this call site must be tail call optimized. Only a
245 /// CallInst can be tail call optimized.
246 bool isMustTailCall() const {
247 return isCall() && cast<CallInst>(getInstruction())->isMustTailCall();
250 /// \brief Tests if this call site is marked as a tail call.
251 bool isTailCall() const {
252 return isCall() && cast<CallInst>(getInstruction())->isTailCall();
255 #define CALLSITE_DELEGATE_GETTER(METHOD) \
256 InstrTy *II = getInstruction(); \
258 ? cast<CallInst>(II)->METHOD \
259 : cast<InvokeInst>(II)->METHOD
261 #define CALLSITE_DELEGATE_SETTER(METHOD) \
262 InstrTy *II = getInstruction(); \
264 cast<CallInst>(II)->METHOD; \
266 cast<InvokeInst>(II)->METHOD
268 unsigned getNumArgOperands() const {
269 CALLSITE_DELEGATE_GETTER(getNumArgOperands());
272 ValTy *getArgOperand(unsigned i) const {
273 CALLSITE_DELEGATE_GETTER(getArgOperand(i));
276 bool isInlineAsm() const {
278 return cast<CallInst>(getInstruction())->isInlineAsm();
282 /// getCallingConv/setCallingConv - get or set the calling convention of the
284 CallingConv::ID getCallingConv() const {
285 CALLSITE_DELEGATE_GETTER(getCallingConv());
287 void setCallingConv(CallingConv::ID CC) {
288 CALLSITE_DELEGATE_SETTER(setCallingConv(CC));
291 FunctionType *getFunctionType() const {
292 CALLSITE_DELEGATE_GETTER(getFunctionType());
295 void mutateFunctionType(FunctionType *Ty) const {
296 CALLSITE_DELEGATE_SETTER(mutateFunctionType(Ty));
299 /// getAttributes/setAttributes - get or set the parameter attributes of
301 const AttributeSet &getAttributes() const {
302 CALLSITE_DELEGATE_GETTER(getAttributes());
304 void setAttributes(const AttributeSet &PAL) {
305 CALLSITE_DELEGATE_SETTER(setAttributes(PAL));
308 /// \brief Return true if this function has the given attribute.
309 bool hasFnAttr(Attribute::AttrKind A) const {
310 CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
313 /// \brief Return true if this function has the given attribute.
314 bool hasFnAttr(StringRef A) const {
315 CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
318 /// \brief Return true if the call or the callee has the given attribute.
319 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const {
320 CALLSITE_DELEGATE_GETTER(paramHasAttr(i, A));
323 /// \brief Return true if the data operand at index \p i directly or
324 /// indirectly has the attribute \p A.
326 /// Normal call or invoke arguments have per operand attributes, as specified
327 /// in the attribute set attached to this instruction, while operand bundle
328 /// operands may have some attributes implied by the type of its containing
330 bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind A) const {
331 CALLSITE_DELEGATE_GETTER(dataOperandHasImpliedAttr(i, A));
334 /// @brief Extract the alignment for a call or parameter (0=unknown).
335 uint16_t getParamAlignment(uint16_t i) const {
336 CALLSITE_DELEGATE_GETTER(getParamAlignment(i));
339 /// @brief Extract the number of dereferenceable bytes for a call or
340 /// parameter (0=unknown).
341 uint64_t getDereferenceableBytes(uint16_t i) const {
342 CALLSITE_DELEGATE_GETTER(getDereferenceableBytes(i));
345 /// @brief Extract the number of dereferenceable_or_null bytes for a call or
346 /// parameter (0=unknown).
347 uint64_t getDereferenceableOrNullBytes(uint16_t i) const {
348 CALLSITE_DELEGATE_GETTER(getDereferenceableOrNullBytes(i));
351 /// @brief Determine if the parameter or return value is marked with NoAlias
353 /// @param n The parameter to check. 1 is the first parameter, 0 is the return
354 bool doesNotAlias(unsigned n) const {
355 CALLSITE_DELEGATE_GETTER(doesNotAlias(n));
358 /// \brief Return true if the call should not be treated as a call to a
360 bool isNoBuiltin() const {
361 CALLSITE_DELEGATE_GETTER(isNoBuiltin());
364 /// @brief Return true if the call should not be inlined.
365 bool isNoInline() const {
366 CALLSITE_DELEGATE_GETTER(isNoInline());
368 void setIsNoInline(bool Value = true) {
369 CALLSITE_DELEGATE_SETTER(setIsNoInline(Value));
372 /// @brief Determine if the call does not access memory.
373 bool doesNotAccessMemory() const {
374 CALLSITE_DELEGATE_GETTER(doesNotAccessMemory());
376 void setDoesNotAccessMemory() {
377 CALLSITE_DELEGATE_SETTER(setDoesNotAccessMemory());
380 /// @brief Determine if the call does not access or only reads memory.
381 bool onlyReadsMemory() const {
382 CALLSITE_DELEGATE_GETTER(onlyReadsMemory());
384 void setOnlyReadsMemory() {
385 CALLSITE_DELEGATE_SETTER(setOnlyReadsMemory());
388 /// @brief Determine if the call can access memmory only using pointers based
389 /// on its arguments.
390 bool onlyAccessesArgMemory() const {
391 CALLSITE_DELEGATE_GETTER(onlyAccessesArgMemory());
393 void setOnlyAccessesArgMemory() {
394 CALLSITE_DELEGATE_SETTER(setOnlyAccessesArgMemory());
397 /// @brief Determine if the call cannot return.
398 bool doesNotReturn() const {
399 CALLSITE_DELEGATE_GETTER(doesNotReturn());
401 void setDoesNotReturn() {
402 CALLSITE_DELEGATE_SETTER(setDoesNotReturn());
405 /// @brief Determine if the call cannot unwind.
406 bool doesNotThrow() const {
407 CALLSITE_DELEGATE_GETTER(doesNotThrow());
409 void setDoesNotThrow() {
410 CALLSITE_DELEGATE_SETTER(setDoesNotThrow());
413 unsigned getNumOperandBundles() const {
414 CALLSITE_DELEGATE_GETTER(getNumOperandBundles());
417 bool hasOperandBundles() const {
418 CALLSITE_DELEGATE_GETTER(hasOperandBundles());
421 unsigned getBundleOperandsStartIndex() const {
422 CALLSITE_DELEGATE_GETTER(getBundleOperandsStartIndex());
425 unsigned getBundleOperandsEndIndex() const {
426 CALLSITE_DELEGATE_GETTER(getBundleOperandsEndIndex());
429 unsigned getNumTotalBundleOperands() const {
430 CALLSITE_DELEGATE_GETTER(getNumTotalBundleOperands());
433 OperandBundleUse getOperandBundleAt(unsigned Index) const {
434 CALLSITE_DELEGATE_GETTER(getOperandBundleAt(Index));
437 Optional<OperandBundleUse> getOperandBundle(StringRef Name) const {
438 CALLSITE_DELEGATE_GETTER(getOperandBundle(Name));
441 Optional<OperandBundleUse> getOperandBundle(uint32_t ID) const {
442 CALLSITE_DELEGATE_GETTER(getOperandBundle(ID));
445 IterTy arg_begin() const {
446 CALLSITE_DELEGATE_GETTER(arg_begin());
449 IterTy arg_end() const {
450 CALLSITE_DELEGATE_GETTER(arg_end());
453 #undef CALLSITE_DELEGATE_GETTER
454 #undef CALLSITE_DELEGATE_SETTER
456 void getOperandBundlesAsDefs(SmallVectorImpl<OperandBundleDef> &Defs) const {
457 const Instruction *II = getInstruction();
458 // Since this is actually a getter that "looks like" a setter, don't use the
459 // above macros to avoid confusion.
461 cast<CallInst>(II)->getOperandBundlesAsDefs(Defs);
463 cast<InvokeInst>(II)->getOperandBundlesAsDefs(Defs);
466 /// @brief Determine whether this data operand is not captured.
467 bool doesNotCapture(unsigned OpNo) const {
468 return dataOperandHasImpliedAttr(OpNo + 1, Attribute::NoCapture);
471 /// @brief Determine whether this argument is passed by value.
472 bool isByValArgument(unsigned ArgNo) const {
473 return paramHasAttr(ArgNo + 1, Attribute::ByVal);
476 /// @brief Determine whether this argument is passed in an alloca.
477 bool isInAllocaArgument(unsigned ArgNo) const {
478 return paramHasAttr(ArgNo + 1, Attribute::InAlloca);
481 /// @brief Determine whether this argument is passed by value or in an alloca.
482 bool isByValOrInAllocaArgument(unsigned ArgNo) const {
483 return paramHasAttr(ArgNo + 1, Attribute::ByVal) ||
484 paramHasAttr(ArgNo + 1, Attribute::InAlloca);
487 /// @brief Determine if there are is an inalloca argument. Only the last
488 /// argument can have the inalloca attribute.
489 bool hasInAllocaArgument() const {
490 return paramHasAttr(arg_size(), Attribute::InAlloca);
493 bool doesNotAccessMemory(unsigned OpNo) const {
494 return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
497 bool onlyReadsMemory(unsigned OpNo) const {
498 return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadOnly) ||
499 dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
502 /// @brief Return true if the return value is known to be not null.
503 /// This may be because it has the nonnull attribute, or because at least
504 /// one byte is dereferenceable and the pointer is in addrspace(0).
505 bool isReturnNonNull() const {
506 if (paramHasAttr(0, Attribute::NonNull))
508 else if (getDereferenceableBytes(0) > 0 &&
509 getType()->getPointerAddressSpace() == 0)
515 /// hasArgument - Returns true if this CallSite passes the given Value* as an
516 /// argument to the called function.
517 bool hasArgument(const Value *Arg) const {
518 for (arg_iterator AI = this->arg_begin(), E = this->arg_end(); AI != E;
520 if (AI->get() == Arg)
526 IterTy getCallee() const {
527 if (isCall()) // Skip Callee
528 return cast<CallInst>(getInstruction())->op_end() - 1;
529 else // Skip BB, BB, Callee
530 return cast<InvokeInst>(getInstruction())->op_end() - 3;
534 class CallSite : public CallSiteBase<Function, BasicBlock, Value, User, Use,
535 Instruction, CallInst, InvokeInst,
539 CallSite(CallSiteBase B) : CallSiteBase(B) {}
540 CallSite(CallInst *CI) : CallSiteBase(CI) {}
541 CallSite(InvokeInst *II) : CallSiteBase(II) {}
542 explicit CallSite(Instruction *II) : CallSiteBase(II) {}
543 explicit CallSite(Value *V) : CallSiteBase(V) {}
545 bool operator==(const CallSite &CS) const { return I == CS.I; }
546 bool operator!=(const CallSite &CS) const { return I != CS.I; }
547 bool operator<(const CallSite &CS) const {
548 return getInstruction() < CS.getInstruction();
552 User::op_iterator getCallee() const;
555 /// ImmutableCallSite - establish a view to a call site for examination
556 class ImmutableCallSite : public CallSiteBase<> {
558 ImmutableCallSite() {}
559 ImmutableCallSite(const CallInst *CI) : CallSiteBase(CI) {}
560 ImmutableCallSite(const InvokeInst *II) : CallSiteBase(II) {}
561 explicit ImmutableCallSite(const Instruction *II) : CallSiteBase(II) {}
562 explicit ImmutableCallSite(const Value *V) : CallSiteBase(V) {}
563 ImmutableCallSite(CallSite CS) : CallSiteBase(CS.getInstruction()) {}
566 } // End llvm namespace