Google Git
Sign in
bazel / crubit / b5bd025ce14f0f1a898cd29f0aa3b7abf1d7f757
commitb5bd025ce14f0f1a898cd29f0aa3b7abf1d7f757[log] [tgz]
authorDmitri Gribenko <dmitrig@google.com>Mon Aug 05 02:58:22 2024 -0700
committerCopybara-Service <copybara-worker@google.com>Mon Aug 05 02:59:07 2024 -0700
treecffefa8c47b9c610029a0b9f153269b30d66b908
parent94ef642d0f2f92352fe749aa0a456aa1de3ccf2c [diff]
Pass down `extra_rustc_flag` when compiling bindings for the C++ standard library

The `bindings_for_toolchain_headers` rule that compiles the `cc_std` target
eventually calls `construct_arguments()` which reads `extra_rustc_flag`.

`extra_rustc_flag` can be used, for example, to enable Memory Sanitizer, and
thus it is critical that it is passed down to every rustc action.

PiperOrigin-RevId: 659488753
Change-Id: I5f5c630b08d6f62ebf3358efc2c283fc2f336c4d
1 file changed
tree: cffefa8c47b9c610029a0b9f153269b30d66b908
  1. .bazelci/
  2. bazel/
  3. cc_bindings_from_rs/
  4. common/
  5. docs/
  6. examples/
  7. features/
  8. lifetime_analysis/
  9. lifetime_annotations/
  10. migrator/
  11. nullability/
  12. rs_bindings_from_cc/
  13. support/
  14. .bazelrc
  15. .gitignore
  16. BUILD
  17. Cargo.lock
  18. CODE_OF_CONDUCT
  19. CONTRIBUTING
  20. LICENSE
  21. MODULE.bazel
  22. README.md
  23. WORKSPACE.bzlmod
README.md

Crubit: C++/Rust Bidirectional Interop Tool

Build status

NOTE: Crubit currently expects deep integration with the build system, and is difficult to deploy to environments dissimilar to Google's monorepo. We do not have our tooling set up to accept external contributions at this time.

Crubit is a bidirectional bindings generator for C++ and Rust, with the goal of integrating the C++ and Rust ecosystems.

Status

Support for calling FFI-friendly C++ from Rust is in progress.

Support for calling Rust from C++ will arrive in 2024H2.

Example

Consider the following C++ function:

extern "C" bool IsGreater(int lhs, int rhs);

This function, if present in a header file which is processed by Crubit, becomes callable from Rust as if it were defined as:

pub fn IsGreater(lhs: ffi::c_int, rhs: ffi::c_int) -> bool {...}

Note: There are some temporary restrictions on the API shape. For example, functions that are not extern "C", or that accept a type like std::string, can't be called from Rust directly via Crubit. These restrictions will be relaxed over time.

Getting Started

Here are some resources for getting started with Crubit:

  • Rust Bindings for C++ Libraries is a detailed walkthrough on how to use C++ from Rust using Crubit.

  • The examples/cpp/ directory has copy-pastable examples of calling C++ from Rust, together with snapshots of what the generated Rust interface looks like.

Building Crubit

$ apt install clang lld bazel
$ git clone git@github.com:google/crubit.git
$ cd crubit
$ bazel build --linkopt=-fuse-ld=/usr/bin/ld.lld //rs_bindings_from_cc:rs_bindings_from_cc_impl

Using a prebuilt LLVM tree

$ git clone https://github.com/llvm/llvm-project
$ cd llvm-project
$ CC=clang CXX=clang++ cmake -S llvm -B build -DLLVM_ENABLE_PROJECTS='clang' -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install
$ cmake --build build -j
$ # wait...
$ cmake --install build
$ cd ../crubit
$ LLVM_INSTALL_PATH=../llvm-project/install bazel build //rs_bindings_from_cc:rs_bindings_from_cc_impl