src/xbt/dynar.c

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