POC: Rust Wrapper for 1DS C++ SDK by CDFriend · Pull Request #1225 · microsoft/cpp_client_telemetry

CDFriend · 2023-11-23T23:49:41Z

What is this?

Adds a Rust "wrapper" to the 1DS C++ SDK, which will allow the SDK to be imported into Rust projects as a crate. The crate interacts with the C API of the SDK (instead of C++) as this will ensure a stable binary interface between the Rust layer and C++ layer of the project.

Project Structure

Crates:

cpp-client-telemetry-sys: crate directly exposing the C API of the 1DS SDK to Rust.
oneds-telemetry: contains some abstractions over the 1DS SDK and allows messages to be sent to the SDK from the log crate.
telemetry-sample: example executable using the oneds-telemetry crate.

Limitations

Currently only i64 and string telemetry fields are supported.
Currently we're only linking with the Windows-x64 static library - additional work on the build script will be required to add support for dynamic linking and other architectures/operating systems.

Build Instructions

Follow instructions in the root of the repository to build the project in Win32-Lib configuration for the x64 arch.
Run cargo build in wrappers/rust

CDFriend · 2023-11-23T23:50:28Z

@microsoft-github-policy-service agree company="Microsoft"

sivadeilra · 2023-11-24T04:15:18Z

wrappers/rust/oneds-telemetry/src/appender.rs

+    }
+
+    fn log(&self, record: &Record) {
+        if unsafe { CONSOLE_ENABLED } && self.enabled(record.metadata()) {


These fields should probably be changed to use std::sync::atomc::AtomicBool, which will allow this code to be safe.

Using static mut is unsafe because it allows for race conditions, which are undefined behavior.

sivadeilra · 2023-11-24T04:17:23Z

wrappers/rust/oneds-telemetry/src/conversion.rs

+pub fn to_leaky_c_str(value: &str) -> *const i8 {
+    let c_str = Box::new(CString::new(value.clone()).unwrap());
+    let ptr = c_str.as_ptr() as *const i8;
+    mem::forget(c_str);


Can this be Box::into_raw(c_str) as *const i8 instead?

sivadeilra · 2023-11-24T04:18:31Z

wrappers/rust/oneds-telemetry/src/lib.rs

+}
+
+/// The global `Tracer` provider singleton.
+static GLOBAL_LOG_MANAGER: Lazy<RwLock<LogManager>> = Lazy::new(|| RwLock::new(LogManager::new()));


Is there a reason this uses Lazy instead of just typing this field as RwLock<LogManager>?

sivadeilra · 2023-11-24T04:21:56Z

wrappers/rust/oneds-telemetry/src/conversion.rs

+ * This will leak memory
+ */
+pub fn to_leaky_c_str(value: &str) -> *const i8 {
+    let c_str = Box::new(CString::new(value.clone()).unwrap());


I suspect the value.clone() call doesn't do anything. It could probably be simplified to just value.

sivadeilra · 2023-11-24T04:25:41Z

wrappers/rust/oneds-telemetry/src/types.rs

+    }
+
+    fn to_str(&self) -> Result<&str, std::str::Utf8Error> {
+        unsafe { CStr::from_ptr(self.as_ptr()).to_str() }


Is there a reason this is not just core::str::from_utf8(&self.bytes)? What merits using unsafe code here?

sivadeilra · 2023-11-24T04:40:36Z

wrappers/rust/cpp-client-telemetry-sys/src/lib.rs

+    result
+}
+
+pub fn evt_upload(handle: &evt_handle_t) -> evt_status_t {


Because you are directly exposing evt_handle_t outside your crate, and this type has unsafe pointers in it, these functions are actually unsafe to call. They allow a safe caller to violate type safety.

You can fix this in one of several ways:

Don't expose these functions outside this crate.

Don't expose evt_context_t, and instead define an EvtContext wrapper type which contains evt_context_t but does not expose it outside of the crate.

Mark these functions unsafe.

sivadeilra · 2023-11-24T04:41:18Z

wrappers/rust/oneds-telemetry/Cargo.toml

+[dependencies]
+chrono = { version = "0.4.30" }
+log = { version = "0.4.20" }
+once_cell = "1.12.0"


Is there a reason to use once_cell, now that Once and OnceLock are part of the Rust standard library?

sivadeilra · 2023-11-24T04:42:42Z

wrappers/rust/oneds-telemetry/src/lib.rs

+pub mod appender;
+pub mod types;
+
+#[derive(Clone)]


Is log_handle a pointer or a handle that was received from the underlying C API? If so, then I don't think this Clone call is correct or safe.

sivadeilra · 2023-11-24T04:44:19Z

wrappers/rust/oneds-telemetry/src/types.rs

+    Int(i64),
+}
+
+pub type TelemetryPropertyBag = HashMap<&'static str, TelemetryProperty>;


It's a matter of taste, but I generally prefer to simply see HashMap<&str, TelemetryProperty> instead of a type alias.

sivadeilra · 2023-11-24T04:44:37Z

wrappers/rust/oneds-telemetry/src/types.rs

+        TelemetryItem {
+            name: StringProperty::new(name),
+            data: TelemetryPropertyBag::new(),
+            time: Option::None,


Use None instead of Option::None.

lalitb · 2024-01-04T20:46:48Z

@CDFriend This looks to be a good addition. when you have time, can you please make it ready for review :)

msft-tsharp · 2024-01-23T06:19:04Z

@CDFriend This looks to be a good addition. when you have time, can you please make it ready for review :)

@lalitb - I can work on resolving the feedback.

* Making quality of life improvements to the types * Adding testing to types

…rate

lalitb · 2025-02-03T15:45:35Z

@CDFriend This looks to be a good addition. when you have time, can you please make it ready for review :)

