1use std::cell::RefCell;
15use std::collections::BTreeMap;
16use std::rc::Rc;
17
18use columnar::{Columnar, Index};
19use differential_dataflow::AsCollection;
20use differential_dataflow::hashable::Hashable;
21use differential_dataflow::lattice::Lattice;
22use differential_dataflow::operators::arrange::{Arranged, TraceAgent};
23use differential_dataflow::operators::iterate::Variable as SemigroupVariable;
24use differential_dataflow::trace::cursor::{BatchCursor, BatchValOwn};
25use differential_dataflow::trace::{Builder, Cursor, Navigable, Trace};
26use differential_dataflow::{Data, VecCollection};
27use mz_compute_types::dyncfgs::TEMPORAL_BUCKETING_SUMMARY;
28use mz_compute_types::plan::ArrangementStrategy;
29use mz_compute_types::plan::scalar::LirScalarExpr;
30use mz_compute_types::plan::top_k::{
31 BasicTopKPlan, MonotonicTop1Plan, MonotonicTopKPlan, TopKPlan,
32};
33use mz_expr::func::CastUint64ToInt64;
34use mz_expr::{BinaryFunc, Columns, Eval, EvalError, UnaryFunc, func, permutation_for_arrangement};
35use mz_ore::cast::CastFrom;
36use mz_ore::soft_assert_or_log;
37use mz_repr::fixed_length::ExtendDatums;
38use mz_repr::{Datum, DatumVec, Diff, ReprScalarType, Row, SharedRow};
39use mz_row_spine::{
40 DatumContainer, DatumSeq, RowBatcher, RowRowBatcher, RowRowBuilder, RowValBuilder, RowValSpine,
41};
42use mz_timely_util::columnar::builder::ColumnBuilder;
43use mz_timely_util::operator::CollectionExt;
44use timely::Container;
45use timely::container::{CapacityContainerBuilder, PushInto};
46use timely::dataflow::channels::pact::Pipeline;
47use timely::dataflow::operators::generic::OutputBuilder;
48use timely::dataflow::operators::generic::builder_rc::OperatorBuilder;
49use timely::dataflow::operators::{CapabilitySet, Operator};
50use timely::progress::Stamp;
51
52use crate::extensions::arrange::{ArrangementSize, KeyCollection, MzArrange};
53use crate::extensions::reduce::{ClearContainer, MzReduce};
54use crate::render::Pairer;
55use crate::render::columnar::{ColCollection, flat_map_datums};
56use crate::render::context::{ArrangementFlavor, CollectionBundle, Context};
57use crate::render::errors::DataflowErrorSer;
58use crate::render::errors::MaybeValidatingRow;
59use crate::typedefs::ConsolidateBatcher;
60use crate::typedefs::{ErrBatcher, MzTimestamp, RowRowSpine, RowSpine};
61
62impl<'scope, T: crate::render::RenderTimestamp + crate::render::MaybeBucketByTime>
64 Context<'scope, T>
65{
66 pub(crate) fn render_topk(
67 &self,
68 input: CollectionBundle<'scope, T>,
69 top_k_plan: TopKPlan,
70 temporal_bucketing_strategy: ArrangementStrategy,
71 ) -> CollectionBundle<'scope, T> {
72 let (ok_input, err_input) = input
75 .collection
76 .clone()
77 .expect("The unarranged collection doesn't exist.");
78
79 if matches!(
89 temporal_bucketing_strategy,
90 ArrangementStrategy::TemporalBucketing
91 ) {
92 let must_consolidate = match &top_k_plan {
93 TopKPlan::MonotonicTop1(p) => p.must_consolidate,
94 TopKPlan::MonotonicTopK(p) => p.must_consolidate,
95 TopKPlan::Basic(_) => true,
96 };
97 soft_assert_or_log!(
98 must_consolidate,
99 "TopK with `TemporalBucketing` should not have `must_consolidate = false`",
100 );
101 }
102 let ok_input = if matches!(
103 temporal_bucketing_strategy,
104 ArrangementStrategy::TemporalBucketing
105 ) {
106 let summary: mz_repr::Timestamp = TEMPORAL_BUCKETING_SUMMARY
107 .get(&self.config_set)
108 .try_into()
109 .expect("must fit");
110 T::maybe_apply_temporal_bucketing(ok_input.inner, self.as_of_frontier.clone(), summary)
111 } else {
112 ok_input
113 };
114
115 let outer_scope = ok_input.scope();
117 let bundle = outer_scope.clone().region_named("TopK", |inner| {
118 let ok_input = ok_input.enter_region(inner);
119 let mut err_collection = err_input.enter_region(inner);
120
121 match top_k_plan.limit().map(|l| (l.as_literal(), l)) {
129 None => {}
130 Some((Some(Ok(literal)), _))
131 if literal == Datum::Null || literal.unwrap_int64() >= 0 => {}
132 Some((_, expr)) => {
133 let expr = expr.clone();
139 let (_, errors) = flat_map_datums::<
144 _,
145 CapacityContainerBuilder<Vec<(Row, T, Diff)>>,
146 _,
147 >(
148 ok_input.clone(),
149 "TopKLimitCheck",
150 usize::MAX,
151 {
152 let mut datum_vec = mz_repr::DatumVec::new();
153 move |row_datums, time, diff, _ok_session, err_session| {
154 let temp_storage = mz_repr::RowArena::new();
155 let mut datums = datum_vec.borrow();
159 datums.extend(row_datums.iter());
160 match expr.eval(&datums[..], &temp_storage) {
161 Ok(l) if l != Datum::Null && l.unwrap_int64() < 0 => {
162 err_session.give((EvalError::NegLimit.into(), time, diff));
163 1
164 }
165 Ok(_) => 0,
166 Err(e) => {
167 err_session.give((e.into(), time, diff));
168 1
169 }
170 }
171 }
172 },
173 );
174 err_collection = err_collection.concat(errors.as_collection());
175 }
176 }
177
178 let bundle = match top_k_plan {
179 TopKPlan::MonotonicTop1(MonotonicTop1Plan {
180 group_key,
181 order_key,
182 arity,
183 must_consolidate,
184 }) => {
185 let (arrangement, errs) = self.render_top1_monotonic(
186 ok_input,
187 group_key.clone(),
188 order_key,
189 arity,
190 must_consolidate,
191 );
192 err_collection = err_collection.concat(errs);
193
194 let errs: KeyCollection<_, _, _> = err_collection.clone().into();
200 let err_arrangement =
201 errs.mz_arrange::<ErrBatcher<_, _>, _>("Arrange bundle err");
202 CollectionBundle::from_columns(
203 group_key.iter().copied(),
204 ArrangementFlavor::Local(arrangement, err_arrangement),
205 )
206 }
207 TopKPlan::MonotonicTopK(MonotonicTopKPlan {
208 order_key,
209 group_key,
210 arity,
211 mut limit,
212 must_consolidate,
213 }) => {
214 if let Some(expr) = limit.as_mut() {
216 let mut map = BTreeMap::new();
217 for (index, column) in group_key.iter().enumerate() {
218 map.insert(*column, index);
219 }
220 expr.permute_map(&map);
221 }
222
223 let ok_scope = ok_input.scope();
225 let collection =
226 map_topk_key(ok_input, "MonotonicTopK input", move |datums, _row| {
227 SharedRow::pack(group_key.iter().map(|i| datums[*i]))
228 })
229 .consolidate_named_if::<ConsolidateBatcher<_, _, _>>(
230 must_consolidate,
231 "Consolidated MonotonicTopK input",
232 );
233
234 let error_logger = self.error_logger();
236 let (collection, errs) = collection.ensure_monotonic(move |data, diff| {
237 error_logger.log(
238 "Non-monotonic input to MonotonicTopK",
239 &format!("data={data:?}, diff={diff}"),
240 );
241 let m = "tried to build monotonic top-k on non-monotonic input".into();
242 (DataflowErrorSer::from(EvalError::Internal(m)), Diff::ONE)
243 });
244 err_collection = err_collection.concat(errs);
245
246 let collection = if let Some(limit) = limit.clone() {
252 render_intra_ts_thinning(collection, order_key.clone(), limit)
253 } else {
254 collection
255 };
256
257 let pairer = Pairer::new(1);
258 let collection = collection.map(move |(group_row, row)| {
259 let hash = row.hashed();
260 let hash_key = pairer.merge(std::iter::once(Datum::from(hash)), &group_row);
261 (hash_key, row)
262 });
263
264 let delay = std::time::Duration::from_secs(10);
273 let (retractions_var, retractions) = SemigroupVariable::new(
274 ok_scope,
275 <T as crate::render::RenderTimestamp>::system_delay(
276 delay.try_into().expect("must fit"),
277 ),
278 );
279 let thinned = collection.clone().concat(retractions.negate());
280
281 let (result, errs) =
287 self.build_topk_stage(thinned, order_key, 1u64, 0, limit, arity, false);
288 let result = CollectionExt::consolidate_named::<ConsolidateBatcher<_, _, _>>(
290 result,
291 "Monotonic TopK final consolidate",
292 );
293 retractions_var.set(collection.concat(result.clone().negate()));
294 soft_assert_or_log!(
295 errs.is_none(),
296 "requested no validation, but received error collection"
297 );
298
299 CollectionBundle::from_edge(topk_result_to_columnar(result), err_collection)
300 }
301 TopKPlan::Basic(BasicTopKPlan {
302 group_key,
303 order_key,
304 offset,
305 mut limit,
306 arity,
307 buckets,
308 }) => {
309 if let Some(expr) = limit.as_mut() {
311 let mut map = BTreeMap::new();
312 for (index, column) in group_key.iter().enumerate() {
313 map.insert(*column, index);
314 }
315 expr.permute_map(&map);
316 }
317
318 let (oks, errs) = self.build_topk(
319 ok_input, group_key, order_key, offset, limit, arity, buckets,
320 );
321 err_collection = err_collection.concat(errs);
322 CollectionBundle::from_edge(oks, err_collection)
323 }
324 };
325
326 bundle.leave_region(outer_scope)
328 });
329
330 bundle
331 }
332
333 fn build_topk<'s>(
335 &self,
336 collection: ColCollection<'s, T>,
337 group_key: Vec<usize>,
338 order_key: Vec<mz_expr::ColumnOrder>,
339 offset: usize,
340 limit: Option<LirScalarExpr>,
341 arity: usize,
342 buckets: Vec<u64>,
343 ) -> (
344 ColCollection<'s, T>,
345 VecCollection<'s, T, DataflowErrorSer, Diff>,
346 ) {
347 let pairer = Pairer::new(1);
348 let mut collection = map_topk_key(collection, "TopK input", move |datums, row| {
349 let row_hash = row.hashed();
350 let iterator = group_key.iter().map(|i| datums[*i]);
351 pairer.merge(std::iter::once(Datum::from(row_hash)), iterator)
352 });
353
354 let mut validating = true;
355 let mut err_collection: Option<VecCollection<'s, T, _, _>> = None;
356
357 if let Some(mut limit) = limit.clone() {
358 if offset > 0 {
361 let new_limit = (|| {
362 let limit = limit.as_literal_int64()?;
363 let offset = i64::try_from(offset).ok()?;
364 limit.checked_add(offset)
365 })();
366
367 if let Some(new_limit) = new_limit {
368 limit =
369 LirScalarExpr::literal_ok(Datum::Int64(new_limit), ReprScalarType::Int64);
370 } else {
371 limit = limit.call_binary(
372 LirScalarExpr::literal_ok(
373 Datum::UInt64(u64::cast_from(offset)),
374 ReprScalarType::UInt64,
375 )
376 .call_unary(UnaryFunc::CastUint64ToInt64(CastUint64ToInt64)),
377 BinaryFunc::AddInt64(func::AddInt64),
378 );
379 }
380 }
381
382 for bucket in buckets.into_iter() {
386 let (oks, errs) = self.build_topk_stage(
390 collection,
391 order_key.clone(),
392 bucket,
393 0,
394 Some(limit.clone()),
395 arity,
396 validating,
397 );
398 collection = oks;
399 if validating {
400 err_collection = errs;
401 validating = false;
402 }
403 }
404 }
405
406 let (oks, errs) = self.build_topk_stage(
410 collection, order_key, 1u64, offset, limit, arity, validating,
411 );
412 let oks = CollectionExt::consolidate_named::<ConsolidateBatcher<_, _, _>>(
414 oks,
415 "TopK final consolidate",
416 );
417 collection = oks;
418 if validating {
419 err_collection = errs;
420 }
421 (
422 topk_result_to_columnar(collection),
423 err_collection.expect("at least one stage validated its inputs"),
424 )
425 }
426
427 fn build_topk_stage<'s>(
460 &self,
461 collection: VecCollection<'s, T, (Row, Row), Diff>,
462 order_key: Vec<mz_expr::ColumnOrder>,
463 modulus: u64,
464 offset: usize,
465 limit: Option<LirScalarExpr>,
466 arity: usize,
467 validating: bool,
468 ) -> (
469 VecCollection<'s, T, (Row, Row), Diff>,
470 Option<VecCollection<'s, T, DataflowErrorSer, Diff>>,
471 ) {
472 let input = collection.map(move |(hash_key, row)| {
475 let mut hash_key_iter = hash_key.iter();
476 let hash = hash_key_iter.next().unwrap().unwrap_uint64() % modulus;
477 let hash_key = SharedRow::pack(std::iter::once(hash.into()).chain(hash_key_iter));
478 (hash_key, row)
479 });
480
481 let (input, oks, errs) = if validating {
483 let (input, stage) = build_topk_negated_stage::<
485 T,
486 RowValBuilder<_, _, _>,
487 RowValSpine<Result<Row, Row>, _, _>,
488 >(&input, order_key, offset, limit, arity);
489 let stage = stage.as_collection(|k, v| (k.to_row(), v.clone()));
490
491 let error_logger = self.error_logger();
493 type CB<C> = CapacityContainerBuilder<C>;
494 let (oks, errs) = stage.map_fallible::<CB<_>, CB<_>, _, _, _>(
495 "Demuxing Errors",
496 move |(hk, result)| match result {
497 Err(v) => {
498 let mut hk_iter = hk.iter();
499 let h = hk_iter.next().unwrap().unwrap_uint64();
500 let k = SharedRow::pack(hk_iter);
501 let message = "Negative multiplicities in TopK";
502 error_logger.log(message, &format!("k={k:?}, h={h}, v={v:?}"));
503 Err(EvalError::Internal(message.into()).into())
504 }
505 Ok(t) => Ok((hk, t)),
506 },
507 );
508 (input, oks, Some(errs))
509 } else {
510 let (input, stage) =
512 build_topk_negated_stage::<T, RowRowBuilder<_, _>, RowRowSpine<_, _>>(
513 &input, order_key, offset, limit, arity,
514 );
515 let stage = stage.as_collection(|k, v| (k.to_row(), v.to_row()));
517
518 (input, stage, None)
519 };
520 let input = input.as_collection(|k, v| (k.to_row(), v.to_row()));
521 (oks.concat(input), errs)
522 }
523
524 fn render_top1_monotonic<'s>(
525 &self,
526 collection: ColCollection<'s, T>,
527 group_key: Vec<usize>,
528 order_key: Vec<mz_expr::ColumnOrder>,
529 arity: usize,
530 must_consolidate: bool,
531 ) -> (
532 Arranged<'s, TraceAgent<RowRowSpine<T, Diff>>>,
533 VecCollection<'s, T, DataflowErrorSer, Diff>,
534 ) {
535 let key: Vec<LirScalarExpr> = group_key
542 .iter()
543 .map(|c| LirScalarExpr::column(*c))
544 .collect();
545 let (_permutation, thinning) = permutation_for_arrangement(&key, arity);
546
547 let collection = map_topk_key(collection, "MonotonicTop1 input", move |datums, _row| {
552 SharedRow::pack(group_key.iter().map(|i| datums[*i]))
553 })
554 .consolidate_named_if::<ConsolidateBatcher<_, _, _>>(
555 must_consolidate,
556 "Consolidated MonotonicTop1 input",
557 );
558
559 let error_logger = self.error_logger();
561 let (partial, errs) = collection.ensure_monotonic(move |data, diff| {
562 error_logger.log(
563 "Non-monotonic input to MonotonicTop1",
564 &format!("data={data:?}, diff={diff}"),
565 );
566 let m = "tried to build monotonic top-1 on non-monotonic input".into();
567 (EvalError::Internal(m).into(), Diff::ONE)
568 });
569 let partial: KeyCollection<_, _, _> = partial
570 .explode_one(move |(group_key, row)| {
571 (
572 group_key,
573 monoids::Top1Monoid {
574 row,
575 order_key: order_key.clone(),
576 },
577 )
578 })
579 .into();
580 let result = partial
581 .mz_arrange::<RowBatcher<_, _>, RowSpine<_, _>>(
582 "Arranged MonotonicTop1 partial [val: empty]",
583 )
584 .mz_reduce_abelian::<_, RowRowBuilder<_, _>, RowRowSpine<_, _>, _>("MonotonicTop1", {
585 let mut datum_vec = mz_repr::DatumVec::new();
586 move |_key, input, output| {
587 let accum: &monoids::Top1Monoid = &input[0].1;
588 let datums = datum_vec.borrow_with(&accum.row);
589 let value = SharedRow::pack(thinning.iter().map(|i| datums[*i]));
590 output.push((value, Diff::ONE));
591 }
592 });
593 (result, errs)
594 }
595}
596
597fn map_topk_key<'s, T, L>(
607 edge: ColCollection<'s, T>,
608 name: &str,
609 mut key: L,
610) -> VecCollection<'s, T, (Row, Row), Diff>
611where
612 T: crate::render::RenderTimestamp,
613 L: FnMut(&[Datum], &Row) -> Row + 'static,
614{
615 let mut builder = OperatorBuilder::new(name.to_string(), edge.inner.scope());
616 let (output, stream) = builder.new_output();
617 let mut output =
618 OutputBuilder::<_, CapacityContainerBuilder<Vec<((Row, Row), T, Diff)>>>::from(output);
619 let mut input = builder.new_input(edge.inner, Pipeline);
620 builder.build(move |_capabilities| {
621 let mut datum_vec = mz_repr::DatumVec::new();
622 move |_frontiers| {
623 let mut output = output.activate();
624 input.for_each(|time, data| {
625 let mut session = output.session_with_builder(&time);
626 for (row, t, d) in data.borrow().into_index_iter() {
627 let value_row: Row = Columnar::into_owned(row);
628 let key_row = {
629 let datums = datum_vec.borrow_with(&value_row);
630 key(&datums, &value_row)
631 };
632 session.give((
633 (key_row, value_row),
634 Columnar::into_owned(t),
635 Columnar::into_owned(d),
636 ));
637 }
638 });
639 }
640 });
641 stream.as_collection()
642}
643
644fn topk_result_to_columnar<'s, T>(
654 collection: VecCollection<'s, T, (Row, Row), Diff>,
655) -> ColCollection<'s, T>
656where
657 T: crate::render::RenderTimestamp,
658{
659 let stream = collection
660 .inner
661 .unary::<ColumnBuilder<(Row, T, Diff)>, _, _, _>(Pipeline, "TopKUnkey", |_cap, _info| {
662 move |input, output| {
663 input.for_each(|time, data| {
664 let mut session = output.session_with_builder(&time);
665 for ((_key_hash, row), t, d) in data.drain(..) {
666 session.give((&row, &t, &d));
667 }
668 });
669 }
670 });
671 stream.as_collection()
672}
673
674fn build_topk_negated_stage<'s, T, Bu, Tr>(
682 input: &VecCollection<'s, T, (Row, Row), Diff>,
683 order_key: Vec<mz_expr::ColumnOrder>,
684 offset: usize,
685 limit: Option<LirScalarExpr>,
686 arity: usize,
687) -> (
688 Arranged<'s, TraceAgent<RowRowSpine<T, Diff>>>,
689 Arranged<'s, TraceAgent<Tr>>,
690)
691where
692 T: MzTimestamp,
693 Bu: Builder<
694 Time = T,
695 Input: Container + ClearContainer + PushInto<((Row, BatchValOwn<Tr>), T, Diff)>,
696 Output = Tr::Batch,
697 > + 'static,
698 Tr: Trace<Batch: Navigable, Time = T> + 'static,
699 for<'a> BatchCursor<Tr>: Cursor<
700 Key<'a> = DatumSeq<'a>,
701 KeyContainer = DatumContainer,
702 ValOwn: Data + MaybeValidatingRow<Row, Row>,
703 Time = T,
704 Diff = Diff,
705 >,
706 Arranged<'s, TraceAgent<Tr>>: ArrangementSize,
707{
708 let mut datum_vec = mz_repr::DatumVec::new();
709
710 let arranged = input
715 .clone()
716 .mz_arrange::<RowRowBatcher<_, _>, RowRowSpine<_, _>>("Arranged TopK input");
717
718 let limit = limit.map(|l| match l.as_literal() {
720 Some(Ok(Datum::Null)) => Ok(Diff::MAX),
721 Some(Ok(d)) => Ok(Diff::from(d.unwrap_int64())),
722 _ => Err(l),
723 });
724
725 let reduced = arranged
726 .clone()
727 .mz_reduce_abelian::<_, Bu, Tr, _>("Reduced TopK input", {
728 move |hash_key, source, target: &mut Vec<(BatchValOwn<Tr>, Diff)>| {
729 let limit = match &limit {
731 Some(Ok(lit)) => Some(*lit),
732 Some(Err(expr)) => {
733 let temp_storage = mz_repr::RowArena::new();
736 let mut key_datums = datum_vec.borrow();
737 hash_key.extend_datums(&temp_storage, &mut key_datums, None);
738 let datum_limit = expr
740 .eval(&key_datums[1..], &temp_storage)
741 .unwrap_or(Datum::Int64(0));
742 Some(match datum_limit {
743 Datum::Null => Diff::MAX,
744 d => Diff::from(d.unwrap_int64()),
745 })
746 }
747 None => None,
748 };
749
750 if let Some(err) = BatchValOwn::<Tr>::into_error() {
751 for (datums, diff) in source.iter() {
752 if diff.is_positive() {
753 continue;
754 }
755 target.push((err((*datums).to_row()), Diff::ONE));
756 return;
757 }
758 }
759
760 let must_shrink = offset > 0
762 || limit
763 .map(|l| source.iter().map(|(_, d)| *d).sum::<Diff>() > l)
764 .unwrap_or(false);
765 if !must_shrink {
766 return;
767 }
768
769 target.reserve(source.len());
773 for (datums, diff) in source.iter() {
774 target.push((BatchValOwn::<Tr>::ok((*datums).to_row()), -diff));
775 }
776 let mut offset = offset;
778 let mut limit = limit;
779
780 let mut indexes = (0..source.len()).collect::<Vec<_>>();
782 let temp_storage = mz_repr::RowArena::new();
785 let mut buffer = Vec::with_capacity(arity * source.len());
786 for (index, (datums, _)) in source.iter().enumerate() {
787 datums.extend_datums(&temp_storage, &mut buffer, None);
788 assert_eq!(buffer.len(), arity * (index + 1));
789 }
790 let width = buffer.len() / source.len();
791
792 indexes.sort_by(|left, right| {
794 let left = &buffer[left * width..][..width];
795 let right = &buffer[right * width..][..width];
796 mz_expr::compare_columns(&order_key, left, right, || left.cmp(right))
799 });
800
801 for index in indexes.into_iter() {
804 let (datums, mut diff) = source[index];
805 if !diff.is_positive() {
806 continue;
807 }
808 if offset > 0 {
810 let to_skip =
811 std::cmp::min(offset, usize::try_from(diff.into_inner()).unwrap());
812 offset -= to_skip;
813 diff -= Diff::try_from(to_skip).unwrap();
814 }
815 if let Some(limit) = &mut limit {
817 diff = std::cmp::min(diff, Diff::from(*limit));
818 *limit -= diff;
819 }
820 if diff.is_positive() {
822 target.push((BatchValOwn::<Tr>::ok(datums.to_row()), diff));
825 }
826 }
827 }
828 });
829 (arranged, reduced)
830}
831
832fn render_intra_ts_thinning<'s, T>(
833 collection: VecCollection<'s, T, (Row, Row), Diff>,
834 order_key: Vec<mz_expr::ColumnOrder>,
835 limit: LirScalarExpr,
836) -> VecCollection<'s, T, (Row, Row), Diff>
837where
838 T: timely::progress::Timestamp + Lattice,
839{
840 let mut datum_vec = mz_repr::DatumVec::new();
841
842 let mut aggregates: BTreeMap<Stamp<T>, (CapabilitySet<T>, BTreeMap<_, _>)> = BTreeMap::new();
846 let shared = Rc::new(RefCell::new(monoids::Top1MonoidShared {
847 order_key,
848 left: DatumVec::new(),
849 right: DatumVec::new(),
850 }));
851
852 collection
853 .inner
854 .unary_frontier(Pipeline, "TopKIntraTimeThinning", move |_cap, _info| {
855 move |(input, chain), output| {
856 input.for_each_stamp(|cap, data| {
857 let (_, agg_time) = aggregates
858 .entry(cap.stamp().clone())
859 .or_insert_with(|| (cap.retain_stamp(0), BTreeMap::new()));
860 for ((grp_row, row), record_time, diff) in data.flat_map(|data| data.drain(..))
861 {
862 let monoid = monoids::Top1MonoidLocal {
863 row,
864 shared: Rc::clone(&shared),
865 };
866
867 let limit = if let Some(l) = limit.as_literal_int64() {
869 l
870 } else {
871 let temp_storage = mz_repr::RowArena::new();
872 let key_datums = datum_vec.borrow_with(&grp_row);
873 let datum_limit = limit
876 .eval(&key_datums, &temp_storage)
877 .unwrap_or(mz_repr::Datum::Int64(0));
878 if datum_limit == Datum::Null {
879 i64::MAX
880 } else {
881 datum_limit.unwrap_int64()
882 }
883 };
884
885 let topk = agg_time
886 .entry((grp_row, record_time))
887 .or_insert_with(move || topk_agg::TopKBatch::new(limit));
888 topk.update(monoid, diff.into_inner());
889 }
890 });
891
892 let frontier = chain.frontier();
895 let complete: Vec<_> = aggregates
896 .keys()
897 .filter(|stamp| stamp.iter().all(|time| !frontier.less_equal(time)))
898 .cloned()
899 .collect();
900 for stamp in complete {
901 let (caps, aggs) = aggregates.remove(&stamp).expect("known to exist");
902 let mut session = output.session(&caps);
903 for ((grp_row, record_time), topk) in aggs {
904 session.give_iterator(topk.into_iter().map(|(monoid, diff)| {
905 (
906 (grp_row.clone(), monoid.into_row()),
907 record_time.clone(),
908 diff.into(),
909 )
910 }))
911 }
912 }
913 }
914 })
915 .as_collection()
916}
917
918pub mod topk_agg {
920 use differential_dataflow::consolidation;
921 use smallvec::SmallVec;
922
923 pub struct TopKBatch<T> {
930 updates: SmallVec<[(T, i64); 16]>,
931 clean: usize,
932 limit: i64,
933 }
934
935 impl<T: Ord> TopKBatch<T> {
936 pub fn new(limit: i64) -> Self {
937 Self {
938 updates: SmallVec::new(),
939 clean: 0,
940 limit,
941 }
942 }
943
944 #[inline]
951 pub fn update(&mut self, item: T, value: i64) {
952 self.updates.push((item, value));
953 self.maintain_bounds();
954 }
955
956 #[inline]
962 pub fn compact(&mut self) {
963 if self.clean < self.updates.len() && self.updates.len() > 1 {
964 let len = consolidation::consolidate_slice(&mut self.updates);
965 self.updates.truncate(len);
966
967 let mut limit = self.limit;
969 self.updates.retain(|x| {
970 if limit > 0 {
971 limit -= x.1;
972 true
973 } else {
974 false
975 }
976 });
977 if limit < 0 {
985 if let Some(item) = self.updates.last_mut() {
986 item.1 -= -limit;
989 }
990 }
991 }
992 self.clean = self.updates.len();
993 }
994
995 fn maintain_bounds(&mut self) {
998 if self.updates.len() > 32 && self.updates.len() >> 1 >= self.clean {
1000 self.compact()
1001 }
1002 }
1003 }
1004
1005 impl<T: Ord> IntoIterator for TopKBatch<T> {
1006 type Item = (T, i64);
1007 type IntoIter = smallvec::IntoIter<[(T, i64); 16]>;
1008
1009 fn into_iter(mut self) -> Self::IntoIter {
1010 self.compact();
1011 self.updates.into_iter()
1012 }
1013 }
1014}
1015
1016pub mod monoids {
1018 use std::cell::RefCell;
1019 use std::cmp::Ordering;
1020 use std::hash::{Hash, Hasher};
1021 use std::rc::Rc;
1022
1023 use columnation::{Columnation, Region};
1024 use differential_dataflow::difference::{IsZero, Multiply, Semigroup};
1025 use mz_expr::ColumnOrder;
1026 use mz_repr::{DatumVec, Diff, Row};
1027 use serde::{Deserialize, Serialize};
1028
1029 #[derive(Eq, PartialEq, Debug, Serialize, Deserialize, Hash, Default)]
1031 pub struct Top1Monoid {
1032 pub row: Row,
1033 pub order_key: Vec<ColumnOrder>,
1034 }
1035
1036 impl Clone for Top1Monoid {
1037 #[inline]
1038 fn clone(&self) -> Self {
1039 Self {
1040 row: self.row.clone(),
1041 order_key: self.order_key.clone(),
1042 }
1043 }
1044
1045 #[inline]
1046 fn clone_from(&mut self, source: &Self) {
1047 self.row.clone_from(&source.row);
1048 self.order_key.clone_from(&source.order_key);
1049 }
1050 }
1051
1052 impl Multiply<Diff> for Top1Monoid {
1053 type Output = Self;
1054
1055 fn multiply(self, factor: &Diff) -> Self {
1056 assert!(factor.is_positive());
1061 self
1062 }
1063 }
1064
1065 impl Ord for Top1Monoid {
1066 fn cmp(&self, other: &Self) -> Ordering {
1067 mz_ore::soft_assert_eq_no_log!(self.order_key, other.order_key);
1068
1069 let left: Vec<_> = self.row.unpack();
1072 let right: Vec<_> = other.row.unpack();
1073 mz_expr::compare_columns(&self.order_key, &left, &right, || left.cmp(&right))
1074 }
1075 }
1076 impl PartialOrd for Top1Monoid {
1077 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1078 Some(self.cmp(other))
1079 }
1080 }
1081
1082 impl Semigroup for Top1Monoid {
1083 fn plus_equals(&mut self, rhs: &Self) {
1084 let cmp = (*self).cmp(rhs);
1085 if cmp == Ordering::Greater {
1087 self.clone_from(rhs);
1088 }
1089 }
1090 }
1091
1092 impl IsZero for Top1Monoid {
1093 fn is_zero(&self) -> bool {
1094 false
1095 }
1096 }
1097
1098 impl Columnation for Top1Monoid {
1099 type InnerRegion = Top1MonoidRegion;
1100 }
1101
1102 #[derive(Default)]
1103 pub struct Top1MonoidRegion {
1104 row_region: <Row as Columnation>::InnerRegion,
1105 order_key_region: <Vec<ColumnOrder> as Columnation>::InnerRegion,
1106 }
1107
1108 impl Region for Top1MonoidRegion {
1109 type Item = Top1Monoid;
1110
1111 unsafe fn copy(&mut self, item: &Self::Item) -> Self::Item {
1112 let row = unsafe { self.row_region.copy(&item.row) };
1113 let order_key = unsafe { self.order_key_region.copy(&item.order_key) };
1114 Self::Item { row, order_key }
1115 }
1116
1117 fn clear(&mut self) {
1118 self.row_region.clear();
1119 self.order_key_region.clear();
1120 }
1121
1122 fn reserve_items<'a, I>(&mut self, items1: I)
1123 where
1124 Self: 'a,
1125 I: Iterator<Item = &'a Self::Item> + Clone,
1126 {
1127 let items2 = items1.clone();
1128 self.row_region
1129 .reserve_items(items1.into_iter().map(|s| &s.row));
1130 self.order_key_region
1131 .reserve_items(items2.into_iter().map(|s| &s.order_key));
1132 }
1133
1134 fn reserve_regions<'a, I>(&mut self, regions1: I)
1135 where
1136 Self: 'a,
1137 I: Iterator<Item = &'a Self> + Clone,
1138 {
1139 let regions2 = regions1.clone();
1140 self.row_region
1141 .reserve_regions(regions1.into_iter().map(|s| &s.row_region));
1142 self.order_key_region
1143 .reserve_regions(regions2.into_iter().map(|s| &s.order_key_region));
1144 }
1145
1146 fn heap_size(&self, mut callback: impl FnMut(usize, usize)) {
1147 self.row_region.heap_size(&mut callback);
1148 self.order_key_region.heap_size(callback);
1149 }
1150 }
1151
1152 #[derive(Debug)]
1154 pub struct Top1MonoidShared {
1155 pub order_key: Vec<ColumnOrder>,
1156 pub left: DatumVec,
1157 pub right: DatumVec,
1158 }
1159
1160 #[derive(Debug, Clone)]
1163 pub struct Top1MonoidLocal {
1164 pub row: Row,
1165 pub shared: Rc<RefCell<Top1MonoidShared>>,
1166 }
1167
1168 impl Top1MonoidLocal {
1169 pub fn into_row(self) -> Row {
1170 self.row
1171 }
1172 }
1173
1174 impl PartialEq for Top1MonoidLocal {
1175 fn eq(&self, other: &Self) -> bool {
1176 self.row.eq(&other.row)
1177 }
1178 }
1179
1180 impl Eq for Top1MonoidLocal {}
1181
1182 impl Hash for Top1MonoidLocal {
1183 fn hash<H: Hasher>(&self, state: &mut H) {
1184 self.row.hash(state);
1185 }
1186 }
1187
1188 impl Ord for Top1MonoidLocal {
1189 fn cmp(&self, other: &Self) -> Ordering {
1190 mz_ore::soft_assert_no_log!(Rc::ptr_eq(&self.shared, &other.shared));
1191 let Top1MonoidShared {
1192 left,
1193 right,
1194 order_key,
1195 } = &mut *self.shared.borrow_mut();
1196
1197 let left = left.borrow_with(&self.row);
1198 let right = right.borrow_with(&other.row);
1199 mz_expr::compare_columns(order_key, &left, &right, || left.cmp(&right))
1200 }
1201 }
1202
1203 impl PartialOrd for Top1MonoidLocal {
1204 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1205 Some(self.cmp(other))
1206 }
1207 }
1208
1209 impl Semigroup for Top1MonoidLocal {
1210 fn plus_equals(&mut self, rhs: &Self) {
1211 let cmp = (*self).cmp(rhs);
1212 if cmp == Ordering::Greater {
1214 self.clone_from(rhs);
1215 }
1216 }
1217 }
1218
1219 impl IsZero for Top1MonoidLocal {
1220 fn is_zero(&self) -> bool {
1221 false
1222 }
1223 }
1224}
1225
1226#[cfg(test)]
1227mod tests {
1228 use differential_dataflow::input::Input;
1229 use mz_repr::{Datum, Timestamp};
1230 use timely::dataflow::operators::Capture;
1231 use timely::dataflow::operators::capture::{Event, Extract};
1232
1233 use super::*;
1234 use crate::render::columnar::{columnar_to_vec, vec_to_columnar};
1235
1236 type KeyedUpdate = ((Row, Row), Timestamp, Diff);
1237 type Captured = std::sync::mpsc::Receiver<Event<Timestamp, Vec<KeyedUpdate>>>;
1238
1239 fn extract_sorted(captured: Captured) -> Vec<KeyedUpdate> {
1240 let mut updates: Vec<_> = captured
1241 .extract()
1242 .into_iter()
1243 .flat_map(|(_, data)| data)
1244 .collect();
1245 updates.sort();
1246 updates
1247 }
1248
1249 fn test_input() -> Vec<(Row, u64, Diff)> {
1253 vec![
1254 (
1255 Row::pack_slice(&[Datum::Int32(1), Datum::String("a")]),
1256 0,
1257 Diff::ONE,
1258 ),
1259 (
1260 Row::pack_slice(&[Datum::Int32(2), Datum::String("b")]),
1261 1,
1262 Diff::ONE,
1263 ),
1264 (
1265 Row::pack_slice(&[Datum::Int32(1), Datum::String("a")]),
1266 2,
1267 Diff::ONE,
1268 ),
1269 (
1270 Row::pack_slice(&[Datum::Int32(3), Datum::Null]),
1271 2,
1272 Diff::ONE,
1273 ),
1274 (
1275 Row::pack_slice(&[Datum::Int32(2), Datum::String("b")]),
1276 2,
1277 -Diff::ONE,
1278 ),
1279 (
1280 Row::pack_slice(&[Datum::Int32(4), Datum::String("d")]),
1281 1,
1282 -Diff::ONE,
1283 ),
1284 ]
1285 }
1286
1287 fn run_columnar(input: Vec<(Row, u64, Diff)>) -> Vec<KeyedUpdate> {
1290 let captured = timely::execute_directly(move |worker| {
1291 worker.dataflow::<Timestamp, _, _>(|scope| {
1292 let (mut handle, collection) = scope.new_collection();
1293 let pairer = Pairer::new(1);
1294 let group_key = [0usize];
1295 let keyed =
1296 map_topk_key(vec_to_columnar(collection), "test", move |datums, row| {
1297 let hash = row.hashed();
1298 let iterator = group_key.iter().map(|i| datums[*i]);
1299 pairer.merge(std::iter::once(Datum::from(hash)), iterator)
1300 });
1301 let captured = keyed.inner.capture();
1302 for (row, time, diff) in input {
1303 handle.update_at(row, Timestamp::from(time), diff);
1304 }
1305 handle.advance_to(Timestamp::from(3_u64));
1306 handle.flush();
1307 captured
1308 })
1309 });
1310 extract_sorted(captured)
1311 }
1312
1313 #[mz_ore::test]
1315 fn map_topk_key_forms_key() {
1316 let updates = run_columnar(test_input());
1317 assert!(!updates.is_empty());
1318 assert!(updates.iter().any(|(_, _, d)| *d < Diff::ZERO));
1321 for ((key, value), _t, _d) in &updates {
1324 let key_datums: Vec<_> = key.iter().collect();
1325 let value_datums: Vec<_> = value.iter().collect();
1326 assert_eq!(key_datums.len(), 2);
1327 assert_eq!(key_datums[1], value_datums[0]);
1328 }
1329 }
1330
1331 #[mz_ore::test]
1332 fn topk_result_to_columnar_drops_key() {
1333 let key = Row::pack_slice(&[Datum::Int64(7)]);
1334 let rows = vec![
1335 (
1336 (key.clone(), Row::pack_slice(&[Datum::Int32(1)])),
1337 0u64,
1338 Diff::ONE,
1339 ),
1340 (
1341 (key.clone(), Row::pack_slice(&[Datum::Int32(2)])),
1342 1u64,
1343 Diff::ONE,
1344 ),
1345 (
1348 (key.clone(), Row::pack_slice(&[Datum::Int32(1)])),
1349 2u64,
1350 -Diff::ONE,
1351 ),
1352 ];
1353 let mut expected: Vec<(Row, Timestamp, Diff)> = rows
1354 .iter()
1355 .map(|((_, v), t, d)| (v.clone(), Timestamp::from(*t), *d))
1356 .collect();
1357 expected.sort();
1358
1359 let captured = timely::execute_directly(move |worker| {
1360 worker.dataflow::<Timestamp, _, _>(|scope| {
1361 let (mut handle, collection) = scope.new_collection();
1362 let edge = topk_result_to_columnar(collection);
1363 let captured = columnar_to_vec(edge).inner.capture();
1364 for (kv, time, diff) in rows {
1365 handle.update_at(kv, Timestamp::from(time), diff);
1366 }
1367 handle.advance_to(Timestamp::from(3u64));
1368 handle.flush();
1369 captured
1370 })
1371 });
1372
1373 let mut got: Vec<(Row, Timestamp, Diff)> = captured
1374 .extract()
1375 .into_iter()
1376 .flat_map(|(_, data)| data)
1377 .collect();
1378 got.sort();
1379 assert_eq!(got, expected);
1380 }
1381}