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,
304 unsigned int hash_code ;
305 xbt_dictelm_t current;
309 hash_code = xbt_dict_hash(key) % dict->table_size;
311 current = dict->table[hash_code];
312 while (current != NULL && (strcmp(key, current->key))) {
313 current = current->next;
319 return current->content;
324 * \brief Remove data from the dict (arbitrary key)
326 * \param dict the trash can
327 * \param key the key of the data to be removed
328 * \param key_len the size of the \a key
330 * Remove the entry associated with the given \a key (throws not_found)
332 void xbt_dict_remove_ext(xbt_dict_t dict,
337 unsigned int hash_code ;
338 xbt_dictelm_t current, previous = NULL;
342 hash_code = xbt_dict_hash_ext(key,key_len) % dict->table_size;
344 current = dict->table[hash_code];
345 while (current != NULL &&
346 (key_len != current->key_len || strncmp(key, current->key, key_len))) {
347 previous = current; /* save the previous node */
348 current = current->next;
351 if (current == NULL) {
352 THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
355 if (previous != NULL) {
356 xbt_assert0(previous->next == current, "previous-next != current");
357 previous->next = current->next;
360 dict->table[hash_code] = current->next;
363 xbt_dictelm_free(current);
368 * \brief Remove data from the dict (null-terminated key)
370 * \param dict the dict
371 * \param key the key of the data to be removed
373 * Remove the entry associated with the given \a key
375 void xbt_dict_remove(xbt_dict_t dict,
379 xbt_dict_remove_ext(dict, key, strlen(key));
383 * \brief Remove all data from the dict
384 * \param dict the dict
386 void xbt_dict_reset(xbt_dict_t dict) {
390 xbt_dictelm_t current, previous = NULL;
394 if (dict->count == 0)
397 for (i = 0; i < dict->table_size; i++) {
398 current = dict->table[i];
399 while (current != NULL) {
401 current = current->next;
402 xbt_dictelm_free(previous);
404 dict->table[i] = NULL;
411 * \brief Return the number of elements in the dict.
412 * \param dict a dictionary
414 int xbt_dict_length(xbt_dict_t dict) {
421 * Add an already mallocated element to a dictionary.
423 void xbt_dict_add_element(xbt_dict_t dict, xbt_dictelm_t element) {
430 hashcode = xbt_dict_hash_ext(element->key,element->key_len) % dict->table_size;
431 element->next = dict->table[hashcode];
432 dict->table[hashcode] = element;
436 * \brief Outputs the content of the structure (debuging purpose)
438 * \param dict the exibitionist
439 * \param output a function to dump each data in the tree
441 * Ouputs the content of the structure. (for debuging purpose). \a ouput is a
442 * function to output the data. If NULL, data won't be displayed.
445 void xbt_dict_dump(xbt_dict_t dict,
446 void_f_pvoid_t output) {
448 xbt_dictelm_t element;
449 printf("Dict %p:\n", dict);
451 for (i = 0; i < dict->table_size; i++) {
452 element = dict->table[i];
453 while (element != NULL) {
454 printf("%s -> ", element->key);
455 if (output != NULL) {
456 (*output)(element->content);
459 element = element->next;
466 * Destroy the dict mallocators.
467 * This is an internal XBT function called by xbt_exit().
469 void xbt_dict_exit(void) {
470 if (dict_mallocator != NULL) {
471 xbt_mallocator_free(dict_mallocator);
472 dict_mallocator = NULL;
473 xbt_mallocator_free(dict_elm_mallocator);
474 dict_elm_mallocator = NULL;
478 static void* dict_mallocator_new_f(void) {
479 return xbt_new(s_xbt_dict_t, 1);
482 static void dict_mallocator_free_f(void* dict) {
486 static void dict_mallocator_reset_f(void* dict) {
487 /* nothing to do because all fields are
488 * initialized in xbt_dict_new
495 #include "portable.h"
497 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
498 XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
500 XBT_TEST_SUITE("dict","Dict data container");
502 static void print_str(void *str) {
503 printf("%s",(char*)PRINTF_STR(str));
506 static void debuged_add_ext(xbt_dict_t head,const char*key,const char*data_to_fill) {
507 char *data=xbt_strdup(data_to_fill);
509 xbt_test_log2("Add %s under %s",PRINTF_STR(data_to_fill),PRINTF_STR(key));
511 xbt_dict_set(head,key,data,&free);
512 if (XBT_LOG_ISENABLED(xbt_dict,xbt_log_priority_debug)) {
513 xbt_dict_dump(head,(void (*)(void*))&printf);
517 static void debuged_add(xbt_dict_t head,const char*key) {
518 debuged_add_ext(head,key,key);
521 static void fill(xbt_dict_t *head) {
522 xbt_test_add0("Fill in the dictionnary");
524 *head = xbt_dict_new();
525 debuged_add(*head,"12");
526 debuged_add(*head,"12a");
527 debuged_add(*head,"12b");
528 debuged_add(*head,"123");
529 debuged_add(*head,"123456");
530 /* Child becomes child of what to add */
531 debuged_add(*head,"1234");
532 /* Need of common ancestor */
533 debuged_add(*head,"123457");
537 static void search_ext(xbt_dict_t head,const char*key, const char *data) {
540 xbt_test_add1("Search %s",key);
541 found=xbt_dict_get(head,key);
542 xbt_test_log1("Found %s",(char *)found);
544 xbt_test_assert1(found,"data do not match expectations: found NULL while searching for %s",data);
546 xbt_test_assert2(!strcmp((char*)data,found),"data do not match expectations: found %s while searching for %s", (char*)found, data);
549 static void search(xbt_dict_t head,const char*key) {
550 search_ext(head,key,key);
553 static void debuged_remove(xbt_dict_t head,const char*key) {
555 xbt_test_add1("Remove '%s'",PRINTF_STR(key));
556 xbt_dict_remove(head,key);
557 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
561 static void traverse(xbt_dict_t head) {
562 xbt_dict_cursor_t cursor=NULL;
566 xbt_dict_foreach(head,cursor,key,data) {
567 xbt_test_log2("Seen: %s->%s",PRINTF_STR(key),PRINTF_STR(data));
568 xbt_test_assert2(!data || !strcmp(key,data),
569 "Key(%s) != value(%s). Abording\n",key,data);
573 static void search_not_found(xbt_dict_t head, const char *data) {
577 xbt_test_add1("Search %s (expected not to be found)",data);
580 data = xbt_dict_get(head, data);
581 THROW1(unknown_error,0,"Found something which shouldn't be there (%s)",data);
583 if (e.category != not_found_error)
584 xbt_test_exception(e);
588 xbt_test_assert0(ok,"Exception not raised");
591 static void count(xbt_dict_t dict, int length) {
592 xbt_test_add1("Count elements (expecting %d)", length);
593 xbt_test_assert2(xbt_dict_length(dict) == length, "Length(%d) != %d.", xbt_dict_length(dict), length);
597 xbt_dict_t head=NULL;
601 XBT_TEST_UNIT("basic",test_dict_basic,"Basic usage: change, retrieve, traverse"){
602 xbt_test_add0("Traversal the null dictionnary");
605 xbt_test_add0("Traversal and search the empty dictionnary");
606 head = xbt_dict_new();
609 debuged_remove(head,"12346");
611 if (e.category != not_found_error)
612 xbt_test_exception(e);
615 xbt_dict_free(&head);
617 xbt_test_add0("Traverse the full dictionnary");
621 debuged_add_ext(head,"toto","tutu");
622 search_ext(head,"toto","tutu");
623 debuged_remove(head,"toto");
628 xbt_test_add0("Free the dictionnary (twice)");
629 xbt_dict_free(&head);
630 xbt_dict_free(&head);
635 xbt_test_add0("Change 123 to 'Changed 123'");
636 xbt_dict_set(head,"123",strdup("Changed 123"),&free);
639 xbt_test_add0("Change 123 back to '123'");
640 xbt_dict_set(head,"123",strdup("123"),&free);
643 xbt_test_add0("Change 12a to 'Dummy 12a'");
644 xbt_dict_set(head,"12a",strdup("Dummy 12a"),&free);
647 xbt_test_add0("Change 12a to '12a'");
648 xbt_dict_set(head,"12a",strdup("12a"),&free);
651 xbt_test_add0("Traverse the resulting dictionnary");
655 xbt_test_add0("Search 123");
656 data = xbt_dict_get(head,"123");
657 xbt_test_assert(data);
658 xbt_test_assert(!strcmp("123",data));
660 search_not_found(head,"Can't be found");
661 search_not_found(head,"123 Can't be found");
662 search_not_found(head,"12345678 NOT");
667 search(head,"123456");
669 search(head,"123457");
671 xbt_test_add0("Traverse the resulting dictionnary");
674 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
676 xbt_test_add0("Free the dictionnary twice");
677 xbt_dict_free(&head);
678 xbt_dict_free(&head);
680 xbt_test_add0("Traverse the resulting dictionnary");
684 XBT_TEST_UNIT("remove",test_dict_remove,"Removing some values"){
687 xbt_test_add0("Remove non existing data");
689 debuged_remove(head,"Does not exist");
691 if (e.category != not_found_error)
692 xbt_test_exception(e);
697 xbt_dict_free(&head);
699 xbt_test_add0("Remove each data manually (traversing the resulting dictionnary each time)");
701 debuged_remove(head,"12a"); traverse(head);
703 debuged_remove(head,"12b"); traverse(head);
705 debuged_remove(head,"12"); traverse(head);
707 debuged_remove(head,"123456"); traverse(head);
710 debuged_remove(head,"12346");
712 if (e.category != not_found_error)
713 xbt_test_exception(e);
717 debuged_remove(head,"1234"); traverse(head);
718 debuged_remove(head,"123457"); traverse(head);
719 debuged_remove(head,"123"); traverse(head);
721 debuged_remove(head,"12346");
723 if (e.category != not_found_error)
724 xbt_test_exception(e);
728 xbt_test_add0("Remove all values");
729 xbt_dict_free(&head);
731 xbt_dict_reset(head);
735 xbt_test_add0("Free the dictionnary twice");
736 xbt_dict_free(&head);
737 xbt_dict_free(&head);
740 XBT_TEST_UNIT("nulldata",test_dict_nulldata,"NULL data management"){
743 xbt_test_add0("Store NULL under 'null'");
744 xbt_dict_set(head,"null",NULL,NULL);
745 search_ext(head,"null",NULL);
747 xbt_test_add0("Check whether I see it while traversing...");
749 xbt_dict_cursor_t cursor=NULL;
753 xbt_dict_foreach(head,cursor,key,data) {
754 xbt_test_log2("Seen: %s->%s",PRINTF_STR(key),PRINTF_STR(data));
755 if (!strcmp(key,"null"))
758 xbt_test_assert0(found,"the key 'null', associated to NULL is not found");
760 xbt_dict_free(&head);
764 #define SIZEOFKEY 1024
765 static int countelems(xbt_dict_t head) {
766 xbt_dict_cursor_t cursor;
771 xbt_dict_foreach(head,cursor,key,data) {
777 XBT_TEST_UNIT("crash",test_dict_crash,"Crash test"){
778 xbt_dict_t head=NULL;
783 srand((unsigned int)time(NULL));
785 xbt_test_add0("CRASH test");
786 xbt_test_log0("Fill the struct, count its elems and frees the structure (x10)");
787 xbt_test_log1("using 1000 elements with %d chars long randomized keys.",SIZEOFKEY);
791 /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
793 for (j=0;j<1000;j++) {
794 key=xbt_malloc(SIZEOFKEY);
796 for (k=0;k<SIZEOFKEY-1;k++)
797 key[k]=rand() % ('z' - 'a') + 'a';
799 /* printf("[%d %s]\n",j,key); */
800 xbt_dict_set(head,key,key,&free);
802 /* xbt_dict_dump(head,(void (*)(void*))&printf); */
803 nb = countelems(head);
804 xbt_test_assert1(nb == 1000,"found %d elements instead of 1000",nb);
806 xbt_dict_free(&head);
807 xbt_dict_free(&head);
812 xbt_test_add1("Fill %d elements, with keys being the number of element",NB_ELM);
813 for (j=0;j<NB_ELM;j++) {
814 /* if (!(j%1000)) { printf("."); fflush(stdout); } */
816 key = xbt_malloc(10);
819 xbt_dict_set(head,key,key,&free);
822 xbt_test_add0("Count the elements (retrieving the key and data for each)");
823 i = countelems(head);
824 xbt_test_log1("There is %d elements",i);
826 xbt_test_add1("Search my %d elements 20 times",NB_ELM);
829 /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
830 for (j=0;j<NB_ELM;j++) {
833 data = xbt_dict_get(head,key);
834 xbt_test_assert2(!strcmp(key,(char*)data),
835 "key=%s != data=%s\n",key,(char*)data);
840 xbt_test_add1("Remove my %d elements",NB_ELM);
842 for (j=0;j<NB_ELM;j++) {
843 /* if (!(j%10000)) printf("."); fflush(stdout); */
846 xbt_dict_remove(head,key);
851 xbt_test_add0("Free the structure (twice)");
852 xbt_dict_free(&head);
853 xbt_dict_free(&head);
856 static void str_free(void *s) {
861 XBT_TEST_UNIT("multicrash",test_dict_multicrash,"Multi-dict crash test"){
864 #define NB_ELM 100 /*00*/
867 #define NB_TEST 20 /*20*/
870 xbt_dict_t mdict = NULL;
872 xbt_dynar_t keys = xbt_dynar_new(sizeof(char*),str_free);
877 xbt_test_add0("Generic multicache CRASH test");
878 xbt_test_log4(" Fill the struct and frees it %d times, using %d elements, "
879 "depth of multicache=%d, key size=%d",
880 NB_TEST,NB_ELM,DEPTH,KEY_SIZE);
882 for (l=0 ; l<DEPTH ; l++) {
883 key=xbt_malloc(KEY_SIZE);
884 xbt_dynar_push(keys,&key);
887 for (i=0;i<NB_TEST;i++) {
888 mdict = xbt_dict_new();
889 VERB1("mdict=%p",mdict);
891 printf("Test %d\n",i);
892 /* else if (i%10) printf("."); else printf("%d",i/10);*/
894 for (j=0;j<NB_ELM;j++) {
895 if (verbose>0) printf (" Add {");
897 for (l=0 ; l<DEPTH ; l++) {
898 key=*(char**)xbt_dynar_get_ptr(keys,l);
900 for (k=0;k<KEY_SIZE-1;k++)
901 key[k]=rand() % ('z' - 'a') + 'a';
905 if (verbose>0) printf("%p=%s %s ",key, key,(l<DEPTH-1?";":"}"));
907 if (verbose>0) printf("in multitree %p.\n",mdict);
909 xbt_multidict_set(mdict,keys,xbt_strdup(key),free);
911 data = xbt_multidict_get(mdict,keys);
913 xbt_test_assert2(data && !strcmp((char*)data,key),
914 "Retrieved value (%s) does not match the entrered one (%s)\n",
917 xbt_dict_free(&mdict);
920 xbt_dynar_free(&keys);
923 xbt_dict_dump(mdict,&xbt_dict_print);*/
925 xbt_dict_free(&mdict);
926 xbt_dynar_free(&keys);
929 #endif /* SIMGRID_TEST */