ルールは、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 という名前）という 1 つのパラメータのみを取ります。プロバイダのリストが返されます。
ターゲット
依存関係は、分析時に 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")
...
出力属性用に作成された出力など、事前に宣言された出力の場合、代わりに File オブジェクトは対応する ctx.outputs のフィールドから取得できます。
操作
アクションは、一連の入力から一連の出力を生成する方法を表します（「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 を使用すると、アクションの引数を効率的に蓄積できます。実行時まで depset のフラット化を回避します。
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],
)
...
アクションは、入力ファイルのリストまたは depset を受け取り、出力ファイルの（空ではない）リストを生成します。入力ファイルと出力ファイルのセットは、分析フェーズで把握する必要があります。依存関係のプロバイダなど、属性の値に依存する場合があります。ただし、実行結果に依存することはできません。たとえば、アクションで unzip コマンドを実行する場合、インフレートするファイルを（unzip を実行する前に）指定する必要があります。内部で可変数のファイルを作成するアクションは、それらを単一のファイル（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 はデフォルトですべての事前宣言出力（通常は出力属性によって作成された出力）になります。
アクションを実行するルールでは、出力が直接使用されないことが想定されていても、デフォルトの出力を指定する必要があります。リクエストされた出力のグラフにないアクションはプルーニングされます。出力がターゲットのコンシューマによってのみ使用される場合、ターゲットが単独で構築されている場合、これらのアクションは実行されません。失敗したターゲットのみを再ビルドしても失敗が再現されないため、デバッグが難しくなります。
実行ファイル
Runfile は、（ビルド時ではなく）実行時にターゲットによって使用される一連のファイルです。実行フェーズで、Bazel は runfile を指すシンボリック リンクを含むディレクトリ ツリーを作成します。これにより、バイナリの環境がステージングされ、実行時にランファイルにアクセスできるようになります。
ランファイルは、ルールの作成時に手動で追加できます。runfiles オブジェクトは、ルール コンテキスト ctx.runfiles の runfiles メソッドで作成し、DefaultInfo の runfiles パラメータに渡すことができます。実行可能ルールの実行可能出力は、暗黙的に実行ファイルに追加されます。
一部のルールでは、通常は data という名前の属性を指定します。この属性の出力は、ターゲットのランファイルに追加されます。Runfile は、data からだけでなく、最終的な実行用のコードを提供する可能性のある属性（通常は srcs（data に関連付けられた 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() の戻り型は、2 つの値のタプル（init が使用されていない場合の通常の戻り値であるプロバイダ シンボルと「未加工のコンストラクタ」）に変更されます。
この場合、プロバイダ シンボルが呼び出されると、新しいインスタンスを直接返すのではなく、引数を 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 で終わる必要があります。（テストのターゲット名も、慣例として _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(
...
)
Runfile の場所
実行可能ターゲットが bazel run（または test）で実行されると、runfiles ディレクトリのルートが実行可能ファイルの隣に配置されます。パスは次のように関連しています。
# 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 ルートを渡すことができます。これが設定されていない場合、バイナリは、これが最初に呼び出されたバイナリであると推測し、隣接する runfiles ディレクトリを探します。
高度なトピック
出力ファイルのリクエスト
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 には実行プラットフォームのコンセプトがなく、代わりにすべてのビルドアクションがホストマシンで実行されると見なされていました。そのため、ホスト構成に依存関係を構築するために使用できる「ホスト」構成と「ホスト」遷移が 1 つあります。多くのルールでは、ツールに引き続き「host」遷移が使用されていますが、これは現在非推奨であり、可能な限り「exec」遷移を使用するように移行されています。
「host」構成と「exec」構成には多くの違いがあります。
- 「host」はターミナル、「exec」はターミナルではありません。依存関係が「host」構成にある場合、それ以上の遷移は許可されません。「exec」構成に移行した後も、構成の移行を続行できます。
- 「host」はモノリシック、「exec」はモノリシックではありません。1 つの「host」構成しかありませんが、実行プラットフォームごとに異なる「exec」構成を使用できます。
- 「host」は、Bazel と同じマシンまたは非常に類似したマシンでツールを実行することを前提としています。これはもはや真実ではありません。ビルドアクションはローカルマシンまたはリモート エグゼキュータで実行できます。リモート エグゼキュータがローカルマシンと同じ CPU と OS であるとは限りません。
exec 構成と host 構成はどちらも、同じオプションの変更を適用します（たとえば、--host_compilation_mode から --compilation_mode を設定する、--host_cpu から --cpu を設定するなど）。違いは、「host」構成は他のすべてのフラグのデフォルト値で開始されるのに対し、「exec」構成はターゲット構成に基づいてフラグの現在の値で開始されることです。
構成フラグメント
ルールは、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
...
)
ctx.fragments は、ターゲット構成の構成フラグメントのみを提供します。ホスト構成のフラグメントにアクセスする場合は、代わりに ctx.host_fragments を使用します。
Runfiles シンボリック リンク
通常、runfiles ツリー内のファイルの相対パスは、ソースツリーまたは生成された出力ツリー内のそのファイルの相対パスと同じです。なんらかの理由でこれらを区別する必要がある場合は、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 に配置されるため、理想的な動作ではありませんが、依存関係チェーン内のすべてのルールに明示的なカバレッジ構成を必要としません）。
検証アクション
場合によっては、ビルドについて検証する必要があり、その検証に必要な情報はアーティファクト（ソースファイルまたは生成されたファイル）でのみ使用できます。この情報はアーティファクトに含まれているため、ルールではファイルを読み取ることができないため、分析時にルールでこの検証を行うことはできません。代わりに、アクションは実行時にこの検証を行う必要があります。検証に失敗すると、アクションが失敗し、ビルドも失敗します。
実行される検証の例としては、静的分析、リンティング、依存関係と整合性のチェック、スタイルチェックなどがあります。
検証アクションは、アーティファクトのビルドに不要なアクションの一部を別のアクションに移動することで、ビルドのパフォーマンスを向上させることもできます。たとえば、コンパイルとリンティングを行う単一のアクションをコンパイル アクションとリンティング アクションに分割できる場合、リンティング アクションは検証アクションとして実行し、他のアクションと並行して実行できます。
これらの「検証アクション」では、入力に関するアサーションのみが必要なため、多くの場合、ビルド内の他の場所で使用されるものは生成されません。ただし、この方法には問題があります。検証アクションがビルドの他の場所で使用されるものを生成しない場合、ルールはどのようにしてアクションを実行させるのでしょうか。従来のアプローチでは、検証アクションで空のファイルを出力し、その出力をビルド内の他の重要なアクションの入力に人為的に追加していました。
これは、Bazel がコンパイル アクションの実行時に常に検証アクションを実行するため機能しますが、重大な欠点があります。
検証アクションがビルドのクリティカル パスにある。Bazel は、コンパイル アクションの実行に空の出力が必要であると判断するため、コンパイル アクションが入力を無視するにもかかわらず、まず検証アクションを実行します。これにより、並列処理が減り、ビルドが遅くなります。
コンパイル アクションの代わりにビルド内の他のアクションが実行される可能性がある場合は、検証アクションの空の出力もそれらのアクションに追加する必要があります（
java_libraryのソース jar 出力など）。これは、コンパイル アクションの代わりに実行される可能性のある新しいアクションが後で追加され、空の検証出力が誤って中断される場合にも問題となります。
この問題を解決するには、Validations 出力グループを使用します。
検証出力グループ
検証出力グループは、検証アクションの未使用の出力を保持するように設計された出力グループです。これにより、他のアクションの入力に人為的に追加する必要がなくなります。
このグループは、--output_groups フラグの値に関係なく、またターゲットがどのように依存するか（コマンドライン、依存関係として、ターゲットの暗黙的な出力など）に関係なく、出力が常にリクエストされる点が特殊です。通常のキャッシュと増分処理は引き続き適用されます。検証アクションへの入力が変更されておらず、検証アクションが以前に成功した場合、検証アクションは実行されません。
この出力グループを使用する場合でも、空のファイルでも、検証アクションでファイルが出力される必要があります。これにより、通常は出力を作成しない一部のツールをラップして、ファイルが作成されるようにする必要があります。
ターゲットの検証アクションは、次の 3 つの場合に実行されません。
- ターゲットがツールとして依存されている場合
- ターゲットが暗黙的な依存関係として依存されている場合（「_」で始まる属性など）
- ターゲットがホスト構成または exec 構成でビルドされている場合。
これらのターゲットには、検証エラーを検出する独自のビルドとテストがあることが前提とされています。
Validations 出力グループの使用
検証出力グループの名前は _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パラメータに明示的に渡します。
避けるべき Runfile の機能
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, ...])
dep がこのルールのインスタンスの結果として生成された Target オブジェクトの場合、プロバイダとそのコンテンツは 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を使用して新しいプロバイダをテストします。すべてのルールからレガシー プロバイダを完全に削除します。