opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorContextImpl.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.cluster.raft;
  10
  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.Supplier;
  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;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  26 import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
  27 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
  28 import org.slf4j.Logger;
  29
  30 public class RaftActorContextImpl implements RaftActorContext {
  31
  32     private final ActorRef actor;
  33
  34     private final ActorContext context;
  35
  36     private final String id;
  37
  38     private final ElectionTerm termInformation;
  39
  40     private long commitIndex;
  41
  42     private long lastApplied;
  43
  44     private ReplicatedLog replicatedLog;
  45
  46     private final Map<String, PeerInfo> peerInfoMap = new HashMap<>();
  47
  48     private final Logger LOG;
  49
  50     private ConfigParams configParams;
  51
  52     private boolean dynamicServerConfiguration = false;
  53
  54     @VisibleForTesting
  55     private Supplier<Long> totalMemoryRetriever;
  56
  57     // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
  58     // be passed to it in the constructor
  59     private SnapshotManager snapshotManager;
  60
  61     private final DataPersistenceProvider persistenceProvider;
  62
  63     private short payloadVersion;
  64
  65     private boolean votingMember = true;
  66
  67     public RaftActorContextImpl(ActorRef actor, ActorContext context, String id,
  68             ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
  69             ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
  70         this.actor = actor;
  71         this.context = context;
  72         this.id = id;
  73         this.termInformation = termInformation;
  74         this.commitIndex = commitIndex;
  75         this.lastApplied = lastApplied;
  76         this.configParams = configParams;
  77         this.persistenceProvider = persistenceProvider;
  78         this.LOG = logger;
  79
  80         for(Map.Entry<String, String> e: peerAddresses.entrySet()) {
  81             peerInfoMap.put(e.getKey(), new PeerInfo(e.getKey(), e.getValue(), VotingState.VOTING));
  82         }
  83     }
  84
  85     public void setPayloadVersion(short payloadVersion) {
  86         this.payloadVersion = payloadVersion;
  87     }
  88
  89     @Override
  90     public short getPayloadVersion() {
  91         return payloadVersion;
  92     }
  93
  94     public void setConfigParams(ConfigParams configParams) {
  95         this.configParams = configParams;
  96     }
  97
  98     @Override
  99     public ActorRef actorOf(Props props){
 100         return context.actorOf(props);
 101     }
 102
 103     @Override
 104     public ActorSelection actorSelection(String path){
 105         return context.actorSelection(path);
 106     }
 107
 108     @Override
 109     public String getId() {
 110         return id;
 111     }
 112
 113     @Override
 114     public ActorRef getActor() {
 115         return actor;
 116     }
 117
 118     @Override
 119     public ElectionTerm getTermInformation() {
 120         return termInformation;
 121     }
 122
 123     @Override
 124     public long getCommitIndex() {
 125         return commitIndex;
 126     }
 127
 128     @Override public void setCommitIndex(long commitIndex) {
 129         this.commitIndex = commitIndex;
 130     }
 131
 132     @Override
 133     public long getLastApplied() {
 134         return lastApplied;
 135     }
 136
 137     @Override
 138     public void setLastApplied(long lastApplied) {
 139         this.lastApplied = lastApplied;
 140     }
 141
 142     @Override
 143     public void setReplicatedLog(ReplicatedLog replicatedLog) {
 144         this.replicatedLog = replicatedLog;
 145     }
 146
 147     @Override
 148     public ReplicatedLog getReplicatedLog() {
 149         return replicatedLog;
 150     }
 151
 152     @Override public ActorSystem getActorSystem() {
 153         return context.system();
 154     }
 155
 156     @Override public Logger getLogger() {
 157         return this.LOG;
 158     }
 159
 160     @Override
 161     public Collection<String> getPeerIds() {
 162         return peerInfoMap.keySet();
 163     }
 164
 165     @Override
 166     public Collection<PeerInfo> getPeers() {
 167         return peerInfoMap.values();
 168     }
 169
 170     @Override
 171     public PeerInfo getPeerInfo(String peerId) {
 172         return peerInfoMap.get(peerId);
 173     }
 174
 175     @Override
 176     public String getPeerAddress(String peerId) {
 177         String peerAddress = null;
 178         PeerInfo peerInfo = peerInfoMap.get(peerId);
 179         if(peerInfo != null) {
 180             peerAddress = peerInfo.getAddress();
 181             if(peerAddress == null) {
 182                 peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
 183                 peerInfo.setAddress(peerAddress);
 184             }
 185         } else {
 186             peerAddress = configParams.getPeerAddressResolver().resolve(peerId);
 187         }
 188
 189         return peerAddress;
 190     }
 191
 192     @Override
 193     public void updatePeerIds(ServerConfigurationPayload serverConfig){
 194         votingMember = true;
 195         boolean foundSelf = false;
 196         Set<String> currentPeers = new HashSet<>(this.getPeerIds());
 197         for(ServerInfo server: serverConfig.getServerConfig()) {
 198             if(getId().equals(server.getId())) {
 199                 foundSelf = true;
 200                 if(!server.isVoting()) {
 201                     votingMember = false;
 202                 }
 203             } else {
 204                 VotingState votingState = server.isVoting() ? VotingState.VOTING: VotingState.NON_VOTING;
 205                 if(!currentPeers.contains(server.getId())) {
 206                     this.addToPeers(server.getId(), null, votingState);
 207                 } else {
 208                     this.getPeerInfo(server.getId()).setVotingState(votingState);
 209                     currentPeers.remove(server.getId());
 210                 }
 211             }
 212         }
 213
 214         for(String peerIdToRemove: currentPeers) {
 215             this.removePeer(peerIdToRemove);
 216         }
 217
 218         if(!foundSelf) {
 219             votingMember = false;
 220         }
 221
 222         setDynamicServerConfigurationInUse();
 223     }
 224
 225     @Override public ConfigParams getConfigParams() {
 226         return configParams;
 227     }
 228
 229     @Override
 230     public void addToPeers(String id, String address, VotingState votingState) {
 231         peerInfoMap.put(id, new PeerInfo(id, address, votingState));
 232     }
 233
 234     @Override
 235     public void removePeer(String name) {
 236         if(getId().equals(name)) {
 237             votingMember = false;
 238         } else {
 239             peerInfoMap.remove(name);
 240         }
 241     }
 242
 243     @Override public ActorSelection getPeerActorSelection(String peerId) {
 244         String peerAddress = getPeerAddress(peerId);
 245         if(peerAddress != null){
 246             return actorSelection(peerAddress);
 247         }
 248         return null;
 249     }
 250
 251     @Override
 252     public void setPeerAddress(String peerId, String peerAddress) {
 253         PeerInfo peerInfo = peerInfoMap.get(peerId);
 254         if(peerInfo != null) {
 255             LOG.info("Peer address for peer {} set to {}", peerId, peerAddress);
 256             peerInfo.setAddress(peerAddress);
 257         }
 258     }
 259
 260     @Override
 261     public SnapshotManager getSnapshotManager() {
 262         if(snapshotManager == null){
 263             snapshotManager = new SnapshotManager(this, LOG);
 264         }
 265         return snapshotManager;
 266     }
 267
 268     @Override
 269     public long getTotalMemory() {
 270         return totalMemoryRetriever != null ? totalMemoryRetriever.get() : Runtime.getRuntime().totalMemory();
 271     }
 272
 273     @Override
 274     public void setTotalMemoryRetriever(Supplier<Long> retriever) {
 275         totalMemoryRetriever = retriever;
 276     }
 277
 278     @Override
 279     public boolean hasFollowers() {
 280         return getPeerIds().size() > 0;
 281     }
 282
 283     @Override
 284     public DataPersistenceProvider getPersistenceProvider() {
 285         return persistenceProvider;
 286     }
 287
 288
 289     @Override
 290     public RaftPolicy getRaftPolicy() {
 291         return configParams.getRaftPolicy();
 292     }
 293
 294     @Override
 295     public boolean isDynamicServerConfigurationInUse() {
 296         return dynamicServerConfiguration;
 297     }
 298
 299     @Override
 300     public void setDynamicServerConfigurationInUse() {
 301         this.dynamicServerConfiguration = true;
 302     }
 303
 304     @Override
 305     public ServerConfigurationPayload getPeerServerInfo(boolean includeSelf) {
 306         if (!isDynamicServerConfigurationInUse()) {
 307             return null;
 308         }
 309         Collection<PeerInfo> peers = getPeers();
 310         List<ServerInfo> newConfig = new ArrayList<>(peers.size() + 1);
 311         for(PeerInfo peer: peers) {
 312             newConfig.add(new ServerInfo(peer.getId(), peer.isVoting()));
 313         }
 314
 315         if(includeSelf) {
 316             newConfig.add(new ServerInfo(getId(), votingMember));
 317         }
 318
 319         return (new ServerConfigurationPayload(newConfig));
 320     }
 321
 322     @Override
 323     public boolean isVotingMember() {
 324         return votingMember;
 325     }
 326 }