1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004-2017. 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 _sanity_check_dynar(dynar);
369 _check_inbound_idx(dynar, idx);
372 _xbt_dynar_get_elm(object, dynar, idx);
373 } else if (dynar->free_f) {
374 dynar->free_f(_xbt_dynar_elm(dynar, idx));
377 unsigned long nb_shift = dynar->used - 1 - idx;
380 unsigned long offset = nb_shift * dynar->elmsize;
381 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
387 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
389 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
390 * nullptr object argument if n equals to 1.
392 * Each of the removed elements is freed using the free_f function passed at dynar creation.
394 extern "C" void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
399 _sanity_check_dynar(dynar);
400 _check_inbound_idx(dynar, idx);
401 _check_inbound_idx(dynar, idx + n - 1);
404 for (unsigned long cur = idx; cur < idx + n; cur++) {
405 dynar->free_f(_xbt_dynar_elm(dynar, cur));
409 unsigned long nb_shift = dynar->used - n - idx;
412 unsigned long offset = nb_shift * dynar->elmsize;
413 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
419 /** @brief Returns the position of the element in the dynar
421 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
422 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
425 * signed int position = -1;
426 * xbt_dynar_foreach(dynar, iter, elem) {
427 * if (not memcmp(elem, searched_element, sizeof(*elem))) {
434 * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
435 * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
437 extern "C" unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* const elem)
441 for (it = 0; it < dynar->used; it++)
442 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
446 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
447 return -1; // Won't happen, just to please eclipse
450 /** @brief Returns the position of the element in the dynar (or -1 if not found)
452 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
453 * what you want. Check the documentation of xbt_dynar_search() for more info.
455 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
456 * this very function will not work (but the other will).
458 extern "C" signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem)
462 for (it = 0; it < dynar->used; it++)
463 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
470 /** @brief Returns a boolean indicating whether the element is part of the dynar
472 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
473 * what you want. Check the documentation of xbt_dynar_search() for more info.
475 extern "C" int xbt_dynar_member(xbt_dynar_t const dynar, void* const elem)
479 for (it = 0; it < dynar->used; it++)
480 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
487 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
489 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
490 * xbt_dynar_push_as() does.
492 extern "C" void* xbt_dynar_push_ptr(xbt_dynar_t const dynar)
494 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
497 /** @brief Add an element at the end of the dynar */
498 extern "C" void xbt_dynar_push(xbt_dynar_t const dynar, const void* const src)
500 /* checks done in xbt_dynar_insert_at_ptr */
501 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
504 /** @brief Mark the last dynar's element as unused and return a pointer to it.
506 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
507 * xbt_dynar_pop_as() does.
509 extern "C" void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
511 _check_populated_dynar(dynar);
512 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
514 return _xbt_dynar_elm(dynar, dynar->used);
517 /** @brief Get and remove the last element of the dynar */
518 extern "C" void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst)
520 /* sanity checks done by remove_at */
521 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
522 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
525 /** @brief Add an element at the begining of the dynar.
527 * This is less efficient than xbt_dynar_push()
529 extern "C" void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* const src)
531 /* sanity checks done by insert_at */
532 xbt_dynar_insert_at(dynar, 0, src);
535 /** @brief Get and remove the first element of the dynar.
537 * This is less efficient than xbt_dynar_pop()
539 extern "C" void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst)
541 /* sanity checks done by remove_at */
542 xbt_dynar_remove_at(dynar, 0, dst);
545 /** @brief Apply a function to each member of a dynar
547 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
549 extern "C" void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
551 char *const data = (char *) dynar->data;
552 const unsigned long elmsize = dynar->elmsize;
553 const unsigned long used = dynar->used;
556 _sanity_check_dynar(dynar);
558 for (i = 0; i < used; i++) {
559 char* elm = (char*) data + i * elmsize;
564 /** @brief Removes and free the entry pointed by the cursor
566 * This function can be used while traversing without problem.
568 extern "C" void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor)
570 xbt_dynar_remove_at(dynar, *cursor, nullptr);
574 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
576 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
577 * You should thus refer to the libc documentation, or to some online tutorial on how to write
578 * a comparison function. Here is a quick example if you have integers in your dynar:
581 * int cmpfunc (const void * a, const void * b) {
582 * int intA = *(int*)a;
583 * int intB = *(int*)b;
584 * return intA - intB;
588 * and now to sort a dynar of MSG hosts depending on their speed:
590 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
591 * MSG_host_t hostA = *(MSG_host_t*)a;
592 * MSG_host_t hostB = *(MSG_host_t*)b;
593 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
597 * \param dynar the dynar to sort
598 * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
600 extern "C" void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
602 if (dynar->data != nullptr)
603 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
606 static int strcmp_voidp(const void *pa, const void *pb) {
607 return strcmp(*(const char **)pa, *(const char **)pb);
610 /** @brief Sorts a dynar of strings (ie, char* data) */
611 extern "C" xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
613 xbt_dynar_sort(dynar, strcmp_voidp);
614 return dynar; // to enable functional uses
617 /** @brief Transform a dynar into a nullptr terminated array.
619 * \param dynar the dynar to transform
620 * \return pointer to the first element of the array
622 * Note: The dynar won't be usable afterwards.
624 extern "C" void* xbt_dynar_to_array(xbt_dynar_t dynar)
627 xbt_dynar_shrink(dynar, 1);
628 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
634 /** @brief Compare two dynars
636 * \param d1 first dynar to compare
637 * \param d2 second dynar to compare
638 * \param compar function to use to compare elements
639 * \return 0 if d1 and d2 are equal and 1 if not equal
641 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
642 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
645 extern "C" int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*))
649 if ((not d1) && (not d2))
651 if ((not d1) || (not d2)) {
652 XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
656 if((d1->elmsize)!=(d2->elmsize)) {
657 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
661 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
662 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
667 size = xbt_dynar_length(d1);
668 for(i=0;i<size;i++) {
669 void *data1 = xbt_dynar_get_as(d1, i, void *);
670 void *data2 = xbt_dynar_get_as(d2, i, void *);
671 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
672 if(compar(data1,data2)){
685 XBT_TEST_SUITE("dynar", "Dynar data container");
686 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
688 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
690 /* Vars_decl [doxygen cruft] */
694 xbt_test_add("==== Traverse the empty dynar");
695 xbt_dynar_t d = xbt_dynar_new(sizeof(int), nullptr);
696 xbt_dynar_foreach(d, cursor, i) {
697 xbt_die( "Damnit, there is something in the empty dynar");
699 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
700 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
701 /* in your code is naturally the way to go outside a regression test */
703 xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
704 /* Populate_ints [doxygen cruft] */
705 /* 1. Populate the dynar */
706 d = xbt_dynar_new(sizeof(int), nullptr);
707 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
708 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
709 /* xbt_dynar_push(d,&cpt); This would also work */
710 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
713 /* 2. Traverse manually the dynar */
714 for (cursor = 0; cursor < NB_ELEM; cursor++) {
715 int* iptr = (int*)xbt_dynar_get_ptr(d, cursor);
716 xbt_test_assert(cursor == (unsigned int)*iptr, "The retrieved value is not the same than the injected one (%u!=%d)",
720 /* 3. Traverse the dynar using the neat macro to that extend */
722 xbt_dynar_foreach(d, cursor, cpt) {
723 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
725 /* end_of_traversal */
727 for (int cpt = 0; cpt < NB_ELEM; cpt++)
728 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
730 for (int cpt = 0; cpt < NB_ELEM; cpt++)
731 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
733 for (int cpt = 0; cpt < NB_ELEM; cpt++)
734 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
737 xbt_dynar_foreach(d, cursor, i) {
738 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
741 xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
743 /* shifting [doxygen cruft] */
744 /* 4. Shift all the values */
745 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
746 xbt_dynar_shift(d, &i);
747 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
748 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
752 xbt_dynar_foreach_ptr(d, cursor, pi) {
755 xbt_dynar_foreach(d, cursor, i) {
756 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
758 xbt_dynar_foreach_ptr(d, cursor, pi) {
761 xbt_dynar_foreach(d, cursor, i) {
762 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
765 /* 5. Free the resources */
766 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
767 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
768 /* in your code is naturally the way to go outside a regression test */
770 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
771 d = xbt_dynar_new(sizeof(int), nullptr);
772 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
773 xbt_dynar_unshift(d, &cpt);
774 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
776 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
777 i = xbt_dynar_pop_as(d, int);
778 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
779 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
781 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
782 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
783 /* in your code is naturally the way to go outside a regression test */
785 xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
786 d = xbt_dynar_new(sizeof(int), nullptr);
787 for (cpt = 0; cpt < NB_ELEM; cpt++) {
788 xbt_dynar_push_as(d, int, cpt);
789 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
791 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
792 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
793 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
796 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
797 xbt_dynar_shift(d, &i);
798 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
800 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
802 for (cpt = 999; cpt >= 0; cpt--) {
803 xbt_dynar_shift(d, &i);
804 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
807 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
808 xbt_dynar_shift(d, &i);
809 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
811 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
812 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
813 /* in your code is naturally the way to go outside a regression test */
815 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
816 d = xbt_dynar_new(sizeof(int), nullptr);
817 for (cpt = 0; cpt < NB_ELEM; cpt++)
818 xbt_dynar_push_as(d, int, cpt);
820 for (cpt = 2000; cpt < 4000; cpt++) {
821 xbt_dynar_remove_at(d, 2000, &i);
822 xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
823 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
825 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
826 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
827 /* in your code is naturally the way to go outside a regression test */
830 /*******************************************************************************/
831 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
833 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), nullptr);
836 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
837 /* Populate_ints [doxygen cruft] */
838 /* 1. Populate the dynar */
839 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
840 xbt_dynar_insert_at(d, cpt, &cpt);
841 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
844 /* 3. Traverse the dynar */
846 xbt_dynar_foreach(d, cursor, cpt) {
847 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
849 /* end_of_traversal */
851 /* Re-fill with the same values using set_as (and re-verify) */
852 for (int cpt = 0; cpt < NB_ELEM; cpt++)
853 xbt_dynar_set_as(d, cpt, int, cpt);
854 xbt_dynar_foreach(d, cursor, cpt)
855 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
857 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
859 xbt_dynar_remove_at(d,0,&val);
860 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
862 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
863 xbt_dynar_length(d));
866 /* ********************* */
867 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
868 d = xbt_dynar_new(sizeof(int), nullptr);
869 for (int cpt = NB_ELEM - 1; cpt >= 0; cpt--) {
870 xbt_dynar_replace(d, cpt, &cpt);
871 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
874 /* 3. Traverse the dynar */
875 xbt_dynar_foreach(d, cursor, cpt) {
876 xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
878 /* end_of_traversal */
880 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
882 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
883 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
885 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
886 xbt_dynar_length(d));
890 /*******************************************************************************/
891 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
898 xbt_test_add("==== Traverse the empty dynar");
899 d = xbt_dynar_new(sizeof(int), nullptr);
900 xbt_dynar_foreach(d, cursor, cpt) {
901 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
903 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
904 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
905 /* in your code is naturally the way to go outside a regression test */
907 xbt_test_add("==== Push/shift 5000 doubles");
908 d = xbt_dynar_new(sizeof(double), nullptr);
909 for (cpt = 0; cpt < 5000; cpt++) {
911 xbt_dynar_push(d, &d1);
913 xbt_dynar_foreach(d, cursor, d2) {
914 d1 = (double) cursor;
915 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
917 for (cpt = 0; cpt < 5000; cpt++) {
919 xbt_dynar_shift(d, &d2);
920 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
922 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
923 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
924 /* in your code is naturally the way to go outside a regression test */
926 xbt_test_add("==== Unshift/pop 5000 doubles");
927 d = xbt_dynar_new(sizeof(double), nullptr);
928 for (cpt = 0; cpt < 5000; cpt++) {
930 xbt_dynar_unshift(d, &d1);
932 for (cpt = 0; cpt < 5000; cpt++) {
934 xbt_dynar_pop(d, &d2);
935 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
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 5000 doubles, insert 1000 doubles in the middle, shift everything");
942 d = xbt_dynar_new(sizeof(double), nullptr);
943 for (cpt = 0; cpt < 5000; cpt++) {
945 xbt_dynar_push(d, &d1);
947 for (cpt = 0; cpt < 1000; cpt++) {
949 xbt_dynar_insert_at(d, 2500, &d1);
952 for (cpt = 0; cpt < 2500; cpt++) {
954 xbt_dynar_shift(d, &d2);
955 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
957 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
959 for (cpt = 999; cpt >= 0; cpt--) {
961 xbt_dynar_shift(d, &d2);
962 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
965 for (cpt = 2500; cpt < 5000; cpt++) {
967 xbt_dynar_shift(d, &d2);
968 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
970 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
971 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
972 /* in your code is naturally the way to go outside a regression test */
974 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
975 d = xbt_dynar_new(sizeof(double), nullptr);
976 for (cpt = 0; cpt < 5000; cpt++) {
978 xbt_dynar_push(d, &d1);
980 for (cpt = 2000; cpt < 4000; cpt++) {
982 xbt_dynar_remove_at(d, 2000, &d2);
983 xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
985 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
986 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
987 /* in your code is naturally the way to go outside a regression test */
990 /* doxygen_string_cruft */
992 /*******************************************************************************/
993 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
999 xbt_test_add("==== Traverse the empty dynar");
1000 xbt_dynar_t d = xbt_dynar_new(sizeof(char*), &xbt_free_ref);
1001 xbt_dynar_foreach(d, iter, s1) {
1002 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
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 %d strings, set them again 3 times, shift them", NB_ELEM);
1009 /* Populate_str [doxygen cruft] */
1010 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1011 /* 1. Populate the dynar */
1012 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1013 snprintf(buf,1023, "%d", cpt);
1014 s1 = xbt_strdup(buf);
1015 xbt_dynar_push(d, &s1);
1017 for (int i = 0 ; i < 3 ; i++) {
1018 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1019 snprintf(buf,1023, "%d", cpt);
1020 s1 = xbt_strdup(buf);
1021 xbt_dynar_replace(d, cpt, &s1);
1024 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1025 snprintf(buf,1023, "%d", cpt);
1026 xbt_dynar_shift(d, &s2);
1027 xbt_test_assert(not strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1030 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1031 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1032 /* in your code is naturally the way to go outside a regression test */
1034 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1035 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1036 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1037 snprintf(buf,1023, "%d", cpt);
1038 s1 = xbt_strdup(buf);
1039 xbt_dynar_unshift(d, &s1);
1041 /* 2. Traverse the dynar with the macro */
1042 xbt_dynar_foreach(d, iter, s1) {
1043 snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1044 xbt_test_assert(not strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1046 /* 3. Traverse the dynar with the macro */
1047 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1048 snprintf(buf,1023, "%d", cpt);
1049 xbt_dynar_pop(d, &s2);
1050 xbt_test_assert(not strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1053 /* 4. Free the resources */
1054 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1055 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1056 /* in your code is naturally the way to go outside a regression test */
1058 xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1059 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1060 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1061 snprintf(buf,1023, "%d", cpt);
1062 s1 = xbt_strdup(buf);
1063 xbt_dynar_push(d, &s1);
1065 for (int cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1066 snprintf(buf,1023, "%d", cpt);
1067 s1 = xbt_strdup(buf);
1068 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1071 for (int cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1072 snprintf(buf,1023, "%d", cpt);
1073 xbt_dynar_shift(d, &s2);
1074 xbt_test_assert(not strcmp(buf, s2),
1075 "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1078 for (int cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1079 snprintf(buf,1023, "%d", cpt);
1080 xbt_dynar_shift(d, &s2);
1081 xbt_test_assert(not strcmp(buf, s2),
1082 "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1085 for (int cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1086 snprintf(buf,1023, "%d", cpt);
1087 xbt_dynar_shift(d, &s2);
1088 xbt_test_assert(not strcmp(buf, s2),
1089 "The retrieved value is not the same than the injected one at the end (%s!=%s)", buf, s2);
1092 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1093 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1094 /* in your code is naturally the way to go outside a regression test */
1096 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1097 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1098 for (int cpt = 0; cpt < NB_ELEM; cpt++) {
1099 snprintf(buf,1023, "%d", cpt);
1100 s1 = xbt_strdup(buf);
1101 xbt_dynar_push(d, &s1);
1103 for (int cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1104 snprintf(buf,1023, "%d", cpt);
1105 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1106 xbt_test_assert(not strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1109 xbt_dynar_free(&d); /* end_of_doxygen */
1111 #endif /* SIMGRID_TEST */