[Profiler] Implement interning API (#917)

Author: danielsn

ddcommon-ffi/src/lib.rs

@@ -15,6 +15,7 @@ pub mod handle;
 pub mod option;
 pub mod result;
 pub mod slice;
+pub mod slice_mut;
 pub mod string;
 pub mod tags;
 pub mod timespec;
@@ -27,6 +28,7 @@ pub use handle::*;
 pub use option::*;
 pub use result::*;
 pub use slice::{CharSlice, Slice};
+pub use slice_mut::MutSlice;
 pub use string::*;
 pub use timespec::*;
 pub use vec::Vec;

ddcommon-ffi/src/slice_mut.rs

@@ -0,0 +1,277 @@
+// Copyright 2021-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
+use core::slice;
+use serde::ser::Error;
+use serde::Serializer;
+use std::borrow::Cow;
+use std::fmt::{Debug, Display, Formatter};
+use std::hash::{Hash, Hasher};
+use std::marker::PhantomData;
+use std::os::raw::c_char;
+use std::ptr::NonNull;
+use std::str::Utf8Error;
+
+#[repr(C)]
+#[derive(Copy, Clone)]
+pub struct MutSlice<'a, T: 'a> {
+    /// Should be non-null and suitably aligned for the underlying type. It is
+    /// allowed but not recommended for the pointer to be null when the len is
+    /// zero.
+    ptr: Option<NonNull<T>>,
+
+    /// The number of elements (not bytes) that `.ptr` points to. Must be less
+    /// than or equal to [isize::MAX].
+    len: usize,
+    _marker: PhantomData<&'a mut [T]>,
+}
+
+impl<'a, T: 'a> core::ops::Deref for MutSlice<'a, T> {
+    type Target = [T];
+
+    fn deref(&self) -> &Self::Target {
+        self.as_slice()
+    }
+}
+
+impl<T: Debug> Debug for MutSlice<'_, T> {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        self.as_slice().fmt(f)
+    }
+}
+
+/// Use to represent strings -- should be valid UTF-8.
+pub type CharMutSlice<'a> = MutSlice<'a, c_char>;
+
+/// Use to represent bytes -- does not need to be valid UTF-8.
+pub type ByteMutSlice<'a> = MutSlice<'a, u8>;
+
+#[inline]
+fn is_aligned<T>(ptr: NonNull<T>) -> bool {
+    ptr.as_ptr() as usize % std::mem::align_of::<T>() == 0
+}
+
+pub trait AsBytes<'a> {
+    fn as_bytes(&self) -> &'a [u8];
+
+    #[inline]
+    fn try_to_utf8(&self) -> Result<&'a str, Utf8Error> {
+        std::str::from_utf8(self.as_bytes())
+    }
+
+    fn try_to_string(&self) -> Result<String, Utf8Error> {
+        Ok(self.try_to_utf8()?.to_string())
+    }
+
+    #[inline]
+    fn try_to_string_option(&self) -> Result<Option<String>, Utf8Error> {
+        Ok(Some(self.try_to_string()?).filter(|x| !x.is_empty()))
+    }
+
+    #[inline]
+    fn to_utf8_lossy(&self) -> Cow<'a, str> {
+        String::from_utf8_lossy(self.as_bytes())
+    }
+
+    #[inline]
+    /// # Safety
+    /// Must only be used when the underlying data was already confirmed to be utf8.
+    unsafe fn assume_utf8(&self) -> &'a str {
+        std::str::from_utf8_unchecked(self.as_bytes())
+    }
+}
+
+impl<'a> AsBytes<'a> for MutSlice<'a, u8> {
+    fn as_bytes(&self) -> &'a [u8] {
+        self.as_slice()
+    }
+}
+
+impl<'a, T: 'a> MutSlice<'a, T> {
+    /// Creates a valid empty slice (len=0, ptr is non-null).
+    // TODO, this can be const once MSRV >= 1.85
+    #[must_use]
+    pub fn empty() -> Self {
+        Self {
+            ptr: Some(NonNull::dangling()),
+            len: 0,
+            _marker: PhantomData,
+        }
+    }
+
+    /// # Safety
+    /// Uphold the same safety requirements as [std::str::from_raw_parts].
+    /// However, it is allowed but not recommended to provide a null pointer
+    /// when the len is 0.
+    // TODO, this can be const once MSRV >= 1.85
+    pub unsafe fn from_raw_parts(ptr: *mut T, len: usize) -> Self {
+        Self {
+            ptr: NonNull::new(ptr),
+            len,
+            _marker: PhantomData,
+        }
+    }
+
+    // TODO, this can be const once MSRV >= 1.85
+    pub fn new(slice: &mut [T]) -> Self {
+        Self {
+            ptr: NonNull::new(slice.as_mut_ptr()),
+            len: slice.len(),
+            _marker: PhantomData,
+        }
+    }
+
+    pub fn as_mut_slice(&mut self) -> &'a mut [T] {
+        if let Some(ptr) = self.ptr {
+            // Crashing immediately is likely better than ignoring these.
+            assert!(is_aligned(ptr));
+            assert!(self.len <= isize::MAX as usize);
+            unsafe { slice::from_raw_parts_mut(ptr.as_ptr(), self.len) }
+        } else {
+            // Crashing immediately is likely better than ignoring this.
+            assert_eq!(self.len, 0);
+            &mut []
+        }
+    }
+
+    pub fn as_slice(&self) -> &'a [T] {
+        if let Some(ptr) = self.ptr {
+            // Crashing immediately is likely better than ignoring these.
+            assert!(is_aligned(ptr));
+            assert!(self.len <= isize::MAX as usize);
+            unsafe { slice::from_raw_parts(ptr.as_ptr(), self.len) }
+        } else {
+            // Crashing immediately is likely better than ignoring this.
+            assert_eq!(self.len, 0);
+            &[]
+        }
+    }
+
+    pub fn into_slice(self) -> &'a [T] {
+        self.as_slice()
+    }
+
+    pub fn into_mut_slice(mut self) -> &'a mut [T] {
+        self.as_mut_slice()
+    }
+}
+
+impl<T> Default for MutSlice<'_, T> {
+    fn default() -> Self {
+        Self::empty()
+    }
+}
+
+impl<'a, T> Hash for MutSlice<'a, T>
+where
+    MutSlice<'a, T>: AsBytes<'a>,
+{
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        state.write(self.as_bytes())
+    }
+}
+
+impl<'a, T> serde::Serialize for MutSlice<'a, T>
+where
+    MutSlice<'a, T>: AsBytes<'a>,
+{
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(self.try_to_utf8().map_err(Error::custom)?)
+    }
+}
+
+impl<'a, T> Display for MutSlice<'a, T>
+where
+    MutSlice<'a, T>: AsBytes<'a>,
+{
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.try_to_utf8().map_err(|_| std::fmt::Error)?)
+    }
+}
+
+impl<'a, T: 'a> From<&'a mut [T]> for MutSlice<'a, T> {
+    fn from(s: &'a mut [T]) -> Self {
+        MutSlice::new(s)
+    }
+}
+
+impl<'a, T> From<&'a mut Vec<T>> for MutSlice<'a, T> {
+    fn from(value: &'a mut Vec<T>) -> Self {
+        MutSlice::new(value)
+    }
+}
+
+impl<'a> From<&'a mut str> for MutSlice<'a, c_char> {
+    fn from(s: &'a mut str) -> Self {
+        // SAFETY: Rust strings meet all the invariants required.
+        unsafe { MutSlice::from_raw_parts(s.as_mut_ptr().cast(), s.len()) }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::ptr;
+
+    #[derive(Debug, Eq, PartialEq)]
+    struct Foo(i64);
+
+    #[test]
+    fn slice_from_foo() {
+        let mut raw = Foo(42);
+        let ptr = &mut raw as *mut _;
+        let mut slice = unsafe { MutSlice::from_raw_parts(ptr, 1) };
+
+        let expected: &[Foo] = &[raw];
+        let actual: &[Foo] = slice.as_mut_slice();
+
+        assert_eq!(expected, actual)
+    }
+
+    #[test]
+    fn test_iterator() {
+        let slice: &mut [i32] = &mut [1, 2, 3];
+        let slice = MutSlice::from(slice);
+
+        let mut iter = slice.iter();
+
+        assert_eq!(Some(&1), iter.next());
+        assert_eq!(Some(&2), iter.next());
+        assert_eq!(Some(&3), iter.next());
+    }
+
+    #[test]
+    fn test_null_len0() {
+        let mut null_len0: MutSlice<u8> = MutSlice {
+            ptr: None,
+            len: 0,
+            _marker: PhantomData,
+        };
+        assert_eq!(null_len0.as_mut_slice(), &[]);
+    }
+
+    #[should_panic]
+    #[test]
+    fn test_null_panic() {
+        let mut null_len0: MutSlice<u8> = MutSlice {
+            ptr: None,
+            len: 1,
+            _marker: PhantomData,
+        };
+        _ = null_len0.as_mut_slice();
+    }
+
+    #[should_panic]
+    #[test]
+    fn test_long_panic() {
+        let mut dangerous: MutSlice<u8> = MutSlice {
+            ptr: Some(ptr::NonNull::dangling()),
+            len: isize::MAX as usize + 1,
+            _marker: PhantomData,
+        };
+        _ = dangerous.as_mut_slice();
+    }
+}

examples/ffi/CMakeLists.txt

@@ -30,6 +30,10 @@ add_executable(crashinfo crashinfo.cpp)
 target_compile_features(crashinfo PRIVATE cxx_std_20)
 target_link_libraries(crashinfo PRIVATE Datadog::Profiling)
 
+add_executable(profile_intern profile_intern.cpp)
+# needed for designated initializers
+target_compile_features(profile_intern PRIVATE cxx_std_20)
+target_link_libraries(profile_intern PRIVATE Datadog::Profiling)
 
 if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
   target_compile_definitions(exporter PUBLIC _CRT_SECURE_NO_WARNINGS)

examples/ffi/exporter.cpp

@@ -133,7 +133,7 @@ int main(int argc, char *argv[]) {
                             "\"platform\": {\"kernel\": \"Darwin Kernel 22.5.0\"}}");
 
   auto res = ddog_prof_Exporter_set_timeout(exporter, 30000);
-  if (res.tag == DDOG_PROF_VOID_RESULT_ERR) {
+  if (res.tag == DDOG_VOID_RESULT_ERR) {
     print_error("Failed to set the timeout", res.err);
     ddog_Error_drop(&res.err);
     return 1;