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 #define DEBUG_FS GNUNET_YES
  37
  38 #define DEBUG_FS_CLIENT GNUNET_EXTRA_LOGGING
  39
  40
  41 /**
  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.
  45  *
  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).
  52  *
  53  * Performance measurements (for 50 MB file, 2 peers):
  54  *
  55  * - Without delays: 3300 kb/s
  56  * - With    delays:  101 kb/s
  57  */
  58 #define SUPPORT_DELAYS GNUNET_NO
  59
  60
  61 /**
  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).
  65  */
  66 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
  67
  68
  69
  70 /**
  71  * A connected peer.
  72  */
  73 struct GSF_ConnectedPeer;
  74
  75 /**
  76  * An active request.
  77  */
  78 struct GSF_PendingRequest;
  79
  80 /**
  81  * A local client.
  82  */
  83 struct GSF_LocalClient;
  84
  85 /**
  86  * Information kept per plan per request ('pe' module).
  87  */
  88 struct GSF_RequestPlan;
  89
  90 /**
  91  * DLL of request plans a particular pending request is
  92  * involved with.
  93  */
  94 struct GSF_RequestPlanReference;
  95
  96 /**
  97  * Our connection to the datastore.
  98  */
  99 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
 100
 101 /**
 102  * Our configuration.
 103  */
 104 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
 105
 106 /**
 107  * Handle for reporting statistics.
 108  */
 109 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
 110
 111 /**
 112  * Pointer to handle to the core service (points to NULL until we've
 113  * connected to it).
 114  */
 115 extern struct GNUNET_CORE_Handle *GSF_core;
 116
 117 /**
 118  * Handle for DHT operations.
 119  */
 120 extern struct GNUNET_DHT_Handle *GSF_dht;
 121
 122 /**
 123  * How long do requests typically stay in the routing table?
 124  */
 125 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 126
 127 /**
 128  * Running average of the observed latency to other peers (round trip).
 129  */
 130 extern struct GNUNET_TIME_Relative GSF_avg_latency;
 131
 132 /**
 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.
 141  */
 142 extern double GSF_current_priorities;
 143
 144 /**
 145  * How many query messages have we received 'recently' that
 146  * have not yet been claimed as cover traffic?
 147  */
 148 extern unsigned int GSF_cover_query_count;
 149
 150 /**
 151  * How many content messages have we received 'recently' that
 152  * have not yet been claimed as cover traffic?
 153  */
 154 extern unsigned int GSF_cover_content_count;
 155
 156 /**
 157  * Our block context.
 158  */
 159 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
 160
 161 /**
 162  * Are we introducing randomized delays for better anonymity?
 163  */
 164 extern int GSF_enable_randomized_delays;
 165
 166 /**
 167  * Test if the DATABASE (GET) load on this peer is too high
 168  * to even consider processing the query at
 169  * all.
 170  *
 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)
 174  */
 175 int
 176 GSF_test_get_load_too_high_ (uint32_t priority);
 177
 178
 179 /**
 180  * We've just now completed a datastore request.  Update our
 181  * datastore load calculations.
 182  *
 183  * @param start time when the datastore request was issued
 184  */
 185 void
 186 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 187
 188
 189
 190 #endif
 191 /* end of gnunet-service-fs.h */