Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dbd896110111c59773d78ece1723b5866a3dd9e9
[simgrid.git] / src / xbt / dynar.cpp
1 /* a generic DYNamic ARray implementation.                                  */
2
3 /* Copyright (c) 2004-2015. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #include "xbt/misc.h"
10 #include "xbt/sysdep.h"
11 #include "xbt/log.h"
12 #include "xbt/ex.h"
13 #include <xbt/ex.hpp>
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
18
19 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
20 {
21   xbt_assert(dynar, "dynar is NULL");
22 }
23
24 static inline void _sanity_check_idx(int idx)
25 {
26   xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
27 }
28
29 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
30 {
31   if (idx < 0 || idx >= (int)dynar->used) {
32     THROWF(bound_error, idx, "dynar is not that long. You asked %d, but it's only %lu long",
33            (int) (idx), (unsigned long) dynar->used);
34   }
35 }
36
37 static inline void _check_populated_dynar(xbt_dynar_t dynar)
38 {
39   if (dynar->used == 0) {
40     THROWF(bound_error, 0, "dynar %p is empty", dynar);
41   }
42 }
43
44 static inline void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
45 {
46   if (new_size != dynar->size) {
47     dynar->size = new_size;
48     dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
49   }
50 }
51
52 static inline void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
53 {
54   const unsigned long old_size = dynar->size;
55
56   if (nb > old_size) {
57     const unsigned long expand = 2 * (old_size + 1);
58     _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
59     XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, dynar->size);
60   }
61 }
62
63 static inline void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
64 {
65   char *const data = (char *) dynar->data;
66   const unsigned long elmsize = dynar->elmsize;
67
68   return data + idx * elmsize;
69 }
70
71 static inline void _xbt_dynar_get_elm(void *const dst, const xbt_dynar_t dynar, const unsigned long idx)
72 {
73   void *const elm = _xbt_dynar_elm(dynar, idx);
74
75   memcpy(dst, elm, dynar->elmsize);
76 }
77
78 void xbt_dynar_dump(xbt_dynar_t dynar)
79 {
80   XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
81         dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
82 }
83
84 /** @brief Constructor
85  *
86  * \param elmsize size of each element in the dynar
87  * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
88  *
89  * Creates a new dynar. If a free_func is provided, the elements have to be pointer of pointer. That is to say that
90  * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
91  */
92 xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
93 {
94   xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
95
96   dynar->size = 0;
97   dynar->used = 0;
98   dynar->elmsize = elmsize;
99   dynar->data = NULL;
100   dynar->free_f = free_f;
101
102   return dynar;
103 }
104
105 /** @brief Destructor of the structure not touching to the content
106  *
107  * \param dynar poor victim
108  *
109  * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the \a free_f function
110  * is not used)
111  */
112 void xbt_dynar_free_container(xbt_dynar_t * dynar)
113 {
114   if (dynar && *dynar) {
115     xbt_dynar_t d = *dynar;
116     free(d->data);
117     free(d);
118     *dynar = NULL;
119   }
120 }
121
122 /** @brief Frees the content and set the size to 0
123  *
124  * \param dynar who to squeeze
125  */
126 void xbt_dynar_reset(xbt_dynar_t const dynar)
127 {
128   _sanity_check_dynar(dynar);
129
130   XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
131   if (dynar->free_f) {
132     xbt_dynar_map(dynar, dynar->free_f);
133   }
134   dynar->used = 0;
135 }
136
137 /** @brief Merge dynar d2 into d1
138  *
139  * \param d1 dynar to keep
140  * \param d2 dynar to merge into d1. This dynar is free at end.
141  */
142 void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
143 {
144   if((*d1)->elmsize != (*d2)->elmsize)
145     xbt_die("Element size must are not equal");
146
147   const unsigned long elmsize = (*d1)->elmsize;
148
149   void *ptr = _xbt_dynar_elm((*d2), 0);
150   _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
151   void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
152
153   memcpy(elm, ptr, ((*d2)->size)*elmsize);
154   (*d1)->used += (*d2)->used;
155   (*d2)->used = 0;
156   xbt_dynar_free(d2);
157 }
158
159 /**
160  * \brief Shrink the dynar by removing empty slots at the end of the internal array
161  * \param dynar a dynar
162  * \param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
163  * insertions
164  *
165  * Reduces the internal array size of the dynar to the number of elements plus \a empty_slots_wanted.
166  * After removing elements from the dynar, you can call this function to make the dynar use less memory.
167  * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
168  * Note that if \a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
169  */
170 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
171 {
172   _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
173 }
174
175 /** @brief Destructor
176  *
177  * \param dynar poor victim
178  *
179  * kilkil a dynar and its content
180  */
181 void xbt_dynar_free(xbt_dynar_t * dynar)
182 {
183   if (dynar && *dynar) {
184     xbt_dynar_reset(*dynar);
185     xbt_dynar_free_container(dynar);
186   }
187 }
188
189 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
190 void xbt_dynar_free_voidp(void *d)
191 {
192   xbt_dynar_t dynar = (xbt_dynar_t)d;
193   xbt_dynar_free(&dynar);
194 }
195
196 /** @brief Count of dynar's elements
197  *
198  * \param dynar the dynar we want to mesure
199  */
200 unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
201 {
202   return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
203 }
204
205  /**@brief check if a dynar is empty
206  *
207  *\param dynar the dynat we want to check
208  */
209
210 int xbt_dynar_is_empty(const xbt_dynar_t dynar)
211 {
212   return (xbt_dynar_length(dynar) == 0);
213 }
214
215 /** @brief Retrieve a copy of the Nth element of a dynar.
216  *
217  * \param dynar information dealer
218  * \param idx index of the slot we want to retrieve
219  * \param[out] dst where to put the result to.
220  */
221 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void *const dst)
222 {
223   _sanity_check_dynar(dynar);
224   _check_inbound_idx(dynar, idx);
225
226   _xbt_dynar_get_elm(dst, dynar, idx);
227 }
228
229 /** @brief Retrieve a pointer to the Nth element of a dynar.
230  *
231  * \param dynar information dealer
232  * \param idx index of the slot we want to retrieve
233  * \return the \a idx-th element of \a dynar.
234  *
235  * \warning The returned value is the actual content of the dynar.
236  * Make a copy before fooling with it.
237  */
238 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
239 {
240   void *res;
241   _sanity_check_dynar(dynar);
242   _check_inbound_idx(dynar, idx);
243
244   res = _xbt_dynar_elm(dynar, idx);
245   return res;
246 }
247
248 void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
249 {
250   _sanity_check_dynar(dynar);
251
252   if (idx >= dynar->used) {
253     _xbt_dynar_expand(dynar, idx + 1);
254     if (idx > dynar->used) {
255       memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
256     }
257     dynar->used = idx + 1;
258   }
259   return _xbt_dynar_elm(dynar, idx);
260 }
261
262 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
263  *
264  * \param dynar information dealer
265  * \param idx index of the slot we want to modify
266  * \param src What will be feeded to the dynar
267  *
268  * If you want to free the previous content, use xbt_dynar_replace().
269  */
270 void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *const src)
271 {
272   memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
273 }
274
275 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
276  *
277  * \param dynar
278  * \param idx
279  * \param object
280  *
281  * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
282  * you don't want to free the previous content, use xbt_dynar_set().
283  */
284 void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *const object)
285 {
286   _sanity_check_dynar(dynar);
287
288   if (idx < dynar->used && dynar->free_f) {
289     void *const old_object = _xbt_dynar_elm(dynar, idx);
290
291     dynar->free_f(old_object);
292   }
293
294   xbt_dynar_set(dynar, idx, object);
295 }
296
297 /** @brief Make room for a new element, and return a pointer to it
298  *
299  * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
300  * xbt_dynar_insert_at_as() does.
301  */
302 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
303 {
304   void *res;
305   unsigned long old_used;
306   unsigned long new_used;
307   long nb_shift;
308
309   _sanity_check_dynar(dynar);
310   _sanity_check_idx(idx);
311
312   old_used = dynar->used;
313   new_used = old_used + 1;
314
315   _xbt_dynar_expand(dynar, new_used);
316
317   nb_shift = old_used - idx;
318
319   if (nb_shift>0) {
320     memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
321   }
322
323   dynar->used = new_used;
324   res = _xbt_dynar_elm(dynar, idx);
325   return res;
326 }
327
328 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
329  *
330  * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
331  * subsequent ones to one position right in the dynar.
332  */
333 void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *const src)
334 {
335   /* checks done in xbt_dynar_insert_at_ptr */
336   memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
337 }
338
339 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
340  *
341  * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
342  * the dynar.
343  *
344  * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
345  * the element is freed using the free_f function passed at dynar creation.
346  */
347 void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void *const object)
348 {
349   unsigned long nb_shift;
350   unsigned long offset;
351
352   _sanity_check_dynar(dynar);
353   _check_inbound_idx(dynar, idx);
354
355   if (object) {
356     _xbt_dynar_get_elm(object, dynar, idx);
357   } else if (dynar->free_f) {
358     dynar->free_f(_xbt_dynar_elm(dynar, idx));
359   }
360
361   nb_shift = dynar->used - 1 - idx;
362
363   if (nb_shift) {
364     offset = nb_shift * dynar->elmsize;
365     memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
366   }
367
368   dynar->used--;
369 }
370
371 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
372  *
373  * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
374  * NULL object argument if n equals to 1.
375  *
376  * Each of the removed elements is freed using the free_f function passed at dynar creation.
377  */
378 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
379 {
380   unsigned long nb_shift;
381   unsigned long offset;
382   unsigned long cur;
383
384   if (!n) return;
385
386   _sanity_check_dynar(dynar);
387   _check_inbound_idx(dynar, idx);
388   _check_inbound_idx(dynar, idx + n - 1);
389
390   if (dynar->free_f) {
391     for (cur = idx; cur < idx + n; cur++) {
392       dynar->free_f(_xbt_dynar_elm(dynar, cur));
393     }
394   }
395
396   nb_shift = dynar->used - n - idx;
397
398   if (nb_shift) {
399     offset = nb_shift * dynar->elmsize;
400     memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
401   }
402
403   dynar->used -= n;
404 }
405
406 /** @brief Returns the position of the element in the dynar
407  *
408  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
409  * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
410  * yourself:
411  * \code
412  * signed int position = -1;
413  * xbt_dynar_foreach(dynar, iter, elem) {
414  *    if (!memcmp(elem, searched_element, sizeof(*elem))) {
415  *        position = iter;
416  *        break;
417  *    }
418  * }
419  * \endcode
420  * 
421  * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
422  * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
423  */
424 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
425 {
426   unsigned long it;
427
428   for (it = 0; it < dynar->used; it++)
429     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
430       return it;
431     }
432
433   THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
434   return -1; // Won't happen, just to please eclipse
435 }
436
437 /** @brief Returns the position of the element in the dynar (or -1 if not found)
438  *
439  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
440  * what you want. Check the documentation of xbt_dynar_search() for more info.
441  * 
442  * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
443  * this very function will not work (but the other will).
444  */
445 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
446 {
447   unsigned long it;
448
449   for (it = 0; it < dynar->used; it++)
450     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
451       return it;
452     }
453
454   return -1;
455 }
456
457 /** @brief Returns a boolean indicating whether the element is part of the dynar 
458  *
459  * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
460  * what you want. Check the documentation of xbt_dynar_search() for more info.
461  */
462 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
463 {
464   try {
465     xbt_dynar_search(dynar, elem);
466   }
467   catch (xbt_ex& e) {
468     if (e.category == not_found_error)
469       return 0;
470     throw;
471   }
472   return 1;
473 }
474
475 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
476  *
477  * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
478  * xbt_dynar_push_as() does.
479  */
480 void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
481 {
482   return xbt_dynar_insert_at_ptr(dynar, dynar->used);
483 }
484
485 /** @brief Add an element at the end of the dynar */
486 void xbt_dynar_push(xbt_dynar_t const dynar, const void *const src)
487 {
488   /* checks done in xbt_dynar_insert_at_ptr */
489   memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
490 }
491
492 /** @brief Mark the last dynar's element as unused and return a pointer to it.
493  *
494  * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
495  * xbt_dynar_pop_as() does.
496  */
497 void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
498 {
499   _check_populated_dynar(dynar);
500   XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
501   dynar->used--;
502   return _xbt_dynar_elm(dynar, dynar->used);
503 }
504
505 /** @brief Get and remove the last element of the dynar */
506 void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
507 {
508   /* sanity checks done by remove_at */
509   XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
510   xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
511 }
512
513 /** @brief Add an element at the begining of the dynar.
514  *
515  * This is less efficient than xbt_dynar_push()
516  */
517 void xbt_dynar_unshift(xbt_dynar_t const dynar, const void *const src)
518 {
519   /* sanity checks done by insert_at */
520   xbt_dynar_insert_at(dynar, 0, src);
521 }
522
523 /** @brief Get and remove the first element of the dynar.
524  *
525  * This is less efficient than xbt_dynar_pop()
526  */
527 void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
528 {
529   /* sanity checks done by remove_at */
530   xbt_dynar_remove_at(dynar, 0, dst);
531 }
532
533 /** @brief Apply a function to each member of a dynar
534  *
535  * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
536  */
537 void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
538 {
539   char *const data = (char *) dynar->data;
540   const unsigned long elmsize = dynar->elmsize;
541   const unsigned long used = dynar->used;
542   unsigned long i;
543
544   _sanity_check_dynar(dynar);
545
546   for (i = 0; i < used; i++) {
547     char* elm = (char*) data + i * elmsize;
548     op(elm);
549   }
550 }
551
552 /** @brief Removes and free the entry pointed by the cursor
553  *
554  * This function can be used while traversing without problem.
555  */
556 void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor)
557 {
558   xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
559 }
560
561 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
562  *
563  * This function simply apply the classical qsort(3) function to the data stored in the dynar.
564  * You should thus refer to the libc documentation, or to some online tutorial on how to write
565  * a comparison function. Here is a quick example if you have integers in your dynar:
566  *
567  * @verbatim
568  * int cmpfunc (const void * a, const void * b) {
569  *   int intA = *(int*)a;
570  *   int intB = *(int*)b;
571  *   return intA - intB;
572  * }
573  * @endverbatim
574  *
575  * and now to sort a dynar of MSG hosts depending on their speed:
576  * @verbatim
577  * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
578  *   MSG_host_t hostA = *(MSG_host_t*)a;
579  *   MSG_host_t hostB = *(MSG_host_t*)b;
580  *   return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
581  * }
582  * @endverbatim
583  *
584  * \param dynar the dynar to sort
585  * \param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
586  */
587 void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
588 {
589   if (dynar->data != nullptr)
590     qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
591 }
592
593 static int strcmp_voidp(const void *pa, const void *pb) {
594   return strcmp(*(const char **)pa, *(const char **)pb);
595 }
596
597 /** @brief Sorts a dynar of strings (ie, char* data) */
598 xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
599 {
600   xbt_dynar_sort(dynar, strcmp_voidp);
601   return dynar; // to enable functional uses
602 }
603
604 /** @brief Sorts a dynar according to their color assuming elements can have only three colors.
605  * Since there are only three colors, it is linear and much faster than a classical sort.
606  * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
607  *
608  * \param dynar the dynar to sort
609  * \param color the color function of type (int (compar_fn*) (void*) (void*)). The return value of color is assumed to
610  *        be 0, 1, or 2.
611  *
612  * At the end of the call, elements with color 0 are at the beginning of the dynar, elements with color 2 are at the
613  * end and elements with color 1 are in the middle.
614  *
615  * Remark: if the elements stored in the dynar are structures, the color function has to retrieve the field to sort
616  * first.
617  */
618 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color)
619 {
620   unsigned long int i;
621   unsigned long int p = -1;
622   unsigned long int q = dynar->used;
623   const unsigned long elmsize = dynar->elmsize;
624   void *tmp = xbt_malloc(elmsize);
625   void *elm;
626
627   for (i = 0; i < q;) {
628     void *elmi = _xbt_dynar_elm(dynar, i);
629     int colori = color(elmi);
630
631     if (colori == 1) {
632       ++i;
633     } else {
634       if (colori == 0) {
635         elm = _xbt_dynar_elm(dynar, ++p);
636         ++i;
637       } else {                  /* colori == 2 */
638         elm = _xbt_dynar_elm(dynar, --q);
639       }
640       if (elm != elmi) {
641         memcpy(tmp,  elm,  elmsize);
642         memcpy(elm,  elmi, elmsize);
643         memcpy(elmi, tmp,  elmsize);
644       }
645     }
646   }
647   xbt_free(tmp);
648 }
649
650 /** @brief Transform a dynar into a NULL terminated array. 
651  *
652  *  \param dynar the dynar to transform
653  *  \return pointer to the first element of the array
654  *
655  *  Note: The dynar won't be usable afterwards.
656  */
657 void *xbt_dynar_to_array(xbt_dynar_t dynar)
658 {
659   void *res;
660   xbt_dynar_shrink(dynar, 1);
661   memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
662   res = dynar->data;
663   free(dynar);
664   return res;
665 }
666
667 /** @brief Compare two dynars
668  *
669  *  \param d1 first dynar to compare
670  *  \param d2 second dynar to compare
671  *  \param compar function to use to compare elements
672  *  \return 0 if d1 and d2 are equal and 1 if not equal
673  *
674  *  d1 and d2 should be dynars of pointers. The compar function takes two  elements and returns 0 when they are
675  *  considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
676  *  afterwards.
677  */
678 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int(*compar)(const void *, const void *))
679 {
680   int i ;
681   int size;
682   if((!d1) && (!d2)) return 0;
683   if((!d1) || (!d2))
684   {
685     XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
686     xbt_dynar_free(&d2);
687     return 1;
688   }
689   if((d1->elmsize)!=(d2->elmsize)) {
690     XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
691     xbt_dynar_free(&d2);
692     return 1; // xbt_die
693   }
694   if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
695     XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
696     xbt_dynar_free(&d2);
697     return 1;
698   }
699
700   size = xbt_dynar_length(d1);
701   for(i=0;i<size;i++) {
702     void *data1 = xbt_dynar_get_as(d1, i, void *);
703     void *data2 = xbt_dynar_get_as(d2, i, void *);
704     XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
705     if(compar(data1,data2)){
706       xbt_dynar_free(&d2);
707       return 1;
708     }
709   }
710   xbt_dynar_free(&d2);
711   return 0;
712 }
713
714 #ifdef SIMGRID_TEST
715
716 #define NB_ELEM 5000
717
718 XBT_TEST_SUITE("dynar", "Dynar data container");
719 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
720
721 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
722 {
723   /* Vars_decl [doxygen cruft] */
724   xbt_dynar_t d;
725   int i, cpt;
726   unsigned int cursor;
727   int *iptr;
728
729   xbt_test_add("==== Traverse the empty dynar");
730   d = xbt_dynar_new(sizeof(int), NULL);
731   xbt_dynar_foreach(d, cursor, i) {
732     xbt_die( "Damnit, there is something in the empty dynar");
733   }
734   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
735   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
736   /* in your code is naturally the way to go outside a regression test */
737
738   xbt_test_add("==== Push %d int, set them again 3 times, traverse them, shift them", NB_ELEM);
739   /* Populate_ints [doxygen cruft] */
740   /* 1. Populate the dynar */
741   d = xbt_dynar_new(sizeof(int), NULL);
742   for (cpt = 0; cpt < NB_ELEM; cpt++) {
743     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
744     /* xbt_dynar_push(d,&cpt);       This would also work */
745     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
746   }
747
748   /* 2. Traverse manually the dynar */
749   for (cursor = 0; cursor < NB_ELEM; cursor++) {
750     iptr = (int*) xbt_dynar_get_ptr(d, cursor);
751     xbt_test_assert(cursor == (unsigned int) *iptr, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
752   }
753
754   /* 3. Traverse the dynar using the neat macro to that extend */
755   xbt_dynar_foreach(d, cursor, cpt) {
756     xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
757   }
758   /* end_of_traversal */
759
760   for (cpt = 0; cpt < NB_ELEM; cpt++)
761     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
762
763   for (cpt = 0; cpt < NB_ELEM; cpt++)
764     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
765   /*     xbt_dynar_set(d,cpt,&cpt); */
766
767   for (cpt = 0; cpt < NB_ELEM; cpt++)
768     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
769
770   cpt = 0;
771   xbt_dynar_foreach(d, cursor, i) {
772     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
773     cpt++;
774   }
775   xbt_test_assert(cpt == NB_ELEM, "Cannot retrieve my %d values. Last got one is %d", NB_ELEM, cpt);
776
777   /* shifting [doxygen cruft] */
778   /* 4. Shift all the values */
779   for (cpt = 0; cpt < NB_ELEM; cpt++) {
780     xbt_dynar_shift(d, &i);
781     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
782     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
783   }
784
785   int* pi;
786   xbt_dynar_foreach_ptr(d, cursor, pi) {
787     *pi = 0;
788   }
789   xbt_dynar_foreach(d, cursor, i) {
790     xbt_test_assert(i == 0, "The value is not the same as the expected one.");
791   }
792   xbt_dynar_foreach_ptr(d, cursor, pi) {
793     *pi = 1;
794   }
795   xbt_dynar_foreach(d, cursor, i) {
796     xbt_test_assert(i == 1, "The value is not the same as the expected one.");
797   }
798
799   /* 5. Free the resources */
800   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
801   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
802   /* in your code is naturally the way to go outside a regression test */
803
804   xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
805   d = xbt_dynar_new(sizeof(int), NULL);
806   for (cpt = 0; cpt < NB_ELEM; cpt++) {
807     xbt_dynar_unshift(d, &cpt);
808     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
809   }
810   for (cpt = 0; cpt < NB_ELEM; cpt++) {
811     i = xbt_dynar_pop_as(d, int);
812     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one (%d!=%d)", i, cpt);
813     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
814   }
815   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
816   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
817   /* in your code is naturally the way to go outside a regression test */
818
819   xbt_test_add ("==== Push %d int, insert 1000 int in the middle, shift everything", NB_ELEM);
820   d = xbt_dynar_new(sizeof(int), NULL);
821   for (cpt = 0; cpt < NB_ELEM; cpt++) {
822     xbt_dynar_push_as(d, int, cpt);
823     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
824   }
825   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
826     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
827     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
828   }
829
830   for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
831     xbt_dynar_shift(d, &i);
832     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
833                      i, cpt);
834     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
835   }
836   for (cpt = 999; cpt >= 0; cpt--) {
837     xbt_dynar_shift(d, &i);
838     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
839                      i, cpt);
840   }
841   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
842     xbt_dynar_shift(d, &i);
843     xbt_test_assert(i == cpt, "The retrieved value is not the same than the injected one at the end (%d!=%d)", i, cpt);
844   }
845   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
846   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
847   /* in your code is naturally the way to go outside a regression test */
848
849   xbt_test_add("==== Push %d int, remove 2000-4000. free the rest", NB_ELEM);
850   d = xbt_dynar_new(sizeof(int), NULL);
851   for (cpt = 0; cpt < NB_ELEM; cpt++)
852     xbt_dynar_push_as(d, int, cpt);
853
854   for (cpt = 2000; cpt < 4000; cpt++) {
855     xbt_dynar_remove_at(d, 2000, &i);
856     xbt_test_assert(i == cpt, "Remove a bad value. Got %d, expected %d", i, cpt);
857     XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
858   }
859   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
860   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
861   /* in your code is naturally the way to go outside a regression test */
862 }
863
864 /*******************************************************************************/
865 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
866 {
867   xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
868   unsigned int cursor;
869   int cpt;
870
871   xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
872   /* Populate_ints [doxygen cruft] */
873   /* 1. Populate the dynar */
874   for (cpt = 0; cpt < NB_ELEM; cpt++) {
875     xbt_dynar_insert_at(d, cpt, &cpt);
876     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
877   }
878
879   /* 3. Traverse the dynar */
880   xbt_dynar_foreach(d, cursor, cpt) {
881     xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
882   }
883   /* end_of_traversal */
884
885   /* Re-fill with the same values using set_as (and re-verify) */
886   for (cpt = 0; cpt < NB_ELEM; cpt++)
887     xbt_dynar_set_as(d, cpt, int, cpt);
888   xbt_dynar_foreach(d, cursor, cpt)
889     xbt_test_assert(cursor == (unsigned int) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
890
891   for (cpt = 0; cpt < NB_ELEM; cpt++) {
892     int val;
893     xbt_dynar_remove_at(d,0,&val);
894     xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
895   }
896   xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
897                    xbt_dynar_length(d));
898   xbt_dynar_free(&d);
899
900   /* ********************* */
901   xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
902   d = xbt_dynar_new(sizeof(int), NULL);
903   for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
904     xbt_dynar_replace(d, cpt, &cpt);
905     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
906   }
907
908   /* 3. Traverse the dynar */
909   xbt_dynar_foreach(d, cursor, cpt) {
910     xbt_test_assert(cursor == (unsigned) cpt, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
911   }
912   /* end_of_traversal */
913
914   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
915     int val;
916     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
917     xbt_test_assert(cpt == val, "The retrieved value is not the same than the injected one (%u!=%d)", cursor, cpt);
918   }
919   xbt_test_assert(xbt_dynar_is_empty(d), "There is still %lu elements in the dynar after removing everything",
920                    xbt_dynar_length(d));
921   xbt_dynar_free(&d);
922 }
923
924 /*******************************************************************************/
925 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
926 {
927   xbt_dynar_t d;
928   int cpt;
929   unsigned int cursor;
930   double d1, d2;
931
932   xbt_test_add("==== Traverse the empty dynar");
933   d = xbt_dynar_new(sizeof(int), NULL);
934   xbt_dynar_foreach(d, cursor, cpt) {
935     xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
936   }
937   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
938   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
939   /* in your code is naturally the way to go outside a regression test */
940
941   xbt_test_add("==== Push/shift 5000 doubles");
942   d = xbt_dynar_new(sizeof(double), NULL);
943   for (cpt = 0; cpt < 5000; cpt++) {
944     d1 = (double) cpt;
945     xbt_dynar_push(d, &d1);
946   }
947   xbt_dynar_foreach(d, cursor, d2) {
948     d1 = (double) cursor;
949     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
950   }
951   for (cpt = 0; cpt < 5000; cpt++) {
952     d1 = (double) cpt;
953     xbt_dynar_shift(d, &d2);
954     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
955   }
956   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
957   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
958   /* in your code is naturally the way to go outside a regression test */
959
960   xbt_test_add("==== Unshift/pop 5000 doubles");
961   d = xbt_dynar_new(sizeof(double), NULL);
962   for (cpt = 0; cpt < 5000; cpt++) {
963     d1 = (double) cpt;
964     xbt_dynar_unshift(d, &d1);
965   }
966   for (cpt = 0; cpt < 5000; cpt++) {
967     d1 = (double) cpt;
968     xbt_dynar_pop(d, &d2);
969     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one (%f!=%f)", d1, d2);
970   }
971   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
972   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
973   /* in your code is naturally the way to go outside a regression test */
974
975   xbt_test_add("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
976   d = xbt_dynar_new(sizeof(double), NULL);
977   for (cpt = 0; cpt < 5000; cpt++) {
978     d1 = (double) cpt;
979     xbt_dynar_push(d, &d1);
980   }
981   for (cpt = 0; cpt < 1000; cpt++) {
982     d1 = (double) cpt;
983     xbt_dynar_insert_at(d, 2500, &d1);
984   }
985
986   for (cpt = 0; cpt < 2500; cpt++) {
987     d1 = (double) cpt;
988     xbt_dynar_shift(d, &d2);
989     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
990                      d1, d2);
991     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
992   }
993   for (cpt = 999; cpt >= 0; cpt--) {
994     d1 = (double) cpt;
995     xbt_dynar_shift(d, &d2);
996     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
997                      d1, d2);
998   }
999   for (cpt = 2500; cpt < 5000; cpt++) {
1000     d1 = (double) cpt;
1001     xbt_dynar_shift(d, &d2);
1002     xbt_test_assert(d1 == d2, "The retrieved value is not the same than the injected one at the end (%f!=%f)", d1, d2);
1003   }
1004   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1005   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1006   /* in your code is naturally the way to go outside a regression test */
1007
1008   xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1009   d = xbt_dynar_new(sizeof(double), NULL);
1010   for (cpt = 0; cpt < 5000; cpt++) {
1011     d1 = (double) cpt;
1012     xbt_dynar_push(d, &d1);
1013   }
1014   for (cpt = 2000; cpt < 4000; cpt++) {
1015     d1 = (double) cpt;
1016     xbt_dynar_remove_at(d, 2000, &d2);
1017     xbt_test_assert(d1 == d2, "Remove a bad value. Got %f, expected %f", d2, d1);
1018   }
1019   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1020   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1021   /* in your code is naturally the way to go outside a regression test */
1022 }
1023
1024 /* doxygen_string_cruft */
1025
1026 /*******************************************************************************/
1027 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1028 {
1029   xbt_dynar_t d;
1030   int cpt;
1031   unsigned int iter;
1032   char buf[1024];
1033   char *s1, *s2;
1034
1035   xbt_test_add("==== Traverse the empty dynar");
1036   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1037   xbt_dynar_foreach(d, iter, s1) {
1038     xbt_test_assert(FALSE, "Damnit, there is something in the empty dynar");
1039   }
1040   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1041   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1042   /* in your code is naturally the way to go outside a regression test */
1043
1044   xbt_test_add("==== Push %d strings, set them again 3 times, shift them", NB_ELEM);
1045   /* Populate_str [doxygen cruft] */
1046   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1047   /* 1. Populate the dynar */
1048   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1049     snprintf(buf,1023, "%d", cpt);
1050     s1 = xbt_strdup(buf);
1051     xbt_dynar_push(d, &s1);
1052   }
1053   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1054     snprintf(buf,1023, "%d", cpt);
1055     s1 = xbt_strdup(buf);
1056     xbt_dynar_replace(d, cpt, &s1);
1057   }
1058   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1059     snprintf(buf,1023, "%d", cpt);
1060     s1 = xbt_strdup(buf);
1061     xbt_dynar_replace(d, cpt, &s1);
1062   }
1063   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1064     snprintf(buf,1023, "%d", cpt);
1065     s1 = xbt_strdup(buf);
1066     xbt_dynar_replace(d, cpt, &s1);
1067   }
1068   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1069     snprintf(buf,1023, "%d", cpt);
1070     xbt_dynar_shift(d, &s2);
1071     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1072     free(s2);
1073   }
1074   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1075   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1076   /* in your code is naturally the way to go outside a regression test */
1077
1078   xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1079   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1080   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1081     snprintf(buf,1023, "%d", cpt);
1082     s1 = xbt_strdup(buf);
1083     xbt_dynar_unshift(d, &s1);
1084   }
1085   /* 2. Traverse the dynar with the macro */
1086   xbt_dynar_foreach(d, iter, s1) {
1087     snprintf(buf,1023, "%u", NB_ELEM - iter - 1);
1088     xbt_test_assert(!strcmp(buf, s1), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s1);
1089   }
1090   /* 3. Traverse the dynar with the macro */
1091   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1092     snprintf(buf,1023, "%d", cpt);
1093     xbt_dynar_pop(d, &s2);
1094     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one (%s!=%s)", buf, s2);
1095     free(s2);
1096   }
1097   /* 4. Free the resources */
1098   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1099   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1100   /* in your code is naturally the way to go outside a regression test */
1101
1102   xbt_test_add("==== Push %d strings, insert %d strings in the middle, shift everything", NB_ELEM, NB_ELEM / 5);
1103   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1104   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1105     snprintf(buf,1023, "%d", cpt);
1106     s1 = xbt_strdup(buf);
1107     xbt_dynar_push(d, &s1);
1108   }
1109   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1110     snprintf(buf,1023, "%d", cpt);
1111     s1 = xbt_strdup(buf);
1112     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1113   }
1114
1115   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1116     snprintf(buf,1023, "%d", cpt);
1117     xbt_dynar_shift(d, &s2);
1118     xbt_test_assert(!strcmp(buf, s2),
1119                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)", buf, s2);
1120     free(s2);
1121   }
1122   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1123     snprintf(buf,1023, "%d", cpt);
1124     xbt_dynar_shift(d, &s2);
1125     xbt_test_assert(!strcmp(buf, s2),
1126                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)", buf, s2);
1127     free(s2);
1128   }
1129   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1130     snprintf(buf,1023, "%d", cpt);
1131     xbt_dynar_shift(d, &s2);
1132     xbt_test_assert(!strcmp(buf, s2), "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1133                      buf, s2);
1134     free(s2);
1135   }
1136   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1137   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1138   /* in your code is naturally the way to go outside a regression test */
1139
1140   xbt_test_add("==== Push %d strings, remove %d-%d. free the rest", NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1141   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1142   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1143     snprintf(buf,1023, "%d", cpt);
1144     s1 = xbt_strdup(buf);
1145     xbt_dynar_push(d, &s1);
1146   }
1147   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1148     snprintf(buf,1023, "%d", cpt);
1149     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1150     xbt_test_assert(!strcmp(buf, s2), "Remove a bad value. Got %s, expected %s", s2, buf);
1151     free(s2);
1152   }
1153   xbt_dynar_free(&d);           /* end_of_doxygen */
1154 }
1155 #endif                          /* SIMGRID_TEST */