C / C++ ルール

ルール

cc_binary

cc_binary(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, copts, defines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, includes, licenses, linkopts, linkshared, linkstatic, local_defines, malloc, nocopts, output_licenses, restricted_to, stamp, tags, target_compatible_with, testonly, toolchains, visibility, win_def_file)

暗黙的な出力ターゲット

  • name.stripped(明示的にリクエストされた場合にのみビルド): バイナリのストリップされたバージョン。strip -g がバイナリに対して実行され、デバッグ シンボルが削除されます。追加の削除オプションは、コマンドラインで --stripopt=-foo を使用して指定できます。この出力は、明示的にリクエストされた場合にのみビルドされます。
  • name.dwp(明示的にリクエストされた場合のみビルド): 分離が有効になっている場合: リモートにデプロイされたバイナリのデバッグに適したデバッグ情報パッケージ ファイル。それ以外の場合は空のファイル。

引数

属性
name

Name; required

このターゲットの一意の名前。

deps

List of labels; optional

バイナリ ターゲットにリンクする他のライブラリのリスト。

cc_library または objc_library のターゲットになります。

srcs

List of labels; optional

ターゲットを作成するために処理された C および C++ ファイルのリスト。これらは C/C++ ソースファイルとヘッダー ファイルであり、非生成ファイル(通常のソースコード)または生成されたものです。

.cc.c.cpp ファイルはすべてコンパイルされます。ファイルが生成される場合があります。名前付きファイルが他のルールの outs に含まれている場合、このルールは自動的にそのルールに依存します。

.h ファイルはコンパイルされませんが、このルールのソースによって含めることができます。.cc.h のどちらのファイルでも、これらの srcs または deps 引数にリストされたルールの hdrs にリストされたヘッダーを直接含めることができます。

すべての #included ファイルは、このルールの srcs 属性か、参照される cc_library()hdrs 属性で言及する必要があります。推奨されるスタイルは、ライブラリに関連するヘッダーをそのライブラリの hdrs 属性にリストし、このルールのソースに関連付けられている残りのヘッダーを srcs にリストすることです。詳細については、ヘッダーの包含確認をご覧ください。

ルールの名前が srcs に含まれている場合、このルールは自動的にそのルールに依存します。名前付きルールの outs が C または C++ ソースファイルの場合は、このルールにコンパイルされます。ライブラリ ファイルの場合は、リンクされます。

許可される srcs ファイル形式:

  • C および C++ ソースファイル: .c.cc.cpp.cxx.c++.C
  • C および C++ ヘッダー ファイル: .h.hh.hpp.hxx.inc.inl.H
  • C プリプロセッサを使用するアセンブラ: .S
  • アーカイブ: .a.pic.a
  • 「常にリンク」ライブラリ: .lo.pic.lo
  • 共有ライブラリ(バージョニングありまたはバージョンなし): .so.so.version
  • オブジェクト ファイル: .o.pic.o

これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。

additional_linker_inputs

List of labels; optional

これらのファイルを C++ リンカー コマンドに渡します。

たとえば、コンパイル済みの Windows .res ファイルをここで指定して、バイナリ ターゲットに埋め込むことができます。

copts

List of strings; optional

これらのオプションを C++ コンパイル コマンドに追加します。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で COPTS に追加されます。このフラグは、このターゲットのコンパイルに対してのみ効果を発揮し、その依存関係には適用されないため、他の場所に含まれるヘッダー ファイルについては注意が必要です。パスはすべて、現在のパッケージではなく、ワークスペースからの相対パスにする必要があります。

パッケージで機能 no_copts_tokenization を宣言した場合、Bourne シェルのトークン化は、単一の「Make」変数で構成される文字列にのみ適用されます。

defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。
includes

List of strings; optional

コンパイル行に追加するインクルード ディレクトリのリスト。

"Make variable" 置換を実行します。 各文字列の先頭に -isystem が付加され、COPTS に追加されます。COPTS とは異なり、これらのフラグは、このルールと、それに依存するすべてのルールに追加されます。(注: この関数が依存するルールとは異なります)。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに「-I」フラグを COPTS に追加してください。

ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。

linkopts

List of strings; optional

これらのフラグを C++ リンカー コマンドに追加します。「Make」変数の置換、 Bourne シェルのトークン化ラベル展開の対象になります。この属性内の各文字列は、バイナリ ターゲットをリンクする前に LINKOPTS に追加されます。

このリスト内で $ または - で始まっていない各要素は、deps 内のターゲットのラベルとみなされます。そのターゲットによって生成されたファイルのリストは、リンカー オプションに追加されます。ラベルが無効な場合、または deps で宣言されていない場合は、エラーが報告されます。

linkshared

Boolean; optional; nonconfigurable; default is False

共有ライブラリを作成します。この属性を有効にするには、ルールに linkshared=True を含めます。このオプションはデフォルトでオフになっています。

このフラグが存在することは、-shared フラグを使用して gcc にリンクされることを意味します。結果の共有ライブラリは、Java プログラムなどへの読み込みに適しています。ただし、ビルド目的の場合は、依存バイナリにリンクされることはありません。cc_binary ルールを使用してビルドされた共有ライブラリは、他のプログラムによってのみ手動で読み込まれると想定されるため、cc_library ルールの代わりとはみなされません。スケーラビリティの観点から、このアプローチは完全に回避し、単純に java_librarycc_library ルールに依存させることをおすすめします。

