Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Test the usage of empty dictionaries
[simgrid.git] / src / xbt / dict.c
index e69810a..227347b 100644 (file)
 #include <string.h>
 #include "xbt/ex.h"
 #include "xbt/log.h"
+#include "xbt/mallocator.h"
+#include "xbt_modinter.h"
 #include "dict_private.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict,xbt,
    "Dictionaries provide the same functionnalities than hash tables");
 /*####[ Private prototypes ]#################################################*/
 
+static xbt_mallocator_t dict_mallocator = NULL;
+static void* dict_mallocator_new_f(void);
+static void dict_mallocator_free_f(void* dict);
+static void dict_mallocator_reset_f(void* dict);
+
+
 /*####[ Code ]###############################################################*/
 
 /**
@@ -36,14 +44,24 @@ xbt_dict_t xbt_dict_new(void) {
  * \see xbt_dict_new(), xbt_dict_free()
  */
 xbt_dict_t xbt_dict_new_ext(int hashsize) {
-  int i;
-  xbt_dict_t dict = xbt_new0(s_xbt_dict_t, 1);
+  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 = hashsize;
   dict->table = xbt_new0(xbt_dictelm_t, dict->table_size);
-
-  for (i = 0; i < hashsize; i++) {
-    dict->table[i] = NULL;
-  }
+  dict->count = 0;
 
   return dict;
 }
