1 //===--- PlistDiagnostics.cpp - Plist Diagnostics for Paths -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the PlistDiagnostics object.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Basic/FileManager.h"
15 #include "clang/Basic/PlistSupport.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/Version.h"
18 #include "clang/Lex/Preprocessor.h"
19 #include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h"
20 #include "clang/StaticAnalyzer/Core/IssueHash.h"
21 #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/Support/Casting.h"
24 using namespace clang;
26 using namespace markup;
29 class PlistDiagnostics : public PathDiagnosticConsumer {
30 const std::string OutputFile;
31 const LangOptions &LangOpts;
32 const bool SupportsCrossFileDiagnostics;
34 PlistDiagnostics(AnalyzerOptions &AnalyzerOpts,
35 const std::string& prefix,
36 const LangOptions &LangOpts,
37 bool supportsMultipleFiles);
39 ~PlistDiagnostics() override {}
41 void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
42 FilesMade *filesMade) override;
44 StringRef getName() const override {
45 return "PlistDiagnostics";
48 PathGenerationScheme getGenerationScheme() const override {
51 bool supportsLogicalOpControlFlow() const override { return true; }
52 bool supportsCrossFileDiagnostics() const override {
53 return SupportsCrossFileDiagnostics;
56 } // end anonymous namespace
58 PlistDiagnostics::PlistDiagnostics(AnalyzerOptions &AnalyzerOpts,
59 const std::string& output,
60 const LangOptions &LO,
61 bool supportsMultipleFiles)
64 SupportsCrossFileDiagnostics(supportsMultipleFiles) {}
66 void ento::createPlistDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts,
67 PathDiagnosticConsumers &C,
69 const Preprocessor &PP) {
70 C.push_back(new PlistDiagnostics(AnalyzerOpts, s,
71 PP.getLangOpts(), false));
74 void ento::createPlistMultiFileDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts,
75 PathDiagnosticConsumers &C,
77 const Preprocessor &PP) {
78 C.push_back(new PlistDiagnostics(AnalyzerOpts, s,
79 PP.getLangOpts(), true));
82 static void ReportControlFlow(raw_ostream &o,
83 const PathDiagnosticControlFlowPiece& P,
85 const SourceManager &SM,
86 const LangOptions &LangOpts,
89 Indent(o, indent) << "<dict>\n";
92 Indent(o, indent) << "<key>kind</key><string>control</string>\n";
95 Indent(o, indent) << "<key>edges</key>\n";
97 Indent(o, indent) << "<array>\n";
99 for (PathDiagnosticControlFlowPiece::const_iterator I=P.begin(), E=P.end();
101 Indent(o, indent) << "<dict>\n";
104 // Make the ranges of the start and end point self-consistent with adjacent edges
105 // by forcing to use only the beginning of the range. This simplifies the layout
106 // logic for clients.
107 Indent(o, indent) << "<key>start</key>\n";
108 SourceRange StartEdge(
109 SM.getExpansionLoc(I->getStart().asRange().getBegin()));
110 EmitRange(o, SM, Lexer::getAsCharRange(StartEdge, SM, LangOpts), FM,
113 Indent(o, indent) << "<key>end</key>\n";
114 SourceRange EndEdge(SM.getExpansionLoc(I->getEnd().asRange().getBegin()));
115 EmitRange(o, SM, Lexer::getAsCharRange(EndEdge, SM, LangOpts), FM,
119 Indent(o, indent) << "</dict>\n";
122 Indent(o, indent) << "</array>\n";
125 // Output any helper text.
126 const auto &s = P.getString();
128 Indent(o, indent) << "<key>alternate</key>";
129 EmitString(o, s) << '\n';
133 Indent(o, indent) << "</dict>\n";
136 static void ReportEvent(raw_ostream &o, const PathDiagnosticPiece& P,
138 const SourceManager &SM,
139 const LangOptions &LangOpts,
142 bool isKeyEvent = false) {
144 Indent(o, indent) << "<dict>\n";
147 Indent(o, indent) << "<key>kind</key><string>event</string>\n";
150 Indent(o, indent) << "<key>key_event</key><true/>\n";
153 // Output the location.
154 FullSourceLoc L = P.getLocation().asLocation();
156 Indent(o, indent) << "<key>location</key>\n";
157 EmitLocation(o, SM, L, FM, indent);
159 // Output the ranges (if any).
160 ArrayRef<SourceRange> Ranges = P.getRanges();
162 if (!Ranges.empty()) {
163 Indent(o, indent) << "<key>ranges</key>\n";
164 Indent(o, indent) << "<array>\n";
166 for (auto &R : Ranges)
168 Lexer::getAsCharRange(SM.getExpansionRange(R), SM, LangOpts),
171 Indent(o, indent) << "</array>\n";
174 // Output the call depth.
175 Indent(o, indent) << "<key>depth</key>";
176 EmitInteger(o, depth) << '\n';
179 assert(!P.getString().empty());
180 Indent(o, indent) << "<key>extended_message</key>\n";
182 EmitString(o, P.getString()) << '\n';
184 // Output the short text.
185 // FIXME: Really use a short string.
186 Indent(o, indent) << "<key>message</key>\n";
188 EmitString(o, P.getString()) << '\n';
192 Indent(o, indent); o << "</dict>\n";
195 static void ReportPiece(raw_ostream &o,
196 const PathDiagnosticPiece &P,
197 const FIDMap& FM, const SourceManager &SM,
198 const LangOptions &LangOpts,
201 bool includeControlFlow,
202 bool isKeyEvent = false);
204 static void ReportCall(raw_ostream &o,
205 const PathDiagnosticCallPiece &P,
206 const FIDMap& FM, const SourceManager &SM,
207 const LangOptions &LangOpts,
211 if (auto callEnter = P.getCallEnterEvent())
212 ReportPiece(o, *callEnter, FM, SM, LangOpts, indent, depth, true,
213 P.isLastInMainSourceFile());
218 if (auto callEnterWithinCaller = P.getCallEnterWithinCallerEvent())
219 ReportPiece(o, *callEnterWithinCaller, FM, SM, LangOpts,
220 indent, depth, true);
222 for (PathPieces::const_iterator I = P.path.begin(), E = P.path.end();I!=E;++I)
223 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, true);
227 if (auto callExit = P.getCallExitEvent())
228 ReportPiece(o, *callExit, FM, SM, LangOpts, indent, depth, true);
231 static void ReportMacro(raw_ostream &o,
232 const PathDiagnosticMacroPiece& P,
233 const FIDMap& FM, const SourceManager &SM,
234 const LangOptions &LangOpts,
238 for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end();
240 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, false);
244 static void ReportDiag(raw_ostream &o, const PathDiagnosticPiece& P,
245 const FIDMap& FM, const SourceManager &SM,
246 const LangOptions &LangOpts) {
247 ReportPiece(o, P, FM, SM, LangOpts, 4, 0, true);
250 static void ReportPiece(raw_ostream &o,
251 const PathDiagnosticPiece &P,
252 const FIDMap& FM, const SourceManager &SM,
253 const LangOptions &LangOpts,
256 bool includeControlFlow,
258 switch (P.getKind()) {
259 case PathDiagnosticPiece::ControlFlow:
260 if (includeControlFlow)
261 ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), FM, SM,
264 case PathDiagnosticPiece::Call:
265 ReportCall(o, cast<PathDiagnosticCallPiece>(P), FM, SM, LangOpts,
268 case PathDiagnosticPiece::Event:
269 ReportEvent(o, cast<PathDiagnosticSpotPiece>(P), FM, SM, LangOpts,
270 indent, depth, isKeyEvent);
272 case PathDiagnosticPiece::Macro:
273 ReportMacro(o, cast<PathDiagnosticMacroPiece>(P), FM, SM, LangOpts,
276 case PathDiagnosticPiece::Note:
277 // FIXME: Extend the plist format to support those.
282 void PlistDiagnostics::FlushDiagnosticsImpl(
283 std::vector<const PathDiagnostic *> &Diags,
284 FilesMade *filesMade) {
285 // Build up a set of FIDs that we use by scanning the locations and
286 // ranges of the diagnostics.
288 SmallVector<FileID, 10> Fids;
289 const SourceManager* SM = nullptr;
292 SM = &Diags.front()->path.front()->getLocation().getManager();
294 auto AddPieceFID = [&FM, &Fids, SM](const PathDiagnosticPiece &Piece) {
295 AddFID(FM, Fids, *SM, Piece.getLocation().asLocation());
296 ArrayRef<SourceRange> Ranges = Piece.getRanges();
297 for (const SourceRange &Range : Ranges) {
298 AddFID(FM, Fids, *SM, Range.getBegin());
299 AddFID(FM, Fids, *SM, Range.getEnd());
303 for (const PathDiagnostic *D : Diags) {
305 SmallVector<const PathPieces *, 5> WorkList;
306 WorkList.push_back(&D->path);
308 while (!WorkList.empty()) {
309 const PathPieces &Path = *WorkList.pop_back_val();
311 for (const auto &Iter : Path) {
312 const PathDiagnosticPiece &Piece = *Iter;
315 if (const PathDiagnosticCallPiece *Call =
316 dyn_cast<PathDiagnosticCallPiece>(&Piece)) {
317 if (auto CallEnterWithin = Call->getCallEnterWithinCallerEvent())
318 AddPieceFID(*CallEnterWithin);
320 if (auto CallEnterEvent = Call->getCallEnterEvent())
321 AddPieceFID(*CallEnterEvent);
323 WorkList.push_back(&Call->path);
324 } else if (const PathDiagnosticMacroPiece *Macro =
325 dyn_cast<PathDiagnosticMacroPiece>(&Piece)) {
326 WorkList.push_back(&Macro->subPieces);
334 llvm::raw_fd_ostream o(OutputFile, EC, llvm::sys::fs::F_Text);
336 llvm::errs() << "warning: could not create file: " << EC.message() << '\n';
342 // Write the root object: a <dict> containing...
343 // - "clang_version", the string representation of clang version
344 // - "files", an <array> mapping from FIDs to file names
345 // - "diagnostics", an <array> containing the path diagnostics
347 " <key>clang_version</key>\n";
348 EmitString(o, getClangFullVersion()) << '\n';
349 o << " <key>files</key>\n"
352 for (FileID FID : Fids)
353 EmitString(o << " ", SM->getFileEntryForID(FID)->getName()) << '\n';
356 " <key>diagnostics</key>\n"
359 for (std::vector<const PathDiagnostic*>::iterator DI=Diags.begin(),
360 DE = Diags.end(); DI!=DE; ++DI) {
363 " <key>path</key>\n";
365 const PathDiagnostic *D = *DI;
369 for (PathPieces::const_iterator I = D->path.begin(), E = D->path.end();
371 ReportDiag(o, **I, FM, *SM, LangOpts);
375 // Output the bug type and bug category.
376 o << " <key>description</key>";
377 EmitString(o, D->getShortDescription()) << '\n';
378 o << " <key>category</key>";
379 EmitString(o, D->getCategory()) << '\n';
380 o << " <key>type</key>";
381 EmitString(o, D->getBugType()) << '\n';
382 o << " <key>check_name</key>";
383 EmitString(o, D->getCheckName()) << '\n';
385 o << " <!-- This hash is experimental and going to change! -->\n";
386 o << " <key>issue_hash_content_of_line_in_context</key>";
387 PathDiagnosticLocation UPDLoc = D->getUniqueingLoc();
388 FullSourceLoc L(SM->getExpansionLoc(UPDLoc.isValid()
389 ? UPDLoc.asLocation()
390 : D->getLocation().asLocation()),
392 const Decl *DeclWithIssue = D->getDeclWithIssue();
393 EmitString(o, GetIssueHash(*SM, L, D->getCheckName(), D->getBugType(),
394 DeclWithIssue, LangOpts))
397 // Output information about the semantic context where
398 // the issue occurred.
399 if (const Decl *DeclWithIssue = D->getDeclWithIssue()) {
400 // FIXME: handle blocks, which have no name.
401 if (const NamedDecl *ND = dyn_cast<NamedDecl>(DeclWithIssue)) {
403 switch (ND->getKind()) {
404 case Decl::CXXRecord:
405 declKind = "C++ class";
407 case Decl::CXXMethod:
408 declKind = "C++ method";
410 case Decl::ObjCMethod:
411 declKind = "Objective-C method";
414 declKind = "function";
419 if (!declKind.empty()) {
420 const std::string &declName = ND->getDeclName().getAsString();
421 o << " <key>issue_context_kind</key>";
422 EmitString(o, declKind) << '\n';
423 o << " <key>issue_context</key>";
424 EmitString(o, declName) << '\n';
427 // Output the bug hash for issue unique-ing. Currently, it's just an
428 // offset from the beginning of the function.
429 if (const Stmt *Body = DeclWithIssue->getBody()) {
431 // If the bug uniqueing location exists, use it for the hash.
432 // For example, this ensures that two leaks reported on the same line
433 // will have different issue_hashes and that the hash will identify
434 // the leak location even after code is added between the allocation
435 // site and the end of scope (leak report location).
436 if (UPDLoc.isValid()) {
437 FullSourceLoc UFunL(SM->getExpansionLoc(
438 D->getUniqueingDecl()->getBody()->getLocStart()), *SM);
439 o << " <key>issue_hash_function_offset</key><string>"
440 << L.getExpansionLineNumber() - UFunL.getExpansionLineNumber()
443 // Otherwise, use the location on which the bug is reported.
445 FullSourceLoc FunL(SM->getExpansionLoc(Body->getLocStart()), *SM);
446 o << " <key>issue_hash_function_offset</key><string>"
447 << L.getExpansionLineNumber() - FunL.getExpansionLineNumber()
455 // Output the location of the bug.
456 o << " <key>location</key>\n";
457 EmitLocation(o, *SM, D->getLocation().asLocation(), FM, 2);
459 // Output the diagnostic to the sub-diagnostic client, if any.
460 if (!filesMade->empty()) {
462 PDFileEntry::ConsumerFiles *files = filesMade->getFiles(*D);
464 for (PDFileEntry::ConsumerFiles::const_iterator CI = files->begin(),
465 CE = files->end(); CI != CE; ++CI) {
466 StringRef newName = CI->first;
467 if (newName != lastName) {
468 if (!lastName.empty()) {
472 o << " <key>" << lastName << "_files</key>\n";
475 o << " <string>" << CI->second << "</string>\n";
481 // Close up the entry.
488 o << "</dict>\n</plist>";