構成可能なクエリ（cquery）

問題を報告するopen_in_new ソースを表示open_in_new

cquery は、ビルドグラフに対する select() とビルド オプションの効果を正しく処理する query のバリアントです。

これを実現するには、これらの効果を統合する Bazel の分析フェーズの結果を実行します。一方、query は、オプションを評価する前に Bazel の読み込みフェーズの結果を実行します。

次に例を示します。

$ cat > tree/BUILD <<EOF
sh_library(
    name = "ash",
    deps = select({
        ":excelsior": [":manna-ash"],
        ":americana": [":white-ash"],
        "//conditions:default": [":common-ash"],
    }),
)
sh_library(name = "manna-ash")
sh_library(name = "white-ash")
sh_library(name = "common-ash")
config_setting(
    name = "excelsior",
    values = {"define": "species=excelsior"},
)
config_setting(
    name = "americana",
    values = {"define": "species=americana"},
)
EOF

# Traditional query: query doesn't know which select() branch you will choose,
# so it conservatively lists all of possible choices, including all used config_settings.
$ bazel query "deps(//tree:ash)" --noimplicit_deps
//tree:americana
//tree:ash
//tree:common-ash
//tree:excelsior
//tree:manna-ash
//tree:white-ash

# cquery: cquery lets you set build options at the command line and chooses
# the exact dependencies that implies (and also the config_setting targets).
$ bazel cquery "deps(//tree:ash)" --define species=excelsior --noimplicit_deps
//tree:ash (9f87702)
//tree:manna-ash (9f87702)
//tree:americana (9f87702)
//tree:excelsior (9f87702)

各結果には、ターゲットがビルドされた構成の一意の識別子 (9f87702) が含まれています。

cquery は構成されたターゲット グラフで実行されるため、ビルド アクションなどのアーティファクトに関する分析情報や test_suite ルールにはターゲットが構成されていないため、アクセスできません。前者については、aquery をご覧ください。

基本的な構文

単純な cquery 呼び出しは次のようになります。

bazel cquery "function(//target)"

クエリ式 "function(//target)" は、次の要素で構成されます。

• function(...) は、ターゲットで実行する関数です。cquery は、query のほとんどの関数に加えて、いくつかの新しい関数をサポートします。
• //target は、関数に渡される式です。この例では、式は単純なターゲットです。ただし、クエリ言語では関数をネストすることもできます。例については、クエリガイドをご覧ください。

cquery には、読み込みと分析のフェーズを行うためのターゲットが必要です。cquery は、特に指定しない限り、クエリ式にリストされているターゲットを解析します。トップレベル ビルド ターゲットの依存関係をクエリする方法については、--universe_scope をご覧ください。

構成

次の行をご覧ください。

//tree:ash (9f87702)

//tree:ash が ID 9f87702 の構成でビルドされたことを意味します。ほとんどのターゲットの場合、これは構成を定義するビルド オプション値の不透明ハッシュです。

構成全体を確認するには、次のコマンドを実行します。

$ bazel config 9f87702

9f87702 は、完全な ID の接頭辞です。これは、完全な ID が長くてわかりにくい SHA-256 ハッシュであるためです。cquery は、完全な識別子の有効な接頭辞を認識します。これは Git の短いハッシュに似ています。完全な ID を表示するには、$ bazel config を実行します。

ターゲット パターンの評価

//foo と cquery では、query の意味が異なります。これは、cquery が構成済みのターゲットを評価し、ビルドグラフに //foo の複数の構成済みバージョンが存在する可能性があるためです。

cquery の場合、クエリ式のターゲット パターンは、そのパターンに一致するラベルを使用して、構成されたすべてのターゲットに評価されます。出力は決定論的ですが、cquery はコアクエリ順序コントラクトを超える順序の保証はありません。

これにより、クエリ式では query を使用した場合よりも結果が小さくなります。たとえば、次のように複数の結果が生成されます。

# Analyzes //foo in the target configuration, but also analyzes
# //genrule_with_foo_as_tool which depends on an exec-configured
# //foo. So there are two configured target instances of //foo in
# the build graph.
$ bazel cquery //foo --universe_scope=//foo,//genrule_with_foo_as_tool
//foo (9f87702)
//foo (exec)

クエリを実行するインスタンスを正確に宣言する場合は、config 関数を使用します。

ターゲット パターンの詳細については、query のターゲット パターンのドキュメントをご覧ください。

関数

query でサポートされている関数セットのうち、cquery は visible、siblings、buildfiles、tests 以外をすべてサポートしています。

cquery には、次の新機能も導入されています。

構成

expr ::= config(expr, word)

config 演算子は、最初の引数で示されたラベルと 2 番目の引数で指定された構成で構成されたターゲットの検索を試みます。

