X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-remoterpc-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fremote%2Frpc%2Fregistry%2FRpcRegistry.java;h=2c89f1426072a6e945de5ed107fd3b07a53ef7df;hp=51609870cc4aad1c8789dfdcd0b68f04563b5cdf;hb=73b088ee110766618a8728eed653b15cef896cf1;hpb=d7ce7c5acee7e6f7cd7895ceff5af63ac53789ad diff --git a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java index 51609870cc..2c89f14260 100644 --- a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java +++ b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java @@ -7,378 +7,193 @@ */ package org.opendaylight.controller.remote.rpc.registry; +import static com.google.common.base.Preconditions.checkArgument; +import static java.util.Objects.requireNonNull; + import akka.actor.ActorRef; import akka.actor.Address; import akka.actor.Props; -import akka.actor.UntypedActor; -import akka.dispatch.Mapper; -import akka.event.Logging; -import akka.event.LoggingAdapter; -import akka.japi.Option; -import akka.japi.Pair; -import akka.pattern.Patterns; -import com.google.common.base.Preconditions; -import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket; -import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore; -import org.opendaylight.controller.sal.connector.api.RpcRouter; -import scala.concurrent.Future; - -import java.util.ArrayList; -import java.util.Collections; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; +import java.util.Collection; +import java.util.HashMap; import java.util.List; import java.util.Map; - -import static org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoute; -import static org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoute; -import static org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.SetLocalRouter; -import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBuckets; -import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBucketsReply; -import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetLocalBucket; -import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetLocalBucketReply; -import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.UpdateBucket; +import java.util.Map.Entry; +import java.util.Optional; +import java.util.Set; +import org.opendaylight.controller.remote.rpc.RemoteOpsProviderConfig; +import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoutes; +import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoutes; +import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket; +import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreAccess; +import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor; +import org.opendaylight.controller.remote.rpc.registry.mbeans.RemoteRpcRegistryMXBeanImpl; +import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier; /** - * Registry to look up cluster nodes that have registered for a given rpc. + * Registry to look up cluster nodes that have registered for a given RPC. + * *

- * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore} to maintain this + * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor} to maintain this * cluster wide information. - * */ -public class RpcRegistry extends UntypedActor { - - final LoggingAdapter log = Logging.getLogger(getContext().system(), this); - - /** - * Store to keep the registry. Bucket store sync's it across nodes in the cluster - */ - private ActorRef bucketStore; - - /** - * Rpc broker that would use the registry to route requests. - */ - private ActorRef localRouter; +public class RpcRegistry extends BucketStoreActor { + private final ActorRef rpcRegistrar; + private RemoteRpcRegistryMXBeanImpl mxBean; - public RpcRegistry() { - bucketStore = getContext().actorOf(Props.create(BucketStore.class), "store"); - } - - public RpcRegistry(ActorRef bucketStore) { - this.bucketStore = bucketStore; - } - - @Override - public void onReceive(Object message) throws Exception { - - log.debug("Received message: message [{}]", message); - - //TODO: if sender is remote, reject message + public RpcRegistry(final RemoteOpsProviderConfig config, final ActorRef rpcInvoker, final ActorRef rpcRegistrar) { + super(config, config.getRpcRegistryPersistenceId(), new RoutingTable(rpcInvoker, ImmutableSet.of())); + this.rpcRegistrar = requireNonNull(rpcRegistrar); - if (message instanceof SetLocalRouter) - receiveSetLocalRouter((SetLocalRouter) message); - - if (message instanceof AddOrUpdateRoute) - receiveAddRoute((AddOrUpdateRoute) message); - - else if (message instanceof RemoveRoute) - receiveRemoveRoute((RemoveRoute) message); - - else if (message instanceof Messages.FindRouters) - receiveGetRouter((Messages.FindRouters) message); - - else - unhandled(message); } /** - * Register's rpc broker + * Create a new props instance for instantiating an RpcRegistry actor. * - * @param message contains {@link akka.actor.ActorRef} for rpc broker - */ - private void receiveSetLocalRouter(SetLocalRouter message) { - if (message == null || message.getRouter() == null) - return;//ignore - - localRouter = message.getRouter(); - } - - /** - * //TODO: update this to accept multiple route registration - * @param msg + * @param config Provider configuration + * @param rpcRegistrar Local RPC provider interface, used to register routers to remote nodes + * @param rpcInvoker Actor handling RPC invocation requests from remote nodes + * @return A new {@link Props} instance */ - private void receiveAddRoute(AddOrUpdateRoute msg) { - if (msg.getRouteIdentifier() == null) - return;//ignore - - Preconditions.checkState(localRouter != null, "Router must be set first"); - - Future futureReply = Patterns.ask(bucketStore, new GetLocalBucket(), 1000); - futureReply.map(getMapperToAddRoute(msg.getRouteIdentifier()), getContext().dispatcher()); + public static Props props(final RemoteOpsProviderConfig config, final ActorRef rpcInvoker, + final ActorRef rpcRegistrar) { + return Props.create(RpcRegistry.class, config, rpcInvoker, rpcRegistrar); } - /** - * //TODO: update this to accept multiple routes - * @param msg - */ - private void receiveRemoveRoute(RemoveRoute msg) { - if (msg.getRouteIdentifier() == null) - return;//ignore - - Future futureReply = Patterns.ask(bucketStore, new GetLocalBucket(), 1000); - futureReply.map(getMapperToRemoveRoute(msg.getRouteIdentifier()), getContext().dispatcher()); - + @Override + public void preStart() { + super.preStart(); + mxBean = new RemoteRpcRegistryMXBeanImpl(new BucketStoreAccess(self(), getContext().dispatcher(), + getConfig().getAskDuration()), getConfig().getAskDuration()); } - /** - * Finds routers for the given rpc. - * @param msg - */ - private void receiveGetRouter(Messages.FindRouters msg) { - final ActorRef sender = getSender(); - - //if empty message, return empty list - if (msg.getRouteIdentifier() == null) { - sender.tell(createEmptyReply(), getSelf()); - return; + @Override + public void postStop() throws Exception { + if (mxBean != null) { + mxBean.unregister(); + mxBean = null; } - - Future futureReply = Patterns.ask(bucketStore, new GetAllBuckets(), 1000); - futureReply.map(getMapperToGetRouter(msg.getRouteIdentifier(), sender), getContext().dispatcher()); - + super.postStop(); } - /** - * Helper to create empty reply when no routers are found - * - * @return - */ - private Messages.FindRoutersReply createEmptyReply() { - List> routerWithUpdateTime = Collections.emptyList(); - return new Messages.FindRoutersReply(routerWithUpdateTime); - } - - /** - * Helper to create a reply when routers are found for the given rpc - * @param buckets - * @param routeId - * @return - */ - private Messages.FindRoutersReply createReplyWithRouters(Map buckets, RpcRouter.RouteIdentifier routeId) { - - List> routers = new ArrayList<>(); - - Option> routerWithUpdateTime = null; - - for (Bucket bucket : buckets.values()) { - - RoutingTable table = (RoutingTable) bucket.getData(); - - if (table == null) - continue; - - routerWithUpdateTime = table.getRouterFor(routeId); - - if (routerWithUpdateTime.isEmpty()) - continue; - - routers.add(routerWithUpdateTime.get()); + @Override + protected void handleCommand(final Object message) throws Exception { + if (message instanceof AddOrUpdateRoutes) { + receiveAddRoutes((AddOrUpdateRoutes) message); + } else if (message instanceof RemoveRoutes) { + receiveRemoveRoutes((RemoveRoutes) message); + } else { + super.handleCommand(message); } - - return new Messages.FindRoutersReply(routers); } - - /// - ///private factories to create Mapper - /// - - /** - * Receives all buckets returned from bucket store and finds routers for the buckets where given rpc(routeId) is found - * - * @param routeId the rpc - * @param sender client who asked to find the routers. - * @return - */ - private Mapper getMapperToGetRouter(final RpcRouter.RouteIdentifier routeId, final ActorRef sender) { - return new Mapper() { - @Override - public Void apply(Object replyMessage) { - - if (replyMessage instanceof GetAllBucketsReply) { - - GetAllBucketsReply reply = (GetAllBucketsReply) replyMessage; - Map buckets = reply.getBuckets(); - - if (buckets == null || buckets.isEmpty()) { - sender.tell(createEmptyReply(), getSelf()); - return null; - } - - sender.tell(createReplyWithRouters(buckets, routeId), getSelf()); - } - return null; - } - }; + private void receiveAddRoutes(final AddOrUpdateRoutes msg) { + LOG.debug("AddOrUpdateRoutes: {}", msg.getRouteIdentifiers()); + updateLocalBucket(getLocalData().addRpcs(msg.getRouteIdentifiers())); } /** - * Receives local bucket from bucket store and updates routing table in it by removing the route. Subsequently, - * it updates the local bucket in bucket store. + * Processes a RemoveRoutes message. * - * @param routeId rpc to remote - * @return + * @param msg contains list of route ids to remove */ - private Mapper getMapperToRemoveRoute(final RpcRouter.RouteIdentifier routeId) { - return new Mapper() { - @Override - public Void apply(Object replyMessage) { - if (replyMessage instanceof GetLocalBucketReply) { - - GetLocalBucketReply reply = (GetLocalBucketReply) replyMessage; - Bucket bucket = reply.getBucket(); - - if (bucket == null) { - log.debug("Local bucket is null"); - return null; - } - - RoutingTable table = bucket.getData(); - if (table == null) - table = new RoutingTable(); - - table.setRouter(localRouter); - table.removeRoute(routeId); - - bucket.setData(table); - - UpdateBucket updateBucketMessage = new UpdateBucket(bucket); - bucketStore.tell(updateBucketMessage, getSelf()); - } - return null; - } - }; + private void receiveRemoveRoutes(final RemoveRoutes msg) { + LOG.debug("RemoveRoutes: {}", msg.getRouteIdentifiers()); + updateLocalBucket(getLocalData().removeRpcs(msg.getRouteIdentifiers())); } - /** - * Receives local bucket from bucket store and updates routing table in it by adding the route. Subsequently, - * it updates the local bucket in bucket store. - * - * @param routeId rpc to add - * @return - */ - private Mapper getMapperToAddRoute(final RpcRouter.RouteIdentifier routeId) { + @Override + protected void onBucketRemoved(final Address address, final Bucket bucket) { + rpcRegistrar.tell(new Messages.UpdateRemoteEndpoints(ImmutableMap.of(address, Optional.empty())), + ActorRef.noSender()); + } - return new Mapper() { - @Override - public Void apply(Object replyMessage) { - if (replyMessage instanceof GetLocalBucketReply) { + @Override + protected void onBucketsUpdated(final Map> buckets) { + final Map> endpoints = new HashMap<>(buckets.size()); - GetLocalBucketReply reply = (GetLocalBucketReply) replyMessage; - Bucket bucket = reply.getBucket(); + for (Entry> e : buckets.entrySet()) { + final RoutingTable table = e.getValue().getData(); - if (bucket == null) { - log.debug("Local bucket is null"); - return null; - } + final Collection rpcs = table.getItems(); + endpoints.put(e.getKey(), rpcs.isEmpty() ? Optional.empty() + : Optional.of(new RemoteRpcEndpoint(table.getInvoker(), rpcs))); + } - RoutingTable table = bucket.getData(); - if (table == null) - table = new RoutingTable(); + if (!endpoints.isEmpty()) { + rpcRegistrar.tell(new Messages.UpdateRemoteEndpoints(endpoints), ActorRef.noSender()); + } + } - table.setRouter(localRouter); - table.addRoute(routeId); + public static final class RemoteRpcEndpoint { + private final Set rpcs; + private final ActorRef router; - bucket.setData(table); + @VisibleForTesting + public RemoteRpcEndpoint(final ActorRef router, final Collection rpcs) { + this.router = requireNonNull(router); + this.rpcs = ImmutableSet.copyOf(rpcs); + } - UpdateBucket updateBucketMessage = new UpdateBucket(bucket); - bucketStore.tell(updateBucketMessage, getSelf()); - } + public ActorRef getRouter() { + return router; + } - return null; - } - }; + public Set getRpcs() { + return rpcs; + } } /** - * All messages used by the RpcRegistry + * All messages used by the RpcRegistry. */ public static class Messages { + abstract static class AbstractRouteMessage { + final List rpcRouteIdentifiers; - - public static class ContainsRoute { - final RpcRouter.RouteIdentifier routeIdentifier; - - public ContainsRoute(RpcRouter.RouteIdentifier routeIdentifier) { - Preconditions.checkArgument(routeIdentifier != null); - this.routeIdentifier = routeIdentifier; + AbstractRouteMessage(final Collection rpcRouteIdentifiers) { + checkArgument(rpcRouteIdentifiers != null && !rpcRouteIdentifiers.isEmpty(), + "Route Identifiers must be supplied"); + this.rpcRouteIdentifiers = ImmutableList.copyOf(rpcRouteIdentifiers); } - public RpcRouter.RouteIdentifier getRouteIdentifier(){ - return this.routeIdentifier; + List getRouteIdentifiers() { + return this.rpcRouteIdentifiers; } @Override public String toString() { - return this.getClass().getSimpleName() + "{" + - "routeIdentifier=" + routeIdentifier + - '}'; - } - } - - public static class AddOrUpdateRoute extends ContainsRoute{ - - public AddOrUpdateRoute(RpcRouter.RouteIdentifier routeIdentifier) { - super(routeIdentifier); + return "ContainsRoute{" + "routeIdentifiers=" + rpcRouteIdentifiers + '}'; } } - public static class RemoveRoute extends ContainsRoute { - - public RemoveRoute(RpcRouter.RouteIdentifier routeIdentifier) { - super(routeIdentifier); - } - } - - public static class SetLocalRouter{ - private final ActorRef router; - - public SetLocalRouter(ActorRef router) { - this.router = router; - } - - public ActorRef getRouter(){ - return this.router; + public static final class AddOrUpdateRoutes extends Messages.AbstractRouteMessage { + public AddOrUpdateRoutes(final Collection rpcRouteIdentifiers) { + super(rpcRouteIdentifiers); } - @Override - public String toString() { - return "SetLocalRouter{" + - "router=" + router + - '}'; - } } - public static class FindRouters extends ContainsRoute { - public FindRouters(RpcRouter.RouteIdentifier routeIdentifier) { - super(routeIdentifier); + public static final class RemoveRoutes extends AbstractRouteMessage { + public RemoveRoutes(final Collection rpcRouteIdentifiers) { + super(rpcRouteIdentifiers); } } - public static class FindRoutersReply { - final List> routerWithUpdateTime; + public static final class UpdateRemoteEndpoints { + private final Map> rpcEndpoints; - public FindRoutersReply(List> routerWithUpdateTime) { - this.routerWithUpdateTime = routerWithUpdateTime; - } - public List> getRouterWithUpdateTime(){ - return routerWithUpdateTime; + @VisibleForTesting + public UpdateRemoteEndpoints(final Map> rpcEndpoints) { + this.rpcEndpoints = ImmutableMap.copyOf(rpcEndpoints); } - @Override - public String toString() { - return "FindRoutersReply{" + - "routerWithUpdateTime=" + routerWithUpdateTime + - '}'; + public Map> getRpcEndpoints() { + return rpcEndpoints; } } }