Skip to content

Latest commit

 

History

History
684 lines (582 loc) · 49.2 KB

File metadata and controls

684 lines (582 loc) · 49.2 KB

Part 2B: Log Replication

实现领导者和跟随者代码来追加新的日志条目。这将涉及到实现Start(),完成AppendEntries RPC结构,发送它们,充实(fleshing out)AppendEntry RPC处理程序(handler),以及推进(advancing)领导者的commitIndex

1. Start()实现

使用Raft的服务调用Start()想要就追加到Raft的log中下一条命令开始达成一致(start agreement)。如果该服务器不是leader,它返回false,否则开始达成一致并立即返回。不保证这条命令将被提交到(be committed to)Raft的log,由于leader可能故障或者输掉选举。即使Raft实例已经被杀掉,该函数也应该优雅地返回。
由于Start()的功能是将接收到的客户端命令追加到自己的本地log,然后给其他所有peers并行发送AppendEntries RPC来迫使其他peer也同意领导者日志的内容,在收到大多数peers的已追加该命令到log的肯定回复后,若该entry的任期等于leader的当前任期,则leader将该entry标记为已提交的(committed),提升(adavance)commitIndex到该entry所在的index,并发送ApplyMsg消息到ApplyCh,相当于应用该entry的命令到状态机。
可见,Start()的结构与startElection()的结构类似,都是并行发送RPC,和与发起选举相同的是,Start()要根据RPC的回复来统计已追加该entry到本地log的peer的数目,在达到大多数后,提升commitIndex,应用该entry的命令到状态机。同时,和发起选举是单次行为不同,Start()可能面临客户端的并发请求,所以Start()必须进行更精细的处理来应对这种并发的情况。

1.1 并发处理

回顾lab 2A中startElection()的结构,可以看到在为每个peer封装RPC请求参数时,直接调用len(rf.log)来获取日志长度。但这种做法在Start()是危险的,考虑这样一种场景:比如客户端连续调用Star()三次,提交了三条命令,它们在log中编号分别为indexN,indexN+1,indexN+2。如果首先执行给其他peers发送AppendEntries RPC,并等待并行发送RPC结束的goroutine是indexN+2的,而后才执行indexN的,那么对于indexN的goroutine来说,直接调用len(rf.log)得到的日志长度将不是N而是错误的N+2,这就是并发情况下需要处理的细节问题。
对于并发,Start()要处理的细节的细节有两个:

  1. 主要就是本次提交的命令所在entry的index的值。要保证在填充要复制的entries时的结尾索引必须是本次的index值,而不是其他并发提交的。同时在确认已将该entry复制到大多数peers后,在将commitIndex提升到index时,也必须是本次提交的index
  2. 在提升commitIndex之前,一定要保证要提升的值index大于当前的commitIndex,并且该index的任期为当前任期,否则会造成混乱。比如index=3的AppendEntries RPC先到达且最终通过了一致性检查,所以提升commitIndex=3;随后index=1的AppendEntries RPC到达,自然一致性检查一次就直接通过,此时index(1)<commitIndex(3),不应该提升commitIndex为1,这就违背了状态机安全属性。

1.2 nextIndex的理解

正如Raft学生指南指出的:

nextIndex是关于领导者和给定跟随者共享的前缀(what prefix)的一种猜测(guess)。它通常相当乐观(optimistic)(我们分享所有内容),并且仅在负面回复(negative)时才向后移动(moved backwards)。例如,当刚刚选出一个领导者时(when a leader has just been elected),nextIndex被设置为日志末尾的索引的索引(index index at the end of the log)。在某种程度上(in a way),nextIndex用于性能——你只需要将这些内容发送给这个对等点。

Start()broadcastHeartbeat()都要发送AppendEntries RPC,而AppendEntriesArgs参数的prevLogIndex等于leader为该peer保存的nextIndex的值减1,但对于两者来说,nextIndex值的来源确不一样。
对于broadcastHeartbeat()而言,由于心跳是周期性的常规行为,所以peer:i的nextIndex应该取自leader的rf.nextIndex[i]。而对于Start()来说,由于将新命令追加到了log,所以对于其他所有peers来说,其对应的nextIndex都应该更新为当前的log的尾后位置,即index + 1

1.3 达到多数者条件时必须仍处于指定状态

对于startElection(),只有为Candidate状态且获得大多数投票,才能变为leader。
对于Start(),只有为Leader状态且已将entry复制到了大多数peers,才能提升commitIndex
因为是为每个peer创建一个goroutine发送RPC并进行RPC回复的处理,根据回复实时统计得到肯定回复的数量。可能出现在给其中一个peer发送RPC时,因为该peer的任期比candiata或leader更高,它拒绝了candidate或leder的RPC请求,candidate或leader被拒绝后,切换到Follower状态。而与此同时,或者在此之后,该过时的candidaet或leader(已经切换到follwer),收到了其他peers的大多数的肯定回复,如果这时不对candidate或leader的状态加以判断,那么该过时的candidate或leader因为满足了多数者条件,采取进一步的动作(对于过时的candidate是变为leader,对于过时的leader来说是提升commitIndex),这显然是错误的!所以必须在达到多数者条件时检查下是否仍处于指定状态,如果是,才能进一步执行相关动作。

1.4 当entry被提交后发送一次心跳以通知其他peers更新commitIndex

