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 com.google.common.annotations.VisibleForTesting;
17 import com.google.common.base.Preconditions;
18 import java.util.ArrayList;
19 import java.util.Collection;
20 import java.util.HashMap;
21 import java.util.HashSet;
22 import java.util.List;
25 import java.util.function.LongSupplier;
26 import org.opendaylight.controller.cluster.DataPersistenceProvider;
27 import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
28 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
29 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
30 import org.slf4j.Logger;
32 public class RaftActorContextImpl implements RaftActorContext {
33 private static final LongSupplier JVM_MEMORY_RETRIEVER = () -> Runtime.getRuntime().totalMemory();
35 private final ActorRef actor;
37 private final ActorContext context;
39 private final String id;
41 private final ElectionTerm termInformation;
43 private long commitIndex;
45 private long lastApplied;
47 private ReplicatedLog replicatedLog;
49 private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
51 private final Logger LOG;
53 private ConfigParams configParams;
55 private boolean dynamicServerConfiguration = false;
58 private LongSupplier totalMemoryRetriever = JVM_MEMORY_RETRIEVER;
60 // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
61 // be passed to it in the constructor
62 private SnapshotManager snapshotManager;
64 private final DataPersistenceProvider persistenceProvider;
66 private short payloadVersion;
68 private boolean votingMember = true;
70 private RaftActorBehavior currentBehavior;
72 public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
73 ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
74 ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
76 this.context = context;
78 this.termInformation = termInformation;
79 this.commitIndex = commitIndex;
80 this.lastApplied = lastApplied;
81 this.configParams = configParams;
82 this.persistenceProvider = persistenceProvider;
85 for(Map.Entry<String, String> e: peerAddresses.entrySet()) {
86 peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
91 public void setPayloadVersion(short payloadVersion) {
92 this.payloadVersion = payloadVersion;
96 public short getPayloadVersion() {
97 return payloadVersion;
100 public void setConfigParams(ConfigParams configParams) {
101 this.configParams = configParams;
105 public ActorRef actorOf(Props props){
106 return context.actorOf(props);
110 public ActorSelection actorSelection(String path){
111 return context.actorSelection(path);
115 public String getId() {
120 public ActorRef getActor() {
125 public ElectionTerm getTermInformation() {
126 return termInformation;
130 public long getCommitIndex() {
134 @Override public void setCommitIndex(long commitIndex) {
135 this.commitIndex = commitIndex;
139 public long getLastApplied() {
144 public void setLastApplied(long lastApplied) {
145 this.lastApplied = lastApplied;
149 public void setReplicatedLog(ReplicatedLog replicatedLog) {
150 this.replicatedLog = replicatedLog;
154 public ReplicatedLog getReplicatedLog() {
155 return replicatedLog;
158 @Override public ActorSystem getActorSystem() {
159 return context.system();
162 @Override public Logger getLogger() {
167 public Collection<String> getPeerIds() {
168 return peerInfoMap.keySet();
172 public Collection<PeerInfo> getPeers() {
173 return peerInfoMap.values();
177 public PeerInfo getPeerInfo(String peerId) {
178 return peerInfoMap.get(peerId);
182 public String getPeerAddress(String peerId) {
183 String peerAddress = null;
184 PeerInfo peerInfo = peerInfoMap.get(peerId);
185 if(peerInfo != null) {
186 peerAddress = peerInfo.getAddress();
187 if(peerAddress == null) {
188 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
189 peerInfo.setAddress(peerAddress);
192 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
199 public void updatePeerIds(ServerConfigurationPayload serverConfig){
201 boolean foundSelf = false;
202 Set<String> currentPeers = new HashSet<>(this.getPeerIds());
203 for(ServerInfo server: serverConfig.getServerConfig()) {
204 if(getId().equals(server.getId())) {
206 if(!server.isVoting()) {
207 votingMember = false;
210 VotingState votingState = server.isVoting() ? VotingState.VOTING: VotingState.NON_VOTING;
211 if(!currentPeers.contains(server.getId())) {
212 this.addToPeers(server.getId(), null, votingState);
214 this.getPeerInfo(server.getId()).setVotingState(votingState);
215 currentPeers.remove(server.getId());
220 for(String peerIdToRemove: currentPeers) {
221 this.removePeer(peerIdToRemove);
225 votingMember = false;
228 setDynamicServerConfigurationInUse();
231 @Override public ConfigParams getConfigParams() {
236 public void addToPeers(String id, String address, VotingState votingState) {
237 peerInfoMap.put(id, new PeerInfo(id, address, votingState));
241 public void removePeer(String name) {
242 if(getId().equals(name)) {
243 votingMember = false;
245 peerInfoMap.remove(name);
249 @Override public ActorSelection getPeerActorSelection(String peerId) {
250 String peerAddress = getPeerAddress(peerId);
251 if(peerAddress != null){
252 return actorSelection(peerAddress);
258 public void setPeerAddress(String peerId, String peerAddress) {
259 PeerInfo peerInfo = peerInfoMap.get(peerId);
260 if(peerInfo != null) {
261 LOG.info("Peer address for peer {} set to {}", peerId, peerAddress);
262 peerInfo.setAddress(peerAddress);
267 public SnapshotManager getSnapshotManager() {
268 if(snapshotManager == null){
269 snapshotManager = new SnapshotManager(this, LOG);
271 return snapshotManager;
275 public long getTotalMemory() {
276 return totalMemoryRetriever.getAsLong();
280 public void setTotalMemoryRetriever(LongSupplier retriever) {
281 totalMemoryRetriever = retriever == null ? JVM_MEMORY_RETRIEVER : retriever;
285 public boolean hasFollowers() {
286 return getPeerIds().size() > 0;
290 public DataPersistenceProvider getPersistenceProvider() {
291 return persistenceProvider;
296 public RaftPolicy getRaftPolicy() {
297 return configParams.getRaftPolicy();
301 public boolean isDynamicServerConfigurationInUse() {
302 return dynamicServerConfiguration;
306 public void setDynamicServerConfigurationInUse() {
307 this.dynamicServerConfiguration = true;
311 public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
312 if (!isDynamicServerConfigurationInUse()) {
315 Collection<PeerInfo> peers = getPeers();
316 List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
317 for(PeerInfo peer: peers) {
318 newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
322 newConfig.add(new ServerInfo(getId(), votingMember));
325 return (new ServerConfigurationPayload(newConfig));
329 public boolean isVotingMember() {
334 public RaftActorBehavior getCurrentBehavior() {
335 return currentBehavior;
338 void setCurrentBehavior(final RaftActorBehavior behavior) {
339 this.currentBehavior = Preconditions.checkNotNull(behavior);
343 if (currentBehavior != null) {
345 currentBehavior.close();
346 } catch (Exception e) {
347 LOG.debug("{}: Error closing behavior {}", getId(), currentBehavior.state());