İşlem Grafiği Sorgusu (sorgu)

. Sorun bildirin Kaynağı göster Gece · 7,3 · 7,2 · 7,1 · 7,0 · 6,5

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 hakkında bilgi.

aquery, İşlemlerin/Yapıların özellikleriyle ilgileniyorsanız kullanışlıdır oluşturulan hedef grafiğidir. Örneğin, gerçek komutlar ve giriş/çıktıları/hatırlamaları.

Araç, çeşitli komut satırı seçeneklerini kabul eder. Ayrıca, aquery komutu normal bir Bazel derlemesinin üzerinde çalışır ve sunulan seçeneklerdir.

Geleneksel programlama araçlarında da bulunan query ancak siblings, buildfiles ve tests.

Ö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))"

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

• aquery_function(...): aquery öğesine özel işlevler. Daha ayrıntılı bilgiyi aşağıda bulabilirsiniz.
• function(...): standart işlevler geleneksel query ile aynıdır.
• //target, ilgilenen hedefin etiketi.

# 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))'

Aquery işlevlerini kullanma

Üç aquery işlevi vardır:

• inputs: İşlemleri girişlere göre filtreleyin.
• outputs: İşlemleri çıkışlara göre filtrele
• mnemonic: işlemleri hatırlatıcıya göre filtrele

expr ::= inputs(word, expr)

inputs operatörü, expr yapısından oluşturulan işlemleri döndürür. giriş dosya adları word tarafından sağlanan normal ifadeyle eşleşen.

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

outputs ve mnemonic işlevleri benzer bir söz dizimi paylaşır.

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şturmak için kullanılan tüm işlemleri bulur. Hafızaları "Cpp.*" ile eşleşen, girişleri kalıplarla eşleşen ".*cpp" ve "foo.*".

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

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 yapısının üzerinde çalışır ve böylece seçenekler kullanılabilir.

Sorgu seçenekleri

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

Varsayılan çıkış biçimi (text) okunabilir. 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

En boy oranı tarafından oluşturulan işlemlerin çıkışa dahil edilip edilmeyeceğini belirler.

--include_param_files, default=false

Komutta kullanılan param dosyalarının içeriğini dahil et (büyük olabilir).

Uyarı: Bu bayrağı etkinleştirdiğinizde --include_commandline işareti otomatik olarak etkinleştirilir.

--include_file_write_contents, default=false

actions.write() işlemi için dosya içeriklerini ve SourceSymlinkManifest işlemi için manifest dosyası Dosya içeriği: file_contents alanında --output=xxxproto ile döndürüldü. --output=text kullanıldığında çıkış FileWriteContents: [<base64-encoded file contents>] satır

--skyframe_state, default=false

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

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

Diğer araçlar ve özellikler

Skyframe'in durumuna göre sorgulama

Skyframe, planlama sürecinin artımlılık modeli kullanıyor. Skyframe, Bazel sunucusunun her bir örneğinde bağımlılık grafiğini ; Analiz aşamasında yapılan önceki çalıştırmalardan oluşturulur.

Bazı durumlarda, Skyframe'de Eylem Grafiği'ni sorgulamak yararlıdır. Örnek kullanım alanı şu şekildedir:

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 adlı binanın binanın içinden üretilip oluşturulmadığını öğrenmek istiyorum //target_a veya //target_b.

Bir çalışan bazel aquery 'outputs("foo.out", //target_a)' ve Sorumlu işlemi belirlemek için bazel aquery 'outputs("foo.out", //target_b)' foo.out için hedef değer. Ancak, alacağınız farklı Önceden oluşturulmuş hedeflerin sayısı 2'den büyük olabilir. Bu da birden fazla aquery çalıştırılmasına neden olur. karmaşık bir sürece neden olabilir.

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, İşlem Grafiği'nin içeriğini alır Skyframe'i Bazel örneğinde tuttuğundan, (isteğe bağlı olarak) bunun üzerinde filtreleme yapar ve analiz aşamasını tekrarlamadan içeriğin çıkışını sağlar.

