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