Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reduce the amount of implicit include directories
[simgrid.git] / src / xbt / dict.c
index 13b84d0..b486403 100644 (file)
@@ -1,20 +1,18 @@
 /* dict - a generic dictionary, variation over hash table                   */
 
-/* Copyright (c) 2004-2011. The SimGrid Team.
+/* Copyright (c) 2004-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#define DJB2_HASH_FUNCTION
-//#define FNV_HASH_FUNCTION
-
 #include <string.h>
 #include <stdio.h>
 #include "xbt/ex.h"
 #include "xbt/log.h"
 #include "xbt/mallocator.h"
-#include "xbt_modinter.h"
+#include "src/xbt_modinter.h"
+#include "xbt/str.h"
 #include "dict_private.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt,
@@ -105,95 +103,16 @@ XBT_INLINE unsigned int xbt_dict_size(xbt_dict_t dict)
   return (dict ? (unsigned int) dict->count : (unsigned int) 0);
 }
 
-/**
- * Returns the hash code of a string.
- */
-static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str,
-                                                 int str_len)
-{
-
-
-#ifdef DJB2_HASH_FUNCTION
-  /* fast implementation of djb2 algorithm */
-  int c;
-  register unsigned int hash = 5381;
-
-  while (str_len--) {
-    c = *str++;
-    hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
-  }
-# elif defined(FNV_HASH_FUNCTION)
-  register unsigned int hash = 0x811c9dc5;
-  unsigned char *bp = (unsigned char *) str;    /* start of buffer */
-  unsigned char *be = bp + str_len;     /* beyond end of buffer */
-
-  while (bp < be) {
-    /* multiply by the 32 bit FNV magic prime mod 2^32 */
-    hash +=
-        (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
-        (hash << 24);
-
-    /* xor the bottom with the current octet */
-    hash ^= (unsigned int) *bp++;
-  }
-
-# else
-  register unsigned int hash = 0;
-
-  while (str_len--) {
-    hash += (*str) * (*str);
-    str++;
-  }
-#endif
-
-  return hash;
-}
-
-static XBT_INLINE unsigned int xbt_dict_hash(const char *str)
-{
-#ifdef DJB2_HASH_FUNCTION
-  /* fast implementation of djb2 algorithm */
-  int c;
-  register unsigned int hash = 5381;
-
-  while ((c = *str++)) {
-    hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
-  }
-
-# elif defined(FNV_HASH_FUNCTION)
-  register unsigned int hash = 0x811c9dc5;
-
-  while (*str) {
-    /* multiply by the 32 bit FNV magic prime mod 2^32 */
-    hash +=
-        (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
-        (hash << 24);
-
-    /* xor the bottom with the current byte */
-    hash ^= (unsigned int) *str++;
-  }
-
-# else
-  register unsigned int hash = 0;
-
-  while (*str) {
-    hash += (*str) * (*str);
-    str++;
-  }
-#endif
-  return hash;
-}
-
 /* Expend the size of the dict */
 static void xbt_dict_rehash(xbt_dict_t dict)
 {
   const int oldsize = dict->table_size + 1;
-  register int newsize = oldsize * 2;
-  register int i;
-  register xbt_dictelm_t *currcell;
-  register xbt_dictelm_t *twincell;
-  register xbt_dictelm_t bucklet;
-  register xbt_dictelm_t *pprev;
+  int newsize = oldsize * 2;
+  int i;
+  xbt_dictelm_t *currcell;
+  xbt_dictelm_t *twincell;
+  xbt_dictelm_t bucklet;
+  xbt_dictelm_t *pprev;
 
   currcell =
       (xbt_dictelm_t *) xbt_realloc((char *) dict->table,
@@ -247,13 +166,14 @@ XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
                                  void *data, void_f_pvoid_t free_ctn)
 {
 
-  unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+  unsigned int hash_code = xbt_str_hash_ext(key, key_len);
 
   xbt_dictelm_t current, previous = NULL;
   xbt_assert(dict);
 
-  XBT_DEBUG("ADD %.*s hash = %u, size = %d, & = %u", key_len, key, hash_code,
-         dict->table_size, hash_code & dict->table_size);
+  XBT_CDEBUG(xbt_dict,
+             "ADD %.*s hash = %u, size = %d, & = %u", key_len, key, hash_code,
+             dict->table_size, hash_code & dict->table_size);
   current = dict->table[hash_code & dict->table_size];
   while (current != NULL &&
          (hash_code != current->hash_code || key_len != current->key_len
@@ -275,9 +195,9 @@ XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
       previous->next = current;
     }
   } else {
-    XBT_DEBUG("Replace %.*s by %.*s under key %.*s",
-           key_len, (char *) current->content,
-           key_len, (char *) data, key_len, (char *) key);
+    XBT_CDEBUG(xbt_dict, "Replace %.*s by %.*s under key %.*s",
+               key_len, (char *) current->content,
+               key_len, (char *) data, key_len, (char *) key);
     /* there is already an element with the same key: overwrite it */
     xbt_dictelm_set_data(dict, current, data, free_ctn);
   }
@@ -318,7 +238,7 @@ XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key,
 {
 
 
-  unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+  unsigned int hash_code = xbt_str_hash_ext(key, key_len);
   xbt_dictelm_t current;
 
   xbt_assert(dict);
@@ -343,7 +263,7 @@ void *xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key,
                                int key_len)
 {
 
-  unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+  unsigned int hash_code = xbt_str_hash_ext(key, key_len);
   xbt_dictelm_t current;
 
   xbt_assert(dict);
@@ -384,6 +304,15 @@ char *xbt_dict_get_key(xbt_dict_t dict, const void *data)
   return NULL;
 }
 
+/**
+ * @brief retrieve the key associated to that xbt_dictelm_t.
+ *
+ */
+char *xbt_dict_get_elm_key(xbt_dictelm_t elm)
+{
+  return elm->key;
+}
+
 /**
  * \brief Retrieve data from the dict (null-terminated key)
  *
@@ -397,21 +326,27 @@ char *xbt_dict_get_key(xbt_dict_t dict, const void *data)
  */
 XBT_INLINE void *xbt_dict_get(xbt_dict_t dict, const char *key)
 {
-
-  unsigned int hash_code = xbt_dict_hash(key);
-  xbt_dictelm_t current;
-
-  xbt_assert(dict);
-
-  current = dict->table[hash_code & dict->table_size];
-  while (current != NULL
-         && (hash_code != current->hash_code || strcmp(key, current->key)))
-    current = current->next;
+  return xbt_dict_get_elm(dict, key)->content;
+}
+/**
+ * \brief Retrieve element from the dict (null-terminated key)
+ *
+ * \param dict the dealer of data
+ * \param key the key to find data
+ * \return the s_xbt_dictelm_t that we are looking for
+ *
+ * Search the given \a key. Throws not_found_error when not found.
+ * Check xbt_dict_get_or_null() for a version returning NULL without exception when
+ * not found.
+ */
+XBT_INLINE xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char *key)
+{
+  xbt_dictelm_t current = xbt_dict_get_elm_or_null(dict, key);
 
   if (current == NULL)
     THROWF(not_found_error, 0, "key %s not found", key);
 
-  return current->content;
+  return current;
 }
 
 /**
@@ -419,7 +354,19 @@ XBT_INLINE void *xbt_dict_get(xbt_dict_t dict, const char *key)
  */
 XBT_INLINE void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
 {
-  unsigned int hash_code = xbt_dict_hash(key);
+  xbt_dictelm_t current = xbt_dict_get_elm_or_null(dict, key);
+
+  if (current == NULL)
+    return NULL;
+
+  return current->content;
+}
+/**
+ * \brief like xbt_dict_get_elm(), but returning NULL when not found
+ */
+XBT_INLINE xbt_dictelm_t xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key)
+{
+  unsigned int hash_code = xbt_str_hash(key);
   xbt_dictelm_t current;
 
   xbt_assert(dict);
@@ -428,11 +375,7 @@ XBT_INLINE void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
   while (current != NULL &&
          (hash_code != current->hash_code || strcmp(key, current->key)))
     current = current->next;
-
-  if (current == NULL)
-    return NULL;
-
-  return current->content;
+  return current;
 }
 
 
@@ -450,7 +393,7 @@ XBT_INLINE void xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
 {
 
 
-  unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+  unsigned int hash_code = xbt_str_hash_ext(key, key_len);
   xbt_dictelm_t current, previous = NULL;
 
   xbt_assert(dict);
@@ -689,12 +632,6 @@ void xbt_dict_dump_sizes(xbt_dict_t dict)
  */
 void xbt_dict_preinit(void)
 {
-  if (dict_elm_mallocator != NULL) {
-    /* Already created. I guess we want to switch to MC mode, so kill the previously created mallocator */
-    xbt_mallocator_free(dict_elm_mallocator);
-    xbt_mallocator_free(dict_het_elm_mallocator);
-  }
-
   dict_elm_mallocator = xbt_mallocator_new(256,
                                            dict_elm_mallocator_new_f,
                                            dict_elm_mallocator_free_f,
@@ -741,15 +678,11 @@ void xbt_dict_postexit(void)
 #include "xbt/ex.h"
 #include "portable.h"
 
-XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
-XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
+#define PRINTF_STR(a) (a)?:"(null)"
 
-XBT_TEST_SUITE("dict", "Dict data container");
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dict);
 
-static void print_str(void *str)
-{
-  printf("%s", (char *) PRINTF_STR(str));
-}
+XBT_TEST_SUITE("dict", "Dict data container");
 
 static void debuged_add_ext(xbt_dict_t head, const char *key,
                             const char *data_to_fill, void_f_pvoid_t free_f)
@@ -792,19 +725,24 @@ static void fill(xbt_dict_t * head, int homogeneous)
 
 static void search_ext(xbt_dict_t head, const char *key, const char *data)
 {
-  void *found;
+  char *found;
 
   xbt_test_add("Search %s", key);
   found = xbt_dict_get(head, key);
-  xbt_test_log("Found %s", (char *) found);
-  if (data)
+  xbt_test_log("Found %s", found);
+  if (data) {
     xbt_test_assert(found,
-                     "data do not match expectations: found NULL while searching for %s",
-                     data);
-  if (found)
-    xbt_test_assert(!strcmp((char *) data, found),
-                     "data do not match expectations: found %s while searching for %s",
-                     (char *) found, data);
+                    "data do not match expectations: found NULL while searching for %s",
+                    data);
+    if (found)
+      xbt_test_assert(!strcmp(data, found),
+                      "data do not match expectations: found %s while searching for %s",
+                      found, data);
+  } else {
+    xbt_test_assert(!found,
+                    "data do not match expectations: found %s while searching for NULL",
+                    found);
+  }
 }
 
 static void search(xbt_dict_t head, const char *key)
@@ -886,7 +824,7 @@ static void count_check_get_key(xbt_dict_t dict, int length)
 {
   xbt_dict_cursor_t cursor;
   char *key;
-  _XBT_GNUC_UNUSED char *key2;
+  XBT_ATTRIB_UNUSED char *key2;
   void *data;
   int effective = 0;
 
@@ -956,19 +894,19 @@ static void basic_test(int homogeneous)
   fill(&head, homogeneous);
   count_check_get_key(head, 7);
   xbt_test_add("Change 123 to 'Changed 123'");
-  xbt_dict_set(head, "123", strdup("Changed 123"), free_f);
+  xbt_dict_set(head, "123", xbt_strdup("Changed 123"), free_f);
   count_check_get_key(head, 7);
 
   xbt_test_add("Change 123 back to '123'");
-  xbt_dict_set(head, "123", strdup("123"), free_f);
+  xbt_dict_set(head, "123", xbt_strdup("123"), free_f);
   count_check_get_key(head, 7);
 
   xbt_test_add("Change 12a to 'Dummy 12a'");
-  xbt_dict_set(head, "12a", strdup("Dummy 12a"), free_f);
+  xbt_dict_set(head, "12a", xbt_strdup("Dummy 12a"), free_f);
   count_check_get_key(head, 7);
 
   xbt_test_add("Change 12a to '12a'");
-  xbt_dict_set(head, "12a", strdup("12a"), free_f);
+  xbt_dict_set(head, "12a", xbt_strdup("12a"), free_f);
   count_check_get_key(head, 7);
 
   xbt_test_add("Traverse the resulting dictionary");
@@ -1236,4 +1174,27 @@ XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
   xbt_dict_free(&head);
 }
 
+XBT_TEST_UNIT("ext", test_dict_int, "Test dictionnary with int keys")
+{
+  xbt_dict_t dict = xbt_dict_new();
+  int count = 500;
+
+  xbt_test_add("Insert elements");
+  int i;
+  for (i = 0; i < count; ++i)
+    xbt_dict_set_ext(dict, (char*) &i, sizeof(i), (void*) (intptr_t) i, NULL);
+  xbt_test_assert(xbt_dict_size(dict) == count,
+    "Bad number of elements in the dictionnary");
+
+  xbt_test_add("Check elements");
+  for (i = 0; i < count; ++i) {
+    int res = (int) (intptr_t) xbt_dict_get_ext(dict, (char*) &i, sizeof(i));
+    xbt_test_assert(xbt_dict_size(dict) == count,
+      "Unexpected value at index %i, expected %i but was %i", i, i, res);
+  }
+
+  xbt_test_add("Free the array");
+  xbt_dict_free(&dict);
+}
+
 #endif                          /* SIMGRID_TEST */