Aturan C / C++

Laporkan masalah Lihat sumber Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Aturan

cc_binary

Melihat sumber aturan
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, link_extra_lib, linkopts, linkshared, linkstatic, local_defines, malloc, nocopts, output_licenses, restricted_to, stamp, tags, target_compatible_with, testonly, toolchains, visibility, win_def_file)

Target output implisit

  • name.stripped (hanya di-build jika diminta secara eksplisit): Versi biner yang dihapus. strip -g dijalankan pada biner untuk menghapus simbol debug. Opsi strip tambahan dapat diberikan di command line menggunakan --stripopt=-foo. Output ini hanya dibuat jika diminta secara eksplisit.
  • name.dwp (hanya di-build jika diminta secara eksplisit): Jika Fission diaktifkan: file paket informasi debug yang cocok untuk men-debug biner yang di-deploy dari jarak jauh. Lainnya: file kosong.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target biner.

Ini dapat berupa target cc_library atau objc_library.

srcs

Daftar label; default-nya adalah []

Daftar file C dan C++ yang diproses untuk membuat target. Ini adalah file sumber dan header C/C++, baik yang tidak dibuat (kode sumber normal) maupun yang dibuat.

Semua file .cc, .c, dan .cpp akan dikompilasi. File ini mungkin adalah file yang dihasilkan: jika file bernama berada di outs dari beberapa aturan lain, aturan ini akan otomatis bergantung pada aturan lain tersebut.

File .h tidak akan dikompilasi, tetapi akan tersedia untuk disertakan oleh sumber dalam aturan ini. File .cc dan .h dapat langsung menyertakan header yang tercantum dalam srcs ini atau dalam hdrs dari aturan apa pun yang tercantum dalam argumen deps.

Semua file #included harus disebutkan dalam srcs atribut aturan ini, atau dalam hdrs atribut cc_library() yang direferensikan. Gaya yang direkomendasikan adalah untuk header yang terkait dengan library agar dicantumkan dalam atribut hdrs library tersebut, dan header lainnya yang terkait dengan sumber aturan ini agar dicantumkan dalam srcs. Lihat "Pemeriksaan penyertaan header" untuk deskripsi yang lebih mendetail.

Jika nama aturan ada di srcs, aturan ini akan otomatis bergantung pada aturan tersebut. Jika outs aturan yang diberi nama adalah file sumber C atau C++, file tersebut akan dikompilasi ke dalam aturan ini; jika file tersebut adalah file library, file tersebut akan ditautkan.

Jenis file srcs yang diizinkan:

  • File sumber C dan C++: .c, .cc, .cpp, .cxx, .c++, .C
  • File header C dan C++: .h, .hh, .hpp, .hxx, .inc, .inl, .H
  • Assembler dengan preprocessor C: .S
  • Arsip: .a, .pic.a
  • Library "Selalu tautkan": .lo, .pic.lo
  • Library bersama, dengan versi atau tanpa versi: .so, .so.version
  • File objek: .o, .pic.o

...dan aturan apa pun yang menghasilkan file tersebut. Ekstensi yang berbeda menunjukkan bahasa pemrograman yang berbeda sesuai dengankonvensi gcc.

additional_linker_inputs

Daftar label; default-nya adalah []

Teruskan file ini ke perintah linker C++.

Misalnya, file .res Windows yang dikompilasi dapat disediakan di sini untuk disematkan dalam target biner.

copts

Daftar string; default-nya adalah []

Tambahkan opsi ini ke perintah kompilasi C++. Tunduk pada penggantian "Make variable" dan tokenisasi shell Bourne.

Setiap string dalam atribut ini ditambahkan dalam urutan yang diberikan ke COPTS sebelum mengompilasi target biner. Flag ini hanya berlaku untuk mengompilasi target ini, bukan dependensinya, jadi berhati-hatilah dengan file header yang disertakan di tempat lain. Semua jalur harus relatif terhadap ruang kerja, bukan paket saat ini.

Jika paket mendeklarasikan fitur no_copts_tokenization, tokenisasi shell Bourne hanya berlaku untuk string yang terdiri dari satu variabel "Make".

defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi ke target ini, serta ke setiap aturan yang bergantung padanya. Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan nilai yang ditentukan ke local_defines.
includes

Daftar string; default-nya adalah []

Daftar direktori yang akan disertakan ke baris kompilasi.

Tunduk pada penggantian "Buat variabel". Setiap string diawali dengan -isystem dan ditambahkan ke COPTS. Tidak seperti COPTS, flag ini ditambahkan untuk aturan ini dan setiap aturan yang bergantung padanya. (Catatan: bukan aturan yang menjadi dependensinya!) Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan flag "-I" ke COPTS.

Header harus ditambahkan ke srcs atau hdrs. Jika tidak, header tidak akan tersedia untuk aturan dependen saat kompilasi di-sandbox (default).

Label; default-nya adalah "@bazel_tools//tools/cpp:link_extra_lib"

Mengontrol penautan library tambahan.

Secara default, biner C++ ditautkan ke //tools/cpp:link_extra_lib, yang secara default bergantung pada tanda label //tools/cpp:link_extra_libs. Tanpa menetapkan tanda, library ini kosong secara default. Menetapkan tanda label memungkinkan penautan dependensi opsional, seperti penggantian untuk simbol lemah, interceptor untuk fungsi library bersama, atau library runtime khusus (untuk penggantian malloc, pilih malloc atau --custom_malloc). Menetapkan atribut ini ke None akan menonaktifkan perilaku ini.

linkopts

Daftar string; default-nya adalah []

Tambahkan flag ini ke perintah linker C++. Tunduk pada penggantian variabel"Make", tokenisasi shell Bourne, dan ekspansi label. Setiap string dalam atribut ini ditambahkan ke LINKOPTS sebelum menautkan target biner.

Setiap elemen dalam daftar ini yang tidak dimulai dengan $ atau - diasumsikan sebagai label target di deps. Daftar file yang dihasilkan oleh target tersebut ditambahkan ke opsi penaut. Error akan dilaporkan jika label tidak valid, atau tidak dideklarasikan di deps.

linkshared

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False

Membuat library bersama. Untuk mengaktifkan atribut ini, sertakan linkshared=True dalam aturan Anda. Secara default, opsi ini nonaktif.

Kehadiran flag ini berarti penautan terjadi dengan flag -shared ke gcc, dan library bersama yang dihasilkan cocok untuk dimuat ke dalam misalnya program Java. Namun, untuk tujuan build, library ini tidak akan pernah ditautkan ke biner dependen, karena diasumsikan bahwa library bersama yang dibuat dengan aturan cc_binary hanya dimuat secara manual oleh program lain, sehingga tidak boleh dianggap sebagai pengganti aturan cc_library. Untuk skalabilitas, sebaiknya hindari pendekatan ini sepenuhnya dan cukup biarkan java_library bergantung pada aturan cc_library.

Jika Anda menentukan linkopts=['-static'] dan linkshared=True, Anda akan mendapatkan satu unit yang sepenuhnya mandiri. Jika menentukan linkstatic=True dan linkshared=True, Anda akan mendapatkan satu unit yang sebagian besar mandiri.

linkstatic

