1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004-2015. 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. */
10 #include "xbt/sysdep.h"
13 #include "xbt/dynar.h"
14 #include <sys/types.h>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
18 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
20 xbt_assert(dynar, "dynar is NULL");
23 static inline void _sanity_check_idx(int idx)
25 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
28 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
30 if (idx < 0 || idx >= (int)dynar->used) {
31 THROWF(bound_error, idx,
32 "dynar is not that long. You asked %d, but it's only %lu long",
33 (int) (idx), (unsigned long) dynar->used);
37 static inline void _check_populated_dynar(xbt_dynar_t dynar)
39 if (dynar->used == 0) {
40 THROWF(bound_error, 0, "dynar %p is empty", dynar);
45 void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
47 if (new_size != dynar->size) {
48 dynar->size = new_size;
49 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
54 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
56 const unsigned long old_size = dynar->size;
59 const unsigned long expand = 2 * (old_size + 1);
60 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
61 XBT_DEBUG("expand %p from %lu to %lu elements",
62 dynar, old_size, dynar->size);
67 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
69 char *const data = (char *) dynar->data;
70 const unsigned long elmsize = dynar->elmsize;
72 return data + idx * elmsize;
77 _xbt_dynar_get_elm(void *const dst,
78 const xbt_dynar_t dynar, const unsigned long idx)
80 void *const elm = _xbt_dynar_elm(dynar, idx);
82 memcpy(dst, elm, dynar->elmsize);
85 void xbt_dynar_dump(xbt_dynar_t dynar)
87 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
88 dynar->size, dynar->used, dynar->elmsize, dynar->data,
92 /** @brief Constructor
94 * \param elmsize size of each element in the dynar
95 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
97 * Creates a new dynar. If a free_func is provided, the elements have to be
98 * pointer of pointer. That is to say that dynars can contain either base
99 * types (int, char, double, etc) or pointer of pointers (struct **).
102 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
105 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
109 dynar->elmsize = elmsize;
111 dynar->free_f = free_f;
116 /** @brief Destructor of the structure not touching to the content
118 * \param dynar poor victim
120 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
121 * is not touched (the \a free_f function is not used)
123 void xbt_dynar_free_container(xbt_dynar_t * dynar)
125 if (dynar && *dynar) {
126 xbt_dynar_t d = *dynar;
133 /** @brief Frees the content and set the size to 0
135 * \param dynar who to squeeze
137 inline void xbt_dynar_reset(xbt_dynar_t const dynar)
139 _sanity_check_dynar(dynar);
141 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
143 xbt_dynar_map(dynar, dynar->free_f);
148 /** @brief Merge dynar d2 into d1
150 * \param d1 dynar to keep
151 * \param d2 dynar to merge into d1. This dynar is free at end.
153 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
155 if((*d1)->elmsize != (*d2)->elmsize)
156 xbt_die("Element size must are not equal");
158 const unsigned long elmsize = (*d1)->elmsize;
160 void *ptr = _xbt_dynar_elm((*d2), 0);
161 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
162 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
164 memcpy(elm, ptr, ((*d2)->size)*elmsize);
165 (*d1)->used += (*d2)->used;
171 * \brief Shrink the dynar by removing empty slots at the end of the internal array
172 * \param dynar a dynar
173 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
174 * internal array for further insertions
176 * Reduces the internal array size of the dynar to the number of elements plus
177 * \a empty_slots_wanted.
178 * After removing elements from the dynar, you can call this function to make
179 * the dynar use less memory.
180 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
182 * Note that if \a empty_slots_wanted is greater than the array size, the internal
183 * array is expanded instead of shriked.
185 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
187 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
190 /** @brief Destructor
192 * \param dynar poor victim
194 * kilkil a dynar and its content
197 inline void xbt_dynar_free(xbt_dynar_t * dynar)
199 if (dynar && *dynar) {
200 xbt_dynar_reset(*dynar);
201 xbt_dynar_free_container(dynar);
205 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
206 void xbt_dynar_free_voidp(void *d)
208 xbt_dynar_t dynar = (xbt_dynar_t)d;
209 xbt_dynar_free(&dynar);
212 /** @brief Count of dynar's elements
214 * \param dynar the dynar we want to mesure
216 inline unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
218 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
221 /**@brief check if a dynar is empty
223 *\param dynar the dynat we want to check
226 inline int xbt_dynar_is_empty(const xbt_dynar_t dynar)
228 return (xbt_dynar_length(dynar) == 0);
231 /** @brief Retrieve a copy of the Nth element of a dynar.
233 * \param dynar information dealer
234 * \param idx index of the slot we want to retrieve
235 * \param[out] dst where to put the result to.
238 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
239 const unsigned long idx, void *const dst)
241 _sanity_check_dynar(dynar);
242 _check_inbound_idx(dynar, idx);
244 _xbt_dynar_get_elm(dst, dynar, idx);
247 /** @brief Retrieve a pointer to the Nth element of a dynar.
249 * \param dynar information dealer
250 * \param idx index of the slot we want to retrieve
251 * \return the \a idx-th element of \a dynar.
253 * \warning The returned value is the actual content of the dynar.
254 * Make a copy before fooling with it.
256 inline void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
257 const unsigned long idx)
261 _sanity_check_dynar(dynar);
262 _check_inbound_idx(dynar, idx);
264 res = _xbt_dynar_elm(dynar, idx);
268 inline void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
269 const unsigned long idx)
271 _sanity_check_dynar(dynar);
273 if (idx >= dynar->used) {
274 _xbt_dynar_expand(dynar, idx + 1);
275 if (idx > dynar->used) {
276 memset(_xbt_dynar_elm(dynar, dynar->used), 0,
277 (idx - dynar->used) * dynar->elmsize);
279 dynar->used = idx + 1;
281 return _xbt_dynar_elm(dynar, idx);
284 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
286 * \param dynar information dealer
287 * \param idx index of the slot we want to modify
288 * \param src What will be feeded to the dynar
290 * If you want to free the previous content, use xbt_dynar_replace().
292 inline void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
293 const void *const src)
296 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
299 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
305 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
306 * free the previous value at this position. If you don't want to free the
307 * previous content, use xbt_dynar_set().
310 xbt_dynar_replace(xbt_dynar_t dynar,
311 const unsigned long idx, const void *const object)
313 _sanity_check_dynar(dynar);
315 if (idx < dynar->used && dynar->free_f) {
316 void *const old_object = _xbt_dynar_elm(dynar, idx);
318 dynar->free_f(old_object);
321 xbt_dynar_set(dynar, idx, object);
324 /** @brief Make room for a new element, and return a pointer to it
326 * You can then use regular affectation to set its value instead of relying
327 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
329 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
332 unsigned long old_used;
333 unsigned long new_used;
336 _sanity_check_dynar(dynar);
337 _sanity_check_idx(idx);
339 old_used = dynar->used;
340 new_used = old_used + 1;
342 _xbt_dynar_expand(dynar, new_used);
344 nb_shift = old_used - idx;
347 memmove(_xbt_dynar_elm(dynar, idx + 1),
348 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
351 dynar->used = new_used;
352 res = _xbt_dynar_elm(dynar, idx);
356 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
358 * Set the Nth element of a dynar, expanding the dynar if needed, and
359 * moving the previously existing value and all subsequent ones to one
360 * position right in the dynar.
363 xbt_dynar_insert_at(xbt_dynar_t const dynar,
364 const int idx, const void *const src)
367 /* checks done in xbt_dynar_insert_at_ptr */
368 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
371 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
373 * Get the Nth element of a dynar, removing it from the dynar and moving
374 * all subsequent values to one position left in the dynar.
376 * If the object argument of this function is a non-null pointer, the removed
377 * element is copied to this address. If not, the element is freed using the
378 * free_f function passed at dynar creation.
381 xbt_dynar_remove_at(xbt_dynar_t const dynar,
382 const int idx, void *const object)
384 unsigned long nb_shift;
385 unsigned long offset;
387 _sanity_check_dynar(dynar);
388 _check_inbound_idx(dynar, idx);
391 _xbt_dynar_get_elm(object, dynar, idx);
392 } else if (dynar->free_f) {
393 dynar->free_f(_xbt_dynar_elm(dynar, idx));
396 nb_shift = dynar->used - 1 - idx;
399 offset = nb_shift * dynar->elmsize;
400 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
407 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
409 * This function removes an n-sized slice that starts at element idx. It is equivalent
410 * to xbt_dynar_remove_at with a NULL object argument if n equals to 1.
412 * Each of the removed elements is freed using the free_f function passed at dynar
416 xbt_dynar_remove_n_at(xbt_dynar_t const dynar,
417 const unsigned int n, const int idx)
419 unsigned long nb_shift;
420 unsigned long offset;
425 _sanity_check_dynar(dynar);
426 _check_inbound_idx(dynar, idx);
427 _check_inbound_idx(dynar, idx + n - 1);
430 for (cur = idx; cur < idx + n; cur++) {
431 dynar->free_f(_xbt_dynar_elm(dynar, cur));
435 nb_shift = dynar->used - n - idx;
438 offset = nb_shift * dynar->elmsize;
439 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n),
446 /** @brief Returns the position of the element in the dynar
448 * Beware that if your dynar contains pointed values (such as strings) instead
449 * of scalar, this function compares the pointer value, not what's pointed. The only
450 * solution to search for a pointed value is then to write the foreach loop yourself:
452 * signed int position = -1;
453 * xbt_dynar_foreach(dynar, iter, elem) {
454 * if (!memcmp(elem, searched_element, sizeof(*elem))) {
461 * Raises not_found_error if not found. If you have less than 2 millions elements,
462 * you probably want to use #xbt_dynar_search_or_negative() instead, so that you
463 * don't have to TRY/CATCH on element not found.
465 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
469 for (it = 0; it < dynar->used; it++)
470 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
474 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
475 return -1; // Won't happen, just to please eclipse
478 /** @brief Returns the position of the element in the dynar (or -1 if not found)
480 * Beware that if your dynar contains pointed values (such as
481 * strings) instead of scalar, this function is probably not what you
482 * want. Check the documentation of xbt_dynar_search() for more info.
484 * Note that usually, the dynar indices are unsigned integers. If you have more
485 * than 2 million elements in your dynar, this very function will not work (but the other will).
487 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
491 for (it = 0; it < dynar->used; it++)
492 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
499 /** @brief Returns a boolean indicating whether the element is part of the dynar
501 * Beware that if your dynar contains pointed values (such as
502 * strings) instead of scalar, this function is probably not what you
503 * want. Check the documentation of xbt_dynar_search() for more info.
505 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
511 xbt_dynar_search(dynar, elem);
514 if (e.category == not_found_error) {
523 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
525 * You can then use regular affectation to set its value instead of relying
526 * on the slow memcpy. This is what xbt_dynar_push_as() does.
528 inline void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
530 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
533 /** @brief Add an element at the end of the dynar */
534 inline void xbt_dynar_push(xbt_dynar_t const dynar,
535 const void *const src)
537 /* checks done in xbt_dynar_insert_at_ptr */
538 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
541 /** @brief Mark the last dynar's element as unused and return a pointer to it.
543 * You can then use regular affectation to set its value instead of relying
544 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
546 inline void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
548 _check_populated_dynar(dynar);
549 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
551 return _xbt_dynar_elm(dynar, dynar->used);
554 /** @brief Get and remove the last element of the dynar */
555 inline void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
558 /* sanity checks done by remove_at */
559 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
560 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
563 /** @brief Add an element at the begining of the dynar.
565 * This is less efficient than xbt_dynar_push()
567 inline void xbt_dynar_unshift(xbt_dynar_t const dynar,
568 const void *const src)
571 /* sanity checks done by insert_at */
572 xbt_dynar_insert_at(dynar, 0, src);
575 /** @brief Get and remove the first element of the dynar.
577 * This is less efficient than xbt_dynar_pop()
579 inline void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
582 /* sanity checks done by remove_at */
583 xbt_dynar_remove_at(dynar, 0, dst);
586 /** @brief Apply a function to each member of a dynar
588 * The mapped function may change the value of the element itself,
589 * but should not mess with the structure of the dynar.
591 inline void xbt_dynar_map(const xbt_dynar_t dynar,
592 void_f_pvoid_t const op)
594 char *const data = (char *) dynar->data;
595 const unsigned long elmsize = dynar->elmsize;
596 const unsigned long used = dynar->used;
599 _sanity_check_dynar(dynar);
601 for (i = 0; i < used; i++) {
602 char* elm = (char*) data + i * elmsize;
608 /** @brief Removes and free the entry pointed by the cursor
610 * This function can be used while traversing without problem.
612 inline void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
613 unsigned int *const cursor)
616 xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
619 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
621 * \param dynar the dynar to sort
622 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
624 * Remark: if the elements stored in the dynar are structures, the compar_fn
625 * function has to retrieve the field to sort first.
627 inline void xbt_dynar_sort(xbt_dynar_t dynar,
628 int_f_cpvoid_cpvoid_t compar_fn)
630 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
633 static int strcmp_voidp(const void *pa, const void *pb) {
634 return strcmp(*(const char **)pa, *(const char **)pb);
636 /** @brief Sorts a dynar of strings (ie, char* data) */
637 xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
639 xbt_dynar_sort(dynar, strcmp_voidp);
640 return dynar; // to enable functional uses
643 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
644 * Since there are only three colors, it is linear and much faster than a classical sort.
645 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
647 * \param dynar the dynar to sort
648 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to be 0, 1, or 2.
650 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the end and elements with color 1 are in the middle.
652 * Remark: if the elements stored in the dynar are structures, the color
653 * function has to retrieve the field to sort first.
655 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
659 unsigned long int p = -1;
660 unsigned long int q = dynar->used;
661 const unsigned long elmsize = dynar->elmsize;
662 void *tmp = xbt_malloc(elmsize);
665 for (i = 0; i < q;) {
666 void *elmi = _xbt_dynar_elm(dynar, i);
667 int colori = color(elmi);
673 elm = _xbt_dynar_elm(dynar, ++p);
675 } else { /* colori == 2 */
676 elm = _xbt_dynar_elm(dynar, --q);
679 memcpy(tmp, elm, elmsize);
680 memcpy(elm, elmi, elmsize);
681 memcpy(elmi, tmp, elmsize);
688 /** @brief Transform a dynar into a NULL terminated array.
690 * \param dynar the dynar to transform
691 * \return pointer to the first element of the array
693 * Note: The dynar won't be usable afterwards.
695 inline void *xbt_dynar_to_array(xbt_dynar_t dynar)
698 xbt_dynar_shrink(dynar, 1);
699 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
705 /** @brief Compare two dynars
707 * \param d1 first dynar to compare
708 * \param d2 second dynar to compare
709 * \param compar function to use to compare elements
710 * \return 0 if d1 and d2 are equal and 1 if not equal
712 * d1 and d2 should be dynars of pointers. The compar function takes two
713 * elements and returns 0 when they are considered equal, and a value different
714 * of zero when they are considered different. Finally, d2 is destroyed
717 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
718 int(*compar)(const void *, const void *))
722 if((!d1) && (!d2)) return 0;
725 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
729 if((d1->elmsize)!=(d2->elmsize))
731 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
735 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
737 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
742 size = xbt_dynar_length(d1);
745 void *data1 = xbt_dynar_get_as(d1, i, void *);
746 void *data2 = xbt_dynar_get_as(d2, i, void *);
747 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
748 if(compar(data1,data2)){
761 XBT_TEST_SUITE("dynar", "Dynar data container");
762 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
764 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
766 /* Vars_decl [doxygen cruft] */
772 xbt_test_add("==== Traverse the empty dynar");
773 d = xbt_dynar_new(sizeof(int), NULL);
774 xbt_dynar_foreach(d, cursor, i) {
775 xbt_die( "Damnit, there is something in the empty dynar");
777 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
778 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
779 /* in your code is naturally the way to go outside a regression test */
782 ("==== Push %d int, set them again 3 times, traverse them, shift them",
784 /* Populate_ints [doxygen cruft] */
785 /* 1. Populate the dynar */
786 d = xbt_dynar_new(sizeof(int), NULL);
787 for (cpt = 0; cpt < NB_ELEM; cpt++) {
788 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
789 /* xbt_dynar_push(d,&cpt); This would also work */
790 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
793 /* 2. Traverse manually the dynar */
794 for (cursor = 0; cursor < NB_ELEM; cursor++) {
795 iptr = xbt_dynar_get_ptr(d, cursor);
796 xbt_test_assert(cursor == *iptr,
797 "The retrieved value is not the same than the injected one (%u!=%d)",
801 /* 3. Traverse the dynar using the neat macro to that extend */
802 xbt_dynar_foreach(d, cursor, cpt) {
803 xbt_test_assert(cursor == cpt,
804 "The retrieved value is not the same than the injected one (%u!=%d)",
807 /* end_of_traversal */
809 for (cpt = 0; cpt < NB_ELEM; cpt++)
810 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
812 for (cpt = 0; cpt < NB_ELEM; cpt++)
813 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
814 /* xbt_dynar_set(d,cpt,&cpt); */
816 for (cpt = 0; cpt < NB_ELEM; cpt++)
817 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
820 xbt_dynar_foreach(d, cursor, i) {
821 xbt_test_assert(i == cpt,
822 "The retrieved value is not the same than the injected one (%d!=%d)",
826 xbt_test_assert(cpt == NB_ELEM,
827 "Cannot retrieve my %d values. Last got one is %d",
830 /* shifting [doxygen cruft] */
831 /* 4. Shift all the values */
832 for (cpt = 0; cpt < NB_ELEM; cpt++) {
833 xbt_dynar_shift(d, &i);
834 xbt_test_assert(i == cpt,
835 "The retrieved value is not the same than the injected one (%d!=%d)",
837 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
841 xbt_dynar_foreach_ptr(d, cursor, pi) {
844 xbt_dynar_foreach(d, cursor, i) {
845 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
847 xbt_dynar_foreach_ptr(d, cursor, pi) {
850 xbt_dynar_foreach(d, cursor, i) {
851 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
854 /* 5. Free the resources */
855 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
856 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
857 /* in your code is naturally the way to go outside a regression test */
859 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
860 d = xbt_dynar_new(sizeof(int), NULL);
861 for (cpt = 0; cpt < NB_ELEM; cpt++) {
862 xbt_dynar_unshift(d, &cpt);
863 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
865 for (cpt = 0; cpt < NB_ELEM; cpt++) {
866 i = xbt_dynar_pop_as(d, int);
867 xbt_test_assert(i == cpt,
868 "The retrieved value is not the same than the injected one (%d!=%d)",
870 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
872 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
873 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
874 /* in your code is naturally the way to go outside a regression test */
878 ("==== Push %d int, insert 1000 int in the middle, shift everything",
880 d = xbt_dynar_new(sizeof(int), NULL);
881 for (cpt = 0; cpt < NB_ELEM; cpt++) {
882 xbt_dynar_push_as(d, int, cpt);
883 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
885 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
886 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
887 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
890 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
891 xbt_dynar_shift(d, &i);
892 xbt_test_assert(i == cpt,
893 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
895 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
897 for (cpt = 999; cpt >= 0; cpt--) {
898 xbt_dynar_shift(d, &i);
899 xbt_test_assert(i == cpt,
900 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
903 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
904 xbt_dynar_shift(d, &i);
905 xbt_test_assert(i == cpt,
906 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
909 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
910 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
911 /* in your code is naturally the way to go outside a regression test */
913 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
915 d = xbt_dynar_new(sizeof(int), NULL);
916 for (cpt = 0; cpt < NB_ELEM; cpt++)
917 xbt_dynar_push_as(d, int, cpt);
919 for (cpt = 2000; cpt < 4000; cpt++) {
920 xbt_dynar_remove_at(d, 2000, &i);
921 xbt_test_assert(i == cpt,
922 "Remove a bad value. Got %d, expected %d", i, cpt);
923 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
925 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
926 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
927 /* in your code is naturally the way to go outside a regression test */
930 /*******************************************************************************/
931 /*******************************************************************************/
932 /*******************************************************************************/
933 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
935 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
939 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
940 /* Populate_ints [doxygen cruft] */
941 /* 1. Populate the dynar */
942 for (cpt = 0; cpt < NB_ELEM; cpt++) {
943 xbt_dynar_insert_at(d, cpt, &cpt);
944 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
947 /* 3. Traverse the dynar */
948 xbt_dynar_foreach(d, cursor, cpt) {
949 xbt_test_assert(cursor == cpt,
950 "The retrieved value is not the same than the injected one (%u!=%d)",
953 /* end_of_traversal */
955 /* Re-fill with the same values using set_as (and re-verify) */
956 for (cpt = 0; cpt < NB_ELEM; cpt++)
957 xbt_dynar_set_as(d, cpt, int, cpt);
958 xbt_dynar_foreach(d, cursor, cpt)
959 xbt_test_assert(cursor == cpt,
960 "The retrieved value is not the same than the injected one (%u!=%d)",
963 for (cpt = 0; cpt < NB_ELEM; cpt++) {
965 xbt_dynar_remove_at(d,0,&val);
966 xbt_test_assert(cpt == val,
967 "The retrieved value is not the same than the injected one (%u!=%d)",
970 xbt_test_assert(xbt_dynar_is_empty(d),
971 "There is still %lu elements in the dynar after removing everything",
972 xbt_dynar_length(d));
975 /* ********************* */
976 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
977 d = xbt_dynar_new(sizeof(int), NULL);
978 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
979 xbt_dynar_replace(d, cpt, &cpt);
980 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
983 /* 3. Traverse the dynar */
984 xbt_dynar_foreach(d, cursor, cpt) {
985 xbt_test_assert(cursor == cpt,
986 "The retrieved value is not the same than the injected one (%u!=%d)",
989 /* end_of_traversal */
991 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
993 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
994 xbt_test_assert(cpt == val,
995 "The retrieved value is not the same than the injected one (%u!=%d)",
998 xbt_test_assert(xbt_dynar_is_empty(d),
999 "There is still %lu elements in the dynar after removing everything",
1000 xbt_dynar_length(d));
1004 /*******************************************************************************/
1005 /*******************************************************************************/
1006 /*******************************************************************************/
1007 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1011 unsigned int cursor;
1014 xbt_test_add("==== Traverse the empty dynar");
1015 d = xbt_dynar_new(sizeof(int), NULL);
1016 xbt_dynar_foreach(d, cursor, cpt) {
1017 xbt_test_assert(FALSE,
1018 "Damnit, there is something in the empty dynar");
1020 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1021 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1022 /* in your code is naturally the way to go outside a regression test */
1024 xbt_test_add("==== Push/shift 5000 doubles");
1025 d = xbt_dynar_new(sizeof(double), NULL);
1026 for (cpt = 0; cpt < 5000; cpt++) {
1028 xbt_dynar_push(d, &d1);
1030 xbt_dynar_foreach(d, cursor, d2) {
1031 d1 = (double) cursor;
1032 xbt_test_assert(d1 == d2,
1033 "The retrieved value is not the same than the injected one (%f!=%f)",
1036 for (cpt = 0; cpt < 5000; cpt++) {
1038 xbt_dynar_shift(d, &d2);
1039 xbt_test_assert(d1 == d2,
1040 "The retrieved value is not the same than the injected one (%f!=%f)",
1043 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1044 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1045 /* in your code is naturally the way to go outside a regression test */
1047 xbt_test_add("==== Unshift/pop 5000 doubles");
1048 d = xbt_dynar_new(sizeof(double), NULL);
1049 for (cpt = 0; cpt < 5000; cpt++) {
1051 xbt_dynar_unshift(d, &d1);
1053 for (cpt = 0; cpt < 5000; cpt++) {
1055 xbt_dynar_pop(d, &d2);
1056 xbt_test_assert(d1 == d2,
1057 "The retrieved value is not the same than the injected one (%f!=%f)",
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 */
1067 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1068 d = xbt_dynar_new(sizeof(double), NULL);
1069 for (cpt = 0; cpt < 5000; cpt++) {
1071 xbt_dynar_push(d, &d1);
1073 for (cpt = 0; cpt < 1000; cpt++) {
1075 xbt_dynar_insert_at(d, 2500, &d1);
1078 for (cpt = 0; cpt < 2500; cpt++) {
1080 xbt_dynar_shift(d, &d2);
1081 xbt_test_assert(d1 == d2,
1082 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1084 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1086 for (cpt = 999; cpt >= 0; cpt--) {
1088 xbt_dynar_shift(d, &d2);
1089 xbt_test_assert(d1 == d2,
1090 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1093 for (cpt = 2500; cpt < 5000; cpt++) {
1095 xbt_dynar_shift(d, &d2);
1096 xbt_test_assert(d1 == d2,
1097 "The retrieved value is not the same than the injected one at the end (%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 */
1105 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1106 d = xbt_dynar_new(sizeof(double), NULL);
1107 for (cpt = 0; cpt < 5000; cpt++) {
1109 xbt_dynar_push(d, &d1);
1111 for (cpt = 2000; cpt < 4000; cpt++) {
1113 xbt_dynar_remove_at(d, 2000, &d2);
1114 xbt_test_assert(d1 == d2,
1115 "Remove a bad value. Got %f, expected %f", d2, d1);
1117 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1118 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1119 /* in your code is naturally the way to go outside a regression test */
1123 /* doxygen_string_cruft */
1125 /*******************************************************************************/
1126 /*******************************************************************************/
1127 /*******************************************************************************/
1128 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1136 xbt_test_add("==== Traverse the empty dynar");
1137 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1138 xbt_dynar_foreach(d, iter, s1) {
1139 xbt_test_assert(FALSE,
1140 "Damnit, there is something in the empty dynar");
1142 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1143 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1144 /* in your code is naturally the way to go outside a regression test */
1146 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1148 /* Populate_str [doxygen cruft] */
1149 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1150 /* 1. Populate the dynar */
1151 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1152 sprintf(buf, "%d", cpt);
1153 s1 = xbt_strdup(buf);
1154 xbt_dynar_push(d, &s1);
1156 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1157 sprintf(buf, "%d", cpt);
1158 s1 = xbt_strdup(buf);
1159 xbt_dynar_replace(d, cpt, &s1);
1161 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1162 sprintf(buf, "%d", cpt);
1163 s1 = xbt_strdup(buf);
1164 xbt_dynar_replace(d, cpt, &s1);
1166 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1167 sprintf(buf, "%d", cpt);
1168 s1 = xbt_strdup(buf);
1169 xbt_dynar_replace(d, cpt, &s1);
1171 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1172 sprintf(buf, "%d", cpt);
1173 xbt_dynar_shift(d, &s2);
1174 xbt_test_assert(!strcmp(buf, s2),
1175 "The retrieved value is not the same than the injected one (%s!=%s)",
1179 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1180 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1181 /* in your code is naturally the way to go outside a regression test */
1183 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1184 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1185 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1186 sprintf(buf, "%d", cpt);
1187 s1 = xbt_strdup(buf);
1188 xbt_dynar_unshift(d, &s1);
1190 /* 2. Traverse the dynar with the macro */
1191 xbt_dynar_foreach(d, iter, s1) {
1192 sprintf(buf, "%u", NB_ELEM - iter - 1);
1193 xbt_test_assert(!strcmp(buf, s1),
1194 "The retrieved value is not the same than the injected one (%s!=%s)",
1197 /* 3. Traverse the dynar with the macro */
1198 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1199 sprintf(buf, "%d", cpt);
1200 xbt_dynar_pop(d, &s2);
1201 xbt_test_assert(!strcmp(buf, s2),
1202 "The retrieved value is not the same than the injected one (%s!=%s)",
1206 /* 4. Free the resources */
1207 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1208 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1209 /* in your code is naturally the way to go outside a regression test */
1213 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1214 NB_ELEM, NB_ELEM / 5);
1215 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1216 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1217 sprintf(buf, "%d", cpt);
1218 s1 = xbt_strdup(buf);
1219 xbt_dynar_push(d, &s1);
1221 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1222 sprintf(buf, "%d", cpt);
1223 s1 = xbt_strdup(buf);
1224 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1227 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1228 sprintf(buf, "%d", cpt);
1229 xbt_dynar_shift(d, &s2);
1230 xbt_test_assert(!strcmp(buf, s2),
1231 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1235 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1236 sprintf(buf, "%d", cpt);
1237 xbt_dynar_shift(d, &s2);
1238 xbt_test_assert(!strcmp(buf, s2),
1239 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1243 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1244 sprintf(buf, "%d", cpt);
1245 xbt_dynar_shift(d, &s2);
1246 xbt_test_assert(!strcmp(buf, s2),
1247 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1251 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1252 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1253 /* in your code is naturally the way to go outside a regression test */
1256 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1257 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1258 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1259 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1260 sprintf(buf, "%d", cpt);
1261 s1 = xbt_strdup(buf);
1262 xbt_dynar_push(d, &s1);
1264 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1265 sprintf(buf, "%d", cpt);
1266 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1267 xbt_test_assert(!strcmp(buf, s2),
1268 "Remove a bad value. Got %s, expected %s", s2, buf);
1271 xbt_dynar_free(&d); /* end_of_doxygen */
1273 #endif /* SIMGRID_TEST */