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