Add MIP tests to compiler-rt

[ellis]

Disable macos test

[ellis]

Add -fPIC -shared test

[ellis]

Add test to make sure __llvm_mipmap isn't removed by --gc-sections.

[ellis]

Fix --gc-sections test.

[ellis]

Update tests.

compiler-rt/test/CMakeLists.txt

if(COMPILER_RT_BUILD_SANITIZERS)
     endforeach()
   endif()
   if(COMPILER_RT_BUILD_PROFILE AND COMPILER_RT_HAS_PROFILE)
     compiler_rt_test_runtime(profile)
   endif()
   if(COMPILER_RT_BUILD_MEMPROF)
     compiler_rt_test_runtime(memprof)
   endif()
+  if(COMPILER_RT_BUILD_MIP)
+    compiler_rt_test_runtime(mip)
+  endif()
   if(COMPILER_RT_BUILD_XRAY)
     compiler_rt_test_runtime(xray)
   endif()
   if(COMPILER_RT_BUILD_ORC)
     compiler_rt_Test_runtime(orc)
   endif()
   if(COMPILER_RT_BUILD_CRT AND COMPILER_RT_HAS_CRT)
     add_subdirectory(crt)

compiler-rt/test/mip/CMakeLists.txt

+set(MIP_LIT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+
+set(MIP_TESTSUITES)
+set(MIP_TEST_DEPS
+  clang clang-resource-headers FileCheck count not compiler-rt-headers
+  llvm-config llvm-objcopy llvm-objdump llvm-nm llvm-mipdata)
+
+if(NOT APPLE AND COMPILER_RT_HAS_LLD AND "lld" IN_LIST LLVM_ENABLE_PROJECTS)
+  list(APPEND MIP_TEST_DEPS lld)
+endif()
+
+if(NOT COMPILER_RT_STANDALONE_BUILD AND COMPILER_RT_BUILD_MIP AND
+   COMPILER_RT_HAS_MIP)
+  list(APPEND MIP_TEST_DEPS mip)
+endif()
+
+set(MIP_TEST_ARCH ${MIP_SUPPORTED_ARCH})
+if (COMPILER_RT_BUILD_MIP AND COMPILER_RT_HAS_MIP)
+  foreach(arch ${MIP_TEST_ARCH})
+    set(MIP_TEST_TARGET_ARCH ${arch})
+    string(TOLOWER "-${arch}-${OS_NAME}" MIP_TEST_CONFIG_SUFFIX)
+    get_test_cc_for_arch(${arch} MIP_TEST_TARGET_CC MIP_TEST_TARGET_CFLAGS)
+    string(TOUPPER ${arch} ARCH_UPPER_CASE)
+    set(CONFIG_NAME ${ARCH_UPPER_CASE}${OS_NAME}Config)
+
+    configure_lit_site_cfg(
+      ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
+      ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME}/lit.site.cfg.py)
+    list(APPEND MIP_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME})
+  endforeach()
+endif()
+
+add_lit_testsuite(check-mip "Running the MIP tests"
+  ${MIP_TESTSUITES}
+  DEPENDS ${MIP_TEST_DEPS})
+set_target_properties(check-mip PROPERTIES FOLDER "Compiler-RT Misc")

compiler-rt/test/mip/Inputs/external-symbols.cpp

+// CHECK-DAG: {{.*}}/Inputs/external-symbols.cpp:[[@LINE+1]]
+static void duplicate_symbol() {}
+inline void merged_symbol() {}
+
+void use_external_symbols() {
+  (void)duplicate_symbol;
+  (void)merged_symbol;
+}

compiler-rt/test/mip/Posix/block-coverage.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-block-coverage -g -o %t.out %s
+// RUN: llvm-objcopy --remove-section=__llvm_mipmap %t.out %t.stripped
+// RUN: llvm-objdump --headers %t.stripped | FileCheck %s --check-prefix SECTIONS
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.mipraw %run %t.stripped
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+// RUN: %llvm_mipdata show -p %t.mip --debug %t.out | FileCheck %s
+//
+// REQUIRES: built-in-llvm-tree
+
+bool bar() { return true; }
+
+// CHECK: main
+// CHECK-NEXT: Source Info: [[FILE:.*]]:[[@LINE+5]]
+// CHECK-NEXT: Call Count: 1
+// CHECK-NEXT: Order Sum: 1
+// CHECK-NEXT: Block Coverage:
+// CHECK-NEXT:   HOT  HOT  COLD HOT
+int main() {
+  if (bar()) {
+    return 0;
+  } else {
+    return 1;
+  }
+}
+
+// SECTIONS-NOT: __llvm_mipmap

