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"
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
19 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
21 xbt_assert(dynar, "dynar is nullptr");
24 static inline void _sanity_check_idx(int idx)
26 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
29 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
31 if (idx < 0 || idx >= (int)dynar->used) {
32 THROWF(bound_error, idx, "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);
44 static inline void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
46 if (new_size != dynar->size) {
47 dynar->size = new_size;
48 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
52 static inline void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
54 const unsigned long old_size = dynar->size;
57 const unsigned long expand = 2 * (old_size + 1);
58 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
59 XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, dynar->size);
63 static inline void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
65 char *const data = (char *) dynar->data;
66 const unsigned long elmsize = dynar->elmsize;
68 return data + idx * elmsize;
71 static inline void _xbt_dynar_get_elm(void *const dst, const xbt_dynar_t dynar, const unsigned long idx)
73 void *const elm = _xbt_dynar_elm(dynar, idx);
75 memcpy(dst, elm, dynar->elmsize);
78 void xbt_dynar_dump(xbt_dynar_t dynar)
80 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
81 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
84 /** @brief Constructor
86 * \param elmsize size of each element in the dynar
87 * \param free_f function to call each time we want to get rid of an element (or nullptr if nothing to do).
89 * Creates a new dynar. If a free_func is provided, the elements have to be pointer of pointer. That is to say that
90 * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
92 xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
94 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
98 dynar->elmsize = elmsize;
99 dynar->data = nullptr;
100 dynar->free_f = free_f;
105 /** @brief Destructor of the structure not touching to the content
107 * \param dynar poor victim
109 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the \a free_f function
112 void xbt_dynar_free_container(xbt_dynar_t * dynar)
114 if (dynar && *dynar) {
115 xbt_dynar_t d = *dynar;
122 /** @brief Frees the content and set the size to 0
124 * \param dynar who to squeeze
126 void xbt_dynar_reset(xbt_dynar_t const dynar)
128 _sanity_check_dynar(dynar);
130 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
132 xbt_dynar_map(dynar, dynar->free_f);
137 /** @brief Merge dynar d2 into d1
139 * \param d1 dynar to keep
140 * \param d2 dynar to merge into d1. This dynar is free at end.
142 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
144 if((*d1)->elmsize != (*d2)->elmsize)
145 xbt_die("Element size must are not equal");
147 const unsigned long elmsize = (*d1)->elmsize;
149 void *ptr = _xbt_dynar_elm((*d2), 0);
150 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
151 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
153 memcpy(elm, ptr, ((*d2)->size)*elmsize);
154 (*d1)->used += (*d2)->used;
160 * \brief Shrink the dynar by removing empty slots at the end of the internal array
161 * \param dynar a dynar
162 * \param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
165 * Reduces the internal array size of the dynar to the number of elements plus \a empty_slots_wanted.
166 * After removing elements from the dynar, you can call this function to make the dynar use less memory.
167 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
168 * Note that if \a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
170 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
172 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
175 /** @brief Destructor
177 * \param dynar poor victim
179 * kilkil a dynar and its content
181 void xbt_dynar_free(xbt_dynar_t * dynar)
183 if (dynar && *dynar) {
184 xbt_dynar_reset(*dynar);
185 xbt_dynar_free_container(dynar);
189 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
190 void xbt_dynar_free_voidp(void *d)
192 xbt_dynar_t dynar = (xbt_dynar_t)d;
193 xbt_dynar_free(&dynar);
196 /** @brief Count of dynar's elements
198 * \param dynar the dynar we want to mesure
200 unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
202 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
205 /**@brief check if a dynar is empty
207 *\param dynar the dynat we want to check
210 int xbt_dynar_is_empty(const xbt_dynar_t dynar)
212 return (xbt_dynar_length(dynar) == 0);
215 /** @brief Retrieve a copy of the Nth element of a dynar.
217 * \param dynar information dealer
218 * \param idx index of the slot we want to retrieve
219 * \param[out] dst where to put the result to.
221 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void *const dst)
223 _sanity_check_dynar(dynar);
224 _check_inbound_idx(dynar, idx);
226 _xbt_dynar_get_elm(dst, dynar, idx);
229 /** @brief Retrieve a pointer to the Nth element of a dynar.
231 * \param dynar information dealer
232 * \param idx index of the slot we want to retrieve
233 * \return the \a idx-th element of \a dynar.
235 * \warning The returned value is the actual content of the dynar.
236 * Make a copy before fooling with it.
238 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
241 _sanity_check_dynar(dynar);
242 _check_inbound_idx(dynar, idx);
244 res = _xbt_dynar_elm(dynar, idx);
248 void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
250 _sanity_check_dynar(dynar);
252 if (idx >= dynar->used) {
253 _xbt_dynar_expand(dynar, idx + 1);
254 if (idx > dynar->used) {
255 memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
257 dynar->used = idx + 1;
259 return _xbt_dynar_elm(dynar, idx);
262 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
264 * \param dynar information dealer
265 * \param idx index of the slot we want to modify
266 * \param src What will be feeded to the dynar
268 * If you want to free the previous content, use xbt_dynar_replace().
270 void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *const src)
272 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
275 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
281 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
282 * you don't want to free the previous content, use xbt_dynar_set().
284 void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *const object)
286 _sanity_check_dynar(dynar);
288 if (idx < dynar->used && dynar->free_f) {
289 void *const old_object = _xbt_dynar_elm(dynar, idx);
291 dynar->free_f(old_object);
294 xbt_dynar_set(dynar, idx, object);
297 /** @brief Make room for a new element, and return a pointer to it
299 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
300 * xbt_dynar_insert_at_as() does.
302 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
305 unsigned long old_used;
306 unsigned long new_used;
309 _sanity_check_dynar(dynar);
310 _sanity_check_idx(idx);
312 old_used = dynar->used;
313 new_used = old_used + 1;
315 _xbt_dynar_expand(dynar, new_used);
317 nb_shift = old_used - idx;
320 memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
323 dynar->used = new_used;
324 res = _xbt_dynar_elm(dynar, idx);
328 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
330 * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
331 * subsequent ones to one position right in the dynar.
333 void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *const src)
335 /* checks done in xbt_dynar_insert_at_ptr */
336 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
339 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
341 * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
344 * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
345 * the element is freed using the free_f function passed at dynar creation.
347 void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void *const object)
349 unsigned long nb_shift;
350 unsigned long offset;
352 _sanity_check_dynar(dynar);
353 _check_inbound_idx(dynar, idx);
356 _xbt_dynar_get_elm(object, dynar, idx);
357 } else if (dynar->free_f) {
358 dynar->free_f(_xbt_dynar_elm(dynar, idx));
361 nb_shift = dynar->used - 1 - idx;
364 offset = nb_shift * dynar->elmsize;
365 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
371 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
373 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
374 * nullptr object argument if n equals to 1.
376 * Each of the removed elements is freed using the free_f function passed at dynar creation.
378 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
380 unsigned long nb_shift;
381 unsigned long offset;
386 _sanity_check_dynar(dynar);
387 _check_inbound_idx(dynar, idx);
388 _check_inbound_idx(dynar, idx + n - 1);
391 for (cur = idx; cur < idx + n; cur++) {
392 dynar->free_f(_xbt_dynar_elm(dynar, cur));
396 nb_shift = dynar->used - n - idx;
399 offset = nb_shift * dynar->elmsize;
400 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
406 /** @brief Returns the position of the element in the dynar
408 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
409 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
412 * signed int position = -1;
413 * xbt_dynar_foreach(dynar, iter, elem) {
414 * if (!memcmp(elem, searched_element, sizeof(*elem))) {
421 * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
422 * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
424 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
428 for (it = 0; it < dynar->used; it++)
429 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
433 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
434 return -1; // Won't happen, just to please eclipse
437 /** @brief Returns the position of the element in the dynar (or -1 if not found)
439 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
440 * what you want. Check the documentation of xbt_dynar_search() for more info.
442 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
443 * this very function will not work (but the other will).
445 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
449 for (it = 0; it < dynar->used; it++)
450 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
457 /** @brief Returns a boolean indicating whether the element is part of the dynar
459 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
460 * what you want. Check the documentation of xbt_dynar_search() for more info.
462 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
466 for (it = 0; it < dynar->used; it++)
467 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
474 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
476 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
477 * xbt_dynar_push_as() does.
479 void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
481 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
484 /** @brief Add an element at the end of the dynar */
485 void xbt_dynar_push(xbt_dynar_t const dynar, const void *const src)
487 /* checks done in xbt_dynar_insert_at_ptr */
488 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
491 /** @brief Mark the last dynar's element as unused and return a pointer to it.
493 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
494 * xbt_dynar_pop_as() does.
496 void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
498 _check_populated_dynar(dynar);
499 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
501 return _xbt_dynar_elm(dynar, dynar->used);
504 /** @brief Get and remove the last element of the dynar */
505 void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
507 /* sanity checks done by remove_at */
508 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
509 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
512 /** @brief Add an element at the begining of the dynar.
514 * This is less efficient than xbt_dynar_push()
516 void xbt_dynar_unshift(xbt_dynar_t const dynar, const void *const src)
518 /* sanity checks done by insert_at */
519 xbt_dynar_insert_at(dynar, 0, src);
522 /** @brief Get and remove the first element of the dynar.
524 * This is less efficient than xbt_dynar_pop()
526 void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
528 /* sanity checks done by remove_at */
529 xbt_dynar_remove_at(dynar, 0, dst);
532 /** @brief Apply a function to each member of a dynar
534 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
536 void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
538 char *const data = (char *) dynar->data;
539 const unsigned long elmsize = dynar->elmsize;
540 const unsigned long used = dynar->used;
543 _sanity_check_dynar(dynar);
545 for (i = 0; i < used; i++) {
546 char* elm = (char*) data + i * elmsize;
551 /** @brief Removes and free the entry pointed by the cursor
553 * This function can be used while traversing without problem.
555 void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor)
557 xbt_dynar_remove_at(dynar, (*cursor)--, nullptr);
560 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
562 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
563 * You should thus refer to the libc documentation, or to some online tutorial on how to write
564 * a comparison function. Here is a quick example if you have integers in your dynar:
567 * int cmpfunc (const void * a, const void * b) {
568 * int intA = *(int*)a;
569 * int intB = *(int*)b;
570 * return intA - intB;
574 * and now to sort a dynar of MSG hosts depending on their speed:
576 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
577 * MSG_host_t hostA = *(MSG_host_t*)a;
578 * MSG_host_t hostB = *(MSG_host_t*)b;
579 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
583 * \param dynar the dynar to sort
584 * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
586 void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
588 if (dynar->data != nullptr)
589 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
592 static int strcmp_voidp(const void *pa, const void *pb) {
593 return strcmp(*(const char **)pa, *(const char **)pb);
596 /** @brief Sorts a dynar of strings (ie, char* data) */
597 xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
599 xbt_dynar_sort(dynar, strcmp_voidp);
600 return dynar; // to enable functional uses
603 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
604 * Since there are only three colors, it is linear and much faster than a classical sort.
605 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
607 * \param dynar the dynar to sort
608 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to
611 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the
612 * end and elements with color 1 are in the middle.
614 * Remark: if the elements stored in the dynar are structures, the color function has to retrieve the field to sort
617 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color)
620 unsigned long int p = -1;
621 unsigned long int q = dynar->used;
622 const unsigned long elmsize = dynar->elmsize;
623 void *tmp = xbt_malloc(elmsize);
626 for (i = 0; i < q;) {
627 void *elmi = _xbt_dynar_elm(dynar, i);
628 int colori = color(elmi);
634 elm = _xbt_dynar_elm(dynar, ++p);
636 } else { /* colori == 2 */
637 elm = _xbt_dynar_elm(dynar, --q);
640 memcpy(tmp, elm, elmsize);
641 memcpy(elm, elmi, elmsize);
642 memcpy(elmi, tmp, elmsize);
649 /** @brief Transform a dynar into a nullptr terminated array.
651 * \param dynar the dynar to transform
652 * \return pointer to the first element of the array
654 * Note: The dynar won't be usable afterwards.
656 void *xbt_dynar_to_array(xbt_dynar_t dynar)
659 xbt_dynar_shrink(dynar, 1);
660 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
666 /** @brief Compare two dynars
668 * \param d1 first dynar to compare
669 * \param d2 second dynar to compare
670 * \param compar function to use to compare elements
671 * \return 0 if d1 and d2 are equal and 1 if not equal
673 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
674 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
677 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int(*compar)(const void *, const void *))
681 if((!d1) && (!d2)) return 0;
684 XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
688 if((d1->elmsize)!=(d2->elmsize)) {
689 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
693 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
694 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
699 size = xbt_dynar_length(d1);
700 for(i=0;i<size;i++) {
701 void *data1 = xbt_dynar_get_as(d1, i, void *);
702 void *data2 = xbt_dynar_get_as(d2, i, void *);
703 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
704 if(compar(data1,data2)){
717 XBT_TEST_SUITE("dynar", "Dynar data container");
718 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
720 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
722 /* Vars_decl [doxygen cruft] */
727 xbt_test_add("==== Traverse the empty dynar");
728 xbt_dynar_t d = xbt_dynar_new(sizeof(int), nullptr);
729 xbt_dynar_foreach(d, cursor, i) {
730 xbt_die( "Damnit, there is something in the empty dynar");
732 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
733 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
734 /* in your code is naturally the way to go outside a regression test */
736 xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
737 /* Populate_ints [doxygen cruft] */
738 /* 1. Populate the dynar */
739 d = xbt_dynar_new(sizeof(int), nullptr);
740 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
741 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
742 /* xbt_dynar_push(d,&cpt); This would also work */
743 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
746 /* 2. Traverse manually the dynar */
747 for (cursor = 0; cursor < NB_ELEM; cursor++) {
748 iptr = (int*) xbt_dynar_get_ptr(d, cursor);
749 xbt_test_assert(cursor == (unsigned int)*iptr, "The retrieved value is not the same than the injected one (%u!=%d)",
753 /* 3. Traverse the dynar using the neat macro to that extend */
755 xbt_dynar_foreach(d, cursor, cpt) {
756 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
758 /* end_of_traversal */
760 for (int cpt = 0; cpt < NB_ELEM; cpt++)
761 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
763 for (int cpt = 0; cpt < NB_ELEM; cpt++)
764 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
765 /* xbt_dynar_set(d,cpt,&cpt); */
767 for (int cpt = 0; cpt < NB_ELEM; cpt++)
768 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
771 xbt_dynar_foreach(d, cursor, i) {
772 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
775 xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
777 /* shifting [doxygen cruft] */
778 /* 4. Shift all the values */
779 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
780 xbt_dynar_shift(d, &i);
781 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
782 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
786 xbt_dynar_foreach_ptr(d, cursor, pi) {
789 xbt_dynar_foreach(d, cursor, i) {
790 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
792 xbt_dynar_foreach_ptr(d, cursor, pi) {
795 xbt_dynar_foreach(d, cursor, i) {
796 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
799 /* 5. Free the resources */
800 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
801 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
802 /* in your code is naturally the way to go outside a regression test */
804 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
805 d = xbt_dynar_new(sizeof(int), nullptr);
806 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
807 xbt_dynar_unshift(d, &cpt);
808 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
810 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
811 i = xbt_dynar_pop_as(d, int);
812 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
813 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
815 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
816 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
817 /* in your code is naturally the way to go outside a regression test */
819 xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
820 d = xbt_dynar_new(sizeof(int), nullptr);
821 for (cpt = 0; cpt < NB_ELEM; cpt++) {
822 xbt_dynar_push_as(d, int, cpt);
823 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
825 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
826 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
827 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
830 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
831 xbt_dynar_shift(d, &i);
832 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
834 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
836 for (cpt = 999; cpt >= 0; cpt--) {
837 xbt_dynar_shift(d, &i);
838 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
841 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
842 xbt_dynar_shift(d, &i);
843 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
845 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
846 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
847 /* in your code is naturally the way to go outside a regression test */
849 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
850 d = xbt_dynar_new(sizeof(int), nullptr);
851 for (cpt = 0; cpt < NB_ELEM; cpt++)
852 xbt_dynar_push_as(d, int, cpt);
854 for (cpt = 2000; cpt < 4000; cpt++) {
855 xbt_dynar_remove_at(d, 2000, &i);
856 xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
857 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
859 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
860 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
861 /* in your code is naturally the way to go outside a regression test */
864 /*******************************************************************************/
865 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
867 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), nullptr);
870 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
871 /* Populate_ints [doxygen cruft] */
872 /* 1. Populate the dynar */
873 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
874 xbt_dynar_insert_at(d, cpt, &cpt);
875 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
878 /* 3. Traverse the dynar */
880 xbt_dynar_foreach(d, cursor, cpt) {
881 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
883 /* end_of_traversal */
885 /* Re-fill with the same values using set_as (and re-verify) */
886 for (int cpt = 0; cpt < NB_ELEM; cpt++)
887 xbt_dynar_set_as(d, cpt, int, cpt);
888 xbt_dynar_foreach(d, cursor, cpt)
889 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
891 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
893 xbt_dynar_remove_at(d,0,&val);
894 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
896 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
897 xbt_dynar_length(d));
900 /* ********************* */
901 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
902 d = xbt_dynar_new(sizeof(int), nullptr);
903 for (int cpt = NB_ELEM - 1; cpt >= 0; cpt--) {
904 xbt_dynar_replace(d, cpt, &cpt);
905 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
908 /* 3. Traverse the dynar */
909 xbt_dynar_foreach(d, cursor, cpt) {
910 xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
912 /* end_of_traversal */
914 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
916 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
917 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
919 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
920 xbt_dynar_length(d));
924 /*******************************************************************************/
925 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
932 xbt_test_add("==== Traverse the empty dynar");
933 d = xbt_dynar_new(sizeof(int), nullptr);
934 xbt_dynar_foreach(d, cursor, cpt) {
935 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
937 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
938 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
939 /* in your code is naturally the way to go outside a regression test */
941 xbt_test_add("==== Push/shift 5000 doubles");
942 d = xbt_dynar_new(sizeof(double), nullptr);
943 for (cpt = 0; cpt < 5000; cpt++) {
945 xbt_dynar_push(d, &d1);
947 xbt_dynar_foreach(d, cursor, d2) {
948 d1 = (double) cursor;
949 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
951 for (cpt = 0; cpt < 5000; cpt++) {
953 xbt_dynar_shift(d, &d2);
954 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
956 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
957 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
958 /* in your code is naturally the way to go outside a regression test */
960 xbt_test_add("==== Unshift/pop 5000 doubles");
961 d = xbt_dynar_new(sizeof(double), nullptr);
962 for (cpt = 0; cpt < 5000; cpt++) {
964 xbt_dynar_unshift(d, &d1);
966 for (cpt = 0; cpt < 5000; cpt++) {
968 xbt_dynar_pop(d, &d2);
969 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
971 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
972 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
973 /* in your code is naturally the way to go outside a regression test */
975 xbt_test_add("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
976 d = xbt_dynar_new(sizeof(double), nullptr);
977 for (cpt = 0; cpt < 5000; cpt++) {
979 xbt_dynar_push(d, &d1);
981 for (cpt = 0; cpt < 1000; cpt++) {
983 xbt_dynar_insert_at(d, 2500, &d1);
986 for (cpt = 0; cpt < 2500; cpt++) {
988 xbt_dynar_shift(d, &d2);
989 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
991 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
993 for (cpt = 999; cpt >= 0; cpt--) {
995 xbt_dynar_shift(d, &d2);
996 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
999 for (cpt = 2500; cpt < 5000; cpt++) {
1001 xbt_dynar_shift(d, &d2);
1002 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1004 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1005 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1006 /* in your code is naturally the way to go outside a regression test */
1008 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1009 d = xbt_dynar_new(sizeof(double), nullptr);
1010 for (cpt = 0; cpt < 5000; cpt++) {
1012 xbt_dynar_push(d, &d1);
1014 for (cpt = 2000; cpt < 4000; cpt++) {
1016 xbt_dynar_remove_at(d, 2000, &d2);
1017 xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1019 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1020 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1021 /* in your code is naturally the way to go outside a regression test */
1024 /* doxygen_string_cruft */
1026 /*******************************************************************************/
1027 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1033 xbt_test_add("==== Traverse the empty dynar");
1034 xbt_dynar_t d = xbt_dynar_new(sizeof(char*), &xbt_free_ref);
1035 xbt_dynar_foreach(d, iter, s1) {
1036 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
1038 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1039 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1040 /* in your code is naturally the way to go outside a regression test */
1042 xbt_test_add("==== Push %d strings, set them again 3 times, shift them", NB_ELEM);
1043 /* Populate_str [doxygen cruft] */
1044 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1045 /* 1. Populate the dynar */
1046 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1047 snprintf(buf,1023, "%d", cpt);
1048 s1 = xbt_strdup(buf);
1049 xbt_dynar_push(d, &s1);
1051 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1052 snprintf(buf,1023, "%d", cpt);
1053 s1 = xbt_strdup(buf);
1054 xbt_dynar_replace(d, cpt, &s1);
1056 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1057 snprintf(buf,1023, "%d", cpt);
1058 s1 = xbt_strdup(buf);
1059 xbt_dynar_replace(d, cpt, &s1);
1061 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1062 snprintf(buf,1023, "%d", cpt);
1063 s1 = xbt_strdup(buf);
1064 xbt_dynar_replace(d, cpt, &s1);
1066 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1067 snprintf(buf,1023, "%d", cpt);
1068 xbt_dynar_shift(d, &s2);
1069 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1072 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1073 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1074 /* in your code is naturally the way to go outside a regression test */
1076 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1077 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1078 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1079 snprintf(buf,1023, "%d", cpt);
1080 s1 = xbt_strdup(buf);
1081 xbt_dynar_unshift(d, &s1);
1083 /* 2. Traverse the dynar with the macro */
1084 xbt_dynar_foreach(d, iter, s1) {
1085 snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1086 xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1088 /* 3. Traverse the dynar with the macro */
1089 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1090 snprintf(buf,1023, "%d", cpt);
1091 xbt_dynar_pop(d, &s2);
1092 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1095 /* 4. Free the resources */
1096 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1097 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1098 /* in your code is naturally the way to go outside a regression test */
1100 xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1101 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1102 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1103 snprintf(buf,1023, "%d", cpt);
1104 s1 = xbt_strdup(buf);
1105 xbt_dynar_push(d, &s1);
1107 for (int cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1108 snprintf(buf,1023, "%d", cpt);
1109 s1 = xbt_strdup(buf);
1110 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1113 for (int cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1114 snprintf(buf,1023, "%d", cpt);
1115 xbt_dynar_shift(d, &s2);
1116 xbt_test_assert(!strcmp(buf, s2),
1117 "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1120 for (int cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1121 snprintf(buf,1023, "%d", cpt);
1122 xbt_dynar_shift(d, &s2);
1123 xbt_test_assert(!strcmp(buf, s2),
1124 "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1127 for (int cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1128 snprintf(buf,1023, "%d", cpt);
1129 xbt_dynar_shift(d, &s2);
1130 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1134 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1135 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1136 /* in your code is naturally the way to go outside a regression test */
1138 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1139 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1140 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1141 snprintf(buf,1023, "%d", cpt);
1142 s1 = xbt_strdup(buf);
1143 xbt_dynar_push(d, &s1);
1145 for (int cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1146 snprintf(buf,1023, "%d", cpt);
1147 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1148 xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1151 xbt_dynar_free(&d); /* end_of_doxygen */
1153 #endif /* SIMGRID_TEST */