src/xbt/dynar.c

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