src/fs/gnunet-service-fs.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @file fs/gnunet-service-fs.h
  21  * @brief shared data structures of gnunet-service-fs.c
  22  * @author Christian Grothoff
  23  */
  24 #ifndef GNUNET_SERVICE_FS_H
  25 #define GNUNET_SERVICE_FS_H
  26
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet_core_service.h"
  31 #include "gnunet_block_lib.h"
  32 #include "gnunet_ats_service.h"
  33 #include "fs.h"
  34
  35
  36 /**
  37  * By which amount do we decrement the TTL for simple forwarding /
  38  * indirection of the query; in milli-seconds.  Set somewhat in
  39  * accordance to your network latency (above the time it'll take you
  40  * to send a packet and get a reply).
  41  */
  42 #define TTL_DECREMENT 5000
  43
  44 /**
  45  * At what frequency should our datastore load decrease
  46  * automatically (since if we don't use it, clearly the
  47  * load must be going down).
  48  */
  49 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
  50
  51 /**
  52  * Only the (mandatory) query is included.
  53  */
  54 #define GET_MESSAGE_BIT_QUERY_ONLY 0
  55
  56 /**
  57  * The peer identity of a peer waiting for the
  58  * reply is included (used if the response
  59  * should be transmitted to someone other than
  60  * the sender of the GET).
  61  */
  62 #define GET_MESSAGE_BIT_RETURN_TO 1
  63
  64 /**
  65  * The peer identity of a peer that had claimed to have the content
  66  * previously is included (can be used if responder-anonymity is not
  67  * desired; note that the precursor presumably lacked a direct
  68  * connection to the specified peer; still, the receiver is in no way
  69  * required to limit forwarding only to the specified peer, it should
  70  * only prefer it somewhat if possible).
  71  */
  72 #define GET_MESSAGE_BIT_TRANSMIT_TO 4
  73
  74
  75 GNUNET_NETWORK_STRUCT_BEGIN
  76
  77 /**
  78  * Message sent between peers asking for FS-content.
  79  */
  80 struct GetMessage
  81 {
  82
  83   /**
  84    * Message type will be #GNUNET_MESSAGE_TYPE_FS_GET.
  85    */
  86   struct GNUNET_MessageHeader header;
  87
  88   /**
  89    * Type of the query (block type).
  90    */
  91   uint32_t type GNUNET_PACKED;
  92
  93   /**
  94    * How important is this request (network byte order)
  95    */
  96   uint32_t priority GNUNET_PACKED;
  97
  98   /**
  99    * Relative time to live in MILLISECONDS (network byte order)
 100    */
 101   int32_t ttl GNUNET_PACKED;
 102
 103   /**
 104    * The content hash should be mutated using this value
 105    * before checking against the bloomfilter (used to
 106    * get many different filters for the same hash codes).
 107    * The number should be in big-endian format when used
 108    * for mingling.
 109    */
 110   uint32_t filter_mutator GNUNET_PACKED;
 111
 112   /**
 113    * Which of the optional hash codes are present at the end of the
 114    * message?  See GET_MESSAGE_BIT_xx constants.  For each bit that is
 115    * set, an additional `struct GNUNET_HashCode` with the respective content
 116    * (in order of the bits) will be appended to the end of the GET
 117    * message.
 118    */
 119   uint32_t hash_bitmap GNUNET_PACKED;
 120
 121   /**
 122    * Hashcodes of the file(s) we're looking for.
 123    * Details depend on the query type.
 124    */
 125   struct GNUNET_HashCode query;
 126
 127   /* this is followed by PeerIdentities as specified in the "hash_bitmap";
 128    * after that, an optional bloomfilter (with bits set for replies
 129    * that should be suppressed) can be present */
 130 };
 131
 132
 133 /**
 134  * Message send by a peer that wants to be excluded
 135  * from migration for a while.
 136  */
 137 struct MigrationStopMessage
 138 {
 139   /**
 140    * Message type will be
 141    * GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP.
 142    */
 143   struct GNUNET_MessageHeader header;
 144
 145   /**
 146    * Always zero.
 147    */
 148   uint32_t reserved GNUNET_PACKED;
 149
 150   /**
 151    * How long should the block last?
 152    */
 153   struct GNUNET_TIME_RelativeNBO duration;
 154
 155 };
 156 GNUNET_NETWORK_STRUCT_END
 157
 158 /**
 159  * A connected peer.
 160  */
 161 struct GSF_ConnectedPeer;
 162
 163 /**
 164  * An active request.
 165  */
 166 struct GSF_PendingRequest;
 167
 168 /**
 169  * A local client.
 170  */
 171 struct GSF_LocalClient;
 172
 173 /**
 174  * Information kept per plan per request ('pe' module).
 175  */
 176 struct GSF_RequestPlan;
 177
 178 /**
 179  * Bijection between request plans and pending requests.
 180  */
 181 struct GSF_PendingRequestPlanBijection;
 182
 183 /**
 184  * Our connection to the datastore.
 185  */
 186 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
 187
 188 /**
 189  * Our configuration.
 190  */
 191 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
 192
 193 /**
 194  * Handle for reporting statistics.
 195  */
 196 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
 197
 198 /**
 199  * Pointer to handle to the core service (points to NULL until we've
 200  * connected to it).
 201  */
 202 extern struct GNUNET_CORE_Handle *GSF_core;
 203
 204 /**
 205  * Handle for DHT operations.
 206  */
 207 extern struct GNUNET_DHT_Handle *GSF_dht;
 208
 209 /**
 210  * How long do requests typically stay in the routing table?
 211  */
 212 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 213
 214 /**
 215  * Running average of the observed latency to other peers (round trip).
 216  */
 217 extern struct GNUNET_TIME_Relative GSF_avg_latency;
 218
 219 /**
 220  * Handle to ATS service.
 221  */
 222 extern struct GNUNET_ATS_PerformanceHandle *GSF_ats;
 223
 224 /**
 225  * Identity of this peer.
 226  */
 227 extern struct GNUNET_PeerIdentity GSF_my_id;
 228
 229 /**
 230  * Typical priorities we're seeing from other peers right now.  Since
 231  * most priorities will be zero, this value is the weighted average of
 232  * non-zero priorities seen "recently".  In order to ensure that new
 233  * values do not dramatically change the ratio, values are first
 234  * "capped" to a reasonable range (+N of the current value) and then
 235  * averaged into the existing value by a ratio of 1:N.  Hence
 236  * receiving the largest possible priority can still only raise our
 237  * "current_priorities" by at most 1.
 238  */
 239 extern double GSF_current_priorities;
 240
 241 /**
 242  * How many query messages have we received 'recently' that
 243  * have not yet been claimed as cover traffic?
 244  */
 245 extern unsigned int GSF_cover_query_count;
 246
 247 /**
 248  * How many content messages have we received 'recently' that
 249  * have not yet been claimed as cover traffic?
 250  */
 251 extern unsigned int GSF_cover_content_count;
 252
 253 /**
 254  * Our block context.
 255  */
 256 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
 257
 258 /**
 259  * Are we introducing randomized delays for better anonymity?
 260  */
 261 extern int GSF_enable_randomized_delays;
 262
 263 /**
 264  * Size of the datastore queue we assume for common requests.
 265  */
 266 extern unsigned int GSF_datastore_queue_size;
 267
 268
 269 /**
 270  * Function to be called after we're done processing
 271  * replies from the local lookup.  If the result status
 272  * code indicates that there may be more replies, plan
 273  * forwarding the request.
 274  *
 275  * @param cls closure (NULL)
 276  * @param pr the pending request we were processing
 277  * @param result final datastore lookup result
 278  */
 279 void
 280 GSF_consider_forwarding (void *cls,
 281                          struct GSF_PendingRequest *pr,
 282                          enum GNUNET_BLOCK_EvaluationResult result);
 283
 284
 285 /**
 286  * Test if the DATABASE (GET) load on this peer is too high
 287  * to even consider processing the query at
 288  * all.
 289  *
 290  * @return #GNUNET_YES if the load is too high to do anything (load high)
 291  *         #GNUNET_NO to process normally (load normal)
 292  *         #GNUNET_SYSERR to process for free (load low)
 293  */
 294 int
 295 GSF_test_get_load_too_high_ (uint32_t priority);
 296
 297
 298 /**
 299  * We've just now completed a datastore request.  Update our
 300  * datastore load calculations.
 301  *
 302  * @param start time when the datastore request was issued
 303  */
 304 void
 305 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 306
 307
 308 #endif
 309 /* end of gnunet-service-fs.h */