Google Git
Sign in
bazel / crubit / 9ec82cc8eb98dcff5e6691c07d4af5efc96da556
commit9ec82cc8eb98dcff5e6691c07d4af5efc96da556[log] [tgz]
authorGoogler <no-reply@google.com>Fri Jun 28 17:31:19 2024 -0700
committerCopybara-Service <copybara-worker@google.com>Fri Jun 28 17:32:13 2024 -0700
treecf087f71391a9d872861d18347a78c8eeb219cf1
parent240782f5d5cae15c48fb55d9ca68e02ea68cf3ee [diff]
Automated rollback of commit 240782f5d5cae15c48fb55d9ca68e02ea68cf3ee.

*** Reason for rollback ***

Break cafe.bow.asan.

*** Original change description ***

Disable Crubit on grpc and targets that disable header parsing.

This allows Crubit to work on targets that depend on grpc, as long as they do not transitively include the headers. So, that's a workaround, at least.

This is not "strictly correct": a target might disable header parsing because it has a bad header in `srcs`, which isn't relevant to Crubit which only reads `hdrs`. However, it's almost certainly (also) broken in `srcs`. If ever we need to enable Crubit on a target that...

***

PiperOrigin-RevId: 647840087
Change-Id: I847b2ea3444b8e3932c41fe3bd0f539fcc69f107
4 files changed
tree: cf087f71391a9d872861d18347a78c8eeb219cf1
  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