[sanitizer_common] Enable external tool to register PrintfAndReportCallback

[protze.joachim]

Summary

This patch enables an external tool to register PrintfAndReportCallback.
The function needs to end up in the dynamic symbol table, so that a dynamic library can call the function.

[kcc]

The logic is too complex.
If you want to disable colors, just disable them with a separate flag.
If you want to disable logging to a file, just use log_file=/dev/null

[protze.joachim]

I cannot find a log_file option, only a log_path option. And this option is not compatible with /dev/null, since it adds ".$PID" to the path prefix.

I reduced the patch to just suppress the output to file for a registered output callback.

[protze.joachim]

With some compiler versions, SetPrintfAndReportCallback gets the .hidden flag. I need to access the symbol from a 3rd party library.
So I added SANITIZER_INTERFACE_ATTRIBUTE to have the symbol visible.

[protze.joachim]

@kcc I would still be interested in this change :)

[kcc]

• I see two independent changes here. If so, please split them into two patches
• most changes need tests.
• Maybe instead of doing this, introduce some logic to treat log_path=/dev/null as a special supported case?

[protze.joachim]

I updated this differential to only export the function.

To make the function available with all sanitizers, I created a new extra file that is included for all sanitizers.

lib/asan/CMakeLists.txt

add_compiler_rt_runtime(clang_rt.asan-preinit
       CFLAGS ${ASAN_CFLAGS}
       DEFS ${ASAN_COMMON_DEFINITIONS}
       PARENT_TARGET asan)
 
   foreach(arch ${ASAN_SUPPORTED_ARCH})
     if (UNIX AND NOT ${arch} MATCHES "i386|i686")
       add_sanitizer_rt_version_list(clang_rt.asan-dynamic-${arch}
                                     LIBS clang_rt.asan-${arch} clang_rt.asan_cxx-${arch}
-                                    EXTRA asan.syms.extra)
+                                    EXTRA asan.syms.extra ../sanitizer_common/common_san.syms.extra)
       set(VERSION_SCRIPT_FLAG
            -Wl,--version-script,${CMAKE_CURRENT_BINARY_DIR}/clang_rt.asan-dynamic-${arch}.vers)
       set_source_files_properties(
         ${CMAKE_CURRENT_BINARY_DIR}/dummy.cc
   PROPERTIES
   OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/clang_rt.asan-dynamic-${arch}.vers)
     else()
       set(VERSION_SCRIPT_FLAG)
add_compiler_rt_runtime(clang_rt.asan
       PARENT_TARGET asan)
 
     if (UNIX AND NOT ${arch} MATCHES "i386|i686")
       add_sanitizer_rt_symbols(clang_rt.asan_cxx
         ARCHS ${arch})
       add_dependencies(asan clang_rt.asan_cxx-${arch}-symbols)
       add_sanitizer_rt_symbols(clang_rt.asan
         ARCHS ${arch} 
-        EXTRA asan.syms.extra)
+        EXTRA asan.syms.extra ../sanitizer_common/common_san.syms.extra)
       add_dependencies(asan clang_rt.asan-${arch}-symbols)
     endif()
 
     if (WIN32)
       add_compiler_rt_runtime(clang_rt.asan_dll_thunk
         STATIC
         ARCHS ${arch}
         SOURCES asan_win_dll_thunk.cc

lib/dfsan/CMakeLists.txt

add_compiler_rt_runtime(clang_rt.dfsan
     SOURCES ${DFSAN_RTL_SOURCES}
             $<TARGET_OBJECTS:RTInterception.${arch}>
             $<TARGET_OBJECTS:RTSanitizerCommon.${arch}>
             $<TARGET_OBJECTS:RTSanitizerCommonLibc.${arch}>
     CFLAGS ${DFSAN_CFLAGS}
     PARENT_TARGET dfsan)
   add_sanitizer_rt_symbols(clang_rt.dfsan
     ARCHS ${arch}
-    EXTRA dfsan.syms.extra)
+    EXTRA dfsan.syms.extra ../sanitizer_common/common_san.syms.extra)
   add_dependencies(dfsan
     clang_rt.dfsan-${arch}-symbols)
 endforeach()
 
 set(dfsan_abilist_filename ${COMPILER_RT_OUTPUT_DIR}/dfsan_abilist.txt)
 add_custom_target(dfsan_abilist ALL
   DEPENDS ${dfsan_abilist_filename})
 add_custom_command(OUTPUT ${dfsan_abilist_filename}

lib/msan/CMakeLists.txt

SOURCES ${MSAN_RTL_CXX_SOURCES}
             $<TARGET_OBJECTS:RTUbsan_cxx.${arch}>
     CFLAGS ${MSAN_RTL_CFLAGS}
     PARENT_TARGET msan)
   list(APPEND MSAN_RUNTIME_LIBRARIES clang_rt.msan-${arch}
                                      clang_rt.msan_cxx-${arch})
   if(UNIX)
     add_sanitizer_rt_symbols(clang_rt.msan
       ARCHS ${arch}
-      EXTRA msan.syms.extra)
+      EXTRA msan.syms.extra ../sanitizer_common/common_san.syms.extra)
     add_sanitizer_rt_symbols(clang_rt.msan_cxx
       ARCHS ${arch}
-      EXTRA msan.syms.extra)
+      EXTRA msan.syms.extra ../sanitizer_common/common_san.syms.extra)
     add_dependencies(msan clang_rt.msan-${arch}-symbols
                           clang_rt.msan_cxx-${arch}-symbols)
   endif()
 endforeach()
 
 add_compiler_rt_resource_file(msan_blacklist msan_blacklist.txt)
 add_dependencies(msan msan_blacklist)
 add_dependencies(compiler-rt msan)
 
 if(COMPILER_RT_INCLUDE_TESTS)
   add_subdirectory(tests)
 endif()

