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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
use std::fmt::Debug;
use std::marker::PhantomData;
use std::ops::Deref;
use std::ops::RangeBounds;
use std::sync::atomic::AtomicBool;
use std::sync::atomic::AtomicU64;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use std::time::Duration;

use tokio::time::sleep;

use crate::async_trait::async_trait;
use crate::defensive::DefensiveCheckBase;
use crate::storage::LogState;
use crate::storage::RaftLogReader;
use crate::storage::RaftSnapshotBuilder;
use crate::storage::Snapshot;
use crate::summary::MessageSummary;
use crate::DefensiveCheck;
use crate::Entry;
use crate::LogId;
use crate::RaftStorage;
use crate::RaftStorageDebug;
use crate::RaftTypeConfig;
use crate::SnapshotMeta;
use crate::StorageError;
use crate::StoredMembership;
use crate::Vote;
use crate::Wrapper;

#[derive(Clone, Debug)]
pub(crate) struct Config {
    /// Time in milliseconds to delay before reading logs.
    ///
    /// For debug only.
    delay_log_read: Arc<AtomicU64>,

    #[allow(dead_code)]
    id: u64,
}

impl Config {
    pub(crate) fn new() -> Self {
        static CONFIG_ID: AtomicU64 = AtomicU64::new(1);

        let id = CONFIG_ID.fetch_add(1, Ordering::Relaxed);

        Self {
            delay_log_read: Arc::new(AtomicU64::new(0)),
            id,
        }
    }

    pub(crate) fn get_delay_log_read(&self) -> Option<Duration> {
        let d = self.delay_log_read.load(Ordering::Relaxed);

        if d == 0 {
            return None;
        }
        Some(Duration::from_millis(d))
    }
}

/// Extended store backed by another impl.
///
/// It provides defensive check against input and the state of underlying store.
/// And it provides more APIs.
pub struct StoreExt<C: RaftTypeConfig, T: RaftStorage<C>> {
    // TODO: move defensive to config
    defensive: Arc<AtomicBool>,

    config: Config,

    inner: T,

    c: PhantomData<C>,
}

impl<C: RaftTypeConfig, T: RaftStorage<C> + Clone> Clone for StoreExt<C, T> {
    fn clone(&self) -> Self {
        Self {
            defensive: self.defensive.clone(),
            config: self.config.clone(),
            inner: self.inner.clone(),
            c: PhantomData,
        }
    }
}

impl<C: RaftTypeConfig, T: RaftStorage<C>> Deref for StoreExt<C, T> {
    type Target = T;

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

impl<C: RaftTypeConfig, T: RaftStorage<C>> StoreExt<C, T> {
    /// Create a StoreExt backed by another store.
    pub fn new(inner: T) -> Self {
        StoreExt {
            defensive: Arc::new(AtomicBool::new(false)),
            config: Config::new(),
            inner,
            c: PhantomData,
        }
    }

