87aa52b54c341a29e676cb424709907e44175382
[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 h Mesh handle.
607  * @param t Tunnel on which to send the ACK.
608  */
609 static void
610 send_ack (struct GNUNET_MESH_Tunnel *t)
611 {
612   struct GNUNET_MESH_LocalAck msg;
613
614   t->last_ack_sent = t->last_pid_recv + 1;
615   LOG (GNUNET_ERROR_TYPE_DEBUG,
616        "Sending ACK on tunnel %X: %u\n",
617        t->tid, t->last_ack_sent);
618   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
619   msg.header.size = htons (sizeof (msg));
620   msg.tunnel_id = htonl (t->tid);
621   msg.ack = htonl (t->last_ack_sent);
622
623 #if DEBUG_ACK
624   t->mesh->acks_sent++;
625 #endif
626
627   send_packet (t->mesh, &msg.header, t);
628   return;
629 }
630
631
632
633 /**
634  * Reconnect callback: tries to reconnect again after a failer previous
635  * reconnecttion
636  * @param cls closure (mesh handle)
637  * @param tc task context
638  */
639 static void
640 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
641
642
643 /**
644  * Send a connect packet to the service with the applications and types
645  * requested by the user.
646  *
647  * @param h The mesh handle.
648  *
649  */
650 static void
651 send_connect (struct GNUNET_MESH_Handle *h)
652 {
653   size_t size;
654
655   size = sizeof (struct GNUNET_MESH_ClientConnect);
656   size += h->n_ports * sizeof (uint32_t);
657   {
658     char buf[size] GNUNET_ALIGN;
659     struct GNUNET_MESH_ClientConnect *msg;
660     uint32_t *ports;
661     uint16_t i;
662
663     /* build connection packet */
664     msg = (struct GNUNET_MESH_ClientConnect *) buf;
665     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
666     msg->header.size = htons (size);
667     ports = (uint32_t *) &msg[1];
668     for (i = 0; i < h->n_ports; i++)
669     {
670       ports[i] = htonl (h->ports[i]);
671       LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n",
672            h->ports[i]);
673     }
674     LOG (GNUNET_ERROR_TYPE_DEBUG,
675          "Sending %lu bytes long message with %u ports\n",
676          ntohs (msg->header.size), h->n_ports);
677     send_packet (h, &msg->header, NULL);
678   }
679 }
680
681
682 /**
683  * Reconnect to the service, retransmit all infomation to try to restore the
684  * original state.
685  *
686  * @param h handle to the mesh
687  *
688  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
689  */
690 static int
691 do_reconnect (struct GNUNET_MESH_Handle *h)
692 {
693   struct GNUNET_MESH_Tunnel *t;
694
695   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
696   LOG (GNUNET_ERROR_TYPE_DEBUG, "*******   RECONNECT   *******\n");
697   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
698   LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
699   LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
700
701   /* disconnect */
702   if (NULL != h->th)
703   {
704     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
705     h->th = NULL;
706   }
707   if (NULL != h->client)
708   {
709     GNUNET_CLIENT_disconnect (h->client);
710   }
711
712   /* connect again */
713   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
714   if (h->client == NULL)
715   {
716     h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
717                                                       &reconnect_cbk, h);
718     h->reconnect_time =
719         GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
720                                   GNUNET_TIME_relative_multiply
721                                   (h->reconnect_time, 2));
722     LOG (GNUNET_ERROR_TYPE_DEBUG, 
723          "Next retry in %s\n",
724          GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
725                                                  GNUNET_NO));
726     GNUNET_break (0);
727     return GNUNET_NO;
728   }
729   else
730   {
731     h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
732   }
733   send_connect (h);
734   /* Rebuild all tunnels */
735   for (t = h->tunnels_head; NULL != t; t = t->next)
736   {
737     struct GNUNET_MESH_TunnelMessage tmsg;
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     send_packet (h, &tmsg.header, t);
756
757     if (GNUNET_NO == t->buffering)
758       GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
759
760     if (GNUNET_YES == t->reliable)
761       GNUNET_MESH_tunnel_reliable (t, GNUNET_YES);
762   }
763   return GNUNET_YES;
764 }
765
766 /**
767  * Reconnect callback: tries to reconnect again after a failer previous
768  * reconnecttion
769  * @param cls closure (mesh handle)
770  * @param tc task context
771  */
772 static void
773 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
774 {
775   struct GNUNET_MESH_Handle *h = cls;
776
777   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
778   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
779     return;
780   do_reconnect (h);
781 }
782
783
784 /**
785  * Reconnect to the service, retransmit all infomation to try to restore the
786  * original state.
787  *
788  * @param h handle to the mesh
789  *
790  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
791  */
792 static void
793 reconnect (struct GNUNET_MESH_Handle *h)
794 {
795   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
796   h->in_receive = GNUNET_NO;
797   if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
798     h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
799                                                       &reconnect_cbk, h);
800 }
801
802
803 /******************************************************************************/
804 /***********************      RECEIVE HANDLERS     ****************************/
805 /******************************************************************************/
806
807 /**
808  * Process the new tunnel notification and add it to the tunnels in the handle
809  *
810  * @param h     The mesh handle
811  * @param msg   A message with the details of the new incoming tunnel
812  */
813 static void
814 process_tunnel_created (struct GNUNET_MESH_Handle *h,
815                         const struct GNUNET_MESH_TunnelNotification *msg)
816 {
817   struct GNUNET_MESH_Tunnel *t;
818   MESH_TunnelNumber tid;
819
820   tid = ntohl (msg->tunnel_id);
821   LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
822   if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
823   {
824     GNUNET_break (0);
825     return;
826   }
827   if (NULL != h->new_tunnel)
828   {
829     t = create_tunnel (h, tid);
830     t->last_ack_sent = 0;
831     t->peer = GNUNET_PEER_intern (&msg->peer);
832     t->mesh = h;
833     t->tid = tid;
834     t->port = ntohl (msg->port);
835     if (0 != (msg->opt & MESH_TUNNEL_OPT_NOBUFFER))
836       t->buffering = GNUNET_NO;
837     else
838       t->buffering = GNUNET_YES;
839     LOG (GNUNET_ERROR_TYPE_DEBUG, "  created tunnel %p\n", t);
840     t->ctx = h->new_tunnel (h->cls, t, &msg->peer, t->port);
841     LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
842   }
843   else
844   {
845     struct GNUNET_MESH_TunnelMessage d_msg;
846
847     LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
848
849     d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
850     d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
851     d_msg.tunnel_id = msg->tunnel_id;
852
853     send_packet (h, &d_msg.header, NULL);
854   }
855   return;
856 }
857
858
859 /**
860  * Process the tunnel destroy notification and free associated resources
861  *
862  * @param h     The mesh handle
863  * @param msg   A message with the details of the tunnel being destroyed
864  */
865 static void
866 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
867                         const struct GNUNET_MESH_TunnelMessage *msg)
868 {
869   struct GNUNET_MESH_Tunnel *t;
870   MESH_TunnelNumber tid;
871
872   tid = ntohl (msg->tunnel_id);
873   t = retrieve_tunnel (h, tid);
874
875   if (NULL == t)
876   {
877     return;
878   }
879   LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
880   destroy_tunnel (t, GNUNET_YES);
881   return;
882 }
883
884
885 /**
886  * Process the incoming data packets, call appropriate handlers.
887  *
888  * @param h         The mesh handle
889  * @param message   A message encapsulating the data
890  */
891 static void
892 process_incoming_data (struct GNUNET_MESH_Handle *h,
893                        const struct GNUNET_MessageHeader *message)
894 {
895   const struct GNUNET_MessageHeader *payload;
896   const struct GNUNET_MESH_MessageHandler *handler;
897   const struct GNUNET_PeerIdentity *peer;
898   struct GNUNET_PeerIdentity id;
899   struct GNUNET_MESH_Data *dmsg;
900   struct GNUNET_MESH_Tunnel *t;
901   unsigned int i;
902   uint32_t pid;
903   uint16_t type;
904
905   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
906   type = ntohs (message->type);
907   switch (type)
908   {
909   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
910   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
911     dmsg = (struct GNUNET_MESH_Data *) message;
912
913     t = retrieve_tunnel (h, ntohl (dmsg->tid));
914     payload = (struct GNUNET_MessageHeader *) &dmsg[1];
915     GNUNET_PEER_resolve (t->peer, &id);
916     peer = &id;
917     pid = ntohl (dmsg->pid);
918     LOG (GNUNET_ERROR_TYPE_DEBUG, "  %s data on tunnel %s [%X]\n",
919          type == GNUNET_MESSAGE_TYPE_MESH_UNICAST ? "fwd" : "bck",
920          GNUNET_i2s (peer), ntohl (dmsg->tid));
921     break;
922   default:
923     GNUNET_break (0);
924     return;
925   }
926   LOG (GNUNET_ERROR_TYPE_DEBUG, "  pid %u\n", pid);
927   if (NULL == t)
928   {
929     /* Tunnel was ignored/destroyed, probably service didn't get it yet */
930     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ignored!\n");
931     return;
932   }
933   if (GNUNET_YES ==
934       GMC_is_pid_bigger(pid, t->last_ack_sent))
935   {
936     GNUNET_break (0);
937     LOG (GNUNET_ERROR_TYPE_WARNING,
938          "  unauthorized message! (%u, ACK %u)\n",
939          pid, t->last_ack_sent);
940     // FIXME fc what now? accept? reject?
941     return;
942   }
943   t->last_pid_recv = pid;
944   type = ntohs (payload->type);
945   for (i = 0; i < h->n_handlers; i++)
946   {
947     handler = &h->message_handlers[i];
948     if (handler->type == type)
949     {
950       if (GNUNET_OK !=
951           handler->callback (h->cls, t, &t->ctx, payload))
952       {
953         LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
954         GNUNET_MESH_tunnel_destroy (t);
955         return;
956       }
957       else
958       {
959         LOG (GNUNET_ERROR_TYPE_DEBUG,
960              "callback completed successfully\n");
961       }
962     }
963   }
964 }
965
966
967 /**
968  * Process a local ACK message, enabling the client to send
969  * more data to the service.
970  * 
971  * @param h Mesh handle.
972  * @param message Message itself.
973  */
974 static void
975 process_ack (struct GNUNET_MESH_Handle *h,
976              const struct GNUNET_MessageHeader *message)
977 {
978   struct GNUNET_MESH_LocalAck *msg;
979   struct GNUNET_MESH_Tunnel *t;
980   uint32_t ack;
981
982   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
983   h->acks_recv++;
984   msg = (struct GNUNET_MESH_LocalAck *) message;
985
986   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
987
988   if (NULL == t)
989   {
990     LOG (GNUNET_ERROR_TYPE_WARNING,
991          "ACK on unknown tunnel %X\n",
992          ntohl (msg->tunnel_id));
993     return;
994   }
995   ack = ntohl (msg->ack);
996   LOG (GNUNET_ERROR_TYPE_DEBUG, "  on tunnel %X, ack %u!\n", t->tid, ack);
997   if (GNUNET_YES == GMC_is_pid_bigger(ack, t->last_ack_recv))
998     t->last_ack_recv = ack;
999   else
1000     return;
1001   if (NULL == h->th && 0 < t->packet_size)
1002   {
1003     LOG (GNUNET_ERROR_TYPE_DEBUG, "  tmt rdy was NULL, requesting!\n", t->tid, ack);
1004     h->th =
1005         GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1006                                              GNUNET_TIME_UNIT_FOREVER_REL,
1007                                              GNUNET_YES, &send_callback, h);
1008   }
1009 }
1010
1011
1012 /**
1013  * Process a local reply about info on all tunnels, pass info to the user.
1014  *
1015  * @param h Mesh handle.
1016  * @param message Message itself.
1017  */
1018 static void
1019 process_get_tunnels (struct GNUNET_MESH_Handle *h,
1020                      const struct GNUNET_MessageHeader *message)
1021 {
1022   struct GNUNET_MESH_LocalMonitor *msg;
1023
1024   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Tunnels messasge received\n");
1025
1026   if (NULL == h->tunnels_cb)
1027   {
1028     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  ignored\n");
1029     return;
1030   }
1031
1032   msg = (struct GNUNET_MESH_LocalMonitor *) message;
1033   if (ntohs (message->size) !=
1034       (sizeof (struct GNUNET_MESH_LocalMonitor) +
1035        sizeof (struct GNUNET_PeerIdentity)))
1036   {
1037     GNUNET_break_op (0);
1038     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1039                 "Get tunnels message: size %hu - expected %u\n",
1040                 ntohs (message->size),
1041                 sizeof (struct GNUNET_MESH_LocalMonitor));
1042     return;
1043   }
1044   h->tunnels_cb (h->tunnels_cls,
1045                  ntohl (msg->tunnel_id),
1046                  &msg->owner,
1047                  &msg->destination);
1048 }
1049
1050
1051
1052 /**
1053  * Process a local monitor_tunnel reply, pass info to the user.
1054  *
1055  * @param h Mesh handle.
1056  * @param message Message itself.
1057  */
1058 static void
1059 process_show_tunnel (struct GNUNET_MESH_Handle *h,
1060                      const struct GNUNET_MessageHeader *message)
1061 {
1062   struct GNUNET_MESH_LocalMonitor *msg;
1063   size_t esize;
1064
1065   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Tunnel messasge received\n");
1066
1067   if (NULL == h->tunnel_cb)
1068   {
1069     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  ignored\n");
1070     return;
1071   }
1072
1073   /* Verify message sanity */
1074   msg = (struct GNUNET_MESH_LocalMonitor *) message;
1075   esize = sizeof (struct GNUNET_MESH_LocalMonitor);
1076   if (ntohs (message->size) != esize)
1077   {
1078     GNUNET_break_op (0);
1079     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1080                 "Show tunnel message: size %hu - expected %u\n",
1081                 ntohs (message->size),
1082                 esize);
1083
1084     h->tunnel_cb (h->tunnel_cls, NULL, NULL);
1085     h->tunnel_cb = NULL;
1086     h->tunnel_cls = NULL;
1087
1088     return;
1089   }
1090
1091   h->tunnel_cb (h->tunnel_cls,
1092                 &msg->destination,
1093                 &msg->owner);
1094 }
1095
1096
1097 /**
1098  * Function to process all messages received from the service
1099  *
1100  * @param cls closure
1101  * @param msg message received, NULL on timeout or fatal error
1102  */
1103 static void
1104 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1105 {
1106   struct GNUNET_MESH_Handle *h = cls;
1107
1108   if (msg == NULL)
1109   {
1110     LOG (GNUNET_ERROR_TYPE_DEBUG, 
1111          "Mesh service disconnected, reconnecting\n", h);
1112     reconnect (h);
1113     return;
1114   }
1115   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1116        GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1117   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1118        GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1119   switch (ntohs (msg->type))
1120   {
1121     /* Notify of a new incoming tunnel */
1122   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1123     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1124     break;
1125     /* Notify of a tunnel disconnection */
1126   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1127     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1128     break;
1129     /* Notify of a new data packet in the tunnel */
1130   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1131   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1132     process_incoming_data (h, msg);
1133     break;
1134   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1135     process_ack (h, msg);
1136     break;
1137   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1138         process_get_tunnels (h, msg);
1139     break;
1140   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1141         process_show_tunnel (h, msg);
1142     break;
1143   default:
1144     /* We shouldn't get any other packages, log and ignore */
1145     LOG (GNUNET_ERROR_TYPE_WARNING,
1146          "unsolicited message form service (type %s)\n",
1147          GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1148   }
1149   LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1150   if (GNUNET_YES == h->in_receive)
1151   {
1152     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1153                            GNUNET_TIME_UNIT_FOREVER_REL);
1154   }
1155   else
1156   {
1157     LOG (GNUNET_ERROR_TYPE_DEBUG,
1158          "in receive off, not calling CLIENT_receive\n");
1159   }
1160 }
1161
1162
1163 /******************************************************************************/
1164 /************************       SEND FUNCTIONS     ****************************/
1165 /******************************************************************************/
1166
1167 /**
1168  * Function called to send a message to the service.
1169  * "buf" will be NULL and "size" zero if the socket was closed for writing in
1170  * the meantime.
1171  *
1172  * @param cls closure, the mesh handle
1173  * @param size number of bytes available in buf
1174  * @param buf where the callee should write the connect message
1175  * @return number of bytes written to buf
1176  */
1177 static size_t
1178 send_callback (void *cls, size_t size, void *buf)
1179 {
1180   struct GNUNET_MESH_Handle *h = cls;
1181   struct GNUNET_MESH_TransmitHandle *th;
1182   struct GNUNET_MESH_TransmitHandle *next;
1183   struct GNUNET_MESH_Tunnel *t;
1184   char *cbuf = buf;
1185   size_t tsize;
1186   size_t psize;
1187   size_t nsize;
1188
1189   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1190   LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() Buffer %u\n", size);
1191   if ((0 == size) || (NULL == buf))
1192   {
1193     LOG (GNUNET_ERROR_TYPE_DEBUG, "# Received NULL send callback on %p\n", h);
1194     reconnect (h);
1195     h->th = NULL;
1196     return 0;
1197   }
1198   tsize = 0;
1199   next = h->th_head;
1200   nsize = message_ready_size (h);
1201   while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1202   {
1203     t = th->tunnel;
1204     if (GNUNET_YES == th_is_payload (th))
1205     {
1206       struct GNUNET_MESH_Data *dmsg;
1207       struct GNUNET_MessageHeader *mh;
1208
1209       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  payload\n");
1210       if (GNUNET_NO == GMC_is_pid_bigger (t->last_ack_recv, t->last_pid_sent))
1211       {
1212         /* This tunnel is not ready to transmit yet, try next message */
1213         next = th->next;
1214         continue;
1215       }
1216       t->packet_size = 0;
1217       GNUNET_assert (size >= th->size);
1218       dmsg = (struct GNUNET_MESH_Data *) cbuf;
1219       mh = (struct GNUNET_MessageHeader *) &dmsg[1];
1220       psize = th->notify (th->notify_cls,
1221                           size - sizeof (struct GNUNET_MESH_Data),
1222                           mh);
1223       if (psize > 0)
1224       {
1225         psize += sizeof (struct GNUNET_MESH_Data);
1226         GNUNET_assert (size >= psize);
1227         dmsg->header.size = htons (psize);
1228         dmsg->tid = htonl (t->tid);
1229         dmsg->pid = htonl (t->last_pid_sent + 1);
1230         dmsg->ttl = 0;
1231         memset (&dmsg->oid, 0, sizeof (struct GNUNET_PeerIdentity));
1232         t->last_pid_sent++;
1233       }
1234       if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1235       {
1236         dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1237         LOG (GNUNET_ERROR_TYPE_DEBUG, "#  to origin, type %s\n",
1238              GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1239       }
1240       else
1241       {
1242         dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1243         LOG (GNUNET_ERROR_TYPE_DEBUG, "#  unicast, type %s\n",
1244              GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1245       }
1246     }
1247     else
1248     {
1249       struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1250
1251       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  mesh traffic, type %s\n",
1252            GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1253       memcpy (cbuf, &th[1], th->size);
1254       psize = th->size;
1255     }
1256     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1257       GNUNET_SCHEDULER_cancel (th->timeout_task);
1258     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1259     GNUNET_free (th);
1260     next = h->th_head;
1261     nsize = message_ready_size (h);
1262     cbuf += psize;
1263     size -= psize;
1264     tsize += psize;
1265   }
1266   LOG (GNUNET_ERROR_TYPE_DEBUG, "#  total size: %u\n", tsize);
1267   h->th = NULL;
1268   size = message_ready_size (h);
1269   if (0 != size)
1270   {
1271     LOG (GNUNET_ERROR_TYPE_DEBUG, "#  next size: %u\n", size);
1272     h->th =
1273         GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1274                                              GNUNET_TIME_UNIT_FOREVER_REL,
1275                                              GNUNET_YES, &send_callback, h);
1276   }
1277   else
1278   {
1279     if (NULL != h->th_head)
1280       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  can't transmit any more\n");
1281     else
1282       LOG (GNUNET_ERROR_TYPE_DEBUG, "#  nothing left to transmit\n");
1283   }
1284   if (GNUNET_NO == h->in_receive)
1285   {
1286     LOG (GNUNET_ERROR_TYPE_DEBUG, "# start receiving from service\n");
1287     h->in_receive = GNUNET_YES;
1288     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1289                            GNUNET_TIME_UNIT_FOREVER_REL);
1290   }
1291   LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() END\n");
1292   return tsize;
1293 }
1294
1295
1296 /**
1297  * Auxiliary function to send an already constructed packet to the service.
1298  * Takes care of creating a new queue element, copying the message and
1299  * calling the tmt_rdy function if necessary.
1300  * 
1301  * @param h mesh handle
1302  * @param msg message to transmit
1303  * @param tunnel tunnel this send is related to (NULL if N/A)
1304  */
1305 static void
1306 send_packet (struct GNUNET_MESH_Handle *h,
1307              const struct GNUNET_MessageHeader *msg,
1308              struct GNUNET_MESH_Tunnel *tunnel)
1309 {
1310   struct GNUNET_MESH_TransmitHandle *th;
1311   size_t msize;
1312
1313   LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1314        GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1315   msize = ntohs (msg->size);
1316   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1317   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1318   th->size = msize;
1319   th->tunnel = tunnel;
1320   memcpy (&th[1], msg, msize);
1321   add_to_queue (h, th);
1322   LOG (GNUNET_ERROR_TYPE_DEBUG, "  queued\n");
1323   if (NULL != h->th)
1324     return;
1325   LOG (GNUNET_ERROR_TYPE_DEBUG, "  calling ntfy tmt rdy for %u bytes\n", msize);
1326   h->th =
1327       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1328                                            GNUNET_TIME_UNIT_FOREVER_REL,
1329                                            GNUNET_YES, &send_callback, h);
1330 }
1331
1332
1333 /******************************************************************************/
1334 /**********************      API CALL DEFINITIONS     *************************/
1335 /******************************************************************************/
1336
1337 struct GNUNET_MESH_Handle *
1338 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1339                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1340                      GNUNET_MESH_TunnelEndHandler cleaner,
1341                      const struct GNUNET_MESH_MessageHandler *handlers,
1342                      const uint32_t *ports)
1343 {
1344   struct GNUNET_MESH_Handle *h;
1345
1346   LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1347   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1348   LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1349   h->cfg = cfg;
1350   h->new_tunnel = new_tunnel;
1351   h->cleaner = cleaner;
1352   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1353   if (h->client == NULL)
1354   {
1355     GNUNET_break (0);
1356     GNUNET_free (h);
1357     return NULL;
1358   }
1359   h->cls = cls;
1360   h->message_handlers = handlers;
1361   h->ports = ports;
1362   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1363   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1364   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1365
1366   /* count handlers */
1367   for (h->n_handlers = 0;
1368        handlers && handlers[h->n_handlers].type;
1369        h->n_handlers++) ;
1370   for (h->n_ports = 0;
1371        ports && ports[h->n_ports];
1372        h->n_ports++) ;
1373   send_connect (h);
1374   LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1375   return h;
1376 }
1377
1378
1379 void
1380 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1381 {
1382   struct GNUNET_MESH_Tunnel *t;
1383   struct GNUNET_MESH_Tunnel *aux;
1384   struct GNUNET_MESH_TransmitHandle *th;
1385
1386   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1387
1388 #if DEBUG_ACK
1389   LOG (GNUNET_ERROR_TYPE_INFO, "Sent %d ACKs\n", handle->acks_sent);
1390   LOG (GNUNET_ERROR_TYPE_INFO, "Recv %d ACKs\n\n", handle->acks_recv);
1391 #endif
1392
1393   t = handle->tunnels_head;
1394   while (NULL != t)
1395   {
1396     aux = t->next;
1397     if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1398     {
1399       GNUNET_break (0);
1400       LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1401     }
1402     destroy_tunnel (t, GNUNET_YES);
1403     t = aux;
1404   }
1405   while ( (th = handle->th_head) != NULL)
1406   {
1407     struct GNUNET_MessageHeader *msg;
1408
1409     /* Make sure it is an allowed packet (everything else should have been
1410      * already canceled).
1411      */
1412     GNUNET_break (GNUNET_NO == th_is_payload (th));
1413     msg = (struct GNUNET_MessageHeader *) &th[1];
1414     switch (ntohs(msg->type))
1415     {
1416       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1417       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1418       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1419       case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1420         break;
1421       default:
1422         GNUNET_break (0);
1423         LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected msg %u\n",
1424              ntohs(msg->type));
1425     }
1426
1427     GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1428     GNUNET_free (th);
1429   }
1430
1431   if (NULL != handle->th)
1432   {
1433     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1434     handle->th = NULL;
1435   }
1436   if (NULL != handle->client)
1437   {
1438     GNUNET_CLIENT_disconnect (handle->client);
1439     handle->client = NULL;
1440   }
1441   if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1442   {
1443     GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1444     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1445   }
1446   GNUNET_free (handle);
1447 }
1448
1449
1450 struct GNUNET_MESH_Tunnel *
1451 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, 
1452                            void *tunnel_ctx,
1453                            const struct GNUNET_PeerIdentity *peer,
1454                            uint32_t port)
1455 {
1456   struct GNUNET_MESH_Tunnel *t;
1457   struct GNUNET_MESH_TunnelMessage msg;
1458
1459   LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1460   t = create_tunnel (h, 0);
1461   LOG (GNUNET_ERROR_TYPE_DEBUG, "  at %p\n", t);
1462   LOG (GNUNET_ERROR_TYPE_DEBUG, "  number %X\n", t->tid);
1463   t->ctx = tunnel_ctx;
1464   t->peer = GNUNET_PEER_intern (peer);
1465   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1466   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1467   msg.tunnel_id = htonl (t->tid);
1468   msg.port = htonl (port);
1469   msg.peer = *peer;
1470   t->last_ack_sent = 0;
1471   send_packet (h, &msg.header, t);
1472   return t;
1473 }
1474
1475
1476 void
1477 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1478 {
1479   struct GNUNET_MESH_Handle *h;
1480   struct GNUNET_MESH_TunnelMessage msg;
1481   struct GNUNET_MESH_TransmitHandle *th;
1482
1483   LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1484   h = tunnel->mesh;
1485
1486   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1487   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1488   msg.tunnel_id = htonl (tunnel->tid);
1489   th = h->th_head;
1490   while (th != NULL)
1491   {
1492     struct GNUNET_MESH_TransmitHandle *aux;
1493     if (th->tunnel == tunnel)
1494     {
1495       aux = th->next;
1496       /* FIXME call the handler? */
1497       if (GNUNET_YES == th_is_payload (th))
1498         th->notify (th->notify_cls, 0, NULL);
1499       GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1500       GNUNET_free (th);
1501       th = aux;
1502     }
1503     else
1504       th = th->next;
1505   }
1506
1507   destroy_tunnel (tunnel, GNUNET_YES);
1508   send_packet (h, &msg.header, NULL);
1509 }
1510
1511
1512 void
1513 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1514 {
1515   struct GNUNET_MESH_TunnelMessage msg;
1516   struct GNUNET_MESH_Handle *h;
1517
1518   h = tunnel->mesh;
1519   tunnel->buffering = buffer;
1520
1521   if (GNUNET_YES == buffer)
1522     msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1523   else
1524     msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1525   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1526   msg.tunnel_id = htonl (tunnel->tid);
1527
1528   send_packet (h, &msg.header, NULL);
1529 }
1530
1531
1532 /**
1533  * Turn on/off the reliability of the tunnel.
1534  * 
1535  * If reliability is on, mesh will resend lost messages, similar to TCP.
1536  * If reliability is off, mesh just do best effort, similar to UDP.
1537  * 
1538  * @param tunnel Tunnel affected.
1539  * @param reliable GNUNET_YES to turn reliability on, 
1540  *                 GNUNET_NO to have a best effort tunnel (default).
1541  */
1542 void
1543 GNUNET_MESH_tunnel_reliable (struct GNUNET_MESH_Tunnel *tunnel, int reliable)
1544 {
1545   struct GNUNET_MESH_TunnelMessage msg;
1546   struct GNUNET_MESH_Handle *h;
1547
1548   h = tunnel->mesh;
1549   tunnel->reliable = reliable;
1550
1551   if (GNUNET_YES == reliable)
1552     msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_RELIABLE);
1553   else
1554     msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_UNRELIABLE);
1555   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1556   msg.tunnel_id = htonl (tunnel->tid);
1557
1558   send_packet (h, &msg.header, NULL);
1559 }
1560
1561
1562 struct GNUNET_MESH_TransmitHandle *
1563 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1564                                    struct GNUNET_TIME_Relative maxdelay,
1565                                    size_t notify_size,
1566                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1567                                    void *notify_cls)
1568 {
1569   struct GNUNET_MESH_TransmitHandle *th;
1570
1571   GNUNET_assert (NULL != tunnel);
1572   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
1573   LOG (GNUNET_ERROR_TYPE_DEBUG, "    on tunnel %X\n", tunnel->tid);
1574   if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1575     LOG (GNUNET_ERROR_TYPE_DEBUG, "    to origin\n");
1576   else
1577     LOG (GNUNET_ERROR_TYPE_DEBUG, "    to destination\n");
1578   LOG (GNUNET_ERROR_TYPE_DEBUG, "    payload size %u\n", notify_size);
1579   GNUNET_assert (NULL != notify);
1580   GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1581   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1582   th->tunnel = tunnel;
1583   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1584   th->size = notify_size + sizeof (struct GNUNET_MESH_Data);
1585   tunnel->packet_size = th->size;
1586   LOG (GNUNET_ERROR_TYPE_DEBUG, "    total size %u\n", th->size);
1587   th->notify = notify;
1588   th->notify_cls = notify_cls;
1589   add_to_queue (tunnel->mesh, th);
1590   if (NULL != tunnel->mesh->th)
1591     return th;
1592   if (!GMC_is_pid_bigger (tunnel->last_ack_recv, tunnel->last_pid_sent))
1593     return th;
1594   LOG (GNUNET_ERROR_TYPE_DEBUG, "    call client notify tmt rdy\n");
1595   tunnel->mesh->th =
1596       GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1597                                            GNUNET_TIME_UNIT_FOREVER_REL,
1598                                            GNUNET_YES, &send_callback,
1599                                            tunnel->mesh);
1600   LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
1601   return th;
1602 }
1603
1604
1605 void
1606 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1607 {
1608   struct GNUNET_MESH_Handle *mesh;
1609
1610   th->tunnel->packet_size = 0;
1611   mesh = th->tunnel->mesh;
1612   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1613     GNUNET_SCHEDULER_cancel (th->timeout_task);
1614   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1615   GNUNET_free (th);
1616   if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
1617   {
1618     /* queue empty, no point in asking for transmission */
1619     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1620     mesh->th = NULL;
1621   }
1622 }
1623
1624 void
1625 GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel)
1626 {
1627   send_ack (tunnel);
1628 }
1629
1630
1631 /**
1632  * Request information about the running mesh peer.
1633  * The callback will be called for every tunnel known to the service,
1634  * listing all active peers that blong to the tunnel.
1635  *
1636  * If called again on the same handle, it will overwrite the previous
1637  * callback and cls. To retrieve the cls, monitor_cancel must be
1638  * called first.
1639  *
1640  * WARNING: unstable API, likely to change in the future!
1641  *
1642  * @param h Handle to the mesh peer.
1643  * @param callback Function to call with the requested data.
1644  * @param callback_cls Closure for @c callback.
1645  */
1646 void
1647 GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
1648                          GNUNET_MESH_TunnelsCB callback,
1649                          void *callback_cls)
1650 {
1651   struct GNUNET_MessageHeader msg;
1652
1653   msg.size = htons (sizeof (msg));
1654   msg.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
1655   send_packet (h, &msg, NULL);
1656   h->tunnels_cb = callback;
1657   h->tunnels_cls = callback_cls;
1658
1659   return;
1660 }
1661
1662
1663 /**
1664  * Cancel a monitor request. The monitor callback will not be called.
1665  *
1666  * @param h Mesh handle.
1667  *
1668  * @return Closure given to GNUNET_MESH_monitor, if any.
1669  */
1670 void *
1671 GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h)
1672 {
1673   void *cls;
1674
1675   cls = h->tunnels_cls;
1676   h->tunnels_cb = NULL;
1677   h->tunnels_cls = NULL;
1678   return cls;
1679 }
1680
1681
1682 /**
1683  * Request information about a specific tunnel of the running mesh peer.
1684  *
1685  * WARNING: unstable API, likely to change in the future!
1686  * FIXME Add destination option.
1687  *
1688  * @param h Handle to the mesh peer.
1689  * @param initiator ID of the owner of the tunnel.
1690  * @param tunnel_number Tunnel number.
1691  * @param callback Function to call with the requested data.
1692  * @param callback_cls Closure for @c callback.
1693  */
1694 void
1695 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
1696                          struct GNUNET_PeerIdentity *initiator,
1697                          unsigned int tunnel_number,
1698                          GNUNET_MESH_TunnelCB callback,
1699                          void *callback_cls)
1700 {
1701   struct GNUNET_MESH_LocalMonitor msg;
1702
1703   msg.header.size = htons (sizeof (msg));
1704   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL);
1705   msg.owner = *initiator;
1706   msg.tunnel_id = htonl (tunnel_number);
1707   msg.reserved = 0;
1708   send_packet (h, &msg.header, NULL);
1709   h->tunnel_cb = callback;
1710   h->tunnel_cls = callback_cls;
1711
1712   return;
1713 }
1714
1715
1716 /**
1717  * Function called to notify a client about the connection
1718  * begin ready to queue more data.  "buf" will be
1719  * NULL and "size" zero if the connection was closed for
1720  * writing in the meantime.
1721  *
1722  * @param cls closure
1723  * @param size number of bytes available in buf
1724  * @param buf where the callee should write the message
1725  * @return number of bytes written to buf
1726  */
1727 static size_t
1728 mesh_mq_ntr (void *cls, size_t size,
1729              void *buf)
1730 {
1731   struct GNUNET_MQ_Handle *mq = cls; 
1732   struct MeshMQState *state = GNUNET_MQ_impl_state (mq);
1733   const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
1734   uint16_t msize;
1735
1736   state->th = NULL;
1737   if (NULL == buf)
1738   {
1739     GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
1740     return 0;
1741   }
1742   msize = ntohs (msg->size);
1743   GNUNET_assert (msize <= size);
1744   memcpy (buf, msg, msize);
1745   GNUNET_MQ_impl_send_continue (mq);
1746   return msize;
1747 }
1748
1749
1750 /**
1751  * Signature of functions implementing the
1752  * sending functionality of a message queue.
1753  *
1754  * @param mq the message queue
1755  * @param msg the message to send
1756  * @param impl_state state of the implementation
1757  */
1758 static void
1759 mesh_mq_send_impl (struct GNUNET_MQ_Handle *mq,
1760                    const struct GNUNET_MessageHeader *msg, void *impl_state)
1761 {
1762   struct MeshMQState *state = impl_state;
1763
1764   GNUNET_assert (NULL == state->th);
1765   GNUNET_MQ_impl_send_commit (mq);
1766   state->th =
1767       GNUNET_MESH_notify_transmit_ready (state->tunnel,
1768                                          /* FIXME: add option for corking */
1769                                          GNUNET_NO,
1770                                          GNUNET_TIME_UNIT_FOREVER_REL, 
1771                                          ntohs (msg->size),
1772                                          mesh_mq_ntr, mq);
1773
1774 }
1775
1776
1777 /**
1778  * Signature of functions implementing the
1779  * destruction of a message queue.
1780  * Implementations must not free 'mq', but should
1781  * take care of 'impl_state'.
1782  * 
1783  * @param mq the message queue to destroy
1784  * @param impl_state state of the implementation
1785  */
1786 static void
1787 mesh_mq_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
1788 {
1789   struct MeshMQState *state = impl_state;
1790
1791   if (NULL != state->th)
1792     GNUNET_MESH_notify_transmit_ready_cancel (state->th);
1793
1794   GNUNET_free (state);
1795 }
1796
1797
1798 /**
1799  * Create a message queue for a mesh tunnel.
1800  * The message queue can only be used to transmit messages,
1801  * not to receive them.
1802  *
1803  * @param tunnel the tunnel to create the message qeue for
1804  * @return a message queue to messages over the tunnel
1805  */
1806 struct GNUNET_MQ_Handle *
1807 GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel)
1808 {
1809   struct GNUNET_MQ_Handle *mq;
1810   struct MeshMQState *state;
1811
1812   state = GNUNET_new (struct MeshMQState);
1813   state->tunnel = tunnel;
1814
1815   mq = GNUNET_MQ_queue_for_callbacks (mesh_mq_send_impl,
1816                                       mesh_mq_destroy_impl,
1817                                       NULL, /* FIXME: cancel impl. */
1818                                       state,
1819                                       NULL, /* no msg handlers */
1820                                       NULL, /* no err handlers */
1821                                       NULL); /* no handler cls */
1822   return mq;
1823 }
1824