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