    pub fn set_delay_log_read(&self, ms: u64) {
        self.config.delay_log_read.store(ms, Ordering::Relaxed);
        let delay = self.config.delay_log_read.load(Ordering::Relaxed);
        tracing::info!("Set log reading delay to {delay}");
    }
}

impl<C: RaftTypeConfig, T: RaftStorage<C>> Wrapper<C, T> for StoreExt<C, T>
where
    C: RaftTypeConfig,
    T: RaftStorage<C>,
{
    fn inner(&mut self) -> &mut T {
        &mut self.inner
    }
}

impl<C: RaftTypeConfig, T: RaftStorage<C>> DefensiveCheckBase<C> for StoreExt<C, T>
where
    C: RaftTypeConfig,
    T: RaftStorage<C>,
{
    fn set_defensive(&self, d: bool) {
        self.defensive.store(d, Ordering::Relaxed);
    }

    fn is_defensive(&self) -> bool {
        self.defensive.load(Ordering::Relaxed)
    }
}

impl<C: RaftTypeConfig, T: RaftStorage<C>> DefensiveCheck<C, T> for StoreExt<C, T>
where
    C: RaftTypeConfig,
    T: RaftStorage<C>,
{
}

#[async_trait]
impl<C, T, SM> RaftStorageDebug<SM> for StoreExt<C, T>
where
    T: RaftStorage<C> + RaftStorageDebug<SM>,
    C: RaftTypeConfig,
{
    async fn get_state_machine(&mut self) -> SM {
        self.inner().get_state_machine().await
    }
}

#[async_trait]
impl<C: RaftTypeConfig, T: RaftStorage<C>> RaftStorage<C> for StoreExt<C, T>
where
    T: RaftStorage<C>,
    C: RaftTypeConfig,
{
    type SnapshotData = T::SnapshotData;

    type LogReader = LogReaderExt<C, T>;

    type SnapshotBuilder = SnapshotBuilderExt<C, T>;

    #[tracing::instrument(level = "trace", skip(self))]
    async fn save_vote(&mut self, vote: &Vote<C::NodeId>) -> Result<(), StorageError<C::NodeId>> {
        self.defensive_incremental_vote(vote).await?;
        self.inner().save_vote(vote).await
    }

    #[tracing::instrument(level = "trace", skip(self))]
    async fn read_vote(&mut self) -> Result<Option<Vote<C::NodeId>>, StorageError<C::NodeId>> {
        self.inner().read_vote().await
    }

    #[tracing::instrument(level = "trace", skip(self))]
    async fn last_applied_state(
        &mut self,
    ) -> Result<(Option<LogId<C::NodeId>>, StoredMembership<C::NodeId, C::Node>), StorageError<C::NodeId>> {
        self.inner().last_applied_state().await
    }

    #[tracing::instrument(level = "trace", skip(self))]
    async fn delete_conflict_logs_since(&mut self, log_id: LogId<C::NodeId>) -> Result<(), StorageError<C::NodeId>> {
        self.defensive_delete_conflict_gt_last_applied(log_id).await?;
        self.inner().delete_conflict_logs_since(log_id).await
    }

    #[tracing::instrument(level = "trace", skip_all)]
    async fn purge_logs_upto(&mut self, log_id: LogId<C::NodeId>) -> Result<(), StorageError<C::NodeId>> {
        self.defensive_purge_applied_le_last_applied(log_id).await?;
        self.inner().purge_logs_upto(log_id).await
    }

    #[tracing::instrument(level = "trace", skip(self, entries), fields(entries=%entries.summary()))]
    async fn append_to_log(&mut self, entries: &[&Entry<C>]) -> Result<(), StorageError<C::NodeId>> {
        self.defensive_nonempty_input(entries).await?;
        self.defensive_consecutive_input(entries).await?;
        self.defensive_append_log_index_is_last_plus_one(entries).await?;
        self.defensive_append_log_id_gt_last(entries).await?;

        self.inner().append_to_log(entries).await
    }

    #[tracing::instrument(level = "trace", skip(self, entries), fields(entries=%entries.summary()))]
    async fn apply_to_state_machine(&mut self, entries: &[&Entry<C>]) -> Result<Vec<C::R>, StorageError<C::NodeId>> {
        self.defensive_nonempty_input(entries).await?;
        self.defensive_apply_index_is_last_applied_plus_one(entries).await?;
        self.defensive_apply_log_id_gt_last(entries).await?;

        self.inner().apply_to_state_machine(entries).await
    }

    #[tracing::instrument(level = "trace", skip(self))]
    async fn begin_receiving_snapshot(&mut self) -> Result<Box<Self::SnapshotData>, StorageError<C::NodeId>> {
        self.inner().begin_receiving_snapshot().await
    }

    #[tracing::instrument(level = "trace", skip(self, snapshot))]
    async fn install_snapshot(
        &mut self,
        meta: &SnapshotMeta<C::NodeId, C::Node>,
        snapshot: Box<Self::SnapshotData>,
    ) -> Result<(), StorageError<C::NodeId>> {
        self.inner().install_snapshot(meta, snapshot).await
    }

    #[tracing::instrument(level = "trace", skip(self))]
    async fn get_current_snapshot(
        &mut self,
    ) -> Result<Option<Snapshot<C::NodeId, C::Node, Self::SnapshotData>>, StorageError<C::NodeId>> {
        self.inner().get_current_snapshot().await
    }

    async fn get_log_reader(&mut self) -> Self::LogReader {
        LogReaderExt {
            defensive: self.defensive.clone(),
            config: self.config.clone(),
            inner: self.inner().get_log_reader().await,
        }
    }

    async fn get_snapshot_builder(&mut self) -> Self::SnapshotBuilder {
        SnapshotBuilderExt {
            inner: self.inner().get_snapshot_builder().await,
        }
    }
}

#[async_trait]
impl<C: RaftTypeConfig, T: RaftStorage<C>> RaftLogReader<C> for StoreExt<C, T> {
    #[tracing::instrument(level = "trace", skip(self))]
    async fn try_get_log_entries<RB: RangeBounds<u64> + Clone + Debug + Send + Sync>(
        &mut self,
        range: RB,
    ) -> Result<Vec<Entry<C>>, StorageError<C::NodeId>> {
        if let Some(d) = self.config.get_delay_log_read() {
            sleep(d).await;
        }

        self.defensive_nonempty_range(range.clone())?;
        self.inner().try_get_log_entries(range).await
    }

