Kueri Grafik Tindakan (aquery)

Laporkan masalah Lihat sumber Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Perintah aquery memungkinkan Anda membuat kueri untuk tindakan dalam grafik build. Alat ini beroperasi pada Grafik Target yang Dikonfigurasi pasca-analisis dan mengekspos informasi tentang Tindakan, Artefak, dan hubungannya.

aquery berguna jika Anda tertarik dengan properti Action/Artefak yang dihasilkan dari Configured Target Graph. Misalnya, perintah sebenarnya dijalankan dan input/output/mnemonik-nya.

Alat ini menerima beberapa opsi command line. Secara khusus, perintah aquery berjalan di atas build Bazel reguler dan mewarisi kumpulan opsi yang tersedia selama build.

Composable ini mendukung kumpulan fungsi yang sama yang juga tersedia untuk query tradisional, tetapi siblings, buildfiles, dan tests.

Contoh output aquery (tanpa detail spesifik):

$ bazel aquery 'deps(//some:label)'
action 'Writing file some_file_name'
  Mnemonic: ...
  Target: ...
  Configuration: ...
  ActionKey: ...
  Inputs: [...]
  Outputs: [...]

Sintaksis dasar

Contoh sederhana sintaksis untuk aquery adalah sebagai berikut:

bazel aquery "aquery_function(function(//target))"

Ekspresi kueri (dalam tanda kutip) terdiri dari hal berikut:

• aquery_function(...): fungsi khusus untuk aquery. Lihat detail selengkapnya di bawah.
• function(...): functions standar seperti query tradisional.
• //target adalah label untuk target yang berminat.

# aquery examples:
# Get the action graph generated while building //src/target_a
$ bazel aquery '//src/target_a'

# Get the action graph generated while building all dependencies of //src/target_a
$ bazel aquery 'deps(//src/target_a)'

# Get the action graph generated while building all dependencies of //src/target_a
# whose inputs filenames match the regex ".*cpp".
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

Menggunakan fungsi kueri

Ada tiga fungsi aquery:

• inputs: memfilter tindakan menurut input.
• outputs: memfilter tindakan menurut output
• mnemonic: memfilter tindakan menurut mnemonik

expr ::= inputs(word, expr)

Operator inputs menampilkan tindakan yang dihasilkan dari mem-build expr, yang nama file inputnya cocok dengan ekspresi reguler yang disediakan oleh word.

$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

Fungsi outputs dan mnemonic memiliki sintaksis yang serupa.

Anda juga dapat menggabungkan fungsi untuk mencapai operasi AND. Contoh:

  $ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'

Perintah di atas akan menemukan semua tindakan yang terlibat dalam mem-build //src/target_a, yang mnemoninya cocok dengan "Cpp.*" dan inputnya cocok dengan pola ".*cpp" dan "foo.*".

Penting: Fungsi aquery tidak dapat disusun bertingkat di dalam fungsi non-aquery. Secara konseptual, hal ini masuk akal karena output fungsi kueri adalah Action, bukan Target yang Dikonfigurasi.

