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 * Unique request id for the request from
46 * a remote peer, sent to the client, which will
47 * accept or reject the request.
48 * Set to '0' iff the request has not been
54 * Timeout task, if the incoming peer has not been accepted
55 * after the timeout, it will be disconnected.
57 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
62 * A listener is inhabited by a client, and
63 * waits for evaluation requests from remote peers.
68 * Listeners are held in a doubly linked list.
70 struct Listener *next;
73 * Listeners are held in a doubly linked list.
75 struct Listener *prev;
78 * Client that owns the listener.
79 * Only one client may own a listener.
81 struct GNUNET_SERVER_Client *client;
84 * Message queue for the client
86 struct GNUNET_MQ_Handle *client_mq;
89 * The type of the operation.
91 enum GNUNET_SET_OperationType operation;
94 * Application ID for the operation, used to distinguish
95 * multiple operations of the same type with the same peer.
97 struct GNUNET_HashCode app_id;
102 * Configuration of our local peer.
104 static const struct GNUNET_CONFIGURATION_Handle *configuration;
107 * Handle to the mesh service, used
108 * to listen for and connect to remote peers.
110 static struct GNUNET_MESH_Handle *mesh;
113 * Sets are held in a doubly linked list.
115 static struct Set *sets_head;
118 * Sets are held in a doubly linked list.
120 static struct Set *sets_tail;
123 * Listeners are held in a doubly linked list.
125 static struct Listener *listeners_head;
128 * Listeners are held in a doubly linked list.
130 static struct Listener *listeners_tail;
133 * Incoming sockets from remote peers are
134 * held in a doubly linked list.
136 static struct Operation *incoming_head;
139 * Incoming sockets from remote peers are
140 * held in a doubly linked list.
142 static struct Operation *incoming_tail;
145 * Counter for allocating unique IDs for clients,
146 * used to identify incoming operation requests from remote peers,
147 * that the client can choose to accept or refuse.
149 static uint32_t suggest_id = 1;
153 * Get set that is owned by the given client, if any.
155 * @param client client to look for
156 * @return set that the client owns, NULL if the client
160 set_get (struct GNUNET_SERVER_Client *client)
164 for (set = sets_head; NULL != set; set = set->next)
165 if (set->client == client)
172 * Get the listener associated with the given client, if any.
174 * @param client the client
175 * @return listener associated with the client, NULL
178 static struct Listener *
179 listener_get (struct GNUNET_SERVER_Client *client)
181 struct Listener *listener;
183 for (listener = listeners_head; NULL != listener; listener = listener->next)
184 if (listener->client == client)
191 * Get the incoming socket associated with the given id.
193 * @param id id to look for
194 * @return the incoming socket associated with the id,
195 * or NULL if there is none
197 static struct Operation *
198 get_incoming (uint32_t id)
200 struct Operation *op;
202 for (op = incoming_head; NULL != op; op = op->next)
203 if (op->state->suggest_id == id)
205 // FIXME: remove this assertion once the corresponding bug is gone!
206 GNUNET_assert (GNUNET_YES == op->is_incoming);
214 * Destroy a listener, free all resources associated with it.
216 * @param listener listener to destroy
219 listener_destroy (struct Listener *listener)
221 /* If the client is not dead yet, destroy it.
222 * The client's destroy callback will destroy the listener again. */
223 if (NULL != listener->client)
225 struct GNUNET_SERVER_Client *client = listener->client;
226 listener->client = NULL;
227 GNUNET_SERVER_client_disconnect (client);
230 if (NULL != listener->client_mq)
232 GNUNET_MQ_destroy (listener->client_mq);
233 listener->client_mq = NULL;
235 GNUNET_CONTAINER_DLL_remove (listeners_head, listeners_tail, listener);
236 GNUNET_free (listener);
241 * Collect and destroy elements that are not needed anymore, because
242 * their lifetime (as determined by their generation) does not overlap with any active
245 * We hereby replace the old element hashmap with a new one, instead of removing elements.
248 collect_generation_garbage (struct Set *set)
250 struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
251 struct ElementEntry *ee;
252 struct GNUNET_CONTAINER_MultiHashMap *new_elements;
254 struct Operation *op;
256 new_elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_NO);
257 iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
259 (res = GNUNET_CONTAINER_multihashmap_iterator_next (iter, NULL, (const void **) &ee)))
261 if (GNUNET_NO == ee->removed)
263 for (op = set->ops_head; NULL != op; op = op->next)
264 if ((op->generation_created >= ee->generation_added) &&
265 (op->generation_created < ee->generation_removed))
270 // we don't expect collisions, thus the replace option
271 GNUNET_CONTAINER_multihashmap_put (new_elements, &ee->element_hash, ee,
272 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
274 GNUNET_CONTAINER_multihashmap_iterator_destroy (iter);
275 GNUNET_CONTAINER_multihashmap_destroy (set->elements);
276 set->elements = new_elements;
281 * Destroy the given operation. Call the implementation-specific cancel function
282 * of the operation. Disconnects from the remote peer.
283 * Does not disconnect the client, as there may be multiple operations per set.
285 * @param op operation to destroy
288 _GSS_operation_destroy (struct Operation *op)
291 struct GNUNET_MESH_Channel *channel;
298 GNUNET_assert (GNUNET_NO == op->is_incoming);
299 GNUNET_assert (NULL != op->spec);
300 GNUNET_CONTAINER_DLL_remove (op->spec->set->ops_head,
301 op->spec->set->ops_tail,
307 if (NULL != op->spec)
309 if (NULL != op->spec->context_msg)
311 GNUNET_free (op->spec->context_msg);
312 op->spec->context_msg = NULL;
314 GNUNET_free (op->spec);
320 GNUNET_MQ_destroy (op->mq);
324 if (NULL != (channel = op->channel))
327 GNUNET_MESH_channel_destroy (channel);
330 collect_generation_garbage (set);
332 /* We rely on the channel end handler to free 'op'. When 'op->channel' was NULL,
333 * there was a channel end handler that will free 'op' on the call stack. */
338 * Iterator over hash map entries to free
342 * @param key current key code
343 * @param value a `struct ElementEntry *` to be free'd
344 * @return #GNUNET_YES if we should continue to
349 destroy_elements_iterator (void *cls,
350 const struct GNUNET_HashCode * key,
353 struct ElementEntry *ee = value;
361 * Destroy a set, and free all resources associated with it.
363 * @param set the set to destroy
366 set_destroy (struct Set *set)
368 /* If the client is not dead yet, destroy it.
369 * The client's destroy callback will destroy the set again.
370 * We do this so that the channel end handler still has a valid set handle
372 if (NULL != set->client)
374 struct GNUNET_SERVER_Client *client = set->client;
376 GNUNET_SERVER_client_disconnect (client);
379 GNUNET_assert (NULL != set->state);
380 while (NULL != set->ops_head)
381 _GSS_operation_destroy (set->ops_head);
382 set->vt->destroy_set (set->state);
384 if (NULL != set->client_mq)
386 GNUNET_MQ_destroy (set->client_mq);
387 set->client_mq = NULL;
389 if (NULL != set->iter)
391 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
394 GNUNET_CONTAINER_DLL_remove (sets_head, sets_tail, set);
395 if (NULL != set->elements)
397 // free all elements in the hashtable, before destroying the table
398 GNUNET_CONTAINER_multihashmap_iterate (set->elements,
399 destroy_elements_iterator, NULL);
400 GNUNET_CONTAINER_multihashmap_destroy (set->elements);
401 set->elements = NULL;
408 * Clean up after a client has disconnected
410 * @param cls closure, unused
411 * @param client the client to clean up after
414 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
417 struct Listener *listener;
419 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
420 "client disconnected, cleaning up\n");
421 set = set_get (client);
426 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
427 "(client's set destroyed)\n");
429 listener = listener_get (client);
430 if (NULL != listener)
432 listener->client = NULL;
433 listener_destroy (listener);
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
435 "(client's listener destroyed)\n");
441 * Destroy an incoming request from a remote peer
443 * @param incoming remote request to destroy
446 incoming_destroy (struct Operation *incoming)
448 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
449 GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
450 if (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task)
452 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
453 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
455 GNUNET_assert (NULL != incoming->state);
456 GNUNET_free (incoming->state);
457 // make sure that the tunnel end handler will not
460 incoming->state = NULL;
461 if (NULL != incoming->mq)
463 GNUNET_MQ_destroy (incoming->mq);
466 if (NULL != incoming->channel)
468 GNUNET_MESH_channel_destroy (incoming->channel);
469 incoming->channel = NULL;
475 * remove & free state of the operation from the incoming list
477 * @param incoming the element to remove
480 incoming_retire (struct Operation *incoming)
482 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
483 incoming->is_incoming = GNUNET_NO;
484 GNUNET_assert (NULL != incoming->state);
485 GNUNET_free (incoming->state);
486 incoming->state = NULL;
487 GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
492 * Find a listener that is interested in the given operation type
493 * and application id.
495 * @param op operation type to look for
496 * @param app_id application id to look for
497 * @return a matching listener, or NULL if no listener matches the
498 * given operation and application id
500 static struct Listener *
501 listener_get_by_target (enum GNUNET_SET_OperationType op,
502 const struct GNUNET_HashCode *app_id)
506 for (l = listeners_head; NULL != l; l = l->next)
508 if (l->operation != op)
510 if (0 != GNUNET_CRYPTO_hash_cmp (app_id, &l->app_id))
519 * Suggest the given request to the listener. The listening client can then
520 * accept or reject the remote request.
522 * @param incoming the incoming peer with the request to suggest
523 * @param listener the listener to suggest the request to
526 incoming_suggest (struct Operation *incoming, struct Listener *listener)
528 struct GNUNET_MQ_Envelope *mqm;
529 struct GNUNET_SET_RequestMessage *cmsg;
531 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
532 GNUNET_assert (NULL != incoming->state);
533 GNUNET_assert (NULL != incoming->spec);
534 GNUNET_assert (0 == incoming->state->suggest_id);
535 incoming->state->suggest_id = suggest_id++;
537 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task);
538 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
539 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
541 mqm = GNUNET_MQ_msg_nested_mh (cmsg, GNUNET_MESSAGE_TYPE_SET_REQUEST,
542 incoming->spec->context_msg);
543 GNUNET_assert (NULL != mqm);
544 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "suggesting request with accept id %u\n",
545 incoming->state->suggest_id);
546 cmsg->accept_id = htonl (incoming->state->suggest_id);
547 cmsg->peer_id = incoming->spec->peer;
548 GNUNET_MQ_send (listener->client_mq, mqm);
553 * Handle a request for a set operation from
556 * This msg is expected as the first and only msg handled through the
557 * non-operation bound virtual table, acceptance of this operation replaces
558 * our virtual table and subsequent msgs would be routed differently.
560 * @param op the operation state
561 * @param mh the received message
562 * @return #GNUNET_OK if the channel should be kept alive,
563 * #GNUNET_SYSERR to destroy the channel
566 handle_incoming_msg (struct Operation *op,
567 const struct GNUNET_MessageHeader *mh)
569 const struct OperationRequestMessage *msg = (const struct OperationRequestMessage *) mh;
570 struct Listener *listener;
571 struct OperationSpecification *spec;
573 GNUNET_assert (GNUNET_YES == op->is_incoming);
575 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got op request\n");
577 if (GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST != ntohs (mh->type))
580 return GNUNET_SYSERR;
583 /* double operation request */
584 if (NULL != op->spec)
587 return GNUNET_SYSERR;
590 spec = GNUNET_new (struct OperationSpecification);
591 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
592 // for simplicity we just backup the context msg instead of rebuilding it later on
593 if (NULL != spec->context_msg)
594 spec->context_msg = GNUNET_copy_message (spec->context_msg);
595 spec->operation = ntohl (msg->operation);
596 spec->app_id = msg->app_id;
597 spec->salt = ntohl (msg->salt);
598 spec->peer = op->state->peer;
599 spec->remote_element_count = ntohl (msg->element_count);
603 if ( (NULL != spec->context_msg) &&
604 (ntohs (spec->context_msg->size) > GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE) )
607 return GNUNET_SYSERR;
610 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received P2P operation request (op %u, app %s)\n",
611 ntohl (msg->operation), GNUNET_h2s (&msg->app_id));
612 listener = listener_get_by_target (ntohl (msg->operation), &msg->app_id);
613 if (NULL == listener)
615 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
616 "no listener matches incoming request, waiting with timeout\n");
619 incoming_suggest (op, listener);
625 * Send the next element of a set to the set's client. The next element is given by
626 * the set's current hashmap iterator. The set's iterator will be set to NULL if there
627 * are no more elements in the set. The caller must ensure that the set's iterator is
630 * @param set set that should send its next element to its client
633 send_client_element (struct Set *set)
636 struct ElementEntry *ee;
637 struct GNUNET_MQ_Envelope *ev;
639 GNUNET_assert (NULL != set->iter);
640 ret = GNUNET_CONTAINER_multihashmap_iterator_next (set->iter, NULL, (const void **) &ee);
641 if (GNUNET_NO == ret)
643 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_DONE);
644 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
649 struct GNUNET_SET_IterResponseMessage *msg;
651 GNUNET_assert (NULL != ee);
652 ev = GNUNET_MQ_msg_extra (msg, ee->element.size, GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT);
653 memcpy (&msg[1], ee->element.data, ee->element.size);
654 msg->element_type = ee->element.type;
656 GNUNET_MQ_send (set->client_mq, ev);
661 * Called when a client wants to iterate the elements of a set.
664 * @param client client that sent the message
665 * @param m message sent by the client
668 handle_client_iterate (void *cls,
669 struct GNUNET_SERVER_Client *client,
670 const struct GNUNET_MessageHeader *m)
674 // iterate over a non existing set
675 set = set_get (client);
679 GNUNET_SERVER_client_disconnect (client);
683 // only one concurrent iterate-action per set
684 if (NULL != set->iter)
687 GNUNET_SERVER_client_disconnect (client);
690 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "iterating union set with %u elements\n",
691 GNUNET_CONTAINER_multihashmap_size (set->elements));
692 GNUNET_SERVER_receive_done (client, GNUNET_OK);
693 set->iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
694 send_client_element (set);
699 * Called when a client wants to create a new set.
702 * @param client client that sent the message
703 * @param m message sent by the client
706 handle_client_create_set (void *cls,
707 struct GNUNET_SERVER_Client *client,
708 const struct GNUNET_MessageHeader *m)
710 const struct GNUNET_SET_CreateMessage *msg;
713 msg = (const struct GNUNET_SET_CreateMessage *) m;
714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
715 "client created new set (operation %u)\n",
716 ntohs (msg->operation));
718 // max. one set per client!
719 if (NULL != set_get (client))
722 GNUNET_SERVER_client_disconnect (client);
726 set = GNUNET_new (struct Set);
728 switch (ntohs (msg->operation))
730 case GNUNET_SET_OPERATION_INTERSECTION:
731 // FIXME: implement intersection vt
732 // set->vt = _GSS_intersection_vt ();
734 case GNUNET_SET_OPERATION_UNION:
735 set->vt = _GSS_union_vt ();
740 GNUNET_SERVER_client_disconnect (client);
744 set->state = set->vt->create ();
745 set->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
746 set->client = client;
747 set->client_mq = GNUNET_MQ_queue_for_server_client (client);
748 GNUNET_CONTAINER_DLL_insert (sets_head, sets_tail, set);
749 GNUNET_SERVER_receive_done (client, GNUNET_OK);
754 * Called when a client wants to create a new listener.
757 * @param client client that sent the message
758 * @param m message sent by the client
761 handle_client_listen (void *cls,
762 struct GNUNET_SERVER_Client *client,
763 const struct GNUNET_MessageHeader *m)
765 const struct GNUNET_SET_ListenMessage *msg;
766 struct Listener *listener;
767 struct Operation *op;
769 msg = (const struct GNUNET_SET_ListenMessage *) m;
770 /* max. one per client! */
771 if (NULL != listener_get (client))
774 GNUNET_SERVER_client_disconnect (client);
778 listener = GNUNET_new (struct Listener);
779 listener->client = client;
780 listener->client_mq = GNUNET_MQ_queue_for_server_client (client);
781 listener->app_id = msg->app_id;
782 listener->operation = ntohl (msg->operation);
783 GNUNET_CONTAINER_DLL_insert_tail (listeners_head, listeners_tail, listener);
784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
785 "new listener created (op %u, app %s)\n",
787 GNUNET_h2s (&listener->app_id));
789 /* check for incoming requests the listener is interested in */
790 for (op = incoming_head; NULL != op; op = op->next)
792 if (NULL == op->spec)
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
795 "request has no spec yet\n");
798 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
799 "considering (op: %u, app: %s, suggest: %u)\n",
801 GNUNET_h2s (&op->spec->app_id),
802 op->state->suggest_id);
804 /* don't consider the incoming request if it has been already suggested to a listener */
805 if (0 != op->state->suggest_id)
807 if (listener->operation != op->spec->operation)
809 if (0 != GNUNET_CRYPTO_hash_cmp (&listener->app_id, &op->spec->app_id))
811 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
812 "request suggested\n");
813 incoming_suggest (op, listener);
815 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
816 "considered all incoming requests\n");
817 GNUNET_SERVER_receive_done (client, GNUNET_OK);
822 * Called when the listening client rejects an operation
823 * request by another peer.
826 * @param client client that sent the message
827 * @param m message sent by the client
830 handle_client_reject (void *cls,
831 struct GNUNET_SERVER_Client *client,
832 const struct GNUNET_MessageHeader *m)
834 struct Operation *incoming;
835 const struct GNUNET_SET_AcceptRejectMessage *msg;
837 msg = (const struct GNUNET_SET_AcceptRejectMessage *) m;
838 GNUNET_break (0 == ntohl (msg->request_id));
840 // no matching incoming operation for this reject
841 incoming = get_incoming (ntohl (msg->accept_reject_id));
842 if (NULL == incoming)
844 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
847 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
848 "peer request rejected by client\n");
850 GNUNET_MESH_channel_destroy (incoming->channel);
851 //channel destruction handler called immediately upon destruction
852 GNUNET_SERVER_receive_done (client, GNUNET_OK);
857 * Called when a client wants to add/remove an element to/from a
861 * @param client client that sent the message
862 * @param m message sent by the client
865 handle_client_add_remove (void *cls,
866 struct GNUNET_SERVER_Client *client,
867 const struct GNUNET_MessageHeader *m)
870 const struct GNUNET_SET_ElementMessage *msg;
871 struct GNUNET_SET_Element el;
872 struct ElementEntry *ee;
874 // client without a set requested an operation
875 set = set_get (client);
879 GNUNET_SERVER_client_disconnect (client);
882 GNUNET_SERVER_receive_done (client, GNUNET_OK);
883 msg = (const struct GNUNET_SET_ElementMessage *) m;
884 el.size = ntohs (m->size) - sizeof *msg;
885 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
886 "client ins/rem element of size %u\n", el.size);
888 if (GNUNET_MESSAGE_TYPE_SET_REMOVE == ntohs (m->type))
890 struct GNUNET_HashCode hash;
892 GNUNET_CRYPTO_hash (el.data, el.size, &hash);
893 ee = GNUNET_CONTAINER_multihashmap_get (set->elements, &hash);
896 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
897 "client tried to remove non-existing element\n");
900 if (GNUNET_YES == ee->removed)
902 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
903 "client tried to remove element twice\n");
906 ee->removed = GNUNET_YES;
907 ee->generation_removed = set->current_generation;
908 set->vt->remove (set->state, ee);
912 struct ElementEntry *ee_dup;
914 ee = GNUNET_malloc (el.size + sizeof *ee);
915 ee->element.size = el.size;
916 memcpy (&ee[1], el.data, el.size);
917 ee->element.data = &ee[1];
918 ee->generation_added = set->current_generation;
919 ee->remote = GNUNET_NO;
920 GNUNET_CRYPTO_hash (ee->element.data, el.size, &ee->element_hash);
921 ee_dup = GNUNET_CONTAINER_multihashmap_get (set->elements,
925 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
926 "element inserted twice, ignoring\n");
930 GNUNET_CONTAINER_multihashmap_put (set->elements, &ee->element_hash, ee,
931 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
932 set->vt->add (set->state, ee);
938 * Called when a client wants to evaluate a set operation with another peer.
941 * @param client client that sent the message
942 * @param m message sent by the client
945 handle_client_evaluate (void *cls,
946 struct GNUNET_SERVER_Client *client,
947 const struct GNUNET_MessageHeader *m)
950 const struct GNUNET_SET_EvaluateMessage *msg;
951 struct OperationSpecification *spec;
952 struct Operation *op;
954 set = set_get (client);
958 GNUNET_SERVER_client_disconnect (client);
962 msg = (const struct GNUNET_SET_EvaluateMessage *) m;
963 spec = GNUNET_new (struct OperationSpecification);
964 spec->operation = set->operation;
965 spec->app_id = msg->app_id;
966 spec->salt = ntohl (msg->salt);
967 spec->peer = msg->target_peer;
969 spec->result_mode = ntohs (msg->result_mode);
970 spec->client_request_id = ntohl (msg->request_id);
971 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
973 // for simplicity we just backup the context msg instead of rebuilding it later on
974 if (NULL != spec->context_msg)
975 spec->context_msg = GNUNET_copy_message (spec->context_msg);
977 op = GNUNET_new (struct Operation);
979 op->generation_created = set->current_generation++;
981 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
983 op->channel = GNUNET_MESH_channel_create (mesh, op, &msg->target_peer,
984 GNUNET_APPLICATION_TYPE_SET,
985 GNUNET_MESH_OPTION_RELIABLE);
987 op->mq = GNUNET_MESH_mq_create (op->channel);
989 set->vt->evaluate (op);
990 GNUNET_SERVER_receive_done (client, GNUNET_OK);
995 * Handle an ack from a client, and send the next element.
998 * @param client the client
999 * @param m the message
1002 handle_client_iter_ack (void *cls,
1003 struct GNUNET_SERVER_Client *client,
1004 const struct GNUNET_MessageHeader *m)
1008 // client without a set requested an operation
1009 set = set_get (client);
1013 GNUNET_SERVER_client_disconnect (client);
1017 // client sent an ack, but we were not expecting one
1018 if (NULL == set->iter)
1021 GNUNET_SERVER_client_disconnect (client);
1025 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1026 send_client_element (set);
1031 * Handle a request from the client to
1032 * cancel a running set operation.
1035 * @param client the client
1036 * @param mh the message
1039 handle_client_cancel (void *cls,
1040 struct GNUNET_SERVER_Client *client,
1041 const struct GNUNET_MessageHeader *mh)
1043 const struct GNUNET_SET_CancelMessage *msg =
1044 (const struct GNUNET_SET_CancelMessage *) mh;
1046 struct Operation *op;
1049 // client without a set requested an operation
1050 set = set_get (client);
1054 GNUNET_SERVER_client_disconnect (client);
1058 for (op = set->ops_head; NULL != op; op = op->next)
1060 if (op->spec->client_request_id == msg->request_id)
1067 if (GNUNET_NO == found)
1070 GNUNET_SERVER_client_disconnect (client);
1074 _GSS_operation_destroy (op);
1079 * Handle a request from the client to accept
1080 * a set operation that came from a remote peer.
1081 * We forward the accept to the associated operation for handling
1084 * @param client the client
1085 * @param mh the message
1088 handle_client_accept (void *cls,
1089 struct GNUNET_SERVER_Client *client,
1090 const struct GNUNET_MessageHeader *mh)
1093 const struct GNUNET_SET_AcceptRejectMessage *msg;
1094 struct Operation *op;
1096 msg = (const struct GNUNET_SET_AcceptRejectMessage *) mh;
1097 op = get_incoming (ntohl (msg->accept_reject_id));
1099 // incoming operation does not exist
1103 GNUNET_SERVER_client_disconnect (client);
1107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1108 "client accepting %u\n",
1109 ntohl (msg->accept_reject_id));
1111 GNUNET_assert (GNUNET_YES == op->is_incoming);
1113 // client without a set requested an operation
1114 set = set_get (client);
1119 GNUNET_SERVER_client_disconnect (client);
1123 op->spec->set = set;
1125 incoming_retire (op);
1127 GNUNET_assert (NULL != op->spec->set);
1128 GNUNET_assert (NULL != op->spec->set->vt);
1130 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
1132 op->spec->client_request_id = ntohl (msg->request_id);
1133 op->spec->result_mode = ntohs (msg->result_mode);
1134 op->generation_created = set->current_generation++;
1135 op->vt = op->spec->set->vt;
1136 GNUNET_assert (NULL != op->vt->accept);
1137 set->vt->accept (op);
1138 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1143 * Called to clean up, after a shutdown has been requested.
1145 * @param cls closure
1146 * @param tc context information (why was this task triggered now)
1149 shutdown_task (void *cls,
1150 const struct GNUNET_SCHEDULER_TaskContext *tc)
1152 while (NULL != incoming_head)
1153 incoming_destroy (incoming_head);
1155 while (NULL != listeners_head)
1156 listener_destroy (listeners_head);
1158 while (NULL != sets_head)
1159 set_destroy (sets_head);
1161 /* it's important to destroy mesh at the end, as all channels
1162 * must be destroyed before the mesh handle! */
1165 GNUNET_MESH_disconnect (mesh);
1168 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1169 "handled shutdown request\n");
1174 * Timeout happens iff:
1175 * - we suggested an operation to our listener,
1176 * but did not receive a response in time
1177 * - we got the channel from a peer but no #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
1178 * - shutdown (obviously)
1180 * @param cls channel context
1181 * @param tc context information (why was this task triggered now)
1184 incoming_timeout_cb (void *cls,
1185 const struct GNUNET_SCHEDULER_TaskContext *tc)
1187 struct Operation *incoming = cls;
1189 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1190 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
1191 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1194 "remote peer timed out\n");
1195 incoming_destroy (incoming);
1200 * Terminates an incoming operation in case we have not yet received an
1201 * operation request. Called by the channel destruction handler.
1203 * @param op the channel context
1206 handle_incoming_disconnect (struct Operation *op)
1208 GNUNET_assert (GNUNET_YES == op->is_incoming);
1209 /* channel is already dead, incoming_destroy must not
1212 incoming_destroy (op);
1218 * Method called whenever another peer has added us to a channel
1219 * the other peer initiated.
1220 * Only called (once) upon reception of data with a message type which was
1221 * subscribed to in GNUNET_MESH_connect().
1223 * The channel context represents the operation itself and gets added to a DLL,
1224 * from where it gets looked up when our local listener client responds
1225 * to a proposed/suggested operation or connects and associates with this operation.
1227 * @param cls closure
1228 * @param channel new handle to the channel
1229 * @param initiator peer that started the channel
1230 * @param port Port this channel is for.
1231 * @param options Unused.
1232 * @return initial channel context for the channel
1233 * (can be NULL -- that's not an error)
1236 channel_new_cb (void *cls,
1237 struct GNUNET_MESH_Channel *channel,
1238 const struct GNUNET_PeerIdentity *initiator,
1239 uint32_t port, enum GNUNET_MESH_ChannelOption options)
1241 struct Operation *incoming;
1242 static const struct SetVT incoming_vt = {
1243 .msg_handler = handle_incoming_msg,
1244 .peer_disconnect = handle_incoming_disconnect
1247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1248 "new incoming channel\n");
1250 if (GNUNET_APPLICATION_TYPE_SET != port)
1253 GNUNET_MESH_channel_destroy (channel);
1257 incoming = GNUNET_new (struct Operation);
1258 incoming->is_incoming = GNUNET_YES;
1259 incoming->state = GNUNET_new (struct OperationState);
1260 incoming->state->peer = *initiator;
1261 incoming->channel = channel;
1262 incoming->mq = GNUNET_MESH_mq_create (incoming->channel);
1263 incoming->vt = &incoming_vt;
1264 incoming->state->timeout_task =
1265 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1266 &incoming_timeout_cb, incoming);
1267 GNUNET_CONTAINER_DLL_insert_tail (incoming_head, incoming_tail, incoming);
1274 * Function called whenever a channel is destroyed. Should clean up
1275 * any associated state. It must NOT call
1276 * GNUNET_MESH_channel_destroy() on the channel.
1278 * The peer_disconnect function is part of a a virtual table set initially either
1279 * when a peer creates a new channel with us (channel_new_cb), or once we create
1280 * a new channel ourselves (evaluate).
1282 * Once we know the exact type of operation (union/intersection), the vt is
1283 * replaced with an operation specific instance (_GSS_[op]_vt).
1285 * @param cls closure (set from GNUNET_MESH_connect())
1286 * @param channel connection to the other end (henceforth invalid)
1287 * @param channel_ctx place where local state associated
1288 * with the channel is stored
1291 channel_end_cb (void *cls,
1292 const struct GNUNET_MESH_Channel *channel, void *channel_ctx)
1294 struct Operation *op = channel_ctx;
1296 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1297 "channel end cb called\n");
1299 /* the vt can be null if a client already requested canceling op. */
1302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1303 "calling peer disconnect due to channel end\n");
1304 op->vt->peer_disconnect (op);
1307 if (GNUNET_YES == op->keep)
1310 /* mesh will never call us with the context again! */
1311 GNUNET_free (channel_ctx);
1312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1313 "channel end cb finished\n");
1318 * Functions with this signature are called whenever a message is
1319 * received via a mesh channel.
1321 * The msg_handler is a virtual table set in initially either when a peer
1322 * creates a new channel with us (channel_new_cb), or once we create a new channel
1323 * ourselves (evaluate).
1325 * Once we know the exact type of operation (union/intersection), the vt is
1326 * replaced with an operation specific instance (_GSS_[op]_vt).
1328 * @param cls Closure (set from GNUNET_MESH_connect()).
1329 * @param channel Connection to the other end.
1330 * @param channel_ctx Place to store local state associated with the channel.
1331 * @param message The actual message.
1332 * @return #GNUNET_OK to keep the channel open,
1333 * #GNUNET_SYSERR to close it (signal serious error).
1336 dispatch_p2p_message (void *cls,
1337 struct GNUNET_MESH_Channel *channel,
1339 const struct GNUNET_MessageHeader *message)
1341 struct Operation *op = *channel_ctx;
1344 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1345 "dispatching mesh message (type: %u)\n",
1346 ntohs (message->type));
1347 /* do this before the handler, as the handler might kill the channel */
1348 GNUNET_MESH_receive_done (channel);
1350 ret = op->vt->msg_handler (op, message);
1352 ret = GNUNET_SYSERR;
1353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1354 "handled mesh message (type: %u)\n",
1355 ntohs (message->type));
1361 * Function called by the service's run
1362 * method to run service-specific setup code.
1364 * @param cls closure
1365 * @param server the initialized server
1366 * @param cfg configuration to use
1369 run (void *cls, struct GNUNET_SERVER_Handle *server,
1370 const struct GNUNET_CONFIGURATION_Handle *cfg)
1372 static const struct GNUNET_SERVER_MessageHandler server_handlers[] = {
1373 {handle_client_accept, NULL, GNUNET_MESSAGE_TYPE_SET_ACCEPT,
1374 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1375 {handle_client_iter_ack, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_ACK, 0},
1376 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_ADD, 0},
1377 {handle_client_create_set, NULL, GNUNET_MESSAGE_TYPE_SET_CREATE,
1378 sizeof (struct GNUNET_SET_CreateMessage)},
1379 {handle_client_iterate, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST,
1380 sizeof (struct GNUNET_MessageHeader)},
1381 {handle_client_evaluate, NULL, GNUNET_MESSAGE_TYPE_SET_EVALUATE, 0},
1382 {handle_client_listen, NULL, GNUNET_MESSAGE_TYPE_SET_LISTEN,
1383 sizeof (struct GNUNET_SET_ListenMessage)},
1384 {handle_client_reject, NULL, GNUNET_MESSAGE_TYPE_SET_REJECT,
1385 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1386 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_REMOVE, 0},
1387 {handle_client_cancel, NULL, GNUNET_MESSAGE_TYPE_SET_CANCEL,
1388 sizeof (struct GNUNET_SET_CancelMessage)},
1391 static const struct GNUNET_MESH_MessageHandler mesh_handlers[] = {
1392 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST, 0},
1393 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF, 0},
1394 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS, 0},
1395 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_DONE, 0},
1396 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS, 0},
1397 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE, 0},
1398 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO, 0},
1399 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF, 0},
1400 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF_PART, 0},
1403 static const uint32_t mesh_ports[] = {GNUNET_APPLICATION_TYPE_SET, 0};
1405 configuration = cfg;
1406 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1407 &shutdown_task, NULL);
1408 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1409 GNUNET_SERVER_add_handlers (server, server_handlers);
1411 mesh = GNUNET_MESH_connect (cfg, NULL, channel_new_cb, channel_end_cb,
1412 mesh_handlers, mesh_ports);
1415 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1416 _("Could not connect to mesh service\n"));
1423 * The main function for the set service.
1425 * @param argc number of arguments from the command line
1426 * @param argv command line arguments
1427 * @return 0 ok, 1 on error
1430 main (int argc, char *const *argv)
1434 ret = GNUNET_SERVICE_run (argc, argv, "set",
1435 GNUNET_SERVICE_OPTION_NONE, &run, NULL);
1436 return (GNUNET_OK == ret) ? 0 : 1;
1439 /* end of gnunet-service-set.c */