Boolean; default-nya adalah True

Untuk cc_binary dan cc_test: tautkan biner dalam mode statis. Untuk cc_library.linkstatic: lihat di bawah.

Secara default, opsi ini diaktifkan untuk cc_binary dan dinonaktifkan untuk yang lainnya.

Jika diaktifkan dan ini adalah biner atau pengujian, opsi ini akan memberi tahu alat build untuk menautkan .a, bukan .so, untuk library pengguna jika memungkinkan. Beberapa library sistem mungkin masih ditautkan secara dinamis, seperti library yang tidak memiliki library statis. Jadi, file yang dapat dieksekusi yang dihasilkan akan tetap ditautkan secara dinamis, sehingga hanya sebagian besar statis.

Sebenarnya ada tiga cara berbeda untuk menautkan file yang dapat dieksekusi:

  • STATIC dengan fitur fully_static_link, yang menautkan semuanya secara statis; mis. "gcc -static foo.o libbar.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan fully_static_link di atribut features.
  • STATIC, dengan semua library pengguna ditautkan secara statis (jika versi statis tersedia), tetapi library sistem (tidak termasuk library runtime C/C++) ditautkan secara dinamis, misalnya "gcc foo.o libfoo.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=True.
  • DINAMIS, dengan semua library ditautkan secara dinamis (jika versi dinamis tersedia), misalnya "gcc foo.o libfoo.so libbaz.so -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=False.

Atribut linkstatic memiliki arti yang berbeda jika digunakan pada cc_library() aturan. Untuk library C++, linkstatic=True menunjukkan bahwa hanya penautan statis yang diizinkan, sehingga tidak ada .so yang akan dihasilkan. linkstatic=False tidak mencegah library statis dibuat. Atribut ini dimaksudkan untuk mengontrol pembuatan library dinamis.

Jika linkstatic=False, alat build akan membuat symlink ke library bersama yang bergantung di area *.runfiles.

local_defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi untuk target ini, tetapi tidak ke dependensinya.
malloc

Label; default-nya adalah "@bazel_tools//tools/cpp:malloc"

Mengganti dependensi default pada malloc.

Secara default, biner C++ ditautkan ke //tools/cpp:malloc, yang merupakan library kosong sehingga biner akhirnya menggunakan libc malloc. Label ini harus merujuk ke cc_library. Jika kompilasi ditujukan untuk aturan non-C++, opsi ini tidak akan berpengaruh. Nilai atribut ini diabaikan jika linkshared=True ditentukan.

nocopts

String; default-nya adalah ""

Hapus opsi yang cocok dari perintah kompilasi C++. Tunduk pada penggantian variabel"Make". Nilai atribut ini ditafsirkan sebagai ekspresi reguler. Setiap COPTS yang sudah ada dan cocok dengan ekspresi reguler ini (termasuk nilai yang ditentukan secara eksplisit dalam atribut copts aturan) akan dihapus dari COPTS untuk tujuan mengompilasi aturan ini. Atribut ini jarang diperlukan.
stamp

Bilangan bulat; default-nya adalah -1

Apakah akan mengenkode informasi build ke dalam biner. Nilai yang mungkin:
  • stamp = 1: Selalu stempel informasi build ke dalam biner, bahkan dalam build --nostamp. Setelan ini harus dihindari, karena berpotensi menghentikan penyimpanan dalam cache jarak jauh untuk biner dan tindakan downstream apa pun yang bergantung padanya.
  • stamp = 0: Selalu ganti informasi build dengan nilai konstan. Hal ini memberikan caching hasil build yang baik.
  • stamp = -1: Penyematan informasi build dikontrol oleh flag --[no]stamp.

Biner yang dicap tidak akan di-build ulang kecuali jika dependensinya berubah.

win_def_file

Label; default-nya adalah None

File DEF Windows yang akan diteruskan ke penaut.

Atribut ini hanya boleh digunakan jika Windows adalah platform target. Library ini dapat digunakan untuk mengekspor simbol selama penautan library bersama.

cc_import

Melihat sumber aturan
cc_import(name, deps, 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)

Aturan cc_import memungkinkan pengguna mengimpor library C/C++ yang telah dikompilasi sebelumnya.

Berikut adalah kasus penggunaan yang umum:
1. Menautkan library statis

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. Menautkan library bersama (Unix)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  shared_library = "libmylib.so",
)
3. Menautkan library bersama dengan library antarmuka (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 will be available for runtime
  shared_library = "mylib.dll",
)
4. Menautkan library bersama dengan 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. Menautkan ke library statis atau bersama
Di 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,
)
Di 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,
)
cc_import mendukung atribut include. Contoh:
  cc_import(
  name = "curl_lib",
  hdrs = glob(["vendor/curl/include/curl/*.h"]),
  includes = [ "vendor/curl/include" ],
  shared_library = "vendor/curl/lib/.libs/libcurl.dylib",
)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang menjadi dependensi target. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build.
hdrs

Daftar label; default-nya adalah []

Daftar file header yang dipublikasikan oleh library yang telah dikompilasi sebelumnya ini untuk disertakan langsung oleh sumber dalam aturan dependen.

Boolean; default-nya adalah False

Jika 1, biner apa pun yang bergantung (secara langsung atau tidak langsung) pada library prekompilasi C++ ini akan menautkan semua file objek yang diarsipkan dalam library statis, meskipun beberapa tidak berisi simbol yang dirujuk oleh biner. Hal ini berguna jika kode Anda tidak dipanggil secara eksplisit oleh kode dalam biner, misalnya, jika kode Anda terdaftar untuk menerima beberapa callback yang disediakan oleh beberapa layanan.

Jika alwayslink tidak berfungsi dengan VS 2017 di Windows, hal ini disebabkan oleh masalah umum, upgrade VS 2017 Anda ke versi terbaru.

interface_library

Label; default-nya adalah None

Satu library antarmuka untuk menautkan library bersama.

Jenis file yang diizinkan: .ifso, .tbd, .lib, .so atau .dylib

shared_library

Label; default-nya adalah None

Satu library bersama yang telah dikompilasi sebelumnya. Bazel memastikannya tersedia untuk biner yang bergantung padanya selama runtime.

Jenis file yang diizinkan: .so, .dll atau .dylib

static_library

Label; default-nya adalah None

Satu library statis yang telah dikompilasi sebelumnya.

Jenis file yang diizinkan: .a, .pic.a atau .lib

system_provided

Boolean; default-nya adalah False

Jika 1, hal ini menunjukkan bahwa library bersama yang diperlukan saat runtime disediakan oleh sistem. Dalam hal ini, interface_library harus ditentukan dan shared_library harus kosong.

cc_library

Melihat sumber aturan
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)

Pemeriksaan penyertaan header

Semua file header yang digunakan dalam build harus dideklarasikan dalam aturan hdrs atau srcs dari cc_*. Kebijakan ini diterapkan.

