opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/BucketStore.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.remote.rpc.registry.gossip;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorRefProvider;
  13 import akka.actor.Address;
  14 import akka.actor.Props;
  15 import akka.cluster.ClusterActorRefProvider;
  16 import akka.event.Logging;
  17 import akka.event.LoggingAdapter;
  18 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering;
  19 import org.opendaylight.controller.remote.rpc.RemoteRpcProviderConfig;
  20 import org.opendaylight.controller.utils.ConditionalProbe;
  21
  22 import java.util.HashMap;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.ConcurrentMap;
  27
  28 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBuckets;
  29 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBucketsReply;
  30 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersions;
  31 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersionsReply;
  32 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketsByMembers;
  33 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketsByMembersReply;
  34 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetLocalBucket;
  35 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetLocalBucketReply;
  36 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.UpdateBucket;
  37 import static org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.UpdateRemoteBuckets;
  38
  39 /**
  40  * A store that syncs its data across nodes in the cluster.
  41  * It maintains a {@link org.opendaylight.controller.remote.rpc.registry.gossip.Bucket} per node. Buckets are versioned.
  42  * A node can write ONLY to its bucket. This way, write conflicts are avoided.
  43  * <p>
  44  * Buckets are sync'ed across nodes using Gossip protocol (http://en.wikipedia.org/wiki/Gossip_protocol)<p>
  45  * This store uses a {@link org.opendaylight.controller.remote.rpc.registry.gossip.Gossiper}.
  46  *
  47  */
  48 public class BucketStore extends AbstractUntypedActorWithMetering {
  49
  50     final LoggingAdapter log = Logging.getLogger(getContext().system(), this);
  51
  52     /**
  53      * Bucket owned by the node
  54      */
  55     private BucketImpl localBucket = new BucketImpl();
  56
  57     /**
  58      * Buckets ownded by other known nodes in the cluster
  59      */
  60     private ConcurrentMap<Address, Bucket> remoteBuckets = new ConcurrentHashMap<>();
  61
  62     /**
  63      * Bucket version for every known node in the cluster including this node
  64      */
  65     private ConcurrentMap<Address, Long> versions = new ConcurrentHashMap<>();
  66
  67     /**
  68      * Cluster address for this node
  69      */
  70     private Address selfAddress;
  71
  72     private ConditionalProbe probe;
  73
  74     private final RemoteRpcProviderConfig config;
  75
  76     public BucketStore(){
  77         config = new RemoteRpcProviderConfig(getContext().system().settings().config());
  78     }
  79
  80     @Override
  81     public void preStart(){
  82         ActorRefProvider provider = getContext().provider();
  83         selfAddress = provider.getDefaultAddress();
  84
  85         if ( provider instanceof ClusterActorRefProvider)
  86             getContext().actorOf(Props.create(Gossiper.class).withMailbox(config.getMailBoxName()), "gossiper");
  87     }
  88
  89
  90     @Override
  91     protected void handleReceive(Object message) throws Exception {
  92         if (probe != null) {
  93             probe.tell(message, getSelf());
  94         }
  95
  96         if (message instanceof ConditionalProbe) {
  97             log.info("Received probe {} {}", getSelf(), message);
  98             probe = (ConditionalProbe) message;
  99         } else if (message instanceof UpdateBucket) {
 100             receiveUpdateBucket(((UpdateBucket) message).getBucket());
 101         } else if (message instanceof GetAllBuckets) {
 102             receiveGetAllBucket();
 103         } else if (message instanceof GetLocalBucket) {
 104             receiveGetLocalBucket();
 105         } else if (message instanceof GetBucketsByMembers) {
 106             receiveGetBucketsByMembers(
 107                     ((GetBucketsByMembers) message).getMembers());
 108         } else if (message instanceof GetBucketVersions) {
 109             receiveGetBucketVersions();
 110         } else if (message instanceof UpdateRemoteBuckets) {
 111             receiveUpdateRemoteBuckets(
 112                     ((UpdateRemoteBuckets) message).getBuckets());
 113         } else {
 114             log.debug("Unhandled message [{}]", message);
 115             unhandled(message);
 116         }
 117     }
 118
 119     /**
 120      * Returns a copy of bucket owned by this node
 121      */
 122     private void receiveGetLocalBucket() {
 123         final ActorRef sender = getSender();
 124         GetLocalBucketReply reply = new GetLocalBucketReply(localBucket);
 125         sender.tell(reply, getSelf());
 126     }
 127
 128     /**
 129      * Updates the bucket owned by this node
 130      *
 131      * @param updatedBucket
 132      */
 133     void receiveUpdateBucket(Bucket updatedBucket){
 134
 135         localBucket = (BucketImpl) updatedBucket;
 136         versions.put(selfAddress, localBucket.getVersion());
 137     }
 138
 139     /**
 140      * Returns all the buckets the this node knows about, self owned + remote
 141      */
 142     void receiveGetAllBucket(){
 143         final ActorRef sender = getSender();
 144         sender.tell(new GetAllBucketsReply(getAllBuckets()), getSelf());
 145     }
 146
 147     /**
 148      * Helper to collect all known buckets
 149      *
 150      * @return self owned + remote buckets
 151      */
 152     Map<Address, Bucket> getAllBuckets(){
 153         Map<Address, Bucket> all = new HashMap<>(remoteBuckets.size() + 1);
 154
 155         //first add the local bucket
 156         all.put(selfAddress, localBucket);
 157
 158         //then get all remote buckets
 159         all.putAll(remoteBuckets);
 160
 161         return all;
 162     }
 163
 164     /**
 165      * Returns buckets for requested members that this node knows about
 166      *
 167      * @param members requested members
 168      */
 169     void receiveGetBucketsByMembers(Set<Address> members){
 170         final ActorRef sender = getSender();
 171         Map<Address, Bucket> buckets = getBucketsByMembers(members);
 172         sender.tell(new GetBucketsByMembersReply(buckets), getSelf());
 173     }
 174
 175     /**
 176      * Helper to collect buckets for requested memebers
 177      *
 178      * @param members requested members
 179      * @return buckets for requested memebers
 180      */
 181     Map<Address, Bucket> getBucketsByMembers(Set<Address> members) {
 182         Map<Address, Bucket> buckets = new HashMap<>();
 183
 184         //first add the local bucket if asked
 185         if (members.contains(selfAddress))
 186             buckets.put(selfAddress, localBucket);
 187
 188         //then get buckets for requested remote nodes
 189         for (Address address : members){
 190             if (remoteBuckets.containsKey(address))
 191                 buckets.put(address, remoteBuckets.get(address));
 192         }
 193
 194         return buckets;
 195     }
 196
 197     /**
 198      * Returns versions for all buckets known
 199      */
 200     void receiveGetBucketVersions(){
 201         final ActorRef sender = getSender();
 202         GetBucketVersionsReply reply = new GetBucketVersionsReply(versions);
 203         sender.tell(reply, getSelf());
 204     }
 205
 206     /**
 207      * Update local copy of remote buckets where local copy's version is older
 208      *
 209      * @param receivedBuckets buckets sent by remote
 210      *                        {@link org.opendaylight.controller.remote.rpc.registry.gossip.Gossiper}
 211      */
 212     void receiveUpdateRemoteBuckets(Map<Address, Bucket> receivedBuckets){
 213
 214         if (receivedBuckets == null || receivedBuckets.isEmpty())
 215             return; //nothing to do
 216
 217         //Remote cant update self's bucket
 218         receivedBuckets.remove(selfAddress);
 219
 220         for (Map.Entry<Address, Bucket> entry : receivedBuckets.entrySet()){
 221
 222             Long localVersion = versions.get(entry.getKey());
 223             if (localVersion == null) localVersion = -1L;
 224
 225             Bucket receivedBucket = entry.getValue();
 226
 227             if (receivedBucket == null)
 228                 continue;
 229
 230             Long remoteVersion = receivedBucket.getVersion();
 231             if (remoteVersion == null) remoteVersion = -1L;
 232
 233             //update only if remote version is newer
 234             if ( remoteVersion.longValue() > localVersion.longValue() ) {
 235                 remoteBuckets.put(entry.getKey(), receivedBucket);
 236                 versions.put(entry.getKey(), remoteVersion);
 237             }
 238         }
 239
 240         log.debug("State after update - Local Bucket [{}], Remote Buckets [{}]", localBucket, remoteBuckets);
 241     }
 242
 243     ///
 244     ///Getter Setters
 245     ///
 246
 247     BucketImpl getLocalBucket() {
 248         return localBucket;
 249     }
 250
 251     void setLocalBucket(BucketImpl localBucket) {
 252         this.localBucket = localBucket;
 253     }
 254
 255     ConcurrentMap<Address, Bucket> getRemoteBuckets() {
 256         return remoteBuckets;
 257     }
 258
 259     void setRemoteBuckets(ConcurrentMap<Address, Bucket> remoteBuckets) {
 260         this.remoteBuckets = remoteBuckets;
 261     }
 262
 263     ConcurrentMap<Address, Long> getVersions() {
 264         return versions;
 265     }
 266
 267     void setVersions(ConcurrentMap<Address, Long> versions) {
 268         this.versions = versions;
 269     }
 270
 271     Address getSelfAddress() {
 272         return selfAddress;
 273     }
 274 }