/* dict - a generic dictionnary, variation over the B-tree concept */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2003 the OURAGAN project. */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
- under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+#include "xbt/ex.h"
+#include "portable.h" /* PRINTF_STR */
#include "dict_private.h" /* prototypes of this module */
XBT_LOG_EXTERNAL_CATEGORY(dict);
XBT_LOG_NEW_SUBCATEGORY(dict_search,dict,"Dictionaries internals: searching");
XBT_LOG_NEW_SUBCATEGORY(dict_remove,dict,"Dictionaries internals: elements removal");
XBT_LOG_NEW_SUBCATEGORY(dict_collapse,dict,"Dictionaries internals: post-removal cleanup");
-XBT_LOG_NEW_SUBCATEGORY(dict_multi,dict,"Dictionaries internals: dictionaries of dictionaries");
/*####[ Private prototypes ]#################################################*/
static _XBT_INLINE void _xbt_dictelm_alloc(char *key,
- int offset,
- int key_len,
- void *data,
- void_f_pvoid_t *free_f,
- /*OUT*/s_xbt_dictelm_t **where);
+ int offset,
+ int key_len,
+ int internal,
+ void *data,
+ void_f_pvoid_t *free_f,
+ /*OUT*/s_xbt_dictelm_t **where);
static void _dictelm_wrapper_free(void*);
static _XBT_INLINE void _str_prefix_lgr(const char *key1,
int offset,
void *data,
void_f_pvoid_t *free_f);
-static xbt_error_t _xbt_dictelm_get_rec(s_xbt_dictelm_t *head,
- const char *key,
- int key_len,
- int offset,
- /* OUT */void **data);
-static xbt_error_t _xbt_dictelm_remove_rec(s_xbt_dictelm_t *head,
- const char *key,
- int key_len,
- int offset);
+static void * _xbt_dictelm_get_rec(s_xbt_dictelm_t *head,
+ const char *key,
+ int key_len,
+ int offset);
+static void _xbt_dictelm_remove_rec(s_xbt_dictelm_t *head,
+ const char *key,
+ int key_len,
+ int offset);
static _XBT_INLINE
void
/* ---- */
-static _XBT_INLINE
-void *
-xbt_memdup(const void * const ptr,
- const size_t length) {
- void * new_ptr = NULL;
-
- new_ptr = xbt_malloc(length);
- memcpy(new_ptr, ptr, length);
-
- return new_ptr;
-}
-
/*
* _xbt_nibble_to_char:
*
static _XBT_INLINE
void
_xbt_dictelm_alloc(char *key,
- int key_len,
- int offset,
- void *data,
- void_f_pvoid_t *free_f,
+ int key_len,
+ int offset,
+ int internal,
+ void *data,
+ void_f_pvoid_t *free_f,
/*OUT*/s_xbt_dictelm_t **pp_elm) {
- xbt_error_t errcode = no_error;
s_xbt_dictelm_t *p_elm = NULL;
p_elm = xbt_new(s_xbt_dictelm_t,1);
p_elm->key = key;
p_elm->key_len = key_len;
p_elm->offset = offset;
+ p_elm->internal = internal;
p_elm->content = data;
p_elm->free_f = free_f;
p_elm->sub = xbt_dynar_new(sizeof(s_xbt_dictelm_t*), _dictelm_wrapper_free);
xbt_dynar_free(&(p_elm->sub));
if (p_elm->key) {
- xbt_free(p_elm->key);
+ free(p_elm->key);
}
if (p_elm->free_f && p_elm->content) {
p_elm->free_f(p_elm->content);
}
- xbt_free(p_elm);
+ free(p_elm);
*pp_elm = NULL;
}
}
*
*
* Returns the length of the common prefix of @str1 and @str2.
- * Do make sure the strings are not null
+ * Do make sure the strings are not null, this function don't
*/
static _XBT_INLINE
void
if (o >= key_len1) {
if (o >= key_len2) {
- m = 1;
+ m = 1; /* exact match */
} else {
- m = 2;
+ m = 2; /* child is prefix */
}
} else if (o >= key_len2) {
- m = 3;
- } else {
- m = 4;
+ m = 3; /* key prefix of child */
+ } else {
+ DEBUG7("Common prefix. o=%d; key1=%.*s; key_len1=%d; key2=%.*s; key_len2=%d",
+ o,
+ key_len1, key1,
+ key_len1,
+ key_len2, key2,
+ key_len2);
+ m = 4; /* Common prefix (=> common ancestor) */
}
}
static _XBT_INLINE
void
_xbt_dictelm_child_search(s_xbt_dictelm_t *p_elm,
- const char *key,
- int key_len,
- int *p_pos,
- int *p_offset,
- int *p_match) {
+ const char *key,
+ int key_len,
+ int *p_pos,
+ int *p_offset,
+ int *p_match) {
int p = 0;
int o = *p_offset;
int len = 0;
- CDEBUG5(dict_search, "search child [%.*s] under [%.*s] (len=%lu)",
+ CDEBUG6(dict_search, "search child [%.*s] under [%.*s]=%p (len=%lu)",
key_len, key,
- p_elm?p_elm->key_len:6, p_elm?p_elm->key:"(head)",
- (p_elm&&p_elm->sub)?xbt_dynar_length(p_elm->sub):0);
+ p_elm ? (p_elm->key_len?p_elm->key_len:6) : 6,
+ p_elm ? PRINTF_STR(p_elm->key) : "(head)",
+ p_elm,
+ (p_elm&&p_elm->sub) ? xbt_dynar_length(p_elm->sub) : 0);
len = xbt_dynar_length(p_elm->sub);
- for (p = 0; p < len; p++) {
- int cmp = 0;
-
- _dict_child_cmp(p_elm, p, key, key_len, &o, &m, &cmp);
-
- if (m)
- break;
-
- o = *p_offset;
- m = 0;
+ {
+ int p_min = 0;
+ int p_max = len-1;
+ int cmp = 0;
+
+ p = p_min;
+ if(len==0) {
+ p=0;
+ } else {
+ _dict_child_cmp(p_elm, p_min, key, key_len, &o, &m, &cmp);
+ if(!m) { /* OK, maybe it is somewhere else. */
+ o = *p_offset;
+ if (cmp<0) { /* Insert at the very beginning */
+ p=0;
+ } else if (p_max<=0) { /* No way. It is not there. Insert at the very end */
+ p=p_max+1;
+ m = 0;
+ } else {
+ p=p_max;
+ _dict_child_cmp(p_elm, p_max, key, key_len, &o, &m, &cmp);
+ if(!m) {
+ o = *p_offset;
+ if(cmp>0) { /* Should be located at the end of the table */
+ p=p_max+1;
+ } else { /* Too bad, let's go for a dichotomic search. */
+ while(p_max-p_min>1) {
+ _dict_child_cmp(p_elm, (p_min+p_max)/2, key, key_len, &o, &m, &cmp);
+ if(m) break;
+ o = *p_offset;
+ if(cmp<0) p_max=(p_min+p_max)/2;
+ if(cmp>0) p_min=(p_min+p_max)/2;
+ }
+ if(m) /* We have the element */
+ p=(p_min+p_max)/2 ;
+ else /* it should be inserted just after p_min */
+ p=p_min + 1;
+ }
+ }
+ }
+ }
+ }
}
*p_offset = o;
*p_pos = p;
*p_match = m;
- CDEBUG5(dict_search, "search [%.*s] in [%.*s] => %s",
+ CDEBUG6(dict_search, "search [%.*s] in [%.*s]=%p => %s",
key_len, key,
- p_elm?p_elm->key_len:6, p_elm?p_elm->key:"(head)",
+ p_elm?(p_elm->key_len?p_elm->key_len:6):6, p_elm?PRINTF_STR(p_elm->key):"(head)",
+ p_elm,
( m == 0 ? "no child have a common prefix" :
( m == 1 ? "selected child have exactly this key" :
( m == 2 ? "selected child constitutes a prefix" :
/**
* _xbt_dictelm_change_value:
*
- * Change the value of the dictelm, making sure to free the old one, if any.
+ * Change the value of the dictelm, making sure to free the old one, if any. The node also become a non-internal one.
*/
static _XBT_INLINE
void
p_elm->free_f = free_f;
p_elm->content = data;
+ p_elm->internal = FALSE;
}
/**
CDEBUG0(dict_add, "--> Change the value of head");
_xbt_dictelm_change_value(p_head, data, free_f);
- xbt_free(key); /* Keep the key used in the tree */
+ free(key); /* Keep the key used in the tree */
return;
}
{
s_xbt_dictelm_t *p_child = NULL;
- _xbt_dictelm_alloc(key, key_len, offset, data, free_f, &p_child);
+ _xbt_dictelm_alloc(key, key_len, offset, FALSE, data, free_f, &p_child);
CDEBUG1(dict_add, "-> Add a child %p", (void*)p_child);
xbt_dynar_insert_at(p_head->sub, pos, &p_child);
CDEBUG1(dict_add, "-> Change the value of the child %p", (void*)p_child);
_xbt_dictelm_change_value(p_child, data, free_f);
- xbt_free(key);
+ free(key);
return;
}
s_xbt_dictelm_t *p_child = NULL;
p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
- _xbt_dictelm_alloc(key, key_len, old_offset, data, free_f, &p_new);
+ _xbt_dictelm_alloc(key, key_len, old_offset, FALSE, data, free_f, &p_new);
CDEBUG2(dict_add, "-> The child %p become child of new dict (%p)",
(void*)p_child, (void*)p_new);
char *anc_key = NULL;
int anc_key_len = offset;
- _xbt_dictelm_alloc(key, key_len, offset, data, free_f, &p_new);
+ _xbt_dictelm_alloc(key, key_len, offset, FALSE, data, free_f, &p_new);
p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
- anc_key = xbt_memdup(key, anc_key_len);
+ /* memdup the old key, taking care of the terminating NULL byte */
+ anc_key = xbt_malloc(anc_key_len+1);
+ memcpy(anc_key, key, anc_key_len);
+ anc_key[anc_key_len] = '\0';
+
- _xbt_dictelm_alloc(anc_key, anc_key_len, old_offset, NULL, NULL, &p_anc);
+ _xbt_dictelm_alloc(anc_key, anc_key_len, old_offset, TRUE, NULL, NULL, &p_anc);
CDEBUG3(dict_add, "-> Make a common ancestor %p (%.*s)",
(void*)p_anc, anc_key_len, anc_key);
}
default:
- DIE_IMPOSSIBLE;
+ THROW_IMPOSSIBLE;
}
}
s_xbt_dictelm_t *p_head = *pp_head;
char *key = NULL;
- key = xbt_memdup(_key, key_len);
+ /* Make sure the copied key is NULL-terminated */
+ key = xbt_malloc(key_len+1);
+ memcpy(key, _key, key_len);
+ key[key_len] = '\0';
/* there is no head, create it */
if (!p_head) {
CDEBUG0(dict_add, "Create an head");
/* The head is priviledged by being the only one with a NULL key */
- _xbt_dictelm_alloc(NULL, 0, 0, NULL, NULL, &p_head);
+ _xbt_dictelm_alloc(NULL, 0, 0, TRUE, NULL, NULL, &p_head);
- _xbt_dictelm_alloc(key, key_len, 0, data, free_f, &p_child);
+ CDEBUG2(dict_add, "Push %.*s as child of this head",key_len,key);
+ _xbt_dictelm_alloc(key, key_len, 0, FALSE, data, free_f, &p_child);
xbt_dynar_insert_at(p_head->sub, 0, &p_child);
*pp_head = p_head;
void *data,
void_f_pvoid_t *free_f) {
- xbt_dictelm_set_ext(pp_head, _key, 1+strlen(_key), data, free_f);
+ xbt_dictelm_set_ext(pp_head, _key, strlen(_key), data, free_f);
}
/**
* @key: the key to find data
* @offset: offset on the key
* @data: the data that we are looking for
- * @Returns: xbt_error
*
- * Search the given @key. mismatch_error when not found.
+ * Search the given @key. Throws not_found_error when not found.
*/
static
-xbt_error_t
+void *
_xbt_dictelm_get_rec(s_xbt_dictelm_t *p_head,
const char *key,
int key_len,
- int offset,
- void **data) {
- void *res;
+ int offset) {
CDEBUG3(dict_search, "Search %.*s in %p", key_len, key, (void*)p_head);
/* we did enough recursion, we're done */
if (offset >= key_len) {
- *data = p_head->content;
-
- return no_error;
+ return p_head->content;
}
{
int match = 0;
int pos = 0;
- *data = NULL; /* Make it ready to answer 'not found' in one operation */
-
/*** Search where is the good child, and how good it is ***/
_xbt_dictelm_child_search(p_head, key, key_len, &pos, &offset, &match);
switch (match) {
case 0: /* no child have a common prefix */
- return mismatch_error;
+ THROW2(not_found_error,0,"key '%.*s' not found",key_len,key);
case 1: /* A child have exactly this key => Got it */
{
s_xbt_dictelm_t *p_child = NULL;
-
p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
- *data = p_child->content;
-
- return no_error;
+ return p_child->content;
}
case 2: /* A child constitutes a prefix of the key => recurse */
p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
- return _xbt_dictelm_get_rec(p_child, key, key_len, offset, data);
+ return _xbt_dictelm_get_rec(p_child, key, key_len, offset);
}
case 3: /* The key is a prefix of the child => not found */
- return mismatch_error;
+ THROW2(not_found_error,0,"key %.*s not found",key_len,key);
case 4: /* A child share a common prefix with this key => not found */
- return mismatch_error;
+ THROW2(not_found_error,0,"key %.*s not found",key_len,key);
default:
- RAISE_IMPOSSIBLE;
+ THROW_IMPOSSIBLE;
}
}
}
* @head: the head of the dict
* @key: the key to find data
* @data: the data that we are looking for
- * @Returns: xbt_error
*
- * Search the given @key. mismatch_error when not found.
+ * Search the given @key. Throws not_found_error when not found.
*/
-xbt_error_t
+void *
xbt_dictelm_get_ext(s_xbt_dictelm_t *p_head,
- const char *key,
- int key_len,
- /* OUT */void **data) {
+ const char *key,
+ int key_len) {
/* there is no head, go to hell */
- if (!p_head) {
- return mismatch_error;
- }
+ if (!p_head)
+ THROW2(not_found_error,0,"Key '%.*s' not found in dict",key_len,key);
- return _xbt_dictelm_get_rec(p_head, key, key_len, 0, data);
+ return _xbt_dictelm_get_rec(p_head, key, key_len, 0);
}
/**
* @head: the head of the dict
* @key: the key to find data
* @data: the data that we are looking for
- * @Returns: xbt_error
*
- * Search the given @key. mismatch_error when not found.
+ * Search the given @key. Throws not_found_error when not found.
*/
-xbt_error_t
-xbt_dictelm_get(s_xbt_dictelm_t *p_head,
- const char *key,
- /* OUT */void **data) {
+void *
+xbt_dictelm_get(s_xbt_dictelm_t *p_head,
+ const char *key) {
- return xbt_dictelm_get_ext(p_head, key, 1+strlen(key), data);
+ return xbt_dictelm_get_ext(p_head, key, strlen(key));
}
/*----[ _xbt_dict_collapse ]------------------------------------------------*/
head->content = child->content;
head->free_f = child->free_f;
- xbt_free(head->key);
+ free(head->key);
head->key = child->key;
head->key_len = child->key_len;
xbt_dynar_free_container(&(head->sub)) ;
head->sub = child->sub;
- xbt_free(child);
+ free(child);
}
/**
* @head: the head of the dict
* @key: the key of the data to be removed
* @offset: offset on the key
- * @Returns: xbt_error_t
*
- * Remove the entry associated with the given @key
+ * Remove the entry associated with the given @key. Throws not_found_error.
*/
-xbt_error_t
+void
_xbt_dictelm_remove_rec(xbt_dictelm_t head,
const char *key,
int key_len,
int offset) {
- xbt_error_t errcode = no_error;
/* there is no key to search, we did enough recursion => kill current */
if (offset >= key_len) {
head->key_len = 0; /* killme. Cleanup done one step higher in recursion */
}
- return errcode;
+ return;
} else {
int match = 0;
p_child = xbt_dynar_get_as(head->sub, pos, s_xbt_dictelm_t*);
/*DEBUG5("Recurse on child %d of %p to remove %.*s (prefix=%d)",
pos, (void*)p_child, key+offset, key_len-offset,offset);*/
- TRY(_xbt_dictelm_remove_rec(p_child, key, key_len, offset));
+ _xbt_dictelm_remove_rec(p_child, key, key_len, offset);
_collapse_if_need(head, pos, old_offset);
- return no_error;
+ return;
}
case 3: /* The key is a prefix of the child => not found */
case 4: /* A child share a common prefix with this key => not found */
- return mismatch_error;
-
+ THROW2(not_found_error,0,"Unable to remove key '%.*s': not found",key_len,key);
default:
- RAISE_IMPOSSIBLE;
+ THROW_IMPOSSIBLE;
}
}
*
* @head: the head of the dict
* @key: the key of the data to be removed
- * @Returns: xbt_error_t
*
- * Remove the entry associated with the given @key
+ * Remove the entry associated with the given @key. Throws not_found_err
*/
-xbt_error_t
+void
xbt_dictelm_remove_ext(xbt_dictelm_t head,
const char *key,
int key_len) {
/* there is no head, go to hell */
- if (!head) {
- RAISE0(mismatch_error, "there is no head, go to hell");
- }
+ if (!head)
+ THROW1(arg_error,0,"Asked to remove key %s from NULL dict",key);
- return _xbt_dictelm_remove_rec(head, key, key_len, 0);
+ _xbt_dictelm_remove_rec(head, key, key_len, 0);
}
/**
*
* @head: the head of the dict
* @key: the key of the data to be removed
- * @Returns: xbt_error_t
*
- * Remove the entry associated with the given @key
+ * Throws not_found when applicable
*/
-xbt_error_t
+void
xbt_dictelm_remove(xbt_dictelm_t head,
const char *key) {
- return _xbt_dictelm_remove_rec(head, key, 1+strlen(key),0);
+ _xbt_dictelm_remove_rec(head, key, strlen(key),0);
}
/*----[ _xbt_dict_dump_rec ]------------------------------------------------*/
static
void
_xbt_dictelm_dump_rec(xbt_dictelm_t head,
- int offset,
- void_f_pvoid_t *output) {
+ int offset,
+ void_f_pvoid_t *output) {
xbt_dictelm_t child = NULL;
char *key = NULL;
int key_len = 0;
fflush(stdout);
if (key) {
-
- if (!key_len) {
- printf ("HEAD");
- } else {
- char *key_string = NULL;
-
- key_string = xbt_malloc(key_len*2+1);
- _xbt_bytes_to_string(key, key_len, key_string);
-
- printf("%.*s|(%d)", key_len-offset, key_string + offset, offset);
-
- xbt_free(key_string);
- }
-
+
+ if (!key_len) {
+ printf ("HEAD");
+ } else if (key[key_len] != '\0') {
+ char *key_string = NULL;
+
+ key_string = xbt_malloc(key_len*2+1);
+ _xbt_bytes_to_string(key, key_len, key_string);
+
+ printf("%.*s|(%d)", key_len-2*offset, key_string + 2*offset, offset);
+
+ free(key_string);
+ } else {
+ printf("%.*s|(%d)", key_len-offset, key + offset , offset);
+ }
}
printf(" -> ");
printf("(data)");
}
+ } else if (head->internal) {
+ printf("(internal node)");
} else {
printf("(null)");
}
*
* @head: the head of the dict
* @output: a function to dump each data in the tree
- * @Returns: xbt_error_t
*
* Ouputs the content of the structure. (for debuging purpose). @ouput is a
* function to output the data. If NULL, data won't be displayed.