algeon-datafusion 0.1.2

DataFusion physical-plan adapter for native GPU execution.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
use std::{collections::BTreeSet, sync::Arc};

use arrow::datatypes::{Field, Schema, SchemaRef};
use datafusion::{
    common::{JoinSide as DataFusionJoinSide, NullEquality},
    logical_expr::JoinType,
    physical_expr::{PhysicalExpr, expressions::Column},
    physical_plan::{
        ExecutionPlan,
        joins::{NestedLoopJoinExec, PartitionMode},
    },
};
use query_planning::{
    datatypes::{is_supported_list_carry_type, is_timestamp_with_timezone},
    error::{QueryError, QueryErrorCode},
    expr::{ColumnRef as NativeColumnRef, Expr as NativeExpr},
    plan::{
        AdvisoryOutputStatistics, JoinKey as NativeJoinKey, JoinNullEquality as NativeJoinNullEquality,
        JoinSide as NativeJoinSide, JoinSpec as NativeJoinSpec, JoinType as NativeJoinType,
        QueryPlanBuilder as NativeQueryPlanBuilder,
    },
};

use super::{
    Demand, LoweredNativeInput, RequiredFields,
    expr::{collect_required_field_indices, lower_physical_expr_with_bindings, physical_expr_field},
    join_output::{
        JoinOutputRequests, cross_join_output_requests, datafusion_join_output_side, hash_join_output_requests,
        nested_loop_join_output_requests,
    },
    join_residual::{JoinResidualMaterialization, LoweredJoinResidual, lower_join_filter},
    lower_native_input, projection_outputs,
};
use crate::{
    capability::CapabilityReason,
    native::{
        ExpressionRejection, LoweringFailure, ParquetReadStrategyConfig,
        expression_contract::validate_join_residual,
        normalize::{
            NormalizedNativeCrossJoin, NormalizedNativeHashJoin, NormalizedNativeInput, NormalizedNativeLiteralSource,
            NormalizedNativeNestedLoopJoin,
        },
    },
};

/// Native join shape after mapping DataFusion-only join variants to the native
/// side convention. `swap_inputs` records whether DataFusion left/right inputs
/// are reversed before building the native join.
#[derive(Debug, Clone, Copy)]
pub(super) struct CanonicalJoin {
    kind: CanonicalJoinKind,
    swap_inputs: bool,
}

/// The native join type of a canonical join, without the state only one join
/// type carries; the null-aware flag and the mark column join it when the
/// spec is built.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum CanonicalJoinKind {
    Inner,
    Left,
    Full,
    LeftSemi,
    LeftAnti,
    LeftMark,
    Cross,
}

impl CanonicalJoin {
    pub(super) const fn new(kind: CanonicalJoinKind, swap_inputs: bool) -> Self {
        Self { kind, swap_inputs }
    }

    fn order_inputs(
        self,
        left: LoweredNativeInput,
        right: LoweredNativeInput,
    ) -> (LoweredNativeInput, LoweredNativeInput) {
        if self.swap_inputs { (right, left) } else { (left, right) }
    }

    pub(super) fn native_input_index_for_datafusion_side(
        self,
        side: DataFusionJoinSide,
    ) -> Result<usize, LoweringFailure> {
        // Residual predicates are expressed in DataFusion sides, while the
        // native IR addresses ordered join inputs. This is the shared mapping.
        match (self.swap_inputs, side) {
            (false, DataFusionJoinSide::Left) | (true, DataFusionJoinSide::Right) => Ok(0),
            (false, DataFusionJoinSide::Right) | (true, DataFusionJoinSide::Left) => Ok(1),
            (_, DataFusionJoinSide::None) => Err(CapabilityReason::UnsupportedExpression.into()),
        }
    }

    pub(super) fn native_side_for_datafusion_side(
        self,
        side: DataFusionJoinSide,
    ) -> Result<NativeJoinSide, LoweringFailure> {
        match self.native_input_index_for_datafusion_side(side)? {
            0 => Ok(NativeJoinSide::Left),
            1 => Ok(NativeJoinSide::Right),
            _ => unreachable!("canonical native join input index is always 0 or 1"),
        }
    }

    pub(super) fn datafusion_side_for_native_left(self) -> DataFusionJoinSide {
        if self.swap_inputs { DataFusionJoinSide::Right } else { DataFusionJoinSide::Left }
    }

    pub(super) const fn kind(self) -> CanonicalJoinKind {
        self.kind
    }

