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
27 * - consider re-issue GSF_dht_lookup_ after non-DHT reply received
28 * - implement 'SUPPORT_DELAYS'
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"
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.
58 #define FS_DHT_HT_SIZE 1024
62 * How quickly do we age cover traffic? At the given
63 * time interval, remaining cover traffic counters are
64 * decremented by 1/16th.
66 #define COVER_AGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
69 /* ****************************** globals ****************************** */
72 * Our connection to the datastore.
74 struct GNUNET_DATASTORE_Handle *GSF_dsh;
79 const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
82 * Handle for reporting statistics.
84 struct GNUNET_STATISTICS_Handle *GSF_stats;
87 * Handle for DHT operations.
89 struct GNUNET_DHT_Handle *GSF_dht;
92 * How long do requests typically stay in the routing table?
94 struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
97 * Running average of the observed latency to other peers (round trip).
98 * Initialized to 5s as the initial default.
100 struct GNUNET_TIME_Relative GSF_avg_latency = { 5000 };
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.
112 double GSF_current_priorities;
115 * How many query messages have we received 'recently' that
116 * have not yet been claimed as cover traffic?
118 unsigned int GSF_cover_query_count;
121 * How many content messages have we received 'recently' that
122 * have not yet been claimed as cover traffic?
124 unsigned int GSF_cover_content_count;
129 struct GNUNET_BLOCK_Context *GSF_block_ctx;
132 * Pointer to handle to the core service (points to NULL until we've
135 struct GNUNET_CORE_Handle *GSF_core;
138 * Are we introducing randomized delays for better anonymity?
140 int GSF_enable_randomized_delays;
142 /* ***************************** locals ******************************* */
145 * Configuration for block library.
147 static struct GNUNET_CONFIGURATION_Handle *block_cfg;
150 * ID of our task that we use to age the cover counters.
152 static GNUNET_SCHEDULER_TaskIdentifier cover_age_task;
155 * Datastore 'GET' load tracking.
157 static struct GNUNET_LOAD_Value *datastore_get_load;
160 * Identity of this peer.
162 static struct GNUNET_PeerIdentity my_id;
165 * Task that periodically ages our cover traffic statistics.
167 * @param cls unused closure
168 * @param tc task context
171 age_cover_counters (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
173 GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
174 GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
176 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
182 * We've just now completed a datastore request. Update our
183 * datastore load calculations.
185 * @param start time when the datastore request was issued
188 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
190 struct GNUNET_TIME_Relative delay;
192 delay = GNUNET_TIME_absolute_get_duration (start);
193 GNUNET_LOAD_update (datastore_get_load, delay.rel_value);
198 * Test if the DATABASE (GET) load on this peer is too high
199 * to even consider processing the query at
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)
207 GSF_test_get_load_too_high_ (uint32_t priority)
211 ld = GNUNET_LOAD_get_load (datastore_get_load);
213 return GNUNET_SYSERR;
221 * We've received peer performance information. Update
222 * our running average for the P2P latency.
224 * @param atsi performance information
225 * @param atsi_count number of 'atsi' records
228 update_latencies (const struct GNUNET_ATS_Information *atsi,
229 unsigned int atsi_count)
233 for (i=0;i<atsi_count;i++)
235 if (ntohl(atsi[i].type) == GNUNET_ATS_QUALITY_NET_DELAY)
237 GSF_avg_latency.rel_value = (GSF_avg_latency.rel_value * 31 + ntohl (atsi[i].value)) / 32;
238 GNUNET_STATISTICS_set (GSF_stats,
239 gettext_noop ("# running average P2P latency (ms)"),
240 GSF_avg_latency.rel_value,
249 * Handle P2P "PUT" message.
251 * @param cls closure, always NULL
252 * @param other the other peer involved (sender or receiver, NULL
253 * for loopback messages where we are both sender and receiver)
254 * @param message the actual message
255 * @param atsi performance information
256 * @param atsi_count number of records in 'atsi'
257 * @return GNUNET_OK to keep the connection open,
258 * GNUNET_SYSERR to close it (signal serious error)
261 handle_p2p_put (void *cls, const struct GNUNET_PeerIdentity *other,
262 const struct GNUNET_MessageHeader *message,
263 const struct GNUNET_ATS_Information *atsi,
264 unsigned int atsi_count)
266 struct GSF_ConnectedPeer *cp;
268 cp = GSF_peer_get_ (other);
274 GSF_cover_content_count++;
275 update_latencies (atsi, atsi_count);
276 return GSF_handle_p2p_content_ (cp, message);
281 * We have a new request, consider forwarding it to the given
284 * @param cls the 'struct GSF_PendingRequest'
285 * @param peer identity of the peer
286 * @param cp handle to the connected peer record
287 * @param ppd peer performance data
290 consider_request_for_forwarding (void *cls,
291 const struct GNUNET_PeerIdentity *peer,
292 struct GSF_ConnectedPeer *cp,
293 const struct GSF_PeerPerformanceData *ppd)
295 struct GSF_PendingRequest *pr = cls;
298 GSF_pending_request_test_target_ (pr,
301 GNUNET_STATISTICS_update (GSF_stats,
302 gettext_noop ("# Loopback routes suppressed"), 1,
306 GSF_plan_add_ (cp, pr);
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.
316 * @param cls closure (NULL)
317 * @param pr the pending request we were processing
318 * @param result final datastore lookup result
321 consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
322 enum GNUNET_BLOCK_EvaluationResult result)
324 if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
325 return; /* we're done... */
326 GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
331 * Handle P2P "GET" request.
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)
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)
348 struct GSF_PendingRequest *pr;
350 pr = GSF_handle_p2p_query_ (other, message);
352 return GNUNET_SYSERR;
353 GSF_local_lookup_ (pr, &consider_forwarding, NULL);
354 update_latencies (atsi, atsi_count);
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.
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
370 start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
371 enum GNUNET_BLOCK_EvaluationResult result)
373 struct GNUNET_SERVER_Client *client = cls;
374 struct GSF_PendingRequestData *prd;
376 prd = GSF_pending_request_get_data_ (pr);
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);
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))
387 GSF_pending_request_cancel_ (pr, GNUNET_YES);
390 GSF_dht_lookup_ (pr);
391 consider_forwarding (NULL, pr, result);
396 * Handle START_SEARCH-message (search request from client).
399 * @param client identification of the client
400 * @param message the actual message
403 handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
404 const struct GNUNET_MessageHeader *message)
406 struct GSF_PendingRequest *pr;
408 pr = GSF_local_client_start_search_handler_ (client, message);
411 /* GNUNET_SERVER_receive_done was already called! */
414 GSF_local_lookup_ (pr, &start_p2p_processing, client);
419 * Task run during shutdown.
425 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
427 if (NULL != GSF_core)
429 GNUNET_CORE_disconnect (GSF_core);
434 GSF_pending_request_done_ ();
436 GSF_connected_peer_done_ ();
437 GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
439 GNUNET_DHT_disconnect (GSF_dht);
441 GNUNET_BLOCK_context_destroy (GSF_block_ctx);
442 GSF_block_ctx = NULL;
443 GNUNET_CONFIGURATION_destroy (block_cfg);
445 GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
447 if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
449 GNUNET_SCHEDULER_cancel (cover_age_task);
450 cover_age_task = GNUNET_SCHEDULER_NO_TASK;
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;
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.
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
471 consider_peer_for_forwarding (void *cls, const GNUNET_HashCode * key,
472 struct GSF_PendingRequest *pr)
474 struct GSF_ConnectedPeer *cp = cls;
475 struct GNUNET_PeerIdentity pid;
477 GSF_connected_peer_get_identity_ (cp, &pid);
479 GSF_pending_request_test_target_ (pr,
482 GNUNET_STATISTICS_update (GSF_stats,
483 gettext_noop ("# Loopback routes suppressed"), 1,
487 GSF_plan_add_ (cp, pr);
493 * Method called whenever a given peer connects.
495 * @param cls closure, not used
496 * @param peer peer identity this notification is about
497 * @param atsi performance information
498 * @param atsi_count number of records in 'atsi'
501 peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
502 const struct GNUNET_ATS_Information *atsi,
503 unsigned int atsi_count)
505 struct GSF_ConnectedPeer *cp;
507 if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
509 cp = GSF_peer_connect_handler_ (peer, atsi, atsi_count);
512 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
517 * Function called after GNUNET_CORE_connect has succeeded
518 * (or failed for good). Note that the private key of the
519 * peer is intentionally not exposed here; if you need it,
520 * your process should try to read the private key file
521 * directly (which should work if you are authorized...).
524 * @param server handle to the server, NULL if we failed
525 * @param my_identity ID of this peer, NULL if we failed
528 peer_init_handler (void *cls, struct GNUNET_CORE_Handle *server,
529 const struct GNUNET_PeerIdentity *my_identity)
531 my_id = *my_identity;
536 * Process fs requests.
538 * @param server the initialized server
539 * @param c configuration to use
542 main_init (struct GNUNET_SERVER_Handle *server,
543 const struct GNUNET_CONFIGURATION_Handle *c)
545 static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
547 GNUNET_MESSAGE_TYPE_FS_GET, 0},
549 GNUNET_MESSAGE_TYPE_FS_PUT, 0},
550 {&GSF_handle_p2p_migration_stop_,
551 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
552 sizeof (struct MigrationStopMessage)},
555 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
556 {&GNUNET_FS_handle_index_start, NULL,
557 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
558 {&GNUNET_FS_handle_index_list_get, NULL,
559 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
560 sizeof (struct GNUNET_MessageHeader)},
561 {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
562 sizeof (struct UnindexMessage)},
563 {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
568 GSF_core = GNUNET_CORE_connect (GSF_cfg, 2, /* larger? */
569 NULL, &peer_init_handler,
570 &peer_connect_handler,
571 &GSF_peer_disconnect_handler_,
573 NULL, GNUNET_NO, p2p_handlers);
574 if (NULL == GSF_core)
576 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
577 _("Failed to connect to `%s' service.\n"), "core");
578 return GNUNET_SYSERR;
580 GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
582 GNUNET_SERVER_add_handlers (server, handlers);
584 GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
586 datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
587 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
594 * Process fs requests.
597 * @param server the initialized server
598 * @param cfg configuration to use
601 run (void *cls, struct GNUNET_SERVER_Handle *server,
602 const struct GNUNET_CONFIGURATION_Handle *cfg)
605 GSF_enable_randomized_delays =
606 GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
607 GSF_dsh = GNUNET_DATASTORE_connect (cfg);
610 GNUNET_SCHEDULER_shutdown ();
613 GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
614 GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
615 block_cfg = GNUNET_CONFIGURATION_create ();
616 GNUNET_CONFIGURATION_set_value_string (block_cfg, "block", "PLUGINS", "fs");
617 GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
618 GNUNET_assert (NULL != GSF_block_ctx);
619 GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
621 GSF_pending_request_init_ ();
622 GSF_connected_peer_init_ ();
625 if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
626 (GNUNET_OK != main_init (server, cfg)))
628 GNUNET_SCHEDULER_shutdown ();
629 shutdown_task (NULL, NULL);
636 * The main function for the fs service.
638 * @param argc number of arguments from the command line
639 * @param argv command line arguments
640 * @return 0 ok, 1 on error
643 main (int argc, char *const *argv)
646 GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
647 &run, NULL)) ? 0 : 1;
650 /* end of gnunet-service-fs.c */