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