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
mod core;
mod execution;
mod shared;
use crate::context::ContextLifecycle;
use crate::protocol::batch::BatchPair;
use crate::scheduler::BatchExecutionResult;
use crate::scheduler::ExecutionTask;
use crate::scheduler::ExecutionTaskCompletionNotifier;
use crate::scheduler::Scheduler;
use crate::scheduler::SchedulerError;
use std::sync::mpsc;
use std::sync::mpsc::Sender;
use std::sync::{Arc, Mutex};
impl From<std::sync::PoisonError<std::sync::MutexGuard<'_, shared::Shared>>> for SchedulerError {
fn from(
error: std::sync::PoisonError<std::sync::MutexGuard<'_, shared::Shared>>,
) -> SchedulerError {
SchedulerError::Internal(format!("scheduler shared lock is poisoned: {}", error))
}
}
impl From<std::sync::mpsc::SendError<core::CoreMessage>> for SchedulerError {
fn from(error: std::sync::mpsc::SendError<core::CoreMessage>) -> SchedulerError {
SchedulerError::Internal(format!("scheduler's core thread disconnected: {}", error))
}
}
pub struct SerialScheduler {
shared_lock: Arc<Mutex<shared::Shared>>,
core_handle: Option<std::thread::JoinHandle<()>>,
core_tx: Sender<core::CoreMessage>,
task_iterator: Option<Box<Iterator<Item = ExecutionTask> + Send>>,
}
impl SerialScheduler {
pub fn new(
context_lifecycle: Box<ContextLifecycle>,
state_id: String,
) -> Result<SerialScheduler, SchedulerError> {
let (execution_tx, execution_rx) = mpsc::channel();
let (core_tx, core_rx) = mpsc::channel();
let shared_lock = Arc::new(Mutex::new(shared::Shared::new()));
let core_handle = core::SchedulerCore::new(
shared_lock.clone(),
core_rx,
execution_tx,
context_lifecycle,
state_id,
)
.start()?;
Ok(SerialScheduler {
shared_lock,
core_handle: Some(core_handle),
core_tx: core_tx.clone(),
task_iterator: Some(Box::new(execution::SerialExecutionTaskIterator::new(
core_tx,
execution_rx,
))),
})
}
pub fn shutdown(mut self) {
match self.core_tx.send(core::CoreMessage::Shutdown) {
Ok(_) => {
if let Some(join_handle) = self.core_handle.take() {
join_handle.join().unwrap_or_else(|err| {
error!(
"failed to join scheduler thread because it panicked: {:?}",
err
)
});
}
}
Err(err) => {
warn!("failed to send to scheduler thread during drop: {}", err);
}
}
}
}
impl Scheduler for SerialScheduler {
fn set_result_callback(
&mut self,
callback: Box<Fn(Option<BatchExecutionResult>) + Send>,
) -> Result<(), SchedulerError> {
self.shared_lock.lock()?.set_result_callback(callback);
Ok(())
}
fn set_error_callback(
&mut self,
callback: Box<Fn(SchedulerError) + Send>,
) -> Result<(), SchedulerError> {
self.shared_lock.lock()?.set_error_callback(callback);
Ok(())
}
fn add_batch(&mut self, batch: BatchPair) -> Result<(), SchedulerError> {
let mut shared = self.shared_lock.lock()?;
if shared.finalized() {
return Err(SchedulerError::SchedulerFinalized);
}
if shared.batch_already_queued(&batch) {
return Err(SchedulerError::DuplicateBatch(
batch.batch().header_signature().into(),
));
}
shared.add_unscheduled_batch(batch);
self.core_tx.send(core::CoreMessage::BatchAdded)?;
Ok(())
}
fn cancel(&mut self) -> Result<Vec<BatchPair>, SchedulerError> {
Ok(self.shared_lock.lock()?.drain_unscheduled_batches())
}
fn finalize(&mut self) -> Result<(), SchedulerError> {
self.shared_lock.lock()?.set_finalized(true);
self.core_tx.send(core::CoreMessage::Finalized)?;
Ok(())
}
fn take_task_iterator(
&mut self,
) -> Result<Box<dyn Iterator<Item = ExecutionTask> + Send>, SchedulerError> {
self.task_iterator
.take()
.ok_or(SchedulerError::NoTaskIterator)
}
fn new_notifier(&mut self) -> Result<Box<dyn ExecutionTaskCompletionNotifier>, SchedulerError> {
Ok(Box::new(
execution::SerialExecutionTaskCompletionNotifier::new(self.core_tx.clone()),
))
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::scheduler::tests::*;
#[test]
fn test_scheduler_thread_cleanup() {
let state_id = String::from("state0");
let context_lifecycle = Box::new(MockContextLifecycle::new());
SerialScheduler::new(context_lifecycle, state_id)
.expect("Failed to create scheduler")
.shutdown();
}
#[test]
fn test_serial_scheduler() {
let state_id = String::from("state0");
let context_lifecycle = Box::new(MockContextLifecycle::new());
let mut scheduler =
SerialScheduler::new(context_lifecycle, state_id).expect("Failed to create scheduler");
test_scheduler(&mut scheduler);
scheduler.shutdown();
}
#[test]
fn test_serial_scheduler_cancel() {
let state_id = String::from("state0");
let context_lifecycle = Box::new(MockContextLifecycle::new());
let mut scheduler =
SerialScheduler::new(context_lifecycle, state_id).expect("Failed to create scheduler");
test_scheduler_cancel(&mut scheduler);
scheduler.shutdown();
}
#[test]
pub fn test_serial_scheduler_flow_with_one_transaction() {
let state_id = String::from("state0");
let context_lifecycle = Box::new(MockContextLifecycle::new());
let mut scheduler =
SerialScheduler::new(context_lifecycle, state_id).expect("Failed to create scheduler");
test_scheduler_flow_with_one_transaction(&mut scheduler);
scheduler.shutdown();
}
}