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
#[macro_use]
extern crate log;
use std::sync::atomic;
use std::sync::Arc;
use std::thread;
use std::time::Duration;
const INIT: usize = 0;
const LIVE: usize = 1;
const TEST: usize = 2;
const RISK: usize = 3;
const DEAD: usize = 4;
pub struct Vigil {
shared: Arc<VigilShared>,
}
impl Vigil {
pub fn create(
interval_ms: usize,
missed_test_cb: Option<Callback>,
at_risk_cb: Option<Callback>,
stall_detected_cb: Option<Callback>,
) -> (Self, thread::JoinHandle<()>) {
let shared = Arc::new(VigilShared {
tick_interval: atomic::AtomicUsize::new(interval_ms),
state: atomic::AtomicUsize::new(INIT),
terminated: atomic::AtomicBool::new(false),
});
let callbacks = VigilCallbacks {
missed_test_cb,
at_risk_cb,
stall_detected_cb,
};
let thread = thread::spawn({
let shared = shared.clone();
move || shared.watch(callbacks)
});
(Vigil { shared }, thread)
}
pub fn notify(&self) {
self.shared.state.store(LIVE, atomic::Ordering::Relaxed);
}
pub fn set_interval(&self, interval_ms: usize) {
self.shared
.tick_interval
.store(interval_ms, atomic::Ordering::Relaxed);
self.notify();
}
}
impl Drop for Vigil {
fn drop(&mut self) {
self.shared
.terminated
.store(true, atomic::Ordering::Relaxed);
}
}
type Callback = Box<dyn Fn() + Send + 'static>;
struct VigilShared {
tick_interval: atomic::AtomicUsize,
state: atomic::AtomicUsize,
terminated: atomic::AtomicBool,
}
struct VigilCallbacks {
missed_test_cb: Option<Callback>,
at_risk_cb: Option<Callback>,
stall_detected_cb: Option<Callback>,
}
impl VigilShared {
fn watch(&self, callbacks: VigilCallbacks) {
loop {
if self.terminated.load(atomic::Ordering::Relaxed) {
info!("Vigil is terminating");
break;
}
match self.state.load(atomic::Ordering::Relaxed) {
INIT => info!("Liveness not initialized... waiting"),
LIVE => {
info!("Software is live - Re-testing");
self.state.store(TEST, atomic::Ordering::Relaxed);
}
TEST => {
warn!("Software missed a test - Temporary glitch/slowdown?");
let _ = self.state.compare_exchange(
TEST,
RISK,
atomic::Ordering::Relaxed,
atomic::Ordering::Relaxed,
);
if let Some(ref cb) = callbacks.missed_test_cb {
cb();
}
}
RISK => {
error!("Software missed multiple tests - Stall detected?");
let _ = self.state.compare_exchange(
RISK,
DEAD,
atomic::Ordering::Relaxed,
atomic::Ordering::Relaxed,
);
if let Some(ref cb) = callbacks.at_risk_cb {
cb();
}
}
DEAD => {
error!("Software is still unresponsive - Likely stalled");
if let Some(ref cb) = callbacks.stall_detected_cb {
cb();
}
}
v => {
warn!("Liveness check had unexpected value {}, resetting", v);
self.state.store(INIT, atomic::Ordering::Relaxed);
}
}
let interval_ms = self.tick_interval.load(atomic::Ordering::Relaxed) as u64;
thread::sleep(Duration::from_millis(interval_ms));
}
}
}
#[cfg(test)]
mod tests {
use super::*;
fn create_callbacks(status: Arc<atomic::AtomicUsize>) -> (Callback, Callback, Callback) {
(
Box::new({
let status = status.clone();
move || status.store(TEST, atomic::Ordering::Relaxed)
}),
Box::new({
let status = status.clone();
move || status.store(RISK, atomic::Ordering::Relaxed)
}),
Box::new({
let status = status;
move || status.store(DEAD, atomic::Ordering::Relaxed)
}),
)
}
macro_rules! test {
($name:ident, $sleep:expr, $interval:expr, $status:expr) => {
#[test]
fn $name() {
let status = Arc::new(atomic::AtomicUsize::new(INIT));
let (a, b, c) = create_callbacks(status.clone());
let (vigil, thread) = Vigil::create(100, Some(a), Some(b), Some(c));
for _ in 1..10 {
std::thread::sleep(Duration::from_millis(50));
vigil.notify();
}
vigil.set_interval($interval);
std::thread::sleep(Duration::from_millis($sleep));
vigil.set_interval(100);
for _ in 1..10 {
std::thread::sleep(Duration::from_millis(50));
vigil.notify();
}
let status = status.load(atomic::Ordering::Relaxed);
assert_eq!($status, status);
drop(vigil);
thread.join().unwrap();
}
};
($name:ident, $sleep:expr, $status:expr) => {
test!($name, $sleep, 100, $status);
};
}
test!(no_false_positives, 0, INIT);
test!(miss_single_test, 200, TEST);
test!(miss_multiple_tests, 300, RISK);
test!(complete_stall, 500, DEAD);
test!(predicted_stall, 500, 750, INIT);
}