clang 18.0.0git
PathDiagnostic.cpp
Go to the documentation of this file.
1//===- PathDiagnostic.cpp - Path-Specific Diagnostic Handling -------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the PathDiagnostic-related interfaces.
10//
11//===----------------------------------------------------------------------===//
12
14#include "clang/AST/Decl.h"
15#include "clang/AST/DeclBase.h"
16#include "clang/AST/DeclCXX.h"
17#include "clang/AST/DeclObjC.h"
19#include "clang/AST/Expr.h"
20#include "clang/AST/ExprCXX.h"
22#include "clang/AST/ParentMap.h"
24#include "clang/AST/Stmt.h"
25#include "clang/AST/Type.h"
27#include "clang/Analysis/CFG.h"
30#include "clang/Basic/LLVM.h"
33#include "llvm/ADT/ArrayRef.h"
34#include "llvm/ADT/FoldingSet.h"
35#include "llvm/ADT/STLExtras.h"
36#include "llvm/ADT/SmallString.h"
37#include "llvm/ADT/SmallVector.h"
38#include "llvm/ADT/StringExtras.h"
39#include "llvm/ADT/StringRef.h"
40#include "llvm/Support/Casting.h"
41#include "llvm/Support/ErrorHandling.h"
42#include "llvm/Support/raw_ostream.h"
43#include <cassert>
44#include <cstring>
45#include <memory>
46#include <optional>
47#include <utility>
48#include <vector>
49
50using namespace clang;
51using namespace ento;
52
53static StringRef StripTrailingDots(StringRef s) {
54 for (StringRef::size_type i = s.size(); i != 0; --i)
55 if (s[i - 1] != '.')
56 return s.substr(0, i);
57 return {};
58}
59
61 Kind k, DisplayHint hint)
62 : str(StripTrailingDots(s)), kind(k), Hint(hint) {}
63
65 : kind(k), Hint(hint) {}
66
68
70
72
74
76
78
80
81void PathPieces::flattenTo(PathPieces &Primary, PathPieces &Current,
82 bool ShouldFlattenMacros) const {
83 for (auto &Piece : *this) {
84 switch (Piece->getKind()) {
86 auto &Call = cast<PathDiagnosticCallPiece>(*Piece);
87 if (auto CallEnter = Call.getCallEnterEvent())
88 Current.push_back(std::move(CallEnter));
89 Call.path.flattenTo(Primary, Primary, ShouldFlattenMacros);
90 if (auto callExit = Call.getCallExitEvent())
91 Current.push_back(std::move(callExit));
92 break;
93 }
95 auto &Macro = cast<PathDiagnosticMacroPiece>(*Piece);
96 if (ShouldFlattenMacros) {
97 Macro.subPieces.flattenTo(Primary, Primary, ShouldFlattenMacros);
98 } else {
99 Current.push_back(Piece);
100 PathPieces NewPath;
101 Macro.subPieces.flattenTo(Primary, NewPath, ShouldFlattenMacros);
102 // FIXME: This probably shouldn't mutate the original path piece.
103 Macro.subPieces = NewPath;
104 }
105 break;
106 }
111 Current.push_back(Piece);
112 break;
113 }
114 }
115}
116
118
120 StringRef CheckerName, const Decl *declWithIssue, StringRef bugtype,
121 StringRef verboseDesc, StringRef shortDesc, StringRef category,
122 PathDiagnosticLocation LocationToUnique, const Decl *DeclToUnique,
123 std::unique_ptr<FilesToLineNumsMap> ExecutedLines)
124 : CheckerName(CheckerName), DeclWithIssue(declWithIssue),
125 BugType(StripTrailingDots(bugtype)),
126 VerboseDesc(StripTrailingDots(verboseDesc)),
127 ShortDesc(StripTrailingDots(shortDesc)),
128 Category(StripTrailingDots(category)), UniqueingLoc(LocationToUnique),
129 UniqueingDecl(DeclToUnique), ExecutedLines(std::move(ExecutedLines)),
130 path(pathImpl) {}
131
132void PathDiagnosticConsumer::anchor() {}
133
135 // Delete the contents of the FoldingSet if it isn't empty already.
136 for (auto &Diag : Diags)
137 delete &Diag;
138}
139
141 std::unique_ptr<PathDiagnostic> D) {
142 if (!D || D->path.empty())
143 return;
144
145 // We need to flatten the locations (convert Stmt* to locations) because
146 // the referenced statements may be freed by the time the diagnostics
147 // are emitted.
148 D->flattenLocations();
149
150 // If the PathDiagnosticConsumer does not support diagnostics that
151 // cross file boundaries, prune out such diagnostics now.
153 // Verify that the entire path is from the same FileID.
154 FileID FID;
155 const SourceManager &SMgr = D->path.front()->getLocation().getManager();
157 WorkList.push_back(&D->path);
159 llvm::raw_svector_ostream warning(buf);
160 warning << "warning: Path diagnostic report is not generated. Current "
161 << "output format does not support diagnostics that cross file "
162 << "boundaries. Refer to --analyzer-output for valid output "
163 << "formats\n";
164
165 while (!WorkList.empty()) {
166 const PathPieces &path = *WorkList.pop_back_val();
167
168 for (const auto &I : path) {
169 const PathDiagnosticPiece *piece = I.get();
171
172 if (FID.isInvalid()) {
173 FID = SMgr.getFileID(L);
174 } else if (SMgr.getFileID(L) != FID) {
175 llvm::errs() << warning.str();
176 return;
177 }
178
179 // Check the source ranges.
180 ArrayRef<SourceRange> Ranges = piece->getRanges();
181 for (const auto &I : Ranges) {
182 SourceLocation L = SMgr.getExpansionLoc(I.getBegin());
183 if (!L.isFileID() || SMgr.getFileID(L) != FID) {
184 llvm::errs() << warning.str();
185 return;
186 }
187 L = SMgr.getExpansionLoc(I.getEnd());
188 if (!L.isFileID() || SMgr.getFileID(L) != FID) {
189 llvm::errs() << warning.str();
190 return;
191 }
192 }
193
194 if (const auto *call = dyn_cast<PathDiagnosticCallPiece>(piece))
195 WorkList.push_back(&call->path);
196 else if (const auto *macro = dyn_cast<PathDiagnosticMacroPiece>(piece))
197 WorkList.push_back(&macro->subPieces);
198 }
199 }
200
201 if (FID.isInvalid())
202 return; // FIXME: Emit a warning?
203 }
204
205 // Profile the node to see if we already have something matching it
206 llvm::FoldingSetNodeID profile;
207 D->Profile(profile);
208 void *InsertPos = nullptr;
209
210 if (PathDiagnostic *orig = Diags.FindNodeOrInsertPos(profile, InsertPos)) {
211 // Keep the PathDiagnostic with the shorter path.
212 // Note, the enclosing routine is called in deterministic order, so the
213 // results will be consistent between runs (no reason to break ties if the
214 // size is the same).
215 const unsigned orig_size = orig->full_size();
216 const unsigned new_size = D->full_size();
217 if (orig_size <= new_size)
218 return;
219
220 assert(orig != D.get());
221 Diags.RemoveNode(orig);
222 delete orig;
223 }
224
225 Diags.InsertNode(D.release());
226}
227
228static std::optional<bool> comparePath(const PathPieces &X,
229 const PathPieces &Y);
230
231static std::optional<bool>
234 FullSourceLoc XSL = X.getStartLocation().asLocation();
236 if (XSL != YSL)
237 return XSL.isBeforeInTranslationUnitThan(YSL);
238 FullSourceLoc XEL = X.getEndLocation().asLocation();
240 if (XEL != YEL)
241 return XEL.isBeforeInTranslationUnitThan(YEL);
242 return std::nullopt;
243}
244
245static std::optional<bool> compareMacro(const PathDiagnosticMacroPiece &X,
246 const PathDiagnosticMacroPiece &Y) {
247 return comparePath(X.subPieces, Y.subPieces);
248}
249
250static std::optional<bool> compareCall(const PathDiagnosticCallPiece &X,
251 const PathDiagnosticCallPiece &Y) {
252 FullSourceLoc X_CEL = X.callEnter.asLocation();
254 if (X_CEL != Y_CEL)
255 return X_CEL.isBeforeInTranslationUnitThan(Y_CEL);
256 FullSourceLoc X_CEWL = X.callEnterWithin.asLocation();
258 if (X_CEWL != Y_CEWL)
259 return X_CEWL.isBeforeInTranslationUnitThan(Y_CEWL);
260 FullSourceLoc X_CRL = X.callReturn.asLocation();
262 if (X_CRL != Y_CRL)
263 return X_CRL.isBeforeInTranslationUnitThan(Y_CRL);
264 return comparePath(X.path, Y.path);
265}
266
267static std::optional<bool> comparePiece(const PathDiagnosticPiece &X,
268 const PathDiagnosticPiece &Y) {
269 if (X.getKind() != Y.getKind())
270 return X.getKind() < Y.getKind();
271
272 FullSourceLoc XL = X.getLocation().asLocation();
274 if (XL != YL)
275 return XL.isBeforeInTranslationUnitThan(YL);
276
277 if (X.getString() != Y.getString())
278 return X.getString() < Y.getString();
279
280 if (X.getRanges().size() != Y.getRanges().size())
281 return X.getRanges().size() < Y.getRanges().size();
282
283 const SourceManager &SM = XL.getManager();
284
285 for (unsigned i = 0, n = X.getRanges().size(); i < n; ++i) {
286 SourceRange XR = X.getRanges()[i];
287 SourceRange YR = Y.getRanges()[i];
288 if (XR != YR) {
289 if (XR.getBegin() != YR.getBegin())
290 return SM.isBeforeInTranslationUnit(XR.getBegin(), YR.getBegin());
291 return SM.isBeforeInTranslationUnit(XR.getEnd(), YR.getEnd());
292 }
293 }
294
295 switch (X.getKind()) {
297 return compareControlFlow(cast<PathDiagnosticControlFlowPiece>(X),
298 cast<PathDiagnosticControlFlowPiece>(Y));
300 return compareMacro(cast<PathDiagnosticMacroPiece>(X),
301 cast<PathDiagnosticMacroPiece>(Y));
303 return compareCall(cast<PathDiagnosticCallPiece>(X),
304 cast<PathDiagnosticCallPiece>(Y));
308 return std::nullopt;
309 }
310 llvm_unreachable("all cases handled");
311}
312
313static std::optional<bool> comparePath(const PathPieces &X,
314 const PathPieces &Y) {
315 if (X.size() != Y.size())
316 return X.size() < Y.size();
317
318 PathPieces::const_iterator X_I = X.begin(), X_end = X.end();
319 PathPieces::const_iterator Y_I = Y.begin(), Y_end = Y.end();
320
321 for (; X_I != X_end && Y_I != Y_end; ++X_I, ++Y_I)
322 if (std::optional<bool> b = comparePiece(**X_I, **Y_I))
323 return *b;
324
325 return std::nullopt;
326}
327
329 if (XL.isInvalid() && YL.isValid())
330 return true;
331 if (XL.isValid() && YL.isInvalid())
332 return false;
333 std::pair<FileID, unsigned> XOffs = XL.getDecomposedLoc();
334 std::pair<FileID, unsigned> YOffs = YL.getDecomposedLoc();
335 const SourceManager &SM = XL.getManager();
336 std::pair<bool, bool> InSameTU = SM.isInTheSameTranslationUnit(XOffs, YOffs);
337 if (InSameTU.first)
338 return XL.isBeforeInTranslationUnitThan(YL);
340 SM.getFileEntryRefForID(XL.getSpellingLoc().getFileID());
342 SM.getFileEntryRefForID(YL.getSpellingLoc().getFileID());
343 if (!XFE || !YFE)
344 return XFE && !YFE;
345 int NameCmp = XFE->getName().compare(YFE->getName());
346 if (NameCmp != 0)
347 return NameCmp < 0;
348 // Last resort: Compare raw file IDs that are possibly expansions.
349 return XL.getFileID() < YL.getFileID();
350}
351
352static bool compare(const PathDiagnostic &X, const PathDiagnostic &Y) {
353 FullSourceLoc XL = X.getLocation().asLocation();
355 if (XL != YL)
356 return compareCrossTUSourceLocs(XL, YL);
357 FullSourceLoc XUL = X.getUniqueingLoc().asLocation();
359 if (XUL != YUL)
360 return compareCrossTUSourceLocs(XUL, YUL);
361 if (X.getBugType() != Y.getBugType())
362 return X.getBugType() < Y.getBugType();
363 if (X.getCategory() != Y.getCategory())
364 return X.getCategory() < Y.getCategory();
365 if (X.getVerboseDescription() != Y.getVerboseDescription())
366 return X.getVerboseDescription() < Y.getVerboseDescription();
367 if (X.getShortDescription() != Y.getShortDescription())
368 return X.getShortDescription() < Y.getShortDescription();
369 auto CompareDecls = [&XL](const Decl *D1,
370 const Decl *D2) -> std::optional<bool> {
371 if (D1 == D2)
372 return std::nullopt;
373 if (!D1)
374 return true;
375 if (!D2)
376 return false;
377 SourceLocation D1L = D1->getLocation();
378 SourceLocation D2L = D2->getLocation();
379 if (D1L != D2L) {
380 const SourceManager &SM = XL.getManager();
382 FullSourceLoc(D2L, SM));
383 }
384 return std::nullopt;
385 };
386 if (auto Result = CompareDecls(X.getDeclWithIssue(), Y.getDeclWithIssue()))
387 return *Result;
388 if (XUL.isValid()) {
389 if (auto Result = CompareDecls(X.getUniqueingDecl(), Y.getUniqueingDecl()))
390 return *Result;
391 }
392 PathDiagnostic::meta_iterator XI = X.meta_begin(), XE = X.meta_end();
394 if (XE - XI != YE - YI)
395 return (XE - XI) < (YE - YI);
396 for ( ; XI != XE ; ++XI, ++YI) {
397 if (*XI != *YI)
398 return (*XI) < (*YI);
399 }
400 return *comparePath(X.path, Y.path);
401}
402
405 if (flushed)
406 return;
407
408 flushed = true;
409
410 std::vector<const PathDiagnostic *> BatchDiags;
411 for (const auto &D : Diags)
412 BatchDiags.push_back(&D);
413
414 // Sort the diagnostics so that they are always emitted in a deterministic
415 // order.
416 int (*Comp)(const PathDiagnostic *const *, const PathDiagnostic *const *) =
417 [](const PathDiagnostic *const *X, const PathDiagnostic *const *Y) {
418 assert(*X != *Y && "PathDiagnostics not uniqued!");
419 if (compare(**X, **Y))
420 return -1;
421 assert(compare(**Y, **X) && "Not a total order!");
422 return 1;
423 };
424 array_pod_sort(BatchDiags.begin(), BatchDiags.end(), Comp);
425
426 FlushDiagnosticsImpl(BatchDiags, Files);
427
428 // Delete the flushed diagnostics.
429 for (const auto D : BatchDiags)
430 delete D;
431
432 // Clear out the FoldingSet.
433 Diags.clear();
434}
435
437 for (auto It = Set.begin(); It != Set.end();)
438 (It++)->~PDFileEntry();
439}
440
442 StringRef ConsumerName,
443 StringRef FileName) {
444 llvm::FoldingSetNodeID NodeID;
445 NodeID.Add(PD);
446 void *InsertPos;
447 PDFileEntry *Entry = Set.FindNodeOrInsertPos(NodeID, InsertPos);
448 if (!Entry) {
449 Entry = Alloc.Allocate<PDFileEntry>();
450 Entry = new (Entry) PDFileEntry(NodeID);
451 Set.InsertNode(Entry, InsertPos);
452 }
453
454 // Allocate persistent storage for the file name.
455 char *FileName_cstr = (char*) Alloc.Allocate(FileName.size(), 1);
456 memcpy(FileName_cstr, FileName.data(), FileName.size());
457
458 Entry->files.push_back(std::make_pair(ConsumerName,
459 StringRef(FileName_cstr,
460 FileName.size())));
461}
462
465 llvm::FoldingSetNodeID NodeID;
466 NodeID.Add(PD);
467 void *InsertPos;
468 PDFileEntry *Entry = Set.FindNodeOrInsertPos(NodeID, InsertPos);
469 if (!Entry)
470 return nullptr;
471 return &Entry->files;
472}
473
474//===----------------------------------------------------------------------===//
475// PathDiagnosticLocation methods.
476//===----------------------------------------------------------------------===//
477
479 const Stmt *S, LocationOrAnalysisDeclContext LAC, bool UseEndOfStatement) {
480 SourceLocation L = UseEndOfStatement ? S->getEndLoc() : S->getBeginLoc();
481 assert(!LAC.isNull() &&
482 "A valid LocationContext or AnalysisDeclContext should be passed to "
483 "PathDiagnosticLocation upon creation.");
484
485 // S might be a temporary statement that does not have a location in the
486 // source code, so find an enclosing statement and use its location.
487 if (!L.isValid()) {
489 if (LAC.is<const LocationContext*>())
490 ADC = LAC.get<const LocationContext*>()->getAnalysisDeclContext();
491 else
492 ADC = LAC.get<AnalysisDeclContext*>();
493
494 ParentMap &PM = ADC->getParentMap();
495
496 const Stmt *Parent = S;
497 do {
498 Parent = PM.getParent(Parent);
499
500 // In rare cases, we have implicit top-level expressions,
501 // such as arguments for implicit member initializers.
502 // In this case, fall back to the start of the body (even if we were
503 // asked for the statement end location).
504 if (!Parent) {
505 const Stmt *Body = ADC->getBody();
506 if (Body)
507 L = Body->getBeginLoc();
508 else
509 L = ADC->getDecl()->getEndLoc();
510 break;
511 }
512
513 L = UseEndOfStatement ? Parent->getEndLoc() : Parent->getBeginLoc();
514 } while (!L.isValid());
515 }
516
517 // FIXME: Ironically, this assert actually fails in some cases.
518 //assert(L.isValid());
519 return L;
520}
521
524 const LocationContext *CallerCtx,
525 const SourceManager &SM) {
526 const CFGBlock &Block = *SFC->getCallSiteBlock();
527 CFGElement Source = Block[SFC->getIndex()];
528
529 switch (Source.getKind()) {
533 return PathDiagnosticLocation(Source.castAs<CFGStmt>().getStmt(),
534 SM, CallerCtx);
536 const CFGInitializer &Init = Source.castAs<CFGInitializer>();
537 return PathDiagnosticLocation(Init.getInitializer()->getInit(),
538 SM, CallerCtx);
539 }
541 const CFGAutomaticObjDtor &Dtor = Source.castAs<CFGAutomaticObjDtor>();
543 SM, CallerCtx);
544 }
546 const CFGDeleteDtor &Dtor = Source.castAs<CFGDeleteDtor>();
547 return PathDiagnosticLocation(Dtor.getDeleteExpr(), SM, CallerCtx);
548 }
551 const AnalysisDeclContext *CallerInfo = CallerCtx->getAnalysisDeclContext();
552 if (const Stmt *CallerBody = CallerInfo->getBody())
553 return PathDiagnosticLocation::createEnd(CallerBody, SM, CallerCtx);
554 return PathDiagnosticLocation::create(CallerInfo->getDecl(), SM);
555 }
557 const CFGNewAllocator &Alloc = Source.castAs<CFGNewAllocator>();
558 return PathDiagnosticLocation(Alloc.getAllocatorExpr(), SM, CallerCtx);
559 }
561 // Temporary destructors are for temporaries. They die immediately at around
562 // the location of CXXBindTemporaryExpr. If they are lifetime-extended,
563 // they'd be dealt with via an AutomaticObjectDtor instead.
564 const auto &Dtor = Source.castAs<CFGTemporaryDtor>();
565 return PathDiagnosticLocation::createEnd(Dtor.getBindTemporaryExpr(), SM,
566 CallerCtx);
567 }
571 llvm_unreachable("not yet implemented!");
574 llvm_unreachable("CFGElement kind should not be on callsite!");
575 }
576
577 llvm_unreachable("Unknown CFGElement kind");
578}
579
582 const SourceManager &SM) {
583 return PathDiagnosticLocation(D->getBeginLoc(), SM, SingleLocK);
584}
585
588 const SourceManager &SM,
590 assert(S && "Statement cannot be null");
591 return PathDiagnosticLocation(getValidSourceLocation(S, LAC),
592 SM, SingleLocK);
593}
594
597 const SourceManager &SM,
599 if (const auto *CS = dyn_cast<CompoundStmt>(S))
600 return createEndBrace(CS, SM);
601 return PathDiagnosticLocation(getValidSourceLocation(S, LAC, /*End=*/true),
602 SM, SingleLocK);
603}
604
607 const SourceManager &SM) {
608 return PathDiagnosticLocation(BO->getOperatorLoc(), SM, SingleLocK);
609}
610
613 const ConditionalOperator *CO,
614 const SourceManager &SM) {
615 return PathDiagnosticLocation(CO->getColonLoc(), SM, SingleLocK);
616}
617
620 const SourceManager &SM) {
621
622 assert(ME->getMemberLoc().isValid() || ME->getBeginLoc().isValid());
623
624 // In some cases, getMemberLoc isn't valid -- in this case we'll return with
625 // some other related valid SourceLocation.
626 if (ME->getMemberLoc().isValid())
627 return PathDiagnosticLocation(ME->getMemberLoc(), SM, SingleLocK);
628
629 return PathDiagnosticLocation(ME->getBeginLoc(), SM, SingleLocK);
630}
631
634 const SourceManager &SM) {
635 SourceLocation L = CS->getLBracLoc();
636 return PathDiagnosticLocation(L, SM, SingleLocK);
637}
638
641 const SourceManager &SM) {
642 SourceLocation L = CS->getRBracLoc();
643 return PathDiagnosticLocation(L, SM, SingleLocK);
644}
645
648 const SourceManager &SM) {
649 // FIXME: Should handle CXXTryStmt if analyser starts supporting C++.
650 if (const auto *CS = dyn_cast_or_null<CompoundStmt>(LC->getDecl()->getBody()))
651 if (!CS->body_empty()) {
652 SourceLocation Loc = (*CS->body_begin())->getBeginLoc();
653 return PathDiagnosticLocation(Loc, SM, SingleLocK);
654 }
655
656 return PathDiagnosticLocation();
657}
658
661 const SourceManager &SM) {
663 return PathDiagnosticLocation(L, SM, SingleLocK);
664}
665
668 const SourceManager &SMng) {
669 const Stmt* S = nullptr;
670 if (std::optional<BlockEdge> BE = P.getAs<BlockEdge>()) {
671 const CFGBlock *BSrc = BE->getSrc();
672 if (BSrc->getTerminator().isVirtualBaseBranch()) {
673 // TODO: VirtualBaseBranches should also appear for destructors.
674 // In this case we should put the diagnostic at the end of decl.
676 P.getLocationContext()->getDecl(), SMng);
677
678 } else {
679 S = BSrc->getTerminatorCondition();
680 if (!S) {
681 // If the BlockEdge has no terminator condition statement but its
682 // source is the entry of the CFG (e.g. a checker crated the branch at
683 // the beginning of a function), use the function's declaration instead.
684 assert(BSrc == &BSrc->getParent()->getEntry() && "CFGBlock has no "
685 "TerminatorCondition and is not the enrty block of the CFG");
687 P.getLocationContext()->getDecl(), SMng);
688 }
689 }
690 } else if (std::optional<StmtPoint> SP = P.getAs<StmtPoint>()) {
691 S = SP->getStmt();
692 if (P.getAs<PostStmtPurgeDeadSymbols>())
693 return PathDiagnosticLocation::createEnd(S, SMng, P.getLocationContext());
694 } else if (std::optional<PostInitializer> PIP = P.getAs<PostInitializer>()) {
695 return PathDiagnosticLocation(PIP->getInitializer()->getSourceLocation(),
696 SMng);
697 } else if (std::optional<PreImplicitCall> PIC = P.getAs<PreImplicitCall>()) {
698 return PathDiagnosticLocation(PIC->getLocation(), SMng);
699 } else if (std::optional<PostImplicitCall> PIE =
700 P.getAs<PostImplicitCall>()) {
701 return PathDiagnosticLocation(PIE->getLocation(), SMng);
702 } else if (std::optional<CallEnter> CE = P.getAs<CallEnter>()) {
703 return getLocationForCaller(CE->getCalleeContext(),
704 CE->getLocationContext(),
705 SMng);
706 } else if (std::optional<CallExitEnd> CEE = P.getAs<CallExitEnd>()) {
707 return getLocationForCaller(CEE->getCalleeContext(),
708 CEE->getLocationContext(),
709 SMng);
710 } else if (auto CEB = P.getAs<CallExitBegin>()) {
711 if (const ReturnStmt *RS = CEB->getReturnStmt())
713 CEB->getLocationContext());
715 CEB->getLocationContext()->getDecl()->getSourceRange().getEnd(), SMng);
716 } else if (std::optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) {
717 if (std::optional<CFGElement> BlockFront = BE->getFirstElement()) {
718 if (auto StmtElt = BlockFront->getAs<CFGStmt>()) {
719 return PathDiagnosticLocation(StmtElt->getStmt()->getBeginLoc(), SMng);
720 } else if (auto NewAllocElt = BlockFront->getAs<CFGNewAllocator>()) {
722 NewAllocElt->getAllocatorExpr()->getBeginLoc(), SMng);
723 }
724 llvm_unreachable("Unexpected CFG element at front of block");
725 }
726
728 BE->getBlock()->getTerminatorStmt()->getBeginLoc(), SMng);
729 } else if (std::optional<FunctionExitPoint> FE =
730 P.getAs<FunctionExitPoint>()) {
731 return PathDiagnosticLocation(FE->getStmt(), SMng,
732 FE->getLocationContext());
733 } else {
734 llvm_unreachable("Unexpected ProgramPoint");
735 }
736
737 return PathDiagnosticLocation(S, SMng, P.getLocationContext());
738}
739
741 const PathDiagnosticLocation &PDL) {
742 FullSourceLoc L = PDL.asLocation();
743 return PathDiagnosticLocation(L, L.getManager(), SingleLocK);
744}
745
747 PathDiagnosticLocation::genLocation(SourceLocation L,
749 assert(isValid());
750 // Note that we want a 'switch' here so that the compiler can warn us in
751 // case we add more cases.
752 switch (K) {
753 case SingleLocK:
754 case RangeK:
755 break;
756 case StmtK:
757 // Defensive checking.
758 if (!S)
759 break;
760 return FullSourceLoc(getValidSourceLocation(S, LAC),
761 const_cast<SourceManager&>(*SM));
762 case DeclK:
763 // Defensive checking.
764 if (!D)
765 break;
766 return FullSourceLoc(D->getLocation(), const_cast<SourceManager&>(*SM));
767 }
768
769 return FullSourceLoc(L, const_cast<SourceManager&>(*SM));
770}
771
773 PathDiagnosticLocation::genRange(LocationOrAnalysisDeclContext LAC) const {
774 assert(isValid());
775 // Note that we want a 'switch' here so that the compiler can warn us in
776 // case we add more cases.
777 switch (K) {
778 case SingleLocK:
779 return PathDiagnosticRange(SourceRange(Loc,Loc), true);
780 case RangeK:
781 break;
782 case StmtK: {
783 const Stmt *S = asStmt();
784 switch (S->getStmtClass()) {
785 default:
786 break;
787 case Stmt::DeclStmtClass: {
788 const auto *DS = cast<DeclStmt>(S);
789 if (DS->isSingleDecl()) {
790 // Should always be the case, but we'll be defensive.
791 return SourceRange(DS->getBeginLoc(),
792 DS->getSingleDecl()->getLocation());
793 }
794 break;
795 }
796 // FIXME: Provide better range information for different
797 // terminators.
798 case Stmt::IfStmtClass:
799 case Stmt::WhileStmtClass:
800 case Stmt::DoStmtClass:
801 case Stmt::ForStmtClass:
802 case Stmt::ChooseExprClass:
803 case Stmt::IndirectGotoStmtClass:
804 case Stmt::SwitchStmtClass:
805 case Stmt::BinaryConditionalOperatorClass:
806 case Stmt::ConditionalOperatorClass:
807 case Stmt::ObjCForCollectionStmtClass: {
808 SourceLocation L = getValidSourceLocation(S, LAC);
809 return SourceRange(L, L);
810 }
811 }
812 SourceRange R = S->getSourceRange();
813 if (R.isValid())
814 return R;
815 break;
816 }
817 case DeclK:
818 if (const auto *MD = dyn_cast<ObjCMethodDecl>(D))
819 return MD->getSourceRange();
820 if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
821 if (Stmt *Body = FD->getBody())
822 return Body->getSourceRange();
823 }
824 else {
825 SourceLocation L = D->getLocation();
826 return PathDiagnosticRange(SourceRange(L, L), true);
827 }
828 }
829
830 return SourceRange(Loc, Loc);
831}
832
834 if (K == StmtK) {
835 K = RangeK;
836 S = nullptr;
837 D = nullptr;
838 }
839 else if (K == DeclK) {
840 K = SingleLocK;
841 S = nullptr;
842 D = nullptr;
843 }
844}
845
846//===----------------------------------------------------------------------===//
847// Manipulation of PathDiagnosticCallPieces.
848//===----------------------------------------------------------------------===//
849
850std::shared_ptr<PathDiagnosticCallPiece>
852 const SourceManager &SM) {
853 const Decl *caller = CE.getLocationContext()->getDecl();
856 SM);
857 return std::shared_ptr<PathDiagnosticCallPiece>(
858 new PathDiagnosticCallPiece(caller, pos));
859}
860
863 const Decl *caller) {
864 std::shared_ptr<PathDiagnosticCallPiece> C(
865 new PathDiagnosticCallPiece(path, caller));
866 path.clear();
867 auto *R = C.get();
868 path.push_front(std::move(C));
869 return R;
870}
871
873 const SourceManager &SM) {
874 const StackFrameContext *CalleeCtx = CE.getCalleeContext();
875 Callee = CalleeCtx->getDecl();
876
877 callEnterWithin = PathDiagnosticLocation::createBegin(Callee, SM);
878 callEnter = getLocationForCaller(CalleeCtx, CE.getLocationContext(), SM);
879
880 // Autosynthesized property accessors are special because we'd never
881 // pop back up to non-autosynthesized code until we leave them.
882 // This is not generally true for autosynthesized callees, which may call
883 // non-autosynthesized callbacks.
884 // Unless set here, the IsCalleeAnAutosynthesizedPropertyAccessor flag
885 // defaults to false.
886 if (const auto *MD = dyn_cast<ObjCMethodDecl>(Callee))
887 IsCalleeAnAutosynthesizedPropertyAccessor = (
888 MD->isPropertyAccessor() &&
890}
891
892static void describeTemplateParameters(raw_ostream &Out,
893 const ArrayRef<TemplateArgument> TAList,
894 const LangOptions &LO,
895 StringRef Prefix = StringRef(),
896 StringRef Postfix = StringRef());
897
898static void describeTemplateParameter(raw_ostream &Out,
899 const TemplateArgument &TArg,
900 const LangOptions &LO) {
901
904 } else {
905 TArg.print(PrintingPolicy(LO), Out, /*IncludeType*/ true);
906 }
907}
908
909static void describeTemplateParameters(raw_ostream &Out,
910 const ArrayRef<TemplateArgument> TAList,
911 const LangOptions &LO,
912 StringRef Prefix, StringRef Postfix) {
913 if (TAList.empty())
914 return;
915
916 Out << Prefix;
917 for (int I = 0, Last = TAList.size() - 1; I != Last; ++I) {
918 describeTemplateParameter(Out, TAList[I], LO);
919 Out << ", ";
920 }
921 describeTemplateParameter(Out, TAList[TAList.size() - 1], LO);
922 Out << Postfix;
923}
924
925static void describeClass(raw_ostream &Out, const CXXRecordDecl *D,
926 StringRef Prefix = StringRef()) {
927 if (!D->getIdentifier())
928 return;
929 Out << Prefix << '\'' << *D;
930 if (const auto T = dyn_cast<ClassTemplateSpecializationDecl>(D))
931 describeTemplateParameters(Out, T->getTemplateArgs().asArray(),
932 D->getLangOpts(), "<", ">");
933
934 Out << '\'';
935}
936
937static bool describeCodeDecl(raw_ostream &Out, const Decl *D,
938 bool ExtendedDescription,
939 StringRef Prefix = StringRef()) {
940 if (!D)
941 return false;
942
943 if (isa<BlockDecl>(D)) {
944 if (ExtendedDescription)
945 Out << Prefix << "anonymous block";
946 return ExtendedDescription;
947 }
948
949 if (const auto *MD = dyn_cast<CXXMethodDecl>(D)) {
950 Out << Prefix;
951 if (ExtendedDescription && !MD->isUserProvided()) {
952 if (MD->isExplicitlyDefaulted())
953 Out << "defaulted ";
954 else
955 Out << "implicit ";
956 }
957
958 if (const auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
959 if (CD->isDefaultConstructor())
960 Out << "default ";
961 else if (CD->isCopyConstructor())
962 Out << "copy ";
963 else if (CD->isMoveConstructor())
964 Out << "move ";
965
966 Out << "constructor";
967 describeClass(Out, MD->getParent(), " for ");
968 } else if (isa<CXXDestructorDecl>(MD)) {
969 if (!MD->isUserProvided()) {
970 Out << "destructor";
971 describeClass(Out, MD->getParent(), " for ");
972 } else {
973 // Use ~Foo for explicitly-written destructors.
974 Out << "'" << *MD << "'";
975 }
976 } else if (MD->isCopyAssignmentOperator()) {
977 Out << "copy assignment operator";
978 describeClass(Out, MD->getParent(), " for ");
979 } else if (MD->isMoveAssignmentOperator()) {
980 Out << "move assignment operator";
981 describeClass(Out, MD->getParent(), " for ");
982 } else {
983 if (MD->getParent()->getIdentifier())
984 Out << "'" << *MD->getParent() << "::" << *MD << "'";
985 else
986 Out << "'" << *MD << "'";
987 }
988
989 return true;
990 }
991
992 Out << Prefix << '\'' << cast<NamedDecl>(*D);
993
994 // Adding template parameters.
995 if (const auto FD = dyn_cast<FunctionDecl>(D))
996 if (const TemplateArgumentList *TAList =
997 FD->getTemplateSpecializationArgs())
998 describeTemplateParameters(Out, TAList->asArray(), FD->getLangOpts(), "<",
999 ">");
1000
1001 Out << '\'';
1002 return true;
1003}
1004
1005std::shared_ptr<PathDiagnosticEventPiece>
1007 // We do not produce call enters and call exits for autosynthesized property
1008 // accessors. We do generally produce them for other functions coming from
1009 // the body farm because they may call callbacks that bring us back into
1010 // visible code.
1011 if (!Callee || IsCalleeAnAutosynthesizedPropertyAccessor)
1012 return nullptr;
1013
1014 SmallString<256> buf;
1015 llvm::raw_svector_ostream Out(buf);
1016
1017 Out << "Calling ";
1018 describeCodeDecl(Out, Callee, /*ExtendedDescription=*/true);
1019
1020 assert(callEnter.asLocation().isValid());
1021 return std::make_shared<PathDiagnosticEventPiece>(callEnter, Out.str());
1022}
1023
1024std::shared_ptr<PathDiagnosticEventPiece>
1026 if (!callEnterWithin.asLocation().isValid())
1027 return nullptr;
1028 if (Callee->isImplicit() || !Callee->hasBody())
1029 return nullptr;
1030 if (const auto *MD = dyn_cast<CXXMethodDecl>(Callee))
1031 if (MD->isDefaulted())
1032 return nullptr;
1033
1034 SmallString<256> buf;
1035 llvm::raw_svector_ostream Out(buf);
1036
1037 Out << "Entered call";
1038 describeCodeDecl(Out, Caller, /*ExtendedDescription=*/false, " from ");
1039
1040 return std::make_shared<PathDiagnosticEventPiece>(callEnterWithin, Out.str());
1041}
1042
1043std::shared_ptr<PathDiagnosticEventPiece>
1045 // We do not produce call enters and call exits for autosynthesized property
1046 // accessors. We do generally produce them for other functions coming from
1047 // the body farm because they may call callbacks that bring us back into
1048 // visible code.
1049 if (NoExit || IsCalleeAnAutosynthesizedPropertyAccessor)
1050 return nullptr;
1051
1052 SmallString<256> buf;
1053 llvm::raw_svector_ostream Out(buf);
1054
1055 if (!CallStackMessage.empty()) {
1056 Out << CallStackMessage;
1057 } else {
1058 bool DidDescribe = describeCodeDecl(Out, Callee,
1059 /*ExtendedDescription=*/false,
1060 "Returning from ");
1061 if (!DidDescribe)
1062 Out << "Returning to caller";
1063 }
1064
1065 assert(callReturn.asLocation().isValid());
1066 return std::make_shared<PathDiagnosticEventPiece>(callReturn, Out.str());
1067}
1068
1069static void compute_path_size(const PathPieces &pieces, unsigned &size) {
1070 for (const auto &I : pieces) {
1071 const PathDiagnosticPiece *piece = I.get();
1072 if (const auto *cp = dyn_cast<PathDiagnosticCallPiece>(piece))
1073 compute_path_size(cp->path, size);
1074 else
1075 ++size;
1076 }
1077}
1078
1080 unsigned size = 0;
1081 compute_path_size(path, size);
1082 return size;
1083}
1084
1085//===----------------------------------------------------------------------===//
1086// FoldingSet profiling methods.
1087//===----------------------------------------------------------------------===//
1088
1089void PathDiagnosticLocation::Profile(llvm::FoldingSetNodeID &ID) const {
1090 ID.Add(Range.getBegin());
1091 ID.Add(Range.getEnd());
1092 ID.Add(static_cast<const SourceLocation &>(Loc));
1093}
1094
1095void PathDiagnosticPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1096 ID.AddInteger((unsigned) getKind());
1097 ID.AddString(str);
1098 // FIXME: Add profiling support for code hints.
1099 ID.AddInteger((unsigned) getDisplayHint());
1100 ArrayRef<SourceRange> Ranges = getRanges();
1101 for (const auto &I : Ranges) {
1102 ID.Add(I.getBegin());
1103 ID.Add(I.getEnd());
1104 }
1105}
1106
1107void PathDiagnosticCallPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1109 for (const auto &I : path)
1110 ID.Add(*I);
1111}
1112
1113void PathDiagnosticSpotPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1115 ID.Add(Pos);
1116}
1117
1118void PathDiagnosticControlFlowPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1120 for (const auto &I : *this)
1121 ID.Add(I);
1122}
1123
1124void PathDiagnosticMacroPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1126 for (const auto &I : subPieces)
1127 ID.Add(*I);
1128}
1129
1130void PathDiagnosticNotePiece::Profile(llvm::FoldingSetNodeID &ID) const {
1132}
1133
1134void PathDiagnosticPopUpPiece::Profile(llvm::FoldingSetNodeID &ID) const {
1136}
1137
1138void PathDiagnostic::Profile(llvm::FoldingSetNodeID &ID) const {
1139 ID.Add(getLocation());
1140 ID.Add(getUniqueingLoc());
1141 ID.AddString(BugType);
1142 ID.AddString(VerboseDesc);
1143 ID.AddString(Category);
1144}
1145
1146void PathDiagnostic::FullProfile(llvm::FoldingSetNodeID &ID) const {
1147 Profile(ID);
1148 for (const auto &I : path)
1149 ID.Add(*I);
1150 for (meta_iterator I = meta_begin(), E = meta_end(); I != E; ++I)
1151 ID.AddString(*I);
1152}
1153
1154LLVM_DUMP_METHOD void PathPieces::dump() const {
1155 unsigned index = 0;
1156 for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I) {
1157 llvm::errs() << "[" << index++ << "] ";
1158 (*I)->dump();
1159 llvm::errs() << "\n";
1160 }
1161}
1162
1163LLVM_DUMP_METHOD void PathDiagnosticCallPiece::dump() const {
1164 llvm::errs() << "CALL\n--------------\n";
1165
1166 if (const Stmt *SLoc = getLocation().getStmtOrNull())
1167 SLoc->dump();
1168 else if (const auto *ND = dyn_cast_or_null<NamedDecl>(getCallee()))
1169 llvm::errs() << *ND << "\n";
1170 else
1171 getLocation().dump();
1172}
1173
1174LLVM_DUMP_METHOD void PathDiagnosticEventPiece::dump() const {
1175 llvm::errs() << "EVENT\n--------------\n";
1176 llvm::errs() << getString() << "\n";
1177 llvm::errs() << " ---- at ----\n";
1178 getLocation().dump();
1179}
1180
1181LLVM_DUMP_METHOD void PathDiagnosticControlFlowPiece::dump() const {
1182 llvm::errs() << "CONTROL\n--------------\n";
1183 getStartLocation().dump();
1184 llvm::errs() << " ---- to ----\n";
1185 getEndLocation().dump();
1186}
1187
1188LLVM_DUMP_METHOD void PathDiagnosticMacroPiece::dump() const {
1189 llvm::errs() << "MACRO\n--------------\n";
1190 // FIXME: Print which macro is being invoked.
1191}
1192
1193LLVM_DUMP_METHOD void PathDiagnosticNotePiece::dump() const {
1194 llvm::errs() << "NOTE\n--------------\n";
1195 llvm::errs() << getString() << "\n";
1196 llvm::errs() << " ---- at ----\n";
1197 getLocation().dump();
1198}
1199
1200LLVM_DUMP_METHOD void PathDiagnosticPopUpPiece::dump() const {
1201 llvm::errs() << "POP-UP\n--------------\n";
1202 llvm::errs() << getString() << "\n";
1203 llvm::errs() << " ---- at ----\n";
1204 getLocation().dump();
1205}
1206
1207LLVM_DUMP_METHOD void PathDiagnosticLocation::dump() const {
1208 if (!isValid()) {
1209 llvm::errs() << "<INVALID>\n";
1210 return;
1211 }
1212
1213 switch (K) {
1214 case RangeK:
1215 // FIXME: actually print the range.
1216 llvm::errs() << "<range>\n";
1217 break;
1218 case SingleLocK:
1219 asLocation().dump();
1220 llvm::errs() << "\n";
1221 break;
1222 case StmtK:
1223 if (S)
1224 S->dump();
1225 else
1226 llvm::errs() << "<NULL STMT>\n";
1227 break;
1228 case DeclK:
1229 if (const auto *ND = dyn_cast_or_null<NamedDecl>(D))
1230 llvm::errs() << *ND << "\n";
1231 else if (isa<BlockDecl>(D))
1232 // FIXME: Make this nicer.
1233 llvm::errs() << "<block>\n";
1234 else if (D)
1235 llvm::errs() << "<unknown decl>\n";
1236 else
1237 llvm::errs() << "<NULL DECL>\n";
1238 break;
1239 }
1240}
NodeId Parent
Definition: ASTDiff.cpp:191
StringRef P
This file defines AnalysisDeclContext, a class that manages the analysis context data for context sen...
#define SM(sm)
Definition: Cuda.cpp:80
static Decl::Kind getKind(const Decl *D)
Definition: DeclBase.cpp:1048
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
Defines the C++ template declaration subclasses.
Defines the clang::Expr interface and subclasses for C++ expressions.
Defines the clang::FileManager interface and associated types.
int Category
Definition: Format.cpp:2939
#define X(type, name)
Definition: Value.h:142
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
static std::optional< bool > comparePath(const PathPieces &X, const PathPieces &Y)
static PathDiagnosticLocation getLocationForCaller(const StackFrameContext *SFC, const LocationContext *CallerCtx, const SourceManager &SM)
static void describeClass(raw_ostream &Out, const CXXRecordDecl *D, StringRef Prefix=StringRef())
static bool compare(const PathDiagnostic &X, const PathDiagnostic &Y)
static bool describeCodeDecl(raw_ostream &Out, const Decl *D, bool ExtendedDescription, StringRef Prefix=StringRef())
static std::optional< bool > compareCall(const PathDiagnosticCallPiece &X, const PathDiagnosticCallPiece &Y)
static std::optional< bool > comparePiece(const PathDiagnosticPiece &X, const PathDiagnosticPiece &Y)
static void describeTemplateParameter(raw_ostream &Out, const TemplateArgument &TArg, const LangOptions &LO)
static void compute_path_size(const PathPieces &pieces, unsigned &size)
static std::optional< bool > compareMacro(const PathDiagnosticMacroPiece &X, const PathDiagnosticMacroPiece &Y)
static std::optional< bool > compareControlFlow(const PathDiagnosticControlFlowPiece &X, const PathDiagnosticControlFlowPiece &Y)
static StringRef StripTrailingDots(StringRef s)
static void describeTemplateParameters(raw_ostream &Out, const ArrayRef< TemplateArgument > TAList, const LangOptions &LO, StringRef Prefix=StringRef(), StringRef Postfix=StringRef())
static bool compareCrossTUSourceLocs(FullSourceLoc XL, FullSourceLoc YL)
Defines the clang::SourceLocation class and associated facilities.
Defines the SourceManager interface.
C Language Family Type Representation.
__DEVICE__ void * memcpy(void *__a, const void *__b, size_t __c)
__device__ __2f16 b
__device__ int
__device__ __2f16 float __ockl_bool s
SourceLocation getColonLoc() const
Definition: Expr.h:4163
AnalysisDeclContext contains the context data for the function, method or block under analysis.
const Decl * getDecl() const
A builtin binary operation expression such as "x + y" or "x <= y".
Definition: Expr.h:3834
SourceLocation getOperatorLoc() const
Definition: Expr.h:3875
Represents C++ object destructor implicitly generated for automatic object or temporary bound to cons...
Definition: CFG.h:417
const Stmt * getTriggerStmt() const
Definition: CFG.h:427
Represents a single basic block in a source-level CFG.
Definition: CFG.h:604
CFGTerminator getTerminator() const
Definition: CFG.h:1076
CFG * getParent() const
Definition: CFG.h:1104
Stmt * getTerminatorCondition(bool StripParens=true)
Definition: CFG.cpp:6266
Represents C++ object destructor generated from a call to delete.
Definition: CFG.h:442
const CXXDeleteExpr * getDeleteExpr() const
Definition: CFG.h:452
Represents a top-level expression in a basic block.
Definition: CFG.h:55
@ CleanupFunction
Definition: CFG.h:79
@ LifetimeEnds
Definition: CFG.h:63
@ CXXRecordTypedCall
Definition: CFG.h:68
@ AutomaticObjectDtor
Definition: CFG.h:72
@ TemporaryDtor
Definition: CFG.h:76
@ NewAllocator
Definition: CFG.h:62
T castAs() const
Convert to the specified CFGElement type, asserting that this CFGElement is of the desired type.
Definition: CFG.h:99
Kind getKind() const
Definition: CFG.h:118
Represents C++ base or member initializer from constructor's initialization list.
Definition: CFG.h:227
Represents C++ allocator call.
Definition: CFG.h:247
const CXXNewExpr * getAllocatorExpr() const
Definition: CFG.h:253
const Stmt * getStmt() const
Definition: CFG.h:138
Represents C++ object destructor implicitly generated at the end of full expression for temporary obj...
Definition: CFG.h:510
bool isVirtualBaseBranch() const
Definition: CFG.h:573
CFGBlock & getEntry()
Definition: CFG.h:1317
Represents a C++ struct/union/class.
Definition: DeclCXX.h:254
Represents a point when we begin processing an inlined call.
Definition: ProgramPoint.h:628
const StackFrameContext * getCalleeContext() const
Definition: ProgramPoint.h:638
Represents a point when we start the call exit sequence (for inlined call).
Definition: ProgramPoint.h:666
Represents a point when we finish the call exit sequence (for inlined call).
Definition: ProgramPoint.h:686
const StackFrameContext * getCalleeContext() const
Definition: ProgramPoint.h:693
CompoundStmt - This represents a group of statements like { stmt stmt }.
Definition: Stmt.h:1429
SourceLocation getLBracLoc() const
Definition: Stmt.h:1559
SourceLocation getRBracLoc() const
Definition: Stmt.h:1560
ConditionalOperator - The ?: ternary operator.
Definition: Expr.h:4173
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:83
SourceLocation getEndLoc() const LLVM_READONLY
Definition: DeclBase.h:428
virtual Stmt * getBody() const
getBody - If this Decl represents a declaration for a body of code, such as a function or method defi...
Definition: DeclBase.h:1055
SourceLocation getBodyRBrace() const
getBodyRBrace - Gets the right brace of the body, if a body exists.
Definition: DeclBase.cpp:970
SourceLocation getLocation() const
Definition: DeclBase.h:432
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: DeclBase.h:424
StringRef getName() const
The name of this FileEntry.
Definition: FileEntry.h:61
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
bool isInvalid() const
A SourceLocation and its associated SourceManager.
FullSourceLoc getExpansionLoc() const
FullSourceLoc getSpellingLoc() const
FileID getFileID() const
std::pair< FileID, unsigned > getDecomposedLoc() const
Decompose the specified location into a raw FileID + Offset pair.
const SourceManager & getManager() const
bool isBeforeInTranslationUnitThan(SourceLocation Loc) const
Determines the order of 2 source locations in the translation unit.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:83
It wraps the AnalysisDeclContext to represent both the call stack with the help of StackFrameContext ...
const Decl * getDecl() const
LLVM_ATTRIBUTE_RETURNS_NONNULL AnalysisDeclContext * getAnalysisDeclContext() const
MemberExpr - [C99 6.5.2.3] Structure and Union Members.
Definition: Expr.h:3195
SourceLocation getMemberLoc() const
getMemberLoc - Return the location of the "member", in X->F, it is the location of 'F'.
Definition: Expr.h:3380
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: Expr.cpp:1816
IdentifierInfo * getIdentifier() const
Get the identifier that names this declaration, if there is one.
Definition: Decl.h:268
Represents a program point just after an implicit call event.
Definition: ProgramPoint.h:597
Represents a point after we ran remove dead bindings AFTER processing the given statement.
Definition: ProgramPoint.h:484
Represents a program point just before an implicit call event.
Definition: ProgramPoint.h:579
const LocationContext * getLocationContext() const
Definition: ProgramPoint.h:175
ReturnStmt - This represents a return, optionally of an expression: return; return 4;.
Definition: Stmt.h:2840
Encodes a location in the source.
bool isValid() const
Return true if this is a valid SourceLocation object.
This class handles loading and caching of source files into memory.
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
SourceLocation getExpansionLoc(SourceLocation Loc) const
Given a SourceLocation object Loc, return the expansion location referenced by the ID.
A trivial tuple used to represent a source range.
SourceLocation getEnd() const
SourceLocation getBegin() const
bool isValid() const
It represents a stack frame of the call stack (based on CallEvent).
const CFGBlock * getCallSiteBlock() const
Stmt - This represents one statement.
Definition: Stmt.h:72
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: Stmt.cpp:337
A template argument list.
Definition: DeclTemplate.h:240
Represents a template argument.
Definition: TemplateBase.h:60
ArrayRef< TemplateArgument > getPackAsArray() const
Return the array of arguments in this template argument pack.
Definition: TemplateBase.h:404
void print(const PrintingPolicy &Policy, raw_ostream &Out, bool IncludeType) const
Print this template argument to the given output stream.
@ Pack
The template argument is actually a parameter pack.
Definition: TemplateBase.h:99
ArgKind getKind() const
Return the kind of stored template argument.
Definition: TemplateBase.h:263
void setCallee(const CallEnter &CE, const SourceManager &SM)
std::shared_ptr< PathDiagnosticEventPiece > getCallExitEvent() const
static std::shared_ptr< PathDiagnosticCallPiece > construct(const CallExitEnd &CE, const SourceManager &SM)
std::shared_ptr< PathDiagnosticEventPiece > getCallEnterWithinCallerEvent() const
void Profile(llvm::FoldingSetNodeID &ID) const override
std::shared_ptr< PathDiagnosticEventPiece > getCallEnterEvent() const
PathDiagnosticLocation callEnterWithin
PDFileEntry::ConsumerFiles * getFiles(const PathDiagnostic &PD)
void addDiagnostic(const PathDiagnostic &PD, StringRef ConsumerName, StringRef fileName)
std::vector< std::pair< StringRef, StringRef > > ConsumerFiles
ConsumerFiles files
A vector of <consumer,file> pairs.
virtual void FlushDiagnosticsImpl(std::vector< const PathDiagnostic * > &Diags, FilesMade *filesMade)=0
virtual bool supportsCrossFileDiagnostics() const
Return true if the PathDiagnosticConsumer supports individual PathDiagnostics that span multiple file...
void HandlePathDiagnostic(std::unique_ptr< PathDiagnostic > D)
llvm::FoldingSet< PathDiagnostic > Diags
void FlushDiagnostics(FilesMade *FilesMade)
PathDiagnosticLocation getStartLocation() const
PathDiagnosticLocation getEndLocation() const
void Profile(llvm::FoldingSetNodeID &ID) const override
static PathDiagnosticLocation createMemberLoc(const MemberExpr *ME, const SourceManager &SM)
For member expressions, return the location of the '.
static PathDiagnosticLocation createDeclBegin(const LocationContext *LC, const SourceManager &SM)
Create a location for the beginning of the enclosing declaration body.
void Profile(llvm::FoldingSetNodeID &ID) const
static PathDiagnosticLocation createOperatorLoc(const BinaryOperator *BO, const SourceManager &SM)
Create the location for the operator of the binary expression.
static PathDiagnosticLocation createEndBrace(const CompoundStmt *CS, const SourceManager &SM)
Create a location for the end of the compound statement.
static PathDiagnosticLocation createBeginBrace(const CompoundStmt *CS, const SourceManager &SM)
Create a location for the beginning of the compound statement.
static SourceLocation getValidSourceLocation(const Stmt *S, LocationOrAnalysisDeclContext LAC, bool UseEndOfStatement=false)
Construct a source location that corresponds to either the beginning or the end of the given statemen...
static PathDiagnosticLocation createEnd(const Stmt *S, const SourceManager &SM, const LocationOrAnalysisDeclContext LAC)
Create a location for the end of the statement.
static PathDiagnosticLocation createBegin(const Decl *D, const SourceManager &SM)
Create a location for the beginning of the declaration.
static PathDiagnosticLocation create(const Decl *D, const SourceManager &SM)
Create a location corresponding to the given declaration.
static PathDiagnosticLocation createConditionalColonLoc(const ConditionalOperator *CO, const SourceManager &SM)
static PathDiagnosticLocation createDeclEnd(const LocationContext *LC, const SourceManager &SM)
Constructs a location for the end of the enclosing declaration body.
static PathDiagnosticLocation createSingleLocation(const PathDiagnosticLocation &PDL)
Convert the given location into a single kind location.
void Profile(llvm::FoldingSetNodeID &ID) const override
void Profile(llvm::FoldingSetNodeID &ID) const override
ArrayRef< SourceRange > getRanges() const
Return the SourceRanges associated with this PathDiagnosticPiece.
virtual PathDiagnosticLocation getLocation() const =0
virtual void Profile(llvm::FoldingSetNodeID &ID) const
void Profile(llvm::FoldingSetNodeID &ID) const override
void Profile(llvm::FoldingSetNodeID &ID) const override
PathDiagnostic - PathDiagnostic objects represent a single path-sensitive diagnostic.
meta_iterator meta_end() const
void FullProfile(llvm::FoldingSetNodeID &ID) const
Profiles the diagnostic, including its path.
PathDiagnosticLocation getUniqueingLoc() const
Get the location on which the report should be uniqued.
std::deque< std::string >::const_iterator meta_iterator
StringRef getVerboseDescription() const
const Decl * getDeclWithIssue() const
Return the semantic context where an issue occurred.
void Profile(llvm::FoldingSetNodeID &ID) const
Profiles the diagnostic, independent of the path it references.
unsigned full_size()
Return the unrolled size of the path.
StringRef getBugType() const
const Decl * getUniqueingDecl() const
Get the declaration containing the uniqueing location.
StringRef getCategory() const
StringRef getShortDescription() const
meta_iterator meta_begin() const
PathDiagnosticLocation getLocation() const
A Range represents the closed range [from, to].
llvm::PointerUnion< const LocationContext *, AnalysisDeclContext * > LocationOrAnalysisDeclContext
@ C
Languages that the frontend can parse and compile.
@ Result
The result type of a method or function.
Definition: Format.h:5078
Describes how types, statements, expressions, and declarations should be printed.
Definition: PrettyPrinter.h:57