@lalitb - I can work on resolving the feedback.

@msft-tsharp Sorry for late reply. Do you think you can still work on resolving it ?

sivadeilra reviewed Nov 24, 2023

View reviewed changes

msft-tsharp and others added 14 commits February 1, 2024 23:40

Initial Setup

3bd3e64

Initial proof-of-concept hacked together.

0e32500

proof of concept using the log crate

eb22a4b

A bit of cleanup as the LogManager isn't used directly anymore

064e416

misc updates - working on memory safe logging

8f58768

Fix appender

db354c8

* Adding back internals

746816d

* Making quality of life improvements to the types * Adding testing to types

Rework build script, create cpp-client-telemetry-sys crate

4090f27

Static link telemetry lib

00c507f

Generate bindings from C++

c6c6039

Copy correct bindings for static linkage

6690e15

Add remaining checks to cpp-client-telemetry-sys library

e2417f9

Refactor: integration oneds-telemetry with cpp-client-telemetry-sys c…

4ffe5a6

…rate

Implement string and integer properties

5c3a0ef

msft-tsharp force-pushed the cfriend/rust-wrapper-contd branch from a95e623 to 5c3a0ef Compare February 2, 2024 07:40

Merge branch 'main' into cfriend/rust-wrapper-contd

5d8cdb6

lalitb assigned michaelgsharp and msft-tsharp and unassigned michaelgsharp and msft-tsharp Jun 4, 2024

Merge branch 'main' into cfriend/rust-wrapper-contd

8a0347b

lalitb added 2 commits February 3, 2025 22:03

Merge branch 'main' into cfriend/rust-wrapper-contd

32778e9

Merge branch 'main' into cfriend/rust-wrapper-contd

8e8efa8

Conversation

CDFriend commented Nov 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is this?

Project Structure

Limitations

Build Instructions

Uh oh!

CDFriend commented Nov 23, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lalitb commented Jan 4, 2024

Uh oh!

msft-tsharp commented Jan 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lalitb commented Feb 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CDFriend commented Nov 23, 2023 •

edited

Loading

msft-tsharp commented Jan 23, 2024 •

edited

Loading