linkopts=['-static']linkshared=True の両方を指定すると、完全に自己完結したユニットが 1 つ作成されます。linkstatic=Truelinkshared=True の両方を指定すると、1 つのユニット(ほとんどが自己完結型)になります。

linkstatic

Boolean; optional; default is True

cc_binarycc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。

デフォルトでは、このオプションは cc_binary ではオンで、残りはオフになっています。

有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの .so ではなく .a でリンクするように指示します。システム ライブラリの中には、静的ライブラリがないライブラリのように、動的にリンクされるものもあります。したがって、生成された実行可能ファイルは依然として動的にリンクされるため、ほぼ静的なファイルになります。

実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。

  • STATIC と full_static_link 機能があり、すべてが静的にリンクされます。例: 「gcc -static foo.o libbar.a libbaz.a -lm」。
    このモードを有効にするには、features 属性で fully_static_link を指定します。
  • STATIC の場合、すべてのユーザー ライブラリが静的にリンクされますが、システム ライブラリ(C/C++ ランタイム ライブラリを除く)が動的にリンクされます(例: gcc foo.o libfoo.a libbaz.a -lm)。
    このモードを有効にするには、linkstatic=True を指定します。
  • DYNAMIC: すべてのライブラリが動的にリンクされます(動的バージョンが利用できる場合)。例: 「gcc foo.o libfoo.so libbaz.so -lm」。
    このモードを有効にするには、linkstatic=False を指定します。

linkstatic 属性は、cc_library() ルールで使用する場合の意味が異なります。C++ ライブラリの場合、linkstatic=True は静的リンクのみが許可されるため、.so は生成されません。linkstatic=False は、静的ライブラリの作成を妨げません。この属性は、動的ライブラリの作成を制御するためのものです。

linkstatic=False の場合、ビルドツールは、依存する共有ライブラリへのシンボリック リンクを *.runfiles 領域に作成します。

local_defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
malloc

Label; optional; default is @bazel_tools//tools/cpp:malloc

malloc のデフォルトの依存関係をオーバーライドします。

デフォルトでは、C++ バイナリは //tools/cpp:malloc(空のライブラリ)に対してリンクされるため、バイナリは最終的に libc malloc を使用します。このラベルは cc_library を参照する必要があります。C++ 以外のルールに対してコンパイルする場合、このオプションは無効です。linkshared=True が指定されている場合、この属性の値は無視されます。

nocopts

String; optional

C++ コンパイル コマンドから一致オプションを削除します。 「Make」変数の置換が可能です。この属性の値は正規表現として解釈されます。 この正規表現に一致する既存の COPTS(ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
stamp

Integer; optional; default is -1

ビルド情報をバイナリにエンコードするかどうか。取得される値は次のとおりです。
  • stamp = 1: --nostamp ビルドの場合でも、常にビルド情報をバイナリにスタンプします。この設定は、バイナリとそれに依存するダウンストリーム アクションのリモート キャッシュを強制終了する可能性があるため、使用しないでください
  • stamp = 0: ビルド情報を常に定数値に置き換えます。これにより、良好なビルド結果のキャッシュ保存ができます。
  • stamp = -1: ビルド情報の埋め込みは --[no]stamp フラグで制御されます。

依存関係が変更されない限り、スタンプされたバイナリは再ビルドされません

win_def_file

Label; optional

リンカーに渡す Windows DEF ファイル。

この属性は、Windows がターゲット プラットフォームである場合にのみ使用してください。これを使用して、共有ライブラリのリンク中に シンボルをエクスポートできます。

cc_import

cc_import(name, data, hdrs, alwayslink, compatible_with, deprecation, distribs, features, interface_library, licenses, restricted_to, shared_library, static_library, system_provided, tags, target_compatible_with, testonly, visibility)

cc_import ルールを使用すると、プリコンパイルされた C/C++ ライブラリをインポートできます。

一般的なユースケースは次のとおりです。
1. 静的ライブラリをリンクする

cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.a",
  # If alwayslink is turned on,
  # libmylib.a will be forcely linked into any binary that depends on it.
  # alwayslink = 1,
)
2. 共有ライブラリのリンク(Unix)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  shared_library = "libmylib.so",
)
3. 共有ライブラリとインターフェース ライブラリのリンク(Windows)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  # mylib.lib is a import library for mylib.dll which will be passed to linker
  interface_library = "mylib.lib",
  # mylib.dll will be available for runtime
  shared_library = "mylib.dll",
)
4. 共有ライブラリを system_provided=True にリンクする(Windows)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  # mylib.lib is an import library for mylib.dll which will be passed to linker
  interface_library = "mylib.lib",
  # mylib.dll is provided by system environment, for example it can be found in PATH.
  # This indicates that Bazel is not responsible for making mylib.dll available.
  system_provided = 1,
)
5. 静的ライブラリまたは共有ライブラリへのリンク
Unix の場合:
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.a",
  shared_library = "libmylib.so",
)

# first will link to libmylib.a
cc_binary(
  name = "first",
  srcs = ["first.cc"],
  deps = [":mylib"],
  linkstatic = 1, # default value
)

