Merge branch 'backup'

Author: gotorion

.github/workflows/cmake-single-platform.yml

@@ -21,6 +21,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
 
     - 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.

.gitignore

@@ -7,6 +7,8 @@
 *.o
 *.obj
 build
+.cache
+output
 
 # Precompiled Headers
 *.gch

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "third_party/abseil-cpp"]
 	path = third_party/abseil-cpp
 	url = [email protected]:abseil/abseil-cpp.git
+[submodule "third_party/tomlplusplus"]
+	path = third_party/tomlplusplus
+	url = [email protected]:marzer/tomlplusplus.git

CMakeLists.txt

@@ -2,4 +2,12 @@ cmake_minimum_required(VERSION 3.12)
 project(raft-kv)
 
 set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/output)
+
+add_subdirectory(third_party/abseil-cpp)
+get_property(targets DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY BUILDSYSTEM_TARGETS)
+message(STATUS "Avaiable CMake targets: ${targets}")
+add_subdirectory(third_party/spdlog)
+add_subdirectory(third_party/tomlplusplus)
+add_subdirectory(src)

README.md

@@ -1 +1,19 @@
-# raft-kv
+# raft-kv
+
+This project is just a learning project for Raft consensus algorithm and KV store. I do not want to implement all the details, so I just use lots of libraries to help me implement the project. The project is not production ready, but it can be used for learning and testing purposes.
+
+## Usage
+### Use protobuf
+
+```bash
+sudo pacman -S protobuf
+sudo pacman -S protobuf-c # cpp support
+protoc -cpp_out=. message.proto
+```
+
+### Use cmake
+
+```bash
+cmake -B build -G Ninja
+cmake --build build --parallel 16
+```

config/config.toml

@@ -0,0 +1,38 @@
+set(EXECUTABLE_NAME StorageNode)
+
+
+set(PRIVATE_INCLUDE_DIR
+        ${CMAKE_CURRENT_SOURCE_DIR}/db
+        ${CMAKE_CURRENT_SOURCE_DIR}/db/bitcask
+        ${CMAKE_CURRENT_SOURCE_DIR}/utils
+        ${CMAKE_CURRENT_SOURCE_DIR}/server
+        ${CMAKE_CURRENT_SOURCE_DIR}/server/proto
+)
+
+set(SOURCE_FILES
+        ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/db/bitcask/bitcask.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/server/net.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/proto/message.pb.cc
+)
+
+
+add_executable(${EXECUTABLE_NAME} ${SOURCE_FILES})
+
+target_include_directories(
+        ${EXECUTABLE_NAME}
+        PRIVATE
+        ${PRIVATE_INCLUDE_DIR}
+)
+
+find_package(Protobuf REQUIRED)
+
+target_link_libraries(
+        ${EXECUTABLE_NAME}
+        PRIVATE
+        spdlog::spdlog
+        tomlplusplus::tomlplusplus
+        protobuf::libprotobuf
+        absl::log_internal_check_op # dependency for protobuf
+)
+

src/CMakeLists.txt

@@ -0,0 +1,8 @@
+#pragma once
+#include "db.h"
+namespace db {
+class Bitcask final : public DbEngine {
+ public:
+ private:
+};
+}  // namespace db

src/db/bitcask/bitcask.cpp

@@ -0,0 +1,26 @@
+#pragma once
+#include <string>
+
+#include "absl/status/status.h"
+
+namespace db {
+
+using absl::Status;
+
+// define db engine interface for storage
+class DbEngine {
+ public:
+  using KeyType = std::string;  // KeyType & Value Type must can be ser & deser
+  using ValueType = std::string;
+  DbEngine(DbEngine&&) = delete;
+  DbEngine(DbEngine const&) = delete;
+  DbEngine& operator=(DbEngine const&) = delete;
+  DbEngine& operator=(DbEngine&&) = delete;
+  virtual ~DbEngine() = default;
+
+  virtual Status Set(KeyType const& key, ValueType const& value) = 0;
+  virtual Status Get(KeyType const& key, ValueType& value) = 0;
+  virtual Status Delete(KeyType const& key) = 0;
+};
+
+}  // namespace db