2 This file is part of GNUnet.
3 (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
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 2, or (at your
8 option) any later version.
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.
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.
23 * @brief definitions for the entire fs module
24 * @author Igor Wronsky, Christian Grothoff
29 #include "gnunet_datastore_service.h"
30 #include "gnunet_fs_service.h"
33 * Size of the individual blocks used for file-sharing.
35 #define GNUNET_FS_DBLOCK_SIZE (32*1024)
39 * Pick a multiple of 2 here to achive 8-byte alignment!
40 * We also probably want DBlocks to have (roughly) the
41 * same size as IBlocks. With SHA-512, the optimal
42 * value is 32768 byte / 128 byte = 256
43 * (128 byte = 2 * 512 bits). DO NOT CHANGE!
45 #define GNUNET_FS_CHK_PER_INODE 256
49 * Maximum size for a file to be considered for
50 * inlining in a directory.
52 #define GNUNET_FS_MAX_INLINE_SIZE 65536
57 * @brief content hash key
62 GNUNET_HashCode query;
67 * @brief complete information needed
74 * Total size of the file in bytes. (network byte order (!))
79 * Query and key of the top GNUNET_EC_IBlock.
81 struct ContentHashKey chk;
87 * Information about a file and its location
88 * (peer claiming to share the file).
93 * Information about the shared file.
95 struct FileIdentifier fi;
98 * Identity of the peer sharing the file.
100 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
103 * Time when this location URI expires.
105 struct GNUNET_TIME_Absolute expirationTime;
108 * RSA signature over the GNUNET_EC_FileIdentifier,
109 * GNUNET_hash of the peer and expiration time.
111 struct GNUNET_CRYPTO_RsaSignature contentSignature;
116 { chk, sks, ksk, loc };
119 * A Universal Resource Identifier (URI), opaque.
129 * Keywords start with a '+' if they are
130 * mandatory (in which case the '+' is NOT
131 * part of the keyword) and with a
132 * simple space if they are optional
133 * (in which case the space is ALSO not
134 * part of the actual keyword).
136 * Double-quotes to protect spaces and
137 * %-encoding are NOT used internally
138 * (only in URI-strings).
143 * Size of the keywords array.
145 unsigned int keywordCount;
151 * Hash of the public key for the namespace.
153 GNUNET_HashCode namespace;
156 * Human-readable identifier chosen for this
157 * entry in the namespace.
163 * Information needed to retrieve a file (content-hash-key
166 struct FileIdentifier chk;
169 * Information needed to retrieve a file including signed
170 * location (identity of a peer) of the content.
179 * Information for a file or directory that is
180 * about to be published.
182 struct GNUNET_FS_FileInformation
186 * Files in a directory are kept as a linked list.
188 struct GNUNET_FS_FileInformation *next;
191 * If this is a file in a directory, "dir" refers to
192 * the directory; otherwise NULL.
194 struct GNUNET_FS_FileInformation *dir;
197 * Pointer kept for the client.
202 * Metadata to use for the file.
204 struct GNUNET_CONTAINER_MetaData *meta;
207 * Keywords to use for KBlocks.
209 struct GNUNET_FS_Uri *keywords;
212 * CHK for this file or directory. NULL if
213 * we have not yet computed it.
215 struct GNUNET_FS_Uri *chk_uri;
218 * At what time should the content expire?
220 struct GNUNET_TIME_Absolute expirationTime;
223 * At what time did we start this upload?
225 struct GNUNET_TIME_Absolute start_time;
228 * Under what filename is this struct serialized
229 * (for operational persistence).
234 * In-memory cache of the current CHK tree.
235 * This struct will contain the CHK values
236 * from the root to the currently processed
237 * node in the tree as identified by
238 * "current_depth" and "publish_offset".
239 * The "chktree" will be initially NULL,
240 * then allocated to a sufficient number of
241 * entries for the size of the file and
242 * finally freed once the upload is complete.
244 struct ContentHashKey *chk_tree;
247 * Error message (non-NULL if this operation
253 * Number of entries in "chk_tree".
255 unsigned int chk_tree_depth;
258 * Depth in the CHK-tree at which we are
259 * currently publishing. 0 is the root
262 unsigned int current_depth;
265 * How many bytes of this file or directory have been
268 uint64_t publish_offset;
271 * Data describing either the file or the directory.
282 * Function that can be used to read the data for the file.
284 GNUNET_FS_DataReader reader;
287 * Closure for reader.
292 * Size of the file (in bytes).
297 * Should the file be indexed or inserted?
304 * Data for a directory.
309 * Name of the directory.
314 * Linked list of entries in the directory.
316 struct GNUNET_FS_FileInformation *entries;
319 * Size of the directory itself (in bytes); 0 if the
320 * size has not yet been calculated.
325 * Pointer to the data for the directory (or NULL if not
335 * Is this struct for a file or directory?
340 * Desired anonymity level.
342 unsigned int anonymity;
345 * Desired priority (for keeping the content in the DB).
347 unsigned int priority;
353 * Master context for most FS operations.
355 struct GNUNET_FS_Handle
360 struct GNUNET_SCHEDULER_Handle *sched;
363 * Configuration to use.
365 const struct GNUNET_CONFIGURATION_Handle *cfg;
368 * Name of our client.
373 * Function to call with updates on our progress.
375 GNUNET_FS_ProgressCallback upcb;
383 * Connection to the FS service.
385 struct GNUNET_CLIENT_Connection *client;
392 * Handle for controlling an upload.
394 struct GNUNET_FS_PublishContext
397 * Handle to the global fs context.
399 struct GNUNET_FS_Handle *h;
402 * Argument to pass to the client in callbacks.
407 * File-structure that is being shared.
409 struct GNUNET_FS_FileInformation *fi;
412 * Namespace that we are publishing in, NULL if we have no namespace.
414 struct GNUNET_FS_Namespace *namespace;
417 * ID of the content in the namespace, NULL if we have no namespace.
422 * ID for future updates, NULL if we have no namespace or no updates.
427 * ID of the task performing the upload. NO_TASK
428 * if the upload has completed.
430 GNUNET_SCHEDULER_TaskIdentifier upload_task;
433 * Typically GNUNET_NO. Set to GNUNET_YES if
434 * "upload_task" is GNUNET_SCHEDULER_NO_TASK
435 * and we're waiting for a response from the
436 * datastore service (in which case this
437 * struct must not be freed until we have that
438 * response). If someone tries to stop the
439 * download for good during this period,
440 * "in_network_wait" is set to GNUNET_SYSERR
441 * which will cause the struct to be destroyed
442 * right after we have the reply (or timeout)
443 * from the datastore service.
448 * Current position in the file-tree for the
451 struct GNUNET_FS_FileInformation *fi_pos;
454 * Connection to the datastore service.
456 struct GNUNET_DATASTORE_Handle *dsh;
459 * Space reservation ID with datastore service
467 * Handle for controlling an unindexing operation.
469 struct GNUNET_FS_UnindexContext
475 * Handle for controlling a search.
477 struct GNUNET_FS_SearchContext
483 * Context for controlling a download.
485 struct GNUNET_FS_DownloadContext
489 struct GNUNET_FS_Namespace