在实现Part 2B的过程中,我发现在某些测试点,明明所有的peers的log都已经和leader的完全一致,但是就是无法通过测试点,查看原因便发现是因为尽管leader在收到大多数AppendEntries RPC的肯定答复后,将已提交的entries应用到了状态机,但有的peer在收到并肯定leader发来的AppendEntries RPC时,由于此时该RPC在发送时还没有得到大多数peers的肯定,所以其leaderCommit参数位于该entry之前,而后当该entry被leader标记为已提交并应该到自己的状态机后,由于没有发送心跳也没有再次发送AppendEntries RPC,所以该peer始终不知道这条entry已经被提交了,尽管这条entry已经被复制到了该peer的log中,它无法应用该entry到自己的状态机,从而无法通过测试点。
由此可见,必须要得有一种沟通机制来通知其他peers更新commitIndex,我的做法是在检测到所有的peers已经同意了某条entry后,就发送一次心跳,以通知所有的peers应用该entry到自己的状态机在检测到该entry被复制到大多数的peers后(保证为该entry为当前任期),即可以将该entry标记为已提交的时,也紧接着发送一次心跳,以通知其他所有的peers更新commitIndex,以应用该entry到自己的状态机。而对于还没有复制该entry的peer而言,也无需担心这次心跳会出现问题,因为心跳也会根据nextIndex的值携带entries,所以对该peer而言,此时的心跳也携带了该entry,如果心跳先于本次Start()调用的AppendEntries RPC到达,则也会进行一致性检查,通过后也会先发生日志复制,然后更新commitIndex,这时应用的新条目已经是leader的这条entry了。
Start()的代码实现如下:

