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 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   unsigned long nb_shift;
 369   unsigned long offset;
 370
 371   _sanity_check_dynar(dynar);
 372   _check_inbound_idx(dynar, idx);
 373
 374   if (object) {
 375     _xbt_dynar_get_elm(object, dynar, idx);
 376   } else if (dynar->free_f) {
 377     dynar->free_f(_xbt_dynar_elm(dynar, idx));
 378   }
 379
 380   nb_shift = dynar->used - 1 - idx;
 381
 382   if (nb_shift) {
 383     offset = nb_shift * dynar->elmsize;
 384     memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
 385   }
 386
 387   dynar->used--;
 388 }
 389
 390 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
 391  *
 392  * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
 393  * nullptr object argument if n equals to 1.
 394  *
 395  * Each of the removed elements is freed using the free_f function passed at dynar creation.
 396  */
 397 extern "C" void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
 398 {
 399   unsigned long nb_shift;
 400   unsigned long offset;
 401   unsigned long cur;
 402
 403   if (!n) return;
 404
 405   _sanity_check_dynar(dynar);
 406   _check_inbound_idx(dynar, idx);
 407   _check_inbound_idx(dynar, idx + n - 1);
 408
 409   if (dynar->free_f) {
 410     for (cur = idx; cur < idx + n; cur++) {
 411       dynar->free_f(_xbt_dynar_elm(dynar, cur));
 412     }
 413   }
 414
 415   nb_shift = dynar->used - n - idx;
 416
 417   if (nb_shift) {
 418     offset = nb_shift * dynar->elmsize;
 419     memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
 420   }
 421
 422   dynar->used -= n;
 423 }
 424
 425 /** @brief Returns the position of the element in the dynar
 426  *
 427  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
 428  * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
 429  * yourself:
 430  * \code
 431  * signed int position = -1;
 432  * xbt_dynar_foreach(dynar, iter, elem) {
 433  *    if (!memcmp(elem, searched_element, sizeof(*elem))) {
 434  *        position = iter;
 435  *        break;
 436  *    }
 437  * }
 438  * \endcode
 439  *
 440  * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
 441  * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
 442  */
 443 extern "C" unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* const elem)
 444 {
 445   unsigned long it;
 446
 447   for (it = 0; it < dynar->used; it++)
 448     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
 449       return it;
 450     }
 451
 452   THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
 453   return -1; // Won't happen, just to please eclipse
 454 }
 455
 456 /** @brief Returns the position of the element in the dynar (or -1 if not found)
 457  *
 458  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
 459  * what you want. Check the documentation of xbt_dynar_search() for more info.
 460  *
 461  * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
 462  * this very function will not work (but the other will).
 463  */
 464 extern "C" signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem)
 465 {
 466   unsigned long it;
 467
 468   for (it = 0; it < dynar->used; it++)
 469     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
 470       return it;
 471     }
 472
 473   return -1;
 474 }
 475
 476 /** @brief Returns a boolean indicating whether the element is part of the dynar
 477  *
 478  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
 479  * what you want. Check the documentation of xbt_dynar_search() for more info.
 480  */
 481 extern "C" int xbt_dynar_member(xbt_dynar_t const dynar, void* const elem)
 482 {
 483   unsigned long it;
 484
 485   for (it = 0; it < dynar->used; it++)
 486     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
 487       return 1;
 488     }
 489
 490   return 0;
 491 }
 492
 493 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
 494  *
 495  * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
 496  * xbt_dynar_push_as() does.
 497  */
 498 extern "C" void* xbt_dynar_push_ptr(xbt_dynar_t const dynar)
 499 {
 500   return xbt_dynar_insert_at_ptr(dynar, dynar->used);
 501 }
 502
 503 /** @brief Add an element at the end of the dynar */
 504 extern "C" void xbt_dynar_push(xbt_dynar_t const dynar, const void* const src)
 505 {
 506   /* checks done in xbt_dynar_insert_at_ptr */
 507   memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
 508 }
 509
 510 /** @brief Mark the last dynar's element as unused and return a pointer to it.
 511  *
 512  * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
 513  * xbt_dynar_pop_as() does.
 514  */
 515 extern "C" void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
 516 {
 517   _check_populated_dynar(dynar);
 518   XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
 519   dynar->used--;
 520   return _xbt_dynar_elm(dynar, dynar->used);
 521 }
 522
 523 /** @brief Get and remove the last element of the dynar */
 524 extern "C" void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst)
 525 {
 526   /* sanity checks done by remove_at */
 527   XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
 528   xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
 529 }
 530
 531 /** @brief Add an element at the begining of the dynar.
 532  *
 533  * This is less efficient than xbt_dynar_push()
 534  */
 535 extern "C" void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* const src)
 536 {
 537   /* sanity checks done by insert_at */
 538   xbt_dynar_insert_at(dynar, 0, src);
 539 }
 540
 541 /** @brief Get and remove the first element of the dynar.
 542  *
 543  * This is less efficient than xbt_dynar_pop()
 544  */
 545 extern "C" void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst)
 546 {
 547   /* sanity checks done by remove_at */
 548   xbt_dynar_remove_at(dynar, 0, dst);
 549 }
 550
 551 /** @brief Apply a function to each member of a dynar
 552  *
 553  * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
 554  */
 555 extern "C" void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
 556 {
 557   char *const data = (char *) dynar->data;
 558   const unsigned long elmsize = dynar->elmsize;
 559   const unsigned long used = dynar->used;
 560   unsigned long i;
 561
 562   _sanity_check_dynar(dynar);
 563
 564   for (i = 0; i < used; i++) {
 565     char* elm = (char*) data + i * elmsize;
 566     op(elm);
 567   }
 568 }
 569
 570 /** @brief Removes and free the entry pointed by the cursor
 571  *
 572  * This function can be used while traversing without problem.
 573  */
 574 extern "C" void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor)
 575 {
 576   xbt_dynar_remove_at(dynar, (*cursor)--, nullptr);
 577 }
 578
 579 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
 580  *
 581  * This function simply apply the classical qsort(3) function to the data stored in the dynar.
 582  * You should thus refer to the libc documentation, or to some online tutorial on how to write
 583  * a comparison function. Here is a quick example if you have integers in your dynar:
 584  *
 585  * @verbatim
 586  * int cmpfunc (const void * a, const void * b) {
 587  *   int intA = *(int*)a;
 588  *   int intB = *(int*)b;
 589  *   return intA - intB;
 590  * }
 591  * @endverbatim
 592  *
 593  * and now to sort a dynar of MSG hosts depending on their speed:
 594  * @verbatim
 595  * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
 596  *   MSG_host_t hostA = *(MSG_host_t*)a;
 597  *   MSG_host_t hostB = *(MSG_host_t*)b;
 598  *   return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
 599  * }
 600  * @endverbatim
 601  *
 602  * \param dynar the dynar to sort
 603  * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
 604  */
 605 extern "C" void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
 606 {
 607   if (dynar->data != nullptr)
 608     qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 609 }
 610
 611 static int strcmp_voidp(const void *pa, const void *pb) {
 612   return strcmp(*(const char **)pa, *(const char **)pb);
 613 }
 614
 615 /** @brief Sorts a dynar of strings (ie, char* data) */
 616 extern "C" xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
 617 {
 618   xbt_dynar_sort(dynar, strcmp_voidp);
 619   return dynar; // to enable functional uses
 620 }
 621
 622 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
 623  * Since there are only three colors, it is linear and much faster than a classical sort.
 624  * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
 625  *
 626  * \param dynar the dynar to sort
 627  * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to
 628  *        be 0, 1, or 2.
 629  *
 630  * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the
 631  * end and elements with color 1 are in the middle.
 632  *
 633  * Remark: if the elements stored in the dynar are structures, the color function has to retrieve the field to sort
 634  * first.
 635  */
 636 extern "C" void xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color)
 637 {
 638   unsigned long int i;
 639   unsigned long int p = -1;
 640   unsigned long int q = dynar->used;
 641   const unsigned long elmsize = dynar->elmsize;
 642   char* tmp[elmsize];
 643   void *elm;
 644
 645   for (i = 0; i < q;) {
 646     void *elmi = _xbt_dynar_elm(dynar, i);
 647     int colori = color(elmi);
 648
 649     if (colori == 1) {
 650       ++i;
 651     } else {
 652       if (colori == 0) {
 653         elm = _xbt_dynar_elm(dynar, ++p);
 654         ++i;
 655       } else {                  /* colori == 2 */
 656         elm = _xbt_dynar_elm(dynar, --q);
 657       }
 658       if (elm != elmi) {
 659         memcpy(tmp,  elm,  elmsize);
 660         memcpy(elm,  elmi, elmsize);
 661         memcpy(elmi, tmp,  elmsize);
 662       }
 663     }
 664   }
 665 }
 666
 667 /** @brief Transform a dynar into a nullptr terminated array.
 668  *
 669  *  \param dynar the dynar to transform
 670  *  \return pointer to the first element of the array
 671  *
 672  *  Note: The dynar won't be usable afterwards.
 673  */
 674 extern "C" void* xbt_dynar_to_array(xbt_dynar_t dynar)
 675 {
 676   void *res;
 677   xbt_dynar_shrink(dynar, 1);
 678   memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
 679   res = dynar->data;
 680   free(dynar);
 681   return res;
 682 }
 683
 684 /** @brief Compare two dynars
 685  *
 686  *  \param d1 first dynar to compare
 687  *  \param d2 second dynar to compare
 688  *  \param compar function to use to compare elements
 689  *  \return 0 if d1 and d2 are equal and 1 if not equal
 690  *
 691  *  d1 and d2 should be dynars of pointers. The compar function takes two  elements and returns 0 when they are
 692  *  considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
 693  *  afterwards.
 694  */
 695 extern "C" int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*))
 696 {
 697   int i ;
 698   int size;
 699   if((!d1) && (!d2)) return 0;
 700   if((!d1) || (!d2))
 701   {
 702     XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
 703     xbt_dynar_free(&d2);
 704     return 1;
 705   }
 706   if((d1->elmsize)!=(d2->elmsize)) {
 707     XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
 708     xbt_dynar_free(&d2);
 709     return 1; // xbt_die
 710   }
 711   if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
 712     XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
 713     xbt_dynar_free(&d2);
 714     return 1;
 715   }
 716
 717   size = xbt_dynar_length(d1);
 718   for(i=0;i<size;i++) {
 719     void *data1 = xbt_dynar_get_as(d1, i, void *);
 720     void *data2 = xbt_dynar_get_as(d2, i, void *);
 721     XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
 722     if(compar(data1,data2)){
 723       xbt_dynar_free(&d2);
 724       return 1;
 725     }
 726   }
 727   xbt_dynar_free(&d2);
 728   return 0;
 729 }
 730
 731 #ifdef SIMGRID_TEST
 732
 733 #define NB_ELEM 5000
 734
 735 XBT_TEST_SUITE("dynar", "Dynar data container");
 736 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
 737
 738 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 739 {
 740   /* Vars_decl [doxygen cruft] */
 741   int i;
 742   unsigned int cursor;
 743   int *iptr;
 744
 745   xbt_test_add("==== Traverse the empty dynar");
 746   xbt_dynar_t d = xbt_dynar_new(sizeof(int), nullptr);
 747   xbt_dynar_foreach(d, cursor, i) {
 748     xbt_die( "Damnit, there is something in the empty dynar");
 749   }
 750   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 751   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 752   /* in your code is naturally the way to go outside a regression test */
 753
 754   xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
 755   /* Populate_ints [doxygen cruft] */
 756   /* 1. Populate the dynar */
 757   d = xbt_dynar_new(sizeof(int), nullptr);
 758   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 759     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
 760     /* xbt_dynar_push(d,&cpt);       This would also work */
 761     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 762   }
 763
 764   /* 2. Traverse manually the dynar */
 765   for (cursor = 0; cursor < NB_ELEM; cursor++) {
 766     iptr = (int*) xbt_dynar_get_ptr(d, cursor);
 767     xbt_test_assert(cursor == (unsigned int)*iptr, "The retrieved value is not the same than the injected one (%u!=%d)",
 768                     cursor, *iptr);
 769   }
 770
 771   /* 3. Traverse the dynar using the neat macro to that extend */
 772   int cpt;
 773   xbt_dynar_foreach(d, cursor, cpt) {
 774     xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
 775   }
 776   /* end_of_traversal */
 777
 778   for (int cpt = 0; cpt < NB_ELEM; cpt++)
 779     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 780
 781   for (int cpt = 0; cpt < NB_ELEM; cpt++)
 782     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 783   /*     xbt_dynar_set(d,cpt,&cpt); */
 784
 785   for (int cpt = 0; cpt < NB_ELEM; cpt++)
 786     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 787
 788   cpt = 0;
 789   xbt_dynar_foreach(d, cursor, i) {
 790     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
 791     cpt++;
 792   }
 793   xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
 794
 795   /* shifting [doxygen cruft] */
 796   /* 4. Shift all the values */
 797   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 798     xbt_dynar_shift(d, &i);
 799     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
 800     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 801   }
 802
 803   int* pi;
 804   xbt_dynar_foreach_ptr(d, cursor, pi) {
 805     *pi = 0;
 806   }
 807   xbt_dynar_foreach(d, cursor, i) {
 808     xbt_test_assert(i == 0, "The value is not the same as the expected one.");
 809   }
 810   xbt_dynar_foreach_ptr(d, cursor, pi) {
 811     *pi = 1;
 812   }
 813   xbt_dynar_foreach(d, cursor, i) {
 814     xbt_test_assert(i == 1, "The value is not the same as the expected one.");
 815   }
 816
 817   /* 5. Free the resources */
 818   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 819   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 820   /* in your code is naturally the way to go outside a regression test */
 821
 822   xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
 823   d = xbt_dynar_new(sizeof(int), nullptr);
 824   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 825     xbt_dynar_unshift(d, &cpt);
 826     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 827   }
 828   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 829     i = xbt_dynar_pop_as(d, int);
 830     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
 831     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 832   }
 833   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 834   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 835   /* in your code is naturally the way to go outside a regression test */
 836
 837   xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
 838   d = xbt_dynar_new(sizeof(int), nullptr);
 839   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 840     xbt_dynar_push_as(d, int, cpt);
 841     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 842   }
 843   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
 844     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
 845     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 846   }
 847
 848   for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
 849     xbt_dynar_shift(d, &i);
 850     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 851                      i, cpt);
 852     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 853   }
 854   for (cpt = 999; cpt >= 0; cpt--) {
 855     xbt_dynar_shift(d, &i);
 856     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 857                      i, cpt);
 858   }
 859   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
 860     xbt_dynar_shift(d, &i);
 861     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
 862   }
 863   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 864   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 865   /* in your code is naturally the way to go outside a regression test */
 866
 867   xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
 868   d = xbt_dynar_new(sizeof(int), nullptr);
 869   for (cpt = 0; cpt < NB_ELEM; cpt++)
 870     xbt_dynar_push_as(d, int, cpt);
 871
 872   for (cpt = 2000; cpt < 4000; cpt++) {
 873     xbt_dynar_remove_at(d, 2000, &i);
 874     xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
 875     XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
 876   }
 877   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 878   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 879   /* in your code is naturally the way to go outside a regression test */
 880 }
 881
 882 /*******************************************************************************/
 883 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
 884 {
 885   xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), nullptr);
 886   unsigned int cursor;
 887
 888   xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
 889   /* Populate_ints [doxygen cruft] */
 890   /* 1. Populate the dynar */
 891   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 892     xbt_dynar_insert_at(d, cpt, &cpt);
 893     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 894   }
 895
 896   /* 3. Traverse the dynar */
 897   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   /* end_of_traversal */
 902
 903   /* Re-fill with the same values using set_as (and re-verify) */
 904   for (int cpt = 0; cpt < NB_ELEM; cpt++)
 905     xbt_dynar_set_as(d, cpt, int, cpt);
 906   xbt_dynar_foreach(d, cursor, cpt)
 907     xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
 908
 909   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
 910     int val;
 911     xbt_dynar_remove_at(d,0,&val);
 912     xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
 913   }
 914   xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
 915                    xbt_dynar_length(d));
 916   xbt_dynar_free(&d);
 917
 918   /* ********************* */
 919   xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
 920   d = xbt_dynar_new(sizeof(int), nullptr);
 921   for (int cpt = NB_ELEM - 1; cpt >= 0; cpt--) {
 922     xbt_dynar_replace(d, cpt, &cpt);
 923     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 924   }
 925
 926   /* 3. Traverse the dynar */
 927   xbt_dynar_foreach(d, cursor, cpt) {
 928     xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
 929   }
 930   /* end_of_traversal */
 931
 932   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
 933     int val;
 934     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
 935     xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
 936   }
 937   xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
 938                    xbt_dynar_length(d));
 939   xbt_dynar_free(&d);
 940 }
 941
 942 /*******************************************************************************/
 943 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
 944 {
 945   xbt_dynar_t d;
 946   int cpt;
 947   unsigned int cursor;
 948   double d1, d2;
 949
 950   xbt_test_add("==== Traverse the empty dynar");
 951   d = xbt_dynar_new(sizeof(int), nullptr);
 952   xbt_dynar_foreach(d, cursor, cpt) {
 953     xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
 954   }
 955   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 956   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 957   /* in your code is naturally the way to go outside a regression test */
 958
 959   xbt_test_add("==== Push/shift 5000 doubles");
 960   d = xbt_dynar_new(sizeof(double), nullptr);
 961   for (cpt = 0; cpt < 5000; cpt++) {
 962     d1 = (double) cpt;
 963     xbt_dynar_push(d, &d1);
 964   }
 965   xbt_dynar_foreach(d, cursor, d2) {
 966     d1 = (double) cursor;
 967     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
 968   }
 969   for (cpt = 0; cpt < 5000; cpt++) {
 970     d1 = (double) cpt;
 971     xbt_dynar_shift(d, &d2);
 972     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
 973   }
 974   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 975   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 976   /* in your code is naturally the way to go outside a regression test */
 977
 978   xbt_test_add("==== Unshift/pop 5000 doubles");
 979   d = xbt_dynar_new(sizeof(double), nullptr);
 980   for (cpt = 0; cpt < 5000; cpt++) {
 981     d1 = (double) cpt;
 982     xbt_dynar_unshift(d, &d1);
 983   }
 984   for (cpt = 0; cpt < 5000; cpt++) {
 985     d1 = (double) cpt;
 986     xbt_dynar_pop(d, &d2);
 987     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
 988   }
 989   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 990   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 991   /* in your code is naturally the way to go outside a regression test */
 992
 993   xbt_test_add("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
 994   d = xbt_dynar_new(sizeof(double), nullptr);
 995   for (cpt = 0; cpt < 5000; cpt++) {
 996     d1 = (double) cpt;
 997     xbt_dynar_push(d, &d1);
 998   }
 999   for (cpt = 0; cpt < 1000; cpt++) {
1000     d1 = (double) cpt;
1001     xbt_dynar_insert_at(d, 2500, &d1);
1002   }
1003
1004   for (cpt = 0; cpt < 2500; cpt++) {
1005     d1 = (double) cpt;
1006     xbt_dynar_shift(d, &d2);
1007     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1008                      d1, d2);
1009     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1010   }
1011   for (cpt = 999; cpt >= 0; cpt--) {
1012     d1 = (double) cpt;
1013     xbt_dynar_shift(d, &d2);
1014     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1015                      d1, d2);
1016   }
1017   for (cpt = 2500; cpt < 5000; cpt++) {
1018     d1 = (double) cpt;
1019     xbt_dynar_shift(d, &d2);
1020     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1021   }
1022   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1023   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1024   /* in your code is naturally the way to go outside a regression test */
1025
1026   xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1027   d = xbt_dynar_new(sizeof(double), nullptr);
1028   for (cpt = 0; cpt < 5000; cpt++) {
1029     d1 = (double) cpt;
1030     xbt_dynar_push(d, &d1);
1031   }
1032   for (cpt = 2000; cpt < 4000; cpt++) {
1033     d1 = (double) cpt;
1034     xbt_dynar_remove_at(d, 2000, &d2);
1035     xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1036   }
1037   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1038   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1039   /* in your code is naturally the way to go outside a regression test */
1040 }
1041
1042 /* doxygen_string_cruft */
1043
1044 /*******************************************************************************/
1045 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1046 {
1047   unsigned int iter;
1048   char buf[1024];
1049   char *s1, *s2;
1050
1051   xbt_test_add("==== Traverse the empty dynar");
1052   xbt_dynar_t d = xbt_dynar_new(sizeof(char*), &xbt_free_ref);
1053   xbt_dynar_foreach(d, iter, s1) {
1054     xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
1055   }
1056   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1057   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1058   /* in your code is naturally the way to go outside a regression test */
1059
1060   xbt_test_add("==== Push %d strings, set them again 3 times, shift them", NB_ELEM);
1061   /* Populate_str [doxygen cruft] */
1062   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1063   /* 1. Populate the dynar */
1064   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1065     snprintf(buf,1023, "%d", cpt);
1066     s1 = xbt_strdup(buf);
1067     xbt_dynar_push(d, &s1);
1068   }
1069   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1070     snprintf(buf,1023, "%d", cpt);
1071     s1 = xbt_strdup(buf);
1072     xbt_dynar_replace(d, cpt, &s1);
1073   }
1074   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1075     snprintf(buf,1023, "%d", cpt);
1076     s1 = xbt_strdup(buf);
1077     xbt_dynar_replace(d, cpt, &s1);
1078   }
1079   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1080     snprintf(buf,1023, "%d", cpt);
1081     s1 = xbt_strdup(buf);
1082     xbt_dynar_replace(d, cpt, &s1);
1083   }
1084   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1085     snprintf(buf,1023, "%d", cpt);
1086     xbt_dynar_shift(d, &s2);
1087     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1088     free(s2);
1089   }
1090   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1091   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1092   /* in your code is naturally the way to go outside a regression test */
1093
1094   xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1095   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1096   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1097     snprintf(buf,1023, "%d", cpt);
1098     s1 = xbt_strdup(buf);
1099     xbt_dynar_unshift(d, &s1);
1100   }
1101   /* 2. Traverse the dynar with the macro */
1102   xbt_dynar_foreach(d, iter, s1) {
1103     snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1104     xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1105   }
1106   /* 3. Traverse the dynar with the macro */
1107   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1108     snprintf(buf,1023, "%d", cpt);
1109     xbt_dynar_pop(d, &s2);
1110     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1111     free(s2);
1112   }
1113   /* 4. Free the resources */
1114   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1115   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1116   /* in your code is naturally the way to go outside a regression test */
1117
1118   xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1119   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1120   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1121     snprintf(buf,1023, "%d", cpt);
1122     s1 = xbt_strdup(buf);
1123     xbt_dynar_push(d, &s1);
1124   }
1125   for (int cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1126     snprintf(buf,1023, "%d", cpt);
1127     s1 = xbt_strdup(buf);
1128     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1129   }
1130
1131   for (int cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1132     snprintf(buf,1023, "%d", cpt);
1133     xbt_dynar_shift(d, &s2);
1134     xbt_test_assert(!strcmp(buf, s2),
1135                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1136     free(s2);
1137   }
1138   for (int cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1139     snprintf(buf,1023, "%d", cpt);
1140     xbt_dynar_shift(d, &s2);
1141     xbt_test_assert(!strcmp(buf, s2),
1142                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1143     free(s2);
1144   }
1145   for (int cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1146     snprintf(buf,1023, "%d", cpt);
1147     xbt_dynar_shift(d, &s2);
1148     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1149                      buf, s2);
1150     free(s2);
1151   }
1152   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1153   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1154   /* in your code is naturally the way to go outside a regression test */
1155
1156   xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1157   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1158   for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1159     snprintf(buf,1023, "%d", cpt);
1160     s1 = xbt_strdup(buf);
1161     xbt_dynar_push(d, &s1);
1162   }
1163   for (int cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1164     snprintf(buf,1023, "%d", cpt);
1165     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1166     xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1167     free(s2);
1168   }
1169   xbt_dynar_free(&d);           /* end_of_doxygen */
1170 }
1171 #endif                          /* SIMGRID_TEST */