Logo AND Algorithmique Numérique Distribuée

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