fidl_fuchsia_tracing_common/
fidl_fuchsia_tracing_common.rs

1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
8use futures::future::{self, MaybeDone, TryFutureExt};
9use zx_status;
10
11pub type CategoryDescription = String;
12
13/// aliases
14pub type CategoryName = String;
15
16pub type EnabledCategoryList = Vec<String>;
17
18pub type ProviderId = u32;
19
20pub type ProviderName = String;
21
22/// The maximum length of a category description.
23pub const MAX_CATEGORY_DESCRIPTION_LENGTH: u32 = 400;
24
25/// The maximum length of a category name.
26pub const MAX_CATEGORY_NAME_LENGTH: u32 = 100;
27
28/// The maximum number of categories supported.
29pub const MAX_NUM_ENABLED_CATEGORIES: u32 = 5000;
30
31/// The maximum number of categories supported.
32pub const MAX_NUM_KNOWN_CATEGORIES: u32 = 5000;
33
34/// The maximum length of a provider's name.
35pub const MAX_PROVIDER_NAME_LENGTH: u32 = 100;
36
37/// Choices for clearing/retaining trace buffer contents at Start.
38/// A brief summary of buffer contents:
39/// The trace buffer is divided into two main pieces: durable and non-durable.
40/// The durable portion contains things like the string and thread data for
41/// their respective references (trace_encoded_string_ref_t and
42/// trace_encoded_thread_ref_t). The non-durable portion contains the rest of
43/// the trace data like events); this is the portion that, for example, is
44/// discarded in circular buffering mode when the (non-durable) buffer fills.
45#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
46#[repr(u8)]
47pub enum BufferDisposition {
48    /// Clear the entire buffer, including durable buffer contents.
49    /// N.B. If this is done mid-session, then string and thread references
50    /// from prior to this point will become invalid - the underlying data
51    /// will be gone. To prevent this save buffer contents before clearing.
52    ///
53    /// This is typically used when buffer contents were saved after the
54    /// preceding Stop.
55    ClearEntire = 1,
56    /// Clear the non-durable portion of the buffer, retaining the durable
57    /// portion.
58    ///
59    /// This is typically used when buffer contents were not saved after the
60    /// preceding Stop and the current contents are to be discarded.
61    ClearNondurable = 2,
62    /// Retain buffer contents. New trace data is added where the previous
63    /// trace run left off.
64    ///
65    /// This is typically used when buffer contents were not saved after the
66    /// preceding Stop and the current contents are to be retained.
67    Retain = 3,
68}
69
70impl BufferDisposition {
71    #[inline]
72    pub fn from_primitive(prim: u8) -> Option<Self> {
73        match prim {
74            1 => Some(Self::ClearEntire),
75            2 => Some(Self::ClearNondurable),
76            3 => Some(Self::Retain),
77            _ => None,
78        }
79    }
80
81    #[inline]
82    pub const fn into_primitive(self) -> u8 {
83        self as u8
84    }
85
86    #[deprecated = "Strict enums should not use `is_unknown`"]
87    #[inline]
88    pub fn is_unknown(&self) -> bool {
89        false
90    }
91}
92
93/// The trace buffering mode.
94#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
95#[repr(u8)]
96pub enum BufferingMode {
97    /// In oneshot mode there is only one buffer that is not reused. When the
98    /// buffer fills the provider just keeps dropping records, keeping a count,
99    /// and then when tracing stops the header is updated to record final
100    /// state.
101    Oneshot = 1,
102    /// In circular mode, the buffer is continually written to until tracing
103    /// stops. When the buffer fills older records are discarded as needed.
104    Circular = 2,
105    /// In streaming mode, the buffer is effectively split into two pieces.
106    /// When one half of the buffer fills the provider notifies the trace
107    /// manager via the provided fifo, and then starts filling the other half
108    /// of the buffer. When the buffer is saved, the manager responds via the
109    /// provided fifo. If trace manager hasn't saved the buffer in time, and
110    /// the other buffer fills, then the provider is required to drop records
111    /// until space becomes available.
112    Streaming = 3,
113}
114
115impl BufferingMode {
116    #[inline]
117    pub fn from_primitive(prim: u8) -> Option<Self> {
118        match prim {
119            1 => Some(Self::Oneshot),
120            2 => Some(Self::Circular),
121            3 => Some(Self::Streaming),
122            _ => None,
123        }
124    }
125
126    #[inline]
127    pub const fn into_primitive(self) -> u8 {
128        self as u8
129    }
130
131    #[deprecated = "Strict enums should not use `is_unknown`"]
132    #[inline]
133    pub fn is_unknown(&self) -> bool {
134        false
135    }
136}
137
138/// The value returned by `GetKnownCategories`.
139#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
140pub struct KnownCategory {
141    pub name: String,
142    pub description: String,
143}
144
145impl fidl::Persistable for KnownCategory {}
146
147mod internal {
148    use super::*;
149    unsafe impl fidl::encoding::TypeMarker for BufferDisposition {
150        type Owned = Self;
151
152        #[inline(always)]
153        fn inline_align(_context: fidl::encoding::Context) -> usize {
154            std::mem::align_of::<u8>()
155        }
156
157        #[inline(always)]
158        fn inline_size(_context: fidl::encoding::Context) -> usize {
159            std::mem::size_of::<u8>()
160        }
161
162        #[inline(always)]
163        fn encode_is_copy() -> bool {
164            true
165        }
166
167        #[inline(always)]
168        fn decode_is_copy() -> bool {
169            false
170        }
171    }
172
173    impl fidl::encoding::ValueTypeMarker for BufferDisposition {
174        type Borrowed<'a> = Self;
175        #[inline(always)]
176        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
177            *value
178        }
179    }
180
181    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<Self, D>
182        for BufferDisposition
183    {
184        #[inline]
185        unsafe fn encode(
186            self,
187            encoder: &mut fidl::encoding::Encoder<'_, D>,
188            offset: usize,
189            _depth: fidl::encoding::Depth,
190        ) -> fidl::Result<()> {
191            encoder.debug_check_bounds::<Self>(offset);
192            encoder.write_num(self.into_primitive(), offset);
193            Ok(())
194        }
195    }
196
197    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for BufferDisposition {
198        #[inline(always)]
199        fn new_empty() -> Self {
200            Self::ClearEntire
201        }
202
203        #[inline]
204        unsafe fn decode(
205            &mut self,
206            decoder: &mut fidl::encoding::Decoder<'_, D>,
207            offset: usize,
208            _depth: fidl::encoding::Depth,
209        ) -> fidl::Result<()> {
210            decoder.debug_check_bounds::<Self>(offset);
211            let prim = decoder.read_num::<u8>(offset);
212
213            *self = Self::from_primitive(prim).ok_or(fidl::Error::InvalidEnumValue)?;
214            Ok(())
215        }
216    }
217    unsafe impl fidl::encoding::TypeMarker for BufferingMode {
218        type Owned = Self;
219
220        #[inline(always)]
221        fn inline_align(_context: fidl::encoding::Context) -> usize {
222            std::mem::align_of::<u8>()
223        }
224
225        #[inline(always)]
226        fn inline_size(_context: fidl::encoding::Context) -> usize {
227            std::mem::size_of::<u8>()
228        }
229
230        #[inline(always)]
231        fn encode_is_copy() -> bool {
232            true
233        }
234
235        #[inline(always)]
236        fn decode_is_copy() -> bool {
237            false
238        }
239    }
240
241    impl fidl::encoding::ValueTypeMarker for BufferingMode {
242        type Borrowed<'a> = Self;
243        #[inline(always)]
244        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
245            *value
246        }
247    }
248
249    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<Self, D> for BufferingMode {
250        #[inline]
251        unsafe fn encode(
252            self,
253            encoder: &mut fidl::encoding::Encoder<'_, D>,
254            offset: usize,
255            _depth: fidl::encoding::Depth,
256        ) -> fidl::Result<()> {
257            encoder.debug_check_bounds::<Self>(offset);
258            encoder.write_num(self.into_primitive(), offset);
259            Ok(())
260        }
261    }
262
263    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for BufferingMode {
264        #[inline(always)]
265        fn new_empty() -> Self {
266            Self::Oneshot
267        }
268
269        #[inline]
270        unsafe fn decode(
271            &mut self,
272            decoder: &mut fidl::encoding::Decoder<'_, D>,
273            offset: usize,
274            _depth: fidl::encoding::Depth,
275        ) -> fidl::Result<()> {
276            decoder.debug_check_bounds::<Self>(offset);
277            let prim = decoder.read_num::<u8>(offset);
278
279            *self = Self::from_primitive(prim).ok_or(fidl::Error::InvalidEnumValue)?;
280            Ok(())
281        }
282    }
283
284    impl fidl::encoding::ValueTypeMarker for KnownCategory {
285        type Borrowed<'a> = &'a Self;
286        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
287            value
288        }
289    }
290
291    unsafe impl fidl::encoding::TypeMarker for KnownCategory {
292        type Owned = Self;
293
294        #[inline(always)]
295        fn inline_align(_context: fidl::encoding::Context) -> usize {
296            8
297        }
298
299        #[inline(always)]
300        fn inline_size(_context: fidl::encoding::Context) -> usize {
301            32
302        }
303    }
304
305    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<KnownCategory, D>
306        for &KnownCategory
307    {
308        #[inline]
309        unsafe fn encode(
310            self,
311            encoder: &mut fidl::encoding::Encoder<'_, D>,
312            offset: usize,
313            _depth: fidl::encoding::Depth,
314        ) -> fidl::Result<()> {
315            encoder.debug_check_bounds::<KnownCategory>(offset);
316            // Delegate to tuple encoding.
317            fidl::encoding::Encode::<KnownCategory, D>::encode(
318                (
319                    <fidl::encoding::BoundedString<100> as fidl::encoding::ValueTypeMarker>::borrow(
320                        &self.name,
321                    ),
322                    <fidl::encoding::BoundedString<400> as fidl::encoding::ValueTypeMarker>::borrow(
323                        &self.description,
324                    ),
325                ),
326                encoder,
327                offset,
328                _depth,
329            )
330        }
331    }
332    unsafe impl<
333            D: fidl::encoding::ResourceDialect,
334            T0: fidl::encoding::Encode<fidl::encoding::BoundedString<100>, D>,
335            T1: fidl::encoding::Encode<fidl::encoding::BoundedString<400>, D>,
336        > fidl::encoding::Encode<KnownCategory, D> for (T0, T1)
337    {
338        #[inline]
339        unsafe fn encode(
340            self,
341            encoder: &mut fidl::encoding::Encoder<'_, D>,
342            offset: usize,
343            depth: fidl::encoding::Depth,
344        ) -> fidl::Result<()> {
345            encoder.debug_check_bounds::<KnownCategory>(offset);
346            // Zero out padding regions. There's no need to apply masks
347            // because the unmasked parts will be overwritten by fields.
348            // Write the fields.
349            self.0.encode(encoder, offset + 0, depth)?;
350            self.1.encode(encoder, offset + 16, depth)?;
351            Ok(())
352        }
353    }
354
355    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for KnownCategory {
356        #[inline(always)]
357        fn new_empty() -> Self {
358            Self {
359                name: fidl::new_empty!(fidl::encoding::BoundedString<100>, D),
360                description: fidl::new_empty!(fidl::encoding::BoundedString<400>, D),
361            }
362        }
363
364        #[inline]
365        unsafe fn decode(
366            &mut self,
367            decoder: &mut fidl::encoding::Decoder<'_, D>,
368            offset: usize,
369            _depth: fidl::encoding::Depth,
370        ) -> fidl::Result<()> {
371            decoder.debug_check_bounds::<Self>(offset);
372            // Verify that padding bytes are zero.
373            fidl::decode!(
374                fidl::encoding::BoundedString<100>,
375                D,
376                &mut self.name,
377                decoder,
378                offset + 0,
379                _depth
380            )?;
381            fidl::decode!(
382                fidl::encoding::BoundedString<400>,
383                D,
384                &mut self.description,
385                decoder,
386                offset + 16,
387                _depth
388            )?;
389            Ok(())
390        }
391    }
392}
fidl_fuchsia_tracing_common/fidl_fuchsia_tracing_common.rs

fidl_fuchsia_tracing_common/
fidl_fuchsia_tracing_common.rs
