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