    /// The native join type with its type-specific state. DataFusion marks
    /// only anti joins null-aware, and a mark join always names its mark
    /// column in the lowered output.
    fn native_join_type(self, null_aware: bool, mark_column: Option<&str>) -> Result<NativeJoinType, LoweringFailure> {
        if null_aware && self.kind != CanonicalJoinKind::LeftAnti {
            return Err(CapabilityReason::UnsupportedOperator.into());
        }
        Ok(match self.kind {
            CanonicalJoinKind::Inner => NativeJoinType::Inner,
            CanonicalJoinKind::Left => NativeJoinType::Left,
            CanonicalJoinKind::Full => NativeJoinType::Full,
            CanonicalJoinKind::LeftSemi => NativeJoinType::LeftSemi,
            CanonicalJoinKind::LeftAnti => NativeJoinType::LeftAnti { null_aware },
            CanonicalJoinKind::Cross => NativeJoinType::Cross,
            CanonicalJoinKind::LeftMark => {
                let mark_column = mark_column.ok_or_else(|| {
                    LoweringFailure::Invalid(QueryError::new(
                        QueryErrorCode::InvalidPlan,
                        "algeon_datafusion.native_lowering.join",
                        "a lowered left mark join has no mark column in its output",
                    ))
                })?;
                NativeJoinType::LeftMark { mark_column: mark_column.to_string() }
            },
        })
    }

    const fn build_side(self) -> NativeJoinSide {
        // Use right-build orientation whenever join semantics allow it so
        // left-deep joined streams can remain on the probe side.
        match self.kind {
            CanonicalJoinKind::Left
            | CanonicalJoinKind::LeftSemi
            | CanonicalJoinKind::LeftAnti
            | CanonicalJoinKind::LeftMark
            | CanonicalJoinKind::Inner => NativeJoinSide::Right,
            CanonicalJoinKind::Full | CanonicalJoinKind::Cross => NativeJoinSide::Left,
        }
    }
}

fn add_join_residual_materializations(
    builder: &mut NativeQueryPlanBuilder,
    input: LoweredNativeInput,
    materializations: &[JoinResidualMaterialization],
) -> Result<LoweredNativeInput, LoweringFailure> {
    // Residual casts that cannot live in the predicate AST are appended as
    // synthetic pre-join projection columns on the original DataFusion side.
    // Canonical input ordering happens after this step.
    if materializations.is_empty() {
        return Ok(input);
    }

    let mut expressions =
        input.schema.fields().iter().map(|field| NativeExpr::column(field.name())).collect::<Vec<_>>();
    let mut fields = input.schema.fields().iter().map(|field| field.as_ref().clone()).collect::<Vec<_>>();
    let mut bindings = input.bindings;
    for materialization in materializations {
        expressions.push(materialization.expr.clone());
        fields.push(materialization.field.clone());
        bindings.push(super::FieldBinding {
            frontend_index: usize::MAX - bindings.len(),
            frontend_name: materialization.alias.clone(),
            native_name: materialization.alias.clone(),
        });
    }
    let schema = Arc::new(Schema::new(fields));
    let node = builder.add_projection(input.node, projection_outputs(expressions, &schema)?)?;
    Ok(LoweredNativeInput::with_bindings(node, schema, bindings))
}

fn add_join_residual_materializations_by_side(
    builder: &mut NativeQueryPlanBuilder,
    left: LoweredNativeInput,
    right: LoweredNativeInput,
    residual: &LoweredJoinResidual,
) -> Result<(LoweredNativeInput, LoweredNativeInput), LoweringFailure> {
    Ok((
        add_join_residual_materializations(builder, left, residual.materializations.side(DataFusionJoinSide::Left)?)?,
        add_join_residual_materializations(builder, right, residual.materializations.side(DataFusionJoinSide::Right)?)?,
    ))
}

#[derive(Debug, Clone, Copy)]
enum JoinKeySide {
    Left,
    Right,
}

struct PreparedJoinKeyExpr {
    column_index: Option<usize>,
    synthetic_alias: Option<String>,
}

struct JoinKeyMaterialization {
    expr: Arc<dyn PhysicalExpr>,
    alias: String,
    field: Field,
}

struct PreparedJoinKeys {
    keys: Vec<(PreparedJoinKeyExpr, PreparedJoinKeyExpr)>,
    left_materializations: Vec<JoinKeyMaterialization>,
    right_materializations: Vec<JoinKeyMaterialization>,
}

