Bu doküman, kod tabanının ve Bazel'in nasıl yapılandırıldığının bir açıklamasıdır. Son kullanıcılar için değil, Bazel'e katkıda bulunmak isteyenler için tasarlanmıştır.
Giriş
Bazel'in kod tabanı büyüktür (~350 KLOC üretim kodu ve ~260 KLOC test kodu) ve hiç kimse tüm manzarayı tanımıyor: Herkes kendi vadisini çok iyi bilir, ancak her yöndeki tepelerin arkasında ne olduğunu çok az kişi bilir.
Yolculuğun ortasında kendilerini karanlık bir ormanda, düz bir yolun kaybolduğu bir yerde bulmamaları için bu dokümanda, kod tabanına genel bir bakış sunulmaya çalışılarak üzerinde çalışmaya başlamaları kolaylaştırılmıştır.
Bazel kaynak kodunun herkese açık sürümü, github.com/bazelbuild/bazel adresindeki GitHub'da yer alır. Bu, "doğru kaynak" değildir; Google dışında kullanışlı olmayan ek işlevler içeren Google'a ait bir kaynak ağacından türetilmiştir. Uzun vadeli hedefimiz, GitHub'ı bilgi kaynağı haline getirmektir.
Katkılar, normal GitHub pull isteği mekanizması aracılığıyla kabul edilir ve bir Google çalışanı tarafından manuel olarak dahili kaynak ağacına aktarılır, ardından GitHub'a geri aktarılır.
İstemci/sunucu mimarisi
Bazel'in büyük kısmı, derlemeler arasında RAM'de kalan bir sunucu sürecinde bulunur. Bu sayede Bazel, derlemeler arasında durumu koruyabilir.
Bu nedenle Bazel komut satırında iki tür seçenek vardır: başlangıç ve komut. Aşağıdaki gibi bir komut satırında:
bazel --host_jvm_args=-Xmx8G build -c opt //foo:bar
Bazı seçenekler (--host_jvm_args=
) çalıştırılacak komutun adından önce, bazıları ise (-c opt
) sonra gelir. Önceki tür "başlangıç seçeneği" olarak adlandırılır ve sunucu sürecini bir bütün olarak etkiler. "Komut seçeneği" olarak adlandırılan ikinci tür ise yalnızca tek bir komutu etkiler.
Her sunucu örneğinin tek bir ilişkili kaynak ağacı ("çalışma alanı") ve her çalışma alanının genellikle tek bir etkin sunucu örneği vardır. Bu sorun, özel bir çıkış tabanı belirterek atlatılabilir (daha fazla bilgi için "Dizin düzeni" bölümüne bakın).
Bazel, geçerli bir .zip dosyası olan tek bir ELF yürütülebilir dosyası olarak dağıtılır.
bazel
yazdığınızda, C++'ta uygulanan yukarıdaki ELF yürütülebilir dosyası ("istemci") kontrolü alır. Aşağıdaki adımları kullanarak uygun bir sunucu işlemi oluşturur:
- Dosyanın daha önce ayıklanıp ayıklanmadığını kontrol eder. Aksi takdirde, bu işlemi yapar. Sunucunun uygulanmasının nedeni budur.
- Çalışan etkin bir sunucu örneği olup olmadığını kontrol eder: Çalışıyor, doğru başlangıç seçeneklerine sahip ve doğru çalışma alanı dizini kullanıyor olmalıdır. Çalışan sunucuyu, sunucunun dinlediği bağlantı noktasının kilit dosyasının bulunduğu
$OUTPUT_BASE/server
dizine bakarak bulur. - Gerekirse eski sunucu işlemini sonlandırır.
- Gerekirse yeni bir sunucu işlemi başlatır
Uygun bir sunucu işlemi hazır olduktan sonra, çalıştırılması gereken komut bir gRPC arayüzü üzerinden ona iletilir ve ardından Bazel'in çıkışı terminale geri aktarılır. Aynı anda yalnızca bir komut çalışabilir. Bu, C++ ve Java'da parçaları olan ayrıntılı bir kilitleme mekanizması kullanılarak uygulanır. bazel version
'ü başka bir komutla paralel olarak çalıştıramamak biraz utanç verici olduğundan, birden fazla komutu paralel olarak çalıştırmak için bazı altyapılar vardır. Ana engelleyici, BlazeModule
öğelerinin yaşam döngüsü ve BlazeRuntime
'daki bazı durumlardır.
Bazel sunucusu, bir komutun sonunda istemcinin döndürmesi gereken çıkış kodunu iletir. bazel run
komutunun uygulanması ilginç bir ayrıntıdır: Bu komutun görevi, Bazel'in yeni oluşturduğu bir şeyi çalıştırmaktır ancak terminali olmadığı için bunu sunucu sürecinden yapamaz. Bunun yerine, istemciye hangi ikili dosyayı ujexec() ile hangi bağımsız değişkenlerle çalıştırması gerektiğini söyler.
Ctrl-C tuşlarına basıldığında istemci, bu tuş kombinasyonunu gRPC bağlantısında bir İptal çağrısına dönüştürür. Bu çağrı, komutu en kısa sürede sonlandırmaya çalışır. Üçüncü Ctrl-C'den sonra istemci, bunun yerine sunucuya SIGKILL gönderir.
İstemcinin kaynak kodu src/main/cpp
altındadır ve sunucuyla iletişim kurmak için kullanılan protokol src/main/protobuf/command_server.proto
içindedir .
Sunucunun ana giriş noktası BlazeRuntime.main()
'tür ve istemciden gelen gRPC çağrıları GrpcServerImpl.run()
tarafından işlenir.
Dizin düzeni
Bazel, derleme sırasında biraz karmaşık bir dizi dizin oluşturur. Tam açıklamayı Çıkış dizini düzeni bölümünde bulabilirsiniz.
"Çalışma alanı", Bazel'in çalıştırıldığı kaynak ağacıdır. Genellikle kaynak kontrolünden aldığınız bir öğeye karşılık gelir.
Bazel, tüm verilerini "output user root" altına yerleştirir. Bu genellikle $HOME/.cache/bazel/_bazel_${USER}
olur ancak --output_user_root
başlangıç seçeneği kullanılarak geçersiz kılınabilir.
"Yükleme tabanı", Bazel'in ayıklandığı yerdir. Bu işlem otomatik olarak yapılır ve her Bazel sürümü, yükleme tabanı altında sağlama toplamına göre bir alt dizin alır. Varsayılan olarak $OUTPUT_USER_ROOT/install
değerindedir ve --install_base
komut satırı seçeneği kullanılarak değiştirilebilir.
"Çıkış tabanı", belirli bir çalışma alanına bağlı Bazel örneğinin yazdığı yerdir. Her çıkış tabanında, herhangi bir zamanda çalışan en fazla bir Bazel sunucusu örneği bulunur. Genellikle $OUTPUT_USER_ROOT/<checksum of the path
to the workspace>
'te. --output_base
başlangıç seçeneği kullanılarak değiştirilebilir. Bu seçenek, diğer özelliklerinin yanı sıra herhangi bir çalışma alanında aynı anda yalnızca bir Bazel örneğinin çalışabileceği sınırlamayı aşmak için de yararlıdır.
Çıkış dizininde şunlar bulunur:
$OUTPUT_BASE/external
adresindeki getirilen harici depolar.- Mevcut derlemenin tüm kaynak kodunun sembolik bağlantılarını içeren bir dizin olan exec kökü. Adresi:
$OUTPUT_BASE/execroot
. Derleme sırasında çalışma dizini$EXECROOT/<name of main repository>
olur. Bu özelliği$EXECROOT
olarak değiştirmeyi planlıyoruz. Ancak bu, çok uyumsuz bir değişiklik olduğu için uzun vadeli bir plandır. - Derleme sırasında oluşturulan dosyalar.
Komut yürütme işlemi
Bazel sunucusu kontrolü aldıktan ve yürütmesi gereken bir komut hakkında bilgilendirildikten sonra aşağıdaki etkinlikler dizisi gerçekleşir:
BlazeCommandDispatcher
, yeni istek hakkında bilgilendirilir. Komutun çalıştırılabilmesi için bir çalışma alanına ihtiyaç duyup duymadığına (sürüm veya yardım gibi kaynak kodla hiçbir ilgisi olmayanlar hariç neredeyse tüm komutlar) ve başka bir komutun çalışıp çalışmadığına karar verir.Doğru komut bulunur. Her komut
BlazeCommand
arayüzünü uygulamalı ve@Command
ek açıklamasına sahip olmalıdır (bu biraz anti-modeldir. Bir komutun ihtiyaç duyduğu tüm meta verilerinBlazeCommand
'teki yöntemlerle açıklanması iyi olur).Komut satırı seçenekleri ayrıştırılır. Her komutun farklı komut satırı seçenekleri vardır. Bu seçenekler
@Command
ek açıklamalarında açıklanmaktadır.Bir etkinlik otobüsü oluşturulur. Etkinlik akışı, derleme sırasında gerçekleşen etkinlikler için bir akıştır. Bunlardan bazıları, derlemenin nasıl gittiğini dünyaya bildirmek için Derleme Etkinliği Protokolü kapsamında Bazel'in dışına aktarılır.
Komut kontrolü alır. En ilginç komutlar, derleme çalıştıranlardır: derle, test et, çalıştır, kapsam vb. Bu işlev
BuildTool
tarafından uygulanır.Komut satırındaki hedef kalıp grubu ayrıştırılır ve
//pkg:all
ve//pkg/...
gibi joker karakterler çözülür. Bu,AnalysisPhaseRunner.evaluateTargetPatterns()
içinde uygulanır ve Skyframe'daTargetPatternPhaseValue
olarak somutlaştırılır.Yükleme/analiz aşaması, işlem grafiğini (derleme için yürütülmesi gereken komutların yönlendirilmiş, döngüsel olmayan bir grafiği) oluşturmak üzere çalıştırılır.
Yürütme aşaması çalıştırılır. Bu, istenen üst düzey hedefleri oluşturmak için gereken her işlemin çalıştırıldığı anlamına gelir.
Komut satırı seçenekleri
Bazel çağrısı için komut satırı seçenekleri, bir OptionsParsingResult
nesnesinde açıklanır. Bu nesne de "option sınıflarından" seçeneklerin değerlerine giden bir harita içerir. "Seçenek sınıfı", OptionsBase
alt sınıfıdır ve birbirleriyle ilgili komut satırı seçeneklerini gruplandırır. Örneğin:
- Bir programlama diliyle (
CppOptions
veyaJavaOptions
) ilgili seçenekler. BunlarFragmentOptions
alt sınıfı olmalı ve sonunda birBuildOptions
nesnesine sarmalanmalıdır. - Bazel'in işlemleri yürütme şekliyle ilgili seçenekler (
ExecutionOptions
)
Bu seçenekler, analiz aşamasında (Java'da RuleContext.getFragment()
veya Starlark'ta ctx.fragments
aracılığıyla) kullanılmak üzere tasarlanmıştır.
Bunlardan bazıları (örneğin, C++ dahil etme taramasının yapılıp yapılmayacağı) yürütme aşamasında okunur ancak BuildConfiguration
o sırada kullanılamadığından bu işlem her zaman açık bağlantı gerektirir. Daha fazla bilgi için "Yapılandırmalar" bölümüne bakın.
UYARI: OptionsBase
örneklerini değiştirilemezmiş gibi göstermeyi ve bu şekilde kullanmayı (ör. SkyKeys
kapsamında) tercih ederiz. Ancak durum böyle değildir ve bunları değiştirmek, Bazel'i hata ayıklamanın zor olduğu ince yollardan bozmanın çok iyi bir yoludur. Maalesef bu öğeleri gerçekten değiştirilemez hale getirmek büyük bir çaba gerektiriyor.
(FragmentOptions
öğesini, başka bir kullanıcının referans alma şansı bulamadan ve equals()
veya hashCode()
çağrılmadan hemen sonra değiştirmek sorun değildir.)
Bazel, seçenek sınıfları hakkında aşağıdaki yöntemlerle bilgi edinir:
- Bazıları Bazel'e (
CommonCommandOptions
) bağlıdır. - Her Bazel komutundaki @Command ek açıklamalarından
ConfiguredRuleClassProvider
'ten (bunlar, ayrı programlama dilleriyle ilgili komut satırı seçenekleridir)- Starlark kuralları da kendi seçeneklerini tanımlayabilir (buraya bakın).
Her seçenek (Starlark tarafından tanımlanan seçenekler hariç), komut satırı seçeneğinin adını ve türünü bazı yardım metinleriyle birlikte belirten @Option
ek açıklamasını içeren bir FragmentOptions
alt sınıfının üye değişkenidir.
Bir komut satırı seçeneğinin değerinin Java türü genellikle basit bir şeydir (dize, tam sayı, Boole, etiket vb.). Ancak daha karmaşık türlerde seçenekleri de destekliyoruz. Bu durumda, komut satırı dizesinden veri türüne dönüştürme işlemi com.google.devtools.common.options.Converter
uygulamasına bırakılır.
Bazel tarafından görülen kaynak ağacı
Bazel, kaynak kodu okuyup yorumlayarak yazılım oluşturma işi yapar. Bazel'in üzerinde çalıştığı kaynak kodun tamamına "çalışma alanı" denir ve depo, paket ve kurallar şeklinde yapılandırılır.
Kod depoları
"Depo", geliştiricinin üzerinde çalıştığı bir kaynak ağacıdır ve genellikle tek bir projeyi temsil eder. Bazel'in atası olan Blaze, monorepo'da (yani derlemeyi çalıştırmak için kullanılan tüm kaynak kodu içeren tek bir kaynak ağacında) çalışırdı. Buna karşılık Bazel, kaynak kodu birden fazla depoyu kapsayan projeleri destekler. Bazel'in çağrıldığı depoya "ana depo", diğer depolara ise "harici depolar" denir.
Depo, kök dizininde WORKSPACE
(veya WORKSPACE.bazel
) adlı bir dosyayla işaretlenir. Bu dosya, derlemenin tamamı için "evrensel" olan bilgileri (ör. kullanılabilir harici depolar grubu) içerir. Normal bir Starlark dosyası gibi çalışır. Diğer Starlark dosyalarını load()
edebilirsiniz.
Bu, açıkça referans verilen bir deponun ihtiyaç duyduğu depoları almak için yaygın olarak kullanılır (buna "deps.bzl
kalıbı" denir).
Harici depoların kodu, $OUTPUT_BASE/external
altında simge bağlantısı oluşturur veya indirilir.
Derleme işlemi sırasında kaynak ağacının tamamının birleştirilmesi gerekir. Bu işlem, ana depodaki her paketi $EXECROOT
ile, harici depoları ise $EXECROOT/external
veya $EXECROOT/..
ile sembolik olarak bağlayan SymlinkForest tarafından gerçekleştirilir (ilki, ana depoda external
adlı bir paketin olmasını imkansız kılar. Bu nedenle, bu yöntemden uzaklaşıyoruz).
Paketler
Her depo, paketlerden, ilgili dosyalardan oluşan bir koleksiyondan ve bağımlılıkların spesifikasyonundan oluşur. Bunlar, BUILD
veya BUILD.bazel
adlı bir dosyayla belirtilir. Her ikisi de varsa Bazel BUILD.bazel
dosya adını tercih eder. BUILD
dosyalarının hâlâ kabul edilmesinin nedeni, Bazel'in atası Blaze'ın bu dosya adını kullanmasıdır. Ancak özellikle dosya adlarının büyük/küçük harf duyarlı olmadığı Windows'ta yaygın olarak kullanılan bir yol segmenti olduğu ortaya çıktı.
Paketler birbirinden bağımsızdır: Bir paketin BUILD
dosyasında yapılan değişiklikler diğer paketlerin değişmesine neden olmaz. Yinelenen glob'lar paket sınırlarında durduğundan ve dolayısıyla BUILD
dosyasının varlığı yinelemeyi durdurduğundan, BUILD
dosyalarının eklenmesi veya kaldırılması diğer paketleri _değiştirebilir_.
BUILD
dosyasının değerlendirilmesine "paket yükleme" denir. PackageFactory
sınıfında uygulanır, Starlark yorumlayıcısını çağırarak çalışır ve mevcut kural sınıfları hakkında bilgi sahibi olmayı gerektirir. Paket yüklemenin sonucu bir Package
nesnesi olur. Çoğunlukla bir dizeyi (hedefin adı) hedefin kendisine eşleyen bir eşlemedir.
Paket yükleme sırasında karmaşıklığın büyük bir kısmı, genelleştirmeden kaynaklanır: Bazel, her kaynak dosyanın açıkça listelenmesini gerektirmez ve bunun yerine genelleştirmeleri (glob(["**/*.java"])
gibi) çalıştırabilir. Kabuğun aksine, alt dizinlere inen (ancak alt paketlere inmeyen) yinelenen genelleştirmeleri destekler. Bu işlem için dosya sistemine erişim gerekir. Bu işlem yavaş olabileceğinden, paralel olarak ve olabildiğince verimli bir şekilde çalışması için her türlü hileyi uygularız.
Globbing aşağıdaki sınıflarda uygulanır:
LegacyGlobber
, hızlı ve Skyframe'dan habersiz bir globberSkyframeHybridGlobber
: Skyframe kullanan ve "Skyframe'ın yeniden başlatılmasını" (aşağıda açıklanmıştır) önlemek için eski toplayıcıya geri dönen bir sürüm
Package
sınıfının kendisi, yalnızca WORKSPACE dosyasını ayrıştırmak için kullanılan ve gerçek paketler için anlamlı olmayan bazı üyeler içerir. Normal paketleri tanımlayan nesneler başka bir şeyi tanımlayan alanlar içermediğinden bu bir tasarım hatası. Bunlardan bazıları:
- Depo eşlemeleri
- Kayıtlı araç zincirleri
- Kayıtlı yürütme platformları
İdeal olarak, WORKSPACE dosyasının ayrıştırılması ile normal paketlerin ayrıştırılması arasında daha fazla ayrım olması gerekir. Böylece Package
'in her ikisinin de ihtiyaçlarını karşılaması gerekmez. İkisi oldukça iç içe geçtiği için bu işlemi yapmak maalesef zordur.
Etiketler, Hedefler ve Kurallar
Paketler, aşağıdaki türlere sahip hedeflerden oluşur:
- Dosyalar: Derlemenin girişi veya çıkışı olan öğeler. Bazel dilinde bunlara yapılar denir (başka bir yerde ele alınmıştır). Derleme sırasında oluşturulan dosyaların tümü hedef değildir. Bazel'in çıktısının ilişkili bir etikete sahip olmaması yaygın bir durumdur.
- Kurallar: Bu, çıktıları girişlerden elde etme adımlarını açıklar. Bunlar genellikle bir programlama diliyle ilişkilendirilir (
cc_library
,java_library
veyapy_library
gibi), ancak dile bağlı olmayan bazı türler de vardır (genrule
veyafilegroup
gibi). - Paket grupları: Görünürlük bölümünde ele alınmıştır.
Hedefin adına etiket denir. Etiketlerin söz dizimi @repo//pac/kage:name
şeklindedir. Burada repo
, etiketin bulunduğu deponun adı, pac/kage
, BUILD
dosyasının bulunduğu dizin ve name
, paketin dizine göre dosyanın yoludur (etiket bir kaynak dosyayı ifade ediyorsa). Komut satırında bir hedeften bahsederken etiketin bazı bölümleri atlanabilir:
- Depo atlanırsa etiketin ana depoda olduğu kabul edilir.
- Paket kısmı atlanırsa (
name
veya:name
gibi) etiketin mevcut çalışma dizininin paketinde olduğu kabul edilir (üst düzey referanslar (..) içeren göreli yollara izin verilmez)
Bir tür kurala ("C++ kitaplığı" gibi) "kural sınıfı" denir. Kural sınıfları Starlark'ta (rule()
işlevi) veya Java'da ("yerel kurallar" olarak da bilinir, RuleClass
türü) uygulanabilir. Uzun vadede, her dile özgü kural Starlark'ta uygulanacak olsa da bazı eski kural aileleri (Java veya C++) şimdilik Java'dadır.
Starlark kural sınıflarının, load()
ifadesi kullanılarak BUILD
dosyalarının başında içe aktarılması gerekir. Java kural sınıfları ise ConfiguredRuleClassProvider
'ye kaydedildikleri için Bazel tarafından "doğal olarak" bilinir.
Kural sınıfları aşağıdaki gibi bilgiler içerir:
- Özellikleri (
srcs
,deps
gibi): türleri, varsayılan değerleri, kısıtlamaları vb. - Her bir özelliğe bağlı yapılandırma geçişleri ve yönler (varsa)
- Kuralın uygulanması
- Kuralın "genellikle" oluşturduğu geçişli bilgi sağlayıcılar
Terminoloji notu: Kod tabanında, bir kural sınıfı tarafından oluşturulan hedefi belirtmek için genellikle "Kural" ifadesini kullanırız. Ancak Starlark'ta ve kullanıcılara yönelik belgelerde "Kural", yalnızca kural sınıfına atıfta bulunmak için kullanılmalıdır; hedef ise yalnızca bir "hedef"tir. Ayrıca, RuleClass
adında "class" olmasına rağmen, kural sınıfı ile bu türdeki hedefler arasında Java miras ilişkisi olmadığını unutmayın.
Skyframe
Bazel'in temel aldığı değerlendirme çerçevesine Skyframe adı verilir. Modeli, bir derleme sırasında oluşturulması gereken her şeyin, veri parçalarından bağımlılıklarına (yani, oluşturulması için bilinmesi gereken diğer veri parçalarına) yönlendiren kenarları olan yönlendirilmiş bir döngüsel olmayan grafikte düzenlenmesidir.
Grafikteki düğümlere SkyValue
, adlarına ise SkyKey
denir. Her ikisi de tamamen sabittir; bunlardan yalnızca sabit nesnelere erişilebilir. Bu değişmezlik neredeyse her zaman geçerlidir ve geçerli olmadığı durumlarda (ör. BuildConfigurationValue
ve SkyKey
üyesi olan bağımsız seçenek sınıfları BuildOptions
için) bunları değiştirmemeye veya yalnızca dışarıdan gözlemlenemeyen şekillerde değiştirmeye çalışıyoruz.
Bu nedenle, Skyframe'da hesaplanan her şeyin (yapılandırılmış hedefler gibi) de değiştirilemez olması gerekir.
Skyframe grafiğini gözlemlemenin en uygun yolu, grafiği satır başına bir SkyValue
olacak şekilde döken bazel dump
--skyframe=detailed
komutunu çalıştırmaktır. Oldukça büyük bir dosya oluşturabileceği için bunu küçük derlemeler için yapmanız önerilir.
Skyframe, com.google.devtools.build.skyframe
paketinde bulunur. Benzer şekilde adlandırılmış com.google.devtools.build.lib.skyframe
paketi, Skyframe'ın üzerine Bazel'in uygulanmasını içerir. Skyframe hakkında daha fazla bilgiye buradan ulaşabilirsiniz.
Skyframe, belirli bir SkyKey
değerini SkyValue
olarak değerlendirmek için anahtarın türüne karşılık gelen SkyFunction
işlevini çağırır. İşlev değerlendirilirken SkyFunction.Environment.getValue()
işlevinin çeşitli aşırı yüklemelerini çağırarak Skyframe'dan başka bağımlılıklar isteyebilir. Bu, bu bağımlılıkları Skyframe'ın dahili grafiğine kaydetme yan etkisine sahiptir. Böylece Skyframe, bağımlılıkları değiştiğinde işlevi yeniden değerlendirmeyi bilir. Diğer bir deyişle, Skyframe'ın önbelleğe alma ve artımlı hesaplama işlemleri SkyFunction
ve SkyValue
düzeyinde çalışır.
Bir SkyFunction
, kullanılamayan bir bağımlılık istediğinde getValue()
null döndürür. Ardından işlev, null döndürerek kontrolü Skyframe'a geri vermelidir. Skyframe, daha sonra kullanılamayan bağımlılığı değerlendirir ve işlevi baştan başlatır. Ancak bu kez getValue()
çağrısı, null olmayan bir sonuçla başarılı olur.
Bunun bir sonucu olarak, yeniden başlatmadan önce SkyFunction
içinde yapılan tüm hesaplamaların tekrarlanması gerekir. Ancak bu, önbelleğe alınan SkyValues
bağımlılığını değerlendirmek için yapılan çalışmaları içermez. Bu nedenle, genellikle aşağıdakileri yaparak bu sorunu gideririz:
- Yeniden başlatma sayısını sınırlamak için bağımlılıklarını gruplar halinde bildirme (
getValuesAndExceptions()
kullanarak). - Bir
SkyValue
'ü, bağımsız olarak hesaplanıp önbelleğe alınabilmeleri için farklıSkyFunction
'lar tarafından hesaplanan ayrı parçalara ayırma. Bellek kullanımını artırma potansiyeli olduğundan bu işlem stratejik bir şekilde yapılmalıdır. SkyFunction.Environment.getState()
kullanarak veya "Skyframe'ın arkasında" geçici bir statik önbelleğe sahip olarak yeniden başlatmalar arasında durumu depolama.
Temel olarak bu tür geçici çözümlere ihtiyacımız var çünkü rutin olarak yüz binlerce uçuştaki Skyframe düğümümüz var ve Java hafif iş parçacıklarını desteklemiyor.
Starlark
Starlark, kullanıcıların Bazel'i yapılandırmak ve genişletmek için kullandığı alana özgü bir dildir. Python'un çok daha az türe sahip, kontrol akışında daha fazla kısıtlamaya sahip ve en önemlisi de eşzamanlı okumaları etkinleştirmeyi garanti eden güçlü bir değişmezlik özelliğine sahip kısıtlanmış bir alt kümesi olarak tasarlanmıştır. Turing-tam değil. Bu durum, bazı kullanıcıların (tüm kullanıcıların değil) dilde genel programlama görevlerini gerçekleştirmeye çalışmasını engeller.
Starlark, net.starlark.java
paketinde uygulanır.
Ayrıca bağımsız bir Go uygulaması da burada mevcuttur. Bazel'de kullanılan Java uygulaması şu anda bir yorumcu.
Starlark aşağıdakiler dahil olmak üzere çeşitli bağlamlarda kullanılır:
BUILD
dili. Yeni kurallar burada tanımlanır. Bu bağlamda çalışan Starlark kodu yalnızcaBUILD
dosyasının ve bu dosya tarafından yüklenen.bzl
dosyalarının içeriğine erişebilir.- Kural tanımları. Yeni kurallar (ör. yeni bir dil desteği) bu şekilde tanımlanır. Bu bağlamda çalışan Starlark kodu, doğrudan bağımlılıkları tarafından sağlanan yapılandırmaya ve verilere erişebilir (bu konu hakkında daha fazla bilgiyi aşağıda bulabilirsiniz).
- WORKSPACE dosyası. Harici depolar (ana kaynak ağacında olmayan kod) burada tanımlanır.
- Depo kural tanımları. Yeni harici depo türleri burada tanımlanır. Bu bağlamda çalışan Starlark kodu, Bazel'in çalıştığı makinede rastgele kod çalıştırabilir ve çalışma alanının dışına çıkabilir.
BUILD
ve .bzl
dosyaları için kullanılabilen lehçeler, farklı şeyler ifade ettikleri için biraz farklıdır. Farklılıkların listesini burada bulabilirsiniz.
Starlark hakkında daha fazla bilgiye buradan ulaşabilirsiniz.
Yükleme/analiz aşaması
Yükleme/analiz aşamasında Bazel, belirli bir kuralı oluşturmak için hangi işlemlerin gerekli olduğunu belirler. Temel birimi, "yapılandırılmış hedef"tir. Bu, oldukça mantıklı bir şekilde bir (hedef, yapılandırma) çiftidir.
"Yükleme/analiz aşaması" olarak adlandırılır çünkü iki farklı bölüme ayrılabilir. Bu bölümler önceden serileştiriliyordu ancak artık zaman içinde çakışabilir:
- Paketleri yükleme, yani
BUILD
dosyalarını onları temsil edenPackage
nesnelerine dönüştürme - Yapılandırılmış hedefleri analiz etme, yani işlem grafiğini oluşturmak için kuralların uygulanmasını çalıştırma
Komut satırında istenen yapılandırılmış hedeflerin geçişli kapatma işlemindeki her yapılandırılmış hedef, aşağıdan yukarıya doğru analiz edilmelidir. Yani önce yaprak düğümler, ardından komut satırındakiler analiz edilmelidir. Tek bir yapılandırılmış hedefin analizine giren girişler şunlardır:
- Yapılandırma. ("bu kuralın nasıl" oluşturulacağı; örneğin, hedef platformun yanı sıra kullanıcının C++ derleyicisine iletilmesini istediği komut satırı seçenekleri gibi öğeler)
- Doğrudan bağımlılıklar. Geçiş bilgi sağlayıcıları, analiz edilen kural tarafından kullanılabilir. Yapılandırılmış hedefin geçişli kapatma işlemindeki bilgilerin "toplamasını" sağladıkları için bu şekilde adlandırılırlar (ör. sınıf yolu üzerindeki tüm .jar dosyaları veya C++ ikilisine bağlanması gereken tüm .o dosyaları).
- Hedefin kendisi. Bu, hedefin bulunduğu paketin yüklenmesi sonucunda ortaya çıkar. Kurallar söz konusu olduğunda, genellikle önemli olan özellikleri de buna dahildir.
- Yapılandırılan hedefin uygulanması. Kurallar için bu, Starlark veya Java'da olabilir. Kural dışında yapılandırılan tüm hedefler Java'da uygulanır.
Yapılandırılmış bir hedefin analizinden elde edilen çıkış:
- Kendisine bağlı hedefleri yapılandıran geçişli bilgi sağlayıcılar erişebilir
- Oluşturabildiği yapıları ve bu yapıları oluşturan işlemleri.
Java kurallarına sunulan API, Starlark kurallarının ctx
bağımsız değişkeninin eşdeğeri olan RuleContext
bağımsız değişkenidir. API'si daha güçlüdür ancak aynı zamanda Kötü Şeyler™ yapmanın da daha kolay olduğu bir yapıdır. Örneğin, zaman veya alan karmaşıklığı ikinci dereceden (veya daha kötü) olan kod yazmak, Bazel sunucusunu Java istisnasıyla kilitlemek ya da değişmezlikleri ihlal etmek (ör. bir Options
örneğini yanlışlıkla değiştirmek veya yapılandırılmış bir hedefi değişken hale getirmek)
Yapılandırılmış bir hedefin doğrudan bağımlılıklarını belirleyen algoritma DependencyResolver.dependentNodeMap()
içinde bulunur.
Yapılandırmalar
Yapılandırmalar, bir hedefin nasıl oluşturulacağını belirtir: Hangi platform için, hangi komut satırı seçenekleriyle vb.
Aynı hedef, aynı derlemedeki birden fazla yapılandırma için oluşturulabilir. Bu, örneğin derleme sırasında çalıştırılan bir araç ve hedef kod için aynı kod kullanıldığında ve çapraz derleme yaptığımızda veya büyük bir Android uygulaması (birden fazla CPU mimarisi için yerel kod içeren) oluşturduğumuzda kullanışlıdır.
Kavramsal olarak yapılandırma bir BuildOptions
örneğidir. Ancak pratikte BuildOptions
, ek çeşitli işlevler sağlayan BuildConfiguration
tarafından sarmalanır. Bağımlılık grafiğinin üst kısmından alt kısmına doğru yayılır. Değişirse derlemenin yeniden analiz edilmesi gerekir.
Bu durum, örneğin istenen test çalıştırmalarının sayısı değişse bile yalnızca test hedeflerini etkilemesine rağmen derlemenin tamamını yeniden analiz etmeniz gerekmesi gibi anormalliklere neden olur (Bunun olmaması için yapılandırmaları "kırpmayı" planlıyoruz ancak bu henüz hazır değil).
Bir kural uygulamasının yapılandırmadan bir kısmına ihtiyacı olduğunda, RuleClass.Builder.requiresConfigurationFragments()
kullanılarak tanımında bu kısım belirtilmelidir. Bu, hem hataları (ör. Java parçasını kullanan Python kuralları) önlemek hem de yapılandırmayı kısaltmayı kolaylaştırmak içindir. Böylece, Python seçenekleri değişirse C++ hedeflerinin yeniden analiz edilmesi gerekmez.
Bir kuralın yapılandırması, "üst" kuralının yapılandırmasıyla aynı olmayabilir. Bağımlılık kenarındaki yapılandırmayı değiştirme işlemine "yapılandırma geçişi" adı verilir. Bu durum iki yerde gerçekleşebilir:
- Bağımlılık kenarında. Bu geçişler
Attribute.Builder.cfg()
içinde belirtilir ve birRule
(geçişin gerçekleştiği yer) ile birBuildOptions
(orijinal yapılandırma) arasından bir veya daha fazlaBuildOptions
'ye (çıktı yapılandırması) giden işlevlerdir. - Yapılandırılmış bir hedefe gelen herhangi bir kenarda. Bunlar
RuleClass.Builder.cfg()
içinde belirtilir.
İlgili sınıflar TransitionFactory
ve ConfigurationTransition
'dir.
Yapılandırma geçişleri kullanılır. Örneğin:
- Belirli bir bağımlığın derleme sırasında kullanıldığını ve bu nedenle yürütme mimarisinde oluşturulması gerektiğini belirtmek için
- Belirli bir bağımlığın birden fazla mimari için derlenmesi gerektiğini belirtmek için (ör. büyük Android APK'larındaki yerel kod için)
Bir yapılandırma geçişi birden fazla yapılandırmayla sonuçlanırsa buna bölünmüş geçiş denir.
Yapılandırma geçişleri Starlark'ta da uygulanabilir (belgelendirme)
Geçiş bilgi sağlayıcıları
Geçiş bilgi sağlayıcıları, yapılandırılmış hedeflerin kendisine bağlı olan diğer yapılandırılmış hedefler hakkında bilgi vermesinin bir yoludur (ve _tek_ yoludur). Adında "geçişli" ifadesinin bulunmasının nedeni, genellikle yapılandırılmış bir hedefin geçişli kapatmasının bir tür toplama işlemi olmasıdır.
Java geçişli bilgi sağlayıcıları ile Starlark bilgi sağlayıcıları arasında genellikle 1:1 bir ilişki vardır (DefaultInfo
hariç. Bu API, Java bilgi sağlayıcısının doğrudan transliterasyonundan daha Starlark tarzında olduğu için FileProvider
, FilesToRunProvider
ve RunfilesProvider
'ın bir birleşimidir).
Anahtarları aşağıdakilerden biridir:
- Java sınıfı nesnesi. Bu özellik yalnızca Starlark'tan erişilemeyen sağlayıcılar tarafından kullanılabilir. Bu sağlayıcılar,
TransitiveInfoProvider
sınıfının alt sınıfıdır. - Dize. Bu yöntem eskidir ve ad çakışmasına yol açabileceğinden kullanılması önerilmez. Bu tür geçişli bilgi sağlayıcılar,
build.lib.packages.Info
sınıfının doğrudan alt sınıflarıdır . - Sağlayıcı sembolü. Bu,
provider()
işlevi kullanılarak Starlark'tan oluşturulabilir ve yeni sağlayıcılar oluşturmanın önerilen yoludur. Bu simge Java'daProvider.Key
örneğiyle temsil edilir.
Java'da uygulanan yeni sağlayıcılar BuiltinProvider
kullanılarak uygulanmalıdır.
NativeProvider
desteği sonlandırıldı (henüz kaldırmaya zamanımız olmadı) ve TransitiveInfoProvider
alt sınıflarına Starlark'tan erişilemez.
Yapılandırılmış hedefler
Yapılandırılmış hedefler RuleConfiguredTargetFactory
olarak uygulanır. Java'da uygulanan her kural sınıfı için bir alt sınıf vardır. Starlark tarafından yapılandırılan hedefler StarlarkRuleConfiguredTargetUtil.buildRule()
üzerinden oluşturulur .
Yapılandırılmış hedef fabrikalar, döndürülen değerlerini oluşturmak için RuleConfiguredTargetBuilder
kullanmalıdır. Bu rapor aşağıdakilerden oluşur:
- "Bu kuralın temsil ettiği dosya grubu" şeklindeki belirsiz bir kavram olan
filesToBuild
. Bunlar, yapılandırılmış hedef komut satırında veya bir genrule'nin srcs bölümündeyken derlenen dosyalardır. - Normal ve veri çalıştırma dosyaları.
- Çıkış grupları. Bunlar, kuralın oluşturabileceği çeşitli "diğer dosya kümeleri"dir. Bunlara BUILD'deki filegroup kuralının output_group özelliği ve Java'daki
OutputGroupInfo
sağlayıcısı kullanılarak erişilebilir.
Çalışma dosyaları
Bazı ikili dosyaların çalışması için veri dosyalarına ihtiyacı vardır. Giriş dosyalarına ihtiyaç duyan testler buna örnek gösterilebilir. Bu, Bazel'de "runfiles" kavramıyla temsil edilir. "Çalışma dosyası ağacı", belirli bir ikili dosyanın veri dosyalarının dizin ağacıdır. Dosya sisteminde, çıkış ağaçları kaynağındaki dosyaları işaret eden ayrı simge bağlantıları içeren bir simge bağlantısı ağacı olarak oluşturulur.
Bir çalışma dosyası grubu, Runfiles
örneği olarak temsil edilir. Kavramsal olarak, runfiles ağacındaki bir dosyanın yolundan, dosyayı temsil eden Artifact
örneğine giden bir haritadır. İki nedenden dolayı tek bir Map
'ten biraz daha karmaşıktır:
- Bir dosyanın runfiles yolu çoğu zaman execpath ile aynıdır. Bu yöntemi, RAM'den tasarruf etmek için kullanırız.
- Runfiles ağaçlarında, temsil edilmesi gereken çeşitli eski giriş türleri vardır.
Runfile'ler RunfilesProvider
kullanılarak toplanır: Bu sınıfın bir örneği, yapılandırılmış bir hedefin (ör. kitaplık) runfile'lerini ve onun geçişli kapatma ihtiyaçlarını temsil eder ve iç içe yerleştirilmiş bir küme gibi toplanır (aslında, arka planda iç içe yerleştirilmiş kümeler kullanılarak uygulanır): Her hedef, bağımlılıklarının runfile'lerini birleştirir, kendi runfile'lerini ekler ve elde edilen kümeyi bağımlılık grafiğinde yukarı doğru gönderir. Bir RunfilesProvider
örneği, biri kuralın "data" özelliği aracılığıyla bağımlı olduğu durumlar için, diğeri ise gelen diğer tüm bağımlılık türleri için olmak üzere iki Runfiles
örneği içerir. Bunun nedeni, bir hedefin bazen bir veri özelliği aracılığıyla bağımlı olduğunda farklı çalıştırma dosyaları sunmasıdır. Bu, henüz kaldırmadığımız istenmeyen eski bir davranıştır.
İkili dosyaların çalıştırma dosyaları RunfilesSupport
örneği olarak temsil edilir. RunfilesSupport
, yalnızca bir eşleme olan Runfiles
'den farklı olarak gerçekten oluşturulabilir.Runfiles
Bunun için aşağıdaki ek bileşenler gerekir:
- Giriş çalışma dosyası manifesti. Bu, çalıştırma dosyaları ağacının serileştirilmiş bir açıklamasıdır. Runfiles ağacının içeriği için proxy olarak kullanılır ve Bazel, runfiles ağacının yalnızca manifest içeriği değiştiğinde değiştiğini varsayar.
- Çıkış çalışma dosyası manifesti. Bu, özellikle Windows'ta bazen sembolik bağlantıları desteklemeyen çalışma dosyası ağaçları ile ilgilenen çalışma zamanı kitaplıkları tarafından kullanılır.
- Çalıştırma dosyası aracısı. Bir çalışma dosyası ağacının var olabilmesi için sembolik bağlantı ağacını ve sembolik bağlantıların işaret ettiği yapıyı oluşturmanız gerekir. Bağımlılık kenarlarının sayısını azaltmak için runfiles aracısı, bunların tümünü temsil etmek üzere kullanılabilir.
RunfilesSupport
nesnesinin temsil ettiği çalışma dosyalarını içeren ikili dosyayı çalıştırmak için komut satırı bağımsız değişkenleri.
Yönler
Yönler, "hesaplamayı bağımlılık grafiğinden aşağıya yaymanın" bir yoludur. Bunlar, Bazel kullanıcıları için burada açıklanmıştır. Motivasyon verici bir örnek olarak protokol arabelleklerini verebiliriz: proto_library
kuralı belirli bir dil hakkında bilgi sahibi olmamalıdır. Ancak herhangi bir programlama dilinde protokol arabelleği mesajının (protokol arabelleklerinin "temel birimi") uygulanması, proto_library
kuralına bağlanmalıdır. Böylece, aynı dildeki iki hedef aynı protokol arabelleğine bağlıysa bu arabellek yalnızca bir kez oluşturulur.
Yapılandırılmış hedefler gibi, Skyframe'da SkyValue
olarak temsil edilirler ve yapılandırılmaları, yapılandırılmış hedeflerin yapılandırılmasına çok benzer: RuleContext
'ye erişimi olan ConfiguredAspectFactory
adlı bir fabrika sınıfları vardır ancak yapılandırılmış hedef fabrikalarının aksine, bağlı oldukları yapılandırılmış hedef ve sağlayıcıları hakkında da bilgi sahibidirler.
Bağımlılık grafiğinde aşağı doğru dağıtılan özellik grubu, her özellik için Attribute.Builder.aspects()
işlevi kullanılarak belirtilir. Bu sürece katılan, kafa karıştırıcı isimli birkaç sınıf vardır:
AspectClass
, özelliğin uygulanmasıdır. Java'da (bu durumda alt sınıftır) veya Starlark'ta (bu durumdaStarlarkAspectClass
örneğidir) olabilir.RuleConfiguredTargetFactory
ile benzerdir.AspectDefinition
, boyutun tanımıdır; gerektirdiği sağlayıcıları, sağladığı sağlayıcıları içerir ve uygunAspectClass
örneği gibi uygulamaya dair bir referans içerir.RuleClass
ile benzerdir.AspectParameters
, bağımlılık grafiğinde aşağı doğru dağıtılan bir yönü parametreleştirmenin bir yoludur. Şu anda dize ile dize eşlemesi olarak kullanılmaktadır. Bu özelliğin neden yararlı olduğuna dair iyi bir örnek protokol arabirimleridir: Bir dilin birden fazla API'si varsa protokol arabirimlerinin hangi API için oluşturulması gerektiğine dair bilgiler bağımlılık grafiğinde aşağıya doğru aktarılmalıdır.Aspect
, bağımlılık grafiğinde aşağı doğru yayılan bir yönü hesaplamak için gereken tüm verileri temsil eder. Bu öğe, görünüm sınıfından, tanımından ve parametrelerinden oluşur.RuleAspect
, belirli bir kuralın hangi yönlerinin dağıtılacağını belirleyen işlevdir. Bu birRule
->Aspect
işlevidir.
Beklemediğimiz bir komplikasyon, yönlerin diğer yönlere bağlanabilmesidir. Örneğin, bir Java IDE'nin sınıf yolunu toplayan bir yön, muhtemelen sınıf yolundaki tüm .jar dosyalarını bilmek ister ancak bunların bazıları protokol arabellekleridir. Bu durumda IDE yönü, (proto_library
kuralı + Java proto yönü) çiftine bağlanmak ister.
Yönlere ilişkin özelliklerin karmaşıklığı AspectCollection
sınıfında yakalanır.
Platformlar ve araç zincirleri
Bazel, çok platformlu derlemeleri destekler. Yani, derleme işlemlerinin çalıştırıldığı birden fazla mimari ve kodun derlendiği birden fazla mimari olabilir. Bu mimariler, Bazel terimiyle platformlar olarak adlandırılır (tam dokümanlar burada).
Platform, kısıt ayarları ("CPU mimarisi" kavramı gibi) ile kısıt değerleri ("x86_64" gibi belirli bir CPU gibi) arasındaki bir anahtar/değer eşlemesi ile açıklanır. @platforms
deposunda en sık kullanılan kısıtlama ayarlarının ve değerlerinin bir "sözlüğü" vardır.
Araçlar zinciri kavramı, derlemenin hangi platformlarda çalıştığına ve hangi platformların hedeflendiğine bağlı olarak farklı derleyiciler kullanılması gerekebileceği gerçeğinden kaynaklanır. Örneğin, belirli bir C++ araç zinciri belirli bir işletim sisteminde çalışabilir ve bazı diğer işletim sistemlerini hedefleyebilir. Bazel, belirlenen yürütme ve hedef platforma göre kullanılan C++ derleyiciyi belirlemelidir (araç zincirleriyle ilgili dokümanlar burada).
Bunun için araç zincirleri, destekledikleri yürütme ve hedef platform kısıtlamaları kümesiyle ek açıklamaya sahiptir. Bunun için araç zinciri tanımı iki bölüme ayrılır:
- Bir araç zincirinin desteklediği yürütme ve hedef kısıtlamaları grubunu tanımlayan ve ne tür bir araç zinciri (ör. C++ veya Java) olduğunu belirten bir
toolchain()
kuralı (ikincisitoolchain_type()
kuralı ile gösterilir) - Gerçek araç zincirini açıklayan dile özgü bir kural (ör.
cc_toolchain()
)
Bu işlem, araç zinciri çözümlemesi yapmak için her araç zincirinin kısıtlamalarını bilmemiz gerektiği ve dile özgü *_toolchain()
kuralları bundan çok daha fazla bilgi içerdiği için daha uzun sürer.
Yürütme platformları aşağıdaki yöntemlerden biriyle belirtilir:
register_execution_platforms()
işlevini kullanarak WORKSPACE dosyasında- Komut satırında --extra_execution_platforms komut satırı seçeneğini kullanarak
Kullanılabilir yürütme platformları grubu RegisteredExecutionPlatformsFunction
içinde hesaplanır .
Yapılandırılmış bir hedefin hedef platformu PlatformOptions.computeTargetPlatform()
tarafından belirlenir . Bu, birden fazla hedef platformu desteklemek istediğimiz için platformların listesidir ancak henüz uygulanmamıştır.
Yapılandırılmış bir hedef için kullanılacak araç zinciri grubu ToolchainResolutionFunction
tarafından belirlenir. Aşağıdakilerin işlevidir:
- Kayıtlı araç zincirleri grubu (WORKSPACE dosyasında ve yapılandırmada)
- İstenilen yürütme ve hedef platformlar (yapılandırmada)
- Yapılandırılmış hedef tarafından gereken araç zinciri türleri grubu (
UnloadedToolchainContextKey)
UnloadedToolchainContextKey
içinde, yapılandırılmış hedefin (exec_compatible_with
özelliği) ve yapılandırmanın (--experimental_add_exec_constraints_to_targets
) yürütme platformu kısıtlamaları grubu
Sonuç, temelde araç zinciri türünden (ToolchainTypeInfo
örneği olarak temsil edilir) seçili araç zincirinin etiketine bir eşleme olan bir UnloadedToolchainContext
olur. Araçlar zincirlerini değil, yalnızca etiketlerini içerdiği için "yüklenmemiştir" olarak adlandırılır.
Ardından araç zincirleri ResolvedToolchainContext.load()
kullanılarak yüklenir ve bunları isteyen yapılandırılmış hedefin uygulaması tarafından kullanılır.
Ayrıca, tek bir "ana makine" yapılandırması ve hedef yapılandırmaların --cpu
gibi çeşitli yapılandırma işaretleriyle temsil edildiği eski bir sistemimiz de var . Yukarıdaki sisteme kademeli olarak geçiş yapıyoruz. Kullanıcıların eski yapılandırma değerlerini kullandığı durumları ele almak için eski işaretler ile yeni stil platform kısıtlamaları arasında çeviri yapmak üzere platform eşlemeleri uyguladık.
Kodları PlatformMappingFunction
dilindedir ve Starlark dışında bir "küçük dil" kullanır.
Sınırlamalar
Bazen bir hedefi yalnızca birkaç platformla uyumlu olarak tanımlamak isteyebilirsiniz. Bazel'in bu amaca ulaşmak için maalesef birden fazla mekanizması vardır:
- Kuralla ilgili kısıtlamalar
environment_group()
/environment()
- Platform kısıtlamaları
Kurala özgü kısıtlamalar çoğunlukla Google'da Java kuralları için kullanılır. Bu kısıtlamalar kullanımdan kaldırılıyor ve Bazel'de kullanılamıyor ancak kaynak kodunda bu kısıtlamalara referanslar bulunabilir. Bunu yöneten özelliğe constraints=
denir .
environment_group() ve environment()
Bu kurallar eski bir mekanizmadır ve yaygın olarak kullanılmaz.
Tüm derleme kuralları, hangi "ortamlar" için derlenebileceklerini belirtebilir. Burada "ortam", environment()
kuralının bir örneğidir.
Bir kural için desteklenen ortamlar çeşitli şekillerde belirtilebilir:
restricted_to=
özelliği aracılığıyla. Bu, spesifikasyonun en doğrudan biçimidir; kuralın bu grup için desteklediği tam ortam grubunu belirtir.compatible_with=
özelliği aracılığıyla. Bu, varsayılan olarak desteklenen "standart" ortamlara ek olarak bir kuralın desteklediği ortamları belirtir.- Paket düzeyindeki
default_restricted_to=
vedefault_compatible_with=
özellikleri aracılığıyla. environment_group()
kurallarındaki varsayılan özellikler aracılığıyla. Her ortam, tematik olarak alakalı bir grup eşe (ör. "CPU mimarileri", "JDK sürümleri" veya "mobil işletim sistemleri") aittir. Bir ortam grubunun tanımı,restricted_to=
/environment()
özellikleri tarafından başka şekilde belirtilmediği takdirde bu ortamlardan hangilerinin "varsayılan" olarak destekleneceğini içerir. Bu tür özellikleri olmayan bir kural, tüm varsayılanları devralır.- Kural sınıfı varsayılan ayarıyla. Bu, belirtilen kural sınıfının tüm örnekleri için global varsayılanları geçersiz kılar. Bu, örneğin, her örneğin bu özelliği açıkça belirtmesi gerekmeden tüm
*_test
kurallarını test edilebilir hale getirmek için kullanılabilir.
environment()
normal bir kural olarak uygulanırken environment_group()
hem Target
(EnvironmentGroup
) değil Rule
alt sınıfı hem de Starlark'ta (StarlarkLibrary.environmentGroup()
) varsayılan olarak bulunan ve sonunda aynı ada sahip bir hedef oluşturan bir işlevdir. Bunun nedeni, her ortamın ait olduğu ortam grubunu ve her ortam grubunun varsayılan ortamlarını belirtmesi gerektiğinden ortaya çıkacak döngüsel bağımlılığı önlemektir.
Bir derleme, --target_environment
komut satırı seçeneğiyle belirli bir ortamla sınırlanabilir.
Kısıtlama kontrolü RuleContextConstraintSemantics
ve TopLevelConstraintSemantics
'te uygulanmaktadır.
Platform kısıtlamaları
Bir hedefin hangi platformlarla uyumlu olduğunu açıklamanın mevcut "resmi" yolu, araç zincirlerini ve platformları tanımlamak için kullanılan aynı kısıtlamaları kullanmaktır. Bu özellik, #10945 numaralı pull isteğinde inceleniyor.
Görünürlük
Çok sayıda geliştiricinin bulunduğu büyük bir kod tabanı üzerinde çalışıyorsanız (Google gibi), diğer herkesin kodunuza keyfi olarak bağımlı olmasını önlemek için dikkatli olmanız gerekir. Aksi takdirde, Hyrum'un yasası uyarınca kullanıcılar, uygulama ayrıntıları olarak kabul ettiğiniz davranışlara bağlı kalacak.
Bazel, bunu görünürlük adlı mekanizmayla destekler: Belirli bir hedefe yalnızca görünürlük özelliğini kullanarak güvenilebileceğini belirtebilirsiniz. Bu özellik biraz özeldir çünkü etiketlerin listesi tutulsa da bu etiketler belirli bir hedefe işaretçi yerine paket adları üzerinde bir kalıp kodlayabilir. (Evet, bu bir tasarım hatası.)
Bu, aşağıdaki yerlerde uygulanır:
RuleVisibility
arayüzü, görünürlük beyanını temsil eder. Sabit (tamamen herkese açık veya tamamen gizli) ya da etiket listesi olabilir.- Etiketler, paket gruplarını (önceden tanımlanmış paket listesi), doğrudan paketleri (
//pkg:__pkg__
) veya paketlerin alt ağaçlarını (//pkg:__subpackages__
) ifade edebilir. Bu,//pkg:*
veya//pkg/...
kullanılan komut satırı söz diziminden farklıdır. - Paket grupları kendi hedefleri (
PackageGroup
) ve yapılandırılmış hedefleri (PackageGroupConfiguredTarget
) olarak uygulanır. İstersek bunları basit kurallarla değiştirebiliriz. Mantıkları şu öğelerin yardımıyla uygulanır://pkg/...
gibi tek bir kalıba karşılık gelenPackageSpecification
; tek birpackage_group
'ınpackages
özelliğine karşılık gelenPackageGroupContents
ve birpackage_group
ile onun geçişliincludes
özelliğini toplayanPackageSpecificationProvider
. - Görünürlük etiketi listelerinden bağımlılıklara geçiş,
DependencyResolver.visitTargetVisibility
ve birkaç başka yerde yapılır. - Gerçek kontrol
CommonPrerequisiteValidator.validateDirectPrerequisiteVisibility()
İç içe yerleştirilmiş kümeler
Yapılandırılmış hedefler genellikle bağımlılıklarından bir dosya grubu toplar, kendi dosyalarını ekler ve toplanan grubu, kendisine bağlı olan yapılandırılmış hedeflerin de aynısını yapabilmesi için geçişli bir bilgi sağlayıcısına sarar. Örnekler:
- Derleme için kullanılan C++ üstbilgi dosyaları
- Bir
cc_library
nesnesinin geçişli kapatmasını temsil eden nesne dosyaları - Bir Java kuralının derlenmesi veya çalıştırılması için sınıf yolu klasöründe bulunması gereken .jar dosyası grubu
- Bir Python kuralının geçişli kapatma kümesinde bulunan Python dosyası grubu
Bunu, örneğin List
veya Set
kullanarak basit bir şekilde yaparsak kare şeklinde bellek kullanımıyla karşılaşırız: N kural zinciri varsa ve her kural bir dosya ekliyorsa 1+2+...+N koleksiyon üyesi olur.
Bu sorunun üstesinden gelmek için NestedSet
kavramını geliştirdik. Diğer NestedSet
örneklerinden ve kendi üyelerinden oluşan bir veri yapısıdır. Bu sayede, kümelerden oluşan yönlendirilmiş bir döngüsel olmayan grafik oluşturur. Değişmezler ve üyeleri üzerinde iterasyon yapılabilir. Birden fazla iterasyon sırası (NestedSet.Order
) tanımlarız: ön sipariş, son sipariş, topolojik (bir düğüm her zaman atalarının ardından gelir) ve "önemsizdir ancak her seferinde aynı olmalıdır".
Aynı veri yapısı Starlark'ta depset
olarak adlandırılır.
Yapılar ve İşlemler
Gerçek derleme, kullanıcının istediği çıktıyı oluşturmak için çalıştırılması gereken bir komut grubundan oluşur. Komutlar Action
sınıfının örnekleri olarak, dosyalar ise Artifact
sınıfının örnekleri olarak gösterilir. Bunlar, "işlem grafiği" adı verilen iki parçalı, yönlendirilmiş, döngüsel olmayan bir grafikte düzenlenir.
Yapılar iki türdedir: kaynak yapılar (Bazel çalışmaya başlamadan önce mevcut olan yapılar) ve türetilmiş yapılar (oluşturulması gereken yapılar). Türetilmiş yapı taşları da birden fazla türde olabilir:
- **Normal eserler. **Bu dosyalar, kısayol olarak mtime kullanılarak sağlama toplamalarının hesaplanması yoluyla güncel olup olmadığı açısından kontrol edilir. ctime değişmemişse dosyanın sağlama toplaması hesaplanmaz.
- Çözümlenmemiş sembolik bağlantı yapıları. readlink() çağrısı yapılarak güncel olup olmadıkları kontrol edilir. Normal yapıların aksine, bunlar sarkan simge bağlantıları olabilir. Genellikle bazı dosyaları bir tür arşive paketlemenin ardından kullanılır.
- Ağaç yapıları. Bunlar tek dosyalar değil, dizin ağaçlarıdır. İçlerindeki dosya grubu ve içerikleri kontrol edilerek güncel olup olmadığına bakılır. Bu değerler
TreeArtifact
olarak gösterilir. - Sabit meta veri yapıları. Bu yapılarda yapılan değişiklikler yeniden derlemeyi tetiklemez. Bu, yalnızca derleme damgası bilgileri için kullanılır: Mevcut saat değiştiği için yeniden derleme yapmak istemeyiz.
Kaynak yapıların ağaç yapıları veya çözülmemiş sembolik bağlantı yapıları olmaması için temel bir neden yoktur. Bunun nedeni, henüz bu özelliği uygulamamış olmamızdır (Ancak uygulamamız gerekir. BUILD
dosyasında bir kaynak dizine referans vermek, Bazel'de bilinen ve uzun süredir devam eden birkaç yanlışlık sorunundan biridir. BAZEL_TRACK_SOURCE_DIRECTORIES=1
JVM mülkü tarafından etkinleştirilen ve bu tür durumlarda işe yarayan bir uygulamamız var).
Artifact
'lerin önemli bir türü aracılardır. Bunlar, MiddlemanAction
işlevinin çıkışları olan Artifact
örnekleriyle gösterilir. Bunlar, bazı durumları özel olarak belirtmek için kullanılır:
- Toplayıcı aracılar, yapıları gruplandırmak için kullanılır. Bu, birçok işlem aynı büyük giriş grubunu kullanıyorsa N*M bağımlılık kenarı yerine yalnızca N+M (iç içe yerleştirilmiş kümelerle değiştirilir) bağımlılık kenarı olmasını sağlar.
- Planlama bağımlılığı aracıları, bir işlemin diğerinden önce çalıştırılmasını sağlar.
Bunlar çoğunlukla linting için kullanılır ancak C++ derlemesi için de kullanılır (açıklama için
CcCompilationContext.createMiddleman()
bölümüne bakın). - Runfiles aracıları, bir runfiles ağacının bulunduğundan emin olmak için kullanılır. Böylece, çıkış manifest dosyasına ve runfiles ağacının referans verdiği her yapıya ayrı ayrı bağımlı olmanıza gerek kalmaz.
İşlemler, çalıştırılması gereken bir komut, ihtiyaç duyduğu ortam ve ürettiği çıkışlar olarak anlaşılır. Bir işlemin açıklamasının ana bileşenleri şunlardır:
- Çalıştırılması gereken komut satırı
- İhtiyacı olan giriş yapıları
- Ayarlanması gereken ortam değişkenleri
- Çalıştırılması gereken ortamı (platform gibi) açıklayan ek açıklamalar \
Bazel'in bildiği içeriğe sahip bir dosya yazmak gibi birkaç özel durum daha vardır. Bunlar AbstractAction
sınıfının alt sınıfıdır. Java ve C++'nun kendi işlem türleri (JavaCompileAction
, CppCompileAction
ve CppLinkAction
) olsa da işlemlerin çoğu bir SpawnAction
veya StarlarkAction
'tir (aynıdır, ayrı sınıflar olmamalıdır).
Sonunda her şeyi SpawnAction
'e taşımak istiyoruz; JavaCompileAction
oldukça yakın, ancak C++ .d dosyalarını ayrıştırması ve dahil etme taraması nedeniyle biraz özel bir durum.
İşlem grafiği çoğunlukla Skyframe grafiğine "yerleştirilir": Kavramsal olarak, bir işlemin yürütülmesi ActionExecutionFunction
çağrısı olarak temsil edilir. Bir işlem grafiği bağımlılık kenarından Skyframe bağımlılık kenarına eşleme, ActionExecutionFunction.getInputDeps()
ve Artifact.key()
'te açıklanmaktadır ve Skyframe kenarlarının sayısını düşük tutmak için birkaç optimizasyona sahiptir:
- Türetilmiş yapıların kendi
SkyValue
'leri yoktur. Bunun yerine,Artifact.getGeneratingActionKey()
, onu oluşturan işlemin anahtarını bulmak için kullanılır. - İç içe yerleştirilmiş kümelerin kendi Skyframe anahtarları vardır.
Paylaşılan işlemler
Bazı işlemler, birden fazla yapılandırılmış hedef tarafından oluşturulur. Starlark kuralları, türetilmiş işlemlerini yalnızca yapılandırmalarına ve paketlerine göre belirlenen bir dizine yerleştirmelerine izin verildiğinden daha sınırlıdır (ancak yine de aynı paketteki kurallar çakışabilir). Java'da uygulanan kurallar ise türetilmiş yapıları herhangi bir yere yerleştirebilir.
Bu bir hata olarak kabul edilir ancak örneğin bir kaynak dosyanın bir şekilde işlenmesi gerektiğinde ve bu dosyaya birden fazla kural tarafından referans verildiğinde (el hareketi-el hareketi) yürütme süresinde önemli ölçüde tasarruf sağladığı için bu hatadan kurtulmak gerçekten zordur. Bu, RAM'in bir kısmının kullanılmasına neden olur: Paylaşılan bir işlemin her örneğinin bellekte ayrı ayrı depolanması gerekir.
İki işlem aynı çıkış dosyasını oluşturuyorsa tam olarak aynı olmalıdır: Aynı girişlere, aynı çıkışlara sahip olmalı ve aynı komut satırını çalıştırmalıdır. Bu eşdeğerlik ilişkisi Actions.canBeShared()
içinde uygulanır ve her işleme bakılarak analiz ile yürütme aşamaları arasında doğrulanır.
Bu işlem SkyframeActionExecutor.findAndStoreArtifactConflicts()
içinde uygulanır ve Bazel'de derlemenin "evrensel" bir görünümünü gerektiren az sayıdaki yerden biridir.
Yürütme aşaması
Bazel, bu aşamada çıkış üreten komutlar gibi derleme işlemlerini başlatır.
Bazel, analiz aşamasından sonra ilk olarak hangi yapıların oluşturulması gerektiğini belirler. Bunun mantığı TopLevelArtifactHelper
içinde kodlanmıştır; kabaca söylemek gerekirse, komut satırındaki yapılandırılmış hedeflerin filesToBuild
'ı ve "bu hedef komut satırındaysa bu yapıları derle" ifadesini açıkça belirtmek için özel bir çıkış grubunun içeriğidir.
Sonraki adım, yürütme kökünü oluşturmaktır. Bazel, dosya sistemindeki (--package_path
) farklı konumlardan kaynak paketleri okuma seçeneğine sahip olduğundan, yerel olarak yürütülen işlemlere tam bir kaynak ağacı sağlaması gerekir. Bu işlem SymlinkForest
sınıfı tarafından gerçekleştirilir ve analiz aşamasında kullanılan her hedefi not ederek ve her paketi gerçek konumundaki kullanılan bir hedefle sembolik olarak bağlayan tek bir dizin ağacı oluşturarak çalışır. Alternatif olarak, komutlara doğru yolları iletmek de (--package_path
dikkate alınarak) mümkündür.
Bunun nedeni:
- Bir paket bir paket yolu girişinden diğerine taşındığında işlem komut satırlarını değiştirir (eskiden sık karşılaşılan bir durumdu)
- Bir işlem uzaktan çalıştırıldığında yerel olarak çalıştırıldığından farklı komut satırları oluşur.
- Kullanılan araca özel bir komut satırı dönüşümü gerektirir (Java sınıf yolları ile C++ dahil etme yolları arasındaki farkı göz önünde bulundurun)
- Bir işlemin komut satırının değiştirilmesi, işlem önbelleği girişini geçersiz kılar
--package_path
yavaş yavaş kullanımdan kaldırılıyor
Ardından Bazel, işlem grafiğini (işlemlerden ve bunların giriş ve çıkış yapılarından oluşan iki parçalı, yönlendirilmiş grafik) taramaya ve işlemleri çalıştırmaya başlar.
Her işlemin yürütülmesi, SkyValue
sınıfının ActionExecutionValue
örneğiyle temsil edilir.
Bir işlemin çalıştırılması pahalı olduğundan Skyframe'ın arkasından erişilebilecek birkaç önbelleğe alma katmanımız vardır:
ActionExecutionFunction.stateMap
,ActionExecutionFunction
için Skyframe'ın yeniden başlatılmasını ucuz hale getirecek veriler içeriyor- Yerel işlem önbelleği, dosya sisteminin durumuyla ilgili veriler içerir
- Uzaktan yürütme sistemleri genellikle kendi önbelleğini de içerir.
Yerel işlem önbelleği
Bu önbellek, Skyframe'ın arkasında bulunan başka bir katmandır. Bir işlem Skyframe'da yeniden yürütülse bile yerel işlem önbelleğinde isabet olabilir. Yerel dosya sisteminin durumunu temsil eder ve diske serileştirilir. Bu, yeni bir Bazel sunucusu başlatıldığında Skyframe grafiği boş olsa bile yerel işlem önbelleği isabetlerini alabileceği anlamına gelir.
Bu önbellekte, ActionCacheChecker.getTokenIfNeedToExecute()
yöntemi kullanılarak isabet olup olmadığı kontrol edilir .
Adının aksine, türetilmiş yapının yolundan onu yayınlayan işleme giden bir haritadır. İşlem şu şekilde açıklanır:
- Giriş ve çıkış dosyası grubu ve bunların sağlama toplamı
- "İşlem anahtarı", genellikle yürütülen komut satırı olmakla birlikte genel olarak giriş dosyalarının sağlama toplamı tarafından yakalanmayan her şeyi temsil eder (
FileWriteAction
için yazılan verilerin sağlama toplamı gibi).
Ayrıca, hâlâ geliştirme aşamasında olan ve önbelleğe çok fazla gitmemek için geçişli karma oluşturma işlemleri kullanan, son derece deneysel bir "yukarıdan aşağıya işlem önbelleği" de vardır.
Giriş keşfi ve giriş budama
Bazı işlemler, yalnızca bir giriş grubuna sahip olmaktan daha karmaşıktır. Bir işlemin giriş grubunda yapılan değişiklikler iki şekilde gerçekleşir:
- Bir işlem, yürütülmeden önce yeni girişler keşfedebilir veya girişlerinin bazılarının aslında gerekli olmadığına karar verebilir. C++ bu konudaki standart örnektir. Burada, her dosyayı uzak yürütücülere göndermek zorunda kalmamak için bir C++ dosyasının hangi üstbilgi dosyalarını kullandığı konusunda bilinçli bir tahminde bulunmak daha iyidir. Bu nedenle, her üstbilgi dosyasını "giriş" olarak kaydetmemeyi tercih edebiliriz. Bunun yerine, kaynak dosyayı geçişli olarak dahil edilen üstbilgiler için tarar ve yalnızca bu üstbilgi dosyalarını
#include
ifadelerinde belirtilen girişler olarak işaretleriz (tam bir C önişleyici uygulamak zorunda kalmamak için üstbilgi sayısını olduğundan fazla tahmin ederiz). Bu seçenek şu anda Bazel'de "false" olarak sabitlenmiştir ve yalnızca Google'da kullanılır. - Bir işlem, yürütülmesi sırasında bazı dosyaların kullanılmadığını fark edebilir. C++'da buna ".d dosyaları" denir: Derleyici, hangi üstbilgi dosyalarının kullanıldığını daha sonra belirtir ve Bazel, Make'ten daha kötü bir artımlılığa sahip olmanın utancını yaşamamak için bu gerçeği kullanır. Bu, derleyiciye dayandığı için dahil etme tarayıcısına kıyasla daha iyi bir tahmin sunar.
Bunlar, İşlem'deki yöntemler kullanılarak uygulanır:
Action.discoverInputs()
çağrıldığında Gerekli olduğu belirlenen bir dizi iç içe yerleştirilmiş yapı döndürmelidir. İşlem grafiğinde, yapılandırılmış hedef grafiğinde eşdeğeri olmayan bağımlı kenar olmaması için bunlar kaynak yapıları olmalıdır.- İşlem,
Action.execute()
çağrılarak yürütülür. Action.execute()
işleminin sonunda, Bazel'e girişlerinin tümünün gerekli olmadığını bildirmek içinAction.updateInputs()
çağrılabilir. Kullanılan bir giriş kullanılmamış olarak raporlanırsa bu durum yanlış artımlı derlemelere neden olabilir.
Bir işlem önbelleği yeni bir işlem örneğinde (ör. sunucu yeniden başlatıldıktan sonra oluşturulan) bir isabet döndürdüğünde Bazel, giriş kümesinin daha önce yapılan giriş keşfi ve budama işleminin sonucunu yansıtması için updateInputs()
'yi kendisi çağırır.
Starlark işlemleri, ctx.actions.run()
işlevinin unused_inputs_list=
bağımsız değişkenini kullanarak bazı girişleri kullanılmamış olarak beyan etme olanağı sunar.
İşlemleri çalıştırmanın çeşitli yolları: Stratejiler/İşlem Bağlamları
Bazı işlemler farklı şekillerde çalıştırılabilir. Örneğin, bir komut satırı yerel olarak, yerel olarak ancak çeşitli türde korumalı alanlarda veya uzaktan çalıştırılabilir. Bunu somutlaştıran kavrama ActionContext
(veya Strategy
, çünkü yeniden adlandırma işleminin yarısını başarıyla tamamladık...) denir.
Bir işlem bağlamının yaşam döngüsü aşağıdaki gibidir:
- Yürütme aşaması başladığında
BlazeModule
örneklerine hangi işlem bağlamlarına sahip oldukları sorulur. Bu,ExecutionTool
sınıfının kurucusunda gerçekleşir. İşlem bağlamı türleri,ActionContext
alt arayüzünü belirten ve işlem bağlamının uygulamak zorunda olduğu bir JavaClass
örneğiyle tanımlanır. - Mevcut işlem bağlamları arasından uygun olan seçilir ve
ActionExecutionContext
ileBlazeExecutor
'e yönlendirilir . - İşlemler,
ActionExecutionContext.getContext()
veBlazeExecutor.getStrategy()
kullanarak bağlam ister (bunu yapmanın tek bir yolu olmalıdır…)
Stratejiler, işlerini yapmak için diğer stratejileri çağırabilir. Bu, örneğin, hem yerel hem de uzaktan işlem başlatan ve ardından hangisi önce biterse onu kullanan dinamik stratejide kullanılır.
Kalıcı işleyici süreçlerini (WorkerSpawnStrategy
) uygulayan stratejiler dikkate değerdir. Buradaki fikir, bazı araçların uzun bir başlatma süresine sahip olması ve bu nedenle her işlem için yeni bir işlem başlatmak yerine işlemler arasında yeniden kullanılması gerektiğidir (Bazel, işleyici sürecinin bağımsız istekler arasında gözlemlenebilir durum taşımadığına dair sözünü güvence olarak kullandığından bu, olası bir doğruluk sorununu temsil eder).
Araç değişirse işleyici işleminin yeniden başlatılması gerekir. Bir işleyicinin yeniden kullanılıp kullanılamayacağı, WorkerFilesHash
kullanılarak kullanılan aracın sağlama toplamının hesaplanması ile belirlenir. Bu işlem, işlemin hangi girişlerinin aracın bir bölümünü temsil ettiğini ve hangilerinin girişleri temsil ettiğini bilmeye dayanır. Bu, işlemin yaratıcısı tarafından belirlenir: Spawn.getToolFiles()
ve Spawn
'ın çalıştırma dosyaları aracın bir parçası olarak sayılır.
Stratejiler (veya işlem bağlamları) hakkında daha fazla bilgi:
- İşlem çalıştırmayla ilgili çeşitli stratejiler hakkında bilgi edinmek için burayı ziyaret edin.
- Bir işlemi hem yerel hem de uzaktan çalıştırarak hangisinin önce biteceğini görmek için kullandığımız dinamik strateji hakkında bilgi edinmek için burayı ziyaret edebilirsiniz.
- İşlemleri yerel olarak yürütmenin incelikleri hakkında bilgi edinmek için burayı inceleyin.
Yerel kaynak yöneticisi
Bazel, birçok işlemi paralel olarak çalıştırabilir. Paralel olarak çalıştırılması gereken yerel işlemlerin sayısı işlemden işleme değişir: Bir işlemin gerektirdiği kaynaklar ne kadar fazlaysa yerel makinenin aşırı yüklenmesini önlemek için aynı anda o kadar az örnek çalıştırılmalıdır.
Bu, ResourceManager
sınıfında uygulanır: Her işlemin, gerektirdiği yerel kaynakların tahmini bir ResourceSet
örneği (CPU ve RAM) biçiminde ek açıklamayla belirtilmesi gerekir. Ardından işlem bağlamları yerel kaynaklar gerektiren bir işlem yaptığında ResourceManager.acquireResources()
işlevini çağırır ve gerekli kaynaklar kullanılabilene kadar engellenir.
Yerel kaynak yönetiminin daha ayrıntılı bir açıklamasını burada bulabilirsiniz.
Çıkış dizininin yapısı
Her işlem için çıkış dizininde, çıkışlarını yerleştireceği ayrı bir yer gerekir. Türetilmiş yapıların konumu genellikle aşağıdaki gibidir:
$EXECROOT/bazel-out/<configuration>/bin/<package>/<artifact name>
Belirli bir yapılandırmayla ilişkili dizinin adı nasıl belirlenir? İki istenilen özellik çakışıyor:
- Aynı derlemede iki yapılandırma oluşabilirse her ikisinin de aynı işlemin kendi sürümüne sahip olabilmesi için farklı dizinlere sahip olmaları gerekir. Aksi takdirde, iki yapılandırma aynı çıkış dosyasını üreten bir işlemin komut satırı gibi konularda anlaşamazsa Bazel hangi işlemi seçeceğini bilemez ("işlem çakışması").
- İki yapılandırma "yaklaşık olarak" aynı şeyi temsil ediyorsa aynı ada sahip olmalıdır. Böylece, komut satırları eşleşirse birinde yürütülen işlemler diğerinde yeniden kullanılabilir: Örneğin, Java derleyicisinin komut satırı seçeneklerinde yapılan değişiklikler C++ derleme işlemlerinin yeniden çalıştırılmasına neden olmamalıdır.
Yapılandırma kısaltma sorunuyla benzerlikler gösteren bu sorunu çözmenin temel bir yolunu henüz bulamadık. Seçenekler hakkında daha ayrıntılı bilgiyi burada bulabilirsiniz. Sorunlu olan başlıca alanlar, Starlark kuralları (yazarlarının genellikle Bazel'i çok iyi bilmediği) ve "aynı" çıkış dosyasını oluşturabilecek öğelerin alanına başka bir boyut katan yönlerdir.
Mevcut yaklaşım, Java'da uygulanan yapılandırma geçişlerinin işlem çakışmasına neden olmaması için yapılandırma yolu segmentinin <CPU>-<compilation mode>
olması ve çeşitli son eklerin eklenmesidir. Ayrıca, kullanıcıların işlem çakışmasına neden olmaması için Starlark yapılandırma geçişi grubunun sağlama toplamı eklenir. Bu durum hiç de mükemmel değil. Bu, OutputDirectories.buildMnemonic()
içinde uygulanır ve her yapılandırma parçasının çıkış dizininin adına kendi bölümünü eklemesine dayanır.
Testler
Bazel, test çalıştırma için zengin bir desteğe sahiptir. Şunları destekler:
- Testleri uzaktan çalıştırma (uzak yürütme arka ucu mevcutsa)
- Testleri paralel olarak birden çok kez çalıştırma (flaking'i kaldırmak veya zamanlama verileri toplamak için)
- Testleri bölme (hız için aynı testteki test durumlarını birden fazla işleme bölme)
- Güvenilir olmayan testleri yeniden çalıştırma
- Testleri test paketlerine gruplandırma
Testler, testin nasıl çalıştırılacağını açıklayan bir TestProvider'a sahip olan normal yapılandırılmış hedeflerdir:
- Derlemesi testin çalıştırılmasına neden olan yapılardır. Bu, serileştirilmiş bir
TestResultData
mesajı içeren bir "önbelleğe alma durumu" dosyasıdır. - Testin kaç kez çalıştırılması gerektiği
- Testin bölünmesi gereken parça sayısı
- Testin nasıl çalıştırılması gerektiğiyle ilgili bazı parametreler (test zaman aşımı gibi)
Hangi testlerin çalıştırılacağını belirleme
Hangi testlerin çalıştırılacağını belirlemek ayrıntılı bir süreçtir.
İlk olarak, hedef kalıp ayrıştırma sırasında test paketleri yinelemeli olarak genişletilir. Genişleme TestsForTargetPatternFunction
'te uygulanır. Biraz şaşırtıcı olan bir nokta, bir test paketinde test belirtilmemişse paketteki her testin kastedildiğidir. Bu, test grubu kurallarına $implicit_tests
adlı bir gizli özellik ekleyerek Package.beforeBuild()
'te uygulanır.
Ardından, komut satırı seçeneklerine göre testler boyut, etiketler, zaman aşımı ve dile göre filtrelenir. Bu, TestFilter
içinde uygulanır ve hedef ayrıştırma sırasında TargetPatternPhaseFunction.determineTests()
'ten çağrılır. Sonuç TargetPatternPhaseValue.getTestsToRunLabels()
içine yerleştirilir. Filtrelenebilir kural özelliklerinin yapılandırılamamasının nedeni, bu işlemin analiz aşamasından önce gerçekleşmesidir. Bu nedenle yapılandırma kullanılamaz.
Bu veriler daha sonra BuildView.createResult()
'te daha ayrıntılı şekilde işlenir: Analizi başarısız olan hedefler filtrelenir ve testler özel ve özel olmayan testlere ayrılır. Ardından AnalysisResult
içine yerleştirilir. Bu sayede ExecutionTool
hangi testlerin çalıştırılacağını bilir.
Bu ayrıntılı sürece biraz şeffaflık kazandırmak için komut satırında belirli bir hedef belirtildiğinde hangi testlerin çalıştırıldığını belirtmek üzere tests()
sorgu operatörü (TestsFunction
'te uygulanır) kullanılabilir. Ne yazık ki yeniden uygulandığı için muhtemelen yukarıdakilerden birçok açıdan farklıdır.
Test çalıştırma
Testler, önbellek durumu yapılarını isteyerek çalıştırılır. Bu, bir TestRunnerAction
'ün yürütülmesine neden olur. Bu TestRunnerAction
, testi istenen şekilde çalıştıran --test_strategy
komut satırı seçeneği tarafından seçilen TestActionContext
'ı çağırır.
Testler, kendilerinden ne beklendiğini belirtmek için ortam değişkenlerini kullanan ayrıntılı bir protokole göre çalıştırılır. Bazel'in testlerden ne beklediğini ve testlerin Bazel'den ne beklediğini ayrıntılı olarak burada bulabilirsiniz. En basit haliyle, 0 çıkış kodu başarı, diğer tüm çıkış kodları ise başarısızlık anlamına gelir.
Her test işlemi, önbellek durum dosyasına ek olarak bir dizi başka dosya da oluşturur. Bu günlükler, hedef yapılandırma çıkış dizininin testlogs
adlı alt dizini olan "test günlük dizinine" yerleştirilir:
test.xml
: Test bölümündeki test durumlarını ayrıntılı olarak açıklayan JUnit tarzı bir XML dosyasıtest.log
, testin konsol çıkışı. stdout ve stderr ayrılmış değildir.test.outputs
, "tanımlanmamış çıkış dizini"dir. Terminale yazdıklarının yanı sıra dosya da yayınlamak isteyen testler tarafından kullanılır.
Test yürütme sırasında, normal hedefleri oluştururken yapılamayan iki işlem yapılabilir: özel test yürütme ve çıkış aktarımı.
Bazı testlerin, diğer testlerle paralel olarak değil, özel modda yürütülmesi gerekir. Bu, test kuralına tags=["exclusive"]
ekleyerek veya testi --test_strategy=exclusive
ile çalıştırarak elde edilebilir . Her özel test, "ana" derlemeden sonra testin yürütülmesini isteyen ayrı bir Skyframe çağrısı tarafından çalıştırılır. Bu, SkyframeExecutor.runExclusiveTest()
'te uygulanır.
İşlem tamamlandığında terminal çıkışı dökümü alınan normal işlemlerin aksine, kullanıcı uzun süren bir testin ilerleme durumu hakkında bilgi edinmek için testlerin çıkışının akış şeklinde sunulmasını isteyebilir. Bu, --test_output=streamed
komut satırı seçeneğiyle belirtilir ve farklı testlerin çıktılarının birbirine karışmaması için özel test yürütme anlamına gelir.
Bu, uygun şekilde adlandırılmış StreamedTestOutput
sınıfında uygulanır ve söz konusu testin test.log
dosyasında yapılan değişiklikleri sorgulayarak ve Bazel kurallarının geçerli olduğu terminale yeni baytlar atarak çalışır.
Çalıştırılan testlerin sonuçları, çeşitli etkinlikleri (ör. TestAttempt
, TestResult
veya TestingCompleteEvent
) gözlemleyerek etkinlik arabasında kullanılabilir. Bu sonuçlar, Build Event Protocol'a aktarılır ve AggregatingTestListener
tarafından konsola yayınlanır.
Kapsam koleksiyonu
Kapsam, testler tarafından bazel-testlogs/$PACKAGE/$TARGET/coverage.dat
dosyalarında LCOV biçiminde raporlanır .
Kapsam toplamak için her test yürütme işlemi, collect_coverage.sh
adlı bir komut dosyasına sarılır .
Bu komut dosyası, kapsam toplamayı etkinleştirmek ve kapsam dosyalarının kapsam çalışma zamanları tarafından nereye yazılacağını belirlemek için testin ortamını oluşturur. Ardından testi çalıştırır. Bir testin kendisi birden fazla alt işlem çalıştırabilir ve birden fazla farklı programlama dilinde yazılmış parçalardan (ayrı kapsam toplama çalışma zamanlarıyla) oluşabilir. Sarmalayıcı komut dosyası, gerekirse ortaya çıkan dosyaları LCOV biçimine dönüştürmekten ve bunları tek bir dosyada birleştirmekten sorumludur.
collect_coverage.sh
'ün araya girmesi test stratejileri tarafından yapılır ve collect_coverage.sh
'ün testin girişlerinde olması gerekir. Bu, yapılandırma işareti --coverage_support
değerine çözülen :coverage_support
gizli özelliğiyle gerçekleştirilir (TestConfiguration.TestOptions.coverageSupport
bölümüne bakın).
Bazı diller çevrimdışı enstrümasyon kullanır. Bu durumda, kapsam enstrümasyonu derleme zamanında eklenir (ör. C++). Diğer diller ise online enstrümasyon kullanır. Bu durumda, kapsam enstrümasyonu yürütme zamanında eklenir.
Referans kapsamı da temel kavramlardan biridir. Bu, bir kütüphanenin, ikili programın veya testin kapsamıdır. Bu yöntem, bir ikili programın test kapsamını hesaplamak istediğinizde tüm testlerin kapsamını birleştirmenin yeterli olmaması sorununu çözer. Bunun nedeni, ikili programda herhangi bir teste bağlı olmayan kodlar bulunabilmesidir. Bu nedenle, her ikili için yalnızca kapsam toplanan dosyaları içeren ve kapsamlı satırlar içermeyen bir kapsam dosyası yayınlarız. Bir hedefin temel kapsam dosyası bazel-testlogs/$PACKAGE/$TARGET/baseline_coverage.dat
adresindedir . --nobuild_tests_only
işaretini Bazel'e iletirseniz testlerin yanı sıra ikili dosyalar ve kitaplıklar için de oluşturulur.
Temel kapsam şu anda bozuk.
Her kural için kapsam toplama amacıyla iki dosya grubunu izleriz: enstrümante edilmiş dosya grubu ve enstrümantasyon meta veri dosyası grubu.
Enstrümante edilmiş dosya grubu, enstrümante edilecek bir dosya grubudur. Çevrimiçi kapsam çalışma zamanları için bu, hangi dosyaların enstrümante edileceğine karar vermek üzere çalışma zamanında kullanılabilir. Ayrıca, temel kapsamı uygulamak için de kullanılır.
Enstrümasyon meta veri dosyası grubu, bir testin Bazel'in gerektirdiği LCOV dosyalarını oluşturmak için ihtiyaç duyduğu ek dosya grubudur. Uygulamada bu, çalışma zamanına özgü dosyalardan oluşur. Örneğin, gcc derleme sırasında .gcno dosyaları oluşturur. Kapsam modu etkinse bunlar test işlemlerinin giriş grubuna eklenir.
Kapsamın toplanıp toplanmadığı BuildConfiguration
içinde saklanır. Test işlemini ve işlem grafiğini bu bit'e göre değiştirmenin kolay bir yolu olduğu için bu kullanışlıdır ancak bu bit değiştirilirse tüm hedeflerin yeniden analiz edilmesi gerektiği anlamına da gelir (C++ gibi bazı diller, kapsam toplayabilen kod yayınlamak için farklı derleyici seçenekleri gerektirir. Bu durumda zaten yeniden analiz yapılması gerektiğinden bu sorun biraz hafifletilir).
Kapsam destek dosyaları, çağrı politikası tarafından geçersiz kılınabilmeleri için etiketler aracılığıyla dolaylı bir bağımlılık ilişkisi içinde kullanılır. Bu sayede, Bazel'in farklı sürümleri arasında farklılık gösterebilirler. İdeal olarak bu farklılıklar kaldırılır ve bunlardan biri standartlaştırılır.
Ayrıca, Bazel çağrısında her test için toplanan kapsamı birleştiren bir "kapsam raporu" da oluştururuz. Bu işlem CoverageReportActionFactory
tarafından yönetilir ve BuildView.createResult()
çağrısından alınır . Çalıştırılan ilk testin :coverage_report_generator
özelliğine bakarak ihtiyaç duyduğu araçlara erişir.
Sorgu motoru
Bazel'in, çeşitli grafikler hakkında çeşitli sorular sormak için kullanılan küçük bir dili vardır. Aşağıdaki sorgu türleri sağlanır:
bazel query
, hedef grafiği incelemek için kullanılırbazel cquery
, yapılandırılmış hedef grafiği incelemek için kullanılırbazel aquery
, işlem grafiğini incelemek için kullanılır
Bunların her biri, AbstractBlazeQueryEnvironment
sınıfının alt sınıfı olarak uygulanır.
QueryFunction
sınıfını alt sınıflandırarak ek sorgu işlevleri yapılabilir.
Sorgu sonuçlarını akış olarak gönderebilmek için, sonuçları bir veri yapısında toplamak yerine QueryFunction
işlevine bir query2.engine.Callback
iletilir. QueryFunction
işlevi, döndürmek istediği sonuçlar için bu işlevi çağırır.
Sorgunun sonucu çeşitli şekillerde yayınlanabilir: etiketler, etiketler ve kural sınıfları, XML, protobuf vb. Bunlar, OutputFormatter
sınıfının alt sınıfları olarak uygulanır.
Bazı sorgu çıkış biçimlerinin (proto kesinlikle) hassas bir koşulu, Bazel'in paket yüklemenin sağladığı _tüm_ bilgileri yayınlamasıdır. Böylece, çıkışı karşılaştırabilir ve belirli bir hedefin değişip değişmediğini belirleyebilirsiniz. Sonuç olarak, özellik değerlerinin serileştirilebilir olması gerekir. Bu nedenle, karmaşık Starlark değerlerine sahip özellikler içermeyen özellik türlerinin sayısı çok azdır. Genelde, bir etiket kullanmak ve karmaşık bilgileri bu etiketle kurala eklemek geçici çözüm olarak kullanılır. Bu çözüm pek tatmin edici değil ve bu şartın kaldırılması çok iyi olur.
Modül sistemi
Bazel'e modüller ekleyerek genişletilebilir. Her modül, BlazeModule
alt sınıfını (ad, Bazel'in Blaze olarak adlandırıldığı zamanlardan kalmadır) içermelidir ve bir komutun yürütülmesi sırasında çeşitli etkinlikler hakkında bilgi alır.
Bunlar çoğunlukla, yalnızca Bazel'in bazı sürümlerinin (Google'da kullandığımız sürüm gibi) ihtiyaç duyduğu çeşitli "temel olmayan" işlev parçalarını uygulamak için kullanılır:
- Uzaktan yürütme sistemleriyle arayüzler
- Yeni komutlar
BlazeModule
tarafından sunulan uzantı noktaları grubu biraz gelişigüzel. İyi tasarım ilkelerine örnek olarak kullanmayın.
Etkinlik otobüsü
BlazeModules'in Bazel'in geri kalanıyla iletişim kurmasının ana yolu bir etkinlik arabiriminden (EventBus
) geçer: Her derleme için yeni bir örnek oluşturulur, Bazel'in çeşitli bölümleri buraya etkinlik gönderebilir ve modüller ilgilendikleri etkinlikler için dinleyici kaydedebilir. Örneğin, aşağıdakiler etkinlik olarak temsil edilir:
- Oluşturulacak derleme hedeflerinin listesi belirlendi (
TargetParsingCompleteEvent
) - Üst düzey yapılandırmalar belirlendi (
BuildConfigurationEvent
) - Hedef oluşturuldu (başarılı veya başarısız) (
TargetCompleteEvent
) - Bir test çalıştırıldı (
TestAttempt
,TestSummary
)
Bu etkinliklerin bazıları Bazel dışında Derleme Etkinliği Protokolü'nde temsil edilir (BuildEvent
olarak adlandırılır). Bu sayede, yalnızca BlazeModule
'ler değil, Bazel sürecinin dışındaki öğeler de derlemeyi gözlemleyebilir. Bu mesajlara protokol mesajları içeren bir dosya olarak erişilebilir veya Bazel, etkinlikleri yayınlamak için bir sunucuya (Derleme Etkinliği Hizmeti olarak adlandırılır) bağlanabilir.
Bu işlem, build.lib.buildeventservice
ve build.lib.buildeventstream
Java paketlerinde uygulanır.
Harici depolar
Bazel başlangıçta monorepo'da (bir uygulamayı derlemek için gereken her şeyi içeren tek bir kaynak ağacı) kullanılmak üzere tasarlanmış olsa da Bazel'in bu durumun geçerli olmadığı bir dünyada yaşadığını söyleyebiliriz. "Harici depolar", bu iki dünya arasında köprü oluşturmak için kullanılan bir soyutlamadır: Derleme için gerekli olan ancak ana kaynak ağacında bulunmayan kodu temsil eder.
WORKSPACE dosyası
Harici depo grubu, WORKSPACE dosyası ayrıştırılarak belirlenir. Örneğin, şöyle bir beyan:
local_repository(name="foo", path="/foo/bar")
@foo
adlı depoda sonuçlar kullanılabilir. Bunun karmaşık hale gelmesinin nedeni, Starlark dosyalarında yeni depo kuralları tanımlanabilmesidir. Bu kurallar daha sonra yeni Starlark kodu yüklemek için kullanılabilir. Bu kod da yeni depo kuralları tanımlamak için kullanılabilir.
Bu durumu ele almak için WORKSPACE dosyasının (WorkspaceFileFunction
içinde) ayrıştırması, load()
ifadeleriyle tanımlanan parçalara bölünür. Parça dizini WorkspaceFileKey.getIndex()
ile gösterilir ve X dizine kadar WorkspaceFileFunction
hesaplamak, X. load()
ifadesine kadar değerlendirmek anlamına gelir.
Depoları getirme
Deponun kodu Bazel'in kullanımına sunulmadan önce getirilmelidir. Bu durumda Bazel, $OUTPUT_BASE/external/<repository name>
altında bir dizin oluşturur.
Depoyu getirme işlemi aşağıdaki adımlarda gerçekleşir:
PackageLookupFunction
, bir depoya ihtiyacı olduğunu fark eder veSkyKey
olarakRepositoryName
oluşturur. Bu,RepositoryLoaderFunction
'ı çağırır.RepositoryLoaderFunction
, isteği belirsiz nedenlerleRepositoryDelegatorFunction
'e yönlendirir (kodda bunun Skyframe'ın yeniden başlatılması durumunda öğelerin yeniden indirilmesini önlemek için olduğu belirtilir ancak bu çok sağlam bir gerekçe değildir)RepositoryDelegatorFunction
, istenen depo bulunana kadar WORKSPACE dosyasının parçalarını iterleyerek getirmesi istenen depo kuralını bulur- Depo getirmeyi uygulayan uygun
RepositoryFunction
bulunur. Bu, deponun Starlark uygulaması veya Java'da uygulanan depolar için sabit kodlanmış bir haritadır.
Bir deposu getirme işlemi çok pahalı olabileceğinden çeşitli önbelleğe alma katmanları vardır:
- İndirilen dosyalar için sağlamalarına (
RepositoryCache
) göre anahtarlanmış bir önbellek vardır. Bunun için sağlamanın WORKSPACE dosyasında bulunması gerekir ancak bu, hermetiklik açısından zaten iyi bir şeydir. Bu, hangi çalışma alanında veya çıkış tabanında çalıştırıldığından bağımsız olarak aynı iş istasyonundaki her Bazel sunucu örneği tarafından paylaşılır. $OUTPUT_BASE/external
altında her depo için, depoyu getirmek için kullanılan kuralın sağlama toplamını içeren bir "işaretçi dosyası" yazılır. Bazel sunucusu yeniden başlatılırsa ancak sağlama toplamı değişmezse yeniden getirilmez. Bu özellikRepositoryDelegatorFunction.DigestWriter
'te uygulanır .--distdir
komut satırı seçeneği, indirilecek yapıları aramak için kullanılan başka bir önbelleği belirtir. Bu, Bazel'in internetten rastgele öğeler getirmemesi gereken kurumsal ayarlarda kullanışlıdır. Bu,DownloadManager
tarafından uygulanır .
Bir depo indirildikten sonra, içindeki yapıların kaynak yapı olarak değerlendirilmesi gerekir. Bazel genellikle kaynak yapıların güncelliğini kontrol etmek için stat() işlevini çağırır. Bu yapıların bulunduğu deposun tanımı değiştiğinde de yapıların geçerliliği iptal edilir. Bu nedenle, bu durum bir sorun teşkil eder. Bu nedenle, harici bir depoda bulunan bir yapının FileStateValue
'lerinin, harici depolarına bağlı olması gerekir. Bu işlem ExternalFilesHelper
tarafından yönetilir.
Yönetilen dizinler
Bazen harici depoların, Workspace kök dizininin altındaki dosyaları (ör. indirilen paketleri kaynak ağacın bir alt dizininde barındıran bir paket yöneticisi) değiştirmesi gerekir. Bu, Bazel'in kaynak dosyaların yalnızca kullanıcı tarafından değiştirildiği ve kendisi tarafından değiştirilmediği varsayımı ile çelişir ve paketlerin, çalışma alanı kökünün altındaki her dizine başvurmasına olanak tanır. Bu tür harici depoların çalışmasını sağlamak için Bazel iki şey yapar:
- Kullanıcının, Bazel'in erişmesine izin verilmeyen Workspace alt dizinlerini belirtmesine olanak tanır. Bunlar
.bazelignore
adlı bir dosyada listelenir ve işlevBlacklistedPackagePrefixesFunction
'te uygulanır. - Workspace'in alt dizininden, yönetildiği harici depolamaya giden eşlemeyi
ManagedDirectoriesKnowledge
olarak kodlarız ve bunlara atıfta bulunanFileStateValue
'leri normal harici depolar için olduğu gibi yönetiriz.
Depo eşlemeleri
Birden fazla deposun aynı depoya bağlı olmak istemesi ancak farklı sürümlerde olması (bu, "elmas bağımlılık sorunu"nun bir örneğidir) Örneğin, derlemedeki ayrı depolardaki iki ikili dosya Guava'ya bağımlı olmak istiyorsa muhtemelen her ikisi de Guava'yı @guava//
ile başlayan etiketlerle ifade eder ve bunun Guava'nın farklı sürümleri anlamına gelmesini bekler.
Bu nedenle Bazel, harici depo etiketlerini yeniden eşlemenize olanak tanır. Böylece @guava//
dizesi, bir ikili dosyanın deposundaki bir Guava deposunu (@guava1//
gibi) ve diğer ikili dosyanın deposundaki başka bir Guava deposunu (@guava2//
gibi) referans alabilir.
Alternatif olarak, elmasları birleştirmek için de kullanılabilir. Bir depo @guava1//
'e, diğer depo ise @guava2//
'a bağlıysa depo eşleme, standart bir @guava//
deposu kullanmak için her iki depoyu da yeniden eşlemenize olanak tanır.
Eşleme, WORKSPACE dosyasında tekil depo tanımları için repo_mapping
özelliği olarak belirtilir. Ardından Skyframe'da WorkspaceFileValue
üyesi olarak görünür ve aşağıdakilerle bağlanır:
Package.Builder.repositoryMapping
, paketteki kuralların etiket değerine sahip özellikleriniRuleClass.populateRuleAttributeValues()
tarafından dönüştürmek için kullanılır.- Analiz aşamasında kullanılan
Package.repositoryMapping
(yükleme aşamasında ayrıştırılmayan$(location)
gibi öğeleri çözmek için) - load() ifadelerindeki etiketleri çözmek için
BzlLoadFunction
JNI bitleri
Bazel'in sunucusu _çoğunlukla_ Java ile yazılmıştır. Java'nın tek başına yapamadığı veya uyguladığımızda tek başına yapamadığı kısımlar istisnadır. Bu, çoğunlukla dosya sistemiyle etkileşim, işlem kontrolü ve diğer çeşitli düşük düzey işlemlerle sınırlıdır.
C++ kodu src/main/native altında bulunur ve yerel yöntemlere sahip Java sınıfları şunlardır:
NativePosixFiles
veNativePosixFileSystem
ProcessUtils
WindowsFileOperations
veWindowsFileProcesses
com.google.devtools.build.lib.platform
Konsol çıkışı
Konsol çıkışı yayınlamak basit bir şey gibi görünse de birden fazla işlemin (bazen uzaktan) çalıştırılması, ayrıntılı önbelleğe alma, güzel ve renkli bir terminal çıkışı elde etme ve uzun süre çalışan bir sunucuya sahip olma isteği, bu işlemin basit olmadığını gösterir.
RPC çağrısı istemciden geldikten hemen sonra, içine yazdırılan verileri istemciye yönlendiren iki RpcOutputStream
örnek (stdout ve stderr için) oluşturulur. Bunlar daha sonra bir OutErr
içine (bir (stdout, stderr) çifti) alınır. Konsolda yazdırılması gereken her şey bu akışlardan geçer. Ardından bu akışlar BlazeCommandDispatcher.execExclusively()
'e aktarılır.
Çıkış varsayılan olarak ANSI kod dışı bırakma sıralarıyla yazdırılır. Bunlar istenmediğinde (--color=no
) AnsiStrippingOutputStream
tarafından kaldırılır. Ayrıca System.out
ve System.err
bu çıkış akışlarına yönlendirilir.
Bunun nedeni, hata ayıklama bilgilerinin System.err.println()
kullanılarak basılabilmesi ve yine de istemcinin terminal çıkışına (sunucununkinden farklı) gönderilebilmesidir. Bir işlem ikili çıkış (bazel query --output=proto
gibi) üretiyorsa stdout'un karıştırılmamasına dikkat edilir.
Kısa mesajlar (hatalar, uyarılar ve benzeri) EventHandler
arayüzü üzerinden ifade edilir. Bunlar, EventBus
'te yayınlanan içeriklerden farklıdır (bu durum kafa karıştırıcıdır). Her Event
'ün bir EventKind
(hata, uyarı, bilgi ve birkaçı daha) ve Location
(kaynak kodda etkinliğin gerçekleşmesine neden olan yer) olabilir.
Bazı EventHandler
uygulamaları, aldıkları etkinlikleri depolar. Bu, önbelleğe alınmış çeşitli işlemlerden (ör. önbelleğe alınmış yapılandırılmış bir hedef tarafından yayınlanan uyarılar) kaynaklanan bilgileri kullanıcı arayüzünde yeniden oynatmak için kullanılır.
Bazı EventHandler
'ler, sonunda etkinlik arabasına ulaşan etkinliklerin yayınlanmasına da izin verir (normal Event
'ler burada _görünmez_). Bunlar ExtendedEventHandler
'ün uygulamalarıdır ve ana kullanım alanları, önbelleğe alınmış EventBus
etkinliklerini yeniden oynatmaktır. Bu EventBus
etkinliklerinin tümü Postable
'u uygular ancak EventBus
'te yayınlanan her şey bu arayüzü uygulamaz. Yalnızca bir ExtendedEventHandler
tarafından önbelleğe alınanlar bu arayüzü uygular (bunun yapılması iyi olur ve çoğu şey bunu yapar ancak zorunlu tutulmaz).
Terminal çıkışı çoğunlukla UiEventHandler
üzerinden yayınlanır. UiEventHandler
, Bazel'in yaptığı tüm süslü çıkış biçimlendirmesinden ve ilerleme raporlarından sorumludur. İki girişi vardır:
- Etkinlik otobüsü
- Reporter aracılığıyla aktarılan etkinlik akışı
Komut yürütme mekanizmasının (örneğin, Bazel'in geri kalanı) istemciye giden RPC akışıyla tek doğrudan bağlantısı, bu akışlara doğrudan erişime olanak tanıyan Reporter.getOutErr()
üzerindendir. Yalnızca bir komutun büyük miktarda olası ikili veriyi (bazel query
gibi) dökmesi gerektiğinde kullanılır.
Bazel'i profilleme
Bazel hızlıdır. Bazel de yavaştır çünkü derlemeler, dayanılabilirliğin sınırına kadar büyür. Bu nedenle Bazel, derlemeleri ve Bazel'in kendisini profillemek için kullanılabilecek bir profilleyici içerir. Profiler
adlı bir sınıfta uygulanır. Varsayılan olarak etkindir ancak ek yükünün tolere edilebilir olması için yalnızca kısaltılmış verileri kaydeder. Komut satırı--record_full_profiler_data
, mümkün olan her şeyi kaydetmesini sağlar.
Chrome profilleyici biçiminde bir profil oluşturur. Bu profil en iyi şekilde Chrome'da görüntülenir. Veri modeli, görev yığınlarına benzer: Görevler başlatılabilir ve sonlandırılabilir ve bunların birbirine düzgün bir şekilde yerleştirilmesi gerekir. Her Java iş parçacığı kendi görev yığınını alır. TODO: Bu, işlemler ve devam etme aktarma stiliyle nasıl çalışır?
Profilleyici sırasıyla BlazeRuntime.initProfiler()
ve BlazeRuntime.afterCommand()
'te başlatılır ve durdurulur. Her şeyi profilleyebilmemiz için mümkün olduğunca uzun süre etkin olmaya çalışır. Profilinize bir şey eklemek için Profiler.instance().profile()
numaralı telefonu arayın. Kapanış değeri görevin sonunu temsil eden bir Closeable
döndürür. En iyi performansı try-with-resources ifadeleriyle gösterir.
MemoryProfiler
'te basit bellek profilleme de yapıyoruz. Ayrıca her zaman açıktır ve çoğunlukla maksimum yığın boyutlarını ve GC davranışını kaydeder.
Bazel'i test etme
Bazel'de iki ana test türü vardır: Bazel'i "kara kutu" olarak gözlemleyen ve yalnızca analiz aşamasını çalıştıran testler. İlkine "entegrasyon testleri", ikincisine ise "birim testleri" diyoruz. Ancak bunlar daha az entegre olan entegrasyon testlerine daha çok benziyor. Gerektiği durumlarda gerçek birim testlerimiz de vardır.
İki tür entegrasyon testi vardır:
src/test/shell
altında çok ayrıntılı bir bash test çerçevesi kullanılarak uygulananlar- Java'da uygulananlar. Bunlar
BuildIntegrationTestCase
sınıfının alt sınıfları olarak uygulanır.
BuildIntegrationTestCase
, çoğu test senaryosu için iyi donanıma sahip olduğundan tercih edilen entegrasyon testi çerçevesidir. Java çerçevesi olduğundan hata ayıklama özelliğine sahiptir ve yaygın olarak kullanılan birçok geliştirme aracıyla sorunsuz entegrasyon sağlar. Bazel deposunda birçok BuildIntegrationTestCase
sınıfı örneği vardır.
Analiz testleri, BuildViewTestCase
sınıfının alt sınıfları olarak uygulanır. BUILD
dosyaları yazmak için kullanabileceğiniz bir geçici dosya sistemi vardır. Ardından çeşitli yardımcı yöntemler, yapılandırılan hedefleri isteyebilir, yapılandırmayı değiştirebilir ve analizin sonucuyla ilgili çeşitli iddialarda bulunabilir.