psyc: in-order message delivery
[oweals/gnunet.git] / src / core / gnunet-service-core_clients.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010, 2011 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 core/gnunet-service-core_clients.c
23  * @brief code for managing interactions with clients of core service
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_statistics_service.h"
29 #include "gnunet_transport_service.h"
30 #include "gnunet-service-core.h"
31 #include "gnunet-service-core_clients.h"
32 #include "gnunet-service-core_sessions.h"
33 #include "gnunet-service-core_typemap.h"
34 #include "core.h"
35
36
37 /**
38  * How many messages do we queue up at most for optional
39  * notifications to a client?  (this can cause notifications
40  * about outgoing messages to be dropped).
41  */
42 #define MAX_NOTIFY_QUEUE 1024
43
44
45 /**
46  * Data structure for each client connected to the CORE service.
47  */
48 struct GSC_Client
49 {
50   /**
51    * Clients are kept in a linked list.
52    */
53   struct GSC_Client *next;
54
55   /**
56    * Clients are kept in a linked list.
57    */
58   struct GSC_Client *prev;
59
60   /**
61    * Handle for the client with the server API.
62    */
63   struct GNUNET_SERVER_Client *client_handle;
64
65   /**
66    * Array of the types of messages this peer cares
67    * about (with @e tcnt entries).  Allocated as part
68    * of this client struct, do not free!
69    */
70   const uint16_t *types;
71
72   /**
73    * Map of peer identities to active transmission requests of this
74    * client to the peer (of type `struct GSC_ClientActiveRequest`).
75    */
76   struct GNUNET_CONTAINER_MultiPeerMap *requests;
77
78   /**
79    * Map containing all peers that this client knows we're connected to.
80    */
81   struct GNUNET_CONTAINER_MultiPeerMap *connectmap;
82
83   /**
84    * Options for messages this client cares about,
85    * see GNUNET_CORE_OPTION_ values.
86    */
87   uint32_t options;
88
89   /**
90    * Number of types of incoming messages this client
91    * specifically cares about.  Size of the @e types array.
92    */
93   unsigned int tcnt;
94
95 };
96
97
98 /**
99  * Big "or" of all client options.
100  */
101 static uint32_t all_client_options;
102
103 /**
104  * Head of linked list of our clients.
105  */
106 static struct GSC_Client *client_head;
107
108 /**
109  * Tail of linked list of our clients.
110  */
111 static struct GSC_Client *client_tail;
112
113 /**
114  * Context for notifications we need to send to our clients.
115  */
116 static struct GNUNET_SERVER_NotificationContext *notifier;
117
118 /**
119  * Tokenizer for messages received from clients.
120  */
121 static struct GNUNET_SERVER_MessageStreamTokenizer *client_mst;
122
123
124 /**
125  * Lookup our client struct given the server's client handle.
126  *
127  * @param client server client handle to look up
128  * @return our client handle for the client
129  */
130 static struct GSC_Client *
131 find_client (struct GNUNET_SERVER_Client *client)
132 {
133   struct GSC_Client *c;
134
135   c = client_head;
136   while ((c != NULL) && (c->client_handle != client))
137     c = c->next;
138   return c;
139 }
140
141
142 /**
143  * Send a message to one of our clients.
144  *
145  * @param client target for the message
146  * @param msg message to transmit
147  * @param can_drop could this message be dropped if the
148  *        client's queue is getting too large?
149  */
150 static void
151 send_to_client (struct GSC_Client *client,
152                 const struct GNUNET_MessageHeader *msg, int can_drop)
153 {
154   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
155               "Preparing to send %u bytes of message of type %u to client.\n",
156               (unsigned int) ntohs (msg->size),
157               (unsigned int) ntohs (msg->type));
158   GNUNET_SERVER_notification_context_unicast (notifier, client->client_handle,
159                                               msg, can_drop);
160 }
161
162
163 /**
164  * Send a message to one of our clients.
165  *
166  * @param client target for the message
167  * @param msg message to transmit
168  * @param can_drop could this message be dropped if the
169  *        client's queue is getting too large?
170  */
171 void
172 GSC_CLIENTS_send_to_client (struct GNUNET_SERVER_Client *client,
173                             const struct GNUNET_MessageHeader *msg,
174                             int can_drop)
175 {
176   struct GSC_Client *c;
177
178   c = find_client (client);
179   if (NULL == c)
180   {
181     GNUNET_break (0);
182     return;
183   }
184   send_to_client (c, msg, can_drop);
185 }
186
187
188 /**
189  * Test if the client is interested in messages of the given type.
190  *
191  * @param type message type
192  * @param c client to test
193  * @return #GNUNET_YES if @a c is interested, #GNUNET_NO if not.
194  */
195 static int
196 type_match (uint16_t type, struct GSC_Client *c)
197 {
198   unsigned int i;
199
200   if (c->tcnt == 0)
201     return GNUNET_YES;          /* peer without handlers matches ALL */
202   for (i = 0; i < c->tcnt; i++)
203     if (type == c->types[i])
204       return GNUNET_YES;
205   return GNUNET_NO;
206 }
207
208
209 /**
210  * Send a message to all of our current clients that have the right
211  * options set.
212  *
213  * @param partner origin (or destination) of the message (used to check that this peer is
214  *        known to be connected to the respective client)
215  * @param msg message to multicast
216  * @param can_drop can this message be discarded if the queue is too long
217  * @param options mask to use
218  * @param type type of the embedded message, 0 for none
219  */
220 static void
221 send_to_all_clients (const struct GNUNET_PeerIdentity *partner,
222                      const struct GNUNET_MessageHeader *msg, int can_drop,
223                      uint32_t options, uint16_t type)
224 {
225   struct GSC_Client *c;
226   int tm;
227
228   for (c = client_head; NULL != c; c = c->next)
229   {
230     tm = type_match (type, c);
231     if (!  ( (0 != (c->options & options)) ||
232              ( (0 != (options & GNUNET_CORE_OPTION_SEND_FULL_INBOUND)) &&
233                (GNUNET_YES == tm) ) ) )
234       continue;  /* neither options nor type match permit the message */
235     if ( (0 != (options & GNUNET_CORE_OPTION_SEND_HDR_INBOUND)) &&
236          ( (0 != (c->options & GNUNET_CORE_OPTION_SEND_FULL_INBOUND)) ||
237            (GNUNET_YES == tm) ) )
238       continue;
239     if ( (0 != (options & GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND)) &&
240          (0 != (c->options & GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND)) )
241       continue;
242     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
243                 "Sending %u message with %u bytes to client interested in messages of type %u.\n",
244                 options,
245                 ntohs (msg->size),
246                 (unsigned int) type);
247     GNUNET_assert ( (0 == (c->options & GNUNET_CORE_OPTION_SEND_FULL_INBOUND)) ||
248                     (GNUNET_YES != tm) ||
249                     (GNUNET_YES ==
250                      GNUNET_CONTAINER_multipeermap_contains (c->connectmap,
251                                                              partner)) );
252     send_to_client (c, msg, can_drop);
253   }
254 }
255
256
257 /**
258  * Handle CORE_INIT request.
259  *
260  * @param cls unused
261  * @param client new client that sent INIT
262  * @param message the `struct InitMessage` (presumably)
263  */
264 static void
265 handle_client_init (void *cls,
266                     struct GNUNET_SERVER_Client *client,
267                     const struct GNUNET_MessageHeader *message)
268 {
269   const struct InitMessage *im;
270   struct InitReplyMessage irm;
271   struct GSC_Client *c;
272   uint16_t msize;
273   const uint16_t *types;
274   uint16_t *wtypes;
275   unsigned int i;
276
277   /* check that we don't have an entry already */
278   c = find_client (client);
279   if (NULL != c)
280   {
281     GNUNET_break (0);
282     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
283     return;
284   }
285   msize = ntohs (message->size);
286   if (msize < sizeof (struct InitMessage))
287   {
288     GNUNET_break (0);
289     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
290     return;
291   }
292   GNUNET_SERVER_notification_context_add (notifier, client);
293   im = (const struct InitMessage *) message;
294   types = (const uint16_t *) &im[1];
295   msize -= sizeof (struct InitMessage);
296   c = GNUNET_malloc (sizeof (struct GSC_Client) + msize);
297   c->client_handle = client;
298   c->tcnt = msize / sizeof (uint16_t);
299   c->options = ntohl (im->options);
300   all_client_options |= c->options;
301   c->types = (const uint16_t *) &c[1];
302   c->connectmap = GNUNET_CONTAINER_multipeermap_create (16, GNUNET_NO);
303   GNUNET_assert (GNUNET_YES ==
304                  GNUNET_CONTAINER_multipeermap_put (c->connectmap,
305                                                     &GSC_my_identity,
306                                                     NULL,
307                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
308   wtypes = (uint16_t *) & c[1];
309   for (i = 0; i < c->tcnt; i++)
310     wtypes[i] = ntohs (types[i]);
311   GSC_TYPEMAP_add (wtypes, c->tcnt);
312   GNUNET_CONTAINER_DLL_insert (client_head, client_tail, c);
313   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
314               "Client connecting to core service is interested in %u message types\n",
315               (unsigned int) c->tcnt);
316   /* send init reply message */
317   irm.header.size = htons (sizeof (struct InitReplyMessage));
318   irm.header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY);
319   irm.reserved = htonl (0);
320   irm.my_identity = GSC_my_identity;
321   send_to_client (c, &irm.header, GNUNET_NO);
322   GSC_SESSIONS_notify_client_about_sessions (c);
323   GNUNET_SERVER_receive_done (client, GNUNET_OK);
324 }
325
326
327 /**
328  * Handle CORE_SEND_REQUEST message.
329  *
330  * @param cls unused
331  * @param client new client that sent CORE_SEND_REQUEST
332  * @param message the `struct SendMessageRequest` (presumably)
333  */
334 static void
335 handle_client_send_request (void *cls,
336                             struct GNUNET_SERVER_Client *client,
337                             const struct GNUNET_MessageHeader *message)
338 {
339   const struct SendMessageRequest *req;
340   struct GSC_Client *c;
341   struct GSC_ClientActiveRequest *car;
342   int is_loopback;
343
344   req = (const struct SendMessageRequest *) message;
345   c = find_client (client);
346   if (c == NULL)
347   {
348     /* client did not send INIT first! */
349     GNUNET_break (0);
350     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
351     return;
352   }
353   if (c->requests == NULL)
354     c->requests = GNUNET_CONTAINER_multipeermap_create (16, GNUNET_NO);
355   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
356               "Client asked for transmission to `%s'\n",
357               GNUNET_i2s (&req->peer));
358   is_loopback =
359       (0 ==
360        memcmp (&req->peer, &GSC_my_identity,
361                sizeof (struct GNUNET_PeerIdentity)));
362   if ((!is_loopback) &&
363       (GNUNET_YES !=
364        GNUNET_CONTAINER_multipeermap_contains (c->connectmap,
365                                                &req->peer)))
366   {
367     /* neighbour must have disconnected since request was issued,
368      * ignore (client will realize it once it processes the
369      * disconnect notification) */
370     GNUNET_STATISTICS_update (GSC_stats,
371                               gettext_noop
372                               ("# send requests dropped (disconnected)"), 1,
373                               GNUNET_NO);
374     GNUNET_SERVER_receive_done (client, GNUNET_OK);
375     return;
376   }
377
378   car = GNUNET_CONTAINER_multipeermap_get (c->requests, &req->peer);
379   if (NULL == car)
380   {
381     /* create new entry */
382     car = GNUNET_new (struct GSC_ClientActiveRequest);
383     GNUNET_assert (GNUNET_OK ==
384                    GNUNET_CONTAINER_multipeermap_put (c->requests,
385                                                       &req->peer,
386                                                       car,
387                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
388     car->client_handle = c;
389   }
390   else
391   {
392     GSC_SESSIONS_dequeue_request (car);
393   }
394   car->target = req->peer;
395   car->deadline = GNUNET_TIME_absolute_ntoh (req->deadline);
396   car->priority = (enum GNUNET_CORE_Priority) ntohl (req->priority);
397   car->msize = ntohs (req->size);
398   car->smr_id = req->smr_id;
399   car->was_solicited = GNUNET_NO;
400   if (is_loopback)
401   {
402     /* loopback, satisfy immediately */
403     GSC_CLIENTS_solicit_request (car);
404     GNUNET_SERVER_receive_done (client, GNUNET_OK);
405     return;
406   }
407   GSC_SESSIONS_queue_request (car);
408   GNUNET_SERVER_receive_done (client, GNUNET_OK);
409 }
410
411
412 /**
413  * Closure for the #client_tokenizer_callback().
414  */
415 struct TokenizerContext
416 {
417
418   /**
419    * Active request handle for the message.
420    */
421   struct GSC_ClientActiveRequest *car;
422
423   /**
424    * How important is this message.
425    */
426   enum GNUNET_CORE_Priority priority;
427
428   /**
429    * Is corking allowed (set only once we have the real message).
430    */
431   int cork;
432
433 };
434
435
436 /**
437  * Handle CORE_SEND request.
438  *
439  * @param cls unused
440  * @param client the client issuing the request
441  * @param message the `struct SendMessage`
442  */
443 static void
444 handle_client_send (void *cls,
445                     struct GNUNET_SERVER_Client *client,
446                     const struct GNUNET_MessageHeader *message)
447 {
448   const struct SendMessage *sm;
449   struct GSC_Client *c;
450   struct TokenizerContext tc;
451   uint16_t msize;
452
453   msize = ntohs (message->size);
454   if (msize <
455       sizeof (struct SendMessage) + sizeof (struct GNUNET_MessageHeader))
456   {
457     GNUNET_break (0);
458     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
459     return;
460   }
461   sm = (const struct SendMessage *) message;
462   msize -= sizeof (struct SendMessage);
463   GNUNET_break (0 == ntohl (sm->reserved));
464   c = find_client (client);
465   if (NULL == c)
466   {
467     /* client did not send INIT first! */
468     GNUNET_break (0);
469     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
470     return;
471   }
472   tc.car =
473       GNUNET_CONTAINER_multipeermap_get (c->requests, &sm->peer);
474   if (NULL == tc.car)
475   {
476     /* Must have been that we first approved the request, then got disconnected
477      * (which triggered removal of the 'car') and now the client gives us a message
478      * just *before* the client learns about the disconnect.  Theoretically, we
479      * might also now be *again* connected.  So this can happen (but should be
480      * rare).  If it does happen, the message is discarded. */
481     GNUNET_STATISTICS_update (GSC_stats,
482                               gettext_noop
483                               ("# messages discarded (session disconnected)"),
484                               1, GNUNET_NO);
485     GNUNET_SERVER_receive_done (client, GNUNET_OK);
486     return;
487   }
488   GNUNET_assert (GNUNET_YES ==
489                  GNUNET_CONTAINER_multipeermap_remove (c->requests,
490                                                        &sm->peer,
491                                                        tc.car));
492   tc.cork = ntohl (sm->cork);
493   tc.priority = (enum GNUNET_CORE_Priority) ntohl (sm->priority);
494   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
495               "Client asked for transmission of %u bytes to `%s' %s\n",
496               msize,
497               GNUNET_i2s (&sm->peer), tc.cork ? "now" : "");
498   GNUNET_SERVER_mst_receive (client_mst, &tc,
499                              (const char *) &sm[1], msize,
500                              GNUNET_YES, GNUNET_NO);
501   if (0 !=
502       memcmp (&tc.car->target, &GSC_my_identity,
503               sizeof (struct GNUNET_PeerIdentity)))
504     GSC_SESSIONS_dequeue_request (tc.car);
505   GNUNET_free (tc.car);
506   GNUNET_SERVER_receive_done (client, GNUNET_OK);
507 }
508
509
510 /**
511  * Functions with this signature are called whenever a complete
512  * message is received by the tokenizer.  Used by the 'client_mst' for
513  * dispatching messages from clients to either the SESSION subsystem
514  * or other CLIENT (for loopback).
515  *
516  * @param cls closure
517  * @param client reservation request (`struct GSC_ClientActiveRequest`)
518  * @param message the actual message
519  */
520 static int
521 client_tokenizer_callback (void *cls, void *client,
522                            const struct GNUNET_MessageHeader *message)
523 {
524   struct TokenizerContext *tc = client;
525   struct GSC_ClientActiveRequest *car = tc->car;
526   char buf[92];
527
528   GNUNET_snprintf (buf, sizeof (buf),
529                    gettext_noop ("# bytes of messages of type %u received"),
530                    (unsigned int) ntohs (message->type));
531   GNUNET_STATISTICS_update (GSC_stats, buf, ntohs (message->size), GNUNET_NO);
532   if (0 ==
533       memcmp (&car->target, &GSC_my_identity,
534               sizeof (struct GNUNET_PeerIdentity)))
535   {
536     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
537                 "Delivering message of type %u to myself\n",
538                 ntohs (message->type));
539     GSC_CLIENTS_deliver_message (&GSC_my_identity, message,
540                                  ntohs (message->size),
541                                  GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND);
542     GSC_CLIENTS_deliver_message (&GSC_my_identity, message,
543                                  sizeof (struct GNUNET_MessageHeader),
544                                  GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND);
545     GSC_CLIENTS_deliver_message (&GSC_my_identity, message,
546                                  ntohs (message->size),
547                                  GNUNET_CORE_OPTION_SEND_FULL_INBOUND);
548     GSC_CLIENTS_deliver_message (&GSC_my_identity, message,
549                                  sizeof (struct GNUNET_MessageHeader),
550                                  GNUNET_CORE_OPTION_SEND_HDR_INBOUND);
551   }
552   else
553   {
554     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
555                 "Delivering message of type %u to %s\n",
556                 ntohs (message->type),
557                 GNUNET_i2s (&car->target));
558     GSC_CLIENTS_deliver_message (&car->target, message,
559                                  ntohs (message->size),
560                                  GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND);
561     GSC_CLIENTS_deliver_message (&car->target, message,
562                                  sizeof (struct GNUNET_MessageHeader),
563                                  GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND);
564     GSC_SESSIONS_transmit (car,
565                            message,
566                            tc->cork,
567                            tc->priority);
568   }
569   return GNUNET_OK;
570 }
571
572
573 /**
574  * Free client request records.
575  *
576  * @param cls NULL
577  * @param key identity of peer for which this is an active request
578  * @param value the `struct GSC_ClientActiveRequest` to free
579  * @return #GNUNET_YES (continue iteration)
580  */
581 static int
582 destroy_active_client_request (void *cls,
583                                const struct GNUNET_PeerIdentity *key,
584                                void *value)
585 {
586   struct GSC_ClientActiveRequest *car = value;
587
588   GNUNET_assert (GNUNET_YES ==
589                  GNUNET_CONTAINER_multipeermap_remove (car->
590                                                        client_handle->requests,
591                                                        &car->target,
592                                                        car));
593   GSC_SESSIONS_dequeue_request (car);
594   GNUNET_free (car);
595   return GNUNET_YES;
596 }
597
598
599 /**
600  * A client disconnected, clean up.
601  *
602  * @param cls closure
603  * @param client identification of the client
604  */
605 static void
606 handle_client_disconnect (void *cls,
607                           struct GNUNET_SERVER_Client *client)
608 {
609   struct GSC_Client *c;
610
611   if (NULL == client)
612     return;
613   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
614               "Client %p has disconnected from core service.\n", client);
615   c = find_client (client);
616   if (c == NULL)
617     return;                     /* client never sent INIT */
618   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, c);
619   if (c->requests != NULL)
620   {
621     GNUNET_CONTAINER_multipeermap_iterate (c->requests,
622                                            &destroy_active_client_request,
623                                            NULL);
624     GNUNET_CONTAINER_multipeermap_destroy (c->requests);
625   }
626   GNUNET_CONTAINER_multipeermap_destroy (c->connectmap);
627   c->connectmap = NULL;
628   GSC_TYPEMAP_remove (c->types, c->tcnt);
629   GNUNET_free (c);
630
631   /* recalculate 'all_client_options' */
632   all_client_options = 0;
633   for (c = client_head; NULL != c ; c = c->next)
634     all_client_options |= c->options;
635 }
636
637
638 /**
639  * Tell a client that we are ready to receive the message.
640  *
641  * @param car request that is now ready; the responsibility
642  *        for the handle remains shared between CLIENTS
643  *        and SESSIONS after this call.
644  */
645 void
646 GSC_CLIENTS_solicit_request (struct GSC_ClientActiveRequest *car)
647 {
648   struct GSC_Client *c;
649   struct SendMessageReady smr;
650
651   c = car->client_handle;
652   if (GNUNET_YES !=
653       GNUNET_CONTAINER_multipeermap_contains (c->connectmap,
654                                               &car->target))
655   {
656     /* connection has gone down since, drop request */
657     GNUNET_assert (0 !=
658                    memcmp (&car->target, &GSC_my_identity,
659                            sizeof (struct GNUNET_PeerIdentity)));
660     GSC_SESSIONS_dequeue_request (car);
661     GSC_CLIENTS_reject_request (car);
662     return;
663   }
664   smr.header.size = htons (sizeof (struct SendMessageReady));
665   smr.header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND_READY);
666   smr.size = htons (car->msize);
667   smr.smr_id = car->smr_id;
668   smr.peer = car->target;
669   send_to_client (c, &smr.header, GNUNET_NO);
670 }
671
672
673 /**
674  * Tell a client that we will never be ready to receive the
675  * given message in time (disconnect or timeout).
676  *
677  * @param car request that now permanently failed; the
678  *        responsibility for the handle is now returned
679  *        to CLIENTS (SESSIONS is done with it).
680  */
681 void
682 GSC_CLIENTS_reject_request (struct GSC_ClientActiveRequest *car)
683 {
684   GNUNET_assert (GNUNET_YES ==
685                  GNUNET_CONTAINER_multipeermap_remove (car->
686                                                        client_handle->requests,
687                                                        &car->target,
688                                                        car));
689   GNUNET_free (car);
690 }
691
692
693 /**
694  * Notify a particular client about a change to existing connection to
695  * one of our neighbours (check if the client is interested).  Called
696  * from 'GSC_SESSIONS_notify_client_about_sessions'.
697  *
698  * @param client client to notify
699  * @param neighbour identity of the neighbour that changed status
700  * @param tmap_old previous type map for the neighbour, NULL for connect
701  * @param tmap_new updated type map for the neighbour, NULL for disconnect
702  */
703 void
704 GSC_CLIENTS_notify_client_about_neighbour (struct GSC_Client *client,
705                                            const struct GNUNET_PeerIdentity *neighbour,
706                                            const struct GSC_TypeMap *tmap_old,
707                                            const struct GSC_TypeMap *tmap_new)
708 {
709   struct ConnectNotifyMessage *cnm;
710   size_t size;
711   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
712   struct DisconnectNotifyMessage dcm;
713   int old_match;
714   int new_match;
715
716   old_match = GSC_TYPEMAP_test_match (tmap_old, client->types, client->tcnt);
717   new_match = GSC_TYPEMAP_test_match (tmap_new, client->types, client->tcnt);
718   if (old_match == new_match)
719   {
720     GNUNET_assert (old_match ==
721                    GNUNET_CONTAINER_multipeermap_contains (client->connectmap,
722                                                            neighbour));
723     return;                     /* no change */
724   }
725   if (old_match == GNUNET_NO)
726   {
727     /* send connect */
728     GNUNET_assert (GNUNET_NO ==
729                    GNUNET_CONTAINER_multipeermap_contains (client->connectmap,
730                                                            neighbour));
731     GNUNET_assert (GNUNET_YES ==
732                    GNUNET_CONTAINER_multipeermap_put (client->connectmap,
733                                                       neighbour,
734                                                       NULL,
735                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
736     size = sizeof (struct ConnectNotifyMessage);
737     cnm = (struct ConnectNotifyMessage *) buf;
738     cnm->header.size = htons (size);
739     cnm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT);
740     cnm->reserved = htonl (0);
741     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
742                 "Sending `%s' message to client.\n",
743                 "NOTIFY_CONNECT");
744     cnm->peer = *neighbour;
745     send_to_client (client, &cnm->header, GNUNET_NO);
746   }
747   else
748   {
749     /* send disconnect */
750     GNUNET_assert (GNUNET_YES ==
751                    GNUNET_CONTAINER_multipeermap_contains (client->connectmap,
752                                                            neighbour));
753     GNUNET_assert (GNUNET_YES ==
754                    GNUNET_CONTAINER_multipeermap_remove (client->connectmap,
755                                                          neighbour,
756                                                          NULL));
757     dcm.header.size = htons (sizeof (struct DisconnectNotifyMessage));
758     dcm.header.type = htons (GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT);
759     dcm.reserved = htonl (0);
760     dcm.peer = *neighbour;
761     send_to_client (client, &dcm.header, GNUNET_NO);
762   }
763 }
764
765
766 /**
767  * Notify all clients about a change to existing session.
768  * Called from SESSIONS whenever there is a change in sessions
769  * or types processed by the respective peer.
770  *
771  * @param neighbour identity of the neighbour that changed status
772  * @param tmap_old previous type map for the neighbour, NULL for connect
773  * @param tmap_new updated type map for the neighbour, NULL for disconnect
774  */
775 void
776 GSC_CLIENTS_notify_clients_about_neighbour (const struct GNUNET_PeerIdentity *neighbour,
777                                             const struct GSC_TypeMap *tmap_old,
778                                             const struct GSC_TypeMap *tmap_new)
779 {
780   struct GSC_Client *c;
781
782   for (c = client_head; NULL != c; c = c->next)
783     GSC_CLIENTS_notify_client_about_neighbour (c, neighbour,
784                                                tmap_old, tmap_new);
785 }
786
787
788 /**
789  * Deliver P2P message to interested clients.  Caller must have checked
790  * that the sending peer actually lists the given message type as one
791  * of its types.
792  *
793  * @param sender peer who sent us the message
794  * @param msg the message
795  * @param msize number of bytes to transmit
796  * @param options options for checking which clients should
797  *        receive the message
798  */
799 void
800 GSC_CLIENTS_deliver_message (const struct GNUNET_PeerIdentity *sender,
801                              const struct GNUNET_MessageHeader *msg,
802                              uint16_t msize,
803                              uint32_t options)
804 {
805   size_t size = msize + sizeof (struct NotifyTrafficMessage);
806   char buf[size] GNUNET_ALIGN;
807   struct NotifyTrafficMessage *ntm;
808
809   if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
810   {
811     GNUNET_break (0);
812     /* recovery strategy: throw performance data away... */
813     size = msize + sizeof (struct NotifyTrafficMessage);
814   }
815   if (! ( (0 != (all_client_options & options)) ||
816           (0 != (options & GNUNET_CORE_OPTION_SEND_FULL_INBOUND)) ))
817     return; /* no client cares about this message notification */
818   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
819               "Core service passes message from `%4s' of type %u to client.\n",
820               GNUNET_i2s (sender), (unsigned int) ntohs (msg->type));
821   GSC_SESSIONS_add_to_typemap (sender, ntohs (msg->type));
822   ntm = (struct NotifyTrafficMessage *) buf;
823   ntm->header.size = htons (size);
824   if (0 != (options & (GNUNET_CORE_OPTION_SEND_FULL_INBOUND | GNUNET_CORE_OPTION_SEND_HDR_INBOUND)))
825     ntm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND);
826   else
827     ntm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND);
828   ntm->peer = *sender;
829   memcpy (&ntm[1], msg, msize);
830   send_to_all_clients (sender, &ntm->header, GNUNET_YES, options,
831                        ntohs (msg->type));
832 }
833
834
835 /**
836  * Initialize clients subsystem.
837  *
838  * @param server handle to server clients connect to
839  */
840 void
841 GSC_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
842 {
843   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
844     {&handle_client_init, NULL,
845      GNUNET_MESSAGE_TYPE_CORE_INIT, 0},
846     {&GSC_KX_handle_client_monitor_peers, NULL,
847      GNUNET_MESSAGE_TYPE_CORE_MONITOR_PEERS,
848      sizeof (struct GNUNET_MessageHeader)},
849     {&handle_client_send_request, NULL,
850      GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST,
851      sizeof (struct SendMessageRequest)},
852     {&handle_client_send, NULL,
853      GNUNET_MESSAGE_TYPE_CORE_SEND, 0},
854     {NULL, NULL, 0, 0}
855   };
856
857   /* setup notification */
858   client_mst = GNUNET_SERVER_mst_create (&client_tokenizer_callback, NULL);
859   notifier =
860       GNUNET_SERVER_notification_context_create (server, MAX_NOTIFY_QUEUE);
861   GNUNET_SERVER_disconnect_notify (server,
862                                    &handle_client_disconnect, NULL);
863   GNUNET_SERVER_add_handlers (server, handlers);
864 }
865
866
867 /**
868  * Shutdown clients subsystem.
869  */
870 void
871 GSC_CLIENTS_done ()
872 {
873   struct GSC_Client *c;
874
875   while (NULL != (c = client_head))
876     handle_client_disconnect (NULL, c->client_handle);
877   if (NULL != notifier)
878   {
879     GNUNET_SERVER_notification_context_destroy (notifier);
880     notifier = NULL;
881   }
882   if (NULL != client_mst)
883   {
884     GNUNET_SERVER_mst_destroy (client_mst);
885     client_mst = NULL;
886   }
887 }
888
889 /* end of gnunet-service-core_clients.c */