fn prepare_join_key_expr(
    expr: &Arc<dyn PhysicalExpr>,
    input_schema: &SchemaRef,
    side: JoinKeySide,
    key_index: usize,
    required: &mut BTreeSet<usize>,
    materializations: &mut Vec<JoinKeyMaterialization>,
) -> Result<PreparedJoinKeyExpr, LoweringFailure> {
    if let Some(column) = expr.downcast_ref::<Column>() {
        let field = input_schema.fields().get(column.index()).ok_or(CapabilityReason::UnsupportedExpression)?;
        if is_timestamp_with_timezone(field.data_type()) || is_supported_list_carry_type(field.data_type()) {
            return Err(ExpressionRejection::unsupported_value_type(expr, field.data_type().clone()).into());
        }
        required.insert(column.index());
        return Ok(PreparedJoinKeyExpr { column_index: Some(column.index()), synthetic_alias: None });
    }

    collect_required_field_indices(expr, input_schema, required)?;
    let alias = unique_synthetic_join_key_alias(side, key_index, input_schema, materializations);
    let field = physical_expr_field(expr, input_schema, alias.as_str())?;
    if is_timestamp_with_timezone(field.data_type()) || is_supported_list_carry_type(field.data_type()) {
        return Err(ExpressionRejection::unsupported_value_type(expr, field.data_type().clone()).into());
    }
    materializations.push(JoinKeyMaterialization { expr: Arc::clone(expr), alias: alias.clone(), field });
    Ok(PreparedJoinKeyExpr { column_index: None, synthetic_alias: Some(alias) })
}

fn prepare_join_keys(
    join: &NormalizedNativeHashJoin<'_>,
    left_required: &mut BTreeSet<usize>,
    right_required: &mut BTreeSet<usize>,
    left_predicate_required: &mut BTreeSet<usize>,
    right_predicate_required: &mut BTreeSet<usize>,
) -> Result<PreparedJoinKeys, LoweringFailure> {
    let left_schema = join.join.left().schema();
    let right_schema = join.join.right().schema();
    let mut left_materializations = Vec::new();
    let mut right_materializations = Vec::new();
    let mut keys = Vec::with_capacity(join.join.on().len());
    for (key_index, (left, right)) in join.join.on().iter().enumerate() {
        let left = prepare_join_key_expr(
            left,
            &left_schema,
            JoinKeySide::Left,
            key_index,
            left_required,
            &mut left_materializations,
        )?;
        left_predicate_required.extend(left_required.iter().copied());
        let right = prepare_join_key_expr(
            right,
            &right_schema,
            JoinKeySide::Right,
            key_index,
            right_required,
            &mut right_materializations,
        )?;
        right_predicate_required.extend(right_required.iter().copied());
        keys.push((left, right));
    }
    Ok(PreparedJoinKeys { keys, left_materializations, right_materializations })
}

fn add_join_key_materializations(
    builder: &mut NativeQueryPlanBuilder,
    input: LoweredNativeInput,
    input_schema: &SchemaRef,
    materializations: &[JoinKeyMaterialization],
) -> Result<LoweredNativeInput, LoweringFailure> {
    if materializations.is_empty() {
        return Ok(input);
    }

    let mut expressions =
        input.schema.fields().iter().map(|field| NativeExpr::column(field.name())).collect::<Vec<_>>();
    let mut fields = input.schema.fields().iter().map(|field| field.as_ref().clone()).collect::<Vec<_>>();
    let mut bindings = input.bindings;
    for materialization in materializations {
        let expr = lower_physical_expr_with_bindings(&materialization.expr, input_schema, Some(&bindings))?;
        expressions.push(expr.alias(materialization.alias.as_str()));
        fields.push(materialization.field.clone());
        bindings.push(super::FieldBinding {
            frontend_index: usize::MAX - bindings.len(),
            frontend_name: materialization.alias.clone(),
            native_name: materialization.alias.clone(),
        });
    }
    let schema = Arc::new(Schema::new(fields));
    let node = builder.add_projection(input.node, projection_outputs(expressions, &schema)?)?;
    Ok(LoweredNativeInput::with_bindings(node, schema, bindings))
}

fn unique_synthetic_join_key_alias(
    side: JoinKeySide,
    key_index: usize,
    input_schema: &SchemaRef,
    materializations: &[JoinKeyMaterialization],
) -> String {
    let side = match side {
        JoinKeySide::Left => "left",
        JoinKeySide::Right => "right",
    };
    for attempt in 0.. {
        let alias = format!("__algeon_native_join_key_{side}_{key_index}_{attempt}");
        if input_schema.field_with_name(alias.as_str()).is_err()
            && materializations.iter().all(|materialization| materialization.alias != alias)
        {
            return alias;
        }
    }
    unreachable!("unbounded synthetic join key alias search must find a free name")
}

