#ffi

autocxx-build

Safe autogenerated interop between Rust and C++

7 unstable releases (3 breaking)

0.4.0 Nov 10, 2020
0.3.3 Nov 7, 2020
0.3.2 Oct 10, 2020
0.3.0 Sep 19, 2020
0.1.0 Sep 6, 2020

#109 in FFI

Download history 14/week @ 2020-09-02 11/week @ 2020-09-09 17/week @ 2020-09-16 13/week @ 2020-09-23 8/week @ 2020-09-30 30/week @ 2020-10-07 20/week @ 2020-10-14 6/week @ 2020-10-21 15/week @ 2020-10-28 42/week @ 2020-11-04 14/week @ 2020-11-11 6/week @ 2020-11-18

54 downloads per month

MIT/Apache

155KB
4K SLoC

Autocxx

This project is a tool for calling C++ from Rust in a heavily automated, but safe, fashion.

The intention is that it has all the fluent safety from cxx whilst generating interfaces automatically from existing C++ headers using a variant of bindgen. Think of autocxx as glue which plugs bindgen into cxx.

Intended eventual interface

It's intended that eventually this exposes a single procedural macro, something like this:

class Bob {
public:
    Bob(std::string name);
    ...
    void do_a_thing();
}
use autocxx::include_cxx;

include_cxx!(
    Header("base/bob.h"),
    Allow("Bob"),
)

let a = ffi::base::Bob::make_unique("hello".into());
a.do_a_thing();

The existing cxx facilities are used to allow safe ownership of C++ types from Rust; specifically things like std::unique_ptr and std::string - so the Rust code should not typically require use of unsafe code, unlike with normal bindgen bindings.

The macro and code generator will both need to know the include path to be passed to bindgen. At the moment, this is passed in via an environment variable, AUTOCXX_INC. See the demo/build.rs file for details.

How it works

It is effectively a three-stage procedural macro, which:

  • First, runs bindgen to generate some bindings (with all the usual unsafe, #[repr(C)] etc.)
  • Second, interprets and converts them to bindings suitable for cxx::bridge.
  • Thirdly, runs cxx::bridge to convert them to Rust code.

The same code can be passed through tools that generate .cc and .h bindings too:

  • First, runs bindgen to generate some bindings (with all the usual unsafe, #[repr(C)] etc.) - in exactly the same way as above.
  • Second, interprets and converts them to bindings suitable for cxx::bridge - in the same way as above.
  • Thirdly, runs the codegen code from cxx to generate .cc and .h files

Current state of affairs

There is an example of this macro working within the demo directory.

The project also contains test code which does this end-to-end, for all sorts of C++ types and constructs which we eventually would like to support. They nearly all fail :)

Type Status
Primitives (u8, etc.) Works
Plain-old-data structs Works
std::unique_ptr of POD Works
std::unique_ptr of std::string Works
std::unique_ptr of opaque types -
Reference to POD Works
Reference to std::string Works
Classes Works but produced warnings
Methods Works
#defines -
Constants -
Enums In progress; doesn't work yet
Structs containing UniquePtr -
Structs containing strings -
Constructors/make_unique -
Destructors Works via cxx UniquePtr already

Build environment

This crate is not yet on crates.io.

At present, thirteen of the tests pass. The rest are ignored.

Because this uses bindgen, and bindgen may depend on the state of your system C++ headers, it is somewhat sensitive. The following known build problems exist:

  • It requires llvm to be installed due to bindgen
  • On Linux including any system header: bindgen generates pub type __uint32_t = ::std::os::raw::c_uint; which cxx can't cope with. This is just a matter of munging bindgen output more. This currently stops the demo building on my Linux box, and prevents all but one test passing.
  • On Linux using cargo 1.47 nightly: trybuild is unable to pull in dependencies from git repositories because it's in offline mode. Running cargo update first seems to solve this.
  • There's a big blocklist of STL types hard-coded. That may be quite OSX-specific or otherwise subject to different STL implementations.

Configuring the build

This runs bindgen within a procedural macro. There are limited opportunities to pass information into procedural macros, yet bindgen needs to know a lot about the build environment.

The plan is:

  • The Rust code itself will specify the include file(s) and allowlist by passing them into the macro. This is the sort of thing that developers within an existing C++ codebase would specify in C++ (give or take) so it makes sense for it to be specific in the Rust code.
  • However, all build settings (e.g. bindgen compiler configuration, include path etc.) will be passed into the macro by means of environment variables. The build environment should set these before building the code. (An alternative means will be provided to pass these into the C++ code generator tools.)

Directory structure

  • demo - a demo example
  • engine - all the core code. Currently a Rust library, but we wouldn't want to support these APIs for external users, so maybe it needs to be a directory of code symlinked into all the other sub-crates. All the following three sub-crates are thin wrappers for part of this engine. This also contains the test code.
  • gen/build - a library to be used from build.rs scripts to generate .cc and .h files from an include_cxx section.
  • gen/cmd - a command-line tool which does the same. Except this isn't written yet.
  • src (outermost project)- the procedural macro include_cxx as described above.

Next steps

The plan is (roughly) to work through the above list of features. Some are going to be very hard, e.g. strings embedded in structs, and it's not at all clear that a plan will present itself. Until we are much further, I don't advise using this for anything in production.

Credits

David Tolnay did much of the hard work here, by inventing the underlying cxx crate, and in fact nearly all of the parsing infrastructure on which this crate depends.

License and usage notes

This is not an officially supported Google product.

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Dependencies

~6MB
~133K SLoC