src/core/gnunet-service-core_neighbours.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file core/gnunet-service-core_neighbours.c
  23  * @brief code for managing low-level 'plaintext' connections with transport (key exchange may or may not be done yet)
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet-service-core.h"
  31 #include "gnunet-service-core_neighbours.h"
  32 #include "gnunet-service-core_kx.h"
  33 #include "gnunet-service-core_sessions.h"
  34 #include "gnunet_constants.h"
  35
  36
  37 /**
  38  * Message ready for transmission via transport service.  This struct
  39  * is followed by the actual content of the message.
  40  */
  41 struct NeighbourMessageEntry
  42 {
  43
  44   /**
  45    * We keep messages in a doubly linked list.
  46    */
  47   struct NeighbourMessageEntry *next;
  48
  49   /**
  50    * We keep messages in a doubly linked list.
  51    */
  52   struct NeighbourMessageEntry *prev;
  53
  54   /**
  55    * By when are we supposed to transmit this message?
  56    */
  57   struct GNUNET_TIME_Absolute deadline;
  58
  59   /**
  60    * How long is the message? (number of bytes following the "struct
  61    * MessageEntry", but not including the size of "struct
  62    * MessageEntry" itself!)
  63    */
  64   size_t size;
  65
  66 };
  67
  68
  69 /**
  70  * Data kept per transport-connected peer.
  71  */
  72 struct Neighbour
  73 {
  74
  75   /**
  76    * Head of the batched message queue (already ordered, transmit
  77    * starting with the head).
  78    */
  79   struct NeighbourMessageEntry *message_head;
  80
  81   /**
  82    * Tail of the batched message queue (already ordered, append new
  83    * messages to tail).
  84    */
  85   struct NeighbourMessageEntry *message_tail;
  86
  87   /**
  88    * Handle for pending requests for transmission to this peer
  89    * with the transport service.  NULL if no request is pending.
  90    */
  91   struct GNUNET_TRANSPORT_TransmitHandle *th;
  92
  93   /**
  94    * Information about the key exchange with the other peer.
  95    */
  96   struct GSC_KeyExchangeInfo *kxinfo;
  97
  98   /**
  99    * Identity of the other peer.
 100    */
 101   struct GNUNET_PeerIdentity peer;
 102
 103   /**
 104    * ID of task used for re-trying plaintext scheduling.
 105    */
 106   GNUNET_SCHEDULER_TaskIdentifier retry_plaintext_task;
 107
 108 };
 109
 110
 111 /**
 112  * Map of peer identities to 'struct Neighbour'.
 113  */
 114 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
 115
 116 /**
 117  * Transport service.
 118  */
 119 static struct GNUNET_TRANSPORT_Handle *transport;
 120
 121
 122 /**
 123  * Find the entry for the given neighbour.
 124  *
 125  * @param peer identity of the neighbour
 126  * @return NULL if we are not connected, otherwise the
 127  *         neighbour's entry.
 128  */
 129 static struct Neighbour *
 130 find_neighbour (const struct GNUNET_PeerIdentity *peer)
 131 {
 132   if (NULL == neighbours)
 133     return NULL;
 134   return GNUNET_CONTAINER_multihashmap_get (neighbours, &peer->hashPubKey);
 135 }
 136
 137
 138 /**
 139  * Free the given entry for the neighbour.
 140  *
 141  * @param n neighbour to free
 142  */
 143 static void
 144 free_neighbour (struct Neighbour *n)
 145 {
 146   struct NeighbourMessageEntry *m;
 147
 148   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 149               "Destroying neighbour entry for peer `%4s'\n",
 150               GNUNET_i2s (&n->peer));
 151   while (NULL != (m = n->message_head))
 152   {
 153     GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 154     GNUNET_free (m);
 155   }
 156   if (NULL != n->th)
 157   {
 158     GNUNET_TRANSPORT_notify_transmit_ready_cancel (n->th);
 159     n->th = NULL;
 160   }
 161   GNUNET_STATISTICS_update (GSC_stats,
 162                             gettext_noop
 163                             ("# sessions terminated by transport disconnect"),
 164                             1, GNUNET_NO);
 165   if (NULL != n->kxinfo)
 166   {
 167     GSC_KX_stop (n->kxinfo);
 168     n->kxinfo = NULL;
 169   }
 170   if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
 171   {
 172     GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
 173     n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
 174   }
 175   GNUNET_assert (GNUNET_OK ==
 176                  GNUNET_CONTAINER_multihashmap_remove (neighbours,
 177                                                        &n->peer.hashPubKey, n));
 178   GNUNET_STATISTICS_set (GSC_stats,
 179                          gettext_noop ("# neighbour entries allocated"),
 180                          GNUNET_CONTAINER_multihashmap_size (neighbours),
 181                          GNUNET_NO);
 182   GNUNET_free (n);
 183 }
 184
 185
 186 /**
 187  * Check if we have encrypted messages for the specified neighbour
 188  * pending, and if so, check with the transport about sending them
 189  * out.
 190  *
 191  * @param n neighbour to check.
 192  */
 193 static void
 194 process_queue (struct Neighbour *n);
 195
 196
 197 /**
 198  * Function called when the transport service is ready to receive a
 199  * message for the respective peer
 200  *
 201  * @param cls neighbour to use message from
 202  * @param size number of bytes we can transmit
 203  * @param buf where to copy the message
 204  * @return number of bytes transmitted
 205  */
 206 static size_t
 207 transmit_ready (void *cls, size_t size, void *buf)
 208 {
 209   struct Neighbour *n = cls;
 210   struct NeighbourMessageEntry *m;
 211   size_t ret;
 212   char *cbuf;
 213
 214   n->th = NULL;
 215   m = n->message_head;
 216   if (m == NULL)
 217   {
 218     GNUNET_break (0);
 219     return 0;
 220   }
 221   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 222   if (buf == NULL)
 223   {
 224     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 225                 "Transmission of message of type %u and size %u failed\n",
 226                 (unsigned int)
 227                 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 228                 (unsigned int) m->size);
 229     GNUNET_free (m);
 230     process_queue (n);
 231     return 0;
 232   }
 233   cbuf = buf;
 234   GNUNET_assert (size >= m->size);
 235   memcpy (cbuf, &m[1], m->size);
 236   ret = m->size;
 237   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 238               "Copied message of type %u and size %u into transport buffer for `%4s'\n",
 239               (unsigned int)
 240               ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 241               (unsigned int) ret, GNUNET_i2s (&n->peer));
 242   GNUNET_free (m);
 243   process_queue (n);
 244   GNUNET_STATISTICS_update (GSC_stats,
 245                             gettext_noop
 246                             ("# encrypted bytes given to transport"), ret,
 247                             GNUNET_NO);
 248   return ret;
 249 }
 250
 251
 252 /**
 253  * Check if we have messages for the specified neighbour pending, and
 254  * if so, check with the transport about sending them out.
 255  *
 256  * @param n neighbour to check.
 257  */
 258 static void
 259 process_queue (struct Neighbour *n)
 260 {
 261   struct NeighbourMessageEntry *m;
 262
 263   if (n->th != NULL)
 264     return;                     /* request already pending */
 265   m = n->message_head;
 266   if (m == NULL)
 267   {
 268     /* notify sessions that the queue is empty and more messages
 269      * could thus be queued now */
 270     GSC_SESSIONS_solicit (&n->peer);
 271     return;
 272   }
 273   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 274               "Asking transport for transmission of %u bytes to `%4s' in next %s\n",
 275               (unsigned int) m->size, GNUNET_i2s (&n->peer),
 276               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (m->deadline), GNUNET_NO));
 277   n->th =
 278       GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size, 0,
 279                                               GNUNET_TIME_absolute_get_remaining
 280                                               (m->deadline), &transmit_ready,
 281                                               n);
 282   if (n->th != NULL)
 283     return;
 284   /* message request too large or duplicate request */
 285   GNUNET_break (0);
 286   /* discard encrypted message */
 287   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 288   GNUNET_free (m);
 289   process_queue (n);
 290 }
 291
 292
 293
 294 /**
 295  * Function called by transport to notify us that
 296  * a peer connected to us (on the network level).
 297  *
 298  * @param cls closure
 299  * @param peer the peer that connected
 300  */
 301 static void
 302 handle_transport_notify_connect (void *cls,
 303                                  const struct GNUNET_PeerIdentity *peer)
 304 {
 305   struct Neighbour *n;
 306
 307   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 308   {
 309     GNUNET_break (0);
 310     return;
 311   }
 312   n = find_neighbour (peer);
 313   if (n != NULL)
 314   {
 315     /* duplicate connect notification!? */
 316     GNUNET_break (0);
 317     return;
 318   }
 319   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
 320               GNUNET_i2s (peer));
 321   n = GNUNET_malloc (sizeof (struct Neighbour));
 322   n->peer = *peer;
 323   GNUNET_assert (GNUNET_OK ==
 324                  GNUNET_CONTAINER_multihashmap_put (neighbours,
 325                                                     &n->peer.hashPubKey, n,
 326                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 327   GNUNET_STATISTICS_set (GSC_stats,
 328                          gettext_noop ("# neighbour entries allocated"),
 329                          GNUNET_CONTAINER_multihashmap_size (neighbours),
 330                          GNUNET_NO);
 331   n->kxinfo = GSC_KX_start (peer);
 332 }
 333
 334
 335 /**
 336  * Function called by transport telling us that a peer
 337  * disconnected.
 338  *
 339  * @param cls closure
 340  * @param peer the peer that disconnected
 341  */
 342 static void
 343 handle_transport_notify_disconnect (void *cls,
 344                                     const struct GNUNET_PeerIdentity *peer)
 345 {
 346   struct Neighbour *n;
 347
 348   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 349               "Peer `%4s' disconnected from us; received notification from transport.\n",
 350               GNUNET_i2s (peer));
 351   n = find_neighbour (peer);
 352   if (n == NULL)
 353   {
 354     GNUNET_break (0);
 355     return;
 356   }
 357   free_neighbour (n);
 358 }
 359
 360
 361 /**
 362  * Function called by the transport for each received message.
 363  *
 364  * @param cls closure
 365  * @param peer (claimed) identity of the other peer
 366  * @param message the message
 367  */
 368 static void
 369 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 370                           const struct GNUNET_MessageHeader *message)
 371 {
 372   struct Neighbour *n;
 373   uint16_t type;
 374
 375   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 376               "Received message of type %u from `%4s', demultiplexing.\n",
 377               (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
 378   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 379   {
 380     GNUNET_break (0);
 381     return;
 382   }
 383   n = find_neighbour (peer);
 384   if (n == NULL)
 385   {
 386     /* received message from peer that is not connected!? */
 387     GNUNET_break (0);
 388     return;
 389   }
 390   type = ntohs (message->type);
 391   switch (type)
 392   {
 393   case GNUNET_MESSAGE_TYPE_CORE_EPHEMERAL_KEY:
 394     GSC_KX_handle_ephemeral_key (n->kxinfo, message);
 395     break;
 396   case GNUNET_MESSAGE_TYPE_CORE_PING:
 397     GSC_KX_handle_ping (n->kxinfo, message);
 398     break;
 399   case GNUNET_MESSAGE_TYPE_CORE_PONG:
 400     GSC_KX_handle_pong (n->kxinfo, message);
 401     break;
 402   case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
 403     GSC_KX_handle_encrypted_message (n->kxinfo, message);
 404     break;
 405   case GNUNET_MESSAGE_TYPE_DUMMY:
 406     /*  Dummy messages for testing / benchmarking, just discard */
 407     break;
 408   default:
 409     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 410                 _
 411                 ("Unsupported message of type %u (%u bytes) received from peer `%s'\n"),
 412                 (unsigned int) type, (unsigned int) ntohs (message->size),
 413                 GNUNET_i2s (peer));
 414     return;
 415   }
 416 }
 417
 418
 419 /**
 420  * Transmit the given message to the given target.
 421  *
 422  * @param target peer that should receive the message (must be connected)
 423  * @param msg message to transmit
 424  * @param timeout by when should the transmission be done?
 425  */
 426 void
 427 GSC_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
 428                          const struct GNUNET_MessageHeader *msg,
 429                          struct GNUNET_TIME_Relative timeout)
 430 {
 431   struct NeighbourMessageEntry *me;
 432   struct Neighbour *n;
 433   size_t msize;
 434
 435   n = find_neighbour (target);
 436   if (NULL == n)
 437   {
 438     GNUNET_break (0);
 439     return;
 440   }
 441   msize = ntohs (msg->size);
 442   me = GNUNET_malloc (sizeof (struct NeighbourMessageEntry) + msize);
 443   me->deadline = GNUNET_TIME_relative_to_absolute (timeout);
 444   me->size = msize;
 445   memcpy (&me[1], msg, msize);
 446   GNUNET_CONTAINER_DLL_insert_tail (n->message_head, n->message_tail, me);
 447   process_queue (n);
 448 }
 449
 450
 451 /**
 452  * Initialize neighbours subsystem.
 453  */
 454 int
 455 GSC_NEIGHBOURS_init ()
 456 {
 457   neighbours = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
 458   transport =
 459       GNUNET_TRANSPORT_connect (GSC_cfg, &GSC_my_identity, NULL,
 460                                 &handle_transport_receive,
 461                                 &handle_transport_notify_connect,
 462                                 &handle_transport_notify_disconnect);
 463   if (NULL == transport)
 464   {
 465     GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 466     neighbours = NULL;
 467     return GNUNET_SYSERR;
 468   }
 469   return GNUNET_OK;
 470 }
 471
 472
 473 /**
 474  * Wrapper around 'free_neighbour'.
 475  *
 476  * @param cls unused
 477  * @param key peer identity
 478  * @param value the 'struct Neighbour' to free
 479  * @return GNUNET_OK (continue to iterate)
 480  */
 481 static int
 482 free_neighbour_helper (void *cls, const struct GNUNET_HashCode * key, void *value)
 483 {
 484   struct Neighbour *n = value;
 485
 486   /* transport should have 'disconnected' all neighbours... */
 487   GNUNET_break (0);
 488   free_neighbour (n);
 489   return GNUNET_OK;
 490 }
 491
 492
 493 /**
 494  * Shutdown neighbours subsystem.
 495  */
 496 void
 497 GSC_NEIGHBOURS_done ()
 498 {
 499   if (NULL != transport)
 500   {
 501     GNUNET_TRANSPORT_disconnect (transport);
 502     transport = NULL;
 503   }
 504   if (NULL != neighbours)
 505   {
 506     GNUNET_CONTAINER_multihashmap_iterate (neighbours, &free_neighbour_helper,
 507                                            NULL);
 508     GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 509     neighbours = NULL;
 510   }
 511 }
 512
 513 /* end of gnunet-service-core_neighbours.c */