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