//
// the service using Raft (e.g. a k/v server) wants to start
// agreement on the next command to be appended to Raft's Log. if this
// server isn't the leader, returns false. otherwise start the
// agreement and return immediately. there is no guarantee that this
// command will ever be committed to the Raft Log, since the leader
// may fail or lose an election. even if the Raft instance has been killed,
// this function should return gracefully.
//
// the first return value is the index that the command will appear at
// if it's ever committed. the second return value is the current
// term. the third return value is true if this server believes it is
// the leader.
//
func (rf *Raft) Start(command interface{}) (int, int, bool) {
    index := -1
    term := -1
    isLeader := true

    // Your code here (2B).
    if term, isLeader = rf.GetState(); isLeader {

        // 1. leader将客户端command作为新的entry追加到自己的本地log
        rf.mu.Lock()
        logEntry := LogEntry{Command:command, Term:rf.CurrentTerm}
        rf.Log = append(rf.Log, logEntry)
        index = len(rf.Log) - 1
        DPrintf("[Start]: Id %d Term %d State %s\t||\treplicate the command to Log index %d\n",
            rf.me, rf.CurrentTerm, state2name(rf.state), index)
        nReplica := 1
        // 发送AppendEntries RPC时也更新下最近发送时间
        rf.latestIssueTime = time.Now().UnixNano()

        // 接收到客户端命令,并写入log,保存下持久状态
        rf.persist()

        rf.mu.Unlock()

        // 2. 给其他peers并行发送AppendEntries RPC以复制该entry
        go func(nReplica *int, index int, commitIndex int, term int) {
            var wg sync.WaitGroup
            majority := len(rf.peers)/2 + 1
            agreement := false
            isCommitted := false

            rf.mu.Lock()
            DPrintf("[Start]: Id %d Term %d State %s\t||\tcreate an goroutine for index %d" +
                " to issue parallel and wait\n", rf.me, rf.CurrentTerm, state2name(rf.state), index)
            rf.mu.Unlock()

            for i, _ := range rf.peers {

                // 避免进入了新任期,还发送过时的entries,因为leader原则上只能提交当前任期的entry
                rf.mu.Lock()
                if rf.CurrentTerm != term {
                    rf.mu.Unlock()
                    return
                }
                rf.mu.Unlock()

                if i == rf.me {
                    continue
                }
                wg.Add(1)

                // 给peer:i发送AppendEntries RPC
                go func(i int, rf *Raft, nReplica *int) {

                    defer wg.Done()
                    nextIndex := index + 1

                    // 在AppendEntries RPC一致性检查失败后,递减nextIndex,重试
                retry:

                    // 因为涉及到retry操作,避免过时的leader的retry操作继续下去
                    _, isLeader = rf.GetState()
                    if isLeader == false {
                        return
                    }

                    // 避免进入了新任期,还发送过时的entries,因为leader原则上只能提交当前任期的entry
                    rf.mu.Lock()
                    if rf.CurrentTerm != term {
                        rf.mu.Unlock()
                        return
                    }
                    rf.mu.Unlock()

                    rf.mu.Lock()
                    // 封装AppendEntriesArgs参数
                    prevLogIndex := nextIndex - 1
                    if prevLogIndex < 0 {
                        DPrintf("[Start]: Id %d Term %d State %s\t||\tinvalid prevLogIndex %d for index %d" +
                            " peer %d\n", rf.me, rf.CurrentTerm, state2name(rf.state), prevLogIndex, index, i)
                    }
                    prevLogTerm := rf.Log[prevLogIndex].Term
                    entries := make([]LogEntry, 0)
                    if nextIndex <= index {
                        entries = rf.Log[nextIndex:index+1] // [nextIndex, index+1)
                    }
                    args := AppendEntriesArgs{Term:term, LeaderId:rf.me,
                        PrevLogIndex:prevLogIndex, PrevLogTerm:prevLogTerm,
                        Entries:entries, LeaderCommit:commitIndex}
                    DPrintf("[Start]: Id %d Term %d State %s\t||\tissue AppendEntries RPC for index %d" +
                        " to peer %d with nextIndex %d\n", rf.me, rf.CurrentTerm, state2name(rf.state), index, i, prevLogIndex+1)
                    rf.mu.Unlock()
                    var reply AppendEntriesReply

                    ok := rf.sendAppendEntries(i, &args, &reply)

                    // 发送AppendEntries RPC失败,表明无法和peer建立通信,直接放弃
                    if ok == false {
                        rf.mu.Lock()
                        DPrintf("[Start]: Id %d Term %d State %s\t||\tissue AppendEntries RPC for index %d" +
                            " to peer %d failed\n", rf.me, rf.CurrentTerm, state2name(rf.state), index, i)
                        rf.mu.Unlock()
                        // Todo: 发送AppendEntries失败,应该直接返回还是重试?直接返回!
                        return
                    }

                    // 图2通常不讨论当你收到旧的RPC回复(replies)时应该做什么。根据经验,
                    // 我们发现到目前为止最简单的方法是首先记录该回复中的任期(the term
                    // in the reply)(它可能高于你的当前任期),然后将当前任期(current term)
                    // 和你在原始RPC中发送的任期(the term you sent in your original RPC)
                    // 比较。如果两者不同,请删除(drop)回复并返回。只有(only)当两个任期相同,
                    // 你才应该继续处理该回复。通过一些巧妙的协议推理(protocol reasoning),
                    // 你可以在这里进一步的优化,但是这个方法似乎运行良好(work well)。并且
                    // 不(not)这样做将导致一个充满鲜血、汗水、眼泪和失望的漫长而曲折的(winding)道路。
                    rf.mu.Lock()
                    if rf.CurrentTerm != args.Term {
                        rf.mu.Unlock()
                        return
                    }
                    rf.mu.Unlock()

                    // AppendEntries被拒绝,原因可能是leader任期过时,或者一致性检查未通过
                    if reply.Success == false {
                        rf.mu.Lock()
                        DPrintf("[Start]: Id %d Term %d State %s\t||\tAppendEntries RPC for index %d is rejected" +
                            " by peer %d\n", rf.me, rf.CurrentTerm, state2name(rf.state), index, i)
                        // 如果是leader任期过时,需要切换到follower并立即退出。这里应该使用
                        // args.Term和reply.Term比较,因为一致性检查就是比较的这两者。而直接
                        // 使用rf.currentTerm和reply.Term比较的话,任期过时的可能性就小了。
                        // 因为rf.currentTerm在同步发送RPC的过程中可能已经发生改变!
                        if args.Term < reply.Term {
                            rf.CurrentTerm = reply.Term
                            rf.VoteFor = -1
                            rf.switchTo(Follower)
                            //rf.resetElectionTimer()

                            DPrintf("[Start]: Id %d Term %d State %s\t||\tAppendEntries PRC for index %d is rejected by" +
                                " peer %d due to newer peer's term %d\n", rf.me, rf.CurrentTerm, state2name(rf.state),
                                index, i, reply.Term)
                            //// 任期过时,说明要追加的entry即index索引的entry是过时的,应该从log中删除
                            //if index < len(rf.Log)-1 {		// 如果index不是最后一个entry的索引
                            //	rf.Log = append(rf.Log[:index], rf.Log[index+1:]...)
                            //} else {	// 如果index是最后一个entry的索引
                            //	rf.Log = rf.Log[:index]
                            //}
                            //*nReplica -= 1

                            // 任期过时,切换为follower,更新下持久状态
                            rf.persist()

                            rf.mu.Unlock()
                            return

                        } else {	// 如果是一致性检查失败,则递减nextIndex,重试

                            // 这里递减nextIndex使用了论文中提到的优化策略:
                            // If desired, the protocol can be optimized to reduce the number of rejected AppendEntries
                            // RPCs. For example,  when rejecting an AppendEntries request, the follower can include the
                            // term of the conflicting entry and the first index it stores for that term. With this
                            // information, the leader can decrement nextIndx to bypass all of the conflicting entries
                            // in that term; one AppendEntries RPC will be required for each term with conflicting entries,
                            // rather than one RPC per entry.
                            // 只存在reply.ConflictFirstIndex < nextIndex,由于一致性检查是从nextIndex-1(prevLogIndex)处
                            // 查看的,所以不会出现reply.ConflictFirstIndex >= nextIndex。

                            nextIndex = rf.getNextIndex(reply, nextIndex)

                            DPrintf("[Start]: Id %d Term %d State %s\t||\tAppendEntries RPC for index %d is rejected by" +
                                " peer %d due to the consistency check failed\n", rf.me, rf.CurrentTerm,
                                state2name(rf.state), index, i)
                            DPrintf("[Start]: Id %d Term %d State %s\t||\treply's conflictFirstIndex %d and conflictTerm %d\n",
                                                rf.me, rf.CurrentTerm, state2name(rf.state), reply.ConflictFirstIndex, reply.ConflictTerm)
                            DPrintf("[Start]; Id %d Term %d State %s\t||\tretry AppendEntries RPC with" +
                                " nextIndex %d, so prevLogIndex %d and prevLogTerm %d\n", rf.me, rf.CurrentTerm,
                                state2name(rf.state), nextIndex, nextIndex-1, rf.Log[nextIndex-1].Term)
                            rf.mu.Unlock()
                            goto retry

                        }
                    } else {	// AppendEntries RPC发送成功

                        rf.mu.Lock()
                        DPrintf("[Start]: Id %d Term %d State %s\t||\tsend AppendEntries PRC for index %d to peer %d success\n",
                            rf.me, rf.CurrentTerm, state2name(rf.state), index, i)

                        // 如果当前index更大,则更新该peer对应的nextIndex和matchIndex
                        if rf.nextIndex[i] < index+1 {
                            rf.nextIndex[i] = index + 1
                            rf.matchIndex[i] = index
                        }
                        *nReplica += 1
                        DPrintf("[Start]: Id %d Term %d State %s\t||\tnReplica %d for index %d\n",
                            rf.me, rf.CurrentTerm, state2name(rf.state), *nReplica, index)

                        // 如果已经将该entry复制到了大多数peers,接着检查index编号的这条entry的任期
                        // 是否为当前任期,如果是则可以提交该条目
                        if agreement == false && rf.state == Leader && *nReplica >= majority {
                            agreement = true
                            DPrintf("[Start]: Id %d Term %d State %s\t||\thas replicated the entry with index %d" +
                                " to the majority with nReplica %d\n", rf.me, rf.CurrentTerm, state2name(rf.state),
                                index, *nReplica)

                            // 如果index大于commitIndex,而且index编号的entry的任期等于当前任期,提交该entry
                            if rf.commitIndex < index && rf.Log[index].Term == rf.CurrentTerm {
                                DPrintf("[Start]: Id %d Term %d State %s\t||\tadvance the commitIndex to %d\n",
                                    rf.me, rf.CurrentTerm, state2name(rf.state), index)
                                isCommitted = true

                                // 提升commitIndex
                                rf.commitIndex = index

                                // 当被提交的entries被复制到多数peers后,可以发送一次心跳通知其他peers更新commitIndex
                                go rf.broadcastHeartbeat()

                                // 更新了commitIndex可以给applyCond条件变量发信号,
                                // 以应用新提交的entries到状态机
                                DPrintf("[Start]: Id %d Term %d State %s\t||\tapply updated commitIndex %d to applyCh\n",
                                    rf.me, rf.CurrentTerm, state2name(rf.state), rf.commitIndex)
                                rf.applyCond.Broadcast()

                                //// 已完成了多数者日志的复制,保存下持久状态
                                //rf.persist()
                            }

                        }
                        //// 当被提交的entries被复制到所有peers后,可以发送一次心跳通知其他peers更新commitIndex
                        //if *nReplica == len(rf.peers) && isCommitted {
                        //	// 同时发送给其他peers发送一次心跳,使它们更新commitIndex
                        //	go rf.broadcastHeartbeat()
                        //}

                        rf.mu.Unlock()
                    }

                }(i, rf, nReplica)
            }

            // 等待所有发送AppendEntries RPC的goroutine退出
            wg.Wait()

        }(&nReplica, index, rf.commitIndex, rf.CurrentTerm)

    }
    return index, term, isLeader
}

