ajsquared commented on code in PR #7283: URL: https://github.com/apache/datafusion-comet/pull/7283#discussion_r4404548726
########## spark/src/main/scala/org/apache/comet/rules/MakeDateEvaluation.scala: ########## @@ -0,0 +1,353 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.comet.rules + +import org.apache.spark.sql.catalyst.expressions.{Add, Alias, And, Attribute, AttributeSet, BinaryComparison, Cast, ConditionalExpression, CreateArray, CreateNamedStruct, DateAdd, DateDiff, DateFormatClass, DateSub, EqualNullSafe, Expression, Greatest, HashExpression, IsNotNull, IsNull, Least, MakeDate, Multiply, Not, Or, SortOrder, Subtract, UnixDate} +import org.apache.spark.sql.catalyst.optimizer.BuildLeft +import org.apache.spark.sql.catalyst.trees.TreeNodeTag +import org.apache.spark.sql.comet._ +import org.apache.spark.sql.comet.execution.shuffle.CometShuffleExchangeExec +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.{BroadcastQueryStageExec, QueryStageExec} +import org.apache.spark.sql.execution.aggregate.{BaseAggregateExec, HashAggregateExec, ObjectHashAggregateExec} +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.execution.joins.{BaseJoinExec, BroadcastHashJoinExec, BroadcastNestedLoopJoinExec} + +import org.apache.comet.CometConf +import org.apache.comet.serde.CometMakeDate +import org.apache.comet.shims.ShimCometWindowGroupLimit + +/** Keeps make_date on Spark's row path where native batching can change whether it throws. */ +private[rules] object MakeDateEvaluation { + private val sparkEvaluation = TreeNodeTag[String]("comet.makeDateSparkEvaluation") + + private def enabled(plan: SparkPlan): Boolean = + CometConf.COMET_EXEC_MAKE_DATE_OPERATOR_FALLBACK_ENABLED.get(plan.conf) + + def reason(plan: SparkPlan): Option[String] = + if (enabled(plan)) plan.getTagValue(sparkEvaluation) else None + + private def containsMakeDate(expressions: Seq[Expression]): Boolean = + expressions.exists(_.exists(_.isInstanceOf[MakeDate])) + + private case class ProjectionDemand( + boundary: String, + deferred: AttributeSet, + // Deferred inputs whose producers need guarding even when they contain no make_date. + guardedInputs: AttributeSet) + + // Attributes may stand for deferred expressions in a lower projection, not materialized values. + private def harmlessValue(expression: Expression): Boolean = + expression.references.isEmpty && CometMakeDate.canEvaluateEagerly(expression) + + /** References that a consumer requires without exposing a potentially skipped sibling. */ + private def eagerReferences(expression: Expression): AttributeSet = expression match { + case attribute: Attribute => AttributeSet(Seq(attribute)) + case _ => + val children = expression match { + case date: MakeDate => + val firstNullable = date.children.indexWhere(_.nullable) + date.children.take(if (firstNullable < 0) date.children.size else firstNullable + 1) + case conditional: ConditionalExpression => + val required = conditional.alwaysEvaluatedInputs + if (conditional.children.filterNot(required.contains).forall(harmlessValue)) required + else Nil + case _: Alias | _: Cast | _: IsNull | _: IsNotNull | _: Not | _: UnixDate => + expression.children + case _: EqualNullSafe | _: CreateArray | _: CreateNamedStruct | _: Greatest | _: Least | + _: HashExpression[_] => + expression.children + case _: And | _: Or => + if (harmlessValue(expression.children(1))) expression.children.take(1) else Nil + case _: Add | _: Subtract | _: Multiply | _: BinaryComparison | _: DateAdd | _: DateSub | + _: DateDiff | _: DateFormatClass => + val left = expression.children.head + val right = expression.children(1) + if (!left.nullable) expression.children + // A right-hand attribute can inline a throwing expression from an earlier projection. + // Only self-contained harmless values are safe without tracing that attribute's source. + else if (harmlessValue(right)) Seq(left) + else Nil + // Unknown expressions may skip inputs or catch errors raised by their children. + case _ => Nil + } + AttributeSet(children.flatMap(eagerReferences)) + } + + private def copyLogicalLinks(from: SparkPlan, to: SparkPlan): Unit = { + if (from ne to) { + // setLogicalLink promotes inherited links to direct links and rewrites descendants. + // Keep each tag's role and retain the fallback plan's links when the source has none. + Seq(SparkPlan.LOGICAL_PLAN_TAG, SparkPlan.LOGICAL_PLAN_INHERITED_TAG).foreach { tag => + from.getTagValue(tag).foreach(to.setTagValue(tag, _)) + } + } + } + + private def nativeBroadcastInput(plan: SparkPlan): Option[SparkPlan] = plan match { + case _: CometBroadcastExchangeExec => Some(plan) + case stage: BroadcastQueryStageExec => nativeBroadcastInput(stage.plan).map(_ => stage) + case reuse: ReusedExchangeExec => nativeBroadcastInput(reuse.child).map(_ => reuse) + case sink: CometSinkPlaceHolder => nativeBroadcastInput(sink.child) + case wrapper: CometScanWrapper => nativeBroadcastInput(wrapper.originalPlan) + case _ => None + } + + private def restoreBroadcast(plan: SparkPlan, reason: String): SparkPlan = + nativeBroadcastInput(plan) + .map { input => + // Spark joins need a HashedRelation (or rows for a nested-loop join), not Arrow buffers. + // The existing transition decodes the cached broadcast and applies its Spark broadcast + // mode, including through AQE/reuse wrappers, without re-executing the build input. + val restored = CometColumnarToRowExec(input) + restored.setTagValue(sparkEvaluation, reason) + copyLogicalLinks(plan, restored) + restored + } + .getOrElse(plan) + + /** + * Run before bottom-up conversion and join rewriting. Reasons propagate back to the consuming + * operator, keeping the row pipeline together instead of inserting an eager Arrow batch between + * a throwing projection and its lazy consumer. Exchanges materialize their input independently; + * local sorts and aggregates do so only after their consumer requests input. + */ + def preserve(plan: SparkPlan): SparkPlan = { + if (!enabled(plan)) return plan + + def visit( + node: SparkPlan, + rowDemand: Option[String], + projectionDemand: Option[ProjectionDemand]): (SparkPlan, Option[String], AttributeSet) = { + node match { + // Materialized stages are independent producers. Their plans have already been guarded. + case _: QueryStageExec | _: ReusedExchangeExec => return (node, None, AttributeSet.empty) + // These wrappers do not have the child shape of their original Spark operator. + case wrapper: CometScanWrapper => + val (child, childReason, dateOutputs) = + visit(wrapper.originalPlan, rowDemand, projectionDemand) + return if (childReason.isDefined) (child, childReason, dateOutputs) + else (wrapper.copy(originalPlan = child), None, dateOutputs) + case sink: CometSinkPlaceHolder => + val (child, childReason, dateOutputs) = visit(sink.child, rowDemand, projectionDemand) + return if (childReason.isDefined) (child, childReason, dateOutputs) + else (sink.withNewChildren(Seq(child)), None, dateOutputs) + case _ => + } + + val original = node match { + case scan: CometScanExec => + scan.wrapped.copy( + partitionFilters = scan.partitionFilters, + dataFilters = scan.dataFilters) + case scan: CometNativeScanExec => scan.sparkFallback(Nil) + case native: CometExec => native.originalPlan + case shuffle: CometShuffleExchangeExec => shuffle.originalPlan + case broadcast: CometBroadcastExchangeExec => broadcast.originalPlan + case _ => node + } + val evaluatesDate = containsMakeDate(original.expressions) + val exchange = original.isInstanceOf[Exchange] + val join = original.isInstanceOf[BaseJoinExec] + // Broadcast joins can inline streamed expressions into their consumer. Their build side + // materializes rows; shuffled hash and sort-merge joins also isolate the streamed input. + val streamedChildIndex = original match { + case hash: BroadcastHashJoinExec if hash.supportCodegen => + Some(if (hash.buildSide == BuildLeft) 1 else 0) + case nestedLoop: BroadcastNestedLoopJoinExec if nestedLoop.supportCodegen => + Some(if (nestedLoop.buildSide == BuildLeft) 1 else 0) + case _ => None + } + val localMaterialization = original match { + case _: SortExec | _: HashAggregateExec | _: ObjectHashAggregateExec => true + case _: TakeOrderedAndProjectExec => true + case _ => false + } + val startsLimit = original match { + case _: CollectLimitExec | _: LocalLimitExec | _: GlobalLimitExec => true + case topK: TakeOrderedAndProjectExec => + SortOrder.orderingSatisfies(topK.child.outputOrdering, topK.sortOrder) + case _ + if ShimCometWindowGroupLimit.windowGroupLimitClass.exists(_.isInstance(original)) => + true + case _ => false + } + val childDemand = original match { + case _ if exchange => None + // A join can leave a local sort or aggregate completely unpolled. + case _ if join || rowDemand.contains("JOIN") => Some("JOIN") + case _ if startsLimit => Some("LIMIT") + case _: SampleExec => Some("SAMPLE") + case _: MapPartitionsExec => Some("a mapPartitions function") + case _ if localMaterialization => None + case _ => rowDemand + } + val childProjectionDemand = original match { + // Generated filters can defer deterministic projection outputs until a row is accepted. + case filter: FilterExec => + Some( + ProjectionDemand( + "FILTER", + filter.child.outputSet, + projectionDemand.map(_.guardedInputs).getOrElse(AttributeSet.empty))) + case project: ProjectExec => + val deferred = projectionDemand.map(_.deferred).getOrElse(AttributeSet.empty) + val eager = project.projectList + .filter(output => !output.deterministic || !deferred.contains(output.toAttribute)) + .flatMap(eagerReferences) + // ProjectExec forces repeated inputs and nondeterministic outputs. Other inputs can + // remain inlined in a consumer's conditional, even across intervening aliases. + val skipped = project.child.outputSet -- project.usedInputs -- AttributeSet(eager) + val inheritedInputs = + projectionDemand.map(_.guardedInputs).getOrElse(AttributeSet.empty) + // A consumer can require the date but still skip another output of this projection. + val guardedOutputs = inheritedInputs ++ + (if (evaluatesDate) deferred else AttributeSet.empty) + val inputsToGuard = AttributeSet(project.projectList.flatMap { output => + val direct = output.collect { case date: MakeDate => date }.flatMap(_.references) + // Follow aliases to the computation, which need not itself contain make_date. + val inherited = + if ((output.deterministic || rowDemand.isDefined) && + guardedOutputs.contains(output.toAttribute)) { + output.references.toSeq + } else { + Nil + } + direct ++ inherited + }) + // A lazy row consumer can skip even the date's required arguments on unread rows. + val guardedChildInputs = + inputsToGuard.intersect(if (rowDemand.isDefined) project.child.outputSet else skipped) Review Comment: [P2] An unmatched broadcast-join probe row can throw `CAST_INVALID_INPUT` before the join discards it. With ANSI mode and whole-stage codegen enabled, take Parquet probe rows `(k, s) = (1, '2024'), (2, 'bad')` and a broadcast table `b` containing only key `1`. In `SELECT /*+ BROADCAST(b) */ p.r, p.r + 1, make_date(p.y, 1, 1) FROM (SELECT k, rand(7) AS r, CAST(s AS INT) AS y FROM t) p JOIN b ON p.k = b.k`, Spark needs `y` only for the matching row and returns January 1, 2024. The new join logic forwards guarded inputs, but the upper projection has already removed `y` by intersecting with `skipped`: the year is required for every *output* row. The lower projection can therefore cast `'bad'` on an unmatched input row. Carry direct date inputs to the streamed side when the join can discard rows, guarding their producers unless the join itself requires those inputs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
