[refactor]: simplify logging (#223)

* refactor logging

Refactor logging levels by removing VVERBOSE and adjusting log level definitions. Update logging calls throughout the codebase to use VERBOSE instead of VVERBOSE for consistency and clarity.

* allow code-quality to run on other branches (#222)

* Refactor CMakeLists.txt to improve logging level handling

Updated the logic for setting default log levels based on the build type. Removed redundant checks and streamlined the configuration for log levels, ensuring appropriate defaults are set for both Debug and Release builds. This enhances clarity and maintainability of the build configuration.

* fix format and cmake default level

* Update libCacheSim/traceReader/sampling/SHARD.c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update CMakeLists.txt

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix

* letter case normalize for build

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 1a1a11a

.github/workflows/code-quality.yml

@@ -1,10 +1,6 @@
 name: Code Quality
 
-on:
-  push:
-    branches: [ main, master, develop ]
-  pull_request:
-    branches: [ main, master, develop ]
+on: [push, pull_request]
 
 jobs:
   code-quality:

CMakeLists.txt

@@ -25,8 +25,8 @@ option(SUPPORT_TTL "whether support TTL" OFF)
 option(OPT_SUPPORT_ZSTD_TRACE "whether support zstd trace" ON)
 option(ENABLE_LRB "enable LRB" OFF)
 option(ENABLE_3L_CACHE "enable 3LCache" OFF)
-set(LOG_LEVEL NONE CACHE STRING "change the logging level")
-set_property(CACHE LOG_LEVEL PROPERTY STRINGS INFO WARN ERROR DEBUG VERBOSE VVERBOSE VVVERBOSE)
+set(LOG_LEVEL "default" CACHE STRING "change the logging level")
+set_property(CACHE LOG_LEVEL PROPERTY STRINGS ERROR WARN INFO DEBUG VERBOSE DEFAULT)
 
 # Platform detection
 if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
@@ -41,20 +41,6 @@ else()
     message(FATAL_ERROR "unsupported operating system ${CMAKE_SYSTEM_NAME}")
 endif()
 
-if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Release)
-
-    if(LOG_LEVEL STREQUAL "NONE")
-        set(LOG_LEVEL INFO)
-    endif()
-elseif(${CMAKE_BUILD_TYPE} MATCHES "Debug")
-    if(LOG_LEVEL STREQUAL "NONE")
-        set(LOG_LEVEL DEBUG)
-    endif()
-else()
-    set(LOG_LEVEL INFO)
-endif()
-
 configure_file(libCacheSim/include/config.h.in libCacheSim/include/config.h)
 
 if(SUPPORT_TTL)
@@ -65,12 +51,23 @@ if(USE_HUGEPAGE)
     add_compile_definitions(USE_HUGEPAGE=1)
 endif()
 
+if(NOT CMAKE_BUILD_TYPE)
+    # we can also consider RelWithDebInfo, but it will be too slow for release build
+    set(CMAKE_BUILD_TYPE Release)
+endif()
+
+
 string(TOLOWER "${LOG_LEVEL}" LOG_LEVEL_LOWER)
+string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LOWER)
 
-if(LOG_LEVEL_LOWER STREQUAL "vvverbose")
-    add_compile_definitions(LOGLEVEL=3)
-elseif(LOG_LEVEL_LOWER STREQUAL "vverbose")
-    add_compile_definitions(LOGLEVEL=4)
+if(LOG_LEVEL_LOWER STREQUAL "default")
+    if(CMAKE_BUILD_TYPE_LOWER MATCHES "Debug")
+        message(STATUS "LOG_LEVEL is not set, use DEBUG as default for debug build")
+        add_compile_definitions(LOGLEVEL=6)
+    else()
+        message(STATUS "LOG_LEVEL is not set, use INFO as default for release build")
+        add_compile_definitions(LOGLEVEL=7)
+    endif()
 elseif(LOG_LEVEL_LOWER STREQUAL "verbose")
     add_compile_definitions(LOGLEVEL=5)
 elseif(LOG_LEVEL_LOWER STREQUAL "debug")
@@ -81,15 +78,13 @@ elseif(LOG_LEVEL_LOWER STREQUAL "warn")
     add_compile_definitions(LOGLEVEL=8)
 elseif(LOG_LEVEL_LOWER STREQUAL "error")
     add_compile_definitions(LOGLEVEL=9)
-
-# default none is info
-elseif(LOG_LEVEL_LOWER STREQUAL "none")
-    add_compile_definitions(LOGLEVEL=7)
 else()
     message(WARNING "unknown log level ${LOG_LEVEL}, use INFO as default")
     add_compile_definitions(LOGLEVEL=7)
 endif()
 
