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
31
#include "gnunet_constants.h"
32
#include "gnunet_core_service.h"
33
#include "gnunet_dht_service.h"
34
#include "gnunet_datastore_service.h"
35
#include "gnunet_load_lib.h"
36
#include "gnunet_peer_lib.h"
37
#include "gnunet_protocols.h"
38
#include "gnunet_signatures.h"
39
#include "gnunet_statistics_service.h"
40
#include "gnunet_transport_service.h"
41
#include "gnunet_util_lib.h"
42
#include "gnunet-service-fs_cp.h"
43
#include "gnunet-service-fs_indexing.h"
44
#include "gnunet-service-fs_lc.h"
45
#include "gnunet-service-fs_pe.h"
46
#include "gnunet-service-fs_pr.h"
47
#include "gnunet-service-fs_push.h"
48
#include "gnunet-service-fs_put.h"
52
* Size for the hash map for DHT requests from the FS
53
* service. Should be about the number of concurrent
54
* DHT requests we plan to make.
56
#define FS_DHT_HT_SIZE 1024
60
* How quickly do we age cover traffic? At the given
61
* time interval, remaining cover traffic counters are
62
* decremented by 1/16th.
64
#define COVER_AGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
67
/* ****************************** globals ****************************** */
70
* Our connection to the datastore.
72
struct GNUNET_DATASTORE_Handle *GSF_dsh;
77
const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
80
* Handle for reporting statistics.
82
struct GNUNET_STATISTICS_Handle *GSF_stats;
85
* Handle for DHT operations.
87
struct GNUNET_DHT_Handle *GSF_dht;
90
* How long do requests typically stay in the routing table?
92
struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
95
* Running average of the observed latency to other peers (round trip).
96
* Initialized to 5s as the initial default.
98
struct GNUNET_TIME_Relative GSF_avg_latency = { 500 };
101
* Typical priorities we're seeing from other peers right now. Since
102
* most priorities will be zero, this value is the weighted average of
103
* non-zero priorities seen "recently". In order to ensure that new
104
* values do not dramatically change the ratio, values are first
105
* "capped" to a reasonable range (+N of the current value) and then
106
* averaged into the existing value by a ratio of 1:N. Hence
107
* receiving the largest possible priority can still only raise our
108
* "current_priorities" by at most 1.
110
double GSF_current_priorities;
113
* How many query messages have we received 'recently' that
114
* have not yet been claimed as cover traffic?
116
unsigned int GSF_cover_query_count;
119
* How many content messages have we received 'recently' that
120
* have not yet been claimed as cover traffic?
122
unsigned int GSF_cover_content_count;
127
struct GNUNET_BLOCK_Context *GSF_block_ctx;
130
* Pointer to handle to the core service (points to NULL until we've
133
struct GNUNET_CORE_Handle *GSF_core;
136
* Are we introducing randomized delays for better anonymity?
138
int GSF_enable_randomized_delays;
140
/* ***************************** locals ******************************* */
143
* Configuration for block library.
145
static struct GNUNET_CONFIGURATION_Handle *block_cfg;
148
* ID of our task that we use to age the cover counters.
150
static GNUNET_SCHEDULER_TaskIdentifier cover_age_task;
153
* Datastore 'GET' load tracking.
155
static struct GNUNET_LOAD_Value *datastore_get_load;
158
* Identity of this peer.
160
static struct GNUNET_PeerIdentity my_id;
163
* Task that periodically ages our cover traffic statistics.
165
* @param cls unused closure
166
* @param tc task context
169
age_cover_counters (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
171
GSF_cover_content_count = (GSF_cover_content_count * 15) / 16;
172
GSF_cover_query_count = (GSF_cover_query_count * 15) / 16;
174
GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
180
* We've just now completed a datastore request. Update our
181
* datastore load calculations.
183
* @param start time when the datastore request was issued
186
GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start)
188
struct GNUNET_TIME_Relative delay;
190
delay = GNUNET_TIME_absolute_get_duration (start);
191
GNUNET_LOAD_update (datastore_get_load, delay.rel_value);
196
* Test if the DATABASE (GET) load on this peer is too high
197
* to even consider processing the query at
200
* @return GNUNET_YES if the load is too high to do anything (load high)
201
* GNUNET_NO to process normally (load normal)
202
* GNUNET_SYSERR to process for free (load low)
205
GSF_test_get_load_too_high_ (uint32_t priority)
209
ld = GNUNET_LOAD_get_load (datastore_get_load);
211
return GNUNET_SYSERR;
219
* We've received peer performance information. Update
220
* our running average for the P2P latency.
222
* @param atsi performance information
223
* @param atsi_count number of 'atsi' records
226
update_latencies (const struct GNUNET_ATS_Information *atsi,
227
unsigned int atsi_count)
231
for (i = 0; i < atsi_count; i++)
233
if (ntohl (atsi[i].type) == GNUNET_ATS_QUALITY_NET_DELAY)
235
GSF_avg_latency.rel_value =
236
(GSF_avg_latency.rel_value * 31 +
237
GNUNET_MIN (5000, ntohl (atsi[i].value))) / 32;
238
GNUNET_STATISTICS_set (GSF_stats,
240
("# running average P2P latency (ms)"),
241
GSF_avg_latency.rel_value, GNUNET_NO);
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;
297
if (GNUNET_YES != GSF_pending_request_test_target_ (pr, peer))
299
GNUNET_STATISTICS_update (GSF_stats,
300
gettext_noop ("# Loopback routes suppressed"), 1,
304
GSF_plan_add_ (cp, pr);
309
* Function to be called after we're done processing
310
* replies from the local lookup. If the result status
311
* code indicates that there may be more replies, plan
312
* forwarding the request.
314
* @param cls closure (NULL)
315
* @param pr the pending request we were processing
316
* @param result final datastore lookup result
319
consider_forwarding (void *cls, struct GSF_PendingRequest *pr,
320
enum GNUNET_BLOCK_EvaluationResult result)
322
if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
323
return; /* we're done... */
324
GSF_iterate_connected_peers_ (&consider_request_for_forwarding, pr);
329
* Handle P2P "GET" request.
331
* @param cls closure, always NULL
332
* @param other the other peer involved (sender or receiver, NULL
333
* for loopback messages where we are both sender and receiver)
334
* @param message the actual message
335
* @param atsi performance information
336
* @param atsi_count number of records in 'atsi'
337
* @return GNUNET_OK to keep the connection open,
338
* GNUNET_SYSERR to close it (signal serious error)
341
handle_p2p_get (void *cls, const struct GNUNET_PeerIdentity *other,
342
const struct GNUNET_MessageHeader *message,
343
const struct GNUNET_ATS_Information *atsi,
344
unsigned int atsi_count)
346
struct GSF_PendingRequest *pr;
348
pr = GSF_handle_p2p_query_ (other, message);
350
return GNUNET_SYSERR;
351
GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
352
GSF_local_lookup_ (pr, &consider_forwarding, NULL);
353
update_latencies (atsi, atsi_count);
359
* We're done with the local lookup, now consider
360
* P2P processing (depending on request options and
361
* result status). Also signal that we can now
362
* receive more request information from the client.
364
* @param cls the client doing the request ('struct GNUNET_SERVER_Client')
365
* @param pr the pending request we were processing
366
* @param result final datastore lookup result
369
start_p2p_processing (void *cls, struct GSF_PendingRequest *pr,
370
enum GNUNET_BLOCK_EvaluationResult result)
372
struct GNUNET_SERVER_Client *client = cls;
373
struct GSF_PendingRequestData *prd;
375
prd = GSF_pending_request_get_data_ (pr);
376
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
377
"Finished database lookup for local request `%s' with result %d\n",
378
GNUNET_h2s (&prd->query), result);
379
GNUNET_SERVER_receive_done (client, GNUNET_OK);
380
if (GNUNET_BLOCK_EVALUATION_OK_LAST == result)
381
return; /* we're done, 'pr' was already destroyed... */
382
if (0 != (GSF_PRO_LOCAL_ONLY & prd->options))
384
GSF_pending_request_cancel_ (pr, GNUNET_YES);
387
GSF_dht_lookup_ (pr);
388
consider_forwarding (NULL, pr, result);
393
* Handle START_SEARCH-message (search request from client).
396
* @param client identification of the client
397
* @param message the actual message
400
handle_start_search (void *cls, struct GNUNET_SERVER_Client *client,
401
const struct GNUNET_MessageHeader *message)
403
struct GSF_PendingRequest *pr;
407
ret = GSF_local_client_start_search_handler_ (client, message, &pr);
411
GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
414
GNUNET_SERVER_receive_done (client, GNUNET_OK);
417
GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
418
GSF_local_lookup_ (pr, &start_p2p_processing, client);
427
* Task run during shutdown.
433
shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
435
if (NULL != GSF_core)
437
GNUNET_CORE_disconnect (GSF_core);
442
GSF_pending_request_done_ ();
444
GSF_connected_peer_done_ ();
445
GNUNET_DATASTORE_disconnect (GSF_dsh, GNUNET_NO);
447
GNUNET_DHT_disconnect (GSF_dht);
449
GNUNET_BLOCK_context_destroy (GSF_block_ctx);
450
GSF_block_ctx = NULL;
451
GNUNET_CONFIGURATION_destroy (block_cfg);
453
GNUNET_STATISTICS_destroy (GSF_stats, GNUNET_NO);
455
if (GNUNET_SCHEDULER_NO_TASK != cover_age_task)
457
GNUNET_SCHEDULER_cancel (cover_age_task);
458
cover_age_task = GNUNET_SCHEDULER_NO_TASK;
460
GNUNET_FS_indexing_done ();
461
GNUNET_LOAD_value_free (datastore_get_load);
462
datastore_get_load = NULL;
463
GNUNET_LOAD_value_free (GSF_rt_entry_lifetime);
464
GSF_rt_entry_lifetime = NULL;
469
* Function called for each pending request whenever a new
470
* peer connects, giving us a chance to decide about submitting
471
* the existing request to the new peer.
473
* @param cls the 'struct GSF_ConnectedPeer' of the new peer
474
* @param key query for the request
475
* @param pr handle to the pending request
476
* @return GNUNET_YES to continue to iterate
479
consider_peer_for_forwarding (void *cls, const GNUNET_HashCode * key,
480
struct GSF_PendingRequest *pr)
482
struct GSF_ConnectedPeer *cp = cls;
483
struct GNUNET_PeerIdentity pid;
485
GSF_connected_peer_get_identity_ (cp, &pid);
486
if (GNUNET_YES != GSF_pending_request_test_target_ (pr, &pid))
488
GNUNET_STATISTICS_update (GSF_stats,
489
gettext_noop ("# Loopback routes suppressed"), 1,
493
GSF_plan_add_ (cp, pr);
499
* Method called whenever a given peer connects.
501
* @param cls closure, not used
502
* @param peer peer identity this notification is about
503
* @param atsi performance information
504
* @param atsi_count number of records in 'atsi'
507
peer_connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
508
const struct GNUNET_ATS_Information *atsi,
509
unsigned int atsi_count)
511
struct GSF_ConnectedPeer *cp;
513
if (0 == memcmp (&my_id, peer, sizeof (struct GNUNET_PeerIdentity)))
515
cp = GSF_peer_connect_handler_ (peer, atsi, atsi_count);
518
GSF_iterate_pending_requests_ (&consider_peer_for_forwarding, cp);
523
* Function called after GNUNET_CORE_connect has succeeded
524
* (or failed for good). Note that the private key of the
525
* peer is intentionally not exposed here; if you need it,
526
* your process should try to read the private key file
527
* directly (which should work if you are authorized...).
530
* @param server handle to the server, NULL if we failed
531
* @param my_identity ID of this peer, NULL if we failed
534
peer_init_handler (void *cls, struct GNUNET_CORE_Handle *server,
535
const struct GNUNET_PeerIdentity *my_identity)
537
my_id = *my_identity;
542
* Process fs requests.
544
* @param server the initialized server
545
* @param c configuration to use
548
main_init (struct GNUNET_SERVER_Handle *server,
549
const struct GNUNET_CONFIGURATION_Handle *c)
551
static const struct GNUNET_CORE_MessageHandler p2p_handlers[] = {
553
GNUNET_MESSAGE_TYPE_FS_GET, 0},
555
GNUNET_MESSAGE_TYPE_FS_PUT, 0},
556
{&GSF_handle_p2p_migration_stop_,
557
GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP,
558
sizeof (struct MigrationStopMessage)},
561
static const struct GNUNET_SERVER_MessageHandler handlers[] = {
562
{&GNUNET_FS_handle_index_start, NULL,
563
GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
564
{&GNUNET_FS_handle_index_list_get, NULL,
565
GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET,
566
sizeof (struct GNUNET_MessageHeader)},
567
{&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
568
sizeof (struct UnindexMessage)},
569
{&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
575
GNUNET_CORE_connect (GSF_cfg, 1, NULL, &peer_init_handler,
576
&peer_connect_handler, &GSF_peer_disconnect_handler_,
577
NULL, GNUNET_NO, NULL, GNUNET_NO, p2p_handlers);
578
if (NULL == GSF_core)
580
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
581
_("Failed to connect to `%s' service.\n"), "core");
582
return GNUNET_SYSERR;
584
GNUNET_SERVER_disconnect_notify (server, &GSF_client_disconnect_handler_,
586
GNUNET_SERVER_add_handlers (server, handlers);
588
GNUNET_SCHEDULER_add_delayed (COVER_AGE_FREQUENCY, &age_cover_counters,
590
datastore_get_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
591
GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
598
* Process fs requests.
601
* @param server the initialized server
602
* @param cfg configuration to use
605
run (void *cls, struct GNUNET_SERVER_Handle *server,
606
const struct GNUNET_CONFIGURATION_Handle *cfg)
609
GSF_enable_randomized_delays =
610
GNUNET_CONFIGURATION_get_value_yesno (cfg, "fs", "DELAY");
611
GSF_dsh = GNUNET_DATASTORE_connect (cfg);
614
GNUNET_SCHEDULER_shutdown ();
617
GSF_rt_entry_lifetime = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_FOREVER_REL);
618
GSF_stats = GNUNET_STATISTICS_create ("fs", cfg);
619
block_cfg = GNUNET_CONFIGURATION_create ();
620
GNUNET_CONFIGURATION_set_value_string (block_cfg, "block", "PLUGINS", "fs");
621
GSF_block_ctx = GNUNET_BLOCK_context_create (block_cfg);
622
GNUNET_assert (NULL != GSF_block_ctx);
623
GSF_dht = GNUNET_DHT_connect (cfg, FS_DHT_HT_SIZE);
625
GSF_pending_request_init_ ();
626
GSF_connected_peer_init_ ();
629
if ((GNUNET_OK != GNUNET_FS_indexing_init (cfg, GSF_dsh)) ||
630
(GNUNET_OK != main_init (server, cfg)))
632
GNUNET_SCHEDULER_shutdown ();
633
shutdown_task (NULL, NULL);
640
* The main function for the fs service.
642
* @param argc number of arguments from the command line
643
* @param argv command line arguments
644
* @return 0 ok, 1 on error
647
main (int argc, char *const *argv)
650
GNUNET_SERVICE_run (argc, argv, "fs", GNUNET_SERVICE_OPTION_NONE,
651
&run, NULL)) ? 0 : 1;
654
/* end of gnunet-service-fs.c */
added
removed
src/fs/gnunet-service-fs.c
