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