fn lowered_join_key_ref<'a>(
    key: &'a PreparedJoinKeyExpr,
    input: &'a LoweredNativeInput,
) -> Result<(&'a str, &'a str), LoweringFailure> {
    if let Some(alias) = key.synthetic_alias.as_deref() {
        return Ok((alias, alias));
    }
    let column_index = key.column_index.ok_or(CapabilityReason::UnsupportedExpression)?;
    let binding = input.binding_for_frontend_index(column_index)?;
    Ok((binding.native_name.as_str(), binding.frontend_name.as_str()))
}

fn lower_prepared_join_keys(
    prepared: &[(PreparedJoinKeyExpr, PreparedJoinKeyExpr)],
    left: &LoweredNativeInput,
    right: &LoweredNativeInput,
    canonical: CanonicalJoin,
) -> Result<Vec<NativeJoinKey>, LoweringFailure> {
    prepared
        .iter()
        .map(|(left_key, right_key)| {
            let (left_native, left_frontend) = lowered_join_key_ref(left_key, left)?;
            let (right_native, right_frontend) = lowered_join_key_ref(right_key, right)?;
            if canonical.swap_inputs {
                Ok(NativeJoinKey::new(
                    NativeColumnRef::input(0, right_native, right_frontend),
                    NativeColumnRef::input(1, left_native, left_frontend),
                ))
            } else {
                Ok(NativeJoinKey::new(
                    NativeColumnRef::input(0, left_native, left_frontend),
                    NativeColumnRef::input(1, right_native, right_frontend),
                ))
            }
        })
        .collect()
}

fn extend_required_fields_from_join_outputs(
    output_requests: &JoinOutputRequests,
    left_required: &mut BTreeSet<usize>,
    right_required: &mut BTreeSet<usize>,
    left_predicate_required: &mut BTreeSet<usize>,
    right_predicate_required: &mut BTreeSet<usize>,
) {
    for output in &output_requests.outputs {
        match output.datafusion_side {
            DataFusionJoinSide::Left => {
                left_required.insert(output.input_index);
                if output.predicate_required {
                    left_predicate_required.insert(output.input_index);
                }
            },
            DataFusionJoinSide::Right => {
                right_required.insert(output.input_index);
                if output.predicate_required {
                    right_predicate_required.insert(output.input_index);
                }
            },
            DataFusionJoinSide::None => {},
        }
    }
}

fn extend_required_fields_from_residual(
    residual: Option<&LoweredJoinResidual>,
    left_required: &mut BTreeSet<usize>,
    right_required: &mut BTreeSet<usize>,
) {
    if let Some(residual) = residual {
        left_required.extend(residual.left_required.iter().copied());
        right_required.extend(residual.right_required.iter().copied());
    }
}

