src/xbt/dict.cpp

   1 /* dict - a generic dictionary, variation over hash table                   */
   2
   3 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "xbt/dict.h"
   9 #include "dict_private.h"
  10 #include "simgrid/Exception.hpp"
  11 #include "xbt/ex.h"
  12 #include "xbt/log.h"
  13 #include "xbt/mallocator.h"
  14 #include "xbt/str.h"
  15 #include "xbt/string.hpp"
  16 #include "xbt/xbt_modinter.h"
  17
  18 #include <cstdio>
  19 #include <cstring>
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt, "Dictionaries provide the same functionalities as hash tables");
  22
  23 constexpr int MAX_FILL_PERCENT = 80;
  24
  25 /**
  26  * @brief Constructor
  27  * @param free_ctn function to call with (@a data as argument) when @a data is removed from the dictionary
  28  * @return pointer to the destination
  29  * @see xbt_dict_free()
  30  *
  31  * Creates and initialize a new dictionary with a default hashtable size.
  32  * The dictionary is homogeneous: each element share the same free function.
  33  */
  34 xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn)
  35 {
  36   xbt_dict_preinit();
  37
  38   xbt_dict_t dict;
  39
  40   dict = xbt_new(s_xbt_dict_t, 1);
  41   dict->free_f = free_ctn;
  42   dict->table_size = 127;
  43   dict->table = xbt_new0(xbt_dictelm_t, dict->table_size + 1);
  44   dict->count = 0;
  45   dict->fill = 0;
  46
  47   return dict;
  48 }
  49
  50 /**
  51  * @brief Destructor
  52  * @param dict the dictionary to be freed
  53  *
  54  * Frees a dictionary with all the data
  55  */
  56 void xbt_dict_free(xbt_dict_t * dict)
  57 {
  58   if (dict != nullptr && *dict != nullptr) {
  59     int table_size       = (*dict)->table_size;
  60     xbt_dictelm_t* table = (*dict)->table;
  61     /* Warning: the size of the table is 'table_size+1'...
  62      * This is because table_size is used as a binary mask in xbt_dict_rehash */
  63     for (int i = 0; (*dict)->count && i <= table_size; i++) {
  64       xbt_dictelm_t current = table[i];
  65       xbt_dictelm_t previous;
  66
  67       while (current != nullptr) {
  68         previous = current;
  69         current = current->next;
  70         xbt_dictelm_free(*dict, previous);
  71         (*dict)->count--;
  72       }
  73     }
  74     xbt_free(table);
  75     xbt_free(*dict);
  76     *dict = nullptr;
  77   }
  78 }
  79
  80 /** Returns the amount of elements in the dict */
  81 unsigned int xbt_dict_size(const_xbt_dict_t dict)
  82 {
  83   return (dict != nullptr ? static_cast<unsigned int>(dict->count) : static_cast<unsigned int>(0));
  84 }
  85
  86 /* Expend the size of the dict */
  87 static void xbt_dict_rehash(xbt_dict_t dict)
  88 {
  89   const unsigned oldsize = dict->table_size + 1;
  90   unsigned newsize = oldsize * 2;
  91
  92   auto* newtable = static_cast<xbt_dictelm_t*>(xbt_realloc((char*)dict->table, newsize * sizeof(xbt_dictelm_t)));
  93   memset(&newtable[oldsize], 0, oldsize * sizeof(xbt_dictelm_t)); /* zero second half */
  94   newsize--;
  95   dict->table_size = newsize;
  96   dict->table      = newtable;
  97   XBT_DEBUG("REHASH (%u->%u)", oldsize, newsize);
  98
  99   for (unsigned i = 0; i < oldsize; i++) {
 100     xbt_dictelm_t* currcell = &newtable[i];
 101     if (*currcell == nullptr) /* empty cell */
 102       continue;
 103
 104     xbt_dictelm_t *twincell = currcell + oldsize;
 105     xbt_dictelm_t *pprev = currcell;
 106     xbt_dictelm_t bucklet = *currcell;
 107     while (bucklet != nullptr) {
 108       /* Since we use "& size" instead of "%size" and since the size was doubled, each bucklet of this cell must either:
 109          - stay  in  cell i (ie, currcell)
 110          - go to the cell i+oldsize (ie, twincell) */
 111       if ((bucklet->hash_code & newsize) != i) {        /* Move to b */
 112         *pprev = bucklet->next;
 113         bucklet->next = *twincell;
 114         if (*twincell == nullptr)
 115           dict->fill++;
 116         *twincell = bucklet;
 117       } else {
 118         pprev = &bucklet->next;
 119       }
 120       bucklet = *pprev;
 121     }
 122
 123     if (*currcell == nullptr) /* everything moved */
 124       dict->fill--;
 125   }
 126 }
 127
 128 /**
 129  * @brief Add data to the dict (arbitrary key)
 130  * @param dict the container
 131  * @param key the key to set the new data
 132  * @param key_len the size of the @a key
 133  * @param data the data to add in the dict
 134  *
 135  * Set the @a data in the structure under the @a key, which can be any kind of data, as long as its length is provided
 136  * in @a key_len.
 137  */
 138 void xbt_dict_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data)
 139 {
 140   unsigned int hash_code = xbt_str_hash_ext(key, key_len);
 141
 142   xbt_dictelm_t current;
 143   xbt_dictelm_t previous = nullptr;
 144
 145   XBT_CDEBUG(xbt_dict, "ADD %.*s hash = %u, size = %d, & = %u", key_len, key, hash_code,
 146              dict->table_size, hash_code & dict->table_size);
 147   current = dict->table[hash_code & dict->table_size];
 148   while (current != nullptr && (hash_code != current->hash_code || key_len != current->key_len
 149           || memcmp(key, current->key, key_len))) {
 150     previous = current;
 151     current = current->next;
 152   }
 153
 154   if (current == nullptr) {
 155     /* this key doesn't exist yet */
 156     current = xbt_dictelm_new(key, key_len, hash_code, data);
 157     dict->count++;
 158     if (previous == nullptr) {
 159       dict->table[hash_code & dict->table_size] = current;
 160       dict->fill++;
 161       if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
 162         xbt_dict_rehash(dict);
 163     } else {
 164       previous->next = current;
 165     }
 166   } else {
 167     XBT_CDEBUG(xbt_dict, "Replace %.*s by %.*s under key %.*s",
 168                key_len, (char *) current->content, key_len, (char *) data, key_len, (char *) key);
 169     /* there is already an element with the same key: overwrite it */
 170     xbt_dictelm_set_data(dict, current, data);
 171   }
 172 }
 173
 174 /**
 175  * @brief Add data to the dict (null-terminated key)
 176  *
 177  * @param dict the dict
 178  * @param key the key to set the new data
 179  * @param data the data to add in the dict
 180  *
 181  * set the @a data in the structure under the @a key, which is a null terminated string.
 182  */
 183 void xbt_dict_set(xbt_dict_t dict, const char* key, void* data)
 184 {
 185   xbt_dict_set_ext(dict, key, strlen(key), data);
 186 }
 187
 188 /**
 189  * @brief Retrieve data from the dict (arbitrary key)
 190  *
 191  * @param dict the dealer of data
 192  * @param key the key to find data
 193  * @param key_len the size of the @a key
 194  * @return the data that we are looking for
 195  *
 196  * Search the given @a key. Returns nullptr when not found.
 197  */
 198 void* xbt_dict_get_or_null_ext(const_xbt_dict_t dict, const char* key, int key_len)
 199 {
 200   unsigned int hash_code = xbt_str_hash_ext(key, key_len);
 201   const s_xbt_dictelm* current = dict->table[hash_code & dict->table_size];
 202
 203   while (current != nullptr && (hash_code != current->hash_code || key_len != current->key_len
 204           || memcmp(key, current->key, key_len))) {
 205     current = current->next;
 206   }
 207
 208   if (current == nullptr)
 209     return nullptr;
 210
 211   return current->content;
 212 }
 213
 214 /**
 215  * @brief Retrieve data from the dict (null-terminated key)
 216  *
 217  * @param dict the dealer of data
 218  * @param key the key to find data
 219  * @return the data that we are looking for
 220  *
 221  * Search the given @a key. Returns nullptr when not found.
 222  */
 223 void* xbt_dict_get_or_null(const_xbt_dict_t dict, const char* key)
 224 {
 225   const s_xbt_dictelm* current = xbt_dict_get_elm_or_null(dict, key);
 226
 227   if (current == nullptr)
 228     return nullptr;
 229
 230   return current->content;
 231 }
 232
 233 /**
 234  * @brief Retrieve element from the dict (null-terminated key)
 235  *
 236  * @param dict the dealer of data
 237  * @param key the key to find data
 238  * @return the s_xbt_dictelm_t that we are looking for
 239  *
 240  * Search the given @a key. Returns nullptr when not found.
 241  */
 242 xbt_dictelm_t xbt_dict_get_elm_or_null(const_xbt_dict_t dict, const char* key)
 243 {
 244   unsigned int hash_code = xbt_str_hash(key);
 245   xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
 246
 247   while (current != nullptr && (hash_code != current->hash_code || strcmp(key, current->key)))
 248     current = current->next;
 249   return current;
 250 }
 251
 252 /**
 253  * @brief Remove data from the dict (arbitrary key)
 254  *
 255  * @param dict the trash can
 256  * @param key the key of the data to be removed
 257  * @param key_len the size of the @a key
 258  *
 259  * Remove the entry associated with the given @a key (throws std::out_of_range)
 260  */
 261 void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len)
 262 {
 263   unsigned int hash_code = xbt_str_hash_ext(key, key_len);
 264   xbt_dictelm_t previous = nullptr;
 265   xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
 266
 267   while (current != nullptr && (hash_code != current->hash_code || key_len != current->key_len
 268           || strncmp(key, current->key, key_len))) {
 269     previous = current;         /* save the previous node */
 270     current = current->next;
 271   }
 272
 273   if (current == nullptr)
 274     throw std::out_of_range(simgrid::xbt::string_printf("key %.*s not found", key_len, key));
 275   else {
 276     if (previous != nullptr) {
 277       previous->next = current->next;
 278     } else {
 279       dict->table[hash_code & dict->table_size] = current->next;
 280     }
 281   }
 282
 283   if (not dict->table[hash_code & dict->table_size])
 284     dict->fill--;
 285
 286   xbt_dictelm_free(dict, current);
 287   dict->count--;
 288 }
 289
 290 /**
 291  * @brief Return the number of elements in the dict.
 292  * @param dict a dictionary
 293  */
 294 int xbt_dict_length(const_xbt_dict_t dict)
 295 {
 296   return dict->count;
 297 }
 298
 299 /**
 300  * @brief test if the dict is empty or not
 301  */
 302 int xbt_dict_is_empty(const_xbt_dict_t dict)
 303 {
 304   return not dict || (xbt_dict_length(dict) == 0);
 305 }
 306
 307 /**
 308  * Create the dict mallocators.
 309  * This is an internal XBT function called during the lib initialization.
 310  * It can be used several times to recreate the mallocator, for example when you switch to MC mode
 311  */
 312 void xbt_dict_preinit()
 313 {
 314   if (dict_elm_mallocator == nullptr)
 315     dict_elm_mallocator = xbt_mallocator_new(256, dict_elm_mallocator_new_f, dict_elm_mallocator_free_f,
 316       dict_elm_mallocator_reset_f);
 317 }
 318
 319 /**
 320  * Destroy the dict mallocators.
 321  * This is an internal XBT function during the lib initialization
 322  */
 323 void xbt_dict_postexit()
 324 {
 325   if (dict_elm_mallocator != nullptr) {
 326     xbt_mallocator_free(dict_elm_mallocator);
 327     dict_elm_mallocator = nullptr;
 328   }
 329 }