clang-tool-chain 1.1.4__py3-none-any.whl → 1.1.6__py3-none-any.whl

clang_tool_chain/__init__.py

@@ -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_runtime_dll_paths,
     get_symbolizer_path,
     prepare_sanitizer_environment,
 )
@@ -27,6 +30,9 @@ __all__ = [
     "CONTROLLABLE_FEATURES",
     # Sanitizer environment
     "prepare_sanitizer_environment",
+    "get_runtime_dll_paths",
     "get_symbolizer_path",
     "detect_sanitizers_from_flags",
+    "get_asan_runtime_dll",
+    "get_all_sanitizer_runtime_dlls",
 ]

clang_tool_chain/__version__.py

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

clang_tool_chain/execution/__init__.py

@@ -12,6 +12,7 @@ from clang_tool_chain.execution.build import build_main, build_run_main
 from clang_tool_chain.execution.core import execute_tool, run_tool, sccache_clang_cpp_main, sccache_clang_main
 from clang_tool_chain.execution.sanitizer_env import (
     detect_sanitizers_from_flags,
+    get_runtime_dll_paths,
     get_symbolizer_path,
     prepare_sanitizer_environment,
 )
@@ -29,5 +30,6 @@ __all__ = [
     # Sanitizer utilities
     "prepare_sanitizer_environment",
     "detect_sanitizers_from_flags",
+    "get_runtime_dll_paths",
     "get_symbolizer_path",
 ]

clang_tool_chain/execution/sanitizer_env.py

@@ -1,9 +1,9 @@
 """
 Sanitizer runtime environment configuration.
 
-This module provides automatic injection of ASAN_OPTIONS, LSAN_OPTIONS, and
-ASAN_SYMBOLIZER_PATH environment variables to improve stack trace quality
-when running executables compiled with Address Sanitizer or Leak Sanitizer.
+This module provides automatic injection of ASAN_OPTIONS, LSAN_OPTIONS,
+ASAN_SYMBOLIZER_PATH, and PATH environment variables to ensure executables
+compiled with Address Sanitizer or Leak Sanitizer can run correctly.
 
 The default options fix <unknown module> entries in stack traces from
 dlopen()'d shared libraries by enabling slow unwinding and symbolization.
@@ -11,6 +11,10 @@ dlopen()'d shared libraries by enabling slow unwinding and symbolization.
 The symbolizer path is automatically detected from the clang-tool-chain
 installation, enabling proper address-to-symbol resolution without manual
 configuration.
+
+On Windows with shared ASAN runtime (-shared-libasan), the clang runtime
+DLL directory is automatically added to PATH to ensure the ASAN DLL can
+be found at runtime.
 """
 
 import logging
@@ -71,6 +75,224 @@ def get_symbolizer_path() -> str | None:
     return None
 
 
+def get_runtime_dll_paths() -> list[str]:
+    """
+    Get paths to directories containing runtime DLLs (Windows only).
+
+    On Windows, when using shared ASAN runtime (-shared-libasan), the
+    libclang_rt.asan_dynamic-x86_64.dll must be findable at runtime.
+    This function returns the paths that should be added to PATH.
+
+    Returns:
+        List of directory paths containing runtime DLLs, or empty list
+        if not applicable (non-Windows or DLLs not found).
+
+    Example:
+        >>> paths = get_runtime_dll_paths()
+        >>> if paths:
+        ...     os.environ["PATH"] = os.pathsep.join(paths) + os.pathsep + os.environ.get("PATH", "")
+    """
+    if platform.system() != "Windows":
+        return []
+
+    paths = []
+
+    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 bin directory and sysroot bin directory
+        clang_bin_dir = get_platform_binary_dir()
+        clang_root = clang_bin_dir.parent
+
+        # Add clang bin directory (for some sanitizer DLLs)
+        if clang_bin_dir.exists():
+            paths.append(str(clang_bin_dir))
+
+        # Add MinGW sysroot bin directory (where libclang_rt.asan_dynamic-x86_64.dll lives)
+        if arch == "x86_64":
+            sysroot_name = "x86_64-w64-mingw32"
+        elif arch == "arm64":
+            sysroot_name = "aarch64-w64-mingw32"
+        else:
+            sysroot_name = None
+
+        if sysroot_name:
+            sysroot_bin = clang_root / sysroot_name / "bin"
+            if sysroot_bin.exists():
+                paths.append(str(sysroot_bin))
+                logger.debug(f"Found MinGW sysroot bin: {sysroot_bin}")
+
+    except (ImportError, RuntimeError) as e:
+        logger.debug(f"Could not get runtime DLL paths: {e}")
+
+    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.
@@ -224,6 +446,20 @@ def prepare_sanitizer_environment(
                 "or ensure clang-tool-chain is properly installed."
             )
 
