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 /**
  61  * A connected peer.
  62  */
  63 struct GSF_ConnectedPeer;
  64
  65 /**
  66  * An active request.
  67  */
  68 struct GSF_PendingRequest;
  69
  70 /**
  71  * A local client.
  72  */
  73 struct GSF_LocalClient;
  74
  75 /**
  76  * Information kept per plan per request ('pe' module).
  77  */
  78 struct GSF_RequestPlan;
  79
  80 /**
  81  * Our connection to the datastore.
  82  */
  83 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
  84
  85 /**
  86  * Our configuration.
  87  */
  88 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
  89
  90 /**
  91  * Handle for reporting statistics.
  92  */
  93 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
  94
  95 /**
  96  * Pointer to handle to the core service (points to NULL until we've
  97  * connected to it).
  98  */
  99 extern struct GNUNET_CORE_Handle *GSF_core;
 100
 101 /**
 102  * Handle for DHT operations.
 103  */
 104 extern struct GNUNET_DHT_Handle *GSF_dht;
 105
 106 /**
 107  * How long do requests typically stay in the routing table?
 108  */
 109 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 110
 111 /**
 112  * Typical priorities we're seeing from other peers right now.  Since
 113  * most priorities will be zero, this value is the weighted average of
 114  * non-zero priorities seen "recently".  In order to ensure that new
 115  * values do not dramatically change the ratio, values are first
 116  * "capped" to a reasonable range (+N of the current value) and then
 117  * averaged into the existing value by a ratio of 1:N.  Hence
 118  * receiving the largest possible priority can still only raise our
 119  * "current_priorities" by at most 1.
 120  */
 121 extern double GSF_current_priorities;
 122
 123 /**
 124  * How many query messages have we received 'recently' that
 125  * have not yet been claimed as cover traffic?
 126  */
 127 extern unsigned int GSF_cover_query_count;
 128
 129 /**
 130  * How many content messages have we received 'recently' that
 131  * have not yet been claimed as cover traffic?
 132  */
 133 extern unsigned int GSF_cover_content_count;
 134
 135 /**
 136  * Our block context.
 137  */
 138 extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
 139
 140
 141 /**
 142  * Test if the DATABASE (GET) load on this peer is too high
 143  * to even consider processing the query at
 144  * all.
 145  *
 146  * @return GNUNET_YES if the load is too high to do anything (load high)
 147  *         GNUNET_NO to process normally (load normal)
 148  *         GNUNET_SYSERR to process for free (load low)
 149  */
 150 int
 151 GSF_test_get_load_too_high_ (uint32_t priority);
 152
 153
 154 /**
 155  * We've just now completed a datastore request.  Update our
 156  * datastore load calculations.
 157  *
 158  * @param start time when the datastore request was issued
 159  */
 160 void
 161 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 162
 163
 164
 165 #endif
 166 /* end of gnunet-service-fs.h */