-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Address comments and move threadpool
- Loading branch information
Showing
5 changed files
with
297 additions
and
5 deletions.
There are no files selected for viewing
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
118 changes: 118 additions & 0 deletions
118
...rg/apache/spark/sql/delta/util/threads/SparkThreadLocalForwardingThreadPoolExecutor.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,118 @@ | ||
| /* | ||
| * Copyright (2021) The Delta Lake Project Authors. | ||
| * | ||
| * Licensed 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.delta.util.threads | ||
|
|
||
| import java.util.Properties | ||
| import java.util.concurrent._ | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import org.apache.spark.{SparkContext, TaskContext} | ||
| import org.apache.spark.internal.Logging | ||
| import org.apache.spark.util.{Utils => SparkUtils} | ||
|
|
||
| /** | ||
| * Implementation of ThreadPoolExecutor that captures the Spark ThreadLocals present at submit time | ||
| * and inserts them into the thread before executing the provided runnable. | ||
| */ | ||
| class SparkThreadLocalForwardingThreadPoolExecutor( | ||
| corePoolSize: Int, | ||
| maximumPoolSize: Int, | ||
| keepAliveTime: Long, | ||
| unit: TimeUnit, | ||
| workQueue: BlockingQueue[Runnable], | ||
| threadFactory: ThreadFactory, | ||
| rejectedExecutionHandler: RejectedExecutionHandler = new ThreadPoolExecutor.AbortPolicy) | ||
| extends ThreadPoolExecutor( | ||
| corePoolSize, maximumPoolSize, keepAliveTime, | ||
| unit, workQueue, threadFactory, rejectedExecutionHandler) { | ||
|
|
||
| override def execute(command: Runnable): Unit = | ||
| super.execute(new SparkThreadLocalCapturingRunnable(command)) | ||
| } | ||
|
|
||
|
|
||
| trait SparkThreadLocalCapturingHelper extends Logging { | ||
| // At the time of creating this instance we capture the task context and command context. | ||
| val capturedTaskContext = TaskContext.get() | ||
| val sparkContext = SparkContext.getActive | ||
| // Capture an immutable threadsafe snapshot of the current local properties | ||
| val capturedProperties = sparkContext | ||
| .map(sc => CapturedSparkThreadLocals.toValuesArray( | ||
| SparkUtils.cloneProperties(sc.getLocalProperties))) | ||
|
|
||
| def runWithCaptured[T](body: => T): T = { | ||
| // Save the previous contexts, overwrite them with the captured contexts, and then restore the | ||
| // previous when execution completes. | ||
| // This has the unfortunate side effect of writing nulls to these thread locals if they were | ||
| // empty beforehand. | ||
| val previousTaskContext = TaskContext.get() | ||
| val previousProperties = sparkContext.map(_.getLocalProperties) | ||
|
|
||
| TaskContext.setTaskContext(capturedTaskContext) | ||
| for { | ||
| p <- capturedProperties | ||
| sc <- sparkContext | ||
| } { | ||
| sc.setLocalProperties(CapturedSparkThreadLocals.toProperties(p)) | ||
| } | ||
|
|
||
| try { | ||
| body | ||
| } catch { | ||
| case t: Throwable => | ||
| logError(s"Exception in thread ${Thread.currentThread().getName}", t) | ||
| throw t | ||
| } finally { | ||
| TaskContext.setTaskContext(previousTaskContext) | ||
| for { | ||
| p <- previousProperties | ||
| sc <- sparkContext | ||
| } { | ||
| sc.setLocalProperties(p) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class CapturedSparkThreadLocals extends SparkThreadLocalCapturingHelper | ||
|
|
||
| object CapturedSparkThreadLocals { | ||
| def apply(): CapturedSparkThreadLocals = { | ||
| new CapturedSparkThreadLocals() | ||
| } | ||
|
|
||
| def toProperties(props: Array[(String, String)]): Properties = { | ||
| val resultProps = new Properties() | ||
| for ((key, value) <- props) { | ||
| resultProps.put(key, value) | ||
| } | ||
| resultProps | ||
| } | ||
|
|
||
| def toValuesArray(props: Properties): Array[(String, String)] = { | ||
| props.asScala.toArray | ||
| } | ||
|
|
||
| } | ||
|
|
||
| class SparkThreadLocalCapturingRunnable(runnable: Runnable) | ||
| extends Runnable with SparkThreadLocalCapturingHelper { | ||
| override def run(): Unit = { | ||
| runWithCaptured(runnable.run()) | ||
| } | ||
| } |
152 changes: 152 additions & 0 deletions
152
.../test/scala/org/apache/spark/sql/delta/util/threads/SparkThreadLocalForwardingSuite.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,152 @@ | ||
| /* | ||
| * Copyright (2021) The Delta Lake Project Authors. | ||
| * | ||
| * Licensed 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.delta.util.threads | ||
|
|
||
| import java.util.Properties | ||
| import java.util.concurrent.{LinkedBlockingQueue, ThreadPoolExecutor, TimeUnit} | ||
|
|
||
| import scala.concurrent.{ExecutionContext, ExecutionContextExecutor, Future} | ||
| import scala.concurrent.duration._ | ||
|
|
||
| import org.apache.spark._ | ||
| import org.apache.spark.util.ThreadUtils | ||
| import org.apache.spark.util.ThreadUtils.namedThreadFactory | ||
|
|
||
| class SparkThreadLocalForwardingSuite extends SparkFunSuite { | ||
|
|
||
| private def createThreadPool(nThreads: Int, prefix: String): ThreadPoolExecutor = { | ||
| val threadFactory = namedThreadFactory(prefix) | ||
| val keepAliveTimeSeconds = 60 | ||
| val threadPool = new SparkThreadLocalForwardingThreadPoolExecutor( | ||
| nThreads, | ||
| nThreads, | ||
| keepAliveTimeSeconds, | ||
| TimeUnit.MILLISECONDS, | ||
| new LinkedBlockingQueue[Runnable], | ||
| threadFactory) | ||
| threadPool.allowCoreThreadTimeOut(true) | ||
| threadPool | ||
| } | ||
|
|
||
| test("SparkThreadLocalForwardingThreadPoolExecutor properly propagates" + | ||
| " TaskContext and Spark Local Properties") { | ||
| val sc = SparkContext.getOrCreate(new SparkConf().setAppName("test").setMaster("local")) | ||
| val executor = createThreadPool(1, "test-threads") | ||
| implicit val executionContext: ExecutionContextExecutor = | ||
| ExecutionContext.fromExecutor(executor) | ||
|
|
||
| val prevTaskContext = TaskContext.get() | ||
| try { | ||
| // assert that each instance of submitting a task to the execution context captures the | ||
| // current task context | ||
| val futures = (1 to 10) map { i => | ||
| setTaskAndProperties(i, sc) | ||
|
|
||
| Future { | ||
| checkTaskAndProperties(i, sc) | ||
| }(executionContext) | ||
| } | ||
|
|
||
| assert(ThreadUtils.awaitResult(Future.sequence(futures), 10.seconds).forall(identity)) | ||
| } finally { | ||
| ThreadUtils.shutdown(executor) | ||
| TaskContext.setTaskContext(prevTaskContext) | ||
| sc.stop() | ||
| } | ||
| } | ||
|
|
||
| def makeTaskContext(id: Int): TaskContext = { | ||
| new TaskContextImpl(id, 0, 0, 0, attemptNumber = 45613, 0, null, new Properties(), null) | ||
| } | ||
|
|
||
| def setTaskAndProperties(i: Int, sc: SparkContext = SparkContext.getActive.get): Unit = { | ||
| val tc = makeTaskContext(i) | ||
| TaskContext.setTaskContext(tc) | ||
| sc.setLocalProperty("test", i.toString) | ||
| } | ||
|
|
||
| def checkTaskAndProperties(i: Int, sc: SparkContext = SparkContext.getActive.get): Boolean = { | ||
| TaskContext.get() != null && | ||
| TaskContext.get().stageId() == i && | ||
| sc.getLocalProperty("test") == i.toString | ||
| } | ||
|
|
||
| test("That CapturedSparkThreadLocals properly restores the existing state") { | ||
| val sc = SparkContext.getOrCreate(new SparkConf().setAppName("test").setMaster("local")) | ||
| val prevTaskContext = TaskContext.get() | ||
| try { | ||
| setTaskAndProperties(10) | ||
| val capturedSparkThreadLocals = CapturedSparkThreadLocals() | ||
| setTaskAndProperties(11) | ||
| assert(!checkTaskAndProperties(10, sc)) | ||
| assert(checkTaskAndProperties(11, sc)) | ||
| capturedSparkThreadLocals.runWithCaptured { | ||
| assert(checkTaskAndProperties(10, sc)) | ||
| } | ||
| assert(checkTaskAndProperties(11, sc)) | ||
| } finally { | ||
| TaskContext.setTaskContext(prevTaskContext) | ||
| sc.stop() | ||
| } | ||
| } | ||
|
|
||
| test("That CapturedSparkThreadLocals properly restores the existing spark properties." + | ||
| " Changes to local properties inside a task do not affect the original properties") { | ||
| val sc = SparkContext.getOrCreate(new SparkConf().setAppName("test").setMaster("local")) | ||
| try { | ||
| sc.setLocalProperty("TestProp", "1") | ||
| val capturedSparkThreadLocals = CapturedSparkThreadLocals() | ||
| assert(sc.getLocalProperty("TestProp") == "1") | ||
| capturedSparkThreadLocals.runWithCaptured { | ||
| sc.setLocalProperty("TestProp", "2") | ||
| assert(sc.getLocalProperty("TestProp") == "2") | ||
| } | ||
| assert(sc.getLocalProperty("TestProp") == "1") | ||
| } finally { | ||
| sc.stop() | ||
| } | ||
| } | ||
|
|
||
|
|
||
| test("captured spark thread locals are immutable") { | ||
| val sc = SparkContext.getOrCreate(new SparkConf().setAppName("test").setMaster("local")) | ||
| try { | ||
| sc.setLocalProperty("test1", "good") | ||
| sc.setLocalProperty("test2", "good") | ||
| val threadLocals = CapturedSparkThreadLocals() | ||
| sc.setLocalProperty("test2", "bad") | ||
| assert(sc.getLocalProperty("test1") == "good") | ||
| assert(sc.getLocalProperty("test2") == "bad") | ||
| threadLocals.runWithCaptured { | ||
| assert(sc.getLocalProperty("test1") == "good") | ||
| assert(sc.getLocalProperty("test2") == "good") | ||
| sc.setLocalProperty("test1", "bad") | ||
| sc.setLocalProperty("test2", "maybe") | ||
| assert(sc.getLocalProperty("test1") == "bad") | ||
| assert(sc.getLocalProperty("test2") == "maybe") | ||
| } | ||
| assert(sc.getLocalProperty("test1") == "good") | ||
| assert(sc.getLocalProperty("test2") == "bad") | ||
| threadLocals.runWithCaptured { | ||
| assert(sc.getLocalProperty("test1") == "good") | ||
| assert(sc.getLocalProperty("test2") == "good") | ||
| } | ||
| } finally { | ||
| sc.stop() | ||
| } | ||
| } | ||
| } |