Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
secure the stack size parameter for thread,
[simgrid.git] / src / xbt / dynar.c
index 7c3bcc6..21dd9c4 100644 (file)
@@ -6,7 +6,6 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "portable.h"           /* SIZEOF_MAX */
 #include "xbt/misc.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
@@ -75,9 +74,12 @@ static XBT_INLINE void _check_populated_dynar(xbt_dynar_t dynar)
 static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
 
 static XBT_INLINE
-    void _xbt_clear_mem(void *const ptr, const unsigned long length)
+void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
 {
-  memset(ptr, 0, length);
+  if (new_size != dynar->size) {
+    dynar->size = new_size;
+    dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
+  }
 }
 
 static XBT_INLINE
@@ -86,30 +88,10 @@ static XBT_INLINE
   const unsigned long old_size = dynar->size;
 
   if (nb > old_size) {
-    char *const old_data = (char *) dynar->data;
-
-    const unsigned long elmsize = dynar->elmsize;
-
-    const unsigned long used = dynar->used;
-    const unsigned long used_length = used * elmsize;
-
-    const unsigned long new_size =
-        nb > (2 * (old_size + 1)) ? nb : (2 * (old_size + 1));
-    const unsigned long new_length = new_size * elmsize;
-    char *const new_data = (char *) xbt_malloc0(elmsize * new_size);
-
-    XBT_DEBUG("expand %p from %lu to %lu elements", (void *) dynar,
-           (unsigned long) old_size, nb);
-
-    if (old_data) {
-      memcpy(new_data, old_data, used_length);
-      free(old_data);
-    }
-
-    _xbt_clear_mem(new_data + used_length, new_length - used_length);
-
-    dynar->size = new_size;
-    dynar->data = new_data;
+    const unsigned long expand = 2 * (old_size + 1);
+    _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
+    XBT_DEBUG("expand %p from %lu to %lu elements",
+              dynar, old_size, dynar->size);
   }
 }
 
@@ -158,16 +140,7 @@ _xbt_dynar_remove_at(xbt_dynar_t const dynar,
   if (object) {
     _xbt_dynar_get_elm(object, dynar, idx);
   } else if (dynar->free_f) {
-    if (dynar->elmsize <= SIZEOF_MAX) {
-      char elm[SIZEOF_MAX];
-      _xbt_dynar_get_elm(elm, dynar, idx);
-      (*dynar->free_f) (elm);
-    } else {
-      char *elm = malloc(dynar->elmsize);
-      _xbt_dynar_get_elm(elm, dynar, idx);
-      (*dynar->free_f) (elm);
-      free(elm);
-    }
+    dynar->free_f(_xbt_dynar_elm(dynar, idx));
   }
 
   nb_shift = dynar->used - 1 - idx;
@@ -237,18 +210,11 @@ xbt_dynar_new_sync(const unsigned long elmsize,
 void xbt_dynar_free_container(xbt_dynar_t * dynar)
 {
   if (dynar && *dynar) {
-
-    if ((*dynar)->data) {
-      _xbt_clear_mem((*dynar)->data, (*dynar)->size);
-      free((*dynar)->data);
-    }
-
-    if ((*dynar)->mutex)
-      xbt_mutex_destroy((*dynar)->mutex);
-
-    _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
-
-    free(*dynar);
+    xbt_dynar_t d = *dynar;
+    free(d->data);
+    if (d->mutex)
+      xbt_mutex_destroy(d->mutex);
+    free(d);
     *dynar = NULL;
   }
 }
@@ -267,17 +233,31 @@ XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
   if (dynar->free_f) {
     _dynar_map(dynar, dynar->free_f);
   }
-  /*
-     if (dynar->data)
-     free(dynar->data);
-
-     dynar->size = 0;
-   */
   dynar->used = 0;
 
   _dynar_unlock(dynar);
+}
+
+/** @brief Merge dynar d2 into d1
+ *
+ * \param d1 dynar to keep
+ * \param d2 dynar to merge into d1. This dynar is free at end.
+ */
+void xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2)
+{
+  if((*d1)->elmsize != (*d2)->elmsize)
+    xbt_die("Element size must are not equal");
+
+  const unsigned long elmsize = (*d1)->elmsize;
+
+  void *ptr = _xbt_dynar_elm((*d2), 0);
+  _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
+  void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
 
-  /*  dynar->data = NULL; */
+  memcpy(elm, ptr, ((*d2)->size)*elmsize);
+  (*d1)->used += (*d2)->used;
+  (*d2)->used = 0;
+  xbt_dynar_free(d2);
 }
 
 /**
@@ -297,15 +277,8 @@ XBT_INLINE void xbt_dynar_reset(xbt_dynar_t const dynar)
  */
 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
 {
-  unsigned long size_wanted;
-
   _dynar_lock(dynar);
-
-  size_wanted = dynar->used + empty_slots_wanted;
-  if (size_wanted != dynar->size) {
-    dynar->size = size_wanted;
-    dynar->data = xbt_realloc(dynar->data, dynar->elmsize * dynar->size);
-  }
+  _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
   _dynar_unlock(dynar);
 }
 
