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
//! Monitor progress at a `Stream`.
use std::rc::Rc;
use std::cell::RefCell;
use crate::progress::Timestamp;
use crate::progress::frontier::{AntichainRef, MutableAntichain};
use crate::dataflow::channels::pushers::Counter as PushCounter;
use crate::dataflow::channels::pushers::buffer::Buffer as PushBuffer;
use crate::dataflow::channels::pact::Pipeline;
use crate::dataflow::channels::pullers::Counter as PullCounter;
use crate::dataflow::operators::generic::builder_raw::OperatorBuilder;
use crate::Data;
use crate::dataflow::{Stream, Scope};
/// Monitors progress at a `Stream`.
pub trait Probe<G: Scope, D: Data> {
/// Constructs a progress probe which indicates which timestamps have elapsed at the operator.
///
/// # Examples
/// ```
/// use timely::*;
/// use timely::dataflow::Scope;
/// use timely::dataflow::operators::{Input, Probe, Inspect};
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let (mut input, probe) = worker.dataflow(|scope| {
/// let (input, stream) = scope.new_input();
/// let probe = stream.inspect(|x| println!("hello {:?}", x))
/// .probe();
/// (input, probe)
/// });
///
/// // introduce input, advance computation
/// for round in 0..10 {
/// input.send(round);
/// input.advance_to(round + 1);
/// worker.step_while(|| probe.less_than(input.time()));
/// }
/// }).unwrap();
/// ```
fn probe(&self) -> Handle<G::Timestamp>;
/// Inserts a progress probe in a stream.
///
/// # Examples
/// ```
/// use timely::*;
/// use timely::dataflow::Scope;
/// use timely::dataflow::operators::{Input, Probe, Inspect};
/// use timely::dataflow::operators::probe::Handle;
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let mut probe = Handle::new();
/// let mut input = worker.dataflow(|scope| {
/// let (input, stream) = scope.new_input();
/// stream.probe_with(&mut probe)
/// .inspect(|x| println!("hello {:?}", x));
///
/// input
/// });
///
/// // introduce input, advance computation
/// for round in 0..10 {
/// input.send(round);
/// input.advance_to(round + 1);
/// worker.step_while(|| probe.less_than(input.time()));
/// }
/// }).unwrap();
/// ```
fn probe_with(&self, handle: &mut Handle<G::Timestamp>) -> Stream<G, D>;
}
impl<G: Scope, D: Data> Probe<G, D> for Stream<G, D> {
fn probe(&self) -> Handle<G::Timestamp> {
// the frontier is shared state; scope updates, handle reads.
let mut handle = Handle::<G::Timestamp>::new();
self.probe_with(&mut handle);
handle
}
fn probe_with(&self, handle: &mut Handle<G::Timestamp>) -> Stream<G, D> {
let mut builder = OperatorBuilder::new("Probe".to_owned(), self.scope());
let mut input = PullCounter::new(builder.new_input(self, Pipeline));
let (tee, stream) = builder.new_output();
let mut output = PushBuffer::new(PushCounter::new(tee));
let frontier = handle.frontier.clone();
let mut started = false;
let mut vector = Vec::new();
builder.build(
move |changes| {
let mut borrow = frontier.borrow_mut();
borrow.update_iter(changes[0].drain());
},
move |consumed, internal, produced| {
if !started {
internal[0].update(Default::default(), -1);
started = true;
}
use crate::communication::message::RefOrMut;
while let Some(message) = input.next() {
let (time, data) = match message.as_ref_or_mut() {
RefOrMut::Ref(reference) => (&reference.time, RefOrMut::Ref(&reference.data)),
RefOrMut::Mut(reference) => (&reference.time, RefOrMut::Mut(&mut reference.data)),
};
data.swap(&mut vector);
output.session(time).give_vec(&mut vector);
}
output.cease();
// extract what we know about progress from the input and output adapters.
input.consumed().borrow_mut().drain_into(&mut consumed[0]);
output.inner().produced().borrow_mut().drain_into(&mut produced[0]);
false
},
);
stream
}
}
/// Reports information about progress at the probe.
pub struct Handle<T:Timestamp> {
frontier: Rc<RefCell<MutableAntichain<T>>>
}
impl<T: Timestamp> Handle<T> {
/// returns true iff the frontier is strictly less than `time`.
#[inline] pub fn less_than(&self, time: &T) -> bool { self.frontier.borrow().less_than(time) }
/// returns true iff the frontier is less than or equal to `time`.
#[inline] pub fn less_equal(&self, time: &T) -> bool { self.frontier.borrow().less_equal(time) }
/// returns true iff the frontier is empty.
#[inline] pub fn done(&self) -> bool { self.frontier.borrow().is_empty() }
/// Allocates a new handle.
#[inline] pub fn new() -> Self { Handle { frontier: Rc::new(RefCell::new(MutableAntichain::new())) } }
/// Invokes a method on the frontier, returning its result.
///
/// This method allows inspection of the frontier, which cannot be returned by reference as
/// it is on the other side of a `RefCell`.
///
/// # Examples
///
/// ```
/// use timely::dataflow::operators::probe::Handle;
///
/// let handle = Handle::<usize>::new();
/// let frontier = handle.with_frontier(|frontier| frontier.to_vec());
/// ```
#[inline]
pub fn with_frontier<R, F: FnMut(AntichainRef<T>)->R>(&self, mut function: F) -> R {
function(self.frontier.borrow().frontier())
}
}
impl<T: Timestamp> Clone for Handle<T> {
fn clone(&self) -> Self {
Handle {
frontier: self.frontier.clone()
}
}
}
#[cfg(test)]
mod tests {
use crate::communication::Configuration;
use crate::dataflow::operators::{Input, Probe};
#[test]
fn probe() {
// initializes and runs a timely dataflow computation
crate::execute(Configuration::Thread, |worker| {
// create a new input, and inspect its output
let (mut input, probe) = worker.dataflow(move |scope| {
let (input, stream) = scope.new_input::<String>();
(input, stream.probe())
});
// introduce data and watch!
for round in 0..10 {
assert!(!probe.done());
assert!(probe.less_equal(&round));
assert!(probe.less_than(&(round + 1)));
input.advance_to(round + 1);
worker.step();
}
// seal the input
input.close();
// finish off any remaining work
worker.step();
worker.step();
worker.step();
worker.step();
assert!(probe.done());
}).unwrap();
}
}