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 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
 378                                       const unsigned long idx)
 379 {
 380
 381   void *res;
 382   _dynar_lock(dynar);
 383   _sanity_check_dynar(dynar);
 384
 385   if (idx >= dynar->used) {
 386     _xbt_dynar_expand(dynar, idx + 1);
 387     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
 388                    (idx + 1 - dynar->used)*dynar->elmsize);
 389     dynar->used = idx + 1;
 390   }
 391
 392   _dynar_unlock(dynar);
 393
 394   res = _xbt_dynar_elm(dynar, idx);
 395
 396   return res;
 397 }
 398
 399 static void XBT_INLINE          /* not synchronized */
 400 _xbt_dynar_set(xbt_dynar_t dynar,
 401                const unsigned long idx, const void *const src)
 402 {
 403
 404   _sanity_check_dynar(dynar);
 405
 406   if (idx >= dynar->used) {
 407     _xbt_dynar_expand(dynar, idx + 1);
 408     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
 409                    (idx + 1 - dynar->used)*dynar->elmsize);
 410     dynar->used = idx + 1;
 411   }
 412
 413   _xbt_dynar_put_elm(dynar, idx, src);
 414 }
 415
 416 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
 417  *
 418  * \param dynar information dealer
 419  * \param idx index of the slot we want to modify
 420  * \param src What will be feeded to the dynar
 421  *
 422  * If you want to free the previous content, use xbt_dynar_replace().
 423  */
 424 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
 425                               const void *const src)
 426 {
 427
 428   _dynar_lock(dynar);
 429   _xbt_dynar_set(dynar, idx, src);
 430   _dynar_unlock(dynar);
 431 }
 432
 433 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
 434  *
 435  * \param dynar
 436  * \param idx
 437  * \param object
 438  *
 439  * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
 440  * free the previous value at this position. If you don't want to free the
 441  * previous content, use xbt_dynar_set().
 442  */
 443 void
 444 xbt_dynar_replace(xbt_dynar_t dynar,
 445                   const unsigned long idx, const void *const object)
 446 {
 447   _dynar_lock(dynar);
 448   _sanity_check_dynar(dynar);
 449
 450   if (idx < dynar->used && dynar->free_f) {
 451     void *const old_object = _xbt_dynar_elm(dynar, idx);
 452
 453     dynar->free_f(old_object);
 454   }
 455
 456   _xbt_dynar_set(dynar, idx, object);
 457   _dynar_unlock(dynar);
 458 }
 459
 460 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 461                                                  const unsigned long idx)
 462 {
 463   void *res;
 464   unsigned long old_used;
 465   unsigned long new_used;
 466   long nb_shift;
 467
 468   _sanity_check_dynar(dynar);
 469   _sanity_check_idx(idx);
 470
 471   old_used = dynar->used;
 472   new_used = old_used + 1;
 473
 474   _xbt_dynar_expand(dynar, new_used);
 475
 476   nb_shift = old_used - idx;
 477
 478   if (nb_shift>0) {
 479     memmove(_xbt_dynar_elm(dynar, idx + 1),
 480             _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
 481   }
 482
 483   dynar->used = new_used;
 484   res = _xbt_dynar_elm(dynar, idx);
 485   return res;
 486 }
 487
 488 /** @brief Make room for a new element, and return a pointer to it
 489  *
 490  * You can then use regular affectation to set its value instead of relying
 491  * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
 492  */
 493 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
 494 {
 495   void *res;
 496
 497   _dynar_lock(dynar);
 498   res = _xbt_dynar_insert_at_ptr(dynar, idx);
 499   _dynar_unlock(dynar);
 500   return res;
 501 }
 502
 503 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
 504  *
 505  * Set the Nth element of a dynar, expanding the dynar if needed, and
 506  * moving the previously existing value and all subsequent ones to one
 507  * position right in the dynar.
 508  */
 509 XBT_INLINE void
 510 xbt_dynar_insert_at(xbt_dynar_t const dynar,
 511                     const int idx, const void *const src)
 512 {
 513
 514   _dynar_lock(dynar);
 515   /* checks done in xbt_dynar_insert_at_ptr */
 516   memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
 517   _dynar_unlock(dynar);
 518 }
 519
 520 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
 521  *
 522  * Get the Nth element of a dynar, removing it from the dynar and moving
 523  * all subsequent values to one position left in the dynar.
 524  *
 525  * If the object argument of this function is a non-null pointer, the removed
 526  * element is copied to this address. If not, the element is freed using the
 527  * free_f function passed at dynar creation.
 528  */
 529 void
 530 xbt_dynar_remove_at(xbt_dynar_t const dynar,
 531                     const int idx, void *const object)
 532 {
 533
 534   _dynar_lock(dynar);
 535   _xbt_dynar_remove_at(dynar, idx, object);
 536   _dynar_unlock(dynar);
 537 }
 538
 539 /** @brief Returns the position of the element in the dynar
 540  *
 541  * Raises not_found_error if not found.
 542  */
 543 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
 544 {
 545   unsigned long it;
 546
 547   _dynar_lock(dynar);
 548   for (it = 0; it < dynar->used; it++)
 549     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
 550       _dynar_unlock(dynar);
 551       return it;
 552     }
 553
 554   _dynar_unlock(dynar);
 555   THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
 556          dynar);
 557 }
 558
 559 /** @brief Returns a boolean indicating whether the element is part of the dynar */
 560 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
 561 {
 562
 563   xbt_ex_t e;
 564
 565   TRY {
 566     xbt_dynar_search(dynar, elem);
 567   }
 568   CATCH(e) {
 569     if (e.category == not_found_error) {
 570       xbt_ex_free(e);
 571       return 0;
 572     }
 573     RETHROW;
 574   }
 575   return 1;
 576 }
 577
 578 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
 579  *
 580  * You can then use regular affectation to set its value instead of relying
 581  * on the slow memcpy. This is what xbt_dynar_push_as() does.
 582  */
 583 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
 584 {
 585   void *res;
 586
 587   /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
 588      dynar->used don't change between reading it and getting the lock
 589      within xbt_dynar_insert_at_ptr */
 590   _dynar_lock(dynar);
 591   res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
 592   _dynar_unlock(dynar);
 593   return res;
 594 }
 595
 596 /** @brief Add an element at the end of the dynar */
 597 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
 598                                const void *const src)
 599 {
 600   _dynar_lock(dynar);
 601   /* checks done in xbt_dynar_insert_at_ptr */
 602   memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
 603          dynar->elmsize);
 604   _dynar_unlock(dynar);
 605 }
 606
 607 /** @brief Mark the last dynar's element as unused and return a pointer to it.
 608  *
 609  * You can then use regular affectation to set its value instead of relying
 610  * on the slow memcpy. This is what xbt_dynar_pop_as() does.
 611  */
 612 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
 613 {
 614   void *res;
 615
 616   _dynar_lock(dynar);
 617   _check_populated_dynar(dynar);
 618   XBT_DEBUG("Pop %p", (void *) dynar);
 619   dynar->used--;
 620   res = _xbt_dynar_elm(dynar, dynar->used);
 621   _dynar_unlock(dynar);
 622   return res;
 623 }
 624
 625 /** @brief Get and remove the last element of the dynar */
 626 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
 627 {
 628
 629   /* sanity checks done by remove_at */
 630   XBT_DEBUG("Pop %p", (void *) dynar);
 631   _dynar_lock(dynar);
 632   _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
 633   _dynar_unlock(dynar);
 634 }
 635
 636 /** @brief Add an element at the begining of the dynar.
 637  *
 638  * This is less efficient than xbt_dynar_push()
 639  */
 640 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
 641                                   const void *const src)
 642 {
 643
 644   /* sanity checks done by insert_at */
 645   xbt_dynar_insert_at(dynar, 0, src);
 646 }
 647
 648 /** @brief Get and remove the first element of the dynar.
 649  *
 650  * This is less efficient than xbt_dynar_pop()
 651  */
 652 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
 653 {
 654
 655   /* sanity checks done by remove_at */
 656   xbt_dynar_remove_at(dynar, 0, dst);
 657 }
 658
 659 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
 660 {
 661   char *const data = (char *) dynar->data;
 662   const unsigned long elmsize = dynar->elmsize;
 663   const unsigned long used = dynar->used;
 664   unsigned long i;
 665
 666   for (i = 0; i < used; i++) {
 667     char* elm = (char*) data + i * elmsize;
 668     op(elm);
 669   }
 670 }
 671
 672 /** @brief Apply a function to each member of a dynar
 673  *
 674  * The mapped function may change the value of the element itself,
 675  * but should not mess with the structure of the dynar.
 676  *
 677  * If the dynar is synchronized, it is locked during the whole map
 678  * operation, so make sure your function don't call any function
 679  * from xbt_dynar_* on it, or you'll get a deadlock.
 680  */
 681 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
 682                               void_f_pvoid_t const op)
 683 {
 684
 685   _sanity_check_dynar(dynar);
 686   _dynar_lock(dynar);
 687
 688   _dynar_map(dynar, op);
 689
 690   _dynar_unlock(dynar);
 691 }
 692
 693
 694 /** @brief Removes and free the entry pointed by the cursor
 695  *
 696  * This function can be used while traversing without problem.
 697  */
 698 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 699                                     unsigned int *const cursor)
 700 {
 701
 702   _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
 703 }
 704
 705 /** @brief Unlocks a synchronized dynar when you want to break the traversal
 706  *
 707  * This function must be used if you <tt>break</tt> the
 708  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
 709  * regular traversal reaching the end of the elements
 710  */
 711 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
 712 {
 713   _dynar_unlock(dynar);
 714 }
 715
 716 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
 717  *
 718  * \param dynar the dynar to sort
 719  * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
 720  *
 721  * Remark: if the elements stored in the dynar are structures, the compar_fn
 722  * function has to retrieve the field to sort first.
 723  */
 724 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
 725                                int_f_cpvoid_cpvoid_t compar_fn)
 726 {
 727
 728   _dynar_lock(dynar);
 729
 730 #ifdef HAVE_MERGESORT
 731   mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 732 #else
 733   qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 734 #endif
 735   _dynar_unlock(dynar);
 736 }
 737
 738 /** @brief Transform a dynar into a NULL terminated array
 739  *
 740  * \param dynar the dynar to transform
 741  */
 742 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
 743 {
 744   void * res;
 745         void * last = xbt_new0(char,dynar->elmsize);
 746         xbt_dynar_push(dynar, last);
 747         free(last);
 748         res = dynar->data;
 749         free(dynar);
 750         return res;
 751 }
 752
 753 /*
 754  * Return 0 if d1 and d2 are equal and 1 if not equal
 755  */
 756 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
 757                                         int(*compar)(const void *, const void *))
 758 {
 759         int i ;
 760         int size;
 761         if((!d1) && (!d2)) return 0;
 762         if((!d1) || (!d2))
 763         {
 764                 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
 765                 xbt_dynar_free(&d2);
 766                 return 1;
 767         }
 768         if((d1->elmsize)!=(d2->elmsize))
 769         {
 770                 XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
 771                 xbt_dynar_free(&d2);
 772                 return 1; // xbt_die
 773         }
 774         if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
 775         {
 776                 XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
 777                 xbt_dynar_free(&d2);
 778                 return 1;
 779         }
 780
 781         size = xbt_dynar_length(d1);
 782         for(i=0;i<size;i++)
 783         {
 784                 void *data1 = xbt_dynar_get_as(d1, i, void *);
 785                 void *data2 = xbt_dynar_get_as(d2, i, void *);
 786                 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
 787                 if(compar(data1,data2)){
 788                         xbt_dynar_free(&d2);
 789                         return 1;
 790                 }
 791         }
 792         xbt_dynar_free(&d2);
 793         return 0;
 794 }
 795
 796 #ifdef SIMGRID_TEST
 797
 798 #define NB_ELEM 5000
 799
 800 XBT_TEST_SUITE("dynar", "Dynar data container");
 801 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 802 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 803
 804 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 805 {
 806   /* Vars_decl [doxygen cruft] */
 807   xbt_dynar_t d;
 808   int i, cpt;
 809   unsigned int cursor;
 810   int *iptr;
 811
 812   xbt_test_add("==== Traverse the empty dynar");
 813   d = xbt_dynar_new(sizeof(int), NULL);
 814   xbt_dynar_foreach(d, cursor, i) {
 815     xbt_die( "Damnit, there is something in the empty dynar");
 816   }
 817   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 818   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 819   /* in your code is naturally the way to go outside a regression test */
 820
 821   xbt_test_add
 822       ("==== Push %d int, set them again 3 times, traverse them, shift them",
 823        NB_ELEM);
 824   /* Populate_ints [doxygen cruft] */
 825   /* 1. Populate the dynar */
 826   d = xbt_dynar_new(sizeof(int), NULL);
 827   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 828     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
 829     /* xbt_dynar_push(d,&cpt);       This would also work */
 830     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 831   }
 832
 833   /* 2. Traverse manually the dynar */
 834   for (cursor = 0; cursor < NB_ELEM; cursor++) {
 835     iptr = xbt_dynar_get_ptr(d, cursor);
 836     xbt_test_assert(cursor == *iptr,
 837                      "The retrieved value is not the same than the injected one (%d!=%d)",
 838                      cursor, cpt);
 839   }
 840
 841   /* 3. Traverse the dynar using the neat macro to that extend */
 842   xbt_dynar_foreach(d, cursor, cpt) {
 843     xbt_test_assert(cursor == cpt,
 844                      "The retrieved value is not the same than the injected one (%d!=%d)",
 845                      cursor, cpt);
 846   }
 847   /* end_of_traversal */
 848
 849   for (cpt = 0; cpt < NB_ELEM; cpt++)
 850     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 851
 852   for (cpt = 0; cpt < NB_ELEM; cpt++)
 853     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 854   /*     xbt_dynar_set(d,cpt,&cpt); */
 855
 856   for (cpt = 0; cpt < NB_ELEM; cpt++)
 857     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 858
 859   cpt = 0;
 860   xbt_dynar_foreach(d, cursor, i) {
 861     xbt_test_assert(i == cpt,
 862                      "The retrieved value is not the same than the injected one (%d!=%d)",
 863                      i, cpt);
 864     cpt++;
 865   }
 866   xbt_test_assert(cpt == NB_ELEM,
 867                    "Cannot retrieve my %d values. Last got one is %d",
 868                    NB_ELEM, cpt);
 869
 870   /* shifting [doxygen cruft] */
 871   /* 4. Shift all the values */
 872   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 873     xbt_dynar_shift(d, &i);
 874     xbt_test_assert(i == cpt,
 875                      "The retrieved value is not the same than the injected one (%d!=%d)",
 876                      i, cpt);
 877     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 878   }
 879
 880   /* 5. Free the resources */
 881   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 882   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 883   /* in your code is naturally the way to go outside a regression test */
 884
 885   xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
 886   d = xbt_dynar_new(sizeof(int), NULL);
 887   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 888     xbt_dynar_unshift(d, &cpt);
 889     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 890   }
 891   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 892     i = xbt_dynar_pop_as(d, int);
 893     xbt_test_assert(i == cpt,
 894                      "The retrieved value is not the same than the injected one (%d!=%d)",
 895                      i, cpt);
 896     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 897   }
 898   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 899   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 900   /* in your code is naturally the way to go outside a regression test */
 901
 902
 903   xbt_test_add
 904       ("==== Push %d int, insert 1000 int in the middle, shift everything",
 905        NB_ELEM);
 906   d = xbt_dynar_new(sizeof(int), NULL);
 907   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 908     xbt_dynar_push_as(d, int, cpt);
 909     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 910   }
 911   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
 912     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
 913     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 914   }
 915
 916   for (cpt = 0; cpt < NB_ELEM/2; 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 at the begining (%d!=%d)",
 920                      i, cpt);
 921     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 922   }
 923   for (cpt = 999; cpt >= 0; cpt--) {
 924     xbt_dynar_shift(d, &i);
 925     xbt_test_assert(i == cpt,
 926                      "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 927                      i, cpt);
 928   }
 929   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
 930     xbt_dynar_shift(d, &i);
 931     xbt_test_assert(i == cpt,
 932                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 933                      i, cpt);
 934   }
 935   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 936   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 937   /* in your code is naturally the way to go outside a regression test */
 938
 939   xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
 940                 NB_ELEM);
 941   d = xbt_dynar_new(sizeof(int), NULL);
 942   for (cpt = 0; cpt < NB_ELEM; cpt++)
 943     xbt_dynar_push_as(d, int, cpt);
 944
 945   for (cpt = 2000; cpt < 4000; cpt++) {
 946     xbt_dynar_remove_at(d, 2000, &i);
 947     xbt_test_assert(i == cpt,
 948                      "Remove a bad value. Got %d, expected %d", i, cpt);
 949     XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
 950   }
 951   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 952   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 953   /* in your code is naturally the way to go outside a regression test */
 954 }
 955
 956 /*******************************************************************************/
 957 /*******************************************************************************/
 958 /*******************************************************************************/
 959 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
 960 {
 961   xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
 962   unsigned int cursor;
 963   int cpt;
 964
 965   xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
 966   /* Populate_ints [doxygen cruft] */
 967   /* 1. Populate the dynar */
 968   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 969     xbt_dynar_insert_at(d, cpt, &cpt);
 970     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 971   }
 972
 973   /* 3. Traverse the dynar */
 974   xbt_dynar_foreach(d, cursor, cpt) {
 975     xbt_test_assert(cursor == cpt,
 976                      "The retrieved value is not the same than the injected one (%d!=%d)",
 977                      cursor, cpt);
 978   }
 979   /* end_of_traversal */
 980
 981   /* Re-fill with the same values using set_as (and re-verify) */
 982   for (cpt = 0; cpt < NB_ELEM; cpt++)
 983     xbt_dynar_set_as(d, cpt, int, cpt);
 984   xbt_dynar_foreach(d, cursor, cpt)
 985     xbt_test_assert(cursor == cpt,
 986                      "The retrieved value is not the same than the injected one (%d!=%d)",
 987                      cursor, cpt);
 988
 989   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 990     int val;
 991     xbt_dynar_remove_at(d,0,&val);
 992     xbt_test_assert(cpt == val,
 993                      "The retrieved value is not the same than the injected one (%d!=%d)",
 994                      cursor, cpt);
 995   }
 996   xbt_test_assert(xbt_dynar_is_empty(d),
 997                    "There is still %lu elements in the dynar after removing everything",
 998                    xbt_dynar_length(d));
 999   xbt_dynar_free(&d);
