opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractRaftActorBehavior.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.behaviors;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.Cancellable;
  13 import java.util.Random;
  14 import java.util.concurrent.TimeUnit;
  15 import org.opendaylight.controller.cluster.raft.ClientRequestTracker;
  16 import org.opendaylight.controller.cluster.raft.RaftActorContext;
  17 import org.opendaylight.controller.cluster.raft.RaftState;
  18 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
  19 import org.opendaylight.controller.cluster.raft.SerializationUtils;
  20 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
  21 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
  22 import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout;
  23 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
  24 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
  25 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
  26 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
  27 import org.slf4j.Logger;
  28 import scala.concurrent.duration.FiniteDuration;
  29
  30 /**
  31  * Abstract class that represents the behavior of a RaftActor
  32  * <p/>
  33  * All Servers:
  34  * <ul>
  35  * <li> If commitIndex > lastApplied: increment lastApplied, apply
  36  * log[lastApplied] to state machine (§5.3)
  37  * <li> If RPC request or response contains term T > currentTerm:
  38  * set currentTerm = T, convert to follower (§5.1)
  39  */
  40 public abstract class AbstractRaftActorBehavior implements RaftActorBehavior {
  41
  42     protected static final ElectionTimeout ELECTION_TIMEOUT = new ElectionTimeout();
  43
  44     /**
  45      * Information about the RaftActor whose behavior this class represents
  46      */
  47     protected final RaftActorContext context;
  48
  49     /**
  50      *
  51      */
  52     protected final Logger LOG;
  53
  54     /**
  55      *
  56      */
  57     private Cancellable electionCancel = null;
  58
  59     /**
  60      *
  61      */
  62     protected String leaderId = null;
  63
  64     private short leaderPayloadVersion = -1;
  65
  66     private long replicatedToAllIndex = -1;
  67
  68     private final String logName;
  69
  70     private final RaftState state;
  71
  72     protected AbstractRaftActorBehavior(RaftActorContext context, RaftState state) {
  73         this.context = context;
  74         this.state = state;
  75         this.LOG = context.getLogger();
  76
  77         logName = String.format("%s (%s)", context.getId(), state);
  78     }
  79
  80     @Override
  81     public RaftState state() {
  82         return state;
  83     }
  84
  85     public String logName() {
  86         return logName;
  87     }
  88
  89     @Override
  90     public void setReplicatedToAllIndex(long replicatedToAllIndex) {
  91         this.replicatedToAllIndex = replicatedToAllIndex;
  92     }
  93
  94     @Override
  95     public long getReplicatedToAllIndex() {
  96         return replicatedToAllIndex;
  97     }
  98
  99     /**
 100      * Derived classes should not directly handle AppendEntries messages it
 101      * should let the base class handle it first. Once the base class handles
 102      * the AppendEntries message and does the common actions that are applicable
 103      * in all RaftState's it will delegate the handling of the AppendEntries
 104      * message to the derived class to do more state specific handling by calling
 105      * this method
 106      *
 107      * @param sender         The actor that sent this message
 108      * @param appendEntries  The AppendEntries message
 109      * @return
 110      */
 111     protected abstract RaftActorBehavior handleAppendEntries(ActorRef sender,
 112         AppendEntries appendEntries);
 113
 114
 115     /**
 116      * appendEntries first processes the AppendEntries message and then
 117      * delegates handling to a specific behavior
 118      *
 119      * @param sender
 120      * @param appendEntries
 121      * @return
 122      */
 123     protected RaftActorBehavior appendEntries(ActorRef sender,
 124         AppendEntries appendEntries) {
 125
 126         // 1. Reply false if term < currentTerm (§5.1)
 127         if (appendEntries.getTerm() < currentTerm()) {
 128             if(LOG.isDebugEnabled()) {
 129                 LOG.debug("{}: Cannot append entries because sender term {} is less than {}",
 130                         logName(), appendEntries.getTerm(), currentTerm());
 131             }
 132
 133             sender.tell(
 134                 new AppendEntriesReply(context.getId(), currentTerm(), false,
 135                     lastIndex(), lastTerm(), context.getPayloadVersion()), actor()
 136             );
 137             return this;
 138         }
 139
 140
 141         return handleAppendEntries(sender, appendEntries);
 142     }
 143
 144     /**
 145      * Derived classes should not directly handle AppendEntriesReply messages it
 146      * should let the base class handle it first. Once the base class handles
 147      * the AppendEntriesReply message and does the common actions that are
 148      * applicable in all RaftState's it will delegate the handling of the
 149      * AppendEntriesReply message to the derived class to do more state specific
 150      * handling by calling this method
 151      *
 152      * @param sender             The actor that sent this message
 153      * @param appendEntriesReply The AppendEntriesReply message
 154      * @return
 155      */
 156     protected abstract RaftActorBehavior handleAppendEntriesReply(ActorRef sender,
 157         AppendEntriesReply appendEntriesReply);
 158
 159     /**
 160      * requestVote handles the RequestVote message. This logic is common
 161      * for all behaviors
 162      *
 163      * @param sender
 164      * @param requestVote
 165      * @return
 166      */
 167     protected RaftActorBehavior requestVote(ActorRef sender, RequestVote requestVote) {
 168
 169         LOG.debug("{}: In requestVote:  {}", logName(), requestVote);
 170
 171         boolean grantVote = false;
 172
 173         //  Reply false if term < currentTerm (§5.1)
 174         if (requestVote.getTerm() < currentTerm()) {
 175             grantVote = false;
 176
 177             // If votedFor is null or candidateId, and candidate’s log is at
 178             // least as up-to-date as receiver’s log, grant vote (§5.2, §5.4)
 179         } else if (votedFor() == null || votedFor()
 180             .equals(requestVote.getCandidateId())) {
 181
 182             boolean candidateLatest = false;
 183
 184             // From §5.4.1
 185             // Raft determines which of two logs is more up-to-date
 186             // by comparing the index and term of the last entries in the
 187             // logs. If the logs have last entries with different terms, then
 188             // the log with the later term is more up-to-date. If the logs
 189             // end with the same term, then whichever log is longer is
 190             // more up-to-date.
 191             if (requestVote.getLastLogTerm() > lastTerm()) {
 192                 candidateLatest = true;
 193             } else if ((requestVote.getLastLogTerm() == lastTerm())
 194                 && requestVote.getLastLogIndex() >= lastIndex()) {
 195                 candidateLatest = true;
 196             }
 197
 198             if (candidateLatest) {
 199                 grantVote = true;
 200                 context.getTermInformation().updateAndPersist(requestVote.getTerm(),
 201                     requestVote.getCandidateId());
 202             }
 203         }
 204
 205         RequestVoteReply reply = new RequestVoteReply(currentTerm(), grantVote);
 206
 207         LOG.debug("{}: requestVote returning: {}", logName(), reply);
 208
 209         sender.tell(reply, actor());
 210
 211         return this;
 212     }
 213
 214     /**
 215      * Derived classes should not directly handle RequestVoteReply messages it
 216      * should let the base class handle it first. Once the base class handles
 217      * the RequestVoteReply message and does the common actions that are
 218      * applicable in all RaftState's it will delegate the handling of the
 219      * RequestVoteReply message to the derived class to do more state specific
 220      * handling by calling this method
 221      *
 222      * @param sender           The actor that sent this message
 223      * @param requestVoteReply The RequestVoteReply message
 224      * @return
 225      */
 226     protected abstract RaftActorBehavior handleRequestVoteReply(ActorRef sender,
 227         RequestVoteReply requestVoteReply);
 228
 229     /**
 230      * Creates a random election duration
 231      *
 232      * @return
 233      */
 234     protected FiniteDuration electionDuration() {
 235         long variance = new Random().nextInt(context.getConfigParams().getElectionTimeVariance());
 236         return context.getConfigParams().getElectionTimeOutInterval().$plus(
 237                 new FiniteDuration(variance, TimeUnit.MILLISECONDS));
 238     }
 239
 240     /**
 241      * stop the scheduled election
 242      */
 243     protected void stopElection() {
 244         if (electionCancel != null && !electionCancel.isCancelled()) {
 245             electionCancel.cancel();
 246         }
 247     }
 248
 249     /**
 250      * schedule a new election
 251      *
 252      * @param interval
 253      */
 254     protected void scheduleElection(FiniteDuration interval) {
 255         stopElection();
 256
 257         // Schedule an election. When the scheduler triggers an ElectionTimeout
 258         // message is sent to itself
 259         electionCancel =
 260             context.getActorSystem().scheduler().scheduleOnce(interval,
 261                 context.getActor(), ELECTION_TIMEOUT,
 262                 context.getActorSystem().dispatcher(), context.getActor());
 263     }
 264
 265     /**
 266      * Get the current term
 267      * @return
 268      */
 269     protected long currentTerm() {
 270         return context.getTermInformation().getCurrentTerm();
 271     }
 272
 273     /**
 274      * Get the candidate for whom we voted in the current term
 275      * @return
 276      */
 277     protected String votedFor() {
 278         return context.getTermInformation().getVotedFor();
 279     }
 280
 281     /**
 282      * Get the actor associated with this behavior
 283      * @return
 284      */
 285     protected ActorRef actor() {
 286         return context.getActor();
 287     }
 288
 289     /**
 290      * Get the term from the last entry in the log
 291      *
 292      * @return
 293      */
 294     protected long lastTerm() {
 295         return context.getReplicatedLog().lastTerm();
 296     }
 297
 298     /**
 299      * Get the index from the last entry in the log
 300      *
 301      * @return
 302      */
 303     protected long lastIndex() {
 304         return context.getReplicatedLog().lastIndex();
 305     }
 306
 307     /**
 308      * Find the client request tracker for a specific logIndex
 309      *
 310      * @param logIndex
 311      * @return
 312      */
 313     protected ClientRequestTracker findClientRequestTracker(long logIndex) {
 314         return null;
 315     }
 316
 317     /**
 318      * Find the client request tracker for a specific logIndex
 319      *
 320      * @param logIndex
 321      * @return
 322      */
 323     protected ClientRequestTracker removeClientRequestTracker(long logIndex) {
 324         return null;
 325     }
 326
 327
 328     /**
 329      * Find the log index from the previous to last entry in the log
 330      *
 331      * @return
 332      */
 333     protected long prevLogIndex(long index){
 334         ReplicatedLogEntry prevEntry =
 335             context.getReplicatedLog().get(index - 1);
 336         if (prevEntry != null) {
 337             return prevEntry.getIndex();
 338         }
 339         return -1;
 340     }
 341
 342     /**
 343      * Find the log term from the previous to last entry in the log
 344      * @return
 345      */
 346     protected long prevLogTerm(long index){
 347         ReplicatedLogEntry prevEntry =
 348             context.getReplicatedLog().get(index - 1);
 349         if (prevEntry != null) {
 350             return prevEntry.getTerm();
 351         }
 352         return -1;
 353     }
 354
 355     /**
 356      * Apply the provided index to the state machine
 357      *
 358      * @param index a log index that is known to be committed
 359      */
 360     protected void applyLogToStateMachine(final long index) {
 361         long newLastApplied = context.getLastApplied();
 362         // Now maybe we apply to the state machine
 363         for (long i = context.getLastApplied() + 1;
 364              i < index + 1; i++) {
 365             ActorRef clientActor = null;
 366             String identifier = null;
 367             ClientRequestTracker tracker = removeClientRequestTracker(i);
 368
 369             if (tracker != null) {
 370                 clientActor = tracker.getClientActor();
 371                 identifier = tracker.getIdentifier();
 372             }
 373             ReplicatedLogEntry replicatedLogEntry =
 374                 context.getReplicatedLog().get(i);
 375
 376             if (replicatedLogEntry != null) {
 377                 // Send a local message to the local RaftActor (it's derived class to be
 378                 // specific to apply the log to it's index)
 379                 actor().tell(new ApplyState(clientActor, identifier,
 380                     replicatedLogEntry), actor());
 381                 newLastApplied = i;
 382             } else {
 383                 //if one index is not present in the log, no point in looping
 384                 // around as the rest wont be present either
 385                 LOG.warn(
 386                         "{}: Missing index {} from log. Cannot apply state. Ignoring {} to {}",
 387                         logName(), i, i, index);
 388                 break;
 389             }
 390         }
 391         if(LOG.isDebugEnabled()) {
 392             LOG.debug("{}: Setting last applied to {}", logName(), newLastApplied);
 393         }
 394         context.setLastApplied(newLastApplied);
 395
 396         // send a message to persist a ApplyLogEntries marker message into akka's persistent journal
 397         // will be used during recovery
 398         //in case if the above code throws an error and this message is not sent, it would be fine
 399         // as the  append entries received later would initiate add this message to the journal
 400         actor().tell(new ApplyJournalEntries(context.getLastApplied()), actor());
 401     }
 402
 403     protected Object fromSerializableMessage(Object serializable){
 404         return SerializationUtils.fromSerializable(serializable);
 405     }
 406
 407     @Override
 408     public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
 409         if (message instanceof AppendEntries) {
 410             return appendEntries(sender, (AppendEntries) message);
 411         } else if (message instanceof AppendEntriesReply) {
 412             return handleAppendEntriesReply(sender, (AppendEntriesReply) message);
 413         } else if (message instanceof RequestVote) {
 414             return requestVote(sender, (RequestVote) message);
 415         } else if (message instanceof RequestVoteReply) {
 416             return handleRequestVoteReply(sender, (RequestVoteReply) message);
 417         }
 418         return this;
 419     }
 420
 421     @Override public String getLeaderId() {
 422         return leaderId;
 423     }
 424
 425     @Override
 426     public short getLeaderPayloadVersion() {
 427         return leaderPayloadVersion;
 428     }
 429
 430     public void setLeaderPayloadVersion(short leaderPayloadVersion) {
 431         this.leaderPayloadVersion = leaderPayloadVersion;
 432     }
 433
 434     protected RaftActorBehavior switchBehavior(RaftActorBehavior behavior) {
 435         LOG.info("{} :- Switching from behavior {} to {}", logName(), this.state(), behavior.state());
 436         try {
 437             close();
 438         } catch (Exception e) {
 439             LOG.error("{}: Failed to close behavior : {}", logName(), this.state(), e);
 440         }
 441
 442         return behavior;
 443     }
 444
 445     protected int getMajorityVoteCount(int numPeers) {
 446         // Votes are required from a majority of the peers including self.
 447         // The numMajority field therefore stores a calculated value
 448         // of the number of votes required for this candidate to win an
 449         // election based on it's known peers.
 450         // If a peer was added during normal operation and raft replicas
 451         // came to know about them then the new peer would also need to be
 452         // taken into consideration when calculating this value.
 453         // Here are some examples for what the numMajority would be for n
 454         // peers
 455         // 0 peers = 1 numMajority -: (0 + 1) / 2 + 1 = 1
 456         // 2 peers = 2 numMajority -: (2 + 1) / 2 + 1 = 2
 457         // 4 peers = 3 numMajority -: (4 + 1) / 2 + 1 = 3
 458
 459         int numMajority = 0;
 460         if (numPeers > 0) {
 461             int self = 1;
 462             numMajority = (numPeers + self) / 2 + 1;
 463         }
 464         return numMajority;
 465
 466     }
 467
 468
 469     /**
 470      * Performs a snapshot with no capture on the replicated log.
 471      * It clears the log from the supplied index or last-applied-1 which ever is minimum.
 472      *
 473      * @param snapshotCapturedIndex
 474      */
 475     protected void performSnapshotWithoutCapture(final long snapshotCapturedIndex) {
 476         long actualIndex = context.getSnapshotManager().trimLog(snapshotCapturedIndex, this);
 477
 478         if(actualIndex != -1){
 479             setReplicatedToAllIndex(actualIndex);
 480         }
 481     }
 482
 483     protected String getId(){
 484         return context.getId();
 485     }
 486
 487 }