このページでは、プロジェクトのビルド方法をカスタマイズするための Bazel の API である Starlark 構成のメリットと基本的な使用方法について説明します。ビルド設定の定義方法と例が記載されています。
これにより、次のことを実現できます。
- プロジェクトのカスタムフラグを定義し、
--defineの必要性をなくします。 - 遷移を記述して、親（
--compilation_mode=optや--cpu=armなど）とは異なる構成で依存関係を構成する - より優れたデフォルトをルールに組み込む（指定された SDK で
//my:android_appを自動的にビルドするなど）
など、すべて .bzl ファイルから作成できます（Bazel リリースは不要です）。例については、bazelbuild/examples リポジトリをご覧ください。
ユーザー定義のビルド設定
ビルド設定は、単一の構成情報です。構成は Key-Value マップと考えてください。--cpu=ppc と --copt="-DFoo" を設定すると、{cpu: ppc, copt: "-DFoo"} のような構成が生成されます。各エントリはビルド設定です。
cpu や copt などの従来のフラグはネイティブ設定です。キーは定義され、値はネイティブの Bazel Java コード内で設定されます。Bazel ユーザーは、コマンドラインやネイティブに管理されている他の API を介してのみ、これらのファイルの読み取りと書き込みを行うことができます。ネイティブ フラグと、それらを公開する API を変更するには、bazel リリースが必要です。ユーザー定義のビルド設定は .bzl ファイルで定義されます（そのため、変更を登録するために bazel リリースは必要ありません）。コマンドライン（flags として指定されている場合、後述を参照）で設定することもできますが、ユーザー定義の遷移で設定することもできます。
ビルド設定の定義
build_setting rule() パラメータ
ビルド設定は他のルールと同様にルールであり、Starlark rule() 関数の build_setting
属性を使用して区別されます。
# example/buildsettings/build_settings.bzl
string_flag = rule(
implementation = _impl,
build_setting = config.string(flag = True)
)
build_setting 属性は、ビルド設定のタイプを指定する関数を受け取ります。型は、bool や string などの基本的な Starlark 型のセットに制限されます。詳しくは、config モジュールのドキュメントをご覧ください。より複雑な入力は、ルールの実装関数で行うことができます。詳しくは以下をご覧ください。
config モジュールの関数は、オプションのブール値パラメータ flag を受け取ります。このパラメータはデフォルトで false に設定されています。flag が true に設定されている場合、ビルド設定はユーザーがコマンドライン上で設定できるほか、ルール作成者がデフォルト値と遷移を使用して内部で設定することもできます。すべての設定をユーザーが設定できるようにする必要はありません。たとえば、ルール作成者がテストルール内で有効にするデバッグモードがある場合、ユーザーが他のテスト以外のルール内でその機能を無差別に有効にできるようにすることはできません。
ctx.build_setting_value を使用する
他のすべてのルールと同様に、ビルド設定ルールには実装関数があります。ビルド設定の基本的な Starlark 型の値には、ctx.build_setting_value メソッドを介してアクセスできます。このメソッドは、ビルド設定ルールの ctx オブジェクトでのみ使用できます。これらの実装方法では、ビルド設定値を直接転送することも、型チェックや複雑な構造体の作成など、追加の処理を行うこともできます。enum 型のビルド設定を実装する方法は次のとおりです。
# example/buildsettings/build_settings.bzl
TemperatureProvider = provider(fields = ['type'])
temperatures = ["HOT", "LUKEWARM", "ICED"]
def _impl(ctx):
raw_temperature = ctx.build_setting_value
if raw_temperature not in temperatures:
fail(str(ctx.label) + " build setting allowed to take values {"
+ ", ".join(temperatures) + "} but was set to unallowed value "
+ raw_temperature)
return TemperatureProvider(type = raw_temperature)
temperature = rule(
implementation = _impl,
build_setting = config.string(flag = True)
)
複数セットの文字列フラグを定義する
文字列設定には、コマンドラインまたは bazelrc でフラグを複数回設定できる allow_multiple パラメータが追加されています。デフォルト値は引き続き文字列型の属性で設定されます。
# example/buildsettings/build_settings.bzl
allow_multiple_flag = rule(
implementation = _impl,
build_setting = config.string(flag = True, allow_multiple = True)
)
# example/buildsettings/BUILD
load("//example/buildsettings:build_settings.bzl", "allow_multiple_flag")
allow_multiple_flag(
name = "roasts",
build_setting_default = "medium"
)
フラグの各設定は、単一の値として扱われます。
$ bazel build //my/target --//example:roasts=blonde \
--//example:roasts=medium,dark
上記は {"//example:roasts": ["blonde", "medium,dark"]} に解析され、ctx.build_setting_value はリスト ["blonde", "medium,dark"] を返します。
ビルド設定のインスタンス化
build_setting パラメータで定義されたルールには、暗黙的に必須の build_setting_default 属性があります。この属性は、build_setting パラメータで宣言されたものと同じ型になります。
# example/buildsettings/build_settings.bzl
FlavorProvider = provider(fields = ['type'])
def _impl(ctx):
return FlavorProvider(type = ctx.build_setting_value)
flavor = rule(
implementation = _impl,
build_setting = config.string(flag = True)
)
# example/buildsettings/BUILD
load("//example/buildsettings:build_settings.bzl", "flavor")
flavor(
name = "favorite_flavor",
build_setting_default = "APPLE"
)
事前定義された設定
Skylib ライブラリには、カスタム Starlark を記述しなくてもインスタンス化できる一連の事前定義された設定が含まれています。
たとえば、限定された文字列値のセットを許可する設定を定義するには、次のようにします。
# example/BUILD
load("@bazel_skylib//rules:common_settings.bzl", "string_flag")
string_flag(
name = "myflag",
values = ["a", "b", "c"],
build_setting_default = "a",
)
完全なリストについては、一般的なビルド設定ルールをご覧ください。
ビルド設定を使用する
ビルド設定に応じて
ターゲットが構成情報を読み取る場合は、通常の属性依存関係を介してビルド設定に直接依存できます。
# example/rules.bzl
load("//example/buildsettings:build_settings.bzl", "FlavorProvider")
def _rule_impl(ctx):
if ctx.attr.flavor[FlavorProvider].type == "ORANGE":
...
drink_rule = rule(
implementation = _rule_impl,
attrs = {
"flavor": attr.label()
}
)
# example/BUILD
load("//example:rules.bzl", "drink_rule")
load("//example/buildsettings:build_settings.bzl", "flavor")
flavor(
name = "favorite_flavor",
build_setting_default = "APPLE"
)
drink_rule(
name = "my_drink",
flavor = ":favorite_flavor",
)
言語によっては、その言語のすべてのルールが依存する標準的なビルド設定セットを作成することをおすすめします。fragments のネイティブ コンセプトは、Starlark 構成の世界ではハードコードされたオブジェクトとして存在しなくなりましたが、このコンセプトを変換する 1 つの方法は、一般的な暗黙的属性のセットを利用することです。次に例を示します。
# kotlin/rules.bzl
_KOTLIN_CONFIG = {
"_compiler": attr.label(default = "//kotlin/config:compiler-flag"),
"_mode": attr.label(default = "//kotlin/config:mode-flag"),
...
}
...
kotlin_library = rule(
implementation = _rule_impl,
attrs = dicts.add({
"library-attr": attr.string()
}, _KOTLIN_CONFIG)
)
kotlin_binary = rule(
implementation = _binary_impl,
attrs = dicts.add({
"binary-attr": attr.label()
}, _KOTLIN_CONFIG)
コマンドラインでビルド設定を使用する
ほとんどのネイティブ フラグと同様に、コマンドラインを使用して、フラグとしてマークされているビルド設定を設定できます。ビルド設定の名前は、name=value 構文を使用した完全なターゲットパスです。
$ bazel build //my/target --//example:string_flag=some-value # allowed
$ bazel build //my/target --//example:string_flag some-value # not allowed
特別なブール値の構文がサポートされています。
$ bazel build //my/target --//example:boolean_flag
$ bazel build //my/target --no//example:boolean_flag
ビルド設定エイリアスの使用
ビルド設定のターゲット パスにエイリアスを設定すると、コマンドラインでの読み取りが容易になります。エイリアスはネイティブ フラグと同様に機能し、ダブルダッシュ オプションの構文も使用します。
.bazelrc に --flag_alias=ALIAS_NAME=TARGET_PATH を追加してエイリアスを設定します。たとえば、エイリアスを coffee に設定するには、次のようにします。
# .bazelrc
build --flag_alias=coffee=//experimental/user/starlark_configurations/basic_build_setting:coffee-temp
ベスト プラクティス: エイリアスを複数回設定すると、最新のエイリアスが優先されます。意図しない解析結果を回避するため、一意のエイリアス名を使用してください。
エイリアスを使用するには、ビルド設定のターゲット パスの代わりにエイリアスを入力します。上記の例では、ユーザーの .bazelrc に coffee が設定されています。
$ bazel build //my/target --coffee=ICED
これは、以下を置き換えるものです。
$ bazel build //my/target --//experimental/user/starlark_configurations/basic_build_setting:coffee-temp=ICED
ベスト プラクティス: エイリアスはコマンドラインで設定できますが、.bazelrc に残しておくとコマンドラインが煩雑になりません。
ラベル型のビルド設定
他のビルド設定とは異なり、ラベル型の設定は build_setting ルール パラメータを使用して定義できません。代わりに、bazel には label_flag と label_setting の 2 つの組み込みルールがあります。これらのルールは、ビルド設定が設定されている実際のターゲットのプロバイダを転送します。label_flag と label_setting は遷移によって読み取り/書き込みが可能です。label_flag は、他の build_setting ルールと同様にユーザーが設定できます。唯一の違いは、カスタム定義できないことです。
ラベル型の設定は、最終的に遅延バインディングのデフォルトの機能を置き換えます。遅延バインディングのデフォルト属性は、最終的な値が構成によって影響を受けるラベル型の属性です。Starlark では、これは configuration_field API に代わるものです。
# example/rules.bzl
MyProvider = provider(fields = ["my_field"])
def _dep_impl(ctx):
return MyProvider(my_field = "yeehaw")
dep_rule = rule(
implementation = _dep_impl
)
def _parent_impl(ctx):
if ctx.attr.my_field_provider[MyProvider].my_field == "cowabunga":
...
parent_rule = rule(
implementation = _parent_impl,
attrs = { "my_field_provider": attr.label() }
)
# example/BUILD
load("//example:rules.bzl", "dep_rule", "parent_rule")
dep_rule(name = "dep")
parent_rule(name = "parent", my_field_provider = ":my_field_provider")
label_flag(
name = "my_field_provider",
build_setting_default = ":dep"
)
ビルド設定と select()
ユーザーは select() を使用して、ビルド設定の属性を構成できます。ビルド設定ターゲットは、config_setting の flag_values 属性に渡すことができます。構成と一致する値は String として渡され、ビルド設定の型に解析されて照合されます。
config_setting(
name = "my_config",
flag_values = {
"//example:favorite_flavor": "MANGO"
}
)
ユーザー定義の遷移
構成遷移は、ビルドグラフ内の構成済みターゲット間の変換をマッピングします。
これらを設定するルールには、特別な属性を含める必要があります。
"_allowlist_function_transition": attr.label(
default = "@bazel_tools//tools/allowlists/function_transition_allowlist"
)
遷移を追加すると、ビルドグラフのサイズが簡単に増大します。これにより、このルールのターゲットを作成できるパッケージに許可リストが設定されます。上記のコードブロックのデフォルト値では、すべてが許可リストに登録されます。ただし、ルールを使用するユーザーを制限する場合は、独自のカスタム許可リストを参照するようにその属性を設定できます。移行がビルドのパフォーマンスに与える影響についてアドバイスやサポートが必要な場合は、bazel-discuss@googlegroups.com までお問い合わせください。
定義
遷移は、ルール間の構成変更を定義します。たとえば、「親とは異なる CPU 用に依存関係をコンパイルする」などのリクエストは、遷移によって処理されます。
正式には、遷移は入力構成から 1 つ以上の出力構成への関数です。ほとんどの遷移は 1:1 です（「入力構成を --cpu=ppc でオーバーライドする」など）。1:2 以上の遷移も存在しますが、特別な制限があります。
Starlark では、遷移はルールとよく似た方法で定義されます。定義する transition()
関数と実装関数が必要です。
# example/transitions/transitions.bzl
def _impl(settings, attr):
_ignore = (settings, attr)
return {"//example:favorite_flavor" : "MINT"}
hot_chocolate_transition = transition(
implementation = _impl,
inputs = [],
outputs = ["//example:favorite_flavor"]
)
transition() 関数は、実装関数、読み取り用のビルド設定のセット（inputs）、書き込み用のビルド設定のセット（outputs）を取ります。実装関数には、settings と attr の 2 つのパラメータがあります。settings は、inputs パラメータで transition() に宣言されたすべての設定のディクショナリ {String:Object} です。
attr は、遷移が適用されているルールの属性と値の辞書です。外向きエッジ遷移として接続する場合、これらの属性の値はすべて、select() 解決後に構成されます。インカミング エッジ遷移として接続する場合、attr には、セレクタを使用して値を解決する属性は含まれません。--foo の受信エッジ遷移が属性 bar を読み取り、--foo を選択して属性 bar を設定する場合、受信エッジ遷移が遷移で bar の間違った値を読み取る可能性があります。
実装関数は、適用する新しいビルド設定値の辞書（複数の出力構成がある遷移の場合は辞書のリスト）を返す必要があります。返される辞書キーセットには、遷移関数の outputs パラメータに渡されるビルド設定セットが正確に含まれている必要があります。これは、移行中にビルド設定が実際に変更されていない場合でも同様です。元の値は、返された辞書で明示的に渡す必要があります。
1:2 以上の遷移を定義する
アウトバウンド エッジ遷移では、1 つの入力構成を 2 つ以上の出力構成にマッピングできます。これは、マルチアーキテクチャ コードをバンドルするルールを定義する場合に役立ちます。
1:2 以上の遷移は、遷移実装関数で辞書のリストを返すことで定義されます。
# example/transitions/transitions.bzl
def _impl(settings, attr):
_ignore = (settings, attr)
return [
{"//example:favorite_flavor" : "LATTE"},
{"//example:favorite_flavor" : "MOCHA"},
]
coffee_transition = transition(
implementation = _impl,
inputs = [],
outputs = ["//example:favorite_flavor"]
)
また、ルール実装関数で個々の依存関係の読み取りに使用できるカスタムキーを設定することもできます。
# example/transitions/transitions.bzl
def _impl(settings, attr):
_ignore = (settings, attr)
return {
"Apple deps": {"//command_line_option:cpu": "ppc"},
"Linux deps": {"//command_line_option:cpu": "x86"},
}
multi_arch_transition = transition(
implementation = _impl,
inputs = [],
outputs = ["//command_line_option:cpu"]
)
遷移の適用
遷移は、入ってくるエッジと出ていくエッジの 2 か所に接続できます。つまり、ルールは独自の構成（インバウンド エッジ遷移）と依存関係の構成（アウトバウンド エッジ遷移）を遷移できます。
注: 現在、Starlark 遷移をネイティブ ルールに接続する方法はありません。回避策を検討する必要がある場合は、bazel-discuss@googlegroups.com にお問い合わせください。
エッジの受信遷移
受信エッジ遷移は、transition オブジェクト（transition() によって作成）を rule() の cfg パラメータに接続することで有効になります。
# example/rules.bzl
load("example/transitions:transitions.bzl", "hot_chocolate_transition")
drink_rule = rule(
implementation = _impl,
cfg = hot_chocolate_transition,
...
インカミング エッジ遷移は 1:1 遷移である必要があります。
外向きエッジ遷移
外向きエッジ遷移は、transition オブジェクト（transition() によって作成）を属性の cfg パラメータに接続することで有効になります。
# example/rules.bzl
load("example/transitions:transitions.bzl", "coffee_transition")
drink_rule = rule(
implementation = _impl,
attrs = { "dep": attr.label(cfg = coffee_transition)}
...
外向きエッジ遷移は 1:1 または 1:2 以上です。
これらのキーの読み取り方法については、遷移を使用して属性にアクセスするをご覧ください。
ネイティブ オプションの遷移
Starlark 遷移では、オプション名に特別な接頭辞を付けて、ネイティブ ビルド構成オプションの読み取りと書き込みを宣言することもできます。
# example/transitions/transitions.bzl
def _impl(settings, attr):
_ignore = (settings, attr)
return {"//command_line_option:cpu": "k8"}
cpu_transition = transition(
implementation = _impl,
inputs = [],
outputs = ["//command_line_option:cpu"]
サポートされていないネイティブ オプション
Bazel は、"//command_line_option:define" による --define への遷移をサポートしていません。代わりに、カスタムのビルド設定を使用してください。一般的に、--define の新しい用途は、ビルド設定に代わるものとして推奨されません。
Bazel は --config での遷移をサポートしていません。これは、--config が他のフラグに展開される「拡張」フラグであるためです。
重要なのは、--config には、--spawn_strategy など、ビルド構成に影響しないフラグを含めることができることです。Bazel は設計上、このようなフラグを個々のターゲットにバインドできません。つまり、遷移でそれらを適用する一貫した方法はありません。
回避策として、移行の構成の一部であるフラグを明示的に列挙できます。これにより、2 か所で --config の展開を維持する必要がありますが、これは既知の UI の欠陥です。
遷移で複数のビルド設定を許可する
複数の値を許可するビルド設定を設定する場合は、設定の値をリストで設定する必要があります。
# example/buildsettings/build_settings.bzl
string_flag = rule(
implementation = _impl,
build_setting = config.string(flag = True, allow_multiple = True)
)
# example/BUILD
load("//example/buildsettings:build_settings.bzl", "string_flag")
string_flag(name = "roasts", build_setting_default = "medium")
# example/transitions/rules.bzl
def _transition_impl(settings, attr):
# Using a value of just "dark" here will throw an error
return {"//example:roasts" : ["dark"]},
coffee_transition = transition(
implementation = _transition_impl,
inputs = [],
outputs = ["//example:roasts"]
)
オペレーションなしの遷移
遷移が {}、[]、または None を返す場合、これはすべての設定を元の値のままにすることを意味します。これは、各出力を明示的に自身に設定するよりも便利な場合があります。
# example/transitions/transitions.bzl
def _impl(settings, attr):
_ignore = (attr)
if settings["//example:already_chosen"] is True:
return {}
return {
"//example:favorite_flavor": "dark chocolate",
"//example:include_marshmallows": "yes",
"//example:desired_temperature": "38C",
}
hot_chocolate_transition = transition(
implementation = _impl,
inputs = ["//example:already_chosen"],
outputs = [
"//example:favorite_flavor",
"//example:include_marshmallows",
"//example:desired_temperature",
]
)
遷移で属性にアクセスする
出力エッジに遷移を接続する場合（遷移が 1:1 遷移か 1:2 以上の遷移かにかかわらず）、ctx.attr はリストにする必要があります（まだリストでない場合）。このリスト内の要素の順序は指定されていません。
# example/transitions/rules.bzl
def _transition_impl(settings, attr):
return {"//example:favorite_flavor" : "LATTE"},
coffee_transition = transition(
implementation = _transition_impl,
inputs = [],
outputs = ["//example:favorite_flavor"]
)
def _rule_impl(ctx):
# Note: List access even though "dep" is not declared as list
transitioned_dep = ctx.attr.dep[0]
# Note: Access doesn't change, other_deps was already a list
for other dep in ctx.attr.other_deps:
# ...
coffee_rule = rule(
implementation = _rule_impl,
attrs = {
"dep": attr.label(cfg = coffee_transition)
"other_deps": attr.label_list(cfg = coffee_transition)
})
遷移が 1:2+ で、カスタムキーを設定している場合は、ctx.split_attr を使用してキーごとに個別の依存関係を読み取ることができます。
# example/transitions/rules.bzl
def _impl(settings, attr):
_ignore = (settings, attr)
return {
"Apple deps": {"//command_line_option:cpu": "ppc"},
"Linux deps": {"//command_line_option:cpu": "x86"},
}
multi_arch_transition = transition(
implementation = _impl,
inputs = [],
outputs = ["//command_line_option:cpu"]
)
def _rule_impl(ctx):
apple_dep = ctx.split_attr.dep["Apple deps"]
linux_dep = ctx.split_attr.dep["Linux deps"]
# ctx.attr has a list of all deps for all keys. Order is not guaranteed.
all_deps = ctx.attr.dep
multi_arch_rule = rule(
implementation = _rule_impl,
attrs = {
"dep": attr.label(cfg = multi_arch_transition)
})
完全な例をご覧ください。
プラットフォームとツールチェーンとの統合
現在、--cpu や --crosstool_top などの多くのネイティブ フラグは、ツールチェーンの解決に関連しています。今後、このようなタイプのフラグでの明示的な遷移は、ターゲット プラットフォームでの遷移に置き換えられる可能性があります。
メモリとパフォーマンスに関する考慮事項
ビルドに遷移（つまり新しい構成）を追加すると、ビルドグラフが大きくなり、ビルドグラフの理解が難しくなり、ビルドが遅くなります。ビルドルールで遷移を使用する場合は、これらの費用を考慮することをおすすめします。以下は、移行によってビルドグラフが指数関数的に増加する例です。
動作が不安定なビルド: ケーススタディ
図 1. 最上位のターゲットとその依存関係を示すスケーラビリティ グラフ。
このグラフは、2 つのターゲット（//pkg:1_0 と //pkg:1_1）に依存するトップレベル ターゲット //pkg:app を示しています。これらのターゲットはどちらも、//pkg:2_0 と //pkg:2_1 の 2 つのターゲットに依存しています。これらのターゲットはどちらも、//pkg:3_0 と //pkg:3_1 の 2 つのターゲットに依存しています。これは、//pkg:n_0 と //pkg:n_1 まで続きます。どちらも単一のターゲット //pkg:dep に依存しています。
//pkg:app をビルドするには、 \(2n+2\) ターゲットが必要です。
//pkg:app//pkg:dep- \([1..n]\)の \(i\) の
//pkg:i_0と//pkg:i_1
フラグ --//foo:owner=<STRING> を実装し、//pkg:i_b が適用されているとします。
depConfig = myConfig + depConfig.owner="$(myConfig.owner)$(b)"
つまり、//pkg:i_b は、すべての依存関係の古い値 --owner に b を追加します。
これにより、次の構成済みターゲットが生成されます。
//pkg:app //foo:owner=""
//pkg:1_0 //foo:owner=""
//pkg:1_1 //foo:owner=""
//pkg:2_0 (via //pkg:1_0) //foo:owner="0"
//pkg:2_0 (via //pkg:1_1) //foo:owner="1"
//pkg:2_1 (via //pkg:1_0) //foo:owner="0"
//pkg:2_1 (via //pkg:1_1) //foo:owner="1"
//pkg:3_0 (via //pkg:1_0 → //pkg:2_0) //foo:owner="00"
//pkg:3_0 (via //pkg:1_0 → //pkg:2_1) //foo:owner="01"
//pkg:3_0 (via //pkg:1_1 → //pkg:2_0) //foo:owner="10"
//pkg:3_0 (via //pkg:1_1 → //pkg:2_1) //foo:owner="11"
...
//pkg:dep は、 \(2^n\) 構成されたターゲットを生成します。 \(\{0,1\}\)内のすべての \(b_i\) に対して config.owner=「\(b_0b_1...b_n\)」です。
これにより、ビルドグラフはターゲット グラフよりも指数関数的に大きくなり、メモリとパフォーマンスに影響します。
TODO: これらの問題の測定と軽減のための戦略を追加します。
関連情報
ビルド構成の変更の詳細については、以下をご覧ください。
- Starlark ビルド構成
- Bazel の構成可能性のロードマップ
- エンドツーエンドの例の完全なセット