[trace] move macros tests to the tracing crate

- This is needed for the tests to pass because the macros
use 'hyperlight_guest_tracing::' which cannot be imported by
'hyperlight_guest_tracing_macro' bacause it would create a
circular dependency.
- The caveat is that when using 'hyperlight_guest_tracing_macro'
one needs to have as a dependency 'hyperlight_guest_tracing'
also

Signed-off-by: Doru Blânzeanu <[email protected]>

Author: dblnz

src/hyperlight_guest_tracing/src/lib.rs

@@ -17,7 +17,93 @@ limitations under the License.
 
 /// Re-export the tracing macros
 /// This allows users to use the macros without needing to import them explicitly.
+///
+/// # Tracing Macros Usage
+///
+/// ## The `trace_function` macro can be used to trace function calls.
+///
+/// ```rust
+/// #[hyperlight_guest_tracing_macro::trace_function]
+/// fn my_function() {
+/// //     // Function body
+/// }
+/// ```
+///
+/// ## The `trace!` macro can be used to create trace records with a message.
+///
+/// ```rust
+/// use hyperlight_guest_tracing_macro::trace;
+/// trace!("message");
+/// trace!("message", { /* block of code */ });
+/// ```
+///
+/// ## Basic usage: trace with message only
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// trace!("hello");
+/// ```
+///
+/// ## Trace with a block, returning a value
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// let x = trace!("block", { 42 });
+/// assert_eq!(x, 42);
+/// ```
+///
+/// ## Trace with a block using local variables
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// let y = 10;
+/// let z = trace!("sum", { y + 5 });
+/// assert_eq!(z, 15);
+/// ```
+///
+/// ## Trace with a block that returns a reference
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// let s = String::from("abc");
+/// let r: &str = trace!("ref", { &s });
+/// assert_eq!(r, "abc");
+/// ```
+///
+/// ## Control flow: `return` inside the block returns from the function
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// fn foo() -> i32 {
+///     let _ = trace!("fail", {
+///         // This return only exits the closure, not the function `foo`.
+///         return 42;
+///     });
+///     assert!(false, "This should not be reached");
+/// }
+/// ```
+///
+/// ## Control flow: `break` inside the block exits the outer loop
+///
+/// ```
+/// use hyperlight_guest_tracing_macro::trace;
+/// let mut x = 0;
+/// for i in 1..3 {
+///     x = i;
+///     let _ = trace!("msg", {
+///         // This break should exit the loop.
+///         break;
+///     });
+/// }
+/// assert_eq!(x, 1, "Loop should break after the first iteration");
+/// ```
+///
+/// ## Flush the trace buffer
+/// ```rust
+/// hyperlight_guest_tracing_macro::flush!();
+/// ```
 pub use hyperlight_guest_tracing_macro::*;
+
 #[cfg(feature = "trace")]
 pub use trace::{create_trace_record, flush_trace_buffer};
 

src/hyperlight_guest_tracing_macro/src/lib.rs

@@ -19,14 +19,6 @@ use quote::quote;
 use syn::{ItemFn, parse_macro_input};
 
 /// A procedural macro attribute for tracing function calls.
-/// Usage:
-/// ```rust
-/// #[hyperlight_guest_tracing_macro::trace_function]
-/// fn my_function() {
-/// //     // Function body
-/// }
-/// ```
-///
 /// This macro will create a trace record when the function is called
 ///
 /// The trace record will contain the function name as a string.
@@ -131,78 +123,8 @@ impl syn::parse::Parse for TraceMacroInput {
 
 /// This macro creates a trace record with a message, or traces a block with entry/exit records.
 ///
-/// Usage:
-/// ```rust
-/// use hyperlight_guest_tracing_macro::trace;
-/// trace!("message");
-/// trace!("message", { /* block of code */ });
-/// ```
-///
 /// When called with an expression or statement as the second argument, it is wrapped in a block,
 /// entry and exit trace records are created at the start and end of block, and the result of the block is returned.
-///
-/// # Examples
-///
-/// ## Basic usage: trace with message only
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// trace!("hello");
-/// ```
-///
-/// ## Trace with a block, returning a value
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// let x = trace!("block", { 42 });
-/// assert_eq!(x, 42);
-/// ```
-///
-/// ## Trace with a block using local variables
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// let y = 10;
-/// let z = trace!("sum", { y + 5 });
-/// assert_eq!(z, 15);
-/// ```
-///
-/// ## Trace with a block that returns a reference
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// let s = String::from("abc");
-/// let r: &str = trace!("ref", { &s });
-/// assert_eq!(r, "abc");
-/// ```
-///
-/// ## Control flow: `return` inside the block returns from the function
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// fn foo() -> i32 {
-///     let _ = trace!("fail", {
-///         // This return only exits the closure, not the function `foo`.
-///         return 42;
-///     });
-///     assert!(false, "This should not be reached");
-/// }
-/// ```
-///
-/// ## Control flow: `break` inside the block exits the outer loop
-///
-/// ```
-/// use hyperlight_guest_tracing_macro::trace;
-/// let mut x = 0;
-/// for i in 1..3 {
-///     x = i;
-///     let _ = trace!("msg", {
-///         // This break should exit the loop.
-///         break;
-///     });
-/// }
-/// assert_eq!(x, 1, "Loop should break after the first iteration");
-/// ```
 #[proc_macro]
 pub fn trace(input: TokenStream) -> TokenStream {
     let parsed = syn::parse_macro_input!(input as TraceMacroInput);
@@ -251,11 +173,6 @@ pub fn trace(input: TokenStream) -> TokenStream {
 }
 
 /// This macro flushes the trace buffer, sending any remaining trace records to the host.
-///
-/// Usage:
-/// ```rust
-/// hyperlight_guest_tracing_macro::flush!();
-/// ```
 #[proc_macro]
 pub fn flush(_input: TokenStream) -> TokenStream {
     #[cfg(feature = "trace")]