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