2. AppendEntries RPC请求处理

2.1 一致性检查通过后只有存在冲突才进行日志替换

AppendEntries RPC请求处理的一个重要内容就是进行一致性检查,如果一致性检查失败,就会将AppenEntriesReply中的参数success置为false,以便leader递减nextIndex并重试。最终一致性检查通过,如果存在冲突的条目,则会删除冲突的条目并替换为AppendEntriesArgs中的entries
正如Raft学生指南指出的:

许多人的另一个问题(通常在解决了上面那个问题后马上遇到)是当收到心跳后,它们会在prevLogIndex之后(following prevLogIndex)截断(truncate)跟随者的日志,然后追加AppendEntries参数中包含的任何条目。这也是不正确的。我们可以再次转向图2:
If an existing entry conflicts with a new one(same index but different terms), delete the existing entry and all that follow it.
这里的If至关重要。如果跟随者拥有领导者发送的所有条目,则跟随者一定不能(MUST NOT)截断其日志。领导者发送的条目之后的任何内容(any elements following the entries sent by the leader)必须(MUST)保留。
这是因为我们可能从领导者那里收到过时的(outdated)AppendEntries RPC,截断日志意味着“收回(taking back)”这些我们可能已经告诉领导者它们在我们的日志中的条目。

所以判断folower日志是否和leader的log存在冲突的方法就是检查AppendEntriesArgsentries参数中包含的条目是否都已经存在于follower的log中,如果都存在,则不存在冲突。
可以从并发的调用Start()的场景下理解这个问题,比如初始时leader的log日志为空(我们的实现里空的log为含有一条index为0的包含了一条空命令的任期为0的entry的log),客户端连续调用Start()6次,追加了6条命令到leader的日志中,它们的index分别为1-6。首先,复制index6的goroutine先执行,并已经将index为1-6的条目复制到某个peer的log中。而后,复制index3的goroutine向该peer发送AppendEntries RPC,自然一次性就通过了一致性检查,此时的场景如下图(a)所示:
冲突检查
此时AppendEntriesArgs中的entires的所有条目在该peer的log中都存在,所以此时不存在冲突,该peer不应该截断其日志,并复制entries中的条目,错误的做法如图(b)所示。正确的做法是什么也无需做,如图(c)所示。

2.2 减少被拒绝的AppendEntries RPC的次数

正如extended Raft指出的:

