- fix memleak

[oweals/gnunet.git] / src / mesh / gnunet-service-mesh-new.c

/*
     This file is part of GNUnet.
     (C) 2001-2013 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file mesh/gnunet-service-mesh-new.c
 * @brief GNUnet MESH service
 * @author Bartlomiej Polot
 *
 * TODO:
 * - relay corking down to core
 * - set ttl relative to path length
 * - add signatures
 * - add encryption
 * - keep queues until receiving ACK
 * TODO END
 */

#include "platform.h"
#include "mesh2.h"
#include "mesh2_protocol.h"
#include "mesh_path.h"
#include "block_mesh.h"
#include "gnunet_dht_service.h"
#include "gnunet_statistics_service.h"

#define MESH_BLOOM_SIZE         128

#define MESH_DEBUG_DHT          GNUNET_NO
#define MESH_DEBUG_CONNECTION   GNUNET_NO
#define MESH_DEBUG_TIMING       __LINUX__ && GNUNET_NO

#define MESH_MAX_POLL_TIME      GNUNET_TIME_relative_multiply (\
                                  GNUNET_TIME_UNIT_MINUTES,\
                                  10)

#if MESH_DEBUG_CONNECTION
#define DEBUG_CONN(...) GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
#else
#define DEBUG_CONN(...)
#endif

#if MESH_DEBUG_DHT
#define DEBUG_DHT(...) GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
#else
#define DEBUG_DHT(...)
#endif

#if MESH_DEBUG_TIMING
#include <time.h>
double __sum;
uint64_t __count;
struct timespec __mesh_start;
struct timespec __mesh_end;
#define INTERVAL_START clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &(__mesh_start))
#define INTERVAL_END \
do {\
  clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &(__mesh_end));\
  double __diff = __mesh_end.tv_nsec - __mesh_start.tv_nsec;\
  if (__diff < 0) __diff += 1000000000;\
  __sum += __diff;\
  __count++;\
} while (0)
#define INTERVAL_SHOW \
if (0 < __count)\
  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "AVG process time: %f ns\n", __sum/__count)
#else
#define INTERVAL_START
#define INTERVAL_END
#define INTERVAL_SHOW
#endif

/******************************************************************************/
/************************      DATA STRUCTURES     ****************************/
/******************************************************************************/

/** FWD declaration */
struct MeshPeerInfo;
struct MeshClient;


/**
 * Struct containing info about a queued transmission to this peer
 */
struct MeshPeerQueue
{
    /**
      * DLL next
      */
  struct MeshPeerQueue *next;

    /**
      * DLL previous
      */
  struct MeshPeerQueue *prev;

    /**
     * Peer this transmission is directed to.
     */
  struct MeshPeerInfo *peer;

    /**
     * Tunnel this message belongs to.
     */
  struct MeshTunnel *tunnel;

    /**
     * Pointer to info stucture used as cls.
     */
  void *cls;

    /**
     * Type of message
     */
  uint16_t type;

    /**
     * Size of the message
     */
  size_t size;
};


/**
 * Struct containing all information regarding a given peer
 */
struct MeshPeerInfo
{
    /**
     * ID of the peer
     */
  GNUNET_PEER_Id id;

    /**
     * Last time we heard from this peer
     */
  struct GNUNET_TIME_Absolute last_contact;

    /**
     * Number of attempts to reconnect so far
     */
  int n_reconnect_attempts;

    /**
     * Paths to reach the peer, ordered by ascending hop count
     */
  struct MeshPeerPath *path_head;

    /**
     * Paths to reach the peer, ordered by ascending hop count
     */
  struct MeshPeerPath *path_tail;

    /**
     * Handle to stop the DHT search for a path to this peer
     */
  struct GNUNET_DHT_GetHandle *dhtget;

    /**
     * Array of tunnels this peer is the target of.
     * Most probably a small amount, therefore not a hashmap.
     * When the path to the peer changes, notify these tunnels to let them
     * re-adjust their path trees.
     */
  struct MeshTunnel **tunnels;

    /**
     * Number of tunnels this peers participates in
     */
  unsigned int ntunnels;

   /**
    * Transmission queue to core DLL head
    */
  struct MeshPeerQueue *queue_head;

   /**
    * Transmission queue to core DLL tail
    */
   struct MeshPeerQueue *queue_tail;

   /**
    * How many messages are in the queue to this peer.
    */
   unsigned int queue_n;

   /**
    * Handle for queued transmissions
    */
  struct GNUNET_CORE_TransmitHandle *core_transmit;
};


/**
 * Struct to encapsulate all the Flow Control information to a peer in the
 * context of a tunnel: Same peer in different tunnels will have independent
 * flow control structures, allowing to choke/free tunnels according to its
 * own criteria.
 */
struct MeshFlowControl
{
  /**
   * ID of the last packet sent towards the peer.
   */
  uint32_t last_pid_sent;

  /**
   * ID of the last packet received from the peer.
   */
  uint32_t last_pid_recv;

  /**
   * Last ACK sent to the peer (peer can't send more than this PID).
   */
  uint32_t last_ack_sent;

  /**
   * Last ACK sent towards the origin (for traffic towards leaf node).
   */
  uint32_t last_ack_recv;

  /**
   * How many messages are in the queue towards this peer.
   */
  uint32_t queue_n;

  /**
   * Task to poll the peer in case of a lost ACK causes stall.
   */
  GNUNET_SCHEDULER_TaskIdentifier poll_task;

  /**
   * How frequently to poll for ACKs.
   */
  struct GNUNET_TIME_Relative poll_time;

  /**
   * On which tunnel to poll.
   * Using an explicit poll_ctx would not help memory wise,
   * since the allocated context would have to be stored in the
   * fc struct in order to free it upon cancelling poll_task.
   */
  struct MeshTunnel *t;
};


/**
 * Globally unique tunnel identification (owner + number)
 * DO NOT USE OVER THE NETWORK
 */
struct MESH_TunnelID
{
    /**
     * Node that owns the tunnel
     */
  GNUNET_PEER_Id oid;

    /**
     * Tunnel number to differentiate all the tunnels owned by the node oid
     * ( tid < GNUNET_MESH_LOCAL_TUNNEL_ID_CLI )
     */
  MESH_TunnelNumber tid;
};


/**
 * Struct containing all information regarding a tunnel
 * For an intermediate node the improtant info used will be:
 * - id        Tunnel unique identification
 * - paths[0]  To know where to send it next
 * - metainfo: ready, speeds, accounting
 */
struct MeshTunnel
{
    /**
     * Tunnel ID
     */
  struct MESH_TunnelID id;

    /**
     * Port of the tunnel.
     */
  uint32_t port;

    /**
     * State of the tunnel.
     */
  enum MeshTunnelState state;

    /**
     * Local tunnel number ( >= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI or 0 )
     */
  MESH_TunnelNumber local_tid;

    /**
     * Local tunnel number for local destination clients (incoming number)
     * ( >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV or 0). All clients share the same
     * number.
     */
  MESH_TunnelNumber local_tid_dest;

    /**
     * Is the tunnel bufferless (minimum latency)?
     */
  int nobuffer;

    /**
     * Force sending ACK? Flag to allow duplicate ACK on POLL.
     */
  int force_ack;

    /**
     * How many messages do we accept in the forward queue.
     */
  unsigned int queue_max;

    /**
     * Last time the tunnel was used
     */
  struct GNUNET_TIME_Absolute timestamp;

    /**
     * Destination of the tunnel.
     */
  GNUNET_PEER_Id dest;

    /**
     * Next hop in the tunnel. If 0, @c client must be set.
     */
  GNUNET_PEER_Id next_hop;

    /**
     * Previous hop in the tunnel. If 0, @c owner must be set.
     */
  GNUNET_PEER_Id prev_hop;

    /**
     * Flow control information about @c next_hop or @c client.
     */
  struct MeshFlowControl next_fc;

  /**
   * Flow control information about @c prev_hop or @c owner.
   */
  struct MeshFlowControl prev_fc;

    /**
     * Client owner of the tunnel, if any
     */
  struct MeshClient *owner;

    /**
     * Client destination of the tunnel, if any.
     */
  struct MeshClient *client;

    /**
     * Task to keep the used paths alive at the owner,
     * time tunnel out on all the other peers.
     */
  GNUNET_SCHEDULER_TaskIdentifier maintenance_task;

    /**
     * Path being used for the tunnel.
     */
  struct MeshPeerPath *path;

    /**
     * Flag to signal the destruction of the tunnel.
     * If this is set GNUNET_YES the tunnel will be destroyed
     * when the queue is empty.
     */
  int destroy;

    /**
     * Total messages pending for this tunnels, payload or not.
     */
  unsigned int pending_messages;
};


/**
 * Struct containing information about a client of the service
 * 
 * TODO: add a list of 'waiting' ports
 */
struct MeshClient
{
    /**
     * Linked list next
     */
  struct MeshClient *next;

    /**
     * Linked list prev
     */
  struct MeshClient *prev;

    /**
     * Tunnels that belong to this client, indexed by local id
     */
  struct GNUNET_CONTAINER_MultiHashMap *own_tunnels;

   /**
     * Tunnels this client has accepted, indexed by incoming local id
     */
  struct GNUNET_CONTAINER_MultiHashMap *incoming_tunnels;

    /**
     * Handle to communicate with the client
     */
  struct GNUNET_SERVER_Client *handle;

    /**
     * Ports that this client has declared interest in.
     * Indexed by a GMC_hash32 (type), contains *Client.
     */
  struct GNUNET_CONTAINER_MultiHashMap *ports;

    /**
     * Whether the client is active or shutting down (don't send confirmations
     * to a client that is shutting down.
     */
  int shutting_down;

    /**
     * ID of the client, mainly for debug messages
     */
  unsigned int id;

};


/******************************************************************************/
/************************      DEBUG FUNCTIONS     ****************************/
/******************************************************************************/

#if MESH_DEBUG
/**
 * GNUNET_SCHEDULER_Task for printing a message after some operation is done
 * @param cls string to print
 * @param success  GNUNET_OK if the PUT was transmitted,
 *                GNUNET_NO on timeout,
 *                GNUNET_SYSERR on disconnect from service
 *                after the PUT message was transmitted
 *                (so we don't know if it was received or not)
 */

#if 0
static void
mesh_debug (void *cls, int success)
{
  char *s = cls;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%s (%d)\n", s, success);
}
#endif

/* FIXME */
unsigned int debug_fwd_ack;
unsigned int debug_bck_ack;

#endif

/******************************************************************************/
/***********************      GLOBAL VARIABLES     ****************************/
/******************************************************************************/

/************************** Configuration parameters **************************/

/**
 * How often to send tunnel keepalives. Tunnels timeout after 4 missed.
 */
static struct GNUNET_TIME_Relative refresh_path_time;

/**
 * How often to PUT own ID in the DHT.
 */
static struct GNUNET_TIME_Relative id_announce_time;

/**
 * Maximum time allowed to connect to a peer found by string.
 */
static struct GNUNET_TIME_Relative connect_timeout;

/**
 * Default TTL for payload packets.
 */
static unsigned long long default_ttl;

/**
 * DHT replication level, see DHT API: GNUNET_DHT_get_start, GNUNET_DHT_put.
 */
static unsigned long long dht_replication_level;

/**
 * How many tunnels are we willing to maintain.
 * Local tunnels are always allowed, even if there are more tunnels than max.
 */
static unsigned long long max_tunnels;

/**
 * How many messages *in total* are we willing to queue, divided by number of 
 * tunnels to get tunnel queue size.
 */
static unsigned long long max_msgs_queue;

/**
 * How many peers do we want to remember?
 */
static unsigned long long max_peers;


/*************************** Static global variables **************************/

/**
 * Hostkey generation context
 */
static struct GNUNET_CRYPTO_EccKeyGenerationContext *keygen;

/**
 * DLL with all the clients, head.
 */
static struct MeshClient *clients_head;

/**
 * DLL with all the clients, tail.
 */
static struct MeshClient *clients_tail;

/**
 * Tunnels known, indexed by MESH_TunnelID (MeshTunnel).
 */
static struct GNUNET_CONTAINER_MultiHashMap *tunnels;

/**
 * Number of tunnels known.
 */
static unsigned long long n_tunnels;

/**
 * Tunnels incoming, indexed by MESH_TunnelNumber
 * (which is greater than GNUNET_MESH_LOCAL_TUNNEL_ID_SERV).
 */
static struct GNUNET_CONTAINER_MultiHashMap *incoming_tunnels;

/**
 * Peers known, indexed by PeerIdentity (MeshPeerInfo).
 */
static struct GNUNET_CONTAINER_MultiHashMap *peers;

/*
 * Handle to communicate with transport
 */
// static struct GNUNET_TRANSPORT_Handle *transport_handle;

/**
 * Handle to communicate with core.
 */
static struct GNUNET_CORE_Handle *core_handle;

/**
 * Handle to use DHT.
 */
static struct GNUNET_DHT_Handle *dht_handle;

/**
 * Handle to server.
 */
static struct GNUNET_SERVER_Handle *server_handle;

/**
 * Handle to the statistics service.
 */
static struct GNUNET_STATISTICS_Handle *stats;

/**
 * Notification context, to send messages to local clients.
 */
static struct GNUNET_SERVER_NotificationContext *nc;

/**
 * Local peer own ID (memory efficient handle).
 */
static GNUNET_PEER_Id myid;

/**
 * Local peer own ID (full value).
 */
static struct GNUNET_PeerIdentity my_full_id;

/**
 * Own private key.
 */
static struct GNUNET_CRYPTO_EccPrivateKey *my_private_key;

/**
 * Own public key.
 */
static struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded my_public_key;

/**
 * Tunnel ID for the next created tunnel (global tunnel number).
 */
static MESH_TunnelNumber next_tid;

/**
 * Tunnel ID for the next incoming tunnel (local tunnel number).
 */
static MESH_TunnelNumber next_local_tid;

/**
 * All ports clients of this peer have opened.
 */
static struct GNUNET_CONTAINER_MultiHashMap *ports;

/**
 * Task to periodically announce itself in the network.
 */
GNUNET_SCHEDULER_TaskIdentifier announce_id_task;

/**
 * Next ID to assign to a client.
 */
unsigned int next_client_id;


/******************************************************************************/
/***********************         DECLARATIONS        **************************/
/******************************************************************************/

/**
 * Function to process paths received for a new peer addition. The recorded
 * paths form the initial tunnel, which can be optimized later.
 * Called on each result obtained for the DHT search.
 *
 * @param cls closure
 * @param exp when will this value expire
 * @param key key of the result
 * @param type type of the result
 * @param size number of bytes in data
 * @param data pointer to the result data
 */
static void
dht_get_id_handler (void *cls, struct GNUNET_TIME_Absolute exp,
                    const struct GNUNET_HashCode * key,
                    const struct GNUNET_PeerIdentity *get_path,
                    unsigned int get_path_length,
                    const struct GNUNET_PeerIdentity *put_path,
                    unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
                    size_t size, const void *data);


/**
 * Retrieve the MeshPeerInfo stucture associated with the peer, create one
 * and insert it in the appropiate structures if the peer is not known yet.
 *
 * @param peer Full identity of the peer.
 *
 * @return Existing or newly created peer info.
 */
static struct MeshPeerInfo *
peer_get (const struct GNUNET_PeerIdentity *peer);


/**
 * Retrieve the MeshPeerInfo stucture associated with the peer, create one
 * and insert it in the appropiate structures if the peer is not known yet.
 *
 * @param peer Short identity of the peer.
 *
 * @return Existing or newly created peer info.
 */
static struct MeshPeerInfo *
peer_get_short (const GNUNET_PEER_Id peer);


/**
 * Build a PeerPath from the paths returned from the DHT, reversing the paths
 * to obtain a local peer -> destination path and interning the peer ids.
 *
 * @return Newly allocated and created path
 */
static struct MeshPeerPath *
path_build_from_dht (const struct GNUNET_PeerIdentity *get_path,
                     unsigned int get_path_length,
                     const struct GNUNET_PeerIdentity *put_path,
                     unsigned int put_path_length);


/**
 * Adds a path to the peer_infos of all the peers in the path
 *
 * @param p Path to process.
 * @param confirmed Whether we know if the path works or not.
 */
static void
path_add_to_peers (struct MeshPeerPath *p, int confirmed);



/**
 * Search for a tunnel by global ID using full PeerIdentities.
 *
 * @param oid owner of the tunnel.
 * @param tid global tunnel number.
 *
 * @return tunnel handler, NULL if doesn't exist.
 */
static struct MeshTunnel *
tunnel_get (const struct GNUNET_PeerIdentity *oid, MESH_TunnelNumber tid);


