2 This file is part of GNUnet
3 Copyright (C) 2013-2017 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file set/gnunet-service-set_union.c
22 * @brief two-peer set operations
23 * @author Florian Dold
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_statistics_service.h"
29 #include "gnunet-service-set.h"
31 #include "gnunet-service-set_union.h"
32 #include "gnunet-service-set_union_strata_estimator.h"
33 #include "gnunet-service-set_protocol.h"
37 #define LOG(kind,...) GNUNET_log_from (kind, "set-union",__VA_ARGS__)
41 * Number of IBFs in a strata estimator.
43 #define SE_STRATA_COUNT 32
46 * Size of the IBFs in the strata estimator.
48 #define SE_IBF_SIZE 80
51 * The hash num parameter for the difference digests and strata estimators.
53 #define SE_IBF_HASH_NUM 4
56 * Number of buckets that can be transmitted in one message.
58 #define MAX_BUCKETS_PER_MESSAGE ((1<<15) / IBF_BUCKET_SIZE)
61 * The maximum size of an ibf we use is 2^(MAX_IBF_ORDER).
62 * Choose this value so that computing the IBF is still cheaper
63 * than transmitting all values.
65 #define MAX_IBF_ORDER (20)
68 * Number of buckets used in the ibf per estimated
75 * Current phase we are in for a union operation.
77 enum UnionOperationPhase
80 * We sent the request message, and expect a strata estimator.
85 * We sent the strata estimator, and expect an IBF. This phase is entered once
86 * upon initialization and later via #PHASE_EXPECT_ELEMENTS_AND_REQUESTS.
88 * XXX: could use better wording.
89 * XXX: repurposed to also expect a "request full set" message, should be renamed
91 * After receiving the complete IBF, we enter #PHASE_EXPECT_ELEMENTS
96 * Continuation for multi part IBFs.
98 PHASE_EXPECT_IBF_CONT,
101 * We are decoding an IBF.
103 PHASE_INVENTORY_ACTIVE,
106 * The other peer is decoding the IBF we just sent.
108 PHASE_INVENTORY_PASSIVE,
111 * The protocol is almost finished, but we still have to flush our message
112 * queue and/or expect some elements.
114 PHASE_FINISH_CLOSING,
117 * In the penultimate phase,
118 * we wait until all our demands
119 * are satisfied. Then we send a done
120 * message, and wait for another done message.
122 PHASE_FINISH_WAITING,
125 * In the ultimate phase, we wait until
126 * our demands are satisfied and then
127 * quit (sending another DONE message).
132 * After sending the full set, wait for responses with the elements
133 * that the local peer is missing.
140 * State of an evaluate operation with another peer.
142 struct OperationState
145 * Copy of the set's strata estimator at the time of
146 * creation of this operation.
148 struct StrataEstimator *se;
151 * The IBF we currently receive.
153 struct InvertibleBloomFilter *remote_ibf;
156 * The IBF with the local set's element.
158 struct InvertibleBloomFilter *local_ibf;
161 * Maps unsalted IBF-Keys to elements.
162 * Used as a multihashmap, the keys being the lower 32bit of the IBF-Key.
163 * Colliding IBF-Keys are linked.
165 struct GNUNET_CONTAINER_MultiHashMap32 *key_to_element;
168 * Current state of the operation.
170 enum UnionOperationPhase phase;
173 * Did we send the client that we are done?
175 int client_done_sent;
178 * Number of ibf buckets already received into the @a remote_ibf.
180 unsigned int ibf_buckets_received;
183 * Hashes for elements that we have demanded from the other peer.
185 struct GNUNET_CONTAINER_MultiHashMap *demanded_hashes;
188 * Salt that we're using for sending IBFs
193 * Salt for the IBF we've received and that we're currently decoding.
195 uint32_t salt_receive;
198 * Number of elements we received from the other peer
199 * that were not in the local set yet.
201 uint32_t received_fresh;
204 * Total number of elements received from the other peer.
206 uint32_t received_total;
209 * Initial size of our set, just before
210 * the operation started.
212 uint64_t initial_size;
217 * The key entry is used to associate an ibf key with an element.
222 * IBF key for the entry, derived from the current salt.
224 struct IBF_Key ibf_key;
227 * The actual element associated with the key.
229 * Only owned by the union operation if element->operation
232 struct ElementEntry *element;
235 * Did we receive this element?
236 * Even if element->is_foreign is false, we might
237 * have received the element, so this indicates that
238 * the other peer has it.
245 * Used as a closure for sending elements
246 * with a specific IBF key.
248 struct SendElementClosure
251 * The IBF key whose matching elements should be
254 struct IBF_Key ibf_key;
257 * Operation for which the elements
260 struct Operation *op;
265 * Extra state required for efficient set union.
270 * The strata estimator is only generated once for
272 * The IBF keys are derived from the element hashes with
275 struct StrataEstimator *se;
280 * Iterator over hash map entries, called to
281 * destroy the linked list of colliding ibf key entries.
284 * @param key current key code
285 * @param value value in the hash map
286 * @return #GNUNET_YES if we should continue to iterate,
290 destroy_key_to_element_iter (void *cls,
294 struct KeyEntry *k = value;
296 GNUNET_assert (NULL != k);
297 if (GNUNET_YES == k->element->remote)
299 GNUNET_free (k->element);
308 * Destroy the union operation. Only things specific to the union
309 * operation are destroyed.
311 * @param op union operation to destroy
314 union_op_cancel (struct Operation *op)
316 LOG (GNUNET_ERROR_TYPE_DEBUG,
317 "destroying union op\n");
318 /* check if the op was canceled twice */
319 GNUNET_assert (NULL != op->state);
320 if (NULL != op->state->remote_ibf)
322 ibf_destroy (op->state->remote_ibf);
323 op->state->remote_ibf = NULL;
325 if (NULL != op->state->demanded_hashes)
327 GNUNET_CONTAINER_multihashmap_destroy (op->state->demanded_hashes);
328 op->state->demanded_hashes = NULL;
330 if (NULL != op->state->local_ibf)
332 ibf_destroy (op->state->local_ibf);
333 op->state->local_ibf = NULL;
335 if (NULL != op->state->se)
337 strata_estimator_destroy (op->state->se);
338 op->state->se = NULL;
340 if (NULL != op->state->key_to_element)
342 GNUNET_CONTAINER_multihashmap32_iterate (op->state->key_to_element,
343 &destroy_key_to_element_iter,
345 GNUNET_CONTAINER_multihashmap32_destroy (op->state->key_to_element);
346 op->state->key_to_element = NULL;
348 GNUNET_free (op->state);
350 LOG (GNUNET_ERROR_TYPE_DEBUG,
351 "destroying union op done\n");
356 * Inform the client that the union operation has failed,
357 * and proceed to destroy the evaluate operation.
359 * @param op the union operation to fail
362 fail_union_operation (struct Operation *op)
364 struct GNUNET_MQ_Envelope *ev;
365 struct GNUNET_SET_ResultMessage *msg;
367 LOG (GNUNET_ERROR_TYPE_WARNING,
368 "union operation failed\n");
369 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
370 msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
371 msg->request_id = htonl (op->client_request_id);
372 msg->element_type = htons (0);
373 GNUNET_MQ_send (op->set->cs->mq,
375 _GSS_operation_destroy (op, GNUNET_YES);
380 * Derive the IBF key from a hash code and
383 * @param src the hash code
384 * @return the derived IBF key
386 static struct IBF_Key
387 get_ibf_key (const struct GNUNET_HashCode *src)
392 GNUNET_assert (GNUNET_OK ==
393 GNUNET_CRYPTO_kdf (&key, sizeof (key),
395 &salt, sizeof (salt),
402 * Context for #op_get_element_iterator
404 struct GetElementContext
409 struct GNUNET_HashCode hash;
419 * Iterator over the mapping from IBF keys to element entries. Checks if we
420 * have an element with a given GNUNET_HashCode.
423 * @param key current key code
424 * @param value value in the hash map
425 * @return #GNUNET_YES if we should search further,
426 * #GNUNET_NO if we've found the element.
429 op_get_element_iterator (void *cls,
433 struct GetElementContext *ctx = cls;
434 struct KeyEntry *k = value;
436 GNUNET_assert (NULL != k);
437 if (0 == GNUNET_CRYPTO_hash_cmp (&k->element->element_hash,
448 * Determine whether the given element is already in the operation's element
451 * @param op operation that should be tested for 'element_hash'
452 * @param element_hash hash of the element to look for
453 * @return #GNUNET_YES if the element has been found, #GNUNET_NO otherwise
455 static struct KeyEntry *
456 op_get_element (struct Operation *op,
457 const struct GNUNET_HashCode *element_hash)
460 struct IBF_Key ibf_key;
461 struct GetElementContext ctx = {{{ 0 }} , 0};
463 ctx.hash = *element_hash;
465 ibf_key = get_ibf_key (element_hash);
466 ret = GNUNET_CONTAINER_multihashmap32_get_multiple (op->state->key_to_element,
467 (uint32_t) ibf_key.key_val,
468 op_get_element_iterator,
471 /* was the iteration aborted because we found the element? */
472 if (GNUNET_SYSERR == ret)
474 GNUNET_assert (NULL != ctx.k);
482 * Insert an element into the union operation's
483 * key-to-element mapping. Takes ownership of 'ee'.
484 * Note that this does not insert the element in the set,
485 * only in the operation's key-element mapping.
486 * This is done to speed up re-tried operations, if some elements
487 * were transmitted, and then the IBF fails to decode.
489 * XXX: clarify ownership, doesn't sound right.
491 * @param op the union operation
492 * @param ee the element entry
493 * @parem received was this element received from the remote peer?
496 op_register_element (struct Operation *op,
497 struct ElementEntry *ee,
500 struct IBF_Key ibf_key;
503 ibf_key = get_ibf_key (&ee->element_hash);
504 k = GNUNET_new (struct KeyEntry);
506 k->ibf_key = ibf_key;
507 k->received = received;
508 GNUNET_assert (GNUNET_OK ==
509 GNUNET_CONTAINER_multihashmap32_put (op->state->key_to_element,
510 (uint32_t) ibf_key.key_val,
512 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
520 salt_key (const struct IBF_Key *k_in,
522 struct IBF_Key *k_out)
525 uint64_t x = k_in->key_val;
527 x = (x >> s) | (x << (64 - s));
536 unsalt_key (const struct IBF_Key *k_in,
538 struct IBF_Key *k_out)
541 uint64_t x = k_in->key_val;
542 x = (x << s) | (x >> (64 - s));
548 * Insert a key into an ibf.
552 * @param value the key entry to get the key from
555 prepare_ibf_iterator (void *cls,
559 struct Operation *op = cls;
560 struct KeyEntry *ke = value;
561 struct IBF_Key salted_key;
563 LOG (GNUNET_ERROR_TYPE_DEBUG,
564 "[OP %x] inserting %lx (hash %s) into ibf\n",
566 (unsigned long) ke->ibf_key.key_val,
567 GNUNET_h2s (&ke->element->element_hash));
568 salt_key (&ke->ibf_key,
569 op->state->salt_send,
571 ibf_insert (op->state->local_ibf, salted_key);
577 * Iterator for initializing the
578 * key-to-element mapping of a union operation
580 * @param cls the union operation `struct Operation *`
582 * @param value the `struct ElementEntry *` to insert
583 * into the key-to-element mapping
584 * @return #GNUNET_YES (to continue iterating)
587 init_key_to_element_iterator (void *cls,
588 const struct GNUNET_HashCode *key,
591 struct Operation *op = cls;
592 struct ElementEntry *ee = value;
594 /* make sure that the element belongs to the set at the time
595 * of creating the operation */
597 _GSS_is_element_of_operation (ee,
600 GNUNET_assert (GNUNET_NO == ee->remote);
601 op_register_element (op,
609 * Initialize the IBF key to element mapping local to this set
612 * @param op the set union operation
615 initialize_key_to_element (struct Operation *op)
619 GNUNET_assert (NULL == op->state->key_to_element);
620 len = GNUNET_CONTAINER_multihashmap_size (op->set->content->elements);
621 op->state->key_to_element = GNUNET_CONTAINER_multihashmap32_create (len + 1);
622 GNUNET_CONTAINER_multihashmap_iterate (op->set->content->elements,
623 &init_key_to_element_iterator,
629 * Create an ibf with the operation's elements
630 * of the specified size
632 * @param op the union operation
633 * @param size size of the ibf to create
634 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
637 prepare_ibf (struct Operation *op,
640 GNUNET_assert (NULL != op->state->key_to_element);
642 if (NULL != op->state->local_ibf)
643 ibf_destroy (op->state->local_ibf);
644 op->state->local_ibf = ibf_create (size, SE_IBF_HASH_NUM);
645 if (NULL == op->state->local_ibf)
647 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
648 "Failed to allocate local IBF\n");
649 return GNUNET_SYSERR;
651 GNUNET_CONTAINER_multihashmap32_iterate (op->state->key_to_element,
652 &prepare_ibf_iterator,
659 * Send an ibf of appropriate size.
661 * Fragments the IBF into multiple messages if necessary.
663 * @param op the union operation
664 * @param ibf_order order of the ibf to send, size=2^order
665 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
668 send_ibf (struct Operation *op,
671 unsigned int buckets_sent = 0;
672 struct InvertibleBloomFilter *ibf;
675 prepare_ibf (op, 1<<ibf_order))
677 /* allocation failed */
678 return GNUNET_SYSERR;
681 LOG (GNUNET_ERROR_TYPE_DEBUG,
682 "sending ibf of size %u\n",
686 char name[64] = { 0 };
687 snprintf (name, sizeof (name), "# sent IBF (order %u)", ibf_order);
688 GNUNET_STATISTICS_update (_GSS_statistics, name, 1, GNUNET_NO);
691 ibf = op->state->local_ibf;
693 while (buckets_sent < (1 << ibf_order))
695 unsigned int buckets_in_message;
696 struct GNUNET_MQ_Envelope *ev;
697 struct IBFMessage *msg;
699 buckets_in_message = (1 << ibf_order) - buckets_sent;
700 /* limit to maximum */
701 if (buckets_in_message > MAX_BUCKETS_PER_MESSAGE)
702 buckets_in_message = MAX_BUCKETS_PER_MESSAGE;
704 ev = GNUNET_MQ_msg_extra (msg,
705 buckets_in_message * IBF_BUCKET_SIZE,
706 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF);
709 msg->order = ibf_order;
710 msg->offset = htonl (buckets_sent);
711 msg->salt = htonl (op->state->salt_send);
712 ibf_write_slice (ibf, buckets_sent,
713 buckets_in_message, &msg[1]);
714 buckets_sent += buckets_in_message;
715 LOG (GNUNET_ERROR_TYPE_DEBUG,
716 "ibf chunk size %u, %u/%u sent\n",
720 GNUNET_MQ_send (op->mq, ev);
723 /* The other peer must decode the IBF, so
725 op->state->phase = PHASE_INVENTORY_PASSIVE;
731 * Compute the necessary order of an ibf
732 * from the size of the symmetric set difference.
734 * @param diff the difference
735 * @return the required size of the ibf
738 get_order_from_difference (unsigned int diff)
740 unsigned int ibf_order;
743 while ( ( (1<<ibf_order) < (IBF_ALPHA * diff) ||
744 ((1<<ibf_order) < SE_IBF_HASH_NUM) ) &&
745 (ibf_order < MAX_IBF_ORDER) )
747 // add one for correction
748 return ibf_order + 1;
753 * Send a set element.
755 * @param cls the union operation `struct Operation *`
757 * @param value the `struct ElementEntry *` to insert
758 * into the key-to-element mapping
759 * @return #GNUNET_YES (to continue iterating)
762 send_full_element_iterator (void *cls,
763 const struct GNUNET_HashCode *key,
766 struct Operation *op = cls;
767 struct GNUNET_SET_ElementMessage *emsg;
768 struct ElementEntry *ee = value;
769 struct GNUNET_SET_Element *el = &ee->element;
770 struct GNUNET_MQ_Envelope *ev;
772 LOG (GNUNET_ERROR_TYPE_DEBUG,
773 "Sending element %s\n",
775 ev = GNUNET_MQ_msg_extra (emsg,
777 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_FULL_ELEMENT);
778 emsg->element_type = htons (el->element_type);
779 GNUNET_memcpy (&emsg[1],
782 GNUNET_MQ_send (op->mq,
789 * Switch to full set transmission for @a op.
791 * @param op operation to switch to full set transmission.
794 send_full_set (struct Operation *op)
796 struct GNUNET_MQ_Envelope *ev;
798 op->state->phase = PHASE_FULL_SENDING;
799 LOG (GNUNET_ERROR_TYPE_DEBUG,
800 "Dedicing to transmit the full set\n");
801 /* FIXME: use a more memory-friendly way of doing this with an
802 iterator, just as we do in the non-full case! */
803 (void) GNUNET_CONTAINER_multihashmap_iterate (op->set->content->elements,
804 &send_full_element_iterator,
806 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_FULL_DONE);
807 GNUNET_MQ_send (op->mq,
813 * Handle a strata estimator from a remote peer
815 * @param cls the union operation
816 * @param msg the message
819 check_union_p2p_strata_estimator (void *cls,
820 const struct StrataEstimatorMessage *msg)
822 struct Operation *op = cls;
826 if (op->state->phase != PHASE_EXPECT_SE)
829 return GNUNET_SYSERR;
831 is_compressed = (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SEC == htons (msg->header.type));
832 len = ntohs (msg->header.size) - sizeof (struct StrataEstimatorMessage);
833 if ( (GNUNET_NO == is_compressed) &&
834 (len != SE_STRATA_COUNT * SE_IBF_SIZE * IBF_BUCKET_SIZE) )
837 return GNUNET_SYSERR;
844 * Handle a strata estimator from a remote peer
846 * @param cls the union operation
847 * @param msg the message
850 handle_union_p2p_strata_estimator (void *cls,
851 const struct StrataEstimatorMessage *msg)
853 struct Operation *op = cls;
854 struct StrataEstimator *remote_se;
860 is_compressed = (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SEC == htons (msg->header.type));
861 GNUNET_STATISTICS_update (_GSS_statistics,
862 "# bytes of SE received",
863 ntohs (msg->header.size),
865 len = ntohs (msg->header.size) - sizeof (struct StrataEstimatorMessage);
866 other_size = GNUNET_ntohll (msg->set_size);
867 remote_se = strata_estimator_create (SE_STRATA_COUNT,
870 if (NULL == remote_se)
872 /* insufficient resources, fail */
873 fail_union_operation (op);
877 strata_estimator_read (&msg[1],
882 /* decompression failed */
883 strata_estimator_destroy (remote_se);
884 fail_union_operation (op);
887 GNUNET_assert (NULL != op->state->se);
888 diff = strata_estimator_difference (remote_se,
894 strata_estimator_destroy (remote_se);
895 strata_estimator_destroy (op->state->se);
896 op->state->se = NULL;
897 LOG (GNUNET_ERROR_TYPE_DEBUG,
898 "got se diff=%d, using ibf size %d\n",
900 1U << get_order_from_difference (diff));
905 set_debug = getenv ("GNUNET_SET_BENCHMARK");
906 if ( (NULL != set_debug) &&
907 (0 == strcmp (set_debug, "1")) )
909 FILE *f = fopen ("set.log", "a");
910 fprintf (f, "%llu\n", (unsigned long long) diff);
915 if ( (GNUNET_YES == op->byzantine) &&
916 (other_size < op->byzantine_lower_bound) )
919 fail_union_operation (op);
923 if ( (GNUNET_YES == op->force_full) ||
924 (diff > op->state->initial_size / 4) ||
927 LOG (GNUNET_ERROR_TYPE_DEBUG,
928 "Deciding to go for full set transmission (diff=%d, own set=%u)\n",
930 op->state->initial_size);
931 GNUNET_STATISTICS_update (_GSS_statistics,
935 if ( (op->state->initial_size <= other_size) ||
942 struct GNUNET_MQ_Envelope *ev;
944 LOG (GNUNET_ERROR_TYPE_DEBUG,
945 "Telling other peer that we expect its full set\n");
946 op->state->phase = PHASE_EXPECT_IBF;
947 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_REQUEST_FULL);
948 GNUNET_MQ_send (op->mq,
954 GNUNET_STATISTICS_update (_GSS_statistics,
960 get_order_from_difference (diff)))
962 /* Internal error, best we can do is shut the connection */
963 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
964 "Failed to send IBF, closing connection\n");
965 fail_union_operation (op);
969 GNUNET_CADET_receive_done (op->channel);
974 * Iterator to send elements to a remote peer
976 * @param cls closure with the element key and the union operation
978 * @param value the key entry
981 send_offers_iterator (void *cls,
985 struct SendElementClosure *sec = cls;
986 struct Operation *op = sec->op;
987 struct KeyEntry *ke = value;
988 struct GNUNET_MQ_Envelope *ev;
989 struct GNUNET_MessageHeader *mh;
991 /* Detect 32-bit key collision for the 64-bit IBF keys. */
992 if (ke->ibf_key.key_val != sec->ibf_key.key_val)
995 ev = GNUNET_MQ_msg_header_extra (mh,
996 sizeof (struct GNUNET_HashCode),
997 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_OFFER);
999 GNUNET_assert (NULL != ev);
1000 *(struct GNUNET_HashCode *) &mh[1] = ke->element->element_hash;
1001 LOG (GNUNET_ERROR_TYPE_DEBUG,
1002 "[OP %x] sending element offer (%s) to peer\n",
1004 GNUNET_h2s (&ke->element->element_hash));
1005 GNUNET_MQ_send (op->mq, ev);
1011 * Send offers (in the form of GNUNET_Hash-es) to the remote peer for the given IBF key.
1013 * @param op union operation
1014 * @param ibf_key IBF key of interest
1017 send_offers_for_key (struct Operation *op,
1018 struct IBF_Key ibf_key)
1020 struct SendElementClosure send_cls;
1022 send_cls.ibf_key = ibf_key;
1024 (void) GNUNET_CONTAINER_multihashmap32_get_multiple (op->state->key_to_element,
1025 (uint32_t) ibf_key.key_val,
1026 &send_offers_iterator,
1032 * Decode which elements are missing on each side, and
1033 * send the appropriate offers and inquiries.
1035 * @param op union operation
1036 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1039 decode_and_send (struct Operation *op)
1042 struct IBF_Key last_key;
1044 unsigned int num_decoded;
1045 struct InvertibleBloomFilter *diff_ibf;
1047 GNUNET_assert (PHASE_INVENTORY_ACTIVE == op->state->phase);
1051 op->state->remote_ibf->size))
1054 /* allocation failed */
1055 return GNUNET_SYSERR;
1057 diff_ibf = ibf_dup (op->state->local_ibf);
1058 ibf_subtract (diff_ibf,
1059 op->state->remote_ibf);
1061 ibf_destroy (op->state->remote_ibf);
1062 op->state->remote_ibf = NULL;
1064 LOG (GNUNET_ERROR_TYPE_DEBUG,
1065 "decoding IBF (size=%u)\n",
1069 key.key_val = 0; /* just to avoid compiler thinking we use undef'ed variable */
1074 int cycle_detected = GNUNET_NO;
1078 res = ibf_decode (diff_ibf, &side, &key);
1079 if (res == GNUNET_OK)
1081 LOG (GNUNET_ERROR_TYPE_DEBUG,
1082 "decoded ibf key %lx\n",
1083 (unsigned long) key.key_val);
1085 if ( (num_decoded > diff_ibf->size) ||
1086 ( (num_decoded > 1) &&
1087 (last_key.key_val == key.key_val) ) )
1089 LOG (GNUNET_ERROR_TYPE_DEBUG,
1090 "detected cyclic ibf (decoded %u/%u)\n",
1093 cycle_detected = GNUNET_YES;
1096 if ( (GNUNET_SYSERR == res) ||
1097 (GNUNET_YES == cycle_detected) )
1101 while (1<<next_order < diff_ibf->size)
1104 if (next_order <= MAX_IBF_ORDER)
1106 LOG (GNUNET_ERROR_TYPE_DEBUG,
1107 "decoding failed, sending larger ibf (size %u)\n",
1109 GNUNET_STATISTICS_update (_GSS_statistics,
1113 op->state->salt_send++;
1115 send_ibf (op, next_order))
1117 /* Internal error, best we can do is shut the connection */
1118 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1119 "Failed to send IBF, closing connection\n");
1120 fail_union_operation (op);
1121 ibf_destroy (diff_ibf);
1122 return GNUNET_SYSERR;
1127 GNUNET_STATISTICS_update (_GSS_statistics,
1128 "# of failed union operations (too large)",
1131 // XXX: Send the whole set, element-by-element
1132 LOG (GNUNET_ERROR_TYPE_ERROR,
1133 "set union failed: reached ibf limit\n");
1134 fail_union_operation (op);
1135 ibf_destroy (diff_ibf);
1136 return GNUNET_SYSERR;
1140 if (GNUNET_NO == res)
1142 struct GNUNET_MQ_Envelope *ev;
1144 LOG (GNUNET_ERROR_TYPE_DEBUG,
1145 "transmitted all values, sending DONE\n");
1146 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DONE);
1147 GNUNET_MQ_send (op->mq, ev);
1148 /* We now wait until we get a DONE message back
1149 * and then wait for our MQ to be flushed and all our
1150 * demands be delivered. */
1155 struct IBF_Key unsalted_key;
1158 op->state->salt_receive,
1160 send_offers_for_key (op,
1163 else if (-1 == side)
1165 struct GNUNET_MQ_Envelope *ev;
1166 struct InquiryMessage *msg;
1168 /* It may be nice to merge multiple requests, but with CADET's corking it is not worth
1169 * the effort additional complexity. */
1170 ev = GNUNET_MQ_msg_extra (msg,
1171 sizeof (struct IBF_Key),
1172 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_INQUIRY);
1173 msg->salt = htonl (op->state->salt_receive);
1174 GNUNET_memcpy (&msg[1],
1176 sizeof (struct IBF_Key));
1177 LOG (GNUNET_ERROR_TYPE_DEBUG,
1178 "sending element inquiry for IBF key %lx\n",
1179 (unsigned long) key.key_val);
1180 GNUNET_MQ_send (op->mq, ev);
1187 ibf_destroy (diff_ibf);
1193 * Check an IBF message from a remote peer.
1195 * Reassemble the IBF from multiple pieces, and
1196 * process the whole IBF once possible.
1198 * @param cls the union operation
1199 * @param msg the header of the message
1200 * @return #GNUNET_OK if @a msg is well-formed
1203 check_union_p2p_ibf (void *cls,
1204 const struct IBFMessage *msg)
1206 struct Operation *op = cls;
1207 unsigned int buckets_in_message;
1209 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1211 GNUNET_break_op (0);
1212 return GNUNET_SYSERR;
1214 buckets_in_message = (ntohs (msg->header.size) - sizeof *msg) / IBF_BUCKET_SIZE;
1215 if (0 == buckets_in_message)
1217 GNUNET_break_op (0);
1218 return GNUNET_SYSERR;
1220 if ((ntohs (msg->header.size) - sizeof *msg) != buckets_in_message * IBF_BUCKET_SIZE)
1222 GNUNET_break_op (0);
1223 return GNUNET_SYSERR;
1225 if (op->state->phase == PHASE_EXPECT_IBF_CONT)
1227 if (ntohl (msg->offset) != op->state->ibf_buckets_received)
1229 GNUNET_break_op (0);
1230 return GNUNET_SYSERR;
1232 if (1<<msg->order != op->state->remote_ibf->size)
1234 GNUNET_break_op (0);
1235 return GNUNET_SYSERR;
1237 if (ntohl (msg->salt) != op->state->salt_receive)
1239 GNUNET_break_op (0);
1240 return GNUNET_SYSERR;
1243 else if ( (op->state->phase != PHASE_INVENTORY_PASSIVE) &&
1244 (op->state->phase != PHASE_EXPECT_IBF) )
1246 GNUNET_break_op (0);
1247 return GNUNET_SYSERR;
1255 * Handle an IBF message from a remote peer.
1257 * Reassemble the IBF from multiple pieces, and
1258 * process the whole IBF once possible.
1260 * @param cls the union operation
1261 * @param msg the header of the message
1264 handle_union_p2p_ibf (void *cls,
1265 const struct IBFMessage *msg)
1267 struct Operation *op = cls;
1268 unsigned int buckets_in_message;
1270 buckets_in_message = (ntohs (msg->header.size) - sizeof *msg) / IBF_BUCKET_SIZE;
1271 if ( (op->state->phase == PHASE_INVENTORY_PASSIVE) ||
1272 (op->state->phase == PHASE_EXPECT_IBF) )
1274 op->state->phase = PHASE_EXPECT_IBF_CONT;
1275 GNUNET_assert (NULL == op->state->remote_ibf);
1276 LOG (GNUNET_ERROR_TYPE_DEBUG,
1277 "Creating new ibf of size %u\n",
1279 op->state->remote_ibf = ibf_create (1<<msg->order, SE_IBF_HASH_NUM);
1280 op->state->salt_receive = ntohl (msg->salt);
1281 LOG (GNUNET_ERROR_TYPE_DEBUG,
1282 "Receiving new IBF with salt %u\n",
1283 op->state->salt_receive);
1284 if (NULL == op->state->remote_ibf)
1286 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1287 "Failed to parse remote IBF, closing connection\n");
1288 fail_union_operation (op);
1291 op->state->ibf_buckets_received = 0;
1292 if (0 != ntohl (msg->offset))
1294 GNUNET_break_op (0);
1295 fail_union_operation (op);
1301 GNUNET_assert (op->state->phase == PHASE_EXPECT_IBF_CONT);
1302 LOG (GNUNET_ERROR_TYPE_DEBUG,
1303 "Received more of IBF\n");
1305 GNUNET_assert (NULL != op->state->remote_ibf);
1307 ibf_read_slice (&msg[1],
1308 op->state->ibf_buckets_received,
1310 op->state->remote_ibf);
1311 op->state->ibf_buckets_received += buckets_in_message;
1313 if (op->state->ibf_buckets_received == op->state->remote_ibf->size)
1315 LOG (GNUNET_ERROR_TYPE_DEBUG,
1316 "received full ibf\n");
1317 op->state->phase = PHASE_INVENTORY_ACTIVE;
1319 decode_and_send (op))
1321 /* Internal error, best we can do is shut down */
1322 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1323 "Failed to decode IBF, closing connection\n");
1324 fail_union_operation (op);
1328 GNUNET_CADET_receive_done (op->channel);
1333 * Send a result message to the client indicating
1334 * that there is a new element.
1336 * @param op union operation
1337 * @param element element to send
1338 * @param status status to send with the new element
1341 send_client_element (struct Operation *op,
1342 struct GNUNET_SET_Element *element,
1345 struct GNUNET_MQ_Envelope *ev;
1346 struct GNUNET_SET_ResultMessage *rm;
1348 LOG (GNUNET_ERROR_TYPE_DEBUG,
1349 "sending element (size %u) to client\n",
1351 GNUNET_assert (0 != op->client_request_id);
1352 ev = GNUNET_MQ_msg_extra (rm, element->size, GNUNET_MESSAGE_TYPE_SET_RESULT);
1355 GNUNET_MQ_discard (ev);
1359 rm->result_status = htons (status);
1360 rm->request_id = htonl (op->client_request_id);
1361 rm->element_type = htons (element->element_type);
1362 rm->current_size = GNUNET_htonll (GNUNET_CONTAINER_multihashmap32_size (op->state->key_to_element));
1363 GNUNET_memcpy (&rm[1],
1366 GNUNET_MQ_send (op->set->cs->mq,
1372 * Destroy remote channel.
1374 * @param op operation
1377 destroy_channel (struct Operation *op)
1379 struct GNUNET_CADET_Channel *channel;
1381 if (NULL != (channel = op->channel))
1383 /* This will free op; called conditionally as this helper function
1384 is also called from within the channel disconnect handler. */
1386 GNUNET_CADET_channel_destroy (channel);
1392 * Signal to the client that the operation has finished and
1393 * destroy the operation.
1395 * @param cls operation to destroy
1398 send_client_done (void *cls)
1400 struct Operation *op = cls;
1401 struct GNUNET_MQ_Envelope *ev;
1402 struct GNUNET_SET_ResultMessage *rm;
1404 if (GNUNET_YES == op->state->client_done_sent)
1409 if (PHASE_DONE != op->state->phase) {
1410 LOG (GNUNET_ERROR_TYPE_WARNING,
1411 "Union operation failed\n");
1412 GNUNET_STATISTICS_update (_GSS_statistics,
1413 "# Union operations failed",
1416 ev = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
1417 rm->result_status = htons (GNUNET_SET_STATUS_FAILURE);
1418 rm->request_id = htonl (op->client_request_id);
1419 rm->element_type = htons (0);
1420 GNUNET_MQ_send (op->set->cs->mq,
1425 op->state->client_done_sent = GNUNET_YES;
1427 GNUNET_STATISTICS_update (_GSS_statistics,
1428 "# Union operations succeeded",
1431 LOG (GNUNET_ERROR_TYPE_INFO,
1432 "Signalling client that union operation is done\n");
1433 ev = GNUNET_MQ_msg (rm,
1434 GNUNET_MESSAGE_TYPE_SET_RESULT);
1435 rm->request_id = htonl (op->client_request_id);
1436 rm->result_status = htons (GNUNET_SET_STATUS_DONE);
1437 rm->element_type = htons (0);
1438 rm->current_size = GNUNET_htonll (GNUNET_CONTAINER_multihashmap32_size (op->state->key_to_element));
1439 GNUNET_MQ_send (op->set->cs->mq,
1445 * Tests if the operation is finished, and if so notify.
1447 * @param op operation to check
1450 maybe_finish (struct Operation *op)
1452 unsigned int num_demanded;
1454 num_demanded = GNUNET_CONTAINER_multihashmap_size (op->state->demanded_hashes);
1456 if (PHASE_FINISH_WAITING == op->state->phase)
1458 LOG (GNUNET_ERROR_TYPE_DEBUG,
1459 "In PHASE_FINISH_WAITING, pending %u demands\n",
1461 if (0 == num_demanded)
1463 struct GNUNET_MQ_Envelope *ev;
1465 op->state->phase = PHASE_DONE;
1466 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DONE);
1467 GNUNET_MQ_send (op->mq,
1469 /* We now wait until the other peer sends P2P_OVER
1470 * after it got all elements from us. */
1473 if (PHASE_FINISH_CLOSING == op->state->phase)
1475 LOG (GNUNET_ERROR_TYPE_DEBUG,
1476 "In PHASE_FINISH_CLOSING, pending %u demands\n",
1478 if (0 == num_demanded)
1480 op->state->phase = PHASE_DONE;
1481 send_client_done (op);
1482 _GSS_operation_destroy2 (op);
1489 * Check an element message from a remote peer.
1491 * @param cls the union operation
1492 * @param emsg the message
1495 check_union_p2p_elements (void *cls,
1496 const struct GNUNET_SET_ElementMessage *emsg)
1498 struct Operation *op = cls;
1500 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1502 GNUNET_break_op (0);
1503 return GNUNET_SYSERR;
1505 if (0 == GNUNET_CONTAINER_multihashmap_size (op->state->demanded_hashes))
1507 GNUNET_break_op (0);
1508 return GNUNET_SYSERR;
1515 * Handle an element message from a remote peer.
1516 * Sent by the other peer either because we decoded an IBF and placed a demand,
1517 * or because the other peer switched to full set transmission.
1519 * @param cls the union operation
1520 * @param emsg the message
1523 handle_union_p2p_elements (void *cls,
1524 const struct GNUNET_SET_ElementMessage *emsg)
1526 struct Operation *op = cls;
1527 struct ElementEntry *ee;
1528 struct KeyEntry *ke;
1529 uint16_t element_size;
1531 element_size = ntohs (emsg->header.size) - sizeof (struct GNUNET_SET_ElementMessage);
1532 ee = GNUNET_malloc (sizeof (struct ElementEntry) + element_size);
1533 GNUNET_memcpy (&ee[1],
1536 ee->element.size = element_size;
1537 ee->element.data = &ee[1];
1538 ee->element.element_type = ntohs (emsg->element_type);
1539 ee->remote = GNUNET_YES;
1540 GNUNET_SET_element_hash (&ee->element,
1543 GNUNET_CONTAINER_multihashmap_remove (op->state->demanded_hashes,
1547 /* We got something we didn't demand, since it's not in our map. */
1548 GNUNET_break_op (0);
1549 fail_union_operation (op);
1553 LOG (GNUNET_ERROR_TYPE_DEBUG,
1554 "Got element (size %u, hash %s) from peer\n",
1555 (unsigned int) element_size,
1556 GNUNET_h2s (&ee->element_hash));
1558 GNUNET_STATISTICS_update (_GSS_statistics,
1559 "# received elements",
1562 GNUNET_STATISTICS_update (_GSS_statistics,
1563 "# exchanged elements",
1567 op->state->received_total++;
1569 ke = op_get_element (op, &ee->element_hash);
1572 /* Got repeated element. Should not happen since
1573 * we track demands. */
1574 GNUNET_STATISTICS_update (_GSS_statistics,
1575 "# repeated elements",
1578 ke->received = GNUNET_YES;
1583 LOG (GNUNET_ERROR_TYPE_DEBUG,
1584 "Registering new element from remote peer\n");
1585 op->state->received_fresh++;
1586 op_register_element (op, ee, GNUNET_YES);
1587 /* only send results immediately if the client wants it */
1588 switch (op->result_mode)
1590 case GNUNET_SET_RESULT_ADDED:
1591 send_client_element (op, &ee->element, GNUNET_SET_STATUS_OK);
1593 case GNUNET_SET_RESULT_SYMMETRIC:
1594 send_client_element (op, &ee->element, GNUNET_SET_STATUS_ADD_LOCAL);
1597 /* Result mode not supported, should have been caught earlier. */
1603 if ( (op->state->received_total > 8) &&
1604 (op->state->received_fresh < op->state->received_total / 3) )
1606 /* The other peer gave us lots of old elements, there's something wrong. */
1607 GNUNET_break_op (0);
1608 fail_union_operation (op);
1611 GNUNET_CADET_receive_done (op->channel);
1617 * Check a full element message from a remote peer.
1619 * @param cls the union operation
1620 * @param emsg the message
1623 check_union_p2p_full_element (void *cls,
1624 const struct GNUNET_SET_ElementMessage *emsg)
1626 struct Operation *op = cls;
1628 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1630 GNUNET_break_op (0);
1631 return GNUNET_SYSERR;
1633 // FIXME: check that we expect full elements here?
1639 * Handle an element message from a remote peer.
1641 * @param cls the union operation
1642 * @param emsg the message
1645 handle_union_p2p_full_element (void *cls,
1646 const struct GNUNET_SET_ElementMessage *emsg)
1648 struct Operation *op = cls;
1649 struct ElementEntry *ee;
1650 struct KeyEntry *ke;
1651 uint16_t element_size;
1653 element_size = ntohs (emsg->header.size) - sizeof (struct GNUNET_SET_ElementMessage);
1654 ee = GNUNET_malloc (sizeof (struct ElementEntry) + element_size);
1655 GNUNET_memcpy (&ee[1], &emsg[1], element_size);
1656 ee->element.size = element_size;
1657 ee->element.data = &ee[1];
1658 ee->element.element_type = ntohs (emsg->element_type);
1659 ee->remote = GNUNET_YES;
1660 GNUNET_SET_element_hash (&ee->element, &ee->element_hash);
1662 LOG (GNUNET_ERROR_TYPE_DEBUG,
1663 "Got element (full diff, size %u, hash %s) from peer\n",
1664 (unsigned int) element_size,
1665 GNUNET_h2s (&ee->element_hash));
1667 GNUNET_STATISTICS_update (_GSS_statistics,
1668 "# received elements",
1671 GNUNET_STATISTICS_update (_GSS_statistics,
1672 "# exchanged elements",
1676 op->state->received_total++;
1678 ke = op_get_element (op, &ee->element_hash);
1681 /* Got repeated element. Should not happen since
1682 * we track demands. */
1683 GNUNET_STATISTICS_update (_GSS_statistics,
1684 "# repeated elements",
1687 ke->received = GNUNET_YES;
1692 LOG (GNUNET_ERROR_TYPE_DEBUG,
1693 "Registering new element from remote peer\n");
1694 op->state->received_fresh++;
1695 op_register_element (op, ee, GNUNET_YES);
1696 /* only send results immediately if the client wants it */
1697 switch (op->result_mode)
1699 case GNUNET_SET_RESULT_ADDED:
1700 send_client_element (op, &ee->element, GNUNET_SET_STATUS_OK);
1702 case GNUNET_SET_RESULT_SYMMETRIC:
1703 send_client_element (op, &ee->element, GNUNET_SET_STATUS_ADD_LOCAL);
1706 /* Result mode not supported, should have been caught earlier. */
1712 if ( (GNUNET_YES == op->byzantine) &&
1713 (op->state->received_total > 384 + op->state->received_fresh * 4) &&
1714 (op->state->received_fresh < op->state->received_total / 6) )
1716 /* The other peer gave us lots of old elements, there's something wrong. */
1717 LOG (GNUNET_ERROR_TYPE_ERROR,
1718 "Other peer sent only %llu/%llu fresh elements, failing operation\n",
1719 (unsigned long long) op->state->received_fresh,
1720 (unsigned long long) op->state->received_total);
1721 GNUNET_break_op (0);
1722 fail_union_operation (op);
1725 GNUNET_CADET_receive_done (op->channel);
1730 * Send offers (for GNUNET_Hash-es) in response
1731 * to inquiries (for IBF_Key-s).
1733 * @param cls the union operation
1734 * @param msg the message
1737 check_union_p2p_inquiry (void *cls,
1738 const struct InquiryMessage *msg)
1740 struct Operation *op = cls;
1741 unsigned int num_keys;
1743 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1745 GNUNET_break_op (0);
1746 return GNUNET_SYSERR;
1748 if (op->state->phase != PHASE_INVENTORY_PASSIVE)
1750 GNUNET_break_op (0);
1751 return GNUNET_SYSERR;
1753 num_keys = (ntohs (msg->header.size) - sizeof (struct InquiryMessage))
1754 / sizeof (struct IBF_Key);
1755 if ((ntohs (msg->header.size) - sizeof (struct InquiryMessage))
1756 != num_keys * sizeof (struct IBF_Key))
1758 GNUNET_break_op (0);
1759 return GNUNET_SYSERR;
1766 * Send offers (for GNUNET_Hash-es) in response
1767 * to inquiries (for IBF_Key-s).
1769 * @param cls the union operation
1770 * @param msg the message
1773 handle_union_p2p_inquiry (void *cls,
1774 const struct InquiryMessage *msg)
1776 struct Operation *op = cls;
1777 const struct IBF_Key *ibf_key;
1778 unsigned int num_keys;
1780 LOG (GNUNET_ERROR_TYPE_DEBUG,
1781 "Received union inquiry\n");
1782 num_keys = (ntohs (msg->header.size) - sizeof (struct InquiryMessage))
1783 / sizeof (struct IBF_Key);
1784 ibf_key = (const struct IBF_Key *) &msg[1];
1785 while (0 != num_keys--)
1787 struct IBF_Key unsalted_key;
1789 unsalt_key (ibf_key,
1792 send_offers_for_key (op,
1796 GNUNET_CADET_receive_done (op->channel);
1801 * Iterator over hash map entries, called to
1802 * destroy the linked list of colliding ibf key entries.
1804 * @param cls closure
1805 * @param key current key code
1806 * @param value value in the hash map
1807 * @return #GNUNET_YES if we should continue to iterate,
1808 * #GNUNET_NO if not.
1811 send_missing_full_elements_iter (void *cls,
1815 struct Operation *op = cls;
1816 struct KeyEntry *ke = value;
1817 struct GNUNET_MQ_Envelope *ev;
1818 struct GNUNET_SET_ElementMessage *emsg;
1819 struct ElementEntry *ee = ke->element;
1821 if (GNUNET_YES == ke->received)
1823 ev = GNUNET_MQ_msg_extra (emsg,
1825 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_FULL_ELEMENT);
1826 GNUNET_memcpy (&emsg[1],
1829 emsg->element_type = htons (ee->element.element_type);
1830 GNUNET_MQ_send (op->mq,
1837 * Handle a request for full set transmission.
1839 * @parem cls closure, a set union operation
1840 * @param mh the demand message
1843 handle_union_p2p_request_full (void *cls,
1844 const struct GNUNET_MessageHeader *mh)
1846 struct Operation *op = cls;
1848 LOG (GNUNET_ERROR_TYPE_DEBUG,
1849 "Received request for full set transmission\n");
1850 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1852 GNUNET_break_op (0);
1853 fail_union_operation (op);
1856 if (PHASE_EXPECT_IBF != op->state->phase)
1858 GNUNET_break_op (0);
1859 fail_union_operation (op);
1863 // FIXME: we need to check that our set is larger than the
1864 // byzantine_lower_bound by some threshold
1866 GNUNET_CADET_receive_done (op->channel);
1871 * Handle a "full done" message.
1873 * @parem cls closure, a set union operation
1874 * @param mh the demand message
1877 handle_union_p2p_full_done (void *cls,
1878 const struct GNUNET_MessageHeader *mh)
1880 struct Operation *op = cls;
1882 switch (op->state->phase)
1884 case PHASE_EXPECT_IBF:
1886 struct GNUNET_MQ_Envelope *ev;
1888 LOG (GNUNET_ERROR_TYPE_DEBUG,
1889 "got FULL DONE, sending elements that other peer is missing\n");
1891 /* send all the elements that did not come from the remote peer */
1892 GNUNET_CONTAINER_multihashmap32_iterate (op->state->key_to_element,
1893 &send_missing_full_elements_iter,
1896 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_UNION_P2P_FULL_DONE);
1897 GNUNET_MQ_send (op->mq,
1899 op->state->phase = PHASE_DONE;
1900 /* we now wait until the other peer sends us the OVER message*/
1903 case PHASE_FULL_SENDING:
1905 LOG (GNUNET_ERROR_TYPE_DEBUG,
1906 "got FULL DONE, finishing\n");
1907 /* We sent the full set, and got the response for that. We're done. */
1908 op->state->phase = PHASE_DONE;
1909 GNUNET_CADET_receive_done (op->channel);
1910 send_client_done (op);
1911 _GSS_operation_destroy2 (op);
1916 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1917 "Handle full done phase is %u\n",
1918 (unsigned) op->state->phase);
1919 GNUNET_break_op (0);
1920 fail_union_operation (op);
1923 GNUNET_CADET_receive_done (op->channel);
1928 * Check a demand by the other peer for elements based on a list
1929 * of `struct GNUNET_HashCode`s.
1931 * @parem cls closure, a set union operation
1932 * @param mh the demand message
1933 * @return #GNUNET_OK if @a mh is well-formed
1936 check_union_p2p_demand (void *cls,
1937 const struct GNUNET_MessageHeader *mh)
1939 struct Operation *op = cls;
1940 unsigned int num_hashes;
1942 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
1944 GNUNET_break_op (0);
1945 return GNUNET_SYSERR;
1947 num_hashes = (ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
1948 / sizeof (struct GNUNET_HashCode);
1949 if ((ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
1950 != num_hashes * sizeof (struct GNUNET_HashCode))
1952 GNUNET_break_op (0);
1953 return GNUNET_SYSERR;
1960 * Handle a demand by the other peer for elements based on a list
1961 * of `struct GNUNET_HashCode`s.
1963 * @parem cls closure, a set union operation
1964 * @param mh the demand message
1967 handle_union_p2p_demand (void *cls,
1968 const struct GNUNET_MessageHeader *mh)
1970 struct Operation *op = cls;
1971 struct ElementEntry *ee;
1972 struct GNUNET_SET_ElementMessage *emsg;
1973 const struct GNUNET_HashCode *hash;
1974 unsigned int num_hashes;
1975 struct GNUNET_MQ_Envelope *ev;
1977 num_hashes = (ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
1978 / sizeof (struct GNUNET_HashCode);
1979 for (hash = (const struct GNUNET_HashCode *) &mh[1];
1981 hash++, num_hashes--)
1983 ee = GNUNET_CONTAINER_multihashmap_get (op->set->content->elements,
1987 /* Demand for non-existing element. */
1988 GNUNET_break_op (0);
1989 fail_union_operation (op);
1992 if (GNUNET_NO == _GSS_is_element_of_operation (ee, op))
1994 /* Probably confused lazily copied sets. */
1995 GNUNET_break_op (0);
1996 fail_union_operation (op);
1999 ev = GNUNET_MQ_msg_extra (emsg, ee->element.size, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS);
2000 GNUNET_memcpy (&emsg[1], ee->element.data, ee->element.size);
2001 emsg->reserved = htons (0);
2002 emsg->element_type = htons (ee->element.element_type);
2003 LOG (GNUNET_ERROR_TYPE_DEBUG,
2004 "[OP %x] Sending demanded element (size %u, hash %s) to peer\n",
2006 (unsigned int) ee->element.size,
2007 GNUNET_h2s (&ee->element_hash));
2008 GNUNET_MQ_send (op->mq, ev);
2009 GNUNET_STATISTICS_update (_GSS_statistics,
2010 "# exchanged elements",
2014 switch (op->result_mode)
2016 case GNUNET_SET_RESULT_ADDED:
2017 /* Nothing to do. */
2019 case GNUNET_SET_RESULT_SYMMETRIC:
2020 send_client_element (op, &ee->element, GNUNET_SET_STATUS_ADD_REMOTE);
2023 /* Result mode not supported, should have been caught earlier. */
2028 GNUNET_CADET_receive_done (op->channel);
2033 * Check offer (of `struct GNUNET_HashCode`s).
2035 * @param cls the union operation
2036 * @param mh the message
2037 * @return #GNUNET_OK if @a mh is well-formed
2040 check_union_p2p_offer (void *cls,
2041 const struct GNUNET_MessageHeader *mh)
2043 struct Operation *op = cls;
2044 unsigned int num_hashes;
2046 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
2048 GNUNET_break_op (0);
2049 return GNUNET_SYSERR;
2051 /* look up elements and send them */
2052 if ( (op->state->phase != PHASE_INVENTORY_PASSIVE) &&
2053 (op->state->phase != PHASE_INVENTORY_ACTIVE))
2055 GNUNET_break_op (0);
2056 return GNUNET_SYSERR;
2058 num_hashes = (ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
2059 / sizeof (struct GNUNET_HashCode);
2060 if ((ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader)) !=
2061 num_hashes * sizeof (struct GNUNET_HashCode))
2063 GNUNET_break_op (0);
2064 return GNUNET_SYSERR;
2071 * Handle offers (of `struct GNUNET_HashCode`s) and
2072 * respond with demands (of `struct GNUNET_HashCode`s).
2074 * @param cls the union operation
2075 * @param mh the message
2078 handle_union_p2p_offer (void *cls,
2079 const struct GNUNET_MessageHeader *mh)
2081 struct Operation *op = cls;
2082 const struct GNUNET_HashCode *hash;
2083 unsigned int num_hashes;
2085 num_hashes = (ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader))
2086 / sizeof (struct GNUNET_HashCode);
2087 for (hash = (const struct GNUNET_HashCode *) &mh[1];
2089 hash++, num_hashes--)
2091 struct ElementEntry *ee;
2092 struct GNUNET_MessageHeader *demands;
2093 struct GNUNET_MQ_Envelope *ev;
2095 ee = GNUNET_CONTAINER_multihashmap_get (op->set->content->elements,
2098 if (GNUNET_YES == _GSS_is_element_of_operation (ee, op))
2102 GNUNET_CONTAINER_multihashmap_contains (op->state->demanded_hashes,
2105 LOG (GNUNET_ERROR_TYPE_DEBUG,
2106 "Skipped sending duplicate demand\n");
2110 GNUNET_assert (GNUNET_OK ==
2111 GNUNET_CONTAINER_multihashmap_put (op->state->demanded_hashes,
2114 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
2116 LOG (GNUNET_ERROR_TYPE_DEBUG,
2117 "[OP %x] Requesting element (hash %s)\n",
2118 (void *) op, GNUNET_h2s (hash));
2119 ev = GNUNET_MQ_msg_header_extra (demands,
2120 sizeof (struct GNUNET_HashCode),
2121 GNUNET_MESSAGE_TYPE_SET_UNION_P2P_DEMAND);
2122 GNUNET_memcpy (&demands[1],
2124 sizeof (struct GNUNET_HashCode));
2125 GNUNET_MQ_send (op->mq, ev);
2127 GNUNET_CADET_receive_done (op->channel);
2132 * Handle a done message from a remote peer
2134 * @param cls the union operation
2135 * @param mh the message
2138 handle_union_p2p_done (void *cls,
2139 const struct GNUNET_MessageHeader *mh)
2141 struct Operation *op = cls;
2143 if (GNUNET_SET_OPERATION_UNION != op->set->operation)
2145 GNUNET_break_op (0);
2146 fail_union_operation (op);
2149 switch (op->state->phase)
2151 case PHASE_INVENTORY_PASSIVE:
2152 /* We got all requests, but still have to send our elements in response. */
2153 op->state->phase = PHASE_FINISH_WAITING;
2155 LOG (GNUNET_ERROR_TYPE_DEBUG,
2156 "got DONE (as passive partner), waiting for our demands to be satisfied\n");
2157 /* The active peer is done sending offers
2158 * and inquiries. This means that all
2159 * our responses to that (demands and offers)
2160 * must be in flight (queued or in mesh).
2162 * We should notify the active peer once
2163 * all our demands are satisfied, so that the active
2164 * peer can quit if we gave it everything.
2166 GNUNET_CADET_receive_done (op->channel);
2169 case PHASE_INVENTORY_ACTIVE:
2170 LOG (GNUNET_ERROR_TYPE_DEBUG,
2171 "got DONE (as active partner), waiting to finish\n");
2172 /* All demands of the other peer are satisfied,
2173 * and we processed all offers, thus we know
2174 * exactly what our demands must be.
2176 * We'll close the channel
2177 * to the other peer once our demands are met.
2179 op->state->phase = PHASE_FINISH_CLOSING;
2180 GNUNET_CADET_receive_done (op->channel);
2184 GNUNET_break_op (0);
2185 fail_union_operation (op);
2191 * Handle a over message from a remote peer
2193 * @param cls the union operation
2194 * @param mh the message
2197 handle_union_p2p_over (void *cls,
2198 const struct GNUNET_MessageHeader *mh)
2200 send_client_done (cls);
2205 * Initiate operation to evaluate a set union with a remote peer.
2207 * @param op operation to perform (to be initialized)
2208 * @param opaque_context message to be transmitted to the listener
2209 * to convince it to accept, may be NULL
2211 static struct OperationState *
2212 union_evaluate (struct Operation *op,
2213 const struct GNUNET_MessageHeader *opaque_context)
2215 struct OperationState *state;
2216 struct GNUNET_MQ_Envelope *ev;
2217 struct OperationRequestMessage *msg;
2219 ev = GNUNET_MQ_msg_nested_mh (msg,
2220 GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST,
2224 /* the context message is too large */
2228 state = GNUNET_new (struct OperationState);
2229 state->demanded_hashes = GNUNET_CONTAINER_multihashmap_create (32,
2231 /* copy the current generation's strata estimator for this operation */
2232 state->se = strata_estimator_dup (op->set->state->se);
2233 /* we started the operation, thus we have to send the operation request */
2234 state->phase = PHASE_EXPECT_SE;
2235 state->salt_receive = state->salt_send = 42; // FIXME?????
2236 LOG (GNUNET_ERROR_TYPE_DEBUG,
2237 "Initiating union operation evaluation\n");
2238 GNUNET_STATISTICS_update (_GSS_statistics,
2239 "# of total union operations",
2242 GNUNET_STATISTICS_update (_GSS_statistics,
2243 "# of initiated union operations",
2246 msg->operation = htonl (GNUNET_SET_OPERATION_UNION);
2247 GNUNET_MQ_send (op->mq,
2250 if (NULL != opaque_context)
2251 LOG (GNUNET_ERROR_TYPE_DEBUG,
2252 "sent op request with context message\n");
2254 LOG (GNUNET_ERROR_TYPE_DEBUG,
2255 "sent op request without context message\n");
2258 initialize_key_to_element (op);
2259 state->initial_size = GNUNET_CONTAINER_multihashmap32_size (state->key_to_element);
2265 * Accept an union operation request from a remote peer.
2266 * Only initializes the private operation state.
2268 * @param op operation that will be accepted as a union operation
2270 static struct OperationState *
2271 union_accept (struct Operation *op)
2273 struct OperationState *state;
2274 const struct StrataEstimator *se;
2275 struct GNUNET_MQ_Envelope *ev;
2276 struct StrataEstimatorMessage *strata_msg;
2281 LOG (GNUNET_ERROR_TYPE_DEBUG,
2282 "accepting set union operation\n");
2283 GNUNET_STATISTICS_update (_GSS_statistics,
2284 "# of accepted union operations",
2287 GNUNET_STATISTICS_update (_GSS_statistics,
2288 "# of total union operations",
2292 state = GNUNET_new (struct OperationState);
2293 state->se = strata_estimator_dup (op->set->state->se);
2294 state->demanded_hashes = GNUNET_CONTAINER_multihashmap_create (32,
2296 state->salt_receive = state->salt_send = 42; // FIXME?????
2298 initialize_key_to_element (op);
2299 state->initial_size = GNUNET_CONTAINER_multihashmap32_size (state->key_to_element);
2301 /* kick off the operation */
2303 buf = GNUNET_malloc (se->strata_count * IBF_BUCKET_SIZE * se->ibf_size);
2304 len = strata_estimator_write (se,
2306 if (len < se->strata_count * IBF_BUCKET_SIZE * se->ibf_size)
2307 type = GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SEC;
2309 type = GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE;
2310 ev = GNUNET_MQ_msg_extra (strata_msg,
2313 GNUNET_memcpy (&strata_msg[1],
2317 strata_msg->set_size
2318 = GNUNET_htonll (GNUNET_CONTAINER_multihashmap_size (op->set->content->elements));
2319 GNUNET_MQ_send (op->mq,
2321 state->phase = PHASE_EXPECT_IBF;
2327 * Create a new set supporting the union operation
2329 * We maintain one strata estimator per set and then manipulate it over the
2330 * lifetime of the set, as recreating a strata estimator would be expensive.
2332 * @return the newly created set, NULL on error
2334 static struct SetState *
2335 union_set_create (void)
2337 struct SetState *set_state;
2339 LOG (GNUNET_ERROR_TYPE_DEBUG,
2340 "union set created\n");
2341 set_state = GNUNET_new (struct SetState);
2342 set_state->se = strata_estimator_create (SE_STRATA_COUNT,
2343 SE_IBF_SIZE, SE_IBF_HASH_NUM);
2344 if (NULL == set_state->se)
2346 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2347 "Failed to allocate strata estimator\n");
2348 GNUNET_free (set_state);
2356 * Add the element from the given element message to the set.
2358 * @param set_state state of the set want to add to
2359 * @param ee the element to add to the set
2362 union_add (struct SetState *set_state,
2363 struct ElementEntry *ee)
2365 strata_estimator_insert (set_state->se,
2366 get_ibf_key (&ee->element_hash));
2371 * Remove the element given in the element message from the set.
2372 * Only marks the element as removed, so that older set operations can still exchange it.
2374 * @param set_state state of the set to remove from
2375 * @param ee set element to remove
2378 union_remove (struct SetState *set_state,
2379 struct ElementEntry *ee)
2381 strata_estimator_remove (set_state->se,
2382 get_ibf_key (&ee->element_hash));
2387 * Destroy a set that supports the union operation.
2389 * @param set_state the set to destroy
2392 union_set_destroy (struct SetState *set_state)
2394 if (NULL != set_state->se)
2396 strata_estimator_destroy (set_state->se);
2397 set_state->se = NULL;
2399 GNUNET_free (set_state);
2404 * Copy union-specific set state.
2406 * @param state source state for copying the union state
2407 * @return a copy of the union-specific set state
2409 static struct SetState *
2410 union_copy_state (struct SetState *state)
2412 struct SetState *new_state;
2414 GNUNET_assert ( (NULL != state) &&
2415 (NULL != state->se) );
2416 new_state = GNUNET_new (struct SetState);
2417 new_state->se = strata_estimator_dup (state->se);
2424 * Handle case where channel went down for an operation.
2426 * @param op operation that lost the channel
2429 union_channel_death (struct Operation *op)
2431 send_client_done (op);
2432 _GSS_operation_destroy (op,
2438 * Get the table with implementing functions for
2441 * @return the operation specific VTable
2443 const struct SetVT *
2446 static const struct SetVT union_vt = {
2447 .create = &union_set_create,
2449 .remove = &union_remove,
2450 .destroy_set = &union_set_destroy,
2451 .evaluate = &union_evaluate,
2452 .accept = &union_accept,
2453 .cancel = &union_op_cancel,
2454 .copy_state = &union_copy_state,
2455 .channel_death = &union_channel_death