The data backup and recovery functions have been added

Author: wuxianrong

.github/workflows/pika.yml

@@ -16,7 +16,7 @@ jobs:
     # The CMake configure and build commands are platform-agnostic and should work equally well on Windows or Mac.
     # You can convert this to a matrix build if you need cross-platform coverage.
     # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Free Disk Space (Ubuntu Host)
@@ -36,17 +36,25 @@ jobs:
       - name: ccache
         uses: hendrikmuhs/[email protected]
         with:
-          key: ubuntu-latest
+          key: ubuntu-22.04
 
       - name: Install Deps
         run: |
           sudo apt-get update
-          sudo apt-get install -y autoconf libprotobuf-dev protobuf-compiler clang-tidy
+          # Use GCC 10 to avoid GCC 13+ / glibc version mismatch issues with brpc/braft
+          # GCC 10 has better C++17 support than GCC 9 while avoiding the glibc incompatibility
+          sudo apt-get install -y autoconf libprotobuf-dev protobuf-compiler clang-tidy libssl-dev gcc-10 g++-10
 
       - name: Configure CMake
         # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
         # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
-        run: cmake -B build -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DUSE_PIKA_TOOLS=ON -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address -D CMAKE_C_COMPILER_LAUNCHER=ccache -D CMAKE_CXX_COMPILER_LAUNCHER=ccache
+        run: |
+          export CC=gcc-10
+          export CXX=g++-10
+          # Ensure GCC 10 is used as the default compiler to avoid glibc/libstdc++ version mismatch
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-10 100
+          cmake -B build -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10 -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DUSE_PIKA_TOOLS=ON -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address -D CMAKE_C_COMPILER_LAUNCHER=ccache -D CMAKE_CXX_COMPILER_LAUNCHER=ccache
 
       - name: Build
         # Build your program with the given configuration
@@ -90,7 +98,8 @@ jobs:
           sh integrate_test.sh
 
   build_on_rocky:
-    runs-on: ubuntu-latest
+    # Use ubuntu-22.04 instead of ubuntu-latest to avoid GCC 13+ incompatibility issues
+    runs-on: ubuntu-22.04
     container:
       image: rockylinux:9
 
@@ -166,8 +175,9 @@ jobs:
       - name: Install deps
         run: |
           dnf update -y
-          dnf install -y bash cmake wget git autoconf gcc perl-Digest-SHA tcl which tar g++ tar epel-release gcc-c++ libstdc++-devel gcc-toolset-13 binutils
           dnf clean all
+          # Use gcc-toolset-10 to avoid GCC 13+ / glibc version mismatch issues with brpc/braft
+          dnf install -y bash cmake wget git autoconf gcc perl-Digest-SHA tcl which tar g++ tar epel-release gcc-c++ libstdc++-devel gcc-toolset-10 openssl-devel zlib-devel
           rm -rf /var/cache/dnf
 
       - name: Set up Go
@@ -182,8 +192,11 @@ jobs:
 
       - name: Configure CMake
         run: |
-          source /opt/rh/gcc-toolset-13/enable
-          cmake -B build -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DUSE_PIKA_TOOLS=ON -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address .
+          source /opt/rh/gcc-toolset-10/enable
+          # Explicitly set compiler to GCC 10 from toolset to avoid glibc/libstdc++ version mismatch
+          export CC=/opt/rh/gcc-toolset-10/root/usr/bin/gcc
+          export CXX=/opt/rh/gcc-toolset-10/root/usr/bin/g++
+          cmake -B build -DCMAKE_C_COMPILER=$CC -DCMAKE_CXX_COMPILER=$CXX -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DUSE_PIKA_TOOLS=ON -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address .
 
       - uses: actions/cache@v3
         with:
@@ -197,7 +210,7 @@ jobs:
 
       - name: Build
         run: |
-          source /opt/rh/gcc-toolset-13/enable
+          source /opt/rh/gcc-toolset-10/enable
           cmake --build build --config ${{ env.BUILD_TYPE }}
 
       - name: Cleanup
