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 2, or (at your
+ 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
* @brief two-peer set operations
* @author Florian Dold
*/
-
-
+#include "platform.h"
+#include "gnunet_util_lib.h"
#include "gnunet-service-set.h"
-#include "gnunet_container_lib.h"
-#include "gnunet_crypto_lib.h"
#include "ibf.h"
#include "strata_estimator.h"
#include "set_protocol.h"
/**
* hash num parameter for the difference digests and strata estimators
*/
-#define SE_IBF_HASH_NUM 3
+#define SE_IBF_HASH_NUM 4
/**
* Number of buckets that can be transmitted in one message.
*/
#define MAX_IBF_ORDER (16)
+/**
+ * Number of buckets used in the ibf per estimated
+ * difference.
+ */
+#define IBF_ALPHA 4
+
/**
* Current phase we are in for a union operation.
/**
* Maps IBF-Keys (specific to the current salt) to elements.
+ * Used as a multihashmap, the keys being the lower 32bit of the IBF-Key.
+ * Colliding IBF-Keys are linked.
*/
struct GNUNET_CONTAINER_MultiHashMap32 *key_to_element;
* Set state of the set that this operation
* belongs to.
*/
- struct SetState *set_state;
-
+ struct Set *set;
+
/**
* Evaluate operations are held in
* a linked list.
*/
struct OperationState *next;
-
+
/**
* Evaluate operations are held in
* a linked list.
*/
struct OperationState *prev;
-};
-
-/**
- * Information about an element element in the set.
- * All elements are stored in a hash-table
- * from their hash-code to their 'struct Element',
- * so that the remove and add operations are reasonably
- * fast.
- */
-struct ElementEntry
-{
/**
- * The actual element. The data for the element
- * should be allocated at the end of this struct.
+ * Did we send the client that we are done?
*/
- struct GNUNET_SET_Element element;
-
- /**
- * Hash of the element.
- * Will be used to derive the different IBF keys
- * for different salts.
- */
- struct GNUNET_HashCode element_hash;
-
- /**
- * Generation the element was added by the client.
- * Operations of earlier generations will not consider the element.
- */
- unsigned int generation_added;
-
- /**
- * GNUNET_YES if the element has been removed in some generation.
- */
- int removed;
-
- /**
- * Generation the element was removed by the client.
- * Operations of later generations will not consider the element.
- * Only valid if is_removed is GNUNET_YES.
- */
- unsigned int generation_removed;
-
- /**
- * GNUNET_YES if the element is a remote element, and does not belong
- * to the operation's set.
- */
- int remote;
+ int client_done_sent;
};
*/
struct StrataEstimator *se;
- /**
- * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
- */
- struct GNUNET_CONTAINER_MultiHashMap *elements;
-
/**
* Evaluate operations are held in
* a linked list.
* a linked list.
*/
struct OperationState *ops_tail;
-
- /**
- * Current generation, that is, number of
- * previously executed operations on this set
- */
- unsigned int current_generation;
};
-
-/**
- * Iterator over hash map entries.
- *
- * @param cls closure
- * @param key current key code
- * @param value value in the hash map
- * @return GNUNET_YES if we should continue to
- * iterate,
- * GNUNET_NO if not.
- */
-static int
-destroy_elements_iterator (void *cls,
- const struct GNUNET_HashCode * key,
- void *value)
-{
- struct ElementEntry *ee = value;
-
- GNUNET_free (ee);
- return GNUNET_YES;
-}
-
-
/**
* Iterator over hash map entries.
*
void *value)
{
struct KeyEntry *k = value;
-
+
while (NULL != k)
{
struct KeyEntry *k_tmp = k;
union_operation_destroy (struct OperationState *eo)
{
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying union op\n");
- GNUNET_CONTAINER_DLL_remove (eo->set_state->ops_head,
- eo->set_state->ops_tail,
+ GNUNET_CONTAINER_DLL_remove (eo->set->state->ops_head,
+ eo->set->state->ops_tail,
eo);
if (NULL != eo->mq)
{
/**
- * Derive the IBF key from a hash code and
+ * Derive the IBF key from a hash code and
* a salt.
*
* @param src the hash code
GNUNET_SERVER_client_disconnect (eo->spec->set->client);
return;
}
- msg->operation = htons (GNUNET_SET_OPERATION_UNION);
+ msg->operation = htonl (GNUNET_SET_OPERATION_UNION);
msg->app_id = eo->spec->app_id;
msg->salt = htonl (eo->spec->salt);
GNUNET_MQ_send (eo->mq, ev);
+ if (NULL != eo->spec->context_msg)
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent op request with context message\n");
+ else
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent op request without context message\n");
+
if (NULL != eo->spec->context_msg)
{
GNUNET_free (eo->spec->context_msg);
eo->spec->context_msg = NULL;
}
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent op request\n");
}
* GNUNET_NO if not.
*/
static int
-insert_element_iterator (void *cls,
+op_register_element_iterator (void *cls,
uint32_t key,
void *value)
{
/**
* Insert an element into the union operation's
* key-to-element mapping. Takes ownership of 'ee'.
+ * Note that this does not insert the element in the set,
+ * only in the operation's key-element mapping.
+ * This is done to speed up re-tried operations, if some elements
+ * were transmitted, and then the IBF fails to decode.
*
* @param eo the union operation
* @param ee the element entry
*/
static void
-insert_element (struct OperationState *eo, struct ElementEntry *ee)
+op_register_element (struct OperationState *eo, struct ElementEntry *ee)
{
int ret;
struct IBF_Key ibf_key;
k->ibf_key = ibf_key;
ret = GNUNET_CONTAINER_multihashmap32_get_multiple (eo->key_to_element,
(uint32_t) ibf_key.key_val,
- insert_element_iterator, k);
+ op_register_element_iterator, k);
/* was the element inserted into a colliding bucket? */
if (GNUNET_SYSERR == ret)
return;
GNUNET_CONTAINER_multihashmap32_put (eo->key_to_element, (uint32_t) ibf_key.key_val, k,
- GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
+ GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
}
struct InvertibleBloomFilter *ibf = cls;
struct KeyEntry *ke = value;
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "inserting %x into ibf\n", ke->ibf_key.key_val);
+
ibf_insert (ibf, ke->ibf_key);
return GNUNET_YES;
}
* @param key unised
* @param value the element entry to insert
* into the key-to-element mapping
+ * @return GNUNET_YES to continue iterating,
+ * GNUNET_NO to stop
*/
static int
init_key_to_element_iterator (void *cls,
(e->generation_removed < eo->generation_created)))
return GNUNET_YES;
- e->remote = GNUNET_NO;
+ GNUNET_assert (GNUNET_NO == e->remote);
- insert_element (eo, e);
+ op_register_element (eo, e);
return GNUNET_YES;
}
if (NULL == eo->key_to_element)
{
unsigned int len;
- len = GNUNET_CONTAINER_multihashmap_size (eo->set_state->elements);
+ len = GNUNET_CONTAINER_multihashmap_size (eo->set->elements);
eo->key_to_element = GNUNET_CONTAINER_multihashmap32_create (len + 1);
- GNUNET_CONTAINER_multihashmap_iterate (eo->set_state->elements,
+ GNUNET_CONTAINER_multihashmap_iterate (eo->set->elements,
init_key_to_element_iterator, eo);
}
if (NULL != eo->local_ibf)
ev = GNUNET_MQ_msg_header_extra (strata_msg,
SE_STRATA_COUNT * IBF_BUCKET_SIZE * SE_IBF_SIZE,
GNUNET_MESSAGE_TYPE_SET_P2P_SE);
- strata_estimator_write (eo->set_state->se, &strata_msg[1]);
+ strata_estimator_write (eo->set->state->se, &strata_msg[1]);
GNUNET_MQ_send (eo->mq, ev);
eo->phase = PHASE_EXPECT_IBF;
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent SE, expecting IBF\n");
unsigned int ibf_order;
ibf_order = 2;
- while ((1<<ibf_order) < (2 * diff))
+ while ((1<<ibf_order) < (IBF_ALPHA * diff) || (1<<ibf_order) < SE_IBF_HASH_NUM)
ibf_order++;
if (ibf_order > MAX_IBF_ORDER)
ibf_order = MAX_IBF_ORDER;
SE_IBF_HASH_NUM);
strata_estimator_read (&mh[1], remote_se);
GNUNET_assert (NULL != eo->se);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got se, calculating diff\n");
diff = strata_estimator_difference (remote_se, eo->se);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "se diff=%d\n", diff);
strata_estimator_destroy (remote_se);
strata_estimator_destroy (eo->se);
eo->se = NULL;
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got se diff=%d, using ibf size %d\n",
+ diff, 1<<get_order_from_difference (diff));
send_ibf (eo, get_order_from_difference (diff));
}
continue;
}
memcpy (&mh[1], element->data, element->size);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending element to peer\n");
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending element (%s) to peer\n",
+ GNUNET_h2s (&ke->element->element_hash));
GNUNET_MQ_send (eo->mq, ev);
ke = ke->next_colliding;
}
decode_and_send (struct OperationState *eo)
{
struct IBF_Key key;
+ struct IBF_Key last_key;
int side;
unsigned int num_decoded;
struct InvertibleBloomFilter *diff_ibf;
prepare_ibf (eo, eo->remote_ibf->size);
diff_ibf = ibf_dup (eo->local_ibf);
ibf_subtract (diff_ibf, eo->remote_ibf);
-
+
ibf_destroy (eo->remote_ibf);
eo->remote_ibf = NULL;
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "decoding IBF (size=%u)\n", diff_ibf->size);
+
num_decoded = 0;
+ last_key.key_val = 0;
while (1)
{
int res;
+ int cycle_detected = GNUNET_NO;
+
+ last_key = key;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "decoding IBF for elements\n");
res = ibf_decode (diff_ibf, &side, &key);
- num_decoded += 1;
- if (num_decoded > diff_ibf->size)
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "detected cyclic ibf\n");
- if ((GNUNET_SYSERR == res) || (num_decoded > diff_ibf->size))
+ if (res == GNUNET_OK)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "decoded ibf key %lx\n",
+ key.key_val);
+ num_decoded += 1;
+ if (num_decoded > diff_ibf->size || (num_decoded > 1 && last_key.key_val == key.key_val))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "detected cyclic ibf (decoded %u/%u)\n",
+ num_decoded, diff_ibf->size);
+ cycle_detected = GNUNET_YES;
+ }
+ }
+ if ((GNUNET_SYSERR == res) || (GNUNET_YES == cycle_detected))
{
int next_order;
next_order = 0;
next_order++;
if (next_order <= MAX_IBF_ORDER)
{
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
"decoding failed, sending larger ibf (size %u)\n",
1<<next_order);
send_ibf (eo, next_order);
}
else
{
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"set union failed: reached ibf limit\n");
}
break;
{
send_elements_for_key (eo, key);
}
- else
+ else if (-1 == side)
{
struct GNUNET_MQ_Envelope *ev;
struct GNUNET_MessageHeader *msg;
/* FIXME: before sending the request, check if we may just have the element */
/* FIXME: merge multiple requests */
+ /* FIXME: remember somewhere that we already requested the element,
+ * so that we don't request it again with the next ibf if decoding fails */
ev = GNUNET_MQ_msg_header_extra (msg, sizeof (struct IBF_Key),
GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS);
+
*(struct IBF_Key *) &msg[1] = key;
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending element request\n");
GNUNET_MQ_send (eo->mq, ev);
}
+ else
+ {
+ GNUNET_assert (0);
+ }
}
ibf_destroy (diff_ibf);
}
fail_union_operation (eo);
return;
}
-
+
ibf_read_slice (&msg[1], eo->ibf_buckets_received, buckets_in_message, eo->remote_ibf);
eo->ibf_buckets_received += buckets_in_message;
if (eo->ibf_buckets_received == eo->remote_ibf->size)
{
-
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received full ibf\n");
eo->phase = PHASE_EXPECT_ELEMENTS;
decode_and_send (eo);
struct GNUNET_MQ_Envelope *ev;
struct GNUNET_SET_ResultMessage *rm;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending el of size %u\n", element->size);
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending element (size %u) to client\n", element->size);
GNUNET_assert (0 != eo->spec->client_request_id);
ev = GNUNET_MQ_msg_extra (rm, element->size, GNUNET_MESSAGE_TYPE_SET_RESULT);
if (NULL == ev)
struct GNUNET_MQ_Envelope *ev;
struct GNUNET_SET_ResultMessage *rm;
+ GNUNET_assert (GNUNET_NO == eo->client_done_sent);
+
+ eo->client_done_sent = GNUNET_YES;
+
ev = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
rm->request_id = htonl (eo->spec->client_request_id);
rm->result_status = htons (GNUNET_SET_STATUS_DONE);
rm->element_type = htons (0);
GNUNET_MQ_send (eo->spec->set->client_mq, ev);
+ union_operation_destroy (eo);
}
return;
}
element_size = ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader);
- ee = GNUNET_malloc (sizeof *eo + element_size);
+ ee = GNUNET_malloc (sizeof *ee + element_size);
memcpy (&ee[1], &mh[1], element_size);
ee->element.size = element_size;
ee->element.data = &ee[1];
ee->remote = GNUNET_YES;
+ GNUNET_CRYPTO_hash (ee->element.data, ee->element.size, &ee->element_hash);
- insert_element (eo, ee);
+ /* FIXME: see if the element has already been inserted! */
+
+ op_register_element (eo, ee);
send_client_element (eo, &ee->element);
}
}
-/**
- * Callback used for notifications
- *
- * @param cls closure
- */
-static void
-peer_done_sent_cb (void *cls)
-{
- struct OperationState *eo = cls;
-
- send_client_done_and_destroy (eo);
-}
-
-
/**
* Handle a done message from a remote peer
- *
+ *
* @param cls the union operation
* @param mh the message
*/
handle_p2p_done (void *cls, const struct GNUNET_MessageHeader *mh)
{
struct OperationState *eo = cls;
+ struct GNUNET_MQ_Envelope *ev;
if (eo->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
{
/* we got all requests, but still have to send our elements as response */
- struct GNUNET_MQ_Envelope *ev;
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got DONE, sending final DONE after elements\n");
eo->phase = PHASE_FINISHED;
ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_P2P_DONE);
- GNUNET_MQ_notify_sent (ev, peer_done_sent_cb, eo);
GNUNET_MQ_send (eo->mq, ev);
return;
}
tc->vt = _GSS_union_vt ();
tc->op = eo;
eo->se = strata_estimator_dup (spec->set->state->se);
- eo->set_state = spec->set->state;
+ eo->generation_created = spec->set->current_generation++;
+ eo->set = spec->set;
eo->spec = spec;
eo->tunnel = tunnel;
eo->mq = GNUNET_MESH_mq_create (tunnel);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "evaluating union operation, (app %s)\n",
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "evaluating union operation, (app %s)\n",
GNUNET_h2s (&eo->spec->app_id));
/* we started the operation, thus we have to send the operation request */
eo->phase = PHASE_EXPECT_SE;
- GNUNET_CONTAINER_DLL_insert (eo->set_state->ops_head,
- eo->set_state->ops_tail,
+ GNUNET_CONTAINER_DLL_insert (eo->set->state->ops_head,
+ eo->set->state->ops_tail,
eo);
send_operation_request (eo);
eo = GNUNET_new (struct OperationState);
tc->vt = _GSS_union_vt ();
tc->op = eo;
- eo->set_state = spec->set->state;
- eo->generation_created = eo->set_state->current_generation++;
+ eo->set = spec->set;
+ eo->generation_created = eo->set->current_generation++;
eo->spec = spec;
eo->tunnel = tunnel;
eo->mq = GNUNET_MESH_mq_create (tunnel);
- eo->se = strata_estimator_dup (eo->set_state->se);
+ eo->se = strata_estimator_dup (eo->set->state->se);
/* transfer ownership of mq and socket from incoming to eo */
- GNUNET_CONTAINER_DLL_insert (eo->set_state->ops_head,
- eo->set_state->ops_tail,
+ GNUNET_CONTAINER_DLL_insert (eo->set->state->ops_head,
+ eo->set->state->ops_tail,
eo);
/* kick off the operation */
send_strata_estimator (eo);
struct SetState *set_state;
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "union set created\n");
-
+
set_state = GNUNET_new (struct SetState);
- /* keys of the hash map are stored in the element entrys, thus we do not
- * want the hash map to copy them */
- set_state->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
set_state->se = strata_estimator_create (SE_STRATA_COUNT,
- SE_IBF_SIZE, SE_IBF_HASH_NUM);
+ SE_IBF_SIZE, SE_IBF_HASH_NUM);
return set_state;
}
* Add the element from the given element message to the set.
*
* @param set_state state of the set want to add to
- * @param element the element to add to the set
+ * @param ee the element to add to the set
*/
static void
-union_add (struct SetState *set_state, const struct GNUNET_SET_Element *element)
+union_add (struct SetState *set_state, struct ElementEntry *ee)
{
- struct ElementEntry *ee;
- struct ElementEntry *ee_dup;
-
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "adding union element of size %u\n", element->size);
-
- ee = GNUNET_malloc (element->size + sizeof *ee);
- ee->element.size = element->size;
- memcpy (&ee[1], element->data, element->size);
- ee->element.data = &ee[1];
- ee->generation_added = set_state->current_generation;
- ee->remote = GNUNET_NO;
- GNUNET_CRYPTO_hash (ee->element.data, element->size, &ee->element_hash);
- ee_dup = GNUNET_CONTAINER_multihashmap_get (set_state->elements,
- &ee->element_hash);
- if (NULL != ee_dup)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "element inserted twice, ignoring\n");
- GNUNET_free (ee);
- return;
- }
- GNUNET_CONTAINER_multihashmap_put (set_state->elements, &ee->element_hash, ee,
- GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
strata_estimator_insert (set_state->se, get_ibf_key (&ee->element_hash, 0));
}
strata_estimator_destroy (set_state->se);
set_state->se = NULL;
}
- if (NULL != set_state->elements)
- {
- GNUNET_CONTAINER_multihashmap_iterate (set_state->elements,
- destroy_elements_iterator, NULL);
- GNUNET_CONTAINER_multihashmap_destroy (set_state->elements);
- set_state->elements = NULL;
- }
-
GNUNET_free (set_state);
}
+
/**
* Remove the element given in the element message from the set.
* Only marks the element as removed, so that older set operations can still exchange it.
* @param element set element to remove
*/
static void
-union_remove (struct SetState *set_state, const struct GNUNET_SET_Element *element)
+union_remove (struct SetState *set_state, struct ElementEntry *element)
{
- struct GNUNET_HashCode hash;
- struct ElementEntry *ee;
-
- GNUNET_CRYPTO_hash (element->data, element->size, &hash);
- ee = GNUNET_CONTAINER_multihashmap_get (set_state->elements, &hash);
- if (NULL == ee)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove non-existing element\n");
- return;
- }
- if (GNUNET_YES == ee->removed)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove element twice\n");
- return;
- }
- ee->removed = GNUNET_YES;
- ee->generation_removed = set_state->current_generation;
+ /* FIXME: remove from strata estimator */
}
union_handle_p2p_message (struct OperationState *eo,
const struct GNUNET_MessageHeader *mh)
{
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received p2p message (t: %u, s: %u)\n",
+ ntohs (mh->type), ntohs (mh->size));
switch (ntohs (mh->type))
{
case GNUNET_MESSAGE_TYPE_SET_P2P_IBF:
{
struct GNUNET_MQ_Envelope *ev;
struct GNUNET_SET_ResultMessage *msg;
+
ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
msg->request_id = htonl (op->spec->client_request_id);
msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
msg->element_type = htons (0);
GNUNET_MQ_send (op->spec->set->client_mq, ev);
GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "other peer disconnected prematurely\n");
+ union_operation_destroy (op);
+ return;
}
- else
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "other peer disconnected (finished)\n");
- }
- union_operation_destroy (op);
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "other peer disconnected (finished)\n");
+ if (GNUNET_NO == op->client_done_sent)
+ send_client_done_and_destroy (op);
}
.evaluate = &union_evaluate,
.accept = &union_accept,
.peer_disconnect = &union_peer_disconnect,
- .cancel = &union_op_cancel
+ .cancel = &union_op_cancel,
};
return &union_vt;