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