[sancov] blacklist support.

[aizatsky]

Summary

Using the blacklist the user can filter own unwanted functions
from all outputs. By default blacklist contains "fun:__sancov*" line.

[aizatsky]

nits

[aizatsky]

nits

[krasin]

LGTM with nits

test/tools/sancov/blacklist.test

3

Please, also add a test case for the default blacklist.

tools/sancov/sancov.cc

88

Do we ever want to see __sancov* functions in the output? Right now, the logic is:

1. If we don't have a blacklist specified, use the default one and suppress __sancov* functions
2. If there's a blacklist specified, exclusively use it, forget about the default one.

It means that the following weird behavior is possible: a user creates a blacklist, puts a function or two there, runs the tool with the blacklist specified and gets *more* output than without --blacklist.

If would rather not have a default blacklist, or always have it. No strong opinion though.

[aizatsky]

review

[aizatsky]

All done, ptal.

[krasin]

LGTM

tools/sancov/sancov.cc

363

FYI: this approach seems error-prone, but it's ok for now.

[aizatsky]

tools/sancov/sancov.cc

363

ACK.

test/tools/sancov/Inputs/blacklist.txt

+fun:bar*

test/tools/sancov/blacklist.test

+REQUIRES: x86_64-linux
+RUN: sancov -obj %p/Inputs/test-linux_x86_64 -covered-functions -blacklist %p/Inputs/blacklist.txt %p/Inputs/test-linux_x86_64.sancov | FileCheck %s
+
+CHECK-NOT: Inputs{{[/\\]}}test.cpp:12 bar(std::string)
+CHECK: Inputs{{[/\\]}}test.cpp:14 main

tools/sancov/sancov.cc

 #include "llvm/Support/ErrorOr.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/LineIterator.h"
 #include "llvm/Support/ManagedStatic.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/PrettyStackTrace.h"
 #include "llvm/Support/Signals.h"
+#include "llvm/Support/SpecialCaseList.h"
 #include "llvm/Support/TargetRegistry.h"
 #include "llvm/Support/TargetSelect.h"
 #include "llvm/Support/ToolOutputFile.h"
 #include "llvm/Support/raw_ostream.h"
 
 #include <set>
 #include <stdio.h>
 #include <string>

 static cl::opt<bool>
     ClDemangle("demangle", cl::init(true),
         cl::desc("Print demangled function name."));
 
 static cl::opt<std::string> ClStripPathPrefix(
     "strip_path_prefix", cl::init(""),
     cl::desc("Strip this prefix from file paths in reports."));
 
+static cl::opt<std::string> ClBlacklist(
+    "blacklist", cl::init(""),
+    cl::desc("Blacklist file (sanitizer blacklist format)."));
+
+static const char *const DefaultBlacklist = "fun:__sancov*";
+
 // --------- FORMAT SPECIFICATION ---------
 
 struct FileHeader {
   uint32_t Bitness;
   uint32_t Magic;
 };
 
 static const uint32_t BinCoverageMagic = 0xC0BFFFFF;
std::set<uint64_t> getCoveragePoints(std::string FileName) {
   else if (object::ObjectFile *O = dyn_cast<object::ObjectFile>(&Binary))
     getObjectCoveragePoints(*O, &Result);
   else
     FailIfError(object::object_error::invalid_file_type);
 
   return Result;
 }
 
+static std::unique_ptr<SpecialCaseList> createBlacklist() {
+  if (!ClBlacklist.empty())
+    return SpecialCaseList::createOrDie({{ClBlacklist}});
+  std::unique_ptr<MemoryBuffer> MB = MemoryBuffer::getMemBuffer(DefaultBlacklist);
+  std::string Error;
+  auto Blacklist = SpecialCaseList::create(MB.get(), Error);
+  FailIfNotEmpty(Error);
+  return Blacklist;
+}
+
 static void printFunctionLocs(const std::set<FunctionLoc> &FnLocs,
                               raw_ostream &OS) {
+  std::unique_ptr<SpecialCaseList> Blacklist = createBlacklist();
+
   for (const FunctionLoc &FnLoc : FnLocs) {
+    if (Blacklist->inSection("fun", FnLoc.FunctionName))
+      continue;
+    if (Blacklist->inSection("src", FnLoc.Loc.FileName))
+      continue;
+
     OS << stripPathPrefix(FnLoc.Loc.FileName) << ":" << FnLoc.Loc.Line << " "
        << FnLoc.FunctionName << "\n";
   }
 }
 
 class CoverageData {
  public:
   // Read single file coverage data.
public:
   }
 
 private:
   explicit CoverageData(std::unique_ptr<std::set<uint64_t>> Addrs)
       : Addrs(std::move(Addrs)) {}
 
   std::unique_ptr<std::set<uint64_t>> Addrs;
 };
+
 } // namespace
 
 int main(int argc, char **argv) {
   // Print stack trace if we signal out.
   sys::PrintStackTraceOnErrorSignal();
   PrettyStackTraceProgram X(argc, argv);
   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.