itegrated multi-index lru to userver

Author: hzhdlrp

cmake/install/userver-multi-index-lru-config.cmake

@@ -0,0 +1,11 @@
+include_guard(GLOBAL)
+
+if(userver_multiindex_lru_FOUND)
+    return()
+endif()
+
+find_package(userver REQUIRED COMPONENTS core)
+
+find_package(Boost REQUIRED) 
+
+set(userver_multiindex_lru_FOUND TRUE)

cmake/modules/Findboost.cmake

@@ -0,0 +1,21 @@
+_userver_module_begin(
+    NAME
+    Boost
+    DEBIAN_NAMES
+    libboost-dev  
+    FORMULA_NAMES
+    boost
+    PACMAN_NAMES
+    boost
+    PKG_CONFIG_NAMES
+    boost
+)
+
+_userver_module_find_include(NAMES boost/version.hpp)
+
+_userver_module_end()
+
+if(NOT TARGET Boost::boost AND Boost_FOUND)
+    add_library(Boost::boost INTERFACE)
+    target_include_directories(Boost::boost INTERFACE ${Boost_INCLUDE_DIRS})
+endif()

libraries/CMakeLists.txt

@@ -2,11 +2,16 @@ option(USERVER_FEATURE_EASY "Build easy HTTP server library" "${USERVER_LIB_ENAB
 option(USERVER_FEATURE_S3API "Build S3 api client library" "${USERVER_LIB_ENABLED_DEFAULT}")
 option(USERVER_FEATURE_GRPC_REFLECTION "Build grpc reflection library" "${USERVER_LIB_ENABLED_DEFAULT}")
 option(USERVER_FEATURE_GRPC_PROTOVALIDATE "Build grpc protovalidate library" "OFF")
+option(USERVER_FEATURE_MULTI_INDEX_LRU "Build multi index lru library" "ON")
 
 if(USERVER_FEATURE_S3API)
     add_subdirectory(s3api)
 endif()
 
+if (USERVER_FEATURE_MULTI_INDEX_LRU)
+    add_subdirectory(multi_index_lru)
+endif()
+
 if(USERVER_FEATURE_EASY)
     if(NOT USERVER_FEATURE_POSTGRESQL)
         message(FATAL_ERROR "'USERVER_FEATURE_EASY' requires 'USERVER_FEATURE_POSTGRESQL=ON'")

libraries/multi_index_lru/CMakeLists.txt

@@ -0,0 +1,32 @@
+project(userver-multi-index-lru CXX)
+
+find_package(Boost REQUIRED) 
+
+
+if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/src/multi_index_lru.cpp")
+    file(WRITE "${CMAKE_CURRENT_SOURCE_DIR}/src/multi_index_lru.cpp"
+        "// MultiIndex LRU header-only lib\n"
+        "// This file exists only to satisfy CMake target requirements\n"
+        "namespace userver::lru_boost_list { const char* multi_index_lru_version = \"1.0\"; }\n")
+endif()
+
+userver_module(
+    multi-index-lru
+    SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}"
+    UTEST_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/tests/main.cpp"
+    DEPENDS core
+)
+
+target_include_directories(userver-multi-index-lru
+    PUBLIC ${Boost_INCLUDE_DIRS}
+)
+
+_userver_directory_install(
+    COMPONENT multi-index-lru
+    FILES "${USERVER_ROOT_DIR}/cmake/modules/Findboost.cmake"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/userver/modules"
+)
+
+# if(USERVER_FEATURE_UTEST)
+    add_subdirectory(tests)
+# endif()

lru_container/src/implements/examples/lru_list_container.h renamed to libraries/multi_index_lru/include/userver/multi_index_lru/implements/examples/lru_list_container.h

@@ -7,6 +7,8 @@
 #include <functional>
 #include <unordered_set>
 
+USERVER_NAMESPACE_BEGIN
+
 namespace lru_list {
 using namespace boost::multi_index;
 
@@ -177,4 +179,6 @@ class LRUCacheContainer_List {
 template<typename T>
 size_t ValueWithIdentificator<T>::id = 0;
 
-}
+}
+
+USERVER_NAMESPACE_END

lru_container/src/implements/examples/lru_time_index_container.h renamed to libraries/multi_index_lru/include/userver/multi_index_lru/implements/examples/lru_time_index_container.h

@@ -2,6 +2,8 @@
 
 #include <chrono>
 
+USERVER_NAMESPACE_BEGIN
+
 namespace lru_time_index {
 using namespace boost::multi_index;
 
@@ -138,4 +140,6 @@ class LRUCacheContainer_TimeIndex {
         }
     }
 };
-}
+}
+
+USERVER_NAMESPACE_END

lru_container/src/implements/actual/lru_boost_list_container.h renamed to libraries/multi_index_lru/include/userver/multi_index_lru/lru_boost_list_container.h

@@ -10,6 +10,8 @@
 #include <unordered_set>
 #include <iostream>
 
+USERVER_NAMESPACE_BEGIN
+
 namespace lru_boost_list {
 using namespace boost::multi_index;
 
@@ -69,7 +71,7 @@ template<
     typename IndexSpecifierList,
     typename Allocator = std::allocator<ValueWithHook<Value>>
 >
-class LRUCacheContainer_BoostList {
+class LRUCacheContainer {
 private:
     using CacheItem = ValueWithHook<Value>;
     using List =  boost::intrusive::list<
@@ -104,7 +106,7 @@ class LRUCacheContainer_BoostList {
     using value_type = Value;
     using cache_item_type = CacheItem;
 
-    LRUCacheContainer_BoostList(size_t max_size) : max_size(max_size) {}
+    LRUCacheContainer(size_t max_size) : max_size(max_size) {}
 
     template<typename... Args>
     bool emplace(Args&&... args) {
@@ -192,4 +194,6 @@ class LRUCacheContainer_BoostList {
         }
     }
 };
-}
+}
+
+USERVER_NAMESPACE_END

libraries/multi_index_lru/library.yaml

@@ -0,0 +1,9 @@
+project-name: userver-lib-multi-index-lru
+
+description: multi index lru cache
+
+maintainers:
+  - Common components
+
+libraries:
+  - userver-core

libraries/multi_index_lru/src/multi_index_lru.cpp

@@ -0,0 +1,3 @@
+// MultiIndex LRU header-only lib
+// This file exists only to satisfy CMake target requirements
+namespace userver::lru_boost_list { const char* multi_index_lru_version = "1.0"; }

libraries/multi_index_lru/tests/CMakeLists.txt

@@ -0,0 +1,33 @@
+project(multi-index-lru-tests)
+
+find_package(Boost REQUIRED)
+find_package(benchmark REQUIRED)
+
+file(GLOB_RECURSE MULTIINDEX_LRU_LIB_TESTS_SOURCES 
+    ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp 
+    ${CMAKE_CURRENT_SOURCE_DIR}/*.h
+)
+
+add_library(${PROJECT_NAME} STATIC ${MULTIINDEX_LRU_LIB_TESTS_SOURCES})
+target_link_libraries(${PROJECT_NAME} 
+    PUBLIC 
+        userver::multi-index-lru 
+        benchmark::benchmark 
+)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_20)
+add_executable(multi-index-lru-test-runner 
+    ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp  
+)
+
+target_link_libraries(multi-index-lru-test-runner 
+    PRIVATE
+        ${PROJECT_NAME}
+)
+
+_userver_directory_install(
+    COMPONENT multi-index-lru
+    DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/include/"
+    DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
+)
+
+_userver_install_targets(COMPONENT multi-index-lru TARGETS ${PROJECT_NAME})