Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b5468e3b9fa76a0657f319eda6f6cbd5c9475a8e
[simgrid.git] / src / xbt / dynar.c
1 /* a generic DYNamic ARray implementation.                                  */
2
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 "portable.h"           /* SIZEOF_MAX */
10 #include "xbt/misc.h"
11 #include "xbt/sysdep.h"
12 #include "xbt/log.h"
13 #include "xbt/ex.h"
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
16
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.
20  */
21
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
23
24 static XBT_INLINE void _dynar_lock(xbt_dynar_t dynar)
25 {
26   if (dynar->mutex)
27     xbt_mutex_acquire(dynar->mutex);
28 }
29
30 static XBT_INLINE void _dynar_unlock(xbt_dynar_t dynar)
31 {
32   if (dynar->mutex)
33     xbt_mutex_release(dynar->mutex);
34 }
35
36 static XBT_INLINE void _sanity_check_dynar(xbt_dynar_t dynar)
37 {
38   xbt_assert(dynar, "dynar is NULL");
39 }
40
41 static XBT_INLINE void _sanity_check_idx(int idx)
42 {
43   xbt_assert(idx >= 0, "dynar idx(=%d) < 0", (int) (idx));
44 }
45
46 static XBT_INLINE void _check_inbound_idx(xbt_dynar_t dynar, int idx)
47 {
48   if (idx < 0 || idx >= dynar->used) {
49     _dynar_unlock(dynar);
50     THROWF(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);
53   }
54 }
55
56 static XBT_INLINE void _check_sloppy_inbound_idx(xbt_dynar_t dynar,
57                                                  int idx)
58 {
59   if (idx > dynar->used) {
60     _dynar_unlock(dynar);
61     THROWF(bound_error, idx,
62            "dynar is not that long. You asked %d, but it's only %lu long (could have been equal to it)",
63            (int) (idx), (unsigned long) dynar->used);
64   }
65 }
66
67 static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
68 {
69   if (dynar->used == 0) {
70     _dynar_unlock(dynar);
71     THROWF(bound_error, 0, "dynar %p is empty", dynar);
72   }
73 }
74
75 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
76
77 static XBT_INLINE
78     void _xbt_clear_mem(void *const ptr, const unsigned long length)
79 {
80   memset(ptr, 0, length);
81 }
82
83 static XBT_INLINE
84     void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
85 {
86   const unsigned long old_size = dynar->size;
87
88   if (nb > old_size) {
89     void *const old_data = dynar->data;
90     const unsigned long elmsize = dynar->elmsize;
91     const unsigned long old_length = old_size * elmsize;
92
93     const unsigned long expand = 2 * (old_size + 1);
94     const unsigned long new_size = (nb > expand ? nb : expand);
95     const unsigned long new_length = new_size * elmsize;
96     void *const new_data = xbt_realloc(old_data, new_length);
97
98     XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, new_size);
99
100     _xbt_clear_mem((char *)new_data + old_length, new_length - old_length);
101
102     dynar->size = new_size;
103     dynar->data = new_data;
104   }
105 }
106
107 static XBT_INLINE
108     void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
109 {
110   char *const data = (char *) dynar->data;
111   const unsigned long elmsize = dynar->elmsize;
112
113   return data + idx * elmsize;
114 }
115
116 static XBT_INLINE
117     void
118 _xbt_dynar_get_elm(void *const dst,
119                    const xbt_dynar_t dynar, const unsigned long idx)
120 {
121   void *const elm = _xbt_dynar_elm(dynar, idx);
122
123   memcpy(dst, elm, dynar->elmsize);
124 }
125
126 static XBT_INLINE
127     void
128 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
129                    const unsigned long idx, const void *const src)
130 {
131   void *const elm = _xbt_dynar_elm(dynar, idx);
132   const unsigned long elmsize = dynar->elmsize;
133
134   memcpy(elm, src, elmsize);
135 }
136
137 static XBT_INLINE
138     void
139 _xbt_dynar_remove_at(xbt_dynar_t const dynar,
140                      const unsigned long idx, void *const object)
141 {
142
143   unsigned long nb_shift;
144   unsigned long offset;
145
146   _sanity_check_dynar(dynar);
147   _check_inbound_idx(dynar, idx);
148
149   if (object) {
150     _xbt_dynar_get_elm(object, dynar, idx);
151   } else if (dynar->free_f) {
152     if (dynar->elmsize <= SIZEOF_MAX) {
153       char elm[SIZEOF_MAX];
154       _xbt_dynar_get_elm(elm, dynar, idx);
155       (*dynar->free_f) (elm);
156     } else {
157       char *elm = malloc(dynar->elmsize);
158       _xbt_dynar_get_elm(elm, dynar, idx);
159       (*dynar->free_f) (elm);
160       free(elm);
161     }
162   }
163
164   nb_shift = dynar->used - 1 - idx;
165
166   if (nb_shift) {
167     offset = nb_shift * dynar->elmsize;
168     memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1),
169             offset);
170   }
171
172   dynar->used--;
173 }
174
175 void xbt_dynar_dump(xbt_dynar_t dynar)
176 {
177   XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
178         dynar->size, dynar->used, dynar->elmsize, dynar->data,
179         dynar->free_f);
180 }
181
182 /** @brief Constructor
183  *
184  * \param elmsize size of each element in the dynar
185  * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
186  *
187  * Creates a new dynar. If a free_func is provided, the elements have to be
188  * pointer of pointer. That is to say that dynars can contain either base
189  * types (int, char, double, etc) or pointer of pointers (struct **).
190  */
191 xbt_dynar_t
192 xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
193 {
194
195   xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
196
197   dynar->size = 0;
198   dynar->used = 0;
199   dynar->elmsize = elmsize;
200   dynar->data = NULL;
201   dynar->free_f = free_f;
202   dynar->mutex = NULL;
203
204   return dynar;
205 }
206
207 /** @brief Creates a synchronized dynar.
208  *
209  * Just like #xbt_dynar_new, but each access to the structure will be protected by a mutex
210  *
211  */
212 xbt_dynar_t
213 xbt_dynar_new_sync(const unsigned long elmsize,
214                    void_f_pvoid_t const free_f)
215 {
216   xbt_dynar_t res = xbt_dynar_new(elmsize, free_f);
217   res->mutex = xbt_mutex_init();
218   return res;
219 }
220
221 /** @brief Destructor of the structure not touching to the content
222  *
223  * \param dynar poor victim
224  *
225  * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
226  * is not touched (the \a free_f function is not used)
227  */
228 void xbt_dynar_free_container(xbt_dynar_t * dynar)
229 {
230   if (dynar && *dynar) {
231
232     if ((*dynar)->data) {
233       _xbt_clear_mem((*dynar)->data, (*dynar)->size);
234       free((*dynar)->data);
235     }
236
237     if ((*dynar)->mutex)
238       xbt_mutex_destroy((*dynar)->mutex);
239
240     _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
241
242     free(*dynar);
243     *dynar = NULL;
244   }
245 }
246
247 /** @brief Frees the content and set the size to 0
248  *
249  * \param dynar who to squeeze
250  */
251 XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
252 {
253   _dynar_lock(dynar);
254
255   _sanity_check_dynar(dynar);
256
257   XBT_DEBUG("Reset the dynar %p", (void *) dynar);
258   if (dynar->free_f) {
259     _dynar_map(dynar, dynar->free_f);
260   }
261   /*
262      if (dynar->data)
263      free(dynar->data);
264
265      dynar->size = 0;
266    */
267   dynar->used = 0;
268
269   _dynar_unlock(dynar);
270
271   /*  dynar->data = NULL; */
272 }
273
274 /**
275  * \brief Shrink the dynar by removing empty slots at the end of the internal array
276  * \param dynar a dynar
277  * \param empty_slots_wanted number of empty slots you want to keep at the end of the
278  * internal array for further insertions
279  *
280  * Reduces the internal array size of the dynar to the number of elements plus
281  * \a empty_slots_wanted.
282  * After removing elements from the dynar, you can call this function to make
283  * the dynar use less memory.
284  * Set \a empty_slots_wanted to zero to reduce the dynar internal array as much
285  * as possible.
286  * Note that if \a empty_slots_wanted is greater than the array size, the internal
287  * array is expanded instead of shriked.
288  */
289 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
290 {
291   unsigned long size_wanted;
292
293   _dynar_lock(dynar);
294
295   size_wanted = dynar->used + empty_slots_wanted;
296   if (size_wanted != dynar->size) {
297     dynar->size = size_wanted;
298     dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
299   }
300   _dynar_unlock(dynar);
301 }
302
303 /** @brief Destructor
304  *
305  * \param dynar poor victim
306  *
307  * kilkil a dynar and its content
308  */
309
310 XBT_INLINE void xbt_dynar_free(xbt_dynar_t * dynar)
311 {
312   if (dynar && *dynar) {
313     xbt_dynar_reset(*dynar);
314     xbt_dynar_free_container(dynar);
315   }
316 }
317
318 /** \brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
319 void xbt_dynar_free_voidp(void *d)
320 {
321   xbt_dynar_t dynar = (xbt_dynar_t)d;
322   xbt_dynar_free(&dynar);
323 }
324
325 /** @brief Count of dynar's elements
326  *
327  * \param dynar the dynar we want to mesure
328  */
329 XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
330 {
331   return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
332 }
333
334 /**@brief check if a dynar is empty
335  *
336  *\param dynar the dynat we want to check
337  */
338
339 XBT_INLINE int xbt_dynar_is_empty(const xbt_dynar_t dynar)
340 {
341   return (xbt_dynar_length(dynar) == 0);
342 }
343
344 /** @brief Retrieve a copy of the Nth element of a dynar.
345  *
346  * \param dynar information dealer
347  * \param idx index of the slot we want to retrieve
348  * \param[out] dst where to put the result to.
349  */
350 XBT_INLINE void
351 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
352                   const unsigned long idx, void *const dst)
353 {
354   _dynar_lock(dynar);
355   _sanity_check_dynar(dynar);
356   _check_inbound_idx(dynar, idx);
357
358   _xbt_dynar_get_elm(dst, dynar, idx);
359   _dynar_unlock(dynar);
360 }
361
362 /** @brief Retrieve a pointer to the Nth element of a dynar.
363  *
364  * \param dynar information dealer
365  * \param idx index of the slot we want to retrieve
366  * \return the \a idx-th element of \a dynar.
367  *
368  * \warning The returned value is the actual content of the dynar.
369  * Make a copy before fooling with it.
370  */
371 XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
372                                    const unsigned long idx)
373 {
374
375   void *res;
376   _dynar_lock(dynar);
377   _sanity_check_dynar(dynar);
378   _check_inbound_idx(dynar, idx);
379
380   res = _xbt_dynar_elm(dynar, idx);
381   _dynar_unlock(dynar);
382   return res;
383 }
384
385 XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
386                                       const unsigned long idx)
387 {
388
389   void *res;
390   _dynar_lock(dynar);
391   _sanity_check_dynar(dynar);
392
393   _xbt_dynar_expand(dynar, idx + 1);
394
395   if (idx >= dynar->used) {
396     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
397                    (idx + 1 - dynar->used)*dynar->elmsize);
398     dynar->used = idx + 1;
399   }
400   
401   _dynar_unlock(dynar);
402
403   res = _xbt_dynar_elm(dynar, idx);
404
405   return res;
406 }
407
408 static void XBT_INLINE          /* not synchronized */
409 _xbt_dynar_set(xbt_dynar_t dynar,
410                const unsigned long idx, const void *const src)
411 {
412
413   _sanity_check_dynar(dynar);
414
415   _xbt_dynar_expand(dynar, idx + 1);
416
417   if (idx >= dynar->used) {
418     _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
419                    (idx + 1 - dynar->used)*dynar->elmsize);
420     dynar->used = idx + 1;
421   }
422
423   _xbt_dynar_put_elm(dynar, idx, src);
424 }
425
426 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
427  *
428  * \param dynar information dealer
429  * \param idx index of the slot we want to modify
430  * \param src What will be feeded to the dynar
431  *
432  * If you want to free the previous content, use xbt_dynar_replace().
433  */
434 XBT_INLINE void xbt_dynar_set(xbt_dynar_t dynar, const int idx,
435                               const void *const src)
436 {
437
438   _dynar_lock(dynar);
439   _xbt_dynar_set(dynar, idx, src);
440   _dynar_unlock(dynar);
441 }
442
443 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
444  *
445  * \param dynar
446  * \param idx
447  * \param object
448  *
449  * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
450  * free the previous value at this position. If you don't want to free the
451  * previous content, use xbt_dynar_set().
452  */
453 void
454 xbt_dynar_replace(xbt_dynar_t dynar,
455                   const unsigned long idx, const void *const object)
456 {
457   _dynar_lock(dynar);
458   _sanity_check_dynar(dynar);
459
460   if (idx < dynar->used && dynar->free_f) {
461     void *const old_object = _xbt_dynar_elm(dynar, idx);
462
463     (*(dynar->free_f)) (old_object);
464   }
465
466   _xbt_dynar_set(dynar, idx, object);
467   _dynar_unlock(dynar);
468 }
469
470 static XBT_INLINE void *_xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
471                                                  const unsigned long idx)
472 {
473   void *res;
474   unsigned long old_used;
475   unsigned long new_used;
476   long nb_shift;
477
478   _sanity_check_dynar(dynar);
479   _sanity_check_idx(idx);
480
481   old_used = dynar->used;
482   new_used = old_used + 1;
483
484   _xbt_dynar_expand(dynar, new_used);
485
486   nb_shift = old_used - idx;
487
488   if (nb_shift>0) {
489     memmove(_xbt_dynar_elm(dynar, idx + 1),
490             _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
491   }
492
493   dynar->used = new_used;
494   res = _xbt_dynar_elm(dynar, idx);
495   return res;
496 }
497
498 /** @brief Make room for a new element, and return a pointer to it
499  *
500  * You can then use regular affectation to set its value instead of relying
501  * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
502  */
503 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
504 {
505   void *res;
506
507   _dynar_lock(dynar);
508   res = _xbt_dynar_insert_at_ptr(dynar, idx);
509   _dynar_unlock(dynar);
510   return res;
511 }
512
513 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
514  *
515  * Set the Nth element of a dynar, expanding the dynar if needed, and
516  * moving the previously existing value and all subsequent ones to one
517  * position right in the dynar.
518  */
519 XBT_INLINE void
520 xbt_dynar_insert_at(xbt_dynar_t const dynar,
521                     const int idx, const void *const src)
522 {
523
524   _dynar_lock(dynar);
525   /* checks done in xbt_dynar_insert_at_ptr */
526   memcpy(_xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
527   _dynar_unlock(dynar);
528 }
529
530 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
531  *
532  * Get the Nth element of a dynar, removing it from the dynar and moving
533  * all subsequent values to one position left in the dynar.
534  *
535  * If the object argument of this function is a non-null pointer, the removed
536  * element is copied to this address. If not, the element is freed using the
537  * free_f function passed at dynar creation.
538  */
539 void
540 xbt_dynar_remove_at(xbt_dynar_t const dynar,
541                     const int idx, void *const object)
542 {
543
544   _dynar_lock(dynar);
545   _xbt_dynar_remove_at(dynar, idx, object);
546   _dynar_unlock(dynar);
547 }
548
549 /** @brief Returns the position of the element in the dynar
550  *
551  * Raises not_found_error if not found.
552  */
553 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
554 {
555   unsigned long it;
556
557   _dynar_lock(dynar);
558   for (it = 0; it < dynar->used; it++)
559     if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
560       _dynar_unlock(dynar);
561       return it;
562     }
563
564   _dynar_unlock(dynar);
565   THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem,
566          dynar);
567 }
568
569 /** @brief Returns a boolean indicating whether the element is part of the dynar */
570 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
571 {
572
573   xbt_ex_t e;
574
575   TRY {
576     xbt_dynar_search(dynar, elem);
577   }
578   CATCH(e) {
579     if (e.category == not_found_error) {
580       xbt_ex_free(e);
581       return 0;
582     }
583     RETHROW;
584   }
585   return 1;
586 }
587
588 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
589  *
590  * You can then use regular affectation to set its value instead of relying
591  * on the slow memcpy. This is what xbt_dynar_push_as() does.
592  */
593 XBT_INLINE void *xbt_dynar_push_ptr(xbt_dynar_t const dynar)
594 {
595   void *res;
596
597   /* we have to inline xbt_dynar_insert_at_ptr here to make sure that
598      dynar->used don't change between reading it and getting the lock
599      within xbt_dynar_insert_at_ptr */
600   _dynar_lock(dynar);
601   res = _xbt_dynar_insert_at_ptr(dynar, dynar->used);
602   _dynar_unlock(dynar);
603   return res;
604 }
605
606 /** @brief Add an element at the end of the dynar */
607 XBT_INLINE void xbt_dynar_push(xbt_dynar_t const dynar,
608                                const void *const src)
609 {
610   _dynar_lock(dynar);
611   /* checks done in xbt_dynar_insert_at_ptr */
612   memcpy(_xbt_dynar_insert_at_ptr(dynar, dynar->used), src,
613          dynar->elmsize);
614   _dynar_unlock(dynar);
615 }
616
617 /** @brief Mark the last dynar's element as unused and return a pointer to it.
618  *
619  * You can then use regular affectation to set its value instead of relying
620  * on the slow memcpy. This is what xbt_dynar_pop_as() does.
621  */
622 XBT_INLINE void *xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
623 {
624   void *res;
625
626   _dynar_lock(dynar);
627   _check_populated_dynar(dynar);
628   XBT_DEBUG("Pop %p", (void *) dynar);
629   dynar->used--;
630   res = _xbt_dynar_elm(dynar, dynar->used);
631   _dynar_unlock(dynar);
632   return res;
633 }
634
635 /** @brief Get and remove the last element of the dynar */
636 XBT_INLINE void xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst)
637 {
638
639   /* sanity checks done by remove_at */
640   XBT_DEBUG("Pop %p", (void *) dynar);
641   _dynar_lock(dynar);
642   _xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
643   _dynar_unlock(dynar);
644 }
645
646 /** @brief Add an element at the begining of the dynar.
647  *
648  * This is less efficient than xbt_dynar_push()
649  */
650 XBT_INLINE void xbt_dynar_unshift(xbt_dynar_t const dynar,
651                                   const void *const src)
652 {
653
654   /* sanity checks done by insert_at */
655   xbt_dynar_insert_at(dynar, 0, src);
656 }
657
658 /** @brief Get and remove the first element of the dynar.
659  *
660  * This is less efficient than xbt_dynar_pop()
661  */
662 XBT_INLINE void xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst)
663 {
664
665   /* sanity checks done by remove_at */
666   xbt_dynar_remove_at(dynar, 0, dst);
667 }
668
669 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
670 {
671   char *const data = (char *) dynar->data;
672   const unsigned long elmsize = dynar->elmsize;
673   const unsigned long used = dynar->used;
674   unsigned long i;
675
676   for (i = 0; i < used; i++) {
677     char* elm = (char*) data + i * elmsize;
678     (*op) (elm);
679   }
680 }
681
682 /** @brief Apply a function to each member of a dynar
683  *
684  * The mapped function may change the value of the element itself,
685  * but should not mess with the structure of the dynar.
686  *
687  * If the dynar is synchronized, it is locked during the whole map
688  * operation, so make sure your function don't call any function
689  * from xbt_dynar_* on it, or you'll get a deadlock.
690  */
691 XBT_INLINE void xbt_dynar_map(const xbt_dynar_t dynar,
692                               void_f_pvoid_t const op)
693 {
694
695   _sanity_check_dynar(dynar);
696   _dynar_lock(dynar);
697
698   _dynar_map(dynar, op);
699
700   _dynar_unlock(dynar);
701 }
702
703
704 /** @brief Removes and free the entry pointed by the cursor
705  *
706  * This function can be used while traversing without problem.
707  */
708 XBT_INLINE void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
709                                     unsigned int *const cursor)
710 {
711
712   _xbt_dynar_remove_at(dynar, (*cursor)--, NULL);
713 }
714
715 /** @brief Unlocks a synchronized dynar when you want to break the traversal
716  *
717  * This function must be used if you <tt>break</tt> the
718  * xbt_dynar_foreach loop, but shouldn't be called at the end of a
719  * regular traversal reaching the end of the elements
720  */
721 XBT_INLINE void xbt_dynar_cursor_unlock(xbt_dynar_t dynar)
722 {
723   _dynar_unlock(dynar);
724 }
725
726 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
727  *
728  * \param dynar the dynar to sort
729  * \param compar_fn comparison function of type (int (compar_fn*) (void*) (void*)).
730  *
731  * Remark: if the elements stored in the dynar are structures, the compar_fn
732  * function has to retrieve the field to sort first.
733  */
734 XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
735                                int_f_cpvoid_cpvoid_t compar_fn)
736 {
737
738   _dynar_lock(dynar);
739
740 #ifdef HAVE_MERGESORT
741   mergesort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
742 #else
743   qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
744 #endif
745   _dynar_unlock(dynar);
746 }
747
748 /** @brief Transform a dynar into a NULL terminated array
749  *
750  * \param dynar the dynar to transform
751  */
752 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
753 {
754   void * res;
755         void * last = xbt_new0(char,dynar->elmsize);
756         xbt_dynar_push(dynar, last);
757         free(last);
758         res = dynar->data;
759         free(dynar);
760         return res;
761 }
762
763 /*
764  * Return 0 if d1 and d2 are equal and 1 if not equal
765  */
766 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
767                                         int(*compar)(const void *, const void *))
768 {
769         int i ;
770         int size;
771         if((!d1) && (!d2)) return 0;
772         if((!d1) || (!d2))
773         {
774                 XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
775                 xbt_dynar_free(&d2);
776                 return 1;
777         }
778         if((d1->elmsize)!=(d2->elmsize))
779         {
780                 XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
781                 xbt_dynar_free(&d2);
782                 return 1; // xbt_die
783         }
784         if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
785         {
786                 XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
787                 xbt_dynar_free(&d2);
788                 return 1;
789         }
790
791         size = xbt_dynar_length(d1);
792         for(i=0;i<size;i++)
793         {
794                 void *data1 = xbt_dynar_get_as(d1, i, void *);
795                 void *data2 = xbt_dynar_get_as(d2, i, void *);
796                 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
797                 if(compar(data1,data2)){
798                         xbt_dynar_free(&d2);
799                         return 1;
800                 }
801         }
802         xbt_dynar_free(&d2);
803         return 0;
804 }
805
806 #ifdef SIMGRID_TEST
807
808 #define NB_ELEM 5000
809
810 XBT_TEST_SUITE("dynar", "Dynar data container");
811 XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
812 XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
813
814 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
815 {
816   /* Vars_decl [doxygen cruft] */
817   xbt_dynar_t d;
818   int i, cpt;
819   unsigned int cursor;
820   int *iptr;
821
822   xbt_test_add("==== Traverse the empty dynar");
823   d = xbt_dynar_new(sizeof(int), NULL);
824   xbt_dynar_foreach(d, cursor, i) {
825     xbt_die( "Damnit, there is something in the empty dynar");
826   }
827   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
828   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
829   /* in your code is naturally the way to go outside a regression test */
830
831   xbt_test_add
832       ("==== Push %d int, set them again 3 times, traverse them, shift them",
833        NB_ELEM);
834   /* Populate_ints [doxygen cruft] */
835   /* 1. Populate the dynar */
836   d = xbt_dynar_new(sizeof(int), NULL);
837   for (cpt = 0; cpt < NB_ELEM; cpt++) {
838     xbt_dynar_push_as(d, int, cpt);     /* This is faster (and possible only with scalars) */
839     /* xbt_dynar_push(d,&cpt);       This would also work */
840     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
841   }
842
843   /* 2. Traverse manually the dynar */
844   for (cursor = 0; cursor < NB_ELEM; cursor++) {
845     iptr = xbt_dynar_get_ptr(d, cursor);
846     xbt_test_assert(cursor == *iptr,
847                      "The retrieved value is not the same than the injected one (%d!=%d)",
848                      cursor, cpt);
849   }
850
851   /* 3. Traverse the dynar using the neat macro to that extend */
852   xbt_dynar_foreach(d, cursor, cpt) {
853     xbt_test_assert(cursor == cpt,
854                      "The retrieved value is not the same than the injected one (%d!=%d)",
855                      cursor, cpt);
856   }
857   /* end_of_traversal */
858
859   for (cpt = 0; cpt < NB_ELEM; cpt++)
860     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
861
862   for (cpt = 0; cpt < NB_ELEM; cpt++)
863     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
864   /*     xbt_dynar_set(d,cpt,&cpt); */
865
866   for (cpt = 0; cpt < NB_ELEM; cpt++)
867     *(int *) xbt_dynar_get_ptr(d, cpt) = cpt;
868
869   cpt = 0;
870   xbt_dynar_foreach(d, cursor, i) {
871     xbt_test_assert(i == cpt,
872                      "The retrieved value is not the same than the injected one (%d!=%d)",
873                      i, cpt);
874     cpt++;
875   }
876   xbt_test_assert(cpt == NB_ELEM,
877                    "Cannot retrieve my %d values. Last got one is %d",
878                    NB_ELEM, cpt);
879
880   /* shifting [doxygen cruft] */
881   /* 4. Shift all the values */
882   for (cpt = 0; cpt < NB_ELEM; cpt++) {
883     xbt_dynar_shift(d, &i);
884     xbt_test_assert(i == cpt,
885                      "The retrieved value is not the same than the injected one (%d!=%d)",
886                      i, cpt);
887     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
888   }
889
890   /* 5. Free the resources */
891   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
892   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
893   /* in your code is naturally the way to go outside a regression test */
894
895   xbt_test_add("==== Unshift/pop %d int", NB_ELEM);
896   d = xbt_dynar_new(sizeof(int), NULL);
897   for (cpt = 0; cpt < NB_ELEM; cpt++) {
898     xbt_dynar_unshift(d, &cpt);
899     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
900   }
901   for (cpt = 0; cpt < NB_ELEM; cpt++) {
902     i = xbt_dynar_pop_as(d, int);
903     xbt_test_assert(i == cpt,
904                      "The retrieved value is not the same than the injected one (%d!=%d)",
905                      i, cpt);
906     xbt_test_log("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
907   }
908   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
909   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
910   /* in your code is naturally the way to go outside a regression test */
911
912
913   xbt_test_add
914       ("==== Push %d int, insert 1000 int in the middle, shift everything",
915        NB_ELEM);
916   d = xbt_dynar_new(sizeof(int), NULL);
917   for (cpt = 0; cpt < NB_ELEM; cpt++) {
918     xbt_dynar_push_as(d, int, cpt);
919     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
920   }
921   for (cpt = 0; cpt < NB_ELEM/5; cpt++) {
922     xbt_dynar_insert_at_as(d, NB_ELEM/2, int, cpt);
923     XBT_DEBUG("Push %d, length=%lu", cpt, xbt_dynar_length(d));
924   }
925
926   for (cpt = 0; cpt < NB_ELEM/2; cpt++) {
927     xbt_dynar_shift(d, &i);
928     xbt_test_assert(i == cpt,
929                      "The retrieved value is not the same than the injected one at the begining (%d!=%d)",
930                      i, cpt);
931     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
932   }
933   for (cpt = 999; cpt >= 0; cpt--) {
934     xbt_dynar_shift(d, &i);
935     xbt_test_assert(i == cpt,
936                      "The retrieved value is not the same than the injected one in the middle (%d!=%d)",
937                      i, cpt);
938   }
939   for (cpt = 2500; cpt < NB_ELEM; cpt++) {
940     xbt_dynar_shift(d, &i);
941     xbt_test_assert(i == cpt,
942                      "The retrieved value is not the same than the injected one at the end (%d!=%d)",
943                      i, cpt);
944   }
945   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
946   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
947   /* in your code is naturally the way to go outside a regression test */
948
949   xbt_test_add("==== Push %d int, remove 2000-4000. free the rest",
950                 NB_ELEM);
951   d = xbt_dynar_new(sizeof(int), NULL);
952   for (cpt = 0; cpt < NB_ELEM; cpt++)
953     xbt_dynar_push_as(d, int, cpt);
954
955   for (cpt = 2000; cpt < 4000; cpt++) {
956     xbt_dynar_remove_at(d, 2000, &i);
957     xbt_test_assert(i == cpt,
958                      "Remove a bad value. Got %d, expected %d", i, cpt);
959     XBT_DEBUG("remove %d, length=%lu", cpt, xbt_dynar_length(d));
960   }
961   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
962   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
963   /* in your code is naturally the way to go outside a regression test */
964 }
965
966 /*******************************************************************************/
967 /*******************************************************************************/
968 /*******************************************************************************/
969 XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dynar_remove functions")
970 {
971   xbt_dynar_t d = xbt_dynar_new(sizeof(unsigned int), NULL);
972   unsigned int cursor;
973   int cpt;
974
975   xbt_test_add("==== Insert %d int, traverse them, remove them",NB_ELEM);
976   /* Populate_ints [doxygen cruft] */
977   /* 1. Populate the dynar */
978   for (cpt = 0; cpt < NB_ELEM; cpt++) {
979     xbt_dynar_insert_at(d, cpt, &cpt);
980     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
981   }
982
983   /* 3. Traverse the dynar */
984   xbt_dynar_foreach(d, cursor, cpt) {
985     xbt_test_assert(cursor == cpt,
986                      "The retrieved value is not the same than the injected one (%d!=%d)",
987                      cursor, cpt);
988   }
989   /* end_of_traversal */
990
991   /* Re-fill with the same values using set_as (and re-verify) */
992   for (cpt = 0; cpt < NB_ELEM; cpt++)
993     xbt_dynar_set_as(d, cpt, int, cpt);
994   xbt_dynar_foreach(d, cursor, cpt)
995     xbt_test_assert(cursor == cpt,
996                      "The retrieved value is not the same than the injected one (%d!=%d)",
997                      cursor, cpt);
998
999   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1000     int val;
1001     xbt_dynar_remove_at(d,0,&val);
1002     xbt_test_assert(cpt == val,
1003                      "The retrieved value is not the same than the injected one (%d!=%d)",
1004                      cursor, cpt);
1005   }
1006   xbt_test_assert(xbt_dynar_length(d) == 0,
1007                    "There is still %lu elements in the dynar after removing everything",
1008                    xbt_dynar_length(d));
1009   xbt_dynar_free(&d);
1010
1011   /* ********************* */
1012   xbt_test_add("==== Insert %d int in reverse order, traverse them, remove them",NB_ELEM);
1013   d = xbt_dynar_new(sizeof(int), NULL);
1014   for (cpt = NB_ELEM-1; cpt >=0; cpt--) {
1015     xbt_dynar_replace(d, cpt, &cpt);
1016     xbt_test_log("Push %d, length=%lu", cpt, xbt_dynar_length(d));
1017   }
1018
1019   /* 3. Traverse the dynar */
1020   xbt_dynar_foreach(d, cursor, cpt) {
1021     xbt_test_assert(cursor == cpt,
1022                      "The retrieved value is not the same than the injected one (%d!=%d)",
1023                      cursor, cpt);
1024   }
1025   /* end_of_traversal */
1026
1027   for (cpt =NB_ELEM-1; cpt >=0; cpt--) {
1028     int val;
1029     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
1030     xbt_test_assert(cpt == val,
1031                      "The retrieved value is not the same than the injected one (%d!=%d)",
1032                      cursor, cpt);
1033   }
1034   xbt_test_assert(xbt_dynar_length(d) == 0,
1035                    "There is still %lu elements in the dynar after removing everything",
1036                    xbt_dynar_length(d));
1037   xbt_dynar_free(&d);
1038 }
1039
1040 /*******************************************************************************/
1041 /*******************************************************************************/
1042 /*******************************************************************************/
1043 XBT_TEST_UNIT("double", test_dynar_double, "Dynars of doubles")
1044 {
1045   xbt_dynar_t d;
1046   int cpt;
1047   unsigned int cursor;
1048   double d1, d2;
1049
1050   xbt_test_add("==== Traverse the empty dynar");
1051   d = xbt_dynar_new(sizeof(int), NULL);
1052   xbt_dynar_foreach(d, cursor, cpt) {
1053     xbt_test_assert(FALSE,
1054                      "Damnit, there is something in the empty dynar");
1055   }
1056   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1057   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1058   /* in your code is naturally the way to go outside a regression test */
1059
1060   xbt_test_add("==== Push/shift 5000 doubles");
1061   d = xbt_dynar_new(sizeof(double), NULL);
1062   for (cpt = 0; cpt < 5000; cpt++) {
1063     d1 = (double) cpt;
1064     xbt_dynar_push(d, &d1);
1065   }
1066   xbt_dynar_foreach(d, cursor, d2) {
1067     d1 = (double) cursor;
1068     xbt_test_assert(d1 == d2,
1069                      "The retrieved value is not the same than the injected one (%f!=%f)",
1070                      d1, d2);
1071   }
1072   for (cpt = 0; cpt < 5000; cpt++) {
1073     d1 = (double) cpt;
1074     xbt_dynar_shift(d, &d2);
1075     xbt_test_assert(d1 == d2,
1076                      "The retrieved value is not the same than the injected one (%f!=%f)",
1077                      d1, d2);
1078   }
1079   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1080   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1081   /* in your code is naturally the way to go outside a regression test */
1082
1083   xbt_test_add("==== Unshift/pop 5000 doubles");
1084   d = xbt_dynar_new(sizeof(double), NULL);
1085   for (cpt = 0; cpt < 5000; cpt++) {
1086     d1 = (double) cpt;
1087     xbt_dynar_unshift(d, &d1);
1088   }
1089   for (cpt = 0; cpt < 5000; cpt++) {
1090     d1 = (double) cpt;
1091     xbt_dynar_pop(d, &d2);
1092     xbt_test_assert(d1 == d2,
1093                      "The retrieved value is not the same than the injected one (%f!=%f)",
1094                      d1, d2);
1095   }
1096   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1097   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1098   /* in your code is naturally the way to go outside a regression test */
1099
1100
1101
1102   xbt_test_add
1103       ("==== Push 5000 doubles, insert 1000 doubles in the middle, shift everything");
1104   d = xbt_dynar_new(sizeof(double), NULL);
1105   for (cpt = 0; cpt < 5000; cpt++) {
1106     d1 = (double) cpt;
1107     xbt_dynar_push(d, &d1);
1108   }
1109   for (cpt = 0; cpt < 1000; cpt++) {
1110     d1 = (double) cpt;
1111     xbt_dynar_insert_at(d, 2500, &d1);
1112   }
1113
1114   for (cpt = 0; cpt < 2500; cpt++) {
1115     d1 = (double) cpt;
1116     xbt_dynar_shift(d, &d2);
1117     xbt_test_assert(d1 == d2,
1118                      "The retrieved value is not the same than the injected one at the begining (%f!=%f)",
1119                      d1, d2);
1120     XBT_DEBUG("Pop %d, length=%lu", cpt, xbt_dynar_length(d));
1121   }
1122   for (cpt = 999; cpt >= 0; cpt--) {
1123     d1 = (double) cpt;
1124     xbt_dynar_shift(d, &d2);
1125     xbt_test_assert(d1 == d2,
1126                      "The retrieved value is not the same than the injected one in the middle (%f!=%f)",
1127                      d1, d2);
1128   }
1129   for (cpt = 2500; cpt < 5000; cpt++) {
1130     d1 = (double) cpt;
1131     xbt_dynar_shift(d, &d2);
1132     xbt_test_assert(d1 == d2,
1133                      "The retrieved value is not the same than the injected one at the end (%f!=%f)",
1134                      d1, d2);
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
1141   xbt_test_add("==== Push 5000 double, remove 2000-4000. free the rest");
1142   d = xbt_dynar_new(sizeof(double), NULL);
1143   for (cpt = 0; cpt < 5000; cpt++) {
1144     d1 = (double) cpt;
1145     xbt_dynar_push(d, &d1);
1146   }
1147   for (cpt = 2000; cpt < 4000; cpt++) {
1148     d1 = (double) cpt;
1149     xbt_dynar_remove_at(d, 2000, &d2);
1150     xbt_test_assert(d1 == d2,
1151                      "Remove a bad value. Got %f, expected %f", d2, d1);
1152   }
1153   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1154   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1155   /* in your code is naturally the way to go outside a regression test */
1156 }
1157
1158
1159 /* doxygen_string_cruft */
1160
1161 /*******************************************************************************/
1162 /*******************************************************************************/
1163 /*******************************************************************************/
1164 XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
1165 {
1166   xbt_dynar_t d;
1167   int cpt;
1168   unsigned int iter;
1169   char buf[1024];
1170   char *s1, *s2;
1171
1172   xbt_test_add("==== Traverse the empty dynar");
1173   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1174   xbt_dynar_foreach(d, iter, s1) {
1175     xbt_test_assert(FALSE,
1176                      "Damnit, there is something in the empty dynar");
1177   }
1178   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1179   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1180   /* in your code is naturally the way to go outside a regression test */
1181
1182   xbt_test_add("==== Push %d strings, set them again 3 times, shift them",
1183                 NB_ELEM);
1184   /* Populate_str [doxygen cruft] */
1185   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1186   /* 1. Populate the dynar */
1187   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1188     sprintf(buf, "%d", cpt);
1189     s1 = strdup(buf);
1190     xbt_dynar_push(d, &s1);
1191   }
1192   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1193     sprintf(buf, "%d", cpt);
1194     s1 = strdup(buf);
1195     xbt_dynar_replace(d, cpt, &s1);
1196   }
1197   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1198     sprintf(buf, "%d", cpt);
1199     s1 = strdup(buf);
1200     xbt_dynar_replace(d, cpt, &s1);
1201   }
1202   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1203     sprintf(buf, "%d", cpt);
1204     s1 = strdup(buf);
1205     xbt_dynar_replace(d, cpt, &s1);
1206   }
1207   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1208     sprintf(buf, "%d", cpt);
1209     xbt_dynar_shift(d, &s2);
1210     xbt_test_assert(!strcmp(buf, s2),
1211                      "The retrieved value is not the same than the injected one (%s!=%s)",
1212                      buf, s2);
1213     free(s2);
1214   }
1215   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1216   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1217   /* in your code is naturally the way to go outside a regression test */
1218
1219   xbt_test_add("==== Unshift, traverse and pop %d strings", NB_ELEM);
1220   d = xbt_dynar_new(sizeof(char **), &xbt_free_ref);
1221   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1222     sprintf(buf, "%d", cpt);
1223     s1 = strdup(buf);
1224     xbt_dynar_unshift(d, &s1);
1225   }
1226   /* 2. Traverse the dynar with the macro */
1227   xbt_dynar_foreach(d, iter, s1) {
1228     sprintf(buf, "%d", NB_ELEM - iter - 1);
1229     xbt_test_assert(!strcmp(buf, s1),
1230                      "The retrieved value is not the same than the injected one (%s!=%s)",
1231                      buf, s1);
1232   }
1233   /* 3. Traverse the dynar with the macro */
1234   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1235     sprintf(buf, "%d", cpt);
1236     xbt_dynar_pop(d, &s2);
1237     xbt_test_assert(!strcmp(buf, s2),
1238                      "The retrieved value is not the same than the injected one (%s!=%s)",
1239                      buf, s2);
1240     free(s2);
1241   }
1242   /* 4. Free the resources */
1243   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1244   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1245   /* in your code is naturally the way to go outside a regression test */
1246
1247
1248   xbt_test_add
1249       ("==== Push %d strings, insert %d strings in the middle, shift everything",
1250        NB_ELEM, NB_ELEM / 5);
1251   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1252   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1253     sprintf(buf, "%d", cpt);
1254     s1 = strdup(buf);
1255     xbt_dynar_push(d, &s1);
1256   }
1257   for (cpt = 0; cpt < NB_ELEM / 5; cpt++) {
1258     sprintf(buf, "%d", cpt);
1259     s1 = strdup(buf);
1260     xbt_dynar_insert_at(d, NB_ELEM / 2, &s1);
1261   }
1262
1263   for (cpt = 0; cpt < NB_ELEM / 2; cpt++) {
1264     sprintf(buf, "%d", cpt);
1265     xbt_dynar_shift(d, &s2);
1266     xbt_test_assert(!strcmp(buf, s2),
1267                      "The retrieved value is not the same than the injected one at the begining (%s!=%s)",
1268                      buf, s2);
1269     free(s2);
1270   }
1271   for (cpt = (NB_ELEM / 5) - 1; cpt >= 0; cpt--) {
1272     sprintf(buf, "%d", cpt);
1273     xbt_dynar_shift(d, &s2);
1274     xbt_test_assert(!strcmp(buf, s2),
1275                      "The retrieved value is not the same than the injected one in the middle (%s!=%s)",
1276                      buf, s2);
1277     free(s2);
1278   }
1279   for (cpt = NB_ELEM / 2; cpt < NB_ELEM; cpt++) {
1280     sprintf(buf, "%d", cpt);
1281     xbt_dynar_shift(d, &s2);
1282     xbt_test_assert(!strcmp(buf, s2),
1283                      "The retrieved value is not the same than the injected one at the end (%s!=%s)",
1284                      buf, s2);
1285     free(s2);
1286   }
1287   xbt_dynar_free(&d);           /* This code is used both as example and as regression test, so we try to */
1288   xbt_dynar_free(&d);           /* free the struct twice here to check that it's ok, but freeing  it only once */
1289   /* in your code is naturally the way to go outside a regression test */
1290
1291
1292   xbt_test_add("==== Push %d strings, remove %d-%d. free the rest",
1293                 NB_ELEM, 2 * (NB_ELEM / 5), 4 * (NB_ELEM / 5));
1294   d = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
1295   for (cpt = 0; cpt < NB_ELEM; cpt++) {
1296     sprintf(buf, "%d", cpt);
1297     s1 = strdup(buf);
1298     xbt_dynar_push(d, &s1);
1299   }
1300   for (cpt = 2 * (NB_ELEM / 5); cpt < 4 * (NB_ELEM / 5); cpt++) {
1301     sprintf(buf, "%d", cpt);
1302     xbt_dynar_remove_at(d, 2 * (NB_ELEM / 5), &s2);
1303     xbt_test_assert(!strcmp(buf, s2),
1304                      "Remove a bad value. Got %s, expected %s", s2, buf);
1305     free(s2);
1306   }
1307   xbt_dynar_free(&d);           /* end_of_doxygen */
1308 }
1309
1310
1311 /*******************************************************************************/
1312 /*******************************************************************************/
1313 /*******************************************************************************/
1314 #include "xbt/synchro.h"
1315 static void pusher_f(void *a)
1316 {
1317   xbt_dynar_t d = (xbt_dynar_t) a;
1318   int i;
1319   for (i = 0; i < 500; i++) {
1320     xbt_dynar_push(d, &i);
1321   }
1322 }
1323
1324 static void poper_f(void *a)
1325 {
1326   xbt_dynar_t d = (xbt_dynar_t) a;
1327   int i;
1328   int data;
1329   xbt_ex_t e;
1330
1331   for (i = 0; i < 500; i++) {
1332     TRY {
1333       xbt_dynar_pop(d, &data);
1334     }
1335     CATCH(e) {
1336       if (e.category == bound_error) {
1337         xbt_ex_free(e);
1338         i--;
1339       } else {
1340         RETHROW;
1341       }
1342     }
1343   }
1344 }
1345
1346
1347 XBT_TEST_UNIT("synchronized int", test_dynar_sync_int, "Synchronized dynars of integers")
1348 {
1349   /* Vars_decl [doxygen cruft] */
1350   xbt_dynar_t d;
1351   xbt_thread_t pusher, poper;
1352
1353   xbt_test_add("==== Have a pusher and a popper on the dynar");
1354   d = xbt_dynar_new_sync(sizeof(int), NULL);
1355   pusher = xbt_thread_create("pusher", pusher_f, d, 0 /*not joinable */ );
1356   poper = xbt_thread_create("poper", poper_f, d, 0 /*not joinable */ );
1357   xbt_thread_join(pusher);
1358   xbt_thread_join(poper);
1359   xbt_dynar_free(&d);
1360 }
1361
1362 #endif                          /* SIMGRID_TEST */