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. */
9 #include "portable.h" /* SIZEOF_MAX */
11 #include "xbt/sysdep.h"
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
17 /* IMPLEMENTATION NOTE ON SYNCHRONIZATION: every functions which name is prefixed by _
18 * assumes that the dynar is already locked if we have to.
19 * Other functions (public ones) check for this.
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
24 static XBT_INLINE void _dynar_lock(xbt_dynar_t dynar)
27 xbt_mutex_acquire(dynar->mutex);
30 static XBT_INLINE void _dynar_unlock(xbt_dynar_t dynar)
33 xbt_mutex_release(dynar->mutex);
36 static XBT_INLINE void _sanity_check_dynar(xbt_dynar_t dynar)
38 xbt_assert0(dynar, "dynar is NULL");
41 static XBT_INLINE void _sanity_check_idx(int idx)
43 xbt_assert1(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
46 static XBT_INLINE void _check_inbound_idx(xbt_dynar_t dynar, int idx)
48 if (idx < 0 || idx >= dynar->used) {
50 THROW2(bound_error, idx,
51 "dynar is not that long. You asked %d, but it's only %lu long",
52 (int) (idx), (unsigned long) dynar->used);
56 static XBT_INLINE void _check_sloppy_inbound_idx(xbt_dynar_t dynar,
59 if (idx > dynar->used) {
61 THROW2(bound_error, idx,
62 "dynar is not that long. You asked %d, but it's only %lu long (could have been equal to it)",
63 (int) (idx), (unsigned long) dynar->used);
67 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
69 if (dynar->used == 0) {
71 THROW1(bound_error, 0, "dynar %p is empty", dynar);
75 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
78 void _xbt_clear_mem(void *const ptr, const unsigned long length)
80 memset(ptr, 0, length);
84 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
86 const unsigned long old_size = dynar->size;
89 char *const old_data = (char *) dynar->data;
91 const unsigned long elmsize = dynar->elmsize;
93 const unsigned long used = dynar->used;
94 const unsigned long used_length = used * elmsize;
96 const unsigned long new_size =
97 nb > (2 * (old_size + 1)) ? nb : (2 * (old_size + 1));
98 const unsigned long new_length = new_size * elmsize;
99 char *const new_data = (char *) xbt_malloc0(elmsize * new_size);
101 DEBUG3("expend %p from %lu to %lu elements", (void *) dynar,
102 (unsigned long) old_size, nb);
105 memcpy(new_data, old_data, used_length);
109 _xbt_clear_mem(new_data + used_length, new_length - used_length);
111 dynar->size = new_size;
112 dynar->data = new_data;
117 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
119 char *const data = (char *) dynar->data;
120 const unsigned long elmsize = dynar->elmsize;
122 return data + idx * elmsize;
127 _xbt_dynar_get_elm(void *const dst,
128 const xbt_dynar_t dynar, const unsigned long idx)
130 void *const elm = _xbt_dynar_elm(dynar, idx);
132 memcpy(dst, elm, dynar->elmsize);
137 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
138 const unsigned long idx, const void *const src)
140 void *const elm = _xbt_dynar_elm(dynar, idx);
141 const unsigned long elmsize = dynar->elmsize;
143 memcpy(elm, src, elmsize);
148 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
149 const unsigned long idx, void *const object)
152 unsigned long nb_shift;
153 unsigned long offset;
155 _sanity_check_dynar(dynar);
156 _check_inbound_idx(dynar, idx);
159 _xbt_dynar_get_elm(object, dynar, idx);
160 } else if (dynar->free_f) {
161 if (dynar->elmsize <= SIZEOF_MAX) {
162 char elm[SIZEOF_MAX];
163 _xbt_dynar_get_elm(elm, dynar, idx);
164 (*dynar->free_f) (elm);
166 char *elm = malloc(dynar->elmsize);
167 _xbt_dynar_get_elm(elm, dynar, idx);
168 (*dynar->free_f) (elm);
173 nb_shift = dynar->used - 1 - idx;
176 offset = nb_shift * dynar->elmsize;
177 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
184 void xbt_dynar_dump(xbt_dynar_t dynar)
186 INFO5("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
187 dynar->size, dynar->used, dynar->elmsize, dynar->data,
191 /** @brief Constructor
193 * \param elmsize size of each element in the dynar
194 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
196 * Creates a new dynar. If a free_func is provided, the elements have to be
197 * pointer of pointer. That is to say that dynars can contain either base
198 * types (int, char, double, etc) or pointer of pointers (struct **).
201 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
204 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
208 dynar->elmsize = elmsize;
210 dynar->free_f = free_f;
216 /** @brief Creates a synchronized dynar.
218 * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
222 xbt_dynar_new_sync(const unsigned long elmsize,
223 void_f_pvoid_t const free_f)
225 xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
226 res->mutex = xbt_mutex_init();
230 /** @brief Destructor of the structure not touching to the content
232 * \param dynar poor victim
234 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
235 * is not touched (the \a free_f function is not used)
237 void xbt_dynar_free_container(xbt_dynar_t * dynar)
239 if (dynar && *dynar) {
241 if ((*dynar)->data) {
242 _xbt_clear_mem((*dynar)->data, (*dynar)->size);
243 free((*dynar)->data);
247 xbt_mutex_destroy((*dynar)->mutex);
249 _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
256 /** @brief Frees the content and set the size to 0
258 * \param dynar who to squeeze
260 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
264 _sanity_check_dynar(dynar);
266 DEBUG1("Reset the dynar %p", (void *) dynar);
268 _dynar_map(dynar, dynar->free_f);
278 _dynar_unlock(dynar);
280 /* dynar->data = NULL; */
284 * \brief Shrink the dynar by removing empty slots at the end of the internal array
285 * \param dynar a dynar
286 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
287 * internal array for further insertions
289 * Reduces the internal array size of the dynar to the number of elements plus
290 * \a empty_slots_wanted.
291 * After removing elements from the dynar, you can call this function to make
292 * the dynar use less memory.
293 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
295 * Note that if \a empty_slots_wanted is greater than the array size, the internal
296 * array is expanded instead of shriked.
298 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
300 unsigned long size_wanted;
304 size_wanted = dynar->used + empty_slots_wanted;
305 if (size_wanted != dynar->size) {
306 dynar->size = size_wanted;
307 dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
309 _dynar_unlock(dynar);
312 /** @brief Destructor
314 * \param dynar poor victim
316 * kilkil a dynar and its content
319 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
321 if (dynar && *dynar) {
322 xbt_dynar_reset(*dynar);
323 xbt_dynar_free_container(dynar);
327 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
328 void xbt_dynar_free_voidp(void *d)
330 xbt_dynar_free((xbt_dynar_t *) d);
333 /** @brief Count of dynar's elements
335 * \param dynar the dynar we want to mesure
337 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
339 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
342 /**@brief check if a dynar is empty
344 *\param dynar the dynat we want to check
347 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
349 return (xbt_dynar_length(dynar) == 0);
352 /** @brief Retrieve a copy of the Nth element of a dynar.
354 * \param dynar information dealer
355 * \param idx index of the slot we want to retrieve
356 * \param[out] dst where to put the result to.
359 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
360 const unsigned long idx, void *const dst)
363 _sanity_check_dynar(dynar);
364 _check_inbound_idx(dynar, idx);
366 _xbt_dynar_get_elm(dst, dynar, idx);
367 _dynar_unlock(dynar);
370 /** @brief Retrieve a pointer to the Nth element of a dynar.
372 * \param dynar information dealer
373 * \param idx index of the slot we want to retrieve
374 * \return the \a idx-th element of \a dynar.
376 * \warning The returned value is the actual content of the dynar.
377 * Make a copy before fooling with it.
379 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
380 const unsigned long idx)
385 _sanity_check_dynar(dynar);
386 _check_inbound_idx(dynar, idx);
388 res = _xbt_dynar_elm(dynar, idx);
389 _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)
399 _sanity_check_dynar(dynar);
400 _sanity_check_idx(idx);
402 _xbt_dynar_expand(dynar, idx + 1);
404 if (idx >= dynar->used) {
405 dynar->used = idx + 1;
408 _xbt_dynar_put_elm(dynar, idx, src);
411 /** @brief Set the Nth element of a dynar (expended if needed). Previous value at this position is NOT freed
413 * \param dynar information dealer
414 * \param idx index of the slot we want to modify
415 * \param src What will be feeded to the dynar
417 * If you want to free the previous content, use xbt_dynar_replace().
419 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
420 const void *const src)
424 _xbt_dynar_set(dynar, idx, src);
425 _dynar_unlock(dynar);
428 /** @brief Set the Nth element of a dynar (expended if needed). Previous value is freed
434 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
435 * free the previous value at this position. If you don't want to free the
436 * previous content, use xbt_dynar_set().
439 xbt_dynar_replace(xbt_dynar_t dynar,
440 const unsigned long idx, const void *const object)
443 _sanity_check_dynar(dynar);
445 if (idx < dynar->used && dynar->free_f) {
446 void *const old_object = _xbt_dynar_elm(dynar, idx);
448 (*(dynar->free_f)) (old_object);
451 _xbt_dynar_set(dynar, idx, object);
452 _dynar_unlock(dynar);
455 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
456 const unsigned long idx)
459 unsigned long old_used;
460 unsigned long new_used;
463 _sanity_check_dynar(dynar);
464 _sanity_check_idx(idx);
466 old_used = dynar->used;
467 new_used = old_used + 1;
469 _xbt_dynar_expand(dynar, new_used);
471 nb_shift = old_used - idx;
474 memmove(_xbt_dynar_elm(dynar, idx + 1),
475 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
478 dynar->used = new_used;
479 res = _xbt_dynar_elm(dynar, idx);
483 /** @brief Make room for a new element, and return a pointer to it
485 * You can then use regular affectation to set its value instead of relying
486 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
488 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
493 res = _xbt_dynar_insert_at_ptr(dynar, idx);
494 _dynar_unlock(dynar);
498 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
500 * Set the Nth element of a dynar, expanding the dynar if needed, and
501 * moving the previously existing value and all subsequent ones to one
502 * position right in the dynar.
505 xbt_dynar_insert_at(xbt_dynar_t const dynar,
506 const int idx, const void *const src)
510 /* checks done in xbt_dynar_insert_at_ptr */
511 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
512 _dynar_unlock(dynar);
515 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
517 * Get the Nth element of a dynar, removing it from the dynar and moving
518 * all subsequent values to one position left in the dynar.
520 * If the object argument of this function is a non-null pointer, the removed
521 * element is copied to this address. If not, the element is freed using the
522 * free_f function passed at dynar creation.
525 xbt_dynar_remove_at(xbt_dynar_t const dynar,
526 const int idx, void *const object)
530 _xbt_dynar_remove_at(dynar, idx, object);
531 _dynar_unlock(dynar);
534 /** @brief Returns the position of the element in the dynar
536 * Raises not_found_error if not found.
538 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
543 for (it = 0; it < dynar->used; it++)
544 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
545 _dynar_unlock(dynar);
549 _dynar_unlock(dynar);
550 THROW2(not_found_error, 0, "Element %p not part of dynar %p", elem,
554 /** @brief Returns a boolean indicating whether the element is part of the dynar */
555 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
561 xbt_dynar_search(dynar, elem);
563 if (e.category == not_found_error) {
572 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
574 * You can then use regular affectation to set its value instead of relying
575 * on the slow memcpy. This is what xbt_dynar_push_as() does.
577 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
581 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
582 dynar->used don't change between reading it and getting the lock
583 within xbt_dynar_insert_at_ptr */
585 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
586 _dynar_unlock(dynar);
590 /** @brief Add an element at the end of the dynar */
591 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
592 const void *const src)
595 /* checks done in xbt_dynar_insert_at_ptr */
596 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
598 _dynar_unlock(dynar);
601 /** @brief Mark the last dynar's element as unused and return a pointer to it.
603 * You can then use regular affectation to set its value instead of relying
604 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
606 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
611 _check_populated_dynar(dynar);
612 DEBUG1("Pop %p", (void *) dynar);
614 res = _xbt_dynar_elm(dynar, dynar->used);
615 _dynar_unlock(dynar);
619 /** @brief Get and remove the last element of the dynar */
620 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
623 /* sanity checks done by remove_at */
624 DEBUG1("Pop %p", (void *) dynar);
626 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
627 _dynar_unlock(dynar);
630 /** @brief Add an element at the begining of the dynar.
632 * This is less efficient than xbt_dynar_push()
634 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
635 const void *const src)
638 /* sanity checks done by insert_at */
639 xbt_dynar_insert_at(dynar, 0, src);
642 /** @brief Get and remove the first element of the dynar.
644 * This is less efficient than xbt_dynar_pop()
646 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
649 /* sanity checks done by remove_at */
650 xbt_dynar_remove_at(dynar, 0, dst);
653 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
655 char elm[SIZEOF_MAX];
656 const unsigned long used = dynar->used;
659 for (i = 0; i < used; i++) {
660 _xbt_dynar_get_elm(elm, dynar, i);
665 /** @brief Apply a function to each member of a dynar
667 * The mapped function may change the value of the element itself,
668 * but should not mess with the structure of the dynar.
670 * If the dynar is synchronized, it is locked during the whole map
671 * operation, so make sure your function don't call any function
672 * from xbt_dynar_* on it, or you'll get a deadlock.
674 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
675 void_f_pvoid_t const op)
678 _sanity_check_dynar(dynar);
681 _dynar_map(dynar, op);
683 _dynar_unlock(dynar);
687 /** @brief Removes and free the entry pointed by the cursor
689 * This function can be used while traversing without problem.
691 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
692 unsigned int *const cursor)
695 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
698 /** @brief Unlocks a synchronized dynar when you want to break the traversal
700 * This function must be used if you <tt>break</tt> the
701 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
702 * regular traversal reaching the end of the elements
704 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
706 _dynar_unlock(dynar);
709 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
711 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
713 * Remark: if the elements stored in the dynar are structures, the compar_fn
714 * function has to retrieve the field to sort first.
716 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
717 int_f_cpvoid_cpvoid_t compar_fn)
722 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
724 _dynar_unlock(dynar);
728 * Return 0 if d1 and d2 are equal and 1 if not equal
730 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
731 int(*compar)(const void *, const void *))
735 if((!d1) && (!d2)) return 0;
736 if((!d1) || (!d2)) return 1;
737 if((d1->elmsize)!=(d2->elmsize)) return 1; // xbt_die
738 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) return 1;
740 size = xbt_dynar_length(d1);
743 void *data1 = xbt_dynar_get_as(d1, i, void *);
744 void *data2 = xbt_dynar_get_as(d2, i, void *);
745 if(compar(data1,data2)) return 1;
754 XBT_TEST_SUITE("dynar", "Dynar data container");
755 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
756 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
758 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
760 /* Vars_decl [doxygen cruft] */
766 xbt_test_add0("==== Traverse the empty dynar");
767 d = xbt_dynar_new(sizeof(int), NULL);
768 xbt_dynar_foreach(d, cursor, i) {
769 xbt_assert0(0, "Damnit, there is something in the empty dynar");
771 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
772 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
773 /* in your code is naturally the way to go outside a regression test */
776 ("==== Push %d int, set them again 3 times, traverse them, shift them",
778 /* Populate_ints [doxygen cruft] */
779 /* 1. Populate the dynar */
780 d = xbt_dynar_new(sizeof(int), NULL);
781 for (cpt = 0; cpt < NB_ELEM; cpt++) {
782 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
783 /* xbt_dynar_push(d,&cpt); This would also work */
784 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
787 /* 2. Traverse manually the dynar */
788 for (cursor = 0; cursor < NB_ELEM; cursor++) {
789 iptr = xbt_dynar_get_ptr(d, cursor);
790 xbt_test_assert2(cursor == *iptr,
791 "The retrieved value is not the same than the injected one (%d!=%d)",
795 /* 3. Traverse the dynar using the neat macro to that extend */
796 xbt_dynar_foreach(d, cursor, cpt) {
797 xbt_test_assert2(cursor == cpt,
798 "The retrieved value is not the same than the injected one (%d!=%d)",
801 /* end_of_traversal */
803 for (cpt = 0; cpt < NB_ELEM; cpt++)
804 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
806 for (cpt = 0; cpt < NB_ELEM; cpt++)
807 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
808 /* xbt_dynar_set(d,cpt,&cpt); */
810 for (cpt = 0; cpt < NB_ELEM; cpt++)
811 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
814 xbt_dynar_foreach(d, cursor, i) {
815 xbt_test_assert2(i == cpt,
816 "The retrieved value is not the same than the injected one (%d!=%d)",
820 xbt_test_assert2(cpt == NB_ELEM,
821 "Cannot retrieve my %d values. Last got one is %d",
824 /* shifting [doxygen cruft] */
825 /* 4. Shift all the values */
826 for (cpt = 0; cpt < NB_ELEM; cpt++) {
827 xbt_dynar_shift(d, &i);
828 xbt_test_assert2(i == cpt,
829 "The retrieved value is not the same than the injected one (%d!=%d)",
831 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
834 /* 5. Free the resources */
835 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
836 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
837 /* in your code is naturally the way to go outside a regression test */
839 xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
840 d = xbt_dynar_new(sizeof(int), NULL);
841 for (cpt = 0; cpt < NB_ELEM; cpt++) {
842 xbt_dynar_unshift(d, &cpt);
843 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
845 for (cpt = 0; cpt < NB_ELEM; cpt++) {
846 i = xbt_dynar_pop_as(d, int);
847 xbt_test_assert2(i == cpt,
848 "The retrieved value is not the same than the injected one (%d!=%d)",
850 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
852 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
853 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
854 /* in your code is naturally the way to go outside a regression test */
858 ("==== Push %d int, insert 1000 int in the middle, shift everything",
860 d = xbt_dynar_new(sizeof(int), NULL);
861 for (cpt = 0; cpt < NB_ELEM; cpt++) {
862 xbt_dynar_push_as(d, int, cpt);
863 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
865 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
866 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
867 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
870 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
871 xbt_dynar_shift(d, &i);
872 xbt_test_assert2(i == cpt,
873 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
875 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
877 for (cpt = 999; cpt >= 0; cpt--) {
878 xbt_dynar_shift(d, &i);
879 xbt_test_assert2(i == cpt,
880 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
883 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
884 xbt_dynar_shift(d, &i);
885 xbt_test_assert2(i == cpt,
886 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
889 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
890 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
891 /* in your code is naturally the way to go outside a regression test */
893 xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest",
895 d = xbt_dynar_new(sizeof(int), NULL);
896 for (cpt = 0; cpt < NB_ELEM; cpt++)
897 xbt_dynar_push_as(d, int, cpt);
899 for (cpt = 2000; cpt < 4000; cpt++) {
900 xbt_dynar_remove_at(d, 2000, &i);
901 xbt_test_assert2(i == cpt,
902 "Remove a bad value. Got %d, expected %d", i, cpt);
903 DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
905 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
906 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
907 /* in your code is naturally the way to go outside a regression test */
910 /*******************************************************************************/
911 /*******************************************************************************/
912 /*******************************************************************************/
913 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
915 xbt_dynar_t d = xbt_dynar_new(sizeof(int), NULL);
919 xbt_test_add1("==== Insert %d int, traverse them, remove them",NB_ELEM);
920 /* Populate_ints [doxygen cruft] */
921 /* 1. Populate the dynar */
922 for (cpt = 0; cpt < NB_ELEM; cpt++) {
923 xbt_dynar_insert_at(d, cpt, &cpt);
924 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
927 /* 3. Traverse the dynar */
928 xbt_dynar_foreach(d, cursor, cpt) {
929 xbt_test_assert2(cursor == cpt,
930 "The retrieved value is not the same than the injected one (%d!=%d)",
933 /* end_of_traversal */
935 /* Re-fill with the same values using set_as (and re-verify) */
936 for (cpt = 0; cpt < NB_ELEM; cpt++)
937 xbt_dynar_set_as(d, cpt, int, cpt);
938 xbt_dynar_foreach(d, cursor, cpt)
939 xbt_test_assert2(cursor == cpt,
940 "The retrieved value is not the same than the injected one (%d!=%d)",
943 for (cpt = 0; cpt < NB_ELEM; cpt++) {
945 xbt_dynar_remove_at(d,0,&val);
946 xbt_test_assert2(cpt == val,
947 "The retrieved value is not the same than the injected one (%d!=%d)",
950 xbt_test_assert1(xbt_dynar_length(d) == 0,
951 "There is still %lu elements in the dynar after removing everything",
952 xbt_dynar_length(d));
955 /* ********************* */
956 xbt_test_add1("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
957 d = xbt_dynar_new(sizeof(int), NULL);
958 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
959 xbt_dynar_replace(d, cpt, &cpt);
960 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
963 /* 3. Traverse the dynar */
964 xbt_dynar_foreach(d, cursor, cpt) {
965 xbt_test_assert2(cursor == cpt,
966 "The retrieved value is not the same than the injected one (%d!=%d)",
969 /* end_of_traversal */
971 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
973 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
974 xbt_test_assert2(cpt == val,
975 "The retrieved value is not the same than the injected one (%d!=%d)",
978 xbt_test_assert1(xbt_dynar_length(d) == 0,
979 "There is still %lu elements in the dynar after removing everything",
980 xbt_dynar_length(d));
984 /*******************************************************************************/
985 /*******************************************************************************/
986 /*******************************************************************************/
987 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
994 xbt_test_add0("==== Traverse the empty dynar");
995 d = xbt_dynar_new(sizeof(int), NULL);
996 xbt_dynar_foreach(d, cursor, cpt) {
997 xbt_test_assert0(FALSE,
998 "Damnit, there is something in the empty dynar");
1000 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1001 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1002 /* in your code is naturally the way to go outside a regression test */
1004 xbt_test_add0("==== Push/shift 5000 doubles");
1005 d = xbt_dynar_new(sizeof(double), NULL);
1006 for (cpt = 0; cpt < 5000; cpt++) {
1008 xbt_dynar_push(d, &d1);
1010 xbt_dynar_foreach(d, cursor, d2) {
1011 d1 = (double) cursor;
1012 xbt_test_assert2(d1 == d2,
1013 "The retrieved value is not the same than the injected one (%f!=%f)",
1016 for (cpt = 0; cpt < 5000; cpt++) {
1018 xbt_dynar_shift(d, &d2);
1019 xbt_test_assert2(d1 == d2,
1020 "The retrieved value is not the same than the injected one (%f!=%f)",
1023 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1024 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1025 /* in your code is naturally the way to go outside a regression test */
1027 xbt_test_add0("==== Unshift/pop 5000 doubles");
1028 d = xbt_dynar_new(sizeof(double), NULL);
1029 for (cpt = 0; cpt < 5000; cpt++) {
1031 xbt_dynar_unshift(d, &d1);
1033 for (cpt = 0; cpt < 5000; cpt++) {
1035 xbt_dynar_pop(d, &d2);
1036 xbt_test_assert2(d1 == d2,
1037 "The retrieved value is not the same than the injected one (%f!=%f)",
1040 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1041 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1042 /* in your code is naturally the way to go outside a regression test */
1047 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1048 d = xbt_dynar_new(sizeof(double), NULL);
1049 for (cpt = 0; cpt < 5000; cpt++) {
1051 xbt_dynar_push(d, &d1);
1053 for (cpt = 0; cpt < 1000; cpt++) {
1055 xbt_dynar_insert_at(d, 2500, &d1);
1058 for (cpt = 0; cpt < 2500; cpt++) {
1060 xbt_dynar_shift(d, &d2);
1061 xbt_test_assert2(d1 == d2,
1062 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1064 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1066 for (cpt = 999; cpt >= 0; cpt--) {
1068 xbt_dynar_shift(d, &d2);
1069 xbt_test_assert2(d1 == d2,
1070 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1073 for (cpt = 2500; cpt < 5000; cpt++) {
1075 xbt_dynar_shift(d, &d2);
1076 xbt_test_assert2(d1 == d2,
1077 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1080 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1081 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1082 /* in your code is naturally the way to go outside a regression test */
1085 xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
1086 d = xbt_dynar_new(sizeof(double), NULL);
1087 for (cpt = 0; cpt < 5000; cpt++) {
1089 xbt_dynar_push(d, &d1);
1091 for (cpt = 2000; cpt < 4000; cpt++) {
1093 xbt_dynar_remove_at(d, 2000, &d2);
1094 xbt_test_assert2(d1 == d2,
1095 "Remove a bad value. Got %f, expected %f", d2, d1);
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 */
1103 /* doxygen_string_cruft */
1105 /*******************************************************************************/
1106 /*******************************************************************************/
1107 /*******************************************************************************/
1108 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1116 xbt_test_add0("==== Traverse the empty dynar");
1117 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1118 xbt_dynar_foreach(d, iter, s1) {
1119 xbt_test_assert0(FALSE,
1120 "Damnit, there is something in the empty dynar");
1122 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1123 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1124 /* in your code is naturally the way to go outside a regression test */
1126 xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
1128 /* Populate_str [doxygen cruft] */
1129 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1130 /* 1. Populate the dynar */
1131 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1132 sprintf(buf, "%d", cpt);
1134 xbt_dynar_push(d, &s1);
1136 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1137 sprintf(buf, "%d", cpt);
1139 xbt_dynar_replace(d, cpt, &s1);
1141 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1142 sprintf(buf, "%d", cpt);
1144 xbt_dynar_replace(d, cpt, &s1);
1146 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1147 sprintf(buf, "%d", cpt);
1149 xbt_dynar_replace(d, cpt, &s1);
1151 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1152 sprintf(buf, "%d", cpt);
1153 xbt_dynar_shift(d, &s2);
1154 xbt_test_assert2(!strcmp(buf, s2),
1155 "The retrieved value is not the same than the injected one (%s!=%s)",
1159 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1160 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1161 /* in your code is naturally the way to go outside a regression test */
1163 xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
1164 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1165 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1166 sprintf(buf, "%d", cpt);
1168 xbt_dynar_unshift(d, &s1);
1170 /* 2. Traverse the dynar with the macro */
1171 xbt_dynar_foreach(d, iter, s1) {
1172 sprintf(buf, "%d", NB_ELEM - iter - 1);
1173 xbt_test_assert2(!strcmp(buf, s1),
1174 "The retrieved value is not the same than the injected one (%s!=%s)",
1177 /* 3. Traverse the dynar with the macro */
1178 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1179 sprintf(buf, "%d", cpt);
1180 xbt_dynar_pop(d, &s2);
1181 xbt_test_assert2(!strcmp(buf, s2),
1182 "The retrieved value is not the same than the injected one (%s!=%s)",
1186 /* 4. Free the resources */
1187 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1188 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1189 /* in your code is naturally the way to go outside a regression test */
1193 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1194 NB_ELEM, NB_ELEM / 5);
1195 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1196 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1197 sprintf(buf, "%d", cpt);
1199 xbt_dynar_push(d, &s1);
1201 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1202 sprintf(buf, "%d", cpt);
1204 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1207 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1208 sprintf(buf, "%d", cpt);
1209 xbt_dynar_shift(d, &s2);
1210 xbt_test_assert2(!strcmp(buf, s2),
1211 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1215 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1216 sprintf(buf, "%d", cpt);
1217 xbt_dynar_shift(d, &s2);
1218 xbt_test_assert2(!strcmp(buf, s2),
1219 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1223 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1224 sprintf(buf, "%d", cpt);
1225 xbt_dynar_shift(d, &s2);
1226 xbt_test_assert2(!strcmp(buf, s2),
1227 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1231 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1232 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1233 /* in your code is naturally the way to go outside a regression test */
1236 xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest",
1237 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1238 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1239 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1240 sprintf(buf, "%d", cpt);
1242 xbt_dynar_push(d, &s1);
1244 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1245 sprintf(buf, "%d", cpt);
1246 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1247 xbt_test_assert2(!strcmp(buf, s2),
1248 "Remove a bad value. Got %s, expected %s", s2, buf);
1251 xbt_dynar_free(&d); /* end_of_doxygen */
1255 /*******************************************************************************/
1256 /*******************************************************************************/
1257 /*******************************************************************************/
1258 #include "xbt/synchro.h"
1259 static void pusher_f(void *a)
1261 xbt_dynar_t d = (xbt_dynar_t) a;
1263 for (i = 0; i < 500; i++) {
1264 xbt_dynar_push(d, &i);
1268 static void poper_f(void *a)
1270 xbt_dynar_t d = (xbt_dynar_t) a;
1275 for (i = 0; i < 500; i++) {
1277 xbt_dynar_pop(d, &data);
1280 if (e.category == bound_error) {
1291 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1293 /* Vars_decl [doxygen cruft] */
1295 xbt_thread_t pusher, poper;
1297 xbt_test_add0("==== Have a pusher and a popper on the dynar");
1298 d = xbt_dynar_new_sync(sizeof(int), NULL);
1299 pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1300 poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1301 xbt_thread_join(pusher);
1302 xbt_thread_join(poper);
1306 #endif /* SIMGRID_TEST */