Implement Raft protocol to replicate KV pairs

.vscode/launch.json

@@ -4,6 +4,105 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "rr - RaftMain",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/RaftMain",
+            "miDebuggerServerAddress": "localhost:50505",
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "externalConsole": true,
+            "linux": {
+                "MIMode": "gdb",
+                "setupCommands": [
+                    {
+                        "description": "Setup to resolve symbols",
+                        "text": "set sysroot /",
+                        "ignoreFailures": false
+                    }
+                ]
+            },
+            "osx": {
+                "MIMode": "gdb"
+            },
+            "windows": {
+                "MIMode": "gdb"
+            }
+        },
+        {
+            "name": "Debug - RaftMain",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/RaftMain", // Path to the compiled executable
+            "args": [
+                "--id",
+                "1",
+                "--nodes",
+                "0.0.0.0:8080,0.0.0.0:8081,0.0.0.0:8082"
+            ], // Arguments to pass to the program
+            "stopAtEntry": false, // Set to true to stop at the program's entry point
+            "cwd": "${workspaceFolder}", // Current working directory
+            "environment": [],
+            "externalConsole": false, // Set to true if you want to use an external terminal
+            "MIMode": "gdb", // Use "lldb" if you're using clang on macOS
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ],
+            "preLaunchTask": "build", // Ensure your program is built before launching
+            "miDebuggerPath": "/usr/bin/gdb", // Path to the gdb or lldb debugger
+            "logging": {
+                "trace": true, // Enable trace for debugging the launch.json config
+                "traceResponse": true,
+                "engineLogging": false
+            },
+            "launchCompleteCommand": "exec-run",
+            "targetArchitecture": "x86_64",
+            "pipeTransport": {
+                "pipeCwd": "",
+                "pipeProgram": "/bin/bash",
+                "pipeArgs": [
+                    "-c"
+                ],
+                "debuggerPath": "/usr/bin/gdb"
+            },
+        },
+        {
+            "name": "Debug Attach - RaftMain",
+            "type": "cppdbg",
+            "request": "attach",
+            "program": "${workspaceFolder}/build/RaftMain", // Path to the compiled executable
+            "processId": "${command:pickProcess}",
+            "MIMode": "gdb", // Use "lldb" if you're using clang on macOS
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ],
+            "preLaunchTask": "build", // Ensure your program is built before launching
+            "miDebuggerPath": "/usr/bin/gdb", // Path to the gdb or lldb debugger
+            "logging": {
+                "trace": true, // Enable trace for debugging the launch.json config
+                "traceResponse": true,
+                "engineLogging": false
+            },
+            "targetArchitecture": "x86_64",
+            "pipeTransport": {
+                "pipeCwd": "",
+                "pipeProgram": "/bin/bash",
+                "pipeArgs": [
+                    "-c"
+                ],
+                "debuggerPath": "/usr/bin/gdb"
+            },
+        },
         {
             "name": "Debug - LSMTreeTest",
             "type": "cppdbg",
@@ -84,7 +183,7 @@
             "args": [
                 "-c",
                 "./assets/tkvpp_config.json"
-            ], // Arguments to pass to the program
+            ],
             "stopAtEntry": false, // Set to true to stop at the program's entry point
             "cwd": "${workspaceFolder}", // Current working directory
             "environment": [],

CMakeLists.txt

@@ -7,8 +7,22 @@ set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED On)
 set(CMAKE_CXX_EXTENSIONS Off)
 
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -pedantic-errors")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic-errors")
+set(TINYKVPP_COMMON_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -pedantic-errors")
+set(TINYKVPP_COMMON_CXX_FLAGS
+    "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic-errors")
+
+message("Using compiler: ${CMAKE_CXX_COMPILER_ID}")
+
+# CFLAGS="-fsanitize=thread -g -O1" CXXFLAGS="-fsanitize=thread -g -O1"
+# LDFLAGS="-fsanitize=thread"
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+  set(CMAKE_C_FLAGS "${TINYKVPP_COMMON_C_FLAGS} -Wthread-safety")
+  set(CMAKE_CXX_FLAGS "${TINYKVPP_COMMON_CXX_FLAGS} -Wthread-safety")
+else()
+  set(CMAKE_C_FLAGS "${TINYKVPP_COMMON_C_FLAGS}")
+  set(CMAKE_CXX_FLAGS "${TINYKVPP_COMMON_CXX_FLAGS}")
+endif()
 
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}")
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}")
@@ -27,6 +41,7 @@ find_package(absl CONFIG REQUIRED)
 find_package(Celero CONFIG REQUIRED)
 find_package(protobuf CONFIG REQUIRED)
 find_package(gRPC CONFIG REQUIRED)
+find_package(GTest CONFIG REQUIRED)
 
 include_directories(lib)
 
@@ -36,12 +51,12 @@ add_subdirectory(bench)
 add_subdirectory(examples)
 
 # Custom targets to build docker images and run tests
-add_custom_target(GCCReleaseDockerImage
-    COMMAND sh scripts/build_gcc_release_docker_image.sh
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-)
-
-add_custom_target(ClangReleaseDockerImage
-    COMMAND sh scripts/build_clang_release_docker_image.sh
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-)
+add_custom_target(
+  GCCReleaseDockerImage
+  COMMAND sh scripts/build_gcc_release_docker_image.sh
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
+
+add_custom_target(
+  ClangReleaseDockerImage
+  COMMAND sh scripts/build_clang_release_docker_image.sh
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})

conan/profiles/debug-clang

