src/mesh/mesh_api.c

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