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 ve alan alabilir. Bunu önlemek için alt kümeleri nasıl etkili bir şekilde kullanacağınızı anlamak çok önemlidir.
Bunu başarmak zor olabilir. Bu yüzden Bazel, hata yapmış olabileceğiniz noktaları bulmada size yardımcı olan bir bellek profili oluşturucu da sağlar. Dikkatli olun: Verimsiz bir kural yazmanın maliyeti, yaygın şekilde kullanılana kadar belirgin olmayabilir.
Dizüstü bilgisayar kullan
Kural bağımlılıklarından bilgi alırken depsets özelliğini kullanmanız gerekir. Mevcut kurala göre yerel bilgileri yayınlamak için yalnızca düz listeler veya komutlar kullanın.
Yok kümesi, bilgileri, paylaşımı mümkün kılan 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. Alt kümelerle 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' teriminden 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 bu liste O(N^2) olmadığı için 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 depset'e genel bakış sayfasına bakın.
depset.to_list() numaralı telefonu aramaktan kaçının
to_list() kullanarak düşüşü düz bir listeye almaya zorlayabilirsiniz ancak bunu yapmak genellikle O(N^2) maliyetiyle sonuçlanır. Mümkünse hata ayıklama amaçları dışında derinliklerin düzleştirilmesinden kaçının.
Yaygın bir yanılgıya göre, bu işlemi yalnızca <xx>_binary kuralı gibi üst düzey hedeflerde yaparsanız alt öğeleri serbestçe birleştirebilirsiniz. Çünkü maliyet, derleme grafiğinin her düzeyinde toplanmaz. Ancak bağımlılıkları örtüşen bir hedef kümesi oluşturduğunuzda bu hâlâ O(N^2) olur. Bu durum //foo/tests/... testlerinizi oluştururken veya bir IDE projesini içe aktarırken ortaya çıkar.
Arama sayısını depset olacak şekilde azaltın
Bir döngünün içinde depset çağrısı yapmak genellikle bir hatadır. Bu durum, çok derin iç içe yerleştirme
yapma sorunlarına yol açarak düşük performans gösterebilir. Ö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 altlıkları toplayın ve aynı anda birleştirin:
transitive = []
for i in inputs:
transitive.append(i.deps)
x = depset(transitive = transitive)
Bazı durumlarda liste anlayışını kullanarak bu oranı azaltabilirsiniz:
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() işlevini kullanmanız gerekir. Bu, alt kümelerin genişletilmesini yürütme aşamasına erteler.
Bu yöntem, kesinlikle daha hızlı olmasını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şken olarak aktarın. Tekliflerin kapsamı
ctx.actions.args()tarafından sizin için genişletilecek. Kaldırılmış içeriklerde herhangi bir dönüşüme ihtiyacınız varsa uygun bir şey olup olmadığını görmek için ctx.actions.args#add ifadesini inceleyin.File#pathöğesini bağımsız değişken olarak iletiyor musunuz? Gerek yok. Herhangi bir Dosya, genişletme süresine ertelenerek otomatik olarak yoluna 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_filekullanılarak koşullu veya koşulsuz olarak bir param dosyasına 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 gerekiyorsa,ctx.actions.writekullanarak dosyayı 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 alt küme olmalıdır
ctx.actions.run kullanarak bir işlem oluştururken inputs alanının depset değerini kabul ettiğini unutmayın. Bağımlılardan 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 $(bazel info output_base)/server/jvm.out dosyasına 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 asılıyken 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ında 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
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 istatistikleri 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. Sola/sağa gitmek içina/dtuşunu 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çin dew/skullanabilirsiniz. - İ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: Aralıklarla reklam yayınında kaç eşzamanlı işlem gerçekleştirildiğini gösterir. Gerçek değeri görmek için üzerini tıklayın. Net derlemelerde--jobsdeğ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 genel bir fikir edinmek için yararlıdır; örneğin, "Launch Bazel", "assessTargetPatterns" ve "runAnalysisPhase".Service Thread: Küçük ve önemli Çöp Toplama (GC) durakları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 bakın:
- Özellikle artımlı derlemelerde, beklenenden daha yavaş analiz aşaması (
runAnalysisPhase). Bu, kötü bir kuralın (örneğin, alt çizgileri düzelten bir uygulama) kötü bir uygulamaya işaret edebilir. Paket yükleme; aşırı miktarda hedef, karmaşık makro veya yinelenen küre nedeniyle yavaş olabilir. - Ayrı ayrı yavaş işlemler, özellikle kritik yoldakiler. 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_TIMEolmayan olağandışı bir yüksek değer olup olmadığını da kontrol edin (REMOTE_SETUPveyaFETCHgibi). - Performans sorunları, diğer tüm iş parçacıkları boşta kalırken / sonucu beklerken az sayıda iş parçacığı meşgul olur (yukarıdaki ekran görüntüsünde 15-30 saniye civarında bir süreye bakın). Bunu optimize etmek, büyük olasılıkla daha fazla paralellik sağlamak için kural uygulamalarına veya Bazel'in kendisine dokunmayı 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 izleme verilerini (traceEvents) içerir. Meta veriler, Bazel çağrısının çağrı kimliği ve tarihi gibi ekstra 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}
]
}
İz 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 olmaları durumunda birleştirildiğini unutmayın. Etkinliklerin birleştirilmesini önlemek istiyorsanız --noslim_json_profile değerini iletin.
Chrome Trace Etkinlik Biçimi Spesifikasyonu'nu da inceleyin.
profili analiz et
Bu profil oluşturma yöntemi iki adımdan oluşur. İlk olarak 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 işleme alınıp analiz edilebilen ikili bir dosyadır:
$ bazel analyze-profile /tmp/prof
Varsayılan olarak, belirtilen profil veri dosyası için özet analiz bilgilerini yazdırır. Her bir derleme aşaması için 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ış 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 aracı içerir. Sorun varsa bu soruna neden olan kod satırını tam olarak bulmak için yığının dökümünü alabilirsiniz.
Bellek izlemeyi etkinleştirme
Aşağıdaki iki başlatma 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 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
Örneğin, foo hedefine bakın ve ne işe yaradığını görün. Derleme yürütme aşamasını çalıştırmak yerine yalnızca analizi çalıştırmak 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ğine bakı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:
$ 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 flame grafiği oluşturmak iyi bir başlangıç noktasıdır.
pprof uygulamasını https://github.com/google/pprof adresinden indirin.
Şu satırlarla not eklenmiş en popüler ç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)