İşlem Grafiği Sorgusu (sorgu)

aquery komutu, derleme grafiğinizdeki işlemleri sorgulamanıza olanak tanır. Analiz sonrası Yapılandırılmış Hedef Grafiği üzerinde çalışır ve Eylemler, Yapılar ve bunların ilişkileri hakkında bilgiler gösterir.

aquery, Yapılandırılmış Hedef Grafiği'nden oluşturulan İşlemlerin/Yapıların özellikleriyle ilgileniyorsanız yararlı olur. Örneğin, gerçek komutlar çalışır ve bunların girişleri/çıkışları/hatırlatıcıları.

Araç, çeşitli komut satırı seçeneklerini kabul eder. Özellikle, aquery komutu normal bir Bazel derlemesinin üzerinde çalışır ve derleme sırasında kullanılabilen seçenek grubunu devralır.

Geleneksel query için de kullanılabilen ancak siblings, buildfiles ve tests için de kullanılabilen işlev grubunu destekler.

Örnek bir 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 için söz diziminin basit bir örneği aşağıda verilmiştir:

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

Tırnak içindeki sorgu ifadesi şunlardan oluşur:

• aquery_function(...): aquery öğesine özgü işlevler. Aşağıda daha ayrıntılı bilgi bulabilirsiniz.
• function(...): Standart, geleneksel query gibi çalışır.
• //target, ilgilenen 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 filtrele
• mnemonic: İşlemleri anımsatıcıya göre filtrele

expr ::= inputs(word, expr)

inputs operatörü, giriş dosya adları word tarafından sağlanan normal ifadeyle eşleşen expr derlemesinden oluşturulan 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 birleştirebilirsiniz. Örneğin:

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

Yukarıdaki komut, //src/target_a derlemesinde yer alan, anımsatıcıları "Cpp.*" ile eşleşen ve girişleri ".*cpp" ve "foo.*" kalıplarıyla eşleşen tüm işlemleri bulur.

Önemli: Sorgu işlevleri, sorgu olmayan işlevlerin içine yerleştirilemez. Kavramsal olarak, bir sorgu işlevlerinin çıktısı Yapılandırılmış Hedefler değil, İşlemler olduğu için bu mantıklıdır.

Oluşturulan söz dizimi hatası örneği:

        $ 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 bu nedenle, derleme sırasında kullanılabilen bir dizi seçeneği devralır.

Sorgu seçenekleri

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

Varsayılan çıkış biçimi (text) kullanıcılar tarafından okunabilir. Makine tarafından okunabilen biçim için proto, textproto veya jsonproto kullanın. Proto mesajı analysis.ActionGraphContainer.

--include_commandline, default=true

Çıkışa işlem komut satırlarının içeriğini içerir (büyük olasılıkla büyüktür).

--include_artifacts, default=true

Çıkışta (büyük olasılıkla büyük) işlem giriş ve çıkışlarının adlarını içerir.

--include_aspects, default=true

Sonuçta En Boy ile oluşturulan işlemlerin eklenip eklenmeyeceğini belirtir.

--include_param_files, default=false

Komutta kullanılan parametre dosyalarının içeriğini ekleyin (büyük olasılıkla büyüktür).

Uyarı: Bu işaret etkinleştirildiğinde --include_commandline işareti otomatik olarak etkinleştirilir.

--include_file_write_contents, default=false

actions.write() işlemi için dosya içeriğini ve SourceSymlinkManifest işlemi için manifest dosyasının içeriğini ekleyin. Dosya içeriği, --output=xxxproto ile file_contents alanına döndürülür. --output=text ile çıkışta FileWriteContents: [<base64-encoded file contents>] satırı olur

--skyframe_state, default=false

Ekstra analiz yapmadan Skyframe'den İşlem Grafiği'nin dökümünü alın.

Not: --skyframe_state ile hedef belirtme özelliği şu anda desteklenmemektedir. Bu işaret yalnızca --output=proto veya --output=textproto ile kullanılabilir.

Diğer araçlar ve özellikler

Skyframe durumunu sorgulama

Skyframe, Bazel'in değerlendirme ve artımlılık modelidir. Skyframe, her 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'nin sorgulanması faydalı olur. Aşağıda örnek bir kullanım alanı verilmiştir:

1. bazel build //target_a çalıştırma
2. bazel build //target_b çalıştırma
3. foo.out dosyası oluşturuldu.

Bir Bazel kullanıcısı olarak, foo.out ürününün //target_a veya //target_b adlı derlemede mi oluşturulduğunu belirlemek istiyorum.

