[GNUnet-SVN] r36119 - gnunet/src/rps

[gnunet]

Author: ch3
Date: 2015-07-23 20:21:45 +0200 (Thu, 23 Jul 2015)
New Revision: 36119

Added:
   gnunet/src/rps/gnunet-service-rps_sampler_elem.c
   gnunet/src/rps/gnunet-service-rps_sampler_elem.h
Modified:
   gnunet/src/rps/Makefile.am
   gnunet/src/rps/gnunet-service-rps_sampler.c
Log:
-split up sampler and sampler element

Modified: gnunet/src/rps/Makefile.am
===================================================================
--- gnunet/src/rps/Makefile.am  2015-07-22 17:02:15 UTC (rev 36118)
+++ gnunet/src/rps/Makefile.am  2015-07-23 18:21:45 UTC (rev 36119)
@@ -48,6 +48,7 @@
 
 gnunet_service_rps_SOURCES = \
  gnunet-service-rps_sampler.h gnunet-service-rps_sampler.c \
+ gnunet-service-rps_sampler_elem.h gnunet-service-rps_sampler_elem.c \
  rps-test_util.h rps-test_util.c \
  gnunet-service-rps.c
 

Modified: gnunet/src/rps/gnunet-service-rps_sampler.c
===================================================================
--- gnunet/src/rps/gnunet-service-rps_sampler.c 2015-07-22 17:02:15 UTC (rev 
36118)
+++ gnunet/src/rps/gnunet-service-rps_sampler.c 2015-07-23 18:21:45 UTC (rev 
36119)
@@ -28,6 +28,7 @@
 #include "rps.h"
 
 #include "gnunet-service-rps_sampler.h"
+#include "gnunet-service-rps_sampler_elem.h"
 
 #include <math.h>
 #include <inttypes.h>
@@ -52,69 +53,7 @@
 
 // TODO care about invalid input of the caller (size 0 or less...)
 
