src/fs/gnunet-service-fs.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 fs/gnunet-service-fs.c
  23  * @brief gnunet anonymity protocol implementation
  24  * @author Christian Grothoff
  25  *
  26  * To use:
  27  * - consider re-issue GSF_dht_lookup_ after non-DHT reply received
  28  * - implement 'SUPPORT_DELAYS'
  29  *
  30  */
  31 #include "platform.h"
  32 #include <float.h>
  33 #include "gnunet_constants.h"
  34 #include "gnunet_core_service.h"
  35 #include "gnunet_dht_service.h"
  36 #include "gnunet_datastore_service.h"
  37 #include "gnunet_load_lib.h"
  38 #include "gnunet_peer_lib.h"
  39 #include "gnunet_protocols.h"
  40 #include "gnunet_signatures.h"
  41 #include "gnunet_statistics_service.h"
  42 #include "gnunet_transport_service.h"
  43 #include "gnunet_util_lib.h"
  44 #include "gnunet-service-fs_cp.h"
  45 #include "gnunet-service-fs_indexing.h"
  46 #include "gnunet-service-fs_lc.h"
  47 #include "gnunet-service-fs_pe.h"
  48 #include "gnunet-service-fs_pr.h"
  49 #include "gnunet-service-fs_push.h"
  50 #include "gnunet-service-fs_put.h"
  51 #include "fs.h"
  52
  53 /**
  54  * Size for the hash map for DHT requests from the FS
  55  * service.  Should be about the number of concurrent
  56  * DHT requests we plan to make.
  57  */
  58 #define FS_DHT_HT_SIZE 1024
  59
  60
  61 /**
  62  * How quickly do we age cover traffic?  At the given
  63  * time interval, remaining cover traffic counters are
  64  * decremented by 1/16th.
  65  */
  66 #define COVER_AGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  67
  68
  69 /* ****************************** globals ****************************** */
  70
  71 /**
  72  * Our connection to the datastore.
  73  */
  74 struct GNUNET_DATASTORE_Handle *GSF_dsh;
  75
  76 /**
  77  * Our configuration.
  78  */
  79 const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
  80
  81 /**
  82  * Handle for reporting statistics.
  83  */
  84 struct GNUNET_STATISTICS_Handle *GSF_stats;
  85
  86 /**
  87  * Handle for DHT operations.
  88  */
  89 struct GNUNET_DHT_Handle *GSF_dht;
  90
  91 /**
  92  * How long do requests typically stay in the routing table?
  93  */
  94 struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
  95
  96 /**
  97  * Typical priorities we're seeing from other peers right now.  Since
  98  * most priorities will be zero, this value is the weighted average of
  99  * non-zero priorities seen "recently".  In order to ensure that new
 100  * values do not dramatically change the ratio, values are first
 101  * "capped" to a reasonable range (+N of the current value) and then
 102  * averaged into the existing value by a ratio of 1:N.  Hence
 103  * receiving the largest possible priority can still only raise our
 104  * "current_priorities" by at most 1.
 105  */
 106 double GSF_current_priorities;
 107
 108 /**
 109  * How many query messages have we received 'recently' that
 110  * have not yet been claimed as cover traffic?
 111  */
 112 unsigned int GSF_cover_query_count;
 113
 114 /**
 115  * How many content messages have we received 'recently' that
 116  * have not yet been claimed as cover traffic?
 117  */
 118 unsigned int GSF_cover_content_count;
 119
 120 /**
 121  * Our block context.
 122  */
 123 struct GNUNET_BLOCK_Context *GSF_block_ctx;
 124
 125 /**
 126  * Pointer to handle to the core service (points to NULL until we've
 127  * connected to it).
 128  */
 129 struct GNUNET_CORE_Handle *GSF_core;
 130
 131 /**
 132  * Are we introducing randomized delays for better anonymity?
 133  */
 134 int GSF_enable_randomized_delays;
 135
 136 /* ***************************** locals ******************************* */
 137
 138 /**
 139  * Configuration for block library.
 140  */
 141 static struct GNUNET_CONFIGURATION_Handle *block_cfg;
 142
 143 /**
 144  * ID of our task that we use to age the cover counters.
 145  */
 146 static GNUNET_SCHEDULER_TaskIdentifier cover_age_task;
 147
 148 /**
 149  * Datastore 'GET' load tracking.
 150  */
 151 static struct GNUNET_LOAD_Value *datastore_get_load;
 152
 153 /**
 154  * Identity of this peer.
 155  */
 156 static struct GNUNET_PeerIdentity my_id;
 157
 158 /**
 159  * Task that periodically ages our cover traffic statistics.
 160  *
 161  * @param cls unused closure
 162  * @param tc task context
 163  */
 164 static void
 165 age_cover_counters (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 166 {
 167   GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
 168   GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
 169   cover_age_task =
 170       GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
 171                                     NULL);
 172 }
 173
 174
 175
 176 /**
 177  * We've just now completed a datastore request.  Update our
 178  * datastore load calculations.
 179  *
 180  * @param start time when the datastore request was issued
 181  */
 182 void
 183 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
 184 {
 185   struct GNUNET_TIME_Relative delay;
 186
 187   delay = GNUNET_TIME_absolute_get_duration (start);
 188   GNUNET_LOAD_update (datastore_get_load, delay.rel_value);
 189 }
 190
 191
 192 /**
 193  * Test if the DATABASE (GET) load on this peer is too high
 194  * to even consider processing the query at
 195  * all.
 196  *
 197  * @return GNUNET_YES if the load is too high to do anything (load high)
 198  *         GNUNET_NO to process normally (load normal)
 199  *         GNUNET_SYSERR to process for free (load low)
 200  */
 201 int
 202 GSF_test_get_load_too_high_ (uint32_t priority)
 203 {
 204   double ld;
 205
 206   ld = GNUNET_LOAD_get_load (datastore_get_load);
 207   if (ld < 1)
 208     return GNUNET_SYSERR;
 209   if (ld <= priority)
 210     return GNUNET_NO;
 211   return GNUNET_YES;
 212 }
 213
 214
 215 /**
 216  * Handle P2P "PUT" message.
 217  *
 218  * @param cls closure, always NULL
 219  * @param other the other peer involved (sender or receiver, NULL
 220  *        for loopback messages where we are both sender and receiver)
 221  * @param message the actual message
 222  * @param atsi performance information
 223  * @param atsi_count number of records in 'atsi'
 224  * @return GNUNET_OK to keep the connection open,
 225  *         GNUNET_SYSERR to close it (signal serious error)
 226  */
 227 static int
 228 handle_p2p_put (void *cls, const struct GNUNET_PeerIdentity *other,
 229                 const struct GNUNET_MessageHeader *message,
 230                 const struct GNUNET_ATS_Information *atsi,
 231                 unsigned int atsi_count)
 232 {
 233   struct GSF_ConnectedPeer *cp;
 234
 235   cp = GSF_peer_get_ (other);
 236   if (NULL == cp)
 237   {
 238     GNUNET_break (0);
 239     return GNUNET_OK;
 240   }
 241   GSF_cover_content_count++;
 242   return GSF_handle_p2p_content_ (cp, message);
 243 }
 244
 245
 246 /**
 247  * We have a new request, consider forwarding it to the given
 248  * peer.
 249  *
 250  * @param cls the 'struct GSF_PendingRequest'
 251  * @param peer identity of the peer
 252  * @param cp handle to the connected peer record
 253  * @param ppd peer performance data
 254  */
 255 static void
 256 consider_request_for_forwarding (void *cls,
 257                                  const struct GNUNET_PeerIdentity *peer,
 258                                  struct GSF_ConnectedPeer *cp,
 259                                  const struct GSF_PeerPerformanceData *ppd)
 260 {
 261   struct GSF_PendingRequest *pr = cls;
 262
 263   if (GNUNET_YES !=
 264       GSF_pending_request_test_target_ (pr,
 265                                         peer))
 266   {
 267     GNUNET_STATISTICS_update (GSF_stats,
 268                               gettext_noop ("# Loopback routes suppressed"), 1,
 269                               GNUNET_NO);
 270     return;
 271   }
 272   GSF_plan_add_ (cp, pr);
 273 }
 274
 275
 276 /**
 277  * Function to be called after we're done processing
 278  * replies from the local lookup.  If the result status
 279  * code indicates that there may be more replies, plan
 280  * forwarding the request.
 281  *
 282  * @param cls closure (NULL)
 283  * @param pr the pending request we were processing
 284  * @param result final datastore lookup result
 285  */
 286 static void
 287 consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
 288                      enum GNUNET_BLOCK_EvaluationResult result)
 289 {
 290   if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
 291     return;                     /* we're done... */
 292   GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
 293 }
 294
 295
 296 /**
 297  * Handle P2P "GET" request.
 298  *
 299  * @param cls closure, always NULL
 300  * @param other the other peer involved (sender or receiver, NULL
 301  *        for loopback messages where we are both sender and receiver)
 302  * @param message the actual message
 303  * @param atsi performance information
 304  * @param atsi_count number of records in 'atsi'
 305  * @return GNUNET_OK to keep the connection open,
 306  *         GNUNET_SYSERR to close it (signal serious error)
 307  */
 308 static int
 309 handle_p2p_get (void *cls, const struct GNUNET_PeerIdentity *other,
 310                 const struct GNUNET_MessageHeader *message,
 311                 const struct GNUNET_ATS_Information *atsi,
 312                 unsigned int atsi_count)
 313 {
 314   struct GSF_PendingRequest *pr;
 315
 316   pr = GSF_handle_p2p_query_ (other, message);
 317   if (NULL == pr)
 318     return GNUNET_SYSERR;
 319   GSF_local_lookup_ (pr, &consider_forwarding, NULL);
 320   return GNUNET_OK;
 321 }
 322
 323
 324 /**
 325  * We're done with the local lookup, now consider
 326  * P2P processing (depending on request options and
 327  * result status).  Also signal that we can now
 328  * receive more request information from the client.
 329  *
 330  * @param cls the client doing the request ('struct GNUNET_SERVER_Client')
 331  * @param pr the pending request we were processing
 332  * @param result final datastore lookup result
 333  */
 334 static void
 335 start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
 336                       enum GNUNET_BLOCK_EvaluationResult result)
 337 {
 338   struct GNUNET_SERVER_Client *client = cls;
 339   struct GSF_PendingRequestData *prd;
 340
 341   prd = GSF_pending_request_get_data_ (pr);
 342 #if DEBUG_FS_CLIENT
 343   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 344               "Finished database lookup for local request `%s' with result %d\n",
 345               GNUNET_h2s (&prd->query), result);
 346 #endif
 347   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 348   if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
 349     return;                     /* we're done, 'pr' was already destroyed... */
 350   if (0 != (GSF_PRO_LOCAL_ONLY & prd->options))
 351   {
 352     GSF_pending_request_cancel_ (pr, GNUNET_YES);
 353     return;
 354   }
 355   GSF_dht_lookup_ (pr);
 356   consider_forwarding (NULL, pr, result);
 357 }
 358
 359
 360 /**
 361  * Handle START_SEARCH-message (search request from client).
 362  *
 363  * @param cls closure
 364  * @param client identification of the client
 365  * @param message the actual message
 366  */
 367 static void
 368 handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
 369                      const struct GNUNET_MessageHeader *message)
 370 {
 371   struct GSF_PendingRequest *pr;
 372
 373   pr = GSF_local_client_start_search_handler_ (client, message);
 374   if (NULL == pr)
 375   {
 376     /* GNUNET_SERVER_receive_done was already called! */
 377     return;
 378   }
 379   GSF_local_lookup_ (pr, &start_p2p_processing, client);
 380 }
 381
 382
 383 /**
 384  * Task run during shutdown.
 385  *
 386  * @param cls unused
 387  * @param tc unused
 388  */
 389 static void
 390 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 391 {
 392   if (NULL != GSF_core)
 393   {
 394     GNUNET_CORE_disconnect (GSF_core);
 395     GSF_core = NULL;
 396   }
 397   GSF_put_done_ ();
 398   GSF_push_done_ ();
 399   GSF_pending_request_done_ ();
 400   GSF_plan_done ();
 401   GSF_connected_peer_done_ ();
 402   GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
 403   GSF_dsh = NULL;
 404   GNUNET_DHT_disconnect (GSF_dht);
 405   GSF_dht = NULL;
 406   GNUNET_BLOCK_context_destroy (GSF_block_ctx);
 407   GSF_block_ctx = NULL;
 408   GNUNET_CONFIGURATION_destroy (block_cfg);
 409   block_cfg = NULL;
 410   GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
 411   GSF_stats = NULL;
 412   if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
 413   {
 414     GNUNET_SCHEDULER_cancel (cover_age_task);
 415     cover_age_task = GNUNET_SCHEDULER_NO_TASK;
 416   }
 417   GNUNET_FS_indexing_done ();
 418   GNUNET_LOAD_value_free (datastore_get_load);
 419   datastore_get_load = NULL;
 420   GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
 421   GSF_rt_entry_lifetime = NULL;
 422 }
 423
 424
 425 /**
 426  * Function called for each pending request whenever a new
 427  * peer connects, giving us a chance to decide about submitting
 428  * the existing request to the new peer.
 429  *
 430  * @param cls the 'struct GSF_ConnectedPeer' of the new peer
 431  * @param key query for the request
 432  * @param pr handle to the pending request
 433  * @return GNUNET_YES to continue to iterate
 434  */
 435 static int
 436 consider_peer_for_forwarding (void *cls, const GNUNET_HashCode * key,
 437                               struct GSF_PendingRequest *pr)
 438 {
 439   struct GSF_ConnectedPeer *cp = cls;
 440   struct GNUNET_PeerIdentity pid;
 441
 442   GSF_connected_peer_get_identity_ (cp, &pid);
 443   if (GNUNET_YES !=
 444       GSF_pending_request_test_target_ (pr,
 445                                         &pid))
 446   {
 447     GNUNET_STATISTICS_update (GSF_stats,
 448                               gettext_noop ("# Loopback routes suppressed"), 1,
 449                               GNUNET_NO);
 450     return GNUNET_YES;
 451   }
 452   GSF_plan_add_ (cp, pr);
 453   return GNUNET_YES;
 454 }
 455
 456
 457 /**
 458  * Method called whenever a given peer connects.
 459  *
 460  * @param cls closure, not used
 461  * @param peer peer identity this notification is about
 462  * @param atsi performance information
 463  * @param atsi_count number of records in 'atsi'
 464  */
 465 static void
 466 peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
 467                       const struct GNUNET_ATS_Information *atsi,
 468                       unsigned int atsi_count)
 469 {
 470   struct GSF_ConnectedPeer *cp;
 471
 472   if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
 473     return;
 474   cp = GSF_peer_connect_handler_ (peer, atsi, atsi_count);
 475   if (NULL == cp)
 476     return;
 477   GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
 478 }
 479
 480
 481 /**
 482  * Function called after GNUNET_CORE_connect has succeeded
 483  * (or failed for good).  Note that the private key of the
 484  * peer is intentionally not exposed here; if you need it,
 485  * your process should try to read the private key file
 486  * directly (which should work if you are authorized...).
 487  *
 488  * @param cls closure
 489  * @param server handle to the server, NULL if we failed
 490  * @param my_identity ID of this peer, NULL if we failed
 491  */
 492 static void
 493 peer_init_handler (void *cls, struct GNUNET_CORE_Handle *server,
 494                    const struct GNUNET_PeerIdentity *my_identity)
 495 {
 496   my_id = *my_identity;
 497 }
 498
 499
 500 /**
 501  * Process fs requests.
 502  *
 503  * @param server the initialized server
 504  * @param c configuration to use
 505  */
 506 static int
 507 main_init (struct GNUNET_SERVER_Handle *server,
 508            const struct GNUNET_CONFIGURATION_Handle *c)
 509 {
 510   static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
 511     {&handle_p2p_get,
 512      GNUNET_MESSAGE_TYPE_FS_GET, 0},
 513     {&handle_p2p_put,
 514      GNUNET_MESSAGE_TYPE_FS_PUT, 0},
 515     {&GSF_handle_p2p_migration_stop_,
 516      GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
 517      sizeof (struct MigrationStopMessage)},
 518     {NULL, 0, 0}
 519   };
 520   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 521     {&GNUNET_FS_handle_index_start, NULL,
 522      GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
 523     {&GNUNET_FS_handle_index_list_get, NULL,
 524      GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
 525      sizeof (struct GNUNET_MessageHeader)},
 526     {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
 527      sizeof (struct UnindexMessage)},
 528     {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
 529      0},
 530     {NULL, NULL, 0, 0}
 531   };
 532
 533   GSF_core = GNUNET_CORE_connect (GSF_cfg, 2,   /* larger? */
 534                                   NULL, &peer_init_handler,
 535                                   &peer_connect_handler,
 536                                   &GSF_peer_disconnect_handler_,
 537                                   NULL, GNUNET_NO,
 538                                   NULL, GNUNET_NO, p2p_handlers);
 539   if (NULL == GSF_core)
 540   {
 541     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 542                 _("Failed to connect to `%s' service.\n"), "core");
 543     return GNUNET_SYSERR;
 544   }
 545   GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
 546                                    NULL);
 547   GNUNET_SERVER_add_handlers (server, handlers);
 548   cover_age_task =
 549       GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
 550                                     NULL);
 551   datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
 552   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
 553                                 NULL);
 554   return GNUNET_OK;
 555 }
 556
 557
 558 /**
 559  * Process fs requests.
 560  *
 561  * @param cls closure
 562  * @param server the initialized server
 563  * @param cfg configuration to use
 564  */
 565 static void
 566 run (void *cls, struct GNUNET_SERVER_Handle *server,
 567      const struct GNUNET_CONFIGURATION_Handle *cfg)
 568 {
 569   GSF_cfg = cfg;
 570   GSF_enable_randomized_delays =
 571       GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
 572   GSF_dsh = GNUNET_DATASTORE_connect (cfg);
 573   if (NULL == GSF_dsh)
 574   {
 575     GNUNET_SCHEDULER_shutdown ();
 576     return;
 577   }
 578   GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
 579   GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
 580   block_cfg = GNUNET_CONFIGURATION_create ();
 581   GNUNET_CONFIGURATION_set_value_string (block_cfg, "block", "PLUGINS", "fs");
 582   GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
 583   GNUNET_assert (NULL != GSF_block_ctx);
 584   GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
 585   GSF_plan_init ();
 586   GSF_pending_request_init_ ();
 587   GSF_connected_peer_init_ ();
 588   GSF_push_init_ ();
 589   GSF_put_init_ ();
 590   if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
 591       (GNUNET_OK != main_init (server, cfg)))
 592   {
 593     GNUNET_SCHEDULER_shutdown ();
 594     shutdown_task (NULL, NULL);
 595     return;
 596   }
 597 }
 598
 599
 600 /**
 601  * The main function for the fs service.
 602  *
 603  * @param argc number of arguments from the command line
 604  * @param argv command line arguments
 605  * @return 0 ok, 1 on error
 606  */
 607 int
 608 main (int argc, char *const *argv)
 609 {
 610   return (GNUNET_OK ==
 611           GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
 612                               &run, NULL)) ? 0 : 1;
 613 }
 614
 615 /* end of gnunet-service-fs.c */