Single process

Author: haochengxia

libCacheSim-python/libcachesim/__init__.py

@@ -21,6 +21,7 @@
     ThreeLCache,
     TinyLFU,
     TwoQ,
+    S4FIFO,
 )
 
 from .const import HF_CACHE_DIR
@@ -36,6 +37,7 @@
     "Clock",
     "Reader",
     "Request",
+    "S4FIFO",
     "Sieve",
     "ThreeLCache",
     "TinyLFU",

libCacheSim-python/libcachesim/__init__.pyi

@@ -132,6 +132,19 @@ def TwoQ_init(
     Create a TwoQ cache instance.
     """
 
+
+def S4FIFO_init(
+    cache_size: int,
+    small_size_ratio: float = 0.10,
+    ghost_size_ratio: float = 0.90,
+    move_to_main_threshold: int = 2,
+    small_skip_ratio: float = 0
+) -> Cache:
+    """
+    Create a S4FIFO cache instance.
+    """
+
+
 class reader_init_param_t:
     time_field: int
     obj_id_field: int
@@ -164,7 +177,6 @@ class Reader:
     def __iter__(self) -> Reader: ...
     def __next__(self) -> Request: ...
 
-
 # -----------------------------
 def get_trace_file_lists(trace_set_name: str) -> list[str]: ...
 def get_trace_file_path(trace_file_name: str) -> str: ...

libCacheSim-python/libcachesim/eviction.py

@@ -17,6 +17,7 @@
     ThreeLCache_init,
     TinyLFU_init,
     TwoQ_init,
+    S4FIFO_init,
 )
 
 
@@ -300,3 +301,27 @@ def __repr__(self):
         return f"{self.__class__.__name__}(cache_size={self.cache.cache_size}, " \
                f"main_cache={self.main_cache}, " \
                f"window_size={self.window_size})"
+
+
+class S4FIFO(EvictionPolicy):
+    """S4FIFO replacement policy.
+
+    Args:
+        cache_size: Size of the cache
+    """
+    def init_cache(self, cache_size: int, **kwargs):
+        small_size_ratio = kwargs.get('small_size_ratio', 0.10)
+        ghost_size_ratio = kwargs.get('ghost_size_ratio', 0.90)
+        move_to_main_threshold = kwargs.get('move_to_main_threshold', 2)
+        small_skip_ratio = kwargs.get('small_skip_ratio', 0)
+
+        if small_size_ratio <= 0 or ghost_size_ratio <= 0:
+            msg = "small_size_ratio and ghost_size_ratio must be greater than 0"
+            raise ValueError(msg)
+        if move_to_main_threshold < 0:
+            msg = "move_to_main_threshold must be greater or equal to 0"
+            raise ValueError(msg)
+        return S4FIFO_init(cache_size, small_size_ratio, ghost_size_ratio, move_to_main_threshold, small_skip_ratio)
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}(cache_size={self.cache.cache_size})"

libCacheSim-python/src/pylibcachesim.cpp

@@ -570,6 +570,31 @@ PYBIND11_MODULE(_libcachesim, m) {  // NOLINT(readability-named-parameter)
                 Cache: A new TwoQ cache instance.
       )pbdoc");
 
+    // S4FIFO
+    m.def(
+      "S4FIFO_init",
+      [](uint64_t cache_size, double small_size_ratio, double ghost_size_ratio, int move_to_main_threshold, double small_skip_ratio) {
+        common_cache_params_t cc_params = {.cache_size = cache_size};
+        cache_t* ptr = S4FIFO_init(cc_params, ("small-size-ratio=" + std::to_string(small_size_ratio) + "," +
+                                                "ghost-size-ratio=" + std::to_string(ghost_size_ratio) + "," +
+                                                "move-to-main-threshold=" + std::to_string(move_to_main_threshold) + "," +
+                                                "small-skip-ratio=" + std::to_string(small_skip_ratio))
+                                               .c_str());
+        return std::unique_ptr<cache_t, CacheDeleter>(ptr);
+      },
+      py::arg("cache_size"), py::arg("small_size_ratio") = 0.10,
+      py::arg("ghost_size_ratio") = 0.90, py::arg("move_to_main_threshold") = 2,
+      py::arg("small_skip_ratio") = 0,
+      R"pbdoc(
+            Create a S4FIFO cache instance.
+
+            Args:
+                cache_size (int): Size of the cache in bytes.
+                small_size_ratio (float): Ratio of small size to cache size (default: 0.10).
+                ghost_size_ratio (float): Ratio of ghost size to cache size (default: 0.90).
+                move_to_main_threshold (int): Threshold for moving to main queue (default: 2).
+      )pbdoc");
+
 #ifdef VERSION_INFO
   m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
 #else

libCacheSim/bin/cachesim/cache_init.h

@@ -67,6 +67,7 @@ static inline cache_t *create_cache(const char *trace_path,
       {"s3-fifo", S3FIFO_init},
       {"s3-fifov0", S3FIFOv0_init},
       {"s3fifo", S3FIFO_init},
+      {"s4fifo", S4FIFO_init},
       {"s3fifod", S3FIFOd_init},
       {"s3fifov0", S3FIFOv0_init},
       {"size", Size_init},

libCacheSim/cache/CMakeLists.txt

@@ -51,6 +51,7 @@ set(eviction_sources_c
         eviction/RandomLRU.c
         eviction/RandomTwo.c
         eviction/S3FIFO.c
+        eviction/S4FIFO.c
         eviction/Sieve.c
         eviction/Size.c
         eviction/SLRU.c
@@ -81,24 +82,24 @@ set(eviction_sources_cpp
 
 # LRB
 if (ENABLE_LRB)
-    set (eviction_sources_cpp ${eviction_sources_cpp} 
+    set (eviction_sources_cpp ${eviction_sources_cpp}
         eviction/LRB/lrb.cpp
         eviction/LRB/LRB_Interface.cpp
         )
 endif()
 
 # 3L Cache
 if (ENABLE_3L_CACHE)
-    set (eviction_sources_cpp ${eviction_sources_cpp} 
+    set (eviction_sources_cpp ${eviction_sources_cpp}
         eviction/3LCache/ThreeLCache_Interface.cpp
         eviction/3LCache/ThreeLCache.cpp
         )
 endif()
 
 # GLCache
 if (ENABLE_GLCACHE)
-    set(eviction_sources_c 
-        ${eviction_sources_c} 
+    set(eviction_sources_c
+        ${eviction_sources_c}
         eviction/GLCache/bucket.c
         eviction/GLCache/dataPrep.c
         eviction/GLCache/eviction.c

libCacheSim/include/libCacheSim/cacheObj.h

@@ -132,6 +132,12 @@ typedef struct {
   int32_t main_insert_freq;
 } S3FIFO_obj_metadata_t;
 
+typedef struct {
+  int64_t insertion_time;  // measured in number of objects inserted
+  int64_t freq;
+  int32_t main_insert_freq;
+} S4FIFO_obj_metadata_t;
+
 typedef struct {
   // int32_t freq;
   int lru_id;
@@ -158,6 +164,7 @@ typedef struct cache_obj {
     struct cache_obj *prev;
     struct cache_obj *next;
   } queue;  // for LRU, FIFO, etc.
+  int64_t time_stamp;
 #ifdef SUPPORT_TTL
   uint32_t exp_time;
 #endif
@@ -189,6 +196,7 @@ typedef struct cache_obj {
     QDLP_obj_metadata_t QDLP;
     LIRS_obj_metadata_t LIRS;
     S3FIFO_obj_metadata_t S3FIFO;
+    S4FIFO_obj_metadata_t S4FIFO;
     Sieve_obj_params_t sieve;
     CAR_obj_metadata_t CAR;
 

libCacheSim/include/libCacheSim/evictionAlgo.h

@@ -144,6 +144,9 @@ cache_t *S3FIFOd_init(const common_cache_params_t ccache_params,
 cache_t *S3FIFOv0_init(const common_cache_params_t ccache_params,
                        const char *cache_specific_params);
 
+cache_t *S4FIFO_init(const common_cache_params_t ccache_params,
+                     const char *cache_specific_params);
+
 cache_t *S3LRU_init(const common_cache_params_t ccache_params,
                     const char *cache_specific_params);
 

scripts/install_libcachesim.sh

@@ -7,6 +7,6 @@ DIR=$(dirname "${SOURCE}")
 cd "${DIR}"/../
 mkdir -p _build
 cd _build
-cmake -G Ninja ..
+cmake -G Ninja .. -DENABLE_LRB=ON
 ninja
 cd "${DIR}"

scripts/install_python.sh

@@ -7,7 +7,7 @@ pip install -r requirements.txt
 pip install pytest
 
 rm -rf ./build
-cmake -G Ninja -B build
+cmake -G Ninja -B build -DENABLE_3L_CACHE=on
 ninja -C build
 pushd libCacheSim-python
 pip install -e . -vvv