Untuk aturan cc_library, header di hdrs terdiri dari antarmuka publik library dan dapat langsung disertakan baik dari file di hdrs maupun srcs dari library itu sendiri, serta dari file di hdrs dan srcs dari aturan cc_* yang mencantumkan library di deps-nya. Header di srcs hanya boleh disertakan langsung dari file di hdrs dan srcs library itu sendiri. Saat memutuskan apakah akan menempatkan header ke hdrs atau srcs, Anda harus bertanya apakah Anda ingin konsumen library ini dapat menyertakannya secara langsung. Keputusan ini kira-kira sama dengan visibilitas public dan private dalam bahasa pemrograman.

Aturan cc_binary dan cc_test tidak memiliki antarmuka yang diekspor, sehingga juga tidak memiliki atribut hdrs. Semua header yang termasuk dalam biner atau pengujian secara langsung harus dicantumkan dalam srcs.

Untuk mengilustrasikan aturan ini, lihat contoh berikut.

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"],
)

Penyertaan langsung yang diizinkan dalam contoh ini tercantum dalam tabel di bawah. Misalnya, foo.cc diizinkan untuk menyertakan foo.h dan bar.h secara langsung, tetapi tidak menyertakan baz.h.

Menyertakan filePenyertaan yang diizinkan
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

Aturan pemeriksaan penyertaan hanya berlaku untuk penyertaan langsung. Pada contoh di atas, foo.cc diizinkan untuk menyertakan bar.h, yang dapat menyertakan baz.h, yang pada gilirannya diizinkan untuk menyertakan baz-impl.h. Secara teknis, kompilasi file .cc dapat secara transitif menyertakan file header apa pun di hdrs atau srcs dalam cc_library apa pun dalam penutupan deps transitif. Dalam hal ini, compiler dapat membaca baz.h dan baz-impl.h saat mengompilasi foo.cc, tetapi foo.cc tidak boleh berisi #include "baz.h". Agar hal tersebut diizinkan, baz harus ditambahkan ke deps dari foo.

Bazel bergantung pada dukungan toolchain untuk menerapkan aturan pemeriksaan penyertaan. Fitur layering_check harus didukung oleh toolchain dan diminta secara eksplisit, misalnya melalui flag command line --features=layering_check atau parameter features dari fungsi package. toolchain yang disediakan oleh Bazel hanya mendukung fitur ini dengan clang di Unix dan macOS.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target biner.

Ini dapat berupa target cc_library atau objc_library.

srcs

Daftar label; default-nya adalah []

Daftar file C dan C++ yang diproses untuk membuat target. Ini adalah file sumber dan header C/C++, baik yang tidak dibuat (kode sumber normal) maupun yang dibuat.

Semua file .cc, .c, dan .cpp akan dikompilasi. File ini mungkin adalah file yang dihasilkan: jika file bernama berada di outs dari beberapa aturan lain, aturan ini akan otomatis bergantung pada aturan lain tersebut.

File .h tidak akan dikompilasi, tetapi akan tersedia untuk disertakan oleh sumber dalam aturan ini. File .cc dan .h dapat langsung menyertakan header yang tercantum dalam srcs ini atau dalam hdrs dari aturan apa pun yang tercantum dalam argumen deps.

Semua file #included harus disebutkan dalam srcs atribut aturan ini, atau dalam hdrs atribut cc_library() yang direferensikan. Gaya yang direkomendasikan adalah untuk header yang terkait dengan library agar dicantumkan dalam atribut hdrs library tersebut, dan header lainnya yang terkait dengan sumber aturan ini agar dicantumkan dalam srcs. Lihat "Pemeriksaan penyertaan header" untuk deskripsi yang lebih mendetail.

Jika nama aturan ada di srcs, aturan ini akan otomatis bergantung pada aturan tersebut. Jika outs aturan yang diberi nama adalah file sumber C atau C++, file tersebut akan dikompilasi ke dalam aturan ini; jika file tersebut adalah file library, file tersebut akan ditautkan.

Jenis file srcs yang diizinkan:

  • File sumber C dan C++: .c, .cc, .cpp, .cxx, .c++, .C
  • File header C dan C++: .h, .hh, .hpp, .hxx, .inc, .inl, .H
  • Assembler dengan preprocessor C: .S
  • Arsip: .a, .pic.a
  • Library "Selalu tautkan": .lo, .pic.lo
  • Library bersama, dengan versi atau tanpa versi: .so, .so.version
  • File objek: .o, .pic.o

...dan aturan apa pun yang menghasilkan file tersebut. Ekstensi yang berbeda menunjukkan bahasa pemrograman yang berbeda sesuai dengankonvensi gcc.

hdrs

Daftar label; default-nya adalah []

Daftar file header yang dipublikasikan oleh library ini untuk disertakan langsung oleh sumber dalam aturan dependen.

Ini adalah lokasi yang sangat disukai untuk mendeklarasikan file header yang menjelaskan antarmuka untuk library. Header ini akan tersedia untuk disertakan oleh sumber dalam aturan ini atau dalam aturan dependen. Header yang tidak dimaksudkan untuk disertakan oleh klien library ini harus dicantumkan dalam atribut srcs, meskipun disertakan oleh header yang dipublikasikan. Lihat "Pemeriksaan penyertaan header" untuk deskripsi yang lebih mendetail.

additional_compiler_inputs

Daftar label; default-nya adalah []

File tambahan apa pun yang mungkin ingin Anda teruskan ke command line compiler, seperti daftar yang dikecualikan sanitizer, misalnya. File yang ditentukan di sini kemudian dapat digunakan di copts dengan fungsi $(location).
additional_linker_inputs

Daftar label; default-nya adalah []

Teruskan file ini ke perintah linker C++.

Misalnya, file .res Windows yang dikompilasi dapat disediakan di sini untuk disematkan dalam target biner.

Boolean; default-nya adalah False

Jika 1, setiap biner yang bergantung (secara langsung atau tidak langsung) pada library C++ ini akan menautkan semua file objek untuk file yang tercantum dalam srcs, meskipun beberapa tidak berisi simbol yang dirujuk oleh biner. Hal ini berguna jika kode Anda tidak dipanggil secara eksplisit oleh kode dalam biner, misalnya, jika kode Anda terdaftar untuk menerima beberapa callback yang disediakan oleh beberapa layanan.

Jika alwayslink tidak berfungsi dengan VS 2017 di Windows, hal ini disebabkan oleh masalah umum, upgrade VS 2017 Anda ke versi terbaru.

copts

Daftar string; default-nya adalah []

Tambahkan opsi ini ke perintah kompilasi C++. Tunduk pada penggantian "Make variable" dan tokenisasi shell Bourne.

Setiap string dalam atribut ini ditambahkan dalam urutan yang diberikan ke COPTS sebelum mengompilasi target biner. Flag ini hanya berlaku untuk mengompilasi target ini, bukan dependensinya, jadi berhati-hatilah dengan file header yang disertakan di tempat lain. Semua jalur harus relatif terhadap ruang kerja, bukan paket saat ini.

Jika paket mendeklarasikan fitur no_copts_tokenization, tokenisasi shell Bourne hanya berlaku untuk string yang terdiri dari satu variabel "Make".

defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi ke target ini, serta ke setiap aturan yang bergantung padanya. Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan nilai yang ditentukan ke local_defines.
implementation_deps

Daftar label; default-nya adalah []

