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_assert(dynar, "dynar is NULL");
  39 }
  40
  41 static XBT_INLINE void _sanity_check_idx(int idx)
  42 {
  43   xbt_assert(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     THROWF(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     THROWF(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     THROWF(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     XBT_DEBUG("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   XBT_INFO("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   XBT_DEBUG("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_t dynar = (xbt_dynar_t)d;
 331   xbt_dynar_free(&dynar);
 332 }
 333
 334 /** @brief Count of dynar's elements
 335  *
 336  * \param dynar the dynar we want to mesure
 337  */
 338 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
 339 {
 340   return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
 341 }
 342
 343 /**@brief check if a dynar is empty
 344  *
 345  *\param dynar the dynat we want to check
 346  */
 347
 348 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
 349 {
 350   return (xbt_dynar_length(dynar) == 0);
 351 }
 352
 353 /** @brief Retrieve a copy of the Nth element of a dynar.
 354  *
 355  * \param dynar information dealer
 356  * \param idx index of the slot we want to retrieve
 357  * \param[out] dst where to put the result to.
 358  */
 359 XBT_INLINE void
 360 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
 361                   const unsigned long idx, void *const dst)
 362 {
 363   _dynar_lock(dynar);
 364   _sanity_check_dynar(dynar);
 365   _check_inbound_idx(dynar, idx);
 366
 367   _xbt_dynar_get_elm(dst, dynar, idx);
 368   _dynar_unlock(dynar);
 369 }
 370
 371 /** @brief Retrieve a pointer to the Nth element of a dynar.
 372  *
 373  * \param dynar information dealer
 374  * \param idx index of the slot we want to retrieve
 375  * \return the \a idx-th element of \a dynar.
 376  *
 377  * \warning The returned value is the actual content of the dynar.
 378  * Make a copy before fooling with it.
 379  */
 380 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
 381                                    const unsigned long idx)
 382 {
 383
 384   void *res;
 385   _dynar_lock(dynar);
 386   _sanity_check_dynar(dynar);
 387   _check_inbound_idx(dynar, idx);
 388
 389   res = _xbt_dynar_elm(dynar, idx);
 390   _dynar_unlock(dynar);
 391   return res;
 392 }
 393
 394 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
 395                                       const unsigned long idx)
 396 {
 397
 398   void *res;
 399   _dynar_lock(dynar);
 400   _sanity_check_dynar(dynar);
 401
 402   _xbt_dynar_expand(dynar, idx + 1);
 403
 404   if (idx >= dynar->used) {
 405     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
 406                    (idx + 1 - dynar->used)*dynar->elmsize);
 407     dynar->used = idx + 1;
 408   }
 409
 410   _dynar_unlock(dynar);
 411
 412   res = _xbt_dynar_elm(dynar, idx);
 413
 414   return res;
 415 }
 416
 417 static void XBT_INLINE          /* not synchronized */
 418 _xbt_dynar_set(xbt_dynar_t dynar,
 419                const unsigned long idx, const void *const src)
 420 {
 421
 422   _sanity_check_dynar(dynar);
 423
 424   _xbt_dynar_expand(dynar, idx + 1);
 425
 426   if (idx >= dynar->used) {
 427     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
 428                    (idx + 1 - dynar->used)*dynar->elmsize);
 429     dynar->used = idx + 1;
 430   }
 431
 432   _xbt_dynar_put_elm(dynar, idx, src);
 433 }
 434
 435 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
 436  *
 437  * \param dynar information dealer
 438  * \param idx index of the slot we want to modify
 439  * \param src What will be feeded to the dynar
 440  *
 441  * If you want to free the previous content, use xbt_dynar_replace().
 442  */
 443 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
 444                               const void *const src)
 445 {
 446
 447   _dynar_lock(dynar);
 448   _xbt_dynar_set(dynar, idx, src);
 449   _dynar_unlock(dynar);
 450 }
 451
 452 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
 453  *
 454  * \param dynar
 455  * \param idx
 456  * \param object
 457  *
 458  * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
 459  * free the previous value at this position. If you don't want to free the
 460  * previous content, use xbt_dynar_set().
 461  */
 462 void
 463 xbt_dynar_replace(xbt_dynar_t dynar,
 464                   const unsigned long idx, const void *const object)
 465 {
 466   _dynar_lock(dynar);
 467   _sanity_check_dynar(dynar);
 468
 469   if (idx < dynar->used && dynar->free_f) {
 470     void *const old_object = _xbt_dynar_elm(dynar, idx);
 471
 472     (*(dynar->free_f)) (old_object);
 473   }
 474
 475   _xbt_dynar_set(dynar, idx, object);
 476   _dynar_unlock(dynar);
 477 }
 478
 479 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 480                                                  const unsigned long idx)
 481 {
 482   void *res;
 483   unsigned long old_used;
 484   unsigned long new_used;
 485   long nb_shift;
 486
 487   _sanity_check_dynar(dynar);
 488   _sanity_check_idx(idx);
 489
 490   old_used = dynar->used;
 491   new_used = old_used + 1;
 492
 493   _xbt_dynar_expand(dynar, new_used);
 494
 495   nb_shift = old_used - idx;
 496
 497   if (nb_shift>0) {
 498     memmove(_xbt_dynar_elm(dynar, idx + 1),
 499             _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
 500   }
 501
 502   dynar->used = new_used;
 503   res = _xbt_dynar_elm(dynar, idx);
 504   return res;
 505 }
 506
 507 /** @brief Make room for a new element, and return a pointer to it
 508  *
 509  * You can then use regular affectation to set its value instead of relying
 510  * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
 511  */
 512 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
 513 {
 514   void *res;
 515
 516   _dynar_lock(dynar);
 517   res = _xbt_dynar_insert_at_ptr(dynar, idx);
 518   _dynar_unlock(dynar);
 519   return res;
 520 }
 521
 522 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
 523  *
 524  * Set the Nth element of a dynar, expanding the dynar if needed, and
 525  * moving the previously existing value and all subsequent ones to one
 526  * position right in the dynar.
 527  */
 528 XBT_INLINE void
 529 xbt_dynar_insert_at(xbt_dynar_t const dynar,
 530                     const int idx, const void *const src)
 531 {
 532
 533   _dynar_lock(dynar);
 534   /* checks done in xbt_dynar_insert_at_ptr */
 535   memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
 536   _dynar_unlock(dynar);
 537 }
 538
 539 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
 540  *
 541  * Get the Nth element of a dynar, removing it from the dynar and moving
 542  * all subsequent values to one position left in the dynar.
 543  *
 544  * If the object argument of this function is a non-null pointer, the removed
 545  * element is copied to this address. If not, the element is freed using the
 546  * free_f function passed at dynar creation.
 547  */
 548 void
 549 xbt_dynar_remove_at(xbt_dynar_t const dynar,
 550                     const int idx, void *const object)
 551 {
 552
 553   _dynar_lock(dynar);
 554   _xbt_dynar_remove_at(dynar, idx, object);
 555   _dynar_unlock(dynar);
 556 }
 557
 558 /** @brief Returns the position of the element in the dynar
 559  *
 560  * Raises not_found_error if not found.
 561  */
 562 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
 563 {
 564   unsigned long it;
 565
 566   _dynar_lock(dynar);
 567   for (it = 0; it < dynar->used; it++)
 568     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
 569       _dynar_unlock(dynar);
 570       return it;
 571     }
 572
 573   _dynar_unlock(dynar);
 574   THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
 575          dynar);
 576 }
 577
 578 /** @brief Returns a boolean indicating whether the element is part of the dynar */
 579 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
 580 {
 581
 582   xbt_ex_t e;
 583
 584   TRY {
 585     xbt_dynar_search(dynar, elem);
 586   } CATCH(e) {
 587     if (e.category == not_found_error) {
 588       xbt_ex_free(e);
 589       return 0;
 590     }
 591     RETHROW;
 592   }
 593   return 1;
 594 }
 595
 596 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
 597  *
 598  * You can then use regular affectation to set its value instead of relying
 599  * on the slow memcpy. This is what xbt_dynar_push_as() does.
 600  */
 601 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
 602 {
 603   void *res;
 604
 605   /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
 606      dynar->used don't change between reading it and getting the lock
 607      within xbt_dynar_insert_at_ptr */
 608   _dynar_lock(dynar);
 609   res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
 610   _dynar_unlock(dynar);
 611   return res;
 612 }
 613
 614 /** @brief Add an element at the end of the dynar */
 615 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
 616                                const void *const src)
 617 {
 618   _dynar_lock(dynar);
 619   /* checks done in xbt_dynar_insert_at_ptr */
 620   memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
 621          dynar->elmsize);
 622   _dynar_unlock(dynar);
 623 }
 624
 625 /** @brief Mark the last dynar's element as unused and return a pointer to it.
 626  *
 627  * You can then use regular affectation to set its value instead of relying
 628  * on the slow memcpy. This is what xbt_dynar_pop_as() does.
 629  */
 630 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
 631 {
 632   void *res;
 633
 634   _dynar_lock(dynar);
 635   _check_populated_dynar(dynar);
 636   XBT_DEBUG("Pop %p", (void *) dynar);
 637   dynar->used--;
 638   res = _xbt_dynar_elm(dynar, dynar->used);
 639   _dynar_unlock(dynar);
 640   return res;
 641 }
 642
 643 /** @brief Get and remove the last element of the dynar */
 644 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
 645 {
 646
 647   /* sanity checks done by remove_at */
 648   XBT_DEBUG("Pop %p", (void *) dynar);
 649   _dynar_lock(dynar);
 650   _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
 651   _dynar_unlock(dynar);
 652 }
 653
 654 /** @brief Add an element at the begining of the dynar.
 655  *
 656  * This is less efficient than xbt_dynar_push()
 657  */
 658 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
 659                                   const void *const src)
 660 {
 661
 662   /* sanity checks done by insert_at */
 663   xbt_dynar_insert_at(dynar, 0, src);
 664 }
 665
 666 /** @brief Get and remove the first element of the dynar.
 667  *
 668  * This is less efficient than xbt_dynar_pop()
 669  */
 670 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
 671 {
 672
 673   /* sanity checks done by remove_at */
 674   xbt_dynar_remove_at(dynar, 0, dst);
 675 }
 676
 677 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
 678 {
 679   char *const data = (char *) dynar->data;
 680   const unsigned long elmsize = dynar->elmsize;
 681   const unsigned long used = dynar->used;
 682   unsigned long i;
 683
 684   for (i = 0; i < used; i++) {
 685     char* elm = (char*) data + i * elmsize;
 686     (*op) (elm);
 687   }
 688 }
 689
 690 /** @brief Apply a function to each member of a dynar
 691  *
 692  * The mapped function may change the value of the element itself,
 693  * but should not mess with the structure of the dynar.
 694  *
 695  * If the dynar is synchronized, it is locked during the whole map
 696  * operation, so make sure your function don't call any function
 697  * from xbt_dynar_* on it, or you'll get a deadlock.
 698  */
 699 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
 700                               void_f_pvoid_t const op)
 701 {
 702
 703   _sanity_check_dynar(dynar);
 704   _dynar_lock(dynar);
 705
 706   _dynar_map(dynar, op);
 707
 708   _dynar_unlock(dynar);
 709 }
 710
 711
 712 /** @brief Removes and free the entry pointed by the cursor
 713  *
 714  * This function can be used while traversing without problem.
 715  */
 716 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 717                                     unsigned int *const cursor)
 718 {
 719
 720   _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
 721 }
 722
 723 /** @brief Unlocks a synchronized dynar when you want to break the traversal
 724  *
 725  * This function must be used if you <tt>break</tt> the
 726  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
 727  * regular traversal reaching the end of the elements
 728  */
 729 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
 730 {
 731   _dynar_unlock(dynar);
 732 }
 733
 734 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
 735  *
 736  * \param dynar the dynar to sort
 737  * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
 738  *
 739  * Remark: if the elements stored in the dynar are structures, the compar_fn
 740  * function has to retrieve the field to sort first.
 741  */
 742 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
 743                                int_f_cpvoid_cpvoid_t compar_fn)
 744 {
 745
 746   _dynar_lock(dynar);
 747
 748 #ifdef HAVE_MERGESORT
 749   mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 750 #else
 751   qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 752 #endif
 753   _dynar_unlock(dynar);
 754 }
 755
 756 /** @brief Transform a dynar into a NULL terminated array
 757  *
 758  * \param dynar the dynar to transform
 759  */
 760 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
 761 {
 762   void * res;
 763         void * last = xbt_new0(char,dynar->elmsize);
 764         xbt_dynar_push(dynar, last);
 765         free(last);
 766         res = dynar->data;
 767         free(dynar);
 768         return res;
 769 }
 770
 771 /*
 772  * Return 0 if d1 and d2 are equal and 1 if not equal
 773  */
 774 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
 775                                         int(*compar)(const void *, const void *))
 776 {
 777         int i ;
 778         int size;
 779         if((!d1) && (!d2)) return 0;
 780         if((!d1) || (!d2))
 781         {
 782                 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
 783                 xbt_dynar_free(&d2);
 784                 return 1;
 785         }
 786         if((d1->elmsize)!=(d2->elmsize))
 787         {
 788                 XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
 789                 xbt_dynar_free(&d2);
 790                 return 1; // xbt_die
 791         }
 792         if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
 793         {
 794                 XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
 795                 xbt_dynar_free(&d2);
 796                 return 1;
 797         }
 798
 799         size = xbt_dynar_length(d1);
 800         for(i=0;i<size;i++)
 801         {
 802                 void *data1 = xbt_dynar_get_as(d1, i, void *);
 803                 void *data2 = xbt_dynar_get_as(d2, i, void *);
 804                 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
 805                 if(compar(data1,data2)){
 806                         xbt_dynar_free(&d2);
 807                         return 1;
 808                 }
 809         }
 810         xbt_dynar_free(&d2);
 811         return 0;
 812 }
 813
 814 #ifdef SIMGRID_TEST
 815
 816 #define NB_ELEM 5000
 817
 818 XBT_TEST_SUITE("dynar", "Dynar data container");
 819 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 820 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 821
 822 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 823 {
 824   /* Vars_decl [doxygen cruft] */
 825   xbt_dynar_t d;
 826   int i, cpt;
 827   unsigned int cursor;
 828   int *iptr;
 829
 830   xbt_test_add("==== Traverse the empty dynar");
 831   d = xbt_dynar_new(sizeof(int), NULL);
 832   xbt_dynar_foreach(d, cursor, i) {
 833     xbt_die( "Damnit, there is something in the empty dynar");
 834   }
 835   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 836   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 837   /* in your code is naturally the way to go outside a regression test */
 838
 839   xbt_test_add
 840       ("==== Push %d int, set them again 3 times, traverse them, shift them",
 841        NB_ELEM);
 842   /* Populate_ints [doxygen cruft] */
 843   /* 1. Populate the dynar */
 844   d = xbt_dynar_new(sizeof(int), NULL);
 845   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 846     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
 847     /* xbt_dynar_push(d,&cpt);       This would also work */
 848     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 849   }
 850
 851   /* 2. Traverse manually the dynar */
 852   for (cursor = 0; cursor < NB_ELEM; cursor++) {
 853     iptr = xbt_dynar_get_ptr(d, cursor);
 854     xbt_test_assert(cursor == *iptr,
 855                      "The retrieved value is not the same than the injected one (%d!=%d)",
 856                      cursor, cpt);
 857   }
 858
 859   /* 3. Traverse the dynar using the neat macro to that extend */
 860   xbt_dynar_foreach(d, cursor, cpt) {
 861     xbt_test_assert(cursor == cpt,
 862                      "The retrieved value is not the same than the injected one (%d!=%d)",
 863                      cursor, cpt);
 864   }
 865   /* end_of_traversal */
 866
 867   for (cpt = 0; cpt < NB_ELEM; cpt++)
 868     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 869
 870   for (cpt = 0; cpt < NB_ELEM; cpt++)
 871     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 872   /*     xbt_dynar_set(d,cpt,&cpt); */
 873
 874   for (cpt = 0; cpt < NB_ELEM; cpt++)
 875     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 876
 877   cpt = 0;
 878   xbt_dynar_foreach(d, cursor, i) {
 879     xbt_test_assert(i == cpt,
 880                      "The retrieved value is not the same than the injected one (%d!=%d)",
 881                      i, cpt);
 882     cpt++;
 883   }
 884   xbt_test_assert(cpt == NB_ELEM,
 885                    "Cannot retrieve my %d values. Last got one is %d",
 886                    NB_ELEM, cpt);
 887
 888   /* shifting [doxygen cruft] */
 889   /* 4. Shift all the values */
 890   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 891     xbt_dynar_shift(d, &i);
 892     xbt_test_assert(i == cpt,
 893                      "The retrieved value is not the same than the injected one (%d!=%d)",
 894                      i, cpt);
 895     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 896   }
 897
 898   /* 5. Free the resources */
 899   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 900   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 901   /* in your code is naturally the way to go outside a regression test */
 902
 903   xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
 904   d = xbt_dynar_new(sizeof(int), NULL);
 905   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 906     xbt_dynar_unshift(d, &cpt);
 907     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 908   }
 909   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 910     i = xbt_dynar_pop_as(d, int);
 911     xbt_test_assert(i == cpt,
 912                      "The retrieved value is not the same than the injected one (%d!=%d)",
 913                      i, cpt);
 914     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 915   }
 916   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 917   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 918   /* in your code is naturally the way to go outside a regression test */
 919
 920
 921   xbt_test_add
 922       ("==== Push %d int, insert 1000 int in the middle, shift everything",
 923        NB_ELEM);
 924   d = xbt_dynar_new(sizeof(int), NULL);
 925   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 926     xbt_dynar_push_as(d, int, cpt);
 927     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 928   }
 929   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
 930     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
 931     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 932   }
 933
 934   for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
 935     xbt_dynar_shift(d, &i);
 936     xbt_test_assert(i == cpt,
 937                      "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 938                      i, cpt);
 939     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 940   }
 941   for (cpt = 999; cpt >= 0; cpt--) {
 942     xbt_dynar_shift(d, &i);
 943     xbt_test_assert(i == cpt,
 944                      "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 945                      i, cpt);
 946   }
 947   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
 948     xbt_dynar_shift(d, &i);
 949     xbt_test_assert(i == cpt,
 950                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 951                      i, cpt);
 952   }
 953   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 954   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 955   /* in your code is naturally the way to go outside a regression test */
 956
 957   xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
 958                 NB_ELEM);
 959   d = xbt_dynar_new(sizeof(int), NULL);
 960   for (cpt = 0; cpt < NB_ELEM; cpt++)
 961     xbt_dynar_push_as(d, int, cpt);
 962
 963   for (cpt = 2000; cpt < 4000; cpt++) {
 964     xbt_dynar_remove_at(d, 2000, &i);
 965     xbt_test_assert(i == cpt,
 966                      "Remove a bad value. Got %d, expected %d", i, cpt);
 967     XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
 968   }
 969   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 970   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 971   /* in your code is naturally the way to go outside a regression test */
 972 }
 973
 974 /*******************************************************************************/
 975 /*******************************************************************************/
 976 /*******************************************************************************/
 977 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
 978 {
 979   xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
 980   unsigned int cursor;
 981   int cpt;
 982
 983   xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
 984   /* Populate_ints [doxygen cruft] */
 985   /* 1. Populate the dynar */
 986   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 987     xbt_dynar_insert_at(d, cpt, &cpt);
 988     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 989   }
 990
 991   /* 3. Traverse the dynar */
 992   xbt_dynar_foreach(d, cursor, cpt) {
 993     xbt_test_assert(cursor == cpt,
 994                      "The retrieved value is not the same than the injected one (%d!=%d)",
 995                      cursor, cpt);
 996   }
 997   /* end_of_traversal */
 998
 999   /* Re-fill with the same values using set_as (and re-verify) */
