src/xbt/dynar.c

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