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