Logo AND Algorithmique Numérique Distribuée

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