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  * TODO:
  24  * - callbacks to client missing on certain events
  25  * - processing messages from service is incomplete
  26  * - Use separate message types for tunnel creation s -> c (+pi) and c -> s
  27  *
  28  * STRUCTURE:
  29  * - CONSTANTS
  30  * - DATA STRUCTURES
  31  * - AUXILIARY FUNCTIONS
  32  * - RECEIVE HANDLERS
  33  * - SEND FUNCTIONS
  34  * - API CALL DEFINITIONS
  35  */
  36 #ifdef __cplusplus
  37 extern "C"
  38 {
  39 #if 0                           /* keep Emacsens' auto-indent happy */
  40 }
  41 #endif
  42 #endif
  43
  44 #include "platform.h"
  45 #include "gnunet_common.h"
  46 #include "gnunet_client_lib.h"
  47 #include "gnunet_util_lib.h"
  48 #include "gnunet_peer_lib.h"
  49 #include "gnunet_mesh_service_new.h"
  50 #include "mesh.h"
  51 #include "mesh_protocol.h"
  52
  53 #define DEBUG GNUNET_YES
  54
  55 /******************************************************************************/
  56 /************************      DATA STRUCTURES     ****************************/
  57 /******************************************************************************/
  58
  59 /**
  60  * Transmission queue to the service
  61  */
  62 struct GNUNET_MESH_TransmitHandle
  63 {
  64
  65     /**
  66      * Double Linked list
  67      */
  68   struct GNUNET_MESH_TransmitHandle *next;
  69
  70     /**
  71      * Double Linked list
  72      */
  73   struct GNUNET_MESH_TransmitHandle *prev;
  74
  75     /**
  76      * Tunnel this message is sent over (may be NULL for control messages).
  77      */
  78   struct GNUNET_MESH_Tunnel *tunnel;
  79
  80     /**
  81      * Callback to obtain the message to transmit, or NULL if we
  82      * got the message in 'data'.  Notice that messages built
  83      * by 'notify' need to be encapsulated with information about
  84      * the 'target'.
  85      */
  86   GNUNET_CONNECTION_TransmitReadyNotify notify;
  87
  88     /**
  89      * Closure for 'notify'
  90      */
  91   void *notify_cls;
  92
  93     /**
  94      * How long is this message valid.  Once the timeout has been
  95      * reached, the message must no longer be sent.  If this
  96      * is a message with a 'notify' callback set, the 'notify'
  97      * function should be called with 'buf' NULL and size 0.
  98      */
  99   struct GNUNET_TIME_Absolute timeout;
 100
 101     /**
 102      * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
 103      */
 104   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 105
 106     /**
 107      * Priority of the message.  The queue is sorted by priority,
 108      * control messages have the maximum priority (UINT32_MAX).
 109      */
 110   uint32_t priority;
 111
 112     /**
 113      * Target of the message, 0 for broadcast.  This field
 114      * is only valid if 'notify' is non-NULL.
 115      */
 116   GNUNET_PEER_Id target;
 117
 118     /**
 119      * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
 120      */
 121   size_t size;
 122 };
 123
 124
 125 /**
 126  * Opaque handle to the service.
 127  */
 128 struct GNUNET_MESH_Handle
 129 {
 130
 131     /**
 132      * Handle to the server connection, to send messages later
 133      */
 134   struct GNUNET_CLIENT_Connection *client;
 135
 136     /**
 137      * Set of handlers used for processing incoming messages in the tunnels
 138      */
 139   const struct GNUNET_MESH_MessageHandler *message_handlers;
 140
 141     /**
 142      * Set of applications that should be claimed to be offered at this node.
 143      * Note that this is just informative, the appropiate handlers must be
 144      * registered independently and the mapping is up to the developer of the
 145      * client application.
 146      */
 147   const GNUNET_MESH_ApplicationType *applications;
 148
 149     /**
 150      * Double linked list of the tunnels this client is connected to.
 151      */
 152   struct GNUNET_MESH_Tunnel *tunnels_head;
 153   struct GNUNET_MESH_Tunnel *tunnels_tail;
 154
 155     /**
 156      * Callback for inbound tunnel creation
 157      */
 158   GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
 159
 160     /**
 161      * Callback for inbound tunnel disconnection
 162      */
 163   GNUNET_MESH_TunnelEndHandler *cleaner;
 164
 165     /**
 166      * Handle to cancel pending transmissions in case of disconnection
 167      */
 168   struct GNUNET_CLIENT_TransmitHandle *th;
 169
 170     /**
 171      * Closure for all the handlers given by the client
 172      */
 173   void *cls;
 174
 175     /**
 176      * Messages to send to the service
 177      */
 178   struct GNUNET_MESH_TransmitHandle *th_head;
 179   struct GNUNET_MESH_TransmitHandle *th_tail;
 180
 181     /**
 182      * tid of the next tunnel to create (to avoid reusing IDs often)
 183      */
 184   MESH_TunnelNumber next_tid;
 185   unsigned int n_handlers;
 186   unsigned int n_applications;
 187   unsigned int max_queue_size;
 188
 189     /**
 190      * Have we started the task to receive messages from the service
 191      * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
 192      */
 193   int in_receive;
 194
 195     /**
 196      * Number of packets queued
 197      */
 198   unsigned int npackets;
 199
 200   /**
 201    * Configuration given by the client, in case of reconnection
 202    */
 203   const struct GNUNET_CONFIGURATION_Handle *cfg;
 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 static void
 560 send_packet (struct GNUNET_MESH_Handle *h,
 561              const struct GNUNET_MessageHeader *msg);
 562
 563
 564 /**
 565  * Reconnect to the service, retransmit all infomation to try to restore the
 566  * original state.
 567  *
 568  * @param h handle to the mesh
 569  *
 570  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
 571  */
 572 static int
 573 reconnect (struct GNUNET_MESH_Handle *h)
 574 {
 575   struct GNUNET_MESH_Tunnel *t;
 576   unsigned int i;
 577
 578   h->in_receive = GNUNET_NO;
 579   /* disconnect */
 580   if (NULL != h->th)
 581   {
 582     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 583   }
 584   if (NULL != h->client)
 585   {
 586     GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
 587   }
 588
 589   /* connect again */
 590   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
 591   if (h->client == NULL)
 592   {
 593     /* FIXME: panic? exponential backoff retry? */
 594     GNUNET_break (0);
 595     return GNUNET_NO;
 596   }
 597   /* Rebuild all tunnels */
 598   for (t = h->tunnels_head; NULL != t; t = t->next)
 599   {
 600     struct GNUNET_MESH_TunnelMessage tmsg;
 601     struct GNUNET_MESH_PeerControl pmsg;
 602
 603     tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
 604     tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
 605     tmsg.tunnel_id = htonl (t->tid);
 606     send_packet (h, &tmsg.header);
 607
 608     pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
 609     pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
 610     pmsg.tunnel_id = htonl (t->tid);
 611
 612     /* Reconnect all peers */
 613     for (i = 0; i < t->npeers; i++)
 614     {
 615       GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
 616       if (NULL != t->disconnect_handler && t->peers[i]->connected)
 617         t->disconnect_handler (t->cls, &pmsg.peer);
 618       /* If the tunnel was "by type", dont connect individual peers */
 619       if (0 == t->napps)
 620         send_packet (t->mesh, &pmsg.header);
 621     }
 622     /* Reconnect all types, if any  */
 623     for (i = 0; i < t->napps; i++)
 624     {
 625       struct GNUNET_MESH_ConnectPeerByType msg;
 626
 627       msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
 628       msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
 629       msg.tunnel_id = htonl (t->tid);
 630       msg.type = htonl (t->apps[i]);
 631       send_packet (t->mesh, &msg.header);
 632     }
 633   }
 634   return GNUNET_YES;
 635 }
 636
 637
 638 /******************************************************************************/
 639 /***********************      RECEIVE HANDLERS     ****************************/
 640 /******************************************************************************/
 641
 642 /**
 643  * Process the new tunnel notification and add it to the tunnels in the handle
 644  *
 645  * @param h     The mesh handle
 646  * @param msg   A message with the details of the new incoming tunnel
 647  */
 648 static void
 649 process_tunnel_create (struct GNUNET_MESH_Handle *h,
 650                        const struct GNUNET_MESH_TunnelMessage *msg)
 651 {
 652   struct GNUNET_MESH_Tunnel *t;
 653   struct GNUNET_TRANSPORT_ATS_Information atsi;
 654   MESH_TunnelNumber tid;
 655
 656   tid = ntohl (msg->tunnel_id);
 657   if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
 658   {
 659     GNUNET_break (0);
 660     return;
 661   }
 662   t = create_tunnel (h, tid);
 663   t->owner = GNUNET_PEER_intern (&msg->peer);
 664   t->npeers = 1;
 665   t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
 666   t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
 667   t->peers[0]->t = t;
 668   t->peers[0]->connected = 1;
 669   t->peers[0]->id = t->owner;
 670   t->mesh = h;
 671   t->tid = tid;
 672   if (NULL != h->new_tunnel)
 673   {
 674     atsi.type = 0;
 675     atsi.value = 0;
 676     t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
 677   }
 678   GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
 679   return;
 680 }
 681
 682
 683 /**
 684  * Process the tunnel destroy notification and free associated resources
 685  *
 686  * @param h     The mesh handle
 687  * @param msg   A message with the details of the tunnel being destroyed
 688  */
 689 static void
 690 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
 691                         const struct GNUNET_MESH_TunnelMessage *msg)
 692 {
 693   struct GNUNET_MESH_Tunnel *t;
 694   MESH_TunnelNumber tid;
 695
 696   tid = ntohl (msg->tunnel_id);
 697   t = retrieve_tunnel (h, tid);
 698
 699   if (NULL == t)
 700   {
 701     GNUNET_break(0);
 702     return;
 703   }
 704   if (0 == t->owner)
 705   {
 706     GNUNET_break(0);
 707   }
 708
 709   destroy_tunnel(t);
 710   return;
 711 }
 712
 713
 714 /**
 715  * Process the new peer event and notify the upper level of it
 716  *
 717  * @param h     The mesh handle
 718  * @param msg   A message with the details of the peer event
 719  */
 720 static void
 721 process_peer_event (struct GNUNET_MESH_Handle *h,
 722                     const struct GNUNET_MESH_PeerControl *msg)
 723 {
 724   struct GNUNET_MESH_Tunnel *t;
 725   struct GNUNET_MESH_Peer *p;
 726   struct GNUNET_TRANSPORT_ATS_Information atsi;
 727   GNUNET_PEER_Id id;
 728   uint16_t size;
 729
 730   size = ntohs (msg->header.size);
 731   if (size != sizeof (struct GNUNET_MESH_PeerControl))
 732   {
 733     GNUNET_break (0);
 734     return;
 735   }
 736   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
 737   if (NULL == t)
 738   {
 739     GNUNET_break(0);
 740     return;
 741   }
 742   id = GNUNET_PEER_search (&msg->peer);
 743   if ((p = retrieve_peer (t, id)) == NULL)
 744     p = add_peer_to_tunnel (t, &msg->peer);
 745   if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
 746   {
 747     if (NULL != t->connect_handler)
 748     {
 749       atsi.type = 0;
 750       atsi.value = 0;
 751       t->connect_handler (t->cls, &msg->peer, &atsi);
 752     }
 753     p->connected = 1;
 754   }
 755   else
 756   {
 757     if (NULL != t->disconnect_handler && p->connected)
 758     {
 759       t->disconnect_handler (t->cls, &msg->peer);
 760     }
 761     remove_peer_from_tunnel (p);
 762     GNUNET_free (p);
 763   }
 764 }
 765
 766
 767 /**
 768  * Process the incoming data packets
 769  *
 770  * @param h     The mesh handle
 771  * @param msh   A message encapsulating the data
 772  */
 773 static void
 774 process_incoming_data (struct GNUNET_MESH_Handle *h,
 775                        const struct GNUNET_MessageHeader *message)
 776 {
 777   const struct GNUNET_MessageHeader *payload;
 778   const struct GNUNET_MESH_MessageHandler *handler;
 779   const struct GNUNET_PeerIdentity *peer;
 780   struct GNUNET_MESH_Unicast *ucast;
 781   struct GNUNET_MESH_Multicast *mcast;
 782   struct GNUNET_MESH_ToOrigin *to_orig;
 783   struct GNUNET_MESH_Tunnel *t;
 784   uint16_t type;
 785   int i;
 786
 787   type = ntohs (message->type);
 788   switch (type)
 789   {
 790   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
 791     ucast = (struct GNUNET_MESH_Unicast *) message;
 792     t = retrieve_tunnel (h, ntohl (ucast->tid));
 793     payload = (struct GNUNET_MessageHeader *) &ucast[1];
 794     peer = &ucast->oid;
 795     break;
 796   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
 797     mcast = (struct GNUNET_MESH_Multicast *) message;
 798     t = retrieve_tunnel (h, ntohl (mcast->tid));
 799     payload = (struct GNUNET_MessageHeader *) &mcast[1];
 800     peer = &mcast->oid;
 801     break;
 802   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
 803     to_orig = (struct GNUNET_MESH_ToOrigin *) message;
 804     t = retrieve_tunnel (h, ntohl (to_orig->tid));
 805     payload = (struct GNUNET_MessageHeader *) &to_orig[1];
 806     peer = &to_orig->sender;
 807     break;
 808   default:
 809     GNUNET_break (0);
 810     return;
 811   }
 812   if (NULL == t)
 813   {
 814     GNUNET_break (0);
 815     return;
 816   }
 817   for (i = 0; i < h->n_handlers; i++)
 818   {
 819     handler = &h->message_handlers[i];
 820     if (handler->type == type)
 821     {
 822       struct GNUNET_TRANSPORT_ATS_Information atsi;
 823
 824       atsi.type = 0;
 825       atsi.value = 0;
 826       if (GNUNET_OK ==
 827           handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
 828       {
 829         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 830                     "MESH: callback completed successfully\n");
 831       }
 832       else
 833       {
 834         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 835                     "MESH: callback caused disconnection\n");
 836         GNUNET_MESH_disconnect (h);
 837       }
 838     }
 839   }
 840 }
 841
 842
 843 /**
 844  * Function to process all messages received from the service
 845  *
 846  * @param cls closure
 847  * @param msg message received, NULL on timeout or fatal error
 848  */
 849 static void
 850 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
 851 {
 852   struct GNUNET_MESH_Handle *h = cls;
 853
 854   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
 855   if (msg == NULL)
 856   {
 857     reconnect (h);
 858     return;
 859   }
 860   switch (ntohs (msg->type))
 861   {
 862     /* Notify of a new incoming tunnel */
 863   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
 864     process_tunnel_create (h, (struct GNUNET_MESH_TunnelMessage *) msg);
 865     break;
 866     /* Notify of a tunnel disconnection */
 867   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
 868     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
 869     break;
 870     /* Notify of a new peer or a peer disconnect in the tunnel */
 871   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
 872   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
 873     process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
 874     break;
 875     /* Notify of a new data packet in the tunnel */
 876   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
 877   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
 878   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
 879     process_incoming_data (h, msg);
 880     break;
 881     /* We shouldn't get any other packages, log and ignore */
 882   default:
 883     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 884                 "MESH: unsolicited message form service (type %d)\n",
 885                 ntohs (msg->type));
 886   }
 887   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
 888   GNUNET_CLIENT_receive (h->client, &msg_received, h,
 889                          GNUNET_TIME_UNIT_FOREVER_REL);
 890 }
 891
 892
 893 /******************************************************************************/
 894 /************************       SEND FUNCTIONS     ****************************/
 895 /******************************************************************************/
 896
 897 /**
 898  * Function called to send a message to the service.
 899  * "buf" will be NULL and "size" zero if the socket was closed for writing in
 900  * the meantime.
 901  *
 902  * @param cls closure, the mesh handle
 903  * @param size number of bytes available in buf
 904  * @param buf where the callee should write the connect message
 905  * @return number of bytes written to buf
 906  */
 907 static size_t
 908 send_callback (void *cls, size_t size, void *buf)
 909 {
 910   struct GNUNET_MESH_Handle *h = cls;
 911   struct GNUNET_MESH_TransmitHandle *th;
 912   char *cbuf = buf;
 913   size_t tsize;
 914   size_t psize;
 915
 916   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
 917   h->th = NULL;
 918   if ((0 == size) || (NULL == buf))
 919   {
 920     reconnect (h);
 921     return 0;
 922   }
 923   tsize = 0;
 924   while ((NULL != (th = h->th_head)) && (size >= th->size))
 925   {
 926 #if DEBUG
 927     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     type: %u\n",
 928                 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
 929     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     size: %u\n",
 930                 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
 931 #endif
 932     if (NULL != th->notify)
 933     {
 934       if (th->target == 0)
 935       {
 936         /* multicast */
 937         struct GNUNET_MESH_Multicast mc;
 938
 939         GNUNET_assert (size >= sizeof (mc) + th->size);
 940         psize =
 941             th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
 942         if (psize > 0)
 943         {
 944           mc.header.size = htons (sizeof (mc) + th->size);
 945           mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
 946           mc.tid = htonl (th->tunnel->tid);
 947           memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
 948           memcpy (cbuf, &mc, sizeof (mc));
 949           psize = th->size + sizeof (mc);
 950         }
 951       }
 952       else
 953       {
 954         /* unicast */
 955         struct GNUNET_MESH_Unicast uc;
 956
 957         GNUNET_assert (size >= sizeof (uc) + th->size);
 958         psize =
 959             th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
 960         if (psize > 0)
 961         {
 962           uc.header.size = htons (sizeof (uc) + th->size);
 963           uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
 964           uc.tid = htonl (th->tunnel->tid);
 965           memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));     /* myself */
 966           GNUNET_PEER_resolve (th->target, &uc.destination);
 967           memcpy (cbuf, &uc, sizeof (uc));
 968           psize = th->size + sizeof (uc);
 969         }
 970       }
 971     }
 972     else
 973     {
 974       memcpy (cbuf, &th[1], th->size);
 975       psize = th->size;
 976     }
 977     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 978       GNUNET_SCHEDULER_cancel (th->timeout_task);
 979     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
 980     GNUNET_free (th);
 981     cbuf += psize;
 982     size -= psize;
 983     tsize += psize;
 984   }
 985   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   total size: %u\n", tsize);
 986   if (NULL != (th = h->th_head))
 987   {
 988     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   next size: %u\n", th->size);
 989     h->th =
 990         GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
 991                                              GNUNET_TIME_UNIT_FOREVER_REL,
 992                                              GNUNET_YES, &send_callback, h);
 993   }
 994   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
 995   if (GNUNET_NO == h->in_receive)
 996   {
 997     h->in_receive = GNUNET_YES;
 998     GNUNET_CLIENT_receive (h->client, &msg_received, h,
 999                            GNUNET_TIME_UNIT_FOREVER_REL);
1000   }
1001   return tsize;
1002 }
1003
1004
1005 /**
1006  * Auxiliary function to send an already constructed packet to the service.
1007  * Takes care of creating a new queue element, copying the message and
1008  * calling the tmt_rdy function if necessary.
1009  * @param h mesh handle
1010  * @param msg message to transmit
1011  */
1012 static void
1013 send_packet (struct GNUNET_MESH_Handle *h,
1014              const struct GNUNET_MessageHeader *msg)
1015 {
1016   struct GNUNET_MESH_TransmitHandle *th;
1017   size_t msize;
1018
1019   msize = ntohs (msg->size);
1020   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1021   th->priority = UINT32_MAX;
1022   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1023   th->size = msize;
1024   memcpy (&th[1], msg, msize);
1025   add_to_queue (h, th);
1026   if (NULL != h->th)
1027     return;
1028   h->th =
1029       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1030                                            GNUNET_TIME_UNIT_FOREVER_REL,
1031                                            GNUNET_YES, &send_callback, h);
1032 }
1033
1034
1035 /******************************************************************************/
1036 /**********************      API CALL DEFINITIONS     *************************/
1037 /******************************************************************************/
1038
1039 /**
1040  * Connect to the mesh service.
1041  *
1042  * @param cfg configuration to use
1043  * @param queue_size size of the data message queue, shared among all tunnels
1044  *                   (each tunnel is guaranteed to accept at least one message,
1045  *                    no matter what is the status of other tunnels)
1046  * @param cls closure for the various callbacks that follow
1047  *            (including handlers in the handlers array)
1048  * @param new_tunnel function called when an *inbound* tunnel is created
1049  * @param cleaner function called when an *inbound* tunnel is destroyed
1050  * @param handlers callbacks for messages we care about, NULL-terminated
1051  *                note that the mesh is allowed to drop notifications about
1052  *                inbound messages if the client does not process them fast
1053  *                enough (for this notification type, a bounded queue is used)
1054  * @param stypes list of the applications that this client claims to provide
1055  * @return handle to the mesh service NULL on error
1056  *         (in this case, init is never called)
1057  */
1058 struct GNUNET_MESH_Handle *
1059 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1060                      unsigned int queue_size, void *cls,
1061                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1062                      GNUNET_MESH_TunnelEndHandler cleaner,
1063                      const struct GNUNET_MESH_MessageHandler *handlers,
1064                      const GNUNET_MESH_ApplicationType *stypes)
1065 {
1066   struct GNUNET_MESH_Handle *h;
1067   struct GNUNET_MESH_ClientConnect *msg;
1068   GNUNET_MESH_ApplicationType *apps;
1069   uint16_t napps;
1070   uint16_t *types;
1071   uint16_t ntypes;
1072   size_t size;
1073
1074   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1075   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1076   h->cfg = cfg;
1077   h->max_queue_size = queue_size;
1078   h->new_tunnel = new_tunnel;
1079   h->cleaner = cleaner;
1080   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1081   if (h->client == NULL)
1082   {
1083     GNUNET_break (0);
1084     GNUNET_free (h);
1085     return NULL;
1086   }
1087   h->cls = cls;
1088   h->message_handlers = handlers;
1089   h->applications = stypes;
1090   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1091
1092   /* count handlers and apps, calculate size */
1093   for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1094   for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1095   size = sizeof (struct GNUNET_MESH_ClientConnect);
1096   size += h->n_handlers * sizeof (uint16_t);
1097   size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1098
1099   {
1100     char buf[size];
1101
1102     /* build connection packet */
1103     msg = (struct GNUNET_MESH_ClientConnect *) buf;
1104     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1105     msg->header.size = htons (size);
1106     types = (uint16_t *) & msg[1];
1107     for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1108       types[ntypes] = h->message_handlers[ntypes].type;
1109     apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1110     for (napps = 0; napps < h->n_applications; napps++)
1111       apps[napps] = h->applications[napps];
1112     msg->applications = htons (napps);
1113     msg->types = htons (ntypes);
1114     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1115                 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1116                 ntohs (msg->header.size), ntypes, napps);
1117     send_packet (h, &msg->header);
1118   }
1119   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1120   return h;
1121 }
1122
1123
1124 /**
1125  * Disconnect from the mesh service.
1126  *
1127  * @param handle connection to mesh to disconnect
1128  */
1129 void
1130 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1131 {
1132   struct GNUNET_MESH_Tunnel *t;
1133
1134   for (t = handle->tunnels_head; NULL != t; t = t->next)
1135   {
1136     destroy_tunnel (t);
1137   }
1138   if (NULL != handle->th)
1139   {
1140     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1141   }
1142   if (NULL != handle->client)
1143   {
1144     GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1145   }
1146   GNUNET_free (handle);
1147 }
1148
1149
1150 /**
1151  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1152  * and to broadcast).
1153  *
1154  * @param h mesh handle
1155  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1156  * @param connect_handler function to call when peers are actually connected
1157  * @param disconnect_handler function to call when peers are disconnected
1158  * @param handler_cls closure for connect/disconnect handlers
1159  */
1160 struct GNUNET_MESH_Tunnel *
1161 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1162                            GNUNET_MESH_TunnelConnectHandler connect_handler,
1163                            GNUNET_MESH_TunnelDisconnectHandler
1164                            disconnect_handler, void *handler_cls)
1165 {
1166   struct GNUNET_MESH_Tunnel *t;
1167   struct GNUNET_MESH_TunnelMessage msg;
1168
1169   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1170   t = create_tunnel (h, 0);
1171   t->connect_handler = connect_handler;
1172   t->disconnect_handler = disconnect_handler;
1173   t->cls = handler_cls;
1174   t->ctx = tunnel_ctx;
1175   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1176   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1177   msg.tunnel_id = htonl (t->tid);
1178   send_packet (h, &msg.header);
1179   return t;
1180 }
1181
1182
1183 /**
1184  * Destroy an existing tunnel.
1185  *
1186  * @param tun tunnel handle
1187  */
1188 void
1189 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1190 {
1191   struct GNUNET_MESH_Handle *h;
1192   struct GNUNET_MESH_TunnelMessage msg;
1193
1194   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1195   h = t->mesh;
1196
1197   if (0 != t->owner)
1198     GNUNET_PEER_change_rc (t->owner, -1);
1199
1200   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1201   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1202   msg.tunnel_id = htonl (t->tid);
1203   destroy_tunnel (t);
1204   send_packet (h, &msg.header);
1205 }
1206
1207
1208 /**
1209  * Request that a peer should be added to the tunnel.  The existing
1210  * connect handler will be called ONCE with either success or failure.
1211  * This function should NOT be called again with the same peer before the
1212  * connect handler is called.
1213  *
1214  * @param tunnel handle to existing tunnel
1215  * @param timeout how long to try to establish a connection
1216  * @param peer peer to add
1217  */
1218 void
1219 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1220                                       const struct GNUNET_PeerIdentity *peer)
1221 {
1222   struct GNUNET_MESH_PeerControl msg;
1223   GNUNET_PEER_Id peer_id;
1224   unsigned int i;
1225
1226   peer_id = GNUNET_PEER_intern (peer);
1227   for (i = 0; i < tunnel->npeers; i++)
1228   {
1229     if (tunnel->peers[i]->id == peer_id)
1230     {
1231       GNUNET_PEER_change_rc (peer_id, -1);
1232       GNUNET_break (0);
1233       return;
1234     }
1235   }
1236   if (NULL == add_peer_to_tunnel (tunnel, peer))
1237     return;
1238
1239   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1240   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1241   msg.tunnel_id = htonl (tunnel->tid);
1242   msg.peer = *peer;
1243   send_packet (tunnel->mesh, &msg.header);
1244
1245   return;
1246 }
1247
1248
1249 /**
1250  * Request that a peer should be removed from the tunnel.  The existing
1251  * disconnect handler will be called ONCE if we were connected.
1252  *
1253  * @param tunnel handle to existing tunnel
1254  * @param peer peer to remove
1255  */
1256 void
1257 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1258                                       const struct GNUNET_PeerIdentity *peer)
1259 {
1260   struct GNUNET_MESH_PeerControl msg;
1261   GNUNET_PEER_Id peer_id;
1262   unsigned int i;
1263
1264   peer_id = GNUNET_PEER_search (peer);
1265   if (0 == peer_id)
1266   {
1267     GNUNET_break (0);
1268     return;
1269   }
1270   for (i = 0; i < tunnel->npeers; i++)
1271     if (tunnel->peers[i]->id == peer_id)
1272       break;
1273   if (i == tunnel->npeers)
1274   {
1275     GNUNET_break (0);
1276     return;
1277   }
1278   if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1279     tunnel->disconnect_handler (tunnel->cls, peer);
1280   GNUNET_PEER_change_rc (peer_id, -1);
1281   GNUNET_free (tunnel->peers[i]);
1282   tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1283   GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1284
1285   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1286   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1287   msg.tunnel_id = htonl (tunnel->tid);
1288   memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1289   send_packet (tunnel->mesh, &msg.header);
1290 }
1291
1292
1293 /**
1294  * Request that the mesh should try to connect to a peer supporting the given
1295  * message type.
1296  *
1297  * @param tunnel handle to existing tunnel
1298  * @param app_type application type that must be supported by the peer (MESH
1299  *                 should discover peer in proximity handling this type)
1300  */
1301 void
1302 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1303                                           GNUNET_MESH_ApplicationType app_type)
1304 {
1305   struct GNUNET_MESH_ConnectPeerByType msg;
1306
1307   GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1308
1309   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1310   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1311   msg.tunnel_id = htonl (tunnel->tid);
1312   msg.type = htonl (app_type);
1313   send_packet (tunnel->mesh, &msg.header);
1314 }
1315
1316
1317 /**
1318  * Ask the mesh to call "notify" once it is ready to transmit the
1319  * given number of bytes to the specified "target".  If we are not yet
1320  * connected to the specified peer, a call to this function will cause
1321  * us to try to establish a connection.
1322  *
1323  * @param tunnel tunnel to use for transmission
1324  * @param cork is corking allowed for this transmission?
1325  * @param priority how important is the message?
1326  * @param maxdelay how long can the message wait?
1327  * @param target destination for the message,
1328  *               NULL for multicast to all tunnel targets
1329  * @param notify_size how many bytes of buffer space does notify want?
1330  * @param notify function to call when buffer space is available;
1331  *        will be called with NULL on timeout or if the overall queue
1332  *        for this peer is larger than queue_size and this is currently
1333  *        the message with the lowest priority
1334  * @param notify_cls closure for notify
1335  * @return non-NULL if the notify callback was queued,
1336  *         NULL if we can not even queue the request (insufficient
1337  *         memory); if NULL is returned, "notify" will NOT be called.
1338  */
1339 struct GNUNET_MESH_TransmitHandle *
1340 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1341                                    uint32_t priority,
1342                                    struct GNUNET_TIME_Relative maxdelay,
1343                                    const struct GNUNET_PeerIdentity *target,
1344                                    size_t notify_size,
1345                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1346                                    void *notify_cls)
1347 {
1348   struct GNUNET_MESH_TransmitHandle *th;
1349   struct GNUNET_MESH_TransmitHandle *least_priority_th;
1350   uint32_t least_priority;
1351   size_t overhead;
1352
1353   GNUNET_assert(NULL != notify);
1354   if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1355       tunnel->npackets > 0)
1356   {
1357     /* queue full */
1358     if (0 == priority)
1359       return NULL;
1360     th = tunnel->mesh->th_tail;
1361     least_priority = priority;
1362     least_priority_th = NULL;
1363     while (NULL != th)
1364     {
1365       if (th->priority < least_priority && th->tunnel->npackets > 1)
1366       {
1367         least_priority_th = th;
1368         least_priority = th->priority;
1369       }
1370       th = th->prev;
1371     }
1372     if (NULL == least_priority_th)
1373       return NULL;
1374     GNUNET_assert(NULL != least_priority_th->notify); /* Cant be a cntrl msg */
1375     least_priority_th->notify(notify_cls, 0, NULL);
1376     least_priority_th->tunnel->npackets--;
1377     tunnel->mesh->npackets--;
1378     GNUNET_CONTAINER_DLL_remove(tunnel->mesh->th_head,
1379                                 tunnel->mesh->th_tail,
1380                                 least_priority_th);
1381     if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1382       GNUNET_SCHEDULER_cancel(least_priority_th->timeout_task);
1383     GNUNET_free(least_priority_th);
1384   }
1385   tunnel->npackets++;
1386   tunnel->mesh->npackets++;
1387   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1388   th->tunnel = tunnel;
1389   th->priority = priority;
1390   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1391   th->target = GNUNET_PEER_intern (target);
1392   overhead =
1393       (NULL ==
1394        target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1395                                                                  GNUNET_MESH_Unicast);
1396   th->size = notify_size + overhead;
1397   th->notify = notify;
1398   th->notify_cls = notify_cls;
1399   add_to_queue (tunnel->mesh, th);
1400   return th;
1401 }
1402
1403
1404 /**
1405  * Cancel the specified transmission-ready notification.
1406  *
1407  * @param th handle that was returned by "notify_transmit_ready".
1408  */
1409 void
1410 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1411 {
1412   struct GNUNET_MESH_Handle *mesh;
1413
1414   mesh = th->tunnel->mesh;
1415   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1416     GNUNET_SCHEDULER_cancel (th->timeout_task);
1417   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1418   GNUNET_free (th);
1419   if ((NULL == mesh->th_head) && (NULL != mesh->th))
1420   {
1421     /* queue empty, no point in asking for transmission */
1422     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1423     mesh->th = NULL;
1424   }
1425 }
1426
1427
1428 #if 0                           /* keep Emacsens' auto-indent happy */
1429 {
1430 #endif
1431 #ifdef __cplusplus
1432 }
1433 #endif