/**
 * Notify a tunnel that a connection has broken that affects at least
 * some of its peers.
 *
 * @param t Tunnel affected.
 * @param p1 Peer that got disconnected from p2.
 * @param p2 Peer that got disconnected from p1.
 *
 * @return Short ID of the peer disconnected (either p1 or p2).
 *         0 if the tunnel remained unaffected.
 */
static GNUNET_PEER_Id
tunnel_notify_connection_broken (struct MeshTunnel *t, GNUNET_PEER_Id p1,
                                 GNUNET_PEER_Id p2);


/**
 * @brief Use the given path for the tunnel.
 * Update the next and prev hops (and RCs).
 * (Re)start the path refresh in case the tunnel is locally owned.
 * 
 * @param t Tunnel to update.
 * @param p Path to use.
 */
static void
tunnel_use_path (struct MeshTunnel *t, struct MeshPeerPath *p);

/**
 * @brief Queue and pass message to core when possible.
 * 
 * If type is payload (UNICAST, TO_ORIGIN, MULTICAST) checks for queue status
 * and accounts for it. In case the queue is full, the message is dropped and
 * a break issued.
 * 
 * Otherwise, message is treated as internal and allowed to go regardless of 
 * queue status.
 *
 * @param cls Closure (@c type dependant). It will be used by queue_send to
 *            build the message to be sent if not already prebuilt.
 * @param type Type of the message, 0 for a raw message.
 * @param size Size of the message.
 * @param dst Neighbor to send message to.
 * @param t Tunnel this message belongs to.
 */
static void
queue_add (void *cls, uint16_t type, size_t size,
           struct MeshPeerInfo *dst, struct MeshTunnel *t);


/**
 * Free a transmission that was already queued with all resources
 * associated to the request.
 *
 * @param queue Queue handler to cancel.
 * @param clear_cls Is it necessary to free associated cls?
 */
static void
queue_destroy (struct MeshPeerQueue *queue, int clear_cls);


/**
 * @brief Get the next transmittable message from the queue.
 *
 * This will be the head, except in the case of being a data packet
 * not allowed by the destination peer.
 *
 * @param peer Destination peer.
 *
 * @return The next viable MeshPeerQueue element to send to that peer.
 *         NULL when there are no transmittable messages.
 */
struct MeshPeerQueue *
queue_get_next (const struct MeshPeerInfo *peer);


/**
 * Core callback to write a queued packet to core buffer
 *
 * @param cls Closure (peer info).
 * @param size Number of bytes available in buf.
 * @param buf Where the to write the message.
 *
 * @return number of bytes written to buf
 */
static size_t
queue_send (void *cls, size_t size, void *buf);


/******************************************************************************/
/************************    PERIODIC FUNCTIONS    ****************************/
/******************************************************************************/

/**
 * Periodically announce self id in the DHT
 *
 * @param cls closure
 * @param tc task context
 */
static void
announce_id (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct PBlock block;

  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
  {
    announce_id_task = GNUNET_SCHEDULER_NO_TASK;
    return;
  }
  /* TODO
   * - Set data expiration in function of X
   * - Adapt X to churn
   */
  DEBUG_DHT ("DHT_put for ID %s started.\n", GNUNET_i2s (&my_full_id));

  block.id = my_full_id;
  block.type = htonl (0);
  GNUNET_DHT_put (dht_handle,   /* DHT handle */
                  &my_full_id.hashPubKey,       /* Key to use */
                  dht_replication_level,     /* Replication level */
                  GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,    /* DHT options */
                  GNUNET_BLOCK_TYPE_MESH_PEER,       /* Block type */
                  sizeof (block),  /* Size of the data */
                  (const char *) &block, /* Data itself */
                  GNUNET_TIME_UNIT_FOREVER_ABS,  /* Data expiration */
                  GNUNET_TIME_UNIT_FOREVER_REL, /* Retry time */
                  NULL,         /* Continuation */
                  NULL);        /* Continuation closure */
  announce_id_task =
      GNUNET_SCHEDULER_add_delayed (id_announce_time, &announce_id, cls);
}


/******************************************************************************/
/******************      GENERAL HELPER FUNCTIONS      ************************/
/******************************************************************************/


/**
 * Check if client has registered with the service and has not disconnected
 *
 * @param client the client to check
 *
 * @return non-NULL if client exists in the global DLL
 */
static struct MeshClient *
client_get (struct GNUNET_SERVER_Client *client)
{
  struct MeshClient *c;

  c = clients_head;
  while (NULL != c)
  {
    if (c->handle == client)
      return c;
    c = c->next;
  }
  return NULL;
}


/**
 * Deletes a tunnel from a client (either owner or destination). To be used on
 * tunnel destroy.
 *
 * @param c Client whose tunnel to delete.
 * @param t Tunnel which should be deleted.
 */
static void
client_delete_tunnel (struct MeshClient *c, struct MeshTunnel *t)
{
  struct GNUNET_HashCode hash;

  if (c == t->owner)
  {
    GMC_hash32 (t->local_tid, &hash);
    GNUNET_assert (GNUNET_YES ==
                   GNUNET_CONTAINER_multihashmap_remove (c->own_tunnels,
                                                         &hash,
                                                         t));
  }
  else if (c == t->client)
  {
    GMC_hash32 (t->local_tid_dest, &hash);
    GNUNET_assert (GNUNET_YES ==
                   GNUNET_CONTAINER_multihashmap_remove (c->incoming_tunnels,
                                                         &hash,
                                                         t));
  }
  else
  {
    GNUNET_break (0);
  }
}

/**
 * Notify the appropiate client that a new incoming tunnel was created.
 *
 * @param t Tunnel that was created.
 */
static void
send_client_tunnel_create (struct MeshTunnel *t)
{
  struct GNUNET_MESH_TunnelMessage msg;

  if (NULL == t->client)
    return;
  msg.header.size = htons (sizeof (msg));
  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
  msg.tunnel_id = htonl (t->local_tid_dest);
  msg.port = htonl (t->port);
  GNUNET_SERVER_notification_context_unicast (nc, t->client->handle,
                                              &msg.header, GNUNET_NO);
}


/**
 * Notify dest client that the incoming tunnel is no longer valid.
 *
 * @param t Tunnel that was destroyed.
 */
static void
send_client_tunnel_destroy (struct MeshTunnel *t)
{
  struct GNUNET_MESH_TunnelMessage msg;

  if (NULL == t->client)
    return;
  msg.header.size = htons (sizeof (msg));
  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
  msg.tunnel_id = htonl (t->local_tid_dest);
  GNUNET_SERVER_notification_context_unicast (nc, t->client->handle,
                                              &msg.header, GNUNET_NO);
}


/**
 * Iterator over all the peers to remove the oldest not-used entry.
 *
 * @param cls Closure (unsued).
 * @param key ID of the peer.
 * @param value Peer_Info of the peer.
 *
 * FIXME implement
 */
static int
peer_info_timeout (void *cls,
                   const struct GNUNET_HashCode *key,
                   void *value)
{
  return GNUNET_YES;
}

/**
 * Retrieve the MeshPeerInfo stucture associated with the peer, create one
 * and insert it in the appropiate structures if the peer is not known yet.
 *
 * @param peer Full identity of the peer.
 *
 * @return Existing or newly created peer info.
 */
static struct MeshPeerInfo *
peer_get (const struct GNUNET_PeerIdentity *peer)
{
  struct MeshPeerInfo *peer_info;

  peer_info = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
  if (NULL == peer_info)
  {
    peer_info =
        (struct MeshPeerInfo *) GNUNET_malloc (sizeof (struct MeshPeerInfo));
    if (GNUNET_CONTAINER_multihashmap_size (peers) > max_peers)
    {
      GNUNET_CONTAINER_multihashmap_iterate (peers,
                                             &peer_info_timeout,
                                             NULL);
    }
    GNUNET_CONTAINER_multihashmap_put (peers, &peer->hashPubKey, peer_info,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
    peer_info->id = GNUNET_PEER_intern (peer);
  }
  peer_info->last_contact = GNUNET_TIME_absolute_get();

  return peer_info;
}


/**
 * Retrieve the MeshPeerInfo stucture associated with the peer, create one
 * and insert it in the appropiate structures if the peer is not known yet.
 *
 * @param peer Short identity of the peer.
 *
 * @return Existing or newly created peer info.
 */
static struct MeshPeerInfo *
peer_get_short (const GNUNET_PEER_Id peer)
{
  struct GNUNET_PeerIdentity id;

  GNUNET_PEER_resolve (peer, &id);
  return peer_get (&id);
}


/**
 * Choose the best path towards a peer considering the tunnel properties.
 * 
 * @param peer The destination peer.
 * @param t The tunnel the path is for.
 *
 * @return Best current known path towards the peer, if any.
 */
static struct MeshPeerPath *
peer_get_best_path (const struct MeshPeerInfo *peer, const struct MeshTunnel *t)
{
  struct MeshPeerPath *best_p;
  struct MeshPeerPath *p;
  unsigned int best_cost;
  unsigned int cost;

  best_p = p = peer->path_head;
  best_cost = cost = p->length;
  while (NULL != p)
  {
    if ((cost = p->length) < best_cost)
    {
      best_cost = cost;
      best_p = p;
    }
        p = p->next;
  }
  return best_p;
}


/**
 * Remove the tunnel from the list of tunnels to which a peer is target.
 *
 * @param peer PeerInfo of the peer.
 * @param t Tunnel to remove.
 */
static void
peer_remove_tunnel (struct MeshPeerInfo *peer, struct MeshTunnel *t)
{
  unsigned int i;

  for (i = 0; i < peer->ntunnels; i++)
  {
    if (0 ==
        memcmp (&peer->tunnels[i]->id, &t->id, sizeof (struct MESH_TunnelID)))
    {
      peer->ntunnels--;
      peer->tunnels[i] = peer->tunnels[peer->ntunnels];
      peer->tunnels = 
        GNUNET_realloc (peer->tunnels, 
                        peer->ntunnels * sizeof(struct MeshTunnel *));
      return;
    }
  }
}


/**
  * Core callback to write a pre-constructed data packet to core buffer
  *
  * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
  * @param size Number of bytes available in buf.
  * @param buf Where the to write the message.
  *
  * @return number of bytes written to buf
  */
static size_t
send_core_data_raw (void *cls, size_t size, void *buf)
{
  struct GNUNET_MessageHeader *msg = cls;
  size_t total_size;

  GNUNET_assert (NULL != msg);
  total_size = ntohs (msg->size);

  if (total_size > size)
  {
    GNUNET_break (0);
    return 0;
  }
  memcpy (buf, msg, total_size);
  GNUNET_free (cls);
  return total_size;
}


/**
 * Sends an already built message to a peer, properly registrating
 * all used resources.
 *
 * @param message Message to send. Function makes a copy of it.
 * @param peer Short ID of the neighbor whom to send the message.
 * @param t Tunnel on which this message is transmitted.
 */
static void
send_prebuilt_message (const struct GNUNET_MessageHeader *message,
                       GNUNET_PEER_Id peer,
                       struct MeshTunnel *t)
{
  struct GNUNET_PeerIdentity id;
  struct MeshPeerInfo *neighbor;
  struct MeshPeerPath *p;
  void *data;
  size_t size;
  uint16_t type;

//   GNUNET_TRANSPORT_try_connect(); FIXME use?

  if (0 == peer)
    return;

  size = ntohs (message->size);
  data = GNUNET_malloc (size);
  memcpy (data, message, size);
  type = ntohs(message->type);
  switch (type)
  {
    struct GNUNET_MESH_Unicast *u;

    case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
      u = (struct GNUNET_MESH_Unicast *) data;
      u->ttl = htonl (ntohl (u->ttl) - 1);
      break;
  }
  GNUNET_PEER_resolve (peer, &id);
  neighbor = peer_get (&id);
  for (p = neighbor->path_head; NULL != p; p = p->next)
  {
    if (2 >= p->length)
    {
      break;
    }
  }
  if (NULL == p)
  {
#if MESH_DEBUG
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  %s IS NOT DIRECTLY CONNECTED\n",
                GNUNET_i2s(&id));
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  PATHS TO %s:\n",
                GNUNET_i2s(&id));
    for (p = neighbor->path_head; NULL != p; p = p->next)
    {
      struct GNUNET_PeerIdentity debug_id;
      unsigned int i;

      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "    path with %u hops through:\n",
                  p->length);
      for (i = 0; i < p->length; i++)
      {
        GNUNET_PEER_resolve(p->peers[i], &debug_id);
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "      hop %u: %s\n",
                    i, GNUNET_i2s(&debug_id));
      }
    }
#endif
    GNUNET_break (0); // FIXME sometimes fails (testing disconnect?)
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                    " no direct connection to %s\n",
                    GNUNET_i2s (&id));
    GNUNET_free (data);
    return;
  }
  if (GNUNET_MESSAGE_TYPE_MESH_PATH_ACK == type)
    type = 0;
  queue_add (data,
             type,
             size,
             neighbor,
             t);
}


/**
 * Sends a CREATE PATH message for a path to a peer, properly registrating
 * all used resources.
 *
 * @param t Tunnel for which the path is created.
 */
static void
send_create_path (struct MeshTunnel *t)
{
  struct MeshPeerInfo *neighbor;

  neighbor = peer_get_short (t->next_hop);
  queue_add (t,
             GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE,
             sizeof (struct GNUNET_MESH_CreateTunnel) +
                (t->path->length * sizeof (struct GNUNET_PeerIdentity)),
             neighbor,
             t);
  t->state = MESH_TUNNEL_WAITING;
}


/**
 * Sends a PATH ACK message in reponse to a received PATH_CREATE directed to us.
 *
 * @param t Tunnel which to confirm.
 */
static void
send_path_ack (struct MeshTunnel *t) 
{
  struct MeshPeerInfo *peer;

  peer = peer_get_short (t->prev_hop);

  queue_add (t,
             GNUNET_MESSAGE_TYPE_MESH_PATH_ACK,
             sizeof (struct GNUNET_MESH_PathACK),
             peer,
             t);
}


/**
 * Try to establish a new connection to this peer in the given tunnel.
 * If the peer doesn't have any path to it yet, try to get one.
 * If the peer already has some path, send a CREATE PATH towards it.
 *
 * @param peer PeerInfo of the peer.
 * @param t Tunnel for which to create the path, if possible.
 */
static void
peer_connect (struct MeshPeerInfo *peer, struct MeshTunnel *t)
{
  struct MeshPeerPath *p;

  if (NULL != peer->path_head)
  {
    p = peer_get_best_path (peer, t);
    tunnel_use_path (t, p);
    send_create_path (t);
  }
  else if (NULL == peer->dhtget)
  {
    struct GNUNET_PeerIdentity id;

    GNUNET_PEER_resolve (peer->id, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  Starting DHT GET for peer %s\n", GNUNET_i2s (&id));
    peer->dhtget = GNUNET_DHT_get_start (dht_handle,    /* handle */
                                         GNUNET_BLOCK_TYPE_MESH_PEER, /* type */
                                         &id.hashPubKey,     /* key to search */
                                         dht_replication_level, /* replication level */
                                         GNUNET_DHT_RO_RECORD_ROUTE |
                                         GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
                                         NULL,       /* xquery */
                                         0,     /* xquery bits */
                                         &dht_get_id_handler, peer);
    t->state = MESH_TUNNEL_SEARCHING;
  }
  /* Otherwise, there is no path but the DHT get is already started. */
}


/**
 * Destroy the peer_info and free any allocated resources linked to it
 *
 * @param pi The peer_info to destroy.
 *
 * @return GNUNET_OK on success
 */
static int
peer_info_destroy (struct MeshPeerInfo *pi)
{
  struct GNUNET_PeerIdentity id;
  struct MeshPeerPath *p;
  struct MeshPeerPath *nextp;

  GNUNET_PEER_resolve (pi->id, &id);
  GNUNET_PEER_change_rc (pi->id, -1);

  if (GNUNET_YES !=
      GNUNET_CONTAINER_multihashmap_remove (peers, &id.hashPubKey, pi))
  {
    GNUNET_break (0);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "removing peer %s, not in hashmap\n", GNUNET_i2s (&id));
  }
  if (NULL != pi->dhtget)
  {
    GNUNET_DHT_get_stop (pi->dhtget);
  }
  p = pi->path_head;
  while (NULL != p)
  {
    nextp = p->next;
    GNUNET_CONTAINER_DLL_remove (pi->path_head, pi->path_tail, p);
    path_destroy (p);
    p = nextp;
  }
  GNUNET_free (pi);
  return GNUNET_OK;
}


