実行グループ

実行グループを使用すると、1 つのターゲット内で複数の実行プラットフォームを使用できます。各実行グループには独自のツールチェーン依存関係があり、独自のツールチェーンの解決を行います。

背景

ルールの作成者は、実行グループを使用して一連のアクションを定義できます。各アクションには、実行プラットフォームが異なる可能性があります。複数の実行プラットフォームでは、アクションを異なる方法で実行できます。たとえば、リモート（Linux）ワーカーで iOS アプリをコンパイルし、ローカルの Mac ワーカーでリンクとコード署名を行うことができます。

アクションのグループを定義できると、アクションを指定するプロキシとしてアクションの頭文字を使用する必要がなくなります。ニーモニックは一意であることが保証されているわけではなく、1 つのアクションのみを参照できます。これは、負荷の少ないタスクに過剰に割り当てることなく、特定のメモリと処理負荷の高いアクション（C++ ビルドでのリンクなど）に追加のリソースを割り当てる場合に特に役立ちます。

実行グループの定義

ルールの定義時に、一連の実行グループをdeclareできます。ルール作成者は、各実行グループで、その実行グループの実行プラットフォームの選択に必要なすべてのものを指定できます。つまり、exec_compatible_with による制約と toolchain によるツールチェーンタイプです。

# foo.bzl
my_rule = rule(
    _impl,
    exec_groups = {
        “link”: exec_group(
            exec_compatible_with = [ "@platforms//os:linux" ]
            toolchains = ["//foo:toolchain_type"],
        ),
        “test”: exec_group(
            toolchains = ["//foo_tools:toolchain_type"],
        ),
    },
    attrs = {
        "_compiler": attr.label(cfg = config.exec("link"))
    },
)

上のコードスニペットでは、ツールの依存関係で cfg 属性パラメータと config モジュールを使用して、実行グループの遷移を指定することもできます。このモジュールは、依存関係をビルドする exec グループの名前である単一の文字列パラメータを取る exec 関数を公開します。

ネイティブルールと同様に、Starlark テストルールには test 実行グループがデフォルトで含まれています。

実行グループへのアクセス

ルールの実装では、アクションを実行グループの実行プラットフォームで実行するように宣言できます。これを行うには、アクション生成メソッドの exec_group パラメータ（具体的には ctx.actions.run と ctx.actions.run_shell）を使用します。

# foo.bzl
def _impl(ctx):
  ctx.actions.run(
     inputs = [ctx.attr._some_tool, ctx.srcs[0]]
     exec_group = "compile",
     # ...
  )

ルールの作成者は、ターゲットの解決済みツールチェーンにアクセスする方法と同様に、実行グループの解決済みツールチェーンにもアクセスできます。

# foo.bzl
def _impl(ctx):
  foo_info = ctx.exec_groups["link"].toolchains["//foo:toolchain_type"].fooinfo
  ctx.actions.run(
     inputs = [foo_info, ctx.srcs[0]]
     exec_group = "link",
     # ...
  )

実行グループを使用して実行プロパティを設定する

実行グループは、すべてのルールに存在する exec_properties 属性と統合されており、ターゲットライターはプロパティの文字列辞書を指定して、実行メカニズムに渡すことができます。たとえば、ターゲットにメモリなどのプロパティを設定し、特定のアクションにより大きなメモリ割り当てを割り当てる場合は、次のように実行グループ拡張キーを使用して exec_properties エントリを作成します。

# BUILD
my_rule(
    name = 'my_target',
    exec_properties = {
        'mem': '12g',
        'link.mem': '16g'
    }
    …
)

exec_group = "link" を使用するすべてのアクションでは、exec プロパティディクショナリが {"mem": "16g"} として表示されます。ご覧のとおり、実行グループ単位の設定はターゲット単位の設定をオーバーライドします。

ネイティブルールの実行グループ

ネイティブルールで定義されたアクションには、次の実行グループを使用できます。

test: テストランナーのアクション。
cpp_link: C++ リンクアクション。

実行グループとプラットフォーム実行プロパティ

プラットフォームターゲットの任意の実行グループに対して exec_properties を定義できます（ターゲットに直接設定される exec_properties とは異なり、不明な実行グループのプロパティは拒否されます）。ターゲットは、デフォルトの実行グループとその他の関連する実行グループに影響する実行プラットフォームの exec_properties を継承します。

たとえば、C++ テストの実行にリソースが必要だが、コンパイルとリンクには必要ない場合、次のようにモデル化できます。

constraint_setting(name = "resource")
constraint_value(name = "has_resource", constraint_setting = ":resource")

platform(
    name = "platform_with_resource",
    constraint_values = [":has_resource"],
    exec_properties = {
        "test.resource": "...",
    },
)

cc_test(
    name = "my_test",
    srcs = ["my_test.cc"],
    exec_compatible_with = [":has_resource"],
)

ターゲットで直接定義された exec_properties は、実行プラットフォームから継承したものよりも優先されます。