Contoh error sintaksis yang dihasilkan:

        $ bazel aquery 'deps(inputs(".*cpp", //src/target_a))'
        ERROR: aquery filter functions (inputs, outputs, mnemonic) produce actions,
        and therefore can't be the input of other function types: deps
        deps(inputs(".*cpp", //src/target_a))

Opsi

Opsi build

aquery berjalan di atas build Bazel reguler sehingga mewarisi kumpulan opsi yang tersedia selama build.

Opsi Aquery

--output=(text|summary|proto|jsonproto|textproto), default=text

Format output default (text) dapat dibaca manusia, gunakan proto, textproto, atau jsonproto untuk format yang dapat dibaca mesin. Pesan proto adalah analysis.ActionGraphContainer.

--include_commandline, default=true

Menyertakan konten baris perintah tindakan dalam output (berpotensi besar).

--include_artifacts, default=true

Menyertakan nama input dan output tindakan dalam output (berpotensi besar).

--include_aspects, default=true

Apakah akan menyertakan tindakan yang dihasilkan Aspek dalam output.

--include_param_files, default=false

Sertakan konten file parameter yang digunakan dalam perintah (berpotensi besar).

Peringatan: Mengaktifkan tanda ini akan otomatis mengaktifkan tanda --include_commandline.

--include_file_write_contents, default=false

Sertakan konten file untuk tindakan actions.write() dan konten file manifes untuk tindakan SourceSymlinkManifest. Konten file ditampilkan di kolom file_contents dengan --output=xxxproto. Dengan --output=text, output memiliki baris FileWriteContents: [<base64-encoded file contents>]

--skyframe_state, default=false

Tanpa melakukan analisis tambahan, buang Action Graph dari Skyframe.

Catatan: Menentukan target dengan --skyframe_state saat ini tidak didukung. Flag ini hanya tersedia dengan --output=proto atau --output=textproto.

Alat dan fitur lainnya

Membuat kueri terhadap status Skyframe

Skyframe adalah model evaluasi dan inkrementalitas Bazel. Pada setiap instance server Bazel, Skyframe menyimpan grafik dependensi yang dibuat dari fase Analisis sebelumnya.

Dalam beberapa kasus, ada baiknya untuk membuat kueri Action Graph di Skyframe. Contoh kasus penggunaannya adalah:

1. Jalankan bazel build //target_a
2. Jalankan bazel build //target_b
3. File foo.out telah dibuat.

Sebagai pengguna Bazel, saya ingin menentukan apakah foo.out dihasilkan dari mem-build //target_a atau //target_b.

Anda dapat menjalankan bazel aquery 'outputs("foo.out", //target_a)' dan bazel aquery 'outputs("foo.out", //target_b)' untuk mengetahui tindakan yang bertanggung jawab untuk membuat foo.out, dan pada akhirnya target. Namun, jumlah target yang berbeda yang sebelumnya dibuat dapat lebih besar dari 2, sehingga menjalankan beberapa perintah aquery menjadi merepotkan.

Sebagai alternatif, flag --skyframe_state dapat digunakan:

  # List all actions on Skyframe's action graph
  $ bazel aquery --output=proto --skyframe_state

  # or

  # List all actions on Skyframe's action graph, whose output matches "foo.out"
  $ bazel aquery --output=proto --skyframe_state 'outputs("foo.out")'

Dengan mode --skyframe_state, aquery mengambil konten Action Graph yang disimpan Skyframe pada instance Bazel, (opsional) melakukan pemfilteran pada konten tersebut, dan menghasilkan konten, tanpa menjalankan ulang fase analisis.

Pertimbangan khusus

Format output

--skyframe_state saat ini hanya tersedia untuk --output=proto dan --output=textproto

Tidak menyertakan label target dalam ekspresi kueri

Saat ini, --skyframe_state membuat kueri seluruh grafik tindakan yang ada di Skyframe, terlepas dari targetnya. Mencantumkan label target dalam kueri bersama dengan --skyframe_state dianggap sebagai error sintaksis:

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state **//target_a**
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java", **//target_a**)'
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # CORRECT: Without Target
  $ bazel aquery --output=proto --skyframe_state
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java")'

Membandingkan output kueri

Anda dapat membandingkan output dari dua pemanggilan aquery yang berbeda menggunakan alat aquery_differ. Misalnya: saat Anda membuat beberapa perubahan pada definisi aturan dan ingin memverifikasi bahwa baris perintah yang dijalankan tidak berubah. aquery_differ adalah alat untuk melakukannya.

Alat ini tersedia di repositori bazelbuild/bazel. Untuk menggunakannya, clone repositori ke komputer lokal Anda. Contoh penggunaan:

  $ bazel run //tools/aquery_differ -- \
  --before=/path/to/before.proto \
  --after=/path/to/after.proto \
  --input_type=proto \
  --attrs=cmdline \
  --attrs=inputs

Perintah di atas menampilkan perbedaan antara output aquery before dan after: tindakan mana yang ada di satu tetapi tidak ada di yang lain, tindakan mana yang memiliki command line/input yang berbeda di setiap output aquery, ...). Hasil dari menjalankan perintah di atas adalah:

  Aquery output 'after' change contains an action that generates the following outputs that aquery output 'before' change doesn't:
  ...
  /list of output files/
  ...

  [cmdline]
  Difference in the action that generates the following output(s):
    /path/to/abc.out
  --- /path/to/before.proto
  +++ /path/to/after.proto
  @@ -1,3 +1,3 @@
    ...
    /cmdline diff, in unified diff format/
    ...

Opsi perintah

--before, --after: File output aquery yang akan dibandingkan

--input_type=(proto|text_proto), default=proto: format file input. Dukungan diberikan untuk output kueri proto dan textproto.

--attrs=(cmdline|inputs), default=cmdline: atribut tindakan yang akan dibandingkan.

Aspek-pada-aspek

Aspek dapat diterapkan di atas satu sama lain. Output aquery dari tindakan yang dihasilkan oleh Aspek ini kemudian akan menyertakan Jalur aspek, yang merupakan urutan Aspek yang diterapkan ke target yang menghasilkan tindakan.

Contoh Aspek-pada-Aspek:

  t0
  ^
  | <- a1
  t1
  ^
  | <- a2
  t2

Misalkan t_i adalah target aturan r_i, yang menerapkan Aspek a_i ke dependensinya.

Asumsikan bahwa a2 menghasilkan tindakan X saat diterapkan ke target t0. Output teks bazel aquery --include_aspects 'deps(//t2)' untuk tindakan X adalah:

  action ...
  Mnemonic: ...
  Target: //my_pkg:t0
  Configuration: ...
  AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...)
    -> //my_pkg:rule.bzl%**a1**(bar=...)]
  ...