pub(super) fn lower_hash_join_input(
    join: &NormalizedNativeHashJoin<'_>,
    builder: &mut NativeQueryPlanBuilder,
    required_output_fields: &RequiredFields,
    source_reads: &ParquetReadStrategyConfig,
) -> Result<LoweredNativeInput, LoweringFailure> {
    // Lowering canonicalizes the join type, derives the DataFusion-output-preserving
    // projection, collects key and residual requirements, lowers both children, adds
    // key and residual materializations, then orders the inputs for the native spec.
    let canonical = canonical_join(join.join.join_type())?;
    let output_requests = hash_join_output_requests(join, required_output_fields)?;
    let residual = join
        .join
        .filter()
        .map(|filter| {
            let left_schema = join.join.left().schema();
            let right_schema = join.join.right().schema();
            let contract = validate_join_residual(filter, &left_schema, &right_schema)?;
            lower_join_filter(&contract, canonical, None)
        })
        .transpose()?;
    let mut left_required = BTreeSet::<usize>::new();
    let mut right_required = BTreeSet::<usize>::new();
    let mut left_predicate_required = BTreeSet::<usize>::new();
    let mut right_predicate_required = BTreeSet::<usize>::new();
    let prepared_keys = prepare_join_keys(
        join,
        &mut left_required,
        &mut right_required,
        &mut left_predicate_required,
        &mut right_predicate_required,
    )?;
    extend_required_fields_from_join_outputs(
        &output_requests,
        &mut left_required,
        &mut right_required,
        &mut left_predicate_required,
        &mut right_predicate_required,
    );
    extend_required_fields_from_residual(residual.as_ref(), &mut left_required, &mut right_required);
    extend_required_fields_from_residual(
        residual.as_ref(),
        &mut left_predicate_required,
        &mut right_predicate_required,
    );
    let left = lower_native_input(
        &join.left,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(left_required, left_predicate_required)),
        source_reads,
    )?;
    let right = lower_native_input(
        &join.right,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(right_required, right_predicate_required)),
        source_reads,
    )?;
    let residual = if join.join.filter().is_some() {
        join.join
            .filter()
            .map(|filter| {
                let left_schema = join.join.left().schema();
                let right_schema = join.join.right().schema();
                let contract = validate_join_residual(filter, &left_schema, &right_schema)?;
                lower_join_filter(
                    &contract,
                    canonical,
                    Some(super::join_residual::JoinResidualInputBindings { left: &left, right: &right }),
                )
            })
            .transpose()?
    } else {
        residual
    };
    let output_columns = output_requests.lower(&left, &right, canonical)?;
    let left =
        add_join_key_materializations(builder, left, &join.join.left().schema(), &prepared_keys.left_materializations)?;
    let right = add_join_key_materializations(
        builder,
        right,
        &join.join.right().schema(),
        &prepared_keys.right_materializations,
    )?;
    let (left, right) = if let Some(residual) = &residual {
        add_join_residual_materializations_by_side(builder, left, right, residual)?
    } else {
        (left, right)
    };
    let keys = lower_prepared_join_keys(&prepared_keys.keys, &left, &right, canonical)?;
    let inferred_lookup_side = unique_lookup_bounded_side(builder, join, canonical, &left, &right, &keys);
    let (native_left, native_right) = canonical.order_inputs(left, right);
    let build_side = native_join_build_side(canonical, keys.len(), residual.is_some());
    let datafusion_order_preserved_side = datafusion_hash_join_order_preserved_side(join, build_side);
    let join_type = canonical.native_join_type(join.join.null_aware, output_columns.mark_column_name.as_deref())?;
    let mut spec = NativeJoinSpec::new(join_type, keys)
        .with_output_projection(output_columns.projection)
        .with_null_equality(lower_join_null_equality(join.join.null_equality()))
        .with_build_side(build_side)
        .with_datafusion_order_preserved_side(datafusion_order_preserved_side);
    if let Some(statistics) = datafusion_join_advisory_output_statistics(join.join) {
        spec = spec.with_advisory_output_statistics(statistics);
    }
    if let Some(residual) = residual {
        spec = spec.with_residual_predicate(residual.predicate);
    }
    if matches!(canonical.kind, CanonicalJoinKind::Inner | CanonicalJoinKind::Left)
        && let Some(bounded_side) = inferred_lookup_side
    {
        spec = spec.with_at_most_one_match_per_bounded_row(bounded_side);
    }
    let node = builder.add_join(native_left.node, native_right.node, spec, Arc::clone(&output_columns.schema))?;
    let output = LoweredNativeInput::with_bindings(node, output_columns.schema, output_columns.bindings);
    if let Some(fetch) = join.fetch {
        let node = builder.add_limit(output.node, fetch)?;
        Ok(LoweredNativeInput::with_bindings(node, output.schema, output.bindings))
    } else {
        Ok(output)
    }
}

fn unique_lookup_bounded_side(
    builder: &NativeQueryPlanBuilder,
    join: &NormalizedNativeHashJoin<'_>,
    canonical: CanonicalJoin,
    left: &LoweredNativeInput,
    right: &LoweredNativeInput,
    keys: &[NativeJoinKey],
) -> Option<NativeJoinSide> {
    if join.join.filter().is_some() || join.join.on().is_empty() {
        return None;
    }
    let left_keys = keys.iter().map(|key| key.left.name().to_owned()).collect::<BTreeSet<_>>();
    let right_keys = keys.iter().map(|key| key.right.name().to_owned()).collect::<BTreeSet<_>>();
    if left_keys.len() != keys.len() || right_keys.len() != keys.len() {
        return None;
    }

    let left_unique = builder.output_is_unique_on(left.node, &left_keys);
    let right_unique = builder.output_is_unique_on(right.node, &right_keys);
    let bounded_datafusion_side = match join.join.join_type() {
        JoinType::Inner if right_unique => DataFusionJoinSide::Left,
        JoinType::Inner if left_unique => DataFusionJoinSide::Right,
        JoinType::Left if right_unique => DataFusionJoinSide::Left,
        JoinType::Right if left_unique => DataFusionJoinSide::Right,
        _ => return None,
    };
    canonical.native_side_for_datafusion_side(bounded_datafusion_side).ok()
}

