Add compiler-rt MIP support

[ellis]

Summary

Add the compiler-rt library libclang_rt.mip.a that automatically dumps the contents of the
__llvm_mipraw section when the program exits.

[MaskRay]

This is a new thing. Do you have an RFC on llvm-dev?

compiler-rt/include/mip/MIPData.inc

37

New code should use // style comments.

[ellis]

In D104086#2812300, @MaskRay wrote:

This is a new thing. Do you have an RFC on llvm-dev?

Yeah, the parent commit has more info.
https://reviews.llvm.org/D104060

I do have an RFC, but it is waiting for moderator approval before it makes it to the mailing list.

[ellis]

Update comment style

[ellis]

Minor updates.

[ellis]

Fix MIPData.inc.

compiler-rt/CMakeLists.txt

 option(COMPILER_RT_BUILD_XRAY "Build xray" ON)
 mark_as_advanced(COMPILER_RT_BUILD_XRAY)
 option(COMPILER_RT_BUILD_LIBFUZZER "Build libFuzzer" ON)
 mark_as_advanced(COMPILER_RT_BUILD_LIBFUZZER)
 option(COMPILER_RT_BUILD_PROFILE "Build profile runtime" ON)
 mark_as_advanced(COMPILER_RT_BUILD_PROFILE)
 option(COMPILER_RT_BUILD_MEMPROF "Build memory profiling runtime" ON)
 mark_as_advanced(COMPILER_RT_BUILD_MEMPROF)
+option(COMPILER_RT_BUILD_MIP "Build mip runtime" ON)
+mark_as_advanced(COMPILER_RT_BUILD_MIP)
 option(COMPILER_RT_BUILD_XRAY_NO_PREINIT "Build xray with no preinit patching" OFF)
 mark_as_advanced(COMPILER_RT_BUILD_XRAY_NO_PREINIT)
 option(COMPILER_RT_BUILD_ORC "Build ORC runtime" ON)
 mark_as_advanced(COMPILER_RT_BUILD_ORC)
 
 set(COMPILER_RT_ASAN_SHADOW_SCALE ""
     CACHE STRING "Override the shadow scale to be used in ASan runtime")
 

compiler-rt/cmake/config-ix.cmake

 else()
   set(ALL_LSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${MIPS64} ${ARM64} ${ARM32} ${PPC64} ${S390X} ${RISCV64})
 endif()
 set(ALL_MSAN_SUPPORTED_ARCH ${X86_64} ${MIPS64} ${ARM64} ${PPC64} ${S390X})
 set(ALL_HWASAN_SUPPORTED_ARCH ${X86_64} ${ARM64})
 set(ALL_MEMPROF_SUPPORTED_ARCH ${X86_64})
 set(ALL_PROFILE_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64} ${PPC32} ${PPC64}
     ${MIPS32} ${MIPS64} ${S390X} ${SPARC} ${SPARCV9})
+set(ALL_MIP_SUPPORTED_ARCH ${X86_64} ${ARM32} ${ARM64})
 set(ALL_TSAN_SUPPORTED_ARCH ${X86_64} ${MIPS64} ${ARM64} ${PPC64})
 set(ALL_UBSAN_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64} ${RISCV64}
     ${MIPS32} ${MIPS64} ${PPC64} ${S390X} ${SPARC} ${SPARCV9})
 set(ALL_SAFESTACK_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM64} ${MIPS32} ${MIPS64})
 set(ALL_CFI_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64} ${MIPS64})
 set(ALL_SCUDO_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64} ${MIPS32} ${MIPS64} ${PPC64})
 set(ALL_SCUDO_STANDALONE_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64} ${MIPS32} ${MIPS64} ${PPC64})
 if(APPLE)
set(DARWIN_tvos_SANITIZER_MIN_VER_FLAG
       ${DARWIN_tvos_MIN_VER_FLAG}=${DARWIN_tvos_MIN_VER})
     set(DARWIN_tvossim_MIN_VER_FLAG -mtvos-simulator-version-min)
     set(DARWIN_tvossim_SANITIZER_MIN_VER_FLAG
       ${DARWIN_tvossim_MIN_VER_FLAG}=${DARWIN_tvos_MIN_VER})
   endif()
 
   set(SANITIZER_COMMON_SUPPORTED_OS osx)
   set(PROFILE_SUPPORTED_OS osx)
