src/xbt/dynar.c

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