Ini berarti tindakan X dihasilkan oleh Aspek a2 yang diterapkan ke a1(t0), dengan a1(t0) adalah hasil dari Aspek a1 yang diterapkan ke target t0.

Setiap AspectDescriptor memiliki format berikut:

  AspectClass([param=value,...])

AspectClass dapat berupa nama class Aspect (untuk Aspect native) atau bzl_file%aspect_name (untuk Aspect Starlark). AspectDescriptor diurutkan dalam urutan topologi grafik dependensi.

Menautkan dengan profil JSON

Meskipun kueri memberikan informasi tentang tindakan yang dijalankan dalam build (alasan tindakan dijalankan, input/output-nya), profil JSON memberi tahu kita waktu dan durasi eksekusinya. Anda dapat menggabungkan 2 kumpulan informasi ini melalui penyebut umum: output utama tindakan.

Untuk menyertakan output tindakan dalam profil JSON, buat profil dengan --experimental_include_primary_output --noslim_profile. Profil ramping tidak kompatibel dengan penyertaan output utama. Output utama tindakan disertakan secara default oleh kueri.

Saat ini kami tidak menyediakan alat kanonis untuk menggabungkan 2 sumber data ini, tetapi Anda seharusnya dapat membuat skrip Anda sendiri dengan informasi di atas.

Masalah umum

Menangani tindakan bersama

Terkadang tindakan dibagikan di antara target yang dikonfigurasi.

Pada fase eksekusi, tindakan bersama tersebut hanya dianggap sebagai satu dan hanya dieksekusi sekali. Namun, kueri beroperasi pada grafik tindakan pra-eksekusi, pasca-analisis, sehingga memperlakukannya seperti tindakan terpisah yang Artefak output-nya memiliki execPath yang sama persis. Akibatnya, Artefak yang setara akan tampak duplikat.

Daftar masalah aquery/fitur yang direncanakan dapat ditemukan di GitHub.

FAQ

ActionKey tetap sama meskipun konten file input berubah.

Dalam konteks kueri, ActionKey mengacu pada String yang diperoleh dari ActionAnalysisMetadata#getKey:

  Returns a string encoding all of the significant behaviour of this Action that might affect the
  output. The general contract of `getKey` is this: if the work to be performed by the
  execution of this action changes, the key must change.

  ...

  Examples of changes that should affect the key are:

  - Changes to the BUILD file that materially affect the rule which gave rise to this Action.
  - Changes to the command-line options, environment, or other global configuration resources
      which affect the behaviour of this kind of Action (other than changes to the names of the
      input/output files, which are handled externally).
  - An upgrade to the build tools which changes the program logic of this kind of Action
      (typically this is achieved by incorporating a UUID into the key, which is changed each
      time the program logic of this action changes).
  Note the following exception: for actions that discover inputs, the key must change if any
  input names change or else action validation may falsely validate.

Hal ini mengecualikan perubahan pada konten file input, dan tidak boleh disamakan dengan RemoteCacheClient#ActionKey.

Pembaruan

Untuk masalah/permintaan fitur apa pun, harap laporkan masalah di sini.