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", idx);
29 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
31 if (idx < 0 || idx >= static_cast<int>(dynar->used)) {
32 THROWF(bound_error, idx, "dynar is not that long. You asked %d, but it's only %lu long",
33 idx, static_cast<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 extern "C" 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 extern "C" 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 Initialize a dynar structure that was not malloc'ed
106 * This can be useful to keep temporary dynars on the stack
108 extern "C" void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, void_f_pvoid_t const free_f)
112 dynar->elmsize = elmsize;
113 dynar->data = nullptr;
114 dynar->free_f = free_f;
117 /** @brief Destroy a dynar that was created with xbt_dynar_init */
118 extern "C" void xbt_dynar_free_data(xbt_dynar_t dynar)
120 xbt_dynar_reset(dynar);
125 /** @brief Destructor of the structure not touching to the content
127 * \param dynar poor victim
129 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the \a free_f function
132 extern "C" void xbt_dynar_free_container(xbt_dynar_t* dynar)
134 if (dynar && *dynar) {
135 xbt_dynar_t d = *dynar;
142 /** @brief Frees the content and set the size to 0
144 * \param dynar who to squeeze
146 extern "C" void xbt_dynar_reset(xbt_dynar_t const dynar)
148 _sanity_check_dynar(dynar);
150 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
152 xbt_dynar_map(dynar, dynar->free_f);
157 /** @brief Merge dynar d2 into d1
159 * \param d1 dynar to keep
160 * \param d2 dynar to merge into d1. This dynar is free at end.
162 extern "C" void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2)
164 if((*d1)->elmsize != (*d2)->elmsize)
165 xbt_die("Element size must are not equal");
167 const unsigned long elmsize = (*d1)->elmsize;
169 void *ptr = _xbt_dynar_elm((*d2), 0);
170 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
171 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
173 memcpy(elm, ptr, ((*d2)->size)*elmsize);
174 (*d1)->used += (*d2)->used;
180 * \brief Shrink the dynar by removing empty slots at the end of the internal array
181 * \param dynar a dynar
182 * \param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
185 * Reduces the internal array size of the dynar to the number of elements plus \a empty_slots_wanted.
186 * After removing elements from the dynar, you can call this function to make the dynar use less memory.
187 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
188 * Note that if \a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
190 extern "C" void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
192 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
195 /** @brief Destructor
197 * \param dynar poor victim
199 * kilkil a dynar and its content
201 extern "C" void xbt_dynar_free(xbt_dynar_t* dynar)
203 if (dynar && *dynar) {
204 xbt_dynar_reset(*dynar);
205 xbt_dynar_free_container(dynar);
209 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
210 extern "C" void xbt_dynar_free_voidp(void* d)
212 xbt_dynar_t dynar = (xbt_dynar_t)d;
213 xbt_dynar_free(&dynar);
216 /** @brief Count of dynar's elements
218 * \param dynar the dynar we want to mesure
220 extern "C" unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
222 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
225 /**@brief check if a dynar is empty
227 *\param dynar the dynat we want to check
229 extern "C" int xbt_dynar_is_empty(const xbt_dynar_t dynar)
231 return (xbt_dynar_length(dynar) == 0);
234 /** @brief Retrieve a copy of the Nth element of a dynar.
236 * \param dynar information dealer
237 * \param idx index of the slot we want to retrieve
238 * \param[out] dst where to put the result to.
240 extern "C" void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void* const dst)
242 _sanity_check_dynar(dynar);
243 _check_inbound_idx(dynar, idx);
245 _xbt_dynar_get_elm(dst, dynar, idx);
248 /** @brief Retrieve a pointer to the Nth element of a dynar.
250 * \param dynar information dealer
251 * \param idx index of the slot we want to retrieve
252 * \return the \a idx-th element of \a dynar.
254 * \warning The returned value is the actual content of the dynar.
255 * Make a copy before fooling with it.
257 extern "C" void* xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
260 _sanity_check_dynar(dynar);
261 _check_inbound_idx(dynar, idx);
263 res = _xbt_dynar_elm(dynar, idx);
267 extern "C" void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
269 _sanity_check_dynar(dynar);
271 if (idx >= dynar->used) {
272 _xbt_dynar_expand(dynar, idx + 1);
273 if (idx > dynar->used) {
274 memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
276 dynar->used = idx + 1;
278 return _xbt_dynar_elm(dynar, idx);
281 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
283 * \param dynar information dealer
284 * \param idx index of the slot we want to modify
285 * \param src What will be feeded to the dynar
287 * If you want to free the previous content, use xbt_dynar_replace().
289 extern "C" void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void* const src)
291 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
294 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
300 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
301 * you don't want to free the previous content, use xbt_dynar_set().
303 extern "C" void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void* const object)
305 _sanity_check_dynar(dynar);
307 if (idx < dynar->used && dynar->free_f) {
308 void *const old_object = _xbt_dynar_elm(dynar, idx);
310 dynar->free_f(old_object);
313 xbt_dynar_set(dynar, idx, object);
316 /** @brief Make room for a new element, and return a pointer to it
318 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
319 * xbt_dynar_insert_at_as() does.
321 extern "C" void* xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
324 unsigned long old_used;
325 unsigned long new_used;
328 _sanity_check_dynar(dynar);
329 _sanity_check_idx(idx);
331 old_used = dynar->used;
332 new_used = old_used + 1;
334 _xbt_dynar_expand(dynar, new_used);
336 nb_shift = old_used - idx;
339 memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
342 dynar->used = new_used;
343 res = _xbt_dynar_elm(dynar, idx);
347 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
349 * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
350 * subsequent ones to one position right in the dynar.
352 extern "C" void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void* const src)
354 /* checks done in xbt_dynar_insert_at_ptr */
355 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
358 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
360 * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
363 * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
364 * the element is freed using the free_f function passed at dynar creation.
366 extern "C" void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void* const object)
368 unsigned long nb_shift;
369 unsigned long offset;
371 _sanity_check_dynar(dynar);
372 _check_inbound_idx(dynar, idx);
375 _xbt_dynar_get_elm(object, dynar, idx);
376 } else if (dynar->free_f) {
377 dynar->free_f(_xbt_dynar_elm(dynar, idx));
380 nb_shift = dynar->used - 1 - idx;
383 offset = nb_shift * dynar->elmsize;
384 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
390 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
392 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
393 * nullptr object argument if n equals to 1.
395 * Each of the removed elements is freed using the free_f function passed at dynar creation.
397 extern "C" void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
399 unsigned long nb_shift;
400 unsigned long offset;
406 _sanity_check_dynar(dynar);
407 _check_inbound_idx(dynar, idx);
408 _check_inbound_idx(dynar, idx + n - 1);
411 for (cur = idx; cur < idx + n; cur++) {
412 dynar->free_f(_xbt_dynar_elm(dynar, cur));
416 nb_shift = dynar->used - n - idx;
419 offset = nb_shift * dynar->elmsize;
420 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
426 /** @brief Returns the position of the element in the dynar
428 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
429 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
432 * signed int position = -1;
433 * xbt_dynar_foreach(dynar, iter, elem) {
434 * if (!memcmp(elem, searched_element, sizeof(*elem))) {
441 * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
442 * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
444 extern "C" unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* const elem)
448 for (it = 0; it < dynar->used; it++)
449 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
453 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
454 return -1; // Won't happen, just to please eclipse
457 /** @brief Returns the position of the element in the dynar (or -1 if not found)
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 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
463 * this very function will not work (but the other will).
465 extern "C" signed int xbt_dynar_search_or_negative(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)) {
477 /** @brief Returns a boolean indicating whether the element is part of the dynar
479 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
480 * what you want. Check the documentation of xbt_dynar_search() for more info.
482 extern "C" int xbt_dynar_member(xbt_dynar_t const dynar, void* const elem)
486 for (it = 0; it < dynar->used; it++)
487 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
494 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
496 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
497 * xbt_dynar_push_as() does.
499 extern "C" void* xbt_dynar_push_ptr(xbt_dynar_t const dynar)
501 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
504 /** @brief Add an element at the end of the dynar */
505 extern "C" void xbt_dynar_push(xbt_dynar_t const dynar, const void* const src)
507 /* checks done in xbt_dynar_insert_at_ptr */
508 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
511 /** @brief Mark the last dynar's element as unused and return a pointer to it.
513 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
514 * xbt_dynar_pop_as() does.
516 extern "C" void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
518 _check_populated_dynar(dynar);
519 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
521 return _xbt_dynar_elm(dynar, dynar->used);
524 /** @brief Get and remove the last element of the dynar */
525 extern "C" void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst)
527 /* sanity checks done by remove_at */
528 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
529 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
532 /** @brief Add an element at the begining of the dynar.
534 * This is less efficient than xbt_dynar_push()
536 extern "C" void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* const src)
538 /* sanity checks done by insert_at */
539 xbt_dynar_insert_at(dynar, 0, src);
542 /** @brief Get and remove the first element of the dynar.
544 * This is less efficient than xbt_dynar_pop()
546 extern "C" void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst)
548 /* sanity checks done by remove_at */
549 xbt_dynar_remove_at(dynar, 0, dst);
552 /** @brief Apply a function to each member of a dynar
554 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
556 extern "C" void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
558 char *const data = (char *) dynar->data;
559 const unsigned long elmsize = dynar->elmsize;
560 const unsigned long used = dynar->used;
563 _sanity_check_dynar(dynar);
565 for (i = 0; i < used; i++) {
566 char* elm = (char*) data + i * elmsize;
571 /** @brief Removes and free the entry pointed by the cursor
573 * This function can be used while traversing without problem.
575 extern "C" void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor)
577 xbt_dynar_remove_at(dynar, *cursor, nullptr);
581 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
583 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
584 * You should thus refer to the libc documentation, or to some online tutorial on how to write
585 * a comparison function. Here is a quick example if you have integers in your dynar:
588 * int cmpfunc (const void * a, const void * b) {
589 * int intA = *(int*)a;
590 * int intB = *(int*)b;
591 * return intA - intB;
595 * and now to sort a dynar of MSG hosts depending on their speed:
597 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
598 * MSG_host_t hostA = *(MSG_host_t*)a;
599 * MSG_host_t hostB = *(MSG_host_t*)b;
600 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
604 * \param dynar the dynar to sort
605 * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
607 extern "C" void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
609 if (dynar->data != nullptr)
610 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
613 static int strcmp_voidp(const void *pa, const void *pb) {
614 return strcmp(*(const char **)pa, *(const char **)pb);
617 /** @brief Sorts a dynar of strings (ie, char* data) */
618 extern "C" xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
620 xbt_dynar_sort(dynar, strcmp_voidp);
621 return dynar; // to enable functional uses
624 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
625 * Since there are only three colors, it is linear and much faster than a classical sort.
626 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
628 * \param dynar the dynar to sort
629 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to
632 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the
633 * end and elements with color 1 are in the middle.
635 * Remark: if the elements stored in the dynar are structures, the color function has to retrieve the field to sort
638 extern "C" void xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color)
641 unsigned long int p = -1;
642 unsigned long int q = dynar->used;
643 const unsigned long elmsize = dynar->elmsize;
647 for (i = 0; i < q;) {
648 void *elmi = _xbt_dynar_elm(dynar, i);
649 int colori = color(elmi);
656 elm = _xbt_dynar_elm(dynar, p);
658 } else { /* colori == 2 */
660 elm = _xbt_dynar_elm(dynar, q);
663 memcpy(tmp, elm, elmsize);
664 memcpy(elm, elmi, elmsize);
665 memcpy(elmi, tmp, elmsize);
671 /** @brief Transform a dynar into a nullptr terminated array.
673 * \param dynar the dynar to transform
674 * \return pointer to the first element of the array
676 * Note: The dynar won't be usable afterwards.
678 extern "C" void* xbt_dynar_to_array(xbt_dynar_t dynar)
681 xbt_dynar_shrink(dynar, 1);
682 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
688 /** @brief Compare two dynars
690 * \param d1 first dynar to compare
691 * \param d2 second dynar to compare
692 * \param compar function to use to compare elements
693 * \return 0 if d1 and d2 are equal and 1 if not equal
695 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
696 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
699 extern "C" int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*))
706 XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
710 if((d1->elmsize)!=(d2->elmsize)) {
711 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
715 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
716 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
721 size = xbt_dynar_length(d1);
722 for(i=0;i<size;i++) {
723 void *data1 = xbt_dynar_get_as(d1, i, void *);
724 void *data2 = xbt_dynar_get_as(d2, i, void *);
725 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
726 if(compar(data1,data2)){
739 XBT_TEST_SUITE("dynar", "Dynar data container");
740 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
742 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
744 /* Vars_decl [doxygen cruft] */
749 xbt_test_add("==== Traverse the empty dynar");
750 xbt_dynar_t d = xbt_dynar_new(sizeof(int), nullptr);
751 xbt_dynar_foreach(d, cursor, i) {
752 xbt_die( "Damnit, there is something in the empty dynar");
754 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
755 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
756 /* in your code is naturally the way to go outside a regression test */
758 xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
759 /* Populate_ints [doxygen cruft] */
760 /* 1. Populate the dynar */
761 d = xbt_dynar_new(sizeof(int), nullptr);
762 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
763 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
764 /* xbt_dynar_push(d,&cpt); This would also work */
765 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
768 /* 2. Traverse manually the dynar */
769 for (cursor = 0; cursor < NB_ELEM; cursor++) {
770 iptr = (int*) xbt_dynar_get_ptr(d, cursor);
771 xbt_test_assert(cursor == (unsigned int)*iptr, "The retrieved value is not the same than the injected one (%u!=%d)",
775 /* 3. Traverse the dynar using the neat macro to that extend */
777 xbt_dynar_foreach(d, cursor, cpt) {
778 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
780 /* end_of_traversal */
782 for (int cpt = 0; cpt < NB_ELEM; cpt++)
783 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
785 for (int cpt = 0; cpt < NB_ELEM; cpt++)
786 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
787 /* xbt_dynar_set(d,cpt,&cpt); */
789 for (int cpt = 0; cpt < NB_ELEM; cpt++)
790 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
793 xbt_dynar_foreach(d, cursor, i) {
794 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
797 xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
799 /* shifting [doxygen cruft] */
800 /* 4. Shift all the values */
801 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
802 xbt_dynar_shift(d, &i);
803 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
804 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
808 xbt_dynar_foreach_ptr(d, cursor, pi) {
811 xbt_dynar_foreach(d, cursor, i) {
812 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
814 xbt_dynar_foreach_ptr(d, cursor, pi) {
817 xbt_dynar_foreach(d, cursor, i) {
818 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
821 /* 5. Free the resources */
822 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
823 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
824 /* in your code is naturally the way to go outside a regression test */
826 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
827 d = xbt_dynar_new(sizeof(int), nullptr);
828 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
829 xbt_dynar_unshift(d, &cpt);
830 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
832 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
833 i = xbt_dynar_pop_as(d, int);
834 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
835 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
837 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
838 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
839 /* in your code is naturally the way to go outside a regression test */
841 xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
842 d = xbt_dynar_new(sizeof(int), nullptr);
843 for (cpt = 0; cpt < NB_ELEM; cpt++) {
844 xbt_dynar_push_as(d, int, cpt);
845 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
847 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
848 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
849 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
852 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
853 xbt_dynar_shift(d, &i);
854 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
856 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
858 for (cpt = 999; cpt >= 0; cpt--) {
859 xbt_dynar_shift(d, &i);
860 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
863 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
864 xbt_dynar_shift(d, &i);
865 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
867 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
868 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
869 /* in your code is naturally the way to go outside a regression test */
871 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
872 d = xbt_dynar_new(sizeof(int), nullptr);
873 for (cpt = 0; cpt < NB_ELEM; cpt++)
874 xbt_dynar_push_as(d, int, cpt);
876 for (cpt = 2000; cpt < 4000; cpt++) {
877 xbt_dynar_remove_at(d, 2000, &i);
878 xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
879 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
881 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
882 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
883 /* in your code is naturally the way to go outside a regression test */
886 /*******************************************************************************/
887 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
889 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), nullptr);
892 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
893 /* Populate_ints [doxygen cruft] */
894 /* 1. Populate the dynar */
895 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
896 xbt_dynar_insert_at(d, cpt, &cpt);
897 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
900 /* 3. Traverse the dynar */
902 xbt_dynar_foreach(d, cursor, cpt) {
903 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
905 /* end_of_traversal */
907 /* Re-fill with the same values using set_as (and re-verify) */
908 for (int cpt = 0; cpt < NB_ELEM; cpt++)
909 xbt_dynar_set_as(d, cpt, int, cpt);
910 xbt_dynar_foreach(d, cursor, cpt)
911 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
913 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
915 xbt_dynar_remove_at(d,0,&val);
916 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
918 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
919 xbt_dynar_length(d));
922 /* ********************* */
923 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
924 d = xbt_dynar_new(sizeof(int), nullptr);
925 for (int cpt = NB_ELEM - 1; cpt >= 0; cpt--) {
926 xbt_dynar_replace(d, cpt, &cpt);
927 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
930 /* 3. Traverse the dynar */
931 xbt_dynar_foreach(d, cursor, cpt) {
932 xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
934 /* end_of_traversal */
936 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
938 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
939 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
941 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
942 xbt_dynar_length(d));
946 /*******************************************************************************/
947 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
954 xbt_test_add("==== Traverse the empty dynar");
955 d = xbt_dynar_new(sizeof(int), nullptr);
956 xbt_dynar_foreach(d, cursor, cpt) {
957 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
959 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
960 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
961 /* in your code is naturally the way to go outside a regression test */
963 xbt_test_add("==== Push/shift 5000 doubles");
964 d = xbt_dynar_new(sizeof(double), nullptr);
965 for (cpt = 0; cpt < 5000; cpt++) {
967 xbt_dynar_push(d, &d1);
969 xbt_dynar_foreach(d, cursor, d2) {
970 d1 = (double) cursor;
971 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
973 for (cpt = 0; cpt < 5000; cpt++) {
975 xbt_dynar_shift(d, &d2);
976 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
978 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
979 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
980 /* in your code is naturally the way to go outside a regression test */
982 xbt_test_add("==== Unshift/pop 5000 doubles");
983 d = xbt_dynar_new(sizeof(double), nullptr);
984 for (cpt = 0; cpt < 5000; cpt++) {
986 xbt_dynar_unshift(d, &d1);
988 for (cpt = 0; cpt < 5000; cpt++) {
990 xbt_dynar_pop(d, &d2);
991 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
993 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
994 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
995 /* in your code is naturally the way to go outside a regression test */
997 xbt_test_add("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
998 d = xbt_dynar_new(sizeof(double), nullptr);
999 for (cpt = 0; cpt < 5000; cpt++) {
1001 xbt_dynar_push(d, &d1);
1003 for (cpt = 0; cpt < 1000; cpt++) {
1005 xbt_dynar_insert_at(d, 2500, &d1);
1008 for (cpt = 0; cpt < 2500; cpt++) {
1010 xbt_dynar_shift(d, &d2);
1011 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1013 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1015 for (cpt = 999; cpt >= 0; cpt--) {
1017 xbt_dynar_shift(d, &d2);
1018 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1021 for (cpt = 2500; cpt < 5000; cpt++) {
1023 xbt_dynar_shift(d, &d2);
1024 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1026 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1027 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1028 /* in your code is naturally the way to go outside a regression test */
1030 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1031 d = xbt_dynar_new(sizeof(double), nullptr);
1032 for (cpt = 0; cpt < 5000; cpt++) {
1034 xbt_dynar_push(d, &d1);
1036 for (cpt = 2000; cpt < 4000; cpt++) {
1038 xbt_dynar_remove_at(d, 2000, &d2);
1039 xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1041 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1042 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1043 /* in your code is naturally the way to go outside a regression test */
1046 /* doxygen_string_cruft */
1048 /*******************************************************************************/
1049 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1055 xbt_test_add("==== Traverse the empty dynar");
1056 xbt_dynar_t d = xbt_dynar_new(sizeof(char*), &xbt_free_ref);
1057 xbt_dynar_foreach(d, iter, s1) {
1058 xbt_test_assert(FALSE, "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 %d strings, set them again 3 times, shift them", NB_ELEM);
1065 /* Populate_str [doxygen cruft] */
1066 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1067 /* 1. Populate the dynar */
1068 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1069 snprintf(buf,1023, "%d", cpt);
1070 s1 = xbt_strdup(buf);
1071 xbt_dynar_push(d, &s1);
1073 for (int i = 0 ; i < 3 ; i++) {
1074 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1075 snprintf(buf,1023, "%d", cpt);
1076 s1 = xbt_strdup(buf);
1077 xbt_dynar_replace(d, cpt, &s1);
1080 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1081 snprintf(buf,1023, "%d", cpt);
1082 xbt_dynar_shift(d, &s2);
1083 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1086 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1087 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1088 /* in your code is naturally the way to go outside a regression test */
1090 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1091 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1092 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1093 snprintf(buf,1023, "%d", cpt);
1094 s1 = xbt_strdup(buf);
1095 xbt_dynar_unshift(d, &s1);
1097 /* 2. Traverse the dynar with the macro */
1098 xbt_dynar_foreach(d, iter, s1) {
1099 snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1100 xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1102 /* 3. Traverse the dynar with the macro */
1103 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1104 snprintf(buf,1023, "%d", cpt);
1105 xbt_dynar_pop(d, &s2);
1106 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1109 /* 4. Free the resources */
1110 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1111 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1112 /* in your code is naturally the way to go outside a regression test */
1114 xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1115 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1116 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1117 snprintf(buf,1023, "%d", cpt);
1118 s1 = xbt_strdup(buf);
1119 xbt_dynar_push(d, &s1);
1121 for (int cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1122 snprintf(buf,1023, "%d", cpt);
1123 s1 = xbt_strdup(buf);
1124 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1127 for (int cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1128 snprintf(buf,1023, "%d", cpt);
1129 xbt_dynar_shift(d, &s2);
1130 xbt_test_assert(!strcmp(buf, s2),
1131 "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1134 for (int cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1135 snprintf(buf,1023, "%d", cpt);
1136 xbt_dynar_shift(d, &s2);
1137 xbt_test_assert(!strcmp(buf, s2),
1138 "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1141 for (int cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1142 snprintf(buf,1023, "%d", cpt);
1143 xbt_dynar_shift(d, &s2);
1144 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1148 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1149 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1150 /* in your code is naturally the way to go outside a regression test */
1152 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1153 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1154 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1155 snprintf(buf,1023, "%d", cpt);
1156 s1 = xbt_strdup(buf);
1157 xbt_dynar_push(d, &s1);
1159 for (int cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1160 snprintf(buf,1023, "%d", cpt);
1161 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1162 xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1165 xbt_dynar_free(&d); /* end_of_doxygen */
1167 #endif /* SIMGRID_TEST */