1000
1001   /* ********************* */
1002   xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1003   d = xbt_dynar_new(sizeof(int), NULL);
1004   for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1005     xbt_dynar_replace(d, cpt, &cpt);
1006     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1007   }
1008
1009   /* 3. Traverse the dynar */
1010   xbt_dynar_foreach(d, cursor, cpt) {
1011     xbt_test_assert(cursor == cpt,
1012                      "The retrieved value is not the same than the injected one (%d!=%d)",
1013                      cursor, cpt);
1014   }
1015   /* end_of_traversal */
1016
1017   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1018     int val;
1019     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1020     xbt_test_assert(cpt == val,
1021                      "The retrieved value is not the same than the injected one (%d!=%d)",
1022                      cursor, cpt);
1023   }
1024   xbt_test_assert(xbt_dynar_is_empty(d),
1025                    "There is still %lu elements in the dynar after removing everything",
1026                    xbt_dynar_length(d));
1027   xbt_dynar_free(&d);
1028 }
1029
1030 /*******************************************************************************/
1031 /*******************************************************************************/
1032 /*******************************************************************************/
1033 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1034 {
1035   xbt_dynar_t d;
1036   int cpt;
1037   unsigned int cursor;
1038   double d1, d2;
1039
1040   xbt_test_add("==== Traverse the empty dynar");
1041   d = xbt_dynar_new(sizeof(int), NULL);
1042   xbt_dynar_foreach(d, cursor, cpt) {
1043     xbt_test_assert(FALSE,
1044                      "Damnit, there is something in the empty dynar");
1045   }
1046   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1047   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1048   /* in your code is naturally the way to go outside a regression test */
1049
1050   xbt_test_add("==== Push/shift 5000 doubles");
1051   d = xbt_dynar_new(sizeof(double), NULL);
1052   for (cpt = 0; cpt < 5000; cpt++) {
1053     d1 = (double) cpt;
1054     xbt_dynar_push(d, &d1);
1055   }
1056   xbt_dynar_foreach(d, cursor, d2) {
1057     d1 = (double) cursor;
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   for (cpt = 0; cpt < 5000; cpt++) {
1063     d1 = (double) cpt;
1064     xbt_dynar_shift(d, &d2);
1065     xbt_test_assert(d1 == d2,
1066                      "The retrieved value is not the same than the injected one (%f!=%f)",
1067                      d1, d2);
1068   }
1069   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1070   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1071   /* in your code is naturally the way to go outside a regression test */
1072
1073   xbt_test_add("==== Unshift/pop 5000 doubles");
1074   d = xbt_dynar_new(sizeof(double), NULL);
1075   for (cpt = 0; cpt < 5000; cpt++) {
1076     d1 = (double) cpt;
1077     xbt_dynar_unshift(d, &d1);
1078   }
1079   for (cpt = 0; cpt < 5000; cpt++) {
1080     d1 = (double) cpt;
1081     xbt_dynar_pop(d, &d2);
1082     xbt_test_assert(d1 == d2,
1083                      "The retrieved value is not the same than the injected one (%f!=%f)",
1084                      d1, d2);
1085   }
1086   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1087   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1088   /* in your code is naturally the way to go outside a regression test */
1089
1090
1091
1092   xbt_test_add
1093       ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1094   d = xbt_dynar_new(sizeof(double), NULL);
1095   for (cpt = 0; cpt < 5000; cpt++) {
1096     d1 = (double) cpt;
1097     xbt_dynar_push(d, &d1);
1098   }
1099   for (cpt = 0; cpt < 1000; cpt++) {
1100     d1 = (double) cpt;
1101     xbt_dynar_insert_at(d, 2500, &d1);
1102   }
1103
1104   for (cpt = 0; cpt < 2500; cpt++) {
1105     d1 = (double) cpt;
1106     xbt_dynar_shift(d, &d2);
1107     xbt_test_assert(d1 == d2,
1108                      "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1109                      d1, d2);
1110     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1111   }
1112   for (cpt = 999; cpt >= 0; 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 in the middle (%f!=%f)",
1117                      d1, d2);
1118   }
1119   for (cpt = 2500; cpt < 5000; cpt++) {
1120     d1 = (double) cpt;
1121     xbt_dynar_shift(d, &d2);
1122     xbt_test_assert(d1 == d2,
1123                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1124                      d1, d2);
1125   }
1126   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1127   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1128   /* in your code is naturally the way to go outside a regression test */
1129
1130
1131   xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1132   d = xbt_dynar_new(sizeof(double), NULL);
1133   for (cpt = 0; cpt < 5000; cpt++) {
1134     d1 = (double) cpt;
1135     xbt_dynar_push(d, &d1);
1136   }
1137   for (cpt = 2000; cpt < 4000; cpt++) {
1138     d1 = (double) cpt;
1139     xbt_dynar_remove_at(d, 2000, &d2);
1140     xbt_test_assert(d1 == d2,
1141                      "Remove a bad value. Got %f, expected %f", d2, d1);
1142   }
1143   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1144   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1145   /* in your code is naturally the way to go outside a regression test */
1146 }
1147
1148
1149 /* doxygen_string_cruft */
1150
1151 /*******************************************************************************/
1152 /*******************************************************************************/
1153 /*******************************************************************************/
1154 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1155 {
1156   xbt_dynar_t d;
1157   int cpt;
1158   unsigned int iter;
1159   char buf[1024];
1160   char *s1, *s2;
1161
1162   xbt_test_add("==== Traverse the empty dynar");
1163   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1164   xbt_dynar_foreach(d, iter, s1) {
1165     xbt_test_assert(FALSE,
1166                      "Damnit, there is something in the empty dynar");
1167   }
1168   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1169   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1170   /* in your code is naturally the way to go outside a regression test */
1171
1172   xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1173                 NB_ELEM);
1174   /* Populate_str [doxygen cruft] */
1175   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1176   /* 1. Populate the dynar */
1177   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1178     sprintf(buf, "%d", cpt);
1179     s1 = strdup(buf);
1180     xbt_dynar_push(d, &s1);
1181   }
1182   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1183     sprintf(buf, "%d", cpt);
1184     s1 = strdup(buf);
1185     xbt_dynar_replace(d, cpt, &s1);
1186   }
1187   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1188     sprintf(buf, "%d", cpt);
1189     s1 = strdup(buf);
1190     xbt_dynar_replace(d, cpt, &s1);
1191   }
1192   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1193     sprintf(buf, "%d", cpt);
1194     s1 = strdup(buf);
1195     xbt_dynar_replace(d, cpt, &s1);
1196   }
1197   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1198     sprintf(buf, "%d", cpt);
1199     xbt_dynar_shift(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   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1206   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1207   /* in your code is naturally the way to go outside a regression test */
1208
1209   xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1210   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1211   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1212     sprintf(buf, "%d", cpt);
1213     s1 = strdup(buf);
1214     xbt_dynar_unshift(d, &s1);
1215   }
1216   /* 2. Traverse the dynar with the macro */
1217   xbt_dynar_foreach(d, iter, s1) {
1218     sprintf(buf, "%d", NB_ELEM - iter - 1);
1219     xbt_test_assert(!strcmp(buf, s1),
1220                      "The retrieved value is not the same than the injected one (%s!=%s)",
1221                      buf, s1);
1222   }
1223   /* 3. Traverse the dynar with the macro */
1224   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1225     sprintf(buf, "%d", cpt);
1226     xbt_dynar_pop(d, &s2);
1227     xbt_test_assert(!strcmp(buf, s2),
1228                      "The retrieved value is not the same than the injected one (%s!=%s)",
1229                      buf, s2);
1230     free(s2);
1231   }
1232   /* 4. Free the resources */
1233   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1234   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1235   /* in your code is naturally the way to go outside a regression test */
1236
1237
1238   xbt_test_add
1239       ("==== Push %d strings, insert %d strings in the middle, shift everything",
1240        NB_ELEM, NB_ELEM / 5);
1241   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1242   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1243     sprintf(buf, "%d", cpt);
1244     s1 = strdup(buf);
1245     xbt_dynar_push(d, &s1);
1246   }
1247   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1248     sprintf(buf, "%d", cpt);
1249     s1 = strdup(buf);
1250     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1251   }
1252
1253   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1254     sprintf(buf, "%d", cpt);
1255     xbt_dynar_shift(d, &s2);
1256     xbt_test_assert(!strcmp(buf, s2),
1257                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1258                      buf, s2);
1259     free(s2);
1260   }
1261   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1262     sprintf(buf, "%d", cpt);
1263     xbt_dynar_shift(d, &s2);
1264     xbt_test_assert(!strcmp(buf, s2),
1265                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1266                      buf, s2);
1267     free(s2);
1268   }
1269   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1270     sprintf(buf, "%d", cpt);
1271     xbt_dynar_shift(d, &s2);
1272     xbt_test_assert(!strcmp(buf, s2),
1273                      "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1274                      buf, s2);
1275     free(s2);
1276   }
1277   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1278   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1279   /* in your code is naturally the way to go outside a regression test */
1280
1281
1282   xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1283                 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1284   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1285   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1286     sprintf(buf, "%d", cpt);
1287     s1 = strdup(buf);
1288     xbt_dynar_push(d, &s1);
1289   }
1290   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1291     sprintf(buf, "%d", cpt);
1292     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1293     xbt_test_assert(!strcmp(buf, s2),
1294                      "Remove a bad value. Got %s, expected %s", s2, buf);
1295     free(s2);
1296   }
1297   xbt_dynar_free(&d);           /* end_of_doxygen */
1298 }
1299
1300
1301 /*******************************************************************************/
1302 /*******************************************************************************/
1303 /*******************************************************************************/
1304 #include "xbt/synchro.h"
1305 static void pusher_f(void *a)
1306 {
1307   xbt_dynar_t d = (xbt_dynar_t) a;
1308   int i;
1309   for (i = 0; i < 500; i++) {
1310     xbt_dynar_push(d, &i);
1311   }
1312 }
1313
1314 static void poper_f(void *a)
1315 {
1316   xbt_dynar_t d = (xbt_dynar_t) a;
1317   volatile int i;
1318   int data;
1319   xbt_ex_t e;
1320
1321   for (i = 0; i < 500; i++) {
1322     TRY {
1323       xbt_dynar_pop(d, &data);
1324     }
1325     CATCH(e) {
1326       if (e.category == bound_error) {
1327         xbt_ex_free(e);
1328         i--;
1329       } else {
1330         RETHROW;
1331       }
1332     }
1333   }
1334 }
1335
1336
1337 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1338 {
1339   /* Vars_decl [doxygen cruft] */
1340   xbt_dynar_t d;
1341   xbt_thread_t pusher, poper;
1342
1343   xbt_test_add("==== Have a pusher and a popper on the dynar");
1344   d = xbt_dynar_new_sync(sizeof(int), NULL);
1345   pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1346   poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1347   xbt_thread_join(pusher);
1348   xbt_thread_join(poper);
1349   xbt_dynar_free(&d);
1350 }
1351
1352 #endif                          /* SIMGRID_TEST */