This is an automated email from the ASF dual-hosted git repository.
ulyssesyou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new 38d7e109b [CORE] Add custom cost evaluator for optimize buildSide of
shuffled hash join (#6143)
38d7e109b is described below
commit 38d7e109bf3daa4af634639d8b4ffc3ac6773b60
Author: Mingliang Zhu <[email protected]>
AuthorDate: Thu Jun 20 11:10:02 2024 +0800
[CORE] Add custom cost evaluator for optimize buildSide of shuffled hash
join (#6143)
---
.../scala/org/apache/gluten/GlutenPlugin.scala | 6 +++
.../scala/org/apache/gluten/GlutenConfig.scala | 15 ++++++++
.../spark/sql/execution/adaptive/GlutenCost.scala | 43 ++++++++++++++++++++++
.../execution/adaptive/GlutenCostEvaluator.scala | 32 ++++++++++++++++
.../execution/adaptive/GlutenCostEvaluator.scala | 35 ++++++++++++++++++
.../execution/adaptive/GlutenCostEvaluator.scala | 35 ++++++++++++++++++
.../execution/adaptive/GlutenCostEvaluator.scala | 35 ++++++++++++++++++
7 files changed, 201 insertions(+)
diff --git a/gluten-core/src/main/scala/org/apache/gluten/GlutenPlugin.scala
b/gluten-core/src/main/scala/org/apache/gluten/GlutenPlugin.scala
index cafed66eb..2860e3ced 100644
--- a/gluten-core/src/main/scala/org/apache/gluten/GlutenPlugin.scala
+++ b/gluten-core/src/main/scala/org/apache/gluten/GlutenPlugin.scala
@@ -143,6 +143,12 @@ private[gluten] class GlutenDriverPlugin extends
DriverPlugin with Logging {
}
conf.set(SPARK_SESSION_EXTS_KEY, extensions)
+ // adaptive custom cost evaluator class
+ if (GlutenConfig.getConf.enableGluten &&
GlutenConfig.getConf.enableGlutenCostEvaluator) {
+ val costEvaluator =
"org.apache.spark.sql.execution.adaptive.GlutenCostEvaluator"
+ conf.set(SQLConf.ADAPTIVE_CUSTOM_COST_EVALUATOR_CLASS.key, costEvaluator)
+ }
+
// check memory off-heap enabled and size
val minOffHeapSize = "1MB"
if (
diff --git a/shims/common/src/main/scala/org/apache/gluten/GlutenConfig.scala
b/shims/common/src/main/scala/org/apache/gluten/GlutenConfig.scala
index eb6118ffc..462032488 100644
--- a/shims/common/src/main/scala/org/apache/gluten/GlutenConfig.scala
+++ b/shims/common/src/main/scala/org/apache/gluten/GlutenConfig.scala
@@ -437,6 +437,8 @@ class GlutenConfig(conf: SQLConf) extends Logging {
def enableCastAvgAggregateFunction: Boolean =
conf.getConf(COLUMNAR_NATIVE_CAST_AGGREGATE_ENABLED)
+ def enableGlutenCostEvaluator: Boolean = conf.getConf(COST_EVALUATOR_ENABLED)
+
def dynamicOffHeapSizingEnabled: Boolean =
conf.getConf(DYNAMIC_OFFHEAP_SIZING_ENABLED)
@@ -595,6 +597,8 @@ object GlutenConfig {
val GLUTEN_DYNAMIC_OFFHEAP_SIZING_MEMORY_FRACTION =
"spark.gluten.memory.dynamic.offHeap.sizing.memory.fraction"
+ val GLUTEN_COST_EVALUATOR_ENABLED =
"spark.gluten.sql.adaptive.costEvaluator.enabled"
+
var ins: GlutenConfig = _
def getConf: GlutenConfig = {
@@ -1962,6 +1966,17 @@ object GlutenConfig {
.booleanConf
.createWithDefault(true)
+ val COST_EVALUATOR_ENABLED =
+ buildConf(GlutenConfig.GLUTEN_COST_EVALUATOR_ENABLED)
+ .internal()
+ .doc(
+ "If true and gluten enabled, use " +
+ "org.apache.spark.sql.execution.adaptive.GlutenCostEvaluator as
custom cost " +
+ "evaluator class, else follow the configuration " +
+ "spark.sql.adaptive.customCostEvaluatorClass.")
+ .booleanConf
+ .createWithDefault(true)
+
val DYNAMIC_OFFHEAP_SIZING_ENABLED =
buildConf(GlutenConfig.GLUTEN_DYNAMIC_OFFHEAP_SIZING_ENABLED)
.internal()
diff --git
a/shims/common/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCost.scala
b/shims/common/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCost.scala
new file mode 100644
index 000000000..9436f469b
--- /dev/null
+++
b/shims/common/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCost.scala
@@ -0,0 +1,43 @@
+/*
+ * 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.spark.sql.execution.adaptive
+
+import org.apache.spark.sql.errors.QueryExecutionErrors
+import org.apache.spark.sql.execution.SparkPlan
+
+class GlutenCost(val eval: CostEvaluator, val plan: SparkPlan) extends Cost {
+ override def compare(that: Cost): Int = that match {
+ case that: GlutenCost if plan eq that.plan =>
+ 0
+ case that: GlutenCost if plan == that.plan =>
+ // Plans are identical. Considers the newer one as having lower cost.
+ -(plan.id - that.plan.id)
+ case that: GlutenCost =>
+ // Plans are different. Use the delegated cost evaluator.
+ assert(eval == that.eval)
+ eval.evaluateCost(plan).compare(eval.evaluateCost(that.plan))
+ case _ =>
+ throw
QueryExecutionErrors.cannotCompareCostWithTargetCostError(that.toString)
+ }
+
+ override def hashCode(): Int = throw new UnsupportedOperationException()
+
+ override def equals(obj: Any): Boolean = obj match {
+ case that: Cost => compare(that) == 0
+ case _ => false
+ }
+}
diff --git
a/shims/spark32/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
b/shims/spark32/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
new file mode 100644
index 000000000..a6f066462
--- /dev/null
+++
b/shims/spark32/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
@@ -0,0 +1,32 @@
+/*
+ * 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.spark.sql.execution.adaptive
+
+import org.apache.gluten.GlutenConfig
+
+import org.apache.spark.sql.execution.SparkPlan
+
+/** This [[CostEvaluator]] is to force use the new physical plan when cost is
equal. */
+case class GlutenCostEvaluator() extends CostEvaluator {
+ override def evaluateCost(plan: SparkPlan): Cost = {
+ if (GlutenConfig.getConf.enableGluten) {
+ new GlutenCost(SimpleCostEvaluator, plan)
+ } else {
+ SimpleCostEvaluator.evaluateCost(plan)
+ }
+ }
+}
diff --git
a/shims/spark33/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
b/shims/spark33/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
new file mode 100644
index 000000000..8fcfa735f
--- /dev/null
+++
b/shims/spark33/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
@@ -0,0 +1,35 @@
+/*
+ * 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.spark.sql.execution.adaptive
+
+import org.apache.gluten.GlutenConfig
+
+import org.apache.spark.sql.catalyst.SQLConfHelper
+import org.apache.spark.sql.execution.SparkPlan
+import org.apache.spark.sql.internal.SQLConf
+
+/** This [[CostEvaluator]] is to force use the new physical plan when cost is
equal. */
+case class GlutenCostEvaluator() extends CostEvaluator with SQLConfHelper {
+ override def evaluateCost(plan: SparkPlan): Cost = {
+ val forceOptimizeSkewedJoin =
conf.getConf(SQLConf.ADAPTIVE_FORCE_OPTIMIZE_SKEWED_JOIN)
+ if (GlutenConfig.getConf.enableGluten) {
+ new GlutenCost(SimpleCostEvaluator(forceOptimizeSkewedJoin), plan)
+ } else {
+ SimpleCostEvaluator(forceOptimizeSkewedJoin).evaluateCost(plan)
+ }
+ }
+}
diff --git
a/shims/spark34/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
b/shims/spark34/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
new file mode 100644
index 000000000..8fcfa735f
--- /dev/null
+++
b/shims/spark34/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
@@ -0,0 +1,35 @@
+/*
+ * 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.spark.sql.execution.adaptive
+
+import org.apache.gluten.GlutenConfig
+
+import org.apache.spark.sql.catalyst.SQLConfHelper
+import org.apache.spark.sql.execution.SparkPlan
+import org.apache.spark.sql.internal.SQLConf
+
+/** This [[CostEvaluator]] is to force use the new physical plan when cost is
equal. */
+case class GlutenCostEvaluator() extends CostEvaluator with SQLConfHelper {
+ override def evaluateCost(plan: SparkPlan): Cost = {
+ val forceOptimizeSkewedJoin =
conf.getConf(SQLConf.ADAPTIVE_FORCE_OPTIMIZE_SKEWED_JOIN)
+ if (GlutenConfig.getConf.enableGluten) {
+ new GlutenCost(SimpleCostEvaluator(forceOptimizeSkewedJoin), plan)
+ } else {
+ SimpleCostEvaluator(forceOptimizeSkewedJoin).evaluateCost(plan)
+ }
+ }
+}
diff --git
a/shims/spark35/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
b/shims/spark35/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
new file mode 100644
index 000000000..8fcfa735f
--- /dev/null
+++
b/shims/spark35/src/main/scala/org/apache/spark/sql/execution/adaptive/GlutenCostEvaluator.scala
@@ -0,0 +1,35 @@
+/*
+ * 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.spark.sql.execution.adaptive
+
+import org.apache.gluten.GlutenConfig
+
+import org.apache.spark.sql.catalyst.SQLConfHelper
+import org.apache.spark.sql.execution.SparkPlan
+import org.apache.spark.sql.internal.SQLConf
+
+/** This [[CostEvaluator]] is to force use the new physical plan when cost is
equal. */
+case class GlutenCostEvaluator() extends CostEvaluator with SQLConfHelper {
+ override def evaluateCost(plan: SparkPlan): Cost = {
+ val forceOptimizeSkewedJoin =
conf.getConf(SQLConf.ADAPTIVE_FORCE_OPTIMIZE_SKEWED_JOIN)
+ if (GlutenConfig.getConf.enableGluten) {
+ new GlutenCost(SimpleCostEvaluator(forceOptimizeSkewedJoin), plan)
+ } else {
+ SimpleCostEvaluator(forceOptimizeSkewedJoin).evaluateCost(plan)
+ }
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
