- missing header
[oweals/gnunet.git] / src / mesh / gnunet-service-mesh_local.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 #include "platform.h"
23 #include "gnunet_util_lib.h"
24
25 #include "gnunet_statistics_service.h"
26
27 #include "mesh.h"
28 #include "mesh_protocol.h" /* GNUNET_MESH_Data is shared */
29
30 #include "gnunet-service-mesh_local.h"
31 #include "gnunet-service-mesh_channel.h"
32
33 #define LOG(level, ...) GNUNET_log_from(level,"mesh-loc",__VA_ARGS__)
34
35 /******************************************************************************/
36 /********************************   STRUCTS  **********************************/
37 /******************************************************************************/
38
39 /**
40  * Struct containing information about a client of the service
41  *
42  * TODO: add a list of 'waiting' ports
43  */
44 struct MeshClient
45 {
46     /**
47      * Linked list next
48      */
49   struct MeshClient *next;
50
51     /**
52      * Linked list prev
53      */
54   struct MeshClient *prev;
55
56     /**
57      * Tunnels that belong to this client, indexed by local id
58      */
59   struct GNUNET_CONTAINER_MultiHashMap32 *own_channels;
60
61     /**
62      * Tunnels this client has accepted, indexed by incoming local id
63      */
64   struct GNUNET_CONTAINER_MultiHashMap32 *incoming_channels;
65
66     /**
67      * Channel ID for the next incoming channel.
68      */
69   MESH_ChannelNumber next_chid;
70
71     /**
72      * Handle to communicate with the client
73      */
74   struct GNUNET_SERVER_Client *handle;
75
76     /**
77      * Ports that this client has declared interest in.
78      * Indexed by port, contains *Client.
79      */
80   struct GNUNET_CONTAINER_MultiHashMap32 *ports;
81
82     /**
83      * Whether the client is active or shutting down (don't send confirmations
84      * to a client that is shutting down.
85      */
86   int shutting_down;
87
88     /**
89      * ID of the client, mainly for debug messages
90      */
91   unsigned int id;
92 };
93
94 /******************************************************************************/
95 /*******************************   GLOBALS  ***********************************/
96 /******************************************************************************/
97
98 /**
99  * Global handle to the statistics service.
100  */
101 extern struct GNUNET_STATISTICS_Handle *stats;
102
103 /**
104  * Handle to server lib.
105  */
106 static struct GNUNET_SERVER_Handle *server_handle;
107
108 /**
109  * DLL with all the clients, head.
110  */
111 static struct MeshClient *clients_head;
112
113 /**
114  * DLL with all the clients, tail.
115  */
116 static struct MeshClient *clients_tail;
117
118 /**
119  * Next ID to assign to a client.
120  */
121 unsigned int next_client_id;
122
123 /**
124  * All ports clients of this peer have opened.
125  */
126 static struct GNUNET_CONTAINER_MultiHashMap32 *ports;
127
128 /**
129  * Notification context, to send messages to local clients.
130  */
131 static struct GNUNET_SERVER_NotificationContext *nc;
132
133
134 /******************************************************************************/
135 /********************************   STATIC  ***********************************/
136 /******************************************************************************/
137
138 /**
139  * Remove client's ports from the global hashmap on disconnect.
140  *
141  * @param cls Closure (unused).
142  * @param key Port.
143  * @param value Client structure.
144  *
145  * @return GNUNET_OK, keep iterating.
146  */
147 static int
148 client_release_ports (void *cls,
149                       uint32_t key,
150                       void *value)
151 {
152   int res;
153
154   res = GNUNET_CONTAINER_multihashmap32_remove (ports, key, value);
155   if (GNUNET_YES != res)
156   {
157     GNUNET_break (0);
158     LOG (GNUNET_ERROR_TYPE_WARNING,
159                 "Port %u by client %p was not registered.\n",
160                 key, value);
161   }
162   return GNUNET_OK;
163 }
164
165
166
167 /******************************************************************************/
168 /********************************  HANDLES  ***********************************/
169 /******************************************************************************/
170
171
172 /**
173  * Handler for client connection.
174  *
175  * @param cls Closure (unused).
176  * @param client Client handler.
177  */
178 static void
179 handle_client_connect (void *cls, struct GNUNET_SERVER_Client *client)
180 {
181   struct MeshClient *c;
182
183   LOG (GNUNET_ERROR_TYPE_DEBUG, "client connected: %p\n", client);
184   if (NULL == client)
185     return;
186   c = GNUNET_new (struct MeshClient);
187   c->handle = client;
188   c->id = next_client_id++; /* overflow not important: just for debug */
189   c->next_chid = GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
190   GNUNET_SERVER_client_keep (client);
191   GNUNET_SERVER_client_set_user_context (client, c);
192   GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, c);
193 }
194
195
196 /**
197  * Iterator for deleting each channel whose client endpoint disconnected.
198  *
199  * @param cls Closure (client that has disconnected).
200  * @param key The local channel id (used to access the hashmap).
201  * @param value The value stored at the key (channel to destroy).
202  *
203  * @return GNUNET_OK, keep iterating.
204  */
205 static int
206 channel_destroy_iterator (void *cls,
207                           uint32_t key,
208                           void *value)
209 {
210   struct MeshChannel *ch = value;
211   struct MeshClient *c = cls;
212
213   LOG (GNUNET_ERROR_TYPE_DEBUG,
214               " Channel %s destroy, due to client %s shutdown.\n",
215               GMCH_2s (ch), GML_2s (c));
216
217   GMCH_handle_local_destroy (ch, c);
218   return GNUNET_OK;
219 }
220
221 /**
222  * Handler for client disconnection
223  *
224  * @param cls closure
225  * @param client identification of the client; NULL
226  *        for the last call when the server is destroyed
227  */
228 static void
229 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
230 {
231   struct MeshClient *c;
232
233   LOG (GNUNET_ERROR_TYPE_DEBUG, "client disconnected: %p\n", client);
234   if (client == NULL)
235   {
236     LOG (GNUNET_ERROR_TYPE_DEBUG, "   (SERVER DOWN)\n");
237     return;
238   }
239
240   c = GML_client_get (client);
241   if (NULL != c)
242   {
243     LOG (GNUNET_ERROR_TYPE_DEBUG, "matching client found (%u, %p)\n",
244                 c->id, c);
245     GNUNET_SERVER_client_drop (c->handle);
246     c->shutting_down = GNUNET_YES;
247     if (NULL != c->own_channels)
248     {
249       GNUNET_CONTAINER_multihashmap32_iterate (c->own_channels,
250                                                &channel_destroy_iterator, c);
251       GNUNET_CONTAINER_multihashmap32_destroy (c->own_channels);
252     }
253
254     if (NULL != c->incoming_channels)
255     {
256       GNUNET_CONTAINER_multihashmap32_iterate (c->incoming_channels,
257                                                &channel_destroy_iterator, c);
258       GNUNET_CONTAINER_multihashmap32_destroy (c->incoming_channels);
259     }
260
261     if (NULL != c->ports)
262     {
263       GNUNET_CONTAINER_multihashmap32_iterate (c->ports,
264                                                &client_release_ports, c);
265       GNUNET_CONTAINER_multihashmap32_destroy (c->ports);
266     }
267     GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, c);
268     GNUNET_STATISTICS_update (stats, "# clients", -1, GNUNET_NO);
269     LOG (GNUNET_ERROR_TYPE_DEBUG, "  client free (%p)\n", c);
270     GNUNET_free (c);
271   }
272   else
273   {
274     LOG (GNUNET_ERROR_TYPE_WARNING, " context NULL!\n");
275   }
276   LOG (GNUNET_ERROR_TYPE_DEBUG, "done!\n");
277   return;
278 }
279
280
281 /**
282  * Handler for new clients
283  *
284  * @param cls closure
285  * @param client identification of the client
286  * @param message the actual message, which includes messages the client wants
287  */
288 static void
289 handle_new_client (void *cls, struct GNUNET_SERVER_Client *client,
290                    const struct GNUNET_MessageHeader *message)
291 {
292   struct GNUNET_MESH_ClientConnect *cc_msg;
293   struct MeshClient *c;
294   unsigned int size;
295   uint32_t *p;
296   unsigned int i;
297
298   LOG (GNUNET_ERROR_TYPE_DEBUG, "new client connected %p\n", client);
299
300   /* Check data sanity */
301   size = ntohs (message->size) - sizeof (struct GNUNET_MESH_ClientConnect);
302   cc_msg = (struct GNUNET_MESH_ClientConnect *) message;
303   if (0 != (size % sizeof (uint32_t)))
304   {
305     GNUNET_break (0);
306     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
307     return;
308   }
309   size /= sizeof (uint32_t);
310
311   /* Initialize new client structure */
312   c = GNUNET_SERVER_client_get_user_context (client, struct MeshClient);
313   LOG (GNUNET_ERROR_TYPE_DEBUG, "  client id %u\n", c->id);
314   LOG (GNUNET_ERROR_TYPE_DEBUG, "  client has %u ports\n", size);
315   if (size > 0)
316   {
317     uint32_t u32;
318
319     p = (uint32_t *) &cc_msg[1];
320     c->ports = GNUNET_CONTAINER_multihashmap32_create (size);
321     for (i = 0; i < size; i++)
322     {
323       u32 = ntohl (p[i]);
324       LOG (GNUNET_ERROR_TYPE_DEBUG, "    port: %u\n", u32);
325
326       /* store in client's hashmap */
327       GNUNET_CONTAINER_multihashmap32_put (c->ports, u32, c,
328                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
329       /* store in global hashmap */
330       /* FIXME only allow one client to have the port open,
331        *       have a backup hashmap with waiting clients */
332       GNUNET_CONTAINER_multihashmap32_put (ports, u32, c,
333                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
334     }
335   }
336
337   c->own_channels = GNUNET_CONTAINER_multihashmap32_create (32);
338   c->incoming_channels = GNUNET_CONTAINER_multihashmap32_create (32);
339   GNUNET_SERVER_notification_context_add (nc, client);
340   GNUNET_STATISTICS_update (stats, "# clients", 1, GNUNET_NO);
341
342   GNUNET_SERVER_receive_done (client, GNUNET_OK);
343   LOG (GNUNET_ERROR_TYPE_DEBUG, "new client processed\n");
344 }
345
346
347 /**
348  * Handler for requests of new tunnels
349  *
350  * @param cls Closure.
351  * @param client Identification of the client.
352  * @param message The actual message.
353  */
354 static void
355 handle_channel_create (void *cls, struct GNUNET_SERVER_Client *client,
356                        const struct GNUNET_MessageHeader *message)
357 {
358   struct MeshClient *c;
359
360   LOG (GNUNET_ERROR_TYPE_DEBUG, "new channel requested\n");
361
362   /* Sanity check for client registration */
363   if (NULL == (c = GML_client_get (client)))
364   {
365     GNUNET_break (0);
366     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
367     return;
368   }
369   LOG (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);
370
371   /* Message size sanity check */
372   if (sizeof (struct GNUNET_MESH_ChannelMessage) != ntohs (message->size))
373   {
374     GNUNET_break (0);
375     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
376     return;
377   }
378
379   if (GNUNET_OK !=
380       GMCH_handle_local_create (c,
381                                 (struct GNUNET_MESH_ChannelMessage *) message))
382   {
383     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
384     return;
385   }
386
387   GNUNET_SERVER_receive_done (client, GNUNET_OK);
388   return;
389 }
390
391
392 /**
393  * Handler for requests of deleting tunnels
394  *
395  * @param cls closure
396  * @param client identification of the client
397  * @param message the actual message
398  */
399 static void
400 handle_channel_destroy (void *cls, struct GNUNET_SERVER_Client *client,
401                         const struct GNUNET_MessageHeader *message)
402 {
403   struct GNUNET_MESH_ChannelMessage *msg;
404   struct MeshClient *c;
405   struct MeshChannel *ch;
406   MESH_ChannelNumber chid;
407
408   LOG (GNUNET_ERROR_TYPE_DEBUG,
409               "Got a DESTROY CHANNEL from client!\n");
410
411   /* Sanity check for client registration */
412   if (NULL == (c = GML_client_get (client)))
413   {
414     GNUNET_break (0);
415     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
416     return;
417   }
418   LOG (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);
419
420   /* Message sanity check */
421   if (sizeof (struct GNUNET_MESH_ChannelMessage) != ntohs (message->size))
422   {
423     GNUNET_break (0);
424     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
425     return;
426   }
427
428   msg = (struct GNUNET_MESH_ChannelMessage *) message;
429
430   /* Retrieve tunnel */
431   chid = ntohl (msg->channel_id);
432   ch = GML_channel_get (c, chid);
433   if (NULL == ch)
434   {
435     LOG (GNUNET_ERROR_TYPE_ERROR, "  channel %X not found\n", chid);
436     GNUNET_break (0);
437     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
438     return;
439   }
440
441   GMCH_handle_local_destroy (ch, c);
442
443   GNUNET_SERVER_receive_done (client, GNUNET_OK);
444   return;
445 }
446
447
448 /**
449  * Handler for client traffic
450  *
451  * @param cls closure
452  * @param client identification of the client
453  * @param message the actual message
454  */
455 static void
456 handle_data (void *cls, struct GNUNET_SERVER_Client *client,
457              const struct GNUNET_MessageHeader *message)
458 {
459   struct GNUNET_MESH_LocalData *msg;
460   struct MeshClient *c;
461   struct MeshChannel *ch;
462   MESH_ChannelNumber chid;
463   size_t size;
464   int fwd;
465
466   LOG (GNUNET_ERROR_TYPE_DEBUG,
467               "Got data from a client!\n");
468
469   /* Sanity check for client registration */
470   if (NULL == (c = GML_client_get (client)))
471   {
472     GNUNET_break (0);
473     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
474     return;
475   }
476   LOG (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);
477
478   msg = (struct GNUNET_MESH_LocalData *) message;
479
480   /* Sanity check for message size */
481   size = ntohs (message->size) - sizeof (struct GNUNET_MESH_LocalData);
482   if (size < sizeof (struct GNUNET_MessageHeader))
483   {
484     GNUNET_break (0);
485     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
486     return;
487   }
488
489   /* Channel exists? */
490   chid = ntohl (msg->id);
491   fwd = chid < GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
492   ch = GML_channel_get (c, chid);
493   if (NULL == ch)
494   {
495     GNUNET_break (0);
496     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
497     return;
498   }
499
500   if (GNUNET_OK !=
501       GMCH_handle_local_data (ch, c,
502                               (struct GNUNET_MessageHeader *)&msg[1], fwd))
503   {
504     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
505     return;
506   }
507
508   LOG (GNUNET_ERROR_TYPE_DEBUG, "receive done OK\n");
509   GNUNET_SERVER_receive_done (client, GNUNET_OK);
510
511   return;
512 }
513
514
515 /**
516  * Handler for client's ACKs for payload traffic.
517  *
518  * @param cls Closure (unused).
519  * @param client Identification of the client.
520  * @param message The actual message.
521  */
522 static void
523 handle_ack (void *cls, struct GNUNET_SERVER_Client *client,
524             const struct GNUNET_MessageHeader *message)
525 {
526   struct GNUNET_MESH_LocalAck *msg;
527   struct MeshChannel *ch;
528   struct MeshClient *c;
529   MESH_ChannelNumber chid;
530   int fwd;
531
532   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a local ACK\n");
533
534   /* Sanity check for client registration */
535   if (NULL == (c = GML_client_get (client)))
536   {
537     GNUNET_break (0);
538     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
539     return;
540   }
541   LOG (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);
542
543   msg = (struct GNUNET_MESH_LocalAck *) message;
544
545   /* Channel exists? */
546   chid = ntohl (msg->channel_id);
547   LOG (GNUNET_ERROR_TYPE_DEBUG, "  on channel %X\n", chid);
548   ch = GML_channel_get (c, chid);
549   LOG (GNUNET_ERROR_TYPE_DEBUG, "   -- ch %p\n", ch);
550   if (NULL == ch)
551   {
552     GNUNET_break (0);
553     LOG (GNUNET_ERROR_TYPE_WARNING, "Channel %X unknown.\n", chid);
554     LOG (GNUNET_ERROR_TYPE_WARNING, "  for client %u.\n", c->id);
555     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
556     return;
557   }
558
559   /* If client is root, the ACK is going FWD, therefore this is "BCK ACK". */
560   /* If client is dest, the ACK is going BCK, therefore this is "FWD ACK" */
561   fwd = chid >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
562
563   GMCH_handle_local_ack (ch, fwd);
564   GNUNET_SERVER_receive_done (client, GNUNET_OK);
565
566   return;
567 }
568
569
570 /*
571  * Iterator over all tunnels to send a monitoring client info about each tunnel.
572  *
573  * @param cls Closure (client handle).
574  * @param key Key (hashed tunnel ID, unused).
575  * @param value Tunnel info.
576  *
577  * @return #GNUNET_YES, to keep iterating.
578  */
579 // static int
580 // monitor_all_tunnels_iterator (void *cls,
581 //                               const struct GNUNET_HashCode * key,
582 //                               void *value)
583 // {
584 //   struct GNUNET_SERVER_Client *client = cls;
585 //   struct MeshChannel *ch = value;
586 //   struct GNUNET_MESH_LocalMonitor *msg;
587 //
588 //   msg = GNUNET_malloc (sizeof(struct GNUNET_MESH_LocalMonitor));
589 //   msg->channel_id = htonl (ch->gid);
590 //   msg->header.size = htons (sizeof (struct GNUNET_MESH_LocalMonitor));
591 //   msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
592 //
593 //   LOG (GNUNET_ERROR_TYPE_INFO,
594 //               "*  sending info about tunnel %s\n",
595 //               GNUNET_i2s (&msg->owner));
596 //
597 //   GNUNET_SERVER_notification_context_unicast (nc, client,
598 //                                               &msg->header, GNUNET_NO);
599 //   return GNUNET_YES;
600 // }
601
602
603 /**
604  * Handler for client's MONITOR request.
605  *
606  * @param cls Closure (unused).
607  * @param client Identification of the client.
608  * @param message The actual message.
609  */
610 static void
611 handle_get_tunnels (void *cls, struct GNUNET_SERVER_Client *client,
612                     const struct GNUNET_MessageHeader *message)
613 {
614   struct MeshClient *c;
615
616   /* Sanity check for client registration */
617   if (NULL == (c = GML_client_get (client)))
618   {
619     GNUNET_break (0);
620     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
621     return;
622   }
623
624   LOG (GNUNET_ERROR_TYPE_INFO,
625               "Received get tunnels request from client %u\n",
626               c->id);
627 //   GNUNET_CONTAINER_multihashmap_iterate (tunnels,
628 //                                          monitor_all_tunnels_iterator,
629 //                                          client);
630   LOG (GNUNET_ERROR_TYPE_INFO,
631               "Get tunnels request from client %u completed\n",
632               c->id);
633   GNUNET_SERVER_receive_done (client, GNUNET_OK);
634 }
635
636
637 /**
638  * Handler for client's MONITOR_TUNNEL request.
639  *
640  * @param cls Closure (unused).
641  * @param client Identification of the client.
642  * @param message The actual message.
643  */
644 void
645 handle_show_tunnel (void *cls, struct GNUNET_SERVER_Client *client,
646                     const struct GNUNET_MessageHeader *message)
647 {
648   const struct GNUNET_MESH_LocalMonitor *msg;
649   struct GNUNET_MESH_LocalMonitor *resp;
650   struct MeshClient *c;
651   struct MeshChannel *ch;
652
653   /* Sanity check for client registration */
654   if (NULL == (c = GML_client_get (client)))
655   {
656     GNUNET_break (0);
657     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
658     return;
659   }
660
661   msg = (struct GNUNET_MESH_LocalMonitor *) message;
662   LOG (GNUNET_ERROR_TYPE_INFO,
663               "Received tunnel info request from client %u for tunnel %s[%X]\n",
664               c->id,
665               &msg->owner,
666               ntohl (msg->channel_id));
667 //   ch = channel_get (&msg->owner, ntohl (msg->channel_id));
668   ch = NULL; // FIXME
669   if (NULL == ch)
670   {
671     /* We don't know the tunnel */
672     struct GNUNET_MESH_LocalMonitor warn;
673
674     warn = *msg;
675     GNUNET_SERVER_notification_context_unicast (nc, client,
676                                                 &warn.header,
677                                                 GNUNET_NO);
678     GNUNET_SERVER_receive_done (client, GNUNET_OK);
679     return;
680   }
681
682   /* Initialize context */
683   resp = GNUNET_malloc (sizeof (struct GNUNET_MESH_LocalMonitor));
684   *resp = *msg;
685   resp->header.size = htons (sizeof (struct GNUNET_MESH_LocalMonitor));
686   GNUNET_SERVER_notification_context_unicast (nc, c->handle,
687                                               &resp->header, GNUNET_NO);
688   GNUNET_free (resp);
689
690   LOG (GNUNET_ERROR_TYPE_INFO,
691               "Monitor tunnel request from client %u completed\n",
692               c->id);
693   GNUNET_SERVER_receive_done (client, GNUNET_OK);
694 }
695
696
697 /**
698  * Functions to handle messages from clients
699  */
700 static struct GNUNET_SERVER_MessageHandler client_handlers[] = {
701   {&handle_new_client, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT, 0},
702   {&handle_channel_create, NULL, GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE,
703    sizeof (struct GNUNET_MESH_ChannelMessage)},
704   {&handle_channel_destroy, NULL, GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY,
705    sizeof (struct GNUNET_MESH_ChannelMessage)},
706   {&handle_data, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA, 0},
707   {&handle_ack, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK,
708    sizeof (struct GNUNET_MESH_LocalAck)},
709   {&handle_get_tunnels, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS,
710    sizeof (struct GNUNET_MessageHeader)},
711   {&handle_show_tunnel, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL,
712    sizeof (struct GNUNET_MESH_LocalMonitor)},
713   {NULL, NULL, 0, 0}
714 };
715
716
717
718 /******************************************************************************/
719 /********************************    API    ***********************************/
720 /******************************************************************************/
721
722 /**
723  * Initialize server subsystem.
724  *
725  * @param handle Server handle.
726  */
727 void
728 GML_init (struct GNUNET_SERVER_Handle *handle)
729 {
730   LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
731   server_handle = handle;
732   GNUNET_SERVER_suspend (server_handle);
733   ports = GNUNET_CONTAINER_multihashmap32_create (32);
734 }
735
736
737 /**
738  * Install server (service) handlers and start listening to clients.
739  */
740 void
741 GML_start (void)
742 {
743   GNUNET_SERVER_add_handlers (server_handle, client_handlers);
744   GNUNET_SERVER_connect_notify (server_handle,  &handle_client_connect, NULL);
745   GNUNET_SERVER_disconnect_notify (server_handle, &handle_client_disconnect,
746                                    NULL);
747   nc = GNUNET_SERVER_notification_context_create (server_handle, 1);
748
749   clients_head = NULL;
750   clients_tail = NULL;
751   next_client_id = 0;
752   GNUNET_SERVER_resume (server_handle);
753 }
754
755
756 /**
757  * Shutdown server.
758  */
759 void
760 GML_shutdown (void)
761 {
762   if (nc != NULL)
763   {
764     GNUNET_SERVER_notification_context_destroy (nc);
765     nc = NULL;
766   }
767 }
768
769
770 /**
771  * Get a channel from a client.
772  *
773  * @param c Client to check.
774  * @param chid Channel ID, must be local (> 0x800...).
775  *
776  * @return non-NULL if channel exists in the clients lists
777  */
778 struct MeshChannel *
779 GML_channel_get (struct MeshClient *c, MESH_ChannelNumber chid)
780 {
781   if (0 == (chid & GNUNET_MESH_LOCAL_CHANNEL_ID_CLI))
782   {
783     GNUNET_break_op (0);
784     LOG (GNUNET_ERROR_TYPE_DEBUG, "CHID %X not a local chid\n", chid);
785     return NULL;
786   }
787   if (chid >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV)
788     return GNUNET_CONTAINER_multihashmap32_get (c->incoming_channels, chid);
789   return GNUNET_CONTAINER_multihashmap32_get (c->own_channels, chid);
790 }
791
792
793 /**
794  * Add a channel to a client
795  *
796  * @param client Client.
797  * @param chid Channel ID.
798  * @param ch Channel.
799  */
800 void
801 GML_channel_add (struct MeshClient *client,
802                  uint32_t chid,
803                  struct MeshChannel *ch)
804 {
805   if (chid >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV)
806     GNUNET_CONTAINER_multihashmap32_put (client->incoming_channels, chid, ch,
807                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
808   else if (chid >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
809     GNUNET_CONTAINER_multihashmap32_put (client->own_channels, chid, ch,
810                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
811   else
812     GNUNET_break (0);
813 }
814
815
816 /**
817  * Remove a channel from a client.
818  *
819  * @param client Client.
820  * @param chid Channel ID.
821  * @param ch Channel.
822  */
823 void
824 GML_channel_remove (struct MeshClient *client,
825                     uint32_t chid,
826                     struct MeshChannel *ch)
827 {
828   if (GNUNET_MESH_LOCAL_CHANNEL_ID_SERV <= chid)
829     GNUNET_break (GNUNET_YES ==
830                   GNUNET_CONTAINER_multihashmap32_remove (client->incoming_channels,
831                                                           chid, ch));
832   else if (GNUNET_MESH_LOCAL_CHANNEL_ID_CLI <= chid)
833     GNUNET_break (GNUNET_YES ==
834                   GNUNET_CONTAINER_multihashmap32_remove (client->own_channels,
835                                                           chid, ch));
836   else
837     GNUNET_break (0);
838 }
839
840
841 /**
842  * Get the tunnel's next free local channel ID.
843  *
844  * @param c Client.
845  *
846  * @return LID of a channel free to use.
847  */
848 MESH_ChannelNumber
849 GML_get_next_chid (struct MeshClient *c)
850 {
851   MESH_ChannelNumber chid;
852
853   while (NULL != GML_channel_get (c, c->next_chid))
854   {
855     LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", c->next_chid);
856     c->next_chid = (c->next_chid + 1) | GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
857   }
858   chid = c->next_chid;
859   c->next_chid = (c->next_chid + 1) | GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
860
861   return chid;
862 }
863
864
865 /**
866  * Check if client has registered with the service and has not disconnected
867  *
868  * @param client the client to check
869  *
870  * @return non-NULL if client exists in the global DLL
871  */
872 struct MeshClient *
873 GML_client_get (struct GNUNET_SERVER_Client *client)
874 {
875   return GNUNET_SERVER_client_get_user_context (client, struct MeshClient);
876 }
877
878 /**
879  * Find a client that has opened a port
880  *
881  * @param port Port to check.
882  *
883  * @return non-NULL if a client has the port.
884  */
885 struct MeshClient *
886 GML_client_get_by_port (uint32_t port)
887 {
888   return GNUNET_CONTAINER_multihashmap32_get (ports, port);
889 }
890
891
892 /**
893  * Deletes a channel from a client (either owner or destination).
894  *
895  * @param c Client whose tunnel to delete.
896  * @param ch Channel which should be deleted.
897  * @param id Channel ID.
898  */
899 void
900 GML_client_delete_channel (struct MeshClient *c,
901                            struct MeshChannel *ch,
902                            MESH_ChannelNumber id)
903 {
904   int res;
905
906   if (GNUNET_MESH_LOCAL_CHANNEL_ID_SERV <= id)
907   {
908     res = GNUNET_CONTAINER_multihashmap32_remove (c->incoming_channels,
909                                                   id, ch);
910     if (GNUNET_YES != res)
911       LOG (GNUNET_ERROR_TYPE_DEBUG, "client_delete_channel dest KO\n");
912   }
913   else if (GNUNET_MESH_LOCAL_CHANNEL_ID_CLI <= id)
914   {
915     res = GNUNET_CONTAINER_multihashmap32_remove (c->own_channels,
916                                                   id, ch);
917     if (GNUNET_YES != res)
918       LOG (GNUNET_ERROR_TYPE_DEBUG, "client_delete_tunnel root KO\n");
919   }
920   else
921   {
922     GNUNET_break (0);
923   }
924 }
925
926 /**
927  * Build a local ACK message and send it to a local client, if needed.
928  *
929  * If the client was already allowed to send data, do nothing.
930  *
931  * @param c Client to whom send the ACK.
932  * @param id Channel ID to use
933  */
934 void
935 GML_send_ack (struct MeshClient *c, MESH_ChannelNumber id)
936 {
937   struct GNUNET_MESH_LocalAck msg;
938
939   LOG (GNUNET_ERROR_TYPE_DEBUG,
940               "send local %s ack on %X towards %p\n",
941               id < GNUNET_MESH_LOCAL_CHANNEL_ID_SERV ? "FWD" : "BCK", id, c);
942
943   msg.header.size = htons (sizeof (msg));
944   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
945   msg.channel_id = htonl (id);
946   GNUNET_SERVER_notification_context_unicast (nc,
947                                               c->handle,
948                                               &msg.header,
949                                               GNUNET_NO);
950
951 }
952
953
954 /**
955  * Build a local channel NACK message and send it to a local client.
956  *
957  * @param c Client to whom send the NACK.
958  * @param id Channel ID to use
959  */
960 void
961 GML_send_nack (struct MeshClient *c, MESH_ChannelNumber id)
962 {
963   struct GNUNET_MESH_LocalAck msg;
964
965   LOG (GNUNET_ERROR_TYPE_DEBUG,
966               "send local nack on %X towards %p\n",
967               id, c);
968
969   msg.header.size = htons (sizeof (msg));
970   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_NACK);
971   msg.channel_id = htonl (id);
972   GNUNET_SERVER_notification_context_unicast (nc,
973                                               c->handle,
974                                               &msg.header,
975                                               GNUNET_NO);
976
977 }
978
979
980 /**
981  * Notify the client that a new incoming channel was created.
982  *
983  * @param c Client to notify.
984  * @param id Channel ID.
985  * @param port Channel's destination port.
986  * @param opt Options (bit array).
987  * @param peer Origin peer.
988  */
989 void
990 GML_send_channel_create (struct MeshClient *c,
991                          uint32_t id, uint32_t port, uint32_t opt,
992                          const struct GNUNET_PeerIdentity *peer)
993 {
994   struct GNUNET_MESH_ChannelMessage msg;
995
996   msg.header.size = htons (sizeof (msg));
997   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
998   msg.channel_id = htonl (id);
999   msg.port = htonl (port);
1000   msg.opt = htonl (opt);
1001   msg.peer = *peer;
1002   GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1003                                               &msg.header, GNUNET_NO);
1004 }
1005
1006
1007 /**
1008  * Notify a client that a channel is no longer valid.
1009  *
1010  * @param c Client.
1011  * @param id ID of the channel that is destroyed.
1012  */
1013 void
1014 GML_send_channel_destroy (struct MeshClient *c, uint32_t id)
1015 {
1016   struct GNUNET_MESH_ChannelMessage msg;
1017
1018   if (NULL == c)
1019   {
1020     GNUNET_break (0);
1021     return;
1022   }
1023   msg.header.size = htons (sizeof (msg));
1024   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1025   msg.channel_id = htonl (id);
1026   msg.port = htonl (0);
1027   memset (&msg.peer, 0, sizeof (msg.peer));
1028   msg.opt = htonl (0);
1029   GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1030                                               &msg.header, GNUNET_NO);
1031 }
1032
1033
1034 /**
1035  * Modify the mesh message ID from global to local and send to client.
1036  *
1037  * @param c Client to send to.
1038  * @param msg Message to modify and send.
1039  * @param id Channel ID to use (c can be both owner and client).
1040  */
1041 void
1042 GML_send_data (struct MeshClient *c,
1043                const struct GNUNET_MESH_Data *msg,
1044                MESH_ChannelNumber id)
1045 {
1046   struct GNUNET_MESH_LocalData *copy;
1047   uint16_t size = ntohs (msg->header.size) - sizeof (struct GNUNET_MESH_Data);
1048   char cbuf[size + sizeof (struct GNUNET_MESH_LocalData)];
1049
1050   if (size < sizeof (struct GNUNET_MessageHeader))
1051   {
1052     GNUNET_break_op (0);
1053     return;
1054   }
1055   if (NULL == c)
1056   {
1057     GNUNET_break (0);
1058     return;
1059   }
1060   copy = (struct GNUNET_MESH_LocalData *) cbuf;
1061   memcpy (&copy[1], &msg[1], size);
1062   copy->header.size = htons (sizeof (struct GNUNET_MESH_LocalData) + size);
1063   copy->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA);
1064   copy->id = htonl (id);
1065   GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1066                                               &copy->header, GNUNET_NO);
1067 }
1068
1069
1070 /**
1071  * Get the static string to represent a client.
1072  *
1073  * @param c Client.
1074  *
1075  * @return Static string for the client.
1076  */
1077 const char *
1078 GML_2s (const struct MeshClient *c)
1079 {
1080   static char buf[32];
1081
1082   sprintf (buf, "%u", c->id);
1083   return buf;
1084 }