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 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 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
 689  *
 690  * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
 691  *
 692  * Remark: if the elements stored in the dynar are structures, the compar_fn
 693  * function has to retrieve the field to sort first.
 694  */
 695 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn){
 696
 697         _dynar_lock(dynar);
 698
 699         qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
 700
 701         _dynar_unlock(dynar);
 702 }
 703
 704 #ifdef SIMGRID_TEST
 705
 706 #define NB_ELEM 5000
 707
 708 XBT_TEST_SUITE("dynar", "Dynar data container");
 709 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
 710 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
 711
 712 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 713 {
 714   /* Vars_decl [doxygen cruft] */
 715   xbt_dynar_t d;
 716   int i, cpt;
 717   unsigned int cursor;
 718   int *iptr;
 719
 720   xbt_test_add0("==== Traverse the empty dynar");
 721   d = xbt_dynar_new(sizeof(int), NULL);
 722   xbt_dynar_foreach(d, cursor, i) {
 723     xbt_assert0(0, "Damnit, there is something in the empty dynar");
 724   }
 725   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 726   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 727                                  /* in your code is naturally the way to go outside a regression test */
 728
 729   xbt_test_add1
 730     ("==== Push %d int, set them again 3 times, traverse them, shift them",
 731      NB_ELEM);
 732   /* Populate_ints [doxygen cruft] */
 733   /* 1. Populate the dynar */
 734   d = xbt_dynar_new(sizeof(int), NULL);
 735   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 736     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
 737     /* xbt_dynar_push(d,&cpt);       This would also work */
 738     xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 739   }
 740
 741   /* 2. Traverse manually the dynar */
 742   for (cursor = 0; cursor < NB_ELEM; cursor++) {
 743     iptr = xbt_dynar_get_ptr(d, cursor);
 744     xbt_test_assert2(cursor == *iptr,
 745                      "The retrieved value is not the same than the injected one (%d!=%d)",
 746                      cursor, cpt);
 747   }
 748
 749   /* 3. Traverse the dynar using the neat macro to that extend */
 750   xbt_dynar_foreach(d, cursor, cpt) {
 751     xbt_test_assert2(cursor == cpt,
 752                      "The retrieved value is not the same than the injected one (%d!=%d)",
 753                      cursor, cpt);
 754   }
 755   /* end_of_traversal */
 756
 757   for (cpt = 0; cpt < NB_ELEM; cpt++)
 758     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 759
 760   for (cpt = 0; cpt < NB_ELEM; cpt++)
 761     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 762   /*     xbt_dynar_set(d,cpt,&cpt); */
 763
 764   for (cpt = 0; cpt < NB_ELEM; cpt++)
 765     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
 766
 767   cpt = 0;
 768   xbt_dynar_foreach(d, cursor, i) {
 769     xbt_test_assert2(i == cpt,
 770                      "The retrieved value is not the same than the injected one (%d!=%d)",
 771                      i, cpt);
 772     cpt++;
 773   }
 774   xbt_test_assert2(cpt == NB_ELEM,
 775                    "Cannot retrieve my %d values. Last got one is %d",
 776                    NB_ELEM, cpt);
 777
 778   /* shifting [doxygen cruft] */
 779   /* 4. Shift all the values */
 780   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 781     xbt_dynar_shift(d, &i);
 782     xbt_test_assert2(i == cpt,
 783                      "The retrieved value is not the same than the injected one (%d!=%d)",
 784                      i, cpt);
 785     xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 786   }
 787
 788   /* 5. Free the resources */
 789   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 790   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 791                                  /* in your code is naturally the way to go outside a regression test */
 792
 793   xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
 794   d = xbt_dynar_new(sizeof(int), NULL);
 795   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 796     xbt_dynar_unshift(d, &cpt);
 797     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 798   }
 799   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 800     i = xbt_dynar_pop_as(d, int);
 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   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 807   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 808                                  /* in your code is naturally the way to go outside a regression test */
 809
 810
 811   xbt_test_add1
 812     ("==== Push %d int, insert 1000 int in the middle, shift everything",
 813      NB_ELEM);
 814   d = xbt_dynar_new(sizeof(int), NULL);
 815   for (cpt = 0; cpt < NB_ELEM; cpt++) {
 816     xbt_dynar_push_as(d, int, cpt);
 817     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 818   }
 819   for (cpt = 0; cpt < 1000; cpt++) {
 820     xbt_dynar_insert_at_as(d, 2500, int, cpt);
 821     DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
 822   }
 823
 824   for (cpt = 0; cpt < 2500; cpt++) {
 825     xbt_dynar_shift(d, &i);
 826     xbt_test_assert2(i == cpt,
 827                      "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
 828                      i, cpt);
 829     DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 830   }
 831   for (cpt = 999; cpt >= 0; cpt--) {
 832     xbt_dynar_shift(d, &i);
 833     xbt_test_assert2(i == cpt,
 834                      "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
 835                      i, cpt);
 836   }
 837   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
 838     xbt_dynar_shift(d, &i);
 839     xbt_test_assert2(i == cpt,
 840                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
 841                      i, cpt);
 842   }
 843   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 844   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 845                                  /* in your code is naturally the way to go outside a regression test */
 846
 847   xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
 848   d = xbt_dynar_new(sizeof(int), NULL);
 849   for (cpt = 0; cpt < NB_ELEM; cpt++)
 850     xbt_dynar_push_as(d, int, cpt);
 851
 852   for (cpt = 2000; cpt < 4000; cpt++) {
 853     xbt_dynar_remove_at(d, 2000, &i);
 854     xbt_test_assert2(i == cpt,
 855                      "Remove a bad value. Got %d, expected %d", i, cpt);
 856     DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
 857   }
 858   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 859   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 860                                  /* in your code is naturally the way to go outside a regression test */
 861 }
 862
 863 /*******************************************************************************/
 864 /*******************************************************************************/
 865 /*******************************************************************************/
 866 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
 867 {
 868   xbt_dynar_t d;
 869   int cpt;
 870   unsigned int cursor;
 871   double d1, d2;
 872
 873   xbt_test_add0("==== Traverse the empty dynar");
 874   d = xbt_dynar_new(sizeof(int), NULL);
 875   xbt_dynar_foreach(d, cursor, cpt) {
 876     xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
 877   }
 878   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 879   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 880                                  /* in your code is naturally the way to go outside a regression test */
 881
 882   xbt_test_add0("==== Push/shift 5000 doubles");
 883   d = xbt_dynar_new(sizeof(double), NULL);
 884   for (cpt = 0; cpt < 5000; cpt++) {
 885     d1 = (double) cpt;
 886     xbt_dynar_push(d, &d1);
 887   }
 888   xbt_dynar_foreach(d, cursor, d2) {
 889     d1 = (double) cursor;
 890     xbt_test_assert2(d1 == d2,
 891                      "The retrieved value is not the same than the injected one (%f!=%f)",
 892                      d1, d2);
 893   }
 894   for (cpt = 0; cpt < 5000; cpt++) {
 895     d1 = (double) cpt;
 896     xbt_dynar_shift(d, &d2);
 897     xbt_test_assert2(d1 == d2,
 898                      "The retrieved value is not the same than the injected one (%f!=%f)",
 899                      d1, d2);
 900   }
 901   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 902   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 903                                  /* in your code is naturally the way to go outside a regression test */
 904
 905   xbt_test_add0("==== Unshift/pop 5000 doubles");
 906   d = xbt_dynar_new(sizeof(double), NULL);
 907   for (cpt = 0; cpt < 5000; cpt++) {
 908     d1 = (double) cpt;
 909     xbt_dynar_unshift(d, &d1);
 910   }
 911   for (cpt = 0; cpt < 5000; cpt++) {
 912     d1 = (double) cpt;
 913     xbt_dynar_pop(d, &d2);
 914     xbt_test_assert2(d1 == d2,
 915                      "The retrieved value is not the same than the injected one (%f!=%f)",
 916                      d1, d2);
 917   }
 918   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 919   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 920                                  /* in your code is naturally the way to go outside a regression test */
 921
 922
 923
 924   xbt_test_add0
 925     ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
 926   d = xbt_dynar_new(sizeof(double), NULL);
 927   for (cpt = 0; cpt < 5000; cpt++) {
 928     d1 = (double) cpt;
 929     xbt_dynar_push(d, &d1);
 930   }
 931   for (cpt = 0; cpt < 1000; cpt++) {
 932     d1 = (double) cpt;
 933     xbt_dynar_insert_at(d, 2500, &d1);
 934   }
 935
 936   for (cpt = 0; cpt < 2500; cpt++) {
 937     d1 = (double) cpt;
 938     xbt_dynar_shift(d, &d2);
 939     xbt_test_assert2(d1 == d2,
 940                      "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
 941                      d1, d2);
 942     DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
 943   }
 944   for (cpt = 999; cpt >= 0; cpt--) {
 945     d1 = (double) cpt;
 946     xbt_dynar_shift(d, &d2);
 947     xbt_test_assert2(d1 == d2,
 948                      "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
 949                      d1, d2);
 950   }
 951   for (cpt = 2500; cpt < 5000; cpt++) {
 952     d1 = (double) cpt;
 953     xbt_dynar_shift(d, &d2);
 954     xbt_test_assert2(d1 == d2,
 955                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
 956                      d1, d2);
 957   }
 958   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 959   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 960                                  /* in your code is naturally the way to go outside a regression test */
 961
 962
 963   xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
 964   d = xbt_dynar_new(sizeof(double), NULL);
 965   for (cpt = 0; cpt < 5000; cpt++) {
 966     d1 = (double) cpt;
 967     xbt_dynar_push(d, &d1);
 968   }
 969   for (cpt = 2000; cpt < 4000; cpt++) {
 970     d1 = (double) cpt;
 971     xbt_dynar_remove_at(d, 2000, &d2);
 972     xbt_test_assert2(d1 == d2,
 973                      "Remove a bad value. Got %f, expected %f", d2, d1);
 974   }
 975   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
 976   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
 977                                  /* in your code is naturally the way to go outside a regression test */
 978 }
 979
 980
 981 /* doxygen_string_cruft */
 982
 983 /*******************************************************************************/
 984 /*******************************************************************************/
 985 /*******************************************************************************/
 986 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
 987 {
 988   xbt_dynar_t d;
 989   int cpt;
 990   unsigned int iter;
 991   char buf[1024];
 992   char *s1, *s2;
 993
 994   xbt_test_add0("==== Traverse the empty dynar");
 995   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 996   xbt_dynar_foreach(d, iter, s1) {
 997     xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
 998   }
 999   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1000   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
1001                                  /* in your code is naturally the way to go outside a regression test */
1002
1003   xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
1004                 NB_ELEM);
1005   /* Populate_str [doxygen cruft] */
1006   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1007   /* 1. Populate the dynar */
1008   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1009     sprintf(buf, "%d", cpt);
1010     s1 = strdup(buf);
1011     xbt_dynar_push(d, &s1);
1012   }
1013   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1014     sprintf(buf, "%d", cpt);
1015     s1 = strdup(buf);
1016     xbt_dynar_replace(d, cpt, &s1);
1017   }
1018   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1019     sprintf(buf, "%d", cpt);
1020     s1 = strdup(buf);
1021     xbt_dynar_replace(d, cpt, &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     xbt_dynar_shift(d, &s2);
1031     xbt_test_assert2(!strcmp(buf, s2),
1032                      "The retrieved value is not the same than the injected one (%s!=%s)",
1033                      buf, s2);
1034     free(s2);
1035   }
1036   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1037   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
1038                                  /* in your code is naturally the way to go outside a regression test */
1039
1040   xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
1041   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1042   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1043     sprintf(buf, "%d", cpt);
1044     s1 = strdup(buf);
1045     xbt_dynar_unshift(d, &s1);
1046   }
1047   /* 2. Traverse the dynar with the macro */
1048   xbt_dynar_foreach(d, iter, s1) {
1049     sprintf(buf, "%d", NB_ELEM - iter - 1);
1050     xbt_test_assert2(!strcmp(buf, s1),
1051                      "The retrieved value is not the same than the injected one (%s!=%s)",
1052                      buf, s1);
1053   }
1054   /* 3. Traverse the dynar with the macro */
1055   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1056     sprintf(buf, "%d", cpt);
1057     xbt_dynar_pop(d, &s2);
1058     xbt_test_assert2(!strcmp(buf, s2),
1059                      "The retrieved value is not the same than the injected one (%s!=%s)",
1060                      buf, s2);
1061     free(s2);
1062   }
1063   /* 4. Free the resources */
1064   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1065   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
1066                                  /* in your code is naturally the way to go outside a regression test */
1067
1068
1069   xbt_test_add2
1070     ("==== Push %d strings, insert %d strings in the middle, shift everything",
1071      NB_ELEM, NB_ELEM / 5);
1072   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1073   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1074     sprintf(buf, "%d", cpt);
1075     s1 = strdup(buf);
1076     xbt_dynar_push(d, &s1);
1077   }
1078   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1079     sprintf(buf, "%d", cpt);
1080     s1 = strdup(buf);
1081     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1082   }
1083
1084   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1085     sprintf(buf, "%d", cpt);
1086     xbt_dynar_shift(d, &s2);
1087     xbt_test_assert2(!strcmp(buf, s2),
1088                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1089                      buf, s2);
1090     free(s2);
1091   }
1092   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1093     sprintf(buf, "%d", cpt);
1094     xbt_dynar_shift(d, &s2);
1095     xbt_test_assert2(!strcmp(buf, s2),
1096                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1097                      buf, s2);
1098     free(s2);
1099   }
1100   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1101     sprintf(buf, "%d", cpt);
1102     xbt_dynar_shift(d, &s2);
1103     xbt_test_assert2(!strcmp(buf, s2),
1104                      "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1105                      buf, s2);
1106     free(s2);
1107   }
1108   xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1109   xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing  it only once */
1110                                  /* in your code is naturally the way to go outside a regression test */
1111
1112
1113   xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM,
1114                 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1115   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1116   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1117     sprintf(buf, "%d", cpt);
1118     s1 = strdup(buf);
1119     xbt_dynar_push(d, &s1);
1120   }
1121   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1122     sprintf(buf, "%d", cpt);
1123     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1124     xbt_test_assert2(!strcmp(buf, s2),
1125                      "Remove a bad value. Got %s, expected %s", s2, buf);
1126     free(s2);
1127   }
1128   xbt_dynar_free(&d);           /* end_of_doxygen */
1129 }
1130
1131
1132 /*******************************************************************************/
1133 /*******************************************************************************/
1134 /*******************************************************************************/
1135 #include "xbt/synchro.h"
1136 static void pusher_f(void *a)
1137 {
1138   xbt_dynar_t d = (xbt_dynar_t) a;
1139   int i;
1140   for (i = 0; i < 500; i++) {
1141     xbt_dynar_push(d, &i);
1142   }
1143 }
1144
1145 static void poper_f(void *a)
1146 {
1147   xbt_dynar_t d = (xbt_dynar_t) a;
1148   int i;
1149   int data;
1150   xbt_ex_t e;
1151
1152   for (i = 0; i < 500; i++) {
1153     TRY {
1154       xbt_dynar_pop(d, &data);
1155     }
1156     CATCH(e) {
1157       if (e.category == bound_error) {
1158         xbt_ex_free(e);
1159         i--;
1160       } else {
1161         RETHROW;
1162       }
1163     }
1164   }
1165 }
1166
1167
1168 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int,"Synchronized dynars of integers")
1169 {
1170   /* Vars_decl [doxygen cruft] */
1171   xbt_dynar_t d;
1172   xbt_thread_t pusher, poper;
1173
1174   xbt_test_add0("==== Have a pusher and a popper on the dynar");
1175   d = xbt_dynar_new_sync(sizeof(int), NULL);
1176   pusher = xbt_thread_create("pusher", pusher_f, d,0/*not joinable*/);
1177   poper = xbt_thread_create("poper", poper_f, d,0/*not joinable*/);
1178   xbt_thread_join(pusher);
1179   xbt_thread_join(poper);
1180   xbt_dynar_free(&d);
1181 }
1182
1183 #endif /* SIMGRID_TEST */