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