Skip to main content

mz_timely_util/
reclock.rs

1// Copyright Materialize, Inc. and contributors. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License in the LICENSE file at the
6// root of this repository, or online at
7//
8//     http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16//! ## Notation
17//!
18//! Collections are represented with capital letters (T, S, R), collection traces as bold letters
19//! (𝐓, 𝐒, 𝐑), and difference traces as δ𝐓.
20//!
21//! Indexing a collection trace 𝐓 to obtain its version at `t` is written as 𝐓(t). Indexing a
22//! collection to obtain the multiplicity of a record `x` is written as T\[x\]. These can be combined
23//! to obtain the multiplicity of a record `x` at some version `t` as 𝐓(t)\[x\].
24//!
25//! ## Overview
26//!
27//! Reclocking transforms a source collection `S` that evolves with some timestamp `FromTime` into
28//! a collection `T` that evolves with some other timestamp `IntoTime`. The reclocked collection T
29//! contains all updates `u ∈ S` that are not beyond some `FromTime` frontier R(t). The collection
30//! `R` is called the remap collection.
31//!
32//! More formally, for some arbitrary time `t` of `IntoTime` and some arbitrary record `x`, the
33//! reclocked collection `T(t)[x]` is defined to be the `sum{δ𝐒(s)[x]: !(𝐑(t) βͺ― s)}`. Since this
34//! holds for any record we can write the definition of Reclock(𝐒, 𝐑) as:
35//!
36//! > Reclock(𝐒, 𝐑) β‰œ 𝐓: βˆ€ t ∈ IntoTime : 𝐓(t) = sum{δ𝐒(s): !(𝐑(t) βͺ― s)}
37//!
38//! In order for the reclocked collection `T` to have a sensible definition of progress we require
39//! that `t1 ≀ t2 β‡’ 𝐑(t1) βͺ― 𝐑(t2)` where the first `≀` is the partial order of `IntoTime` and the
40//! second one the partial order of `FromTime` antichains.
41//!
42//! ## Total order simplification
43//!
44//! In order to simplify the implementation we will require that `IntoTime` is a total order. This
45//! limitation can be lifted in the future but further elaboration on the mechanics of reclocking
46//! is required to ensure a correct implementation.
47//!
48//! ## The difference trace
49//!
50//! By the definition of difference traces we have:
51//!
52//! ```text
53//!     δ𝐓(t) = T(t) - sum{δ𝐓(s): s < t}
54//! ```
55//!
56//! Due to the total order assumption we only need to consider two cases.
57//!
58//! **Case 1:** `t` is the minimum timestamp
59//!
60//! In this case `sum{δ𝐓(s): s < t}` is the empty set and so we obtain:
61//!
62//! ```text
63//!     δ𝐓(min) = T(min) = sum{δ𝐒(s): !(𝐑(min) ≀ s}
64//! ```
65//!
66//! **Case 2:** `t` is a timestamp with a predecessor `prev`
67//!
68//! In this case `sum{δ𝐓(s): s < t}` is equal to `T(prev)` because:
69//!
70//! ```text
71//!     sum{δ𝐓(s): s < t} = sum{δ𝐓(s): s ≀ prev} + sum{δ𝐓(s): prev < s < t}
72//!                       = T(prev) + βˆ…
73//!                       = T(prev)
74//! ```
75//!
76//! And therefore the difference trace of T is:
77//!
78//! ```text
79//!     δ𝐓(t) = 𝐓(t) - 𝐓(prev)
80//!           = sum{δ𝐒(s): !(𝐑(t) βͺ― s)} - sum{δ𝐒(s): !(𝐑(prev) βͺ― s)}
81//!           = sum{δ𝐒(s): (𝐑(prev) βͺ― s) ∧ !(𝐑(t) βͺ― s)}
82//! ```
83//!
84//! ## Unique mapping property
85//!
86//! Given the definition above we can derive the fact that for any source difference δ𝐒(s) there is
87//! at most one target timestamp t that it must be reclocked to. This property can be exploited by
88//! the implementation of the operator as it can safely discard source updates once a matching
89//! Ξ΄T(t) has been found, making it "stateless" with respect to the source trace. A formal proof of
90//! this property is [provided below](#unique-mapping-property-proof).
91//!
92//! ## Operational description
93//!
94//! The operator follows a run-to-completion model where on each scheduling it completes all
95//! outstanding work that can be completed.
96//!
97//! ### Unique mapping property proof
98//!
99//! This section contains the formal proof the unique mapping property. The proof follows the
100//! structure proof notation created by Leslie Lamport. Readers unfamiliar with structured proofs
101//! can read about them here <https://lamport.azurewebsites.net/pubs/proof.pdf>.
102//!
103//! #### Statement
104//!
105//! AtMostOne(X, Ο†(x)) β‰œ βˆ€ x1, x2 ∈ X : Ο†(x1) ∧ Ο†(x2) β‡’ x1 = x2
106//!
107//! * **THEOREM** UniqueMapping β‰œ
108//!     * **ASSUME**
109//!         * **NEW** (FromTime, βͺ―) ∈ PartiallyOrderedTimestamps
110//!         * **NEW** (IntoTime, ≀) ∈ TotallyOrderedTimestamps
111//!         * **NEW** 𝐒 ∈ SetOfCollectionTraces(FromTime)
112//!         * **NEW** 𝐑 ∈ SetOfCollectionTraces(IntoTime)
113//!         * βˆ€ t ∈ IntoTime: 𝐑(t) ∈ SetOfAntichains(FromTime)
114//!         * βˆ€ t1, t1 ∈ IntoTime: t1 ≀ t2 β‡’ 𝐑(t1) βͺ― 𝐑(t2)
115//!         * **NEW** 𝐓 = Reclock(𝐒, 𝐑)
116//!     * **PROVE**  βˆ€ s ∈ FromTime : AtMostOne(IntoTime, δ𝐒(s) ∈ δ𝐓(x))
117//!
118//! #### Proof
119//!
120//! 1. **SUFFICES ASSUME** βˆƒ s ∈ FromTime: Β¬AtMostOne(IntoTime, δ𝐒(s) ∈ δ𝐓(x))
121//!     * **PROVE FALSE**
122//!     * _By proof by contradiction._
123//! 2. **PICK** s ∈ FromTime : Β¬AtMostOne(IntoTime, δ𝐒(s) ∈ δ𝐓(x))
124//!    * _Proof: Such time exists by <1>1._
125//! 3. βˆƒ t1, t2 ∈ IntoTime : t1 β‰  t2 ∧ δ𝐒(s) ∈ δ𝐓(t1) ∧ δ𝐒(s) ∈ δ𝐓(t2)
126//!     1. Β¬(βˆ€ x1, x2 ∈ X : (δ𝐒(s) ∈ δ𝐓(x1)) ∧ (δ𝐒(s) ∈ δ𝐓(x2)) β‡’ x1 = x2)
127//!         * _Proof: By <1>2 and definition of AtMostOne._
128//!     2. Q.E.D
129//!         * _Proof: By <2>1, quantifier negation rules, and theorem of propositional logic Β¬(P β‡’ Q) ≑ P ∧ Β¬Q._
130//! 4. **PICK** t1, t2 ∈ IntoTime : t1 < t2 ∧ δ𝐒(s) ∈ δ𝐓(t1) ∧ δ𝐒(s) ∈ δ𝐓(t2)
131//!    * _Proof: By <1>3. Assume t1 < t2 without loss of generality._
132//! 5. Β¬(𝐑(t1) βͺ― s)
133//!     1. **CASE** t1 = min(IntoTime)
134//!         1. δ𝐓(t1) = sum{δ𝐒(s): !(𝐑(t1)) βͺ― s}
135//!             * _Proof: By definition of δ𝐓(min)._
136//!         2. δ𝐒(s) ∈ δ𝐓(t1)
137//!             * _Proof: By <1>4._
138//!         3. Q.E.D
139//!             * _Proof: By <3>1 and <3>2._
140//!     2. **CASE** t1 > min(IntoTime)
141//!         1. **PICK** t1_prev = Predecessor(t1)
142//!             * _Proof: Predecessor exists because the set {t: t < t1} is non-empty since it must contain at least min(IntoTime)._
143//!         2. δ𝐓(t1) = sum{δ𝐒(s): (𝐑(t1_prev) βͺ― s) ∧ !(𝐑(t1) βͺ― s)}
144//!             * _Proof: By definition of δ𝐓(t)._
145//!         3. δ𝐒(s) ∈ δ𝐓(t1)
146//!             * _Proof: By <1>4._
147//!         3. Q.E.D
148//!             * _Proof: By <3>2 and <3>3._
149//!     3. Q.E.D
150//!         * _Proof: From cases <2>1 and <2>2 which are exhaustive_
151//! 6. **PICK** t2_prev ∈ IntoTime : t2_prev = Predecessor(t2)
152//!    * _Proof: Predecessor exists because by <1>4 the set {t: t < t2} is non empty since it must contain at least t1._
153//! 7. t1 ≀ t2_prev
154//!    * _Proof: t1 ∈ {t: t < t2} and t2_prev is the maximum element of the set._
155//! 8. 𝐑(t2) βͺ― s
156//!     1. t2 > min(IntoTime)
157//!         * _Proof: By <1>5._
158//!     2. **PICK** t2_prev = Predecessor(t2)
159//!         * _Proof: Predecessor exists because the set {t: t < t2} is non-empty since it must contain at least min(IntoTime)._
160//!     3. δ𝐓(t) = sum{δ𝐒(s): (𝐑(t2_prev) βͺ― s) ∧ !(𝐑(t) βͺ― s)}
161//!         * _Proof: By definition of δ𝐓(t)_
162//!     4. δ𝐒(s) ∈ δ𝐓(t1)
163//!         * _Proof: By <1>4._
164//!     5. Q.E.D
165//!         * _Proof: By <2>3 and <2>4._
166//! 9. 𝐑(t1) βͺ― 𝐑(t2_prev)
167//!     * _Proof: By <1>.7 and hypothesis on R_
168//! 10. 𝐑(t1) βͺ― s
169//!     * _Proof: By <1>8 and <1>9._
170//! 11. Q.E.D
171//!     * _Proof: By <1>5 and <1>10_
172
173use std::cmp::{Ordering, Reverse};
174use std::collections::VecDeque;
175use std::collections::binary_heap::{BinaryHeap, PeekMut};
176use std::iter::FromIterator;
177
178use differential_dataflow::difference::Semigroup;
179use differential_dataflow::lattice::Lattice;
180use differential_dataflow::{AsCollection, ExchangeData, VecCollection, consolidation};
181use mz_ore::Overflowing;
182use mz_ore::collections::CollectionExt;
183use timely::communication::{Pull, Push};
184use timely::dataflow::channels::pact::Pipeline;
185use timely::dataflow::operators::CapabilitySet;
186use timely::dataflow::operators::capture::Event;
187use timely::dataflow::operators::generic::OutputBuilder;
188use timely::dataflow::operators::generic::builder_rc::OperatorBuilder;
189use timely::order::{PartialOrder, TotalOrder};
190use timely::progress::frontier::{AntichainRef, MutableAntichain};
191use timely::progress::{Antichain, Timestamp};
192
193/// Constructs an operator that reclocks a `source` collection varying with some time `FromTime`
194/// into the corresponding `reclocked` collection varying over some time `IntoTime` using the
195/// provided `remap` collection.
196///
197/// In order for the operator to read the `source` collection a `Pusher` is returned which can be
198/// used with timely's capture facilities to connect a collection from a foreign scope to this
199/// operator.
200pub fn reclock<'scope, D, FromTime, IntoTime, R>(
201    remap_collection: VecCollection<'scope, IntoTime, FromTime, Overflowing<i64>>,
202    as_of: Antichain<IntoTime>,
203) -> (
204    Box<dyn Push<Event<FromTime, Vec<(D, FromTime, R)>>>>,
205    VecCollection<'scope, IntoTime, D, R>,
206)
207where
208    D: ExchangeData,
209    FromTime: Timestamp,
210    IntoTime: Timestamp + Lattice + TotalOrder,
211    R: Semigroup + 'static,
212{
213    let scope = remap_collection.scope();
214    let mut builder = OperatorBuilder::new("Reclock".into(), scope.clone());
215    // Here we create a channel that can be used to send data from a foreign scope into this
216    // operator. The channel is associated with this operator's address so that it is activated
217    // every time events are available for consumption. This mechanism is similar to Timely's input
218    // handles where data can be introduced into a timely scope from an exogenous source.
219    let info = builder.operator_info();
220    let channel_id = scope.worker().new_identifier();
221    let (pusher, mut events) = scope
222        .worker()
223        .pipeline::<Event<FromTime, Vec<(D, FromTime, R)>>>(channel_id, info.address);
224
225    let mut remap_input = builder.new_input(remap_collection.inner, Pipeline);
226    let (output, reclocked) = builder.new_output();
227    let mut output = OutputBuilder::from(output);
228
229    builder.build(move |caps| {
230        let mut capset = CapabilitySet::from_elem(caps.into_element());
231        capset.downgrade(&as_of.borrow());
232
233        // Received remap updates at times `into_time` greater or equal to `remap_input`'s input
234        // frontier. As the input frontier advances, we drop elements out of this priority queue
235        // and mint new associations.
236        let mut pending_remap: BinaryHeap<Reverse<(IntoTime, FromTime, i64)>> = BinaryHeap::new();
237        // A trace of `remap_input` that accumulates correctly for all times that are beyond
238        // `remap_since` and not beyond `remap_upper`. The updates in `remap_trace` are maintained
239        // in time order. An actual DD trace could be used here at the expense of a more
240        // complicated API to traverse it. This is left for future work if the naive trace
241        // maintenance implemented in this operator becomes problematic.
242        let mut remap_upper = Antichain::from_elem(IntoTime::minimum());
243        let mut remap_since = as_of.clone();
244        let mut remap_trace = Vec::new();
245
246        // A stash of source updates for which we don't know the corresponding binding yet.
247        let mut deferred_source_updates: Vec<ChainBatch<_, _, _>> = Vec::new();
248        // The frontier of the `events` input
249        let mut source_frontier = MutableAntichain::from_elem(FromTime::minimum());
250
251        let mut binding_buffer = Vec::new();
252
253        // Accumulation buffer for `remap_input` updates.
254        use timely::progress::ChangeBatch;
255        let mut remap_accum_buffer: ChangeBatch<(IntoTime, FromTime)> = ChangeBatch::new();
256
257        // The operator drains `remap_input` and organizes new bindings that are not beyond
258        // `remap_input`'s frontier into the time ordered `remap_trace`.
259        //
260        // All received data events can either be reclocked to a time included in the
261        // `remap_trace`, or deferred until new associations are minted. Each data event that
262        // happens at some `FromTime` is mapped to the first `IntoTime` whose associated antichain
263        // is not less or equal to the input `FromTime`.
264        //
265        // As progress events are received from the `events` input, we can advance our
266        // held capability to track the least `IntoTime` a newly received `FromTime` could possibly
267        // map to and also compact the maintained `remap_trace` to that time.
268        move |frontiers| {
269            let Some(cap) = capset.get(0).cloned() else {
270                return;
271            };
272            let mut output = output.activate();
273            let mut session = output.session(&cap);
274
275            // STEP 1. Accept new bindings into `pending_remap`.
276            // Advance all `into` times by `as_of`, and consolidate all updates at that frontier.
277            remap_input.for_each(|_, data| {
278                for (from, mut into, diff) in data.drain(..) {
279                    into.advance_by(as_of.borrow());
280                    remap_accum_buffer.update((into, from), diff.into_inner());
281                }
282            });
283            // Drain consolidated bindings into the `pending_remap` heap.
284            // Only do this once any of the `remap_input` frontier has passed `as_of`.
285            // For as long as the input frontier is less-equal `as_of`, we have no finalized times.
286            if !PartialOrder::less_equal(&frontiers[0].frontier(), &as_of.borrow()) {
287                for ((into, from), diff) in remap_accum_buffer.drain() {
288                    pending_remap.push(Reverse((into, from, diff)));
289                }
290            }
291
292            // STEP 2. Extract bindings not beyond `remap_frontier` and commit them into `remap_trace`.
293            let prev_remap_upper =
294                std::mem::replace(&mut remap_upper, frontiers[0].frontier().to_owned());
295            while let Some(update) = pending_remap.peek_mut() {
296                if !remap_upper.less_equal(&update.0.0) {
297                    let Reverse((into, from, diff)) = PeekMut::pop(update);
298                    remap_trace.push((from, into, diff));
299                } else {
300                    break;
301                }
302            }
303
304            // STEP 3. Receive new data updates
305            //         The `events` input describes arbitrary progress and data over `FromTime`,
306            //         which must be translated to `IntoTime`. Each `FromTime` can be found as the
307            //         first `IntoTime` associated with a `[FromTime]` that is not less or equal to
308            //         the input `FromTime`. Received events that are not yet associated to an
309            //         `IntoTime` are collected, and formed into a "chain batch": a sequence of
310            //         chains that results from sorting the updates by `FromTime`, and then
311            //         segmenting the sequence at elements where the partial order on `FromTime` is
312            //         violated.
313            let mut stash = Vec::new();
314            // Consolidate progress updates before applying them to `source_frontier`, to avoid quadratic
315            // behavior in overload scenarios.
316            let mut change_batch = ChangeBatch::<FromTime, 2>::default();
317            while let Some(event) = events.pull() {
318                match event {
319                    Event::Progress(changes) => {
320                        change_batch.extend(changes.drain(..));
321                    }
322                    Event::Messages(_, data) => stash.append(data),
323                }
324            }
325            source_frontier.update_iter(change_batch.drain());
326            stash.sort_unstable_by(|(_, t1, _): &(D, FromTime, R), (_, t2, _)| t1.cmp(t2));
327            let mut new_source_updates = ChainBatch::from_iter(stash);
328
329            // STEP 4: Reclock new and deferred updates
330            //         We are now ready to step through the remap bindings in time order and
331            //         perform the following actions:
332            //         4.1. Match `new_source_updates` against the entirety of bindings contained
333            //              in the trace.
334            //         4.2. Match `deferred_source_updates` against the bindings that were just
335            //              added in the trace.
336            //         4.3. Reclock `source_frontier` to calculate the new since frontier of the
337            //              remap trace.
338            //
339            //         The steps above only make sense to perform if there are any times for which
340            //         we can correctly accumulate the remap trace, which is what we check here.
341            if remap_since.iter().all(|t| !remap_upper.less_equal(t)) {
342                let mut cur_binding = MutableAntichain::new();
343
344                let mut remap = remap_trace.iter().peekable();
345                let mut reclocked_source_frontier = remap_upper.clone();
346
347                // We go over all the times for which we might need to output data at. These times
348                // are restrticted to the times at which there exists an update in `remap_trace`
349                // and the minimum timestamp for the case where `remap_trace` is completely empty,
350                // in which case the minimum timestamp maps to the empty `FromTime` frontier and
351                // therefore all data events map to that minimum timestamp.
352                //
353                // The approach taken here will take time proportional to the number of elements in
354                // `remap_trace`. During development an alternative approach was considered where
355                // the updates in `remap_trace` are instead fully materialized into an ordered list
356                // of antichains in which every data update can be binary searched into. The are
357                // two concerns with this alternative approach that led to preferring this one:
358                // 1. Materializing very wide antichains with small differences between them
359                //    needs memory proportial to the number of bindings times the width of the
360                //    antichain.
361                // 2. It locks in the requirement of a totally ordered target timestamp since only
362                //    in that case can one binary search a binding.
363                // The linear scan is expected to be fine due to the run-to-completion nature of
364                // the operator since its cost is amortized among the number of outstanding
365                // updates.
366                let mut min_time = IntoTime::minimum();
367                min_time.advance_by(remap_since.borrow());
368                let mut prev_cur_time = None;
369                let mut interesting_times = std::iter::once(&min_time)
370                    .chain(remap_trace.iter().map(|(_, t, _)| t))
371                    .filter(|&v| {
372                        let prev = prev_cur_time.replace(v);
373                        prev != prev_cur_time
374                    });
375                let mut frontier_reclocked = false;
376                while !(new_source_updates.is_empty()
377                    && deferred_source_updates.is_empty()
378                    && frontier_reclocked)
379                    && let Some(cur_time) = interesting_times.next()
380                {
381                    // 4.0. Load updates of `cur_time` from the trace into `cur_binding` to
382                    //      construct the `[FromTime]` frontier that `cur_time` maps to.
383                    while let Some((t_from, _, diff)) = remap.next_if(|(_, t, _)| t == cur_time) {
384                        binding_buffer.push((t_from.clone(), *diff));
385                    }
386                    cur_binding.update_iter(binding_buffer.drain(..));
387                    let cur_binding = cur_binding.frontier();
388
389                    // 4.1. Extract updates from `new_source_updates`
390                    for (data, _, diff) in new_source_updates.extract(cur_binding) {
391                        session.give((data, cur_time.clone(), diff));
392                    }
393
394                    // 4.2. Extract updates from `deferred_source_updates`.
395                    //      The deferred updates contain all updates that were not able to be
396                    //      reclocked with the bindings until `prev_remap_upper`. For this reason
397                    //      we only need to reconsider these updates when we start looking at new
398                    //      bindings, i.e bindings that are beyond `prev_remap_upper`.
399                    if prev_remap_upper.less_equal(cur_time) {
400                        deferred_source_updates.retain_mut(|batch| {
401                            for (data, _, diff) in batch.extract(cur_binding) {
402                                session.give((data, cur_time.clone(), diff));
403                            }
404                            // Retain non-empty batches
405                            !batch.is_empty()
406                        })
407                    }
408
409                    // 4.3. Reclock `source_frontier`
410                    //      If any FromTime in source frontier could possibly be reclocked to this
411                    //      binding then we must maintain our capability to emit data at that time
412                    //      and not compact past it. Since we iterate over this loop in time order
413                    //      and IntoTime is a total order we only need to perform this step once.
414                    //      Once a `cur_time` is inserted into `reclocked_source_frontier` no more
415                    //      changes can be made to the frontier by inserting times later in the
416                    //      loop.
417                    if !frontier_reclocked
418                        && source_frontier
419                            .frontier()
420                            .iter()
421                            .any(|t| !cur_binding.less_equal(t))
422                    {
423                        reclocked_source_frontier.insert(cur_time.clone());
424                        frontier_reclocked = true;
425                    }
426                }
427
428                // STEP 5. Downgrade capability and compact remap trace
429                capset.downgrade(&reclocked_source_frontier.borrow());
430                remap_since = reclocked_source_frontier;
431                for (_, t, _) in remap_trace.iter_mut() {
432                    t.advance_by(remap_since.borrow());
433                }
434                consolidation::consolidate_updates(&mut remap_trace);
435                remap_trace
436                    .sort_unstable_by(|(_, t1, _): &(_, IntoTime, _), (_, t2, _)| t1.cmp(t2));
437
438                // If using less than a quarter of the capacity, shrink the container. To avoid having
439                // to resize the container on a subsequent push, shrink to 2x the length, which is
440                // what push would grow it to.
441                if remap_trace.len() < remap_trace.capacity() / 4 {
442                    remap_trace.shrink_to(remap_trace.len() * 2);
443                }
444            }
445
446            // STEP 6. Tidy up deferred updates
447            //         Deferred updates are represented as a list of chain batches where each batch
448            //         contains two times the updates of the batch proceeding it. This organization
449            //         leads to a logarithmic number of batches with respect to the outstanding
450            //         number of updates.
451            deferred_source_updates.sort_unstable_by_key(|b| Reverse(b.len()));
452            if !new_source_updates.is_empty() {
453                deferred_source_updates.push(new_source_updates);
454            }
455            let dsu = &mut deferred_source_updates;
456            while dsu.len() > 1 && (dsu[dsu.len() - 1].len() >= dsu[dsu.len() - 2].len() / 2) {
457                let a = dsu.pop().unwrap();
458                let b = dsu.pop().unwrap();
459                dsu.push(a.merge_with(b));
460            }
461
462            // If using less than a quarter of the capacity, shrink the container. To avoid having
463            // to resize the container on a subsequent push, shrink to 2x the length, which is
464            // what push would grow it to.
465            if deferred_source_updates.len() < deferred_source_updates.capacity() / 4 {
466                deferred_source_updates.shrink_to(deferred_source_updates.len() * 2);
467            }
468        }
469    });
470
471    (Box::new(pusher), reclocked.as_collection())
472}
473
474/// A batch of differential updates that vary over some partial order. This type maintains the data
475/// as a set of chains that allows for efficient extraction of batches given a frontier.
476#[derive(Debug, PartialEq)]
477struct ChainBatch<D, T, R> {
478    /// A list of chains (sets of mutually comparable times) sorted by the partial order.
479    chains: Vec<VecDeque<(D, T, R)>>,
480}
481
482impl<D, T: Timestamp, R> ChainBatch<D, T, R> {
483    /// Extracts all updates with time not greater or equal to any time in `upper`.
484    fn extract<'a>(
485        &'a mut self,
486        upper: AntichainRef<'a, T>,
487    ) -> impl Iterator<Item = (D, T, R)> + 'a {
488        self.chains.retain(|chain| !chain.is_empty());
489        self.chains.iter_mut().flat_map(move |chain| {
490            // A chain is a sorted list of mutually comparable elements so we keep extracting
491            // elements that are not beyond upper.
492            std::iter::from_fn(move || {
493                let (_, into, _) = chain.front()?;
494                if !upper.less_equal(into) {
495                    chain.pop_front()
496                } else {
497                    None
498                }
499            })
500        })
501    }
502
503    fn merge_with(
504        mut self: ChainBatch<D, T, R>,
505        mut other: ChainBatch<D, T, R>,
506    ) -> ChainBatch<D, T, R>
507    where
508        D: ExchangeData,
509        T: Timestamp,
510        R: Semigroup,
511    {
512        let mut updates1 = self.chains.drain(..).flatten().peekable();
513        let mut updates2 = other.chains.drain(..).flatten().peekable();
514
515        let merged = std::iter::from_fn(|| {
516            match (updates1.peek(), updates2.peek()) {
517                (Some((d1, t1, _)), Some((d2, t2, _))) => {
518                    match (t1, d1).cmp(&(t2, d2)) {
519                        Ordering::Less => updates1.next(),
520                        Ordering::Greater => updates2.next(),
521                        // If the same (d, t) pair is found, consolidate their diffs
522                        Ordering::Equal => {
523                            let (d1, t1, mut r1) = updates1.next().unwrap();
524                            while let Some((_, _, r)) =
525                                updates1.next_if(|(d, t, _)| (d, t) == (&d1, &t1))
526                            {
527                                r1.plus_equals(&r);
528                            }
529                            while let Some((_, _, r)) =
530                                updates2.next_if(|(d, t, _)| (d, t) == (&d1, &t1))
531                            {
532                                r1.plus_equals(&r);
533                            }
534                            Some((d1, t1, r1))
535                        }
536                    }
537                }
538                (Some(_), None) => updates1.next(),
539                (None, Some(_)) => updates2.next(),
540                (None, None) => None,
541            }
542        });
543
544        ChainBatch::from_iter(merged.filter(|(_, _, r)| !r.is_zero()))
545    }
546
547    /// Returns the number of updates in the batch.
548    fn len(&self) -> usize {
549        self.chains.iter().map(|chain| chain.len()).sum()
550    }
551
552    /// Returns true if the batch contains no updates.
553    fn is_empty(&self) -> bool {
554        self.len() == 0
555    }
556}
557
558impl<D, T: Timestamp, R> FromIterator<(D, T, R)> for ChainBatch<D, T, R> {
559    /// Computes the chain decomposition of updates according to the partial order `T`.
560    fn from_iter<I: IntoIterator<Item = (D, T, R)>>(updates: I) -> Self {
561        let mut chains = vec![];
562        let mut updates = updates.into_iter();
563        if let Some((d, t, r)) = updates.next() {
564            let mut chain = VecDeque::new();
565            chain.push_back((d, t, r));
566            for (d, t, r) in updates {
567                let prev_t = &chain[chain.len() - 1].1;
568                if !PartialOrder::less_equal(prev_t, &t) {
569                    chains.push(chain);
570                    chain = VecDeque::new();
571                }
572                chain.push_back((d, t, r));
573            }
574            chains.push(chain);
575        }
576        Self { chains }
577    }
578}
579
580#[cfg(test)]
581mod test {
582    use std::sync::atomic::AtomicUsize;
583    use std::sync::mpsc::{Receiver, TryRecvError};
584
585    use differential_dataflow::consolidation;
586    use differential_dataflow::input::{Input, InputSession};
587    use serde::{Deserialize, Serialize};
588    use timely::dataflow::operators::capture::{Event, Extract};
589    use timely::dataflow::operators::vec::UnorderedInput;
590    use timely::dataflow::operators::vec::unordered_input::UnorderedHandle;
591    use timely::dataflow::operators::{ActivateCapability, Capture};
592    use timely::progress::PathSummary;
593    use timely::progress::timestamp::Refines;
594    use timely::worker::Worker;
595
596    use crate::capture::PusherCapture;
597    use crate::order::Partitioned;
598
599    use super::*;
600
601    type Diff = Overflowing<i64>;
602    type FromTime = Partitioned<u64, u64>;
603    type IntoTime = u64;
604    type BindingHandle<FromTime> = InputSession<IntoTime, FromTime, Diff>;
605    type DataHandle<D, FromTime> = (
606        UnorderedHandle<FromTime, (D, FromTime, Diff)>,
607        ActivateCapability<FromTime>,
608    );
609    type ReclockedStream<D> = Receiver<Event<IntoTime, Vec<(D, IntoTime, Diff)>>>;
610
611    /// A helper function that sets up a dataflow program to test the reclocking operator. Each
612    /// test provides a test logic closure which accepts four arguments:
613    ///
614    /// * A reference to the worker that allows the test to step the computation
615    /// * A [`BindingHandle`] that allows the test to manipulate the remap bindings
616    /// * A [`DataHandle`] that allows the test to submit the data to be reclocked
617    /// * A [`ReclockedStream`] that allows observing the result of the reclocking process
618    ///
619    /// Note that the `DataHandle` contains a capability that should be dropped or downgraded before
620    /// calling [`step`] to process data at the time.
621    fn harness<FromTime, D, F, R>(as_of: Antichain<IntoTime>, test_logic: F) -> R
622    where
623        FromTime: Timestamp + Refines<()>,
624        D: ExchangeData,
625        F: FnOnce(
626                &mut Worker,
627                BindingHandle<FromTime>,
628                DataHandle<D, FromTime>,
629                ReclockedStream<D>,
630            ) -> R
631            + Send
632            + Sync
633            + 'static,
634        R: Send + 'static,
635    {
636        timely::execute_directly(move |worker| {
637            let (bindings, data, data_cap, reclocked) = worker.dataflow::<(), _, _>(|scope| {
638                let (bindings, data_pusher, reclocked) =
639                    scope.scoped::<IntoTime, _, _>("IntoScope", move |scope| {
640                        let (binding_handle, binding_collection) = scope.new_collection();
641                        let (data_pusher, reclocked_collection) =
642                            reclock(binding_collection, as_of);
643                        let reclocked_capture = reclocked_collection.inner.capture();
644                        (binding_handle, data_pusher, reclocked_capture)
645                    });
646
647                let (data, data_cap) = scope.scoped::<FromTime, _, _>("FromScope", move |scope| {
648                    let ((handle, cap), data) = scope.new_unordered_input::<(D, FromTime, Diff)>();
649                    data.capture_into(PusherCapture(data_pusher));
650                    (handle, cap)
651                });
652
653                (bindings, data, data_cap, reclocked)
654            });
655
656            test_logic(worker, bindings, (data, data_cap), reclocked)
657        })
658    }
659
660    /// Steps the worker four times which is the required number of times for both data and
661    /// frontier updates to propagate across the two scopes and into the probing channels.
662    fn step(worker: &mut Worker) {
663        for _ in 0..4 {
664            worker.step();
665        }
666    }
667
668    #[mz_ore::test]
669    fn basic_reclocking() {
670        let as_of = Antichain::from_elem(IntoTime::minimum());
671        harness::<FromTime, _, _, _>(
672            as_of,
673            |worker, bindings, (mut data, data_cap), reclocked| {
674                // Reclock everything at the minimum IntoTime
675                bindings.close();
676                data.activate()
677                    .session(&data_cap)
678                    .give(('a', Partitioned::minimum(), Diff::ONE));
679                drop(data_cap);
680                step(worker);
681                let extracted = reclocked.extract();
682                let expected = vec![(0, vec![('a', 0, Diff::ONE)])];
683                assert_eq!(extracted, expected);
684            },
685        )
686    }
687
688    /// Generates a `Partitioned<u64, u64>` Antichain where all the provided
689    /// partitions are at the specified offset and the gaps in between are filled with range
690    /// timestamps at offset zero.
691    fn partitioned_frontier<I>(items: I) -> Antichain<Partitioned<u64, u64>>
692    where
693        I: IntoIterator<Item = (u64, u64)>,
694    {
695        let mut frontier = Antichain::new();
696        let mut prev = 0;
697        for (pid, offset) in items {
698            if prev < pid {
699                frontier.insert(Partitioned::new_range(prev, pid - 1, 0));
700            }
701            frontier.insert(Partitioned::new_singleton(pid, offset));
702            prev = pid + 1
703        }
704        frontier.insert(Partitioned::new_range(prev, u64::MAX, 0));
705        frontier
706    }
707
708    #[mz_ore::test]
709    fn test_basic_usage() {
710        let as_of = Antichain::from_elem(IntoTime::minimum());
711        harness(
712            as_of,
713            |worker, mut bindings, (mut data, data_cap), reclocked| {
714                // Reclock offsets 1 and 3 to timestamp 1000
715                bindings.update_at(Partitioned::minimum(), 0, Diff::ONE);
716                bindings.update_at(Partitioned::minimum(), 1000, Diff::MINUS_ONE);
717                for time in partitioned_frontier([(0, 4)]) {
718                    bindings.update_at(time, 1000, Diff::ONE);
719                }
720                bindings.advance_to(1001);
721                bindings.flush();
722                data.activate().session(&data_cap).give_iterator(
723                    vec![
724                        (1, Partitioned::new_singleton(0, 1), Diff::ONE),
725                        (1, Partitioned::new_singleton(0, 1), Diff::ONE),
726                        (3, Partitioned::new_singleton(0, 3), Diff::ONE),
727                    ]
728                    .into_iter(),
729                );
730
731                step(worker);
732                assert_eq!(
733                    reclocked.try_recv(),
734                    Ok(Event::Messages(
735                        0u64,
736                        vec![
737                            (1, 1000, Diff::ONE),
738                            (1, 1000, Diff::ONE),
739                            (3, 1000, Diff::ONE)
740                        ]
741                    ))
742                );
743                assert_eq!(
744                    reclocked.try_recv(),
745                    Ok(Event::Progress(vec![(0, -1), (1000, 1)]))
746                );
747
748                // Reclock more messages for offsets 3 to the same timestamp
749                data.activate().session(&data_cap).give_iterator(
750                    vec![
751                        (3, Partitioned::new_singleton(0, 3), Diff::ONE),
752                        (3, Partitioned::new_singleton(0, 3), Diff::ONE),
753                    ]
754                    .into_iter(),
755                );
756                step(worker);
757                assert_eq!(
758                    reclocked.try_recv(),
759                    Ok(Event::Messages(
760                        1000u64,
761                        vec![(3, 1000, Diff::ONE), (3, 1000, Diff::ONE)]
762                    ))
763                );
764
765                // Drop the capability which should advance the reclocked frontier to 1001.
766                drop(data_cap);
767                step(worker);
768                assert_eq!(
769                    reclocked.try_recv(),
770                    Ok(Event::Progress(vec![(1000, -1), (1001, 1)]))
771                );
772            },
773        );
774    }
775
776    #[mz_ore::test]
777    fn test_reclock_frontier() {
778        let as_of = Antichain::from_elem(IntoTime::minimum());
779        harness::<_, (), _, _>(
780            as_of,
781            |worker, mut bindings, (_data, data_cap), reclocked| {
782                // Initialize the bindings such that the minimum IntoTime contains the minimum FromTime
783                // frontier.
784                bindings.update_at(Partitioned::minimum(), 0, Diff::ONE);
785                bindings.advance_to(1);
786                bindings.flush();
787                step(worker);
788                assert_eq!(
789                    reclocked.try_recv(),
790                    Ok(Event::Progress(vec![(0, -1), (1, 1)]))
791                );
792
793                // Mint a couple of bindings for multiple partitions
794                bindings.update_at(Partitioned::minimum(), 1000, Diff::MINUS_ONE);
795                for time in partitioned_frontier([(1, 10)]) {
796                    bindings.update_at(time.clone(), 1000, Diff::ONE);
797                    bindings.update_at(time, 2000, Diff::MINUS_ONE);
798                }
799                for time in partitioned_frontier([(1, 10), (2, 10)]) {
800                    bindings.update_at(time, 2000, Diff::ONE);
801                }
802                bindings.advance_to(2001);
803                bindings.flush();
804
805                // The initial frontier should now map to the minimum between the two partitions
806                step(worker);
807                step(worker);
808                assert_eq!(
809                    reclocked.try_recv(),
810                    Ok(Event::Progress(vec![(1, -1), (1000, 1)]))
811                );
812
813                // Downgrade data frontier such that only one of the partitions is advanced
814                let mut part1_cap = data_cap.delayed(&Partitioned::new_singleton(1, 9));
815                let mut part2_cap = data_cap.delayed(&Partitioned::new_singleton(2, 0));
816                let _rest_cap = data_cap.delayed(&Partitioned::new_range(3, u64::MAX, 0));
817                drop(data_cap);
818                step(worker);
819                assert_eq!(reclocked.try_recv(), Err(TryRecvError::Empty));
820
821                // Downgrade the data frontier past the first binding
822                part1_cap.downgrade(&Partitioned::new_singleton(1, 10));
823                step(worker);
824                assert_eq!(
825                    reclocked.try_recv(),
826                    Ok(Event::Progress(vec![(1000, -1), (2000, 1)]))
827                );
828
829                // Downgrade the data frontier past the second binding
830                part2_cap.downgrade(&Partitioned::new_singleton(2, 10));
831                step(worker);
832                assert_eq!(
833                    reclocked.try_recv(),
834                    Ok(Event::Progress(vec![(2000, -1), (2001, 1)]))
835                );
836
837                // Advance the binding frontier and confirm that we get to the next timestamp
838                bindings.advance_to(3001);
839                bindings.flush();
840                step(worker);
841                assert_eq!(
842                    reclocked.try_recv(),
843                    Ok(Event::Progress(vec![(2001, -1), (3001, 1)]))
844                );
845            },
846        );
847    }
848
849    #[mz_ore::test]
850    fn test_reclock() {
851        let as_of = Antichain::from_elem(IntoTime::minimum());
852        harness(
853            as_of,
854            |worker, mut bindings, (mut data, data_cap), reclocked| {
855                // Initialize the bindings such that the minimum IntoTime contains the minimum FromTime
856                // frontier.
857                bindings.update_at(Partitioned::minimum(), 0, Diff::ONE);
858
859                // Setup more precise capabilities for the rest of the test
860                let mut part0_cap = data_cap.delayed(&Partitioned::new_singleton(0, 0));
861                let rest_cap = data_cap.delayed(&Partitioned::new_range(1, u64::MAX, 0));
862                drop(data_cap);
863
864                // Reclock offsets 1 and 2 to timestamp 1000
865                data.activate().session(&part0_cap).give_iterator(
866                    vec![
867                        (1, Partitioned::new_singleton(0, 1), Diff::ONE),
868                        (2, Partitioned::new_singleton(0, 2), Diff::ONE),
869                    ]
870                    .into_iter(),
871                );
872
873                part0_cap.downgrade(&Partitioned::new_singleton(0, 3));
874                bindings.update_at(Partitioned::minimum(), 1000, Diff::MINUS_ONE);
875                bindings.update_at(part0_cap.time().clone(), 1000, Diff::ONE);
876                bindings.update_at(rest_cap.time().clone(), 1000, Diff::ONE);
877                bindings.advance_to(1001);
878                bindings.flush();
879                step(worker);
880                assert_eq!(
881                    reclocked.try_recv(),
882                    Ok(Event::Messages(
883                        0,
884                        vec![(1, 1000, Diff::ONE), (2, 1000, Diff::ONE)]
885                    ))
886                );
887                assert_eq!(
888                    reclocked.try_recv(),
889                    Ok(Event::Progress(vec![(0, -1), (1000, 1)]))
890                );
891                assert_eq!(
892                    reclocked.try_recv(),
893                    Ok(Event::Progress(vec![(1000, -1), (1001, 1)]))
894                );
895
896                // Reclock offsets 3 and 4 to timestamp 2000
897                data.activate().session(&part0_cap).give_iterator(
898                    vec![
899                        (3, Partitioned::new_singleton(0, 3), Diff::ONE),
900                        (3, Partitioned::new_singleton(0, 3), Diff::ONE),
901                        (4, Partitioned::new_singleton(0, 4), Diff::ONE),
902                    ]
903                    .into_iter(),
904                );
905                bindings.update_at(part0_cap.time().clone(), 2000, Diff::MINUS_ONE);
906                part0_cap.downgrade(&Partitioned::new_singleton(0, 5));
907                bindings.update_at(part0_cap.time().clone(), 2000, Diff::ONE);
908                bindings.advance_to(2001);
909                bindings.flush();
910                step(worker);
911                assert_eq!(
912                    reclocked.try_recv(),
913                    Ok(Event::Messages(
914                        1001,
915                        vec![
916                            (3, 2000, Diff::ONE),
917                            (3, 2000, Diff::ONE),
918                            (4, 2000, Diff::ONE)
919                        ]
920                    ))
921                );
922                assert_eq!(
923                    reclocked.try_recv(),
924                    Ok(Event::Progress(vec![(1001, -1), (2000, 1)]))
925                );
926                assert_eq!(
927                    reclocked.try_recv(),
928                    Ok(Event::Progress(vec![(2000, -1), (2001, 1)]))
929                );
930            },
931        );
932    }
933
934    #[mz_ore::test]
935    fn test_reclock_gh16318() {
936        let as_of = Antichain::from_elem(IntoTime::minimum());
937        harness(
938            as_of,
939            |worker, mut bindings, (mut data, data_cap), reclocked| {
940                // Initialize the bindings such that the minimum IntoTime contains the minimum FromTime
941                // frontier.
942                bindings.update_at(Partitioned::minimum(), 0, Diff::ONE);
943                // First mint bindings for 0 at timestamp 1000
944                bindings.update_at(Partitioned::minimum(), 1000, Diff::MINUS_ONE);
945                for time in partitioned_frontier([(0, 50)]) {
946                    bindings.update_at(time, 1000, Diff::ONE);
947                }
948                // Then only for 1 at timestamp 2000
949                for time in partitioned_frontier([(0, 50)]) {
950                    bindings.update_at(time, 2000, Diff::MINUS_ONE);
951                }
952                for time in partitioned_frontier([(0, 50), (1, 50)]) {
953                    bindings.update_at(time, 2000, Diff::ONE);
954                }
955                // Then again only for 0 at timestamp 3000
956                for time in partitioned_frontier([(0, 50), (1, 50)]) {
957                    bindings.update_at(time, 3000, Diff::MINUS_ONE);
958                }
959                for time in partitioned_frontier([(0, 100), (1, 50)]) {
960                    bindings.update_at(time, 3000, Diff::ONE);
961                }
962                bindings.advance_to(3001);
963                bindings.flush();
964
965                // Reclockng (0, 50) must ignore the updates on the FromTime frontier that happened at
966                // timestamp 2000 since those are completely unrelated
967                data.activate().session(&data_cap).give((
968                    50,
969                    Partitioned::new_singleton(0, 50),
970                    Diff::ONE,
971                ));
972                drop(data_cap);
973                step(worker);
974                assert_eq!(
975                    reclocked.try_recv(),
976                    Ok(Event::Messages(0, vec![(50, 3000, Diff::ONE),]))
977                );
978                assert_eq!(
979                    reclocked.try_recv(),
980                    Ok(Event::Progress(vec![(0, -1), (1000, 1)]))
981                );
982                assert_eq!(
983                    reclocked.try_recv(),
984                    Ok(Event::Progress(vec![(1000, -1), (3001, 1)]))
985                );
986            },
987        );
988    }
989
990    /// Test that compact(reclock(remap, source)) == reclock(compact(remap), source)
991    #[mz_ore::test]
992    fn test_compaction() {
993        let mut remap = vec![];
994        remap.push((Partitioned::minimum(), 0, Diff::ONE));
995        // Reclock offsets 1 and 2 to timestamp 1000
996        remap.push((Partitioned::minimum(), 1000, Diff::MINUS_ONE));
997        for time in partitioned_frontier([(0, 3)]) {
998            remap.push((time, 1000, Diff::ONE));
999        }
1000        // Reclock offsets 3 and 4 to timestamp 2000
1001        for time in partitioned_frontier([(0, 3)]) {
1002            remap.push((time, 2000, Diff::MINUS_ONE));
1003        }
1004        for time in partitioned_frontier([(0, 5)]) {
1005            remap.push((time, 2000, Diff::ONE));
1006        }
1007
1008        let source_updates = vec![
1009            (1, Partitioned::new_singleton(0, 1), Diff::ONE),
1010            (2, Partitioned::new_singleton(0, 2), Diff::ONE),
1011            (3, Partitioned::new_singleton(0, 3), Diff::ONE),
1012            (4, Partitioned::new_singleton(0, 4), Diff::ONE),
1013        ];
1014
1015        let since = Antichain::from_elem(1500);
1016
1017        // Compute reclock(remap, source)
1018        let as_of = Antichain::from_elem(IntoTime::minimum());
1019        let remap1 = remap.clone();
1020        let source_updates1 = source_updates.clone();
1021        let reclock_remap = harness(
1022            as_of,
1023            move |worker, mut bindings, (mut data, data_cap), reclocked| {
1024                for (from_ts, into_ts, diff) in remap1 {
1025                    bindings.update_at(from_ts, into_ts, diff);
1026                }
1027                bindings.close();
1028                data.activate()
1029                    .session(&data_cap)
1030                    .give_iterator(source_updates1.iter().cloned());
1031                drop(data_cap);
1032                step(worker);
1033                reclocked.extract()
1034            },
1035        );
1036        // Compute compact(reclock(remap, source))
1037        let mut compact_reclock_remap = reclock_remap;
1038        for (t, updates) in compact_reclock_remap.iter_mut() {
1039            t.advance_by(since.borrow());
1040            for (_, t, _) in updates.iter_mut() {
1041                t.advance_by(since.borrow());
1042            }
1043        }
1044
1045        // Compute compact(remap)
1046        let mut compact_remap = remap;
1047        for (_, t, _) in compact_remap.iter_mut() {
1048            t.advance_by(since.borrow());
1049        }
1050        consolidation::consolidate_updates(&mut compact_remap);
1051        // Compute reclock(compact(remap), source)
1052        let reclock_compact_remap = harness(
1053            since,
1054            move |worker, mut bindings, (mut data, data_cap), reclocked| {
1055                for (from_ts, into_ts, diff) in compact_remap {
1056                    bindings.update_at(from_ts, into_ts, diff);
1057                }
1058                bindings.close();
1059                data.activate()
1060                    .session(&data_cap)
1061                    .give_iterator(source_updates.iter().cloned());
1062                drop(data_cap);
1063                step(worker);
1064                reclocked.extract()
1065            },
1066        );
1067
1068        let expected = vec![(
1069            1500,
1070            vec![
1071                (1, 1500, Diff::ONE),
1072                (2, 1500, Diff::ONE),
1073                (3, 2000, Diff::ONE),
1074                (4, 2000, Diff::ONE),
1075            ],
1076        )];
1077        assert_eq!(expected, reclock_compact_remap);
1078        assert_eq!(expected, compact_reclock_remap);
1079    }
1080
1081    #[mz_ore::test]
1082    fn test_chainbatch_merge() {
1083        let a = ChainBatch::from_iter([('a', 0, 1)]);
1084        let b = ChainBatch::from_iter([('a', 0, -1), ('a', 1, 1)]);
1085        assert_eq!(a.merge_with(b), ChainBatch::from_iter([('a', 1, 1)]));
1086    }
1087
1088    #[mz_ore::test]
1089    #[cfg_attr(miri, ignore)] // too slow
1090    fn test_binding_consolidation() {
1091        use std::sync::atomic::Ordering;
1092
1093        #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
1094        struct Time(u64);
1095
1096        // A counter of the number of active Time instances
1097        static INSTANCES: AtomicUsize = AtomicUsize::new(0);
1098
1099        impl Time {
1100            fn new(time: u64) -> Self {
1101                INSTANCES.fetch_add(1, Ordering::Relaxed);
1102                Self(time)
1103            }
1104        }
1105
1106        impl Clone for Time {
1107            fn clone(&self) -> Self {
1108                INSTANCES.fetch_add(1, Ordering::Relaxed);
1109                Self(self.0)
1110            }
1111        }
1112
1113        impl Drop for Time {
1114            fn drop(&mut self) {
1115                INSTANCES.fetch_sub(1, Ordering::Relaxed);
1116            }
1117        }
1118
1119        impl Timestamp for Time {
1120            type Summary = ();
1121
1122            fn minimum() -> Self {
1123                Time::new(0)
1124            }
1125        }
1126
1127        impl PathSummary<Time> for () {
1128            fn results_in(&self, src: &Time) -> Option<Time> {
1129                Some(src.clone())
1130            }
1131
1132            fn followed_by(&self, _other: &()) -> Option<Self> {
1133                Some(())
1134            }
1135        }
1136
1137        impl Refines<()> for Time {
1138            fn to_inner(_: ()) -> Self {
1139                Self::minimum()
1140            }
1141            fn to_outer(self) -> () {}
1142            fn summarize(_path: ()) {}
1143        }
1144
1145        impl PartialOrder for Time {
1146            fn less_equal(&self, other: &Self) -> bool {
1147                self.0.less_equal(&other.0)
1148            }
1149        }
1150
1151        let as_of = 1000;
1152
1153        // Test that supplying a single big batch of unconsolidated bindings gets
1154        // consolidated after a single worker step.
1155        harness::<Time, u64, _, _>(
1156            Antichain::from_elem(as_of),
1157            move |worker, mut bindings, _, _| {
1158                step(worker);
1159                let instances_before = INSTANCES.load(Ordering::Relaxed);
1160                for ts in 0..as_of {
1161                    if ts > 0 {
1162                        bindings.update_at(Time::new(ts - 1), ts, Diff::MINUS_ONE);
1163                    }
1164                    bindings.update_at(Time::new(ts), ts, Diff::ONE);
1165                }
1166                bindings.advance_to(as_of);
1167                bindings.flush();
1168                step(worker);
1169                let instances_after = INSTANCES.load(Ordering::Relaxed);
1170                // The extra instances live in a ChangeBatch which considers compaction when more
1171                // than 32 elements are inside.
1172                assert!(instances_after - instances_before < 32);
1173            },
1174        );
1175
1176        // Test that a slow feed of uncompacted bindings over multiple steps never leads to an
1177        // excessive number of bindings held in memory.
1178        harness::<Time, u64, _, _>(
1179            Antichain::from_elem(as_of),
1180            move |worker, mut bindings, _, _| {
1181                step(worker);
1182                let instances_before = INSTANCES.load(Ordering::Relaxed);
1183                for ts in 0..as_of {
1184                    if ts > 0 {
1185                        bindings.update_at(Time::new(ts - 1), ts, Diff::MINUS_ONE);
1186                    }
1187                    bindings.update_at(Time::new(ts), ts, Diff::ONE);
1188                    bindings.advance_to(ts + 1);
1189                    bindings.flush();
1190                    step(worker);
1191                    let instances_now = INSTANCES.load(Ordering::Relaxed);
1192                    // The extra instances live in a ChangeBatch which considers compaction when
1193                    // more than 32 elements are inside.
1194                    assert!(instances_now - instances_before < 32);
1195                }
1196            },
1197        );
1198    }
1199
1200    #[cfg(feature = "count-allocations")]
1201    #[mz_ore::test]
1202    #[cfg_attr(miri, ignore)] // too slow
1203    fn test_shrinking() {
1204        let as_of = 1000_u64;
1205
1206        // This workflow accumulates updates in remap_trace, advances the source frontier,
1207        // and validates that memory was reclaimed.  To avoid errant test failures due to
1208        // optimizations, this only validates that memory is reclaimed, not how much.
1209        harness::<FromTime, u64, _, _>(
1210            Antichain::from_elem(0),
1211            move |worker, mut bindings, (_data, mut data_cap), _| {
1212                let info1 = allocation_counter::measure(|| {
1213                    step(worker);
1214                    for ts in 0..as_of {
1215                        if ts > 0 {
1216                            bindings.update_at(
1217                                Partitioned::new_singleton(0, ts - 1),
1218                                ts,
1219                                Diff::MINUS_ONE,
1220                            );
1221                        }
1222                        bindings.update_at(Partitioned::new_singleton(0, ts), ts, Diff::ONE);
1223                        bindings.advance_to(ts + 1);
1224                        bindings.flush();
1225                        step(worker);
1226                    }
1227                });
1228                println!("info = {info1:?}");
1229
1230                let info2 = allocation_counter::measure(|| {
1231                    data_cap.downgrade(&Partitioned::new_singleton(0, as_of));
1232                    step(worker);
1233                });
1234                println!("info = {info2:?}");
1235                assert!(info2.bytes_current < 0);
1236            },
1237        );
1238    }
1239}