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.FileBackedOutputStream;
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 RaftActorLeadershipTransferCohort leadershipTransferCohort;
94 public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
95 @Nonnull ElectionTerm termInformation, long commitIndex, long lastApplied,
96 @Nonnull Map<String, String> peerAddresses,
97 @Nonnull ConfigParams configParams, @Nonnull DataPersistenceProvider persistenceProvider,
98 @Nonnull Consumer<ApplyState> applyStateConsumer, @Nonnull Logger logger) {
100 this.context = context;
102 this.termInformation = Preconditions.checkNotNull(termInformation);
103 this.commitIndex = commitIndex;
104 this.lastApplied = lastApplied;
105 this.configParams = Preconditions.checkNotNull(configParams);
106 this.persistenceProvider = Preconditions.checkNotNull(persistenceProvider);
107 this.log = Preconditions.checkNotNull(logger);
108 this.applyStateConsumer = Preconditions.checkNotNull(applyStateConsumer);
110 for (Map.Entry<String, String> e: Preconditions.checkNotNull(peerAddresses).entrySet()) {
111 peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
116 public void setPayloadVersion(short payloadVersion) {
117 this.payloadVersion = payloadVersion;
121 public short getPayloadVersion() {
122 return payloadVersion;
125 public void setConfigParams(ConfigParams configParams) {
126 this.configParams = configParams;
130 public ActorRef actorOf(Props props) {
131 return context.actorOf(props);
135 public ActorSelection actorSelection(String path) {
136 return context.actorSelection(path);
140 public String getId() {
145 public ActorRef getActor() {
150 @SuppressWarnings("checkstyle:IllegalCatch")
151 public Optional<Cluster> getCluster() {
152 if (cluster == null) {
154 cluster = Optional.of(Cluster.get(getActorSystem()));
155 } catch (Exception e) {
156 // An exception means there's no cluster configured. This will only happen in unit tests.
157 log.debug("{}: Could not obtain Cluster: {}", getId(), e);
158 cluster = Optional.empty();
166 public ElectionTerm getTermInformation() {
167 return termInformation;
171 public long getCommitIndex() {
175 @Override public void setCommitIndex(long commitIndex) {
176 this.commitIndex = commitIndex;
180 public long getLastApplied() {
185 public void setLastApplied(long lastApplied) {
186 this.lastApplied = lastApplied;
190 public void setReplicatedLog(ReplicatedLog replicatedLog) {
191 this.replicatedLog = replicatedLog;
195 public ReplicatedLog getReplicatedLog() {
196 return replicatedLog;
199 @Override public ActorSystem getActorSystem() {
200 return context.system();
203 @Override public Logger getLogger() {
208 public Collection<String> getPeerIds() {
209 return peerInfoMap.keySet();
213 public Collection<PeerInfo> getPeers() {
214 return peerInfoMap.values();
218 public PeerInfo getPeerInfo(String peerId) {
219 return peerInfoMap.get(peerId);
223 public String getPeerAddress(String peerId) {
225 PeerInfo peerInfo = peerInfoMap.get(peerId);
226 if (peerInfo != null) {
227 peerAddress = peerInfo.getAddress();
228 if (peerAddress == null) {
229 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
230 peerInfo.setAddress(peerAddress);
233 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
240 public void updatePeerIds(ServerConfigurationPayload serverConfig) {
242 boolean foundSelf = false;
243 Set<String> currentPeers = new HashSet<>(this.getPeerIds());
244 for (ServerInfo server : serverConfig.getServerConfig()) {
245 if (getId().equals(server.getId())) {
247 if (!server.isVoting()) {
248 votingMember = false;
251 VotingState votingState = server.isVoting() ? VotingState.VOTING : VotingState.NON_VOTING;
252 if (!currentPeers.contains(server.getId())) {
253 this.addToPeers(server.getId(), null, votingState);
255 this.getPeerInfo(server.getId()).setVotingState(votingState);
256 currentPeers.remove(server.getId());
261 for (String peerIdToRemove : currentPeers) {
262 this.removePeer(peerIdToRemove);
266 votingMember = false;
269 log.debug("{}: Updated server config: isVoting: {}, peers: {}", id, votingMember, peerInfoMap.values());
271 setDynamicServerConfigurationInUse();
274 @Override public ConfigParams getConfigParams() {
279 public void addToPeers(String peerId, String address, VotingState votingState) {
280 peerInfoMap.put(peerId, new PeerInfo(peerId, address, votingState));
285 public void removePeer(String name) {
286 if (getId().equals(name)) {
287 votingMember = false;
289 peerInfoMap.remove(name);
294 @Override public ActorSelection getPeerActorSelection(String peerId) {
295 String peerAddress = getPeerAddress(peerId);
296 if (peerAddress != null) {
297 return actorSelection(peerAddress);
303 public void setPeerAddress(String peerId, String peerAddress) {
304 PeerInfo peerInfo = peerInfoMap.get(peerId);
305 if (peerInfo != null) {
306 log.info("Peer address for peer {} set to {}", peerId, peerAddress);
307 peerInfo.setAddress(peerAddress);
312 public SnapshotManager getSnapshotManager() {
313 if (snapshotManager == null) {
314 snapshotManager = new SnapshotManager(this, log);
316 return snapshotManager;
320 public long getTotalMemory() {
321 return totalMemoryRetriever.getAsLong();
325 public void setTotalMemoryRetriever(LongSupplier retriever) {
326 totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
330 public boolean hasFollowers() {
331 return !getPeerIds().isEmpty();
335 public DataPersistenceProvider getPersistenceProvider() {
336 return persistenceProvider;
341 public RaftPolicy getRaftPolicy() {
342 return configParams.getRaftPolicy();
346 public boolean isDynamicServerConfigurationInUse() {
347 return dynamicServerConfiguration;
351 public void setDynamicServerConfigurationInUse() {
352 this.dynamicServerConfiguration = true;
356 public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
357 if (!isDynamicServerConfigurationInUse()) {
360 Collection<PeerInfo> peers = getPeers();
361 List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
362 for (PeerInfo peer: peers) {
363 newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
367 newConfig.add(new ServerInfo(getId(), votingMember));
370 return new ServerConfigurationPayload(newConfig);
374 public boolean isVotingMember() {
379 public boolean anyVotingPeers() {
380 if (numVotingPeers < 0) {
382 for (PeerInfo info: getPeers()) {
383 if (info.isVoting()) {
389 return numVotingPeers > 0;
393 public RaftActorBehavior getCurrentBehavior() {
394 return currentBehavior;
397 void setCurrentBehavior(final RaftActorBehavior behavior) {
398 this.currentBehavior = Preconditions.checkNotNull(behavior);
402 public Consumer<ApplyState> getApplyStateConsumer() {
403 return applyStateConsumer;
407 public FileBackedOutputStream newFileBackedOutputStream() {
408 return new FileBackedOutputStream(configParams.getFileBackedStreamingThreshold(),
409 configParams.getTempFileDirectory());
412 @SuppressWarnings("checkstyle:IllegalCatch")
414 if (currentBehavior != null) {
416 currentBehavior.close();
417 } catch (Exception e) {
418 log.debug("{}: Error closing behavior {}", getId(), currentBehavior.state(), e);
425 public RaftActorLeadershipTransferCohort getRaftActorLeadershipTransferCohort() {
426 return leadershipTransferCohort;
430 public void setRaftActorLeadershipTransferCohort(
431 @Nullable RaftActorLeadershipTransferCohort leadershipTransferCohort) {
432 this.leadershipTransferCohort = leadershipTransferCohort;