src/xbt/dict.c

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