1000   for (cpt = 0; cpt < NB_ELEM; cpt++)
1001     xbt_dynar_set_as(d, cpt, int, cpt);
1002   xbt_dynar_foreach(d, cursor, cpt)
1003     xbt_test_assert(cursor == cpt,
1004                      "The retrieved value is not the same than the injected one (%d!=%d)",
1005                      cursor, cpt);
1006
1007   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1008     int val;
1009     xbt_dynar_remove_at(d,0,&val);
1010     xbt_test_assert(cpt == val,
1011                      "The retrieved value is not the same than the injected one (%d!=%d)",
1012                      cursor, cpt);
1013   }
1014   xbt_test_assert(xbt_dynar_length(d) == 0,
1015                    "There is still %lu elements in the dynar after removing everything",
1016                    xbt_dynar_length(d));
1017   xbt_dynar_free(&d);
1018
1019   /* ********************* */
1020   xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1021   d = xbt_dynar_new(sizeof(int), NULL);
1022   for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1023     xbt_dynar_replace(d, cpt, &cpt);
1024     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1025   }
1026
1027   /* 3. Traverse the dynar */
1028   xbt_dynar_foreach(d, cursor, cpt) {
1029     xbt_test_assert(cursor == cpt,
1030                      "The retrieved value is not the same than the injected one (%d!=%d)",
1031                      cursor, cpt);
1032   }
1033   /* end_of_traversal */
1034
1035   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1036     int val;
1037     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1038     xbt_test_assert(cpt == val,
1039                      "The retrieved value is not the same than the injected one (%d!=%d)",
1040                      cursor, cpt);
1041   }
1042   xbt_test_assert(xbt_dynar_length(d) == 0,
1043                    "There is still %lu elements in the dynar after removing everything",
1044                    xbt_dynar_length(d));
1045   xbt_dynar_free(&d);
1046 }
1047
1048 /*******************************************************************************/
1049 /*******************************************************************************/
1050 /*******************************************************************************/
1051 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1052 {
1053   xbt_dynar_t d;
1054   int cpt;
1055   unsigned int cursor;
1056   double d1, d2;
1057
1058   xbt_test_add("==== Traverse the empty dynar");
1059   d = xbt_dynar_new(sizeof(int), NULL);
1060   xbt_dynar_foreach(d, cursor, cpt) {
1061     xbt_test_assert(FALSE,
1062                      "Damnit, there is something in the empty dynar");
1063   }
1064   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1065   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1066   /* in your code is naturally the way to go outside a regression test */
1067
1068   xbt_test_add("==== Push/shift 5000 doubles");
1069   d = xbt_dynar_new(sizeof(double), NULL);
1070   for (cpt = 0; cpt < 5000; cpt++) {
1071     d1 = (double) cpt;
1072     xbt_dynar_push(d, &d1);
1073   }
1074   xbt_dynar_foreach(d, cursor, d2) {
1075     d1 = (double) cursor;
1076     xbt_test_assert(d1 == d2,
1077                      "The retrieved value is not the same than the injected one (%f!=%f)",
1078                      d1, d2);
1079   }
1080   for (cpt = 0; cpt < 5000; cpt++) {
1081     d1 = (double) cpt;
1082     xbt_dynar_shift(d, &d2);
1083     xbt_test_assert(d1 == d2,
1084                      "The retrieved value is not the same than the injected one (%f!=%f)",
1085                      d1, d2);
1086   }
1087   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1088   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1089   /* in your code is naturally the way to go outside a regression test */
1090
1091   xbt_test_add("==== Unshift/pop 5000 doubles");
1092   d = xbt_dynar_new(sizeof(double), NULL);
1093   for (cpt = 0; cpt < 5000; cpt++) {
1094     d1 = (double) cpt;
1095     xbt_dynar_unshift(d, &d1);
1096   }
1097   for (cpt = 0; cpt < 5000; cpt++) {
1098     d1 = (double) cpt;
1099     xbt_dynar_pop(d, &d2);
1100     xbt_test_assert(d1 == d2,
1101                      "The retrieved value is not the same than the injected one (%f!=%f)",
1102                      d1, d2);
1103   }
1104   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1105   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1106   /* in your code is naturally the way to go outside a regression test */
1107
1108
1109
1110   xbt_test_add
1111       ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1112   d = xbt_dynar_new(sizeof(double), NULL);
1113   for (cpt = 0; cpt < 5000; cpt++) {
1114     d1 = (double) cpt;
1115     xbt_dynar_push(d, &d1);
1116   }
1117   for (cpt = 0; cpt < 1000; cpt++) {
1118     d1 = (double) cpt;
1119     xbt_dynar_insert_at(d, 2500, &d1);
1120   }
1121
1122   for (cpt = 0; cpt < 2500; cpt++) {
1123     d1 = (double) cpt;
1124     xbt_dynar_shift(d, &d2);
1125     xbt_test_assert(d1 == d2,
1126                      "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1127                      d1, d2);
1128     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1129   }
1130   for (cpt = 999; cpt >= 0; cpt--) {
1131     d1 = (double) cpt;
1132     xbt_dynar_shift(d, &d2);
1133     xbt_test_assert(d1 == d2,
1134                      "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1135                      d1, d2);
1136   }
1137   for (cpt = 2500; cpt < 5000; cpt++) {
1138     d1 = (double) cpt;
1139     xbt_dynar_shift(d, &d2);
1140     xbt_test_assert(d1 == d2,
1141                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1142                      d1, d2);
1143   }
1144   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1145   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1146   /* in your code is naturally the way to go outside a regression test */
1147
1148
1149   xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1150   d = xbt_dynar_new(sizeof(double), NULL);
1151   for (cpt = 0; cpt < 5000; cpt++) {
1152     d1 = (double) cpt;
1153     xbt_dynar_push(d, &d1);
1154   }
1155   for (cpt = 2000; cpt < 4000; cpt++) {
1156     d1 = (double) cpt;
1157     xbt_dynar_remove_at(d, 2000, &d2);
1158     xbt_test_assert(d1 == d2,
1159                      "Remove a bad value. Got %f, expected %f", d2, d1);
1160   }
1161   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1162   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1163   /* in your code is naturally the way to go outside a regression test */
1164 }
1165
1166
1167 /* doxygen_string_cruft */
1168
1169 /*******************************************************************************/
1170 /*******************************************************************************/
1171 /*******************************************************************************/
1172 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1173 {
1174   xbt_dynar_t d;
1175   int cpt;
1176   unsigned int iter;
1177   char buf[1024];
1178   char *s1, *s2;
1179
1180   xbt_test_add("==== Traverse the empty dynar");
1181   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1182   xbt_dynar_foreach(d, iter, s1) {
1183     xbt_test_assert(FALSE,
1184                      "Damnit, there is something in the empty dynar");
1185   }
1186   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1187   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1188   /* in your code is naturally the way to go outside a regression test */
1189
1190   xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1191                 NB_ELEM);
1192   /* Populate_str [doxygen cruft] */
1193   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1194   /* 1. Populate the dynar */
1195   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1196     sprintf(buf, "%d", cpt);
1197     s1 = strdup(buf);
1198     xbt_dynar_push(d, &s1);
1199   }
1200   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1201     sprintf(buf, "%d", cpt);
1202     s1 = strdup(buf);
1203     xbt_dynar_replace(d, cpt, &s1);
1204   }
1205   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1206     sprintf(buf, "%d", cpt);
1207     s1 = strdup(buf);
1208     xbt_dynar_replace(d, cpt, &s1);
1209   }
1210   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1211     sprintf(buf, "%d", cpt);
1212     s1 = strdup(buf);
1213     xbt_dynar_replace(d, cpt, &s1);
1214   }
1215   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1216     sprintf(buf, "%d", cpt);
1217     xbt_dynar_shift(d, &s2);
1218     xbt_test_assert(!strcmp(buf, s2),
1219                      "The retrieved value is not the same than the injected one (%s!=%s)",
1220                      buf, s2);
1221     free(s2);
1222   }
1223   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1224   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1225   /* in your code is naturally the way to go outside a regression test */
1226
1227   xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1228   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1229   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1230     sprintf(buf, "%d", cpt);
1231     s1 = strdup(buf);
1232     xbt_dynar_unshift(d, &s1);
1233   }
1234   /* 2. Traverse the dynar with the macro */
1235   xbt_dynar_foreach(d, iter, s1) {
1236     sprintf(buf, "%d", NB_ELEM - iter - 1);
1237     xbt_test_assert(!strcmp(buf, s1),
1238                      "The retrieved value is not the same than the injected one (%s!=%s)",
1239                      buf, s1);
1240   }
1241   /* 3. Traverse the dynar with the macro */
1242   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1243     sprintf(buf, "%d", cpt);
1244     xbt_dynar_pop(d, &s2);
1245     xbt_test_assert(!strcmp(buf, s2),
1246                      "The retrieved value is not the same than the injected one (%s!=%s)",
1247                      buf, s2);
1248     free(s2);
1249   }
1250   /* 4. Free the resources */
1251   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1252   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1253   /* in your code is naturally the way to go outside a regression test */
1254
1255
1256   xbt_test_add
1257       ("==== Push %d strings, insert %d strings in the middle, shift everything",
1258        NB_ELEM, NB_ELEM / 5);
1259   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1260   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1261     sprintf(buf, "%d", cpt);
1262     s1 = strdup(buf);
1263     xbt_dynar_push(d, &s1);
1264   }
1265   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1266     sprintf(buf, "%d", cpt);
1267     s1 = strdup(buf);
1268     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1269   }
1270
1271   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1272     sprintf(buf, "%d", cpt);
1273     xbt_dynar_shift(d, &s2);
1274     xbt_test_assert(!strcmp(buf, s2),
1275                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1276                      buf, s2);
1277     free(s2);
1278   }
1279   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1280     sprintf(buf, "%d", cpt);
1281     xbt_dynar_shift(d, &s2);
1282     xbt_test_assert(!strcmp(buf, s2),
1283                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1284                      buf, s2);
1285     free(s2);
1286   }
1287   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1288     sprintf(buf, "%d", cpt);
1289     xbt_dynar_shift(d, &s2);
1290     xbt_test_assert(!strcmp(buf, s2),
1291                      "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1292                      buf, s2);
1293     free(s2);
1294   }
1295   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1296   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1297   /* in your code is naturally the way to go outside a regression test */
1298
1299
1300   xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1301                 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1302   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1303   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1304     sprintf(buf, "%d", cpt);
1305     s1 = strdup(buf);
1306     xbt_dynar_push(d, &s1);
1307   }
1308   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1309     sprintf(buf, "%d", cpt);
1310     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1311     xbt_test_assert(!strcmp(buf, s2),
1312                      "Remove a bad value. Got %s, expected %s", s2, buf);
1313     free(s2);
1314   }
1315   xbt_dynar_free(&d);           /* end_of_doxygen */
1316 }
1317
1318
1319 /*******************************************************************************/
1320 /*******************************************************************************/
1321 /*******************************************************************************/
1322 #include "xbt/synchro.h"
1323 static void pusher_f(void *a)
1324 {
1325   xbt_dynar_t d = (xbt_dynar_t) a;
1326   int i;
1327   for (i = 0; i < 500; i++) {
1328     xbt_dynar_push(d, &i);
1329   }
1330 }
1331
1332 static void poper_f(void *a)
1333 {
1334   xbt_dynar_t d = (xbt_dynar_t) a;
1335   int i;
1336   int data;
1337   xbt_ex_t e;
1338
1339   for (i = 0; i < 500; i++) {
1340     TRY {
1341       xbt_dynar_pop(d, &data);
1342     }
1343     CATCH(e) {
1344       if (e.category == bound_error) {
1345         xbt_ex_free(e);
1346         i--;
1347       } else {
1348         RETHROW;
1349       }
1350     }
1351   }
1352 }
1353
1354
1355 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1356 {
1357   /* Vars_decl [doxygen cruft] */
1358   xbt_dynar_t d;
1359   xbt_thread_t pusher, poper;
1360
1361   xbt_test_add("==== Have a pusher and a popper on the dynar");
1362   d = xbt_dynar_new_sync(sizeof(int), NULL);
1363   pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1364   poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1365   xbt_thread_join(pusher);
1366   xbt_thread_join(poper);
1367   xbt_dynar_free(&d);
1368 }
1369
1370 #endif                          /* SIMGRID_TEST */