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