@@ -57,17 +75,22 @@ xbt_dict_t xbt_dict_new_ext(int hashsize) {
 void xbt_dict_free(xbt_dict_t *dict) {
   int i;
   xbt_dictelm_t current, previous;
+  int table_size;
+  xbt_dictelm_t *table;
+
   if (dict != NULL && *dict != NULL) {
-    for (i = 0; i < (*dict)->table_size; i++) {
-      current = (*dict)->table[i];
+    table_size = (*dict)->table_size;
+    table = (*dict)->table;
+    for (i = 0; i < table_size; i++) {
+      current = table[i];
       while (current != NULL) {
        previous = current;
        current = current->next;
        xbt_dictelm_free(previous);
       }
     }
-    xbt_free((*dict)->table);
-    xbt_free(*dict);
+    xbt_free(table);
+    xbt_mallocator_release(dict_mallocator, *dict);
     *dict = NULL;
   }
 }
@@ -104,12 +127,25 @@ void xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize) {
 /**
  * Returns the hash code of a string.
  */
-unsigned int xbt_dict_hash(const char *str) {
+static unsigned int xbt_dict_hash_ext(const char *str, int str_len) {
+  /* fast implementation of djb2 algorithm */
+  unsigned int hash = 5381;
+  int c;
+  
+  while (str_len--) {
+    c = *str++;
+    hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
+  }
+  
+  return hash;
+}
+
+static unsigned int xbt_dict_hash(const char *str) {
   /* fast implementation of djb2 algorithm */
   unsigned int hash = 5381;
   int c;
   
-  while ((c = *str++)) {
+  while ( (c = *str++) ) {
     hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
   }
   
@@ -135,7 +171,7 @@ void xbt_dict_set_ext(xbt_dict_t      dict,
                      void_f_pvoid_t  *free_ctn) {
   xbt_assert(dict);
 
-  unsigned int hash_code = xbt_dict_hash(key) % dict->table_size;
+  unsigned int hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
   xbt_dictelm_t current, previous = NULL;
 
   current = dict->table[hash_code];
@@ -154,6 +190,7 @@ void xbt_dict_set_ext(xbt_dict_t      dict,
     else {
       previous->next = current;
     }
+    dict->count++;
   }
   else {
     /* there is already an element with the same key: we overwrite it */
@@ -168,7 +205,7 @@ void xbt_dict_set_ext(xbt_dict_t      dict,
 /**
  * \brief Add data to the dict (null-terminated key)
  *
- * \param dict the head of the dict
+ * \param dict the dict
  * \param key the key to set the new data
  * \param data the data to add in the dict
  * \param free_ctn function to call with (\a key as argument) when 
@@ -202,7 +239,7 @@ void *xbt_dict_get_ext(xbt_dict_t      dict,
                       int             key_len) {
   xbt_assert(dict);
 
-  unsigned int hash_code = xbt_dict_hash(key) % dict->table_size;
+  unsigned int hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
   xbt_dictelm_t current;
 
   current = dict->table[hash_code];
@@ -233,7 +270,19 @@ void *xbt_dict_get(xbt_dict_t dict,
                   const char *key) {
   xbt_assert(dict);
 
-  return xbt_dict_get_ext(dict, key, strlen(key));
+  unsigned int hash_code = xbt_dict_hash(key) % dict->table_size;
+  xbt_dictelm_t current;
+
+  current = dict->table[hash_code];
+  while (current != NULL && (strcmp(key, current->key))) {
+    current = current->next;
+  }
+
+  if (current == NULL) {
+    THROW1(not_found_error, 0, "key %s not found", key);
+  }
+
+  return current->content;
 }
 
 /**
@@ -269,7 +318,7 @@ void xbt_dict_remove_ext(xbt_dict_t  dict,
                         int          key_len) {
   xbt_assert(dict);
 
-  unsigned int hash_code = xbt_dict_hash(key) % dict->table_size;
+  unsigned int hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
   xbt_dictelm_t current, previous = NULL;
 
   current = dict->table[hash_code];
@@ -292,31 +341,67 @@ void xbt_dict_remove_ext(xbt_dict_t  dict,
   }
 
   xbt_dictelm_free(current);
+  dict->count--;
 }
 
 /**
  * \brief Remove data from the dict (null-terminated key)
  *
- * \param dict the head of the dict
+ * \param dict the dict
  * \param key the key of the data to be removed
  *
  * Remove the entry associated with the given \a key
  */
 void xbt_dict_remove(xbt_dict_t  dict,
                     const char  *key) {
-  if (!dict)
-    THROW1(arg_error, 0, "Asked to remove key %s from NULL dict", key);
+  xbt_assert(dict);
 
   xbt_dict_remove_ext(dict, key, strlen(key));
 }
 
+/**
+ * \brief Remove all data from the dict
+ * \param dict the dict
+ */
+void xbt_dict_reset(xbt_dict_t dict) {
+  xbt_assert(dict);
+
+  int i;
+  xbt_dictelm_t current, previous = NULL;
+   
+  if (dict->count == 0)
+    return;
+   
+  for (i = 0; i < dict->table_size; i++) {
+    current = dict->table[i];
+    while (current != NULL) {
+      previous = current;
+      current = current->next;
+      xbt_dictelm_free(previous);
+    }
+    dict->table[i] = NULL;
+  }
+
+  dict->count = 0;
+}
+
+/**
+ * \brief Return the number of elements in the dict.
+ * \param dict a dictionary
+ */
+int xbt_dict_length(xbt_dict_t dict) {
+  xbt_assert(dict);
+
+  return dict->count;
+}
+
 /*
  * Add an already mallocated element to a dictionary.
  */
 void xbt_dict_add_element(xbt_dict_t dict, xbt_dictelm_t element) {
   xbt_assert(dict);
 
-  int hashcode = xbt_dict_hash(element->key) % dict->table_size;
+  int hashcode = xbt_dict_hash_ext(element->key,element->key_len) % dict->table_size;
   element->next = dict->table[hashcode];
   dict->table[hashcode] = element;
 }
@@ -351,6 +436,31 @@ void xbt_dict_dump(xbt_dict_t     dict,
   }
 }
 
+/**
+ * Destroy the dict mallocators.
+ * This is an internal XBT function called by xbt_exit().
+ */
+void xbt_dict_exit(void) {
+  if (dict_mallocator != NULL) {
+    xbt_mallocator_free(dict_mallocator);
+    xbt_mallocator_free(dict_elm_mallocator);
+  }
+}
+
+static void* dict_mallocator_new_f(void) {
+  return xbt_new(s_xbt_dict_t, 1);
+}
+
+static void dict_mallocator_free_f(void* dict) {
+  xbt_free(dict);
+}
+
+static void dict_mallocator_reset_f(void* dict) {
+  /* nothing to do because all fields are
+   * initialized in xbt_dict_new
+   */
+}
+
 #ifdef SIMGRID_TEST
 #include "xbt.h"
 #include "xbt/ex.h"
@@ -365,11 +475,10 @@ static void print_str(void *str) {
   printf("%s",(char*)PRINTF_STR(str));
 }
 
-static void debuged_add(xbt_dict_t head,const char*key)
-{
-  char *data=xbt_strdup(key);
+static void debuged_add_ext(xbt_dict_t head,const char*key,const char*data_to_fill) {
+  char *data=xbt_strdup(data_to_fill);
 
-  xbt_test_log1("Add %s",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)) {
@@ -377,6 +486,9 @@ static void debuged_add(xbt_dict_t head,const char*key)
     fflush(stdout);
   }
 }
+static void debuged_add(xbt_dict_t head,const char*key) {
+   debuged_add_ext(head,key,key);
+}
 
 static void fill(xbt_dict_t *head) {
   xbt_test_add0("Fill in the dictionnary");
@@ -393,14 +505,21 @@ static void fill(xbt_dict_t *head) {
   debuged_add(*head,"123457");
 }
 
-static void search(xbt_dict_t head,const char*key) {
-  void *data;
+
+static void search_ext(xbt_dict_t head,const char*key, const char *data) {
+  void *found;
   
   xbt_test_add1("Search %s",key);
-  data=xbt_dict_get(head,key);
-  xbt_test_log1("Found %s",(char *)data);
+  found=xbt_dict_get(head,key);
+  xbt_test_log1("Found %s",(char *)found);
   if (data)
-    xbt_test_assert0(!strcmp((char*)data,key),"Key and data do not match");
+    xbt_test_assert1(found,"data do not match expectations: found NULL while searching for %s",data);
+  if (found)
+    xbt_test_assert2(!strcmp((char*)data,found),"data do not match expectations: found %s while searching for %s", (char*)found, data);
+}
+
+static void search(xbt_dict_t head,const char*key) {
+  search_ext(head,key,key);
 }
 
 static void debuged_remove(xbt_dict_t head,const char*key) {
@@ -424,18 +543,26 @@ static void traverse(xbt_dict_t head) {
 }
 
 static void search_not_found(xbt_dict_t head, const char *data) {
+  int ok=0;
   xbt_ex_t e;
 
   xbt_test_add1("Search %s (expected not to be found)",data);
 
   TRY {    
-    data = xbt_dict_get(head,"Can't be found");
+    data = xbt_dict_get(head, 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);
     xbt_ex_free(e);
+    ok=1;
   }
+  xbt_test_assert0(ok,"Exception not raised");
+}
+
+static void count(xbt_dict_t dict, int length) {
+  xbt_test_add1("Count elements (expecting %d)", length);
+  xbt_test_assert2(xbt_dict_length(dict) == length, "Length(%d) != %d.", xbt_dict_length(dict), length);
 }
 
 xbt_ex_t e;
@@ -444,11 +571,28 @@ char *data;
 
 
 XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse"){
-  xbt_test_add0("Traversal the empty dictionnary");
+  xbt_test_add0("Traversal the null dictionnary");
   traverse(head);
 
+  xbt_test_add0("Traversal and search the empty dictionnary");
+  head = xbt_dict_new();
+  traverse(head);
+  TRY {
+    debuged_remove(head,"12346");
+  } CATCH(e) {
+    if (e.category != not_found_error) 
+      xbt_test_exception(e);
+    xbt_ex_free(e);
+  }
+  xbt_dict_free(&head);
+
   xbt_test_add0("Traverse the full dictionnary");
   fill(&head);
+  count(head, 7);
+   
+  debuged_add_ext(head,"toto","tutu");
+  search_ext(head,"toto","tutu");
+  debuged_remove(head,"toto");
 
   search(head,"12a");
   traverse(head);
@@ -459,17 +603,22 @@ XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse")
 
   /* CHANGING */
   fill(&head);
+  count(head, 7);
   xbt_test_add0("Change 123 to 'Changed 123'");
   xbt_dict_set(head,"123",strdup("Changed 123"),&free);
+  count(head, 7);
 
   xbt_test_add0("Change 123 back to '123'");
   xbt_dict_set(head,"123",strdup("123"),&free);
+  count(head, 7);
 
   xbt_test_add0("Change 12a to 'Dummy 12a'");
   xbt_dict_set(head,"12a",strdup("Dummy 12a"),&free);
+  count(head, 7);
 
   xbt_test_add0("Change 12a to '12a'");
   xbt_dict_set(head,"12a",strdup("12a"),&free);
+  count(head, 7);
 
   xbt_test_add0("Traverse the resulting dictionnary");
   traverse(head);
@@ -506,6 +655,7 @@ XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse")
 
 XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
   fill(&head);
+  count(head, 7);
   xbt_test_add0("Remove non existing data");
   TRY {
     debuged_remove(head,"Does not exist");
@@ -518,21 +668,16 @@ XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
 
   xbt_dict_free(&head);
 
-  xbt_test_add0("Remove data from the NULL dict");
-  TRY {
-    debuged_remove(head,"12345");
-  } CATCH(e) {
-    if (e.category != arg_error) 
-      xbt_test_exception(e);
-    xbt_ex_free(e);
-  } 
-
   xbt_test_add0("Remove each data manually (traversing the resulting dictionnary each time)");
   fill(&head);
   debuged_remove(head,"12a");    traverse(head);
+  count(head, 6);
   debuged_remove(head,"12b");    traverse(head);
+  count(head, 5);
   debuged_remove(head,"12");     traverse(head);
+  count(head, 4);
   debuged_remove(head,"123456"); traverse(head);
+  count(head, 3);
   TRY {
     debuged_remove(head,"12346");
   } CATCH(e) {
@@ -552,6 +697,13 @@ XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
     xbt_ex_free(e);
   }                              traverse(head);
   
+  xbt_test_add0("Remove all values");
+  xbt_dict_free(&head);
+  fill(&head);
+  xbt_dict_reset(head);
+  count(head, 0);
+  traverse(head);
+
   xbt_test_add0("Free the dictionnary twice");
   xbt_dict_free(&head);
   xbt_dict_free(&head);      
@@ -562,7 +714,7 @@ XBT_TEST_UNIT("nulldata",test_dict_nulldata,"NULL data management"){
 
   xbt_test_add0("Store NULL under 'null'");
   xbt_dict_set(head,"null",NULL,NULL);
-  search(head,"null");
+  search_ext(head,"null",NULL);
 
   xbt_test_add0("Check whether I see it while traversing...");
   {
@@ -608,7 +760,7 @@ XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
 
   for (i=0;i<10;i++) {
     head=xbt_dict_new();
-    //    if (i%10) printf("."); else printf("%d",i/10); fflush(stdout);
+    /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
     nb=0;
     for (j=0;j<1000;j++) {
       key=xbt_malloc(SIZEOFKEY);
@@ -631,7 +783,7 @@ XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
   head=xbt_dict_new();
   xbt_test_add1("Fill %d elements, with keys being the number of element",NB_ELM);
   for (j=0;j<NB_ELM;j++) {
-    //    if (!(j%1000)) { printf("."); fflush(stdout); }
+    /* if (!(j%1000)) { printf("."); fflush(stdout); } */
 
     key = xbt_malloc(10);
     
@@ -646,7 +798,7 @@ XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
   xbt_test_add1("Search my %d elements 20 times",NB_ELM);
   key=xbt_malloc(10);
   for (i=0;i<20;i++) {
-    //    if (i%10) printf("."); else printf("%d",i/10); fflush(stdout);
+    /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
     for (j=0;j<NB_ELM;j++) {
       
       sprintf(key,"%d",j);
@@ -660,7 +812,7 @@ XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
   xbt_test_add1("Remove my %d elements",NB_ELM);
   key=xbt_malloc(10);
   for (j=0;j<NB_ELM;j++) {
-    //if (!(j%10000)) printf("."); fflush(stdout);
+    /* if (!(j%10000)) printf("."); fflush(stdout); */
     
     sprintf(key,"%d",j);
     xbt_dict_remove(head,key);