Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix a 3 years old bug in the dictionary's function xbt_dict_get_or_null().
[simgrid.git] / src / xbt / dict.c
index 60937b3..708cffb 100644 (file)
@@ -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);
@@ -102,7 +89,7 @@ void xbt_dict_free(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);
 }
 
 /**
@@ -341,6 +328,7 @@ XBT_INLINE void *xbt_dict_get_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;
 
@@ -423,7 +411,7 @@ XBT_INLINE 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)
@@ -476,6 +464,8 @@ XBT_INLINE void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_le
   dict->count--;
 }
 
+
+
 /**
  * \brief Remove data from the dict (null-terminated key)
  *
@@ -489,6 +479,119 @@ 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 key_len the size of the \a key
+ * \param data the data to add in the dict
+ * \param free_ctn function to call with (\a key as argument) when
+ *        \a key is removed from the dictionary
+ *
+ * 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 in \a key_len.
+ */
+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)) )) {
+    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
@@ -534,7 +637,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)
@@ -632,11 +741,33 @@ 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);
@@ -1035,6 +1166,46 @@ 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)