-
Notifications
You must be signed in to change notification settings - Fork 625
[GLUTEN-12013][VL] Fix bloom-filter bytes corruption on whole-stage AQE fallback #12151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
brijrajk
wants to merge
1
commit into
apache:main
Choose a base branch
from
brijrajk:fix/12013-bloom-filter-stage-fallback
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
...ends-velox/src/main/scala/org/apache/gluten/extension/RuntimeBloomFilterRewriteRule.scala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * 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.gluten.extension | ||
|
|
||
| import org.apache.gluten.config.GlutenConfig | ||
| import org.apache.gluten.expression.VeloxBloomFilterMightContain | ||
| import org.apache.gluten.expression.aggregate.VeloxBloomFilterAggregate | ||
|
|
||
| import org.apache.spark.sql.SparkSession | ||
| import org.apache.spark.sql.catalyst.expressions.{BloomFilterMightContain, XxHash64} | ||
| import org.apache.spark.sql.catalyst.expressions.aggregate.{AggregateExpression, BloomFilterAggregate} | ||
| import org.apache.spark.sql.catalyst.rules.Rule | ||
| import org.apache.spark.sql.execution.SparkPlan | ||
|
|
||
| /** | ||
| * Physical pre-transform rule that rewrites runtime-filter bloom filters (the ones injected by | ||
| * Spark's `InjectRuntimeFilter` optimizer rule) to their Velox variants so they offload natively. | ||
| * | ||
| * Runtime bloom filters cannot be handled by [[BloomFilterMightContainJointRewriteRule]]: that rule | ||
| * is registered via `injectOptimizerRule`, which lands in Spark's Operator Optimization batch, | ||
| * while `InjectRuntimeFilter` runs in a later batch of `SparkOptimizer`. The runtime-filter | ||
| * expressions therefore do not exist yet when the logical rule fires, and a physical-level rewrite | ||
| * (as was always done before the logical rule was introduced) is required to keep | ||
| * `FilterExecTransformer` and the bloom-filter aggregate native. | ||
| * | ||
| * The rewrite is restricted to `InjectRuntimeFilter`'s exact expression shapes, which always wrap | ||
| * the key in [[XxHash64]] on both the producer and the consumer side: | ||
| * - producer: `bloom_filter_agg(xxhash64(key), ...)` -> `velox_bloom_filter_agg(...)` | ||
| * - consumer: `might_contain(bf, xxhash64(key))` -> `velox_might_contain(...)` | ||
| * | ||
| * Because each side is identifiable on its own, both are rewritten consistently to the Velox byte | ||
| * format (version=1) even when AQE compiles the bloom-filter subquery separately from the consuming | ||
| * filter stage. The `XxHash64` fingerprint also guarantees the other bloom-filter populations are | ||
| * never touched: | ||
| * - `DataFrame.stat.bloomFilter()` builds `bloom_filter_agg(col, ...)` on the raw column (no | ||
| * `XxHash64` wrapper) and deserializes the result with Spark's `BloomFilter.readFrom`, so its | ||
| * bytes must stay in Spark-native format. | ||
| * - User-facing `might_contain(<scalar subquery>, <value>)` pairs are already rewritten at the | ||
| * logical level by [[BloomFilterMightContainJointRewriteRule]] (the GLUTEN-12013 fix), making | ||
| * this rule a no-op for them. | ||
| * - Literal-value pairs (SPARK-54336) contain no `XxHash64` and stay fully vanilla. | ||
| */ | ||
| case class RuntimeBloomFilterRewriteRule(spark: SparkSession) extends Rule[SparkPlan] { | ||
| override def apply(plan: SparkPlan): SparkPlan = { | ||
| if (!GlutenConfig.get.enableNativeBloomFilter) { | ||
| return plan | ||
| } | ||
| plan.transformWithSubqueries { | ||
| case p => | ||
| p.transformExpressions { | ||
| case ae @ AggregateExpression(b: BloomFilterAggregate, _, _, _, _) | ||
| if b.child.isInstanceOf[XxHash64] => | ||
| ae.copy(aggregateFunction = VeloxBloomFilterAggregate( | ||
| b.child, | ||
| b.estimatedNumItemsExpression, | ||
| b.numBitsExpression, | ||
| b.mutableAggBufferOffset, | ||
| b.inputAggBufferOffset)) | ||
| case BloomFilterMightContain(bf, value: XxHash64) => | ||
| VeloxBloomFilterMightContain(bf, value) | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the early-exit
if (!GlutenConfig.get.enableNativeBloomFilter) return planis untested. Can we add a test case?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a test that sets
spark.gluten.sql.native.bloomFilter=falseand checks the query still returns the correct count and the optimized plan does not containvelox_might_contain.