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   GSC_SESSIONS_end (&n->peer);
 166   if (NULL != n->kxinfo)
 167   {
 168     GSC_KX_stop (n->kxinfo);
 169     n->kxinfo = NULL;
 170   }
 171   if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
 172   {
 173     GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
 174     n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
 175   }
 176   GNUNET_assert (GNUNET_OK ==
 177                  GNUNET_CONTAINER_multihashmap_remove (neighbours,
 178                                                        &n->peer.hashPubKey, n));
 179   GNUNET_STATISTICS_set (GSC_stats,
 180                          gettext_noop ("# neighbour entries allocated"),
 181                          GNUNET_CONTAINER_multihashmap_size (neighbours),
 182                          GNUNET_NO);
 183   GNUNET_free (n);
 184 }
 185
 186
 187 /**
 188  * Check if we have encrypted messages for the specified neighbour
 189  * pending, and if so, check with the transport about sending them
 190  * out.
 191  *
 192  * @param n neighbour to check.
 193  */
 194 static void
 195 process_queue (struct Neighbour *n);
 196
 197
 198 /**
 199  * Function called when the transport service is ready to receive a
 200  * message for the respective peer
 201  *
 202  * @param cls neighbour to use message from
 203  * @param size number of bytes we can transmit
 204  * @param buf where to copy the message
 205  * @return number of bytes transmitted
 206  */
 207 static size_t
 208 transmit_ready (void *cls, size_t size, void *buf)
 209 {
 210   struct Neighbour *n = cls;
 211   struct NeighbourMessageEntry *m;
 212   size_t ret;
 213   char *cbuf;
 214
 215   n->th = NULL;
 216   m = n->message_head;
 217   if (m == NULL)
 218   {
 219     GNUNET_break (0);
 220     return 0;
 221   }
 222   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 223   if (buf == NULL)
 224   {
 225     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 226                 "Transmission of message of type %u and size %u failed\n",
 227                 (unsigned int)
 228                 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 229                 (unsigned int) m->size);
 230     GNUNET_free (m);
 231     process_queue (n);
 232     return 0;
 233   }
 234   cbuf = buf;
 235   GNUNET_assert (size >= m->size);
 236   memcpy (cbuf, &m[1], m->size);
 237   ret = m->size;
 238   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 239               "Copied message of type %u and size %u into transport buffer for `%4s'\n",
 240               (unsigned int)
 241               ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 242               (unsigned int) ret, GNUNET_i2s (&n->peer));
 243   GNUNET_free (m);
 244   process_queue (n);
 245   GNUNET_STATISTICS_update (GSC_stats,
 246                             gettext_noop
 247                             ("# encrypted bytes given to transport"), ret,
 248                             GNUNET_NO);
 249   return ret;
 250 }
 251
 252
 253 /**
 254  * Check if we have messages for the specified neighbour pending, and
 255  * if so, check with the transport about sending them out.
 256  *
 257  * @param n neighbour to check.
 258  */
 259 static void
 260 process_queue (struct Neighbour *n)
 261 {
 262   struct NeighbourMessageEntry *m;
 263
 264   if (n->th != NULL)
 265     return;                     /* request already pending */
 266   m = n->message_head;
 267   if (m == NULL)
 268   {
 269     /* notify sessions that the queue is empty and more messages
 270      * could thus be queued now */
 271     GSC_SESSIONS_solicit (&n->peer);
 272     return;
 273   }
 274   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 275               "Asking transport for transmission of %u bytes to `%4s' in next %llu ms\n",
 276               (unsigned int) m->size, GNUNET_i2s (&n->peer),
 277               (unsigned long long)
 278               GNUNET_TIME_absolute_get_remaining (m->deadline).rel_value);
 279   n->th =
 280       GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size, 0,
 281                                               GNUNET_TIME_absolute_get_remaining
 282                                               (m->deadline), &transmit_ready,
 283                                               n);
 284   if (n->th != NULL)
 285     return;
 286   /* message request too large or duplicate request */
 287   GNUNET_break (0);
 288   /* discard encrypted message */
 289   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 290   GNUNET_free (m);
 291   process_queue (n);
 292 }
 293
 294
 295
 296 /**
 297  * Function called by transport to notify us that
 298  * a peer connected to us (on the network level).
 299  *
 300  * @param cls closure
 301  * @param peer the peer that connected
 302  * @param atsi performance data
 303  * @param atsi_count number of entries in ats (excluding 0-termination)
 304  */
 305 static void
 306 handle_transport_notify_connect (void *cls,
 307                                  const struct GNUNET_PeerIdentity *peer,
 308                                  const struct GNUNET_ATS_Information *atsi,
 309                                  uint32_t atsi_count)
 310 {
 311   struct Neighbour *n;
 312
 313   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 314   {
 315     GNUNET_break (0);
 316     return;
 317   }
 318   n = find_neighbour (peer);
 319   if (n != NULL)
 320   {
 321     /* duplicate connect notification!? */
 322     GNUNET_break (0);
 323     return;
 324   }
 325   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
 326               GNUNET_i2s (peer));
 327   n = GNUNET_malloc (sizeof (struct Neighbour));
 328   n->peer = *peer;
 329   GNUNET_assert (GNUNET_OK ==
 330                  GNUNET_CONTAINER_multihashmap_put (neighbours,
 331                                                     &n->peer.hashPubKey, n,
 332                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 333   GNUNET_STATISTICS_set (GSC_stats,
 334                          gettext_noop ("# neighbour entries allocated"),
 335                          GNUNET_CONTAINER_multihashmap_size (neighbours),
 336                          GNUNET_NO);
 337   n->kxinfo = GSC_KX_start (peer);
 338 }
 339
 340
 341 /**
 342  * Function called by transport telling us that a peer
 343  * disconnected.
 344  *
 345  * @param cls closure
 346  * @param peer the peer that disconnected
 347  */
 348 static void
 349 handle_transport_notify_disconnect (void *cls,
 350                                     const struct GNUNET_PeerIdentity *peer)
 351 {
 352   struct Neighbour *n;
 353
 354   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 355               "Peer `%4s' disconnected from us; received notification from transport.\n",
 356               GNUNET_i2s (peer));
 357   n = find_neighbour (peer);
 358   if (n == NULL)
 359   {
 360     GNUNET_break (0);
 361     return;
 362   }
 363   free_neighbour (n);
 364 }
 365
 366
 367 /**
 368  * Function called by the transport for each received message.
 369  *
 370  * @param cls closure
 371  * @param peer (claimed) identity of the other peer
 372  * @param message the message
 373  * @param atsi performance data
 374  * @param atsi_count number of entries in ats (excluding 0-termination)
 375  */
 376 static void
 377 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 378                           const struct GNUNET_MessageHeader *message,
 379                           const struct GNUNET_ATS_Information *atsi,
 380                           uint32_t atsi_count)
 381 {
 382   struct Neighbour *n;
 383   uint16_t type;
 384
 385   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 386               "Received message of type %u from `%4s', demultiplexing.\n",
 387               (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
 388   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 389   {
 390     GNUNET_break (0);
 391     return;
 392   }
 393   n = find_neighbour (peer);
 394   if (n == NULL)
 395   {
 396     /* received message from peer that is not connected!? */
 397     GNUNET_break (0);
 398     return;
 399   }
 400   type = ntohs (message->type);
 401   switch (type)
 402   {
 403   case GNUNET_MESSAGE_TYPE_CORE_SET_KEY:
 404     GSC_KX_handle_set_key (n->kxinfo, message);
 405     break;
 406   case GNUNET_MESSAGE_TYPE_CORE_PING:
 407     GSC_KX_handle_ping (n->kxinfo, message);
 408     break;
 409   case GNUNET_MESSAGE_TYPE_CORE_PONG:
 410     GSC_KX_handle_pong (n->kxinfo, message);
 411     break;
 412   case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
 413     GSC_KX_handle_encrypted_message (n->kxinfo, message, atsi, atsi_count);
 414     break;
 415   default:
 416     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 417                 _
 418                 ("Unsupported message of type %u (%u bytes) received from peer `%s'\n"),
 419                 (unsigned int) type, (unsigned int) ntohs (message->size),
 420                 GNUNET_i2s (peer));
 421     return;
 422   }
 423 }
 424
 425
 426 /**
 427  * Transmit the given message to the given target.
 428  *
 429  * @param target peer that should receive the message (must be connected)
 430  * @param msg message to transmit
 431  * @param timeout by when should the transmission be done?
 432  */
 433 void
 434 GSC_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
 435                          const struct GNUNET_MessageHeader *msg,
 436                          struct GNUNET_TIME_Relative timeout)
 437 {
 438   struct NeighbourMessageEntry *me;
 439   struct Neighbour *n;
 440   size_t msize;
 441
 442   n = find_neighbour (target);
 443   if (NULL == n)
 444   {
 445     GNUNET_break (0);
 446     return;
 447   }
 448   msize = ntohs (msg->size);
 449   me = GNUNET_malloc (sizeof (struct NeighbourMessageEntry) + msize);
 450   me->deadline = GNUNET_TIME_relative_to_absolute (timeout);
 451   me->size = msize;
 452   memcpy (&me[1], msg, msize);
 453   GNUNET_CONTAINER_DLL_insert_tail (n->message_head, n->message_tail, me);
 454   process_queue (n);
 455 }
 456
 457
 458 /**
 459  * Initialize neighbours subsystem.
 460  */
 461 int
 462 GSC_NEIGHBOURS_init ()
 463 {
 464   neighbours = GNUNET_CONTAINER_multihashmap_create (128);
 465   transport =
 466       GNUNET_TRANSPORT_connect (GSC_cfg, &GSC_my_identity, NULL,
 467                                 &handle_transport_receive,
 468                                 &handle_transport_notify_connect,
 469                                 &handle_transport_notify_disconnect);
 470   if (NULL == transport)
 471   {
 472     GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 473     neighbours = NULL;
 474     return GNUNET_SYSERR;
 475   }
 476   return GNUNET_OK;
 477 }
 478
 479
 480 /**
 481  * Wrapper around 'free_neighbour'.
 482  *
 483  * @param cls unused
 484  * @param key peer identity
 485  * @param value the 'struct Neighbour' to free
 486  * @return GNUNET_OK (continue to iterate)
 487  */
 488 static int
 489 free_neighbour_helper (void *cls, const GNUNET_HashCode * key, void *value)
 490 {
 491   struct Neighbour *n = value;
 492
 493   /* transport should have 'disconnected' all neighbours... */
 494   GNUNET_break (0);
 495   free_neighbour (n);
 496   return GNUNET_OK;
 497 }
 498
 499
 500 /**
 501  * Shutdown neighbours subsystem.
 502  */
 503 void
 504 GSC_NEIGHBOURS_done ()
 505 {
 506   if (NULL == transport)
 507     return;
 508   GNUNET_TRANSPORT_disconnect (transport);
 509   transport = NULL;
 510   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &free_neighbour_helper,
 511                                          NULL);
 512   GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 513   neighbours = NULL;
 514 }
 515
 516 /* end of gnunet-service-core_neighbours.c */