Fix mem leak

Author: haochengxia

libCacheSim/cache/eviction/3LCache/ThreeLCache.cpp

@@ -145,7 +145,6 @@ void ThreeLCacheCache::erase_out_cache() {
         }
       }
       key_map.erase(meta._key);
-      meta.free();
     }
     out_cache.metas.pop_front();
     out_cache.front_index++;

libCacheSim/cache/eviction/3LCache/ThreeLCache.hpp

@@ -46,6 +46,10 @@ struct MetaExtra {
     _past_distances = vector<int32_t>(1, distance);
   }
 
+  MetaExtra(const MetaExtra &other)
+      : _past_distances(other._past_distances),
+        _past_distance_idx(other._past_distance_idx) {}
+
   void update(const int32_t &distance) {
     uint8_t distance_idx = _past_distance_idx % max_n_past_distances;
     if (_past_distances.size() < max_n_past_distances)
@@ -77,13 +81,38 @@ class Meta {
     _sample_times = 0;
   }
 
-  virtual ~Meta() = default;
+  // deep copy
+  Meta(const Meta &other)
+      : _key(other._key),
+        _size(other._size),
+        _past_timestamp(other._past_timestamp),
+        _freq(other._freq),
+        _sample_times(other._sample_times) {
+    if (other._extra) {
+      _extra = new MetaExtra(*other._extra);
+    }
+  }
+
+  // copy assignment operator
+  Meta &operator=(const Meta &other) {
+    if (this != &other) {
+      _key = other._key;
+      _size = other._size;
+      _past_timestamp = other._past_timestamp;
+      _freq = other._freq;
+      _sample_times = other._sample_times;
+      if (_extra) delete _extra;
+      _extra = other._extra ? new MetaExtra(*other._extra) : nullptr;
+    }
+    return *this;
+  }
+
+  ~Meta() { delete _extra; }
 
   void emplace_sample(uint64_t &sample_t, uint8_t max_num = 1) {
     if (_sample_times == 0) _sample_times = sample_t;
   }
 
-  void free() { delete _extra; }
   void update(const uint64_t &past_timestamp) {
     if (max_n_past_distances > 0) {
       int32_t _distance = past_timestamp - _past_timestamp;
@@ -386,6 +415,13 @@ class ThreeLCacheCache : public webcachesim::Cache {
     }
     return distribution;
   }
+
+  ~ThreeLCacheCache() {
+    if (evcition_distribution) free(evcition_distribution);
+    if (object_distribution_n_eviction) free(object_distribution_n_eviction);
+    if (training_data) delete training_data;
+    if (booster) LGBM_BoosterFree(booster);
+  }
 };
 
 }  // namespace ThreeLCache

libCacheSim/cache/eviction/3LCache/ThreeLCache_Interface.cpp

