Skip to content

Fix incorrect comments for cache init #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1a1a11a merged 1 commit into from
Jun 22, 2025
Merged

Fix incorrect comments for cache init #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 37 additions & 19 deletions libCacheSim/cache/eviction/BeladySize.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ typedef struct {
// **** ****
// ***********************************************************************

static void BeladySize_parse_params(cache_t *cache, const char *cache_specific_params);
static void BeladySize_parse_params(cache_t *cache,
const char *cache_specific_params);
static void BeladySize_free(cache_t *cache);
static bool BeladySize_get(cache_t *cache, const request_t *req);
static cache_obj_t *BeladySize_find(cache_t *cache, const request_t *req, const bool update_cache);
static cache_obj_t *BeladySize_find(cache_t *cache, const request_t *req,
const bool update_cache);
static cache_obj_t *BeladySize_insert(cache_t *cache, const request_t *req);
static cache_obj_t *BeladySize_to_evict(cache_t *cache, const request_t *req);
static void BeladySize_evict(cache_t *cache, const request_t *req);
Expand All @@ -46,13 +48,16 @@ static void BeladySize_remove_obj(cache_t *cache, cache_obj_t *obj);
// ***********************************************************************

/**
* @brief initialize a Belady cache
* @brief initialize a BeladySize cache
*
* @param ccache_params some common cache parameters
* @param cache_specific_params Belady specific parameters, should be NULL
* @param cache_specific_params BeladySize specific parameters, see parse_params
* function or use -e "print" with the cachesim binary
*/
cache_t *BeladySize_init(const common_cache_params_t ccache_params, const char *cache_specific_params) {
cache_t *cache = cache_struct_init("BeladySize", ccache_params, cache_specific_params);
cache_t *BeladySize_init(const common_cache_params_t ccache_params,
const char *cache_specific_params) {
cache_t *cache =
cache_struct_init("BeladySize", ccache_params, cache_specific_params);

cache->cache_init = BeladySize_init;
cache->cache_free = BeladySize_free;
Expand All @@ -63,7 +68,8 @@ cache_t *BeladySize_init(const common_cache_params_t ccache_params, const char *
cache->remove = BeladySize_remove;
cache->to_evict = BeladySize_to_evict;

BeladySize_params_t *params = (BeladySize_params_t *)malloc(sizeof(BeladySize_params_t));
BeladySize_params_t *params =
(BeladySize_params_t *)malloc(sizeof(BeladySize_params_t));
cache->eviction_params = params;

BeladySize_parse_params(cache, DEFAULT_PARAMS);
Expand Down Expand Up @@ -103,7 +109,9 @@ static void BeladySize_free(cache_t *cache) {
* @param req
* @return true if cache hit, false if cache miss
*/
static bool BeladySize_get(cache_t *cache, const request_t *req) { return cache_get_base(cache, req); }
static bool BeladySize_get(cache_t *cache, const request_t *req) {
return cache_get_base(cache, req);
}

// ***********************************************************************
// **** ****
Expand All @@ -121,7 +129,8 @@ static bool BeladySize_get(cache_t *cache, const request_t *req) { return cache_
* and if the object is expired, it is removed from the cache
* @return the object or NULL if not found
*/
static cache_obj_t *BeladySize_find(cache_t *cache, const request_t *req, const bool update_cache) {
static cache_obj_t *BeladySize_find(cache_t *cache, const request_t *req,
const bool update_cache) {
cache_obj_t *obj = cache_find_base(cache, req, update_cache);

if (!update_cache) {
Expand Down Expand Up @@ -167,15 +176,18 @@ struct hash_iter_user_data {
uint64_t max_score;
};

static inline void hashtable_iter_Belady_size(cache_obj_t *cache_obj, void *userdata) {
struct hash_iter_user_data *iter_userdata = (struct hash_iter_user_data *)userdata;
static inline void hashtable_iter_Belady_size(cache_obj_t *cache_obj,
void *userdata) {
struct hash_iter_user_data *iter_userdata =
(struct hash_iter_user_data *)userdata;
if (iter_userdata->max_score == UINT64_MAX) return;

uint64_t obj_score;
if (cache_obj->Belady.next_access_vtime == -1)
obj_score = UINT64_MAX;
else
obj_score = cache_obj->obj_size * (cache_obj->Belady.next_access_vtime - iter_userdata->curr_vtime);
obj_score = cache_obj->obj_size * (cache_obj->Belady.next_access_vtime -
iter_userdata->curr_vtime);

if (obj_score > iter_userdata->max_score) {
iter_userdata->to_evict_obj = cache_obj;
Expand All @@ -199,7 +211,8 @@ static cache_obj_t *BeladySize_to_evict(cache_t *cache, const request_t *req) {
iter_userdata.max_score = 0;
iter_userdata.to_evict_obj = NULL;

hashtable_foreach(cache->hashtable, hashtable_iter_Belady_size, &iter_userdata);
hashtable_foreach(cache->hashtable, hashtable_iter_Belady_size,
&iter_userdata);

return iter_userdata.to_evict_obj;
}
Expand All @@ -212,7 +225,8 @@ static cache_obj_t *BeladySize_to_evict(cache_t *cache, const request_t *req) {
for (int i = 0; i < params->n_sample; i++) {
sampled_obj = hashtable_rand_obj(cache->hashtable);
sampled_obj_score =
log((double)sampled_obj->obj_size) + log((double)(sampled_obj->Belady.next_access_vtime - cache->n_req));
log((double)sampled_obj->obj_size) +
log((double)(sampled_obj->Belady.next_access_vtime - cache->n_req));
if (obj_to_evict_score < sampled_obj_score) {
obj_to_evict = sampled_obj;
obj_to_evict_score = sampled_obj_score;
Expand All @@ -222,10 +236,12 @@ static cache_obj_t *BeladySize_to_evict(cache_t *cache, const request_t *req) {
WARN(
"BeladySize_to_evict: obj_to_evict is NULL, "
"maybe cache size is too small or hash power too large, "
"current hash table size %lu, n_obj %lu, cache size %lu, request size %lu, and %d samples "
"current hash table size %lu, n_obj %lu, cache size %lu, request size "
"%lu, and %d samples "
"obj_to_evict_score %.4lf sampled_obj_score %.4lf\n",
hashsize(cache->hashtable->hashpower), cache->hashtable->n_obj, cache->cache_size, req->obj_size,
params->n_sample, obj_to_evict_score, sampled_obj_score);
hashsize(cache->hashtable->hashpower), cache->hashtable->n_obj,
cache->cache_size, req->obj_size, params->n_sample, obj_to_evict_score,
sampled_obj_score);
return BeladySize_to_evict(cache, req);
}

Expand Down Expand Up @@ -277,7 +293,8 @@ static const char *BeladySize_current_params(BeladySize_params_t *params) {
* to see the default parameters, use current_params()
* or use -e "print" with cachesim
*/
static void BeladySize_parse_params(cache_t *cache, const char *cache_specific_params) {
static void BeladySize_parse_params(cache_t *cache,
const char *cache_specific_params) {
BeladySize_params_t *params = (BeladySize_params_t *)cache->eviction_params;
char *params_str = strdup(cache_specific_params);
char *old_params_str = params_str;
Expand All @@ -303,7 +320,8 @@ static void BeladySize_parse_params(cache_t *cache, const char *cache_specific_p
printf("current parameters: %s\n", BeladySize_current_params(params));
exit(0);
} else {
ERROR("%s does not have parameter %s, support %s\n", cache->cache_name, key, BeladySize_current_params(params));
ERROR("%s does not have parameter %s, support %s\n", cache->cache_name,
key, BeladySize_current_params(params));
exit(1);
}
}
Expand Down
9 changes: 5 additions & 4 deletions libCacheSim/cache/eviction/FIFO.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,15 @@ static bool FIFO_remove(cache_t *cache, const obj_id_t obj_id);
// ***********************************************************************

/**
* @brief initialize a ARC cache
* @brief initialize a FIFO cache
*
* @param ccache_params some common cache parameters
* @param cache_specific_params ARC specific parameters, should be NULL
* @param cache_specific_params FIFO specific parameters, should be NULL
*/
cache_t *FIFO_init(const common_cache_params_t ccache_params,
const char *cache_specific_params) {
cache_t *cache = cache_struct_init("FIFO", ccache_params, cache_specific_params);
cache_t *cache =
cache_struct_init("FIFO", ccache_params, cache_specific_params);
cache->cache_init = FIFO_init;
cache->cache_free = FIFO_free;
cache->get = FIFO_get;
Expand Down Expand Up @@ -120,7 +121,7 @@ static bool FIFO_get(cache_t *cache, const request_t *req) {
* @return the object or NULL if not found
*/
static cache_obj_t *FIFO_find(cache_t *cache, const request_t *req,
const bool update_cache) {
const bool update_cache) {
return cache_find_base(cache, req, update_cache);
}

Expand Down
5 changes: 3 additions & 2 deletions libCacheSim/cache/eviction/SLRU.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ bool SLRU_get_debug(cache_t *cache, const request_t *req);
// **** ****
// ***********************************************************************
/**
* @brief initialize a LRU cache
* @brief initialize a SLRU cache
*
* @param ccache_params some common cache parameters
* @param cache_specific_params LRU specific parameters, should be NULL
* @param cache_specific_params SLRU specific parameters, see parse_params
* function or use -e "print" with the cachesim binary
*/
cache_t *SLRU_init(const common_cache_params_t ccache_params,
const char *cache_specific_params) {
Expand Down