-enum RPS_SamplerEmpty
-{
-  NOT_EMPTY = 0x0,
-      EMPTY = 0x1
-};
-
 /**
- * A sampler element sampling one PeerID at a time.
- */
-struct RPS_SamplerElement
-{
-  /**
-   * Min-wise linear permutation used by this sampler.
-   *
-   * This is an key later used by a hmac.
-   */
-  struct GNUNET_CRYPTO_AuthKey auth_key;
-
-  /**
-   * The PeerID this sampler currently samples.
-   */
-  struct GNUNET_PeerIdentity peer_id;
-
-  /**
-   * The according hash value of this PeerID.
-   */
-  struct GNUNET_HashCode peer_id_hash;
-
-
-  /**
-   * Time of last request.
-   */
-  struct GNUNET_TIME_Absolute last_client_request;
-
-  /**
-   * Flag that indicates that we are not holding a valid PeerID right now.
-   */
-  enum RPS_SamplerEmpty is_empty;
-
-  /**
-   * 'Birth'
-   */
-  struct GNUNET_TIME_Absolute birth;
-
-  /**
-   * How many times a PeerID was put in this sampler.
-   */
-  uint32_t num_peers;
-
-  /**
-   * How many times this sampler changed the peer_id.
-   */
-  uint32_t num_change;
-
-  /**
-   * The file name this sampler element should log to
-   */
-  #ifdef TO_FILE
-  char *file_name;
-  #endif /* TO_FILE */
-};
-
-/**
  * Callback that is called from _get_rand_peer() when the PeerID is ready.
  *
  * @param cls the closure given alongside this function.
@@ -214,25 +153,6 @@
   struct RPS_SamplerElement **sampler_elements;
 
   /**
-   * Number of sampler elements trash can holds.
-   */
-  unsigned int trash_can_size;
-
-  /**
-   * Trash can for old sampler elements.
-   * We need this to evaluate the sampler.
-   * TODO remove after evaluation
-   *      and undo changes in
-   *      sampler_resize
-   *      sampler_empty
-   *      sampler_init
-   *      sampler_remove?
-   *      sampler_reinitialise_by_value
-   *      sampler_update
-   */
-  struct RPS_SamplerElement **trash_can;
-
-  /**
    * Maximum time a round takes
    *
    * Used in the context of RPS
@@ -353,129 +273,6 @@
 
 
 /**
- * Reinitialise a previously initialised sampler element.
- *
- * @param sampler pointer to the memory that keeps the value.
- */
-  static void
-RPS_sampler_elem_reinit (struct RPS_SamplerElement *sampler_el)
-{
-  sampler_el->is_empty = EMPTY;
-
-  // I guess I don't need to call GNUNET_CRYPTO_hmac_derive_key()...
-  GNUNET_CRYPTO_random_block(GNUNET_CRYPTO_QUALITY_STRONG,
-                             &(sampler_el->auth_key.key),
-                             GNUNET_CRYPTO_HASH_LENGTH);
-
-  #ifdef TO_FILE
-  /* Create a file(-name) to store internals to */
-  char *name_buf;
-  name_buf = auth_key_to_string (sampler_el->auth_key);
-
-  sampler_el->file_name = create_file (name_buf);
-  GNUNET_free (name_buf);
-  #endif /* TO_FILE */
-
-  sampler_el->last_client_request = GNUNET_TIME_UNIT_FOREVER_ABS;
-
-  sampler_el->birth = GNUNET_TIME_absolute_get ();
-  sampler_el->num_peers = 0;
-  sampler_el->num_change = 0;
-}
-
-
-/**
- * (Re)Initialise given Sampler with random min-wise independent function.
- *
- * In this implementation this means choosing an auth_key for later use in
- * a hmac at random.
- *
- * @return a newly created RPS_SamplerElement which currently holds no id.
- */
-  struct RPS_SamplerElement *
-RPS_sampler_elem_create (void)
-{
-  struct RPS_SamplerElement *s;
-
-  s = GNUNET_new (struct RPS_SamplerElement);
-
-  RPS_sampler_elem_reinit (s);
-
-  return s;
-}
-
-
-/**
- * Input an PeerID into the given sampler element.
- *
- * @param sampler the sampler the @a s_elem belongs to.
- *                Needed to know the
- */
-static void
-RPS_sampler_elem_next (struct RPS_SamplerElement *s_elem,
-                       struct RPS_Sampler *sampler, /* TODO remove? */
-                       const struct GNUNET_PeerIdentity *other)
-{
-  struct GNUNET_HashCode other_hash;
-
-  s_elem->num_peers++;
-
-  to_file (s_elem->file_name,
-           "Got id %s",
-           GNUNET_i2s_full (other));
-
-  if (0 == GNUNET_CRYPTO_cmp_peer_identity (other, &(s_elem->peer_id)))
-  {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "         Got PeerID %s\n",
-        GNUNET_i2s (other));
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Have already PeerID %s\n",
-        GNUNET_i2s (&(s_elem->peer_id)));
-  }
-  else
-  {
-    GNUNET_CRYPTO_hmac(&s_elem->auth_key,
-        other,
-        sizeof(struct GNUNET_PeerIdentity),
-        &other_hash);
-
-    if (EMPTY == s_elem->is_empty)
-    {
-      LOG (GNUNET_ERROR_TYPE_DEBUG,
-           "Got PeerID %s; Simply accepting (was empty previously).\n",
-           GNUNET_i2s(other));
-      s_elem->peer_id = *other;
-      s_elem->peer_id_hash = other_hash;
-
-      s_elem->num_change++;
-    }
-    else if (0 > GNUNET_CRYPTO_hash_cmp (&other_hash, &s_elem->peer_id_hash))
-    {
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "           Got PeerID %s\n",
-          GNUNET_i2s (other));
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "Discarding old PeerID %s\n",
-          GNUNET_i2s (&s_elem->peer_id));
-      s_elem->peer_id = *other;
-      s_elem->peer_id_hash = other_hash;
-
-      s_elem->num_change++;
-    }
-    else
-    {
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "        Got PeerID %s\n",
-          GNUNET_i2s (other));
-      LOG (GNUNET_ERROR_TYPE_DEBUG, "Keeping old PeerID %s\n",
-          GNUNET_i2s (&s_elem->peer_id));
-    }
-  }
-  s_elem->is_empty = NOT_EMPTY;
-
-  to_file (s_elem->file_name,
-           "Now holding %s",
-           GNUNET_i2s_full (&s_elem->peer_id));
-}
-
-
-/**
  * Get the size of the sampler.
  *
  * @param sampler the sampler to return the size of.
@@ -517,10 +314,6 @@
          old_size,
          new_size);
 
-    /* TODO Temporary store those to properly call the removeCB on those 
later? */
-    GNUNET_array_grow (sampler->trash_can,
-                       sampler->trash_can_size,
-                       old_size - new_size);
     for (i = new_size ; i < old_size ; i++)
     {
       to_file (sampler->file_name,
@@ -527,9 +320,6 @@
                "-%" PRIu32 ": %s",
                i,
                sampler->sampler_elements[i]->file_name);
-      to_file (sampler->sampler_elements[i]->file_name,
-               "--- non-active");
-      sampler->trash_can[i - new_size] = sampler->sampler_elements[i];
     }
 
     GNUNET_array_grow (sampler->sampler_elements,
@@ -632,8 +422,6 @@
 
   sampler->sampler_size = 0;
   sampler->sampler_elements = NULL;
-  sampler->trash_can_size = 0;
-  sampler->trash_can = NULL;
   sampler->max_round_interval = max_round_interval;
   sampler->get_peers = sampler_get_rand_peer;
   sampler->gpc_head = NULL;
@@ -693,16 +481,9 @@
   for (i = 0 ; i < sampler->sampler_size ; i++)
   {
     RPS_sampler_elem_next (sampler->sampler_elements[i],
-                           sampler,
                            id);
   }
 
-  for (i = 0 ; i < sampler->trash_can_size ; i++)
-  {
-    RPS_sampler_elem_next (sampler->trash_can[i],
-                           sampler,
-                           id);
-  }
 }
 
 
