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_constants.h"
30 #include "gnunet_datastore_service.h"
31 #include "gnunet_fs_service.h"
32 #include "gnunet_block_lib.h"
35 * Size of the individual blocks used for file-sharing.
37 #define DBLOCK_SIZE (32*1024)
40 * Maximum legal size for a kblock.
42 #define MAX_KBLOCK_SIZE (60 * 1024)
45 * Maximum legal size for an sblock.
47 #define MAX_SBLOCK_SIZE (60 * 1024)
50 * Maximum legal size for an nblock.
52 #define MAX_NBLOCK_SIZE (60 * 1024)
55 * Pick a multiple of 2 here to achive 8-byte alignment!
56 * We also probably want DBlocks to have (roughly) the
57 * same size as IBlocks. With SHA-512, the optimal
58 * value is 32768 byte / 128 byte = 256
59 * (128 byte = 2 * 512 bits). DO NOT CHANGE!
61 #define CHK_PER_INODE 256
65 * Maximum size for a file to be considered for
66 * inlining in a directory.
68 #define MAX_INLINE_SIZE 65536
72 * Blocksize to use when hashing files
73 * for indexing (blocksize for IO, not for
74 * the DBlocks). Larger blocksizes can
75 * be more efficient but will be more disruptive
76 * as far as the scheduler is concerned.
78 #define HASHING_BLOCKSIZE (1024 * 1024)
81 * Number of bits we set per entry in the bloomfilter.
84 #define BLOOMFILTER_K 16
87 * Number of availability trials we perform per search result.
89 #define AVAILABILITY_TRIALS_MAX 8
92 * By how much (in ms) do we decrement the TTL
95 #define TTL_DECREMENT 5000
98 * Length of the P2P success tracker. Note that
99 * having a very long list can also hurt performance.
101 #define P2P_SUCCESS_LIST_SIZE 8
105 * Length of the CS-2-P success tracker. Note that
106 * having a very long list can also hurt performance.
108 #define CS2P_SUCCESS_LIST_SIZE 8
111 * How long are we willing to wait for the datastore to be ready to
112 * process a request for a query without priority?
114 #define BASIC_DATASTORE_REQUEST_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
118 * How long are we willing to wait for the core to be ready to
119 * transmit a reply to the target peer (if we can not transmit
120 * until then, we will discard the reply).
122 #define ACCEPTABLE_REPLY_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
126 * Bandwidth value of an (effectively) 0-priority query.
128 #define QUERY_BANDWIDTH_VALUE 0.001
131 * Bandwidth value of a 0-priority content (must be
132 * fairly high compared to query since content is
133 * typically significantly larger -- and more valueable
134 * since it can take many queries to get one piece of
137 #define CONTENT_BANDWIDTH_VALUE 0.8
140 * By which amount do we decrement the TTL for simple forwarding /
141 * indirection of the query; in milli-seconds. Set somewhat in
142 * accordance to your network latency (above the time it'll take you
143 * to send a packet and get a reply).
145 #define TTL_DECREMENT 5000
148 * Until which load do we consider the peer idle and do not
149 * charge at all? (should be larger than GNUNET_IDLE_LOAD_THRESHOLD used
150 * by the rest of the code)!
152 #define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
157 * @brief content hash key
159 struct ContentHashKey
162 GNUNET_HashCode query;
167 * @brief complete information needed
168 * to download a file.
170 struct FileIdentifier
174 * Total size of the file in bytes. (network byte order (!))
176 uint64_t file_length;
179 * Query and key of the top GNUNET_EC_IBlock.
181 struct ContentHashKey chk;
187 * Information about a file and its location
188 * (peer claiming to share the file).
193 * Information about the shared file.
195 struct FileIdentifier fi;
198 * Identity of the peer sharing the file.
200 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
203 * Time when this location URI expires.
205 struct GNUNET_TIME_Absolute expirationTime;
208 * RSA signature over the GNUNET_EC_FileIdentifier,
209 * GNUNET_hash of the peer and expiration time.
211 struct GNUNET_CRYPTO_RsaSignature contentSignature;
216 { chk, sks, ksk, loc };
219 * A Universal Resource Identifier (URI), opaque.
229 * Keywords start with a '+' if they are
230 * mandatory (in which case the '+' is NOT
231 * part of the keyword) and with a
232 * simple space if they are optional
233 * (in which case the space is ALSO not
234 * part of the actual keyword).
236 * Double-quotes to protect spaces and
237 * %-encoding are NOT used internally
238 * (only in URI-strings).
243 * Size of the keywords array.
245 unsigned int keywordCount;
251 * Hash of the public key for the namespace.
253 GNUNET_HashCode namespace;
256 * Human-readable identifier chosen for this
257 * entry in the namespace.
263 * Information needed to retrieve a file (content-hash-key
266 struct FileIdentifier chk;
269 * Information needed to retrieve a file including signed
270 * location (identity of a peer) of the content.
279 * Information for a file or directory that is
280 * about to be published.
282 struct GNUNET_FS_FileInformation
286 * Files in a directory are kept as a linked list.
288 struct GNUNET_FS_FileInformation *next;
291 * If this is a file in a directory, "dir" refers to
292 * the directory; otherwise NULL.
294 struct GNUNET_FS_FileInformation *dir;
297 * Handle to the master context.
299 struct GNUNET_FS_Handle *h;
302 * Pointer kept for the client.
307 * Metadata to use for the file.
309 struct GNUNET_CONTAINER_MetaData *meta;
312 * Keywords to use for KBlocks.
314 struct GNUNET_FS_Uri *keywords;
317 * CHK for this file or directory. NULL if
318 * we have not yet computed it.
320 struct GNUNET_FS_Uri *chk_uri;
323 * At what time should the content expire?
325 struct GNUNET_TIME_Absolute expirationTime;
328 * At what time did we start this upload?
330 struct GNUNET_TIME_Absolute start_time;
333 * Under what filename is this struct serialized
334 * (for operational persistence). Should be determined
340 * Encoder being used to publish this file.
342 struct GNUNET_FS_TreeEncoder *te;
345 * Error message (non-NULL if this operation failed).
350 * Name of the file or directory (must be an absolute path).
355 * Data describing either the file or the directory.
366 * Function that can be used to read the data for the file.
368 GNUNET_FS_DataReader reader;
371 * Closure for reader.
376 * If this file is being indexed, this value is set to the hash
377 * over the entire file (when the indexing process is started).
378 * Otherwise this field is not used.
380 GNUNET_HashCode file_id;
383 * Size of the file (in bytes).
388 * Should the file be indexed or inserted?
393 * Is "file_id" already valid? Set to GNUNET_YES once the hash
394 * has been calculated.
399 * Has the service confirmed our INDEX_START request?
400 * GNUNET_YES if this step has been completed.
402 int index_start_confirmed;
407 * Data for a directory.
412 * Linked list of entries in the directory.
414 struct GNUNET_FS_FileInformation *entries;
417 * Size of the directory itself (in bytes); 0 if the
418 * size has not yet been calculated.
423 * Pointer to the data for the directory (or NULL if not
433 * Desired anonymity level.
438 * Desired priority (for keeping the content in the DB).
443 * Is this struct for a file or directory?
448 * Are we done publishing this file?
456 * The job is now ready to run and should use the given client
457 * handle to communicate with the FS service.
460 * @param client handle to use for FS communication
462 typedef void (*GNUNET_FS_QueueStart)(void *cls,
463 struct GNUNET_CLIENT_Connection *client);
467 * The job must now stop to run and should destry the client handle as
468 * soon as possible (ideally prior to returning).
470 typedef void (*GNUNET_FS_QueueStop)(void *cls);
474 * Entry in the job queue.
476 struct GNUNET_FS_QueueEntry
479 * This is a linked list.
481 struct GNUNET_FS_QueueEntry *next;
484 * This is a linked list.
486 struct GNUNET_FS_QueueEntry *prev;
489 * Function to call when the job is started.
491 GNUNET_FS_QueueStart start;
494 * Function to call when the job needs to stop (or is done / dequeued).
496 GNUNET_FS_QueueStop stop;
499 * Closure for start and stop.
504 * Handle to FS primary context.
506 struct GNUNET_FS_Handle *h;
509 * Client handle, or NULL if job is not running.
511 struct GNUNET_CLIENT_Connection *client;
514 * Time the job was originally queued.
516 struct GNUNET_TIME_Absolute queue_time;
519 * Time the job was started last.
521 struct GNUNET_TIME_Absolute start_time;
524 * Total amount of time the job has been running (except for the
527 struct GNUNET_TIME_Relative run_time;
530 * How many blocks do the active downloads have?
535 * How often have we (re)started this download?
537 unsigned int start_times;
545 * Information we store for each search result.
551 * Search context this result belongs to.
553 struct GNUNET_FS_SearchContext *sc;
556 * URI to which this search result refers to.
558 struct GNUNET_FS_Uri *uri;
561 * Metadata for the search result.
563 struct GNUNET_CONTAINER_MetaData *meta;
566 * Client info for this search result.
571 * ID of a job that is currently probing this results' availability
572 * (NULL if we are not currently probing).
574 struct GNUNET_FS_DownloadContext *probe_ctx;
577 * Name under which this search result is stored on disk.
582 * ID of the task that will clean up the probe_ctx should it not
583 * complete on time (and that will need to be cancelled if we clean
584 * up the search result before then).
586 GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
589 * When did the current probe become active?
591 struct GNUNET_TIME_Absolute probe_active_time;
594 * How much longer should we run the current probe before giving up?
596 struct GNUNET_TIME_Relative remaining_probe_time;
599 * Number of mandatory keywords for which we have NOT yet found the
600 * search result; when this value hits zero, the search result is
601 * given to the callback.
603 uint32_t mandatory_missing;
606 * Number of optional keywords under which this result was also
609 uint32_t optional_support;
612 * Number of availability tests that have succeeded for this result.
614 uint32_t availability_success;
617 * Number of availability trials that we have performed for this
620 uint32_t availability_trials;
626 * Add a job to the queue.
628 * @param h handle to the overall FS state
629 * @param start function to call to begin the job
630 * @param stop function to call to pause the job, or on dequeue (if the job was running)
631 * @param cls closure for start and stop
632 * @param blocks number of blocks this download has
633 * @return queue handle
635 struct GNUNET_FS_QueueEntry *
636 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
637 GNUNET_FS_QueueStart start,
638 GNUNET_FS_QueueStop stop,
640 unsigned int blocks);
644 * Dequeue a job from the queue.
645 * @param qh handle for the job
648 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh);
652 * Function that provides data by reading from a file.
654 * @param cls closure (points to the file information)
655 * @param offset offset to read from; it is possible
656 * that the caller might need to go backwards
658 * @param max maximum number of bytes that should be
659 * copied to buf; readers are not allowed
660 * to provide less data unless there is an error;
661 * a value of "0" will be used at the end to allow
662 * the reader to clean up its internal state
663 * @param buf where the reader should write the data
664 * @param emsg location for the reader to store an error message
665 * @return number of bytes written, usually "max", 0 on error
668 GNUNET_FS_data_reader_file_(void *cls,
676 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
678 * @param filename file to read
679 * @return closure to use
682 GNUNET_FS_make_file_reader_context_ (const char *filename);
687 * Function that provides data by copying from a buffer.
689 * @param cls closure (points to the buffer)
690 * @param offset offset to read from; it is possible
691 * that the caller might need to go backwards
693 * @param max maximum number of bytes that should be
694 * copied to buf; readers are not allowed
695 * to provide less data unless there is an error;
696 * a value of "0" will be used at the end to allow
697 * the reader to clean up its internal state
698 * @param buf where the reader should write the data
699 * @param emsg location for the reader to store an error message
700 * @return number of bytes written, usually "max", 0 on error
703 GNUNET_FS_data_reader_copy_(void *cls,
710 * Notification of FS that a search probe has made progress.
711 * This function is used INSTEAD of the client's event handler
712 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
714 * @param cls closure, always NULL (!), actual closure
715 * is in the client-context of the info struct
716 * @param info details about the event, specifying the event type
717 * and various bits about the event
718 * @return client-context (for the next progress call
719 * for this operation; should be set to NULL for
720 * SUSPEND and STOPPED events). The value returned
721 * will be passed to future callbacks in the respective
722 * field in the GNUNET_FS_ProgressInfo struct.
725 GNUNET_FS_search_probe_progress_ (void *cls,
726 const struct GNUNET_FS_ProgressInfo *info);
730 * Main function that performs the upload.
732 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
733 * @param tc task context
736 GNUNET_FS_publish_main_ (void *cls,
737 const struct GNUNET_SCHEDULER_TaskContext *tc);
741 * Function called once the hash of the file
742 * that is being unindexed has been computed.
744 * @param cls closure, unindex context
745 * @param file_id computed hash, NULL on error
748 GNUNET_FS_unindex_process_hash_ (void *cls,
749 const GNUNET_HashCode *file_id);
753 * Fill in all of the generic fields for a publish event and call the
756 * @param pi structure to fill in
757 * @param sc overall publishing context
758 * @param p file information for the file being published
759 * @param offset where in the file are we so far
760 * @return value returned from callback
763 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
764 struct GNUNET_FS_PublishContext *sc,
765 const struct GNUNET_FS_FileInformation *p,
769 * Fill in all of the generic fields for
770 * an unindex event and call the callback.
772 * @param pi structure to fill in
773 * @param uc overall unindex context
774 * @param offset where we are in the file (for progress)
777 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
778 struct GNUNET_FS_UnindexContext *uc,
782 * Fill in all of the generic fields for a search event and
785 * @param pi structure to fill in
786 * @param sc overall search context
787 * @return value returned by the callback
790 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
791 struct GNUNET_FS_SearchContext *sc);
795 * Connect to the datastore and remove the blocks.
797 * @param uc context for the unindex operation.
800 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
803 * Build the request and actually initiate the search using the
806 * @param sc search context
807 * @return GNUNET_OK on success, GNUNET_SYSERR on error
810 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
813 * Start download probes for the given search result.
815 * @param sr the search result
818 GNUNET_FS_search_start_probe_ (struct SearchResult *sr);
821 * Remove serialization/deserialization file from disk.
823 * @param h master context
824 * @param ext component of the path
825 * @param ent entity identifier
828 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
834 * Synchronize this file-information struct with its mirror
835 * on disk. Note that all internal FS-operations that change
836 * file information data should already call "sync" internally,
837 * so this function is likely not useful for clients.
839 * @param fi the struct to sync
842 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
845 * Synchronize this publishing struct with its mirror
846 * on disk. Note that all internal FS-operations that change
847 * publishing structs should already call "sync" internally,
848 * so this function is likely not useful for clients.
850 * @param pc the struct to sync
853 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
856 * Synchronize this unindex struct with its mirror
857 * on disk. Note that all internal FS-operations that change
858 * publishing structs should already call "sync" internally,
859 * so this function is likely not useful for clients.
861 * @param uc the struct to sync
864 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
867 * Synchronize this search struct with its mirror
868 * on disk. Note that all internal FS-operations that change
869 * publishing structs should already call "sync" internally,
870 * so this function is likely not useful for clients.
872 * @param sc the struct to sync
875 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
878 * Synchronize this search result with its mirror
879 * on disk. Note that all internal FS-operations that change
880 * publishing structs should already call "sync" internally,
881 * so this function is likely not useful for clients.
883 * @param sc the struct to sync
886 GNUNET_FS_search_result_sync_ (struct SearchResult *sr);
890 * Master context for most FS operations.
892 struct GNUNET_FS_Handle
897 struct GNUNET_SCHEDULER_Handle *sched;
900 * Configuration to use.
902 const struct GNUNET_CONFIGURATION_Handle *cfg;
905 * Name of our client.
910 * Function to call with updates on our progress.
912 GNUNET_FS_ProgressCallback upcb;
920 * Connection to the FS service.
922 struct GNUNET_CLIENT_Connection *client;
925 * Head of DLL of running jobs.
927 struct GNUNET_FS_QueueEntry *running_head;
930 * Tail of DLL of running jobs.
932 struct GNUNET_FS_QueueEntry *running_tail;
935 * Head of DLL of pending jobs.
937 struct GNUNET_FS_QueueEntry *pending_head;
940 * Tail of DLL of pending jobs.
942 struct GNUNET_FS_QueueEntry *pending_tail;
945 * Task that processes the jobs in the running and pending queues
946 * (and moves jobs around as needed).
948 GNUNET_SCHEDULER_TaskIdentifier queue_job;
951 * Average time we take for a single request to be satisfied.
952 * FIXME: not yet calcualted properly...
954 struct GNUNET_TIME_Relative avg_block_latency;
957 * How many actual downloads do we have running right now?
959 unsigned int active_downloads;
962 * How many blocks do the active downloads have?
964 unsigned int active_blocks;
969 enum GNUNET_FS_Flags flags;
972 * Maximum number of parallel downloads.
974 unsigned int max_parallel_downloads;
977 * Maximum number of parallel requests.
979 unsigned int max_parallel_requests;
985 * Handle for controlling a publication process.
987 struct GNUNET_FS_PublishContext
990 * Handle to the global fs context.
992 struct GNUNET_FS_Handle *h;
995 * File-structure that is being shared.
997 struct GNUNET_FS_FileInformation *fi;
1000 * Namespace that we are publishing in, NULL if we have no namespace.
1002 struct GNUNET_FS_Namespace *namespace;
1005 * ID of the content in the namespace, NULL if we have no namespace.
1010 * ID for future updates, NULL if we have no namespace or no updates.
1015 * Filename used for serializing information about this operation
1016 * (should be determined using 'mktemp').
1018 char *serialization;
1021 * Our own client handle for the FS service; only briefly used when
1022 * we start to index a file, otherwise NULL.
1024 struct GNUNET_CLIENT_Connection *client;
1027 * Current position in the file-tree for the upload.
1029 struct GNUNET_FS_FileInformation *fi_pos;
1032 * Connection to the datastore service.
1034 struct GNUNET_DATASTORE_Handle *dsh;
1037 * ID of the task performing the upload. NO_TASK if the upload has
1040 GNUNET_SCHEDULER_TaskIdentifier upload_task;
1043 * Typically GNUNET_NO. Set to GNUNET_YES if "upload_task" is
1044 * GNUNET_SCHEDULER_NO_TASK and we're waiting for a response from
1045 * the datastore service (in which case this struct must not be
1046 * freed until we have that response). If someone tries to stop the
1047 * download for good during this period, "in_network_wait" is set to
1048 * GNUNET_SYSERR which will cause the struct to be destroyed right
1049 * after we have the reply (or timeout) from the datastore service.
1051 int in_network_wait;
1054 * Options for publishing.
1056 enum GNUNET_FS_PublishOptions options;
1059 * Space reservation ID with datastore service
1065 * Set to GNUNET_YES if all processing has completed.
1072 * Phases of unindex processing (state machine).
1077 * We're currently hashing the file.
1079 UNINDEX_STATE_HASHING = 0,
1082 * We're notifying the FS service about
1085 UNINDEX_STATE_FS_NOTIFY = 1,
1088 * We're telling the datastore to delete
1089 * the respective entries.
1091 UNINDEX_STATE_DS_REMOVE = 2,
1096 UNINDEX_STATE_COMPLETE = 3,
1099 * We've encountered a fatal error.
1101 UNINDEX_STATE_ERROR = 4,
1104 * We've been aborted. The next callback should clean up the
1107 UNINDEX_STATE_ABORTED = 5
1112 * Handle for controlling an unindexing operation.
1114 struct GNUNET_FS_UnindexContext
1118 * Global FS context.
1120 struct GNUNET_FS_Handle *h;
1123 * Name of the file that we are unindexing.
1128 * Short name under which we are serializing the state of this operation.
1130 char *serialization;
1133 * Connection to the FS service, only valid during the
1134 * UNINDEX_STATE_FS_NOTIFY phase.
1136 struct GNUNET_CLIENT_Connection *client;
1139 * Connection to the datastore service, only valid during the
1140 * UNINDEX_STATE_DS_NOTIFY phase.
1142 struct GNUNET_DATASTORE_Handle *dsh;
1145 * Pointer kept for the client.
1150 * Merkle-ish tree encoder context.
1152 struct GNUNET_FS_TreeEncoder *tc;
1155 * Handle used to read the file.
1157 struct GNUNET_DISK_FileHandle *fh;
1160 * Error message, NULL on success.
1165 * Overall size of the file.
1170 * When did we start?
1172 struct GNUNET_TIME_Absolute start_time;
1175 * Hash of the file's contents (once computed).
1177 GNUNET_HashCode file_id;
1180 * Current operatinonal phase.
1182 enum UnindexState state;
1188 * Information we keep for each keyword in
1191 struct SearchRequestEntry
1194 * Hash of the original keyword, also known as the
1195 * key (for decrypting the KBlock).
1197 GNUNET_HashCode key;
1200 * Hash of the public key, also known as the query.
1202 GNUNET_HashCode query;
1205 * Map that contains a "struct SearchResult" for each result that
1206 * was found under this keyword. Note that the entries will point
1207 * to the same locations as those in the master result map (in
1208 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1209 * The key for each entry is the XOR of the key and query in the CHK
1210 * URI (as a unique identifier for the search result).
1212 struct GNUNET_CONTAINER_MultiHashMap *results;
1215 * Is this keyword a mandatory keyword
1216 * (started with '+')?
1224 * Handle for controlling a search.
1226 struct GNUNET_FS_SearchContext
1229 * Handle to the global FS context.
1231 struct GNUNET_FS_Handle *h;
1234 * List of keywords that we're looking for.
1236 struct GNUNET_FS_Uri *uri;
1239 * For update-searches, link to the base-SKS search that triggered
1240 * the update search; otherwise NULL.
1242 struct GNUNET_FS_SearchContext *parent;
1245 * For update-searches, link to the first child search that
1246 * triggered the update search; otherwise NULL.
1248 struct GNUNET_FS_SearchContext *child_head;
1251 * For update-searches, link to the last child search that triggered
1252 * the update search; otherwise NULL.
1254 struct GNUNET_FS_SearchContext *child_tail;
1257 * For update-searches, link to the next child belonging to the same
1260 struct GNUNET_FS_SearchContext *next;
1263 * For update-searches, link to the previous child belonging to the
1266 struct GNUNET_FS_SearchContext *prev;
1269 * Connection to the FS service.
1271 struct GNUNET_CLIENT_Connection *client;
1274 * Pointer we keep for the client.
1279 * Name of the file on disk we use for persistence.
1281 char *serialization;
1284 * Error message (non-NULL if this operation failed).
1289 * Map that contains a "struct SearchResult" for each result that
1290 * was found in the search. The key for each entry is the XOR of
1291 * the key and query in the CHK URI (as a unique identifier for the
1294 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1297 * Per-keyword information for a keyword search. This array will
1298 * have exactly as many entries as there were keywords.
1300 struct SearchRequestEntry *requests;
1303 * When did we start?
1305 struct GNUNET_TIME_Absolute start_time;
1308 * ID of a task that is using this struct and that must be cancelled
1309 * when the search is being stopped (if not
1310 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1311 * artificial delay when trying to reconnect to the FS service.
1313 GNUNET_SCHEDULER_TaskIdentifier task;
1316 * Anonymity level for the search.
1321 * Number of mandatory keywords in this query.
1323 uint32_t mandatory_count;
1326 * Options for the search.
1328 enum GNUNET_FS_SearchOptions options;
1333 * Information about an active download request.
1335 struct DownloadRequest
1338 * While pending, we keep all download requests in a linked list.
1340 struct DownloadRequest *next;
1343 * CHK for the request.
1345 struct ContentHashKey chk;
1348 * Offset of the corresponding block.
1353 * Depth of the corresponding block in the tree.
1358 * Set if this request is currently in the linked list of pending
1359 * requests. Needed in case we get a response for a request that we
1360 * have not yet send (due to FS bug or two blocks with identical
1361 * content); in this case, we would need to remove the block from
1362 * the pending list (and need a fast way to check if the block is on
1371 * Context for controlling a download.
1373 struct GNUNET_FS_DownloadContext
1377 * Global FS context.
1379 struct GNUNET_FS_Handle *h;
1382 * Connection to the FS service.
1384 struct GNUNET_CLIENT_Connection *client;
1387 * Parent download (used when downloading files
1390 struct GNUNET_FS_DownloadContext *parent;
1393 * Head of list of child downloads.
1395 struct GNUNET_FS_DownloadContext *child_head;
1398 * Tail of list of child downloads.
1400 struct GNUNET_FS_DownloadContext *child_tail;
1403 * Previous download belonging to the same parent.
1405 struct GNUNET_FS_DownloadContext *prev;
1408 * Next download belonging to the same parent.
1410 struct GNUNET_FS_DownloadContext *next;
1413 * Context kept for the client.
1418 * URI that identifies the file that
1419 * we are downloading.
1421 struct GNUNET_FS_Uri *uri;
1424 * Known meta-data for the file (can be NULL).
1426 struct GNUNET_CONTAINER_MetaData *meta;
1429 * Error message, NULL if we're doing OK.
1434 * Where are we writing the data (name of the
1435 * file, can be NULL!).
1440 * Where are we writing the data temporarily (name of the
1441 * file, can be NULL!); used if we do not have a permanent
1442 * name and we are a directory and we do a recursive download.
1444 char *temp_filename;
1447 * Map of active requests (those waiting
1448 * for a response). The key is the hash
1449 * of the encryped block (aka query).
1451 struct GNUNET_CONTAINER_MultiHashMap *active;
1454 * Linked list of pending requests.
1456 struct DownloadRequest *pending;
1459 * The file handle, NULL if we don't create
1462 struct GNUNET_DISK_FileHandle *handle;
1465 * Non-NULL if we are currently having a request for
1466 * transmission pending with the client handle.
1468 struct GNUNET_CLIENT_TransmitHandle *th;
1471 * Our entry in the job queue.
1473 struct GNUNET_FS_QueueEntry *job_queue;
1476 * Identity of the peer having the content, or all-zeros
1477 * if we don't know of such a peer.
1479 struct GNUNET_PeerIdentity target;
1482 * ID of a task that is using this struct
1483 * and that must be cancelled when the download
1484 * is being stopped (if not GNUNET_SCHEDULER_NO_TASK).
1485 * Used for the task that adds some artificial
1486 * delay when trying to reconnect to the FS
1489 GNUNET_SCHEDULER_TaskIdentifier task;
1492 * What was the size of the file on disk that we're downloading
1493 * before we started? Used to detect if there is a point in
1494 * checking an existing block on disk for matching the desired
1495 * content. 0 if the file did not exist already.
1497 uint64_t old_file_size;
1500 * What is the first offset that we're interested
1506 * How many bytes starting from offset are desired?
1507 * This is NOT the overall length of the file!
1512 * How many bytes have we already received within
1513 * the specified range (DBlocks only).
1518 * Time download was started.
1520 struct GNUNET_TIME_Absolute start_time;
1523 * Desired level of anonymity.
1528 * The depth of the file-tree.
1530 unsigned int treedepth;
1533 * Options for the download.
1535 enum GNUNET_FS_DownloadOptions options;
1538 * Flag set upon transitive completion (includes child downloads).
1539 * This flag is only set to GNUNET_YES for directories where all
1540 * child-downloads have also completed (and signalled completion).
1546 struct GNUNET_FS_Namespace
1550 * Private key for the namespace.
1552 struct GNUNET_CRYPTO_RsaPrivateKey *key;
1555 * Name of the file with the private key.
1560 * Name of the namespace.
1565 * Reference counter.
1572 * Message sent from a GNUnet (fs) publishing activity to the
1573 * gnunet-fs-service to initiate indexing of a file. The service is
1574 * supposed to check if the specified file is available and has the
1575 * same cryptographic hash. It should then respond with either a
1576 * confirmation or a denial.
1578 * On OSes where this works, it is considered acceptable if the
1579 * service only checks that the path, device and inode match (it can
1580 * then be assumed that the hash will also match without actually
1581 * computing it; this is an optimization that should be safe given
1582 * that the client is not our adversary).
1584 struct IndexStartMessage
1588 * Message type will be GNUNET_MESSAGE_TYPE_FS_INDEX_START.
1590 struct GNUNET_MessageHeader header;
1593 * ID of device containing the file, as seen by the client. This
1594 * device ID is obtained using a call like "statvfs" (and converting
1595 * the "f_fsid" field to a 32-bit big-endian number). Use 0 if the
1596 * OS does not support this, in which case the service must do a
1597 * full hash recomputation.
1599 uint32_t device GNUNET_PACKED;
1602 * Inode of the file on the given device, as seen by the client
1603 * ("st_ino" field from "struct stat"). Use 0 if the OS does not
1604 * support this, in which case the service must do a full hash
1607 uint64_t inode GNUNET_PACKED;
1610 * Hash of the file that we would like to index.
1612 GNUNET_HashCode file_id;
1614 /* this is followed by a 0-terminated
1615 filename of a file with the hash
1616 "file_id" as seen by the client */
1622 * Message send by FS service in response to a request
1623 * asking for a list of all indexed files.
1625 struct IndexInfoMessage
1628 * Message type will be
1629 * GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY.
1631 struct GNUNET_MessageHeader header;
1636 uint32_t reserved GNUNET_PACKED;
1639 * Hash of the indexed file.
1641 GNUNET_HashCode file_id;
1643 /* this is followed by a 0-terminated
1644 filename of a file with the hash
1645 "file_id" as seen by the client */
1651 * Message sent from a GNUnet (fs) unindexing activity to the
1652 * gnunet-service-fs to indicate that a file will be unindexed. The
1653 * service is supposed to remove the file from the list of indexed
1654 * files and response with a confirmation message (even if the file
1655 * was already not on the list).
1657 struct UnindexMessage
1661 * Message type will be
1662 * GNUNET_MESSAGE_TYPE_FS_UNINDEX.
1664 struct GNUNET_MessageHeader header;
1669 uint32_t reserved GNUNET_PACKED;
1672 * Hash of the file that we will unindex.
1674 GNUNET_HashCode file_id;
1680 * Message sent from a GNUnet (fs) search activity to the
1681 * gnunet-service-fs to start a search.
1683 struct SearchMessage
1687 * Message type will be
1688 * GNUNET_MESSAGE_TYPE_FS_START_SEARCH.
1690 struct GNUNET_MessageHeader header;
1693 * Bitmask with options. Zero for no options, one for loopback-only.
1694 * Other bits are currently not defined.
1696 int32_t options GNUNET_PACKED;
1699 * Type of the content that we're looking for.
1701 uint32_t type GNUNET_PACKED;
1704 * Desired anonymity level, big-endian.
1706 uint32_t anonymity_level GNUNET_PACKED;
1709 * If the request is for a DBLOCK or IBLOCK, this is the identity of
1710 * the peer that is known to have a response. Set to all-zeros if
1711 * such a target is not known (note that even if OUR anonymity
1712 * level is >0 we may happen to know the responder's identity;
1713 * nevertheless, we should probably not use it for a DHT-lookup
1714 * or similar blunt actions in order to avoid exposing ourselves).
1716 * If the request is for an SBLOCK, this is the identity of the
1717 * pseudonym to which the SBLOCK belongs.
1719 * If the request is for a KBLOCK, "target" must be all zeros.
1721 GNUNET_HashCode target;
1724 * Hash of the keyword (aka query) for KBLOCKs; Hash of
1725 * the CHK-encoded block for DBLOCKS and IBLOCKS (aka query)
1726 * and hash of the identifier XORed with the target for
1727 * SBLOCKS (aka query).
1729 GNUNET_HashCode query;
1731 /* this is followed by the hash codes of already-known
1732 results (which should hence be excluded from what
1733 the service returns); naturally, this only applies
1734 to queries that can have multiple results, such as
1735 those for KBLOCKS (KSK) and SBLOCKS (SKS) */
1740 * Only the (mandatory) query is included.
1742 #define GET_MESSAGE_BIT_QUERY_ONLY 0
1745 * The peer identity of a peer waiting for the
1746 * reply is included (used if the response
1747 * should be transmitted to someone other than
1748 * the sender of the GET).
1750 #define GET_MESSAGE_BIT_RETURN_TO 1
1753 * The hash of the public key of the target
1754 * namespace is included (for SKS queries).
1756 #define GET_MESSAGE_BIT_SKS_NAMESPACE 2
1759 * The peer identity of a peer that had claimed to have the content
1760 * previously is included (can be used if responder-anonymity is not
1761 * desired; note that the precursor presumably lacked a direct
1762 * connection to the specified peer; still, the receiver is in no way
1763 * required to limit forwarding only to the specified peer, it should
1764 * only prefer it somewhat if possible).
1766 #define GET_MESSAGE_BIT_TRANSMIT_TO 4
1770 * Message sent between peers asking for FS-content.
1776 * Message type will be GNUNET_MESSAGE_TYPE_FS_GET.
1778 struct GNUNET_MessageHeader header;
1781 * Type of the query (block type).
1783 uint32_t type GNUNET_PACKED;
1786 * How important is this request (network byte order)
1788 uint32_t priority GNUNET_PACKED;
1791 * Relative time to live in MILLISECONDS (network byte order)
1793 int32_t ttl GNUNET_PACKED;
1796 * The content hash should be mutated using this value
1797 * before checking against the bloomfilter (used to
1798 * get many different filters for the same hash codes).
1799 * The number should be in big-endian format when used
1802 int32_t filter_mutator GNUNET_PACKED;
1805 * Which of the optional hash codes are present at the end of the
1806 * message? See GET_MESSAGE_BIT_xx constants. For each bit that is
1807 * set, an additional GNUNET_HashCode with the respective content
1808 * (in order of the bits) will be appended to the end of the GET
1811 uint32_t hash_bitmap GNUNET_PACKED;
1814 * Hashcodes of the file(s) we're looking for.
1815 * Details depend on the query type.
1817 GNUNET_HashCode query GNUNET_PACKED;
1819 /* this is followed by hash codes
1820 as specified in the "hash_bitmap";
1821 after that, an optional bloomfilter
1822 (with bits set for replies that should
1823 be suppressed) can be present */
1828 * Response from FS service with a result for a previous FS search.
1829 * Note that queries for DBLOCKS and IBLOCKS that have received a
1830 * single response are considered done. This message is transmitted
1831 * between peers as well as between the service and a client.
1837 * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
1839 struct GNUNET_MessageHeader header;
1842 * Type of the block (in big endian). Should never be zero.
1844 uint32_t type GNUNET_PACKED;
1847 * When does this result expire?
1849 struct GNUNET_TIME_AbsoluteNBO expiration;
1851 /* this is followed by the actual encrypted content */