1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 /* IMPLEMENTATION NOTE ON SYNCHRONIZATION: every functions which name is prefixed by _
17 * assumes that the dynar is already locked if we have to.
18 * Other functions (public ones) check for this.
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
23 static XBT_INLINE void _dynar_lock(xbt_dynar_t dynar)
26 xbt_mutex_acquire(dynar->mutex);
29 static XBT_INLINE void _dynar_unlock(xbt_dynar_t dynar)
32 xbt_mutex_release(dynar->mutex);
35 static XBT_INLINE void _sanity_check_dynar(xbt_dynar_t dynar)
37 xbt_assert(dynar, "dynar is NULL");
40 static XBT_INLINE void _sanity_check_idx(int idx)
42 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
45 static XBT_INLINE void _check_inbound_idx(xbt_dynar_t dynar, int idx)
47 if (idx < 0 || idx >= dynar->used) {
49 THROWF(bound_error, idx,
50 "dynar is not that long. You asked %d, but it's only %lu long",
51 (int) (idx), (unsigned long) dynar->used);
55 static XBT_INLINE void _check_sloppy_inbound_idx(xbt_dynar_t dynar,
58 if (idx > dynar->used) {
60 THROWF(bound_error, idx,
61 "dynar is not that long. You asked %d, but it's only %lu long (could have been equal to it)",
62 (int) (idx), (unsigned long) dynar->used);
66 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
68 if (dynar->used == 0) {
70 THROWF(bound_error, 0, "dynar %p is empty", dynar);
74 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
77 void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
79 if (new_size != dynar->size) {
80 dynar->size = new_size;
81 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
86 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
88 const unsigned long old_size = dynar->size;
91 const unsigned long expand = 2 * (old_size + 1);
92 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
93 XBT_DEBUG("expand %p from %lu to %lu elements",
94 dynar, old_size, dynar->size);
99 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
101 char *const data = (char *) dynar->data;
102 const unsigned long elmsize = dynar->elmsize;
104 return data + idx * elmsize;
109 _xbt_dynar_get_elm(void *const dst,
110 const xbt_dynar_t dynar, const unsigned long idx)
112 void *const elm = _xbt_dynar_elm(dynar, idx);
114 memcpy(dst, elm, dynar->elmsize);
119 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
120 const unsigned long idx, const void *const src)
122 void *const elm = _xbt_dynar_elm(dynar, idx);
123 const unsigned long elmsize = dynar->elmsize;
125 memcpy(elm, src, elmsize);
130 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
131 const unsigned long idx, void *const object)
134 unsigned long nb_shift;
135 unsigned long offset;
137 _sanity_check_dynar(dynar);
138 _check_inbound_idx(dynar, idx);
141 _xbt_dynar_get_elm(object, dynar, idx);
142 } else if (dynar->free_f) {
143 dynar->free_f(_xbt_dynar_elm(dynar, idx));
146 nb_shift = dynar->used - 1 - idx;
149 offset = nb_shift * dynar->elmsize;
150 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
157 void xbt_dynar_dump(xbt_dynar_t dynar)
159 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
160 dynar->size, dynar->used, dynar->elmsize, dynar->data,
164 /** @brief Constructor
166 * \param elmsize size of each element in the dynar
167 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
169 * Creates a new dynar. If a free_func is provided, the elements have to be
170 * pointer of pointer. That is to say that dynars can contain either base
171 * types (int, char, double, etc) or pointer of pointers (struct **).
174 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
177 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
181 dynar->elmsize = elmsize;
183 dynar->free_f = free_f;
189 /** @brief Creates a synchronized dynar.
191 * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
195 xbt_dynar_new_sync(const unsigned long elmsize,
196 void_f_pvoid_t const free_f)
198 xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
199 res->mutex = xbt_mutex_init();
203 /** @brief Destructor of the structure not touching to the content
205 * \param dynar poor victim
207 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
208 * is not touched (the \a free_f function is not used)
210 void xbt_dynar_free_container(xbt_dynar_t * dynar)
212 if (dynar && *dynar) {
213 xbt_dynar_t d = *dynar;
216 xbt_mutex_destroy(d->mutex);
222 /** @brief Frees the content and set the size to 0
224 * \param dynar who to squeeze
226 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
230 _sanity_check_dynar(dynar);
232 XBT_DEBUG("Reset the dynar %p", (void *) dynar);
234 _dynar_map(dynar, dynar->free_f);
238 _dynar_unlock(dynar);
241 /** @brief Merge dynar d2 into d1
243 * \param d1 dynar to keep
244 * \param d2 dynar to merge into d1. This dynar is free at end.
246 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
248 if((*d1)->elmsize != (*d2)->elmsize)
249 xbt_die("Element size must are not equal");
251 const unsigned long elmsize = (*d1)->elmsize;
253 void *ptr = _xbt_dynar_elm((*d2), 0);
254 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
255 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
257 memcpy(elm, ptr, ((*d2)->size)*elmsize);
258 (*d1)->used += (*d2)->used;
264 * \brief Shrink the dynar by removing empty slots at the end of the internal array
265 * \param dynar a dynar
266 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
267 * internal array for further insertions
269 * Reduces the internal array size of the dynar to the number of elements plus
270 * \a empty_slots_wanted.
271 * After removing elements from the dynar, you can call this function to make
272 * the dynar use less memory.
273 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
275 * Note that if \a empty_slots_wanted is greater than the array size, the internal
276 * array is expanded instead of shriked.
278 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
281 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
282 _dynar_unlock(dynar);
285 /** @brief Destructor
287 * \param dynar poor victim
289 * kilkil a dynar and its content
292 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
294 if (dynar && *dynar) {
295 xbt_dynar_reset(*dynar);
296 xbt_dynar_free_container(dynar);
300 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
301 void xbt_dynar_free_voidp(void *d)
303 xbt_dynar_t dynar = (xbt_dynar_t)d;
304 xbt_dynar_free(&dynar);
307 /** @brief Count of dynar's elements
309 * \param dynar the dynar we want to mesure
311 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
313 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
316 /**@brief check if a dynar is empty
318 *\param dynar the dynat we want to check
321 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
323 return (xbt_dynar_length(dynar) == 0);
326 /** @brief Retrieve a copy of the Nth element of a dynar.
328 * \param dynar information dealer
329 * \param idx index of the slot we want to retrieve
330 * \param[out] dst where to put the result to.
333 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
334 const unsigned long idx, void *const dst)
337 _sanity_check_dynar(dynar);
338 _check_inbound_idx(dynar, idx);
340 _xbt_dynar_get_elm(dst, dynar, idx);
341 _dynar_unlock(dynar);
344 /** @brief Retrieve a pointer to the Nth element of a dynar.
346 * \param dynar information dealer
347 * \param idx index of the slot we want to retrieve
348 * \return the \a idx-th element of \a dynar.
350 * \warning The returned value is the actual content of the dynar.
351 * Make a copy before fooling with it.
353 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
354 const unsigned long idx)
359 _sanity_check_dynar(dynar);
360 _check_inbound_idx(dynar, idx);
362 res = _xbt_dynar_elm(dynar, idx);
363 _dynar_unlock(dynar);
367 /* not synchronized */
368 static XBT_INLINE void *_xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
369 const unsigned long idx)
371 _sanity_check_dynar(dynar);
373 if (idx >= dynar->used) {
374 _xbt_dynar_expand(dynar, idx + 1);
375 if (idx > dynar->used) {
376 memset(_xbt_dynar_elm(dynar, dynar->used), 0,
377 (idx - dynar->used) * dynar->elmsize);
379 dynar->used = idx + 1;
381 return _xbt_dynar_elm(dynar, idx);
384 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
385 const unsigned long idx)
389 res = _xbt_dynar_set_at_ptr(dynar, idx);
390 _dynar_unlock(dynar);
394 static void XBT_INLINE /* not synchronized */
395 _xbt_dynar_set(xbt_dynar_t dynar,
396 const unsigned long idx, const void *const src)
398 memcpy(_xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
401 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
403 * \param dynar information dealer
404 * \param idx index of the slot we want to modify
405 * \param src What will be feeded to the dynar
407 * If you want to free the previous content, use xbt_dynar_replace().
409 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
410 const void *const src)
414 _xbt_dynar_set(dynar, idx, src);
415 _dynar_unlock(dynar);
418 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
424 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
425 * free the previous value at this position. If you don't want to free the
426 * previous content, use xbt_dynar_set().
429 xbt_dynar_replace(xbt_dynar_t dynar,
430 const unsigned long idx, const void *const object)
433 _sanity_check_dynar(dynar);
435 if (idx < dynar->used && dynar->free_f) {
436 void *const old_object = _xbt_dynar_elm(dynar, idx);
438 dynar->free_f(old_object);
441 _xbt_dynar_set(dynar, idx, object);
442 _dynar_unlock(dynar);
445 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
446 const unsigned long idx)
449 unsigned long old_used;
450 unsigned long new_used;
453 _sanity_check_dynar(dynar);
454 _sanity_check_idx(idx);
456 old_used = dynar->used;
457 new_used = old_used + 1;
459 _xbt_dynar_expand(dynar, new_used);
461 nb_shift = old_used - idx;
464 memmove(_xbt_dynar_elm(dynar, idx + 1),
465 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
468 dynar->used = new_used;
469 res = _xbt_dynar_elm(dynar, idx);
473 /** @brief Make room for a new element, and return a pointer to it
475 * You can then use regular affectation to set its value instead of relying
476 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
478 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
483 res = _xbt_dynar_insert_at_ptr(dynar, idx);
484 _dynar_unlock(dynar);
488 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
490 * Set the Nth element of a dynar, expanding the dynar if needed, and
491 * moving the previously existing value and all subsequent ones to one
492 * position right in the dynar.
495 xbt_dynar_insert_at(xbt_dynar_t const dynar,
496 const int idx, const void *const src)
500 /* checks done in xbt_dynar_insert_at_ptr */
501 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
502 _dynar_unlock(dynar);
505 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
507 * Get the Nth element of a dynar, removing it from the dynar and moving
508 * all subsequent values to one position left in the dynar.
510 * If the object argument of this function is a non-null pointer, the removed
511 * element is copied to this address. If not, the element is freed using the
512 * free_f function passed at dynar creation.
515 xbt_dynar_remove_at(xbt_dynar_t const dynar,
516 const int idx, void *const object)
520 _xbt_dynar_remove_at(dynar, idx, object);
521 _dynar_unlock(dynar);
524 /** @brief Returns the position of the element in the dynar
526 * Raises not_found_error if not found. If you have less than 2 millions elements,
527 * you probably want to use #xbt_dynar_search_or_negative() instead, so that you
528 * don't have to TRY/CATCH on element not found.
530 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
535 for (it = 0; it < dynar->used; it++)
536 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
537 _dynar_unlock(dynar);
541 _dynar_unlock(dynar);
542 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
546 /** @brief Returns the position of the element in the dynar (or -1 if not found)
548 * Note that usually, the dynar indices are unsigned integers. If you have more
549 * than 2 million elements in your dynar, this very function will not work (but the other will).
551 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
556 for (it = 0; it < dynar->used; it++)
557 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
558 _dynar_unlock(dynar);
562 _dynar_unlock(dynar);
566 /** @brief Returns a boolean indicating whether the element is part of the dynar */
567 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
573 xbt_dynar_search(dynar, elem);
576 if (e.category == not_found_error) {
585 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
587 * You can then use regular affectation to set its value instead of relying
588 * on the slow memcpy. This is what xbt_dynar_push_as() does.
590 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
594 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
595 dynar->used don't change between reading it and getting the lock
596 within xbt_dynar_insert_at_ptr */
598 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
599 _dynar_unlock(dynar);
603 /** @brief Add an element at the end of the dynar */
604 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
605 const void *const src)
608 /* checks done in xbt_dynar_insert_at_ptr */
609 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
611 _dynar_unlock(dynar);
614 /** @brief Mark the last dynar's element as unused and return a pointer to it.
616 * You can then use regular affectation to set its value instead of relying
617 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
619 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
624 _check_populated_dynar(dynar);
625 XBT_DEBUG("Pop %p", (void *) dynar);
627 res = _xbt_dynar_elm(dynar, dynar->used);
628 _dynar_unlock(dynar);
632 /** @brief Get and remove the last element of the dynar */
633 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
636 /* sanity checks done by remove_at */
637 XBT_DEBUG("Pop %p", (void *) dynar);
639 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
640 _dynar_unlock(dynar);
643 /** @brief Add an element at the begining of the dynar.
645 * This is less efficient than xbt_dynar_push()
647 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
648 const void *const src)
651 /* sanity checks done by insert_at */
652 xbt_dynar_insert_at(dynar, 0, src);
655 /** @brief Get and remove the first element of the dynar.
657 * This is less efficient than xbt_dynar_pop()
659 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
662 /* sanity checks done by remove_at */
663 xbt_dynar_remove_at(dynar, 0, dst);
666 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
668 char *const data = (char *) dynar->data;
669 const unsigned long elmsize = dynar->elmsize;
670 const unsigned long used = dynar->used;
673 for (i = 0; i < used; i++) {
674 char* elm = (char*) data + i * elmsize;
679 /** @brief Apply a function to each member of a dynar
681 * The mapped function may change the value of the element itself,
682 * but should not mess with the structure of the dynar.
684 * If the dynar is synchronized, it is locked during the whole map
685 * operation, so make sure your function don't call any function
686 * from xbt_dynar_* on it, or you'll get a deadlock.
688 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
689 void_f_pvoid_t const op)
692 _sanity_check_dynar(dynar);
695 _dynar_map(dynar, op);
697 _dynar_unlock(dynar);
701 /** @brief Removes and free the entry pointed by the cursor
703 * This function can be used while traversing without problem.
705 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
706 unsigned int *const cursor)
709 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
712 /** @brief Unlocks a synchronized dynar when you want to break the traversal
714 * This function must be used if you <tt>break</tt> the
715 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
716 * regular traversal reaching the end of the elements
718 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
720 _dynar_unlock(dynar);
723 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
725 * \param dynar the dynar to sort
726 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
728 * Remark: if the elements stored in the dynar are structures, the compar_fn
729 * function has to retrieve the field to sort first.
731 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
732 int_f_cpvoid_cpvoid_t compar_fn)
737 #ifdef HAVE_MERGESORT
738 mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
740 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
742 _dynar_unlock(dynar);
745 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
746 * Since there are only three colors, it is linear and much faster than a classical sort.
747 * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
749 * \param dynar the dynar to sort
750 * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to be 0, 1, or 2.
752 * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the end and elements with color 1 are in the middle.
754 * Remark: if the elements stored in the dynar are structures, the color
755 * function has to retrieve the field to sort first.
757 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
762 unsigned long int p = -1;
763 unsigned long int q = dynar->used;
764 const unsigned long elmsize = dynar->elmsize;
765 void *tmp = xbt_malloc(elmsize);
768 for (i = 0; i < q;) {
769 void *elmi = _xbt_dynar_elm(dynar, i);
770 int colori = color(elmi);
776 elm = _xbt_dynar_elm(dynar, ++p);
778 } else { /* colori == 2 */
779 elm = _xbt_dynar_elm(dynar, --q);
782 memcpy(tmp, elm, elmsize);
783 memcpy(elm, elmi, elmsize);
784 memcpy(elmi, tmp, elmsize);
788 _dynar_unlock(dynar);
792 /** @brief Transform a dynar into a NULL terminated array
794 * \param dynar the dynar to transform
796 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
799 xbt_dynar_shrink(dynar, 1);
800 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
803 xbt_mutex_destroy(dynar->mutex);
809 * Return 0 if d1 and d2 are equal and 1 if not equal
811 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
812 int(*compar)(const void *, const void *))
816 if((!d1) && (!d2)) return 0;
819 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
823 if((d1->elmsize)!=(d2->elmsize))
825 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
829 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
831 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
836 size = xbt_dynar_length(d1);
839 void *data1 = xbt_dynar_get_as(d1, i, void *);
840 void *data2 = xbt_dynar_get_as(d2, i, void *);
841 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
842 if(compar(data1,data2)){
855 XBT_TEST_SUITE("dynar", "Dynar data container");
856 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
858 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
860 /* Vars_decl [doxygen cruft] */
866 xbt_test_add("==== Traverse the empty dynar");
867 d = xbt_dynar_new(sizeof(int), NULL);
868 xbt_dynar_foreach(d, cursor, i) {
869 xbt_die( "Damnit, there is something in the empty dynar");
871 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
872 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
873 /* in your code is naturally the way to go outside a regression test */
876 ("==== Push %d int, set them again 3 times, traverse them, shift them",
878 /* Populate_ints [doxygen cruft] */
879 /* 1. Populate the dynar */
880 d = xbt_dynar_new(sizeof(int), NULL);
881 for (cpt = 0; cpt < NB_ELEM; cpt++) {
882 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
883 /* xbt_dynar_push(d,&cpt); This would also work */
884 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
887 /* 2. Traverse manually the dynar */
888 for (cursor = 0; cursor < NB_ELEM; cursor++) {
889 iptr = xbt_dynar_get_ptr(d, cursor);
890 xbt_test_assert(cursor == *iptr,
891 "The retrieved value is not the same than the injected one (%u!=%d)",
895 /* 3. Traverse the dynar using the neat macro to that extend */
896 xbt_dynar_foreach(d, cursor, cpt) {
897 xbt_test_assert(cursor == cpt,
898 "The retrieved value is not the same than the injected one (%u!=%d)",
901 /* end_of_traversal */
903 for (cpt = 0; cpt < NB_ELEM; cpt++)
904 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
906 for (cpt = 0; cpt < NB_ELEM; cpt++)
907 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
908 /* xbt_dynar_set(d,cpt,&cpt); */
910 for (cpt = 0; cpt < NB_ELEM; cpt++)
911 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
914 xbt_dynar_foreach(d, cursor, i) {
915 xbt_test_assert(i == cpt,
916 "The retrieved value is not the same than the injected one (%d!=%d)",
920 xbt_test_assert(cpt == NB_ELEM,
921 "Cannot retrieve my %d values. Last got one is %d",
924 /* shifting [doxygen cruft] */
925 /* 4. Shift all the values */
926 for (cpt = 0; cpt < NB_ELEM; cpt++) {
927 xbt_dynar_shift(d, &i);
928 xbt_test_assert(i == cpt,
929 "The retrieved value is not the same than the injected one (%d!=%d)",
931 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
934 /* 5. Free the resources */
935 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
936 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
937 /* in your code is naturally the way to go outside a regression test */
939 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
940 d = xbt_dynar_new(sizeof(int), NULL);
941 for (cpt = 0; cpt < NB_ELEM; cpt++) {
942 xbt_dynar_unshift(d, &cpt);
943 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
945 for (cpt = 0; cpt < NB_ELEM; cpt++) {
946 i = xbt_dynar_pop_as(d, int);
947 xbt_test_assert(i == cpt,
948 "The retrieved value is not the same than the injected one (%d!=%d)",
950 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
952 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
953 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
954 /* in your code is naturally the way to go outside a regression test */
958 ("==== Push %d int, insert 1000 int in the middle, shift everything",
960 d = xbt_dynar_new(sizeof(int), NULL);
961 for (cpt = 0; cpt < NB_ELEM; cpt++) {
962 xbt_dynar_push_as(d, int, cpt);
963 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
965 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
966 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
967 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
970 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
971 xbt_dynar_shift(d, &i);
972 xbt_test_assert(i == cpt,
973 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
975 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
977 for (cpt = 999; cpt >= 0; cpt--) {
978 xbt_dynar_shift(d, &i);
979 xbt_test_assert(i == cpt,
980 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
983 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
984 xbt_dynar_shift(d, &i);
985 xbt_test_assert(i == cpt,
986 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
989 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
990 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
991 /* in your code is naturally the way to go outside a regression test */
993 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
995 d = xbt_dynar_new(sizeof(int), NULL);
996 for (cpt = 0; cpt < NB_ELEM; cpt++)
997 xbt_dynar_push_as(d, int, cpt);
999 for (cpt = 2000; cpt < 4000; cpt++) {
1000 xbt_dynar_remove_at(d, 2000, &i);
1001 xbt_test_assert(i == cpt,
1002 "Remove a bad value. Got %d, expected %d", i, cpt);
1003 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
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 */
1010 /*******************************************************************************/
1011 /*******************************************************************************/
1012 /*******************************************************************************/
1013 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
1015 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
1016 unsigned int cursor;
1019 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
1020 /* Populate_ints [doxygen cruft] */
1021 /* 1. Populate the dynar */
1022 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1023 xbt_dynar_insert_at(d, cpt, &cpt);
1024 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1027 /* 3. Traverse the dynar */
1028 xbt_dynar_foreach(d, cursor, cpt) {
1029 xbt_test_assert(cursor == cpt,
1030 "The retrieved value is not the same than the injected one (%u!=%d)",
1033 /* end_of_traversal */
1035 /* Re-fill with the same values using set_as (and re-verify) */
1036 for (cpt = 0; cpt < NB_ELEM; cpt++)
1037 xbt_dynar_set_as(d, cpt, int, cpt);
1038 xbt_dynar_foreach(d, cursor, cpt)
1039 xbt_test_assert(cursor == cpt,
1040 "The retrieved value is not the same than the injected one (%u!=%d)",
1043 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1045 xbt_dynar_remove_at(d,0,&val);
1046 xbt_test_assert(cpt == val,
1047 "The retrieved value is not the same than the injected one (%u!=%d)",
1050 xbt_test_assert(xbt_dynar_is_empty(d),
1051 "There is still %lu elements in the dynar after removing everything",
1052 xbt_dynar_length(d));
1055 /* ********************* */
1056 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1057 d = xbt_dynar_new(sizeof(int), NULL);
1058 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1059 xbt_dynar_replace(d, cpt, &cpt);
1060 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1063 /* 3. Traverse the dynar */
1064 xbt_dynar_foreach(d, cursor, cpt) {
1065 xbt_test_assert(cursor == cpt,
1066 "The retrieved value is not the same than the injected one (%u!=%d)",
1069 /* end_of_traversal */
1071 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1073 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1074 xbt_test_assert(cpt == val,
1075 "The retrieved value is not the same than the injected one (%u!=%d)",
1078 xbt_test_assert(xbt_dynar_is_empty(d),
1079 "There is still %lu elements in the dynar after removing everything",
1080 xbt_dynar_length(d));
1084 /*******************************************************************************/
1085 /*******************************************************************************/
1086 /*******************************************************************************/
1087 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1091 unsigned int cursor;
1094 xbt_test_add("==== Traverse the empty dynar");
1095 d = xbt_dynar_new(sizeof(int), NULL);
1096 xbt_dynar_foreach(d, cursor, cpt) {
1097 xbt_test_assert(FALSE,
1098 "Damnit, there is something in the empty dynar");
1100 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1101 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1102 /* in your code is naturally the way to go outside a regression test */
1104 xbt_test_add("==== Push/shift 5000 doubles");
1105 d = xbt_dynar_new(sizeof(double), NULL);
1106 for (cpt = 0; cpt < 5000; cpt++) {
1108 xbt_dynar_push(d, &d1);
1110 xbt_dynar_foreach(d, cursor, d2) {
1111 d1 = (double) cursor;
1112 xbt_test_assert(d1 == d2,
1113 "The retrieved value is not the same than the injected one (%f!=%f)",
1116 for (cpt = 0; cpt < 5000; cpt++) {
1118 xbt_dynar_shift(d, &d2);
1119 xbt_test_assert(d1 == d2,
1120 "The retrieved value is not the same than the injected one (%f!=%f)",
1123 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1124 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1125 /* in your code is naturally the way to go outside a regression test */
1127 xbt_test_add("==== Unshift/pop 5000 doubles");
1128 d = xbt_dynar_new(sizeof(double), NULL);
1129 for (cpt = 0; cpt < 5000; cpt++) {
1131 xbt_dynar_unshift(d, &d1);
1133 for (cpt = 0; cpt < 5000; cpt++) {
1135 xbt_dynar_pop(d, &d2);
1136 xbt_test_assert(d1 == d2,
1137 "The retrieved value is not the same than the injected one (%f!=%f)",
1140 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1141 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1142 /* in your code is naturally the way to go outside a regression test */
1147 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1148 d = xbt_dynar_new(sizeof(double), NULL);
1149 for (cpt = 0; cpt < 5000; cpt++) {
1151 xbt_dynar_push(d, &d1);
1153 for (cpt = 0; cpt < 1000; cpt++) {
1155 xbt_dynar_insert_at(d, 2500, &d1);
1158 for (cpt = 0; cpt < 2500; cpt++) {
1160 xbt_dynar_shift(d, &d2);
1161 xbt_test_assert(d1 == d2,
1162 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1164 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1166 for (cpt = 999; cpt >= 0; cpt--) {
1168 xbt_dynar_shift(d, &d2);
1169 xbt_test_assert(d1 == d2,
1170 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1173 for (cpt = 2500; cpt < 5000; cpt++) {
1175 xbt_dynar_shift(d, &d2);
1176 xbt_test_assert(d1 == d2,
1177 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1180 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1181 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1182 /* in your code is naturally the way to go outside a regression test */
1185 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1186 d = xbt_dynar_new(sizeof(double), NULL);
1187 for (cpt = 0; cpt < 5000; cpt++) {
1189 xbt_dynar_push(d, &d1);
1191 for (cpt = 2000; cpt < 4000; cpt++) {
1193 xbt_dynar_remove_at(d, 2000, &d2);
1194 xbt_test_assert(d1 == d2,
1195 "Remove a bad value. Got %f, expected %f", d2, d1);
1197 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1198 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1199 /* in your code is naturally the way to go outside a regression test */
1203 /* doxygen_string_cruft */
1205 /*******************************************************************************/
1206 /*******************************************************************************/
1207 /*******************************************************************************/
1208 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1216 xbt_test_add("==== Traverse the empty dynar");
1217 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1218 xbt_dynar_foreach(d, iter, s1) {
1219 xbt_test_assert(FALSE,
1220 "Damnit, there is something in the empty dynar");
1222 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1223 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1224 /* in your code is naturally the way to go outside a regression test */
1226 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1228 /* Populate_str [doxygen cruft] */
1229 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1230 /* 1. Populate the dynar */
1231 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1232 sprintf(buf, "%d", cpt);
1234 xbt_dynar_push(d, &s1);
1236 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1237 sprintf(buf, "%d", cpt);
1239 xbt_dynar_replace(d, cpt, &s1);
1241 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1242 sprintf(buf, "%d", cpt);
1244 xbt_dynar_replace(d, cpt, &s1);
1246 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1247 sprintf(buf, "%d", cpt);
1249 xbt_dynar_replace(d, cpt, &s1);
1251 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1252 sprintf(buf, "%d", cpt);
1253 xbt_dynar_shift(d, &s2);
1254 xbt_test_assert(!strcmp(buf, s2),
1255 "The retrieved value is not the same than the injected one (%s!=%s)",
1259 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1260 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1261 /* in your code is naturally the way to go outside a regression test */
1263 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1264 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1265 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1266 sprintf(buf, "%d", cpt);
1268 xbt_dynar_unshift(d, &s1);
1270 /* 2. Traverse the dynar with the macro */
1271 xbt_dynar_foreach(d, iter, s1) {
1272 sprintf(buf, "%u", NB_ELEM - iter - 1);
1273 xbt_test_assert(!strcmp(buf, s1),
1274 "The retrieved value is not the same than the injected one (%s!=%s)",
1277 /* 3. Traverse the dynar with the macro */
1278 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1279 sprintf(buf, "%d", cpt);
1280 xbt_dynar_pop(d, &s2);
1281 xbt_test_assert(!strcmp(buf, s2),
1282 "The retrieved value is not the same than the injected one (%s!=%s)",
1286 /* 4. Free the resources */
1287 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1288 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1289 /* in your code is naturally the way to go outside a regression test */
1293 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1294 NB_ELEM, NB_ELEM / 5);
1295 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1296 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1297 sprintf(buf, "%d", cpt);
1299 xbt_dynar_push(d, &s1);
1301 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1302 sprintf(buf, "%d", cpt);
1304 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1307 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1308 sprintf(buf, "%d", cpt);
1309 xbt_dynar_shift(d, &s2);
1310 xbt_test_assert(!strcmp(buf, s2),
1311 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1315 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1316 sprintf(buf, "%d", cpt);
1317 xbt_dynar_shift(d, &s2);
1318 xbt_test_assert(!strcmp(buf, s2),
1319 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1323 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1324 sprintf(buf, "%d", cpt);
1325 xbt_dynar_shift(d, &s2);
1326 xbt_test_assert(!strcmp(buf, s2),
1327 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1331 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1332 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1333 /* in your code is naturally the way to go outside a regression test */
1336 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1337 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1338 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1339 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1340 sprintf(buf, "%d", cpt);
1342 xbt_dynar_push(d, &s1);
1344 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1345 sprintf(buf, "%d", cpt);
1346 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1347 xbt_test_assert(!strcmp(buf, s2),
1348 "Remove a bad value. Got %s, expected %s", s2, buf);
1351 xbt_dynar_free(&d); /* end_of_doxygen */
1355 /*******************************************************************************/
1356 /*******************************************************************************/
1357 /*******************************************************************************/
1358 #include "xbt/synchro.h"
1359 static void pusher_f(void *a)
1361 xbt_dynar_t d = (xbt_dynar_t) a;
1363 for (i = 0; i < 500; i++) {
1364 xbt_dynar_push(d, &i);
1368 static void poper_f(void *a)
1370 xbt_dynar_t d = (xbt_dynar_t) a;
1375 for (i = 0; i < 500; i++) {
1377 xbt_dynar_pop(d, &data);
1380 if (e.category == bound_error) {
1391 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1393 /* Vars_decl [doxygen cruft] */
1395 xbt_thread_t pusher, poper;
1397 xbt_test_add("==== Have a pusher and a popper on the dynar");
1398 d = xbt_dynar_new_sync(sizeof(int), NULL);
1399 pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1400 poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1401 xbt_thread_join(pusher);
1402 xbt_thread_join(poper);
1406 #endif /* SIMGRID_TEST */