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