[sancov] generating html report on coverage dump

[aizatsky]

Summary

If html_cov_report is set and sancov binary is found, the html report would be generated automatically on coverage dump.

[aizatsky]

cleanup round.

[aizatsky]

nits

[kcc]

lib/sanitizer_common/sanitizer_common.cc

426 ↗

(On Diff #45602)

remove {}

lib/sanitizer_common/sanitizer_common_nolibc.cc

27 ↗

(On Diff #45602)

this is gross :)
Put the stubs into windows and mac files instead

lib/sanitizer_common/sanitizer_coverage_libcdep.cc

812

you need InternalScopedString

854

put this into a separate function

[kcc]

also, StartSubprocess deserves a separate test

[aizatsky]

I've merged in subprocess changes. Please take another look.

[aizatsky]

extracted function.

[samsonov]

lib/sanitizer_common/sanitizer_coverage_libcdep.cc

787

Consider adding an early return here instead

if (!common_flags()->html_cov_report || sancov_args[0] == nullptr)

800

Don't you want to log unsuccessful attempt to generate html?

lib/sanitizer_common/sanitizer_flags.inc

206

Is sancov_path more appropriate flag name?

test/asan/lit.cfg

144

I think you should use llvm_tools_dir instead. See the way it's handled in test/lit.common.cfg: probably you want to add this functionality there. Also, as LLVM tools directory is in PATH, auto-discovery of "sancov" binary must work in the lit test (in the same way we auto-discover llvm-symbolizer).

147

You have to explicitly add dependency on "sancov" binary from sanitizer test suites: see test/CMakeLists.txt

[aizatsky]

review

[aizatsky]

all done.

lib/sanitizer_common/sanitizer_coverage_libcdep.cc

800

StartSubprocess & WaitForPid have logging inside. I was relying on those.

[aizatsky]

clang-format

[samsonov]

Looks reasonsable to me. I'll let Kostya sign this off.

test/asan/TestCases/Posix/coverage_html_report.cc

7

Will this test work even if you don't provide sancov=%sancovcc explicitly?

25

Should this also be [[PID]].html ?

[aizatsky]

test/asan/TestCases/Posix/coverage_html_report.cc

7

it does

25

It's a different invocation of FileCheck. Unfortunately PID is not available here.

[aizatsky]

removed explicit tool path

[samsonov]

LGTM

test/asan/TestCases/Posix/coverage_html_report.cc

25

Ack.

[aizatsky]

Thank you for review.

lib/sanitizer_common/sanitizer_common.h

 // in parent process even in case of an error.
 // The child process will close all fds after STDERR_FILENO
 // before passing control to a program.
 pid_t StartSubprocess(const char *filename, const char *const argv[],
                       fd_t stdin_fd = kInvalidFd, fd_t stdout_fd = kInvalidFd,
                       fd_t stderr_fd = kInvalidFd);
 // Checks if specified process is still running
 bool IsProcessRunning(pid_t pid);
+// Waits for the process to finish and returns its exit code.
+// Returns -1 in case of an error.
+int WaitForProcess(pid_t pid);
 
 u32 GetUid();
 void ReExec();
 char **GetArgv();
 void PrintCmdline();
 bool StackSizeIsUnlimited();
 void SetStackSizeLimitInBytes(uptr limit);
 bool AddressSpaceIsUnlimited();

lib/sanitizer_common/sanitizer_coverage_libcdep.cc

void CoverageData::GetRangeOffsets(const NamedPcRange& r, Symbolizer* sym,
   }
 
   CHECK_GE(offsets->size(), kNumWordsForMagic);
   SortArray(offsets->data(), offsets->size());
   for (uptr i = 0; i < offsets->size(); i++)
     (*offsets)[i] = UnbundlePc((*offsets)[i]);
 }
 