@@ -90,6 +90,11 @@ cache_t *ThreeLCache_init(const common_cache_params_t ccache_params,
   ThreeLCache_params_t *params = my_malloc(ThreeLCache_params_t);
   cache->eviction_params = params;
 
+  // init
+  params->ThreeLCache_cache = nullptr;
+  params->objective = nullptr;
+  params->to_evict_pair = std::make_pair(0, 0);
+
   ThreeLCache_parse_params(cache, DEFAULT_PARAMS);
   if (cache_specific_params != NULL) {
     ThreeLCache_parse_params(cache, cache_specific_params);
@@ -130,6 +135,7 @@ static void ThreeLCache_free(cache_t *cache) {
   free(cache->to_evict_candidate);
   if (params->objective != NULL) {
     free(params->objective);
+    params->objective = NULL;
   }
   my_free(sizeof(ThreeLCache_params_t), params);
   cache_struct_free(cache);
@@ -326,7 +332,7 @@ static void ThreeLCache_parse_params(cache_t *cache,
                                      const char *cache_specific_params) {
   ThreeLCache_params_t *params = (ThreeLCache_params_t *)cache->eviction_params;
   char *params_str = strdup(cache_specific_params);
-  char *end;
+  char *original_params_str = params_str;  // preserve the original pointer
 
   while (params_str != NULL && params_str[0] != '\0') {
     /* different parameters are separated by comma,
@@ -342,6 +348,7 @@ static void ThreeLCache_parse_params(cache_t *cache,
     if (strcasecmp(key, "objective") == 0) {
       if (params->objective != NULL) {
         free(params->objective);
+        params->objective = NULL;
       }
       params->objective = strdup(value);
       if (params->objective == NULL) {
@@ -350,13 +357,15 @@ static void ThreeLCache_parse_params(cache_t *cache,
     } else if (strcasecmp(key, "print") == 0) {
       printf("current parameters: %s\n",
              ThreeLCache_current_params(cache, params));
+      free(original_params_str);
       exit(0);
     } else {
       ERROR("%s does not have parameter %s\n", cache->cache_name, key);
+      free(original_params_str);
       exit(1);
     }
   }
-  free(params_str);
+  free(original_params_str);
 }
 #ifdef __cplusplus
 }

libCacheSim/cache/eviction/LRB/LRB_Interface.cpp

@@ -320,7 +320,7 @@ static void LRB_parse_params(cache_t *cache,
                              const char *cache_specific_params) {
   LRB_params_t *params = (LRB_params_t *)cache->eviction_params;
   char *params_str = strdup(cache_specific_params);
-  char *end;
+  char *original_params_str = params_str;  // preserve the original pointer
 
   while (params_str != NULL && params_str[0] != '\0') {
     /* different parameters are separated by comma,
@@ -343,13 +343,15 @@ static void LRB_parse_params(cache_t *cache,
       }
     } else if (strcasecmp(key, "print") == 0) {
       printf("current parameters: %s\n", LRB_current_params(cache, params));
+      free(original_params_str);
       exit(0);
     } else {
       ERROR("%s does not have parameter %s\n", cache->cache_name, key);
+      free(original_params_str);
       exit(1);
     }
   }
-  free(params_str);
+  free(original_params_str);
 }
 #ifdef __cplusplus
 }

test/CMakeLists.txt

@@ -66,8 +66,3 @@ add_test(NAME testUtils COMMAND testUtils WORKING_DIRECTORY .)
 #     target_link_libraries(testGLCache ${all_modules} ${dependency_libs})
 #     add_test(NAME testGLCache COMMAND testGLCache WORKING_DIRECTORY .)
 # endif (ENABLE_GLCACHE)
-
-if (ENABLE_3L_CACHE)
-   add_test_executable(test3LCache test_3lcache.c)
-   add_test(NAME test3LCache COMMAND test3LCache WORKING_DIRECTORY .)
-endif (ENABLE_3L_CACHE)

test/common.h

@@ -101,20 +101,18 @@ static reader_t *setup_GLCacheTestData_reader(void) {
 
 static reader_t *setup_3LCacheTestData_reader(void) {
   const char *url =
-      "https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/cacheDatasets/"
-      "tencentBlock/"
-      "tencentBlock.ns3964.oracleGeneral.zst";
+      "https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/"
+      ".w68.oracleGeneral.bin.zst";
   int ret = system(
-      "if [ ! -f tencentBlock.ns3964.oracleGeneral.zst ]; then wget "
-      "https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/cacheDatasets/"
-      "tencentBlock/"
-      "tencentBlock.ns3964.oracleGeneral.zst; fi");
+      "if [ ! -f .w68.oracleGeneral.bin.zst ]; then wget "
+      "https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/"
+      ".w68.oracleGeneral.bin.zst; fi");
   if (ret != 0) {
     ERROR("downloading data failed\n");
   }
 
-  reader_t *reader_oracle = setup_reader(
-      "tencentBlock.ns3964.oracleGeneral.zst", ORACLE_GENERAL_TRACE, NULL);
+  reader_t *reader_oracle =
+      setup_reader(".w68.oracleGeneral.bin.zst", ORACLE_GENERAL_TRACE, NULL);
   return reader_oracle;
 }
 

test/test_3lcache.c

@@ -104,7 +104,7 @@ static void test_admission_algorithm(gconstpointer user_data,
                            test_data->miss_byte_true);
 
   cache->cache_free(cache);
-  my_free(sizeof(cache_stat_t), res);
+  my_free(sizeof(cache_stat_t) * (CACHE_SIZE / STEP_SIZE), res);
 }
 
 // Individual test functions (ordered alphabetically)

test/test_admissionAlgo.c

@@ -195,7 +195,17 @@ static const cache_test_data_t test_data_truth[] = {
      .req_byte_true = 4368040448,
      .miss_cnt_true = {90043, 83978, 81482, 77727, 72611, 72059, 67836, 65739},
      .miss_byte_true = {4068758016, 3792818176, 3639756288, 3379609600,
-                        3165339648, 3058814976, 2862775296, 2774183936}}};
+                        3165339648, 3058814976, 2862775296, 2774183936}},
+#if defined(ENABLE_3L_CACHE) && ENABLE_3L_CACHE == 1
+    {.cache_name = "3LCache",
+     .hashpower = 20,
+     .req_cnt_true = 113872,
+     .req_byte_true = 4368040448,
+     .miss_cnt_true = {93374, 89783, 83572, 81722, 72494, 72104, 71972, 71704},
+     .miss_byte_true = {4214303232, 4061242368, 3778040320, 3660569600,
+                        3100927488, 3078128640, 3075403776, 3061662720}},
+#endif /* ENABLE_3L_CACHE */
+};
 
 static void _verify_profiler_results(const cache_stat_t *res,
                                      uint64_t num_of_sizes,
@@ -255,7 +265,7 @@ static void test_cache_algorithm(gconstpointer user_data,
                            test_data->miss_byte_true);
 
   cache->cache_free(cache);
-  my_free(sizeof(cache_stat_t), res);
+  my_free(sizeof(cache_stat_t) * (CACHE_SIZE / STEP_SIZE), res);
 }
 
 // Individual test functions (ordered alphabetically)
@@ -364,6 +374,12 @@ static void test_SR_LRU(gconstpointer user_data) {
   test_cache_algorithm(user_data, &test_data_truth[24]);
 }
 
+#if defined(ENABLE_3L_CACHE) && ENABLE_3L_CACHE == 1
+static void test_3LCache(gconstpointer user_data) {
+  test_cache_algorithm(user_data, &test_data_truth[25]);
+}
+#endif /* ENABLE_3L_CACHE */
+
 static void test_WTinyLFU(gconstpointer user_data) {
   // TODO: to be implemented
 }
@@ -414,6 +430,10 @@ int main(int argc, char *argv[]) {
   g_test_add_data_func("/libCacheSim/cacheAlgo_SLRU", reader, test_SLRU);
   g_test_add_data_func("/libCacheSim/cacheAlgo_SR_LRU", reader, test_SR_LRU);
 
+#if defined(ENABLE_3L_CACHE) && ENABLE_3L_CACHE == 1
+  g_test_add_data_func("/libCacheSim/cacheAlgo_3LCache", reader, test_3LCache);
+#endif /* ENABLE_3L_CACHE */
+
   // Belady algorithms require reader that has next access information
   // and can only use oracleGeneral trace (which we're using)
   g_test_add_data_func("/libCacheSim/cacheAlgo_Belady", reader, test_Belady);

test/test_evictionAlgo.c

@@ -101,7 +101,7 @@ static void test_prefetch_algorithm(gconstpointer user_data,
                            test_data->miss_byte_true);
 
   cache->cache_free(cache);
-  my_free(sizeof(cache_stat_t), res);
+  my_free(sizeof(cache_stat_t) * (CACHE_SIZE / STEP_SIZE), res);
 }
 
 // Individual test functions (ordered alphabetically)