Skip to content

Commit 20efb97

Browse files
committed
Revert "[analyzer] Extend bug reports with extra notes" to fix Windows bot.
This reverts commit r283092. llvm-svn: 283180
1 parent bba7416 commit 20efb97

File tree

10 files changed

+58
-232
lines changed

10 files changed

+58
-232
lines changed

clang/include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -266,9 +266,6 @@ class AnalyzerOptions : public RefCountedBase<AnalyzerOptions> {
266266
/// \sa shouldWidenLoops
267267
Optional<bool> WidenLoops;
268268

269-
/// \sa shouldDisplayNotesAsEvents
270-
Optional<bool> DisplayNotesAsEvents;
271-
272269
/// A helper function that retrieves option for a given full-qualified
273270
/// checker name.
274271
/// Options for checkers can be specified via 'analyzer-config' command-line
@@ -537,14 +534,6 @@ class AnalyzerOptions : public RefCountedBase<AnalyzerOptions> {
537534
/// This is controlled by the 'widen-loops' config option.
538535
bool shouldWidenLoops();
539536

540-
/// Returns true if the bug reporter should transparently treat extra note
541-
/// diagnostic pieces as event diagnostic pieces. Useful when the diagnostic
542-
/// consumer doesn't support the extra note pieces.
543-
///
544-
/// This is controlled by the 'notes-as-events' option, which defaults
545-
/// to false when unset.
546-
bool shouldDisplayNotesAsEvents();
547-
548537
public:
549538
AnalyzerOptions() :
550539
AnalysisStoreOpt(RegionStoreModel),

clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,6 @@ class BugReport : public llvm::ilist_node<BugReport> {
6666
typedef SmallVector<std::unique_ptr<BugReporterVisitor>, 8> VisitorList;
6767
typedef VisitorList::iterator visitor_iterator;
6868
typedef SmallVector<StringRef, 2> ExtraTextList;
69-
typedef SmallVector<llvm::IntrusiveRefCntPtr<PathDiagnosticNotePiece>, 4>
70-
NoteList;
7169

7270
protected:
7371
friend class BugReporter;
@@ -84,8 +82,7 @@ class BugReport : public llvm::ilist_node<BugReport> {
8482
const ExplodedNode *ErrorNode;
8583
SmallVector<SourceRange, 4> Ranges;
8684
ExtraTextList ExtraText;
87-
NoteList Notes;
88-
85+
8986
typedef llvm::DenseSet<SymbolRef> Symbols;
9087
typedef llvm::DenseSet<const MemRegion *> Regions;
9188

@@ -180,18 +177,6 @@ class BugReport : public llvm::ilist_node<BugReport> {
180177
const BugType& getBugType() const { return BT; }
181178
BugType& getBugType() { return BT; }
182179

183-
/// \brief True when the report has an execution path associated with it.
184-
///
185-
/// A report is said to be path-sensitive if it was thrown against a
186-
/// particular exploded node in the path-sensitive analysis graph.
187-
/// Path-sensitive reports have their intermediate path diagnostics
188-
/// auto-generated, perhaps with the help of checker-defined visitors,
189-
/// and may contain extra notes.
190-
/// Path-insensitive reports consist only of a single warning message
191-
/// in a specific location, and perhaps extra notes.
192-
/// Path-sensitive checkers are allowed to throw path-insensitive reports.
193-
bool isPathSensitive() const { return ErrorNode != nullptr; }
194-
195180
const ExplodedNode *getErrorNode() const { return ErrorNode; }
196181

197182
StringRef getDescription() const { return Description; }
@@ -260,27 +245,7 @@ class BugReport : public llvm::ilist_node<BugReport> {
260245
void setDeclWithIssue(const Decl *declWithIssue) {
261246
DeclWithIssue = declWithIssue;
262247
}
263-
264-
/// Add new item to the list of additional notes that need to be attached to
265-
/// this path-insensitive report. If you want to add extra notes to a
266-
/// path-sensitive report, you need to use a BugReporterVisitor because it
267-
/// allows you to specify where exactly in the auto-generated path diagnostic
268-
/// the extra note should appear.
269-
void addNote(StringRef Msg, const PathDiagnosticLocation &Pos,
270-
ArrayRef<SourceRange> Ranges = {}) {
271-
PathDiagnosticNotePiece *P =
272-
new PathDiagnosticNotePiece(Pos, Msg);
273-
274-
for (const auto &R : Ranges)
275-
P->addRange(R);
276-
277-
Notes.push_back(P);
278-
}
279-
280-
virtual const NoteList &getNotes() {
281-
return Notes;
282-
}
283-
248+
284249
/// \brief This allows for addition of meta data to the diagnostic.
285250
///
286251
/// Currently, only the HTMLDiagnosticClient knows how to display it.

clang/include/clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ class PathDiagnosticLocationPair {
336336

337337
class PathDiagnosticPiece : public RefCountedBaseVPTR {
338338
public:
339-
enum Kind { ControlFlow, Event, Macro, Call, Note };
339+
enum Kind { ControlFlow, Event, Macro, Call };
340340
enum DisplayHint { Above, Below };
341341

342342
private:
@@ -452,8 +452,7 @@ class PathDiagnosticSpotPiece : public PathDiagnosticPiece {
452452
void Profile(llvm::FoldingSetNodeID &ID) const override;
453453

454454
static bool classof(const PathDiagnosticPiece *P) {
455-
return P->getKind() == Event || P->getKind() == Macro ||
456-
P->getKind() == Note;
455+
return P->getKind() == Event || P->getKind() == Macro;
457456
}
458457
};
459458

@@ -711,23 +710,6 @@ class PathDiagnosticMacroPiece : public PathDiagnosticSpotPiece {
711710
void Profile(llvm::FoldingSetNodeID &ID) const override;
712711
};
713712

714-
class PathDiagnosticNotePiece: public PathDiagnosticSpotPiece {
715-
public:
716-
PathDiagnosticNotePiece(const PathDiagnosticLocation &Pos, StringRef S,
717-
bool AddPosRange = true)
718-
: PathDiagnosticSpotPiece(Pos, S, Note, AddPosRange) {}
719-
720-
~PathDiagnosticNotePiece() override;
721-
722-
static inline bool classof(const PathDiagnosticPiece *P) {
723-
return P->getKind() == Note;
724-
}
725-
726-
void dump() const override;
727-
728-
void Profile(llvm::FoldingSetNodeID &ID) const override;
729-
};
730-
731713
/// PathDiagnostic - PathDiagnostic objects represent a single path-sensitive
732714
/// diagnostic. It represents an ordered-collection of PathDiagnosticPieces,
733715
/// each which represent the pieces of the path.

clang/lib/Rewrite/HTMLRewrite.cpp

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,6 @@ void html::AddHeaderFooterInternalBuiltinCSS(Rewriter &R, FileID FID,
324324
" .msgT { padding:0x; spacing:0x }\n"
325325
" .msgEvent { background-color:#fff8b4; color:#000000 }\n"
326326
" .msgControl { background-color:#bbbbbb; color:#000000 }\n"
327-
" .msgNote { background-color:#ddeeff; color:#000000 }\n"
328327
" .mrange { background-color:#dfddf3 }\n"
329328
" .mrange { border-bottom:1px solid #6F9DBE }\n"
330329
" .PathIndex { font-weight: bold; padding:0px 5px; "
@@ -344,12 +343,8 @@ void html::AddHeaderFooterInternalBuiltinCSS(Rewriter &R, FileID FID,
344343
" border-collapse: collapse; border-spacing: 0px;\n"
345344
" }\n"
346345
" td.rowname {\n"
347-
" text-align: right;\n"
348-
" vertical-align: top;\n"
349-
" font-weight: bold;\n"
350-
" color:#444444;\n"
351-
" padding-right:2ex;\n"
352-
" }\n"
346+
" text-align:right; font-weight:bold; color:#444444;\n"
347+
" padding-right:2ex; }\n"
353348
"</style>\n</head>\n<body>";
354349

355350
// Generate header

clang/lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -344,10 +344,3 @@ bool AnalyzerOptions::shouldWidenLoops() {
344344
WidenLoops = getBooleanOption("widen-loops", /*Default=*/false);
345345
return WidenLoops.getValue();
346346
}
347-
348-
bool AnalyzerOptions::shouldDisplayNotesAsEvents() {
349-
if (!DisplayNotesAsEvents.hasValue())
350-
DisplayNotesAsEvents =
351-
getBooleanOption("notes-as-events", /*Default=*/false);
352-
return DisplayNotesAsEvents.getValue();
353-
}

clang/lib/StaticAnalyzer/Core/BugReporter.cpp

Lines changed: 18 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ static void removeRedundantMsgs(PathPieces &path) {
112112
path.pop_front();
113113

114114
switch (piece->getKind()) {
115-
case PathDiagnosticPiece::Call:
115+
case clang::ento::PathDiagnosticPiece::Call:
116116
removeRedundantMsgs(cast<PathDiagnosticCallPiece>(piece)->path);
117117
break;
118-
case PathDiagnosticPiece::Macro:
118+
case clang::ento::PathDiagnosticPiece::Macro:
119119
removeRedundantMsgs(cast<PathDiagnosticMacroPiece>(piece)->subPieces);
120120
break;
121-
case PathDiagnosticPiece::ControlFlow:
121+
case clang::ento::PathDiagnosticPiece::ControlFlow:
122122
break;
123-
case PathDiagnosticPiece::Event: {
123+
case clang::ento::PathDiagnosticPiece::Event: {
124124
if (i == N-1)
125125
break;
126126

@@ -140,8 +140,6 @@ static void removeRedundantMsgs(PathPieces &path) {
140140
}
141141
break;
142142
}
143-
case PathDiagnosticPiece::Note:
144-
break;
145143
}
146144
path.push_back(piece);
147145
}
@@ -199,9 +197,6 @@ static bool removeUnneededCalls(PathPieces &pieces, BugReport *R,
199197
}
200198
case PathDiagnosticPiece::ControlFlow:
201199
break;
202-
203-
case PathDiagnosticPiece::Note:
204-
break;
205200
}
206201

207202
pieces.push_back(piece);
@@ -3408,28 +3403,25 @@ void BugReporter::FlushReport(BugReport *exampleReport,
34083403
exampleReport->getUniqueingLocation(),
34093404
exampleReport->getUniqueingDecl()));
34103405

3411-
if (exampleReport->isPathSensitive()) {
3412-
// Generate the full path diagnostic, using the generation scheme
3413-
// specified by the PathDiagnosticConsumer. Note that we have to generate
3414-
// path diagnostics even for consumers which do not support paths, because
3415-
// the BugReporterVisitors may mark this bug as a false positive.
3416-
assert(!bugReports.empty());
3417-
3418-
MaxBugClassSize =
3419-
std::max(bugReports.size(), static_cast<size_t>(MaxBugClassSize));
3406+
MaxBugClassSize = std::max(bugReports.size(),
3407+
static_cast<size_t>(MaxBugClassSize));
34203408

3409+
// Generate the full path diagnostic, using the generation scheme
3410+
// specified by the PathDiagnosticConsumer. Note that we have to generate
3411+
// path diagnostics even for consumers which do not support paths, because
3412+
// the BugReporterVisitors may mark this bug as a false positive.
3413+
if (!bugReports.empty())
34213414
if (!generatePathDiagnostic(*D.get(), PD, bugReports))
34223415
return;
34233416

3424-
MaxValidBugClassSize =
3425-
std::max(bugReports.size(), static_cast<size_t>(MaxValidBugClassSize));
3417+
MaxValidBugClassSize = std::max(bugReports.size(),
3418+
static_cast<size_t>(MaxValidBugClassSize));
34263419

3427-
// Examine the report and see if the last piece is in a header. Reset the
3428-
// report location to the last piece in the main source file.
3429-
AnalyzerOptions &Opts = getAnalyzerOptions();
3430-
if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll)
3431-
D->resetDiagnosticLocationToMainFile();
3432-
}
3420+
// Examine the report and see if the last piece is in a header. Reset the
3421+
// report location to the last piece in the main source file.
3422+
AnalyzerOptions& Opts = getAnalyzerOptions();
3423+
if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll)
3424+
D->resetDiagnosticLocationToMainFile();
34333425

34343426
// If the path is empty, generate a single step path with the location
34353427
// of the issue.
@@ -3442,27 +3434,6 @@ void BugReporter::FlushReport(BugReport *exampleReport,
34423434
D->setEndOfPath(std::move(piece));
34433435
}
34443436

3445-
PathPieces &Pieces = D->getMutablePieces();
3446-
if (getAnalyzerOptions().shouldDisplayNotesAsEvents()) {
3447-
// For path diagnostic consumers that don't support extra notes,
3448-
// we may optionally convert those to path notes.
3449-
for (auto I = exampleReport->getNotes().rbegin(),
3450-
E = exampleReport->getNotes().rend(); I != E; ++I) {
3451-
PathDiagnosticNotePiece *Piece = I->get();
3452-
PathDiagnosticEventPiece *ConvertedPiece =
3453-
new PathDiagnosticEventPiece(Piece->getLocation(),
3454-
Piece->getString());
3455-
for (const auto &R: Piece->getRanges())
3456-
ConvertedPiece->addRange(R);
3457-
3458-
Pieces.push_front(ConvertedPiece);
3459-
}
3460-
} else {
3461-
for (auto I = exampleReport->getNotes().rbegin(),
3462-
E = exampleReport->getNotes().rend(); I != E; ++I)
3463-
Pieces.push_front(*I);
3464-
}
3465-
34663437
// Get the meta data.
34673438
const BugReport::ExtraTextList &Meta = exampleReport->getExtraText();
34683439
for (BugReport::ExtraTextList::const_iterator i = Meta.begin(),
@@ -3547,13 +3518,6 @@ LLVM_DUMP_METHOD void PathDiagnosticMacroPiece::dump() const {
35473518
// FIXME: Print which macro is being invoked.
35483519
}
35493520

3550-
LLVM_DUMP_METHOD void PathDiagnosticNotePiece::dump() const {
3551-
llvm::errs() << "NOTE\n--------------\n";
3552-
llvm::errs() << getString() << "\n";
3553-
llvm::errs() << " ---- at ----\n";
3554-
getLocation().dump();
3555-
}
3556-
35573521
LLVM_DUMP_METHOD void PathDiagnosticLocation::dump() const {
35583522
if (!isValid()) {
35593523
llvm::errs() << "<INVALID>\n";

0 commit comments

Comments
 (0)