Performansı Optimize Etme

Kural yazarken, en yaygın performans hatası, bağımlılıklardan toplanan verileri aktarmak veya kopyalamaktır. Derlemenin tamamında toplandığında bu işlemler kolayca O(N^2) zaman veya alan alabilir. Bunun önüne geçmek için alt öğeleri etkili şekilde kullanmayı anlamak çok önemlidir.

Bunun doğru şekilde yapılması zor olabilir. Bu yüzden Bazel, hata yapmış olabileceğiniz noktaları bulmanızda size yardımcı olan bir bellek profili de sağlar. Bu konuda uyaralım: Verimsiz bir kural yazmanın maliyeti, yaygın şekilde kullanılana kadar açık olmayabilir.

Dizüstü bilgisayar kullan

Kural bağımlılıklarından bilgi topladığınızda depsets özelliğini kullanmanız gerekir. Mevcut kurala göre yerel bilgiler yayınlamak için yalnızca düz listeler veya komutlar kullanın.

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

Aşağıdaki grafiği inceleyin:

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

Her düğüm tek bir dize yayınlar. Alt noktalarla veriler şöyle 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. Listeler sayesinde:

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

Bu örnekte 'a' ifadesinden dört kez bahsedildiğini unutmayın. Büyük grafiklerle bu sorun daha da kötüleşir.

Aşağıda, geçişli bilgileri yayınlamak için alt kümeleri doğru şekilde kullanan bir kural uygulaması örneği verilmiştir. İsterseniz, O(N^2) olmadığından kural-yerel bilgilerini listeleri kullanarak yayınlayabilirsiniz.

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 veri kümesine genel bakış sayfasına göz atın.

depset.to_list() numaralı telefonu aramaktan kaçının

to_list() kullanarak desteği düz listeye almaya zorlayabilirsiniz ancak bunu yaptığınızda genellikle O(N^2) maliyeti elde edilir. Mümkünse, hata ayıklama amaçları dışında derinlikleri birleştirmekten kaçının.

Yaygın bir yanılgıya göre, bu işlemi yalnızca üst düzey hedeflerde (ör. <xx>_binary kuralı) yaptığınız takdirde uygulamaları serbest bir şekilde birleştirebilirsiniz. Bunun nedeni, maliyetin derleme grafiğinin her düzeyinde toplanmayacağıdır. Ancak, çakışan bağımlılıkları olan bir hedef grubu oluşturduğunuzda bu sayı hâlâ O(N^2) olur. Bu durum testlerinizi oluştururken //foo/tests/... veya bir IDE projesini içe aktarırken ortaya çıkar.

Arama sayısını azalt: depset

Bir döngü içinde depset işlevinin çağrılması genellikle bir hatadır. Bu durum, çok derin iç içe geçmelere ve dolayısıyla düşük performansa yol açabilir. Örneğin:

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

Bu kod kolayca değiştirilebilir. Öncelikle geçişli kesintileri toplayın ve hepsini aynı anda birleştirin:

transitive = []

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

x = depset(transitive = transitive)

Bu durum bazen liste anlayışını kullanarak 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() yöntemini kullanmanız gerekir. Bu, tüm alt kümelerin yürütme aşamasına genişletilmesini geciktirir.

Bu yöntem, kesinlikle daha hızlı olmanın yanı sıra kurallarınızın bellek tüketimini bazen% 90 veya daha fazla azaltır.

Aşağıda bazı püf noktaları verilmiştir:

  • Derinlikleri ve listeleri kendiniz birleştirmek yerine doğrudan bağımsız değişkenler olarak iletin. Bu öğeler ctx.actions.args() tarafından sizin için genişletilecek. Kaldırılan içerikte herhangi bir dönüşüme ihtiyacınız varsa ctx.actions.args#add ile uyumlu olup olmadığına bakın.

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

  • Dizeleri birbirine bağlayarak oluşturmaktan kaçının. En iyi dize bağımsız değişkeni sabittir, çünkü bu bağımsız değişkenin belleği kuralınızın tüm örnekleri arasında paylaştırılır.

  • Bağımsız değişkenler komut satırı için çok uzunsa ctx.actions.args() nesnesi, ctx.actions.args#use_param_file kullanılarak koşullu veya koşulsuz olarak bir param dosyasına yazılabilir. Bu işlem, eylem gerçekleştirildiğinde perde arkasında yapılır. Parametreleri açık bir şekilde kontrol etmeniz gerekiyorsa dosyayı ctx.actions.write kullanarak manuel olarak yazabilirsiniz.

Ö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şli işlem girişleri deplet olmalıdır

ctx.actions.run kullanarak bir işlem oluştururken inputs alanının bir kaldırma işlemini kabul ettiğini unutmayın. Bağımlılıklardan geçişli olarak giriş toplandığında bunu kullanın.

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 basarak veya Bazel'a SIGQUIT sinyali (kill -3 $(bazel info server_pid)) göndererek $(bazel info output_base)/server/jvm.out dosyasında iş parçacığı dökümü alabilirsiniz.

Bazel asılıysa bazel info öğesini çalıştıramayabilirsiniz. Bu nedenle output_base dizini genellikle çalışma alanı dizininizdeki bazel-<workspace> sembolik bağlantısının üst öğesidir.

Performans profili oluşturma

Bazel varsayılan olarak çıkış tabanındaki command.profile.gz öğesine bir JSON profili yazar. Konumu --profile işaretiyle yapılandırabilirsiniz, örneğin --profile=/tmp/profile.gz. .gz ile biten konumlar GZIP ile sıkıştırılır.