@@ -7,6 +7,5 @@ arch=x86_64
 build_type=Debug
 compiler=clang
 compiler.cppstd=23
-compiler.libcxx=libstdc++11
-compiler.version=18
+compiler.version=19
 os=Linux

conan/profiles/debug-clang-tsan

@@ -10,7 +10,5 @@ arch=x86_64
 build_type=Debug
 compiler=clang
 compiler.cppstd=23
-compiler.libcxx=libstdc++11
-compiler.version=18
+compiler.version=19
 os=Linux
-

conan/profiles/debug-gcc

@@ -6,7 +6,7 @@ CXX=/usr/local/bin/g++
 arch=x86_64
 build_type=Debug
 compiler=gcc
-compiler.cppstd=gnu23
 compiler.libcxx=libstdc++11
+compiler.cppstd=gnu23
 compiler.version=13
 os=Linux

conan/profiles/release-clang

@@ -7,6 +7,5 @@ arch=x86_64
 build_type=Release
 compiler=clang
 compiler.cppstd=23
-compiler.libcxx=libstdc++11
-compiler.version=18
+compiler.version=19
 os=Linux

conan/profiles/release-gcc

@@ -6,7 +6,7 @@ CXX=/usr/local/bin/g++
 arch=x86_64
 build_type=Release
 compiler=gcc
-compiler.cppstd=gnu23
+compiler.cppstd=23
 compiler.libcxx=libstdc++11
 compiler.version=13
 os=Linux

conanfile.txt

@@ -11,6 +11,7 @@ abseil/20240116.2
 celero/2.9.0
 protobuf/5.27.0
 grpc/1.67.1
+gtest/1.15.0
 
 [tool_requires]
 protobuf/5.27.0

examples/CMakeLists.txt

@@ -3,3 +3,4 @@ project(zkv)
 
 add_subdirectory(absl)
 add_subdirectory(embedded)
+add_subdirectory(raft)

examples/raft/CMakeLists.txt

@@ -0,0 +1,15 @@
+cmake_minimum_required(VERSION 3.25)
+project(zkv)
+
+add_executable(RaftMain "main.cpp" "raft.cpp")
+set_target_properties(RaftMain PROPERTIES CXX_STANDARD 23)
+target_link_libraries(RaftMain PRIVATE DB RaftProtoObjects TKVProtoObjects)
+
+add_executable(RaftTest "raft_test.cpp" "raft.cpp")
+set_target_properties(RaftTest PROPERTIES CXX_STANDARD 23)
+target_link_libraries(RaftTest gtest::gtest DB
+                      RaftProtoObjects TKVProtoObjects)
+
+# Register Catch2 tests with CTest
+# include(Catch)
+# catch_discover_tests(RaftTest)

examples/raft/main.cpp

@@ -0,0 +1,84 @@
+#include <grpcpp/server.h>
+#include <grpcpp/security/credentials.h>
+
+#include "raft.h"
+
+#include <cxxopts.hpp>
+
+#include <spdlog/spdlog.h>
+
+#include <csignal>
+
+std::condition_variable gCv;
+
+static void signalHandler(int sig)
+{
+    if (sig == SIGTERM || sig == SIGINT)
+    {
+        gCv.notify_all();
+    }
+}
+
+auto main(int argc, char *argv[]) -> int
+{
+    std::signal(SIGTERM, signalHandler);
+    std::signal(SIGINT, signalHandler);
+
+    cxxopts::Options options("raft");
+    options.add_options()("id", "id of the node", cxxopts::value<id_t>())(
+        "nodes", "ip addresses of replicas in a correct order", cxxopts::value<std::vector<raft::ip_t>>());
+
+    auto parsedOptions = options.parse(argc, argv);
+    if ((parsedOptions.count("help") != 0U) || (parsedOptions.count("id") == 0U) ||
+        (parsedOptions.count("nodes") == 0U))
+    {
+        spdlog::info("{}", options.help());
+        return EXIT_SUCCESS;
+    }
+
+    auto nodeId = parsedOptions["id"].as<id_t>();
+    if (nodeId == 0)
+    {
+        spdlog::error("ID of the node should be positve integer");
+        return EXIT_FAILURE;
+    }
+
+    auto nodeIps = parsedOptions["nodes"].as<std::vector<raft::ip_t>>();
+    if (nodeIps.empty())
+    {
+        spdlog::error("List of node IPs can't be empty");
+        return EXIT_FAILURE;
+    }
+
+    std::vector<raft::raft_node_grpc_client_t> replicas;
+    for (raft::id_t replicaId{1}; const auto &replicaIp : nodeIps)
+    {
+        if (replicaId != nodeId)
+        {
+            std::unique_ptr<RaftService::Stub> stub{
+                RaftService::NewStub(grpc::CreateChannel(replicaIp, grpc::InsecureChannelCredentials()))};
+
+            replicas.emplace_back(raft::node_config_t{.m_id = replicaId, .m_ip = replicaIp}, std::move(stub));
+        }
+
+        ++replicaId;
+    }
+
+    raft::consensus_module_t consensusModule({.m_id = nodeId, .m_ip = nodeIps[nodeId - 1]}, std::move(replicas));
+    if (!consensusModule.init())
+    {
+        spdlog::error("Failed to initialize the state machine");
+        return EXIT_FAILURE;
+    }
+
+    spdlog::set_level(spdlog::level::debug);
+    consensusModule.start();
+
+    std::mutex                   mtx;
+    std::unique_lock<std::mutex> lock(mtx);
+    gCv.wait(lock);
+
+    consensusModule.stop();
+
+    return EXIT_SUCCESS;
+}