1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
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. */
9 #include "portable.h" /* SIZEOF_MAX */
11 #include "xbt/sysdep.h"
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
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.
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
24 static XBT_INLINE void _dynar_lock(xbt_dynar_t dynar)
27 xbt_mutex_acquire(dynar->mutex);
30 static XBT_INLINE void _dynar_unlock(xbt_dynar_t dynar)
33 xbt_mutex_release(dynar->mutex);
36 static XBT_INLINE void _sanity_check_dynar(xbt_dynar_t dynar)
38 xbt_assert0(dynar, "dynar is NULL");
41 static XBT_INLINE void _sanity_check_idx(int idx)
43 xbt_assert1(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
46 static XBT_INLINE void _check_inbound_idx(xbt_dynar_t dynar, int idx)
48 if (idx < 0 || idx >= dynar->used) {
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);
56 static XBT_INLINE void _check_sloppy_inbound_idx(xbt_dynar_t dynar, int idx)
58 if (idx > dynar->used) {
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);
66 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
68 if (dynar->used == 0) {
70 THROW1(bound_error, 0, "dynar %p is empty", dynar);
74 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
77 void _xbt_clear_mem(void *const ptr, const unsigned long length)
79 memset(ptr, 0, length);
83 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
85 const unsigned long old_size = dynar->size;
88 char *const old_data = (char *) dynar->data;
90 const unsigned long elmsize = dynar->elmsize;
92 const unsigned long used = dynar->used;
93 const unsigned long used_length = used * elmsize;
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);
100 DEBUG3("expend %p from %lu to %lu elements", (void *) dynar,
101 (unsigned long) old_size, nb);
104 memcpy(new_data, old_data, used_length);
108 _xbt_clear_mem(new_data + used_length, new_length - used_length);
110 dynar->size = new_size;
111 dynar->data = new_data;
116 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
118 char *const data = (char *) dynar->data;
119 const unsigned long elmsize = dynar->elmsize;
121 return data + idx * elmsize;
126 _xbt_dynar_get_elm(void *const dst,
127 const xbt_dynar_t dynar, const unsigned long idx)
129 void *const elm = _xbt_dynar_elm(dynar, idx);
131 memcpy(dst, elm, dynar->elmsize);
136 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
137 const unsigned long idx, const void *const src)
139 void *const elm = _xbt_dynar_elm(dynar, idx);
140 const unsigned long elmsize = dynar->elmsize;
142 memcpy(elm, src, elmsize);
147 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
148 const unsigned long idx, void *const object)
151 unsigned long nb_shift;
152 unsigned long offset;
154 _sanity_check_dynar(dynar);
155 _check_inbound_idx(dynar, idx);
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);
165 char *elm = malloc(dynar->elmsize);
166 _xbt_dynar_get_elm(elm, dynar, idx);
167 (*dynar->free_f) (elm);
172 nb_shift = dynar->used - 1 - idx;
175 offset = nb_shift * dynar->elmsize;
176 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
182 void xbt_dynar_dump(xbt_dynar_t dynar)
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);
188 /** @brief Constructor
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).
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 **).
198 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
201 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
205 dynar->elmsize = elmsize;
207 dynar->free_f = free_f;
213 /** @brief Creates a synchronized dynar.
215 * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
219 xbt_dynar_new_sync(const unsigned long elmsize, void_f_pvoid_t const free_f)
221 xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
222 res->mutex = xbt_mutex_init();
226 /** @brief Destructor of the structure not touching to the content
228 * \param dynar poor victim
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)
233 void xbt_dynar_free_container(xbt_dynar_t * dynar)
235 if (dynar && *dynar) {
237 if ((*dynar)->data) {
238 _xbt_clear_mem((*dynar)->data, (*dynar)->size);
239 free((*dynar)->data);
243 xbt_mutex_destroy((*dynar)->mutex);
245 _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
252 /** @brief Frees the content and set the size to 0
254 * \param dynar who to squeeze
256 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
260 _sanity_check_dynar(dynar);
262 DEBUG1("Reset the dynar %p", (void *) dynar);
264 _dynar_map(dynar, dynar->free_f);
274 _dynar_unlock(dynar);
276 /* dynar->data = NULL; */
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
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
291 * Note that if \a empty_slots_wanted is greater than the array size, the internal
292 * array is expanded instead of shriked.
294 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
296 unsigned long size_wanted;
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);
305 _dynar_unlock(dynar);
308 /** @brief Destructor
310 * \param dynar poor victim
312 * kilkil a dynar and its content
315 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
317 if (dynar && *dynar) {
318 xbt_dynar_reset(*dynar);
319 xbt_dynar_free_container(dynar);
323 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
324 void xbt_dynar_free_voidp(void *d)
326 xbt_dynar_free((xbt_dynar_t *) d);
329 /** @brief Count of dynar's elements
331 * \param dynar the dynar we want to mesure
333 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
335 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
338 /**@brief check if a dynar is empty
340 *\param dynar the dynat we want to check
343 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
345 return (xbt_dynar_length(dynar) == 0);
348 /** @brief Retrieve a copy of the Nth element of a dynar.
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.
355 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
356 const unsigned long idx, void *const dst)
359 _sanity_check_dynar(dynar);
360 _check_inbound_idx(dynar, idx);
362 _xbt_dynar_get_elm(dst, dynar, idx);
363 _dynar_unlock(dynar);
366 /** @brief Retrieve a pointer to the Nth element of a dynar.
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.
372 * \warning The returned value is the actual content of the dynar.
373 * Make a copy before fooling with it.
375 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
380 _sanity_check_dynar(dynar);
381 _check_inbound_idx(dynar, idx);
383 res = _xbt_dynar_elm(dynar, idx);
384 _dynar_unlock(dynar);
389 static void XBT_INLINE /* not synchronized */
390 _xbt_dynar_set(xbt_dynar_t dynar,
391 const unsigned long idx, const void *const src)
394 _sanity_check_dynar(dynar);
395 _sanity_check_idx(idx);
397 _xbt_dynar_expand(dynar, idx + 1);
399 if (idx >= dynar->used) {
400 dynar->used = idx + 1;
403 _xbt_dynar_put_elm(dynar, idx, src);
406 /** @brief Set the Nth element of a dynar (expended if needed). Previous value at this position is NOT freed
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
412 * If you want to free the previous content, use xbt_dynar_replace().
414 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *const src)
418 _xbt_dynar_set(dynar, idx, src);
419 _dynar_unlock(dynar);
422 /** @brief Set the Nth element of a dynar (expended if needed). Previous value is freed
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().
433 xbt_dynar_replace(xbt_dynar_t dynar,
434 const unsigned long idx, const void *const object)
437 _sanity_check_dynar(dynar);
438 _sanity_check_idx(idx);
440 if (idx < dynar->used && dynar->free_f) {
441 void *const old_object = _xbt_dynar_elm(dynar, idx);
443 (*(dynar->free_f)) (old_object);
446 _xbt_dynar_set(dynar, idx, object);
447 _dynar_unlock(dynar);
450 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
451 const unsigned long idx)
454 unsigned long old_used;
455 unsigned long new_used;
456 unsigned long nb_shift;
458 _sanity_check_dynar(dynar);
459 _sanity_check_idx(idx);
460 _check_sloppy_inbound_idx(dynar, idx);
462 old_used = dynar->used;
463 new_used = old_used + 1;
465 _xbt_dynar_expand(dynar, new_used);
467 nb_shift = old_used - idx;
470 memmove(_xbt_dynar_elm(dynar, idx + 1),
471 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
473 dynar->used = new_used;
474 res = _xbt_dynar_elm(dynar, idx);
478 /** @brief Make room for a new element, and return a pointer to it
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.
483 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
488 res = _xbt_dynar_insert_at_ptr(dynar, idx);
489 _dynar_unlock(dynar);
493 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
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.
500 xbt_dynar_insert_at(xbt_dynar_t const dynar,
501 const int idx, const void *const src)
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);
510 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
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.
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.
520 xbt_dynar_remove_at(xbt_dynar_t const dynar,
521 const int idx, void *const object)
525 _xbt_dynar_remove_at(dynar, idx, object);
526 _dynar_unlock(dynar);
529 /** @brief Returns the position of the element in the dynar
531 * Raises not_found_error if not found.
533 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
538 for (it = 0; it < dynar->used; it++)
539 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
540 _dynar_unlock(dynar);
544 _dynar_unlock(dynar);
545 THROW2(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
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)
555 xbt_dynar_search(dynar, elem);
557 if (e.category == not_found_error) {
566 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
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.
571 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
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 */
579 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
580 _dynar_unlock(dynar);
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)
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);
593 /** @brief Mark the last dynar's element as unused and return a pointer to it.
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.
598 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
603 _check_populated_dynar(dynar);
604 DEBUG1("Pop %p", (void *) dynar);
606 res = _xbt_dynar_elm(dynar, dynar->used);
607 _dynar_unlock(dynar);
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)
615 /* sanity checks done by remove_at */
616 DEBUG1("Pop %p", (void *) dynar);
618 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
619 _dynar_unlock(dynar);
622 /** @brief Add an element at the begining of the dynar.
624 * This is less efficient than xbt_dynar_push()
626 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar, const void *const src)
629 /* sanity checks done by insert_at */
630 xbt_dynar_insert_at(dynar, 0, src);
633 /** @brief Get and remove the first element of the dynar.
635 * This is less efficient than xbt_dynar_pop()
637 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
640 /* sanity checks done by remove_at */
641 xbt_dynar_remove_at(dynar, 0, dst);
644 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
646 char elm[SIZEOF_MAX];
647 const unsigned long used = dynar->used;
650 for (i = 0; i < used; i++) {
651 _xbt_dynar_get_elm(elm, dynar, i);
656 /** @brief Apply a function to each member of a dynar
658 * The mapped function may change the value of the element itself,
659 * but should not mess with the structure of the dynar.
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.
665 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
668 _sanity_check_dynar(dynar);
671 _dynar_map(dynar, op);
673 _dynar_unlock(dynar);
677 /** @brief Removes and free the entry pointed by the cursor
679 * This function can be used while traversing without problem.
681 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor)
684 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
687 /** @brief Unlocks a synchronized dynar when you want to break the traversal
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
693 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
695 _dynar_unlock(dynar);
698 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
700 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
702 * Remark: if the elements stored in the dynar are structures, the compar_fn
703 * function has to retrieve the field to sort first.
705 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn){
709 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
711 _dynar_unlock(dynar);
718 XBT_TEST_SUITE("dynar", "Dynar data container");
719 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
720 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
722 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
724 /* Vars_decl [doxygen cruft] */
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");
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 */
740 ("==== Push %d int, set them again 3 times, traverse them, shift them",
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));
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)",
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)",
765 /* end_of_traversal */
767 for (cpt = 0; cpt < NB_ELEM; cpt++)
768 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
770 for (cpt = 0; cpt < NB_ELEM; cpt++)
771 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
772 /* xbt_dynar_set(d,cpt,&cpt); */
774 for (cpt = 0; cpt < NB_ELEM; cpt++)
775 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
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)",
784 xbt_test_assert2(cpt == NB_ELEM,
785 "Cannot retrieve my %d values. Last got one is %d",
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)",
795 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
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 */
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));
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)",
814 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
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 */
822 ("==== Push %d int, insert 1000 int in the middle, shift everything",
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));
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));
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)",
839 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
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)",
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)",
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 */
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);
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));
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 */
873 /*******************************************************************************/
874 /*******************************************************************************/
875 /*******************************************************************************/
876 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
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");
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 */
892 xbt_test_add0("==== Push/shift 5000 doubles");
893 d = xbt_dynar_new(sizeof(double), NULL);
894 for (cpt = 0; cpt < 5000; cpt++) {
896 xbt_dynar_push(d, &d1);
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)",
904 for (cpt = 0; cpt < 5000; 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)",
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 */
915 xbt_test_add0("==== Unshift/pop 5000 doubles");
916 d = xbt_dynar_new(sizeof(double), NULL);
917 for (cpt = 0; cpt < 5000; cpt++) {
919 xbt_dynar_unshift(d, &d1);
921 for (cpt = 0; cpt < 5000; 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)",
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 */
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++) {
939 xbt_dynar_push(d, &d1);
941 for (cpt = 0; cpt < 1000; cpt++) {
943 xbt_dynar_insert_at(d, 2500, &d1);
946 for (cpt = 0; cpt < 2500; 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)",
952 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
954 for (cpt = 999; cpt >= 0; 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)",
961 for (cpt = 2500; cpt < 5000; 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)",
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 */
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++) {
977 xbt_dynar_push(d, &d1);
979 for (cpt = 2000; cpt < 4000; 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);
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 */
991 /* doxygen_string_cruft */
993 /*******************************************************************************/
994 /*******************************************************************************/
995 /*******************************************************************************/
996 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
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");
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 */
1013 xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
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);
1021 xbt_dynar_push(d, &s1);
1023 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1024 sprintf(buf, "%d", cpt);
1026 xbt_dynar_replace(d, cpt, &s1);
1028 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1029 sprintf(buf, "%d", cpt);
1031 xbt_dynar_replace(d, cpt, &s1);
1033 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1034 sprintf(buf, "%d", cpt);
1036 xbt_dynar_replace(d, cpt, &s1);
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)",
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 */
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);
1055 xbt_dynar_unshift(d, &s1);
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)",
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)",
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 */
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);
1086 xbt_dynar_push(d, &s1);
1088 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1089 sprintf(buf, "%d", cpt);
1091 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
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)",
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)",
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)",
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 */
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);
1129 xbt_dynar_push(d, &s1);
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);
1138 xbt_dynar_free(&d); /* end_of_doxygen */
1142 /*******************************************************************************/
1143 /*******************************************************************************/
1144 /*******************************************************************************/
1145 #include "xbt/synchro.h"
1146 static void pusher_f(void *a)
1148 xbt_dynar_t d = (xbt_dynar_t) a;
1150 for (i = 0; i < 500; i++) {
1151 xbt_dynar_push(d, &i);
1155 static void poper_f(void *a)
1157 xbt_dynar_t d = (xbt_dynar_t) a;
1162 for (i = 0; i < 500; i++) {
1164 xbt_dynar_pop(d, &data);
1167 if (e.category == bound_error) {
1178 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int,"Synchronized dynars of integers")
1180 /* Vars_decl [doxygen cruft] */
1182 xbt_thread_t pusher, poper;
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);
1193 #endif /* SIMGRID_TEST */