lib/sanitizer_common/common_san.syms.extra

+SetPrintfAndReportCallback

lib/sanitizer_common/sanitizer_common.h

 void SetLowLevelAllocateCallback(LowLevelAllocateCallback callback);
 
 // IO
 void RawWrite(const char *buffer);
 bool ColorizeReports();
 void RemoveANSIEscapeSequencesFromString(char *buffer);
 void Printf(const char *format, ...);
 void Report(const char *format, ...);
-void SetPrintfAndReportCallback(void (*callback)(const char *));
+SANITIZER_INTERFACE_ATTRIBUTE void SetPrintfAndReportCallback(void (*callback)(const char *));
 #define VReport(level, ...)                                              \
   do {                                                                   \
     if ((uptr)Verbosity() >= (level)) Report(__VA_ARGS__); \
   } while (0)
 #define VPrintf(level, ...)                                              \
   do {                                                                   \
     if ((uptr)Verbosity() >= (level)) Printf(__VA_ARGS__); \
   } while (0)

lib/tsan/CMakeLists.txt

add_compiler_rt_runtime(clang_rt.tsan_cxx
       ARCHS ${arch}
       SOURCES ${TSAN_CXX_SOURCES}
               $<TARGET_OBJECTS:RTUbsan_cxx.${arch}>
       CFLAGS ${TSAN_RTL_CFLAGS})
     list(APPEND TSAN_RUNTIME_LIBRARIES clang_rt.tsan-${arch}
                                        clang_rt.tsan_cxx-${arch})
     add_sanitizer_rt_symbols(clang_rt.tsan
       ARCHS ${arch}
-      EXTRA rtl/tsan.syms.extra)
+      EXTRA rtl/tsan.syms.extra ../sanitizer_common/common_san.syms.extra)
     add_sanitizer_rt_symbols(clang_rt.tsan_cxx
       ARCHS ${arch}
-      EXTRA rtl/tsan.syms.extra)
+      EXTRA rtl/tsan.syms.extra ../sanitizer_common/common_san.syms.extra)
     add_dependencies(tsan clang_rt.tsan-${arch}
                           clang_rt.tsan_cxx-${arch}
                           clang_rt.tsan-${arch}-symbols
                           clang_rt.tsan_cxx-${arch}-symbols)
   endforeach()
 endif()
 
 add_dependencies(compiler-rt tsan)

lib/ubsan/CMakeLists.txt

add_compiler_rt_runtime(clang_rt.ubsan_standalone_cxx
       PARENT_TARGET ubsan)
 
     if (UNIX)
       set(ARCHS_FOR_SYMBOLS ${UBSAN_SUPPORTED_ARCH})
       list(REMOVE_ITEM ARCHS_FOR_SYMBOLS i386 i686)
       add_sanitizer_rt_symbols(clang_rt.ubsan_standalone
         ARCHS ${ARCHS_FOR_SYMBOLS}
         PARENT_TARGET ubsan
-        EXTRA ubsan.syms.extra)
+        EXTRA ubsan.syms.extra ../sanitizer_common/common_san.syms.extra)
       add_sanitizer_rt_symbols(clang_rt.ubsan_standalone_cxx
         ARCHS ${ARCHS_FOR_SYMBOLS}
         PARENT_TARGET ubsan
-        EXTRA ubsan.syms.extra)
+        EXTRA ubsan.syms.extra ../sanitizer_common/common_san.syms.extra)
     endif()
   endif()
 endif()
 
 add_dependencies(compiler-rt ubsan)