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,
59 if (idx > dynar->used) {
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);
67 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
69 if (dynar->used == 0) {
71 THROW1(bound_error, 0, "dynar %p is empty", dynar);
75 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
78 void _xbt_clear_mem(void *const ptr, const unsigned long length)
80 memset(ptr, 0, length);
84 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
86 const unsigned long old_size = dynar->size;
89 char *const old_data = (char *) dynar->data;
91 const unsigned long elmsize = dynar->elmsize;
93 const unsigned long used = dynar->used;
94 const unsigned long used_length = used * elmsize;
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);
101 XBT_DEBUG("expand %p from %lu to %lu elements", (void *) dynar,
102 (unsigned long) old_size, nb);
105 memcpy(new_data, old_data, used_length);
109 _xbt_clear_mem(new_data + used_length, new_length - used_length);
111 dynar->size = new_size;
112 dynar->data = new_data;
117 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
119 char *const data = (char *) dynar->data;
120 const unsigned long elmsize = dynar->elmsize;
122 return data + idx * elmsize;
127 _xbt_dynar_get_elm(void *const dst,
128 const xbt_dynar_t dynar, const unsigned long idx)
130 void *const elm = _xbt_dynar_elm(dynar, idx);
132 memcpy(dst, elm, dynar->elmsize);
137 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
138 const unsigned long idx, const void *const src)
140 void *const elm = _xbt_dynar_elm(dynar, idx);
141 const unsigned long elmsize = dynar->elmsize;
143 memcpy(elm, src, elmsize);
148 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
149 const unsigned long idx, void *const object)
152 unsigned long nb_shift;
153 unsigned long offset;
155 _sanity_check_dynar(dynar);
156 _check_inbound_idx(dynar, idx);
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);
166 char *elm = malloc(dynar->elmsize);
167 _xbt_dynar_get_elm(elm, dynar, idx);
168 (*dynar->free_f) (elm);
173 nb_shift = dynar->used - 1 - idx;
176 offset = nb_shift * dynar->elmsize;
177 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
184 void xbt_dynar_dump(xbt_dynar_t dynar)
186 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
187 dynar->size, dynar->used, dynar->elmsize, dynar->data,
191 /** @brief Constructor
193 * \param elmsize size of each element in the dynar
194 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
196 * Creates a new dynar. If a free_func is provided, the elements have to be
197 * pointer of pointer. That is to say that dynars can contain either base
198 * types (int, char, double, etc) or pointer of pointers (struct **).
201 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
204 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
208 dynar->elmsize = elmsize;
210 dynar->free_f = free_f;
216 /** @brief Creates a synchronized dynar.
218 * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
222 xbt_dynar_new_sync(const unsigned long elmsize,
223 void_f_pvoid_t const free_f)
225 xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
226 res->mutex = xbt_mutex_init();
230 /** @brief Destructor of the structure not touching to the content
232 * \param dynar poor victim
234 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
235 * is not touched (the \a free_f function is not used)
237 void xbt_dynar_free_container(xbt_dynar_t * dynar)
239 if (dynar && *dynar) {
241 if ((*dynar)->data) {
242 _xbt_clear_mem((*dynar)->data, (*dynar)->size);
243 free((*dynar)->data);
247 xbt_mutex_destroy((*dynar)->mutex);
249 _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
256 /** @brief Frees the content and set the size to 0
258 * \param dynar who to squeeze
260 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
264 _sanity_check_dynar(dynar);
266 XBT_DEBUG("Reset the dynar %p", (void *) dynar);
268 _dynar_map(dynar, dynar->free_f);
278 _dynar_unlock(dynar);
280 /* dynar->data = NULL; */
284 * \brief Shrink the dynar by removing empty slots at the end of the internal array
285 * \param dynar a dynar
286 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
287 * internal array for further insertions
289 * Reduces the internal array size of the dynar to the number of elements plus
290 * \a empty_slots_wanted.
291 * After removing elements from the dynar, you can call this function to make
292 * the dynar use less memory.
293 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
295 * Note that if \a empty_slots_wanted is greater than the array size, the internal
296 * array is expanded instead of shriked.
298 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
300 unsigned long size_wanted;
304 size_wanted = dynar->used + empty_slots_wanted;
305 if (size_wanted != dynar->size) {
306 dynar->size = size_wanted;
307 dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
309 _dynar_unlock(dynar);
312 /** @brief Destructor
314 * \param dynar poor victim
316 * kilkil a dynar and its content
319 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
321 if (dynar && *dynar) {
322 xbt_dynar_reset(*dynar);
323 xbt_dynar_free_container(dynar);
327 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
328 void xbt_dynar_free_voidp(void *d)
330 xbt_dynar_t dynar = (xbt_dynar_t)d;
331 xbt_dynar_free(&dynar);
334 /** @brief Count of dynar's elements
336 * \param dynar the dynar we want to mesure
338 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
340 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
343 /**@brief check if a dynar is empty
345 *\param dynar the dynat we want to check
348 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
350 return (xbt_dynar_length(dynar) == 0);
353 /** @brief Retrieve a copy of the Nth element of a dynar.
355 * \param dynar information dealer
356 * \param idx index of the slot we want to retrieve
357 * \param[out] dst where to put the result to.
360 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
361 const unsigned long idx, void *const dst)
364 _sanity_check_dynar(dynar);
365 _check_inbound_idx(dynar, idx);
367 _xbt_dynar_get_elm(dst, dynar, idx);
368 _dynar_unlock(dynar);
371 /** @brief Retrieve a pointer to the Nth element of a dynar.
373 * \param dynar information dealer
374 * \param idx index of the slot we want to retrieve
375 * \return the \a idx-th element of \a dynar.
377 * \warning The returned value is the actual content of the dynar.
378 * Make a copy before fooling with it.
380 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
381 const unsigned long idx)
386 _sanity_check_dynar(dynar);
387 _check_inbound_idx(dynar, idx);
389 res = _xbt_dynar_elm(dynar, idx);
390 _dynar_unlock(dynar);
394 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
395 const unsigned long idx)
400 _sanity_check_dynar(dynar);
402 _xbt_dynar_expand(dynar, idx + 1);
404 if (idx >= dynar->used) {
405 _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
406 (idx + 1 - dynar->used)*dynar->elmsize);
407 dynar->used = idx + 1;
410 _dynar_unlock(dynar);
412 res = _xbt_dynar_elm(dynar, idx);
417 static void XBT_INLINE /* not synchronized */
418 _xbt_dynar_set(xbt_dynar_t dynar,
419 const unsigned long idx, const void *const src)
422 _sanity_check_dynar(dynar);
424 _xbt_dynar_expand(dynar, idx + 1);
426 if (idx >= dynar->used) {
427 _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
428 (idx + 1 - dynar->used)*dynar->elmsize);
429 dynar->used = idx + 1;
432 _xbt_dynar_put_elm(dynar, idx, src);
435 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
437 * \param dynar information dealer
438 * \param idx index of the slot we want to modify
439 * \param src What will be feeded to the dynar
441 * If you want to free the previous content, use xbt_dynar_replace().
443 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
444 const void *const src)
448 _xbt_dynar_set(dynar, idx, src);
449 _dynar_unlock(dynar);
452 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
458 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
459 * free the previous value at this position. If you don't want to free the
460 * previous content, use xbt_dynar_set().
463 xbt_dynar_replace(xbt_dynar_t dynar,
464 const unsigned long idx, const void *const object)
467 _sanity_check_dynar(dynar);
469 if (idx < dynar->used && dynar->free_f) {
470 void *const old_object = _xbt_dynar_elm(dynar, idx);
472 (*(dynar->free_f)) (old_object);
475 _xbt_dynar_set(dynar, idx, object);
476 _dynar_unlock(dynar);
479 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
480 const unsigned long idx)
483 unsigned long old_used;
484 unsigned long new_used;
487 _sanity_check_dynar(dynar);
488 _sanity_check_idx(idx);
490 old_used = dynar->used;
491 new_used = old_used + 1;
493 _xbt_dynar_expand(dynar, new_used);
495 nb_shift = old_used - idx;
498 memmove(_xbt_dynar_elm(dynar, idx + 1),
499 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
502 dynar->used = new_used;
503 res = _xbt_dynar_elm(dynar, idx);
507 /** @brief Make room for a new element, and return a pointer to it
509 * You can then use regular affectation to set its value instead of relying
510 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
512 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
517 res = _xbt_dynar_insert_at_ptr(dynar, idx);
518 _dynar_unlock(dynar);
522 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
524 * Set the Nth element of a dynar, expanding the dynar if needed, and
525 * moving the previously existing value and all subsequent ones to one
526 * position right in the dynar.
529 xbt_dynar_insert_at(xbt_dynar_t const dynar,
530 const int idx, const void *const src)
534 /* checks done in xbt_dynar_insert_at_ptr */
535 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
536 _dynar_unlock(dynar);
539 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
541 * Get the Nth element of a dynar, removing it from the dynar and moving
542 * all subsequent values to one position left in the dynar.
544 * If the object argument of this function is a non-null pointer, the removed
545 * element is copied to this address. If not, the element is freed using the
546 * free_f function passed at dynar creation.
549 xbt_dynar_remove_at(xbt_dynar_t const dynar,
550 const int idx, void *const object)
554 _xbt_dynar_remove_at(dynar, idx, object);
555 _dynar_unlock(dynar);
558 /** @brief Returns the position of the element in the dynar
560 * Raises not_found_error if not found.
562 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
567 for (it = 0; it < dynar->used; it++)
568 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
569 _dynar_unlock(dynar);
573 _dynar_unlock(dynar);
574 THROW2(not_found_error, 0, "Element %p not part of dynar %p", elem,
578 /** @brief Returns a boolean indicating whether the element is part of the dynar */
579 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
585 xbt_dynar_search(dynar, elem);
587 if (e.category == not_found_error) {
596 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
598 * You can then use regular affectation to set its value instead of relying
599 * on the slow memcpy. This is what xbt_dynar_push_as() does.
601 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
605 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
606 dynar->used don't change between reading it and getting the lock
607 within xbt_dynar_insert_at_ptr */
609 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
610 _dynar_unlock(dynar);
614 /** @brief Add an element at the end of the dynar */
615 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
616 const void *const src)
619 /* checks done in xbt_dynar_insert_at_ptr */
620 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
622 _dynar_unlock(dynar);
625 /** @brief Mark the last dynar's element as unused and return a pointer to it.
627 * You can then use regular affectation to set its value instead of relying
628 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
630 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
635 _check_populated_dynar(dynar);
636 XBT_DEBUG("Pop %p", (void *) dynar);
638 res = _xbt_dynar_elm(dynar, dynar->used);
639 _dynar_unlock(dynar);
643 /** @brief Get and remove the last element of the dynar */
644 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
647 /* sanity checks done by remove_at */
648 XBT_DEBUG("Pop %p", (void *) dynar);
650 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
651 _dynar_unlock(dynar);
654 /** @brief Add an element at the begining of the dynar.
656 * This is less efficient than xbt_dynar_push()
658 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
659 const void *const src)
662 /* sanity checks done by insert_at */
663 xbt_dynar_insert_at(dynar, 0, src);
666 /** @brief Get and remove the first element of the dynar.
668 * This is less efficient than xbt_dynar_pop()
670 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
673 /* sanity checks done by remove_at */
674 xbt_dynar_remove_at(dynar, 0, dst);
677 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
679 char elm[SIZEOF_MAX];
680 const unsigned long used = dynar->used;
683 for (i = 0; i < used; i++) {
684 _xbt_dynar_get_elm(elm, dynar, i);
689 /** @brief Apply a function to each member of a dynar
691 * The mapped function may change the value of the element itself,
692 * but should not mess with the structure of the dynar.
694 * If the dynar is synchronized, it is locked during the whole map
695 * operation, so make sure your function don't call any function
696 * from xbt_dynar_* on it, or you'll get a deadlock.
698 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
699 void_f_pvoid_t const op)
702 _sanity_check_dynar(dynar);
705 _dynar_map(dynar, op);
707 _dynar_unlock(dynar);
711 /** @brief Removes and free the entry pointed by the cursor
713 * This function can be used while traversing without problem.
715 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
716 unsigned int *const cursor)
719 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
722 /** @brief Unlocks a synchronized dynar when you want to break the traversal
724 * This function must be used if you <tt>break</tt> the
725 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
726 * regular traversal reaching the end of the elements
728 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
730 _dynar_unlock(dynar);
733 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
735 * \param dynar the dynar to sort
736 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
738 * Remark: if the elements stored in the dynar are structures, the compar_fn
739 * function has to retrieve the field to sort first.
741 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
742 int_f_cpvoid_cpvoid_t compar_fn)
747 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
749 _dynar_unlock(dynar);
752 /** @brief Transform a dynar into a NULL terminated array
754 * \param dynar the dynar to transform
756 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
759 void * last = xbt_new0(char,dynar->elmsize);
760 xbt_dynar_push(dynar, last);
768 * Return 0 if d1 and d2 are equal and 1 if not equal
770 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
771 int(*compar)(const void *, const void *))
775 if((!d1) && (!d2)) return 0;
778 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
782 if((d1->elmsize)!=(d2->elmsize))
784 XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
788 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
790 XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
795 size = xbt_dynar_length(d1);
798 void *data1 = xbt_dynar_get_as(d1, i, void *);
799 void *data2 = xbt_dynar_get_as(d2, i, void *);
800 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
801 if(compar(data1,data2)){
814 XBT_TEST_SUITE("dynar", "Dynar data container");
815 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
816 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
818 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
820 /* Vars_decl [doxygen cruft] */
826 xbt_test_add("==== Traverse the empty dynar");
827 d = xbt_dynar_new(sizeof(int), NULL);
828 xbt_dynar_foreach(d, cursor, i) {
829 xbt_die( "Damnit, there is something in the empty dynar");
831 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
832 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
833 /* in your code is naturally the way to go outside a regression test */
836 ("==== Push %d int, set them again 3 times, traverse them, shift them",
838 /* Populate_ints [doxygen cruft] */
839 /* 1. Populate the dynar */
840 d = xbt_dynar_new(sizeof(int), NULL);
841 for (cpt = 0; cpt < NB_ELEM; cpt++) {
842 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
843 /* xbt_dynar_push(d,&cpt); This would also work */
844 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
847 /* 2. Traverse manually the dynar */
848 for (cursor = 0; cursor < NB_ELEM; cursor++) {
849 iptr = xbt_dynar_get_ptr(d, cursor);
850 xbt_test_assert(cursor == *iptr,
851 "The retrieved value is not the same than the injected one (%d!=%d)",
855 /* 3. Traverse the dynar using the neat macro to that extend */
856 xbt_dynar_foreach(d, cursor, cpt) {
857 xbt_test_assert(cursor == cpt,
858 "The retrieved value is not the same than the injected one (%d!=%d)",
861 /* end_of_traversal */
863 for (cpt = 0; cpt < NB_ELEM; cpt++)
864 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
866 for (cpt = 0; cpt < NB_ELEM; cpt++)
867 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
868 /* xbt_dynar_set(d,cpt,&cpt); */
870 for (cpt = 0; cpt < NB_ELEM; cpt++)
871 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
874 xbt_dynar_foreach(d, cursor, i) {
875 xbt_test_assert(i == cpt,
876 "The retrieved value is not the same than the injected one (%d!=%d)",
880 xbt_test_assert(cpt == NB_ELEM,
881 "Cannot retrieve my %d values. Last got one is %d",
884 /* shifting [doxygen cruft] */
885 /* 4. Shift all the values */
886 for (cpt = 0; cpt < NB_ELEM; cpt++) {
887 xbt_dynar_shift(d, &i);
888 xbt_test_assert(i == cpt,
889 "The retrieved value is not the same than the injected one (%d!=%d)",
891 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
894 /* 5. Free the resources */
895 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
896 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
897 /* in your code is naturally the way to go outside a regression test */
899 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
900 d = xbt_dynar_new(sizeof(int), NULL);
901 for (cpt = 0; cpt < NB_ELEM; cpt++) {
902 xbt_dynar_unshift(d, &cpt);
903 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
905 for (cpt = 0; cpt < NB_ELEM; cpt++) {
906 i = xbt_dynar_pop_as(d, int);
907 xbt_test_assert(i == cpt,
908 "The retrieved value is not the same than the injected one (%d!=%d)",
910 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
912 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
913 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
914 /* in your code is naturally the way to go outside a regression test */
918 ("==== Push %d int, insert 1000 int in the middle, shift everything",
920 d = xbt_dynar_new(sizeof(int), NULL);
921 for (cpt = 0; cpt < NB_ELEM; cpt++) {
922 xbt_dynar_push_as(d, int, cpt);
923 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
925 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
926 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
927 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
930 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
931 xbt_dynar_shift(d, &i);
932 xbt_test_assert(i == cpt,
933 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
935 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
937 for (cpt = 999; cpt >= 0; cpt--) {
938 xbt_dynar_shift(d, &i);
939 xbt_test_assert(i == cpt,
940 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
943 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
944 xbt_dynar_shift(d, &i);
945 xbt_test_assert(i == cpt,
946 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
949 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
950 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
951 /* in your code is naturally the way to go outside a regression test */
953 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
955 d = xbt_dynar_new(sizeof(int), NULL);
956 for (cpt = 0; cpt < NB_ELEM; cpt++)
957 xbt_dynar_push_as(d, int, cpt);
959 for (cpt = 2000; cpt < 4000; cpt++) {
960 xbt_dynar_remove_at(d, 2000, &i);
961 xbt_test_assert(i == cpt,
962 "Remove a bad value. Got %d, expected %d", i, cpt);
963 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
965 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
966 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
967 /* in your code is naturally the way to go outside a regression test */
970 /*******************************************************************************/
971 /*******************************************************************************/
972 /*******************************************************************************/
973 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
975 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
979 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
980 /* Populate_ints [doxygen cruft] */
981 /* 1. Populate the dynar */
982 for (cpt = 0; cpt < NB_ELEM; cpt++) {
983 xbt_dynar_insert_at(d, cpt, &cpt);
984 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
987 /* 3. Traverse the dynar */
988 xbt_dynar_foreach(d, cursor, cpt) {
989 xbt_test_assert(cursor == cpt,
990 "The retrieved value is not the same than the injected one (%d!=%d)",
993 /* end_of_traversal */
995 /* Re-fill with the same values using set_as (and re-verify) */
996 for (cpt = 0; cpt < NB_ELEM; cpt++)
997 xbt_dynar_set_as(d, cpt, int, cpt);
998 xbt_dynar_foreach(d, cursor, cpt)
999 xbt_test_assert(cursor == cpt,
1000 "The retrieved value is not the same than the injected one (%d!=%d)",
1003 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1005 xbt_dynar_remove_at(d,0,&val);
1006 xbt_test_assert(cpt == val,
1007 "The retrieved value is not the same than the injected one (%d!=%d)",
1010 xbt_test_assert(xbt_dynar_length(d) == 0,
1011 "There is still %lu elements in the dynar after removing everything",
1012 xbt_dynar_length(d));
1015 /* ********************* */
1016 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1017 d = xbt_dynar_new(sizeof(int), NULL);
1018 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1019 xbt_dynar_replace(d, cpt, &cpt);
1020 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1023 /* 3. Traverse the dynar */
1024 xbt_dynar_foreach(d, cursor, cpt) {
1025 xbt_test_assert(cursor == cpt,
1026 "The retrieved value is not the same than the injected one (%d!=%d)",
1029 /* end_of_traversal */
1031 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1033 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1034 xbt_test_assert(cpt == val,
1035 "The retrieved value is not the same than the injected one (%d!=%d)",
1038 xbt_test_assert(xbt_dynar_length(d) == 0,
1039 "There is still %lu elements in the dynar after removing everything",
1040 xbt_dynar_length(d));
1044 /*******************************************************************************/
1045 /*******************************************************************************/
1046 /*******************************************************************************/
1047 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1051 unsigned int cursor;
1054 xbt_test_add("==== Traverse the empty dynar");
1055 d = xbt_dynar_new(sizeof(int), NULL);
1056 xbt_dynar_foreach(d, cursor, cpt) {
1057 xbt_test_assert(FALSE,
1058 "Damnit, there is something in the empty dynar");
1060 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1061 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1062 /* in your code is naturally the way to go outside a regression test */
1064 xbt_test_add("==== Push/shift 5000 doubles");
1065 d = xbt_dynar_new(sizeof(double), NULL);
1066 for (cpt = 0; cpt < 5000; cpt++) {
1068 xbt_dynar_push(d, &d1);
1070 xbt_dynar_foreach(d, cursor, d2) {
1071 d1 = (double) cursor;
1072 xbt_test_assert(d1 == d2,
1073 "The retrieved value is not the same than the injected one (%f!=%f)",
1076 for (cpt = 0; cpt < 5000; cpt++) {
1078 xbt_dynar_shift(d, &d2);
1079 xbt_test_assert(d1 == d2,
1080 "The retrieved value is not the same than the injected one (%f!=%f)",
1083 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1084 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1085 /* in your code is naturally the way to go outside a regression test */
1087 xbt_test_add("==== Unshift/pop 5000 doubles");
1088 d = xbt_dynar_new(sizeof(double), NULL);
1089 for (cpt = 0; cpt < 5000; cpt++) {
1091 xbt_dynar_unshift(d, &d1);
1093 for (cpt = 0; cpt < 5000; cpt++) {
1095 xbt_dynar_pop(d, &d2);
1096 xbt_test_assert(d1 == d2,
1097 "The retrieved value is not the same than the injected one (%f!=%f)",
1100 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1101 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1102 /* in your code is naturally the way to go outside a regression test */
1107 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1108 d = xbt_dynar_new(sizeof(double), NULL);
1109 for (cpt = 0; cpt < 5000; cpt++) {
1111 xbt_dynar_push(d, &d1);
1113 for (cpt = 0; cpt < 1000; cpt++) {
1115 xbt_dynar_insert_at(d, 2500, &d1);
1118 for (cpt = 0; cpt < 2500; cpt++) {
1120 xbt_dynar_shift(d, &d2);
1121 xbt_test_assert(d1 == d2,
1122 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1124 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1126 for (cpt = 999; cpt >= 0; cpt--) {
1128 xbt_dynar_shift(d, &d2);
1129 xbt_test_assert(d1 == d2,
1130 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1133 for (cpt = 2500; cpt < 5000; cpt++) {
1135 xbt_dynar_shift(d, &d2);
1136 xbt_test_assert(d1 == d2,
1137 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1140 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1141 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1142 /* in your code is naturally the way to go outside a regression test */
1145 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1146 d = xbt_dynar_new(sizeof(double), NULL);
1147 for (cpt = 0; cpt < 5000; cpt++) {
1149 xbt_dynar_push(d, &d1);
1151 for (cpt = 2000; cpt < 4000; cpt++) {
1153 xbt_dynar_remove_at(d, 2000, &d2);
1154 xbt_test_assert(d1 == d2,
1155 "Remove a bad value. Got %f, expected %f", d2, d1);
1157 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1158 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1159 /* in your code is naturally the way to go outside a regression test */
1163 /* doxygen_string_cruft */
1165 /*******************************************************************************/
1166 /*******************************************************************************/
1167 /*******************************************************************************/
1168 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1176 xbt_test_add("==== Traverse the empty dynar");
1177 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1178 xbt_dynar_foreach(d, iter, s1) {
1179 xbt_test_assert(FALSE,
1180 "Damnit, there is something in the empty dynar");
1182 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1183 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1184 /* in your code is naturally the way to go outside a regression test */
1186 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1188 /* Populate_str [doxygen cruft] */
1189 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1190 /* 1. Populate the dynar */
1191 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1192 sprintf(buf, "%d", cpt);
1194 xbt_dynar_push(d, &s1);
1196 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1197 sprintf(buf, "%d", cpt);
1199 xbt_dynar_replace(d, cpt, &s1);
1201 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1202 sprintf(buf, "%d", cpt);
1204 xbt_dynar_replace(d, cpt, &s1);
1206 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1207 sprintf(buf, "%d", cpt);
1209 xbt_dynar_replace(d, cpt, &s1);
1211 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1212 sprintf(buf, "%d", cpt);
1213 xbt_dynar_shift(d, &s2);
1214 xbt_test_assert(!strcmp(buf, s2),
1215 "The retrieved value is not the same than the injected one (%s!=%s)",
1219 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1220 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1221 /* in your code is naturally the way to go outside a regression test */
1223 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1224 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1225 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1226 sprintf(buf, "%d", cpt);
1228 xbt_dynar_unshift(d, &s1);
1230 /* 2. Traverse the dynar with the macro */
1231 xbt_dynar_foreach(d, iter, s1) {
1232 sprintf(buf, "%d", NB_ELEM - iter - 1);
1233 xbt_test_assert(!strcmp(buf, s1),
1234 "The retrieved value is not the same than the injected one (%s!=%s)",
1237 /* 3. Traverse the dynar with the macro */
1238 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1239 sprintf(buf, "%d", cpt);
1240 xbt_dynar_pop(d, &s2);
1241 xbt_test_assert(!strcmp(buf, s2),
1242 "The retrieved value is not the same than the injected one (%s!=%s)",
1246 /* 4. Free the resources */
1247 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1248 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1249 /* in your code is naturally the way to go outside a regression test */
1253 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1254 NB_ELEM, NB_ELEM / 5);
1255 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1256 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1257 sprintf(buf, "%d", cpt);
1259 xbt_dynar_push(d, &s1);
1261 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1262 sprintf(buf, "%d", cpt);
1264 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1267 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1268 sprintf(buf, "%d", cpt);
1269 xbt_dynar_shift(d, &s2);
1270 xbt_test_assert(!strcmp(buf, s2),
1271 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1275 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1276 sprintf(buf, "%d", cpt);
1277 xbt_dynar_shift(d, &s2);
1278 xbt_test_assert(!strcmp(buf, s2),
1279 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1283 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1284 sprintf(buf, "%d", cpt);
1285 xbt_dynar_shift(d, &s2);
1286 xbt_test_assert(!strcmp(buf, s2),
1287 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1291 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1292 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1293 /* in your code is naturally the way to go outside a regression test */
1296 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1297 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1298 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1299 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1300 sprintf(buf, "%d", cpt);
1302 xbt_dynar_push(d, &s1);
1304 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1305 sprintf(buf, "%d", cpt);
1306 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1307 xbt_test_assert(!strcmp(buf, s2),
1308 "Remove a bad value. Got %s, expected %s", s2, buf);
1311 xbt_dynar_free(&d); /* end_of_doxygen */
1315 /*******************************************************************************/
1316 /*******************************************************************************/
1317 /*******************************************************************************/
1318 #include "xbt/synchro.h"
1319 static void pusher_f(void *a)
1321 xbt_dynar_t d = (xbt_dynar_t) a;
1323 for (i = 0; i < 500; i++) {
1324 xbt_dynar_push(d, &i);
1328 static void poper_f(void *a)
1330 xbt_dynar_t d = (xbt_dynar_t) a;
1335 for (i = 0; i < 500; i++) {
1337 xbt_dynar_pop(d, &data);
1340 if (e.category == bound_error) {
1351 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1353 /* Vars_decl [doxygen cruft] */
1355 xbt_thread_t pusher, poper;
1357 xbt_test_add("==== Have a pusher and a popper on the dynar");
1358 d = xbt_dynar_new_sync(sizeof(int), NULL);
1359 pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1360 poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1361 xbt_thread_join(pusher);
1362 xbt_thread_join(poper);
1366 #endif /* SIMGRID_TEST */