Added more debug info
[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 mesh service
21  * @author Bartlomiej Polot
22  *
23  * STRUCTURE:
24  * - CONSTANTS
25  * - DATA STRUCTURES
26  * - AUXILIARY FUNCTIONS
27  * - RECEIVE HANDLERS
28  * - SEND FUNCTIONS
29  * - API CALL DEFINITIONS
30  */
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #if 0                           /* keep Emacsens' auto-indent happy */
35 }
36 #endif
37 #endif
38
39 #include "platform.h"
40 #include "gnunet_common.h"
41 #include "gnunet_client_lib.h"
42 #include "gnunet_util_lib.h"
43 #include "gnunet_peer_lib.h"
44 #include "gnunet_mesh_service.h"
45 #include "mesh.h"
46 #include "mesh_protocol.h"
47
48 #define MESH_API_DEBUG GNUNET_YES
49
50 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
51
52 /******************************************************************************/
53 /************************      DATA STRUCTURES     ****************************/
54 /******************************************************************************/
55
56 /**
57  * Transmission queue to the service
58  */
59 struct GNUNET_MESH_TransmitHandle
60 {
61
62     /**
63      * Double Linked list
64      */
65   struct GNUNET_MESH_TransmitHandle *next;
66
67     /**
68      * Double Linked list
69      */
70   struct GNUNET_MESH_TransmitHandle *prev;
71
72     /**
73      * Tunnel this message is sent over (may be NULL for control messages).
74      */
75   struct GNUNET_MESH_Tunnel *tunnel;
76
77     /**
78      * Callback to obtain the message to transmit, or NULL if we
79      * got the message in 'data'.  Notice that messages built
80      * by 'notify' need to be encapsulated with information about
81      * the 'target'.
82      */
83   GNUNET_CONNECTION_TransmitReadyNotify notify;
84
85     /**
86      * Closure for 'notify'
87      */
88   void *notify_cls;
89
90     /**
91      * How long is this message valid.  Once the timeout has been
92      * reached, the message must no longer be sent.  If this
93      * is a message with a 'notify' callback set, the 'notify'
94      * function should be called with 'buf' NULL and size 0.
95      */
96   struct GNUNET_TIME_Absolute timeout;
97
98     /**
99      * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
100      */
101   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
102
103     /**
104      * Priority of the message.  The queue is sorted by priority,
105      * control messages have the maximum priority (UINT32_MAX).
106      */
107   uint32_t priority;
108
109     /**
110      * Target of the message, 0 for multicast.  This field
111      * is only valid if 'notify' is non-NULL.
112      */
113   GNUNET_PEER_Id target;
114
115     /**
116      * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
117      */
118   size_t size;
119 };
120
121
122 /**
123  * Opaque handle to the service.
124  */
125 struct GNUNET_MESH_Handle
126 {
127
128     /**
129      * Handle to the server connection, to send messages later
130      */
131   struct GNUNET_CLIENT_Connection *client;
132
133     /**
134      * Set of handlers used for processing incoming messages in the tunnels
135      */
136   const struct GNUNET_MESH_MessageHandler *message_handlers;
137
138     /**
139      * Set of applications that should be claimed to be offered at this node.
140      * Note that this is just informative, the appropiate handlers must be
141      * registered independently and the mapping is up to the developer of the
142      * client application.
143      */
144   const GNUNET_MESH_ApplicationType *applications;
145
146     /**
147      * Double linked list of the tunnels this client is connected to.
148      */
149   struct GNUNET_MESH_Tunnel *tunnels_head;
150   struct GNUNET_MESH_Tunnel *tunnels_tail;
151
152     /**
153      * Callback for inbound tunnel creation
154      */
155   GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
156
157     /**
158      * Callback for inbound tunnel disconnection
159      */
160   GNUNET_MESH_TunnelEndHandler *cleaner;
161
162     /**
163      * Handle to cancel pending transmissions in case of disconnection
164      */
165   struct GNUNET_CLIENT_TransmitHandle *th;
166
167     /**
168      * Closure for all the handlers given by the client
169      */
170   void *cls;
171
172     /**
173      * Messages to send to the service
174      */
175   struct GNUNET_MESH_TransmitHandle *th_head;
176   struct GNUNET_MESH_TransmitHandle *th_tail;
177
178     /**
179      * tid of the next tunnel to create (to avoid reusing IDs often)
180      */
181   MESH_TunnelNumber next_tid;
182   unsigned int n_handlers;
183   unsigned int n_applications;
184   unsigned int max_queue_size;
185
186     /**
187      * Have we started the task to receive messages from the service
188      * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
189      */
190   int in_receive;
191
192     /**
193      * Number of packets queued
194      */
195   unsigned int npackets;
196
197   /**
198    * Configuration given by the client, in case of reconnection
199    */
200   const struct GNUNET_CONFIGURATION_Handle *cfg;
201
202   /**
203    * Time to the next reconnect in case one reconnect fails
204    */
205   struct GNUNET_TIME_Relative reconnect_time;
206 };
207
208
209 /**
210  * Description of a peer
211  */
212 struct GNUNET_MESH_Peer
213 {
214     /**
215      * ID of the peer in short form
216      */
217   GNUNET_PEER_Id id;
218
219   /**
220    * Tunnel this peer belongs to
221    */
222   struct GNUNET_MESH_Tunnel *t;
223
224   /**
225    * Flag indicating whether service has informed about its connection
226    */
227   int connected;
228
229 };
230
231
232 /**
233  * Opaque handle to a tunnel.
234  */
235 struct GNUNET_MESH_Tunnel
236 {
237
238     /**
239      * DLL
240      */
241   struct GNUNET_MESH_Tunnel *next;
242   struct GNUNET_MESH_Tunnel *prev;
243
244     /**
245      * Callback to execute when peers connect to the tunnel
246      */
247   GNUNET_MESH_PeerConnectHandler connect_handler;
248
249     /**
250      * Callback to execute when peers disconnect from the tunnel
251      */
252   GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
253
254     /**
255      * Closure for the connect/disconnect handlers
256      */
257   void *cls;
258
259     /**
260      * Handle to the mesh this tunnel belongs to
261      */
262   struct GNUNET_MESH_Handle *mesh;
263
264     /**
265      * Local ID of the tunnel
266      */
267   MESH_TunnelNumber tid;
268
269     /**
270      * Owner of the tunnel. 0 if the tunnel is the local client.
271      */
272   GNUNET_PEER_Id owner;
273
274     /**
275      * All peers added to the tunnel
276      */
277   struct GNUNET_MESH_Peer **peers;
278
279   /**
280    * List of application types that have been requested for this tunnel
281    */
282   GNUNET_MESH_ApplicationType *apps;
283
284   /**
285    * Any data the caller wants to put in here
286    */
287   void *ctx;
288
289   /**
290      * Number of peers added to the tunnel
291      */
292   unsigned int npeers;
293
294     /**
295      * Number of packets queued in this tunnel
296      */
297   unsigned int npackets;
298
299     /**
300      * Number of applications requested this tunnel
301      */
302   unsigned int napps;
303
304 };
305
306
307 /******************************************************************************/
308 /***********************     AUXILIARY FUNCTIONS      *************************/
309 /******************************************************************************/
310
311 /**
312  * Get the tunnel handler for the tunnel specified by id from the given handle
313  * @param h Mesh handle
314  * @param tid ID of the wanted tunnel
315  * @return handle to the required tunnel or NULL if not found
316  */
317 static struct GNUNET_MESH_Tunnel *
318 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
319 {
320   struct GNUNET_MESH_Tunnel *t;
321
322   t = h->tunnels_head;
323   while (t != NULL)
324   {
325     if (t->tid == tid)
326       return t;
327     t = t->next;
328   }
329   return NULL;
330 }
331
332
333 /**
334  * Create a new tunnel and insert it in the tunnel list of the mesh handle
335  * @param h Mesh handle
336  * @param tid desired tid of the tunnel, 0 to assign one automatically
337  * @return handle to the created tunnel
338  */
339 static struct GNUNET_MESH_Tunnel *
340 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
341 {
342   struct GNUNET_MESH_Tunnel *t;
343
344   t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
345   GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
346   t->mesh = h;
347   if (0 == tid)
348   {
349     t->tid = h->next_tid;
350     while (NULL != retrieve_tunnel (h, h->next_tid))
351     {
352       h->next_tid++;
353       h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
354       h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
355     }
356   }
357   else
358   {
359     t->tid = tid;
360   }
361   return t;
362 }
363
364
365 /**
366  * Destroy the specified tunnel.
367  * - Destroys all peers, calling the disconnect callback on each if needed
368  * - Cancels all outgoing traffic for that tunnel, calling respective notifys
369  * - Calls cleaner if tunnel was inbound
370  * - Frees all memory used
371  *
372  * @param t Pointer to the tunnel.
373  *
374  * @return Handle to the required tunnel or NULL if not found.
375  */
376 static void
377 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
378 {
379   struct GNUNET_MESH_Handle *h;
380   struct GNUNET_PeerIdentity pi;
381   struct GNUNET_MESH_TransmitHandle *th;
382   struct GNUNET_MESH_TransmitHandle *aux;
383   unsigned int i;
384
385   if (NULL == t)
386   {
387     GNUNET_break (0);
388     return;
389   }
390   h = t->mesh;
391   th = h->th_head;
392   while (NULL != th)
393   {
394     if (th->tunnel == t)
395     {
396       aux = th->next;
397       GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
398       if (NULL == h->th_head && NULL != h->th)
399       {
400         GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
401         h->th = NULL;
402       }
403       if (NULL != th->notify)
404         th->notify (th->notify_cls, 0, NULL);
405       if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
406         GNUNET_SCHEDULER_cancel (th->timeout_task);
407       GNUNET_free (th);
408       th = aux;
409     }
410     else
411     {
412       th = th->next;
413     }
414   }
415   GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
416   for (i = 0; i < t->npeers; i++)
417   {
418     if (NULL != t->disconnect_handler && t->peers[i]->connected)
419     {
420       GNUNET_PEER_resolve (t->peers[i]->id, &pi);
421       t->disconnect_handler (t->cls, &pi);
422     }
423     GNUNET_PEER_change_rc (t->peers[i]->id, -1);
424     GNUNET_free (t->peers[i]);
425   }
426   if (t->npeers > 0)
427     GNUNET_free (t->peers);
428   if (NULL != h->cleaner && 0 != t->owner)
429     h->cleaner (h->cls, t, t->ctx);
430   if (0 != t->owner)
431     GNUNET_PEER_change_rc (t->owner, -1);
432   if (0 != t->napps && t->apps)
433     GNUNET_free (t->apps);
434   GNUNET_free (t);
435   return;
436 }
437
438
439 /**
440  * Get the peer descriptor for the peer with id from the given tunnel
441  * @param t Tunnel handle
442  * @param id Short form ID of the wanted peer
443  * @return handle to the requested peer or NULL if not found
444  */
445 static struct GNUNET_MESH_Peer *
446 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
447 {
448   unsigned int i;
449
450   for (i = 0; i < t->npeers; i++)
451     if (t->peers[i]->id == id)
452       return t->peers[i];
453   return NULL;
454 }
455
456
457 /**
458  * Add a peer into a tunnel
459  * @param t Tunnel handle
460  * @param pi Full ID of the new peer
461  * @return handle to the newly created peer
462  */
463 static struct GNUNET_MESH_Peer *
464 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
465                     const struct GNUNET_PeerIdentity *pi)
466 {
467   struct GNUNET_MESH_Peer *p;
468   GNUNET_PEER_Id id;
469
470   if (0 != t->owner)
471   {
472     GNUNET_break (0);
473     return NULL;
474   }
475   id = GNUNET_PEER_intern (pi);
476
477   p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
478   p->id = id;
479   p->t = t;
480   GNUNET_array_append (t->peers, t->npeers, p);
481   return p;
482 }
483
484
485 /**
486  * Remove a peer from a tunnel
487  * @param p Peer handle
488  */
489 static void
490 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
491 {
492   unsigned int i;
493
494   for (i = 0; i < p->t->npeers; i++)
495   {
496     if (p->t->peers[i] == p)
497       break;
498   }
499   if (i == p->t->npeers)
500   {
501     GNUNET_break (0);
502     return;
503   }
504   p->t->peers[i] = p->t->peers[p->t->npeers - 1];
505   GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
506 }
507
508
509 /**
510  * Notify client that the transmission has timed out
511  * @param cls closure
512  * @param tc task context
513  */
514 static void
515 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
516 {
517   struct GNUNET_MESH_TransmitHandle *th = cls;
518   struct GNUNET_MESH_Handle *mesh;
519
520   mesh = th->tunnel->mesh;
521   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
522   if (th->notify != NULL)
523     th->notify (th->notify_cls, 0, NULL);
524   GNUNET_free (th);
525   if ((NULL == mesh->th_head) && (NULL != mesh->th))
526   {
527     /* queue empty, no point in asking for transmission */
528     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
529     mesh->th = NULL;
530   }
531 }
532
533
534 /**
535  * Add a transmit handle to the transmission queue by priority and set the
536  * timeout if needed.
537  *
538  * @param h mesh handle with the queue head and tail
539  * @param th handle to the packet to be transmitted
540  */
541 static void
542 add_to_queue (struct GNUNET_MESH_Handle *h,
543               struct GNUNET_MESH_TransmitHandle *th)
544 {
545   struct GNUNET_MESH_TransmitHandle *p;
546
547   p = h->th_head;
548   while ((NULL != p) && (th->priority <= p->priority))
549     p = p->next;
550   if (NULL == p)
551     p = h->th_tail;
552   else
553     p = p->prev;
554   GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
555   if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
556     return;
557   th->timeout_task =
558       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
559                                     (th->timeout), &timeout_transmission, th);
560 }
561
562
563 /**
564  * Auxiliary function to send an already constructed packet to the service.
565  * Takes care of creating a new queue element, copying the message and
566  * calling the tmt_rdy function if necessary.
567  * @param h mesh handle
568  * @param msg message to transmit
569  */
570 static void
571 send_packet (struct GNUNET_MESH_Handle *h,
572              const struct GNUNET_MessageHeader *msg);
573
574
575 /**
576  * Reconnect callback: tries to reconnect again after a failer previous
577  * reconnecttion
578  * @param cls closure (mesh handle)
579  * @param tc task context
580  */
581 static void
582 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
583
584
585 /**
586  * Send a connect packet to the service with the applications and types
587  * requested by the user.
588  *
589  * @param h The mesh handle.
590  *
591  */
592 static void
593 send_connect (struct GNUNET_MESH_Handle *h)
594 {
595   size_t size;
596
597   size = sizeof (struct GNUNET_MESH_ClientConnect);
598   size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
599   size += h->n_handlers * sizeof (uint16_t);
600   {
601     char buf[size];
602     struct GNUNET_MESH_ClientConnect *msg;
603     GNUNET_MESH_ApplicationType *apps;
604     uint16_t napps;
605     uint16_t *types;
606     uint16_t ntypes;
607
608     /* build connection packet */
609     msg = (struct GNUNET_MESH_ClientConnect *) buf;
610     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
611     msg->header.size = htons (size);
612     apps = (GNUNET_MESH_ApplicationType *) &msg[1];
613     for (napps = 0; napps < h->n_applications; napps++)
614     {
615       apps[napps] = htonl (h->applications[napps]);
616       LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:  app %u\n", h->applications[napps]);
617     }
618     types = (uint16_t *) & apps[napps];
619     for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
620       types[ntypes] = htons (h->message_handlers[ntypes].type);
621     msg->applications = htons (napps);
622     msg->types = htons (ntypes);
623 #if MESH_API_DEBUG
624     LOG (GNUNET_ERROR_TYPE_DEBUG,
625          "mesh: Sending %lu bytes long message %d types and %d apps\n",
626          ntohs (msg->header.size), ntypes, napps);
627 #endif
628     send_packet (h, &msg->header);
629   }
630 }
631
632
633 /**
634  * Reconnect to the service, retransmit all infomation to try to restore the
635  * original state.
636  *
637  * @param h handle to the mesh
638  *
639  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
640  */
641 static int
642 reconnect (struct GNUNET_MESH_Handle *h)
643 {
644   struct GNUNET_MESH_Tunnel *t;
645   unsigned int i;
646
647 #if MESH_API_DEBUG
648   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
649   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *******   RECONNECT   *******\n");
650   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
651 #endif
652   h->in_receive = GNUNET_NO;
653   /* disconnect */
654   if (NULL != h->th)
655   {
656     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
657   }
658   if (NULL != h->client)
659   {
660     GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
661   }
662
663   /* connect again */
664   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
665   if (h->client == NULL)
666   {
667     GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
668     h->reconnect_time =
669         GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
670                                   GNUNET_TIME_relative_multiply
671                                   (h->reconnect_time, 2));
672     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   Next retry in %sms\n",
673          GNUNET_TIME_relative_to_string (h->reconnect_time));
674     GNUNET_break (0);
675     return GNUNET_NO;
676   }
677   else
678   {
679     h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
680   }
681   send_connect (h);
682   /* Rebuild all tunnels */
683   for (t = h->tunnels_head; NULL != t; t = t->next)
684   {
685     struct GNUNET_MESH_TunnelMessage tmsg;
686     struct GNUNET_MESH_PeerControl pmsg;
687
688     if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
689     {
690       /* Tunnel was created by service (incoming tunnel) */
691       /* TODO: Notify service of missing tunnel, to request
692        * creator to recreate path (find a path to him via DHT?)
693        */
694       continue;
695     }
696     tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
697     tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
698     tmsg.tunnel_id = htonl (t->tid);
699     send_packet (h, &tmsg.header);
700
701     pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
702     pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
703     pmsg.tunnel_id = htonl (t->tid);
704
705     /* Reconnect all peers */
706     for (i = 0; i < t->npeers; i++)
707     {
708       GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
709       if (NULL != t->disconnect_handler && t->peers[i]->connected)
710         t->disconnect_handler (t->cls, &pmsg.peer);
711       /* If the tunnel was "by type", dont connect individual peers */
712       if (0 == t->napps)
713         send_packet (t->mesh, &pmsg.header);
714     }
715     /* Reconnect all types, if any  */
716     for (i = 0; i < t->napps; i++)
717     {
718       struct GNUNET_MESH_ConnectPeerByType msg;
719
720       msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
721       msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
722       msg.tunnel_id = htonl (t->tid);
723       msg.type = htonl (t->apps[i]);
724       send_packet (t->mesh, &msg.header);
725     }
726   }
727   return GNUNET_YES;
728 }
729
730 /**
731  * Reconnect callback: tries to reconnect again after a failer previous
732  * reconnecttion
733  * @param cls closure (mesh handle)
734  * @param tc task context
735  */
736 static void
737 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
738 {
739   struct GNUNET_MESH_Handle *h = cls;
740
741   if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
742     return;
743   reconnect (h);
744 }
745
746
747 /******************************************************************************/
748 /***********************      RECEIVE HANDLERS     ****************************/
749 /******************************************************************************/
750
751 /**
752  * Process the new tunnel notification and add it to the tunnels in the handle
753  *
754  * @param h     The mesh handle
755  * @param msg   A message with the details of the new incoming tunnel
756  */
757 static void
758 process_tunnel_created (struct GNUNET_MESH_Handle *h,
759                         const struct GNUNET_MESH_TunnelNotification *msg)
760 {
761   struct GNUNET_MESH_Tunnel *t;
762   MESH_TunnelNumber tid;
763
764   tid = ntohl (msg->tunnel_id);
765   if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
766   {
767     GNUNET_break (0);
768     return;
769   }
770   t = create_tunnel (h, tid);
771   t->owner = GNUNET_PEER_intern (&msg->peer);
772   t->npeers = 1;
773   t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
774   t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
775   t->peers[0]->t = t;
776   t->peers[0]->connected = 1;
777   t->peers[0]->id = t->owner;
778   GNUNET_PEER_change_rc (t->owner, 1);
779   t->mesh = h;
780   t->tid = tid;
781   if (NULL != h->new_tunnel)
782   {
783     struct GNUNET_ATS_Information atsi;
784
785     atsi.type = 0;
786     atsi.value = 0;
787     t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
788   }
789 #if MESH_API_DEBUG
790   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: new incoming tunnel %X\n",
791               t->tid);
792 #endif
793   return;
794 }
795
796
797 /**
798  * Process the tunnel destroy notification and free associated resources
799  *
800  * @param h     The mesh handle
801  * @param msg   A message with the details of the tunnel being destroyed
802  */
803 static void
804 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
805                         const struct GNUNET_MESH_TunnelMessage *msg)
806 {
807   struct GNUNET_MESH_Tunnel *t;
808   MESH_TunnelNumber tid;
809
810   tid = ntohl (msg->tunnel_id);
811   t = retrieve_tunnel (h, tid);
812
813   if (NULL == t)
814   {
815     return;
816   }
817   if (0 == t->owner)
818   {
819     GNUNET_break (0);
820   }
821 #if MESH_API_DEBUG
822   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: tunnel %u destroyed\n", t->tid);
823 #endif
824   destroy_tunnel (t);
825   return;
826 }
827
828
829 /**
830  * Process the new peer event and notify the upper level of it
831  *
832  * @param h     The mesh handle
833  * @param msg   A message with the details of the peer event
834  */
835 static void
836 process_peer_event (struct GNUNET_MESH_Handle *h,
837                     const struct GNUNET_MESH_PeerControl *msg)
838 {
839   struct GNUNET_MESH_Tunnel *t;
840   struct GNUNET_MESH_Peer *p;
841   struct GNUNET_ATS_Information atsi;
842   GNUNET_PEER_Id id;
843   uint16_t size;
844
845   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
846   size = ntohs (msg->header.size);
847   if (size != sizeof (struct GNUNET_MESH_PeerControl))
848   {
849     GNUNET_break (0);
850     return;
851   }
852   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
853   if (NULL == t)
854   {
855     GNUNET_break (0);
856     return;
857   }
858   id = GNUNET_PEER_search (&msg->peer);
859   if ((p = retrieve_peer (t, id)) == NULL)
860     p = add_peer_to_tunnel (t, &msg->peer);
861   if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
862   {
863     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
864     if (NULL != t->connect_handler)
865     {
866       atsi.type = 0;
867       atsi.value = 0;
868       t->connect_handler (t->cls, &msg->peer, &atsi);
869     }
870     p->connected = 1;
871   }
872   else
873   {
874     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
875     if (NULL != t->disconnect_handler && p->connected)
876     {
877       t->disconnect_handler (t->cls, &msg->peer);
878     }
879     remove_peer_from_tunnel (p);
880     GNUNET_free (p);
881   }
882   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
883 }
884
885
886 /**
887  * Process the incoming data packets
888  *
889  * @param h         The mesh handle
890  * @param message   A message encapsulating the data
891  */
892 static void
893 process_incoming_data (struct GNUNET_MESH_Handle *h,
894                        const struct GNUNET_MessageHeader *message)
895 {
896   const struct GNUNET_MessageHeader *payload;
897   const struct GNUNET_MESH_MessageHandler *handler;
898   const struct GNUNET_PeerIdentity *peer;
899   struct GNUNET_MESH_Unicast *ucast;
900   struct GNUNET_MESH_Multicast *mcast;
901   struct GNUNET_MESH_ToOrigin *to_orig;
902   struct GNUNET_MESH_Tunnel *t;
903   unsigned int i;
904   uint16_t type;
905
906   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
907   type = ntohs (message->type);
908   switch (type)
909   {
910   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
911     ucast = (struct GNUNET_MESH_Unicast *) message;
912
913     t = retrieve_tunnel (h, ntohl (ucast->tid));
914     payload = (struct GNUNET_MessageHeader *) &ucast[1];
915     peer = &ucast->oid;
916     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   ucast on tunnel %s [%x]\n",
917                 GNUNET_i2s (peer), ntohl (ucast->tid));
918     break;
919   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
920     mcast = (struct GNUNET_MESH_Multicast *) message;
921     t = retrieve_tunnel (h, ntohl (mcast->tid));
922     payload = (struct GNUNET_MessageHeader *) &mcast[1];
923     peer = &mcast->oid;
924     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   mcast on tunnel %s [%x]\n",
925                 GNUNET_i2s (peer), ntohl (mcast->tid));
926     break;
927   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
928     to_orig = (struct GNUNET_MESH_ToOrigin *) message;
929     t = retrieve_tunnel (h, ntohl (to_orig->tid));
930     payload = (struct GNUNET_MessageHeader *) &to_orig[1];
931     peer = &to_orig->sender;
932     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   reply on tunnel %s [%x]\n",
933                 GNUNET_i2s (peer), ntohl (to_orig->tid));
934     break;
935   default:
936     GNUNET_break (0);
937     return;
938   }
939   if (NULL == t)
940   {
941     GNUNET_break (0);
942     return;
943   }
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       struct GNUNET_ATS_Information atsi;
951
952       atsi.type = 0;
953       atsi.value = 0;
954       if (GNUNET_OK !=
955           handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
956       {
957         LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
958         GNUNET_MESH_disconnect (h);
959         return;
960       }
961 #if MESH_API_DEBUG
962       else
963       {
964         LOG (GNUNET_ERROR_TYPE_DEBUG,
965              "MESH: callback completed successfully\n");
966
967       }
968 #endif
969     }
970   }
971 }
972
973
974 /**
975  * Function to process all messages received from the service
976  *
977  * @param cls closure
978  * @param msg message received, NULL on timeout or fatal error
979  */
980 static void
981 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
982 {
983   struct GNUNET_MESH_Handle *h = cls;
984
985   if (msg == NULL)
986   {
987     reconnect (h);
988     return;
989   }
990   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
991        ntohs (msg->type));
992   switch (ntohs (msg->type))
993   {
994     /* Notify of a new incoming tunnel */
995   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
996     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
997     break;
998     /* Notify of a tunnel disconnection */
999   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1000     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1001     break;
1002     /* Notify of a new peer or a peer disconnect in the tunnel */
1003   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1004   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1005     process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1006     break;
1007     /* Notify of a new data packet in the tunnel */
1008   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1009   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1010   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1011     process_incoming_data (h, msg);
1012     break;
1013     /* We shouldn't get any other packages, log and ignore */
1014   default:
1015     LOG (GNUNET_ERROR_TYPE_WARNING,
1016          "MESH: unsolicited message form service (type %d)\n",
1017          ntohs (msg->type));
1018   }
1019   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1020   GNUNET_CLIENT_receive (h->client, &msg_received, h,
1021                          GNUNET_TIME_UNIT_FOREVER_REL);
1022 }
1023
1024
1025 /******************************************************************************/
1026 /************************       SEND FUNCTIONS     ****************************/
1027 /******************************************************************************/
1028
1029 /**
1030  * Function called to send a message to the service.
1031  * "buf" will be NULL and "size" zero if the socket was closed for writing in
1032  * the meantime.
1033  *
1034  * @param cls closure, the mesh handle
1035  * @param size number of bytes available in buf
1036  * @param buf where the callee should write the connect message
1037  * @return number of bytes written to buf
1038  */
1039 static size_t
1040 send_callback (void *cls, size_t size, void *buf)
1041 {
1042   struct GNUNET_MESH_Handle *h = cls;
1043   struct GNUNET_MESH_TransmitHandle *th;
1044   char *cbuf = buf;
1045   size_t tsize;
1046   size_t psize;
1047
1048   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1049   h->th = NULL;
1050   if ((0 == size) || (NULL == buf))
1051   {
1052     reconnect (h);
1053     return 0;
1054   }
1055   tsize = 0;
1056   while ((NULL != (th = h->th_head)) && (size >= th->size))
1057   {
1058     if (NULL != th->notify)
1059     {
1060       if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1061       {
1062         /* traffic to origin */
1063         struct GNUNET_MESH_ToOrigin to;
1064         struct GNUNET_MessageHeader *mh;
1065
1066         GNUNET_assert (size >= th->size);
1067         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1068         psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1069         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   to origin, type %u\n",
1070                     ntohs (mh->type));
1071         if (psize > 0)
1072         {
1073           psize += sizeof (to);
1074           GNUNET_assert (size >= psize);
1075           to.header.size = htons (psize);
1076           to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1077           to.tid = htonl (th->tunnel->tid);
1078           memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1079           memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1080           memcpy (cbuf, &to, sizeof (to));
1081         }
1082       }
1083       else if (th->target == 0)
1084       {
1085         /* multicast */
1086         struct GNUNET_MESH_Multicast mc;
1087         struct GNUNET_MessageHeader *mh;
1088
1089         GNUNET_assert (size >= th->size);
1090         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1091         psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1092         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   multicast, type %u\n",
1093                     ntohs (mh->type));
1094         if (psize > 0)
1095         {
1096           psize += sizeof (mc);
1097           GNUNET_assert (size >= psize);
1098           mc.header.size = htons (psize);
1099           mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1100           mc.tid = htonl (th->tunnel->tid);
1101           mc.mid = 0;
1102           mc.ttl = 0;
1103           memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1104           memcpy (cbuf, &mc, sizeof (mc));
1105         }
1106       }
1107       else
1108       {
1109         /* unicast */
1110         struct GNUNET_MESH_Unicast uc;
1111         struct GNUNET_MessageHeader *mh;
1112
1113         GNUNET_assert (size >= th->size);
1114         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1115         psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1116         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   unicast, type %u\n",
1117                     ntohs (mh->type));
1118         if (psize > 0)
1119         {
1120           psize += sizeof (uc);
1121           GNUNET_assert (size >= psize);
1122           uc.header.size = htons (psize);
1123           uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1124           uc.tid = htonl (th->tunnel->tid);
1125           memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1126           GNUNET_PEER_resolve (th->target, &uc.destination);
1127           memcpy (cbuf, &uc, sizeof (uc));
1128         }
1129       }
1130     }
1131     else
1132     {
1133       memcpy (cbuf, &th[1], th->size);
1134       psize = th->size;
1135     }
1136     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1137       GNUNET_SCHEDULER_cancel (th->timeout_task);
1138     if (NULL != th->tunnel)
1139     {
1140       th->tunnel->mesh->npackets--;
1141       th->tunnel->npackets--;
1142     }
1143     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1144     GNUNET_free (th);
1145     cbuf += psize;
1146     size -= psize;
1147     tsize += psize;
1148   }
1149   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   total size: %u\n", tsize);
1150   if (NULL != (th = h->th_head))
1151   {
1152     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   next size: %u\n", th->size);
1153     h->th =
1154         GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1155                                              GNUNET_TIME_UNIT_FOREVER_REL,
1156                                              GNUNET_YES, &send_callback, h);
1157   }
1158   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1159   if (GNUNET_NO == h->in_receive)
1160   {
1161     h->in_receive = GNUNET_YES;
1162     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1163                            GNUNET_TIME_UNIT_FOREVER_REL);
1164   }
1165   return tsize;
1166 }
1167
1168
1169 /**
1170  * Auxiliary function to send an already constructed packet to the service.
1171  * Takes care of creating a new queue element, copying the message and
1172  * calling the tmt_rdy function if necessary.
1173  * @param h mesh handle
1174  * @param msg message to transmit
1175  */
1176 static void
1177 send_packet (struct GNUNET_MESH_Handle *h,
1178              const struct GNUNET_MessageHeader *msg)
1179 {
1180   struct GNUNET_MESH_TransmitHandle *th;
1181   size_t msize;
1182
1183   msize = ntohs (msg->size);
1184   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1185   th->priority = UINT32_MAX;
1186   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1187   th->size = msize;
1188   memcpy (&th[1], msg, msize);
1189   add_to_queue (h, th);
1190   if (NULL != h->th)
1191     return;
1192   h->th =
1193       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1194                                            GNUNET_TIME_UNIT_FOREVER_REL,
1195                                            GNUNET_YES, &send_callback, h);
1196 }
1197
1198
1199 /******************************************************************************/
1200 /**********************      API CALL DEFINITIONS     *************************/
1201 /******************************************************************************/
1202
1203 /**
1204  * Connect to the mesh service.
1205  *
1206  * @param cfg configuration to use
1207  * @param queue_size size of the data message queue, shared among all tunnels
1208  *                   (each tunnel is guaranteed to accept at least one message,
1209  *                    no matter what is the status of other tunnels)
1210  * @param cls closure for the various callbacks that follow
1211  *            (including handlers in the handlers array)
1212  * @param new_tunnel function called when an *inbound* tunnel is created
1213  * @param cleaner function called when an *inbound* tunnel is destroyed
1214  * @param handlers callbacks for messages we care about, NULL-terminated
1215  *                note that the mesh is allowed to drop notifications about
1216  *                inbound messages if the client does not process them fast
1217  *                enough (for this notification type, a bounded queue is used)
1218  * @param stypes list of the applications that this client claims to provide
1219  * @return handle to the mesh service NULL on error
1220  *         (in this case, init is never called)
1221  */
1222 struct GNUNET_MESH_Handle *
1223 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1224                      unsigned int queue_size, void *cls,
1225                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1226                      GNUNET_MESH_TunnelEndHandler cleaner,
1227                      const struct GNUNET_MESH_MessageHandler *handlers,
1228                      const GNUNET_MESH_ApplicationType *stypes)
1229 {
1230   struct GNUNET_MESH_Handle *h;
1231
1232   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1233   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1234   h->cfg = cfg;
1235   h->max_queue_size = queue_size;
1236   h->new_tunnel = new_tunnel;
1237   h->cleaner = cleaner;
1238   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1239   if (h->client == NULL)
1240   {
1241     GNUNET_break (0);
1242     GNUNET_free (h);
1243     return NULL;
1244   }
1245   h->cls = cls;
1246   /* FIXME memdup? */
1247   h->applications = stypes;
1248   h->message_handlers = handlers;
1249   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1250   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1251
1252   /* count handlers and apps, calculate size */
1253   for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1254   for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1255   send_connect (h);
1256   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1257   return h;
1258 }
1259
1260
1261 /**
1262  * Disconnect from the mesh service.
1263  *
1264  * @param handle connection to mesh to disconnect
1265  */
1266 void
1267 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1268 {
1269   struct GNUNET_MESH_Tunnel *t;
1270   struct GNUNET_MESH_Tunnel *aux;
1271   struct GNUNET_MESH_TransmitHandle *th;
1272
1273   t = handle->tunnels_head;
1274   while (NULL != t)
1275   {
1276     aux = t->next;
1277     destroy_tunnel (t);
1278     t = aux;
1279   }
1280   while ( (th = handle->th_head) != NULL)
1281   {
1282     struct GNUNET_MessageHeader *msg;
1283
1284     /* Make sure it is a connect packet (everything else should have been
1285      * already canceled).
1286      */
1287     GNUNET_break (UINT32_MAX == th->priority);
1288     GNUNET_break (NULL == th->notify);
1289     msg = (struct GNUNET_MessageHeader *) &th[1];
1290     GNUNET_break (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT == ntohs(msg->type));
1291     GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1292     GNUNET_free (th);
1293   }
1294   if (NULL != handle->th)
1295   {
1296     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1297   }
1298   if (NULL != handle->client)
1299   {
1300     GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1301   }
1302   GNUNET_free (handle);
1303 }
1304
1305
1306 /**
1307  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1308  * and to broadcast).
1309  *
1310  * @param h mesh handle
1311  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1312  * @param connect_handler function to call when peers are actually connected
1313  * @param disconnect_handler function to call when peers are disconnected
1314  * @param handler_cls closure for connect/disconnect handlers
1315  */
1316 struct GNUNET_MESH_Tunnel *
1317 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1318                            GNUNET_MESH_PeerConnectHandler connect_handler,
1319                            GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1320                            void *handler_cls)
1321 {
1322   struct GNUNET_MESH_Tunnel *t;
1323   struct GNUNET_MESH_TunnelMessage msg;
1324
1325   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1326   t = create_tunnel (h, 0);
1327   t->connect_handler = connect_handler;
1328   t->disconnect_handler = disconnect_handler;
1329   t->cls = handler_cls;
1330   t->ctx = tunnel_ctx;
1331   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1332   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1333   msg.tunnel_id = htonl (t->tid);
1334   send_packet (h, &msg.header);
1335   return t;
1336 }
1337
1338
1339 /**
1340  * Destroy an existing tunnel.
1341  *
1342  * @param tunnel tunnel handle
1343  */
1344 void
1345 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1346 {
1347   struct GNUNET_MESH_Handle *h;
1348   struct GNUNET_MESH_TunnelMessage msg;
1349
1350   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1351   h = tunnel->mesh;
1352
1353   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1354   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1355   msg.tunnel_id = htonl (tunnel->tid);
1356   destroy_tunnel (tunnel);
1357   send_packet (h, &msg.header);
1358 }
1359
1360
1361 /**
1362  * Request that a peer should be added to the tunnel.  The existing
1363  * connect handler will be called ONCE with either success or failure.
1364  * This function should NOT be called again with the same peer before the
1365  * connect handler is called.
1366  *
1367  * @param tunnel handle to existing tunnel
1368  * @param peer peer to add
1369  */
1370 void
1371 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1372                                       const struct GNUNET_PeerIdentity *peer)
1373 {
1374   struct GNUNET_MESH_PeerControl msg;
1375   GNUNET_PEER_Id peer_id;
1376   unsigned int i;
1377
1378   peer_id = GNUNET_PEER_intern (peer);
1379   for (i = 0; i < tunnel->npeers; i++)
1380   {
1381     if (tunnel->peers[i]->id == peer_id)
1382     {
1383       /* Peer already exists in tunnel */
1384       GNUNET_PEER_change_rc (peer_id, -1);
1385       GNUNET_break (0);
1386       return;
1387     }
1388   }
1389   if (NULL == add_peer_to_tunnel (tunnel, peer))
1390     return;
1391
1392   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1393   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1394   msg.tunnel_id = htonl (tunnel->tid);
1395   msg.peer = *peer;
1396   send_packet (tunnel->mesh, &msg.header);
1397
1398   return;
1399 }
1400
1401
1402 /**
1403  * Request that a peer should be removed from the tunnel.  The existing
1404  * disconnect handler will be called ONCE if we were connected.
1405  *
1406  * @param tunnel handle to existing tunnel
1407  * @param peer peer to remove
1408  */
1409 void
1410 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1411                                       const struct GNUNET_PeerIdentity *peer)
1412 {
1413   struct GNUNET_MESH_PeerControl msg;
1414   GNUNET_PEER_Id peer_id;
1415   unsigned int i;
1416
1417   peer_id = GNUNET_PEER_search (peer);
1418   if (0 == peer_id)
1419   {
1420     GNUNET_break (0);
1421     return;
1422   }
1423   for (i = 0; i < tunnel->npeers; i++)
1424     if (tunnel->peers[i]->id == peer_id)
1425       break;
1426   if (i == tunnel->npeers)
1427   {
1428     GNUNET_break (0);
1429     return;
1430   }
1431   if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1432     tunnel->disconnect_handler (tunnel->cls, peer);
1433   GNUNET_PEER_change_rc (peer_id, -1);
1434   GNUNET_free (tunnel->peers[i]);
1435   tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1436   GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1437
1438   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1439   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1440   msg.tunnel_id = htonl (tunnel->tid);
1441   memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1442   send_packet (tunnel->mesh, &msg.header);
1443 }
1444
1445
1446 /**
1447  * Request that the mesh should try to connect to a peer supporting the given
1448  * message type.
1449  *
1450  * @param tunnel handle to existing tunnel
1451  * @param app_type application type that must be supported by the peer (MESH
1452  *                 should discover peer in proximity handling this type)
1453  */
1454 void
1455 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1456                                           GNUNET_MESH_ApplicationType app_type)
1457 {
1458   struct GNUNET_MESH_ConnectPeerByType msg;
1459
1460   GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1461
1462   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1463   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1464   msg.tunnel_id = htonl (tunnel->tid);
1465   msg.type = htonl (app_type);
1466   send_packet (tunnel->mesh, &msg.header);
1467 }
1468
1469
1470 /**
1471  * Ask the mesh to call "notify" once it is ready to transmit the
1472  * given number of bytes to the specified "target".  If we are not yet
1473  * connected to the specified peer, a call to this function will cause
1474  * us to try to establish a connection.
1475  *
1476  * @param tunnel tunnel to use for transmission
1477  * @param cork is corking allowed for this transmission?
1478  * @param priority how important is the message?
1479  * @param maxdelay how long can the message wait?
1480  * @param target destination for the message,
1481  *               NULL for multicast to all tunnel targets
1482  * @param notify_size how many bytes of buffer space does notify want?
1483  * @param notify function to call when buffer space is available;
1484  *        will be called with NULL on timeout or if the overall queue
1485  *        for this peer is larger than queue_size and this is currently
1486  *        the message with the lowest priority
1487  * @param notify_cls closure for notify
1488  * @return non-NULL if the notify callback was queued,
1489  *         NULL if we can not even queue the request (insufficient
1490  *         memory); if NULL is returned, "notify" will NOT be called.
1491  */
1492 struct GNUNET_MESH_TransmitHandle *
1493 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1494                                    uint32_t priority,
1495                                    struct GNUNET_TIME_Relative maxdelay,
1496                                    const struct GNUNET_PeerIdentity *target,
1497                                    size_t notify_size,
1498                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1499                                    void *notify_cls)
1500 {
1501   struct GNUNET_MESH_TransmitHandle *th;
1502   struct GNUNET_MESH_TransmitHandle *least_priority_th;
1503   uint32_t least_priority;
1504   size_t overhead;
1505
1506   GNUNET_assert (NULL != tunnel);
1507 #if MESH_API_DEBUG
1508   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1509               "mesh: mesh notify transmit ready called\n");
1510   if (NULL != target)
1511     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     target %s\n",
1512                 GNUNET_i2s (target));
1513   else
1514     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     target multicast\n");
1515 #endif
1516   GNUNET_assert (NULL != notify);
1517   if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1518       tunnel->npackets > 0)
1519   {
1520     /* queue full */
1521     if (0 == priority)
1522       return NULL;
1523     th = tunnel->mesh->th_tail;
1524     least_priority = priority;
1525     least_priority_th = NULL;
1526     while (NULL != th)
1527     {
1528       if (th->priority < least_priority && th->tunnel->npackets > 1)
1529       {
1530         least_priority_th = th;
1531         least_priority = th->priority;
1532       }
1533       th = th->prev;
1534     }
1535     if (NULL == least_priority_th)
1536       return NULL;
1537     /* Can't be a control message */
1538     GNUNET_assert (NULL != least_priority_th->notify);
1539     least_priority_th->notify (notify_cls, 0, NULL);
1540     least_priority_th->tunnel->npackets--;
1541     tunnel->mesh->npackets--;
1542     GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1543                                  least_priority_th);
1544     if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1545       GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1546     GNUNET_free (least_priority_th);
1547   }
1548   tunnel->npackets++;
1549   tunnel->mesh->npackets++;
1550   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1551   th->tunnel = tunnel;
1552   th->priority = priority;
1553   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1554   th->target = GNUNET_PEER_intern (target);
1555   if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1556     overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1557   else if (NULL == target)
1558     overhead = sizeof (struct GNUNET_MESH_Multicast);
1559   else
1560     overhead = sizeof (struct GNUNET_MESH_Unicast);
1561   th->size = notify_size + overhead;
1562   th->notify = notify;
1563   th->notify_cls = notify_cls;
1564   add_to_queue (tunnel->mesh, th);
1565   if (NULL != tunnel->mesh->th)
1566     return th;
1567   tunnel->mesh->th =
1568       GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1569                                            GNUNET_TIME_UNIT_FOREVER_REL,
1570                                            GNUNET_YES, &send_callback,
1571                                            tunnel->mesh);
1572   return th;
1573 }
1574
1575
1576 /**
1577  * Cancel the specified transmission-ready notification.
1578  *
1579  * @param th handle that was returned by "notify_transmit_ready".
1580  */
1581 void
1582 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1583 {
1584   struct GNUNET_MESH_Handle *mesh;
1585
1586   mesh = th->tunnel->mesh;
1587   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1588     GNUNET_SCHEDULER_cancel (th->timeout_task);
1589   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1590   GNUNET_free (th);
1591   if ((NULL == mesh->th_head) && (NULL != mesh->th))
1592   {
1593     /* queue empty, no point in asking for transmission */
1594     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1595     mesh->th = NULL;
1596   }
1597 }
1598
1599
1600 /**
1601  * Transition API for tunnel ctx management
1602  */
1603 void
1604 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1605 {
1606   tunnel->ctx = data;
1607 }
1608
1609 /**
1610  * Transition API for tunnel ctx management
1611  */
1612 void *
1613 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)
1614 {
1615   return tunnel->ctx;
1616 }
1617
1618
1619 #if 0                           /* keep Emacsens' auto-indent happy */
1620 {
1621 #endif
1622 #ifdef __cplusplus
1623 }
1624 #endif