このチュートリアルでは、プロジェクトの C++ ツールチェーンを構成する方法について、サンプル シナリオを使用して説明します。
学習内容
このチュートリアルでは、以下の方法について学習します。
- ビルド環境を設定する
--toolchain_resolution_debugを使用してツールチェーンの解決をデバッグする- C++ ツールチェーンを構成する
-
cc_toolchainの追加構成を提供する Starlark ルールを作成して、Bazel がclangでアプリケーションをビルドできるようにする - Linux マシンで
を実行して、 の C++ バイナリをビルドする
bazel build //main:hello-world bazel build //main:hello-world --platforms=//:android_x86_64を実行して、android 用のバイナリをクロスコンパイルする
始める前に
このチュートリアルでは、Linux を使用し、C++
アプリケーションを正常にビルドして、適切なツールとライブラリをインストールしていることを前提としています。このチュートリアルでは、
clang version 16 を使用します。これはシステムにインストールできます。
ビルド環境を設定する
ビルド環境を次のように設定します。
まだ行っていない場合は、Bazel 7.0.2 以降をダウンロードしてインストールします。
ルートフォルダに空の
MODULE.bazelファイルを追加します。次の
cc_binaryターゲットをmain/BUILDファイルに追加します。cc_binary( name = "hello-world", srcs = ["hello-world.cc"], )Bazel は、ビルド中に C++ で記述された多くの内部ツールを使用するため、既存のデフォルトの C++ ツールチェーンがホスト プラットフォームに指定されます。
process-wrapperこれにより、これらの内部ツールは、このチュートリアルで作成した ツールチェーンを使用してビルドできます。したがって、cc_binaryターゲット もデフォルトのツールチェーンでビルドされます。次のコマンドでビルドを実行します。
bazel build //main:hello-worldMODULE.bazelにツールチェーンが登録されていなくても、ビルドは成功します。内部の動作を確認するには、次を実行します。
bazel build //main:hello-world --toolchain_resolution_debug='@bazel_tools//tools/cpp:toolchain_type' INFO: ToolchainResolution: Target platform @@platforms//host:host: Selected execution platform @@platforms//host:host, type @@bazel_tools//tools/cpp:toolchain_type -> toolchain @@bazel_tools+cc_configure_extension+local_config_cc//:cc-compiler-k8--platformsを指定しない場合、Bazel は@platforms//hostを使用して@bazel_tools+cc_configure_extension+local_config_cc//:cc-compiler-k8のターゲットをビルドします。
C++ ツールチェーンを構成する
C++ ツールチェーンを構成するには、アプリケーションを繰り返しビルドし、 次の説明に従って各エラーを 1 つずつ解消します。
また、clang version 9.0.1 を使用していることを前提としていますが、clang のバージョンが異なっても詳細が大きく変わることはありません。
次を追加します。
toolchain/BUILDfilegroup(name = "empty") cc_toolchain( name = "linux_x86_64_toolchain", toolchain_identifier = "linux_x86_64-toolchain", toolchain_config = ":linux_x86_64_toolchain_config", all_files = ":empty", compiler_files = ":empty", dwp_files = ":empty", linker_files = ":empty", objcopy_files = ":empty", strip_files = ":empty", supports_param_files = 0, ) toolchain( name = "cc_toolchain_for_linux_x86_64", toolchain = ":linux_x86_64_toolchain", toolchain_type = "@bazel_tools//tools/cpp:toolchain_type", exec_compatible_with = [ "@platforms//cpu:x86_64", "@platforms//os:linux", ], target_compatible_with = [ "@platforms//cpu:x86_64", "@platforms//os:linux", ], )次に、適切な依存関係を追加し、
MODULE.bazelに次を使用してツールチェーンを登録します。bazel_dep(name = "platforms", version = "0.0.10") register_toolchains( "//toolchain:cc_toolchain_for_linux_x86_64" )このステップでは、
cc_toolchainを定義し、ホスト構成のtoolchainターゲットにバインドします。もう一度ビルドを実行します。
toolchainパッケージでlinux_x86_64_toolchain_configターゲットがまだ定義されていないため、Bazel は次のエラーをスローします。ERROR: toolchain/BUILD:4:13: in toolchain_config attribute of cc_toolchain rule //toolchain:linux_x86_64_toolchain: rule '//toolchain:linux_x86_64_toolchain_config' does not exist.toolchain/BUILDファイルで、次のように空の filegroup を定義します。package(default_visibility = ["//visibility:public"]) filegroup(name = "linux_x86_64_toolchain_config")もう一度ビルドを実行します。Bazel は次のエラーをスローします。
'//toolchain:linux_x86_64_toolchain_config' does not have mandatory providers: 'CcToolchainConfigInfo'.CcToolchainConfigInfoは、C++ ツールチェーンの構成に使用するプロバイダです。このエラーを修正するには、次の内容でtoolchain/cc_toolchain_config.bzlファイルを作成して、Bazel にCcToolchainConfigInfoを提供する Starlark ルールを作成します。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()は、必要なプロバイダCcToolchainConfigInfoを作成します。cc_toolchain_configルールを使用するには、package ステートメントの直下のtoolchain/BUILDに load ステートメントを追加します。load(":cc_toolchain_config.bzl", "cc_toolchain_config")また、「linux_x86_64_toolchain_config」filegroup を宣言 の
cc_toolchain_configルールに置き換えます。cc_toolchain_config(name = "linux_x86_64_toolchain_config")もう一度ビルドを実行します。Bazel は次のエラーをスローします。
.../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`この時点で、Bazel はコードのビルドを試行するのに十分な情報を取得していますが、 必要なビルドアクションを完了するために使用するツールはまだわかりません。Starlark ルールの実装を変更して、使用する ツールを Bazel に伝えます。そのためには、
tool_path()コンストラクタが@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzlから必要です。# 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/clangと/usr/bin/ldが システムの正しいパスであることを確認します。もう一度ビルドを実行します。Bazel は次のエラーをスローします。
ERROR: main/BUILD:3:10: Compiling main/hello-world.cc failed: absolute path inclusion(s) found in rule '//main:hello-world': the source file 'main/hello-world.cc' includes the following non-builtin files with absolute paths (if these are builtin files, make sure these paths are in your toolchain): '/usr/include/c++/13/ctime' '/usr/include/x86_64-linux-gnu/c++/13/bits/c++config.h' '/usr/include/x86_64-linux-gnu/c++/13/bits/os_defines.h' ...Bazel は、インクルード ヘッダーを検索する場所を把握する必要があります。これを解決する方法はいくつかあります。たとえば、
cc_binaryのincludes属性を使用する方法がありますが、ここではcc_common.create_cc_toolchain_config_infoのcxx_builtin_include_directoriesパラメータを使用して、ツールチェーン レベルで解決します。clangのバージョンが異なる場合、インクルード パスは 異なります。これらのパスは、ディストリビューションによって異なる場合もあります。toolchain/cc_toolchain_config.bzlの戻り値を次のように変更します 。return cc_common.create_cc_toolchain_config_info( ctx = ctx, cxx_builtin_include_directories = [ # NEW "/usr/lib/llvm-16/lib/clang/16/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, )ビルドコマンドをもう一度実行すると、次のようなエラーが表示されます。
/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'これは、リンカーに C++ 標準 ライブラリがなく、そのシンボルが見つからないためです。これを解決する方法はいくつかあります。 たとえば、
linkopts属性をcc_binary使用する方法があります。ここでは、ツールチェーンを使用するターゲットでこの フラグを指定する必要がないようにすることで 解決します。次のコードを
toolchain/cc_toolchain_config.bzlにコピーします。# 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", # NEW "flag_group", # NEW "flag_set", # NEW "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 //main:hello-worldを実行すると、最終的にホストのバイナリが正常にビルドされます。toolchain/BUILDで、cc_toolchain_config、cc_toolchain、toolchainターゲットをコピーし、ターゲット名でlinux_x86_64をandroid_x86_64に置き換えます。MODULE.bazelで、android のツールチェーンを登録します。register_toolchains( "//toolchain:cc_toolchain_for_linux_x86_64", "//toolchain:cc_toolchain_for_android_x86_64" )bazel build //main:hello-world --android_platforms=//toolchain:android_x86_64を実行して、 Android 用のバイナリをビルドします。
実際には、Linux と Android で C++ ツールチェーンの構成が異なります。既存の cc_toolchain_config を変更して違いを反映させるか、プラットフォームごとに個別のルール（CcToolchainConfigInfo プロバイダ）を作成します。
実施したタスクを確認する
このチュートリアルでは、基本的な C++ ツールチェーンを構成する方法について説明しましたが、 ツールチェーンはこれよりも強力です。
重要な学習ポイント:
- Bazel がプラットフォームで同じ制約値のツールチェーンを解決するには、コマンドラインで一致する
platformsフラグを指定する必要があります。言語固有の構成フラグについて詳しくは、ドキュメントをご覧ください。 - ツールチェーンにツールの場所を知らせる必要があります。このチュートリアルでは、システムからツールにアクセスする簡略版を使用します。自己完結型の方法に関心がある場合は、
外部依存関係をご覧ください。ツールは別のモジュールから取得できるため、
cc_toolchainなどの属性のターゲット依存関係を使用して、compiler_filesでファイルを使用できるようにする必要があります。tool_pathsも変更する必要があります。 - 機能を作成して、リンクやその他のタイプのアクションなど、 さまざまなアクションに渡すフラグをカスタマイズできます。
関連情報
詳しくは、C++ ツールチェーン の構成をご覧ください。