Dikkat edilmesi gereken noktalar

Çıkış biçimi

--skyframe_state şu anda yalnızca --output=proto ile kullanılabilir ve --output=textproto

Sorgu ifadesine hedef etiketlerin eklenmemesi

--skyframe_state şu anda Skyframe'deki tüm işlem grafiğini sorguluyor en iyi uygulamaları paylaşacağız. Sorguda hedef etiketin --skyframe_state, 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ı değişmedi. aquery_differ bunun için araçtır.

Bu 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 ile after sorgu çıkışları arasındaki farkı döndürür: hangi işlemlerin birinde bulunuyor, diğerinde bulunmuyorsa, hangi işlemlerin farklı komut satırı/girişler, ...). Yukarıdaki komut çalıştırıldığında şöyle bir sonuç elde edilir:

  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şin biçimi dosyası olarak da kaydedebilir. proto ve textproto sorgu çıkışı için destek sağlanır.

--attrs=(cmdline|inputs), default=cmdline: işlemlerin özellikleri bahsedeceğim.

En-Boy

Yönler birlikte kullanılması gerekir. Veri analisti tarafından oluşturulan işlemin sorgu çıkışı Bu Aspectler, öğelerin en boy oranını oluşturan En boy yolu İşlemi oluşturan hedefe uygulanan en boy oranları.

En Boy Oranı örneği:

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

t_i r_i kuralının hedefi olsun. Bu kural için A_i ve bağımlılıklarını fark edebilirsiniz.

a2'nin, t0 hedefine uygulandığında X eylemi oluşturduğunu varsayalım. Metin çıkışı X işlemi için bazel aquery --include_aspects 'deps(//t2)' şöyle 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 modele uygulanan Aspect a2 tarafından oluşturulduğu anlamına gelir. a1(t0), burada a1(t0), uygulanan a1 işlevinin sonucudur. t0 hedefine gidin.

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

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

AspectClass, Aspect sınıfının (yerel Aspects için) adı olabilir veya bzl_file%aspect_name (Starlark Aspects için). AspectDescriptor topolojik sıraya göre sıralanır bağımlılık grafiği.

JSON profiliyle bağlantı oluşturma

Sorgu, derlemede çalıştırılmakta olan işlemler (neden çalıştırıldıkları) hakkında bilgi sağlar. JSON profili gibi yürütmenin zamanlamasını ve süresini gösterir. Bu iki bilgi kümesini, bir ortak payda üzerinden, yani işlemin birincil çıkışıyla birleştirmek mümkündür.

İşlemleri dahil etmek için JSON profilinde çıkışlara yer verirseniz profili --experimental_include_primary_output --noexperimental_slim_json_profile İnce profiller, birincil çıkışların dahil edilmesiyle uyumlu değildir. Bir işlemin birincil çıkışı dahil edilir.

Şu anda bu 2 veri kaynağını birleştirmek için standart bir araç sunmuyoruz, ancak kendi komut dosyanızı oluşturabileceğinizi lütfen unutmayın.

Bilinen sorunlar

Paylaşılan işlemleri işleme

Bazı eylemler, paylaşıldı kontrol eder.

Yürütme aşamasında bu paylaşılan işlemler bir olarak kabul edilir ve yalnızca bir kez yürütülür. Ancak sorgu, yürütme öncesi, analiz sonrası eylem grafiği üzerinde çalışır ve dolayısıyla bu işlemleri Örneğin, çıkış yapılarında tam olarak aynı execPath bulunan ayrı işlemler gibi. Sonuç olarak, eşdeğer Yapılar kopya olarak görünüyor.

Sorgu sorunlarının/planlanan özelliklerin listesini şu adreste bulabilirsiniz: GitHub'a gidin.

SSS

Bir giriş dosyasının içeriği değişse bile ActionKey aynı kalır.

Sorgu bağlamında ActionKey, bir sorgudan alınan String anlamına gelir. 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.

Bu, giriş dosyalarının içeriğinde yapılan değişiklikleri hariç tutar ve RemoteCacheClient#ActionKey

Güncellemeler

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