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)
210 * Destroy a listener, free all resources associated with it.
212 * @param listener listener to destroy
215 listener_destroy (struct Listener *listener)
217 /* If the client is not dead yet, destroy it.
218 * The client's destroy callback will destroy the listener again. */
219 if (NULL != listener->client)
221 struct GNUNET_SERVER_Client *client = listener->client;
222 listener->client = NULL;
223 GNUNET_SERVER_client_disconnect (client);
226 if (NULL != listener->client_mq)
228 GNUNET_MQ_destroy (listener->client_mq);
229 listener->client_mq = NULL;
231 GNUNET_CONTAINER_DLL_remove (listeners_head, listeners_tail, listener);
232 GNUNET_free (listener);
237 * Collect and destroy elements that are not needed anymore, because
238 * their lifetime (as determined by their generation) does not overlap with any active
241 * We hereby replace the old element hashmap with a new one, instead of removing elements.
244 collect_generation_garbage (struct Set *set)
246 struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
247 struct ElementEntry *ee;
248 struct GNUNET_CONTAINER_MultiHashMap *new_elements;
250 struct Operation *op;
252 new_elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_NO);
253 iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
255 (res = GNUNET_CONTAINER_multihashmap_iterator_next (iter, NULL, (const void **) &ee)))
257 if (GNUNET_NO == ee->removed)
259 for (op = set->ops_head; NULL != op; op = op->next)
260 if ((op->generation_created >= ee->generation_added) &&
261 (op->generation_created < ee->generation_removed))
266 // we don't expect collisions, thus the replace option
267 GNUNET_CONTAINER_multihashmap_put (new_elements, &ee->element_hash, ee,
268 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
270 GNUNET_CONTAINER_multihashmap_iterator_destroy (iter);
271 GNUNET_CONTAINER_multihashmap_destroy (set->elements);
272 set->elements = new_elements;
277 * Destroy the given operation. Call the implementation-specific cancel function
278 * of the operation. Disconnects from the remote peer.
279 * Does not disconnect the client, as there may be multiple operations per set.
281 * @param op operation to destroy
284 _GSS_operation_destroy (struct Operation *op)
287 struct GNUNET_MESH_Channel *channel;
294 GNUNET_assert (GNUNET_NO == op->is_incoming);
295 GNUNET_assert (NULL != op->spec);
296 GNUNET_CONTAINER_DLL_remove (op->spec->set->ops_head,
297 op->spec->set->ops_tail,
303 if (NULL != op->spec)
305 if (NULL != op->spec->context_msg)
307 GNUNET_free (op->spec->context_msg);
308 op->spec->context_msg = NULL;
310 GNUNET_free (op->spec);
316 GNUNET_MQ_destroy (op->mq);
320 if (NULL != (channel = op->channel))
323 GNUNET_MESH_channel_destroy (channel);
326 collect_generation_garbage (set);
328 /* We rely on the channel end handler to free 'op'. When 'op->channel' was NULL,
329 * there was a channel end handler that will free 'op' on the call stack. */
334 * Iterator over hash map entries to free
338 * @param key current key code
339 * @param value a `struct ElementEntry *` to be free'd
340 * @return #GNUNET_YES if we should continue to
345 destroy_elements_iterator (void *cls,
346 const struct GNUNET_HashCode * key,
349 struct ElementEntry *ee = value;
357 * Destroy a set, and free all resources associated with it.
359 * @param set the set to destroy
362 set_destroy (struct Set *set)
364 /* If the client is not dead yet, destroy it.
365 * The client's destroy callback will destroy the set again.
366 * We do this so that the channel end handler still has a valid set handle
368 if (NULL != set->client)
370 struct GNUNET_SERVER_Client *client = set->client;
372 GNUNET_SERVER_client_disconnect (client);
375 GNUNET_assert (NULL != set->state);
376 while (NULL != set->ops_head)
377 _GSS_operation_destroy (set->ops_head);
378 set->vt->destroy_set (set->state);
380 if (NULL != set->client_mq)
382 GNUNET_MQ_destroy (set->client_mq);
383 set->client_mq = NULL;
385 if (NULL != set->iter)
387 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
390 GNUNET_CONTAINER_DLL_remove (sets_head, sets_tail, set);
391 if (NULL != set->elements)
393 // free all elements in the hashtable, before destroying the table
394 GNUNET_CONTAINER_multihashmap_iterate (set->elements,
395 destroy_elements_iterator, NULL);
396 GNUNET_CONTAINER_multihashmap_destroy (set->elements);
397 set->elements = NULL;
404 * Clean up after a client has disconnected
406 * @param cls closure, unused
407 * @param client the client to clean up after
410 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
413 struct Listener *listener;
415 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
416 "client disconnected, cleaning up\n");
417 set = set_get (client);
422 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
423 "(client's set destroyed)\n");
425 listener = listener_get (client);
426 if (NULL != listener)
428 listener->client = NULL;
429 listener_destroy (listener);
430 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
431 "(client's listener destroyed)\n");
437 * Destroy an incoming request from a remote peer
439 * @param incoming remote request to destroy
442 incoming_destroy (struct Operation *incoming)
444 GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
445 if (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task)
447 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
448 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
450 GNUNET_free (incoming->state);
455 * remove & free state of the operation from the incoming list
457 * @param incoming the element to remove
460 incoming_retire (struct Operation *incoming)
462 incoming->is_incoming = GNUNET_NO;
463 GNUNET_free (incoming->state);
464 incoming->state = NULL;
465 GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
470 * Find a listener that is interested in the given operation type
471 * and application id.
473 * @param op operation type to look for
474 * @param app_id application id to look for
475 * @return a matching listener, or NULL if no listener matches the
476 * given operation and application id
478 static struct Listener *
479 listener_get_by_target (enum GNUNET_SET_OperationType op,
480 const struct GNUNET_HashCode *app_id)
484 for (l = listeners_head; NULL != l; l = l->next)
486 if (l->operation != op)
488 if (0 != GNUNET_CRYPTO_hash_cmp (app_id, &l->app_id))
497 * Suggest the given request to the listener. The listening client can then
498 * accept or reject the remote request.
500 * @param incoming the incoming peer with the request to suggest
501 * @param listener the listener to suggest the request to
504 incoming_suggest (struct Operation *incoming, struct Listener *listener)
506 struct GNUNET_MQ_Envelope *mqm;
507 struct GNUNET_SET_RequestMessage *cmsg;
509 GNUNET_assert (NULL != incoming->spec);
510 GNUNET_assert (0 == incoming->state->suggest_id);
511 incoming->state->suggest_id = suggest_id++;
513 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task);
514 GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
515 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
517 mqm = GNUNET_MQ_msg_nested_mh (cmsg, GNUNET_MESSAGE_TYPE_SET_REQUEST,
518 incoming->spec->context_msg);
519 GNUNET_assert (NULL != mqm);
520 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "suggesting request with accept id %u\n",
521 incoming->state->suggest_id);
522 cmsg->accept_id = htonl (incoming->state->suggest_id);
523 cmsg->peer_id = incoming->spec->peer;
524 GNUNET_MQ_send (listener->client_mq, mqm);
529 * Handle a request for a set operation from
532 * This msg is expected as the first and only msg handled through the
533 * non-operation bound virtual table, acceptance of this operation replaces
534 * our virtual table and subsequent msgs would be routed differently.
536 * @param op the operation state
537 * @param mh the received message
538 * @return #GNUNET_OK if the channel should be kept alive,
539 * #GNUNET_SYSERR to destroy the channel
542 handle_incoming_msg (struct Operation *op,
543 const struct GNUNET_MessageHeader *mh)
545 const struct OperationRequestMessage *msg = (const struct OperationRequestMessage *) mh;
546 struct Listener *listener;
547 struct OperationSpecification *spec;
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got op request\n");
551 if (GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST != ntohs (mh->type))
554 return GNUNET_SYSERR;
557 /* double operation request */
558 if (NULL != op->spec)
561 return GNUNET_SYSERR;
564 spec = GNUNET_new (struct OperationSpecification);
565 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
566 // for simplicity we just backup the context msg instead of rebuilding it later on
567 if (NULL != spec->context_msg)
568 spec->context_msg = GNUNET_copy_message (spec->context_msg);
569 spec->operation = ntohl (msg->operation);
570 spec->app_id = msg->app_id;
571 spec->salt = ntohl (msg->salt);
572 spec->peer = op->state->peer;
573 spec->remote_element_count = ntohl (msg->element_count);
577 if ( (NULL != spec->context_msg) &&
578 (ntohs (spec->context_msg->size) > GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE) )
581 return GNUNET_SYSERR;
584 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received P2P operation request (op %u, app %s)\n",
585 ntohl (msg->operation), GNUNET_h2s (&msg->app_id));
586 listener = listener_get_by_target (ntohl (msg->operation), &msg->app_id);
587 if (NULL == listener)
589 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
590 "no listener matches incoming request, waiting with timeout\n");
593 incoming_suggest (op, listener);
599 * Send the next element of a set to the set's client. The next element is given by
600 * the set's current hashmap iterator. The set's iterator will be set to NULL if there
601 * are no more elements in the set. The caller must ensure that the set's iterator is
604 * @param set set that should send its next element to its client
607 send_client_element (struct Set *set)
610 struct ElementEntry *ee;
611 struct GNUNET_MQ_Envelope *ev;
613 GNUNET_assert (NULL != set->iter);
614 ret = GNUNET_CONTAINER_multihashmap_iterator_next (set->iter, NULL, (const void **) &ee);
615 if (GNUNET_NO == ret)
617 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_DONE);
618 GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
623 struct GNUNET_SET_IterResponseMessage *msg;
625 GNUNET_assert (NULL != ee);
626 ev = GNUNET_MQ_msg_extra (msg, ee->element.size, GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT);
627 memcpy (&msg[1], ee->element.data, ee->element.size);
628 msg->element_type = ee->element.type;
630 GNUNET_MQ_send (set->client_mq, ev);
635 * Called when a client wants to iterate the elements of a set.
638 * @param client client that sent the message
639 * @param m message sent by the client
642 handle_client_iterate (void *cls,
643 struct GNUNET_SERVER_Client *client,
644 const struct GNUNET_MessageHeader *m)
648 // iterate over a non existing set
649 set = set_get (client);
653 GNUNET_SERVER_client_disconnect (client);
657 // only one concurrent iterate-action per set
658 if (NULL != set->iter)
661 GNUNET_SERVER_client_disconnect (client);
664 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "iterating union set with %u elements\n",
665 GNUNET_CONTAINER_multihashmap_size (set->elements));
666 GNUNET_SERVER_receive_done (client, GNUNET_OK);
667 set->iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
668 send_client_element (set);
673 * Called when a client wants to create a new set.
676 * @param client client that sent the message
677 * @param m message sent by the client
680 handle_client_create_set (void *cls,
681 struct GNUNET_SERVER_Client *client,
682 const struct GNUNET_MessageHeader *m)
684 const struct GNUNET_SET_CreateMessage *msg;
687 msg = (const struct GNUNET_SET_CreateMessage *) m;
688 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
689 "client created new set (operation %u)\n",
690 ntohs (msg->operation));
692 // max. one set per client!
693 if (NULL != set_get (client))
696 GNUNET_SERVER_client_disconnect (client);
700 set = GNUNET_new (struct Set);
702 switch (ntohs (msg->operation))
704 case GNUNET_SET_OPERATION_INTERSECTION:
705 // FIXME: implement intersection vt
706 // set->vt = _GSS_intersection_vt ();
708 case GNUNET_SET_OPERATION_UNION:
709 set->vt = _GSS_union_vt ();
714 GNUNET_SERVER_client_disconnect (client);
718 set->state = set->vt->create ();
719 set->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
720 set->client = client;
721 set->client_mq = GNUNET_MQ_queue_for_server_client (client);
722 GNUNET_CONTAINER_DLL_insert (sets_head, sets_tail, set);
723 GNUNET_SERVER_receive_done (client, GNUNET_OK);
728 * Called when a client wants to create a new listener.
731 * @param client client that sent the message
732 * @param m message sent by the client
735 handle_client_listen (void *cls,
736 struct GNUNET_SERVER_Client *client,
737 const struct GNUNET_MessageHeader *m)
739 const struct GNUNET_SET_ListenMessage *msg;
740 struct Listener *listener;
741 struct Operation *op;
743 msg = (const struct GNUNET_SET_ListenMessage *) m;
744 /* max. one per client! */
745 if (NULL != listener_get (client))
748 GNUNET_SERVER_client_disconnect (client);
752 listener = GNUNET_new (struct Listener);
753 listener->client = client;
754 listener->client_mq = GNUNET_MQ_queue_for_server_client (client);
755 listener->app_id = msg->app_id;
756 listener->operation = ntohl (msg->operation);
757 GNUNET_CONTAINER_DLL_insert_tail (listeners_head, listeners_tail, listener);
758 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
759 "new listener created (op %u, app %s)\n",
761 GNUNET_h2s (&listener->app_id));
763 /* check for incoming requests the listener is interested in */
764 for (op = incoming_head; NULL != op; op = op->next)
766 if (NULL == op->spec)
768 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
769 "request has no spec yet\n");
772 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
773 "considering (op: %u, app: %s, suggest: %u)\n",
775 GNUNET_h2s (&op->spec->app_id),
776 op->state->suggest_id);
778 /* don't consider the incoming request if it has been already suggested to a listener */
779 if (0 != op->state->suggest_id)
781 if (listener->operation != op->spec->operation)
783 if (0 != GNUNET_CRYPTO_hash_cmp (&listener->app_id, &op->spec->app_id))
785 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
786 "request suggested\n");
787 incoming_suggest (op, listener);
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "considered all incoming requests\n");
791 GNUNET_SERVER_receive_done (client, GNUNET_OK);
796 * Called when the listening client rejects an operation
797 * request by another peer.
800 * @param client client that sent the message
801 * @param m message sent by the client
804 handle_client_reject (void *cls,
805 struct GNUNET_SERVER_Client *client,
806 const struct GNUNET_MessageHeader *m)
808 struct Operation *incoming;
809 const struct GNUNET_SET_AcceptRejectMessage *msg;
811 msg = (const struct GNUNET_SET_AcceptRejectMessage *) m;
812 GNUNET_break (0 == ntohl (msg->request_id));
814 // no matching incoming operation for this reject
815 incoming = get_incoming (ntohl (msg->accept_reject_id));
816 if (NULL == incoming)
818 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
822 "peer request rejected by client\n");
824 GNUNET_MESH_channel_destroy (incoming->channel);
825 //channel destruction handler called immediately upon destruction
826 GNUNET_SERVER_receive_done (client, GNUNET_OK);
831 * Called when a client wants to add/remove an element to/from a
835 * @param client client that sent the message
836 * @param m message sent by the client
839 handle_client_add_remove (void *cls,
840 struct GNUNET_SERVER_Client *client,
841 const struct GNUNET_MessageHeader *m)
844 const struct GNUNET_SET_ElementMessage *msg;
845 struct GNUNET_SET_Element el;
846 struct ElementEntry *ee;
848 // client without a set requested an operation
849 set = set_get (client);
853 GNUNET_SERVER_client_disconnect (client);
856 GNUNET_SERVER_receive_done (client, GNUNET_OK);
857 msg = (const struct GNUNET_SET_ElementMessage *) m;
858 el.size = ntohs (m->size) - sizeof *msg;
859 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
860 "client ins/rem element of size %u\n", el.size);
862 if (GNUNET_MESSAGE_TYPE_SET_REMOVE == ntohs (m->type))
864 struct GNUNET_HashCode hash;
866 GNUNET_CRYPTO_hash (el.data, el.size, &hash);
867 ee = GNUNET_CONTAINER_multihashmap_get (set->elements, &hash);
870 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
871 "client tried to remove non-existing element\n");
874 if (GNUNET_YES == ee->removed)
876 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
877 "client tried to remove element twice\n");
880 ee->removed = GNUNET_YES;
881 ee->generation_removed = set->current_generation;
882 set->vt->remove (set->state, ee);
886 struct ElementEntry *ee_dup;
888 ee = GNUNET_malloc (el.size + sizeof *ee);
889 ee->element.size = el.size;
890 memcpy (&ee[1], el.data, el.size);
891 ee->element.data = &ee[1];
892 ee->generation_added = set->current_generation;
893 ee->remote = GNUNET_NO;
894 GNUNET_CRYPTO_hash (ee->element.data, el.size, &ee->element_hash);
895 ee_dup = GNUNET_CONTAINER_multihashmap_get (set->elements,
899 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
900 "element inserted twice, ignoring\n");
904 GNUNET_CONTAINER_multihashmap_put (set->elements, &ee->element_hash, ee,
905 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
906 set->vt->add (set->state, ee);
912 * Called when a client wants to evaluate a set operation with another peer.
915 * @param client client that sent the message
916 * @param m message sent by the client
919 handle_client_evaluate (void *cls,
920 struct GNUNET_SERVER_Client *client,
921 const struct GNUNET_MessageHeader *m)
924 const struct GNUNET_SET_EvaluateMessage *msg;
925 struct OperationSpecification *spec;
926 struct Operation *op;
928 set = set_get (client);
932 GNUNET_SERVER_client_disconnect (client);
936 msg = (const struct GNUNET_SET_EvaluateMessage *) m;
937 spec = GNUNET_new (struct OperationSpecification);
938 spec->operation = set->operation;
939 spec->app_id = msg->app_id;
940 spec->salt = ntohl (msg->salt);
941 spec->peer = msg->target_peer;
943 spec->result_mode = ntohs (msg->result_mode);
944 spec->client_request_id = ntohl (msg->request_id);
945 spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
947 // for simplicity we just backup the context msg instead of rebuilding it later on
948 if (NULL != spec->context_msg)
949 spec->context_msg = GNUNET_copy_message (spec->context_msg);
951 op = GNUNET_new (struct Operation);
953 op->generation_created = set->current_generation++;
955 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
957 op->channel = GNUNET_MESH_channel_create (mesh, op, &msg->target_peer,
958 GNUNET_APPLICATION_TYPE_SET,
959 GNUNET_MESH_OPTION_RELIABLE);
961 op->mq = GNUNET_MESH_mq_create (op->channel);
963 set->vt->evaluate (op);
964 GNUNET_SERVER_receive_done (client, GNUNET_OK);
969 * Handle an ack from a client, and send the next element.
972 * @param client the client
973 * @param m the message
976 handle_client_iter_ack (void *cls,
977 struct GNUNET_SERVER_Client *client,
978 const struct GNUNET_MessageHeader *m)
982 // client without a set requested an operation
983 set = set_get (client);
987 GNUNET_SERVER_client_disconnect (client);
991 // client sent an ack, but we were not expecting one
992 if (NULL == set->iter)
995 GNUNET_SERVER_client_disconnect (client);
999 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1000 send_client_element (set);
1005 * Handle a request from the client to
1006 * cancel a running set operation.
1009 * @param client the client
1010 * @param mh the message
1013 handle_client_cancel (void *cls,
1014 struct GNUNET_SERVER_Client *client,
1015 const struct GNUNET_MessageHeader *mh)
1017 const struct GNUNET_SET_CancelMessage *msg =
1018 (const struct GNUNET_SET_CancelMessage *) mh;
1020 struct Operation *op;
1023 // client without a set requested an operation
1024 set = set_get (client);
1028 GNUNET_SERVER_client_disconnect (client);
1032 for (op = set->ops_head; NULL != op; op = op->next)
1034 if (op->spec->client_request_id == msg->request_id)
1041 if (GNUNET_NO == found)
1044 GNUNET_SERVER_client_disconnect (client);
1048 _GSS_operation_destroy (op);
1053 * Handle a request from the client to accept
1054 * a set operation that came from a remote peer.
1055 * We forward the accept to the associated operation for handling
1058 * @param client the client
1059 * @param mh the message
1062 handle_client_accept (void *cls,
1063 struct GNUNET_SERVER_Client *client,
1064 const struct GNUNET_MessageHeader *mh)
1067 const struct GNUNET_SET_AcceptRejectMessage *msg;
1068 struct Operation *op;
1070 msg = (const struct GNUNET_SET_AcceptRejectMessage *) mh;
1071 op = get_incoming (ntohl (msg->accept_reject_id));
1073 // incoming operation does not exist
1077 GNUNET_SERVER_client_disconnect (client);
1081 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1082 "client accepting %u\n",
1083 ntohl (msg->accept_reject_id));
1085 GNUNET_assert (GNUNET_YES == op->is_incoming);
1087 // client without a set requested an operation
1088 set = set_get (client);
1093 GNUNET_SERVER_client_disconnect (client);
1097 op->spec->set = set;
1099 incoming_retire (op);
1101 GNUNET_assert (NULL != op->spec->set);
1102 GNUNET_assert (NULL != op->spec->set->vt);
1104 GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
1106 op->spec->client_request_id = ntohl (msg->request_id);
1107 op->spec->result_mode = ntohs (msg->result_mode);
1108 op->generation_created = set->current_generation++;
1109 op->vt = op->spec->set->vt;
1110 GNUNET_assert (NULL != op->vt->accept);
1111 set->vt->accept (op);
1112 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1117 * Called to clean up, after a shutdown has been requested.
1119 * @param cls closure
1120 * @param tc context information (why was this task triggered now)
1123 shutdown_task (void *cls,
1124 const struct GNUNET_SCHEDULER_TaskContext *tc)
1126 while (NULL != incoming_head)
1127 incoming_destroy (incoming_head);
1129 while (NULL != listeners_head)
1130 listener_destroy (listeners_head);
1132 while (NULL != sets_head)
1133 set_destroy (sets_head);
1135 /* it's important to destroy mesh at the end, as all channels
1136 * must be destroyed before the mesh handle! */
1139 GNUNET_MESH_disconnect (mesh);
1142 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1143 "handled shutdown request\n");
1148 * Timeout happens iff:
1149 * - we suggested an operation to our listener,
1150 * but did not receive a response in time
1151 * - we got the channel from a peer but no #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
1152 * - shutdown (obviously)
1154 * @param cls channel context
1155 * @param tc context information (why was this task triggered now)
1158 incoming_timeout_cb (void *cls,
1159 const struct GNUNET_SCHEDULER_TaskContext *tc)
1161 struct Operation *incoming = cls;
1163 incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1164 GNUNET_assert (GNUNET_YES == incoming->is_incoming);
1165 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1167 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1168 "remote peer timed out\n");
1169 incoming_destroy (incoming);
1174 * Terminates an incoming operation in case we have not yet received an
1175 * operation request. Called by the channel destruction handler.
1177 * @param op the channel context
1180 handle_incoming_disconnect (struct Operation *op)
1182 GNUNET_assert (GNUNET_YES == op->is_incoming);
1183 if (NULL == op->channel)
1185 incoming_destroy (op);
1190 * Method called whenever another peer has added us to a channel
1191 * the other peer initiated.
1192 * Only called (once) upon reception of data with a message type which was
1193 * subscribed to in GNUNET_MESH_connect().
1195 * The channel context represents the operation itself and gets added to a DLL,
1196 * from where it gets looked up when our local listener client responds
1197 * to a proposed/suggested operation or connects and associates with this operation.
1199 * @param cls closure
1200 * @param channel new handle to the channel
1201 * @param initiator peer that started the channel
1202 * @param port Port this channel is for.
1203 * @param options Unused.
1204 * @return initial channel context for the channel
1205 * (can be NULL -- that's not an error)
1208 channel_new_cb (void *cls,
1209 struct GNUNET_MESH_Channel *channel,
1210 const struct GNUNET_PeerIdentity *initiator,
1211 uint32_t port, enum MeshOption options)
1213 struct Operation *incoming;
1214 static const struct SetVT incoming_vt = {
1215 .msg_handler = handle_incoming_msg,
1216 .peer_disconnect = handle_incoming_disconnect
1219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1220 "new incoming channel\n");
1222 if (GNUNET_APPLICATION_TYPE_SET != port)
1225 GNUNET_MESH_channel_destroy (channel);
1229 incoming = GNUNET_new (struct Operation);
1230 incoming->is_incoming = GNUNET_YES;
1231 incoming->state = GNUNET_new (struct OperationState);
1232 incoming->state->peer = *initiator;
1233 incoming->channel = channel;
1234 incoming->mq = GNUNET_MESH_mq_create (incoming->channel);
1235 incoming->vt = &incoming_vt;
1236 incoming->state->timeout_task =
1237 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1238 &incoming_timeout_cb, incoming);
1239 GNUNET_CONTAINER_DLL_insert_tail (incoming_head, incoming_tail, incoming);
1246 * Function called whenever a channel is destroyed. Should clean up
1247 * any associated state. It must NOT call
1248 * GNUNET_MESH_channel_destroy() on the channel.
1250 * The peer_disconnect function is part of a a virtual table set initially either
1251 * when a peer creates a new channel with us (channel_new_cb), or once we create
1252 * a new channel ourselves (evaluate).
1254 * Once we know the exact type of operation (union/intersection), the vt is
1255 * replaced with an operation specific instance (_GSS_[op]_vt).
1257 * @param cls closure (set from GNUNET_MESH_connect())
1258 * @param channel connection to the other end (henceforth invalid)
1259 * @param channel_ctx place where local state associated
1260 * with the channel is stored
1263 channel_end_cb (void *cls,
1264 const struct GNUNET_MESH_Channel *channel, void *channel_ctx)
1266 struct Operation *op = channel_ctx;
1268 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1269 "channel end cb called\n");
1272 op->vt->peer_disconnect (op);
1273 /* mesh will never call us with the context again! */
1274 GNUNET_free (channel_ctx);
1279 * Functions with this signature are called whenever any message is
1280 * received via the mesh channel.
1282 * The msg_handler is a virtual table set in initially either when a peer
1283 * creates a new channel with us (channel_new_cb), or once we create a new channel
1284 * ourselves (evaluate).
1286 * Once we know the exact type of operation (union/intersection), the vt is
1287 * replaced with an operation specific instance (_GSS_[op]_vt).
1289 * @param cls Closure (set from GNUNET_MESH_connect()).
1290 * @param channel Connection to the other end.
1291 * @param channel_ctx Place to store local state associated with the channel.
1292 * @param message The actual message.
1293 * @return #GNUNET_OK to keep the channel open,
1294 * #GNUNET_SYSERR to close it (signal serious error).
1297 dispatch_p2p_message (void *cls,
1298 struct GNUNET_MESH_Channel *channel,
1300 const struct GNUNET_MessageHeader *message)
1302 struct Operation *op = *channel_ctx;
1305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1306 "dispatching mesh message (type: %u)\n",
1307 ntohs (message->type));
1308 /* do this before the handler, as the handler might kill the channel */
1309 GNUNET_MESH_receive_done (channel);
1310 ret = op->vt->msg_handler (op, message);
1311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1312 "handled mesh message (type: %u)\n",
1313 ntohs (message->type));
1319 * Function called by the service's run
1320 * method to run service-specific setup code.
1322 * @param cls closure
1323 * @param server the initialized server
1324 * @param cfg configuration to use
1327 run (void *cls, struct GNUNET_SERVER_Handle *server,
1328 const struct GNUNET_CONFIGURATION_Handle *cfg)
1330 static const struct GNUNET_SERVER_MessageHandler server_handlers[] = {
1331 {handle_client_accept, NULL, GNUNET_MESSAGE_TYPE_SET_ACCEPT,
1332 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1333 {handle_client_iter_ack, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_ACK, 0},
1334 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_ADD, 0},
1335 {handle_client_create_set, NULL, GNUNET_MESSAGE_TYPE_SET_CREATE,
1336 sizeof (struct GNUNET_SET_CreateMessage)},
1337 {handle_client_iterate, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST,
1338 sizeof (struct GNUNET_MessageHeader)},
1339 {handle_client_evaluate, NULL, GNUNET_MESSAGE_TYPE_SET_EVALUATE, 0},
1340 {handle_client_listen, NULL, GNUNET_MESSAGE_TYPE_SET_LISTEN,
1341 sizeof (struct GNUNET_SET_ListenMessage)},
1342 {handle_client_reject, NULL, GNUNET_MESSAGE_TYPE_SET_REJECT,
1343 sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1344 {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_REMOVE, 0},
1345 {handle_client_cancel, NULL, GNUNET_MESSAGE_TYPE_SET_CANCEL,
1346 sizeof (struct GNUNET_SET_CancelMessage)},
1349 static const struct GNUNET_MESH_MessageHandler mesh_handlers[] = {
1350 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST, 0},
1351 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF, 0},
1352 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS, 0},
1353 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_DONE, 0},
1354 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS, 0},
1355 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE, 0},
1356 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO, 0},
1357 {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF, 0},
1360 static const uint32_t mesh_ports[] = {GNUNET_APPLICATION_TYPE_SET, 0};
1362 configuration = cfg;
1363 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1364 &shutdown_task, NULL);
1365 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1366 GNUNET_SERVER_add_handlers (server, server_handlers);
1368 mesh = GNUNET_MESH_connect (cfg, NULL, channel_new_cb, channel_end_cb,
1369 mesh_handlers, mesh_ports);
1372 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1373 _("Could not connect to mesh service\n"));
1380 * The main function for the set service.
1382 * @param argc number of arguments from the command line
1383 * @param argv command line arguments
1384 * @return 0 ok, 1 on error
1387 main (int argc, char *const *argv)
1391 ret = GNUNET_SERVICE_run (argc, argv, "set",
1392 GNUNET_SERVICE_OPTION_NONE, &run, NULL);
1393 return (GNUNET_OK == ret) ? 0 : 1;
1396 /* end of gnunet-service-set.c */