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    unsigned long old_used;
 430    unsigned long new_used;
 431    unsigned long nb_shift;
 432
 433   _sanity_check_dynar(dynar);
 434   _sanity_check_idx(idx);
 435   _check_sloppy_inbound_idx(dynar, idx);
 436
 437   old_used = dynar->used;
 438   new_used = old_used + 1;
 439
 440   _xbt_dynar_expand(dynar, new_used);
 441
 442   nb_shift =  old_used - idx;
 443
 444   if (nb_shift)
 445      memmove(_xbt_dynar_elm(dynar, idx+1),
 446              _xbt_dynar_elm(dynar, idx),
 447              nb_shift * dynar->elmsize);
 448
 449   dynar->used = new_used;
 450   res = _xbt_dynar_elm(dynar,idx);
 451   return res;
 452 }
 453
 454 /** @brief Make room for a new element, and return a pointer to it
 455  *
 456  * You can then use regular affectation to set its value instead of relying
 457  * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
 458  */
 459 void *
 460 xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 461                         const int            idx) {
 462   void *res;
 463
 464   _dynar_lock(dynar);
 465   res = _xbt_dynar_insert_at_ptr(dynar,idx);
 466   _dynar_unlock(dynar);
 467   return res;
 468 }
 469
 470 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
 471  *
 472  * Set the Nth element of a dynar, expanding the dynar if needed, and
 473  * moving the previously existing value and all subsequent ones to one
 474  * position right in the dynar.
 475  */
 476 void
 477 xbt_dynar_insert_at(xbt_dynar_t  const dynar,
 478                     const int            idx,
 479                     const void   * const src) {
 480
 481   _dynar_lock(dynar);
 482   /* checks done in xbt_dynar_insert_at_ptr */
 483   memcpy(_xbt_dynar_insert_at_ptr(dynar,idx),
 484          src,
 485          dynar->elmsize);
 486   _dynar_unlock(dynar);
 487 }
 488
 489 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
 490  *
 491  * Get the Nth element of a dynar, removing it from the dynar and moving
 492  * all subsequent values to one position left in the dynar.
 493  *
 494  * If the object argument of this function is a non-null pointer, the removed
 495  * element is copied to this address. If not, the element is freed using the
 496  * free_f function passed at dynar creation.
 497  */
 498 void
 499 xbt_dynar_remove_at(xbt_dynar_t  const dynar,
 500                      const int            idx,
 501                      void         * const object) {
 502
 503   _dynar_lock(dynar);
 504         _xbt_dynar_remove_at(dynar, idx, object);
 505   _dynar_unlock(dynar);
 506 }
 507
 508 /** @brief Returns the position of the element in the dynar
 509  *
 510  * Raises not_found_error if not found.
 511  */
 512 int
 513 xbt_dynar_search(xbt_dynar_t  const dynar,
 514                  void        *const elem) {
 515   int it;
 516
 517   _dynar_lock(dynar);
 518   for (it=0; it< dynar->used; it++)
 519     if (!memcmp(_xbt_dynar_elm(dynar, it),elem,dynar->elmsize)) {
 520       _dynar_unlock(dynar);
 521       return it;
 522     }
 523
 524   _dynar_unlock(dynar);
 525   THROW2(not_found_error,0,"Element %p not part of dynar %p",elem,dynar);
 526 }
 527
 528 /** @brief Returns a boolean indicating whether the element is part of the dynar */
 529 int
 530 xbt_dynar_member(xbt_dynar_t  const dynar,
 531                  void        *const elem) {
 532
 533   xbt_ex_t e;
 534
 535   TRY {
 536      xbt_dynar_search(dynar,elem);
 537   } CATCH(e) {
 538      if (e.category == not_found_error) {
 539         xbt_ex_free(e);
 540         return 0;
 541      }
 542      RETHROW;
 543   }
 544   return 1;
 545 }
 546
 547 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
 548  *
 549  * You can then use regular affectation to set its value instead of relying
 550  * on the slow memcpy. This is what xbt_dynar_push_as() does.
 551  */
 552 void *
 553 xbt_dynar_push_ptr(xbt_dynar_t  const dynar) {
 554   return xbt_dynar_insert_at_ptr(dynar, dynar->used);
 555 }
 556
 557 /** @brief Add an element at the end of the dynar */
 558 void
 559 xbt_dynar_push(xbt_dynar_t  const dynar,
 560                 const void   * const src) {
 561   /* sanity checks done by insert_at */
 562   xbt_dynar_insert_at(dynar, dynar->used, src);
 563 }
 564
 565 /** @brief Mark the last dynar's element as unused and return a pointer to it.
 566  *
 567  * You can then use regular affectation to set its value instead of relying
 568  * on the slow memcpy. This is what xbt_dynar_pop_as() does.
 569  */
 570 void *
 571 xbt_dynar_pop_ptr(xbt_dynar_t  const dynar) {
 572   void *res;
 573
 574   _dynar_lock(dynar);
 575   _check_populated_dynar(dynar);
 576   DEBUG1("Pop %p",(void*)dynar);
 577   dynar->used--;
 578   res = _xbt_dynar_elm(dynar,dynar->used);
 579   _dynar_unlock(dynar);
 580   return res;
 581 }
 582
 583 /** @brief Get and remove the last element of the dynar */
 584 void
 585 xbt_dynar_pop(xbt_dynar_t  const dynar,
 586               void         * const dst) {
 587
 588   /* sanity checks done by remove_at */
 589   DEBUG1("Pop %p",(void*)dynar);
 590   xbt_dynar_remove_at(dynar, dynar->used-1, dst);
 591 }
 592
 593 /** @brief Add an element at the begining of the dynar.
 594  *
 595  * This is less efficient than xbt_dynar_push()
 596  */
 597 void
 598 xbt_dynar_unshift(xbt_dynar_t  const dynar,
 599                    const void   * const src) {
 600
 601   /* sanity checks done by insert_at */
 602   xbt_dynar_insert_at(dynar, 0, src);
 603 }
 604
 605 /** @brief Get and remove the first element of the dynar.
 606  *
 607  * This is less efficient than xbt_dynar_pop()
 608  */
 609 void
 610 xbt_dynar_shift(xbt_dynar_t  const dynar,
 611                  void         * const dst) {
 612
 613   /* sanity checks done by remove_at */
 614   xbt_dynar_remove_at(dynar, 0, dst);
 615 }
 616
 617 /** @brief Apply a function to each member of a dynar
 618  *
 619  * The mapped function may change the value of the element itself,
 620  * but should not mess with the structure of the dynar.
 621  *
 622  * If the dynar is synchronized, it is locked during the whole map
 623  * operation, so make sure your function don't call any function
 624  * from xbt_dynar_* on it, or you'll get a deadlock.
 625  */
 626 void
 627 xbt_dynar_map(const xbt_dynar_t  dynar,
 628                void_f_pvoid_t     * const op) {
 629
 630   _dynar_lock(dynar);
 631   _sanity_check_dynar(dynar);
 632
 633   {
 634     char         elm[SIZEOF_MAX];
 635     const unsigned long used = dynar->used;
 636     unsigned long       i    = 0;
 637
 638     for (i = 0; i < used; i++) {
 639       _xbt_dynar_get_elm(elm, dynar, i);
 640       op(elm);
 641     }
 642   }
 643   _dynar_unlock(dynar);
 644 }
 645
 646 /** @brief Put the cursor at the begining of the dynar.
 647  *
 648  * Actually, the cursor is set one step before the begining, so that you
 649  * can iterate over the dynar with a for loop.
 650  *
 651  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 652  */
 653 void
 654 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
 655                        int        * const cursor) {
 656
 657   _dynar_lock(dynar);
 658   DEBUG1("Set cursor on %p to the first position",(void*)dynar);
 659   *cursor = 0;
 660 }
 661
 662 /** @brief Move the cursor to the next value
 663  *
 664  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 665  */
 666 void
 667 _xbt_dynar_cursor_step(const xbt_dynar_t dynar,
 668                        int        * const cursor) {
 669
 670   (*cursor)++;
 671 }
 672
 673 /** @brief Get the data currently pointed by the cursor
 674  *
 675  * @warning Do not call this function directly, but only through xbt_dynar_foreach.
 676  */
 677 int
 678 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
 679                       int                * const cursor,
 680                       void               * const dst) {
 681
 682   _sanity_check_dynar(dynar);
 683   {
 684
 685     const int idx = *cursor;
 686
 687     if (idx >= dynar->used) {
 688       DEBUG1("Cursor on %p already on last elem",(void*)dynar);
 689       _dynar_unlock(dynar);
 690       return FALSE;
 691     }
 692     DEBUG2("Cash out cursor on %p at %d",(void*)dynar,idx);
 693
 694     _xbt_dynar_get_elm(dst, dynar, idx);
 695   }
 696   return TRUE;
 697
 698 }
 699
 700 /** @brief Removes and free the entry pointed by the cursor
 701  *
 702  * This function can be used while traversing without problem.
 703  */
 704 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 705                           int          * const cursor) {
 706
 707   _xbt_dynar_remove_at(dynar,(*cursor)--,NULL);
 708 }
 709
 710 /** @brief Unlocks a synchronized dynar when you want to break the traversal
 711  *
 712  * This function must be used if you <tt>break</tt> the
 713  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
 714  * regular traversal reaching the end of the elements
 715  */
 716 void xbt_dynar_cursor_unlock(xbt_dynar_t dynar) {
 717   _dynar_unlock(dynar);
 718 }
 719
 720 #ifdef SIMGRID_TEST
 721
 722 #define NB_ELEM 5000
 723
 724 XBT_TEST_SUITE("dynar","Dynar data container");
 725 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 726 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 727
 728 XBT_TEST_UNIT("int",test_dynar_int,"Dynars of integers") {
 729    /* Vars_decl [doxygen cruft] */
 730    xbt_dynar_t d;
 731    int i,cpt,cursor;
 732    int *iptr;
 733
 734    xbt_test_add0("==== Traverse the empty dynar");
 735    d=xbt_dynar_new(sizeof(int),NULL);
 736    xbt_dynar_foreach(d,cursor,i){
 737      xbt_assert0(0,"Damnit, there is something in the empty dynar");
 738    }
 739    xbt_dynar_free(&d);
 740    xbt_dynar_free(&d);
 741
 742    xbt_test_add1("==== Push %d int, set them again 3 times, traverse them, shift them",
 743         NB_ELEM);
 744    /* Populate_ints [doxygen cruft] */
 745    /* 1. Populate the dynar */
 746    d=xbt_dynar_new(sizeof(int),NULL);
 747    for (cpt=0; cpt< NB_ELEM; cpt++) {
 748      xbt_dynar_push_as(d,int,cpt); /* This is faster (and possible only with scalars) */
 749      /* xbt_dynar_push(d,&cpt);       This would also work */
 750      xbt_test_log2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 751    }
 752
 753    /* 2. Traverse manually the dynar */
 754    for (cursor=0; cursor< NB_ELEM; cursor++) {
 755      iptr=xbt_dynar_get_ptr(d,cursor);
 756      xbt_test_assert2(cursor == *iptr,
 757                       "The retrieved value is not the same than the injected one (%d!=%d)",
 758                       cursor,cpt);
 759    }
 760
 761    /* 3. Traverse the dynar using the neat macro to that extend */
 762    xbt_dynar_foreach(d,cursor,cpt){
 763      xbt_test_assert2(cursor == cpt,
 764                       "The retrieved value is not the same than the injected one (%d!=%d)",
 765                       cursor,cpt);
 766    }
 767    /* end_of_traversal */
 768
 769    for (cpt=0; cpt< NB_ELEM; cpt++)
 770      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 771
 772    for (cpt=0; cpt< NB_ELEM; cpt++)
 773      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 774 /*     xbt_dynar_set(d,cpt,&cpt);*/
 775
 776    for (cpt=0; cpt< NB_ELEM; cpt++)
 777      *(int*)xbt_dynar_get_ptr(d,cpt) = cpt;
 778
 779    cpt=0;
 780    xbt_dynar_foreach(d,cursor,i){
 781      xbt_test_assert2(i == cpt,
 782                       "The retrieved value is not the same than the injected one (%d!=%d)",
 783                       i,cpt);
 784      cpt++;
 785    }
 786    xbt_test_assert2(cpt == NB_ELEM,
 787                     "Cannot retrieve my %d values. Last got one is %d",
 788                     NB_ELEM, cpt);
 789
 790    /* shifting [doxygen cruft] */
 791    /* 4. Shift all the values */
 792    for (cpt=0; cpt< NB_ELEM; cpt++) {
 793      xbt_dynar_shift(d,&i);
 794      xbt_test_assert2(i == cpt,
 795                       "The retrieved value is not the same than the injected one (%d!=%d)",
 796                       i,cpt);
 797      xbt_test_log2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 798    }
 799
 800    /* 5. Free the resources */
 801    xbt_dynar_free(&d);
 802    xbt_dynar_free(&d);
 803
 804
 805    xbt_test_add1("==== Unshift/pop %d int",NB_ELEM);
 806    d=xbt_dynar_new(sizeof(int),NULL);
 807    for (cpt=0; cpt< NB_ELEM; cpt++) {
 808      xbt_dynar_unshift(d,&cpt);
 809      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 810    }
 811    for (cpt=0; cpt< NB_ELEM; cpt++) {
 812      i=xbt_dynar_pop_as(d,int);
 813      xbt_test_assert2(i == cpt,
 814                       "The retrieved value is not the same than the injected one (%d!=%d)",
 815                       i,cpt);
 816      xbt_test_log2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 817    }
 818    xbt_dynar_free(&d);
 819    xbt_dynar_free(&d);
 820
 821
 822    xbt_test_add1("==== Push %d int, insert 1000 int in the middle, shift everything",NB_ELEM);
 823    d=xbt_dynar_new(sizeof(int),NULL);
 824    for (cpt=0; cpt< NB_ELEM; cpt++) {
 825      xbt_dynar_push_as(d,int,cpt);
 826      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 827    }
 828    for (cpt=0; cpt< 1000; cpt++) {
 829      xbt_dynar_insert_at_as(d,2500,int,cpt);
 830      DEBUG2("Push %d, length=%lu",cpt, xbt_dynar_length(d));
 831    }
 832
 833    for (cpt=0; cpt< 2500; cpt++) {
 834      xbt_dynar_shift(d,&i);
 835      xbt_test_assert2(i == cpt,
 836              "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 837                i,cpt);
 838      DEBUG2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 839    }
 840    for (cpt=999; cpt>=0; cpt--) {
 841      xbt_dynar_shift(d,&i);
 842      xbt_test_assert2(i == cpt,
 843            "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 844                       i,cpt);
 845    }
 846    for (cpt=2500; cpt< NB_ELEM; cpt++) {
 847      xbt_dynar_shift(d,&i);
 848       xbt_test_assert2(i == cpt,
 849            "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 850                        i,cpt);
 851    }
 852    xbt_dynar_free(&d);
 853    xbt_dynar_free(&d);
 854
 855
 856    xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest",NB_ELEM);
 857    d=xbt_dynar_new(sizeof(int),NULL);
 858    for (cpt=0; cpt< NB_ELEM; cpt++)
 859      xbt_dynar_push_as(d,int,cpt);
 860
 861    for (cpt=2000; cpt< 4000; cpt++) {
 862      xbt_dynar_remove_at(d,2000,&i);
 863      xbt_test_assert2(i == cpt,
 864                       "Remove a bad value. Got %d, expected %d",
 865                       i,cpt);
 866      DEBUG2("remove %d, length=%lu",cpt, xbt_dynar_length(d));
 867    }
 868    xbt_dynar_free(&d);
 869    xbt_dynar_free(&d);
 870 }
 871 /*******************************************************************************/
 872 /*******************************************************************************/
 873 /*******************************************************************************/
 874 XBT_TEST_UNIT("double",test_dynar_double,"Dynars of doubles") {
 875    xbt_dynar_t d;
 876    int cpt,cursor;
 877    double d1,d2;
 878
 879    xbt_test_add0("==== Traverse the empty dynar");
 880    d=xbt_dynar_new(sizeof(int),NULL);
 881    xbt_dynar_foreach(d,cursor,cpt){
 882      xbt_test_assert0(FALSE,
 883              "Damnit, there is something in the empty dynar");
 884    }
 885    xbt_dynar_free(&d);
 886    xbt_dynar_free(&d);
 887
 888    xbt_test_add0("==== Push/shift 5000 doubles");
 889    d=xbt_dynar_new(sizeof(double),NULL);
 890    for (cpt=0; cpt< 5000; cpt++) {
 891      d1=(double)cpt;
 892      xbt_dynar_push(d,&d1);
 893    }
 894    xbt_dynar_foreach(d,cursor,d2){
 895      d1=(double)cursor;
 896      xbt_test_assert2(d1 == d2,
 897            "The retrieved value is not the same than the injected one (%f!=%f)",
 898                   d1,d2);
 899    }
 900    for (cpt=0; cpt< 5000; cpt++) {
 901      d1=(double)cpt;
 902      xbt_dynar_shift(d,&d2);
 903      xbt_test_assert2(d1 == d2,
 904            "The retrieved value is not the same than the injected one (%f!=%f)",
 905                   d1,d2);
 906    }
 907    xbt_dynar_free(&d);
 908    xbt_dynar_free(&d);
 909
 910
 911    xbt_test_add0("==== Unshift/pop 5000 doubles");
 912    d=xbt_dynar_new(sizeof(double),NULL);
 913    for (cpt=0; cpt< 5000; cpt++) {
 914      d1=(double)cpt;
 915      xbt_dynar_unshift(d,&d1);
 916    }
 917    for (cpt=0; cpt< 5000; cpt++) {
 918      d1=(double)cpt;
 919      xbt_dynar_pop(d,&d2);
 920      xbt_test_assert2 (d1 == d2,
 921            "The retrieved value is not the same than the injected one (%f!=%f)",
 922                    d1,d2);
 923    }
 924    xbt_dynar_free(&d);
 925    xbt_dynar_free(&d);
 926
 927
 928
 929    xbt_test_add0("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
 930    d=xbt_dynar_new(sizeof(double),NULL);
 931    for (cpt=0; cpt< 5000; cpt++) {
 932      d1=(double)cpt;
 933      xbt_dynar_push(d,&d1);
 934    }
 935    for (cpt=0; cpt< 1000; cpt++) {
 936      d1=(double)cpt;
 937      xbt_dynar_insert_at(d,2500,&d1);
 938    }
 939
 940    for (cpt=0; cpt< 2500; cpt++) {
 941      d1=(double)cpt;
 942      xbt_dynar_shift(d,&d2);
 943      xbt_test_assert2(d1 == d2,
 944            "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
 945                   d1,d2);
 946      DEBUG2("Pop %d, length=%lu",cpt, xbt_dynar_length(d));
 947    }
 948    for (cpt=999; cpt>=0; cpt--) {
 949      d1=(double)cpt;
 950      xbt_dynar_shift(d,&d2);
 951      xbt_test_assert2 (d1 == d2,
 952            "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
 953                    d1,d2);
 954    }
 955    for (cpt=2500; cpt< 5000; cpt++) {
 956      d1=(double)cpt;
 957      xbt_dynar_shift(d,&d2);
 958      xbt_test_assert2 (d1 == d2,
 959            "The retrieved value is not the same than the injected one at the end (%f!=%f)",
 960                    d1,d2);
 961    }
 962    xbt_dynar_free(&d);
 963    xbt_dynar_free(&d);
 964
 965
 966    xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
 967    d=xbt_dynar_new(sizeof(double),NULL);
 968    for (cpt=0; cpt< 5000; cpt++) {
 969      d1=(double)cpt;
 970      xbt_dynar_push(d,&d1);
 971    }
 972    for (cpt=2000; cpt< 4000; cpt++) {
 973      d1=(double)cpt;
 974      xbt_dynar_remove_at(d,2000,&d2);
 975      xbt_test_assert2 (d1 == d2,
 976            "Remove a bad value. Got %f, expected %f",
 977                d2,d1);
 978    }
 979    xbt_dynar_free(&d);
 980    xbt_dynar_free(&d);
 981 }
 982
 983
 984 /* doxygen_string_cruft */
 985
 986 /* The function we will use to free the data */
 987 static void free_string(void *d){
 988   free(*(void**)d);
 989 }
 990
 991 /*******************************************************************************/
 992 /*******************************************************************************/
 993 /*******************************************************************************/
 994 XBT_TEST_UNIT("string",test_dynar_string,"Dyars of strings") {
 995    xbt_dynar_t d;
 996    int cpt;
 997    char buf[1024];
 998    char *s1,*s2;
 999
1000    xbt_test_add0("==== Traverse the empty dynar");
1001    d=xbt_dynar_new(sizeof(char *),&free_string);
1002    xbt_dynar_foreach(d,cpt,s1){
1003      xbt_test_assert0(FALSE,
1004                   "Damnit, there is something in the empty dynar");
1005    }
1006    xbt_dynar_free(&d);
1007    xbt_dynar_free(&d);
1008
1009    xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",NB_ELEM);
1010    /* Populate_str [doxygen cruft] */
1011    d=xbt_dynar_new(sizeof(char*),&free_string);
1012    /* 1. Populate the dynar */
1013    for (cpt=0; cpt< NB_ELEM; cpt++) {
1014      sprintf(buf,"%d",cpt);
1015      s1=strdup(buf);
1016      xbt_dynar_push(d,&s1);
1017    }
1018    for (cpt=0; cpt< NB_ELEM; cpt++) {
1019      sprintf(buf,"%d",cpt);
1020      s1=strdup(buf);
1021      xbt_dynar_replace(d,cpt,&s1);
1022    }
1023    for (cpt=0; cpt< NB_ELEM; cpt++) {
1024      sprintf(buf,"%d",cpt);
1025      s1=strdup(buf);
1026      xbt_dynar_replace(d,cpt,&s1);
1027    }
1028    for (cpt=0; cpt< NB_ELEM; cpt++) {
1029      sprintf(buf,"%d",cpt);
1030      s1=strdup(buf);
1031      xbt_dynar_replace(d,cpt,&s1);
1032    }
1033    for (cpt=0; cpt< NB_ELEM; cpt++) {
1034      sprintf(buf,"%d",cpt);
1035      xbt_dynar_shift(d,&s2);
1036      xbt_test_assert2 (!strcmp(buf,s2),
1037             "The retrieved value is not the same than the injected one (%s!=%s)",
1038                    buf,s2);
1039      free(s2);
1040    }
1041    xbt_dynar_free(&d);
1042    xbt_dynar_free(&d);
1043
1044
1045    xbt_test_add1("==== Unshift, traverse and pop %d strings",NB_ELEM);
1046    d=xbt_dynar_new(sizeof(char**),&free_string);
1047    for (cpt=0; cpt< NB_ELEM; cpt++) {
1048      sprintf(buf,"%d",cpt);
1049      s1=strdup(buf);
1050      xbt_dynar_unshift(d,&s1);
1051    }
1052    /* 2. Traverse the dynar with the macro */
1053    xbt_dynar_foreach(d,cpt,s1) {
1054      sprintf(buf,"%d",NB_ELEM - cpt -1);
1055      xbt_test_assert2 (!strcmp(buf,s1),
1056            "The retrieved value is not the same than the injected one (%s!=%s)",
1057                buf,s1);
1058    }
1059    /* 3. Traverse the dynar with the macro */
1060    for (cpt=0; cpt< NB_ELEM; cpt++) {
1061      sprintf(buf,"%d",cpt);
1062      xbt_dynar_pop(d,&s2);
1063      xbt_test_assert2 (!strcmp(buf,s2),
1064            "The retrieved value is not the same than the injected one (%s!=%s)",
1065                buf,s2);
1066      free(s2);
1067    }
1068    /* 4. Free the resources */
1069    xbt_dynar_free(&d);
1070    xbt_dynar_free(&d);
1071
1072
1073    xbt_test_add2("==== Push %d strings, insert %d strings in the middle, shift everything",NB_ELEM,NB_ELEM/5);
1074    d=xbt_dynar_new(sizeof(char*),&free_string);
1075    for (cpt=0; cpt< NB_ELEM; cpt++) {
1076      sprintf(buf,"%d",cpt);
1077      s1=strdup(buf);
1078      xbt_dynar_push(d,&s1);
1079    }
1080    for (cpt=0; cpt< NB_ELEM/5; cpt++) {
1081      sprintf(buf,"%d",cpt);
1082      s1=strdup(buf);
1083      xbt_dynar_insert_at(d,NB_ELEM/2,&s1);
1084    }
1085
1086    for (cpt=0; cpt< NB_ELEM/2; cpt++) {
1087      sprintf(buf,"%d",cpt);
1088      xbt_dynar_shift(d,&s2);
1089      xbt_test_assert2(!strcmp(buf,s2),
1090            "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1091                buf,s2);
1092       free(s2);
1093    }
1094    for (cpt=(NB_ELEM/5)-1; cpt>=0; cpt--) {
1095      sprintf(buf,"%d",cpt);
1096      xbt_dynar_shift(d,&s2);
1097      xbt_test_assert2 (!strcmp(buf,s2),
1098            "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1099                buf,s2);
1100      free(s2);
1101    }
1102    for (cpt=NB_ELEM/2; cpt< NB_ELEM; cpt++) {
1103      sprintf(buf,"%d",cpt);
1104      xbt_dynar_shift(d,&s2);
1105      xbt_test_assert2 (!strcmp(buf,s2),
1106            "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1107                buf,s2);
1108      free(s2);
1109    }
1110    xbt_dynar_free(&d);
1111    xbt_dynar_free(&d);
1112
1113
1114    xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest",NB_ELEM,2*(NB_ELEM/5),4*(NB_ELEM/5));
1115    d=xbt_dynar_new(sizeof(char*),&free_string);
1116    for (cpt=0; cpt< NB_ELEM; cpt++) {
1117      sprintf(buf,"%d",cpt);
1118      s1=strdup(buf);
1119      xbt_dynar_push(d,&s1);
1120    }
1121    for (cpt=2*(NB_ELEM/5); cpt< 4*(NB_ELEM/5); cpt++) {
1122      sprintf(buf,"%d",cpt);
1123      xbt_dynar_remove_at(d,2*(NB_ELEM/5),&s2);
1124      xbt_test_assert2(!strcmp(buf,s2),
1125                   "Remove a bad value. Got %s, expected %s",
1126                   s2,buf);
1127       free(s2);
1128    }
1129    xbt_dynar_free(&d); /* end_of_doxygen */
1130 }
1131
1132
1133 /*******************************************************************************/
1134 /*******************************************************************************/
1135 /*******************************************************************************/
1136 #include "xbt/synchro.h"
1137 static void pusher_f(void *a) {
1138    xbt_dynar_t d=(xbt_dynar_t)a;
1139    int i;
1140    for (i=0; i<500; i++) {
1141       xbt_dynar_push(d,&i);
1142    }
1143 }
1144 static void poper_f(void *a) {
1145    xbt_dynar_t d=(xbt_dynar_t)a;
1146    int i;
1147    int data;
1148    xbt_ex_t e;
1149
1150    for (i=0; i<500; i++) {
1151       TRY {
1152          xbt_dynar_pop(d,&data);
1153       } CATCH(e) {
1154          if (e.category == bound_error) {
1155             xbt_ex_free(e);
1156             i--;
1157          } else {
1158             RETHROW;
1159          }
1160       }
1161    }
1162 }
1163
1164
1165 XBT_TEST_UNIT("synchronized int",test_dynar_sync_int,"Synchronized dynars of integers") {
1166    /* Vars_decl [doxygen cruft] */
1167    xbt_dynar_t d;
1168    xbt_thread_t pusher,poper;
1169
1170    xbt_test_add0("==== Have a pusher and a popper on the dynar");
1171    d=xbt_dynar_new_sync(sizeof(int),NULL);
1172    pusher = xbt_thread_create("pusher",pusher_f,d);
1173    poper = xbt_thread_create("poper",poper_f,d);
1174    xbt_thread_join(pusher);
1175    xbt_thread_join(poper);
1176    xbt_dynar_free(&d);
1177 }
1178
1179 #endif /* SIMGRID_TEST */