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., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
#include "rps.h"
#include "gnunet-service-rps_sampler.h"
+#include "gnunet-service-rps_sampler_elem.h"
#include <math.h>
#include <inttypes.h>
// 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.
*
* DLL
*/
struct GetPeerCls *next;
-
- /**
- * DLL
- */
struct GetPeerCls *prev;
/**
- * The sampler this function operates on.
+ * The #RPS_SamplerRequestHandle this single request belongs to.
*/
- struct RPS_Sampler *sampler;
+ struct RPS_SamplerRequestHandle *req_handle;
/**
* The task for this function.
* Sampler.
*/
typedef void
-(*RPS_get_peers_type) (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc);
+(*RPS_get_peers_type) (void *cls);
/**
* Get one random peer out of the sampled peers.
* Only used internally
*/
static void
-sampler_get_rand_peer (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc);
+sampler_get_rand_peer (void *cls);
+
/**
* Get one random peer out of the sampled peers.
* corrsponding peer to the client.
*/
static void
-sampler_mod_get_rand_peer (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc);
+sampler_mod_get_rand_peer (void *cls);
/**
*/
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
*
RPS_get_peers_type get_peers;
/**
- * Head for the DLL to store the closures to pending requests.
- */
- struct GetPeerCls *gpc_head;
-
- /**
- * Tail for the DLL to store the closures to pending requests.
+ * Head and tail for the DLL to store the #RPS_SamplerRequestHandle
*/
- struct GetPeerCls *gpc_tail;
+ struct RPS_SamplerRequestHandle *req_handle_head;
+ struct RPS_SamplerRequestHandle *req_handle_tail;
#ifdef TO_FILE
/**
/**
* Closure to _get_n_rand_peers_ready_cb()
*/
-struct NRandPeersReadyCls
+struct RPS_SamplerRequestHandle
{
+ /**
+ * DLL
+ */
+ struct RPS_SamplerRequestHandle *next;
+ struct RPS_SamplerRequestHandle *prev;
+
/**
* Number of peers we are waiting for.
*/
*/
struct GNUNET_PeerIdentity *ids;
+ /**
+ * Head and tail for the DLL to store the tasks for single requests
+ */
+ struct GetPeerCls *gpc_head;
+ struct GetPeerCls *gpc_tail;
+
+ /**
+ * Sampler.
+ */
+ struct RPS_Sampler *sampler;
+
/**
* Callback to be called when all ids are available.
*/
check_n_peers_ready (void *cls,
const struct GNUNET_PeerIdentity *id)
{
- struct NRandPeersReadyCls *n_peers_cls = cls;
+ struct RPS_SamplerRequestHandle *req_handle = cls;
- n_peers_cls->cur_num_peers++;
+ req_handle->cur_num_peers++;
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Got %" PRIX32 ". of %" PRIX32 " peers\n",
- n_peers_cls->cur_num_peers, n_peers_cls->num_peers);
+ req_handle->cur_num_peers, req_handle->num_peers);
- if (n_peers_cls->num_peers == n_peers_cls->cur_num_peers)
+ if (req_handle->num_peers == req_handle->cur_num_peers)
{ /* All peers are ready -- return those to the client */
- GNUNET_assert (NULL != n_peers_cls->callback);
+ GNUNET_assert (NULL != req_handle->callback);
LOG (GNUNET_ERROR_TYPE_DEBUG,
"returning %" PRIX32 " peers to the client\n",
- n_peers_cls->num_peers);
- n_peers_cls->callback (n_peers_cls->cls, n_peers_cls->ids, n_peers_cls->num_peers);
+ req_handle->num_peers);
+ req_handle->callback (req_handle->cls, req_handle->ids, req_handle->num_peers);
- GNUNET_free (n_peers_cls);
+ RPS_sampler_request_cancel (req_handle);
}
}
-/**
- * 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.
*
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,
"-%" 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_free (sampler->sampler_elements[i]);
}
GNUNET_array_grow (sampler->sampler_elements,
sampler_empty (struct RPS_Sampler *sampler)
{
sampler_resize (sampler, 0);
- GNUNET_array_grow (sampler->trash_can,
- sampler->trash_can_size,
- 0);
}
sampler->file_name);
#endif /* TO_FILE */
- 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;
- sampler->gpc_tail = NULL;
//sampler->sampler_elements = GNUNET_new_array(init_size, struct GNUNET_PeerIdentity);
//GNUNET_array_grow (sampler->sampler_elements, sampler->sampler_size, min_size);
RPS_sampler_resize (sampler, init_size);
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);
- }
}
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]);
* Only used internally
*/
static void
-sampler_get_rand_peer (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+sampler_get_rand_peer (void *cls)
{
struct GetPeerCls *gpc = cls;
uint32_t r_index;
+ struct RPS_Sampler *sampler;
gpc->get_peer_task = NULL;
- if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
- return;
+ sampler = gpc->req_handle->sampler;
/**;
* Choose the r_index of the peer we want to return
* at random from the interval of the gossip list
*/
r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
- gpc->sampler->sampler_size);
+ sampler->sampler_size);
- if (EMPTY == gpc->sampler->sampler_elements[r_index]->is_empty)
+ if (EMPTY == sampler->sampler_elements[r_index]->is_empty)
{
//LOG (GNUNET_ERROR_TYPE_DEBUG,
// "Not returning randomly selected, empty PeerID. - Rescheduling.\n");
* Counter?
*/
gpc->get_peer_task =
- GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (
- GNUNET_TIME_UNIT_SECONDS, 0.1),
- &sampler_get_rand_peer,
- cls);
+ GNUNET_SCHEDULER_add_delayed (
+ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1),
+ &sampler_get_rand_peer,
+ cls);
return;
}
- *gpc->id = gpc->sampler->sampler_elements[r_index]->peer_id;
-
- gpc->cont (gpc->cont_cls, gpc->id);
-
- GNUNET_CONTAINER_DLL_remove (gpc->sampler->gpc_head,
- gpc->sampler->gpc_tail,
+ GNUNET_CONTAINER_DLL_remove (gpc->req_handle->gpc_head,
+ gpc->req_handle->gpc_tail,
gpc);
+ *gpc->id = sampler->sampler_elements[r_index]->peer_id;
+ gpc->cont (gpc->cont_cls, gpc->id);
GNUNET_free (gpc);
}
* corrsponding peer to the client.
*/
static void
-sampler_mod_get_rand_peer (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+sampler_mod_get_rand_peer (void *cls)
{
struct GetPeerCls *gpc = cls;
- struct GNUNET_PeerIdentity tmp_id;
- unsigned int empty_flag;
struct RPS_SamplerElement *s_elem;
struct GNUNET_TIME_Relative last_request_diff;
- uint32_t tmp_client_get_index;
+ struct RPS_Sampler *sampler;
gpc->get_peer_task = NULL;
- if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
- return;
+ sampler = gpc->req_handle->sampler;
LOG (GNUNET_ERROR_TYPE_DEBUG, "Single peer was requested\n");
+ /* Cycle the #client_get_index one step further */
+ client_get_index = (client_get_index + 1) % sampler->sampler_size;
- /* Store the next #client_get_index to check whether we cycled over the whole list */
- if (0 < client_get_index)
- tmp_client_get_index = client_get_index - 1;
- else
- tmp_client_get_index = gpc->sampler->sampler_size - 1;
-
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "sched for later if index reaches %" PRIX32 " (sampler size: %" PRIX32 ").\n",
- tmp_client_get_index, gpc->sampler->sampler_size);
-
- do
- { /* Get first non empty sampler */
- if (tmp_client_get_index == client_get_index)
- { /* We once cycled over the whole list */
- LOG (GNUNET_ERROR_TYPE_DEBUG, "reached tmp_index %" PRIX32 ".\n",
- client_get_index);
- GNUNET_assert (NULL == gpc->get_peer_task);
- gpc->get_peer_task =
- GNUNET_SCHEDULER_add_delayed (gpc->sampler->max_round_interval,
- &sampler_mod_get_rand_peer,
- cls);
- return;
- }
-
- tmp_id = gpc->sampler->sampler_elements[client_get_index]->peer_id;
- empty_flag = gpc->sampler->sampler_elements[client_get_index]->is_empty;
- RPS_sampler_elem_reinit (gpc->sampler->sampler_elements[client_get_index]);
- if (EMPTY != empty_flag)
- RPS_sampler_elem_next (gpc->sampler->sampler_elements[client_get_index],
- gpc->sampler,
- &tmp_id);
-
- /* Cycle the #client_get_index one step further */
- if ( client_get_index == gpc->sampler->sampler_size - 1 )
- client_get_index = 0;
- else
- client_get_index++;
-
- LOG (GNUNET_ERROR_TYPE_DEBUG, "incremented index to %" PRIX32 ".\n",
- client_get_index);
- } while (EMPTY == gpc->sampler->sampler_elements[client_get_index]->is_empty);
-
- s_elem = gpc->sampler->sampler_elements[client_get_index];
+ s_elem = sampler->sampler_elements[client_get_index];
*gpc->id = s_elem->peer_id;
+ GNUNET_assert (NULL != s_elem);
+
+ if (EMPTY == s_elem->is_empty)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Sampler_mod element empty, rescheduling.\n");
+ GNUNET_assert (NULL == gpc->get_peer_task);
+ gpc->get_peer_task =
+ GNUNET_SCHEDULER_add_delayed (sampler->max_round_interval,
+ &sampler_mod_get_rand_peer,
+ cls);
+ return;
+ }
/* Check whether we may use this sampler to give it back to the client */
if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us != s_elem->last_client_request.abs_value_us)
GNUNET_TIME_absolute_get ());
/* We're not going to give it back now if it was
* already requested by a client this round */
- if (last_request_diff.rel_value_us < gpc->sampler->max_round_interval.rel_value_us)
+ if (last_request_diff.rel_value_us < sampler->max_round_interval.rel_value_us)
{
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Last client request on this sampler was less than max round interval ago -- scheduling for later\n");
/* Schedule it one round later */
GNUNET_assert (NULL == gpc->get_peer_task);
gpc->get_peer_task =
- GNUNET_SCHEDULER_add_delayed (gpc->sampler->max_round_interval,
+ GNUNET_SCHEDULER_add_delayed (sampler->max_round_interval,
&sampler_mod_get_rand_peer,
cls);
return;
s_elem->last_client_request = GNUNET_TIME_absolute_get ();
- GNUNET_CONTAINER_DLL_remove (gpc->sampler->gpc_head,
- gpc->sampler->gpc_tail,
+ GNUNET_CONTAINER_DLL_remove (gpc->req_handle->gpc_head,
+ gpc->req_handle->gpc_tail,
gpc);
gpc->cont (gpc->cont_cls, gpc->id);
GNUNET_free (gpc);
* #GNUNET_NO if used internally
* @param num_peers the number of peers requested
*/
- void
+struct RPS_SamplerRequestHandle *
RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler,
RPS_sampler_n_rand_peers_ready_cb cb,
void *cls, uint32_t num_peers)
{
GNUNET_assert (0 != sampler->sampler_size);
+ if (0 == num_peers)
+ return NULL;
// TODO check if we have too much (distinct) sampled peers
uint32_t i;
- struct NRandPeersReadyCls *cb_cls;
+ struct RPS_SamplerRequestHandle *req_handle;
struct GetPeerCls *gpc;
- cb_cls = GNUNET_new (struct NRandPeersReadyCls);
- cb_cls->num_peers = num_peers;
- cb_cls->cur_num_peers = 0;
- cb_cls->ids = GNUNET_new_array (num_peers, struct GNUNET_PeerIdentity);
- cb_cls->callback = cb;
- cb_cls->cls = cls;
+ req_handle = GNUNET_new (struct RPS_SamplerRequestHandle);
+ req_handle->num_peers = num_peers;
+ req_handle->cur_num_peers = 0;
+ req_handle->ids = GNUNET_new_array (num_peers, struct GNUNET_PeerIdentity);
+ req_handle->sampler = sampler;
+ req_handle->callback = cb;
+ req_handle->cls = cls;
+ GNUNET_CONTAINER_DLL_insert (sampler->req_handle_head,
+ sampler->req_handle_tail,
+ req_handle);
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Scheduling requests for %" PRIu32 " peers\n", num_peers);
for (i = 0 ; i < num_peers ; i++)
{
gpc = GNUNET_new (struct GetPeerCls);
- gpc->sampler = sampler;
+ gpc->req_handle = req_handle;
gpc->cont = check_n_peers_ready;
- gpc->cont_cls = cb_cls;
- gpc->id = &cb_cls->ids[i];
+ gpc->cont_cls = req_handle;
+ gpc->id = &req_handle->ids[i];
+ GNUNET_CONTAINER_DLL_insert (req_handle->gpc_head,
+ req_handle->gpc_tail,
+ gpc);
// maybe add a little delay
- gpc->get_peer_task = GNUNET_SCHEDULER_add_now (sampler->get_peers, gpc);
+ gpc->get_peer_task = GNUNET_SCHEDULER_add_now (sampler->get_peers,
+ gpc);
+ }
+ return req_handle;
+}
- GNUNET_CONTAINER_DLL_insert (sampler->gpc_head,
- sampler->gpc_tail,
- gpc);
+/**
+ * Cancle a request issued through #RPS_sampler_n_rand_peers_ready_cb.
+ *
+ * @param req_handle the handle to the request
+ */
+void
+RPS_sampler_request_cancel (struct RPS_SamplerRequestHandle *req_handle)
+{
+ struct GetPeerCls *i;
+
+ while (NULL != (i = req_handle->gpc_head) )
+ {
+ GNUNET_CONTAINER_DLL_remove (req_handle->gpc_head,
+ req_handle->gpc_tail,
+ i);
+ if (NULL != i->get_peer_task)
+ GNUNET_SCHEDULER_cancel (i->get_peer_task);
+ GNUNET_free (i);
}
+ GNUNET_CONTAINER_DLL_remove (req_handle->sampler->req_handle_head,
+ req_handle->sampler->req_handle_tail,
+ req_handle);
+ GNUNET_free (req_handle);
}
void
RPS_sampler_destroy (struct RPS_Sampler *sampler)
{
- struct GetPeerCls *i;
-
- for (i = sampler->gpc_head; NULL != i; i = sampler->gpc_head)
+ if (NULL != sampler->req_handle_head)
{
- GNUNET_CONTAINER_DLL_remove (sampler->gpc_head,
- sampler->gpc_tail,
- i);
- GNUNET_SCHEDULER_cancel (i->get_peer_task);
- GNUNET_free (i);
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "There are still pending requests. Going to remove them.\n");
+ while (NULL != sampler->req_handle_head)
+ RPS_sampler_request_cancel (sampler->req_handle_head);
}
-
sampler_empty (sampler);
GNUNET_free (sampler);
}
projects / oweals / gnunet.git / blobdiff