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  * By which amount do we decrement the TTL for simple forwarding /
  42  * indirection of the query; in milli-seconds.  Set somewhat in
  43  * accordance to your network latency (above the time it'll take you
  44  * to send a packet and get a reply).
  45  */
  46 #define TTL_DECREMENT 5000
  47
  48 /**
  49  * At what frequency should our datastore load decrease
  50  * automatically (since if we don't use it, clearly the
  51  * load must be going down).
  52  */
  53 #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
  54
  55
  56
  57 /**
  58  * A connected peer.
  59  */
  60 struct GSF_ConnectedPeer;
  61
  62 /**
  63  * An active request.
  64  */
  65 struct GSF_PendingRequest;
  66
  67 /**
  68  * A local client.
  69  */
  70 struct GSF_LocalClient;
  71
  72 /**
  73  * Information kept per plan per request ('pe' module).
  74  */
  75 struct GSF_RequestPlan;
  76
  77 /**
  78  * DLL of request plans a particular pending request is
  79  * involved with.
  80  */
  81 struct GSF_RequestPlanReference;
  82
  83 /**
  84  * Our connection to the datastore.
  85  */
  86 extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
  87
  88 /**
  89  * Our configuration.
  90  */
  91 extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
  92
  93 /**
  94  * Handle for reporting statistics.
  95  */
  96 extern struct GNUNET_STATISTICS_Handle *GSF_stats;
  97
  98 /**
  99  * Pointer to handle to the core service (points to NULL until we've
 100  * connected to it).
 101  */
 102 extern struct GNUNET_CORE_Handle *GSF_core;
 103
 104 /**
 105  * Handle for DHT operations.
 106  */
 107 extern struct GNUNET_DHT_Handle *GSF_dht;
 108
 109 /**
 110  * How long do requests typically stay in the routing table?
 111  */
 112 extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
 113
 114 /**
 115  * Running average of the observed latency to other peers (round trip).
 116  */
 117 extern struct GNUNET_TIME_Relative GSF_avg_latency;
 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  * Are we introducing randomized delays for better anonymity?
 150  */
 151 extern int GSF_enable_randomized_delays;
 152
 153 /**
 154  * Test if the DATABASE (GET) load on this peer is too high
 155  * to even consider processing the query at
 156  * all.
 157  *
 158  * @return GNUNET_YES if the load is too high to do anything (load high)
 159  *         GNUNET_NO to process normally (load normal)
 160  *         GNUNET_SYSERR to process for free (load low)
 161  */
 162 int
 163 GSF_test_get_load_too_high_ (uint32_t priority);
 164
 165
 166 /**
 167  * We've just now completed a datastore request.  Update our
 168  * datastore load calculations.
 169  *
 170  * @param start time when the datastore request was issued
 171  */
 172 void
 173 GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
 174
 175
 176
 177 #endif
 178 /* end of gnunet-service-fs.h */