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
 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 #if DEBUG_CORE
 226     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 227                 "Transmission of message of type %u and size %u failed\n",
 228                 (unsigned int)
 229                 ntohs (((struct GNUNET_MessageHeader *) &m[1])->type),
 230                 (unsigned int) m->size);
 231 #endif
 232     GNUNET_free (m);
 233     process_queue (n);
 234     return 0;
 235   }
 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, 0,
 287                                               GNUNET_TIME_absolute_get_remaining
 288                                               (m->deadline), &transmit_ready,
 289                                               n);
 290   if (n->th != NULL)
 291     return;
 292   /* message request too large or duplicate request */
 293   GNUNET_break (0);
 294   /* discard encrypted message */
 295   GNUNET_CONTAINER_DLL_remove (n->message_head, n->message_tail, m);
 296   GNUNET_free (m);
 297   process_queue (n);
 298 }
 299
 300
 301
 302 /**
 303  * Function called by transport to notify us that
 304  * a peer connected to us (on the network level).
 305  *
 306  * @param cls closure
 307  * @param peer the peer that connected
 308  * @param atsi performance data
 309  * @param atsi_count number of entries in ats (excluding 0-termination)
 310  */
 311 static void
 312 handle_transport_notify_connect (void *cls,
 313                                  const struct GNUNET_PeerIdentity *peer,
 314                                  const struct GNUNET_ATS_Information *atsi,
 315                                  uint32_t atsi_count)
 316 {
 317   struct Neighbour *n;
 318
 319   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 320   {
 321     GNUNET_break (0);
 322     return;
 323   }
 324   n = find_neighbour (peer);
 325   if (n != NULL)
 326   {
 327     /* duplicate connect notification!? */
 328     GNUNET_break (0);
 329     return;
 330   }
 331 #if DEBUG_CORE
 332   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received connection from `%4s'.\n",
 333               GNUNET_i2s (peer));
 334 #endif
 335   n = GNUNET_malloc (sizeof (struct Neighbour));
 336   n->peer = *peer;
 337   GNUNET_assert (GNUNET_OK ==
 338                  GNUNET_CONTAINER_multihashmap_put (neighbours,
 339                                                     &n->peer.hashPubKey, n,
 340                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 341   GNUNET_STATISTICS_set (GSC_stats,
 342                          gettext_noop ("# neighbour entries allocated"),
 343                          GNUNET_CONTAINER_multihashmap_size (neighbours),
 344                          GNUNET_NO);
 345   n->kxinfo = GSC_KX_start (peer);
 346 }
 347
 348
 349 /**
 350  * Function called by transport telling us that a peer
 351  * disconnected.
 352  *
 353  * @param cls closure
 354  * @param peer the peer that disconnected
 355  */
 356 static void
 357 handle_transport_notify_disconnect (void *cls,
 358                                     const struct GNUNET_PeerIdentity *peer)
 359 {
 360   struct Neighbour *n;
 361
 362 #if DEBUG_CORE
 363   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 364               "Peer `%4s' disconnected from us; received notification from transport.\n",
 365               GNUNET_i2s (peer));
 366 #endif
 367   n = find_neighbour (peer);
 368   if (n == NULL)
 369   {
 370     GNUNET_break (0);
 371     return;
 372   }
 373   free_neighbour (n);
 374 }
 375
 376
 377 /**
 378  * Function called by the transport for each received message.
 379  *
 380  * @param cls closure
 381  * @param peer (claimed) identity of the other peer
 382  * @param message the message
 383  * @param atsi performance data
 384  * @param atsi_count number of entries in ats (excluding 0-termination)
 385  */
 386 static void
 387 handle_transport_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 388                           const struct GNUNET_MessageHeader *message,
 389                           const struct GNUNET_ATS_Information *atsi,
 390                           uint32_t atsi_count)
 391 {
 392   struct Neighbour *n;
 393   uint16_t type;
 394
 395 #if DEBUG_CORE > 1
 396   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 397               "Received message of type %u from `%4s', demultiplexing.\n",
 398               (unsigned int) ntohs (message->type), GNUNET_i2s (peer));
 399 #endif
 400   if (0 == memcmp (peer, &GSC_my_identity, sizeof (struct GNUNET_PeerIdentity)))
 401   {
 402     GNUNET_break (0);
 403     return;
 404   }
 405   n = find_neighbour (peer);
 406   if (n == NULL)
 407   {
 408     /* received message from peer that is not connected!? */
 409     GNUNET_break (0);
 410     return;
 411   }
 412   type = ntohs (message->type);
 413   switch (type)
 414   {
 415   case GNUNET_MESSAGE_TYPE_CORE_SET_KEY:
 416     GSC_KX_handle_set_key (n->kxinfo, message);
 417     break;
 418   case GNUNET_MESSAGE_TYPE_CORE_PING:
 419     GSC_KX_handle_ping (n->kxinfo, message);
 420     break;
 421   case GNUNET_MESSAGE_TYPE_CORE_PONG:
 422     GSC_KX_handle_pong (n->kxinfo, message);
 423     break;
 424   case GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE:
 425     GSC_KX_handle_encrypted_message (n->kxinfo, message, atsi, atsi_count);
 426     break;
 427   default:
 428     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 429                 _
 430                 ("Unsupported message of type %u (%u bytes) received from peer `%s'\n"),
 431                 (unsigned int) type, (unsigned int) ntohs (message->size),
 432                 GNUNET_i2s (peer));
 433     return;
 434   }
 435 }
 436
 437
 438 /**
 439  * Transmit the given message to the given target.
 440  *
 441  * @param target peer that should receive the message (must be connected)
 442  * @param msg message to transmit
 443  * @param timeout by when should the transmission be done?
 444  */
 445 void
 446 GSC_NEIGHBOURS_transmit (const struct GNUNET_PeerIdentity *target,
 447                          const struct GNUNET_MessageHeader *msg,
 448                          struct GNUNET_TIME_Relative timeout)
 449 {
 450   struct NeighbourMessageEntry *me;
 451   struct Neighbour *n;
 452   size_t msize;
 453
 454   n = find_neighbour (target);
 455   if (NULL == n)
 456   {
 457     GNUNET_break (0);
 458     return;
 459   }
 460   msize = ntohs (msg->size);
 461   me = GNUNET_malloc (sizeof (struct NeighbourMessageEntry) + msize);
 462   me->deadline = GNUNET_TIME_relative_to_absolute (timeout);
 463   me->size = msize;
 464   memcpy (&me[1], msg, msize);
 465   GNUNET_CONTAINER_DLL_insert_tail (n->message_head, n->message_tail, me);
 466   process_queue (n);
 467 }
 468
 469
 470 /**
 471  * Initialize neighbours subsystem.
 472  */
 473 int
 474 GSC_NEIGHBOURS_init ()
 475 {
 476   neighbours = GNUNET_CONTAINER_multihashmap_create (128);
 477   transport =
 478       GNUNET_TRANSPORT_connect (GSC_cfg, &GSC_my_identity, NULL,
 479                                 &handle_transport_receive,
 480                                 &handle_transport_notify_connect,
 481                                 &handle_transport_notify_disconnect);
 482   if (NULL == transport)
 483   {
 484     GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 485     neighbours = NULL;
 486     return GNUNET_SYSERR;
 487   }
 488   return GNUNET_OK;
 489 }
 490
 491
 492 /**
 493  * Wrapper around 'free_neighbour'.
 494  *
 495  * @param cls unused
 496  * @param key peer identity
 497  * @param value the 'struct Neighbour' to free
 498  * @return GNUNET_OK (continue to iterate)
 499  */
 500 static int
 501 free_neighbour_helper (void *cls, const GNUNET_HashCode * key, void *value)
 502 {
 503   struct Neighbour *n = value;
 504
 505   /* transport should have 'disconnected' all neighbours... */
 506   GNUNET_break (0);
 507   free_neighbour (n);
 508   return GNUNET_OK;
 509 }
 510
 511
 512 /**
 513  * Shutdown neighbours subsystem.
 514  */
 515 void
 516 GSC_NEIGHBOURS_done ()
 517 {
 518   if (NULL == transport)
 519     return;
 520   GNUNET_TRANSPORT_disconnect (transport);
 521   transport = NULL;
 522   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &free_neighbour_helper,
 523                                          NULL);
 524   GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 525   neighbours = NULL;
 526 }
 527
 528 /* end of gnunet-service-core_neighbours.c */