クエリガイド

問題を報告 ソースを表示 Nightly · 7.4 . 7.3 7.2 7.1 7.0 6.5

このページでは、Bazel のクエリ言語を使用してトレースを開始する方法について説明します。 おすすめします。

言語の詳細と --output フラグの詳細については、以下をご覧ください。 リファレンス マニュアル、Bazel クエリ リファレンスBazel cquery リファレンスをご覧ください。ヘルプは、コマンドラインで bazel help query または bazel help cquery を入力して取得できます。

ターゲットの欠落などのエラーを無視してクエリを実行するには、 --keep_going フラグ。

ルールの依存関係の検索

//foo の依存関係を表示するには、次のコマンドを使用します。 Bazel クエリの deps 関数:

$ bazel query "deps(//foo)"
//foo:foo
//foo:foo-dep
...

これは、//foo のビルドに必要なすべてのターゲットのセットです。

2 つのパッケージ間の依存関係チェーンをトレースする

ライブラリ //third_party/zlib:zlibonly は、次の BUILD ファイルに存在しません。 //foo ですが、これは間接的な依存関係です。どうすれば どうなるでしょうか。便利な関数は allpathssomepath の 2 つです。ビルドしたアーティファクトに含まれるもののみを対象とし、すべてのジョブを対象としない場合は、--notool_deps を使用してツールの依存関係を除外することもできます。

すべての依存関係のグラフを可視化するには、bazel クエリの出力を dot コマンドライン ツールにパイプします。

$ bazel query "allpaths(//foo, third_party/...)" --notool_deps --output graph | dot -Tsvg > /tmp/deps.svg

依存関係グラフが大きく複雑な場合は、次のように 1 つのパスから始めると便利です。

$ bazel query "somepath(//foo:foo, third_party/zlib:zlibonly)"
//foo:foo
//translations/tools:translator
//translations/base:base
//third_party/py/MySQL:MySQL
//third_party/py/MySQL:_MySQL.so
//third_party/mysql:mysql
//third_party/zlib:zlibonly

allpaths--output graph を指定しない場合、 フラット化された依存関係グラフが表示されます。

$ bazel query "allpaths(//foo, third_party/...)"
  ...many errors detected in BUILD files...
//foo:foo
//translations/tools:translator
//translations/tools:aggregator
//translations/base:base
//tools/pkg:pex
//tools/pkg:pex_phase_one
//tools/pkg:pex_lib
//third_party/python:python_lib
//translations/tools:messages
//third_party/py/xml:xml
//third_party/py/xml:utils/boolean.so
//third_party/py/xml:parsers/sgmlop.so
//third_party/py/xml:parsers/pyexpat.so
//third_party/py/MySQL:MySQL
//third_party/py/MySQL:_MySQL.so
//third_party/mysql:mysql
//third_party/openssl:openssl
//third_party/zlib:zlibonly
//third_party/zlib:zlibonly_v1_2_3
//third_party/python:headers
//third_party/openssl:crypto

補足: 暗黙的な依存関係

//foo の BUILD ファイルは //translations/tools:aggregator を参照しません。直接依存関係はどこにあるのでしょうか。

一部のルールには、追加のライブラリまたはツールに対する暗黙的な依存関係が含まれます。 たとえば、genproto ルールを作成するには、まずプロトコルを構築する必要があります。 コンパイラ。そのため、すべての genproto ルールは プロトコル コンパイラです。これらの依存関係はビルドファイルには記載されていませんが、ビルドツールによって追加されます。すべての暗黙的な依存関係は、 現時点では文書化されていません。--noimplicit_deps を使用すると、これらの依存関係をクエリ結果から除外できます。cquery の場合、これには解決済みのツールチェーンが含まれます。

依存関係を逆にする

特定のターゲットに依存するターゲット セットを知りたい場合があります。たとえば、コードを変更する場合は、破壊する他のコードを把握しておく必要があります。rdeps(u, x) を使用すると、その逆の u の推移的クロージャ内の x 内のターゲットの依存関係。

Bazel の Sky Query は、指定したユニバースでリバース依存関係をクエリできる allrdeps 関数をサポートしています。

その他の用途

bazel query を使用すると、多くの依存関係を分析できます。

存在する ...

foo の下に存在するパッケージ

bazel query 'foo/...' --output package

foo パッケージではどのようなルールが定義されていますか?

bazel query 'kind(rule, foo:*)' --output label_kind

foo パッケージのルールによって生成されるファイル

bazel query 'kind("generated file", //foo:*)'

スターラーク マクロ foo によって生成されるターゲット

bazel query 'attr(generator_function, foo, //path/to/search/...)'

//foo のビルドに必要な BUILD ファイルのセットは何ですか?

bazel query 'buildfiles(deps(//foo))' | cut -f1 -d:

test_suite が拡張される個々のテストは何ですか?

bazel query 'tests(//foo:smoke_tests)'

次のうち、C++ テストはどれですか。

bazel query 'kind(cc_.*, tests(//foo:smoke_tests))'

次のうち、小さいのはどれですか?中程度ですか?大きい?

bazel query 'attr(size, small, tests(//foo:smoke_tests))'

