clang  7.0.0svn
CallEvent.cpp
Go to the documentation of this file.
1 //===- CallEvent.cpp - Wrapper for all function and method calls ----------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// \file This file defines CallEvent and its subclasses, which represent path-
11 /// sensitive instances of different kinds of function and method calls
12 /// (C, C++, and Objective-C).
13 //
14 //===----------------------------------------------------------------------===//
15 
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/Decl.h"
19 #include "clang/AST/DeclBase.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/Expr.h"
23 #include "clang/AST/ExprCXX.h"
24 #include "clang/AST/ExprObjC.h"
25 #include "clang/AST/ParentMap.h"
26 #include "clang/AST/Stmt.h"
27 #include "clang/AST/Type.h"
29 #include "clang/Analysis/CFG.h"
33 #include "clang/Basic/LLVM.h"
36 #include "clang/Basic/Specifiers.h"
47 #include "llvm/ADT/ArrayRef.h"
48 #include "llvm/ADT/DenseMap.h"
49 #include "llvm/ADT/None.h"
50 #include "llvm/ADT/Optional.h"
51 #include "llvm/ADT/PointerIntPair.h"
52 #include "llvm/ADT/SmallSet.h"
53 #include "llvm/ADT/SmallVector.h"
54 #include "llvm/ADT/StringExtras.h"
55 #include "llvm/ADT/StringRef.h"
56 #include "llvm/Support/Casting.h"
57 #include "llvm/Support/Compiler.h"
58 #include "llvm/Support/Debug.h"
59 #include "llvm/Support/ErrorHandling.h"
60 #include "llvm/Support/raw_ostream.h"
61 #include <cassert>
62 #include <utility>
63 
64 #define DEBUG_TYPE "static-analyzer-call-event"
65 
66 using namespace clang;
67 using namespace ento;
68 
70  ASTContext &Ctx = getState()->getStateManager().getContext();
71  const Expr *E = getOriginExpr();
72  if (!E)
73  return Ctx.VoidTy;
74  assert(E);
75 
76  QualType ResultTy = E->getType();
77 
78  // A function that returns a reference to 'int' will have a result type
79  // of simply 'int'. Check the origin expr's value kind to recover the
80  // proper type.
81  switch (E->getValueKind()) {
82  case VK_LValue:
83  ResultTy = Ctx.getLValueReferenceType(ResultTy);
84  break;
85  case VK_XValue:
86  ResultTy = Ctx.getRValueReferenceType(ResultTy);
87  break;
88  case VK_RValue:
89  // No adjustment is necessary.
90  break;
91  }
92 
93  return ResultTy;
94 }
95 
96 static bool isCallback(QualType T) {
97  // If a parameter is a block or a callback, assume it can modify pointer.
98  if (T->isBlockPointerType() ||
99  T->isFunctionPointerType() ||
100  T->isObjCSelType())
101  return true;
102 
103  // Check if a callback is passed inside a struct (for both, struct passed by
104  // reference and by value). Dig just one level into the struct for now.
105 
106  if (T->isAnyPointerType() || T->isReferenceType())
107  T = T->getPointeeType();
108 
109  if (const RecordType *RT = T->getAsStructureType()) {
110  const RecordDecl *RD = RT->getDecl();
111  for (const auto *I : RD->fields()) {
112  QualType FieldT = I->getType();
113  if (FieldT->isBlockPointerType() || FieldT->isFunctionPointerType())
114  return true;
115  }
116  }
117  return false;
118 }
119 
121  if (const auto *PT = T->getAs<PointerType>()) {
122  QualType PointeeTy = PT->getPointeeType();
123  if (PointeeTy.isConstQualified())
124  return false;
125  return PointeeTy->isVoidType();
126  } else
127  return false;
128 }
129 
130 bool CallEvent::hasNonNullArgumentsWithType(bool (*Condition)(QualType)) const {
131  unsigned NumOfArgs = getNumArgs();
132 
133  // If calling using a function pointer, assume the function does not
134  // satisfy the callback.
135  // TODO: We could check the types of the arguments here.
136  if (!getDecl())
137  return false;
138 
139  unsigned Idx = 0;
141  E = param_type_end();
142  I != E && Idx < NumOfArgs; ++I, ++Idx) {
143  // If the parameter is 0, it's harmless.
144  if (getArgSVal(Idx).isZeroConstant())
145  continue;
146 
147  if (Condition(*I))
148  return true;
149  }
150  return false;
151 }
152 
155 }
156 
159 }
160 
161 bool CallEvent::isGlobalCFunction(StringRef FunctionName) const {
162  const auto *FD = dyn_cast_or_null<FunctionDecl>(getDecl());
163  if (!FD)
164  return false;
165 
166  return CheckerContext::isCLibraryFunction(FD, FunctionName);
167 }
168 
169 /// Returns true if a type is a pointer-to-const or reference-to-const
170 /// with no further indirection.
171 static bool isPointerToConst(QualType Ty) {
172  QualType PointeeTy = Ty->getPointeeType();
173  if (PointeeTy == QualType())
174  return false;
175  if (!PointeeTy.isConstQualified())
176  return false;
177  if (PointeeTy->isAnyPointerType())
178  return false;
179  return true;
180 }
181 
182 // Try to retrieve the function declaration and find the function parameter
183 // types which are pointers/references to a non-pointer const.
184 // We will not invalidate the corresponding argument regions.
185 static void findPtrToConstParams(llvm::SmallSet<unsigned, 4> &PreserveArgs,
186  const CallEvent &Call) {
187  unsigned Idx = 0;
189  E = Call.param_type_end();
190  I != E; ++I, ++Idx) {
191  if (isPointerToConst(*I))
192  PreserveArgs.insert(Idx);
193  }
194 }
195 
197  ProgramStateRef Orig) const {
198  ProgramStateRef Result = (Orig ? Orig : getState());
199 
200  // Don't invalidate anything if the callee is marked pure/const.
201  if (const Decl *callee = getDecl())
202  if (callee->hasAttr<PureAttr>() || callee->hasAttr<ConstAttr>())
203  return Result;
204 
205  SmallVector<SVal, 8> ValuesToInvalidate;
207 
208  getExtraInvalidatedValues(ValuesToInvalidate, &ETraits);
209 
210  // Indexes of arguments whose values will be preserved by the call.
211  llvm::SmallSet<unsigned, 4> PreserveArgs;
212  if (!argumentsMayEscape())
213  findPtrToConstParams(PreserveArgs, *this);
214 
215  for (unsigned Idx = 0, Count = getNumArgs(); Idx != Count; ++Idx) {
216  // Mark this region for invalidation. We batch invalidate regions
217  // below for efficiency.
218  if (PreserveArgs.count(Idx))
219  if (const MemRegion *MR = getArgSVal(Idx).getAsRegion())
220  ETraits.setTrait(MR->getBaseRegion(),
222  // TODO: Factor this out + handle the lower level const pointers.
223 
224  ValuesToInvalidate.push_back(getArgSVal(Idx));
225  }
226 
227  // Invalidate designated regions using the batch invalidation API.
228  // NOTE: Even if RegionsToInvalidate is empty, we may still invalidate
229  // global variables.
230  return Result->invalidateRegions(ValuesToInvalidate, getOriginExpr(),
231  BlockCount, getLocationContext(),
232  /*CausedByPointerEscape*/ true,
233  /*Symbols=*/nullptr, this, &ETraits);
234 }
235 
237  const ProgramPointTag *Tag) const {
238  if (const Expr *E = getOriginExpr()) {
239  if (IsPreVisit)
240  return PreStmt(E, getLocationContext(), Tag);
241  return PostStmt(E, getLocationContext(), Tag);
242  }
243 
244  const Decl *D = getDecl();
245  assert(D && "Cannot get a program point without a statement or decl");
246 
248  if (IsPreVisit)
249  return PreImplicitCall(D, Loc, getLocationContext(), Tag);
250  return PostImplicitCall(D, Loc, getLocationContext(), Tag);
251 }
252 
253 bool CallEvent::isCalled(const CallDescription &CD) const {
254  // FIXME: Add ObjC Message support.
255  if (getKind() == CE_ObjCMessage)
256  return false;
257  if (!CD.IsLookupDone) {
258  CD.IsLookupDone = true;
259  CD.II = &getState()->getStateManager().getContext().Idents.get(CD.FuncName);
260  }
261  const IdentifierInfo *II = getCalleeIdentifier();
262  if (!II || II != CD.II)
263  return false;
264  return (CD.RequiredArgs == CallDescription::NoArgRequirement ||
265  CD.RequiredArgs == getNumArgs());
266 }
267 
268 SVal CallEvent::getArgSVal(unsigned Index) const {
269  const Expr *ArgE = getArgExpr(Index);
270  if (!ArgE)
271  return UnknownVal();
272  return getSVal(ArgE);
273 }
274 
276  const Expr *ArgE = getArgExpr(Index);
277  if (!ArgE)
278  return {};
279  return ArgE->getSourceRange();
280 }
281 
283  const Expr *E = getOriginExpr();
284  if (!E)
285  return UndefinedVal();
286  return getSVal(E);
287 }
288 
289 LLVM_DUMP_METHOD void CallEvent::dump() const { dump(llvm::errs()); }
290 
291 void CallEvent::dump(raw_ostream &Out) const {
292  ASTContext &Ctx = getState()->getStateManager().getContext();
293  if (const Expr *E = getOriginExpr()) {
294  E->printPretty(Out, nullptr, Ctx.getPrintingPolicy());
295  Out << "\n";
296  return;
297  }
298 
299  if (const Decl *D = getDecl()) {
300  Out << "Call to ";
301  D->print(Out, Ctx.getPrintingPolicy());
302  return;
303  }
304 
305  // FIXME: a string representation of the kind would be nice.
306  Out << "Unknown call (type " << getKind() << ")";
307 }
308 
309 bool CallEvent::isCallStmt(const Stmt *S) {
310  return isa<CallExpr>(S) || isa<ObjCMessageExpr>(S)
311  || isa<CXXConstructExpr>(S)
312  || isa<CXXNewExpr>(S);
313 }
314 
316  assert(D);
317  if (const auto *FD = dyn_cast<FunctionDecl>(D))
318  return FD->getReturnType();
319  if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
320  return MD->getReturnType();
321  if (const auto *BD = dyn_cast<BlockDecl>(D)) {
322  // Blocks are difficult because the return type may not be stored in the
323  // BlockDecl itself. The AST should probably be enhanced, but for now we
324  // just do what we can.
325  // If the block is declared without an explicit argument list, the
326  // signature-as-written just includes the return type, not the entire
327  // function type.
328  // FIXME: All blocks should have signatures-as-written, even if the return
329  // type is inferred. (That's signified with a dependent result type.)
330  if (const TypeSourceInfo *TSI = BD->getSignatureAsWritten()) {
331  QualType Ty = TSI->getType();
332  if (const FunctionType *FT = Ty->getAs<FunctionType>())
333  Ty = FT->getReturnType();
334  if (!Ty->isDependentType())
335  return Ty;
336  }
337 
338  return {};
339  }
340 
341  llvm_unreachable("unknown callable kind");
342 }
343 
344 bool CallEvent::isVariadic(const Decl *D) {
345  assert(D);
346 
347  if (const auto *FD = dyn_cast<FunctionDecl>(D))
348  return FD->isVariadic();
349  if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
350  return MD->isVariadic();
351  if (const auto *BD = dyn_cast<BlockDecl>(D))
352  return BD->isVariadic();
353 
354  llvm_unreachable("unknown callable kind");
355 }
356 
357 static void addParameterValuesToBindings(const StackFrameContext *CalleeCtx,
358  CallEvent::BindingsTy &Bindings,
359  SValBuilder &SVB,
360  const CallEvent &Call,
362  MemRegionManager &MRMgr = SVB.getRegionManager();
363 
364  // If the function has fewer parameters than the call has arguments, we simply
365  // do not bind any values to them.
366  unsigned NumArgs = Call.getNumArgs();
367  unsigned Idx = 0;
368  ArrayRef<ParmVarDecl*>::iterator I = parameters.begin(), E = parameters.end();
369  for (; I != E && Idx < NumArgs; ++I, ++Idx) {
370  const ParmVarDecl *ParamDecl = *I;
371  assert(ParamDecl && "Formal parameter has no decl?");
372 
373  SVal ArgVal = Call.getArgSVal(Idx);
374  if (!ArgVal.isUnknown()) {
375  Loc ParamLoc = SVB.makeLoc(MRMgr.getVarRegion(ParamDecl, CalleeCtx));
376  Bindings.push_back(std::make_pair(ParamLoc, ArgVal));
377  }
378  }
379 
380  // FIXME: Variadic arguments are not handled at all right now.
381 }
382 
384  const FunctionDecl *D = getDecl();
385  if (!D)
386  return None;
387  return D->parameters();
388 }
389 
391  const FunctionDecl *FD = getDecl();
392  if (!FD)
393  return {};
394 
395  // Note that the AnalysisDeclContext will have the FunctionDecl with
396  // the definition (if one exists).
397  AnalysisDeclContext *AD =
399  getManager()->getContext(FD);
400  bool IsAutosynthesized;
401  Stmt* Body = AD->getBody(IsAutosynthesized);
402  LLVM_DEBUG({
403  if (IsAutosynthesized)
404  llvm::dbgs() << "Using autosynthesized body for " << FD->getName()
405  << "\n";
406  });
407  if (Body) {
408  const Decl* Decl = AD->getDecl();
409  return RuntimeDefinition(Decl);
410  }
411 
412  SubEngine *Engine = getState()->getStateManager().getOwningEngine();
413  AnalyzerOptions &Opts = Engine->getAnalysisManager().options;
414 
415  // Try to get CTU definition only if CTUDir is provided.
416  if (!Opts.naiveCTUEnabled())
417  return {};
418 
421  llvm::Expected<const FunctionDecl *> CTUDeclOrError =
422  CTUCtx.getCrossTUDefinition(FD, Opts.getCTUDir(), Opts.getCTUIndexName());
423 
424  if (!CTUDeclOrError) {
425  handleAllErrors(CTUDeclOrError.takeError(),
426  [&](const cross_tu::IndexError &IE) {
427  CTUCtx.emitCrossTUDiagnostics(IE);
428  });
429  return {};
430  }
431 
432  return RuntimeDefinition(*CTUDeclOrError);
433 }
434 
436  const StackFrameContext *CalleeCtx,
437  BindingsTy &Bindings) const {
438  const auto *D = cast<FunctionDecl>(CalleeCtx->getDecl());
439  SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
440  addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
441  D->parameters());
442 }
443 
446  return true;
447 
448  const FunctionDecl *D = getDecl();
449  if (!D)
450  return true;
451 
452  const IdentifierInfo *II = D->getIdentifier();
453  if (!II)
454  return false;
455 
456  // This set of "escaping" APIs is
457 
458  // - 'int pthread_setspecific(ptheread_key k, const void *)' stores a
459  // value into thread local storage. The value can later be retrieved with
460  // 'void *ptheread_getspecific(pthread_key)'. So even thought the
461  // parameter is 'const void *', the region escapes through the call.
462  if (II->isStr("pthread_setspecific"))
463  return true;
464 
465  // - xpc_connection_set_context stores a value which can be retrieved later
466  // with xpc_connection_get_context.
467  if (II->isStr("xpc_connection_set_context"))
468  return true;
469 
470  // - funopen - sets a buffer for future IO calls.
471  if (II->isStr("funopen"))
472  return true;
473 
474  // - __cxa_demangle - can reallocate memory and can return the pointer to
475  // the input buffer.
476  if (II->isStr("__cxa_demangle"))
477  return true;
478 
479  StringRef FName = II->getName();
480 
481  // - CoreFoundation functions that end with "NoCopy" can free a passed-in
482  // buffer even if it is const.
483  if (FName.endswith("NoCopy"))
484  return true;
485 
486  // - NSXXInsertXX, for example NSMapInsertIfAbsent, since they can
487  // be deallocated by NSMapRemove.
488  if (FName.startswith("NS") && (FName.find("Insert") != StringRef::npos))
489  return true;
490 
491  // - Many CF containers allow objects to escape through custom
492  // allocators/deallocators upon container construction. (PR12101)
493  if (FName.startswith("CF") || FName.startswith("CG")) {
494  return StrInStrNoCase(FName, "InsertValue") != StringRef::npos ||
495  StrInStrNoCase(FName, "AddValue") != StringRef::npos ||
496  StrInStrNoCase(FName, "SetValue") != StringRef::npos ||
497  StrInStrNoCase(FName, "WithData") != StringRef::npos ||
498  StrInStrNoCase(FName, "AppendValue") != StringRef::npos ||
499  StrInStrNoCase(FName, "SetAttribute") != StringRef::npos;
500  }
501 
502  return false;
503 }
504 
506  const FunctionDecl *D = getOriginExpr()->getDirectCallee();
507  if (D)
508  return D;
509 
510  return getSVal(getOriginExpr()->getCallee()).getAsFunctionDecl();
511 }
512 
514  const auto *CE = cast_or_null<CallExpr>(getOriginExpr());
515  if (!CE)
516  return AnyFunctionCall::getDecl();
517 
518  const FunctionDecl *D = CE->getDirectCallee();
519  if (D)
520  return D;
521 
522  return getSVal(CE->getCallee()).getAsFunctionDecl();
523 }
524 
526  ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const {
527  SVal ThisVal = getCXXThisVal();
528  Values.push_back(ThisVal);
529 
530  // Don't invalidate if the method is const and there are no mutable fields.
531  if (const auto *D = cast_or_null<CXXMethodDecl>(getDecl())) {
532  if (!D->isConst())
533  return;
534  // Get the record decl for the class of 'This'. D->getParent() may return a
535  // base class decl, rather than the class of the instance which needs to be
536  // checked for mutable fields.
537  const Expr *Ex = getCXXThisExpr()->ignoreParenBaseCasts();
538  const CXXRecordDecl *ParentRecord = Ex->getType()->getAsCXXRecordDecl();
539  if (!ParentRecord || ParentRecord->hasMutableFields())
540  return;
541  // Preserve CXXThis.
542  const MemRegion *ThisRegion = ThisVal.getAsRegion();
543  if (!ThisRegion)
544  return;
545 
546  ETraits->setTrait(ThisRegion->getBaseRegion(),
548  }
549 }
550 
552  const Expr *Base = getCXXThisExpr();
553  // FIXME: This doesn't handle an overloaded ->* operator.
554  if (!Base)
555  return UnknownVal();
556 
557  SVal ThisVal = getSVal(Base);
558  assert(ThisVal.isUnknownOrUndef() || ThisVal.getAs<Loc>());
559  return ThisVal;
560 }
561 
563  // Do we have a decl at all?
564  const Decl *D = getDecl();
565  if (!D)
566  return {};
567 
568  // If the method is non-virtual, we know we can inline it.
569  const auto *MD = cast<CXXMethodDecl>(D);
570  if (!MD->isVirtual())
572 
573  // Do we know the implicit 'this' object being called?
574  const MemRegion *R = getCXXThisVal().getAsRegion();
575  if (!R)
576  return {};
577 
578  // Do we know anything about the type of 'this'?
580  if (!DynType.isValid())
581  return {};
582 
583  // Is the type a C++ class? (This is mostly a defensive check.)
584  QualType RegionType = DynType.getType()->getPointeeType();
585  assert(!RegionType.isNull() && "DynamicTypeInfo should always be a pointer.");
586 
587  const CXXRecordDecl *RD = RegionType->getAsCXXRecordDecl();
588  if (!RD || !RD->hasDefinition())
589  return {};
590 
591  // Find the decl for this method in that class.
592  const CXXMethodDecl *Result = MD->getCorrespondingMethodInClass(RD, true);
593  if (!Result) {
594  // We might not even get the original statically-resolved method due to
595  // some particularly nasty casting (e.g. casts to sister classes).
596  // However, we should at least be able to search up and down our own class
597  // hierarchy, and some real bugs have been caught by checking this.
598  assert(!RD->isDerivedFrom(MD->getParent()) && "Couldn't find known method");
599 
600  // FIXME: This is checking that our DynamicTypeInfo is at least as good as
601  // the static type. However, because we currently don't update
602  // DynamicTypeInfo when an object is cast, we can't actually be sure the
603  // DynamicTypeInfo is up to date. This assert should be re-enabled once
604  // this is fixed. <rdar://problem/12287087>
605  //assert(!MD->getParent()->isDerivedFrom(RD) && "Bad DynamicTypeInfo");
606 
607  return {};
608  }
609 
610  // Does the decl that we found have an implementation?
611  const FunctionDecl *Definition;
612  if (!Result->hasBody(Definition))
613  return {};
614 
615  // We found a definition. If we're not sure that this devirtualization is
616  // actually what will happen at runtime, make sure to provide the region so
617  // that ExprEngine can decide what to do with it.
618  if (DynType.canBeASubClass())
619  return RuntimeDefinition(Definition, R->StripCasts());
620  return RuntimeDefinition(Definition, /*DispatchRegion=*/nullptr);
621 }
622 
624  const StackFrameContext *CalleeCtx,
625  BindingsTy &Bindings) const {
627 
628  // Handle the binding of 'this' in the new stack frame.
629  SVal ThisVal = getCXXThisVal();
630  if (!ThisVal.isUnknown()) {
631  ProgramStateManager &StateMgr = getState()->getStateManager();
632  SValBuilder &SVB = StateMgr.getSValBuilder();
633 
634  const auto *MD = cast<CXXMethodDecl>(CalleeCtx->getDecl());
635  Loc ThisLoc = SVB.getCXXThis(MD, CalleeCtx);
636 
637  // If we devirtualized to a different member function, we need to make sure
638  // we have the proper layering of CXXBaseObjectRegions.
639  if (MD->getCanonicalDecl() != getDecl()->getCanonicalDecl()) {
640  ASTContext &Ctx = SVB.getContext();
641  const CXXRecordDecl *Class = MD->getParent();
642  QualType Ty = Ctx.getPointerType(Ctx.getRecordType(Class));
643 
644  // FIXME: CallEvent maybe shouldn't be directly accessing StoreManager.
645  bool Failed;
646  ThisVal = StateMgr.getStoreManager().attemptDownCast(ThisVal, Ty, Failed);
647  if (Failed) {
648  // We might have suffered some sort of placement new earlier, so
649  // we're constructing in a completely unexpected storage.
650  // Fall back to a generic pointer cast for this-value.
651  const CXXMethodDecl *StaticMD = cast<CXXMethodDecl>(getDecl());
652  const CXXRecordDecl *StaticClass = StaticMD->getParent();
653  QualType StaticTy = Ctx.getPointerType(Ctx.getRecordType(StaticClass));
654  ThisVal = SVB.evalCast(ThisVal, Ty, StaticTy);
655  }
656  }
657 
658  if (!ThisVal.isUnknown())
659  Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
660  }
661 }
662 
664  return getOriginExpr()->getImplicitObjectArgument();
665 }
666 
668  // C++11 [expr.call]p1: ...If the selected function is non-virtual, or if the
669  // id-expression in the class member access expression is a qualified-id,
670  // that function is called. Otherwise, its final overrider in the dynamic type
671  // of the object expression is called.
672  if (const auto *ME = dyn_cast<MemberExpr>(getOriginExpr()->getCallee()))
673  if (ME->hasQualifier())
675 
677 }
678 
680  return getOriginExpr()->getArg(0);
681 }
682 
684  const Expr *Callee = getOriginExpr()->getCallee();
685  const MemRegion *DataReg = getSVal(Callee).getAsRegion();
686 
687  return dyn_cast_or_null<BlockDataRegion>(DataReg);
688 }
689 
691  const BlockDecl *D = getDecl();
692  if (!D)
693  return nullptr;
694  return D->parameters();
695 }
696 
698  RegionAndSymbolInvalidationTraits *ETraits) const {
699  // FIXME: This also needs to invalidate captured globals.
700  if (const MemRegion *R = getBlockRegion())
701  Values.push_back(loc::MemRegionVal(R));
702 }
703 
705  BindingsTy &Bindings) const {
706  SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
707  ArrayRef<ParmVarDecl*> Params;
708  if (isConversionFromLambda()) {
709  auto *LambdaOperatorDecl = cast<CXXMethodDecl>(CalleeCtx->getDecl());
710  Params = LambdaOperatorDecl->parameters();
711 
712  // For blocks converted from a C++ lambda, the callee declaration is the
713  // operator() method on the lambda so we bind "this" to
714  // the lambda captured by the block.
715  const VarRegion *CapturedLambdaRegion = getRegionStoringCapturedLambda();
716  SVal ThisVal = loc::MemRegionVal(CapturedLambdaRegion);
717  Loc ThisLoc = SVB.getCXXThis(LambdaOperatorDecl, CalleeCtx);
718  Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
719  } else {
720  Params = cast<BlockDecl>(CalleeCtx->getDecl())->parameters();
721  }
722 
723  addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
724  Params);
725 }
726 
728  if (Data)
729  return loc::MemRegionVal(static_cast<const MemRegion *>(Data));
730  return UnknownVal();
731 }
732 
734  RegionAndSymbolInvalidationTraits *ETraits) const {
735  if (Data) {
736  loc::MemRegionVal MV(static_cast<const MemRegion *>(Data));
737  if (SymbolRef Sym = MV.getAsSymbol(true))
738  ETraits->setTrait(Sym,
740  Values.push_back(MV);
741  }
742 }
743 
745  const StackFrameContext *CalleeCtx,
746  BindingsTy &Bindings) const {
748 
749  SVal ThisVal = getCXXThisVal();
750  if (!ThisVal.isUnknown()) {
751  SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
752  const auto *MD = cast<CXXMethodDecl>(CalleeCtx->getDecl());
753  Loc ThisLoc = SVB.getCXXThis(MD, CalleeCtx);
754  Bindings.push_back(std::make_pair(ThisLoc, ThisVal));
755  }
756 }
757 
759  if (Data)
760  return loc::MemRegionVal(DtorDataTy::getFromOpaqueValue(Data).getPointer());
761  return UnknownVal();
762 }
763 
765  // Base destructors are always called non-virtually.
766  // Skip CXXInstanceCall's devirtualization logic in this case.
767  if (isBaseDestructor())
769 
771 }
772 
774  const ObjCMethodDecl *D = getDecl();
775  if (!D)
776  return None;
777  return D->parameters();
778 }
779 
781  ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const {
782 
783  // If the method call is a setter for property known to be backed by
784  // an instance variable, don't invalidate the entire receiver, just
785  // the storage for that instance variable.
786  if (const ObjCPropertyDecl *PropDecl = getAccessedProperty()) {
787  if (const ObjCIvarDecl *PropIvar = PropDecl->getPropertyIvarDecl()) {
788  SVal IvarLVal = getState()->getLValue(PropIvar, getReceiverSVal());
789  if (const MemRegion *IvarRegion = IvarLVal.getAsRegion()) {
790  ETraits->setTrait(
791  IvarRegion,
793  ETraits->setTrait(
794  IvarRegion,
796  Values.push_back(IvarLVal);
797  }
798  return;
799  }
800  }
801 
802  Values.push_back(getReceiverSVal());
803 }
804 
806  const LocationContext *LCtx = getLocationContext();
807  const ImplicitParamDecl *SelfDecl = LCtx->getSelfDecl();
808  if (!SelfDecl)
809  return SVal();
810  return getState()->getSVal(getState()->getRegion(SelfDecl, LCtx));
811 }
812 
814  // FIXME: Is this the best way to handle class receivers?
815  if (!isInstanceMessage())
816  return UnknownVal();
817 
818  if (const Expr *RecE = getOriginExpr()->getInstanceReceiver())
819  return getSVal(RecE);
820 
821  // An instance message with no expression means we are sending to super.
822  // In this case the object reference is the same as 'self'.
823  assert(getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance);
824  SVal SelfVal = getSelfSVal();
825  assert(SelfVal.isValid() && "Calling super but not in ObjC method");
826  return SelfVal;
827 }
828 
830  if (getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperInstance ||
831  getOriginExpr()->getReceiverKind() == ObjCMessageExpr::SuperClass)
832  return true;
833 
834  if (!isInstanceMessage())
835  return false;
836 
837  SVal RecVal = getSVal(getOriginExpr()->getInstanceReceiver());
838 
839  return (RecVal == getSelfSVal());
840 }
841 
843  switch (getMessageKind()) {
844  case OCM_Message:
845  return getOriginExpr()->getSourceRange();
846  case OCM_PropertyAccess:
847  case OCM_Subscript:
848  return getContainingPseudoObjectExpr()->getSourceRange();
849  }
850  llvm_unreachable("unknown message kind");
851 }
852 
853 using ObjCMessageDataTy = llvm::PointerIntPair<const PseudoObjectExpr *, 2>;
854 
855 const PseudoObjectExpr *ObjCMethodCall::getContainingPseudoObjectExpr() const {
856  assert(Data && "Lazy lookup not yet performed.");
857  assert(getMessageKind() != OCM_Message && "Explicit message send.");
858  return ObjCMessageDataTy::getFromOpaqueValue(Data).getPointer();
859 }
860 
861 static const Expr *
863  const Expr *Syntactic = POE->getSyntacticForm();
864 
865  // This handles the funny case of assigning to the result of a getter.
866  // This can happen if the getter returns a non-const reference.
867  if (const auto *BO = dyn_cast<BinaryOperator>(Syntactic))
868  Syntactic = BO->getLHS();
869 
870  return Syntactic;
871 }
872 
874  if (!Data) {
875  // Find the parent, ignoring implicit casts.
878 
879  // Check if parent is a PseudoObjectExpr.
880  if (const auto *POE = dyn_cast_or_null<PseudoObjectExpr>(S)) {
881  const Expr *Syntactic = getSyntacticFromForPseudoObjectExpr(POE);
882 
883  ObjCMessageKind K;
884  switch (Syntactic->getStmtClass()) {
885  case Stmt::ObjCPropertyRefExprClass:
886  K = OCM_PropertyAccess;
887  break;
888  case Stmt::ObjCSubscriptRefExprClass:
889  K = OCM_Subscript;
890  break;
891  default:
892  // FIXME: Can this ever happen?
893  K = OCM_Message;
894  break;
895  }
896 
897  if (K != OCM_Message) {
898  const_cast<ObjCMethodCall *>(this)->Data
899  = ObjCMessageDataTy(POE, K).getOpaqueValue();
900  assert(getMessageKind() == K);
901  return K;
902  }
903  }
904 
905  const_cast<ObjCMethodCall *>(this)->Data
906  = ObjCMessageDataTy(nullptr, 1).getOpaqueValue();
907  assert(getMessageKind() == OCM_Message);
908  return OCM_Message;
909  }
910 
911  ObjCMessageDataTy Info = ObjCMessageDataTy::getFromOpaqueValue(Data);
912  if (!Info.getPointer())
913  return OCM_Message;
914  return static_cast<ObjCMessageKind>(Info.getInt());
915 }
916 
918  // Look for properties accessed with property syntax (foo.bar = ...)
919  if ( getMessageKind() == OCM_PropertyAccess) {
920  const PseudoObjectExpr *POE = getContainingPseudoObjectExpr();
921  assert(POE && "Property access without PseudoObjectExpr?");
922 
923  const Expr *Syntactic = getSyntacticFromForPseudoObjectExpr(POE);
924  auto *RefExpr = cast<ObjCPropertyRefExpr>(Syntactic);
925 
926  if (RefExpr->isExplicitProperty())
927  return RefExpr->getExplicitProperty();
928  }
929 
930  // Look for properties accessed with method syntax ([foo setBar:...]).
931  const ObjCMethodDecl *MD = getDecl();
932  if (!MD || !MD->isPropertyAccessor())
933  return nullptr;
934 
935  // Note: This is potentially quite slow.
936  return MD->findPropertyDecl();
937 }
938 
940  Selector Sel) const {
941  assert(IDecl);
942  AnalysisManager &AMgr =
943  getState()->getStateManager().getOwningEngine()->getAnalysisManager();
944  // If the class interface is declared inside the main file, assume it is not
945  // subcassed.
946  // TODO: It could actually be subclassed if the subclass is private as well.
947  // This is probably very rare.
948  SourceLocation InterfLoc = IDecl->getEndOfDefinitionLoc();
949  if (InterfLoc.isValid() && AMgr.isInCodeFile(InterfLoc))
950  return false;
951 
952  // Assume that property accessors are not overridden.
953  if (getMessageKind() == OCM_PropertyAccess)
954  return false;
955 
956  // We assume that if the method is public (declared outside of main file) or
957  // has a parent which publicly declares the method, the method could be
958  // overridden in a subclass.
959 
960  // Find the first declaration in the class hierarchy that declares
961  // the selector.
962  ObjCMethodDecl *D = nullptr;
963  while (true) {
964  D = IDecl->lookupMethod(Sel, true);
965 
966  // Cannot find a public definition.
967  if (!D)
968  return false;
969 
970  // If outside the main file,
971  if (D->getLocation().isValid() && !AMgr.isInCodeFile(D->getLocation()))
972  return true;
973 
974  if (D->isOverriding()) {
975  // Search in the superclass on the next iteration.
976  IDecl = D->getClassInterface();
977  if (!IDecl)
978  return false;
979 
980  IDecl = IDecl->getSuperClass();
981  if (!IDecl)
982  return false;
983 
984  continue;
985  }
986 
987  return false;
988  };
989 
990  llvm_unreachable("The while loop should always terminate.");
991 }
992 
994  if (!MD)
995  return MD;
996 
997  // Find the redeclaration that defines the method.
998  if (!MD->hasBody()) {
999  for (auto I : MD->redecls())
1000  if (I->hasBody())
1001  MD = cast<ObjCMethodDecl>(I);
1002  }
1003  return MD;
1004 }
1005 
1006 static bool isCallToSelfClass(const ObjCMessageExpr *ME) {
1007  const Expr* InstRec = ME->getInstanceReceiver();
1008  if (!InstRec)
1009  return false;
1010  const auto *InstRecIg = dyn_cast<DeclRefExpr>(InstRec->IgnoreParenImpCasts());
1011 
1012  // Check that receiver is called 'self'.
1013  if (!InstRecIg || !InstRecIg->getFoundDecl() ||
1014  !InstRecIg->getFoundDecl()->getName().equals("self"))
1015  return false;
1016 
1017  // Check that the method name is 'class'.
1018  if (ME->getSelector().getNumArgs() != 0 ||
1019  !ME->getSelector().getNameForSlot(0).equals("class"))
1020  return false;
1021 
1022  return true;
1023 }
1024 
1026  const ObjCMessageExpr *E = getOriginExpr();
1027  assert(E);
1028  Selector Sel = E->getSelector();
1029 
1030  if (E->isInstanceMessage()) {
1031  // Find the receiver type.
1032  const ObjCObjectPointerType *ReceiverT = nullptr;
1033  bool CanBeSubClassed = false;
1034  QualType SupersType = E->getSuperType();
1035  const MemRegion *Receiver = nullptr;
1036 
1037  if (!SupersType.isNull()) {
1038  // The receiver is guaranteed to be 'super' in this case.
1039  // Super always means the type of immediate predecessor to the method
1040  // where the call occurs.
1041  ReceiverT = cast<ObjCObjectPointerType>(SupersType);
1042  } else {
1043  Receiver = getReceiverSVal().getAsRegion();
1044  if (!Receiver)
1045  return {};
1046 
1047  DynamicTypeInfo DTI = getDynamicTypeInfo(getState(), Receiver);
1048  if (!DTI.isValid()) {
1049  assert(isa<AllocaRegion>(Receiver) &&
1050  "Unhandled untyped region class!");
1051  return {};
1052  }
1053 
1054  QualType DynType = DTI.getType();
1055  CanBeSubClassed = DTI.canBeASubClass();
1056  ReceiverT = dyn_cast<ObjCObjectPointerType>(DynType.getCanonicalType());
1057 
1058  if (ReceiverT && CanBeSubClassed)
1059  if (ObjCInterfaceDecl *IDecl = ReceiverT->getInterfaceDecl())
1060  if (!canBeOverridenInSubclass(IDecl, Sel))
1061  CanBeSubClassed = false;
1062  }
1063 
1064  // Handle special cases of '[self classMethod]' and
1065  // '[[self class] classMethod]', which are treated by the compiler as
1066  // instance (not class) messages. We will statically dispatch to those.
1067  if (auto *PT = dyn_cast_or_null<ObjCObjectPointerType>(ReceiverT)) {
1068  // For [self classMethod], return the compiler visible declaration.
1069  if (PT->getObjectType()->isObjCClass() &&
1070  Receiver == getSelfSVal().getAsRegion())
1072 
1073  // Similarly, handle [[self class] classMethod].
1074  // TODO: We are currently doing a syntactic match for this pattern with is
1075  // limiting as the test cases in Analysis/inlining/InlineObjCClassMethod.m
1076  // shows. A better way would be to associate the meta type with the symbol
1077  // using the dynamic type info tracking and use it here. We can add a new
1078  // SVal for ObjC 'Class' values that know what interface declaration they
1079  // come from. Then 'self' in a class method would be filled in with
1080  // something meaningful in ObjCMethodCall::getReceiverSVal() and we could
1081  // do proper dynamic dispatch for class methods just like we do for
1082  // instance methods now.
1083  if (E->getInstanceReceiver())
1084  if (const auto *M = dyn_cast<ObjCMessageExpr>(E->getInstanceReceiver()))
1085  if (isCallToSelfClass(M))
1087  }
1088 
1089  // Lookup the instance method implementation.
1090  if (ReceiverT)
1091  if (ObjCInterfaceDecl *IDecl = ReceiverT->getInterfaceDecl()) {
1092  // Repeatedly calling lookupPrivateMethod() is expensive, especially
1093  // when in many cases it returns null. We cache the results so
1094  // that repeated queries on the same ObjCIntefaceDecl and Selector
1095  // don't incur the same cost. On some test cases, we can see the
1096  // same query being issued thousands of times.
1097  //
1098  // NOTE: This cache is essentially a "global" variable, but it
1099  // only gets lazily created when we get here. The value of the
1100  // cache probably comes from it being global across ExprEngines,
1101  // where the same queries may get issued. If we are worried about
1102  // concurrency, or possibly loading/unloading ASTs, etc., we may
1103  // need to revisit this someday. In terms of memory, this table
1104  // stays around until clang quits, which also may be bad if we
1105  // need to release memory.
1106  using PrivateMethodKey = std::pair<const ObjCInterfaceDecl *, Selector>;
1107  using PrivateMethodCache =
1108  llvm::DenseMap<PrivateMethodKey, Optional<const ObjCMethodDecl *>>;
1109 
1110  static PrivateMethodCache PMC;
1111  Optional<const ObjCMethodDecl *> &Val = PMC[std::make_pair(IDecl, Sel)];
1112 
1113  // Query lookupPrivateMethod() if the cache does not hit.
1114  if (!Val.hasValue()) {
1115  Val = IDecl->lookupPrivateMethod(Sel);
1116 
1117  // If the method is a property accessor, we should try to "inline" it
1118  // even if we don't actually have an implementation.
1119  if (!*Val)
1120  if (const ObjCMethodDecl *CompileTimeMD = E->getMethodDecl())
1121  if (CompileTimeMD->isPropertyAccessor()) {
1122  if (!CompileTimeMD->getSelfDecl() &&
1123  isa<ObjCCategoryDecl>(CompileTimeMD->getDeclContext())) {
1124  // If the method is an accessor in a category, and it doesn't
1125  // have a self declaration, first
1126  // try to find the method in a class extension. This
1127  // works around a bug in Sema where multiple accessors
1128  // are synthesized for properties in class
1129  // extensions that are redeclared in a category and the
1130  // the implicit parameters are not filled in for
1131  // the method on the category.
1132  // This ensures we find the accessor in the extension, which
1133  // has the implicit parameters filled in.
1134  auto *ID = CompileTimeMD->getClassInterface();
1135  for (auto *CatDecl : ID->visible_extensions()) {
1136  Val = CatDecl->getMethod(Sel,
1137  CompileTimeMD->isInstanceMethod());
1138  if (*Val)
1139  break;
1140  }
1141  }
1142  if (!*Val)
1143  Val = IDecl->lookupInstanceMethod(Sel);
1144  }
1145  }
1146 
1147  const ObjCMethodDecl *MD = Val.getValue();
1148  if (CanBeSubClassed)
1149  return RuntimeDefinition(MD, Receiver);
1150  else
1151  return RuntimeDefinition(MD, nullptr);
1152  }
1153  } else {
1154  // This is a class method.
1155  // If we have type info for the receiver class, we are calling via
1156  // class name.
1157  if (ObjCInterfaceDecl *IDecl = E->getReceiverInterface()) {
1158  // Find/Return the method implementation.
1159  return RuntimeDefinition(IDecl->lookupPrivateClassMethod(Sel));
1160  }
1161  }
1162 
1163  return {};
1164 }
1165 
1167  if (isInSystemHeader() && !isInstanceMessage()) {
1168  Selector Sel = getSelector();
1169  if (Sel.getNumArgs() == 1 &&
1170  Sel.getIdentifierInfoForSlot(0)->isStr("valueWithPointer"))
1171  return true;
1172  }
1173 
1175 }
1176 
1178  const StackFrameContext *CalleeCtx,
1179  BindingsTy &Bindings) const {
1180  const auto *D = cast<ObjCMethodDecl>(CalleeCtx->getDecl());
1181  SValBuilder &SVB = getState()->getStateManager().getSValBuilder();
1182  addParameterValuesToBindings(CalleeCtx, Bindings, SVB, *this,
1183  D->parameters());
1184 
1185  SVal SelfVal = getReceiverSVal();
1186  if (!SelfVal.isUnknown()) {
1187  const VarDecl *SelfD = CalleeCtx->getAnalysisDeclContext()->getSelfDecl();
1188  MemRegionManager &MRMgr = SVB.getRegionManager();
1189  Loc SelfLoc = SVB.makeLoc(MRMgr.getVarRegion(SelfD, CalleeCtx));
1190  Bindings.push_back(std::make_pair(SelfLoc, SelfVal));
1191  }
1192 }
1193 
1196  const LocationContext *LCtx) {
1197  if (const auto *MCE = dyn_cast<CXXMemberCallExpr>(CE))
1198  return create<CXXMemberCall>(MCE, State, LCtx);
1199 
1200  if (const auto *OpCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
1201  const FunctionDecl *DirectCallee = OpCE->getDirectCallee();
1202  if (const auto *MD = dyn_cast<CXXMethodDecl>(DirectCallee))
1203  if (MD->isInstance())
1204  return create<CXXMemberOperatorCall>(OpCE, State, LCtx);
1205 
1206  } else if (CE->getCallee()->getType()->isBlockPointerType()) {
1207  return create<BlockCall>(CE, State, LCtx);
1208  }
1209 
1210  // Otherwise, it's a normal function call, static member function call, or
1211  // something we can't reason about.
1212  return create<SimpleFunctionCall>(CE, State, LCtx);
1213 }
1214 
1217  ProgramStateRef State) {
1218  const LocationContext *ParentCtx = CalleeCtx->getParent();
1219  const LocationContext *CallerCtx = ParentCtx->getCurrentStackFrame();
1220  assert(CallerCtx && "This should not be used for top-level stack frames");
1221 
1222  const Stmt *CallSite = CalleeCtx->getCallSite();
1223 
1224  if (CallSite) {
1225  if (const CallExpr *CE = dyn_cast<CallExpr>(CallSite))
1226  return getSimpleCall(CE, State, CallerCtx);
1227 
1228  switch (CallSite->getStmtClass()) {
1229  case Stmt::CXXConstructExprClass:
1230  case Stmt::CXXTemporaryObjectExprClass: {
1231  SValBuilder &SVB = State->getStateManager().getSValBuilder();
1232  const auto *Ctor = cast<CXXMethodDecl>(CalleeCtx->getDecl());
1233  Loc ThisPtr = SVB.getCXXThis(Ctor, CalleeCtx);
1234  SVal ThisVal = State->getSVal(ThisPtr);
1235 
1236  return getCXXConstructorCall(cast<CXXConstructExpr>(CallSite),
1237  ThisVal.getAsRegion(), State, CallerCtx);
1238  }
1239  case Stmt::CXXNewExprClass:
1240  return getCXXAllocatorCall(cast<CXXNewExpr>(CallSite), State, CallerCtx);
1241  case Stmt::ObjCMessageExprClass:
1242  return getObjCMethodCall(cast<ObjCMessageExpr>(CallSite),
1243  State, CallerCtx);
1244  default:
1245  llvm_unreachable("This is not an inlineable statement.");
1246  }
1247  }
1248 
1249  // Fall back to the CFG. The only thing we haven't handled yet is
1250  // destructors, though this could change in the future.
1251  const CFGBlock *B = CalleeCtx->getCallSiteBlock();
1252  CFGElement E = (*B)[CalleeCtx->getIndex()];
1253  assert((E.getAs<CFGImplicitDtor>() || E.getAs<CFGTemporaryDtor>()) &&
1254  "All other CFG elements should have exprs");
1255 
1256  SValBuilder &SVB = State->getStateManager().getSValBuilder();
1257  const auto *Dtor = cast<CXXDestructorDecl>(CalleeCtx->getDecl());
1258  Loc ThisPtr = SVB.getCXXThis(Dtor, CalleeCtx);
1259  SVal ThisVal = State->getSVal(ThisPtr);
1260 
1261  const Stmt *Trigger;
1263  Trigger = AutoDtor->getTriggerStmt();
1264  else if (Optional<CFGDeleteDtor> DeleteDtor = E.getAs<CFGDeleteDtor>())
1265  Trigger = DeleteDtor->getDeleteExpr();
1266  else
1267  Trigger = Dtor->getBody();
1268 
1269  return getCXXDestructorCall(Dtor, Trigger, ThisVal.getAsRegion(),
1270  E.getAs<CFGBaseDtor>().hasValue(), State,
1271  CallerCtx);
1272 }
The receiver is the instance of the superclass object.
Definition: ExprObjC.h:1060
Defines the clang::ASTContext interface.
SVal attemptDownCast(SVal Base, QualType DerivedPtrType, bool &Failed)
Attempts to do a down cast.
Definition: Store.cpp:305
SVal getSelfSVal() const
Return the value of &#39;self&#39; if available.
Definition: CallEvent.cpp:805
SVal getReceiverSVal() const
Returns the value of the receiver at the time of this call.
Definition: CallEvent.cpp:813
void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const override
Definition: CallEvent.cpp:733
Represents a function declaration or definition.
Definition: Decl.h:1714
Expr * getSyntacticForm()
Return the syntactic form of this expression, i.e.
Definition: Expr.h:5052
Smart pointer class that efficiently represents Objective-C method names.
PointerType - C99 6.7.5.1 - Pointer Declarators.
Definition: Type.h:2374
A (possibly-)qualified type.
Definition: Type.h:654
MemRegion - The root abstract class for all memory regions.
Definition: MemRegion.h:94
bool isBlockPointerType() const
Definition: Type.h:6056
bool argumentsMayEscape() const override
Returns true if any of the arguments are known to escape to long- term storage, even if this method w...
Definition: CallEvent.cpp:444
Selector getSelector() const
Definition: ExprObjC.cpp:312
ObjCInterfaceDecl * getClassInterface()
Definition: DeclObjC.cpp:1098
Stmt * getBody() const
Get the body of the Declaration.
static const Expr * getSyntacticFromForPseudoObjectExpr(const PseudoObjectExpr *POE)
Definition: CallEvent.cpp:862
Stmt - This represents one statement.
Definition: Stmt.h:66
Information about invalidation for a particular region/symbol.
Definition: MemRegion.h:1384
ProgramPoint getProgramPoint(bool IsPreVisit=false, const ProgramPointTag *Tag=nullptr) const
Returns an appropriate ProgramPoint for this call.
Definition: CallEvent.cpp:236
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:3147
static bool isCallToSelfClass(const ObjCMessageExpr *ME)
Definition: CallEvent.cpp:1006
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee...
Definition: Type.cpp:460
C Language Family Type Representation.
Defines the SourceManager interface.
ObjCInterfaceDecl * getReceiverInterface() const
Retrieve the Objective-C interface to which this message is being directed, if known.
Definition: ExprObjC.cpp:333
QualType getLValueReferenceType(QualType T, bool SpelledAsLValue=true) const
Return the uniqued reference to the type for an lvalue reference to the specified type...
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
const RecordType * getAsStructureType() const
Definition: Type.cpp:476
CFGDeleteDtor - Represents C++ object destructor generated from a call to delete. ...
Definition: CFG.h:405
SourceRange getSourceRange() const override
Definition: CallEvent.cpp:842
Represents a program point just before an implicit call event.
Definition: ProgramPoint.h:553
A container of type source information.
Definition: Decl.h:86
CallEventRef getSimpleCall(const CallExpr *E, ProgramStateRef State, const LocationContext *LCtx)
Definition: CallEvent.cpp:1195
SVal evalCast(SVal val, QualType castTy, QualType originalType)
void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
Definition: CallEvent.cpp:623
Expr * ignoreParenBaseCasts() LLVM_READONLY
Ignore parentheses and derived-to-base casts.
Definition: Expr.cpp:2540
bool isOverriding() const
Whether this method overrides any other in the class hierarchy.
Definition: DeclObjC.h:472
const Expr * getOriginExpr() const
Returns the expression whose value will be the result of this call.
Definition: CallEvent.h:248
Represents a variable declaration or definition.
Definition: Decl.h:812
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6455
loc::MemRegionVal getCXXThis(const CXXMethodDecl *D, const StackFrameContext *SFC)
Return a memory region for the &#39;this&#39; object reference.
void setTrait(SymbolRef Sym, InvalidationKinds IK)
Definition: MemRegion.cpp:1533
SVal getSVal(const Stmt *S) const
Get the value of arbitrary expressions at this point in the path.
Definition: CallEvent.h:208
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:139
static bool isVoidPointerToNonConst(QualType T)
Definition: CallEvent.cpp:120
const Expr * getCXXThisExpr() const override
Returns the expression representing the implicit &#39;this&#39; object.
Definition: CallEvent.cpp:679
ArrayRef< ParmVarDecl * > parameters() const override
Return call&#39;s formal parameters.
Definition: CallEvent.cpp:383
Represents a parameter to a function.
Definition: Decl.h:1533
Defines the clang::Expr interface and subclasses for C++ expressions.
void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const override
Definition: CallEvent.cpp:697
Symbolic value.
Definition: SymExpr.h:30
IdentifierInfo * getIdentifier() const
Get the identifier that names this declaration, if there is one.
Definition: Decl.h:269
Represents a struct/union/class.
Definition: Decl.h:3548
bool isValid() const
Return false if no dynamic type info is available.
One of these records is kept for each identifier that is lexed.
RuntimeDefinition getRuntimeDefinition() const override
Definition: CallEvent.cpp:667
MemRegionManager & getRegionManager()
Definition: SValBuilder.h:175
param_type_iterator param_type_end() const
Definition: CallEvent.h:433
bool isStr(const char(&Str)[StrLen]) const
Return true if this is the identifier for the specified string.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:150
field_range fields() const
Definition: Decl.h:3764
AnalysisDeclContext contains the context data for the function or method under analysis.
StringRef getCTUDir()
Returns the directory containing the CTU related files.
CFGAutomaticObjDtor - Represents C++ object destructor implicitly generated for automatic object or t...
Definition: CFG.h:379
bool isReferenceType() const
Definition: Type.h:6060
static bool isInCodeFile(SourceLocation SL, const SourceManager &SM)
virtual const Expr * getArgExpr(unsigned Index) const
Returns the expression associated with a given argument.
Definition: CallEvent.h:298
bool isObjCSelType() const
Definition: Type.h:6186
An r-value expression (a pr-value in the C++11 taxonomy) produces a temporary value.
Definition: Specifiers.h:110
ArrayRef< ParmVarDecl * > parameters() const
Definition: Decl.h:2222
static void addParameterValuesToBindings(const StackFrameContext *CalleeCtx, CallEvent::BindingsTy &Bindings, SValBuilder &SVB, const CallEvent &Call, ArrayRef< ParmVarDecl *> parameters)
Definition: CallEvent.cpp:357
BlockDataRegion - A region that represents a block instance.
Definition: MemRegion.h:668
Represents any expression that calls an Objective-C method.
Definition: CallEvent.h:892
virtual Kind getKind() const =0
Returns the kind of call this is.
const ImplicitParamDecl * getSelfDecl() const
bool hasNonZeroCallbackArg() const
Returns true if any of the arguments appear to represent callbacks.
Definition: CallEvent.cpp:153
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
An x-value expression is a reference to an object with independent storage but which can be "moved"...
Definition: Specifiers.h:119
ExprValueKind getValueKind() const
getValueKind - The value kind that this expression produces.
Definition: Expr.h:405
const StackFrameContext * getCurrentStackFrame() const
static void findPtrToConstParams(llvm::SmallSet< unsigned, 4 > &PreserveArgs, const CallEvent &Call)
Definition: CallEvent.cpp:185
const clang::PrintingPolicy & getPrintingPolicy() const
Definition: ASTContext.h:636
const LocationContext * getParent() const
static bool isPointerToConst(QualType Ty)
Returns true if a type is a pointer-to-const or reference-to-const with no further indirection...
Definition: CallEvent.cpp:171
bool isUnknown() const
Definition: SVals.h:137
QualType getType() const
Returns the currently inferred upper bound on the runtime type.
static const ObjCMethodDecl * findDefiningRedecl(const ObjCMethodDecl *MD)
Definition: CallEvent.cpp:993
SVal getReturnValue() const
Returns the return value of the call.
Definition: CallEvent.cpp:282
const FunctionDecl * getDecl() const override
Returns the declaration of the function or method that will be called.
Definition: CallEvent.h:457
param_type_iterator param_type_begin() const
Returns an iterator over the types of the call&#39;s formal parameters.
Definition: CallEvent.h:429
Represents an ObjC class declaration.
Definition: DeclObjC.h:1191
static bool isVariadic(const Decl *D)
Returns true if the given decl is known to be variadic.
Definition: CallEvent.cpp:344
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclBase.h:875
virtual ArrayRef< ParmVarDecl * > parameters() const =0
Return call&#39;s formal parameters.
const CFGBlock * getCallSiteBlock() const
SymbolRef getAsSymbol(bool IncludeBaseRegions=false) const
If this SVal wraps a symbol return that SymbolRef.
Definition: SVals.cpp:127
SmallVectorImpl< FrameBindingTy > BindingsTy
Definition: CallEvent.h:377
const Expr * getCXXThisExpr() const override
Returns the expression representing the implicit &#39;this&#39; object.
Definition: CallEvent.cpp:663
ObjCMessageKind
Represents the ways an Objective-C message send can occur.
Definition: CallEvent.h:883
bool isReceiverSelfOrSuper() const
Checks if the receiver refers to &#39;self&#39; or &#39;super&#39;.
Definition: CallEvent.cpp:829
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
Definition: Type.cpp:1590
const Stmt * getCallSite() const
ArrayRef< ParmVarDecl * > parameters() const override
Definition: CallEvent.cpp:773
CFGBlock - Represents a single basic block in a source-level CFG.
Definition: CFG.h:548
bool argumentsMayEscape() const override
Definition: CallEvent.cpp:1166
Loc makeLoc(SymbolRef sym)
Definition: SValBuilder.h:354
ArrayRef< ParmVarDecl * > parameters() const override
Definition: CallEvent.cpp:690
const LocationContext * getLocationContext() const
The context in which the call is being evaluated.
Definition: CallEvent.h:238
static bool isCallback(QualType T)
Definition: CallEvent.cpp:96
Pepresents a block literal declaration, which is like an unnamed FunctionDecl.
Definition: Decl.h:3838
bool canBeASubClass() const
Returns false if the type information is precise (the type T is the only type in the lattice)...
Expr - This represents one expression.
Definition: Expr.h:106
void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
Definition: CallEvent.cpp:1177
Stores the currently inferred strictest bound on the runtime type of a region in a given state along ...
const FunctionDecl * getDecl() const override
Returns the declaration of the function or method that will be called.
Definition: CallEvent.cpp:505
const FunctionProtoType * T
CallEventRef getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State)
Definition: CallEvent.cpp:1216
static bool isCLibraryFunction(const FunctionDecl *FD, StringRef Name=StringRef())
Returns true if the callee is an externally-visible function in the top-level namespace, such as malloc.
llvm::mapped_iterator< ArrayRef< ParmVarDecl * >::iterator, GetTypeFn > param_type_iterator
Definition: CallEvent.h:422
const Expr * getCallee() const
Definition: Expr.h:2282
bool isInSystemHeader() const
Returns true if the callee is known to be from a system header.
Definition: CallEvent.h:260
StringRef getNameForSlot(unsigned argIndex) const
Retrieve the name at a given position in the selector.
bool isValid() const
Definition: SVals.h:149
ObjCInterfaceDecl * getSuperClass() const
Definition: DeclObjC.cpp:331
virtual SVal getCXXThisVal() const
Returns the value of the implicit &#39;this&#39; object.
Definition: CallEvent.cpp:551
const IdentifierInfo * getCalleeIdentifier() const
Returns the name of the callee, if its name is a simple identifier.
Definition: CallEvent.h:358
void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
Definition: CallEvent.cpp:704
bool hasBody(const FunctionDecl *&Definition) const
Returns true if the function has a body.
Definition: Decl.cpp:2626
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
QualType getType() const
Definition: Expr.h:128
virtual const Decl * getDecl() const
Returns the declaration of the function or method that will be called.
Definition: CallEvent.h:228
An expression that sends a message to the given Objective-C object or class.
Definition: ExprObjC.h:903
virtual cross_tu::CrossTranslationUnitContext * getCrossTranslationUnitContext()=0
QualType getRecordType(const RecordDecl *Decl) const
unsigned getNumArgs() const
void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const override
Definition: CallEvent.cpp:780
CFGBaseDtor - Represents C++ object destructor implicitly generated for base object in destructor...
Definition: CFG.h:431
bool isNull() const
Return true if this QualType doesn&#39;t point to a type yet.
Definition: Type.h:719
ParentMap & getParentMap() const
Optional< T > getAs() const
Convert to the specified SVal type, returning None if this SVal is not of the desired type...
Definition: SVals.h:112
virtual bool argumentsMayEscape() const
Returns true if any of the arguments are known to escape to long- term storage, even if this method w...
Definition: CallEvent.h:329
RuntimeDefinition getRuntimeDefinition() const override
Definition: CallEvent.cpp:562
bool isConstQualified() const
Determine whether this type is const-qualified.
Definition: Type.h:5883
virtual SourceRange getSourceRange() const
Returns a source range for the entire call, suitable for outputting in diagnostics.
Definition: CallEvent.h:289
void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
Populates the given SmallVector with the bindings in the callee&#39;s stack frame at the start of this ca...
Definition: CallEvent.cpp:435
const MemRegion * StripCasts(bool StripBaseCasts=true) const
Definition: MemRegion.cpp:1152
const ImplicitParamDecl * getSelfDecl() const
Return the ImplicitParamDecl* associated with &#39;self&#39; if this AnalysisDeclContext wraps an ObjCMethodD...
Defines the runtime definition of the called function.
Definition: CallEvent.h:127
QualType getCanonicalType() const
Definition: Type.h:5863
PseudoObjectExpr - An expression which accesses a pseudo-object l-value.
Definition: Expr.h:5008
This class represents a description of a function call using the number of arguments and the name of ...
Definition: CallEvent.h:77
IdentifierInfo * getIdentifierInfoForSlot(unsigned argIndex) const
Retrieve the identifier at a given position in the selector.
void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const override
Definition: CallEvent.cpp:525
Encodes a location in the source.
const FunctionDecl * getDecl() const override
Definition: CallEvent.cpp:513
static bool isCallStmt(const Stmt *S)
Returns true if this is a statement is a function or method call of some kind.
Definition: CallEvent.cpp:309
ProgramPoints can be "tagged" as representing points specific to a given analysis entity...
Definition: ProgramPoint.h:40
const MemRegion * getAsRegion() const
Definition: SVals.cpp:151
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:2031
ASTContext & getContext()
Definition: SValBuilder.h:156
SVal - This represents a symbolic expression, which can be either an L-value or an R-value...
Definition: SVals.h:76
CanQualType VoidTy
Definition: ASTContext.h:997
const Decl * getDecl() const
bool isAnyPointerType() const
Definition: Type.h:6052
bool naiveCTUEnabled()
Returns true when naive cross translation unit analysis is enabled.
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:746
RuntimeDefinition getRuntimeDefinition() const override
Definition: CallEvent.cpp:764
const ObjCMethodDecl * getMethodDecl() const
Definition: ExprObjC.h:1302
Tells that a region&#39;s contents is not changed.
Definition: MemRegion.h:1399
virtual void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const
Used to specify non-argument regions that will be invalidated as a result of this call...
Definition: CallEvent.h:216
Optional< T > getAs() const
Convert to the specified CFGElement type, returning None if this CFGElement is not of the desired typ...
Definition: CFG.h:109
Defines various enumerations that describe declaration and type specifiers.
StringRef getName() const
Return the actual identifier string.
Expr * getInstanceReceiver()
Returns the object expression (receiver) for an instance message, or null for a message that is not a...
Definition: ExprObjC.h:1206
static const unsigned NoArgRequirement
Definition: CallEvent.h:86
llvm::Expected< const FunctionDecl * > getCrossTUDefinition(const FunctionDecl *FD, StringRef CrossTUDir, StringRef IndexName)
This function loads a function definition from an external AST file and merge it into the original AS...
redecl_range redecls() const
Returns an iterator range for all the redeclarations of the same decl.
Definition: DeclBase.h:946
SVal getCXXThisVal() const
Returns the value of the implicit &#39;this&#39; object.
Definition: CallEvent.cpp:727
Dataflow Directional Tag Classes.
virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl, Selector Sel) const
Check if the selector may have multiple definitions (may have overrides).
Definition: CallEvent.cpp:939
const BlockDataRegion * getBlockRegion() const
Returns the region associated with this instance of the block.
Definition: CallEvent.cpp:683
bool isValid() const
Return true if this is a valid SourceLocation object.
virtual SourceRange getArgSourceRange(unsigned Index) const
Returns the source range for errors associated with this argument.
Definition: CallEvent.cpp:275
Represents a program point just after an implicit call event.
Definition: ProgramPoint.h:570
DynamicTypeInfo getDynamicTypeInfo(ProgramStateRef State, const MemRegion *Reg)
Get dynamic type information for a region.
RuntimeDefinition getRuntimeDefinition() const override
Definition: CallEvent.cpp:1025
const VarRegion * getVarRegion(const VarDecl *D, const LocationContext *LC)
getVarRegion - Retrieve or create the memory region associated with a specified VarDecl and LocationC...
Definition: MemRegion.cpp:819
QualType getSuperType() const
Retrieve the type referred to by &#39;super&#39;.
Definition: ExprObjC.h:1282
StmtClass getStmtClass() const
Definition: Stmt.h:389
bool hasVoidPointerToNonConstArg() const
Returns true if any of the arguments is void*.
Definition: CallEvent.cpp:157
const CXXRecordDecl * getParent() const
Returns the parent of this method declaration, which is the class in which this method is defined...
Definition: DeclCXX.h:2151
Represents an abstract call to a function or method along a particular path.
Definition: CallEvent.h:164
ObjCMessageKind getMessageKind() const
Returns how the message was written in the source (property access, subscript, or explicit message se...
Definition: CallEvent.cpp:873
This class is used for tools that requires cross translation unit capability.
const Decl * getDecl() const
Expr * IgnoreParenImpCasts() LLVM_READONLY
IgnoreParenImpCasts - Ignore parentheses and implicit casts.
Definition: Expr.cpp:2557
Represents a pointer to an Objective C object.
Definition: Type.h:5546
const FunctionDecl * getAsFunctionDecl() const
getAsFunctionDecl - If this SVal is a MemRegionVal and wraps a CodeTextRegion wrapping a FunctionDecl...
Definition: SVals.cpp:63
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:4071
StringRef getCTUIndexName()
Returns the name of the file containing the CTU index of functions.
ObjCInterfaceDecl * getInterfaceDecl() const
If this pointer points to an Objective @interface type, gets the declaration for that interface...
Definition: Type.h:5602
bool hasBody() const override
Determine whether this method has a body.
Definition: DeclObjC.h:524
static QualType getDeclaredResultType(const Decl *D)
Returns the result type of a function or method declaration.
Definition: CallEvent.cpp:315
bool isGlobalCFunction(StringRef SpecificName=StringRef()) const
Returns true if the callee is an externally-visible function in the top-level namespace, such as malloc.
Definition: CallEvent.cpp:161
ObjCMethodDecl * lookupMethod(Selector Sel, bool isInstance, bool shallowCategoryLookup=false, bool followSuper=true, const ObjCCategoryDecl *C=nullptr) const
lookupMethod - This method returns an instance/class method by looking in the class, its categories, and its super classes (using a linear search).
Definition: DeclObjC.cpp:676
QualType getResultType() const
Returns the result type, adjusted for references.
Definition: CallEvent.cpp:69
bool hasMutableFields() const
Determine whether this class, or any of its class subobjects, contains a mutable field.
Definition: DeclCXX.h:1346
const ObjCPropertyDecl * findPropertyDecl(bool CheckOverrides=true) const
Returns the property associated with this method&#39;s selector.
Definition: DeclObjC.cpp:1256
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
bool hasNonNullArgumentsWithType(bool(*Condition)(QualType)) const
Returns true if the type of any of the non-null arguments satisfies the condition.
Definition: CallEvent.cpp:130
const ProgramStateRef & getState() const
The state in which the call is being evaluated.
Definition: CallEvent.h:233
Defines the clang::SourceLocation class and associated facilities.
Represents a C++ struct/union/class.
Definition: DeclCXX.h:300
QualType getRValueReferenceType(QualType T) const
Return the uniqued reference to the type for an rvalue reference to the specified type...
bool isVoidType() const
Definition: Type.h:6275
SVal getCXXThisVal() const override
Returns the value of the implicit &#39;this&#39; object.
Definition: CallEvent.cpp:758
CFGImplicitDtor - Represents C++ object destructor implicitly generated by compiler on various occasi...
Definition: CFG.h:354
bool isCalled(const CallDescription &CD) const
Returns true if the CallEvent is a call to a function that matches the CallDescription.
Definition: CallEvent.cpp:253
ObjCIvarDecl - Represents an ObjC instance variable.
Definition: DeclObjC.h:1964
virtual unsigned getNumArgs() const =0
Returns the number of arguments (explicit and implicit).
CFGElement - Represents a top-level expression in a basic block.
Definition: CFG.h:55
llvm::PointerIntPair< const PseudoObjectExpr *, 2 > ObjCMessageDataTy
Definition: CallEvent.cpp:853
QualType getPointerType(QualType T) const
Return the uniqued reference to the type for a pointer to the specified type.
const MemRegion * getBaseRegion() const
Definition: MemRegion.cpp:1126
SourceRange getSourceRange() const LLVM_READONLY
SourceLocation tokens are not useful in isolation - they are low level value objects created/interpre...
Definition: Stmt.cpp:266
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition: Expr.h:2242
void emitCrossTUDiagnostics(const IndexError &IE)
Emit diagnostics for the user for potential configuration errors.
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
Definition: Decl.h:275
const ObjCPropertyDecl * getAccessedProperty() const
Definition: CallEvent.cpp:917
Stmt * getParentIgnoreParenCasts(Stmt *) const
Definition: ParentMap.cpp:134
ProgramStateRef invalidateRegions(unsigned BlockCount, ProgramStateRef Orig=nullptr) const
Returns a new state with all argument regions invalidated.
Definition: CallEvent.cpp:196
bool isDependentType() const
Whether this type is a dependent type, meaning that its definition somehow depends on a template para...
Definition: Type.h:1929
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:972
ArrayRef< ParmVarDecl * > parameters() const
Definition: Decl.h:3927
virtual SVal getArgSVal(unsigned Index) const
Returns the value of a given argument at the time of the call.
Definition: CallEvent.cpp:268
An l-value expression is a reference to an object with independent storage.
Definition: Specifiers.h:114
const void * Data
Definition: CallEvent.h:175
A trivial tuple used to represent a source range.
bool isPropertyAccessor() const
Definition: DeclObjC.h:459
AnalysisDeclContext * getAnalysisDeclContext() const
SourceLocation getEndOfDefinitionLoc() const
Definition: DeclObjC.h:1897
bool isFunctionPointerType() const
Definition: Type.h:6072
The receiver is a superclass.
Definition: ExprObjC.h:1057
bool isInstanceMessage() const
Determine whether this is an instance message to either a computed object or to super.
Definition: ExprObjC.h:1194
SourceLocation getBegin() const
CFGTemporaryDtor - Represents C++ object destructor implicitly generated at the end of full expressio...
Definition: CFG.h:473
RuntimeDefinition getRuntimeDefinition() const override
Returns the definition of the function or method that will be called.
Definition: CallEvent.cpp:390
bool isUnknownOrUndef() const
Definition: SVals.h:145
SourceLocation getLocation() const
Definition: DeclBase.h:417
ArrayRef< ParmVarDecl * > parameters() const
Definition: DeclObjC.h:405
void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
Definition: CallEvent.cpp:744
virtual AnalysisManager & getAnalysisManager()=0