pacifica-rs 1.0.0

rust implementation of PacificA: Replication in Log-Based Distributed Storage Systems
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

use crate::error::LifeCycleError;
use crate::runtime::{OneshotSender, TypeConfigExt};
use crate::type_config::alias::{JoinHandleOf, OneshotReceiverOf, OneshotSenderOf};
use crate::TypeConfig;
use std::future::Future;
use std::ops::{Deref, DerefMut};
use std::sync::Mutex;

pub(crate) trait Lifecycle<C>
where
    C: TypeConfig,
{
    /// phase: startup
    /// return ture if success startup.
    async fn startup(&self) -> Result<(), LifeCycleError>;

    /// phase: shutdown
    async fn shutdown(&self) -> Result<(), LifeCycleError>;
}

pub(crate) trait LoopHandler<C>
where
    C: TypeConfig,
{
    fn run_loop(self, rx_shutdown: OneshotReceiverOf<C, ()>)
        -> impl Future<Output = Result<(), LifeCycleError>> + Send;
}

pub(crate) trait Component<C>: Lifecycle<C>
where
    C: TypeConfig,
{
    type LoopHandler: LoopHandler<C> + Send + Sync + 'static;

    fn new_loop_handler(&self) -> Option<Self::LoopHandler>;
}

pub(crate) struct ReplicaComponent<C, T>
where
    C: TypeConfig,
    T: Component<C> + Sized,
{
    tx_shutdown: Mutex<Option<OneshotSenderOf<C, ()>>>,
    join_handler: Mutex<Option<JoinHandleOf<C, Result<(), LifeCycleError>>>>,
    component: T,
}

impl<C, T> ReplicaComponent<C, T>
where
    C: TypeConfig,
    T: Component<C>,
{
    pub(crate) fn new(component: T) -> ReplicaComponent<C, T> {
        ReplicaComponent {
            tx_shutdown: Mutex::new(None),
            join_handler: Mutex::new(None),
            component: component,
        }
    }

    fn do_startup(&self) -> bool {
        let mut shutdown = self.tx_shutdown.lock().unwrap();
        match *shutdown {
            Some(_) => {
                // repeated startup
                false
            }
            None => {
                let (tx_shutdown, rx_shutdown) = C::oneshot();
                let loop_handler = self.component.new_loop_handler();
                match loop_handler {
                    Some(loop_handler) => {
                        let join_handler = C::spawn(loop_handler.run_loop(rx_shutdown));
                        self.join_handler.lock().unwrap().replace(join_handler);
                        shutdown.replace(tx_shutdown);
                    }
                    None => {}
                }
                true
            }
        }
    }
}

impl<C, T> Lifecycle<C> for ReplicaComponent<C, T>
where
    C: TypeConfig,
    T: Component<C>,
{
    async fn startup(&self) -> Result<(), LifeCycleError> {
        if self.do_startup() {
            self.component.startup().await?;
        }
        // repeated startup
        Ok(())
    }



    async fn shutdown(&self) -> Result<(), LifeCycleError> {
        let shutdown = {
            let mut shutdown = self.tx_shutdown.lock().unwrap();
            shutdown.take()
        };
        match shutdown {
            None => {
                // repeated shutdown or un startup
                Ok(())
            }
            Some(tx_shutdown) => {
                // send shutdown msg
                let _ = tx_shutdown.send(());
                // wait
                let loop_handler = {
                    self.join_handler.lock().unwrap().take()
                };
                if let Some(loop_handler) = loop_handler {
                    let _ = loop_handler.await;
                }
                self.component.shutdown().await?;
                Ok(())
            }
        }
    }
}

impl<C, T> Deref for ReplicaComponent<C, T>
where
    C: TypeConfig,
    T: Component<C>,
{
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.component
    }
}

impl<C, T> DerefMut for ReplicaComponent<C, T>
where
    C: TypeConfig,
    T: Component<C>,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.component
    }
}