src/fs/gnunet-service-fs.h

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