Add process trace

Author: haochengxia

experiments/README.md

@@ -0,0 +1,15 @@
+
+
+## Datasets
+
+
+
+## Algos
+
+- LRU
+- ARC
+- TinyLFU
+- LRB
+- 2Q
+- 3LCache
+- S3FIFO

libCacheSim-python/libcachesim/__init__.pyi

@@ -39,7 +39,7 @@ def create_cache(
 def open_trace(
     trace_path: str,
     type: TraceType,
-    reader_init_param: dict | reader_init_param_t | None = None
+    ignore_obj_size: bool = False
 ) -> Reader: ...
 
 

libCacheSim-python/libcachesim/eviction.py

@@ -26,6 +26,10 @@ class EvictionPolicyBase(ABC):
     def get(self, req: Request) -> bool:
         pass
 
+    @abstractmethod
+    def process_trace(self, reader: Reader, max_requests: int = -1, max_seconds: int = -1, start_time: int = -1, end_time: int = -1) -> float:
+        pass
+
     @abstractmethod
     def __repr__(self) -> str:
         pass
@@ -43,13 +47,16 @@ def init_cache(self, cache_size: int, **kwargs) -> Cache:
     def get(self, req: Request) -> bool:
         return self.cache.get(req)
 
+    def process_trace(self, reader: Reader, max_requests: int = -1, max_seconds: int = -1, start_time: int = -1, end_time: int = -1) -> float:
+        return self.cache.process_trace(reader, max_requests, max_seconds, start_time, end_time)
+
     def __repr__(self):
         return f"{self.__class__.__name__}(cache_size={self.cache.cache_size})"
 
 
 class FIFO(EvictionPolicy):
     """First In First Out replacement policy.
-    
+
     Args:
         cache_size: Size of the cache
     """
@@ -59,7 +66,7 @@ def init_cache(self, cache_size: int, **kwargs) -> Cache:  # noqa: ARG002
 
 class Clock(EvictionPolicy):
     """Clock (Second Chance or FIFO-Reinsertion) replacement policy.
-    
+
     Args:
         cache_size: Size of the cache
         n_bit_counter: Number of bits for counter (default: 1)
@@ -78,7 +85,7 @@ def init_cache(self, cache_size: int, **kwargs):
         if init_freq < 0 or init_freq > 2**n_bit_counter - 1:
             msg = "init_freq must be between 0 and 2^n_bit_counter - 1"
             raise ValueError(msg)
-        
+
         self.init_freq = init_freq
         self.n_bit_counter = n_bit_counter
 
@@ -93,9 +100,9 @@ def __repr__(self):
 class TwoQ(EvictionPolicy):
     """2Q replacement policy.
 
-    2Q has three queues: Ain, Aout, Am. When a obj hits in Aout, it will be 
+    2Q has three queues: Ain, Aout, Am. When a obj hits in Aout, it will be
     inserted into Am otherwise it will be inserted into Ain.
-    
+
     Args:
         cache_size: Total size of the cache
         ain_size_ratio: Size ratio for Ain queue (default: 0.25)
@@ -125,11 +132,11 @@ def __repr__(self):
 
 class LRB(EvictionPolicy):
     """LRB (Learning Relaxed Belady) replacement policy.
-    
-    LRB is a learning-based replacement policy that uses a neural network to 
+
+    LRB is a learning-based replacement policy that uses a neural network to
     predict the future access patterns of the cache, randomly select one obj
     outside the Belady boundary to evict.
-    
+
     Args:
         cache_size: Size of the cache
         objective: Objective function to optimize (default: "byte-miss-ratio")
@@ -155,7 +162,7 @@ def __repr__(self):
 
 class LRU(EvictionPolicy):
     """Least Recently Used replacement policy.
-    
+
     Args:
         cache_size: Size of the cache
     """
@@ -167,10 +174,10 @@ class ARC(EvictionPolicy):
     """Adaptive Replacement Cache policy.
 
     ARC is a two-tiered cache with two LRU caches (T1 and T2) and two ghost
-    lists (B1 and B2). T1 records the obj accessed only once, T2 records 
-    the obj accessed more than once. ARC has an internal parameter `p` to 
+    lists (B1 and B2). T1 records the obj accessed only once, T2 records
+    the obj accessed more than once. ARC has an internal parameter `p` to
     learn and dynamically control the size of T1 and T2.
-    
+
     Args:
         cache_size: Size of the cache
     """
@@ -181,25 +188,25 @@ def init_cache(self, cache_size: int, **kwargs):  # noqa: ARG002
 class S3FIFO(EvictionPolicy):
     """S3FIFO replacement policy.
 
-    S3FIFO consists of three FIFO queues: Small, Main, and Ghost. Small 
+    S3FIFO consists of three FIFO queues: Small, Main, and Ghost. Small
     queue gets the obj and records the freq.
-    When small queue is full, if the obj to evict satisfies the threshold, 
-    it will be moved to main queue. Otherwise, it will be evicted from small 
+    When small queue is full, if the obj to evict satisfies the threshold,
+    it will be moved to main queue. Otherwise, it will be evicted from small
     queue and inserted into ghost queue.
-    When main queue is full, the obj to evict will be evicted and reinserted 
+    When main queue is full, the obj to evict will be evicted and reinserted
     like Clock.
     If obj hits in the ghost queue, it will be moved to main queue.
-    
+
     Args:
         cache_size: Size of the cache
         fifo_size_ratio: Size ratio for FIFO queue (default: 0.1)
         ghost_size_ratio: Size ratio for ghost queue (default: 0.9)
         move_to_main_threshold: Threshold for moving obj from ghost to main (default: 2)
     """
-    def __init__(self, cache_size: int, fifo_size_ratio: float = 0.1, 
+    def __init__(self, cache_size: int, fifo_size_ratio: float = 0.1,
                  ghost_size_ratio: float = 0.9, move_to_main_threshold: int = 2):
-        super().__init__(cache_size, fifo_size_ratio=fifo_size_ratio, 
-                         ghost_size_ratio=ghost_size_ratio, 
+        super().__init__(cache_size, fifo_size_ratio=fifo_size_ratio,
+                         ghost_size_ratio=ghost_size_ratio,
                          move_to_main_threshold=move_to_main_threshold)
 
     def init_cache(self, cache_size: int, **kwargs):
@@ -231,7 +238,7 @@ class Sieve(EvictionPolicy):
     """Sieve replacement policy.
 
     FIFO-Reinsertion with check pointer.
-    
+
     Args:
         cache_size: Size of the cache
     """
@@ -241,7 +248,7 @@ def init_cache(self, cache_size: int, **kwargs):  # noqa: ARG002
 
 class ThreeLCache(EvictionPolicy):
     """3L-Cache replacement policy.
-    
+
     Args:
         cache_size: Size of the cache
         objective: Objective function to optimize (default: "byte-miss-ratio")
@@ -267,7 +274,7 @@ def __repr__(self):
 
 class TinyLFU(EvictionPolicy):
     """TinyLFU replacement policy.
-    
+
     Args:
         cache_size: Size of the cache
         main_cache: Main cache to use (default: "SLRU")
@@ -292,4 +299,4 @@ def init_cache(self, cache_size: int, **kwargs):
     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})"
+               f"window_size={self.window_size})"