@@ -728,9 +509,6 @@
       LOG (GNUNET_ERROR_TYPE_DEBUG, "Reinitialising sampler\n");
       trash_entry = GNUNET_new (struct RPS_SamplerElement);
       *trash_entry = *(sampler->sampler_elements[i]);
-      GNUNET_array_append (sampler->trash_can,
-                           sampler->trash_can_size,
-                           trash_entry);
       to_file (trash_entry->file_name,
                "--- non-active");
       RPS_sampler_elem_reinit (sampler->sampler_elements[i]);

Added: gnunet/src/rps/gnunet-service-rps_sampler_elem.c
===================================================================
--- gnunet/src/rps/gnunet-service-rps_sampler_elem.c                            
(rev 0)
+++ gnunet/src/rps/gnunet-service-rps_sampler_elem.c    2015-07-23 18:21:45 UTC 
(rev 36119)
@@ -0,0 +1,169 @@
+/*
+     This file is part of GNUnet.
+     Copyright (C)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
+*/
+
+/**
+ * @file rps/gnunet-service-rps_sampler.c
+ * @brief sampler implementation
+ * @author Julius Bünger
+ */
+#include "platform.h"
+#include "gnunet_util_lib.h"
+
+#include "gnunet-service-rps_sampler_elem.h"
+
+#include <inttypes.h>
+
+#include "rps-test_util.h"
+
+#define LOG(kind, ...) GNUNET_log_from(kind,"rps-sampler_elem",__VA_ARGS__)
+
+
+// TODO check for overflows
+
+/***********************************************************************
+ * WARNING: This section needs to be reviewed regarding the use of
+ * functions providing (pseudo)randomness!
+***********************************************************************/
+
+// TODO care about invalid input of the caller (size 0 or less...)
+
+
+/**
+ * Reinitialise a previously initialised sampler element.
+ *
+ * @param sampler pointer to the memory that keeps the value.
+ */
+void
+RPS_sampler_elem_reinit (struct RPS_SamplerElement *sampler_el)
+{
+  sampler_el->is_empty = EMPTY;
+
+  // I guess I don't need to call GNUNET_CRYPTO_hmac_derive_key()...
+  GNUNET_CRYPTO_random_block(GNUNET_CRYPTO_QUALITY_STRONG,
+                             &(sampler_el->auth_key.key),
+                             GNUNET_CRYPTO_HASH_LENGTH);
+
+  #ifdef TO_FILE
+  /* Create a file(-name) to store internals to */
+  char *name_buf;
+  name_buf = auth_key_to_string (sampler_el->auth_key);
+
+  sampler_el->file_name = create_file (name_buf);
+  GNUNET_free (name_buf);
+  #endif /* TO_FILE */
+
+  sampler_el->last_client_request = GNUNET_TIME_UNIT_FOREVER_ABS;
+
+  sampler_el->birth = GNUNET_TIME_absolute_get ();
+  sampler_el->num_peers = 0;
+  sampler_el->num_change = 0;
+}
+
+
+/**
+ * (Re)Initialise given Sampler with random min-wise independent function.
+ *
+ * In this implementation this means choosing an auth_key for later use in
+ * a hmac at random.
+ *
+ * @return a newly created RPS_SamplerElement which currently holds no id.
+ */
+struct RPS_SamplerElement *
+RPS_sampler_elem_create (void)
+{
+  struct RPS_SamplerElement *s;
+
+  s = GNUNET_new (struct RPS_SamplerElement);
+
+  RPS_sampler_elem_reinit (s);
+
+  return s;
+}
+
+
+/**
+ * Input an PeerID into the given sampler element.
+ *
+ * @param sampler the sampler the @a s_elem belongs to.
+ *                Needed to know the
+ */
+void
+RPS_sampler_elem_next (struct RPS_SamplerElement *s_elem,
+                       const struct GNUNET_PeerIdentity *other)
+{
+  struct GNUNET_HashCode other_hash;
+
+  s_elem->num_peers++;
+
+  to_file (s_elem->file_name,
+           "Got id %s",
+           GNUNET_i2s_full (other));
+
+  if (0 == GNUNET_CRYPTO_cmp_peer_identity (other, &(s_elem->peer_id)))
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG, "         Got PeerID %s\n",
+        GNUNET_i2s (other));
+    LOG (GNUNET_ERROR_TYPE_DEBUG, "Have already PeerID %s\n",
+        GNUNET_i2s (&(s_elem->peer_id)));
+  }
+  else
+  {
+    GNUNET_CRYPTO_hmac(&s_elem->auth_key,
+        other,
+        sizeof(struct GNUNET_PeerIdentity),
+        &other_hash);
+
+    if (EMPTY == s_elem->is_empty)
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Got PeerID %s; Simply accepting (was empty previously).\n",
+           GNUNET_i2s(other));
+      s_elem->peer_id = *other;
+      s_elem->peer_id_hash = other_hash;
+
+      s_elem->num_change++;
+    }
+    else if (0 > GNUNET_CRYPTO_hash_cmp (&other_hash, &s_elem->peer_id_hash))
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG, "           Got PeerID %s\n",
+          GNUNET_i2s (other));
+      LOG (GNUNET_ERROR_TYPE_DEBUG, "Discarding old PeerID %s\n",
+          GNUNET_i2s (&s_elem->peer_id));
+      s_elem->peer_id = *other;
+      s_elem->peer_id_hash = other_hash;
+
+      s_elem->num_change++;
+    }
+    else
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG, "        Got PeerID %s\n",
+          GNUNET_i2s (other));
+      LOG (GNUNET_ERROR_TYPE_DEBUG, "Keeping old PeerID %s\n",
+          GNUNET_i2s (&s_elem->peer_id));
+    }
+  }
+  s_elem->is_empty = NOT_EMPTY;
+
+  to_file (s_elem->file_name,
+           "Now holding %s",
+           GNUNET_i2s_full (&s_elem->peer_id));
+}
+
+/* end of gnunet-service-rps.c */

