clang-tool-chain 1.1.5__py3-none-any.whl → 1.1.7__py3-none-any.whl

clang_tool_chain/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.30"
+__version__ = "1.1.7"
 
 # Re-export commonly used functions for convenient access
 from clang_tool_chain.env_utils import (
@@ -9,6 +9,9 @@ from clang_tool_chain.env_utils import (
 )
 from clang_tool_chain.execution.sanitizer_env import (
     detect_sanitizers_from_flags,
+    get_all_sanitizer_runtime_dlls,
+    get_asan_runtime_dll,
+    get_default_asan_options,
     get_runtime_dll_paths,
     get_symbolizer_path,
     prepare_sanitizer_environment,
@@ -31,4 +34,7 @@ __all__ = [
     "get_runtime_dll_paths",
     "get_symbolizer_path",
     "detect_sanitizers_from_flags",
+    "get_asan_runtime_dll",
+    "get_all_sanitizer_runtime_dlls",
+    "get_default_asan_options",
 ]

clang_tool_chain/__version__.py

@@ -1,3 +1,3 @@
 """Version information for clang-tool-chain."""
 
-__version__ = "1.1.5"
+__version__ = "1.1.7"

clang_tool_chain/execution/sanitizer_env.py

@@ -30,11 +30,47 @@ logger = logging.getLogger(__name__)
 # Default options to inject for optimal stack traces
 # fast_unwind_on_malloc=0: Use slow but accurate unwinding (fixes <unknown module>)
 # symbolize=1: Enable symbolization for readable stack traces
-# detect_leaks=1: Enable leak detection (ASAN only)
-DEFAULT_ASAN_OPTIONS = "fast_unwind_on_malloc=0:symbolize=1:detect_leaks=1"
+# detect_leaks=1: Enable leak detection (ASAN only, NOT on Windows - LSAN unsupported)
+#
+# LeakSanitizer (LSAN) is NOT supported on Windows. Only Linux, macOS, Android,
+# Fuchsia, and NetBSD are supported. See: https://clang.llvm.org/docs/LeakSanitizer.html
+#
+# On Windows, setting detect_leaks=1 causes immediate failure with:
+#   "AddressSanitizer: detect_leaks is not supported on this platform."
+_BASE_ASAN_OPTIONS = "fast_unwind_on_malloc=0:symbolize=1"
 DEFAULT_LSAN_OPTIONS = "fast_unwind_on_malloc=0:symbolize=1"
 
 
+def get_default_asan_options() -> str:
+    """
+    Get platform-appropriate default ASAN options.
+
+    Returns options string with detect_leaks=1 only on platforms where
+    LeakSanitizer is supported (Linux, macOS). Windows does not support
+    LSAN, so detect_leaks is omitted to prevent runtime failures.
+
+    Returns:
+        ASAN options string appropriate for the current platform.
+
+    Example:
+        >>> get_default_asan_options()  # On Linux/macOS
+        'fast_unwind_on_malloc=0:symbolize=1:detect_leaks=1'
+        >>> get_default_asan_options()  # On Windows
+        'fast_unwind_on_malloc=0:symbolize=1'
+    """
+    if platform.system() == "Windows":
+        # LSAN (LeakSanitizer) is not supported on Windows
+        # See: https://clang.llvm.org/docs/LeakSanitizer.html
+        return _BASE_ASAN_OPTIONS
+    # Linux, macOS, and other platforms support LSAN
+    return f"{_BASE_ASAN_OPTIONS}:detect_leaks=1"
+
+
+# For backward compatibility - this is now dynamically computed
+# Code that imports DEFAULT_ASAN_OPTIONS directly will get the platform-appropriate value
+DEFAULT_ASAN_OPTIONS = get_default_asan_options()
+
+
 def get_symbolizer_path() -> str | None:
     """
     Get the path to llvm-symbolizer from the clang-tool-chain installation.
@@ -131,6 +167,168 @@ def get_runtime_dll_paths() -> list[str]:
     return paths
 
 
+def get_asan_runtime_dll() -> Path | None:
+    """
+    Get the full path to the ASAN runtime DLL (Windows only).
+
+    This function locates the shared ASAN runtime DLL used when compiling
+    with -fsanitize=address -shared-libasan. The DLL must be accessible
+    at runtime for ASAN-instrumented executables to run.
+
+    This is particularly useful when running tests via build systems like
+    Meson that reset PATH and don't inherit ASAN DLL directories. By getting
+    the DLL path, consuming projects can copy it to their build directory
+    where the build system will automatically discover it.
+
+    Returns:
+        Path to libclang_rt.asan_dynamic-x86_64.dll (or ARM64 equivalent),
+        or None if not found or not on Windows.
+
+    Example:
+        >>> dll_path = get_asan_runtime_dll()
+        >>> if dll_path:
+        ...     shutil.copy(dll_path, build_dir / dll_path.name)
+        ...     # Now Meson tests will find the ASAN DLL in build_dir
+
+    Note:
+        This function ensures the toolchain is downloaded before searching.
+        The DLL is typically located in the MinGW sysroot bin directory:
+        ~/.clang-tool-chain/clang/win/x86_64/x86_64-w64-mingw32/bin/
+
+    See Also:
+        get_runtime_dll_paths: Returns directories containing runtime DLLs
+        prepare_sanitizer_environment: Adds DLL paths to PATH
+    """
+    if platform.system() != "Windows":
+        logger.debug("get_asan_runtime_dll: Not on Windows, returning None")
+        return None
+
+    try:
+        from clang_tool_chain.platform.detection import get_platform_binary_dir, get_platform_info
+
+        # Get platform info for sysroot lookup
+        _platform_name, arch = get_platform_info()
+
+        # Get the clang root directory
+        clang_bin_dir = get_platform_binary_dir()
+        clang_root = clang_bin_dir.parent
+
+        # Determine sysroot and DLL name based on architecture
+        if arch == "x86_64":
+            sysroot_name = "x86_64-w64-mingw32"
+            dll_name = "libclang_rt.asan_dynamic-x86_64.dll"
+        elif arch == "arm64":
+            sysroot_name = "aarch64-w64-mingw32"
+            dll_name = "libclang_rt.asan_dynamic-aarch64.dll"
+        else:
+            logger.debug(f"get_asan_runtime_dll: Unsupported architecture {arch}")
+            return None
+
+        # Check MinGW sysroot bin directory first (primary location)
+        sysroot_bin = clang_root / sysroot_name / "bin"
+        dll_path = sysroot_bin / dll_name
+        if dll_path.exists():
+            logger.debug(f"Found ASAN runtime DLL: {dll_path}")
+            return dll_path
+
+        # Fallback: check clang bin directory
+        dll_path = clang_bin_dir / dll_name
+        if dll_path.exists():
+            logger.debug(f"Found ASAN runtime DLL (fallback): {dll_path}")
+            return dll_path
+
+        # Try glob pattern for any ASAN DLL (version may vary)
+        for search_dir in [sysroot_bin, clang_bin_dir]:
+            if search_dir.exists():
+                for dll_file in search_dir.glob("libclang_rt.asan*.dll"):
+                    logger.debug(f"Found ASAN runtime DLL (glob): {dll_file}")
+                    return dll_file
+
+        logger.debug(f"ASAN runtime DLL not found in {sysroot_bin} or {clang_bin_dir}")
+        return None
+
+    except (ImportError, RuntimeError) as e:
+        logger.debug(f"Could not get ASAN runtime DLL path: {e}")
+        return None
+
+
+def get_all_sanitizer_runtime_dlls() -> list[Path]:
+    """
+    Get all sanitizer runtime DLLs (Windows only).
+
+    This function locates all shared sanitizer runtime DLLs, including:
+    - Address Sanitizer (ASAN)
+    - Undefined Behavior Sanitizer (UBSAN)
+    - Thread Sanitizer (TSAN) - if available
+
+    This is useful for projects that want to copy all sanitizer DLLs to
+    their build directory to ensure all instrumented code can run.
+
+    Returns:
+        List of Paths to sanitizer runtime DLLs, or empty list if not
+        found or not on Windows.
+
+    Example:
+        >>> dlls = get_all_sanitizer_runtime_dlls()
+        >>> for dll in dlls:
+        ...     shutil.copy(dll, build_dir / dll.name)
+
+    See Also:
+        get_asan_runtime_dll: Returns just the ASAN DLL path
+    """
+    if platform.system() != "Windows":
+        return []
+
+    dlls: list[Path] = []
+
+    try:
+        from clang_tool_chain.platform.detection import get_platform_binary_dir, get_platform_info
+
+        # Get platform info for sysroot lookup
+        _platform_name, arch = get_platform_info()
+
+        # Get the clang root directory
+        clang_bin_dir = get_platform_binary_dir()
+        clang_root = clang_bin_dir.parent
+
+        # Determine sysroot based on architecture
+        if arch == "x86_64":
+            sysroot_name = "x86_64-w64-mingw32"
+        elif arch == "arm64":
+            sysroot_name = "aarch64-w64-mingw32"
+        else:
+            return []
+
+        # Search directories
+        search_dirs = [
+            clang_root / sysroot_name / "bin",
+            clang_bin_dir,
+        ]
+
+        # Patterns for sanitizer DLLs
+        patterns = [
+            "libclang_rt.asan*.dll",  # Address Sanitizer
+            "libclang_rt.ubsan*.dll",  # Undefined Behavior Sanitizer
+            "libclang_rt.tsan*.dll",  # Thread Sanitizer
+            "libclang_rt.lsan*.dll",  # Leak Sanitizer (standalone)
+        ]
+
+        seen_names: set[str] = set()
+        for search_dir in search_dirs:
+            if search_dir.exists():
+                for pattern in patterns:
+                    for dll_file in search_dir.glob(pattern):
+                        if dll_file.name not in seen_names:
+                            dlls.append(dll_file)
+                            seen_names.add(dll_file.name)
+                            logger.debug(f"Found sanitizer DLL: {dll_file}")
+
+    except (ImportError, RuntimeError) as e:
+        logger.debug(f"Could not get sanitizer runtime DLLs: {e}")
+
+    return dlls
+
+
 def detect_sanitizers_from_flags(compiler_flags: list[str]) -> tuple[bool, bool]:
     """
     Detect which sanitizers are enabled from compiler flags.
@@ -263,8 +461,9 @@ def prepare_sanitizer_environment(
 
     # Inject ASAN_OPTIONS if ASAN is enabled and not already set by user
     if asan_enabled and "ASAN_OPTIONS" not in env:
-        env["ASAN_OPTIONS"] = DEFAULT_ASAN_OPTIONS
-        logger.info(f"Injecting ASAN_OPTIONS={DEFAULT_ASAN_OPTIONS}")
+        asan_options = get_default_asan_options()
+        env["ASAN_OPTIONS"] = asan_options
+        logger.info(f"Injecting ASAN_OPTIONS={asan_options}")
 
     # Inject LSAN_OPTIONS if LSAN is enabled and not already set by user
     if lsan_enabled and "LSAN_OPTIONS" not in env:

{clang_tool_chain-1.1.5.dist-info → clang_tool_chain-1.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clang-tool-chain
-Version: 1.1.5
+Version: 1.1.7
 Summary: Clang Tool Chain - C/C++ compilation toolchain utilities
 Project-URL: Homepage, https://github.com/zackees/clang-tool-chain
 Project-URL: Repository, https://github.com/zackees/clang-tool-chain

{clang_tool_chain-1.1.5.dist-info → clang_tool_chain-1.1.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
-clang_tool_chain/__init__.py,sha256=nLK5yA3seauLHvtQN3Qfe8_XLfbs8b-noek_3baRRZc,936
-clang_tool_chain/__version__.py,sha256=jG7OiD1U-R4k5RPrITUrVwY2AnwCm3EQkm__FP_IjMI,71
+clang_tool_chain/__init__.py,sha256=Ac2qUqz9rzFHvXLkH6kqf63m-1JywYcJckKrbLft2ag,1125
+clang_tool_chain/__version__.py,sha256=gVI5QWADLkUhsYHs8TuVovVei5SJ_bx5saZRIWgkOTU,71
 clang_tool_chain/archive.py,sha256=t3reh7cm5XP2rhTqfRIDAQZv5XQq7SsstyiROYg8wFA,27697
 clang_tool_chain/archive_cache.py,sha256=5ZmlwXIJZDcrDFkTbdgBQYN9sulGn0WyI6qwWqC4HEU,6806
 clang_tool_chain/checksums.py,sha256=KFXeAeDz5ZlcZVOxsHDpNDCrm9UDoJ8bMA4PeNhuzdA,9868
@@ -49,7 +49,7 @@ clang_tool_chain/execution/iwyu.py,sha256=bmP0d_PZObA1JfmFYp3qIOKCb7y32AWPm2_ReF
 clang_tool_chain/execution/lldb.py,sha256=VpxkWTPS6PsyskaKTALeziR5Z5NLwarW174Fm1SMX9k,20718
 clang_tool_chain/execution/nodejs_resolver.py,sha256=8QsJWvIfmt5mBDV7n0ypSjsPyXS-eZTizhBli937I-g,11172
 clang_tool_chain/execution/platform_executor.py,sha256=sF4GyW0ujy2EewG8y2Eo1gUWGzss5G5iIkv02w7-2_o,14362
-clang_tool_chain/execution/sanitizer_env.py,sha256=OE00wOEaLm-HIWL1fdjhQWEZ9D1hVN3bYfMxUEo8ZiQ,13364
+clang_tool_chain/execution/sanitizer_env.py,sha256=IHxmeAzbbdrIAz38c2U3erunTVjHjePx7BytVBzluB4,20766
 clang_tool_chain/installers/__init__.py,sha256=NAV5woPCEDKSbFr1UmfQsrg4Ua5UdghN4q7H3ymvRsg,279
 clang_tool_chain/installers/base.py,sha256=OS78bau9zoYPitmhla7pKsfCPEj-zLY0DkvVzjE31Tw,15437
 clang_tool_chain/installers/clang.py,sha256=rUtheVRF7mq_1YdmQ3XzIybrJqsHbm2Xf0cbhRbH7RQ,16994
@@ -71,8 +71,8 @@ clang_tool_chain/symbolizer/unwind_windows.h,sha256=XTWhJDv13AAMUPAzWCfRN7tO6EbN
 clang_tool_chain/testing/__init__.py,sha256=-sYqOOCuTV_u-MkmExrD4uKdTHG4RmMwR3D1kIG281Q,208
 clang_tool_chain/testing/diagnostic_runner.py,sha256=mnmFUEOQulY3-Ggu6hKVGZwjrKQNmV6kY80PRTUu2qU,5293
 clang_tool_chain/testing/diagnostic_tests.py,sha256=GmtKWrDcddZTpx9_yIKfhRAy6YOde8dj7SksCWVEME4,6019
-clang_tool_chain-1.1.5.dist-info/METADATA,sha256=V3_teL2iXVtyGp-CJKBjeYgC2UhYj0KlTXc2d9pWZtQ,60267
-clang_tool_chain-1.1.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clang_tool_chain-1.1.5.dist-info/entry_points.txt,sha256=N0a0OVPkCFbf6BisRkHj-m2TcZ-f1mqxfXxAHQxfrQg,2800
-clang_tool_chain-1.1.5.dist-info/licenses/LICENSE,sha256=51FO1oc2pZbQNI0v0_THnznnZIF4iFgawG1xnQ58kKo,10997
-clang_tool_chain-1.1.5.dist-info/RECORD,,
+clang_tool_chain-1.1.7.dist-info/METADATA,sha256=m33JQp6EzIWtJsAFjwat9lcI-kGIXmh902VQZ2IQwb8,60267
+clang_tool_chain-1.1.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clang_tool_chain-1.1.7.dist-info/entry_points.txt,sha256=N0a0OVPkCFbf6BisRkHj-m2TcZ-f1mqxfXxAHQxfrQg,2800
+clang_tool_chain-1.1.7.dist-info/licenses/LICENSE,sha256=51FO1oc2pZbQNI0v0_THnznnZIF4iFgawG1xnQ58kKo,10997
+clang_tool_chain-1.1.7.dist-info/RECORD,,