src/xbt/dynar.c

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