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/StaticAnalyzer/Core/AnalyzerOptions.h"
15 #include "clang/Basic/FileManager.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/PathDiagnosticConsumers.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/Support/Casting.h"
24 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
28 typedef llvm::DenseMap<FileID, unsigned> FIDMap;
32 class PlistDiagnostics : public PathDiagnosticConsumer {
33 const std::string OutputFile;
34 const LangOptions &LangOpts;
35 const bool SupportsCrossFileDiagnostics;
37 PlistDiagnostics(AnalyzerOptions &AnalyzerOpts,
38 const std::string& prefix,
39 const LangOptions &LangOpts,
40 bool supportsMultipleFiles);
42 virtual ~PlistDiagnostics() {}
44 void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
45 FilesMade *filesMade);
47 virtual StringRef getName() const {
48 return "PlistDiagnostics";
51 PathGenerationScheme getGenerationScheme() const { return Extensive; }
52 bool supportsLogicalOpControlFlow() const { return true; }
53 virtual bool supportsCrossFileDiagnostics() const {
54 return SupportsCrossFileDiagnostics;
57 } // end anonymous namespace
59 PlistDiagnostics::PlistDiagnostics(AnalyzerOptions &AnalyzerOpts,
60 const std::string& output,
61 const LangOptions &LO,
62 bool supportsMultipleFiles)
65 SupportsCrossFileDiagnostics(supportsMultipleFiles) {}
67 void ento::createPlistDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts,
68 PathDiagnosticConsumers &C,
70 const Preprocessor &PP) {
71 C.push_back(new PlistDiagnostics(AnalyzerOpts, s,
72 PP.getLangOpts(), false));
75 void ento::createPlistMultiFileDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts,
76 PathDiagnosticConsumers &C,
78 const Preprocessor &PP) {
79 C.push_back(new PlistDiagnostics(AnalyzerOpts, s,
80 PP.getLangOpts(), true));
83 static void AddFID(FIDMap &FIDs, SmallVectorImpl<FileID> &V,
84 const SourceManager* SM, SourceLocation L) {
86 FileID FID = SM->getFileID(SM->getExpansionLoc(L));
87 FIDMap::iterator I = FIDs.find(FID);
88 if (I != FIDs.end()) return;
93 static unsigned GetFID(const FIDMap& FIDs, const SourceManager &SM,
95 FileID FID = SM.getFileID(SM.getExpansionLoc(L));
96 FIDMap::const_iterator I = FIDs.find(FID);
97 assert(I != FIDs.end());
101 static raw_ostream &Indent(raw_ostream &o, const unsigned indent) {
102 for (unsigned i = 0; i < indent; ++i) o << ' ';
106 static void EmitLocation(raw_ostream &o, const SourceManager &SM,
107 const LangOptions &LangOpts,
108 SourceLocation L, const FIDMap &FM,
109 unsigned indent, bool extend = false) {
111 FullSourceLoc Loc(SM.getExpansionLoc(L), const_cast<SourceManager&>(SM));
113 // Add in the length of the token, so that we cover multi-char tokens.
115 extend ? Lexer::MeasureTokenLength(Loc, SM, LangOpts) - 1 : 0;
117 Indent(o, indent) << "<dict>\n";
118 Indent(o, indent) << " <key>line</key><integer>"
119 << Loc.getExpansionLineNumber() << "</integer>\n";
120 Indent(o, indent) << " <key>col</key><integer>"
121 << Loc.getExpansionColumnNumber() + offset << "</integer>\n";
122 Indent(o, indent) << " <key>file</key><integer>"
123 << GetFID(FM, SM, Loc) << "</integer>\n";
124 Indent(o, indent) << "</dict>\n";
127 static void EmitLocation(raw_ostream &o, const SourceManager &SM,
128 const LangOptions &LangOpts,
129 const PathDiagnosticLocation &L, const FIDMap& FM,
130 unsigned indent, bool extend = false) {
131 EmitLocation(o, SM, LangOpts, L.asLocation(), FM, indent, extend);
134 static void EmitRange(raw_ostream &o, const SourceManager &SM,
135 const LangOptions &LangOpts,
136 PathDiagnosticRange R, const FIDMap &FM,
138 Indent(o, indent) << "<array>\n";
139 EmitLocation(o, SM, LangOpts, R.getBegin(), FM, indent+1);
140 EmitLocation(o, SM, LangOpts, R.getEnd(), FM, indent+1, !R.isPoint);
141 Indent(o, indent) << "</array>\n";
144 static raw_ostream &EmitString(raw_ostream &o, StringRef s) {
146 for (StringRef::const_iterator I = s.begin(), E = s.end(); I != E; ++I) {
149 default: o << c; break;
150 case '&': o << "&"; break;
151 case '<': o << "<"; break;
152 case '>': o << ">"; break;
153 case '\'': o << "'"; break;
154 case '\"': o << """; break;
161 static void ReportControlFlow(raw_ostream &o,
162 const PathDiagnosticControlFlowPiece& P,
164 const SourceManager &SM,
165 const LangOptions &LangOpts,
168 Indent(o, indent) << "<dict>\n";
171 Indent(o, indent) << "<key>kind</key><string>control</string>\n";
174 Indent(o, indent) << "<key>edges</key>\n";
176 Indent(o, indent) << "<array>\n";
178 for (PathDiagnosticControlFlowPiece::const_iterator I=P.begin(), E=P.end();
180 Indent(o, indent) << "<dict>\n";
183 // Make the ranges of the start and end point self-consistent with adjacent edges
184 // by forcing to use only the beginning of the range. This simplifies the layout
185 // logic for clients.
186 Indent(o, indent) << "<key>start</key>\n";
187 SourceLocation StartEdge = I->getStart().asRange().getBegin();
188 EmitRange(o, SM, LangOpts, SourceRange(StartEdge, StartEdge), FM, indent+1);
190 Indent(o, indent) << "<key>end</key>\n";
191 SourceLocation EndEdge = I->getEnd().asRange().getBegin();
192 EmitRange(o, SM, LangOpts, SourceRange(EndEdge, EndEdge), FM, indent+1);
195 Indent(o, indent) << "</dict>\n";
198 Indent(o, indent) << "</array>\n";
201 // Output any helper text.
202 const std::string& s = P.getString();
204 Indent(o, indent) << "<key>alternate</key>";
205 EmitString(o, s) << '\n';
209 Indent(o, indent) << "</dict>\n";
212 static void ReportEvent(raw_ostream &o, const PathDiagnosticPiece& P,
214 const SourceManager &SM,
215 const LangOptions &LangOpts,
218 bool isKeyEvent = false) {
220 Indent(o, indent) << "<dict>\n";
223 Indent(o, indent) << "<key>kind</key><string>event</string>\n";
226 Indent(o, indent) << "<key>key_event</key><true/>\n";
229 // Output the location.
230 FullSourceLoc L = P.getLocation().asLocation();
232 Indent(o, indent) << "<key>location</key>\n";
233 EmitLocation(o, SM, LangOpts, L, FM, indent);
235 // Output the ranges (if any).
236 ArrayRef<SourceRange> Ranges = P.getRanges();
238 if (!Ranges.empty()) {
239 Indent(o, indent) << "<key>ranges</key>\n";
240 Indent(o, indent) << "<array>\n";
242 for (ArrayRef<SourceRange>::iterator I = Ranges.begin(), E = Ranges.end();
244 EmitRange(o, SM, LangOpts, *I, FM, indent+1);
247 Indent(o, indent) << "</array>\n";
250 // Output the call depth.
251 Indent(o, indent) << "<key>depth</key>"
252 << "<integer>" << depth << "</integer>\n";
255 assert(!P.getString().empty());
256 Indent(o, indent) << "<key>extended_message</key>\n";
258 EmitString(o, P.getString()) << '\n';
260 // Output the short text.
261 // FIXME: Really use a short string.
262 Indent(o, indent) << "<key>message</key>\n";
264 EmitString(o, P.getString()) << '\n';
268 Indent(o, indent); o << "</dict>\n";
271 static void ReportPiece(raw_ostream &o,
272 const PathDiagnosticPiece &P,
273 const FIDMap& FM, const SourceManager &SM,
274 const LangOptions &LangOpts,
277 bool includeControlFlow,
278 bool isKeyEvent = false);
280 static void ReportCall(raw_ostream &o,
281 const PathDiagnosticCallPiece &P,
282 const FIDMap& FM, const SourceManager &SM,
283 const LangOptions &LangOpts,
287 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callEnter =
288 P.getCallEnterEvent();
291 ReportPiece(o, *callEnter, FM, SM, LangOpts, indent, depth, true,
292 P.isLastInMainSourceFile());
294 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callEnterWithinCaller =
295 P.getCallEnterWithinCallerEvent();
299 if (callEnterWithinCaller)
300 ReportPiece(o, *callEnterWithinCaller, FM, SM, LangOpts,
301 indent, depth, true);
303 for (PathPieces::const_iterator I = P.path.begin(), E = P.path.end();I!=E;++I)
304 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, true);
308 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callExit =
309 P.getCallExitEvent();
312 ReportPiece(o, *callExit, FM, SM, LangOpts, indent, depth, true);
315 static void ReportMacro(raw_ostream &o,
316 const PathDiagnosticMacroPiece& P,
317 const FIDMap& FM, const SourceManager &SM,
318 const LangOptions &LangOpts,
322 for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end();
324 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, false);
328 static void ReportDiag(raw_ostream &o, const PathDiagnosticPiece& P,
329 const FIDMap& FM, const SourceManager &SM,
330 const LangOptions &LangOpts) {
331 ReportPiece(o, P, FM, SM, LangOpts, 4, 0, true);
334 static void ReportPiece(raw_ostream &o,
335 const PathDiagnosticPiece &P,
336 const FIDMap& FM, const SourceManager &SM,
337 const LangOptions &LangOpts,
340 bool includeControlFlow,
342 switch (P.getKind()) {
343 case PathDiagnosticPiece::ControlFlow:
344 if (includeControlFlow)
345 ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), FM, SM,
348 case PathDiagnosticPiece::Call:
349 ReportCall(o, cast<PathDiagnosticCallPiece>(P), FM, SM, LangOpts,
352 case PathDiagnosticPiece::Event:
353 ReportEvent(o, cast<PathDiagnosticSpotPiece>(P), FM, SM, LangOpts,
354 indent, depth, isKeyEvent);
356 case PathDiagnosticPiece::Macro:
357 ReportMacro(o, cast<PathDiagnosticMacroPiece>(P), FM, SM, LangOpts,
363 void PlistDiagnostics::FlushDiagnosticsImpl(
364 std::vector<const PathDiagnostic *> &Diags,
365 FilesMade *filesMade) {
366 // Build up a set of FIDs that we use by scanning the locations and
367 // ranges of the diagnostics.
369 SmallVector<FileID, 10> Fids;
370 const SourceManager* SM = 0;
373 SM = &(*(*Diags.begin())->path.begin())->getLocation().getManager();
376 for (std::vector<const PathDiagnostic*>::iterator DI = Diags.begin(),
377 DE = Diags.end(); DI != DE; ++DI) {
379 const PathDiagnostic *D = *DI;
381 SmallVector<const PathPieces *, 5> WorkList;
382 WorkList.push_back(&D->path);
384 while (!WorkList.empty()) {
385 const PathPieces &path = *WorkList.pop_back_val();
387 for (PathPieces::const_iterator I = path.begin(), E = path.end(); I != E;
389 const PathDiagnosticPiece *piece = I->getPtr();
390 AddFID(FM, Fids, SM, piece->getLocation().asLocation());
391 ArrayRef<SourceRange> Ranges = piece->getRanges();
392 for (ArrayRef<SourceRange>::iterator I = Ranges.begin(),
393 E = Ranges.end(); I != E; ++I) {
394 AddFID(FM, Fids, SM, I->getBegin());
395 AddFID(FM, Fids, SM, I->getEnd());
398 if (const PathDiagnosticCallPiece *call =
399 dyn_cast<PathDiagnosticCallPiece>(piece)) {
400 IntrusiveRefCntPtr<PathDiagnosticEventPiece>
401 callEnterWithin = call->getCallEnterWithinCallerEvent();
403 AddFID(FM, Fids, SM, callEnterWithin->getLocation().asLocation());
405 WorkList.push_back(&call->path);
407 else if (const PathDiagnosticMacroPiece *macro =
408 dyn_cast<PathDiagnosticMacroPiece>(piece)) {
409 WorkList.push_back(¯o->subPieces);
417 llvm::raw_fd_ostream o(OutputFile.c_str(), ErrMsg);
418 if (!ErrMsg.empty()) {
419 llvm::errs() << "warning: could not create file: " << OutputFile << '\n';
423 // Write the plist header.
424 o << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
425 "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" "
426 "\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
427 "<plist version=\"1.0\">\n";
429 // Write the root object: a <dict> containing...
430 // - "clang_version", the string representation of clang version
431 // - "files", an <array> mapping from FIDs to file names
432 // - "diagnostics", an <array> containing the path diagnostics
434 " <key>clang_version</key>\n";
435 EmitString(o, getClangFullVersion()) << '\n';
436 o << " <key>files</key>\n"
439 for (SmallVectorImpl<FileID>::iterator I=Fids.begin(), E=Fids.end();
442 EmitString(o, SM->getFileEntryForID(*I)->getName()) << '\n';
446 " <key>diagnostics</key>\n"
449 for (std::vector<const PathDiagnostic*>::iterator DI=Diags.begin(),
450 DE = Diags.end(); DI!=DE; ++DI) {
453 " <key>path</key>\n";
455 const PathDiagnostic *D = *DI;
459 for (PathPieces::const_iterator I = D->path.begin(), E = D->path.end();
461 ReportDiag(o, **I, FM, *SM, LangOpts);
465 // Output the bug type and bug category.
466 o << " <key>description</key>";
467 EmitString(o, D->getShortDescription()) << '\n';
468 o << " <key>category</key>";
469 EmitString(o, D->getCategory()) << '\n';
470 o << " <key>type</key>";
471 EmitString(o, D->getBugType()) << '\n';
473 // Output information about the semantic context where
474 // the issue occurred.
475 if (const Decl *DeclWithIssue = D->getDeclWithIssue()) {
476 // FIXME: handle blocks, which have no name.
477 if (const NamedDecl *ND = dyn_cast<NamedDecl>(DeclWithIssue)) {
479 switch (ND->getKind()) {
480 case Decl::CXXRecord:
481 declKind = "C++ class";
483 case Decl::CXXMethod:
484 declKind = "C++ method";
486 case Decl::ObjCMethod:
487 declKind = "Objective-C method";
490 declKind = "function";
495 if (!declKind.empty()) {
496 const std::string &declName = ND->getDeclName().getAsString();
497 o << " <key>issue_context_kind</key>";
498 EmitString(o, declKind) << '\n';
499 o << " <key>issue_context</key>";
500 EmitString(o, declName) << '\n';
503 // Output the bug hash for issue unique-ing. Currently, it's just an
504 // offset from the beginning of the function.
505 if (const Stmt *Body = DeclWithIssue->getBody()) {
507 // If the bug uniqueing location exists, use it for the hash.
508 // For example, this ensures that two leaks reported on the same line
509 // will have different issue_hashes and that the hash will identify
510 // the leak location even after code is added between the allocation
511 // site and the end of scope (leak report location).
512 PathDiagnosticLocation UPDLoc = D->getUniqueingLoc();
513 if (UPDLoc.isValid()) {
514 FullSourceLoc UL(SM->getExpansionLoc(UPDLoc.asLocation()),
516 FullSourceLoc UFunL(SM->getExpansionLoc(
517 D->getUniqueingDecl()->getBody()->getLocStart()), *SM);
518 o << " <key>issue_hash</key><string>"
519 << UL.getExpansionLineNumber() - UFunL.getExpansionLineNumber()
522 // Otherwise, use the location on which the bug is reported.
524 FullSourceLoc L(SM->getExpansionLoc(D->getLocation().asLocation()),
526 FullSourceLoc FunL(SM->getExpansionLoc(Body->getLocStart()), *SM);
527 o << " <key>issue_hash</key><string>"
528 << L.getExpansionLineNumber() - FunL.getExpansionLineNumber()
536 // Output the location of the bug.
537 o << " <key>location</key>\n";
538 EmitLocation(o, *SM, LangOpts, D->getLocation(), FM, 2);
540 // Output the diagnostic to the sub-diagnostic client, if any.
541 if (!filesMade->empty()) {
543 PDFileEntry::ConsumerFiles *files = filesMade->getFiles(*D);
545 for (PDFileEntry::ConsumerFiles::const_iterator CI = files->begin(),
546 CE = files->end(); CI != CE; ++CI) {
547 StringRef newName = CI->first;
548 if (newName != lastName) {
549 if (!lastName.empty()) {
553 o << " <key>" << lastName << "_files</key>\n";
556 o << " <string>" << CI->second << "</string>\n";
562 // Close up the entry.
569 o << "</dict>\n</plist>";