/**
 * Remove all paths that rely on a direct connection between p1 and p2
 * from the peer itself and notify all tunnels about it.
 *
 * @param peer PeerInfo of affected peer.
 * @param p1 GNUNET_PEER_Id of one peer.
 * @param p2 GNUNET_PEER_Id of another peer that was connected to the first and
 *           no longer is.
 *
 * TODO: optimize (see below)
 */
static void
peer_remove_path (struct MeshPeerInfo *peer, GNUNET_PEER_Id p1,
                       GNUNET_PEER_Id p2)
{
  struct MeshPeerPath *p;
  struct MeshPeerPath *next;
  struct MeshPeerInfo *peer_d;
  GNUNET_PEER_Id d;
  unsigned int destroyed;
  unsigned int i;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "peer_info_remove_path\n");
  destroyed = 0;
  for (p = peer->path_head; NULL != p; p = next)
  {
    next = p->next;
    for (i = 0; i < (p->length - 1); i++)
    {
      if ((p->peers[i] == p1 && p->peers[i + 1] == p2) ||
          (p->peers[i] == p2 && p->peers[i + 1] == p1))
      {
        GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
        path_destroy (p);
        destroyed++;
        break;
      }
    }
  }
  if (0 == destroyed)
    return;

  for (i = 0; i < peer->ntunnels; i++)
  {
    d = tunnel_notify_connection_broken (peer->tunnels[i], p1, p2);
    if (0 == d)
      continue;

    peer_d = peer_get_short (d);
    next = peer_get_best_path (peer_d, peer->tunnels[i]);
    tunnel_use_path (peer->tunnels[i], next);
    peer_connect (peer_d, peer->tunnels[i]);
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "peer_info_remove_path END\n");
}


/**
 * Add the path to the peer and update the path used to reach it in case this
 * is the shortest.
 *
 * @param peer_info Destination peer to add the path to.
 * @param path New path to add. Last peer must be the peer in arg 1.
 *             Path will be either used of freed if already known.
 * @param trusted Do we trust that this path is real?
 */
void
peer_info_add_path (struct MeshPeerInfo *peer_info, struct MeshPeerPath *path,
                    int trusted)
{
  struct MeshPeerPath *aux;
  unsigned int l;
  unsigned int l2;

  if ((NULL == peer_info) || (NULL == path))
  {
    GNUNET_break (0);
    path_destroy (path);
    return;
  }
  if (path->peers[path->length - 1] != peer_info->id)
  {
    GNUNET_break (0);
    path_destroy (path);
    return;
  }
  if (path->length <= 2 && GNUNET_NO == trusted)
  {
    /* Only allow CORE to tell us about direct paths */
    path_destroy (path);
    return;
  }
  for (l = 1; l < path->length; l++)
  {
    if (path->peers[l] == myid)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
      for (l2 = 0; l2 < path->length - l; l2++)
      {
        path->peers[l2] = path->peers[l + l2];
      }
      path->length -= l;
      l = 1;
      path->peers =
          GNUNET_realloc (path->peers, path->length * sizeof (GNUNET_PEER_Id));
    }
  }
#if MESH_DEBUG
  {
    struct GNUNET_PeerIdentity id;

    GNUNET_PEER_resolve (peer_info->id, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
                path->length, GNUNET_i2s (&id));
  }
#endif
  l = path_get_length (path);
  if (0 == l)
  {
    GNUNET_free (path);
    return;
  }

  GNUNET_assert (peer_info->id == path->peers[path->length - 1]);
  for (aux = peer_info->path_head; aux != NULL; aux = aux->next)
  {
    l2 = path_get_length (aux);
    if (l2 > l)
    {
      GNUNET_CONTAINER_DLL_insert_before (peer_info->path_head,
                                          peer_info->path_tail, aux, path);
      return;
    }
    else
    {
      if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
      {
        path_destroy (path);
        return;
      }
    }
  }
  GNUNET_CONTAINER_DLL_insert_tail (peer_info->path_head, peer_info->path_tail,
                                    path);
  return;
}


/**
 * Add the path to the origin peer and update the path used to reach it in case
 * this is the shortest.
 * The path is given in peer_info -> destination, therefore we turn the path
 * upside down first.
 *
 * @param peer_info Peer to add the path to, being the origin of the path.
 * @param path New path to add after being inversed.
 *             Path will be either used or freed.
 * @param trusted Do we trust that this path is real?
 */
static void
peer_info_add_path_to_origin (struct MeshPeerInfo *peer_info,
                              struct MeshPeerPath *path, int trusted)
{
  path_invert (path);
  peer_info_add_path (peer_info, path, trusted);
}



/**
 * Remove a tunnel from the list of tunnels a peer participates in.
 * 
 * @param p Peer to clean.
 * @param t Tunnel to remove.
 */
static void
peer_info_remove_tunnel (struct MeshPeerInfo *p, struct MeshTunnel *t)
{
  unsigned int i;

  for (i = 0; i < p->ntunnels; i++)
  {
    if (p->tunnels[i] == t)
    {
      p->tunnels[i] = p->tunnels[p->ntunnels - 1];
      GNUNET_array_grow (p->tunnels, p->ntunnels, p->ntunnels - 1);
      return;
    }
  }
}


/**
 * Function called if the connection to the peer has been stalled for a while,
 * possibly due to a missed ACK. Poll the peer about its ACK status.
 *
 * @param cls Closure (poll ctx).
 * @param tc TaskContext.
 */
static void
tunnel_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct MeshFlowControl *fc = cls;
  struct GNUNET_MESH_Poll msg;
  struct MeshTunnel *t = fc->t;
  GNUNET_PEER_Id peer;

  fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
  {
    return;
  }

  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
  msg.header.size = htons (sizeof (msg));
  msg.tid = htonl (t->id.tid);
  GNUNET_PEER_resolve (t->id.oid, &msg.oid);

  if (fc == &t->prev_fc)
  {
    peer = t->prev_hop;
  }
  else if (fc == &t->next_fc)
  {
    peer = t->next_hop;
  }
  else
  {
    GNUNET_break (0);
    return;
  }
  send_prebuilt_message (&msg.header, peer, t);
  fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
  fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
                                                &tunnel_poll, fc);
}


/**
 * Build a PeerPath from the paths returned from the DHT, reversing the paths
 * to obtain a local peer -> destination path and interning the peer ids.
 *
 * @return Newly allocated and created path
 */
static struct MeshPeerPath *
path_build_from_dht (const struct GNUNET_PeerIdentity *get_path,
                     unsigned int get_path_length,
                     const struct GNUNET_PeerIdentity *put_path,
                     unsigned int put_path_length)
{
  struct MeshPeerPath *p;
  GNUNET_PEER_Id id;
  int i;

  p = path_new (1);
  p->peers[0] = myid;
  GNUNET_PEER_change_rc (myid, 1);
  i = get_path_length;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   GET has %d hops.\n", i);
  for (i--; i >= 0; i--)
  {
    id = GNUNET_PEER_intern (&get_path[i]);
    if (p->length > 0 && id == p->peers[p->length - 1])
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   Optimizing 1 hop out.\n");
      GNUNET_PEER_change_rc (id, -1);
    }
    else
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   Adding from GET: %s.\n",
                  GNUNET_i2s (&get_path[i]));
      p->length++;
      p->peers = GNUNET_realloc (p->peers, sizeof (GNUNET_PEER_Id) * p->length);
      p->peers[p->length - 1] = id;
    }
  }
  i = put_path_length;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   PUT has %d hops.\n", i);
  for (i--; i >= 0; i--)
  {
    id = GNUNET_PEER_intern (&put_path[i]);
    if (id == myid)
    {
      /* PUT path went through us, so discard the path up until now and start
       * from here to get a much shorter (and loop-free) path.
       */
      path_destroy (p);
      p = path_new (0);
    }
    if (p->length > 0 && id == p->peers[p->length - 1])
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   Optimizing 1 hop out.\n");
      GNUNET_PEER_change_rc (id, -1);
    }
    else
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   Adding from PUT: %s.\n",
                  GNUNET_i2s (&put_path[i]));
      p->length++;
      p->peers = GNUNET_realloc (p->peers, sizeof (GNUNET_PEER_Id) * p->length);
      p->peers[p->length - 1] = id;
    }
  }
#if MESH_DEBUG
  if (get_path_length > 0)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   (first of GET: %s)\n",
                GNUNET_i2s (&get_path[0]));
  if (put_path_length > 0)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   (first of PUT: %s)\n",
                GNUNET_i2s (&put_path[0]));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   In total: %d hops\n",
              p->length);
  for (i = 0; i < p->length; i++)
  {
    struct GNUNET_PeerIdentity peer_id;

    GNUNET_PEER_resolve (p->peers[i], &peer_id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "       %u: %s\n", p->peers[i],
                GNUNET_i2s (&peer_id));
  }
#endif
  return p;
}


/**
 * Adds a path to the peer_infos of all the peers in the path
 *
 * @param p Path to process.
 * @param confirmed Whether we know if the path works or not.
 */
static void
path_add_to_peers (struct MeshPeerPath *p, int confirmed)
{
  unsigned int i;

  /* TODO: invert and add */
  for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
  for (i++; i < p->length; i++)
  {
    struct MeshPeerInfo *aux;
    struct MeshPeerPath *copy;

    aux = peer_get_short (p->peers[i]);
    copy = path_duplicate (p);
    copy->length = i + 1;
    peer_info_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
  }
}


/**
 * Send keepalive packets for a peer
 *
 * @param cls Closure (tunnel for which to send the keepalive).
 * @param tc Notification context.
 */
static void
path_refresh (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);


/**
 * Search for a tunnel among the incoming tunnels
 *
 * @param tid the local id of the tunnel
 *
 * @return tunnel handler, NULL if doesn't exist
 */
static struct MeshTunnel *
tunnel_get_incoming (MESH_TunnelNumber tid)
{
  struct GNUNET_HashCode hash;

  GNUNET_assert (tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV);
  GMC_hash32 (tid, &hash);
  return GNUNET_CONTAINER_multihashmap_get (incoming_tunnels, &hash);
}


/**
 * Search for a tunnel among the tunnels for a client
 *
 * @param c the client whose tunnels to search in
 * @param tid the local id of the tunnel
 *
 * @return tunnel handler, NULL if doesn't exist
 */
static struct MeshTunnel *
tunnel_get_by_local_id (struct MeshClient *c, MESH_TunnelNumber tid)
{
  if (tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
  {
    return tunnel_get_incoming (tid);
  }
  else
  {
    struct GNUNET_HashCode hash;

    GMC_hash32 (tid, &hash);
    return GNUNET_CONTAINER_multihashmap_get (c->own_tunnels, &hash);
  }
}


/**
 * Search for a tunnel by global ID using PEER_ID
 *
 * @param pi owner of the tunnel
 * @param tid global tunnel number
 *
 * @return tunnel handler, NULL if doesn't exist
 */
static struct MeshTunnel *
tunnel_get_by_pi (GNUNET_PEER_Id pi, MESH_TunnelNumber tid)
{
  struct MESH_TunnelID id;
  struct GNUNET_HashCode hash;

  id.oid = pi;
  id.tid = tid;

  GNUNET_CRYPTO_hash (&id, sizeof (struct MESH_TunnelID), &hash);
  return GNUNET_CONTAINER_multihashmap_get (tunnels, &hash);
}


/**
 * Search for a tunnel by global ID using full PeerIdentities
 *
 * @param oid owner of the tunnel
 * @param tid global tunnel number
 *
 * @return tunnel handler, NULL if doesn't exist
 */
static struct MeshTunnel *
tunnel_get (const struct GNUNET_PeerIdentity *oid, MESH_TunnelNumber tid)
{
  return tunnel_get_by_pi (GNUNET_PEER_search (oid), tid);
}


/**
 * Add a client to a tunnel, initializing all needed data structures.
 * 
 * @param t Tunnel to which add the client.
 * @param c Client which to add to the tunnel.
 */
static void
tunnel_add_client (struct MeshTunnel *t, struct MeshClient *c)
{
  struct GNUNET_HashCode hash;

  if (NULL != t->client)
  {
    GNUNET_break(0);
    return;
  }
  if (0 != t->next_hop)
  {
    GNUNET_break(0);
    return;
  }
  GMC_hash32 (t->local_tid_dest, &hash);
  if (GNUNET_OK !=
      GNUNET_CONTAINER_multihashmap_put (c->incoming_tunnels, &hash, t,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
  {
    GNUNET_break (0);
    return;
  }
  if (GNUNET_OK !=
      GNUNET_CONTAINER_multihashmap_put (incoming_tunnels, &hash, t,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
  {
    GNUNET_break (0);
    return;
  }
  t->client = c;
}


static void
tunnel_use_path (struct MeshTunnel *t, struct MeshPeerPath *p)
{
  unsigned int own_pos;

  for (own_pos = 0; own_pos < p->length; own_pos++)
  {
    if (p->peers[own_pos] == myid)
      break;
  }
  if (own_pos > p->length - 1)
  {
    GNUNET_break (0);
    return;
  }

  if (own_pos < p->length - 1)
    t->next_hop = p->peers[own_pos + 1];
  else
    t->next_hop = p->peers[own_pos];
  GNUNET_PEER_change_rc (t->next_hop, 1);
  if (0 < own_pos)
    t->prev_hop = p->peers[own_pos - 1];
  else
    t->prev_hop = p->peers[0];
  GNUNET_PEER_change_rc (t->prev_hop, 1);

  if (NULL != t->path)
    path_destroy (t->path);
  t->path = path_duplicate (p);
  if (0 == own_pos)
  {
    if (GNUNET_SCHEDULER_NO_TASK != t->maintenance_task)
      GNUNET_SCHEDULER_cancel (t->maintenance_task);
    t->maintenance_task = GNUNET_SCHEDULER_add_delayed (refresh_path_time,
                                                        &path_refresh, t);
  }
}


/**
 * Notifies a tunnel that a connection has broken that affects at least
 * some of its peers. Sends a notification towards the root of the tree.
 * In case the peer is the owner of the tree, notifies the client that owns
 * the tunnel and tries to reconnect.
 *
 * @param t Tunnel affected.
 * @param p1 Peer that got disconnected from p2.
 * @param p2 Peer that got disconnected from p1.
 *
 * @return Short ID of the peer disconnected (either p1 or p2).
 *         0 if the tunnel remained unaffected.
 */
static GNUNET_PEER_Id
tunnel_notify_connection_broken (struct MeshTunnel *t, GNUNET_PEER_Id p1,
                                 GNUNET_PEER_Id p2)
{
//   if (myid != p1 && myid != p2) FIXME
//   {
//     return;
//   }
// 
//   if (tree_get_predecessor (t->tree) != 0)
//   {
//     /* We are the peer still connected, notify owner of the disconnection. */
//     struct GNUNET_MESH_PathBroken msg;
//     struct GNUNET_PeerIdentity neighbor;
// 
//     msg.header.size = htons (sizeof (msg));
//     msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN);
//     GNUNET_PEER_resolve (t->id.oid, &msg.oid);
//     msg.tid = htonl (t->id.tid);
//     msg.peer1 = my_full_id;
//     GNUNET_PEER_resolve (pid, &msg.peer2);
//     GNUNET_PEER_resolve (tree_get_predecessor (t->tree), &neighbor);
//     send_prebuilt_message (&msg.header, &neighbor, t);
//   }
  return 0;
}


/**
 * Build a local ACK message and send it to a local client.
 * 
 * @param t Tunnel on which to send the ACK.
 * @param c Client to whom send the ACK.
 * @param ack Value of the ACK.
 */
static void
send_local_ack (struct MeshTunnel *t, struct MeshClient *c, uint32_t ack)
{
  struct GNUNET_MESH_LocalAck msg;

  msg.header.size = htons (sizeof (msg));
  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
  msg.tunnel_id = htonl (t->owner == c ? t->local_tid : t->local_tid_dest);
  msg.max_pid = htonl (ack); 
  GNUNET_SERVER_notification_context_unicast(nc,
                                              c->handle,
                                              &msg.header,
                                              GNUNET_NO);
}

/**
 * Build an ACK message and queue it to send to the given peer.
 * 
 * @param t Tunnel on which to send the ACK.
 * @param peer Peer to whom send the ACK.
 * @param ack Value of the ACK.
 */
static void
send_ack (struct MeshTunnel *t, GNUNET_PEER_Id peer,  uint32_t ack)
{
  struct GNUNET_MESH_ACK msg;

  GNUNET_PEER_resolve (t->id.oid, &msg.oid);
  msg.header.size = htons (sizeof (msg));
  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
  msg.pid = htonl (ack);
  msg.tid = htonl (t->id.tid);

  send_prebuilt_message (&msg.header, peer, t);
}


/**
 * Send an ACK informing the predecessor about the available buffer space.
 * In case there is no predecessor, inform the owning client.
 * If buffering is off, send only on behalf of children or self if endpoint.
 * If buffering is on, send when sent to children and buffer space is free.
 * Note that although the name is fwd_ack, the FWD mean forward *traffic*,
 * the ACK itself goes "back" (towards root).
 * 
 * @param t Tunnel on which to send the ACK.
 * @param type Type of message that triggered the ACK transmission.
 */
static void
tunnel_send_fwd_ack (struct MeshTunnel *t, uint16_t type)
{
  uint32_t ack;

  /* Is it after unicast retransmission? */
  switch (type)
  {
    case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "ACK due to FWD DATA retransmission\n");
      if (GNUNET_YES == t->nobuffer)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, nobuffer\n");
        return;
      }
      break;
    case GNUNET_MESSAGE_TYPE_MESH_ACK:
    case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
      break;
    case GNUNET_MESSAGE_TYPE_MESH_POLL:
      t->force_ack = GNUNET_YES;
      break;
    default:
      GNUNET_break (0);
  }

  /* Check if we need to transmit the ACK */
  if (t->queue_max > t->next_fc.queue_n * 4 &&
      GMC_is_pid_bigger(t->prev_fc.last_ack_sent, t->prev_fc.last_pid_recv) &&
      GNUNET_NO == t->force_ack)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer free\n");
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  t->qmax: %u, t->qn: %u\n",
                t->queue_max, t->next_fc.queue_n);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  t->pid: %u, t->ack: %u\n",
                t->prev_fc.last_pid_recv, t->prev_fc.last_ack_sent);
    return;
  }

  /* Ok, ACK might be necessary, what PID to ACK? */
  ack = t->prev_fc.last_pid_recv + t->queue_max - t->next_fc.queue_n;
  if (ack == t->prev_fc.last_ack_sent && GNUNET_NO == t->force_ack)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
    return;
  }

  t->prev_fc.last_ack_sent = ack;
  if (NULL != t->owner)
    send_local_ack (t, t->owner, ack);
  else if (0 != t->prev_hop)
    send_ack (t, t->prev_hop, ack);
  else
    GNUNET_break (0);
  debug_fwd_ack++;
  t->force_ack = GNUNET_NO;
}


