Github user aarondav commented on a diff in the pull request:
https://github.com/apache/spark/pull/4588#discussion_r27348783
--- Diff: core/src/main/scala/org/apache/spark/rpc/akka/AkkaRpcEnv.scala ---
@@ -0,0 +1,321 @@
+/*
+ * 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.rpc.akka
+
+import java.net.URI
+import java.util.concurrent.ConcurrentHashMap
+
+import scala.concurrent.{Await, Future}
+import scala.concurrent.duration._
+import scala.language.postfixOps
+import scala.reflect.ClassTag
+import scala.util.control.NonFatal
+
+import akka.actor.{ActorSystem, ExtendedActorSystem, Actor, ActorRef,
Props, Address}
+import akka.pattern.{ask => akkaAsk}
+import akka.remote.{AssociationEvent, AssociatedEvent, DisassociatedEvent,
AssociationErrorEvent}
+import org.apache.spark.{SparkException, Logging, SparkConf}
+import org.apache.spark.rpc._
+import org.apache.spark.util.{ActorLogReceive, AkkaUtils}
+
+/**
+ * A RpcEnv implementation based on Akka.
+ *
+ * TODO Once we remove all usages of Akka in other place, we can move this
file to a new project and
+ * remove Akka from the dependencies.
+ *
+ * @param actorSystem
+ * @param conf
+ * @param boundPort
+ */
+private[spark] class AkkaRpcEnv private[akka] (
+ val actorSystem: ActorSystem, conf: SparkConf, boundPort: Int)
+ extends RpcEnv(conf) with Logging {
+
+ private val defaultAddress: RpcAddress = {
+ val address =
actorSystem.asInstanceOf[ExtendedActorSystem].provider.getDefaultAddress
+ // In some test case, ActorSystem doesn't bind to any address.
+ // So just use some default value since they are only some unit tests
+ RpcAddress(address.host.getOrElse("localhost"),
address.port.getOrElse(boundPort))
+ }
+
+ override val address: RpcAddress = defaultAddress
+
+ /**
+ * A lookup table to search a [[RpcEndpointRef]] for a [[RpcEndpoint]].
We need it to make
+ * [[RpcEndpoint.self]] work.
+ */
+ private val endpointToRef = new ConcurrentHashMap[RpcEndpoint,
RpcEndpointRef]()
+
+ /**
+ * Need this map to remove `RpcEndpoint` from `endpointToRef` via a
`RpcEndpointRef`
+ */
+ private val refToEndpoint = new ConcurrentHashMap[RpcEndpointRef,
RpcEndpoint]()
+
+ private def registerEndpoint(endpoint: RpcEndpoint, endpointRef:
RpcEndpointRef): Unit = {
+ endpointToRef.put(endpoint, endpointRef)
+ refToEndpoint.put(endpointRef, endpoint)
+ }
+
+ private def unregisterEndpoint(endpointRef: RpcEndpointRef): Unit = {
+ val endpoint = refToEndpoint.remove(endpointRef)
+ if (endpoint != null) {
+ endpointToRef.remove(endpoint)
+ }
+ }
+
+ /**
+ * Retrieve the [[RpcEndpointRef]] of `endpoint`.
+ */
+ override def endpointRef(endpoint: RpcEndpoint): RpcEndpointRef = {
+ val endpointRef = endpointToRef.get(endpoint)
+ require(endpointRef != null, s"Cannot find RpcEndpointRef of
${endpoint} in ${this}")
+ endpointRef
+ }
+
+ override def setupEndpoint(name: String, endpoint: RpcEndpoint):
RpcEndpointRef = {
+ setupThreadSafeEndpoint(name, endpoint)
+ }
+
+ override def setupThreadSafeEndpoint(name: String, endpoint:
RpcEndpoint): RpcEndpointRef = {
+ @volatile var endpointRef: AkkaRpcEndpointRef = null
+ // Use lazy because the Actor needs to use `endpointRef`.
+ // So `actorRef` should be created after assigning `endpointRef`.
+ lazy val actorRef = actorSystem.actorOf(Props(new Actor with
ActorLogReceive with Logging {
+
+ require(endpointRef != null)
+ registerEndpoint(endpoint, endpointRef)
+
+ override def preStart(): Unit = {
+ // Listen for remote client network events
+ context.system.eventStream.subscribe(self,
classOf[AssociationEvent])
+ safelyCall(endpoint) {
+ endpoint.onStart()
+ }
+ }
+
+ override def receiveWithLogging: Receive = {
+ case AssociatedEvent(_, remoteAddress, _) =>
+ safelyCall(endpoint) {
+ endpoint.onConnected(akkaAddressToRpcAddress(remoteAddress))
+ }
+
+ case DisassociatedEvent(_, remoteAddress, _) =>
+ safelyCall(endpoint) {
+ endpoint.onDisconnected(akkaAddressToRpcAddress(remoteAddress))
+ }
+
+ case AssociationErrorEvent(cause, localAddress, remoteAddress,
inbound, _) =>
+ safelyCall(endpoint) {
+ endpoint.onNetworkError(cause,
akkaAddressToRpcAddress(remoteAddress))
+ }
+
+ case e: AssociationEvent =>
+ // TODO ignore?
+
+ case m: AkkaMessage =>
+ logDebug(s"Received RPC message: $m")
+ safelyCall(endpoint) {
+ processMessage(endpoint, m, sender)
+ }
+
+ case AkkaFailure(e) =>
+ try {
+ endpoint.onError(e)
+ } catch {
+ case NonFatal(e) => logError(s"Ignore error: ${e.getMessage}",
e)
+ }
+
+ case message: Any => {
+ logWarning(s"Unknown message: $message")
+ }
+
+ }
+
+ override def postStop(): Unit = {
+ unregisterEndpoint(endpoint.self)
+ safelyCall(endpoint) {
+ endpoint.onStop()
+ }
+ }
+
+ }), name = name)
+ endpointRef = new AkkaRpcEndpointRef(defaultAddress, actorRef, conf,
initInConstructor = false)
+ // Now actorRef can be created safely
+ endpointRef.init()
+ endpointRef
+ }
+
+ private def processMessage(endpoint: RpcEndpoint, m: AkkaMessage,
_sender: ActorRef): Unit = {
+ val message = m.message
+ val needReply = m.needReply
+ val pf =
+ if (needReply) {
+ endpoint.receiveAndReply(new RpcCallContext {
+ override def sendFailure(e: Throwable): Unit = {
+ _sender ! AkkaFailure(e)
+ }
+
+ override def reply(response: Any): Unit = {
+ _sender ! AkkaMessage(response, false)
+ }
+
+ // Some RpcEndpoints need to know the sender's address
+ override val sender: RpcEndpointRef =
+ new AkkaRpcEndpointRef(defaultAddress, _sender, conf)
+ })
+ } else {
+ endpoint.receive
+ }
+ try {
+ if (pf.isDefinedAt(message)) {
--- End diff --
We should use applyOrElse to avoid double-evaluating the conditions when
possible (I believe most partial functions will be literals, so it should
generally work).
Additionally, we should probably have a better fallback behavior, such as
throwing an exception or at least logging a warning that a message was
unmatched. (Whichever is chosen should of course also be documented.)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]