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);
242 * \brief Shrink the dynar by removing empty slots at the end of the internal array
243 * \param dynar a dynar
244 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
245 * internal array for further insertions
247 * Reduces the internal array size of the dynar to the number of elements plus
248 * \a empty_slots_wanted.
249 * After removing elements from the dynar, you can call this function to make
250 * the dynar use less memory.
251 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
253 * Note that if \a empty_slots_wanted is greater than the array size, the internal
254 * array is expanded instead of shriked.
256 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
259 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
260 _dynar_unlock(dynar);
263 /** @brief Destructor
265 * \param dynar poor victim
267 * kilkil a dynar and its content
270 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
272 if (dynar && *dynar) {
273 xbt_dynar_reset(*dynar);
274 xbt_dynar_free_container(dynar);
278 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
279 void xbt_dynar_free_voidp(void *d)
281 xbt_dynar_t dynar = (xbt_dynar_t)d;
282 xbt_dynar_free(&dynar);
285 /** @brief Count of dynar's elements
287 * \param dynar the dynar we want to mesure
289 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
291 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
294 /**@brief check if a dynar is empty
296 *\param dynar the dynat we want to check
299 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
301 return (xbt_dynar_length(dynar) == 0);
304 /** @brief Retrieve a copy of the Nth element of a dynar.
306 * \param dynar information dealer
307 * \param idx index of the slot we want to retrieve
308 * \param[out] dst where to put the result to.
311 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
312 const unsigned long idx, void *const dst)
315 _sanity_check_dynar(dynar);
316 _check_inbound_idx(dynar, idx);
318 _xbt_dynar_get_elm(dst, dynar, idx);
319 _dynar_unlock(dynar);
322 /** @brief Retrieve a pointer to the Nth element of a dynar.
324 * \param dynar information dealer
325 * \param idx index of the slot we want to retrieve
326 * \return the \a idx-th element of \a dynar.
328 * \warning The returned value is the actual content of the dynar.
329 * Make a copy before fooling with it.
331 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
332 const unsigned long idx)
337 _sanity_check_dynar(dynar);
338 _check_inbound_idx(dynar, idx);
340 res = _xbt_dynar_elm(dynar, idx);
341 _dynar_unlock(dynar);
345 /* not synchronized */
346 static XBT_INLINE void *_xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
347 const unsigned long idx)
349 _sanity_check_dynar(dynar);
351 if (idx >= dynar->used) {
352 _xbt_dynar_expand(dynar, idx + 1);
353 if (idx > dynar->used) {
354 memset(_xbt_dynar_elm(dynar, dynar->used), 0,
355 (idx - dynar->used) * dynar->elmsize);
357 dynar->used = idx + 1;
359 return _xbt_dynar_elm(dynar, idx);
362 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
363 const unsigned long idx)
367 res = _xbt_dynar_set_at_ptr(dynar, idx);
368 _dynar_unlock(dynar);
372 static void XBT_INLINE /* not synchronized */
373 _xbt_dynar_set(xbt_dynar_t dynar,
374 const unsigned long idx, const void *const src)
376 memcpy(_xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
379 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
381 * \param dynar information dealer
382 * \param idx index of the slot we want to modify
383 * \param src What will be feeded to the dynar
385 * If you want to free the previous content, use xbt_dynar_replace().
387 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
388 const void *const src)
392 _xbt_dynar_set(dynar, idx, src);
393 _dynar_unlock(dynar);
396 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
402 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
403 * free the previous value at this position. If you don't want to free the
404 * previous content, use xbt_dynar_set().
407 xbt_dynar_replace(xbt_dynar_t dynar,
408 const unsigned long idx, const void *const object)
411 _sanity_check_dynar(dynar);
413 if (idx < dynar->used && dynar->free_f) {
414 void *const old_object = _xbt_dynar_elm(dynar, idx);
416 dynar->free_f(old_object);
419 _xbt_dynar_set(dynar, idx, object);
420 _dynar_unlock(dynar);
423 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
424 const unsigned long idx)
427 unsigned long old_used;
428 unsigned long new_used;
431 _sanity_check_dynar(dynar);
432 _sanity_check_idx(idx);
434 old_used = dynar->used;
435 new_used = old_used + 1;
437 _xbt_dynar_expand(dynar, new_used);
439 nb_shift = old_used - idx;
442 memmove(_xbt_dynar_elm(dynar, idx + 1),
443 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
446 dynar->used = new_used;
447 res = _xbt_dynar_elm(dynar, idx);
451 /** @brief Make room for a new element, and return a pointer to it
453 * You can then use regular affectation to set its value instead of relying
454 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
456 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
461 res = _xbt_dynar_insert_at_ptr(dynar, idx);
462 _dynar_unlock(dynar);
466 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
468 * Set the Nth element of a dynar, expanding the dynar if needed, and
469 * moving the previously existing value and all subsequent ones to one
470 * position right in the dynar.
473 xbt_dynar_insert_at(xbt_dynar_t const dynar,
474 const int idx, const void *const src)
478 /* checks done in xbt_dynar_insert_at_ptr */
479 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
480 _dynar_unlock(dynar);
483 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
485 * Get the Nth element of a dynar, removing it from the dynar and moving
486 * all subsequent values to one position left in the dynar.
488 * If the object argument of this function is a non-null pointer, the removed
489 * element is copied to this address. If not, the element is freed using the
490 * free_f function passed at dynar creation.
493 xbt_dynar_remove_at(xbt_dynar_t const dynar,
494 const int idx, void *const object)
498 _xbt_dynar_remove_at(dynar, idx, object);
499 _dynar_unlock(dynar);
502 /** @brief Returns the position of the element in the dynar
504 * Raises not_found_error if not found.
506 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
511 for (it = 0; it < dynar->used; it++)
512 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
513 _dynar_unlock(dynar);
517 _dynar_unlock(dynar);
518 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
522 /** @brief Returns a boolean indicating whether the element is part of the dynar */
523 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
529 xbt_dynar_search(dynar, elem);
532 if (e.category == not_found_error) {
541 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
543 * You can then use regular affectation to set its value instead of relying
544 * on the slow memcpy. This is what xbt_dynar_push_as() does.
546 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
550 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
551 dynar->used don't change between reading it and getting the lock
552 within xbt_dynar_insert_at_ptr */
554 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
555 _dynar_unlock(dynar);
559 /** @brief Add an element at the end of the dynar */
560 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
561 const void *const src)
564 /* checks done in xbt_dynar_insert_at_ptr */
565 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
567 _dynar_unlock(dynar);
570 /** @brief Mark the last dynar's element as unused and return a pointer to it.
572 * You can then use regular affectation to set its value instead of relying
573 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
575 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
580 _check_populated_dynar(dynar);
581 XBT_DEBUG("Pop %p", (void *) dynar);
583 res = _xbt_dynar_elm(dynar, dynar->used);
584 _dynar_unlock(dynar);
588 /** @brief Get and remove the last element of the dynar */
589 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
592 /* sanity checks done by remove_at */
593 XBT_DEBUG("Pop %p", (void *) dynar);
595 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
596 _dynar_unlock(dynar);
599 /** @brief Add an element at the begining of the dynar.
601 * This is less efficient than xbt_dynar_push()
603 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
604 const void *const src)
607 /* sanity checks done by insert_at */
608 xbt_dynar_insert_at(dynar, 0, src);
611 /** @brief Get and remove the first element of the dynar.
613 * This is less efficient than xbt_dynar_pop()
615 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
618 /* sanity checks done by remove_at */
619 xbt_dynar_remove_at(dynar, 0, dst);
622 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
624 char *const data = (char *) dynar->data;
625 const unsigned long elmsize = dynar->elmsize;
626 const unsigned long used = dynar->used;
629 for (i = 0; i < used; i++) {
630 char* elm = (char*) data + i * elmsize;
635 /** @brief Apply a function to each member of a dynar
637 * The mapped function may change the value of the element itself,
638 * but should not mess with the structure of the dynar.
640 * If the dynar is synchronized, it is locked during the whole map
641 * operation, so make sure your function don't call any function
642 * from xbt_dynar_* on it, or you'll get a deadlock.
644 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
645 void_f_pvoid_t const op)
648 _sanity_check_dynar(dynar);
651 _dynar_map(dynar, op);
653 _dynar_unlock(dynar);
657 /** @brief Removes and free the entry pointed by the cursor
659 * This function can be used while traversing without problem.
661 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
662 unsigned int *const cursor)
665 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
668 /** @brief Unlocks a synchronized dynar when you want to break the traversal
670 * This function must be used if you <tt>break</tt> the
671 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
672 * regular traversal reaching the end of the elements
674 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
676 _dynar_unlock(dynar);
679 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
681 * \param dynar the dynar to sort
682 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
684 * Remark: if the elements stored in the dynar are structures, the compar_fn
685 * function has to retrieve the field to sort first.
687 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
688 int_f_cpvoid_cpvoid_t compar_fn)
693 #ifdef HAVE_MERGESORT
694 mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
696 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
698 _dynar_unlock(dynar);
701 /** @brief Transform a dynar into a NULL terminated array
703 * \param dynar the dynar to transform
705 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
708 xbt_dynar_shrink(dynar, 1);
709 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
716 * Return 0 if d1 and d2 are equal and 1 if not equal
718 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
719 int(*compar)(const void *, const void *))
723 if((!d1) && (!d2)) return 0;
726 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
730 if((d1->elmsize)!=(d2->elmsize))
732 XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
736 if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
738 XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
743 size = xbt_dynar_length(d1);
746 void *data1 = xbt_dynar_get_as(d1, i, void *);
747 void *data2 = xbt_dynar_get_as(d2, i, void *);
748 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
749 if(compar(data1,data2)){
762 XBT_TEST_SUITE("dynar", "Dynar data container");
763 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
764 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
766 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
768 /* Vars_decl [doxygen cruft] */
774 xbt_test_add("==== Traverse the empty dynar");
775 d = xbt_dynar_new(sizeof(int), NULL);
776 xbt_dynar_foreach(d, cursor, i) {
777 xbt_die( "Damnit, there is something in the empty dynar");
779 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
780 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
781 /* in your code is naturally the way to go outside a regression test */
784 ("==== Push %d int, set them again 3 times, traverse them, shift them",
786 /* Populate_ints [doxygen cruft] */
787 /* 1. Populate the dynar */
788 d = xbt_dynar_new(sizeof(int), NULL);
789 for (cpt = 0; cpt < NB_ELEM; cpt++) {
790 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
791 /* xbt_dynar_push(d,&cpt); This would also work */
792 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
795 /* 2. Traverse manually the dynar */
796 for (cursor = 0; cursor < NB_ELEM; cursor++) {
797 iptr = xbt_dynar_get_ptr(d, cursor);
798 xbt_test_assert(cursor == *iptr,
799 "The retrieved value is not the same than the injected one (%d!=%d)",
803 /* 3. Traverse the dynar using the neat macro to that extend */
804 xbt_dynar_foreach(d, cursor, cpt) {
805 xbt_test_assert(cursor == cpt,
806 "The retrieved value is not the same than the injected one (%d!=%d)",
809 /* end_of_traversal */
811 for (cpt = 0; cpt < NB_ELEM; cpt++)
812 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
814 for (cpt = 0; cpt < NB_ELEM; cpt++)
815 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
816 /* xbt_dynar_set(d,cpt,&cpt); */
818 for (cpt = 0; cpt < NB_ELEM; cpt++)
819 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
822 xbt_dynar_foreach(d, cursor, i) {
823 xbt_test_assert(i == cpt,
824 "The retrieved value is not the same than the injected one (%d!=%d)",
828 xbt_test_assert(cpt == NB_ELEM,
829 "Cannot retrieve my %d values. Last got one is %d",
832 /* shifting [doxygen cruft] */
833 /* 4. Shift all the values */
834 for (cpt = 0; cpt < NB_ELEM; cpt++) {
835 xbt_dynar_shift(d, &i);
836 xbt_test_assert(i == cpt,
837 "The retrieved value is not the same than the injected one (%d!=%d)",
839 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
842 /* 5. Free the resources */
843 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
844 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
845 /* in your code is naturally the way to go outside a regression test */
847 xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
848 d = xbt_dynar_new(sizeof(int), NULL);
849 for (cpt = 0; cpt < NB_ELEM; cpt++) {
850 xbt_dynar_unshift(d, &cpt);
851 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
853 for (cpt = 0; cpt < NB_ELEM; cpt++) {
854 i = xbt_dynar_pop_as(d, int);
855 xbt_test_assert(i == cpt,
856 "The retrieved value is not the same than the injected one (%d!=%d)",
858 xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
860 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
861 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
862 /* in your code is naturally the way to go outside a regression test */
866 ("==== Push %d int, insert 1000 int in the middle, shift everything",
868 d = xbt_dynar_new(sizeof(int), NULL);
869 for (cpt = 0; cpt < NB_ELEM; cpt++) {
870 xbt_dynar_push_as(d, int, cpt);
871 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
873 for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
874 xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
875 XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
878 for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
879 xbt_dynar_shift(d, &i);
880 xbt_test_assert(i == cpt,
881 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
883 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
885 for (cpt = 999; cpt >= 0; cpt--) {
886 xbt_dynar_shift(d, &i);
887 xbt_test_assert(i == cpt,
888 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
891 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
892 xbt_dynar_shift(d, &i);
893 xbt_test_assert(i == cpt,
894 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
897 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
898 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
899 /* in your code is naturally the way to go outside a regression test */
901 xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
903 d = xbt_dynar_new(sizeof(int), NULL);
904 for (cpt = 0; cpt < NB_ELEM; cpt++)
905 xbt_dynar_push_as(d, int, cpt);
907 for (cpt = 2000; cpt < 4000; cpt++) {
908 xbt_dynar_remove_at(d, 2000, &i);
909 xbt_test_assert(i == cpt,
910 "Remove a bad value. Got %d, expected %d", i, cpt);
911 XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
913 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
914 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
915 /* in your code is naturally the way to go outside a regression test */
918 /*******************************************************************************/
919 /*******************************************************************************/
920 /*******************************************************************************/
921 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
923 xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
927 xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
928 /* Populate_ints [doxygen cruft] */
929 /* 1. Populate the dynar */
930 for (cpt = 0; cpt < NB_ELEM; cpt++) {
931 xbt_dynar_insert_at(d, cpt, &cpt);
932 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
935 /* 3. Traverse the dynar */
936 xbt_dynar_foreach(d, cursor, cpt) {
937 xbt_test_assert(cursor == cpt,
938 "The retrieved value is not the same than the injected one (%d!=%d)",
941 /* end_of_traversal */
943 /* Re-fill with the same values using set_as (and re-verify) */
944 for (cpt = 0; cpt < NB_ELEM; cpt++)
945 xbt_dynar_set_as(d, cpt, int, cpt);
946 xbt_dynar_foreach(d, cursor, cpt)
947 xbt_test_assert(cursor == cpt,
948 "The retrieved value is not the same than the injected one (%d!=%d)",
951 for (cpt = 0; cpt < NB_ELEM; cpt++) {
953 xbt_dynar_remove_at(d,0,&val);
954 xbt_test_assert(cpt == val,
955 "The retrieved value is not the same than the injected one (%d!=%d)",
958 xbt_test_assert(xbt_dynar_is_empty(d),
959 "There is still %lu elements in the dynar after removing everything",
960 xbt_dynar_length(d));
963 /* ********************* */
964 xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
965 d = xbt_dynar_new(sizeof(int), NULL);
966 for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
967 xbt_dynar_replace(d, cpt, &cpt);
968 xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
971 /* 3. Traverse the dynar */
972 xbt_dynar_foreach(d, cursor, cpt) {
973 xbt_test_assert(cursor == cpt,
974 "The retrieved value is not the same than the injected one (%d!=%d)",
977 /* end_of_traversal */
979 for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
981 xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
982 xbt_test_assert(cpt == val,
983 "The retrieved value is not the same than the injected one (%d!=%d)",
986 xbt_test_assert(xbt_dynar_is_empty(d),
987 "There is still %lu elements in the dynar after removing everything",
988 xbt_dynar_length(d));
992 /*******************************************************************************/
993 /*******************************************************************************/
994 /*******************************************************************************/
995 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1002 xbt_test_add("==== Traverse the empty dynar");
1003 d = xbt_dynar_new(sizeof(int), NULL);
1004 xbt_dynar_foreach(d, cursor, cpt) {
1005 xbt_test_assert(FALSE,
1006 "Damnit, there is something in the empty dynar");
1008 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1009 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1010 /* in your code is naturally the way to go outside a regression test */
1012 xbt_test_add("==== Push/shift 5000 doubles");
1013 d = xbt_dynar_new(sizeof(double), NULL);
1014 for (cpt = 0; cpt < 5000; cpt++) {
1016 xbt_dynar_push(d, &d1);
1018 xbt_dynar_foreach(d, cursor, d2) {
1019 d1 = (double) cursor;
1020 xbt_test_assert(d1 == d2,
1021 "The retrieved value is not the same than the injected one (%f!=%f)",
1024 for (cpt = 0; cpt < 5000; cpt++) {
1026 xbt_dynar_shift(d, &d2);
1027 xbt_test_assert(d1 == d2,
1028 "The retrieved value is not the same than the injected one (%f!=%f)",
1031 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1032 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1033 /* in your code is naturally the way to go outside a regression test */
1035 xbt_test_add("==== Unshift/pop 5000 doubles");
1036 d = xbt_dynar_new(sizeof(double), NULL);
1037 for (cpt = 0; cpt < 5000; cpt++) {
1039 xbt_dynar_unshift(d, &d1);
1041 for (cpt = 0; cpt < 5000; cpt++) {
1043 xbt_dynar_pop(d, &d2);
1044 xbt_test_assert(d1 == d2,
1045 "The retrieved value is not the same than the injected one (%f!=%f)",
1048 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1049 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1050 /* in your code is naturally the way to go outside a regression test */
1055 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1056 d = xbt_dynar_new(sizeof(double), NULL);
1057 for (cpt = 0; cpt < 5000; cpt++) {
1059 xbt_dynar_push(d, &d1);
1061 for (cpt = 0; cpt < 1000; cpt++) {
1063 xbt_dynar_insert_at(d, 2500, &d1);
1066 for (cpt = 0; cpt < 2500; cpt++) {
1068 xbt_dynar_shift(d, &d2);
1069 xbt_test_assert(d1 == d2,
1070 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1072 XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1074 for (cpt = 999; cpt >= 0; cpt--) {
1076 xbt_dynar_shift(d, &d2);
1077 xbt_test_assert(d1 == d2,
1078 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1081 for (cpt = 2500; cpt < 5000; cpt++) {
1083 xbt_dynar_shift(d, &d2);
1084 xbt_test_assert(d1 == d2,
1085 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1088 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1089 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1090 /* in your code is naturally the way to go outside a regression test */
1093 xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1094 d = xbt_dynar_new(sizeof(double), NULL);
1095 for (cpt = 0; cpt < 5000; cpt++) {
1097 xbt_dynar_push(d, &d1);
1099 for (cpt = 2000; cpt < 4000; cpt++) {
1101 xbt_dynar_remove_at(d, 2000, &d2);
1102 xbt_test_assert(d1 == d2,
1103 "Remove a bad value. Got %f, expected %f", d2, d1);
1105 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1106 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1107 /* in your code is naturally the way to go outside a regression test */
1111 /* doxygen_string_cruft */
1113 /*******************************************************************************/
1114 /*******************************************************************************/
1115 /*******************************************************************************/
1116 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1124 xbt_test_add("==== Traverse the empty dynar");
1125 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1126 xbt_dynar_foreach(d, iter, s1) {
1127 xbt_test_assert(FALSE,
1128 "Damnit, there is something in the empty dynar");
1130 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1131 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1132 /* in your code is naturally the way to go outside a regression test */
1134 xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1136 /* Populate_str [doxygen cruft] */
1137 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1138 /* 1. Populate the dynar */
1139 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1140 sprintf(buf, "%d", cpt);
1142 xbt_dynar_push(d, &s1);
1144 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1145 sprintf(buf, "%d", cpt);
1147 xbt_dynar_replace(d, cpt, &s1);
1149 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1150 sprintf(buf, "%d", cpt);
1152 xbt_dynar_replace(d, cpt, &s1);
1154 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1155 sprintf(buf, "%d", cpt);
1157 xbt_dynar_replace(d, cpt, &s1);
1159 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1160 sprintf(buf, "%d", cpt);
1161 xbt_dynar_shift(d, &s2);
1162 xbt_test_assert(!strcmp(buf, s2),
1163 "The retrieved value is not the same than the injected one (%s!=%s)",
1167 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1168 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1169 /* in your code is naturally the way to go outside a regression test */
1171 xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1172 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1173 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1174 sprintf(buf, "%d", cpt);
1176 xbt_dynar_unshift(d, &s1);
1178 /* 2. Traverse the dynar with the macro */
1179 xbt_dynar_foreach(d, iter, s1) {
1180 sprintf(buf, "%d", NB_ELEM - iter - 1);
1181 xbt_test_assert(!strcmp(buf, s1),
1182 "The retrieved value is not the same than the injected one (%s!=%s)",
1185 /* 3. Traverse the dynar with the macro */
1186 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1187 sprintf(buf, "%d", cpt);
1188 xbt_dynar_pop(d, &s2);
1189 xbt_test_assert(!strcmp(buf, s2),
1190 "The retrieved value is not the same than the injected one (%s!=%s)",
1194 /* 4. Free the resources */
1195 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1196 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1197 /* in your code is naturally the way to go outside a regression test */
1201 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1202 NB_ELEM, NB_ELEM / 5);
1203 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1204 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1205 sprintf(buf, "%d", cpt);
1207 xbt_dynar_push(d, &s1);
1209 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1210 sprintf(buf, "%d", cpt);
1212 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1215 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1216 sprintf(buf, "%d", cpt);
1217 xbt_dynar_shift(d, &s2);
1218 xbt_test_assert(!strcmp(buf, s2),
1219 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1223 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1224 sprintf(buf, "%d", cpt);
1225 xbt_dynar_shift(d, &s2);
1226 xbt_test_assert(!strcmp(buf, s2),
1227 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1231 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1232 sprintf(buf, "%d", cpt);
1233 xbt_dynar_shift(d, &s2);
1234 xbt_test_assert(!strcmp(buf, s2),
1235 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
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 */
1244 xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1245 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1246 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1247 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1248 sprintf(buf, "%d", cpt);
1250 xbt_dynar_push(d, &s1);
1252 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1253 sprintf(buf, "%d", cpt);
1254 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1255 xbt_test_assert(!strcmp(buf, s2),
1256 "Remove a bad value. Got %s, expected %s", s2, buf);
1259 xbt_dynar_free(&d); /* end_of_doxygen */
1263 /*******************************************************************************/
1264 /*******************************************************************************/
1265 /*******************************************************************************/
1266 #include "xbt/synchro.h"
1267 static void pusher_f(void *a)
1269 xbt_dynar_t d = (xbt_dynar_t) a;
1271 for (i = 0; i < 500; i++) {
1272 xbt_dynar_push(d, &i);
1276 static void poper_f(void *a)
1278 xbt_dynar_t d = (xbt_dynar_t) a;
1283 for (i = 0; i < 500; i++) {
1285 xbt_dynar_pop(d, &data);
1288 if (e.category == bound_error) {
1299 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1301 /* Vars_decl [doxygen cruft] */
1303 xbt_thread_t pusher, poper;
1305 xbt_test_add("==== Have a pusher and a popper on the dynar");
1306 d = xbt_dynar_new_sync(sizeof(int), NULL);
1307 pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1308 poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1309 xbt_thread_join(pusher);
1310 xbt_thread_join(poper);
1314 #endif /* SIMGRID_TEST */