Logo AND Algorithmique Numérique Distribuée

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