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,
246 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
247 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
248 const struct GNUNET_ATS_Information *ats,
252 struct GNUNET_TIME_Relative latency;
254 // FIXME: if (GNUNET_YES != current_address) return;
255 for (i = 0; i < ats_count; i++)
257 if (GNUNET_ATS_QUALITY_NET_DELAY != ntohl (ats[i].type))
259 latency.rel_value = ntohl (ats[i].value);
260 GSF_update_peer_latency_ (&address->peer,
262 GSF_avg_latency.rel_value =
263 (GSF_avg_latency.rel_value * 31 +
264 GNUNET_MIN (5000, ntohl (ats[i].value))) / 32;
265 GNUNET_STATISTICS_set (GSF_stats,
267 ("# running average P2P latency (ms)"),
268 GSF_avg_latency.rel_value, GNUNET_NO);
275 * Handle P2P "PUT" message.
277 * @param cls closure, always NULL
278 * @param other the other peer involved (sender or receiver, NULL
279 * for loopback messages where we are both sender and receiver)
280 * @param message the actual message
281 * @return GNUNET_OK to keep the connection open,
282 * GNUNET_SYSERR to close it (signal serious error)
285 handle_p2p_put (void *cls, const struct GNUNET_PeerIdentity *other,
286 const struct GNUNET_MessageHeader *message)
288 struct GSF_ConnectedPeer *cp;
290 cp = GSF_peer_get_ (other);
296 GSF_cover_content_count++;
297 return GSF_handle_p2p_content_ (cp, message);
302 * We have a new request, consider forwarding it to the given
305 * @param cls the 'struct GSF_PendingRequest'
306 * @param peer identity of the peer
307 * @param cp handle to the connected peer record
308 * @param ppd peer performance data
311 consider_request_for_forwarding (void *cls,
312 const struct GNUNET_PeerIdentity *peer,
313 struct GSF_ConnectedPeer *cp,
314 const struct GSF_PeerPerformanceData *ppd)
316 struct GSF_PendingRequest *pr = cls;
318 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
320 #if INSANE_STATISTICS
321 GNUNET_STATISTICS_update (GSF_stats,
322 gettext_noop ("# Loopback routes suppressed"), 1,
327 GSF_plan_add_ (cp, pr);
332 * Function to be called after we're done processing
333 * replies from the local lookup. If the result status
334 * code indicates that there may be more replies, plan
335 * forwarding the request.
337 * @param cls closure (NULL)
338 * @param pr the pending request we were processing
339 * @param result final datastore lookup result
342 consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
343 enum GNUNET_BLOCK_EvaluationResult result)
345 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
346 return; /* we're done... */
347 GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
352 * Handle P2P "GET" request.
354 * @param cls closure, always NULL
355 * @param other the other peer involved (sender or receiver, NULL
356 * for loopback messages where we are both sender and receiver)
357 * @param message the actual message
358 * @return GNUNET_OK to keep the connection open,
359 * GNUNET_SYSERR to close it (signal serious error)
362 handle_p2p_get (void *cls, const struct GNUNET_PeerIdentity *other,
363 const struct GNUNET_MessageHeader *message)
365 struct GSF_PendingRequest *pr;
367 pr = GSF_handle_p2p_query_ (other, message);
369 return GNUNET_SYSERR;
370 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
371 GSF_local_lookup_ (pr, &consider_forwarding, NULL);
377 * We're done with the local lookup, now consider
378 * P2P processing (depending on request options and
379 * result status). Also signal that we can now
380 * receive more request information from the client.
382 * @param cls the client doing the request ('struct GNUNET_SERVER_Client')
383 * @param pr the pending request we were processing
384 * @param result final datastore lookup result
387 start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
388 enum GNUNET_BLOCK_EvaluationResult result)
390 struct GNUNET_SERVER_Client *client = cls;
391 struct GSF_PendingRequestData *prd;
393 prd = GSF_pending_request_get_data_ (pr);
394 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
395 "Finished database lookup for local request `%s' with result %d\n",
396 GNUNET_h2s (&prd->query), result);
397 GNUNET_SERVER_receive_done (client, GNUNET_OK);
398 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
399 return; /* we're done, 'pr' was already destroyed... */
400 if (0 != (GSF_PRO_LOCAL_ONLY & prd->options))
402 GSF_pending_request_cancel_ (pr, GNUNET_YES);
405 if (0 == prd->anonymity_level)
409 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
410 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
411 /* the above block types MAY be available via 'stream' */
412 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
413 "Considering stream-based download for block\n");
414 GSF_stream_lookup_ (pr);
416 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
417 /* the above block types are in the DHT */
418 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
419 "Considering DHT-based search for block\n");
420 GSF_dht_lookup_ (pr);
427 consider_forwarding (NULL, pr, result);
432 * Handle START_SEARCH-message (search request from client).
435 * @param client identification of the client
436 * @param message the actual message
439 handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
440 const struct GNUNET_MessageHeader *message)
442 struct GSF_PendingRequest *pr;
446 ret = GSF_local_client_start_search_handler_ (client, message, &pr);
450 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
453 GNUNET_SERVER_receive_done (client, GNUNET_OK);
456 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
457 GSF_local_lookup_ (pr, &start_p2p_processing, client);
466 * Task run during shutdown.
472 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
475 if (NULL != GSF_core)
477 GNUNET_CORE_disconnect (GSF_core);
482 GNUNET_ATS_performance_done (GSF_ats);
487 GSF_pending_request_done_ ();
489 GSF_connected_peer_done_ ();
490 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
492 GNUNET_DHT_disconnect (GSF_dht);
494 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
495 GSF_block_ctx = NULL;
496 GNUNET_CONFIGURATION_destroy (block_cfg);
498 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
500 if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
502 GNUNET_SCHEDULER_cancel (cover_age_task);
503 cover_age_task = GNUNET_SCHEDULER_NO_TASK;
505 GNUNET_FS_indexing_done ();
506 GNUNET_LOAD_value_free (datastore_get_load);
507 datastore_get_load = NULL;
508 GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
509 GSF_rt_entry_lifetime = NULL;
514 * Function called for each pending request whenever a new
515 * peer connects, giving us a chance to decide about submitting
516 * the existing request to the new peer.
518 * @param cls the 'struct GSF_ConnectedPeer' of the new peer
519 * @param key query for the request
520 * @param pr handle to the pending request
521 * @return GNUNET_YES to continue to iterate
524 consider_peer_for_forwarding (void *cls, const struct GNUNET_HashCode * key,
525 struct GSF_PendingRequest *pr)
527 struct GSF_ConnectedPeer *cp = cls;
528 struct GNUNET_PeerIdentity pid;
530 GSF_connected_peer_get_identity_ (cp, &pid);
531 if (GNUNET_YES != GSF_pending_request_test_target_ (pr, &pid))
533 GNUNET_STATISTICS_update (GSF_stats,
534 gettext_noop ("# Loopback routes suppressed"), 1,
538 GSF_plan_add_ (cp, pr);
544 * Method called whenever a given peer connects.
546 * @param cls closure, not used
547 * @param peer peer identity this notification is about
550 peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
552 struct GSF_ConnectedPeer *cp;
554 if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
556 cp = GSF_peer_connect_handler_ (peer);
559 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
564 * Function called after GNUNET_CORE_connect has succeeded
565 * (or failed for good). Note that the private key of the
566 * peer is intentionally not exposed here; if you need it,
567 * your process should try to read the private key file
568 * directly (which should work if you are authorized...).
571 * @param server handle to the server, NULL if we failed
572 * @param my_identity ID of this peer, NULL if we failed
575 peer_init_handler (void *cls, struct GNUNET_CORE_Handle *server,
576 const struct GNUNET_PeerIdentity *my_identity)
578 my_id = *my_identity;
583 * Process fs requests.
585 * @param server the initialized server
586 * @param c configuration to use
589 main_init (struct GNUNET_SERVER_Handle *server,
590 const struct GNUNET_CONFIGURATION_Handle *c)
592 static const struct GNUNET_CORE_MessageHandler no_p2p_handlers[] = {
595 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
597 GNUNET_MESSAGE_TYPE_FS_GET, 0},
599 GNUNET_MESSAGE_TYPE_FS_PUT, 0},
600 {&GSF_handle_p2p_migration_stop_,
601 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
602 sizeof (struct MigrationStopMessage)},
605 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
606 {&GNUNET_FS_handle_index_start, NULL,
607 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
608 {&GNUNET_FS_handle_index_list_get, NULL,
609 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
610 sizeof (struct GNUNET_MessageHeader)},
611 {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
612 sizeof (struct UnindexMessage)},
613 {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
619 /* this option is really only for testcases that need to disable
620 _anonymous_ file-sharing for some reason */
621 anon_p2p_off = (GNUNET_YES ==
622 GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
624 "DISABLE_ANON_TRANSFER"));
626 GNUNET_CORE_connect (GSF_cfg, NULL, &peer_init_handler,
627 &peer_connect_handler, &GSF_peer_disconnect_handler_,
628 NULL, GNUNET_NO, NULL, GNUNET_NO,
629 (GNUNET_YES == anon_p2p_off)
632 if (NULL == GSF_core)
634 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
635 _("Failed to connect to `%s' service.\n"), "core");
636 return GNUNET_SYSERR;
638 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
640 GNUNET_SERVER_add_handlers (server, handlers);
642 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
644 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
646 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
653 * Process fs requests.
656 * @param server the initialized server
657 * @param cfg configuration to use
660 run (void *cls, struct GNUNET_SERVER_Handle *server,
661 const struct GNUNET_CONFIGURATION_Handle *cfg)
663 unsigned long long dqs;
667 GNUNET_CONFIGURATION_get_value_size (GSF_cfg, "fs", "DATASTORE_QUEUE_SIZE",
670 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_INFO,
671 "fs", "DATASTORE_QUEUE_SIZE");
674 GSF_datastore_queue_size = (unsigned int) dqs;
675 GSF_enable_randomized_delays =
676 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
677 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
680 GNUNET_SCHEDULER_shutdown ();
683 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
684 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
685 block_cfg = GNUNET_CONFIGURATION_create ();
686 GNUNET_CONFIGURATION_set_value_string (block_cfg, "block", "PLUGINS", "fs");
687 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
688 GNUNET_assert (NULL != GSF_block_ctx);
689 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
691 GSF_pending_request_init_ ();
692 GSF_connected_peer_init_ ();
693 GSF_ats = GNUNET_ATS_performance_init (GSF_cfg, &update_latencies, NULL);
696 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
697 (GNUNET_OK != main_init (server, cfg)))
699 GNUNET_SCHEDULER_shutdown ();
700 shutdown_task (NULL, NULL);
707 * The main function for the fs service.
709 * @param argc number of arguments from the command line
710 * @param argv command line arguments
711 * @return 0 ok, 1 on error
714 main (int argc, char *const *argv)
717 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
718 &run, NULL)) ? 0 : 1;
721 /* end of gnunet-service-fs.c */