Kural yazarken en yaygın performans sorunu, bağımlılıklardan toplanan verileri farklı şekillerde incelemek veya kopyalamaktır. Bu işlemler, derleme işleminin tamamında toplandığında kolayca O(N^2) zaman veya alan alabilir. Bu sorunu önlemek için depo setlerini etkili bir şekilde nasıl kullanacağınızı anlamanız çok önemlidir.
Bunu tutturmak zor olabiliyor. Bu nedenle Bazel, hata yapmış olabileceğiniz noktaları bulmanıza yardımcı olan bir bellek profil aracı da sağlıyor. Uyarılı olun: Verimsiz bir kural yazmanın maliyeti, yaygın kullanıma sunulana kadar belli olmayabilir.
Depo kümelerini kullanma
Kural bağımlılıkları kapsamındaki bilgileri toplarken depsets değerini kullanmanız gerekir. Mevcut kurala özgü bilgileri yayınlamak için yalnızca düz listeler veya sözlükler kullanın.
Depo grubu, bilgileri paylaşımı sağlayan iç içe yerleştirilmiş bir grafik olarak temsil eder.
Aşağıdaki grafiği inceleyin:
C -> B -> A
D ---^
Her düğüm tek bir dize yayınlar. Veriler, veri kümeleriyle şu şekilde 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 şunları yapabilirsiniz:
a = ['a']
b = ['b', 'a']
c = ['c', 'b', 'a']
d = ['d', 'b', 'a']
Bu örnekte 'a' dört kez kullanılmıştır. Grafikler büyükse bu sorun
daha da kötüleşir.
Aşağıda, geçişli bilgileri yayınlamak için depset'leri doğru şekilde kullanan bir kural uygulaması örneği verilmiştir. O(N^2) olmadığından, kurala özgü bilgileri listeleri kullanarak yayınlamanın uygun olduğunu unutmayın.
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() numarasını aramaktan kaçının
to_list() kullanarak bir depset'i düz bir listeye zorlayabilirsiniz ancak bu işlem genellikle O(N^2) maliyetle sonuçlanır. Mümkünse hata ayıklama amaçları dışında, hataları düzleştirmekten kaçının.
Yaygın bir yanlış anlama, yalnızca <xx>_binary kuralı gibi üst düzey hedeflerde yaparsanız maliyet, derleme grafiğinin her düzeyinde toplanmadığı için depsetleri istediğiniz gibi düzleştirebileceğinizdir. Ancak çakışan bağımlılıklara sahip bir hedef kümesi oluşturduğunuzda bu durum hâlâ O(N^2) olacaktır. Bu durum, testlerinizi //foo/tests/... oluştururken veya bir IDE projesini içe aktarırken ortaya çıkar.
Arama sayısını depset'e düşürme
depset işlevinin bir döngü içinde çağrılması genellikle hatalıdır. Bu, çok derin iç içe yerleştirilmiş ve kötü performans gösteren depsetlere 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. İlk olarak, geçişli verileri toplayın ve hepsini aynı anda birleştirin:
transitive = []
for i in inputs:
transitive.append(i.deps)
x = depset(transitive = transitive)
Bu, bazen liste kapsamı kullanılarak azaltılabilir:
x = depset(transitive = [i.deps for i in inputs])
Komut satırı için ctx.actions.args() işlevini kullanma
Komut satırları oluştururken ctx.actions.args() işlevini kullanmanız gerekir. Bu, tüm depsetlerin genişletilmesini yürütme aşamasına erteler.
Bu, kesinlikle daha hızlı olmanın yanı sıra kurallarınızın hafıza tüketimini bazen% 90 veya daha fazla azaltır.
İşte bazı püf noktaları:
Depset'leri ve listeleri kendiniz birleştirmek yerine doğrudan bağımsız değişken olarak iletin. Bu veriler sizin için
ctx.actions.args()tarafından genişletilecektir. Depset içeriklerinde dönüştürme yapmanız gerekiyorsa ctx.actions.args#add değerine bakarak ihtiyacınız olan öğeyi bulun.File#pathöğesini bağımsız değişken olarak iletiyor musunuz? Gerek yok. Tüm dosyalar, otomatik olarak yoluna dönüştürülür ve genişletme zamanına ertelenir.Dizeleri bir araya getirerek oluşturmaktan kaçının. En iyi dize bağımsız değişkeni, belleği kuralınızın tüm örnekleri arasında paylaşılacağı için sabit bir değerdir.
args, komut satırı için çok uzunsa
ctx.actions.args()nesnesi,ctx.actions.args#use_param_filekullanılarak koşullu veya koşulsuz olarak bir parametre dosyasına yazılabilir. Bu işlem, işlem yürütüldüğünde arka planda yapılır. Params dosyasını açıkça kontrol etmeniz gerekiyorsactx.actions.writekullanarak 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 depset olmalıdır
ctx.actions.run yöntemini kullanarak bir işlem oluştururken inputs alanının depset'i kabul ettiğini unutmayın. Girişler bağımlılıklardan geçişli olarak toplandığında bunu kullanın.
inputs = depset(...)
ctx.actions.run(
inputs = inputs, # Do *not* turn inputs into a list
...
)
Asılı
Bazel donmuş görünüyorsa $(bazel info output_base)/server/jvm.out dosyasına bir iş parçacığı dökümü almak için Ctrl-\ tuşlarına basabilir veya Bazel'e bir SIGQUIT sinyali (kill -3 $(bazel info server_pid)) gönderebilirsiniz.
Bazel askıya alınırsa bazel info öğesini çalıştıramayabilirsiniz. Bu nedenle output_base dizini genellikle Workspace dizininizdeki bazel-<workspace> sembol bağlantısının üst öğesidir.
Performans profili çıkarma
Bazel, varsayılan olarak çıkış tabanında command.profile.gz dosyasına bir JSON profili yazar. Konumu --profile işaretiyle yapılandırabilirsiniz (ör. --profile=/tmp/profile.gz). .gz ile biten konumlar GZIP ile sıkıştırılır.
Sonuçları görmek için bir Chrome Tarayıcı sekmesinde chrome://tracing'ü açın, "Yükle"yi tıklayın ve (sıkıştırılmış olabilecek) 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 kontrollerini kullanabilirsiniz:
- "Seç" modu için
1tuş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 istatistikler almak için birden fazla etkinlik seçin. - "Kaydırma" modu için
2tuşuna basın. Ardından, görünümü taşımak için fareyi sürükleyin. Sol/sağ gitmek içina/dtuşlarını da kullanabilirsiniz. - "Yakınlaştırma" modu için
3tuşuna basın. Ardından, yakınlaştırmak için fareyi sürükleyin. Yakınlaştırmak/uzaklaştırmak içinw/stuşlarını da kullanabilirsiniz. - İki etkinlik arasındaki mesafeyi ölçebileceğiniz "zamanlama" modu için
4tuşuna basın. - Tüm kontroller hakkında bilgi edinmek için
?düğmesine basın.
Profil bilgileri
Örnek profil:
Şekil 1. Örnek profil.
Bazı özel satırlar vardır:
action counters: Devam eden eşzamanlı işlem sayısını gösterir. Gerçek değeri görmek için tıklayın. Temiz derlemelerde--jobsdeğerine kadar çıkmalıdır.cpu counters: Derlemenin her bir saniyesinde 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'in ana ileti dizisi. Bazel'in ne yaptığının üst düzey bir resmini elde etmek için yararlıdır (ör. "Bazel'i başlat", "evaluateTargetPatterns" ve "runAnalysisPhase").Service Thread: Küçük ve büyük Çöp Toplama (GC) duraklamaları gösterilir.
Diğer satırlar Bazel mesaj dizilerini temsil eder ve ilgili mesaj dizisindeki tüm etkinlikleri gösterir.
Sık karşılaşılan performans sorunları
Performans profillerini analiz ederken şunları arayın:
- Özellikle artımlı derlemelerde analiz aşaması (
runAnalysisPhase) beklenenden daha yavaştır. Bu durum, kuralın kötü bir şekilde uygulandığının göstergesi olabilir (ör. depo setlerini düzleştiren bir kural). Paket yükleme işlemi, çok fazla hedef, karmaşık makrolar veya yinelenen glob'ler nedeniyle yavaş olabilir. - Özellikle kritik yoldaki yavaş işlemler. Büyük işlemleri hızlandırmak için birden fazla küçük işleme bölmek veya (geçişli) bağımlılık grubunu azaltmak mümkün olabilir. Ayrıca,
PROCESS_TIMEolmayan ve anormal derecede yüksek bir değer (REMOTE_SETUPveyaFETCHgibi) olup olmadığını kontrol edin. - Performans sorunları, yani az sayıda iş parçacığı meşgulken diğerleri boşta / sonucu bekliyordur (yukarıdaki ekran görüntüsünde yaklaşık 15-30 saniyeye bakın). Bu durumu optimize etmek için büyük olasılıkla daha fazla paralellik sağlamak amacıyla kural uygulamalarında veya Bazel'de değişiklik yapmanız gerekir. Bu durum, olağan dışı miktarda GC olduğunda da ortaya çıkabilir.
Profil dosya biçimi
En üst düzey nesne, meta verileri (otherData) ve gerçek izleme verilerini (traceEvents) içerir. Meta veriler, Bazel çağrısının çağrı kimliği ve tarihi gibi ek bilgiler içerir.
Ö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) mikrosaniye cinsinden verilir. Kategori (cat), ProfilerTask enum değerlerinden biri.
Çok kısa ve birbirine yakın olan bazı etkinliklerin birleştirildiğini unutmayın. Etkinlik birleştirme işlemini önlemek istiyorsanız --noslim_json_profile değerini iletin.
Chrome İzleme Etkinliği Biçimi Spesifikasyonu'na da bakın.
analyze-profile
Bu profil oluşturma yöntemi iki adımdan oluşur. Öncelikle derleme/test işleminizi --profile işaretiyle yürütmeniz gerekir. Örneğin:
$ bazel build --profile=/tmp/prof //path/to:target
Oluşturulan dosya (bu durumda /tmp/prof), analyze-profile komutu tarafından son işleme tabi tutulup 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. Bu rapor, her derleme aşaması için farklı görev türleriyle ilgili kümülatif istatistikleri ve kritik yolun analizini içerir.
Varsayılan çıktının ilk bölümü, farklı derleme aşamalarında harcanan süreye 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 kullanımının profilini çıkarma
Bazel, kuralınızın bellek kullanımını kontrol etmenize yardımcı olabilecek yerleşik bir bellek profil oluşturucusuyla birlikte gelir. Sorun varsa soruna neden olan tam kod satırını bulmak için yığını dökebilirsiniz.
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
Bu komutlar, sunucuyu bellek izleme modunda başlatır. Bunları bir Bazel çağrısında bile unutursanız sunucu yeniden başlatılır ve baştan başlamanız gerekir.
Bellek İzleyici'yi kullanma
Örneğin, foo hedefine bakın ve ne işe yaradığını öğrenin. 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 tükettiğini öğrenin:
$ bazel $(STARTUP_FLAGS) info used-heap-size-after-gc
> 2594MB
bazel dump --rules simgesini kullanarak verileri kural sınıfına göre ayırı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 kullanarak 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 bir alev grafiği elde etmek iyi bir başlangıç noktasıdır.
pprof'yi https://github.com/google/pprof adresinden indirin.
En popüler arama 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)