#ifndef FS_H
#define FS_H
+#include "gnunet_constants.h"
#include "gnunet_datastore_service.h"
#include "gnunet_fs_service.h"
*/
#define HASHING_BLOCKSIZE (1024 * 1024)
+/**
+ * Number of bits we set per entry in the bloomfilter.
+ * Do not change!
+ */
+#define BLOOMFILTER_K 16
+
+/**
+ * By how much (in ms) do we decrement the TTL
+ * at each hop?
+ */
+#define TTL_DECREMENT 5000
+
+/**
+ * How long are we willing to wait for the datastore to be ready to
+ * process a request for a query without priority?
+ */
+#define BASIC_DATASTORE_REQUEST_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
+
+
+/**
+ * How long are we willing to wait for the core to be ready to
+ * transmit a reply to the target peer (if we can not transmit
+ * until then, we will discard the reply).
+ */
+#define ACCEPTABLE_REPLY_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
+
+
+/**
+ * Bandwidth value of an (effectively) 0-priority query.
+ */
+#define QUERY_BANDWIDTH_VALUE 0.001
+
+/**
+ * Bandwidth value of a 0-priority content (must be
+ * fairly high compared to query since content is
+ * typically significantly larger -- and more valueable
+ * since it can take many queries to get one piece of
+ * content).
+ */
+#define CONTENT_BANDWIDTH_VALUE 0.8
+
+/**
+ * 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
+
+/**
+ * Until which load do we consider the peer idle and do not
+ * charge at all? (should be larger than GNUNET_IDLE_LOAD_THRESHOLD used
+ * by the rest of the code)!
+ */
+#define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
+
+
/**
* @brief content hash key
/**
* Desired anonymity level.
*/
- unsigned int anonymity;
+ uint32_t anonymity;
/**
* Desired priority (for keeping the content in the DB).
*/
- unsigned int priority;
+ uint32_t priority;
};
*/
unsigned int active_probes;
+ /**
+ * General flags.
+ */
+ enum GNUNET_FS_Flags flags;
+
};
*/
char *nuid;
- /**
- * ID of the task performing the upload. NO_TASK
- * if the upload has completed.
- */
- GNUNET_SCHEDULER_TaskIdentifier upload_task;
-
/**
* Our own client handle for the FS service;
* only briefly used when we start to index a
*/
struct GNUNET_CLIENT_Connection *client;
+ /**
+ * Current position in the file-tree for the
+ * upload.
+ */
+ struct GNUNET_FS_FileInformation *fi_pos;
+
+ /**
+ * Connection to the datastore service.
+ */
+ struct GNUNET_DATASTORE_Handle *dsh;
+
+ /**
+ * ID of the task performing the upload. NO_TASK
+ * if the upload has completed.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier upload_task;
+
/**
* Typically GNUNET_NO. Set to GNUNET_YES if
* "upload_task" is GNUNET_SCHEDULER_NO_TASK
*/
enum GNUNET_FS_PublishOptions options;
- /**
- * Current position in the file-tree for the
- * upload.
- */
- struct GNUNET_FS_FileInformation *fi_pos;
-
- /**
- * Connection to the datastore service.
- */
- struct GNUNET_DATASTORE_Handle *dsh;
-
/**
* Space reservation ID with datastore service
* for this upload.
};
+/**
+ * Information about an active download request.
+ */
+struct DownloadRequest
+{
+ /**
+ * While pending, we keep all download requests
+ * in a linked list.
+ */
+ struct DownloadRequest *next;
+
+ /**
+ * CHK for the request.
+ */
+ struct ContentHashKey chk;
+
+ /**
+ * Offset of the corresponding block.
+ */
+ uint64_t offset;
+
+ /**
+ * Depth of the corresponding block in the tree.
+ */
+ unsigned int depth;
+
+ /**
+ * Set if this request is currently in the linked list of pending
+ * requests. Needed in case we get a response for a request that we
+ * have not yet send (due to FS bug or two blocks with identical
+ * content); in this case, we would need to remove the block from
+ * the pending list (and need a fast way to check if the block is on
+ * it).
+ */
+ int is_pending;
+
+};
+
+
/**
* Context for controlling a download.
*/
struct GNUNET_FS_DownloadContext
{
+
+ /**
+ * Global FS context.
+ */
+ struct GNUNET_FS_Handle *h;
+
+ /**
+ * Connection to the FS service.
+ */
+ struct GNUNET_CLIENT_Connection *client;
+
+ /**
+ * Parent download (used when downloading files
+ * in directories).
+ */
+ struct GNUNET_FS_DownloadContext *parent;
+
+ /**
+ * Context kept for the client.
+ */
+ void *client_info;
+
+ /**
+ * URI that identifies the file that
+ * we are downloading.
+ */
+ struct GNUNET_FS_Uri *uri;
+
+ /**
+ * Known meta-data for the file (can be NULL).
+ */
+ struct GNUNET_CONTAINER_MetaData *meta;
+
+ /**
+ * Error message, NULL if we're doing OK.
+ */
+ char *emsg;
+
+ /**
+ * Where are we writing the data (name of the
+ * file, can be NULL!).
+ */
+ char *filename;
+
+ /**
+ * Map of active requests (those waiting
+ * for a response). The key is the hash
+ * of the encryped block (aka query).
+ */
+ struct GNUNET_CONTAINER_MultiHashMap *active;
+
+ /**
+ * Linked list of pending requests.
+ */
+ struct DownloadRequest *pending;
+
+ /**
+ * The file handle, NULL if we don't create
+ * a file.
+ */
+ struct GNUNET_DISK_FileHandle *handle;
+
+ /**
+ * Identity of the peer having the content, or all-zeros
+ * if we don't know of such a peer.
+ */
+ struct GNUNET_PeerIdentity target;
+
+ /**
+ * ID of a task that is using this struct
+ * and that must be cancelled when the download
+ * is being stopped (if not GNUNET_SCHEDULER_NO_TASK).
+ * Used for the task that adds some artificial
+ * delay when trying to reconnect to the FS
+ * service.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier task;
+
+ /**
+ * What was the size of the file on disk that we're downloading
+ * before we started? Used to detect if there is a point in
+ * checking an existing block on disk for matching the desired
+ * content. 0 if the file did not exist already.
+ */
+ uint64_t old_file_size;
+
+ /**
+ * What is the first offset that we're interested
+ * in?
+ */
+ uint64_t offset;
+
+ /**
+ * How many bytes starting from offset are desired?
+ * This is NOT the overall length of the file!
+ */
+ uint64_t length;
+
+ /**
+ * How many bytes have we already received within
+ * the specified range (DBlocks only).
+ */
+ uint64_t completed;
+
+ /**
+ * Time download was started.
+ */
+ struct GNUNET_TIME_Absolute start_time;
+
+ /**
+ * Desired level of anonymity.
+ */
+ uint32_t anonymity;
+
+ /**
+ * The depth of the file-tree.
+ */
+ unsigned int treedepth;
+
+ /**
+ * Options for the download.
+ */
+ enum GNUNET_FS_DownloadOptions options;
+
};
struct GNUNET_FS_Namespace
* SBLOCKS (aka query).
*/
GNUNET_HashCode query;
-
+
+ /* this is followed by the hash codes of already-known
+ results (which should hence be excluded from what
+ the service returns); naturally, this only applies
+ to queries that can have multiple results, such as
+ those for KBLOCKS (KSK) and SBLOCKS (SKS) */
};
};
+/**
+ * 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 hash of the public key of the target
+ * namespace is included (for SKS queries).
+ */
+#define GET_MESSAGE_BIT_SKS_NAMESPACE 2
+
+/**
+ * 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
+
+
+/**
+ * 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 GNUNET_CRON_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.
+ */
+ int32_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 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.
+ */
+ GNUNET_HashCode query GNUNET_PACKED;
+
+ /* this is followed by hash codes
+ as specified in the "hash_bitmap";
+ after that, an optional bloomfilter
+ (with bits set for replies that should
+ be suppressed) can be present */
+};
+
+
+/**
+ * Message sent between peers providing FS-content.
+ */
+struct PutMessage
+{
+
+ /**
+ * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
+ */
+ struct GNUNET_MessageHeader header;
+
+ /**
+ * Type of the block (in big endian).
+ */
+ uint32_t type GNUNET_PACKED;
+
+ /**
+ * When does this result expire?
+ */
+ struct GNUNET_TIME_RelativeNBO expiration;
+
+ /* this is followed by the actual encrypted content */
+
+};
#endif
projects / oweals / gnunet.git / blobdiff