1use std::fmt;
18use std::sync::atomic::{AtomicUsize, Ordering};
19use std::sync::{Arc, Mutex};
20use std::time::Instant;
21
22use async_stream::try_stream;
23use common_error::ext::BoxedError;
24use common_recordbatch::util::ChainedRecordBatchStream;
25use common_recordbatch::{RecordBatchStreamWrapper, SendableRecordBatchStream};
26use common_telemetry::tracing::{self, Instrument};
27use common_telemetry::warn;
28use datafusion::execution::memory_pool::MemoryPool;
29use datafusion::physical_plan::metrics::ExecutionPlanMetricsSet;
30use datafusion::physical_plan::{DisplayAs, DisplayFormatType};
31use datatypes::arrow::array::BinaryArray;
32use datatypes::arrow::record_batch::RecordBatch;
33use datatypes::schema::SchemaRef;
34use futures::{StreamExt, TryStreamExt};
35use smallvec::SmallVec;
36use snafu::{OptionExt, ResultExt, ensure};
37use store_api::metadata::RegionMetadataRef;
38use store_api::region_engine::{
39 PartitionRange, PrepareRequest, QueryScanContext, RegionScanner, ScannerProperties,
40};
41use tokio::sync::Semaphore;
42use tokio::sync::mpsc::error::TrySendError;
43use tokio::sync::mpsc::{self, Receiver, Sender};
44
45use crate::error::{
46 Error, InvalidSenderSnafu, JoinSnafu, PartitionOutOfRangeSnafu, Result, ScanMultiTimesSnafu,
47 ScanSeriesSnafu, TooManyFilesToReadSnafu,
48};
49use crate::metrics::SCAN_MAX_CONCURRENT_FILES;
50use crate::read::ScannerMetrics;
51use crate::read::pruner::{PartitionPruner, Pruner, PrunerOptions};
52use crate::read::scan_region::{ScanInput, StreamContext};
53use crate::read::scan_util::{
54 PartitionMetrics, PartitionMetricsList, SeriesDistributorMetrics, compute_average_batch_size,
55 compute_parallel_channel_size,
56};
57use crate::read::seq_scan::{FlatReadMode, SeqScan};
58use crate::read::series_candidate::{SeriesCandidateScanner, is_sparse_metric_metadata};
59use crate::read::series_reader::{AssignedSeriesBatch, SeriesBatchCollector, SeriesReader};
60use crate::read::stream::{ConvertBatchStream, ScanBatch, ScanBatchStream};
61use crate::sst::parquet::flat_format::primary_key_column_index;
62use crate::sst::parquet::format::PrimaryKeyArray;
63
64const CANDIDATE_SERIES_ASSIGNMENT_THRESHOLD: usize = 1_000_000;
66
67type LegacyReceiverList = Vec<Option<Receiver<Result<SeriesBatch>>>>;
69
70type CandidateReceiverList = Vec<Option<CandidateReceiver>>;
72
73type CandidateSenderList = Vec<Option<mpsc::UnboundedSender<Result<SeriesReaderInput>>>>;
75
76struct CandidateReceiver {
77 receiver: mpsc::UnboundedReceiver<Result<SeriesReaderInput>>,
78 active_receivers: Arc<AtomicUsize>,
79}
80
81impl CandidateReceiver {
82 async fn recv(&mut self) -> Option<Result<SeriesReaderInput>> {
83 self.receiver.recv().await
84 }
85}
86
87impl Drop for CandidateReceiver {
88 fn drop(&mut self) {
89 let previous = self.active_receivers.fetch_sub(1, Ordering::Relaxed);
90 debug_assert!(previous > 0);
91 }
92}
93
94struct SeriesReaderInput {
96 assigned_series: AssignedSeriesBatch,
97 partition_pruner: Arc<PartitionPruner>,
98 range_semaphore: Arc<Semaphore>,
99}
100
101#[derive(Debug, Clone, Copy, PartialEq, Eq)]
102enum SeriesScanMode {
103 Legacy,
104 TwoPhase,
105}
106
107impl SeriesScanMode {
108 fn as_str(self) -> &'static str {
109 match self {
110 Self::Legacy => "legacy",
111 Self::TwoPhase => "two_phase",
112 }
113 }
114}
115
116pub struct SeriesScan {
122 mode: SeriesScanMode,
124 properties: ScannerProperties,
126 stream_ctx: Arc<StreamContext>,
128 pruner: Arc<Pruner>,
130 legacy_receivers: Mutex<LegacyReceiverList>,
132 candidate_receivers: Mutex<CandidateReceiverList>,
134 metrics_list: Arc<PartitionMetricsList>,
137}
138
139impl SeriesScan {
140 pub(crate) fn new(input: ScanInput, experimental_series_scan_v2: bool) -> Self {
142 let mode = if experimental_series_scan_v2 && Self::supports_two_phase(&input) {
143 SeriesScanMode::TwoPhase
144 } else {
145 SeriesScanMode::Legacy
146 };
147 let mut properties = ScannerProperties::default()
148 .with_append_mode(input.append_mode)
149 .with_total_rows(input.total_rows())
150 .with_total_rows_is_exact(input.append_mode && input.total_rows_is_exact());
151 if let Some(counters) = input.query_stat_counters.clone() {
152 properties.set_query_stat_counters(counters);
153 }
154 let stream_ctx = Arc::new(StreamContext::seq_scan_ctx(input));
155 properties.partitions = vec![stream_ctx.partition_ranges()];
156
157 let num_workers = common_stat::get_total_cpu_cores().max(1);
159 let pruner = match mode {
160 SeriesScanMode::Legacy => Arc::new(Pruner::new(stream_ctx.clone(), num_workers)),
161 SeriesScanMode::TwoPhase => Arc::new(Pruner::new_with_options(
162 stream_ctx.clone(),
163 num_workers,
164 PrunerOptions {
165 retain_builders: true,
166 enable_predicate_prefilter: false,
167 },
168 )),
169 };
170
171 Self {
172 mode,
173 properties,
174 stream_ctx,
175 pruner,
176 legacy_receivers: Mutex::new(Vec::new()),
177 candidate_receivers: Mutex::new(Vec::new()),
178 metrics_list: Arc::new(PartitionMetricsList::default()),
179 }
180 }
181
182 fn supports_two_phase(input: &ScanInput) -> bool {
183 if !is_sparse_metric_metadata(input.region_metadata()) {
184 return false;
185 }
186 #[cfg(feature = "enterprise")]
187 if !input.extension_ranges().is_empty() {
188 return false;
189 }
190 true
191 }
192
193 #[tracing::instrument(
194 skip_all,
195 fields(
196 region_id = %self.stream_ctx.input.mapper.metadata().region_id,
197 partition = partition
198 )
199 )]
200 fn scan_partition_impl(
201 &self,
202 ctx: &QueryScanContext,
203 metrics_set: &ExecutionPlanMetricsSet,
204 partition: usize,
205 ) -> Result<SendableRecordBatchStream> {
206 let metrics = new_partition_metrics(
207 &self.stream_ctx,
208 ctx.explain_verbose,
209 metrics_set,
210 partition,
211 &self.metrics_list,
212 );
213
214 let batch_stream =
215 self.scan_batch_in_partition(ctx, partition, metrics.clone(), metrics_set)?;
216
217 let input = &self.stream_ctx.input;
218 let record_batch_stream = ConvertBatchStream::new(
219 batch_stream,
220 input.mapper.clone(),
221 input.cache_strategy.clone(),
222 metrics,
223 );
224
225 Ok(Box::pin(RecordBatchStreamWrapper::new(
226 input.mapper.output_schema(),
227 Box::pin(record_batch_stream),
228 )))
229 }
230
231 #[tracing::instrument(
232 skip_all,
233 fields(
234 region_id = %self.stream_ctx.input.mapper.metadata().region_id,
235 partition = partition
236 )
237 )]
238 fn scan_batch_in_partition(
239 &self,
240 ctx: &QueryScanContext,
241 partition: usize,
242 part_metrics: PartitionMetrics,
243 metrics_set: &ExecutionPlanMetricsSet,
244 ) -> Result<ScanBatchStream> {
245 if ctx.explain_verbose {
246 common_telemetry::info!(
247 "SeriesScan partition {}, region_id: {}",
248 partition,
249 self.stream_ctx.input.region_metadata().region_id
250 );
251 }
252
253 ensure!(
254 partition < self.properties.num_partitions(),
255 PartitionOutOfRangeSnafu {
256 given: partition,
257 all: self.properties.num_partitions(),
258 }
259 );
260
261 match self.mode {
262 SeriesScanMode::Legacy => self.scan_legacy_batch_in_partition(
263 partition,
264 part_metrics,
265 metrics_set,
266 ctx.explain_verbose,
267 ),
268 SeriesScanMode::TwoPhase => {
269 self.scan_two_phase_batch_in_partition(ctx, partition, part_metrics, metrics_set)
270 }
271 }
272 }
273
274 fn scan_legacy_batch_in_partition(
275 &self,
276 partition: usize,
277 part_metrics: PartitionMetrics,
278 metrics_set: &ExecutionPlanMetricsSet,
279 explain_verbose: bool,
280 ) -> Result<ScanBatchStream> {
281 self.maybe_start_legacy_distributor(metrics_set, explain_verbose);
282 let mut receiver = self.legacy_receivers.lock().unwrap()[partition]
283 .take()
284 .context(ScanMultiTimesSnafu { partition })?;
285 let stream = try_stream! {
286 part_metrics.on_first_poll();
287
288 let mut fetch_start = Instant::now();
289 let mut metrics = ScannerMetrics::default();
290 while let Some(series) = receiver.recv().await {
291 let series = series?;
292 metrics.scan_cost += fetch_start.elapsed();
293 metrics.num_batches += series.num_batches();
294 metrics.num_rows += series.num_rows();
295
296 let yield_start = Instant::now();
297 yield ScanBatch::Series(series);
298 metrics.yield_cost += yield_start.elapsed();
299 fetch_start = Instant::now();
300 }
301
302 part_metrics.merge_metrics(&metrics);
303 part_metrics.on_finish();
304 };
305 Ok(Box::pin(stream))
306 }
307
308 fn scan_two_phase_batch_in_partition(
309 &self,
310 ctx: &QueryScanContext,
311 partition: usize,
312 part_metrics: PartitionMetrics,
313 metrics_set: &ExecutionPlanMetricsSet,
314 ) -> Result<ScanBatchStream> {
315 self.maybe_start_candidate_distributor(ctx, metrics_set);
316 let mut receiver = self.candidate_receivers.lock().unwrap()[partition]
319 .take()
320 .context(ScanMultiTimesSnafu { partition })?;
321 let stream_ctx = self.stream_ctx.clone();
322 let partition_ranges = self
323 .properties
324 .partitions
325 .iter()
326 .flatten()
327 .copied()
328 .collect::<Vec<_>>();
329 let stream = try_stream! {
330 part_metrics.on_first_poll();
331
332 let mut fetch_start = Instant::now();
333 let mut metrics = ScannerMetrics::default();
334 while let Some(input) = receiver.recv().await {
335 let input = input?;
336 metrics.scan_cost += fetch_start.elapsed();
337
338 let build_start = Instant::now();
339 let reader = SeriesReader::try_new(
340 stream_ctx.clone(),
341 partition_ranges.clone(),
342 input.assigned_series,
343 input.partition_pruner,
344 input.range_semaphore,
345 part_metrics.clone(),
346 )?;
347 let mut reader_stream = reader.build_stream().await?;
348 metrics.scan_cost += build_start.elapsed();
349 fetch_start = Instant::now();
350 while let Some(record_batch) = reader_stream.try_next().await? {
351 metrics.scan_cost += fetch_start.elapsed();
352 metrics.num_batches += 1;
353 metrics.num_rows += record_batch.num_rows();
354
355 let yield_start = Instant::now();
356 yield ScanBatch::RecordBatch(record_batch);
357 metrics.yield_cost += yield_start.elapsed();
358 fetch_start = Instant::now();
359 }
360 }
361 metrics.scan_cost += fetch_start.elapsed();
362
363 part_metrics.merge_metrics(&metrics);
364 part_metrics.on_finish();
365 };
366 Ok(Box::pin(stream))
367 }
368
369 fn maybe_start_legacy_distributor(
370 &self,
371 metrics_set: &ExecutionPlanMetricsSet,
372 explain_verbose: bool,
373 ) {
374 let mut rx_list = self.legacy_receivers.lock().unwrap();
375 if !rx_list.is_empty() {
376 return;
377 }
378
379 let (senders, receivers) = new_legacy_channel_list(self.properties.num_partitions());
380 let mut distributor = SeriesDistributor {
381 stream_ctx: self.stream_ctx.clone(),
382 range_semaphore: Some(Arc::new(Semaphore::new(self.properties.num_partitions()))),
383 final_merge_semaphore: Some(Arc::new(Semaphore::new(self.properties.num_partitions()))),
384 partitions: self.properties.partitions.clone(),
385 pruner: self.pruner.clone(),
386 senders,
387 metrics_set: metrics_set.clone(),
388 metrics_list: self.metrics_list.clone(),
389 explain_verbose,
390 };
391 let region_id = distributor.stream_ctx.input.mapper.metadata().region_id;
392 let span = tracing::info_span!("SeriesScan::distributor", region_id = %region_id);
393 common_runtime::spawn_query(
394 async move {
395 distributor.execute().await;
396 }
397 .instrument(span),
398 );
399
400 *rx_list = receivers;
401 }
402
403 fn maybe_start_candidate_distributor(
404 &self,
405 ctx: &QueryScanContext,
406 metrics_set: &ExecutionPlanMetricsSet,
407 ) {
408 let mut rx_list = self.candidate_receivers.lock().unwrap();
409 if !rx_list.is_empty() {
410 return;
411 }
412
413 let (senders, receivers, active_receivers) =
414 new_candidate_channel_list(self.properties.num_partitions());
415 let mut distributor = SeriesCandidateDistributor {
418 memory_pool: ctx.memory_pool.clone(),
419 stream_ctx: self.stream_ctx.clone(),
420 range_semaphore: Arc::new(Semaphore::new(self.properties.num_partitions())),
421 partitions: self.properties.partitions.clone(),
422 pruner: self.pruner.clone(),
423 senders,
424 active_receivers,
425 metrics_set: metrics_set.clone(),
426 metrics_list: self.metrics_list.clone(),
427 explain_verbose: ctx.explain_verbose,
428 };
429 let region_id = distributor.stream_ctx.input.mapper.metadata().region_id;
430 let span = tracing::info_span!("SeriesScan::candidate_distributor", region_id = %region_id);
431 common_runtime::spawn_query(
432 async move {
433 distributor.execute().await;
434 }
435 .instrument(span),
436 );
437
438 *rx_list = receivers;
439 }
440
441 #[tracing::instrument(
443 skip_all,
444 fields(region_id = %self.stream_ctx.input.mapper.metadata().region_id)
445 )]
446 pub(crate) async fn build_stream(&self) -> Result<SendableRecordBatchStream, BoxedError> {
447 let part_num = self.properties.num_partitions();
448 let metrics_set = ExecutionPlanMetricsSet::default();
449 let ctx = QueryScanContext::default();
450 let streams = (0..part_num)
451 .map(|i| self.scan_partition(&ctx, &metrics_set, i))
452 .collect::<Result<Vec<_>, BoxedError>>()?;
453 let chained_stream = ChainedRecordBatchStream::new(streams).map_err(BoxedError::new)?;
454 Ok(Box::pin(chained_stream))
455 }
456
457 pub(crate) fn scan_all_partitions(&self) -> Result<ScanBatchStream> {
459 let metrics_set = ExecutionPlanMetricsSet::new();
460
461 let ctx = QueryScanContext::default();
462 let streams = (0..self.properties.partitions.len())
463 .map(|partition| {
464 let metrics = new_partition_metrics(
465 &self.stream_ctx,
466 false,
467 &metrics_set,
468 partition,
469 &self.metrics_list,
470 );
471
472 self.scan_batch_in_partition(&ctx, partition, metrics, &metrics_set)
473 })
474 .collect::<Result<Vec<_>>>()?;
475
476 Ok(Box::pin(futures::stream::iter(streams).flatten()))
477 }
478
479 pub(crate) fn check_scan_limit(&self) -> Result<()> {
481 let total_files: usize = self
483 .properties
484 .partitions
485 .iter()
486 .flat_map(|partition| partition.iter())
487 .map(|part_range| {
488 let range_meta = &self.stream_ctx.ranges[part_range.identifier];
489 range_meta.indices.len()
490 })
491 .sum();
492
493 if !self.stream_ctx.input.compaction {
494 SCAN_MAX_CONCURRENT_FILES
495 .with_label_values(&["query"])
496 .observe(total_files as f64);
497 }
498 if self.stream_ctx.input.uses_scan_memory_limit() {
499 return Ok(());
500 }
501
502 let max_concurrent_files = self.stream_ctx.input.max_concurrent_scan_files;
503 if total_files > max_concurrent_files {
504 return TooManyFilesToReadSnafu {
505 actual: total_files,
506 max: max_concurrent_files,
507 }
508 .fail();
509 }
510
511 Ok(())
512 }
513}
514
515fn new_legacy_channel_list(num_partitions: usize) -> (SenderList, LegacyReceiverList) {
516 let (senders, receivers): (Vec<_>, Vec<_>) = (0..num_partitions)
517 .map(|_| {
518 let (sender, receiver) = mpsc::channel(1);
519 (Some(sender), Some(receiver))
520 })
521 .unzip();
522 (SenderList::new(senders), receivers)
523}
524
525fn new_candidate_channel_list(
526 num_partitions: usize,
527) -> (CandidateSenderList, CandidateReceiverList, Arc<AtomicUsize>) {
528 let active_receivers = Arc::new(AtomicUsize::new(num_partitions));
529 let (senders, receivers) = (0..num_partitions)
530 .map(|_| {
531 let (sender, receiver) = mpsc::unbounded_channel();
535 let receiver = CandidateReceiver {
536 receiver,
537 active_receivers: active_receivers.clone(),
538 };
539 (Some(sender), Some(receiver))
540 })
541 .unzip();
542 (senders, receivers, active_receivers)
543}
544
545impl RegionScanner for SeriesScan {
546 fn name(&self) -> &str {
547 "SeriesScan"
548 }
549
550 fn properties(&self) -> &ScannerProperties {
551 &self.properties
552 }
553
554 fn schema(&self) -> SchemaRef {
555 self.stream_ctx.input.mapper.output_schema()
556 }
557
558 fn metadata(&self) -> RegionMetadataRef {
559 self.stream_ctx.input.mapper.metadata().clone()
560 }
561
562 fn scan_partition(
563 &self,
564 ctx: &QueryScanContext,
565 metrics_set: &ExecutionPlanMetricsSet,
566 partition: usize,
567 ) -> Result<SendableRecordBatchStream, BoxedError> {
568 self.scan_partition_impl(ctx, metrics_set, partition)
569 .map_err(BoxedError::new)
570 }
571
572 fn prepare(&mut self, request: PrepareRequest) -> Result<(), BoxedError> {
573 self.properties.prepare(request);
574
575 self.check_scan_limit().map_err(BoxedError::new)?;
576
577 Ok(())
578 }
579
580 fn has_predicate_without_region(&self) -> bool {
581 let predicate = self
582 .stream_ctx
583 .input
584 .predicate_group()
585 .predicate_without_region();
586 predicate.is_some()
587 }
588
589 fn add_dyn_filter_to_predicate(
590 &mut self,
591 filter_exprs: Vec<Arc<dyn datafusion::physical_plan::PhysicalExpr>>,
592 ) -> Vec<bool> {
593 self.stream_ctx.add_dyn_filter_to_predicate(filter_exprs)
594 }
595
596 fn reset_state(&mut self) {
597 self.stream_ctx.input.predicate.clear_dyn_filters();
598 let num_workers = common_stat::get_total_cpu_cores().max(1);
599 self.pruner = match self.mode {
600 SeriesScanMode::Legacy => Arc::new(Pruner::new(self.stream_ctx.clone(), num_workers)),
601 SeriesScanMode::TwoPhase => Arc::new(Pruner::new_with_options(
602 self.stream_ctx.clone(),
603 num_workers,
604 PrunerOptions {
605 retain_builders: true,
606 enable_predicate_prefilter: false,
607 },
608 )),
609 };
610 self.legacy_receivers.lock().unwrap().clear();
611 self.candidate_receivers.lock().unwrap().clear();
612 self.metrics_list = Arc::new(PartitionMetricsList::default());
613 }
614
615 fn set_logical_region(&mut self, logical_region: bool) {
616 self.properties.set_logical_region(logical_region);
617 }
618
619 fn set_query_load_region_id(&mut self, region_id: store_api::storage::RegionId) {
620 self.properties.set_query_load_region_id(region_id);
621 }
622
623 fn snapshot_sequence(&self) -> Option<u64> {
624 self.stream_ctx.input.snapshot_sequence
625 }
626}
627
628impl DisplayAs for SeriesScan {
629 fn fmt_as(&self, t: DisplayFormatType, f: &mut fmt::Formatter) -> fmt::Result {
630 write!(
631 f,
632 "SeriesScan: region={}, ",
633 self.stream_ctx.input.mapper.metadata().region_id
634 )?;
635 match t {
636 DisplayFormatType::Default | DisplayFormatType::TreeRender => {
637 self.stream_ctx.format_for_explain(false, f)?;
638 }
639 DisplayFormatType::Verbose => {
640 self.stream_ctx.format_for_explain(true, f)?;
641 }
642 }
643 write!(f, ", \"mode\":\"{}\"", self.mode.as_str())?;
644 if matches!(t, DisplayFormatType::Verbose) {
645 self.metrics_list.format_verbose_metrics(f)?;
646 }
647 Ok(())
648 }
649}
650
651impl fmt::Debug for SeriesScan {
652 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
653 f.debug_struct("SeriesScan")
654 .field("mode", &self.mode)
655 .field("num_ranges", &self.stream_ctx.ranges.len())
656 .finish()
657 }
658}
659
660#[cfg(test)]
661impl SeriesScan {
662 pub(crate) fn input(&self) -> &ScanInput {
664 &self.stream_ctx.input
665 }
666
667 pub(crate) fn mode(&self) -> &'static str {
669 self.mode.as_str()
670 }
671}
672
673struct SeriesDistributor {
675 stream_ctx: Arc<StreamContext>,
677 range_semaphore: Option<Arc<Semaphore>>,
679 final_merge_semaphore: Option<Arc<Semaphore>>,
684 partitions: Vec<Vec<PartitionRange>>,
686 pruner: Arc<Pruner>,
688 senders: SenderList,
690 metrics_set: ExecutionPlanMetricsSet,
696 metrics_list: Arc<PartitionMetricsList>,
697 explain_verbose: bool,
699}
700
701impl SeriesDistributor {
702 #[tracing::instrument(
704 skip_all,
705 fields(region_id = %self.stream_ctx.input.mapper.metadata().region_id)
706 )]
707 async fn execute(&mut self) {
708 if let Err(e) = self.scan_partitions_flat().await {
709 self.senders.send_error(e).await;
710 }
711 }
712
713 #[tracing::instrument(
715 skip_all,
716 fields(region_id = %self.stream_ctx.input.mapper.metadata().region_id)
717 )]
718 async fn scan_partitions_flat(&mut self) -> Result<()> {
719 for partition_ranges in &self.partitions {
721 self.pruner.add_partition_ranges(partition_ranges);
722 }
723
724 let all_partition_ranges: Vec<_> = self.partitions.iter().flatten().cloned().collect();
726 let needs_merge = all_partition_ranges.len() > 1;
727 let partition_pruner = Arc::new(PartitionPruner::new(
728 self.pruner.clone(),
729 &all_partition_ranges,
730 ));
731
732 let part_metrics = new_partition_metrics(
733 &self.stream_ctx,
734 self.explain_verbose,
735 &self.metrics_set,
736 self.partitions.len(),
737 &self.metrics_list,
738 );
739 part_metrics.on_first_poll();
740 let mut fetch_start = Instant::now();
743
744 let build_start = Instant::now();
746 let mut tasks = Vec::new();
747 for partition in &self.partitions {
748 for part_range in partition {
749 let stream_ctx = self.stream_ctx.clone();
750 let part_range = *part_range;
751 let part_metrics = part_metrics.clone();
752 let partition_pruner = partition_pruner.clone();
753 let file_scan_semaphore = self.range_semaphore.clone();
754 let merge_semaphore = self.range_semaphore.clone();
755 tasks.push(common_runtime::spawn_query(async move {
756 SeqScan::build_flat_partition_range_read(
757 &stream_ctx,
758 &part_range,
759 if needs_merge {
760 FlatReadMode::CrossRangeMerge
761 } else {
762 FlatReadMode::Sequential
763 },
764 &part_metrics,
765 partition_pruner,
766 file_scan_semaphore,
767 merge_semaphore,
768 )
769 .await
770 }));
771 }
772 }
773 let mut range_streams = Vec::with_capacity(tasks.len());
774 let mut estimated_batch_sizes = Vec::with_capacity(tasks.len());
775 for task in tasks {
776 let (stream, estimated_batch_size) = task.await.context(JoinSnafu)??;
777 range_streams.push(stream);
778 estimated_batch_sizes.push(estimated_batch_size);
779 }
780 let channel_size =
781 compute_parallel_channel_size(compute_average_batch_size(estimated_batch_sizes));
782 common_telemetry::debug!(
783 "SeriesDistributor built {} range_streams, region: {}, build cost: {:?}, channel_size: {}",
784 range_streams.len(),
785 self.stream_ctx.input.region_metadata().region_id,
786 build_start.elapsed(),
787 channel_size,
788 );
789
790 let mut reader = SeqScan::build_flat_reader_from_sources(
794 &self.stream_ctx,
795 range_streams,
796 self.final_merge_semaphore.clone(),
797 Some(&part_metrics),
798 true,
799 channel_size,
800 )
801 .await?;
802 let mut metrics = SeriesDistributorMetrics::default();
803
804 let mut divider = FlatSeriesBatchDivider::default();
805 while let Some(record_batch) = reader.try_next().await? {
806 metrics.scan_cost += fetch_start.elapsed();
807 metrics.num_batches += 1;
808 metrics.num_rows += record_batch.num_rows();
809
810 debug_assert!(record_batch.num_rows() > 0);
811 if record_batch.num_rows() == 0 {
812 fetch_start = Instant::now();
813 continue;
814 }
815
816 let divider_start = Instant::now();
818 let series_batch = divider.push(record_batch);
819 metrics.divider_cost += divider_start.elapsed();
820 if let Some(series_batch) = series_batch {
821 let yield_start = Instant::now();
822 self.senders
823 .send_batch(SeriesBatch::Flat(series_batch))
824 .await?;
825 metrics.yield_cost += yield_start.elapsed();
826 }
827 fetch_start = Instant::now();
828 }
829
830 let divider_start = Instant::now();
832 let series_batch = divider.finish();
833 metrics.divider_cost += divider_start.elapsed();
834 if let Some(series_batch) = series_batch {
835 let yield_start = Instant::now();
836 self.senders
837 .send_batch(SeriesBatch::Flat(series_batch))
838 .await?;
839 metrics.yield_cost += yield_start.elapsed();
840 }
841
842 metrics.scan_cost += fetch_start.elapsed();
843 metrics.num_series_send_full = self.senders.num_full;
844 part_metrics.set_distributor_metrics(&metrics);
845
846 part_metrics.on_finish();
847
848 Ok(())
849 }
850}
851
852struct SeriesCandidateDistributor {
854 memory_pool: Arc<dyn MemoryPool>,
855 stream_ctx: Arc<StreamContext>,
856 range_semaphore: Arc<Semaphore>,
857 partitions: Vec<Vec<PartitionRange>>,
858 pruner: Arc<Pruner>,
859 senders: CandidateSenderList,
860 active_receivers: Arc<AtomicUsize>,
861 metrics_set: ExecutionPlanMetricsSet,
862 metrics_list: Arc<PartitionMetricsList>,
863 explain_verbose: bool,
864}
865
866impl SeriesCandidateDistributor {
867 async fn execute(&mut self) {
868 if let Err(e) = self.distribute().await {
869 self.send_error(e);
870 }
871 }
872
873 async fn distribute(&mut self) -> Result<()> {
874 let part_metrics = new_partition_metrics(
875 &self.stream_ctx,
876 self.explain_verbose,
877 &self.metrics_set,
878 self.partitions.len(),
879 &self.metrics_list,
880 );
881 part_metrics.on_first_poll();
882
883 let candidate_scanner = SeriesCandidateScanner::try_new(
884 self.stream_ctx.clone(),
885 self.partitions.clone(),
886 self.pruner.clone(),
887 self.range_semaphore.clone(),
888 self.memory_pool.clone(),
889 self.metrics_set.clone(),
890 part_metrics.clone(),
891 )?;
892 let partition_pruner = candidate_scanner.partition_pruner();
893 let mut candidates = candidate_scanner.build_stream().await?;
894 let mut collector =
895 SeriesBatchCollector::new(self.partitions.len()).context(InvalidSenderSnafu)?;
896 let mut chunked = false;
897 while let Some(batch) = candidates.try_next().await? {
898 if !self.should_fetch_candidates() {
899 part_metrics.on_finish();
900 return Ok(());
901 }
902 collector.push(batch);
903 if collector.len() >= CANDIDATE_SERIES_ASSIGNMENT_THRESHOLD {
904 chunked = true;
905 self.send_assignments(collector.finish(false), &partition_pruner);
906 if !self.should_fetch_candidates() {
907 part_metrics.on_finish();
908 return Ok(());
909 }
910 collector =
911 SeriesBatchCollector::new(self.partitions.len()).context(InvalidSenderSnafu)?;
912 }
913 }
914
915 if collector.len() > 0 {
916 self.send_assignments(collector.finish(!chunked), &partition_pruner);
917 }
918 part_metrics.on_finish();
919 Ok(())
920 }
921
922 fn send_assignments(
923 &mut self,
924 assignments: Vec<AssignedSeriesBatch>,
925 partition_pruner: &Arc<PartitionPruner>,
926 ) {
927 for (partition, assigned_series) in assignments.into_iter().enumerate() {
928 if assigned_series.series().is_empty() {
929 continue;
930 }
931 let Some(sender) = self.senders[partition].as_ref() else {
932 continue;
933 };
934 let sent = sender
935 .send(Ok(SeriesReaderInput {
936 assigned_series,
937 partition_pruner: partition_pruner.clone(),
938 range_semaphore: self.range_semaphore.clone(),
939 }))
940 .is_ok();
941 if !sent {
942 self.senders[partition] = None;
943 }
944 }
945 }
946
947 fn should_fetch_candidates(&self) -> bool {
948 self.active_receivers.load(Ordering::Relaxed) > 0
949 }
950
951 fn send_error(&mut self, error: Error) {
952 let error = Arc::new(error);
953 for sender in self.senders.iter_mut().filter_map(Option::take) {
954 let result = Err(error.clone()).context(ScanSeriesSnafu);
955 let _ = sender.send(result);
956 }
957 }
958}
959
960#[derive(Debug)]
962pub enum SeriesBatch {
963 Flat(FlatSeriesBatch),
964}
965
966impl SeriesBatch {
967 pub fn num_batches(&self) -> usize {
969 match self {
970 SeriesBatch::Flat(flat_batch) => flat_batch.batches.len(),
971 }
972 }
973
974 pub fn num_rows(&self) -> usize {
976 match self {
977 SeriesBatch::Flat(flat_batch) => flat_batch.batches.iter().map(|x| x.num_rows()).sum(),
978 }
979 }
980}
981
982#[derive(Default, Debug)]
984pub struct FlatSeriesBatch {
985 pub batches: SmallVec<[RecordBatch; 4]>,
986}
987
988struct SenderList {
990 senders: Vec<Option<Sender<Result<SeriesBatch>>>>,
991 num_nones: usize,
993 sender_idx: usize,
995 num_full: usize,
997}
998
999impl SenderList {
1000 fn new(senders: Vec<Option<Sender<Result<SeriesBatch>>>>) -> Self {
1001 let num_nones = senders.iter().filter(|sender| sender.is_none()).count();
1002 Self {
1003 senders,
1004 num_nones,
1005 sender_idx: 0,
1006 num_full: 0,
1007 }
1008 }
1009
1010 fn try_send_batch(&mut self, mut batch: SeriesBatch) -> Result<Option<SeriesBatch>> {
1013 for _ in 0..self.senders.len() {
1014 ensure!(self.num_nones < self.senders.len(), InvalidSenderSnafu);
1015
1016 let sender_idx = self.fetch_add_sender_idx();
1017 let Some(sender) = &self.senders[sender_idx] else {
1018 continue;
1019 };
1020
1021 match sender.try_send(Ok(batch)) {
1022 Ok(()) => return Ok(None),
1023 Err(TrySendError::Full(res)) => {
1024 self.num_full += 1;
1025 batch = res.unwrap();
1027 }
1028 Err(TrySendError::Closed(res)) => {
1029 self.senders[sender_idx] = None;
1030 self.num_nones += 1;
1031 batch = res.unwrap();
1033 }
1034 }
1035 }
1036
1037 Ok(Some(batch))
1038 }
1039
1040 async fn send_batch(&mut self, batch: SeriesBatch) -> Result<()> {
1042 let Some(batch) = self.try_send_batch(batch)? else {
1043 return Ok(());
1044 };
1045
1046 loop {
1047 ensure!(self.num_nones < self.senders.len(), InvalidSenderSnafu);
1048
1049 let closed = {
1053 let reservations = self.senders.iter().enumerate().filter_map(|(idx, sender)| {
1054 sender
1055 .as_ref()
1056 .map(|sender| Box::pin(async move { (idx, sender.reserve().await) }))
1057 });
1058 let ((idx, reserved), _, _) = futures::future::select_all(reservations).await;
1059 match reserved {
1060 Ok(permit) => {
1061 permit.send(Ok(batch));
1062 return Ok(());
1063 }
1064 Err(_) => idx,
1065 }
1066 };
1067 self.senders[closed] = None;
1068 self.num_nones += 1;
1069 }
1070 }
1071
1072 async fn send_error(&self, error: Error) {
1073 let error = Arc::new(error);
1074 for sender in self.senders.iter().flatten() {
1075 let result = Err(error.clone()).context(ScanSeriesSnafu);
1076 let _ = sender.send(result).await;
1077 }
1078 }
1079
1080 fn fetch_add_sender_idx(&mut self) -> usize {
1081 let sender_idx = self.sender_idx;
1082 self.sender_idx = (self.sender_idx + 1) % self.senders.len();
1083 sender_idx
1084 }
1085}
1086
1087fn new_partition_metrics(
1088 stream_ctx: &StreamContext,
1089 explain_verbose: bool,
1090 metrics_set: &ExecutionPlanMetricsSet,
1091 partition: usize,
1092 metrics_list: &PartitionMetricsList,
1093) -> PartitionMetrics {
1094 let metrics = PartitionMetrics::new(
1095 stream_ctx.input.mapper.metadata().region_id,
1096 partition,
1097 "SeriesScan",
1098 stream_ctx.query_start,
1099 explain_verbose,
1100 metrics_set,
1101 );
1102
1103 metrics_list.set(partition, metrics.clone());
1104 metrics
1105}
1106
1107#[derive(Default)]
1112struct FlatSeriesBatchDivider {
1113 buffer: FlatSeriesBatch,
1114}
1115
1116impl FlatSeriesBatchDivider {
1117 fn push(&mut self, batch: RecordBatch) -> Option<FlatSeriesBatch> {
1121 if self.buffer.batches.is_empty() {
1123 self.buffer.batches.push(batch);
1124 return None;
1125 }
1126
1127 let pk_column_idx = primary_key_column_index(batch.num_columns());
1129 let batch_pk_column = batch.column(pk_column_idx);
1130 let batch_pk_array = batch_pk_column
1131 .as_any()
1132 .downcast_ref::<PrimaryKeyArray>()
1133 .unwrap();
1134 let batch_pk_values = batch_pk_array
1135 .values()
1136 .as_any()
1137 .downcast_ref::<BinaryArray>()
1138 .unwrap();
1139 let batch_last_pk =
1141 primary_key_at(batch_pk_array, batch_pk_values, batch_pk_array.len() - 1);
1142 let buffer_last_batch = self.buffer.batches.last().unwrap();
1145 let buffer_pk_column = buffer_last_batch.column(pk_column_idx);
1146 let buffer_pk_array = buffer_pk_column
1147 .as_any()
1148 .downcast_ref::<PrimaryKeyArray>()
1149 .unwrap();
1150 let buffer_pk_values = buffer_pk_array
1151 .values()
1152 .as_any()
1153 .downcast_ref::<BinaryArray>()
1154 .unwrap();
1155 let buffer_last_pk =
1156 primary_key_at(buffer_pk_array, buffer_pk_values, buffer_pk_array.len() - 1);
1157
1158 if batch_last_pk == buffer_last_pk {
1160 self.buffer.batches.push(batch);
1161 return None;
1162 }
1163 let batch_pk_keys = batch_pk_array.keys();
1166 let pk_indices = batch_pk_keys.values();
1167 let mut change_offset = 0;
1168 for (i, &key) in pk_indices.iter().enumerate() {
1169 let batch_pk = batch_pk_values.value(key as usize);
1170
1171 if buffer_last_pk != batch_pk {
1172 change_offset = i;
1173 break;
1174 }
1175 }
1176
1177 let (first_part, remaining_part) = if change_offset > 0 {
1179 let first_part = batch.slice(0, change_offset);
1180 let remaining_part = batch.slice(change_offset, batch.num_rows() - change_offset);
1181 (Some(first_part), Some(remaining_part))
1182 } else {
1183 (None, Some(batch))
1184 };
1185
1186 let mut result = std::mem::take(&mut self.buffer);
1188 if let Some(first_part) = first_part {
1189 result.batches.push(first_part);
1190 }
1191
1192 if let Some(remaining_part) = remaining_part {
1194 self.buffer.batches.push(remaining_part);
1195 }
1196
1197 Some(result)
1198 }
1199
1200 fn finish(&mut self) -> Option<FlatSeriesBatch> {
1202 if self.buffer.batches.is_empty() {
1203 None
1204 } else {
1205 Some(std::mem::take(&mut self.buffer))
1206 }
1207 }
1208}
1209
1210fn primary_key_at<'a>(
1212 primary_key: &PrimaryKeyArray,
1213 primary_key_values: &'a BinaryArray,
1214 index: usize,
1215) -> &'a [u8] {
1216 let key = primary_key.keys().value(index);
1217 primary_key_values.value(key as usize)
1218}
1219
1220#[cfg(test)]
1221mod tests {
1222 use std::sync::Arc;
1223
1224 use api::v1::OpType;
1225 use datatypes::arrow::array::{
1226 ArrayRef, BinaryDictionaryBuilder, Int64Array, StringDictionaryBuilder,
1227 TimestampMillisecondArray, UInt8Array, UInt64Array,
1228 };
1229 use datatypes::arrow::datatypes::{DataType, Field, Schema, SchemaRef, TimeUnit, UInt32Type};
1230 use datatypes::arrow::record_batch::RecordBatch;
1231
1232 use super::*;
1233 use crate::read::flat_projection::FlatProjectionMapper;
1234 use crate::read::scan_region::PredicateGroup;
1235 use crate::test_util::scheduler_util::SchedulerEnv;
1236 use crate::test_util::sst_util::sst_region_metadata_with_encoding;
1237
1238 #[tokio::test]
1239 async fn two_phase_eligibility_allows_exact_sequence_range() {
1240 let env = SchedulerEnv::new().await;
1241 let metadata = Arc::new(sst_region_metadata_with_encoding(
1242 store_api::codec::PrimaryKeyEncoding::Sparse,
1243 ));
1244 let predicate = PredicateGroup::default();
1245
1246 let eligible = ScanInput::builder(
1247 env.access_layer.clone(),
1248 FlatProjectionMapper::new(&metadata, [0]).unwrap(),
1249 )
1250 .with_predicate(predicate.clone())
1251 .build();
1252 assert!(SeriesScan::supports_two_phase(&eligible));
1253
1254 let exact_sequence = ScanInput::builder(
1255 env.access_layer.clone(),
1256 FlatProjectionMapper::new(&metadata, [0]).unwrap(),
1257 )
1258 .with_predicate(predicate)
1259 .with_sequence_range(Some(store_api::storage::SequenceRange::GtLtEq {
1260 min: 1,
1261 max: 2,
1262 }))
1263 .build();
1264 assert!(SeriesScan::supports_two_phase(&exact_sequence));
1265 }
1266
1267 #[test]
1268 fn candidate_distributor_stops_after_all_receivers_close() {
1269 let (_senders, mut receivers, active_receivers) = new_candidate_channel_list(2);
1270 assert_eq!(2, active_receivers.load(Ordering::Relaxed));
1271
1272 drop(receivers[0].take());
1273 assert_eq!(1, active_receivers.load(Ordering::Relaxed));
1274
1275 drop(receivers[1].take());
1276 assert_eq!(0, active_receivers.load(Ordering::Relaxed));
1277 }
1278
1279 #[tokio::test]
1280 async fn distributor_does_not_stall_on_partitions_read_one_after_another() {
1281 const NUM_BATCHES: usize = 2000;
1282 let (mut senders, receivers) = new_legacy_channel_list(16);
1283 let producer = tokio::spawn(async move {
1284 for _ in 0..NUM_BATCHES {
1285 senders
1286 .send_batch(SeriesBatch::Flat(FlatSeriesBatch::default()))
1287 .await
1288 .unwrap();
1289 }
1290 });
1291 let consume = async {
1294 let mut received = 0;
1295 for mut receiver in receivers.into_iter().flatten() {
1296 while let Some(batch) = receiver.recv().await {
1297 batch.unwrap();
1298 received += 1;
1299 }
1300 }
1301 received
1302 };
1303 let received = tokio::time::timeout(std::time::Duration::from_secs(1), consume)
1304 .await
1305 .expect("the distributor stalled on partitions the consumer was not reading");
1306 producer.await.unwrap();
1307 assert_eq!(NUM_BATCHES, received);
1308 }
1309
1310 fn new_test_record_batch(
1311 primary_keys: &[&[u8]],
1312 timestamps: &[i64],
1313 sequences: &[u64],
1314 op_types: &[OpType],
1315 fields: &[u64],
1316 ) -> RecordBatch {
1317 let num_rows = timestamps.len();
1318 debug_assert_eq!(sequences.len(), num_rows);
1319 debug_assert_eq!(op_types.len(), num_rows);
1320 debug_assert_eq!(fields.len(), num_rows);
1321 debug_assert_eq!(primary_keys.len(), num_rows);
1322
1323 let columns: Vec<ArrayRef> = vec![
1324 build_test_pk_string_dict_array(primary_keys),
1325 Arc::new(Int64Array::from_iter(
1326 fields.iter().map(|v| Some(*v as i64)),
1327 )),
1328 Arc::new(TimestampMillisecondArray::from_iter_values(
1329 timestamps.iter().copied(),
1330 )),
1331 build_test_pk_array(primary_keys),
1332 Arc::new(UInt64Array::from_iter_values(sequences.iter().copied())),
1333 Arc::new(UInt8Array::from_iter_values(
1334 op_types.iter().map(|v| *v as u8),
1335 )),
1336 ];
1337
1338 RecordBatch::try_new(build_test_flat_schema(), columns).unwrap()
1339 }
1340
1341 fn build_test_pk_string_dict_array(primary_keys: &[&[u8]]) -> ArrayRef {
1342 let mut builder = StringDictionaryBuilder::<UInt32Type>::new();
1343 for &pk in primary_keys {
1344 let pk_str = std::str::from_utf8(pk).unwrap();
1345 builder.append(pk_str).unwrap();
1346 }
1347 Arc::new(builder.finish())
1348 }
1349
1350 fn build_test_pk_array(primary_keys: &[&[u8]]) -> ArrayRef {
1351 let mut builder = BinaryDictionaryBuilder::<UInt32Type>::new();
1352 for &pk in primary_keys {
1353 builder.append(pk).unwrap();
1354 }
1355 Arc::new(builder.finish())
1356 }
1357
1358 fn build_test_flat_schema() -> SchemaRef {
1359 let fields = vec![
1360 Field::new(
1361 "k0",
1362 DataType::Dictionary(Box::new(DataType::UInt32), Box::new(DataType::Utf8)),
1363 false,
1364 ),
1365 Field::new("field0", DataType::Int64, true),
1366 Field::new(
1367 "ts",
1368 DataType::Timestamp(TimeUnit::Millisecond, None),
1369 false,
1370 ),
1371 Field::new(
1372 "__primary_key",
1373 DataType::Dictionary(Box::new(DataType::UInt32), Box::new(DataType::Binary)),
1374 false,
1375 ),
1376 Field::new("__sequence", DataType::UInt64, false),
1377 Field::new("__op_type", DataType::UInt8, false),
1378 ];
1379 Arc::new(Schema::new(fields))
1380 }
1381
1382 #[test]
1383 fn test_empty_buffer_first_push() {
1384 let mut divider = FlatSeriesBatchDivider::default();
1385 let result = divider.finish();
1386 assert!(result.is_none());
1387
1388 let mut divider = FlatSeriesBatchDivider::default();
1389 let batch = new_test_record_batch(
1390 &[b"series1", b"series1"],
1391 &[1000, 2000],
1392 &[1, 2],
1393 &[OpType::Put, OpType::Put],
1394 &[10, 20],
1395 );
1396 let result = divider.push(batch);
1397 assert!(result.is_none());
1398 assert_eq!(divider.buffer.batches.len(), 1);
1399 }
1400
1401 #[test]
1402 fn test_same_series_accumulation() {
1403 let mut divider = FlatSeriesBatchDivider::default();
1404
1405 let batch1 = new_test_record_batch(
1406 &[b"series1", b"series1"],
1407 &[1000, 2000],
1408 &[1, 2],
1409 &[OpType::Put, OpType::Put],
1410 &[10, 20],
1411 );
1412
1413 let batch2 = new_test_record_batch(
1414 &[b"series1", b"series1"],
1415 &[3000, 4000],
1416 &[3, 4],
1417 &[OpType::Put, OpType::Put],
1418 &[30, 40],
1419 );
1420
1421 divider.push(batch1);
1422 let result = divider.push(batch2);
1423 assert!(result.is_none());
1424 let series_batch = divider.finish().unwrap();
1425 assert_eq!(series_batch.batches.len(), 2);
1426 }
1427
1428 #[test]
1429 fn test_series_boundary_detection() {
1430 let mut divider = FlatSeriesBatchDivider::default();
1431
1432 let batch1 = new_test_record_batch(
1433 &[b"series1", b"series1"],
1434 &[1000, 2000],
1435 &[1, 2],
1436 &[OpType::Put, OpType::Put],
1437 &[10, 20],
1438 );
1439
1440 let batch2 = new_test_record_batch(
1441 &[b"series2", b"series2"],
1442 &[3000, 4000],
1443 &[3, 4],
1444 &[OpType::Put, OpType::Put],
1445 &[30, 40],
1446 );
1447
1448 divider.push(batch1);
1449 let series_batch = divider.push(batch2).unwrap();
1450 assert_eq!(series_batch.batches.len(), 1);
1451
1452 assert_eq!(divider.buffer.batches.len(), 1);
1453 }
1454
1455 #[test]
1456 fn test_series_boundary_within_batch() {
1457 let mut divider = FlatSeriesBatchDivider::default();
1458
1459 let batch1 = new_test_record_batch(
1460 &[b"series1", b"series1"],
1461 &[1000, 2000],
1462 &[1, 2],
1463 &[OpType::Put, OpType::Put],
1464 &[10, 20],
1465 );
1466
1467 let batch2 = new_test_record_batch(
1468 &[b"series1", b"series2"],
1469 &[3000, 4000],
1470 &[3, 4],
1471 &[OpType::Put, OpType::Put],
1472 &[30, 40],
1473 );
1474
1475 divider.push(batch1);
1476 let series_batch = divider.push(batch2).unwrap();
1477 assert_eq!(series_batch.batches.len(), 2);
1478 assert_eq!(series_batch.batches[0].num_rows(), 2);
1479 assert_eq!(series_batch.batches[1].num_rows(), 1);
1480
1481 assert_eq!(divider.buffer.batches.len(), 1);
1482 assert_eq!(divider.buffer.batches[0].num_rows(), 1);
1483 }
1484
1485 #[test]
1486 fn test_series_splitting() {
1487 let mut divider = FlatSeriesBatchDivider::default();
1488
1489 let batch1 = new_test_record_batch(&[b"series1"], &[1000], &[1], &[OpType::Put], &[10]);
1490
1491 let batch2 = new_test_record_batch(
1492 &[b"series1", b"series2", b"series2", b"series3"],
1493 &[2000, 3000, 4000, 5000],
1494 &[2, 3, 4, 5],
1495 &[OpType::Put, OpType::Put, OpType::Put, OpType::Put],
1496 &[20, 30, 40, 50],
1497 );
1498
1499 divider.push(batch1);
1500 let series_batch = divider.push(batch2).unwrap();
1501 assert_eq!(series_batch.batches.len(), 2);
1502
1503 let total_rows: usize = series_batch.batches.iter().map(|b| b.num_rows()).sum();
1504 assert_eq!(total_rows, 2);
1505
1506 let final_batch = divider.finish().unwrap();
1507 assert_eq!(final_batch.batches.len(), 1);
1508 assert_eq!(final_batch.batches[0].num_rows(), 3);
1509 }
1510}