2 番目の引数の有効な値は null またはカスタム構成ハッシュです。ハッシュは $ bazel config または前の cquery の出力から取得できます。

例:

$ bazel cquery "config(//bar, 3732cc8)" --universe_scope=//foo

$ bazel cquery "deps(//foo)"
//bar (exec)
//baz (exec)

$ bazel cquery "config(//baz, 3732cc8)"

指定した引数で最初の引数の結果が見つからない場合、見つかった結果のみが返されます。指定された構成で結果が見つからない場合、クエリは失敗します。

オプション

ビルド オプション

cquery は通常の Bazel ビルドで実行されるため、ビルド時に使用可能な一連のオプションを継承します。

cquery オプションの使用

--universe_scope（カンマ区切りのリスト）

多くの場合、構成されたターゲットの依存関係は遷移を経るため、構成が依存先とは異なります。このフラグを使用すると、ターゲットが別のターゲットの依存関係または推移的な依存関係としてビルドされているかのように、ターゲットをクエリできます。次に例を示します。

# x/BUILD
genrule(
     name = "my_gen",
     srcs = ["x.in"],
     outs = ["x.cc"],
     cmd = "$(locations :tool) $< >$@",
     tools = [":tool"],
)
cc_binary(
    name = "tool",
    srcs = ["tool.cpp"],
)

Genrule は exec 構成でツールを構成するため、以下のクエリにより以下の出力が生成されます。

クエリ	ターゲット構築	出力
bazel cquery "//x:tool"	//x:tool	//x:tool(targetconfig)
bazel cquery "//x:tool" --universe_scopeoffx:my_gen"	//x:my_gen	//x:tool(execconfig)

このフラグが設定されている場合、そのコンテンツがビルドされます。設定されていない場合、クエリ式に記載されているすべてのターゲットがビルドされます。ビルドされたターゲットの推移的な閉鎖がクエリの範囲として使用されます。いずれの場合も、ビルドされるターゲットは最上位でビルド可能である必要があります（つまり、トップレベル オプションと互換性がある必要があります）。cquery は、これらの最上位ターゲットの推移的な結果を返します。

