[compiler-rt] Add cmake option to enable/disable searching PATH for symbolizer (PR #129012)

[via llvm-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-compiler-rt-sanitizer

Author: Midhunesh (midhuncodes7)

<details>
<summary>Changes</summary>

Introduced cmake option that is disabled by default allowing searching PATH variable for symbolizer. The option will be enabled for downstream changes to disable searching PATH variable for symbolizer instead use ASAN_SYMBOLIZER_PATH

---
Full diff: https://github.com/llvm/llvm-project/pull/129012.diff


2 Files Affected:

- (modified) compiler-rt/CMakeLists.txt (+7) 
- (modified) compiler-rt/lib/sanitizer_common/sanitizer_symbolizer_posix_libcdep.cpp (+20-15) 


``````````diff
diff --git a/compiler-rt/CMakeLists.txt b/compiler-rt/CMakeLists.txt
index 2c52788de56af..67133b62cd047 100644
--- a/compiler-rt/CMakeLists.txt
+++ b/compiler-rt/CMakeLists.txt
@@ -830,6 +830,13 @@ pythonize_bool(COMPILER_RT_TEST_USE_LLD)
 option(COMPILER_RT_ENABLE_INTERNAL_SYMBOLIZER "Build Compiler RT linked with in LLVM symbolizer" OFF)
 mark_as_advanced(COMPILER_RT_ENABLE_INTERNAL_SYMBOLIZER)
 
+option(SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH "Disable searching for external symbolizer in $PATH" OFF)
+mark_as_advanced(SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH)
+
+if (SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH)
+    add_compile_definitions(SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH)
+endif()
+
 add_subdirectory(lib)
 
 if(COMPILER_RT_INCLUDE_TESTS)
diff --git a/compiler-rt/lib/sanitizer_common/sanitizer_symbolizer_posix_libcdep.cpp b/compiler-rt/lib/sanitizer_common/sanitizer_symbolizer_posix_libcdep.cpp
index 0ddc24802d216..7febcf6d4ff00 100644
--- a/compiler-rt/lib/sanitizer_common/sanitizer_symbolizer_posix_libcdep.cpp
+++ b/compiler-rt/lib/sanitizer_common/sanitizer_symbolizer_posix_libcdep.cpp
@@ -443,23 +443,28 @@ static SymbolizerTool *ChooseExternalSymbolizer(LowLevelAllocator *allocator) {
   }
 
   // Otherwise symbolizer program is unknown, let's search $PATH
+#ifdef SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH
+   VReport(2, "Symbolizer path search is disabled in the runtime build configuration\n");
+   return nullptr;
+#else 
   CHECK(path == nullptr);
-#if SANITIZER_APPLE
-  if (const char *found_path = FindPathToBinary("atos")) {
-    VReport(2, "Using atos found at: %s\n", found_path);
-    return new(*allocator) AtosSymbolizer(found_path, allocator);
-  }
-#endif  // SANITIZER_APPLE
-  if (const char *found_path = FindPathToBinary("llvm-symbolizer")) {
-    VReport(2, "Using llvm-symbolizer found at: %s\n", found_path);
-    return new(*allocator) LLVMSymbolizer(found_path, allocator);
-  }
-  if (common_flags()->allow_addr2line) {
-    if (const char *found_path = FindPathToBinary("addr2line")) {
-      VReport(2, "Using addr2line found at: %s\n", found_path);
-      return new(*allocator) Addr2LinePool(found_path, allocator);
+  #if SANITIZER_APPLE
+    if (const char *found_path = FindPathToBinary("atos")) {
+      VReport(2, "Using atos found at: %s\n", found_path);
+      return new(*allocator) AtosSymbolizer(found_path, allocator);
     }
-  }
+  #endif  // SANITIZER_APPLE
+    if (const char *found_path = FindPathToBinary("llvm-symbolizer")) {
+      VReport(2, "Using llvm-symbolizer found at: %s\n", found_path);
+      return new(*allocator) LLVMSymbolizer(found_path, allocator);
+    }
+    if (common_flags()->allow_addr2line) {
+      if (const char *found_path = FindPathToBinary("addr2line")) {
+        VReport(2, "Using addr2line found at: %s\n", found_path);
+        return new(*allocator) Addr2LinePool(found_path, allocator);
+      }
+    }
+#endif // SANITIZER_DISABLE_SYMBOLIZER_PATH_SEARCH
   return nullptr;
 }
 

``````````

</details>


https://github.com/llvm/llvm-project/pull/129012