123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- /*
- This file is part of GNUnet.
- (C) 2009, 2010 Christian Grothoff (and other contributing authors)
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
- */
- /**
- * @file fs/gnunet-service-fs.h
- * @brief shared data structures of gnunet-service-fs.c
- * @author Christian Grothoff
- */
- #ifndef GNUNET_SERVICE_FS_H
- #define GNUNET_SERVICE_FS_H
- #include "gnunet_util_lib.h"
- #include "gnunet_statistics_service.h"
- #include "gnunet_transport_service.h"
- #include "gnunet_core_service.h"
- #include "gnunet_block_lib.h"
- #include "gnunet_ats_service.h"
- #include "fs.h"
- /**
- * By which amount do we decrement the TTL for simple forwarding /
- * indirection of the query; in milli-seconds. Set somewhat in
- * accordance to your network latency (above the time it'll take you
- * to send a packet and get a reply).
- */
- #define TTL_DECREMENT 5000
- /**
- * At what frequency should our datastore load decrease
- * automatically (since if we don't use it, clearly the
- * load must be going down).
- */
- #define DATASTORE_LOAD_AUTODECLINE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
- /**
- * Only the (mandatory) query is included.
- */
- #define GET_MESSAGE_BIT_QUERY_ONLY 0
- /**
- * The peer identity of a peer waiting for the
- * reply is included (used if the response
- * should be transmitted to someone other than
- * the sender of the GET).
- */
- #define GET_MESSAGE_BIT_RETURN_TO 1
- /**
- * The peer identity of a peer that had claimed to have the content
- * previously is included (can be used if responder-anonymity is not
- * desired; note that the precursor presumably lacked a direct
- * connection to the specified peer; still, the receiver is in no way
- * required to limit forwarding only to the specified peer, it should
- * only prefer it somewhat if possible).
- */
- #define GET_MESSAGE_BIT_TRANSMIT_TO 4
- GNUNET_NETWORK_STRUCT_BEGIN
- /**
- * Message sent between peers asking for FS-content.
- */
- struct GetMessage
- {
- /**
- * Message type will be #GNUNET_MESSAGE_TYPE_FS_GET.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Type of the query (block type).
- */
- uint32_t type GNUNET_PACKED;
- /**
- * How important is this request (network byte order)
- */
- uint32_t priority GNUNET_PACKED;
- /**
- * Relative time to live in MILLISECONDS (network byte order)
- */
- int32_t ttl GNUNET_PACKED;
- /**
- * The content hash should be mutated using this value
- * before checking against the bloomfilter (used to
- * get many different filters for the same hash codes).
- * The number should be in big-endian format when used
- * for mingling.
- */
- uint32_t filter_mutator GNUNET_PACKED;
- /**
- * Which of the optional hash codes are present at the end of the
- * message? See GET_MESSAGE_BIT_xx constants. For each bit that is
- * set, an additional `struct GNUNET_HashCode` with the respective content
- * (in order of the bits) will be appended to the end of the GET
- * message.
- */
- uint32_t hash_bitmap GNUNET_PACKED;
- /**
- * Hashcodes of the file(s) we're looking for.
- * Details depend on the query type.
- */
- struct GNUNET_HashCode query;
- /* this is followed by PeerIdentities as specified in the "hash_bitmap";
- * after that, an optional bloomfilter (with bits set for replies
- * that should be suppressed) can be present */
- };
- /**
- * Message send by a peer that wants to be excluded
- * from migration for a while.
- */
- struct MigrationStopMessage
- {
- /**
- * Message type will be
- * GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero.
- */
- uint32_t reserved GNUNET_PACKED;
- /**
- * How long should the block last?
- */
- struct GNUNET_TIME_RelativeNBO duration;
- };
- GNUNET_NETWORK_STRUCT_END
- /**
- * A connected peer.
- */
- struct GSF_ConnectedPeer;
- /**
- * An active request.
- */
- struct GSF_PendingRequest;
- /**
- * A local client.
- */
- struct GSF_LocalClient;
- /**
- * Information kept per plan per request ('pe' module).
- */
- struct GSF_RequestPlan;
- /**
- * Bijection between request plans and pending requests.
- */
- struct GSF_PendingRequestPlanBijection;
- /**
- * Our connection to the datastore.
- */
- extern struct GNUNET_DATASTORE_Handle *GSF_dsh;
- /**
- * Our configuration.
- */
- extern const struct GNUNET_CONFIGURATION_Handle *GSF_cfg;
- /**
- * Handle for reporting statistics.
- */
- extern struct GNUNET_STATISTICS_Handle *GSF_stats;
- /**
- * Pointer to handle to the core service (points to NULL until we've
- * connected to it).
- */
- extern struct GNUNET_CORE_Handle *GSF_core;
- /**
- * Handle for DHT operations.
- */
- extern struct GNUNET_DHT_Handle *GSF_dht;
- /**
- * How long do requests typically stay in the routing table?
- */
- extern struct GNUNET_LOAD_Value *GSF_rt_entry_lifetime;
- /**
- * Running average of the observed latency to other peers (round trip).
- */
- extern struct GNUNET_TIME_Relative GSF_avg_latency;
- /**
- * Handle to ATS service.
- */
- extern struct GNUNET_ATS_PerformanceHandle *GSF_ats;
- /**
- * Typical priorities we're seeing from other peers right now. Since
- * most priorities will be zero, this value is the weighted average of
- * non-zero priorities seen "recently". In order to ensure that new
- * values do not dramatically change the ratio, values are first
- * "capped" to a reasonable range (+N of the current value) and then
- * averaged into the existing value by a ratio of 1:N. Hence
- * receiving the largest possible priority can still only raise our
- * "current_priorities" by at most 1.
- */
- extern double GSF_current_priorities;
- /**
- * How many query messages have we received 'recently' that
- * have not yet been claimed as cover traffic?
- */
- extern unsigned int GSF_cover_query_count;
- /**
- * How many content messages have we received 'recently' that
- * have not yet been claimed as cover traffic?
- */
- extern unsigned int GSF_cover_content_count;
- /**
- * Our block context.
- */
- extern struct GNUNET_BLOCK_Context *GSF_block_ctx;
- /**
- * Are we introducing randomized delays for better anonymity?
- */
- extern int GSF_enable_randomized_delays;
- /**
- * Size of the datastore queue we assume for common requests.
- */
- extern unsigned int GSF_datastore_queue_size;
- /**
- * Test if the DATABASE (GET) load on this peer is too high
- * to even consider processing the query at
- * all.
- *
- * @return GNUNET_YES if the load is too high to do anything (load high)
- * GNUNET_NO to process normally (load normal)
- * GNUNET_SYSERR to process for free (load low)
- */
- int
- GSF_test_get_load_too_high_ (uint32_t priority);
- /**
- * We've just now completed a datastore request. Update our
- * datastore load calculations.
- *
- * @param start time when the datastore request was issued
- */
- void
- GSF_update_datastore_delay_ (struct GNUNET_TIME_Absolute start);
- #endif
- /* end of gnunet-service-fs.h */
|