@@ -340,7 +313,7 @@ XBT_INLINE unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
   return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
 }
 
-/**@brief check if a dynar is empty
+ /**@brief check if a dynar is empty
  *
  *\param dynar the dynat we want to check
  */
@@ -391,26 +364,30 @@ XBT_INLINE void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
   return res;
 }
 
-XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
-                                      const unsigned long idx)
+/* not synchronized */
+static XBT_INLINE void *_xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
+                                              const unsigned long idx)
 {
-
-  void *res;
-  _dynar_lock(dynar);
   _sanity_check_dynar(dynar);
 
-  _xbt_dynar_expand(dynar, idx + 1);
-
   if (idx >= dynar->used) {
-    _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
-                   (idx + 1 - dynar->used)*dynar->elmsize);
+    _xbt_dynar_expand(dynar, idx + 1);
+    if (idx > dynar->used) {
+      memset(_xbt_dynar_elm(dynar, dynar->used), 0,
+             (idx - dynar->used) * dynar->elmsize);
+    }
     dynar->used = idx + 1;
   }
-  
-  _dynar_unlock(dynar);
-
-  res = _xbt_dynar_elm(dynar, idx);
+  return _xbt_dynar_elm(dynar, idx);
+}
 
+XBT_INLINE void *xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
+                                      const unsigned long idx)
+{
+  void *res;
+  _dynar_lock(dynar);
+  res = _xbt_dynar_set_at_ptr(dynar, idx);
+  _dynar_unlock(dynar);
   return res;
 }
 