/**
 * Send an ACK informing the children node/client about the available
 * buffer space.
 * If buffering is off, send only on behalf of root (can be self).
 * If buffering is on, send when sent to predecessor and buffer space is free.
 * Note that although the name is bck_ack, the BCK mean backwards *traffic*,
 * the ACK itself goes "forward" (towards children/clients).
 * 
 * @param t Tunnel on which to send the ACK.
 * @param type Type of message that triggered the ACK transmission.
 */
static void
tunnel_send_bck_ack (struct MeshTunnel *t, uint16_t type)
{
  uint32_t ack;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Sending BCK ACK on tunnel %u [%u] due to %s\n",
              t->id.oid, t->id.tid, GNUNET_MESH_DEBUG_M2S(type));
  /* Is it after data to_origin retransmission? */
  switch (type)
  {
    case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
      if (GNUNET_YES == t->nobuffer)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "    Not sending ACK, nobuffer + traffic\n");
        return;
      }
      break;
    case GNUNET_MESSAGE_TYPE_MESH_ACK:
    case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
      break;
    case GNUNET_MESSAGE_TYPE_MESH_PATH_ACK:
    case GNUNET_MESSAGE_TYPE_MESH_POLL:
      t->force_ack = GNUNET_YES;
      break;
    default:
      GNUNET_break (0);
  }

  /* TODO: Check if we need to transmit the ACK (as in fwd) */

  ack = t->next_fc.last_pid_recv + t->queue_max - t->prev_fc.queue_n;

  if (t->next_fc.last_ack_sent == ack && GNUNET_NO == t->force_ack)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "    Not sending ACK, not needed\n");
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "    Sending BCK ACK %u (last sent: %u)\n",
              ack, t->next_fc.last_ack_sent);
  t->next_fc.last_ack_sent = ack;

  if (NULL != t->client)
    send_local_ack (t, t->client, ack);
  else if (0 != t->next_hop)
    send_ack (t, t->next_hop, ack);
  else
    GNUNET_break (0);
  t->force_ack = GNUNET_NO;
}


/**
 * @brief Re-initiate traffic to this peer if necessary.
 *
 * Check if there is traffic queued towards this peer
 * and the core transmit handle is NULL (traffic was stalled).
 * If so, call core tmt rdy.
 *
 * @param peer_id Short ID of peer to which initiate traffic.
 */
static void
peer_unlock_queue(GNUNET_PEER_Id peer_id)
{
  struct MeshPeerInfo *peer;
  struct GNUNET_PeerIdentity id;
  struct MeshPeerQueue *q;
  size_t size;

  peer = peer_get_short (peer_id);
  if (NULL != peer->core_transmit)
    return;

  q = queue_get_next (peer);
  if (NULL == q)
  {
    /* Might br multicast traffic already sent to this particular peer but
     * not to other children in this tunnel.
     * This way t->queue_n would be > 0 but the queue of this particular peer
     * would be empty.
     */
    return;
  }
  size = q->size;
  GNUNET_PEER_resolve (peer->id, &id);
  peer->core_transmit =
        GNUNET_CORE_notify_transmit_ready(core_handle,
                                          0,
                                          0,
                                          GNUNET_TIME_UNIT_FOREVER_REL,
                                          &id,
                                          size,
                                          &queue_send,
                                          peer);
        return;
}


/**
 * Send a message to all peers in this tunnel that the tunnel is no longer
 * valid.
 *
 * @param t The tunnel whose peers to notify.
 */
static void
tunnel_send_destroy (struct MeshTunnel *t)
{
  struct GNUNET_MESH_TunnelDestroy msg;
  struct GNUNET_PeerIdentity id;

  msg.header.size = htons (sizeof (msg));
  msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY);
  GNUNET_PEER_resolve (t->id.oid, &msg.oid);
  msg.tid = htonl (t->id.tid);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "  sending tunnel destroy for tunnel: %s [%X]\n",
              GNUNET_i2s (&msg.oid), t->id.tid);

  if (NULL == t->client && 0 != t->next_hop)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  child: %u\n", t->next_hop);
    GNUNET_PEER_resolve (t->next_hop, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  sending forward to %s\n",
                GNUNET_i2s (&id));
    send_prebuilt_message (&msg.header, t->next_hop, t);
  }
  if (NULL == t->owner && 0 != t->prev_hop)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  parent: %u\n", t->prev_hop);
    GNUNET_PEER_resolve (t->prev_hop, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  sending back to %s\n",
                GNUNET_i2s (&id));
    send_prebuilt_message (&msg.header, t->prev_hop, t);
  }
}


/**
 * Cancel all transmissions towards a neighbor that belongs to a certain tunnel.
 *
 * @param t Tunnel which to cancel.
 * @param neighbor Short ID of the neighbor to whom cancel the transmissions.
 */
static void
peer_cancel_queues (GNUNET_PEER_Id neighbor, struct MeshTunnel *t)
{
  struct MeshPeerInfo *peer_info;
  struct MeshPeerQueue *pq;
  struct MeshPeerQueue *next;

  peer_info = peer_get_short (neighbor);
  for (pq = peer_info->queue_head; NULL != pq; pq = next)
  {
    next = pq->next;
    if (pq->tunnel == t)
    {
      if (GNUNET_MESSAGE_TYPE_MESH_UNICAST == pq->type ||
          GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN == pq->type)
      {
        /* Should have been removed on destroy children */
        GNUNET_break (0);
      }
      queue_destroy (pq, GNUNET_YES);
    }
  }
  if (NULL == peer_info->queue_head && NULL != peer_info->core_transmit)
  {
    GNUNET_CORE_notify_transmit_ready_cancel(peer_info->core_transmit);
    peer_info->core_transmit = NULL;
  }
}


/**
 * Destroy the tunnel and free any allocated resources linked to it.
 *
 * @param t the tunnel to destroy
 *
 * @return GNUNET_OK on success
 */
static int
tunnel_destroy (struct MeshTunnel *t)
{
  struct MeshClient *c;
  struct GNUNET_HashCode hash;
  int r;

  if (NULL == t)
    return GNUNET_OK;

  r = GNUNET_OK;
  c = t->owner;
#if MESH_DEBUG
  {
    struct GNUNET_PeerIdentity id;

    GNUNET_PEER_resolve (t->id.oid, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "destroying tunnel %s [%x]\n",
                GNUNET_i2s (&id), t->id.tid);
    if (NULL != c)
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);
  }
#endif

  GNUNET_CRYPTO_hash (&t->id, sizeof (struct MESH_TunnelID), &hash);
  if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (tunnels, &hash, t))
  {
    GNUNET_break (0);
    r = GNUNET_SYSERR;
  }

  if (NULL != c)
  {
    GMC_hash32 (t->local_tid, &hash);
    if (GNUNET_YES !=
        GNUNET_CONTAINER_multihashmap_remove (c->own_tunnels, &hash, t))
    {
      GNUNET_break (0);
      r = GNUNET_SYSERR;
    }
  }

  if (NULL != t->client)
  {
    c = t->client;
    GMC_hash32 (t->local_tid_dest, &hash);
    if (GNUNET_YES !=
          GNUNET_CONTAINER_multihashmap_remove (c->incoming_tunnels, &hash, t))
    {
      GNUNET_break (0);
      r = GNUNET_SYSERR;
    }
    if (GNUNET_YES != 
      GNUNET_CONTAINER_multihashmap_remove (incoming_tunnels, &hash, t))
    {
      GNUNET_break (0);
      r = GNUNET_SYSERR;
    }
  }

  peer_cancel_queues (t->next_hop, t);
  peer_cancel_queues (t->prev_hop, t);
  GNUNET_PEER_change_rc(t->next_hop, -1);
  GNUNET_PEER_change_rc(t->prev_hop, -1);

  if (GNUNET_SCHEDULER_NO_TASK != t->maintenance_task)
    GNUNET_SCHEDULER_cancel (t->maintenance_task);

  n_tunnels--;
  GNUNET_STATISTICS_update (stats, "# tunnels", -1, GNUNET_NO);
  GNUNET_free (t);
  return r;
}

/**
 * Tunnel is empty: destroy it.
 * 
 * @param t Tunnel to destroy. 
 */
static void
tunnel_destroy_empty (struct MeshTunnel *t)
{
  #if MESH_DEBUG
  {
    struct GNUNET_PeerIdentity id;

    GNUNET_PEER_resolve (t->id.oid, &id);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "executing destruction of empty tunnel %s [%X]\n",
                GNUNET_i2s (&id), t->id.tid);
  }
  #endif

  if (GNUNET_NO == t->destroy)
    tunnel_send_destroy (t);
  if (0 == t->pending_messages)
    tunnel_destroy (t);
  else
    t->destroy = GNUNET_YES;
}

/**
 * Initialize a Flow Control structure to the initial state.
 * 
 * @param fc Flow Control structure to initialize.
 */
static void
fc_init (struct MeshFlowControl *fc)
{
  fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
  fc->last_pid_recv = (uint32_t) -1;
  fc->last_ack_sent = (uint32_t) -1; /* No traffic allowed yet */
  fc->last_ack_recv = (uint32_t) -1;
  fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
  fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
  fc->queue_n = 0;
}

/**
 * Create a new tunnel
 * 
 * @param owner Who is the owner of the tunnel (short ID).
 * @param tid Tunnel Number of the tunnel.
 * @param client Clients that owns the tunnel, NULL for foreign tunnels.
 * @param local Tunnel Number for the tunnel, for the client point of view.
 * 
 * @return A new initialized tunnel. NULL on error.
 */
static struct MeshTunnel *
tunnel_new (GNUNET_PEER_Id owner,
            MESH_TunnelNumber tid,
            struct MeshClient *client,
            MESH_TunnelNumber local)
{
  struct MeshTunnel *t;
  struct GNUNET_HashCode hash;

  if (n_tunnels >= max_tunnels && NULL == client)
    return NULL;

  t = GNUNET_malloc (sizeof (struct MeshTunnel));
  t->id.oid = owner;
  t->id.tid = tid;
  t->queue_max = (max_msgs_queue / max_tunnels) + 1;
  t->owner = client;
  fc_init (&t->next_fc);
  fc_init (&t->prev_fc);
  t->local_tid = local;
  n_tunnels++;
  GNUNET_STATISTICS_update (stats, "# tunnels", 1, GNUNET_NO);

  GNUNET_CRYPTO_hash (&t->id, sizeof (struct MESH_TunnelID), &hash);
  if (GNUNET_OK !=
      GNUNET_CONTAINER_multihashmap_put (tunnels, &hash, t,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
  {
    GNUNET_break (0);
    tunnel_destroy (t);
    if (NULL != client)
    {
      GNUNET_break (0);
      GNUNET_SERVER_receive_done (client->handle, GNUNET_SYSERR);
    }
    return NULL;
  }

  if (NULL != client)
  {
    GMC_hash32 (t->local_tid, &hash);
    if (GNUNET_OK !=
        GNUNET_CONTAINER_multihashmap_put (client->own_tunnels, &hash, t,
                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
    {
      tunnel_destroy (t);
      GNUNET_break (0);
      GNUNET_SERVER_receive_done (client->handle, GNUNET_SYSERR);
      return NULL;
    }
  }

  return t;
}



/**
 * tunnel_destroy_iterator: iterator for deleting each tunnel that belongs to a
 * client when the client disconnects. If the client is not the owner, the
 * owner will get notified if no more clients are in the tunnel and the client
 * get removed from the tunnel's list.
 *
 * @param cls closure (client that is disconnecting)
 * @param key the hash of the local tunnel id (used to access the hashmap)
 * @param value the value stored at the key (tunnel to destroy)
 *
 * @return GNUNET_OK, keep iterating.
 */
static int
tunnel_destroy_iterator (void *cls,
                         const struct GNUNET_HashCode * key,
                         void *value)
{
  struct MeshTunnel *t = value;
  struct MeshClient *c = cls;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              " Tunnel %X / %X destroy, due to client %u shutdown.\n",
              t->local_tid, t->local_tid_dest, c->id);
  if (GNUNET_NO == c->shutting_down)
    send_client_tunnel_destroy (t);
  client_delete_tunnel (c, t);
  if (c == t->client)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " Client %u is destination.\n", c->id);
    t->client = NULL;
    t->next_hop = 0;
  }
  else if (c == t->owner)
  {
    struct MeshPeerInfo *p;
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " Client %u is owner.\n", c->id);
    t->owner = NULL;
    t->prev_hop = 0;
    p = peer_get_short(t->dest);
    peer_info_remove_tunnel (p, t);
  }
  else
  {
    GNUNET_break (0);
  }
  tunnel_destroy_empty (t);

  return GNUNET_OK;
}


/**
 * Timeout function, destroys tunnel if called
 *
 * @param cls Closure (tunnel to destroy).
 * @param tc TaskContext
 */
static void
tunnel_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct MeshTunnel *t = cls;
  struct GNUNET_PeerIdentity id;

  t->maintenance_task = GNUNET_SCHEDULER_NO_TASK;
  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
    return;
  GNUNET_PEER_resolve(t->id.oid, &id);
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Tunnel %s [%X] timed out. Destroying.\n",
              GNUNET_i2s(&id), t->id.tid);
  send_client_tunnel_destroy (t);
  tunnel_destroy (t);
}


/**
 * Resets the tunnel timeout. Starts it if no timeout was running.
 *
 * @param t Tunnel whose timeout to reset.
 *
 * TODO use heap to improve efficiency of scheduler.
 */
static void
tunnel_reset_timeout (struct MeshTunnel *t)
{
  if (NULL != t->owner || 0 != t->local_tid || 0 == t->prev_hop)
    return;
  if (GNUNET_SCHEDULER_NO_TASK != t->maintenance_task)
    GNUNET_SCHEDULER_cancel (t->maintenance_task);
  t->maintenance_task =
      GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
                                    (refresh_path_time, 4), &tunnel_timeout, t);
}


/******************************************************************************/
/****************      MESH NETWORK HANDLER HELPERS     ***********************/
/******************************************************************************/

/**
 * Function to send a create path packet to a peer.
 *
 * @param cls closure
 * @param size number of bytes available in buf
 * @param buf where the callee should write the message
 * @return number of bytes written to buf
 */
