2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.remote.rpc.registry.gossip;
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 com.google.common.base.Preconditions;
17 import java.util.HashMap;
20 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering;
21 import org.opendaylight.controller.remote.rpc.RemoteRpcProviderConfig;
22 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBuckets;
23 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBucketsReply;
24 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersions;
25 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersionsReply;
26 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketsByMembers;
27 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketsByMembersReply;
28 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.UpdateRemoteBuckets;
29 import org.opendaylight.controller.utils.ConditionalProbe;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
34 * A store that syncs its data across nodes in the cluster.
35 * It maintains a {@link org.opendaylight.controller.remote.rpc.registry.gossip.Bucket} per node. Buckets are versioned.
36 * A node can write ONLY to its bucket. This way, write conflicts are avoided.
38 * Buckets are sync'ed across nodes using Gossip protocol (http://en.wikipedia.org/wiki/Gossip_protocol)<p>
39 * This store uses a {@link org.opendaylight.controller.remote.rpc.registry.gossip.Gossiper}.
42 public class BucketStore<T extends Copier<T>> extends AbstractUntypedActorWithMetering {
44 private static final Long NO_VERSION = -1L;
46 protected final Logger log = LoggerFactory.getLogger(getClass());
49 * Bucket owned by the node
51 private final BucketImpl<T> localBucket = new BucketImpl<>();
54 * Buckets ownded by other known nodes in the cluster
56 private final Map<Address, Bucket<T>> remoteBuckets = new HashMap<>();
59 * Bucket version for every known node in the cluster including this node
61 private final Map<Address, Long> versions = new HashMap<>();
64 * Cluster address for this node
66 private Address selfAddress;
68 private ConditionalProbe probe;
70 private final RemoteRpcProviderConfig config;
72 public BucketStore(RemoteRpcProviderConfig config){
73 this.config = Preconditions.checkNotNull(config);
77 public void preStart(){
78 ActorRefProvider provider = getContext().provider();
79 selfAddress = provider.getDefaultAddress();
81 if ( provider instanceof ClusterActorRefProvider) {
82 getContext().actorOf(Props.create(Gossiper.class, config).withMailbox(config.getMailBoxName()), "gossiper");
87 protected void handleReceive(Object message) throws Exception {
89 probe.tell(message, getSelf());
92 if (message instanceof ConditionalProbe) {
93 // The ConditionalProbe is only used for unit tests.
94 log.info("Received probe {} {}", getSelf(), message);
95 probe = (ConditionalProbe) message;
96 // Send back any message to tell the caller we got the probe.
97 getSender().tell("Got it", getSelf());
98 } else if (message instanceof GetAllBuckets) {
99 receiveGetAllBuckets();
100 } else if (message instanceof GetBucketsByMembers) {
101 receiveGetBucketsByMembers(((GetBucketsByMembers) message).getMembers());
102 } else if (message instanceof GetBucketVersions) {
103 receiveGetBucketVersions();
104 } else if (message instanceof UpdateRemoteBuckets) {
105 receiveUpdateRemoteBuckets(((UpdateRemoteBuckets<T>) message).getBuckets());
107 if(log.isDebugEnabled()) {
108 log.debug("Unhandled message [{}]", message);
115 * Returns all the buckets the this node knows about, self owned + remote
117 void receiveGetAllBuckets(){
118 final ActorRef sender = getSender();
119 sender.tell(new GetAllBucketsReply<T>(getAllBuckets()), getSelf());
123 * Helper to collect all known buckets
125 * @return self owned + remote buckets
127 Map<Address, Bucket<T>> getAllBuckets(){
128 Map<Address, Bucket<T>> all = new HashMap<>(remoteBuckets.size() + 1);
130 //first add the local bucket
131 all.put(selfAddress, new BucketImpl<>(localBucket));
133 //then get all remote buckets
134 all.putAll(remoteBuckets);
140 * Returns buckets for requested members that this node knows about
142 * @param members requested members
144 void receiveGetBucketsByMembers(Set<Address> members){
145 final ActorRef sender = getSender();
146 Map<Address, Bucket<T>> buckets = getBucketsByMembers(members);
147 sender.tell(new GetBucketsByMembersReply<T>(buckets), getSelf());
151 * Helper to collect buckets for requested memebers
153 * @param members requested members
154 * @return buckets for requested memebers
156 Map<Address, Bucket<T>> getBucketsByMembers(Set<Address> members) {
157 Map<Address, Bucket<T>> buckets = new HashMap<>();
159 //first add the local bucket if asked
160 if (members.contains(selfAddress)) {
161 buckets.put(selfAddress, new BucketImpl<>(localBucket));
164 //then get buckets for requested remote nodes
165 for (Address address : members){
166 if (remoteBuckets.containsKey(address)) {
167 buckets.put(address, remoteBuckets.get(address));
175 * Returns versions for all buckets known
177 void receiveGetBucketVersions(){
178 final ActorRef sender = getSender();
179 GetBucketVersionsReply reply = new GetBucketVersionsReply(versions);
180 sender.tell(reply, getSelf());
184 * Update local copy of remote buckets where local copy's version is older
186 * @param receivedBuckets buckets sent by remote
187 * {@link org.opendaylight.controller.remote.rpc.registry.gossip.Gossiper}
189 void receiveUpdateRemoteBuckets(Map<Address, Bucket<T>> receivedBuckets){
190 log.debug("{}: receiveUpdateRemoteBuckets: {}", selfAddress, receivedBuckets);
191 if (receivedBuckets == null || receivedBuckets.isEmpty())
193 return; //nothing to do
196 //Remote cant update self's bucket
197 receivedBuckets.remove(selfAddress);
199 for (Map.Entry<Address, Bucket<T>> entry : receivedBuckets.entrySet()){
201 Long localVersion = versions.get(entry.getKey());
202 if (localVersion == null) {
203 localVersion = NO_VERSION;
206 Bucket<T> receivedBucket = entry.getValue();
208 if (receivedBucket == null) {
212 Long remoteVersion = receivedBucket.getVersion();
213 if (remoteVersion == null) {
214 remoteVersion = NO_VERSION;
217 //update only if remote version is newer
218 if ( remoteVersion.longValue() > localVersion.longValue() ) {
219 remoteBuckets.put(entry.getKey(), receivedBucket);
220 versions.put(entry.getKey(), remoteVersion);
224 if(log.isDebugEnabled()) {
225 log.debug("State after update - Local Bucket [{}], Remote Buckets [{}]", localBucket, remoteBuckets);
229 public BucketImpl<T> getLocalBucket() {
233 protected void updateLocalBucket(T data) {
234 localBucket.setData(data);
235 versions.put(selfAddress, localBucket.getVersion());
238 public Map<Address, Bucket<T>> getRemoteBuckets() {
239 return remoteBuckets;
242 public Map<Address, Long> getVersions() {