実行グループ

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

背景

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

アクションのグループを定義できることで、アクションを指定するプロキシとしてアクションのニーモニックを使用する必要もなくなります。ニーモニックは一意であることが保証されておらず、1 つのアクションのみを参照できます。これは、C++ ビルドでのリンクなどのメモリと処理を多用するアクションに余分なリソースを割り当て、要求の少ないタスクに過剰に割り当てない場合に特に役立ちます。

実行グループを定義する

ルール定義時に、ルール作成者は一連の実行グループを宣言できます。ルール作成者は、各実行グループで、その実行グループの実行プラットフォームを選択するために必要なすべてのもの（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 関数を公開します。

ネイティブルールと同様に、test 実行グループはデフォルトで Starlark テストルールに存在します。

実行グループの継承

新しい実行グループは、独自の制約とツールチェーンを定義するだけでなく、copy_from_rule = True パラメータを渡すことで、ルールのデフォルトの実行グループから継承することを宣言できます。copy_from_rule を true に設定し、exec_compatible_with または toolchains も渡すことはエラーです。

デフォルトの実行グループから継承する実行グループは、デフォルトから制約、ツールチェーン、実行プロパティをコピーします。これには、ルール自体で指定されたものだけでなく、ターゲットレベルで設定された制約と実行プロパティも含まれます。つまり、次のようになります。

# foo.bzl
my_rule = rule(
    _impl,
    exec_groups = {
        “copied”: exec_group(
            copy_from_rule = True,
            # This will inherit exec_compatible_with and toolchains.
            # Setting them here directly would be an error, however.
        ),
    },
    toolchains = ["//foo_tools:toolchain_type"],
    exec_compatible_with = ["@platforms//os:linux"],
)

# BUILD

my_rule(
    name = "demo",
    exec_compatible_with = [":local_constraint"],
)

構成されたターゲット demo の copied 実行グループには、次のすべてが含まれます。 - //fool_tools:toolchain_type - @platforms//os:linux - :local_constraint

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

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

# 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 グループを使用して特定のアクションに異なる exec プロパティを付与したいが、実際にはルールとは異なるツールチェーンや制約を必要としない場合があります。このような場合は、copy_from_rule パラメータを使用して実行グループを作成できます。

# foo.bzl

# Creating an exec group with `copy_from_rule=True` is the same as explicitly
# setting the exec group's toolchains and constraints to the same values as the
# rule's respective parameters.
my_rule = rule(
    _impl,
    exec_compatible_with = ["@platforms//os:linux"],
    toolchains = ["//foo:toolchain_type"],
    exec_groups = {
        # The following two groups have the same toolchains and constraints:
        “foo”: exec_group(copy_from_rule = True),
        "bar": exec_group(
            exec_compatible_with = ["@platforms//os:linux"],
            toolchains = ["//foo:toolchain_type"],
        ),
    },
)

#

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

プラットフォームターゲットの任意の実行グループに対して 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 は、実行プラットフォームから継承されたものよりも優先されます。