@@ -292,13 +305,15 @@ jobs:
       - name: Install Deps
         run: |
           brew list --versions cmake && brew uninstall --ignore-dependencies --force cmake || true
-          brew install gcc@13 automake cmake make binutils
+          # Use GCC 10 for consistency with Ubuntu and Rocky builds
+          brew install gcc@10 automake cmake make binutils
 
       - name: Configure CMake
         run: |
-          GCC_PREFIX=$(brew --prefix gcc@13)
-          export CC=$GCC_PREFIX/bin/gcc-13
-          cmake -B build -DCMAKE_C_COMPILER=$GCC_PREFIX/bin/gcc-13 -DUSE_PIKA_TOOLS=ON -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address -D CMAKE_C_COMPILER_LAUNCHER=ccache -D CMAKE_CXX_COMPILER_LAUNCHER=ccache
+          GCC_PREFIX=$(brew --prefix gcc@10)
+          export CC=$GCC_PREFIX/bin/gcc-10
+          export CXX=$GCC_PREFIX/bin/g++-10
+          cmake -B build -DCMAKE_C_COMPILER=$GCC_PREFIX/bin/gcc-10 -DCMAKE_CXX_COMPILER=$GCC_PREFIX/bin/g++-10 -DUSE_PIKA_TOOLS=ON -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DCMAKE_CXX_FLAGS_DEBUG=-fsanitize=address -D CMAKE_C_COMPILER_LAUNCHER=ccache -D CMAKE_CXX_COMPILER_LAUNCHER=ccache
 
       - name: Build
         run: |

CMakeLists.txt

@@ -89,6 +89,18 @@ set(INSTALL_LIBDIR ${STAGED_INSTALL_PREFIX}/lib)
 set(INSTALL_LIBDIR_64 ${STAGED_INSTALL_PREFIX}/lib64)
 set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ${STAGED_INSTALL_PREFIX})
 
+# Fix __const__ macro conflict with GCC 13+/glibc 2.38+ in existing brpc headers
+# This must run during CMake configuration to fix cached/existing headers
+if(EXISTS "${INSTALL_INCLUDEDIR}/butil/errno.h")
+  file(READ "${INSTALL_INCLUDEDIR}/butil/errno.h" ERRNO_H_CONTENT)
+  string(FIND "${ERRNO_H_CONTENT}" "#ifndef __const__" HAS_CONST_MACRO)
+  if(NOT HAS_CONST_MACRO EQUAL -1)
+    message(STATUS "Patching existing brpc errno.h for GCC 13+ compatibility")
+    string(REPLACE "#ifndef __const__" "#if 0 /* disabled for GCC 13+ compatibility */" ERRNO_H_CONTENT "${ERRNO_H_CONTENT}")
+    file(WRITE "${INSTALL_INCLUDEDIR}/butil/errno.h" "${ERRNO_H_CONTENT}")
+  endif()
+endif()
+
 execute_process(COMMAND sh ${CMAKE_UTILS_DIR}/Get_OS_Version.sh
   OUTPUT_VARIABLE OS_VERSION)
 
