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.LongSupplier;
28 import org.opendaylight.controller.cluster.DataPersistenceProvider;
29 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
30 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
31 import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
32 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
33 import org.slf4j.Logger;
36 * Implementation of the RaftActorContext interface.
39 * @author Thomas Pantelis
41 public class RaftActorContextImpl implements RaftActorContext {
42 private static final LongSupplier JVM_MEMORY_RETRIEVER = () -> Runtime.getRuntime().maxMemory();
44 private final ActorRef actor;
46 private final ActorContext context;
48 private final String id;
50 private final ElectionTerm termInformation;
52 private long commitIndex;
54 private long lastApplied;
56 private ReplicatedLog replicatedLog;
58 private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
60 private final Logger log;
62 private ConfigParams configParams;
64 private boolean dynamicServerConfiguration = false;
67 private LongSupplier totalMemoryRetriever = JVM_MEMORY_RETRIEVER;
69 // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
70 // be passed to it in the constructor
71 private SnapshotManager snapshotManager;
73 private final DataPersistenceProvider persistenceProvider;
75 private short payloadVersion;
77 private boolean votingMember = true;
79 private RaftActorBehavior currentBehavior;
81 private int numVotingPeers = -1;
83 private Optional<Cluster> cluster;
85 public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
86 ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
87 ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
89 this.context = context;
91 this.termInformation = termInformation;
92 this.commitIndex = commitIndex;
93 this.lastApplied = lastApplied;
94 this.configParams = configParams;
95 this.persistenceProvider = persistenceProvider;
98 for(Map.Entry<String, String> e: peerAddresses.entrySet()) {
99 peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
104 public void setPayloadVersion(short payloadVersion) {
105 this.payloadVersion = payloadVersion;
109 public short getPayloadVersion() {
110 return payloadVersion;
113 public void setConfigParams(ConfigParams configParams) {
114 this.configParams = configParams;
118 public ActorRef actorOf(Props props){
119 return context.actorOf(props);
123 public ActorSelection actorSelection(String path){
124 return context.actorSelection(path);
128 public String getId() {
133 public ActorRef getActor() {
138 public Optional<Cluster> getCluster() {
139 if(cluster == null) {
141 cluster = Optional.of(Cluster.get(getActorSystem()));
142 } catch(Exception e) {
143 // An exception means there's no cluster configured. This will only happen in unit tests.
144 log.debug("{}: Could not obtain Cluster: {}", getId(), e);
145 cluster = Optional.empty();
153 public ElectionTerm getTermInformation() {
154 return termInformation;
158 public long getCommitIndex() {
162 @Override public void setCommitIndex(long commitIndex) {
163 this.commitIndex = commitIndex;
167 public long getLastApplied() {
172 public void setLastApplied(long lastApplied) {
173 this.lastApplied = lastApplied;
177 public void setReplicatedLog(ReplicatedLog replicatedLog) {
178 this.replicatedLog = replicatedLog;
182 public ReplicatedLog getReplicatedLog() {
183 return replicatedLog;
186 @Override public ActorSystem getActorSystem() {
187 return context.system();
190 @Override public Logger getLogger() {
195 public Collection<String> getPeerIds() {
196 return peerInfoMap.keySet();
200 public Collection<PeerInfo> getPeers() {
201 return peerInfoMap.values();
205 public PeerInfo getPeerInfo(String peerId) {
206 return peerInfoMap.get(peerId);
210 public String getPeerAddress(String peerId) {
212 PeerInfo peerInfo = peerInfoMap.get(peerId);
213 if(peerInfo != null) {
214 peerAddress = peerInfo.getAddress();
215 if(peerAddress == null) {
216 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
217 peerInfo.setAddress(peerAddress);
220 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
227 public void updatePeerIds(ServerConfigurationPayload serverConfig){
229 boolean foundSelf = false;
230 Set<String> currentPeers = new HashSet<>(this.getPeerIds());
231 for(ServerInfo server: serverConfig.getServerConfig()) {
232 if(getId().equals(server.getId())) {
234 if(!server.isVoting()) {
235 votingMember = false;
238 VotingState votingState = server.isVoting() ? VotingState.VOTING: VotingState.NON_VOTING;
239 if(!currentPeers.contains(server.getId())) {
240 this.addToPeers(server.getId(), null, votingState);
242 this.getPeerInfo(server.getId()).setVotingState(votingState);
243 currentPeers.remove(server.getId());
248 for(String peerIdToRemove: currentPeers) {
249 this.removePeer(peerIdToRemove);
253 votingMember = false;
256 log.debug("{}: Updated server config: isVoting: {}, peers: {}", id, votingMember, peerInfoMap.values());
258 setDynamicServerConfigurationInUse();
261 @Override public ConfigParams getConfigParams() {
266 public void addToPeers(String peerId, String address, VotingState votingState) {
267 peerInfoMap.put(peerId, new PeerInfo(peerId, address, votingState));
272 public void removePeer(String name) {
273 if(getId().equals(name)) {
274 votingMember = false;
276 peerInfoMap.remove(name);
281 @Override public ActorSelection getPeerActorSelection(String peerId) {
282 String peerAddress = getPeerAddress(peerId);
283 if(peerAddress != null){
284 return actorSelection(peerAddress);
290 public void setPeerAddress(String peerId, String peerAddress) {
291 PeerInfo peerInfo = peerInfoMap.get(peerId);
292 if(peerInfo != null) {
293 log.info("Peer address for peer {} set to {}", peerId, peerAddress);
294 peerInfo.setAddress(peerAddress);
299 public SnapshotManager getSnapshotManager() {
300 if(snapshotManager == null){
301 snapshotManager = new SnapshotManager(this, log);
303 return snapshotManager;
307 public long getTotalMemory() {
308 return totalMemoryRetriever.getAsLong();
312 public void setTotalMemoryRetriever(LongSupplier retriever) {
313 totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
317 public boolean hasFollowers() {
318 return !getPeerIds().isEmpty();
322 public DataPersistenceProvider getPersistenceProvider() {
323 return persistenceProvider;
328 public RaftPolicy getRaftPolicy() {
329 return configParams.getRaftPolicy();
333 public boolean isDynamicServerConfigurationInUse() {
334 return dynamicServerConfiguration;
338 public void setDynamicServerConfigurationInUse() {
339 this.dynamicServerConfiguration = true;
343 public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
344 if (!isDynamicServerConfigurationInUse()) {
347 Collection<PeerInfo> peers = getPeers();
348 List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
349 for(PeerInfo peer: peers) {
350 newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
354 newConfig.add(new ServerInfo(getId(), votingMember));
357 return new ServerConfigurationPayload(newConfig);
361 public boolean isVotingMember() {
366 public boolean anyVotingPeers() {
367 if(numVotingPeers < 0) {
369 for(PeerInfo info: getPeers()) {
370 if(info.isVoting()) {
376 return numVotingPeers > 0;
380 public RaftActorBehavior getCurrentBehavior() {
381 return currentBehavior;
384 void setCurrentBehavior(final RaftActorBehavior behavior) {
385 this.currentBehavior = Preconditions.checkNotNull(behavior);
389 if (currentBehavior != null) {
391 currentBehavior.close();
392 } catch (Exception e) {
393 log.debug("{}: Error closing behavior {}", getId(), currentBehavior.state(), e);