c-raft


难度 中等

CI Tests codecov Documentation Status

raft协议的完全异步C语言实现。

raft库采用模块化设计,核心部分实现了完全独立于平台的raft协议逻辑。最重要的是为网络传输(发送/接收,rpc消息)和存储持久化(日志和快照)提供了可插拔的I/O接口实现。

在使用默认选项构建库时,基于 libuv提供了 I/O 接口的库存实现,适合绝大多数应用场景。唯一的问题是它目前
需要 Linux,因为它使用 Linux AIO API 用于磁盘输入/输出。 欢迎补丁添加对更多平台的支持。

可以通过raft.h来查看全部接口。

license

这个 raft C 库是在略微修改的 LGPLv3 版本下发布的,其中包括一个版权例外,允许用户在他们的项目中静态链接库代码并按照自己的条款发布最终作品。如有需要,请查看完整license文件。

Features

该实现包括 Raft 论文中描述的所有基本功能:

  • 领袖选举

  • 日志复制

  • 日志压缩

  • 成员变更

它还包括一些可选的增强功能:

  • 乐观流水线减少日志复制延迟
  • 并行写入领导者的磁盘
  • 领导者失去法定人数时自动下台
  • 领导转移延期
  • 投票前协议

install

如果您使用的是基于 Debian 的系统,您可以从 dqlite 的dev PPA 获得最新的开发版本:

sudo add-apt-repository ppa:dqlite/dev
sudo apt-get update
sudo apt-get install libraft-dev

Building

从源码编译libraft,需要准备:

  • 最较新版本的libuv(v1.18.0或之后的版本)
  • 可选的liblz4(推荐使用)(v1.7.1或之后的版本)
sudo apt-get install libuv1-dev liblz4-dev

autoreconf -i

./configure --enable-example

make

Example

理解如何使用raft库的最好方式是阅读源码目录下的example server。

可以运行如下命令来了解example server的运行情况:

./example/cluster

这个命令启动了一个3节点组成的集群,并且会不断的随机停止一个节点并重启。

Quick guide

以下是一个如何使用raft库的快速指南(为了简洁起见,省略了错误处理),要想了解详细的信息建议阅读raft.h。

  1. 创建一个raft_io 接口实现的实例(如果库附带的接口确实不适合,则实现您自己的实例):
const char *dir = "/your/raft/data";
struct uv_loop_s loop;
struct raft_uv_transport transport;
struct raft_io io;
uv_loop_init(&loop);
raft_uv_tcp_init(&transport, &loop);
raft_uv_init(&io, &loop, dir, &transport);
  1. 定义应用层的Raft FSM,实现raft_fsm接口
```C
struct raft_fsm
{
  void *data;
  int (*apply)(struct raft_fsm *fsm, const struct raft_buffer *buf, void **result);
  int (*snapshot)(struct raft_fsm *fsm, struct raft_buffer *bufs[], unsigned *n_bufs);
  int (*restore)(struct raft_fsm *fsm, struct raft_buffer *buf);
}
3. 为每个服务节点选择一个唯一的 ID 和地址并初始化 raft 对象:

```C
unsigned id = 1;
const char *address = "192.168.1.1:9999";
struct raft raft;
raft_init(&raft, &io, &fsm, id, address);
  1. 如果这是您第一次启动集群,请创建一个包含集群中服务器节点(节点通常只有一个,因为稍后可以使用raft_add 和raft_promote 扩展集群)的配置对象,并启动配置:
struct raft_configuration configuration;
raft_configuration_init(&configuration);
raft_configuration_add(&configuration, 1, "192.168.1.1:9999", true);
raft_bootstrap(&raft, &configuration);
  1. 启动raft服务器节点
raft_start(&raft);
uv_run(&loop, UV_RUN_DEFAULT);
  1. 异步提交请求将新命令应用到应用程序状态机
static void apply_callback(struct raft_apply *req, int status, void *result) {
  /* ... */
}

struct raft_apply req;
struct raft_buffer buf;
buf.len = ...; /* The length of your FSM entry data */
buf.base = ...; /* Your FSM entry data */
raft_apply(&raft, &req, &buf, 1, apply_callback);
  1. 添加更多的服务器节点到集群使用raft_add() 和raft_promote APIs

