[opt] Share Infra implementation and unify status codes (#399)

mag1c-h · FangRun2 · web-flow · commit 4efe8f57af94 · 2025-11-24T10:24:13.000+08:00
share infra module

Co-authored-by: Fang Run &lt;Fang_Run@126.com&gt;
diff --git a/ucm/shared/CMakeLists.txt b/ucm/shared/CMakeLists.txt
@@ -1,3 +1,4 @@
 add_subdirectory(vendor)
+add_subdirectory(infra)
 add_subdirectory(trans)
 add_subdirectory(test)
diff --git a/ucm/shared/infra/CMakeLists.txt b/ucm/shared/infra/CMakeLists.txt
@@ -0,0 +1,22 @@
+file(GLOB_RECURSE UCMINFRA_STATUS_SOURCE_FILES "status/*.*")
+add_library(infra_status OBJECT ${UCMINFRA_STATUS_SOURCE_FILES})
+target_include_directories(infra_status PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(infra_status PUBLIC fmt)
+
+file(GLOB UCMINFRA_LOGGER_SOURCE_FILES "logger/*.*")
+file(GLOB_RECURSE UCMINFRA_LOGGER_DETAIL_SOURCE_FILES "logger/${LOGGER_BACKEND}/*.cc")
+add_library(infra_logger OBJECT ${UCMINFRA_LOGGER_SOURCE_FILES} ${UCMINFRA_LOGGER_DETAIL_SOURCE_FILES})
+target_include_directories(infra_logger PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(infra_logger PUBLIC fmt spdlog)
+
+file(GLOB_RECURSE UCMINFRA_TEMPLATE_SOURCE_FILES "template/*.*")
+add_library(infra_template OBJECT ${UCMINFRA_TEMPLATE_SOURCE_FILES})
+target_include_directories(infra_template PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+
+file(GLOB_RECURSE UCMINFRA_THREAD_SOURCE_FILES "thread/*.*")
+add_library(infra_thread OBJECT ${UCMINFRA_THREAD_SOURCE_FILES})
+target_include_directories(infra_thread PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+
+file(GLOB_RECURSE UCMINFRA_TIME_SOURCE_FILES "time/*.*")
+add_library(infra_time OBJECT ${UCMINFRA_TIME_SOURCE_FILES})
+target_include_directories(infra_time PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
diff --git a/ucm/shared/infra/logger/flux/flux_logger.cc b/ucm/shared/infra/logger/flux/flux_logger.cc
diff --git a/ucm/shared/infra/logger/logger.h b/ucm/shared/infra/logger/logger.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_LOGGER_H
-#define UNIFIEDCACHE_LOGGER_H
+#ifndef UNIFIEDCACHE_INFRA_LOGGER_H
+#define UNIFIEDCACHE_INFRA_LOGGER_H
 
 #include <cstddef>
 #include <fmt/format.h>
diff --git a/ucm/shared/infra/logger/spdlog/spdlog_logger.cc b/ucm/shared/infra/logger/spdlog/spdlog_logger.cc
diff --git a/ucm/shared/infra/status/status.h b/ucm/shared/infra/status/status.h
@@ -21,34 +21,70 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_TRANS_STATUS_H
-#define UNIFIEDCACHE_TRANS_STATUS_H
+#ifndef UNIFIEDCACHE_INFRA_STATUS_H
+#define UNIFIEDCACHE_INFRA_STATUS_H
 
+#include <cstdint>
 #include <fmt/format.h>
 #include <string>
 
-namespace UC::Trans {
+namespace UC {
+
+template <int32_t i>
+static inline constexpr int32_t __MakeStatusCode()
+{
+    return -50000 - i;
+}
 
 class Status {
     static constexpr int32_t OK_ = 0;
     static constexpr int32_t ERROR_ = -1;
+    static constexpr int32_t EPARAM_ = __MakeStatusCode<0>();
+    static constexpr int32_t EOOM_ = __MakeStatusCode<1>();
+    static constexpr int32_t EOSERROR_ = __MakeStatusCode<2>();
+    static constexpr int32_t EDUPLICATE_ = __MakeStatusCode<3>();
+    static constexpr int32_t ERETRY_ = __MakeStatusCode<4>();
+    static constexpr int32_t ENOOBJ_ = __MakeStatusCode<5>();
+    static constexpr int32_t ESERIALIZE_ = __MakeStatusCode<6>();
+    static constexpr int32_t EDESERIALIZE_ = __MakeStatusCode<7>();
+    static constexpr int32_t EUNSUPPORTED_ = __MakeStatusCode<8>();
+    static constexpr int32_t ENOSPACE_ = __MakeStatusCode<9>();
     int32_t code_;
     std::string message_;
     explicit Status(int32_t code) : code_(code) {}
 
 public:
     bool operator==(const Status& other) const noexcept { return code_ == other.code_; }
     bool operator!=(const Status& other) const noexcept { return !(*this == other); }
-    std::string ToString() const { return fmt::format("({}) {}", code_, message_); }
+    int32_t Underlying() const { return code_; }
+    std::string ToString() const
+    {
+        auto str = std::to_string(code_);
+        if (message_.empty()) { return str; }
+        return fmt::format("{}, {}", str, message_);
+    }
     constexpr bool Success() const noexcept { return code_ == OK_; }
     constexpr bool Failure() const noexcept { return !Success(); }
 
 public:
     Status(int32_t code, std::string message) : code_{code}, message_{std::move(message)} {}
     static Status OK() { return Status{OK_}; }
     static Status Error(std::string message) { return {ERROR_, std::move(message)}; }
+    static Status Error() { return Status{ERROR_}; }
+    static Status InvalidParam() { return Status{EPARAM_}; }
+    static Status OutOfMemory() { return Status{EOOM_}; }
+    static Status OsApiError() { return Status{EOSERROR_}; }
+    static Status DuplicateKey() { return Status{EDUPLICATE_}; }
+    static Status Retry() { return Status{ERETRY_}; }
+    static Status NotFound() { return Status{ENOOBJ_}; }
+    static Status SerializeFailed() { return Status{ESERIALIZE_}; }
+    static Status DeserializeFailed() { return Status{EDESERIALIZE_}; }
+    static Status Unsupported() { return Status{EUNSUPPORTED_}; }
+    static Status NoSpace() { return Status{ENOSPACE_}; }
 };
 
-} // namespace UC::Trans
+inline std::string format_as(const Status& status) { return status.ToString(); }
+
+} // namespace UC
 
 #endif
diff --git a/ucm/shared/infra/template/hashset.h b/ucm/shared/infra/template/hashset.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_HASHSET_H
-#define UNIFIEDCACHE_HASHSET_H
+#ifndef UNIFIEDCACHE_INFRA_HASHSET_H
+#define UNIFIEDCACHE_INFRA_HASHSET_H
 
 #include <array>
 #include <atomic>
diff --git a/ucm/shared/infra/template/singleton.h b/ucm/shared/infra/template/singleton.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_SINGLETON_H
-#define UNIFIEDCACHE_SINGLETON_H
+#ifndef UNIFIEDCACHE_INFRA_SINGLETON_H
+#define UNIFIEDCACHE_INFRA_SINGLETON_H
 
 namespace UC {
 
diff --git a/ucm/shared/infra/template/timer.h b/ucm/shared/infra/template/timer.h
@@ -21,61 +21,58 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_TIMER_H
-#define UNIFIEDCACHE_TIMER_H
+#ifndef UNIFIEDCACHE_INFRA_TIMER_H
+#define UNIFIEDCACHE_INFRA_TIMER_H
 
-#include <chrono>
-#include <thread>
-#include <mutex>
 #include <atomic>
+#include <chrono>
 #include <condition_variable>
-#include "logger/logger.h"
-#include "status/status.h"
+#include <mutex>
+#include <thread>
 
 namespace UC {
 
 template <typename Callable>
 class Timer {
 public:
     Timer(const std::chrono::seconds& interval, Callable&& callable)
-        : interval_(interval), callable_(callable), running_(false) {}
-    ~Timer() {
+        : interval_(interval), callable_(callable), running_(false)
+    {
+    }
+    ~Timer()
+    {
         {
             std::lock_guard<std::mutex> lg(this->mutex_);
             this->running_ = false;
+            this->cv_.notify_one();
         }
-        
-        this->cv_.notify_one();
         if (this->thread_.joinable()) { this->thread_.join(); }
     }
-    Status Start()
+    bool Start()
     {
         {
             std::lock_guard<std::mutex> lg(this->mutex_);
-            if (this->running_) { return Status::OK(); }
+            if (this->running_) { return true; }
         }
         try {
             this->running_ = true;
             this->thread_ = std::thread(&Timer::Runner, this);
-            return Status::OK();
-        } catch (const std::exception& e) {
-            UC_ERROR("Failed({}) to start timer.", e.what());
-            return Status::OutOfMemory();
+            return true;
+        } catch (...) {
+            return false;
         }
     }
 
 private:
     void Runner()
     {
         while (this->running_) {
-            try {
-                {
-                    std::unique_lock<std::mutex> lg(this->mutex_);
-                    this->cv_.wait_for(lg, this->interval_, [this] { return !this->running_; });
-                    if (!this->running_) { break; }
-                }
-                this->callable_();
-            } catch (const std::exception& e) { UC_ERROR("Failed({}) to run timer.", e.what()); }
+            {
+                std::unique_lock<std::mutex> lg(this->mutex_);
+                this->cv_.wait_for(lg, this->interval_, [this] { return !this->running_; });
+                if (!this->running_) { break; }
+            }
+            this->callable_();
         }
     }
 
@@ -88,6 +85,6 @@ class Timer {
     std::atomic<bool> running_;
 };
 
-} // namespace UC   
+} // namespace UC
 
-#endif
+#endif
diff --git a/ucm/shared/infra/template/topn_heap.h b/ucm/shared/infra/template/topn_heap.h
@@ -22,11 +22,12 @@
  * SOFTWARE.
  * */
 
-#ifndef UNIFIEDCACHE_TOP_N_HEAP_H
-#define UNIFIEDCACHE_TOP_N_HEAP_H
+#ifndef UNIFIEDCACHE_INFRA_TOP_N_HEAP_H
+#define UNIFIEDCACHE_INFRA_TOP_N_HEAP_H
 
 #include <algorithm>
 #include <cstdint>
+#include <functional>
 
 namespace UC {
 
@@ -117,4 +118,4 @@ class TopNFixedHeap : public TopNHeap<T, Compare> {
 
 } // namespace UC
 
-#endif
+#endif
diff --git a/ucm/shared/infra/thread/index_pool.h b/ucm/shared/infra/thread/index_pool.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_INDEX_POOL_H
-#define UNIFIEDCACHE_INDEX_POOL_H
+#ifndef UNIFIEDCACHE_INFRA_INDEX_POOL_H
+#define UNIFIEDCACHE_INFRA_INDEX_POOL_H
 
 #include <atomic>
 #include <cstddef>
diff --git a/ucm/shared/infra/thread/latch.h b/ucm/shared/infra/thread/latch.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_LATCH_H
-#define UNIFIEDCACHE_LATCH_H
+#ifndef UNIFIEDCACHE_INFRA_LATCH_H
+#define UNIFIEDCACHE_INFRA_LATCH_H
 
 #include <atomic>
 #include <condition_variable>
@@ -66,4 +66,4 @@ class Latch {
 
 } // namespace UC
 
-#endif // UNIFIEDCACHE_LATCH_H
+#endif // UNIFIEDCACHE_INFRA_LATCH_H
diff --git a/ucm/shared/infra/thread/thread_pool.h b/ucm/shared/infra/thread/thread_pool.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_THREAD_POOL_H
-#define UNIFIEDCACHE_THREAD_POOL_H
+#ifndef UNIFIEDCACHE_INFRA_THREAD_POOL_H
+#define UNIFIEDCACHE_INFRA_THREAD_POOL_H
 
 #include <condition_variable>
 #include <functional>
diff --git a/ucm/shared/infra/time/stopwatch.h b/ucm/shared/infra/time/stopwatch.h
@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  * */
-#ifndef UNIFIEDCACHE_STOPWATCH_H
-#define UNIFIEDCACHE_STOPWATCH_H
+#ifndef UNIFIEDCACHE_INFRA_STOPWATCH_H
+#define UNIFIEDCACHE_INFRA_STOPWATCH_H
 
 #include <chrono>
 
diff --git a/ucm/shared/test/case/infra/hashset_test.cc b/ucm/shared/test/case/infra/hashset_test.cc
diff --git a/ucm/shared/test/case/trans/trans_test.cc b/ucm/shared/test/case/trans/trans_test.cc
@@ -28,7 +28,7 @@ class UCTransUnitTest : public ::testing::Test {};
 
 TEST_F(UCTransUnitTest, CopyDataWithCE)
 {
-    const auto ok = UC::Trans::Status::OK();
+    const auto ok = UC::Status::OK();
     constexpr int32_t deviceId = 0;
     constexpr size_t size = 36 * 1024;
     constexpr size_t number = 64 * 61;
@@ -60,7 +60,7 @@ TEST_F(UCTransUnitTest, CopyDataWithCE)
 
 TEST_F(UCTransUnitTest, CopyDataWithSM)
 {
-    const auto ok = UC::Trans::Status::OK();
+    const auto ok = UC::Status::OK();
     constexpr int32_t deviceId = 0;
     constexpr size_t size = 36 * 1024;
     constexpr size_t number = 64 * 61;
diff --git a/ucm/shared/trans/CMakeLists.txt b/ucm/shared/trans/CMakeLists.txt
@@ -8,6 +8,7 @@ if(RUNTIME_ENVIRONMENT STREQUAL "simu")
     add_subdirectory(simu)
 endif()
 target_include_directories(trans PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/..)
+target_link_libraries(trans PUBLIC infra_status)
 
 file(GLOB_RECURSE UCMTRANS_CPY_SOURCE_FILES "./cpy/*.cc")
 pybind11_add_module(ucmtrans ${UCMTRANS_CPY_SOURCE_FILES})
diff --git a/ucm/shared/trans/buffer.h b/ucm/shared/trans/buffer.h
@@ -25,7 +25,7 @@
 #define UNIFIEDCACHE_TRANS_BUFFER_H
 
 #include <memory>
-#include "status.h"
+#include "status/status.h"
 
 namespace UC::Trans {
 
diff --git a/ucm/shared/trans/stream.h b/ucm/shared/trans/stream.h
@@ -25,7 +25,7 @@
 #define UNIFIEDCACHE_TRANS_STREAM_H
 
 #include <functional>
-#include "status.h"
+#include "status/status.h"
 
 namespace UC::Trans {
 
diff --git a/ucm/store/infra/CMakeLists.txt b/ucm/store/infra/CMakeLists.txt
@@ -1,21 +1,11 @@
 add_library(storeinfra STATIC)
 target_include_directories(storeinfra PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 file(GLOB_RECURSE UCMSTORE_COMMON_FILE_SOURCE_FILES "file/*.cc")
-if(LOGGER_BACKEND STREQUAL "spdlog")
-    file(GLOB_RECURSE UCMSTORE_COMMON_LOGGER_SOURCE_FILES "logger/spdlog/*.cc")
-endif()
-if(LOGGER_BACKEND STREQUAL "flux")
-    file(GLOB_RECURSE UCMSTORE_COMMON_LOGGER_SOURCE_FILES "logger/flux/*.cc")
-endif()
-file(GLOB_RECURSE UCMSTORE_COMMON_STATUS_SOURCE_FILES "status/*.cc")
-file(GLOB_RECURSE UCMSTORE_COMMON_TEMPLATE_SOURCE_FILES "template/*.cc")
-file(GLOB_RECURSE UCMSTORE_COMMON_THREAD_SOURCE_FILES "thread/*.cc")
 target_sources(storeinfra PRIVATE ${UCMSTORE_COMMON_FILE_SOURCE_FILES})
-target_sources(storeinfra PRIVATE ${UCMSTORE_COMMON_LOGGER_SOURCE_FILES})
-target_sources(storeinfra PRIVATE ${UCMSTORE_COMMON_STATUS_SOURCE_FILES})
-target_sources(storeinfra PRIVATE ${UCMSTORE_COMMON_TEMPLATE_SOURCE_FILES})
-target_sources(storeinfra PRIVATE ${UCMSTORE_COMMON_THREAD_SOURCE_FILES})
-target_link_libraries(storeinfra PUBLIC fmt)
-if(LOGGER_BACKEND STREQUAL "spdlog")
-    target_link_libraries(storeinfra PUBLIC spdlog)
-endif()
+target_link_libraries(storeinfra PUBLIC
+    infra_status
+    infra_logger
+    infra_template
+    infra_thread
+    infra_time
+)
diff --git a/ucm/store/infra/status/status.h b/ucm/store/infra/status/status.h
diff --git a/ucm/store/nfsstore/cc/domain/hotness/hotness_timer.h b/ucm/store/nfsstore/cc/domain/hotness/hotness_timer.h
diff --git a/ucm/store/pcstore/cc/domain/trans/trans_queue.cc b/ucm/store/pcstore/cc/domain/trans/trans_queue.cc
