Tweaks to benchmarks: update docs, remove UDL, Python was stale. (#2668)

Author: mhammond

fixtures/benchmarks/Cargo.toml

@@ -15,9 +15,6 @@ uniffi = { workspace = true }
 clap = { version = "4", features = ["cargo", "std", "derive"] }
 criterion = "0.5.1"
 
-[build-dependencies]
-uniffi = { workspace = true, features = ["build"] }
-
 [dev-dependencies]
 uniffi_bindgen = {path = "../../uniffi_bindgen", features = ["bindgen-tests"]}
 

fixtures/benchmarks/README.md

@@ -1,5 +1,7 @@
 This fixture runs a set of benchmark tests, using criterion to test the performance.
 
+Note your cwd must be this crate, not the workspace/repo root!
+
 - `cargo bench` to run all benchmarks.
 - `cargo bench -- -p` to run all python benchmarks (or -s for swift, -k for kotlin)
 - `cargo bench -- [glob]` to run a subset of the benchmarks

fixtures/benchmarks/benches/bindings/run_benchmarks.py

@@ -5,7 +5,7 @@
 from benchmarks import *
 import time
 
-class TestCallbackObj:
+class TestCallbackObj(TestCallbackInterface):
     def method(self, a, b, data):
         return data.bar
 
@@ -16,7 +16,7 @@ def method_with_no_args_and_void_return(self):
         pass
 
     def run_test(self, test_case, count):
-        data = TestData("StringOne", "StringTwo")
+        data = TestData(foo="StringOne", bar="StringTwo")
         if test_case == TestCase.FUNCTION:
             start = time.perf_counter_ns()
             for i in range(count):

fixtures/benchmarks/build.rs

@@ -2,37 +2,57 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-use std::env;
+use std::sync::Arc;
 use std::time::Duration;
 
 mod cli;
 pub use cli::Args;
 
+#[derive(uniffi::Record)]
 pub struct TestData {
     foo: String,
     bar: String,
 }
 
+#[derive(uniffi::Enum)]
 pub enum TestCase {
     Function,
     VoidReturn,
     NoArgsVoidReturn,
 }
 
-pub trait TestCallbackInterface {
+/// Test callback methods.
+///
+/// These are intended to test the overhead of callback interface calls
+/// including: popping arguments from the stack, unpacking RustBuffers,
+/// pushing return values back to the stack, etc.
+#[uniffi::export(with_foreign)]
+pub trait TestCallbackInterface: Send + Sync {
     fn method(&self, a: i32, b: i32, data: TestData) -> String;
     fn method_with_void_return(&self, a: i32, b: i32, data: TestData);
     fn method_with_no_args_and_void_return(&self);
+    /// Run a performance test N times and return the elapsed time in nanoseconds
     fn run_test(&self, test_case: TestCase, count: u64) -> u64;
 }
 
+/// Test functions
+///
+/// These are intended to test the overhead of Rust function calls including:
+/// popping arguments from the stack, unpacking RustBuffers, pushing return
+/// values back to the stack, etc.
+#[uniffi::export]
 pub fn test_function(_a: i32, _b: i32, data: TestData) -> String {
     data.bar
 }
+
+#[uniffi::export]
 pub fn test_void_return(_a: i32, _b: i32, _data: TestData) {}
+#[uniffi::export]
 pub fn test_no_args_void_return() {}
 
-pub fn run_benchmarks(language: String, cb: Box<dyn TestCallbackInterface>) {
+/// Run all benchmarks and print the results to stdout
+#[uniffi::export]
+pub fn run_benchmarks(language: String, cb: Arc<dyn TestCallbackInterface>) {
     let args = Args::parse_for_run_benchmarks();
     let mut c = args.build_criterion();
 
@@ -90,4 +110,4 @@ pub fn run_benchmarks(language: String, cb: Box<dyn TestCallbackInterface>) {
     c.final_summary();
 }
 
-uniffi::include_scaffolding!("benchmarks");
+uniffi::setup_scaffolding!("benchmarks");