2210: Tracing printouts for FFI calls

Added the `uniffi:ffi-trace` feature. If enabled, UniFFI will printout tracing-level logs for FFI calls. I hooked up the futures code to this, in the future we could also log more stuff. Lowering/lifting/cloning arcs is the first example that comes to mind. To see tracing, use the `--features=ffi-trace` when running a tests, for example: - `cd fixtures/futures/src` - `cargo test --features=ffi-trace` Here's an example of the tracing printouts when running tests from the futures fixtures: ``` rust_future_new: Handle(94402427620656) rust_future_poll: Handle(94402427620656) RustFuture::wake called rust_future_poll: Handle(94402427620656) RustFuture::poll is ready (canceled: false) rust_future_complete: Handle(94402427620656) rust_future_free: Handle(94402427620656) ```
mozilla · Aug 9, 2024 · fdf1919 · fdf1919
1 parent 7ff7584
commit fdf1919
Show file tree

Hide file tree

Showing 63 changed files with 201 additions and 5 deletions.
diff --git a/examples/app/uniffi-bindgen-cli/Cargo.toml b/examples/app/uniffi-bindgen-cli/Cargo.toml
@@ -10,3 +10,6 @@ path = "uniffi-bindgen.rs"
 
 [dependencies]
 uniffi = { workspace = true, features = ["cli"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/arithmetic-procmacro/Cargo.toml b/examples/arithmetic-procmacro/Cargo.toml
@@ -16,3 +16,6 @@ thiserror = "1.0"
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/arithmetic/Cargo.toml b/examples/arithmetic/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build", "scaffolding-ffi-buffer-fns"]
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/async-api-client/Cargo.toml b/examples/async-api-client/Cargo.toml
@@ -21,3 +21,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/callbacks/Cargo.toml b/examples/callbacks/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/custom-types/Cargo.toml b/examples/custom-types/Cargo.toml
@@ -21,3 +21,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/futures/Cargo.toml b/examples/futures/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/geometry/Cargo.toml b/examples/geometry/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/rondpoint/Cargo.toml b/examples/rondpoint/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/sprites/Cargo.toml b/examples/sprites/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/todolist/Cargo.toml b/examples/todolist/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/examples/traits/Cargo.toml b/examples/traits/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
 
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/benchmarks/Cargo.toml b/fixtures/benchmarks/Cargo.toml
@@ -25,3 +25,6 @@ uniffi_bindgen = {path = "../../uniffi_bindgen", features = ["bindgen-tests"]}
 [[bench]]
 name = "benchmarks"
 harness = false
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/callbacks/Cargo.toml b/fixtures/callbacks/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/coverall/Cargo.toml b/fixtures/coverall/Cargo.toml
@@ -22,3 +22,6 @@ uniffi = { workspace = true, features = ["build"] }
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
 uniffi_meta = { path = "../../uniffi_meta/" }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/docstring-proc-macro/Cargo.toml b/fixtures/docstring-proc-macro/Cargo.toml
@@ -23,3 +23,6 @@ glob = "0.3"
 uniffi = { path = "../../uniffi", features = ["bindgen-tests"] }
 uniffi_bindgen = { path = "../../uniffi_bindgen" }
 uniffi_testing = { path = "../../uniffi_testing" }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/docstring/Cargo.toml b/fixtures/docstring/Cargo.toml
@@ -23,3 +23,6 @@ glob = "0.3"
 uniffi = { path = "../../uniffi", features = ["bindgen-tests"] }
 uniffi_bindgen = { path = "../../uniffi_bindgen" }
 uniffi_testing = { path = "../../uniffi_testing" }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/enum-types/Cargo.toml b/fixtures/enum-types/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/error-types/Cargo.toml b/fixtures/error-types/Cargo.toml
@@ -20,3 +20,5 @@ uniffi = {path = "../../uniffi", features = ["build"] }
 [dev-dependencies]
 uniffi = {path = "../../uniffi", features = ["bindgen-tests"] }
 
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/custom-types/Cargo.toml b/fixtures/ext-types/custom-types/Cargo.toml
@@ -21,3 +21,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/http-headermap/Cargo.toml b/fixtures/ext-types/http-headermap/Cargo.toml
@@ -21,3 +21,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/lib/Cargo.toml b/fixtures/ext-types/lib/Cargo.toml
@@ -40,3 +40,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/proc-macro-lib/Cargo.toml b/fixtures/ext-types/proc-macro-lib/Cargo.toml
@@ -35,3 +35,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/sub-lib/Cargo.toml b/fixtures/ext-types/sub-lib/Cargo.toml
@@ -25,3 +25,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/ext-types/uniffi-one/Cargo.toml b/fixtures/ext-types/uniffi-one/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true }
 
 [build-dependencies]
 uniffi = { workspace = true, features = ["build"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/futures/Cargo.toml b/fixtures/futures/Cargo.toml
@@ -28,3 +28,6 @@ uniffi = { workspace = true, features = ["build", "scaffolding-ffi-buffer-fns"]
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/keywords/kotlin/Cargo.toml b/fixtures/keywords/kotlin/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/keywords/rust/Cargo.toml b/fixtures/keywords/rust/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/keywords/swift/Cargo.toml b/fixtures/keywords/swift/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/large-enum/Cargo.toml b/fixtures/large-enum/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/large-error/Cargo.toml b/fixtures/large-error/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/metadata/Cargo.toml b/fixtures/metadata/Cargo.toml
@@ -13,3 +13,6 @@ thiserror = "1.0"
 uniffi = { workspace = true }
 uniffi_meta = { path = "../../uniffi_meta" }
 uniffi_core = { path = "../../uniffi_core" }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/proc-macro-no-implicit-prelude/Cargo.toml b/fixtures/proc-macro-no-implicit-prelude/Cargo.toml
@@ -12,6 +12,7 @@ crate-type = ["lib", "cdylib"]
 
 [features]
 default = ["myfeature"]
+ffi-trace = ["uniffi/ffi-trace"]
 myfeature = []
 
 [dependencies]

diff --git a/fixtures/proc-macro/Cargo.toml b/fixtures/proc-macro/Cargo.toml
@@ -12,6 +12,7 @@ crate-type = ["lib", "cdylib"]
 
 [features]
 default = ["myfeature"]
+ffi-trace = ["uniffi/ffi-trace"]
 myfeature = []
 
 [dependencies]

diff --git a/fixtures/regressions/cdylib-crate-type-dependency/ffi-crate/Cargo.toml b/fixtures/regressions/cdylib-crate-type-dependency/ffi-crate/Cargo.toml
@@ -19,3 +19,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/enum-without-i32-helpers/Cargo.toml b/fixtures/regressions/enum-without-i32-helpers/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/fully-qualified-types/Cargo.toml b/fixtures/regressions/fully-qualified-types/Cargo.toml
@@ -15,3 +15,6 @@ uniffi = { workspace = true }
 
 [build-dependencies]
 uniffi = { workspace = true, features = ["build"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/kotlin-experimental-unsigned-types/Cargo.toml b/fixtures/regressions/kotlin-experimental-unsigned-types/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/logging-callback-interface/Cargo.toml b/fixtures/regressions/logging-callback-interface/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/missing-newline/Cargo.toml b/fixtures/regressions/missing-newline/Cargo.toml
@@ -17,3 +17,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/nested-module-import/Cargo.toml b/fixtures/regressions/nested-module-import/Cargo.toml
@@ -15,3 +15,6 @@ uniffi = { workspace = true }
 
 [build-dependencies]
 uniffi = { workspace = true, features = ["build"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/swift-callbacks-omit-labels/Cargo.toml b/fixtures/regressions/swift-callbacks-omit-labels/Cargo.toml
@@ -17,3 +17,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/swift-dictionary-nesting/Cargo.toml b/fixtures/regressions/swift-dictionary-nesting/Cargo.toml
@@ -17,3 +17,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/unary-result-alias/Cargo.toml b/fixtures/regressions/unary-result-alias/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/regressions/wrong-lower-check/Cargo.toml b/fixtures/regressions/wrong-lower-check/Cargo.toml
@@ -17,3 +17,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/simple-fns/Cargo.toml b/fixtures/simple-fns/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/simple-iface/Cargo.toml b/fixtures/simple-iface/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/struct-default-values/Cargo.toml b/fixtures/struct-default-values/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/swift-bridging-header-compile/Cargo.toml b/fixtures/swift-bridging-header-compile/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 uniffi = { workspace = true, features = ["bindgen-tests", "cli"] }
 uniffi_testing = { path = "../../uniffi_testing" }
 anyhow = "1"
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/swift-omit-labels/Cargo.toml b/fixtures/swift-omit-labels/Cargo.toml
@@ -18,3 +18,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/trait-methods/Cargo.toml b/fixtures/trait-methods/Cargo.toml
@@ -20,3 +20,5 @@ uniffi = { workspace = true, features = ["build"] }
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
 
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/type-limits/Cargo.toml b/fixtures/type-limits/Cargo.toml
@@ -17,3 +17,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/uitests/Cargo.toml b/fixtures/uitests/Cargo.toml
@@ -16,3 +16,6 @@ thiserror = "1.0"
 
 [dev-dependencies]
 trybuild = "1.0.76"
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/uniffi-fixture-time/Cargo.toml b/fixtures/uniffi-fixture-time/Cargo.toml
@@ -20,3 +20,6 @@ uniffi = { workspace = true, features = ["build"] }
 
 [dev-dependencies]
 uniffi = { workspace = true, features = ["bindgen-tests"] }
+
+[features]
+ffi-trace = ["uniffi/ffi-trace"]
diff --git a/fixtures/version-mismatch/Cargo.toml b/fixtures/version-mismatch/Cargo.toml
@@ -15,6 +15,7 @@ path = "src/bindgen.rs"
 
 [features]
 default = []
+ffi-trace = ["uniffi/ffi-trace"]
 # Change the API that the proc-macros wrap in order to test mismatches between
 # the scaffolding and bindings code
 proc_macro_v2 = []