如果需要的话,算法可以通过减少被拒绝的追加条目(AppendEntries) RPC的次数来优化。例如,当追加条目(AppendEntries) RPC的请求被拒绝时,跟随者可以包含冲突条目的任期号和它自己存储的那个任期的第一个索引值。借助这个信息,领导者可以减少nextIndex来越过该任期内的所有冲突的日志条目;这样就变为每个任期需要一条追加条目(AppendEntries) RPC而不是每个条目一条。

这么做之所以有效的原因在于AppendEntriesArgsentrires携带的日志条目可以在冲突点之前,但不能在冲突点之后。也就是说,如果任期2的某个条目是冲突点,但该条目不是任期2的第一个条目,按照论文中给出的优化处理,entries中将包含从任期2的第一个条目到该冲突点之前的所有条目,而这些条目本身是和leader的log中对应位置的条目是匹配的,但是截断这些条目并替换为leader中一样的条目,仍然是正确的。
而对于leader的AppendEntries RPC回复处理来说,得到了AppendEntriesReplyconflictTermconflictFirstIndex参数,需要进行进一步的处理。
首先,conflictFirstIndex一定小于nextIndex,因为一致性检查是从prevLogIndex(nextIndex-1)处查看的,所以conflictTerm至多是prevLogIndex对应entry的任期,而conflictFirstIndex作为conflictTerm的第一次出现的索引,至多等于prevLogIndex,所以必然小于nextIndex
接着判断leader的log中conflictFirstIndex处entry的任期是否等于conflictTerm,如果等于,说明在该索引处,leader与该peer的日志已经是匹配的,可以直接将nextIndex置为conflictFirstIndex+1,否则leader应该也采取上面的优化手段,递减conflictFirstIndex,直到其为该任期的第一个条目的索引,接着也是将nextIndex置为conflictIndex+1,再次发送AppendEntries RPC进行重试。并且前一种情况下,接下来的这次重置将通过一致性检查,而第二种情况则不一定,而且还有可能出现“活锁”。
考虑下面这种情况,leader的log中conflictFirstIndex处entry的任期和conflictTerm不等,而且该entry也是leader的log中该任期的第一次出现的entry。如果采取上面的方式,则进行重试时nextIndex就是本次AppendEntriesReply中的conflictFirstIndex+1,即接下来的AppendEntriesArgs中的prevLogIndex参数等于本次回复中的conflictFirstIndex,所以重试肯定无法通过一致性检查,而这次重试的回复中包含的仍是相同的conflictFirstIndex,这个过程就会一直重复下去,形成“活锁”。应该对这种情况进行判断,可以看出当经过上述处理的conflictFirstIndex的值仍和reply.ConflictFirstIndex相等,而且leader的log[conflictFirstIndex].Term又不等于reply.ConflictTerm时,就对应这种情况。这时只需要简单的将nextIndex减1,和没有优化前的处理一样,保证nextIndex可以前进即可。一种可能的情况如下图所示:
活锁

2.3 一致性检查通过一定要设置为Follower状态

如果收到AppendEntries RPC且一致性检查通过,必须将该peer的状态设置为Follower,因为收到并通过了AppendEntries RPC(包括心跳),说明承认了leader的合法地位,此时该peer必须是follwer,而不能是candidate或leader。
AppendEntries RPC的请求处理实现如下:

