İşlem Grafiği Sorgusu (sorgu)

Sorun bildirin Kaynağı göster Gece · 7,4 , 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 grafiğinde çalışır ve işlemler, yapı taşları ve bunların ilişkileri hakkında bilgi sağlar.

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 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'a özgü 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))'

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

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

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

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

--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 kullanıldığında çıkış FileWriteContents: [<base64-encoded file contents>] satır

--skyframe_state, default=false

Ek analiz yapmadan Skyframe'dan işlem grafiğini dökü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 durumuna göre sorgu oluşturma

Skyframe, Bazel'in değerlendirme ve artımlı modeldir. 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 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.

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 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 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 ve --output=textproto için kullanılabilir.

Sorgu ifadesine hedef etiketlerin eklenmemesi

Ş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, 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ılan komut satırlarının değişmediğinden emin olmak istediğinizde. aquery_differ bunun için 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 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ş sayısı, ...). 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 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 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ı.

Boyut üzerinde boyut örneği:

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

t_i, bağımlılıklarına bir a_i yönü uygulayan r_i kuralının bir hedefi olsun.

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

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

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

Sorgu bağlamında ActionKey, üzerinden 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.

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

Sorunlar veya özellik talepleri için lütfen buradan sorun kaydı oluşturun.