src/xbt/dynar.cpp

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