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 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;
22 import java.util.HashMap;
25 import java.util.concurrent.ConcurrentHashMap;
26 import java.util.concurrent.ConcurrentMap;
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;
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.
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}.
48 public class BucketStore extends AbstractUntypedActorWithMetering {
50 final LoggingAdapter log = Logging.getLogger(getContext().system(), this);
53 * Bucket owned by the node
55 private BucketImpl localBucket = new BucketImpl();
58 * Buckets ownded by other known nodes in the cluster
60 private ConcurrentMap<Address, Bucket> remoteBuckets = new ConcurrentHashMap<>();
63 * Bucket version for every known node in the cluster including this node
65 private ConcurrentMap<Address, Long> versions = new ConcurrentHashMap<>();
68 * Cluster address for this node
70 private Address selfAddress;
72 private ConditionalProbe probe;
74 private final RemoteRpcProviderConfig config;
77 config = new RemoteRpcProviderConfig(getContext().system().settings().config());
81 public void preStart(){
82 ActorRefProvider provider = getContext().provider();
83 selfAddress = provider.getDefaultAddress();
85 if ( provider instanceof ClusterActorRefProvider)
86 getContext().actorOf(Props.create(Gossiper.class).withMailbox(config.getMailBoxName()), "gossiper");
91 protected void handleReceive(Object message) throws Exception {
93 probe.tell(message, getSelf());
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());
114 if(log.isDebugEnabled()) {
115 log.debug("Unhandled message [{}]", message);
122 * Returns a copy of bucket owned by this node
124 private void receiveGetLocalBucket() {
125 final ActorRef sender = getSender();
126 GetLocalBucketReply reply = new GetLocalBucketReply(localBucket);
127 sender.tell(reply, getSelf());
131 * Updates the bucket owned by this node
133 * @param updatedBucket
135 void receiveUpdateBucket(Bucket updatedBucket){
137 localBucket = (BucketImpl) updatedBucket;
138 versions.put(selfAddress, localBucket.getVersion());
142 * Returns all the buckets the this node knows about, self owned + remote
144 void receiveGetAllBucket(){
145 final ActorRef sender = getSender();
146 sender.tell(new GetAllBucketsReply(getAllBuckets()), getSelf());
150 * Helper to collect all known buckets
152 * @return self owned + remote buckets
154 Map<Address, Bucket> getAllBuckets(){
155 Map<Address, Bucket> all = new HashMap<>(remoteBuckets.size() + 1);
157 //first add the local bucket
158 all.put(selfAddress, localBucket);
160 //then get all remote buckets
161 all.putAll(remoteBuckets);
167 * Returns buckets for requested members that this node knows about
169 * @param members requested members
171 void receiveGetBucketsByMembers(Set<Address> members){
172 final ActorRef sender = getSender();
173 Map<Address, Bucket> buckets = getBucketsByMembers(members);
174 sender.tell(new GetBucketsByMembersReply(buckets), getSelf());
178 * Helper to collect buckets for requested memebers
180 * @param members requested members
181 * @return buckets for requested memebers
183 Map<Address, Bucket> getBucketsByMembers(Set<Address> members) {
184 Map<Address, Bucket> buckets = new HashMap<>();
186 //first add the local bucket if asked
187 if (members.contains(selfAddress))
188 buckets.put(selfAddress, localBucket);
190 //then get buckets for requested remote nodes
191 for (Address address : members){
192 if (remoteBuckets.containsKey(address))
193 buckets.put(address, remoteBuckets.get(address));
200 * Returns versions for all buckets known
202 void receiveGetBucketVersions(){
203 final ActorRef sender = getSender();
204 GetBucketVersionsReply reply = new GetBucketVersionsReply(versions);
205 sender.tell(reply, getSelf());
209 * Update local copy of remote buckets where local copy's version is older
211 * @param receivedBuckets buckets sent by remote
212 * {@link org.opendaylight.controller.remote.rpc.registry.gossip.Gossiper}
214 void receiveUpdateRemoteBuckets(Map<Address, Bucket> receivedBuckets){
216 if (receivedBuckets == null || receivedBuckets.isEmpty())
217 return; //nothing to do
219 //Remote cant update self's bucket
220 receivedBuckets.remove(selfAddress);
222 for (Map.Entry<Address, Bucket> entry : receivedBuckets.entrySet()){
224 Long localVersion = versions.get(entry.getKey());
225 if (localVersion == null) localVersion = -1L;
227 Bucket receivedBucket = entry.getValue();
229 if (receivedBucket == null)
232 Long remoteVersion = receivedBucket.getVersion();
233 if (remoteVersion == null) remoteVersion = -1L;
235 //update only if remote version is newer
236 if ( remoteVersion.longValue() > localVersion.longValue() ) {
237 remoteBuckets.put(entry.getKey(), receivedBucket);
238 versions.put(entry.getKey(), remoteVersion);
241 if(log.isDebugEnabled()) {
242 log.debug("State after update - Local Bucket [{}], Remote Buckets [{}]", localBucket, remoteBuckets);
250 BucketImpl getLocalBucket() {
254 void setLocalBucket(BucketImpl localBucket) {
255 this.localBucket = localBucket;
258 ConcurrentMap<Address, Bucket> getRemoteBuckets() {
259 return remoteBuckets;
262 void setRemoteBuckets(ConcurrentMap<Address, Bucket> remoteBuckets) {
263 this.remoteBuckets = remoteBuckets;
266 ConcurrentMap<Address, Long> getVersions() {
270 void setVersions(ConcurrentMap<Address, Long> versions) {
271 this.versions = versions;
274 Address getSelfAddress() {