[analyzer] Mark lines as relevant even if they weren't executed but have a label attached

[george.karpenkov]

Summary

"relevant lines" set was previously empty for path-insensitive checkers for which no lines were "executed".
In that case, we should still mark a single line with the warning as "relevant".

[NoQ]

Fair enough^^

lib/StaticAnalyzer/Core/HTMLDiagnostics.cpp

 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
 #include "clang/StaticAnalyzer/Core/IssueHash.h"
 #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
 #include "llvm/Support/Errc.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/raw_ostream.h"
+#include <map>
+#include <set>
 #include <sstream>
 
 using namespace clang;
 using namespace ento;
 
 //===----------------------------------------------------------------------===//
 // Boilerplate.
 //===----------------------------------------------------------------------===//
public:
   // Rewrite the file specified by FID with HTML formatting.
   void RewriteFile(Rewriter &R, const SourceManager& SMgr,
                    const PathPieces& path, FileID FID);
 
   /// \return Javascript for navigating the HTML report using j/k keys.
   std::string generateKeyboardNavigationJavascript();
 
 private:
-  /// \return JavaScript for an option to only show relevant lines.
-  std::string showRelevantLinesJavascript(const PathDiagnostic &D);
-
-  /// \return Executed lines from \p D in JSON format.
-  std::string serializeExecutedLines(const PathDiagnostic &D);
 
   /// \return Javascript for displaying shortcuts help;
   std::string showHelpJavascript();
 };
 
 } // end anonymous namespace
 
 HTMLDiagnostics::HTMLDiagnostics(AnalyzerOptions &AnalyzerOpts,
std::string HTMLDiagnostics::GenerateHTML(const PathDiagnostic& D, Rewriter &R,
   std::string file;
   llvm::raw_string_ostream os(file);
   for (auto BI : *Buf)
     os << BI;
 
   return os.str();
 }
 
+/// Write executed lines from \p D in JSON format into \p os.
+static void serializeExecutedLines(
+    const PathDiagnostic &D,
+    const PathPieces &path,
+    llvm::raw_string_ostream &os) {
+
+  // Copy executed lines from path diagnostics.
+  std::map<unsigned, std::set<unsigned>> ExecutedLines;
+  for (auto I = D.executedLines_begin(),
+            E = D.executedLines_end(); I != E; ++I) {
+    std::set<unsigned> &LinesInFile = ExecutedLines[I->first];
+    for (unsigned LineNo : I->second) {
+      LinesInFile.insert(LineNo);
+    }
+  }
+
+  // We need to include all lines for which any kind of diagnostics appears.
+  for (const auto &P : path) {
+    FullSourceLoc Loc = P->getLocation().asLocation().getExpansionLoc();
+    FileID FID = Loc.getFileID();
+    unsigned LineNo = Loc.getLineNumber();
+    ExecutedLines[FID.getHashValue()].insert(LineNo);
+  }
+
+  os << "var relevant_lines = {";
+  for (auto I = ExecutedLines.begin(),
+            E = ExecutedLines.end(); I != E; ++I) {
+    if (I != ExecutedLines.begin())
+      os << ", ";
+
+    os << "\"" << I->first << "\": {";
+    for (unsigned LineNo : I->second) {
+      if (LineNo != *(I->second.begin()))
+        os << ", ";
+
+      os << "\"" << LineNo << "\": 1";
+    }
+    os << "}";
+  }
+
+  os << "};";
+}
+
+/// \return JavaScript for an option to only show relevant lines.
+static std::string showRelevantLinesJavascript(
+      const PathDiagnostic &D, const PathPieces &path) {
+  std::string s;
+  llvm::raw_string_ostream os(s);
+  os << "<script type='text/javascript'>\n";
+  serializeExecutedLines(D, path, os);
+  os << R"<<<(
+
+var filterCounterexample = function (hide) {
+  var tables = document.getElementsByClassName("code");
+  for (var t=0; t<tables.length; t++) {
+    var table = tables[t];
+    var file_id = table.getAttribute("data-fileid");
+    var lines_in_fid = relevant_lines[file_id];
+    if (!lines_in_fid) {
+      lines_in_fid = {};
+    }
+    var lines = table.getElementsByClassName("codeline");
+    for (var i=0; i<lines.length; i++) {
+        var el = lines[i];
+        var lineNo = el.getAttribute("data-linenumber");
+        if (!lines_in_fid[lineNo]) {
+          if (hide) {
+            el.setAttribute("hidden", "");
+          } else {
+            el.removeAttribute("hidden");
+          }
+        }
+    }
+  }
+}
+
+window.addEventListener("keydown", function (event) {
+  if (event.defaultPrevented) {
+    return;
+  }
+  if (event.key == "S") {
+    var checked = document.getElementsByName("showCounterexample")[0].checked;
+    filterCounterexample(!checked);
+    document.getElementsByName("showCounterexample")[0].checked = !checked;
+  } else {
+    return;
+  }
+  event.preventDefault();
+}, true);
+
+document.addEventListener("DOMContentLoaded", function() {
+    document.querySelector('input[name="showCounterexample"]').onchange=
+        function (event) {
+      filterCounterexample(this.checked);
+    };
+});
+</script>
+
+<form>
+    <input type="checkbox" name="showCounterexample" id="showCounterexample" />
+    <label for="showCounterexample">
+       Show only relevant lines
+    </label>
+</form>
+)<<<";
+
+  return os.str();
+}
+
 void HTMLDiagnostics::FinalizeHTML(const PathDiagnostic& D, Rewriter &R,
     const SourceManager& SMgr, const PathPieces& path, FileID FID,
     const FileEntry *Entry, const char *declName) {
   // This is a cludge; basically we want to append either the full
   // working directory if we have no directory information.  This is
   // a work in progress.
 
   llvm::SmallString<0> DirName;
 
   if (llvm::sys::path::is_relative(Entry->getName())) {
     llvm::sys::fs::current_path(DirName);
     DirName += '/';
   }
 
   int LineNumber = path.back()->getLocation().asLocation().getExpansionLineNumber();
   int ColumnNumber = path.back()->getLocation().asLocation().getExpansionColumnNumber();
 
   R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), showHelpJavascript());
 
   R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
                      generateKeyboardNavigationJavascript());
 
   // Checkbox and javascript for filtering the output to the counterexample.
   R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
