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_stream.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);
210 * Test if the DATABASE (GET) load on this peer is too high
211 * to even consider processing the query at
214 * @return GNUNET_YES if the load is too high to do anything (load high)
215 * GNUNET_NO to process normally (load normal)
216 * GNUNET_SYSERR to process for free (load low)
219 GSF_test_get_load_too_high_ (uint32_t priority)
223 ld = GNUNET_LOAD_get_load (datastore_get_load);
225 return GNUNET_SYSERR;
233 * We've received peer performance information. Update
234 * our running average for the P2P latency.
237 * @param address the address
238 * @param bandwidth_out assigned outbound bandwidth for the connection
239 * @param bandwidth_in assigned inbound bandwidth for the connection
240 * @param ats performance data for the address (as far as known)
241 * @param ats_count number of performance records in 'ats'
244 update_latencies (void *cls,
245 const struct GNUNET_HELLO_Address *address,
247 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
248 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
249 const struct GNUNET_ATS_Information *ats,
253 struct GNUNET_TIME_Relative latency;
255 if (GNUNET_YES != active)
257 for (i = 0; i < ats_count; i++)
259 if (GNUNET_ATS_QUALITY_NET_DELAY != ntohl (ats[i].type))
261 latency.rel_value = ntohl (ats[i].value);
262 GSF_update_peer_latency_ (&address->peer,
264 GSF_avg_latency.rel_value =
265 (GSF_avg_latency.rel_value * 31 +
266 GNUNET_MIN (5000, ntohl (ats[i].value))) / 32;
267 GNUNET_STATISTICS_set (GSF_stats,
269 ("# running average P2P latency (ms)"),
270 GSF_avg_latency.rel_value, GNUNET_NO);
277 * Handle P2P "PUT" message.
279 * @param cls closure, always NULL
280 * @param other the other peer involved (sender or receiver, NULL
281 * for loopback messages where we are both sender and receiver)
282 * @param message the actual message
283 * @return GNUNET_OK to keep the connection open,
284 * GNUNET_SYSERR to close it (signal serious error)
287 handle_p2p_put (void *cls, const struct GNUNET_PeerIdentity *other,
288 const struct GNUNET_MessageHeader *message)
290 struct GSF_ConnectedPeer *cp;
292 cp = GSF_peer_get_ (other);
298 GSF_cover_content_count++;
299 return GSF_handle_p2p_content_ (cp, message);
304 * We have a new request, consider forwarding it to the given
307 * @param cls the 'struct GSF_PendingRequest'
308 * @param peer identity of the peer
309 * @param cp handle to the connected peer record
310 * @param ppd peer performance data
313 consider_request_for_forwarding (void *cls,
314 const struct GNUNET_PeerIdentity *peer,
315 struct GSF_ConnectedPeer *cp,
316 const struct GSF_PeerPerformanceData *ppd)
318 struct GSF_PendingRequest *pr = cls;
320 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
322 #if INSANE_STATISTICS
323 GNUNET_STATISTICS_update (GSF_stats,
324 gettext_noop ("# Loopback routes suppressed"), 1,
329 GSF_plan_add_ (cp, pr);
334 * Function to be called after we're done processing
335 * replies from the local lookup. If the result status
336 * code indicates that there may be more replies, plan
337 * forwarding the request.
339 * @param cls closure (NULL)
340 * @param pr the pending request we were processing
341 * @param result final datastore lookup result
344 consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
345 enum GNUNET_BLOCK_EvaluationResult result)
347 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
348 return; /* we're done... */
349 GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
354 * Handle P2P "GET" request.
356 * @param cls closure, always NULL
357 * @param other the other peer involved (sender or receiver, NULL
358 * for loopback messages where we are both sender and receiver)
359 * @param message the actual message
360 * @return GNUNET_OK to keep the connection open,
361 * GNUNET_SYSERR to close it (signal serious error)
364 handle_p2p_get (void *cls, const struct GNUNET_PeerIdentity *other,
365 const struct GNUNET_MessageHeader *message)
367 struct GSF_PendingRequest *pr;
369 pr = GSF_handle_p2p_query_ (other, message);
371 return GNUNET_SYSERR;
372 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
373 GSF_local_lookup_ (pr, &consider_forwarding, NULL);
379 * We're done with the local lookup, now consider
380 * P2P processing (depending on request options and
381 * result status). Also signal that we can now
382 * receive more request information from the client.
384 * @param cls the client doing the request ('struct GNUNET_SERVER_Client')
385 * @param pr the pending request we were processing
386 * @param result final datastore lookup result
389 start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
390 enum GNUNET_BLOCK_EvaluationResult result)
392 struct GNUNET_SERVER_Client *client = cls;
393 struct GSF_PendingRequestData *prd;
395 prd = GSF_pending_request_get_data_ (pr);
396 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
397 "Finished database lookup for local request `%s' with result %d\n",
398 GNUNET_h2s (&prd->query), result);
399 GNUNET_SERVER_receive_done (client, GNUNET_OK);
400 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
401 return; /* we're done, 'pr' was already destroyed... */
402 if (0 != (GSF_PRO_LOCAL_ONLY & prd->options))
404 GSF_pending_request_cancel_ (pr, GNUNET_YES);
407 if (0 == prd->anonymity_level)
411 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
412 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
413 /* the above block types MAY be available via 'stream' */
414 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
415 "Considering stream-based download for block\n");
416 GSF_stream_lookup_ (pr);
418 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
419 /* the above block types are in the DHT */
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
421 "Considering DHT-based search for block\n");
422 GSF_dht_lookup_ (pr);
429 consider_forwarding (NULL, pr, result);
434 * Handle START_SEARCH-message (search request from client).
437 * @param client identification of the client
438 * @param message the actual message
441 handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
442 const struct GNUNET_MessageHeader *message)
444 struct GSF_PendingRequest *pr;
448 ret = GSF_local_client_start_search_handler_ (client, message, &pr);
452 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
455 GNUNET_SERVER_receive_done (client, GNUNET_OK);
458 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
459 GSF_local_lookup_ (pr, &start_p2p_processing, client);
468 * Task run during shutdown.
474 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
477 if (NULL != GSF_core)
479 GNUNET_CORE_disconnect (GSF_core);
484 GNUNET_ATS_performance_done (GSF_ats);
489 GSF_pending_request_done_ ();
491 GSF_connected_peer_done_ ();
492 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
494 GNUNET_DHT_disconnect (GSF_dht);
496 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
497 GSF_block_ctx = NULL;
498 GNUNET_CONFIGURATION_destroy (block_cfg);
500 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
502 if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
504 GNUNET_SCHEDULER_cancel (cover_age_task);
505 cover_age_task = GNUNET_SCHEDULER_NO_TASK;
507 GNUNET_FS_indexing_done ();
508 GNUNET_LOAD_value_free (datastore_get_load);
509 datastore_get_load = NULL;
510 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
511 GSF_rt_entry_lifetime = NULL;
516 * Function called for each pending request whenever a new
517 * peer connects, giving us a chance to decide about submitting
518 * the existing request to the new peer.
520 * @param cls the 'struct GSF_ConnectedPeer' of the new peer
521 * @param key query for the request
522 * @param pr handle to the pending request
523 * @return GNUNET_YES to continue to iterate
526 consider_peer_for_forwarding (void *cls, const struct GNUNET_HashCode * key,
527 struct GSF_PendingRequest *pr)
529 struct GSF_ConnectedPeer *cp = cls;
530 struct GNUNET_PeerIdentity pid;
532 GSF_connected_peer_get_identity_ (cp, &pid);
533 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, &pid))
535 GNUNET_STATISTICS_update (GSF_stats,
536 gettext_noop ("# Loopback routes suppressed"), 1,
540 GSF_plan_add_ (cp, pr);
546 * Method called whenever a given peer connects.
548 * @param cls closure, not used
549 * @param peer peer identity this notification is about
552 peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
554 struct GSF_ConnectedPeer *cp;
556 if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
558 cp = GSF_peer_connect_handler_ (peer);
561 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
566 * Function called after GNUNET_CORE_connect has succeeded
567 * (or failed for good). Note that the private key of the
568 * peer is intentionally not exposed here; if you need it,
569 * your process should try to read the private key file
570 * directly (which should work if you are authorized...).
573 * @param server handle to the server, NULL if we failed
574 * @param my_identity ID of this peer, NULL if we failed
577 peer_init_handler (void *cls, struct GNUNET_CORE_Handle *server,
578 const struct GNUNET_PeerIdentity *my_identity)
580 my_id = *my_identity;
585 * Process fs requests.
587 * @param server the initialized server
588 * @param c configuration to use
591 main_init (struct GNUNET_SERVER_Handle *server,
592 const struct GNUNET_CONFIGURATION_Handle *c)
594 static const struct GNUNET_CORE_MessageHandler no_p2p_handlers[] = {
597 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
599 GNUNET_MESSAGE_TYPE_FS_GET, 0},
601 GNUNET_MESSAGE_TYPE_FS_PUT, 0},
602 {&GSF_handle_p2p_migration_stop_,
603 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
604 sizeof (struct MigrationStopMessage)},
607 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
608 {&GNUNET_FS_handle_index_start, NULL,
609 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
610 {&GNUNET_FS_handle_index_list_get, NULL,
611 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
612 sizeof (struct GNUNET_MessageHeader)},
613 {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
614 sizeof (struct UnindexMessage)},
615 {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
621 /* this option is really only for testcases that need to disable
622 _anonymous_ file-sharing for some reason */
623 anon_p2p_off = (GNUNET_YES ==
624 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
626 "DISABLE_ANON_TRANSFER"));
628 GNUNET_CORE_connect (GSF_cfg, NULL, &peer_init_handler,
629 &peer_connect_handler, &GSF_peer_disconnect_handler_,
630 NULL, GNUNET_NO, NULL, GNUNET_NO,
631 (GNUNET_YES == anon_p2p_off)
634 if (NULL == GSF_core)
636 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
637 _("Failed to connect to `%s' service.\n"), "core");
638 return GNUNET_SYSERR;
640 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
642 GNUNET_SERVER_add_handlers (server, handlers);
644 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
646 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
648 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
655 * Process fs requests.
658 * @param server the initialized server
659 * @param cfg configuration to use
662 run (void *cls, struct GNUNET_SERVER_Handle *server,
663 const struct GNUNET_CONFIGURATION_Handle *cfg)
665 unsigned long long dqs;
669 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
672 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
673 "fs", "DATASTORE_QUEUE_SIZE");
676 GSF_datastore_queue_size = (unsigned int) dqs;
677 GSF_enable_randomized_delays =
678 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
679 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
682 GNUNET_SCHEDULER_shutdown ();
685 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
686 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
687 block_cfg = GNUNET_CONFIGURATION_create ();
688 GNUNET_CONFIGURATION_set_value_string (block_cfg, "block", "PLUGINS", "fs");
689 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
690 GNUNET_assert (NULL != GSF_block_ctx);
691 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
693 GSF_pending_request_init_ ();
694 GSF_connected_peer_init_ ();
695 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, NULL, NULL, &update_latencies, NULL);
698 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
699 (GNUNET_OK != main_init (server, cfg)))
701 GNUNET_SCHEDULER_shutdown ();
702 shutdown_task (NULL, NULL);
709 * The main function for the fs service.
711 * @param argc number of arguments from the command line
712 * @param argv command line arguments
713 * @return 0 ok, 1 on error
716 main (int argc, char *const *argv)
719 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
720 &run, NULL)) ? 0 : 1;
723 /* end of gnunet-service-fs.c */