多重工作器(实验性功能)

本页面介绍了多路复用工作器、如何编写与多路复用兼容的规则,以及针对某些限制的解决方法。

借助多重工作器,Bazel 可以通过单个工作器进程处理多个请求。对于多线程工作器,Bazel 可以使用更少的资源来实现相同或更好的性能。例如,Bazel 可以使 4 个多路复用工作器与同一个工作器进程通信,从而使它们并行处理请求,而不是为每个工作器设置一个工作器进程。对于 Java 和 Scala 等语言,这样做可以节省 JVM 预热时间和 JIT 编译时间,并且通常允许在相同类型的所有工作器之间使用一个共享缓存。

概览

Bazel 服务器和工作器进程之间存在两层。对于某些可以并行运行进程的助记符,Bazel 会从工作器池获取 WorkerProxyWorkerProxy 依次将请求与 request_id 一起转发到工作器进程,工作器进程会处理请求并将响应发送到 WorkerMultiplexer。当 WorkerMultiplexer 收到响应时,它会解析 request_id,然后将响应传回正确的 WorkerProxy。与非多路复用工作器一样,所有通信都是通过标准输入/输出完成,但该工具不能只将 stderr 用于用户可见的输出(见下文)。

每个 worker 都有一个密钥。Bazel 使用密钥的哈希代码(由环境变量、执行根和助记符组成)来确定使用哪个WorkerMultiplexer。如果WorkerProxy具有相同的哈希代码,则 Bazel 会与相同的WorkerMultiplexer通信。因此,假设单次 Bazel 调用中的环境变量和执行根相同,则每个唯一的助记符只能有一个 WorkerMultiplexer 和一个工作器进程。工作器总数(包括常规工作器和 WorkerProxy)仍受 --worker_max_instances 限制。

编写兼容多重广告的规则

该规则的工作器进程应为多线程的,以便利用多路复用工作器。即使数据流中可能堆积了多个请求,协议缓冲区也允许规则集解析单个请求。每当工作器进程解析来自数据流的请求时,都应在新线程中处理该请求。由于不同的线程可能会同时完成并向数据流写入数据,因此工作器进程需要确保响应是以原子方式写入的(消息不重叠)。响应必须包含它们所处理的请求的 request_id

处理多路复用输出

与单工工作器相比,多路复用工作器在处理其输出时需要更加小心。发送到 stderr 的任何内容都将放入同一类型的所有 WorkerProxy 共享的单个日志文件中,该文件在并发请求之间随机交错。虽然将 stdout 重定向到 stderr 是个好主意,但请勿将该输出收集到 WorkResponseoutput 字段中,因为这样可能会导致用户损坏的输出片段。如果您的工具仅将面向用户的输出发送到 stdoutstderr,则您需要先更改该行为,然后才能启用多路复用工作器。

启用多路复用工作器

默认情况下,多重工作器处于未启用状态。规则集可以在操作的 execution_requirements 中使用 supports-multiplex-workers 标记来启用多路复用工作器(就像 supports-workers 标记启用常规工作器一样)。与使用常规工作器时一样,需要在规则集级别(例如 --strategy=[some_mnemonic]=worker)或通常在策略级别(例如 --dynamic_local_strategy=worker,standalone)指定工作器策略。无需额外的标志,并且 supports-multiplex-workers 优先于 supports-workers(如果同时设置了两者)。您可以通过传递 --noexperimental_worker_multiplex 在全球范围内关闭多路复用工作器。

建议使用规则集尽可能使用多路复用工作器,以降低内存压力并提升性能。但是,除非实现多路复用沙盒,否则多路复用工作器目前与动态执行不兼容。如果您尝试使用动态执行方式运行非沙盒化多路复用 worker,则会以静默方式使用沙盒化单工 worker。

多重沙盒

通过在 worker 实现中添加对多重工作器的明确支持,可以对多重 worker 进行沙盒化。虽然单工工作器沙盒可以通过在自己的沙盒中运行每个工作器进程来实现,但多路工作器工作器会在多个并行请求之间共享进程工作目录。如需允许将多路复用工作器沙盒化,工作器必须支持在每个请求中指定的子目录中读取和写入数据,而不是直接在其工作目录中执行读写操作。

如需支持多路复用沙盒,工作器必须使用 WorkRequest 中的 sandbox_dir 字段,并将其用作所有文件读写操作的前缀。虽然未经过沙盒屏蔽的请求中的 argumentsinputs 字段保持不变,但实际输入相对于 sandbox_dir。工作器必须转换在 argumentsinputs 中找到的文件路径才能从此修改后的路径中读取数据,并且还必须写入相对于 sandbox_dir 的所有输出。这包括“.”等路径以及在参数(如 "argfile" 参数)中指定的文件中找到的路径。

工作器支持多路复用沙盒后,规则集可以通过将 supports-multiplex-sandboxing 添加到操作的 execution_requirements 中来声明此支持。然后,如果传递了 --experimental_worker_multiplex_sandboxing 标志或者工作器用于动态执行,Bazel 将使用多路沙盒。

沙盒化多路复用工作器的工作器文件仍相对于工作器进程的工作目录。因此,如果文件同时用于运行 worker 和输入,则必须同时在 flagfile 参数以及 toolsexecutablerunfiles 中指定为输入。