static size_t
send_core_path_create (void *cls, size_t size, void *buf)
{
  struct MeshTunnel *t = cls;
  struct GNUNET_MESH_CreateTunnel *msg;
  struct GNUNET_PeerIdentity *peer_ptr;
  struct MeshPeerPath *p = t->path;
  size_t size_needed;
  uint32_t opt;
  int i;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "CREATE PATH sending...\n");
  size_needed =
      sizeof (struct GNUNET_MESH_CreateTunnel) +
      p->length * sizeof (struct GNUNET_PeerIdentity);

  if (size < size_needed || NULL == buf)
  {
    GNUNET_break (0);
    return 0;
  }
  msg = (struct GNUNET_MESH_CreateTunnel *) buf;
  msg->header.size = htons (size_needed);
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE);
  msg->tid = ntohl (t->id.tid);

  opt = 0;
  if (GNUNET_YES == t->nobuffer)
    opt |= MESH_TUNNEL_OPT_NOBUFFER;
  msg->opt = htonl (opt);
  msg->port = htonl (t->port);

  peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
  for (i = 0; i < p->length; i++)
  {
    GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
  }

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "CREATE PATH (%u bytes long) sent!\n", size_needed);
  return size_needed;
}


/**
 * Creates a path ack message in buf and frees all unused resources.
 *
 * @param cls closure (MeshTransmissionDescriptor)
 * @param size number of bytes available in buf
 * @param buf where the callee should write the message
 * @return number of bytes written to buf
 */
static size_t
send_core_path_ack (void *cls, size_t size, void *buf)
{
  struct MeshTunnel *t = cls;
  struct GNUNET_MESH_PathACK *msg = buf;

  GNUNET_assert (NULL != t);
  if (sizeof (struct GNUNET_MESH_PathACK) > size)
  {
    GNUNET_break (0);
    return 0;
  }
  t->prev_fc.last_ack_sent = t->nobuffer ? 0 : t->queue_max - 1;
  msg->header.size = htons (sizeof (struct GNUNET_MESH_PathACK));
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_PATH_ACK);
  GNUNET_PEER_resolve (t->id.oid, &msg->oid);
  msg->tid = htonl (t->id.tid);
  msg->peer_id = my_full_id;
  msg->ack = htonl (t->prev_fc.last_ack_sent);

  /* TODO add signature */

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "PATH ACK sent!\n");
  return sizeof (struct GNUNET_MESH_PathACK);
}


/**
 * Free a transmission that was already queued with all resources
 * associated to the request.
 *
 * @param queue Queue handler to cancel.
 * @param clear_cls Is it necessary to free associated cls?
 */
static void
queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
{
  struct MeshFlowControl *fc;

  if (GNUNET_YES == clear_cls)
  {
    switch (queue->type)
    {
      case GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY:
        GNUNET_log (GNUNET_ERROR_TYPE_INFO, "   cancelling TUNNEL_DESTROY\n");
        GNUNET_break (GNUNET_YES == queue->tunnel->destroy);
        /* fall through */
      case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
      case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
      case GNUNET_MESSAGE_TYPE_MESH_ACK:
      case GNUNET_MESSAGE_TYPE_MESH_POLL:
      case GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE:
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "   prebuilt message\n");
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "   type %s\n",
                    GNUNET_MESH_DEBUG_M2S (queue->type));
        break;
      case GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE:
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   type create path\n");
        break;
      default:
        GNUNET_break (0);
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "   type %s unknown!\n",
                    GNUNET_MESH_DEBUG_M2S (queue->type));
    }
    GNUNET_free_non_null (queue->cls);
  }
  GNUNET_CONTAINER_DLL_remove (queue->peer->queue_head,
                               queue->peer->queue_tail,
                               queue);

  /* Delete from appropiate fc in the tunnel */
  if (queue->peer->id == queue->tunnel->next_hop)
    fc = &queue->tunnel->next_fc;
  else if (queue->peer->id == queue->tunnel->next_hop)
    fc = &queue->tunnel->next_fc;
  else
  {
    GNUNET_break (0);
    return;
  }
  fc->queue_n--;
  GNUNET_free (queue);
}


/**
 * @brief Get the next transmittable message from the queue.
 *
 * This will be the head, except in the case of being a data packet
 * not allowed by the destination peer.
 *
 * @param peer Destination peer.
 *
 * @return The next viable MeshPeerQueue element to send to that peer.
 *         NULL when there are no transmittable messages.
 */
struct MeshPeerQueue *
queue_get_next (const struct MeshPeerInfo *peer)
{
  struct MeshPeerQueue *q;
 
  struct GNUNET_MESH_Unicast *ucast;
  struct GNUNET_MESH_ToOrigin *to_orig;
  struct MeshTunnel* t;
  uint32_t pid;
  uint32_t ack;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   selecting message\n");
  for (q = peer->queue_head; NULL != q; q = q->next)
  {
    t = q->tunnel;
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "*     %s\n",
                GNUNET_MESH_DEBUG_M2S(q->type));
    switch (q->type)
    {
      case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
        ucast = (struct GNUNET_MESH_Unicast *) q->cls;
        pid = ntohl (ucast->pid);
        ack = t->next_fc.last_ack_recv;
        break;
      case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
        to_orig = (struct GNUNET_MESH_ToOrigin *) q->cls;
        pid = ntohl (to_orig->pid);
        ack = t->prev_fc.last_ack_recv;
        break;
      default:
        GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                    "*   OK!\n");
        return q;
    }
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "*     ACK: %u, PID: %u\n",
                ack, pid);
    if (GNUNET_NO == GMC_is_pid_bigger (pid, ack))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "*   OK!\n");
      return q;
    }
    else
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "*     NEXT!\n");
    }
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "*   nothing found\n");
  return NULL;
}


static size_t
queue_send (void *cls, size_t size, void *buf)
{
  struct MeshPeerInfo *peer = cls;
  struct GNUNET_MessageHeader *msg;
  struct MeshPeerQueue *queue;
  struct MeshTunnel *t;
  struct GNUNET_PeerIdentity dst_id;
  struct MeshFlowControl *fc;
  size_t data_size;
  uint16_t type;

  peer->core_transmit = NULL;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "* Queue send\n");
  queue = queue_get_next (peer);

  /* Queue has no internal mesh traffic nor sendable payload */
  if (NULL == queue)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   not ready, return\n");
    if (NULL == peer->queue_head)
      GNUNET_break (0); /* Core tmt_rdy should've been canceled */
    return 0;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   not empty\n");

  GNUNET_PEER_resolve (peer->id, &dst_id);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "*   towards %s\n",
              GNUNET_i2s (&dst_id));
  /* Check if buffer size is enough for the message */
  if (queue->size > size)
  {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "*   not enough room, reissue\n");
      peer->core_transmit =
          GNUNET_CORE_notify_transmit_ready (core_handle,
                                             GNUNET_NO,
                                             0,
                                             GNUNET_TIME_UNIT_FOREVER_REL,
                                             &dst_id,
                                             queue->size,
                                             &queue_send,
                                             peer);
      return 0;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   size ok\n");

  t = queue->tunnel;
  GNUNET_assert (0 < t->pending_messages);
  t->pending_messages--;
  type = 0;

  /* Fill buf */
  switch (queue->type)
  {
    case 0:
    case GNUNET_MESSAGE_TYPE_MESH_ACK:
    case GNUNET_MESSAGE_TYPE_MESH_POLL:
    case GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN:
    case GNUNET_MESSAGE_TYPE_MESH_PATH_DESTROY:
    case GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY:
    case GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE:
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "*   raw: %s\n",
                  GNUNET_MESH_DEBUG_M2S (queue->type));
      /* Fall through */
    case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
    case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
      data_size = send_core_data_raw (queue->cls, size, buf);
      msg = (struct GNUNET_MessageHeader *) buf;
      type = ntohs (msg->type);
      break;
    case GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE:
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   path create\n");
      data_size = send_core_path_create (queue->cls, size, buf);
      break;
    case GNUNET_MESSAGE_TYPE_MESH_PATH_ACK:
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   path ack\n");
      data_size = send_core_path_ack (queue->cls, size, buf);
      break;
    default:
      GNUNET_break (0);
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "*   type unknown: %u\n",
                  queue->type);
      data_size = 0;
  }

  /* Free queue, but cls was freed by send_core_* */
  queue_destroy (queue, GNUNET_NO);

  /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
  switch (type)
  {
    case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
      t->next_fc.last_pid_sent = ((struct GNUNET_MESH_Unicast *) buf)->pid;
      tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_UNICAST);
      break;
    case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
      t->prev_fc.last_pid_sent = ((struct GNUNET_MESH_ToOrigin *) buf)->pid;
      tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
      break;
    default:
      break;
  }

  if (GNUNET_YES == t->destroy && 0 == t->pending_messages)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*  destroying tunnel!\n");
    tunnel_destroy (t);
  }

  /* If more data in queue, send next */
  queue = queue_get_next (peer);
  if (NULL != queue)
  {
      struct GNUNET_PeerIdentity id;

      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*   more data!\n");
      GNUNET_PEER_resolve (peer->id, &id);
      peer->core_transmit =
          GNUNET_CORE_notify_transmit_ready(core_handle,
                                            0,
                                            0,
                                            GNUNET_TIME_UNIT_FOREVER_REL,
                                            &id,
                                            queue->size,
                                            &queue_send,
                                            peer);
  }
  else if (NULL != peer->queue_head)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "*   %s stalled\n",
                GNUNET_i2s (&my_full_id));
    if (peer->id == t->next_hop)
      fc = &t->next_fc;
    else if (peer->id == t->prev_hop)
      fc = &t->prev_fc;
    else
    {
      GNUNET_break (0);
      fc = NULL;
    }
    if (NULL != fc && GNUNET_SCHEDULER_NO_TASK == fc->poll_task)
    {
      fc->t = t;
      fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
                                                    &tunnel_poll, fc);
    }
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "*  Return %d\n", data_size);
  return data_size;
}


/**
 * @brief Queue and pass message to core when possible.
 * 
 * If type is payload (UNICAST, TO_ORIGIN) checks for queue status and
 * accounts for it. In case the queue is full, the message is dropped and
 * a break issued.
 * 
 * Otherwise, message is treated as internal and allowed to go regardless of 
 * queue status.
 *
 * @param cls Closure (@c type dependant). It will be used by queue_send to
 *            build the message to be sent if not already prebuilt.
 * @param type Type of the message, 0 for a raw message.
 * @param size Size of the message.
 * @param dst Neighbor to send message to.
 * @param t Tunnel this message belongs to.
 */
static void
queue_add (void *cls, uint16_t type, size_t size,
           struct MeshPeerInfo *dst, struct MeshTunnel *t)
{
  struct MeshPeerQueue *queue;
  struct GNUNET_PeerIdentity id;
  unsigned int *n;

  n = NULL;
  if (GNUNET_MESSAGE_TYPE_MESH_UNICAST == type)
  {
    n = &t->next_fc.queue_n;
  }
  else if (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN == type)
  {
    n = &t->prev_fc.queue_n;
  }
  if (NULL != n)
  {
    if (*n >= t->queue_max)
    {
      GNUNET_break(0);
      GNUNET_STATISTICS_update(stats,
                               "# messages dropped (buffer full)",
                               1, GNUNET_NO);
      return; /* Drop message */
    }
    (*n)++;
  }
  queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
  queue->cls = cls;
  queue->type = type;
  queue->size = size;
  queue->peer = dst;
  queue->tunnel = t;
  GNUNET_CONTAINER_DLL_insert_tail (dst->queue_head, dst->queue_tail, queue);
  if (NULL == dst->core_transmit)
  {
    GNUNET_PEER_resolve (dst->id, &id);
    dst->core_transmit =
        GNUNET_CORE_notify_transmit_ready (core_handle,
                                           0,
                                           0,
                                           GNUNET_TIME_UNIT_FOREVER_REL,
                                           &id,
                                           size,
                                           &queue_send,
                                           dst);
  }
  t->pending_messages++;
}


/******************************************************************************/
/********************      MESH NETWORK HANDLERS     **************************/
/******************************************************************************/


/**
 * Core handler for path creation
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_path_create (void *cls, const struct GNUNET_PeerIdentity *peer,
                         const struct GNUNET_MessageHeader *message)
{
  unsigned int own_pos;
  uint16_t size;
  uint16_t i;
  MESH_TunnelNumber tid;
  struct GNUNET_MESH_CreateTunnel *msg;
  struct GNUNET_PeerIdentity *pi;
  struct MeshPeerPath *path;
  struct MeshPeerInfo *dest_peer_info;
  struct MeshPeerInfo *orig_peer_info;
  struct MeshTunnel *t;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received a path create msg [%s]\n",
              GNUNET_i2s (&my_full_id));
  size = ntohs (message->size);
  if (size < sizeof (struct GNUNET_MESH_CreateTunnel))
  {
    GNUNET_break_op (0);
    return GNUNET_OK;
  }

  size -= sizeof (struct GNUNET_MESH_CreateTunnel);
  if (size % sizeof (struct GNUNET_PeerIdentity))
  {
    GNUNET_break_op (0);
    return GNUNET_OK;
  }
  size /= sizeof (struct GNUNET_PeerIdentity);
  if (size < 1)
  {
    GNUNET_break_op (0);
    return GNUNET_OK;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "    path has %u hops.\n", size);
  msg = (struct GNUNET_MESH_CreateTunnel *) message;

  tid = ntohl (msg->tid);
  pi = (struct GNUNET_PeerIdentity *) &msg[1];
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "    path is for tunnel %s[%X].\n", GNUNET_i2s (pi), tid);
  t = tunnel_get (pi, tid);
  if (NULL == t) /* might be a local tunnel */
  {
    uint32_t opt;

    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  Creating tunnel\n");
    t = tunnel_new (GNUNET_PEER_intern (pi), tid, NULL, 0);
    if (NULL == t)
    {
      GNUNET_break (0);
      return GNUNET_OK;
    }
    t->port = ntohl (msg->port);
    opt = ntohl (msg->opt);
    if (0 != (opt & MESH_TUNNEL_OPT_NOBUFFER))
    {
      t->nobuffer = GNUNET_YES;
      t->prev_fc.last_ack_sent = t->prev_fc.last_pid_recv + 1;
      t->next_fc.last_ack_sent = t->next_fc.last_pid_recv + 1;
      t->queue_max = 1;
    }
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  nobuffer:%d\n", t->nobuffer);

    tunnel_reset_timeout (t);
  }
  t->state = MESH_TUNNEL_WAITING;
  dest_peer_info =
      GNUNET_CONTAINER_multihashmap_get (peers, &pi[size - 1].hashPubKey);
  if (NULL == dest_peer_info)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  Creating PeerInfo for destination.\n");
    dest_peer_info = GNUNET_malloc (sizeof (struct MeshPeerInfo));
    dest_peer_info->id = GNUNET_PEER_intern (&pi[size - 1]);
    GNUNET_CONTAINER_multihashmap_put (peers, &pi[size - 1].hashPubKey,
                                       dest_peer_info,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
  }
  orig_peer_info = GNUNET_CONTAINER_multihashmap_get (peers, &pi->hashPubKey);
  if (NULL == orig_peer_info)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  Creating PeerInfo for origin.\n");
    orig_peer_info = GNUNET_malloc (sizeof (struct MeshPeerInfo));
    orig_peer_info->id = GNUNET_PEER_intern (pi);
    GNUNET_CONTAINER_multihashmap_put (peers, &pi->hashPubKey, orig_peer_info,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  Creating path...\n");
  path = path_new (size);
  own_pos = 0;
  for (i = 0; i < size; i++)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  ... adding %s\n",
                GNUNET_i2s (&pi[i]));
    path->peers[i] = GNUNET_PEER_intern (&pi[i]);
    if (path->peers[i] == myid)
      own_pos = i;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  Own position: %u\n", own_pos);
  if (own_pos == 0 && path->peers[own_pos] != myid)
  {
    /* create path: self not found in path through self */
    GNUNET_break_op (0);
    path_destroy (path);
    tunnel_destroy (t);
    return GNUNET_OK;
  }
  path_add_to_peers (path, GNUNET_NO);
  tunnel_use_path (t, path);

  if (own_pos == size - 1)
  {
    struct MeshClient *c;
    struct GNUNET_HashCode hc;

    /* Find target client */
    GMC_hash32 (t->port, &hc);
    c = GNUNET_CONTAINER_multihashmap_get (ports, &hc);
    if (NULL == c)
    {
      /* TODO send reject */
      return GNUNET_OK;
    }

    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  It's for us!\n");
    peer_info_add_path_to_origin (orig_peer_info, path, GNUNET_YES);
    t->dest = myid;

    /* Assign local tid */
    while (NULL != tunnel_get_incoming (next_local_tid))
      next_local_tid = (next_local_tid + 1) | GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
    t->local_tid_dest = next_local_tid++;
    next_local_tid = next_local_tid | GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;

    tunnel_add_client (t, c);
    send_client_tunnel_create (t);
    send_path_ack (t);
  }
  else
  {
    struct MeshPeerPath *path2;

    t->next_hop = path->peers[own_pos + 1];
    GNUNET_PEER_change_rc(t->next_hop, 1);

    /* It's for somebody else! Retransmit. */
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  Retransmitting.\n");
    path2 = path_duplicate (path);
    peer_info_add_path (dest_peer_info, path2, GNUNET_NO);
    peer_info_add_path_to_origin (orig_peer_info, path, GNUNET_NO);
    send_create_path (t);
  }
  return GNUNET_OK;
}



