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