+  set(MIP_SUPPORTED_OS osx)
   set(TSAN_SUPPORTED_OS osx)
   set(XRAY_SUPPORTED_OS osx)
   set(FUZZER_SUPPORTED_OS osx)
   set(ORC_SUPPORTED_OS osx)
 
   # Note: In order to target x86_64h on OS X the minimum deployment target must
   # be 10.8 or higher.
   set(DEFAULT_SANITIZER_MIN_OSX_VERSION 10.10)
foreach(platform ${DARWIN_EMBEDDED_PLATFORMS})
         set(DARWIN_${platform}sim_SKIP_CC_KEXT On)
         darwin_test_archs(${platform}sim
           DARWIN_${platform}sim_ARCHS
           ${toolchain_arches})
         message(STATUS "${platform} Simulator supported arches: ${DARWIN_${platform}sim_ARCHS}")
         if(DARWIN_${platform}sim_ARCHS)
           list(APPEND SANITIZER_COMMON_SUPPORTED_OS ${platform}sim)
           list(APPEND PROFILE_SUPPORTED_OS ${platform}sim)
+          list(APPEND MIP_SUPPORTED_OS ${platform}sim)
           list(APPEND TSAN_SUPPORTED_OS ${platform}sim)
           list(APPEND FUZZER_SUPPORTED_OS ${platform}sim)
         endif()
         foreach(arch ${DARWIN_${platform}sim_ARCHS})
           list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
           set(CAN_TARGET_${arch} 1)
         endforeach()
       endif()
foreach(platform ${DARWIN_EMBEDDED_PLATFORMS})
 
         darwin_test_archs(${platform}
           DARWIN_${platform}_ARCHS
           ${toolchain_arches})
         message(STATUS "${platform} supported arches: ${DARWIN_${platform}_ARCHS}")
         if(DARWIN_${platform}_ARCHS)
           list(APPEND SANITIZER_COMMON_SUPPORTED_OS ${platform})
           list(APPEND PROFILE_SUPPORTED_OS ${platform})
+          list(APPEND MIP_SUPPORTED_OS ${platform})
 
           list_intersect(DARWIN_${platform}_TSAN_ARCHS DARWIN_${platform}_ARCHS ALL_TSAN_SUPPORTED_ARCH)
           if(DARWIN_${platform}_TSAN_ARCHS)
             list(APPEND TSAN_SUPPORTED_OS ${platform})
           endif()
           list(APPEND FUZZER_SUPPORTED_OS ${platform})
         endif()
         foreach(arch ${DARWIN_${platform}_ARCHS})
list_intersect(HWASAN_SUPPORTED_ARCH
     ALL_HWASAN_SUPPORTED_ARCH
     SANITIZER_COMMON_SUPPORTED_ARCH)
   list_intersect(MEMPROF_SUPPORTED_ARCH
     ALL_MEMPROF_SUPPORTED_ARCH
     SANITIZER_COMMON_SUPPORTED_ARCH)
   list_intersect(PROFILE_SUPPORTED_ARCH
     ALL_PROFILE_SUPPORTED_ARCH
     SANITIZER_COMMON_SUPPORTED_ARCH)
