Logo AND Algorithmique Numérique Distribuée

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