# second will link to libmylib.so
cc_binary(
  name = "second",
  srcs = ["second.cc"],
  deps = [":mylib"],
  linkstatic = 0,
)
Windows の場合:
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.lib", # A normal static library
  interface_library = "mylib.lib", # An import library for mylib.dll
  shared_library = "mylib.dll",
)

# first will link to libmylib.lib
cc_binary(
  name = "first",
  srcs = ["first.cc"],
  deps = [":mylib"],
  linkstatic = 1, # default value
)

# second will link to mylib.dll through mylib.lib
cc_binary(
  name = "second",
  srcs = ["second.cc"],
  deps = [":mylib"],
  linkstatic = 0,
)

引数

属性
name

Name; required

このターゲットの一意の名前。

hdrs

List of labels; optional

従属ルールでソースによって直接インクルードされる、このプリコンパイル済みライブラリによって公開されるヘッダー ファイルのリスト。

Boolean; optional; default is False

1 の場合、この C++ プリコンパイル済みライブラリに直接的または間接的に依存するバイナリは、バイナリによって参照されるシンボルが含まれていなくても、静的ライブラリにアーカイブされたすべてのオブジェクト ファイルにリンクします。 これは、バイナリ内のコードによってコードが明示的に呼び出されない場合(サービスがなんらかのサービスから提供されるコールバックを受け取るようにコードが登録されている場合など)に有用です。

既知の問題が原因で、Windows の VS 2017 で alwayslink が動作しない場合は、VS 2017 を最新バージョンにアップグレードしてください。

interface_library

Label; optional

共有ライブラリをリンクする単一のインターフェース ライブラリ。

使用できるファイル形式: .ifso.tbd.lib.so.dylib

shared_library

Label; optional

プリコンパイルされた単一の共有ライブラリ。Bazel は、実行時に、Bazel に依存するバイナリがこれを利用できるようにします。

使用できるファイル形式: .so.dll、または .dylib

static_library

Label; optional

プリコンパイルされた単一の静的ライブラリ。

使用できるファイル形式: .a.pic.a、または .lib

system_provided

Boolean; optional; default is False

1 の場合、実行時に必要な共有ライブラリがシステムによって提供されたことを示します。この場合、interface_library を指定し、shared_library を空にする必要があります。

cc_library

cc_library(name, deps, srcs, data, hdrs, additional_compiler_inputs, alwayslink, compatible_with, copts, defines, deprecation, distribs, exec_compatible_with, exec_properties, features, implementation_deps, include_prefix, includes, licenses, linkopts, linkstamp, linkstatic, local_defines, nocopts, restricted_to, strip_include_prefix, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, win_def_file)

ヘッダーの包含チェック

ビルドで使用されるすべてのヘッダー ファイルは、cc_* ルールの hdrs または srcs で宣言する必要があります。これは必須です。

cc_library ルールの場合、hdrs のヘッダーはライブラリの公開インターフェースを構成します。ライブラリ自体の hdrssrcs のファイルだけでなく、deps にライブラリをリストしている cc_* ルールの hdrssrcs のファイルからも直接含めることができます。srcs のヘッダーは、ライブラリ自体の hdrssrcs 内のファイルからのみ直接含める必要があります。ヘッダーを hdrssrcs のどちらに配置するかを決定するときは、このライブラリのコンシューマがヘッダーを直接インクルードできるようにするかどうかを尋ねてください。これは、プログラミング言語で publicprivate のどちらを表示するかを指定するのとほぼ同じです。

cc_binary ルールと cc_test ルールはエクスポートされたインターフェースがないため、hdrs 属性もありません。バイナリまたはテストに直接属するすべてのヘッダーは、srcs にリストする必要があります。

これらのルールについて、次の例で説明します。

cc_binary(
    name = "foo",
    srcs = [
        "foo.cc",
        "foo.h",
    ],
    deps = [":bar"],
)

cc_library(
    name = "bar",
    srcs = [
        "bar.cc",
        "bar-impl.h",
    ],
    hdrs = ["bar.h"],
    deps = [":baz"],
)

cc_library(
    name = "baz",
    srcs = [
        "baz.cc",
        "baz-impl.h",
    ],
    hdrs = ["baz.h"],
)

この例で許可される直接的包含は、以下の表のとおりです。たとえば、foo.cc には foo.hbar.h を直接含めることができますが、baz.h を含めることはできません。

ファイルをインクルードしています許可される包含
foo.hbar.h
foo.ccfoo.h bar.h
bar.hbar-impl.h baz.h
bar-impl.hbar.h baz.h
bar.ccbar.h bar-impl.h baz.h
baz.hbaz-impl.h
baz-impl.hbaz.h
baz.ccbaz.h baz-impl.h

包含チェックルールは、直接の包含にのみ適用されます。上記の例では、foo.ccbar.h を含めることができ、これには baz.h を含めることもできます。さらに、baz-impl.h を含めることもできます。技術的には、.cc ファイルのコンパイルでは、推移的 deps クロージャ内の任意の cc_library 内の hdrs または srcs 内の任意のヘッダー ファイルを推移的に含めることができます。この場合、コンパイラは foo.cc のコンパイル時に baz.hbaz-impl.h を読み取ることはできますが、foo.cc#include "baz.h" を含めることはできません。これを許可するには、bazfoodeps に追加する必要があります。

