/* dict - a generic dictionary, variation over hash table */
-/* Copyright (c) 2004-2011. The SimGrid Team.
+/* Copyright (c) 2004-2015. 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. */
-#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 "src/xbt_modinter.h"
+#include "xbt/str.h"
#include "dict_private.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt,
- "Dictionaries provide the same functionalities than hash tables");
+ "Dictionaries provide the same functionalities as hash tables");
/**
* \brief Constructor
* \return pointer to the destination
- * \see xbt_dict_free()
+ * \see xbt_dict_new_homogenous(), xbt_dict_free()
*
* Creates and initialize a new dictionary with a default hashtable size.
* The dictionary is heterogeneous: each element can have a different free
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;
+ int newsize = oldsize * 2;
+ int i;
+ xbt_dictelm_t *currcell;
+ xbt_dictelm_t *twincell;
+ xbt_dictelm_t bucklet;
+ xbt_dictelm_t *pprev;
currcell =
(xbt_dictelm_t *) xbt_realloc((char *) dict->table,
* \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 (\a data as argument) when
- * \a data is removed from the dictionary
+ * \a data is removed from the dictionary. This param
+ * will only be considered when the dict was instantiated with
+ * xbt_dict_new() and not xbt_dict_new_homogeneous()
*
* 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 *data, void_f_pvoid_t free_ctn)
{
- unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
+ unsigned int hash_code = xbt_str_hash_ext(key, key_len);
xbt_dictelm_t current, previous = NULL;
- xbt_assert(dict);
- XBT_DEBUG("ADD %.*s hash = %d, size = %d, & = %d", key_len, key, hash_code,
- dict->table_size, hash_code & dict->table_size);
+ XBT_CDEBUG(xbt_dict,
+ "ADD %.*s hash = %u, size = %d, & = %u", 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
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);
+ XBT_CDEBUG(xbt_dict, "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 */
xbt_dictelm_set_data(dict, current, data, free_ctn);
}
* \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 (\a data as argument) when
- * \a data is removed from the dictionary
+ * \a data is removed from the dictionary. This param
+ * will only be considered when the dict was instantiated with
+ * xbt_dict_new() and not xbt_dict_new_homogeneous()
*
* set the \a data in the structure under the \a key, which is a
* null terminated string.
*
* Search the given \a key. Throws not_found_error when not found.
*/
-XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key,
- int key_len)
+XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len)
{
+ unsigned int hash_code = xbt_str_hash_ext(key, key_len);
+ xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
-
- 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))) {
return current->content;
}
-/**
- * \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)
+/** @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_str_hash_ext(key, key_len);
+ xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
- 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))) {
*/
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];
+ for (int i = 0; i <= dict->table_size; i++) {
+ xbt_dictelm_t current = dict->table[i];
while (current != NULL) {
if (current->content == data)
return current->key;
return NULL;
}
+/** @brief retrieve the key associated to that xbt_dictelm_t. */
+char *xbt_dict_get_elm_key(xbt_dictelm_t elm)
+{
+ return elm->key;
+}
+
/**
* \brief Retrieve data from the dict (null-terminated key)
*
*/
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);
-
- current = dict->table[hash_code & dict->table_size];
- while (current != NULL
- && (hash_code != current->hash_code || strcmp(key, current->key)))
- current = current->next;
+ return xbt_dict_get_elm(dict, key)->content;
+}
+/**
+ * \brief Retrieve element from the dict (null-terminated key)
+ *
+ * \param dict the dealer of data
+ * \param key the key to find data
+ * \return the s_xbt_dictelm_t that we are looking for
+ *
+ * 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_INLINE xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char *key)
+{
+ xbt_dictelm_t current = xbt_dict_get_elm_or_null(dict, key);
if (current == NULL)
THROWF(not_found_error, 0, "key %s not found", key);
- return current->content;
+ return current;
}
/**
*/
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;
+ xbt_dictelm_t current = xbt_dict_get_elm_or_null(dict, key);
if (current == NULL)
return NULL;
return current->content;
}
+/**
+ * \brief like xbt_dict_get_elm(), but returning NULL when not found
+ */
+XBT_INLINE xbt_dictelm_t xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key)
+{
+ unsigned int hash_code = xbt_str_hash(key);
+ xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
+
+ while (current != NULL &&
+ (hash_code != current->hash_code || strcmp(key, current->key)))
+ current = current->next;
+ return current;
+}
/**
*
* Remove the entry associated with the given \a key (throws not_found)
*/
-XBT_INLINE void 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_str_hash_ext(key, key_len);
+ xbt_dictelm_t previous = NULL;
+ xbt_dictelm_t current = dict->table[hash_code & dict->table_size];
-
- unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
- xbt_dictelm_t current, previous = NULL;
-
- xbt_assert(dict);
-
- // 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))) {
xbt_dict_remove_ext(dict, key, strlen(key));
}
-#ifdef XBT_USE_DEPRECATED
-/**
- * \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)
-{
- xbt_dict_set_ext(dict, (void *)&key, sizeof key, (void*)data, 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_INLINE uintptr_t xbt_dicti_get(xbt_dict_t dict, uintptr_t key)
-{
- return (uintptr_t)xbt_dict_get_or_null_ext(dict, (void *)&key, sizeof key);
-}
-
-/** Remove a uintptr_t key from the dict */
-XBT_INLINE void xbt_dicti_remove(xbt_dict_t dict, uintptr_t key)
-{
- xbt_dict_remove_ext(dict, (void *)&key, sizeof key);
-}
-#endif
-
-/**
- * \brief Remove all data from the dict
- * \param dict the dict
- */
+/** @brief Remove all data from 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];
+ for (int i = 0; i <= dict->table_size; i++) {
+ xbt_dictelm_t previous = NULL;
+ xbt_dictelm_t current = dict->table[i];
while (current != NULL) {
previous = current;
current = current->next;
*/
XBT_INLINE int xbt_dict_length(xbt_dict_t dict)
{
- xbt_assert(dict);
-
return dict->count;
}
/** @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;
+
+ printf("Dict %p: %d bucklets, %d used cells (of %d) ", dict, dict->count, dict->fill, dict->table_size);
+
+ if (!dict) {
+ printf("\n");
+ return;
+ }
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);
+ for (int i = 0; i < dict->table_size; i++) {
+ xbt_dictelm_t element = dict->table[i];
+ size = 0;
+ if (element) {
+ while (element != NULL) {
+ size++;
+ element = element->next;
}
}
- 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);
+ 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("%uelm x %u cells; ", count, size);
+ }
printf("\n");
xbt_dynar_free(&sizes);
}
*/
void xbt_dict_preinit(void)
{
- if (dict_elm_mallocator != NULL) {
- /* Already created. I guess we want to switch to MC mode, so kill the previously created mallocator */
- xbt_mallocator_free(dict_elm_mallocator);
- xbt_mallocator_free(dict_het_elm_mallocator);
- }
-
dict_elm_mallocator = xbt_mallocator_new(256,
dict_elm_mallocator_new_f,
dict_elm_mallocator_free_f,
continue;
if (size == 0)
continue;
- printf("%delm x %d cells; ", count, size);
+ printf("%uelm x %d cells; ", count, size);
avg += count * size;
total_count += size;
}
#ifdef SIMGRID_TEST
#include "xbt.h"
#include "xbt/ex.h"
-#include "portable.h"
+#include "src/portable.h"
-XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
-XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
-XBT_TEST_SUITE("dict", "Dict data container");
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dict);
-static void print_str(void *str)
-{
- printf("%s", (char *) PRINTF_STR(str));
-}
+XBT_TEST_SUITE("dict", "Dict data container");
static void debuged_add_ext(xbt_dict_t head, const char *key,
const char *data_to_fill, void_f_pvoid_t free_f)
{
char *data = xbt_strdup(data_to_fill);
- xbt_test_log("Add %s under %s", PRINTF_STR(data_to_fill),
- PRINTF_STR(key));
+ xbt_test_log("Add %s under %s", data_to_fill, key);
xbt_dict_set(head, key, data, free_f);
if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
static void search_ext(xbt_dict_t head, const char *key, const char *data)
{
- void *found;
+ char *found;
xbt_test_add("Search %s", key);
found = xbt_dict_get(head, key);
- xbt_test_log("Found %s", (char *) found);
- if (data)
+ xbt_test_log("Found %s", 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);
+ "data do not match expectations: found NULL while searching for %s",
+ data);
+ if (found)
+ xbt_test_assert(!strcmp(data, found),
+ "data do not match expectations: found %s while searching for %s",
+ found, data);
+ } else {
+ xbt_test_assert(!found,
+ "data do not match expectations: found %s while searching for NULL",
+ found);
+ }
}
static void search(xbt_dict_t head, const char *key)
static void debuged_remove(xbt_dict_t head, const char *key)
{
- xbt_test_add("Remove '%s'", PRINTF_STR(key));
+ xbt_test_add("Remove '%s'", key);
xbt_dict_remove(head, key);
/* xbt_dict_dump(head,(void (*)(void*))&printf); */
}
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));
+ xbt_test_log("Seen #%d: %s->%s", ++i, key, data);
} else {
- xbt_test_log("Seen #%d: %s", ++i, PRINTF_STR(key));
+ xbt_test_log("Seen #%d: %s", ++i, key);
}
xbt_test_assert(!data || !strcmp(key, data),
"Key(%s) != value(%s). Aborting", key, data);
{
xbt_dict_cursor_t cursor;
char *key;
- _XBT_GNUC_UNUSED char *key2;
+ XBT_ATTRIB_UNUSED char *key2;
void *data;
int effective = 0;
fill(&head, homogeneous);
count_check_get_key(head, 7);
xbt_test_add("Change 123 to 'Changed 123'");
- xbt_dict_set(head, "123", strdup("Changed 123"), free_f);
+ xbt_dict_set(head, "123", xbt_strdup("Changed 123"), free_f);
count_check_get_key(head, 7);
xbt_test_add("Change 123 back to '123'");
- xbt_dict_set(head, "123", strdup("123"), free_f);
+ xbt_dict_set(head, "123", xbt_strdup("123"), free_f);
count_check_get_key(head, 7);
xbt_test_add("Change 12a to 'Dummy 12a'");
- xbt_dict_set(head, "12a", strdup("Dummy 12a"), free_f);
+ xbt_dict_set(head, "12a", xbt_strdup("Dummy 12a"), free_f);
count_check_get_key(head, 7);
xbt_test_add("Change 12a to '12a'");
- xbt_dict_set(head, "12a", strdup("12a"), free_f);
+ xbt_dict_set(head, "12a", xbt_strdup("12a"), free_f);
count_check_get_key(head, 7);
xbt_test_add("Traverse the resulting dictionary");
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));
+ xbt_test_log("Seen: %s->%s", key, data);
} else {
- xbt_test_log("Seen: %s", PRINTF_STR(key));
+ xbt_test_log("Seen: %s", key);
}
if (!strcmp(key, "null"))
xbt_dict_free(&head);
}
+XBT_TEST_UNIT("ext", test_dict_int, "Test dictionnary with int keys")
+{
+ xbt_dict_t dict = xbt_dict_new();
+ int count = 500;
+
+ xbt_test_add("Insert elements");
+ int i;
+ for (i = 0; i < count; ++i)
+ xbt_dict_set_ext(dict, (char*) &i, sizeof(i), (void*) (intptr_t) i, NULL);
+ xbt_test_assert(xbt_dict_size(dict) == count,
+ "Bad number of elements in the dictionnary");
+
+ xbt_test_add("Check elements");
+ for (i = 0; i < count; ++i) {
+ int res = (int) (intptr_t) xbt_dict_get_ext(dict, (char*) &i, sizeof(i));
+ xbt_test_assert(xbt_dict_size(dict) == count,
+ "Unexpected value at index %i, expected %i but was %i", i, i, res);
+ }
+
+ xbt_test_add("Free the array");
+ xbt_dict_free(&dict);
+}
+
#endif /* SIMGRID_TEST */
