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

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

このチュートリアルでは、サンプル シナリオを使用して、C++ ツールチェーンを構築しました。これは、 C++ プロジェクトの例 これは、clang を使用してエラーなしでビルドします。

学習内容

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

  • ビルド環境をセットアップする
  • C++ ツールチェーンを構成する
  • Starlark ルールを作成して、追加の Bazel でアプリケーションをビルドできるように、cc_toolchain の構成 参加者: clang
  • 次のコマンドを実行して、期待される結果を確認する Linux マシン上の bazel build --config=clang_config //main:hello-world
  • C++ アプリケーションをビルドする

始める前に

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

このチュートリアルでは、Linux を使用していて、 C++ アプリケーションをインストールし、適切なツールとライブラリをインストールしました。 このチュートリアルでは、システムにインストールできる clang version 9.0.1 を使用します。

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

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

  2. ダウンロード: C++ プロジェクトの例 ローカルマシン上の空のディレクトリに配置します。

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

    cc_binary(
        name = "hello-world",
        srcs = ["hello-world.cc"],
    )
    
  4. 次の構成ファイルを含む .bazelrc ファイルを、ワークスペース ディレクトリのルートに作成します。 次の内容で、--config フラグの使用を有効にします。

    # 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 の場合、コマンドライン フラグ --config={config_name} はその特定のフラグに関連付けられています。詳しくは、 使用するフラグについては、次のドキュメントをご覧ください。 crosstool_top cpuhost_crosstool_top

ターゲットを構築するとき Bazel は、bazel build --config=clang_config //main:hello-world で カスタム ツールチェーンを cc_toolchain_suite //toolchain:clang_suite。スイートによっては、 ツールチェーン、 そのためフラグ --cpu=k8 で区別されます。

Bazel は、次のような C++ で記述された内部ツールをビルド時に使用するため、 process-wrapper の場合は、既存のデフォルトの C++ ツールチェーンが そのため、ツールの構築にはツールチェーンではなく、ツールチェーンを使用した 作成します。

C++ ツールチェーンの構成

C++ ツールチェーンを構成するには、アプリケーションを繰り返しビルドし、 以下で説明するように 1 つずつ処理します。

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

    bazel build --config=clang_config //main:hello-world
    

    環境変数で --crosstool_top=//toolchain:clang_suite を指定したためです。 .bazelrc ファイルがあると、Bazel は次のエラーをスローします。

    No such package `toolchain`: BUILD file not found on package path.
    

    ワークスペース ディレクトリに、パッケージの toolchain ディレクトリを作成します。 toolchain ディレクトリ内には空の BUILD ファイルがあります。

  2. ビルドを再度実行します。toolchain パッケージでは、まだ依存関係が定義されていないため、 clang_suite ターゲットの場合、Bazel は次のエラーをスローします。

    No such target '//toolchain:clang_suite': target 'clang_suite' not declared
    in package 'toolchain' defined by .../toolchain/BUILD
    

    toolchain/BUILD ファイルで、空のファイル グループを次のように定義します。

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

    '//toolchain:clang_suite' does not have mandatory providers: 'ToolchainInfo'
    

    Bazel は、--crosstool_top フラグが以下のルールを指していることを検出しました。 必要な ToolchainInfo が提供されていない 接続します。そのため、--crosstool_top で特定の値を提供するルールを ToolchainInfo - これは cc_toolchain_suite ルールです。 toolchain/BUILD ファイル内で、空のファイル グループを次の内容に置き換えます。

    cc_toolchain_suite(
        name = "clang_suite",
        toolchains = {
            "k8": ":k8_toolchain",
        },
    )
    

    toolchains 属性は、自動的に --cpu をマッピングし、 --compiler など)の値を cc_toolchain に設定します。まだ購入できません。 cc_toolchain ターゲットを定義した場合、Bazel はそれについてエラーを返します 後ほど説明します。

  4. ビルドを再度実行します。Bazel は次のエラーをスローします。

    Rule '//toolchain:k8_toolchain' does not exist
    

    次に、cc_toolchain cc_toolchain_suite.toolchains 属性。次の内容を追加します: toolchain/BUILD ファイル:

    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,
    )
    
  5. ビルドを再度実行します。Bazel は次のエラーをスローします。

    Rule '//toolchain:k8_toolchain_config' does not exist
    

    次に、「:k8_ツールチェーン_config」をtoolchain/BUILD ファイルにターゲットを設定します。

    filegroup(name = "k8_toolchain_config")
    
  6. ビルドを再度実行します。Bazel は次のエラーをスローします。

    '//toolchain:k8_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 ルールを使用するには、負荷を ステートメントを toolchains/BUILD に追加します。

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

    そして、「k8_ツールチェーン_config」をファイルグループの宣言が cc_toolchain_config ルール:

    cc_toolchain_config(name = "k8_toolchain_config")
    
  7. ビルドを再度実行します。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 が正しいパスであることを確認する 選択します

  8. ビルドを再度実行します。Bazel は次のエラーをスローします。

     ..../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 は、含まれているヘッダーを検索する場所を認識する必要があります。他にも この問題は、includes 属性を使用するなど、複数の方法で解決できます。 cc_binary ですが、ここでは、 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-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,
     )
    
  9. ビルドコマンドを再度実行すると、次のようなエラーが表示されます。

    /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 属性を使用するなどです。この場合、 ツールチェーンを使用するターゲットでは、 指定します。

    次のコードを 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",
          "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],
      )
    
  10. bazel build --config=clang_config //main:hello-world を実行すると、 構築します。

作業内容を確認する

このチュートリアルでは基本的な C++ ツールチェーンの構成方法を学びましたが、 ツールチェーンは、この簡単な例よりも強力です。

重要なポイントは次のとおりです。 - コマンドラインで --crosstool_top フラグを指定する必要があります。 cc_toolchain_suite を指す - .bazelrc を使用して特定の設定のショートカットを作成できます。 ファイル - cc_ツールチェーン_suite は、異なる CPU や異なるために cc_toolchains をリストする場合があります。 サポートしています。--cpu などのコマンドライン フラグを使用して、区別できます。 - ツールが存在する場所をツールチェーンに通知する必要がある。このチュートリアルの内容 簡易版では システムからツールにアクセスできます条件 より自己完結型のアプローチに関心がある場合は、 こちらをご覧ください。ツールの元になるのは 各ワークスペースでファイルを利用できるようにし 次のような属性のターゲット依存関係を持つ cc_toolchaincompiler_filestool_paths も変更する必要があります。 - 機能を作成して、渡すフラグをカスタマイズできる さまざまなアクションを指定できます。

関連情報

詳しくは、 C++ ツールチェーン構成