このチュートリアルでは、サンプル シナリオを使用して、プロジェクトの C++ ツールチェーンを構成する方法について説明します。
学習内容
このチュートリアルでは、次の方法について学習します。
- ビルド環境を設定する
--toolchain_resolution_debugを使用してツールチェーンの解決をデバッグする- C++ ツールチェーンを構成する
- Bazel が
clangを使用してアプリケーションをビルドできるように、cc_toolchainの追加構成を指定する Starlark ルールを作成します。 - Linux マシンで
bazel build //main:hello-worldを実行して C++ バイナリをビルドする 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 はビルド中に
process-wrapperなど、C++ で記述された多くの内部ツールを使用するため、ホスト プラットフォームに既存のデフォルトの C++ ツールチェーンが指定されます。これにより、これらの内部ツールは、このチュートリアルで作成した toolchain を使用してビルドできるようになります。したがって、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 は@bazel_tools+cc_configure_extension+local_config_cc//:cc-compiler-k8を使用して@platforms//hostのターゲットをビルドします。
C++ ツールチェーンを構成する
C++ ツールチェーンを構成するには、アプリケーションを繰り返しビルドし、次のようにエラーを 1 つずつ排除します。
また、clang version 9.0.1 を前提としていますが、詳細は clang のバージョンによってわずかに異なる場合があります。
次で
toolchain/BUILDを追加:filegroup(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で toolchain を登録します。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ファイルで、空のファイル グループを次のように定義します。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ルールを使用するには、パッケージ ステートメントのすぐ下のtoolchain/BUILDに読み込みステートメントを追加します。load(":cc_toolchain_config.bzl", "cc_toolchain_config")また、「linux_x86_64_toolchain_config」ファイルグループを
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 に指示します。そのためには、
@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzlのtool_path()コンストラクタが必要です。# 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++ 標準ライブラリがないため、シンボルが見つからないためです。これを解決するには、
cc_binaryのlinkopts属性を使用するなど、多くの方法があります。ここでは、ツールチェーンを使用するターゲットがこのフラグを指定する必要がないようにすることで解決します。次のコードを
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フラグを指定する必要があります。ドキュメントには、言語固有の構成フラグに関する詳細が記載されています。 - ツールが存在する場所をツールチェーンに通知する必要があります。このチュートリアルでは、システムからツールにアクセスする簡易版があります。より自己完結型のアプローチに興味がある場合は、外部依存関係をご覧ください。ツールは別のモジュールから取得できます。その場合は、
compiler_filesなどの属性にターゲット依存関係を指定して、cc_toolchainでそのファイルを使用できるようにする必要があります。tool_pathsも変更する必要があります。 - リンクやその他のタイプのアクションなど、さまざまなアクションに渡すフラグをカスタマイズする特徴を作成できます。
関連情報
詳細については、C++ ツールチェーンの構成をご覧ください。