-
Notifications
You must be signed in to change notification settings - Fork 28.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-23711][SQL] Add fallback generator for UnsafeProjection
## What changes were proposed in this pull request? Add fallback logic for `UnsafeProjection`. In production we can try to create unsafe projection using codegen implementation. Once any compile error happens, it fallbacks to interpreted implementation. ## How was this patch tested? Added test. Author: Liang-Chi Hsieh <viirya@gmail.com> Closes #21106 from viirya/SPARK-23711.
- Loading branch information
Showing
9 changed files
with
230 additions
and
88 deletions.
There are no files selected for viewing
73 changes: 73 additions & 0 deletions
73
...cala/org/apache/spark/sql/catalyst/expressions/CodeGeneratorWithInterpretedFallback.scala
This file contains 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,73 @@ | ||
/* | ||
* 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.catalyst.expressions | ||
|
||
import org.codehaus.commons.compiler.CompileException | ||
import org.codehaus.janino.InternalCompilerException | ||
|
||
import org.apache.spark.TaskContext | ||
import org.apache.spark.sql.internal.SQLConf | ||
import org.apache.spark.util.Utils | ||
|
||
/** | ||
* Catches compile error during code generation. | ||
*/ | ||
object CodegenError { | ||
def unapply(throwable: Throwable): Option[Exception] = throwable match { | ||
case e: InternalCompilerException => Some(e) | ||
case e: CompileException => Some(e) | ||
case _ => None | ||
} | ||
} | ||
|
||
/** | ||
* Defines values for `SQLConf` config of fallback mode. Use for test only. | ||
*/ | ||
object CodegenObjectFactoryMode extends Enumeration { | ||
val FALLBACK, CODEGEN_ONLY, NO_CODEGEN = Value | ||
} | ||
|
||
/** | ||
* A codegen object generator which creates objects with codegen path first. Once any compile | ||
* error happens, it can fallbacks to interpreted implementation. In tests, we can use a SQL config | ||
* `SQLConf.CODEGEN_FACTORY_MODE` to control fallback behavior. | ||
*/ | ||
abstract class CodeGeneratorWithInterpretedFallback[IN, OUT] { | ||
|
||
def createObject(in: IN): OUT = { | ||
// We are allowed to choose codegen-only or no-codegen modes if under tests. | ||
val config = SQLConf.get.getConf(SQLConf.CODEGEN_FACTORY_MODE) | ||
val fallbackMode = CodegenObjectFactoryMode.withName(config) | ||
|
||
fallbackMode match { | ||
case CodegenObjectFactoryMode.CODEGEN_ONLY if Utils.isTesting => | ||
createCodeGeneratedObject(in) | ||
case CodegenObjectFactoryMode.NO_CODEGEN if Utils.isTesting => | ||
createInterpretedObject(in) | ||
case _ => | ||
try { | ||
createCodeGeneratedObject(in) | ||
} catch { | ||
case CodegenError(_) => createInterpretedObject(in) | ||
} | ||
} | ||
} | ||
|
||
protected def createCodeGeneratedObject(in: IN): OUT | ||
protected def createInterpretedObject(in: IN): OUT | ||
} |
This file contains 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 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 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
43 changes: 43 additions & 0 deletions
43
...org/apache/spark/sql/catalyst/expressions/CodeGeneratorWithInterpretedFallbackSuite.scala
This file contains 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,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.catalyst.expressions | ||
|
||
import org.apache.spark.SparkFunSuite | ||
import org.apache.spark.sql.catalyst.plans.PlanTestBase | ||
import org.apache.spark.sql.internal.SQLConf | ||
import org.apache.spark.sql.types.{IntegerType, LongType} | ||
|
||
class CodeGeneratorWithInterpretedFallbackSuite extends SparkFunSuite with PlanTestBase { | ||
|
||
test("UnsafeProjection with codegen factory mode") { | ||
val input = Seq(LongType, IntegerType) | ||
.zipWithIndex.map(x => BoundReference(x._2, x._1, true)) | ||
|
||
val codegenOnly = CodegenObjectFactoryMode.CODEGEN_ONLY.toString | ||
withSQLConf(SQLConf.CODEGEN_FACTORY_MODE.key -> codegenOnly) { | ||
val obj = UnsafeProjection.createObject(input) | ||
assert(obj.getClass.getName.contains("GeneratedClass$SpecificUnsafeProjection")) | ||
} | ||
|
||
val noCodegen = CodegenObjectFactoryMode.NO_CODEGEN.toString | ||
withSQLConf(SQLConf.CODEGEN_FACTORY_MODE.key -> noCodegen) { | ||
val obj = UnsafeProjection.createObject(input) | ||
assert(obj.isInstanceOf[InterpretedUnsafeProjection]) | ||
} | ||
} | ||
} |
This file contains 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 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
Oops, something went wrong.