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 inline 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 inline 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 inline 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 inline 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 inline 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 inline 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 inline 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 inline 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 inline 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)
466 xbt_dynar_search(dynar, elem);
468 if (e.category == not_found_error) {
477 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
479 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
480 * xbt_dynar_push_as() does.
482 inline void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
484 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
487 /** @brief Add an element at the end of the dynar */
488 inline void xbt_dynar_push(xbt_dynar_t const dynar, const void *const src)
490 /* checks done in xbt_dynar_insert_at_ptr */
491 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
494 /** @brief Mark the last dynar's element as unused 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_pop_as() does.
499 inline void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
501 _check_populated_dynar(dynar);
502 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
504 return _xbt_dynar_elm(dynar, dynar->used);
507 /** @brief Get and remove the last element of the dynar */
508 inline void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
510 /* sanity checks done by remove_at */
511 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
512 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
515 /** @brief Add an element at the begining of the dynar.
517 * This is less efficient than xbt_dynar_push()
519 inline void xbt_dynar_unshift(xbt_dynar_t const dynar, const void *const src)
521 /* sanity checks done by insert_at */
522 xbt_dynar_insert_at(dynar, 0, src);
525 /** @brief Get and remove the first element of the dynar.
527 * This is less efficient than xbt_dynar_pop()
529 inline void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
531 /* sanity checks done by remove_at */
532 xbt_dynar_remove_at(dynar, 0, dst);
535 /** @brief Apply a function to each member of a dynar
537 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
539 inline void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
541 char *const data = (char *) dynar->data;
542 const unsigned long elmsize = dynar->elmsize;
543 const unsigned long used = dynar->used;
546 _sanity_check_dynar(dynar);
548 for (i = 0; i < used; i++) {
549 char* elm = (char*) data + i * elmsize;
554 /** @brief Removes and free the entry pointed by the cursor
556 * This function can be used while traversing without problem.
558 inline void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor)
560 xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
563 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
565 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
566 * You should thus refer to the libc documentation, or to some online tutorial on how to write
567 * a comparison function. Here is a quick example if you have integers in your dynar:
570 * int cmpfunc (const void * a, const void * b) {
571 * int intA = *(int*)a;
572 * int intB = *(int*)b;
573 * return intA - intB;
577 * and now to sort a dynar of MSG hosts depending on their speed:
579 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
580 * MSG_host_t hostA = *(MSG_host_t*)a;
581 * MSG_host_t hostB = *(MSG_host_t*)b;
582 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
586 * \param dynar the dynar to sort
587 * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
589 inline void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
591 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
594 static int strcmp_voidp(const void *pa, const void *pb) {
595 return strcmp(*(const char **)pa, *(const char **)pb);
598 /** @brief Sorts a dynar of strings (ie, char* data) */
599 xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
601 xbt_dynar_sort(dynar, strcmp_voidp);
602 return dynar; // to enable functional uses
605 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
606 * Since there are only three colors, it is linear and much faster than a classical sort.
607 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
609 * \param dynar the dynar to sort
610 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to
613 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the
614 * end and elements with color 1 are in the middle.
616 * Remark: if the elements stored in the dynar are structures, the color function has to retrieve the field to sort
619 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color)
622 unsigned long int p = -1;
623 unsigned long int q = dynar->used;
624 const unsigned long elmsize = dynar->elmsize;
625 void *tmp = xbt_malloc(elmsize);
628 for (i = 0; i < q;) {
629 void *elmi = _xbt_dynar_elm(dynar, i);
630 int colori = color(elmi);
636 elm = _xbt_dynar_elm(dynar, ++p);
638 } else { /* colori == 2 */
639 elm = _xbt_dynar_elm(dynar, --q);
642 memcpy(tmp, elm, elmsize);
643 memcpy(elm, elmi, elmsize);
644 memcpy(elmi, tmp, elmsize);
651 /** @brief Transform a dynar into a NULL terminated array.
653 * \param dynar the dynar to transform
654 * \return pointer to the first element of the array
656 * Note: The dynar won't be usable afterwards.
658 inline void *xbt_dynar_to_array(xbt_dynar_t dynar)
661 xbt_dynar_shrink(dynar, 1);
662 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
668 /** @brief Compare two dynars
670 * \param d1 first dynar to compare
671 * \param d2 second dynar to compare
672 * \param compar function to use to compare elements
673 * \return 0 if d1 and d2 are equal and 1 if not equal
675 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
676 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
679 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int(*compar)(const void *, const void *))
683 if((!d1) && (!d2)) return 0;
686 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
690 if((d1->elmsize)!=(d2->elmsize)) {
691 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
695 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
696 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
701 size = xbt_dynar_length(d1);
702 for(i=0;i<size;i++) {
703 void *data1 = xbt_dynar_get_as(d1, i, void *);
704 void *data2 = xbt_dynar_get_as(d2, i, void *);
705 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
706 if(compar(data1,data2)){
719 XBT_TEST_SUITE("dynar", "Dynar data container");
720 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
722 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
724 /* Vars_decl [doxygen cruft] */
730 xbt_test_add("==== Traverse the empty dynar");
731 d = xbt_dynar_new(sizeof(int), NULL);
732 xbt_dynar_foreach(d, cursor, i) {
733 xbt_die( "Damnit, there is something in the empty dynar");
735 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
736 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
737 /* in your code is naturally the way to go outside a regression test */
739 xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
740 /* Populate_ints [doxygen cruft] */
741 /* 1. Populate the dynar */
742 d = xbt_dynar_new(sizeof(int), NULL);
743 for (cpt = 0; cpt < NB_ELEM; cpt++) {
744 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
745 /* xbt_dynar_push(d,&cpt); This would also work */
746 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
749 /* 2. Traverse manually the dynar */
750 for (cursor = 0; cursor < NB_ELEM; cursor++) {
751 iptr = xbt_dynar_get_ptr(d, cursor);
752 xbt_test_assert(cursor == *iptr, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
755 /* 3. Traverse the dynar using the neat macro to that extend */
756 xbt_dynar_foreach(d, cursor, cpt) {
757 xbt_test_assert(cursor == cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
759 /* end_of_traversal */
761 for (cpt = 0; cpt < NB_ELEM; cpt++)
762 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
764 for (cpt = 0; cpt < NB_ELEM; cpt++)
765 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
766 /* xbt_dynar_set(d,cpt,&cpt); */
768 for (cpt = 0; cpt < NB_ELEM; cpt++)
769 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
772 xbt_dynar_foreach(d, cursor, i) {
773 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
776 xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
778 /* shifting [doxygen cruft] */
779 /* 4. Shift all the values */
780 for (cpt = 0; cpt < NB_ELEM; cpt++) {
781 xbt_dynar_shift(d, &i);
782 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
783 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
787 xbt_dynar_foreach_ptr(d, cursor, pi) {
790 xbt_dynar_foreach(d, cursor, i) {
791 xbt_test_assert(i == 0, "The value is not the same as the expected one.");
793 xbt_dynar_foreach_ptr(d, cursor, pi) {
796 xbt_dynar_foreach(d, cursor, i) {
797 xbt_test_assert(i == 1, "The value is not the same as the expected one.");
800 /* 5. Free the resources */
801 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
802 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
803 /* in your code is naturally the way to go outside a regression test */
805 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
806 d = xbt_dynar_new(sizeof(int), NULL);
807 for (cpt = 0; cpt < NB_ELEM; cpt++) {
808 xbt_dynar_unshift(d, &cpt);
809 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
811 for (cpt = 0; cpt < NB_ELEM; cpt++) {
812 i = xbt_dynar_pop_as(d, int);
813 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
814 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
816 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
817 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
818 /* in your code is naturally the way to go outside a regression test */
820 xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
821 d = xbt_dynar_new(sizeof(int), NULL);
822 for (cpt = 0; cpt < NB_ELEM; cpt++) {
823 xbt_dynar_push_as(d, int, cpt);
824 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
826 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
827 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
828 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
831 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
832 xbt_dynar_shift(d, &i);
833 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
835 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
837 for (cpt = 999; cpt >= 0; cpt--) {
838 xbt_dynar_shift(d, &i);
839 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
842 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
843 xbt_dynar_shift(d, &i);
844 xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
846 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
847 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
848 /* in your code is naturally the way to go outside a regression test */
850 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
851 d = xbt_dynar_new(sizeof(int), NULL);
852 for (cpt = 0; cpt < NB_ELEM; cpt++)
853 xbt_dynar_push_as(d, int, cpt);
855 for (cpt = 2000; cpt < 4000; cpt++) {
856 xbt_dynar_remove_at(d, 2000, &i);
857 xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
858 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
860 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
861 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
862 /* in your code is naturally the way to go outside a regression test */
865 /*******************************************************************************/
866 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
868 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
872 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
873 /* Populate_ints [doxygen cruft] */
874 /* 1. Populate the dynar */
875 for (cpt = 0; cpt < NB_ELEM; cpt++) {
876 xbt_dynar_insert_at(d, cpt, &cpt);
877 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
880 /* 3. Traverse the dynar */
881 xbt_dynar_foreach(d, cursor, cpt) {
882 xbt_test_assert(cursor == cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
884 /* end_of_traversal */
886 /* Re-fill with the same values using set_as (and re-verify) */
887 for (cpt = 0; cpt < NB_ELEM; cpt++)
888 xbt_dynar_set_as(d, cpt, int, cpt);
889 xbt_dynar_foreach(d, cursor, cpt)
890 xbt_test_assert(cursor == cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
892 for (cpt = 0; cpt < NB_ELEM; cpt++) {
894 xbt_dynar_remove_at(d,0,&val);
895 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
897 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
898 xbt_dynar_length(d));
901 /* ********************* */
902 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
903 d = xbt_dynar_new(sizeof(int), NULL);
904 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
905 xbt_dynar_replace(d, cpt, &cpt);
906 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
909 /* 3. Traverse the dynar */
910 xbt_dynar_foreach(d, cursor, cpt) {
911 xbt_test_assert(cursor == cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
913 /* end_of_traversal */
915 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
917 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
918 xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
920 xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
921 xbt_dynar_length(d));
925 /*******************************************************************************/
926 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
933 xbt_test_add("==== Traverse the empty dynar");
934 d = xbt_dynar_new(sizeof(int), NULL);
935 xbt_dynar_foreach(d, cursor, cpt) {
936 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
938 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
939 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
940 /* in your code is naturally the way to go outside a regression test */
942 xbt_test_add("==== Push/shift 5000 doubles");
943 d = xbt_dynar_new(sizeof(double), NULL);
944 for (cpt = 0; cpt < 5000; cpt++) {
946 xbt_dynar_push(d, &d1);
948 xbt_dynar_foreach(d, cursor, d2) {
949 d1 = (double) cursor;
950 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
952 for (cpt = 0; cpt < 5000; cpt++) {
954 xbt_dynar_shift(d, &d2);
955 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
957 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
958 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
959 /* in your code is naturally the way to go outside a regression test */
961 xbt_test_add("==== Unshift/pop 5000 doubles");
962 d = xbt_dynar_new(sizeof(double), NULL);
963 for (cpt = 0; cpt < 5000; cpt++) {
965 xbt_dynar_unshift(d, &d1);
967 for (cpt = 0; cpt < 5000; cpt++) {
969 xbt_dynar_pop(d, &d2);
970 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
972 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
973 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
974 /* in your code is naturally the way to go outside a regression test */
976 xbt_test_add("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
977 d = xbt_dynar_new(sizeof(double), NULL);
978 for (cpt = 0; cpt < 5000; cpt++) {
980 xbt_dynar_push(d, &d1);
982 for (cpt = 0; cpt < 1000; cpt++) {
984 xbt_dynar_insert_at(d, 2500, &d1);
987 for (cpt = 0; cpt < 2500; cpt++) {
989 xbt_dynar_shift(d, &d2);
990 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
992 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
994 for (cpt = 999; cpt >= 0; cpt--) {
996 xbt_dynar_shift(d, &d2);
997 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1000 for (cpt = 2500; cpt < 5000; cpt++) {
1002 xbt_dynar_shift(d, &d2);
1003 xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1005 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1006 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1007 /* in your code is naturally the way to go outside a regression test */
1009 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1010 d = xbt_dynar_new(sizeof(double), NULL);
1011 for (cpt = 0; cpt < 5000; cpt++) {
1013 xbt_dynar_push(d, &d1);
1015 for (cpt = 2000; cpt < 4000; cpt++) {
1017 xbt_dynar_remove_at(d, 2000, &d2);
1018 xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1020 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1021 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1022 /* in your code is naturally the way to go outside a regression test */
1025 /* doxygen_string_cruft */
1027 /*******************************************************************************/
1028 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1036 xbt_test_add("==== Traverse the empty dynar");
1037 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1038 xbt_dynar_foreach(d, iter, s1) {
1039 xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
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 */
1045 xbt_test_add("==== Push %d strings, set them again 3 times, shift them", NB_ELEM);
1046 /* Populate_str [doxygen cruft] */
1047 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1048 /* 1. Populate the dynar */
1049 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1050 snprintf(buf,1023, "%d", cpt);
1051 s1 = xbt_strdup(buf);
1052 xbt_dynar_push(d, &s1);
1054 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1055 snprintf(buf,1023, "%d", cpt);
1056 s1 = xbt_strdup(buf);
1057 xbt_dynar_replace(d, cpt, &s1);
1059 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1060 snprintf(buf,1023, "%d", cpt);
1061 s1 = xbt_strdup(buf);
1062 xbt_dynar_replace(d, cpt, &s1);
1064 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1065 snprintf(buf,1023, "%d", cpt);
1066 s1 = xbt_strdup(buf);
1067 xbt_dynar_replace(d, cpt, &s1);
1069 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1070 snprintf(buf,1023, "%d", cpt);
1071 xbt_dynar_shift(d, &s2);
1072 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1075 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1076 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1077 /* in your code is naturally the way to go outside a regression test */
1079 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1080 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1081 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1082 snprintf(buf,1023, "%d", cpt);
1083 s1 = xbt_strdup(buf);
1084 xbt_dynar_unshift(d, &s1);
1086 /* 2. Traverse the dynar with the macro */
1087 xbt_dynar_foreach(d, iter, s1) {
1088 snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1089 xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1091 /* 3. Traverse the dynar with the macro */
1092 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1093 snprintf(buf,1023, "%d", cpt);
1094 xbt_dynar_pop(d, &s2);
1095 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1098 /* 4. Free the resources */
1099 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1100 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1101 /* in your code is naturally the way to go outside a regression test */
1103 xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1104 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1105 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1106 snprintf(buf,1023, "%d", cpt);
1107 s1 = xbt_strdup(buf);
1108 xbt_dynar_push(d, &s1);
1110 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1111 snprintf(buf,1023, "%d", cpt);
1112 s1 = xbt_strdup(buf);
1113 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1116 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1117 snprintf(buf,1023, "%d", cpt);
1118 xbt_dynar_shift(d, &s2);
1119 xbt_test_assert(!strcmp(buf, s2),
1120 "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1123 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1124 snprintf(buf,1023, "%d", cpt);
1125 xbt_dynar_shift(d, &s2);
1126 xbt_test_assert(!strcmp(buf, s2),
1127 "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1130 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1131 snprintf(buf,1023, "%d", cpt);
1132 xbt_dynar_shift(d, &s2);
1133 xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1137 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1138 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1139 /* in your code is naturally the way to go outside a regression test */
1141 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1142 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1143 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1144 snprintf(buf,1023, "%d", cpt);
1145 s1 = xbt_strdup(buf);
1146 xbt_dynar_push(d, &s1);
1148 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1149 snprintf(buf,1023, "%d", cpt);
1150 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1151 xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1154 xbt_dynar_free(&d); /* end_of_doxygen */
1156 #endif /* SIMGRID_TEST */