src/xbt/dynar.c

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