/**
 * Core handler for path ACKs
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_path_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
                      const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_PathACK *msg;
  struct MeshPeerInfo *peer_info;
  struct MeshPeerPath *p;
  struct MeshTunnel *t;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received a path ACK msg [%s]\n",
              GNUNET_i2s (&my_full_id));
  msg = (struct GNUNET_MESH_PathACK *) message;
  t = tunnel_get (&msg->oid, ntohl(msg->tid));
  if (NULL == t)
  {
    /* TODO notify that we don't know the tunnel */
    GNUNET_STATISTICS_update (stats, "# control on unknown tunnel", 1, GNUNET_NO);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  don't know the tunnel %s [%X]!\n",
                GNUNET_i2s (&msg->oid), ntohl(msg->tid));
    return GNUNET_OK;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  on tunnel %s [%X]\n",
              GNUNET_i2s (&msg->oid), ntohl(msg->tid));

  peer_info = peer_get (&msg->peer_id);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by peer %s\n",
              GNUNET_i2s (&msg->peer_id));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  via peer %s\n",
              GNUNET_i2s (peer));

  /* Add path to peers? */
  p = t->path;
  if (NULL != p)
  {
    path_add_to_peers (p, GNUNET_YES);
  }
  else
  {
    GNUNET_break (0);
  }
  t->state = MESH_TUNNEL_READY;
  t->next_fc.last_ack_recv = ntohl (msg->ack);
  t->prev_fc.last_ack_sent = ntohl (msg->ack);

  /* Message for us? */
  if (0 == memcmp (&msg->oid, &my_full_id, sizeof (struct GNUNET_PeerIdentity)))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  It's for us!\n");
    if (NULL == t->owner)
    {
      GNUNET_break_op (0);
      return GNUNET_OK;
    }
    if (NULL != peer_info->dhtget)
    {
      GNUNET_DHT_get_stop (peer_info->dhtget);
      peer_info->dhtget = NULL;
    }
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_PATH_ACK);
    return GNUNET_OK;
  }

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "  not for us, retransmitting...\n");
  peer_info = peer_get (&msg->oid);
  send_prebuilt_message (message, t->prev_hop, t);
  return GNUNET_OK;
}


/**
 * Core handler for notifications of broken paths
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_path_broken (void *cls, const struct GNUNET_PeerIdentity *peer,
                         const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_PathBroken *msg;
  struct MeshTunnel *t;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received a PATH BROKEN msg from %s\n", GNUNET_i2s (peer));
  msg = (struct GNUNET_MESH_PathBroken *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
              GNUNET_i2s (&msg->peer1));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
              GNUNET_i2s (&msg->peer2));
  t = tunnel_get (&msg->oid, ntohl (msg->tid));
  if (NULL == t)
  {
    GNUNET_break_op (0);
    return GNUNET_OK;
  }
  tunnel_notify_connection_broken (t, GNUNET_PEER_search (&msg->peer1),
                                   GNUNET_PEER_search (&msg->peer2));
  return GNUNET_OK;

}


/**
 * Core handler for tunnel destruction
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_tunnel_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
                            const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_TunnelDestroy *msg;
  struct MeshTunnel *t;

  msg = (struct GNUNET_MESH_TunnelDestroy *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Got a TUNNEL DESTROY packet from %s\n",
              GNUNET_i2s (peer));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "  for tunnel %s [%u]\n",
              GNUNET_i2s (&msg->oid), ntohl (msg->tid));
  t = tunnel_get (&msg->oid, ntohl (msg->tid));
  if (NULL == t)
  {
    /* Probably already got the message from another path,
     * destroyed the tunnel and retransmitted to children.
     * Safe to ignore.
     */
    GNUNET_STATISTICS_update (stats, "# control on unknown tunnel",
                              1, GNUNET_NO);
    return GNUNET_OK;
  }
  // TODO check owner's signature
  if (t->local_tid_dest >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
  {
    /* Tunnel was incoming, notify clients */
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "INCOMING TUNNEL %X %X\n",
                t->local_tid, t->local_tid_dest);
    send_client_tunnel_destroy (t);
  }
  tunnel_send_destroy (t);
  t->destroy = GNUNET_YES;
  // TODO: add timeout to destroy the tunnel anyway
  return GNUNET_OK;
}


/**
 * Core handler for mesh network traffic going from the origin to a peer
 *
 * @param cls closure
 * @param peer peer identity this notification is about
 * @param message message
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_unicast (void *cls, const struct GNUNET_PeerIdentity *peer,
                          const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_Unicast *msg;
  struct MeshTunnel *t;
  uint32_t pid;
  uint32_t ttl;
  size_t size;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got a unicast packet from %s\n",
              GNUNET_i2s (peer));
  /* Check size */
  size = ntohs (message->size);
  if (size <
      sizeof (struct GNUNET_MESH_Unicast) +
      sizeof (struct GNUNET_MessageHeader))
  {
    GNUNET_break (0);
    return GNUNET_OK;
  }
  msg = (struct GNUNET_MESH_Unicast *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " of type %s\n",
              GNUNET_MESH_DEBUG_M2S (ntohs (msg[1].header.type)));
  /* Check tunnel */
  t = tunnel_get (&msg->oid, ntohl (msg->tid));
  if (NULL == t)
  {
    /* TODO notify back: we don't know this tunnel */
    GNUNET_STATISTICS_update (stats, "# data on unknown tunnel", 1, GNUNET_NO);
    GNUNET_break_op (0);
    return GNUNET_OK;
  }
  pid = ntohl (msg->pid);
  if (t->prev_fc.last_pid_recv == pid)
  {
    GNUNET_STATISTICS_update (stats, "# duplicate PID drops", 1, GNUNET_NO);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                " Already seen pid %u, DROPPING!\n", pid);
    return GNUNET_OK;
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                " pid %u not seen yet, forwarding\n", pid);
  }

  if (GMC_is_pid_bigger (pid, t->prev_fc.last_ack_sent))
  {
    GNUNET_STATISTICS_update (stats, "# unsolicited unicast", 1, GNUNET_NO);
    GNUNET_break_op (0);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Received PID %u, ACK %u\n",
                pid, t->prev_fc.last_ack_sent);
    tunnel_send_fwd_ack(t, GNUNET_MESSAGE_TYPE_MESH_POLL);
    return GNUNET_OK;
  }
  t->prev_fc.last_pid_recv = pid;

  tunnel_reset_timeout (t);
  if (t->dest == myid)
  {
    if (NULL == t->client)
    {
      GNUNET_break (0);
      return GNUNET_OK;
    }
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  it's for us! sending to clients...\n");
    GNUNET_STATISTICS_update (stats, "# unicast received", 1, GNUNET_NO);
    GNUNET_SERVER_notification_context_unicast (nc, t->client->handle,
                                                message, GNUNET_NO);
    tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_UNICAST);
    return GNUNET_OK;
  }
  if (0 == t->next_hop)
  {
    GNUNET_break (0);
    return GNUNET_OK;
  }
  ttl = ntohl (msg->ttl);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   ttl: %u\n", ttl);
  if (ttl == 0)
  {
    GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
    tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_ACK);
    return GNUNET_OK;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "  not for us, retransmitting...\n");

  send_prebuilt_message (message, t->next_hop, t);
  GNUNET_STATISTICS_update (stats, "# unicast forwarded", 1, GNUNET_NO);
  return GNUNET_OK;
}


/**
 * Core handler for mesh network traffic toward the owner of a tunnel
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_to_orig (void *cls, const struct GNUNET_PeerIdentity *peer,
                          const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_ToOrigin *msg;
  struct MeshTunnel *t;
  size_t size;
  uint32_t pid;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got a ToOrigin packet from %s\n",
              GNUNET_i2s (peer));
  size = ntohs (message->size);
  if (size < sizeof (struct GNUNET_MESH_ToOrigin) +     /* Payload must be */
      sizeof (struct GNUNET_MessageHeader))     /* at least a header */
  {
    GNUNET_break_op (0);
    return GNUNET_OK;
  }
  msg = (struct GNUNET_MESH_ToOrigin *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " of type %s\n",
              GNUNET_MESH_DEBUG_M2S (ntohs (msg[1].header.type)));
  t = tunnel_get (&msg->oid, ntohl (msg->tid));
  pid = ntohl (msg->pid);

  if (NULL == t)
  {
    /* TODO notify that we dont know this tunnel (whom)? */
    GNUNET_STATISTICS_update (stats, "# data on unknown tunnel", 1, GNUNET_NO);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Received to_origin with PID %u on unknown tunnel %s [%u]\n",
                pid, GNUNET_i2s (&msg->oid), ntohl (msg->tid));
    return GNUNET_OK;
  }

  if (t->next_fc.last_pid_recv == pid)
  {
    /* already seen this packet, drop */
    GNUNET_STATISTICS_update (stats, "# duplicate PID drops BCK", 1, GNUNET_NO);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                " Already seen pid %u, DROPPING!\n", pid);
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_ACK);
    return GNUNET_OK;
  }

  if (GMC_is_pid_bigger (pid, t->next_fc.last_ack_sent))
  {
    GNUNET_STATISTICS_update (stats, "# unsolicited to_orig", 1, GNUNET_NO);
    GNUNET_break_op (0);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Received PID %u, ACK %u\n",
                pid, t->next_fc.last_ack_sent);
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_POLL);
    return GNUNET_OK;
  }
  t->next_fc.last_pid_recv = pid;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              " pid %u not seen yet, forwarding\n", pid);

  if (NULL != t->owner)
  {
    char cbuf[size];
    struct GNUNET_MESH_ToOrigin *copy;

    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  it's for us! sending to clients...\n");
    /* TODO signature verification */
    memcpy (cbuf, message, size);
    copy = (struct GNUNET_MESH_ToOrigin *) cbuf;
    copy->tid = htonl (t->local_tid);
    GNUNET_STATISTICS_update (stats, "# to origin received", 1, GNUNET_NO);
    GNUNET_SERVER_notification_context_unicast (nc, t->owner->handle,
                                                &copy->header, GNUNET_NO);
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
    return GNUNET_OK;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "  not for us, retransmitting...\n");

  if (0 == t->prev_hop) /* No owner AND no prev hop */
  {
    if (GNUNET_YES == t->destroy)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "to orig received on a dying tunnel %s [%X]\n",
                  GNUNET_i2s (&msg->oid), ntohl(msg->tid));
      return GNUNET_OK;
    }
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, 
                "unknown to origin at %s\n",
                GNUNET_i2s (&my_full_id));
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, 
                "from peer %s\n",
                GNUNET_i2s (peer));
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, 
                "on tunnel %s [%X]\n",
                GNUNET_i2s (&msg->oid), ntohl(msg->tid));
    return GNUNET_OK;
  }
  send_prebuilt_message (message, t->prev_hop, t);
  GNUNET_STATISTICS_update (stats, "# to origin forwarded", 1, GNUNET_NO);

  return GNUNET_OK;
}


/**
 * Core handler for mesh network traffic point-to-point acks.
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
                 const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_ACK *msg;
  struct MeshTunnel *t;
  GNUNET_PEER_Id id;
  uint32_t ack;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
              GNUNET_i2s (peer));
  msg = (struct GNUNET_MESH_ACK *) message;

  t = tunnel_get (&msg->oid, ntohl (msg->tid));

  if (NULL == t)
  {
    /* TODO notify that we dont know this tunnel (whom)? */
    GNUNET_STATISTICS_update (stats, "# ack on unknown tunnel", 1, GNUNET_NO);
    return GNUNET_OK;
  }
  ack = ntohl (msg->pid);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  ACK %u\n", ack);

  /* Is this a forward or backward ACK? */
  id = GNUNET_PEER_search (peer);
  if (t->next_hop == id)
  {
    debug_fwd_ack++;
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  FWD ACK\n");
    if (GNUNET_SCHEDULER_NO_TASK != t->next_fc.poll_task &&
        GMC_is_pid_bigger (ack, t->next_fc.last_ack_recv))
    {
      GNUNET_SCHEDULER_cancel (t->next_fc.poll_task);
      t->next_fc.poll_task = GNUNET_SCHEDULER_NO_TASK;
      t->next_fc.poll_time = GNUNET_TIME_UNIT_SECONDS;
    }
    t->next_fc.last_ack_recv = ack;
    peer_unlock_queue (t->next_hop);
    tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_ACK);
  }
  else if (t->prev_hop == id)
  {
    debug_bck_ack++;
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  BCK ACK\n");
    if (GNUNET_SCHEDULER_NO_TASK != t->prev_fc.poll_task &&
        GMC_is_pid_bigger (ack, t->prev_fc.last_ack_recv))
    {
      GNUNET_SCHEDULER_cancel (t->prev_fc.poll_task);
      t->prev_fc.poll_task = GNUNET_SCHEDULER_NO_TASK;
      t->prev_fc.poll_time = GNUNET_TIME_UNIT_SECONDS;
    }
    t->prev_fc.last_ack_recv = ack;
    peer_unlock_queue (t->prev_hop);
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_ACK);
  }
  else
    GNUNET_break_op (0);
  return GNUNET_OK;
}


/**
 * Core handler for mesh network traffic point-to-point ack polls.
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 *
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 */
static int
handle_mesh_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
                  const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_Poll *msg;
  struct MeshTunnel *t;
  GNUNET_PEER_Id id;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got an POLL packet from %s!\n",
              GNUNET_i2s (peer));

  msg = (struct GNUNET_MESH_Poll *) message;

  t = tunnel_get (&msg->oid, ntohl (msg->tid));

  if (NULL == t)
  {
    /* TODO notify that we dont know this tunnel (whom)? */
    GNUNET_STATISTICS_update (stats, "# poll on unknown tunnel", 1, GNUNET_NO);
    GNUNET_break_op (0);
    return GNUNET_OK;
  }

  /* Is this a forward or backward ACK? */
  id = GNUNET_PEER_search(peer);
  if (t->next_hop == id)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  from FWD\n");
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_POLL);
  }
  else if (t->prev_hop == id)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  from BCK\n");
    tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_POLL);
  }
  else
    GNUNET_break (0);

  return GNUNET_OK;
}


/**
 * Core handler for mesh keepalives.
 *
 * @param cls closure
 * @param message message
 * @param peer peer identity this notification is about
 * @return GNUNET_OK to keep the connection open,
 *         GNUNET_SYSERR to close it (signal serious error)
 *
 * TODO: Check who we got this from, to validate route.
 */
static int
handle_mesh_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
                       const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_TunnelKeepAlive *msg;
  struct MeshTunnel *t;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
              GNUNET_i2s (peer));

  msg = (struct GNUNET_MESH_TunnelKeepAlive *) message;
  t = tunnel_get (&msg->oid, ntohl (msg->tid));

  if (NULL == t)
  {
    /* TODO notify that we dont know that tunnel */
    GNUNET_STATISTICS_update (stats, "# keepalive on unknown tunnel", 1,
                              GNUNET_NO);
    return GNUNET_OK;
  }

  tunnel_reset_timeout (t);

  GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
  send_prebuilt_message (message, t->next_hop, t);
  return GNUNET_OK;
  }



/**
 * Functions to handle messages from core
 */
static struct GNUNET_CORE_MessageHandler core_handlers[] = {
  {&handle_mesh_path_create, GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE, 0},
  {&handle_mesh_path_broken, GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN,
   sizeof (struct GNUNET_MESH_PathBroken)},
  {&handle_mesh_tunnel_destroy, GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY,
   sizeof (struct GNUNET_MESH_TunnelDestroy)},
  {&handle_mesh_unicast, GNUNET_MESSAGE_TYPE_MESH_UNICAST, 0},
  {&handle_mesh_keepalive, GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE,
    sizeof (struct GNUNET_MESH_TunnelKeepAlive)},
  {&handle_mesh_to_orig, GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN, 0},
  {&handle_mesh_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
    sizeof (struct GNUNET_MESH_ACK)},
  {&handle_mesh_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
    sizeof (struct GNUNET_MESH_Poll)},
  {&handle_mesh_path_ack, GNUNET_MESSAGE_TYPE_MESH_PATH_ACK,
   sizeof (struct GNUNET_MESH_PathACK)},
  {NULL, 0, 0}
};



/******************************************************************************/
/****************       MESH LOCAL HANDLER HELPERS      ***********************/
/******************************************************************************/


