İşlem Grafiği Sorgusu (sorgu)

Sorun bildir Kaynağı göster

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 bilgi gösterir.

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

Araç, çeşitli komut satırı seçeneklerini kabul eder. Özellikle, sorgu komutu normal bir Bazel derlemesinin üzerinde çalışır ve bir derleme sırasında mevcut olan bir dizi seçeneği devralır.

Geleneksel query için de kullanılabilen ancak siblings, buildfiles ve tests için de kullanılabilen aynı 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 basit bir söz dizimi örneği şu şekildedir:

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

Sorgu ifadesi (tırnak içinde) şunlardan oluşur:

  • aquery_function(...): aquery öğesine özel 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 binasında 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.

Ayrıca, AND 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, anımsatıcıları "Cpp.*" ile, girişleri ise ".*cpp" ve "foo.*" kalıplarıyla eşleşen //src/target_a derlemesinde yer alan tüm işlemleri bulur.

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 bu nedenle derleme sırasında kullanılabilen seçenekler kümesini devralır.

Aquery seçenekleri

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

Varsayılan çıkış biçimi (text) kullanıcılar tarafından okunabilir biçimdedir. 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 (büyük olasılıkla büyük olabilir) içerir.

--include_artifacts, default=true

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

--include_aspects, default=true

Çıkışa En boy oranında oluşturulan işlemlerin eklenip eklenmeyeceğini belirtir.

--include_param_files, default=false

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

--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, file_contents alanına --output=xxxproto ile 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 Action Graph'in dökümünü alın.

Diğer araçlar ve özellikler

Skyframe'in 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 binasından mı oluşturulduğunu öğrenmek istiyorum.

foo.out oluşturmaktan sorumlu işlemi ve dolayısıyla hedefi belirlemek 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 komutu ç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ı tekrar çalıştırmadan bu öğe üzerinde filtreleme yapar ve içeriği çıkarı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, hedefler ne olursa olsun Skyframe'deki tüm işlem grafiğini sorgular. 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 sonuçlarını karşılaştırabilirsiniz. Örneğin, kural tanımınızda bazı değişiklikler yapıp çalıştırılan komut satırlarının değişmediğini doğrulamak istediğinizde. Bunun için aquery_differ aracını kullanabilirsiniz.

Araç bazelbuild/bazel deposunda bulunabilir. 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 birinde varken diğerinde yok? Hangi işlemlerin her bir sorgu çıkışında farklı komut satırı/girişleri vardır, ...). Yukarıdaki komut şu şekilde çalışır:

  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önlerin birbirinin üzerine uygulanması mümkündür. Bu Özellikler tarafından oluşturulan eylemin sorgu çıkışı, işlemi oluşturan hedefe uygulanan Hedef dizisi olan En Boy yolu'nu da içerir.

En Boy Oranı örneği:

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

ti, ri kuralının hedefi olsun. Bu kural, bağımlılıklarına i Aspect uygular.

a2'nin, t0 hedefine uygulandığında X işlemi 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=...)]
  ...

Diğer bir deyişle, X işlemi a1(t0) üzerine uygulanan En Boy a2 tarafından oluşturuldu. Burada a1(t0), t0 hedefine a1 En boy özelliğinin uygulanmasının sonucudur.

Her AspectDescriptor aşağıdaki biçime sahiptir:

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

AspectClass, En boy sınıfının (yerel Özellikler için) veya bzl_file%aspect_name (Starlark Aspects için) adı olabilir. AspectDescriptor, bağımlılık grafiğinin topolojik sırasına göre sıralanır.

JSON profiliyle bağlantı oluşturma

Sorgu, bir derlemede çalıştırılan 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 bize bildirir. Bu 2 bilgi kümesi, ortak bir payda üzerinden birleştirilebilir: işlemin birincil çıktısı.

İşlemlerin çıkışlarını JSON profiline eklemek için profili --experimental_include_primary_output --noslim_profile ile oluşturun. İnce profiller, birincil çıkışların dahil edilmesiyle uyumlu değildir. Bir işlemin birincil çıkışı varsayılan olarak bir sorguya dahil edilir.

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

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. Ancak bir sorgu yürütme öncesi ve analiz sonrası işlem grafiği üzerinde çalışır ve dolayısıyla bunları çıkış Yapıları aynı execPath değerine sahip ayrı işlemler olarak ele alır. Sonuç olarak, eşdeğer Yapılar kopya 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 kaynağından alınan String değerini belirtir:

  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.

Buna, giriş dosyalarının içeriğinde yapılan değişiklikler dahil değildir ve RemoteCacheClient#ActionKey ile karıştırılmamalıdır.

Güncellemeler

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