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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
// Copyright 2024 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//! Common traits and types for dealing with abstracted frames.
use core::{convert::Infallible as Never, fmt::Debug};
use packet::{BufferMut, Serializer};
/// A context for receiving frames.
///
/// Note: Use this trait as trait bounds, but always implement
/// [`ReceivableFrameMeta`] instead, which generates a `RecvFrameContext`
/// implementation.
pub trait RecvFrameContext<BC, Meta> {
/// Receive a frame.
///
/// `receive_frame` receives a frame with the given metadata.
fn receive_frame<B: BufferMut + Debug>(
&mut self,
bindings_ctx: &mut BC,
metadata: Meta,
frame: B,
);
}
impl<CC, BC> ReceivableFrameMeta<CC, BC> for Never {
fn receive_meta<B: BufferMut + Debug>(
self,
_core_ctx: &mut CC,
_bindings_ctx: &mut BC,
_frame: B,
) {
match self {}
}
}
/// A trait providing the receive implementation for some frame identified by a
/// metadata type.
///
/// This trait sidesteps orphan rules by allowing [`RecvFrameContext`] to be
/// implemented by the multiple core crates, given it can always be implemented
/// for a local metadata type. `ReceivableFrameMeta` should always be used for
/// trait implementations, while [`RecvFrameContext`] is used for trait bounds.
pub trait ReceivableFrameMeta<CC, BC> {
/// Receives this frame using the provided contexts.
fn receive_meta<B: BufferMut + Debug>(self, core_ctx: &mut CC, bindings_ctx: &mut BC, frame: B);
}
impl<CC, BC, Meta> RecvFrameContext<BC, Meta> for CC
where
Meta: ReceivableFrameMeta<CC, BC>,
{
fn receive_frame<B: BufferMut + Debug>(
&mut self,
bindings_ctx: &mut BC,
metadata: Meta,
frame: B,
) {
metadata.receive_meta(self, bindings_ctx, frame)
}
}
/// A context for sending frames.
pub trait SendFrameContext<BC, Meta> {
/// Send a frame.
///
/// `send_frame` sends a frame with the given metadata. The frame itself is
/// passed as a [`Serializer`] which `send_frame` is responsible for
/// serializing. If serialization fails for any reason, the original,
/// unmodified `Serializer` is returned.
///
/// [`Serializer`]: packet::Serializer
fn send_frame<S>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S) -> Result<(), S>
where
S: Serializer,
S::Buffer: BufferMut;
}
/// A trait providing the send implementation for some frame identified by a
/// metadata type.
///
/// This trait sidesteps orphan rules by allowing [`SendFrameContext`] to be
/// implemented by the multiple core crates, given it can always be implemented
/// for a local metadata type. `SendableFrameMeta` should always be used for
/// trait implementations, while [`SendFrameContext`] is used for trait bounds.
pub trait SendableFrameMeta<CC, BC> {
/// Sends this frame metadata to the provided contexts.
fn send_meta<S>(self, core_ctx: &mut CC, bindings_ctx: &mut BC, frame: S) -> Result<(), S>
where
S: Serializer,
S::Buffer: BufferMut;
}
impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CC
where
Meta: SendableFrameMeta<CC, BC>,
{
fn send_frame<S>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S) -> Result<(), S>
where
S: Serializer,
S::Buffer: BufferMut,
{
metadata.send_meta(self, bindings_ctx, frame)
}
}
#[cfg(any(test, feature = "testutils"))]
pub(crate) mod testutil {
use super::*;
use alloc::{boxed::Box, vec::Vec};
/// A fake [`FrameContext`].
pub struct FakeFrameCtx<Meta> {
frames: Vec<(Meta, Vec<u8>)>,
should_error_for_frame: Option<Box<dyn FnMut(&Meta) -> bool + Send>>,
}
impl<Meta> FakeFrameCtx<Meta> {
/// Closure which can decide to cause an error to be thrown when
/// handling a frame, based on the metadata.
pub fn set_should_error_for_frame<F: Fn(&Meta) -> bool + Send + 'static>(&mut self, f: F) {
self.should_error_for_frame = Some(Box::new(f));
}
}
impl<Meta> Default for FakeFrameCtx<Meta> {
fn default() -> FakeFrameCtx<Meta> {
FakeFrameCtx { frames: Vec::new(), should_error_for_frame: None }
}
}
impl<Meta> FakeFrameCtx<Meta> {
/// Take all frames sent so far.
pub fn take_frames(&mut self) -> Vec<(Meta, Vec<u8>)> {
core::mem::take(&mut self.frames)
}
/// Get the frames sent so far.
pub fn frames(&self) -> &[(Meta, Vec<u8>)] {
self.frames.as_slice()
}
/// Pushes a frame to the context.
pub fn push(&mut self, meta: Meta, frame: Vec<u8>) {
self.frames.push((meta, frame))
}
}
impl<Meta, BC> SendableFrameMeta<FakeFrameCtx<Meta>, BC> for Meta {
fn send_meta<S>(
self,
core_ctx: &mut FakeFrameCtx<Meta>,
_bindings_ctx: &mut BC,
frame: S,
) -> Result<(), S>
where
S: Serializer,
S::Buffer: BufferMut,
{
if let Some(should_error_for_frame) = core_ctx.should_error_for_frame.as_mut() {
if should_error_for_frame(&self) {
return Err(frame);
}
}
let buffer = frame.serialize_vec_outer().map_err(|(_err, s)| s)?;
core_ctx.push(self, buffer.as_ref().to_vec());
Ok(())
}
}
/// A trait for abstracting contexts that may contain a [`FakeFrameCtx`].
pub trait WithFakeFrameContext<SendMeta> {
/// Calls the callback with a mutable reference to the [`FakeFrameCtx`].
fn with_fake_frame_ctx_mut<O, F: FnOnce(&mut FakeFrameCtx<SendMeta>) -> O>(
&mut self,
f: F,
) -> O;
}
impl<SendMeta> WithFakeFrameContext<SendMeta> for FakeFrameCtx<SendMeta> {
fn with_fake_frame_ctx_mut<O, F: FnOnce(&mut FakeFrameCtx<SendMeta>) -> O>(
&mut self,
f: F,
) -> O {
f(self)
}
}
}