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