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, int idx)
58 if (idx > dynar->used) {
60 THROW2(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 THROW1(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_clear_mem(void *const ptr, const unsigned long length)
79 memset(ptr, 0, length);
83 void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
85 const unsigned long old_size = dynar->size;
88 char *const old_data = (char *) dynar->data;
90 const unsigned long elmsize = dynar->elmsize;
92 const unsigned long used = dynar->used;
93 const unsigned long used_length = used * elmsize;
95 const unsigned long new_size =
96 nb > (2 * (old_size + 1)) ? nb : (2 * (old_size + 1));
97 const unsigned long new_length = new_size * elmsize;
98 char *const new_data = (char *) xbt_malloc0(elmsize * new_size);
100 DEBUG3("expend %p from %lu to %lu elements", (void *) dynar,
101 (unsigned long) old_size, nb);
104 memcpy(new_data, old_data, used_length);
108 _xbt_clear_mem(new_data + used_length, new_length - used_length);
110 dynar->size = new_size;
111 dynar->data = new_data;
116 void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
118 char *const data = (char *) dynar->data;
119 const unsigned long elmsize = dynar->elmsize;
121 return data + idx * elmsize;
126 _xbt_dynar_get_elm(void *const dst,
127 const xbt_dynar_t dynar, const unsigned long idx)
129 void *const elm = _xbt_dynar_elm(dynar, idx);
131 memcpy(dst, elm, dynar->elmsize);
136 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
137 const unsigned long idx, const void *const src)
139 void *const elm = _xbt_dynar_elm(dynar, idx);
140 const unsigned long elmsize = dynar->elmsize;
142 memcpy(elm, src, elmsize);
147 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
148 const unsigned long idx, void *const object)
151 unsigned long nb_shift;
152 unsigned long offset;
154 _sanity_check_dynar(dynar);
155 _check_inbound_idx(dynar, idx);
158 _xbt_dynar_get_elm(object, dynar, idx);
159 } else if (dynar->free_f) {
160 if (dynar->elmsize <= SIZEOF_MAX) {
161 char elm[SIZEOF_MAX];
162 _xbt_dynar_get_elm(elm, dynar, idx);
163 (*dynar->free_f) (elm);
165 char *elm = malloc(dynar->elmsize);
166 _xbt_dynar_get_elm(elm, dynar, idx);
167 (*dynar->free_f) (elm);
172 nb_shift = dynar->used - 1 - idx;
175 offset = nb_shift * dynar->elmsize;
176 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
182 void xbt_dynar_dump(xbt_dynar_t dynar)
184 INFO5("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
185 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
188 /** @brief Constructor
190 * \param elmsize size of each element in the dynar
191 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
193 * Creates a new dynar. If a free_func is provided, the elements have to be
194 * pointer of pointer. That is to say that dynars can contain either base
195 * types (int, char, double, etc) or pointer of pointers (struct **).
198 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
201 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
205 dynar->elmsize = elmsize;
207 dynar->free_f = free_f;
213 /** @brief Creates a synchronized dynar.
215 * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
219 xbt_dynar_new_sync(const unsigned long elmsize, void_f_pvoid_t const free_f)
221 xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
222 res->mutex = xbt_mutex_init();
226 /** @brief Destructor of the structure not touching to the content
228 * \param dynar poor victim
230 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
231 * is not touched (the \a free_f function is not used)
233 void xbt_dynar_free_container(xbt_dynar_t * dynar)
235 if (dynar && *dynar) {
237 if ((*dynar)->data) {
238 _xbt_clear_mem((*dynar)->data, (*dynar)->size);
239 free((*dynar)->data);
243 xbt_mutex_destroy((*dynar)->mutex);
245 _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
252 /** @brief Frees the content and set the size to 0
254 * \param dynar who to squeeze
256 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
260 _sanity_check_dynar(dynar);
262 DEBUG1("Reset the dynar %p", (void *) dynar);
264 _dynar_map(dynar, dynar->free_f);
274 _dynar_unlock(dynar);
276 /* dynar->data = NULL; */
280 * \brief Shrink the dynar by removing empty slots at the end of the internal array
281 * \param dynar a dynar
282 * \param empty_slots_wanted number of empty slots you want to keep at the end of the
283 * internal array for further insertions
285 * Reduces the internal array size of the dynar to the number of elements plus
286 * \a empty_slots_wanted.
287 * After removing elements from the dynar, you can call this function to make
288 * the dynar use less memory.
289 * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
291 * Note that if \a empty_slots_wanted is greater than the array size, the internal
292 * array is expanded instead of shriked.
294 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
296 unsigned long size_wanted;
300 size_wanted = dynar->used + empty_slots_wanted;
301 if (size_wanted != dynar->size) {
302 dynar->size = size_wanted;
303 dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
305 _dynar_unlock(dynar);
308 /** @brief Destructor
310 * \param dynar poor victim
312 * kilkil a dynar and its content
315 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
317 if (dynar && *dynar) {
318 xbt_dynar_reset(*dynar);
319 xbt_dynar_free_container(dynar);
323 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
324 void xbt_dynar_free_voidp(void *d)
326 xbt_dynar_free((xbt_dynar_t *) d);
329 /** @brief Count of dynar's elements
331 * \param dynar the dynar we want to mesure
333 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
335 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
338 /** @brief Retrieve a copy of the Nth element of a dynar.
340 * \param dynar information dealer
341 * \param idx index of the slot we want to retrieve
342 * \param[out] dst where to put the result to.
345 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
346 const unsigned long idx, void *const dst)
349 _sanity_check_dynar(dynar);
350 _check_inbound_idx(dynar, idx);
352 _xbt_dynar_get_elm(dst, dynar, idx);
353 _dynar_unlock(dynar);
356 /** @brief Retrieve a pointer to the Nth element of a dynar.
358 * \param dynar information dealer
359 * \param idx index of the slot we want to retrieve
360 * \return the \a idx-th element of \a dynar.
362 * \warning The returned value is the actual content of the dynar.
363 * Make a copy before fooling with it.
365 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
370 _sanity_check_dynar(dynar);
371 _check_inbound_idx(dynar, idx);
373 res = _xbt_dynar_elm(dynar, idx);
374 _dynar_unlock(dynar);
379 static void XBT_INLINE /* not synchronized */
380 _xbt_dynar_set(xbt_dynar_t dynar,
381 const unsigned long idx, const void *const src)
384 _sanity_check_dynar(dynar);
385 _sanity_check_idx(idx);
387 _xbt_dynar_expand(dynar, idx + 1);
389 if (idx >= dynar->used) {
390 dynar->used = idx + 1;
393 _xbt_dynar_put_elm(dynar, idx, src);
396 /** @brief Set the Nth element of a dynar (expended if needed). Previous value at this position is NOT freed
398 * \param dynar information dealer
399 * \param idx index of the slot we want to modify
400 * \param src What will be feeded to the dynar
402 * If you want to free the previous content, use xbt_dynar_replace().
404 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *const src)
408 _xbt_dynar_set(dynar, idx, src);
409 _dynar_unlock(dynar);
412 /** @brief Set the Nth element of a dynar (expended if needed). Previous value is freed
418 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
419 * free the previous value at this position. If you don't want to free the
420 * previous content, use xbt_dynar_set().
423 xbt_dynar_replace(xbt_dynar_t dynar,
424 const unsigned long idx, const void *const object)
427 _sanity_check_dynar(dynar);
428 _sanity_check_idx(idx);
430 if (idx < dynar->used && dynar->free_f) {
431 void *const old_object = _xbt_dynar_elm(dynar, idx);
433 (*(dynar->free_f)) (old_object);
436 _xbt_dynar_set(dynar, idx, object);
437 _dynar_unlock(dynar);
440 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
441 const unsigned long idx)
444 unsigned long old_used;
445 unsigned long new_used;
446 unsigned long nb_shift;
448 _sanity_check_dynar(dynar);
449 _sanity_check_idx(idx);
450 _check_sloppy_inbound_idx(dynar, idx);
452 old_used = dynar->used;
453 new_used = old_used + 1;
455 _xbt_dynar_expand(dynar, new_used);
457 nb_shift = old_used - idx;
460 memmove(_xbt_dynar_elm(dynar, idx + 1),
461 _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
463 dynar->used = new_used;
464 res = _xbt_dynar_elm(dynar, idx);
468 /** @brief Make room for a new element, and return a pointer to it
470 * You can then use regular affectation to set its value instead of relying
471 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
473 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
478 res = _xbt_dynar_insert_at_ptr(dynar, idx);
479 _dynar_unlock(dynar);
483 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
485 * Set the Nth element of a dynar, expanding the dynar if needed, and
486 * moving the previously existing value and all subsequent ones to one
487 * position right in the dynar.
490 xbt_dynar_insert_at(xbt_dynar_t const dynar,
491 const int idx, const void *const src)
495 /* checks done in xbt_dynar_insert_at_ptr */
496 memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
497 _dynar_unlock(dynar);
500 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
502 * Get the Nth element of a dynar, removing it from the dynar and moving
503 * all subsequent values to one position left in the dynar.
505 * If the object argument of this function is a non-null pointer, the removed
506 * element is copied to this address. If not, the element is freed using the
507 * free_f function passed at dynar creation.
510 xbt_dynar_remove_at(xbt_dynar_t const dynar,
511 const int idx, void *const object)
515 _xbt_dynar_remove_at(dynar, idx, object);
516 _dynar_unlock(dynar);
519 /** @brief Returns the position of the element in the dynar
521 * Raises not_found_error if not found.
523 int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
528 for (it = 0; it < dynar->used; it++)
529 if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
530 _dynar_unlock(dynar);
534 _dynar_unlock(dynar);
535 THROW2(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
538 /** @brief Returns a boolean indicating whether the element is part of the dynar */
539 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
545 xbt_dynar_search(dynar, elem);
547 if (e.category == not_found_error) {
556 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
558 * You can then use regular affectation to set its value instead of relying
559 * on the slow memcpy. This is what xbt_dynar_push_as() does.
561 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
565 /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
566 dynar->used don't change between reading it and getting the lock
567 within xbt_dynar_insert_at_ptr */
569 res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
570 _dynar_unlock(dynar);
574 /** @brief Add an element at the end of the dynar */
575 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar, const void *const src)
578 /* checks done in xbt_dynar_insert_at_ptr */
579 memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
580 _dynar_unlock(dynar);
583 /** @brief Mark the last dynar's element as unused and return a pointer to it.
585 * You can then use regular affectation to set its value instead of relying
586 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
588 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
593 _check_populated_dynar(dynar);
594 DEBUG1("Pop %p", (void *) dynar);
596 res = _xbt_dynar_elm(dynar, dynar->used);
597 _dynar_unlock(dynar);
601 /** @brief Get and remove the last element of the dynar */
602 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
605 /* sanity checks done by remove_at */
606 DEBUG1("Pop %p", (void *) dynar);
608 _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
609 _dynar_unlock(dynar);
612 /** @brief Add an element at the begining of the dynar.
614 * This is less efficient than xbt_dynar_push()
616 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar, const void *const src)
619 /* sanity checks done by insert_at */
620 xbt_dynar_insert_at(dynar, 0, src);
623 /** @brief Get and remove the first element of the dynar.
625 * This is less efficient than xbt_dynar_pop()
627 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
630 /* sanity checks done by remove_at */
631 xbt_dynar_remove_at(dynar, 0, dst);
634 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
636 char elm[SIZEOF_MAX];
637 const unsigned long used = dynar->used;
640 for (i = 0; i < used; i++) {
641 _xbt_dynar_get_elm(elm, dynar, i);
646 /** @brief Apply a function to each member of a dynar
648 * The mapped function may change the value of the element itself,
649 * but should not mess with the structure of the dynar.
651 * If the dynar is synchronized, it is locked during the whole map
652 * operation, so make sure your function don't call any function
653 * from xbt_dynar_* on it, or you'll get a deadlock.
655 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
658 _sanity_check_dynar(dynar);
661 _dynar_map(dynar, op);
663 _dynar_unlock(dynar);
667 /** @brief Removes and free the entry pointed by the cursor
669 * This function can be used while traversing without problem.
671 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor)
674 _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
677 /** @brief Unlocks a synchronized dynar when you want to break the traversal
679 * This function must be used if you <tt>break</tt> the
680 * xbt_dynar_foreach loop, but shouldn't be called at the end of a
681 * regular traversal reaching the end of the elements
683 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
685 _dynar_unlock(dynar);
688 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
690 * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
692 * Remark: if the elements stored in the dynar are structures, the compar_fn
693 * function has to retrieve the field to sort first.
695 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar, int_f_pvoid_pvoid_t compar_fn){
699 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
701 _dynar_unlock(dynar);
708 XBT_TEST_SUITE("dynar", "Dynar data container");
709 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
710 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
712 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
714 /* Vars_decl [doxygen cruft] */
720 xbt_test_add0("==== Traverse the empty dynar");
721 d = xbt_dynar_new(sizeof(int), NULL);
722 xbt_dynar_foreach(d, cursor, i) {
723 xbt_assert0(0, "Damnit, there is something in the empty dynar");
725 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
726 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
727 /* in your code is naturally the way to go outside a regression test */
730 ("==== Push %d int, set them again 3 times, traverse them, shift them",
732 /* Populate_ints [doxygen cruft] */
733 /* 1. Populate the dynar */
734 d = xbt_dynar_new(sizeof(int), NULL);
735 for (cpt = 0; cpt < NB_ELEM; cpt++) {
736 xbt_dynar_push_as(d, int, cpt); /* This is faster (and possible only with scalars) */
737 /* xbt_dynar_push(d,&cpt); This would also work */
738 xbt_test_log2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
741 /* 2. Traverse manually the dynar */
742 for (cursor = 0; cursor < NB_ELEM; cursor++) {
743 iptr = xbt_dynar_get_ptr(d, cursor);
744 xbt_test_assert2(cursor == *iptr,
745 "The retrieved value is not the same than the injected one (%d!=%d)",
749 /* 3. Traverse the dynar using the neat macro to that extend */
750 xbt_dynar_foreach(d, cursor, cpt) {
751 xbt_test_assert2(cursor == cpt,
752 "The retrieved value is not the same than the injected one (%d!=%d)",
755 /* end_of_traversal */
757 for (cpt = 0; cpt < NB_ELEM; cpt++)
758 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
760 for (cpt = 0; cpt < NB_ELEM; cpt++)
761 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
762 /* xbt_dynar_set(d,cpt,&cpt); */
764 for (cpt = 0; cpt < NB_ELEM; cpt++)
765 *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
768 xbt_dynar_foreach(d, cursor, i) {
769 xbt_test_assert2(i == cpt,
770 "The retrieved value is not the same than the injected one (%d!=%d)",
774 xbt_test_assert2(cpt == NB_ELEM,
775 "Cannot retrieve my %d values. Last got one is %d",
778 /* shifting [doxygen cruft] */
779 /* 4. Shift all the values */
780 for (cpt = 0; cpt < NB_ELEM; cpt++) {
781 xbt_dynar_shift(d, &i);
782 xbt_test_assert2(i == cpt,
783 "The retrieved value is not the same than the injected one (%d!=%d)",
785 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
788 /* 5. Free the resources */
789 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
790 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
791 /* in your code is naturally the way to go outside a regression test */
793 xbt_test_add1("==== Unshift/pop %d int", NB_ELEM);
794 d = xbt_dynar_new(sizeof(int), NULL);
795 for (cpt = 0; cpt < NB_ELEM; cpt++) {
796 xbt_dynar_unshift(d, &cpt);
797 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
799 for (cpt = 0; cpt < NB_ELEM; cpt++) {
800 i = xbt_dynar_pop_as(d, int);
801 xbt_test_assert2(i == cpt,
802 "The retrieved value is not the same than the injected one (%d!=%d)",
804 xbt_test_log2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
806 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
807 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
808 /* in your code is naturally the way to go outside a regression test */
812 ("==== Push %d int, insert 1000 int in the middle, shift everything",
814 d = xbt_dynar_new(sizeof(int), NULL);
815 for (cpt = 0; cpt < NB_ELEM; cpt++) {
816 xbt_dynar_push_as(d, int, cpt);
817 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
819 for (cpt = 0; cpt < 1000; cpt++) {
820 xbt_dynar_insert_at_as(d, 2500, int, cpt);
821 DEBUG2("Push %d, length=%lu", cpt, xbt_dynar_length(d));
824 for (cpt = 0; cpt < 2500; cpt++) {
825 xbt_dynar_shift(d, &i);
826 xbt_test_assert2(i == cpt,
827 "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
829 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
831 for (cpt = 999; cpt >= 0; cpt--) {
832 xbt_dynar_shift(d, &i);
833 xbt_test_assert2(i == cpt,
834 "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
837 for (cpt = 2500; cpt < NB_ELEM; cpt++) {
838 xbt_dynar_shift(d, &i);
839 xbt_test_assert2(i == cpt,
840 "The retrieved value is not the same than the injected one at the end (%d!=%d)",
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_add1("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
848 d = xbt_dynar_new(sizeof(int), NULL);
849 for (cpt = 0; cpt < NB_ELEM; cpt++)
850 xbt_dynar_push_as(d, int, cpt);
852 for (cpt = 2000; cpt < 4000; cpt++) {
853 xbt_dynar_remove_at(d, 2000, &i);
854 xbt_test_assert2(i == cpt,
855 "Remove a bad value. Got %d, expected %d", i, cpt);
856 DEBUG2("remove %d, length=%lu", cpt, xbt_dynar_length(d));
858 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
859 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
860 /* in your code is naturally the way to go outside a regression test */
863 /*******************************************************************************/
864 /*******************************************************************************/
865 /*******************************************************************************/
866 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
873 xbt_test_add0("==== Traverse the empty dynar");
874 d = xbt_dynar_new(sizeof(int), NULL);
875 xbt_dynar_foreach(d, cursor, cpt) {
876 xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
878 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
879 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
880 /* in your code is naturally the way to go outside a regression test */
882 xbt_test_add0("==== Push/shift 5000 doubles");
883 d = xbt_dynar_new(sizeof(double), NULL);
884 for (cpt = 0; cpt < 5000; cpt++) {
886 xbt_dynar_push(d, &d1);
888 xbt_dynar_foreach(d, cursor, d2) {
889 d1 = (double) cursor;
890 xbt_test_assert2(d1 == d2,
891 "The retrieved value is not the same than the injected one (%f!=%f)",
894 for (cpt = 0; cpt < 5000; cpt++) {
896 xbt_dynar_shift(d, &d2);
897 xbt_test_assert2(d1 == d2,
898 "The retrieved value is not the same than the injected one (%f!=%f)",
901 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
902 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
903 /* in your code is naturally the way to go outside a regression test */
905 xbt_test_add0("==== Unshift/pop 5000 doubles");
906 d = xbt_dynar_new(sizeof(double), NULL);
907 for (cpt = 0; cpt < 5000; cpt++) {
909 xbt_dynar_unshift(d, &d1);
911 for (cpt = 0; cpt < 5000; cpt++) {
913 xbt_dynar_pop(d, &d2);
914 xbt_test_assert2(d1 == d2,
915 "The retrieved value is not the same than the injected one (%f!=%f)",
918 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
919 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
920 /* in your code is naturally the way to go outside a regression test */
925 ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
926 d = xbt_dynar_new(sizeof(double), NULL);
927 for (cpt = 0; cpt < 5000; cpt++) {
929 xbt_dynar_push(d, &d1);
931 for (cpt = 0; cpt < 1000; cpt++) {
933 xbt_dynar_insert_at(d, 2500, &d1);
936 for (cpt = 0; cpt < 2500; cpt++) {
938 xbt_dynar_shift(d, &d2);
939 xbt_test_assert2(d1 == d2,
940 "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
942 DEBUG2("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
944 for (cpt = 999; cpt >= 0; cpt--) {
946 xbt_dynar_shift(d, &d2);
947 xbt_test_assert2(d1 == d2,
948 "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
951 for (cpt = 2500; cpt < 5000; cpt++) {
953 xbt_dynar_shift(d, &d2);
954 xbt_test_assert2(d1 == d2,
955 "The retrieved value is not the same than the injected one at the end (%f!=%f)",
958 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
959 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
960 /* in your code is naturally the way to go outside a regression test */
963 xbt_test_add0("==== Push 5000 double, remove 2000-4000. free the rest");
964 d = xbt_dynar_new(sizeof(double), NULL);
965 for (cpt = 0; cpt < 5000; cpt++) {
967 xbt_dynar_push(d, &d1);
969 for (cpt = 2000; cpt < 4000; cpt++) {
971 xbt_dynar_remove_at(d, 2000, &d2);
972 xbt_test_assert2(d1 == d2,
973 "Remove a bad value. Got %f, expected %f", d2, d1);
975 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
976 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
977 /* in your code is naturally the way to go outside a regression test */
981 /* doxygen_string_cruft */
983 /*******************************************************************************/
984 /*******************************************************************************/
985 /*******************************************************************************/
986 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
994 xbt_test_add0("==== Traverse the empty dynar");
995 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
996 xbt_dynar_foreach(d, iter, s1) {
997 xbt_test_assert0(FALSE, "Damnit, there is something in the empty dynar");
999 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1000 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1001 /* in your code is naturally the way to go outside a regression test */
1003 xbt_test_add1("==== Push %d strings, set them again 3 times, shift them",
1005 /* Populate_str [doxygen cruft] */
1006 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1007 /* 1. Populate the dynar */
1008 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1009 sprintf(buf, "%d", cpt);
1011 xbt_dynar_push(d, &s1);
1013 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1014 sprintf(buf, "%d", cpt);
1016 xbt_dynar_replace(d, cpt, &s1);
1018 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1019 sprintf(buf, "%d", cpt);
1021 xbt_dynar_replace(d, cpt, &s1);
1023 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1024 sprintf(buf, "%d", cpt);
1026 xbt_dynar_replace(d, cpt, &s1);
1028 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1029 sprintf(buf, "%d", cpt);
1030 xbt_dynar_shift(d, &s2);
1031 xbt_test_assert2(!strcmp(buf, s2),
1032 "The retrieved value is not the same than the injected one (%s!=%s)",
1036 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1037 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1038 /* in your code is naturally the way to go outside a regression test */
1040 xbt_test_add1("==== Unshift, traverse and pop %d strings", NB_ELEM);
1041 d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1042 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1043 sprintf(buf, "%d", cpt);
1045 xbt_dynar_unshift(d, &s1);
1047 /* 2. Traverse the dynar with the macro */
1048 xbt_dynar_foreach(d, iter, s1) {
1049 sprintf(buf, "%d", NB_ELEM - iter - 1);
1050 xbt_test_assert2(!strcmp(buf, s1),
1051 "The retrieved value is not the same than the injected one (%s!=%s)",
1054 /* 3. Traverse the dynar with the macro */
1055 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1056 sprintf(buf, "%d", cpt);
1057 xbt_dynar_pop(d, &s2);
1058 xbt_test_assert2(!strcmp(buf, s2),
1059 "The retrieved value is not the same than the injected one (%s!=%s)",
1063 /* 4. Free the resources */
1064 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1065 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1066 /* in your code is naturally the way to go outside a regression test */
1070 ("==== Push %d strings, insert %d strings in the middle, shift everything",
1071 NB_ELEM, NB_ELEM / 5);
1072 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1073 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1074 sprintf(buf, "%d", cpt);
1076 xbt_dynar_push(d, &s1);
1078 for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1079 sprintf(buf, "%d", cpt);
1081 xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1084 for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1085 sprintf(buf, "%d", cpt);
1086 xbt_dynar_shift(d, &s2);
1087 xbt_test_assert2(!strcmp(buf, s2),
1088 "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1092 for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1093 sprintf(buf, "%d", cpt);
1094 xbt_dynar_shift(d, &s2);
1095 xbt_test_assert2(!strcmp(buf, s2),
1096 "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1100 for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1101 sprintf(buf, "%d", cpt);
1102 xbt_dynar_shift(d, &s2);
1103 xbt_test_assert2(!strcmp(buf, s2),
1104 "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1108 xbt_dynar_free(&d); /* This code is used both as example and as regression test, so we try to */
1109 xbt_dynar_free(&d); /* free the struct twice here to check that it's ok, but freeing it only once */
1110 /* in your code is naturally the way to go outside a regression test */
1113 xbt_test_add3("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM,
1114 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1115 d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1116 for (cpt = 0; cpt < NB_ELEM; cpt++) {
1117 sprintf(buf, "%d", cpt);
1119 xbt_dynar_push(d, &s1);
1121 for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1122 sprintf(buf, "%d", cpt);
1123 xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1124 xbt_test_assert2(!strcmp(buf, s2),
1125 "Remove a bad value. Got %s, expected %s", s2, buf);
1128 xbt_dynar_free(&d); /* end_of_doxygen */
1132 /*******************************************************************************/
1133 /*******************************************************************************/
1134 /*******************************************************************************/
1135 #include "xbt/synchro.h"
1136 static void pusher_f(void *a)
1138 xbt_dynar_t d = (xbt_dynar_t) a;
1140 for (i = 0; i < 500; i++) {
1141 xbt_dynar_push(d, &i);
1145 static void poper_f(void *a)
1147 xbt_dynar_t d = (xbt_dynar_t) a;
1152 for (i = 0; i < 500; i++) {
1154 xbt_dynar_pop(d, &data);
1157 if (e.category == bound_error) {
1168 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int,"Synchronized dynars of integers")
1170 /* Vars_decl [doxygen cruft] */
1172 xbt_thread_t pusher, poper;
1174 xbt_test_add0("==== Have a pusher and a popper on the dynar");
1175 d = xbt_dynar_new_sync(sizeof(int), NULL);
1176 pusher = xbt_thread_create("pusher", pusher_f, d,0/*not joinable*/);
1177 poper = xbt_thread_create("poper", poper_f, d,0/*not joinable*/);
1178 xbt_thread_join(pusher);
1179 xbt_thread_join(poper);
1183 #endif /* SIMGRID_TEST */