contrib/llvm/tools/clang/lib/StaticAnalyzer/Core/PathDiagnostic.cpp

   1 //===--- PathDiagnostic.cpp - Path-Specific Diagnostic Handling -*- C++ -*-===//
   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 //  This file defines the PathDiagnostic-related interfaces.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h"
  15 #include "clang/AST/Decl.h"
  16 #include "clang/AST/DeclCXX.h"
  17 #include "clang/AST/DeclObjC.h"
  18 #include "clang/AST/Expr.h"
  19 #include "clang/AST/ExprCXX.h"
  20 #include "clang/AST/ParentMap.h"
  21 #include "clang/AST/StmtCXX.h"
  22 #include "clang/Basic/SourceManager.h"
  23 #include "clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/ADT/StringExtras.h"
  26 #include "llvm/Support/raw_ostream.h"
  27
  28 using namespace clang;
  29 using namespace ento;
  30
  31 bool PathDiagnosticMacroPiece::containsEvent() const {
  32   for (auto &P : subPieces) {
  33     if (isa<PathDiagnosticEventPiece>(*P))
  34       return true;
  35     if (auto *MP = dyn_cast<PathDiagnosticMacroPiece>(P.get()))
  36       if (MP->containsEvent())
  37         return true;
  38   }
  39   return false;
  40 }
  41
  42 static StringRef StripTrailingDots(StringRef s) {
  43   for (StringRef::size_type i = s.size(); i != 0; --i)
  44     if (s[i - 1] != '.')
  45       return s.substr(0, i);
  46   return "";
  47 }
  48
  49 PathDiagnosticPiece::PathDiagnosticPiece(StringRef s,
  50                                          Kind k, DisplayHint hint)
  51   : str(StripTrailingDots(s)), kind(k), Hint(hint),
  52     LastInMainSourceFile(false) {}
  53
  54 PathDiagnosticPiece::PathDiagnosticPiece(Kind k, DisplayHint hint)
  55   : kind(k), Hint(hint), LastInMainSourceFile(false) {}
  56
  57 PathDiagnosticPiece::~PathDiagnosticPiece() {}
  58 PathDiagnosticEventPiece::~PathDiagnosticEventPiece() {}
  59 PathDiagnosticCallPiece::~PathDiagnosticCallPiece() {}
  60 PathDiagnosticControlFlowPiece::~PathDiagnosticControlFlowPiece() {}
  61 PathDiagnosticMacroPiece::~PathDiagnosticMacroPiece() {}
  62 PathDiagnosticNotePiece::~PathDiagnosticNotePiece() {}
  63
  64 void PathPieces::flattenTo(PathPieces &Primary, PathPieces &Current,
  65                            bool ShouldFlattenMacros) const {
  66   for (auto &Piece : *this) {
  67     switch (Piece->getKind()) {
  68     case PathDiagnosticPiece::Call: {
  69       auto &Call = cast<PathDiagnosticCallPiece>(*Piece);
  70       if (auto CallEnter = Call.getCallEnterEvent())
  71         Current.push_back(std::move(CallEnter));
  72       Call.path.flattenTo(Primary, Primary, ShouldFlattenMacros);
  73       if (auto callExit = Call.getCallExitEvent())
  74         Current.push_back(std::move(callExit));
  75       break;
  76     }
  77     case PathDiagnosticPiece::Macro: {
  78       auto &Macro = cast<PathDiagnosticMacroPiece>(*Piece);
  79       if (ShouldFlattenMacros) {
  80         Macro.subPieces.flattenTo(Primary, Primary, ShouldFlattenMacros);
  81       } else {
  82         Current.push_back(Piece);
  83         PathPieces NewPath;
  84         Macro.subPieces.flattenTo(Primary, NewPath, ShouldFlattenMacros);
  85         // FIXME: This probably shouldn't mutate the original path piece.
  86         Macro.subPieces = NewPath;
  87       }
  88       break;
  89     }
  90     case PathDiagnosticPiece::Event:
  91     case PathDiagnosticPiece::ControlFlow:
  92     case PathDiagnosticPiece::Note:
  93       Current.push_back(Piece);
  94       break;
  95     }
  96   }
  97 }
  98
  99 PathDiagnostic::~PathDiagnostic() {}
 100
 101 PathDiagnostic::PathDiagnostic(StringRef CheckName, const Decl *declWithIssue,
 102                                StringRef bugtype, StringRef verboseDesc,
 103                                StringRef shortDesc, StringRef category,
 104                                PathDiagnosticLocation LocationToUnique,
 105                                const Decl *DeclToUnique)
 106   : CheckName(CheckName),
 107     DeclWithIssue(declWithIssue),
 108     BugType(StripTrailingDots(bugtype)),
 109     VerboseDesc(StripTrailingDots(verboseDesc)),
 110     ShortDesc(StripTrailingDots(shortDesc)),
 111     Category(StripTrailingDots(category)),
 112     UniqueingLoc(LocationToUnique),
 113     UniqueingDecl(DeclToUnique),
 114     path(pathImpl) {}
 115
 116 static PathDiagnosticCallPiece *
 117 getFirstStackedCallToHeaderFile(PathDiagnosticCallPiece *CP,
 118                                 const SourceManager &SMgr) {
 119   SourceLocation CallLoc = CP->callEnter.asLocation();
 120
 121   // If the call is within a macro, don't do anything (for now).
 122   if (CallLoc.isMacroID())
 123     return nullptr;
 124
 125   assert(SMgr.isInMainFile(CallLoc) &&
 126          "The call piece should be in the main file.");
 127
 128   // Check if CP represents a path through a function outside of the main file.
 129   if (!SMgr.isInMainFile(CP->callEnterWithin.asLocation()))
 130     return CP;
 131
 132   const PathPieces &Path = CP->path;
 133   if (Path.empty())
 134     return nullptr;
 135
 136   // Check if the last piece in the callee path is a call to a function outside
 137   // of the main file.
 138   if (PathDiagnosticCallPiece *CPInner =
 139           dyn_cast<PathDiagnosticCallPiece>(Path.back().get())) {
 140     return getFirstStackedCallToHeaderFile(CPInner, SMgr);
 141   }
 142
 143   // Otherwise, the last piece is in the main file.
 144   return nullptr;
 145 }
 146
 147 void PathDiagnostic::resetDiagnosticLocationToMainFile() {
 148   if (path.empty())
 149     return;
 150
 151   PathDiagnosticPiece *LastP = path.back().get();
 152   assert(LastP);
 153   const SourceManager &SMgr = LastP->getLocation().getManager();
 154
 155   // We only need to check if the report ends inside headers, if the last piece
 156   // is a call piece.
 157   if (PathDiagnosticCallPiece *CP = dyn_cast<PathDiagnosticCallPiece>(LastP)) {
 158     CP = getFirstStackedCallToHeaderFile(CP, SMgr);
 159     if (CP) {
 160       // Mark the piece.
 161        CP->setAsLastInMainSourceFile();
 162
 163       // Update the path diagnostic message.
 164       const NamedDecl *ND = dyn_cast<NamedDecl>(CP->getCallee());
 165       if (ND) {
 166         SmallString<200> buf;
 167         llvm::raw_svector_ostream os(buf);
 168         os << " (within a call to '" << ND->getDeclName() << "')";
 169         appendToDesc(os.str());
 170       }
 171
 172       // Reset the report containing declaration and location.
 173       DeclWithIssue = CP->getCaller();
 174       Loc = CP->getLocation();
 175
 176       return;
 177     }
 178   }
 179 }
 180
 181 void PathDiagnosticConsumer::anchor() { }
 182
 183 PathDiagnosticConsumer::~PathDiagnosticConsumer() {
 184   // Delete the contents of the FoldingSet if it isn't empty already.
 185   for (llvm::FoldingSet<PathDiagnostic>::iterator it =
 186        Diags.begin(), et = Diags.end() ; it != et ; ++it) {
 187     delete &*it;
 188   }
 189 }
 190
 191 void PathDiagnosticConsumer::HandlePathDiagnostic(
 192     std::unique_ptr<PathDiagnostic> D) {
 193   if (!D || D->path.empty())
 194     return;
 195
 196   // We need to flatten the locations (convert Stmt* to locations) because
 197   // the referenced statements may be freed by the time the diagnostics
 198   // are emitted.
 199   D->flattenLocations();
 200
 201   // If the PathDiagnosticConsumer does not support diagnostics that
 202   // cross file boundaries, prune out such diagnostics now.
 203   if (!supportsCrossFileDiagnostics()) {
 204     // Verify that the entire path is from the same FileID.
 205     FileID FID;
 206     const SourceManager &SMgr = D->path.front()->getLocation().getManager();
 207     SmallVector<const PathPieces *, 5> WorkList;
 208     WorkList.push_back(&D->path);
 209     SmallString<128> buf;
 210     llvm::raw_svector_ostream warning(buf);
 211     warning << "warning: Path diagnostic report is not generated. Current "
 212             << "output format does not support diagnostics that cross file "
 213             << "boundaries. Refer to --analyzer-output for valid output "
 214             << "formats\n";
 215
 216     while (!WorkList.empty()) {
 217       const PathPieces &path = *WorkList.pop_back_val();
 218
 219       for (PathPieces::const_iterator I = path.begin(), E = path.end(); I != E;
 220            ++I) {
 221         const PathDiagnosticPiece *piece = I->get();
 222         FullSourceLoc L = piece->getLocation().asLocation().getExpansionLoc();
 223
 224         if (FID.isInvalid()) {
 225           FID = SMgr.getFileID(L);
 226         } else if (SMgr.getFileID(L) != FID) {
 227           llvm::errs() << warning.str();
 228           return;
 229         }
 230
 231         // Check the source ranges.
 232         ArrayRef<SourceRange> Ranges = piece->getRanges();
 233         for (ArrayRef<SourceRange>::iterator I = Ranges.begin(),
 234                                              E = Ranges.end(); I != E; ++I) {
 235           SourceLocation L = SMgr.getExpansionLoc(I->getBegin());
 236           if (!L.isFileID() || SMgr.getFileID(L) != FID) {
 237             llvm::errs() << warning.str();
 238             return;
 239           }
 240           L = SMgr.getExpansionLoc(I->getEnd());
 241           if (!L.isFileID() || SMgr.getFileID(L) != FID) {
 242             llvm::errs() << warning.str();
 243             return;
 244           }
 245         }
 246
 247         if (const PathDiagnosticCallPiece *call =
 248             dyn_cast<PathDiagnosticCallPiece>(piece)) {
 249           WorkList.push_back(&call->path);
 250         }
 251         else if (const PathDiagnosticMacroPiece *macro =
 252                  dyn_cast<PathDiagnosticMacroPiece>(piece)) {
 253           WorkList.push_back(&macro->subPieces);
 254         }
 255       }
 256     }
 257
 258     if (FID.isInvalid())
 259       return; // FIXME: Emit a warning?
 260   }
 261
 262   // Profile the node to see if we already have something matching it
 263   llvm::FoldingSetNodeID profile;
 264   D->Profile(profile);
 265   void *InsertPos = nullptr;
 266
 267   if (PathDiagnostic *orig = Diags.FindNodeOrInsertPos(profile, InsertPos)) {
 268     // Keep the PathDiagnostic with the shorter path.
 269     // Note, the enclosing routine is called in deterministic order, so the
 270     // results will be consistent between runs (no reason to break ties if the
 271     // size is the same).
 272     const unsigned orig_size = orig->full_size();
 273     const unsigned new_size = D->full_size();
 274     if (orig_size <= new_size)
 275       return;
 276
 277     assert(orig != D.get());
 278     Diags.RemoveNode(orig);
 279     delete orig;
 280   }
 281
 282   Diags.InsertNode(D.release());
 283 }
 284
 285 static Optional<bool> comparePath(const PathPieces &X, const PathPieces &Y);
 286
 287 static Optional<bool>
 288 compareControlFlow(const PathDiagnosticControlFlowPiece &X,
 289                    const PathDiagnosticControlFlowPiece &Y) {
 290   FullSourceLoc XSL = X.getStartLocation().asLocation();
 291   FullSourceLoc YSL = Y.getStartLocation().asLocation();
 292   if (XSL != YSL)
 293     return XSL.isBeforeInTranslationUnitThan(YSL);
 294   FullSourceLoc XEL = X.getEndLocation().asLocation();
 295   FullSourceLoc YEL = Y.getEndLocation().asLocation();
 296   if (XEL != YEL)
 297     return XEL.isBeforeInTranslationUnitThan(YEL);
 298   return None;
 299 }
 300
 301 static Optional<bool> compareMacro(const PathDiagnosticMacroPiece &X,
 302                                    const PathDiagnosticMacroPiece &Y) {
 303   return comparePath(X.subPieces, Y.subPieces);
 304 }
 305
 306 static Optional<bool> compareCall(const PathDiagnosticCallPiece &X,
 307                                   const PathDiagnosticCallPiece &Y) {
 308   FullSourceLoc X_CEL = X.callEnter.asLocation();
 309   FullSourceLoc Y_CEL = Y.callEnter.asLocation();
 310   if (X_CEL != Y_CEL)
 311     return X_CEL.isBeforeInTranslationUnitThan(Y_CEL);
 312   FullSourceLoc X_CEWL = X.callEnterWithin.asLocation();
 313   FullSourceLoc Y_CEWL = Y.callEnterWithin.asLocation();
 314   if (X_CEWL != Y_CEWL)
 315     return X_CEWL.isBeforeInTranslationUnitThan(Y_CEWL);
 316   FullSourceLoc X_CRL = X.callReturn.asLocation();
 317   FullSourceLoc Y_CRL = Y.callReturn.asLocation();
 318   if (X_CRL != Y_CRL)
 319     return X_CRL.isBeforeInTranslationUnitThan(Y_CRL);
 320   return comparePath(X.path, Y.path);
 321 }
 322
 323 static Optional<bool> comparePiece(const PathDiagnosticPiece &X,
 324                                    const PathDiagnosticPiece &Y) {
 325   if (X.getKind() != Y.getKind())
 326     return X.getKind() < Y.getKind();
 327
 328   FullSourceLoc XL = X.getLocation().asLocation();
 329   FullSourceLoc YL = Y.getLocation().asLocation();
 330   if (XL != YL)
 331     return XL.isBeforeInTranslationUnitThan(YL);
 332
 333   if (X.getString() != Y.getString())
 334     return X.getString() < Y.getString();
 335
 336   if (X.getRanges().size() != Y.getRanges().size())
 337     return X.getRanges().size() < Y.getRanges().size();
 338
 339   const SourceManager &SM = XL.getManager();
 340
 341   for (unsigned i = 0, n = X.getRanges().size(); i < n; ++i) {
 342     SourceRange XR = X.getRanges()[i];
 343     SourceRange YR = Y.getRanges()[i];
 344     if (XR != YR) {
 345       if (XR.getBegin() != YR.getBegin())
 346         return SM.isBeforeInTranslationUnit(XR.getBegin(), YR.getBegin());
 347       return SM.isBeforeInTranslationUnit(XR.getEnd(), YR.getEnd());
 348     }
 349   }
 350
 351   switch (X.getKind()) {
 352     case PathDiagnosticPiece::ControlFlow:
 353       return compareControlFlow(cast<PathDiagnosticControlFlowPiece>(X),
 354                                 cast<PathDiagnosticControlFlowPiece>(Y));
 355     case PathDiagnosticPiece::Event:
 356     case PathDiagnosticPiece::Note:
 357       return None;
 358     case PathDiagnosticPiece::Macro:
 359       return compareMacro(cast<PathDiagnosticMacroPiece>(X),
 360                           cast<PathDiagnosticMacroPiece>(Y));
 361     case PathDiagnosticPiece::Call:
 362       return compareCall(cast<PathDiagnosticCallPiece>(X),
 363                          cast<PathDiagnosticCallPiece>(Y));
 364   }
 365   llvm_unreachable("all cases handled");
 366 }
 367
 368 static Optional<bool> comparePath(const PathPieces &X, const PathPieces &Y) {
 369   if (X.size() != Y.size())
 370     return X.size() < Y.size();
 371
 372   PathPieces::const_iterator X_I = X.begin(), X_end = X.end();
 373   PathPieces::const_iterator Y_I = Y.begin(), Y_end = Y.end();
 374
 375   for ( ; X_I != X_end && Y_I != Y_end; ++X_I, ++Y_I) {
 376     Optional<bool> b = comparePiece(**X_I, **Y_I);
 377     if (b.hasValue())
 378       return b.getValue();
 379   }
 380
 381   return None;
 382 }
 383
 384 static bool compare(const PathDiagnostic &X, const PathDiagnostic &Y) {
 385   FullSourceLoc XL = X.getLocation().asLocation();
 386   FullSourceLoc YL = Y.getLocation().asLocation();
 387   if (XL != YL)
 388     return XL.isBeforeInTranslationUnitThan(YL);
 389   if (X.getBugType() != Y.getBugType())
 390     return X.getBugType() < Y.getBugType();
 391   if (X.getCategory() != Y.getCategory())
 392     return X.getCategory() < Y.getCategory();
 393   if (X.getVerboseDescription() != Y.getVerboseDescription())
 394     return X.getVerboseDescription() < Y.getVerboseDescription();
 395   if (X.getShortDescription() != Y.getShortDescription())
 396     return X.getShortDescription() < Y.getShortDescription();
 397   if (X.getDeclWithIssue() != Y.getDeclWithIssue()) {
 398     const Decl *XD = X.getDeclWithIssue();
 399     if (!XD)
 400       return true;
 401     const Decl *YD = Y.getDeclWithIssue();
 402     if (!YD)
 403       return false;
 404     SourceLocation XDL = XD->getLocation();
 405     SourceLocation YDL = YD->getLocation();
 406     if (XDL != YDL) {
 407       const SourceManager &SM = XL.getManager();
 408       return SM.isBeforeInTranslationUnit(XDL, YDL);
 409     }
 410   }
 411   PathDiagnostic::meta_iterator XI = X.meta_begin(), XE = X.meta_end();
 412   PathDiagnostic::meta_iterator YI = Y.meta_begin(), YE = Y.meta_end();
 413   if (XE - XI != YE - YI)
 414     return (XE - XI) < (YE - YI);
 415   for ( ; XI != XE ; ++XI, ++YI) {
 416     if (*XI != *YI)
 417       return (*XI) < (*YI);
 418   }
 419   Optional<bool> b = comparePath(X.path, Y.path);
 420   assert(b.hasValue());
 421   return b.getValue();
 422 }
 423
 424 void PathDiagnosticConsumer::FlushDiagnostics(
 425                                      PathDiagnosticConsumer::FilesMade *Files) {
 426   if (flushed)
 427     return;
 428
 429   flushed = true;
 430
 431   std::vector<const PathDiagnostic *> BatchDiags;
 432   for (llvm::FoldingSet<PathDiagnostic>::iterator it = Diags.begin(),
 433        et = Diags.end(); it != et; ++it) {
 434     const PathDiagnostic *D = &*it;
 435     BatchDiags.push_back(D);
 436   }
 437
 438   // Sort the diagnostics so that they are always emitted in a deterministic
 439   // order.
 440   int (*Comp)(const PathDiagnostic *const *, const PathDiagnostic *const *) =
 441       [](const PathDiagnostic *const *X, const PathDiagnostic *const *Y) {
 442         assert(*X != *Y && "PathDiagnostics not uniqued!");
 443         if (compare(**X, **Y))
 444           return -1;
 445         assert(compare(**Y, **X) && "Not a total order!");
 446         return 1;
 447       };
 448   array_pod_sort(BatchDiags.begin(), BatchDiags.end(), Comp);
 449
 450   FlushDiagnosticsImpl(BatchDiags, Files);
 451
 452   // Delete the flushed diagnostics.
 453   for (std::vector<const PathDiagnostic *>::iterator it = BatchDiags.begin(),
 454        et = BatchDiags.end(); it != et; ++it) {
 455     const PathDiagnostic *D = *it;
 456     delete D;
 457   }
 458
 459   // Clear out the FoldingSet.
 460   Diags.clear();
 461 }
 462
 463 PathDiagnosticConsumer::FilesMade::~FilesMade() {
 464   for (PDFileEntry &Entry : Set)
 465     Entry.~PDFileEntry();
 466 }
 467
 468 void PathDiagnosticConsumer::FilesMade::addDiagnostic(const PathDiagnostic &PD,
 469                                                       StringRef ConsumerName,
 470                                                       StringRef FileName) {
 471   llvm::FoldingSetNodeID NodeID;
 472   NodeID.Add(PD);
 473   void *InsertPos;
 474   PDFileEntry *Entry = Set.FindNodeOrInsertPos(NodeID, InsertPos);
 475   if (!Entry) {
 476     Entry = Alloc.Allocate<PDFileEntry>();
 477     Entry = new (Entry) PDFileEntry(NodeID);
 478     Set.InsertNode(Entry, InsertPos);
 479   }
 480
 481   // Allocate persistent storage for the file name.
 482   char *FileName_cstr = (char*) Alloc.Allocate(FileName.size(), 1);
 483   memcpy(FileName_cstr, FileName.data(), FileName.size());
 484
 485   Entry->files.push_back(std::make_pair(ConsumerName,
 486                                         StringRef(FileName_cstr,
 487                                                   FileName.size())));
 488 }
 489
 490 PathDiagnosticConsumer::PDFileEntry::ConsumerFiles *
 491 PathDiagnosticConsumer::FilesMade::getFiles(const PathDiagnostic &PD) {
 492   llvm::FoldingSetNodeID NodeID;
 493   NodeID.Add(PD);
 494   void *InsertPos;
 495   PDFileEntry *Entry = Set.FindNodeOrInsertPos(NodeID, InsertPos);
 496   if (!Entry)
 497     return nullptr;
 498   return &Entry->files;
 499 }
 500
 501 //===----------------------------------------------------------------------===//
 502 // PathDiagnosticLocation methods.
 503 //===----------------------------------------------------------------------===//
 504
 505 static SourceLocation getValidSourceLocation(const Stmt* S,
 506                                              LocationOrAnalysisDeclContext LAC,
 507                                              bool UseEnd = false) {
 508   SourceLocation L = UseEnd ? S->getLocEnd() : S->getLocStart();
 509   assert(!LAC.isNull() && "A valid LocationContext or AnalysisDeclContext should "
 510                           "be passed to PathDiagnosticLocation upon creation.");
 511
 512   // S might be a temporary statement that does not have a location in the
 513   // source code, so find an enclosing statement and use its location.
 514   if (!L.isValid()) {
 515     AnalysisDeclContext *ADC;
 516     if (LAC.is<const LocationContext*>())
 517       ADC = LAC.get<const LocationContext*>()->getAnalysisDeclContext();
 518     else
 519       ADC = LAC.get<AnalysisDeclContext*>();
 520
 521     ParentMap &PM = ADC->getParentMap();
 522
 523     const Stmt *Parent = S;
 524     do {
 525       Parent = PM.getParent(Parent);
 526
 527       // In rare cases, we have implicit top-level expressions,
 528       // such as arguments for implicit member initializers.
 529       // In this case, fall back to the start of the body (even if we were
 530       // asked for the statement end location).
 531       if (!Parent) {
 532         const Stmt *Body = ADC->getBody();
 533         if (Body)
 534           L = Body->getLocStart();
 535         else
 536           L = ADC->getDecl()->getLocEnd();
 537         break;
 538       }
 539
 540       L = UseEnd ? Parent->getLocEnd() : Parent->getLocStart();
 541     } while (!L.isValid());
 542   }
 543
 544   return L;
 545 }
 546
 547 static PathDiagnosticLocation
 548 getLocationForCaller(const StackFrameContext *SFC,
 549                      const LocationContext *CallerCtx,
 550                      const SourceManager &SM) {
 551   const CFGBlock &Block = *SFC->getCallSiteBlock();
 552   CFGElement Source = Block[SFC->getIndex()];
 553
 554   switch (Source.getKind()) {
 555   case CFGElement::Statement:
 556     return PathDiagnosticLocation(Source.castAs<CFGStmt>().getStmt(),
 557                                   SM, CallerCtx);
 558   case CFGElement::Initializer: {
 559     const CFGInitializer &Init = Source.castAs<CFGInitializer>();
 560     return PathDiagnosticLocation(Init.getInitializer()->getInit(),
 561                                   SM, CallerCtx);
 562   }
 563   case CFGElement::AutomaticObjectDtor: {
 564     const CFGAutomaticObjDtor &Dtor = Source.castAs<CFGAutomaticObjDtor>();
 565     return PathDiagnosticLocation::createEnd(Dtor.getTriggerStmt(),
 566                                              SM, CallerCtx);
 567   }
 568   case CFGElement::DeleteDtor: {
 569     const CFGDeleteDtor &Dtor = Source.castAs<CFGDeleteDtor>();
 570     return PathDiagnosticLocation(Dtor.getDeleteExpr(), SM, CallerCtx);
 571   }
 572   case CFGElement::BaseDtor:
 573   case CFGElement::MemberDtor: {
 574     const AnalysisDeclContext *CallerInfo = CallerCtx->getAnalysisDeclContext();
 575     if (const Stmt *CallerBody = CallerInfo->getBody())
 576       return PathDiagnosticLocation::createEnd(CallerBody, SM, CallerCtx);
 577     return PathDiagnosticLocation::create(CallerInfo->getDecl(), SM);
 578   }
 579   case CFGElement::TemporaryDtor:
 580   case CFGElement::NewAllocator:
 581     llvm_unreachable("not yet implemented!");
 582   }
 583
 584   llvm_unreachable("Unknown CFGElement kind");
 585 }
 586
 587 PathDiagnosticLocation
 588 PathDiagnosticLocation::createBegin(const Decl *D,
 589                                     const SourceManager &SM) {
 590   return PathDiagnosticLocation(D->getLocStart(), SM, SingleLocK);
 591 }
 592
 593 PathDiagnosticLocation
 594 PathDiagnosticLocation::createBegin(const Stmt *S,
 595                                     const SourceManager &SM,
 596                                     LocationOrAnalysisDeclContext LAC) {
 597   return PathDiagnosticLocation(getValidSourceLocation(S, LAC),
 598                                 SM, SingleLocK);
 599 }
 600
 601 PathDiagnosticLocation
 602 PathDiagnosticLocation::createEnd(const Stmt *S,
 603                                   const SourceManager &SM,
 604                                   LocationOrAnalysisDeclContext LAC) {
 605   if (const CompoundStmt *CS = dyn_cast<CompoundStmt>(S))
 606     return createEndBrace(CS, SM);
 607   return PathDiagnosticLocation(getValidSourceLocation(S, LAC, /*End=*/true),
 608                                 SM, SingleLocK);
 609 }
 610
 611 PathDiagnosticLocation
 612 PathDiagnosticLocation::createOperatorLoc(const BinaryOperator *BO,
 613                                           const SourceManager &SM) {
 614   return PathDiagnosticLocation(BO->getOperatorLoc(), SM, SingleLocK);
 615 }
 616
 617 PathDiagnosticLocation
 618 PathDiagnosticLocation::createConditionalColonLoc(
 619                                             const ConditionalOperator *CO,
 620                                             const SourceManager &SM) {
 621   return PathDiagnosticLocation(CO->getColonLoc(), SM, SingleLocK);
 622 }
 623
 624
 625 PathDiagnosticLocation
 626 PathDiagnosticLocation::createMemberLoc(const MemberExpr *ME,
 627                                         const SourceManager &SM) {
 628   return PathDiagnosticLocation(ME->getMemberLoc(), SM, SingleLocK);
 629 }
 630
 631 PathDiagnosticLocation
 632 PathDiagnosticLocation::createBeginBrace(const CompoundStmt *CS,
 633                                          const SourceManager &SM) {
 634   SourceLocation L = CS->getLBracLoc();
 635   return PathDiagnosticLocation(L, SM, SingleLocK);
 636 }
 637
 638 PathDiagnosticLocation
 639 PathDiagnosticLocation::createEndBrace(const CompoundStmt *CS,
 640                                        const SourceManager &SM) {
 641   SourceLocation L = CS->getRBracLoc();
 642   return PathDiagnosticLocation(L, SM, SingleLocK);
 643 }
 644
 645 PathDiagnosticLocation
 646 PathDiagnosticLocation::createDeclBegin(const LocationContext *LC,
 647                                         const SourceManager &SM) {
 648   // FIXME: Should handle CXXTryStmt if analyser starts supporting C++.
 649   if (const CompoundStmt *CS =
 650         dyn_cast_or_null<CompoundStmt>(LC->getDecl()->getBody()))
 651     if (!CS->body_empty()) {
 652       SourceLocation Loc = (*CS->body_begin())->getLocStart();
 653       return PathDiagnosticLocation(Loc, SM, SingleLocK);
 654     }
 655
 656   return PathDiagnosticLocation();
 657 }
 658
 659 PathDiagnosticLocation
 660 PathDiagnosticLocation::createDeclEnd(const LocationContext *LC,
 661                                       const SourceManager &SM) {
 662   SourceLocation L = LC->getDecl()->getBodyRBrace();
 663   return PathDiagnosticLocation(L, SM, SingleLocK);
 664 }
 665
 666 PathDiagnosticLocation
 667 PathDiagnosticLocation::create(const ProgramPoint& P,
 668                                const SourceManager &SMng) {
 669   const Stmt* S = nullptr;
 670   if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) {
 671     const CFGBlock *BSrc = BE->getSrc();
 672     S = BSrc->getTerminatorCondition();
 673   } else if (Optional<StmtPoint> SP = P.getAs<StmtPoint>()) {
 674     S = SP->getStmt();
 675     if (P.getAs<PostStmtPurgeDeadSymbols>())
 676       return PathDiagnosticLocation::createEnd(S, SMng, P.getLocationContext());
 677   } else if (Optional<PostInitializer> PIP = P.getAs<PostInitializer>()) {
 678     return PathDiagnosticLocation(PIP->getInitializer()->getSourceLocation(),
 679                                   SMng);
 680   } else if (Optional<PostImplicitCall> PIE = P.getAs<PostImplicitCall>()) {
 681     return PathDiagnosticLocation(PIE->getLocation(), SMng);
 682   } else if (Optional<CallEnter> CE = P.getAs<CallEnter>()) {
 683     return getLocationForCaller(CE->getCalleeContext(),
 684                                 CE->getLocationContext(),
 685                                 SMng);
 686   } else if (Optional<CallExitEnd> CEE = P.getAs<CallExitEnd>()) {
 687     return getLocationForCaller(CEE->getCalleeContext(),
 688                                 CEE->getLocationContext(),
 689                                 SMng);
 690   } else {
 691     llvm_unreachable("Unexpected ProgramPoint");
 692   }
 693
 694   return PathDiagnosticLocation(S, SMng, P.getLocationContext());
 695 }
 696
 697 const Stmt *PathDiagnosticLocation::getStmt(const ExplodedNode *N) {
 698   ProgramPoint P = N->getLocation();
 699   if (Optional<StmtPoint> SP = P.getAs<StmtPoint>())
 700     return SP->getStmt();
 701   if (Optional<BlockEdge> BE = P.getAs<BlockEdge>())
 702     return BE->getSrc()->getTerminator();
 703   if (Optional<CallEnter> CE = P.getAs<CallEnter>())
 704     return CE->getCallExpr();
 705   if (Optional<CallExitEnd> CEE = P.getAs<CallExitEnd>())
 706     return CEE->getCalleeContext()->getCallSite();
 707   if (Optional<PostInitializer> PIPP = P.getAs<PostInitializer>())
 708     return PIPP->getInitializer()->getInit();
 709
 710   return nullptr;
 711 }
 712
 713 const Stmt *PathDiagnosticLocation::getNextStmt(const ExplodedNode *N) {
 714   for (N = N->getFirstSucc(); N; N = N->getFirstSucc()) {
 715     if (const Stmt *S = getStmt(N)) {
 716       // Check if the statement is '?' or '&&'/'||'.  These are "merges",
 717       // not actual statement points.
 718       switch (S->getStmtClass()) {
 719         case Stmt::ChooseExprClass:
 720         case Stmt::BinaryConditionalOperatorClass:
 721         case Stmt::ConditionalOperatorClass:
 722           continue;
 723         case Stmt::BinaryOperatorClass: {
 724           BinaryOperatorKind Op = cast<BinaryOperator>(S)->getOpcode();
 725           if (Op == BO_LAnd || Op == BO_LOr)
 726             continue;
 727           break;
 728         }
 729         default:
 730           break;
 731       }
 732       // We found the statement, so return it.
 733       return S;
 734     }
 735   }
 736
 737   return nullptr;
 738 }
 739
 740 PathDiagnosticLocation
 741   PathDiagnosticLocation::createEndOfPath(const ExplodedNode *N,
 742                                           const SourceManager &SM) {
 743   assert(N && "Cannot create a location with a null node.");
 744   const Stmt *S = getStmt(N);
 745
 746   if (!S) {
 747     // If this is an implicit call, return the implicit call point location.
 748     if (Optional<PreImplicitCall> PIE = N->getLocationAs<PreImplicitCall>())
 749       return PathDiagnosticLocation(PIE->getLocation(), SM);
 750     S = getNextStmt(N);
 751   }
 752
 753   if (S) {
 754     ProgramPoint P = N->getLocation();
 755     const LocationContext *LC = N->getLocationContext();
 756
 757     // For member expressions, return the location of the '.' or '->'.
 758     if (const MemberExpr *ME = dyn_cast<MemberExpr>(S))
 759       return PathDiagnosticLocation::createMemberLoc(ME, SM);
 760
 761     // For binary operators, return the location of the operator.
 762     if (const BinaryOperator *B = dyn_cast<BinaryOperator>(S))
 763       return PathDiagnosticLocation::createOperatorLoc(B, SM);
 764
 765     if (P.getAs<PostStmtPurgeDeadSymbols>())
 766       return PathDiagnosticLocation::createEnd(S, SM, LC);
 767
 768     if (S->getLocStart().isValid())
 769       return PathDiagnosticLocation(S, SM, LC);
 770     return PathDiagnosticLocation(getValidSourceLocation(S, LC), SM);
 771   }
 772
 773   return createDeclEnd(N->getLocationContext(), SM);
 774 }
 775
 776 PathDiagnosticLocation PathDiagnosticLocation::createSingleLocation(
 777                                            const PathDiagnosticLocation &PDL) {
 778   FullSourceLoc L = PDL.asLocation();
 779   return PathDiagnosticLocation(L, L.getManager(), SingleLocK);
 780 }
 781
 782 FullSourceLoc
 783   PathDiagnosticLocation::genLocation(SourceLocation L,
 784                                       LocationOrAnalysisDeclContext LAC) const {
 785   assert(isValid());
 786   // Note that we want a 'switch' here so that the compiler can warn us in
 787   // case we add more cases.
 788   switch (K) {
 789     case SingleLocK:
 790     case RangeK:
 791       break;
 792     case StmtK:
 793       // Defensive checking.
 794       if (!S)
 795         break;
 796       return FullSourceLoc(getValidSourceLocation(S, LAC),
 797                            const_cast<SourceManager&>(*SM));
 798     case DeclK:
 799       // Defensive checking.
 800       if (!D)
 801         break;
 802       return FullSourceLoc(D->getLocation(), const_cast<SourceManager&>(*SM));
 803   }
 804
 805   return FullSourceLoc(L, const_cast<SourceManager&>(*SM));
 806 }
 807
 808 PathDiagnosticRange
 809   PathDiagnosticLocation::genRange(LocationOrAnalysisDeclContext LAC) const {
 810   assert(isValid());
 811   // Note that we want a 'switch' here so that the compiler can warn us in
 812   // case we add more cases.
 813   switch (K) {
 814     case SingleLocK:
 815       return PathDiagnosticRange(SourceRange(Loc,Loc), true);
 816     case RangeK:
 817       break;
 818     case StmtK: {
 819       const Stmt *S = asStmt();
 820       switch (S->getStmtClass()) {
 821         default:
 822           break;
 823         case Stmt::DeclStmtClass: {
 824           const DeclStmt *DS = cast<DeclStmt>(S);
 825           if (DS->isSingleDecl()) {
 826             // Should always be the case, but we'll be defensive.
 827             return SourceRange(DS->getLocStart(),
 828                                DS->getSingleDecl()->getLocation());
 829           }
 830           break;
 831         }
 832           // FIXME: Provide better range information for different
 833           //  terminators.
 834         case Stmt::IfStmtClass:
 835         case Stmt::WhileStmtClass:
 836         case Stmt::DoStmtClass:
 837         case Stmt::ForStmtClass:
 838         case Stmt::ChooseExprClass:
 839         case Stmt::IndirectGotoStmtClass:
 840         case Stmt::SwitchStmtClass:
 841         case Stmt::BinaryConditionalOperatorClass:
 842         case Stmt::ConditionalOperatorClass:
 843         case Stmt::ObjCForCollectionStmtClass: {
 844           SourceLocation L = getValidSourceLocation(S, LAC);
 845           return SourceRange(L, L);
 846         }
 847       }
 848       SourceRange R = S->getSourceRange();
 849       if (R.isValid())
 850         return R;
 851       break;
 852     }
 853     case DeclK:
 854       if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
 855         return MD->getSourceRange();
 856       if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
 857         if (Stmt *Body = FD->getBody())
 858           return Body->getSourceRange();
 859       }
 860       else {
 861         SourceLocation L = D->getLocation();
 862         return PathDiagnosticRange(SourceRange(L, L), true);
 863       }
 864   }
 865
 866   return SourceRange(Loc,Loc);
 867 }
 868
 869 void PathDiagnosticLocation::flatten() {
 870   if (K == StmtK) {
 871     K = RangeK;
 872     S = nullptr;
 873     D = nullptr;
 874   }
 875   else if (K == DeclK) {
 876     K = SingleLocK;
 877     S = nullptr;
 878     D = nullptr;
 879   }
 880 }
 881
 882 //===----------------------------------------------------------------------===//
 883 // Manipulation of PathDiagnosticCallPieces.
 884 //===----------------------------------------------------------------------===//
 885
 886 std::shared_ptr<PathDiagnosticCallPiece>
 887 PathDiagnosticCallPiece::construct(const ExplodedNode *N, const CallExitEnd &CE,
 888                                    const SourceManager &SM) {
 889   const Decl *caller = CE.getLocationContext()->getDecl();
 890   PathDiagnosticLocation pos = getLocationForCaller(CE.getCalleeContext(),
 891                                                     CE.getLocationContext(),
 892                                                     SM);
 893   return std::shared_ptr<PathDiagnosticCallPiece>(
 894       new PathDiagnosticCallPiece(caller, pos));
 895 }
 896
 897 PathDiagnosticCallPiece *
 898 PathDiagnosticCallPiece::construct(PathPieces &path,
 899                                    const Decl *caller) {
 900   std::shared_ptr<PathDiagnosticCallPiece> C(
 901       new PathDiagnosticCallPiece(path, caller));
 902   path.clear();
 903   auto *R = C.get();
 904   path.push_front(std::move(C));
 905   return R;
 906 }
 907
 908 void PathDiagnosticCallPiece::setCallee(const CallEnter &CE,
 909                                         const SourceManager &SM) {
 910   const StackFrameContext *CalleeCtx = CE.getCalleeContext();
 911   Callee = CalleeCtx->getDecl();
 912
 913   callEnterWithin = PathDiagnosticLocation::createBegin(Callee, SM);
 914   callEnter = getLocationForCaller(CalleeCtx, CE.getLocationContext(), SM);
 915 }
 916
 917 static inline void describeClass(raw_ostream &Out, const CXXRecordDecl *D,
 918                                  StringRef Prefix = StringRef()) {
 919   if (!D->getIdentifier())
 920     return;
 921   Out << Prefix << '\'' << *D << '\'';
 922 }
 923
 924 static bool describeCodeDecl(raw_ostream &Out, const Decl *D,
 925                              bool ExtendedDescription,
 926                              StringRef Prefix = StringRef()) {
 927   if (!D)
 928     return false;
 929
 930   if (isa<BlockDecl>(D)) {
 931     if (ExtendedDescription)
 932       Out << Prefix << "anonymous block";
 933     return ExtendedDescription;
 934   }
 935
 936   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(D)) {
 937     Out << Prefix;
 938     if (ExtendedDescription && !MD->isUserProvided()) {
 939       if (MD->isExplicitlyDefaulted())
 940         Out << "defaulted ";
 941       else
 942         Out << "implicit ";
 943     }
 944
 945     if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(MD)) {
 946       if (CD->isDefaultConstructor())
 947         Out << "default ";
 948       else if (CD->isCopyConstructor())
 949         Out << "copy ";
 950       else if (CD->isMoveConstructor())
 951         Out << "move ";
 952
 953       Out << "constructor";
 954       describeClass(Out, MD->getParent(), " for ");
 955
 956     } else if (isa<CXXDestructorDecl>(MD)) {
 957       if (!MD->isUserProvided()) {
 958         Out << "destructor";
 959         describeClass(Out, MD->getParent(), " for ");
 960       } else {
 961         // Use ~Foo for explicitly-written destructors.
 962         Out << "'" << *MD << "'";
 963       }
 964
 965     } else if (MD->isCopyAssignmentOperator()) {
 966         Out << "copy assignment operator";
 967         describeClass(Out, MD->getParent(), " for ");
 968
 969     } else if (MD->isMoveAssignmentOperator()) {
 970         Out << "move assignment operator";
 971         describeClass(Out, MD->getParent(), " for ");
 972
 973     } else {
 974       if (MD->getParent()->getIdentifier())
 975         Out << "'" << *MD->getParent() << "::" << *MD << "'";
 976       else
 977         Out << "'" << *MD << "'";
 978     }
 979
 980     return true;
 981   }
 982
 983   Out << Prefix << '\'' << cast<NamedDecl>(*D) << '\'';
 984   return true;
 985 }
 986
 987 std::shared_ptr<PathDiagnosticEventPiece>
 988 PathDiagnosticCallPiece::getCallEnterEvent() const {
 989   if (!Callee)
 990     return nullptr;
 991
 992   SmallString<256> buf;
 993   llvm::raw_svector_ostream Out(buf);
 994
 995   Out << "Calling ";
 996   describeCodeDecl(Out, Callee, /*ExtendedDescription=*/true);
 997
 998   assert(callEnter.asLocation().isValid());
 999   return std::make_shared<PathDiagnosticEventPiece>(callEnter, Out.str());
1000 }
1001
1002 std::shared_ptr<PathDiagnosticEventPiece>
1003 PathDiagnosticCallPiece::getCallEnterWithinCallerEvent() const {
1004   if (!callEnterWithin.asLocation().isValid())
1005     return nullptr;
1006   if (Callee->isImplicit() || !Callee->hasBody())
1007     return nullptr;
1008   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Callee))
1009     if (MD->isDefaulted())
1010       return nullptr;
1011
1012   SmallString<256> buf;
1013   llvm::raw_svector_ostream Out(buf);
1014
1015   Out << "Entered call";
1016   describeCodeDecl(Out, Caller, /*ExtendedDescription=*/false, " from ");
1017
1018   return std::make_shared<PathDiagnosticEventPiece>(callEnterWithin, Out.str());
1019 }
1020
1021 std::shared_ptr<PathDiagnosticEventPiece>
1022 PathDiagnosticCallPiece::getCallExitEvent() const {
1023   if (NoExit)
1024     return nullptr;
1025
1026   SmallString<256> buf;
1027   llvm::raw_svector_ostream Out(buf);
1028
1029   if (!CallStackMessage.empty()) {
1030     Out << CallStackMessage;
1031   } else {
1032     bool DidDescribe = describeCodeDecl(Out, Callee,
1033                                         /*ExtendedDescription=*/false,
1034                                         "Returning from ");
1035     if (!DidDescribe)
1036       Out << "Returning to caller";
1037   }
1038
1039   assert(callReturn.asLocation().isValid());
1040   return std::make_shared<PathDiagnosticEventPiece>(callReturn, Out.str());
1041 }
1042
1043 static void compute_path_size(const PathPieces &pieces, unsigned &size) {
1044   for (PathPieces::const_iterator it = pieces.begin(),
1045                                   et = pieces.end(); it != et; ++it) {
1046     const PathDiagnosticPiece *piece = it->get();
1047     if (const PathDiagnosticCallPiece *cp =
1048         dyn_cast<PathDiagnosticCallPiece>(piece)) {
1049       compute_path_size(cp->path, size);
1050     }
1051     else
1052       ++size;
1053   }
1054 }
1055
1056 unsigned PathDiagnostic::full_size() {
1057   unsigned size = 0;
1058   compute_path_size(path, size);
1059   return size;
1060 }
1061
1062 //===----------------------------------------------------------------------===//
1063 // FoldingSet profiling methods.
1064 //===----------------------------------------------------------------------===//
1065
1066 void PathDiagnosticLocation::Profile(llvm::FoldingSetNodeID &ID) const {
1067   ID.AddInteger(Range.getBegin().getRawEncoding());
1068   ID.AddInteger(Range.getEnd().getRawEncoding());
1069   ID.AddInteger(Loc.getRawEncoding());
1070 }
1071
1072 void PathDiagnosticPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1073   ID.AddInteger((unsigned) getKind());
1074   ID.AddString(str);
1075   // FIXME: Add profiling support for code hints.
1076   ID.AddInteger((unsigned) getDisplayHint());
1077   ArrayRef<SourceRange> Ranges = getRanges();
1078   for (ArrayRef<SourceRange>::iterator I = Ranges.begin(), E = Ranges.end();
1079                                         I != E; ++I) {
1080     ID.AddInteger(I->getBegin().getRawEncoding());
1081     ID.AddInteger(I->getEnd().getRawEncoding());
1082   }
1083 }
1084
1085 void PathDiagnosticCallPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1086   PathDiagnosticPiece::Profile(ID);
1087   for (PathPieces::const_iterator it = path.begin(),
1088        et = path.end(); it != et; ++it) {
1089     ID.Add(**it);
1090   }
1091 }
1092
1093 void PathDiagnosticSpotPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1094   PathDiagnosticPiece::Profile(ID);
1095   ID.Add(Pos);
1096 }
1097
1098 void PathDiagnosticControlFlowPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1099   PathDiagnosticPiece::Profile(ID);
1100   for (const_iterator I = begin(), E = end(); I != E; ++I)
1101     ID.Add(*I);
1102 }
1103
1104 void PathDiagnosticMacroPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1105   PathDiagnosticSpotPiece::Profile(ID);
1106   for (PathPieces::const_iterator I = subPieces.begin(), E = subPieces.end();
1107        I != E; ++I)
1108     ID.Add(**I);
1109 }
1110
1111 void PathDiagnosticNotePiece::Profile(llvm::FoldingSetNodeID &ID) const {
1112   PathDiagnosticSpotPiece::Profile(ID);
1113 }
1114
1115 void PathDiagnostic::Profile(llvm::FoldingSetNodeID &ID) const {
1116   ID.Add(getLocation());
1117   ID.AddString(BugType);
1118   ID.AddString(VerboseDesc);
1119   ID.AddString(Category);
1120 }
1121
1122 void PathDiagnostic::FullProfile(llvm::FoldingSetNodeID &ID) const {
1123   Profile(ID);
1124   for (PathPieces::const_iterator I = path.begin(), E = path.end(); I != E; ++I)
1125     ID.Add(**I);
1126   for (meta_iterator I = meta_begin(), E = meta_end(); I != E; ++I)
1127     ID.AddString(*I);
1128 }
1129
1130 StackHintGenerator::~StackHintGenerator() {}
1131
1132 std::string StackHintGeneratorForSymbol::getMessage(const ExplodedNode *N){
1133   ProgramPoint P = N->getLocation();
1134   CallExitEnd CExit = P.castAs<CallExitEnd>();
1135
1136   // FIXME: Use CallEvent to abstract this over all calls.
1137   const Stmt *CallSite = CExit.getCalleeContext()->getCallSite();
1138   const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite);
1139   if (!CE)
1140     return "";
1141
1142   if (!N)
1143     return getMessageForSymbolNotFound();
1144
1145   // Check if one of the parameters are set to the interesting symbol.
1146   ProgramStateRef State = N->getState();
1147   const LocationContext *LCtx = N->getLocationContext();
1148   unsigned ArgIndex = 0;
1149   for (CallExpr::const_arg_iterator I = CE->arg_begin(),
1150                                     E = CE->arg_end(); I != E; ++I, ++ArgIndex){
1151     SVal SV = State->getSVal(*I, LCtx);
1152
1153     // Check if the variable corresponding to the symbol is passed by value.
1154     SymbolRef AS = SV.getAsLocSymbol();
1155     if (AS == Sym) {
1156       return getMessageForArg(*I, ArgIndex);
1157     }
1158
1159     // Check if the parameter is a pointer to the symbol.
1160     if (Optional<loc::MemRegionVal> Reg = SV.getAs<loc::MemRegionVal>()) {
1161       SVal PSV = State->getSVal(Reg->getRegion());
1162       SymbolRef AS = PSV.getAsLocSymbol();
1163       if (AS == Sym) {
1164         return getMessageForArg(*I, ArgIndex);
1165       }
1166     }
1167   }
1168
1169   // Check if we are returning the interesting symbol.
1170   SVal SV = State->getSVal(CE, LCtx);
1171   SymbolRef RetSym = SV.getAsLocSymbol();
1172   if (RetSym == Sym) {
1173     return getMessageForReturn(CE);
1174   }
1175
1176   return getMessageForSymbolNotFound();
1177 }
1178
1179 std::string StackHintGeneratorForSymbol::getMessageForArg(const Expr *ArgE,
1180                                                           unsigned ArgIndex) {
1181   // Printed parameters start at 1, not 0.
1182   ++ArgIndex;
1183
1184   SmallString<200> buf;
1185   llvm::raw_svector_ostream os(buf);
1186
1187   os << Msg << " via " << ArgIndex << llvm::getOrdinalSuffix(ArgIndex)
1188      << " parameter";
1189
1190   return os.str();
1191 }