opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorContextImpl.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.cluster.raft;
  10
  11 import akka.actor.ActorContext;
  12 import akka.actor.ActorRef;
  13 import akka.actor.ActorSelection;
  14 import akka.actor.ActorSystem;
  15 import akka.actor.Props;
  16 import com.google.common.annotations.VisibleForTesting;
  17 import com.google.common.base.Preconditions;
  18 import com.google.common.base.Supplier;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Set;
  26 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  27 import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
  28 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
  29 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
  30 import org.slf4j.Logger;
  31
  32 public class RaftActorContextImpl implements RaftActorContext {
  33
  34     private final ActorRef actor;
  35
  36     private final ActorContext context;
  37
  38     private final String id;
  39
  40     private final ElectionTerm termInformation;
  41
  42     private long commitIndex;
  43
  44     private long lastApplied;
  45
  46     private ReplicatedLog replicatedLog;
  47
  48     private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
  49
  50     private final Logger LOG;
  51
  52     private ConfigParams configParams;
  53
  54     private boolean dynamicServerConfiguration = false;
  55
  56     @VisibleForTesting
  57     private Supplier<Long> totalMemoryRetriever;
  58
  59     // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
  60     // be passed to it in the constructor
  61     private SnapshotManager snapshotManager;
  62
  63     private final DataPersistenceProvider persistenceProvider;
  64
  65     private short payloadVersion;
  66
  67     private boolean votingMember = true;
  68
  69     private RaftActorBehavior currentBehavior;
  70
  71     public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
  72             ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
  73             ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
  74         this.actor = actor;
  75         this.context = context;
  76         this.id = id;
  77         this.termInformation = termInformation;
  78         this.commitIndex = commitIndex;
  79         this.lastApplied = lastApplied;
  80         this.configParams = configParams;
  81         this.persistenceProvider = persistenceProvider;
  82         this.LOG = logger;
  83
  84         for(Map.Entry<String, String> e: peerAddresses.entrySet()) {
  85             peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
  86         }
  87     }
  88
  89     public void setPayloadVersion(short payloadVersion) {
  90         this.payloadVersion = payloadVersion;
  91     }
  92
  93     @Override
  94     public short getPayloadVersion() {
  95         return payloadVersion;
  96     }
  97
  98     public void setConfigParams(ConfigParams configParams) {
  99         this.configParams = configParams;
 100     }
 101
 102     @Override
 103     public ActorRef actorOf(Props props){
 104         return context.actorOf(props);
 105     }
 106
 107     @Override
 108     public ActorSelection actorSelection(String path){
 109         return context.actorSelection(path);
 110     }
 111
 112     @Override
 113     public String getId() {
 114         return id;
 115     }
 116
 117     @Override
 118     public ActorRef getActor() {
 119         return actor;
 120     }
 121
 122     @Override
 123     public ElectionTerm getTermInformation() {
 124         return termInformation;
 125     }
 126
 127     @Override
 128     public long getCommitIndex() {
 129         return commitIndex;
 130     }
 131
 132     @Override public void setCommitIndex(long commitIndex) {
 133         this.commitIndex = commitIndex;
 134     }
 135
 136     @Override
 137     public long getLastApplied() {
 138         return lastApplied;
 139     }
 140
 141     @Override
 142     public void setLastApplied(long lastApplied) {
 143         this.lastApplied = lastApplied;
 144     }
 145
 146     @Override
 147     public void setReplicatedLog(ReplicatedLog replicatedLog) {
 148         this.replicatedLog = replicatedLog;
 149     }
 150
 151     @Override
 152     public ReplicatedLog getReplicatedLog() {
 153         return replicatedLog;
 154     }
 155
 156     @Override public ActorSystem getActorSystem() {
 157         return context.system();
 158     }
 159
 160     @Override public Logger getLogger() {
 161         return this.LOG;
 162     }
 163
 164     @Override
 165     public Collection<String> getPeerIds() {
 166         return peerInfoMap.keySet();
 167     }
 168
 169     @Override
 170     public Collection<PeerInfo> getPeers() {
 171         return peerInfoMap.values();
 172     }
 173
 174     @Override
 175     public PeerInfo getPeerInfo(String peerId) {
 176         return peerInfoMap.get(peerId);
 177     }
 178
 179     @Override
 180     public String getPeerAddress(String peerId) {
 181         String peerAddress = null;
 182         PeerInfo peerInfo = peerInfoMap.get(peerId);
 183         if(peerInfo != null) {
 184             peerAddress = peerInfo.getAddress();
 185             if(peerAddress == null) {
 186                 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
 187                 peerInfo.setAddress(peerAddress);
 188             }
 189         } else {
 190             peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
 191         }
 192
 193         return peerAddress;
 194     }
 195
 196     @Override
 197     public void updatePeerIds(ServerConfigurationPayload serverConfig){
 198         votingMember = true;
 199         boolean foundSelf = false;
 200         Set<String> currentPeers = new HashSet<>(this.getPeerIds());
 201         for(ServerInfo server: serverConfig.getServerConfig()) {
 202             if(getId().equals(server.getId())) {
 203                 foundSelf = true;
 204                 if(!server.isVoting()) {
 205                     votingMember = false;
 206                 }
 207             } else {
 208                 VotingState votingState = server.isVoting() ? VotingState.VOTING: VotingState.NON_VOTING;
 209                 if(!currentPeers.contains(server.getId())) {
 210                     this.addToPeers(server.getId(), null, votingState);
 211                 } else {
 212                     this.getPeerInfo(server.getId()).setVotingState(votingState);
 213                     currentPeers.remove(server.getId());
 214                 }
 215             }
 216         }
 217
 218         for(String peerIdToRemove: currentPeers) {
 219             this.removePeer(peerIdToRemove);
 220         }
 221
 222         if(!foundSelf) {
 223             votingMember = false;
 224         }
 225
 226         setDynamicServerConfigurationInUse();
 227     }
 228
 229     @Override public ConfigParams getConfigParams() {
 230         return configParams;
 231     }
 232
 233     @Override
 234     public void addToPeers(String id, String address, VotingState votingState) {
 235         peerInfoMap.put(id, new PeerInfo(id, address, votingState));
 236     }
 237
 238     @Override
 239     public void removePeer(String name) {
 240         if(getId().equals(name)) {
 241             votingMember = false;
 242         } else {
 243             peerInfoMap.remove(name);
 244         }
 245     }
 246
 247     @Override public ActorSelection getPeerActorSelection(String peerId) {
 248         String peerAddress = getPeerAddress(peerId);
 249         if(peerAddress != null){
 250             return actorSelection(peerAddress);
 251         }
 252         return null;
 253     }
 254
 255     @Override
 256     public void setPeerAddress(String peerId, String peerAddress) {
 257         PeerInfo peerInfo = peerInfoMap.get(peerId);
 258         if(peerInfo != null) {
 259             LOG.info("Peer address for peer {} set to {}", peerId, peerAddress);
 260             peerInfo.setAddress(peerAddress);
 261         }
 262     }
 263
 264     @Override
 265     public SnapshotManager getSnapshotManager() {
 266         if(snapshotManager == null){
 267             snapshotManager = new SnapshotManager(this, LOG);
 268         }
 269         return snapshotManager;
 270     }
 271
 272     @Override
 273     public long getTotalMemory() {
 274         return totalMemoryRetriever != null ? totalMemoryRetriever.get() : Runtime.getRuntime().totalMemory();
 275     }
 276
 277     @Override
 278     public void setTotalMemoryRetriever(Supplier<Long> retriever) {
 279         totalMemoryRetriever = retriever;
 280     }
 281
 282     @Override
 283     public boolean hasFollowers() {
 284         return getPeerIds().size() > 0;
 285     }
 286
 287     @Override
 288     public DataPersistenceProvider getPersistenceProvider() {
 289         return persistenceProvider;
 290     }
 291
 292
 293     @Override
 294     public RaftPolicy getRaftPolicy() {
 295         return configParams.getRaftPolicy();
 296     }
 297
 298     @Override
 299     public boolean isDynamicServerConfigurationInUse() {
 300         return dynamicServerConfiguration;
 301     }
 302
 303     @Override
 304     public void setDynamicServerConfigurationInUse() {
 305         this.dynamicServerConfiguration = true;
 306     }
 307
 308     @Override
 309     public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
 310         if (!isDynamicServerConfigurationInUse()) {
 311             return null;
 312         }
 313         Collection<PeerInfo> peers = getPeers();
 314         List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
 315         for(PeerInfo peer: peers) {
 316             newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
 317         }
 318
 319         if(includeSelf) {
 320             newConfig.add(new ServerInfo(getId(), votingMember));
 321         }
 322
 323         return (new ServerConfigurationPayload(newConfig));
 324     }
 325
 326     @Override
 327     public boolean isVotingMember() {
 328         return votingMember;
 329     }
 330
 331     @Override
 332     public RaftActorBehavior getCurrentBehavior() {
 333         return currentBehavior;
 334     }
 335
 336     void setCurrentBehavior(final RaftActorBehavior behavior) {
 337         this.currentBehavior = Preconditions.checkNotNull(behavior);
 338     }
 339
 340     void close() {
 341         if (currentBehavior != null) {
 342             try {
 343                 currentBehavior.close();
 344             } catch (Exception e) {
 345                 LOG.debug("{}: Error closing behavior {}", getId(), currentBehavior.state());
 346             }
 347         }
 348     }
 349 }