s2n-quic-core 0.81.0

Internal crate used by s2n-quic
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

#[doc(hidden)]
#[macro_export]
macro_rules! __probe_define__ {
    (extern "probe" {
        $(
            $(
                #[doc = $doc:tt]
            )*
            #[link_name = $link_name:ident]
            $vis:vis fn $fun:ident($($arg:ident: $arg_t:ty),* $(,)?);
        )*
    }) => {
        $(
            $(
                #[doc = $doc]
            )*
            #[inline(always)]
            $vis fn $fun($($arg: $arg_t),*) {
                $crate::probe::__trace!(
                    name: stringify!($fun),
                    target: concat!(module_path!(), "::", stringify!($fun)),
                    $(
                        $arg = ?$arg,
                    )*
                );

                $crate::probe::__usdt!(
                    s2n_quic,
                    $link_name,
                    $(
                        $arg
                    ),*
                );
            }
        )*
    }
}

#[doc(inline)]
pub use __probe_define__ as define;

#[cfg(feature = "probe-tracing")]
#[doc(hidden)]
pub use tracing::trace as __trace;

#[cfg(not(feature = "probe-tracing"))]
#[macro_export]
#[doc(hidden)]
macro_rules! __trace_impl__ {
    ($($fmt:tt)*) => {};
}

#[cfg(not(feature = "probe-tracing"))]
#[doc(hidden)]
pub use __trace_impl__ as __trace;

#[cfg(feature = "usdt")]
#[doc(hidden)]
pub use probe::probe as __usdt_emit__;

#[cfg(feature = "usdt")]
#[doc(hidden)]
#[macro_export]
macro_rules! __usdt_impl__ {
    ($provider:ident, $name:ident $(, $arg:ident)* $(,)?) => {{
        // define a function with inline(never) to consolidate probes to this single location
        #[inline(never)]
        fn probe($($arg: isize),*) {
            $crate::probe::__usdt_emit__!($provider, $name, $($arg),*);
        }
        probe($(
            $crate::probe::Arg::into_usdt($arg),
        )*);
    }}
}

#[cfg(not(feature = "usdt"))]
#[doc(hidden)]
#[macro_export]
macro_rules! __usdt_impl__ {
    ($provider:ident, $name:ident $(, $arg:ident)* $(,)?) => {{
        // make sure all of the args implement Arg
        $(
            let _ = $crate::probe::Arg::into_usdt($arg);
        )*
    }}
}

#[doc(inline)]
pub use __usdt_impl__ as __usdt;

pub trait Arg {
    fn into_usdt(self) -> isize;
}

macro_rules! impl_int_arg {
    ($($ty:ident),* $(,)?) => {
        $(
            impl Arg for $ty {
                #[inline]
                fn into_usdt(self) -> isize {
                    self as _
                }
            }
        )*
    }
}

impl_int_arg!(u8, i8, u16, i16, u32, i32, u64, i64, usize, isize);

impl Arg for bool {
    #[inline]
    fn into_usdt(self) -> isize {
        if self {
            1
        } else {
            0
        }
    }
}

impl Arg for core::time::Duration {
    #[inline]
    fn into_usdt(self) -> isize {
        self.as_nanos() as _
    }
}

impl Arg for crate::time::Timestamp {
    #[inline]
    fn into_usdt(self) -> isize {
        unsafe { self.as_duration().into_usdt() }
    }
}

impl Arg for crate::packet::number::PacketNumber {
    #[inline]
    fn into_usdt(self) -> isize {
        self.as_u64().into_usdt()
    }
}

impl Arg for crate::varint::VarInt {
    #[inline]
    fn into_usdt(self) -> isize {
        self.as_u64().into_usdt()
    }
}

impl Arg for &core::ffi::CStr {
    #[inline]
    fn into_usdt(self) -> isize {
        self.as_ptr() as _
    }
}

#[cfg(test)]
mod tests {
    crate::probe::define!(
        extern "probe" {
            /// Testing the probe capability
            #[link_name = s2n_quic_core__probe__tests__test123]
            pub fn test123(a: u8, b: core::time::Duration, c: u64);
        }
    );

    #[test]
    fn call_probe_test() {
        test123(123, core::time::Duration::from_secs(123), 123);
    }
}