+
+
 # Define shared compiler flags for all targets
 set(LIBCACHESIM_C_FLAGS 
     -Wall -Wextra -Werror 

libCacheSim/cache/admission/adaptsize/adaptsize.cpp

@@ -188,7 +188,7 @@ void Adaptsize::reconfigure() {
     total_obj_size += it->second.obj_size;
     ++it;
   }
-  VVERBOSE(
+  VERBOSE(
       "Reconfiguring over %zu objects - log2 total size %f log2 statsize %f\n",
       longterm_metadata.size(), log2(total_obj_size), log2(stat_size));
   // END Prepare for reconf
@@ -249,10 +249,10 @@ void Adaptsize::reconfigure() {
     WARN("BUG: NaN h1:%f h2:%f\n", h1, h2);
   } else if (h1 > h2) {
     c_param = pow(2, x1);
-    VVERBOSE("C = %f (log2: %f )\n", c_param, x1);
+    VERBOSE("C = %f (log2: %f )\n", c_param, x1);
   } else {
     c_param = pow(2, x2);
-    VVERBOSE("C = %f (log2: %f )\n", c_param, x2);
+    VERBOSE("C = %f (log2: %f )\n", c_param, x2);
   }
   // END Check for result
 }

libCacheSim/cache/cache.c

@@ -243,10 +243,10 @@ bool cache_get_base(cache_t *cache, const request_t *req) {
   }
 
   if (hit) {
-    VVERBOSE("req %ld, obj %ld --- cache hit\n", cache->n_req, req->obj_id);
+    VERBOSE("req %ld, obj %ld --- cache hit\n", cache->n_req, req->obj_id);
   } else if (!cache->can_insert(cache, req)) {
-    VVERBOSE("req %ld, obj %ld --- cache miss cannot insert\n", cache->n_req,
-             req->obj_id);
+    VERBOSE("req %ld, obj %ld --- cache miss cannot insert\n", cache->n_req,
+            req->obj_id);
   } else {
     while (cache->get_occupied_byte(cache) + req->obj_size +
                cache->obj_md_size >

libCacheSim/cache/eviction/GLCache/GLCache.c

@@ -397,8 +397,8 @@ static cache_obj_t *GLCache_insert(cache_t *cache, const request_t *req) {
 
     seg = allocate_new_seg(cache, bucket->bucket_id);
     append_seg_to_bucket(params, bucket, seg);
-    VVERBOSE("%lu allocate new seg, %d in use seg\n", cache->n_req,
-             params->n_in_use_segs);
+    VERBOSE("%lu allocate new seg, %d in use seg\n", cache->n_req,
+            params->n_in_use_segs);
   }
 
   cache_obj_t *cache_obj = &seg->objs[seg->n_obj];

libCacheSim/cache/eviction/GLCache/eviction.c

@@ -141,8 +141,8 @@ void GLCache_merge_segs(cache_t *cache, bucket_t *bucket, segment_t **segs) {
 // called when there is no segment can be merged due to fragmentation
 // different from clean_one_seg because this function also updates cache state
 int evict_one_seg(cache_t *cache, segment_t *seg) {
-  VVERBOSE("req %lu, evict one seg id %d occupied size %lu/%lu\n", cache->n_req,
-           seg->seg_id, cache->occupied_byte, cache->cache_size);
+  VERBOSE("req %lu, evict one seg id %d occupied size %lu/%lu\n", cache->n_req,
+          seg->seg_id, cache->occupied_byte, cache->cache_size);
   GLCache_params_t *params = cache->eviction_params;
   bucket_t *bucket = &params->buckets[seg->bucket_id];
 

libCacheSim/cache/eviction/LFU.c

@@ -192,8 +192,8 @@ static cache_obj_t *LFU_find(cache_t *cache, const request_t *req,
       memset(new_node, 0, sizeof(freq_node_t));
       new_node->freq = cache_obj->lfu.freq;
       g_hash_table_insert(params->freq_map, new_key, new_node);
-      VVVERBOSE("allocate new %ld %d %p %p\n", new_node->freq, new_node->n_obj,
-                new_node->first_obj, new_node->last_obj);
+      VERBOSE("allocate new %ld %d %p %p\n", new_node->freq, new_node->n_obj,
+              new_node->first_obj, new_node->last_obj);
     } else {
       // it could be new_node is empty
       DEBUG_ASSERT(new_node->freq == cache_obj->lfu.freq);

libCacheSim/cache/eviction/LFUDA.c

@@ -181,8 +181,8 @@ static cache_obj_t *LFUDA_find(cache_t *cache, const request_t *req,
       memset(new_node, 0, sizeof(freq_node_t));
       new_node->freq = cache_obj->lfu.freq;
       g_hash_table_insert(params->freq_map, new_key, new_node);
-      VVVERBOSE("allocate new %ld %d %p %p\n", new_node->freq, new_node->n_obj,
-                new_node->first_obj, new_node->last_obj);
+      VERBOSE("allocate new %ld %d %p %p\n", new_node->freq, new_node->n_obj,
+              new_node->first_obj, new_node->last_obj);
     } else {
       // it could be new_node is empty
       DEBUG_ASSERT(new_node->freq == cache_obj->lfu.freq);

libCacheSim/cache/eviction/LeCaR.c

@@ -288,7 +288,7 @@ static cache_obj_t *LeCaR_find(cache_t *cache, const request_t *req,
      * when remove_obj_from_freq_node */
     if (cache_obj->LeCaR.freq < params->min_freq) {
       params->min_freq = cache_obj->LeCaR.freq;
-      VVERBOSE("update min freq to %d\n", (int)params->min_freq);
+      VERBOSE("update min freq to %d\n", (int)params->min_freq);
     }
   }
 
@@ -312,7 +312,7 @@ static cache_obj_t *LeCaR_find(cache_t *cache, const request_t *req,
 cache_obj_t *LeCaR_insert(cache_t *cache, const request_t *req) {
   LeCaR_params_t *params = (LeCaR_params_t *)(cache->eviction_params);
 
-  VVERBOSE("insert object %lu into cache\n", (unsigned long)req->obj_id);
+  VERBOSE("insert object %lu into cache\n", (unsigned long)req->obj_id);
 
   // LRU and hash table insert
   cache_obj_t *cache_obj = cache_insert_base(cache, req);
@@ -652,8 +652,8 @@ static inline void update_LFU_min_freq(LeCaR_params_t *params) {
       break;
     }
   }
-  VVERBOSE("update LFU min freq from %ld to %ld\n", old_min_freq,
-           params->min_freq);
+  VERBOSE("update LFU min freq from %ld to %ld\n", old_min_freq,
+          params->min_freq);
   // if the object is the only object in the cache, we may have min_freq == 1
   DEBUG_ASSERT(params->min_freq > old_min_freq ||
                params->q_head == params->q_tail);
@@ -682,19 +682,19 @@ static inline void remove_obj_from_freq_node(LeCaR_params_t *params,
   DEBUG_ASSERT(freq_node != NULL);
   DEBUG_ASSERT(freq_node->freq == cache_obj->LeCaR.freq);
   DEBUG_ASSERT(freq_node->n_obj > 0);
-  VVERBOSE("remove object from freq node %p (freq %ld, %u obj)\n", freq_node,
-           freq_node->freq, freq_node->n_obj);
+  VERBOSE("remove object from freq node %p (freq %ld, %u obj)\n", freq_node,
+          freq_node->freq, freq_node->n_obj);
   freq_node->n_obj--;
 
   if (cache_obj == freq_node->first_obj) {
-    VVVERBOSE("remove object from freq node --- object is the first object\n");
+    VERBOSE("remove object from freq node --- object is the first object\n");
     freq_node->first_obj = cache_obj->LeCaR.lfu_next;
     if (cache_obj->LeCaR.lfu_next != NULL)
       ((cache_obj_t *)(cache_obj->LeCaR.lfu_next))->LeCaR.lfu_prev = NULL;
   }
 
   if (cache_obj == freq_node->last_obj) {
-    VVVERBOSE("remove object from freq node --- object is the last object\n");
+    VERBOSE("remove object from freq node --- object is the last object\n");
     freq_node->last_obj = cache_obj->LeCaR.lfu_prev;
     if (cache_obj->LeCaR.lfu_prev != NULL)
       ((cache_obj_t *)(cache_obj->LeCaR.lfu_prev))->LeCaR.lfu_next = NULL;
@@ -787,7 +787,7 @@ static void verify_ghost_lru_integrity(cache_t *cache, LeCaR_params_t *params) {
     cur = cur->queue.next;
   }
 
-  VVVERBOSE(
+  VERBOSE(
       "ghost entry head %p tail %p, "
       "ghost_entry_size from scan = %ld,"
       "lru_g_occupied_byte = %ld\n ",

libCacheSim/include/libCacheSim/const.h

@@ -39,13 +39,11 @@ extern "C" {
 #define MAGENTA "\x1B[35m"
 #define CYAN "\x1B[36m"
 
-#define VVVERBOSE_LEVEL 3
-#define VVERBOSE_LEVEL 4
 #define VERBOSE_LEVEL 5
 #define DEBUG_LEVEL 6
 #define INFO_LEVEL 7
 #define WARN_LEVEL 8
-#define SEVERE_LEVEL 9
+#define ERROR_LEVEL 9
 
 // this is correct, to change to this, need to update test
 #define KiB 1024LL