pub(super) fn lower_nested_loop_join_input(
    join: &NormalizedNativeNestedLoopJoin<'_>,
    builder: &mut NativeQueryPlanBuilder,
    required_output_fields: &RequiredFields,
    source_reads: &ParquetReadStrategyConfig,
) -> Result<LoweredNativeInput, LoweringFailure> {
    // Nested-loop lowering shares the residual/materialization path with hash
    // joins, but has no equality keys. Cross joins are represented as keyless
    // native joins without residual predicates.
    let canonical = nested_loop_join_canonical(join, required_output_fields)?;
    let residual = nested_loop_join_residual(join.join, canonical)?;
    let output_requests = nested_loop_join_output_requests(join, required_output_fields)?;
    let mut left_required = BTreeSet::<usize>::new();
    let mut right_required = BTreeSet::<usize>::new();
    extend_required_fields_from_residual(residual.as_ref(), &mut left_required, &mut right_required);
    let mut left_predicate_required = BTreeSet::<usize>::new();
    let mut right_predicate_required = BTreeSet::<usize>::new();
    extend_required_fields_from_join_outputs(
        &output_requests,
        &mut left_required,
        &mut right_required,
        &mut left_predicate_required,
        &mut right_predicate_required,
    );
    extend_required_fields_from_residual(
        residual.as_ref(),
        &mut left_predicate_required,
        &mut right_predicate_required,
    );
    let left = lower_native_input(
        &join.left,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(left_required, left_predicate_required)),
        source_reads,
    )?;
    let right = lower_native_input(
        &join.right,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(right_required, right_predicate_required)),
        source_reads,
    )?;
    let residual = match join.join.filter() {
        Some(filter) => {
            let left_schema = join.join.left().schema();
            let right_schema = join.join.right().schema();
            let contract = validate_join_residual(filter, &left_schema, &right_schema)?;
            Some(lower_join_filter(
                &contract,
                canonical,
                Some(super::join_residual::JoinResidualInputBindings { left: &left, right: &right }),
            )?)
        },
        None => residual,
    };
    let output_columns = output_requests.lower(&left, &right, canonical)?;
    let (left, right) = if let Some(residual) = &residual {
        add_join_residual_materializations_by_side(builder, left, right, residual)?
    } else {
        (left, right)
    };
    let (native_left, native_right) = canonical.order_inputs(left, right);
    let build_side = native_join_build_side(canonical, 0, residual.is_some());
    let join_type = canonical.native_join_type(false, output_columns.mark_column_name.as_deref())?;
    let mut spec = NativeJoinSpec::new(join_type, Vec::new())
        .with_output_projection(output_columns.projection)
        .with_build_side(build_side);
    if let Some(statistics) = datafusion_join_advisory_output_statistics(join.join) {
        spec = spec.with_advisory_output_statistics(statistics);
    }
    if let Some(residual) = residual {
        spec = spec.with_residual_predicate(residual.predicate);
    }
    let node = builder.add_join(native_left.node, native_right.node, spec, Arc::clone(&output_columns.schema))?;
    Ok(LoweredNativeInput::with_bindings(node, output_columns.schema, output_columns.bindings))
}

pub(super) fn lower_cross_join_input(
    join: &NormalizedNativeCrossJoin<'_>,
    builder: &mut NativeQueryPlanBuilder,
    required_output_fields: &RequiredFields,
    source_reads: &ParquetReadStrategyConfig,
) -> Result<LoweredNativeInput, LoweringFailure> {
    let canonical = CanonicalJoin::new(CanonicalJoinKind::Cross, false);
    let output_requests = cross_join_output_requests(join, required_output_fields)?;
    let mut left_required = BTreeSet::<usize>::new();
    let mut right_required = BTreeSet::<usize>::new();
    let mut left_predicate_required = BTreeSet::<usize>::new();
    let mut right_predicate_required = BTreeSet::<usize>::new();
    extend_required_fields_from_join_outputs(
        &output_requests,
        &mut left_required,
        &mut right_required,
        &mut left_predicate_required,
        &mut right_predicate_required,
    );
    let left = lower_native_input(
        &join.left,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(left_required, left_predicate_required)),
        source_reads,
    )?;
    let right = lower_native_input(
        &join.right,
        builder,
        &Demand::fields(RequiredFields::only_with_predicates(right_required, right_predicate_required)),
        source_reads,
    )?;
    let output_columns = output_requests.lower(&left, &right, canonical)?;
    let mut spec = NativeJoinSpec::new(NativeJoinType::Cross, Vec::new())
        .with_output_projection(output_columns.projection)
        .with_build_side(NativeJoinSide::Left);
    if let Some(statistics) = datafusion_join_advisory_output_statistics(join.join) {
        spec = spec.with_advisory_output_statistics(statistics);
    }
    let node = builder.add_join(left.node, right.node, spec, Arc::clone(&output_columns.schema))?;
    Ok(LoweredNativeInput::with_bindings(node, output_columns.schema, output_columns.bindings))
}

