Performansı Optimize Etme

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

Kural yazarken en sık karşılaşılan performans hatası, verileri toplayarak dikkate alınması gerektiğini unutmayın. Bir bütün olarak bu işlemler O(N^2) zaman veya alan alabilir. Bunu önlemek için depletlerin nasıl etkili şekilde kullanılacağının anlaşılması açısından son derece önemlidir.

Bunun sağlanması zor olabildiğinden Bazel aynı zamanda hata yapmış olabileceğiniz noktaları bulmanıza yardımcı olur. Aşağıdaki durumlarda uyar: Verimsiz bir kural yazmanın maliyeti, kural tam olarak yaygın bir şekilde kullanılıyor.

Depset'leri kullanma

Kural bağımlılıklarıyla ilgili bilgileri toplarken depsets belirtin. Bilgi yayınlamak için yalnızca düz listeleri veya diktleri kullanın yerel olarak ayarlayın.

Desset, bilgileri paylaşmaya olanak tanıyan iç içe yerleştirilmiş bir grafik olarak temsil eder.

Aşağıdaki grafiği göz önünde bulundurun:

C -> B -> A
D ---^

Her düğüm tek bir dize yayınlar. Depset'larda veriler aşağıdaki gibi görünür:

a = depset(direct=['a'])
b = depset(direct=['b'], transitive=[a])
c = depset(direct=['c'], transitive=[b])
d = depset(direct=['d'], transitive=[b])

Her öğeden yalnızca bir kez bahsedildiğini unutmayın. Listelerle şunları elde edersiniz:

a = ['a']
b = ['b', 'a']
c = ['c', 'b', 'a']
d = ['d', 'b', 'a']

Bu örnekte 'a' parametresinin dört kez geçtiğine dikkat edin. Daha büyük grafiklerde sorun daha da kötüleşecektir.

Aşağıdaki örnek, verileri doğru şekilde kullanan bir kural uygulaması örneğidir: geçişli bilgiler yayınlayabilirsiniz. Yerel kural yayınlamanın kabul edilebilir olduğunu unutmayın isterseniz listeleri kullanabilirsiniz, çünkü bu O(N^2) değildir.

MyProvider = provider()

def _impl(ctx):
  my_things = ctx.attr.things
  all_things = depset(
      direct=my_things,
      transitive=[dep[MyProvider].all_things for dep in ctx.attr.deps]
  )
  ...
  return [MyProvider(
    my_things=my_things,  # OK, a flat list of rule-local things only
    all_things=all_things,  # OK, a depset containing dependencies
  )]

Daha fazla bilgi için cihaza genel bakış sayfasını ziyaret edin.

depset.to_list() adlı kişiyi aramaktan kaçının

Bir geliştirmeyi düz listeye dönüştürmek için to_list(). Ancak bu genellikle O(N^2) ile sonuçlanır maliyet. Mümkünse hata ayıklama dışında hataları düzeltmekten kaçının amaçlar.

Yaygın bir yanlış inanış, sadece bir şey yaparak duyguları özgürce düzeltebileceğinizdir. <xx>_binary kuralı gibi üst düzey hedeflere uygulanır. Çünkü bu durumda maliyet, seviye boyunca toplanan verileri gösterir. Ancak bu, sorun yaşanırken hâlâ O(N^2) bağımlılıkları çakışan bir dizi hedef oluşturursunuz. Bu, testlerinizi oluştururken //foo/tests/... veya bir IDE projesini içe aktarırken.

Arama sayısını depset olacak şekilde azaltın

depset işlevinin bir döngü içinde çağrılması genellikle hatadır. Potansiyel riskler nedeniyle iç içe geçmiş olabilir. Bu da kötü performans gösterir. Örneğin:

x = depset()
for i in inputs:
    # Do not do that.
    x = depset(transitive = [x, i.deps])

Bu kod kolayca değiştirilebilir. İlk olarak, geçişli verileri toplayın ve hepsini aynı anda birleştirmek için:

transitive = []

for i in inputs:
    transitive.append(i.deps)

x = depset(transitive = transitive)

Bu bazen liste anlama özellikleri kullanılarak azaltılabilir:

x = depset(transitive = [i.deps for i in inputs])

Komut satırları için ctx.actions.args() kullanma

Komut satırları oluştururken ctx.actions.args() kullanmanız gerekir. Böylece, her türlü detayın yürütme aşamasına genişletilmesine gerek kalmaz.

Bu yöntem, kesinlikle daha hızlı olmanın yanı sıra oranında bir artış sağlayabilir.

