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("expend %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   _sanity_check_idx(idx);
 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 (expended 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 (expended 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, expending 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   THROW2(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   DEBUG1("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   DEBUG1("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 elm[SIZEOF_MAX];
 680   const unsigned long used = dynar->used;
 681   unsigned long i = 0;
 682
 683   for (i = 0; i < used; i++) {
 684     _xbt_dynar_get_elm(elm, dynar, i);
 685     (*op) (elm);
 686   }
 687 }
 688
 689 /** @brief Apply a function to each member of a dynar
 690  *
 691  * The mapped function may change the value of the element itself,
 692  * but should not mess with the structure of the dynar.
 693  *
 694  * If the dynar is synchronized, it is locked during the whole map
 695  * operation, so make sure your function don't call any function
 696  * from xbt_dynar_* on it, or you'll get a deadlock.
 697  */
 698 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
 699                               void_f_pvoid_t const op)
 700 {
 701
 702   _sanity_check_dynar(dynar);
 703   _dynar_lock(dynar);
 704
 705   _dynar_map(dynar, op);
 706
 707   _dynar_unlock(dynar);
 708 }
 709
 710
 711 /** @brief Removes and free the entry pointed by the cursor
 712  *
 713  * This function can be used while traversing without problem.
 714  */
 715 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 716                                     unsigned int *const cursor)
 717 {
 718
 719   _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
 720 }
 721
 722 /** @brief Unlocks a synchronized dynar when you want to break the traversal
 723  *
 724  * This function must be used if you <tt>break</tt> the
 725  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
 726  * regular traversal reaching the end of the elements
 727  */
 728 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
 729 {
 730   _dynar_unlock(dynar);
 731 }
 732
 733 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
 734  *
 735  * \param dynar the dynar to sort
 736  * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
 737  *
 738  * Remark: if the elements stored in the dynar are structures, the compar_fn
 739  * function has to retrieve the field to sort first.
 740  */
 741 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
 742                                int_f_cpvoid_cpvoid_t compar_fn)
 743 {
 744
 745   _dynar_lock(dynar);
 746
 747   qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 748
 749   _dynar_unlock(dynar);
 750 }
 751
 752 /*
 753  * Return 0 if d1 and d2 are equal and 1 if not equal
 754  */
 755 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
 756                                         int(*compar)(const void *, const void *))
 757 {
 758         int i ;
 759         int size;
 760         if((!d1) && (!d2)) return 0;
 761         if((!d1) || (!d2))
 762         {
 763                 DEBUG2("NULL dynar d1=%p d2=%p",d1,d2);
 764                 return 1;
 765         }
 766         if((d1->elmsize)!=(d2->elmsize))
 767         {
 768                 DEBUG2("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
 769                 return 1; // xbt_die
 770         }
 771         if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
 772         {
 773                 DEBUG2("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
 774                 return 1;
 775         }
 776
 777         size = xbt_dynar_length(d1);
 778         for(i=0;i<size;i++)
 779         {
 780                 void *data1 = xbt_dynar_get_as(d1, i, void *);
 781                 void *data2 = xbt_dynar_get_as(d2, i, void *);
 782                 DEBUG3("link[%d] d1=%p d2=%p",i,data1,data2);
 783                 if(compar(data1,data2)) return 1;
 784         }
 785         return 0;
 786 }
 787
 788 #ifdef SIMGRID_TEST
 789
 790 #define NB_ELEM 5000
 791
 792 XBT_TEST_SUITE("dynar", "Dynar data container");
 793 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 794 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 795
 796 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 797 {
 798   /* Vars_decl [doxygen cruft] */
 799   xbt_dynar_t d;
 800   int i, cpt;
 801   unsigned int cursor;
 802   int *iptr;
 803
 804   xbt_test_add0("==== Traverse the empty dynar");
 805   d = xbt_dynar_new(sizeof(int), NULL);
 806   xbt_dynar_foreach(d, cursor, i) {
 807     xbt_assert0(0, "Damnit, there is something in the empty dynar");
 808   }
 809   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 810   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 811   /* in your code is naturally the way to go outside a regression test */
 812
 813   xbt_test_add1
 814       ("==== Push %d int, set them again 3 times, traverse them, shift them",
 815        NB_ELEM);
 816   /* Populate_ints [doxygen cruft] */
 817   /* 1. Populate the dynar */
 818   d = xbt_dynar_new(sizeof(int), NULL);
 819   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 820     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
 821     /* xbt_dynar_push(d,&cpt);       This would also work */
 822     xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 823   }
 824
 825   /* 2. Traverse manually the dynar */
 826   for (cursor = 0; cursor < NB_ELEM; cursor++) {
 827     iptr = xbt_dynar_get_ptr(d, cursor);
 828     xbt_test_assert2(cursor == *iptr,
 829                      "The retrieved value is not the same than the injected one (%d!=%d)",
 830                      cursor, cpt);
 831   }
 832
 833   /* 3. Traverse the dynar using the neat macro to that extend */
 834   xbt_dynar_foreach(d, cursor, cpt) {
 835     xbt_test_assert2(cursor == cpt,
 836                      "The retrieved value is not the same than the injected one (%d!=%d)",
 837                      cursor, cpt);
 838   }
 839   /* end_of_traversal */
 840
 841   for (cpt = 0; cpt < NB_ELEM; cpt++)
 842     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 843
 844   for (cpt = 0; cpt < NB_ELEM; cpt++)
 845     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 846   /*     xbt_dynar_set(d,cpt,&cpt); */
 847
 848   for (cpt = 0; cpt < NB_ELEM; cpt++)
 849     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 850
 851   cpt = 0;
 852   xbt_dynar_foreach(d, cursor, i) {
 853     xbt_test_assert2(i == cpt,
 854                      "The retrieved value is not the same than the injected one (%d!=%d)",
 855                      i, cpt);
 856     cpt++;
 857   }
 858   xbt_test_assert2(cpt == NB_ELEM,
 859                    "Cannot retrieve my %d values. Last got one is %d",
 860                    NB_ELEM, cpt);
 861
 862   /* shifting [doxygen cruft] */
 863   /* 4. Shift all the values */
 864   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 865     xbt_dynar_shift(d, &i);
 866     xbt_test_assert2(i == cpt,
 867                      "The retrieved value is not the same than the injected one (%d!=%d)",
 868                      i, cpt);
 869     xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 870   }
 871
 872   /* 5. Free the resources */
 873   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 874   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 875   /* in your code is naturally the way to go outside a regression test */
 876
 877   xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
 878   d = xbt_dynar_new(sizeof(int), NULL);
 879   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 880     xbt_dynar_unshift(d, &cpt);
 881     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 882   }
 883   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 884     i = xbt_dynar_pop_as(d, int);
 885     xbt_test_assert2(i == cpt,
 886                      "The retrieved value is not the same than the injected one (%d!=%d)",
 887                      i, cpt);
 888     xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 889   }
 890   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 891   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 892   /* in your code is naturally the way to go outside a regression test */
 893
 894
 895   xbt_test_add1
 896       ("==== Push %d int, insert 1000 int in the middle, shift everything",
 897        NB_ELEM);
 898   d = xbt_dynar_new(sizeof(int), NULL);
 899   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 900     xbt_dynar_push_as(d, int, cpt);
 901     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 902   }
 903   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
 904     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
 905     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 906   }
 907
 908   for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
 909     xbt_dynar_shift(d, &i);
 910     xbt_test_assert2(i == cpt,
 911                      "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 912                      i, cpt);
 913     DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 914   }
 915   for (cpt = 999; cpt >= 0; cpt--) {
 916     xbt_dynar_shift(d, &i);
 917     xbt_test_assert2(i == cpt,
 918                      "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 919                      i, cpt);
 920   }
 921   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
 922     xbt_dynar_shift(d, &i);
 923     xbt_test_assert2(i == cpt,
 924                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 925                      i, cpt);
 926   }
 927   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 928   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 929   /* in your code is naturally the way to go outside a regression test */
 930
 931   xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest",
 932                 NB_ELEM);
 933   d = xbt_dynar_new(sizeof(int), NULL);
 934   for (cpt = 0; cpt < NB_ELEM; cpt++)
 935     xbt_dynar_push_as(d, int, cpt);
 936
 937   for (cpt = 2000; cpt < 4000; cpt++) {
 938     xbt_dynar_remove_at(d, 2000, &i);
 939     xbt_test_assert2(i == cpt,
 940                      "Remove a bad value. Got %d, expected %d", i, cpt);
 941     DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
 942   }
 943   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
 944   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
 945   /* in your code is naturally the way to go outside a regression test */
 946 }
 947
 948 /*******************************************************************************/
 949 /*******************************************************************************/
 950 /*******************************************************************************/
 951 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
 952 {
 953   xbt_dynar_t d = xbt_dynar_new(sizeof(int), NULL);
 954   unsigned int cursor;
 955   int cpt;
 956
 957   xbt_test_add1("==== Insert %d int, traverse them, remove them",NB_ELEM);
 958   /* Populate_ints [doxygen cruft] */
 959   /* 1. Populate the dynar */
 960   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 961     xbt_dynar_insert_at(d, cpt, &cpt);
 962     xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 963   }
 964
 965   /* 3. Traverse the dynar */
 966   xbt_dynar_foreach(d, cursor, cpt) {
 967     xbt_test_assert2(cursor == cpt,
 968                      "The retrieved value is not the same than the injected one (%d!=%d)",
 969                      cursor, cpt);
 970   }
 971   /* end_of_traversal */
 972
 973   /* Re-fill with the same values using set_as (and re-verify) */
 974   for (cpt = 0; cpt < NB_ELEM; cpt++)
 975     xbt_dynar_set_as(d, cpt, int, cpt);
 976   xbt_dynar_foreach(d, cursor, cpt)
 977     xbt_test_assert2(cursor == cpt,
 978                      "The retrieved value is not the same than the injected one (%d!=%d)",
 979                      cursor, cpt);
 980
 981   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 982     int val;
 983     xbt_dynar_remove_at(d,0,&val);
 984     xbt_test_assert2(cpt == val,
 985                      "The retrieved value is not the same than the injected one (%d!=%d)",
 986                      cursor, cpt);
 987   }
 988   xbt_test_assert1(xbt_dynar_length(d) == 0,
 989                    "There is still %lu elements in the dynar after removing everything",
 990                    xbt_dynar_length(d));
 991   xbt_dynar_free(&d);
 992
 993   /* ********************* */
 994   xbt_test_add1("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
 995   d = xbt_dynar_new(sizeof(int), NULL);
 996   for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
 997     xbt_dynar_replace(d, cpt, &cpt);
 998     xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 999   }
