ルールでは、Bazel が入力に対して実行する一連のアクションを定義します。これらのアクションは、ルールの実装関数によって返されるプロバイダで参照されます。たとえば、C++ バイナリのルールは次のようになります。
- 一連の
.cppソースファイル（入力）を取得します。 - ソースファイルに対して
g++を実行します（アクション）。 - 実行可能な出力と、実行時に利用できるようにするその他のファイルとともに
DefaultInfoプロバイダを返します。 - ターゲットとその依存関係から収集した C++ 固有の情報で
CcInfoプロバイダを返します。
Bazel から見ると、g++ と標準 C++ ライブラリもこのルールの入力です。ルールライターは、ユーザー指定のルールだけでなく、アクションの実行に必要なツールとライブラリについても考慮する必要があります。
ルールを作成または変更する前に、Bazel のビルドフェーズを理解しておいてください。ビルドの 3 つのフェーズ（読み込み、分析、実行）を理解することが重要です。また、マクロについても、ルールとマクロの違いを理解しておくと便利です。まず、ルールのチュートリアルをご覧ください。このページは参考資料としてご利用ください。
Bazel 自体にはいくつかのルールが組み込まれています。cc_library や java_binary などのネイティブ ルールは、特定の言語のコアサポートを提供します。独自のルールを定義することで、Bazel がネイティブでサポートしていない言語やツールのサポートを追加できます。
Bazel は、Starlark 言語を使用してルールを作成するための拡張モデルを提供します。ルールは .bzl ファイルに記述され、BUILD ファイルから直接読み込むことができます。
独自のルールを定義する際には、サポートする属性と、その出力の生成方法を決定する必要があります。
ルールの implementation 関数は、分析フェーズ中の正確な動作を定義します。この関数は外部コマンドを実行しません。必要に応じて実行を登録します。このアクションは、実行フェーズの後半で、必要に応じてルールの出力を構築するために使用します。
ルールの作成
.bzl ファイルで、rule 関数を使用して新しいルールを定義し、結果をグローバル変数に格納します。rule の呼び出しでは、属性と実装関数を指定します。
example_library = rule(
implementation = _example_library_impl,
attrs = {
"deps": attr.label_list(),
...
},
)
これにより、example_library という名前のルールの種類が定義されます。
rule の呼び出しでは、ルールで実行可能ファイルの出力（executable=True を含む）を作成するか、テスト実行可能ファイル（test=True を使用）を明示的に作成するかを指定する必要があります。後者の場合、ルールはテストルールであり、ルール名は _test で終わる必要があります。
ターゲットのインスタンス化
ルールは、BUILD ファイルで読み込みて呼び出すことができます。
load('//some/pkg:rules.bzl', 'example_library')
example_library(
name = "example_target",
deps = [":another_target"],
...
)
ビルドルールを呼び出すたびに値は返されませんが、ターゲットを定義する副作用があります。これは、ルールのインスタンス化と呼ばれます。新しいターゲットの名前とそのターゲット属性の値を指定します。
ルールは Starlark 関数から呼び出し、.bzl ファイルに読み込むこともできます。ルールを呼び出す Starlark 関数は、Starlark マクロと呼ばれます。
Starlark マクロは、最終的に BUILD ファイルから呼び出す必要があります。読み込みフェーズでターゲットをインスタンス化するために BUILD ファイルを評価するときにのみ呼び出すことができます。
属性
属性はルール引数です。属性は、ターゲットの実装に特定の値を指定することも、他のターゲットを参照して依存関係のグラフを作成することもできます。
srcs や deps などのルール固有の属性は、属性名からスキーマ（attr モジュールを使用して作成）に rule の attrs パラメータを渡すことで定義されます。name や visibility などの共通の属性は、すべてのルールに暗黙的に追加されます。その他の属性は、実行可能ファイルとテストルールに暗黙的に追加されます。ルールに暗黙的に追加された属性は、attrs に渡される辞書に含めることができません。
依存関係の属性
ソースコードを処理するルールでは通常、さまざまな依存関係を処理するために次の属性を定義します。
srcsは、ターゲットのアクションによって処理されるソースファイルを指定します。多くの場合、属性スキーマは、ルールが処理するソースファイルの種類に対して期待されるファイル拡張子を指定します。ヘッダー ファイルを含む言語のルールでは、通常、ターゲットとそのコンシューマによって処理されるヘッダーに個別のhdrs属性を指定します。depsには、ターゲットのコードの依存関係を指定します。属性スキーマでは、これらの依存関係がどのプロバイダを提供する必要があるかを指定する必要があります。（たとえば、cc_libraryはCcInfoを提供します）。dataは、ターゲットに依存する任意の実行可能ファイルに対して実行時に利用できるようにするファイルを指定します。これにより、任意のファイルを指定できます。
example_library = rule(
implementation = _example_library_impl,
attrs = {
"srcs": attr.label_list(allow_files = [".example"]),
"hdrs": attr.label_list(allow_files = [".header"]),
"deps": attr.label_list(providers = [ExampleInfo]),
"data": attr.label_list(allow_files = True),
...
},
)
これらは、依存関係属性の例です。入力ラベルを指定する属性（attr.label_list、attr.label、または attr.label_keyed_string_dict で定義される属性）は、ターゲットと特定のターゲット（ラベル）に対応するターゲットと、ラベル（または対応する Label オブジェクト）の間の依存関係を指定します。これらのラベルのリポジトリ（場合によってはパス）は、定義されたターゲットからの相対パスで解決されます。
example_library(
name = "my_target",
deps = [":other_target"],
)
example_library(
name = "other_target",
...
)
この例では、other_target は my_target の依存関係であるため、other_target が最初に分析されます。ターゲットの依存関係グラフにサイクルがある場合、エラーが発生します。
プライベート属性と暗黙的な依存関係
デフォルト値を含む依存関係属性は、暗黙の依存関係を作成します。これはターゲット グラフの一部であり、ユーザーが BUILD ファイルで指定していないため、暗黙的です。暗黙的な依存関係は、ルールとツール間の関係をハードコードする場合に役立ちます（コンパイラなどのビルド時の依存関係）。ほとんどの場合、ユーザーはルールが使用するツールを指定しません。ルールの実装関数内では、これは他の依存関係と同様に扱われます。
ユーザーにその値のオーバーライドを許可せずに暗黙的な依存関係を指定するには、属性の先頭をアンダースコア（_）にして非公開にできます。非公開属性にはデフォルト値を指定する必要があります。通常は、暗黙の依存関係にのみプライベート属性を使用するのが合理的です。
example_library = rule(
implementation = _example_library_impl,
attrs = {
...
"_compiler": attr.label(
default = Label("//tools:example_compiler"),
allow_single_file = True,
executable = True,
cfg = "exec",
),
},
)
この例では、example_library タイプのすべてのターゲットがコンパイラ //tools:example_compiler に暗黙的に依存しています。これにより、ユーザーが入力としてラベルを渡さなくても、example_library の実装関数でコンパイラを呼び出すアクションを生成できます。_compiler はプライベート属性であるため、ctx.attr._compiler はこのルールタイプのすべてのターゲットで常に //tools:example_compiler を参照します。または、属性にcompilerアンダースコアを付けずにデフォルト値のままにすることもできます。ユーザーは必要に応じて別のコンパイラに置き換えることができますが、コンパイラのラベルを認識する必要はありません。
暗黙的な依存関係は通常、ルールの実装と同じリポジトリにあるツールに使用されます。ツールが実行プラットフォームまたは別のリポジトリから取得されている場合、ルールはそのツールをツールチェーンから取得する必要があります。
出力属性
出力属性（attr.output や attr.output_list など）は、ターゲットが生成する出力ファイルを宣言します。依存関係属性には以下の 2 つの違いがあります。
- 別の場所で定義されたターゲットを参照する代わりに、出力ファイル ターゲットを定義します。
- 出力ファイル ターゲットは、その逆ではなく、インスタンス化されたルール ターゲットに依存します。
通常、出力属性は、ルールでターゲット名に基づくことができないユーザー定義の名前で出力を作成する必要がある場合にのみ使用されます。ルールに 1 つの出力属性がある場合、通常は out または outs という名前になります。
出力属性は、宣言された出力を作成する場合におすすめの方法です。出力は、コマンドラインに依存するか、リクエストすることができます。
実装関数
すべてのルールには implementation 関数が必要です。これらの関数は分析フェーズで厳密に実行され、読み込みフェーズで生成されたターゲットのグラフを実行フェーズ中に実行されるアクションのグラフに変換します。そのため、実装関数は実際にファイルを読み書きできません。
通常、ルールの実装関数はプライベートです（先頭にアンダースコアが付いています）。従来は、名前はルールのものと同じでしたが、末尾に _impl が付加されました。
実装関数はパラメータ のみを受け取ります。ルール コンテキストは通常、ctx という名前になります。プロバイダのリストが返されます。
ターゲット
依存関係は、分析時に Target オブジェクトとして表されます。これらのオブジェクトには、ターゲットの実装関数の実行時に生成されたプロバイダが含まれます。
ctx.attr には、各依存関係属性の名前に対応するフィールドがあり、その属性を介した各直接依存関係を表す Target オブジェクトが格納されます。label_list 属性の場合、これは Targets のリストです。label 属性の場合、これは単一の Target または None です。
プロバイダ オブジェクトのリストが、ターゲットの実装関数によって返されます。
return [ExampleInfo(headers = depset(...))]
これらは、プロバイダのタイプをキーとして、インデックス表記（[]）を使用してアクセスできます。これらは、Starlark で定義されたカスタム プロバイダ、または Starlark グローバル変数として利用可能なネイティブ ルールのプロバイダです。
たとえば、ルールが hdrs 属性を介してヘッダー ファイルを取得し、それをターゲットとそのコンシューマのコンパイル アクションに渡す場合、次のように収集できます。
def _example_library_impl(ctx):
...
transitive_headers = [hdr[ExampleInfo].headers for hdr in ctx.attr.hdrs]
プロバイダ オブジェクトのリストではなく、ターゲットの実装関数から struct が返される従来のスタイルの場合:
return struct(example_info = struct(headers = depset(...)))
プロバイダは、Target オブジェクトの対応するフィールドから取得できます。
transitive_headers = [hdr.example_info.headers for hdr in ctx.attr.hdrs]
このスタイルは使用しないことを強くおすすめします。ルールを移行しない必要があります。
ファイル
ファイルは File オブジェクトで表されます。Bazel は分析フェーズでファイル I/O を実行しないため、これらのオブジェクトを使用してファイル コンテンツを直接読み書きすることはできません。アクションを出力する関数（ctx.actions を参照）に渡され、アクション グラフの一部が作成されます。
File は、ソースファイルまたは生成されたファイルのいずれかです。生成される各ファイルは、正確に 1 つのアクションの出力である必要があります。ソースファイルをアクションの出力にすることはできません。
依存関係属性ごとに、ctx.files の対応するフィールドには、その属性を介してすべての依存関係のデフォルト出力のリストが含まれます。
def _example_library_impl(ctx):
...
headers = depset(ctx.files.hdrs, transitive=transitive_headers)
srcs = ctx.files.srcs
...
ctx.file には、仕様に allow_single_file=True が設定されている依存関係属性について、単一の File または None が含まれています。ctx.executable は ctx.file と同じように動作しますが、仕様に executable=True が設定されている依存関係属性のフィールドのみが含まれます。
出力の宣言
分析フェーズでは、ルールの実装関数で出力を作成できます。読み込みフェーズではすべてのラベルがわかっている必要があるため、これらの追加の出力にはラベルがありません。出力用の File オブジェクトは、ctx.actions.declare_file と ctx.actions.declare_directory を使用して作成できます。多くの場合、出力の名前はターゲットの名前 ctx.label.name に基づいています。
def _example_library_impl(ctx):
...
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
...
出力属性用に作成された出力など、事前に宣言された出力については、代わりに ctx.outputs の対応するフィールドから File オブジェクトを取得できます。
Actions
アクションは、「hello.c で gcc を実行して hello.o を取得」など、一連の入力から出力を生成する方法を記述します。アクションを作成しても、Bazel はすぐにコマンドを実行しません。あるアクションが別のアクションの出力に依存する可能性があるため、依存関係のグラフに登録されます。たとえば C では、コンパイラの後にリンカーを呼び出す必要があります。
アクションを作成する汎用関数は、ctx.actions で定義されています。
ctx.actions.run: 実行可能ファイルを実行します。ctx.actions.run_shell。シェルコマンドを実行します。ctx.actions.write: 文字列をファイルに書き込みます。ctx.actions.expand_template。テンプレートからファイルを生成します。
ctx.actions.args を使用すると、アクションの引数を効率的に蓄積できます。実行時間まで、デプトのフラット化を回避できます。
def _example_library_impl(ctx):
...
transitive_headers = [dep[ExampleInfo].headers for dep in ctx.attr.deps]
headers = depset(ctx.files.hdrs, transitive=transitive_headers)
srcs = ctx.files.srcs
inputs = depset(srcs, transitive=[headers])
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
args = ctx.actions.args()
args.add_joined("-h", headers, join_with=",")
args.add_joined("-s", srcs, join_with=",")
args.add("-o", output_file)
ctx.actions.run(
mnemonic = "ExampleCompile",
executable = ctx.executable._compiler,
arguments = [args],
inputs = inputs,
outputs = [output_file],
)
...
アクションは、入力ファイルのリストまたは依存関係を取得し、出力ファイルのリスト（空でない）を生成します。入力ファイルと出力ファイルのセットは、分析フェーズで把握している必要があります。依存関係のプロバイダなど、属性の値によって異なりますが、実行結果には依存しません。たとえば、アクションで解凍コマンドを実行する場合は、（解凍を実行する前に）インフレートするファイルを指定する必要があります。内部で一定数のファイルを作成するアクションは、それらのファイルを 1 つのファイル（zip や tar などのアーカイブ形式）にラップできます。
アクションには、すべての入力をリストする必要があります。使用されていない入力の一覧表示は許可されますが、非効率的です。
アクションはすべての出力を作成する必要があります。他のファイルは書き込めますが、出力にないものはコンシューマが利用できなくなります。宣言された出力はすべて、なんらかのアクションによって書き込まれる必要があります。
アクションは純粋な関数と同等です。これらは、提供された入力のみに依存し、コンピュータ情報、ユーザー名、クロック、ネットワーク、I/O デバイスへのアクセスを回避します（入力の読み取りと出力の書き込みを除く）。出力はキャッシュに保存され、再利用されるため、これは重要です。
依存関係は、Bazel で解決されます。Bazel は実行するアクションを決定します。依存関係グラフにサイクルがある場合はエラーです。アクションを作成しても、ビルドで出力が必要かどうかによって、実行が保証されるわけではありません。
プロバイダ
プロバイダは、ルールが依存する他のルールに公開される情報です。このデータには、出力ファイル、ライブラリ、ツールのコマンドラインに渡すパラメータなど、ターゲットのコンシューマが知っておくべきあらゆる情報を含めることができます。
ルールの実装関数は、インスタンス化されたターゲットの即時依存関係からのみプロバイダを読み取れるため、ルールは、ターゲットのコンシューマが把握する必要があるターゲットの依存関係から情報を転送する必要があります。これは通常、depset に蓄積されます。
ターゲットのプロバイダは、実装関数によって返される Provider オブジェクトのリストで指定します。
古い実装関数は、実装関数がプロバイダ オブジェクトのリストではなく struct を返す従来のスタイルで記述することもできます。このスタイルは使用しないことを強くおすすめします。ルールを移行しない必要があります。
デフォルトの出力
ターゲットのデフォルト出力は、ターゲットがコマンドラインでビルドをリクエストしたときにデフォルトでリクエストされる出力です。たとえば、java_library ターゲット //pkg:foo にはデフォルト出力として foo.jar があるため、コマンド bazel build //pkg:foo でビルドされます。
デフォルトの出力は、DefaultInfo の files パラメータで指定されます。
def _example_library_impl(ctx):
...
return [
DefaultInfo(files = depset([output_file]), ...),
...
]
DefaultInfo がルール実装で返されない場合、または files パラメータが指定されていない場合、DefaultInfo.files はデフォルトですべての宣言された出力（通常は出力属性によって作成された出力）になります。
アクションを実行するルールは、それらの出力を直接使用する予定がなくても、デフォルトの出力を提供する必要があります。リクエストされた出力のグラフに含まれていないアクションはプルーニングされます。出力がターゲットのコンシューマによってのみ使用される場合、ターゲットが単独で組み込まれている場合、これらのアクションは実行されません。失敗したターゲットを再構築しても失敗を再現しないため、デバッグは困難になります。
ランファイル
実行ファイルは、（ビルド時ではなく）実行時にターゲットで使用されるファイルのセットです。実行フェーズ中、Bazel はランファイルを参照するシンボリック リンクを含むディレクトリ ツリーを作成します。これにより、バイナリの環境がステージングされ、実行時にランファイルにアクセスできるようになります。
ルールファイルを作成するときに、ランファイルを手動で追加できます。runfiles オブジェクトは、ルール コンテキスト ctx.runfiles の runfiles メソッドで作成し、DefaultInfo の runfiles パラメータに渡すことができます。実行可能ルールの実行可能出力は、実行ファイルに暗黙的に追加されます。
一部のルールでは属性（通常は data）が指定されています。この属性の出力はターゲットのランファイルに追加されます。ランファイルは data からマージすることと、最終的に実行するためのコードを提供する可能性がある属性（通常は srcs に関連する filegroup ターゲットを含む）と deps からマージされる必要もあります。
def _example_library_impl(ctx):
...
runfiles = ctx.runfiles(files = ctx.files.data)
transitive_runfiles = []
for runfiles_attr in (
ctx.attr.srcs,
ctx.attr.hdrs,
ctx.attr.deps,
ctx.attr.data,
):
for target in runfiles_attr:
transitive_runfiles.append(target[DefaultInfo].default_runfiles)
runfiles = runfiles.merge_all(transitive_runfiles)
return [
DefaultInfo(..., runfiles = runfiles),
...
]
カスタム プロバイダ
プロバイダを定義するには、provider 関数を使用してルール固有の情報を指定します。
ExampleInfo = provider(
"Info needed to compile/link Example code.",
fields={
"headers": "depset of header Files from transitive dependencies.",
"files_to_link": "depset of Files from compilation.",
})
その後、ルール実装関数はプロバイダ インスタンスを構築して返すことができます。
def _example_library_impl(ctx):
...
return [
...
ExampleInfo(
headers = headers,
files_to_link = depset(
[output_file],
transitive = [
dep[ExampleInfo].files_to_link for dep in ctx.attr.deps
],
),
)
]
プロバイダのカスタム初期化
カスタム前処理と検証ロジックでプロバイダのインスタンス化を保護できます。これは、すべてのプロバイダ インスタンスが特定の不変性に従うようにするため、またはインスタンスを取得するためによりクリーンな API をユーザーに提供するために使用できます。
これを行うには、init コールバックを provider 関数に渡します。このコールバックを指定すると、provider() の戻り値の型は、init が使用されていない場合は通常の戻り値であるプロバイダ シンボルと、「未加工のコンストラクタ」の 2 つの値のタプルに変わります。
この場合、プロバイダ シンボルが呼び出されると、新しいインスタンスを直接返すのではなく、引数を init コールバックに転送します。コールバックの戻り値は、フィールド名（文字列）と値のマッピングの辞書でなければなりません。これは、新しいインスタンスのフィールドを初期化するために使用されます。コールバックには任意の署名が含まれる場合があります。引数が署名と一致しない場合、コールバックが直接呼び出された場合と同様にエラーが報告されます。
一方、未加工のコンストラクタは init コールバックをバイパスします。
次の例では、init を使用して引数の前処理と検証を行います。
# //pkg:exampleinfo.bzl
_core_headers = [...] # private constant representing standard library files
# It's possible to define an init accepting positional arguments, but
# keyword-only arguments are preferred.
def _exampleinfo_init(*, files_to_link, headers = None, allow_empty_files_to_link = False):
if not files_to_link and not allow_empty_files_to_link:
fail("files_to_link may not be empty")
all_headers = depset(_core_headers, transitive = headers)
return {'files_to_link': files_to_link, 'headers': all_headers}
ExampleInfo, _new_exampleinfo = provider(
...
init = _exampleinfo_init)
export ExampleInfo
ルールの実装では、次のようにプロバイダをインスタンス化できます。
ExampleInfo(
files_to_link=my_files_to_link, # may not be empty
headers = my_headers, # will automatically include the core headers
)
未加工のコンストラクタを使用すると、init ロジックを経由しない代替のパブリック ファクトリ関数を定義できます。たとえば、exampleinfo.bzl では、次のように定義できます。
def make_barebones_exampleinfo(headers):
"""Returns an ExampleInfo with no files_to_link and only the specified headers."""
return _new_exampleinfo(files_to_link = depset(), headers = all_headers)
通常、未加工のコンストラクタは、名前がアンダースコア（上記の _new_exampleinfo）で始まる変数にバインドされます。これにより、ユーザーコードでこれを読み込んで任意のプロバイダ インスタンスを生成できなくなります。
init のもう 1 つの用途は、単にユーザーがプロバイダ記号を呼び出すのを防ぐことと、代わりにファクトリ関数を使用するように強制することです。
def _exampleinfo_init_banned(*args, **kwargs):
fail("Do not call ExampleInfo(). Use make_exampleinfo() instead.")
ExampleInfo, _new_exampleinfo = provider(
...
init = _exampleinfo_init_banned)
def make_exampleinfo(...):
...
return _new_exampleinfo(...)
実行ルールとテストルール
実行可能ルールは、bazel run コマンドで呼び出せるターゲットを定義します。テストルールは特別な種類の実行可能ルールで、ターゲットは bazel test コマンドで呼び出すこともできます。実行可能ルールとテストルールは、rule の呼び出しで、それぞれの executable 引数または test 引数を True に設定して作成します。
example_binary = rule(
implementation = _example_binary_impl,
executable = True,
...
)
example_test = rule(
implementation = _example_binary_impl,
test = True,
...
)
テストルールの名前には _test で終わる必要があります。（多くの場合、テスト target の名前も通常は _test で終わりますが、必須ではありません）。テスト以外のルールにこのサフィックスを付けないでください。
どちらの種類のルールでも、run または test コマンドによって呼び出される実行可能な出力ファイル（宣言されている場合もあります）が生成される必要があります。この実行可能ファイルとして使用するルールの出力を Bazel に指示するには、返された DefaultInfo プロバイダの executable 引数として渡します。その executable は、ルールのデフォルト出力に追加されます。したがって、executable と files の両方に渡す必要はありません。また、暗黙的に runfiles に追加されます。
def _example_binary_impl(ctx):
executable = ctx.actions.declare_file(ctx.label.name)
...
return [
DefaultInfo(executable = executable, ...),
...
]
このファイルを生成するアクションでは、ファイルの実行ビットを設定する必要があります。ctx.actions.run または ctx.actions.run_shell アクションの場合は、アクションによって呼び出される基になるツールで行う必要があります。ctx.actions.write アクションの場合は、is_executable=True を渡します。
従来の動作と同様に、実行可能ルールには特別な ctx.outputs.executable 宣言済み出力があります。このファイルは、DefaultInfo を使用して指定しなかった場合、デフォルトの実行可能ファイルとして機能します。それ以外の場合は使用しないでください。この出力メカニズムは、分析時に実行ファイルの名前をカスタマイズできないため、非推奨です。
実行ルールとテストルールには、すべてのルールの追加属性に加えて、暗黙的に定義される追加属性があります。暗黙的に追加された属性のデフォルトは変更できませんが、デフォルトを変更する Starlark マクロでプライベート ルールをラップすることで回避できます。
def example_test(size="small", **kwargs):
_example_test(size=size, **kwargs)
_example_test = rule(
...
)
ランファイルのロケーション
実行可能ターゲットが bazel run（または test）で実行される場合、実行ファイル ディレクトリのルートは実行可能ファイルに隣接します。パスは以下のとおりです。
# Given launcher_path and runfile_file:
runfiles_root = launcher_path.path + ".runfiles"
workspace_name = ctx.workspace_name
runfile_path = runfile_file.short_path
execution_root_relative_path = "%s/%s/%s" % (
runfiles_root, workspace_name, runfile_path)
runfiles ディレクトリの下にある File へのパスは File.short_path に対応しています。
bazel が直接実行するバイナリは、runfiles ディレクトリのルートに隣接します。ただし、ランファイルから呼び出されるバイナリを同じ前提条件にすることはできません。これを軽減するために、各バイナリは、環境またはコマンドライン引数/フラグを使用して、runfile ルートをパラメータとして受け入れる方法を提供する必要があります。これにより、バイナリは呼び出すバイナリに正しい正規ランファイル ルートを渡すことができます。設定されていない場合、バイナリは最初に呼び出されたと推測し、隣接するランファイル ディレクトリを探します。
高度なトピック
出力ファイルのリクエスト
1 つのターゲットに複数の出力ファイルを含めることができます。bazel build コマンドを実行すると、コマンドで指定されたターゲットの出力の一部はリクエストとみなされます。Bazel は、リクエストされたファイルと、それらが直接的または間接的に依存しているファイルのみをビルドします。（アクション グラフに関しては、Bazel はリクエストされたファイルの推移的依存関係として到達可能なアクションのみを実行します）。
デフォルトの出力に加えて、宣言された出力をコマンドラインで明示的にリクエストできます。ルールでは、出力属性を介して事前に宣言された出力を指定できます。その場合、ユーザーはルールをインスタンス化するときに出力ラベルを明示的に選択します。出力属性の File オブジェクトを取得するには、対応する ctx.outputs 属性を使用します。ターゲットの名前に基づいて宣言された出力を暗黙的に定義することもできますが、この機能は非推奨です。
デフォルトの出力に加えて、出力グループがあります。これは、まとめてリクエストできる出力ファイルの集合です。これらは --output_groups を使用してリクエストできます。たとえば、ターゲットの //pkg:mytarget が debug_files 出力グループを含むルールタイプの場合、bazel build //pkg:mytarget
--output_groups=debug_files を実行することでこれらのファイルを作成できます。宣言されていない出力にはラベルがないため、デフォルトの出力または出力グループに表示される場合にのみリクエストできます。
出力グループは、OutputGroupInfo プロバイダで指定できます。多くの組み込みプロバイダとは異なり、OutputGroupInfo は任意の名前のパラメータを取り、その名前で出力グループを定義することができます。
def _example_library_impl(ctx):
...
debug_file = ctx.actions.declare_file(name + ".pdb")
...
return [
DefaultInfo(files = depset([output_file]), ...),
OutputGroupInfo(
debug_files = depset([debug_file]),
all_files = depset([output_file, debug_file]),
),
...
]
また、ほとんどのプロバイダとは異なり、OutputGroupInfo は、同じ出力グループを定義しない限り、アスペクトと、そのアスペクトが適用されるルール ターゲットの両方から返されることがあります。その場合、結果のプロバイダは統合されます。
OutputGroupInfo は通常、特定の種類のファイルをターゲットからユーザーのアクションに伝えるために使用するべきではありません。代わりにルール固有のプロバイダを定義します。
構成
別のアーキテクチャ用の C++ バイナリをビルドするとします。ビルドが複雑になる場合があり、複数のステップが必要になります。コンパイラやコード生成ツールなどの中間バイナリの一部は、実行プラットフォーム（ホストまたはリモート エグゼキュータ）で実行する必要があります。最終出力などの一部のバイナリは、ターゲット アーキテクチャ向けにビルドする必要があります。
このため、Bazel には「構成」と遷移の概念があります。最上位のターゲット（コマンドラインでリクエストされたターゲット）は「target」構成でビルドされ、実行プラットフォームで実行するツールは「exec」構成でビルドされます。ルールは、構成に基づいてさまざまなアクションを生成します。たとえば、コンパイラに渡される CPU アーキテクチャを変更できます。場合によっては、異なる構成で同じライブラリが必要になることがあります。その場合、分析が行われ、複数回ビルドされる可能性があります。
デフォルトでは、Bazel はターゲットと同じ構成でターゲットの依存関係を作成します。つまり、遷移しません。依存関係がターゲットのビルドに役立つツールである場合、対応する属性で exec 構成への移行を指定する必要があります。これにより、ツールとそのすべての依存関係が実行プラットフォーム用にビルドされます。
依存関係の属性ごとに cfg を使用して、依存関係を同じ構成でビルドするか、exec 構成に移行する必要があるかを決定できます。依存関係属性に executable=True フラグがある場合は、cfg を明示的に設定する必要があります。これは、誤った構成に対してツールを誤ってビルドすることを防ぐためです。
例を見る
一般に、実行時に必要となるソース、依存ライブラリ、実行可能ファイルは同じ構成を使用できます。
ビルドの一環として実行されるツール（コンパイラやコード生成ツールなど）は、exec 構成用にビルドする必要があります。この場合は、属性に cfg="exec" を指定します。
それ以外の場合、実行時に使用される実行可能ファイル（テストの一部など）は、ターゲット構成用にビルドする必要があります。この場合は、属性に cfg="target" を指定します。
cfg="target" は実際には何もしません。これは単に、ルールの設計者が意図を明示できるようにするための単なるコンビニエンス値です。executable=False（cfg は省略可）の場合は、読みやすくなる場合にのみ設定します。
また、cfg=my_transition を使用してユーザー定義の遷移を使用することもできます。これにより、ルールの作成者は構成の変更時に高い柔軟性を得ることができます。また、ビルドグラフが大きくなり、わかりにくいというデメリットがあります。
注: Bazel には実行プラットフォームという概念がありませんでした。すべてのビルド アクションは、ホストマシンで実行されると考えられていました。6.0 より前の Bazel バージョンでは、この状況を表す個別の「ホスト」構成が作成されました。コードや以前のドキュメントで「ホスト」という表記がある場合、それを指します。この余分な概念上のオーバーヘッドを回避するために、Bazel 6.0 以降を使用することをおすすめします。
構成フラグメント
ルールは、cpp、java、jvm などの構成フラグメントにアクセスできます。ただし、アクセスエラーを避けるために、必要なすべてのフラグメントを宣言する必要があります。
def _impl(ctx):
# Using ctx.fragments.cpp leads to an error since it was not declared.
x = ctx.fragments.java
...
my_rule = rule(
implementation = _impl,
fragments = ["java"], # Required fragments of the target configuration
host_fragments = ["java"], # Required fragments of the host configuration
...
)
ランファイル シンボリック リンク
通常、ランファイル ツリー内のファイルの相対パスは、ソースツリーまたは生成された出力ツリー内のファイルの相対パスと同じです。なんらかの理由でこれらを区別する必要がある場合は、root_symlinks 引数または symlinks 引数を指定できます。root_symlinks は、ファイルへのパスをマッピングする辞書です。ここで、パスは runfiles ディレクトリのルートからの相対パスです。symlinks ディクショナリは同じですが、パスの先頭にワークスペースの名前が暗黙的に付加されます。
...
runfiles = ctx.runfiles(
root_symlinks = {"some/path/here.foo": ctx.file.some_data_file2}
symlinks = {"some/path/here.bar": ctx.file.some_data_file3}
)
# Creates something like:
# sometarget.runfiles/
# some/
# path/
# here.foo -> some_data_file2
# <workspace_name>/
# some/
# path/
# here.bar -> some_data_file3
symlinks または root_symlinks を使用する場合は、2 つの異なるファイルを runfiles ツリーの同じパスにマッピングしないように注意してください。これにより、競合を説明するエラーでビルドが失敗します。これを修正するには、ctx.runfiles 引数を変更して競合を除外する必要があります。このチェックは、ルールを使用しているすべてのターゲットと、それらのターゲットに依存するすべての種類のターゲットに対して行われます。これは、ツールが他のツールによって推移的に使用される可能性が高い場合に特にリスクとなります。シンボリック リンク名は、ツールの実行ファイルとそのすべての依存関係において一意である必要があります。
コード カバレッジ
coverage コマンドを実行する際、ビルドが特定のターゲットに対するカバレッジのインストルメンテーションを追加する必要がある場合があります。ビルドは、インストルメント化されたソースファイルのリストも収集します。考慮されるターゲットのサブセットは、フラグ --instrumentation_filter によって制御されます。--instrument_test_targets が指定されていない限り、テスト ターゲットは除外されます。
ルール実装がビルド時にカバレッジのインストルメンテーションを追加する場合、ターゲット関数をインストルメント化する必要がある場合、カバレッジ関数でそれを考慮する必要があります。ctx.coverage_instrumented は、カバレッジ モードで true を返します。
# Are this rule's sources instrumented?
if ctx.coverage_instrumented():
# Do something to turn on coverage for this compile action
ターゲット ソースがインストルメンテーションであるかどうかにかかわらず、常にカバレッジ モードにする必要があるロジックは、ctx.configuration.coverage_enabled で調整できます。
ルールにコンパイル前の依存関係のソース（ヘッダー ファイルなど）が直接含まれている場合、依存関係のソースをインストルメント化する必要がある場合、コンパイル時のインストルメンテーションもオンにする必要があります。
# Are this rule's sources or any of the sources for its direct dependencies
# in deps instrumented?
if (ctx.configuration.coverage_enabled and
(ctx.coverage_instrumented() or
any([ctx.coverage_instrumented(dep) for dep in ctx.attr.deps]))):
# Do something to turn on coverage for this compile action
ルールでは、coverage_common.instrumented_files_info を使用して構築された、InstrumentedFilesInfo プロバイダでカバーに関連する属性の情報も提供する必要があります。instrumented_files_info の dependency_attributes パラメータには、deps などのコード依存関係や、data などのデータ依存関係など、すべてのランタイム依存関係属性を一覧表示する必要があります。カバレッジ インストルメンテーションを追加できる場合は、source_attributes パラメータにルールのソースファイル属性を一覧表示します。
def _example_library_impl(ctx):
...
return [
...
coverage_common.instrumented_files_info(
ctx,
dependency_attributes = ["deps", "data"],
# Omitted if coverage is not supported for this rule:
source_attributes = ["srcs", "hdrs"],
)
...
]
InstrumentedFilesInfo が返されない場合は、dependency_attributes の属性属性で cfg を "host" または "exec" に設定していない、各ツール以外の依存関係属性を使用して、デフォルトの属性が作成されます。（srcs のような属性は source_attributes ではなく dependency_attributes に配置されるため、この動作は理想的ではありませんが、依存関係チェーン内のすべてのルールで明示的なカバレッジ構成を指定する必要はありません）。
検証アクション
場合によっては、ビルドに関する妥当性を検証する必要があります。その検証に必要な情報は、アーティファクト（ソースファイルまたは生成されたファイル）でのみ使用できます。この情報はアーティファクト内にあるため、ルールがファイルを読み取ることができないため、ルールの分析時に検証できません。代わりに、アクションは実行時にこの検証を行う必要があります。検証で不合格になると、アクションは失敗し、その結果ビルドも失敗します。
実行される検証の例としては、静的分析、lint チェック、依存関係と整合性のチェック、スタイル チェックがあります。
検証アクションは、アーティファクトの構築に不要なアクションの一部を別のアクションに移動することで、ビルドのパフォーマンスを向上させることもできます。たとえば、コンパイルと lint チェックを行う単一のアクションをコンパイル アクションと lint チェックアクションに分けられる場合は、lint チェック アクションを検証アクションとして実行し、他のアクションと並行して実行できます。
これらの「検証アクション」は、入力に関して表明するだけなので、ビルドの他の場所で使用されないものは生成されません。しかし、これには問題があります。検証アクションでビルドの他の場所で使用されるものが生成されない場合、ルールはどのようにアクションを実行しますか。従来は、検証アクションで空のファイルを出力させ、その出力をビルド内の他の重要なアクションの入力に対して人為的な方法で追加していました。
Bazel はコンパイル アクションの実行時に必ず検証アクションを実行しますが、これには大きなデメリットがあります。
検証アクションはビルドのクリティカル パスにあります。Bazel はコンパイル アクションの実行に空の出力が必要であると判断するため、コンパイル アクションで入力が無視されても、最初に検証アクションを実行します。これにより並列処理が減り、ビルドが遅くなります。
コンパイル アクションの代わりにビルド内の他のアクションが実行される可能性がある場合は、検証アクションの空の出力もそれらのアクション（
java_libraryのソース jar 出力など）に追加する必要があります。また、コンパイル アクションの代わりに実行される可能性のある新しいアクションが後で追加され、空の検証出力が誤って閉じられた場合にも問題が発生します。
これらの問題を解決するには、検証出力グループを使用します。
検証の出力グループ
検証出力グループは、それ以外の、検証アクションで使用されない出力を保持するように設計された出力グループです。これにより、他のアクションの入力に人為的に追加する必要がなくなります。
このグループは、--output_groups フラグの値に関係なく、またターゲットの依存方法（コマンドライン、依存関係、ターゲットの暗黙的出力など）に関係なく、常に出力がリクエストされるという点で特殊です。通常のキャッシュ保存とインクリメンタリティも適用されます。検証アクションへの入力が変更されず、以前に検証アクションが成功した場合、検証アクションは実行されません。
この出力グループを使用する場合でも、検証アクションでは一部のファイル（空のファイルを含む）を出力する必要があります。場合によっては、通常は出力を作成しない一部のツールをラップして、ファイルが作成されるようにする必要があります。
ターゲットの検証アクションは、次の 3 つのケースでは実行されません。
- ターゲットがツールに依存している場合
- ターゲットが暗黙的な依存関係（たとえば、「_」で始まる属性）に依存している場合。
- ターゲットがホスト構成または実行構成でビルドされた場合。
これらのターゲットには、検証の失敗を発見する独自のビルドとテストがあることを前提としています。
検証出力グループの使用
検証出力グループの名前は _validation であり、他の出力グループと同様に使用されます。
def _rule_with_validation_impl(ctx):
ctx.actions.write(ctx.outputs.main, "main output\n")
ctx.actions.write(ctx.outputs.implicit, "implicit output\n")
validation_output = ctx.actions.declare_file(ctx.attr.name + ".validation")
ctx.actions.run(
outputs = [validation_output],
executable = ctx.executable._validation_tool,
arguments = [validation_output.path])
return [
DefaultInfo(files = depset([ctx.outputs.main])),
OutputGroupInfo(_validation = depset([validation_output])),
]
rule_with_validation = rule(
implementation = _rule_with_validation_impl,
outputs = {
"main": "%{name}.main",
"implicit": "%{name}.implicit",
},
attrs = {
"_validation_tool": attr.label(
default = Label("//validation_actions:validation_tool"),
executable = True,
cfg = "exec"),
}
)
検証出力ファイルは DefaultInfo に追加されず、他のアクションへの入力も追加されません。このルール種類のターゲットの検証アクションは、ターゲットがラベルに依存している場合、またはターゲットの暗黙的な出力が直接的または間接的に依存している場合でも実行されます。
通常、検証アクションの出力は検証出力グループにのみ入り、他のアクションの入力には追加されないことが重要です。これにより、並列処理でのゲインが失われる可能性があります。ただし、Bazel には現在、これを実施するための特別なチェックはありません。そのため、Starlark ルールのテスト内のアクションの入力に、検証アクションの出力が追加されないことをテストする必要があります。例:
load("@bazel_skylib//lib:unittest.bzl", "analysistest")
def _validation_outputs_test_impl(ctx):
env = analysistest.begin(ctx)
actions = analysistest.target_actions(env)
target = analysistest.target_under_test(env)
validation_outputs = target.output_groups._validation.to_list()
for action in actions:
for validation_output in validation_outputs:
if validation_output in action.inputs.to_list():
analysistest.fail(env,
"%s is a validation action output, but is an input to action %s" % (
validation_output, action))
return analysistest.end(env)
validation_outputs_test = analysistest.make(_validation_outputs_test_impl)
検証アクションのフラグ
検証アクションの実行は、--run_validations コマンドライン フラグで制御されます。デフォルトでは true です。
サポートが終了した機能
非推奨の宣言済み出力
宣言された出力を使用する方法として、次の 2 つが非推奨になりました。
ruleのoutputsパラメータは、出力属性名と文字列テンプレートとの間のマッピングを指定して、事前に宣言された出力ラベルを生成します。事前に宣言されていない出力を使用し、DefaultInfo.filesに出力を明示的に追加することをおすすめします。事前に宣言された出力のラベルではなく、出力を使用するルールの入力として、ルール ターゲットのラベルを使用します。実行可能ルールの場合、
ctx.outputs.executableは、ルール ターゲットと同じ名前で事前に宣言された実行可能出力を参照します。たとえば、ctx.actions.declare_file(ctx.label.name)を使用して出力を明示的に宣言し、実行ファイルを生成するコマンドの実行を許可するように設定してください。実行可能出力をDefaultInfoのexecutableパラメータに明示的に渡します。
回避するランファイル機能
ctx.runfiles タイプと runfiles タイプには複雑な特徴セットがあり、その多くは従来の理由で保持されています。次の推奨事項は、複雑さの軽減に役立ちます。
ctx.runfilesのcollect_dataモードとcollect_defaultモードは使用しないでください。これらのモードでは、特定のハードコードされた依存関係のエッジ全体で、混乱を招く方法でランファイルが暗黙的に収集されます。代わりに、ctx.runfilesのfilesまたはtransitive_filesパラメータを使用するか、runfiles = runfiles.merge(dep[DefaultInfo].default_runfiles)の依存関係から実行ファイルをマージして、ファイルを追加します。DefaultInfoコンストラクタのdata_runfilesとdefault_runfilesを使用しないでください。代わりにDefaultInfo(runfiles = ...)を指定してください。以前の理由から「デフォルト」と「データ」のランファイルは区別されています。たとえば、一部のルールではデフォルトの出力をdata_runfilesに指定し、default_runfilesには出力しません。ルールでdata_runfilesを使用する代わりに、デフォルト出力を含めるとともに、ランファイルを提供する属性（多くの場合data）からdefault_runfilesにマージする必要があります。DefaultInfoからrunfilesを取得する場合（通常、現在のルールとその依存関係の間で実行ファイルをマージするためだけ）、DefaultInfo.data_runfilesではなく、DefaultInfo.default_runfilesを使用します。
従来のプロバイダからの移行
これまで、Bazel プロバイダは Target オブジェクトの単純なフィールドでした。これらはドット演算子を使用してアクセスされ、ルールの実装関数によって返された構造体にフィールドを入れることで作成されました。
このスタイルはサポートが終了しているため、新しいコードには使用しないでください。移行に役立つ可能性のある情報については、以下をご確認ください。新しいプロバイダ メカニズムは、名前の競合を回避します。また、データを非表示にするには、プロバイダ インスタンスにアクセスするコードに、プロバイダ シンボルを使用して取得するよう求めます。
現時点では、従来のプロバイダがまだサポートされています。ルールでは、従来のプロバイダと最新のプロバイダの両方を返すことができます。
def _old_rule_impl(ctx):
...
legacy_data = struct(x="foo", ...)
modern_data = MyInfo(y="bar", ...)
# When any legacy providers are returned, the top-level returned value is a
# struct.
return struct(
# One key = value entry for each legacy provider.
legacy_info = legacy_data,
...
# Additional modern providers:
providers = [modern_data, ...])
このルールのインスタンスで生成される Target オブジェクトが dep の場合、プロバイダとその内容は dep.legacy_info.x と dep[MyInfo].y として取得できます。
返される構造体は、providers だけでなく、特別な意味を持つ他のフィールドをいくつか受け入れることができます（したがって、対応するレガシー プロバイダは作成しません）。
フィールド
files、runfiles、data_runfiles、default_runfiles、executableは、DefaultInfoの同じ名前のフィールドに対応しています。DefaultInfoフィールドを返すと同時に、これらのフィールドを指定することはできません。output_groupsフィールドは構造体値を取り、OutputGroupInfoに対応します。
provides のルールの宣言と、providers の依存関係属性の宣言では、従来のプロバイダが文字列として渡され、最新のプロバイダが *Info 記号で渡されます。移行時には、文字列からシンボルに変更してください。すべてのルールをアトミックに更新するのが難しい複雑なルールセットや大規模なルールセットの場合、次のシーケンスに従うと時間を短縮できます。
上記の構文を使用して、レガシー プロバイダを生成するルールを変更して、レガシー プロバイダと最新のプロバイダの両方を生成します。レガシー プロバイダを返すことを宣言するルールでは、その宣言を更新してレガシー プロバイダと最新のプロバイダの両方を含めます。
従来のプロバイダを使用するルールを、最新のプロバイダを使用するように変更します。従来のプロバイダを必要とする属性宣言も、最新のプロバイダを必要とするように更新します。必要に応じて、このプロバイダをステップ 1 でインターリーブできます。その場合、コンシューマに
hasattr(target, 'foo')を使用してレガシー プロバイダの存在をテストするか、FooInfo in targetを使用して新しいプロバイダが存在するかどうかをテストします。すべてのルールから従来のプロバイダを完全に削除します。