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

// Copyright 2018-2019 Parity Technologies (UK) Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Bridging round state between rounds.

use crate::round::State as RoundState;
use futures::task;
use parking_lot::{RwLock, RwLockReadGuard};
use std::{sync::Arc, task::Context};

// round state bridged across rounds.
struct Bridged<H, N> {
	inner: RwLock<RoundState<H, N>>,
	waker: task::AtomicWaker,
}

impl<H, N> Bridged<H, N> {
	fn new(inner: RwLock<RoundState<H, N>>) -> Self {
		Bridged { inner, waker: task::AtomicWaker::new() }
	}
}

/// A prior view of a round-state.
pub(crate) struct PriorView<H, N>(Arc<Bridged<H, N>>);

impl<H, N> PriorView<H, N> {
	/// Push an update to the latter view.
	pub(crate) fn update(&self, new: RoundState<H, N>) {
		*self.0.inner.write() = new;
		self.0.waker.wake();
	}
}

/// A latter view of a round-state.
pub(crate) struct LatterView<H, N>(Arc<Bridged<H, N>>);

impl<H, N> LatterView<H, N> {
	/// Fetch a handle to the last round-state.
	pub(crate) fn get(&self, cx: &mut Context) -> RwLockReadGuard<RoundState<H, N>> {
		self.0.waker.register(cx.waker());
		self.0.inner.read()
	}
}

/// Constructs two views of a bridged round-state.
///
/// The prior view is held by a round which produces the state and pushes updates to a latter view.
/// When updating, the latter view's task is updated.
///
/// The latter view is held by the subsequent round, which blocks certain activity
/// while waiting for events on an older round.
pub(crate) fn bridge_state<H, N>(initial: RoundState<H, N>) -> (PriorView<H, N>, LatterView<H, N>) {
	let inner = Arc::new(Bridged::new(RwLock::new(initial)));
	(PriorView(inner.clone()), LatterView(inner))
}

#[cfg(test)]
mod tests {
	use super::*;
	use std::{sync::Barrier, task::Poll};

	#[test]
	fn bridging_state() {
		let initial =
			RoundState { prevote_ghost: None, finalized: None, estimate: None, completable: false };

		let (prior, latter) = bridge_state(initial);
		let waits_for_finality = ::futures::future::poll_fn(move |cx| -> Poll<()> {
			if latter.get(cx).finalized.is_some() {
				Poll::Ready(())
			} else {
				Poll::Pending
			}
		});

		let barrier = Arc::new(Barrier::new(2));
		let barrier_other = barrier.clone();
		::std::thread::spawn(move || {
			barrier_other.wait();
			prior.update(RoundState {
				prevote_ghost: Some(("5", 5)),
				finalized: Some(("1", 1)),
				estimate: Some(("3", 3)),
				completable: true,
			});
		});

		barrier.wait();
		futures::executor::block_on(waits_for_finality);
	}
}