Bazel チュートリアル: C++ ツールチェーンを構成する

<ph type="x-smartling-placeholder"></ph> 問題を報告する <ph type="x-smartling-placeholder"></ph> ソースを表示 夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

このチュートリアルでは、サンプル シナリオを使用して、C++ ツールチェーンを構築しました。

学習内容

このチュートリアルでは、次の方法について学びます。

  • ビルド環境をセットアップする
  • --toolchain_resolution_debug を使用してツールチェーンの解決をデバッグする
  • C++ ツールチェーンを構成する
  • ファイアウォール ルールに対して追加構成を行う Starlark ルールを cc_toolchain: Bazel が clang でアプリケーションをビルドできるようにします。
  • bazel build //main:hello-world を実行して、C++ バイナリをビルドします。 Linux マシン
  • bazel build //main:hello-world --platforms=//:android_x86_64 を実行して、Android のバイナリをクロスコンパイルします。

始める前に

このチュートリアルでは、Linux を使用していて、C++ を正しくビルドしていることを前提としています 適切なツールとライブラリをインストールしました。チュートリアル システムにインストールできる clang version 16 を使用します。

ビルド環境をセットアップする

ビルド環境を次のように設定します。

  1. まだインストールしていない場合は、Bazel をダウンロードしてインストールします。 7.0.2 以降。

  2. ルートフォルダに空の MODULE.bazel ファイルを追加します。

  3. 次の cc_binary ターゲットを main/BUILD ファイルに追加します。

    cc_binary(
        name = "hello-world",
        srcs = ["hello-world.cc"],
    )
    

    Bazel は、C++ で記述された多くの内部ツールをビルド時に使用するため、 process-wrapper の場合、既存のデフォルトの C++ ツールチェーンが指定されます。 設定することもできます。これにより、これらの内部ツールはそれを使って ツールチェーンと同じコードを使用します。したがって、cc_binary ターゲットは デフォルトのツールチェーンでビルドされます。

  4. 次のコマンドを使用してビルドを実行します。

    bazel build //main:hello-world
    

    MODULE.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 を前提としていますが、詳細は変更されるだけです。 若干異なることがあります。

  1. 次で 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

    bazel_dep(name = "platforms", version = "0.0.10")
    register_toolchains(
        "//toolchain:cc_toolchain_for_linux_x86_64"
    )
    

    このステップでは、cc_toolchain を定義し、それを toolchain ターゲットにバインドします。 ホスト構成を変更できます。

  2. ビルドを再度実行します。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.
    
  3. toolchain/BUILD ファイルで、空のファイル グループを次のように定義します。

    package(default_visibility = ["//visibility:public"])
    
    filegroup(name = "linux_x86_64_toolchain_config")
    
  4. ビルドを再度実行します。Bazel は次のエラーをスローします。

    '//toolchain:linux_x86_64_toolchain_config' does not have mandatory providers: 'CcToolchainConfigInfo'.
    

    CcToolchainConfigInfo は、C++ の構成に使用するプロバイダです。 統合できます。このエラーを修正するには、Starlark ルールを作成して 次のようにして、CcToolchainConfigInfo を Bazel に割り当てます。 次の内容の toolchain/cc_toolchain_config.bzl ファイル:

    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() により、必要なプロバイダが作成されます。 CcToolchainConfigInfocc_toolchain_config ルールを使用するには、負荷を ステートメントを package ステートメントのすぐ下にある toolchain/BUILD に追加します。

    load(":cc_toolchain_config.bzl", "cc_toolchain_config")
    

    そして、"linux_x86_64_ツールチェーン_config"を宣言を含むファイルグループ cc_toolchain_config ルールの場合:

    cc_toolchain_config(name = "linux_x86_64_toolchain_config")
    
  5. ビルドを再度実行します。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 が次の文字列の正しいパスであることを確認します。 できます。

  6. ビルドを再度実行します。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_binaryincludes 属性を使用するなど) これはツールチェーン レベルで cxx_builtin_include_directories パラメータ cc_common.create_cc_toolchain_config_info を指定します。ただし、 別のバージョンの 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,
    )
    
  7. ビルドコマンドを再度実行すると、次のようなエラーが表示されます。

    /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_binarylinkopts 属性を使用するなどです。この場合、 ツールチェーンを使用するターゲットではこの指定が不要になるように 設定されます。

    次のコードを 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],
    )
    
  8. bazel build //main:hello-world を実行すると、最終的にバイナリがビルドされるはずです。 正常にホストされます。

  9. toolchain/BUILD で、cc_toolchain_configcc_toolchain、 ターゲットを toolchain 個、linux_x86_64android_x86_64 に置き換えます。 指定します。

    MODULE.bazel で、Android のツールチェーンを登録する

    register_toolchains(
        "//toolchain:cc_toolchain_for_linux_x86_64",
        "//toolchain:cc_toolchain_for_android_x86_64"
    )
    
  10. bazel build //main:hello-world --android_platforms=//toolchain:android_x86_64 を実行して、次のバイナリをビルドします。 Android。

実際には、Linux と Android では異なる C++ ツールチェーン構成を使用する必要があります。マイページ 差分のために既存の cc_toolchain_config を変更するか、 個別のルール(CcToolchainConfigInfo プロバイダなど)を 説明します。

作業内容を確認する

このチュートリアルでは基本的な C++ ツールチェーンの構成方法を学びましたが、 ツールチェーンのほうが優れています。

重要な学習ポイント:

  • 一致する platforms フラグをコマンドラインで指定する必要があります。 Bazel で解決し、同じ制約値でツールチェーンに解決する必要があります。 できます。ドキュメントには、特定の言語に関する詳しい情報が記載されており、 構成フラグを使用できます。
  • ツールが存在する場所をツールチェーンに通知する必要があります。このチュートリアルの内容 簡易版では システムからツールにアクセスできます条件 より自己完結型のアプローチに関心がある場合は、 外部依存関係。ツールの元になるのは 別のモジュールに展開する場合、そのファイルを cc_toolchain は、次のような属性のターゲット依存関係に置き換えます。 compiler_filestool_paths も変更する必要があります。
  • 機能を作成して、どのフラグを渡すかをカスタマイズできます。 さまざまなアクションを指定できます。

関連情報

詳細については、C++ ツールチェーン 構成