2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file fs/gnunet-service-fs.c
23 * @brief gnunet anonymity protocol implementation
24 * @author Christian Grothoff
28 #include "gnunet_constants.h"
29 #include "gnunet_core_service.h"
30 #include "gnunet_dht_service.h"
31 #include "gnunet_datastore_service.h"
32 #include "gnunet_load_lib.h"
33 #include "gnunet_peer_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_signatures.h"
36 #include "gnunet_statistics_service.h"
37 #include "gnunet_transport_service.h"
38 #include "gnunet_util_lib.h"
39 #include "gnunet-service-fs_cp.h"
40 #include "gnunet-service-fs_indexing.h"
41 #include "gnunet-service-fs_lc.h"
42 #include "gnunet-service-fs_pe.h"
43 #include "gnunet-service-fs_pr.h"
44 #include "gnunet-service-fs_push.h"
45 #include "gnunet-service-fs_put.h"
46 #include "gnunet-service-fs_cadet.h"
50 * Size for the hash map for DHT requests from the FS
51 * service. Should be about the number of concurrent
52 * DHT requests we plan to make.
54 #define FS_DHT_HT_SIZE 1024
58 * How quickly do we age cover traffic? At the given
59 * time interval, remaining cover traffic counters are
60 * decremented by 1/16th.
62 #define COVER_AGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
65 * Collect an instane number of statistics? May cause excessive IPC.
67 #define INSANE_STATISTICS GNUNET_NO
70 /* ****************************** globals ****************************** */
73 * Our connection to the datastore.
75 struct GNUNET_DATASTORE_Handle *GSF_dsh;
80 const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
83 * Handle for reporting statistics.
85 struct GNUNET_STATISTICS_Handle *GSF_stats;
88 * Handle for DHT operations.
90 struct GNUNET_DHT_Handle *GSF_dht;
93 * How long do requests typically stay in the routing table?
95 struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
98 * Running average of the observed latency to other peers (round trip).
99 * Initialized to 5s as the initial default.
101 struct GNUNET_TIME_Relative GSF_avg_latency = { 500 };
104 * Handle to ATS service.
106 struct GNUNET_ATS_PerformanceHandle *GSF_ats;
110 * Typical priorities we're seeing from other peers right now. Since
111 * most priorities will be zero, this value is the weighted average of
112 * non-zero priorities seen "recently". In order to ensure that new
113 * values do not dramatically change the ratio, values are first
114 * "capped" to a reasonable range (+N of the current value) and then
115 * averaged into the existing value by a ratio of 1:N. Hence
116 * receiving the largest possible priority can still only raise our
117 * "current_priorities" by at most 1.
119 double GSF_current_priorities;
122 * Size of the datastore queue we assume for common requests.
124 unsigned int GSF_datastore_queue_size;
127 * How many query messages have we received 'recently' that
128 * have not yet been claimed as cover traffic?
130 unsigned int GSF_cover_query_count;
133 * How many content messages have we received 'recently' that
134 * have not yet been claimed as cover traffic?
136 unsigned int GSF_cover_content_count;
141 struct GNUNET_BLOCK_Context *GSF_block_ctx;
144 * Pointer to handle to the core service (points to NULL until we've
147 struct GNUNET_CORE_Handle *GSF_core;
150 * Are we introducing randomized delays for better anonymity?
152 int GSF_enable_randomized_delays;
154 /* ***************************** locals ******************************* */
157 * Configuration for block library.
159 static struct GNUNET_CONFIGURATION_Handle *block_cfg;
162 * ID of our task that we use to age the cover counters.
164 static GNUNET_SCHEDULER_TaskIdentifier cover_age_task;
167 * Datastore 'GET' load tracking.
169 static struct GNUNET_LOAD_Value *datastore_get_load;
172 * Identity of this peer.
174 static struct GNUNET_PeerIdentity my_id;
177 * Task that periodically ages our cover traffic statistics.
179 * @param cls unused closure
180 * @param tc task context
183 age_cover_counters (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
185 GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
186 GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
188 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
194 * We've just now completed a datastore request. Update our
195 * datastore load calculations.
197 * @param start time when the datastore request was issued
200 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
202 struct GNUNET_TIME_Relative delay;
204 delay = GNUNET_TIME_absolute_get_duration (start);
205 GNUNET_LOAD_update (datastore_get_load, delay.rel_value_us);
210 * Test if the DATABASE (GET) load on this peer is too high
211 * to even consider processing the query at
214 * @param priority priority of the request (used as a reference point to compare with the load)
215 * @return GNUNET_YES if the load is too high to do anything (load high)
216 * GNUNET_NO to process normally (load normal)
217 * GNUNET_SYSERR to process for free (load low)
220 GSF_test_get_load_too_high_ (uint32_t priority)
224 ld = GNUNET_LOAD_get_load (datastore_get_load);
226 return GNUNET_SYSERR;
234 * We've received peer performance information. Update
235 * our running average for the P2P latency.
238 * @param address the address
239 * @param active is this address in active use
240 * @param bandwidth_out assigned outbound bandwidth for the connection
241 * @param bandwidth_in assigned inbound bandwidth for the connection
242 * @param ats performance data for the address (as far as known)
243 * @param ats_count number of performance records in 'ats'
246 update_latencies (void *cls,
247 const struct GNUNET_HELLO_Address *address,
249 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
250 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
251 const struct GNUNET_ATS_Information *ats,
255 struct GNUNET_TIME_Relative latency;
259 /* ATS service temporarily disconnected */
263 if (GNUNET_YES != active)
265 for (i = 0; i < ats_count; i++)
267 if (GNUNET_ATS_QUALITY_NET_DELAY != ntohl (ats[i].type))
269 latency.rel_value_us = ntohl (ats[i].value);
270 GSF_update_peer_latency_ (&address->peer,
272 GSF_avg_latency.rel_value_us =
273 (GSF_avg_latency.rel_value_us * 31 +
274 GNUNET_MIN (5000, ntohl (ats[i].value))) / 32;
275 GNUNET_STATISTICS_set (GSF_stats,
277 ("# running average P2P latency (ms)"),
278 GSF_avg_latency.rel_value_us / 1000LL, GNUNET_NO);
285 * Handle P2P "PUT" message.
287 * @param cls closure, always NULL
288 * @param other the other peer involved (sender or receiver, NULL
289 * for loopback messages where we are both sender and receiver)
290 * @param message the actual message
291 * @return GNUNET_OK to keep the connection open,
292 * GNUNET_SYSERR to close it (signal serious error)
295 handle_p2p_put (void *cls, const struct GNUNET_PeerIdentity *other,
296 const struct GNUNET_MessageHeader *message)
298 struct GSF_ConnectedPeer *cp;
300 cp = GSF_peer_get_ (other);
306 GSF_cover_content_count++;
307 return GSF_handle_p2p_content_ (cp, message);
312 * We have a new request, consider forwarding it to the given
315 * @param cls the 'struct GSF_PendingRequest'
316 * @param peer identity of the peer
317 * @param cp handle to the connected peer record
318 * @param ppd peer performance data
321 consider_request_for_forwarding (void *cls,
322 const struct GNUNET_PeerIdentity *peer,
323 struct GSF_ConnectedPeer *cp,
324 const struct GSF_PeerPerformanceData *ppd)
326 struct GSF_PendingRequest *pr = cls;
328 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
330 #if INSANE_STATISTICS
331 GNUNET_STATISTICS_update (GSF_stats,
332 gettext_noop ("# Loopback routes suppressed"), 1,
337 GSF_plan_add_ (cp, pr);
342 * Function to be called after we're done processing
343 * replies from the local lookup. If the result status
344 * code indicates that there may be more replies, plan
345 * forwarding the request.
347 * @param cls closure (NULL)
348 * @param pr the pending request we were processing
349 * @param result final datastore lookup result
352 consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
353 enum GNUNET_BLOCK_EvaluationResult result)
355 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
356 return; /* we're done... */
357 GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
362 * Handle P2P "GET" request.
364 * @param cls closure, always NULL
365 * @param other the other peer involved (sender or receiver, NULL
366 * for loopback messages where we are both sender and receiver)
367 * @param message the actual message
368 * @return GNUNET_OK to keep the connection open,
369 * GNUNET_SYSERR to close it (signal serious error)
372 handle_p2p_get (void *cls, const struct GNUNET_PeerIdentity *other,
373 const struct GNUNET_MessageHeader *message)
375 struct GSF_PendingRequest *pr;
377 pr = GSF_handle_p2p_query_ (other, message);
379 return GNUNET_SYSERR;
380 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
381 GSF_local_lookup_ (pr, &consider_forwarding, NULL);
387 * We're done with the local lookup, now consider
388 * P2P processing (depending on request options and
389 * result status). Also signal that we can now
390 * receive more request information from the client.
392 * @param cls the client doing the request ('struct GNUNET_SERVER_Client')
393 * @param pr the pending request we were processing
394 * @param result final datastore lookup result
397 start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
398 enum GNUNET_BLOCK_EvaluationResult result)
400 struct GNUNET_SERVER_Client *client = cls;
401 struct GSF_PendingRequestData *prd;
403 GNUNET_SERVER_receive_done (client, GNUNET_OK);
404 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
405 return; /* we're done, 'pr' was already destroyed... */
406 prd = GSF_pending_request_get_data_ (pr);
407 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
408 "Finished database lookup for local request `%s' with result %d\n",
409 GNUNET_h2s (&prd->query), result);
410 if (0 == prd->anonymity_level)
414 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
415 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
416 /* the above block types MAY be available via 'cadet' */
417 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
418 "Considering cadet-based download for block\n");
419 GSF_cadet_lookup_ (pr);
421 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
422 /* the above block types are in the DHT */
423 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
424 "Considering DHT-based search for block\n");
425 GSF_dht_lookup_ (pr);
432 consider_forwarding (NULL, pr, result);
437 * Handle START_SEARCH-message (search request from client).
440 * @param client identification of the client
441 * @param message the actual message
444 handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
445 const struct GNUNET_MessageHeader *message)
447 struct GSF_PendingRequest *pr;
451 ret = GSF_local_client_start_search_handler_ (client, message, &pr);
455 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
458 GNUNET_SERVER_receive_done (client, GNUNET_OK);
461 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
462 GSF_local_lookup_ (pr, &start_p2p_processing, client);
471 * Task run during shutdown.
477 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
479 GSF_cadet_stop_client ();
480 GSF_cadet_stop_server ();
481 if (NULL != GSF_core)
483 GNUNET_CORE_disconnect (GSF_core);
488 GNUNET_ATS_performance_done (GSF_ats);
493 GSF_pending_request_done_ ();
495 GSF_connected_peer_done_ ();
496 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
498 GNUNET_DHT_disconnect (GSF_dht);
500 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
501 GSF_block_ctx = NULL;
502 GNUNET_CONFIGURATION_destroy (block_cfg);
504 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
506 if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
508 GNUNET_SCHEDULER_cancel (cover_age_task);
509 cover_age_task = GNUNET_SCHEDULER_NO_TASK;
511 GNUNET_FS_indexing_done ();
512 GNUNET_LOAD_value_free (datastore_get_load);
513 datastore_get_load = NULL;
514 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
515 GSF_rt_entry_lifetime = NULL;
520 * Function called for each pending request whenever a new
521 * peer connects, giving us a chance to decide about submitting
522 * the existing request to the new peer.
524 * @param cls the 'struct GSF_ConnectedPeer' of the new peer
525 * @param key query for the request
526 * @param pr handle to the pending request
527 * @return GNUNET_YES to continue to iterate
530 consider_peer_for_forwarding (void *cls, const struct GNUNET_HashCode * key,
531 struct GSF_PendingRequest *pr)
533 struct GSF_ConnectedPeer *cp = cls;
534 struct GNUNET_PeerIdentity pid;
536 GSF_connected_peer_get_identity_ (cp, &pid);
537 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, &pid))
539 GNUNET_STATISTICS_update (GSF_stats,
540 gettext_noop ("# Loopback routes suppressed"), 1,
544 GSF_plan_add_ (cp, pr);
550 * Function called after the creation of a connected peer record is complete.
552 * @param cls closure (unused)
553 * @param cp handle to the newly created connected peer record
556 connected_peer_cb (void *cls, struct GSF_ConnectedPeer *cp)
560 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
565 * Method called whenever a given peer connects.
567 * @param cls closure, not used
568 * @param peer peer identity this notification is about
571 peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
573 if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
575 GSF_peer_connect_handler_ (peer, &connected_peer_cb, NULL);
580 * Function called after GNUNET_CORE_connect has succeeded
581 * (or failed for good). Note that the private key of the
582 * peer is intentionally not exposed here; if you need it,
583 * your process should try to read the private key file
584 * directly (which should work if you are authorized...).
587 * @param my_identity ID of this peer, NULL if we failed
590 peer_init_handler (void *cls,
591 const struct GNUNET_PeerIdentity *my_identity)
593 my_id = *my_identity;
598 * Process fs requests.
600 * @param server the initialized server
601 * @param c configuration to use
604 main_init (struct GNUNET_SERVER_Handle *server,
605 const struct GNUNET_CONFIGURATION_Handle *c)
607 static const struct GNUNET_CORE_MessageHandler no_p2p_handlers[] = {
610 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
612 GNUNET_MESSAGE_TYPE_FS_GET, 0},
614 GNUNET_MESSAGE_TYPE_FS_PUT, 0},
615 {&GSF_handle_p2p_migration_stop_,
616 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
617 sizeof (struct MigrationStopMessage)},
620 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
621 {&GNUNET_FS_handle_index_start, NULL,
622 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
623 {&GNUNET_FS_handle_index_list_get, NULL,
624 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
625 sizeof (struct GNUNET_MessageHeader)},
626 {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
627 sizeof (struct UnindexMessage)},
628 {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
634 /* this option is really only for testcases that need to disable
635 _anonymous_ file-sharing for some reason */
636 anon_p2p_off = (GNUNET_YES ==
637 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
639 "DISABLE_ANON_TRANSFER"));
641 GNUNET_CORE_connect (GSF_cfg, NULL, &peer_init_handler,
642 &peer_connect_handler, &GSF_peer_disconnect_handler_,
643 NULL, GNUNET_NO, NULL, GNUNET_NO,
644 (GNUNET_YES == anon_p2p_off)
647 if (NULL == GSF_core)
649 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
650 _("Failed to connect to `%s' service.\n"), "core");
651 return GNUNET_SYSERR;
653 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
655 GNUNET_SERVER_add_handlers (server, handlers);
657 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
659 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
660 GSF_cadet_start_server ();
661 GSF_cadet_start_client ();
662 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
669 * Process fs requests.
672 * @param server the initialized server
673 * @param cfg configuration to use
676 run (void *cls, struct GNUNET_SERVER_Handle *server,
677 const struct GNUNET_CONFIGURATION_Handle *cfg)
679 unsigned long long dqs;
683 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
686 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
687 "fs", "DATASTORE_QUEUE_SIZE");
690 GSF_datastore_queue_size = (unsigned int) dqs;
691 GSF_enable_randomized_delays =
692 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
693 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
696 GNUNET_SCHEDULER_shutdown ();
699 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
700 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
701 block_cfg = GNUNET_CONFIGURATION_create ();
702 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
703 GNUNET_assert (NULL != GSF_block_ctx);
704 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
706 GSF_pending_request_init_ ();
707 GSF_connected_peer_init_ ();
708 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, &update_latencies, NULL);
711 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
712 (GNUNET_OK != main_init (server, cfg)))
714 GNUNET_SCHEDULER_shutdown ();
715 shutdown_task (NULL, NULL);
722 * The main function for the fs service.
724 * @param argc number of arguments from the command line
725 * @param argv command line arguments
726 * @return 0 ok, 1 on error
729 main (int argc, char *const *argv)
732 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
733 &run, NULL)) ? 0 : 1;
736 /* end of gnunet-service-fs.c */