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
8 package org.opendaylight.controller.cluster.raft;
10 import static java.util.Objects.requireNonNull;
12 import akka.actor.ActorContext;
13 import akka.actor.ActorRef;
14 import akka.actor.ActorSelection;
15 import akka.actor.ActorSystem;
16 import akka.actor.Props;
17 import akka.cluster.Cluster;
18 import com.google.common.annotations.VisibleForTesting;
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 org.eclipse.jdt.annotation.NonNull;
30 import org.opendaylight.controller.cluster.DataPersistenceProvider;
31 import org.opendaylight.controller.cluster.io.FileBackedOutputStreamFactory;
32 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
33 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
34 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
35 import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
36 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
37 import org.slf4j.Logger;
40 * Implementation of the RaftActorContext interface.
43 * @author Thomas Pantelis
45 public class RaftActorContextImpl implements RaftActorContext {
46 private static final LongSupplier JVM_MEMORY_RETRIEVER = () -> Runtime.getRuntime().maxMemory();
48 private final ActorRef actor;
50 private final ActorContext context;
52 private final String id;
54 private final ElectionTerm termInformation;
56 private long commitIndex;
58 private long lastApplied;
60 private ReplicatedLog replicatedLog;
62 private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
64 private final Logger log;
66 private ConfigParams configParams;
68 private boolean dynamicServerConfiguration = false;
71 private LongSupplier totalMemoryRetriever = JVM_MEMORY_RETRIEVER;
73 // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
74 // be passed to it in the constructor
75 private SnapshotManager snapshotManager;
77 private final DataPersistenceProvider persistenceProvider;
79 private short payloadVersion;
81 private boolean votingMember = true;
83 private RaftActorBehavior currentBehavior;
85 private int numVotingPeers = -1;
87 private Optional<Cluster> cluster;
89 private final Consumer<ApplyState> applyStateConsumer;
91 private final FileBackedOutputStreamFactory fileBackedOutputStreamFactory;
93 private RaftActorLeadershipTransferCohort leadershipTransferCohort;
95 public RaftActorContextImpl(final ActorRef actor, final ActorContext context, final String id,
96 final @NonNull ElectionTerm termInformation, final long commitIndex, final long lastApplied,
97 final @NonNull Map<String, String> peerAddresses,
98 final @NonNull ConfigParams configParams, final @NonNull DataPersistenceProvider persistenceProvider,
99 final @NonNull Consumer<ApplyState> applyStateConsumer, final @NonNull Logger logger) {
101 this.context = context;
103 this.termInformation = requireNonNull(termInformation);
104 this.commitIndex = commitIndex;
105 this.lastApplied = lastApplied;
106 this.configParams = requireNonNull(configParams);
107 this.persistenceProvider = requireNonNull(persistenceProvider);
108 this.log = requireNonNull(logger);
109 this.applyStateConsumer = requireNonNull(applyStateConsumer);
111 fileBackedOutputStreamFactory = new FileBackedOutputStreamFactory(
112 configParams.getFileBackedStreamingThreshold(), configParams.getTempFileDirectory());
114 for (Map.Entry<String, String> e : requireNonNull(peerAddresses).entrySet()) {
115 peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
120 public void setPayloadVersion(final short payloadVersion) {
121 this.payloadVersion = payloadVersion;
125 public short getPayloadVersion() {
126 return payloadVersion;
129 public void setConfigParams(final ConfigParams configParams) {
130 this.configParams = configParams;
134 public ActorRef actorOf(final Props props) {
135 return context.actorOf(props);
139 public ActorSelection actorSelection(final String path) {
140 return context.actorSelection(path);
144 public String getId() {
149 public ActorRef getActor() {
154 @SuppressWarnings("checkstyle:IllegalCatch")
155 public Optional<Cluster> getCluster() {
156 if (cluster == null) {
158 cluster = Optional.of(Cluster.get(getActorSystem()));
159 } catch (Exception e) {
160 // An exception means there's no cluster configured. This will only happen in unit tests.
161 log.debug("{}: Could not obtain Cluster", getId(), e);
162 cluster = Optional.empty();
170 public ElectionTerm getTermInformation() {
171 return termInformation;
175 public long getCommitIndex() {
179 @Override public void setCommitIndex(final long commitIndex) {
180 this.commitIndex = commitIndex;
184 public long getLastApplied() {
189 public void setLastApplied(final long lastApplied) {
190 final Throwable stackTrace = log.isTraceEnabled() ? new Throwable() : null;
191 log.debug("{}: Moving last applied index from {} to {}", id, this.lastApplied, lastApplied, stackTrace);
192 this.lastApplied = lastApplied;
196 public void setReplicatedLog(final ReplicatedLog replicatedLog) {
197 this.replicatedLog = replicatedLog;
201 public ReplicatedLog getReplicatedLog() {
202 return replicatedLog;
206 public ActorSystem getActorSystem() {
207 return context.system();
211 public Logger getLogger() {
216 public Collection<String> getPeerIds() {
217 return peerInfoMap.keySet();
221 public Collection<PeerInfo> getPeers() {
222 return peerInfoMap.values();
226 public PeerInfo getPeerInfo(final String peerId) {
227 return peerInfoMap.get(peerId);
231 public String getPeerAddress(final String peerId) {
233 PeerInfo peerInfo = peerInfoMap.get(peerId);
234 if (peerInfo != null) {
235 peerAddress = peerInfo.getAddress();
236 if (peerAddress == null) {
237 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
238 peerInfo.setAddress(peerAddress);
241 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
248 public void updatePeerIds(final ServerConfigurationPayload serverConfig) {
250 boolean foundSelf = false;
251 Set<String> currentPeers = new HashSet<>(this.getPeerIds());
252 for (ServerInfo server : serverConfig.getServerConfig()) {
253 if (getId().equals(server.getId())) {
255 if (!server.isVoting()) {
256 votingMember = false;
259 VotingState votingState = server.isVoting() ? VotingState.VOTING : VotingState.NON_VOTING;
260 if (!currentPeers.contains(server.getId())) {
261 this.addToPeers(server.getId(), null, votingState);
263 this.getPeerInfo(server.getId()).setVotingState(votingState);
264 currentPeers.remove(server.getId());
269 for (String peerIdToRemove : currentPeers) {
270 this.removePeer(peerIdToRemove);
274 votingMember = false;
277 log.debug("{}: Updated server config: isVoting: {}, peers: {}", id, votingMember, peerInfoMap.values());
279 setDynamicServerConfigurationInUse();
282 @Override public ConfigParams getConfigParams() {
287 public void addToPeers(final String peerId, final String address, final VotingState votingState) {
288 peerInfoMap.put(peerId, new PeerInfo(peerId, address, votingState));
293 public void removePeer(final String name) {
294 if (getId().equals(name)) {
295 votingMember = false;
297 peerInfoMap.remove(name);
302 @Override public ActorSelection getPeerActorSelection(final String peerId) {
303 String peerAddress = getPeerAddress(peerId);
304 if (peerAddress != null) {
305 return actorSelection(peerAddress);
311 public void setPeerAddress(final String peerId, final String peerAddress) {
312 PeerInfo peerInfo = peerInfoMap.get(peerId);
313 if (peerInfo != null) {
314 log.info("Peer address for peer {} set to {}", peerId, peerAddress);
315 peerInfo.setAddress(peerAddress);
320 public SnapshotManager getSnapshotManager() {
321 if (snapshotManager == null) {
322 snapshotManager = new SnapshotManager(this, log);
324 return snapshotManager;
328 public long getTotalMemory() {
329 return totalMemoryRetriever.getAsLong();
333 public void setTotalMemoryRetriever(final LongSupplier retriever) {
334 totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
338 public boolean hasFollowers() {
339 return !getPeerIds().isEmpty();
343 public DataPersistenceProvider getPersistenceProvider() {
344 return persistenceProvider;
349 public RaftPolicy getRaftPolicy() {
350 return configParams.getRaftPolicy();
354 public boolean isDynamicServerConfigurationInUse() {
355 return dynamicServerConfiguration;
359 public void setDynamicServerConfigurationInUse() {
360 this.dynamicServerConfiguration = true;
364 public ServerConfigurationPayload getPeerServerInfo(final boolean includeSelf) {
365 if (!isDynamicServerConfigurationInUse()) {
368 Collection<PeerInfo> peers = getPeers();
369 List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
370 for (PeerInfo peer: peers) {
371 newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
375 newConfig.add(new ServerInfo(getId(), votingMember));
378 return new ServerConfigurationPayload(newConfig);
382 public boolean isVotingMember() {
387 public boolean anyVotingPeers() {
388 if (numVotingPeers < 0) {
390 for (PeerInfo info: getPeers()) {
391 if (info.isVoting()) {
397 return numVotingPeers > 0;
401 public RaftActorBehavior getCurrentBehavior() {
402 return currentBehavior;
405 void setCurrentBehavior(final RaftActorBehavior behavior) {
406 this.currentBehavior = requireNonNull(behavior);
410 public Consumer<ApplyState> getApplyStateConsumer() {
411 return applyStateConsumer;
415 public FileBackedOutputStreamFactory getFileBackedOutputStreamFactory() {
416 return fileBackedOutputStreamFactory;
419 @SuppressWarnings("checkstyle:IllegalCatch")
421 if (currentBehavior != null) {
423 currentBehavior.close();
424 } catch (Exception e) {
425 log.debug("{}: Error closing behavior {}", getId(), currentBehavior.state(), e);
431 public RaftActorLeadershipTransferCohort getRaftActorLeadershipTransferCohort() {
432 return leadershipTransferCohort;
436 @SuppressWarnings("checkstyle:hiddenField")
437 public void setRaftActorLeadershipTransferCohort(final RaftActorLeadershipTransferCohort leadershipTransferCohort) {
438 this.leadershipTransferCohort = leadershipTransferCohort;