ルール
- cc_binary
- cc_import
- cc_library
- cc_proto_library
- fdo_prefetch_Hints
- fdo_profile
- propeller_optimize
- cc_test
- cc_ツールチェーン
- cc_ツールチェーン_suite
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 |
このターゲットの一意の名前。 |
deps
|
|
srcs
|
すべての ルールの名前が
許可される
これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。 |
additional_linker_inputs
|
たとえば、コンパイル済みの Windows .res ファイルをここで指定して、バイナリ ターゲットに埋め込むことができます。 |
copts
|
この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で
パッケージで機能
|
defines
|
-D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。 |
includes
|
"Make variable" 置換を実行します。
各文字列の先頭に ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。 |
linkopts
|
LINKOPTS に追加されます。
このリスト内で |
linkshared
|
linkshared=True を含めます。このオプションはデフォルトでオフになっています。
このフラグが存在することは、
|
linkstatic
|
cc_binary と cc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。
デフォルトでは、このオプションは
有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの 実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。
|
local_defines
|
-D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
|
malloc
|
デフォルトでは、C++ バイナリは |
nocopts
|
COPTS (ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
|
stamp
|
依存関係が変更されない限り、スタンプされたバイナリは再ビルドされません。 |
win_def_file
|
この属性は、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 |
このターゲットの一意の名前。 |
hdrs
|
|
alwayslink
|
既知の問題が原因で、Windows の VS 2017 で alwayslink が動作しない場合は、VS 2017 を最新バージョンにアップグレードしてください。 |
interface_library
|
使用できるファイル形式: |
shared_library
|
使用できるファイル形式:
|
static_library
|
使用できるファイル形式:
|
system_provided
|
interface_library を指定し、shared_library を空にする必要があります。 |
cc_library
cc_library(name, deps, srcs, data, hdrs, additional_compiler_inputs, additional_linker_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
のヘッダーはライブラリの公開インターフェースを構成します。ライブラリ自体の hdrs
と srcs
のファイルだけでなく、deps
にライブラリをリストしている cc_*
ルールの hdrs
と srcs
のファイルからも直接含めることができます。srcs
のヘッダーは、ライブラリ自体の hdrs
と srcs
内のファイルからのみ直接含める必要があります。ヘッダーを hdrs
と srcs
のどちらに配置するかを決定するときは、このライブラリのコンシューマがヘッダーを直接インクルードできるようにするかどうかを尋ねてください。これは、プログラミング言語で public
と private
のどちらを表示するかを指定するのとほぼ同じです。
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.h
と bar.h
を直接含めることができますが、baz.h
を含めることはできません。
ファイルをインクルードしています | 許可される包含 |
---|---|
foo.h | bar.h |
foo.cc | foo.h bar.h |
bar.h | bar-impl.h baz.h |
bar-impl.h | bar.h baz.h |
bar.cc | bar.h bar-impl.h baz.h |
baz.h | baz-impl.h |
baz-impl.h | baz.h |
baz.cc | baz.h baz-impl.h |
包含チェックルールは、直接の包含にのみ適用されます。上記の例では、foo.cc
に bar.h
を含めることができ、これには baz.h
を含めることもできます。さらに、baz-impl.h
を含めることもできます。技術的には、.cc
ファイルのコンパイルでは、推移的 deps
クロージャ内の任意の cc_library
内の hdrs
または srcs
内の任意のヘッダー ファイルを推移的に含めることができます。この場合、コンパイラは foo.cc
のコンパイル時に baz.h
と baz-impl.h
を読み取ることはできますが、foo.cc
に #include "baz.h"
を含めることはできません。これを許可するには、baz
を foo
の deps
に追加する必要があります。
残念ながら、現時点で Bazel では直接インクルードと推移的インクルードを区別できないため、推移的インクルードしか許可されていないヘッダーがファイルに直接直接含まれているエラーケースは検出できません。たとえば、上記の例で foo.cc
に baz.h
が直接含まれている場合、Bazel でエラーが返されることはありません。foo
は baz
に直接依存していないため、これは違法です。現時点では、そのような場合にエラーが生成されることはありませんが、今後エラーチェックが追加される可能性があります。
引数
属性 | |
---|---|
name |
このターゲットの一意の名前。 |
deps
|
|
srcs
|
すべての ルールの名前が
許可される
これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。 |
hdrs
|
これは、ライブラリのインターフェースを記述するヘッダー ファイルを宣言する場合に強く推奨される場所です。これらのヘッダーは、このルールまたは依存ルールのソースによって含めることが可能になります。
このライブラリのクライアントに含めることを想定していないヘッダーは、公開ヘッダーに含まれている場合でも、代わりに |
additional_compiler_inputs
|
|
additional_linker_inputs
|
たとえば、コンパイル済みの Windows .res ファイルをここで指定して、バイナリ ターゲットに埋め込むことができます。 |
alwayslink
|
srcs にリストされているファイルのすべてのオブジェクト ファイルにリンクします。
これは、バイナリ内のコードによってコードが明示的に呼び出されない場合(サービスがなんらかのサービスから提供されるコールバックを受け取るようにコードが登録されている場合など)に有用です。
既知の問題が原因で、Windows の VS 2017 で alwayslink が動作しない場合は、VS 2017 を最新バージョンにアップグレードしてください。 |
copts
|
この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で
パッケージで機能
|
defines
|
-D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。 |
implementation_deps
|
deps と異なり、これらのライブラリのヘッダーとインクルードパス(およびそのすべての推移的依存関係)は、このライブラリのコンパイルにのみ使用され、それに依存するライブラリには使用されません。implementation_deps で指定されたライブラリは、このライブラリに依存するバイナリ ターゲットでは引き続きリンクされます。
現時点では cc_libraries に制限されており、 |
include_prefix
|
この属性を設定した場合、このルールの この接頭辞が追加される前に、 |
includes
|
"Make variable" 置換を実行します。
各文字列の先頭に ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。 |
linkopts
|
LINKOPTS に追加されます。
このリスト内で |
linkstamp
|
base パッケージでのみ必要になります。
|
linkstatic
|
cc_binary と cc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。
デフォルトでは、このオプションは
有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの 実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。
|
local_defines
|
-D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
|
nocopts
|
COPTS (ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
|
strip_include_prefix
|
設定すると、このルールの 相対パスの場合は、パッケージ相対パスと見なされます。絶対パスの場合は、リポジトリからの相対パスとして認識されます。
|
textual_hdrs
|
これは、単独でコンパイルできないヘッダー ファイルを宣言する場所です。つまり、有効なコードをビルドするには、他のソースファイルに常にテキストでインクルードする必要があります。 |
win_def_file
|
この属性は、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++ コードを生成します。
deps
は proto_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 |
このターゲットの一意の名前。 |
deps
|
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 |
このターゲットの一意の名前。 |
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 |
このターゲットの一意の名前。 |
absolute_path_profile
|
|
profile
|
|
proto_profile
|
|
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 |
このターゲットの一意の名前。 |
ld_profile
|
|
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 |
このターゲットの一意の名前。 |
deps
|
|
srcs
|
すべての ルールの名前が
許可される
これらのファイルを生成するルールについても確認します。拡張機能は、gcc の規則に従ってプログラミング言語を示します。 |
additional_linker_inputs
|
たとえば、コンパイル済みの Windows .res ファイルをここで指定して、バイナリ ターゲットに埋め込むことができます。 |
copts
|
この属性内の各文字列は、バイナリ ターゲットをコンパイルする前に、指定された順序で
パッケージで機能
|
defines
|
-D が付加され、このターゲットとそれに依存するすべてのルールのコンパイル コマンドラインに追加されます。これは広範囲にわたる影響を及ぼす可能性があるため、十分に注意してください。判断に迷う場合は、代わりに定義値を local_defines に追加してください。 |
includes
|
"Make variable" 置換を実行します。
各文字列の先頭に ヘッダーは srcs または hdrs に追加する必要があります。そうしないと、コンパイルがサンドボックス化されている場合(デフォルト)、依存ルールでヘッダーを使用できません。 |
linkopts
|
LINKOPTS に追加されます。
このリスト内で |
linkstatic
|
cc_binary と cc_test の場合: 静的モードでバイナリをリンクします。cc_library.linkstatic の場合: 下記をご覧ください。
デフォルトでは、このオプションは
有効な場合、このオプションはバイナリまたはテストです。このオプションはビルドツールに対し、可能な限りユーザー ライブラリの 実行可能ファイルをリンクするには、実際には次の 3 つの方法があります。
|
local_defines
|
-D が付加され、このターゲットのコンパイル コマンドラインに追加されますが、依存関係には追加されません。
|
malloc
|
デフォルトでは、C++ バイナリは |
nocopts
|
COPTS (ルールの copts 属性で明示的に指定された値を含む)は、このルールのコンパイルのために COPTS から削除されます。この属性が必要になることはほとんどありません。
|
stamp
|
依存関係が変更されない限り、スタンプされたバイナリは再ビルドされません。 |
win_def_file
|
この属性は、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_files
、compiler_files
、linker_files
などの属性や、末尾が_files
の属性によって行われます。ほとんどの場合、このようなファイルは必要なすべてのファイルをグロブしているファイルグループです。 -
C++ アクション用の正しいコマンドラインを生成する。これを行うには、
CcToolchainConfigInfo
プロバイダを使用します(詳細は後述します)。
C++ ツールチェーンを構成するには、toolchain_config
属性を使用します。
C++ ツールチェーンの構成と選択について詳しく説明したこちらの
ページ
もご覧ください。
bazel build //...
の呼び出し時にツールチェーンが不必要にビルドおよび構成されないようにするために、tags = ["manual"]
を使用します。
引数
属性 | |
---|---|
name |
このターゲットの一意の名前。 |
all_files
|
all_files が他のすべてのアーティファクト提供属性のスーパーセットであると想定します(たとえば、Linkstamp コンパイルには、コンパイル ファイルとリンク ファイルの両方が必要なため、all_files を使用します)。
これは |
ar_files
|
アーカイブ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。 |
as_files
|
アセンブリ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。 |
compiler
|
toolchain_identifier 属性を使用してください。
CROSSTOOL から Starlark への移行
後は通知を受け取りません。#7075 までに削除されます。
設定すると、crosstool_config.ツールチェーン の選択に使用されます。--cpu Bazel オプションよりも優先されます。 |
compiler_files
|
|
compiler_files_without_includes
|
|
coverage_files
|
|
cpu
|
設定すると、crosstool_config.ツールチェーン の選択に使用されます。--cpu Bazel オプションよりも優先されます。 |
dwp_files
|
|
dynamic_runtime_lib
|
これは、「static_link_cpp_runtimes」機能が有効で、依存関係を動的にリンクしている場合に使用されます。 |
exec_transition_for_inputs
|
|
libc_top
|
|
linker_files
|
|
module_map
|
|
objcopy_files
|
|
static_runtime_lib
|
これは、「static_link_cpp_runtimes」機能が有効で、依存関係を静的にリンクしている場合に使用されます。 |
strip_files
|
|
supports_header_parsing
|
|
supports_param_files
|
|
toolchain_config
|
cc_toolchain_config_info を提供するルールのラベル。 |
toolchain_identifier
|
問題 #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 |
このターゲットの一意の名前。 |
toolchains
|
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", }, ) |