Bug 7521: Add FileBackedOutputStream and use for snapshot chunking
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / RaftActorContextImpl.java
index fa851515d70d94d7a8b7411652519926d5d85a1e..b307195a7ae038a976beae15997376a30a4f590f 100644 (file)
@@ -13,6 +13,7 @@ import akka.actor.ActorRef;
 import akka.actor.ActorSelection;
 import akka.actor.ActorSystem;
 import akka.actor.Props;
+import akka.cluster.Cluster;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import java.util.ArrayList;
@@ -21,15 +22,28 @@ import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
-import java.util.function.Supplier;
+import java.util.function.Consumer;
+import java.util.function.LongSupplier;
+import javax.annotation.Nonnull;
 import org.opendaylight.controller.cluster.DataPersistenceProvider;
-import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
+import org.opendaylight.controller.cluster.io.FileBackedOutputStream;
+import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
+import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
+import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
 import org.slf4j.Logger;
 
+/**
+ * Implementation of the RaftActorContext interface.
+ *
+ * @author Moiz Raja
+ * @author Thomas Pantelis
+ */
 public class RaftActorContextImpl implements RaftActorContext {
+    private static final LongSupplier JVM_MEMORY_RETRIEVER = () -> Runtime.getRuntime().maxMemory();
 
     private final ActorRef actor;
 
@@ -47,14 +61,14 @@ public class RaftActorContextImpl implements RaftActorContext {
 
     private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
 
-    private final Logger LOG;
+    private final Logger log;
 
     private ConfigParams configParams;
 
     private boolean dynamicServerConfiguration = false;
 
     @VisibleForTesting
-    private Supplier<Long> totalMemoryRetriever;
+    private LongSupplier totalMemoryRetriever = JVM_MEMORY_RETRIEVER;
 
     // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
     // be passed to it in the constructor
@@ -68,20 +82,29 @@ public class RaftActorContextImpl implements RaftActorContext {
 
     private RaftActorBehavior currentBehavior;
 
+    private int numVotingPeers = -1;
+
+    private Optional<Cluster> cluster;
+
+    private final Consumer<ApplyState> applyStateConsumer;
+
     public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
-            ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
-            ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
+            @Nonnull ElectionTerm termInformation, long commitIndex, long lastApplied,
+            @Nonnull Map<String, String> peerAddresses,
+            @Nonnull ConfigParams configParams, @Nonnull DataPersistenceProvider persistenceProvider,
+            @Nonnull Consumer<ApplyState> applyStateConsumer, @Nonnull Logger logger) {
         this.actor = actor;
         this.context = context;
         this.id = id;
-        this.termInformation = termInformation;
+        this.termInformation = Preconditions.checkNotNull(termInformation);
         this.commitIndex = commitIndex;
         this.lastApplied = lastApplied;
-        this.configParams = configParams;
-        this.persistenceProvider = persistenceProvider;
-        this.LOG = logger;
+        this.configParams = Preconditions.checkNotNull(configParams);
+        this.persistenceProvider = Preconditions.checkNotNull(persistenceProvider);
+        this.log = Preconditions.checkNotNull(logger);
+        this.applyStateConsumer = Preconditions.checkNotNull(applyStateConsumer);
 
-        for(Map.Entry<String, String> e: peerAddresses.entrySet()) {
+        for (Map.Entry<String, String> e: Preconditions.checkNotNull(peerAddresses).entrySet()) {
             peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
         }
     }
@@ -101,12 +124,12 @@ public class RaftActorContextImpl implements RaftActorContext {
     }
 
     @Override
-    public ActorRef actorOf(Props props){
+    public ActorRef actorOf(Props props) {
         return context.actorOf(props);
     }
 
     @Override
-    public ActorSelection actorSelection(String path){
+    public ActorSelection actorSelection(String path) {
         return context.actorSelection(path);
     }
 
@@ -120,6 +143,22 @@ public class RaftActorContextImpl implements RaftActorContext {
         return actor;
     }
 
+    @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public Optional<Cluster> getCluster() {
+        if (cluster == null) {
+            try {
+                cluster = Optional.of(Cluster.get(getActorSystem()));
+            } catch (Exception e) {
+                // An exception means there's no cluster configured. This will only happen in unit tests.
+                log.debug("{}: Could not obtain Cluster: {}", getId(), e);
+                cluster = Optional.empty();
+            }
+        }
+
+        return cluster;
+    }
+
     @Override
     public ElectionTerm getTermInformation() {
         return termInformation;
@@ -159,7 +198,7 @@ public class RaftActorContextImpl implements RaftActorContext {
     }
 
     @Override public Logger getLogger() {
-        return this.LOG;
+        return this.log;
     }
 
     @Override
@@ -179,11 +218,11 @@ public class RaftActorContextImpl implements RaftActorContext {
 
     @Override
     public String getPeerAddress(String peerId) {
-        String peerAddress = null;
+        String peerAddress;
         PeerInfo peerInfo = peerInfoMap.get(peerId);
-        if(peerInfo != null) {
+        if (peerInfo != null) {
             peerAddress = peerInfo.getAddress();
-            if(peerAddress == null) {
+            if (peerAddress == null) {
                 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
                 peerInfo.setAddress(peerAddress);
             }
@@ -195,19 +234,19 @@ public class RaftActorContextImpl implements RaftActorContext {
     }
 
     @Override
-    public void updatePeerIds(ServerConfigurationPayload serverConfig){
+    public void updatePeerIds(ServerConfigurationPayload serverConfig) {
         votingMember = true;
         boolean foundSelf = false;
         Set<String> currentPeers = new HashSet<>(this.getPeerIds());
-        for(ServerInfo server: serverConfig.getServerConfig()) {
-            if(getId().equals(server.getId())) {
+        for (ServerInfo server : serverConfig.getServerConfig()) {
+            if (getId().equals(server.getId())) {
                 foundSelf = true;
-                if(!server.isVoting()) {
+                if (!server.isVoting()) {
                     votingMember = false;
                 }
             } else {
-                VotingState votingState = server.isVoting() ? VotingState.VOTING: VotingState.NON_VOTING;
-                if(!currentPeers.contains(server.getId())) {
+                VotingState votingState = server.isVoting() ? VotingState.VOTING : VotingState.NON_VOTING;
+                if (!currentPeers.contains(server.getId())) {
                     this.addToPeers(server.getId(), null, votingState);
                 } else {
                     this.getPeerInfo(server.getId()).setVotingState(votingState);
@@ -216,14 +255,16 @@ public class RaftActorContextImpl implements RaftActorContext {
             }
         }
 
-        for(String peerIdToRemove: currentPeers) {
+        for (String peerIdToRemove : currentPeers) {
             this.removePeer(peerIdToRemove);
         }
 
-        if(!foundSelf) {
+        if (!foundSelf) {
             votingMember = false;
         }
 
+        log.debug("{}: Updated server config: isVoting: {}, peers: {}", id, votingMember, peerInfoMap.values());
+
         setDynamicServerConfigurationInUse();
     }
 
@@ -232,22 +273,24 @@ public class RaftActorContextImpl implements RaftActorContext {
     }
 
     @Override
-    public void addToPeers(String id, String address, VotingState votingState) {
-        peerInfoMap.put(id, new PeerInfo(id, address, votingState));
+    public void addToPeers(String peerId, String address, VotingState votingState) {
+        peerInfoMap.put(peerId, new PeerInfo(peerId, address, votingState));
+        numVotingPeers = -1;
     }
 
     @Override
     public void removePeer(String name) {
-        if(getId().equals(name)) {
+        if (getId().equals(name)) {
             votingMember = false;
         } else {
             peerInfoMap.remove(name);
+            numVotingPeers = -1;
         }
     }
 
     @Override public ActorSelection getPeerActorSelection(String peerId) {
         String peerAddress = getPeerAddress(peerId);
-        if(peerAddress != null){
+        if (peerAddress != null) {
             return actorSelection(peerAddress);
         }
         return null;
@@ -256,33 +299,33 @@ public class RaftActorContextImpl implements RaftActorContext {
     @Override
     public void setPeerAddress(String peerId, String peerAddress) {
         PeerInfo peerInfo = peerInfoMap.get(peerId);
-        if(peerInfo != null) {
-            LOG.info("Peer address for peer {} set to {}", peerId, peerAddress);
+        if (peerInfo != null) {
+            log.info("Peer address for peer {} set to {}", peerId, peerAddress);
             peerInfo.setAddress(peerAddress);
         }
     }
 
     @Override
     public SnapshotManager getSnapshotManager() {
-        if(snapshotManager == null){
-            snapshotManager = new SnapshotManager(this, LOG);
+        if (snapshotManager == null) {
+            snapshotManager = new SnapshotManager(this, log);
         }
         return snapshotManager;
     }
 
     @Override
     public long getTotalMemory() {
-        return totalMemoryRetriever != null ? totalMemoryRetriever.get() : Runtime.getRuntime().totalMemory();
+        return totalMemoryRetriever.getAsLong();
     }
 
     @Override
-    public void setTotalMemoryRetriever(Supplier<Long> retriever) {
-        totalMemoryRetriever = retriever;
+    public void setTotalMemoryRetriever(LongSupplier retriever) {
+        totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
     }
 
     @Override
     public boolean hasFollowers() {
-        return getPeerIds().size() > 0;
+        return !getPeerIds().isEmpty();
     }
 
     @Override
@@ -313,15 +356,15 @@ public class RaftActorContextImpl implements RaftActorContext {
         }
         Collection<PeerInfo> peers = getPeers();
         List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
-        for(PeerInfo peer: peers) {
+        for (PeerInfo peer: peers) {
             newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
         }
 
-        if(includeSelf) {
+        if (includeSelf) {
             newConfig.add(new ServerInfo(getId(), votingMember));
         }
 
-        return (new ServerConfigurationPayload(newConfig));
+        return new ServerConfigurationPayload(newConfig);
     }
 
     @Override
@@ -329,6 +372,20 @@ public class RaftActorContextImpl implements RaftActorContext {
         return votingMember;
     }
 
+    @Override
+    public boolean anyVotingPeers() {
+        if (numVotingPeers < 0) {
+            numVotingPeers = 0;
+            for (PeerInfo info: getPeers()) {
+                if (info.isVoting()) {
+                    numVotingPeers++;
+                }
+            }
+        }
+
+        return numVotingPeers > 0;
+    }
+
     @Override
     public RaftActorBehavior getCurrentBehavior() {
         return currentBehavior;
@@ -338,12 +395,24 @@ public class RaftActorContextImpl implements RaftActorContext {
         this.currentBehavior = Preconditions.checkNotNull(behavior);
     }
 
+    @Override
+    public Consumer<ApplyState> getApplyStateConsumer() {
+        return applyStateConsumer;
+    }
+
+    @Override
+    public FileBackedOutputStream newFileBackedOutputStream() {
+        return new FileBackedOutputStream(configParams.getFileBackedStreamingThreshold(),
+                configParams.getTempFileDirectory());
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
     void close() {
         if (currentBehavior != null) {
             try {
                 currentBehavior.close();
             } catch (Exception e) {
-                LOG.debug("{}: Error closing behavior {}", getId(), currentBehavior.state());
+                log.debug("{}: Error closing behavior {}", getId(), currentBehavior.state(), e);
             }
         }
     }