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    * #GNUNET_YES if this peer currently has excess bandwidth.
 110    */
 111   int has_excess_bandwidth;
 112
 113 };
 114
 115
 116 /**
 117  * Map of peer identities to 'struct Neighbour'.
 118  */
 119 static struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
 120
 121 /**
 122  * Transport service.
 123  */
 124 static struct GNUNET_TRANSPORT_Handle *transport;
 125
 126
 127 /**
 128  * Find the entry for the given neighbour.
 129  *
 130  * @param peer identity of the neighbour
 131  * @return NULL if we are not connected, otherwise the
 132  *         neighbour's entry.
 133  */
 134 static struct Neighbour *
 135 find_neighbour (const struct GNUNET_PeerIdentity *peer)
 136 {
 137   if (NULL == neighbours)
 138     return NULL;
 139   return GNUNET_CONTAINER_multipeermap_get (neighbours, peer);
 140 }
 141
 142
 143 /**
 144  * Free the given entry for the neighbour.
 145  *
 146  * @param n neighbour to free
 147  */
 148 static void
 149 free_neighbour (struct Neighbour *n)
 150 {
 151   struct NeighbourMessageEntry *m;
 152
 153   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 154               "Destroying neighbour entry for peer `%4s'\n",
 155               GNUNET_i2s (&n->peer));
 156   while (NULL != (m = n->message_head))
 157   {
 158     GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 159     GNUNET_free (m);
 160   }
 161   if (NULL != n->th)
 162   {
 163     GNUNET_TRANSPORT_notify_transmit_ready_cancel (n->th);
 164     n->th = NULL;
 165   }
 166   GNUNET_STATISTICS_update (GSC_stats,
 167                             gettext_noop
 168                             ("# sessions terminated by transport disconnect"),
 169                             1, GNUNET_NO);
 170   if (NULL != n->kxinfo)
 171   {
 172     GSC_KX_stop (n->kxinfo);
 173     n->kxinfo = NULL;
 174   }
 175   if (n->retry_plaintext_task != GNUNET_SCHEDULER_NO_TASK)
 176   {
 177     GNUNET_SCHEDULER_cancel (n->retry_plaintext_task);
 178     n->retry_plaintext_task = GNUNET_SCHEDULER_NO_TASK;
 179   }
 180   GNUNET_assert (GNUNET_OK ==
 181                  GNUNET_CONTAINER_multipeermap_remove (neighbours,
 182                                                        &n->peer, n));
 183   GNUNET_STATISTICS_set (GSC_stats,
 184                          gettext_noop ("# neighbour entries allocated"),
 185                          GNUNET_CONTAINER_multipeermap_size (neighbours),
 186                          GNUNET_NO);
 187   GNUNET_free (n);
 188 }
 189
 190
 191 /**
 192  * Check if we have encrypted messages for the specified neighbour
 193  * pending, and if so, check with the transport about sending them
 194  * out.
 195  *
 196  * @param n neighbour to check.
 197  */
 198 static void
 199 process_queue (struct Neighbour *n);
 200
 201
 202 /**
 203  * Function called when the transport service is ready to receive a
 204  * message for the respective peer
 205  *
 206  * @param cls neighbour to use message from
 207  * @param size number of bytes we can transmit
 208  * @param buf where to copy the message
 209  * @return number of bytes transmitted
 210  */
 211 static size_t
 212 transmit_ready (void *cls, size_t size, void *buf)
 213 {
 214   struct Neighbour *n = cls;
 215   struct NeighbourMessageEntry *m;
 216   size_t ret;
 217   char *cbuf;
 218
 219   n->th = NULL;
 220   m = n->message_head;
 221   if (NULL == m)
 222   {
 223     GNUNET_break (0);
 224     return 0;
 225   }
 226   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 227   if (NULL == buf)
 228   {
 229     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 230                 "Transmission of message of type %u and size %u failed\n",
 231                 (unsigned int)
 232                 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 233                 (unsigned int) m->size);
 234     GNUNET_free (m);
 235     process_queue (n);
 236     return 0;
 237   }
 238   cbuf = buf;
 239   GNUNET_assert (size >= m->size);
 240   memcpy (cbuf, &m[1], m->size);
 241   ret = m->size;
 242   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 243               "Copied message of type %u and size %u into transport buffer for `%4s'\n",
 244               (unsigned int)
 245               ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 246               (unsigned int) ret, GNUNET_i2s (&n->peer));
 247   GNUNET_free (m);
 248   n->has_excess_bandwidth = GNUNET_NO;
 249   process_queue (n);
 250   GNUNET_STATISTICS_update (GSC_stats,
 251                             gettext_noop
 252                             ("# encrypted bytes given to transport"), ret,
 253                             GNUNET_NO);
 254   return ret;
 255 }
 256
 257
 258 /**
 259  * Check if we have messages for the specified neighbour pending, and
 260  * if so, check with the transport about sending them out.
 261  *
 262  * @param n neighbour to check.
 263  */
 264 static void
 265 process_queue (struct Neighbour *n)
 266 {
 267   struct NeighbourMessageEntry *m;
 268
 269   if (n->th != NULL)
 270     return;                     /* request already pending */
 271   m = n->message_head;
 272   if (m == NULL)
 273   {
 274     /* notify sessions that the queue is empty and more messages
 275      * could thus be queued now */
 276     GSC_SESSIONS_solicit (&n->peer);
 277     return;
 278   }
 279   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 280               "Asking transport for transmission of %u bytes to `%4s' in next %s\n",
 281               (unsigned int) m->size, GNUNET_i2s (&n->peer),
 282               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (m->deadline), GNUNET_NO));
 283   n->th =
 284       GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer, m->size,
 285                                               GNUNET_TIME_absolute_get_remaining
 286                                               (m->deadline), &transmit_ready,
 287                                               n);
 288   if (n->th != NULL)
 289     return;
 290   /* message request too large or duplicate request */
 291   GNUNET_break (0);
 292   /* discard encrypted message */
 293   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 294   GNUNET_free (m);
 295   process_queue (n);
 296 }
 297
 298
 299
 300 /**
 301  * Function called by transport to notify us that
 302  * a peer connected to us (on the network level).
 303  *
 304  * @param cls closure
 305  * @param peer the peer that connected
 306  */
 307 static void
 308 handle_transport_notify_connect (void *cls,
 309                                  const struct GNUNET_PeerIdentity *peer)
 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,
 326               "Received connection from `%4s'.\n",
 327               GNUNET_i2s (peer));
 328   n = GNUNET_new (struct Neighbour);
 329   n->peer = *peer;
 330   GNUNET_assert (GNUNET_OK ==
 331                  GNUNET_CONTAINER_multipeermap_put (neighbours,
 332                                                     &n->peer, n,
 333                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 334   GNUNET_STATISTICS_set (GSC_stats,
 335                          gettext_noop ("# neighbour entries allocated"),
 336                          GNUNET_CONTAINER_multipeermap_size (neighbours),
 337                          GNUNET_NO);
 338   n->kxinfo = GSC_KX_start (peer);
 339 }
 340
 341
 342 /**
 343  * Function called by transport telling us that a peer
 344  * disconnected.
 345  *
 346  * @param cls closure
 347  * @param peer the peer that disconnected
 348  */
 349 static void
 350 handle_transport_notify_disconnect (void *cls,
 351                                     const struct GNUNET_PeerIdentity *peer)
 352 {
 353   struct Neighbour *n;
 354
 355   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 356               "Peer `%4s' disconnected from us; received notification from transport.\n",
 357               GNUNET_i2s (peer));
 358   n = find_neighbour (peer);
 359   if (n == NULL)
 360   {
 361     GNUNET_break (0);
 362     return;
 363   }
 364   free_neighbour (n);
 365 }
 366
 367
 368 /**
 369  * Function called by the transport for each received message.
 370  *
 371  * @param cls closure
 372  * @param peer (claimed) identity of the other peer
 373  * @param message the message
 374  */
 375 static void
 376 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 377                           const struct GNUNET_MessageHeader *message)
 378 {
 379   struct Neighbour *n;
 380   uint16_t type;
 381
 382   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 383               "Received message of type %u from `%4s', demultiplexing.\n",
 384               (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
 385   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 386   {
 387     GNUNET_break (0);
 388     return;
 389   }
 390   n = find_neighbour (peer);
 391   if (n == NULL)
 392   {
 393     /* received message from peer that is not connected!? */
 394     GNUNET_break (0);
 395     return;
 396   }
 397   type = ntohs (message->type);
 398   switch (type)
 399   {
 400   case GNUNET_MESSAGE_TYPE_CORE_EPHEMERAL_KEY:
 401     GSC_KX_handle_ephemeral_key (n->kxinfo, message);
 402     break;
 403   case GNUNET_MESSAGE_TYPE_CORE_PING:
 404     GSC_KX_handle_ping (n->kxinfo, message);
 405     break;
 406   case GNUNET_MESSAGE_TYPE_CORE_PONG:
 407     GSC_KX_handle_pong (n->kxinfo, message);
 408     break;
 409   case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
 410     GSC_KX_handle_encrypted_message (n->kxinfo, message);
 411     break;
 412   case GNUNET_MESSAGE_TYPE_DUMMY:
 413     /*  Dummy messages for testing / benchmarking, just discard */
 414     break;
 415   default:
 416     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 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  * One of our neighbours has excess bandwidth,
 460  * remember this.
 461  *
 462  * @param cls NULL
 463  * @param pid identity of the peer with excess bandwidth
 464  */
 465 static void
 466 handle_transport_notify_excess_bw (void *cls,
 467                                    const struct GNUNET_PeerIdentity *pid)
 468 {
 469   struct Neighbour *n;
 470
 471   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 472               "Peer %s has excess bandwidth available\n",
 473               GNUNET_i2s (pid));
 474   n = find_neighbour (pid);
 475   if (NULL == n)
 476   {
 477     GNUNET_break (0);
 478     return;
 479   }
 480   n->has_excess_bandwidth = GNUNET_YES;
 481   GSC_SESSIONS_solicit (pid);
 482 }
 483
 484
 485 /**
 486  * Check if the given neighbour has excess bandwidth available.
 487  *
 488  * @param target neighbour to check
 489  * @return #GNUNET_YES if excess bandwidth is available, #GNUNET_NO if not
 490  */
 491 int
 492 GSC_NEIGHBOURS_check_excess_bandwidth (const struct GNUNET_PeerIdentity *target)
 493 {
 494   struct Neighbour *n;
 495
 496   n = find_neighbour (target);
 497   if (NULL == n)
 498   {
 499     GNUNET_break (0);
 500     return GNUNET_SYSERR;
 501   }
 502   return n->has_excess_bandwidth;
 503 }
 504
 505
 506 /**
 507  * Initialize neighbours subsystem.
 508  */
 509 int
 510 GSC_NEIGHBOURS_init ()
 511 {
 512   neighbours = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
 513   transport =
 514       GNUNET_TRANSPORT_connect2 (GSC_cfg, &GSC_my_identity, NULL,
 515                                  &handle_transport_receive,
 516                                  &handle_transport_notify_connect,
 517                                  &handle_transport_notify_disconnect,
 518                                  &handle_transport_notify_excess_bw);
 519   if (NULL == transport)
 520   {
 521     GNUNET_CONTAINER_multipeermap_destroy (neighbours);
 522     neighbours = NULL;
 523     return GNUNET_SYSERR;
 524   }
 525   return GNUNET_OK;
 526 }
 527
 528
 529 /**
 530  * Wrapper around 'free_neighbour'.
 531  *
 532  * @param cls unused
 533  * @param key peer identity
 534  * @param value the `struct Neighbour` to free
 535  * @return #GNUNET_OK (continue to iterate)
 536  */
 537 static int
 538 free_neighbour_helper (void *cls,
 539                        const struct GNUNET_PeerIdentity * key,
 540                        void *value)
 541 {
 542   struct Neighbour *n = value;
 543
 544   /* transport should have 'disconnected' all neighbours... */
 545   GNUNET_break (0);
 546   free_neighbour (n);
 547   return GNUNET_OK;
 548 }
 549
 550
 551 /**
 552  * Shutdown neighbours subsystem.
 553  */
 554 void
 555 GSC_NEIGHBOURS_done ()
 556 {
 557   if (NULL != transport)
 558   {
 559     GNUNET_TRANSPORT_disconnect (transport);
 560     transport = NULL;
 561   }
 562   if (NULL != neighbours)
 563   {
 564     GNUNET_CONTAINER_multipeermap_iterate (neighbours, &free_neighbour_helper,
 565                                            NULL);
 566     GNUNET_CONTAINER_multipeermap_destroy (neighbours);
 567     neighbours = NULL;
 568   }
 569 }
 570
 571 /* end of gnunet-service-core_neighbours.c */