-/* $Id$ */
+/* dict - a generic dictionary, variation over hash table */
-/* dict - a generic dictionnary, variation over the B-tree concept */
-
-/* Copyright (c) 2003,2004 Martin Quinson. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * 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. */
-#include "dict_private.h"
-
-#include <stdlib.h> /* malloc() */
-#include <string.h> /* strlen() */
+#define DJB2_HASH_FUNCTION
+//#define FNV_HASH_FUNCTION
+#include <string.h>
#include <stdio.h>
+#include "xbt/ex.h"
+#include "xbt/log.h"
+#include "xbt/mallocator.h"
+#include "xbt_modinter.h"
+#include "dict_private.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dict,xbt,
- "Dictionaries provide the same functionnalities than hash tables");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt,
+ "Dictionaries provide the same functionalities than hash tables");
/*####[ Private prototypes ]#################################################*/
+static xbt_mallocator_t dict_mallocator = NULL;
+static void *dict_mallocator_new_f(void);
+static void dict_mallocator_free_f(void *dict);
+static void dict_mallocator_reset_f(void *dict);
+
+
/*####[ Code ]###############################################################*/
/**
- * \ingroup XBT_dict
- *
+ * \brief Constructor
* \return pointer to the destination
+ * \see xbt_dict_new_ext(), xbt_dict_free()
*
- * Creates and initialize a new dictionnary
+ * Creates and initialize a new dictionary with a default hashtable size.
*/
-xbt_dict_t
-xbt_dict_new(void) {
- xbt_dict_t res= xbt_new(s_xbt_dict_t,1);
- res->head=NULL;
- return res;
+xbt_dict_t xbt_dict_new(void)
+{
+ xbt_dict_t dict;
+
+ dict = xbt_mallocator_get(dict_mallocator);
+ dict->table_size = 127;
+ dict->table = xbt_new0(xbt_dictelm_t, dict->table_size + 1);
+ dict->count = 0;
+ dict->fill = 0;
+
+ return dict;
}
+
/**
- * \ingroup XBT_dict
- * \param dict the dictionnary to be freed
+ * \brief Destructor
+ * \param dict the dictionary to be freed
*
- * Frees a cache structure with all its childs.
+ * Frees a dictionary with all the data
*/
-void
-xbt_dict_free(xbt_dict_t *dict) {
- if (dict && *dict) {
- if ((*dict)->head) {
- xbt_dictelm_free( &( (*dict)->head ) );
- (*dict)->head = NULL;
+void xbt_dict_free(xbt_dict_t * dict)
+{
+ int i;
+ xbt_dictelm_t current, previous;
+ int table_size;
+ xbt_dictelm_t *table;
+
+ // if ( *dict ) xbt_dict_dump_sizes(*dict);
+
+ if (dict != NULL && *dict != NULL) {
+ table_size = (*dict)->table_size;
+ table = (*dict)->table;
+ /* Warning: the size of the table is 'table_size+1'...
+ * This is because table_size is used as a binary mask in xbt_dict_rehash */
+ for (i = 0; (*dict)->count && i <= table_size; i++) {
+ current = table[i];
+ while (current != NULL) {
+ previous = current;
+ current = current->next;
+ xbt_dictelm_free(previous);
+ (*dict)->count--;
+ }
}
- xbt_free(*dict);
- *dict=NULL;
+ xbt_free(table);
+ xbt_mallocator_release(dict_mallocator, *dict);
+ *dict = NULL;
}
}
/**
- * \ingroup XBT_dict
- *
+ * Returns the amount of elements in the dict
+ */
+XBT_INLINE unsigned int xbt_dict_size(xbt_dict_t dict)
+{
+ return (dict ? (unsigned int) dict->count : (unsigned int) 0);
+}
+
+/**
+ * Returns the hash code of a string.
+ */
+static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str,
+ int str_len)
+{
+
+
+#ifdef DJB2_HASH_FUNCTION
+ /* fast implementation of djb2 algorithm */
+ int c;
+ register unsigned int hash = 5381;
+
+ while (str_len--) {
+ c = *str++;
+ hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
+ }
+# elif defined(FNV_HASH_FUNCTION)
+ register unsigned int hash = 0x811c9dc5;
+ unsigned char *bp = (unsigned char *) str; /* start of buffer */
+ unsigned char *be = bp + str_len; /* beyond end of buffer */
+
+ while (bp < be) {
+ /* multiply by the 32 bit FNV magic prime mod 2^32 */
+ hash +=
+ (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
+ (hash << 24);
+
+ /* xor the bottom with the current octet */
+ hash ^= (unsigned int) *bp++;
+ }
+
+# else
+ register unsigned int hash = 0;
+
+ while (str_len--) {
+ hash += (*str) * (*str);
+ str++;
+ }
+#endif
+
+ return hash;
+}
+
+static XBT_INLINE unsigned int xbt_dict_hash(const char *str)
+{
+#ifdef DJB2_HASH_FUNCTION
+ /* fast implementation of djb2 algorithm */
+ int c;
+ register unsigned int hash = 5381;
+
+ while ((c = *str++)) {
+ hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
+ }
+
+# elif defined(FNV_HASH_FUNCTION)
+ register unsigned int hash = 0x811c9dc5;
+
+ while (*str) {
+ /* multiply by the 32 bit FNV magic prime mod 2^32 */
+ hash +=
+ (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
+ (hash << 24);
+
+ /* xor the bottom with the current byte */
+ hash ^= (unsigned int) *str++;
+ }
+
+# else
+ register unsigned int hash = 0;
+
+ while (*str) {
+ hash += (*str) * (*str);
+ str++;
+ }
+#endif
+ return hash;
+}
+
+/* Expend the size of the dict */
+static void xbt_dict_rehash(xbt_dict_t dict)
+{
+ const int oldsize = dict->table_size + 1;
+ register int newsize = oldsize * 2;
+ register int i;
+ register xbt_dictelm_t *currcell;
+ register xbt_dictelm_t *twincell;
+ register xbt_dictelm_t bucklet;
+ register xbt_dictelm_t *pprev;
+
+ currcell =
+ (xbt_dictelm_t *) xbt_realloc((char *) dict->table,
+ newsize * sizeof(xbt_dictelm_t));
+ memset(&currcell[oldsize], 0, oldsize * sizeof(xbt_dictelm_t)); /* zero second half */
+ dict->table_size = --newsize;
+ dict->table = currcell;
+ XBT_DEBUG("REHASH (%d->%d)", oldsize, newsize);
+
+ for (i = 0; i < oldsize; i++, currcell++) {
+ if (!*currcell) /* empty cell */
+ continue;
+ twincell = currcell + oldsize;
+ for (pprev = currcell, bucklet = *currcell; bucklet; bucklet = *pprev) {
+ /* Since we use "& size" instead of "%size" and since the size was doubled,
+ each bucklet of this cell must either :
+ - stay in cell i (ie, currcell)
+ - go to the cell i+oldsize (ie, twincell) */
+ if ((bucklet->hash_code & newsize) != i) { /* Move to b */
+ *pprev = bucklet->next;
+ bucklet->next = *twincell;
+ if (!*twincell)
+ dict->fill++;
+ *twincell = bucklet;
+ continue;
+ } else {
+ pprev = &bucklet->next;
+ }
+
+ }
+
+ if (!*currcell) /* everything moved */
+ dict->fill--;
+ }
+}
+
+/**
+ * \brief Add data to the dict (arbitrary key)
* \param dict the container
* \param key the key to set the new data
- * \param key_len the size of the #key
+ * \param key_len the size of the \a key
* \param data the data to add in the dict
- * \param free_ctn function to call with (#key as argument) when
- * #key is removed from the dictionnary
+ * \param free_ctn function to call with (\a data as argument) when
+ * \a data is removed from the dictionary
*
- * set the #data in the structure under the #key, which can be any kind
- * of data, as long as its length is provided in #key_len.
+ * 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 in \a key_len.
*/
-void
-xbt_dict_set_ext(xbt_dict_t dict,
- const char *key,
- int key_len,
- void *data,
- void_f_pvoid_t *free_ctn) {
+XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
+ const char *key, int key_len,
+ void *data, void_f_pvoid_t free_ctn)
+{
+ unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+
+ xbt_dictelm_t current, previous = NULL;
xbt_assert(dict);
- xbt_dictelm_set_ext(&(dict->head),
- key, key_len, data, free_ctn);
+ XBT_DEBUG("ADD %.*s hash = %d, size = %d, & = %d", key_len, key, hash_code,
+ dict->table_size, hash_code & dict->table_size);
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code || key_len != current->key_len
+ || memcmp(key, current->key, key_len))) {
+ previous = current;
+ current = current->next;
+ }
+
+ if (current == NULL) {
+ /* this key doesn't exist yet */
+ current = xbt_dictelm_new(key, key_len, hash_code, data, free_ctn);
+ dict->count++;
+ if (previous == NULL) {
+ dict->table[hash_code & dict->table_size] = current;
+ dict->fill++;
+ if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
+ xbt_dict_rehash(dict);
+ } else {
+ previous->next = current;
+ }
+ } else {
+
+ XBT_DEBUG("Replace %.*s by %.*s under key %.*s",
+ key_len, (char *) current->content,
+ key_len, (char *) data, key_len, (char *) key);
+ /* there is already an element with the same key: overwrite it */
+ if (current->content != NULL && current->free_f != NULL) {
+ current->free_f(current->content);
+ }
+ current->content = data;
+ current->free_f = free_ctn;
+ }
}
/**
- * \ingroup XBT_dict
+ * \brief Add data to the dict (null-terminated key)
*
- * \param dict the head of the dict
+ * \param dict the dict
* \param key the key to set the new data
* \param data the data to add in the dict
- * \param free_ctn function to call with (#key as argument) when
- * #key is removed from the dictionnary
+ * \param free_ctn function to call with (\a data as argument) when
+ * \a data is removed from the dictionary
*
- * set the #data in the structure under the #key, which is a
+ * set the \a data in the structure under the \a key, which is a
* null terminated string.
*/
-void
-xbt_dict_set(xbt_dict_t dict,
- const char *key,
- void *data,
- void_f_pvoid_t *free_ctn) {
+XBT_INLINE void xbt_dict_set(xbt_dict_t dict,
+ const char *key, void *data,
+ void_f_pvoid_t free_ctn)
+{
- xbt_assert(dict);
-
- xbt_dictelm_set(&(dict->head), key, data, free_ctn);
+ xbt_dict_set_ext(dict, key, strlen(key), data, free_ctn);
}
/**
- * \ingroup XBT_dict
+ * \brief Retrieve data from the dict (arbitrary key)
*
* \param dict the dealer of data
* \param key the key to find data
- * \param key_len the size of the #key
- * \param data the data that we are looking for
- * \return xbt_error
+ * \param key_len the size of the \a key
+ * \return the data that we are looking for
*
- * Search the given #key. mismatch_error when not found.
+ * Search the given \a key. Throws not_found_error when not found.
*/
-xbt_error_t
-xbt_dict_get_ext(xbt_dict_t dict,
- const char *key,
- int key_len,
- /* OUT */void **data) {
+XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key,
+ int key_len)
+{
+
+
+ unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+ xbt_dictelm_t current;
xbt_assert(dict);
- return xbt_dictelm_get_ext(dict->head, key, key_len, data);
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code || key_len != current->key_len
+ || memcmp(key, current->key, key_len))) {
+ current = current->next;
+ }
+
+ if (current == NULL)
+ THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
+
+ return current->content;
}
/**
- * \ingroup XBT_dict
+ * \brief like xbt_dict_get_ext(), but returning NULL when not found
+ */
+void *xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key,
+ int key_len)
+{
+
+ unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+ xbt_dictelm_t current;
+
+ xbt_assert(dict);
+
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code || key_len != current->key_len
+ || memcmp(key, current->key, key_len))) {
+ current = current->next;
+ }
+
+ if (current == NULL)
+ return NULL;
+
+ return current->content;
+}
+
+/**
+ * @brief retrieve the key associated to that object. Warning, that's a linear search
+ *
+ * Returns NULL if the object cannot be found
+ */
+char *xbt_dict_get_key(xbt_dict_t dict, const void *data)
+{
+ int i;
+ xbt_dictelm_t current;
+
+
+ for (i = 0; i <= dict->table_size; i++) {
+ current = dict->table[i];
+ while (current != NULL) {
+ if (current->content == data)
+ return current->key;
+ current = current->next;
+ }
+ }
+
+ return NULL;
+}
+
+/**
+ * \brief Retrieve data from the dict (null-terminated key)
*
* \param dict the dealer of data
* \param key the key to find data
- * \param data the data that we are looking for
- * \return xbt_error
+ * \return the data that we are looking for
*
- * Search the given #key. mismatch_error when not found.
+ * Search the given \a key. Throws not_found_error when not found.
+ * Check xbt_dict_get_or_null() for a version returning NULL without exception when
+ * not found.
*/
-xbt_error_t
-xbt_dict_get(xbt_dict_t dict,
- const char *key,
- /* OUT */void **data) {
+XBT_INLINE void *xbt_dict_get(xbt_dict_t dict, const char *key)
+{
+
+ unsigned int hash_code = xbt_dict_hash(key);
+ xbt_dictelm_t current;
+
xbt_assert(dict);
- return xbt_dictelm_get(dict->head, key, data);
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL
+ && (hash_code != current->hash_code || strcmp(key, current->key)))
+ current = current->next;
+
+ if (current == NULL)
+ THROW1(not_found_error, 0, "key %s not found", key);
+
+ return current->content;
+}
+
+/**
+ * \brief like xbt_dict_get(), but returning NULL when not found
+ */
+XBT_INLINE void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
+{
+ unsigned int hash_code = xbt_dict_hash(key);
+ xbt_dictelm_t current;
+
+ xbt_assert(dict);
+
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code || strcmp(key, current->key)))
+ current = current->next;
+
+ if (current == NULL)
+ return NULL;
+
+ return current->content;
}
/**
- * \ingroup XBT_dict
+ * \brief Remove data from the dict (arbitrary key)
*
* \param dict the trash can
* \param key the key of the data to be removed
- * \param key_len the size of the #key
- * \return xbt_error_t
+ * \param key_len the size of the \a key
*
- * Remove the entry associated with the given #key
+ * Remove the entry associated with the given \a key (throws not_found)
*/
-xbt_error_t
-xbt_dict_remove_ext(xbt_dict_t dict,
- const char *key,
- int key_len) {
+XBT_INLINE void xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
+ int key_len)
+{
+
+
+ unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+ xbt_dictelm_t current, previous = NULL;
+
xbt_assert(dict);
-
- return xbt_dictelm_remove_ext(dict->head, key, key_len);
+
+ // fprintf(stderr,"RM %.*s hash = %d, size = %d, & = %d\n",key_len,key,hash_code, dict->table_size, hash_code & dict->table_size);
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code || key_len != current->key_len
+ || strncmp(key, current->key, key_len))) {
+ previous = current; /* save the previous node */
+ current = current->next;
+ }
+
+ if (current == NULL)
+ THROW2(not_found_error, 0, "key %.*s not found", key_len, key);
+
+ if (previous != NULL) {
+ previous->next = current->next;
+ } else {
+ dict->table[hash_code & dict->table_size] = current->next;
+ }
+
+ if (!dict->table[hash_code & dict->table_size])
+ dict->fill--;
+
+ xbt_dictelm_free(current);
+ dict->count--;
}
+
+
/**
- * \ingroup XBT_dict
+ * \brief Remove data from the dict (null-terminated key)
*
- * \param dict the head of the dict
+ * \param dict the dict
* \param key the key of the data to be removed
- * \return xbt_error_t
*
- * Remove the entry associated with the given #key
+ * Remove the entry associated with the given \a key
+ */
+XBT_INLINE void xbt_dict_remove(xbt_dict_t dict, const char *key)
+{
+ xbt_dict_remove_ext(dict, key, strlen(key));
+}
+
+/**
+ * \brief Add data to the dict (arbitrary key)
+ * \param dict the container
+ * \param key the key to set the new data
+ * \param data the data to add in the dict
+ *
+ * Set the \a data in the structure under the \a key.
+ * Both \a data and \a key are considered as uintptr_t.
+ */
+XBT_INLINE void xbt_dicti_set(xbt_dict_t dict,
+ uintptr_t key, uintptr_t data)
+{
+
+ unsigned int hash_code =
+ xbt_dict_hash_ext((void *) &key, sizeof(uintptr_t));
+
+ xbt_dictelm_t current, previous = NULL;
+ xbt_assert(dict);
+
+ XBT_DEBUG("ADD %zu->%zu; hash = %d, size = %d, & = %d", key, data,
+ hash_code, dict->table_size, hash_code & dict->table_size);
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code
+ || sizeof(uintptr_t) != current->key_len
+ || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+ previous = current;
+ current = current->next;
+ }
+
+ if (current == NULL) {
+ /* this key doesn't exist yet */
+ current = xbt_dictielm_new(key, hash_code, data);
+ dict->count++;
+ if (previous == NULL) {
+ dict->table[hash_code & dict->table_size] = current;
+ dict->fill++;
+ if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
+ xbt_dict_rehash(dict);
+ } else {
+ previous->next = current;
+ }
+ } else {
+
+ /* there is already an element with the same key: overwrite it */
+ if (current->content != NULL && current->free_f != NULL) {
+ current->free_f(current->content);
+ }
+ current->content = (void *) data;
+ current->free_f = NULL;
+ }
+}
+
+/**
+ * \brief Retrieve data from the dict (key considered as a uintptr_t)
+ *
+ * \param dict the dealer of data
+ * \param key the key to find data
+ * \return the data that we are looking for (or 0 if not found)
+ *
+ * Mixing uintptr_t keys with regular keys in the same dict is discouraged
*/
-xbt_error_t
-xbt_dict_remove(xbt_dict_t dict,
- const char *key) {
- if (!dict)
- RAISE1(mismatch_error,"Asked to remove key %s from NULL dict",key);
+XBT_INLINE uintptr_t xbt_dicti_get(xbt_dict_t dict, uintptr_t key)
+{
+
+ unsigned int hash_code =
+ xbt_dict_hash_ext(((void *) &key), sizeof(uintptr_t));
+ xbt_dictelm_t current;
+
+ xbt_assert(dict);
+
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code
+ || sizeof(uintptr_t) != current->key_len
+ || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+ current = current->next;
+ }
- return xbt_dictelm_remove(dict->head, key);
+ if (current == NULL)
+ return 0;
+
+ return (uintptr_t) (current->content);
+}
+
+/** Remove a uintptr_t key from the dict */
+XBT_INLINE void xbt_dicti_remove(xbt_dict_t dict, uintptr_t key)
+{
+
+ unsigned int hash_code =
+ xbt_dict_hash_ext(((void *) &key), sizeof(uintptr_t));
+ xbt_dictelm_t current, previous = NULL;
+
+
+ current = dict->table[hash_code & dict->table_size];
+ while (current != NULL &&
+ (hash_code != current->hash_code
+ || sizeof(uintptr_t) != current->key_len
+ || (((uintptr_t) key) != ((uintptr_t) current->key)))) {
+ previous = current; /* save the previous node */
+ current = current->next;
+ }
+
+ if (current == NULL)
+ THROW1(not_found_error, 0, "key %zu not found", key);
+
+ if (previous != NULL) {
+ previous->next = current->next;
+ } else {
+ dict->table[hash_code & dict->table_size] = current->next;
+ }
+
+ if (!dict->table[hash_code & dict->table_size])
+ dict->fill--;
+
+ xbt_dictelm_free(current);
+ dict->count--;
}
/**
- * \ingroup XBT_dict
+ * \brief Remove all data from the dict
+ * \param dict the dict
+ */
+void xbt_dict_reset(xbt_dict_t dict)
+{
+
+ int i;
+ xbt_dictelm_t current, previous = NULL;
+
+ xbt_assert(dict);
+
+ if (dict->count == 0)
+ return;
+
+ for (i = 0; i <= dict->table_size; i++) {
+ current = dict->table[i];
+ while (current != NULL) {
+ previous = current;
+ current = current->next;
+ xbt_dictelm_free(previous);
+ }
+ dict->table[i] = NULL;
+ }
+
+ dict->count = 0;
+ dict->fill = 0;
+}
+
+/**
+ * \brief Return the number of elements in the dict.
+ * \param dict a dictionary
+ */
+XBT_INLINE int xbt_dict_length(xbt_dict_t dict)
+{
+ xbt_assert(dict);
+
+ return dict->count;
+}
+
+/** @brief function to be used in xbt_dict_dump as long as the stored values are strings */
+void xbt_dict_dump_output_string(void *s)
+{
+ fputs(s, stdout);
+}
+
+/**
+ * \brief test if the dict is empty or not
+ */
+XBT_INLINE int xbt_dict_is_empty(xbt_dict_t dict)
+{
+ return (xbt_dict_size(dict) == 0);
+}
+
+/**
+ * \brief Outputs the content of the structure (debugging purpose)
*
* \param dict the exibitionist
- * \param output a function to dump each data in the tree
- * \return xbt_error_t
+ * \param output a function to dump each data in the tree (check @ref xbt_dict_dump_output_string)
*
- * Ouputs the content of the structure. (for debuging purpose). #ouput is a
+ * Outputs the content of the structure. (for debugging purpose). \a output is a
* function to output the data. If NULL, data won't be displayed.
*/
-void
-xbt_dict_dump(xbt_dict_t dict,
- void_f_pvoid_t *output) {
+void xbt_dict_dump(xbt_dict_t dict, void_f_pvoid_t output)
+{
+ int i;
+ xbt_dictelm_t element;
+ printf("Dict %p:\n", dict);
+ if (dict != NULL) {
+ for (i = 0; i < dict->table_size; i++) {
+ element = dict->table[i];
+ if (element) {
+ printf("[\n");
+ while (element != NULL) {
+ printf(" %s -> '", element->key);
+ if (output != NULL) {
+ (*output) (element->content);
+ }
+ printf("'\n");
+ element = element->next;
+ }
+ printf("]\n");
+ } else {
+ printf("[]\n");
+ }
+ }
+ }
+}
+
+xbt_dynar_t all_sizes = NULL;
+/** @brief shows some debugging info about the bucklet repartition */
+void xbt_dict_dump_sizes(xbt_dict_t dict)
+{
+
+ int i;
+ unsigned int count;
+ unsigned int size;
+ xbt_dictelm_t element;
+ xbt_dynar_t sizes = xbt_dynar_new(sizeof(int), NULL);
+
+ printf("Dict %p: %d bucklets, %d used cells (of %d) ", dict, dict->count,
+ dict->fill, dict->table_size);
+ if (dict != NULL) {
+ for (i = 0; i < dict->table_size; i++) {
+ element = dict->table[i];
+ size = 0;
+ if (element) {
+ while (element != NULL) {
+ size++;
+ element = element->next;
+ }
+ }
+ if (xbt_dynar_length(sizes) <= size) {
+ int prevsize = 1;
+ xbt_dynar_set(sizes, size, &prevsize);
+ } else {
+ int prevsize;
+ xbt_dynar_get_cpy(sizes, size, &prevsize);
+ prevsize++;
+ xbt_dynar_set(sizes, size, &prevsize);
+ }
+ }
+ if (!all_sizes)
+ all_sizes = xbt_dynar_new(sizeof(int), NULL);
+
+ xbt_dynar_foreach(sizes, count, size) {
+ /* Copy values of this one into all_sizes */
+ int prevcount;
+ if (xbt_dynar_length(all_sizes) <= count) {
+ prevcount = size;
+ xbt_dynar_set(all_sizes, count, &prevcount);
+ } else {
+ xbt_dynar_get_cpy(all_sizes, count, &prevcount);
+ prevcount += size;
+ xbt_dynar_set(all_sizes, count, &prevcount);
+ }
+
+ /* Report current sizes */
+ if (count == 0)
+ continue;
+ if (size == 0)
+ continue;
+ printf("%delm x %u cells; ", count, size);
+ }
+ }
+ printf("\n");
+ xbt_dynar_free(&sizes);
+}
+
+/**
+ * Create the dict mallocators.
+ * This is an internal XBT function called during the lib initialization.
+ * It can be used several times to recreate the mallocator, for example when you switch to MC mode
+ */
+void xbt_dict_preinit(void)
+{
+ if (dict_mallocator != NULL) {
+ /* Already created. I guess we want to switch to MC mode, so kill the previously created mallocator */
+ xbt_mallocator_free(dict_mallocator);
+ xbt_mallocator_free(dict_elm_mallocator);
+ }
+
+ dict_mallocator = xbt_mallocator_new(256,
+ dict_mallocator_new_f,
+ dict_mallocator_free_f,
+ dict_mallocator_reset_f);
+ dict_elm_mallocator = xbt_mallocator_new(256,
+ dict_elm_mallocator_new_f,
+ dict_elm_mallocator_free_f,
+ dict_elm_mallocator_reset_f);
+}
+
+/**
+ * Destroy the dict mallocators.
+ * This is an internal XBT function during the lib initialization
+ */
+void xbt_dict_postexit(void)
+{
+ if (dict_mallocator != NULL) {
+ xbt_mallocator_free(dict_mallocator);
+ dict_mallocator = NULL;
+ xbt_mallocator_free(dict_elm_mallocator);
+ dict_elm_mallocator = NULL;
+ }
+ if (all_sizes) {
+ unsigned int count;
+ int size;
+ double avg = 0;
+ int total_count = 0;
+ printf("Overall stats:");
+ xbt_dynar_foreach(all_sizes, count, size) {
+ if (count == 0)
+ continue;
+ if (size == 0)
+ continue;
+ printf("%delm x %d cells; ", count, size);
+ avg += count * size;
+ total_count += size;
+ }
+ printf("; %f elm per cell\n", avg / (double) total_count);
+ }
+}
+
+static void *dict_mallocator_new_f(void)
+{
+ return xbt_new(s_xbt_dict_t, 1);
+}
+
+static void dict_mallocator_free_f(void *dict)
+{
+ xbt_free(dict);
+}
+
+static void dict_mallocator_reset_f(void *dict)
+{
+ /* nothing to do because all fields are
+ * initialized in xbt_dict_new
+ */
+}
+
+#ifdef SIMGRID_TEST
+#include "xbt.h"
+#include "xbt/ex.h"
+#include "portable.h"
+
+XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
+XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
+
+XBT_TEST_SUITE("dict", "Dict data container");
+
+static void print_str(void *str)
+{
+ printf("%s", (char *) PRINTF_STR(str));
+}
+
+static void debuged_add_ext(xbt_dict_t head, const char *key,
+ const char *data_to_fill)
+{
+ char *data = xbt_strdup(data_to_fill);
+
+ xbt_test_log("Add %s under %s", PRINTF_STR(data_to_fill),
+ PRINTF_STR(key));
+
+ xbt_dict_set(head, key, data, &free);
+ if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
+ xbt_dict_dump(head, (void (*)(void *)) &printf);
+ fflush(stdout);
+ }
+}
+
+static void debuged_add(xbt_dict_t head, const char *key)
+{
+ debuged_add_ext(head, key, key);
+}
+
+static void fill(xbt_dict_t * head)
+{
+ xbt_test_add("Fill in the dictionnary");
+
+ *head = xbt_dict_new();
+ debuged_add(*head, "12");
+ debuged_add(*head, "12a");
+ debuged_add(*head, "12b");
+ debuged_add(*head, "123");
+ debuged_add(*head, "123456");
+ /* Child becomes child of what to add */
+ debuged_add(*head, "1234");
+ /* Need of common ancestor */
+ debuged_add(*head, "123457");
+}
+
+
+static void search_ext(xbt_dict_t head, const char *key, const char *data)
+{
+ void *found;
+
+ xbt_test_add("Search %s", key);
+ found = xbt_dict_get(head, key);
+ xbt_test_log("Found %s", (char *) found);
+ if (data)
+ xbt_test_assert(found,
+ "data do not match expectations: found NULL while searching for %s",
+ data);
+ if (found)
+ xbt_test_assert(!strcmp((char *) data, found),
+ "data do not match expectations: found %s while searching for %s",
+ (char *) found, data);
+}
+
+static void search(xbt_dict_t head, const char *key)
+{
+ search_ext(head, key, key);
+}
+
+static void debuged_remove(xbt_dict_t head, const char *key)
+{
+
+ xbt_test_add("Remove '%s'", PRINTF_STR(key));
+ xbt_dict_remove(head, key);
+ /* xbt_dict_dump(head,(void (*)(void*))&printf); */
+}
+
+
+static void traverse(xbt_dict_t head)
+{
+ xbt_dict_cursor_t cursor = NULL;
+ char *key;
+ char *data;
+ int i = 0;
+
+ xbt_dict_foreach(head, cursor, key, data) {
+ if (!key || !data || strcmp(key, data)) {
+ xbt_test_log("Seen #%d: %s->%s", ++i, PRINTF_STR(key),
+ PRINTF_STR(data));
+ } else {
+ xbt_test_log("Seen #%d: %s", ++i, PRINTF_STR(key));
+ }
+ xbt_test_assert(!data || !strcmp(key, data),
+ "Key(%s) != value(%s). Aborting", key, data);
+ }
+}
+
+static void search_not_found(xbt_dict_t head, const char *data)
+{
+ int ok = 0;
+ xbt_ex_t e;
+
+ xbt_test_add("Search %s (expected not to be found)", data);
+
+ TRY {
+ data = xbt_dict_get(head, data);
+ THROW1(unknown_error, 0,
+ "Found something which shouldn't be there (%s)", data);
+ } CATCH(e) {
+ if (e.category != not_found_error)
+ xbt_test_exception(e);
+ xbt_ex_free(e);
+ ok = 1;
+ }
+ xbt_test_assert(ok, "Exception not raised");
+}
+
+static void count(xbt_dict_t dict, int length)
+{
+ xbt_dict_cursor_t cursor;
+ char *key;
+ void *data;
+ int effective = 0;
+
+
+ xbt_test_add("Count elements (expecting %d)", length);
+ xbt_test_assert(xbt_dict_length(dict) == length,
+ "Announced length(%d) != %d.", xbt_dict_length(dict),
+ length);
+
+ xbt_dict_foreach(dict, cursor, key, data)
+ effective++;
+
+ xbt_test_assert(effective == length, "Effective length(%d) != %d.",
+ effective, length);
+
+}
+
+static void count_check_get_key(xbt_dict_t dict, int length)
+{
+ xbt_dict_cursor_t cursor;
+ char *key, *key2;
+ void *data;
+ int effective = 0;
+
+
+ xbt_test_add
+ ("Count elements (expecting %d), and test the getkey function",
+ length);
+ xbt_test_assert(xbt_dict_length(dict) == length,
+ "Announced length(%d) != %d.", xbt_dict_length(dict),
+ length);
+
+ xbt_dict_foreach(dict, cursor, key, data) {
+ effective++;
+ key2 = xbt_dict_get_key(dict, data);
+ xbt_assert2(!strcmp(key, key2),
+ "The data was registered under %s instead of %s as expected",
+ key2, key);
+ }
+
+ xbt_test_assert(effective == length, "Effective length(%d) != %d.",
+ effective, length);
+
+}
+
+xbt_ex_t e;
+xbt_dict_t head = NULL;
+char *data;
+
+
+XBT_TEST_UNIT("basic", test_dict_basic, "Basic usage: change, retrieve, traverse")
+{
+ xbt_test_add("Traversal the null dictionary");
+ traverse(head);
+
+ xbt_test_add("Traversal and search the empty dictionary");
+ head = xbt_dict_new();
+ traverse(head);
+ TRY {
+ debuged_remove(head, "12346");
+ } CATCH(e) {
+ if (e.category != not_found_error)
+ xbt_test_exception(e);
+ xbt_ex_free(e);
+ }
+ xbt_dict_free(&head);
+
+ xbt_test_add("Traverse the full dictionary");
+ fill(&head);
+ count_check_get_key(head, 7);
+
+ debuged_add_ext(head, "toto", "tutu");
+ search_ext(head, "toto", "tutu");
+ debuged_remove(head, "toto");
+
+ search(head, "12a");
+ traverse(head);
+
+ xbt_test_add("Free the dictionary (twice)");
+ xbt_dict_free(&head);
+ xbt_dict_free(&head);
+
+ /* CHANGING */
+ fill(&head);
+ count_check_get_key(head, 7);
+ xbt_test_add("Change 123 to 'Changed 123'");
+ xbt_dict_set(head, "123", strdup("Changed 123"), &free);
+ count_check_get_key(head, 7);
+
+ xbt_test_add("Change 123 back to '123'");
+ xbt_dict_set(head, "123", strdup("123"), &free);
+ count_check_get_key(head, 7);
+
+ xbt_test_add("Change 12a to 'Dummy 12a'");
+ xbt_dict_set(head, "12a", strdup("Dummy 12a"), &free);
+ count_check_get_key(head, 7);
+
+ xbt_test_add("Change 12a to '12a'");
+ xbt_dict_set(head, "12a", strdup("12a"), &free);
+ count_check_get_key(head, 7);
+
+ xbt_test_add("Traverse the resulting dictionary");
+ traverse(head);
+
+ /* RETRIEVE */
+ xbt_test_add("Search 123");
+ data = xbt_dict_get(head, "123");
+ xbt_test_assert(data);
+ xbt_test_assert(!strcmp("123", data));
+
+ search_not_found(head, "Can't be found");
+ search_not_found(head, "123 Can't be found");
+ search_not_found(head, "12345678 NOT");
+
+ search(head, "12a");
+ search(head, "12b");
+ search(head, "12");
+ search(head, "123456");
+ search(head, "1234");
+ search(head, "123457");
+
+ xbt_test_add("Traverse the resulting dictionary");
+ traverse(head);
+
+ /* xbt_dict_dump(head,(void (*)(void*))&printf); */
+
+ xbt_test_add("Free the dictionary twice");
+ xbt_dict_free(&head);
+ xbt_dict_free(&head);
+
+ xbt_test_add("Traverse the resulting dictionary");
+ traverse(head);
+}
+
+XBT_TEST_UNIT("remove", test_dict_remove, "Removing some values")
+{
+ fill(&head);
+ count(head, 7);
+ xbt_test_add("Remove non existing data");
+ TRY {
+ debuged_remove(head, "Does not exist");
+ }
+ CATCH(e) {
+ if (e.category != not_found_error)
+ xbt_test_exception(e);
+ xbt_ex_free(e);
+ }
+ traverse(head);
+
+ xbt_dict_free(&head);
+
+ xbt_test_add
+ ("Remove each data manually (traversing the resulting dictionary each time)");
+ fill(&head);
+ debuged_remove(head, "12a");
+ traverse(head);
+ count(head, 6);
+ debuged_remove(head, "12b");
+ traverse(head);
+ count(head, 5);
+ debuged_remove(head, "12");
+ traverse(head);
+ count(head, 4);
+ debuged_remove(head, "123456");
+ traverse(head);
+ count(head, 3);
+ TRY {
+ debuged_remove(head, "12346");
+ }
+ CATCH(e) {
+ if (e.category != not_found_error)
+ xbt_test_exception(e);
+ xbt_ex_free(e);
+ traverse(head);
+ }
+ debuged_remove(head, "1234");
+ traverse(head);
+ debuged_remove(head, "123457");
+ traverse(head);
+ debuged_remove(head, "123");
+ traverse(head);
+ TRY {
+ debuged_remove(head, "12346");
+ }
+ CATCH(e) {
+ if (e.category != not_found_error)
+ xbt_test_exception(e);
+ xbt_ex_free(e);
+ }
+ traverse(head);
+
+ xbt_test_add
+ ("Free dict, create new fresh one, and then reset the dict");
+ xbt_dict_free(&head);
+ fill(&head);
+ xbt_dict_reset(head);
+ count(head, 0);
+ traverse(head);
+
+ xbt_test_add("Free the dictionary twice");
+ xbt_dict_free(&head);
+ xbt_dict_free(&head);
+}
+
+XBT_TEST_UNIT("nulldata", test_dict_nulldata, "NULL data management")
+{
+ fill(&head);
+
+ xbt_test_add("Store NULL under 'null'");
+ xbt_dict_set(head, "null", NULL, NULL);
+ search_ext(head, "null", NULL);
+
+ xbt_test_add("Check whether I see it while traversing...");
+ {
+ xbt_dict_cursor_t cursor = NULL;
+ char *key;
+ int found = 0;
+
+ xbt_dict_foreach(head, cursor, key, data) {
+ if (!key || !data || strcmp(key, data)) {
+ xbt_test_log("Seen: %s->%s", PRINTF_STR(key), PRINTF_STR(data));
+ } else {
+ xbt_test_log("Seen: %s", PRINTF_STR(key));
+ }
+
+ if (!strcmp(key, "null"))
+ found = 1;
+ }
+ xbt_test_assert(found,
+ "the key 'null', associated to NULL is not found");
+ }
+ xbt_dict_free(&head);
+}
+
+static void debuged_addi(xbt_dict_t head, uintptr_t key, uintptr_t data)
+{
+ uintptr_t stored_data = 0;
+ xbt_test_log("Add %zu under %zu", data, key);
+
+ xbt_dicti_set(head, key, data);
+ if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
+ xbt_dict_dump(head, (void (*)(void *)) &printf);
+ fflush(stdout);
+ }
+ stored_data = xbt_dicti_get(head, key);
+ xbt_test_assert(stored_data == data,
+ "Retrieved data (%zu) is not what I just stored (%zu) under key %zu",
+ stored_data, data, key);
+}
+
+XBT_TEST_UNIT("dicti", test_dict_scalar, "Scalar data and key management")
+{
+ xbt_test_add("Fill in the dictionnary");
+
+ head = xbt_dict_new();
+ debuged_addi(head, 12, 12);
+ debuged_addi(head, 13, 13);
+ debuged_addi(head, 14, 14);
+ debuged_addi(head, 15, 15);
+ /* Change values */
+ debuged_addi(head, 12, 15);
+ debuged_addi(head, 15, 2000);
+ debuged_addi(head, 15, 3000);
+ /* 0 as key */
+ debuged_addi(head, 0, 1000);
+ debuged_addi(head, 0, 2000);
+ debuged_addi(head, 0, 3000);
+ /* 0 as value */
+ debuged_addi(head, 12, 0);
+ debuged_addi(head, 13, 0);
+ debuged_addi(head, 12, 0);
+ debuged_addi(head, 0, 0);
+
+ xbt_dict_free(&head);
+}
+
+#define NB_ELM 20000
+#define SIZEOFKEY 1024
+static int countelems(xbt_dict_t head)
+{
+ xbt_dict_cursor_t cursor;
+ char *key;
+ void *data;
+ int res = 0;
+
+ xbt_dict_foreach(head, cursor, key, data) {
+ res++;
+ }
+ return res;
+}
+
+XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
+{
+ xbt_dict_t head = NULL;
+ int i, j, k, nb;
+ char *key;
+ void *data;
+
+ srand((unsigned int) time(NULL));
+
+ for (i = 0; i < 10; i++) {
+ xbt_test_add("CRASH test number %d (%d to go)", i + 1, 10 - i - 1);
+ xbt_test_log
+ ("Fill the struct, count its elems and frees the structure");
+ xbt_test_log
+ ("using 1000 elements with %d chars long randomized keys.",
+ SIZEOFKEY);
+ head = xbt_dict_new();
+ /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
+ nb = 0;
+ for (j = 0; j < 1000; j++) {
+ char *data = NULL;
+ key = xbt_malloc(SIZEOFKEY);
+
+ do {
+ for (k = 0; k < SIZEOFKEY - 1; k++)
+ key[k] = rand() % ('z' - 'a') + 'a';
+ key[k] = '\0';
+ /* printf("[%d %s]\n",j,key); */
+ data = xbt_dict_get_or_null(head, key);
+ } while (data != NULL);
+
+ xbt_dict_set(head, key, key, &free);
+ data = xbt_dict_get(head, key);
+ xbt_test_assert(!strcmp(key, data),
+ "Retrieved value (%s) != Injected value (%s)", key,
+ data);
+
+ count(head, j + 1);
+ }
+ /* xbt_dict_dump(head,(void (*)(void*))&printf); */
+ traverse(head);
+ xbt_dict_free(&head);
+ xbt_dict_free(&head);
+ }
+
+
+ head = xbt_dict_new();
+ xbt_test_add("Fill %d elements, with keys being the number of element",
+ NB_ELM);
+ for (j = 0; j < NB_ELM; j++) {
+ /* if (!(j%1000)) { printf("."); fflush(stdout); } */
+
+ key = xbt_malloc(10);
+
+ sprintf(key, "%d", j);
+ xbt_dict_set(head, key, key, &free);
+ }
+ /*xbt_dict_dump(head,(void (*)(void*))&printf); */
+
+ xbt_test_add
+ ("Count the elements (retrieving the key and data for each)");
+ i = countelems(head);
+ xbt_test_log("There is %d elements", i);
+
+ xbt_test_add("Search my %d elements 20 times", NB_ELM);
+ key = xbt_malloc(10);
+ for (i = 0; i < 20; i++) {
+ /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
+ for (j = 0; j < NB_ELM; j++) {
+
+ sprintf(key, "%d", j);
+ data = xbt_dict_get(head, key);
+ xbt_test_assert(!strcmp(key, (char *) data),
+ "with get, key=%s != data=%s", key, (char *) data);
+ data = xbt_dict_get_ext(head, key, strlen(key));
+ xbt_test_assert(!strcmp(key, (char *) data),
+ "with get_ext, key=%s != data=%s", key,
+ (char *) data);
+ }
+ }
+ free(key);
+
+ xbt_test_add("Remove my %d elements", NB_ELM);
+ key = xbt_malloc(10);
+ for (j = 0; j < NB_ELM; j++) {
+ /* if (!(j%10000)) printf("."); fflush(stdout); */
+
+ sprintf(key, "%d", j);
+ xbt_dict_remove(head, key);
+ }
+ free(key);
+
+
+ xbt_test_add("Free the structure (twice)");
+ xbt_dict_free(&head);
+ xbt_dict_free(&head);
+}
+
+static void str_free(void *s)
+{
+ char *c = *(char **) s;
+ free(c);
+}
+
+XBT_TEST_UNIT("multicrash", test_dict_multicrash, "Multi-dict crash test")
+{
+
+#undef NB_ELM
+#define NB_ELM 100 /*00 */
+#define DEPTH 5
+#define KEY_SIZE 512
+#define NB_TEST 20 /*20 */
+ int verbose = 0;
+
+ xbt_dict_t mdict = NULL;
+ int i, j, k, l;
+ xbt_dynar_t keys = xbt_dynar_new(sizeof(char *), str_free);
+ void *data;
+ char *key;
+
+
+ xbt_test_add("Generic multicache CRASH test");
+ xbt_test_log
+ (" Fill the struct and frees it %d times, using %d elements, "
+ "depth of multicache=%d, key size=%d", NB_TEST, NB_ELM, DEPTH,
+ KEY_SIZE);
+
+ for (l = 0; l < DEPTH; l++) {
+ key = xbt_malloc(KEY_SIZE);
+ xbt_dynar_push(keys, &key);
+ }
+
+ for (i = 0; i < NB_TEST; i++) {
+ mdict = xbt_dict_new();
+ XBT_VERB("mdict=%p", mdict);
+ if (verbose > 0)
+ printf("Test %d\n", i);
+ /* else if (i%10) printf("."); else printf("%d",i/10); */
+
+ for (j = 0; j < NB_ELM; j++) {
+ if (verbose > 0)
+ printf(" Add {");
+
+ for (l = 0; l < DEPTH; l++) {
+ key = *(char **) xbt_dynar_get_ptr(keys, l);
+
+ for (k = 0; k < KEY_SIZE - 1; k++)
+ key[k] = rand() % ('z' - 'a') + 'a';
+
+ key[k] = '\0';
+
+ if (verbose > 0)
+ printf("%p=%s %s ", key, key, (l < DEPTH - 1 ? ";" : "}"));
+ }
+ if (verbose > 0)
+ printf("in multitree %p.\n", mdict);
+
+ xbt_multidict_set(mdict, keys, xbt_strdup(key), free);
+
+ data = xbt_multidict_get(mdict, keys);
+
+ xbt_test_assert(data && !strcmp((char *) data, key),
+ "Retrieved value (%s) does not match the given one (%s)\n",
+ (char *) data, key);
+ }
+ xbt_dict_free(&mdict);
+ }
+
+ xbt_dynar_free(&keys);
+
+ /* if (verbose>0)
+ xbt_dict_dump(mdict,&xbt_dict_print); */
+
+ xbt_dict_free(&mdict);
+ xbt_dynar_free(&keys);
- printf("Dict %p:\n", (void*)dict);
- xbt_dictelm_dump(dict ? dict->head: NULL, output);
}
+#endif /* SIMGRID_TEST */
