İşlem Grafiği Sorgusu (sorgu)

Sorun bildirme Kaynağı görüntüleme Nightly · 8.0 . 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

aquery komutu, derleme grafiğinizde işlemler için sorgu göndermenize olanak tanır. Analiz sonrası yapılandırılmış hedef grafiğinde çalışır ve işlemler, yapı taşları ve bunların ilişkileri hakkında bilgi sağlar.

aquery, yapılandırılmış hedef grafiğinden oluşturulan işlemler/yapıların özellikleriyle ilgilendiğinizde kullanışlıdır. Örneğin, çalıştırılan gerçek komutlar ve bunların girişleri/çıktıları/hatırlatı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 aynı işlev grubunu 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özdiziminin basit bir örneği aşağıda verilmiştir:

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

Sorgu ifadesi (tırnak içinde) aşağıdakilerden oluşur:

  • aquery_function(...): aquery'a özgü işlevler. Daha fazla bilgiyi aşağıda bulabilirsiniz.
  • function(...): Standart functions, geleneksel query gibi çalışır.
  • //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: işlemleri çıkışlara göre filtreleme
  • mnemonic: 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 fonksiyonları da 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ı ö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 seçenekleri 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

Çıktıya işlem komut satırlarının içeriğini (muhtemelen büyük) ekler.

--include_artifacts, default=true

Çıktıda işlem girişlerinin ve çıkışlarının adlarını içerir (potansiyel olarak büyüktür).

--include_aspects, default=true

Özellik 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 ekleyin (muhtemelen büyüktür).

--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ı

--skyframe_state, default=false

Ek analiz yapmadan Skyframe'dan işlem grafiğini dökün.

Diğer araçlar ve özellikler

Skyframe'ın durumuna göre sorgu oluşturma

Skyframe, Bazel'in değerlendirme ve artımlı modeldir. 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'da işlem grafiğini sorgulamak yararlı olabilir. Örnek bir kullanım alanı:

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

Bazel kullanıcısı olarak, foo.out'in //target_a mi yoksa //target_b mi oluşturulduğunu belirlemek istiyorum.

foo.out'yi ve dolayısıyla hedefi oluşturmaktan sorumlu işlemi bulmak için bazel aquery 'outputs("foo.out", //target_a)' ve bazel aquery 'outputs("foo.out", //target_b)' çalıştırılabilir. Ancak daha önce oluşturulan farklı hedeflerin sayısı 2'den fazla olabilir. Bu da birden fazla aquerykomut çalıştırmayı zorlaştırır.

Alternatif olarak --skyframe_state işareti de 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 için 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 etiketinin --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ı aquery ç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ılan komut satırlarının değişmediğinden emin olmak istediğinizde. aquery_differ bu konuda kullanabileceğiniz araçtır.

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 aquery çı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ı

Aspektlerin birbirinin üzerine uygulanması mümkündür. Bu özelliklerin oluşturduğu işlemin aquery çıkışı, işlemi oluşturan hedefe uygulanan özelliklerin sırası olan özellik yolunu içerir.

Boyut üzerinde boyut örneği:

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

ti, bağımlılıklarına bir ai yönü uygulayan ri kuralının bir hedefi olsun.

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=...)]
  ...

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ğlılık grafiğinin topolojik sırasına göre sıralanır.

JSON profiliyle bağlantı oluşturma

aquery, bir derlemede çalıştırılan işlemler (neden çalıştırıldığı, girişleri/çıktıları) hakkında bilgi sağlarken JSON profili, bu işlemlerin zamanlamasını ve süresini bize bildirir. Bu 2 bilgi grubunu ortak bir payda üzerinden birleştirmek mümkündür: bir işlemin birincil çıkışı.

İş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ışı, varsayılan olarak bir sorgu tarafından dahil edilir.

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

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 aquery, yürütme öncesi ve analiz sonrası işlem grafiğinde çalışır ve bu nedenle bunları, çıkış yapılarının tam olarak aynı execPath değerine sahip olduğu ayrı işlemler gibi 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.

aquery bağlamında ActionKey, ActionAnalysisMetadata#getKey işlevinden alınan String değerini 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.

Giriş dosyalarının içeriğinde yapılan değişiklikler bu kapsamda değildir ve RemoteCacheClient#ActionKey ile karıştırılmamalıdır.

Güncellemeler

Herhangi bir sorun veya özellik talebi için lütfen buradan sorun kaydı oluşturun.