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