如何通过--config参数覆盖gcc-toolchain默认模板实现自定义Wrapper

问题场景 #

正在为GCC编译器开发Wrapper，计划集成到已有默认模板的gcc-toolchain中。该工具链通过私有属性指定了默认模板：

_PRIVATE_ATTRS = {
    "_wrapper_sh_template": attr.label(
        default = Label("//toolchain:wrapper.sh.tpl"),
    ),
}

Wrapper由Python脚本和可执行文件安装逻辑组成，已通过defs.bzl实现核心逻辑：

# defs.bzl
def _wrapper_impl(repository_ctx):
    # 安装工具到指定目录的命令
    ins_dir =  repository_ctx.path("<installation_dir>")
    py_path =  repository_ctx.path("<python_script>")

    repository_ctx.template(
        "wrapper_sh", Label("//foo:wrapper_sh.tpl"),
        {"__ins_dir__":str(ins_dir),
         "__py_path__":str(py_path)},
        executable=True,
    )

    return None

gcc_toolchain = repository_rule(
    _wrapper_impl,
)

Wrapper模板wrapper_sh.tpl内容：

# wrapper_sh.tpl
# 工具参数与函数逻辑
exec __py_path__ __ins_dir__ <args to python> /usr/bin/gcc

需求是仅在传入--config=use_wrapper参数时启用该Wrapper，但尝试覆盖模板时因路径嵌入问题失败，无法实现按需切换。

解决方案 #

1. 用Bazel配置选择控制模板切换 #

修改gcc-toolchain的私有属性，通过select语法结合配置标志实现模板的条件默认值：

_PRIVATE_ATTRS = {
    "_wrapper_sh_template": attr.label(
        default = select({
            "@//conditions:use_wrapper": Label("//foo:wrapper_sh.tpl"),
            "//conditions:default": Label("//toolchain:wrapper.sh.tpl"),
        }),
    ),
}

在项目根目录的.bazelrc中添加配置标志映射：

build:use_wrapper --define=use_wrapper=true

2. 调整Repository规则传递路径参数 #

原有Wrapper生成逻辑中，路径参数是在repository_rule内嵌入模板的，需要让gcc-toolchain能正确获取这些动态生成的路径。修改gcc_toolchain规则，声明输出文件并返回路径：

def _wrapper_impl(repository_ctx):
    # 保留原有安装逻辑
    ins_dir = repository_ctx.path("<installation_dir>")
    py_path = repository_ctx.path("<python_script>")

    repository_ctx.template(
        "wrapper_sh", Label("//foo:wrapper_sh.tpl"),
        {"__ins_dir__": str(ins_dir), "__py_path__": str(py_path)},
        executable=True,
    )

    # 声明输出文件，让Bazel追踪依赖
    return [repository_ctx.path("wrapper_sh")]

gcc_toolchain = repository_rule(
    _wrapper_impl,
    outputs = ["wrapper_sh"],
)

然后在gcc-toolchain的实现逻辑中，根据配置标志判断是否使用生成的Wrapper：

def _gcc_toolchain_impl(ctx):
    # 原有工具链初始化逻辑
    wrapper_template = ctx.attr._wrapper_sh_template

    if ctx.var.get("use_wrapper") == "true":
        # 读取预生成的Wrapper内容
        wrapper_content = ctx.read(wrapper_template)
        # 生成最终可执行的Wrapper脚本
        ctx.actions.write(
            output = ctx.outputs.gcc_wrapper,
            content = wrapper_content,
            is_executable = True,
        )
    else:
        # 使用默认模板生成Wrapper
        ctx.actions.expand_template(
            template = wrapper_template,
            output = ctx.outputs.gcc_wrapper,
            substitutions = {}, # 默认模板的替换变量
            is_executable = True,
        )

3. 按需启用的使用流程 #

• 启用Wrapper时，执行构建命令：

bazel build --config=use_wrapper //your/target:target_name

• 不添加--config=use_wrapper时，自动使用原工具链的默认模板。

内容的提问来源于stack exchange，提问作者Anitha Syed