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
  39 /**
  40  * Should we introduce random latency in processing?  Required for proper
  41  * implementation of GAP, but can be disabled for performance evaluation of
  42  * the basic routing algorithm.
  43  *
  44  * Note that with delays enabled, performance can be significantly lower
  45  * (several orders of magnitude in 2-peer test runs); if you want to
  46  * measure throughput of other components, set this to NO.  Also, you
  47  * might want to consider changing 'RETRY_PROBABILITY_INV' to 1 for
  48  * a rather wasteful mode of operation (that might still get the highest
  49  * throughput overall).
  50  *
  51  * Performance measurements (for 50 MB file, 2 peers):
  52  *
  53  * - Without delays: 3300 kb/s
  54  * - With    delays:  101 kb/s
  55  */
  56 #define SUPPORT_DELAYS GNUNET_NO
  57
  58
  59 /**
  60  * At what frequency should our datastore load decrease
  61  * automatically (since if we don't use it, clearly the
  62  * load must be going down).
  63  */
  64 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
  65
  66
  67
  68 /**
  69  * A connected peer.
  70  */
  71 struct GSF_ConnectedPeer;
  72
  73 /**
  74  * An active request.
  75  */
  76 struct GSF_PendingRequest;
  77
  78 /**
  79  * A local client.
  80  */
  81 struct GSF_LocalClient;
  82
  83 /**
  84  * Information kept per plan per request ('pe' module).
  85  */
  86 struct GSF_RequestPlan;
  87
  88 /**
  89  * Our connection to the datastore.
  90  */
  91 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
  92
  93 /**
  94  * Our configuration.
  95  */
  96 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
  97
  98 /**
  99  * Handle for reporting statistics.
 100  */
 101 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
 102
 103 /**
 104  * Pointer to handle to the core service (points to NULL until we've
 105  * connected to it).
 106  */
 107 extern struct GNUNET_CORE_Handle *GSF_core;
 108
 109 /**
 110  * Handle for DHT operations.
 111  */
 112 extern struct GNUNET_DHT_Handle *GSF_dht;
 113
 114 /**
 115  * How long do requests typically stay in the routing table?
 116  */
 117 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 118
 119 /**
 120  * Typical priorities we're seeing from other peers right now.  Since
 121  * most priorities will be zero, this value is the weighted average of
 122  * non-zero priorities seen "recently".  In order to ensure that new
 123  * values do not dramatically change the ratio, values are first
 124  * "capped" to a reasonable range (+N of the current value) and then
 125  * averaged into the existing value by a ratio of 1:N.  Hence
 126  * receiving the largest possible priority can still only raise our
 127  * "current_priorities" by at most 1.
 128  */
 129 extern double GSF_current_priorities;
 130
 131 /**
 132  * How many query messages have we received 'recently' that
 133  * have not yet been claimed as cover traffic?
 134  */
 135 extern unsigned int GSF_cover_query_count;
 136
 137 /**
 138  * How many content messages have we received 'recently' that
 139  * have not yet been claimed as cover traffic?
 140  */
 141 extern unsigned int GSF_cover_content_count;
 142
 143 /**
 144  * Our block context.
 145  */
 146 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
 147
 148
 149 /**
 150  * Test if the DATABASE (GET) load on this peer is too high
 151  * to even consider processing the query at
 152  * all.
 153  *
 154  * @return GNUNET_YES if the load is too high to do anything (load high)
 155  *         GNUNET_NO to process normally (load normal)
 156  *         GNUNET_SYSERR to process for free (load low)
 157  */
 158 int
 159 GSF_test_get_load_too_high_ (uint32_t priority);
 160
 161
 162 /**
 163  * We've just now completed a datastore request.  Update our
 164  * datastore load calculations.
 165  *
 166  * @param start time when the datastore request was issued
 167  */
 168 void
 169 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 170
 171
 172
 173 #endif
 174 /* end of gnunet-service-fs.h */