foo.out ve buna bağlı olarak hedefin oluşturulmasından sorumlu olan işlemi bulmak için bazel aquery 'outputs("foo.out", //target_a)' ve bazel aquery 'outputs("foo.out", //target_b)' çalıştırılabilir. Bununla birlikte, daha önce oluşturulmuş farklı hedeflerin sayısı 2'den fazla olabilir. Bu da birden fazla aquery komutunu çalıştırmayı 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 moduyla aquery, Skyframe'in Bazel örneğinde tuttuğu İşlem Grafiği'nin içeriğini alır (isteğe bağlı olarak) analiz aşamasını yeniden çalıştırmadan bu örneğin üzerinde filtreleme yapar ve içerik çıkartır.

Dikkat edilmesi gereken noktalar

Çıkış biçimi

--skyframe_state, şu anda yalnızca --output=proto ve --output=textproto için kullanılabilir

Sorgu ifadesine hedef etiketlerin dahil edilmemesi

Şu anda --skyframe_state, hedeflerden bağımsız olarak Skyframe'de bulunan tüm eylem grafiğini sorgular. Sorguda hedef etiketin --skyframe_state ile birlikte belirtilmesi bir 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 sonuçlarını karşılaştırabilirsiniz. Örneğin, kural tanımınızda bazı değişiklikler yaptığınızda ve çalıştırılan komut satırlarının değişmediğini doğrulamak istediğinizde. Bunun için kullanabileceğiniz araç aquery_differ.

Araç bazelbuild/bazel deposunda mevcuttur. Kullanabilmek 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 sorgu çıkışları arasındaki farkı döndürür: Hangi işlemler diğerinde bulunmayan; hangi işlemlerin her sorgu çıkışında farklı komut satırı/girişleri olur, ...). Yukarıdaki komut çalıştırıldığında sonuç şu şekilde 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 sorgu çı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ı

Yönler'in birbirinin üzerine uygulanması mümkündür. Bu Yönler tarafından oluşturulan işlemin sorgu çıkışı, daha sonra En boy yolu'nu içerir. Bu, işlemi oluşturan hedefe uygulanan Yönler dizisidir.

En Boy Boyuna bir örnek:

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

t_i'yi, bağımlılıklarına bir Aspect a_i uygulayan r_i kuralının hedefi olsun.

a2'nin, t0 hedefine uygulandığında bir X işlemi oluşturduğunu varsayalım. X işlemi için bazel aquery --include_aspects 'deps(//t2)' metin çıktısı şöyle olur:

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

Bu, X eyleminin a1(t0) öğesine uygulanan a2 Boyutu tarafından oluşturulduğu anlamına gelir. Burada a1(t0), t0 hedefine uygulanan a1 Boyutunun sonucudur.

Her AspectDescriptor aşağıdaki biçimdedir:

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

AspectClass, En boy sınıfının adı (yerel Yönler için) veya bzl_file%aspect_name (Starlark Aspects 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

Sorgular, derlemelerde çalıştırılmakta olan işlemler (neden çalıştırıldıkları, girişleri/çıkışları) hakkında bilgi sağlarken JSON profili ise yürütme işlemlerinin zamanlamasını ve süresini bildirir. Bu iki bilgi kümesi, ortak bir paydada (işlemin birincil çıktısı) birleştirilebilir.

İşlemlerin çıkışlarını JSON profiline eklemek için profili --experimental_include_primary_output --noexperimental_slim_json_profile ile oluşturun. İnce profiller, birincil çıkışların eklenmesiyle uyumlu değildir. Bir işlemin birincil çıkışı varsayılan olarak sorgu tarafından dahil edilir.

Şu anda bu 2 veri kaynağını birleştirmek için standart bir araç sağlamıyoruz ancak yukarıdaki bilgilerle kendi komut dosyanızı oluşturabilirsiniz.

Bilinen sorunlar

Paylaşılan işlemleri işleme

Bazen işlemler yapılandırılmış hedefler arasında paylaşılır.

Yürütme aşamasında, bu paylaşılan işlemler basit bir şekilde tek bir işlem olarak kabul edilir ve yalnızca bir kez yürütülür. Bununla birlikte, bir sorgu yürütme öncesi, analiz sonrası işlem grafiği üzerinde çalışır ve bu nedenle bunları, çıkış Yapıları aynı execPath değerine sahip ayrı işlemler olarak ele alır. Sonuç olarak, eşdeğer Yapılar kopyalanmış gibi görünür.

Sorgu sorunlarının/planlanan özelliklerin listesini GitHub'da bulabilirsiniz.

SSS

Giriş dosyasının içeriği değişmiş olsa bile ActionKey aynı kalır.

Sorgu bağlamında ActionKey, ActionAnalysisMetadata#getKey parametresinden alınan String anlamına gelir:

  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.

Giriş dosyalarının içeriğinde yapılan değişiklikler hariç tutulur ve RemoteCacheClient#ActionKey ile karıştırılmaz.

Güncellemeler

Tüm sorunlar veya özellik istekleri için lütfen buradan sorun bildiriminde bulunun.