/// Lowers DataFusion's own whole-output statistics for a join into the
/// backend-neutral advisory signal.
///
/// DataFusion's join estimate is inexact by construction (NDV from min/max
/// ranges, no skew or correlation model) and can be absent when a child scan
/// carries no statistics. Both cases map faithfully; an error while computing
/// statistics is the same as no estimate because the signal is advisory and
/// must never gate lowering.
fn datafusion_join_advisory_output_statistics(join: &dyn ExecutionPlan) -> Option<AdvisoryOutputStatistics> {
    super::advisory::output_statistics(join).filter(|statistics| !statistics.is_absent())
}

fn native_join_build_side(canonical: CanonicalJoin, key_count: usize, has_residual: bool) -> NativeJoinSide {
    // Keyless semi/anti joins with residuals need the preserved side as the
    // build side so the native executor can evaluate the condition without
    // emitting build-side rows.
    if key_count == 0
        && has_residual
        && matches!(
            canonical.kind,
            CanonicalJoinKind::LeftSemi | CanonicalJoinKind::LeftAnti | CanonicalJoinKind::LeftMark
        )
    {
        NativeJoinSide::Left
    } else {
        canonical.build_side()
    }
}

fn datafusion_hash_join_order_preserved_side(
    join: &NormalizedNativeHashJoin<'_>,
    build_side: NativeJoinSide,
) -> NativeJoinSide {
    match join.join.partition_mode() {
        PartitionMode::CollectLeft => opposite_native_side(build_side),
        PartitionMode::Partitioned | PartitionMode::Auto => NativeJoinSide::Right,
    }
}

const fn opposite_native_side(side: NativeJoinSide) -> NativeJoinSide {
    match side {
        NativeJoinSide::Left => NativeJoinSide::Right,
        NativeJoinSide::Right => NativeJoinSide::Left,
    }
}

fn nested_loop_join_canonical(
    join: &NormalizedNativeNestedLoopJoin<'_>,
    required_output_fields: &RequiredFields,
) -> Result<CanonicalJoin, LoweringFailure> {
    // Predicate-free inner nested-loop joins are native cross joins.
    // Predicate-free left/right joins are also native cross joins when the null-supplying
    // input is provably a scalar aggregate subtree. A scalar aggregate emits exactly one row,
    // which leaves no unmatched side to null-extend. Predicate inner joins may swap when
    // only DataFusion-right columns are required. The swap keeps the output compact and
    // preserves the DataFusion schema.
    if join.join.filter().is_none() && matches!(join.join.join_type(), JoinType::Inner) {
        return Ok(CanonicalJoin::new(CanonicalJoinKind::Cross, false));
    }
    if join.join.filter().is_none()
        && matches!(join.join.join_type(), JoinType::Left)
        && normalized_input_is_scalar_single_row(&join.right)
    {
        return Ok(CanonicalJoin::new(CanonicalJoinKind::Cross, false));
    }
    if join.join.filter().is_none()
        && matches!(join.join.join_type(), JoinType::Right)
        && normalized_input_is_scalar_single_row(&join.left)
    {
        return Ok(CanonicalJoin::new(CanonicalJoinKind::Cross, false));
    }
    let canonical = canonical_join(join.join.join_type())?;
    if matches!(join.join.join_type(), JoinType::Inner)
        && nested_loop_join_required_outputs_are_right_only(join, required_output_fields)?
    {
        Ok(CanonicalJoin::new(CanonicalJoinKind::Inner, true))
    } else {
        Ok(canonical)
    }
}