@@ -418,18 +395,7 @@ static void XBT_INLINE          /* not synchronized */
 _xbt_dynar_set(xbt_dynar_t dynar,
                const unsigned long idx, const void *const src)
 {
-
-  _sanity_check_dynar(dynar);
-
-  _xbt_dynar_expand(dynar, idx + 1);
-
-  if (idx >= dynar->used) {
-    _xbt_clear_mem(((char * const)dynar->data) + dynar->used * dynar->elmsize,
-                   (idx + 1 - dynar->used)*dynar->elmsize);
-    dynar->used = idx + 1;
-  }
-
-  _xbt_dynar_put_elm(dynar, idx, src);
+  memcpy(_xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
 }
 
 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
@@ -469,7 +435,7 @@ xbt_dynar_replace(xbt_dynar_t dynar,
   if (idx < dynar->used && dynar->free_f) {
     void *const old_object = _xbt_dynar_elm(dynar, idx);
 
-    (*(dynar->free_f)) (old_object);
+    dynar->free_f(old_object);
   }
 
   _xbt_dynar_set(dynar, idx, object);
@@ -557,7 +523,9 @@ xbt_dynar_remove_at(xbt_dynar_t const dynar,
 
 /** @brief Returns the position of the element in the dynar
  *
- * Raises not_found_error if not found.
+ * Raises not_found_error if not found. If you have less than 2 millions elements,
+ * you probably want to use #xbt_dynar_search_or_negative() instead, so that you
+ * don't have to TRY/CATCH on element not found.
  */
 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
 {
@@ -575,6 +543,26 @@ unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void *const elem)
          dynar);
 }
 
+/** @brief Returns the position of the element in the dynar (or -1 if not found)
+ *
+ * Note that usually, the dynar indices are unsigned integers. If you have more
+ * than 2 million elements in your dynar, this very function will not work (but the other will).
+ */
+signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem)
+{
+  unsigned long it;
+
+  _dynar_lock(dynar);
+  for (it = 0; it < dynar->used; it++)
+    if (!memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
+      _dynar_unlock(dynar);
+      return it;
+    }
+
+  _dynar_unlock(dynar);
+  return -1;
+}
+
 /** @brief Returns a boolean indicating whether the element is part of the dynar */
 int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
 {
@@ -583,7 +571,8 @@ int xbt_dynar_member(xbt_dynar_t const dynar, void *const elem)
 
   TRY {
     xbt_dynar_search(dynar, elem);
-  } CATCH(e) {
+  }
+  CATCH(e) {
     if (e.category == not_found_error) {
       xbt_ex_free(e);
       return 0;
@@ -683,7 +672,7 @@ static void _dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
 
   for (i = 0; i < used; i++) {
     char* elm = (char*) data + i * elmsize;
-    (*op) (elm);
+    op(elm);
   }
 }
 
@@ -753,62 +742,110 @@ XBT_INLINE void xbt_dynar_sort(xbt_dynar_t dynar,
   _dynar_unlock(dynar);
 }
 
-/** @brief Transform a dynar into a NULL terminated array
+/** @brief Sorts a dynar according to their color assuming elements can have only three colors.
+ * Since there are only three colors, it is linear and much faster than a classical sort.
+ * See for example http://en.wikipedia.org/wiki/Dutch_national_flag_problem
  *
+ * \param dynar the dynar to sort
+ * \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.
+ *
+ * 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.
+ *
+ * Remark: if the elements stored in the dynar are structures, the color
+ * function has to retrieve the field to sort first.
+ */
+XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
+                                               int_f_pvoid_t color)
+{
+  _dynar_lock(dynar);
+  unsigned long int i;
+  unsigned long int p = -1;
+  unsigned long int q = dynar->used;
+  const unsigned long elmsize = dynar->elmsize;
+  void *tmp = xbt_malloc(elmsize);
+  void *elm;
+
+  for (i = 0; i < q;) {
+    void *elmi = _xbt_dynar_elm(dynar, i);
+    int colori = color(elmi);
+
+    if (colori == 1) {
+      ++i;
+    } else {
+      if (colori == 0) {
+        elm = _xbt_dynar_elm(dynar, ++p);
+        ++i;
+      } else {                  /* colori == 2 */
+        elm = _xbt_dynar_elm(dynar, --q);
+      }
+      if (elm != elmi) {
+        memcpy(tmp,  elm,  elmsize);
+        memcpy(elm,  elmi, elmsize);
+        memcpy(elmi, tmp,  elmsize);
+      }
+    }
+  }
+  _dynar_unlock(dynar);
+  xbt_free(tmp);
+}
+
+/** @brief Transform a dynar into a NULL terminated array. 
+ *  The dynar won't be usable afterwards.
  * \param dynar the dynar to transform
  */
 XBT_INLINE void * xbt_dynar_to_array (xbt_dynar_t dynar)
 {
-  void * res;
-       void * last = xbt_new0(char,dynar->elmsize);
-       xbt_dynar_push(dynar, last);
-       free(last);
-       res = dynar->data;
-       free(dynar);
-       return res;
+  void *res;
+  xbt_dynar_shrink(dynar, 1);
+  memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
+  res = dynar->data;
+  if (dynar->mutex)
+    xbt_mutex_destroy(dynar->mutex);
+  free(dynar);
+  return res;
 }
 
 /*
  * Return 0 if d1 and d2 are equal and 1 if not equal
  */
 XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
-                                       int(*compar)(const void *, const void *))
+          int(*compar)(const void *, const void *))
 {
-       int i ;
-       int size;
-       if((!d1) && (!d2)) return 0;
-       if((!d1) || (!d2))
-       {
-               XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
-               xbt_dynar_free(&d2);
-               return 1;
-       }
-       if((d1->elmsize)!=(d2->elmsize))
-       {
-               XBT_DEBUG("Size of elmsize d1=%ld d2=%ld",d1->elmsize,d2->elmsize);
-               xbt_dynar_free(&d2);
-               return 1; // xbt_die
-       }
-       if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
-       {
-               XBT_DEBUG("Size of dynar d1=%ld d2=%ld",xbt_dynar_length(d1),xbt_dynar_length(d2));
-               xbt_dynar_free(&d2);
-               return 1;
-       }
-
-       size = xbt_dynar_length(d1);
-       for(i=0;i<size;i++)
-       {
-               void *data1 = xbt_dynar_get_as(d1, i, void *);
-               void *data2 = xbt_dynar_get_as(d2, i, void *);
-               XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
-               if(compar(data1,data2)){
-                       xbt_dynar_free(&d2);
-                       return 1;
-               }
-       }
-       xbt_dynar_free(&d2);
-       return 0;
+  int i ;
+  int size;
+  if((!d1) && (!d2)) return 0;
+  if((!d1) || (!d2))
+  {
+    XBT_DEBUG("NULL dynar d1=%p d2=%p",d1,d2);
+    xbt_dynar_free(&d2);
+    return 1;
+  }
+  if((d1->elmsize)!=(d2->elmsize))
+  {
+    XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
+    xbt_dynar_free(&d2);
+    return 1; // xbt_die
+  }
+  if(xbt_dynar_length(d1) != xbt_dynar_length(d2))
+  {
+    XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
+    xbt_dynar_free(&d2);
+    return 1;
+  }
+
+  size = xbt_dynar_length(d1);
+  for(i=0;i<size;i++)
+  {
+    void *data1 = xbt_dynar_get_as(d1, i, void *);
+    void *data2 = xbt_dynar_get_as(d2, i, void *);
+    XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
+    if(compar(data1,data2)){
+      xbt_dynar_free(&d2);
+      return 1;
+    }
+  }
+  xbt_dynar_free(&d2);
+  return 0;
 }
 
 #ifdef SIMGRID_TEST
