2 This file is part of GNUnet.
3 (C) 2009, 2010 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.h
23 * @brief shared data structures of gnunet-service-fs.c
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_H
27 #define GNUNET_SERVICE_FS_H
29 #include "gnunet_util_lib.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet_transport_service.h"
32 #include "gnunet_core_service.h"
33 #include "gnunet_block_lib.h"
36 #define DEBUG_FS GNUNET_YES
38 #define DEBUG_FS_CLIENT GNUNET_EXTRA_LOGGING
42 * Should we introduce random latency in processing? Required for proper
43 * implementation of GAP, but can be disabled for performance evaluation of
44 * the basic routing algorithm.
46 * Note that with delays enabled, performance can be significantly lower
47 * (several orders of magnitude in 2-peer test runs); if you want to
48 * measure throughput of other components, set this to NO. Also, you
49 * might want to consider changing 'RETRY_PROBABILITY_INV' to 1 for
50 * a rather wasteful mode of operation (that might still get the highest
51 * throughput overall).
53 * Performance measurements (for 50 MB file, 2 peers):
55 * - Without delays: 3300 kb/s
56 * - With delays: 101 kb/s
58 #define SUPPORT_DELAYS GNUNET_NO
62 * At what frequency should our datastore load decrease
63 * automatically (since if we don't use it, clearly the
64 * load must be going down).
66 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
73 struct GSF_ConnectedPeer;
78 struct GSF_PendingRequest;
83 struct GSF_LocalClient;
86 * Information kept per plan per request ('pe' module).
88 struct GSF_RequestPlan;
91 * DLL of request plans a particular pending request is
94 struct GSF_RequestPlanReference;
97 * Our connection to the datastore.
99 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
104 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
107 * Handle for reporting statistics.
109 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
112 * Pointer to handle to the core service (points to NULL until we've
115 extern struct GNUNET_CORE_Handle *GSF_core;
118 * Handle for DHT operations.
120 extern struct GNUNET_DHT_Handle *GSF_dht;
123 * How long do requests typically stay in the routing table?
125 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
128 * Running average of the observed latency to other peers (round trip).
130 extern struct GNUNET_TIME_Relative GSF_avg_latency;
133 * Typical priorities we're seeing from other peers right now. Since
134 * most priorities will be zero, this value is the weighted average of
135 * non-zero priorities seen "recently". In order to ensure that new
136 * values do not dramatically change the ratio, values are first
137 * "capped" to a reasonable range (+N of the current value) and then
138 * averaged into the existing value by a ratio of 1:N. Hence
139 * receiving the largest possible priority can still only raise our
140 * "current_priorities" by at most 1.
142 extern double GSF_current_priorities;
145 * How many query messages have we received 'recently' that
146 * have not yet been claimed as cover traffic?
148 extern unsigned int GSF_cover_query_count;
151 * How many content messages have we received 'recently' that
152 * have not yet been claimed as cover traffic?
154 extern unsigned int GSF_cover_content_count;
159 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
162 * Are we introducing randomized delays for better anonymity?
164 extern int GSF_enable_randomized_delays;
167 * Test if the DATABASE (GET) load on this peer is too high
168 * to even consider processing the query at
171 * @return GNUNET_YES if the load is too high to do anything (load high)
172 * GNUNET_NO to process normally (load normal)
173 * GNUNET_SYSERR to process for free (load low)
176 GSF_test_get_load_too_high_ (uint32_t priority);
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);
191 /* end of gnunet-service-fs.h */