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