func (rf *Raft) AppendEntries(args *AppendEntriesArgs, reply *AppendEntriesReply) {
    rf.mu.Lock()
    defer rf.mu.Unlock()

    // Reply false if term < currentTerm, otherwise continue a "consistency check"
    if rf.currentTerm <= args.Term {

        // If RPC request or response contains term T > currentTerm:
        // set currentTerm = T, convert to follower
        if rf.currentTerm < args.Term {

            DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\targs's term %d is newer\n",
                rf.me, rf.currentTerm, state2name(rf.state), args.Term)

            rf.currentTerm = args.Term

            // 收到来自leader的args.Term大于peer自身的currentTerm的AppendEntries RPC时,表明
            // 目前是存在leader的且自己的任期是过时的,所以需要切换到follower状态,重置选举超时。
            rf.resetElectionTimer()

            // 重置下voteFor,以便可以重新投票
            rf.voteFor = -1

            // if a candidate or leader discovers that its term is out of date, it
            // immediately revert to follower state
            rf.switchTo(Follower)

            // 继续往下,以便一致性检查通过后进行日志复制
        }

        // if the consistency check pass
        if len(rf.log) > args.PrevLogIndex &&
            rf.log[args.PrevLogIndex].Term == args.PrevLogTerm {

            // 收到AppendEntries RPC(包括心跳),说明存在leader,自己切换为follower状态
            rf.switchTo(Follower)

            // **If** an existing entry conflicts with a new one(same index but
            // different terms), delete the existing entry and all that follow it.
            // 这里的If至关重要。如果follower拥有领导者的日志条目,则follower一定不能(MUST NOT)
            // 截断其日志。leader发送的条目之后的任何内容(any elements of following the entries
            // send by the leader)必须(MUST)保留。

            // 1. 判断follower中log是否已经拥有args.Entries的所有条目,全部有则匹配!
            isMatch := true
            nextIndex := args.PrevLogIndex+1
            end := len(rf.log) - 1
            for i := 0; isMatch && i < len(args.Entries); i++ {
                // 如果args.Entries还有元素,而log已经达到结尾,则不匹配
                if end < nextIndex + i {
                    isMatch = false
                } else if rf.log[nextIndex+i].Term != args.Entries[i].Term {
                    isMatch = false
                }
            }

            // 2. 如果存在冲突的条目,再进行日志复制
            if isMatch == false {
                // 2.1. 进行日志复制,并更新commitIndex
                rf.log = append(rf.log[:nextIndex], args.Entries...)	// [0, nextIndex) + entries
            }

            DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\tcommitIndex %d while leaderCommit %d" +
                " for leader %d\n", rf.me, rf.currentTerm, state2name(rf.state), rf.commitIndex,
                args.LeaderCommit, args.LeaderId)

            // if leaderCommit > commitIndex, set commitIndex = min(leaderCommit, index of last new entry)
            if args.LeaderCommit > rf.commitIndex {
                rf.commitIndex = args.LeaderCommit
                if rf.commitIndex > len(rf.log) - 1 {
                    rf.commitIndex = len(rf.log) - 1
                }
            }

            index := nextIndex + len(args.Entries) - 1
            DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\tconsistency check pass for index %d" +
                " with args's prevLogIndex %d args's prevLogTerm %d\n", rf.me, rf.currentTerm, state2name(rf.state),
                index, args.PrevLogIndex, args.PrevLogTerm)


            // Reset timeout when received leader's AppendEntries RPC
            rf.resetElectionTimer()
            // 接收到leader的心跳,就可以将投票时用于记录授予投票voteFor清零
            rf.voteFor = -1

            // 记录下leaderId
            rf.leaderId = args.LeaderId

            // 更新了commitIndex之后给applyCond条件变量发信号,以应用新提交的entries到状态机
            rf.applyCond.Broadcast()

            reply.Term = rf.currentTerm
            reply.Success = true
            return

        } else {

            nextIndex := args.PrevLogIndex + 1
            index := nextIndex + len(args.Entries) - 1

            DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\tconsistency check failed for index %d" +
                " with args's prevLogIndex %d args's prevLogTerm %d\n",
                rf.me, rf.currentTerm, state2name(rf.state), index, args.PrevLogIndex, args.PrevLogTerm)

            //如果peer的日志长度小于leader的nextIndex
            if len(rf.log) < nextIndex {
                lastIndex := len(rf.log) - 1
                lastTerm := rf.log[lastIndex].Term
                reply.ConflictTerm = lastTerm
                reply.ConflictFirstIndex = lastIndex

                DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\tlog's len %d" +
                    " is shorter than args's prevLogIndex %d\n",
                    rf.me, rf.currentTerm, state2name(rf.state), len(rf.log), args.PrevLogIndex)
            } else {
                reply.ConflictTerm = rf.log[args.PrevLogIndex].Term
                reply.ConflictFirstIndex = args.PrevLogIndex
                DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\tconsistency check failed" +
                    " with args's prevLogIndex %d args's prevLogTerm %d while it's prevLogTerm %d in" +
                    " prevLogIndex %d\n", rf.me, rf.currentTerm, state2name(rf.state),
                    args.PrevLogIndex, args.PrevLogTerm, rf.log[args.PrevLogIndex].Term, args.PrevLogIndex)
            }
            // 递减reply.ConflictFirstIndex直到index为log中第一个term为reply.ConflictTerm的entry
            for i := reply.ConflictFirstIndex - 1; i >= 0; i-- {
                if rf.log[i].Term != reply.ConflictTerm {
                    break
                } else {
                    reply.ConflictFirstIndex -= 1
                }
            }
            DPrintf("[AppendEntries]: Id %d Term %d State %s\t||\treply's conflictFirstIndex %d" +
                " and conflictTerm %d\n", rf.me, rf.currentTerm, state2name(rf.state),
                reply.ConflictFirstIndex, reply.ConflictTerm)
        }
    }

    reply.Term = rf.currentTerm
    reply.Success = false
}

3. 心跳处理

3.1 心跳也需要重试机制

Start()中在发送AppendEntries RPC时,该RPC可能会因为一致性检查不通过而失败,此时需要递减nextIndex并重新发送RPC,直到一致性检查通过,然后进行进一步处理。因为发送心跳也会进行一致性检查,为了不因为初始时的日志不一致而使得心跳发送失败,而其他peers因为没有通过心跳而心跳超时(也就是选举超时,即electionTimeout),进而发起不需要的(no-needed)选举,所以发送心跳也需要在一致性检查失败后进行重试。

3.2 心跳应该根据nextIndex的值判断是否需要携带entries信息

概念上讲,心跳不携带entries,这指的是对某个peer而言,其nextIndex为其log的尾后位置时的这种一般情况。但是如果nextIndex小于log的尾后位置,这时心跳必须携带entries,这是因为正如1.4 当entry被提交后发送一次心跳以通知其他peers更新commitIndex所述,心跳的一个作用是通知其他peer更新commitIndex以应用新提交的entry,所以如果这次心跳通过了一致性检查,就可能会提升commitIndex,这时会给applyCond条件变量发信号以提交[lastApplied+1, commitIndex]之间的entries。如果此次心跳没有携带entries,则不会有不一致日志的截断和leader对应位置entries的追加,所以这时提交的可能是和leader不一致的过时的entries,这就出现了严重错误。所以这种情况下心跳要携带entries信息。而是否携带entries,完全取决于nextIndex的值。
在实验中,我为了保证心跳不携带entries不出现上述错误,在Start()调用中,当在处理AppendEntries RPC的回复时发现leader任期是过时的,除了更新leader的任期为回复中的更新的任期,切换为follower,重置voteFor为-1,以及重置选举超时定时器这些常规操作外,任期过时,也说明了要追加的entry是过时的,此时应该从log中删除这条entry,以免该过时的leader再次当选后,可能会复制该entry到其他peers。同时在发送心跳时,当一致性检查失败时,接下来的重试都携带entreis,以便如果这次重试的一致性检查通过,可以进行日志追加,以使得AppendEntries RPC请求处理程序提升commitIndex并应用新提交的entires到状态机的操作,不是应用之前不一致的entries,而是追加的leader的entries。但这还是无法避免一些情况下仍出错,比如Part 2B的测试函数TestBackup2B()的情况,如下图所示:
TestBackup2B()出错
修改后的broadcastHeartbeat实现如下:

