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.c
23 * @brief two-peer set operations
24 * @author Florian Dold
26 #include "gnunet-service-set.h"
27 #include "set_protocol.h"
31 * State of an operation where the peer has connected to us, but is not yet
32 * evaluating a set operation. Once the peer has sent a concrete request, and
33 * the client has accepted or rejected it, this information will be deleted
34 * and replaced by the real set operation state.
39 * The identity of the requesting peer. Needs to
40 * be stored here as the op spec might not have been created yet.
42 struct GNUNET_PeerIdentity peer;
45 * Timeout task, if the incoming peer has not been accepted
46 * after the timeout, it will be disconnected.
48 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
51 * Unique request id for the request from a remote peer, sent to the
52 * client, which will accept or reject the request. Set to '0' iff
53 * the request has not been suggested yet.
61 * A listener is inhabited by a client, and waits for evaluation
62 * requests from remote peers.
67 * Listeners are held in a doubly linked list.
69 struct Listener *next;
72 * Listeners are held in a doubly linked list.
74 struct Listener *prev;
77 * Client that owns the listener.
78 * Only one client may own a listener.
80 struct GNUNET_SERVER_Client *client;
83 * Message queue for the client
85 struct GNUNET_MQ_Handle *client_mq;
88 * Application ID for the operation, used to distinguish
89 * multiple operations of the same type with the same peer.
91 struct GNUNET_HashCode app_id;
94 * The type of the operation.
96 enum GNUNET_SET_OperationType operation;
101 * Configuration of our local peer.
103 static const struct GNUNET_CONFIGURATION_Handle *configuration;
106 * Handle to the cadet service, used to listen for and connect to
109 static struct GNUNET_CADET_Handle *cadet;
112 * Sets are held in a doubly linked list.
114 static struct Set *sets_head;
117 * Sets are held in a doubly linked list.
119 static struct Set *sets_tail;
122 * Listeners are held in a doubly linked list.
124 static struct Listener *listeners_head;
127 * Listeners are held in a doubly linked list.
129 static struct Listener *listeners_tail;
132 * Incoming sockets from remote peers are held in a doubly linked
135 static struct Operation *incoming_head;
138 * Incoming sockets from remote peers are held in a doubly linked
141 static struct Operation *incoming_tail;
144 * Counter for allocating unique IDs for clients, used to identify
145 * incoming operation requests from remote peers, that the client can
146 * choose to accept or refuse.
148 static uint32_t suggest_id = 1;
152 * Get set that is owned by the given client, if any.
154 * @param client client to look for
155 * @return set that the client owns, NULL if the client
159 set_get (struct GNUNET_SERVER_Client *client)
163 for (set = sets_head; NULL != set; set = set->next)
164 if (set->client == client)
171 * Get the listener associated with the given client, if any.
173 * @param client the client
174 * @return listener associated with the client, NULL
177 static struct Listener *
178 listener_get (struct GNUNET_SERVER_Client *client)
180 struct Listener *listener;
182 for (listener = listeners_head; NULL != listener; listener = listener->next)
183 if (listener->client == client)
190 * Get the incoming socket associated with the given id.
192 * @param id id to look for
193 * @return the incoming socket associated with the id,
194 * or NULL if there is none
196 static struct Operation *
197 get_incoming (uint32_t id)
199 struct Operation *op;
201 for (op = incoming_head; NULL != op; op = op->next)
202 if (op->state->suggest_id == id)
204 // FIXME: remove this assertion once the corresponding bug is gone!
205 GNUNET_assert (GNUNET_YES == op->is_incoming);
213 * Destroy a listener, free all resources associated with it.
215 * @param listener listener to destroy
218 listener_destroy (struct Listener *listener)
220 /* If the client is not dead yet, destroy it.
221 * The client's destroy callback will destroy the listener again. */
222 if (NULL != listener->client)
224 struct GNUNET_SERVER_Client *client = listener->client;
226 listener->client = NULL;
227 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
228 "disconnecting listener client\n");
229 GNUNET_SERVER_client_disconnect (client);
232 if (NULL != listener->client_mq)
234 GNUNET_MQ_destroy (listener->client_mq);
235 listener->client_mq = NULL;
237 GNUNET_CONTAINER_DLL_remove (listeners_head,
240 GNUNET_free (listener);
245 * Context for the #garbage_collect_cb().
247 struct GarbageContext
251 * Map for which we are garbage collecting removed elements.
253 struct GNUNET_CONTAINER_MultiHashMap *map;
256 * Lowest generation for which an operation is still pending.
258 unsigned int min_op_generation;
261 * Largest generation for which an operation is still pending.
263 unsigned int max_op_generation;
269 * Function invoked to check if an element can be removed from
270 * the set's history because it is no longer needed.
272 * @param cls the `struct GarbageContext *`
273 * @param key key of the element in the map
274 * @param value the `struct ElementEntry *`
275 * @return #GNUNET_OK (continue to iterate)
278 garbage_collect_cb (void *cls,
279 const struct GNUNET_HashCode *key,
282 struct GarbageContext *gc = cls;
283 struct ElementEntry *ee = value;
285 if (GNUNET_YES != ee->removed)
287 if ( (gc->max_op_generation < ee->generation_added) ||
288 (ee->generation_removed > gc->min_op_generation) )
290 GNUNET_assert (GNUNET_YES ==
291 GNUNET_CONTAINER_multihashmap_remove (gc->map,
301 * Collect and destroy elements that are not needed anymore, because
302 * their lifetime (as determined by their generation) does not overlap
303 * with any active set operation.
305 * @param set set to garbage collect
308 collect_generation_garbage (struct Set *set)
310 struct Operation *op;
311 struct GarbageContext gc;
313 gc.min_op_generation = UINT_MAX;
314 gc.max_op_generation = 0;
315 for (op = set->ops_head; NULL != op; op = op->next)
317 gc.min_op_generation = GNUNET_MIN (gc.min_op_generation,
318 op->generation_created);
319 gc.max_op_generation = GNUNET_MAX (gc.max_op_generation,
320 op->generation_created);
322 gc.map = set->elements;
323 GNUNET_CONTAINER_multihashmap_iterate (set->elements,
330 * Destroy the given operation. Call the implementation-specific
331 * cancel function of the operation. Disconnects from the remote
332 * peer. Does not disconnect the client, as there may be multiple
333 * operations per set.
335 * @param op operation to destroy
336 * @param gc #GNUNET_YES to perform garbage collection on the set
339 _GSS_operation_destroy (struct Operation *op,
343 struct GNUNET_CADET_Channel *channel;
347 /* already in #_GSS_operation_destroy() */
350 GNUNET_assert (GNUNET_NO == op->is_incoming);
351 GNUNET_assert (NULL != op->spec);
353 GNUNET_CONTAINER_DLL_remove (op->spec->set->ops_head,
354 op->spec->set->ops_tail,
358 if (NULL != op->spec)
360 if (NULL != op->spec->context_msg)
362 GNUNET_free (op->spec->context_msg);
363 op->spec->context_msg = NULL;
365 GNUNET_free (op->spec);
370 GNUNET_MQ_destroy (op->mq);
373 if (NULL != (channel = op->channel))
376 GNUNET_CADET_channel_destroy (channel);
378 if (GNUNET_YES == gc)
379 collect_generation_garbage (set);
380 /* We rely on the channel end handler to free 'op'. When 'op->channel' was NULL,
381 * there was a channel end handler that will free 'op' on the call stack. */
386 * Iterator over hash map entries to free element entries.
389 * @param key current key code
390 * @param value a `struct ElementEntry *` to be free'd
391 * @return #GNUNET_YES (continue to iterate)
394 destroy_elements_iterator (void *cls,
395 const struct GNUNET_HashCode *key,
398 struct ElementEntry *ee = value;
406 * Destroy a set, and free all resources and operations associated with it.
408 * @param set the set to destroy
411 set_destroy (struct Set *set)
413 if (NULL != set->client)
415 /* If the client is not dead yet, destroy it. The client's destroy
416 * callback will call `set_destroy()` again in this case. We do
417 * this so that the channel end handler still has a valid set handle
419 struct GNUNET_SERVER_Client *client = set->client;
422 GNUNET_SERVER_client_disconnect (client);
425 GNUNET_assert (NULL != set->state);
426 while (NULL != set->ops_head)
427 _GSS_operation_destroy (set->ops_head, GNUNET_NO);
428 set->vt->destroy_set (set->state);
430 if (NULL != set->client_mq)
432 GNUNET_MQ_destroy (set->client_mq);
433 set->client_mq = NULL;
435 if (NULL != set->iter)
437 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
440 if (NULL != set->elements)
442 GNUNET_CONTAINER_multihashmap_iterate (set->elements,
443 &destroy_elements_iterator,
445 GNUNET_CONTAINER_multihashmap_destroy (set->elements);
446 set->elements = NULL;
448 GNUNET_CONTAINER_DLL_remove (sets_head,
456 * Clean up after a client has disconnected
458 * @param cls closure, unused
459 * @param client the client to clean up after
462 handle_client_disconnect (void *cls,
463 struct GNUNET_SERVER_Client *client)
466 struct Listener *listener;
468 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
469 "client disconnected, cleaning up\n");
470 set = set_get (client);
475 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
476 "Client's set destroyed\n");
478 listener = listener_get (client);
479 if (NULL != listener)
481 listener->client = NULL;
482 listener_destroy (listener);
483 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
484 "Client's listener destroyed\n");
490 * Destroy an incoming request from a remote peer
492 * @param incoming remote request to destroy
495 incoming_destroy (struct Operation *incoming)
497 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
498 GNUNET_CONTAINER_DLL_remove (incoming_head,
501 if (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task)
503 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
504 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
506 GNUNET_assert (NULL != incoming->state);
507 GNUNET_free (incoming->state);
508 /* make sure that the tunnel end handler will not destroy us again */
510 incoming->state = NULL;
511 if (NULL != incoming->mq)
513 GNUNET_MQ_destroy (incoming->mq);
516 if (NULL != incoming->channel)
518 GNUNET_CADET_channel_destroy (incoming->channel);
519 incoming->channel = NULL;
525 * Find a listener that is interested in the given operation type
526 * and application id.
528 * @param op operation type to look for
529 * @param app_id application id to look for
530 * @return a matching listener, or NULL if no listener matches the
531 * given operation and application id
533 static struct Listener *
534 listener_get_by_target (enum GNUNET_SET_OperationType op,
535 const struct GNUNET_HashCode *app_id)
539 for (l = listeners_head; NULL != l; l = l->next)
541 if (l->operation != op)
543 if (0 != GNUNET_CRYPTO_hash_cmp (app_id, &l->app_id))
552 * Suggest the given request to the listener. The listening client can then
553 * accept or reject the remote request.
555 * @param incoming the incoming peer with the request to suggest
556 * @param listener the listener to suggest the request to
559 incoming_suggest (struct Operation *incoming, struct Listener *listener)
561 struct GNUNET_MQ_Envelope *mqm;
562 struct GNUNET_SET_RequestMessage *cmsg;
564 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
565 GNUNET_assert (NULL != incoming->state);
566 GNUNET_assert (NULL != incoming->spec);
567 GNUNET_assert (0 == incoming->state->suggest_id);
568 incoming->state->suggest_id = suggest_id++;
570 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task);
571 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
572 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
574 mqm = GNUNET_MQ_msg_nested_mh (cmsg, GNUNET_MESSAGE_TYPE_SET_REQUEST,
575 incoming->spec->context_msg);
576 GNUNET_assert (NULL != mqm);
577 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "suggesting request with accept id %u\n",
578 incoming->state->suggest_id);
579 cmsg->accept_id = htonl (incoming->state->suggest_id);
580 cmsg->peer_id = incoming->spec->peer;
581 GNUNET_MQ_send (listener->client_mq, mqm);
586 * Handle a request for a set operation from
589 * This msg is expected as the first and only msg handled through the
590 * non-operation bound virtual table, acceptance of this operation replaces
591 * our virtual table and subsequent msgs would be routed differently.
593 * @param op the operation state
594 * @param mh the received message
595 * @return #GNUNET_OK if the channel should be kept alive,
596 * #GNUNET_SYSERR to destroy the channel
599 handle_incoming_msg (struct Operation *op,
600 const struct GNUNET_MessageHeader *mh)
602 const struct OperationRequestMessage *msg = (const struct OperationRequestMessage *) mh;
603 struct Listener *listener;
604 struct OperationSpecification *spec;
606 GNUNET_assert (GNUNET_YES == op->is_incoming);
608 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got op request\n");
610 if (GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST != ntohs (mh->type))
613 return GNUNET_SYSERR;
616 /* double operation request */
617 if (NULL != op->spec)
620 return GNUNET_SYSERR;
623 spec = GNUNET_new (struct OperationSpecification);
624 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
625 // for simplicity we just backup the context msg instead of rebuilding it later on
626 if (NULL != spec->context_msg)
627 spec->context_msg = GNUNET_copy_message (spec->context_msg);
628 spec->operation = ntohl (msg->operation);
629 spec->app_id = msg->app_id;
630 spec->salt = ntohl (msg->salt);
631 spec->peer = op->state->peer;
632 spec->remote_element_count = ntohl (msg->element_count);
636 if ( (NULL != spec->context_msg) &&
637 (ntohs (spec->context_msg->size) > GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE) )
640 return GNUNET_SYSERR;
643 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received P2P operation request (op %u, app %s)\n",
644 ntohl (msg->operation), GNUNET_h2s (&msg->app_id));
645 listener = listener_get_by_target (ntohl (msg->operation), &msg->app_id);
646 if (NULL == listener)
648 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
649 "no listener matches incoming request, waiting with timeout\n");
652 incoming_suggest (op, listener);
658 * Send the next element of a set to the set's client. The next element is given by
659 * the set's current hashmap iterator. The set's iterator will be set to NULL if there
660 * are no more elements in the set. The caller must ensure that the set's iterator is
663 * @param set set that should send its next element to its client
666 send_client_element (struct Set *set)
669 struct ElementEntry *ee;
670 struct GNUNET_MQ_Envelope *ev;
672 GNUNET_assert (NULL != set->iter);
673 ret = GNUNET_CONTAINER_multihashmap_iterator_next (set->iter, NULL, (const void **) &ee);
674 if (GNUNET_NO == ret)
676 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_DONE);
677 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
682 struct GNUNET_SET_IterResponseMessage *msg;
684 GNUNET_assert (NULL != ee);
685 ev = GNUNET_MQ_msg_extra (msg, ee->element.size, GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT);
686 memcpy (&msg[1], ee->element.data, ee->element.size);
687 msg->element_type = ee->element.type;
689 GNUNET_MQ_send (set->client_mq, ev);
694 * Called when a client wants to iterate the elements of a set.
697 * @param client client that sent the message
698 * @param m message sent by the client
701 handle_client_iterate (void *cls,
702 struct GNUNET_SERVER_Client *client,
703 const struct GNUNET_MessageHeader *m)
707 // iterate over a non existing set
708 set = set_get (client);
712 GNUNET_SERVER_client_disconnect (client);
716 // only one concurrent iterate-action per set
717 if (NULL != set->iter)
720 GNUNET_SERVER_client_disconnect (client);
723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "iterating union set with %u elements\n",
724 GNUNET_CONTAINER_multihashmap_size (set->elements));
725 GNUNET_SERVER_receive_done (client, GNUNET_OK);
726 set->iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
727 send_client_element (set);
732 * Called when a client wants to create a new set.
735 * @param client client that sent the message
736 * @param m message sent by the client
739 handle_client_create_set (void *cls,
740 struct GNUNET_SERVER_Client *client,
741 const struct GNUNET_MessageHeader *m)
743 const struct GNUNET_SET_CreateMessage *msg;
746 msg = (const struct GNUNET_SET_CreateMessage *) m;
747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
748 "client created new set (operation %u)\n",
749 ntohs (msg->operation));
751 // max. one set per client!
752 if (NULL != set_get (client))
755 GNUNET_SERVER_client_disconnect (client);
759 set = GNUNET_new (struct Set);
761 switch (ntohs (msg->operation))
763 case GNUNET_SET_OPERATION_INTERSECTION:
764 set->vt = _GSS_intersection_vt ();
766 case GNUNET_SET_OPERATION_UNION:
767 set->vt = _GSS_union_vt ();
772 GNUNET_SERVER_client_disconnect (client);
776 set->state = set->vt->create ();
777 set->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
778 set->client = client;
779 set->client_mq = GNUNET_MQ_queue_for_server_client (client);
780 GNUNET_CONTAINER_DLL_insert (sets_head, sets_tail, set);
781 GNUNET_SERVER_receive_done (client, GNUNET_OK);
786 * Called when a client wants to create a new listener.
789 * @param client client that sent the message
790 * @param m message sent by the client
793 handle_client_listen (void *cls,
794 struct GNUNET_SERVER_Client *client,
795 const struct GNUNET_MessageHeader *m)
797 const struct GNUNET_SET_ListenMessage *msg;
798 struct Listener *listener;
799 struct Operation *op;
801 msg = (const struct GNUNET_SET_ListenMessage *) m;
802 /* max. one per client! */
803 if (NULL != listener_get (client))
806 GNUNET_SERVER_client_disconnect (client);
810 listener = GNUNET_new (struct Listener);
811 listener->client = client;
812 listener->client_mq = GNUNET_MQ_queue_for_server_client (client);
813 listener->app_id = msg->app_id;
814 listener->operation = ntohl (msg->operation);
815 GNUNET_CONTAINER_DLL_insert_tail (listeners_head, listeners_tail, listener);
816 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
817 "new listener created (op %u, app %s)\n",
819 GNUNET_h2s (&listener->app_id));
821 /* check for incoming requests the listener is interested in */
822 for (op = incoming_head; NULL != op; op = op->next)
824 if (NULL == op->spec)
826 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
827 "request has no spec yet\n");
830 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
831 "considering (op: %u, app: %s, suggest: %u)\n",
833 GNUNET_h2s (&op->spec->app_id),
834 op->state->suggest_id);
836 /* don't consider the incoming request if it has been already suggested to a listener */
837 if (0 != op->state->suggest_id)
839 if (listener->operation != op->spec->operation)
841 if (0 != GNUNET_CRYPTO_hash_cmp (&listener->app_id, &op->spec->app_id))
843 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
844 "request suggested\n");
845 incoming_suggest (op, listener);
847 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
848 "considered all incoming requests\n");
849 GNUNET_SERVER_receive_done (client, GNUNET_OK);
854 * Called when the listening client rejects an operation
855 * request by another peer.
858 * @param client client that sent the message
859 * @param m message sent by the client
862 handle_client_reject (void *cls,
863 struct GNUNET_SERVER_Client *client,
864 const struct GNUNET_MessageHeader *m)
866 struct Operation *incoming;
867 const struct GNUNET_SET_AcceptRejectMessage *msg;
869 msg = (const struct GNUNET_SET_AcceptRejectMessage *) m;
870 GNUNET_break (0 == ntohl (msg->request_id));
872 // no matching incoming operation for this reject
873 incoming = get_incoming (ntohl (msg->accept_reject_id));
874 if (NULL == incoming)
876 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
879 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
880 "peer request rejected by client\n");
882 GNUNET_CADET_channel_destroy (incoming->channel);
883 //channel destruction handler called immediately upon destruction
884 GNUNET_SERVER_receive_done (client, GNUNET_OK);
889 * Called when a client wants to add/remove an element to/from a
893 * @param client client that sent the message
894 * @param m message sent by the client
897 handle_client_add_remove (void *cls,
898 struct GNUNET_SERVER_Client *client,
899 const struct GNUNET_MessageHeader *m)
902 const struct GNUNET_SET_ElementMessage *msg;
903 struct GNUNET_SET_Element el;
904 struct ElementEntry *ee;
906 // client without a set requested an operation
907 set = set_get (client);
911 GNUNET_SERVER_client_disconnect (client);
914 GNUNET_SERVER_receive_done (client, GNUNET_OK);
915 msg = (const struct GNUNET_SET_ElementMessage *) m;
916 el.size = ntohs (m->size) - sizeof *msg;
917 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
918 "client ins/rem element of size %u\n", el.size);
920 if (GNUNET_MESSAGE_TYPE_SET_REMOVE == ntohs (m->type))
922 struct GNUNET_HashCode hash;
924 GNUNET_CRYPTO_hash (el.data, el.size, &hash);
925 ee = GNUNET_CONTAINER_multihashmap_get (set->elements, &hash);
928 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
929 "client tried to remove non-existing element\n");
932 if (GNUNET_YES == ee->removed)
934 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
935 "client tried to remove element twice\n");
938 ee->removed = GNUNET_YES;
939 ee->generation_removed = set->current_generation;
940 set->vt->remove (set->state, ee);
944 struct ElementEntry *ee_dup;
946 ee = GNUNET_malloc (el.size + sizeof *ee);
947 ee->element.size = el.size;
948 memcpy (&ee[1], el.data, el.size);
949 ee->element.data = &ee[1];
950 ee->generation_added = set->current_generation;
951 ee->remote = GNUNET_NO;
952 GNUNET_CRYPTO_hash (ee->element.data, el.size, &ee->element_hash);
953 ee_dup = GNUNET_CONTAINER_multihashmap_get (set->elements,
957 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
958 "element inserted twice, ignoring\n");
962 GNUNET_CONTAINER_multihashmap_put (set->elements, &ee->element_hash, ee,
963 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
964 set->vt->add (set->state, ee);
970 * Called when a client wants to evaluate a set operation with another peer.
973 * @param client client that sent the message
974 * @param m message sent by the client
977 handle_client_evaluate (void *cls,
978 struct GNUNET_SERVER_Client *client,
979 const struct GNUNET_MessageHeader *m)
982 const struct GNUNET_SET_EvaluateMessage *msg;
983 struct OperationSpecification *spec;
984 struct Operation *op;
986 set = set_get (client);
990 GNUNET_SERVER_client_disconnect (client);
994 msg = (const struct GNUNET_SET_EvaluateMessage *) m;
995 spec = GNUNET_new (struct OperationSpecification);
996 spec->operation = set->operation;
997 spec->app_id = msg->app_id;
998 spec->salt = ntohl (msg->salt);
999 spec->peer = msg->target_peer;
1001 spec->result_mode = ntohs (msg->result_mode);
1002 spec->client_request_id = ntohl (msg->request_id);
1003 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
1005 // for simplicity we just backup the context msg instead of rebuilding it later on
1006 if (NULL != spec->context_msg)
1007 spec->context_msg = GNUNET_copy_message (spec->context_msg);
1009 op = GNUNET_new (struct Operation);
1011 op->generation_created = set->current_generation++;
1013 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
1015 op->channel = GNUNET_CADET_channel_create (cadet, op, &msg->target_peer,
1016 GNUNET_APPLICATION_TYPE_SET,
1017 GNUNET_CADET_OPTION_RELIABLE);
1019 op->mq = GNUNET_CADET_mq_create (op->channel);
1021 set->vt->evaluate (op);
1022 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1027 * Handle an ack from a client, and send the next element.
1030 * @param client the client
1031 * @param m the message
1034 handle_client_iter_ack (void *cls,
1035 struct GNUNET_SERVER_Client *client,
1036 const struct GNUNET_MessageHeader *m)
1040 // client without a set requested an operation
1041 set = set_get (client);
1045 GNUNET_SERVER_client_disconnect (client);
1049 // client sent an ack, but we were not expecting one
1050 if (NULL == set->iter)
1053 GNUNET_SERVER_client_disconnect (client);
1057 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1058 send_client_element (set);
1063 * Handle a request from the client to
1064 * cancel a running set operation.
1067 * @param client the client
1068 * @param mh the message
1071 handle_client_cancel (void *cls,
1072 struct GNUNET_SERVER_Client *client,
1073 const struct GNUNET_MessageHeader *mh)
1075 const struct GNUNET_SET_CancelMessage *msg =
1076 (const struct GNUNET_SET_CancelMessage *) mh;
1078 struct Operation *op;
1081 // client without a set requested an operation
1082 set = set_get (client);
1086 GNUNET_SERVER_client_disconnect (client);
1090 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1091 "client requested cancel for op %u\n",
1092 ntohl (msg->request_id));
1095 for (op = set->ops_head; NULL != op; op = op->next)
1097 if (op->spec->client_request_id == ntohl (msg->request_id))
1104 /* It may happen that the operation was destroyed due to
1105 * the other peer disconnecting. The client may not know about this
1106 * yet and try to cancel the (non non-existent) operation.
1108 if (GNUNET_NO != found)
1109 _GSS_operation_destroy (op,
1112 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1113 "client canceled non-existent op\n");
1116 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1121 * Handle a request from the client to accept
1122 * a set operation that came from a remote peer.
1123 * We forward the accept to the associated operation for handling
1126 * @param client the client
1127 * @param mh the message
1130 handle_client_accept (void *cls,
1131 struct GNUNET_SERVER_Client *client,
1132 const struct GNUNET_MessageHeader *mh)
1135 const struct GNUNET_SET_AcceptRejectMessage *msg;
1136 struct Operation *op;
1138 msg = (const struct GNUNET_SET_AcceptRejectMessage *) mh;
1140 // client without a set requested an operation
1141 set = set_get (client);
1146 GNUNET_SERVER_client_disconnect (client);
1150 op = get_incoming (ntohl (msg->accept_reject_id));
1152 /* it is not an error if the set op does not exist -- it may
1153 * have been destroyed when the partner peer disconnected. */
1156 struct GNUNET_SET_ResultMessage *result_message;
1157 struct GNUNET_MQ_Envelope *ev;
1158 ev = GNUNET_MQ_msg (result_message, GNUNET_MESSAGE_TYPE_SET_RESULT);
1159 result_message->request_id = msg->request_id;
1160 result_message->element_type = 0;
1161 result_message->result_status = htons (GNUNET_SET_STATUS_FAILURE);
1162 GNUNET_MQ_send (set->client_mq, ev);
1163 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1167 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1168 "client accepting %u\n",
1169 ntohl (msg->accept_reject_id));
1171 GNUNET_assert (GNUNET_YES == op->is_incoming);
1174 op->spec->set = set;
1176 GNUNET_assert (GNUNET_YES == op->is_incoming);
1177 op->is_incoming = GNUNET_NO;
1178 GNUNET_assert (NULL != op->state);
1179 GNUNET_free (op->state);
1181 GNUNET_CONTAINER_DLL_remove (incoming_head,
1185 GNUNET_assert (NULL != op->spec->set);
1186 GNUNET_assert (NULL != op->spec->set->vt);
1188 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
1190 op->spec->client_request_id = ntohl (msg->request_id);
1191 op->spec->result_mode = ntohs (msg->result_mode);
1192 op->generation_created = set->current_generation++;
1193 op->vt = op->spec->set->vt;
1194 GNUNET_assert (NULL != op->vt->accept);
1195 set->vt->accept (op);
1196 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1201 * Called to clean up, after a shutdown has been requested.
1203 * @param cls closure
1204 * @param tc context information (why was this task triggered now)
1207 shutdown_task (void *cls,
1208 const struct GNUNET_SCHEDULER_TaskContext *tc)
1210 while (NULL != incoming_head)
1211 incoming_destroy (incoming_head);
1213 while (NULL != listeners_head)
1214 listener_destroy (listeners_head);
1216 while (NULL != sets_head)
1217 set_destroy (sets_head);
1219 /* it's important to destroy cadet at the end, as all channels
1220 * must be destroyed before the cadet handle! */
1223 GNUNET_CADET_disconnect (cadet);
1226 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1227 "handled shutdown request\n");
1232 * Timeout happens iff:
1233 * - we suggested an operation to our listener,
1234 * but did not receive a response in time
1235 * - we got the channel from a peer but no #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
1236 * - shutdown (obviously)
1238 * @param cls channel context
1239 * @param tc context information (why was this task triggered now)
1242 incoming_timeout_cb (void *cls,
1243 const struct GNUNET_SCHEDULER_TaskContext *tc)
1245 struct Operation *incoming = cls;
1247 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1248 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
1249 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1252 "remote peer timed out\n");
1253 incoming_destroy (incoming);
1258 * Terminates an incoming operation in case we have not yet received an
1259 * operation request. Called by the channel destruction handler.
1261 * @param op the channel context
1264 handle_incoming_disconnect (struct Operation *op)
1266 GNUNET_assert (GNUNET_YES == op->is_incoming);
1267 /* channel is already dead, incoming_destroy must not
1270 incoming_destroy (op);
1276 * Method called whenever another peer has added us to a channel
1277 * the other peer initiated.
1278 * Only called (once) upon reception of data with a message type which was
1279 * subscribed to in GNUNET_CADET_connect().
1281 * The channel context represents the operation itself and gets added to a DLL,
1282 * from where it gets looked up when our local listener client responds
1283 * to a proposed/suggested operation or connects and associates with this operation.
1285 * @param cls closure
1286 * @param channel new handle to the channel
1287 * @param initiator peer that started the channel
1288 * @param port Port this channel is for.
1289 * @param options Unused.
1290 * @return initial channel context for the channel
1291 * (can be NULL -- that's not an error)
1294 channel_new_cb (void *cls,
1295 struct GNUNET_CADET_Channel *channel,
1296 const struct GNUNET_PeerIdentity *initiator,
1297 uint32_t port, enum GNUNET_CADET_ChannelOption options)
1299 struct Operation *incoming;
1300 static const struct SetVT incoming_vt = {
1301 .msg_handler = handle_incoming_msg,
1302 .peer_disconnect = handle_incoming_disconnect
1305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1306 "new incoming channel\n");
1308 if (GNUNET_APPLICATION_TYPE_SET != port)
1311 GNUNET_CADET_channel_destroy (channel);
1315 incoming = GNUNET_new (struct Operation);
1316 incoming->is_incoming = GNUNET_YES;
1317 incoming->state = GNUNET_new (struct OperationState);
1318 incoming->state->peer = *initiator;
1319 incoming->channel = channel;
1320 incoming->mq = GNUNET_CADET_mq_create (incoming->channel);
1321 incoming->vt = &incoming_vt;
1322 incoming->state->timeout_task =
1323 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1324 &incoming_timeout_cb, incoming);
1325 GNUNET_CONTAINER_DLL_insert_tail (incoming_head, incoming_tail, incoming);
1332 * Function called whenever a channel is destroyed. Should clean up
1333 * any associated state. It must NOT call
1334 * GNUNET_CADET_channel_destroy() on the channel.
1336 * The peer_disconnect function is part of a a virtual table set initially either
1337 * when a peer creates a new channel with us (channel_new_cb), or once we create
1338 * a new channel ourselves (evaluate).
1340 * Once we know the exact type of operation (union/intersection), the vt is
1341 * replaced with an operation specific instance (_GSS_[op]_vt).
1343 * @param cls closure (set from GNUNET_CADET_connect())
1344 * @param channel connection to the other end (henceforth invalid)
1345 * @param channel_ctx place where local state associated
1346 * with the channel is stored
1349 channel_end_cb (void *cls,
1350 const struct GNUNET_CADET_Channel *channel, void *channel_ctx)
1352 struct Operation *op = channel_ctx;
1354 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1355 "channel end cb called\n");
1357 /* the vt can be null if a client already requested canceling op. */
1360 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1361 "calling peer disconnect due to channel end\n");
1362 op->vt->peer_disconnect (op);
1365 if (GNUNET_YES == op->keep)
1368 /* cadet will never call us with the context again! */
1369 GNUNET_free (channel_ctx);
1370 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1371 "channel end cb finished\n");
1376 * Functions with this signature are called whenever a message is
1377 * received via a cadet channel.
1379 * The msg_handler is a virtual table set in initially either when a peer
1380 * creates a new channel with us (channel_new_cb), or once we create a new channel
1381 * ourselves (evaluate).
1383 * Once we know the exact type of operation (union/intersection), the vt is
1384 * replaced with an operation specific instance (_GSS_[op]_vt).
1386 * @param cls Closure (set from GNUNET_CADET_connect()).
1387 * @param channel Connection to the other end.
1388 * @param channel_ctx Place to store local state associated with the channel.
1389 * @param message The actual message.
1390 * @return #GNUNET_OK to keep the channel open,
1391 * #GNUNET_SYSERR to close it (signal serious error).
1394 dispatch_p2p_message (void *cls,
1395 struct GNUNET_CADET_Channel *channel,
1397 const struct GNUNET_MessageHeader *message)
1399 struct Operation *op = *channel_ctx;
1402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1403 "dispatching cadet message (type: %u)\n",
1404 ntohs (message->type));
1405 /* do this before the handler, as the handler might kill the channel */
1406 GNUNET_CADET_receive_done (channel);
1408 ret = op->vt->msg_handler (op, message);
1410 ret = GNUNET_SYSERR;
1411 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1412 "handled cadet message (type: %u)\n",
1413 ntohs (message->type));
1419 * Function called by the service's run
1420 * method to run service-specific setup code.
1422 * @param cls closure
1423 * @param server the initialized server
1424 * @param cfg configuration to use
1427 run (void *cls, struct GNUNET_SERVER_Handle *server,
1428 const struct GNUNET_CONFIGURATION_Handle *cfg)
1430 static const struct GNUNET_SERVER_MessageHandler server_handlers[] = {
1431 {handle_client_accept, NULL, GNUNET_MESSAGE_TYPE_SET_ACCEPT,
1432 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1433 {handle_client_iter_ack, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_ACK, 0},
1434 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_ADD, 0},
1435 {handle_client_create_set, NULL, GNUNET_MESSAGE_TYPE_SET_CREATE,
1436 sizeof (struct GNUNET_SET_CreateMessage)},
1437 {handle_client_iterate, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST,
1438 sizeof (struct GNUNET_MessageHeader)},
1439 {handle_client_evaluate, NULL, GNUNET_MESSAGE_TYPE_SET_EVALUATE, 0},
1440 {handle_client_listen, NULL, GNUNET_MESSAGE_TYPE_SET_LISTEN,
1441 sizeof (struct GNUNET_SET_ListenMessage)},
1442 {handle_client_reject, NULL, GNUNET_MESSAGE_TYPE_SET_REJECT,
1443 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1444 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_REMOVE, 0},
1445 {handle_client_cancel, NULL, GNUNET_MESSAGE_TYPE_SET_CANCEL,
1446 sizeof (struct GNUNET_SET_CancelMessage)},
1449 static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1450 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST, 0},
1451 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF, 0},
1452 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS, 0},
1453 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_DONE, 0},
1454 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS, 0},
1455 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE, 0},
1456 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO, 0},
1457 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF, 0},
1458 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF_PART, 0},
1461 static const uint32_t cadet_ports[] = {GNUNET_APPLICATION_TYPE_SET, 0};
1463 configuration = cfg;
1464 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1465 &shutdown_task, NULL);
1466 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1467 GNUNET_SERVER_add_handlers (server, server_handlers);
1469 cadet = GNUNET_CADET_connect (cfg, NULL, channel_new_cb, channel_end_cb,
1470 cadet_handlers, cadet_ports);
1473 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1474 _("Could not connect to cadet service\n"));
1481 * The main function for the set service.
1483 * @param argc number of arguments from the command line
1484 * @param argv command line arguments
1485 * @return 0 ok, 1 on error
1488 main (int argc, char *const *argv)
1492 ret = GNUNET_SERVICE_run (argc, argv, "set",
1493 GNUNET_SERVICE_OPTION_NONE, &run, NULL);
1494 return (GNUNET_OK == ret) ? 0 : 1;
1497 /* end of gnunet-service-set.c */