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