Daftar library lain yang menjadi dependensi target library. Tidak seperti deps, header dan jalur penyertaan library ini (dan semua dependensi transitifnya) hanya digunakan untuk kompilasi library ini, dan bukan library yang bergantung padanya. Library yang ditentukan dengan implementation_deps masih ditautkan dalam target biner yang bergantung pada library ini.

Untuk saat ini, penggunaan dibatasi untuk cc_libraries dan dilindungi oleh flag --experimental_cc_implementation_deps.

include_prefix

String; default-nya adalah ""

Awalan yang akan ditambahkan ke jalur header aturan ini.

Jika ditetapkan, header dalam atribut hdrs aturan ini dapat diakses di nilai atribut ini yang ditambahkan ke jalur relatif repositorinya.

Awalan dalam atribut strip_include_prefix dihapus sebelum awalan ini ditambahkan.

includes

Daftar string; default-nya adalah []

Daftar direktori yang akan disertakan ke baris kompilasi.

Tunduk pada penggantian "Buat variabel". Setiap string diawali dengan -isystem dan ditambahkan ke COPTS. Tidak seperti COPTS, flag ini ditambahkan untuk aturan ini dan setiap aturan yang bergantung padanya. (Catatan: bukan aturan yang menjadi dependensinya!) Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan flag "-I" ke COPTS.

Header harus ditambahkan ke srcs atau hdrs. Jika tidak, header tidak akan tersedia untuk aturan dependen saat kompilasi di-sandbox (default).

linkopts

Daftar string; default-nya adalah []

Tambahkan flag ini ke perintah linker C++. Tunduk pada penggantian variabel"Make", tokenisasi shell Bourne, dan ekspansi label. Setiap string dalam atribut ini ditambahkan ke LINKOPTS sebelum menautkan target biner.

Setiap elemen dalam daftar ini yang tidak dimulai dengan $ atau - diasumsikan sebagai label target di deps. Daftar file yang dihasilkan oleh target tersebut ditambahkan ke opsi penaut. Error akan dilaporkan jika label tidak valid, atau tidak dideklarasikan di deps.

linkstamp

Label; default-nya adalah None

Mengompilasi dan menautkan file sumber C++ yang ditentukan secara bersamaan ke biner akhir. Trik ini diperlukan untuk memasukkan informasi stempel waktu ke dalam biner; jika kita mengompilasi file sumber ke file objek dengan cara biasa, stempel waktu akan salah. Kompilasi linkstamp mungkin tidak menyertakan kumpulan tanda compiler tertentu sehingga tidak boleh bergantung pada header, opsi compiler, atau variabel build tertentu. Opsi ini hanya diperlukan dalam paket base.
linkstatic

Boolean; default-nya adalah False

Untuk cc_binary dan cc_test: tautkan biner dalam mode statis. Untuk cc_library.linkstatic: lihat di bawah.

Secara default, opsi ini diaktifkan untuk cc_binary dan dinonaktifkan untuk yang lainnya.

Jika diaktifkan dan ini adalah biner atau pengujian, opsi ini akan memberi tahu alat build untuk menautkan .a, bukan .so, untuk library pengguna jika memungkinkan. Beberapa library sistem mungkin masih ditautkan secara dinamis, seperti library yang tidak memiliki library statis. Jadi, file yang dapat dieksekusi yang dihasilkan akan tetap ditautkan secara dinamis, sehingga hanya sebagian besar statis.

Sebenarnya ada tiga cara berbeda untuk menautkan file yang dapat dieksekusi:

  • STATIC dengan fitur fully_static_link, yang menautkan semuanya secara statis; mis. "gcc -static foo.o libbar.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan fully_static_link di atribut features.
  • STATIC, dengan semua library pengguna ditautkan secara statis (jika versi statis tersedia), tetapi library sistem (tidak termasuk library runtime C/C++) ditautkan secara dinamis, misalnya "gcc foo.o libfoo.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=True.
  • DINAMIS, dengan semua library ditautkan secara dinamis (jika versi dinamis tersedia), misalnya "gcc foo.o libfoo.so libbaz.so -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=False.

Atribut linkstatic memiliki arti yang berbeda jika digunakan pada cc_library() aturan. Untuk library C++, linkstatic=True menunjukkan bahwa hanya penautan statis yang diizinkan, sehingga tidak ada .so yang akan dihasilkan. linkstatic=False tidak mencegah library statis dibuat. Atribut ini dimaksudkan untuk mengontrol pembuatan library dinamis.

Jika linkstatic=False, alat build akan membuat symlink ke library bersama yang bergantung di area *.runfiles.

local_defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi untuk target ini, tetapi tidak ke dependensinya.
nocopts

String; default-nya adalah ""

Hapus opsi yang cocok dari perintah kompilasi C++. Tunduk pada penggantian variabel"Make". Nilai atribut ini ditafsirkan sebagai ekspresi reguler. Setiap COPTS yang sudah ada dan cocok dengan ekspresi reguler ini (termasuk nilai yang ditentukan secara eksplisit dalam atribut copts aturan) akan dihapus dari COPTS untuk tujuan mengompilasi aturan ini. Atribut ini jarang diperlukan.
strip_include_prefix

String; default-nya adalah ""

Awalan yang akan dihapus dari jalur header aturan ini.

Jika ditetapkan, header dalam atribut hdrs aturan ini dapat diakses di jalurnya dengan awalan ini dipotong.

Jika merupakan jalur relatif, jalur tersebut akan dianggap sebagai jalur relatif paket. Jika bersifat absolut, jalur tersebut akan dipahami sebagai jalur relatif repositori.

Awalan dalam atribut include_prefix ditambahkan setelah awalan ini dihapus.

textual_hdrs

Daftar label; default-nya adalah []

Daftar file header yang dipublikasikan oleh library ini untuk disertakan secara tekstual oleh sumber dalam aturan dependen.

Ini adalah lokasi untuk mendeklarasikan file header yang tidak dapat dikompilasi sendiri; yaitu, file tersebut selalu harus disertakan secara tekstual oleh file sumber lain untuk mem-build kode yang valid.

win_def_file

Label; default-nya adalah None

File DEF Windows yang akan diteruskan ke penaut.

Atribut ini hanya boleh digunakan jika Windows adalah platform target. Library ini dapat digunakan untuk mengekspor simbol selama penautan library bersama.

cc_proto_library

Melihat sumber aturan
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 menghasilkan kode C++ dari file .proto.

deps harus mengarah ke aturan proto_library .

Contoh:

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

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

proto_library(
    name = "foo_proto",
)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar aturan proto_library untuk membuat kode C++.

cc_shared_library

Melihat sumber aturan
cc_shared_library(name, deps, additional_linker_inputs, dynamic_deps, exports_filter, shared_lib_name, tags, user_link_flags, win_def_file)

Tindakan ini akan menghasilkan library bersama.

Contoh

cc_shared_library(
    name = "foo_shared",
    deps = [
        ":foo",
    ],
    dynamic_deps = [
        ":bar_shared",
    ],
    additional_linker_inputs = [
        ":foo.lds",
    ],
    user_link_flags = [
        "-Wl,--version-script=$(location :foo.lds)",
    ],
)
cc_library(
    name = "foo",
    srcs = ["foo.cc"],
    hdrs = ["foo.h"],
    deps = [
        ":bar",
        ":baz",
    ],
)
cc_shared_library(
    name = "bar_shared",
    shared_lib_name = "bar.so",
    deps = [":bar"],
)
cc_library(
    name = "bar",
    srcs = ["bar.cc"],
    hdrs = ["bar.h"],
)
cc_library(
    name = "baz",
    srcs = ["baz.cc"],
    hdrs = ["baz.h"],
)