+  list_intersect(MIP_SUPPORTED_ARCH
+    ALL_MIP_SUPPORTED_ARCH
+    SANITIZER_COMMON_SUPPORTED_ARCH)
   list_intersect(TSAN_SUPPORTED_ARCH
     ALL_TSAN_SUPPORTED_ARCH
     SANITIZER_COMMON_SUPPORTED_ARCH)
   list_intersect(UBSAN_SUPPORTED_ARCH
     ALL_UBSAN_SUPPORTED_ARCH
     SANITIZER_COMMON_SUPPORTED_ARCH)
   list_intersect(SAFESTACK_SUPPORTED_ARCH
     ALL_SAFESTACK_SUPPORTED_ARCH
else()
   filter_available_targets(ASAN_SUPPORTED_ARCH ${ALL_ASAN_SUPPORTED_ARCH})
   filter_available_targets(FUZZER_SUPPORTED_ARCH ${ALL_FUZZER_SUPPORTED_ARCH})
   filter_available_targets(DFSAN_SUPPORTED_ARCH ${ALL_DFSAN_SUPPORTED_ARCH})
   filter_available_targets(LSAN_SUPPORTED_ARCH ${ALL_LSAN_SUPPORTED_ARCH})
   filter_available_targets(MSAN_SUPPORTED_ARCH ${ALL_MSAN_SUPPORTED_ARCH})
   filter_available_targets(HWASAN_SUPPORTED_ARCH ${ALL_HWASAN_SUPPORTED_ARCH})
   filter_available_targets(MEMPROF_SUPPORTED_ARCH ${ALL_MEMPROF_SUPPORTED_ARCH})
   filter_available_targets(PROFILE_SUPPORTED_ARCH ${ALL_PROFILE_SUPPORTED_ARCH})
+  filter_available_targets(MIP_SUPPORTED_ARCH ${ALL_MIP_SUPPORTED_ARCH})
   filter_available_targets(TSAN_SUPPORTED_ARCH ${ALL_TSAN_SUPPORTED_ARCH})
   filter_available_targets(UBSAN_SUPPORTED_ARCH ${ALL_UBSAN_SUPPORTED_ARCH})
   filter_available_targets(SAFESTACK_SUPPORTED_ARCH
     ${ALL_SAFESTACK_SUPPORTED_ARCH})
   filter_available_targets(CFI_SUPPORTED_ARCH ${ALL_CFI_SUPPORTED_ARCH})
   filter_available_targets(SCUDO_SUPPORTED_ARCH ${ALL_SCUDO_SUPPORTED_ARCH})
   filter_available_targets(SCUDO_STANDALONE_SUPPORTED_ARCH ${ALL_SCUDO_STANDALONE_SUPPORTED_ARCH})
   filter_available_targets(XRAY_SUPPORTED_ARCH ${ALL_XRAY_SUPPORTED_ARCH})

 
 if (PROFILE_SUPPORTED_ARCH AND NOT LLVM_USE_SANITIZER AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Windows|Android|Fuchsia|SunOS|NetBSD|AIX")
   set(COMPILER_RT_HAS_PROFILE TRUE)
 else()
   set(COMPILER_RT_HAS_PROFILE FALSE)
 endif()
 
+if (MIP_SUPPORTED_ARCH AND OS_NAME MATCHES "Darwin|Linux|Android")
+  set(COMPILER_RT_HAS_MIP TRUE)
+else()
+  set(COMPILER_RT_HAS_MIP FALSE)
+endif()
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND TSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Android|NetBSD")
   set(COMPILER_RT_HAS_TSAN TRUE)
 else()
   set(COMPILER_RT_HAS_TSAN FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND UBSAN_SUPPORTED_ARCH AND

compiler-rt/include/mip/MIPData.inc

+//===-- MIPData.inc - machine ir profile runtime structures -------*- C -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains definitions and data structures that are shared between
+// the runtime and the compiler. It lives in two locations that need to stay in
+// sync.
+// + llvm/include/llvm/MIP/MIPData.inc
+// + compiler-rt/include/mip/MIPData.inc
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef MIP_DATA_DEFINED
+
+#include <stdint.h>
+
+#ifndef MIP_DATA_INC
+#define MIP_DATA_INC
+
+#define MIP_SIMPLE_QUOTE(x) #x
+#define MIP_QUOTE(x) MIP_SIMPLE_QUOTE(x)
+#define MIP_SIMPLE_CONCAT(x,y) x ## y
+#define MIP_CONCAT(x,y) MIP_SIMPLE_CONCAT(x,y)
+
+#define MIP_RAW_SECTION __llvm_mipraw
+#define MIP_MAP_SECTION __llvm_mipmap
+#define MIP_RUNTIME_SYMBOL __llvm_mip_runtime
+
+#define MIP_RAW_SECTION_NAME MIP_QUOTE(MIP_RAW_SECTION)
+#define MIP_MAP_SECTION_NAME MIP_QUOTE(MIP_MAP_SECTION)
+#define MIP_RUNTIME_SYMBOL_NAME MIP_QUOTE(MIP_RUNTIME_SYMBOL)
+
+// MIP magic value in little endian format.
+// \251 M    I    P
+// 0xFB 0x4D 0x49 0x50
+#define MIP_MAGIC_VALUE (0x50494DFB)
+#define MIP_VERSION (8)
+
+typedef enum {
+  MIP_FILE_TYPE_RAW = 1 << 0,               // .mipraw
+  MIP_FILE_TYPE_CALL_EDGE_SAMPLES = 1 << 1, // .mipret
+  MIP_FILE_TYPE_MAP = 1 << 2,               // .mipmap
+  MIP_FILE_TYPE_PROFILE = 1 << 3,           // .mip
+  MIP_FILE_TYPE_64_BIT = 1 << 4,
+  MIP_FILE_TYPE_32_BIT = 1 << 5,
+} MIPFileType;
+
+typedef enum {
+  MIP_PROFILE_TYPE_FUNCTION_COVERAGE = 1 << 0,
+  MIP_PROFILE_TYPE_BLOCK_COVERAGE = 1 << 1,
+  MIP_PROFILE_TYPE_FUNCTION_TIMESTAMP = 1 << 2,
+  MIP_PROFILE_TYPE_FUNCTION_CALL_COUNT = 1 << 3,
+  MIP_PROFILE_TYPE_RETURN_ADDRESS = 1 << 4,
+} MIPProfileType;
+
+typedef struct {
+  uint32_t Magic;
+  uint16_t Version;
+  uint16_t FileType;
+  uint32_t ProfileType;
+  uint32_t ModuleHash;
+  int64_t RawSectionOffset;
+  uint32_t Reserved;
+  uint32_t OffsetToData;
+} MIPHeader;
+
+typedef struct {
+  uint32_t CalleeProfileDataOffset;
+  uint32_t SectionRelativeReturnAddress;
+} CallEdge_t;
+
+#endif // MIP_DATA_INC
+
+#else // MIP_DATA_INC
+#undef MIP_DATA_DEFINED
+#endif // MIP_DATA_DEFINED

compiler-rt/lib/CMakeLists.txt

foreach(sanitizer ${COMPILER_RT_SANITIZERS_TO_BUILD})
     compiler_rt_build_runtime(${sanitizer})
   endforeach()
 endif()
 
 if(COMPILER_RT_BUILD_PROFILE AND COMPILER_RT_HAS_PROFILE)
   compiler_rt_build_runtime(profile)
 endif()
 
+if(COMPILER_RT_BUILD_MIP AND COMPILER_RT_HAS_MIP)
+  compiler_rt_build_runtime(mip)
+endif()
+
 if(COMPILER_RT_BUILD_XRAY)
   compiler_rt_build_runtime(xray)
 endif()
 
 if(COMPILER_RT_BUILD_LIBFUZZER)
   compiler_rt_build_runtime(fuzzer)
 endif()
 

compiler-rt/lib/mip/CMakeLists.txt

+add_compiler_rt_component(mip)
+
+set(MIP_SOURCES
+  MIPHelper.c
+  MIPRuntime.cpp
+)
+
+set(MIP_HEADERS
+  MIPHelper.h
+)
+
+include_directories(../../include)
+
+if(APPLE)
+  add_compiler_rt_runtime(clang_rt.mip
+    STATIC
+    OS ${MIP_SUPPORTED_OS}
+    ARCHS ${MIP_SUPPORTED_ARCH}
+    CFLAGS ${EXTRA_FLAGS}
+    SOURCES ${MIP_SOURCES}
+    ADDITIONAL_HEADERS ${MIP_HEADERS}
+    PARENT_TARGET mip)
+else()
+  add_compiler_rt_runtime(clang_rt.mip
+    STATIC
+    ARCHS ${MIP_SUPPORTED_ARCH}
+    CFLAGS ${EXTRA_FLAGS}
+    SOURCES ${MIP_SOURCES}
+    ADDITIONAL_HEADERS ${MIP_HEADERS}
+    PARENT_TARGET mip)
+endif()

compiler-rt/lib/mip/MIPHelper.h

+/*===- MIPHelper.h - Machine IR Profile Runtime Helper --------------------===*\
+|*
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+|* See https://llvm.org/LICENSE.txt for license information.
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+|*
+\*===----------------------------------------------------------------------===*/
+
+#ifndef MIP_MIPHELPER_H
+#define MIP_MIPHELPER_H
+
+#include "mip/MIPData.inc"
+
+void __llvm_dump_mip_profile(void);
+int __llvm_dump_mip_profile_with_filename(const char *Filename);
+
+void *__llvm_mip_profile_begin(void);
+void *__llvm_mip_profile_end(void);
+
+void __llvm_mip_runtime_initialize(void);
+
+#endif // MIP_MIPHELPER_H

compiler-rt/lib/mip/MIPHelper.c

+/*===- MIPHelper.c - Machine IR Profile Runtime Helper --------------------===*\
+|*
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+|* See https://llvm.org/LICENSE.txt for license information.
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+|*
+\*===----------------------------------------------------------------------===*/
+
+#include "MIPHelper.h"
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+void __llvm_mip_runtime_initialize(void) { atexit(__llvm_dump_mip_profile); }
+
+void __llvm_dump_mip_profile(void) {
+  const char *Filename = getenv("LLVM_MIP_PROFILE_FILENAME");
+  if (!Filename || !Filename[0])
+    Filename = "default.mipraw";
+
+  char *FormatSpecifierPtr;
+  char Buffer[strlen(Filename) + 3];
+  if ((FormatSpecifierPtr = strstr(Filename, "%h"))) {
+    const MIPHeader *Header = (MIPHeader *)__llvm_mip_profile_begin();
+    const char *Prefix = Filename;
+    int PrefixLength = FormatSpecifierPtr - Filename;
+    const char *Suffix = FormatSpecifierPtr + strlen("%h");
+    sprintf(Buffer, "%.*s%04x%s", PrefixLength, Prefix,
+            Header->ModuleHash & 0xFFFF, Suffix);
+    Filename = Buffer;
+  }
+  __llvm_dump_mip_profile_with_filename(Filename);
+}
+
+int __llvm_dump_mip_profile_with_filename(const char *Filename) {
+  FILE *filep = fopen(Filename, "wb");
+  if (!filep) {
+    fprintf(stderr, "[MIPRuntime]: Failed to open %s: %s\n", Filename,
+            strerror(errno));
+    return -1;
+  }
+
+  const void *Data = __llvm_mip_profile_begin();
+  size_t DataSize =
+      (char *)__llvm_mip_profile_end() - (char *)__llvm_mip_profile_begin();
+  size_t BytesWritten = fwrite(Data, 1, DataSize, filep);
+  if (BytesWritten != DataSize) {
+    fprintf(stderr, "[MIPRuntime]: Failed to write to %s: %s\n", Filename,
+            strerror(errno));
+    fclose(filep);
+    return -1;
+  }
+
+  fclose(filep);
+  return 0;
+}
+
+#ifdef __linux__
+#define MIP_RAW_SECTION_BEGIN_SYMBOL MIP_CONCAT(__start_, MIP_RAW_SECTION)
+#define MIP_RAW_SECTION_END_SYMBOL MIP_CONCAT(__stop_, MIP_RAW_SECTION)
+extern char MIP_RAW_SECTION_BEGIN_SYMBOL;
+extern char MIP_RAW_SECTION_END_SYMBOL;
+#endif // __linux__
+
+#ifdef __APPLE__
+#define MIP_RAW_SECTION_BEGIN_SYMBOL __llvm_mip_raw_section_start
+#define MIP_RAW_SECTION_END_SYMBOL __llvm_mip_raw_section_end
+extern char MIP_RAW_SECTION_BEGIN_SYMBOL __asm(
+    "section$start$__DATA$" MIP_RAW_SECTION_NAME);
+extern char MIP_RAW_SECTION_END_SYMBOL __asm(
+    "section$end$__DATA$" MIP_RAW_SECTION_NAME);
+#endif // __APPLE__
+
+void *__llvm_mip_profile_begin(void) { return &MIP_RAW_SECTION_BEGIN_SYMBOL; }
+
+void *__llvm_mip_profile_end(void) { return &MIP_RAW_SECTION_END_SYMBOL; }

compiler-rt/lib/mip/MIPRuntime.cpp

+/*===- MIPRuntime.c - Machine IR Profile Runtime Helper -------------------===*\
+|*
+|* Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+|* See https://llvm.org/LICENSE.txt for license information.
+|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+|*
+\*===----------------------------------------------------------------------===*/
+
+extern "C" {
+#include "MIPHelper.h"
+int MIP_RUNTIME_SYMBOL;
+}
+
+namespace {
+
+class RegisterMIPRuntime {
+public:
+  RegisterMIPRuntime() { __llvm_mip_runtime_initialize(); }
+};
+
+RegisterMIPRuntime Registration;
+
+} // namespace