fn nested_loop_join_residual(
    join: &NestedLoopJoinExec,
    canonical: CanonicalJoin,
) -> Result<Option<LoweredJoinResidual>, LoweringFailure> {
    // Non-inner nested-loop joins require a residual predicate unless the
    // canonicalizer has proven that the predicate-free join is a cross join.
    if let Some(filter) = join.filter() {
        let left_schema = join.left().schema();
        let right_schema = join.right().schema();
        let contract = validate_join_residual(filter, &left_schema, &right_schema)?;
        let residual = lower_join_filter(&contract, canonical, None)?;
        return Ok(Some(residual));
    }
    if matches!(join.join_type(), JoinType::Inner)
        || matches!(canonical.kind, CanonicalJoinKind::Cross | CanonicalJoinKind::Left | CanonicalJoinKind::Full)
    {
        return Ok(None);
    }
    Err(CapabilityReason::UnsupportedOperator.into())
}

fn normalized_input_is_scalar_single_row(input: &NormalizedNativeInput<'_>) -> bool {
    match input {
        NormalizedNativeInput::Projection(projection) => normalized_input_is_scalar_single_row(&projection.input),
        NormalizedNativeInput::Limit(limit) => {
            limit.spec.skip == 0 && limit.spec.fetch != Some(0) && normalized_input_is_scalar_single_row(&limit.input)
        },
        NormalizedNativeInput::Aggregate(aggregate) => aggregate.aggregate.group_expr().expr().is_empty(),
        NormalizedNativeInput::GpuResidentSource(_) => false,
        NormalizedNativeInput::LiteralSource(source) => {
            matches!(source, NormalizedNativeLiteralSource::PlaceholderRow(_))
        },
        NormalizedNativeInput::Source(_)
        | NormalizedNativeInput::Filter(_)
        | NormalizedNativeInput::Sort(_)
        | NormalizedNativeInput::Window(_)
        | NormalizedNativeInput::HashJoin(_)
        | NormalizedNativeInput::CrossJoin(_)
        | NormalizedNativeInput::NestedLoopJoin(_)
        | NormalizedNativeInput::Union(_) => false,
    }
}

fn nested_loop_join_required_outputs_are_right_only(
    join: &NormalizedNativeNestedLoopJoin<'_>,
    required_output_fields: &RequiredFields,
) -> Result<bool, LoweringFailure> {
    let mut saw_output = false;
    for output_index in required_output_fields.requested_indices(join.join.schema().fields().len())? {
        saw_output = true;
        let join_schema_index = match join.join.projection().as_deref() {
            Some(projection) => *projection.get(output_index).ok_or(CapabilityReason::UnsupportedExpression)?,
            None => output_index,
        };
        let (datafusion_side, _) = datafusion_join_output_side(
            join.join.join_type(),
            join_schema_index,
            &join.join.left().schema(),
            &join.join.right().schema(),
        )?;
        if datafusion_side != DataFusionJoinSide::Right {
            return Ok(false);
        }
    }
    Ok(saw_output)
}

fn canonical_join(join_type: &JoinType) -> Result<CanonicalJoin, LoweringFailure> {
    // Native join variants are left-oriented for right/semi/anti cases. Right
    // joins become left joins with swapped inputs, and right semi/anti become
    // left semi/anti with swapped inputs.
    match join_type {
        JoinType::Inner => Ok(CanonicalJoin::new(CanonicalJoinKind::Inner, false)),
        JoinType::Left => Ok(CanonicalJoin::new(CanonicalJoinKind::Left, false)),
        JoinType::Right => Ok(CanonicalJoin::new(CanonicalJoinKind::Left, true)),
        JoinType::Full => Ok(CanonicalJoin::new(CanonicalJoinKind::Full, false)),
        JoinType::LeftSemi => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftSemi, false)),
        JoinType::RightSemi => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftSemi, true)),
        JoinType::LeftAnti => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftAnti, false)),
        JoinType::RightAnti => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftAnti, true)),
        JoinType::LeftMark => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftMark, false)),
        JoinType::RightMark => Ok(CanonicalJoin::new(CanonicalJoinKind::LeftMark, true)),
    }
}

fn lower_join_null_equality(null_equality: NullEquality) -> NativeJoinNullEquality {
    match null_equality {
        NullEquality::NullEqualsNothing => NativeJoinNullEquality::NullsDoNotMatch,
        NullEquality::NullEqualsNull => NativeJoinNullEquality::NullsMatch,
    }
}