1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
|
//===--- PlistDiagnostics.cpp - Plist Diagnostics for Paths -----*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines the PlistDiagnostics object.
//
//===----------------------------------------------------------------------===//
#include "clang/Analysis/IssueHash.h"
#include "clang/Analysis/MacroExpansionContext.h"
#include "clang/Analysis/PathDiagnostic.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/PlistSupport.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/Version.h"
#include "clang/CrossTU/CrossTranslationUnit.h"
#include "clang/Frontend/ASTUnit.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Lex/TokenConcatenation.h"
#include "clang/Rewrite/Core/HTMLRewrite.h"
#include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Support/Casting.h"
#include <memory>
using namespace clang;
using namespace ento;
using namespace markup;
//===----------------------------------------------------------------------===//
// Declarations of helper classes and functions for emitting bug reports in
// plist format.
//===----------------------------------------------------------------------===//
namespace {
class PlistDiagnostics : public PathDiagnosticConsumer {
PathDiagnosticConsumerOptions DiagOpts;
const std::string OutputFile;
const Preprocessor &PP;
const cross_tu::CrossTranslationUnitContext &CTU;
const MacroExpansionContext &MacroExpansions;
const bool SupportsCrossFileDiagnostics;
void printBugPath(llvm::raw_ostream &o, const FIDMap &FM,
const PathPieces &Path);
public:
PlistDiagnostics(PathDiagnosticConsumerOptions DiagOpts,
const std::string &OutputFile, const Preprocessor &PP,
const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions,
bool supportsMultipleFiles);
~PlistDiagnostics() override {}
void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
FilesMade *filesMade) override;
StringRef getName() const override {
return "PlistDiagnostics";
}
PathGenerationScheme getGenerationScheme() const override {
return Extensive;
}
bool supportsLogicalOpControlFlow() const override { return true; }
bool supportsCrossFileDiagnostics() const override {
return SupportsCrossFileDiagnostics;
}
};
} // end anonymous namespace
namespace {
/// A helper class for emitting a single report.
class PlistPrinter {
const FIDMap& FM;
const Preprocessor &PP;
const cross_tu::CrossTranslationUnitContext &CTU;
const MacroExpansionContext &MacroExpansions;
llvm::SmallVector<const PathDiagnosticMacroPiece *, 0> MacroPieces;
public:
PlistPrinter(const FIDMap &FM, const Preprocessor &PP,
const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions)
: FM(FM), PP(PP), CTU(CTU), MacroExpansions(MacroExpansions) {}
void ReportDiag(raw_ostream &o, const PathDiagnosticPiece& P) {
ReportPiece(o, P, /*indent*/ 4, /*depth*/ 0, /*includeControlFlow*/ true);
}
/// Print the expansions of the collected macro pieces.
///
/// Each time ReportDiag is called on a PathDiagnosticMacroPiece (or, if one
/// is found through a call piece, etc), it's subpieces are reported, and the
/// piece itself is collected. Call this function after the entire bugpath
/// was reported.
void ReportMacroExpansions(raw_ostream &o, unsigned indent);
private:
void ReportPiece(raw_ostream &o, const PathDiagnosticPiece &P,
unsigned indent, unsigned depth, bool includeControlFlow,
bool isKeyEvent = false) {
switch (P.getKind()) {
case PathDiagnosticPiece::ControlFlow:
if (includeControlFlow)
ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), indent);
break;
case PathDiagnosticPiece::Call:
ReportCall(o, cast<PathDiagnosticCallPiece>(P), indent,
depth);
break;
case PathDiagnosticPiece::Event:
ReportEvent(o, cast<PathDiagnosticEventPiece>(P), indent, depth,
isKeyEvent);
break;
case PathDiagnosticPiece::Macro:
ReportMacroSubPieces(o, cast<PathDiagnosticMacroPiece>(P), indent,
depth);
break;
case PathDiagnosticPiece::Note:
ReportNote(o, cast<PathDiagnosticNotePiece>(P), indent);
break;
case PathDiagnosticPiece::PopUp:
ReportPopUp(o, cast<PathDiagnosticPopUpPiece>(P), indent);
break;
}
}
void EmitRanges(raw_ostream &o, const ArrayRef<SourceRange> Ranges,
unsigned indent);
void EmitMessage(raw_ostream &o, StringRef Message, unsigned indent);
void EmitFixits(raw_ostream &o, ArrayRef<FixItHint> fixits, unsigned indent);
void ReportControlFlow(raw_ostream &o,
const PathDiagnosticControlFlowPiece& P,
unsigned indent);
void ReportEvent(raw_ostream &o, const PathDiagnosticEventPiece& P,
unsigned indent, unsigned depth, bool isKeyEvent = false);
void ReportCall(raw_ostream &o, const PathDiagnosticCallPiece &P,
unsigned indent, unsigned depth);
void ReportMacroSubPieces(raw_ostream &o, const PathDiagnosticMacroPiece& P,
unsigned indent, unsigned depth);
void ReportNote(raw_ostream &o, const PathDiagnosticNotePiece& P,
unsigned indent);
void ReportPopUp(raw_ostream &o, const PathDiagnosticPopUpPiece &P,
unsigned indent);
};
} // end of anonymous namespace
/// Print coverage information to output stream @c o.
/// May modify the used list of files @c Fids by inserting new ones.
static void printCoverage(const PathDiagnostic *D,
unsigned InputIndentLevel,
SmallVectorImpl<FileID> &Fids,
FIDMap &FM,
llvm::raw_fd_ostream &o);
static Optional<StringRef> getExpandedMacro(
SourceLocation MacroLoc, const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions, const SourceManager &SM);
//===----------------------------------------------------------------------===//
// Methods of PlistPrinter.
//===----------------------------------------------------------------------===//
void PlistPrinter::EmitRanges(raw_ostream &o,
const ArrayRef<SourceRange> Ranges,
unsigned indent) {
if (Ranges.empty())
return;
Indent(o, indent) << "<key>ranges</key>\n";
Indent(o, indent) << "<array>\n";
++indent;
const SourceManager &SM = PP.getSourceManager();
const LangOptions &LangOpts = PP.getLangOpts();
for (auto &R : Ranges)
EmitRange(o, SM,
Lexer::getAsCharRange(SM.getExpansionRange(R), SM, LangOpts),
FM, indent + 1);
--indent;
Indent(o, indent) << "</array>\n";
}
void PlistPrinter::EmitMessage(raw_ostream &o, StringRef Message,
unsigned indent) {
// Output the text.
assert(!Message.empty());
Indent(o, indent) << "<key>extended_message</key>\n";
Indent(o, indent);
EmitString(o, Message) << '\n';
// Output the short text.
// FIXME: Really use a short string.
Indent(o, indent) << "<key>message</key>\n";
Indent(o, indent);
EmitString(o, Message) << '\n';
}
void PlistPrinter::EmitFixits(raw_ostream &o, ArrayRef<FixItHint> fixits,
unsigned indent) {
if (fixits.size() == 0)
return;
const SourceManager &SM = PP.getSourceManager();
const LangOptions &LangOpts = PP.getLangOpts();
Indent(o, indent) << "<key>fixits</key>\n";
Indent(o, indent) << "<array>\n";
for (const auto &fixit : fixits) {
assert(!fixit.isNull());
// FIXME: Add support for InsertFromRange and BeforePreviousInsertion.
assert(!fixit.InsertFromRange.isValid() && "Not implemented yet!");
assert(!fixit.BeforePreviousInsertions && "Not implemented yet!");
Indent(o, indent) << " <dict>\n";
Indent(o, indent) << " <key>remove_range</key>\n";
EmitRange(o, SM, Lexer::getAsCharRange(fixit.RemoveRange, SM, LangOpts),
FM, indent + 2);
Indent(o, indent) << " <key>insert_string</key>";
EmitString(o, fixit.CodeToInsert);
o << "\n";
Indent(o, indent) << " </dict>\n";
}
Indent(o, indent) << "</array>\n";
}
void PlistPrinter::ReportControlFlow(raw_ostream &o,
const PathDiagnosticControlFlowPiece& P,
unsigned indent) {
const SourceManager &SM = PP.getSourceManager();
const LangOptions &LangOpts = PP.getLangOpts();
Indent(o, indent) << "<dict>\n";
++indent;
Indent(o, indent) << "<key>kind</key><string>control</string>\n";
// Emit edges.
Indent(o, indent) << "<key>edges</key>\n";
++indent;
Indent(o, indent) << "<array>\n";
++indent;
for (PathDiagnosticControlFlowPiece::const_iterator I=P.begin(), E=P.end();
I!=E; ++I) {
Indent(o, indent) << "<dict>\n";
++indent;
// Make the ranges of the start and end point self-consistent with adjacent edges
// by forcing to use only the beginning of the range. This simplifies the layout
// logic for clients.
Indent(o, indent) << "<key>start</key>\n";
SourceRange StartEdge(
SM.getExpansionLoc(I->getStart().asRange().getBegin()));
EmitRange(o, SM, Lexer::getAsCharRange(StartEdge, SM, LangOpts), FM,
indent + 1);
Indent(o, indent) << "<key>end</key>\n";
SourceRange EndEdge(SM.getExpansionLoc(I->getEnd().asRange().getBegin()));
EmitRange(o, SM, Lexer::getAsCharRange(EndEdge, SM, LangOpts), FM,
indent + 1);
--indent;
Indent(o, indent) << "</dict>\n";
}
--indent;
Indent(o, indent) << "</array>\n";
--indent;
// Output any helper text.
const auto &s = P.getString();
if (!s.empty()) {
Indent(o, indent) << "<key>alternate</key>";
EmitString(o, s) << '\n';
}
assert(P.getFixits().size() == 0 &&
"Fixits on constrol flow pieces are not implemented yet!");
--indent;
Indent(o, indent) << "</dict>\n";
}
void PlistPrinter::ReportEvent(raw_ostream &o, const PathDiagnosticEventPiece& P,
unsigned indent, unsigned depth,
bool isKeyEvent) {
const SourceManager &SM = PP.getSourceManager();
Indent(o, indent) << "<dict>\n";
++indent;
Indent(o, indent) << "<key>kind</key><string>event</string>\n";
if (isKeyEvent) {
Indent(o, indent) << "<key>key_event</key><true/>\n";
}
// Output the location.
FullSourceLoc L = P.getLocation().asLocation();
Indent(o, indent) << "<key>location</key>\n";
EmitLocation(o, SM, L, FM, indent);
// Output the ranges (if any).
ArrayRef<SourceRange> Ranges = P.getRanges();
EmitRanges(o, Ranges, indent);
// Output the call depth.
Indent(o, indent) << "<key>depth</key>";
EmitInteger(o, depth) << '\n';
// Output the text.
EmitMessage(o, P.getString(), indent);
// Output the fixits.
EmitFixits(o, P.getFixits(), indent);
// Finish up.
--indent;
Indent(o, indent); o << "</dict>\n";
}
void PlistPrinter::ReportCall(raw_ostream &o, const PathDiagnosticCallPiece &P,
unsigned indent,
unsigned depth) {
if (auto callEnter = P.getCallEnterEvent())
ReportPiece(o, *callEnter, indent, depth, /*includeControlFlow*/ true,
P.isLastInMainSourceFile());
++depth;
if (auto callEnterWithinCaller = P.getCallEnterWithinCallerEvent())
ReportPiece(o, *callEnterWithinCaller, indent, depth,
/*includeControlFlow*/ true);
for (PathPieces::const_iterator I = P.path.begin(), E = P.path.end();I!=E;++I)
ReportPiece(o, **I, indent, depth, /*includeControlFlow*/ true);
--depth;
if (auto callExit = P.getCallExitEvent())
ReportPiece(o, *callExit, indent, depth, /*includeControlFlow*/ true);
assert(P.getFixits().size() == 0 &&
"Fixits on call pieces are not implemented yet!");
}
void PlistPrinter::ReportMacroSubPieces(raw_ostream &o,
const PathDiagnosticMacroPiece& P,
unsigned indent, unsigned depth) {
MacroPieces.push_back(&P);
for (PathPieces::const_iterator I = P.subPieces.begin(),
E = P.subPieces.end();
I != E; ++I) {
ReportPiece(o, **I, indent, depth, /*includeControlFlow*/ false);
}
assert(P.getFixits().size() == 0 &&
"Fixits on constrol flow pieces are not implemented yet!");
}
void PlistPrinter::ReportMacroExpansions(raw_ostream &o, unsigned indent) {
for (const PathDiagnosticMacroPiece *P : MacroPieces) {
const SourceManager &SM = PP.getSourceManager();
SourceLocation MacroExpansionLoc =
P->getLocation().asLocation().getExpansionLoc();
const Optional<StringRef> MacroName =
MacroExpansions.getOriginalText(MacroExpansionLoc);
const Optional<StringRef> ExpansionText =
getExpandedMacro(MacroExpansionLoc, CTU, MacroExpansions, SM);
if (!MacroName || !ExpansionText)
continue;
Indent(o, indent) << "<dict>\n";
++indent;
// Output the location.
FullSourceLoc L = P->getLocation().asLocation();
Indent(o, indent) << "<key>location</key>\n";
EmitLocation(o, SM, L, FM, indent);
// Output the ranges (if any).
ArrayRef<SourceRange> Ranges = P->getRanges();
EmitRanges(o, Ranges, indent);
// Output the macro name.
Indent(o, indent) << "<key>name</key>";
EmitString(o, MacroName.value()) << '\n';
// Output what it expands into.
Indent(o, indent) << "<key>expansion</key>";
EmitString(o, ExpansionText.value()) << '\n';
// Finish up.
--indent;
Indent(o, indent);
o << "</dict>\n";
}
}
void PlistPrinter::ReportNote(raw_ostream &o, const PathDiagnosticNotePiece& P,
unsigned indent) {
const SourceManager &SM = PP.getSourceManager();
Indent(o, indent) << "<dict>\n";
++indent;
// Output the location.
FullSourceLoc L = P.getLocation().asLocation();
Indent(o, indent) << "<key>location</key>\n";
EmitLocation(o, SM, L, FM, indent);
// Output the ranges (if any).
ArrayRef<SourceRange> Ranges = P.getRanges();
EmitRanges(o, Ranges, indent);
// Output the text.
EmitMessage(o, P.getString(), indent);
// Output the fixits.
EmitFixits(o, P.getFixits(), indent);
// Finish up.
--indent;
Indent(o, indent); o << "</dict>\n";
}
void PlistPrinter::ReportPopUp(raw_ostream &o,
const PathDiagnosticPopUpPiece &P,
unsigned indent) {
const SourceManager &SM = PP.getSourceManager();
Indent(o, indent) << "<dict>\n";
++indent;
Indent(o, indent) << "<key>kind</key><string>pop-up</string>\n";
// Output the location.
FullSourceLoc L = P.getLocation().asLocation();
Indent(o, indent) << "<key>location</key>\n";
EmitLocation(o, SM, L, FM, indent);
// Output the ranges (if any).
ArrayRef<SourceRange> Ranges = P.getRanges();
EmitRanges(o, Ranges, indent);
// Output the text.
EmitMessage(o, P.getString(), indent);
assert(P.getFixits().size() == 0 &&
"Fixits on pop-up pieces are not implemented yet!");
// Finish up.
--indent;
Indent(o, indent) << "</dict>\n";
}
//===----------------------------------------------------------------------===//
// Static function definitions.
//===----------------------------------------------------------------------===//
/// Print coverage information to output stream @c o.
/// May modify the used list of files @c Fids by inserting new ones.
static void printCoverage(const PathDiagnostic *D,
unsigned InputIndentLevel,
SmallVectorImpl<FileID> &Fids,
FIDMap &FM,
llvm::raw_fd_ostream &o) {
unsigned IndentLevel = InputIndentLevel;
Indent(o, IndentLevel) << "<key>ExecutedLines</key>\n";
Indent(o, IndentLevel) << "<dict>\n";
IndentLevel++;
// Mapping from file IDs to executed lines.
const FilesToLineNumsMap &ExecutedLines = D->getExecutedLines();
for (auto I = ExecutedLines.begin(), E = ExecutedLines.end(); I != E; ++I) {
unsigned FileKey = AddFID(FM, Fids, I->first);
Indent(o, IndentLevel) << "<key>" << FileKey << "</key>\n";
Indent(o, IndentLevel) << "<array>\n";
IndentLevel++;
for (unsigned LineNo : I->second) {
Indent(o, IndentLevel);
EmitInteger(o, LineNo) << "\n";
}
IndentLevel--;
Indent(o, IndentLevel) << "</array>\n";
}
IndentLevel--;
Indent(o, IndentLevel) << "</dict>\n";
assert(IndentLevel == InputIndentLevel);
}
//===----------------------------------------------------------------------===//
// Methods of PlistDiagnostics.
//===----------------------------------------------------------------------===//
PlistDiagnostics::PlistDiagnostics(
PathDiagnosticConsumerOptions DiagOpts, const std::string &output,
const Preprocessor &PP, const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions, bool supportsMultipleFiles)
: DiagOpts(std::move(DiagOpts)), OutputFile(output), PP(PP), CTU(CTU),
MacroExpansions(MacroExpansions),
SupportsCrossFileDiagnostics(supportsMultipleFiles) {
// FIXME: Will be used by a later planned change.
(void)this->CTU;
}
void ento::createPlistDiagnosticConsumer(
PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
const std::string &OutputFile, const Preprocessor &PP,
const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions) {
// TODO: Emit an error here.
if (OutputFile.empty())
return;
C.push_back(new PlistDiagnostics(DiagOpts, OutputFile, PP, CTU,
MacroExpansions,
/*supportsMultipleFiles=*/false));
createTextMinimalPathDiagnosticConsumer(std::move(DiagOpts), C, OutputFile,
PP, CTU, MacroExpansions);
}
void ento::createPlistMultiFileDiagnosticConsumer(
PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
const std::string &OutputFile, const Preprocessor &PP,
const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions) {
// TODO: Emit an error here.
if (OutputFile.empty())
return;
C.push_back(new PlistDiagnostics(DiagOpts, OutputFile, PP, CTU,
MacroExpansions,
/*supportsMultipleFiles=*/true));
createTextMinimalPathDiagnosticConsumer(std::move(DiagOpts), C, OutputFile,
PP, CTU, MacroExpansions);
}
void PlistDiagnostics::printBugPath(llvm::raw_ostream &o, const FIDMap &FM,
const PathPieces &Path) {
PlistPrinter Printer(FM, PP, CTU, MacroExpansions);
assert(std::is_partitioned(Path.begin(), Path.end(),
[](const PathDiagnosticPieceRef &E) {
return E->getKind() == PathDiagnosticPiece::Note;
}) &&
"PathDiagnostic is not partitioned so that notes precede the rest");
PathPieces::const_iterator FirstNonNote = std::partition_point(
Path.begin(), Path.end(), [](const PathDiagnosticPieceRef &E) {
return E->getKind() == PathDiagnosticPiece::Note;
});
PathPieces::const_iterator I = Path.begin();
if (FirstNonNote != Path.begin()) {
o << " <key>notes</key>\n"
" <array>\n";
for (; I != FirstNonNote; ++I)
Printer.ReportDiag(o, **I);
o << " </array>\n";
}
o << " <key>path</key>\n";
o << " <array>\n";
for (PathPieces::const_iterator E = Path.end(); I != E; ++I)
Printer.ReportDiag(o, **I);
o << " </array>\n";
if (!DiagOpts.ShouldDisplayMacroExpansions)
return;
o << " <key>macro_expansions</key>\n"
" <array>\n";
Printer.ReportMacroExpansions(o, /* indent */ 4);
o << " </array>\n";
}
void PlistDiagnostics::FlushDiagnosticsImpl(
std::vector<const PathDiagnostic *> &Diags,
FilesMade *filesMade) {
// Build up a set of FIDs that we use by scanning the locations and
// ranges of the diagnostics.
FIDMap FM;
SmallVector<FileID, 10> Fids;
const SourceManager& SM = PP.getSourceManager();
const LangOptions &LangOpts = PP.getLangOpts();
auto AddPieceFID = [&FM, &Fids, &SM](const PathDiagnosticPiece &Piece) {
AddFID(FM, Fids, SM, Piece.getLocation().asLocation());
ArrayRef<SourceRange> Ranges = Piece.getRanges();
for (const SourceRange &Range : Ranges) {
AddFID(FM, Fids, SM, Range.getBegin());
AddFID(FM, Fids, SM, Range.getEnd());
}
};
for (const PathDiagnostic *D : Diags) {
SmallVector<const PathPieces *, 5> WorkList;
WorkList.push_back(&D->path);
while (!WorkList.empty()) {
const PathPieces &Path = *WorkList.pop_back_val();
for (const auto &Iter : Path) {
const PathDiagnosticPiece &Piece = *Iter;
AddPieceFID(Piece);
if (const PathDiagnosticCallPiece *Call =
dyn_cast<PathDiagnosticCallPiece>(&Piece)) {
if (auto CallEnterWithin = Call->getCallEnterWithinCallerEvent())
AddPieceFID(*CallEnterWithin);
if (auto CallEnterEvent = Call->getCallEnterEvent())
AddPieceFID(*CallEnterEvent);
WorkList.push_back(&Call->path);
} else if (const PathDiagnosticMacroPiece *Macro =
dyn_cast<PathDiagnosticMacroPiece>(&Piece)) {
WorkList.push_back(&Macro->subPieces);
}
}
}
}
// Open the file.
std::error_code EC;
llvm::raw_fd_ostream o(OutputFile, EC, llvm::sys::fs::OF_TextWithCRLF);
if (EC) {
llvm::errs() << "warning: could not create file: " << EC.message() << '\n';
return;
}
EmitPlistHeader(o);
// Write the root object: a <dict> containing...
// - "clang_version", the string representation of clang version
// - "files", an <array> mapping from FIDs to file names
// - "diagnostics", an <array> containing the path diagnostics
o << "<dict>\n" <<
" <key>clang_version</key>\n";
EmitString(o, getClangFullVersion()) << '\n';
o << " <key>diagnostics</key>\n"
" <array>\n";
for (std::vector<const PathDiagnostic*>::iterator DI=Diags.begin(),
DE = Diags.end(); DI!=DE; ++DI) {
o << " <dict>\n";
const PathDiagnostic *D = *DI;
printBugPath(o, FM, D->path);
// Output the bug type and bug category.
o << " <key>description</key>";
EmitString(o, D->getShortDescription()) << '\n';
o << " <key>category</key>";
EmitString(o, D->getCategory()) << '\n';
o << " <key>type</key>";
EmitString(o, D->getBugType()) << '\n';
o << " <key>check_name</key>";
EmitString(o, D->getCheckerName()) << '\n';
o << " <!-- This hash is experimental and going to change! -->\n";
o << " <key>issue_hash_content_of_line_in_context</key>";
PathDiagnosticLocation UPDLoc = D->getUniqueingLoc();
FullSourceLoc L(SM.getExpansionLoc(UPDLoc.isValid()
? UPDLoc.asLocation()
: D->getLocation().asLocation()),
SM);
const Decl *DeclWithIssue = D->getDeclWithIssue();
EmitString(o, getIssueHash(L, D->getCheckerName(), D->getBugType(),
DeclWithIssue, LangOpts))
<< '\n';
// Output information about the semantic context where
// the issue occurred.
if (const Decl *DeclWithIssue = D->getDeclWithIssue()) {
// FIXME: handle blocks, which have no name.
if (const NamedDecl *ND = dyn_cast<NamedDecl>(DeclWithIssue)) {
StringRef declKind;
switch (ND->getKind()) {
case Decl::CXXRecord:
declKind = "C++ class";
break;
case Decl::CXXMethod:
declKind = "C++ method";
break;
case Decl::ObjCMethod:
declKind = "Objective-C method";
break;
case Decl::Function:
declKind = "function";
break;
default:
break;
}
if (!declKind.empty()) {
const std::string &declName = ND->getDeclName().getAsString();
o << " <key>issue_context_kind</key>";
EmitString(o, declKind) << '\n';
o << " <key>issue_context</key>";
EmitString(o, declName) << '\n';
}
// Output the bug hash for issue unique-ing. Currently, it's just an
// offset from the beginning of the function.
if (const Stmt *Body = DeclWithIssue->getBody()) {
// If the bug uniqueing location exists, use it for the hash.
// For example, this ensures that two leaks reported on the same line
// will have different issue_hashes and that the hash will identify
// the leak location even after code is added between the allocation
// site and the end of scope (leak report location).
if (UPDLoc.isValid()) {
FullSourceLoc UFunL(
SM.getExpansionLoc(
D->getUniqueingDecl()->getBody()->getBeginLoc()),
SM);
o << " <key>issue_hash_function_offset</key><string>"
<< L.getExpansionLineNumber() - UFunL.getExpansionLineNumber()
<< "</string>\n";
// Otherwise, use the location on which the bug is reported.
} else {
FullSourceLoc FunL(SM.getExpansionLoc(Body->getBeginLoc()), SM);
o << " <key>issue_hash_function_offset</key><string>"
<< L.getExpansionLineNumber() - FunL.getExpansionLineNumber()
<< "</string>\n";
}
}
}
}
// Output the location of the bug.
o << " <key>location</key>\n";
EmitLocation(o, SM, D->getLocation().asLocation(), FM, 2);
// Output the diagnostic to the sub-diagnostic client, if any.
if (!filesMade->empty()) {
StringRef lastName;
PDFileEntry::ConsumerFiles *files = filesMade->getFiles(*D);
if (files) {
for (PDFileEntry::ConsumerFiles::const_iterator CI = files->begin(),
CE = files->end(); CI != CE; ++CI) {
StringRef newName = CI->first;
if (newName != lastName) {
if (!lastName.empty()) {
o << " </array>\n";
}
lastName = newName;
o << " <key>" << lastName << "_files</key>\n";
o << " <array>\n";
}
o << " <string>" << CI->second << "</string>\n";
}
o << " </array>\n";
}
}
printCoverage(D, /*IndentLevel=*/2, Fids, FM, o);
// Close up the entry.
o << " </dict>\n";
}
o << " </array>\n";
o << " <key>files</key>\n"
" <array>\n";
for (FileID FID : Fids)
EmitString(o << " ", SM.getFileEntryForID(FID)->getName()) << '\n';
o << " </array>\n";
if (llvm::AreStatisticsEnabled() && DiagOpts.ShouldSerializeStats) {
o << " <key>statistics</key>\n";
std::string stats;
llvm::raw_string_ostream os(stats);
llvm::PrintStatisticsJSON(os);
os.flush();
EmitString(o, html::EscapeText(stats)) << '\n';
}
// Finish.
o << "</dict>\n</plist>\n";
}
//===----------------------------------------------------------------------===//
// Definitions of helper functions and methods for expanding macros.
//===----------------------------------------------------------------------===//
static Optional<StringRef>
getExpandedMacro(SourceLocation MacroExpansionLoc,
const cross_tu::CrossTranslationUnitContext &CTU,
const MacroExpansionContext &MacroExpansions,
const SourceManager &SM) {
if (auto CTUMacroExpCtx =
CTU.getMacroExpansionContextForSourceLocation(MacroExpansionLoc)) {
return CTUMacroExpCtx->getExpandedText(MacroExpansionLoc);
}
return MacroExpansions.getExpandedText(MacroExpansionLoc);
}
|