1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/sysdep.h"
13 #include "xbt/dynar.h"
14 #include <sys/types.h>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
18 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
20 xbt_assert(dynar, "dynar is NULL");
23 static inline void _sanity_check_idx(int idx)
25 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
28 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
30 if (idx < 0 || idx >= (int)dynar->used) {
31 THROWF(bound_error, idx, "dynar is not that long. You asked %d, but it's only %lu long",
32 (int) (idx), (unsigned long) dynar->used);
36 static inline void _check_populated_dynar(xbt_dynar_t dynar)
38 if (dynar->used == 0) {
39 THROWF(bound_error, 0, "dynar %p is empty", dynar);
43 static inline void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
45 if (new_size != dynar->size) {
46 dynar->size = new_size;
47 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
51 static inline void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
53 const unsigned long old_size = dynar->size;
56 const unsigned long expand = 2 * (old_size + 1);
57 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
58 XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, dynar->size);
62 static inline void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
64 char *const data = (char *) dynar->data;
65 const unsigned long elmsize = dynar->elmsize;
67 return data + idx * elmsize;
70 static inline void _xbt_dynar_get_elm(void *const dst, const xbt_dynar_t dynar, const unsigned long idx)
72 void *const elm = _xbt_dynar_elm(dynar, idx);
74 memcpy(dst, elm, dynar->elmsize);
77 void xbt_dynar_dump(xbt_dynar_t dynar)
79 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
80 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
83 /** @brief Constructor
85 * \param elmsize size of each element in the dynar
86 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
88 * Creates a new dynar. If a free_func is provided, the elements have to be pointer of pointer. That is to say that
89 * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
91 xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
93 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
97 dynar->elmsize = elmsize;
99 dynar->free_f = free_f;
104 /** @brief Destructor of the structure not touching to the content
106 * \param dynar poor victim
108 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the \a free_f function
111 void xbt_dynar_free_container(xbt_dynar_t * dynar)
113 if (dynar && *dynar) {
114 xbt_dynar_t d = *dynar;
121 /** @brief Frees the content and set the size to 0
123 * \param dynar who to squeeze
125 void xbt_dynar_reset(xbt_dynar_t const dynar)
127 _sanity_check_dynar(dynar);
129 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
131 xbt_dynar_map(dynar, dynar->free_f);
136 /** @brief Merge dynar d2 into d1
138 * \param d1 dynar to keep
139 * \param d2 dynar to merge into d1. This dynar is free at end.
141 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
143 if((*d1)->elmsize != (*d2)->elmsize)
144 xbt_die("Element size must are not equal");
146 const unsigned long elmsize = (*d1)->elmsize;
148 void *ptr = _xbt_dynar_elm((*d2), 0);
149 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
150 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
152 memcpy(elm, ptr, ((*d2)->size)*elmsize);
153 (*d1)->used += (*d2)->used;
159 * \brief Shrink the dynar by removing empty slots at the end of the internal array
160 * \param dynar a dynar
161 * \param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
164 * Reduces the internal array size of the dynar to the number of elements plus \a empty_slots_wanted.
165 * After removing elements from the dynar, you can call this function to make the dynar use less memory.
166 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
167 * Note that if \a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
169 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
171 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
174 /** @brief Destructor
176 * \param dynar poor victim
178 * kilkil a dynar and its content
180 void xbt_dynar_free(xbt_dynar_t * dynar)
182 if (dynar && *dynar) {
183 xbt_dynar_reset(*dynar);
184 xbt_dynar_free_container(dynar);
188 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
189 void xbt_dynar_free_voidp(void *d)
191 xbt_dynar_t dynar = (xbt_dynar_t)d;
192 xbt_dynar_free(&dynar);
195 /** @brief Count of dynar's elements
197 * \param dynar the dynar we want to mesure
199 unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
201 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
204 /**@brief check if a dynar is empty
206 *\param dynar the dynat we want to check
209 int xbt_dynar_is_empty(const xbt_dynar_t dynar)
211 return (xbt_dynar_length(dynar) == 0);
214 /** @brief Retrieve a copy of the Nth element of a dynar.
216 * \param dynar information dealer
217 * \param idx index of the slot we want to retrieve
218 * \param[out] dst where to put the result to.
220 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void *const dst)
222 _sanity_check_dynar(dynar);
223 _check_inbound_idx(dynar, idx);
225 _xbt_dynar_get_elm(dst, dynar, idx);
228 /** @brief Retrieve a pointer to the Nth element of a dynar.
230 * \param dynar information dealer
231 * \param idx index of the slot we want to retrieve
232 * \return the \a idx-th element of \a dynar.
234 * \warning The returned value is the actual content of the dynar.
235 * Make a copy before fooling with it.
237 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
240 _sanity_check_dynar(dynar);
241 _check_inbound_idx(dynar, idx);
243 res = _xbt_dynar_elm(dynar, idx);
247 void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
249 _sanity_check_dynar(dynar);
251 if (idx >= dynar->used) {
252 _xbt_dynar_expand(dynar, idx + 1);
253 if (idx > dynar->used) {
254 memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
256 dynar->used = idx + 1;
258 return _xbt_dynar_elm(dynar, idx);
261 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
263 * \param dynar information dealer
264 * \param idx index of the slot we want to modify
265 * \param src What will be feeded to the dynar
267 * If you want to free the previous content, use xbt_dynar_replace().
269 void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *const src)
271 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
274 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
280 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
281 * you don't want to free the previous content, use xbt_dynar_set().
283 void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *const object)
285 _sanity_check_dynar(dynar);
287 if (idx < dynar->used && dynar->free_f) {
288 void *const old_object = _xbt_dynar_elm(dynar, idx);
290 dynar->free_f(old_object);
293 xbt_dynar_set(dynar, idx, object);
296 /** @brief Make room for a new element, and return a pointer to it
298 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
299 * xbt_dynar_insert_at_as() does.
301 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
304 unsigned long old_used;
305 unsigned long new_used;
308 _sanity_check_dynar(dynar);
309 _sanity_check_idx(idx);
311 old_used = dynar->used;
312 new_used = old_used + 1;
314 _xbt_dynar_expand(dynar, new_used);
316 nb_shift = old_used - idx;
319 memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
322 dynar->used = new_used;
323 res = _xbt_dynar_elm(dynar, idx);
327 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
329 * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
330 * subsequent ones to one position right in the dynar.
332 void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *const src)
334 /* checks done in xbt_dynar_insert_at_ptr */
335 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
338 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
340 * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
343 * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
344 * the element is freed using the free_f function passed at dynar creation.
346 void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void *const object)
348 unsigned long nb_shift;
349 unsigned long offset;
351 _sanity_check_dynar(dynar);
352 _check_inbound_idx(dynar, idx);
355 _xbt_dynar_get_elm(object, dynar, idx);
356 } else if (dynar->free_f) {
357 dynar->free_f(_xbt_dynar_elm(dynar, idx));
360 nb_shift = dynar->used - 1 - idx;
363 offset = nb_shift * dynar->elmsize;
364 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
370 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
372 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
373 * NULL object argument if n equals to 1.
375 * Each of the removed elements is freed using the free_f function passed at dynar creation.
377 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
379 unsigned long nb_shift;
380 unsigned long offset;
385 _sanity_check_dynar(dynar);
386 _check_inbound_idx(dynar, idx);
387 _check_inbound_idx(dynar, idx + n - 1);
390 for (cur = idx; cur < idx + n; cur++) {
391 dynar->free_f(_xbt_dynar_elm(dynar, cur));
395 nb_shift = dynar->used - n - idx;
398 offset = nb_shift * dynar->elmsize;
399 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
405 /** @brief Returns the position of the element in the dynar
407 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
408 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
411 * signed int position = -1;
412 * xbt_dynar_foreach(dynar, iter, elem) {
413 * if (!memcmp(elem, searched_element, sizeof(*elem))) {
420 * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
421 * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
423 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
427 for (it = 0; it < dynar->used; it++)
428 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
432 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
433 return -1; // Won't happen, just to please eclipse
436 /** @brief Returns the position of the element in the dynar (or -1 if not found)
438 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
439 * what you want. Check the documentation of xbt_dynar_search() for more info.
441 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
442 * this very function will not work (but the other will).
444 signed int xbt_dynar_search_or_negative(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)) {
456 /** @brief Returns a boolean indicating whether the element is part of the dynar
458 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
459 * what you want. Check the documentation of xbt_dynar_search() for more info.
461 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
464 xbt_dynar_search(dynar, elem);
467 if (e.category == not_found_error)
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)--, NULL);
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 NULL 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("NULL 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] */
728 xbt_test_add("==== Traverse the empty dynar");
729 d = xbt_dynar_new(sizeof(int), NULL);
730 xbt_dynar_foreach(d, cursor, i) {
731 xbt_die( "Damnit, there is something in the empty dynar");
733 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
734 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
735 /* in your code is naturally the way to go outside a regression test */
737 xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
738 /* Populate_ints [doxygen cruft] */
739 /* 1. Populate the dynar */
740 d = xbt_dynar_new(sizeof(int), NULL);
741 for (cpt = 0; cpt < NB_ELEM; cpt++) {
742 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
743 /* xbt_dynar_push(d,&cpt); This would also work */
744 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
747 /* 2. Traverse manually the dynar */
748 for (cursor = 0; cursor < NB_ELEM; cursor++) {
749 iptr = (int*) xbt_dynar_get_ptr(d, cursor);
750 xbt_test_assert(cursor == (unsigned int) *iptr, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
753 /* 3. Traverse the dynar using the neat macro to that extend */
754 xbt_dynar_foreach(d, cursor, cpt) {
755 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
757 /* end_of_traversal */
759 for (cpt = 0; cpt < NB_ELEM; cpt++)
760 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
762 for (cpt = 0; cpt < NB_ELEM; cpt++)
763 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
764 /* xbt_dynar_set(d,cpt,&cpt); */
766 for (cpt = 0; cpt < NB_ELEM; cpt++)
767 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
770 xbt_dynar_foreach(d, cursor, i) {
771 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
774 xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
776 /* shifting [doxygen cruft] */
777 /* 4. Shift all the values */
778 for (cpt = 0; cpt < NB_ELEM; cpt++) {
779 xbt_dynar_shift(d, &i);
780 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
781 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
785 xbt_dynar_foreach_ptr(d, cursor, pi) {
788 xbt_dynar_foreach(d, cursor, i) {
789 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
791 xbt_dynar_foreach_ptr(d, cursor, pi) {
794 xbt_dynar_foreach(d, cursor, i) {
795 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
798 /* 5. Free the resources */
799 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
800 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
801 /* in your code is naturally the way to go outside a regression test */
803 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
804 d = xbt_dynar_new(sizeof(int), NULL);
805 for (cpt = 0; cpt < NB_ELEM; cpt++) {
806 xbt_dynar_unshift(d, &cpt);
807 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
809 for (cpt = 0; cpt < NB_ELEM; cpt++) {
810 i = xbt_dynar_pop_as(d, int);
811 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
812 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
814 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
815 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
816 /* in your code is naturally the way to go outside a regression test */
818 xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
819 d = xbt_dynar_new(sizeof(int), NULL);
820 for (cpt = 0; cpt < NB_ELEM; cpt++) {
821 xbt_dynar_push_as(d, int, cpt);
822 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
824 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
825 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
826 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
829 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
830 xbt_dynar_shift(d, &i);
831 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
833 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
835 for (cpt = 999; cpt >= 0; cpt--) {
836 xbt_dynar_shift(d, &i);
837 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
840 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
841 xbt_dynar_shift(d, &i);
842 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
844 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
845 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
846 /* in your code is naturally the way to go outside a regression test */
848 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
849 d = xbt_dynar_new(sizeof(int), NULL);
850 for (cpt = 0; cpt < NB_ELEM; cpt++)
851 xbt_dynar_push_as(d, int, cpt);
853 for (cpt = 2000; cpt < 4000; cpt++) {
854 xbt_dynar_remove_at(d, 2000, &i);
855 xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
856 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
858 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
859 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
860 /* in your code is naturally the way to go outside a regression test */
863 /*******************************************************************************/
864 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
866 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
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 (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 */
879 xbt_dynar_foreach(d, cursor, cpt) {
880 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
882 /* end_of_traversal */
884 /* Re-fill with the same values using set_as (and re-verify) */
885 for (cpt = 0; cpt < NB_ELEM; cpt++)
886 xbt_dynar_set_as(d, cpt, int, cpt);
887 xbt_dynar_foreach(d, cursor, cpt)
888 xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
890 for (cpt = 0; cpt < NB_ELEM; cpt++) {
892 xbt_dynar_remove_at(d,0,&val);
893 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
895 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
896 xbt_dynar_length(d));
899 /* ********************* */
900 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
901 d = xbt_dynar_new(sizeof(int), NULL);
902 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
903 xbt_dynar_replace(d, cpt, &cpt);
904 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
907 /* 3. Traverse the dynar */
908 xbt_dynar_foreach(d, cursor, cpt) {
909 xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
911 /* end_of_traversal */
913 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
915 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&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));
923 /*******************************************************************************/
924 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
931 xbt_test_add("==== Traverse the empty dynar");
932 d = xbt_dynar_new(sizeof(int), NULL);
933 xbt_dynar_foreach(d, cursor, cpt) {
934 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
936 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
937 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
938 /* in your code is naturally the way to go outside a regression test */
940 xbt_test_add("==== Push/shift 5000 doubles");
941 d = xbt_dynar_new(sizeof(double), NULL);
942 for (cpt = 0; cpt < 5000; cpt++) {
944 xbt_dynar_push(d, &d1);
946 xbt_dynar_foreach(d, cursor, d2) {
947 d1 = (double) cursor;
948 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
950 for (cpt = 0; cpt < 5000; cpt++) {
952 xbt_dynar_shift(d, &d2);
953 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
955 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
956 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
957 /* in your code is naturally the way to go outside a regression test */
959 xbt_test_add("==== Unshift/pop 5000 doubles");
960 d = xbt_dynar_new(sizeof(double), NULL);
961 for (cpt = 0; cpt < 5000; cpt++) {
963 xbt_dynar_unshift(d, &d1);
965 for (cpt = 0; cpt < 5000; cpt++) {
967 xbt_dynar_pop(d, &d2);
968 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%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 doubles, insert 1000 doubles in the middle, shift everything");
975 d = xbt_dynar_new(sizeof(double), NULL);
976 for (cpt = 0; cpt < 5000; cpt++) {
978 xbt_dynar_push(d, &d1);
980 for (cpt = 0; cpt < 1000; cpt++) {
982 xbt_dynar_insert_at(d, 2500, &d1);
985 for (cpt = 0; cpt < 2500; cpt++) {
987 xbt_dynar_shift(d, &d2);
988 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
990 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
992 for (cpt = 999; cpt >= 0; cpt--) {
994 xbt_dynar_shift(d, &d2);
995 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
998 for (cpt = 2500; cpt < 5000; cpt++) {
1000 xbt_dynar_shift(d, &d2);
1001 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1003 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1004 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1005 /* in your code is naturally the way to go outside a regression test */
1007 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1008 d = xbt_dynar_new(sizeof(double), NULL);
1009 for (cpt = 0; cpt < 5000; cpt++) {
1011 xbt_dynar_push(d, &d1);
1013 for (cpt = 2000; cpt < 4000; cpt++) {
1015 xbt_dynar_remove_at(d, 2000, &d2);
1016 xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1018 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1019 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1020 /* in your code is naturally the way to go outside a regression test */
1023 /* doxygen_string_cruft */
1025 /*******************************************************************************/
1026 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1034 xbt_test_add("==== Traverse the empty dynar");
1035 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1036 xbt_dynar_foreach(d, iter, s1) {
1037 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
1039 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1040 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1041 /* in your code is naturally the way to go outside a regression test */
1043 xbt_test_add("==== Push %d strings, set them again 3 times, shift them", NB_ELEM);
1044 /* Populate_str [doxygen cruft] */
1045 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1046 /* 1. Populate the dynar */
1047 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1048 snprintf(buf,1023, "%d", cpt);
1049 s1 = xbt_strdup(buf);
1050 xbt_dynar_push(d, &s1);
1052 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1053 snprintf(buf,1023, "%d", cpt);
1054 s1 = xbt_strdup(buf);
1055 xbt_dynar_replace(d, cpt, &s1);
1057 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1058 snprintf(buf,1023, "%d", cpt);
1059 s1 = xbt_strdup(buf);
1060 xbt_dynar_replace(d, cpt, &s1);
1062 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1063 snprintf(buf,1023, "%d", cpt);
1064 s1 = xbt_strdup(buf);
1065 xbt_dynar_replace(d, cpt, &s1);
1067 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1068 snprintf(buf,1023, "%d", cpt);
1069 xbt_dynar_shift(d, &s2);
1070 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1073 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1074 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1075 /* in your code is naturally the way to go outside a regression test */
1077 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1078 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1079 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1080 snprintf(buf,1023, "%d", cpt);
1081 s1 = xbt_strdup(buf);
1082 xbt_dynar_unshift(d, &s1);
1084 /* 2. Traverse the dynar with the macro */
1085 xbt_dynar_foreach(d, iter, s1) {
1086 snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1087 xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1089 /* 3. Traverse the dynar with the macro */
1090 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1091 snprintf(buf,1023, "%d", cpt);
1092 xbt_dynar_pop(d, &s2);
1093 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1096 /* 4. Free the resources */
1097 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1098 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1099 /* in your code is naturally the way to go outside a regression test */
1101 xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1102 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1103 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1104 snprintf(buf,1023, "%d", cpt);
1105 s1 = xbt_strdup(buf);
1106 xbt_dynar_push(d, &s1);
1108 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1109 snprintf(buf,1023, "%d", cpt);
1110 s1 = xbt_strdup(buf);
1111 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1114 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1115 snprintf(buf,1023, "%d", cpt);
1116 xbt_dynar_shift(d, &s2);
1117 xbt_test_assert(!strcmp(buf, s2),
1118 "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1121 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1122 snprintf(buf,1023, "%d", cpt);
1123 xbt_dynar_shift(d, &s2);
1124 xbt_test_assert(!strcmp(buf, s2),
1125 "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1128 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1129 snprintf(buf,1023, "%d", cpt);
1130 xbt_dynar_shift(d, &s2);
1131 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1135 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1136 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1137 /* in your code is naturally the way to go outside a regression test */
1139 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1140 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1141 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1142 snprintf(buf,1023, "%d", cpt);
1143 s1 = xbt_strdup(buf);
1144 xbt_dynar_push(d, &s1);
1146 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1147 snprintf(buf,1023, "%d", cpt);
1148 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1149 xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1152 xbt_dynar_free(&d); /* end_of_doxygen */
1154 #endif /* SIMGRID_TEST */