X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4c07ef1267acad0364557ca2695643be18be5547..cba95b2580780a5924063056d2be528451d6008a:/src/xbt/dict.c

diff --git a/src/xbt/dict.c b/src/xbt/dict.c
index 93b29eb989..4dc99bb086 100644
--- a/src/xbt/dict.c
+++ b/src/xbt/dict.c
@@ -1,8 +1,7 @@
-/* $Id$ */
+/* dict - a generic dictionary, variation over hash table                   */
 
-/* dict - a generic dictionary, variation over the B-tree concept          */
-
-/* Copyright (c) 2003,2004 Martin Quinson. All rights reserved.             */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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. */
@@ -41,18 +40,6 @@ xbt_dict_t xbt_dict_new(void)
 {
   xbt_dict_t dict;
 
-  if (dict_mallocator == NULL) {
-    /* first run */
-    dict_mallocator = xbt_mallocator_new(256,
-                                         dict_mallocator_new_f,
-                                         dict_mallocator_free_f,
-                                         dict_mallocator_reset_f);
-    dict_elm_mallocator = xbt_mallocator_new(256,
-                                             dict_elm_mallocator_new_f,
-                                             dict_elm_mallocator_free_f,
-                                             dict_elm_mallocator_reset_f);
-  }
-
   dict = xbt_mallocator_get(dict_mallocator);
   dict->table_size = 127;
   dict->table = xbt_new0(xbt_dictelm_t, dict->table_size + 1);
@@ -80,7 +67,9 @@ void xbt_dict_free(xbt_dict_t * dict)
   if (dict != NULL && *dict != NULL) {
     table_size = (*dict)->table_size;
     table = (*dict)->table;
-    for (i = 0; (*dict)->count && i < table_size; i++) {
+    /* Warning: the size of the table is 'table_size+1'...
+     * This is because table_size is used as a binary mask in xbt_dict_rehash */
+    for (i = 0; (*dict)->count && i <= table_size; i++) {
       current = table[i];
       while (current != NULL) {
         previous = current;
@@ -98,15 +87,16 @@ void xbt_dict_free(xbt_dict_t * dict)
 /**
  * Returns the amount of elements in the dict
  */
-unsigned int xbt_dict_size(xbt_dict_t dict)
+XBT_INLINE unsigned int xbt_dict_size(xbt_dict_t dict)
 {
-  return dict->count;
+  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)
+static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str,
+                                                 int str_len)
 {
 
 
@@ -127,7 +117,8 @@ static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str, int str_len)
   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);
+        (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
+        (hash << 24);
 
     /* xor the bottom with the current octet */
     hash ^= (unsigned int) *bp++;
@@ -162,7 +153,8 @@ static XBT_INLINE unsigned int xbt_dict_hash(const char *str)
   while (*str) {
     /* multiply by the 32 bit FNV magic prime mod 2^32 */
     hash +=
-      (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) + (hash << 24);
+        (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
+        (hash << 24);
 
     /* xor the bottom with the current byte */
     hash ^= (unsigned int) *str++;
@@ -191,8 +183,8 @@ static void xbt_dict_rehash(xbt_dict_t dict)
   register xbt_dictelm_t *pprev;
 
   currcell =
-    (xbt_dictelm_t *) xbt_realloc((char *) dict->table,
-                                  newsize * sizeof(xbt_dictelm_t));
+      (xbt_dictelm_t *) xbt_realloc((char *) dict->table,
+                                    newsize * sizeof(xbt_dictelm_t));
   memset(&currcell[oldsize], 0, oldsize * sizeof(xbt_dictelm_t));       /* zero second half */
   dict->table_size = --newsize;
   dict->table = currcell;
@@ -295,8 +287,9 @@ XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
  * set the \a data in the structure under the \a key, which is a
  * null terminated string.
  */
-void xbt_dict_set(xbt_dict_t dict,
-                  const char *key, void *data, void_f_pvoid_t free_ctn)
+XBT_INLINE void xbt_dict_set(xbt_dict_t dict,
+                             const char *key, void *data,
+                             void_f_pvoid_t free_ctn)
 {
 
   xbt_dict_set_ext(dict, key, strlen(key), data, free_ctn);
@@ -312,7 +305,8 @@ void xbt_dict_set(xbt_dict_t dict,
  *
  * Search the given \a key. Throws not_found_error when not found.
  */
-void *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len)
+XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key,
+                                  int key_len)
 {
 
 
@@ -337,8 +331,10 @@ void *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len)
 /**
  * \brief like xbt_dict_get_ext(), but returning NULL when not found
  */
-void *xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len)
+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);
   xbt_dictelm_t current;
 
@@ -362,7 +358,8 @@ void *xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len)
  *
  * Returns NULL if the object cannot be found
  */
-char *xbt_dict_get_key(xbt_dict_t dict, void*data) {
+char *xbt_dict_get_key(xbt_dict_t dict, const void *data)
+{
   int i;
   xbt_dictelm_t current;
 
@@ -390,7 +387,7 @@ char *xbt_dict_get_key(xbt_dict_t dict, void*data) {
  * Check xbt_dict_get_or_null() for a version returning NULL without exception when
  * not found.
  */
-void *xbt_dict_get(xbt_dict_t dict, const char *key)
+XBT_INLINE void *xbt_dict_get(xbt_dict_t dict, const char *key)
 {
 
   unsigned int hash_code = xbt_dict_hash(key);
@@ -412,7 +409,7 @@ void *xbt_dict_get(xbt_dict_t dict, const char *key)
 /**
  * \brief like xbt_dict_get(), but returning NULL when not found
  */
-void *xbt_dict_get_or_null(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;
@@ -421,7 +418,7 @@ void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
 
   current = dict->table[hash_code & dict->table_size];
   while (current != NULL &&
-         hash_code != current->hash_code && strcmp(key, current->key))
+         (hash_code != current->hash_code || strcmp(key, current->key)))
     current = current->next;
 
   if (current == NULL)
@@ -440,7 +437,8 @@ void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
  *
  * Remove the entry associated with the given \a key (throws not_found)
  */
-void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len)
+XBT_INLINE void xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
+                                    int key_len)
 {
 
 
@@ -474,6 +472,8 @@ void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len)
   dict->count--;
 }
 
+
+
 /**
  * \brief Remove data from the dict (null-terminated key)
  *
@@ -482,11 +482,131 @@ void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len)
  *
  * Remove the entry associated with the given \a key
  */
-void xbt_dict_remove(xbt_dict_t dict, const char *key)
+XBT_INLINE void xbt_dict_remove(xbt_dict_t dict, const char *key)
 {
   xbt_dict_remove_ext(dict, key, strlen(key));
 }
 
+/**
+ * \brief Add data to the dict (arbitrary key)
+ * \param dict the container
+ * \param key the key to set the new data
+ * \param data the data to add in the dict
+ *
+ * Set the \a data in the structure under the \a key.
+ * Both \a data and \a key are considered as uintptr_t.
+ */
+XBT_INLINE void xbt_dicti_set(xbt_dict_t dict,
+                              uintptr_t key, uintptr_t data)
+{
+
+  unsigned int hash_code =
+      xbt_dict_hash_ext((void *) &key, sizeof(uintptr_t));
+
+  xbt_dictelm_t current, previous = NULL;
+  xbt_assert(dict);
+
+  DEBUG5("ADD %zu->%zu; hash = %d, size = %d, & = %d", key, data,
+         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
+          || sizeof(uintptr_t) != current->key_len
+          || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+    previous = current;
+    current = current->next;
+  }
+
+  if (current == NULL) {
+    /* this key doesn't exist yet */
+    current = xbt_dictielm_new(key, hash_code, data);
+    dict->count++;
+    if (previous == NULL) {
+      dict->table[hash_code & dict->table_size] = current;
+      dict->fill++;
+      if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
+        xbt_dict_rehash(dict);
+    } else {
+      previous->next = current;
+    }
+  } else {
+
+    /* there is already an element with the same key: overwrite it */
+    if (current->content != NULL && current->free_f != NULL) {
+      current->free_f(current->content);
+    }
+    current->content = (void *) data;
+    current->free_f = NULL;
+  }
+}
+
+/**
+ * \brief Retrieve data from the dict (key considered as a uintptr_t)
+ *
+ * \param dict the dealer of data
+ * \param key the key to find data
+ * \return the data that we are looking for (or 0 if not found)
+ *
+ * Mixing uintptr_t keys with regular keys in the same dict is discouraged
+ */
+XBT_INLINE uintptr_t xbt_dicti_get(xbt_dict_t dict, uintptr_t key)
+{
+
+  unsigned int hash_code =
+      xbt_dict_hash_ext(((void *) &key), sizeof(uintptr_t));
+  xbt_dictelm_t current;
+
+  xbt_assert(dict);
+
+  current = dict->table[hash_code & dict->table_size];
+  while (current != NULL &&
+         (hash_code != current->hash_code
+          || sizeof(uintptr_t) != current->key_len
+          || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+    current = current->next;
+  }
+
+  if (current == NULL)
+    return 0;
+
+  return (uintptr_t) (current->content);
+}
+
+/** Remove a uintptr_t key from the dict */
+XBT_INLINE void xbt_dicti_remove(xbt_dict_t dict, uintptr_t key)
+{
+
+  unsigned int hash_code =
+      xbt_dict_hash_ext(((void *) &key), sizeof(uintptr_t));
+  xbt_dictelm_t current, previous = NULL;
+
+
+  current = dict->table[hash_code & dict->table_size];
+  while (current != NULL &&
+         (hash_code != current->hash_code
+          || sizeof(uintptr_t) != current->key_len
+          || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+    previous = current;         /* save the previous node */
+    current = current->next;
+  }
+
+  if (current == NULL)
+    THROW1(not_found_error, 0, "key %zu not found", key);
+
+  if (previous != NULL) {
+    previous->next = current->next;
+  } else {
+    dict->table[hash_code & dict->table_size] = current->next;
+  }
+
+  if (!dict->table[hash_code & dict->table_size])
+    dict->fill--;
+
+  xbt_dictelm_free(current);
+  dict->count--;
+}
+
+
 /**
  * \brief Remove all data from the dict
  * \param dict the dict
@@ -520,7 +640,7 @@ void xbt_dict_reset(xbt_dict_t dict)
  * \brief Return the number of elements in the dict.
  * \param dict a dictionary
  */
-int xbt_dict_length(xbt_dict_t dict)
+XBT_INLINE int xbt_dict_length(xbt_dict_t dict)
 {
   xbt_assert(dict);
 
@@ -533,6 +653,13 @@ void xbt_dict_dump_output_string(void *s)
   fputs(s, stdout);
 }
 
+/**
+ * \brief test if the dict is empty or not
+ */
+XBT_INLINE int xbt_dict_is_empty(xbt_dict_t dict)
+{
+  return (xbt_dict_size(dict) == 0);
+}
 
 /**
  * \brief Outputs the content of the structure (debugging purpose)
@@ -630,11 +757,34 @@ void xbt_dict_dump_sizes(xbt_dict_t dict)
   xbt_dynar_free(&sizes);
 }
 
+/**
+ * Create the dict mallocators.
+ * This is an internal XBT function called during the lib initialization.
+ * It can be used several times to recreate the mallocator, for example when you switch to MC mode
+ */
+void xbt_dict_preinit(void)
+{
+  if (dict_mallocator != NULL) {
+    /* Already created. I guess we want to switch to MC mode, so kill the previously created mallocator */
+    xbt_mallocator_free(dict_mallocator);
+    xbt_mallocator_free(dict_elm_mallocator);
+  }
+
+  dict_mallocator = xbt_mallocator_new(256,
+                                       dict_mallocator_new_f,
+                                       dict_mallocator_free_f,
+                                       dict_mallocator_reset_f);
+  dict_elm_mallocator = xbt_mallocator_new(256,
+                                           dict_elm_mallocator_new_f,
+                                           dict_elm_mallocator_free_f,
+                                           dict_elm_mallocator_reset_f);
+}
+
 /**
  * Destroy the dict mallocators.
- * This is an internal XBT function called by xbt_exit().
+ * This is an internal XBT function during the lib initialization
  */
-void xbt_dict_exit(void)
+void xbt_dict_postexit(void)
 {
   if (dict_mallocator != NULL) {
     xbt_mallocator_free(dict_mallocator);
@@ -698,7 +848,8 @@ static void debuged_add_ext(xbt_dict_t head, const char *key,
 {
   char *data = xbt_strdup(data_to_fill);
 
-  xbt_test_log2("Add %s under %s", PRINTF_STR(data_to_fill), PRINTF_STR(key));
+  xbt_test_log2("Add %s under %s", PRINTF_STR(data_to_fill),
+                PRINTF_STR(key));
 
   xbt_dict_set(head, key, data, &free);
   if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
@@ -788,8 +939,8 @@ static void search_not_found(xbt_dict_t head, const char *data)
 
   TRY {
     data = xbt_dict_get(head, data);
-    THROW1(unknown_error, 0, "Found something which shouldn't be there (%s)",
-           data);
+    THROW1(unknown_error, 0,
+           "Found something which shouldn't be there (%s)", data);
   } CATCH(e) {
     if (e.category != not_found_error)
       xbt_test_exception(e);
@@ -813,7 +964,7 @@ static void count(xbt_dict_t dict, int length)
                    length);
 
   xbt_dict_foreach(dict, cursor, key, data)
-    effective++;
+      effective++;
 
   xbt_test_assert2(effective == length, "Effective length(%d) != %d.",
                    effective, length);
@@ -823,21 +974,24 @@ static void count(xbt_dict_t dict, int length)
 static void count_check_get_key(xbt_dict_t dict, int length)
 {
   xbt_dict_cursor_t cursor;
-  char *key,*key2;
+  char *key, *key2;
   void *data;
   int effective = 0;
 
 
-  xbt_test_add1("Count elements (expecting %d), and test the getkey function", length);
+  xbt_test_add1
+      ("Count elements (expecting %d), and test the getkey function",
+       length);
   xbt_test_assert2(xbt_dict_length(dict) == length,
                    "Announced length(%d) != %d.", xbt_dict_length(dict),
                    length);
 
   xbt_dict_foreach(dict, cursor, key, data) {
     effective++;
-    key2 = xbt_dict_get_key(dict,data);
-    xbt_assert2(!strcmp(key,key2),
-          "The data was registered under %s instead of %s as expected",key2,key);
+    key2 = xbt_dict_get_key(dict, data);
+    xbt_assert2(!strcmp(key, key2),
+                "The data was registered under %s instead of %s as expected",
+                key2, key);
   }
 
   xbt_test_assert2(effective == length, "Effective length(%d) != %d.",
@@ -850,7 +1004,7 @@ xbt_dict_t head = NULL;
 char *data;
 
 
-XBT_TEST_UNIT("basic", test_dict_basic,"Basic usage: change, retrieve, traverse")
+XBT_TEST_UNIT("basic", test_dict_basic, "Basic usage: change, retrieve, traverse")
 {
   xbt_test_add0("Traversal the null dictionary");
   traverse(head);
@@ -952,7 +1106,7 @@ XBT_TEST_UNIT("remove", test_dict_remove, "Removing some values")
   xbt_dict_free(&head);
 
   xbt_test_add0
-    ("Remove each data manually (traversing the resulting dictionary each time)");
+      ("Remove each data manually (traversing the resulting dictionary each time)");
   fill(&head);
   debuged_remove(head, "12a");
   traverse(head);
@@ -991,7 +1145,8 @@ XBT_TEST_UNIT("remove", test_dict_remove, "Removing some values")
   }
   traverse(head);
 
-  xbt_test_add0("Free dict, create new fresh one, and then reset the dict");
+  xbt_test_add0
+      ("Free dict, create new fresh one, and then reset the dict");
   xbt_dict_free(&head);
   fill(&head);
   xbt_dict_reset(head);
@@ -1033,6 +1188,48 @@ XBT_TEST_UNIT("nulldata", test_dict_nulldata, "NULL data management")
   xbt_dict_free(&head);
 }
 
+static void debuged_addi(xbt_dict_t head, uintptr_t key, uintptr_t data)
+{
+  uintptr_t stored_data = 0;
+  xbt_test_log2("Add %zu under %zu", data, key);
+
+  xbt_dicti_set(head, key, data);
+  if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
+    xbt_dict_dump(head, (void (*)(void *)) &printf);
+    fflush(stdout);
+  }
+  stored_data = xbt_dicti_get(head, key);
+  xbt_test_assert3(stored_data == data,
+                   "Retrieved data (%zu) is not what I just stored (%zu) under key %zu",
+                   stored_data, data, key);
+}
+
+XBT_TEST_UNIT("dicti", test_dict_scalar, "Scalar data and key management")
+{
+  xbt_test_add0("Fill in the dictionnary");
+
+  head = xbt_dict_new();
+  debuged_addi(head, 12, 12);
+  debuged_addi(head, 13, 13);
+  debuged_addi(head, 14, 14);
+  debuged_addi(head, 15, 15);
+  /* Change values */
+  debuged_addi(head, 12, 15);
+  debuged_addi(head, 15, 2000);
+  debuged_addi(head, 15, 3000);
+  /* 0 as key */
+  debuged_addi(head, 0, 1000);
+  debuged_addi(head, 0, 2000);
+  debuged_addi(head, 0, 3000);
+  /* 0 as value */
+  debuged_addi(head, 12, 0);
+  debuged_addi(head, 13, 0);
+  debuged_addi(head, 12, 0);
+  debuged_addi(head, 0, 0);
+
+  xbt_dict_free(&head);
+}
+
 #define NB_ELM 20000
 #define SIZEOFKEY 1024
 static int countelems(xbt_dict_t head)
@@ -1059,9 +1256,11 @@ XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
 
   for (i = 0; i < 10; i++) {
     xbt_test_add2("CRASH test number %d (%d to go)", i + 1, 10 - i - 1);
-    xbt_test_log0("Fill the struct, count its elems and frees the structure");
-    xbt_test_log1("using 1000 elements with %d chars long randomized keys.",
-                  SIZEOFKEY);
+    xbt_test_log0
+        ("Fill the struct, count its elems and frees the structure");
+    xbt_test_log1
+        ("using 1000 elements with %d chars long randomized keys.",
+         SIZEOFKEY);
     head = xbt_dict_new();
     /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
     nb = 0;
@@ -1105,7 +1304,8 @@ XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
   }
   /*xbt_dict_dump(head,(void (*)(void*))&printf); */
 
-  xbt_test_add0("Count the elements (retrieving the key and data for each)");
+  xbt_test_add0
+      ("Count the elements (retrieving the key and data for each)");
   i = countelems(head);
   xbt_test_log1("There is %d elements", i);
 
@@ -1121,7 +1321,8 @@ XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
                        "with get, key=%s != data=%s", key, (char *) data);
       data = xbt_dict_get_ext(head, key, strlen(key));
       xbt_test_assert2(!strcmp(key, (char *) data),
-                       "with get_ext, key=%s != data=%s", key, (char *) data);
+                       "with get_ext, key=%s != data=%s", key,
+                       (char *) data);
     }
   }
   free(key);
@@ -1166,9 +1367,10 @@ XBT_TEST_UNIT("multicrash", test_dict_multicrash, "Multi-dict crash test")
 
 
   xbt_test_add0("Generic multicache CRASH test");
-  xbt_test_log4(" Fill the struct and frees it %d times, using %d elements, "
-                "depth of multicache=%d, key size=%d",
-                NB_TEST, NB_ELM, DEPTH, KEY_SIZE);
+  xbt_test_log4
+      (" Fill the struct and frees it %d times, using %d elements, "
+       "depth of multicache=%d, key size=%d", NB_TEST, NB_ELM, DEPTH,
+       KEY_SIZE);
 
   for (l = 0; l < DEPTH; l++) {
     key = xbt_malloc(KEY_SIZE);
@@ -1220,4 +1422,4 @@ XBT_TEST_UNIT("multicrash", test_dict_multicrash, "Multi-dict crash test")
   xbt_dynar_free(&keys);
 
 }
-#endif /* SIMGRID_TEST */
+#endif                          /* SIMGRID_TEST */