Dalam contoh, foo_shared menautkan foo dan baz secara statis, dengan baz sebagai dependensi transitif. Fungsi ini tidak menautkan bar karena sudah disediakan secara dinamis oleh dynamic_dep bar_shared.

foo_shared menggunakan file skrip penaut *.lds untuk mengontrol simbol yang akan diekspor. Logika aturan cc_shared_library tidak mengontrol simbol mana yang diekspor, tetapi hanya menggunakan apa yang diasumsikan diekspor untuk memberikan error selama fase analisis jika dua library bersama mengekspor target yang sama.

Setiap dependensi langsung cc_shared_library diasumsikan diekspor. Oleh karena itu, Bazel mengasumsikan selama analisis bahwa foo sedang diekspor oleh foo_shared. baz tidak dianggap diekspor oleh foo_shared. Setiap target yang cocok dengan exports_filter juga diasumsikan diekspor.

Setiap cc_library dalam contoh harus muncul maksimal dalam satu cc_shared_library. Jika ingin menautkan baz juga ke bar_shared, kita harus menambahkan tags = ["LINKABLE_MORE_THAN_ONCE"] ke baz.

Karena atribut shared_lib_name, file yang dihasilkan oleh bar_shared akan memiliki nama bar.so, bukan nama libbar.so yang akan dimiliki secara default di Linux.

Error

Two shared libraries in dependencies export the same symbols.

Hal ini akan terjadi setiap kali Anda membuat target dengan dua dependensi cc_shared_library yang berbeda yang mengekspor target yang sama. Untuk memperbaikinya, Anda harus menghentikan library agar tidak diekspor di salah satu dependensi cc_shared_library.

Hal ini akan terjadi setiap kali Anda membuat cc_shared_library baru dengan dua dependensi cc_shared_library yang berbeda yang menautkan target yang sama secara statis. Mirip dengan error pada ekspor.

Salah satu cara untuk memperbaikinya adalah dengan berhenti menautkan library ke salah satu dependensi cc_shared_library. Pada saat yang sama, library yang masih menautkannya harus mengekspor library sehingga library yang tidak menautkannya tetap memiliki visibilitas terhadap simbol. Cara lainnya adalah dengan mengambil library ketiga yang mengekspor target. Cara ketiga adalah memberi tag pada cc_library pelaku dengan LINKABLE_MORE_THAN_ONCE, tetapi perbaikan ini jarang terjadi dan Anda harus memastikan bahwa cc_library memang aman untuk ditautkan lebih dari sekali.

