src/xbt/dynar.c

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