2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.cluster.raft;
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;
25 import java.util.Optional;
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;
41 * Implementation of the RaftActorContext interface.
44 * @author Thomas Pantelis
46 public class RaftActorContextImpl implements RaftActorContext {
47 private static final LongSupplier JVM_MEMORY_RETRIEVER = () -> Runtime.getRuntime().maxMemory();
49 private final ActorRef actor;
51 private final ActorContext context;
53 private final String id;
55 private final ElectionTerm termInformation;
57 private long commitIndex;
59 private long lastApplied;
61 private ReplicatedLog replicatedLog;
63 private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
65 private final Logger log;
67 private ConfigParams configParams;
69 private boolean dynamicServerConfiguration = false;
72 private LongSupplier totalMemoryRetriever = JVM_MEMORY_RETRIEVER;
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;
78 private final DataPersistenceProvider persistenceProvider;
80 private short payloadVersion;
82 private boolean votingMember = true;
84 private RaftActorBehavior currentBehavior;
86 private int numVotingPeers = -1;
88 private Optional<Cluster> cluster;
90 private final Consumer<ApplyState> applyStateConsumer;
92 private final FileBackedOutputStreamFactory fileBackedOutputStreamFactory;
94 private RaftActorLeadershipTransferCohort leadershipTransferCohort;
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) {
102 this.context = context;
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);
112 fileBackedOutputStreamFactory = new FileBackedOutputStreamFactory(
113 configParams.getFileBackedStreamingThreshold(), configParams.getTempFileDirectory());
115 for (Map.Entry<String, String> e: Preconditions.checkNotNull(peerAddresses).entrySet()) {
116 peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
121 public void setPayloadVersion(short payloadVersion) {
122 this.payloadVersion = payloadVersion;
126 public short getPayloadVersion() {
127 return payloadVersion;
130 public void setConfigParams(ConfigParams configParams) {
131 this.configParams = configParams;
135 public ActorRef actorOf(Props props) {
136 return context.actorOf(props);
140 public ActorSelection actorSelection(String path) {
141 return context.actorSelection(path);
145 public String getId() {
150 public ActorRef getActor() {
155 @SuppressWarnings("checkstyle:IllegalCatch")
156 public Optional<Cluster> getCluster() {
157 if (cluster == null) {
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();
171 public ElectionTerm getTermInformation() {
172 return termInformation;
176 public long getCommitIndex() {
180 @Override public void setCommitIndex(long commitIndex) {
181 this.commitIndex = commitIndex;
185 public long getLastApplied() {
190 public void setLastApplied(long lastApplied) {
191 log.debug("{}: Moving last applied index from {} to {}", id, this.lastApplied, lastApplied);
192 this.lastApplied = lastApplied;
196 public void setReplicatedLog(ReplicatedLog replicatedLog) {
197 this.replicatedLog = replicatedLog;
201 public ReplicatedLog getReplicatedLog() {
202 return replicatedLog;
205 @Override public ActorSystem getActorSystem() {
206 return context.system();
209 @Override public Logger getLogger() {
214 public Collection<String> getPeerIds() {
215 return peerInfoMap.keySet();
219 public Collection<PeerInfo> getPeers() {
220 return peerInfoMap.values();
224 public PeerInfo getPeerInfo(String peerId) {
225 return peerInfoMap.get(peerId);
229 public String getPeerAddress(String peerId) {
231 PeerInfo peerInfo = peerInfoMap.get(peerId);
232 if (peerInfo != null) {
233 peerAddress = peerInfo.getAddress();
234 if (peerAddress == null) {
235 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
236 peerInfo.setAddress(peerAddress);
239 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
246 public void updatePeerIds(ServerConfigurationPayload serverConfig) {
248 boolean foundSelf = false;
249 Set<String> currentPeers = new HashSet<>(this.getPeerIds());
250 for (ServerInfo server : serverConfig.getServerConfig()) {
251 if (getId().equals(server.getId())) {
253 if (!server.isVoting()) {
254 votingMember = false;
257 VotingState votingState = server.isVoting() ? VotingState.VOTING : VotingState.NON_VOTING;
258 if (!currentPeers.contains(server.getId())) {
259 this.addToPeers(server.getId(), null, votingState);
261 this.getPeerInfo(server.getId()).setVotingState(votingState);
262 currentPeers.remove(server.getId());
267 for (String peerIdToRemove : currentPeers) {
268 this.removePeer(peerIdToRemove);
272 votingMember = false;
275 log.debug("{}: Updated server config: isVoting: {}, peers: {}", id, votingMember, peerInfoMap.values());
277 setDynamicServerConfigurationInUse();
280 @Override public ConfigParams getConfigParams() {
285 public void addToPeers(String peerId, String address, VotingState votingState) {
286 peerInfoMap.put(peerId, new PeerInfo(peerId, address, votingState));
291 public void removePeer(String name) {
292 if (getId().equals(name)) {
293 votingMember = false;
295 peerInfoMap.remove(name);
300 @Override public ActorSelection getPeerActorSelection(String peerId) {
301 String peerAddress = getPeerAddress(peerId);
302 if (peerAddress != null) {
303 return actorSelection(peerAddress);
309 public void setPeerAddress(String peerId, String peerAddress) {
310 PeerInfo peerInfo = peerInfoMap.get(peerId);
311 if (peerInfo != null) {
312 log.info("Peer address for peer {} set to {}", peerId, peerAddress);
313 peerInfo.setAddress(peerAddress);
318 public SnapshotManager getSnapshotManager() {
319 if (snapshotManager == null) {
320 snapshotManager = new SnapshotManager(this, log);
322 return snapshotManager;
326 public long getTotalMemory() {
327 return totalMemoryRetriever.getAsLong();
331 public void setTotalMemoryRetriever(LongSupplier retriever) {
332 totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
336 public boolean hasFollowers() {
337 return !getPeerIds().isEmpty();
341 public DataPersistenceProvider getPersistenceProvider() {
342 return persistenceProvider;
347 public RaftPolicy getRaftPolicy() {
348 return configParams.getRaftPolicy();
352 public boolean isDynamicServerConfigurationInUse() {
353 return dynamicServerConfiguration;
357 public void setDynamicServerConfigurationInUse() {
358 this.dynamicServerConfiguration = true;
362 public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
363 if (!isDynamicServerConfigurationInUse()) {
366 Collection<PeerInfo> peers = getPeers();
367 List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
368 for (PeerInfo peer: peers) {
369 newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
373 newConfig.add(new ServerInfo(getId(), votingMember));
376 return new ServerConfigurationPayload(newConfig);
380 public boolean isVotingMember() {
385 public boolean anyVotingPeers() {
386 if (numVotingPeers < 0) {
388 for (PeerInfo info: getPeers()) {
389 if (info.isVoting()) {
395 return numVotingPeers > 0;
399 public RaftActorBehavior getCurrentBehavior() {
400 return currentBehavior;
403 void setCurrentBehavior(final RaftActorBehavior behavior) {
404 this.currentBehavior = Preconditions.checkNotNull(behavior);
408 public Consumer<ApplyState> getApplyStateConsumer() {
409 return applyStateConsumer;
413 public FileBackedOutputStreamFactory getFileBackedOutputStreamFactory() {
414 return fileBackedOutputStreamFactory;
417 @SuppressWarnings("checkstyle:IllegalCatch")
419 if (currentBehavior != null) {
421 currentBehavior.close();
422 } catch (Exception e) {
423 log.debug("{}: Error closing behavior {}", getId(), currentBehavior.state(), e);
430 public RaftActorLeadershipTransferCohort getRaftActorLeadershipTransferCohort() {
431 return leadershipTransferCohort;
435 public void setRaftActorLeadershipTransferCohort(
436 @Nullable RaftActorLeadershipTransferCohort leadershipTransferCohort) {
437 this.leadershipTransferCohort = leadershipTransferCohort;