src/xbt/dict_elm.c

   1 /* $Id$ */
   2
   3 /* dict - a generic dictionnary, variation over the B-tree concept          */
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2003 the OURAGAN project.                                  */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #include "dict_private.h"  /* prototypes of this module */
  12
  13 XBT_LOG_EXTERNAL_CATEGORY(dict);
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dict_elm,dict,"Dictionaries internals");
  15
  16 XBT_LOG_NEW_SUBCATEGORY(dict_add,dict,"Dictionaries internals: elements addition");
  17 XBT_LOG_NEW_SUBCATEGORY(dict_search,dict,"Dictionaries internals: searching");
  18 XBT_LOG_NEW_SUBCATEGORY(dict_remove,dict,"Dictionaries internals: elements removal");
  19 XBT_LOG_NEW_SUBCATEGORY(dict_collapse,dict,"Dictionaries internals: post-removal cleanup");
  20 XBT_LOG_NEW_SUBCATEGORY(dict_multi,dict,"Dictionaries internals: dictionaries of dictionaries");
  21
  22 /*####[ Private prototypes ]#################################################*/
  23
  24 static _XBT_INLINE void _xbt_dictelm_alloc(char                *key,
  25                                              int                  offset,
  26                                              int                  key_len,
  27                                              void                *data,
  28                                              void_f_pvoid_t      *free_f,
  29                                              /*OUT*/s_xbt_dictelm_t **where);
  30 static void         _dictelm_wrapper_free(void*);
  31
  32 static _XBT_INLINE void  _str_prefix_lgr(const char *key1,
  33                                           int         key_len1,
  34                                           const char *key2,
  35                                           int         key_len2,
  36                                           int        *offset,
  37                                           int        *match);
  38
  39
  40 static void _xbt_dictelm_dump_rec(s_xbt_dictelm_t *head,
  41                                    int             offset,
  42                                    void_f_pvoid_t *output);
  43
  44
  45
  46 static void _xbt_dictelm_set_rec(s_xbt_dictelm_t *head,
  47                                   char           *key,
  48                                   int             key_len,
  49                                   int             offset,
  50                                   void           *data,
  51                                   void_f_pvoid_t *free_f);
  52 static xbt_error_t _xbt_dictelm_get_rec(s_xbt_dictelm_t *head,
  53                                                const char     *key,
  54                                                int             key_len,
  55                                                int             offset,
  56                                                /* OUT */void **data);
  57 static xbt_error_t _xbt_dictelm_remove_rec(s_xbt_dictelm_t *head,
  58                                              const char     *key,
  59                                              int             key_len,
  60                                              int             offset);
  61
  62 static _XBT_INLINE
  63 void
  64 _collapse_if_need(s_xbt_dictelm_t *p_head,
  65                   int             pos,
  66                   int             offset);
  67
  68 /* ---- */
  69
  70 static _XBT_INLINE
  71 void *
  72 xbt_memdup(const void * const ptr,
  73             const size_t       length) {
  74   void * new_ptr = NULL;
  75
  76   new_ptr = xbt_malloc(length);
  77   memcpy(new_ptr, ptr, length);
  78
  79   return new_ptr;
  80 }
  81
  82 /*
  83  * _xbt_nibble_to_char:
  84  *
  85  * Change any byte to a printable char
  86  */
  87
  88 static _XBT_INLINE
  89 char
  90 _xbt_nibble_to_char(unsigned char c) {
  91   c &= 0x0f;
  92   return c>9 ? c-10+'a' : c + '0';
  93 }
  94
  95 /*
  96  * _xbt_bytes_to_string:
  97  *
  98  * Change any byte array to a printable string
  99  * The length of string_container should at least be data_len*2+1
 100  */
 101 static _XBT_INLINE
 102 char *
 103 _xbt_bytes_to_string(char * const ptr,
 104                       int          data_len,
 105                       char * const string_container) {
 106   unsigned char *src = (unsigned char *)ptr;
 107            char *dst = string_container;
 108
 109   while (data_len--) {
 110     *dst++ = _xbt_nibble_to_char(*src   & 0x0f     );
 111     *dst++ = _xbt_nibble_to_char(*src++ & 0xf0 >> 4);
 112   }
 113
 114   *dst = 0;
 115
 116   return ptr;
 117 }
 118
 119 /* ---- */
 120
 121 /*
 122  * _xbt_dictelm_alloc:
 123  *
 124  * Alloc a dict element with no child.
 125  */
 126 static _XBT_INLINE
 127 void
 128 _xbt_dictelm_alloc(char                *key,
 129                     int                  key_len,
 130                     int                  offset,
 131                     void                *data,
 132                     void_f_pvoid_t      *free_f,
 133                  /*OUT*/s_xbt_dictelm_t **pp_elm) {
 134   xbt_error_t   errcode = no_error;
 135   s_xbt_dictelm_t *p_elm  = NULL;
 136
 137   p_elm = xbt_new(s_xbt_dictelm_t,1);
 138
 139   p_elm->key      = key;
 140   p_elm->key_len  = key_len;
 141   p_elm->offset   = offset;
 142   p_elm->content  = data;
 143   p_elm->free_f = free_f;
 144   p_elm->sub      = xbt_dynar_new(sizeof(s_xbt_dictelm_t*), _dictelm_wrapper_free);
 145
 146   *pp_elm = p_elm;
 147
 148 }
 149
 150 /**
 151  * xbt_dictelm_free:
 152  *
 153  * @pp_elm: the dict elem to be freed
 154  *
 155  * Frees a dictionnary element with all its childs.
 156  */
 157 void
 158 xbt_dictelm_free(s_xbt_dictelm_t **pp_elm)  {
 159   if (*pp_elm) {
 160     s_xbt_dictelm_t *p_elm = *pp_elm;
 161
 162     xbt_dynar_free(&(p_elm->sub));
 163
 164     if (p_elm->key) {
 165       xbt_free(p_elm->key);
 166     }
 167
 168     if (p_elm->free_f && p_elm->content) {
 169       p_elm->free_f(p_elm->content);
 170     }
 171
 172     xbt_free(p_elm);
 173     *pp_elm = NULL;
 174   }
 175 }
 176
 177 /**
 178  * _dictelm_wrapper_free:
 179  *
 180  * a wrapper to free dictelm with the right prototype to be usable within dynar
 181  */
 182 static
 183 void
 184 _dictelm_wrapper_free(void *pp_elm) {
 185   DEBUG3("Free dictelm '%.*s' %p",
 186          (*(s_xbt_dictelm_t**)pp_elm)->key_len, (*(s_xbt_dictelm_t**)pp_elm)->key,
 187          *(void**)pp_elm);
 188   xbt_dictelm_free((s_xbt_dictelm_t**)pp_elm);
 189 }
 190
 191 /*####[ utility functions ]##################################################*/
 192 /**
 193  * _str_prefix_lgr:
 194  *
 195  *
 196  * Returns the length of the common prefix of @str1 and @str2.
 197  * Do make sure the strings are not null
 198  */
 199 static _XBT_INLINE
 200 void
 201 _str_prefix_lgr(const char *key1,
 202                 int         key_len1,
 203                 const char *key2,
 204                 int         key_len2,
 205                 int        *p_offset,
 206                 int        *p_match) {
 207   const int old_offset = *p_offset;
 208   int       o          = *p_offset;
 209   int       m          = *p_match;
 210
 211   m = 0;
 212
 213   /*CDEBUG5(dict_search, "%s: [%.*s] <=> [%.*s]", __FUNCTION__,
 214             key1,key_len1,key2,key_len2);*/
 215
 216   if (o < key_len1  &&  o < key_len2) {
 217
 218     while (key1[o] == key2[o]) {
 219       o++;
 220
 221       if (!(o < key_len1  &&  o < key_len2))
 222         break;
 223
 224     }
 225
 226   }
 227
 228
 229   if (o != old_offset) {
 230
 231     if (o >= key_len1) {
 232
 233       if (o >= key_len2) {
 234         m = 1;
 235       } else {
 236         m = 2;
 237       }
 238
 239     } else if (o >= key_len2) {
 240       m = 3;
 241     } else {
 242       m = 4;
 243     }
 244   }
 245
 246
 247   *p_offset = o;
 248   *p_match  = m;
 249 }
 250
 251 /**
 252  * _dictelm_child_cmp:
 253  *
 254  * Compares two dictelm keys and return their matching (using the same
 255  * convention than @_xbt_dict_child_search() )
 256  */
 257 static _XBT_INLINE
 258 void
 259 _dict_child_cmp(s_xbt_dictelm_t *p_dict,
 260                 int          pos,
 261                 const char  *key,
 262                 const int    key_len,
 263                 int         *p_offset,
 264                 int         *p_match,
 265                 int         *p_cmp) {
 266   s_xbt_dictelm_t  *p_child = NULL;
 267   int           cmp     = 0;
 268   int           o       = *p_offset;
 269   int           m       = *p_match;
 270
 271   p_child = xbt_dynar_get_as(p_dict->sub, pos, s_xbt_dictelm_t*);
 272
 273   /* Compute the length of the prefix
 274      and if the searched key is before or after cur */
 275   _str_prefix_lgr(p_child->key, p_child->key_len,
 276                   key,          key_len,
 277                   &o, &m);
 278
 279
 280   if (m) /* found, get out */
 281     goto end;
 282
 283   if (o < p_child->key_len  &&  (o >= key_len  ||  key[o] < p_child->key[o])) {
 284     cmp = -1;
 285   } else {
 286     cmp =  1;
 287   }
 288
 289   CDEBUG6(dict_search, "Cmp '%.*s' and '%.*s' (offset=%d) => %d",
 290           p_child->key_len - *p_offset, p_child->key + *p_offset,
 291           key_len - *p_offset, key + *p_offset,
 292           *p_offset,cmp);
 293
 294  end:
 295   *p_offset = o;
 296   *p_match  = m;
 297   *p_cmp    = cmp;
 298 }
 299
 300 /**
 301  * _xbt_dict_child_search:
 302  *
 303  * Search where would be inserted @key between the childs of @p_elm.
 304  *
 305  * Returns position of the child having a common prefix with this key
 306  * If *match==0, no child have a common prefix
 307  *               *pos is where to add the key
 308  * If *match==1, A child (located at *pos) have exactly this key
 309  * If *match==2, A child (located at *pos) constitutes a prefix of the key
 310  *               the recursion have to go on that guy
 311  *               *prefix = the size of the key eaten at this level
 312  * If *match==3  The key is a prefix of the child at *pos
 313  * If *match==4, A child (loc. at *pos) share a common prefix with this key
 314  *               *prefix = size of the prefix.
 315  *               If searching, that's a mismatch.
 316  *               If inserting, you have to break the child and create an
 317  *                 internal node having {child, key} as childs
 318  * offset is used in input and output. In input, that's the length of the key
 319  *  handled by previous levels of recursion. In output, that the one counting
 320  *  also this level.
 321  */
 322 static _XBT_INLINE
 323 void
 324 _xbt_dictelm_child_search(s_xbt_dictelm_t *p_elm,
 325                            const char  *key,
 326                            int          key_len,
 327                            int         *p_pos,
 328                            int         *p_offset,
 329                            int         *p_match) {
 330
 331   int          p       = 0;
 332   int          o       = *p_offset;
 333   int          m       = 0;
 334   int          len     = 0;
 335
 336
 337   CDEBUG5(dict_search, "search child [%.*s] under [%.*s] (len=%lu)",
 338           key_len, key,
 339           p_elm?p_elm->key_len:6, p_elm?p_elm->key:"(head)",
 340           (p_elm&&p_elm->sub)?xbt_dynar_length(p_elm->sub):0);
 341
 342
 343   len = xbt_dynar_length(p_elm->sub);
 344
 345   for (p = 0; p < len; p++) {
 346     int          cmp     = 0;
 347
 348     _dict_child_cmp(p_elm, p, key, key_len, &o, &m, &cmp);
 349
 350     if (m)
 351       break;
 352
 353     o = *p_offset;
 354     m = 0;
 355   }
 356
 357   *p_offset = o;
 358   *p_pos    = p;
 359   *p_match  = m;
 360   CDEBUG5(dict_search, "search [%.*s] in [%.*s] => %s",
 361           key_len, key,
 362           p_elm?p_elm->key_len:6, p_elm?p_elm->key:"(head)",
 363           ( m == 0 ? "no child have a common prefix" :
 364             ( m == 1 ? "selected child have exactly this key" :
 365               ( m == 2 ? "selected child constitutes a prefix" :
 366                 ( m == 3 ? "key is a prefix of selected child" :
 367                   (m == 4 ? "selected child share a prefix" :
 368                    "internal error")))))
 369           );
 370 }
 371
 372 /**
 373  * _xbt_dictelm_change_value:
 374  *
 375  * Change the value of the dictelm, making sure to free the old one, if any.
 376  */
 377 static _XBT_INLINE
 378 void
 379 _xbt_dictelm_change_value(s_xbt_dictelm_t    *p_elm,
 380                            void           *data,
 381                            void_f_pvoid_t *free_f) {
 382
 383   if (p_elm->content && p_elm->free_f) {
 384     p_elm->free_f(p_elm->content);
 385   }
 386
 387   p_elm->free_f = free_f;
 388   p_elm->content  = data;
 389 }
 390
 391 /**
 392  * _xbt_dictelm_set_rec:
 393  *
 394  * @head: the head of the dict
 395  * @key: the key to set the new data
 396  * @offset: offset on key.
 397  * @data: the data to add in the dict
 398  *
 399  * set the @data in the structure under the @key. The @key is destroyed
 400  * in the process. Think to strdup it before.
 401  *
 402  * This is a helper function to xbt_dict_set which locks the struct and
 403  * strdup the key before action.
 404  */
 405 void
 406 _xbt_dictelm_set_rec(s_xbt_dictelm_t     *p_head,
 407                          char            *key,
 408                          int              key_len,
 409                          int              offset,
 410                          void            *data,
 411                          void_f_pvoid_t  *free_f) {
 412   int          match      = 0;
 413   int          pos        = 0;
 414   const int    old_offset = offset;
 415
 416   CDEBUG6(dict_add, "--> Insert '%.*s' after '%.*s' (offset=%d) in tree %p",
 417           key_len, key,
 418           ((p_head && p_head->key) ? p_head->key_len : 6),
 419           ((p_head && p_head->key) ? p_head->key : "(head)"),
 420           offset, (void*)p_head);
 421
 422   /*** The trivial cases first ***/
 423
 424   /* there is no key (we did enough recursion), change the value of head */
 425   if (offset >= key_len) {
 426
 427     CDEBUG0(dict_add, "--> Change the value of head");
 428
 429     _xbt_dictelm_change_value(p_head, data, free_f);
 430     xbt_free(key); /* Keep the key used in the tree */
 431
 432     return;
 433   }
 434
 435   /*** Search where to add this child, and how ***/
 436   _xbt_dictelm_child_search(p_head, key, key_len, &pos, &offset, &match);
 437
 438   CDEBUG3(dict_add, "child_search => pos=%d, offset=%d, match=%d",
 439           pos, offset, match);
 440
 441   switch (match) {
 442
 443   case 0: /* no child have a common prefix */
 444     {
 445       s_xbt_dictelm_t *p_child = NULL;
 446
 447       _xbt_dictelm_alloc(key, key_len, offset, data, free_f, &p_child);
 448       CDEBUG1(dict_add, "-> Add a child %p", (void*)p_child);
 449       xbt_dynar_insert_at(p_head->sub, pos, &p_child);
 450
 451       return;
 452     }
 453
 454   case 1: /* A child have exactly this key => change its value*/
 455     {
 456       s_xbt_dictelm_t *p_child = NULL;
 457
 458       p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 459       CDEBUG1(dict_add, "-> Change the value of the child %p", (void*)p_child);
 460       _xbt_dictelm_change_value(p_child, data, free_f);
 461
 462       xbt_free(key);
 463
 464       return;
 465     }
 466
 467   case 2: /* A child constitutes a prefix of the key => recurse */
 468     {
 469       s_xbt_dictelm_t *p_child = NULL;
 470
 471       p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 472       CDEBUG2(dict_add,"-> Recurse on %p (offset=%d)", (void*)p_child, offset);
 473
 474       _xbt_dictelm_set_rec(p_child, key, key_len,
 475                             offset, data, free_f);
 476       return;
 477     }
 478
 479   case 3: /* The key is a prefix of the child => child becomes child of p_new */
 480     {
 481       s_xbt_dictelm_t *p_new   = NULL;
 482       s_xbt_dictelm_t *p_child = NULL;
 483
 484       p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 485       _xbt_dictelm_alloc(key, key_len, old_offset, data, free_f, &p_new);
 486
 487       CDEBUG2(dict_add, "-> The child %p become child of new dict (%p)",
 488               (void*)p_child, (void*)p_new);
 489
 490       xbt_dynar_push(p_new->sub, &p_child);
 491       p_child->offset = offset;
 492       xbt_dynar_set(p_head->sub, pos, &p_new);
 493
 494       return;
 495     }
 496
 497   case 4: /* A child share a common prefix with this key => Common ancestor */
 498     {
 499       s_xbt_dictelm_t *p_new       = NULL;
 500       s_xbt_dictelm_t *p_child     = NULL;
 501       s_xbt_dictelm_t *p_anc       = NULL;
 502       char        *anc_key     = NULL;
 503       int          anc_key_len = offset;
 504
 505       _xbt_dictelm_alloc(key, key_len, offset, data, free_f, &p_new);
 506       p_child=xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 507
 508       anc_key = xbt_memdup(key, anc_key_len);
 509
 510       _xbt_dictelm_alloc(anc_key, anc_key_len, old_offset, NULL, NULL, &p_anc);
 511
 512       CDEBUG3(dict_add, "-> Make a common ancestor %p (%.*s)",
 513               (void*)p_anc, anc_key_len, anc_key);
 514
 515       if (key[offset] < p_child->key[offset]) {
 516         xbt_dynar_push(p_anc->sub, &p_new);
 517         xbt_dynar_push(p_anc->sub, &p_child);
 518       } else {
 519         xbt_dynar_push(p_anc->sub, &p_child);
 520         xbt_dynar_push(p_anc->sub, &p_new);
 521       }
 522
 523       p_child->offset = offset;
 524
 525       xbt_dynar_set(p_head->sub, pos, &p_anc);
 526
 527       return;
 528     }
 529
 530   default:
 531     DIE_IMPOSSIBLE;
 532   }
 533 }
 534
 535 /**
 536  * xbt_dictelm_set_ext:
 537  *
 538  * @head: the head of the dict
 539  * @key: the key to set the new data
 540  * @data: the data to add in the dict
 541  *
 542  * set the @data in the structure under the @key, which can be any kind
 543  * of data, as long as its length is provided in @key_len.
 544  */
 545 void
 546 xbt_dictelm_set_ext(s_xbt_dictelm_t **pp_head,
 547                         const char      *_key,
 548                         int              key_len,
 549                         void            *data,
 550                         void_f_pvoid_t  *free_f) {
 551   s_xbt_dictelm_t  *p_head  = *pp_head;
 552   char         *key     =  NULL;
 553
 554   key = xbt_memdup(_key, key_len);
 555
 556   /* there is no head, create it */
 557   if (!p_head) {
 558     s_xbt_dictelm_t *p_child = NULL;
 559
 560     CDEBUG0(dict_add, "Create an head");
 561
 562     /* The head is priviledged by being the only one with a NULL key */
 563     _xbt_dictelm_alloc(NULL, 0, 0, NULL, NULL, &p_head);
 564
 565     _xbt_dictelm_alloc(key, key_len, 0, data, free_f, &p_child);
 566     xbt_dynar_insert_at(p_head->sub, 0, &p_child);
 567
 568     *pp_head = p_head;
 569
 570     return;
 571   }
 572
 573   _xbt_dictelm_set_rec(p_head, key, key_len, 0, data, free_f);
 574 }
 575
 576 /**
 577  * xbt_dictelm_set:
 578  *
 579  * @head: the head of the dict
 580  * @key: the key to set the new data
 581  * @data: the data to add in the dict
 582  *
 583  * set the @data in the structure under the @key, which is a
 584  * null terminated string.
 585  */
 586 void
 587 xbt_dictelm_set(s_xbt_dictelm_t **pp_head,
 588                     const char      *_key,
 589                     void            *data,
 590                     void_f_pvoid_t  *free_f) {
 591
 592   xbt_dictelm_set_ext(pp_head, _key, 1+strlen(_key), data, free_f);
 593 }
 594
 595 /**
 596  * _xbt_dict_get_rec:
 597  *
 598  * @head: the head of the dict
 599  * @key: the key to find data
 600  * @offset: offset on the key
 601  * @data: the data that we are looking for
 602  * @Returns: xbt_error
 603  *
 604  * Search the given @key. mismatch_error when not found.
 605  */
 606 static
 607 xbt_error_t
 608 _xbt_dictelm_get_rec(s_xbt_dictelm_t *p_head,
 609                       const char     *key,
 610                       int             key_len,
 611                       int             offset,
 612                       void **data) {
 613   void *res;
 614
 615   CDEBUG3(dict_search, "Search %.*s in %p", key_len, key, (void*)p_head);
 616
 617   /*** The trivial case first ***/
 618
 619   /* we did enough recursion, we're done */
 620   if (offset >= key_len) {
 621     *data = p_head->content;
 622
 623     return no_error;
 624   }
 625
 626   {
 627     int match = 0;
 628     int pos   = 0;
 629
 630     *data = NULL; /* Make it ready to answer 'not found' in one operation */
 631
 632     /*** Search where is the good child, and how good it is ***/
 633     _xbt_dictelm_child_search(p_head, key, key_len, &pos, &offset, &match);
 634
 635     switch (match) {
 636
 637     case 0: /* no child have a common prefix */
 638       return mismatch_error;
 639
 640     case 1: /* A child have exactly this key => Got it */
 641       {
 642         s_xbt_dictelm_t *p_child = NULL;
 643
 644         p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 645         *data = p_child->content;
 646
 647         return no_error;
 648       }
 649
 650     case 2: /* A child constitutes a prefix of the key => recurse */
 651       {
 652         s_xbt_dictelm_t *p_child = NULL;
 653
 654         p_child = xbt_dynar_get_as(p_head->sub, pos, s_xbt_dictelm_t*);
 655
 656         return _xbt_dictelm_get_rec(p_child, key, key_len, offset, data);
 657       }
 658
 659     case 3: /* The key is a prefix of the child => not found */
 660       return mismatch_error;
 661
 662     case 4: /* A child share a common prefix with this key => not found */
 663       return mismatch_error;
 664
 665     default:
 666       RAISE_IMPOSSIBLE;
 667     }
 668   }
 669 }
 670
 671 /**
 672  * xbt_dictelm_get_ext:
 673  *
 674  * @head: the head of the dict
 675  * @key: the key to find data
 676  * @data: the data that we are looking for
 677  * @Returns: xbt_error
 678  *
 679  * Search the given @key. mismatch_error when not found.
 680  */
 681 xbt_error_t
 682 xbt_dictelm_get_ext(s_xbt_dictelm_t *p_head,
 683                           const char     *key,
 684                           int             key_len,
 685                           /* OUT */void **data) {
 686   /* there is no head, go to hell */
 687   if (!p_head) {
 688     return mismatch_error;
 689   }
 690
 691   return _xbt_dictelm_get_rec(p_head, key, key_len, 0, data);
 692 }
 693
 694 /**
 695  * xbt_dictelm_get:
 696  *
 697  * @head: the head of the dict
 698  * @key: the key to find data
 699  * @data: the data that we are looking for
 700  * @Returns: xbt_error
 701  *
 702  * Search the given @key. mismatch_error when not found.
 703  */
 704 xbt_error_t
 705 xbt_dictelm_get(s_xbt_dictelm_t    *p_head,
 706                    const char     *key,
 707                    /* OUT */void **data) {
 708
 709   return xbt_dictelm_get_ext(p_head, key, 1+strlen(key), data);
 710 }
 711
 712 /*----[ _xbt_dict_collapse ]------------------------------------------------*/
 713 static _XBT_INLINE
 714 void
 715 _collapse_if_need(xbt_dictelm_t head,
 716                   int            pos,
 717                   int            offset) {
 718   xbt_dictelm_t child = NULL;
 719
 720   CDEBUG2(dict_collapse, "Collapse %d of %p... ", pos, (void*)head);
 721
 722   if (pos >= 0) {
 723     /* Remove the child if |it's key| == 0 (meaning it's dead) */
 724     child = xbt_dynar_get_as(head->sub, pos, xbt_dictelm_t);
 725
 726     if (offset >= child->key_len) {
 727
 728       xbt_assert0(xbt_dynar_length(child->sub) == 0,
 729                    "Found a dead child with grand childs. Internal error");
 730
 731       CDEBUG1(dict_collapse, "Remove dead child %p.... ", (void*)child);
 732       xbt_dynar_remove_at(head->sub, pos, &child);
 733       xbt_dictelm_free(&child);
 734     }
 735   }
 736
 737   if (!head->key) {
 738     CDEBUG0(dict_collapse, "Do not collapse the head, you stupid programm");
 739     return;
 740   }
 741
 742   if (head->content || head->free_f ||
 743       xbt_dynar_length(head->sub) != 1) {
 744     CDEBUG0(dict_collapse, "Cannot collapse");
 745     return; /* cannot collapse */
 746   }
 747
 748   child = xbt_dynar_get_as(head->sub, 0, xbt_dictelm_t);
 749
 750   /* Get the child's key as new key */
 751   CDEBUG2(dict_collapse,
 752           "Do collapse with only child %.*s", child->key_len, child->key);
 753
 754   head->content  = child->content;
 755   head->free_f = child->free_f;
 756   xbt_free(head->key);
 757   head->key      = child->key;
 758   head->key_len  = child->key_len;
 759
 760   xbt_dynar_free_container(&(head->sub)) ;
 761
 762   head->sub = child->sub;
 763   xbt_free(child);
 764 }
 765
 766 /**
 767  * _xbt_dict_remove_rec:
 768  *
 769  * @head: the head of the dict
 770  * @key: the key of the data to be removed
 771  * @offset: offset on the key
 772  * @Returns: xbt_error_t
 773  *
 774  * Remove the entry associated with the given @key
 775  */
 776 xbt_error_t
 777 _xbt_dictelm_remove_rec(xbt_dictelm_t head,
 778                          const char  *key,
 779                          int          key_len,
 780                          int          offset) {
 781   xbt_error_t errcode = no_error;
 782
 783   /* there is no key to search, we did enough recursion => kill current */
 784   if (offset >= key_len) {
 785     int killme = 0; /* do I need to suicide me ? */
 786
 787     if (head->content && head->free_f) {
 788       head->free_f(head->content);
 789     }
 790
 791     killme = !xbt_dynar_length(head->sub);
 792     head->content  = NULL;
 793     head->free_f = NULL;
 794     _collapse_if_need(head, -1, offset);
 795
 796     if (killme) {
 797       DEBUG0("kill this node");
 798       head->key_len = 0; /* killme. Cleanup done one step higher in recursion */
 799     }
 800
 801     return errcode;
 802
 803   } else {
 804     int match      =      0;
 805     int pos        =      0;
 806     int old_offset = offset;
 807
 808     /*** Search where is the good child, and how good it is ***/
 809     _xbt_dictelm_child_search(head, key, key_len, &pos, &offset, &match);
 810
 811     switch (match) {
 812
 813     case 1: /* A child have exactly this key           => recurse */
 814     case 2: /* A child constitutes a prefix of the key => recurse */
 815
 816       {
 817         s_xbt_dictelm_t *p_child = NULL;
 818
 819         p_child = xbt_dynar_get_as(head->sub, pos, s_xbt_dictelm_t*);
 820         /*DEBUG5("Recurse on child %d of %p to remove %.*s (prefix=%d)",
 821           pos, (void*)p_child, key+offset, key_len-offset,offset);*/
 822         TRY(_xbt_dictelm_remove_rec(p_child, key, key_len, offset));
 823
 824         _collapse_if_need(head, pos, old_offset);
 825         return no_error;
 826       }
 827
 828
 829     case 0: /* no child have a common prefix */
 830     case 3: /* The key is a prefix of the child => not found */
 831     case 4: /* A child share a common prefix with this key => not found */
 832
 833       return mismatch_error;
 834
 835
 836     default:
 837       RAISE_IMPOSSIBLE;
 838
 839     }
 840   }
 841 }
 842
 843 /**
 844  * xbt_dictelm_remove_ext:
 845  *
 846  * @head: the head of the dict
 847  * @key: the key of the data to be removed
 848  * @Returns: xbt_error_t
 849  *
 850  * Remove the entry associated with the given @key
 851  */
 852 xbt_error_t
 853 xbt_dictelm_remove_ext(xbt_dictelm_t head,
 854                         const char  *key,
 855                         int          key_len) {
 856   /* there is no head, go to hell */
 857   if (!head) {
 858     RAISE0(mismatch_error, "there is no head, go to hell");
 859   }
 860
 861   return _xbt_dictelm_remove_rec(head, key, key_len, 0);
 862 }
 863
 864 /**
 865  * xbt_dictelm_remove:
 866  *
 867  * @head: the head of the dict
 868  * @key: the key of the data to be removed
 869  * @Returns: xbt_error_t
 870  *
 871  * Remove the entry associated with the given @key
 872  */
 873 xbt_error_t
 874 xbt_dictelm_remove(xbt_dictelm_t head,
 875                     const char     *key) {
 876   return _xbt_dictelm_remove_rec(head, key, 1+strlen(key),0);
 877 }
 878
 879 /*----[ _xbt_dict_dump_rec ]------------------------------------------------*/
 880 /* private function to do the job of xbt_dict_dump recursively              */
 881 /*---------------------------------------------------------------------------*/
 882 static
 883 void
 884 _xbt_dictelm_dump_rec(xbt_dictelm_t  head,
 885                        int             offset,
 886                        void_f_pvoid_t *output) {
 887   xbt_dictelm_t child   =     NULL;
 888   char          *key     =     NULL;
 889   int            key_len =        0;
 890   int            i       =        0;
 891
 892   if (!head)
 893     return;
 894
 895   printf("[%p] ", (void*)head);
 896
 897   key     = head->key;
 898   key_len = head->key_len;
 899
 900   if (key_len)
 901     printf ("  ");
 902
 903   for (i = 0; i < offset; i++)
 904     printf("-");
 905
 906   fflush(stdout);
 907
 908   if (key) {
 909
 910     if (!key_len) {
 911       printf ("HEAD");
 912     } else {
 913       char *key_string = NULL;
 914
 915       key_string = xbt_malloc(key_len*2+1);
 916       _xbt_bytes_to_string(key, key_len, key_string);
 917
 918       printf("%.*s|(%d)", key_len-offset, key_string + offset, offset);
 919
 920       xbt_free(key_string);
 921     }
 922
 923   }
 924
 925   printf(" -> ");
 926
 927   if (head->content) {
 928
 929     if (output) {
 930       output(head->content);
 931     } else {
 932       printf("(data)");
 933     }
 934
 935   } else {
 936     printf("(null)");
 937   }
 938
 939   printf("    \t\t\t[ %lu child(s) ]\n", xbt_dynar_length(head->sub));
 940
 941   xbt_dynar_foreach(head->sub, i, child)
 942     _xbt_dictelm_dump_rec(child, child->offset, output);
 943
 944 }
 945
 946 /**
 947  * xbt_dictelm_dump:
 948  *
 949  * @head: the head of the dict
 950  * @output: a function to dump each data in the tree
 951  * @Returns: xbt_error_t
 952  *
 953  * Ouputs the content of the structure. (for debuging purpose). @ouput is a
 954  * function to output the data. If NULL, data won't be displayed.
 955  */
 956
 957 void
 958 xbt_dictelm_dump(xbt_dictelm_t  head,
 959                   void_f_pvoid_t *output) {
 960   _xbt_dictelm_dump_rec(head, 0, output);
 961 }
 962
 963 /**
 964  * xbt_dictelm_print_fct:
 965  *
 966  * @data:
 967  *
 968  * To dump multidict, this function dumps a dict
 969  */
 970
 971 void
 972 xbt_dictelm_print_fct(void *data) {
 973   printf("tree %p", (void*)data);
 974 }
 975