永久性工作器可让您的构建更快。如果您的 build 中存在启动开销较高或可从跨操作缓存中受益的重复操作,您可能需要实现自己的永久性工作器来执行这些操作。
Bazel 服务器使用 stdin
/stdout
与工作器通信。它支持使用协议缓冲区或 JSON 字符串。
工作器实现分为两个部分:
创建工作器
持久性工作器需要满足以下要求:
- 它会从
stdin
读取 WorkRequest。 - 它会将 WorkResponse(仅限
WorkResponse
)写入其stdout
。 - 它接受
--persistent_worker
标志。封装容器必须识别--persistent_worker
命令行标记,并且仅在传递该标记时使其自身保持持久性,否则它必须进行单次编译并退出。
如果您的程序满足这些要求,您就可以将其用作持久性工作器!
工作请求
WorkRequest
包含工作器的参数列表、表示工作器可以访问的输入的路径-摘要对列表(未强制执行,但您可以使用此信息进行缓存)以及请求 ID(对于单工工作器,此 ID 为 0)。
注意:虽然协议缓冲区规范使用“蛇形命名法”(request_id
),但 JSON 协议使用“驼峰式命名法”(requestId
)。本文档在 JSON 示例中使用的是驼峰式大小写,但在讨论字段时,无论采用何种协议,均使用蛇形命名法。
{
"arguments" : ["--some_argument"],
"inputs" : [
{ "path": "/path/to/my/file/1", "digest": "fdk3e2ml23d"},
{ "path": "/path/to/my/file/2", "digest": "1fwqd4qdd" }
],
"requestId" : 12
}
可选的 verbosity
字段可用于请求从 worker 获取额外的调试输出。工作器完全可以自行决定要输出什么以及如何输出。值越高,输出信息越详细。将 --worker_verbose
标志传递给 Bazel 会将 verbosity
字段设置为 10,但您可以针对不同的输出手动使用更小或更大的值。
可选的 sandbox_dir
字段仅供支持多路复用沙盒的工作器使用。
工作回复
WorkResponse
包含一个请求 ID、一个零或非零退出代码,以及一个用于描述处理或执行请求过程中遇到的任何错误的输出字符串。output
字段包含简短说明;完整的日志可能会写入工作器的 stderr
。由于工作器只能将 WorkResponses
写入 stdout
,因此工作器常常会将其使用的任何工具的 stdout
重定向到 stderr
。
{
"exitCode" : 1,
"output" : "Action failed with the following message:\nCould not find input
file \"/path/to/my/file/1\"",
"requestId" : 12
}
根据 protobuf 的标准,所有字段都是可选的。但是,Bazel 要求 WorkRequest
和相应的 WorkResponse
具有相同的请求 ID,因此如果请求 ID 不为零,则必须指定请求 ID。这是一个有效的 WorkResponse
。
{
"requestId" : 12,
}
request_id
为 0 表示“单工单”请求,当此请求无法与其他请求并行处理时使用。服务器可保证给定工作器收到的请求中,request_id
仅为 0 或仅为大于 0 的值。单播请求是串行发送的,例如,服务器在收到响应之前不会发送其他请求(取消请求除外,详见下文)。
备注
- 每个协议缓冲区前面都带有其长度(采用
varint
格式,请参阅MessageLite.writeDelimitedTo()
)。 - JSON 请求和响应的前面没有大小指示符。
- JSON 请求遵循与 protobuf 相同的结构,但使用标准 JSON 并对所有字段名称使用驼峰式大小写。
- 为了保持与 protobuf 相同的向后和向前兼容性属性,JSON 工作器必须容忍这些消息中的未知字段,并对缺失值使用 protobuf 默认值。
- Bazel 将请求存储为 protobuf,并使用 protobuf 的 JSON 格式将其转换为 JSON。
取消
工人可以选择允许在工作请求完成之前取消该请求。这在动态执行方面特别有用,因为在这种情况下,本地执行可能会经常被更快的远程执行中断。如需允许取消,请将 supports-worker-cancellation: 1
添加到 execution-requirements
字段(见下文),并设置 --experimental_worker_cancellation
标志。
取消请求是设置了 cancel
字段的 WorkRequest
(同样,取消响应是设置了 was_cancelled
字段的 WorkResponse
)。取消请求或取消响应中必须包含的唯一其他字段是 request_id
,用于指明要取消哪个请求。对于单工工作器,request_id
字段将为 0;对于多路复用工作器,request_id
字段将是之前发送的 WorkRequest
的非 0。服务器可能会针对 worker 已响应的请求发送取消请求,在这种情况下,必须忽略取消请求。
每条非取消 WorkRequest
消息都必须只回复一次,无论它是否被取消都是如此。服务器发送取消请求后,工作器可能会返回 WorkResponse
(设置 request_id
并将 was_cancelled
字段设置为 true)。您也可以发送常规的 WorkResponse
,但系统会忽略 output
和 exit_code
字段。
针对 WorkRequest
发送响应后,工作器不得触碰其工作目录中的文件。服务器可以随意清理文件,包括临时文件。
制定使用工作器的规则
您还需要创建一个规则,用于生成由 worker 执行的操作。创建使用工作器的 Starlark 规则与创建任何其他规则一样。
此外,该规则需要包含对 worker 本身的引用,并且对其生成的操作有一些要求。
引用 worker
使用工作器的规则需要包含一个引用工作器本身的字段,因此您需要创建 \*\_binary
规则的实例来定义工作器。如果您的工作器名为 MyWorker.Java
,则关联的规则可能是:
java_binary(
name = "worker",
srcs = ["MyWorker.Java"],
)
这将创建“工作器”标签,该标签指的是工作器二进制文件。然后,您将定义一条使用工作器的规则。此规则应定义一个引用工作器二进制文件的属性。
如果您构建的工作器二进制文件位于名为“work”的软件包(位于 build 的顶层)中,则属性定义可能是:
"worker": attr.label(
default = Label("//work:worker"),
executable = True,
cfg = "exec",
)
cfg = "exec"
表示应将 worker 构建为在执行平台(而不是目标平台)上运行(即,工作器在构建期间用作工具)。
工作操作要求
使用该 worker 的规则会为 worker 创建要执行的操作。这些操作有一些要求。
"arguments" 字段。此方法接受一个字符串列表,其中除最后一个字符串外,所有字符串都是在启动时传递给工作器的参数。“实参”列表中的最后一个元素是
flag-file
(带 @ 前缀)参数。工作器会按 WorkRequest 读取指定标志文件中的参数。您的规则可以将工作器的非启动参数写入此标志文件。"execution-requirements" 字段,它采用包含
"supports-workers" : "1"
和/或"supports-multiplex-workers" : "1"
的字典。发送到工作器的所有操作都需要“参数”和“执行要求”字段。此外,应由 JSON 工作器执行的操作需要在执行要求字段中包含
"requires-worker-protocol" : "json"
。"requires-worker-protocol" : "proto"
也是一项有效的执行要求,但 proto 工作器不需要它,因为它们是默认设置。您还可以在执行要求中设置
worker-key-mnemonic
。如果要将可执行文件重复用于多种操作类型,并希望区分此工作器的操作,这样做可能很有用。操作过程中生成的临时文件应保存到 worker 的目录中。这会启用沙盒功能。
假设规则定义包含上述“worker”属性,除了表示输入的“srcs”属性、表示输出的“output”属性和表示 worker 启动参数的“args”属性之外,对 ctx.actions.run
的调用可能为:
ctx.actions.run(
inputs=ctx.files.srcs,
outputs=[ctx.outputs.output],
executable=ctx.executable.worker,
mnemonic="someMnemonic",
execution_requirements={
"supports-workers" : "1",
"requires-worker-protocol" : "json"},
arguments=ctx.attr.args + ["@flagfile"]
)
如需查看其他示例,请参阅实现永久性工作器。
示例
除了用于我们的集成测试的示例 JSON 工作器之外,Bazel 代码库还使用 Java 编译器工作器。
您可以使用其基架,通过传入正确的回调将任何基于 Java 的工具放入工作器。
如需查看使用工作器的规则示例,请查看 Bazel 的工作器集成测试。
外部贡献者已使用多种语言实现了工作器;请参阅 Bazel 永久性工作器的多语言实现。您可以在 GitHub 上找到更多示例!