Usage Notes

默认基于 libuv 的 raft_io 实现使用 liblz4 库压缩 raft 快照。 除了节省磁盘空间,lz4 压缩快照以内容校验和的形式提供额外的数据完整性检查,这允许 raft检测存储期间发生的损坏。 因此,建议不要通过--disable-lz4 配置标志禁用 lz4 压缩。

当启动时设置环境变量 LIBRAFT_TRACE 时,将启用详细跟踪。

Notable users

- dqlite

Credits

当然,最感谢的是 Diego Ongaro :)(raft论文的作者)。下面的raft实现提供了很多灵感和想法:


文章作者: growdu
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 growdu !
  目录
分类导航
随笔3 AI29 计算机基础13 算法1 博客搭建7 ChatGPT2 集群63 计算机通信1 数据库59 数据库深入93 数据库93 Docker11 DPDK26 编辑工具4 Elasticsearch4 FAQ1 Go Web1 hometown2 编程语言16 人生11 网络9 Linux38 OPC1 openGauss4 页面12 PostgreSQL54 程序员自我修养1 协议11 stock1 存储5 成长之路1 工具20 视频作品1 VPP18 Vue13 Web1 代码示例11 BenchmarkSQL1 PostgreSQL 源码修炼之路14
最热文章
1
PostgreSQL 逻辑复制全链路:以一个真实事务为例,从 `INSERT` 到 `apply` 的源码级旅程
数据库🔥 2162
2
PostgreSQL 逻辑复制 Stream 执行逻辑源码级拆解:从 reorderbuffer 触发到订阅端落盘回放
数据库🔥 1765
3
PostgreSQL 行锁机制源码级深度拆解:4 种锁模式 + xmax + MultiXact 的完整链路
数据库🔥 1656
4
PostgreSQL reorderbuffer.c 函数级源码全集:5615 行 / 95 个函数的逐函数解析
数据库深入🔥 1650
5
PostgreSQL 目录快照源码级深度拆解:系统表读取的 MVCC 真相与失效机制
数据库🔥 1604
6
13 逻辑复制深入
数据库深入🔥 1570
7
0 Postgresql存储、索引及系统优化、主备切换
PostgreSQL🔥 1495
8
PostgreSQL 读一行数据源码级深度拆解:MVCC 在每个环节的落点
数据库🔥 1464
9
PostgreSQL WAL 记录类型完全指南:21 个 RMGR × 80+ 种记录的源码级拆解
数据库🔥 1431
10
一文读懂openguass dcf网络模块
集群🔥 1420
11
PostgreSQL 元数据存储机制:从磁盘文件到内存缓存,`pg_class` 撑起的整个系统表体系
数据库🔥 1411
12
openGauss 并行解码设计原理深度拆解:reader + 多 worker + CSN 三层架构的源码级剖析
数据库深入🔥 1344
13
逻辑复制源码分析
数据库深入🔥 1327
14
PostgreSQL 逻辑复制:catalog 改动、可见性判定与 xmin/xmax 推进全景
数据库深入🔥 1317
15
自托管服务全家桶:从原文方案到可复制实操手册
人生🔥 1278
16
PostgreSQL CREATE_REPLICATION_SLOT 端到端源码分析:从 SQL 到 snapbuild 状态机的完整链路(每个函数每个参数)
数据库深入🔥 1277
17
PostgreSQL syscache 模块源码深度拆解:CatCache 数据结构、LRU 哈希表、cache invalidation 全链路
数据库深入🔥 1216
18
PostgreSQL 18 内核数据结构全景:RangeVar 与 20+ 个核心数据结构源码级拆解
数据库🔥 1158
19
PostgreSQL 逻辑复制里 `RUNNING_XACTS` 写入机制与快照 `xmin / xmax / xip` 的演化:源码级深度拆解
数据库🔥 1119
20
PostgreSQL 分区表:从一行 `PARTITION BY` 到路由热路径的全链路拆解
数据库🔥 1094