aquery komutu, derleme grafiğinizdeki işlemleri sorgulamanızı sağlar.
Analiz sonrası Yapılandırılmış Hedef Grafik üzerinde çalışır ve İşlemler, Yapılar ve bunların ilişkileri ile ilgili bilgileri gösterir.
aquery, yapılandırılmış hedef grafiğinden oluşturulan işlemler/yapıların özellikleriyle ilgilendiğinizde kullanışlıdır. Örneğin, gerçek komutların çalıştığı
ve bunların giriş/çıkış/anımsatıcılar.
Araç, çeşitli komut satırı seçeneklerini kabul eder. aquery komutunun normal bir Bazel derlemesinin üzerinde çalıştığı ve derleme sırasında kullanılabilen seçenek grubunu devraldığı özellikle belirtilmelidir.
Geleneksel query'te de kullanılabilen işlevlerin aynısını destekler ancak siblings, buildfiles ve tests'te de kullanılabilir.
Örnek aquery çıkışı (belirli ayrıntılar olmadan):
$ bazel aquery 'deps(//some:label)' action 'Writing file some_file_name' Mnemonic: ... Target: ... Configuration: ... ActionKey: ... Inputs: [...] Outputs: [...]
Temel söz dizimi
aquery söz dizimine ilişkin basit bir örnek aşağıda verilmiştir:
bazel aquery "aquery_function(function(//target))"
Sorgu ifadesi (tırnak işareti içinde) aşağıdakilerden oluşur:
aquery_function(...):aquery'a özgü işlevler. Daha fazla bilgiyi aşağıda bulabilirsiniz.function(...): gelenekselqueryolarak standart işlevler.//target, ilgilenilen hedefin etiketidir.
# 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))'
Sorgu işlevlerini kullanma
Üç aquery işlevi vardır:
inputs: İşlemleri girişlere göre filtreleyin.outputs: İşlemleri çıkışlara göre filtrelemnemonic: işlemleri hafıza güçlendiriciye göre filtreleme
expr ::= inputs(word, expr)
inputs operatörü, expr binasından oluşturulan ve giriş dosya adları word tarafından sağlanan normal ifadeyle eşleşen işlemleri döndürür.
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'
outputs ve mnemonic işlevleri benzer bir söz dizimine sahiptir.
VE işlemini gerçekleştirmek için işlevleri de birleştirebilirsiniz. Örneğin:
$ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'
Yukarıdaki komut, //src/target_a oluşturmayla ilgili tüm işlemleri bulur. Bu işlemlerin anımsatıcıları "Cpp.*" ile eşleşir ve girişleri ".*cpp" ve "foo.*" kalıplarıyla eşleşir.
Oluşturulan söz dizimi hatasına bir örnek:
$ 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))
Seçenekler
Derleme seçenekleri
aquery, normal bir Bazel derlemesinin üzerinde çalışır ve böylece, derleme sırasında kullanılabilen seçenekler kümesini devralır.
Sorgu seçenekleri
--output=(text|summary|proto|jsonproto|textproto), default=text
Varsayılan çıkış biçimi (text) kullanıcılar tarafından okunabilirdir. Makine tarafından okunabilir biçim için proto, textproto veya jsonproto kullanın.
Proto mesajı: analysis.ActionGraphContainer.
--include_commandline, default=true
Çıkıştaki işlem komut satırlarının içeriğini içerir (büyük olabilir).
--include_artifacts, default=true
Çıkıştaki işlem giriş ve çıkışlarının adlarını içerir (büyük olabilir).
--include_aspects, default=true
Aspect tarafından oluşturulan işlemlerin çıktıya dahil edilip edilmeyeceğini belirtir.
--include_param_files, default=false
Komutta kullanılan param dosyalarının içeriğini dahil et (büyük olabilir).
--include_file_write_contents, default=false
actions.write() işleminin dosya içeriğini ve SourceSymlinkManifest işleminin manifest dosyasının içeriğini ekleyin. Dosya içeriği, --output=xxxproto ile file_contents alanında döndürülür.
--output=text ile çıkışta FileWriteContents: [<base64-encoded file contents>] satır bulunur
--skyframe_state, default=false
Ekstra analiz gerçekleştirmeden Skyframe'den İşlem Grafiği'nin dökümünü alın.
Diğer araçlar ve özellikler
Skyframe'in durumuna göre sorgulama
Skyframe, Bazel'in değerlendirme ve artış modelidir. Skyframe, Bazel sunucusunun her örneğinde analiz aşamasının önceki çalıştırmalarından oluşturulan bağımlılık grafiğini depolar.
Bazı durumlarda, Skyframe'de İşlem Grafiği'ni sorgulamak yararlıdır. Örnek kullanım alanı şu şekildedir:
bazel build //target_açalıştırmabazel build //target_bçalıştırmafoo.outdosyası oluşturuldu.
Bazel kullanıcısı olarak, foo.out'in //target_a mi yoksa //target_b mi oluşturulduğunu belirlemek istiyorum.
foo.out oluşturmakla sorumlu işlemi belirlemek için bazel aquery 'outputs("foo.out", //target_a)' ve bazel aquery 'outputs("foo.out", //target_b)' çalıştırabilir, sonra da hedefi belirleyebilirsiniz. Bununla birlikte, daha önce oluşturulan farklı hedeflerin sayısı 2'den fazla olabilir. Bu da birden fazla aquery komutunun çalıştırılmasını zorlaştırır.
Alternatif olarak --skyframe_state işareti kullanılabilir:
# 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")'
--skyframe_state modunda aquery, Skyframe'ın Bazel örneğinde tuttuğu işlem grafiğinin içeriğini alır, (isteğe bağlı olarak) üzerinde filtreleme yapar ve analiz aşamasını yeniden çalıştırmadan içeriği döndürür.
Dikkat edilmesi gereken noktalar
Çıkış biçimi
--skyframe_state şu anda yalnızca --output=proto ve --output=textproto ile kullanılabilir
Hedef etiketlerinin sorgu ifadesine dahil edilmemesi
Şu anda --skyframe_state, hedeflerden bağımsız olarak Skyframe'da bulunan tüm işlem grafiğini sorgulayan bir işlevdir. Sorguda hedef etiketin --skyframe_state ile birlikte belirtilmesi, söz dizimi hatası olarak kabul edilir:
# 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")'
Sorgu çıkışlarını karşılaştırma
aquery_differ aracını kullanarak iki farklı sorgu çağrısının çıktılarını karşılaştırabilirsiniz.
Örneğin, kural tanımınızda bazı değişiklikler yaptığınızda ve çalıştırılmakta olan komut satırlarının değişmediğini doğrulamak istediğinizde. aquery_differ bu konuda kullanabileceğiniz araçtır.
Bu araç bazelbuild/bazel deposunda mevcuttur. Bu özelliği kullanmak için depoyu yerel makinenize klonlayın. Örnek kullanım:
$ bazel run //tools/aquery_differ -- \ --before=/path/to/before.proto \ --after=/path/to/after.proto \ --input_type=proto \ --attrs=cmdline \ --attrs=inputs
Yukarıdaki komut, before ve after aquery çıkışları arasındaki farkı döndürür: hangi işlemlerin birinde mevcut olup diğerinde bulunmadığı, hangi işlemlerin her aquery çıkışında farklı komut satırı/girişlere sahip olduğu vb. Yukarıdaki komutun çalıştırılmasının sonucu şu olur:
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/
...
Komut seçenekleri
--before, --after: Karşılaştırılacak aquery çıkış dosyaları
--input_type=(proto|text_proto), default=proto: Giriş dosyalarının biçimi. proto ve textproto sorgu çıkışı için destek sağlanır.
--attrs=(cmdline|inputs), default=cmdline: karşılaştırılacak işlemlerin özellikleri.
En boy oranı üzerinde en boy oranı
Yönler birbirinin üzerine uygulanabilir. Bu Aspect'ler tarafından oluşturulan işlemin sorgu çıkışı, En boy yolu'nu içerir. Bu, işlemi oluşturan hedefe uygulanan Yönlerin sırasıdır.
En Boy Oranı örneği:
t0 ^ | <- a1 t1 ^ | <- a2 t2
Bağımlılıklarına Aspecti uygulayan ri kuralının hedefi i olsun.
a2'nin, t0 hedefine uygulandığında X eylemi oluşturduğunu varsayalım. X işlemi için bazel aquery --include_aspects 'deps(//t2)' metin çıkışı şu şekilde olur:
action ...
Mnemonic: ...
Target: //my_pkg:t0
Configuration: ...
AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...)
-> //my_pkg:rule.bzl%**a1**(bar=...)]
...
Bu, X işleminin a1(t0)'ye uygulanan a2 özelliği tarafından oluşturulduğu anlamına gelir. a1(t0), t0 hedefine uygulanan a1 özelliğinin sonucudur.
Her AspectDescriptor aşağıdaki biçimdedir:
AspectClass([param=value,...])
AspectClass, Aspect sınıfının adı (yerel Aspect'ler için) veya bzl_file%aspect_name (Starlark Aspect'ler için) olabilir. AspectDescriptor, bağımlılık grafiğinin topolojik sırasına göre sıralanır.
JSON profiliyle bağlantı oluşturma
Sorgu, derlemede çalıştırılan işlemler (neden çalıştırıldıkları, bunların girişleri/çıkışları) hakkında bilgi sağlarken JSON profili, yürütme işlemlerinin zamanlamasını ve süresini belirtir. Bu iki bilgi kümesini, bir ortak payda üzerinden, yani işlemin birincil çıkışıyla birleştirmek mümkündür.
İşlemlerin çıktılarını JSON profiline dahil etmek için profili --experimental_include_primary_output --noexperimental_slim_json_profile ile oluşturun.
İnce profiller, birincil çıkışların dahil edilmesiyle uyumlu değildir. Bir işlemin birincil çıkışı,
sorguya varsayılan olarak dahil edilir.
Şu anda bu 2 veri kaynağını birleştirmek için standart bir araç sunmuyoruz, ancak yukarıdaki bilgileri kullanarak kendi komut dosyanızı oluşturabiliyor olmalısınız.
Bilinen sorunlar
Paylaşılan işlemleri işleme
Bazen yapılandırılmış hedefler arasında işlemler paylaşılır.
Yürütme aşamasında bu ortak işlemler tek bir işlem olarak kabul edilir ve yalnızca bir kez yürütülür.
Ancak sorgular, yürütme öncesi, analiz sonrası işlem grafiğinde çalışır ve bu nedenle, çıkış yapıları tam olarak aynı execPath değerine sahip olan bu ayrı işlemleri benzer şekilde ele alır. Sonuç olarak, eşdeğer yapı taşları yinelenmiş olarak görünür.
Sorgu sorunlarının/planlanan özelliklerin listesini GitHub'da bulabilirsiniz.
SSS
Giriş dosyasının içeriği değişse bile ActionKey aynı kalır.
Sorgu bağlamında ActionKey, ActionAnalysisMetadata#getKey'den alınan String öğesini ifade eder:
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.
Bu, giriş dosyalarının içeriğinde yapılan değişiklikleri içermez ve RemoteCacheClient#ActionKey ile karıştırılmamalıdır.
Güncellemeler
Sorunlar veya özellik talepleri için lütfen buradan sorun kaydı oluşturun.