- Updated doxygen
[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
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_HOURS,
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   struct GNUNET_ATS_Information atsi;
763   MESH_TunnelNumber tid;
764
765   tid = ntohl (msg->tunnel_id);
766   if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
767   {
768     GNUNET_break (0);
769     return;
770   }
771   t = create_tunnel (h, tid);
772   t->owner = GNUNET_PEER_intern (&msg->peer);
773   t->npeers = 1;
774   t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
775   t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
776   t->peers[0]->t = t;
777   t->peers[0]->connected = 1;
778   t->peers[0]->id = t->owner;
779   t->mesh = h;
780   t->tid = tid;
781   if (NULL != h->new_tunnel)
782   {
783     atsi.type = 0;
784     atsi.value = 0;
785     t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
786   }
787   return;
788 }
789
790
791 /**
792  * Process the tunnel destroy notification and free associated resources
793  *
794  * @param h     The mesh handle
795  * @param msg   A message with the details of the tunnel being destroyed
796  */
797 static void
798 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
799                         const struct GNUNET_MESH_TunnelMessage *msg)
800 {
801   struct GNUNET_MESH_Tunnel *t;
802   MESH_TunnelNumber tid;
803
804   tid = ntohl (msg->tunnel_id);
805   t = retrieve_tunnel (h, tid);
806
807   if (NULL == t)
808   {
809     return;
810   }
811   if (0 == t->owner)
812   {
813     GNUNET_break (0);
814   }
815
816   destroy_tunnel (t);
817   return;
818 }
819
820
821 /**
822  * Process the new peer event and notify the upper level of it
823  *
824  * @param h     The mesh handle
825  * @param msg   A message with the details of the peer event
826  */
827 static void
828 process_peer_event (struct GNUNET_MESH_Handle *h,
829                     const struct GNUNET_MESH_PeerControl *msg)
830 {
831   struct GNUNET_MESH_Tunnel *t;
832   struct GNUNET_MESH_Peer *p;
833   struct GNUNET_ATS_Information atsi;
834   GNUNET_PEER_Id id;
835   uint16_t size;
836
837   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
838   size = ntohs (msg->header.size);
839   if (size != sizeof (struct GNUNET_MESH_PeerControl))
840   {
841     GNUNET_break (0);
842     return;
843   }
844   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
845   if (NULL == t)
846   {
847     GNUNET_break (0);
848     return;
849   }
850   id = GNUNET_PEER_search (&msg->peer);
851   if ((p = retrieve_peer (t, id)) == NULL)
852     p = add_peer_to_tunnel (t, &msg->peer);
853   if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
854   {
855     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
856     if (NULL != t->connect_handler)
857     {
858       atsi.type = 0;
859       atsi.value = 0;
860       t->connect_handler (t->cls, &msg->peer, &atsi);
861     }
862     p->connected = 1;
863   }
864   else
865   {
866     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
867     if (NULL != t->disconnect_handler && p->connected)
868     {
869       t->disconnect_handler (t->cls, &msg->peer);
870     }
871     remove_peer_from_tunnel (p);
872     GNUNET_free (p);
873   }
874   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
875 }
876
877
878 /**
879  * Process the incoming data packets
880  *
881  * @param h         The mesh handle
882  * @param message   A message encapsulating the data
883  */
884 static void
885 process_incoming_data (struct GNUNET_MESH_Handle *h,
886                        const struct GNUNET_MessageHeader *message)
887 {
888   const struct GNUNET_MessageHeader *payload;
889   const struct GNUNET_MESH_MessageHandler *handler;
890   const struct GNUNET_PeerIdentity *peer;
891   struct GNUNET_MESH_Unicast *ucast;
892   struct GNUNET_MESH_Multicast *mcast;
893   struct GNUNET_MESH_ToOrigin *to_orig;
894   struct GNUNET_MESH_Tunnel *t;
895   unsigned int i;
896   uint16_t type;
897
898   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
899   type = ntohs (message->type);
900   switch (type)
901   {
902   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
903     ucast = (struct GNUNET_MESH_Unicast *) message;
904
905     t = retrieve_tunnel (h, ntohl (ucast->tid));
906     payload = (struct GNUNET_MessageHeader *) &ucast[1];
907     peer = &ucast->oid;
908     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   on tunnel %s [%x]\n",
909                 GNUNET_i2s (peer), ntohl (ucast->tid));
910     break;
911   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
912     mcast = (struct GNUNET_MESH_Multicast *) message;
913     t = retrieve_tunnel (h, ntohl (mcast->tid));
914     payload = (struct GNUNET_MessageHeader *) &mcast[1];
915     peer = &mcast->oid;
916     break;
917   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
918     to_orig = (struct GNUNET_MESH_ToOrigin *) message;
919     t = retrieve_tunnel (h, ntohl (to_orig->tid));
920     payload = (struct GNUNET_MessageHeader *) &to_orig[1];
921     peer = &to_orig->sender;
922     break;
923   default:
924     GNUNET_break (0);
925     return;
926   }
927   if (NULL == t)
928   {
929     GNUNET_break (0);
930     return;
931   }
932   type = ntohs (payload->type);
933   for (i = 0; i < h->n_handlers; i++)
934   {
935     handler = &h->message_handlers[i];
936     if (handler->type == type)
937     {
938       struct GNUNET_ATS_Information atsi;
939
940       atsi.type = 0;
941       atsi.value = 0;
942       if (GNUNET_OK !=
943           handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
944       {
945         LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
946         GNUNET_MESH_disconnect (h);
947         return;
948       }
949 #if MESH_API_DEBUG
950       else
951       {
952         LOG (GNUNET_ERROR_TYPE_DEBUG,
953              "MESH: callback completed successfully\n");
954
955       }
956 #endif
957     }
958   }
959 }
960
961
962 /**
963  * Function to process all messages received from the service
964  *
965  * @param cls closure
966  * @param msg message received, NULL on timeout or fatal error
967  */
968 static void
969 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
970 {
971   struct GNUNET_MESH_Handle *h = cls;
972
973   if (msg == NULL)
974   {
975     reconnect (h);
976     return;
977   }
978   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
979        ntohs (msg->type));
980   switch (ntohs (msg->type))
981   {
982     /* Notify of a new incoming tunnel */
983   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
984     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
985     break;
986     /* Notify of a tunnel disconnection */
987   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
988     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
989     break;
990     /* Notify of a new peer or a peer disconnect in the tunnel */
991   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
992   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
993     process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
994     break;
995     /* Notify of a new data packet in the tunnel */
996   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
997   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
998   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
999     process_incoming_data (h, msg);
1000     break;
1001     /* We shouldn't get any other packages, log and ignore */
1002   default:
1003     LOG (GNUNET_ERROR_TYPE_WARNING,
1004          "MESH: unsolicited message form service (type %d)\n",
1005          ntohs (msg->type));
1006   }
1007   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1008   GNUNET_CLIENT_receive (h->client, &msg_received, h,
1009                          GNUNET_TIME_UNIT_FOREVER_REL);
1010 }
1011
1012
1013 /******************************************************************************/
1014 /************************       SEND FUNCTIONS     ****************************/
1015 /******************************************************************************/
1016
1017 /**
1018  * Function called to send a message to the service.
1019  * "buf" will be NULL and "size" zero if the socket was closed for writing in
1020  * the meantime.
1021  *
1022  * @param cls closure, the mesh handle
1023  * @param size number of bytes available in buf
1024  * @param buf where the callee should write the connect message
1025  * @return number of bytes written to buf
1026  */
1027 static size_t
1028 send_callback (void *cls, size_t size, void *buf)
1029 {
1030   struct GNUNET_MESH_Handle *h = cls;
1031   struct GNUNET_MESH_TransmitHandle *th;
1032   char *cbuf = buf;
1033   size_t tsize;
1034   size_t psize;
1035
1036   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1037   h->th = NULL;
1038   if ((0 == size) || (NULL == buf))
1039   {
1040     reconnect (h);
1041     return 0;
1042   }
1043   tsize = 0;
1044   while ((NULL != (th = h->th_head)) && (size >= th->size))
1045   {
1046     if (NULL != th->notify)
1047     {
1048       if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1049       {
1050         /* traffic to origin */
1051         struct GNUNET_MESH_ToOrigin to;
1052         struct GNUNET_MessageHeader *mh;
1053
1054         GNUNET_assert (size >= th->size);
1055         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1056         psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1057         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   to origin, type %u\n",
1058                     ntohs (mh->type));
1059         if (psize > 0)
1060         {
1061           psize += sizeof (to);
1062           GNUNET_assert (size >= psize);
1063           to.header.size = htons (psize);
1064           to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1065           to.tid = htonl (th->tunnel->tid);
1066           memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1067           memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1068           memcpy (cbuf, &to, sizeof (to));
1069         }
1070       }
1071       else if (th->target == 0)
1072       {
1073         /* multicast */
1074         struct GNUNET_MESH_Multicast mc;
1075         struct GNUNET_MessageHeader *mh;
1076
1077         GNUNET_assert (size >= th->size);
1078         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1079         psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1080         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   multicast, type %u\n",
1081                     ntohs (mh->type));
1082         if (psize > 0)
1083         {
1084           psize += sizeof (mc);
1085           GNUNET_assert (size >= psize);
1086           mc.header.size = htons (psize);
1087           mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1088           mc.tid = htonl (th->tunnel->tid);
1089           mc.mid = 0;
1090           memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1091           memcpy (cbuf, &mc, sizeof (mc));
1092         }
1093       }
1094       else
1095       {
1096         /* unicast */
1097         struct GNUNET_MESH_Unicast uc;
1098         struct GNUNET_MessageHeader *mh;
1099
1100         GNUNET_assert (size >= th->size);
1101         mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1102         psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1103         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   unicast, type %u\n",
1104                     ntohs (mh->type));
1105         if (psize > 0)
1106         {
1107           psize += sizeof (uc);
1108           GNUNET_assert (size >= psize);
1109           uc.header.size = htons (psize);
1110           uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1111           uc.tid = htonl (th->tunnel->tid);
1112           memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1113           GNUNET_PEER_resolve (th->target, &uc.destination);
1114           memcpy (cbuf, &uc, sizeof (uc));
1115         }
1116       }
1117     }
1118     else
1119     {
1120       memcpy (cbuf, &th[1], th->size);
1121       psize = th->size;
1122     }
1123     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1124       GNUNET_SCHEDULER_cancel (th->timeout_task);
1125     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1126     GNUNET_free (th);
1127     cbuf += psize;
1128     size -= psize;
1129     tsize += psize;
1130   }
1131   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   total size: %u\n", tsize);
1132   if (NULL != (th = h->th_head))
1133   {
1134     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   next size: %u\n", th->size);
1135     h->th =
1136         GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1137                                              GNUNET_TIME_UNIT_FOREVER_REL,
1138                                              GNUNET_YES, &send_callback, h);
1139   }
1140   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1141   if (GNUNET_NO == h->in_receive)
1142   {
1143     h->in_receive = GNUNET_YES;
1144     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1145                            GNUNET_TIME_UNIT_FOREVER_REL);
1146   }
1147   return tsize;
1148 }
1149
1150
1151 /**
1152  * Auxiliary function to send an already constructed packet to the service.
1153  * Takes care of creating a new queue element, copying the message and
1154  * calling the tmt_rdy function if necessary.
1155  * @param h mesh handle
1156  * @param msg message to transmit
1157  */
1158 static void
1159 send_packet (struct GNUNET_MESH_Handle *h,
1160              const struct GNUNET_MessageHeader *msg)
1161 {
1162   struct GNUNET_MESH_TransmitHandle *th;
1163   size_t msize;
1164
1165   msize = ntohs (msg->size);
1166   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1167   th->priority = UINT32_MAX;
1168   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1169   th->size = msize;
1170   memcpy (&th[1], msg, msize);
1171   add_to_queue (h, th);
1172   if (NULL != h->th)
1173     return;
1174   h->th =
1175       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1176                                            GNUNET_TIME_UNIT_FOREVER_REL,
1177                                            GNUNET_YES, &send_callback, h);
1178 }
1179
1180
1181 /******************************************************************************/
1182 /**********************      API CALL DEFINITIONS     *************************/
1183 /******************************************************************************/
1184
1185 /**
1186  * Connect to the mesh service.
1187  *
1188  * @param cfg configuration to use
1189  * @param queue_size size of the data message queue, shared among all tunnels
1190  *                   (each tunnel is guaranteed to accept at least one message,
1191  *                    no matter what is the status of other tunnels)
1192  * @param cls closure for the various callbacks that follow
1193  *            (including handlers in the handlers array)
1194  * @param new_tunnel function called when an *inbound* tunnel is created
1195  * @param cleaner function called when an *inbound* tunnel is destroyed
1196  * @param handlers callbacks for messages we care about, NULL-terminated
1197  *                note that the mesh is allowed to drop notifications about
1198  *                inbound messages if the client does not process them fast
1199  *                enough (for this notification type, a bounded queue is used)
1200  * @param stypes list of the applications that this client claims to provide
1201  * @return handle to the mesh service NULL on error
1202  *         (in this case, init is never called)
1203  */
1204 struct GNUNET_MESH_Handle *
1205 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1206                      unsigned int queue_size, void *cls,
1207                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1208                      GNUNET_MESH_TunnelEndHandler cleaner,
1209                      const struct GNUNET_MESH_MessageHandler *handlers,
1210                      const GNUNET_MESH_ApplicationType *stypes)
1211 {
1212   struct GNUNET_MESH_Handle *h;
1213
1214   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1215   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1216   h->cfg = cfg;
1217   h->max_queue_size = queue_size;
1218   h->new_tunnel = new_tunnel;
1219   h->cleaner = cleaner;
1220   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1221   if (h->client == NULL)
1222   {
1223     GNUNET_break (0);
1224     GNUNET_free (h);
1225     return NULL;
1226   }
1227   h->cls = cls;
1228   /* FIXME memdup? */
1229   h->applications = stypes;
1230   h->message_handlers = handlers;
1231   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1232   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1233
1234   /* count handlers and apps, calculate size */
1235   for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1236   for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1237   send_connect (h);
1238   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1239   return h;
1240 }
1241
1242
1243 /**
1244  * Disconnect from the mesh service.
1245  *
1246  * @param handle connection to mesh to disconnect
1247  */
1248 void
1249 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1250 {
1251   struct GNUNET_MESH_Tunnel *t;
1252   struct GNUNET_MESH_Tunnel *aux;
1253
1254   t = handle->tunnels_head;
1255   while (NULL != t)
1256   {
1257     aux = t->next;
1258     destroy_tunnel (t);
1259     t = aux;
1260   }
1261   if (NULL != handle->th)
1262   {
1263     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1264   }
1265   if (NULL != handle->client)
1266   {
1267     GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1268   }
1269   GNUNET_free (handle);
1270 }
1271
1272
1273 /**
1274  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1275  * and to broadcast).
1276  *
1277  * @param h mesh handle
1278  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1279  * @param connect_handler function to call when peers are actually connected
1280  * @param disconnect_handler function to call when peers are disconnected
1281  * @param handler_cls closure for connect/disconnect handlers
1282  */
1283 struct GNUNET_MESH_Tunnel *
1284 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1285                            GNUNET_MESH_PeerConnectHandler connect_handler,
1286                            GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1287                            void *handler_cls)
1288 {
1289   struct GNUNET_MESH_Tunnel *t;
1290   struct GNUNET_MESH_TunnelMessage msg;
1291
1292   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1293   t = create_tunnel (h, 0);
1294   t->connect_handler = connect_handler;
1295   t->disconnect_handler = disconnect_handler;
1296   t->cls = handler_cls;
1297   t->ctx = tunnel_ctx;
1298   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1299   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1300   msg.tunnel_id = htonl (t->tid);
1301   send_packet (h, &msg.header);
1302   return t;
1303 }
1304
1305
1306 /**
1307  * Destroy an existing tunnel.
1308  *
1309  * @param tunnel tunnel handle
1310  */
1311 void
1312 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1313 {
1314   struct GNUNET_MESH_Handle *h;
1315   struct GNUNET_MESH_TunnelMessage msg;
1316
1317   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1318   h = tunnel->mesh;
1319
1320   if (0 != tunnel->owner)
1321     GNUNET_PEER_change_rc (tunnel->owner, -1);
1322
1323   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1324   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1325   msg.tunnel_id = htonl (tunnel->tid);
1326   destroy_tunnel (tunnel);
1327   send_packet (h, &msg.header);
1328 }
1329
1330
1331 /**
1332  * Request that a peer should be added to the tunnel.  The existing
1333  * connect handler will be called ONCE with either success or failure.
1334  * This function should NOT be called again with the same peer before the
1335  * connect handler is called.
1336  *
1337  * @param tunnel handle to existing tunnel
1338  * @param peer peer to add
1339  */
1340 void
1341 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1342                                       const struct GNUNET_PeerIdentity *peer)
1343 {
1344   struct GNUNET_MESH_PeerControl msg;
1345   GNUNET_PEER_Id peer_id;
1346   unsigned int i;
1347
1348   peer_id = GNUNET_PEER_intern (peer);
1349   for (i = 0; i < tunnel->npeers; i++)
1350   {
1351     if (tunnel->peers[i]->id == peer_id)
1352     {
1353       /* Peer already exists in tunnel */
1354       GNUNET_PEER_change_rc (peer_id, -1);
1355       GNUNET_break (0);
1356       return;
1357     }
1358   }
1359   if (NULL == add_peer_to_tunnel (tunnel, peer))
1360     return;
1361
1362   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1363   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1364   msg.tunnel_id = htonl (tunnel->tid);
1365   msg.peer = *peer;
1366   send_packet (tunnel->mesh, &msg.header);
1367
1368   return;
1369 }
1370
1371
1372 /**
1373  * Request that a peer should be removed from the tunnel.  The existing
1374  * disconnect handler will be called ONCE if we were connected.
1375  *
1376  * @param tunnel handle to existing tunnel
1377  * @param peer peer to remove
1378  */
1379 void
1380 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1381                                       const struct GNUNET_PeerIdentity *peer)
1382 {
1383   struct GNUNET_MESH_PeerControl msg;
1384   GNUNET_PEER_Id peer_id;
1385   unsigned int i;
1386
1387   peer_id = GNUNET_PEER_search (peer);
1388   if (0 == peer_id)
1389   {
1390     GNUNET_break (0);
1391     return;
1392   }
1393   for (i = 0; i < tunnel->npeers; i++)
1394     if (tunnel->peers[i]->id == peer_id)
1395       break;
1396   if (i == tunnel->npeers)
1397   {
1398     GNUNET_break (0);
1399     return;
1400   }
1401   if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1402     tunnel->disconnect_handler (tunnel->cls, peer);
1403   GNUNET_PEER_change_rc (peer_id, -1);
1404   GNUNET_free (tunnel->peers[i]);
1405   tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1406   GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1407
1408   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1409   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1410   msg.tunnel_id = htonl (tunnel->tid);
1411   memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1412   send_packet (tunnel->mesh, &msg.header);
1413 }
1414
1415
1416 /**
1417  * Request that the mesh should try to connect to a peer supporting the given
1418  * message type.
1419  *
1420  * @param tunnel handle to existing tunnel
1421  * @param app_type application type that must be supported by the peer (MESH
1422  *                 should discover peer in proximity handling this type)
1423  */
1424 void
1425 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1426                                           GNUNET_MESH_ApplicationType app_type)
1427 {
1428   struct GNUNET_MESH_ConnectPeerByType msg;
1429
1430   GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1431
1432   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1433   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1434   msg.tunnel_id = htonl (tunnel->tid);
1435   msg.type = htonl (app_type);
1436   send_packet (tunnel->mesh, &msg.header);
1437 }
1438
1439
1440 /**
1441  * Ask the mesh to call "notify" once it is ready to transmit the
1442  * given number of bytes to the specified "target".  If we are not yet
1443  * connected to the specified peer, a call to this function will cause
1444  * us to try to establish a connection.
1445  *
1446  * @param tunnel tunnel to use for transmission
1447  * @param cork is corking allowed for this transmission?
1448  * @param priority how important is the message?
1449  * @param maxdelay how long can the message wait?
1450  * @param target destination for the message,
1451  *               NULL for multicast to all tunnel targets
1452  * @param notify_size how many bytes of buffer space does notify want?
1453  * @param notify function to call when buffer space is available;
1454  *        will be called with NULL on timeout or if the overall queue
1455  *        for this peer is larger than queue_size and this is currently
1456  *        the message with the lowest priority
1457  * @param notify_cls closure for notify
1458  * @return non-NULL if the notify callback was queued,
1459  *         NULL if we can not even queue the request (insufficient
1460  *         memory); if NULL is returned, "notify" will NOT be called.
1461  */
1462 struct GNUNET_MESH_TransmitHandle *
1463 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1464                                    uint32_t priority,
1465                                    struct GNUNET_TIME_Relative maxdelay,
1466                                    const struct GNUNET_PeerIdentity *target,
1467                                    size_t notify_size,
1468                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1469                                    void *notify_cls)
1470 {
1471   struct GNUNET_MESH_TransmitHandle *th;
1472   struct GNUNET_MESH_TransmitHandle *least_priority_th;
1473   uint32_t least_priority;
1474   size_t overhead;
1475
1476 #if MESH_API_DEBUG
1477   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1478               "mesh: mesh notify transmit ready called\n");
1479   if (NULL != target)
1480     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     target %s\n",
1481                 GNUNET_i2s (target));
1482   else
1483     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     target multicast\n");
1484 #endif
1485   GNUNET_assert (NULL != notify);
1486   if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1487       tunnel->npackets > 0)
1488   {
1489     /* queue full */
1490     if (0 == priority)
1491       return NULL;
1492     th = tunnel->mesh->th_tail;
1493     least_priority = priority;
1494     least_priority_th = NULL;
1495     while (NULL != th)
1496     {
1497       if (th->priority < least_priority && th->tunnel->npackets > 1)
1498       {
1499         least_priority_th = th;
1500         least_priority = th->priority;
1501       }
1502       th = th->prev;
1503     }
1504     if (NULL == least_priority_th)
1505       return NULL;
1506     /* Can't be a control message */
1507     GNUNET_assert (NULL != least_priority_th->notify);
1508     least_priority_th->notify (notify_cls, 0, NULL);
1509     least_priority_th->tunnel->npackets--;
1510     tunnel->mesh->npackets--;
1511     GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1512                                  least_priority_th);
1513     if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1514       GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1515     GNUNET_free (least_priority_th);
1516   }
1517   tunnel->npackets++;
1518   tunnel->mesh->npackets++;
1519   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1520   th->tunnel = tunnel;
1521   th->priority = priority;
1522   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1523   th->target = GNUNET_PEER_intern (target);
1524   if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1525     overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1526   else if (NULL == target)
1527     overhead = sizeof (struct GNUNET_MESH_Multicast);
1528   else
1529     overhead = sizeof (struct GNUNET_MESH_Unicast);
1530   th->size = notify_size + overhead;
1531   th->notify = notify;
1532   th->notify_cls = notify_cls;
1533   add_to_queue (tunnel->mesh, th);
1534   if (NULL != tunnel->mesh->th)
1535     return th;
1536   tunnel->mesh->th =
1537       GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1538                                            GNUNET_TIME_UNIT_FOREVER_REL,
1539                                            GNUNET_YES, &send_callback,
1540                                            tunnel->mesh);
1541   return th;
1542 }
1543
1544
1545 /**
1546  * Cancel the specified transmission-ready notification.
1547  *
1548  * @param th handle that was returned by "notify_transmit_ready".
1549  */
1550 void
1551 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1552 {
1553   struct GNUNET_MESH_Handle *mesh;
1554
1555   mesh = th->tunnel->mesh;
1556   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1557     GNUNET_SCHEDULER_cancel (th->timeout_task);
1558   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1559   GNUNET_free (th);
1560   if ((NULL == mesh->th_head) && (NULL != mesh->th))
1561   {
1562     /* queue empty, no point in asking for transmission */
1563     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1564     mesh->th = NULL;
1565   }
1566 }
1567
1568
1569 /**
1570  * Transition API for tunnel ctx management
1571  */
1572 void
1573 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1574 {
1575   tunnel->ctx = data;
1576 }
1577
1578 /**
1579  * Transition API for tunnel ctx management
1580  */
1581 void *
1582 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)
1583 {
1584   return tunnel->ctx;
1585 }
1586
1587
1588 #if 0                           /* keep Emacsens' auto-indent happy */
1589 {
1590 #endif
1591 #ifdef __cplusplus
1592 }
1593 #endif