@@ -816,8 +853,7 @@ XBT_INLINE int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
 #define NB_ELEM 5000
 
 XBT_TEST_SUITE("dynar", "Dynar data container");
-XBT_LOG_EXTERNAL_CATEGORY(xbt_dyn);
-XBT_LOG_DEFAULT_CATEGORY(xbt_dyn);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dyn);
 
 XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
 {
@@ -852,14 +888,14 @@ XBT_TEST_UNIT("int", test_dynar_int, "Dynars of integers")
   for (cursor = 0; cursor < NB_ELEM; cursor++) {
     iptr = xbt_dynar_get_ptr(d, cursor);
     xbt_test_assert(cursor == *iptr,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
 
   /* 3. Traverse the dynar using the neat macro to that extend */
   xbt_dynar_foreach(d, cursor, cpt) {
     xbt_test_assert(cursor == cpt,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
   /* end_of_traversal */
@@ -991,7 +1027,7 @@ XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dyn
   /* 3. Traverse the dynar */
   xbt_dynar_foreach(d, cursor, cpt) {
     xbt_test_assert(cursor == cpt,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
   /* end_of_traversal */
@@ -1001,17 +1037,17 @@ XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dyn
     xbt_dynar_set_as(d, cpt, int, cpt);
   xbt_dynar_foreach(d, cursor, cpt)
     xbt_test_assert(cursor == cpt,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
 
   for (cpt = 0; cpt < NB_ELEM; cpt++) {
     int val;
     xbt_dynar_remove_at(d,0,&val);
     xbt_test_assert(cpt == val,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
-  xbt_test_assert(xbt_dynar_length(d) == 0,
+  xbt_test_assert(xbt_dynar_is_empty(d),
                    "There is still %lu elements in the dynar after removing everything",
                    xbt_dynar_length(d));
   xbt_dynar_free(&d);
@@ -1027,7 +1063,7 @@ XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dyn
   /* 3. Traverse the dynar */
   xbt_dynar_foreach(d, cursor, cpt) {
     xbt_test_assert(cursor == cpt,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
   /* end_of_traversal */
@@ -1036,10 +1072,10 @@ XBT_TEST_UNIT("insert",test_dynar_insert,"Using the xbt_dynar_insert and xbt_dyn
     int val;
     xbt_dynar_remove_at(d,xbt_dynar_length(d)-1,&val);
     xbt_test_assert(cpt == val,
-                     "The retrieved value is not the same than the injected one (%d!=%d)",
+                     "The retrieved value is not the same than the injected one (%u!=%d)",
                      cursor, cpt);
   }
-  xbt_test_assert(xbt_dynar_length(d) == 0,
+  xbt_test_assert(xbt_dynar_is_empty(d),
                    "There is still %lu elements in the dynar after removing everything",
                    xbt_dynar_length(d));
   xbt_dynar_free(&d);
@@ -1233,7 +1269,7 @@ XBT_TEST_UNIT("string", test_dynar_string, "Dynars of strings")
   }
   /* 2. Traverse the dynar with the macro */
   xbt_dynar_foreach(d, iter, s1) {
-    sprintf(buf, "%d", NB_ELEM - iter - 1);
+    sprintf(buf, "%u", NB_ELEM - iter - 1);
     xbt_test_assert(!strcmp(buf, s1),
                      "The retrieved value is not the same than the injected one (%s!=%s)",
                      buf, s1);
@@ -1332,7 +1368,7 @@ static void pusher_f(void *a)
 static void poper_f(void *a)
 {
   xbt_dynar_t d = (xbt_dynar_t) a;
-  int i;
+  volatile int i;
   int data;
   xbt_ex_t e;