Added: gnunet/src/rps/gnunet-service-rps_sampler_elem.h
===================================================================
--- gnunet/src/rps/gnunet-service-rps_sampler_elem.h                            
(rev 0)
+++ gnunet/src/rps/gnunet-service-rps_sampler_elem.h    2015-07-23 18:21:45 UTC 
(rev 36119)
@@ -0,0 +1,134 @@
+/*
+     This file is part of GNUnet.
+     Copyright (C)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
+*/
+
+/**
+ * @file rps/gnunet-service-rps_sampler_elem.h
+ * @brief sampler element implementation
+ * @author Julius Bünger
+ */
+
+#ifndef RPS_SAMPLER_ELEM_H
+#define RPS_SAMPLER_ELEM_H
+#include <inttypes.h>
+
+
+/***********************************************************************
+ * WARNING: This section needs to be reviewed regarding the use of
+ * functions providing (pseudo)randomness!
+ ***********************************************************************/
+
+/**
+ * Used to indicate whether a sampler element is empty.
+ */
+enum RPS_SamplerEmpty
+{
+  NOT_EMPTY = 0x0,
+  EMPTY = 0x1
+};
+
+/**
+ * A sampler element sampling one PeerID at a time.
+ */
+struct RPS_SamplerElement
+{
+  /**
+   * Min-wise linear permutation used by this sampler.
+   *
+   * This is an key later used by a hmac.
+   */
+  struct GNUNET_CRYPTO_AuthKey auth_key;
+
+  /**
+   * The PeerID this sampler currently samples.
+   */
+  struct GNUNET_PeerIdentity peer_id;
+
+  /**
+   * The according hash value of this PeerID.
+   */
+  struct GNUNET_HashCode peer_id_hash;
+
+
+  /**
+   * Time of last request.
+   */
+  struct GNUNET_TIME_Absolute last_client_request;
+
+  /**
+   * Flag that indicates that we are not holding a valid PeerID right now.
+   */
+  enum RPS_SamplerEmpty is_empty;
+
+  /**
+   * 'Birth'
+   */
+  struct GNUNET_TIME_Absolute birth;
+
+  /**
+   * How many times a PeerID was put in this sampler.
+   */
+  uint32_t num_peers;
+
+  /**
+   * How many times this sampler changed the peer_id.
+   */
+  uint32_t num_change;
+
+  /**
+   * The file name this sampler element should log to
+   */
+  char *file_name;
+};
+
+
+/**
+ * Reinitialise a previously initialised sampler element.
+ *
+ * @param sampler pointer to the memory that keeps the value.
+ */
+void
+RPS_sampler_elem_reinit (struct RPS_SamplerElement *sampler_el);
+
+
+/**
+ * (Re)Initialise given Sampler with random min-wise independent function.
+ *
+ * In this implementation this means choosing an auth_key for later use in
+ * a hmac at random.
+ *
+ * @return a newly created RPS_SamplerElement which currently holds no id.
+ */
+struct RPS_SamplerElement *
+RPS_sampler_elem_create (void);
+
+
+/**
+ * Input an PeerID into the given sampler element.
+ *
+ * @param sampler the sampler the @a s_elem belongs to.
+ *                Needed to know the
+ */
+void
+RPS_sampler_elem_next (struct RPS_SamplerElement *s_elem,
+                       const struct GNUNET_PeerIdentity *new_ID);
+
+
+#endif /* RPS_SAMPLER_ELEM_H */
+/* end of gnunet-service-rps.c */