HeartSaVioR commented on code in PR #56008: URL: https://github.com/apache/spark/pull/56008#discussion_r3301391117
########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return ShuffleLocationResponse which contains a map shuffle writer task locations and the + * total number of shuffle writers to expect. + */ + def getAvailableShuffleWriterTaskLocations(shuffleId: Int): Option[ShuffleLocationResponse] +} + +private[spark] case class StreamingShuffleInfo(numMaps: Int, numReduces: Int, jobId: Int) + +class StreamingShuffleOutputTrackerMaster(conf: SparkConf) + extends StreamingShuffleOutputTracker(conf) { + + // map that stores task location information organized in the following fashion + // shuffle id -> {mapId -> location} + private val taskLocations = + new ConcurrentHashMap[Int, ConcurrentHashMap[Long, StreamingShuffleTaskLocation]]() + + private val shuffleInfos = new ConcurrentHashMap[Int, StreamingShuffleInfo]() + + private val trackerMasterMessages = + new LinkedBlockingQueue[StreamingShuffleTaskLocationTrackerMasterMessage] + + // Thread pool used for handling map output status requests. This is a separate thread pool + // to ensure we don't block the normal dispatcher threads. + private val threadpool: ThreadPoolExecutor = { + val numThreads = conf.get(SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS) + val pool = + ThreadUtils.newDaemonFixedThreadPool(numThreads, "streaming-shuffle-location-dispatcher") + for (i <- 0 until numThreads) { + pool.execute(new MessageLoop) + } + pool + } + + def registerShuffle(shuffleId: Int, numMaps: Int, numReduces: Int, jobId: Int): Unit = { + logInfo(log"Registering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} with ${ + MDC(LogKeys.NUM_MAPPERS, numMaps)} mappers and ${ + MDC(LogKeys.NUM_REDUCERS, numReduces)} reducers") + shuffleInfos.put(shuffleId, StreamingShuffleInfo(numMaps, numReduces, jobId)) + } + + // for testing purposes + private[spark] def getShuffleInfo(shuffleId: Int): Option[StreamingShuffleInfo] = { + Option(shuffleInfos.get(shuffleId)) + } + + override def unregisterShuffle(shuffleId: Int): Unit = { + logInfo(log"Unregistering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)}") + + if (!shuffleInfos.containsKey(shuffleId)) { + logWarning(log"Attempting to unregister a shuffle with id ${ + MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered") + } + taskLocations.remove(shuffleId) + shuffleInfos.remove(shuffleId) + } + + def post(message: StreamingShuffleTaskLocationTrackerMasterMessage): Unit = { + trackerMasterMessages.offer(message) + } + + /** Message loop used for dispatching messages. */ + private class MessageLoop extends Runnable { + + override def run(): Unit = { + try { + while (true) { + try { + val data = trackerMasterMessages.take() + if (data == PoisonPill) { + // Put PoisonPill back so that other MessageLoops can see it. + trackerMasterMessages.offer(PoisonPill) + return + } + + data match { + case GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAllShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAvailableShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId, + mapId, + location, + context) => + context.reply(registerShuffleWriterTask(shuffleId, mapId, location)) + + } + } catch { + case NonFatal(e) => logError(e.getMessage, e) + } + } + } catch { + case ie: InterruptedException => // exit + } + } + } + + /** A poison endpoint that indicates MessageLoop should exit its message loop. */ + private val PoisonPill = + GetAllStreamingShuffleTaskLocationsMasterMessage(-99, null) + + override def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean = { + if (!shuffleInfos.containsKey(shuffleId)) { + logWarning( + log"Attempting to register shuffle writer task for shuffle with id ${ + MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered. Map id ${ + MDC(LogKeys.MAP_ID, mapId)}} location ${MDC(LogKeys.TASK_LOCATION, location)}}") Review Comment: ```suggestion MDC(LogKeys.MAP_ID, mapId)} location ${MDC(LogKeys.TASK_LOCATION, location)}") ``` ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return ShuffleLocationResponse which contains a map shuffle writer task locations and the + * total number of shuffle writers to expect. + */ + def getAvailableShuffleWriterTaskLocations(shuffleId: Int): Option[ShuffleLocationResponse] +} + +private[spark] case class StreamingShuffleInfo(numMaps: Int, numReduces: Int, jobId: Int) + +class StreamingShuffleOutputTrackerMaster(conf: SparkConf) + extends StreamingShuffleOutputTracker(conf) { + + // map that stores task location information organized in the following fashion + // shuffle id -> {mapId -> location} + private val taskLocations = + new ConcurrentHashMap[Int, ConcurrentHashMap[Long, StreamingShuffleTaskLocation]]() + + private val shuffleInfos = new ConcurrentHashMap[Int, StreamingShuffleInfo]() + + private val trackerMasterMessages = + new LinkedBlockingQueue[StreamingShuffleTaskLocationTrackerMasterMessage] + + // Thread pool used for handling map output status requests. This is a separate thread pool + // to ensure we don't block the normal dispatcher threads. + private val threadpool: ThreadPoolExecutor = { + val numThreads = conf.get(SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS) + val pool = + ThreadUtils.newDaemonFixedThreadPool(numThreads, "streaming-shuffle-location-dispatcher") + for (i <- 0 until numThreads) { + pool.execute(new MessageLoop) + } + pool + } + + def registerShuffle(shuffleId: Int, numMaps: Int, numReduces: Int, jobId: Int): Unit = { + logInfo(log"Registering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} with ${ + MDC(LogKeys.NUM_MAPPERS, numMaps)} mappers and ${ + MDC(LogKeys.NUM_REDUCERS, numReduces)} reducers") + shuffleInfos.put(shuffleId, StreamingShuffleInfo(numMaps, numReduces, jobId)) + } + + // for testing purposes + private[spark] def getShuffleInfo(shuffleId: Int): Option[StreamingShuffleInfo] = { + Option(shuffleInfos.get(shuffleId)) + } + + override def unregisterShuffle(shuffleId: Int): Unit = { + logInfo(log"Unregistering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)}") + + if (!shuffleInfos.containsKey(shuffleId)) { + logWarning(log"Attempting to unregister a shuffle with id ${ + MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered") + } + taskLocations.remove(shuffleId) + shuffleInfos.remove(shuffleId) + } + + def post(message: StreamingShuffleTaskLocationTrackerMasterMessage): Unit = { + trackerMasterMessages.offer(message) + } + + /** Message loop used for dispatching messages. */ + private class MessageLoop extends Runnable { + + override def run(): Unit = { + try { + while (true) { + try { + val data = trackerMasterMessages.take() + if (data == PoisonPill) { + // Put PoisonPill back so that other MessageLoops can see it. + trackerMasterMessages.offer(PoisonPill) + return + } + + data match { + case GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAllShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAvailableShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId, + mapId, + location, + context) => + context.reply(registerShuffleWriterTask(shuffleId, mapId, location)) + + } + } catch { + case NonFatal(e) => logError(e.getMessage, e) Review Comment: ```suggestion case NonFatal(e) => logError(log"${MDC(ERROR, e.getMessage)}", e) ``` This should be structured logging - see MapOutputTracker.MessageLoop. ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} Review Comment: ```suggestion import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} ``` nit: normally we have a blank line between package and import ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return ShuffleLocationResponse which contains a map shuffle writer task locations and the + * total number of shuffle writers to expect. + */ + def getAvailableShuffleWriterTaskLocations(shuffleId: Int): Option[ShuffleLocationResponse] +} + +private[spark] case class StreamingShuffleInfo(numMaps: Int, numReduces: Int, jobId: Int) + +class StreamingShuffleOutputTrackerMaster(conf: SparkConf) Review Comment: ```suggestion private[spark] class StreamingShuffleOutputTrackerMaster(conf: SparkConf) ``` nit: It's not a must, but probably good to be consistent (since we have several classes as package private). ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks Review Comment: ```suggestion * @param shuffleId The id of the shuffle to get the location information about writer tasks ``` ########## core/src/test/scala/org/apache/spark/StreamingShuffleOutputTrackerSuite.scala: ########## @@ -0,0 +1,323 @@ +/* + * 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 + +import org.scalatest.BeforeAndAfter +import org.scalatest.matchers.should.Matchers + +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.RpcEnv + +class StreamingShuffleOutputTrackerSuite + extends SparkFunSuite + with LocalSparkContext + with ThreadAudit + with BeforeAndAfter + with Matchers { + + before { + doThreadPreAudit() + } + + after { + doThreadPostAudit() + } + + protected val conf = new SparkConf + + protected def newTrackerMaster(sparkConf: SparkConf = conf) = { + new StreamingShuffleOutputTrackerMaster(sparkConf) + } + + protected def newTrackerWorker( + sparkConf: SparkConf = conf): StreamingShuffleOutputTrackerWorker = { + new StreamingShuffleOutputTrackerWorker(sparkConf) + } + + def createRpcEnv( + name: String, + host: String = "localhost", + port: Int = 0, + securityManager: SecurityManager = new SecurityManager(conf)): RpcEnv = { + RpcEnv.create(name, host, port, conf, securityManager) + } + + test("master start and stop") { + val rpcEnv = createRpcEnv("test") + val tracker = newTrackerMaster() + tracker.trackerEndpoint = rpcEnv.setupEndpoint( + StreamingShuffleOutputTracker.ENDPOINT_NAME, + new StreamingShuffleOutputTrackerMasterEndpoint(rpcEnv, tracker, conf)) + tracker.stop() + rpcEnv.shutdown() + } + + test("test tracker workflow") { + val master = newTrackerMaster() + val worker = newTrackerWorker() + + val rpcEnv = createRpcEnv("test") Review Comment: This RpcEnv doesn't seem to be cleaned up (shutdown). Same with other test cases. (Some test cases do the shutdown, like the above one.) ########## core/src/test/scala/org/apache/spark/StreamingShuffleOutputTrackerSuite.scala: ########## @@ -0,0 +1,323 @@ +/* + * 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 + +import org.scalatest.BeforeAndAfter +import org.scalatest.matchers.should.Matchers + +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.RpcEnv + +class StreamingShuffleOutputTrackerSuite + extends SparkFunSuite + with LocalSparkContext + with ThreadAudit + with BeforeAndAfter + with Matchers { + + before { + doThreadPreAudit() + } + + after { + doThreadPostAudit() + } + + protected val conf = new SparkConf + + protected def newTrackerMaster(sparkConf: SparkConf = conf) = { + new StreamingShuffleOutputTrackerMaster(sparkConf) + } + + protected def newTrackerWorker( + sparkConf: SparkConf = conf): StreamingShuffleOutputTrackerWorker = { + new StreamingShuffleOutputTrackerWorker(sparkConf) + } + + def createRpcEnv( + name: String, + host: String = "localhost", + port: Int = 0, + securityManager: SecurityManager = new SecurityManager(conf)): RpcEnv = { + RpcEnv.create(name, host, port, conf, securityManager) + } + + test("master start and stop") { + val rpcEnv = createRpcEnv("test") + val tracker = newTrackerMaster() + tracker.trackerEndpoint = rpcEnv.setupEndpoint( + StreamingShuffleOutputTracker.ENDPOINT_NAME, + new StreamingShuffleOutputTrackerMasterEndpoint(rpcEnv, tracker, conf)) + tracker.stop() + rpcEnv.shutdown() + } + + test("test tracker workflow") { + val master = newTrackerMaster() + val worker = newTrackerWorker() + + val rpcEnv = createRpcEnv("test") + val rpcEndpoint = rpcEnv.setupEndpoint( + StreamingShuffleOutputTracker.ENDPOINT_NAME, + new StreamingShuffleOutputTrackerMasterEndpoint(rpcEnv, master, conf)) + + master.trackerEndpoint = rpcEndpoint + worker.trackerEndpoint = rpcEndpoint + + val shuffleId = 0 + val numMaps = 2 + val numReduces = 2 + val jobId = 0 + val taskMap = + Map( + 0 -> StreamingShuffleTaskLocation("executor-1", "host-1", 0), + 1 -> StreamingShuffleTaskLocation("executor-2", "host-2", 0)) + master.registerShuffle(shuffleId, numMaps, numReduces, jobId) + // register one shuffle write task + worker.registerShuffleWriterTask(shuffleId, 0, taskMap(0)) + // Get all shuffle write task location information. Should return None since + // only one of the shuffle writers have registered + worker.getAllShuffleWriterTaskLocations(shuffleId) should be(None) + // register the next shuffle write task + worker.registerShuffleWriterTask(shuffleId, 1, taskMap(1)) + // should get all the shuffle task location information now + worker.getAllShuffleWriterTaskLocations(shuffleId) should be(Some(taskMap)) + + // should be a no-op for the worker + worker.unregisterShuffle(shuffleId) + master.unregisterShuffle(shuffleId) + + master.getShuffleInfo(shuffleId) should be(None) + worker.stop() + master.stop() + } + + test("register task for shuffle that doesn't exist") { + val master = newTrackerMaster() + val worker = newTrackerWorker() + + val rpcEnv = createRpcEnv("test") + val rpcEndpoint = rpcEnv.setupEndpoint( + StreamingShuffleOutputTracker.ENDPOINT_NAME, + new StreamingShuffleOutputTrackerMasterEndpoint(rpcEnv, master, conf)) + + master.trackerEndpoint = rpcEndpoint + worker.trackerEndpoint = rpcEndpoint + + worker.registerShuffleWriterTask( + 0, + 0, + StreamingShuffleTaskLocation("executor-1", "host-1", 0)) should be(false) + + worker.stop() + master.stop() + } + + test("get task location for shuffle that doesn't exist") { + val master = newTrackerMaster() + val worker = newTrackerWorker() + + val rpcEnv = createRpcEnv("test") + val rpcEndpoint = rpcEnv.setupEndpoint( + StreamingShuffleOutputTracker.ENDPOINT_NAME, + new StreamingShuffleOutputTrackerMasterEndpoint(rpcEnv, master, conf)) + + master.trackerEndpoint = rpcEndpoint + worker.trackerEndpoint = rpcEndpoint + + worker.getAllShuffleWriterTaskLocations(0) should be(None) + + worker.stop() + master.stop() + } + + test("StreamingShuffleOutputTrackerMaster - register shuffle") { + val conf = new SparkConf(false) + val tracker = new StreamingShuffleOutputTrackerMaster(conf) Review Comment: nit: We don't seem to clean this up? We run thread pool during initialization of this instance, meaning we might be leaking threads from tests. Same with other test cases. ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks Review Comment: ```suggestion * @param shuffleId The id of the shuffle to get the location information about writer tasks ``` ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return ShuffleLocationResponse which contains a map shuffle writer task locations and the + * total number of shuffle writers to expect. + */ + def getAvailableShuffleWriterTaskLocations(shuffleId: Int): Option[ShuffleLocationResponse] +} + +private[spark] case class StreamingShuffleInfo(numMaps: Int, numReduces: Int, jobId: Int) + +class StreamingShuffleOutputTrackerMaster(conf: SparkConf) + extends StreamingShuffleOutputTracker(conf) { + + // map that stores task location information organized in the following fashion + // shuffle id -> {mapId -> location} + private val taskLocations = + new ConcurrentHashMap[Int, ConcurrentHashMap[Long, StreamingShuffleTaskLocation]]() + + private val shuffleInfos = new ConcurrentHashMap[Int, StreamingShuffleInfo]() + + private val trackerMasterMessages = + new LinkedBlockingQueue[StreamingShuffleTaskLocationTrackerMasterMessage] + + // Thread pool used for handling map output status requests. This is a separate thread pool + // to ensure we don't block the normal dispatcher threads. + private val threadpool: ThreadPoolExecutor = { + val numThreads = conf.get(SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS) + val pool = + ThreadUtils.newDaemonFixedThreadPool(numThreads, "streaming-shuffle-location-dispatcher") + for (i <- 0 until numThreads) { + pool.execute(new MessageLoop) + } + pool + } + + def registerShuffle(shuffleId: Int, numMaps: Int, numReduces: Int, jobId: Int): Unit = { + logInfo(log"Registering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} with ${ + MDC(LogKeys.NUM_MAPPERS, numMaps)} mappers and ${ + MDC(LogKeys.NUM_REDUCERS, numReduces)} reducers") + shuffleInfos.put(shuffleId, StreamingShuffleInfo(numMaps, numReduces, jobId)) Review Comment: MapOutputTrackerMaster.registerShuffle does not allow shuffle ID to be registered twice. ``` if (shuffleStatuses.put(shuffleId, new ShuffleStatus(numMaps)).isDefined) { throw new IllegalArgumentException("Shuffle ID " + shuffleId + " registered twice") } ``` Should we do the same for defensive programming, or does streaming shuffle have a different requirement? ########## core/src/main/scala/org/apache/spark/StreamingShuffleOutputTracker.scala: ########## @@ -0,0 +1,400 @@ +/* + * 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 +import java.util.concurrent.{ConcurrentHashMap, LinkedBlockingQueue, ThreadPoolExecutor} + +import scala.jdk.CollectionConverters._ +import scala.reflect.ClassTag +import scala.util.control.NonFatal + +import org.apache.spark.internal.{Logging, LogKeys} +import org.apache.spark.internal.config.SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS +import org.apache.spark.rpc.{RpcCallContext, RpcEndpoint, RpcEndpointRef, RpcEnv} +import org.apache.spark.util.ThreadUtils + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAllStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocations(shuffleId: Int) + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] case object StopStreamingShuffleOutputTracker + extends StreamingShuffleTaskLocationTrackerMessage + +private[spark] sealed trait StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAllStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class GetAvailableStreamingShuffleTaskLocationsMasterMessage( + shuffleId: Int, + context: RpcCallContext) + extends StreamingShuffleTaskLocationTrackerMasterMessage + +private[spark] case class StreamingShuffleTaskLocation( + executorId: String, + host: String, + port: Int) + +private[spark] class StreamingShuffleOutputTrackerMasterEndpoint( + override val rpcEnv: RpcEnv, + tracker: StreamingShuffleOutputTrackerMaster, + conf: SparkConf) + extends RpcEndpoint + with Logging { + + logDebug("init") // force eager creation of logger + + override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { + case GetAllStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case GetAvailableStreamingShuffleTaskLocations(shuffleId) => + tracker.post(GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context)) + + case UpdateStreamingShuffleTaskLocation( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation) => + tracker.post( + UpdateStreamingShuffleTaskLocationMasterMessage(shuffleId, mapId, location, context)) + + case StopStreamingShuffleOutputTracker => + logInfo(log"StreamingShuffleOutputTrackerMasterEndpoint stopped!") + // Unregister the endpoint from the Dispatcher BEFORE completing the reply. + // This avoids a race where the caller (e.g., initializeShuffleManager) is + // unblocked by context.reply() and tries to register a new endpoint with the + // same name before this handler has finished unregistering the old one. + // stop() synchronously calls Dispatcher.stop(self) which removes the endpoint + // name from the Dispatcher's endpoints map. + // context.reply() just completes a local Promise (p.success(true)) and has no + // dependency on the endpoint's registration state, so it is safe to call after + // stop(). + stop() + context.reply(true) + } +} + +case class ShuffleLocationResponse( + shuffleTaskLocations: Map[Long, StreamingShuffleTaskLocation], + numShuffleWriterTasks: Int) + +/** + * The purpose of this class is to support get task location information for the streaming + * shuffle. For the streaming shuffle to work, tasks need to figure out what where upstream tasks + * are located so it can connect to them to get data. The general usage of the APIs are the + * following + * 1. The DAGScheduler will call registerShuffle for the tracker running on the driver to + * register the shuffle. This is when information like number of mappers will be passed into + * the driver. + * 2. Mapper / Shuffle writer tasks will call registerShuffleWriterTask to + * register themselves with the tracker running on the driver and provide the information + * about where it is running + * 3. Reduce / Shuffle reader tasks will call + * getAllShuffleWriterTaskLocations to get the location information of all the writers. The + * API "getAllShuffleWriterTaskLocations" returns all the writer task locations or nothing at + * all. Partial results will not be returned. Shuffle readers should keep polling this API + * until it returns a non-empty response. + */ +private[spark] abstract class StreamingShuffleOutputTracker(conf: SparkConf) extends Logging { + + /** Reference to the master endpoint living on the driver. */ + var trackerEndpoint: RpcEndpointRef = _ + + /** + * Send a message to the trackerEndpoint and get its result within a default timeout, or + * throw a SparkException if this fails. + */ + protected def askTracker[T: ClassTag](message: Any): T = { + try { + trackerEndpoint.askSync[T](message) + } catch { + case e: Exception => + logError(log"Error communicating with StreamingShuffleOutputTracker", e) + throw new SparkException("Error communicating with StreamingShuffleOutputTracker", e) + } + } + + /** Send a one-way message to the trackerEndpoint, to which we expect it to reply with true. */ + protected def sendTracker(message: Any): Unit = { + val response = askTracker[Boolean](message) + if (response != true) { + throw new SparkException( + "Error reply received from StreamingShuffleOutputTracker. Expecting true, got " + + response.toString) + } + } + + def unregisterShuffle(shuffleId: Int): Unit = {} + + def stop(): Unit = {} + + /** + * Register a shuffle writer task (typically mapper task) for a shuffle and provide information + * about where it is running. Will return false if the register is not completed successfully + */ + def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean + + /** + * Get all shuffle writer tasks that are part of the shuffle. This API will return None until + * all shuffle writer task location info is available. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return A map in which the key is the shuffle writer task map id and the value + * is the location information of the task. + */ + def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] + + /** + * Get the shuffle writer task locations that are currently available for a shuffle. Please note + * that this function may not return all the shuffle writer locations if not all of them are + * available. This contrast with the method "getAllShuffleWriterTaskLocations" in which all + * locations will be returned or none with be returned. + * @param shuffleId The id of the shuffle to get the lacation information about writer tasks + * @return ShuffleLocationResponse which contains a map shuffle writer task locations and the + * total number of shuffle writers to expect. + */ + def getAvailableShuffleWriterTaskLocations(shuffleId: Int): Option[ShuffleLocationResponse] +} + +private[spark] case class StreamingShuffleInfo(numMaps: Int, numReduces: Int, jobId: Int) + +class StreamingShuffleOutputTrackerMaster(conf: SparkConf) + extends StreamingShuffleOutputTracker(conf) { + + // map that stores task location information organized in the following fashion + // shuffle id -> {mapId -> location} + private val taskLocations = + new ConcurrentHashMap[Int, ConcurrentHashMap[Long, StreamingShuffleTaskLocation]]() + + private val shuffleInfos = new ConcurrentHashMap[Int, StreamingShuffleInfo]() + + private val trackerMasterMessages = + new LinkedBlockingQueue[StreamingShuffleTaskLocationTrackerMasterMessage] + + // Thread pool used for handling map output status requests. This is a separate thread pool + // to ensure we don't block the normal dispatcher threads. + private val threadpool: ThreadPoolExecutor = { + val numThreads = conf.get(SHUFFLE_MAPOUTPUT_DISPATCHER_NUM_THREADS) + val pool = + ThreadUtils.newDaemonFixedThreadPool(numThreads, "streaming-shuffle-location-dispatcher") + for (i <- 0 until numThreads) { + pool.execute(new MessageLoop) + } + pool + } + + def registerShuffle(shuffleId: Int, numMaps: Int, numReduces: Int, jobId: Int): Unit = { + logInfo(log"Registering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} with ${ + MDC(LogKeys.NUM_MAPPERS, numMaps)} mappers and ${ + MDC(LogKeys.NUM_REDUCERS, numReduces)} reducers") + shuffleInfos.put(shuffleId, StreamingShuffleInfo(numMaps, numReduces, jobId)) + } + + // for testing purposes + private[spark] def getShuffleInfo(shuffleId: Int): Option[StreamingShuffleInfo] = { + Option(shuffleInfos.get(shuffleId)) + } + + override def unregisterShuffle(shuffleId: Int): Unit = { + logInfo(log"Unregistering shuffleId ${MDC(LogKeys.SHUFFLE_ID, shuffleId)}") + + if (!shuffleInfos.containsKey(shuffleId)) { + logWarning(log"Attempting to unregister a shuffle with id ${ + MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered") + } + taskLocations.remove(shuffleId) + shuffleInfos.remove(shuffleId) + } + + def post(message: StreamingShuffleTaskLocationTrackerMasterMessage): Unit = { + trackerMasterMessages.offer(message) + } + + /** Message loop used for dispatching messages. */ + private class MessageLoop extends Runnable { + + override def run(): Unit = { + try { + while (true) { + try { + val data = trackerMasterMessages.take() + if (data == PoisonPill) { + // Put PoisonPill back so that other MessageLoops can see it. + trackerMasterMessages.offer(PoisonPill) + return + } + + data match { + case GetAllStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAllShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case GetAvailableStreamingShuffleTaskLocationsMasterMessage(shuffleId, context) => + val ret = getAvailableShuffleWriterTaskLocations(shuffleId) + context.reply(ret) + + case UpdateStreamingShuffleTaskLocationMasterMessage( + shuffleId, + mapId, + location, + context) => + context.reply(registerShuffleWriterTask(shuffleId, mapId, location)) + + } + } catch { + case NonFatal(e) => logError(e.getMessage, e) + } + } + } catch { + case ie: InterruptedException => // exit + } + } + } + + /** A poison endpoint that indicates MessageLoop should exit its message loop. */ + private val PoisonPill = + GetAllStreamingShuffleTaskLocationsMasterMessage(-99, null) + + override def registerShuffleWriterTask( + shuffleId: Int, + mapId: Long, + location: StreamingShuffleTaskLocation): Boolean = { + if (!shuffleInfos.containsKey(shuffleId)) { + logWarning( + log"Attempting to register shuffle writer task for shuffle with id ${ + MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered. Map id ${ + MDC(LogKeys.MAP_ID, mapId)}} location ${MDC(LogKeys.TASK_LOCATION, location)}}") + return false + } + taskLocations.compute( + shuffleId, + ( + shuffleId: Int, + shuffleTaskLocationMap: ConcurrentHashMap[Long, StreamingShuffleTaskLocation]) => { + val newShuffleTaskLocationMap = if (shuffleTaskLocationMap == null) { + new ConcurrentHashMap[Long, StreamingShuffleTaskLocation]() + } else { + shuffleTaskLocationMap + } + + newShuffleTaskLocationMap.put(mapId, location) + newShuffleTaskLocationMap + }) + true + } + + override def getAllShuffleWriterTaskLocations( + shuffleId: Int): Option[Map[Long, StreamingShuffleTaskLocation]] = { + val shuffleInfo = shuffleInfos.get(shuffleId) + if (shuffleInfo == null) { + logWarning(log"Attempting to get shuffle writer task location information " + + log"for shuffle with id ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered.") + return None + } + + val shuffleTaskLocationMap = taskLocations.get(shuffleId) + if (shuffleTaskLocationMap == null) { + return None + } + + // only return the mapper task location information if all mappers have registered + if (shuffleInfo.numMaps == shuffleTaskLocationMap.size()) { + Some(shuffleTaskLocationMap.asScala.toMap) + } else { + None + } + } + + override def stop(): Unit = { + trackerMasterMessages.offer(PoisonPill) + threadpool.shutdown() + try { + sendTracker(StopStreamingShuffleOutputTracker) + } catch { + case e: SparkException => + logError(log"Could not tell tracker we are stopping.", e) + } + trackerEndpoint = null + } + + override def getAvailableShuffleWriterTaskLocations( + shuffleId: Int): Option[ShuffleLocationResponse] = { + val shuffleInfo = shuffleInfos.get(shuffleId) + if (shuffleInfo == null) { + logWarning(log"Attempting to get shuffle writer task location information for " + + log"shuffle with id ${MDC(LogKeys.SHUFFLE_ID, shuffleId)} that hasn't been registered.") + return None + } + val locations = taskLocations.get(shuffleId) + val shuffleTaskLocationMap = if (locations == null) { + Map.empty[Long, StreamingShuffleTaskLocation] + } else { + locations.asScala.toMap + } + + Some(ShuffleLocationResponse(shuffleTaskLocationMap, shuffleInfo.numMaps)) + } +} + +class StreamingShuffleOutputTrackerWorker(conf: SparkConf) Review Comment: ```suggestion private[spark] class StreamingShuffleOutputTrackerWorker(conf: SparkConf) ``` nit: same here, not a must but for consistency. -- 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]