@@ -664,6 +676,12 @@ ExternalProject_Add(brpc
   1
   UPDATE_COMMAND
   ""
+  # Patch to fix __const__ macro conflict with GCC 13+/glibc 2.38+
+  # The issue is that brpc defines __const__ as __unused__ which conflicts with
+  # glibc's __glibc_has_attribute(__const__) macro in sys/cdefs.h
+  # We replace '#ifndef __const__' with '#if 0' to disable the problematic macro
+  PATCH_COMMAND
+  sh -c "sed -i.bak 's/#ifndef __const__/#if 0 /' src/butil/errno.h && cat src/butil/errno.h | head -35"
   LOG_CONFIGURE
   1
   LOG_BUILD
@@ -677,16 +695,29 @@ ExternalProject_Add(brpc
   -DCMAKE_INSTALL_PREFIX=${STAGED_INSTALL_PREFIX}
   -DCMAKE_BUILD_TYPE=${LIB_BUILD_TYPE}
   -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
+  -DCMAKE_FIND_ROOT_PATH=${STAGED_INSTALL_PREFIX}
+  -DCMAKE_INCLUDE_PATH=${INSTALL_INCLUDEDIR}
+  -DCMAKE_LIBRARY_PATH=${INSTALL_LIBDIR}
   -DWITH_GLOG=ON
   -DWITH_SNAPPY=ON
   -DBUILD_SHARED_LIBS=OFF
   -DDOWNLOAD_GTEST=OFF
+  -DCMAKE_EXE_LINKER_FLAGS=-L${INSTALL_LIBDIR}\ -L${INSTALL_LIBDIR_64}
   BUILD_ALWAYS
   1
   BUILD_COMMAND
   make -j${CPU_CORE}
 )
 
+# Fix the installed header file after brpc installation
+# This is needed because braft uses the installed headers, not the patched source
+# The __const__ macro in butil/errno.h conflicts with glibc 2.38+ / GCC 13+
+ExternalProject_Add_Step(brpc fix_installed_headers
+  COMMAND sh -c "sed -i.bak 's/#ifndef __const__/#if 0 /' ${INSTALL_INCLUDEDIR}/butil/errno.h && cat ${INSTALL_INCLUDEDIR}/butil/errno.h | head -35"
+  DEPENDEES install
+  COMMENT "Patching installed brpc headers for GCC 13+ compatibility"
+)
+
 if(${OS_VERSION} MATCHES "Rocky" OR ${OS_VERSION} MATCHES "CentOS")
   set(BRPC_LIBRARY ${INSTALL_LIBDIR_64}/libbrpc.a)
 else()

docs/raft_implementation_review.md

@@ -0,0 +1,93 @@
+# Pika Raft 模式实现 Review 文档
+
+## 1. 概述
+
+Pika 的 Raft 模式基于 [braft](https://github.com/baidu/braft) 实现分布式一致性，使用 brpc 进行节点间通信。
+
+**核心特性**：
+- 强一致性保证
+- 自动 Leader 选举
+- 基于 RocksDB Checkpoint 的快照机制
+
+## 2. 架构概览
+
+```
+┌─────────────────────────────────────────────────────┐
+│                    Pika Server                       │
+├─────────────────────────────────────────────────────┤
+│  Client Request → RaftManager → PikaRaftNode        │
+│                                    ↓                 │
+│                              braft::Node             │
+│                                    ↓                 │
+│                           PikaStateMachine          │
+│                                    ↓                 │
+│                         Storage::OnBinlogWrite()    │
+│                                    ↓                 │
+│                              RocksDB                 │
+└─────────────────────────────────────────────────────┘
+```
+
+## 3. 核心组件
+
+| 组件 | 文件 | 职责 |
+|------|------|------|
+| `RaftManager` | [praft.h](../src/praft/include/praft/praft.h) | 管理多个 Raft 节点（每个 DB 一个） |
+| `PikaRaftNode` | [praft.h](../src/praft/include/praft/praft.h) | 封装 braft::Node，提供日志追加接口 |
+| `PikaStateMachine` | [praft.cc](../src/praft/src/praft.cc) | 实现状态机，处理日志应用和快照 |
+| `PPosixFileSystemAdaptor` | [psnapshot.cc](../src/praft/src/psnapshot.cc) | 快照文件系统适配器 |
+
+## 4. 数据流
+
+### 写入流程
+1. 客户端发送写命令
+2. Storage 层构建 Binlog（Protobuf 格式）
+3. 通过 `PikaRaftNode::AppendLog()` 提交到 Raft
+4. braft 复制日志到多数节点
+5. 提交后 `PikaStateMachine::on_apply()` 被调用
+6. 调用 `Storage::OnBinlogWrite()` 写入 RocksDB
+
+### Binlog 格式
+
+定义在 [binlog.proto](../src/praft/src/binlog.proto)：
+- 支持数据类型：Strings, Hashes, Lists, Sets, ZSets, Streams
+- 操作类型：Put, Delete
+
+## 5. 快照机制
+
+- 使用 RocksDB Checkpoint 创建快照
+- 快照恢复点基于 `GetSmallestFlushedLogIndex()`
+- 通过 `LogIndexOfColumnFamilies` 追踪各 CF 的日志应用进度
+
+## 6. 配置选项
+
+| 配置项 | 默认值 | 说明 |
+|--------|--------|------|
+| `raft_enabled` | false | 是否启用 Raft |
+| `raft_group_id` | "" | Raft Group ID |
+| `raft_election_timeout_ms` | 1000 | 选举超时(ms) |
+| `raft_snapshot_interval_s` | 3600 | 快照间隔(s) |
+
+## 7. Review 重点
+
+### 正确性
+- **日志幂等性**: `IsApplied()` 检查是否已应用，防止重复应用
+- **快照一致性**: 使用最小 flushed_log_index 确定快照点
+- **WAL 禁用**: Raft 日志提供持久性保证，RocksDB WAL 被禁用
+
+### 性能
+- 同步写入等待 Raft 提交（可优化为批量提交）
+- Binlog 使用 Protobuf 序列化
+
+### 线程安全
+- `LogIndexOfColumnFamilies` 使用 mutex 保护
+- braft 保证 `on_apply()` 顺序调用
+
+## 8. 关键代码位置
+
+| 功能 | 文件 |
+|------|------|
+| 日志应用 | [praft.cc](../src/praft/src/praft.cc) - `on_apply()` |
+| Binlog 处理 | [storage.cc](../src/storage/src/storage.cc) - `OnBinlogWrite()` |
+| Log Index 追踪 | [log_index.cc](../src/storage/src/log_index.cc) |
+| 快照创建 | [psnapshot.cc](../src/praft/src/psnapshot.cc) |
+| Raft 命令 | [pika_raft.cc](../src/pika_raft.cc) |

include/pika_db.h

@@ -94,6 +94,8 @@ class DB : public std::enable_shared_from_this<DB>, public pstd::noncopyable {
   std::shared_ptr<storage::Storage> storage() const;
   void GetBgSaveMetaData(std::vector<std::string>* fileNames, std::string* snapshot_uuid);
   void BgSaveDB();
+  pstd::Status CreateCheckpoint(const std::string& checkpoint_dir);
+  pstd::Status LoadDBFromCheckpoint(const std::string& checkpoint_dir);
   void SetBinlogIoError();
   void SetBinlogIoErrorrelieve();
   bool IsBinlogIoError();

include/pika_server.h

@@ -71,6 +71,8 @@ enum TaskType {
   kCompactRangeSets,
   kCompactRangeZSets,
   kCompactRangeList,
+  kLoadDBFromCheckpoint,
+  kCreateCheckpoint,
 };
 
 struct TaskArg {

src/pika_db.cc

@@ -67,6 +67,75 @@ void DB::BgSaveDB() {
   g_pika_server->BGSaveTaskSchedule(&DoBgSave, static_cast<void*>(bg_task_arg));
 }
 
+pstd::Status DB::CreateCheckpoint(const std::string& checkpoint_dir) {
+  std::string checkpoint_sub_path = checkpoint_dir;
+  if (!checkpoint_sub_path.empty() && checkpoint_sub_path.back() != '/') {
+    checkpoint_sub_path.push_back('/');
+  }
+  checkpoint_sub_path += db_name_;
+
+  if (!pstd::FileExists(checkpoint_sub_path)) {
+    if (pstd::CreatePath(checkpoint_sub_path, 0755) != 0) {
+      return Status::IOError("Failed to create checkpoint path", checkpoint_sub_path);
+    }
+  }
+
+  std::shared_lock guard(dbs_rw_);
+  auto tasks = storage_->CreateCheckpoint(checkpoint_sub_path);
+  for (auto& task : tasks) {
+    auto status = task.get();
+    if (!status.ok()) {
+      return Status::Corruption("Create checkpoint failed: " + status.ToString());
+    }
+  }
+  return Status::OK();
+}
+
+pstd::Status DB::LoadDBFromCheckpoint(const std::string& checkpoint_dir) {
+  std::string checkpoint_sub_path = checkpoint_dir;
+  if (!checkpoint_sub_path.empty() && checkpoint_sub_path.back() != '/') {
+    checkpoint_sub_path.push_back('/');
+  }
+  checkpoint_sub_path += db_name_;
+
+  if (!pstd::FileExists(checkpoint_sub_path)) {
+    return Status::NotFound("Checkpoint dir does not exist: " + checkpoint_sub_path);
+  }
+
+  std::lock_guard<std::shared_mutex> guard(dbs_rw_);
+  opened_ = false;
+
+  auto old_storage = storage_;
+  storage_.reset();
+  if (old_storage) {
+    old_storage->Close();
+  }
+
+  storage_ = std::make_shared<storage::Storage>();
+  auto checkpoint_tasks = storage_->LoadCheckpoint(checkpoint_sub_path, db_path_);
+  for (auto& task : checkpoint_tasks) {
+    auto status = task.get();
+    if (!status.ok()) {
+      storage_.reset();
+      return Status::Corruption("Load checkpoint failed: " + status.ToString());
+    }
+  }
+
+  storage::StorageOptions storage_options = g_pika_server->storage_options();
+  auto open_status = storage_->Open(storage_options, db_path_);
+  if (!open_status.ok()) {
+    storage_.reset();
+    return Status::Corruption("Storage open failed: " + open_status.ToString());
+  }
+
+  if (!g_pika_conf->raft_enabled()) {
+    storage_->DisableWal(false);
+  }
+
+  opened_ = true;
+  return Status::OK();
+}
+
 void DB::SetBinlogIoError() { return binlog_io_error_.store(true); }
 void DB::SetBinlogIoErrorrelieve() { return binlog_io_error_.store(false); }
 bool DB::IsBinlogIoError() { return binlog_io_error_.load(); }

src/pika_server.cc

@@ -497,6 +497,37 @@ Status PikaServer::DoSameThingSpecificDB(const std::set<std::string>& dbs, const
       case TaskType::kCompactRangeList:
         db_item.second->CompactRange(storage::DataType::kLists, arg.argv[0], arg.argv[1]);
         break;
+      case TaskType::kLoadDBFromCheckpoint: {
+        // arg.argv[0] should contain checkpoint_path
+        if (arg.argv.empty()) {
+          LOG(ERROR) << "LoadDBFromCheckpoint requires checkpoint_path argument";
+          return Status::InvalidArgument("Missing checkpoint_path");
+        }
+        std::string checkpoint_path = arg.argv[0];
+        auto s = db_item.second->LoadDBFromCheckpoint(checkpoint_path);
+        if (!s.ok()) {
+          LOG(ERROR) << "Failed to load DB from checkpoint: " << s.ToString();
+          return s;
+        }
+        LOG(INFO) << "Successfully loaded DB " << db_item.first << " from checkpoint: " << checkpoint_path;
+        break;
+      }
+      case TaskType::kCreateCheckpoint: {
+        // arg.argv[0] should contain checkpoint_path
+        if (arg.argv.empty()) {
+          LOG(ERROR) << "CreateCheckpoint requires checkpoint_path argument";
+          return Status::InvalidArgument("Missing checkpoint_path");
+        }
+        std::string checkpoint_path = arg.argv[0];
+        auto s = db_item.second->CreateCheckpoint(checkpoint_path);
+        if (!s.ok()) {
+          LOG(ERROR) << "Failed to create checkpoint: " << s.ToString();
+          return s;
+        }
+        LOG(INFO) << "Successfully created checkpoint for DB " << db_item.first << " at: " << checkpoint_path;
+        break;
+      }
+      
       default:
         break;
     }