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("expand %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);
393 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
394 const unsigned long idx)
399 _sanity_check_dynar(dynar);
401 _xbt_dynar_expand(dynar, idx + 1);
403 if (idx >= dynar->used) {
404 _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
405 (idx + 1 - dynar->used)*dynar->elmsize);
406 dynar->used = idx + 1;
409 _dynar_unlock(dynar);
411 res = _xbt_dynar_elm(dynar, idx);
416 static void XBT_INLINE /* not synchronized */
417 _xbt_dynar_set(xbt_dynar_t dynar,
418 const unsigned long idx, const void *const src)
421 _sanity_check_dynar(dynar);
423 _xbt_dynar_expand(dynar, idx + 1);
425 if (idx >= dynar->used) {
426 _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
427 (idx + 1 - dynar->used)*dynar->elmsize);
428 dynar->used = idx + 1;
431 _xbt_dynar_put_elm(dynar, idx, src);
434 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
436 * \param dynar information dealer
437 * \param idx index of the slot we want to modify
438 * \param src What will be feeded to the dynar
440 * If you want to free the previous content, use xbt_dynar_replace().
442 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
443 const void *const src)
447 _xbt_dynar_set(dynar, idx, src);
448 _dynar_unlock(dynar);
451 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
457 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
458 * free the previous value at this position. If you don't want to free the
459 * previous content, use xbt_dynar_set().
462 xbt_dynar_replace(xbt_dynar_t dynar,
463 const unsigned long idx, const void *const object)
466 _sanity_check_dynar(dynar);
468 if (idx < dynar->used && dynar->free_f) {
469 void *const old_object = _xbt_dynar_elm(dynar, idx);
471 (*(dynar->free_f)) (old_object);
474 _xbt_dynar_set(dynar, idx, object);
475 _dynar_unlock(dynar);
478 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
479 const unsigned long idx)
482 unsigned long old_used;
483 unsigned long new_used;
486 _sanity_check_dynar(dynar);
487 _sanity_check_idx(idx);
489 old_used = dynar->used;
490 new_used = old_used + 1;
492 _xbt_dynar_expand(dynar, new_used);
494 nb_shift = old_used - idx;
497 memmove(_xbt_dynar_elm(dynar, idx + 1),
498 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
501 dynar->used = new_used;
502 res = _xbt_dynar_elm(dynar, idx);
506 /** @brief Make room for a new element, and return a pointer to it
508 * You can then use regular affectation to set its value instead of relying
509 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
511 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
516 res = _xbt_dynar_insert_at_ptr(dynar, idx);
517 _dynar_unlock(dynar);
521 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
523 * Set the Nth element of a dynar, expanding the dynar if needed, and
524 * moving the previously existing value and all subsequent ones to one
525 * position right in the dynar.
528 xbt_dynar_insert_at(xbt_dynar_t const dynar,
529 const int idx, const void *const src)
533 /* checks done in xbt_dynar_insert_at_ptr */
534 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
535 _dynar_unlock(dynar);
538 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
540 * Get the Nth element of a dynar, removing it from the dynar and moving
541 * all subsequent values to one position left in the dynar.
543 * If the object argument of this function is a non-null pointer, the removed
544 * element is copied to this address. If not, the element is freed using the
545 * free_f function passed at dynar creation.
548 xbt_dynar_remove_at(xbt_dynar_t const dynar,
549 const int idx, void *const object)
553 _xbt_dynar_remove_at(dynar, idx, object);
554 _dynar_unlock(dynar);
557 /** @brief Returns the position of the element in the dynar
559 * Raises not_found_error if not found.
561 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
566 for (it = 0; it < dynar->used; it++)
567 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
568 _dynar_unlock(dynar);
572 _dynar_unlock(dynar);
573 THROW2(not_found_error, 0, "Element %p not part of dynar %p", elem,
577 /** @brief Returns a boolean indicating whether the element is part of the dynar */
578 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
584 xbt_dynar_search(dynar, elem);
586 if (e.category == not_found_error) {
595 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
597 * You can then use regular affectation to set its value instead of relying
598 * on the slow memcpy. This is what xbt_dynar_push_as() does.
600 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
604 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
605 dynar->used don't change between reading it and getting the lock
606 within xbt_dynar_insert_at_ptr */
608 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
609 _dynar_unlock(dynar);
613 /** @brief Add an element at the end of the dynar */
614 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
615 const void *const src)
618 /* checks done in xbt_dynar_insert_at_ptr */
619 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
621 _dynar_unlock(dynar);
624 /** @brief Mark the last dynar's element as unused and return a pointer to it.
626 * You can then use regular affectation to set its value instead of relying
627 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
629 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
634 _check_populated_dynar(dynar);
635 DEBUG1("Pop %p", (void *) dynar);
637 res = _xbt_dynar_elm(dynar, dynar->used);
638 _dynar_unlock(dynar);
642 /** @brief Get and remove the last element of the dynar */
643 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
646 /* sanity checks done by remove_at */
647 DEBUG1("Pop %p", (void *) dynar);
649 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
650 _dynar_unlock(dynar);
653 /** @brief Add an element at the begining of the dynar.
655 * This is less efficient than xbt_dynar_push()
657 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
658 const void *const src)
661 /* sanity checks done by insert_at */
662 xbt_dynar_insert_at(dynar, 0, src);
665 /** @brief Get and remove the first element of the dynar.
667 * This is less efficient than xbt_dynar_pop()
669 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
672 /* sanity checks done by remove_at */
673 xbt_dynar_remove_at(dynar, 0, dst);
676 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
678 char elm[SIZEOF_MAX];
679 const unsigned long used = dynar->used;
682 for (i = 0; i < used; i++) {
683 _xbt_dynar_get_elm(elm, dynar, i);
688 /** @brief Apply a function to each member of a dynar
690 * The mapped function may change the value of the element itself,
691 * but should not mess with the structure of the dynar.
693 * If the dynar is synchronized, it is locked during the whole map
694 * operation, so make sure your function don't call any function
695 * from xbt_dynar_* on it, or you'll get a deadlock.
697 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
698 void_f_pvoid_t const op)
701 _sanity_check_dynar(dynar);
704 _dynar_map(dynar, op);
706 _dynar_unlock(dynar);
710 /** @brief Removes and free the entry pointed by the cursor
712 * This function can be used while traversing without problem.
714 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
715 unsigned int *const cursor)
718 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
721 /** @brief Unlocks a synchronized dynar when you want to break the traversal
723 * This function must be used if you <tt>break</tt> the
724 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
725 * regular traversal reaching the end of the elements
727 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
729 _dynar_unlock(dynar);
732 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
734 * \param dynar the dynar to sort
735 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
737 * Remark: if the elements stored in the dynar are structures, the compar_fn
738 * function has to retrieve the field to sort first.
740 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
741 int_f_cpvoid_cpvoid_t compar_fn)
746 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
748 _dynar_unlock(dynar);
751 /** @brief Transform a dynar into a NULL terminated array
753 * \param dynar the dynar to transform
755 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
758 void * last = xbt_new0(char,dynar->elmsize);
759 xbt_dynar_push(dynar, last);
767 * Return 0 if d1 and d2 are equal and 1 if not equal
769 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
770 int(*compar)(const void *, const void *))
774 if((!d1) && (!d2)) return 0;
777 DEBUG2("NULL dynar d1=%p d2=%p",d1,d2);
780 if((d1->elmsize)!=(d2->elmsize))
782 DEBUG2("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
785 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
787 DEBUG2("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
791 size = xbt_dynar_length(d1);
794 void *data1 = xbt_dynar_get_as(d1, i, void *);
795 void *data2 = xbt_dynar_get_as(d2, i, void *);
796 DEBUG3("link[%d] d1=%p d2=%p",i,data1,data2);
797 if(compar(data1,data2)) return 1;
806 XBT_TEST_SUITE("dynar", "Dynar data container");
807 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
808 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
810 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
812 /* Vars_decl [doxygen cruft] */
818 xbt_test_add0("==== Traverse the empty dynar");
819 d = xbt_dynar_new(sizeof(int), NULL);
820 xbt_dynar_foreach(d, cursor, i) {
821 xbt_assert0(0, "Damnit, there is something in the empty dynar");
823 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
824 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
825 /* in your code is naturally the way to go outside a regression test */
828 ("==== Push %d int, set them again 3 times, traverse them, shift them",
830 /* Populate_ints [doxygen cruft] */
831 /* 1. Populate the dynar */
832 d = xbt_dynar_new(sizeof(int), NULL);
833 for (cpt = 0; cpt < NB_ELEM; cpt++) {
834 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
835 /* xbt_dynar_push(d,&cpt); This would also work */
836 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
839 /* 2. Traverse manually the dynar */
840 for (cursor = 0; cursor < NB_ELEM; cursor++) {
841 iptr = xbt_dynar_get_ptr(d, cursor);
842 xbt_test_assert2(cursor == *iptr,
843 "The retrieved value is not the same than the injected one (%d!=%d)",
847 /* 3. Traverse the dynar using the neat macro to that extend */
848 xbt_dynar_foreach(d, cursor, cpt) {
849 xbt_test_assert2(cursor == cpt,
850 "The retrieved value is not the same than the injected one (%d!=%d)",
853 /* end_of_traversal */
855 for (cpt = 0; cpt < NB_ELEM; cpt++)
856 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
858 for (cpt = 0; cpt < NB_ELEM; cpt++)
859 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
860 /* xbt_dynar_set(d,cpt,&cpt); */
862 for (cpt = 0; cpt < NB_ELEM; cpt++)
863 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
866 xbt_dynar_foreach(d, cursor, i) {
867 xbt_test_assert2(i == cpt,
868 "The retrieved value is not the same than the injected one (%d!=%d)",
872 xbt_test_assert2(cpt == NB_ELEM,
873 "Cannot retrieve my %d values. Last got one is %d",
876 /* shifting [doxygen cruft] */
877 /* 4. Shift all the values */
878 for (cpt = 0; cpt < NB_ELEM; cpt++) {
879 xbt_dynar_shift(d, &i);
880 xbt_test_assert2(i == cpt,
881 "The retrieved value is not the same than the injected one (%d!=%d)",
883 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
886 /* 5. Free the resources */
887 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
888 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
889 /* in your code is naturally the way to go outside a regression test */
891 xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
892 d = xbt_dynar_new(sizeof(int), NULL);
893 for (cpt = 0; cpt < NB_ELEM; cpt++) {
894 xbt_dynar_unshift(d, &cpt);
895 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
897 for (cpt = 0; cpt < NB_ELEM; cpt++) {
898 i = xbt_dynar_pop_as(d, int);
899 xbt_test_assert2(i == cpt,
900 "The retrieved value is not the same than the injected one (%d!=%d)",
902 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
904 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
905 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
906 /* in your code is naturally the way to go outside a regression test */
910 ("==== Push %d int, insert 1000 int in the middle, shift everything",
912 d = xbt_dynar_new(sizeof(int), NULL);
913 for (cpt = 0; cpt < NB_ELEM; cpt++) {
914 xbt_dynar_push_as(d, int, cpt);
915 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
917 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
918 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
919 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
922 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
923 xbt_dynar_shift(d, &i);
924 xbt_test_assert2(i == cpt,
925 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
927 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
929 for (cpt = 999; cpt >= 0; cpt--) {
930 xbt_dynar_shift(d, &i);
931 xbt_test_assert2(i == cpt,
932 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
935 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
936 xbt_dynar_shift(d, &i);
937 xbt_test_assert2(i == cpt,
938 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
941 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
942 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
943 /* in your code is naturally the way to go outside a regression test */
945 xbt_test_add1("==== Push %d int, remove 2000-4000. free the rest",
947 d = xbt_dynar_new(sizeof(int), NULL);
948 for (cpt = 0; cpt < NB_ELEM; cpt++)
949 xbt_dynar_push_as(d, int, cpt);
951 for (cpt = 2000; cpt < 4000; cpt++) {
952 xbt_dynar_remove_at(d, 2000, &i);
953 xbt_test_assert2(i == cpt,
954 "Remove a bad value. Got %d, expected %d", i, cpt);
955 DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
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 */
962 /*******************************************************************************/
963 /*******************************************************************************/
964 /*******************************************************************************/
965 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
967 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
971 xbt_test_add1("==== Insert %d int, traverse them, remove them",NB_ELEM);
972 /* Populate_ints [doxygen cruft] */
973 /* 1. Populate the dynar */
974 for (cpt = 0; cpt < NB_ELEM; cpt++) {
975 xbt_dynar_insert_at(d, cpt, &cpt);
976 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
979 /* 3. Traverse the dynar */
980 xbt_dynar_foreach(d, cursor, cpt) {
981 xbt_test_assert2(cursor == cpt,
982 "The retrieved value is not the same than the injected one (%d!=%d)",
985 /* end_of_traversal */
987 /* Re-fill with the same values using set_as (and re-verify) */
988 for (cpt = 0; cpt < NB_ELEM; cpt++)
989 xbt_dynar_set_as(d, cpt, int, cpt);
990 xbt_dynar_foreach(d, cursor, cpt)
991 xbt_test_assert2(cursor == cpt,
992 "The retrieved value is not the same than the injected one (%d!=%d)",
995 for (cpt = 0; cpt < NB_ELEM; cpt++) {
997 xbt_dynar_remove_at(d,0,&val);
998 xbt_test_assert2(cpt == val,
999 "The retrieved value is not the same than the injected one (%d!=%d)",
1002 xbt_test_assert1(xbt_dynar_length(d) == 0,
1003 "There is still %lu elements in the dynar after removing everything",
1004 xbt_dynar_length(d));
1007 /* ********************* */
1008 xbt_test_add1("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1009 d = xbt_dynar_new(sizeof(int), NULL);
1010 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1011 xbt_dynar_replace(d, cpt, &cpt);
1012 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1015 /* 3. Traverse the dynar */
1016 xbt_dynar_foreach(d, cursor, cpt) {
1017 xbt_test_assert2(cursor == cpt,
1018 "The retrieved value is not the same than the injected one (%d!=%d)",
1021 /* end_of_traversal */
1023 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1025 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1026 xbt_test_assert2(cpt == val,
1027 "The retrieved value is not the same than the injected one (%d!=%d)",
1030 xbt_test_assert1(xbt_dynar_length(d) == 0,
1031 "There is still %lu elements in the dynar after removing everything",
1032 xbt_dynar_length(d));
1036 /*******************************************************************************/
1037 /*******************************************************************************/
1038 /*******************************************************************************/
1039 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1043 unsigned int cursor;
1046 xbt_test_add0("==== Traverse the empty dynar");
1047 d = xbt_dynar_new(sizeof(int), NULL);
1048 xbt_dynar_foreach(d, cursor, cpt) {
1049 xbt_test_assert0(FALSE,
1050 "Damnit, there is something in the empty dynar");
1052 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1053 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1054 /* in your code is naturally the way to go outside a regression test */
1056 xbt_test_add0("==== Push/shift 5000 doubles");
1057 d = xbt_dynar_new(sizeof(double), NULL);
1058 for (cpt = 0; cpt < 5000; cpt++) {
1060 xbt_dynar_push(d, &d1);
1062 xbt_dynar_foreach(d, cursor, d2) {
1063 d1 = (double) cursor;
1064 xbt_test_assert2(d1 == d2,
1065 "The retrieved value is not the same than the injected one (%f!=%f)",
1068 for (cpt = 0; cpt < 5000; cpt++) {
1070 xbt_dynar_shift(d, &d2);
1071 xbt_test_assert2(d1 == d2,
1072 "The retrieved value is not the same than the injected one (%f!=%f)",
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_add0("==== Unshift/pop 5000 doubles");
1080 d = xbt_dynar_new(sizeof(double), NULL);
1081 for (cpt = 0; cpt < 5000; cpt++) {
1083 xbt_dynar_unshift(d, &d1);
1085 for (cpt = 0; cpt < 5000; cpt++) {
1087 xbt_dynar_pop(d, &d2);
1088 xbt_test_assert2(d1 == d2,
1089 "The retrieved value is not the same than the injected one (%f!=%f)",
1092 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1093 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1094 /* in your code is naturally the way to go outside a regression test */
1099 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1100 d = xbt_dynar_new(sizeof(double), NULL);
1101 for (cpt = 0; cpt < 5000; cpt++) {
1103 xbt_dynar_push(d, &d1);
1105 for (cpt = 0; cpt < 1000; cpt++) {
1107 xbt_dynar_insert_at(d, 2500, &d1);
1110 for (cpt = 0; cpt < 2500; cpt++) {
1112 xbt_dynar_shift(d, &d2);
1113 xbt_test_assert2(d1 == d2,
1114 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1116 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1118 for (cpt = 999; cpt >= 0; cpt--) {
1120 xbt_dynar_shift(d, &d2);
1121 xbt_test_assert2(d1 == d2,
1122 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1125 for (cpt = 2500; cpt < 5000; cpt++) {
1127 xbt_dynar_shift(d, &d2);
1128 xbt_test_assert2(d1 == d2,
1129 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1132 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1133 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1134 /* in your code is naturally the way to go outside a regression test */
1137 xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
1138 d = xbt_dynar_new(sizeof(double), NULL);
1139 for (cpt = 0; cpt < 5000; cpt++) {
1141 xbt_dynar_push(d, &d1);
1143 for (cpt = 2000; cpt < 4000; cpt++) {
1145 xbt_dynar_remove_at(d, 2000, &d2);
1146 xbt_test_assert2(d1 == d2,
1147 "Remove a bad value. Got %f, expected %f", d2, d1);
1149 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1150 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1151 /* in your code is naturally the way to go outside a regression test */
1155 /* doxygen_string_cruft */
1157 /*******************************************************************************/
1158 /*******************************************************************************/
1159 /*******************************************************************************/
1160 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1168 xbt_test_add0("==== Traverse the empty dynar");
1169 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1170 xbt_dynar_foreach(d, iter, s1) {
1171 xbt_test_assert0(FALSE,
1172 "Damnit, there is something in the empty dynar");
1174 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1175 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1176 /* in your code is naturally the way to go outside a regression test */
1178 xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
1180 /* Populate_str [doxygen cruft] */
1181 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1182 /* 1. Populate the dynar */
1183 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1184 sprintf(buf, "%d", cpt);
1186 xbt_dynar_push(d, &s1);
1188 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1189 sprintf(buf, "%d", cpt);
1191 xbt_dynar_replace(d, cpt, &s1);
1193 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1194 sprintf(buf, "%d", cpt);
1196 xbt_dynar_replace(d, cpt, &s1);
1198 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1199 sprintf(buf, "%d", cpt);
1201 xbt_dynar_replace(d, cpt, &s1);
1203 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1204 sprintf(buf, "%d", cpt);
1205 xbt_dynar_shift(d, &s2);
1206 xbt_test_assert2(!strcmp(buf, s2),
1207 "The retrieved value is not the same than the injected one (%s!=%s)",
1211 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1212 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1213 /* in your code is naturally the way to go outside a regression test */
1215 xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
1216 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1217 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1218 sprintf(buf, "%d", cpt);
1220 xbt_dynar_unshift(d, &s1);
1222 /* 2. Traverse the dynar with the macro */
1223 xbt_dynar_foreach(d, iter, s1) {
1224 sprintf(buf, "%d", NB_ELEM - iter - 1);
1225 xbt_test_assert2(!strcmp(buf, s1),
1226 "The retrieved value is not the same than the injected one (%s!=%s)",
1229 /* 3. Traverse the dynar with the macro */
1230 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1231 sprintf(buf, "%d", cpt);
1232 xbt_dynar_pop(d, &s2);
1233 xbt_test_assert2(!strcmp(buf, s2),
1234 "The retrieved value is not the same than the injected one (%s!=%s)",
1238 /* 4. Free the resources */
1239 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1240 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1241 /* in your code is naturally the way to go outside a regression test */
1245 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1246 NB_ELEM, NB_ELEM / 5);
1247 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1248 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1249 sprintf(buf, "%d", cpt);
1251 xbt_dynar_push(d, &s1);
1253 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1254 sprintf(buf, "%d", cpt);
1256 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1259 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1260 sprintf(buf, "%d", cpt);
1261 xbt_dynar_shift(d, &s2);
1262 xbt_test_assert2(!strcmp(buf, s2),
1263 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1267 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1268 sprintf(buf, "%d", cpt);
1269 xbt_dynar_shift(d, &s2);
1270 xbt_test_assert2(!strcmp(buf, s2),
1271 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1275 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1276 sprintf(buf, "%d", cpt);
1277 xbt_dynar_shift(d, &s2);
1278 xbt_test_assert2(!strcmp(buf, s2),
1279 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1283 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1284 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1285 /* in your code is naturally the way to go outside a regression test */
1288 xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest",
1289 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1290 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1291 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1292 sprintf(buf, "%d", cpt);
1294 xbt_dynar_push(d, &s1);
1296 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1297 sprintf(buf, "%d", cpt);
1298 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1299 xbt_test_assert2(!strcmp(buf, s2),
1300 "Remove a bad value. Got %s, expected %s", s2, buf);
1303 xbt_dynar_free(&d); /* end_of_doxygen */
1307 /*******************************************************************************/
1308 /*******************************************************************************/
1309 /*******************************************************************************/
1310 #include "xbt/synchro.h"
1311 static void pusher_f(void *a)
1313 xbt_dynar_t d = (xbt_dynar_t) a;
1315 for (i = 0; i < 500; i++) {
1316 xbt_dynar_push(d, &i);
1320 static void poper_f(void *a)
1322 xbt_dynar_t d = (xbt_dynar_t) a;
1327 for (i = 0; i < 500; i++) {
1329 xbt_dynar_pop(d, &data);
1332 if (e.category == bound_error) {
1343 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1345 /* Vars_decl [doxygen cruft] */
1347 xbt_thread_t pusher, poper;
1349 xbt_test_add0("==== Have a pusher and a popper on the dynar");
1350 d = xbt_dynar_new_sync(sizeof(int), NULL);
1351 pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1352 poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1353 xbt_thread_join(pusher);
1354 xbt_thread_join(poper);
1358 #endif /* SIMGRID_TEST */