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