Logo AND Algorithmique Numérique Distribuée

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