// leader给其他peers广播一次心跳。因为发送心跳也要进行一致性检查,
// 为了不因为初始时的日志不一致而使得心跳发送失败,而其他peers因为
// 接收不到心跳而心跳超时,进而发起不需要的(no-needed)选举,所以
// 发送心跳也需要在一致性检查失败时进行重试。
func (rf *Raft) broadcastHeartbeat() {

    // 非leader不能发送心跳
    if _, isLeader := rf.GetState(); isLeader == false {
        return
    }

    rf.mu.Lock()
    // 发送心跳时更新下发送时间
    rf.latestIssueTime = time.Now().UnixNano()
    rf.mu.Unlock()

    go func() {
        var wg sync.WaitGroup
        keep := true

        for i, _ := range rf.peers {

            // 读keep需要加锁
            rf.mu.Lock()
            if keep == false {
                break
            }
            rf.mu.Unlock()

            if i == rf.me {
                continue
            }
            wg.Add(1)

            go func(i int, rf *Raft, keep *bool) {
                defer wg.Done()

                // 在AppendEntries RPC一致性检查失败后,递减nextIndex,重试
            retry:

                // 因为涉及到retry操作,避免过时的leader的retry操作继续下去
                if _, isLeader := rf.GetState(); isLeader == false {
                    return
                }

                rf.mu.Lock()
                // 封装AppendEntriesArgs参数
                prevLogIndex := rf.nextIndex[i] - 1
                if prevLogIndex < 0 {
                    DPrintf("[Broadcast]: Id %d Term %d State %s\t||\tinvalid prevLogIndex %d for peer %d\n",
                        rf.me, rf.currentTerm, state2name(rf.state), prevLogIndex, i)
                }
                prevLogTerm := rf.log[prevLogIndex].Term
                // Todo:概念上将心跳不携带entries,这指的是当nextIndex为log的尾后位置时的一般情况。
                // 但是如果nextIndex小于log的尾后位置,这是心跳必须携带entries,因为这次心跳可能就会
                // 通过一致性检查,并可能提升commitIndex,这时会给applyCond条件变量发信号以提交
                // [lastApplied+1, commitIndex]之间的entries。如果此次心跳没有携带entries,则不会有
                // 日志追加,所以提交的可能是和leader不一致的过时的entries,这就出现了严重错误。所以
                // 这种情况下心跳要携带entries。
                entries := rf.log[prevLogIndex+1:]
                args := AppendEntriesArgs{Term:rf.currentTerm, LeaderId:rf.me,
                    PrevLogIndex:prevLogIndex, PrevLogTerm:prevLogTerm,
                    Entries:entries, LeaderCommit:rf.commitIndex}
                DPrintf("[Broadcast]: Id %d Term %d State %s\t||\tissue heartbeat to peer %d" +
                    " with nextIndex %d\n", rf.me, rf.currentTerm, state2name(rf.state), i, prevLogIndex+1)
                rf.mu.Unlock()
                var reply AppendEntriesReply

                ok := rf.sendAppendEntries(i, &args, &reply)

                // 心跳发送失败,表明无法和peer建立通信,直接退出
                if ok == false {
                    rf.mu.Lock()
                    DPrintf("[Broadcast]: Id %d Term %d State %s\t||\tissue heartbeat to peer %d failed\n",
                        rf.me, rf.currentTerm, state2name(rf.state), i)
                    rf.mu.Unlock()
                    return
                }

                // heartbeat被拒绝,原因可能是leader任期过时,或者一致性检查没有通过。
                // 发送心跳也可能出现一致性检查不通过,因为一致性检查是查看leader的nextIndex之前的
                // entry和指定peer的log中那个索引的日志是否匹配。即使心跳中不携带任何日志,但一致性
                // 检查仍会因为nextIndex而失败,这时需要递减nextIndex然后重试。
                if reply.Success == false {

                    rf.mu.Lock()
                    DPrintf("[Broadcast]: Id %d Term %d State %s\t||\theartbeat is rejected by peer %d\n",
                        rf.me, rf.currentTerm, state2name(rf.state), i)

                    // leader任期过时,需要切换到follower
                    if rf.currentTerm < reply.Term {
                        // If RPC request or response contains term T > currentTerm, set currentTerm = T,
                        // convert to follower
                        rf.currentTerm = reply.Term
                        rf.voteFor = -1
                        rf.switchTo(Follower)
                        rf.resetElectionTimer()
                        *keep = false
                        DPrintf("[Broadcast]: Id %d Term %d State %s\t||\theartbeat is rejected by peer %d" +
                            " due to newer peer's term %d\n", rf.me, rf.currentTerm, state2name(rf.state), i, reply.Term)
                        rf.mu.Unlock()
                        return
                    } else {	// 如果是一致性检查未通过,则递减nextIndex,重试

                        conflictFirstIndex := reply.ConflictFirstIndex
                        conflictTerm := rf.log[conflictFirstIndex].Term
                        // 判断conflictFirstIndex处的entry是否和reply的peer一致,即term相等
                        if conflictTerm == reply.ConflictTerm {
                            // 相等,则nextIndex直接设置为conflictFirstIndex + 1
                            rf.nextIndex[i] = conflictFirstIndex + 1
                        } else {
                            // 若不等,则递减conflictFirstIndex,直到entry为leader的log中第一个出现conflictTerm的index
                            for k := conflictFirstIndex - 1; k >= 0; k-- {
                                if rf.log[k].Term != conflictTerm {
                                    break
                                } else {
                                    conflictFirstIndex -= 1
                                }
                            }
                            rf.nextIndex[i] = conflictFirstIndex + 1
                        }
                        // 为避免活锁,这里需要判断下prevLogIndex(rf.nextIndex[i]-1)的任期是否等于reply.ConflictTerm。
                        // 如果不等,则说明rf.nextIndex[i]没有前进,遇到“活锁”,这时简单的将其减1即可。
                        nextIndex := rf.nextIndex[i]
                        if nextIndex - 1 == reply.ConflictFirstIndex &&
                            rf.log[nextIndex-1].Term != reply.ConflictTerm {
                            rf.nextIndex[i] -= 1
                        }

                        DPrintf("[Broadcast]: Id %d Term %d State %s\t||\theartbeat is rejected by peer %d" +
                            " due to the consistency check failed\n", rf.me, rf.currentTerm, state2name(rf.state), i)
                        DPrintf("[Broadcast]: Id %d Term %d State %s\t||\tretry heartbeat with" +
                            " conflictFirstIndex %d and conflictTerm %d nextIndex %d\n", rf.me, rf.currentTerm,
                            state2name(rf.state), conflictFirstIndex, conflictTerm, rf.nextIndex[i])
                        rf.mu.Unlock()
                        goto retry
                    }

                } else {
                    // 心跳发送成功
                    rf.mu.Lock()
                    // 更新下该peer对应的nextIndex和matchIndex
                    if rf.nextIndex[i] < len(rf.log) {
                        rf.nextIndex[i] = len(rf.log)
                        rf.matchIndex[i] = rf.nextIndex[i] - 1
                    }
                    //rf.matchIndex[i] = rf.nextIndex[i] - 1
                    DPrintf("[Broadcast]: Id %d Term %d State %s\t||\tsend heartbeat to peer %d success\n",
                        rf.me, rf.currentTerm, state2name(rf.state), i)
                    rf.mu.Unlock()
                }

            }(i, rf, &keep)

        }

        //等待所有发送goroutine结束
        wg.Wait()

    }()
}

