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 2, 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 * Configuration of our local peer.
32 * (Not declared 'static' as also needed in gnunet-service-set_union.c)
34 const struct GNUNET_CONFIGURATION_Handle *configuration;
37 * Handle to the mesh service, used
38 * to listen for and connect to remote peers.
39 * (Not declared 'static' as also needed in gnunet-service-set_union.c)
41 struct GNUNET_MESH_Handle *mesh;
44 * Sets are held in a doubly linked list.
46 static struct Set *sets_head;
49 * Sets are held in a doubly linked list.
51 static struct Set *sets_tail;
54 * Listeners are held in a doubly linked list.
56 static struct Listener *listeners_head;
59 * Listeners are held in a doubly linked list.
61 static struct Listener *listeners_tail;
64 * Incoming sockets from remote peers are
65 * held in a doubly linked list.
67 static struct Incoming *incoming_head;
70 * Incoming sockets from remote peers are
71 * held in a doubly linked list.
73 static struct Incoming *incoming_tail;
76 * Counter for allocating unique IDs for clients,
77 * used to identify incoming operation requests from remote peers,
78 * that the client can choose to accept or refuse.
80 static uint32_t accept_id = 1;
84 * Get set that is owned by the given client, if any.
86 * @param client client to look for
87 * @return set that the client owns, NULL if the client
91 set_get (struct GNUNET_SERVER_Client *client)
94 for (set = sets_head; NULL != set; set = set->next)
95 if (set->client == client)
102 * Get the listener associated to a client, if any.
104 * @param client the client
105 * @return listener associated with the client, NULL
108 static struct Listener *
109 get_listener (struct GNUNET_SERVER_Client *client)
111 struct Listener *listener;
112 for (listener = listeners_head; NULL != listener; listener = listener->next)
113 if (listener->client == client)
120 * Get the incoming socket associated with the given id.
122 * @param id id to look for
123 * @return the incoming socket associated with the id,
124 * or NULL if there is none
126 static struct Incoming *
127 get_incoming (uint32_t id)
129 struct Incoming *incoming;
130 for (incoming = incoming_head; NULL != incoming; incoming = incoming->next)
131 if (incoming->accept_id == id)
138 * Destroy a listener, free all resources associated with it.
140 * @param listener listener to destroy
143 listener_destroy (struct Listener *listener)
145 if (NULL != listener->client_mq)
147 GNUNET_MQ_destroy (listener->client_mq);
148 listener->client_mq = NULL;
150 GNUNET_CONTAINER_DLL_remove (listeners_head, listeners_tail, listener);
151 GNUNET_free (listener);
156 * Destroy a set, and free all resources associated with it.
158 * @param set the set to destroy
161 set_destroy (struct Set *set)
163 switch (set->operation)
165 case GNUNET_SET_OPERATION_INTERSECTION:
168 case GNUNET_SET_OPERATION_UNION:
169 _GSS_union_set_destroy (set);
175 GNUNET_CONTAINER_DLL_remove (sets_head, sets_tail, set);
181 * Clean up after a client after it is
182 * disconnected (either by us or by itself)
184 * @param cls closure, unused
185 * @param client the client to clean up after
188 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
191 struct Listener *listener;
193 set = set_get (client);
196 listener = get_listener (client);
197 if (NULL != listener)
198 listener_destroy (listener);
203 * Destroy an incoming request from a remote peer
205 * @param incoming remote request to destroy
208 incoming_destroy (struct Incoming *incoming)
210 if (NULL != incoming->tc)
212 GNUNET_free (incoming->tc);
213 GNUNET_assert (NULL != incoming->tc->tunnel);
214 GNUNET_MESH_tunnel_destroy (incoming->tc->tunnel);
217 GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
218 GNUNET_free (incoming);
222 static struct Listener *
223 get_listener_by_target (enum GNUNET_SET_OperationType op,
224 const struct GNUNET_HashCode *app_id)
228 for (l = listeners_head; NULL != l; l = l->next)
230 if (l->operation != op)
232 if (0 != GNUNET_CRYPTO_hash_cmp (app_id, &l->app_id))
242 tunnel_context_destroy (struct TunnelContext *tc)
245 /* FIXME destroy the rest */
250 * Handle a request for a set operation from
253 * @param cls the incoming socket
254 * @param mh the message
257 handle_p2p_operation_request (void *cls,
258 struct GNUNET_MESH_Tunnel *tunnel,
260 const struct GNUNET_MessageHeader *mh)
262 struct TunnelContext *tc = *tunnel_ctx;
263 struct Incoming *incoming;
264 const struct OperationRequestMessage *msg = (const struct OperationRequestMessage *) mh;
265 struct GNUNET_MQ_Envelope *mqm;
266 struct GNUNET_SET_RequestMessage *cmsg;
267 struct Listener *listener;
268 const struct GNUNET_MessageHeader *context_msg;
270 if (CONTEXT_INCOMING != tc->type)
272 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "unexpected operation request\n");
273 tunnel_context_destroy (tc);
274 /* don't kill the whole mesh connection */
280 context_msg = GNUNET_MQ_extract_nested_mh (msg);
281 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "received P2P operation request (op %u, app %s)\n",
282 ntohs (msg->operation), GNUNET_h2s (&msg->app_id));
283 listener = get_listener_by_target (ntohs (msg->operation), &msg->app_id);
284 if (NULL == listener)
286 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
287 "set operation request from peer failed: "
288 "no set with matching application ID and operation type\n");
289 tunnel_context_destroy (tc);
290 /* don't kill the whole mesh connection */
293 mqm = GNUNET_MQ_msg_nested_mh (cmsg, GNUNET_MESSAGE_TYPE_SET_REQUEST, context_msg);
296 /* FIXME: disconnect the peer */
298 tunnel_context_destroy (tc);
299 /* don't kill the whole mesh connection */
302 incoming->accept_id = accept_id++;
303 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "sending request with accept id %u\n", incoming->accept_id);
304 cmsg->accept_id = htonl (incoming->accept_id);
305 cmsg->peer_id = incoming->tc->peer;
306 GNUNET_MQ_send (listener->client_mq, mqm);
313 * Called when a client wants to create a new set.
316 * @param client client that sent the message
317 * @param m message sent by the client
320 handle_client_create (void *cls,
321 struct GNUNET_SERVER_Client *client,
322 const struct GNUNET_MessageHeader *m)
324 struct GNUNET_SET_CreateMessage *msg = (struct GNUNET_SET_CreateMessage *) m;
327 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "client created new set (operation %u)\n",
328 ntohs (msg->operation));
330 if (NULL != set_get (client))
333 GNUNET_SERVER_client_disconnect (client);
339 switch (ntohs (msg->operation))
341 case GNUNET_SET_OPERATION_INTERSECTION:
342 //set = _GSS_intersection_set_create ();
344 case GNUNET_SET_OPERATION_UNION:
345 set = _GSS_union_set_create ();
349 GNUNET_SERVER_client_disconnect (client);
353 GNUNET_assert (NULL != set);
355 set->client = client;
356 set->client_mq = GNUNET_MQ_queue_for_server_client (client);
357 GNUNET_CONTAINER_DLL_insert (sets_head, sets_tail, set);
358 GNUNET_SERVER_receive_done (client, GNUNET_OK);
363 * Called when a client wants to create a new listener.
366 * @param client client that sent the message
367 * @param m message sent by the client
370 handle_client_listen (void *cls,
371 struct GNUNET_SERVER_Client *client,
372 const struct GNUNET_MessageHeader *m)
374 struct GNUNET_SET_ListenMessage *msg = (struct GNUNET_SET_ListenMessage *) m;
375 struct Listener *listener;
377 if (NULL != get_listener (client))
380 GNUNET_SERVER_client_disconnect (client);
383 listener = GNUNET_new (struct Listener);
384 listener->client = client;
385 listener->client_mq = GNUNET_MQ_queue_for_server_client (client);
386 listener->app_id = msg->app_id;
387 listener->operation = ntohs (msg->operation);
388 GNUNET_CONTAINER_DLL_insert_tail (listeners_head, listeners_tail, listener);
389 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "new listener created (op %u, app %s)\n",
390 listener->operation, GNUNET_h2s (&listener->app_id));
391 GNUNET_SERVER_receive_done (client, GNUNET_OK);
396 * Called when a client wants to remove an element
397 * from the set it inhabits.
400 * @param client client that sent the message
401 * @param m message sent by the client
404 handle_client_remove (void *cls,
405 struct GNUNET_SERVER_Client *client,
406 const struct GNUNET_MessageHeader *m)
410 set = set_get (client);
414 GNUNET_SERVER_client_disconnect (client);
417 switch (set->operation)
419 case GNUNET_SET_OPERATION_UNION:
420 _GSS_union_remove ((struct GNUNET_SET_ElementMessage *) m, set);
422 case GNUNET_SET_OPERATION_INTERSECTION:
423 //_GSS_intersection_remove ((struct GNUNET_SET_ElementMessage *) m, set);
430 GNUNET_SERVER_receive_done (client, GNUNET_OK);
436 * Called when the client wants to reject an operation
437 * request from another peer.
440 * @param client client that sent the message
441 * @param m message sent by the client
444 handle_client_reject (void *cls,
445 struct GNUNET_SERVER_Client *client,
446 const struct GNUNET_MessageHeader *m)
448 struct Incoming *incoming;
449 struct GNUNET_SET_AcceptRejectMessage *msg = (struct GNUNET_SET_AcceptRejectMessage *) m;
451 GNUNET_break (0 == ntohl (msg->request_id));
453 incoming = get_incoming (ntohl (msg->accept_reject_id));
454 if (NULL == incoming)
456 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
459 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "peer request rejected by client\n");
460 incoming_destroy (incoming);
461 GNUNET_SERVER_receive_done (client, GNUNET_OK);
467 * Called when a client wants to add an element to a
471 * @param client client that sent the message
472 * @param m message sent by the client
475 handle_client_add (void *cls,
476 struct GNUNET_SERVER_Client *client,
477 const struct GNUNET_MessageHeader *m)
481 set = set_get (client);
485 GNUNET_SERVER_client_disconnect (client);
488 switch (set->operation)
490 case GNUNET_SET_OPERATION_UNION:
491 _GSS_union_add ((struct GNUNET_SET_ElementMessage *) m, set);
493 case GNUNET_SET_OPERATION_INTERSECTION:
494 //_GSS_intersection_add ((struct GNUNET_SET_ElementMessage *) m, set);
501 GNUNET_SERVER_receive_done (client, GNUNET_OK);
506 * Called when a client wants to evaluate a set operation with another peer.
509 * @param client client that sent the message
510 * @param m message sent by the client
513 handle_client_evaluate (void *cls,
514 struct GNUNET_SERVER_Client *client,
515 const struct GNUNET_MessageHeader *m)
519 set = set_get (client);
523 GNUNET_SERVER_client_disconnect (client);
528 switch (set->operation)
530 case GNUNET_SET_OPERATION_INTERSECTION:
531 //_GSS_intersection_evaluate ((struct GNUNET_SET_EvaluateMessage *) m, set);
533 case GNUNET_SET_OPERATION_UNION:
534 _GSS_union_evaluate ((struct GNUNET_SET_EvaluateMessage *) m, set);
541 GNUNET_SERVER_receive_done (client, GNUNET_OK);
546 * Handle an ack from a client.
549 * @param client the client
550 * @param m the message
553 handle_client_ack (void *cls,
554 struct GNUNET_SERVER_Client *client,
555 const struct GNUNET_MessageHeader *m)
557 /* FIXME: implement */
558 GNUNET_SERVER_receive_done (client, GNUNET_OK);
563 * Handle a request from the client to accept
564 * a set operation that came from a remote peer.
567 * @param client the client
568 * @param mh the message
571 handle_client_accept (void *cls,
572 struct GNUNET_SERVER_Client *client,
573 const struct GNUNET_MessageHeader *mh)
576 struct Incoming *incoming;
577 struct GNUNET_SET_AcceptRejectMessage *msg = (struct GNUNET_SET_AcceptRejectMessage *) mh;
579 incoming = get_incoming (ntohl (msg->accept_reject_id));
581 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "client accepting %u\n", ntohl (msg->accept_reject_id));
583 if (NULL == incoming)
587 GNUNET_SERVER_client_disconnect (client);
591 set = set_get (client);
596 GNUNET_SERVER_client_disconnect (client);
600 switch (set->operation)
602 case GNUNET_SET_OPERATION_INTERSECTION:
603 // _GSS_intersection_accept (msg, set, incoming);
605 case GNUNET_SET_OPERATION_UNION:
606 _GSS_union_accept (msg, set, incoming);
613 /* note: _GSS_*_accept has to make sure the socket and mq are set to NULL,
614 * otherwise they will be destroyed and disconnected */
615 incoming_destroy (incoming);
616 GNUNET_SERVER_receive_done (client, GNUNET_OK);
621 * Called to clean up, after a shutdown has been requested.
624 * @param tc context information (why was this task triggered now)
627 shutdown_task (void *cls,
628 const struct GNUNET_SCHEDULER_TaskContext *tc)
632 GNUNET_MESH_disconnect (mesh);
636 while (NULL != incoming_head)
638 incoming_destroy (incoming_head);
641 while (NULL != listeners_head)
643 listener_destroy (listeners_head);
646 while (NULL != sets_head)
648 set_destroy (sets_head);
651 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "handled shutdown request\n");
657 * Signature of the main function of a task.
660 * @param tc context information (why was this task triggered now)
663 incoming_timeout_cb (void *cls,
664 const struct GNUNET_SCHEDULER_TaskContext *tc)
666 struct Incoming *incoming = cls;
668 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "remote peer timed out");
669 incoming_destroy (incoming);
674 * Method called whenever another peer has added us to a tunnel
675 * the other peer initiated.
676 * Only called (once) upon reception of data with a message type which was
677 * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
678 * causes te tunnel to be ignored and no further notifications are sent about
682 * @param tunnel new handle to the tunnel
683 * @param initiator peer that started the tunnel
684 * @param port Port this tunnel is for.
685 * @return initial tunnel context for the tunnel
686 * (can be NULL -- that's not an error)
689 tunnel_new_cb (void *cls,
690 struct GNUNET_MESH_Tunnel *tunnel,
691 const struct GNUNET_PeerIdentity *initiator,
694 struct Incoming *incoming;
695 struct TunnelContext *tc;
697 GNUNET_assert (port == GNUNET_APPLICATION_TYPE_SET);
698 tc = GNUNET_new (struct TunnelContext);
699 incoming = GNUNET_new (struct Incoming);
701 tc->peer = *initiator;
703 tc->mq = GNUNET_MESH_mq_create (tunnel);
705 tc->type = CONTEXT_INCOMING;
706 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES, incoming_timeout_cb, incoming);
707 GNUNET_CONTAINER_DLL_insert_tail (incoming_head, incoming_tail, incoming);
714 * Function called whenever a tunnel is destroyed. Should clean up
715 * any associated state. This function is NOT called if the client has
716 * explicitly asked for the tunnel to be destroyed using
717 * GNUNET_MESH_tunnel_destroy. It must NOT call GNUNET_MESH_tunnel_destroy on
720 * @param cls closure (set from GNUNET_MESH_connect)
721 * @param tunnel connection to the other end (henceforth invalid)
722 * @param tunnel_ctx place where local state associated
723 * with the tunnel is stored
726 tunnel_end_cb (void *cls,
727 const struct GNUNET_MESH_Tunnel *tunnel, void *tunnel_ctx)
729 struct TunnelContext *ctx = tunnel_ctx;
733 case CONTEXT_INCOMING:
734 incoming_destroy ((struct Incoming *) ctx->data);
736 case CONTEXT_OPERATION_UNION:
737 _GSS_union_operation_destroy ((struct UnionEvaluateOperation *) ctx->data);
739 case CONTEXT_OPERATION_INTERSECTION:
751 * Function called by the service's run
752 * method to run service-specific setup code.
755 * @param server the initialized server
756 * @param cfg configuration to use
759 run (void *cls, struct GNUNET_SERVER_Handle *server,
760 const struct GNUNET_CONFIGURATION_Handle *cfg)
762 static const struct GNUNET_SERVER_MessageHandler server_handlers[] = {
763 {handle_client_accept, NULL, GNUNET_MESSAGE_TYPE_SET_ACCEPT, 0},
764 {handle_client_ack, NULL, GNUNET_MESSAGE_TYPE_SET_ACK, 0},
765 {handle_client_add, NULL, GNUNET_MESSAGE_TYPE_SET_ADD, 0},
766 {handle_client_create, NULL, GNUNET_MESSAGE_TYPE_SET_CREATE, 0},
767 {handle_client_evaluate, NULL, GNUNET_MESSAGE_TYPE_SET_EVALUATE, 0},
768 {handle_client_listen, NULL, GNUNET_MESSAGE_TYPE_SET_LISTEN, 0},
769 {handle_client_reject, NULL, GNUNET_MESSAGE_TYPE_SET_REJECT, 0},
770 {handle_client_remove, NULL, GNUNET_MESSAGE_TYPE_SET_REMOVE, 0},
773 static const struct GNUNET_MESH_MessageHandler mesh_handlers[] = {
774 {handle_p2p_operation_request,
775 GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST, 0},
776 /* messages for the union operation */
777 {_GSS_union_handle_p2p_message,
778 GNUNET_MESSAGE_TYPE_SET_P2P_IBF, 0},
779 {_GSS_union_handle_p2p_message,
780 GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS, 0},
781 {_GSS_union_handle_p2p_message,
782 GNUNET_MESSAGE_TYPE_SET_P2P_DONE, 0},
783 {_GSS_union_handle_p2p_message,
784 GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS, 0},
785 {_GSS_union_handle_p2p_message,
786 GNUNET_MESSAGE_TYPE_SET_P2P_SE, 0},
787 /* FIXME: messages for intersection operation */
790 static const uint32_t mesh_ports[] = {GNUNET_APPLICATION_TYPE_SET, 0};
793 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
794 &shutdown_task, NULL);
795 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
796 GNUNET_SERVER_add_handlers (server, server_handlers);
798 mesh = GNUNET_MESH_connect (cfg, NULL, tunnel_new_cb, tunnel_end_cb,
799 mesh_handlers, mesh_ports);
802 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "could not connect to mesh\n");
806 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "service started\n");
811 * The main function for the set service.
813 * @param argc number of arguments from the command line
814 * @param argv command line arguments
815 * @return 0 ok, 1 on error
818 main (int argc, char *const *argv)
821 ret = GNUNET_SERVICE_run (argc, argv, "set",
822 GNUNET_SERVICE_OPTION_NONE, &run, NULL);
823 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "exit\n");
824 return (GNUNET_OK == ret) ? 0 : 1;