残念ながら、現時点で Bazel では直接インクルードと推移的インクルードを区別できないため、推移的インクルードしか許可されていないヘッダーがファイルに直接直接含まれているエラーケースは検出できません。たとえば、上記の例で foo.ccbaz.h が直接含まれている場合、Bazel でエラーが返されることはありません。foobaz に直接依存していないため、これは違法です。現時点では、そのような場合にエラーが生成されることはありませんが、今後エラーチェックが追加される可能性があります。

引数

属性
name

Name; required

このターゲットの一意の名前。

deps

List of labels; optional

バイナリ ターゲットにリンクする他のライブラリのリスト。

cc_library または objc_library のターゲットになります。

srcs

List of labels; optional

ターゲットを作成するために処理された C および C++ ファイルのリスト。これらは C/C++ ソースファイルとヘッダー ファイルであり、非生成ファイル(通常のソースコード)または生成されたものです。

.cc.c.cpp ファイルはすべてコンパイルされます。ファイルが生成される場合があります。名前付きファイルが他のルールの outs に含まれている場合、このルールは自動的にそのルールに依存します。

.h ファイルはコンパイルされませんが、このルールのソースによって含めることができます。.cc.h のどちらのファイルでも、これらの srcs または deps 引数にリストされたルールの hdrs にリストされたヘッダーを直接含めることができます。

すべての #included ファイルは、このルールの srcs 属性か、参照される cc_library()hdrs 属性で言及する必要があります。推奨されるスタイルは、ライブラリに関連するヘッダーをそのライブラリの hdrs 属性にリストし、このルールのソースに関連付けられている残りのヘッダーを srcs にリストすることです。詳細については、ヘッダーの包含確認をご覧ください。

ルールの名前が srcs に含まれている場合、このルールは自動的にそのルールに依存します。名前付きルールの outs が C または C++ ソースファイルの場合は、このルールにコンパイルされます。ライブラリ ファイルの場合は、リンクされます。

許可される srcs ファイル形式:

  • C および C++ ソースファイル: .c.cc.cpp.cxx.c++.C
  • C および C++ ヘッダー ファイル: .h.hh.hpp.hxx.inc.inl.H
  • C プリプロセッサを使用するアセンブラ: .S
  • アーカイブ: .a.pic.a
  • 「常にリンク」ライブラリ: .lo.pic.lo
  • 共有ライブラリ(バージョニングありまたはバージョンなし): .so.so.version
  • オブジェクト ファイル: .o.pic.o

これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。

hdrs

List of labels; optional

このライブラリによって公開されるヘッダー ファイルのリスト。依存ルールのソースによって直接インクルードされます。

これは、ライブラリのインターフェースを記述するヘッダー ファイルを宣言する場合に強く推奨される場所です。これらのヘッダーは、このルールまたは依存ルールのソースによって含めることが可能になります。 このライブラリのクライアントに含めることを想定していないヘッダーは、公開ヘッダーに含まれている場合でも、代わりに srcs 属性に含める必要があります。詳細については、ヘッダーの包含確認をご覧ください。

additional_compiler_inputs

List of labels; optional

サニタイザーの無視リストなど、コンパイラのコマンドラインに渡す必要があるその他のファイル。ここで指定したファイルは、$(location) 関数で copts で使用できます。

Boolean; optional; default is False

1 の場合、この C++ ライブラリに直接的または間接的に依存するバイナリは、バイナリによって参照されるシンボルが含まれていなくても、srcs にリストされているファイルのすべてのオブジェクト ファイルにリンクします。 これは、バイナリ内のコードによってコードが明示的に呼び出されない場合(サービスがなんらかのサービスから提供されるコールバックを受け取るようにコードが登録されている場合など)に有用です。

既知の問題が原因で、Windows の VS 2017 で alwayslink が動作しない場合は、VS 2017 を最新バージョンにアップグレードしてください。

copts

List of strings; optional

これらのオプションを C++ コンパイル コマンドに追加します。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で COPTS に追加されます。このフラグは、このターゲットのコンパイルに対してのみ効果を発揮し、その依存関係には適用されないため、他の場所に含まれるヘッダー ファイルについては注意が必要です。パスはすべて、現在のパッケージではなく、ワークスペースからの相対パスにする必要があります。

パッケージで機能 no_copts_tokenization を宣言した場合、Bourne シェルのトークン化は、単一の「Make」変数で構成される文字列にのみ適用されます。

defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。
implementation_deps

List of labels; optional

ライブラリ ターゲットが依存する他のライブラリのリスト。deps と異なり、これらのライブラリのヘッダーとインクルードパス(およびそのすべての推移的依存関係)は、このライブラリのコンパイルにのみ使用され、それに依存するライブラリには使用されません。implementation_deps で指定されたライブラリは、このライブラリに依存するバイナリ ターゲットでは引き続きリンクされます。

現時点では cc_libraries に制限されており、--experimental_cc_implementation_deps フラグで保護されています。

include_prefix

String; optional

このルールのヘッダーのパスに追加する接頭辞。

この属性を設定した場合、このルールの hdrs 属性のヘッダーは、この属性の値がリポジトリの相対パスの先頭に付加された時点でアクセス可能になります。

この接頭辞が追加される前に、strip_include_prefix 属性の接頭辞は削除されます。

includes

List of strings; optional

コンパイル行に追加するインクルード ディレクトリのリスト。

