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