KiwiDB 要点

[AlexStocks]

1 KiWiDB主流程

1.1 Raft的Join/Add/Remove/Init命令流程

只记录了发送端，接收端代码尚未探查.

1.2 PClient SendPacket流程 与数据包真正发送的流程

1.3 NetEvent 与其他Class关系

红色为继承关系，黑色为成员关系

1.4 kiwiDB::TCPConnect 流程

1. 机器启动执行初始化
2. 设置定时任务Cron()
3. 若本机是Replication机，尝试与Master构建连接，维护连接
4. PClient 是与其他机器的连接操作的抽象，只有在成功连接后才能加入本机的ClientMap

1.5 RaftClusterCmd::DoCmdJoin() 拆解

1.6 ListenSocket 监听 + 创建连接流程

1.7 命令解析链路

[AlexStocks]

2 BRaft API分析

2.1 Node 各个接口的功能分析

核心功能

接口	作用
void apply(const Task& task);	提交任务到 Raft 组，任务成功提交后会被状态机应用。
int init(const NodeOptions& options);	根据配置初始化节点，启动 Raft 组的相关服务。
void shutdown(Closure* done);	优雅关闭节点，执行清理操作并调用用户定义的 done 回调。
void join();	阻塞线程，直到节点成功停止。

动态配置

接口	作用
void add_peer(const PeerId& peer, Closure* done);	向 Raft 组添加一个新节点。
void remove_peer(const PeerId& peer, Closure* done);	从 Raft 组中移除一个节点。
void change_peers(const Configuration& new_peers, Closure* done);	更改 Raft 组的节点配置。
butil::Status reset_peers(const Configuration& new_peers);	在极端情况下强制重置节点配置，以恢复服务。

领导者管理

接口	作用
bool is_leader();	检查当前节点是否为领导者。
bool is_leader_lease_valid();	检查当前领导者的租约是否有效。
int transfer_leadership_to(const PeerId& peer);	手动触发领导权转移。

状态查询

接口	作用
butil::Status list_peers(std::vector* peers);	返回当前 Raft 组的节点列表。
void get_status(NodeStatus* status);	返回节点的详细状态信息，用于监控或调试。
PeerId leader_id();	获取当前领导者的 ID，用于重定向请求。

快照管理

接口	作用
void snapshot(Closure* done);	手动触发快照生成，用于压缩日志或恢复状态。

选举管理

接口	作用
butil::Status vote(int election_timeout);	手动触发选举，用于测试或特定场景。
butil::Status reset_election_timeout_ms(int election_timeout_ms);	动态调整选举超时时间。
void reset_election_timeout_ms(int election_timeout_ms, int max_clock_drift_ms);	动态调整选举超时和时钟漂移参数。

日志管理

接口	作用
butil::Status read_committed_user_log(const int64_t index, UserLog* user_log);	读取已提交的用户日志，用于查询或恢复。

只读模式

接口	作用
void enter_readonly_mode();	将节点设置为只读模式，用于保护系统或处理极端情况。
void leave_readonly_mode();	恢复节点的读写功能。
bool readonly();	返回节点是否处于只读模式。

2.2 FSMCaller::run() 状态分析

状态类型	执行的操作
COMMITTED	如果 iter->committed_index 大于 max_committed_index，则更新 max_committed_index 并增加计数器 counter。如果达到批量大小 batch_size，则调用 caller->do_committed(max_committed_index) 提交任务。
SNAPSHOT_SAVE	设置 caller->_cur_task 为 SNAPSHOT_SAVE，并调用 caller->do_snapshot_save 保存快照。
SNAPSHOT_LOAD	设置 caller->_cur_task 为 SNAPSHOT_LOAD，并调用 caller->do_snapshot_load 加载快照。
LEADER_STOP	设置 caller->_cur_task 为 LEADER_STOP，并调用 caller->do_leader_stop 停止领导角色。删除 iter->status。
LEADER_START	调用 caller->do_leader_start 启动领导角色。删除 iter->leader_start_context。
START_FOLLOWING	设置 caller->_cur_task 为 START_FOLLOWING，并调用 caller->do_start_following 开始跟随领导角色。删除 iter->leader_change_context。
STOP_FOLLOWING	设置 caller->_cur_task 为 STOP_FOLLOWING，并调用 caller->do_stop_following 停止跟随领导角色。删除 iter->leader_change_context。
ERROR	设置 caller->_cur_task 为 ERROR，并调用 caller->do_on_error 处理错误。
IDLE	断言 false，表示不应该到达此状态。

2.3 Node::Apply() 流程

2.4 NodeImpl接口分析

2.5 Raft NodeImpl AppendEntries 流程分析

[AlexStocks]

[luky116]

CURVE ：
https://ask.opencurve.io/t/topic/98/9

BRAFT：
https://zhuanlan.zhihu.com/p/169904153