Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9533beb56474729f099ce9307e241b9312f36612
[simgrid.git] / src / xbt / dict.c
1 /* $Id$ */
2
3 /* dict - a generic dictionary, variation over the B-tree concept          */
4
5 /* Copyright (c) 2003,2004 Martin Quinson. All rights reserved.             */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #define DJB2_HASH_FUNCTION
11 //#define FNV_HASH_FUNCTION
12
13 #include <string.h>
14 #include <stdio.h>
15 #include "xbt/ex.h"
16 #include "xbt/log.h"
17 #include "xbt/mallocator.h"
18 #include "xbt_modinter.h"
19 #include "dict_private.h"
20
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict,xbt,
22                                 "Dictionaries provide the same functionalities than hash tables");
23 /*####[ Private prototypes ]#################################################*/
24
25 static xbt_mallocator_t dict_mallocator = NULL;
26 static void* dict_mallocator_new_f(void);
27 static void dict_mallocator_free_f(void* dict);
28 static void dict_mallocator_reset_f(void* dict);
29
30
31 /*####[ Code ]###############################################################*/
32
33 /**
34  * \brief Constructor
35  * \return pointer to the destination
36  * \see xbt_dict_new_ext(), xbt_dict_free()
37  *
38  * Creates and initialize a new dictionary with a default hashtable size.
39  */
40 xbt_dict_t xbt_dict_new(void) {
41   xbt_dict_t dict;
42
43   if (dict_mallocator == NULL) {
44     /* first run */
45     dict_mallocator = xbt_mallocator_new(256,
46                                          dict_mallocator_new_f,
47                                          dict_mallocator_free_f,
48                                          dict_mallocator_reset_f);
49     dict_elm_mallocator = xbt_mallocator_new(256,
50                                              dict_elm_mallocator_new_f,
51                                              dict_elm_mallocator_free_f,
52                                              dict_elm_mallocator_reset_f);
53   }
54
55   dict = xbt_mallocator_get(dict_mallocator);
56   dict->table_size = 127;
57   dict->table = xbt_new0(xbt_dictelm_t, dict->table_size+1);
58   dict->count = 0;
59   dict->fill = 0;
60
61   return dict;
62 }
63
64 /**
65  * \brief Destructor
66  * \param dict the dictionary to be freed
67  *
68  * Frees a dictionary with all the data
69  */
70 void xbt_dict_free(xbt_dict_t *dict) {
71   int i;
72   xbt_dictelm_t current, previous;
73   int table_size;
74   xbt_dictelm_t *table;
75
76   //  if ( *dict )  xbt_dict_dump_sizes(*dict);
77
78   if (dict != NULL && *dict != NULL) {
79     table_size = (*dict)->table_size;
80     table = (*dict)->table;
81     for (i = 0; (*dict)->count && i < table_size; i++) {
82       current = table[i];
83       while (current != NULL) {
84         previous = current;
85         current = current->next;
86         xbt_dictelm_free(previous);
87         (*dict)->count--;
88       }
89     }
90     xbt_free(table);
91     xbt_mallocator_release(dict_mallocator, *dict);
92     *dict = NULL;
93   }
94 }
95
96 /**
97  * Returns the amount of elements in the dict
98  */
99 unsigned int xbt_dict_size(xbt_dict_t dict) {
100   return dict->count;
101 }
102
103 /**
104  * Returns the hash code of a string.
105  */
106 static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str, int str_len) {
107
108
109 #ifdef DJB2_HASH_FUNCTION
110   /* fast implementation of djb2 algorithm */
111   int c;
112   register unsigned int hash = 5381;
113
114   while (str_len--) {
115     c = *str++;
116     hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
117   }
118 # elif defined(FNV_HASH_FUNCTION)
119   register unsigned int hash = 0x811c9dc5;
120   unsigned char *bp = (unsigned char *)str;   /* start of buffer */
121   unsigned char *be = bp + str_len;               /* beyond end of buffer */
122
123   while (bp < be) {
124     /* multiply by the 32 bit FNV magic prime mod 2^32 */
125     hash += (hash<<1) + (hash<<4) + (hash<<7) + (hash<<8) + (hash<<24);
126
127     /* xor the bottom with the current octet */
128     hash ^= (unsigned int)*bp++;
129   }
130
131 # else
132   register unsigned int hash = 0;
133
134   while (str_len--) {
135     hash += (*str) * (*str);
136     str++;
137   }
138 #endif
139
140   return hash;
141 }
142
143 static XBT_INLINE unsigned int xbt_dict_hash(const char *str) {
144 #ifdef DJB2_HASH_FUNCTION
145   /* fast implementation of djb2 algorithm */
146   int c;
147   register unsigned int hash = 5381;
148
149   while ( (c = *str++) ) {
150     hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
151   }
152
153 # elif defined(FNV_HASH_FUNCTION)
154   register unsigned int hash = 0x811c9dc5;
155
156   while (*str) {
157     /* multiply by the 32 bit FNV magic prime mod 2^32 */
158     hash += (hash<<1) + (hash<<4) + (hash<<7) + (hash<<8) + (hash<<24);
159
160     /* xor the bottom with the current byte */
161     hash ^= (unsigned int)*str++;
162   }
163
164 # else
165   register unsigned int hash = 0;
166
167   while (*str) {
168     hash += (*str) * (*str);
169     str++;
170   }
171 #endif
172   return hash;
173 }
174
175 /* Expend the size of the dict */
176 static void xbt_dict_rehash(xbt_dict_t dict) {
177   const int oldsize = dict->table_size + 1;
178   register int newsize = oldsize * 2;
179   register int i;
180   register xbt_dictelm_t *currcell;
181   register xbt_dictelm_t *twincell;
182   register xbt_dictelm_t bucklet;
183   register xbt_dictelm_t *pprev;
184
185   currcell = (xbt_dictelm_t*) xbt_realloc((char*)dict->table, newsize * sizeof(xbt_dictelm_t));
186   memset(&currcell[oldsize], 0, oldsize * sizeof(xbt_dictelm_t)); /* zero second half */
187   dict->table_size = --newsize;
188   dict->table = currcell;
189   DEBUG2("REHASH (%d->%d)",oldsize,newsize);
190
191   for (i=0; i<oldsize; i++,currcell++) {
192     if (!*currcell) /* empty cell */
193       continue;
194     twincell = currcell+oldsize;
195     for (pprev = currcell, bucklet = *currcell;
196     bucklet;
197     bucklet = *pprev) {
198       /* Since we use "& size" instead of "%size" and since the size was doubled,
199             each bucklet of this cell must either :
200              - stay  in  cell i (ie, currcell)
201              - go to the cell i+oldsize (ie, twincell) */
202       if ((bucklet->hash_code & newsize) != i) { /* Move to b */
203         *pprev = bucklet->next;
204         bucklet->next = *twincell;
205         if (!*twincell)
206           dict->fill++;
207         *twincell = bucklet;
208         continue;
209       } else {
210         pprev = &bucklet->next;
211       }
212
213     }
214
215     if (!*currcell)  /* everything moved */
216       dict->fill--;
217   }
218 }
219
220 /**
221  * \brief Add data to the dict (arbitrary key)
222  * \param dict the container
223  * \param key the key to set the new data
224  * \param key_len the size of the \a key
225  * \param data the data to add in the dict
226  * \param free_ctn function to call with (\a key as argument) when
227  *        \a key is removed from the dictionary
228  *
229  * Set the \a data in the structure under the \a key, which can be any kind
230  * of data, as long as its length is provided in \a key_len.
231  */
232 XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
233                                  const char *key, int key_len,
234                                  void *data, void_f_pvoid_t free_ctn) {
235
236   unsigned int hash_code = xbt_dict_hash_ext(key,key_len);
237
238   xbt_dictelm_t current, previous = NULL;
239   xbt_assert(dict);
240
241   DEBUG5("ADD %.*s hash = %d, size = %d, & = %d",key_len,key,hash_code, dict->table_size, hash_code & dict->table_size);
242   current = dict->table[hash_code & dict->table_size];
243   while (current != NULL &&
244       (hash_code != current->hash_code || key_len != current->key_len || memcmp(key, current->key, key_len))) {
245     previous = current;
246     current = current->next;
247   }
248
249   if (current == NULL) {
250     /* this key doesn't exist yet */
251     current = xbt_dictelm_new(key, key_len, hash_code, data, free_ctn);
252     dict->count++;
253     if (previous == NULL) {
254       dict->table[hash_code & dict->table_size] = current;
255       dict->fill++;
256       if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
257         xbt_dict_rehash(dict);
258     } else {
259       previous->next = current;
260     }
261   }
262   else {
263
264     DEBUG6("Replace %.*s by %.*s under key %.*s",
265            key_len,(char*)current->content,
266            key_len,(char*)data,
267            key_len,(char*)key);
268     /* there is already an element with the same key: overwrite it */
269     if (current->content != NULL && current->free_f != NULL) {
270       current->free_f(current->content);
271     }
272     current->content = data;
273     current->free_f = free_ctn;
274   }
275 }
276
277 /**
278  * \brief Add data to the dict (null-terminated key)
279  *
280  * \param dict the dict
281  * \param key the key to set the new data
282  * \param data the data to add in the dict
283  * \param free_ctn function to call with (\a key as argument) when
284  *        \a key is removed from the dictionary
285  *
286  * set the \a data in the structure under the \a key, which is a
287  * null terminated string.
288  */
289 void xbt_dict_set(xbt_dict_t      dict,
290                   const char     *key,
291                   void           *data,
292                   void_f_pvoid_t  free_ctn) {
293
294   xbt_dict_set_ext(dict, key, strlen(key), data, free_ctn);
295 }
296
297 /**
298  * \brief Retrieve data from the dict (arbitrary key)
299  *
300  * \param dict the dealer of data
301  * \param key the key to find data
302  * \param key_len the size of the \a key
303  * \return the data that we are looking for
304  *
305  * Search the given \a key. Throws not_found_error when not found.
306  */
307 void *xbt_dict_get_ext(xbt_dict_t dict,
308                        const char *key, int key_len) {
309
310
311   unsigned int hash_code = xbt_dict_hash_ext(key,key_len);
312   xbt_dictelm_t current;
313
314   xbt_assert(dict);
315
316   current = dict->table[hash_code & dict->table_size];
317   while (current != NULL &&
318       (hash_code != current->hash_code || key_len != current->key_len || memcmp(key, current->key, key_len))) {
319     current = current->next;
320   }
321
322   if (current == NULL)
323     THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
324
325   return current->content;
326 }
327 /**
328  * \brief like xbt_dict_get_ext(), but returning NULL when not found
329  */
330 void *xbt_dict_get_or_null_ext(xbt_dict_t dict,
331                                const char *key, int key_len) {
332   unsigned int hash_code = xbt_dict_hash_ext(key,key_len);
333   xbt_dictelm_t current;
334
335   xbt_assert(dict);
336
337   current = dict->table[hash_code & dict->table_size];
338   while (current != NULL &&
339       (hash_code != current->hash_code || key_len != current->key_len || memcmp(key, current->key, key_len))) {
340     current = current->next;
341   }
342
343   if (current == NULL)
344     return NULL;
345
346   return current->content;
347 }
348
349 /**
350  * \brief Retrieve data from the dict (null-terminated key)
351  *
352  * \param dict the dealer of data
353  * \param key the key to find data
354  * \return the data that we are looking for
355  *
356  * Search the given \a key. Throws not_found_error when not found.
357  * Check xbt_dict_get_or_null() for a version returning NULL without exception when
358  * not found.
359  */
360 void *xbt_dict_get(xbt_dict_t dict,
361                    const char *key) {
362
363   unsigned int hash_code = xbt_dict_hash(key);
364   xbt_dictelm_t current;
365
366   xbt_assert(dict);
367
368   current = dict->table[hash_code & dict->table_size];
369   while (current != NULL && (hash_code != current->hash_code || strcmp(key, current->key)))
370     current = current->next;
371
372   if (current == NULL)
373     THROW1(not_found_error, 0, "key %s not found", key);
374
375   return current->content;
376 }
377
378 /**
379  * \brief like xbt_dict_get(), but returning NULL when not found
380  */
381 void *xbt_dict_get_or_null(xbt_dict_t dict,
382                            const char *key) {
383   unsigned int hash_code = xbt_dict_hash(key);
384   xbt_dictelm_t current;
385
386   xbt_assert(dict);
387
388   current = dict->table[hash_code & dict->table_size];
389   while (current != NULL &&
390       hash_code != current->hash_code && strcmp(key, current->key))
391     current = current->next;
392
393   if (current == NULL)
394     return NULL;
395
396   return current->content;
397 }
398
399
400 /**
401  * \brief Remove data from the dict (arbitrary key)
402  *
403  * \param dict the trash can
404  * \param key the key of the data to be removed
405  * \param key_len the size of the \a key
406  *
407  * Remove the entry associated with the given \a key (throws not_found)
408  */
409 void xbt_dict_remove_ext(xbt_dict_t  dict,
410                          const char  *key,
411                          int          key_len) {
412
413
414   unsigned int hash_code = xbt_dict_hash_ext(key,key_len);
415   xbt_dictelm_t current, previous = NULL;
416
417   xbt_assert(dict);
418
419   //  fprintf(stderr,"RM %.*s hash = %d, size = %d, & = %d\n",key_len,key,hash_code, dict->table_size, hash_code & dict->table_size);
420   current = dict->table[hash_code & dict->table_size];
421   while (current != NULL &&
422       (hash_code != current->hash_code || key_len != current->key_len || strncmp(key, current->key, key_len))) {
423     previous = current; /* save the previous node */
424     current = current->next;
425   }
426
427   if (current == NULL)
428     THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
429
430   if (previous != NULL) {
431     previous->next = current->next;
432   } else {
433     dict->table[hash_code & dict->table_size] = current->next;
434   }
435
436   if (!dict->table[hash_code & dict->table_size])
437     dict->fill--;
438
439   xbt_dictelm_free(current);
440   dict->count--;
441 }
442
443 /**
444  * \brief Remove data from the dict (null-terminated key)
445  *
446  * \param dict the dict
447  * \param key the key of the data to be removed
448  *
449  * Remove the entry associated with the given \a key
450  */
451 void xbt_dict_remove(xbt_dict_t dict, const char *key) {
452   xbt_dict_remove_ext(dict, key, strlen(key));
453 }
454
455 /**
456  * \brief Remove all data from the dict
457  * \param dict the dict
458  */
459 void xbt_dict_reset(xbt_dict_t dict) {
460
461   int i;
462   xbt_dictelm_t current, previous = NULL;
463
464   xbt_assert(dict);
465
466   if (dict->count == 0)
467     return;
468
469   for (i = 0; i <= dict->table_size; i++) {
470     current = dict->table[i];
471     while (current != NULL) {
472       previous = current;
473       current = current->next;
474       xbt_dictelm_free(previous);
475     }
476     dict->table[i] = NULL;
477   }
478
479   dict->count = 0;
480   dict->fill = 0;
481 }
482
483 /**
484  * \brief Return the number of elements in the dict.
485  * \param dict a dictionary
486  */
487 int xbt_dict_length(xbt_dict_t dict) {
488   xbt_assert(dict);
489
490   return dict->count;
491 }
492
493 /**
494  * \brief Outputs the content of the structure (debugging purpose)
495  *
496  * \param dict the exibitionist
497  * \param output a function to dump each data in the tree
498  *
499  * Outputs the content of the structure. (for debugging purpose). \a output is a
500  * function to output the data. If NULL, data won't be displayed.
501  */
502
503 void xbt_dict_dump(xbt_dict_t     dict,
504                    void_f_pvoid_t output) {
505   int i;
506   xbt_dictelm_t element;
507   printf("Dict %p:\n", dict);
508   if (dict != NULL) {
509     for (i = 0; i < dict->table_size; i++) {
510       element = dict->table[i];
511       if (element) {
512         printf("[\n");
513         while (element != NULL) {
514           printf(" %s -> ", element->key);
515           if (output != NULL) {
516             (*output)(element->content);
517           }
518           printf("\n");
519           element = element->next;
520         }
521         printf("]\n");
522       } else {
523         printf("[]\n");
524       }
525     }
526   }
527 }
528
529 xbt_dynar_t all_sizes = NULL;
530 /** @brief shows some debugging info about the bucklet repartition */
531 void xbt_dict_dump_sizes(xbt_dict_t dict) {
532
533   int i;
534   unsigned int count;
535   unsigned int size;
536   xbt_dictelm_t element;
537   xbt_dynar_t sizes = xbt_dynar_new(sizeof(int),NULL);
538
539   printf("Dict %p: %d bucklets, %d used cells (of %d) ", dict, dict->count, dict->fill,dict->table_size);
540   if (dict != NULL) {
541     for (i = 0; i < dict->table_size; i++) {
542       element = dict->table[i];
543       size = 0;
544       if (element) {
545         while (element != NULL) {
546           size ++;
547           element = element->next;
548         }
549       }
550       if (xbt_dynar_length(sizes) <= size) {
551         int prevsize = 1;
552         xbt_dynar_set(sizes,size,&prevsize);
553       } else {
554         int prevsize;
555         xbt_dynar_get_cpy(sizes,size,&prevsize);
556         prevsize++;
557         xbt_dynar_set(sizes,size,&prevsize);
558       }
559     }
560     if (!all_sizes)
561       all_sizes = xbt_dynar_new(sizeof(int), NULL);
562
563     xbt_dynar_foreach(sizes,count,size) {
564       /* Copy values of this one into all_sizes */
565       int prevcount;
566       if (xbt_dynar_length(all_sizes) <= count) {
567         prevcount = size;
568         xbt_dynar_set(all_sizes,count,&prevcount);
569       } else {
570         xbt_dynar_get_cpy(all_sizes,count,&prevcount);
571         prevcount += size;
572         xbt_dynar_set(all_sizes,count,&prevcount);
573       }
574
575       /* Report current sizes */
576       if (count==0)
577         continue;
578       if (size==0)
579         continue;
580       printf("%delm x %u cells; ",count,size);
581     }
582   }
583   printf("\n");
584   xbt_dynar_free(&sizes);
585 }
586
587 /**
588  * Destroy the dict mallocators.
589  * This is an internal XBT function called by xbt_exit().
590  */
591 void xbt_dict_exit(void) {
592   if (dict_mallocator != NULL) {
593     xbt_mallocator_free(dict_mallocator);
594     dict_mallocator = NULL;
595     xbt_mallocator_free(dict_elm_mallocator);
596     dict_elm_mallocator = NULL;
597   }
598   if (all_sizes) {
599     unsigned int count;
600     int size;
601     double avg = 0;
602     int total_count = 0;
603     printf("Overall stats:");
604     xbt_dynar_foreach(all_sizes,count,size) {
605       if (count==0)
606         continue;
607       if (size==0)
608         continue;
609       printf("%delm x %d cells; ",count,size);
610       avg += count * size;
611       total_count += size;
612     }
613     printf("; %f elm per cell\n",avg/(double)total_count);
614   }
615 }
616
617 static void* dict_mallocator_new_f(void) {
618   return xbt_new(s_xbt_dict_t, 1);
619 }
620
621 static void dict_mallocator_free_f(void* dict) {
622   xbt_free(dict);
623 }
624
625 static void dict_mallocator_reset_f(void* dict) {
626   /* nothing to do because all fields are
627    * initialized in xbt_dict_new
628    */
629 }
630
631 #ifdef SIMGRID_TEST
632 #include "xbt.h"
633 #include "xbt/ex.h"
634 #include "portable.h"
635
636 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
637 XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
638
639 XBT_TEST_SUITE("dict","Dict data container");
640
641 static void print_str(void *str) {
642   printf("%s",(char*)PRINTF_STR(str));
643 }
644
645 static void debuged_add_ext(xbt_dict_t head,const char*key,const char*data_to_fill) {
646   char *data=xbt_strdup(data_to_fill);
647
648   xbt_test_log2("Add %s under %s",PRINTF_STR(data_to_fill),PRINTF_STR(key));
649
650   xbt_dict_set(head,key,data,&free);
651   if (XBT_LOG_ISENABLED(xbt_dict,xbt_log_priority_debug)) {
652     xbt_dict_dump(head,(void (*)(void*))&printf);
653     fflush(stdout);
654   }
655 }
656 static void debuged_add(xbt_dict_t head,const char*key) {
657   debuged_add_ext(head,key,key);
658 }
659
660 static void fill(xbt_dict_t *head) {
661   xbt_test_add0("Fill in the dictionnary");
662
663   *head = xbt_dict_new();
664   debuged_add(*head,"12");
665   debuged_add(*head,"12a");
666   debuged_add(*head,"12b");
667   debuged_add(*head,"123");
668   debuged_add(*head,"123456");
669   /* Child becomes child of what to add */
670   debuged_add(*head,"1234");
671   /* Need of common ancestor */
672   debuged_add(*head,"123457");
673 }
674
675
676 static void search_ext(xbt_dict_t head,const char*key, const char *data) {
677   void *found;
678
679   xbt_test_add1("Search %s",key);
680   found=xbt_dict_get(head,key);
681   xbt_test_log1("Found %s",(char *)found);
682   if (data)
683     xbt_test_assert1(found,"data do not match expectations: found NULL while searching for %s",data);
684   if (found)
685     xbt_test_assert2(!strcmp((char*)data,found),"data do not match expectations: found %s while searching for %s", (char*)found, data);
686 }
687
688 static void search(xbt_dict_t head,const char*key) {
689   search_ext(head,key,key);
690 }
691
692 static void debuged_remove(xbt_dict_t head,const char*key) {
693
694   xbt_test_add1("Remove '%s'",PRINTF_STR(key));
695   xbt_dict_remove(head,key);
696   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
697 }
698
699
700 static void traverse(xbt_dict_t head) {
701   xbt_dict_cursor_t cursor=NULL;
702   char *key;
703   char *data;
704   int i = 0;
705
706   xbt_dict_foreach(head,cursor,key,data) {
707     if (!key || !data || strcmp(key,data)) {
708       xbt_test_log3("Seen #%d:  %s->%s",++i,PRINTF_STR(key),PRINTF_STR(data));
709     } else {
710       xbt_test_log2("Seen #%d:  %s",++i,PRINTF_STR(key));
711     }
712     xbt_test_assert2(!data || !strcmp(key,data),
713                      "Key(%s) != value(%s). Aborting",key,data);
714   }
715 }
716
717 static void search_not_found(xbt_dict_t head, const char *data) {
718   int ok=0;
719   xbt_ex_t e;
720
721   xbt_test_add1("Search %s (expected not to be found)",data);
722
723   TRY {
724     data = xbt_dict_get(head, data);
725     THROW1(unknown_error,0,"Found something which shouldn't be there (%s)",data);
726   } CATCH(e) {
727     if (e.category != not_found_error)
728       xbt_test_exception(e);
729     xbt_ex_free(e);
730     ok=1;
731   }
732   xbt_test_assert0(ok,"Exception not raised");
733 }
734
735 static void count(xbt_dict_t dict, int length) {
736   xbt_dict_cursor_t cursor;
737   char *key;
738   void *data;
739   int effective = 0;
740
741
742   xbt_test_add1("Count elements (expecting %d)", length);
743   xbt_test_assert2(xbt_dict_length(dict) == length, "Announced length(%d) != %d.", xbt_dict_length(dict), length);
744
745   xbt_dict_foreach(dict,cursor,key,data) {
746     effective++;
747   }
748   xbt_test_assert2(effective == length, "Effective length(%d) != %d.", effective, length);
749 }
750
751 xbt_ex_t e;
752 xbt_dict_t head=NULL;
753 char *data;
754
755
756 XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse"){
757   xbt_test_add0("Traversal the null dictionary");
758   traverse(head);
759
760   xbt_test_add0("Traversal and search the empty dictionary");
761   head = xbt_dict_new();
762   traverse(head);
763   TRY {
764     debuged_remove(head,"12346");
765   } CATCH(e) {
766     if (e.category != not_found_error)
767       xbt_test_exception(e);
768     xbt_ex_free(e);
769   }
770   xbt_dict_free(&head);
771
772   xbt_test_add0("Traverse the full dictionary");
773   fill(&head);
774   count(head, 7);
775
776   debuged_add_ext(head,"toto","tutu");
777   search_ext(head,"toto","tutu");
778   debuged_remove(head,"toto");
779
780   search(head,"12a");
781   traverse(head);
782
783   xbt_test_add0("Free the dictionary (twice)");
784   xbt_dict_free(&head);
785   xbt_dict_free(&head);
786
787   /* CHANGING */
788   fill(&head);
789   count(head, 7);
790   xbt_test_add0("Change 123 to 'Changed 123'");
791   xbt_dict_set(head,"123",strdup("Changed 123"),&free);
792   count(head, 7);
793
794   xbt_test_add0("Change 123 back to '123'");
795   xbt_dict_set(head,"123",strdup("123"),&free);
796   count(head, 7);
797
798   xbt_test_add0("Change 12a to 'Dummy 12a'");
799   xbt_dict_set(head,"12a",strdup("Dummy 12a"),&free);
800   count(head, 7);
801
802   xbt_test_add0("Change 12a to '12a'");
803   xbt_dict_set(head,"12a",strdup("12a"),&free);
804   count(head, 7);
805
806   xbt_test_add0("Traverse the resulting dictionary");
807   traverse(head);
808
809   /* RETRIEVE */
810   xbt_test_add0("Search 123");
811   data = xbt_dict_get(head,"123");
812   xbt_test_assert(data);
813   xbt_test_assert(!strcmp("123",data));
814
815   search_not_found(head,"Can't be found");
816   search_not_found(head,"123 Can't be found");
817   search_not_found(head,"12345678 NOT");
818
819   search(head,"12a");
820   search(head,"12b");
821   search(head,"12");
822   search(head,"123456");
823   search(head,"1234");
824   search(head,"123457");
825
826   xbt_test_add0("Traverse the resulting dictionary");
827   traverse(head);
828
829   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
830
831   xbt_test_add0("Free the dictionary twice");
832   xbt_dict_free(&head);
833   xbt_dict_free(&head);
834
835   xbt_test_add0("Traverse the resulting dictionary");
836   traverse(head);
837 }
838
839 XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
840   fill(&head);
841   count(head, 7);
842   xbt_test_add0("Remove non existing data");
843   TRY {
844     debuged_remove(head,"Does not exist");
845   } CATCH(e) {
846     if (e.category != not_found_error)
847       xbt_test_exception(e);
848     xbt_ex_free(e);
849   }
850   traverse(head);
851
852   xbt_dict_free(&head);
853
854   xbt_test_add0("Remove each data manually (traversing the resulting dictionary each time)");
855   fill(&head);
856   debuged_remove(head,"12a");    traverse(head);
857   count(head, 6);
858   debuged_remove(head,"12b");    traverse(head);
859   count(head, 5);
860   debuged_remove(head,"12");     traverse(head);
861   count(head, 4);
862   debuged_remove(head,"123456"); traverse(head);
863   count(head, 3);
864   TRY {
865     debuged_remove(head,"12346");
866   } CATCH(e) {
867     if (e.category != not_found_error)
868       xbt_test_exception(e);
869     xbt_ex_free(e);
870     traverse(head);
871   }
872   debuged_remove(head,"1234");   traverse(head);
873   debuged_remove(head,"123457"); traverse(head);
874   debuged_remove(head,"123");    traverse(head);
875   TRY {
876     debuged_remove(head,"12346");
877   } CATCH(e) {
878     if (e.category != not_found_error)
879       xbt_test_exception(e);
880     xbt_ex_free(e);
881   }                              traverse(head);
882
883   xbt_test_add0("Free dict, create new fresh one, and then reset the dict");
884   xbt_dict_free(&head);
885   fill(&head);
886   xbt_dict_reset(head);
887   count(head, 0);
888   traverse(head);
889
890   xbt_test_add0("Free the dictionary twice");
891   xbt_dict_free(&head);
892   xbt_dict_free(&head);
893 }
894
895 XBT_TEST_UNIT("nulldata",test_dict_nulldata,"NULL data management"){
896   fill(&head);
897
898   xbt_test_add0("Store NULL under 'null'");
899   xbt_dict_set(head,"null",NULL,NULL);
900   search_ext(head,"null",NULL);
901
902   xbt_test_add0("Check whether I see it while traversing...");
903   {
904     xbt_dict_cursor_t cursor=NULL;
905     char *key;
906     int found=0;
907
908     xbt_dict_foreach(head,cursor,key,data) {
909       if (!key || !data || strcmp(key,data)) {
910         xbt_test_log2("Seen:  %s->%s",PRINTF_STR(key),PRINTF_STR(data));
911       } else {
912         xbt_test_log1("Seen:  %s",PRINTF_STR(key));
913       }
914
915       if (!strcmp(key,"null"))
916         found = 1;
917     }
918     xbt_test_assert0(found,"the key 'null', associated to NULL is not found");
919   }
920   xbt_dict_free(&head);
921 }
922
923 #define NB_ELM 20000
924 #define SIZEOFKEY 1024
925 static int countelems(xbt_dict_t head) {
926   xbt_dict_cursor_t cursor;
927   char *key;
928   void *data;
929   int res = 0;
930
931   xbt_dict_foreach(head,cursor,key,data) {
932     res++;
933   }
934   return res;
935 }
936
937 XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
938   xbt_dict_t head=NULL;
939   int i,j,k, nb;
940   char *key;
941   void *data;
942
943   srand((unsigned int)time(NULL));
944
945   for (i=0;i<10;i++) {
946     xbt_test_add2("CRASH test number %d (%d to go)",i+1,10-i-1);
947     xbt_test_log0("Fill the struct, count its elems and frees the structure");
948     xbt_test_log1("using 1000 elements with %d chars long randomized keys.",SIZEOFKEY);
949     head=xbt_dict_new();
950     /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
951     nb=0;
952     for (j=0;j<1000;j++) {
953       char *data = NULL;
954       key=xbt_malloc(SIZEOFKEY);
955
956       do {
957         for (k=0;k<SIZEOFKEY-1;k++)
958           key[k]=rand() % ('z' - 'a') + 'a';
959         key[k]='\0';
960         /*      printf("[%d %s]\n",j,key); */
961         data = xbt_dict_get_or_null(head,key);
962       } while (data != NULL);
963
964       xbt_dict_set(head,key,key,&free);
965       data = xbt_dict_get(head,key);
966       xbt_test_assert2(!strcmp(key,data), "Retrieved value (%s) != Injected value (%s)",key,data);
967
968       count(head,j+1);
969     }
970     /*    xbt_dict_dump(head,(void (*)(void*))&printf); */
971     traverse(head);
972     xbt_dict_free(&head);
973     xbt_dict_free(&head);
974   }
975
976
977   head=xbt_dict_new();
978   xbt_test_add1("Fill %d elements, with keys being the number of element",NB_ELM);
979   for (j=0;j<NB_ELM;j++) {
980     /* if (!(j%1000)) { printf("."); fflush(stdout); } */
981
982     key = xbt_malloc(10);
983
984     sprintf(key,"%d",j);
985     xbt_dict_set(head,key,key,&free);
986   }
987   /*xbt_dict_dump(head,(void (*)(void*))&printf);*/
988
989   xbt_test_add0("Count the elements (retrieving the key and data for each)");
990   i = countelems(head);
991   xbt_test_log1("There is %d elements",i);
992
993   xbt_test_add1("Search my %d elements 20 times",NB_ELM);
994   key=xbt_malloc(10);
995   for (i=0;i<20;i++) {
996     /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
997     for (j=0;j<NB_ELM;j++) {
998
999       sprintf(key,"%d",j);
1000       data = xbt_dict_get(head,key);
1001       xbt_test_assert2(!strcmp(key,(char*)data),
1002                        "with get, key=%s != data=%s",key,(char*)data);
1003       data = xbt_dict_get_ext(head,key,strlen(key));
1004       xbt_test_assert2(!strcmp(key,(char*)data),
1005                        "with get_ext, key=%s != data=%s",key,(char*)data);
1006     }
1007   }
1008   free(key);
1009
1010   xbt_test_add1("Remove my %d elements",NB_ELM);
1011   key=xbt_malloc(10);
1012   for (j=0;j<NB_ELM;j++) {
1013     /* if (!(j%10000)) printf("."); fflush(stdout); */
1014
1015     sprintf(key,"%d",j);
1016     xbt_dict_remove(head,key);
1017   }
1018   free(key);
1019
1020
1021   xbt_test_add0("Free the structure (twice)");
1022   xbt_dict_free(&head);
1023   xbt_dict_free(&head);
1024 }
1025
1026 static void str_free(void *s) {
1027   char *c=*(char**)s;
1028   free(c);
1029 }
1030
1031 XBT_TEST_UNIT("multicrash",test_dict_multicrash,"Multi-dict crash test"){
1032
1033 #undef NB_ELM
1034 #define NB_ELM 100 /*00*/
1035 #define DEPTH 5
1036 #define KEY_SIZE 512
1037 #define NB_TEST 20 /*20*/
1038   int verbose=0;
1039
1040   xbt_dict_t mdict = NULL;
1041   int i,j,k,l;
1042   xbt_dynar_t keys = xbt_dynar_new(sizeof(char*),str_free);
1043   void *data;
1044   char *key;
1045
1046
1047   xbt_test_add0("Generic multicache CRASH test");
1048   xbt_test_log4(" Fill the struct and frees it %d times, using %d elements, "
1049                 "depth of multicache=%d, key size=%d",
1050                 NB_TEST,NB_ELM,DEPTH,KEY_SIZE);
1051
1052   for (l=0 ; l<DEPTH ; l++) {
1053     key=xbt_malloc(KEY_SIZE);
1054     xbt_dynar_push(keys,&key);
1055   }
1056
1057   for (i=0;i<NB_TEST;i++) {
1058     mdict = xbt_dict_new();
1059     VERB1("mdict=%p",mdict);
1060     if (verbose>0)
1061       printf("Test %d\n",i);
1062     /* else if (i%10) printf("."); else printf("%d",i/10);*/
1063
1064     for (j=0;j<NB_ELM;j++) {
1065       if (verbose>0) printf ("  Add {");
1066
1067       for (l=0 ; l<DEPTH ; l++) {
1068         key=*(char**)xbt_dynar_get_ptr(keys,l);
1069
1070         for (k=0;k<KEY_SIZE-1;k++)
1071           key[k]=rand() % ('z' - 'a') + 'a';
1072
1073         key[k]='\0';
1074
1075         if (verbose>0) printf("%p=%s %s ",key, key,(l<DEPTH-1?";":"}"));
1076       }
1077       if (verbose>0) printf("in multitree %p.\n",mdict);
1078
1079       xbt_multidict_set(mdict,keys,xbt_strdup(key),free);
1080
1081       data = xbt_multidict_get(mdict,keys);
1082
1083       xbt_test_assert2(data && !strcmp((char*)data,key),
1084                        "Retrieved value (%s) does not match the given one (%s)\n",
1085                        (char*)data,key);
1086     }
1087     xbt_dict_free(&mdict);
1088   }
1089
1090   xbt_dynar_free(&keys);
1091
1092   /*  if (verbose>0)
1093     xbt_dict_dump(mdict,&xbt_dict_print);*/
1094
1095   xbt_dict_free(&mdict);
1096   xbt_dynar_free(&keys);
1097
1098 }
1099 #endif /* SIMGRID_TEST */