src/xbt/dynar.c

   1 /* $Id$ */
   2
   3 /* a generic DYNamic ARray implementation.                                  */
   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 #include "portable.h" /* SIZEOF_MAX */
  11 #include "xbt/misc.h"
  12 #include "xbt/sysdep.h"
  13 #include "xbt/log.h"
  14 #include "xbt/ex.h"
  15 #include "xbt/dynar.h"
  16 #include <sys/types.h>
  17
  18 #include "xbt/dynar_private.h" /* type definition, which we share with the
  19                                   code in charge of sending this across the net */
  20
  21 /* IMPLEMENTATION NOTE ON SYNCHRONIZATION: every functions which name is prefixed by _
  22  * assumes that the dynar is already locked if we have to.
  23  * Other functions (public ones) check for this.
  24  */
  25
  26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn,xbt,"Dynamic arrays");
  27
  28 #define _dynar_lock(dynar) \
  29            if (dynar->mutex) \
  30               xbt_mutex_lock(dynar->mutex)
  31 #define _dynar_unlock(dynar) \
  32            if (dynar->mutex) \
  33               xbt_mutex_unlock(dynar->mutex)
  34 #define _sanity_check_dynar(dynar)       \
  35            xbt_assert0(dynar,           \
  36                         "dynar is NULL")
  37 #define _sanity_check_idx(idx)                \
  38            xbt_assert1(idx >= 0,             \
  39                         "dynar idx(=%d) < 0", \
  40                         (int) (idx))
  41 #define _check_inbound_idx(dynar, idx)                                                \
  42            if (idx>=dynar->used)              \
  43              THROW2(bound_error,idx,          \
  44                     "dynar is not that long. You asked %d, but it's only %lu long", \
  45                         (int) (idx), (unsigned long) dynar->used)
  46 #define _check_sloppy_inbound_idx(dynar, idx)                                         \
  47            if (idx>dynar->used)              \
  48              THROW2(bound_error,idx,          \
  49                     "dynar is not that long. You asked %d, but it's only %lu long (could have been equal to it)", \
  50                         (int) (idx), (unsigned long) dynar->used)
  51 #define _check_populated_dynar(dynar)            \
  52            if (dynar->used == 0)              \
  53              THROW1(bound_error,0,            \
  54                     "dynar %p is empty", dynar)
  55
  56
  57 static XBT_INLINE
  58 void _xbt_clear_mem(void * const ptr,
  59                      const unsigned long length) {
  60   memset(ptr, 0, length);
  61 }
  62
  63 static XBT_INLINE
  64 void
  65 _xbt_dynar_expand(xbt_dynar_t const dynar,
  66                    const int          nb) {
  67   const unsigned long old_size    = dynar->size;
  68
  69   if (nb > old_size) {
  70     char * const old_data    = (char *) dynar->data;
  71
  72     const unsigned long elmsize     = dynar->elmsize;
  73     const unsigned long old_length  = old_size*elmsize;
  74
  75     const unsigned long used        = dynar->used;
  76     const unsigned long used_length = used*elmsize;
  77
  78     const unsigned long new_size    = nb > (2*(old_size+1)) ? nb : (2*(old_size+1));
  79     const unsigned long new_length  = new_size*elmsize;
  80     char * const new_data    = (char *) xbt_malloc0(elmsize*new_size);
  81
  82     DEBUG3("expend %p from %lu to %d elements", (void*)dynar, (unsigned long)old_size, nb);
  83
  84     if (old_data) {
  85       memcpy(new_data, old_data, used_length);
  86       _xbt_clear_mem(old_data, old_length);
  87       free(old_data);
  88     }
  89
  90     _xbt_clear_mem(new_data + used_length, new_length - used_length);
  91
  92     dynar->size = new_size;
  93     dynar->data = new_data;
  94   }
  95 }
  96
  97 static XBT_INLINE
  98 void *
  99 _xbt_dynar_elm(const xbt_dynar_t  dynar,
 100                 const unsigned long idx) {
 101   char * const data    = (char*) dynar->data;
 102   const unsigned long elmsize = dynar->elmsize;
 103
 104   return data + idx*elmsize;
 105 }
 106
 107 static XBT_INLINE
 108 void
 109 _xbt_dynar_get_elm(void  * const       dst,
 110                     const xbt_dynar_t  dynar,
 111                     const unsigned long idx) {
 112   void * const elm     = _xbt_dynar_elm(dynar, idx);
 113
 114   memcpy(dst, elm, dynar->elmsize);
 115 }
 116
 117 static XBT_INLINE
 118 void
 119 _xbt_dynar_put_elm(const xbt_dynar_t  dynar,
 120                     const unsigned long idx,
 121                     const void * const  src) {
 122   void * const elm     = _xbt_dynar_elm(dynar, idx);
 123   const unsigned long elmsize = dynar->elmsize;
 124
 125   memcpy(elm, src, elmsize);
 126 }
 127
 128 static XBT_INLINE
 129 void
 130 _xbt_dynar_remove_at(xbt_dynar_t  const dynar,
 131                      const int            idx,
 132                      void         * const object) {
 133
 134   unsigned long nb_shift;
 135   unsigned long offset;
 136
 137   _sanity_check_dynar(dynar);
 138   _sanity_check_idx(idx);
 139   _check_inbound_idx(dynar, idx);
 140
 141   if (object) {
 142     _xbt_dynar_get_elm(object, dynar, idx);
 143   } else if (dynar->free_f) {
 144     if (dynar->elmsize <= SIZEOF_MAX) {
 145        char elm[SIZEOF_MAX];
 146        _xbt_dynar_get_elm(elm, dynar, idx);
 147        (*dynar->free_f)(elm);
 148     } else {
 149        char *elm=malloc(dynar->elmsize);
 150        _xbt_dynar_get_elm(elm, dynar, idx);
 151        (*dynar->free_f)(elm);
 152        free(elm);
 153     }
 154   }
 155
 156   nb_shift =  dynar->used-1 - idx;
 157   offset   =  nb_shift * dynar->elmsize;
 158
 159   memmove(_xbt_dynar_elm(dynar, idx),
 160           _xbt_dynar_elm(dynar, idx+1),
 161           offset);
 162
 163   dynar->used--;
 164 }
 165
 166 void
 167 xbt_dynar_dump(xbt_dynar_t dynar) {
 168   INFO5("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
 169         dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
 170 }
 171
 172 /** @brief Constructor
 173  *
 174  * \param elmsize size of each element in the dynar
 175  * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
 176  *
 177  * Creates a new dynar. If a free_func is provided, the elements have to be
 178  * pointer of pointer. That is to say that dynars can contain either base
 179  * types (int, char, double, etc) or pointer of pointers (struct **).
 180  */
 181 xbt_dynar_t
 182 xbt_dynar_new(const unsigned long elmsize,
 183                void_f_pvoid_t * const free_f) {
 184
 185   xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t,1);
 186
 187   dynar->size    = 0;
 188   dynar->used    = 0;
 189   dynar->elmsize = elmsize;
 190   dynar->data    = NULL;
 191   dynar->free_f    = free_f;
 192   dynar->mutex    = NULL;
 193
 194   return dynar;
 195 }
 196
 197 /** @brief Creates a synchronized dynar.
 198  *
 199  * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
 200  *
 201  */
 202 xbt_dynar_t
 203 xbt_dynar_new_sync(const unsigned long elmsize,
 204                void_f_pvoid_t * const free_f) {
 205    xbt_dynar_t res = xbt_dynar_new(elmsize,free_f);
 206    res->mutex = xbt_mutex_init();
 207    return res;
 208 }
 209
 210 /** @brief Destructor of the structure not touching to the content
 211  *
 212  * \param dynar poor victim
 213  *
 214  * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
 215  * is not touched (the \a free_f function is not used)
 216  */
 217 void
 218 xbt_dynar_free_container(xbt_dynar_t *dynar) {
 219   if (dynar && *dynar) {
 220
 221     if ((*dynar)->data) {
 222       _xbt_clear_mem((*dynar)->data, (*dynar)->size);
 223       free((*dynar)->data);
 224     }
 225
 226     if ((*dynar)->mutex)
 227        xbt_mutex_destroy((*dynar)->mutex);
 228
 229     _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
 230
 231     free(*dynar);
 232     *dynar=NULL;
 233   }
 234 }
 235
 236 /** @brief Frees the content and set the size to 0
 237  *
 238  * \param dynar who to squeeze
 239  */
 240 void
 241 xbt_dynar_reset(xbt_dynar_t const dynar) {
 242   _dynar_lock(dynar);
 243
 244   _sanity_check_dynar(dynar);
 245
 246   DEBUG1("Reset the dynar %p",(void*)dynar);
 247   if (dynar->free_f) {
 248     xbt_dynar_map(dynar, dynar->free_f);
 249   }
 250      /*
 251   if (dynar->data)
 252     free(dynar->data);
 253
 254   dynar->size = 0;
 255   */
 256   dynar->used = 0;
 257
 258   _dynar_unlock(dynar);
 259
 260 /*  dynar->data = NULL;*/
 261 }
 262
 263 /**
 264  * \brief Shrink the dynar by removing empty slots at the end of the internal array
 265  * \param dynar a dynar
 266  * \param empty_slots_wanted number of empty slots you want to keep at the end of the
 267  * internal array for further insertions
 268  *
 269  * Reduces the internal array size of the dynar to the number of elements plus
 270  * \a empty_slots_wanted.
 271  * After removing elements from the dynar, you can call this function to make
 272  * the dynar use less memory.
 273  * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
 274  * as possible.
 275  * Note that if \a empty_slots_wanted is greater than the array size, the internal
 276  * array is not expanded and nothing is done.
 277  */
 278 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted) {
 279   int size_wanted;
 280
 281   _dynar_lock(dynar);
 282
 283   size_wanted = dynar->used + empty_slots_wanted;
 284   if (size_wanted < dynar->size) {
 285     dynar->size = size_wanted;
 286     dynar->data = xbt_realloc(dynar->data, sizeof(void*) * dynar->size);
 287   }
 288   _dynar_unlock(dynar);
 289 }
 290
 291 /** @brief Destructor
 292  *
 293  * \param dynar poor victim
 294  *
 295  * kilkil a dynar and its content
 296  */
 297
 298 void
 299 xbt_dynar_free(xbt_dynar_t * dynar) {
 300   if (dynar && *dynar) {
 301     xbt_dynar_reset(*dynar);
 302     xbt_dynar_free_container(dynar);
 303   }
 304 }
 305 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
 306 void xbt_dynar_free_voidp(void *d) {
 307    xbt_dynar_free( (xbt_dynar_t*) d);
 308 }
 309
 310 /** @brief Count of dynar's elements
 311  *
 312  * \param dynar the dynar we want to mesure
 313  */
 314 unsigned long
 315 xbt_dynar_length(const xbt_dynar_t dynar) {
 316   return (dynar ? (unsigned long) dynar->used : (unsigned long)0);
 317 }
 318
 319 /** @brief Retrieve a copy of the Nth element of a dynar.
 320  *
 321  * \param dynar information dealer
 322  * \param idx index of the slot we want to retrieve
 323  * \param[out] dst where to put the result to.
 324  */
 325 void
 326 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
 327                    const int          idx,
 328                    void       * const dst) {
 329   _dynar_lock(dynar);
 330   _sanity_check_dynar(dynar);
 331   _sanity_check_idx(idx);
 332   _check_inbound_idx(dynar, idx);
 333
 334   _xbt_dynar_get_elm(dst, dynar, idx);
 335   _dynar_unlock(dynar);
 336 }
 337
 338 /** @brief Retrieve a pointer to the Nth element of a dynar.
 339  *
 340  * \param dynar information dealer
 341  * \param idx index of the slot we want to retrieve
 342  * \return the \a idx-th element of \a dynar.
 343  *
 344  * \warning The returned value is the actual content of the dynar.
 345  * Make a copy before fooling with it.
 346  */
 347 void*
 348 xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx) {
 349
 350   void *res;
 351   _dynar_lock(dynar);
 352   _sanity_check_dynar(dynar);
 353   _sanity_check_idx(idx);
 354   _check_inbound_idx(dynar, idx);
 355
 356   res = _xbt_dynar_elm(dynar, idx);
 357   _dynar_unlock(dynar);
 358   return res;
 359 }
 360
 361
 362 static void XBT_INLINE /* not synchronized */
 363 _xbt_dynar_set(xbt_dynar_t         dynar,
 364                const int            idx,
 365                const void   * const src) {
 366
 367   _sanity_check_dynar(dynar);
 368   _sanity_check_idx(idx);
 369
 370   _xbt_dynar_expand(dynar, idx+1);
 371
 372   if (idx >= dynar->used) {
 373     dynar->used = idx+1;
 374   }
 375
 376   _xbt_dynar_put_elm(dynar, idx, src);
 377 }
 378
 379 /** @brief Set the Nth element of a dynar (expended if needed). Previous value at this position is NOT freed
 380  *
 381  * \param dynar information dealer
 382  * \param idx index of the slot we want to modify
 383  * \param src What will be feeded to the dynar
 384  *
 385  * If you want to free the previous content, use xbt_dynar_replace().
 386  */
 387 void
 388 xbt_dynar_set(xbt_dynar_t         dynar,
 389                const int            idx,
 390                const void   * const src) {
 391
 392   _dynar_lock(dynar);
 393   _xbt_dynar_set(dynar,idx,src);
 394   _dynar_unlock(dynar);
 395 }
 396
 397 /** @brief Set the Nth element of a dynar (expended if needed). Previous value is freed
 398  *
 399  * \param dynar
 400  * \param idx
 401  * \param object
 402  *
 403  * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
 404  * free the previous value at this position. If you don't want to free the
 405  * previous content, use xbt_dynar_set().
 406  */
 407 void
 408 xbt_dynar_replace(xbt_dynar_t         dynar,
 409                    const int            idx,
 410                    const void   * const object) {
 411   _dynar_lock(dynar);
 412   _sanity_check_dynar(dynar);
 413   _sanity_check_idx(idx);
 414
 415   if (idx < dynar->used && dynar->free_f) {
 416     void * const old_object = _xbt_dynar_elm(dynar, idx);
 417
 418     dynar->free_f(old_object);
 419   }
 420
 421   _xbt_dynar_set(dynar, idx, object);
 422   _dynar_unlock(dynar);
 423 }
 424
 425 static XBT_INLINE void *
 426 _xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 427                         const int            idx) {
 428    void *res;
 429
 430   _sanity_check_dynar(dynar);
 431   _sanity_check_idx(idx);
 432   _check_sloppy_inbound_idx(dynar, idx);
 433
 434   const unsigned long old_used = dynar->used;
 435   const unsigned long new_used = old_used + 1;
 436
 437   _xbt_dynar_expand(dynar, new_used);
 438
 439   const unsigned long nb_shift =  old_used - idx;
 440
 441   if (nb_shift)
 442      memmove(_xbt_dynar_elm(dynar, idx+1),
 443              _xbt_dynar_elm(dynar, idx),
 444              nb_shift * dynar->elmsize);
 445
 446   dynar->used = new_used;
 447   res = _xbt_dynar_elm(dynar,idx);
 448   return res;
 449 }
 450
 451 /** @brief Make room for a new element, and return a pointer to it
 452  *
 453  * You can then use regular affectation to set its value instead of relying
 454  * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
 455  */
 456 void *
 457 xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 458                         const int            idx) {
 459   void *res;
 460
 461   _dynar_lock(dynar);
 462   res = _xbt_dynar_insert_at_ptr(dynar,idx);
 463   _dynar_unlock(dynar);
 464   return res;
 465 }
 466
 467 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
 468  *
 469  * Set the Nth element of a dynar, expanding the dynar if needed, and
 470  * moving the previously existing value and all subsequent ones to one
 471  * position right in the dynar.
 472  */
 473 void
 474 xbt_dynar_insert_at(xbt_dynar_t  const dynar,
 475                     const int            idx,
 476                     const void   * const src) {
 477
 478   _dynar_lock(dynar);
 479   /* checks done in xbt_dynar_insert_at_ptr */
 480   memcpy(_xbt_dynar_insert_at_ptr(dynar,idx),
 481          src,
 482          dynar->elmsize);
 483   _dynar_unlock(dynar);
 484 }
 485
 486 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
 487  *
 488  * Get the Nth element of a dynar, removing it from the dynar and moving
 489  * all subsequent values to one position left in the dynar.
 490  *
 491  * If the object argument of this function is a non-null pointer, the removed
 492  * element is copied to this address. If not, the element is freed using the
 493  * free_f function passed at dynar creation.
 494  */
 495 void
 496 xbt_dynar_remove_at(xbt_dynar_t  const dynar,
 497                      const int            idx,
 498                      void         * const object) {
 499
 500   _dynar_lock(dynar);
 501         _xbt_dynar_remove_at(dynar, idx, object);
 502   _dynar_unlock(dynar);
 503 }
 504
 505 /** @brief Returns the position of the element in the dynar
 506  *
 507  * Raises not_found_error if not found.
 508  */
 509 int
 510 xbt_dynar_search(xbt_dynar_t  const dynar,
 511                  void        *const elem) {
 512   int it;
 513
 514   _dynar_lock(dynar);
 515   for (it=0; it< dynar->used; it++)
 516     if (!memcmp(_xbt_dynar_elm(dynar, it),elem,dynar->elmsize)) {
 517       _dynar_unlock(dynar);
 518       return it;
 519     }
 520
 521   _dynar_unlock(dynar);
 522   THROW2(not_found_error,0,"Element %p not part of dynar %p",elem,dynar);
 523 }
 524
 525 /** @brief Returns a boolean indicating whether the element is part of the dynar */
 526 int
 527 xbt_dynar_member(xbt_dynar_t  const dynar,
 528                  void        *const elem) {
 529
 530   xbt_ex_t e;
 531
 532   TRY {
 533      xbt_dynar_search(dynar,elem);
 534   } CATCH(e) {
 535      if (e.category == not_found_error) {
 536         xbt_ex_free(e);
 537         return 0;
 538      }
 539      RETHROW;
 540   }
 541   return 1;
 542 }
 543
 544 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
 545  *
 546  * You can then use regular affectation to set its value instead of relying
 547  * on the slow memcpy. This is what xbt_dynar_push_as() does.
 548  */
 549 void *
 550 xbt_dynar_push_ptr(xbt_dynar_t  const dynar) {
 551   return xbt_dynar_insert_at_ptr(dynar, dynar->used);
 552 }
 553
 554 /** @brief Add an element at the end of the dynar */
 555 void
 556 xbt_dynar_push(xbt_dynar_t  const dynar,
 557                 const void   * const src) {
 558   /* sanity checks done by insert_at */
 559   xbt_dynar_insert_at(dynar, dynar->used, src);
 560 }
 561
 562 /** @brief Mark the last dynar's element as unused and return a pointer to it.
 563  *
 564  * You can then use regular affectation to set its value instead of relying
 565  * on the slow memcpy. This is what xbt_dynar_pop_as() does.
 566  */
 567 void *
 568 xbt_dynar_pop_ptr(xbt_dynar_t  const dynar) {
 569   void *res;
 570
 571   _dynar_lock(dynar);
 572   _check_populated_dynar(dynar);
 573   DEBUG1("Pop %p",(void*)dynar);
 574   dynar->used--;
 575   res = _xbt_dynar_elm(dynar,dynar->used);
 576   _dynar_unlock(dynar);
 577   return res;
 578 }
 579
 580 /** @brief Get and remove the last element of the dynar */
 581 void
 582 xbt_dynar_pop(xbt_dynar_t  const dynar,
 583               void         * const dst) {
 584
 585   /* sanity checks done by remove_at */
 586   DEBUG1("Pop %p",(void*)dynar);
 587   xbt_dynar_remove_at(dynar, dynar->used-1, dst);
 588 }
 589
 590 /** @brief Add an element at the begining of the dynar.
 591  *
 592  * This is less efficient than xbt_dynar_push()
 593  */
 594 void
 595 xbt_dynar_unshift(xbt_dynar_t  const dynar,
 596                    const void   * const src) {
 597
 598   /* sanity checks done by insert_at */
 599   xbt_dynar_insert_at(dynar, 0, src);
 600 }
 601
 602 /** @brief Get and remove the first element of the dynar.
 603  *
 604  * This is less efficient than xbt_dynar_pop()
 605  */
 606 void
 607 xbt_dynar_shift(xbt_dynar_t  const dynar,
 608                  void         * const dst) {
 609
 610   /* sanity checks done by remove_at */
 611   xbt_dynar_remove_at(dynar, 0, dst);
 612 }
 613
 614 /** @brief Apply a function to each member of a dynar
 615  *
 616  * The mapped function may change the value of the element itself,
 617  * but should not mess with the structure of the dynar.
 618  *
 619  * If the dynar is synchronized, it is locked during the whole map
 620  * operation, so make sure your function don't call any function
 621  * from xbt_dynar_* on it, or you'll get a deadlock.
 622  */
 623 void
 624 xbt_dynar_map(const xbt_dynar_t  dynar,
 625                void_f_pvoid_t     * const op) {
 626
 627   _dynar_lock(dynar);
 628   _sanity_check_dynar(dynar);
 629
 630   {
 631     char         elm[SIZEOF_MAX];
 632     const unsigned long used = dynar->used;
 633     unsigned long       i    = 0;
 634
 635     for (i = 0; i < used; i++) {
 636       _xbt_dynar_get_elm(elm, dynar, i);
 637       op(elm);
 638     }
 639   }
 640   _dynar_unlock(dynar);
 641 }
 642
 643 /** @brief Put the cursor at the begining of the dynar.
 644  *
 645  * Actually, the cursor is set one step before the begining, so that you
 646  * can iterate over the dynar with a for loop.
 647  *
 648  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 649  */
 650 void
 651 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
 652                        int        * const cursor) {
 653
 654   _dynar_lock(dynar);
 655   DEBUG1("Set cursor on %p to the first position",(void*)dynar);
 656   *cursor = 0;
 657 }
 658
 659 /** @brief Move the cursor to the next value
 660  *
 661  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 662  */
 663 void
 664 _xbt_dynar_cursor_step(const xbt_dynar_t dynar,
 665                        int        * const cursor) {
 666
 667   (*cursor)++;
 668 }
 669
 670 /** @brief Get the data currently pointed by the cursor
 671  *
 672  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 673  */
 674 int
 675 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
 676                       int                * const cursor,
 677                       void               * const dst) {
 678
 679   _sanity_check_dynar(dynar);
 680   {
 681
 682     const int idx = *cursor;
 683
 684     if (idx >= dynar->used) {
 685       DEBUG1("Cursor on %p already on last elem",(void*)dynar);
 686       _dynar_unlock(dynar);
 687       return FALSE;
 688     }
 689     DEBUG2("Cash out cursor on %p at %d",(void*)dynar,idx);
 690
 691     _xbt_dynar_get_elm(dst, dynar, idx);
 692   }
 693   return TRUE;
 694
 695 }
 696
 697 /** @brief Removes and free the entry pointed by the cursor
 698  *
 699  * This function can be used while traversing without problem.
 700  */
 701 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 702                           int          * const cursor) {
 703
 704   _xbt_dynar_remove_at(dynar,(*cursor)--,NULL);
 705 }
 706
 707 /** @brief Unlocks a synchronized dynar when you want to break the traversal
 708  *
 709  * This function must be used if you <tt>break</tt> the
 710  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
 711  * regular traversal reaching the end of the elements
 712  */
 713 void xbt_dynar_cursor_unlock(xbt_dynar_t dynar) {
 714   _dynar_unlock(dynar);
 715 }
 716
 717 #ifdef SIMGRID_TEST
 718
 719 #define NB_ELEM 5000
 720
 721 XBT_TEST_SUITE("dynar","Dynar data container");
 722 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 723 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 724
 725 XBT_TEST_UNIT("int",test_dynar_int,"Dynars of integers") {
 726    /* Vars_decl [doxygen cruft] */
 727    xbt_dynar_t d;
 728    int i,cpt,cursor;
 729    int *iptr;
 730
 731    xbt_test_add0("==== Traverse the empty dynar");
 732    d=xbt_dynar_new(sizeof(int),NULL);
 733    xbt_dynar_foreach(d,cursor,i){
 734      xbt_assert0(0,"Damnit, there is something in the empty dynar");
 735    }
 736    xbt_dynar_free(&d);
 737    xbt_dynar_free(&d);
 738
 739    xbt_test_add1("==== Push %d int, set them again 3 times, traverse them, shift them",
 740         NB_ELEM);
 741    /* Populate_ints [doxygen cruft] */
 742    /* 1. Populate the dynar */
 743    d=xbt_dynar_new(sizeof(int),NULL);
 744    for (cpt=0; cpt< NB_ELEM; cpt++) {
 745      xbt_dynar_push_as(d,int,cpt); /* This is faster (and possible only with scalars) */
 746      /* xbt_dynar_push(d,&cpt);       This would also work */
 747      xbt_test_log2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 748    }
 749
 750    /* 2. Traverse manually the dynar */
 751    for (cursor=0; cursor< NB_ELEM; cursor++) {
 752      iptr=xbt_dynar_get_ptr(d,cursor);
 753      xbt_test_assert2(cursor == *iptr,
 754                       "The retrieved value is not the same than the injected one (%d!=%d)",
 755                       cursor,cpt);
 756    }
 757
 758    /* 3. Traverse the dynar using the neat macro to that extend */
 759    xbt_dynar_foreach(d,cursor,cpt){
 760      xbt_test_assert2(cursor == cpt,
 761                       "The retrieved value is not the same than the injected one (%d!=%d)",
 762                       cursor,cpt);
 763    }
 764    /* end_of_traversal */
 765
 766    for (cpt=0; cpt< NB_ELEM; cpt++)
 767      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 768
 769    for (cpt=0; cpt< NB_ELEM; cpt++)
 770      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 771 /*     xbt_dynar_set(d,cpt,&cpt);*/
 772
 773    for (cpt=0; cpt< NB_ELEM; cpt++)
 774      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 775
 776    cpt=0;
 777    xbt_dynar_foreach(d,cursor,i){
 778      xbt_test_assert2(i == cpt,
 779                       "The retrieved value is not the same than the injected one (%d!=%d)",
 780                       i,cpt);
 781      cpt++;
 782    }
 783    xbt_test_assert2(cpt == NB_ELEM,
 784                     "Cannot retrieve my %d values. Last got one is %d",
 785                     NB_ELEM, cpt);
 786
 787    /* shifting [doxygen cruft] */
 788    /* 4. Shift all the values */
 789    for (cpt=0; cpt< NB_ELEM; cpt++) {
 790      xbt_dynar_shift(d,&i);
 791      xbt_test_assert2(i == cpt,
 792                       "The retrieved value is not the same than the injected one (%d!=%d)",
 793                       i,cpt);
 794      xbt_test_log2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 795    }
 796
 797    /* 5. Free the resources */
 798    xbt_dynar_free(&d);
 799    xbt_dynar_free(&d);
 800
 801
 802    xbt_test_add1("==== Unshift/pop %d int",NB_ELEM);
 803    d=xbt_dynar_new(sizeof(int),NULL);
 804    for (cpt=0; cpt< NB_ELEM; cpt++) {
 805      xbt_dynar_unshift(d,&cpt);
 806      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 807    }
 808    for (cpt=0; cpt< NB_ELEM; cpt++) {
 809      i=xbt_dynar_pop_as(d,int);
 810      xbt_test_assert2(i == cpt,
 811                       "The retrieved value is not the same than the injected one (%d!=%d)",
 812                       i,cpt);
 813      xbt_test_log2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 814    }
 815    xbt_dynar_free(&d);
 816    xbt_dynar_free(&d);
 817
 818
 819    xbt_test_add1("==== Push %d int, insert 1000 int in the middle, shift everything",NB_ELEM);
 820    d=xbt_dynar_new(sizeof(int),NULL);
 821    for (cpt=0; cpt< NB_ELEM; cpt++) {
 822      xbt_dynar_push_as(d,int,cpt);
 823      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 824    }
 825    for (cpt=0; cpt< 1000; cpt++) {
 826      xbt_dynar_insert_at_as(d,2500,int,cpt);
 827      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 828    }
 829
 830    for (cpt=0; cpt< 2500; cpt++) {
 831      xbt_dynar_shift(d,&i);
 832      xbt_test_assert2(i == cpt,
 833              "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 834                i,cpt);
 835      DEBUG2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 836    }
 837    for (cpt=999; cpt>=0; cpt--) {
 838      xbt_dynar_shift(d,&i);
 839      xbt_test_assert2(i == cpt,
 840            "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 841                       i,cpt);
 842    }
 843    for (cpt=2500; cpt< NB_ELEM; cpt++) {
 844      xbt_dynar_shift(d,&i);
 845       xbt_test_assert2(i == cpt,
 846            "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 847                        i,cpt);
 848    }
 849    xbt_dynar_free(&d);
 850    xbt_dynar_free(&d);
 851
 852
 853    xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest",NB_ELEM);
 854    d=xbt_dynar_new(sizeof(int),NULL);
 855    for (cpt=0; cpt< NB_ELEM; cpt++)
 856      xbt_dynar_push_as(d,int,cpt);
 857
 858    for (cpt=2000; cpt< 4000; cpt++) {
 859      xbt_dynar_remove_at(d,2000,&i);
 860      xbt_test_assert2(i == cpt,
 861                       "Remove a bad value. Got %d, expected %d",
 862                       i,cpt);
 863      DEBUG2("remove %d, length=%lu",cpt, xbt_dynar_length(d));
 864    }
 865    xbt_dynar_free(&d);
 866    xbt_dynar_free(&d);
 867 }
 868 /*******************************************************************************/
 869 /*******************************************************************************/
 870 /*******************************************************************************/
 871 XBT_TEST_UNIT("double",test_dynar_double,"Dynars of doubles") {
 872    xbt_dynar_t d;
 873    int cpt,cursor;
 874    double d1,d2;
 875
 876    xbt_test_add0("==== Traverse the empty dynar");
 877    d=xbt_dynar_new(sizeof(int),NULL);
 878    xbt_dynar_foreach(d,cursor,cpt){
 879      xbt_test_assert0(FALSE,
 880              "Damnit, there is something in the empty dynar");
 881    }
 882    xbt_dynar_free(&d);
 883    xbt_dynar_free(&d);
 884
 885    xbt_test_add0("==== Push/shift 5000 doubles");
 886    d=xbt_dynar_new(sizeof(double),NULL);
 887    for (cpt=0; cpt< 5000; cpt++) {
 888      d1=(double)cpt;
 889      xbt_dynar_push(d,&d1);
 890    }
 891    xbt_dynar_foreach(d,cursor,d2){
 892      d1=(double)cursor;
 893      xbt_test_assert2(d1 == d2,
 894            "The retrieved value is not the same than the injected one (%f!=%f)",
 895                   d1,d2);
 896    }
 897    for (cpt=0; cpt< 5000; cpt++) {
 898      d1=(double)cpt;
 899      xbt_dynar_shift(d,&d2);
 900      xbt_test_assert2(d1 == d2,
 901            "The retrieved value is not the same than the injected one (%f!=%f)",
 902                   d1,d2);
 903    }
 904    xbt_dynar_free(&d);
 905    xbt_dynar_free(&d);
 906
 907
 908    xbt_test_add0("==== Unshift/pop 5000 doubles");
 909    d=xbt_dynar_new(sizeof(double),NULL);
 910    for (cpt=0; cpt< 5000; cpt++) {
 911      d1=(double)cpt;
 912      xbt_dynar_unshift(d,&d1);
 913    }
 914    for (cpt=0; cpt< 5000; cpt++) {
 915      d1=(double)cpt;
 916      xbt_dynar_pop(d,&d2);
 917      xbt_test_assert2 (d1 == d2,
 918            "The retrieved value is not the same than the injected one (%f!=%f)",
 919                    d1,d2);
 920    }
 921    xbt_dynar_free(&d);
 922    xbt_dynar_free(&d);
 923
 924
 925
 926    xbt_test_add0("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
 927    d=xbt_dynar_new(sizeof(double),NULL);
 928    for (cpt=0; cpt< 5000; cpt++) {
 929      d1=(double)cpt;
 930      xbt_dynar_push(d,&d1);
 931    }
 932    for (cpt=0; cpt< 1000; cpt++) {
 933      d1=(double)cpt;
 934      xbt_dynar_insert_at(d,2500,&d1);
 935    }
 936
 937    for (cpt=0; cpt< 2500; cpt++) {
 938      d1=(double)cpt;
 939      xbt_dynar_shift(d,&d2);
 940      xbt_test_assert2(d1 == d2,
 941            "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
 942                   d1,d2);
 943      DEBUG2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 944    }
 945    for (cpt=999; cpt>=0; cpt--) {
 946      d1=(double)cpt;
 947      xbt_dynar_shift(d,&d2);
 948      xbt_test_assert2 (d1 == d2,
 949            "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
 950                    d1,d2);
 951    }
 952    for (cpt=2500; cpt< 5000; cpt++) {
 953      d1=(double)cpt;
 954      xbt_dynar_shift(d,&d2);
 955      xbt_test_assert2 (d1 == d2,
 956            "The retrieved value is not the same than the injected one at the end (%f!=%f)",
 957                    d1,d2);
 958    }
 959    xbt_dynar_free(&d);
 960    xbt_dynar_free(&d);
 961
 962
 963    xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
 964    d=xbt_dynar_new(sizeof(double),NULL);
 965    for (cpt=0; cpt< 5000; cpt++) {
 966      d1=(double)cpt;
 967      xbt_dynar_push(d,&d1);
 968    }
 969    for (cpt=2000; cpt< 4000; cpt++) {
 970      d1=(double)cpt;
 971      xbt_dynar_remove_at(d,2000,&d2);
 972      xbt_test_assert2 (d1 == d2,
 973            "Remove a bad value. Got %f, expected %f",
 974                d2,d1);
 975    }
 976    xbt_dynar_free(&d);
 977    xbt_dynar_free(&d);
 978 }
 979
 980
 981 /* doxygen_string_cruft */
 982
 983 /* The function we will use to free the data */
 984 static void free_string(void *d){
 985   free(*(void**)d);
 986 }
 987
 988 /*******************************************************************************/
 989 /*******************************************************************************/
 990 /*******************************************************************************/
 991 XBT_TEST_UNIT("string",test_dynar_string,"Dyars of strings") {
 992    xbt_dynar_t d;
 993    int cpt;
 994    char buf[1024];
 995    char *s1,*s2;
 996
 997    xbt_test_add0("==== Traverse the empty dynar");
 998    d=xbt_dynar_new(sizeof(char *),&free_string);
 999    xbt_dynar_foreach(d,cpt,s1){
1000      xbt_test_assert0(FALSE,
1001                   "Damnit, there is something in the empty dynar");
1002    }
1003    xbt_dynar_free(&d);
1004    xbt_dynar_free(&d);
1005
1006    xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",NB_ELEM);
1007    /* Populate_str [doxygen cruft] */
1008    d=xbt_dynar_new(sizeof(char*),&free_string);
1009    /* 1. Populate the dynar */
1010    for (cpt=0; cpt< NB_ELEM; cpt++) {
1011      sprintf(buf,"%d",cpt);
1012      s1=strdup(buf);
1013      xbt_dynar_push(d,&s1);
1014    }
1015    for (cpt=0; cpt< NB_ELEM; cpt++) {
1016      sprintf(buf,"%d",cpt);
1017      s1=strdup(buf);
1018      xbt_dynar_replace(d,cpt,&s1);
1019    }
1020    for (cpt=0; cpt< NB_ELEM; cpt++) {
1021      sprintf(buf,"%d",cpt);
1022      s1=strdup(buf);
1023      xbt_dynar_replace(d,cpt,&s1);
1024    }
1025    for (cpt=0; cpt< NB_ELEM; cpt++) {
1026      sprintf(buf,"%d",cpt);
1027      s1=strdup(buf);
1028      xbt_dynar_replace(d,cpt,&s1);
1029    }
1030    for (cpt=0; cpt< NB_ELEM; cpt++) {
1031      sprintf(buf,"%d",cpt);
1032      xbt_dynar_shift(d,&s2);
1033      xbt_test_assert2 (!strcmp(buf,s2),
1034             "The retrieved value is not the same than the injected one (%s!=%s)",
1035                    buf,s2);
1036      free(s2);
1037    }
1038    xbt_dynar_free(&d);
1039    xbt_dynar_free(&d);
1040
1041
1042    xbt_test_add1("==== Unshift, traverse and pop %d strings",NB_ELEM);
1043    d=xbt_dynar_new(sizeof(char**),&free_string);
1044    for (cpt=0; cpt< NB_ELEM; cpt++) {
1045      sprintf(buf,"%d",cpt);
1046      s1=strdup(buf);
1047      xbt_dynar_unshift(d,&s1);
1048    }
1049    /* 2. Traverse the dynar with the macro */
1050    xbt_dynar_foreach(d,cpt,s1) {
1051      sprintf(buf,"%d",NB_ELEM - cpt -1);
1052      xbt_test_assert2 (!strcmp(buf,s1),
1053            "The retrieved value is not the same than the injected one (%s!=%s)",
1054                buf,s1);
1055    }
1056    /* 3. Traverse the dynar with the macro */
1057    for (cpt=0; cpt< NB_ELEM; cpt++) {
1058      sprintf(buf,"%d",cpt);
1059      xbt_dynar_pop(d,&s2);
1060      xbt_test_assert2 (!strcmp(buf,s2),
1061            "The retrieved value is not the same than the injected one (%s!=%s)",
1062                buf,s2);
1063      free(s2);
1064    }
1065    /* 4. Free the resources */
1066    xbt_dynar_free(&d);
1067    xbt_dynar_free(&d);
1068
1069
1070    xbt_test_add2("==== Push %d strings, insert %d strings in the middle, shift everything",NB_ELEM,NB_ELEM/5);
1071    d=xbt_dynar_new(sizeof(char*),&free_string);
1072    for (cpt=0; cpt< NB_ELEM; cpt++) {
1073      sprintf(buf,"%d",cpt);
1074      s1=strdup(buf);
1075      xbt_dynar_push(d,&s1);
1076    }
1077    for (cpt=0; cpt< NB_ELEM/5; cpt++) {
1078      sprintf(buf,"%d",cpt);
1079      s1=strdup(buf);
1080      xbt_dynar_insert_at(d,NB_ELEM/2,&s1);
1081    }
1082
1083    for (cpt=0; cpt< NB_ELEM/2; cpt++) {
1084      sprintf(buf,"%d",cpt);
1085      xbt_dynar_shift(d,&s2);
1086      xbt_test_assert2(!strcmp(buf,s2),
1087            "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1088                buf,s2);
1089       free(s2);
1090    }
1091    for (cpt=(NB_ELEM/5)-1; cpt>=0; cpt--) {
1092      sprintf(buf,"%d",cpt);
1093      xbt_dynar_shift(d,&s2);
1094      xbt_test_assert2 (!strcmp(buf,s2),
1095            "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1096                buf,s2);
1097      free(s2);
1098    }
1099    for (cpt=NB_ELEM/2; cpt< NB_ELEM; cpt++) {
1100      sprintf(buf,"%d",cpt);
1101      xbt_dynar_shift(d,&s2);
1102      xbt_test_assert2 (!strcmp(buf,s2),
1103            "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1104                buf,s2);
1105      free(s2);
1106    }
1107    xbt_dynar_free(&d);
1108    xbt_dynar_free(&d);
1109
1110
1111    xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest",NB_ELEM,2*(NB_ELEM/5),4*(NB_ELEM/5));
1112    d=xbt_dynar_new(sizeof(char*),&free_string);
1113    for (cpt=0; cpt< NB_ELEM; cpt++) {
1114      sprintf(buf,"%d",cpt);
1115      s1=strdup(buf);
1116      xbt_dynar_push(d,&s1);
1117    }
1118    for (cpt=2*(NB_ELEM/5); cpt< 4*(NB_ELEM/5); cpt++) {
1119      sprintf(buf,"%d",cpt);
1120      xbt_dynar_remove_at(d,2*(NB_ELEM/5),&s2);
1121      xbt_test_assert2(!strcmp(buf,s2),
1122                   "Remove a bad value. Got %s, expected %s",
1123                   s2,buf);
1124       free(s2);
1125    }
1126    xbt_dynar_free(&d); /* end_of_doxygen */
1127 }
1128
1129
1130 /*******************************************************************************/
1131 /*******************************************************************************/
1132 /*******************************************************************************/
1133 #include "xbt/synchro.h"
1134 static void pusher_f(void *a) {
1135    xbt_dynar_t d=(xbt_dynar_t)a;
1136    int i;
1137    for (i=0; i<500; i++) {
1138       xbt_dynar_push(d,&i);
1139    }
1140 }
1141 static void poper_f(void *a) {
1142    xbt_dynar_t d=(xbt_dynar_t)a;
1143    int i;
1144    int data;
1145    xbt_ex_t e;
1146
1147    for (i=0; i<500; i++) {
1148       TRY {
1149          xbt_dynar_pop(d,&data);
1150       } CATCH(e) {
1151          if (e.category == bound_error) {
1152             xbt_ex_free(e);
1153             i--;
1154          } else {
1155             RETHROW;
1156          }
1157       }
1158    }
1159 }
1160
1161
1162 XBT_TEST_UNIT("synchronized int",test_dynar_sync_int,"Synchronized dynars of integers") {
1163    /* Vars_decl [doxygen cruft] */
1164    xbt_dynar_t d;
1165    xbt_thread_t pusher,poper;
1166
1167    xbt_test_add0("==== Have a pusher and a popper on the dynar");
1168    d=xbt_dynar_new_sync(sizeof(int),NULL);
1169    pusher = xbt_thread_create("pusher",pusher_f,d);
1170    poper = xbt_thread_create("poper",poper_f,d);
1171    xbt_thread_join(pusher);
1172    xbt_thread_join(poper);
1173    xbt_dynar_free(&d);
1174 }
1175
1176 #endif /* SIMGRID_TEST */