自動執行群組 (AEG)

回報問題 查看原始碼 Nightly · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0 · 7.1 · 7.0 · 6.5

自動執行群組會為每個工具鍊類型選取執行平台。換句話說,單一目標可以有多個執行平台,而無須定義執行群組。

簡要說明

自動執行群組與工具鍊密切相關。如果您使用工具鍊,則需要在受影響的動作 (使用可執行檔或工具鍊中的工具的動作) 上新增 toolchain 參數。例如:

ctx.actions.run(
    ...,
    executable = ctx.toolchain['@bazel_tools//tools/jdk:toolchain_type'].tool,
    ...,
    toolchain = '@bazel_tools//tools/jdk:toolchain_type',
)

如果動作未使用工具或工具鍊的可執行檔,而 Blaze 未偵測到 (錯誤已提示),您可以設定 toolchain = None

如果您需要在單一執行平台上使用多個工具鍊 (動作使用可執行檔或來自兩個或更多工具鍊的工具),就必須手動定義 exec_groups (請參閱「何時應使用自訂 exec_group?」一節)。

記錄

在 AEG 推出之前,執行平台是在規則層級選取。例如:

my_rule = rule(
    _impl,
    toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
)

規則 my_rule 會註冊兩種工具鍊類型。也就是說,Toolchain Resolution 會用來尋找支援兩種工具鍊類型的執行平台。除非使用 exec_groups 指定不同執行平台,否則系統會為規則中每個已註冊動作使用所選執行平台。換句話說,規則中的所有動作都會使用單一執行平台,即使這些動作使用不同工具鍊的工具 (每個目標都會選取執行平台) 也一樣。這會導致在沒有支援所有工具鍊的執行平台時發生失敗。

目前狀態

使用 AEG 時,系統會為每個工具鍊類型選取執行平台。先前範例 my_rule 的實作函式如下所示:

def _impl(ctx):
    ctx.actions.run(
      mnemonic = "First action",
      executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
      toolchain = '//tools:toolchain_type_1',
    )

    ctx.actions.run(
      mnemonic = "Second action",
      executable = ctx.toolchain['//tools:toolchain_type_2'].tool,
      toolchain = '//tools:toolchain_type_2',
    )

這項規則會建立兩個動作:First action 會使用 //tools:toolchain_type_1 中的可執行檔,Second action 則會使用 //tools:toolchain_type_2 中的可執行檔。在 AEG 之前,這兩項動作都會在單一執行平台上執行,該平台支援這兩種工具鍊類型。在 AEG 中,只要在動作中新增 toolchain 參數,每個動作就會在提供工具鍊的執行平台上執行。這些動作可能會在不同的執行平台上執行。

同樣適用於 ctx.actions.run_shell,在 tools 來自工具鍊時,應新增 toolchain 參數。

自訂執行群組和自動執行群組的差異

顧名思義,AEG 是針對規則中註冊的每個工具鍊類型自動建立的執行群組。與「傳統」執行群組不同,您不需要手動指定這些群組。

何時該使用自訂 exec_group?

只有在需要在單一執行平台上執行多個工具鍊時,才需要自訂 exec_groups。在其他情況下,您不需要定義自訂 exec_groups。例如:

def _impl(ctx):
    ctx.actions.run(
      ...,
      executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
      tools = [ctx.toolchain['//tools:toolchain_type_2'].tool],
      exec_group = 'two_toolchains',
    )
my_rule = rule(
    _impl,
    exec_groups = {
        "two_toolchains": exec_group(
            toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
        ),
    }
)

AEG 遷移

在 google3 內部,Blaze 已開始使用 AEG。對於外部 Bazel 而言,遷移作業正在進行中。部分規則已在使用這項功能 (例如 Java 和 C++ 規則)。

哪些 Bazel 版本支援這項遷移作業?

從 Bazel 7 開始,AEG 已全面支援。

如何啟用 AEG?

--incompatible_auto_exec_groups 設為 true。如要進一步瞭解此標記,請參閱 GitHub 問題

如何在特定規則中啟用 AEG?

為規則設定 _use_auto_exec_groups 屬性。

my_rule = rule(
    _impl,
    attrs = {
      "_use_auto_exec_groups": attr.bool(default = True),
    }
)

這樣一來,只有 my_rule 和其動作會在選取執行平台時開始使用新邏輯。這個屬性會覆寫不相容標記。

如何在發生錯誤時停用 AEG?

--incompatible_auto_exec_groups 設為 false,即可完全停用專案中的 AEG (flag 的 GitHub 問題),或將 _use_auto_exec_groups 屬性設為 False,即可停用特定規則 (屬性詳情)。

遷移至 AEG 時顯示的錯誤訊息

無法判斷工具是來自隱含的依附元件還是工具鍊。請設定工具鍊參數。如果您未使用工具鍊,請將其設為「None」。

  • 在這種情況下,您會在發生錯誤之前取得一堆呼叫,並清楚看到哪些確切動作需要工具鍊參數。請檢查哪個工具鍊用於動作,並使用工具鍊參數進行設定。如果工具或可執行檔的動作中未使用任何工具鍊,請將其設為 None

為不存在的工具鍊「[toolchain_type]」宣告的動作。

  • 這表示您已在動作上設定工具鍊參數,但未在規則上註冊該參數。註冊工具鍊或在動作中設定 None

其他材料

詳情請參閱設計文件:工具鍊的自動執行群組