gwr_components/

store.rs

// Copyright (c) 2023 Graphcore Ltd. All rights reserved.

//! A data store.
//!
//! The [Store] is a component that can hold a number of items defined by its
//! capacity.
//!
//! # Ports
//!
//! This component has the following ports:
//!   - The `rx` port [InPort] which is used to put data into the store.
//!   - The `tx` port [OutPort] which is used to get data out of the store.
//!
//! A given [Store] is capable of holding any type as long as it implements the
//! [SimObject] trait. This trait has been implemented for a few builtin types
//! like `i32` and `usize` so that they can be used for simple testing.
//!
//! <br>
//!
//! # Build a store
//!
//! Here is an example creating a [Store]:
//!
//! ```rust
//! use std::rc::Rc;
//!
//! use gwr_components::store::Store;
//! use gwr_engine::engine::Engine;
//! use gwr_engine::executor::Spawner;
//! use gwr_engine::time::clock::Clock;
//! use gwr_track::entity::{Entity, GetEntity};
//!
//! fn build_store(engine: &Engine, clock: &Clock, parent: &Rc<Entity>) -> Rc<Store<i32>> {
//!     // Create a store. It is passed:
//!     //   - the engine under which the store runs
//!     //   - a clock that the store will run off
//!     //   - a parent entity which provides its location within the simulation.
//!     //   - a name which should be unique within the parent.
//!     //   - a capacity.
//!     let store: Rc<Store<i32>> = Store::new_and_register(engine, clock, parent, "store", 5)
//!         .expect("should be able to create and register `Store`");
//!     store
//! }
//! ```
//!
//! By default, the store enters a waiting state if the capacity is overflown,
//! but this behaviour can be changed to return an error, by using the
//! `set_error_on_overflow()` method.
//!
//! ```rust
//! use std::rc::Rc;
//!
//! use gwr_components::store::Store;
//! use gwr_engine::engine::Engine;
//! use gwr_engine::executor::Spawner;
//! use gwr_engine::time::clock::Clock;
//! use gwr_track::entity::{Entity, GetEntity};
//!
//! fn build_store_with_panic(
//!     engine: &Engine,
//!     clock: &Clock,
//!     parent: &Rc<Entity>,
//!     spawner: Spawner,
//! ) -> Rc<Store<i32>> {
//!     // Create a store that panics on overflow. Use `new_and_register()` as before,
//!     // then call `set_error_on_overflow()` on the resulting struct.
//!     let store = Store::new_and_register(engine, clock, parent, "store_error", 5)
//!         .expect("should be able to create and register `Store`");
//!     store.set_error_on_overflow();
//!     store
//! }
//! ```

//! # Connect a store
//!
//! Here is an example of a more complete simulation using a [Store] as well as
//! a [Source](crate::source::Source) to put data into the store and an
//! [Sink](crate::sink::Sink) to take the data out of the store.
//!
//! ```rust
//! use std::rc::Rc;
//! use gwr_components::sink::Sink;
//! use gwr_components::source::Source;
//! use gwr_components::store::Store;
//! use gwr_components::{connect_port, option_box_repeat};
//! use gwr_engine::engine::Engine;
//! use gwr_engine::time::clock::Clock;
//! use gwr_engine::run_simulation;
//! use gwr_track::entity::GetEntity;
//!
//! // Every simulation is based around an `Engine`
//! let mut engine = Engine::default();
//!
//! // For this simulation just use the default clock
//! let clock = engine.default_clock();
//!
//! // Take a reference to the engine top to use as the parent
//! let top = engine.top();
//!
//! // Create the basic componets:
//! // The simplest use of the source is to inject the same value repeatedly.
//! let source = Source::new_and_register(&engine, top, "source", option_box_repeat!(1 ; 10))
//!     .expect("should be able to create and register `Source`");
//! // Create the store - its type will be derived from the connections to its ports.
//! let store = Store::new_and_register(&engine, &clock, top, "store", 5)
//!     .expect("should be able to create and register `Store`");
//! // Create the sink which will pull all of the data items out of the store
//! let sink = Sink::new_and_register(&engine, &clock, top, "sink")
//!     .expect("should be able to create and register `Sink`");
//!
//! // Connect the ports together:
//! // The source will drive data into the store:
//! connect_port!(source, tx => store, rx)
//!     .expect("should be able to connect `Source` to `Store`");
//!
//! // The sink will pull data out of the store
//! connect_port!(store, tx => sink, rx)
//!     .expect("should be able to connect `Store` to `Sink`");
//!
//! // The `run_simulation!` macro then spawns all active components
//! // and runs the simulation to completion.
//! run_simulation!(engine);
//! ```

use std::cell::RefCell;
use std::collections::VecDeque;
use std::rc::Rc;

use async_trait::async_trait;
use gwr_engine::engine::Engine;
use gwr_engine::events::repeated::Repeated;
use gwr_engine::executor::Spawner;
use gwr_engine::port::{InPort, OutPort, PortStateResult};
use gwr_engine::sim_error;
use gwr_engine::time::clock::Clock;
use gwr_engine::traits::{Event, Runnable, SimObject};
use gwr_engine::types::{SimError, SimResult};
use gwr_model_builder::{EntityDisplay, EntityGet};
use gwr_track::entity::Entity;
use gwr_track::tracker::aka::Aka;
use gwr_track::{enter, exit};

use crate::{connect_tx, port_rx, take_option};

