1 #+setupfile: ../clean.theme
3 - State "DRAFT" from [2023-11-05 Sun 22:23]
5 Our core languages are
[[https://www.rust-lang.org/][Rust]] and
[[https://lisp-lang.org/][Lisp]] - this is the killer combo which will allow NAS-T
6 to rapidly develop high-quality software. As such, it's crucial that these two very
7 different languages (i.e. compilers) are able to interoperate seamlessly.
9 Some interop methods are easy to accomodate via the OS - such as IPC or data sharing,
10 but others are a bit more difficult.
12 In this 2-part series we'll build a FFI bridge between Rust and Lisp, which is something
13 that
/can/ be difficult, due to some complications with Rust and because this is not the
14 most popular software stack (yet ;). This is an experiment and may not make it to our
15 code-base, but it's definitely something worth adding to the toolbox in case we need it.
18 The level of interop we're after in this case is
[[https://en.wikipedia.org/wiki/Foreign_function_interface][FFI]].
20 Basically, calling Rust code from Lisp and vice-versa. There's an article about calling
21 Rust from Common Lisp
[[https://dev.to/veer66/calling-rust-from-common-lisp-45c5][here]] which shows the basics and serves as a great starting point
24 The complication(s) with Rust I mentioned early is really just that
/it is not C/.
=C= 25 is old, i.e. well-supported with a stable ABI, making the process of creating bindings
26 for a C library a breeze in many languages.
28 For a Rust library we need to first appease the compiler, as explained in
[[https://doc.rust-lang.org/nomicon/ffi.html#calling-rust-code-from-c][this section]] 29 of the Rustonomicon. Among other things it involves changing the calling-convention of
30 functions with a type signature and editing the Cargo.toml file to produce a
31 C-compatible ABI binary. The Rust default ABI is unstable and can't reliably be used
35 Using FFI involves some overhead. Check
[[https://github.com/dyu/ffi-overhead][here]] for an example benchmark across a few
36 languages. While building the NAS-T core, I'm very much aware of this, and will need a
37 few sanity benchmarks to make sure the cost doesn't outweigh the benefit. In particular,
38 I'm concerned about crossing multiple language barriers (Rust
<->C
<->Lisp).
42 For starters, I'm going to assume we all have Rust (via
=rustup=) and Lisp (
=sbcl= only)
43 installed on our GNU/Linux system (some tweaks needed for Darwin/Windows, not covered in
46 Create a new library crate. For this example we're focusing on a 'skeleton' for
47 /dynamic/ libraries only, so our experiment will be called
=dylib-skel= or
*dysk* for
49 src_sh[:exports code]{cargo init dysk --lib && cd dysk}
51 A
=src/lib.rs= will be generated for you. Go ahead and delete that. We're going to be
52 making our own
=lib.rs= file directly in the root directory (just to be cool).
54 The next step is to edit your
=Cargo.toml= file. Add these lines after the
=[package]= 55 section and before
=[dependencies]=:
58 crate-type = ["cdylib","rlib"]
65 This tells Rust to generate a shared C-compatible object with a
=.so= extension which we
66 can open using
[[https://man.archlinux.org/man/dlopen.3.en][dlopen]].
69 Next, we want the
=cbindgen= program which we'll use to generate header files for
70 C/C++. This step isn't necessary at all, we just want it for further experimentation.
72 src_sh[:exports code]{cargo install --force cbindgen}
74 We append the
=cbindgen= crate as a
/build dependency/ to our
=Cargo.toml= like so:
80 #+begin_src conf-toml :tangle cbindgen.toml 82 autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
83 include_version = true
86 after_includes = "#define DYSK_VERSION \"0.1.0\""
90 documentation_style = "c99"
91 usize_is_size_t = true
96 #+begin_src rust :tangle build.rs 97 fn main() -> Result<(), cbindgen::Error> {
98 if let Ok(b) = cbindgen::generate(std::env::var("CARGO_MANIFEST_DIR").unwrap()) {
99 b.write_to_file("dysk.h"); Ok(())}
100 else { panic!("failed to generate dysk.h from cbindgen.toml") } }
103 #+begin_src rust :tangle lib.rs 104 //! lib.rs --- dysk library
105 use std::ffi::{c_char, c_int, CString};
107 pub extern "C" fn dysk_hello() -> *const c_char {
108 CString::new("hello from rust").unwrap().into_raw()}
110 pub extern "C" fn dysk_plus(a:c_int,b:c_int) -> c_int {a+b}
112 pub extern "C" fn dysk_plus1(n:c_int) -> c_int {n+1}
115 #+begin_src rust :tangle test.rs 116 //! test.rs --- dysk test
117 fn main() { let mut i = 0u32; while i < 500000000 {i+=1; dysk::dysk_plus1(2 as core::ffi::c_int);}}
121 cargo build --release
124 #+begin_src lisp :tangle dysk.lisp 125 (load-shared-object #P"target/release/libdysk.so")
126 (define-alien-routine dysk-hello c-string)
127 (define-alien-routine dysk-plus int (a int) (b int))
128 (define-alien-routine dysk-plus1 int (n int))
129 (dysk-hello) ;; => "hello from rust"
133 time target/release/dysk-test
135 #+begin_src lisp :tangle test.lisp 136 (time (dotimes (_ 500000000) (dysk-plus1 2)))