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