"Make variable" 置換を実行します。 各文字列の先頭に -isystem が付加され、COPTS に追加されます。COPTS とは異なり、これらのフラグは、このルールと、それに依存するすべてのルールに追加されます。(注: この関数が依存するルールとは異なります)。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに「-I」フラグを COPTS に追加してください。

ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。

linkopts

List of strings; optional

これらのフラグを C++ リンカー コマンドに追加します。「Make」変数の置換、 Bourne シェルのトークン化ラベル展開の対象になります。この属性内の各文字列は、バイナリ ターゲットをリンクする前に LINKOPTS に追加されます。

このリスト内で $ または - で始まっていない各要素は、deps 内のターゲットのラベルとみなされます。そのターゲットによって生成されたファイルのリストは、リンカー オプションに追加されます。ラベルが無効な場合、または deps で宣言されていない場合は、エラーが報告されます。

linkstamp

Label; optional

同時に、指定された C++ ソースファイルをコンパイルして最終バイナリにリンクします。タイムスタンプ情報をバイナリに導入するには、この方法が必要です。通常の方法でソースファイルをオブジェクト ファイルにコンパイルすると、タイムスタンプは不正確になります。 リンクスタンプのコンパイルには、特定のコンパイラ フラグのセットを含めることはできません。そのため、特定のヘッダー、コンパイラ オプション、その他のビルド変数に依存しないようにする必要があります。このオプションは、base パッケージでのみ必要になります。
linkstatic

Boolean; optional; default is False

cc_binarycc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。

デフォルトでは、このオプションは cc_binary ではオンで、残りはオフになっています。

有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの .so ではなく .a でリンクするように指示します。システム ライブラリの中には、静的ライブラリがないライブラリのように、動的にリンクされるものもあります。したがって、生成された実行可能ファイルは依然として動的にリンクされるため、ほぼ静的なファイルになります。

実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。

  • STATIC と full_static_link 機能があり、すべてが静的にリンクされます。例: 「gcc -static foo.o libbar.a libbaz.a -lm」。
    このモードを有効にするには、features 属性で fully_static_link を指定します。
  • STATIC の場合、すべてのユーザー ライブラリが静的にリンクされますが、システム ライブラリ(C/C++ ランタイム ライブラリを除く)が動的にリンクされます(例: gcc foo.o libfoo.a libbaz.a -lm)。
    このモードを有効にするには、linkstatic=True を指定します。
  • DYNAMIC: すべてのライブラリが動的にリンクされます(動的バージョンが利用できる場合)。例: 「gcc foo.o libfoo.so libbaz.so -lm」。
    このモードを有効にするには、linkstatic=False を指定します。

linkstatic 属性は、cc_library() ルールで使用する場合の意味が異なります。C++ ライブラリの場合、linkstatic=True は静的リンクのみが許可されるため、.so は生成されません。linkstatic=False は、静的ライブラリの作成を妨げません。この属性は、動的ライブラリの作成を制御するためのものです。

linkstatic=False の場合、ビルドツールは、依存する共有ライブラリへのシンボリック リンクを *.runfiles 領域に作成します。

local_defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
nocopts

String; optional