4. 新增的长期运行的(long-running)的应用日志条目goroutine

一旦更新了commitIndex,需要一种机制将新提交的entry封装为ApplyMsg消息并发送到传递给Make()函数的参数applyChchannel中。
正如Raft Structrue Advice关于应用提交的日志条目的建议:

你会想有一个单独的(separate)长期运行的goroutine来按顺序(in order)发送已提交的(committed)日志条目到applyCh。它必须是单独的(separate),因为在applyCh上发送消息可能阻塞(block);并且它也必须是单个的goroutine,因为否则可能很难确保你可以按照日志顺序(in log order)发送日志条目。提升(advances)commitIndex的代码需要踢(kick)该应用goroutine(the apply goroutine);使用条件变量(condition variable)(Go's sync.Cond)做这个可能是最简单的。

参照之前选举超时(心跳超时)检测electionTimeoutTick的实现,我们自然想到可以将该通知机制作为另一个长期运行的goroutine,它循环检测commitIndex是否大于lastApplied,如果满足,则逐个将[lastApplied+1, commitIndex]之间的entry封装为ApplyMsg发送到applyCh,如果不满足,则休眠等待条件变量applyCond。而每当leader或其他follower的commitIndex更新后,就给applyCond发信号。
applyEntriesgoroutine的代码实现如下:

// 按顺序(in order)发送已提交的(committed)日志条目到applyCh的goroutine。
// 该goroutine是单独的(separate)、长期运行的(long-running),在没有新提交
// 的entries时会等待条件变量;当更新了commitIndex之后会给条件变量发信号,
// 以唤醒该goroutine执行提交。
func (rf *Raft) applyEntries() {
    for {

        rf.mu.Lock()
        commitIndex := rf.commitIndex
        lastApplied := rf.lastApplied
        DPrintf("[applyEntries]: Id %d Term %d State %s\t||\tlastApplied %d and commitIndex %d\n",
            rf.me, rf.currentTerm, state2name(rf.state), lastApplied, commitIndex)
        rf.mu.Unlock()

        if lastApplied == commitIndex {
            rf.mu.Lock()
            rf.applyCond.Wait()
            rf.mu.Unlock()
        } else {
            for i := lastApplied+1; i <= commitIndex; i++ {

                rf.mu.Lock()
                applyMsg := ApplyMsg{CommandValid:true, Command:rf.log[i].Command,
                    CommandIndex:i}
                rf.lastApplied = i
                DPrintf("[applyEntries]: Id %d Term %d State %s\t||\tapply command of index %d to applyCh\n",
                    rf.me, rf.currentTerm, state2name(rf.state), i)
                rf.mu.Unlock()
                rf.applyCh <- applyMsg

            }
        }
    }
}