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