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