#if LATER
/**
 * notify_client_connection_failure: notify a client that the connection to the
 * requested remote peer is not possible (for instance, no route found)
 * Function called when the socket is ready to queue more data. "buf" will be
 * NULL and "size" zero if the socket was closed for writing in the meantime.
 *
 * @param cls closure
 * @param size number of bytes available in buf
 * @param buf where the callee should write the message
 * @return number of bytes written to buf
 */
static size_t
notify_client_connection_failure (void *cls, size_t size, void *buf)
{
  int size_needed;
  struct MeshPeerInfo *peer_info;
  struct GNUNET_MESH_PeerControl *msg;
  struct GNUNET_PeerIdentity id;

  if (0 == size && NULL == buf)
  {
    // TODO retry? cancel?
    return 0;
  }

  size_needed = sizeof (struct GNUNET_MESH_PeerControl);
  peer_info = (struct MeshPeerInfo *) cls;
  msg = (struct GNUNET_MESH_PeerControl *) buf;
  msg->header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DISCONNECTED);
//     msg->tunnel_id = htonl(peer_info->t->tid);
  GNUNET_PEER_resolve (peer_info->id, &id);
  memcpy (&msg->peer, &id, sizeof (struct GNUNET_PeerIdentity));

  return size_needed;
}
#endif


/**
 * Send keepalive packets for a tunnel.
 *
 * @param cls Closure (tunnel for which to send the keepalive).
 * @param tc Notification context.
 */
static void
path_refresh (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct MeshTunnel *t = cls;
  struct GNUNET_MESH_TunnelKeepAlive *msg;
  size_t size = sizeof (struct GNUNET_MESH_TunnelKeepAlive);
  char cbuf[size];

  t->maintenance_task = GNUNET_SCHEDULER_NO_TASK;
  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) ||
      NULL == t->owner || 0 == t->local_tid || 0 != t->prev_hop)
  {
    return;
  }

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "sending keepalive for tunnel %d\n", t->id.tid);

  msg = (struct GNUNET_MESH_TunnelKeepAlive *) cbuf;
  msg->header.size = htons (size);
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE);
  msg->oid = my_full_id;
  msg->tid = htonl (t->id.tid);
  send_prebuilt_message (&msg->header, t->next_hop, t);

  t->maintenance_task =
      GNUNET_SCHEDULER_add_delayed (refresh_path_time, &path_refresh, t);
}


/**
 * Function to process paths received for a new peer addition. The recorded
 * paths form the initial tunnel, which can be optimized later.
 * Called on each result obtained for the DHT search.
 *
 * @param cls closure
 * @param exp when will this value expire
 * @param key key of the result
 * @param get_path path of the get request
 * @param get_path_length lenght of get_path
 * @param put_path path of the put request
 * @param put_path_length length of the put_path
 * @param type type of the result
 * @param size number of bytes in data
 * @param data pointer to the result data
 */
static void
dht_get_id_handler (void *cls, struct GNUNET_TIME_Absolute exp,
                    const struct GNUNET_HashCode * key,
                    const struct GNUNET_PeerIdentity *get_path,
                    unsigned int get_path_length,
                    const struct GNUNET_PeerIdentity *put_path,
                    unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
                    size_t size, const void *data)
{
  struct MeshPeerInfo *peer = cls;
  struct MeshPeerPath *p;
  struct GNUNET_PeerIdentity pi;
  int i;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got results from DHT!\n");
  GNUNET_PEER_resolve (peer->id, &pi);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  for %s\n", GNUNET_i2s (&pi));

  p = path_build_from_dht (get_path, get_path_length,
                           put_path, put_path_length);
  path_add_to_peers (p, GNUNET_NO);
  path_destroy (p);
  for (i = 0; i < peer->ntunnels; i++)
  {
    if (peer->tunnels[i]->state == MESH_TUNNEL_SEARCHING)
      peer_connect (peer, peer->tunnels[i]);
  }

  return;
}


/******************************************************************************/
/*********************       MESH LOCAL HANDLES      **************************/
/******************************************************************************/


/**
 * Handler for client disconnection
 *
 * @param cls closure
 * @param client identification of the client; NULL
 *        for the last call when the server is destroyed
 */
static void
handle_local_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
{
  struct MeshClient *c;
  struct MeshClient *next;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "client disconnected\n");
  if (client == NULL)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   (SERVER DOWN)\n");
    return;
  }

  c = clients_head;
  while (NULL != c)
  {
    if (c->handle != client)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "   ... searching\n");
      c = c->next;
      continue;
    }
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "matching client found (%u)\n",
                c->id);
    GNUNET_SERVER_client_drop (c->handle);
    c->shutting_down = GNUNET_YES;
    GNUNET_CONTAINER_multihashmap_iterate (c->own_tunnels,
                                           &tunnel_destroy_iterator, c);
    GNUNET_CONTAINER_multihashmap_iterate (c->incoming_tunnels,
                                           &tunnel_destroy_iterator, c);
    GNUNET_CONTAINER_multihashmap_destroy (c->own_tunnels);
    GNUNET_CONTAINER_multihashmap_destroy (c->incoming_tunnels);

    if (NULL != c->ports)
      GNUNET_CONTAINER_multihashmap_destroy (c->ports);
    next = c->next;
    GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, c);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  CLIENT FREE at %p\n", c);
    GNUNET_free (c);
    GNUNET_STATISTICS_update (stats, "# clients", -1, GNUNET_NO);
    c = next;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "done!\n");
  return;
}


/**
 * Handler for new clients
 *
 * @param cls closure
 * @param client identification of the client
 * @param message the actual message, which includes messages the client wants
 */
static void
handle_local_new_client (void *cls, struct GNUNET_SERVER_Client *client,
                         const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_ClientConnect *cc_msg;
  struct MeshClient *c;
  unsigned int size;
  uint32_t *p;
  unsigned int i;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new client connected\n");

  /* Check data sanity */
  size = ntohs (message->size) - sizeof (struct GNUNET_MESH_ClientConnect);
  cc_msg = (struct GNUNET_MESH_ClientConnect *) message;
  if (0 != (size % sizeof (uint32_t)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  size /= sizeof (uint32_t);

  /* Create new client structure */
  c = GNUNET_malloc (sizeof (struct MeshClient));
  c->id = next_client_id++; /* overflow not important: just for debug */
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  client id %u\n", c->id);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  client has %u ports\n", size);
  c->handle = client;
  GNUNET_SERVER_client_keep (client);
  if (size > 0)
  {
    uint32_t u32;
    struct GNUNET_HashCode hc;

    p = (uint32_t *) &cc_msg[1];
    c->ports = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
    for (i = 0; i < size; i++)
    {
      u32 = ntohl (p[i]);
      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "    port: %u\n", u32);
      GMC_hash32 (u32, &hc);

      /* store in client's hashmap */
      GNUNET_CONTAINER_multihashmap_put (c->ports, &hc, c,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
      /* store in global hashmap */
      /* FIXME only allow one client to have the port open,
       *       have a backup hashmap with waiting clients */
      GNUNET_CONTAINER_multihashmap_put (ports, &hc, c,
                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
    }
  }

  GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, c);
  c->own_tunnels = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);
  c->incoming_tunnels = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);
  GNUNET_SERVER_notification_context_add (nc, client);
  GNUNET_STATISTICS_update (stats, "# clients", 1, GNUNET_NO);

  GNUNET_SERVER_receive_done (client, GNUNET_OK);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new client processed\n");
}


/**
 * Handler for requests of new tunnels
 *
 * @param cls Closure.
 * @param client Identification of the client.
 * @param message The actual message.
 */
static void
handle_local_tunnel_create (void *cls, struct GNUNET_SERVER_Client *client,
                            const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_TunnelMessage *t_msg;
  struct MeshPeerInfo *peer_info;
  struct MeshTunnel *t;
  struct MeshClient *c;
  MESH_TunnelNumber tid;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new tunnel requested\n");

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  /* Message sanity check */
  if (sizeof (struct GNUNET_MESH_TunnelMessage) != ntohs (message->size))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  t_msg = (struct GNUNET_MESH_TunnelMessage *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  towards %s\n",
              GNUNET_i2s (&t_msg->peer));
  /* Sanity check for tunnel numbering */
  tid = ntohl (t_msg->tunnel_id);
  if (0 == (tid & GNUNET_MESH_LOCAL_TUNNEL_ID_CLI))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  /* Sanity check for duplicate tunnel IDs */
  if (NULL != tunnel_get_by_local_id (c, tid))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  while (NULL != tunnel_get_by_pi (myid, next_tid))
    next_tid = (next_tid + 1) & ~GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
  t = tunnel_new (myid, next_tid, c, tid);
  next_tid = (next_tid + 1) & ~GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
  if (NULL == t)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  t->port = ntohl (t_msg->port);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "CREATED TUNNEL %s[%x]:%u (%x)\n",
              GNUNET_i2s (&my_full_id), t->id.tid, t->port, t->local_tid);

  peer_info = peer_get (&t_msg->peer);
  GNUNET_array_append (peer_info->tunnels, peer_info->ntunnels, t);
  peer_connect (peer_info, t);
  GNUNET_SERVER_receive_done (client, GNUNET_OK);
  return;
}


/**
 * Handler for requests of deleting tunnels
 *
 * @param cls closure
 * @param client identification of the client
 * @param message the actual message
 */
static void
handle_local_tunnel_destroy (void *cls, struct GNUNET_SERVER_Client *client,
                             const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_TunnelMessage *tunnel_msg;
  struct MeshClient *c;
  struct MeshTunnel *t;
  MESH_TunnelNumber tid;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Got a DESTROY TUNNEL from client!\n");

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  /* Message sanity check */
  if (sizeof (struct GNUNET_MESH_TunnelMessage) != ntohs (message->size))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  tunnel_msg = (struct GNUNET_MESH_TunnelMessage *) message;

  /* Retrieve tunnel */
  tid = ntohl (tunnel_msg->tunnel_id);
  t = tunnel_get_by_local_id(c, tid);
  if (NULL == t)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  tunnel %X not found\n", tid);
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  if (c == t->client)
  {
    tunnel_destroy_empty (t);
    GNUNET_SERVER_receive_done (client, GNUNET_OK);
    return;
  }
  send_client_tunnel_destroy (t);
  client_delete_tunnel (c, t);

  /* Don't try to ACK the client about the tunnel_destroy multicast packet */
  t->owner = NULL;
  tunnel_send_destroy (t);
  peer_remove_tunnel (peer_get_short(t->dest), t);
  t->destroy = GNUNET_YES;
  /* The tunnel will be destroyed when the last message is transmitted. */
  GNUNET_SERVER_receive_done (client, GNUNET_OK);
  return;
}


/**
 * Handler for requests of seeting tunnel's buffering policy.
 *
 * @param cls Closure (unused).
 * @param client Identification of the client.
 * @param message The actual message.
 */
static void
handle_local_tunnel_buffer (void *cls, struct GNUNET_SERVER_Client *client,
                            const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_TunnelMessage *tunnel_msg;
  struct MeshClient *c;
  struct MeshTunnel *t;
  MESH_TunnelNumber tid;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Got a BUFFER request from client!\n");

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  tunnel_msg = (struct GNUNET_MESH_TunnelMessage *) message;

  /* Retrieve tunnel */
  tid = ntohl (tunnel_msg->tunnel_id);
  t = tunnel_get_by_local_id(c, tid);
  if (NULL == t)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "  tunnel %X not found\n", tid);
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  switch (ntohs(message->type))
  {
      case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER:
          t->nobuffer = GNUNET_NO;
          break;
      case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER:
          t->nobuffer = GNUNET_YES;
          break;
      default:
          GNUNET_break (0);
  }

  GNUNET_SERVER_receive_done (client, GNUNET_OK);
}


/**
 * Handler for client traffic directed to one peer
 *
 * @param cls closure
 * @param client identification of the client
 * @param message the actual message
 */
static void
handle_local_unicast (void *cls, struct GNUNET_SERVER_Client *client,
                      const struct GNUNET_MessageHeader *message)
{
  struct MeshClient *c;
  struct MeshTunnel *t;
  struct GNUNET_MESH_Unicast *data_msg;
  MESH_TunnelNumber tid;
  size_t size;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Got a unicast request from a client!\n");

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  data_msg = (struct GNUNET_MESH_Unicast *) message;

  /* Sanity check for message size */
  size = ntohs (message->size);
  if (sizeof (struct GNUNET_MESH_Unicast) +
      sizeof (struct GNUNET_MessageHeader) > size)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* Tunnel exists? */
  tid = ntohl (data_msg->tid);
  t = tunnel_get_by_local_id (c, tid);
  if (NULL == t)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /*  Is it a local tunnel? Then, does client own the tunnel? */
  if (t->owner->handle != client)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* PID should be as expected: client<->service communication */
  if (ntohl (data_msg->pid) != t->prev_fc.last_pid_recv + 1)
  {
    GNUNET_break (0);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
              "Unicast PID, expected %u, got %u\n",
              t->prev_fc.last_pid_recv + 1, ntohl (data_msg->pid));
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* Ok, everything is correct, send the message
   * (pretend we got it from a mesh peer)
   */
  {
    /* Work around const limitation */
    char buf[ntohs (message->size)] GNUNET_ALIGN;
    struct GNUNET_MESH_Unicast *copy;

    copy = (struct GNUNET_MESH_Unicast *) buf;
    memcpy (buf, data_msg, size);
    copy->oid = my_full_id;
    copy->tid = htonl (t->id.tid);
    copy->ttl = htonl (default_ttl);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  calling generic handler...\n");
        handle_mesh_unicast (NULL, &my_full_id, &copy->header);
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "receive done OK\n");
  GNUNET_SERVER_receive_done (client, GNUNET_OK);

  return;
}


/**
 * Handler for client traffic directed to the origin
 *
 * @param cls closure
 * @param client identification of the client
 * @param message the actual message
 */
static void
handle_local_to_origin (void *cls, struct GNUNET_SERVER_Client *client,
                        const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_ToOrigin *data_msg;
  struct MeshFlowControl *fc;
  struct MeshClient *c;
  struct MeshTunnel *t;
  MESH_TunnelNumber tid;
  size_t size;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Got a ToOrigin request from a client!\n");
  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  data_msg = (struct GNUNET_MESH_ToOrigin *) message;

  /* Sanity check for message size */
  size = ntohs (message->size);
  if (sizeof (struct GNUNET_MESH_ToOrigin) +
      sizeof (struct GNUNET_MessageHeader) > size)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* Tunnel exists? */
  tid = ntohl (data_msg->tid);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  on tunnel %X\n", tid);
  if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  t = tunnel_get_by_local_id (c, tid);
  if (NULL == t)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tunnel %X unknown.\n", tid);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "  for client %u.\n", c->id);
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /*  It should be sent by someone who has this as incoming tunnel. */
  if (t->client != c)
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* PID should be as expected */
  fc = &t->next_fc;
  if (ntohl (data_msg->pid) != fc->last_pid_recv + 1)
  {
    GNUNET_break (0);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "To Origin PID, expected %u, got %u\n",
                fc->last_pid_recv + 1,
                ntohl (data_msg->pid));
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  /* Ok, everything is correct, send the message
   * (pretend we got it from a mesh peer)
   */
  {
    char buf[ntohs (message->size)] GNUNET_ALIGN;
    struct GNUNET_MESH_ToOrigin *copy;

    /* Work around 'const' limitation */
    memcpy (buf, data_msg, size);
    copy = (struct GNUNET_MESH_ToOrigin *) buf;
    GNUNET_PEER_resolve (t->id.oid, &copy->oid);
    copy->tid = htonl (t->id.tid);
    copy->ttl = htonl (default_ttl);

    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "  calling generic handler...\n");
        handle_mesh_to_orig (NULL, &my_full_id, &copy->header);
  }
  GNUNET_SERVER_receive_done (client, GNUNET_OK);

  return;
}


/**
 * Handler for client's ACKs for payload traffic.
 *
 * @param cls Closure (unused).
 * @param client Identification of the client.
 * @param message The actual message.
 */
