src/xbt/dict.c

   1 /* dict - a generic dictionary, variation over hash table                   */
   2
   3 /* Copyright (c) 2004-2011. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #define DJB2_HASH_FUNCTION
  10 //#define FNV_HASH_FUNCTION
  11
  12 #include <string.h>
  13 #include <stdio.h>
  14 #include "xbt/ex.h"
  15 #include "xbt/log.h"
  16 #include "xbt/mallocator.h"
  17 #include "xbt_modinter.h"
  18 #include "dict_private.h"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt,
  21                                 "Dictionaries provide the same functionalities than hash tables");
  22
  23 /**
  24  * \brief Constructor
  25  * \return pointer to the destination
  26  * \see xbt_dict_free()
  27  *
  28  * Creates and initialize a new dictionary with a default hashtable size.
  29  * The dictionary is heterogeneous: each element can have a different free
  30  * function.
  31  */
  32 xbt_dict_t xbt_dict_new(void)
  33 {
  34   xbt_dict_t dict = xbt_dict_new_homogeneous(NULL);
  35   dict->homogeneous = 0;
  36
  37   return dict;
  38 }
  39
  40 /**
  41  * \brief Constructor
  42  * \param free_ctn function to call with (\a data as argument) when
  43  *        \a data is removed from the dictionary
  44  * \return pointer to the destination
  45  * \see xbt_dict_new(), xbt_dict_free()
  46  *
  47  * Creates and initialize a new dictionary with a default hashtable size.
  48  * The dictionary is homogeneous: each element share the same free function.
  49  */
  50 xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn)
  51 {
  52   xbt_dict_t dict;
  53
  54   dict = xbt_new(s_xbt_dict_t, 1);
  55   dict->free_f = free_ctn;
  56   dict->table_size = 127;
  57   dict->table = xbt_new0(xbt_dictelm_t, dict->table_size + 1);
  58   dict->count = 0;
  59   dict->fill = 0;
  60   dict->homogeneous = 1;
  61
  62   return dict;
  63 }
  64
  65 /**
  66  * \brief Destructor
  67  * \param dict the dictionary to be freed
  68  *
  69  * Frees a dictionary with all the data
  70  */
  71 void xbt_dict_free(xbt_dict_t * dict)
  72 {
  73   int i;
  74   xbt_dictelm_t current, previous;
  75   int table_size;
  76   xbt_dictelm_t *table;
  77
  78   //  if ( *dict )  xbt_dict_dump_sizes(*dict);
  79
  80   if (dict != NULL && *dict != NULL) {
  81     table_size = (*dict)->table_size;
  82     table = (*dict)->table;
  83     /* Warning: the size of the table is 'table_size+1'...
  84      * This is because table_size is used as a binary mask in xbt_dict_rehash */
  85     for (i = 0; (*dict)->count && i <= table_size; i++) {
  86       current = table[i];
  87       while (current != NULL) {
  88         previous = current;
  89         current = current->next;
  90         xbt_dictelm_free(*dict, previous);
  91         (*dict)->count--;
  92       }
  93     }
  94     xbt_free(table);
  95     xbt_free(*dict);
  96     *dict = NULL;
  97   }
  98 }
  99
 100 /**
 101  * Returns the amount of elements in the dict
 102  */
 103 XBT_INLINE unsigned int xbt_dict_size(xbt_dict_t dict)
 104 {
 105   return (dict ? (unsigned int) dict->count : (unsigned int) 0);
 106 }
 107
 108 /**
 109  * Returns the hash code of a string.
 110  */
 111 static XBT_INLINE unsigned int xbt_dict_hash_ext(const char *str,
 112                                                  int str_len)
 113 {
 114
 115
 116 #ifdef DJB2_HASH_FUNCTION
 117   /* fast implementation of djb2 algorithm */
 118   int c;
 119   register unsigned int hash = 5381;
 120
 121   while (str_len--) {
 122     c = *str++;
 123     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
 124   }
 125 # elif defined(FNV_HASH_FUNCTION)
 126   register unsigned int hash = 0x811c9dc5;
 127   unsigned char *bp = (unsigned char *) str;    /* start of buffer */
 128   unsigned char *be = bp + str_len;     /* beyond end of buffer */
 129
 130   while (bp < be) {
 131     /* multiply by the 32 bit FNV magic prime mod 2^32 */
 132     hash +=
 133         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
 134         (hash << 24);
 135
 136     /* xor the bottom with the current octet */
 137     hash ^= (unsigned int) *bp++;
 138   }
 139
 140 # else
 141   register unsigned int hash = 0;
 142
 143   while (str_len--) {
 144     hash += (*str) * (*str);
 145     str++;
 146   }
 147 #endif
 148
 149   return hash;
 150 }
 151
 152 static XBT_INLINE unsigned int xbt_dict_hash(const char *str)
 153 {
 154 #ifdef DJB2_HASH_FUNCTION
 155   /* fast implementation of djb2 algorithm */
 156   int c;
 157   register unsigned int hash = 5381;
 158
 159   while ((c = *str++)) {
 160     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
 161   }
 162
 163 # elif defined(FNV_HASH_FUNCTION)
 164   register unsigned int hash = 0x811c9dc5;
 165
 166   while (*str) {
 167     /* multiply by the 32 bit FNV magic prime mod 2^32 */
 168     hash +=
 169         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
 170         (hash << 24);
 171
 172     /* xor the bottom with the current byte */
 173     hash ^= (unsigned int) *str++;
 174   }
 175
 176 # else
 177   register unsigned int hash = 0;
 178
 179   while (*str) {
 180     hash += (*str) * (*str);
 181     str++;
 182   }
 183 #endif
 184   return hash;
 185 }
 186
 187 /* Expend the size of the dict */
 188 static void xbt_dict_rehash(xbt_dict_t dict)
 189 {
 190   const int oldsize = dict->table_size + 1;
 191   register int newsize = oldsize * 2;
 192   register int i;
 193   register xbt_dictelm_t *currcell;
 194   register xbt_dictelm_t *twincell;
 195   register xbt_dictelm_t bucklet;
 196   register xbt_dictelm_t *pprev;
 197
 198   currcell =
 199       (xbt_dictelm_t *) xbt_realloc((char *) dict->table,
 200                                     newsize * sizeof(xbt_dictelm_t));
 201   memset(&currcell[oldsize], 0, oldsize * sizeof(xbt_dictelm_t));       /* zero second half */
 202   dict->table_size = --newsize;
 203   dict->table = currcell;
 204   XBT_DEBUG("REHASH (%d->%d)", oldsize, newsize);
 205
 206   for (i = 0; i < oldsize; i++, currcell++) {
 207     if (!*currcell)             /* empty cell */
 208       continue;
 209     twincell = currcell + oldsize;
 210     for (pprev = currcell, bucklet = *currcell; bucklet; bucklet = *pprev) {
 211       /* Since we use "& size" instead of "%size" and since the size was doubled,
 212          each bucklet of this cell must either :
 213          - stay  in  cell i (ie, currcell)
 214          - go to the cell i+oldsize (ie, twincell) */
 215       if ((bucklet->hash_code & newsize) != i) {        /* Move to b */
 216         *pprev = bucklet->next;
 217         bucklet->next = *twincell;
 218         if (!*twincell)
 219           dict->fill++;
 220         *twincell = bucklet;
 221         continue;
 222       } else {
 223         pprev = &bucklet->next;
 224       }
 225
 226     }
 227
 228     if (!*currcell)             /* everything moved */
 229       dict->fill--;
 230   }
 231 }
 232
 233 /**
 234  * \brief Add data to the dict (arbitrary key)
 235  * \param dict the container
 236  * \param key the key to set the new data
 237  * \param key_len the size of the \a key
 238  * \param data the data to add in the dict
 239  * \param free_ctn function to call with (\a data as argument) when
 240  *        \a data is removed from the dictionary
 241  *
 242  * Set the \a data in the structure under the \a key, which can be any kind
 243  * of data, as long as its length is provided in \a key_len.
 244  */
 245 XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
 246                                  const char *key, int key_len,
 247                                  void *data, void_f_pvoid_t free_ctn)
 248 {
 249
 250   unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
 251
 252   xbt_dictelm_t current, previous = NULL;
 253   xbt_assert(dict);
 254
 255   XBT_DEBUG("ADD %.*s hash = %d, size = %d, & = %d", key_len, key, hash_code,
 256          dict->table_size, hash_code & dict->table_size);
 257   current = dict->table[hash_code & dict->table_size];
 258   while (current != NULL &&
 259          (hash_code != current->hash_code || key_len != current->key_len
 260           || memcmp(key, current->key, key_len))) {
 261     previous = current;
 262     current = current->next;
 263   }
 264
 265   if (current == NULL) {
 266     /* this key doesn't exist yet */
 267     current = xbt_dictelm_new(dict, key, key_len, hash_code, data, free_ctn);
 268     dict->count++;
 269     if (previous == NULL) {
 270       dict->table[hash_code & dict->table_size] = current;
 271       dict->fill++;
 272       if ((dict->fill * 100) / (dict->table_size + 1) > MAX_FILL_PERCENT)
 273         xbt_dict_rehash(dict);
 274     } else {
 275       previous->next = current;
 276     }
 277   } else {
 278     XBT_DEBUG("Replace %.*s by %.*s under key %.*s",
 279            key_len, (char *) current->content,
 280            key_len, (char *) data, key_len, (char *) key);
 281     /* there is already an element with the same key: overwrite it */
 282     xbt_dictelm_set_data(dict, current, data, free_ctn);
 283   }
 284 }
 285
 286 /**
 287  * \brief Add data to the dict (null-terminated key)
 288  *
 289  * \param dict the dict
 290  * \param key the key to set the new data
 291  * \param data the data to add in the dict
 292  * \param free_ctn function to call with (\a data as argument) when
 293  *        \a data is removed from the dictionary
 294  *
 295  * set the \a data in the structure under the \a key, which is a
 296  * null terminated string.
 297  */
 298 XBT_INLINE void xbt_dict_set(xbt_dict_t dict,
 299                              const char *key, void *data,
 300                              void_f_pvoid_t free_ctn)
 301 {
 302
 303   xbt_dict_set_ext(dict, key, strlen(key), data, free_ctn);
 304 }
 305
 306 /**
 307  * \brief Retrieve data from the dict (arbitrary key)
 308  *
 309  * \param dict the dealer of data
 310  * \param key the key to find data
 311  * \param key_len the size of the \a key
 312  * \return the data that we are looking for
 313  *
 314  * Search the given \a key. Throws not_found_error when not found.
 315  */
 316 XBT_INLINE void *xbt_dict_get_ext(xbt_dict_t dict, const char *key,
 317                                   int key_len)
 318 {
 319
 320
 321   unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
 322   xbt_dictelm_t current;
 323
 324   xbt_assert(dict);
 325
 326   current = dict->table[hash_code & dict->table_size];
 327   while (current != NULL &&
 328          (hash_code != current->hash_code || key_len != current->key_len
 329           || memcmp(key, current->key, key_len))) {
 330     current = current->next;
 331   }
 332
 333   if (current == NULL)
 334     THROWF(not_found_error, 0, "key %.*s not found", key_len, key);
 335
 336   return current->content;
 337 }
 338
 339 /**
 340  * \brief like xbt_dict_get_ext(), but returning NULL when not found
 341  */
 342 void *xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key,
 343                                int key_len)
 344 {
 345
 346   unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
 347   xbt_dictelm_t current;
 348
 349   xbt_assert(dict);
 350
 351   current = dict->table[hash_code & dict->table_size];
 352   while (current != NULL &&
 353          (hash_code != current->hash_code || key_len != current->key_len
 354           || memcmp(key, current->key, key_len))) {
 355     current = current->next;
 356   }
 357
 358   if (current == NULL)
 359     return NULL;
 360
 361   return current->content;
 362 }
 363
 364 /**
 365  * @brief retrieve the key associated to that object. Warning, that's a linear search
 366  *
 367  * Returns NULL if the object cannot be found
 368  */
 369 char *xbt_dict_get_key(xbt_dict_t dict, const void *data)
 370 {
 371   int i;
 372   xbt_dictelm_t current;
 373
 374
 375   for (i = 0; i <= dict->table_size; i++) {
 376     current = dict->table[i];
 377     while (current != NULL) {
 378       if (current->content == data)
 379         return current->key;
 380       current = current->next;
 381     }
 382   }
 383
 384   return NULL;
 385 }
 386
 387 /**
 388  * \brief Retrieve data from the dict (null-terminated key)
 389  *
 390  * \param dict the dealer of data
 391  * \param key the key to find data
 392  * \return the data that we are looking for
 393  *
 394  * Search the given \a key. Throws not_found_error when not found.
 395  * Check xbt_dict_get_or_null() for a version returning NULL without exception when
 396  * not found.
 397  */
 398 XBT_INLINE void *xbt_dict_get(xbt_dict_t dict, const char *key)
 399 {
 400
 401   unsigned int hash_code = xbt_dict_hash(key);
 402   xbt_dictelm_t current;
 403
 404   xbt_assert(dict);
 405
 406   current = dict->table[hash_code & dict->table_size];
 407   while (current != NULL
 408          && (hash_code != current->hash_code || strcmp(key, current->key)))
 409     current = current->next;
 410
 411   if (current == NULL)
 412     THROWF(not_found_error, 0, "key %s not found", key);
 413
 414   return current->content;
 415 }
 416
 417 /**
 418  * \brief like xbt_dict_get(), but returning NULL when not found
 419  */
 420 XBT_INLINE void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key)
 421 {
 422   unsigned int hash_code = xbt_dict_hash(key);
 423   xbt_dictelm_t current;
 424
 425   xbt_assert(dict);
 426
 427   current = dict->table[hash_code & dict->table_size];
 428   while (current != NULL &&
 429          (hash_code != current->hash_code || strcmp(key, current->key)))
 430     current = current->next;
 431
 432   if (current == NULL)
 433     return NULL;
 434
 435   return current->content;
 436 }
 437
 438
 439 /**
 440  * \brief Remove data from the dict (arbitrary key)
 441  *
 442  * \param dict the trash can
 443  * \param key the key of the data to be removed
 444  * \param key_len the size of the \a key
 445  *
 446  * Remove the entry associated with the given \a key (throws not_found)
 447  */
 448 XBT_INLINE void xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
 449                                     int key_len)
 450 {
 451
 452
 453   unsigned int hash_code = xbt_dict_hash_ext(key, key_len);
 454   xbt_dictelm_t current, previous = NULL;
 455
 456   xbt_assert(dict);
 457
 458   //  fprintf(stderr,"RM %.*s hash = %d, size = %d, & = %d\n",key_len,key,hash_code, dict->table_size, hash_code & dict->table_size);
 459   current = dict->table[hash_code & dict->table_size];
 460   while (current != NULL &&
 461          (hash_code != current->hash_code || key_len != current->key_len
 462           || strncmp(key, current->key, key_len))) {
 463     previous = current;         /* save the previous node */
 464     current = current->next;
 465   }
 466
 467   if (current == NULL)
 468     THROWF(not_found_error, 0, "key %.*s not found", key_len, key);
 469
 470   if (previous != NULL) {
 471     previous->next = current->next;
 472   } else {
 473     dict->table[hash_code & dict->table_size] = current->next;
 474   }
 475
 476   if (!dict->table[hash_code & dict->table_size])
 477     dict->fill--;
 478
 479   xbt_dictelm_free(dict, current);
 480   dict->count--;
 481 }
 482
 483
 484
 485 /**
 486  * \brief Remove data from the dict (null-terminated key)
 487  *
 488  * \param dict the dict
 489  * \param key the key of the data to be removed
 490  *
 491  * Remove the entry associated with the given \a key
 492  */
 493 XBT_INLINE void xbt_dict_remove(xbt_dict_t dict, const char *key)
 494 {
 495   xbt_dict_remove_ext(dict, key, strlen(key));
 496 }
 497
 498 #ifdef XBT_USE_DEPRECATED
 499 /**
 500  * \brief Add data to the dict (arbitrary key)
 501  * \param dict the container
 502  * \param key the key to set the new data
 503  * \param data the data to add in the dict
 504  *
 505  * Set the \a data in the structure under the \a key.
 506  * Both \a data and \a key are considered as uintptr_t.
 507  */
 508 XBT_INLINE void xbt_dicti_set(xbt_dict_t dict,
 509                               uintptr_t key, uintptr_t data)
 510 {
 511   xbt_dict_set_ext(dict, (void *)&key, sizeof key, (void*)data, NULL);
 512 }
 513
 514 /**
 515  * \brief Retrieve data from the dict (key considered as a uintptr_t)
 516  *
 517  * \param dict the dealer of data
 518  * \param key the key to find data
 519  * \return the data that we are looking for (or 0 if not found)
 520  *
 521  * Mixing uintptr_t keys with regular keys in the same dict is discouraged
 522  */
 523 XBT_INLINE uintptr_t xbt_dicti_get(xbt_dict_t dict, uintptr_t key)
 524 {
 525   return (uintptr_t)xbt_dict_get_or_null_ext(dict, (void *)&key, sizeof key);
 526 }
 527
 528 /** Remove a uintptr_t key from the dict */
 529 XBT_INLINE void xbt_dicti_remove(xbt_dict_t dict, uintptr_t key)
 530 {
 531   xbt_dict_remove_ext(dict, (void *)&key, sizeof key);
 532 }
 533 #endif
 534
 535 /**
 536  * \brief Remove all data from the dict
 537  * \param dict the dict
 538  */
 539 void xbt_dict_reset(xbt_dict_t dict)
 540 {
 541
 542   int i;
 543   xbt_dictelm_t current, previous = NULL;
 544
 545   xbt_assert(dict);
 546
 547   if (dict->count == 0)
 548     return;
 549
 550   for (i = 0; i <= dict->table_size; i++) {
 551     current = dict->table[i];
 552     while (current != NULL) {
 553       previous = current;
 554       current = current->next;
 555       xbt_dictelm_free(dict, previous);
 556     }
 557     dict->table[i] = NULL;
 558   }
 559
 560   dict->count = 0;
 561   dict->fill = 0;
 562 }
 563
 564 /**
 565  * \brief Return the number of elements in the dict.
 566  * \param dict a dictionary
 567  */
 568 XBT_INLINE int xbt_dict_length(xbt_dict_t dict)
 569 {
 570   xbt_assert(dict);
 571
 572   return dict->count;
 573 }
 574
 575 /** @brief function to be used in xbt_dict_dump as long as the stored values are strings */
 576 void xbt_dict_dump_output_string(void *s)
 577 {
 578   fputs(s, stdout);
 579 }
 580
 581 /**
 582  * \brief test if the dict is empty or not
 583  */
 584 XBT_INLINE int xbt_dict_is_empty(xbt_dict_t dict)
 585 {
 586   return !dict || (xbt_dict_length(dict) == 0);
 587 }
 588
 589 /**
 590  * \brief Outputs the content of the structure (debugging purpose)
 591  *
 592  * \param dict the exibitionist
 593  * \param output a function to dump each data in the tree (check @ref xbt_dict_dump_output_string)
 594  *
 595  * Outputs the content of the structure. (for debugging purpose). \a output is a
 596  * function to output the data. If NULL, data won't be displayed.
 597  */
 598
 599 void xbt_dict_dump(xbt_dict_t dict, void_f_pvoid_t output)
 600 {
 601   int i;
 602   xbt_dictelm_t element;
 603   printf("Dict %p:\n", dict);
 604   if (dict != NULL) {
 605     for (i = 0; i < dict->table_size; i++) {
 606       element = dict->table[i];
 607       if (element) {
 608         printf("[\n");
 609         while (element != NULL) {
 610           printf(" %s -> '", element->key);
 611           if (output != NULL) {
 612             output(element->content);
 613           }
 614           printf("'\n");
 615           element = element->next;
 616         }
 617         printf("]\n");
 618       } else {
 619         printf("[]\n");
 620       }
 621     }
 622   }
 623 }
 624
 625 xbt_dynar_t all_sizes = NULL;
 626 /** @brief shows some debugging info about the bucklet repartition */
 627 void xbt_dict_dump_sizes(xbt_dict_t dict)
 628 {
 629
 630   int i;
 631   unsigned int count;
 632   unsigned int size;
 633   xbt_dictelm_t element;
 634   xbt_dynar_t sizes = xbt_dynar_new(sizeof(int), NULL);
 635
 636   printf("Dict %p: %d bucklets, %d used cells (of %d) ", dict, dict->count,
 637          dict->fill, dict->table_size);
 638   if (dict != NULL) {
 639     for (i = 0; i < dict->table_size; i++) {
 640       element = dict->table[i];
 641       size = 0;
 642       if (element) {
 643         while (element != NULL) {
 644           size++;
 645           element = element->next;
 646         }
 647       }
 648       if (xbt_dynar_length(sizes) <= size) {
 649         int prevsize = 1;
 650         xbt_dynar_set(sizes, size, &prevsize);
 651       } else {
 652         int prevsize;
 653         xbt_dynar_get_cpy(sizes, size, &prevsize);
 654         prevsize++;
 655         xbt_dynar_set(sizes, size, &prevsize);
 656       }
 657     }
 658     if (!all_sizes)
 659       all_sizes = xbt_dynar_new(sizeof(int), NULL);
 660
 661     xbt_dynar_foreach(sizes, count, size) {
 662       /* Copy values of this one into all_sizes */
 663       int prevcount;
 664       if (xbt_dynar_length(all_sizes) <= count) {
 665         prevcount = size;
 666         xbt_dynar_set(all_sizes, count, &prevcount);
 667       } else {
 668         xbt_dynar_get_cpy(all_sizes, count, &prevcount);
 669         prevcount += size;
 670         xbt_dynar_set(all_sizes, count, &prevcount);
 671       }
 672
 673       /* Report current sizes */
 674       if (count == 0)
 675         continue;
 676       if (size == 0)
 677         continue;
 678       printf("%delm x %u cells; ", count, size);
 679     }
 680   }
 681   printf("\n");
 682   xbt_dynar_free(&sizes);
 683 }
 684
 685 /**
 686  * Create the dict mallocators.
 687  * This is an internal XBT function called during the lib initialization.
 688  * It can be used several times to recreate the mallocator, for example when you switch to MC mode
 689  */
 690 void xbt_dict_preinit(void)
 691 {
 692   if (dict_elm_mallocator != NULL) {
 693     /* Already created. I guess we want to switch to MC mode, so kill the previously created mallocator */
 694     xbt_mallocator_free(dict_elm_mallocator);
 695     xbt_mallocator_free(dict_het_elm_mallocator);
 696   }
 697
 698   dict_elm_mallocator = xbt_mallocator_new(256,
 699                                            dict_elm_mallocator_new_f,
 700                                            dict_elm_mallocator_free_f,
 701                                            dict_elm_mallocator_reset_f);
 702   dict_het_elm_mallocator = xbt_mallocator_new(256,
 703                                                dict_het_elm_mallocator_new_f,
 704                                                dict_het_elm_mallocator_free_f,
 705                                                dict_het_elm_mallocator_reset_f);
 706 }
 707
 708 /**
 709  * Destroy the dict mallocators.
 710  * This is an internal XBT function during the lib initialization
 711  */
 712 void xbt_dict_postexit(void)
 713 {
 714   if (dict_elm_mallocator != NULL) {
 715     xbt_mallocator_free(dict_elm_mallocator);
 716     dict_elm_mallocator = NULL;
 717     xbt_mallocator_free(dict_het_elm_mallocator);
 718     dict_het_elm_mallocator = NULL;
 719   }
 720   if (all_sizes) {
 721     unsigned int count;
 722     int size;
 723     double avg = 0;
 724     int total_count = 0;
 725     printf("Overall stats:");
 726     xbt_dynar_foreach(all_sizes, count, size) {
 727       if (count == 0)
 728         continue;
 729       if (size == 0)
 730         continue;
 731       printf("%delm x %d cells; ", count, size);
 732       avg += count * size;
 733       total_count += size;
 734     }
 735     printf("; %f elm per cell\n", avg / (double) total_count);
 736   }
 737 }
 738
 739 #ifdef SIMGRID_TEST
 740 #include "xbt.h"
 741 #include "xbt/ex.h"
 742 #include "portable.h"
 743
 744 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
 745 XBT_LOG_DEFAULT_CATEGORY(xbt_dict);
 746
 747 XBT_TEST_SUITE("dict", "Dict data container");
 748
 749 static void print_str(void *str)
 750 {
 751   printf("%s", (char *) PRINTF_STR(str));
 752 }
 753
 754 static void debuged_add_ext(xbt_dict_t head, const char *key,
 755                             const char *data_to_fill, void_f_pvoid_t free_f)
 756 {
 757   char *data = xbt_strdup(data_to_fill);
 758
 759   xbt_test_log("Add %s under %s", PRINTF_STR(data_to_fill),
 760                 PRINTF_STR(key));
 761
 762   xbt_dict_set(head, key, data, free_f);
 763   if (XBT_LOG_ISENABLED(xbt_dict, xbt_log_priority_debug)) {
 764     xbt_dict_dump(head, (void (*)(void *)) &printf);
 765     fflush(stdout);
 766   }
 767 }
 768
 769 static void debuged_add(xbt_dict_t head, const char *key, void_f_pvoid_t free_f)
 770 {
 771   debuged_add_ext(head, key, key, free_f);
 772 }
 773
 774 static void fill(xbt_dict_t * head, int homogeneous)
 775 {
 776   void_f_pvoid_t free_f = homogeneous ? NULL : &free;
 777
 778   xbt_test_add("Fill in the dictionnary");
 779
 780   *head = homogeneous ? xbt_dict_new_homogeneous(&free) : xbt_dict_new();
 781   debuged_add(*head, "12", free_f);
 782   debuged_add(*head, "12a", free_f);
 783   debuged_add(*head, "12b", free_f);
 784   debuged_add(*head, "123", free_f);
 785   debuged_add(*head, "123456", free_f);
 786   /* Child becomes child of what to add */
 787   debuged_add(*head, "1234", free_f);
 788   /* Need of common ancestor */
 789   debuged_add(*head, "123457", free_f);
 790 }
 791
 792
 793 static void search_ext(xbt_dict_t head, const char *key, const char *data)
 794 {
 795   void *found;
 796
 797   xbt_test_add("Search %s", key);
 798   found = xbt_dict_get(head, key);
 799   xbt_test_log("Found %s", (char *) found);
 800   if (data)
 801     xbt_test_assert(found,
 802                      "data do not match expectations: found NULL while searching for %s",
 803                      data);
 804   if (found)
 805     xbt_test_assert(!strcmp((char *) data, found),
 806                      "data do not match expectations: found %s while searching for %s",
 807                      (char *) found, data);
 808 }
 809
 810 static void search(xbt_dict_t head, const char *key)
 811 {
 812   search_ext(head, key, key);
 813 }
 814
 815 static void debuged_remove(xbt_dict_t head, const char *key)
 816 {
 817
 818   xbt_test_add("Remove '%s'", PRINTF_STR(key));
 819   xbt_dict_remove(head, key);
 820   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
 821 }
 822
 823
 824 static void traverse(xbt_dict_t head)
 825 {
 826   xbt_dict_cursor_t cursor = NULL;
 827   char *key;
 828   char *data;
 829   int i = 0;
 830
 831   xbt_dict_foreach(head, cursor, key, data) {
 832     if (!key || !data || strcmp(key, data)) {
 833       xbt_test_log("Seen #%d:  %s->%s", ++i, PRINTF_STR(key),
 834                     PRINTF_STR(data));
 835     } else {
 836       xbt_test_log("Seen #%d:  %s", ++i, PRINTF_STR(key));
 837     }
 838     xbt_test_assert(!data || !strcmp(key, data),
 839                      "Key(%s) != value(%s). Aborting", key, data);
 840   }
 841 }
 842
 843 static void search_not_found(xbt_dict_t head, const char *data)
 844 {
 845   int ok = 0;
 846   xbt_ex_t e;
 847
 848   xbt_test_add("Search %s (expected not to be found)", data);
 849
 850   TRY {
 851     data = xbt_dict_get(head, data);
 852     THROWF(unknown_error, 0,
 853            "Found something which shouldn't be there (%s)", data);
 854   }
 855   CATCH(e) {
 856     if (e.category != not_found_error)
 857       xbt_test_exception(e);
 858     xbt_ex_free(e);
 859     ok = 1;
 860   }
 861   xbt_test_assert(ok, "Exception not raised");
 862 }
 863
 864 static void count(xbt_dict_t dict, int length)
 865 {
 866   xbt_dict_cursor_t cursor;
 867   char *key;
 868   void *data;
 869   int effective = 0;
 870
 871
 872   xbt_test_add("Count elements (expecting %d)", length);
 873   xbt_test_assert(xbt_dict_length(dict) == length,
 874                    "Announced length(%d) != %d.", xbt_dict_length(dict),
 875                    length);
 876
 877   xbt_dict_foreach(dict, cursor, key, data)
 878       effective++;
 879
 880   xbt_test_assert(effective == length, "Effective length(%d) != %d.",
 881                    effective, length);
 882
 883 }
 884
 885 static void count_check_get_key(xbt_dict_t dict, int length)
 886 {
 887   xbt_dict_cursor_t cursor;
 888   char *key;
 889   _XBT_GNUC_UNUSED char *key2;
 890   void *data;
 891   int effective = 0;
 892
 893
 894   xbt_test_add
 895       ("Count elements (expecting %d), and test the getkey function",
 896        length);
 897   xbt_test_assert(xbt_dict_length(dict) == length,
 898                    "Announced length(%d) != %d.", xbt_dict_length(dict),
 899                    length);
 900
 901   xbt_dict_foreach(dict, cursor, key, data) {
 902     effective++;
 903     key2 = xbt_dict_get_key(dict, data);
 904     xbt_assert(!strcmp(key, key2),
 905                 "The data was registered under %s instead of %s as expected",
 906                 key2, key);
 907   }
 908
 909   xbt_test_assert(effective == length, "Effective length(%d) != %d.",
 910                    effective, length);
 911
 912 }
 913
 914 xbt_ex_t e;
 915 xbt_dict_t head = NULL;
 916 char *data;
 917
 918 static void basic_test(int homogeneous)
 919 {
 920   void_f_pvoid_t free_f;
 921
 922   xbt_test_add("Traversal the null dictionary");
 923   traverse(head);
 924
 925   xbt_test_add("Traversal and search the empty dictionary");
 926   head = homogeneous ? xbt_dict_new_homogeneous(&free) : xbt_dict_new();
 927   traverse(head);
 928   TRY {
 929     debuged_remove(head, "12346");
 930   }
 931   CATCH(e) {
 932     if (e.category != not_found_error)
 933       xbt_test_exception(e);
 934     xbt_ex_free(e);
 935   }
 936   xbt_dict_free(&head);
 937
 938   free_f = homogeneous ? NULL : &free;
 939
 940   xbt_test_add("Traverse the full dictionary");
 941   fill(&head, homogeneous);
 942   count_check_get_key(head, 7);
 943
 944   debuged_add_ext(head, "toto", "tutu", free_f);
 945   search_ext(head, "toto", "tutu");
 946   debuged_remove(head, "toto");
 947
 948   search(head, "12a");
 949   traverse(head);
 950
 951   xbt_test_add("Free the dictionary (twice)");
 952   xbt_dict_free(&head);
 953   xbt_dict_free(&head);
 954
 955   /* CHANGING */
 956   fill(&head, homogeneous);
 957   count_check_get_key(head, 7);
 958   xbt_test_add("Change 123 to 'Changed 123'");
 959   xbt_dict_set(head, "123", strdup("Changed 123"), free_f);
 960   count_check_get_key(head, 7);
 961
 962   xbt_test_add("Change 123 back to '123'");
 963   xbt_dict_set(head, "123", strdup("123"), free_f);
 964   count_check_get_key(head, 7);
 965
 966   xbt_test_add("Change 12a to 'Dummy 12a'");
 967   xbt_dict_set(head, "12a", strdup("Dummy 12a"), free_f);
 968   count_check_get_key(head, 7);
 969
 970   xbt_test_add("Change 12a to '12a'");
 971   xbt_dict_set(head, "12a", strdup("12a"), free_f);
 972   count_check_get_key(head, 7);
 973
 974   xbt_test_add("Traverse the resulting dictionary");
 975   traverse(head);
 976
 977   /* RETRIEVE */
 978   xbt_test_add("Search 123");
 979   data = xbt_dict_get(head, "123");
 980   xbt_test_assert(data);
 981   xbt_test_assert(!strcmp("123", data));
 982
 983   search_not_found(head, "Can't be found");
 984   search_not_found(head, "123 Can't be found");
 985   search_not_found(head, "12345678 NOT");
 986
 987   search(head, "12a");
 988   search(head, "12b");
 989   search(head, "12");
 990   search(head, "123456");
 991   search(head, "1234");
 992   search(head, "123457");
 993
 994   xbt_test_add("Traverse the resulting dictionary");
 995   traverse(head);
 996
 997   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
 998
 999   xbt_test_add("Free the dictionary twice");
1000   xbt_dict_free(&head);
1001   xbt_dict_free(&head);
1002
1003   xbt_test_add("Traverse the resulting dictionary");
1004   traverse(head);
1005 }
1006
1007 XBT_TEST_UNIT("basic_heterogeneous", test_dict_basic_heterogeneous, "Basic usage: change, retrieve, traverse: heterogeneous dict")
1008 {
1009   basic_test(0);
1010 }
1011
1012 XBT_TEST_UNIT("basic_homogeneous", test_dict_basic_homogeneous, "Basic usage: change, retrieve, traverse: homogeneous dict")
1013 {
1014   basic_test(1);
1015 }
1016
1017 static void remove_test(int homogeneous)
1018 {
1019   fill(&head, homogeneous);
1020   count(head, 7);
1021   xbt_test_add("Remove non existing data");
1022   TRY {
1023     debuged_remove(head, "Does not exist");
1024   }
1025   CATCH(e) {
1026     if (e.category != not_found_error)
1027       xbt_test_exception(e);
1028     xbt_ex_free(e);
1029   }
1030   traverse(head);
1031
1032   xbt_dict_free(&head);
1033
1034   xbt_test_add
1035       ("Remove each data manually (traversing the resulting dictionary each time)");
1036   fill(&head, homogeneous);
1037   debuged_remove(head, "12a");
1038   traverse(head);
1039   count(head, 6);
1040   debuged_remove(head, "12b");
1041   traverse(head);
1042   count(head, 5);
1043   debuged_remove(head, "12");
1044   traverse(head);
1045   count(head, 4);
1046   debuged_remove(head, "123456");
1047   traverse(head);
1048   count(head, 3);
1049   TRY {
1050     debuged_remove(head, "12346");
1051   }
1052   CATCH(e) {
1053     if (e.category != not_found_error)
1054       xbt_test_exception(e);
1055     xbt_ex_free(e);
1056     traverse(head);
1057   }
1058   debuged_remove(head, "1234");
1059   traverse(head);
1060   debuged_remove(head, "123457");
1061   traverse(head);
1062   debuged_remove(head, "123");
1063   traverse(head);
1064   TRY {
1065     debuged_remove(head, "12346");
1066   }
1067   CATCH(e) {
1068     if (e.category != not_found_error)
1069       xbt_test_exception(e);
1070     xbt_ex_free(e);
1071   }
1072   traverse(head);
1073
1074   xbt_test_add
1075       ("Free dict, create new fresh one, and then reset the dict");
1076   xbt_dict_free(&head);
1077   fill(&head, homogeneous);
1078   xbt_dict_reset(head);
1079   count(head, 0);
1080   traverse(head);
1081
1082   xbt_test_add("Free the dictionary twice");
1083   xbt_dict_free(&head);
1084   xbt_dict_free(&head);
1085 }
1086
1087 XBT_TEST_UNIT("remove_heterogeneous", test_dict_remove_heterogeneous, "Removing some values: heterogeneous dict")
1088 {
1089   remove_test(0);
1090 }
1091
1092 XBT_TEST_UNIT("remove_homogeneous", test_dict_remove_homogeneous, "Removing some values: homogeneous dict")
1093 {
1094   remove_test(1);
1095 }
1096
1097 XBT_TEST_UNIT("nulldata", test_dict_nulldata, "NULL data management")
1098 {
1099   fill(&head, 1);
1100
1101   xbt_test_add("Store NULL under 'null'");
1102   xbt_dict_set(head, "null", NULL, NULL);
1103   search_ext(head, "null", NULL);
1104
1105   xbt_test_add("Check whether I see it while traversing...");
1106   {
1107     xbt_dict_cursor_t cursor = NULL;
1108     char *key;
1109     int found = 0;
1110
1111     xbt_dict_foreach(head, cursor, key, data) {
1112       if (!key || !data || strcmp(key, data)) {
1113         xbt_test_log("Seen:  %s->%s", PRINTF_STR(key), PRINTF_STR(data));
1114       } else {
1115         xbt_test_log("Seen:  %s", PRINTF_STR(key));
1116       }
1117
1118       if (!strcmp(key, "null"))
1119         found = 1;
1120     }
1121     xbt_test_assert(found,
1122                      "the key 'null', associated to NULL is not found");
1123   }
1124   xbt_dict_free(&head);
1125 }
1126
1127 #define NB_ELM 20000
1128 #define SIZEOFKEY 1024
1129 static int countelems(xbt_dict_t head)
1130 {
1131   xbt_dict_cursor_t cursor;
1132   char *key;
1133   void *data;
1134   int res = 0;
1135
1136   xbt_dict_foreach(head, cursor, key, data) {
1137     res++;
1138   }
1139   return res;
1140 }
1141
1142 XBT_TEST_UNIT("crash", test_dict_crash, "Crash test")
1143 {
1144   xbt_dict_t head = NULL;
1145   int i, j, k;
1146   char *key;
1147   void *data;
1148
1149   srand((unsigned int) time(NULL));
1150
1151   for (i = 0; i < 10; i++) {
1152     xbt_test_add("CRASH test number %d (%d to go)", i + 1, 10 - i - 1);
1153     xbt_test_log
1154         ("Fill the struct, count its elems and frees the structure");
1155     xbt_test_log
1156         ("using 1000 elements with %d chars long randomized keys.",
1157          SIZEOFKEY);
1158     head = xbt_dict_new();
1159     /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
1160     for (j = 0; j < 1000; j++) {
1161       char *data = NULL;
1162       key = xbt_malloc(SIZEOFKEY);
1163
1164       do {
1165         for (k = 0; k < SIZEOFKEY - 1; k++)
1166           key[k] = rand() % ('z' - 'a') + 'a';
1167         key[k] = '\0';
1168         /*      printf("[%d %s]\n",j,key); */
1169         data = xbt_dict_get_or_null(head, key);
1170       } while (data != NULL);
1171
1172       xbt_dict_set(head, key, key, &free);
1173       data = xbt_dict_get(head, key);
1174       xbt_test_assert(!strcmp(key, data),
1175                        "Retrieved value (%s) != Injected value (%s)", key,
1176                        data);
1177
1178       count(head, j + 1);
1179     }
1180     /*    xbt_dict_dump(head,(void (*)(void*))&printf); */
1181     traverse(head);
1182     xbt_dict_free(&head);
1183     xbt_dict_free(&head);
1184   }
1185
1186
1187   head = xbt_dict_new();
1188   xbt_test_add("Fill %d elements, with keys being the number of element",
1189                 NB_ELM);
1190   for (j = 0; j < NB_ELM; j++) {
1191     /* if (!(j%1000)) { printf("."); fflush(stdout); } */
1192
1193     key = xbt_malloc(10);
1194
1195     sprintf(key, "%d", j);
1196     xbt_dict_set(head, key, key, &free);
1197   }
1198   /*xbt_dict_dump(head,(void (*)(void*))&printf); */
1199
1200   xbt_test_add
1201       ("Count the elements (retrieving the key and data for each)");
1202   i = countelems(head);
1203   xbt_test_log("There is %d elements", i);
1204
1205   xbt_test_add("Search my %d elements 20 times", NB_ELM);
1206   key = xbt_malloc(10);
1207   for (i = 0; i < 20; i++) {
1208     /* if (i%10) printf("."); else printf("%d",i/10); fflush(stdout); */
1209     for (j = 0; j < NB_ELM; j++) {
1210
1211       sprintf(key, "%d", j);
1212       data = xbt_dict_get(head, key);
1213       xbt_test_assert(!strcmp(key, (char *) data),
1214                        "with get, key=%s != data=%s", key, (char *) data);
1215       data = xbt_dict_get_ext(head, key, strlen(key));
1216       xbt_test_assert(!strcmp(key, (char *) data),
1217                        "with get_ext, key=%s != data=%s", key,
1218                        (char *) data);
1219     }
1220   }
1221   free(key);
1222
1223   xbt_test_add("Remove my %d elements", NB_ELM);
1224   key = xbt_malloc(10);
1225   for (j = 0; j < NB_ELM; j++) {
1226     /* if (!(j%10000)) printf("."); fflush(stdout); */
1227
1228     sprintf(key, "%d", j);
1229     xbt_dict_remove(head, key);
1230   }
1231   free(key);
1232
1233
1234   xbt_test_add("Free the structure (twice)");
1235   xbt_dict_free(&head);
1236   xbt_dict_free(&head);
1237 }
1238
1239 #endif                          /* SIMGRID_TEST */