use LOG macro in mesh_api.c
[oweals/gnunet.git] / src / mesh / mesh_api_new.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_new.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_new.h"
45 #include "mesh.h"
46 #include "mesh_protocol.h"
47
48 #define 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  * @param tid ID of the wanted tunnel
372  * @return handle to the required tunnel or NULL if not found
373  */
374 static void
375 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
376 {
377   struct GNUNET_MESH_Handle *h;
378   struct GNUNET_PeerIdentity pi;
379   struct GNUNET_MESH_TransmitHandle *th;
380   struct GNUNET_MESH_TransmitHandle *aux;
381   unsigned int i;
382
383   if (NULL == t)
384   {
385     GNUNET_break (0);
386     return;
387   }
388   h = t->mesh;
389   th = h->th_head;
390   while (NULL != th)
391   {
392     if (th->tunnel == t)
393     {
394       aux = th->next;
395       GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
396       if (NULL == h->th_head && NULL != h->th)
397       {
398         GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
399         h->th = NULL;
400       }
401       if (NULL != th->notify)
402         th->notify (th->notify_cls, 0, NULL);
403       if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
404         GNUNET_SCHEDULER_cancel (th->timeout_task);
405       GNUNET_free (th);
406       th = aux;
407     }
408     else
409     {
410       th = th->next;
411     }
412   }
413   GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
414   for (i = 0; i < t->npeers; i++)
415   {
416     if (NULL != t->disconnect_handler && t->peers[i]->connected)
417     {
418       GNUNET_PEER_resolve (t->peers[i]->id, &pi);
419       t->disconnect_handler (t->cls, &pi);
420     }
421     GNUNET_PEER_change_rc (t->peers[i]->id, -1);
422     GNUNET_free (t->peers[i]);
423   }
424   if (t->npeers > 0)
425     GNUNET_free (t->peers);
426   if (NULL != h->cleaner && 0 != t->owner)
427     h->cleaner (h->cls, t, t->ctx);
428   if (0 != t->owner)
429     GNUNET_PEER_change_rc (t->owner, -1);
430   if (0 != t->napps && t->apps)
431     GNUNET_free (t->apps);
432   GNUNET_free (t);
433   return;
434 }
435
436
437 /**
438  * Get the peer descriptor for the peer with id from the given tunnel
439  * @param t Tunnel handle
440  * @param id Short form ID of the wanted peer
441  * @return handle to the requested peer or NULL if not found
442  */
443 static struct GNUNET_MESH_Peer *
444 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
445 {
446   unsigned int i;
447
448   for (i = 0; i < t->npeers; i++)
449     if (t->peers[i]->id == id)
450       return t->peers[i];
451   return NULL;
452 }
453
454
455 /**
456  * Add a peer into a tunnel
457  * @param t Tunnel handle
458  * @param pi Full ID of the new peer
459  * @return handle to the newly created peer
460  */
461 static struct GNUNET_MESH_Peer *
462 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
463                     const struct GNUNET_PeerIdentity *pi)
464 {
465   struct GNUNET_MESH_Peer *p;
466   GNUNET_PEER_Id id;
467
468   if (0 != t->owner)
469   {
470     GNUNET_break (0);
471     return NULL;
472   }
473   id = GNUNET_PEER_intern (pi);
474
475   p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
476   p->id = id;
477   p->t = t;
478   GNUNET_array_append (t->peers, t->npeers, p);
479   return p;
480 }
481
482
483 /**
484  * Remove a peer from a tunnel
485  * @param p Peer handle
486  */
487 static void
488 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
489 {
490   unsigned int i;
491
492   for (i = 0; i < p->t->npeers; i++)
493   {
494     if (p->t->peers[i] == p)
495       break;
496   }
497   if (i == p->t->npeers)
498   {
499     GNUNET_break (0);
500     return;
501   }
502   p->t->peers[i] = p->t->peers[p->t->npeers - 1];
503   GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
504 }
505
506
507 /**
508  * Notify client that the transmission has timed out
509  * @param cls closure
510  * @param tc task context
511  */
512 static void
513 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
514 {
515   struct GNUNET_MESH_TransmitHandle *th = cls;
516   struct GNUNET_MESH_Handle *mesh;
517
518   mesh = th->tunnel->mesh;
519   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
520   if (th->notify != NULL)
521     th->notify (th->notify_cls, 0, NULL);
522   GNUNET_free (th);
523   if ((NULL == mesh->th_head) && (NULL != mesh->th))
524   {
525     /* queue empty, no point in asking for transmission */
526     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
527     mesh->th = NULL;
528   }
529 }
530
531
532 /**
533  * Add a transmit handle to the transmission queue by priority and set the
534  * timeout if needed.
535  *
536  * @param h mesh handle with the queue head and tail
537  * @param th handle to the packet to be transmitted
538  */
539 static void
540 add_to_queue (struct GNUNET_MESH_Handle *h,
541               struct GNUNET_MESH_TransmitHandle *th)
542 {
543   struct GNUNET_MESH_TransmitHandle *p;
544
545   p = h->th_head;
546   while ((NULL != p) && (th->priority <= p->priority))
547     p = p->next;
548   if (NULL == p)
549     p = h->th_tail;
550   else
551     p = p->prev;
552   GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
553   if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
554     return;
555   th->timeout_task =
556       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
557                                     (th->timeout), &timeout_transmission, th);
558 }
559
560
561 /**
562  * Auxiliary function to send an already constructed packet to the service.
563  * Takes care of creating a new queue element, copying the message and
564  * calling the tmt_rdy function if necessary.
565  * @param h mesh handle
566  * @param msg message to transmit
567  */
568 static void
569 send_packet (struct GNUNET_MESH_Handle *h,
570              const struct GNUNET_MessageHeader *msg);
571
572
573 /**
574  * Reconnect callback: tries to reconnect again after a failer previous
575  * reconnecttion
576  * @param cls closure (mesh handle)
577  * @param tc task context
578  */
579 static void
580 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
581
582
583 /**
584  * Send a connect packet to the service with the applications and types
585  * requested by the user.
586  *
587  * @param h The mesh handle.
588  *
589  */
590 static void
591 send_connect (struct GNUNET_MESH_Handle *h)
592 {
593   size_t size;
594
595   size = sizeof (struct GNUNET_MESH_ClientConnect);
596   size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
597   size += h->n_handlers * sizeof (uint16_t);
598   {
599     char buf[size];
600     struct GNUNET_MESH_ClientConnect *msg;
601     GNUNET_MESH_ApplicationType *apps;
602     uint16_t napps;
603     uint16_t *types;
604     uint16_t ntypes;
605
606     /* build connection packet */
607     msg = (struct GNUNET_MESH_ClientConnect *) buf;
608     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
609     msg->header.size = htons (size);
610     apps = (GNUNET_MESH_ApplicationType *) &msg[1];
611     for (napps = 0; napps < h->n_applications; napps++)
612     {
613       apps[napps] = htonl (h->applications[napps]);
614       LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:  app %u\n", h->applications[napps]);
615     }
616     types = (uint16_t *) & apps[napps];
617     for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
618       types[ntypes] = htons (h->message_handlers[ntypes].type);
619     msg->applications = htons (napps);
620     msg->types = htons (ntypes);
621 #if DEBUG
622     LOG (GNUNET_ERROR_TYPE_DEBUG,
623          "mesh: Sending %lu bytes long message %d types and %d apps\n",
624          ntohs (msg->header.size), ntypes, napps);
625 #endif
626     send_packet (h, &msg->header);
627   }
628 }
629
630
631 /**
632  * Reconnect to the service, retransmit all infomation to try to restore the
633  * original state.
634  *
635  * @param h handle to the mesh
636  *
637  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
638  */
639 static int
640 reconnect (struct GNUNET_MESH_Handle *h)
641 {
642   struct GNUNET_MESH_Tunnel *t;
643   unsigned int i;
644
645 #if DEBUG
646   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
647   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *******   RECONNECT   *******\n");
648   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
649 #endif
650   h->in_receive = GNUNET_NO;
651   /* disconnect */
652   if (NULL != h->th)
653   {
654     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
655   }
656   if (NULL != h->client)
657   {
658     GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
659   }
660
661   /* connect again */
662   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
663   if (h->client == NULL)
664   {
665     GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
666     h->reconnect_time =
667         GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
668                                   GNUNET_TIME_relative_multiply
669                                   (h->reconnect_time, 2));
670     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   Next retry in %sms\n",
671          GNUNET_TIME_relative_to_string (h->reconnect_time));
672     GNUNET_break (0);
673     return GNUNET_NO;
674   }
675   else
676   {
677     h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
678   }
679   send_connect (h);
680   /* Rebuild all tunnels */
681   for (t = h->tunnels_head; NULL != t; t = t->next)
682   {
683     struct GNUNET_MESH_TunnelMessage tmsg;
684     struct GNUNET_MESH_PeerControl pmsg;
685
686     tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
687     tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
688     tmsg.tunnel_id = htonl (t->tid);
689     send_packet (h, &tmsg.header);
690
691     pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
692     pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
693     pmsg.tunnel_id = htonl (t->tid);
694
695     /* Reconnect all peers */
696     for (i = 0; i < t->npeers; i++)
697     {
698       GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
699       if (NULL != t->disconnect_handler && t->peers[i]->connected)
700         t->disconnect_handler (t->cls, &pmsg.peer);
701       /* If the tunnel was "by type", dont connect individual peers */
702       if (0 == t->napps)
703         send_packet (t->mesh, &pmsg.header);
704     }
705     /* Reconnect all types, if any  */
706     for (i = 0; i < t->napps; i++)
707     {
708       struct GNUNET_MESH_ConnectPeerByType msg;
709
710       msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
711       msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
712       msg.tunnel_id = htonl (t->tid);
713       msg.type = htonl (t->apps[i]);
714       send_packet (t->mesh, &msg.header);
715     }
716   }
717   return GNUNET_YES;
718 }
719
720 /**
721  * Reconnect callback: tries to reconnect again after a failer previous
722  * reconnecttion
723  * @param cls closure (mesh handle)
724  * @param tc task context
725  */
726 static void
727 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
728 {
729   struct GNUNET_MESH_Handle *h = cls;
730
731   if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
732     return;
733   reconnect (h);
734 }
735
736
737 /******************************************************************************/
738 /***********************      RECEIVE HANDLERS     ****************************/
739 /******************************************************************************/
740
741 /**
742  * Process the new tunnel notification and add it to the tunnels in the handle
743  *
744  * @param h     The mesh handle
745  * @param msg   A message with the details of the new incoming tunnel
746  */
747 static void
748 process_tunnel_created (struct GNUNET_MESH_Handle *h,
749                         const struct GNUNET_MESH_TunnelNotification *msg)
750 {
751   struct GNUNET_MESH_Tunnel *t;
752   struct GNUNET_TRANSPORT_ATS_Information atsi;
753   MESH_TunnelNumber tid;
754
755   tid = ntohl (msg->tunnel_id);
756   if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
757   {
758     GNUNET_break (0);
759     return;
760   }
761   t = create_tunnel (h, tid);
762   t->owner = GNUNET_PEER_intern (&msg->peer);
763   t->npeers = 1;
764   t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
765   t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
766   t->peers[0]->t = t;
767   t->peers[0]->connected = 1;
768   t->peers[0]->id = t->owner;
769   t->mesh = h;
770   t->tid = tid;
771   if (NULL != h->new_tunnel)
772   {
773     atsi.type = 0;
774     atsi.value = 0;
775     t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
776   }
777   return;
778 }
779
780
781 /**
782  * Process the tunnel destroy notification and free associated resources
783  *
784  * @param h     The mesh handle
785  * @param msg   A message with the details of the tunnel being destroyed
786  */
787 static void
788 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
789                         const struct GNUNET_MESH_TunnelMessage *msg)
790 {
791   struct GNUNET_MESH_Tunnel *t;
792   MESH_TunnelNumber tid;
793
794   tid = ntohl (msg->tunnel_id);
795   t = retrieve_tunnel (h, tid);
796
797   if (NULL == t)
798   {
799     GNUNET_break (0);
800     return;
801   }
802   if (0 == t->owner)
803   {
804     GNUNET_break (0);
805   }
806
807   destroy_tunnel (t);
808   return;
809 }
810
811
812 /**
813  * Process the new peer event and notify the upper level of it
814  *
815  * @param h     The mesh handle
816  * @param msg   A message with the details of the peer event
817  */
818 static void
819 process_peer_event (struct GNUNET_MESH_Handle *h,
820                     const struct GNUNET_MESH_PeerControl *msg)
821 {
822   struct GNUNET_MESH_Tunnel *t;
823   struct GNUNET_MESH_Peer *p;
824   struct GNUNET_TRANSPORT_ATS_Information atsi;
825   GNUNET_PEER_Id id;
826   uint16_t size;
827
828   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
829   size = ntohs (msg->header.size);
830   if (size != sizeof (struct GNUNET_MESH_PeerControl))
831   {
832     GNUNET_break (0);
833     return;
834   }
835   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
836   if (NULL == t)
837   {
838     GNUNET_break (0);
839     return;
840   }
841   id = GNUNET_PEER_search (&msg->peer);
842   if ((p = retrieve_peer (t, id)) == NULL)
843     p = add_peer_to_tunnel (t, &msg->peer);
844   if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
845   {
846     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
847     if (NULL != t->connect_handler)
848     {
849       atsi.type = 0;
850       atsi.value = 0;
851       t->connect_handler (t->cls, &msg->peer, &atsi);
852     }
853     p->connected = 1;
854   }
855   else
856   {
857     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
858     if (NULL != t->disconnect_handler && p->connected)
859     {
860       t->disconnect_handler (t->cls, &msg->peer);
861     }
862     remove_peer_from_tunnel (p);
863     GNUNET_free (p);
864   }
865   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
866 }
867
868
869 /**
870  * Process the incoming data packets
871  *
872  * @param h         The mesh handle
873  * @param message   A message encapsulating the data
874  */
875 static void
876 process_incoming_data (struct GNUNET_MESH_Handle *h,
877                        const struct GNUNET_MessageHeader *message)
878 {
879   const struct GNUNET_MessageHeader *payload;
880   const struct GNUNET_MESH_MessageHandler *handler;
881   const struct GNUNET_PeerIdentity *peer;
882   struct GNUNET_MESH_Unicast *ucast;
883   struct GNUNET_MESH_Multicast *mcast;
884   struct GNUNET_MESH_ToOrigin *to_orig;
885   struct GNUNET_MESH_Tunnel *t;
886   unsigned int i;
887   uint16_t type;
888
889
890   type = ntohs (message->type);
891   switch (type)
892   {
893   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
894     ucast = (struct GNUNET_MESH_Unicast *) message;
895     t = retrieve_tunnel (h, ntohl (ucast->tid));
896     payload = (struct GNUNET_MessageHeader *) &ucast[1];
897     peer = &ucast->oid;
898     break;
899   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
900     mcast = (struct GNUNET_MESH_Multicast *) message;
901     t = retrieve_tunnel (h, ntohl (mcast->tid));
902     payload = (struct GNUNET_MessageHeader *) &mcast[1];
903     peer = &mcast->oid;
904     break;
905   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
906     to_orig = (struct GNUNET_MESH_ToOrigin *) message;
907     t = retrieve_tunnel (h, ntohl (to_orig->tid));
908     payload = (struct GNUNET_MessageHeader *) &to_orig[1];
909     peer = &to_orig->sender;
910     break;
911   default:
912     GNUNET_break (0);
913     return;
914   }
915   if (NULL == t)
916   {
917     GNUNET_break (0);
918     return;
919   }
920   type = ntohs (payload->type);
921   for (i = 0; i < h->n_handlers; i++)
922   {
923     handler = &h->message_handlers[i];
924     if (handler->type == type)
925     {
926       struct GNUNET_TRANSPORT_ATS_Information atsi;
927
928       atsi.type = 0;
929       atsi.value = 0;
930       if (GNUNET_OK !=
931           handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
932       {
933         LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
934         GNUNET_MESH_disconnect (h);
935         return;
936       }
937 #if DEBUG
938       else
939       {
940         LOG (GNUNET_ERROR_TYPE_DEBUG,
941              "MESH: callback completed successfully\n");
942
943       }
944 #endif
945     }
946   }
947 }
948
949
950 /**
951  * Function to process all messages received from the service
952  *
953  * @param cls closure
954  * @param msg message received, NULL on timeout or fatal error
955  */
956 static void
957 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
958 {
959   struct GNUNET_MESH_Handle *h = cls;
960
961   if (msg == NULL)
962   {
963     reconnect (h);
964     return;
965   }
966   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
967        ntohs (msg->type));
968   switch (ntohs (msg->type))
969   {
970     /* Notify of a new incoming tunnel */
971   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
972     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
973     break;
974     /* Notify of a tunnel disconnection */
975   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
976     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
977     break;
978     /* Notify of a new peer or a peer disconnect in the tunnel */
979   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
980   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
981     process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
982     break;
983     /* Notify of a new data packet in the tunnel */
984   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
985   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
986   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
987     process_incoming_data (h, msg);
988     break;
989     /* We shouldn't get any other packages, log and ignore */
990   default:
991     LOG (GNUNET_ERROR_TYPE_WARNING,
992          "MESH: unsolicited message form service (type %d)\n",
993          ntohs (msg->type));
994   }
995   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
996   GNUNET_CLIENT_receive (h->client, &msg_received, h,
997                          GNUNET_TIME_UNIT_FOREVER_REL);
998 }
999
1000
1001 /******************************************************************************/
1002 /************************       SEND FUNCTIONS     ****************************/
1003 /******************************************************************************/
1004
1005 /**
1006  * Function called to send a message to the service.
1007  * "buf" will be NULL and "size" zero if the socket was closed for writing in
1008  * the meantime.
1009  *
1010  * @param cls closure, the mesh handle
1011  * @param size number of bytes available in buf
1012  * @param buf where the callee should write the connect message
1013  * @return number of bytes written to buf
1014  */
1015 static size_t
1016 send_callback (void *cls, size_t size, void *buf)
1017 {
1018   struct GNUNET_MESH_Handle *h = cls;
1019   struct GNUNET_MESH_TransmitHandle *th;
1020   char *cbuf = buf;
1021   size_t tsize;
1022   size_t psize;
1023
1024   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1025   h->th = NULL;
1026   if ((0 == size) || (NULL == buf))
1027   {
1028     reconnect (h);
1029     return 0;
1030   }
1031   tsize = 0;
1032   while ((NULL != (th = h->th_head)) && (size >= th->size))
1033   {
1034 #if DEBUG
1035     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:     type: %u\n",
1036          ntohs (((struct GNUNET_MessageHeader *) &th[1])->type));
1037     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:     size: %u\n",
1038          ntohs (((struct GNUNET_MessageHeader *) &th[1])->size));
1039 #endif
1040     if (NULL != th->notify)
1041     {
1042       if (th->target == 0)
1043       {
1044         /* multicast */
1045         struct GNUNET_MESH_Multicast mc;
1046
1047         GNUNET_assert (size >= sizeof (mc) + th->size);
1048         psize =
1049             th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
1050         if (psize > 0)
1051         {
1052           mc.header.size = htons (sizeof (mc) + th->size);
1053           mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1054           mc.tid = htonl (th->tunnel->tid);
1055           memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1056           memcpy (cbuf, &mc, sizeof (mc));
1057           psize = th->size + sizeof (mc);
1058         }
1059       }
1060       else
1061       {
1062         /* unicast */
1063         struct GNUNET_MESH_Unicast uc;
1064
1065         GNUNET_assert (size >= sizeof (uc) + th->size);
1066         psize =
1067             th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
1068         if (psize > 0)
1069         {
1070           uc.header.size = htons (sizeof (uc) + th->size);
1071           uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1072           uc.tid = htonl (th->tunnel->tid);
1073           memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1074           GNUNET_PEER_resolve (th->target, &uc.destination);
1075           memcpy (cbuf, &uc, sizeof (uc));
1076           psize = th->size + sizeof (uc);
1077         }
1078       }
1079     }
1080     else
1081     {
1082       memcpy (cbuf, &th[1], th->size);
1083       psize = th->size;
1084     }
1085     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1086       GNUNET_SCHEDULER_cancel (th->timeout_task);
1087     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1088     GNUNET_free (th);
1089     cbuf += psize;
1090     size -= psize;
1091     tsize += psize;
1092   }
1093   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   total size: %u\n", tsize);
1094   if (NULL != (th = h->th_head))
1095   {
1096     LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh:   next size: %u\n", th->size);
1097     h->th =
1098         GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1099                                              GNUNET_TIME_UNIT_FOREVER_REL,
1100                                              GNUNET_YES, &send_callback, h);
1101   }
1102   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1103   if (GNUNET_NO == h->in_receive)
1104   {
1105     h->in_receive = GNUNET_YES;
1106     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1107                            GNUNET_TIME_UNIT_FOREVER_REL);
1108   }
1109   return tsize;
1110 }
1111
1112
1113 /**
1114  * Auxiliary function to send an already constructed packet to the service.
1115  * Takes care of creating a new queue element, copying the message and
1116  * calling the tmt_rdy function if necessary.
1117  * @param h mesh handle
1118  * @param msg message to transmit
1119  */
1120 static void
1121 send_packet (struct GNUNET_MESH_Handle *h,
1122              const struct GNUNET_MessageHeader *msg)
1123 {
1124   struct GNUNET_MESH_TransmitHandle *th;
1125   size_t msize;
1126
1127   msize = ntohs (msg->size);
1128   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1129   th->priority = UINT32_MAX;
1130   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1131   th->size = msize;
1132   memcpy (&th[1], msg, msize);
1133   add_to_queue (h, th);
1134   if (NULL != h->th)
1135     return;
1136   h->th =
1137       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1138                                            GNUNET_TIME_UNIT_FOREVER_REL,
1139                                            GNUNET_YES, &send_callback, h);
1140 }
1141
1142
1143 /******************************************************************************/
1144 /**********************      API CALL DEFINITIONS     *************************/
1145 /******************************************************************************/
1146
1147 /**
1148  * Connect to the mesh service.
1149  *
1150  * @param cfg configuration to use
1151  * @param queue_size size of the data message queue, shared among all tunnels
1152  *                   (each tunnel is guaranteed to accept at least one message,
1153  *                    no matter what is the status of other tunnels)
1154  * @param cls closure for the various callbacks that follow
1155  *            (including handlers in the handlers array)
1156  * @param new_tunnel function called when an *inbound* tunnel is created
1157  * @param cleaner function called when an *inbound* tunnel is destroyed
1158  * @param handlers callbacks for messages we care about, NULL-terminated
1159  *                note that the mesh is allowed to drop notifications about
1160  *                inbound messages if the client does not process them fast
1161  *                enough (for this notification type, a bounded queue is used)
1162  * @param stypes list of the applications that this client claims to provide
1163  * @return handle to the mesh service NULL on error
1164  *         (in this case, init is never called)
1165  */
1166 struct GNUNET_MESH_Handle *
1167 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1168                      unsigned int queue_size, void *cls,
1169                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1170                      GNUNET_MESH_TunnelEndHandler cleaner,
1171                      const struct GNUNET_MESH_MessageHandler *handlers,
1172                      const GNUNET_MESH_ApplicationType *stypes)
1173 {
1174   struct GNUNET_MESH_Handle *h;
1175
1176   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1177   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1178   h->cfg = cfg;
1179   h->max_queue_size = queue_size;
1180   h->new_tunnel = new_tunnel;
1181   h->cleaner = cleaner;
1182   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1183   if (h->client == NULL)
1184   {
1185     GNUNET_break (0);
1186     GNUNET_free (h);
1187     return NULL;
1188   }
1189   h->cls = cls;
1190   /* FIXME memdup? */
1191   h->applications = stypes;
1192   h->message_handlers = handlers;
1193   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1194   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1195
1196   /* count handlers and apps, calculate size */
1197   for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1198   for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1199   send_connect (h);
1200   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1201   return h;
1202 }
1203
1204
1205 /**
1206  * Disconnect from the mesh service.
1207  *
1208  * @param handle connection to mesh to disconnect
1209  */
1210 void
1211 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1212 {
1213   struct GNUNET_MESH_Tunnel *t;
1214   struct GNUNET_MESH_Tunnel *aux;
1215
1216   t = handle->tunnels_head;
1217   while (NULL != t)
1218   {
1219     aux = t->next;
1220     destroy_tunnel (t);
1221     t = aux;
1222   }
1223   if (NULL != handle->th)
1224   {
1225     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1226   }
1227   if (NULL != handle->client)
1228   {
1229     GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1230   }
1231   GNUNET_free (handle);
1232 }
1233
1234
1235 /**
1236  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1237  * and to broadcast).
1238  *
1239  * @param h mesh handle
1240  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1241  * @param connect_handler function to call when peers are actually connected
1242  * @param disconnect_handler function to call when peers are disconnected
1243  * @param handler_cls closure for connect/disconnect handlers
1244  */
1245 struct GNUNET_MESH_Tunnel *
1246 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1247                            GNUNET_MESH_PeerConnectHandler connect_handler,
1248                            GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1249                            void *handler_cls)
1250 {
1251   struct GNUNET_MESH_Tunnel *t;
1252   struct GNUNET_MESH_TunnelMessage msg;
1253
1254   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1255   t = create_tunnel (h, 0);
1256   t->connect_handler = connect_handler;
1257   t->disconnect_handler = disconnect_handler;
1258   t->cls = handler_cls;
1259   t->ctx = tunnel_ctx;
1260   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1261   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1262   msg.tunnel_id = htonl (t->tid);
1263   send_packet (h, &msg.header);
1264   return t;
1265 }
1266
1267
1268 /**
1269  * Destroy an existing tunnel.
1270  *
1271  * @param tun tunnel handle
1272  */
1273 void
1274 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1275 {
1276   struct GNUNET_MESH_Handle *h;
1277   struct GNUNET_MESH_TunnelMessage msg;
1278
1279   LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1280   h = tunnel->mesh;
1281
1282   if (0 != tunnel->owner)
1283     GNUNET_PEER_change_rc (tunnel->owner, -1);
1284
1285   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1286   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1287   msg.tunnel_id = htonl (tunnel->tid);
1288   destroy_tunnel (tunnel);
1289   send_packet (h, &msg.header);
1290 }
1291
1292
1293 /**
1294  * Request that a peer should be added to the tunnel.  The existing
1295  * connect handler will be called ONCE with either success or failure.
1296  * This function should NOT be called again with the same peer before the
1297  * connect handler is called.
1298  *
1299  * @param tunnel handle to existing tunnel
1300  * @param peer peer to add
1301  */
1302 void
1303 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1304                                       const struct GNUNET_PeerIdentity *peer)
1305 {
1306   struct GNUNET_MESH_PeerControl msg;
1307   GNUNET_PEER_Id peer_id;
1308   unsigned int i;
1309
1310   peer_id = GNUNET_PEER_intern (peer);
1311   for (i = 0; i < tunnel->npeers; i++)
1312   {
1313     if (tunnel->peers[i]->id == peer_id)
1314     {
1315       GNUNET_PEER_change_rc (peer_id, -1);
1316       GNUNET_break (0);
1317       return;
1318     }
1319   }
1320   if (NULL == add_peer_to_tunnel (tunnel, peer))
1321     return;
1322
1323   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1324   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1325   msg.tunnel_id = htonl (tunnel->tid);
1326   msg.peer = *peer;
1327   send_packet (tunnel->mesh, &msg.header);
1328
1329   return;
1330 }
1331
1332
1333 /**
1334  * Request that a peer should be removed from the tunnel.  The existing
1335  * disconnect handler will be called ONCE if we were connected.
1336  *
1337  * @param tunnel handle to existing tunnel
1338  * @param peer peer to remove
1339  */
1340 void
1341 GNUNET_MESH_peer_request_connect_del (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_search (peer);
1349   if (0 == peer_id)
1350   {
1351     GNUNET_break (0);
1352     return;
1353   }
1354   for (i = 0; i < tunnel->npeers; i++)
1355     if (tunnel->peers[i]->id == peer_id)
1356       break;
1357   if (i == tunnel->npeers)
1358   {
1359     GNUNET_break (0);
1360     return;
1361   }
1362   if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1363     tunnel->disconnect_handler (tunnel->cls, peer);
1364   GNUNET_PEER_change_rc (peer_id, -1);
1365   GNUNET_free (tunnel->peers[i]);
1366   tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1367   GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1368
1369   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1370   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1371   msg.tunnel_id = htonl (tunnel->tid);
1372   memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1373   send_packet (tunnel->mesh, &msg.header);
1374 }
1375
1376
1377 /**
1378  * Request that the mesh should try to connect to a peer supporting the given
1379  * message type.
1380  *
1381  * @param tunnel handle to existing tunnel
1382  * @param app_type application type that must be supported by the peer (MESH
1383  *                 should discover peer in proximity handling this type)
1384  */
1385 void
1386 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1387                                           GNUNET_MESH_ApplicationType app_type)
1388 {
1389   struct GNUNET_MESH_ConnectPeerByType msg;
1390
1391   GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1392
1393   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1394   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1395   msg.tunnel_id = htonl (tunnel->tid);
1396   msg.type = htonl (app_type);
1397   send_packet (tunnel->mesh, &msg.header);
1398 }
1399
1400
1401 /**
1402  * Ask the mesh to call "notify" once it is ready to transmit the
1403  * given number of bytes to the specified "target".  If we are not yet
1404  * connected to the specified peer, a call to this function will cause
1405  * us to try to establish a connection.
1406  *
1407  * @param tunnel tunnel to use for transmission
1408  * @param cork is corking allowed for this transmission?
1409  * @param priority how important is the message?
1410  * @param maxdelay how long can the message wait?
1411  * @param target destination for the message,
1412  *               NULL for multicast to all tunnel targets
1413  * @param notify_size how many bytes of buffer space does notify want?
1414  * @param notify function to call when buffer space is available;
1415  *        will be called with NULL on timeout or if the overall queue
1416  *        for this peer is larger than queue_size and this is currently
1417  *        the message with the lowest priority
1418  * @param notify_cls closure for notify
1419  * @return non-NULL if the notify callback was queued,
1420  *         NULL if we can not even queue the request (insufficient
1421  *         memory); if NULL is returned, "notify" will NOT be called.
1422  */
1423 struct GNUNET_MESH_TransmitHandle *
1424 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1425                                    uint32_t priority,
1426                                    struct GNUNET_TIME_Relative maxdelay,
1427                                    const struct GNUNET_PeerIdentity *target,
1428                                    size_t notify_size,
1429                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1430                                    void *notify_cls)
1431 {
1432   struct GNUNET_MESH_TransmitHandle *th;
1433   struct GNUNET_MESH_TransmitHandle *least_priority_th;
1434   uint32_t least_priority;
1435   size_t overhead;
1436
1437   GNUNET_assert (NULL != notify);
1438   if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1439       tunnel->npackets > 0)
1440   {
1441     /* queue full */
1442     if (0 == priority)
1443       return NULL;
1444     th = tunnel->mesh->th_tail;
1445     least_priority = priority;
1446     least_priority_th = NULL;
1447     while (NULL != th)
1448     {
1449       if (th->priority < least_priority && th->tunnel->npackets > 1)
1450       {
1451         least_priority_th = th;
1452         least_priority = th->priority;
1453       }
1454       th = th->prev;
1455     }
1456     if (NULL == least_priority_th)
1457       return NULL;
1458     /* Can't be a control message */
1459     GNUNET_assert (NULL != least_priority_th->notify);
1460     least_priority_th->notify (notify_cls, 0, NULL);
1461     least_priority_th->tunnel->npackets--;
1462     tunnel->mesh->npackets--;
1463     GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1464                                  least_priority_th);
1465     if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1466       GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1467     GNUNET_free (least_priority_th);
1468   }
1469   tunnel->npackets++;
1470   tunnel->mesh->npackets++;
1471   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1472   th->tunnel = tunnel;
1473   th->priority = priority;
1474   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1475   th->target = GNUNET_PEER_intern (target);
1476   if (NULL == target)
1477     overhead = sizeof (struct GNUNET_MESH_Multicast);
1478   else
1479     overhead = sizeof (struct GNUNET_MESH_Unicast);
1480   th->size = notify_size + overhead;
1481   th->notify = notify;
1482   th->notify_cls = notify_cls;
1483   add_to_queue (tunnel->mesh, th);
1484   return th;
1485 }
1486
1487
1488 /**
1489  * Cancel the specified transmission-ready notification.
1490  *
1491  * @param th handle that was returned by "notify_transmit_ready".
1492  */
1493 void
1494 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1495 {
1496   struct GNUNET_MESH_Handle *mesh;
1497
1498   mesh = th->tunnel->mesh;
1499   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1500     GNUNET_SCHEDULER_cancel (th->timeout_task);
1501   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1502   GNUNET_free (th);
1503   if ((NULL == mesh->th_head) && (NULL != mesh->th))
1504   {
1505     /* queue empty, no point in asking for transmission */
1506     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1507     mesh->th = NULL;
1508   }
1509 }
1510
1511
1512 #if 0                           /* keep Emacsens' auto-indent happy */
1513 {
1514 #endif
1515 #ifdef __cplusplus
1516 }
1517 #endif