compiler-rt/test/mip/Posix/duplicate-symbol.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-function-coverage -g -o %t.out %s %S/../Inputs/external-symbols.cpp
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+// RUN: %llvm_mipdata show -p %t.mip --debug %t.out -o %t.show
+// RUN: FileCheck %s --input-file %t.show
+// RUN: FileCheck %S/../Inputs/external-symbols.cpp --input-file %t.show
+//
+// REQUIRES: built-in-llvm-tree
+
+// CHECK-DAG: {{.*}}/duplicate-symbol.cpp:[[@LINE+1]]
+static void duplicate_symbol() {}
+extern void use_external_symbols();
+
+int main() {
+  (void)use_external_symbols;
+  (void)duplicate_symbol;
+  return 0;
+}

compiler-rt/test/mip/Posix/full-profile.cpp

+// RUN: %clang -fmachine-profile-generate -g -o %t.out %s
+// RUN: llvm-objcopy --remove-section=__llvm_mipmap %t.out %t.stripped
+// RUN: llvm-objdump --headers %t.stripped | FileCheck %s --check-prefix SECTIONS
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.mipraw %run %t.stripped
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+// RUN: %llvm_mipdata show -p %t.mip --debug %t.out | FileCheck %s
+//
+// REQUIRES: built-in-llvm-tree
+// TODO: Full MIP instrumentation does not yet support armv7 targets.
+// XFAIL: arm
+
+// CHECK: _Z3barv
+// CHECK-NEXT: Source Info: [[FILE:.*]]:[[@LINE+3]]
+// CHECK-NEXT: Call Count: 2
+// CHECK-NEXT: Order Sum: 2
+void bar() {}
+
+// CHECK: _Z3foov
+// CHECK-NEXT: Source Info: [[FILE]]:[[@LINE+3]]
+// CHECK-NEXT: Call Count: 100
+// CHECK-NEXT: Order Sum: 3
+void foo() {}
+
+int main() {
+  bar();
+  for (int i = 0; i < 100; i++)
+    foo();
+  bar();
+  return 0;
+}
+
+// SECTIONS-NOT: __llvm_mipmap

compiler-rt/test/mip/Posix/function-coverage.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-function-coverage -g -o %t.out %s
+// RUN: llvm-objcopy --remove-section=__llvm_mipmap %t.out %t.stripped
+// RUN: llvm-objdump --headers %t.stripped | FileCheck %s --check-prefix SECTIONS
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.mipraw %run %t.stripped
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+// RUN: %llvm_mipdata covered -p %t.mip --debug %t.out | FileCheck %s --check-prefixes CHECK,CHECK-MISSING
+//
+// REQUIRES: built-in-llvm-tree
+
+void not_called() {}
+// CHECK-DAG: called()
+void called() {}
+
+// CHECK-DAG: main
+int main() {
+  called();
+  return 0;
+}
+
+// CHECK-MISSING-NOT: not_called()
+
+// SECTIONS-NOT: __llvm_mipmap

compiler-rt/test/mip/Posix/gc-sections.cpp

+// RUN: %clang -fmachine-profile-generate -g -ffunction-sections -fuse-ld=lld -Wl,--gc-sections -o %t.out %s
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.mipraw %run %t.out
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+//
+// RUN: llvm-nm %t.out | FileCheck %s --implicit-check-not bar
+//
+// REQUIRES: built-in-llvm-tree, lld-available
+
+void foo() {}
+void bar() {}
+
+int main() {
+  foo();
+  return 0;
+}
+
+// CHECK: _Z3foov
+// CHECK: _Z3foov$MAP
+// CHECK: _Z3foov$RAW

compiler-rt/test/mip/Posix/manual-profile-dump.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-function-coverage -fno-machine-profile-dump -g -o %t.out %s
+// RUN: llvm-objcopy --remove-section=__llvm_mipmap %t.out %t.stripped
+// RUN: llvm-objdump --headers %t.stripped | FileCheck %s --check-prefix SECTIONS
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.missing.mipraw %run %t.stripped %t.mipraw
+// RUN: not test -f %t.missing.mipraw
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+// RUN: %llvm_mipdata show -p %t.mip --debug %t.out | FileCheck %s
+//
+// REQUIRES: built-in-llvm-tree
+
+extern "C" {
+int __llvm_dump_mip_profile_with_filename(const char *Filename);
+}
+
+// CHECK: _Z3foov
+// CHECK-NEXT: Source Info: [[FILE:.*]]:[[@LINE+2]]
+// CHECK-NEXT: Call Count: 1
+void foo() {}
+
+// argv[1] holds the filename to dump.
+int main(int argc, const char *argv[]) {
+  foo();
+  __llvm_dump_mip_profile_with_filename(argv[1]);
+  return 0;
+}
+
+// SECTIONS-NOT: __llvm_mipmap

