2 This file is part of GNUnet
3 (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.
22 * @file set/gnunet-service-set_intersection.c
23 * @brief two-peer set intersection
24 * @author Christian Fuchs
27 #include "gnunet_util_lib.h"
28 #include "gnunet-service-set.h"
29 #include "strata_estimator.h"
30 #include "set_protocol.h"
34 * Current phase we are in for a intersection operation.
36 enum IntersectionOperationPhase
39 * We get our tunnel but received no message as of now
43 * We expect a BF + the number of the other peers elements
47 * The protocol is over.
48 * Results may still have to be sent to the client.
55 * State of an evaluate operation
61 * Tunnel to the remote peer.
63 struct GNUNET_MESH_Tunnel *tunnel;
66 * Detail information about the set operation,
67 * including the set to use.
69 struct OperationSpecification *spec;
72 * Message queue for the peer.
74 struct GNUNET_MQ_Handle *mq;
77 * The bf we currently receive
79 struct GNUNET_CONTAINER_BloomFilter *remote_bf;
82 * BF of the set's element.
84 struct GNUNET_CONTAINER_BloomFilter *local_bf;
87 * Current state of the operation.
89 enum IntersectionOperationPhase phase;
92 * Generation in which the operation handle
95 unsigned int generation_created;
98 * Set state of the set that this operation
104 * Maps element-id-hashes to 'elements in our set'.
106 struct GNUNET_CONTAINER_MultiHashMap *contained_elements;
109 * Current element count contained within contained_elements
111 uint32_t contained_elements_count;
114 * Iterator for sending elements on the key to element mapping to the client.
116 struct GNUNET_CONTAINER_MultiHashMap32Iterator *full_result_iter;
119 * Evaluate operations are held in
122 struct OperationState *next;
125 * Evaluate operations are held in
128 struct OperationState *prev;
131 * Did we send the client that we are done?
133 int client_done_sent;
138 * Extra state required for efficient set intersection.
143 * Evaluate operations are held in
146 struct OperationState *ops_head;
149 * Evaluate operations are held in
152 struct OperationState *ops_tail;
157 * Destroy a intersection operation, and free all resources
158 * associated with it.
160 * @param eo the intersection operation to destroy
163 intersection_operation_destroy (struct OperationState *eo)
165 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying intersection op\n");
166 GNUNET_CONTAINER_DLL_remove (eo->set->state->ops_head,
167 eo->set->state->ops_tail,
171 GNUNET_MQ_destroy (eo->mq);
174 if (NULL != eo->tunnel)
176 struct GNUNET_MESH_Tunnel *t = eo->tunnel;
178 GNUNET_MESH_tunnel_destroy (t);
180 // TODO: destroy set elements?
181 if (NULL != eo->spec)
183 if (NULL != eo->spec->context_msg)
185 GNUNET_free (eo->spec->context_msg);
186 eo->spec->context_msg = NULL;
188 GNUNET_free (eo->spec);
193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying intersection op done\n");
195 /* FIXME: do a garbage collection of the set generations */
200 * Inform the client that the intersection operation has failed,
201 * and proceed to destroy the evaluate operation.
203 * @param eo the intersection operation to fail
206 fail_intersection_operation (struct OperationState *eo)
208 struct GNUNET_MQ_Envelope *ev;
209 struct GNUNET_SET_ResultMessage *msg;
211 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
212 msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
213 msg->request_id = htonl (eo->spec->client_request_id);
214 msg->element_type = htons (0);
215 GNUNET_MQ_send (eo->spec->set->client_mq, ev);
216 intersection_operation_destroy (eo);
221 * Send a request for the evaluate operation to a remote peer
223 * @param eo operation with the other peer
226 send_operation_request (struct Operation *op)
228 struct GNUNET_MQ_Envelope *ev;
229 struct OperationRequestMessage *msg;
231 ev = GNUNET_MQ_msg_nested_mh (msg, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST,
232 op->spec->context_msg);
236 /* the context message is too large */
238 GNUNET_SERVER_client_disconnect (op->spec->set->client);
241 msg->operation = htonl (GNUNET_SET_OPERATION_INTERSECTION);
242 msg->app_id = op->spec->app_id;
243 msg->salt = htonl (op->spec->salt);
244 GNUNET_MQ_send (op->mq, ev);
246 if (NULL != op->spec->context_msg)
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent op request with context message\n");
249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sent op request without context message\n");
251 if (NULL != op->spec->context_msg)
253 GNUNET_free (op->spec->context_msg);
254 op->spec->context_msg = NULL;
261 * Handle an BF message from a remote peer.
263 * @param cls the intersection operation
264 * @param mh the header of the message
267 handle_p2p_bf (void *cls, const struct GNUNET_MessageHeader *mh)
269 struct OperationState *eo = cls;
270 struct BFMessage *msg = (struct BFMessage *) mh;
271 unsigned int buckets_in_message;
273 if (eo->phase == PHASE_EXPECT_INITIAL )
275 eo->phase = PHASE_BF_EXCHANGE;
277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "creating new bf of size %u\n", 1<<msg->order);
279 // if (the remote peer has less elements than us)
280 // run our elements through his bloomfilter
281 // else if (we have the same elements)
284 // evict elements we can exclude through the bloomfilter
286 // create a new bloomfilter over our remaining elements
288 // send our new count and the bloomfilter back
290 else if (eo->phase == PHASE_BF_EXCHANGE)
299 * Send a result message to the client indicating
300 * that there is a new element.
302 * @param eo intersection operation
303 * @param element element to send
306 send_client_element (struct OperationState *eo,
307 struct GNUNET_SET_Element *element)
309 struct GNUNET_MQ_Envelope *ev;
310 struct GNUNET_SET_ResultMessage *rm;
312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending element (size %u) to client\n", element->size);
313 GNUNET_assert (0 != eo->spec->client_request_id);
314 ev = GNUNET_MQ_msg_extra (rm, element->size, GNUNET_MESSAGE_TYPE_SET_RESULT);
317 GNUNET_MQ_discard (ev);
321 rm->result_status = htons (GNUNET_SET_STATUS_OK);
322 rm->request_id = htonl (eo->spec->client_request_id);
323 rm->element_type = element->type;
324 memcpy (&rm[1], element->data, element->size);
325 GNUNET_MQ_send (eo->spec->set->client_mq, ev);
330 * Send a result message to the client indicating
331 * that the operation is over.
332 * After the result done message has been sent to the client,
333 * destroy the evaluate operation.
335 * @param eo intersection operation
338 send_client_done_and_destroy (struct OperationState *eo)
340 struct GNUNET_MQ_Envelope *ev;
341 struct GNUNET_SET_ResultMessage *rm;
343 GNUNET_assert (GNUNET_NO == eo->client_done_sent);
345 eo->client_done_sent = GNUNET_YES;
347 ev = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
348 rm->request_id = htonl (eo->spec->client_request_id);
349 rm->result_status = htons (GNUNET_SET_STATUS_DONE);
350 rm->element_type = htons (0);
351 GNUNET_MQ_send (eo->spec->set->client_mq, ev);
353 intersection_operation_destroy (eo);
358 * Send a bloomfilter to our peer.
359 * that the operation is over.
360 * After the result done message has been sent to the client,
361 * destroy the evaluate operation.
363 * @param eo intersection operation
366 send_bloomfilter (struct Operation *op)
368 struct BloomFilter *bf;
369 struct GNUNET_MQ_Envelope *ev;
370 struct BFMessage *msg;
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending bf of size %u\n", );
375 ev = GNUNET_MQ_msg(msg, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF);
377 msg->sender_mutator = htonl (op->spec->salt);
378 msg->sender_element_count = htonl (op->state->contained_elements_count);
379 GNUNET_assert(GNUNET_SYSERR != GNUNET_CONTAINER_bloomfilter_get_raw_data(
382 GNUNET_CRYPTO_HASH_LENGTH));
384 GNUNET_MQ_send (op->mq, ev);
386 op->state->phase = PHASE_BF_EXCHANGE;
390 * Handle a done message from a remote peer
392 * @param cls the intersection operation
393 * @param mh the message
396 handle_p2p_done (void *cls, const struct GNUNET_MessageHeader *mh)
398 struct OperationState *eo = cls;
399 struct GNUNET_MQ_Envelope *ev;
401 if (eo->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
403 /* we got all requests, but still have to send our elements as response */
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got DONE, sending final DONE after elements\n");
406 eo->phase = PHASE_FINISHED;
407 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_P2P_DONE);
408 GNUNET_MQ_send (eo->mq, ev);
411 if (eo->phase == PHASE_EXPECT_ELEMENTS)
413 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got final DONE\n");
414 eo->phase = PHASE_FINISHED;
415 send_client_done_and_destroy (eo);
419 fail_intersection_operation (eo);
424 * Evaluate a union operation with
427 * @param op operation to evaluate
430 intersection_evaluate (struct Operation *op)
432 op->state = GNUNET_new (struct OperationState);
433 /* we started the operation, thus we have to send the operation request */
434 op->state->phase = PHASE_BF_EXCHANGE;
435 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "evaluating intersection operation");
436 send_operation_request (op);
443 * fills the contained-elements hashmap with all relevant
444 * elements and adds their mutated hashes to our local bloomfilter with mutator+1
447 * @param key current key code
448 * @param value value in the hash map
449 * @return #GNUNET_YES if we should continue to
454 intersection_iterator_set_to_contained_alice (void *cls,
455 const struct GNUNET_HashCode *key,
457 struct ElementEntry *ee = value;
458 struct Operation *op = cls;
459 struct GNUNET_HashCode mutated_hash;
461 //only consider this element, if it is valid for us
462 if ((op->generation_created >= ee->generation_removed)
463 || (op->generation_created < ee->generation_added))
466 // not contained according to bob's bloomfilter
467 GNUNET_BLOCK_mingle_hash(&ee->element_hash, op->spec->salt, &mutated_hash);
468 if (GNUNET_NO == GNUNET_CONTAINER_bloomfilter_test (op->state->remote_bf,
472 op->state->contained_elements_count++;
473 GNUNET_CONTAINER_multihashmap_put (op->state->contained_elements,
474 &ee->element_hash, ee,
475 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
477 // create our own bloomfilter with salt+1
478 GNUNET_BLOCK_mingle_hash(&ee->element_hash, op->spec->salt+1, &mutated_hash);
479 GNUNET_CONTAINER_bloomfilter_add (op->state->local_bf,
488 * fills the contained-elements hashmap with all relevant
489 * elements and adds their mutated hashes to our local bloomfilter
492 * @param key current key code
493 * @param value value in the hash map
494 * @return #GNUNET_YES if we should continue to
499 intersection_iterator_set_to_contained_bob (void *cls,
500 const struct GNUNET_HashCode *key,
502 struct ElementEntry *ee = value;
503 struct Operation *op = cls;
504 struct GNUNET_HashCode mutated_hash;
506 //only consider this element, if it is valid for us
507 if ((op->generation_created >= ee->generation_removed)
508 || (op->generation_created < ee->generation_added))
511 GNUNET_CONTAINER_multihashmap_put (op->state->contained_elements,
512 &ee->element_hash, ee,
513 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
515 op->state->contained_elements_count++;
517 GNUNET_BLOCK_mingle_hash(&ee->element_hash, op->spec->salt, &mutated_hash);
519 GNUNET_CONTAINER_bloomfilter_add (op->state->local_bf,
526 * removes element from a hashmap if it is not contained within the
527 * provided remote bloomfilter.
530 * @param key current key code
531 * @param value value in the hash map
532 * @return #GNUNET_YES if we should continue to
537 intersection_iterator_element_removal (void *cls,
538 const struct GNUNET_HashCode *key,
540 struct ElementEntry *ee = value;
541 struct Operation *op = cls;
542 struct GNUNET_HashCode mutated_hash;
544 GNUNET_BLOCK_mingle_hash(&ee->element_hash, op->spec->salt, &mutated_hash);
546 if (GNUNET_NO == GNUNET_CONTAINER_bloomfilter_test (op->state->remote_bf,
548 op->state->contained_elements_count--;
549 GNUNET_CONTAINER_multihashmap_remove (op->state->contained_elements,
558 * removes element from a hashmap if it is not contained within the
559 * provided remote bloomfilter.
562 * @param key current key code
563 * @param value value in the hash map
564 * @return #GNUNET_YES if we should continue to
569 intersection_iterator_create_bf (void *cls,
570 const struct GNUNET_HashCode *key,
572 struct ElementEntry *ee = value;
573 struct Operation *op = cls;
574 struct GNUNET_HashCode mutated_hash;
576 GNUNET_BLOCK_mingle_hash(&ee->element_hash, op->spec->salt, &mutated_hash);
578 GNUNET_CONTAINER_bloomfilter_add (op->state->local_bf,
586 * Accept an union operation request from a remote peer.
587 * Only initializes the private operation state.
589 * @param op operation that will be accepted as a union operation
592 intersection_accept (struct Operation *op)
594 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "accepting set union operation\n");
595 op->state = GNUNET_new (struct OperationState);
597 op->state->contained_elements = GNUNET_CONTAINER_multihashmap_create(1, GNUNET_YES);
598 op->state-> = GNUNET_CONTAINER_multihashmap_create(1, GNUNET_YES);
600 op->state->local_bf = GNUNET_CONTAINER_bloomfilter_init(NULL, , GNUNET_CONSTANTS_BLOOMFILTER_K);
602 GNUNET_CONTAINER_multihashmap_iterate(op->spec->set->elements,
603 &intersection_iterator_set_to_contained_bob,
605 /* kick off the operation */
606 send_bloomfilter (op);
611 * Create a new set supporting the intersection operation
613 * @return the newly created set
615 static struct SetState *
616 intersection_set_create (void)
618 struct SetState *set_state;
620 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "intersection set created\n");
622 set_state = GNUNET_new (struct SetState);
629 * Add the element from the given element message to the set.
631 * @param set_state state of the set want to add to
632 * @param ee the element to add to the set
635 intersection_add (struct SetState *set_state, struct ElementEntry *ee)
642 * Destroy a set that supports the intersection operation
644 * @param set_state the set to destroy
647 intersection_set_destroy (struct SetState *set_state)
649 GNUNET_free (set_state);
654 * Remove the element given in the element message from the set.
656 * @param set_state state of the set to remove from
657 * @param element set element to remove
660 intersection_remove (struct SetState *set_state, struct ElementEntry *element)
667 * Dispatch messages for a intersection operation.
669 * @param eo the state of the intersection evaluate operation
670 * @param mh the received message
671 * @return GNUNET_SYSERR if the tunnel should be disconnected,
672 * GNUNET_OK otherwise
675 intersection_handle_p2p_message (struct OperationState *eo,
676 const struct GNUNET_MessageHeader *mh)
678 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received p2p message (t: %u, s: %u)\n",
679 ntohs (mh->type), ntohs (mh->size));
680 switch (ntohs (mh->type))
682 /* this message handler is not active until after we received an
683 * operation request message, thus the ops request is not handled here
685 case GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF:
686 handle_p2p_bf (eo, mh);
688 case GNUNET_MESSAGE_TYPE_SET_P2P_DONE:
689 handle_p2p_done (eo, mh);
692 /* something wrong with mesh's message handlers? */
699 * Signal to the client that the operation has finished and
700 * destroy the operation.
702 * @param cls operation to destroy
705 send_done_and_destroy (void *cls)
707 struct Operation *op = cls;
708 struct GNUNET_MQ_Envelope *ev;
709 struct GNUNET_SET_ResultMessage *rm;
710 ev = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
711 rm->request_id = htonl (op->spec->client_request_id);
712 rm->result_status = htons (GNUNET_SET_STATUS_DONE);
713 rm->element_type = htons (0);
714 GNUNET_MQ_send (op->spec->set->client_mq, ev);
715 _GSS_operation_destroy (op);
719 * Send a result message to the client indicating
720 * that the operation is over.
721 * After the result done message has been sent to the client,
722 * destroy the evaluate operation.
724 * @param op union operation
727 finish_and_destroy (struct Operation *op)
729 GNUNET_assert (GNUNET_NO == op->state->client_done_sent);
731 if (GNUNET_SET_RESULT_FULL == op->spec->result_mode)
733 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "sending full result set\n");
734 GNUNET_assert (NULL == op->state->full_result_iter);
735 op->state->full_result_iter =
736 GNUNET_CONTAINER_multihashmap32_iterator_create (op->state->contained_elements);
739 send_done_and_destroy (op);
744 intersection_peer_disconnect (struct Operation *op)
746 if (PHASE_FINISHED != op->state->phase)
748 struct GNUNET_MQ_Envelope *ev;
749 struct GNUNET_SET_ResultMessage *msg;
751 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
752 msg->request_id = htonl (op->spec->client_request_id);
753 msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
754 msg->element_type = htons (0);
755 GNUNET_MQ_send (op->spec->set->client_mq, ev);
756 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "other peer disconnected prematurely\n");
757 _GSS_operation_destroy (op);
760 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "other peer disconnected (finished)\n");
761 if (GNUNET_NO == op->state->client_done_sent)
762 finish_and_destroy (op);
767 * Destroy the union operation. Only things specific to the union operation are destroyed.
769 * @param op union operation to destroy
772 intersection_op_cancel (struct Operation *op)
774 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying intersection op\n");
775 /* check if the op was canceled twice */
776 GNUNET_assert (NULL != op->state);
777 if (NULL != op->state->remote_bf)
779 GNUNET_CONTAINER_bloomfilter_free (op->state->remote_bf);
780 op->state->remote_bf = NULL;
782 if (NULL != op->state->local_bf)
784 GNUNET_CONTAINER_bloomfilter_free (op->state->local_bf);
785 op->state->local_bf = NULL;
787 if (NULL != op->state->contained_elements)
789 // no need to free the elements, they are still part of the set
790 GNUNET_CONTAINER_multihashmap_destroy (op->state->contained_elements);
791 op->state->contained_elements = NULL;
793 GNUNET_free (op->state);
795 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying intersection op done\n");
799 _GSS_intersection_vt ()
801 static const struct SetVT intersection_vt = {
802 .create = &intersection_set_create,
803 .msg_handler = &intersection_handle_p2p_message,
804 .add = &intersection_add,
805 .remove = &intersection_remove,
806 .destroy_set = &intersection_set_destroy,
807 .evaluate = &intersection_evaluate,
808 .accept = &intersection_accept,
809 .peer_disconnect = &intersection_peer_disconnect,
810 .cancel = &intersection_op_cancel,
813 return &intersection_vt;