+static void GenerateHtmlReport(const InternalMmapVector<char *> &sancov_argv) {
+  if (!common_flags()->html_cov_report || sancov_argv[0] == nullptr) {
+    return;
+  }
+
+  InternalScopedString report_path(kMaxPathLength);
+  fd_t report_fd =
+    CovOpenFile(&report_path, false /* packed */, GetProcessName(), "html");
+  int pid = StartSubprocess(sancov_argv[0], sancov_argv.data(),
+      kInvalidFd /* stdin */, report_fd /* std_out */);
+  if (pid > 0) {
+    int result = WaitForProcess(pid);
+    if (result == 0) {
+      VReport(1, " CovDump: html report generated to %s (%d)\n",
+          report_path.data(), result);
+    }
+  }
+}
+
 void CoverageData::DumpOffsets() {
   auto sym = Symbolizer::GetOrInit();
   if (!common_flags()->coverage_pcs) return;
   CHECK_NE(sym, nullptr);
   InternalMmapVector<uptr> offsets(0);
   InternalScopedString path(kMaxPathLength);
+
+  InternalMmapVector<char *> sancov_argv(module_name_vec.size() + 2);
+  sancov_argv.push_back(FindPathToBinary(common_flags()->sancov_path));
+  sancov_argv.push_back(internal_strdup("-obj"));
+  sancov_argv.push_back(internal_strdup(GetArgv()[0]));
+  sancov_argv.push_back(internal_strdup("-html-report"));
+  auto argv_deleter = at_scope_exit([&] {
+    for (uptr i = 0; i < sancov_argv.size(); ++i) {
+      InternalFree(sancov_argv[i]);
+    }
+  });
+
   for (uptr m = 0; m < module_name_vec.size(); m++) {
     auto r = module_name_vec[m];
     GetRangeOffsets(r, sym, &offsets);
 
     uptr num_offsets = offsets.size() - kNumWordsForMagic;
     u64 *magic_p = reinterpret_cast<u64*>(offsets.data());
     CHECK_EQ(*magic_p, 0ULL);
     // FIXME: we may want to write 32-bit offsets even in 64-mode
     // if all the offsets are small enough.
     *magic_p = kMagic;
 
     const char *module_name = StripModuleName(r.copied_module_name);
     if (cov_sandboxed) {
       if (cov_fd != kInvalidFd) {
         CovWritePacked(internal_getpid(), module_name, offsets.data(),
                        offsets.size() * sizeof(offsets[0]));
         VReport(1, " CovDump: %zd PCs written to packed file\n", num_offsets);
       }
     } else {
       // One file per module per process.
       fd_t fd = CovOpenFile(&path, false /* packed */, module_name);
       if (fd == kInvalidFd) continue;
       WriteToFile(fd, offsets.data(), offsets.size() * sizeof(offsets[0]));
       CloseFile(fd);
+      sancov_argv.push_back(internal_strdup(path.data()));
       VReport(1, " CovDump: %s: %zd PCs written\n", path.data(), num_offsets);
     }
   }
   if (cov_fd != kInvalidFd)
     CloseFile(cov_fd);
+
+  sancov_argv.push_back(nullptr);
+  GenerateHtmlReport(sancov_argv);
 }
 
 void CoverageData::DumpAll() {
   if (!coverage_enabled || common_flags()->coverage_direct) return;
   if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
     return;
   DumpAsBitSet();
   DumpCounters();

lib/sanitizer_common/sanitizer_flags.inc

COMMON_FLAG(
     bool, abort_on_error, SANITIZER_MAC,
     "If set, the tool calls abort() instead of _exit() after printing the "
     "error report.")
 COMMON_FLAG(bool, suppress_equal_pcs, true,
             "Deduplicate multiple reports for single source location in "
             "halt_on_error=false mode (asan only).")
 COMMON_FLAG(bool, print_cmdline, false, "Print command line on crash "
             "(asan only).")
+COMMON_FLAG(bool, html_cov_report, false, "Generate html coverage report.")
+COMMON_FLAG(const char *, sancov_path, "sancov", "Sancov tool location.")

lib/sanitizer_common/sanitizer_posix_libcdep.cc

bool IsProcessRunning(pid_t pid) {
   int local_errno;
   if (internal_iserror(waitpid_status, &local_errno)) {
     VReport(1, "Waiting on the process failed (errno %d).\n", local_errno);
     return false;
   }
   return waitpid_status == 0;
 }
 
+int WaitForProcess(pid_t pid) {
+  int process_status;
+  uptr waitpid_status = internal_waitpid(pid, &process_status, 0);
+  int local_errno;
+  if (internal_iserror(waitpid_status, &local_errno)) {
+    VReport(1, "Waiting on the process failed (errno %d).\n", local_errno);
+    return -1;
+  }
+  return process_status;
+}
+
 } // namespace __sanitizer
 
 #endif // SANITIZER_POSIX

lib/sanitizer_common/sanitizer_win.cc

pid_t StartSubprocess(const char *program, const char *const argv[],
   return -1;
 }
 
 bool IsProcessRunning(pid_t pid) {
   // FIXME: implement on this platform.
   return false;
 }
 