-                     showRelevantLinesJavascript(D));
+                     showRelevantLinesJavascript(D, path));
 
   // Add the name of the file as an <h1> tag.
   {
     std::string s;
     llvm::raw_string_ostream os(s);
 
     os << "<!-- REPORTHEADER -->\n"
        << "<h3>Bug Summary</h3>\n<table class=\"simpletable\">\n"
if (event.key == "?") {
     return;
   }
   event.preventDefault();
 });
 </script>
 )<<<";
 }
 
-std::string
-HTMLDiagnostics::showRelevantLinesJavascript(const PathDiagnostic &D) {
-  std::string s;
-  llvm::raw_string_ostream os(s);
-  os << "<script type='text/javascript'>\n";
-  os << serializeExecutedLines(D);
-  os << R"<<<(
-
-var filterCounterexample = function (hide) {
-  var tables = document.getElementsByClassName("code");
-  for (var t=0; t<tables.length; t++) {
-    var table = tables[t];
-    var file_id = table.getAttribute("data-fileid");
-    var lines_in_fid = relevant_lines[file_id];
-    if (!lines_in_fid) {
-      lines_in_fid = {};
-    }
-    var lines = table.getElementsByClassName("codeline");
-    for (var i=0; i<lines.length; i++) {
-        var el = lines[i];
-        var lineNo = el.getAttribute("data-linenumber");
-        if (!lines_in_fid[lineNo]) {
-          if (hide) {
-            el.setAttribute("hidden", "");
-          } else {
-            el.removeAttribute("hidden");
-          }
-        }
-    }
-  }
-}
-
-window.addEventListener("keydown", function (event) {
-  if (event.defaultPrevented) {
-    return;
-  }
-  if (event.key == "S") {
-    var checked = document.getElementsByName("showCounterexample")[0].checked;
-    filterCounterexample(!checked);
-    document.getElementsByName("showCounterexample")[0].checked = !checked;
-  } else {
-    return;
-  } 
-  event.preventDefault();
-}, true);
-
-document.addEventListener("DOMContentLoaded", function() {
-    document.querySelector('input[name="showCounterexample"]').onchange=
-        function (event) {
-      filterCounterexample(this.checked);
-    };
-});
-</script>
-
-<form>
-    <input type="checkbox" name="showCounterexample" />
-    <label for="showCounterexample">
-       Show only relevant lines
-    </label>
-</form>
-)<<<";
-
-  return os.str();
-}
-
-std::string HTMLDiagnostics::serializeExecutedLines(const PathDiagnostic &D) {
-  std::string s;
-  llvm::raw_string_ostream os(s);
-  os << "var relevant_lines = {";
-  for (auto I = D.executedLines_begin(),
-            E = D.executedLines_end(); I != E; ++I) {
-    if (I != D.executedLines_begin())
-      os << ", ";
 
-    os << "\"" << I->first << "\": {";
-    for (unsigned LineNo : I->second) {
-      if (LineNo != *(I->second.begin()))
-        os << ", ";
-
-      os << "\"" << LineNo << "\": 1";
-    }
-    os << "}";
-  }
 
-  os << "};";
-  return os.str();
-}
 
 void HTMLDiagnostics::RewriteFile(Rewriter &R, const SourceManager& SMgr,
     const PathPieces& path, FileID FID) {
   // Process the path.
   // Maintain the counts of extra note pieces separately.
   unsigned TotalPieces = path.size();
   unsigned TotalNotePieces =
       std::count_if(path.begin(), path.end(),
if (event.defaultPrevented) {
     return;
   }
   if (event.key == "j") {
     navigateTo(/*up=*/false);
   } else if (event.key == "k") {
     navigateTo(/*up=*/true);
   } else {
     return;
-  } 
+  }
   event.preventDefault();
 }, true);
 </script>
   )<<<";
 }

test/Analysis/html_diagnostics/relevant_lines/notexecutedlines.c

+int f() {
+  int zzz = 200;
+  zzz += 100;
+  return 0;
+}
+
+// Show line with the warning even if it wasn't executed (e.g. warning given
+// by path-insensitive analysis).
+// RUN: rm -rf %t.output
+// RUN: %clang_analyze_cc1 -analyze -analyzer-checker=core,deadcode -analyzer-output html -o %t.output %s
+// RUN: cat %t.output/* | FileCheck %s --match-full-lines
+// CHECK: var relevant_lines = {"1": {"3": 1}};