2 This file is part of GNUnet
3 Copyright (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file set/gnunet-service-set_union.c
22 * @brief two-peer set operations
23 * @author Florian Dold
26 #include "gnunet_util_lib.h"
27 #include "gnunet-service-set.h"
29 #include "gnunet-service-set_union_strata_estimator.h"
30 #include "gnunet-service-set_protocol.h"
35 * Number of IBFs in a strata estimator.
37 #define SE_STRATA_COUNT 32
39 * Size of the IBFs in the strata estimator.
41 #define SE_IBF_SIZE 80
43 * hash num parameter for the difference digests and strata estimators
45 #define SE_IBF_HASH_NUM 4
48 * Number of buckets that can be transmitted in one message.
50 #define MAX_BUCKETS_PER_MESSAGE ((1<<15) / IBF_BUCKET_SIZE)
53 * The maximum size of an ibf we use is 2^(MAX_IBF_ORDER).
54 * Choose this value so that computing the IBF is still cheaper
55 * than transmitting all values.
57 #define MAX_IBF_ORDER (16)
60 * Number of buckets used in the ibf per estimated
67 * Current phase we are in for a union operation.
69 enum UnionOperationPhase
72 * We sent the request message, and expect a strata estimator
77 * We sent the strata estimator, and expect an IBF. This phase is entered once
78 * upon initialization and later via #PHASE_EXPECT_ELEMENTS_AND_REQUESTS.
80 * After receiving the complete IBF, we enter #PHASE_EXPECT_ELEMENTS
85 * Continuation for multi part IBFs.
87 PHASE_EXPECT_IBF_CONT,
90 * We are sending request and elements,
91 * and thus only expect elements from the other peer.
93 * We are currently decoding an IBF until it can no longer be decoded,
94 * we currently send requests and expect elements
95 * The remote peer is in #PHASE_EXPECT_ELEMENTS_AND_REQUESTS
97 PHASE_EXPECT_ELEMENTS,
100 * We are expecting elements and requests, and send
101 * requested elements back to the other peer.
103 * We are in this phase if we have SENT an IBF for the remote peer to decode.
104 * We expect requests, send elements or could receive an new IBF, which takes
105 * us via #PHASE_EXPECT_IBF to phase #PHASE_EXPECT_ELEMENTS
107 * The remote peer is thus in:
108 * #PHASE_EXPECT_ELEMENTS
110 PHASE_EXPECT_ELEMENTS_AND_REQUESTS,
113 * The protocol is over.
114 * Results may still have to be sent to the client.
121 * State of an evaluate operation with another peer.
123 struct OperationState
127 * Copy of the set's strata estimator at the time of
128 * creation of this operation
130 struct StrataEstimator *se;
133 * The ibf we currently receive
135 struct InvertibleBloomFilter *remote_ibf;
138 * IBF of the set's element.
140 struct InvertibleBloomFilter *local_ibf;
143 * Maps IBF-Keys (specific to the current salt) to elements.
144 * Used as a multihashmap, the keys being the lower 32bit of the IBF-Key.
145 * Colliding IBF-Keys are linked.
147 struct GNUNET_CONTAINER_MultiHashMap32 *key_to_element;
150 * Iterator for sending elements on the key to element mapping to the client.
152 struct GNUNET_CONTAINER_MultiHashMap32Iterator *full_result_iter;
155 * Current state of the operation.
157 enum UnionOperationPhase phase;
160 * Did we send the client that we are done?
162 int client_done_sent;
165 * Number of ibf buckets received
167 unsigned int ibf_buckets_received;
173 * The key entry is used to associate an ibf key with an element.
178 * IBF key for the entry, derived from the current salt.
180 struct IBF_Key ibf_key;
183 * The actual element associated with the key.
185 struct ElementEntry *element;
188 * Element that collides with this element
189 * on the ibf key. All colliding entries must have the same ibf key.
191 struct KeyEntry *next_colliding;
196 * Used as a closure for sending elements
197 * with a specific IBF key.
199 struct SendElementClosure
202 * The IBF key whose matching elements should be
205 struct IBF_Key ibf_key;
208 * Operation for which the elements
211 struct Operation *op;
216 * Extra state required for efficient set union.
221 * The strata estimator is only generated once for
223 * The IBF keys are derived from the element hashes with
226 struct StrataEstimator *se;
231 * Iterator over hash map entries, called to
232 * destroy the linked list of colliding ibf key entries.
235 * @param key current key code
236 * @param value value in the hash map
237 * @return #GNUNET_YES if we should continue to iterate,
241 destroy_key_to_element_iter (void *cls,
245 struct KeyEntry *k = value;
249 struct KeyEntry *k_tmp = k;
251 k = k->next_colliding;
252 if (GNUNET_YES == k_tmp->element->remote)
254 GNUNET_free (k_tmp->element);
255 k_tmp->element = NULL;
264 * Destroy the union operation. Only things specific to the union
265 * operation are destroyed.
267 * @param op union operation to destroy
270 union_op_cancel (struct Operation *op)
272 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
273 "destroying union op\n");
274 /* check if the op was canceled twice */
275 GNUNET_assert (NULL != op->state);
276 if (NULL != op->state->remote_ibf)
278 ibf_destroy (op->state->remote_ibf);
279 op->state->remote_ibf = NULL;
281 if (NULL != op->state->local_ibf)
283 ibf_destroy (op->state->local_ibf);
284 op->state->local_ibf = NULL;
286 if (NULL != op->state->se)
288 strata_estimator_destroy (op->state->se);
289 op->state->se = NULL;
291 if (NULL != op->state->key_to_element)
293 GNUNET_CONTAINER_multihashmap32_iterate (op->state->key_to_element,
294 &destroy_key_to_element_iter,
296 GNUNET_CONTAINER_multihashmap32_destroy (op->state->key_to_element);
297 op->state->key_to_element = NULL;
299 GNUNET_free (op->state);
301 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
302 "destroying union op done\n");
307 * Inform the client that the union operation has failed,
308 * and proceed to destroy the evaluate operation.
310 * @param op the union operation to fail
313 fail_union_operation (struct Operation *op)
315 struct GNUNET_MQ_Envelope *ev;
316 struct GNUNET_SET_ResultMessage *msg;
318 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
319 "union operation failed\n");
320 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
321 msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
322 msg->request_id = htonl (op->spec->client_request_id);
323 msg->element_type = htons (0);
324 GNUNET_MQ_send (op->spec->set->client_mq, ev);
325 _GSS_operation_destroy (op, GNUNET_YES);
330 * Derive the IBF key from a hash code and
333 * @param src the hash code
334 * @param salt salt to use
335 * @return the derived IBF key
337 static struct IBF_Key
338 get_ibf_key (const struct GNUNET_HashCode *src,
343 GNUNET_CRYPTO_hkdf (&key, sizeof (key),
344 GCRY_MD_SHA512, GCRY_MD_SHA256,
346 &salt, sizeof (salt),
353 * Iterator to create the mapping between ibf keys
354 * and element entries.
357 * @param key current key code
358 * @param value value in the hash map
359 * @return #GNUNET_YES if we should continue to iterate,
363 op_register_element_iterator (void *cls,
367 struct KeyEntry *const new_k = cls;
368 struct KeyEntry *old_k = value;
370 GNUNET_assert (NULL != old_k);
371 /* check if our ibf key collides with the ibf key in the existing entry */
372 if (old_k->ibf_key.key_val == new_k->ibf_key.key_val)
374 /* insert the the new key in the collision chain */
375 new_k->next_colliding = old_k->next_colliding;
376 old_k->next_colliding = new_k;
377 /* signal to the caller that we were able to insert into a colliding bucket */
385 * Iterator to create the mapping between ibf keys
386 * and element entries.
389 * @param key current key code
390 * @param value value in the hash map
391 * @return #GNUNET_YES (we should continue to iterate)
394 op_has_element_iterator (void *cls,
398 struct GNUNET_HashCode *element_hash = cls;
399 struct KeyEntry *k = value;
401 GNUNET_assert (NULL != k);
404 if (0 == GNUNET_CRYPTO_hash_cmp (&k->element->element_hash,
407 k = k->next_colliding;
414 * Determine whether the given element is already in the operation's element
417 * @param op operation that should be tested for 'element_hash'
418 * @param element_hash hash of the element to look for
419 * @return #GNUNET_YES if the element has been found, #GNUNET_NO otherwise
422 op_has_element (struct Operation *op,
423 const struct GNUNET_HashCode *element_hash)
426 struct IBF_Key ibf_key;
428 ibf_key = get_ibf_key (element_hash, op->spec->salt);
429 ret = GNUNET_CONTAINER_multihashmap32_get_multiple (op->state->key_to_element,
430 (uint32_t) ibf_key.key_val,
431 op_has_element_iterator,
432 (void *) element_hash);
434 /* was the iteration aborted because we found the element? */
435 if (GNUNET_SYSERR == ret)
442 * Insert an element into the union operation's
443 * key-to-element mapping. Takes ownership of 'ee'.
444 * Note that this does not insert the element in the set,
445 * only in the operation's key-element mapping.
446 * This is done to speed up re-tried operations, if some elements
447 * were transmitted, and then the IBF fails to decode.
449 * @param op the union operation
450 * @param ee the element entry
453 op_register_element (struct Operation *op,
454 struct ElementEntry *ee)
457 struct IBF_Key ibf_key;
460 ibf_key = get_ibf_key (&ee->element_hash, op->spec->salt);
461 k = GNUNET_new (struct KeyEntry);
463 k->ibf_key = ibf_key;
464 ret = GNUNET_CONTAINER_multihashmap32_get_multiple (op->state->key_to_element,
465 (uint32_t) ibf_key.key_val,
466 op_register_element_iterator,
469 /* was the element inserted into a colliding bucket? */
470 if (GNUNET_SYSERR == ret)
472 GNUNET_CONTAINER_multihashmap32_put (op->state->key_to_element,
473 (uint32_t) ibf_key.key_val,
475 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
480 * Insert a key into an ibf.
484 * @param value the key entry to get the key from
487 prepare_ibf_iterator (void *cls,
491 struct InvertibleBloomFilter *ibf = cls;
492 struct KeyEntry *ke = value;
494 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
495 "inserting %x into ibf\n",
496 ke->ibf_key.key_val);
497 ibf_insert (ibf, ke->ibf_key);
503 * Iterator for initializing the
504 * key-to-element mapping of a union operation
506 * @param cls the union operation `struct Operation *`
508 * @param value the `struct ElementEntry *` to insert
509 * into the key-to-element mapping
510 * @return #GNUNET_YES (to continue iterating)
513 init_key_to_element_iterator (void *cls,
514 const struct GNUNET_HashCode *key,
517 struct Operation *op = cls;
518 struct ElementEntry *e = value;
520 /* make sure that the element belongs to the set at the time
521 * of creating the operation */
522 if ( (e->generation_added > op->generation_created) ||
523 ( (GNUNET_YES == e->removed) &&
524 (e->generation_removed < op->generation_created)))
527 GNUNET_assert (GNUNET_NO == e->remote);
529 op_register_element (op, e);
535 * Create an ibf with the operation's elements
536 * of the specified size
538 * @param op the union operation
539 * @param size size of the ibf to create
542 prepare_ibf (struct Operation *op,
545 if (NULL == op->state->key_to_element)
549 len = GNUNET_CONTAINER_multihashmap_size (op->spec->set->elements);
550 op->state->key_to_element = GNUNET_CONTAINER_multihashmap32_create (len + 1);
551 GNUNET_CONTAINER_multihashmap_iterate (op->spec->set->elements,
552 init_key_to_element_iterator, op);
554 if (NULL != op->state->local_ibf)
555 ibf_destroy (op->state->local_ibf);
556 op->state->local_ibf = ibf_create (size, SE_IBF_HASH_NUM);
557 GNUNET_CONTAINER_multihashmap32_iterate (op->state->key_to_element,
558 &prepare_ibf_iterator,
559 op->state->local_ibf);
564 * Send an ibf of appropriate size.
566 * @param op the union operation
567 * @param ibf_order order of the ibf to send, size=2^order
570 send_ibf (struct Operation *op,
573 unsigned int buckets_sent = 0;
574 struct InvertibleBloomFilter *ibf;
576 prepare_ibf (op, 1<<ibf_order);
578 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
579 "sending ibf of size %u\n",
582 ibf = op->state->local_ibf;
584 while (buckets_sent < (1 << ibf_order))
586 unsigned int buckets_in_message;
587 struct GNUNET_MQ_Envelope *ev;
588 struct IBFMessage *msg;
590 buckets_in_message = (1 << ibf_order) - buckets_sent;
591 /* limit to maximum */
592 if (buckets_in_message > MAX_BUCKETS_PER_MESSAGE)
593 buckets_in_message = MAX_BUCKETS_PER_MESSAGE;
595 ev = GNUNET_MQ_msg_extra (msg,
596 buckets_in_message * IBF_BUCKET_SIZE,
597 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF);
599 msg->order = ibf_order;
600 msg->offset = htons (buckets_sent);
601 ibf_write_slice (ibf, buckets_sent,
602 buckets_in_message, &msg[1]);
603 buckets_sent += buckets_in_message;
604 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
605 "ibf chunk size %u, %u/%u sent\n",
609 GNUNET_MQ_send (op->mq, ev);
612 op->state->phase = PHASE_EXPECT_ELEMENTS_AND_REQUESTS;
617 * Send a strata estimator to the remote peer.
619 * @param op the union operation with the remote peer
622 send_strata_estimator (struct Operation *op)
624 struct GNUNET_MQ_Envelope *ev;
625 struct GNUNET_MessageHeader *strata_msg;
627 ev = GNUNET_MQ_msg_header_extra (strata_msg,
628 SE_STRATA_COUNT * IBF_BUCKET_SIZE * SE_IBF_SIZE,
629 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE);
630 strata_estimator_write (op->state->se, &strata_msg[1]);
631 GNUNET_MQ_send (op->mq,
633 op->state->phase = PHASE_EXPECT_IBF;
634 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
635 "sent SE, expecting IBF\n");
640 * Compute the necessary order of an ibf
641 * from the size of the symmetric set difference.
643 * @param diff the difference
644 * @return the required size of the ibf
647 get_order_from_difference (unsigned int diff)
649 unsigned int ibf_order;
652 while ( (1<<ibf_order) < (IBF_ALPHA * diff) ||
653 ((1<<ibf_order) < SE_IBF_HASH_NUM) )
655 if (ibf_order > MAX_IBF_ORDER)
656 ibf_order = MAX_IBF_ORDER;
662 * Handle a strata estimator from a remote peer
664 * @param cls the union operation
665 * @param mh the message
666 * @return #GNUNET_SYSERR if the tunnel should be disconnected,
667 * #GNUNET_OK otherwise
670 handle_p2p_strata_estimator (void *cls,
671 const struct GNUNET_MessageHeader *mh)
673 struct Operation *op = cls;
674 struct StrataEstimator *remote_se;
677 if (op->state->phase != PHASE_EXPECT_SE)
679 fail_union_operation (op);
681 return GNUNET_SYSERR;
683 if (ntohs (mh->size) !=
684 SE_STRATA_COUNT * SE_IBF_SIZE * IBF_BUCKET_SIZE +
685 sizeof (struct GNUNET_MessageHeader))
687 fail_union_operation (op);
689 return GNUNET_SYSERR;
691 remote_se = strata_estimator_create (SE_STRATA_COUNT,
694 strata_estimator_read (&mh[1], remote_se);
695 GNUNET_assert (NULL != op->state->se);
696 diff = strata_estimator_difference (remote_se,
698 strata_estimator_destroy (remote_se);
699 strata_estimator_destroy (op->state->se);
700 op->state->se = NULL;
701 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
702 "got se diff=%d, using ibf size %d\n",
704 1<<get_order_from_difference (diff));
706 get_order_from_difference (diff));
712 * Iterator to send elements to a remote peer
714 * @param cls closure with the element key and the union operation
716 * @param value the key entry
719 send_element_iterator (void *cls,
723 struct SendElementClosure *sec = cls;
724 struct IBF_Key ibf_key = sec->ibf_key;
725 struct Operation *op = sec->op;
726 struct KeyEntry *ke = value;
728 if (ke->ibf_key.key_val != ibf_key.key_val)
732 const struct GNUNET_SET_Element *const element = &ke->element->element;
733 struct GNUNET_MQ_Envelope *ev;
734 struct GNUNET_MessageHeader *mh;
736 GNUNET_assert (ke->ibf_key.key_val == ibf_key.key_val);
737 ev = GNUNET_MQ_msg_header_extra (mh,
739 GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS);
742 /* element too large */
749 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
750 "sending element (%s) to peer\n",
751 GNUNET_h2s (&ke->element->element_hash));
752 GNUNET_MQ_send (op->mq, ev);
753 ke = ke->next_colliding;
760 * Send all elements that have the specified IBF key
761 * to the remote peer of the union operation
763 * @param op union operation
764 * @param ibf_key IBF key of interest
767 send_elements_for_key (struct Operation *op,
768 struct IBF_Key ibf_key)
770 struct SendElementClosure send_cls;
772 send_cls.ibf_key = ibf_key;
774 (void) GNUNET_CONTAINER_multihashmap32_get_multiple (op->state->key_to_element,
775 (uint32_t) ibf_key.key_val,
776 &send_element_iterator,
782 * Decode which elements are missing on each side, and
783 * send the appropriate elemens and requests
785 * @param op union operation
788 decode_and_send (struct Operation *op)
791 struct IBF_Key last_key;
793 unsigned int num_decoded;
794 struct InvertibleBloomFilter *diff_ibf;
796 GNUNET_assert (PHASE_EXPECT_ELEMENTS == op->state->phase);
798 prepare_ibf (op, op->state->remote_ibf->size);
799 diff_ibf = ibf_dup (op->state->local_ibf);
800 ibf_subtract (diff_ibf, op->state->remote_ibf);
802 ibf_destroy (op->state->remote_ibf);
803 op->state->remote_ibf = NULL;
805 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
806 "decoding IBF (size=%u)\n",
810 last_key.key_val = 0;
815 int cycle_detected = GNUNET_NO;
819 res = ibf_decode (diff_ibf, &side, &key);
820 if (res == GNUNET_OK)
822 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
823 "decoded ibf key %lx\n",
826 if ( (num_decoded > diff_ibf->size) ||
827 (num_decoded > 1 && last_key.key_val == key.key_val) )
829 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
830 "detected cyclic ibf (decoded %u/%u)\n",
833 cycle_detected = GNUNET_YES;
836 if ( (GNUNET_SYSERR == res) ||
837 (GNUNET_YES == cycle_detected) )
841 while (1<<next_order < diff_ibf->size)
844 if (next_order <= MAX_IBF_ORDER)
846 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
847 "decoding failed, sending larger ibf (size %u)\n",
849 send_ibf (op, next_order);
853 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
854 "set union failed: reached ibf limit\n");
858 if (GNUNET_NO == res)
860 struct GNUNET_MQ_Envelope *ev;
862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
863 "transmitted all values, sending DONE\n");
864 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DONE);
865 GNUNET_MQ_send (op->mq, ev);
870 send_elements_for_key (op, key);
874 struct GNUNET_MQ_Envelope *ev;
875 struct GNUNET_MessageHeader *msg;
877 /* It may be nice to merge multiple requests, but with cadet's corking it is not worth
878 * the effort additional complexity. */
879 ev = GNUNET_MQ_msg_header_extra (msg,
880 sizeof (struct IBF_Key),
881 GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS);
885 sizeof (struct IBF_Key));
886 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
887 "sending element request\n");
888 GNUNET_MQ_send (op->mq, ev);
895 ibf_destroy (diff_ibf);
900 * Handle an IBF message from a remote peer.
902 * @param cls the union operation
903 * @param mh the header of the message
904 * @return #GNUNET_SYSERR if the tunnel should be disconnected,
905 * #GNUNET_OK otherwise
908 handle_p2p_ibf (void *cls,
909 const struct GNUNET_MessageHeader *mh)
911 struct Operation *op = cls;
912 const struct IBFMessage *msg;
913 unsigned int buckets_in_message;
915 if (ntohs (mh->size) < sizeof (struct IBFMessage))
918 fail_union_operation (op);
919 return GNUNET_SYSERR;
921 msg = (const struct IBFMessage *) mh;
922 if ( (op->state->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS) ||
923 (op->state->phase == PHASE_EXPECT_IBF) )
925 op->state->phase = PHASE_EXPECT_IBF_CONT;
926 GNUNET_assert (NULL == op->state->remote_ibf);
927 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
928 "Creating new ibf of size %u\n",
930 op->state->remote_ibf = ibf_create (1<<msg->order, SE_IBF_HASH_NUM);
931 op->state->ibf_buckets_received = 0;
932 if (0 != ntohs (msg->offset))
935 fail_union_operation (op);
936 return GNUNET_SYSERR;
939 else if (op->state->phase == PHASE_EXPECT_IBF_CONT)
941 if ( (ntohs (msg->offset) != op->state->ibf_buckets_received) ||
942 (1<<msg->order != op->state->remote_ibf->size) )
945 fail_union_operation (op);
946 return GNUNET_SYSERR;
950 buckets_in_message = (ntohs (msg->header.size) - sizeof *msg) / IBF_BUCKET_SIZE;
952 if (0 == buckets_in_message)
955 fail_union_operation (op);
956 return GNUNET_SYSERR;
959 if ((ntohs (msg->header.size) - sizeof *msg) != buckets_in_message * IBF_BUCKET_SIZE)
962 fail_union_operation (op);
963 return GNUNET_SYSERR;
966 ibf_read_slice (&msg[1],
967 op->state->ibf_buckets_received,
969 op->state->remote_ibf);
970 op->state->ibf_buckets_received += buckets_in_message;
972 if (op->state->ibf_buckets_received == op->state->remote_ibf->size)
974 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
975 "received full ibf\n");
976 op->state->phase = PHASE_EXPECT_ELEMENTS;
977 decode_and_send (op);
984 * Send a result message to the client indicating
985 * that there is a new element.
987 * @param op union operation
988 * @param element element to send
991 send_client_element (struct Operation *op,
992 struct GNUNET_SET_Element *element)
994 struct GNUNET_MQ_Envelope *ev;
995 struct GNUNET_SET_ResultMessage *rm;
997 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
998 "sending element (size %u) to client\n",
1000 GNUNET_assert (0 != op->spec->client_request_id);
1001 ev = GNUNET_MQ_msg_extra (rm, element->size, GNUNET_MESSAGE_TYPE_SET_RESULT);
1004 GNUNET_MQ_discard (ev);
1008 rm->result_status = htons (GNUNET_SET_STATUS_OK);
1009 rm->request_id = htonl (op->spec->client_request_id);
1010 rm->element_type = element->element_type;
1011 memcpy (&rm[1], element->data, element->size);
1012 GNUNET_MQ_send (op->spec->set->client_mq, ev);
1017 * Signal to the client that the operation has finished and
1018 * destroy the operation.
1020 * @param cls operation to destroy
1023 send_done_and_destroy (void *cls)
1025 struct Operation *op = cls;
1026 struct GNUNET_MQ_Envelope *ev;
1027 struct GNUNET_SET_ResultMessage *rm;
1029 ev = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
1030 rm->request_id = htonl (op->spec->client_request_id);
1031 rm->result_status = htons (GNUNET_SET_STATUS_DONE);
1032 rm->element_type = htons (0);
1033 GNUNET_MQ_send (op->spec->set->client_mq, ev);
1034 _GSS_operation_destroy (op, GNUNET_YES);
1042 * Send all remaining elements in the full result iterator.
1044 * @param cls operation
1047 send_remaining_elements (void *cls)
1049 struct Operation *op = cls;
1050 struct KeyEntry *ke;
1053 res = GNUNET_CONTAINER_multihashmap32_iterator_next (op->state->full_result_iter,
1055 (const void **) &ke);
1056 if (GNUNET_NO == res)
1058 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1059 "sending done and destroy because iterator ran out\n");
1060 send_done_and_destroy (op);
1063 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1064 "sending elements from key entry\n");
1067 struct GNUNET_MQ_Envelope *ev;
1068 struct GNUNET_SET_ResultMessage *rm;
1069 struct GNUNET_SET_Element *element;
1071 element = &ke->element->element;
1072 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1073 "sending element (size %u) to client (full set)\n",
1075 GNUNET_assert (0 != op->spec->client_request_id);
1076 ev = GNUNET_MQ_msg_extra (rm,
1078 GNUNET_MESSAGE_TYPE_SET_RESULT);
1081 GNUNET_MQ_discard (ev);
1085 rm->result_status = htons (GNUNET_SET_STATUS_OK);
1086 rm->request_id = htonl (op->spec->client_request_id);
1087 rm->element_type = element->element_type;
1088 memcpy (&rm[1], element->data, element->size);
1089 if (NULL == ke->next_colliding)
1091 GNUNET_MQ_notify_sent (ev, send_remaining_elements, op);
1092 GNUNET_MQ_send (op->spec->set->client_mq, ev);
1095 GNUNET_MQ_send (op->spec->set->client_mq, ev);
1096 ke = ke->next_colliding;
1102 * Send a result message to the client indicating
1103 * that the operation is over.
1104 * After the result done message has been sent to the client,
1105 * destroy the evaluate operation.
1107 * @param op union operation
1110 finish_and_destroy (struct Operation *op)
1112 GNUNET_assert (GNUNET_NO == op->state->client_done_sent);
1114 if (GNUNET_SET_RESULT_FULL == op->spec->result_mode)
1116 /* prevent that the op is free'd by the tunnel end handler */
1117 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1118 "sending full result set\n");
1119 GNUNET_assert (NULL == op->state->full_result_iter);
1120 op->state->full_result_iter =
1121 GNUNET_CONTAINER_multihashmap32_iterator_create (op->state->key_to_element);
1122 send_remaining_elements (op);
1125 send_done_and_destroy (op);
1130 * Handle an element message from a remote peer.
1132 * @param cls the union operation
1133 * @param mh the message
1136 handle_p2p_elements (void *cls,
1137 const struct GNUNET_MessageHeader *mh)
1139 struct Operation *op = cls;
1140 struct ElementEntry *ee;
1141 uint16_t element_size;
1143 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1144 "Got element from peer\n");
1145 if ( (op->state->phase != PHASE_EXPECT_ELEMENTS) &&
1146 (op->state->phase != PHASE_EXPECT_ELEMENTS_AND_REQUESTS) )
1148 fail_union_operation (op);
1149 GNUNET_break_op (0);
1152 element_size = ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader);
1153 ee = GNUNET_malloc (sizeof (struct ElementEntry) + element_size);
1154 memcpy (&ee[1], &mh[1], element_size);
1155 ee->element.size = element_size;
1156 ee->element.data = &ee[1];
1157 ee->remote = GNUNET_YES;
1158 GNUNET_CRYPTO_hash (ee->element.data,
1162 if (GNUNET_YES == op_has_element (op, &ee->element_hash))
1164 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1165 "got existing element from peer\n");
1170 op_register_element (op, ee);
1171 /* only send results immediately if the client wants it */
1172 if (GNUNET_SET_RESULT_ADDED == op->spec->result_mode)
1173 send_client_element (op, &ee->element);
1178 * Handle an element request from a remote peer.
1180 * @param cls the union operation
1181 * @param mh the message
1184 handle_p2p_element_requests (void *cls,
1185 const struct GNUNET_MessageHeader *mh)
1187 struct Operation *op = cls;
1188 const struct IBF_Key *ibf_key;
1189 unsigned int num_keys;
1191 /* look up elements and send them */
1192 if (op->state->phase != PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
1194 GNUNET_break_op (0);
1195 fail_union_operation (op);
1198 num_keys = (ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
1199 / sizeof (struct IBF_Key);
1200 if ((ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
1201 != num_keys * sizeof (struct IBF_Key))
1203 GNUNET_break_op (0);
1204 fail_union_operation (op);
1208 ibf_key = (const struct IBF_Key *) &mh[1];
1209 while (0 != num_keys--)
1211 send_elements_for_key (op, *ibf_key);
1218 * Handle a done message from a remote peer
1220 * @param cls the union operation
1221 * @param mh the message
1224 handle_p2p_done (void *cls,
1225 const struct GNUNET_MessageHeader *mh)
1227 struct Operation *op = cls;
1228 struct GNUNET_MQ_Envelope *ev;
1230 if (op->state->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
1232 /* we got all requests, but still have to send our elements as response */
1234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1235 "got DONE, sending final DONE after elements\n");
1236 op->state->phase = PHASE_FINISHED;
1237 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DONE);
1238 GNUNET_MQ_send (op->mq, ev);
1241 if (op->state->phase == PHASE_EXPECT_ELEMENTS)
1243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1244 "got final DONE\n");
1245 op->state->phase = PHASE_FINISHED;
1246 finish_and_destroy (op);
1249 GNUNET_break_op (0);
1250 fail_union_operation (op);
1255 * Initiate operation to evaluate a set union with a remote peer.
1257 * @param op operation to perform (to be initialized)
1258 * @param opaque_context message to be transmitted to the listener
1259 * to convince him to accept, may be NULL
1262 union_evaluate (struct Operation *op,
1263 const struct GNUNET_MessageHeader *opaque_context)
1265 struct GNUNET_MQ_Envelope *ev;
1266 struct OperationRequestMessage *msg;
1268 op->state = GNUNET_new (struct OperationState);
1269 /* copy the current generation's strata estimator for this operation */
1270 op->state->se = strata_estimator_dup (op->spec->set->state->se);
1271 /* we started the operation, thus we have to send the operation request */
1272 op->state->phase = PHASE_EXPECT_SE;
1273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1274 "Initiating union operation evaluation\n");
1275 ev = GNUNET_MQ_msg_nested_mh (msg,
1276 GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST,
1280 /* the context message is too large */
1282 GNUNET_SERVER_client_disconnect (op->spec->set->client);
1285 msg->operation = htonl (GNUNET_SET_OPERATION_UNION);
1286 msg->app_id = op->spec->app_id;
1287 GNUNET_MQ_send (op->mq,
1290 if (NULL != opaque_context)
1291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1292 "sent op request with context message\n");
1294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1295 "sent op request without context message\n");
1300 * Accept an union operation request from a remote peer.
1301 * Only initializes the private operation state.
1303 * @param op operation that will be accepted as a union operation
1306 union_accept (struct Operation *op)
1308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1309 "accepting set union operation\n");
1310 op->state = GNUNET_new (struct OperationState);
1311 op->state->se = strata_estimator_dup (op->spec->set->state->se);
1312 /* kick off the operation */
1313 send_strata_estimator (op);
1318 * Create a new set supporting the union operation
1320 * We maintain one strata estimator per set and then manipulate it over the
1321 * lifetime of the set, as recreating a strata estimator would be expensive.
1323 * @return the newly created set
1325 static struct SetState *
1326 union_set_create (void)
1328 struct SetState *set_state;
1330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1331 "union set created\n");
1332 set_state = GNUNET_new (struct SetState);
1333 set_state->se = strata_estimator_create (SE_STRATA_COUNT,
1334 SE_IBF_SIZE, SE_IBF_HASH_NUM);
1340 * Add the element from the given element message to the set.
1342 * @param set_state state of the set want to add to
1343 * @param ee the element to add to the set
1346 union_add (struct SetState *set_state, struct ElementEntry *ee)
1348 strata_estimator_insert (set_state->se,
1349 get_ibf_key (&ee->element_hash, 0));
1354 * Remove the element given in the element message from the set.
1355 * Only marks the element as removed, so that older set operations can still exchange it.
1357 * @param set_state state of the set to remove from
1358 * @param ee set element to remove
1361 union_remove (struct SetState *set_state, struct ElementEntry *ee)
1363 strata_estimator_remove (set_state->se,
1364 get_ibf_key (&ee->element_hash, 0));
1369 * Destroy a set that supports the union operation.
1371 * @param set_state the set to destroy
1374 union_set_destroy (struct SetState *set_state)
1376 if (NULL != set_state->se)
1378 strata_estimator_destroy (set_state->se);
1379 set_state->se = NULL;
1381 GNUNET_free (set_state);
1386 * Dispatch messages for a union operation.
1388 * @param op the state of the union evaluate operation
1389 * @param mh the received message
1390 * @return #GNUNET_SYSERR if the tunnel should be disconnected,
1391 * #GNUNET_OK otherwise
1394 union_handle_p2p_message (struct Operation *op,
1395 const struct GNUNET_MessageHeader *mh)
1397 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1398 "received p2p message (t: %u, s: %u)\n",
1401 switch (ntohs (mh->type))
1403 case GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF:
1404 return handle_p2p_ibf (op, mh);
1405 case GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE:
1406 return handle_p2p_strata_estimator (op, mh);
1407 case GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS:
1408 handle_p2p_elements (op, mh);
1410 case GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS:
1411 handle_p2p_element_requests (op, mh);
1413 case GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DONE:
1414 handle_p2p_done (op, mh);
1417 /* something wrong with cadet's message handlers? */
1424 * handler for peer-disconnects, notifies the client
1425 * about the aborted operation in case the op was not concluded
1427 * @param op the destroyed operation
1430 union_peer_disconnect (struct Operation *op)
1432 if (PHASE_FINISHED != op->state->phase)
1434 struct GNUNET_MQ_Envelope *ev;
1435 struct GNUNET_SET_ResultMessage *msg;
1437 ev = GNUNET_MQ_msg (msg,
1438 GNUNET_MESSAGE_TYPE_SET_RESULT);
1439 msg->request_id = htonl (op->spec->client_request_id);
1440 msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
1441 msg->element_type = htons (0);
1442 GNUNET_MQ_send (op->spec->set->client_mq,
1444 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1445 "other peer disconnected prematurely\n");
1446 _GSS_operation_destroy (op,
1450 // else: the session has already been concluded
1451 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1452 "other peer disconnected (finished)\n");
1453 if (GNUNET_NO == op->state->client_done_sent)
1454 finish_and_destroy (op);
1459 * Get the table with implementing functions for
1462 * @return the operation specific VTable
1464 const struct SetVT *
1467 static const struct SetVT union_vt = {
1468 .create = &union_set_create,
1469 .msg_handler = &union_handle_p2p_message,
1471 .remove = &union_remove,
1472 .destroy_set = &union_set_destroy,
1473 .evaluate = &union_evaluate,
1474 .accept = &union_accept,
1475 .peer_disconnect = &union_peer_disconnect,
1476 .cancel = &union_op_cancel,