static void
handle_local_ack (void *cls, struct GNUNET_SERVER_Client *client,
                  const struct GNUNET_MessageHeader *message)
{
  struct GNUNET_MESH_LocalAck *msg;
  struct MeshTunnel *t;
  struct MeshClient *c;
  MESH_TunnelNumber tid;
  uint32_t ack;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got a local ACK\n");
  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  by client %u\n", c->id);

  msg = (struct GNUNET_MESH_LocalAck *) message;

  /* Tunnel exists? */
  tid = ntohl (msg->tunnel_id);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  on tunnel %X\n", tid);
  t = tunnel_get_by_local_id (c, tid);
  if (NULL == t)
  {
    GNUNET_break (0);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tunnel %X unknown.\n", tid);
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "  for client %u.\n", c->id);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  ack = ntohl (msg->max_pid);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "  ack %u\n", ack);

  /* Does client own tunnel? I.E: Is this an ACK for BCK traffic? */
  if (t->owner == c)
  {
    /* The client owns the tunnel, ACK is for data to_origin, send BCK ACK. */
    t->prev_fc.last_ack_recv = ack;
    tunnel_send_bck_ack (t, GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
  }
  else
  {
    /* The client doesn't own the tunnel, this ACK is for FWD traffic. */
    t->next_fc.last_ack_recv = ack;
    tunnel_send_fwd_ack (t, GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
  }

  GNUNET_SERVER_receive_done (client, GNUNET_OK);

  return;
}



/**
 * Iterator over all tunnels to send a monitoring client info about each tunnel.
 *
 * @param cls Closure (client handle).
 * @param key Key (hashed tunnel ID, unused).
 * @param value Tunnel info.
 *
 * @return GNUNET_YES, to keep iterating.
 */
static int
monitor_all_tunnels_iterator (void *cls,
                              const struct GNUNET_HashCode * key,
                              void *value)
{
  struct GNUNET_SERVER_Client *client = cls;
  struct MeshTunnel *t = value;
  struct GNUNET_MESH_LocalMonitor *msg;

  msg = GNUNET_malloc (sizeof(struct GNUNET_MESH_LocalMonitor));
  GNUNET_PEER_resolve(t->id.oid, &msg->owner);
  msg->tunnel_id = htonl (t->id.tid);
  msg->header.size = htons (sizeof (struct GNUNET_MESH_LocalMonitor));
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
  GNUNET_PEER_resolve (t->dest, &msg->destination);

  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "*  sending info about tunnel %s [%u]\n",
              GNUNET_i2s (&msg->owner), t->id.tid);

  GNUNET_SERVER_notification_context_unicast (nc, client,
                                              &msg->header, GNUNET_NO);
  return GNUNET_YES;
}


/**
 * Handler for client's MONITOR request.
 *
 * @param cls Closure (unused).
 * @param client Identification of the client.
 * @param message The actual message.
 */
static void
handle_local_get_tunnels (void *cls, struct GNUNET_SERVER_Client *client,
                          const struct GNUNET_MessageHeader *message)
{
  struct MeshClient *c;

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Received get tunnels request from client %u\n",
              c->id);
  GNUNET_CONTAINER_multihashmap_iterate (tunnels,
                                         monitor_all_tunnels_iterator,
                                         client);
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Get tunnels request from client %u completed\n",
              c->id);
  GNUNET_SERVER_receive_done (client, GNUNET_OK);
}


/**
 * Handler for client's MONITOR_TUNNEL request.
 *
 * @param cls Closure (unused).
 * @param client Identification of the client.
 * @param message The actual message.
 */
static void
handle_local_show_tunnel (void *cls, struct GNUNET_SERVER_Client *client,
                          const struct GNUNET_MessageHeader *message)
{
  const struct GNUNET_MESH_LocalMonitor *msg;
  struct GNUNET_MESH_LocalMonitor *resp;
  struct MeshClient *c;
  struct MeshTunnel *t;

  /* Sanity check for client registration */
  if (NULL == (c = client_get (client)))
  {
    GNUNET_break (0);
    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
    return;
  }

  msg = (struct GNUNET_MESH_LocalMonitor *) message;
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Received tunnel info request from client %u for tunnel %s[%X]\n",
              c->id,
              &msg->owner,
              ntohl (msg->tunnel_id));
  t = tunnel_get (&msg->owner, ntohl (msg->tunnel_id));
  if (NULL == t)
  {
    /* We don't know the tunnel FIXME */
    struct GNUNET_MESH_LocalMonitor warn;

    warn = *msg;
    GNUNET_SERVER_notification_context_unicast (nc, client,
                                                &warn.header,
                                                GNUNET_NO);
    GNUNET_SERVER_receive_done (client, GNUNET_OK);
    return;
  }

  /* Initialize context */
  resp = GNUNET_malloc (sizeof (struct GNUNET_MESH_LocalMonitor));
  *resp = *msg;
  GNUNET_PEER_resolve (t->dest, &resp->destination);
  resp->header.size = htons (sizeof (struct GNUNET_MESH_LocalMonitor));
  GNUNET_SERVER_notification_context_unicast (nc, c->handle,
                                              &resp->header, GNUNET_NO);
  GNUNET_free (resp);

  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Monitor tunnel request from client %u completed\n",
              c->id);
  GNUNET_SERVER_receive_done (client, GNUNET_OK);
}


/**
 * Functions to handle messages from clients
 */
static struct GNUNET_SERVER_MessageHandler client_handlers[] = {
  {&handle_local_new_client, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT, 0},
  {&handle_local_tunnel_create, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE,
   sizeof (struct GNUNET_MESH_TunnelMessage)},
  {&handle_local_tunnel_destroy, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY,
   sizeof (struct GNUNET_MESH_TunnelMessage)},
  {&handle_local_tunnel_buffer, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER,
   sizeof (struct GNUNET_MESH_TunnelMessage)},
  {&handle_local_tunnel_buffer, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER,
   sizeof (struct GNUNET_MESH_TunnelMessage)},
  {&handle_local_unicast, NULL,
   GNUNET_MESSAGE_TYPE_MESH_UNICAST, 0},
  {&handle_local_to_origin, NULL,
   GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN, 0},
  {&handle_local_ack, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK,
   sizeof (struct GNUNET_MESH_LocalAck)},
  {&handle_local_get_tunnels, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS,
   sizeof (struct GNUNET_MessageHeader)},
  {&handle_local_show_tunnel, NULL,
   GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL,
     sizeof (struct GNUNET_MESH_LocalMonitor)},
  {NULL, NULL, 0, 0}
};


/**
 * Method called whenever a given peer connects.
 *
 * @param cls closure
 * @param peer peer identity this notification is about
 */
static void
core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
{
  struct MeshPeerInfo *peer_info;
  struct MeshPeerPath *path;

  DEBUG_CONN ("Peer connected\n");
  DEBUG_CONN ("     %s\n", GNUNET_i2s (&my_full_id));
  peer_info = peer_get (peer);
  if (myid == peer_info->id)
  {
    DEBUG_CONN ("     (self)\n");
    return;
  }
  else
  {
    DEBUG_CONN ("     %s\n", GNUNET_i2s (peer));
  }
  path = path_new (2);
  path->peers[0] = myid;
  path->peers[1] = peer_info->id;
  GNUNET_PEER_change_rc (myid, 1);
  GNUNET_PEER_change_rc (peer_info->id, 1);
  peer_info_add_path (peer_info, path, GNUNET_YES);
  GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
  return;
}


/**
 * Method called whenever a peer disconnects.
 *
 * @param cls closure
 * @param peer peer identity this notification is about
 */
static void
core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
{
  struct MeshPeerInfo *pi;
  struct MeshPeerQueue *q;
  struct MeshPeerQueue *n;

  DEBUG_CONN ("Peer disconnected\n");
  pi = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
  if (NULL == pi)
  {
    GNUNET_break (0);
    return;
  }
  q = pi->queue_head;
  while (NULL != q)
  {
      n = q->next;
      /* TODO try to reroute this traffic instead */
      queue_destroy(q, GNUNET_YES);
      q = n;
  }
  if (NULL != pi->core_transmit)
  {
    GNUNET_CORE_notify_transmit_ready_cancel(pi->core_transmit);
    pi->core_transmit = NULL;
  }
    peer_remove_path (pi, pi->id, myid);
  if (myid == pi->id)
  {
    DEBUG_CONN ("     (self)\n");
  }
  GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
  return;
}


/**
 * Install server (service) handlers and start listening to clients.
 */
static void
server_init (void)
{
  GNUNET_SERVER_add_handlers (server_handle, client_handlers);
  GNUNET_SERVER_disconnect_notify (server_handle,
                                   &handle_local_client_disconnect, NULL);
  nc = GNUNET_SERVER_notification_context_create (server_handle, 1);

  clients_head = NULL;
  clients_tail = NULL;
  next_client_id = 0;
  GNUNET_SERVER_resume (server_handle);
}


/**
 * To be called on core init/fail.
 *
 * @param cls Closure (config)
 * @param server handle to the server for this service
 * @param identity the public identity of this peer
 */
static void
core_init (void *cls, struct GNUNET_CORE_Handle *server,
           const struct GNUNET_PeerIdentity *identity)
{
  const struct GNUNET_CONFIGURATION_Handle *c = cls;
  static int i = 0;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
  GNUNET_break (core_handle == server);
  if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)) ||
    NULL == server)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                " core id %s\n",
                GNUNET_i2s (identity));
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                " my id %s\n",
                GNUNET_i2s (&my_full_id));
    GNUNET_CORE_disconnect (core_handle);
    core_handle = GNUNET_CORE_connect (c, /* Main configuration */
                                       NULL,      /* Closure passed to MESH functions */
                                       &core_init,        /* Call core_init once connected */
                                       &core_connect,     /* Handle connects */
                                       &core_disconnect,  /* remove peers on disconnects */
                                       NULL,      /* Don't notify about all incoming messages */
                                       GNUNET_NO, /* For header only in notification */
                                       NULL,      /* Don't notify about all outbound messages */
                                       GNUNET_NO, /* For header-only out notification */
                                       core_handlers);    /* Register these handlers */
    if (10 < i++)
      GNUNET_abort();
  }
  server_init ();
  return;
}


/******************************************************************************/
/************************      MAIN FUNCTIONS      ****************************/
/******************************************************************************/

/**
 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
 *
 * @param cls closure
 * @param key current key code
 * @param value value in the hash map
 * @return GNUNET_YES if we should continue to iterate,
 *         GNUNET_NO if not.
 */
static int
shutdown_tunnel (void *cls, const struct GNUNET_HashCode * key, void *value)
{
  struct MeshTunnel *t = value;

  tunnel_destroy (t);
  return GNUNET_YES;
}

/**
 * Iterator over peer hash map entries to destroy the tunnel during shutdown.
 *
 * @param cls closure
 * @param key current key code
 * @param value value in the hash map
 * @return GNUNET_YES if we should continue to iterate,
 *         GNUNET_NO if not.
 */
static int
shutdown_peer (void *cls, const struct GNUNET_HashCode * key, void *value)
{
  struct MeshPeerInfo *p = value;
  struct MeshPeerQueue *q;
  struct MeshPeerQueue *n;

  q = p->queue_head;
  while (NULL != q)
  {
      n = q->next;
      if (q->peer == p)
      {
        queue_destroy(q, GNUNET_YES);
      }
      q = n;
  }
  peer_info_destroy (p);
  return GNUNET_YES;
}


/**
 * Task run during shutdown.
 *
 * @param cls unused
 * @param tc unused
 */
static void
shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shutting down\n");

  if (core_handle != NULL)
  {
    GNUNET_CORE_disconnect (core_handle);
    core_handle = NULL;
  }
  if (NULL != keygen)
  {
    GNUNET_CRYPTO_ecc_key_create_stop (keygen);
    keygen = NULL;
  }
  GNUNET_CONTAINER_multihashmap_iterate (tunnels, &shutdown_tunnel, NULL);
  GNUNET_CONTAINER_multihashmap_iterate (peers, &shutdown_peer, NULL);
  if (dht_handle != NULL)
  {
    GNUNET_DHT_disconnect (dht_handle);
    dht_handle = NULL;
  }
  if (nc != NULL)
  {
    GNUNET_SERVER_notification_context_destroy (nc);
    nc = NULL;
  }
  if (GNUNET_SCHEDULER_NO_TASK != announce_id_task)
  {
    GNUNET_SCHEDULER_cancel (announce_id_task);
    announce_id_task = GNUNET_SCHEDULER_NO_TASK;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shut down\n");
}


/**
 * Callback for hostkey read/generation.
 *
 * @param cls Closure (Configuration handle).
 * @param pk The ECC private key.
 * @param emsg Error message, if any.
 */
static void
key_generation_cb (void *cls,
                   struct GNUNET_CRYPTO_EccPrivateKey *pk,
                   const char *emsg)
{
  const struct GNUNET_CONFIGURATION_Handle *c = cls;
  struct MeshPeerInfo *peer;
  struct MeshPeerPath *p;

  keygen = NULL;
  if (NULL == pk)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                _("Could not access hostkey: %s. Exiting.\n"),
                emsg);
    GNUNET_SCHEDULER_shutdown ();
    return;
  }
  my_private_key = pk;
  GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
  GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
                      &my_full_id.hashPubKey);
  myid = GNUNET_PEER_intern (&my_full_id);
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Mesh for peer [%s] starting\n",
              GNUNET_i2s(&my_full_id));

  core_handle = GNUNET_CORE_connect (c, /* Main configuration */
                                     NULL,      /* Closure passed to MESH functions */
                                     &core_init,        /* Call core_init once connected */
                                     &core_connect,     /* Handle connects */
                                     &core_disconnect,  /* remove peers on disconnects */
                                     NULL,      /* Don't notify about all incoming messages */
                                     GNUNET_NO, /* For header only in notification */
                                     NULL,      /* Don't notify about all outbound messages */
                                     GNUNET_NO, /* For header-only out notification */
                                     core_handlers);    /* Register these handlers */
  if (core_handle == NULL)
  {
    GNUNET_break (0);
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  next_tid = 0;
  next_local_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;

  announce_id_task = GNUNET_SCHEDULER_add_now (&announce_id, cls);

  /* Create a peer_info for the local peer */
  peer = peer_get (&my_full_id);
  p = path_new (1);
  p->peers[0] = myid;
  GNUNET_PEER_change_rc (myid, 1);
  peer_info_add_path (peer, p, GNUNET_YES);

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Mesh service running\n");
}


/**
 * Process mesh requests.
 *
 * @param cls closure
 * @param server the initialized server
 * @param c configuration to use
 */
static void
run (void *cls, struct GNUNET_SERVER_Handle *server,
     const struct GNUNET_CONFIGURATION_Handle *c)
{
  char *keyfile;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "starting to run\n");
  server_handle = server;
  GNUNET_SERVER_suspend (server_handle);

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
                                               &keyfile))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "peer/privatekey");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_PATH_TIME",
                                           &refresh_path_time))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "refresh path time");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_time (c, "MESH", "ID_ANNOUNCE_TIME",
                                           &id_announce_time))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "id announce time");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_time (c, "MESH", "CONNECT_TIMEOUT",
                                           &connect_timeout))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "connect timeout");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
                                             &max_msgs_queue))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "max msgs queue");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_TUNNELS",
                                             &max_tunnels))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
                "mesh", "max tunnels");
    GNUNET_SCHEDULER_shutdown ();
    return;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DEFAULT_TTL",
                                             &default_ttl))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _
                ("%s service is lacking key configuration settings (%s). Using default (%u).\n"),
                "mesh", "default ttl", 64);
    default_ttl = 64;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
                                             &max_peers))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _("%s service is lacking key configuration settings (%s). Using default (%u).\n"),
                "mesh", "max peers", 1000);
    max_peers = 1000;
  }

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DHT_REPLICATION_LEVEL",
                                             &dht_replication_level))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _
                ("%s service is lacking key configuration settings (%s). Using default (%u).\n"),
                "mesh", "dht replication level", 3);
    dht_replication_level = 3;
  }

  tunnels = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);
  incoming_tunnels = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);
  peers = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);
  ports = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_NO);

  dht_handle = GNUNET_DHT_connect (c, 64);
  if (NULL == dht_handle)
  {
    GNUNET_break (0);
  }
  stats = GNUNET_STATISTICS_create ("mesh", c);

  /* Scheduled the task to clean up when shutdown is called */
  GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
                                NULL);
  keygen = GNUNET_CRYPTO_ecc_key_create_start (keyfile,
                                               &key_generation_cb,
                                               (void *) c);
  GNUNET_free (keyfile);
}


/**
 * The main function for the mesh service.
 *
 * @param argc number of arguments from the command line
 * @param argv command line arguments
 * @return 0 ok, 1 on error
 */
int
main (int argc, char *const *argv)
{
  int ret;
  int r;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "main()\n");
  r = GNUNET_SERVICE_run (argc, argv, "mesh", GNUNET_SERVICE_OPTION_NONE, &run,
                          NULL);
  ret = (GNUNET_OK == r) ? 0 : 1;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "main() END\n");

  INTERVAL_SHOW;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Mesh for peer [%s] FWD ACKs %u, BCK ACKs %u\n",
              GNUNET_i2s(&my_full_id), debug_fwd_ack, debug_bck_ack);

  return ret;
}