3 /* dict - a generic dictionnary, variation over the B-tree concept */
5 /* Copyright (c) 2003,2004 Martin Quinson. All rights reserved. */
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. */
14 #include "xbt/mallocator.h"
15 #include "xbt_modinter.h"
16 #include "dict_private.h"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict,xbt,
19 "Dictionaries provide the same functionnalities than hash tables");
20 /*####[ Private prototypes ]#################################################*/
22 static xbt_mallocator_t dict_mallocator = NULL;
23 static void* dict_mallocator_new_f(void);
24 static void dict_mallocator_free_f(void* dict);
25 static void dict_mallocator_reset_f(void* dict);
28 /*####[ Code ]###############################################################*/
32 * \return pointer to the destination
33 * \see xbt_dict_new_ext(), xbt_dict_free()
35 * Creates and initialize a new dictionnary with a default hashtable size.
37 xbt_dict_t xbt_dict_new(void) {
38 return xbt_dict_new_ext(256);
42 * \brief Create a new dictionary with the specified hashtable size
43 * \param hashsize the hashtable size
44 * \return a pointer to the created object
45 * \see xbt_dict_new(), xbt_dict_free()
47 xbt_dict_t xbt_dict_new_ext(int hashsize) {
50 if (dict_mallocator == NULL) {
52 dict_mallocator = xbt_mallocator_new(256,
53 dict_mallocator_new_f,
54 dict_mallocator_free_f,
55 dict_mallocator_reset_f);
56 dict_elm_mallocator = xbt_mallocator_new(256,
57 dict_elm_mallocator_new_f,
58 dict_elm_mallocator_free_f,
59 dict_elm_mallocator_reset_f);
62 dict = xbt_mallocator_get(dict_mallocator);
63 dict->table_size = hashsize;
64 dict->table = xbt_new0(xbt_dictelm_t, dict->table_size);
72 * \param dict the dictionnary to be freed
74 * Frees a dictionary with all the data
76 void xbt_dict_free(xbt_dict_t *dict) {
78 xbt_dictelm_t current, previous;
82 if (dict != NULL && *dict != NULL) {
83 table_size = (*dict)->table_size;
84 table = (*dict)->table;
85 for (i = 0; i < table_size; i++) {
87 while (current != NULL) {
89 current = current->next;
90 xbt_dictelm_free(previous);
94 xbt_mallocator_release(dict_mallocator, *dict);
100 * \brief Change the hashtable size
101 * \param dict a dictionary
102 * \param hashsize the new hashtable size
104 * Change the hashtable size is a long operation, so it's better
105 * to use xbt_dict_new_ext or to call xbt_dict_hashsize_set when
106 * the dictionary is empty.
108 void xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize) {
109 xbt_dict_t new_dict = xbt_dict_new_ext(hashsize);
110 xbt_dictelm_t element, next;
113 for (i = 0; i < dict->table_size; i++) {
114 element = dict->table[i];
115 while (element != NULL) {
116 next = element->next; /* save the next because it will be lost */
117 xbt_dict_add_element(new_dict, element); /* no new xbt_dictelm_t is mallocated */
122 xbt_free(dict->table);
123 dict->table = new_dict->table;
124 dict->table_size = hashsize;
129 * Returns the hash code of a string.
131 static unsigned int xbt_dict_hash_ext(const char *str, int str_len) {
132 /* fast implementation of djb2 algorithm */
133 unsigned int hash = 5381;
138 hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
144 static unsigned int xbt_dict_hash(const char *str) {
145 /* fast implementation of djb2 algorithm */
146 unsigned int hash = 5381;
149 while ( (c = *str++) ) {
150 hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
157 * \brief Add data to the dict (arbitrary key)
158 * \param dict the container
159 * \param key the key to set the new data
160 * \param key_len the size of the \a key
161 * \param data the data to add in the dict
162 * \param free_ctn function to call with (\a key as argument) when
163 * \a key is removed from the dictionnary
165 * Set the \a data in the structure under the \a key, which can be any kind
166 * of data, as long as its length is provided in \a key_len.
168 void xbt_dict_set_ext(xbt_dict_t dict,
172 void_f_pvoid_t *free_ctn) {
174 unsigned int hash_code;
175 xbt_dictelm_t current, previous = NULL;
178 hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
180 current = dict->table[hash_code];
181 while (current != NULL &&
182 (key_len != current->key_len || strncmp(key, current->key, key_len))) {
184 current = current->next;
187 if (current == NULL) {
188 /* this key doesn't exist yet */
189 current = xbt_dictelm_new(key, key_len, data, free_ctn, NULL);
190 if (previous == NULL) {
191 dict->table[hash_code] = current;
194 previous->next = current;
199 /* there is already an element with the same key: we overwrite it */
200 if (current->content != NULL && current->free_f != NULL) {
201 current->free_f(current->content);
203 current->content = data;
204 current->free_f = free_ctn;
209 * \brief Add data to the dict (null-terminated key)
211 * \param dict the dict
212 * \param key the key to set the new data
213 * \param data the data to add in the dict
214 * \param free_ctn function to call with (\a key as argument) when
215 * \a key is removed from the dictionnary
217 * set the \a data in the structure under the \a key, which is a
218 * null terminated string.
220 void xbt_dict_set(xbt_dict_t dict,
223 void_f_pvoid_t *free_ctn) {
227 xbt_dict_set_ext(dict, key, strlen(key), data, free_ctn);
231 * \brief Retrieve data from the dict (arbitrary key)
233 * \param dict the dealer of data
234 * \param key the key to find data
235 * \param key_len the size of the \a key
236 * \return the data that we are looking for
238 * Search the given \a key. Throws not_found_error when not found.
240 void *xbt_dict_get_ext(xbt_dict_t dict,
245 unsigned int hash_code;
246 xbt_dictelm_t current;
250 hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
252 current = dict->table[hash_code];
253 while (current != NULL &&
254 (key_len != current->key_len || strncmp(key, current->key, key_len))) {
255 current = current->next;
258 if (current == NULL) {
259 THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
262 return current->content;
266 * \brief Retrieve data from the dict (null-terminated key)
268 * \param dict the dealer of data
269 * \param key the key to find data
270 * \return the data that we are looking for
272 * Search the given \a key. Throws not_found_error when not found.
273 * Check xbt_dict_get_or_null() for a version returning NULL without exception when
276 void *xbt_dict_get(xbt_dict_t dict,
280 unsigned int hash_code ;
281 xbt_dictelm_t current;
285 hash_code = xbt_dict_hash(key) % dict->table_size;
287 current = dict->table[hash_code];
288 while (current != NULL && (strcmp(key, current->key))) {
289 current = current->next;
292 if (current == NULL) {
293 THROW1(not_found_error, 0, "key %s not found", key);
296 return current->content;
300 * \brief like xbt_dict_get(), but returning NULL when not found
302 void *xbt_dict_get_or_null(xbt_dict_t dict,
307 result = xbt_dict_get(dict, key);
309 if (e.category != not_found_error)
319 * \brief Remove data from the dict (arbitrary key)
321 * \param dict the trash can
322 * \param key the key of the data to be removed
323 * \param key_len the size of the \a key
325 * Remove the entry associated with the given \a key (throws not_found)
327 void xbt_dict_remove_ext(xbt_dict_t dict,
332 unsigned int hash_code ;
333 xbt_dictelm_t current, previous = NULL;
337 hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
339 current = dict->table[hash_code];
340 while (current != NULL &&
341 (key_len != current->key_len || strncmp(key, current->key, key_len))) {
342 previous = current; /* save the previous node */
343 current = current->next;
346 if (current == NULL) {
347 THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
350 if (previous != NULL) {
351 xbt_assert0(previous->next == current, "previous-next != current");
352 previous->next = current->next;
355 dict->table[hash_code] = current->next;
358 xbt_dictelm_free(current);
363 * \brief Remove data from the dict (null-terminated key)
365 * \param dict the dict
366 * \param key the key of the data to be removed
368 * Remove the entry associated with the given \a key
370 void xbt_dict_remove(xbt_dict_t dict,
374 xbt_dict_remove_ext(dict, key, strlen(key));
378 * \brief Remove all data from the dict
379 * \param dict the dict
381 void xbt_dict_reset(xbt_dict_t dict) {
385 xbt_dictelm_t current, previous = NULL;
389 if (dict->count == 0)
392 for (i = 0; i < dict->table_size; i++) {
393 current = dict->table[i];
394 while (current != NULL) {
396 current = current->next;
397 xbt_dictelm_free(previous);
399 dict->table[i] = NULL;
406 * \brief Return the number of elements in the dict.
407 * \param dict a dictionary
409 int xbt_dict_length(xbt_dict_t dict) {
416 * Add an already mallocated element to a dictionary.
418 void xbt_dict_add_element(xbt_dict_t dict, xbt_dictelm_t element) {
425 hashcode = xbt_dict_hash_ext(element->key,element->key_len) % dict->table_size;
426 element->next = dict->table[hashcode];
427 dict->table[hashcode] = element;
431 * \brief Outputs the content of the structure (debuging purpose)
433 * \param dict the exibitionist
434 * \param output a function to dump each data in the tree
436 * Ouputs the content of the structure. (for debuging purpose). \a ouput is a
437 * function to output the data. If NULL, data won't be displayed.
440 void xbt_dict_dump(xbt_dict_t dict,
441 void_f_pvoid_t *output) {
443 xbt_dictelm_t element;
444 printf("Dict %p:\n", dict);
446 for (i = 0; i < dict->table_size; i++) {
447 element = dict->table[i];
448 while (element != NULL) {
449 printf("%s -> ", element->key);
450 if (output != NULL) {
451 output(element->content);
454 element = element->next;
461 * Destroy the dict mallocators.
462 * This is an internal XBT function called by xbt_exit().
464 void xbt_dict_exit(void) {
465 if (dict_mallocator != NULL) {
466 xbt_mallocator_free(dict_mallocator);
467 xbt_mallocator_free(dict_elm_mallocator);
471 static void* dict_mallocator_new_f(void) {
472 return xbt_new(s_xbt_dict_t, 1);
475 static void dict_mallocator_free_f(void* dict) {
479 static void dict_mallocator_reset_f(void* dict) {
480 /* nothing to do because all fields are
481 * initialized in xbt_dict_new
488 #include "portable.h"
490 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
491 XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
493 XBT_TEST_SUITE("dict","Dict data container");
495 static void print_str(void *str) {
496 printf("%s",(char*)PRINTF_STR(str));
499 static void debuged_add_ext(xbt_dict_t head,const char*key,const char*data_to_fill) {
500 char *data=xbt_strdup(data_to_fill);
502 xbt_test_log2("Add %s under %s",PRINTF_STR(data_to_fill),PRINTF_STR(key));
504 xbt_dict_set(head,key,data,&free);
505 if (XBT_LOG_ISENABLED(xbt_dict,xbt_log_priority_debug)) {
506 xbt_dict_dump(head,(void (*)(void*))&printf);
510 static void debuged_add(xbt_dict_t head,const char*key) {
511 debuged_add_ext(head,key,key);
514 static void fill(xbt_dict_t *head) {
515 xbt_test_add0("Fill in the dictionnary");
517 *head = xbt_dict_new();
518 debuged_add(*head,"12");
519 debuged_add(*head,"12a");
520 debuged_add(*head,"12b");
521 debuged_add(*head,"123");
522 debuged_add(*head,"123456");
523 /* Child becomes child of what to add */
524 debuged_add(*head,"1234");
525 /* Need of common ancestor */
526 debuged_add(*head,"123457");
530 static void search_ext(xbt_dict_t head,const char*key, const char *data) {
533 xbt_test_add1("Search %s",key);
534 found=xbt_dict_get(head,key);
535 xbt_test_log1("Found %s",(char *)found);
537 xbt_test_assert1(found,"data do not match expectations: found NULL while searching for %s",data);
539 xbt_test_assert2(!strcmp((char*)data,found),"data do not match expectations: found %s while searching for %s", (char*)found, data);
542 static void search(xbt_dict_t head,const char*key) {
543 search_ext(head,key,key);
546 static void debuged_remove(xbt_dict_t head,const char*key) {
548 xbt_test_add1("Remove '%s'",PRINTF_STR(key));
549 xbt_dict_remove(head,key);
550 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
554 static void traverse(xbt_dict_t head) {
555 xbt_dict_cursor_t cursor=NULL;
559 xbt_dict_foreach(head,cursor,key,data) {
560 xbt_test_log2("Seen: %s->%s",PRINTF_STR(key),PRINTF_STR(data));
561 xbt_test_assert2(!data || !strcmp(key,data),
562 "Key(%s) != value(%s). Abording\n",key,data);
566 static void search_not_found(xbt_dict_t head, const char *data) {
570 xbt_test_add1("Search %s (expected not to be found)",data);
573 data = xbt_dict_get(head, data);
574 THROW1(unknown_error,0,"Found something which shouldn't be there (%s)",data);
576 if (e.category != not_found_error)
577 xbt_test_exception(e);
581 xbt_test_assert0(ok,"Exception not raised");
584 static void count(xbt_dict_t dict, int length) {
585 xbt_test_add1("Count elements (expecting %d)", length);
586 xbt_test_assert2(xbt_dict_length(dict) == length, "Length(%d) != %d.", xbt_dict_length(dict), length);
590 xbt_dict_t head=NULL;
594 XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse"){
595 xbt_test_add0("Traversal the null dictionnary");
598 xbt_test_add0("Traversal and search the empty dictionnary");
599 head = xbt_dict_new();
602 debuged_remove(head,"12346");
604 if (e.category != not_found_error)
605 xbt_test_exception(e);
608 xbt_dict_free(&head);
610 xbt_test_add0("Traverse the full dictionnary");
614 debuged_add_ext(head,"toto","tutu");
615 search_ext(head,"toto","tutu");
616 debuged_remove(head,"toto");
621 xbt_test_add0("Free the dictionnary (twice)");
622 xbt_dict_free(&head);
623 xbt_dict_free(&head);
628 xbt_test_add0("Change 123 to 'Changed 123'");
629 xbt_dict_set(head,"123",strdup("Changed 123"),&free);
632 xbt_test_add0("Change 123 back to '123'");
633 xbt_dict_set(head,"123",strdup("123"),&free);
636 xbt_test_add0("Change 12a to 'Dummy 12a'");
637 xbt_dict_set(head,"12a",strdup("Dummy 12a"),&free);
640 xbt_test_add0("Change 12a to '12a'");
641 xbt_dict_set(head,"12a",strdup("12a"),&free);
644 xbt_test_add0("Traverse the resulting dictionnary");
648 xbt_test_add0("Search 123");
649 data = xbt_dict_get(head,"123");
650 xbt_test_assert(data);
651 xbt_test_assert(!strcmp("123",data));
653 search_not_found(head,"Can't be found");
654 search_not_found(head,"123 Can't be found");
655 search_not_found(head,"12345678 NOT");
660 search(head,"123456");
662 search(head,"123457");
664 xbt_test_add0("Traverse the resulting dictionnary");
667 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
669 xbt_test_add0("Free the dictionnary twice");
670 xbt_dict_free(&head);
671 xbt_dict_free(&head);
673 xbt_test_add0("Traverse the resulting dictionnary");
677 XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
680 xbt_test_add0("Remove non existing data");
682 debuged_remove(head,"Does not exist");
684 if (e.category != not_found_error)
685 xbt_test_exception(e);
690 xbt_dict_free(&head);
692 xbt_test_add0("Remove each data manually (traversing the resulting dictionnary each time)");
694 debuged_remove(head,"12a"); traverse(head);
696 debuged_remove(head,"12b"); traverse(head);
698 debuged_remove(head,"12"); traverse(head);
700 debuged_remove(head,"123456"); traverse(head);
703 debuged_remove(head,"12346");
705 if (e.category != not_found_error)
706 xbt_test_exception(e);
710 debuged_remove(head,"1234"); traverse(head);
711 debuged_remove(head,"123457"); traverse(head);
712 debuged_remove(head,"123"); traverse(head);
714 debuged_remove(head,"12346");
716 if (e.category != not_found_error)
717 xbt_test_exception(e);
721 xbt_test_add0("Remove all values");
722 xbt_dict_free(&head);
724 xbt_dict_reset(head);
728 xbt_test_add0("Free the dictionnary twice");
729 xbt_dict_free(&head);
730 xbt_dict_free(&head);
733 XBT_TEST_UNIT("nulldata",test_dict_nulldata,"NULL data management"){
736 xbt_test_add0("Store NULL under 'null'");
737 xbt_dict_set(head,"null",NULL,NULL);
738 search_ext(head,"null",NULL);
740 xbt_test_add0("Check whether I see it while traversing...");
742 xbt_dict_cursor_t cursor=NULL;
746 xbt_dict_foreach(head,cursor,key,data) {
747 xbt_test_log2("Seen: %s->%s",PRINTF_STR(key),PRINTF_STR(data));
748 if (!strcmp(key,"null"))
751 xbt_test_assert0(found,"the key 'null', associated to NULL is not found");
753 xbt_dict_free(&head);
757 #define SIZEOFKEY 1024
758 static int countelems(xbt_dict_t head) {
759 xbt_dict_cursor_t cursor;
764 xbt_dict_foreach(head,cursor,key,data) {
770 XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
771 xbt_dict_t head=NULL;
776 srand((unsigned int)time(NULL));
778 xbt_test_add0("CRASH test");
779 xbt_test_log0("Fill the struct, count its elems and frees the structure (x10)");
780 xbt_test_log1("using 1000 elements with %d chars long randomized keys.",SIZEOFKEY);
784 /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
786 for (j=0;j<1000;j++) {
787 key=xbt_malloc(SIZEOFKEY);
789 for (k=0;k<SIZEOFKEY-1;k++)
790 key[k]=rand() % ('z' - 'a') + 'a';
792 /* printf("[%d %s]\n",j,key); */
793 xbt_dict_set(head,key,key,&free);
795 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
796 nb = countelems(head);
797 xbt_test_assert1(nb == 1000,"found %d elements instead of 1000",nb);
799 xbt_dict_free(&head);
800 xbt_dict_free(&head);
805 xbt_test_add1("Fill %d elements, with keys being the number of element",NB_ELM);
806 for (j=0;j<NB_ELM;j++) {
807 /* if (!(j%1000)) { printf("."); fflush(stdout); } */
809 key = xbt_malloc(10);
812 xbt_dict_set(head,key,key,&free);
815 xbt_test_add0("Count the elements (retrieving the key and data for each)");
816 i = countelems(head);
817 xbt_test_log1("There is %d elements",i);
819 xbt_test_add1("Search my %d elements 20 times",NB_ELM);
822 /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
823 for (j=0;j<NB_ELM;j++) {
826 data = xbt_dict_get(head,key);
827 xbt_test_assert2(!strcmp(key,(char*)data),
828 "key=%s != data=%s\n",key,(char*)data);
833 xbt_test_add1("Remove my %d elements",NB_ELM);
835 for (j=0;j<NB_ELM;j++) {
836 /* if (!(j%10000)) printf("."); fflush(stdout); */
839 xbt_dict_remove(head,key);
844 xbt_test_add0("Free the structure (twice)");
845 xbt_dict_free(&head);
846 xbt_dict_free(&head);
849 static void str_free(void *s) {
854 XBT_TEST_UNIT("multicrash",test_dict_multicrash,"Multi-dict crash test"){
857 #define NB_ELM 100 /*00*/
860 #define NB_TEST 20 /*20*/
863 xbt_dict_t mdict = NULL;
865 xbt_dynar_t keys = xbt_dynar_new(sizeof(char*),str_free);
870 xbt_test_add0("Generic multicache CRASH test");
871 xbt_test_log4(" Fill the struct and frees it %d times, using %d elements, "
872 "depth of multicache=%d, key size=%d",
873 NB_TEST,NB_ELM,DEPTH,KEY_SIZE);
875 for (l=0 ; l<DEPTH ; l++) {
876 key=xbt_malloc(KEY_SIZE);
877 xbt_dynar_push(keys,&key);
880 for (i=0;i<NB_TEST;i++) {
881 mdict = xbt_dict_new();
882 VERB1("mdict=%p",mdict);
884 printf("Test %d\n",i);
885 /* else if (i%10) printf("."); else printf("%d",i/10);*/
887 for (j=0;j<NB_ELM;j++) {
888 if (verbose>0) printf (" Add {");
890 for (l=0 ; l<DEPTH ; l++) {
891 key=*(char**)xbt_dynar_get_ptr(keys,l);
893 for (k=0;k<KEY_SIZE-1;k++)
894 key[k]=rand() % ('z' - 'a') + 'a';
898 if (verbose>0) printf("%p=%s %s ",key, key,(l<DEPTH-1?";":"}"));
900 if (verbose>0) printf("in multitree %p.\n",mdict);
902 xbt_multidict_set(mdict,keys,xbt_strdup(key),free);
904 data = xbt_multidict_get(mdict,keys);
906 xbt_test_assert2(data && !strcmp((char*)data,key),
907 "Retrieved value (%s) does not match the entrered one (%s)\n",
910 xbt_dict_free(&mdict);
913 xbt_dynar_free(&keys);
916 xbt_dict_dump(mdict,&xbt_dict_print);*/
918 xbt_dict_free(&mdict);
919 xbt_dynar_free(&keys);
922 #endif /* SIMGRID_TEST */