/// The [`State`] of a [`Store`].
struct State<T>
where
    T: SimObject,
{
    entity: Rc<Entity>,
    capacity: usize,
    data: RefCell<VecDeque<T>>,
    error_on_overflow: RefCell<bool>,
    level_change: Repeated<usize>,
}

impl<T> State<T>
where
    T: SimObject,
{
    /// Create a new store
    fn new(entity: &Rc<Entity>, capacity: usize) -> Self {
        Self {
            entity: entity.clone(),
            capacity,
            data: RefCell::new(VecDeque::with_capacity(capacity)),
            error_on_overflow: RefCell::new(false),
            level_change: Repeated::new(usize::default()),
        }
    }

    /// Place an object into the store state.
    ///
    /// There must be room before this is called.
    fn push_value(&self, value: T) -> SimResult {
        enter!(self.entity ; value.id());
        if *self.error_on_overflow.borrow() {
            if self.data.borrow().len() >= self.capacity {
                return sim_error!(format!("Overflow in {:?}", self.entity.full_name()));
            }
        } else {
            assert!(self.data.borrow().len() < self.capacity);
        }

        self.data.borrow_mut().push_back(value);
        self.level_change.notify_result(self.data.borrow().len())?;
        Ok(())
    }

    /// Remove an object from the store state.
    ///
    /// There must be an object available to remove before this is called.
    fn pop_value(&self) -> Result<T, SimError> {
        let value = self.data.borrow_mut().pop_front().unwrap();
        self.level_change.notify_result(self.data.borrow().len())?;
        exit!(self.entity ; value.id());
        Ok(value)
    }
}

/// A component that can support a configurable number of objects.
///
/// Objects must support the [SimObject] trait.
#[derive(EntityGet, EntityDisplay)]
pub struct Store<T>
where
    T: SimObject,
{
    entity: Rc<Entity>,
    spawner: Spawner,
    state: Rc<State<T>>,

    tx: RefCell<Option<OutPort<T>>>,
    rx: RefCell<Option<InPort<T>>>,
}

impl<T> Store<T>
where
    T: SimObject,
{
    /// Basic store constructor
    ///
    /// Returns a `SimError` if `capacity` is 0.
    pub fn new_and_register_with_renames(
        engine: &Engine,
        clock: &Clock,
        parent: &Rc<Entity>,
        name: &str,
        aka: Option<&Aka>,
        capacity: usize,
    ) -> Result<Rc<Self>, SimError> {
        let spawner = engine.spawner();
        if capacity == 0 {
            return sim_error!("Unsupported Store with 0 capacity");
        }
        let entity = Rc::new(Entity::new(parent, name));
        let state = Rc::new(State::new(&entity, capacity));
        let tx = OutPort::new_with_renames(&entity, "tx", aka);
        let rx = InPort::new_with_renames(engine, clock, &entity, "rx", aka);
        let rc_self = Rc::new(Self {
            entity,
            spawner,
            state,
            tx: RefCell::new(Some(tx)),
            rx: RefCell::new(Some(rx)),
        });
        engine.register(rc_self.clone());
        Ok(rc_self)
    }

    /// Basic store constructor
    ///
    /// Returns a `SimError` if `capacity` is 0.
    pub fn new_and_register(
        engine: &Engine,
        clock: &Clock,
        parent: &Rc<Entity>,
        name: &str,
        capacity: usize,
    ) -> Result<Rc<Self>, SimError> {
        Self::new_and_register_with_renames(engine, clock, parent, name, None, capacity)
    }

    pub fn connect_port_tx(&self, port_state: PortStateResult<T>) -> SimResult {
        connect_tx!(self.tx, connect ; port_state)
    }

    pub fn port_rx(&self) -> PortStateResult<T> {
        port_rx!(self.rx, state)
    }

    #[must_use]
    pub fn fill_level(&self) -> usize {
        self.state.data.borrow().len()
    }

    pub fn set_error_on_overflow(&self) {
        *self.state.error_on_overflow.borrow_mut() = true;
    }

    #[must_use]
    pub fn get_level_change_event(&self) -> Repeated<usize> {
        self.state.level_change.clone()
    }
}

#[async_trait(?Send)]
impl<T> Runnable for Store<T>
where
    T: SimObject,
{
    async fn run(&self) -> SimResult {
        let rx = take_option!(self.rx);
        let state = self.state.clone();
        self.spawner.spawn(async move { run_rx(rx, state).await });

        let tx = take_option!(self.tx);
        let state = self.state.clone();
        self.spawner.spawn(async move { run_tx(tx, state).await });
        Ok(())
    }
}

async fn run_rx<T>(rx: InPort<T>, state: Rc<State<T>>) -> SimResult
where
    T: SimObject,
{
    let level_change = state.level_change.clone();
    let error_on_overflow = *state.error_on_overflow.borrow();
    loop {
        let level = state.data.borrow().len();
        if level < state.capacity || error_on_overflow {
            let value = rx.get()?.await;
            state.push_value(value)?;
        } else {
            level_change.listen().await;
        }
    }
}

async fn run_tx<T>(tx: OutPort<T>, state: Rc<State<T>>) -> SimResult
where
    T: SimObject,
{
    let level_change = state.level_change.clone();
    loop {
        let level = state.data.borrow().len();
        if level > 0 {
            // Wait for something to actually want the store value
            tx.try_put()?.await;
            let value = state.pop_value()?;
            tx.put(value)?.await;
        } else {
            level_change.listen().await;
        }
    }
}