'//foo:foo' is already linked statically in '//bar:bar' but not exported`

Artinya, library dalam penutupan transitif deps Anda dapat dijangkau tanpa melalui salah satu dependensi cc_shared_library, tetapi sudah dikaitkan ke cc_shared_library yang berbeda di dynamic_deps dan tidak diekspor.

Solusinya adalah mengekspornya dari dependensi cc_shared_library atau menarik cc_shared_library ketiga yang mengekspornya.

Do not place libraries which only contain a precompiled dynamic library in deps.

Jika Anda memiliki library dinamis yang telah dikompilasi sebelumnya, library ini tidak perlu dan tidak dapat ditautkan secara statis ke target cc_shared_library saat ini yang sedang Anda buat. Oleh karena itu, nilai ini tidak termasuk dalam deps dari cc_shared_library. Jika library dinamis yang telah dikompilasi sebelumnya ini merupakan dependensi dari salah satu cc_libraries Anda, cc_library harus bergantung pada library tersebut secara langsung.

Trying to export a library already exported by a different shared library

Anda akan melihat error ini jika pada aturan saat ini Anda mengklaim untuk mengekspor target yang sudah diekspor oleh salah satu dependensi dinamis Anda.

Untuk memperbaikinya, hapus target dari deps dan cukup andalkan dari dependensi dinamis atau pastikan exports_filter tidak menangkap target ini.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Library tingkat teratas yang akan ditautkan secara statis ke dalam library bersama tanpa syarat setelah diarsipkan secara keseluruhan.

Setiap dependensi library transitif dari dependensi langsung ini akan ditautkan ke library bersama ini selama belum ditautkan oleh cc_shared_library di dynamic_deps.

Selama analisis, penerapan aturan akan menganggap target apa pun yang tercantum dalam deps sebagai diekspor oleh library bersama untuk memberikan error saat beberapa cc_shared_libraries mengekspor target yang sama. Penerapan aturan tidak menangani pemberitahuan kepada penaut tentang simbol mana yang harus diekspor oleh objek bersama. Pengguna harus menangani hal ini melalui skrip penaut atau deklarasi visibilitas dalam kode sumber.

Implementasi juga akan memicu error setiap kali library yang sama ditautkan secara statis ke lebih dari satu cc_shared_library. Hal ini dapat dihindari dengan menambahkan "LINKABLE_MORE_THAN_ONCE" ke cc_library.tags atau dengan mencantumkan `cc_library` sebagai ekspor dari salah satu library bersama sehingga salah satunya dapat dibuat menjadi dynamic_dep dari library lainnya.

additional_linker_inputs

Daftar label; default-nya adalah []

File tambahan apa pun yang mungkin ingin Anda teruskan ke penaut, misalnya, skrip penaut. Anda harus meneruskan flag penaut yang diperlukan penaut secara terpisah agar mengetahui file ini. Anda dapat melakukannya melalui atribut user_link_flags.
dynamic_deps

Daftar label; default-nya adalah []

Ini adalah dependensi cc_shared_library lain yang menjadi dependensi target saat ini.

Implementasi cc_shared_library akan menggunakan daftar dynamic_deps (secara transitif, yaitu juga dynamic_deps dari dynamic_deps target saat ini) untuk memutuskan cc_libraries mana dalam deps transitif yang tidak boleh ditautkan karena sudah disediakan oleh cc_shared_library yang berbeda.

exports_filter

Daftar string; default-nya adalah []

Atribut ini berisi daftar target yang diklaim diekspor oleh library bersama saat ini.

Setiap target deps sudah dipahami untuk diekspor oleh library bersama. Atribut ini harus digunakan untuk mencantumkan target apa pun yang diekspor oleh library bersama, tetapi merupakan dependensi transitif dari deps.

Perhatikan bahwa atribut ini sebenarnya tidak menambahkan tepi dependensi ke target tersebut, tetapi tepi dependensi harus dibuat oleh deps.Entri dalam atribut ini hanyalah string. Perlu diingat bahwa saat menempatkan target dalam atribut ini, hal ini dianggap sebagai klaim bahwa library bersama mengekspor simbol dari target tersebut. Logika cc_shared_library sebenarnya tidak menangani cara memberi tahu penaut simbol mana yang harus diekspor.

Sintaks berikut diizinkan:

//foo:__package__ untuk memperhitungkan target apa pun di foo/BUILD

//foo:__subpackages__ untuk memperhitungkan target apa pun di foo/BUILD atau paket lain di bawah foo/ seperti foo/bar/BUILD

shared_lib_name

String; default-nya adalah ""

Secara default, cc_shared_library akan menggunakan nama untuk file output library bersama berdasarkan nama target dan platform. Ini mencakup ekstensi dan terkadang awalan. Terkadang Anda mungkin tidak menginginkan nama default, misalnya, saat memuat library bersama C++ untuk Python, awalan lib* default sering kali tidak diinginkan, dalam hal ini Anda dapat menggunakan atribut ini untuk memilih nama kustom.

Daftar string; default-nya adalah []

Tanda tambahan yang mungkin ingin Anda teruskan ke penaut. Misalnya, agar linker mengetahui skrip penaut yang diteruskan melalui additional_linker_inputs, Anda dapat menggunakan hal berikut:
         cc_shared_library(
            name = "foo_shared",
            additional_linker_inputs = select({
              "//src/conditions:linux": [
                ":foo.lds",
                ":additional_script.txt",
              ],
              "//conditions:default": []}),
            user_link_flags = select({
              "//src/conditions:linux": [
                "-Wl,-rpath,kittens",
                "-Wl,--version-script=$(location :foo.lds)",
                "-Wl,--script=$(location :additional_script.txt)",
              ],
              "//conditions:default": []}),
              ...
         )
        
win_def_file

Label; default-nya adalah None

File DEF Windows yang akan diteruskan ke penaut.

Atribut ini hanya boleh digunakan jika Windows adalah platform target. Library ini dapat digunakan untuk mengekspor simbol selama penautan library bersama.

cc_static_library

Melihat sumber aturan
cc_static_library(name, deps, tags)
Menghasilkan library statis dari daftar target dan dependensi transitifnya.

Library statis yang dihasilkan berisi file objek target yang tercantum dalam deps serta dependensi transitifnya, dengan preferensi yang diberikan ke objek PIC.

Grup output

linkdeps

File teks yang berisi label dependensi transitif target yang tercantum dalam deps yang tidak berkontribusi pada file objek apa pun ke library statis, tetapi menyediakan setidaknya satu library statis, dinamis, atau antarmuka. Library statis yang dihasilkan mungkin memerlukan library ini tersedia pada waktu penautan.

linkopts

File teks yang berisi linkopts yang disediakan pengguna dari semua dependensi transitif target yang tercantum dalam deps.

Simbol duplikat

Secara default, aturan cc_static_library memeriksa apakah library statis yang dihasilkan tidak berisi simbol duplikat. Jika demikian, build akan gagal dengan pesan error yang mencantumkan simbol duplikat dan file objek yang berisinya.

Pemeriksaan ini dapat dinonaktifkan per target atau per paket dengan menetapkan features = ["-symbol_check"] atau secara global melalui --features=-symbol_check.

Dukungan toolchain untuk symbol_check

Toolchain C++ yang dikonfigurasi otomatis dan dikirimkan dengan Bazel mendukung fitur symbol_check di semua platform. toolchain kustom dapat menambahkan dukungan untuk hal ini dengan salah satu dari dua cara:

  • Menerapkan tindakan ACTION_NAMES.validate_static_library dan mengaktifkannya dengan fitur symbol_check. Alat yang ditetapkan dalam tindakan dipanggil dengan dua argumen, library statis untuk memeriksa simbol duplikat dan jalur file yang harus dibuat jika pemeriksaan lulus.
  • Memiliki fitur symbol_check yang menambahkan flag pengarsip yang menyebabkan tindakan pembuatan library statis gagal pada simbol duplikat.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar target yang akan digabungkan menjadi library statis, termasuk semua dependensi transitifnya.

Dependensi yang tidak menyediakan file objek apa pun tidak disertakan dalam library statis, tetapi labelnya dikumpulkan dalam file yang disediakan oleh grup output linkdeps.

fdo_prefetch_hints

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

Merepresentasikan profil petunjuk pengambilan data FDO yang ada di ruang kerja atau di jalur absolut yang ditentukan. Contoh:

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

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

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

profile

Label; default-nya adalah None

Label profil petunjuk. File petunjuk memiliki ekstensi .afdo Label juga dapat mengarah ke aturan fdo_absolute_path_profile.

fdo_profile

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

Merepresentasikan profil FDO yang ada di ruang kerja atau di jalur absolut yang ditentukan. Contoh:

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

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

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

absolute_path_profile

String; default-nya adalah ""

Jalur absolut ke profil FDO. File FDO hanya boleh memiliki ekstensi .afdo.
profile

Label; default-nya adalah None

Label profil FDO atau aturan yang membuatnya. File FDO dapat memiliki salah satu ekstensi berikut: .profraw untuk profil LLVM yang tidak diindeks, .profdata untuk profil LLVM yang diindeks, .zip yang menyimpan profil profraw LLVM, .afdo untuk profil AutoFDO, .xfdo untuk profil XBinary. Label juga dapat mengarah ke aturan fdo_absolute_path_profile.
proto_profile

Label; default-nya adalah None

Label profil protobuf.

memprof_profile

Melihat sumber aturan
memprof_profile(name, absolute_path_profile, compatible_with, deprecation, distribs, features, licenses, profile, restricted_to, tags, target_compatible_with, testonly, visibility)

Merepresentasikan profil MEMPROF yang ada di ruang kerja atau di jalur absolut yang ditentukan. Contoh:

memprof_profile(
    name = "memprof",
    profile = "//path/to/memprof:profile.afdo",
)

memprof_profile(
  name = "memprof_abs",
  absolute_path_profile = "/absolute/path/profile.afdo",
)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

absolute_path_profile

String; default-nya adalah ""

Jalur absolut ke profil MEMPROF. File hanya boleh memiliki ekstensi .profdata atau .zip (dengan file zip harus berisi file memprof.profdata).
profile

Label; default-nya adalah None

Label profil MEMPROF. Profil diharapkan memiliki ekstensi .profdata (untuk profil memprof yang diindeks/disimbolkan), atau ekstensi .zip untuk file zip yang berisi file memprof.profdata. Label juga dapat mengarah ke aturan fdo_absolute_path_profile.

propeller_optimize

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

Merepresentasikan profil pengoptimalan Propeller di ruang kerja. Contoh:

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"
)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

ld_profile

Label; default-nya adalah None

Label profil yang diteruskan ke tindakan penautan. File ini memiliki ekstensi .txt.

cc_test

Melihat sumber aturan
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, link_extra_lib, linkopts, linkstatic, local, local_defines, malloc, nocopts, restricted_to, shard_count, size, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility, win_def_file)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

deps

Daftar label; default-nya adalah []

Daftar library lain yang akan ditautkan ke target biner.

Ini dapat berupa target cc_library atau objc_library.

srcs

Daftar label; default-nya adalah []

Daftar file C dan C++ yang diproses untuk membuat target. Ini adalah file sumber dan header C/C++, baik yang tidak dibuat (kode sumber normal) maupun yang dibuat.

Semua file .cc, .c, dan .cpp akan dikompilasi. File ini mungkin adalah file yang dihasilkan: jika file bernama berada di outs dari beberapa aturan lain, aturan ini akan otomatis bergantung pada aturan lain tersebut.

File .h tidak akan dikompilasi, tetapi akan tersedia untuk disertakan oleh sumber dalam aturan ini. File .cc dan .h dapat langsung menyertakan header yang tercantum dalam srcs ini atau dalam hdrs dari aturan apa pun yang tercantum dalam argumen deps.

Semua file #included harus disebutkan dalam srcs atribut aturan ini, atau dalam hdrs atribut cc_library() yang direferensikan. Gaya yang direkomendasikan adalah untuk header yang terkait dengan library agar dicantumkan dalam atribut hdrs library tersebut, dan header lainnya yang terkait dengan sumber aturan ini agar dicantumkan dalam srcs. Lihat "Pemeriksaan penyertaan header" untuk deskripsi yang lebih mendetail.

Jika nama aturan ada di srcs, aturan ini akan otomatis bergantung pada aturan tersebut. Jika outs aturan yang diberi nama adalah file sumber C atau C++, file tersebut akan dikompilasi ke dalam aturan ini; jika file tersebut adalah file library, file tersebut akan ditautkan.

Jenis file srcs yang diizinkan:

  • File sumber C dan C++: .c, .cc, .cpp, .cxx, .c++, .C
  • File header C dan C++: .h, .hh, .hpp, .hxx, .inc, .inl, .H
  • Assembler dengan preprocessor C: .S
  • Arsip: .a, .pic.a
  • Library "Selalu tautkan": .lo, .pic.lo
  • Library bersama, dengan versi atau tanpa versi: .so, .so.version
  • File objek: .o, .pic.o

...dan aturan apa pun yang menghasilkan file tersebut. Ekstensi yang berbeda menunjukkan bahasa pemrograman yang berbeda sesuai dengankonvensi gcc.

additional_linker_inputs

Daftar label; default-nya adalah []

Teruskan file ini ke perintah linker C++.

Misalnya, file .res Windows yang dikompilasi dapat disediakan di sini untuk disematkan dalam target biner.

copts

Daftar string; default-nya adalah []

Tambahkan opsi ini ke perintah kompilasi C++. Tunduk pada penggantian "Make variable" dan tokenisasi shell Bourne.

Setiap string dalam atribut ini ditambahkan dalam urutan yang diberikan ke COPTS sebelum mengompilasi target biner. Flag ini hanya berlaku untuk mengompilasi target ini, bukan dependensinya, jadi berhati-hatilah dengan file header yang disertakan di tempat lain. Semua jalur harus relatif terhadap ruang kerja, bukan paket saat ini.

Jika paket mendeklarasikan fitur no_copts_tokenization, tokenisasi shell Bourne hanya berlaku untuk string yang terdiri dari satu variabel "Make".

defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi ke target ini, serta ke setiap aturan yang bergantung padanya. Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan nilai yang ditentukan ke local_defines.
includes

Daftar string; default-nya adalah []

Daftar direktori yang akan disertakan ke baris kompilasi.

Tunduk pada penggantian "Buat variabel". Setiap string diawali dengan -isystem dan ditambahkan ke COPTS. Tidak seperti COPTS, flag ini ditambahkan untuk aturan ini dan setiap aturan yang bergantung padanya. (Catatan: bukan aturan yang menjadi dependensinya!) Berhati-hatilah, karena hal ini dapat berdampak luas. Jika ragu, tambahkan flag "-I" ke COPTS.

Header harus ditambahkan ke srcs atau hdrs. Jika tidak, header tidak akan tersedia untuk aturan dependen saat kompilasi di-sandbox (default).

Label; default-nya adalah "@bazel_tools//tools/cpp:link_extra_lib"

Mengontrol penautan library tambahan.

Secara default, biner C++ ditautkan ke //tools/cpp:link_extra_lib, yang secara default bergantung pada tanda label //tools/cpp:link_extra_libs. Tanpa menetapkan tanda, library ini kosong secara default. Menetapkan tanda label memungkinkan penautan dependensi opsional, seperti penggantian untuk simbol lemah, interceptor untuk fungsi library bersama, atau library runtime khusus (untuk penggantian malloc, pilih malloc atau --custom_malloc). Menetapkan atribut ini ke None akan menonaktifkan perilaku ini.

linkopts

Daftar string; default-nya adalah []

Tambahkan flag ini ke perintah linker C++. Tunduk pada penggantian variabel"Make", tokenisasi shell Bourne, dan ekspansi label. Setiap string dalam atribut ini ditambahkan ke LINKOPTS sebelum menautkan target biner.

Setiap elemen dalam daftar ini yang tidak dimulai dengan $ atau - diasumsikan sebagai label target di deps. Daftar file yang dihasilkan oleh target tersebut ditambahkan ke opsi penaut. Error akan dilaporkan jika label tidak valid, atau tidak dideklarasikan di deps.

linkstatic

Boolean; default-nya adalah False

Untuk cc_binary dan cc_test: tautkan biner dalam mode statis. Untuk cc_library.linkstatic: lihat di bawah.

Secara default, opsi ini diaktifkan untuk cc_binary dan dinonaktifkan untuk yang lainnya.

Jika diaktifkan dan ini adalah biner atau pengujian, opsi ini akan memberi tahu alat build untuk menautkan .a, bukan .so, untuk library pengguna jika memungkinkan. Beberapa library sistem mungkin masih ditautkan secara dinamis, seperti library yang tidak memiliki library statis. Jadi, file yang dapat dieksekusi yang dihasilkan akan tetap ditautkan secara dinamis, sehingga hanya sebagian besar statis.

Sebenarnya ada tiga cara berbeda untuk menautkan file yang dapat dieksekusi:

  • STATIC dengan fitur fully_static_link, yang menautkan semuanya secara statis; mis. "gcc -static foo.o libbar.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan fully_static_link di atribut features.
  • STATIC, dengan semua library pengguna ditautkan secara statis (jika versi statis tersedia), tetapi library sistem (tidak termasuk library runtime C/C++) ditautkan secara dinamis, misalnya "gcc foo.o libfoo.a libbaz.a -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=True.
  • DINAMIS, dengan semua library ditautkan secara dinamis (jika versi dinamis tersedia), misalnya "gcc foo.o libfoo.so libbaz.so -lm".
    Mode ini diaktifkan dengan menentukan linkstatic=False.

Atribut linkstatic memiliki arti yang berbeda jika digunakan pada cc_library() aturan. Untuk library C++, linkstatic=True menunjukkan bahwa hanya penautan statis yang diizinkan, sehingga tidak ada .so yang akan dihasilkan. linkstatic=False tidak mencegah library statis dibuat. Atribut ini dimaksudkan untuk mengontrol pembuatan library dinamis.

Jika linkstatic=False, alat build akan membuat symlink ke library bersama yang bergantung di area *.runfiles.

local_defines

Daftar string; default-nya adalah []

Daftar definisi yang akan ditambahkan ke baris kompilasi. Tunduk pada penggantian variabel"Make" dan tokenisasi shell Bourne. Setiap string, yang harus terdiri dari satu token shell Bourne, diawali dengan -D dan ditambahkan ke command line kompilasi untuk target ini, tetapi tidak ke dependensinya.
malloc

Label; default-nya adalah "@bazel_tools//tools/cpp:malloc"

Mengganti dependensi default pada malloc.

Secara default, biner C++ ditautkan ke //tools/cpp:malloc, yang merupakan library kosong sehingga biner akhirnya menggunakan libc malloc. Label ini harus merujuk ke cc_library. Jika kompilasi ditujukan untuk aturan non-C++, opsi ini tidak akan berpengaruh. Nilai atribut ini diabaikan jika linkshared=True ditentukan.

nocopts

String; default-nya adalah ""

Hapus opsi yang cocok dari perintah kompilasi C++. Tunduk pada penggantian variabel"Make". Nilai atribut ini ditafsirkan sebagai ekspresi reguler. Setiap COPTS yang sudah ada dan cocok dengan ekspresi reguler ini (termasuk nilai yang ditentukan secara eksplisit dalam atribut copts aturan) akan dihapus dari COPTS untuk tujuan mengompilasi aturan ini. Atribut ini jarang diperlukan.
stamp

Bilangan bulat; default-nya adalah 0

Apakah akan mengenkode informasi build ke dalam biner. Nilai yang mungkin:
  • stamp = 1: Selalu stempel informasi build ke dalam biner, bahkan dalam build --nostamp. Setelan ini harus dihindari, karena berpotensi menghentikan penyimpanan dalam cache jarak jauh untuk biner dan tindakan downstream apa pun yang bergantung padanya.
  • stamp = 0: Selalu ganti informasi build dengan nilai konstan. Hal ini memberikan caching hasil build yang baik.
  • stamp = -1: Penyematan informasi build dikontrol oleh flag --[no]stamp.

Biner yang dicap tidak akan di-build ulang kecuali jika dependensinya berubah.

win_def_file

Label; default-nya adalah None

File DEF Windows yang akan diteruskan ke penaut.

Atribut ini hanya boleh digunakan jika Windows adalah platform target. Library ini dapat digunakan untuk mengekspor simbol selama penautan library bersama.

cc_toolchain

Melihat sumber aturan
cc_toolchain(name, all_files, ar_files, as_files, compatible_with, compiler_files, compiler_files_without_includes, coverage_files, 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)

Merepresentasikan toolchain C++.

Aturan ini bertanggung jawab untuk:

  • Mengumpulkan semua artefak yang diperlukan agar tindakan C++ dapat berjalan. Hal ini dilakukan oleh atribut seperti all_files, compiler_files, linker_files, atau atribut lain yang diakhiri dengan _files). Ini adalah grup file yang paling umum yang menggabungkan semua file yang diperlukan.
  • Membuat command line yang benar untuk tindakan C++. Hal ini dilakukan menggunakan penyedia CcToolchainConfigInfo (detail di bawah).

Gunakan atribut toolchain_config untuk mengonfigurasi toolchain C++. Lihat juga halaman ini untuk mengetahui dokumentasi konfigurasi toolchain C++ dan pemilihan toolchain yang mendetail.

Gunakan tags = ["manual"] untuk mencegah toolchain di-build dan dikonfigurasi secara tidak perlu saat memanggil bazel build //...

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

all_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain. Artefak ini akan ditambahkan sebagai input ke semua tindakan terkait rules_cc (kecuali tindakan yang menggunakan kumpulan artefak yang lebih akurat dari atribut di bawah). Bazel mengasumsikan bahwa all_files adalah superset dari semua atribut penyedia artefak lainnya (misalnya, kompilasi linkstamp memerlukan file kompilasi dan link, sehingga memerlukan all_files).

Ini adalah isi cc_toolchain.files, dan ini digunakan oleh semua aturan Starlark yang menggunakan toolchain C++.

ar_files

Label; default-nya adalah None

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan pengarsipan.

as_files

Label; default-nya adalah None

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan assembly.

compiler_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan kompilasi.
compiler_files_without_includes

Label; default-nya adalah None

Pengumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan kompilasi jika penemuan input didukung (saat ini khusus Google).
coverage_files

Label; default-nya adalah None

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan cakupan. Jika tidak ditentukan, all_files akan digunakan.
dwp_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan dwp.
dynamic_runtime_lib

Label; default-nya adalah None

Artefak library dinamis untuk library runtime C++ (misalnya, libstdc++.so).

Ini akan digunakan saat fitur 'static_link_cpp_runtimes' diaktifkan, dan kita menautkan dependensi secara dinamis.

exec_transition_for_inputs

Boolean; default-nya adalah True

Tetapkan ke True untuk mem-build semua input file ke cc_toolchain untuk platform exec, bukan tidak memiliki transisi (yaitu platform target secara default).
libc_top

Label; default-nya adalah None

Kumpulan artefak untuk libc yang diteruskan sebagai input untuk tindakan kompilasi/penautan.
linker_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain yang diperlukan untuk menautkan tindakan.
module_map

Label; default-nya adalah None

Artefak peta modul yang akan digunakan untuk build modular.
objcopy_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan objcopy.
static_runtime_lib

Label; default-nya adalah None

Artefak library statis untuk library runtime C++ (misalnya, libstdc++.a).

Ini akan digunakan saat fitur 'static_link_cpp_runtimes' diaktifkan, dan kita menautkan dependensi secara statis.

strip_files

Label; wajib diisi

Kumpulan semua artefak cc_toolchain yang diperlukan untuk tindakan strip.
supports_header_parsing

Boolean; default-nya adalah False

Tetapkan ke True jika cc_toolchain mendukung tindakan penguraian header.
supports_param_files

Boolean; default-nya adalah True

Tetapkan ke True jika cc_toolchain mendukung penggunaan file parameter untuk tindakan penautan.
toolchain_config

Label; wajib diisi

Label aturan yang menyediakan cc_toolchain_config_info.
toolchain_identifier

String; tidak dapat dikonfigurasi; default-nya adalah ""

ID yang digunakan untuk mencocokkan cc_toolchain ini dengan crosstool_config.toolchain yang sesuai.

Sampai masalah #5380 diperbaiki, ini adalah cara yang direkomendasikan untuk mengaitkan cc_toolchain dengan CROSSTOOL.toolchain. Atribut ini akan diganti dengan atribut toolchain_config (#5380).

cc_toolchain_suite

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

Merepresentasikan kumpulan toolchain C++.

Aturan ini bertanggung jawab untuk:

  • Mengumpulkan semua toolchain C++ yang relevan.
  • Memilih satu toolchain bergantung pada opsi --cpu dan --compiler yang diteruskan ke Bazel.

Lihat juga halaman ini untuk mengetahui dokumentasi konfigurasi toolchain C++ dan pemilihan toolchain yang mendetail.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

toolchains

String pemetaan kamus ke label; tidak dapat dikonfigurasi; wajib

Peta dari string "<cpu>" atau "<cpu>|<compiler>" ke label cc_toolchain. "<cpu>" akan digunakan jika hanya --cpu yang diteruskan ke Bazel, dan "<cpu>|<compiler>" akan digunakan jika --cpu dan --compiler diteruskan ke Bazel. Contoh:

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