bazel query 'attr(size, medium, tests(//foo:smoke_tests))'

bazel query 'attr(size, large, tests(//foo:smoke_tests))'

foo の下でパターンに一致するテストは何ですか?

bazel query 'filter("pa?t", kind(".*_test rule", //foo/...))'

パターンは正規表現で、ルールの完全な名前に適用されます。これは、

bazel query 'kind(".*_test rule", //foo/...)' | grep -E 'pa?t'

ファイル path/to/file/bar.java が含まれているパッケージ

 bazel query path/to/file/bar.java --output=package

path/to/file/bar.java? のビルドラベル

bazel query path/to/file/bar.java

ファイル path/to/file/bar.java がソースとして含まれているルール ターゲット

fullname=$(bazel query path/to/file/bar.java)
bazel query "attr('srcs', $fullname, ${fullname//:*/}:*)"

存在するパッケージの依存関係

foo はどのパッケージに依存していますか?(foo をビルドするには何をチェックする必要がありますか)

bazel query 'buildfiles(deps(//foo:foo))' --output package

foo ツリーが依存しているパッケージ(foo/contrib を除く)は何ですか?

bazel query 'deps(foo/... except foo/contrib/...)' --output package

どのようなルールの依存関係が存在するか

bar はどの genproto ルールに依存していますか?

bazel query 'kind(genproto, deps(bar/...))'

Java バイナリルールによって推移的に依存する JNI(C++)ライブラリの定義をサーブレット ツリーで見つけます。

bazel query 'some(kind(cc_.*library, deps(kind(java_binary, //java/com/example/frontend/...))))' --output location
...それに依存するすべての Java バイナリの定義を見つけましょう
bazel query 'let jbs = kind(java_binary, //java/com/example/frontend/...) in
  let cls = kind(cc_.*library, deps($jbs)) in
    $jbs intersect allpaths($jbs, $cls)'

どのようなファイル依存関係が存在しているか ...

foo のビルドに必要な Java ソースファイルの完全なセットは何ですか。

ソースファイル:

bazel query 'kind("source file", deps(//path/to/target/foo/...))' | grep java$

生成されたファイル:

bazel query 'kind("generated file", deps(//path/to/target/foo/...))' | grep java$

QUX のテストのビルドに必要な Java ソースファイルの完全なセットは何ですか。

ソースファイル:

bazel query 'kind("source file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$

生成されたファイル:

bazel query 'kind("generated file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$

X と Y の依存関係の違い

//foo が依存していて、//foo:foolib が依存していないターゲットは何ですか?

bazel query 'deps(//foo) except deps(//foo:foolib)'

//foo 本番環境バイナリが依存していないfoo テストで依存している C++ ライブラリはどれですか?

bazel query 'kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo))'

この依存関係が存在する理由

bargroups2 に依存する理由

bazel query 'somepath(bar/...,groups2/...:*)'

このクエリの結果が得られると、たいていは 1 つの 想定外または悪質かつ好ましくない bar の依存関係。その後、次のようにクエリをさらに絞り込むことができます。

docker/updater:updater_systestpy_test)から、それが依存する cc_library へのパスを表示します。

bazel query 'let cc = kind(cc_library, deps(docker/updater:updater_systest)) in
  somepath(docker/updater:updater_systest, $cc)'

ライブラリ //photos/frontend:lib が同じライブラリ //third_party/jpeglib//third_party/jpeg の 2 つのバリアントに依存するのはなぜですか?

このクエリは、「両方のライブラリに依存する //photos/frontend:lib のサブグラフを表示」に要約できます。トポロジ順に表示された結果の最後の要素が原因である可能性が高いです。

bazel query 'allpaths(//photos/frontend:lib, //third_party/jpeglib)
                intersect
               allpaths(//photos/frontend:lib, //third_party/jpeg)'
//photos/frontend:lib
//photos/frontend:lib_impl
//photos/frontend:lib_dispatcher
//photos/frontend:icons
//photos/frontend/modules/gadgets:gadget_icon
//photos/thumbnailer:thumbnail_lib
//third_party/jpeg/img:renderer

次に依存する内容

バーの下にあるどのルールが Y に依存していますか。

bazel query 'bar/... intersect allpaths(bar/..., Y)'

T のパッケージ内で T に直接依存するターゲットは何ですか?

bazel query 'same_pkg_direct_rdeps(T)'

依存関係を破棄するにはどうすればよいですか?

bar が X に依存しないようにするには、どのような依存関係パスを解除する必要がありますか?

グラフを svg ファイルに出力するには:

bazel query 'allpaths(bar/...,X)' --output graph | dot -Tsvg > /tmp/dep.svg

その他

//foo-tests ビルドには連続するステップがいくつありますか。

残念ながら、現時点ではクエリ言語では、 x から y までの距離ですが、座標から最も遠いノードも x から始まりまでの最長パスの長さを 依存しています。maxrank を使用します。

bazel query 'deps(//foo-tests)' --output maxrank | tail -1
85 //third_party/zlib:zutil.c

この結果は、長さ 85 のパスが存在することを示しています。 おすすめします。