b9f6bf9c2645f6998a62343928165ac338d071ee
[oweals/gnunet.git] / src / mesh / mesh_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2011 Christian Grothoff (and other contributing authors)
4      GNUnet is free software; you can redistribute it and/or modify
5      it under the terms of the GNU General Public License as published
6      by the Free Software Foundation; either version 3, or (at your
7      option) any later version.
8      GNUnet is distributed in the hope that it will be useful, but
9      WITHOUT ANY WARRANTY; without even the implied warranty of
10      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11      General Public License for more details.
12      You should have received a copy of the GNU General Public License
13      along with GNUnet; see the file COPYING.  If not, write to the
14      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
15      Boston, MA 02111-1307, USA.
16 */
17
18 /**
19  * @file mesh/mesh_api.c
20  * @brief mesh api: client implementation of new mesh service
21  * @author Bartlomiej Polot
22  *
23  * STRUCTURE:
24  * - DATA STRUCTURES
25  * - DECLARATIONS
26  * - AUXILIARY FUNCTIONS
27  * - RECEIVE HANDLERS
28  * - SEND FUNCTIONS
29  * - API CALL DEFINITIONS
30  *
31  * TODO: add regex to reconnect
32  */
33 #include "platform.h"
34 #include "gnunet_common.h"
35 #include "gnunet_client_lib.h"
36 #include "gnunet_util_lib.h"
37 #include "gnunet_peer_lib.h"
38 #include "gnunet_mesh_service.h"
39 #include "mesh.h"
40 #include "mesh_protocol.h"
41
42 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
43 #define DEBUG_ACK GNUNET_YES
44
45 /******************************************************************************/
46 /************************      DATA STRUCTURES     ****************************/
47 /******************************************************************************/
48
49 /**
50  * Transmission queue to the service
51  */
52 struct GNUNET_MESH_TransmitHandle
53 {
54
55     /**
56      * Double Linked list
57      */
58   struct GNUNET_MESH_TransmitHandle *next;
59
60     /**
61      * Double Linked list
62      */
63   struct GNUNET_MESH_TransmitHandle *prev;
64
65     /**
66      * Tunnel this message is sent on / for (may be NULL for control messages).
67      */
68   struct GNUNET_MESH_Tunnel *tunnel;
69
70     /**
71      * Callback to obtain the message to transmit, or NULL if we
72      * got the message in 'data'.  Notice that messages built
73      * by 'notify' need to be encapsulated with information about
74      * the 'target'.
75      */
76   GNUNET_CONNECTION_TransmitReadyNotify notify;
77
78     /**
79      * Closure for 'notify'
80      */
81   void *notify_cls;
82
83     /**
84      * How long is this message valid.  Once the timeout has been
85      * reached, the message must no longer be sent.  If this
86      * is a message with a 'notify' callback set, the 'notify'
87      * function should be called with 'buf' NULL and size 0.
88      */
89   struct GNUNET_TIME_Absolute timeout;
90
91     /**
92      * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
93      */
94   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
95
96     /**
97      * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
98      */
99   size_t size;
100 };
101
102
103 /**
104  * Opaque handle to the service.
105  */
106 struct GNUNET_MESH_Handle
107 {
108
109     /**
110      * Handle to the server connection, to send messages later
111      */
112   struct GNUNET_CLIENT_Connection *client;
113
114     /**
115      * Set of handlers used for processing incoming messages in the tunnels
116      */
117   const struct GNUNET_MESH_MessageHandler *message_handlers;
118
119   /**
120    * Number of handlers in the handlers array.
121    */
122   unsigned int n_handlers;
123
124   /**
125    * Ports open.
126    */
127   const uint32_t *ports;
128
129   /**
130    * Number of ports.
131    */
132   unsigned int n_ports;
133
134     /**
135      * Double linked list of the tunnels this client is connected to, head.
136      */
137   struct GNUNET_MESH_Tunnel *tunnels_head;
138
139     /**
140      * Double linked list of the tunnels this client is connected to, tail.
141      */
142   struct GNUNET_MESH_Tunnel *tunnels_tail;
143
144     /**
145      * Callback for inbound tunnel creation
146      */
147   GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
148
149     /**
150      * Callback for inbound tunnel disconnection
151      */
152   GNUNET_MESH_TunnelEndHandler *cleaner;
153
154     /**
155      * Handle to cancel pending transmissions in case of disconnection
156      */
157   struct GNUNET_CLIENT_TransmitHandle *th;
158
159     /**
160      * Closure for all the handlers given by the client
161      */
162   void *cls;
163
164     /**
165      * Messages to send to the service, head.
166      */
167   struct GNUNET_MESH_TransmitHandle *th_head;
168
169     /**
170      * Messages to send to the service, tail.
171      */
172   struct GNUNET_MESH_TransmitHandle *th_tail;
173
174     /**
175      * tid of the next tunnel to create (to avoid reusing IDs often)
176      */
177   MESH_TunnelNumber next_tid;
178
179     /**
180      * Have we started the task to receive messages from the service
181      * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
182      */
183   int in_receive;
184
185   /**
186    * Configuration given by the client, in case of reconnection
187    */
188   const struct GNUNET_CONFIGURATION_Handle *cfg;
189
190   /**
191    * Time to the next reconnect in case one reconnect fails
192    */
193   struct GNUNET_TIME_Relative reconnect_time;
194   
195   /**
196    * Task for trying to reconnect.
197    */
198   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
199
200   /**
201    * Monitor callback
202    */
203   GNUNET_MESH_TunnelsCB tunnels_cb;
204
205   /**
206    * Monitor callback closure.
207    */
208   void *tunnels_cls;
209
210   /**
211    * Tunnel callback.
212    */
213   GNUNET_MESH_TunnelCB tunnel_cb;
214
215   /**
216    * Tunnel callback closure.
217    */
218   void *tunnel_cls;
219
220 #if DEBUG_ACK
221   unsigned int acks_sent;
222   unsigned int acks_recv;
223 #endif
224 };
225
226
227 /**
228  * Description of a peer
229  */
230 struct GNUNET_MESH_Peer
231 {
232     /**
233      * ID of the peer in short form
234      */
235   GNUNET_PEER_Id id;
236
237   /**
238    * Tunnel this peer belongs to
239    */
240   struct GNUNET_MESH_Tunnel *t;
241
242   /**
243    * Flag indicating whether service has informed about its connection
244    */
245   int connected;
246
247 };
248
249
250 /**
251  * Opaque handle to a tunnel.
252  */
253 struct GNUNET_MESH_Tunnel
254 {
255
256     /**
257      * DLL next
258      */
259   struct GNUNET_MESH_Tunnel *next;
260
261     /**
262      * DLL prev
263      */
264   struct GNUNET_MESH_Tunnel *prev;
265
266     /**
267      * Handle to the mesh this tunnel belongs to
268      */
269   struct GNUNET_MESH_Handle *mesh;
270
271     /**
272      * Local ID of the tunnel
273      */
274   MESH_TunnelNumber tid;
275
276     /**
277      * Port number.
278      */
279   uint32_t port;
280
281     /**
282      * Other end of the tunnel.
283      */
284   GNUNET_PEER_Id peer;
285
286   /**
287    * Any data the caller wants to put in here
288    */
289   void *ctx;
290
291     /**
292      * Size of packet queued in this tunnel
293      */
294   unsigned int packet_size;
295
296     /**
297      * Is the tunnel allowed to buffer?
298      */
299   int buffering;
300
301     /**
302      * Is the tunnel allowed to buffer?
303      */
304   int reliable;
305
306     /**
307      * Maximum allowed PID to send (last ACK recevied).
308      */
309   uint32_t last_ack_recv;
310
311     /**
312      * Last PID received from the service.
313      */
314   uint32_t last_pid_recv;
315
316   /**
317    * Last packet ID sent to the service.
318    */
319   uint32_t last_pid_sent;
320
321   /**
322    * Last ACK value sent to the service: how much are we willing to accept?
323    */
324   uint32_t last_ack_sent;
325 };
326
327
328 /**
329  * Implementation state for mesh's message queue.
330  */
331 struct MeshMQState
332 {
333   /**
334    * The current transmit handle, or NULL
335    * if no transmit is active.
336    */
337   struct GNUNET_MESH_TransmitHandle *th;
338
339   /**
340    * Tunnel to send the data over.
341    */
342   struct GNUNET_MESH_Tunnel *tunnel;
343 };
344
345
346 /******************************************************************************/
347 /***********************         DECLARATIONS         *************************/
348 /******************************************************************************/
349
350 /**
351  * Function called to send a message to the service.
352  * "buf" will be NULL and "size" zero if the socket was closed for writing in
353  * the meantime.
354  *
355  * @param cls closure, the mesh handle
356  * @param size number of bytes available in buf
357  * @param buf where the callee should write the connect message
358  * @return number of bytes written to buf
359  */
360 static size_t
361 send_callback (void *cls, size_t size, void *buf);
362
363
364 /******************************************************************************/
365 /***********************     AUXILIARY FUNCTIONS      *************************/
366 /******************************************************************************/
367
368 /**
369  * Check if transmission is a payload packet.
370  *
371  * @param th Transmission handle.
372  *
373  * @return GNUNET_YES if it is a payload packet,
374  *         GNUNET_NO if it is a mesh management packet.
375  */
376 static int
377 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
378 {
379   return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
380 }
381
382
383 /**
384  * Check whether there is any message ready in the queue and find the size.
385  * 
386  * @param h Mesh handle.
387  * 
388  * @return The size of the first ready message in the queue,
389  *         0 if there is none.
390  */
391 static size_t
392 message_ready_size (struct GNUNET_MESH_Handle *h)
393 {
394   struct GNUNET_MESH_TransmitHandle *th;
395   struct GNUNET_MESH_Tunnel *t;
396
397   for (th = h->th_head; NULL != th; th = th->next)
398   {
399     t = th->tunnel;
400     if (GNUNET_NO == th_is_payload (th))
401     {
402       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  message internal\n");
403       return th->size;
404     }
405     if (GNUNET_YES == GMC_is_pid_bigger(t->last_ack_recv, t->last_pid_sent))
406     {
407       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  message payload ok (%u =< %u)\n",
408            t->last_pid_sent + 1, t->last_ack_recv);
409       return th->size;
410     }
411   }
412   return 0;
413 }
414
415
416 /**
417  * Get the tunnel handler for the tunnel specified by id from the given handle
418  * @param h Mesh handle
419  * @param tid ID of the wanted tunnel
420  * @return handle to the required tunnel or NULL if not found
421  */
422 static struct GNUNET_MESH_Tunnel *
423 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
424 {
425   struct GNUNET_MESH_Tunnel *t;
426
427   t = h->tunnels_head;
428   while (t != NULL)
429   {
430     if (t->tid == tid)
431       return t;
432     t = t->next;
433   }
434   return NULL;
435 }
436
437
438 /**
439  * Create a new tunnel and insert it in the tunnel list of the mesh handle
440  * @param h Mesh handle
441  * @param tid desired tid of the tunnel, 0 to assign one automatically
442  * @return handle to the created tunnel
443  */
444 static struct GNUNET_MESH_Tunnel *
445 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
446 {
447   struct GNUNET_MESH_Tunnel *t;
448
449   t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
450   GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
451   t->mesh = h;
452   if (0 == tid)
453   {
454     t->tid = h->next_tid;
455     while (NULL != retrieve_tunnel (h, h->next_tid))
456     {
457       h->next_tid++;
458       h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
459       h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
460     }
461   }
462   else
463   {
464     t->tid = tid;
465   }
466   t->last_ack_recv = (uint32_t) -1;
467   t->last_pid_recv = (uint32_t) -1;
468   t->last_ack_sent = (uint32_t) -1;
469   t->last_pid_sent = (uint32_t) -1;
470   t->buffering = GNUNET_YES;
471   return t;
472 }
473
474
475 /**
476  * Destroy the specified tunnel.
477  * - Destroys all peers, calling the disconnect callback on each if needed
478  * - Cancels all outgoing traffic for that tunnel, calling respective notifys
479  * - Calls cleaner if tunnel was inbound
480  * - Frees all memory used
481  *
482  * @param t Pointer to the tunnel.
483  * @param call_cleaner Whether to call the cleaner handler.
484  *
485  * @return Handle to the required tunnel or NULL if not found.
486  */
487 static void
488 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
489 {
490   struct GNUNET_MESH_Handle *h;
491   struct GNUNET_MESH_TransmitHandle *th;
492   struct GNUNET_MESH_TransmitHandle *next;
493
494   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
495
496   if (NULL == t)
497   {
498     GNUNET_break (0);
499     return;
500   }
501   h = t->mesh;
502
503   GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
504
505   /* signal tunnel destruction */
506   if ( (NULL != h->cleaner) && (0 != t->peer) && (GNUNET_YES == call_cleaner) )
507     h->cleaner (h->cls, t, t->ctx);
508
509   /* check that clients did not leave messages behind in the queue */
510   for (th = h->th_head; NULL != th; th = next)
511   {
512     next = th->next;
513     if (th->tunnel != t)
514       continue;
515     /* Clients should have aborted their requests already.
516      * Management traffic should be ok, as clients can't cancel that */
517     GNUNET_break (GNUNET_NO == th_is_payload(th));
518     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
519
520     /* clean up request */
521     if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
522       GNUNET_SCHEDULER_cancel (th->timeout_task);
523     GNUNET_free (th);    
524   }
525
526   /* if there are no more pending requests with mesh service, cancel active request */
527   /* Note: this should be unnecessary... */
528   if ((0 == message_ready_size (h)) && (NULL != h->th))
529   {
530     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
531     h->th = NULL;
532   }
533
534   if (0 != t->peer)
535     GNUNET_PEER_change_rc (t->peer, -1);
536   GNUNET_free (t);
537   return;
538 }
539
540
541 /**
542  * Notify client that the transmission has timed out
543  * 
544  * @param cls closure
545  * @param tc task context
546  */
547 static void
548 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
549 {
550   struct GNUNET_MESH_TransmitHandle *th = cls;
551   struct GNUNET_MESH_Handle *mesh;
552
553   mesh = th->tunnel->mesh;
554   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
555   th->tunnel->packet_size = 0;
556   if (GNUNET_YES == th_is_payload (th))
557     th->notify (th->notify_cls, 0, NULL);
558   GNUNET_free (th);
559   if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
560   {
561     /* nothing ready to transmit, no point in asking for transmission */
562     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
563     mesh->th = NULL;
564   }
565 }
566
567
568 /**
569  * Add a transmit handle to the transmission queue and set the
570  * timeout if needed.
571  *
572  * @param h mesh handle with the queue head and tail
573  * @param th handle to the packet to be transmitted
574  */
575 static void
576 add_to_queue (struct GNUNET_MESH_Handle *h,
577               struct GNUNET_MESH_TransmitHandle *th)
578 {
579   GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
580   if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
581     return;
582   th->timeout_task =
583       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
584                                     (th->timeout), &timeout_transmission, th);
585 }
586
587
588 /**
589  * Auxiliary function to send an already constructed packet to the service.
590  * Takes care of creating a new queue element, copying the message and
591  * calling the tmt_rdy function if necessary.
592  *
593  * @param h mesh handle
594  * @param msg message to transmit
595  * @param tunnel tunnel this send is related to (NULL if N/A)
596  */
597 static void
598 send_packet (struct GNUNET_MESH_Handle *h,
599              const struct GNUNET_MessageHeader *msg,
600              struct GNUNET_MESH_Tunnel *tunnel);
601
602
603 /**
604  * Send an ack on the tunnel to confirm the processing of a message.
605  * 
606  * @param t Tunnel on which to send the ACK.
607  */
608 static void
609 send_ack (struct GNUNET_MESH_Tunnel *t)
610 {
611   struct GNUNET_MESH_LocalAck msg;
612
613   t->last_ack_sent = t->last_pid_recv + 1;
614   LOG (GNUNET_ERROR_TYPE_DEBUG,
615        "Sending ACK on tunnel %X: %u\n",
616        t->tid, t->last_ack_sent);
617   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
618   msg.header.size = htons (sizeof (msg));
619   msg.tunnel_id = htonl (t->tid);
620   msg.ack = htonl (t->last_ack_sent);
621
622 #if DEBUG_ACK
623   t->mesh->acks_sent++;
624 #endif
625
626   send_packet (t->mesh, &msg.header, t);
627   return;
628 }
629
630
631
632 /**
633  * Reconnect callback: tries to reconnect again after a failer previous
634  * reconnecttion
635  * @param cls closure (mesh handle)
636  * @param tc task context
637  */
638 static void
639 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
640
641
642 /**
643  * Send a connect packet to the service with the applications and types
644  * requested by the user.
645  *
646  * @param h The mesh handle.
647  *
648  */
649 static void
650 send_connect (struct GNUNET_MESH_Handle *h)
651 {
652   size_t size;
653
654   size = sizeof (struct GNUNET_MESH_ClientConnect);
655   size += h->n_ports * sizeof (uint32_t);
656   {
657     char buf[size] GNUNET_ALIGN;
658     struct GNUNET_MESH_ClientConnect *msg;
659     uint32_t *ports;
660     uint16_t i;
661
662     /* build connection packet */
663     msg = (struct GNUNET_MESH_ClientConnect *) buf;
664     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
665     msg->header.size = htons (size);
666     ports = (uint32_t *) &msg[1];
667     for (i = 0; i < h->n_ports; i++)
668     {
669       ports[i] = htonl (h->ports[i]);
670       LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n",
671            h->ports[i]);
672     }
673     LOG (GNUNET_ERROR_TYPE_DEBUG,
674          "Sending %lu bytes long message with %u ports\n",
675          ntohs (msg->header.size), h->n_ports);
676     send_packet (h, &msg->header, NULL);
677   }
678 }
679
680
681 /**
682  * Reconnect to the service, retransmit all infomation to try to restore the
683  * original state.
684  *
685  * @param h handle to the mesh
686  *
687  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
688  */
689 static int
690 do_reconnect (struct GNUNET_MESH_Handle *h)
691 {
692   struct GNUNET_MESH_Tunnel *t;
693
694   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
695   LOG (GNUNET_ERROR_TYPE_DEBUG, "*******   RECONNECT   *******\n");
696   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
697   LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
698   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
699
700   /* disconnect */
701   if (NULL != h->th)
702   {
703     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
704     h->th = NULL;
705   }
706   if (NULL != h->client)
707   {
708     GNUNET_CLIENT_disconnect (h->client);
709   }
710
711   /* connect again */
712   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
713   if (h->client == NULL)
714   {
715     h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
716                                                       &reconnect_cbk, h);
717     h->reconnect_time =
718         GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
719                                   GNUNET_TIME_relative_multiply
720                                   (h->reconnect_time, 2));
721     LOG (GNUNET_ERROR_TYPE_DEBUG, 
722          "Next retry in %s\n",
723          GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
724                                                  GNUNET_NO));
725     GNUNET_break (0);
726     return GNUNET_NO;
727   }
728   else
729   {
730     h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
731   }
732   send_connect (h);
733   /* Rebuild all tunnels */
734   for (t = h->tunnels_head; NULL != t; t = t->next)
735   {
736     struct GNUNET_MESH_TunnelMessage tmsg;
737     uint32_t options;
738
739     if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
740     {
741       /* Tunnel was created by service (incoming tunnel) */
742       /* TODO: Notify service of missing tunnel, to request
743        * creator to recreate path (find a path to him via DHT?)
744        */
745       continue;
746     }
747     t->last_ack_sent = (uint32_t) -1;
748     t->last_pid_sent = (uint32_t) -1;
749     t->last_ack_recv = (uint32_t) -1;
750     t->last_pid_recv = (uint32_t) -1;
751     tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
752     tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
753     tmsg.tunnel_id = htonl (t->tid);
754     GNUNET_PEER_resolve (t->peer, &tmsg.peer);
755
756     options = 0;
757     if (GNUNET_NO == t->buffering)
758       options |= GNUNET_MESH_OPTION_NOBUFFER;
759
760     if (GNUNET_YES == t->reliable)
761       options |= GNUNET_MESH_OPTION_RELIABLE;
762
763     tmsg.options = htonl (options);
764     send_packet (h, &tmsg.header, t);
765   }
766   return GNUNET_YES;
767 }
768
769 /**
770  * Reconnect callback: tries to reconnect again after a failer previous
771  * reconnecttion
772  * @param cls closure (mesh handle)
773  * @param tc task context
774  */
775 static void
776 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
777 {
778   struct GNUNET_MESH_Handle *h = cls;
779
780   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
781   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
782     return;
783   do_reconnect (h);
784 }
785
786
787 /**
788  * Reconnect to the service, retransmit all infomation to try to restore the
789  * original state.
790  *
791  * @param h handle to the mesh
792  *
793  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
794  */
795 static void
796 reconnect (struct GNUNET_MESH_Handle *h)
797 {
798   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
799   h->in_receive = GNUNET_NO;
800   if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
801     h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
802                                                       &reconnect_cbk, h);
803 }
804
805
806 /******************************************************************************/
807 /***********************      RECEIVE HANDLERS     ****************************/
808 /******************************************************************************/
809
810 /**
811  * Process the new tunnel notification and add it to the tunnels in the handle
812  *
813  * @param h     The mesh handle
814  * @param msg   A message with the details of the new incoming tunnel
815  */
816 static void
817 process_tunnel_created (struct GNUNET_MESH_Handle *h,
818                         const struct GNUNET_MESH_TunnelNotification *msg)
819 {
820   struct GNUNET_MESH_Tunnel *t;
821   MESH_TunnelNumber tid;
822
823   tid = ntohl (msg->tunnel_id);
824   LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
825   if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
826   {
827     GNUNET_break (0);
828     return;
829   }
830   if (NULL != h->new_tunnel)
831   {
832     t = create_tunnel (h, tid);
833     t->last_ack_sent = 0;
834     t->peer = GNUNET_PEER_intern (&msg->peer);
835     t->mesh = h;
836     t->tid = tid;
837     t->port = ntohl (msg->port);
838     if (0 != (msg->opt & GNUNET_MESH_OPTION_NOBUFFER))
839       t->buffering = GNUNET_NO;
840     else
841       t->buffering = GNUNET_YES;
842     if (0 != (msg->opt & GNUNET_MESH_OPTION_RELIABLE))
843       t->reliable = GNUNET_YES;
844     else
845       t->reliable = GNUNET_NO;
846     LOG (GNUNET_ERROR_TYPE_DEBUG, "  created tunnel %p\n", t);
847     t->ctx = h->new_tunnel (h->cls, t, &msg->peer, t->port);
848     LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
849   }
850   else
851   {
852     struct GNUNET_MESH_TunnelMessage d_msg;
853
854     LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
855
856     d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
857     d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
858     d_msg.tunnel_id = msg->tunnel_id;
859
860     send_packet (h, &d_msg.header, NULL);
861   }
862   return;
863 }
864
865
866 /**
867  * Process the tunnel destroy notification and free associated resources
868  *
869  * @param h     The mesh handle
870  * @param msg   A message with the details of the tunnel being destroyed
871  */
872 static void
873 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
874                         const struct GNUNET_MESH_TunnelMessage *msg)
875 {
876   struct GNUNET_MESH_Tunnel *t;
877   MESH_TunnelNumber tid;
878
879   tid = ntohl (msg->tunnel_id);
880   t = retrieve_tunnel (h, tid);
881
882   if (NULL == t)
883   {
884     return;
885   }
886   LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
887   destroy_tunnel (t, GNUNET_YES);
888   return;
889 }
890
891
892 /**
893  * Process the incoming data packets, call appropriate handlers.
894  *
895  * @param h         The mesh handle
896  * @param message   A message encapsulating the data
897  */
898 static void
899 process_incoming_data (struct GNUNET_MESH_Handle *h,
900                        const struct GNUNET_MessageHeader *message)
901 {
902   const struct GNUNET_MessageHeader *payload;
903   const struct GNUNET_MESH_MessageHandler *handler;
904   const struct GNUNET_PeerIdentity *peer;
905   struct GNUNET_PeerIdentity id;
906   struct GNUNET_MESH_Data *dmsg;
907   struct GNUNET_MESH_Tunnel *t;
908   unsigned int i;
909   uint32_t pid;
910   uint16_t type;
911
912   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
913   type = ntohs (message->type);
914   switch (type)
915   {
916   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
917   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
918     dmsg = (struct GNUNET_MESH_Data *) message;
919
920     t = retrieve_tunnel (h, ntohl (dmsg->tid));
921     payload = (struct GNUNET_MessageHeader *) &dmsg[1];
922     GNUNET_PEER_resolve (t->peer, &id);
923     peer = &id;
924     pid = ntohl (dmsg->pid);
925     LOG (GNUNET_ERROR_TYPE_DEBUG, "  %s data on tunnel %s [%X]\n",
926          type == GNUNET_MESSAGE_TYPE_MESH_UNICAST ? "fwd" : "bck",
927          GNUNET_i2s (peer), ntohl (dmsg->tid));
928     break;
929   default:
930     GNUNET_break (0);
931     return;
932   }
933   LOG (GNUNET_ERROR_TYPE_DEBUG, "  pid %u\n", pid);
934   if (NULL == t)
935   {
936     /* Tunnel was ignored/destroyed, probably service didn't get it yet */
937     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ignored!\n");
938     return;
939   }
940   if (GNUNET_YES ==
941       GMC_is_pid_bigger(pid, t->last_ack_sent))
942   {
943     GNUNET_break (0);
944     LOG (GNUNET_ERROR_TYPE_WARNING,
945          "  unauthorized message! (%u, ACK %u)\n",
946          pid, t->last_ack_sent);
947     // FIXME fc what now? accept? reject?
948     return;
949   }
950   t->last_pid_recv = pid;
951   type = ntohs (payload->type);
952   for (i = 0; i < h->n_handlers; i++)
953   {
954     handler = &h->message_handlers[i];
955     if (handler->type == type)
956     {
957       if (GNUNET_OK !=
958           handler->callback (h->cls, t, &t->ctx, payload))
959       {
960         LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
961         GNUNET_MESH_tunnel_destroy (t);
962         return;
963       }
964       else
965       {
966         LOG (GNUNET_ERROR_TYPE_DEBUG,
967              "callback completed successfully\n");
968       }
969     }
970   }
971 }
972
973
974 /**
975  * Process a local ACK message, enabling the client to send
976  * more data to the service.
977  * 
978  * @param h Mesh handle.
979  * @param message Message itself.
980  */
981 static void
982 process_ack (struct GNUNET_MESH_Handle *h,
983              const struct GNUNET_MessageHeader *message)
984 {
985   struct GNUNET_MESH_LocalAck *msg;
986   struct GNUNET_MESH_Tunnel *t;
987   MESH_TunnelNumber tid;
988   uint32_t ack;
989
990   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
991   h->acks_recv++;
992   msg = (struct GNUNET_MESH_LocalAck *) message;
993   tid = ntohl (msg->tunnel_id);
994   t = retrieve_tunnel (h, tid);
995   if (NULL == t)
996   {
997     LOG (GNUNET_ERROR_TYPE_WARNING, "ACK on unknown tunnel %X\n", tid);
998     return;
999   }
1000   ack = ntohl (msg->ack);
1001   LOG (GNUNET_ERROR_TYPE_DEBUG, "  on tunnel %X, ack %u!\n", t->tid, ack);
1002   if (GNUNET_YES == GMC_is_pid_bigger(ack, t->last_ack_recv))
1003     t->last_ack_recv = ack;
1004   else
1005     return;
1006   if (NULL == h->th && 0 < t->packet_size)
1007   {
1008     LOG (GNUNET_ERROR_TYPE_DEBUG, "  tmt rdy was NULL, requesting!\n", t->tid, ack);
1009     h->th =
1010         GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1011                                              GNUNET_TIME_UNIT_FOREVER_REL,
1012                                              GNUNET_YES, &send_callback, h);
1013   }
1014 }
1015
1016
1017 /**
1018  * Process a local reply about info on all tunnels, pass info to the user.
1019  *
1020  * @param h Mesh handle.
1021  * @param message Message itself.
1022  */
1023 static void
1024 process_get_tunnels (struct GNUNET_MESH_Handle *h,
1025                      const struct GNUNET_MessageHeader *message)
1026 {
1027   struct GNUNET_MESH_LocalMonitor *msg;
1028
1029   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Tunnels messasge received\n");
1030
1031   if (NULL == h->tunnels_cb)
1032   {
1033     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  ignored\n");
1034     return;
1035   }
1036
1037   msg = (struct GNUNET_MESH_LocalMonitor *) message;
1038   if (ntohs (message->size) !=
1039       (sizeof (struct GNUNET_MESH_LocalMonitor) +
1040        sizeof (struct GNUNET_PeerIdentity)))
1041   {
1042     GNUNET_break_op (0);
1043     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1044                 "Get tunnels message: size %hu - expected %u\n",
1045                 ntohs (message->size),
1046                 sizeof (struct GNUNET_MESH_LocalMonitor));
1047     return;
1048   }
1049   h->tunnels_cb (h->tunnels_cls,
1050                  ntohl (msg->tunnel_id),
1051                  &msg->owner,
1052                  &msg->destination);
1053 }
1054
1055
1056
1057 /**
1058  * Process a local monitor_tunnel reply, pass info to the user.
1059  *
1060  * @param h Mesh handle.
1061  * @param message Message itself.
1062  */
1063 static void
1064 process_show_tunnel (struct GNUNET_MESH_Handle *h,
1065                      const struct GNUNET_MessageHeader *message)
1066 {
1067   struct GNUNET_MESH_LocalMonitor *msg;
1068   size_t esize;
1069
1070   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Tunnel messasge received\n");
1071
1072   if (NULL == h->tunnel_cb)
1073   {
1074     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  ignored\n");
1075     return;
1076   }
1077
1078   /* Verify message sanity */
1079   msg = (struct GNUNET_MESH_LocalMonitor *) message;
1080   esize = sizeof (struct GNUNET_MESH_LocalMonitor);
1081   if (ntohs (message->size) != esize)
1082   {
1083     GNUNET_break_op (0);
1084     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1085                 "Show tunnel message: size %hu - expected %u\n",
1086                 ntohs (message->size),
1087                 esize);
1088
1089     h->tunnel_cb (h->tunnel_cls, NULL, NULL);
1090     h->tunnel_cb = NULL;
1091     h->tunnel_cls = NULL;
1092
1093     return;
1094   }
1095
1096   h->tunnel_cb (h->tunnel_cls,
1097                 &msg->destination,
1098                 &msg->owner);
1099 }
1100
1101
1102 /**
1103  * Function to process all messages received from the service
1104  *
1105  * @param cls closure
1106  * @param msg message received, NULL on timeout or fatal error
1107  */
1108 static void
1109 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1110 {
1111   struct GNUNET_MESH_Handle *h = cls;
1112
1113   if (msg == NULL)
1114   {
1115     LOG (GNUNET_ERROR_TYPE_DEBUG, 
1116          "Mesh service disconnected, reconnecting\n", h);
1117     reconnect (h);
1118     return;
1119   }
1120   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1121        GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1122   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1123        GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1124   switch (ntohs (msg->type))
1125   {
1126     /* Notify of a new incoming tunnel */
1127   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1128     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1129     break;
1130     /* Notify of a tunnel disconnection */
1131   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1132     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1133     break;
1134     /* Notify of a new data packet in the tunnel */
1135   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1136   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1137     process_incoming_data (h, msg);
1138     break;
1139   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1140     process_ack (h, msg);
1141     break;
1142   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1143     process_get_tunnels (h, msg);
1144     break;
1145   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1146     process_show_tunnel (h, msg);
1147     break;
1148   default:
1149     /* We shouldn't get any other packages, log and ignore */
1150     LOG (GNUNET_ERROR_TYPE_WARNING,
1151          "unsolicited message form service (type %s)\n",
1152          GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1153   }
1154   LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1155   if (GNUNET_YES == h->in_receive)
1156   {
1157     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1158                            GNUNET_TIME_UNIT_FOREVER_REL);
1159   }
1160   else
1161   {
1162     LOG (GNUNET_ERROR_TYPE_DEBUG,
1163          "in receive off, not calling CLIENT_receive\n");
1164   }
1165 }
1166
1167
1168 /******************************************************************************/
1169 /************************       SEND FUNCTIONS     ****************************/
1170 /******************************************************************************/
1171
1172 /**
1173  * Function called to send a message to the service.
1174  * "buf" will be NULL and "size" zero if the socket was closed for writing in
1175  * the meantime.
1176  *
1177  * @param cls closure, the mesh handle
1178  * @param size number of bytes available in buf
1179  * @param buf where the callee should write the connect message
1180  * @return number of bytes written to buf
1181  */
1182 static size_t
1183 send_callback (void *cls, size_t size, void *buf)
1184 {
1185   struct GNUNET_MESH_Handle *h = cls;
1186   struct GNUNET_MESH_TransmitHandle *th;
1187   struct GNUNET_MESH_TransmitHandle *next;
1188   struct GNUNET_MESH_Tunnel *t;
1189   char *cbuf = buf;
1190   size_t tsize;
1191   size_t psize;
1192   size_t nsize;
1193
1194   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1195   LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() Buffer %u\n", size);
1196   if ((0 == size) || (NULL == buf))
1197   {
1198     LOG (GNUNET_ERROR_TYPE_DEBUG, "# Received NULL send callback on %p\n", h);
1199     reconnect (h);
1200     h->th = NULL;
1201     return 0;
1202   }
1203   tsize = 0;
1204   next = h->th_head;
1205   nsize = message_ready_size (h);
1206   while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1207   {
1208     t = th->tunnel;
1209     if (GNUNET_YES == th_is_payload (th))
1210     {
1211       struct GNUNET_MESH_Data *dmsg;
1212       struct GNUNET_MessageHeader *mh;
1213
1214       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  payload\n");
1215       if (GNUNET_NO == GMC_is_pid_bigger (t->last_ack_recv, t->last_pid_sent))
1216       {
1217         /* This tunnel is not ready to transmit yet, try next message */
1218         next = th->next;
1219         continue;
1220       }
1221       t->packet_size = 0;
1222       GNUNET_assert (size >= th->size);
1223       dmsg = (struct GNUNET_MESH_Data *) cbuf;
1224       mh = (struct GNUNET_MessageHeader *) &dmsg[1];
1225       psize = th->notify (th->notify_cls,
1226                           size - sizeof (struct GNUNET_MESH_Data),
1227                           mh);
1228       if (psize > 0)
1229       {
1230         psize += sizeof (struct GNUNET_MESH_Data);
1231         GNUNET_assert (size >= psize);
1232         dmsg->header.size = htons (psize);
1233         dmsg->tid = htonl (t->tid);
1234         dmsg->pid = htonl (t->last_pid_sent + 1);
1235         dmsg->ttl = 0;
1236         memset (&dmsg->oid, 0, sizeof (struct GNUNET_PeerIdentity));
1237         t->last_pid_sent++;
1238       }
1239       if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1240       {
1241         dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1242         LOG (GNUNET_ERROR_TYPE_DEBUG, "#  to origin, type %s\n",
1243              GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1244       }
1245       else
1246       {
1247         dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1248         LOG (GNUNET_ERROR_TYPE_DEBUG, "#  unicast, type %s\n",
1249              GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1250       }
1251     }
1252     else
1253     {
1254       struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1255
1256       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  mesh traffic, type %s\n",
1257            GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1258       memcpy (cbuf, &th[1], th->size);
1259       psize = th->size;
1260     }
1261     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1262       GNUNET_SCHEDULER_cancel (th->timeout_task);
1263     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1264     GNUNET_free (th);
1265     next = h->th_head;
1266     nsize = message_ready_size (h);
1267     cbuf += psize;
1268     size -= psize;
1269     tsize += psize;
1270   }
1271   LOG (GNUNET_ERROR_TYPE_DEBUG, "#  total size: %u\n", tsize);
1272   h->th = NULL;
1273   size = message_ready_size (h);
1274   if (0 != size)
1275   {
1276     LOG (GNUNET_ERROR_TYPE_DEBUG, "#  next size: %u\n", size);
1277     h->th =
1278         GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1279                                              GNUNET_TIME_UNIT_FOREVER_REL,
1280                                              GNUNET_YES, &send_callback, h);
1281   }
1282   else
1283   {
1284     if (NULL != h->th_head)
1285       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  can't transmit any more\n");
1286     else
1287       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  nothing left to transmit\n");
1288   }
1289   if (GNUNET_NO == h->in_receive)
1290   {
1291     LOG (GNUNET_ERROR_TYPE_DEBUG, "# start receiving from service\n");
1292     h->in_receive = GNUNET_YES;
1293     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1294                            GNUNET_TIME_UNIT_FOREVER_REL);
1295   }
1296   LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() END\n");
1297   return tsize;
1298 }
1299
1300
1301 /**
1302  * Auxiliary function to send an already constructed packet to the service.
1303  * Takes care of creating a new queue element, copying the message and
1304  * calling the tmt_rdy function if necessary.
1305  * 
1306  * @param h mesh handle
1307  * @param msg message to transmit
1308  * @param tunnel tunnel this send is related to (NULL if N/A)
1309  */
1310 static void
1311 send_packet (struct GNUNET_MESH_Handle *h,
1312              const struct GNUNET_MessageHeader *msg,
1313              struct GNUNET_MESH_Tunnel *tunnel)
1314 {
1315   struct GNUNET_MESH_TransmitHandle *th;
1316   size_t msize;
1317
1318   LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1319        GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1320   msize = ntohs (msg->size);
1321   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1322   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1323   th->size = msize;
1324   th->tunnel = tunnel;
1325   memcpy (&th[1], msg, msize);
1326   add_to_queue (h, th);
1327   LOG (GNUNET_ERROR_TYPE_DEBUG, "  queued\n");
1328   if (NULL != h->th)
1329     return;
1330   LOG (GNUNET_ERROR_TYPE_DEBUG, "  calling ntfy tmt rdy for %u bytes\n", msize);
1331   h->th =
1332       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1333                                            GNUNET_TIME_UNIT_FOREVER_REL,
1334                                            GNUNET_YES, &send_callback, h);
1335 }
1336
1337
1338 /******************************************************************************/
1339 /**********************      API CALL DEFINITIONS     *************************/
1340 /******************************************************************************/
1341
1342 struct GNUNET_MESH_Handle *
1343 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1344                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1345                      GNUNET_MESH_TunnelEndHandler cleaner,
1346                      const struct GNUNET_MESH_MessageHandler *handlers,
1347                      const uint32_t *ports)
1348 {
1349   struct GNUNET_MESH_Handle *h;
1350
1351   LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1352   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1353   LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1354   h->cfg = cfg;
1355   h->new_tunnel = new_tunnel;
1356   h->cleaner = cleaner;
1357   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1358   if (h->client == NULL)
1359   {
1360     GNUNET_break (0);
1361     GNUNET_free (h);
1362     return NULL;
1363   }
1364   h->cls = cls;
1365   h->message_handlers = handlers;
1366   h->ports = ports;
1367   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1368   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1369   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1370
1371   /* count handlers */
1372   for (h->n_handlers = 0;
1373        handlers && handlers[h->n_handlers].type;
1374        h->n_handlers++) ;
1375   for (h->n_ports = 0;
1376        ports && ports[h->n_ports];
1377        h->n_ports++) ;
1378   send_connect (h);
1379   LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1380   return h;
1381 }
1382
1383
1384 void
1385 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1386 {
1387   struct GNUNET_MESH_Tunnel *t;
1388   struct GNUNET_MESH_Tunnel *aux;
1389   struct GNUNET_MESH_TransmitHandle *th;
1390
1391   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1392
1393 #if DEBUG_ACK
1394   LOG (GNUNET_ERROR_TYPE_INFO, "Sent %d ACKs\n", handle->acks_sent);
1395   LOG (GNUNET_ERROR_TYPE_INFO, "Recv %d ACKs\n\n", handle->acks_recv);
1396 #endif
1397
1398   t = handle->tunnels_head;
1399   while (NULL != t)
1400   {
1401     aux = t->next;
1402     if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1403     {
1404       GNUNET_break (0);
1405       LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1406     }
1407     destroy_tunnel (t, GNUNET_YES);
1408     t = aux;
1409   }
1410   while ( (th = handle->th_head) != NULL)
1411   {
1412     struct GNUNET_MessageHeader *msg;
1413
1414     /* Make sure it is an allowed packet (everything else should have been
1415      * already canceled).
1416      */
1417     GNUNET_break (GNUNET_NO == th_is_payload (th));
1418     msg = (struct GNUNET_MessageHeader *) &th[1];
1419     switch (ntohs(msg->type))
1420     {
1421       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1422       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1423       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1424       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1425         break;
1426       default:
1427         GNUNET_break (0);
1428         LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected msg %u\n",
1429              ntohs(msg->type));
1430     }
1431
1432     GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1433     GNUNET_free (th);
1434   }
1435
1436   if (NULL != handle->th)
1437   {
1438     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1439     handle->th = NULL;
1440   }
1441   if (NULL != handle->client)
1442   {
1443     GNUNET_CLIENT_disconnect (handle->client);
1444     handle->client = NULL;
1445   }
1446   if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1447   {
1448     GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1449     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1450   }
1451   GNUNET_free (handle);
1452 }
1453
1454
1455 /**
1456  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1457  * and to broadcast).
1458  *
1459  * @param h mesh handle
1460  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1461  * @param peer peer identity the tunnel should go to
1462  * @param port Port number.
1463  * @param buffer Flag for buffering on relay nodes.
1464  * @param reliable Flag for end-to-end reliability.
1465  *
1466  * @return handle to the tunnel
1467  */
1468 struct GNUNET_MESH_Tunnel *
1469 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, 
1470                            void *tunnel_ctx,
1471                            const struct GNUNET_PeerIdentity *peer,
1472                            uint32_t port,
1473                            int buffer,
1474                            int reliable)
1475 {
1476   struct GNUNET_MESH_Tunnel *t;
1477   struct GNUNET_MESH_TunnelMessage msg;
1478
1479   LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1480   t = create_tunnel (h, 0);
1481   LOG (GNUNET_ERROR_TYPE_DEBUG, "  at %p\n", t);
1482   LOG (GNUNET_ERROR_TYPE_DEBUG, "  number %X\n", t->tid);
1483   t->ctx = tunnel_ctx;
1484   t->peer = GNUNET_PEER_intern (peer);
1485   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1486   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1487   msg.tunnel_id = htonl (t->tid);
1488   msg.port = htonl (port);
1489   msg.peer = *peer;
1490   t->last_ack_sent = 0;
1491   send_packet (h, &msg.header, t);
1492   return t;
1493 }
1494
1495
1496 void
1497 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1498 {
1499   struct GNUNET_MESH_Handle *h;
1500   struct GNUNET_MESH_TunnelMessage msg;
1501   struct GNUNET_MESH_TransmitHandle *th;
1502
1503   LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1504   h = tunnel->mesh;
1505
1506   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1507   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1508   msg.tunnel_id = htonl (tunnel->tid);
1509   th = h->th_head;
1510   while (th != NULL)
1511   {
1512     struct GNUNET_MESH_TransmitHandle *aux;
1513     if (th->tunnel == tunnel)
1514     {
1515       aux = th->next;
1516       /* FIXME call the handler? */
1517       if (GNUNET_YES == th_is_payload (th))
1518         th->notify (th->notify_cls, 0, NULL);
1519       GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1520       GNUNET_free (th);
1521       th = aux;
1522     }
1523     else
1524       th = th->next;
1525   }
1526
1527   destroy_tunnel (tunnel, GNUNET_YES);
1528   send_packet (h, &msg.header, NULL);
1529 }
1530
1531
1532 /**
1533  * Get information about a tunnel.
1534  * 
1535  * The existing end callback for the tunnel will be called immediately.
1536  * Any pending outgoing messages will be sent but no incoming messages will be
1537  * accepted and no data callbacks will be called.
1538  *
1539  * @param tunnel Tunnel handle.
1540  * 
1541  * @return Allocated, {0, NULL} terminated set of tunnel properties.
1542  */
1543 struct MeshTunnelInfo *
1544 GNUNET_MESH_tunnel_get_info (struct GNUNET_MESH_Tunnel *tunnel)
1545 {
1546   struct MeshTunnelInfo *ret;
1547
1548   ret = GNUNET_malloc (sizeof (struct MeshTunnelInfo) * 3);
1549   ret[0].prop = GNUNET_MESH_OPTION_NOBUFFER;
1550   ret[0].value = &tunnel->buffering; // FIXME return ¬buffering ("nobuffer")
1551   ret[1].prop = GNUNET_MESH_OPTION_RELIABLE;
1552   ret[1].value = &tunnel->reliable;
1553   ret[2].prop = 0;
1554   ret[2].value = NULL;
1555
1556   return ret;
1557 }
1558
1559 struct GNUNET_MESH_TransmitHandle *
1560 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1561                                    struct GNUNET_TIME_Relative maxdelay,
1562                                    size_t notify_size,
1563                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1564                                    void *notify_cls)
1565 {
1566   struct GNUNET_MESH_TransmitHandle *th;
1567
1568   GNUNET_assert (NULL != tunnel);
1569   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
1570   LOG (GNUNET_ERROR_TYPE_DEBUG, "    on tunnel %X\n", tunnel->tid);
1571   if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1572     LOG (GNUNET_ERROR_TYPE_DEBUG, "    to origin\n");
1573   else
1574     LOG (GNUNET_ERROR_TYPE_DEBUG, "    to destination\n");
1575   LOG (GNUNET_ERROR_TYPE_DEBUG, "    payload size %u\n", notify_size);
1576   GNUNET_assert (NULL != notify);
1577   GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1578   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1579   th->tunnel = tunnel;
1580   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1581   th->size = notify_size + sizeof (struct GNUNET_MESH_Data);
1582   tunnel->packet_size = th->size;
1583   LOG (GNUNET_ERROR_TYPE_DEBUG, "    total size %u\n", th->size);
1584   th->notify = notify;
1585   th->notify_cls = notify_cls;
1586   add_to_queue (tunnel->mesh, th);
1587   if (NULL != tunnel->mesh->th)
1588     return th;
1589   if (!GMC_is_pid_bigger (tunnel->last_ack_recv, tunnel->last_pid_sent))
1590     return th;
1591   LOG (GNUNET_ERROR_TYPE_DEBUG, "    call client notify tmt rdy\n");
1592   tunnel->mesh->th =
1593       GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1594                                            GNUNET_TIME_UNIT_FOREVER_REL,
1595                                            GNUNET_YES, &send_callback,
1596                                            tunnel->mesh);
1597   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
1598   return th;
1599 }
1600
1601
1602 void
1603 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1604 {
1605   struct GNUNET_MESH_Handle *mesh;
1606
1607   th->tunnel->packet_size = 0;
1608   mesh = th->tunnel->mesh;
1609   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1610     GNUNET_SCHEDULER_cancel (th->timeout_task);
1611   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1612   GNUNET_free (th);
1613   if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
1614   {
1615     /* queue empty, no point in asking for transmission */
1616     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1617     mesh->th = NULL;
1618   }
1619 }
1620
1621 void
1622 GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel)
1623 {
1624   send_ack (tunnel);
1625 }
1626
1627
1628 /**
1629  * Request information about the running mesh peer.
1630  * The callback will be called for every tunnel known to the service,
1631  * listing all active peers that blong to the tunnel.
1632  *
1633  * If called again on the same handle, it will overwrite the previous
1634  * callback and cls. To retrieve the cls, monitor_cancel must be
1635  * called first.
1636  *
1637  * WARNING: unstable API, likely to change in the future!
1638  *
1639  * @param h Handle to the mesh peer.
1640  * @param callback Function to call with the requested data.
1641  * @param callback_cls Closure for @c callback.
1642  */
1643 void
1644 GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
1645                          GNUNET_MESH_TunnelsCB callback,
1646                          void *callback_cls)
1647 {
1648   struct GNUNET_MessageHeader msg;
1649
1650   msg.size = htons (sizeof (msg));
1651   msg.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
1652   send_packet (h, &msg, NULL);
1653   h->tunnels_cb = callback;
1654   h->tunnels_cls = callback_cls;
1655
1656   return;
1657 }
1658
1659
1660 /**
1661  * Cancel a monitor request. The monitor callback will not be called.
1662  *
1663  * @param h Mesh handle.
1664  *
1665  * @return Closure given to GNUNET_MESH_monitor, if any.
1666  */
1667 void *
1668 GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h)
1669 {
1670   void *cls;
1671
1672   cls = h->tunnels_cls;
1673   h->tunnels_cb = NULL;
1674   h->tunnels_cls = NULL;
1675   return cls;
1676 }
1677
1678
1679 /**
1680  * Request information about a specific tunnel of the running mesh peer.
1681  *
1682  * WARNING: unstable API, likely to change in the future!
1683  * FIXME Add destination option.
1684  *
1685  * @param h Handle to the mesh peer.
1686  * @param initiator ID of the owner of the tunnel.
1687  * @param tunnel_number Tunnel number.
1688  * @param callback Function to call with the requested data.
1689  * @param callback_cls Closure for @c callback.
1690  */
1691 void
1692 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
1693                          struct GNUNET_PeerIdentity *initiator,
1694                          unsigned int tunnel_number,
1695                          GNUNET_MESH_TunnelCB callback,
1696                          void *callback_cls)
1697 {
1698   struct GNUNET_MESH_LocalMonitor msg;
1699
1700   msg.header.size = htons (sizeof (msg));
1701   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL);
1702   msg.owner = *initiator;
1703   msg.tunnel_id = htonl (tunnel_number);
1704   msg.reserved = 0;
1705   send_packet (h, &msg.header, NULL);
1706   h->tunnel_cb = callback;
1707   h->tunnel_cls = callback_cls;
1708
1709   return;
1710 }
1711
1712
1713 /**
1714  * Function called to notify a client about the connection
1715  * begin ready to queue more data.  "buf" will be
1716  * NULL and "size" zero if the connection was closed for
1717  * writing in the meantime.
1718  *
1719  * @param cls closure
1720  * @param size number of bytes available in buf
1721  * @param buf where the callee should write the message
1722  * @return number of bytes written to buf
1723  */
1724 static size_t
1725 mesh_mq_ntr (void *cls, size_t size,
1726              void *buf)
1727 {
1728   struct GNUNET_MQ_Handle *mq = cls; 
1729   struct MeshMQState *state = GNUNET_MQ_impl_state (mq);
1730   const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
1731   uint16_t msize;
1732
1733   state->th = NULL;
1734   if (NULL == buf)
1735   {
1736     GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
1737     return 0;
1738   }
1739   msize = ntohs (msg->size);
1740   GNUNET_assert (msize <= size);
1741   memcpy (buf, msg, msize);
1742   GNUNET_MQ_impl_send_continue (mq);
1743   return msize;
1744 }
1745
1746
1747 /**
1748  * Signature of functions implementing the
1749  * sending functionality of a message queue.
1750  *
1751  * @param mq the message queue
1752  * @param msg the message to send
1753  * @param impl_state state of the implementation
1754  */
1755 static void
1756 mesh_mq_send_impl (struct GNUNET_MQ_Handle *mq,
1757                    const struct GNUNET_MessageHeader *msg, void *impl_state)
1758 {
1759   struct MeshMQState *state = impl_state;
1760
1761   GNUNET_assert (NULL == state->th);
1762   GNUNET_MQ_impl_send_commit (mq);
1763   state->th =
1764       GNUNET_MESH_notify_transmit_ready (state->tunnel,
1765                                          /* FIXME: add option for corking */
1766                                          GNUNET_NO,
1767                                          GNUNET_TIME_UNIT_FOREVER_REL, 
1768                                          ntohs (msg->size),
1769                                          mesh_mq_ntr, mq);
1770
1771 }
1772
1773
1774 /**
1775  * Signature of functions implementing the
1776  * destruction of a message queue.
1777  * Implementations must not free 'mq', but should
1778  * take care of 'impl_state'.
1779  * 
1780  * @param mq the message queue to destroy
1781  * @param impl_state state of the implementation
1782  */
1783 static void
1784 mesh_mq_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
1785 {
1786   struct MeshMQState *state = impl_state;
1787
1788   if (NULL != state->th)
1789     GNUNET_MESH_notify_transmit_ready_cancel (state->th);
1790
1791   GNUNET_free (state);
1792 }
1793
1794
1795 /**
1796  * Create a message queue for a mesh tunnel.
1797  * The message queue can only be used to transmit messages,
1798  * not to receive them.
1799  *
1800  * @param tunnel the tunnel to create the message qeue for
1801  * @return a message queue to messages over the tunnel
1802  */
1803 struct GNUNET_MQ_Handle *
1804 GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel)
1805 {
1806   struct GNUNET_MQ_Handle *mq;
1807   struct MeshMQState *state;
1808
1809   state = GNUNET_new (struct MeshMQState);
1810   state->tunnel = tunnel;
1811
1812   mq = GNUNET_MQ_queue_for_callbacks (mesh_mq_send_impl,
1813                                       mesh_mq_destroy_impl,
1814                                       NULL, /* FIXME: cancel impl. */
1815                                       state,
1816                                       NULL, /* no msg handlers */
1817                                       NULL, /* no err handlers */
1818                                       NULL); /* no handler cls */
1819   return mq;
1820 }
1821