Sonuçları görmek için chrome://tracing uygulamasını bir Chrome tarayıcı sekmesinde açın, "Yükle"yi tıklayın 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ç" modu için 1 tuşuna basın. Bu modda, etkinlik ayrıntılarını incelemek için belirli kutuları seçebilirsiniz (sol alt köşeye bakın). Özet ve toplu istatistikleri almak için birden fazla etkinlik seçin.
  • "Kaydırma" modu için 2 tuşuna basın. Ardından, görünümü taşımak için fareyi sürükleyin. Ayrıca sağa/sola gitmek için a/d kullanabilirsiniz.
  • "Yakınlaştırma" modu için 3 tuşuna basın. Ardından, yakınlaştırmak için fareyi sürükleyin. Ayrıca yakınlaştırmak/uzaklaştırmak için w/s kullanabilirsiniz.
  • İki etkinlik arasındaki mesafeyi ölçebileceğiniz "zamanlama" modu için 4 tuşuna basın.
  • Tüm kontroller hakkında bilgi edinmek için ? tuşlarına 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. Gerçek değeri görmek için üzerini tıklayın. Temiz derlemelerde --jobs değerine kadar yükselmelidir.
  • cpu counters: Derlemenin her saniyesi için Bazel tarafından kullanılan CPU miktarını gösterir (1 değeri, bir çekirdeğin% 100 meşgul olduğu anlamına gelir).
  • Critical Path: Kritik yoldaki her işlem için bir blok görüntüler.
  • grpc-command-1: Bazel'ın ana ileti dizisi. Bazel'ın neler yaptığına ilişkin kuş bakışı bir resim elde etmek için yararlıdır. Örneğin, "Launch Bazel", "assessTargetPatterns" ve "runAnalysisStage".
  • Service Thread: Küçük ve önemli Çöp Toplama (GC) duraklamalarını gösterir.

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

Genel performans sorunları

Performans profillerini analiz ederken şunlara dikkat edin:

  • Özellikle artımlı derlemelerde, beklenenden daha yavaş analiz aşaması (runAnalysisPhase). Bu, kötü bir kural uygulamasının (örneğin, detayı sadeleştiren bir uygulama) göstergesi olabilir. Paketin yüklenmesi aşırı miktarda hedef, karmaşık makrolar veya yinelenen glob'lar nedeniyle yavaş olabilir.
  • Ayrı ayrı yavaş işlemler, özellikle kritik yolda olanlar. Büyük işlemleri birden çok küçük işleme bölmek veya bunları hızlandırmak için (geçişli) bağımlılık grubunu azaltmak mümkün olabilir. PROCESS_TIME olmayan olağandışı bir yüksek değer (REMOTE_SETUP veya FETCH gibi) olup olmadığını da kontrol edin.
  • Performans sorunları, diğer tüm iş parçacığı boştayken / sonucu beklerken az sayıda iş parçacığı meşguldür (yukarıdaki ekran görüntüsünde 15-30 saniye civarında bir süreye bakın). Bunu optimize etmek, muhtemelen daha fazla paralellik yaratmak için kural uygulamalarına veya Bazel'in kendisine dokunmanızı gerektirecektir. Olağan dışı miktarda GC olduğunda da bu durum görülebilir.

Profil dosyası biçimi

Üst düzey nesne, meta verileri (otherData) ve gerçek iz verilerini (traceEvents) içerir. Meta veriler, ekstra bilgiler (örneğin, Bazel çağrısının çağrı kimliği ve tarihi) içerir.

Örnek:

{
  "otherData": {
    "build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
    "date": "Tue Jun 16 08:30:21 CEST 2020",
    "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) mikrosaniye cinsinden verilir. Kategori (cat), ProfilerTask enum değerlerinden biridir. Bazı etkinliklerin çok kısa ve birbirine yakın olması halinde birleştirildiğini unutmayın. Etkinliklerin birleştirilmesini önlemek için --noslim_json_profile değerini iletin.

Chrome İzleme Etkinlik Biçimi Spesifikasyonu'nu da inceleyin.

profili analiz et

Bu profil oluşturma yöntemi iki adımdan oluşur. Öncelikle derleme/testinizi --profile işaretiyle yürütmeniz gerekir. Örneğin,

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

Oluşturulan dosya (bu örnekte /tmp/prof), analyze-profile komutuyla sonradan işlenip analiz edilebilen bir ikili dosyadır:

$ bazel analyze-profile /tmp/prof

Varsayılan olarak, belirtilen profil veri dosyası için özet analiz bilgilerini yazdırır. Her geliştirme aşamasında farklı görev türlerine ait kümülatif istatistikler ve kritik yolun analizi de buna dahildir.

Varsayılan çıkışın ilk bölümü, farklı derleme aşamalarında harcanan zamana genel bir bakıştır:

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 profili oluşturma

Bazel, kuralınızın bellek kullanımını kontrol etmenize yardımcı olabilecek yerleşik bir bellek profil aracı içerir. Sorun varsa bu soruna neden olan tam kod satırını bulmak için yığının dökümünü alabilirsiniz.

Bellek izlemeyi etkinleştirme

Her Bazel çağrısına şu iki başlatma işaretini 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 Bazel çağrısı için bile unutursanız 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 analizi çalıştırmak ve derleme yürütme aşamasını çalıştırmamak için --nobuild işaretini ekleyin.

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

Ardından, tüm Bazel örneğinin ne kadar bellek kullandığını görün:

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

bazel dump --rules kullanarak kural sınıfına göre döküm alı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)

bazel dump --skylark_memory ile bir pprof dosyası oluşturarak belleğin nereye gittiğine bakın:

$ 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. pprof -flame $HOME/prof.gz kullanarak flame grafiği edinmek iyi bir başlangıç noktasıdır.

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

Şu satırlarla not eklenmiş en yeni çağrı sitelerinin 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)