compiler-rt/test/mip/Posix/merged-symbol.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-function-coverage -g -o %t.out %s %S/../Inputs/external-symbols.cpp
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.out
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+// RUN: %llvm_mipdata show -p %t.mip | FileCheck %s
+//
+// REQUIRES: built-in-llvm-tree
+
+// CHECK-DAG: _Z20use_external_symbolsv
+inline void merged_symbol() {}
+extern void use_external_symbols();
+
+int main() {
+  (void)use_external_symbols;
+  (void)merged_symbol;
+  return 0;
+}

compiler-rt/test/mip/Posix/shared.cpp

+// RUN: %clang -fmachine-profile-generate -fmachine-profile-function-coverage -g -fPIC -shared -o %t.so %S/../Inputs/external-symbols.cpp
+// RUN: llvm-objcopy --remove-section=__llvm_mipmap %t.so %t.stripped.so
+// RUN: llvm-objdump --headers %t.stripped.so | FileCheck %s --check-prefix SECTIONS
+// RUN: llvm-objcopy --dump-section=__llvm_mipmap=%t.mipmap %t.so
+// RUN: %llvm_mipdata create -p %t.mip %t.mipmap
+// RUN: %clang -l:%t.so -L/ -o %t.out %s %t.so
+//
+// RUN: LLVM_MIP_PROFILE_FILENAME=%t.mipraw %run %t.out
+// RUN: %llvm_mipdata merge -p %t.mip %t.mipraw
+// RUN: %llvm_mipdata covered -p %t.mip --debug %t.so | FileCheck %s
+//
+// REQUIRES: built-in-llvm-tree
+
+void use_external_symbols();
+
+int main() {
+  // CHECK: use_external_symbols()
+  use_external_symbols();
+  return 0;
+}
+
+// SECTIONS-NOT: __llvm_mipmap

compiler-rt/test/mip/lit.cfg.py

+# -*- Python -*-
+
+import os
+
+# Setup config name.
+config.name = "MIP" + config.name_suffix
+
+# Setup source root.
+config.test_source_root = os.path.dirname(__file__)
+
+def build_invocation(compile_flags):
+    return " " + " ".join([config.clang] + compile_flags) + " "
+
+
+# Assume that llvm-mipdata is in the config.llvm_tools_dir.
+llvm_mipdata = os.path.join(config.llvm_tools_dir, "llvm-mipdata")
+
+config.substitutions.append(("%clang ", build_invocation([config.target_cflags])))
+config.substitutions.append(
+    ("%clangxx ", build_invocation(config.cxx_mode_flags + [config.target_cflags]))
+)
+config.substitutions.append(("%llvm_mipdata", llvm_mipdata))
+
+config.suffixes = [".c", ".cpp"]
+config.excludes = ['Inputs']
+
+# TODO: Darwin is supported, but the test cases are specifically written for
+#       Linux. We should be able to update the clang driver to eliminate the
+#       need to use `llvm-objcopy` and then we can enable Darwin tests easily.
+# TODO: armv7 is not supported for modes other than just function coverage.
+if config.host_os not in ["Linux"]:
+    config.unsupported = True
+elif config.host_arch not in ["x86_64", "aarch64"]:
+    config.unsupported = True

compiler-rt/test/mip/lit.site.cfg.py.in

+@LIT_SITE_CFG_IN_HEADER@
+
+# Tool-specific config options.
+config.name_suffix = "@MIP_TEST_CONFIG_SUFFIX@"
+config.mip_lit_source_dir = "@MIP_LIT_SOURCE_DIR@"
+config.target_cflags = "@MIP_TEST_TARGET_CFLAGS@"
+config.target_arch = "@MIP_TEST_TARGET_ARCH@"
+config.built_with_llvm = ("@COMPILER_RT_STANDALONE_BUILD@" != "TRUE")
+
+# TODO: Look into whether we can run a capability test on the standalone build to
+# see whether it can run 'llvm-mipdata --version' instead of turning off tests for a
+# standalone build.
+if config.built_with_llvm:
+  config.available_features.add('built-in-llvm-tree')
+
+# Load common config for all compiler-rt lit tests
+lit_config.load_config(config, "@COMPILER_RT_BINARY_DIR@/test/lit.common.configured")
+
+# Load tool-specific config that would do the real work.
+lit_config.load_config(config, "@CMAKE_CURRENT_SOURCE_DIR@/lit.cfg.py")