このページでは、Starlark 構成の利点と基本的な使用方法について説明します。 プロジェクトのビルド方法をカスタマイズするための Bazel の API。また、Kubernetes の ビルド設定について説明し、サンプルを示します。
これにより、次のことが可能になります。
- プロジェクトのカスタムフラグを定義し、
--define
の必要性をなくします。 - 書き込み
Transitions で依存関係を設定します。
構成が異なる場合があります。
(
--compilation_mode=opt
、--cpu=arm
など) - より適切なデフォルトをルールに埋め込む(
//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)
)
複数セットの文字列フラグの定義
文字列の設定には、allow_multiple
パラメータが追加されており、
コマンドラインまたは bazelrcs でフラグを複数回設定することもできます。デフォルト値は引き続き文字列型の属性で設定されます。
# example/buildsettings/build_settings.bzl
allow_multiple_flag = rule(
implementation = _impl,
build_setting = config.string(flag = True, allow_multiple = True)
)
# example/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/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()
を使用して、ビルド設定の属性を構成できます。ビルド設定ターゲットは、次の flag_values
属性に渡すことができます:
config_setting
。構成に一致する値は、値として
次に、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 以上の遷移は、 します。
# 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"]
)
NoOps の遷移
遷移が {}
、[]
、または 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
など、現在多くのネイティブ フラグは以下に関連しています。
ツールチェーンの解決。将来的には、このような Google Cloud の
フラグは、アプリケーションの移行によって置き換えられる
ターゲット プラットフォーム。
メモリとパフォーマンスに関する考慮事項
ビルドに遷移(つまり新しい構成を追加)を追加する場合は、 コスト: ビルドグラフが大きく、ビルドグラフがわかりにくく、低速です。 説明します。これらの費用を検討する際には ビルドルールで遷移を使用します。以下は、移行プロセスが ビルドグラフが急激に増加することがあります
不正な動作のビルド: ケーススタディ
図 1. 最上位のターゲットとその依存関係を示すスケーラビリティ グラフ。
このグラフは、2 つのターゲット(//pkg:app
//pkg:1_0
と //pkg:1_1
。どちらのターゲットも、//pkg:2_0
と
//pkg:2_1
。これらのターゲットはどちらも、//pkg:3_0
と //pkg:3_1
の 2 つのターゲットに依存しています。これは、単一の要素に依存する //pkg:n_0
と //pkg:n_1
まで続きます。
ターゲット、//pkg:dep
。
//pkg:app
を構築するには \(2n+2\) ターゲット:
//pkg:app
//pkg:dep
//pkg:i_0
と//pkg:i_1
( \([1..n]\)の \(i\) )
フラグを実装しているとします。
--//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\) 構成されたターゲット config.owner=
を生成します。
「\(b_0b_1...b_n\)」。 \(b_i\) \(\{0,1\}\)
これにより、ビルドグラフがターゲット グラフより指数関数的に大きくなり、 メモリやパフォーマンスにも影響します
TODO: これらの問題の測定と軽減のための戦略を追加します。
関連情報
ビルド構成の変更について詳しくは、以下をご覧ください。
- Starlark ビルド構成
- Bazel の構成可能性のロードマップ
- エンドツーエンドのサンプルの完全なセット