İşte bazı püf noktaları:

  • Depset'leri ve listeleri birleştirmek yerine doğrudan bağımsız değişken olarak iletin kendiniz. Sizin için ctx.actions.args() genişletilecek. Kaldırılmış içeriklerde herhangi bir dönüşüme ihtiyacınız olursa ctx.actions.args#add adresini ziyaret edin.

  • File#path öğesini bağımsız değişken olarak iletiyor musunuz? Gerek yok. Herhangi biri Dosya otomatik olarak path, genişletme süresine ertelenmiş.

  • Dizeleri bir araya getirerek oluşturmaktan kaçının. En iyi dize bağımsız değişkeni sabittir, çünkü belleği tüm örneklerini etkiler.

  • Bağımsız değişkenler komut satırı için çok uzunsa ctx.actions.args() nesnesi Parametre değeri, ctx.actions.args#use_param_file Bu sahne arkasında yapılır. Rapor oluşturma işlemini açıkça parametre dosyasını kullanarak manuel bir şekilde yazabileceğiniz ctx.actions.write.

Örnek:

def _impl(ctx):
  ...
  args = ctx.actions.args()
  file = ctx.declare_file(...)
  files = depset(...)

  # Bad, constructs a full string "--foo=<file path>" for each rule instance
  args.add("--foo=" + file.path)

  # Good, shares "--foo" among all rule instances, and defers file.path to later
  # It will however pass ["--foo", <file path>] to the action command line,
  # instead of ["--foo=<file_path>"]
  args.add("--foo", file)

  # Use format if you prefer ["--foo=<file path>"] to ["--foo", <file path>]
  args.add(format="--foo=%s", value=file)

  # Bad, makes a giant string of a whole depset
  args.add(" ".join(["-I%s" % file.short_path for file in files])

  # Good, only stores a reference to the depset
  args.add_all(files, format_each="-I%s", map_each=_to_short_path)

# Function passed to map_each above
def _to_short_path(f):
  return f.short_path

Geçiş işlemi girişleri, depsets olmalıdır

ctx.actions.run işlevini kullanarak bir işlem oluştururken inputs alanının eksik öğeleri kabul ettiğini unutmayın. Bu seçeneği, geçişli olarak toplanır.

inputs = depset(...)
ctx.actions.run(
  inputs = inputs,  # Do *not* turn inputs into a list
  ...
)

Askılı

Bazel asılı görünüyorsa Ctrl-\ tuşlarına basabilir veya Bazel'i İleti dizisi almak için bir SIGQUIT sinyali (kill -3 $(bazel info server_pid)) oluşturun $(bazel info output_base)/server/jvm.out dosyasının dökümünü alın.

Bazel takılıysa bazel info aracını çalıştıramayabilirsiniz. output_base dizini genellikle bazel-<workspace> öğesinin üst öğesidir sembolik bağlantıyı kullanabilirsiniz.

Performans profili oluşturma

Bazel, çıkış tabanında command.profile.gz öğesine bir JSON profili yazar. varsayılandır. Konumu --profile işaretini kullanın: --profile=/tmp/profile.gz. .gz ile biten konumlar şununla sıkıştırılır: GZIP'e dokunun.

Sonuçları görmek için chrome://tracing sayfasını bir Chrome tarayıcı sekmesinde açın, şunu tıklayın: "Yükle" ve (potansiyel olarak sıkıştırılmış) profil dosyasını seçin. Daha ayrıntılı sonuçları için sol alt köşedeki kutuları tıklayın.

Gezinmek için şu klavye denetimlerini kullanabilirsiniz:

  • "Seç" için 1 tuşlarına basın yatırım yapmanız önemlidir. Bu modda, tıklayın (sol alt köşeye bakın). Özet ve toplu istatistikler almak için birden fazla etkinlik seçin.
  • "Kaydır" için 2 tuşlarına basın yatırım yapmanız önemlidir. Ardından görünümü hareket ettirmek için fareyi sürükleyin. Siz sağa/sola gitmek için a/d tuşlarını da kullanabilirsiniz.
  • "Yakınlaştırma" için 3 tuşlarına basın yatırım yapmanız önemlidir. Ardından, yakınlaştırmak için fareyi sürükleyin. Şunları yapabilirsiniz: yakınlaştırmak/uzaklaştırmak için w/s tuşlarını da kullanın.
  • "Zamanlama" için 4 tuşlarına basın Mesafeyi ölçebileceğiniz bir mod iki etkinlik vardır.
  • Tüm kontroller hakkında bilgi edinmek için ? tuşuna basın.

Profil bilgileri

Örnek profil:

Örnek profil

Şekil 1. Örnek profil.

Bazı özel satırlar vardır:

  • action counters: Yayında olan eşzamanlı işlem sayısını gösterir. Sonraki slayta geçin tıklayın. Şu para birimi cinsinden --jobs değerine kadar olmalı: ele alacağız.
  • cpu counters: Derlemenin her saniyesi için CPU miktarını gösterir (1 değeri, bir çekirdeğin% 100 meşgul olduğunu gösterir).
  • Critical Path: Kritik yoldaki her işlem için bir blok görüntüler.
  • grpc-command-1: Bazel'in ana ileti dizisi. Müşteriyi genel hatlarıyla tanımanıza yardımcı olur. Örneğin, "Launch Bazel", "assessTargetPatterns", ve "runAnalysisPhase" gibi.
  • Service Thread: Küçük ve önemli Çöp Toplama (GC) duraklatmalarını gösterir.

Diğer satırlar Bazel ileti dizilerini temsil eder ve bu ileti dizisindeki tüm etkinlikleri gösterir.

Sık karşılaşılan performans sorunları

Performans profillerini analiz ederken şunlara dikkat edin:

  • Beklenenden daha yavaş analiz aşaması (runAnalysisPhase), özellikle iyi bir fırsattır. Bu durum, normal koşullarda tek bir örnek verelim. Paketin yüklenmesi aşırı miktarda hedef, karmaşık makrolar veya özyinelemeli glob'lar.
  • Bağımsız yavaş işlemler, özellikle de kritik yoldakiler. Projenin küçük işlemleri birden fazla küçük işleme bölmek veya bir dizi (geçişli) bağımlılıktan oluşur. Ayrıca, olağandışı bir PROCESS_TIME olmayan yüksek değer (REMOTE_SETUP veya FETCH gibi).
  • Performans sorunları; az sayıda ileti dizisi meşgulken diğer tüm ileti dizileri boşta kalma / sonuç bekleniyor (yukarıdaki ekran görüntüsünde yaklaşık 15-30 saniyeye bakın). Bunu optimize etmek için büyük olasılıkla kural uygulamalarına dokunmak gerekecektir. veya Bazel'in kendisini tanıtacağını düşünüyor. Bu durum, olağanüstü miktarda GC var.

Profil dosya biçimi

Üst düzey nesne, meta verileri (otherData) ve gerçek izleme verilerini içerir (traceEvents). Meta veri, çağrı kimliği gibi ek bilgiler içerir ve Bazel çağrı tarihini belirtin.

Örnek:

{
  "otherData": {
    "build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
    "date": "Tue Jun 16 08:30:21 CEST 2020",
    "profile_finish_ts": "1677666095162000",
    "output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
  },
  "traceEvents": [
    {"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
    {"cat":"build phase marker","name":"Launch Bazel","ph":"X","ts":-1824000,"dur":1824000,"pid":1,"tid":60},
    ...
    {"cat":"general information","name":"NoSpawnCacheModule.beforeCommand","ph":"X","ts":116461,"dur":419,"pid":1,"tid":60},
    ...
    {"cat":"package creation","name":"src","ph":"X","ts":279844,"dur":15479,"pid":1,"tid":838},
    ...
    {"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Service Thread"}},
    {"cat":"gc notification","name":"minor GC","ph":"X","ts":334626,"dur":13000,"pid":1,"tid":11},

    ...
    {"cat":"action processing","name":"Compiling third_party/grpc/src/core/lib/transport/status_conversion.cc","ph":"X","ts":12630845,"dur":136644,"pid":1,"tid":1546}
 ]
}

İzleme etkinliklerindeki zaman damgaları (ts) ve süreler (dur) mikrosaniyedir. Kategori (cat), ProfilerTask enum değerlerinden biri. Çok kısa ve çok yakın olan bazı etkinliklerin birleştirildiğini unutmayın. birbiri ile; aşağıdaki işlemleri yapabilirsiniz: --noslim_json_profile engelleyebilirsiniz.

Ayrıca bkz. Chrome İzleme Etkinlik Biçimi Spesifikasyonu.

analyze-profile

Bu profil oluşturma yöntemi iki adımdan oluşur: İlk olarak --profile işaretiyle derleme/test etme gibi

$ bazel build --profile=/tmp/prof //path/to:target

Oluşturulan dosya (bu örnekte /tmp/prof), analyze-profile komutuyla son işlenip analiz edilir:

$ bazel analyze-profile /tmp/prof

Varsayılan olarak, belirtilen profilin özet analiz bilgilerini yazdırır veri dosyası olarak kaydeder. Bu, her biri için farklı görev türlerine ilişkin kümülatif istatistikleri içerir kritik yolun analizini yapmak.

Varsayılan çıkışın ilk bölümü, harcanan süreye genel bir bakıştır. farklı aşamalarında ele alacağız:

INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0

=== PHASE SUMMARY INFORMATION ===

Total launch phase time         1.070 s   12.95%
Total init phase time           0.299 s    3.62%
Total loading phase time        0.878 s   10.64%
Total analysis phase time       1.319 s   15.98%
Total preparation phase time    0.047 s    0.57%
Total execution phase time      4.629 s   56.05%
Total finish phase time         0.014 s    0.18%
------------------------------------------------
Total run time                  8.260 s  100.00%

Critical path (4.245 s):
       Time Percentage   Description
    8.85 ms    0.21%   _Ccompiler_Udeps for @local_config_cc// compiler_deps
    3.839 s   90.44%   action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
     270 ms    6.36%   action 'Linking external/com_google_protobuf/protoc [for host]'
    0.25 ms    0.01%   runfiles for @com_google_protobuf// protoc
     126 ms    2.97%   action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
    0.96 ms    0.02%   runfiles for //tools/aquery_differ aquery_differ

Bellek kullanımının profilini çıkarma

Bazel, kuralınızın özelliklerini kontrol etmenize yardımcı olabilecek yerleşik bir bellek profil oluşturucusuyla birlikte gelir. bazı işaretler vardır. Bir sorun olursa soruna neden olan kod satırını kullanın.

Bellek izlemeyi etkinleştirme

Şu iki başlangıç işaretini her Bazel çağrısına iletmeniz gerekir:

  STARTUP_FLAGS=\
  --host_jvm_args=-javaagent:$(BAZEL)/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
  --host_jvm_args=-DRULE_MEMORY_TRACKER=1

Bunlar sunucuyu bellek izleme modunda başlatır. Bunları bir süre sonra unutsanız bile sunucu yeniden başlatılır ve baştan başlamanız gerekir.

Bellek İzleyici'yi kullanma

Örnek olarak, foo hedefine bakın ve ne işe yaradığını görün. Yalnızca alıcı çalıştırma aşamasını çalıştırmadan analizi çalıştırıyorsanız --nobuild işareti.

$ bazel $(STARTUP_FLAGS) build --nobuild //foo:foo

Daha sonra, tüm Bazel örneğinin tükettiği bellek miktarına bakın:

$ bazel $(STARTUP_FLAGS) info used-heap-size-after-gc
> 2594MB

bazel dump --rules kullanarak veri miktarını kural sınıfına göre bölün:

$ bazel $(STARTUP_FLAGS) dump --rules
>

RULE                                 COUNT     ACTIONS          BYTES         EACH
genrule                             33,762      33,801    291,538,824        8,635
config_setting                      25,374           0     24,897,336          981
filegroup                           25,369      25,369     97,496,272        3,843
cc_library                           5,372      73,235    182,214,456       33,919
proto_library                        4,140     110,409    186,776,864       45,115
android_library                      2,621      36,921    218,504,848       83,366
java_library                         2,371      12,459     38,841,000       16,381
_gen_source                            719       2,157      9,195,312       12,789
_check_proto_library_deps              719         668      1,835,288        2,552
... (more output)

Bir pprof dosyası oluşturarak belleğin nereye gittiğine bakın bazel dump --skylark_memory kullanılarak:

$ bazel $(STARTUP_FLAGS) dump --skylark_memory=$HOME/prof.gz
> Dumping Starlark heap to: /usr/local/google/home/$USER/prof.gz

Yığını incelemek için pprof aracını kullanın. İyi bir başlangıç noktası pprof -flame $HOME/prof.gz kullanarak flame grafiği alınıyor.

pprof uygulamasını https://github.com/google/pprof adresinden indirebilirsiniz.

En popüler telefon araması sitelerinin satırlarla ek açıklamalı metin dökümünü alın:

$ pprof -text -lines $HOME/prof.gz
>
      flat  flat%   sum%        cum   cum%
  146.11MB 19.64% 19.64%   146.11MB 19.64%  android_library <native>:-1
  113.02MB 15.19% 34.83%   113.02MB 15.19%  genrule <native>:-1
   74.11MB  9.96% 44.80%    74.11MB  9.96%  glob <native>:-1
   55.98MB  7.53% 52.32%    55.98MB  7.53%  filegroup <native>:-1
   53.44MB  7.18% 59.51%    53.44MB  7.18%  sh_test <native>:-1
   26.55MB  3.57% 63.07%    26.55MB  3.57%  _generate_foo_files /foo/tc/tc.bzl:491
   26.01MB  3.50% 66.57%    26.01MB  3.50%  _build_foo_impl /foo/build_test.bzl:78
   22.01MB  2.96% 69.53%    22.01MB  2.96%  _build_foo_impl /foo/build_test.bzl:73
   ... (more output)