クエリの式ですべてのターゲットをトップレベルでビルドできる場合でも、この処理はしない方がよい場合があります。たとえば、--universe_scope を明示的に設定すると、重要でない構成でターゲットを複数回ビルドすることを防ぐことができます。また、探しているターゲットの構成バージョンも指定できます（現時点では他の方法で完全に指定することはできません）。クエリ式が deps(//foo) より複雑な場合は、このフラグを設定する必要があります。

--implicit_deps（ブール値、デフォルト=True）

このフラグを false に設定すると、BUILD ファイルで明示的に設定されず、Bazel が別の場所に設定した結果がすべて除外されます。これには、解決済みのツールチェーンのフィルタリングも含まれます。

--tool_deps（ブール値、デフォルト=True）

このフラグを false に設定すると、クエリされたターゲットからターゲットへのパスがターゲット構成とターゲット以外の構成の間の遷移を超える、すべての構成対象が除外されます。クエリ対象のターゲットがターゲット構成にある場合、--notool_deps を設定すると、ターゲット構成にも存在するターゲットのみが返されます。クエリ対象のターゲットがターゲット以外の構成にある場合、--notool_deps を設定すると、ターゲット以外の構成でもターゲットが返されます。通常、この設定は解決済みのツールチェーンのフィルタリングには影響しません。

--include_aspects（ブール値、デフォルト=True）

アスペクトにより追加された依存関係を含める。

このフラグが無効で、X がアスペクトを介してのみ依存する場合、cquery somepath(X, Y) と cquery deps(X) | grep 'Y' は Y を省略します。

出力形式

デフォルトでは、cquery はラベルと構成のペアの依存関係順にリストを出力します。結果を公開する別のオプションもあります。

遷移

--transitions=lite
--transitions=full

構成遷移は、トップレベル ターゲットとは異なる構成で最上位ターゲットの下にターゲットをビルドするために使用されます。

たとえば、ターゲットは、tools 属性内のすべての依存関係で exec 構成への移行を課す場合があります。これらは、属性遷移と呼ばれます。ルールでは、遷移を独自の構成（ルールクラス遷移）に設定することもできます。この出力形式では、移行タイプに関する情報（ビルドタイプに対する影響やビルド オプションへの影響など）が出力されます。

この出力形式は、デフォルトで NONE に設定されている --transitions フラグによってトリガーされます。FULL または LITE モードに設定できます。FULL モードでは、ルールクラス遷移と属性遷移に関する情報が、遷移の前後でオプションの詳細な差分を含めて出力されます。LITE モードでは、オプションの差分なしで、同じ情報が出力されます。

プロトコル メッセージの出力

--output=proto

このオプションを使用すると、結果のターゲットがバイナリ プロトコル バッファ形式で出力されます。プロトコル バッファの定義は、src/main/protobuf/analysis_v2.proto にあります。

CqueryResult は、cquery の結果を含む最上位メッセージです。ConfiguredTarget メッセージのリストと Configuration メッセージのリストがあります。各 ConfiguredTarget の configuration_id の値は、対応する Configuration メッセージの id フィールドの値と同じです。

--[no]proto:include_configurations

デフォルトでは、cquery の結果は構成済みのターゲットの一部として構成情報を返します。この情報を省略し、クエリの proto 出力とまったく同じ形式の proto 出力を取得するには、このフラグを false に設定します。

proto の出力関連のオプションの詳細については、クエリの proto 出力のドキュメントをご覧ください。

グラフ出力

--output=graph

このオプションでは、Graphviz 互換の .dot ファイルとして出力を生成します。詳しくは、query のグラフ出力のドキュメントをご覧ください。cquery は --graph:node_limit と --graph:factored もサポートしています。

ファイル出力

--output=files

このオプションは、bazel build 呼び出しの最後に出力されるリストと同様のクエリを持つ各ターゲットによって生成された出力ファイルのリストを出力します。出力には、--output_groups フラグで決定された、リクエストされた出力グループでアドバタイズされたファイルのみが含まれます。ソースファイルが含まれています。

この出力形式で出力されるパスはすべて、bazel info execution_root を介して取得できる execroot からの相対パスです。bazel-out コンビニエンス シンボリック リンクが存在する場合、メイン リポジトリ内のファイルへのパスも、ワークスペース ディレクトリを基準とする相対パスで解決されます。

Starlark を使用して出力形式を定義する

--output=starlark

この出力形式では、クエリ結果で構成されたターゲットごとに Starlark 関数を呼び出し、呼び出しによって返された値を出力します。--starlark:file フラグには、format という関数を 1 つのパラメータ target で定義する Starlark ファイルの場所を指定します。この関数は、クエリ結果の各ターゲットに対して呼び出されます。あるいは、--starlark:expr フラグを使用して、def format(target): return expr として宣言する関数の本文だけを指定することもできます。

「cquery」スターラーク方言

cquery Starlark 環境は、ビルドまたは .bzl ファイルとは異なります。これには、すべての Starlark の組み込み定数と関数に加えて、以下に説明する cquery 固有のいくつかの関数が含まれますが、glob、native、rule などは含まれていません。load ステートメントはサポートされていません。

build_options（target）

build_options(target) は、キーがビルド オプション識別子（構成を参照）であり、値が Starlark 値であるマップを返します。値が有効な Starlark 値ではないビルド オプションは、このマップから省略されています。

ターゲットが入力ファイルの場合、入力ファイルのターゲットが null 構成であるため、build_options(target) は None を返します。

プロバイダ（ターゲット）

providers(target) は、キーがプロバイダの名前（"DefaultInfo" など）で、値が Starlark の値であるマップを返します。有効な Starlark 値でないプロバイダは、このマップから除外されます。

例

//foo によって生成されたすべてのファイルのベース名のスペース区切りリストを出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="' '.join([f.basename for f in target.files.to_list()])"

//bar とそのサブパッケージ内のルール ターゲットによって生成されたすべてのファイルのパスをスペースで区切ったリストを出力します。

  bazel cquery 'kind(rule, //bar/...)' --output=starlark \
    --starlark:expr="' '.join([f.path for f in target.files.to_list()])"

//foo で登録されたすべてのアクションの覚え方のリストを出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="[a.mnemonic for a in target.actions]"

cc_library //baz で登録されたコンパイル出力のリストを出力します。

  bazel cquery //baz --output=starlark \
    --starlark:expr="[f.path for f in target.output_groups.compilation_outputs.to_list()]"

//foo のビルド時に、コマンドライン オプション --javacopt の値を出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="build_options(target)['//command_line_option:javacopt']"

各ターゲットのラベルを 1 つの出力で出力します。この例では、ファイルで定義されている Starlark 関数を使用します。

  $ cat example.cquery

  def has_one_output(target):
    return len(target.files.to_list()) == 1

  def format(target):
    if has_one_output(target):
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

各ターゲットのラベルを Python 3 と厳密に出力します。この例では、ファイルで定義されている Starlark 関数を使用します。

  $ cat example.cquery

  def format(target):
    p = providers(target)
    py_info = p.get("PyInfo")
    if py_info and py_info.has_py3_only_sources:
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

ユーザー定義のプロバイダから値を抽出します。

  $ cat some_package/my_rule.bzl

  MyRuleInfo = provider(fields={"color": "the name of a color"})

  def _my_rule_impl(ctx):
      ...
      return [MyRuleInfo(color="red")]

  my_rule = rule(
      implementation = _my_rule_impl,
      attrs = {...},
  )

  $ cat example.cquery

  def format(target):
    p = providers(target)
    my_rule_info = p.get("//some_package:my_rule.bzl%MyRuleInfo'")
    if my_rule_info:
      return my_rule_info.color
    return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

cquery と query

cquery と query は相互に補完し、異なるニッチを得意とします。以下から、最適なツールをお選びください。

• cquery は特定の select() ブランチに従って、作成するグラフを正確にモデル化します。query はビルドが選択するブランチを認識しないため、すべてのブランチを含めて過大評価します。
• cquery の精度には、query よりも多くのグラフを作成する必要があります。具体的には、cquery は構成されたターゲットを評価しますが、query はターゲットのみを評価します。時間とメモリの使用量が増えます。
• cquery のクエリ言語の解釈により、query が回避するあいまいさが生じます。たとえば、"//foo" が 2 つの構成に存在する場合、cquery "deps(//foo)" のどれを使用する必要がありますか？これを行うには、config 関数を使用します。
• 新しいツールである cquery は、特定のユースケースをサポートしていません。詳しくは、既知の問題をご覧ください。

既知の問題

cquery「ビルド」されるターゲットはすべて同じ構成である必要があります。

cquery は、クエリを評価する前に、ビルド アクションが実行される直前のビルドをトリガーします。「ビルドする」ターゲットは、デフォルトでクエリ式に表示されるすべてのラベルから選択されます（これは --universe_scope でオーバーライドできます）。構成は同じである必要があります。

通常はトップレベルの「ターゲット」構成を共有しますが、ルールは受信エッジ遷移で独自の構成を変更できます。ここが cquery の要です。

回避策: 可能であれば、--universe_scope をより厳格なスコープに設定します。次に例を示します。

# This command attempts to build the transitive closures of both //foo and
# //bar. //bar uses an incoming edge transition to change its --cpu flag.
$ bazel cquery 'somepath(//foo, //bar)'
ERROR: Error doing post analysis query: Top-level targets //foo and //bar
have different configurations (top-level targets with different
configurations is not supported)

# This command only builds the transitive closure of //foo, under which
# //bar should exist in the correct configuration.
$ bazel cquery 'somepath(//foo, //bar)' --universe_scope=//foo

--output=xml はサポート対象外です。

非確定的な出力。

cquery は、以前のコマンドからビルドグラフを自動的にワイプしないため、過去のクエリの結果が返される可能性が高くなります。たとえば、genquery は tools 属性に exec 遷移を実行します。つまり、このツールは exec 構成でツールを構成します。

今回の移行による長期的な影響は、以下でご確認いただけます。

$ cat > foo/BUILD <<<EOF
genrule(
    name = "my_gen",
    srcs = ["x.in"],
    outs = ["x.cc"],
    cmd = "$(locations :tool) $< >$@",
    tools = [":tool"],
)
cc_library(
    name = "tool",
)
EOF

    $ bazel cquery "//foo:tool"
tool(target_config)

    $ bazel cquery "deps(//foo:my_gen)"
my_gen (target_config)
tool (exec_config)
...

    $ bazel cquery "//foo:tool"
tool(exec_config)

回避策: 構成されたターゲットの再解析を強制的に行うように、起動オプションを変更します。たとえば、ビルドコマンドに --test_arg=<whatever> を追加します。

トラブルシューティング

再帰ターゲット パターン（/...）

問題が発生した場合:

$ bazel cquery --universe_scope=//foo:app "somepath(//foo:app, //foo/...)"
ERROR: Error doing post analysis query: Evaluation failed: Unable to load package '[foo]'
because package is not in scope. Check that all target patterns in query expression are within the
--universe_scope of this query.

これは、パッケージ //foo が --universe_scope=//foo:app に含まれているにもかかわらず、対象範囲外であることを意味します。これは、cquery の設計上の制限によるものです。回避策として、ユニバース スコープに //foo/... を明示的に追加します。

$ bazel cquery --universe_scope=//foo:app,//foo/... "somepath(//foo:app, //foo/...)"

この方法がうまくいかない場合（たとえば、選択したビルドフラグで //foo/... 内の一部のターゲットをビルドできない場合）、前処理クエリを使用してパターンを構成要素パッケージに手動でラップ解除します。

# Replace "//foo/..." with a subshell query call (not cquery!) outputting each package, piped into
# a sed call converting "<pkg>" to "//<pkg>:*", piped into a "+"-delimited line merge.
# Output looks like "//foo:*+//foo/bar:*+//foo/baz".
#
$  bazel cquery --universe_scope=//foo:app "somepath(//foo:app, $(bazel query //foo/...
--output=package | sed -e 's/^/\/\//' -e 's/$/:*/' | paste -sd "+" -))"