13bb3829274015a383cbe24bbcda2f06e2a826df
[oweals/gnunet.git] / src / set / gnunet-service-set.c
1 /*
2       This file is part of GNUnet
3       (C) 2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file set/gnunet-service-set.c
23  * @brief two-peer set operations
24  * @author Florian Dold
25  */
26 #include "gnunet-service-set.h"
27 #include "set_protocol.h"
28
29
30 /**
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.
35  */
36 struct OperationState
37 {
38   /**
39    * The identity of the requesting peer.  Needs to
40    * be stored here as the op spec might not have been created yet.
41    */
42   struct GNUNET_PeerIdentity peer;
43
44   /**
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
49    * suggested yet.
50    */
51   uint32_t suggest_id;
52
53   /**
54    * Timeout task, if the incoming peer has not been accepted
55    * after the timeout, it will be disconnected.
56    */
57   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
58 };
59
60
61 /**
62  * A listener is inhabited by a client, and
63  * waits for evaluation requests from remote peers.
64  */
65 struct Listener
66 {
67   /**
68    * Listeners are held in a doubly linked list.
69    */
70   struct Listener *next;
71
72   /**
73    * Listeners are held in a doubly linked list.
74    */
75   struct Listener *prev;
76
77   /**
78    * Client that owns the listener.
79    * Only one client may own a listener.
80    */
81   struct GNUNET_SERVER_Client *client;
82
83   /**
84    * Message queue for the client
85    */
86   struct GNUNET_MQ_Handle *client_mq;
87
88   /**
89    * The type of the operation.
90    */
91   enum GNUNET_SET_OperationType operation;
92
93   /**
94    * Application ID for the operation, used to distinguish
95    * multiple operations of the same type with the same peer.
96    */
97   struct GNUNET_HashCode app_id;
98 };
99
100
101 /**
102  * Configuration of our local peer.
103  */
104 static const struct GNUNET_CONFIGURATION_Handle *configuration;
105
106 /**
107  * Handle to the mesh service, used
108  * to listen for and connect to remote peers.
109  */
110 static struct GNUNET_MESH_Handle *mesh;
111
112 /**
113  * Sets are held in a doubly linked list.
114  */
115 static struct Set *sets_head;
116
117 /**
118  * Sets are held in a doubly linked list.
119  */
120 static struct Set *sets_tail;
121
122 /**
123  * Listeners are held in a doubly linked list.
124  */
125 static struct Listener *listeners_head;
126
127 /**
128  * Listeners are held in a doubly linked list.
129  */
130 static struct Listener *listeners_tail;
131
132 /**
133  * Incoming sockets from remote peers are
134  * held in a doubly linked list.
135  */
136 static struct Operation *incoming_head;
137
138 /**
139  * Incoming sockets from remote peers are
140  * held in a doubly linked list.
141  */
142 static struct Operation *incoming_tail;
143
144 /**
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.
148  */
149 static uint32_t suggest_id = 1;
150
151
152 /**
153  * Get set that is owned by the given client, if any.
154  *
155  * @param client client to look for
156  * @return set that the client owns, NULL if the client
157  *         does not own a set
158  */
159 static struct Set *
160 set_get (struct GNUNET_SERVER_Client *client)
161 {
162   struct Set *set;
163
164   for (set = sets_head; NULL != set; set = set->next)
165     if (set->client == client)
166       return set;
167   return NULL;
168 }
169
170
171 /**
172  * Get the listener associated with the given client, if any.
173  *
174  * @param client the client
175  * @return listener associated with the client, NULL
176  *         if there isn't any
177  */
178 static struct Listener *
179 listener_get (struct GNUNET_SERVER_Client *client)
180 {
181   struct Listener *listener;
182
183   for (listener = listeners_head; NULL != listener; listener = listener->next)
184     if (listener->client == client)
185       return listener;
186   return NULL;
187 }
188
189
190 /**
191  * Get the incoming socket associated with the given id.
192  *
193  * @param id id to look for
194  * @return the incoming socket associated with the id,
195  *         or NULL if there is none
196  */
197 static struct Operation *
198 get_incoming (uint32_t id)
199 {
200   struct Operation *op;
201
202   for (op = incoming_head; NULL != op; op = op->next)
203     if (op->state->suggest_id == id)
204       return op;
205   return NULL;
206 }
207
208
209 /**
210  * Destroy a listener, free all resources associated with it.
211  *
212  * @param listener listener to destroy
213  */
214 static void
215 listener_destroy (struct Listener *listener)
216 {
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)
220   {
221     struct GNUNET_SERVER_Client *client = listener->client;
222     listener->client = NULL;
223     GNUNET_SERVER_client_disconnect (client);
224     return;
225   }
226   if (NULL != listener->client_mq)
227   {
228     GNUNET_MQ_destroy (listener->client_mq);
229     listener->client_mq = NULL;
230   }
231   GNUNET_CONTAINER_DLL_remove (listeners_head, listeners_tail, listener);
232   GNUNET_free (listener);
233 }
234
235
236 /**
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
239  * set operation.
240  *
241  * We hereby replace the old element hashmap with a new one, instead of removing elements.
242  */
243 void
244 collect_generation_garbage (struct Set *set)
245 {
246   struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
247   struct ElementEntry *ee;
248   struct GNUNET_CONTAINER_MultiHashMap *new_elements;
249   int res;
250   struct Operation *op;
251
252   new_elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_NO);
253   iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
254   while (GNUNET_OK ==
255          (res = GNUNET_CONTAINER_multihashmap_iterator_next (iter, NULL, (const void **) &ee)))
256   {
257     if (GNUNET_NO == ee->removed)
258       goto still_needed;
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))
262         goto still_needed;
263     GNUNET_free (ee);
264     continue;
265 still_needed:
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);
269   }
270   GNUNET_CONTAINER_multihashmap_iterator_destroy (iter);
271   GNUNET_CONTAINER_multihashmap_destroy (set->elements);
272   set->elements = new_elements;
273 }
274
275
276 /**
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.
280  *
281  * @param op operation to destroy
282  */
283 void
284 _GSS_operation_destroy (struct Operation *op)
285 {
286   struct Set *set;
287   struct GNUNET_MESH_Channel *channel;
288
289   if (NULL == op->vt)
290     return;
291
292   set = op->spec->set;
293
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,
298                                op);
299
300   op->vt->cancel (op);
301   op->vt = NULL;
302
303   if (NULL != op->spec)
304   {
305     if (NULL != op->spec->context_msg)
306     {
307       GNUNET_free (op->spec->context_msg);
308       op->spec->context_msg = NULL;
309     }
310     GNUNET_free (op->spec);
311     op->spec = NULL;
312   }
313
314   if (NULL != op->mq)
315   {
316     GNUNET_MQ_destroy (op->mq);
317     op->mq = NULL;
318   }
319
320   if (NULL != (channel = op->channel))
321   {
322     op->channel = NULL;
323     GNUNET_MESH_channel_destroy (channel);
324   }
325
326   collect_generation_garbage (set);
327
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. */
330 }
331
332
333 /**
334  * Iterator over hash map entries to free
335  * element entries.
336  *
337  * @param cls closure
338  * @param key current key code
339  * @param value value in the hash map
340  * @return GNUNET_YES if we should continue to
341  *         iterate,
342  *         GNUNET_NO if not.
343  */
344 static int
345 destroy_elements_iterator (void *cls,
346                            const struct GNUNET_HashCode * key,
347                            void *value)
348 {
349   struct ElementEntry *ee = value;
350
351   GNUNET_free (ee);
352   return GNUNET_YES;
353 }
354
355
356 /**
357  * Destroy a set, and free all resources associated with it.
358  *
359  * @param set the set to destroy
360  */
361 static void
362 set_destroy (struct Set *set)
363 {
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
367    * to destroy. */
368   if (NULL != set->client)
369   {
370     struct GNUNET_SERVER_Client *client = set->client;
371     set->client = NULL;
372     GNUNET_SERVER_client_disconnect (client);
373     return;
374   }
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);
379   set->state = NULL;
380   if (NULL != set->client_mq)
381   {
382     GNUNET_MQ_destroy (set->client_mq);
383     set->client_mq = NULL;
384   }
385   if (NULL != set->iter)
386   {
387     GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
388     set->iter = NULL;
389   }
390   GNUNET_CONTAINER_DLL_remove (sets_head, sets_tail, set);
391   if (NULL != set->elements)
392   {
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;
398   }
399   GNUNET_free (set);
400 }
401
402
403 /**
404  * Clean up after a client has disconnected
405  *
406  * @param cls closure, unused
407  * @param client the client to clean up after
408  */
409 static void
410 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
411 {
412   struct Set *set;
413   struct Listener *listener;
414
415   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "client disconnected, cleaning up\n");
416
417   set = set_get (client);
418   if (NULL != set)
419   {
420     set->client = NULL;
421     set_destroy (set);
422     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "(client's set destroyed)\n");
423   }
424   listener = listener_get (client);
425   if (NULL != listener)
426   {
427     listener->client = NULL;
428     listener_destroy (listener);
429     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "(client's listener destroyed)\n");
430   }
431 }
432
433
434 /**
435  * Destroy an incoming request from a remote peer
436  *
437  * @param incoming remote request to destroy
438  */
439 static void
440 incoming_destroy (struct Operation *incoming)
441 {
442   GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
443   if (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task)
444   {
445     GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
446     incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
447   }
448   GNUNET_free (incoming->state);
449 }
450
451 /**
452  * remove & free state of the operation from the incoming list
453  *
454  * @param incoming the element to remove
455  */
456
457 static void
458 incoming_retire (struct Operation *incoming)
459 {
460   incoming->is_incoming = GNUNET_NO;
461   GNUNET_free (incoming->state);
462   incoming->state = NULL;
463   GNUNET_CONTAINER_DLL_remove (incoming_head, incoming_tail, incoming);
464 }
465
466
467 /**
468  * Find a listener that is interested in the given operation type
469  * and application id.
470  *
471  * @param op operation type to look for
472  * @param app_id application id to look for
473  * @return a matching listener, or NULL if no listener matches the
474  *         given operation and application id
475  */
476 static struct Listener *
477 listener_get_by_target (enum GNUNET_SET_OperationType op,
478                         const struct GNUNET_HashCode *app_id)
479 {
480   struct Listener *l;
481
482   for (l = listeners_head; NULL != l; l = l->next)
483   {
484     if (l->operation != op)
485       continue;
486     if (0 != GNUNET_CRYPTO_hash_cmp (app_id, &l->app_id))
487       continue;
488     return l;
489   }
490   return NULL;
491 }
492
493
494 /**
495  * Suggest the given request to the listener. The listening client can then
496  * accept or reject the remote request.
497  *
498  * @param incoming the incoming peer with the request to suggest
499  * @param listener the listener to suggest the request to
500  */
501 static void
502 incoming_suggest (struct Operation *incoming, struct Listener *listener)
503 {
504   struct GNUNET_MQ_Envelope *mqm;
505   struct GNUNET_SET_RequestMessage *cmsg;
506
507   GNUNET_assert (NULL != incoming->spec);
508   GNUNET_assert (0 == incoming->state->suggest_id);
509   incoming->state->suggest_id = suggest_id++;
510
511   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != incoming->state->timeout_task);
512   GNUNET_SCHEDULER_cancel (incoming->state->timeout_task);
513   incoming->state->timeout_task = GNUNET_SCHEDULER_NO_TASK;
514
515   mqm = GNUNET_MQ_msg_nested_mh (cmsg, GNUNET_MESSAGE_TYPE_SET_REQUEST,
516                                  incoming->spec->context_msg);
517   GNUNET_assert (NULL != mqm);
518   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "suggesting request with accept id %u\n",
519               incoming->state->suggest_id);
520   cmsg->accept_id = htonl (incoming->state->suggest_id);
521   cmsg->peer_id = incoming->spec->peer;
522   GNUNET_MQ_send (listener->client_mq, mqm);
523 }
524
525
526 /**
527  * Handle a request for a set operation from
528  * another peer.
529  *
530  * This msg is expected as the first and only msg handled through the
531  * non-operation bound virtual table, acceptance of this operation replaces
532  * our virtual table and subsequent msgs would be routed differently.
533  *
534  * @param op the operation state
535  * @param mh the received message
536  * @return GNUNET_OK if the channel should be kept alive,
537  *         GNUNET_SYSERR to destroy the channel
538  */
539 static int
540 handle_incoming_msg (struct Operation *op,
541                      const struct GNUNET_MessageHeader *mh)
542 {
543   const struct OperationRequestMessage *msg = (const struct OperationRequestMessage *) mh;
544   struct Listener *listener;
545   struct OperationSpecification *spec;
546
547   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got op request\n");
548
549   if (GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST != ntohs (mh->type))
550   {
551     GNUNET_break_op (0);
552     return GNUNET_SYSERR;
553   }
554
555   /* double operation request */
556   if (NULL != op->spec)
557   {
558     GNUNET_break_op (0);
559     return GNUNET_SYSERR;
560   }
561
562   spec = GNUNET_new (struct OperationSpecification);
563   spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
564   // for simplicity we just backup the context msg instead of rebuilding it later on
565   if (NULL != spec->context_msg)
566     spec->context_msg = GNUNET_copy_message (spec->context_msg);
567   spec->operation = ntohl (msg->operation);
568   spec->app_id = msg->app_id;
569   spec->salt = ntohl (msg->salt);
570   spec->peer = op->state->peer;
571   spec->remote_element_count = ntohl (msg->element_count);
572
573   op->spec = spec;
574
575   if ( (NULL != spec->context_msg) &&
576        (ntohs (spec->context_msg->size) > GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE) )
577   {
578     GNUNET_break_op (0);
579     return GNUNET_SYSERR;
580   }
581
582   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "received P2P operation request (op %u, app %s)\n",
583               ntohl (msg->operation), GNUNET_h2s (&msg->app_id));
584   listener = listener_get_by_target (ntohl (msg->operation), &msg->app_id);
585   if (NULL == listener)
586   {
587     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
588                 "no listener matches incoming request, waiting with timeout\n");
589     return GNUNET_OK;
590   }
591   incoming_suggest (op, listener);
592   return GNUNET_OK;
593 }
594
595
596 /**
597  * Send the next element of a set to the set's client.  The next element is given by
598  * the set's current hashmap iterator.  The set's iterator will be set to NULL if there
599  * are no more elements in the set.  The caller must ensure that the set's iterator is
600  * valid.
601  *
602  * @param set set that should send its next element to its client
603  */
604 static void
605 send_client_element (struct Set *set)
606 {
607   int ret;
608   struct ElementEntry *ee;
609   struct GNUNET_MQ_Envelope *ev;
610
611   GNUNET_assert (NULL != set->iter);
612   ret = GNUNET_CONTAINER_multihashmap_iterator_next (set->iter, NULL, (const void **) &ee);
613   if (GNUNET_NO == ret)
614   {
615     ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_DONE);
616     GNUNET_CONTAINER_multihashmap_iterator_destroy (set->iter);
617     set->iter = NULL;
618   }
619   else
620   {
621     struct GNUNET_SET_IterResponseMessage *msg;
622
623     GNUNET_assert (NULL != ee);
624     ev = GNUNET_MQ_msg_extra (msg, ee->element.size, GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT);
625     memcpy (&msg[1], ee->element.data, ee->element.size);
626     msg->element_type = ee->element.type;
627   }
628   GNUNET_MQ_send (set->client_mq, ev);
629 }
630
631
632 /**
633  * Called when a client wants to iterate the elements of a set.
634  *
635  * @param cls unused
636  * @param client client that sent the message
637  * @param m message sent by the client
638  */
639 static void
640 handle_client_iterate (void *cls,
641                        struct GNUNET_SERVER_Client *client,
642                        const struct GNUNET_MessageHeader *m)
643 {
644   struct Set *set;
645
646   // iterate over a non existing set
647   set = set_get (client);
648   if (NULL == set)
649   {
650     GNUNET_break (0);
651     GNUNET_SERVER_client_disconnect (client);
652     return;
653   }
654
655   // only one concurrent iterate-action per set
656   if (NULL != set->iter)
657   {
658     GNUNET_break (0);
659     GNUNET_SERVER_client_disconnect (client);
660     return;
661   }
662   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "iterating union set with %u elements\n",
663               GNUNET_CONTAINER_multihashmap_size (set->elements));
664   GNUNET_SERVER_receive_done (client, GNUNET_OK);
665   set->iter = GNUNET_CONTAINER_multihashmap_iterator_create (set->elements);
666   send_client_element (set);
667 }
668
669
670 /**
671  * Called when a client wants to create a new set.
672  *
673  * @param cls unused
674  * @param client client that sent the message
675  * @param m message sent by the client
676  */
677 static void
678 handle_client_create_set (void *cls,
679                           struct GNUNET_SERVER_Client *client,
680                           const struct GNUNET_MessageHeader *m)
681 {
682   struct GNUNET_SET_CreateMessage *msg = (struct GNUNET_SET_CreateMessage *) m;
683   struct Set *set;
684
685   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "client created new set (operation %u)\n",
686               ntohs (msg->operation));
687
688   // max. one set per client!
689   if (NULL != set_get (client))
690   {
691     GNUNET_break (0);
692     GNUNET_SERVER_client_disconnect (client);
693     return;
694   }
695
696   set = GNUNET_new (struct Set);
697
698   switch (ntohs (msg->operation))
699   {
700   case GNUNET_SET_OPERATION_INTERSECTION:
701     // FIXME: implement intersection vt
702     // set->vt = _GSS_intersection_vt ();
703     break;
704   case GNUNET_SET_OPERATION_UNION:
705     set->vt = _GSS_union_vt ();
706     break;
707   default:
708     GNUNET_free (set);
709     GNUNET_break (0);
710     GNUNET_SERVER_client_disconnect (client);
711     return;
712   }
713
714   set->state = set->vt->create ();
715   set->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
716   set->client = client;
717   set->client_mq = GNUNET_MQ_queue_for_server_client (client);
718   GNUNET_CONTAINER_DLL_insert (sets_head, sets_tail, set);
719   GNUNET_SERVER_receive_done (client, GNUNET_OK);
720 }
721
722
723 /**
724  * Called when a client wants to create a new listener.
725  *
726  * @param cls unused
727  * @param client client that sent the message
728  * @param m message sent by the client
729  */
730 static void
731 handle_client_listen (void *cls,
732                       struct GNUNET_SERVER_Client *client,
733                       const struct GNUNET_MessageHeader *m)
734 {
735   struct GNUNET_SET_ListenMessage *msg = (struct GNUNET_SET_ListenMessage *) m;
736   struct Listener *listener;
737   struct Operation *op;
738
739   // max. one per client!
740   if (NULL != listener_get (client))
741   {
742     GNUNET_break (0);
743     GNUNET_SERVER_client_disconnect (client);
744     return;
745   }
746
747   listener = GNUNET_new (struct Listener);
748   listener->client = client;
749   listener->client_mq = GNUNET_MQ_queue_for_server_client (client);
750   listener->app_id = msg->app_id;
751   listener->operation = ntohl (msg->operation);
752   GNUNET_CONTAINER_DLL_insert_tail (listeners_head, listeners_tail, listener);
753   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new listener created (op %u, app %s)\n",
754               listener->operation, GNUNET_h2s (&listener->app_id));
755
756   /* check for incoming requests the listener is interested in */
757   for (op = incoming_head; NULL != op; op = op->next)
758   {
759     if (NULL == op->spec)
760     {
761       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "request has no spec yet\n");
762       continue;
763     }
764     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "considering (op: %u, app: %s, suggest: %u)\n",
765                 op->spec->operation, GNUNET_h2s (&op->spec->app_id), op->state->suggest_id);
766
767     /* don't consider the incoming request if it has been already suggested to a listener */
768     if (0 != op->state->suggest_id)
769       continue;
770     if (listener->operation != op->spec->operation)
771       continue;
772     if (0 != GNUNET_CRYPTO_hash_cmp (&listener->app_id, &op->spec->app_id))
773       continue;
774     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "request suggested\n");
775     incoming_suggest (op, listener);
776   }
777   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "considered all incoming requests\n");
778   GNUNET_SERVER_receive_done (client, GNUNET_OK);
779 }
780
781
782 /**
783  * Called when the listening client rejects an operation
784  * request by another peer.
785  *
786  * @param cls unused
787  * @param client client that sent the message
788  * @param m message sent by the client
789  */
790 static void
791 handle_client_reject (void *cls,
792                       struct GNUNET_SERVER_Client *client,
793                       const struct GNUNET_MessageHeader *m)
794 {
795   struct Operation *incoming;
796   const struct GNUNET_SET_AcceptRejectMessage *msg;
797
798   msg = (const struct GNUNET_SET_AcceptRejectMessage *) m;
799   GNUNET_break (0 == ntohl (msg->request_id));
800
801   // no matching incoming operation for this reject
802   incoming = get_incoming (ntohl (msg->accept_reject_id));
803   if (NULL == incoming)
804   {
805     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
806     return;
807   }
808   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "peer request rejected by client\n");
809
810   GNUNET_MESH_channel_destroy (incoming->channel);
811   //channel destruction handler called immediately upon destruction
812   GNUNET_SERVER_receive_done (client, GNUNET_OK);
813 }
814
815
816 /**
817  * Called when a client wants to add/remove an element to/from a
818  * set it inhabits.
819  *
820  * @param cls unused
821  * @param client client that sent the message
822  * @param m message sent by the client
823  */
824 static void
825 handle_client_add_remove (void *cls,
826                           struct GNUNET_SERVER_Client *client,
827                           const struct GNUNET_MessageHeader *m)
828 {
829   struct Set *set;
830   const struct GNUNET_SET_ElementMessage *msg;
831   struct GNUNET_SET_Element el;
832   struct ElementEntry *ee;
833
834   // client without a set requested an operation
835   set = set_get (client);
836   if (NULL == set)
837   {
838     GNUNET_break (0);
839     GNUNET_SERVER_client_disconnect (client);
840     return;
841   }
842   GNUNET_SERVER_receive_done (client, GNUNET_OK);
843   msg = (const struct GNUNET_SET_ElementMessage *) m;
844   el.size = ntohs (m->size) - sizeof *msg;
845   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
846               "client ins/rem element of size %u\n", el.size);
847   el.data = &msg[1];
848   if (GNUNET_MESSAGE_TYPE_SET_REMOVE == ntohs (m->type))
849   {
850     struct GNUNET_HashCode hash;
851
852     GNUNET_CRYPTO_hash (el.data, el.size, &hash);
853     ee = GNUNET_CONTAINER_multihashmap_get (set->elements, &hash);
854     if (NULL == ee)
855     {
856       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove non-existing element\n");
857       return;
858     }
859     if (GNUNET_YES == ee->removed)
860     {
861       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove element twice\n");
862       return;
863     }
864     ee->removed = GNUNET_YES;
865     ee->generation_removed = set->current_generation;
866     set->vt->remove (set->state, ee);
867   }
868   else
869   {
870     struct ElementEntry *ee_dup;
871
872     ee = GNUNET_malloc (el.size + sizeof *ee);
873     ee->element.size = el.size;
874     memcpy (&ee[1], el.data, el.size);
875     ee->element.data = &ee[1];
876     ee->generation_added = set->current_generation;
877     ee->remote = GNUNET_NO;
878     GNUNET_CRYPTO_hash (ee->element.data, el.size, &ee->element_hash);
879     ee_dup = GNUNET_CONTAINER_multihashmap_get (set->elements,
880                                                 &ee->element_hash);
881     if (NULL != ee_dup)
882     {
883       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "element inserted twice, ignoring\n");
884       GNUNET_free (ee);
885       return;
886     }
887     GNUNET_CONTAINER_multihashmap_put (set->elements, &ee->element_hash, ee,
888                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
889     set->vt->add (set->state, ee);
890   }
891 }
892
893
894 /**
895  * Called when a client wants to evaluate a set operation with another peer.
896  *
897  * @param cls unused
898  * @param client client that sent the message
899  * @param m message sent by the client
900  */
901 static void
902 handle_client_evaluate (void *cls,
903                         struct GNUNET_SERVER_Client *client,
904                         const struct GNUNET_MessageHeader *m)
905 {
906   struct Set *set;
907   struct GNUNET_SET_EvaluateMessage *msg;
908   struct OperationSpecification *spec;
909   struct Operation *op;
910
911   set = set_get (client);
912   if (NULL == set)
913   {
914     GNUNET_break (0);
915     GNUNET_SERVER_client_disconnect (client);
916     return;
917   }
918
919   msg = (struct GNUNET_SET_EvaluateMessage *) m;
920   spec = GNUNET_new (struct OperationSpecification);
921   spec->operation = set->operation;
922   spec->app_id = msg->app_id;
923   spec->salt = ntohl (msg->salt);
924   spec->peer = msg->target_peer;
925   spec->set = set;
926   spec->result_mode = ntohs (msg->result_mode);
927   spec->client_request_id = ntohl (msg->request_id);
928   spec->context_msg = GNUNET_MQ_extract_nested_mh (msg);
929
930   // for simplicity we just backup the context msg instead of rebuilding it later on
931   if (NULL != spec->context_msg)
932     spec->context_msg = GNUNET_copy_message (spec->context_msg);
933
934   op = GNUNET_new (struct Operation);
935   op->spec = spec;
936   op->generation_created = set->current_generation++;
937   op->vt = set->vt;
938   GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
939
940   op->channel = GNUNET_MESH_channel_create (mesh, op, &msg->target_peer,
941                                           GNUNET_APPLICATION_TYPE_SET,
942                                           GNUNET_MESH_OPTION_RELIABLE);
943
944   op->mq = GNUNET_MESH_mq_create (op->channel);
945
946   set->vt->evaluate (op);
947   GNUNET_SERVER_receive_done (client, GNUNET_OK);
948 }
949
950
951 /**
952  * Handle an ack from a client, and send the next element.
953  *
954  * @param cls unused
955  * @param client the client
956  * @param m the message
957  */
958 static void
959 handle_client_iter_ack (void *cls,
960                    struct GNUNET_SERVER_Client *client,
961                    const struct GNUNET_MessageHeader *m)
962 {
963   struct Set *set;
964
965   // client without a set requested an operation
966   set = set_get (client);
967   if (NULL == set)
968   {
969     GNUNET_break (0);
970     GNUNET_SERVER_client_disconnect (client);
971     return;
972   }
973
974   // client sent an ack, but we were not expecting one
975   if (NULL == set->iter)
976   {
977     GNUNET_break (0);
978     GNUNET_SERVER_client_disconnect (client);
979     return;
980   }
981
982   GNUNET_SERVER_receive_done (client, GNUNET_OK);
983   send_client_element (set);
984 }
985
986
987 /**
988  * Handle a request from the client to
989  * cancel a running set operation.
990  *
991  * @param cls unused
992  * @param client the client
993  * @param mh the message
994  */
995 static void
996 handle_client_cancel (void *cls,
997                       struct GNUNET_SERVER_Client *client,
998                       const struct GNUNET_MessageHeader *mh)
999 {
1000   const struct GNUNET_SET_CancelMessage *msg =
1001       (const struct GNUNET_SET_CancelMessage *) mh;
1002   struct Set *set;
1003   struct Operation *op;
1004   int found;
1005
1006   // client without a set requested an operation
1007   set = set_get (client);
1008   if (NULL == set)
1009   {
1010     GNUNET_break (0);
1011     GNUNET_SERVER_client_disconnect (client);
1012     return;
1013   }
1014   found = GNUNET_NO;
1015   for (op = set->ops_head; NULL != op; op = op->next)
1016   {
1017     if (op->spec->client_request_id == msg->request_id)
1018     {
1019       found = GNUNET_YES;
1020       break;
1021     }
1022   }
1023
1024   if (GNUNET_NO == found)
1025   {
1026     GNUNET_break (0);
1027     GNUNET_SERVER_client_disconnect (client);
1028     return;
1029   }
1030
1031   _GSS_operation_destroy (op);
1032 }
1033
1034
1035 /**
1036  * Handle a request from the client to accept
1037  * a set operation that came from a remote peer.
1038  * We forward the accept to the associated operation for handling
1039  *
1040  * @param cls unused
1041  * @param client the client
1042  * @param mh the message
1043  */
1044 static void
1045 handle_client_accept (void *cls,
1046                       struct GNUNET_SERVER_Client *client,
1047                       const struct GNUNET_MessageHeader *mh)
1048 {
1049   struct Set *set;
1050   struct GNUNET_SET_AcceptRejectMessage *msg = (struct GNUNET_SET_AcceptRejectMessage *) mh;
1051   struct Operation *op;
1052
1053   op = get_incoming (ntohl (msg->accept_reject_id));
1054
1055   // incoming operation does not exist
1056   if (NULL == op)
1057   {
1058     GNUNET_break (0);
1059     GNUNET_SERVER_client_disconnect (client);
1060     return;
1061   }
1062
1063   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "client accepting %u\n", ntohl (msg->accept_reject_id));
1064
1065   GNUNET_assert (GNUNET_YES == op->is_incoming);
1066
1067   // client without a set requested an operation
1068   set = set_get (client);
1069
1070   if (NULL == set)
1071   {
1072     GNUNET_break (0);
1073     GNUNET_SERVER_client_disconnect (client);
1074     return;
1075   }
1076
1077   op->spec->set = set;
1078
1079   incoming_retire (op);
1080
1081   GNUNET_assert (NULL != op->spec->set);
1082   GNUNET_assert (NULL != op->spec->set->vt);
1083
1084   GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, op);
1085
1086   op->spec->client_request_id = ntohl (msg->request_id);
1087   op->spec->result_mode = ntohs (msg->result_mode);
1088   op->generation_created = set->current_generation++;
1089   op->vt = op->spec->set->vt;
1090   GNUNET_assert (NULL != op->vt->accept);
1091   set->vt->accept (op);
1092   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1093 }
1094
1095
1096 /**
1097  * Called to clean up, after a shutdown has been requested.
1098  *
1099  * @param cls closure
1100  * @param tc context information (why was this task triggered now)
1101  */
1102 static void
1103 shutdown_task (void *cls,
1104                const struct GNUNET_SCHEDULER_TaskContext *tc)
1105 {
1106   while (NULL != incoming_head)
1107     incoming_destroy (incoming_head);
1108
1109   while (NULL != listeners_head)
1110     listener_destroy (listeners_head);
1111
1112   while (NULL != sets_head)
1113     set_destroy (sets_head);
1114
1115   /* it's important to destroy mesh at the end, as all channels
1116    * must be destroyed before the mesh handle! */
1117   if (NULL != mesh)
1118   {
1119     GNUNET_MESH_disconnect (mesh);
1120     mesh = NULL;
1121   }
1122
1123   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "handled shutdown request\n");
1124 }
1125
1126
1127 /**
1128  * Timeout happens iff:
1129  *  - we suggested an operation to our listener,
1130  *    but did not receive a response in time
1131  *  - we got the channel from a peer but no GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
1132  *  - shutdown (obviously)
1133  * @param cls channel context
1134  * @param tc context information (why was this task triggered now)
1135  */
1136 static void
1137 incoming_timeout_cb (void *cls,
1138                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1139 {
1140   struct Operation *incoming = cls;
1141
1142   GNUNET_assert (GNUNET_YES == incoming->is_incoming);
1143
1144   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1145     return;
1146
1147   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "remote peer timed out\n");
1148   incoming_destroy (incoming);
1149 }
1150
1151
1152 /**
1153  * Terminates an incoming operation in case we have not yet received an
1154  * operation request. Called by the channel destruction handler.
1155  *
1156  * @param op the channel context
1157  */
1158 static void
1159 handle_incoming_disconnect (struct Operation *op)
1160 {
1161   GNUNET_assert (GNUNET_YES == op->is_incoming);
1162
1163   if (NULL == op->channel)
1164     return;
1165
1166   incoming_destroy (op);
1167 }
1168
1169
1170 /**
1171  * Method called whenever another peer has added us to a channel
1172  * the other peer initiated.
1173  * Only called (once) upon reception of data with a message type which was
1174  * subscribed to in GNUNET_MESH_connect.
1175  *
1176  * The channel context represents the operation itself and gets added to a DLL,
1177  * from where it gets looked up when our local listener client responds
1178  * to a proposed/suggested operation or connects and associates with this operation.
1179  *
1180  * @param cls closure
1181  * @param channel new handle to the channel
1182  * @param initiator peer that started the channel
1183  * @param port Port this channel is for.
1184  * @param options Unused.
1185  * @return initial channel context for the channel
1186  *         (can be NULL -- that's not an error)
1187  */
1188 static void *
1189 channel_new_cb (void *cls,
1190                struct GNUNET_MESH_Channel *channel,
1191                const struct GNUNET_PeerIdentity *initiator,
1192                uint32_t port, enum MeshOption options)
1193 {
1194   struct Operation *incoming;
1195   static const struct SetVT incoming_vt = {
1196     .msg_handler = handle_incoming_msg,
1197     .peer_disconnect = handle_incoming_disconnect
1198   };
1199
1200   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new incoming channel\n");
1201
1202   if (GNUNET_APPLICATION_TYPE_SET != port)
1203   {
1204     GNUNET_break (0);
1205     GNUNET_MESH_channel_destroy (channel);
1206     return NULL;
1207   }
1208
1209   incoming = GNUNET_new (struct Operation);
1210   incoming->is_incoming = GNUNET_YES;
1211   incoming->state = GNUNET_new (struct OperationState);
1212   incoming->state->peer = *initiator;
1213   incoming->channel = channel;
1214   incoming->mq = GNUNET_MESH_mq_create (incoming->channel);
1215   incoming->vt = &incoming_vt;
1216   incoming->state->timeout_task =
1217       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES, incoming_timeout_cb, incoming);
1218   GNUNET_CONTAINER_DLL_insert_tail (incoming_head, incoming_tail, incoming);
1219
1220   return incoming;
1221 }
1222
1223
1224 /**
1225  * Function called whenever a channel is destroyed.  Should clean up
1226  * any associated state.
1227  * GNUNET_MESH_channel_destroy. It must NOT call GNUNET_MESH_channel_destroy on
1228  * the channel.
1229  *
1230  * The peer_disconnect function is part of a a virtual table set initially either
1231  * when a peer creates a new channel with us (channel_new_cb), or once we create
1232  * a new channel ourselves (evaluate).
1233  *
1234  * Once we know the exact type of operation (union/intersection), the vt is
1235  * replaced with an operation specific instance (_GSS_[op]_vt).
1236  *
1237  * @param cls closure (set from GNUNET_MESH_connect)
1238  * @param channel connection to the other end (henceforth invalid)
1239  * @param channel_ctx place where local state associated
1240  *                   with the channel is stored
1241  */
1242 static void
1243 channel_end_cb (void *cls,
1244                const struct GNUNET_MESH_Channel *channel, void *channel_ctx)
1245 {
1246   struct Operation *op = channel_ctx;
1247
1248   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "channel end cb called\n");
1249
1250   op->channel = NULL;
1251
1252   if (NULL != op->vt)
1253     op->vt->peer_disconnect (op);
1254   /* mesh will never call us with the context again! */
1255   GNUNET_free (channel_ctx);
1256 }
1257
1258
1259 /**
1260  * Functions with this signature are called whenever any message is
1261  * received via the mesh channel.
1262  *
1263  * The msg_handler is a virtual table set in initially either when a peer
1264  * creates a new channel with us (channel_new_cb), or once we create a new channel
1265  * ourselves (evaluate).
1266  *
1267  * Once we know the exact type of operation (union/intersection), the vt is
1268  * replaced with an operation specific instance (_GSS_[op]_vt).
1269  *
1270  * @param cls Closure (set from GNUNET_MESH_connect).
1271  * @param channel Connection to the other end.
1272  * @param channel_ctx Place to store local state associated with the channel.
1273  * @param message The actual message.
1274  *
1275  * @return GNUNET_OK to keep the channel open,
1276  *         GNUNET_SYSERR to close it (signal serious error).
1277  */
1278 static int
1279 dispatch_p2p_message (void *cls,
1280                       struct GNUNET_MESH_Channel *channel,
1281                       void **channel_ctx,
1282                       const struct GNUNET_MessageHeader *message)
1283 {
1284   struct Operation *op = *channel_ctx;
1285   int ret;
1286
1287   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "dispatching mesh message (type: %u)\n",
1288               ntohs (message->type));
1289   /* do this before the handler, as the handler might kill the channel */
1290   GNUNET_MESH_receive_done (channel);
1291   ret = op->vt->msg_handler (op, message);
1292   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "handled mesh message (type: %u)\n",
1293               ntohs (message->type));
1294   return ret;
1295 }
1296
1297
1298 /**
1299  * Function called by the service's run
1300  * method to run service-specific setup code.
1301  *
1302  * @param cls closure
1303  * @param server the initialized server
1304  * @param cfg configuration to use
1305  */
1306 static void
1307 run (void *cls, struct GNUNET_SERVER_Handle *server,
1308      const struct GNUNET_CONFIGURATION_Handle *cfg)
1309 {
1310   static const struct GNUNET_SERVER_MessageHandler server_handlers[] = {
1311     {handle_client_accept, NULL, GNUNET_MESSAGE_TYPE_SET_ACCEPT,
1312         sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1313     {handle_client_iter_ack, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_ACK, 0},
1314     {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_ADD, 0},
1315     {handle_client_create_set, NULL, GNUNET_MESSAGE_TYPE_SET_CREATE,
1316         sizeof (struct GNUNET_SET_CreateMessage)},
1317     {handle_client_iterate, NULL, GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST,
1318         sizeof (struct GNUNET_MessageHeader)},
1319     {handle_client_evaluate, NULL, GNUNET_MESSAGE_TYPE_SET_EVALUATE, 0},
1320     {handle_client_listen, NULL, GNUNET_MESSAGE_TYPE_SET_LISTEN,
1321         sizeof (struct GNUNET_SET_ListenMessage)},
1322     {handle_client_reject, NULL, GNUNET_MESSAGE_TYPE_SET_REJECT,
1323         sizeof (struct GNUNET_SET_AcceptRejectMessage)},
1324     {handle_client_add_remove, NULL, GNUNET_MESSAGE_TYPE_SET_REMOVE, 0},
1325     {handle_client_cancel, NULL, GNUNET_MESSAGE_TYPE_SET_CANCEL,
1326         sizeof (struct GNUNET_SET_CancelMessage)},
1327     {NULL, NULL, 0, 0}
1328   };
1329   static const struct GNUNET_MESH_MessageHandler mesh_handlers[] = {
1330     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST, 0},
1331     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF, 0},
1332     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS, 0},
1333     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_DONE, 0},
1334     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS, 0},
1335     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE, 0},
1336     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO, 0},
1337     {dispatch_p2p_message, GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF, 0},
1338     {NULL, 0, 0}
1339   };
1340   static const uint32_t mesh_ports[] = {GNUNET_APPLICATION_TYPE_SET, 0};
1341
1342   configuration = cfg;
1343   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1344                                 &shutdown_task, NULL);
1345   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1346   GNUNET_SERVER_add_handlers (server, server_handlers);
1347
1348   mesh = GNUNET_MESH_connect (cfg, NULL, channel_new_cb, channel_end_cb,
1349                               mesh_handlers, mesh_ports);
1350   if (NULL == mesh)
1351   {
1352     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "could not connect to mesh\n");
1353     return;
1354   }
1355
1356   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "started\n");
1357 }
1358
1359
1360 /**
1361  * The main function for the set service.
1362  *
1363  * @param argc number of arguments from the command line
1364  * @param argv command line arguments
1365  * @return 0 ok, 1 on error
1366  */
1367 int
1368 main (int argc, char *const *argv)
1369 {
1370   int ret;
1371   ret = GNUNET_SERVICE_run (argc, argv, "set",
1372                             GNUNET_SERVICE_OPTION_NONE, &run, NULL);
1373   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "exit (%d)\n", GNUNET_OK != ret);
1374   return (GNUNET_OK == ret) ? 0 : 1;
1375 }
1376