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