ルール
- <ph type="x-smartling-placeholder"></ph> cc_binary
- <ph type="x-smartling-placeholder"></ph> cc_import
- <ph type="x-smartling-placeholder"></ph> cc_library
- <ph type="x-smartling-placeholder"></ph> cc_proto_library
- <ph type="x-smartling-placeholder"></ph> fdo_prefetch_hints
- <ph type="x-smartling-placeholder"></ph> fdo_profile
- <ph type="x-smartling-placeholder"></ph> propeller_optimize
- <ph type="x-smartling-placeholder"></ph> cc_test
- <ph type="x-smartling-placeholder"></ph> cc_toolchain
- <ph type="x-smartling-placeholder"></ph> cc_toolchain_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(明示的にリクエストされた場合にのみビルド): Fission が有効になっている(デバッグ) リモートにデプロイされたバイナリのデバッグに適した情報パッケージ ファイルです。それ以外: 空のファイルです。
引数
| 属性 | |
|---|---|
name |
このターゲットの一意の名前。 |
deps
|
|
srcs
|
ルールの名前が
許可される
...およびそれらのファイルを生成するルール。 拡張子はそれぞれ、異なるプログラミング言語を表します。 gcc の規則に従います。 |
additional_linker_inputs
|
たとえば、コンパイル済みの Windows .res ファイルをここで提供して、 バイナリターゲットです |
copts
|
この属性の各文字列は、指定された順序で
パッケージで feature が宣言されているかどうか
|
defines
|
-D が付き、このターゲットのコンパイル コマンドラインに追加されます。
関連するすべてのルールにも影響します。ただし、このケースでは
影響を及ぼす可能性があります。判断に迷った場合は、
local_defines をご利用ください。
|
includes
|
「変数を作成」による置換が適用されます。
各文字列の先頭に ヘッダーは 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, )
cc_import( name = "mylib", hdrs = ["mylib.h"], shared_library = "libmylib.so", )
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", )
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, )
へのリンク 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, )
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, 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)
ヘッダー包含チェック
ビルドで使用するすべてのヘッダー ファイルは、hdrs または
cc_* 個中 srcs 個のルール。これは強制適用です。
cc_library ルールの場合、hdrs のヘッダーは、次の公開インターフェースで構成されます。
含まれており、hdrs のファイルと、
ライブラリ自体の srcs と hdrs のファイルと
ライブラリを deps にリストする cc_* 個のルールのうち 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 ファイルのコンパイルには、任意のヘッダーが推移的に含まれる場合があります。
ファイル内の hdrs または srcs に
推移的 deps クロージャ内の cc_library。イン
この場合、コンパイラは baz.h と baz-impl.h を読み取れます。
foo.cc のコンパイル時(foo.cc はコンパイル時)
#include "baz.h" を含む。そのためには、
許可します。baz を deps に追加する必要があります
/foo。
残念ながら、Bazel は現在、直接的と推移的を区別できません。
含まれていないため、ファイルに不正に
直接含めることが可能です。たとえば
上記の例で直接 foo.cc をしても、Bazel はエラーになりません
baz.h を含む。foo のため、これは違法です。
baz には直接依存しません。現在、エラーは生成されていません。
ただし、今後このようなエラーチェックが追加される可能性があります。
引数
| 属性 | |
|---|---|
name |
このターゲットの一意の名前。 |
deps
|
|
srcs
|
ルールの名前が
許可される
...およびそれらのファイルを生成するルール。 拡張子はそれぞれ、異なるプログラミング言語を表します。 gcc の規則に従います。 |
hdrs
|
メタデータを格納するヘッダー ファイルを宣言するには、この行を
ライブラリのインターフェースを記述します。これらのヘッダーは
または依存するルールのソースごとに含めることができます。
このライブラリのクライアントによってインクルードされないヘッダーは、
|
alwayslink
|
srcs。バイナリで参照されるシンボルが含まれていないものもあります。
これは、Python のコードでコードを明示的に呼び出していない場合に
バイナリを受け取るコード(たとえば、コールバックを受け取るためにコードが登録されている場合)
提供します。
Windows 上の VS 2017 で alwayslink が動作しない場合は、 既知の問題 VS 2017 を最新バージョンにアップグレードしてください。 |
copts
|
この属性の各文字列は、指定された順序で
パッケージで feature が宣言されているかどうか
|
defines
|
-D が付き、このターゲットのコンパイル コマンドラインに追加されます。
関連するすべてのルールにも影響します。ただし、このケースでは
影響を及ぼす可能性があります。判断に迷った場合は、
local_defines をご利用ください。
|
implementation_deps
|
deps: これらのライブラリのヘッダーとインクルード パス(および
推移的依存関係)は、このライブラリのコンパイルにのみ使用され、
依存します。implementation_deps で指定されたライブラリは引き続き以下でリンクされます
バイナリ ターゲットを作成します。
現時点では、使用は cc_libraries に限定され、フラグによって保護される
|
include_prefix
|
設定すると、このルールの
|
includes
|
「変数を作成」による置換が適用されます。
各文字列の先頭に ヘッダーは 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
|
この属性の各文字列は、指定された順序で
パッケージで feature が宣言されているかどうか
|
defines
|
-D が付き、このターゲットのコンパイル コマンドラインに追加されます。
関連するすべてのルールにも影響します。ただし、このケースでは
影響を及ぼす可能性があります。判断に迷った場合は、
local_defines をご利用ください。
|
includes
|
「変数を作成」による置換が適用されます。
各文字列の先頭に ヘッダーは 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プロバイダ(詳しくは下記を参照)。
toolchain_config 属性を使用して C++ ツールチェーンを構成します。
関連情報
<ph type="x-smartling-placeholder"></ph>
ページ
を参照してください。
ツールチェーンがビルドおよび構成されないようにするには、tags = ["manual"] を使用します。
bazel build //... の呼び出し時に不必要に
引数
| 属性 | |
|---|---|
name |
このターゲットの一意の名前。 |
all_files
|
all_files がスーパーセットであると想定します。
他のすべてのアーティファクト提供属性(例: リンクスタンプのコンパイルには、
リンクファイルを指定するため、all_files が必要です)。
|
ar_files
|
アーカイブ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。 |
as_files
|
アセンブリ アクションに必要なすべての cc_ツールチェーン アーティファクトの収集。 |
compiler
|
toolchain_identifier 属性を使用してください。ヌープになる
以降
<ph type="x-smartling-placeholder"></ph>
Starlark への CROSSTOOL の移行
。削除予定:
#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++ ツールチェーンを収集する。
-
--cpuオプションと--compilerオプションに応じて 1 つのツールチェーンを選択する Bazel に渡されます。
関連情報 <ph type="x-smartling-placeholder"></ph> ページ を参照してください。
引数
| 属性 | |
|---|---|
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",
},
)
|