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
339
340
341
342
343
344
345
346
347
348
349
350
//! Create new `Streams` connected to external inputs.
use std::rc::Rc;
use std::cell::RefCell;
use std::default::Default;
use progress::frontier::Antichain;
use progress::{Operate, Timestamp};
use progress::nested::subgraph::Source;
use progress::ChangeBatch;
use progress::timestamp::RootTimestamp;
use progress::nested::product::Product;
use timely_communication::Allocate;
use {Data, Push};
use dataflow::channels::Content;
use dataflow::channels::pushers::{Tee, Counter};
use dataflow::{Stream, Scope};
use dataflow::scopes::{Child, Root};
// TODO : This is an exogenous input, but it would be nice to wrap a Subgraph in something
// TODO : more like a harness, with direct access to its inputs.
// NOTE : This only takes a &self, not a &mut self, which works but is a bit weird.
// NOTE : Experiments with &mut indicate that the borrow of 'a lives for too long.
// NOTE : Might be able to fix with another lifetime parameter, say 'c: 'a.
/// Create a new `Stream` and `Handle` through which to supply input.
pub trait Input<'a, A: Allocate, T: Timestamp> {
/// Create a new `Stream` and `Handle` through which to supply input.
///
/// The `new_input` method returns a pair `(Handle, Stream)` where the `Stream` can be used
/// immediately for timely dataflow construction, and the `Handle` is later used to introduce
/// data into the timely dataflow computation.
///
/// The `Handle` also provides a means to indicate
/// to timely dataflow that the input has advanced beyond certain timestamps, allowing timely
/// to issue progress notifications.
///
/// #Examples
/// ```
/// use timely::*;
/// use timely::dataflow::operators::{Input, Inspect};
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let mut input = worker.dataflow(|scope| {
/// let (input, stream) = scope.new_input();
/// stream.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();
/// }
/// });
/// ```
fn new_input<D: Data>(&mut self) -> (Handle<T, D>, Stream<Child<'a, Root<A>, T>, D>);
/// Create a new stream from a supplied interactive handle.
///
/// This method creates a new timely stream whose data are supplied interactively through the `handle`
/// argument. Each handle may be used multiple times (or not at all), and will clone data as appropriate
/// if it as attached to more than one stream.
///
/// #Examples
/// ```
/// use timely::*;
/// use timely::dataflow::operators::{Input, Inspect};
/// use timely::dataflow::operators::input::Handle;
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let mut input = Handle::new();
/// worker.dataflow(|scope| {
/// scope.input_from(&mut input)
/// .inspect(|x| println!("hello {:?}", x));
/// });
///
/// // introduce input, advance computation
/// for round in 0..10 {
/// input.send(round);
/// input.advance_to(round + 1);
/// worker.step();
/// }
/// });
/// ```
fn input_from<D: Data>(&mut self, handle: &mut Handle<T, D>) -> Stream<Child<'a, Root<A>, T>, D>;
}
impl<'a, A: Allocate, T: Timestamp> Input<'a, A, T> for Child<'a, Root<A>, T> {
fn new_input<D: Data>(&mut self) -> (Handle<T, D>, Stream<Child<'a, Root<A>, T>, D>) {
let mut handle = Handle::new();
let stream = self.input_from(&mut handle);
(handle, stream)
}
fn input_from<D: Data>(&mut self, handle: &mut Handle<T, D>) -> Stream<Child<'a, Root<A>, T>, D> {
let (output, registrar) = Tee::<Product<RootTimestamp, T>, D>::new();
let counter = Counter::new(output);
let produced = counter.produced().clone();
let progress = Rc::new(RefCell::new(ChangeBatch::new()));
handle.register(counter, progress.clone());
let copies = self.peers();
let index = self.add_operator(Operator {
progress: progress,
messages: produced,
copies: copies,
});
Stream::new(Source { index: index, port: 0 }, registrar, self.clone())
}
}
struct Operator<T:Timestamp> {
progress: Rc<RefCell<ChangeBatch<Product<RootTimestamp, T>>>>, // times closed since last asked
messages: Rc<RefCell<ChangeBatch<Product<RootTimestamp, T>>>>, // messages sent since last asked
copies: usize,
}
impl<T:Timestamp> Operate<Product<RootTimestamp, T>> for Operator<T> {
fn name(&self) -> String { "Input".to_owned() }
fn inputs(&self) -> usize { 0 }
fn outputs(&self) -> usize { 1 }
fn get_internal_summary(&mut self) -> (Vec<Vec<Antichain<<Product<RootTimestamp, T> as Timestamp>::Summary>>>,
Vec<ChangeBatch<Product<RootTimestamp, T>>>) {
let mut map = ChangeBatch::new();
map.update(Default::default(), self.copies as i64);
(Vec::new(), vec![map])
}
fn pull_internal_progress(&mut self,_messages_consumed: &mut [ChangeBatch<Product<RootTimestamp, T>>],
frontier_progress: &mut [ChangeBatch<Product<RootTimestamp, T>>],
messages_produced: &mut [ChangeBatch<Product<RootTimestamp, T>>]) -> bool
{
self.messages.borrow_mut().drain_into(&mut messages_produced[0]);
self.progress.borrow_mut().drain_into(&mut frontier_progress[0]);
false
}
fn notify_me(&self) -> bool { false }
}
/// A handle to an input `Stream`, used to introduce data to a timely dataflow computation.
pub struct Handle<T: Timestamp, D: Data> {
progress: Vec<Rc<RefCell<ChangeBatch<Product<RootTimestamp, T>>>>>,
pushers: Vec<Counter<Product<RootTimestamp, T>, D, Tee<Product<RootTimestamp, T>, D>>>,
buffer1: Vec<D>,
buffer2: Vec<D>,
now_at: Product<RootTimestamp, T>,
}
impl<T:Timestamp, D: Data> Handle<T, D> {
/// Allocates a new input handle, from which one can create timely streams.
///
/// #Examples
/// ```
/// use timely::*;
/// use timely::dataflow::operators::{Input, Inspect};
/// use timely::dataflow::operators::input::Handle;
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let mut input = Handle::new();
/// worker.dataflow(|scope| {
/// scope.input_from(&mut input)
/// .inspect(|x| println!("hello {:?}", x));
/// });
///
/// // introduce input, advance computation
/// for round in 0..10 {
/// input.send(round);
/// input.advance_to(round + 1);
/// worker.step();
/// }
/// });
/// ```
pub fn new() -> Self {
Handle {
progress: Vec::new(),
pushers: Vec::new(),
buffer1: Vec::with_capacity(Content::<D>::default_length()),
buffer2: Vec::with_capacity(Content::<D>::default_length()),
now_at: Default::default(),
}
}
/// Creates an input stream from the handle in the supplied scope.
///
/// #Examples
/// ```
/// use timely::*;
/// use timely::dataflow::operators::{Input, Inspect};
/// use timely::dataflow::operators::input::Handle;
///
/// // construct and execute a timely dataflow
/// timely::execute(Configuration::Thread, |worker| {
///
/// // add an input and base computation off of it
/// let mut input = Handle::new();
/// worker.dataflow(|scope| {
/// input.to_stream(scope)
/// .inspect(|x| println!("hello {:?}", x));
/// });
///
/// // introduce input, advance computation
/// for round in 0..10 {
/// input.send(round);
/// input.advance_to(round + 1);
/// worker.step();
/// }
/// });
/// ```
pub fn to_stream<'a, A: Allocate>(&mut self, scope: &mut Child<'a, Root<A>, T>) -> Stream<Child<'a, Root<A>, T>, D>
where T: Ord {
scope.input_from(self)
}
fn register(
&mut self,
pusher: Counter<Product<RootTimestamp, T>, D, Tee<Product<RootTimestamp, T>, D>>,
progress: Rc<RefCell<ChangeBatch<Product<RootTimestamp, T>>>>
) {
// flush current contents, so new registrant does not see existing data.
if !self.buffer1.is_empty() { self.flush(); }
// we need to produce an appropriate update to the capabilities for `progress`, in case a
// user has decided to drive the handle around a bit before registering it.
progress.borrow_mut().update(Default::default(), -1);
progress.borrow_mut().update(self.now_at.clone(), 1);
self.progress.push(progress);
self.pushers.push(pusher);
}
// flushes our buffer at each of the destinations. there can be more than one; clone if needed.
fn flush(&mut self) {
for index in 0 .. self.pushers.len() {
if index < self.pushers.len() - 1 {
self.buffer2.extend_from_slice(&self.buffer1[..]);
Content::push_at(&mut self.buffer2, self.now_at.clone(), &mut self.pushers[index]);
assert!(self.buffer2.is_empty());
}
else {
Content::push_at(&mut self.buffer1, self.now_at.clone(), &mut self.pushers[index]);
assert!(self.buffer1.is_empty());
}
}
self.buffer1.clear();
}
// closes the current epoch, flushing if needed, shutting if needed, and updating the frontier.
fn close_epoch(&mut self) {
if !self.buffer1.is_empty() { self.flush(); }
for pusher in self.pushers.iter_mut() {
pusher.done();
}
for progress in self.progress.iter() {
progress.borrow_mut().update(self.now_at.clone(), -1);
}
}
#[inline(always)]
/// Sends one record into the corresponding timely dataflow `Stream`, at the current epoch.
pub fn send(&mut self, data: D) {
// assert!(self.buffer.capacity() == Content::<D>::default_length());
self.buffer1.push(data);
if self.buffer1.len() == self.buffer1.capacity() {
self.flush();
}
}
/// Sends a batch of records into the corresponding timely dataflow `Stream`, at the current epoch.
///
/// This method flushes single elements previously sent with `send`, to keep the insertion order.
pub fn send_batch(&mut self, buffer: &mut Vec<D>) {
if !buffer.is_empty() {
// flush buffered elements to ensure local fifo.
if !self.buffer1.is_empty() { self.flush(); }
// push buffer (or clone of buffer) at each destination.
for index in 0 .. self.pushers.len() {
if index < self.pushers.len() - 1 {
self.buffer2.extend_from_slice(&buffer[..]);
Content::push_at(&mut self.buffer2, self.now_at.clone(), &mut self.pushers[index]);
assert!(self.buffer2.is_empty());
}
else {
Content::push_at(buffer, self.now_at.clone(), &mut self.pushers[index]);
assert!(buffer.is_empty());
}
}
buffer.clear();
}
}
/// Advances the current epoch to `next`.
///
/// This method allows timely dataflow to issue progress notifications as it can now determine
/// that this input can no longer produce data at earlier timestamps.
pub fn advance_to(&mut self, next: T) {
assert!(self.now_at.inner.less_equal(&next));
self.close_epoch();
self.now_at = RootTimestamp::new(next);
for progress in self.progress.iter() {
progress.borrow_mut().update(self.now_at.clone(), 1);
}
}
/// Closes the input.
///
/// This method allows timely dataflow to issue all progress notifications blocked by this input
/// and to begin to shut down operators, as this input can no longer produce data.
pub fn close(self) { }
/// Reports the current epoch.
pub fn epoch(&self) -> &T {
&self.now_at.inner
}
/// Reports the current timestamp.
pub fn time(&self) -> &Product<RootTimestamp, T> {
&self.now_at
}
}
impl<T:Timestamp, D: Data> Drop for Handle<T, D> {
fn drop(&mut self) {
self.close_epoch();
}
}