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. */
11 #include "portable.h" /* PRINTF_STR */
12 #include "dict_private.h" /* prototypes of this module */
14 XBT_LOG_EXTERNAL_CATEGORY(dict);
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dict_elm,dict,"Dictionaries internals");
17 XBT_LOG_NEW_SUBCATEGORY(dict_add,dict,"Dictionaries internals: elements addition");
18 XBT_LOG_NEW_SUBCATEGORY(dict_search,dict,"Dictionaries internals: searching");
19 XBT_LOG_NEW_SUBCATEGORY(dict_remove,dict,"Dictionaries internals: elements removal");
20 XBT_LOG_NEW_SUBCATEGORY(dict_collapse,dict,"Dictionaries internals: post-removal cleanup");
22 /*####[ Private prototypes ]#################################################*/
24 static _XBT_INLINE void _xbt_dictelm_alloc(char *key,
29 void_f_pvoid_t *free_f,
30 /*OUT*/s_xbt_dictelm_t **where);
31 static void _dictelm_wrapper_free(void*);
33 static _XBT_INLINE void _str_prefix_lgr(const char *key1,
41 static void _xbt_dictelm_dump_rec(s_xbt_dictelm_t *head,
43 void_f_pvoid_t *output);
47 static void _xbt_dictelm_set_rec(s_xbt_dictelm_t *head,
52 void_f_pvoid_t *free_f);
53 static void * _xbt_dictelm_get_rec(s_xbt_dictelm_t *head,
57 static void _xbt_dictelm_remove_rec(s_xbt_dictelm_t *head,
64 _collapse_if_need(s_xbt_dictelm_t *p_head,
72 xbt_memdup(const void * const ptr,
73 const size_t length) {
74 void * new_ptr = NULL;
76 new_ptr = xbt_malloc(length);
77 memcpy(new_ptr, ptr, length);
83 * _xbt_nibble_to_char:
85 * Change any byte to a printable char
90 _xbt_nibble_to_char(unsigned char c) {
92 return c>9 ? c-10+'a' : c + '0';
96 * _xbt_bytes_to_string:
98 * Change any byte array to a printable string
99 * The length of string_container should at least be data_len*2+1
103 _xbt_bytes_to_string(char * const ptr,
105 char * const string_container) {
106 unsigned char *src = (unsigned char *)ptr;
107 char *dst = string_container;
110 *dst++ = _xbt_nibble_to_char(*src & 0x0f );
111 *dst++ = _xbt_nibble_to_char(*src++ & 0xf0 >> 4);
122 * _xbt_dictelm_alloc:
124 * Alloc a dict element with no child.
128 _xbt_dictelm_alloc(char *key,
133 void_f_pvoid_t *free_f,
134 /*OUT*/s_xbt_dictelm_t **pp_elm) {
135 s_xbt_dictelm_t *p_elm = NULL;
137 p_elm = xbt_new(s_xbt_dictelm_t,1);
140 p_elm->key_len = key_len;
141 p_elm->offset = offset;
142 p_elm->internal = internal;
143 p_elm->content = data;
144 p_elm->free_f = free_f;
145 p_elm->sub = xbt_dynar_new(sizeof(s_xbt_dictelm_t*), _dictelm_wrapper_free);
154 * @pp_elm: the dict elem to be freed
156 * Frees a dictionnary element with all its childs.
159 xbt_dictelm_free(s_xbt_dictelm_t **pp_elm) {
161 s_xbt_dictelm_t *p_elm = *pp_elm;
163 xbt_dynar_free(&(p_elm->sub));
169 if (p_elm->free_f && p_elm->content) {
170 p_elm->free_f(p_elm->content);
179 * _dictelm_wrapper_free:
181 * a wrapper to free dictelm with the right prototype to be usable within dynar
185 _dictelm_wrapper_free(void *pp_elm) {
186 DEBUG3("Free dictelm '%.*s' %p",
187 (*(s_xbt_dictelm_t**)pp_elm)->key_len, (*(s_xbt_dictelm_t**)pp_elm)->key,
189 xbt_dictelm_free((s_xbt_dictelm_t**)pp_elm);
192 /*####[ utility functions ]##################################################*/
197 * Returns the length of the common prefix of @str1 and @str2.
198 * Do make sure the strings are not null, this function don't
202 _str_prefix_lgr(const char *key1,
208 const int old_offset = *p_offset;
214 /*CDEBUG5(dict_search, "%s: [%.*s] <=> [%.*s]", __FUNCTION__,
215 key1,key_len1,key2,key_len2);*/
217 if (o < key_len1 && o < key_len2) {
219 while (key1[o] == key2[o]) {
222 if (!(o < key_len1 && o < key_len2))
230 if (o != old_offset) {
235 m = 1; /* exact match */
237 m = 2; /* child is prefix */
240 } else if (o >= key_len2) {
241 m = 3; /* key prefix of child */
243 DEBUG7("Common prefix. o=%d; key1=%.*s; key_len1=%d; key2=%.*s; key_len2=%d",
249 m = 4; /* Common prefix (=> common ancestor) */
259 * _dictelm_child_cmp:
261 * Compares two dictelm keys and return their matching (using the same
262 * convention than @_xbt_dict_child_search() )
266 _dict_child_cmp(s_xbt_dictelm_t *p_dict,
273 s_xbt_dictelm_t *p_child = NULL;
278 p_child = xbt_dynar_get_as(p_dict->sub, pos, s_xbt_dictelm_t*);
280 /* Compute the length of the prefix
281 and if the searched key is before or after cur */
282 _str_prefix_lgr(p_child->key, p_child->key_len,
287 if (m) /* found, get out */
290 if (o < p_child->key_len && (o >= key_len || key[o] < p_child->key[o])) {
296 CDEBUG6(dict_search, "Cmp '%.*s' and '%.*s' (offset=%d) => %d",
297 p_child->key_len - *p_offset, p_child->key + *p_offset,
298 key_len - *p_offset, key + *p_offset,
308 * _xbt_dict_child_search:
310 * Search where would be inserted @key between the childs of @p_elm.
312 * Returns position of the child having a common prefix with this key
313 * If *match==0, no child have a common prefix
314 * *pos is where to add the key
315 * If *match==1, A child (located at *pos) have exactly this key
316 * If *match==2, A child (located at *pos) constitutes a prefix of the key
317 * the recursion have to go on that guy
318 * *prefix = the size of the key eaten at this level
319 * If *match==3 The key is a prefix of the child at *pos
320 * If *match==4, A child (loc. at *pos) share a common prefix with this key
321 * *prefix = size of the prefix.
322 * If searching, that's a mismatch.
323 * If inserting, you have to break the child and create an
324 * internal node having {child, key} as childs
325 * offset is used in input and output. In input, that's the length of the key
326 * handled by previous levels of recursion. In output, that the one counting
331 _xbt_dictelm_child_search(s_xbt_dictelm_t *p_elm,
344 CDEBUG6(dict_search, "search child [%.*s] under [%.*s]=%p (len=%lu)",
346 p_elm ? (p_elm->key_len?p_elm->key_len:6) : 6,
347 p_elm ? PRINTF_STR(p_elm->key) : "(head)",
349 (p_elm&&p_elm->sub) ? xbt_dynar_length(p_elm->sub) : 0);
352 len = xbt_dynar_length(p_elm->sub);
363 _dict_child_cmp(p_elm, p_min, key, key_len, &o, &m, &cmp);
364 if(!m) { /* OK, maybe it is somewhere else. */
366 if (cmp<0) { /* Insert at the very beginning */
368 } else if (p_max<=0) { /* No way. It is not there. Insert at the very end */
373 _dict_child_cmp(p_elm, p_max, key, key_len, &o, &m, &cmp);
376 if(cmp>0) { /* Should be located at the end of the table */
378 } else { /* Too bad, let's go for a dichotomic search. */
379 while(p_max-p_min>1) {
380 _dict_child_cmp(p_elm, (p_min+p_max)/2, key, key_len, &o, &m, &cmp);
383 if(cmp<0) p_max=(p_min+p_max)/2;
384 if(cmp>0) p_min=(p_min+p_max)/2;
386 if(m) /* We have the element */
388 else /* it should be inserted just after p_min */
400 CDEBUG6(dict_search, "search [%.*s] in [%.*s]=%p => %s",
402 p_elm?(p_elm->key_len?p_elm->key_len:6):6, p_elm?PRINTF_STR(p_elm->key):"(head)",
404 ( m == 0 ? "no child have a common prefix" :
405 ( m == 1 ? "selected child have exactly this key" :
406 ( m == 2 ? "selected child constitutes a prefix" :
407 ( m == 3 ? "key is a prefix of selected child" :
408 (m == 4 ? "selected child share a prefix" :
409 "internal error")))))
414 * _xbt_dictelm_change_value:
416 * Change the value of the dictelm, making sure to free the old one, if any. The node also become a non-internal one.
420 _xbt_dictelm_change_value(s_xbt_dictelm_t *p_elm,
422 void_f_pvoid_t *free_f) {
424 if (p_elm->content && p_elm->free_f) {
425 p_elm->free_f(p_elm->content);
428 p_elm->free_f = free_f;
429 p_elm->content = data;
430 p_elm->internal = FALSE;
434 * _xbt_dictelm_set_rec:
436 * @head: the head of the dict
437 * @key: the key to set the new data
438 * @offset: offset on key.
439 * @data: the data to add in the dict
441 * set the @data in the structure under the @key. The @key is destroyed
442 * in the process. Think to strdup it before.
444 * This is a helper function to xbt_dict_set which locks the struct and
445 * strdup the key before action.
448 _xbt_dictelm_set_rec(s_xbt_dictelm_t *p_head,
453 void_f_pvoid_t *free_f) {
456 const int old_offset = offset;
458 CDEBUG6(dict_add, "--> Insert '%.*s' after '%.*s' (offset=%d) in tree %p",
460 ((p_head && p_head->key) ? p_head->key_len : 6),
461 ((p_head && p_head->key) ? p_head->key : "(head)"),
462 offset, (void*)p_head);
464 /*** The trivial cases first ***/
466 /* there is no key (we did enough recursion), change the value of head */
467 if (offset >= key_len) {
469 CDEBUG0(dict_add, "--> Change the value of head");
471 _xbt_dictelm_change_value(p_head, data, free_f);
472 free(key); /* Keep the key used in the tree */
477 /*** Search where to add this child, and how ***/
478 _xbt_dictelm_child_search(p_head, key, key_len, &pos, &offset, &match);
480 CDEBUG3(dict_add, "child_search => pos=%d, offset=%d, match=%d",
485 case 0: /* no child have a common prefix */
487 s_xbt_dictelm_t *p_child = NULL;
489 _xbt_dictelm_alloc(key, key_len, offset, FALSE, data, free_f, &p_child);
490 CDEBUG1(dict_add, "-> Add a child %p", (void*)p_child);
491 xbt_dynar_insert_at(p_head->sub, pos, &p_child);
496 case 1: /* A child have exactly this key => change its value*/
498 s_xbt_dictelm_t *p_child = NULL;
500 p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
501 CDEBUG1(dict_add, "-> Change the value of the child %p", (void*)p_child);
502 _xbt_dictelm_change_value(p_child, data, free_f);
509 case 2: /* A child constitutes a prefix of the key => recurse */
511 s_xbt_dictelm_t *p_child = NULL;
513 p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
514 CDEBUG2(dict_add,"-> Recurse on %p (offset=%d)", (void*)p_child, offset);
516 _xbt_dictelm_set_rec(p_child, key, key_len,
517 offset, data, free_f);
521 case 3: /* The key is a prefix of the child => child becomes child of p_new */
523 s_xbt_dictelm_t *p_new = NULL;
524 s_xbt_dictelm_t *p_child = NULL;
526 p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
527 _xbt_dictelm_alloc(key, key_len, old_offset, FALSE, data, free_f, &p_new);
529 CDEBUG2(dict_add, "-> The child %p become child of new dict (%p)",
530 (void*)p_child, (void*)p_new);
532 xbt_dynar_push(p_new->sub, &p_child);
533 p_child->offset = offset;
534 xbt_dynar_set(p_head->sub, pos, &p_new);
539 case 4: /* A child share a common prefix with this key => Common ancestor */
541 s_xbt_dictelm_t *p_new = NULL;
542 s_xbt_dictelm_t *p_child = NULL;
543 s_xbt_dictelm_t *p_anc = NULL;
544 char *anc_key = NULL;
545 int anc_key_len = offset;
547 _xbt_dictelm_alloc(key, key_len, offset, FALSE, data, free_f, &p_new);
548 p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
550 anc_key = xbt_memdup(key, anc_key_len);
552 _xbt_dictelm_alloc(anc_key, anc_key_len, old_offset, TRUE, NULL, NULL, &p_anc);
554 CDEBUG3(dict_add, "-> Make a common ancestor %p (%.*s)",
555 (void*)p_anc, anc_key_len, anc_key);
557 if (key[offset] < p_child->key[offset]) {
558 xbt_dynar_push(p_anc->sub, &p_new);
559 xbt_dynar_push(p_anc->sub, &p_child);
561 xbt_dynar_push(p_anc->sub, &p_child);
562 xbt_dynar_push(p_anc->sub, &p_new);
565 p_child->offset = offset;
567 xbt_dynar_set(p_head->sub, pos, &p_anc);
578 * xbt_dictelm_set_ext:
580 * @head: the head of the dict
581 * @key: the key to set the new data
582 * @data: the data to add in the dict
584 * set the @data in the structure under the @key, which can be any kind
585 * of data, as long as its length is provided in @key_len.
588 xbt_dictelm_set_ext(s_xbt_dictelm_t **pp_head,
592 void_f_pvoid_t *free_f) {
593 s_xbt_dictelm_t *p_head = *pp_head;
596 key = xbt_memdup(_key, key_len+1);
598 /* there is no head, create it */
600 s_xbt_dictelm_t *p_child = NULL;
602 CDEBUG0(dict_add, "Create an head");
604 /* The head is priviledged by being the only one with a NULL key */
605 _xbt_dictelm_alloc(NULL, 0, 0, TRUE, NULL, NULL, &p_head);
607 CDEBUG2(dict_add, "Push %.*s as child of this head",key_len,key);
608 _xbt_dictelm_alloc(key, key_len, 0, FALSE, data, free_f, &p_child);
609 xbt_dynar_insert_at(p_head->sub, 0, &p_child);
616 _xbt_dictelm_set_rec(p_head, key, key_len, 0, data, free_f);
622 * @head: the head of the dict
623 * @key: the key to set the new data
624 * @data: the data to add in the dict
626 * set the @data in the structure under the @key, which is a
627 * null terminated string.
630 xbt_dictelm_set(s_xbt_dictelm_t **pp_head,
633 void_f_pvoid_t *free_f) {
635 xbt_dictelm_set_ext(pp_head, _key, strlen(_key), data, free_f);
641 * @head: the head of the dict
642 * @key: the key to find data
643 * @offset: offset on the key
644 * @data: the data that we are looking for
646 * Search the given @key. Throws not_found_error when not found.
650 _xbt_dictelm_get_rec(s_xbt_dictelm_t *p_head,
655 CDEBUG3(dict_search, "Search %.*s in %p", key_len, key, (void*)p_head);
657 /*** The trivial case first ***/
659 /* we did enough recursion, we're done */
660 if (offset >= key_len) {
661 return p_head->content;
668 /*** Search where is the good child, and how good it is ***/
669 _xbt_dictelm_child_search(p_head, key, key_len, &pos, &offset, &match);
673 case 0: /* no child have a common prefix */
674 THROW1(not_found_error,0,"key '%s' not found",key);
676 case 1: /* A child have exactly this key => Got it */
678 s_xbt_dictelm_t *p_child = NULL;
679 p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
680 return p_child->content;
683 case 2: /* A child constitutes a prefix of the key => recurse */
685 s_xbt_dictelm_t *p_child = NULL;
687 p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
689 return _xbt_dictelm_get_rec(p_child, key, key_len, offset);
692 case 3: /* The key is a prefix of the child => not found */
693 THROW1(not_found_error,0,"key %s not found",key);
695 case 4: /* A child share a common prefix with this key => not found */
696 THROW1(not_found_error,0,"key %s not found",key);
705 * xbt_dictelm_get_ext:
707 * @head: the head of the dict
708 * @key: the key to find data
709 * @data: the data that we are looking for
711 * Search the given @key. Throws not_found_error when not found.
714 xbt_dictelm_get_ext(s_xbt_dictelm_t *p_head,
717 /* there is no head, go to hell */
719 THROW2(not_found_error,0,"Key '%*s' not found in dict",key_len,key);
721 return _xbt_dictelm_get_rec(p_head, key, key_len, 0);
727 * @head: the head of the dict
728 * @key: the key to find data
729 * @data: the data that we are looking for
731 * Search the given @key. Throws not_found_error when not found.
734 xbt_dictelm_get(s_xbt_dictelm_t *p_head,
737 return xbt_dictelm_get_ext(p_head, key, strlen(key));
740 /*----[ _xbt_dict_collapse ]------------------------------------------------*/
743 _collapse_if_need(xbt_dictelm_t head,
746 xbt_dictelm_t child = NULL;
748 CDEBUG2(dict_collapse, "Collapse %d of %p... ", pos, (void*)head);
751 /* Remove the child if |it's key| == 0 (meaning it's dead) */
752 child = xbt_dynar_get_as(head->sub, pos, xbt_dictelm_t);
754 if (offset >= child->key_len) {
756 xbt_assert0(xbt_dynar_length(child->sub) == 0,
757 "Found a dead child with grand childs. Internal error");
759 CDEBUG1(dict_collapse, "Remove dead child %p.... ", (void*)child);
760 xbt_dynar_remove_at(head->sub, pos, &child);
761 xbt_dictelm_free(&child);
766 CDEBUG0(dict_collapse, "Do not collapse the head, you stupid programm");
770 if (head->content || head->free_f ||
771 xbt_dynar_length(head->sub) != 1) {
772 CDEBUG0(dict_collapse, "Cannot collapse");
773 return; /* cannot collapse */
776 child = xbt_dynar_get_as(head->sub, 0, xbt_dictelm_t);
778 /* Get the child's key as new key */
779 CDEBUG2(dict_collapse,
780 "Do collapse with only child %.*s", child->key_len, child->key);
782 head->content = child->content;
783 head->free_f = child->free_f;
785 head->key = child->key;
786 head->key_len = child->key_len;
788 xbt_dynar_free_container(&(head->sub)) ;
790 head->sub = child->sub;
795 * _xbt_dict_remove_rec:
797 * @head: the head of the dict
798 * @key: the key of the data to be removed
799 * @offset: offset on the key
801 * Remove the entry associated with the given @key. Throws not_found_error.
804 _xbt_dictelm_remove_rec(xbt_dictelm_t head,
809 /* there is no key to search, we did enough recursion => kill current */
810 if (offset >= key_len) {
811 int killme = 0; /* do I need to suicide me ? */
813 if (head->content && head->free_f) {
814 head->free_f(head->content);
817 killme = !xbt_dynar_length(head->sub);
818 head->content = NULL;
820 _collapse_if_need(head, -1, offset);
823 DEBUG0("kill this node");
824 head->key_len = 0; /* killme. Cleanup done one step higher in recursion */
832 int old_offset = offset;
834 /*** Search where is the good child, and how good it is ***/
835 _xbt_dictelm_child_search(head, key, key_len, &pos, &offset, &match);
839 case 1: /* A child have exactly this key => recurse */
840 case 2: /* A child constitutes a prefix of the key => recurse */
843 s_xbt_dictelm_t *p_child = NULL;
845 p_child = xbt_dynar_get_as(head->sub, pos, s_xbt_dictelm_t*);
846 /*DEBUG5("Recurse on child %d of %p to remove %.*s (prefix=%d)",
847 pos, (void*)p_child, key+offset, key_len-offset,offset);*/
848 _xbt_dictelm_remove_rec(p_child, key, key_len, offset);
850 _collapse_if_need(head, pos, old_offset);
855 case 0: /* no child have a common prefix */
856 case 3: /* The key is a prefix of the child => not found */
857 case 4: /* A child share a common prefix with this key => not found */
859 THROW2(not_found_error,0,"Unable to remove key '%*s': not found",key_len,key);
869 * xbt_dictelm_remove_ext:
871 * @head: the head of the dict
872 * @key: the key of the data to be removed
874 * Remove the entry associated with the given @key. Throws not_found_err
877 xbt_dictelm_remove_ext(xbt_dictelm_t head,
880 /* there is no head, go to hell */
882 THROW1(arg_error,0,"Asked to remove key %s from NULL dict",key);
884 _xbt_dictelm_remove_rec(head, key, key_len, 0);
888 * xbt_dictelm_remove:
890 * @head: the head of the dict
891 * @key: the key of the data to be removed
893 * Throws not_found when applicable
896 xbt_dictelm_remove(xbt_dictelm_t head,
898 _xbt_dictelm_remove_rec(head, key, strlen(key),0);
901 /*----[ _xbt_dict_dump_rec ]------------------------------------------------*/
902 /* private function to do the job of xbt_dict_dump recursively */
903 /*---------------------------------------------------------------------------*/
906 _xbt_dictelm_dump_rec(xbt_dictelm_t head,
908 void_f_pvoid_t *output) {
909 xbt_dictelm_t child = NULL;
917 printf("[%p] ", (void*)head);
920 key_len = head->key_len;
925 for (i = 0; i < offset; i++)
934 } else if (key[key_len] != '\0') {
935 char *key_string = NULL;
937 key_string = xbt_malloc(key_len*2+1);
938 _xbt_bytes_to_string(key, key_len, key_string);
940 printf("%.*s|(%d)", key_len-2*offset, key_string + 2*offset, offset);
944 printf("%.*s|(%d)", key_len-offset, key + offset , offset);
953 output(head->content);
958 } else if (head->internal) {
959 printf("(internal node)");
964 printf(" \t\t\t[ %lu child(s) ]\n", xbt_dynar_length(head->sub));
966 xbt_dynar_foreach(head->sub, i, child)
967 _xbt_dictelm_dump_rec(child, child->offset, output);
974 * @head: the head of the dict
975 * @output: a function to dump each data in the tree
977 * Ouputs the content of the structure. (for debuging purpose). @ouput is a
978 * function to output the data. If NULL, data won't be displayed.
982 xbt_dictelm_dump(xbt_dictelm_t head,
983 void_f_pvoid_t *output) {
984 _xbt_dictelm_dump_rec(head, 0, output);
988 * xbt_dictelm_print_fct:
992 * To dump multidict, this function dumps a dict
996 xbt_dictelm_print_fct(void *data) {
997 printf("tree %p", (void*)data);