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