Bu eğitimde, bir proje için C++ araç zincirlerinin nasıl yapılandırılacağını açıklamak üzere örnek bir senaryo kullanılmaktadır. clang kullanılarak hatasız oluşturulan bir örnek C++ projesine dayanır.
Neler öğreneceksiniz?
Bu eğitimde şunları öğreneceksiniz:
- Derleme ortamını ayarlama
- C++ araç zincirini yapılandırma
cc_toolchainiçin ek yapılandırma sağlayan bir Starlark kuralı oluşturun. Böylece Bazel, uygulamayıclangile derleyebilir.- Linux makinede
bazel build --config=clang_config //main:hello-worldkomutunu çalıştırarak beklenen sonucu onaylayın. - C++ uygulamasını oluşturma
Başlamadan önce
Derleme ortamını ayarlama
Bu eğitimde, Linux kullandığınız ve C++ uygulamalarını başarıyla oluşturup uygun araçları ve kitaplıkları yüklediğiniz varsayılır.
Eğitimde clang version 9.0.1 kullanılır. Bunu sisteminize yükleyebilirsiniz.
Derleme ortamınızı aşağıdaki gibi ayarlayın:
Henüz yapmadıysanız Bazel 0.23 veya sonraki bir sürümünü indirip yükleyin.
GitHub'dan örnek C++ projesini indirip yerel makinenizdeki boş bir dizine yerleştirin.
main/BUILDdosyasına aşağıdakicc_binaryhedefini ekleyin:cc_binary( name = "hello-world", srcs = ["hello-world.cc"], )--configişaretinin kullanılmasını sağlamak için çalışma alanı dizininin kök dizininde aşağıdaki içeriklere sahip bir.bazelrcdosyası oluşturun:# Use our custom-configured c++ toolchain. build:clang_config --crosstool_top=//toolchain:clang_suite # Use --cpu as a differentiator. build:clang_config --cpu=k8 # Use the default Bazel C++ toolchain to build the tools used during the # build. build:clang_config --host_crosstool_top=@bazel_tools//tools/cpp:toolchain
build:{config_name} --flag=value girişi için komut satırı işareti --config={config_name} söz konusu işaretle ilişkilendirilir. Kullanılan işaretlerle ilgili dokümanlara göz atın:
crosstool_top,
cpu ve
host_crosstool_top.
bazel build --config=clang_config //main:hello-world ile hedefinizi oluşturduğunuzda Bazel, //toolchain:clang_suite cc_toolchain_suite'ten özel araç zincirinizi kullanır. Pakette farklı CPU'lar için farklı toolchain'ler listelenebilir. Bu nedenle, paket --cpu=k8 işaretiyle ayırt edilir.
Bazel, derleme sırasında C++ ile yazılmış birçok dahili araç (ör. process-wrapper) kullandığından, bu araçların bu eğitimde oluşturulan araç zinciri yerine önceden var olan varsayılan C++ araç zinciri kullanılarak oluşturulması için ana makine platformu için önceden var olan varsayılan C++ araç zinciri belirtilir.
C++ araç zincirini yapılandırma
C++ araç zincirini yapılandırmak için uygulamayı tekrar tekrar oluşturun ve her hatayı aşağıda açıklandığı şekilde tek tek giderin.
Aşağıdaki komutla derlemeyi çalıştırın:
bazel build --config=clang_config //main:hello-world.bazelrcdosyasında--crosstool_top=//toolchain:clang_suitebelirttiğiniz için Bazel aşağıdaki hatayı verir:No such package `toolchain`: BUILD file not found on package path.Çalışma alanı dizininde, paket için
toolchaindizinini vetoolchaindizininin içinde boş birBUILDdosyası oluşturun.Derlemeyi tekrar çalıştırın.
toolchainpaketi henüzclang_suitehedefini tanımlamadığından Bazel aşağıdaki hatayı verir:No such target '//toolchain:clang_suite': target 'clang_suite' not declared in package 'toolchain' defined by .../toolchain/BUILDtoolchain/BUILDdosyasında boş bir dosya grubu tanımlayın:package(default_visibility = ["//visibility:public"]) filegroup(name = "clang_suite")Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
'//toolchain:clang_suite' does not have mandatory providers: 'ToolchainInfo'Bazel,
--crosstool_topişaretinin gerekliToolchainInfosağlayıcısını sağlamayan bir kurala işaret ettiğini tespit etti. Bu nedenle,--crosstool_topöğesiniToolchainInfosağlayan bir kurala, yanicc_toolchain_suitekuralına yönlendirmeniz gerekir.toolchain/BUILDdosyasında boş dosya grubunu aşağıdakilerle değiştirin:cc_toolchain_suite( name = "clang_suite", toolchains = { "k8": ":k8_toolchain", }, )toolchainsözelliği,--cpu(ve belirtilmişse--compiler) değerlerini otomatik olarakcc_toolchainile eşler. Henüz herhangi bircc_toolchainhedef tanımlamadınız ve Bazel kısa süre içinde bu konuda hata verecek.Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
Rule '//toolchain:k8_toolchain' does not existŞimdi
cc_toolchain_suite.toolchainsözelliğindeki her değer içincc_toolchainhedeflerini tanımlamanız gerekir.toolchain/BUILDdosyasına aşağıdakileri ekleyin:filegroup(name = "empty") cc_toolchain( name = "k8_toolchain", toolchain_identifier = "k8-toolchain", toolchain_config = ":k8_toolchain_config", all_files = ":empty", compiler_files = ":empty", dwp_files = ":empty", linker_files = ":empty", objcopy_files = ":empty", strip_files = ":empty", supports_param_files = 0, )Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
Rule '//toolchain:k8_toolchain_config' does not existArdından,
toolchain/BUILDdosyasına bir ":k8_toolchain_config" hedefi ekleyin:filegroup(name = "k8_toolchain_config")Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
'//toolchain:k8_toolchain_config' does not have mandatory providers: 'CcToolchainConfigInfo'CcToolchainConfigInfo, C++ araç zincirlerinizi yapılandırmak için kullandığınız bir sağlayıcıdır. Bu hatayı düzeltmek için aşağıdaki içeriğe sahip birtoolchain/cc_toolchain_config.bzldosyası oluşturarak Bazel'eCcToolchainConfigInfosağlayan bir Starlark kuralı oluşturun:def _impl(ctx): return cc_common.create_cc_toolchain_config_info( ctx = ctx, toolchain_identifier = "k8-toolchain", host_system_name = "local", target_system_name = "local", target_cpu = "k8", target_libc = "unknown", compiler = "clang", abi_version = "unknown", abi_libc_version = "unknown", ) cc_toolchain_config = rule( implementation = _impl, attrs = {}, provides = [CcToolchainConfigInfo], )cc_common.create_cc_toolchain_config_info()gerekli sağlayıcıyı oluştururCcToolchainConfigInfo.cc_toolchain_configkuralını kullanmak için paket ifadesinin hemen altınatoolchain/BUILDyükleme ifadesi ekleyin:load(":cc_toolchain_config.bzl", "cc_toolchain_config")Ayrıca "k8_toolchain_config" filegroup'u bir
cc_toolchain_configkuralı bildirimiyle değiştirin:cc_toolchain_config(name = "k8_toolchain_config")Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
.../BUILD:1:1: C++ compilation of rule '//:hello-world' failed (Exit 1) src/main/tools/linux-sandbox-pid1.cc:421: "execvp(toolchain/DUMMY_GCC_TOOL, 0x11f20e0)": No such file or directory Target //:hello-world failed to build`Bu noktada Bazel, kodu oluşturmayı denemek için yeterli bilgiye sahiptir ancak gerekli derleme işlemlerini tamamlamak için hangi araçların kullanılacağını hâlâ bilmemektedir. Starlark kuralı uygulamasını, Bazel'e hangi araçların kullanılacağını söyleyecek şekilde değiştireceksiniz. Bunun için
@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzladresindeki tool_path() oluşturucusuna ihtiyacınız vardır:# toolchain/cc_toolchain_config.bzl: # NEW load("@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzl", "tool_path") def _impl(ctx): tool_paths = [ # NEW tool_path( name = "gcc", path = "/usr/bin/clang", ), tool_path( name = "ld", path = "/usr/bin/ld", ), tool_path( name = "ar", path = "/usr/bin/ar", ), tool_path( name = "cpp", path = "/bin/false", ), tool_path( name = "gcov", path = "/bin/false", ), tool_path( name = "nm", path = "/bin/false", ), tool_path( name = "objdump", path = "/bin/false", ), tool_path( name = "strip", path = "/bin/false", ), ] return cc_common.create_cc_toolchain_config_info( ctx = ctx, toolchain_identifier = "local", host_system_name = "local", target_system_name = "local", target_cpu = "k8", target_libc = "unknown", compiler = "clang", abi_version = "unknown", abi_libc_version = "unknown", tool_paths = tool_paths, # NEW )/usr/bin/clangve/usr/bin/ld'nin sisteminiz için doğru yollar olduğundan emin olun.Derlemeyi tekrar çalıştırın. Bazel aşağıdaki hatayı veriyor:
..../BUILD:3:1: undeclared inclusion(s) in rule '//main:hello-world': this rule is missing dependency declarations for the following files included by 'main/hello-world.cc': '/usr/include/c++/9/ctime' '/usr/include/x86_64-linux-gnu/c++/9/bits/c++config.h' '/usr/include/x86_64-linux-gnu/c++/9/bits/os_defines.h' ....Bazel'ın dahil edilen üstbilgileri nerede arayacağını bilmesi gerekir. Bunu çözmenin birden fazla yolu vardır. Örneğin,
cc_binaryöğesininincludesözelliği kullanılabilir. Ancak burada bu sorun,cc_common.create_cc_toolchain_config_infoöğesinincxx_builtin_include_directoriesparametresiyle araç zinciri düzeyinde çözülür.clang'nın farklı bir sürümünü kullanıyorsanız ekleme yolunun farklı olacağını unutmayın. Bu yollar, dağıtıma bağlı olarak da farklılık gösterebilir.toolchain/cc_toolchain_config.bzliçindeki dönüş değerini aşağıdaki gibi değiştirin:return cc_common.create_cc_toolchain_config_info( ctx = ctx, cxx_builtin_include_directories = [ # NEW "/usr/lib/llvm-9/lib/clang/9.0.1/include", "/usr/include", ], toolchain_identifier = "local", host_system_name = "local", target_system_name = "local", target_cpu = "k8", target_libc = "unknown", compiler = "clang", abi_version = "unknown", abi_libc_version = "unknown", tool_paths = tool_paths, )Derleme komutunu tekrar çalıştırın. Şuna benzer bir hata görürsünüz:
/usr/bin/ld: bazel-out/k8-fastbuild/bin/main/_objs/hello-world/hello-world.o: in function `print_localtime()': hello-world.cc:(.text+0x68): undefined reference to `std::cout'Bunun nedeni, bağlayıcıda C++ standart kitaplığının olmaması ve sembollerinin bulunamamasıdır. Bu sorunu çözmenin birçok yolu vardır. Örneğin,
cc_binaryöğesininlinkoptsözelliğini kullanabilirsiniz. Burada, araç zincirini kullanan herhangi bir hedefin bu işareti belirtmesi gerekmediğinden emin olunarak sorun çözülür.Aşağıdaki kodu
cc_toolchain_config.bzlkonumuna kopyalayın:# NEW load("@bazel_tools//tools/build_defs/cc:action_names.bzl", "ACTION_NAMES") # NEW load( "@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzl", "feature", "flag_group", "flag_set", "tool_path", ) all_link_actions = [ # NEW ACTION_NAMES.cpp_link_executable, ACTION_NAMES.cpp_link_dynamic_library, ACTION_NAMES.cpp_link_nodeps_dynamic_library, ] def _impl(ctx): tool_paths = [ tool_path( name = "gcc", path = "/usr/bin/clang", ), tool_path( name = "ld", path = "/usr/bin/ld", ), tool_path( name = "ar", path = "/bin/false", ), tool_path( name = "cpp", path = "/bin/false", ), tool_path( name = "gcov", path = "/bin/false", ), tool_path( name = "nm", path = "/bin/false", ), tool_path( name = "objdump", path = "/bin/false", ), tool_path( name = "strip", path = "/bin/false", ), ] features = [ # NEW feature( name = "default_linker_flags", enabled = True, flag_sets = [ flag_set( actions = all_link_actions, flag_groups = ([ flag_group( flags = [ "-lstdc++", ], ), ]), ), ], ), ] return cc_common.create_cc_toolchain_config_info( ctx = ctx, features = features, # NEW cxx_builtin_include_directories = [ "/usr/lib/llvm-9/lib/clang/9.0.1/include", "/usr/include", ], toolchain_identifier = "local", host_system_name = "local", target_system_name = "local", target_cpu = "k8", target_libc = "unknown", compiler = "clang", abi_version = "unknown", abi_libc_version = "unknown", tool_paths = tool_paths, ) cc_toolchain_config = rule( implementation = _impl, attrs = {}, provides = [CcToolchainConfigInfo], )bazel build --config=clang_config //main:hello-worldkomutunu çalıştırırsanız nihayet oluşturulur.
Çalışmanızı inceleme
Bu eğitimde, temel bir C++ araç zincirini nasıl yapılandıracağınızı öğrendiniz. Ancak araç zincirleri bu basit örnekten daha güçlüdür.
Önemli noktalar:
- Komut satırında --crosstool_top işaretini belirtmeniz gerekir. Bu işaret, cc_toolchain_suite konumunu göstermelidir.
- .bazelrc dosyasını kullanarak belirli bir yapılandırma için kısayol oluşturabilirsiniz.
- cc_toolchain_suite, farklı CPU'lar ve derleyiciler için cc_toolchains değerini listeleyebilir. Farklılaştırmak için --cpu gibi komut satırı işaretlerini kullanabilirsiniz.
- Araç zincirine araçların nerede bulunduğunu bildirmeniz gerekir. Bu eğitimin basitleştirilmiş versiyonunda, araçlara sistemden erişebilirsiniz. Daha bağımsız bir yaklaşımla ilgileniyorsanız çalışma alanları hakkında bilgi edinmek için burayı inceleyebilirsiniz. Araçlarınız farklı bir çalışma alanından geliyorsa dosyalarını, cc_toolchain için kullanılabilir hale getirmeniz gerekir. Bu işlemde, compiler_files gibi özelliklere yönelik hedef bağımlılıklar kullanılır. tool_paths de değiştirilmelidir.
- Bağlantı oluşturma veya başka bir işlem türü olsun, farklı işlemlere hangi işaretlerin iletileceğini özelleştirmek için özellikler oluşturabilirsiniz.
Daha fazla bilgi
Daha fazla bilgi için C++ toolchain yapılandırması başlıklı makaleyi inceleyin.