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
41 * By which amount do we decrement the TTL for simple forwarding /
42 * indirection of the query; in milli-seconds. Set somewhat in
43 * accordance to your network latency (above the time it'll take you
44 * to send a packet and get a reply).
46 #define TTL_DECREMENT 5000
49 * At what frequency should our datastore load decrease
50 * automatically (since if we don't use it, clearly the
51 * load must be going down).
53 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
56 * Only the (mandatory) query is included.
58 #define GET_MESSAGE_BIT_QUERY_ONLY 0
61 * The peer identity of a peer waiting for the
62 * reply is included (used if the response
63 * should be transmitted to someone other than
64 * the sender of the GET).
66 #define GET_MESSAGE_BIT_RETURN_TO 1
69 * The hash of the public key of the target
70 * namespace is included (for SKS queries).
72 #define GET_MESSAGE_BIT_SKS_NAMESPACE 2
75 * The peer identity of a peer that had claimed to have the content
76 * previously is included (can be used if responder-anonymity is not
77 * desired; note that the precursor presumably lacked a direct
78 * connection to the specified peer; still, the receiver is in no way
79 * required to limit forwarding only to the specified peer, it should
80 * only prefer it somewhat if possible).
82 #define GET_MESSAGE_BIT_TRANSMIT_TO 4
85 GNUNET_NETWORK_STRUCT_BEGIN
88 * Message sent between peers asking for FS-content.
94 * Message type will be GNUNET_MESSAGE_TYPE_FS_GET.
96 struct GNUNET_MessageHeader header;
99 * Type of the query (block type).
101 uint32_t type GNUNET_PACKED;
104 * How important is this request (network byte order)
106 uint32_t priority GNUNET_PACKED;
109 * Relative time to live in MILLISECONDS (network byte order)
111 int32_t ttl GNUNET_PACKED;
114 * The content hash should be mutated using this value
115 * before checking against the bloomfilter (used to
116 * get many different filters for the same hash codes).
117 * The number should be in big-endian format when used
120 uint32_t filter_mutator GNUNET_PACKED;
123 * Which of the optional hash codes are present at the end of the
124 * message? See GET_MESSAGE_BIT_xx constants. For each bit that is
125 * set, an additional GNUNET_HashCode with the respective content
126 * (in order of the bits) will be appended to the end of the GET
129 uint32_t hash_bitmap GNUNET_PACKED;
132 * Hashcodes of the file(s) we're looking for.
133 * Details depend on the query type.
135 GNUNET_HashCode query GNUNET_PACKED;
137 /* this is followed by hash codes as specified in the "hash_bitmap";
138 * after that, an optional bloomfilter (with bits set for replies
139 * that should be suppressed) can be present */
144 * Message send by a peer that wants to be excluded
145 * from migration for a while.
147 struct MigrationStopMessage
150 * Message type will be
151 * GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP.
153 struct GNUNET_MessageHeader header;
158 uint32_t reserved GNUNET_PACKED;
161 * How long should the block last?
163 struct GNUNET_TIME_RelativeNBO duration;
166 GNUNET_NETWORK_STRUCT_END
171 struct GSF_ConnectedPeer;
176 struct GSF_PendingRequest;
181 struct GSF_LocalClient;
184 * Information kept per plan per request ('pe' module).
186 struct GSF_RequestPlan;
189 * DLL of request plans a particular pending request is
192 struct GSF_RequestPlanReference;
195 * Our connection to the datastore.
197 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
202 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
205 * Handle for reporting statistics.
207 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
210 * Pointer to handle to the core service (points to NULL until we've
213 extern struct GNUNET_CORE_Handle *GSF_core;
216 * Handle for DHT operations.
218 extern struct GNUNET_DHT_Handle *GSF_dht;
221 * How long do requests typically stay in the routing table?
223 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
226 * Running average of the observed latency to other peers (round trip).
228 extern struct GNUNET_TIME_Relative GSF_avg_latency;
231 * Typical priorities we're seeing from other peers right now. Since
232 * most priorities will be zero, this value is the weighted average of
233 * non-zero priorities seen "recently". In order to ensure that new
234 * values do not dramatically change the ratio, values are first
235 * "capped" to a reasonable range (+N of the current value) and then
236 * averaged into the existing value by a ratio of 1:N. Hence
237 * receiving the largest possible priority can still only raise our
238 * "current_priorities" by at most 1.
240 extern double GSF_current_priorities;
243 * How many query messages have we received 'recently' that
244 * have not yet been claimed as cover traffic?
246 extern unsigned int GSF_cover_query_count;
249 * How many content messages have we received 'recently' that
250 * have not yet been claimed as cover traffic?
252 extern unsigned int GSF_cover_content_count;
257 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
260 * Are we introducing randomized delays for better anonymity?
262 extern int GSF_enable_randomized_delays;
265 * Test if the DATABASE (GET) load on this peer is too high
266 * to even consider processing the query at
269 * @return GNUNET_YES if the load is too high to do anything (load high)
270 * GNUNET_NO to process normally (load normal)
271 * GNUNET_SYSERR to process for free (load low)
274 GSF_test_get_load_too_high_ (uint32_t priority);
278 * We've just now completed a datastore request. Update our
279 * datastore load calculations.
281 * @param start time when the datastore request was issued
284 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
289 /* end of gnunet-service-fs.h */