+    # On Windows, add runtime DLL paths to PATH for shared ASAN runtime
+    # This ensures libclang_rt.asan_dynamic-x86_64.dll can be found at runtime
+    if asan_enabled and platform.system() == "Windows":
+        dll_paths = get_runtime_dll_paths()
+        if dll_paths:
+            current_path = env.get("PATH", "")
+            # Prepend DLL paths to ensure they take priority
+            new_path = os.pathsep.join(dll_paths)
+            if current_path:
+                env["PATH"] = new_path + os.pathsep + current_path
+            else:
+                env["PATH"] = new_path
+            logger.info(f"Injecting runtime DLL paths to PATH: {dll_paths}")
+
     # Add platform-specific LSan suppressions if LSAN is enabled
     if lsan_enabled:
         # Check if user explicitly disabled built-in suppressions with ""

{clang_tool_chain-1.1.4.dist-info → clang_tool_chain-1.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clang-tool-chain
-Version: 1.1.4
+Version: 1.1.6
 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.4.dist-info → clang_tool_chain-1.1.6.dist-info}/RECORD

@@ -1,5 +1,5 @@
-clang_tool_chain/__init__.py,sha256=u-qgOuQxh5W2g7n8BgUtBnUWsK66rM4N6LJXY9PiEx0,880
-clang_tool_chain/__version__.py,sha256=OZTe0l-1KRXG_B5GhtooBTlUxPJy68FJ5pyGG4KC95U,71
+clang_tool_chain/__init__.py,sha256=TS-fHsqErYIes4VJyZExhRMQjveVv7i99T9JjHJPpas,1064
+clang_tool_chain/__version__.py,sha256=YTx56JW89_upt38FX8hlUWfRFbv_i6nx3Au3Ysdk01M,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
@@ -38,7 +38,7 @@ clang_tool_chain/deployment/libdeploy.py,sha256=cfyDFmbuUmimss5fv7exO7NOulDnw7ag
 clang_tool_chain/deployment/so_deployer.py,sha256=eAygmGojioi1iz5cHeqmKjJ5fI-5XooG9Ro-5TIA0gw,12867
 clang_tool_chain/directives/__init__.py,sha256=MJDNYL_MD2MF0HFsrTsSTX645bYo6vtjq2pOTtfykaU,198
 clang_tool_chain/directives/parser.py,sha256=6J7mO1JtvuHkkKS0Xges5b_jT9b3uTF6ULI0ZiwGAdw,11179
-clang_tool_chain/execution/__init__.py,sha256=fFQEW9VejCdbBvt4quNJ2X8udh_PKgewTfzUXHmXzyc,940
+clang_tool_chain/execution/__init__.py,sha256=-jrL19U2UkP6qcUQVNq2qB0txg2TGXXTpXn_wXjVemg,996
 clang_tool_chain/execution/arg_transformers.py,sha256=Vut8XHp4IHkEUhVRI-NSvFaX6EvrGDd3FCEHbDe9gHo,26268
 clang_tool_chain/execution/build.py,sha256=YHS1BJTZg5pBS9czVko41mBdfswSPad5hxfitMoLvsI,13275
 clang_tool_chain/execution/build_pipeline.py,sha256=ORJEJ8WYp8c7bhWAa-e3w_ySXwenpUczlmXgoGByToY,17823
@@ -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=bLGUATKNnuB8WxWt1eopVgEh6bsZzkmpcpGxYOeRcHk,10642
+clang_tool_chain/execution/sanitizer_env.py,sha256=DgmSKOOGd0JxoKJfLkT9pDFXIfm4C6IWtECeeRGc838,19269
 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.4.dist-info/METADATA,sha256=EQviHfowQcUB26PHuj-VYtH5YfTNoE1b2D8DOXArOT8,60267
-clang_tool_chain-1.1.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clang_tool_chain-1.1.4.dist-info/entry_points.txt,sha256=N0a0OVPkCFbf6BisRkHj-m2TcZ-f1mqxfXxAHQxfrQg,2800
-clang_tool_chain-1.1.4.dist-info/licenses/LICENSE,sha256=51FO1oc2pZbQNI0v0_THnznnZIF4iFgawG1xnQ58kKo,10997
-clang_tool_chain-1.1.4.dist-info/RECORD,,
+clang_tool_chain-1.1.6.dist-info/METADATA,sha256=fUCTpvTHpVserQz52zpkBTZVZD0KoZR-AMxA4r3vmhc,60267
+clang_tool_chain-1.1.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+clang_tool_chain-1.1.6.dist-info/entry_points.txt,sha256=N0a0OVPkCFbf6BisRkHj-m2TcZ-f1mqxfXxAHQxfrQg,2800
+clang_tool_chain-1.1.6.dist-info/licenses/LICENSE,sha256=51FO1oc2pZbQNI0v0_THnznnZIF4iFgawG1xnQ58kKo,10997
+clang_tool_chain-1.1.6.dist-info/RECORD,,