Add bzlmod extension for sanitizer_libs (#3404)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: phlax <454682+phlax@users.noreply.github.com>

Author: Copilot

bazel/MODULE.bazel

@@ -68,6 +68,19 @@ sysroot_ext = use_extension("//sysroot:extensions.bzl", "sysroot_extension", dev
 sysroot_ext.setup()
 use_repo(sysroot_ext, "sysroot_linux_amd64", "sysroot_linux_arm64")
 
+# Setup sanitizer libraries (MSAN and TSAN) - example for downstream consumers
+# Uncomment to use in your MODULE.bazel:
+# sanitizer_ext = use_extension("@envoy_toolshed//compile:extensions.bzl", "sanitizer_extension")
+# sanitizer_ext.setup()  # Uses default versions from VERSIONS
+# # Or with custom versions:
+# # sanitizer_ext.setup(
+# #     msan_version = "0.1.34",
+# #     msan_sha256 = "534e5e6893f177f891d78d6e85a80c680c84f0abd64681f8ddbf2f5457e97a52",
+# #     tsan_version = "0.1.34",
+# #     tsan_sha256 = "2cd571a07014972ff9bc0f189c5725c2ea121aeab0daa4c27ef171842ea13985",
+# # )
+# use_repo(sanitizer_ext, "msan_libs", "tsan_libs")
+
 # Configure LLVM toolchain
 llvm = use_extension("@toolchains_llvm//toolchain/extensions:llvm.bzl", "llvm", dev_dependency=True)
 llvm.toolchain(

bazel/compile/BUILD

@@ -5,7 +5,7 @@ load("//:versions.bzl", "VERSIONS")
 
 package(default_visibility = ["//visibility:public"])
 
-exports_files(["sanitizer_libs.bzl"])
+exports_files(["sanitizer_libs.bzl", "extensions.bzl"])
 
 SANITIZER_ENV = {
     "CXXFLAGS": "-nostdinc++ -nostdlib++",

bazel/compile/README.md

@@ -38,3 +38,41 @@ The sanitizer libraries are automatically built and published to GitHub releases
    "msan_libs_sha256": "...",  # Add actual SHA256
    "tsan_libs_sha256": "...",  # Add actual SHA256
    ```
+
+## Using with WORKSPACE
+
+In your WORKSPACE file:
+
+```starlark
+load("@envoy_toolshed//compile:sanitizer_libs.bzl", "setup_sanitizer_libs")
+
+setup_sanitizer_libs()
+```
+
+This will create `@msan_libs` and `@tsan_libs` repositories you can use in your builds.
+
+## Using with bzlmod (MODULE.bazel)
+
+In your MODULE.bazel file:
+
+```starlark
+bazel_dep(name = "envoy_toolshed", version = "0.3.12")
+
+# Setup sanitizer libraries
+sanitizer_ext = use_extension("@envoy_toolshed//compile:extensions.bzl", "sanitizer_extension")
+sanitizer_ext.setup()  # Uses default versions
+use_repo(sanitizer_ext, "msan_libs", "tsan_libs")
+```
+
+Or with custom versions:
+
+```starlark
+sanitizer_ext = use_extension("@envoy_toolshed//compile:extensions.bzl", "sanitizer_extension")
+sanitizer_ext.setup(
+    msan_version = "0.1.34",
+    msan_sha256 = "534e5e6893f177f891d78d6e85a80c680c84f0abd64681f8ddbf2f5457e97a52",
+    tsan_version = "0.1.34",
+    tsan_sha256 = "2cd571a07014972ff9bc0f189c5725c2ea121aeab0daa4c27ef171842ea13985",
+)
+use_repo(sanitizer_ext, "msan_libs", "tsan_libs")
+```

bazel/compile/extensions.bzl

@@ -0,0 +1,57 @@
+"""Module extension for sanitizer libraries configuration in bzlmod."""
+
+load(":sanitizer_libs.bzl", "setup_sanitizer_libs")
+
+def _sanitizer_libs_impl(module_ctx):
+    """Implementation of the sanitizer_libs module extension.
+
+    This extension allows configuring sanitizer libraries in MODULE.bazel using
+    the same setup_sanitizer_libs() function used in WORKSPACE.
+    """
+
+    # Collect all setup tags from all modules
+    # Only use the first tag found (sanitizer repos have fixed names)
+    setup_tag = None
+    for mod in module_ctx.modules:
+        for tag in mod.tags.setup:
+            if setup_tag == None:
+                setup_tag = tag
+            else:
+                # Fail if multiple tags are found
+                fail("Multiple setup() calls found for sanitizer_extension. Only one configuration is allowed since repository names are fixed to @msan_libs and @tsan_libs.")
+
+    # Call setup_sanitizer_libs once with the configuration
+    if setup_tag:
+        setup_sanitizer_libs(
+            msan_version = setup_tag.msan_version,
+            msan_sha256 = setup_tag.msan_sha256,
+            tsan_version = setup_tag.tsan_version,
+            tsan_sha256 = setup_tag.tsan_sha256,
+        )
+    else:
+        # Use default configuration if no tags specified
+        setup_sanitizer_libs()
+
+_setup = tag_class(
+    attrs = {
+        "msan_version": attr.string(
+            doc = "Version of MSAN release to use (default: VERSIONS['bins_release'] from //:versions.bzl)",
+        ),
+        "msan_sha256": attr.string(
+            doc = "SHA256 hash of the MSAN libs archive (default: VERSIONS['msan_libs_sha256'] from //:versions.bzl)",
+        ),
+        "tsan_version": attr.string(
+            doc = "Version of TSAN release to use (default: VERSIONS['bins_release'] from //:versions.bzl)",
+        ),
+        "tsan_sha256": attr.string(
+            doc = "SHA256 hash of the TSAN libs archive (default: VERSIONS['tsan_libs_sha256'] from //:versions.bzl)",
+        ),
+    },
+)
+
+sanitizer_extension = module_extension(
+    implementation = _sanitizer_libs_impl,
+    tag_classes = {
+        "setup": _setup,
+    },
+)