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