1000
1001   /* 3. Traverse the dynar */
1002   xbt_dynar_foreach(d, cursor, cpt) {
1003     xbt_test_assert2(cursor == cpt,
1004                      "The retrieved value is not the same than the injected one (%d!=%d)",
1005                      cursor, cpt);
1006   }
1007   /* end_of_traversal */
1008
1009   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1010     int val;
1011     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1012     xbt_test_assert2(cpt == val,
1013                      "The retrieved value is not the same than the injected one (%d!=%d)",
1014                      cursor, cpt);
1015   }
1016   xbt_test_assert1(xbt_dynar_length(d) == 0,
1017                    "There is still %lu elements in the dynar after removing everything",
1018                    xbt_dynar_length(d));
1019   xbt_dynar_free(&d);
1020 }
1021
1022 /*******************************************************************************/
1023 /*******************************************************************************/
1024 /*******************************************************************************/
1025 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1026 {
1027   xbt_dynar_t d;
1028   int cpt;
1029   unsigned int cursor;
1030   double d1, d2;
1031
1032   xbt_test_add0("==== Traverse the empty dynar");
1033   d = xbt_dynar_new(sizeof(int), NULL);
1034   xbt_dynar_foreach(d, cursor, cpt) {
1035     xbt_test_assert0(FALSE,
1036                      "Damnit, there is something in the empty dynar");
1037   }
1038   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1039   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1040   /* in your code is naturally the way to go outside a regression test */
1041
1042   xbt_test_add0("==== Push/shift 5000 doubles");
1043   d = xbt_dynar_new(sizeof(double), NULL);
1044   for (cpt = 0; cpt < 5000; cpt++) {
1045     d1 = (double) cpt;
1046     xbt_dynar_push(d, &d1);
1047   }
1048   xbt_dynar_foreach(d, cursor, d2) {
1049     d1 = (double) cursor;
1050     xbt_test_assert2(d1 == d2,
1051                      "The retrieved value is not the same than the injected one (%f!=%f)",
1052                      d1, d2);
1053   }
1054   for (cpt = 0; cpt < 5000; cpt++) {
1055     d1 = (double) cpt;
1056     xbt_dynar_shift(d, &d2);
1057     xbt_test_assert2(d1 == d2,
1058                      "The retrieved value is not the same than the injected one (%f!=%f)",
1059                      d1, d2);
1060   }
1061   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1062   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1063   /* in your code is naturally the way to go outside a regression test */
1064
1065   xbt_test_add0("==== Unshift/pop 5000 doubles");
1066   d = xbt_dynar_new(sizeof(double), NULL);
1067   for (cpt = 0; cpt < 5000; cpt++) {
1068     d1 = (double) cpt;
1069     xbt_dynar_unshift(d, &d1);
1070   }
1071   for (cpt = 0; cpt < 5000; cpt++) {
1072     d1 = (double) cpt;
1073     xbt_dynar_pop(d, &d2);
1074     xbt_test_assert2(d1 == d2,
1075                      "The retrieved value is not the same than the injected one (%f!=%f)",
1076                      d1, d2);
1077   }
1078   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1079   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1080   /* in your code is naturally the way to go outside a regression test */
1081
1082
1083
1084   xbt_test_add0
1085       ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1086   d = xbt_dynar_new(sizeof(double), NULL);
1087   for (cpt = 0; cpt < 5000; cpt++) {
1088     d1 = (double) cpt;
1089     xbt_dynar_push(d, &d1);
1090   }
1091   for (cpt = 0; cpt < 1000; cpt++) {
1092     d1 = (double) cpt;
1093     xbt_dynar_insert_at(d, 2500, &d1);
1094   }
1095
1096   for (cpt = 0; cpt < 2500; cpt++) {
1097     d1 = (double) cpt;
1098     xbt_dynar_shift(d, &d2);
1099     xbt_test_assert2(d1 == d2,
1100                      "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1101                      d1, d2);
1102     DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1103   }
1104   for (cpt = 999; cpt >= 0; cpt--) {
1105     d1 = (double) cpt;
1106     xbt_dynar_shift(d, &d2);
1107     xbt_test_assert2(d1 == d2,
1108                      "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1109                      d1, d2);
1110   }
1111   for (cpt = 2500; cpt < 5000; cpt++) {
1112     d1 = (double) cpt;
1113     xbt_dynar_shift(d, &d2);
1114     xbt_test_assert2(d1 == d2,
1115                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1116                      d1, d2);
1117   }
1118   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1119   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1120   /* in your code is naturally the way to go outside a regression test */
1121
1122
1123   xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
1124   d = xbt_dynar_new(sizeof(double), NULL);
1125   for (cpt = 0; cpt < 5000; cpt++) {
1126     d1 = (double) cpt;
1127     xbt_dynar_push(d, &d1);
1128   }
1129   for (cpt = 2000; cpt < 4000; cpt++) {
1130     d1 = (double) cpt;
1131     xbt_dynar_remove_at(d, 2000, &d2);
1132     xbt_test_assert2(d1 == d2,
1133                      "Remove a bad value. Got %f, expected %f", d2, d1);
1134   }
1135   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1136   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1137   /* in your code is naturally the way to go outside a regression test */
1138 }
1139
1140
1141 /* doxygen_string_cruft */
1142
1143 /*******************************************************************************/
1144 /*******************************************************************************/
1145 /*******************************************************************************/
1146 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1147 {
1148   xbt_dynar_t d;
1149   int cpt;
1150   unsigned int iter;
1151   char buf[1024];
1152   char *s1, *s2;
1153
1154   xbt_test_add0("==== Traverse the empty dynar");
1155   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1156   xbt_dynar_foreach(d, iter, s1) {
1157     xbt_test_assert0(FALSE,
1158                      "Damnit, there is something in the empty dynar");
1159   }
1160   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1161   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1162   /* in your code is naturally the way to go outside a regression test */
1163
1164   xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
1165                 NB_ELEM);
1166   /* Populate_str [doxygen cruft] */
1167   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1168   /* 1. Populate the dynar */
1169   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1170     sprintf(buf, "%d", cpt);
1171     s1 = strdup(buf);
1172     xbt_dynar_push(d, &s1);
1173   }
1174   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1175     sprintf(buf, "%d", cpt);
1176     s1 = strdup(buf);
1177     xbt_dynar_replace(d, cpt, &s1);
1178   }
1179   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1180     sprintf(buf, "%d", cpt);
1181     s1 = strdup(buf);
1182     xbt_dynar_replace(d, cpt, &s1);
1183   }
1184   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1185     sprintf(buf, "%d", cpt);
1186     s1 = strdup(buf);
1187     xbt_dynar_replace(d, cpt, &s1);
1188   }
1189   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1190     sprintf(buf, "%d", cpt);
1191     xbt_dynar_shift(d, &s2);
1192     xbt_test_assert2(!strcmp(buf, s2),
1193                      "The retrieved value is not the same than the injected one (%s!=%s)",
1194                      buf, s2);
1195     free(s2);
1196   }
1197   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1198   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1199   /* in your code is naturally the way to go outside a regression test */
1200
1201   xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
1202   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1203   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1204     sprintf(buf, "%d", cpt);
1205     s1 = strdup(buf);
1206     xbt_dynar_unshift(d, &s1);
1207   }
1208   /* 2. Traverse the dynar with the macro */
1209   xbt_dynar_foreach(d, iter, s1) {
1210     sprintf(buf, "%d", NB_ELEM - iter - 1);
1211     xbt_test_assert2(!strcmp(buf, s1),
1212                      "The retrieved value is not the same than the injected one (%s!=%s)",
1213                      buf, s1);
1214   }
1215   /* 3. Traverse the dynar with the macro */
1216   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1217     sprintf(buf, "%d", cpt);
1218     xbt_dynar_pop(d, &s2);
1219     xbt_test_assert2(!strcmp(buf, s2),
1220                      "The retrieved value is not the same than the injected one (%s!=%s)",
1221                      buf, s2);
1222     free(s2);
1223   }
1224   /* 4. Free the resources */
1225   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1226   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1227   /* in your code is naturally the way to go outside a regression test */
1228
1229
1230   xbt_test_add2
1231       ("==== Push %d strings, insert %d strings in the middle, shift everything",
1232        NB_ELEM, NB_ELEM / 5);
1233   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1234   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1235     sprintf(buf, "%d", cpt);
1236     s1 = strdup(buf);
1237     xbt_dynar_push(d, &s1);
1238   }
1239   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1240     sprintf(buf, "%d", cpt);
1241     s1 = strdup(buf);
1242     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1243   }
1244
1245   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1246     sprintf(buf, "%d", cpt);
1247     xbt_dynar_shift(d, &s2);
1248     xbt_test_assert2(!strcmp(buf, s2),
1249                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1250                      buf, s2);
1251     free(s2);
1252   }
1253   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1254     sprintf(buf, "%d", cpt);
1255     xbt_dynar_shift(d, &s2);
1256     xbt_test_assert2(!strcmp(buf, s2),
1257                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1258                      buf, s2);
1259     free(s2);
1260   }
1261   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1262     sprintf(buf, "%d", cpt);
1263     xbt_dynar_shift(d, &s2);
1264     xbt_test_assert2(!strcmp(buf, s2),
1265                      "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1266                      buf, s2);
1267     free(s2);
1268   }
1269   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1270   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1271   /* in your code is naturally the way to go outside a regression test */
1272
1273
1274   xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest",
1275                 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1276   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1277   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1278     sprintf(buf, "%d", cpt);
1279     s1 = strdup(buf);
1280     xbt_dynar_push(d, &s1);
1281   }
1282   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1283     sprintf(buf, "%d", cpt);
1284     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1285     xbt_test_assert2(!strcmp(buf, s2),
1286                      "Remove a bad value. Got %s, expected %s", s2, buf);
1287     free(s2);
1288   }
1289   xbt_dynar_free(&d);           /* end_of_doxygen */
1290 }
1291
1292
1293 /*******************************************************************************/
1294 /*******************************************************************************/
1295 /*******************************************************************************/
1296 #include "xbt/synchro.h"
1297 static void pusher_f(void *a)
1298 {
1299   xbt_dynar_t d = (xbt_dynar_t) a;
1300   int i;
1301   for (i = 0; i < 500; i++) {
1302     xbt_dynar_push(d, &i);
1303   }
1304 }
1305
1306 static void poper_f(void *a)
1307 {
1308   xbt_dynar_t d = (xbt_dynar_t) a;
1309   int i;
1310   int data;
1311   xbt_ex_t e;
1312
1313   for (i = 0; i < 500; i++) {
1314     TRY {
1315       xbt_dynar_pop(d, &data);
1316     }
1317     CATCH(e) {
1318       if (e.category == bound_error) {
1319         xbt_ex_free(e);
1320         i--;
1321       } else {
1322         RETHROW;
1323       }
1324     }
1325   }
1326 }
1327
1328
1329 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1330 {
1331   /* Vars_decl [doxygen cruft] */
1332   xbt_dynar_t d;
1333   xbt_thread_t pusher, poper;
1334
1335   xbt_test_add0("==== Have a pusher and a popper on the dynar");
1336   d = xbt_dynar_new_sync(sizeof(int), NULL);
1337   pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1338   poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1339   xbt_thread_join(pusher);
1340   xbt_thread_join(poper);
1341   xbt_dynar_free(&d);
1342 }
1343
1344 #endif                          /* SIMGRID_TEST */