C++ コンパイル コマンドから一致オプションを削除します。 「Make」変数の置換が可能です。この属性の値は正規表現として解釈されます。 この正規表現に一致する既存の COPTS(ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
strip_include_prefix

String; optional

このルールのヘッダーのパスから削除する接頭辞。

設定すると、このルールの hdrs 属性のヘッダーは、パスでこの接頭辞がカットされてアクセス可能になります。

相対パスの場合は、パッケージ相対パスと見なされます。絶対パスの場合は、リポジトリからの相対パスとして認識されます。

include_prefix 属性の接頭辞は、この接頭辞が削除されてから追加されます。

textual_hdrs

List of labels; optional

このライブラリによって公開されるヘッダー ファイルのリスト。依存ルールのソースによってテキストでインクルードされます。

これは、単独でコンパイルできないヘッダー ファイルを宣言する場所です。つまり、有効なコードをビルドするには、他のソースファイルに常にテキストでインクルードする必要があります。

win_def_file

Label; optional

リンカーに渡す Windows DEF ファイル。

この属性は、Windows がターゲット プラットフォームである場合にのみ使用してください。これを使用して、共有ライブラリのリンク中に シンボルをエクスポートできます。

cc_proto_library

cc_proto_library(name, deps, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

cc_proto_library.proto ファイルから C++ コードを生成します。

depsproto_library ルールを指す必要があります。

例:

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引数

属性
name

Name; required

このターゲットの一意の名前。

deps

List of labels; optional

C++ コードの生成対象となる proto_library ルールのリスト。

fdo_prefetch_hints

fdo_prefetch_hints(name, compatible_with, deprecation, distribs, features, licenses, profile, restricted_to, tags, target_compatible_with, testonly, visibility)

ワークスペース内または指定された絶対パスにある FDO プリフェッチ ヒント プロファイルを表します。例:

fdo_prefetch_hints(
    name = "hints",
    profile = "//path/to/hints:profile.afdo",
)

fdo_profile(
  name = "hints_abs",
  absolute_path_profile = "/absolute/path/profile.afdo",
)

引数

属性
name

Name; required

このターゲットの一意の名前。

profile

Label; optional

ヒント プロファイルのラベル。ヒント ファイルの拡張子は .afdo です。ラベルで fdo_absolute_path_profile ルールを指定することもできます。

fdo_profile

fdo_profile(name, absolute_path_profile, compatible_with, deprecation, distribs, features, licenses, profile, proto_profile, restricted_to, tags, target_compatible_with, testonly, visibility)

ワークスペース内または指定された絶対パスにある FDO プロファイルを表します。 例:

fdo_profile(
    name = "fdo",
    profile = "//path/to/fdo:profile.zip",
)

fdo_profile(
  name = "fdo_abs",
  absolute_path_profile = "/absolute/path/profile.zip",
)

引数

属性
name

Name; required

このターゲットの一意の名前。

absolute_path_profile

String; optional

FDO プロファイルへの絶対パス。FDO ファイルの拡張子は、.profraw(インデックス付けされていない LLVM プロファイルの場合)、.profdata(インデックスに登録されている LLVM プロファイルの場合)、.zip(LLVM profraw プロファイルを保持する場合)、.afdo(AutoFDO プロファイルの場合)のいずれかです。
profile

Label; optional

FDO プロファイルまたはこれを生成するルールのラベル。FDO ファイルの拡張子は、.profraw(インデックスに登録されていない LLVM プロファイル)、.profdata(インデックスに登録された LLVM プロファイル)、.zip(LLVM profraw プロファイルを含む)、.afdo(AutoFDO プロファイル)、.xfdo(XBinary プロファイル)のいずれかです。このラベルで fdo_absolute_path_profile ルールを指定することもできます。
proto_profile

Label; optional

protobuf プロファイルのラベル。

propeller_optimize

propeller_optimize(name, compatible_with, deprecation, distribs, features, ld_profile, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

ワークスペース内の Propeller の最適化プロファイルを表します。 例:

propeller_optimize(
    name = "layout",
    cc_profile = "//path:cc_profile.txt",
    ld_profile = "//path:ld_profile.txt"
)

propeller_optimize(
    name = "layout_absolute",
    absolute_cc_profile = "/absolute/cc_profile.txt",
    absolute_ld_profile = "/absolute/ld_profile.txt"
)

引数

属性
name

Name; required

このターゲットの一意の名前。

ld_profile

Label; optional

リンク アクションに渡されるプロファイルのラベル。このファイルの拡張子は .txt です。

cc_test

cc_test(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, copts, defines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, includes, licenses, linkopts, linkstatic, local, local_defines, malloc, nocopts, restricted_to, shard_count, size, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility, win_def_file)

引数

属性
name

Name; required

このターゲットの一意の名前。

deps

List of labels; optional

バイナリ ターゲットにリンクする他のライブラリのリスト。

cc_library または objc_library のターゲットになります。

srcs

List of labels; optional

ターゲットを作成するために処理された C および C++ ファイルのリスト。これらは C/C++ ソースファイルとヘッダー ファイルであり、非生成ファイル(通常のソースコード)または生成されたものです。

.cc.c.cpp ファイルはすべてコンパイルされます。ファイルが生成される場合があります。名前付きファイルが他のルールの outs に含まれている場合、このルールは自動的にそのルールに依存します。

.h ファイルはコンパイルされませんが、このルールのソースによって含めることができます。.cc.h のどちらのファイルでも、これらの srcs または deps 引数にリストされたルールの hdrs にリストされたヘッダーを直接含めることができます。

すべての #included ファイルは、このルールの srcs 属性か、参照される cc_library()hdrs 属性で言及する必要があります。推奨されるスタイルは、ライブラリに関連するヘッダーをそのライブラリの hdrs 属性にリストし、このルールのソースに関連付けられている残りのヘッダーを srcs にリストすることです。詳細については、ヘッダーの包含確認をご覧ください。

ルールの名前が srcs に含まれている場合、このルールは自動的にそのルールに依存します。名前付きルールの outs が C または C++ ソースファイルの場合は、このルールにコンパイルされます。ライブラリ ファイルの場合は、リンクされます。

許可される srcs ファイル形式:

  • C および C++ ソースファイル: .c.cc.cpp.cxx.c++.C
  • C および C++ ヘッダー ファイル: .h.hh.hpp.hxx.inc.inl.H
  • C プリプロセッサを使用するアセンブラ: .S
  • アーカイブ: .a.pic.a
  • 「常にリンク」ライブラリ: .lo.pic.lo
  • 共有ライブラリ(バージョニングありまたはバージョンなし): .so.so.version
  • オブジェクト ファイル: .o.pic.o

これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。

additional_linker_inputs

List of labels; optional

これらのファイルを C++ リンカー コマンドに渡します。

たとえば、コンパイル済みの Windows .res ファイルをここで指定して、バイナリ ターゲットに埋め込むことができます。

copts

List of strings; optional

これらのオプションを C++ コンパイル コマンドに追加します。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で COPTS に追加されます。このフラグは、このターゲットのコンパイルに対してのみ効果を発揮し、その依存関係には適用されないため、他の場所に含まれるヘッダー ファイルについては注意が必要です。パスはすべて、現在のパッケージではなく、ワークスペースからの相対パスにする必要があります。

パッケージで機能 no_copts_tokenization を宣言した場合、Bourne シェルのトークン化は、単一の「Make」変数で構成される文字列にのみ適用されます。

defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。
includes

List of strings; optional

コンパイル行に追加するインクルード ディレクトリのリスト。

"Make variable" 置換を実行します。 各文字列の先頭に -isystem が付加され、COPTS に追加されます。COPTS とは異なり、これらのフラグは、このルールと、それに依存するすべてのルールに追加されます。(注: この関数が依存するルールとは異なります)。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに「-I」フラグを COPTS に追加してください。

ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。

linkopts

List of strings; optional

これらのフラグを C++ リンカー コマンドに追加します。「Make」変数の置換、 Bourne シェルのトークン化ラベル展開の対象になります。この属性内の各文字列は、バイナリ ターゲットをリンクする前に LINKOPTS に追加されます。

このリスト内で $ または - で始まっていない各要素は、deps 内のターゲットのラベルとみなされます。そのターゲットによって生成されたファイルのリストは、リンカー オプションに追加されます。ラベルが無効な場合、または deps で宣言されていない場合は、エラーが報告されます。

linkstatic

Boolean; optional; default is False

cc_binarycc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。

デフォルトでは、このオプションは cc_binary ではオンで、残りはオフになっています。

有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの .so ではなく .a でリンクするように指示します。システム ライブラリの中には、静的ライブラリがないライブラリのように、動的にリンクされるものもあります。したがって、生成された実行可能ファイルは依然として動的にリンクされるため、ほぼ静的なファイルになります。

実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。

  • STATIC と full_static_link 機能があり、すべてが静的にリンクされます。例: 「gcc -static foo.o libbar.a libbaz.a -lm」。
    このモードを有効にするには、features 属性で fully_static_link を指定します。
  • STATIC の場合、すべてのユーザー ライブラリが静的にリンクされますが、システム ライブラリ(C/C++ ランタイム ライブラリを除く)が動的にリンクされます(例: gcc foo.o libfoo.a libbaz.a -lm)。
    このモードを有効にするには、linkstatic=True を指定します。
  • DYNAMIC: すべてのライブラリが動的にリンクされます(動的バージョンが利用できる場合)。例: 「gcc foo.o libfoo.so libbaz.so -lm」。
    このモードを有効にするには、linkstatic=False を指定します。

linkstatic 属性は、cc_library() ルールで使用する場合の意味が異なります。C++ ライブラリの場合、linkstatic=True は静的リンクのみが許可されるため、.so は生成されません。linkstatic=False は、静的ライブラリの作成を妨げません。この属性は、動的ライブラリの作成を制御するためのものです。

linkstatic=False の場合、ビルドツールは、依存する共有ライブラリへのシンボリック リンクを *.runfiles 領域に作成します。

local_defines

List of strings; optional

コンパイル行に追加する定義のリスト。 「Make」変数の置換と Bourne シェルのトークン化が適用されます。各文字列は 1 つの Bourne シェルトークンで構成する必要があり、先頭に -D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
malloc

Label; optional; default is @bazel_tools//tools/cpp:malloc

malloc のデフォルトの依存関係をオーバーライドします。

デフォルトでは、C++ バイナリは //tools/cpp:malloc(空のライブラリ)に対してリンクされるため、バイナリは最終的に libc malloc を使用します。このラベルは cc_library を参照する必要があります。C++ 以外のルールに対してコンパイルする場合、このオプションは無効です。linkshared=True が指定されている場合、この属性の値は無視されます。

nocopts

String; optional

C++ コンパイル コマンドから一致オプションを削除します。 「Make」変数の置換が可能です。この属性の値は正規表現として解釈されます。 この正規表現に一致する既存の COPTS(ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
stamp

Integer; optional; default is 0

ビルド情報をバイナリにエンコードするかどうか。取得される値は次のとおりです。
  • stamp = 1: --nostamp ビルドの場合でも、常にビルド情報をバイナリにスタンプします。この設定は、バイナリとそれに依存するダウンストリーム アクションのリモート キャッシュを強制終了する可能性があるため、使用しないでください
  • stamp = 0: ビルド情報を常に定数値に置き換えます。これにより、良好なビルド結果のキャッシュ保存ができます。
  • stamp = -1: ビルド情報の埋め込みは --[no]stamp フラグで制御されます。

依存関係が変更されない限り、スタンプされたバイナリは再ビルドされません

win_def_file

Label; optional

リンカーに渡す Windows DEF ファイル。

この属性は、Windows がターゲット プラットフォームである場合にのみ使用してください。これを使用して、共有ライブラリのリンク中に シンボルをエクスポートできます。

cc_toolchain

cc_toolchain(name, all_files, ar_files, as_files, compatible_with, compiler, compiler_files, compiler_files_without_includes, coverage_files, cpu, deprecation, distribs, dwp_files, dynamic_runtime_lib, exec_transition_for_inputs, features, libc_top, licenses, linker_files, module_map, objcopy_files, restricted_to, static_runtime_lib, strip_files, supports_header_parsing, supports_param_files, tags, target_compatible_with, testonly, toolchain_config, toolchain_identifier, visibility)

C++ ツールチェーンを表します。

このルールの役割は次のとおりです。

  • C++ アクションの実行に必要なすべてのアーティファクトを収集する。この処理は、all_filescompiler_fileslinker_files などの属性や、末尾が _files の属性によって行われます。ほとんどの場合、このようなファイルは必要なすべてのファイルをグロブしているファイルグループです。
  • C++ アクション用の正しいコマンドラインを生成する。これを行うには、CcToolchainConfigInfo プロバイダを使用します(詳細は後述します)。

C++ ツールチェーンを構成するには、toolchain_config 属性を使用します。 C++ ツールチェーンの構成と選択について詳しく説明したこちらの ページ もご覧ください。

bazel build //... の呼び出し時にツールチェーンが不必要にビルドおよび構成されないようにするために、tags = ["manual"] を使用します。

引数

属性
name

Name; required

このターゲットの一意の名前。

all_files

Label; required

すべての cc_ツールチェーン アーティファクトのコレクション。これらのアーティファクトは、すべての rules_cc 関連アクションに入力として追加されます(ただし、以下の属性のより正確なアーティファクト セットを使用するアクションは除きます)。Bazel は、all_files が他のすべてのアーティファクト提供属性のスーパーセットであると想定します(たとえば、Linkstamp コンパイルには、コンパイル ファイルとリンク ファイルの両方が必要なため、all_files を使用します)。

これは cc_toolchain.files に含まれるもので、C++ ツールチェーンを使用するすべての Starlark ルールで使用されます。

ar_files

Label; optional

アーカイブ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。

as_files

Label; optional

アセンブリ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。

compiler

String; optional; nonconfigurable

非推奨です。代わりに toolchain_identifier 属性を使用してください。 CROSSTOOL から Starlark への移行 後は通知を受け取りません。#7075 までに削除されます。

設定すると、crosstool_config.ツールチェーン の選択に使用されます。--cpu Bazel オプションよりも優先されます。

compiler_files

Label; required

コンパイル アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。
compiler_files_without_includes

Label; optional

入力検出がサポートされている場合のコンパイル アクションに必要なすべての cc_ツールチェーン アーティファクトの収集(現在は Google のみ)。
coverage_files

Label; optional

カバレッジ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。指定しない場合は、all_files が使用されます。
cpu

String; optional; nonconfigurable

非推奨です。代わりに ツールチェーン_identifier 属性を使用してください。CROSSTOOL から Starlark への移行 後は通知を受け取りません。#7075 までに削除されます。

設定すると、crosstool_config.ツールチェーン の選択に使用されます。--cpu Bazel オプションよりも優先されます。

dwp_files

Label; required

dwp アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。
dynamic_runtime_lib

Label; optional

C++ ランタイム ライブラリの動的ライブラリ アーティファクト(例: libstdc++.so)。

これは、「static_link_cpp_runtimes」機能が有効で、依存関係を動的にリンクしている場合に使用されます。

exec_transition_for_inputs

Boolean; optional; default is True

True に設定すると、すべてのファイル入力を、実行プラットフォーム(デフォルトのターゲット プラットフォーム)ではなく実行プラットフォームの cc_ツールチェーン にビルドします。
libc_top

Label; optional

コンパイル/リンク アクションへの入力として渡される libc のアーティファクトのコレクション。
linker_files

Label; required

リンク アクションに必要なすべての cc_ツールチェーン アーティファクトのコレクション。
module_map

Label; optional

モジュラー ビルドに使用されるモジュール マップ アーティファクト。
objcopy_files

Label; required

objcopy アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。
static_runtime_lib

Label; optional

C++ ランタイム ライブラリの静的ライブラリ アーティファクト(例: libstdc++.a)。

これは、「static_link_cpp_runtimes」機能が有効で、依存関係を静的にリンクしている場合に使用されます。

strip_files

Label; required

削除操作に必要なすべての cc_ツールチェーン アーティファクトの収集。
supports_header_parsing

Boolean; optional; default is False

cc_ツールチェーン がヘッダー解析アクションをサポートしている場合は、True に設定します。
supports_param_files

Boolean; optional; default is True

cc_ツールチェーン がアクションのリンクにパラメータ ファイルの使用をサポートしている場合は、True に設定します。
toolchain_config

Label; required

cc_toolchain_config_info を提供するルールのラベル。
toolchain_identifier

String; optional; nonconfigurable

この cc_ツールチェーンと、対応する crosstool_config.ツールチェーンとを照合するために使用される識別子です。

問題 #5380 が修正されるまで、この方法では cc_toolchainCROSSTOOL.toolchain と関連付けることをおすすめします。これは toolchain_config 属性に置き換えられます(#5380)。

cc_toolchain_suite

cc_toolchain_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

C++ ツールチェーンのコレクションを表します。

このルールの役割は次のとおりです。

  • 関連するすべての C++ ツールチェーンを収集する。
  • Bazel に渡される --cpu オプションと --compiler オプションに応じて 1 つのツールチェーンを選択する。

C++ ツールチェーンの構成と選択について詳しく説明したこちらの ページ もご覧ください。

引数

属性
name

Name; required

このターゲットの一意の名前。

toolchains

Dictionary mapping strings to labels; required; nonconfigurable

「<cpu>」または「<cpu>|<compiler>」の文字列から cc_toolchain ラベルへのマップ。「<cpu>」は、--cpu のみが Bazel に渡される場合、「<cpu>|<compiler>」は --cpu--compiler の両方が Bazel に渡される場合に使用されます。次に例を示します。

          cc_toolchain_suite(
            name = "toolchain",
            toolchains = {
              "piii|gcc": ":my_cc_toolchain_for_piii_using_gcc",
              "piii": ":my_cc_toolchain_for_piii_using_default_compiler",
            },
          )