+int WaitForProcess(pid_t pid) { return -1; }
+
 }  // namespace __sanitizer
 
 #endif  // _WIN32

test/CMakeLists.txt

 
 # When ANDROID, we build tests with the host compiler (i.e. CMAKE_C_COMPILER),
 # and run tests with tools from the host toolchain.
 if(NOT ANDROID)
   if(NOT COMPILER_RT_STANDALONE_BUILD)
     # Use LLVM utils and Clang from the same build tree.
     list(APPEND SANITIZER_COMMON_LIT_TEST_DEPS
       clang clang-headers FileCheck count not llvm-config llvm-nm llvm-objdump
-      llvm-symbolizer compiler-rt-headers)
+      llvm-symbolizer compiler-rt-headers sancov)
     if (COMPILER_RT_HAS_PROFILE)
       list(APPEND SANITIZER_COMMON_LIT_TEST_DEPS profile)
     endif()
     if (WIN32)
       list(APPEND SANITIZER_COMMON_LIT_TEST_DEPS KillTheDoctor)
     endif()
   endif()
   if(UNIX)

test/asan/TestCases/Posix/coverage_html_report.cc

+// REQUIRES: has_sancovcc
+// RUN: %clangxx_asan -fsanitize-coverage=func %s -o %t
+// RUN: rm -rf %T/coverage_html_report
+// RUN: mkdir -p %T/coverage_html_report
+// RUN: cd %T/coverage_html_report
+// RUN: %env_asan_opts=coverage=1:verbosity=1:html_cov_report=1:sancov=%sancovcc %run %t 2>&1 | FileCheck %s --check-prefix=CHECK-main
+// RUN: ls *.html | FileCheck %s --check-prefix=CHECK-ls
+// RUN: rm -r %T/coverage_html_report
+
+#include <stdio.h>
+#include <unistd.h>
+
+void bar() { printf("bar\n"); }
+
+int main(int argc, char **argv) {
+  fprintf(stderr, "PID: %d\n", getpid());
+  bar();
+  return 0;
+}
+
+// CHECK-main: PID: [[PID:[0-9]+]]
+// CHECK-main: [[PID]].sancov: 2 PCs written
+// CHECK-main: html report generated to ./coverage_html_report.cc.tmp.[[PID]].html
+// CHECK-ls: coverage_html_report.cc.tmp.{{[0-9]+}}.html

test/asan/lit.cfg

 config.substitutions.append( ("%asan_symbolize", python_exec + " " + asan_symbolize + " ") )
 # Setup path to sancov.py script.
 sanitizer_common_source_dir = os.path.join(
   get_required_attr(config, "compiler_rt_src_root"), "lib", "sanitizer_common")
 sancov = os.path.join(sanitizer_common_source_dir, "scripts", "sancov.py")
 if not os.path.exists(sancov):
   lit_config.fatal("Can't find script on path %r" % sancov)
 python_exec = get_required_attr(config, "python_executable")
-config.substitutions.append( ("%sancov", python_exec + " " + sancov + " ") )
+config.substitutions.append( ("%sancov ", python_exec + " " + sancov + " ") )
 
 # Determine kernel bitness
 if config.host_arch.find('64') != -1 and config.android != "1":
   kernel_bits = '64'
 else:
   kernel_bits = '32'
 
 config.substitutions.append( ('CHECK-%kernel_bits', ("CHECK-kernel-" + kernel_bits + "-bits")))
 
 config.substitutions.append( ("%libdl", libdl_flag) )
 
 config.available_features.add("asan-" + config.bits + "-bits")
 
 if config.host_os == 'Darwin':

test/lit.common.cfg

 if config.has_lld:
   config.available_features.add('lld')
 
 if config.can_symbolize:
   config.available_features.add('can-symbolize')
 
 lit.util.usePlatformSdkOnDarwin(config, lit_config)
 
+sancovcc_path = os.path.join(llvm_tools_dir, "sancov") 
+if os.path.exists(sancovcc_path):
+  config.available_features.add("has_sancovcc")
+  config.substitutions.append( ("%sancovcc ", sancovcc_path) )
+
 def is_darwin_lto_supported():
   return os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO.dylib'))
 
 def is_linux_lto_supported():
   if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
     return False
 
   ld_cmd = subprocess.Popen([config.gold_executable, '--help'], stdout = subprocess.PIPE)