Kural yazarken en yaygın performans sorunu, bağımlılıklardan toplanan verileri farklı şekillerde incelemek veya kopyalamaktır. Derlemenin tamamı boyunca toplandığında bu işlemler kolayca O(N^2) zaman veya alan alabilir. Bundan kaçınmak için, sunumların etkili şekilde nasıl kullanılacağını anlamak ç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.
Depset'leri kullanma
Kural bağımlılıklarıyla ilgili bilgileri toplarken depsets'i kullanmanız gerekir. Geçerli kurala yerel bilgileri yayınlamak için yalnızca düz listeleri veya diktleri kullanı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. Grafikler büyükse bu sorun
daha da kötüleşir.
Geçişli bilgileri yayınlamak için tanımlayıcıları doğru şekilde kullanan bir kural uygulaması örneğini aşağıda bulabilirsiniz. Bu O(N^2) olmadığından, isterseniz listeler kullanarak yerel kural bilgilerini 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 cihaza genel bakış sayfasını ziyaret edin.
depset.to_list() adlı kişiyi aramaktan kaçının
to_list() kullanarak bir öğeyi düz listeye çevirmeyi zorlayabilirsiniz ancak bu genellikle O(N^2) maliyetiyle sonuçlanır. Mümkünse hata ayıklama amaçları dışında, hataları düzeltmekten kaçının.
Yaygın bir yanlış kanı, bu işlemi yalnızca <xx>_binary kuralı gibi üst düzey hedeflerde yaparsanız yapının düzelmesidir. Çünkü bu durumda maliyet, derleme grafiğinin her seviyesine biriktirilmez. 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, //foo/tests/... testlerinizi oluştururken veya bir IDE projesini içe aktarırken yaşanır.
Arama sayısını depset olacak şekilde azaltın
depset işlevinin bir döngü içinde çağrılması genellikle hatadır. Çok derin iç içe geçmenin derinliklerine
dağılmasına neden olarak düşük 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ştirin:
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. Bu, tüm derinlerin yürütme aşamasına genişletilmesini engeller.
Bu, tamamen daha hızlı olmanın yanı sıra kurallarınızın bellek 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. Sizin için
ctx.actions.args()genişletilecek. Hazırlanan içeriklerde herhangi bir dönüşüme ihtiyacınız varsa, faturaya uygun bir şey olup olmadığını görmek için ctx.actions.args#add adresine 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 ertelenen yola dönüştürülür.Dizeleri bir araya getirerek oluşturmaktan kaçının. En iyi dize bağımsız değişkeni sabittir, çünkü belleği, kuralınızın tüm örnekleri arasında paylaşılacaktır.
Bağımsız değişkenler komut satırı için çok uzunsa
ctx.actions.args()nesnesi,ctx.actions.args#use_param_filekullanılarak bir param dosyasına koşullu veya koşulsuz olarak yazılabilir. Bu işlem, işlem yürütüldüğünde perde arkasında yapılır. Parametre dosyasını açık bir şekilde kontrol etmeniz gerekirse dosyayıctx.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ş işlemi girişleri, depsets 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. Bağımlılıklardan geçişli olarak
girişler toplandığında bunu kullanın.
inputs = depset(...)
ctx.actions.run(
inputs = inputs, # Do *not* turn inputs into a list
...
)
Askılı
Bazel askıya alınmış gibi görünüyorsa $(bazel info output_base)/server/jvm.out dosyasında bir iş parçacığı dökümü almak için Ctrl-\ tuşlarına basabilir veya Bazel'a SIGQUIT sinyali (kill -3 $(bazel info server_pid)) gönderebilirsiniz.
Bazel askıya alınırsa bazel info komutunu çalıştıramayabilirsiniz. Bu nedenle, output_base dizini genellikle Workspace dizininizdeki bazel-<workspace> sembol bağlantısının üst öğesidir.
Performans profili oluşturma
Bazel varsayılan olarak çıkış tabanında command.profile.gz işlevine 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 chrome://tracing adresini 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
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şlarına basın. Ardından görünümü hareket ettirmek için fareyi sürükleyin. Sağa/sola 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
?tuşuna basın.
Profil bilgileri
Ö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--jobsdeğerine kadar çıkmalıdır.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ğ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. Bazel'ın neler yaptığına dair genel bir fikir edinmek için kullanışlıdır. Örneğin, "Launch Bazel", "assessTargetPatterns" ve "runAnalysisPhase".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:
- Özellikle artımlı derlemelerde, beklenenden daha yavaş analiz aşaması (
runAnalysisPhase). Bu, kuralın kötü bir şekilde uygulandığını, örneğin dendeki eksiklikleri giderdiğinin göstergesi olabilir. Paket yükleme işlemi, aşırı sayıda hedef, karmaşık makrolar veya özyinelemeli glob'lar nedeniyle yavaş olabilir. - Bağımsız yavaş işlemler, özellikle de kritik yoldakiler. Büyük işlemleri birden çok küçük eyleme bölmek veya bunları hızlandırmak için (geçişli) bağımlılıkları azaltmak mümkün olabilir. Ayrıca,
PROCESS_TIMEolmayan olağan dışı bir değer olup olmadığını kontrol edin (REMOTE_SETUPveyaFETCHgibi). - 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). Bunu optimize etmek için, büyük olasılıkla kural uygulamalarına veya Bazel'e daha fazla benzerlik sağlamak amacıyla dokunmak gerekecektir. Olağan dışı miktarda GC olduğunda bu durum ortaya çıkabilir.
Profil dosya biçimi
Üst düzey nesne, meta verileri (otherData) ve gerçek izleme verilerini (traceEvents) içerir. Meta veri, ek bilgiler (ör. Bazel çağrısının tarihi ve çağrı kimliği) 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 biri.
Birbirine çok yakın ve çok kısa olan bazı etkinliklerin birleştirildiğini unutmayın. Etkinlik birleştirmeyi önlemek istiyorsanız --noslim_json_profile değerini iletin.
Ayrıca Chrome İzleme Etkinlik Biçimi Spesifikasyonu'na da bakın.
analiz-profili
Bu profil oluşturma yöntemi iki adımdan oluşur. Önce derlemenizi/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 son işlenip analiz edilebilen bir ikili program dosyasıdır:
$ bazel analyze-profile /tmp/prof
Varsayılan olarak, belirtilen profil veri dosyası için özet analiz bilgilerini yazdırır. Buna, her oluşturma aşaması için farklı görev türlerine ait kümülatif istatistikler ve kritik yolun analizi dahildir.
Varsayılan çıktının ilk bölümü, farklı derleme aşamalarında harcanan süreye genel bir bakış sunar:
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. Bir sorun varsa, soruna neden olan kod satırını tam olarak bulmak için yığın dökümünü çıkarabilirsiniz.
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. Tek bir Bazel çağrısında da bunları 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
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)
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. İyi bir başlangıç noktası olarak
pprof -flame $HOME/prof.gz kullanarak bir flame grafiği edinmektir.
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)