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