    async fn get_log_state(&mut self) -> Result<LogState<C>, StorageError<C::NodeId>> {
        self.defensive_no_dirty_log().await?;
        self.inner().get_log_state().await
    }
}

/// Extended snapshot builder backed by another impl.
///
/// It provides defensive check against input and the state of underlying snapshot builder.
pub struct SnapshotBuilderExt<C: RaftTypeConfig, T: RaftStorage<C>> {
    inner: T::SnapshotBuilder,
}

#[async_trait]
impl<C: RaftTypeConfig, T: RaftStorage<C>> RaftSnapshotBuilder<C, T::SnapshotData> for SnapshotBuilderExt<C, T> {
    #[tracing::instrument(level = "trace", skip(self))]
    async fn build_snapshot(
        &mut self,
    ) -> Result<Snapshot<C::NodeId, C::Node, T::SnapshotData>, StorageError<C::NodeId>> {
        self.inner.build_snapshot().await
    }
}

/// Extended log reader backed by another impl.
///
/// It provides defensive check against input and the state of underlying log reader.
pub struct LogReaderExt<C: RaftTypeConfig, T: RaftStorage<C>> {
    defensive: Arc<AtomicBool>,
    config: Config,
    inner: T::LogReader,
}

#[async_trait]
impl<C: RaftTypeConfig, T: RaftStorage<C>> RaftLogReader<C> for LogReaderExt<C, T> {
    #[tracing::instrument(level = "trace", skip(self))]
    async fn try_get_log_entries<RB: RangeBounds<u64> + Clone + Debug + Send + Sync>(
        &mut self,
        range: RB,
    ) -> Result<Vec<Entry<C>>, StorageError<C::NodeId>> {
        if let Some(d) = self.config.get_delay_log_read() {
            sleep(d).await;
        }

        self.defensive_nonempty_range(range.clone())?;
        self.inner.try_get_log_entries(range).await
    }

    async fn get_log_state(&mut self) -> Result<LogState<C>, StorageError<C::NodeId>> {
        // TODO self.defensive_no_dirty_log().await?;
        // Log state via LogReader is requested exactly at one place in the replication loop.
        // Find a way how to either remove it there or assert here properly.
        self.inner.get_log_state().await
    }
}

impl<C: RaftTypeConfig, T: RaftStorage<C>> DefensiveCheckBase<C> for LogReaderExt<C, T>
where
    C: RaftTypeConfig,
    T: RaftStorage<C>,
{
    fn set_defensive(&self, d: bool) {
        self.defensive.store(d, Ordering::Relaxed);
    }

    fn is_defensive(&self) -> bool {
        self.defensive.load(Ordering::Relaxed)
    }
}