Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-23687][SS] Add a memory source for continuous processing.
## What changes were proposed in this pull request? Add a memory source for continuous processing. Note that only one of the ContinuousSuite tests is migrated to minimize the diff here. I'll submit a second PR for SPARK-23688 to change the rest and get rid of waitForRateSourceTriggers. ## How was this patch tested? unit test Author: Jose Torres <torres.joseph.f+github@gmail.com> Closes #20828 from jose-torres/continuousMemory.
- Loading branch information
1 parent
14844a6
commit 1cc66a0
Showing
5 changed files
with
266 additions
and
44 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
211 changes: 211 additions & 0 deletions
211
.../main/scala/org/apache/spark/sql/execution/streaming/sources/ContinuousMemoryStream.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,211 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.spark.sql.execution.streaming.sources | ||
|
|
||
| import java.{util => ju} | ||
| import java.util.Optional | ||
| import java.util.concurrent.atomic.AtomicInteger | ||
| import javax.annotation.concurrent.GuardedBy | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
| import scala.collection.mutable.ListBuffer | ||
|
|
||
| import org.json4s.NoTypeHints | ||
| import org.json4s.jackson.Serialization | ||
|
|
||
| import org.apache.spark.SparkEnv | ||
| import org.apache.spark.rpc.{RpcCallContext, RpcEndpointRef, RpcEnv, ThreadSafeRpcEndpoint} | ||
| import org.apache.spark.sql.{Encoder, Row, SQLContext} | ||
| import org.apache.spark.sql.execution.streaming._ | ||
| import org.apache.spark.sql.execution.streaming.sources.ContinuousMemoryStream.GetRecord | ||
| import org.apache.spark.sql.sources.v2.{ContinuousReadSupport, DataSourceOptions} | ||
| import org.apache.spark.sql.sources.v2.reader.DataReaderFactory | ||
| import org.apache.spark.sql.sources.v2.reader.streaming.{ContinuousDataReader, ContinuousReader, Offset, PartitionOffset} | ||
| import org.apache.spark.sql.types.StructType | ||
| import org.apache.spark.util.RpcUtils | ||
|
|
||
| /** | ||
| * The overall strategy here is: | ||
| * * ContinuousMemoryStream maintains a list of records for each partition. addData() will | ||
| * distribute records evenly-ish across partitions. | ||
| * * RecordEndpoint is set up as an endpoint for executor-side | ||
| * ContinuousMemoryStreamDataReader instances to poll. It returns the record at the specified | ||
| * offset within the list, or null if that offset doesn't yet have a record. | ||
| */ | ||
| class ContinuousMemoryStream[A : Encoder](id: Int, sqlContext: SQLContext) | ||
| extends MemoryStreamBase[A](sqlContext) with ContinuousReader with ContinuousReadSupport { | ||
| private implicit val formats = Serialization.formats(NoTypeHints) | ||
| private val NUM_PARTITIONS = 2 | ||
|
|
||
| protected val logicalPlan = | ||
| StreamingRelationV2(this, "memory", Map(), attributes, None)(sqlContext.sparkSession) | ||
|
|
||
| // ContinuousReader implementation | ||
|
|
||
| @GuardedBy("this") | ||
| private val records = Seq.fill(NUM_PARTITIONS)(new ListBuffer[A]) | ||
|
|
||
| @GuardedBy("this") | ||
| private var startOffset: ContinuousMemoryStreamOffset = _ | ||
|
|
||
| private val recordEndpoint = new RecordEndpoint() | ||
| @volatile private var endpointRef: RpcEndpointRef = _ | ||
|
|
||
| def addData(data: TraversableOnce[A]): Offset = synchronized { | ||
| // Distribute data evenly among partition lists. | ||
| data.toSeq.zipWithIndex.map { | ||
| case (item, index) => records(index % NUM_PARTITIONS) += item | ||
| } | ||
|
|
||
| // The new target offset is the offset where all records in all partitions have been processed. | ||
| ContinuousMemoryStreamOffset((0 until NUM_PARTITIONS).map(i => (i, records(i).size)).toMap) | ||
| } | ||
|
|
||
| override def setStartOffset(start: Optional[Offset]): Unit = synchronized { | ||
| // Inferred initial offset is position 0 in each partition. | ||
| startOffset = start.orElse { | ||
| ContinuousMemoryStreamOffset((0 until NUM_PARTITIONS).map(i => (i, 0)).toMap) | ||
| }.asInstanceOf[ContinuousMemoryStreamOffset] | ||
| } | ||
|
|
||
| override def getStartOffset: Offset = synchronized { | ||
| startOffset | ||
| } | ||
|
|
||
| override def deserializeOffset(json: String): ContinuousMemoryStreamOffset = { | ||
| ContinuousMemoryStreamOffset(Serialization.read[Map[Int, Int]](json)) | ||
| } | ||
|
|
||
| override def mergeOffsets(offsets: Array[PartitionOffset]): ContinuousMemoryStreamOffset = { | ||
| ContinuousMemoryStreamOffset( | ||
| offsets.map { | ||
| case ContinuousMemoryStreamPartitionOffset(part, num) => (part, num) | ||
| }.toMap | ||
| ) | ||
| } | ||
|
|
||
| override def createDataReaderFactories(): ju.List[DataReaderFactory[Row]] = { | ||
| synchronized { | ||
| val endpointName = s"ContinuousMemoryStreamRecordEndpoint-${java.util.UUID.randomUUID()}-$id" | ||
| endpointRef = | ||
| recordEndpoint.rpcEnv.setupEndpoint(endpointName, recordEndpoint) | ||
|
|
||
| startOffset.partitionNums.map { | ||
| case (part, index) => | ||
| new ContinuousMemoryStreamDataReaderFactory( | ||
| endpointName, part, index): DataReaderFactory[Row] | ||
| }.toList.asJava | ||
| } | ||
| } | ||
|
|
||
| override def stop(): Unit = { | ||
| if (endpointRef != null) recordEndpoint.rpcEnv.stop(endpointRef) | ||
| } | ||
|
|
||
| override def commit(end: Offset): Unit = {} | ||
|
|
||
| // ContinuousReadSupport implementation | ||
| // This is necessary because of how StreamTest finds the source for AddDataMemory steps. | ||
| def createContinuousReader( | ||
| schema: Optional[StructType], | ||
| checkpointLocation: String, | ||
| options: DataSourceOptions): ContinuousReader = { | ||
| this | ||
| } | ||
|
|
||
| /** | ||
| * Endpoint for executors to poll for records. | ||
| */ | ||
| private class RecordEndpoint extends ThreadSafeRpcEndpoint { | ||
| override val rpcEnv: RpcEnv = SparkEnv.get.rpcEnv | ||
|
|
||
| override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = { | ||
| case GetRecord(ContinuousMemoryStreamPartitionOffset(part, index)) => | ||
| ContinuousMemoryStream.this.synchronized { | ||
| val buf = records(part) | ||
| val record = if (buf.size <= index) None else Some(buf(index)) | ||
|
|
||
| context.reply(record.map(Row(_))) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| object ContinuousMemoryStream { | ||
| case class GetRecord(offset: ContinuousMemoryStreamPartitionOffset) | ||
| protected val memoryStreamId = new AtomicInteger(0) | ||
|
|
||
| def apply[A : Encoder](implicit sqlContext: SQLContext): ContinuousMemoryStream[A] = | ||
| new ContinuousMemoryStream[A](memoryStreamId.getAndIncrement(), sqlContext) | ||
| } | ||
|
|
||
| /** | ||
| * Data reader factory for continuous memory stream. | ||
| */ | ||
| class ContinuousMemoryStreamDataReaderFactory( | ||
| driverEndpointName: String, | ||
| partition: Int, | ||
| startOffset: Int) extends DataReaderFactory[Row] { | ||
| override def createDataReader: ContinuousMemoryStreamDataReader = | ||
| new ContinuousMemoryStreamDataReader(driverEndpointName, partition, startOffset) | ||
| } | ||
|
|
||
| /** | ||
| * Data reader for continuous memory stream. | ||
| * | ||
| * Polls the driver endpoint for new records. | ||
| */ | ||
| class ContinuousMemoryStreamDataReader( | ||
| driverEndpointName: String, | ||
| partition: Int, | ||
| startOffset: Int) extends ContinuousDataReader[Row] { | ||
| private val endpoint = RpcUtils.makeDriverRef( | ||
| driverEndpointName, | ||
| SparkEnv.get.conf, | ||
| SparkEnv.get.rpcEnv) | ||
|
|
||
| private var currentOffset = startOffset | ||
| private var current: Option[Row] = None | ||
|
|
||
| override def next(): Boolean = { | ||
| current = None | ||
| while (current.isEmpty) { | ||
| Thread.sleep(10) | ||
| current = endpoint.askSync[Option[Row]]( | ||
| GetRecord(ContinuousMemoryStreamPartitionOffset(partition, currentOffset))) | ||
| } | ||
| currentOffset += 1 | ||
| true | ||
| } | ||
|
|
||
| override def get(): Row = current.get | ||
|
|
||
| override def close(): Unit = {} | ||
|
|
||
| override def getOffset: ContinuousMemoryStreamPartitionOffset = | ||
| ContinuousMemoryStreamPartitionOffset(partition, currentOffset) | ||
| } | ||
|
|
||
| case class ContinuousMemoryStreamOffset(partitionNums: Map[Int, Int]) | ||
| extends Offset { | ||
| private implicit val formats = Serialization.formats(NoTypeHints) | ||
| override def json(): String = Serialization.write(partitionNums) | ||
| } | ||
|
|
||
| case class ContinuousMemoryStreamPartitionOffset(partition: Int, numProcessed: Int) | ||
| extends PartitionOffset |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.