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 3, 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_dht_service.h"
32 #include "gnunet_fs_service.h"
33 #include "gnunet_block_lib.h"
38 * Maximum number of outgoing messages we queue per peer.
40 * Performance measurements for 2 peer setup for 50 MB file
41 * (with MAX_DATASTORE_QUEUE = 1 and RETRY_PROBABILITY_INV = 1):
43 * 2: 1700 kb/s, 1372 kb/s
44 * 8: 2117 kb/s, 1284 kb/s, 1112 kb/s
45 * 16: 3500 kb/s, 3200 kb/s, 3388 kb/s
46 * 32: 3441 kb/s, 3163 kb/s, 3277 kb/s
47 * 128: 1700 kb/s; 2010 kb/s, 3383 kb/s, 1156 kb/s
49 * Conclusion: 16 seems to be a pretty good value (stable
50 * and high performance, no excessive memory use).
52 #define MAX_QUEUE_PER_PEER 16
55 * Maximum size of the datastore queue for P2P operations.
56 * Needs to be large enough to queue MAX_QUEUE_PER_PEER
57 * operations for roughly the number of active (connected)
60 #define MAX_DATASTORE_QUEUE (16 * MAX_QUEUE_PER_PEER)
63 * Maximum number of blocks we keep in memory for migration.
65 #define MAX_MIGRATION_QUEUE 32
68 * How many peers do we select as possible
69 * targets per block obtained for migration?
71 #define MIGRATION_LIST_SIZE 4
74 * To how many peers do we forward each migration block ultimately?
75 * This number must be smaller or equal to MIGRATION_LIST_SIZE. Using
76 * a smaller value allows for variation in available bandwidth (for
77 * migration) between the peers.
79 #define MIGRATION_TARGET_COUNT 2
82 * Ratio for moving average delay calculation. The previous
83 * average goes in with a factor of (n-1) into the calculation.
86 #define RUNAVG_DELAY_N 16
89 * Size of the individual blocks used for file-sharing.
91 #define DBLOCK_SIZE (32*1024)
94 * Maximum legal size for a kblock.
96 #define MAX_KBLOCK_SIZE (60 * 1024)
99 * Maximum legal size for an sblock.
101 #define MAX_SBLOCK_SIZE (60 * 1024)
104 * Maximum legal size for an nblock.
106 #define MAX_NBLOCK_SIZE (60 * 1024)
109 * Pick a multiple of 2 here to achive 8-byte alignment!
110 * We also probably want DBlocks to have (roughly) the
111 * same size as IBlocks. With SHA-512, the optimal
112 * value is 32768 byte / 128 byte = 256
113 * (128 byte = 2 * 512 bits). DO NOT CHANGE!
115 #define CHK_PER_INODE 256
119 * Maximum size for a file to be considered for
120 * inlining in a directory.
122 #define MAX_INLINE_SIZE 65536
126 * Blocksize to use when hashing files
127 * for indexing (blocksize for IO, not for
128 * the DBlocks). Larger blocksizes can
129 * be more efficient but will be more disruptive
130 * as far as the scheduler is concerned.
132 #define HASHING_BLOCKSIZE (1024 * 128)
135 * Number of bits we set per entry in the bloomfilter.
138 #define BLOOMFILTER_K GNUNET_DHT_GET_BLOOMFILTER_K
141 * Number of availability trials we perform per search result.
143 #define AVAILABILITY_TRIALS_MAX 8
146 * Length of the P2P success tracker. Note that
147 * having a very long list can also hurt performance.
149 #define P2P_SUCCESS_LIST_SIZE 8
153 * Length of the CS-2-P success tracker. Note that
154 * having a very long list can also hurt performance.
156 #define CS2P_SUCCESS_LIST_SIZE 8
159 * How long are we willing to wait for the datastore to be ready to
160 * process a request for a query without priority?
162 #define BASIC_DATASTORE_REQUEST_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
166 * How long are we willing to wait for the core to be ready to
167 * transmit a reply to the target peer (if we can not transmit
168 * until then, we will discard the reply).
170 #define ACCEPTABLE_REPLY_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
174 * Bandwidth value of an (effectively) 0-priority query.
176 #define QUERY_BANDWIDTH_VALUE 1
179 * Bandwidth value of a 0-priority content (must be
180 * fairly high compared to query since content is
181 * typically significantly larger -- and more valueable
182 * since it can take many queries to get one piece of
185 #define CONTENT_BANDWIDTH_VALUE 800
188 * By which amount do we decrement the TTL for simple forwarding /
189 * indirection of the query; in milli-seconds. Set somewhat in
190 * accordance to your network latency (above the time it'll take you
191 * to send a packet and get a reply).
193 #define TTL_DECREMENT 5000
196 * Until which load do we consider the peer idle and do not
197 * charge at all? (should be larger than GNUNET_IDLE_LOAD_THRESHOLD used
198 * by the rest of the code)!
200 #define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
203 * Name of the directory with top-level searches.
205 #define GNUNET_FS_SYNC_PATH_MASTER_SEARCH "search"
208 * Name of the directory with sub-searches (namespace-updates).
210 #define GNUNET_FS_SYNC_PATH_CHILD_SEARCH "search-child"
213 * Name of the directory with master downloads (not associated
214 * with search or part of another download).
216 #define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD "download"
219 * Name of the directory with downloads that are part of another
220 * download or a search.
222 #define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD "download-child"
225 * Name of the directory with publishing operations.
227 #define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH "publish"
230 * Name of the directory with files that are being published
232 #define GNUNET_FS_SYNC_PATH_FILE_INFO "publish-file"
235 * Name of the directory with unindex operations.
237 #define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX "unindex"
241 * @brief content hash key
243 struct ContentHashKey
246 * Hash of the original content, used for encryption.
251 * Hash of the encrypted content, used for querying.
253 GNUNET_HashCode query;
258 * @brief complete information needed
259 * to download a file.
261 struct FileIdentifier
265 * Total size of the file in bytes. (network byte order (!))
267 uint64_t file_length;
270 * Query and key of the top GNUNET_EC_IBlock.
272 struct ContentHashKey chk;
278 * Information about a file and its location
279 * (peer claiming to share the file).
284 * Information about the shared file.
286 struct FileIdentifier fi;
289 * Identity of the peer sharing the file.
291 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
294 * Time when this location URI expires.
296 struct GNUNET_TIME_Absolute expirationTime;
299 * RSA signature over the GNUNET_EC_FileIdentifier,
300 * GNUNET_hash of the peer and expiration time.
302 struct GNUNET_CRYPTO_RsaSignature contentSignature;
312 * Content-hash-key (simple file).
317 * Signed key space (file in namespace).
322 * Keyword search key (query with keywords).
327 * Location (chk with identity of hosting peer).
333 * A Universal Resource Identifier (URI), opaque.
347 * Keywords start with a '+' if they are
348 * mandatory (in which case the '+' is NOT
349 * part of the keyword) and with a
350 * simple space if they are optional
351 * (in which case the space is ALSO not
352 * part of the actual keyword).
354 * Double-quotes to protect spaces and
355 * %-encoding are NOT used internally
356 * (only in URI-strings).
361 * Size of the keywords array.
363 unsigned int keywordCount;
369 * Hash of the public key for the namespace.
371 GNUNET_HashCode namespace;
374 * Human-readable identifier chosen for this
375 * entry in the namespace.
381 * Information needed to retrieve a file (content-hash-key
384 struct FileIdentifier chk;
387 * Information needed to retrieve a file including signed
388 * location (identity of a peer) of the content.
397 * Information for a file or directory that is
398 * about to be published.
400 struct GNUNET_FS_FileInformation
404 * Files in a directory are kept as a linked list.
406 struct GNUNET_FS_FileInformation *next;
409 * If this is a file in a directory, "dir" refers to
410 * the directory; otherwise NULL.
412 struct GNUNET_FS_FileInformation *dir;
415 * Handle to the master context.
417 struct GNUNET_FS_Handle *h;
420 * Pointer kept for the client.
425 * Metadata to use for the file.
427 struct GNUNET_CONTAINER_MetaData *meta;
430 * Keywords to use for KBlocks.
432 struct GNUNET_FS_Uri *keywords;
435 * CHK for this file or directory. NULL if
436 * we have not yet computed it.
438 struct GNUNET_FS_Uri *chk_uri;
441 * At what time should the content expire?
443 struct GNUNET_TIME_Absolute expirationTime;
446 * At what time did we start this upload?
448 struct GNUNET_TIME_Absolute start_time;
451 * Under what filename is this struct serialized
452 * (for operational persistence). Should be determined
458 * Encoder being used to publish this file.
460 struct GNUNET_FS_TreeEncoder *te;
463 * Error message (non-NULL if this operation failed).
468 * Name of the file or directory (must be an absolute path).
473 * Data describing either the file or the directory.
484 * Function that can be used to read the data for the file.
486 GNUNET_FS_DataReader reader;
489 * Closure for reader.
494 * If this file is being indexed, this value is set to the hash
495 * over the entire file (when the indexing process is started).
496 * Otherwise this field is not used.
498 GNUNET_HashCode file_id;
501 * Size of the file (in bytes).
506 * Should the file be indexed or inserted?
511 * Is "file_id" already valid? Set to GNUNET_YES once the hash
512 * has been calculated.
517 * Has the service confirmed our INDEX_START request?
518 * GNUNET_YES if this step has been completed.
520 int index_start_confirmed;
525 * Data for a directory.
530 * Linked list of entries in the directory.
532 struct GNUNET_FS_FileInformation *entries;
535 * Size of the directory itself (in bytes); 0 if the
536 * size has not yet been calculated.
541 * Pointer to the data for the directory (or NULL if not
551 * Desired anonymity level.
556 * Desired priority (for keeping the content in the DB).
561 * Is this struct for a file or directory?
566 * Are we done publishing this file?
574 * The job is now ready to run and should use the given client
575 * handle to communicate with the FS service.
578 * @param client handle to use for FS communication
580 typedef void (*GNUNET_FS_QueueStart)(void *cls,
581 struct GNUNET_CLIENT_Connection *client);
585 * The job must now stop to run and should destry the client handle as
586 * soon as possible (ideally prior to returning).
588 typedef void (*GNUNET_FS_QueueStop)(void *cls);
592 * Entry in the job queue.
594 struct GNUNET_FS_QueueEntry
597 * This is a linked list.
599 struct GNUNET_FS_QueueEntry *next;
602 * This is a linked list.
604 struct GNUNET_FS_QueueEntry *prev;
607 * Function to call when the job is started.
609 GNUNET_FS_QueueStart start;
612 * Function to call when the job needs to stop (or is done / dequeued).
614 GNUNET_FS_QueueStop stop;
617 * Closure for start and stop.
622 * Handle to FS primary context.
624 struct GNUNET_FS_Handle *h;
627 * Client handle, or NULL if job is not running.
629 struct GNUNET_CLIENT_Connection *client;
632 * Time the job was originally queued.
634 struct GNUNET_TIME_Absolute queue_time;
637 * Time the job was started last.
639 struct GNUNET_TIME_Absolute start_time;
642 * Total amount of time the job has been running (except for the
645 struct GNUNET_TIME_Relative run_time;
648 * How many blocks do the active downloads have?
653 * How often have we (re)started this download?
655 unsigned int start_times;
663 * Information we store for each search result.
665 struct GNUNET_FS_SearchResult
669 * Search context this result belongs to.
671 struct GNUNET_FS_SearchContext *sc;
674 * URI to which this search result refers to.
676 struct GNUNET_FS_Uri *uri;
679 * Metadata for the search result.
681 struct GNUNET_CONTAINER_MetaData *meta;
684 * Client info for this search result.
689 * ID of a job that is currently probing this results' availability
690 * (NULL if we are not currently probing).
692 struct GNUNET_FS_DownloadContext *probe_ctx;
695 * ID of an associated download based on this search result (or
698 struct GNUNET_FS_DownloadContext *download;
701 * If this search result triggered an update search, this field
702 * links to the update search.
704 struct GNUNET_FS_SearchContext *update_search;
707 * Name under which this search result is stored on disk.
712 * Key for the search result
717 * ID of the task that will clean up the probe_ctx should it not
718 * complete on time (and that will need to be cancelled if we clean
719 * up the search result before then).
721 GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
724 * When did the current probe become active?
726 struct GNUNET_TIME_Absolute probe_active_time;
729 * How much longer should we run the current probe before giving up?
731 struct GNUNET_TIME_Relative remaining_probe_time;
734 * Number of mandatory keywords for which we have NOT yet found the
735 * search result; when this value hits zero, the search result is
736 * given to the callback.
738 uint32_t mandatory_missing;
741 * Number of optional keywords under which this result was also
744 uint32_t optional_support;
747 * Number of availability tests that have succeeded for this result.
749 uint32_t availability_success;
752 * Number of availability trials that we have performed for this
755 uint32_t availability_trials;
761 * Add a job to the queue.
763 * @param h handle to the overall FS state
764 * @param start function to call to begin the job
765 * @param stop function to call to pause the job, or on dequeue (if the job was running)
766 * @param cls closure for start and stop
767 * @param blocks number of blocks this download has
768 * @return queue handle
770 struct GNUNET_FS_QueueEntry *
771 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
772 GNUNET_FS_QueueStart start,
773 GNUNET_FS_QueueStop stop,
775 unsigned int blocks);
779 * Dequeue a job from the queue.
780 * @param qh handle for the job
783 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh);
787 * Function that provides data by reading from a file.
789 * @param cls closure (points to the file information)
790 * @param offset offset to read from; it is possible
791 * that the caller might need to go backwards
793 * @param max maximum number of bytes that should be
794 * copied to buf; readers are not allowed
795 * to provide less data unless there is an error;
796 * a value of "0" will be used at the end to allow
797 * the reader to clean up its internal state
798 * @param buf where the reader should write the data
799 * @param emsg location for the reader to store an error message
800 * @return number of bytes written, usually "max", 0 on error
803 GNUNET_FS_data_reader_file_(void *cls,
811 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
813 * @param filename file to read
814 * @return closure to use
817 GNUNET_FS_make_file_reader_context_ (const char *filename);
822 * Function that provides data by copying from a buffer.
824 * @param cls closure (points to the buffer)
825 * @param offset offset to read from; it is possible
826 * that the caller might need to go backwards
828 * @param max maximum number of bytes that should be
829 * copied to buf; readers are not allowed
830 * to provide less data unless there is an error;
831 * a value of "0" will be used at the end to allow
832 * the reader to clean up its internal state
833 * @param buf where the reader should write the data
834 * @param emsg location for the reader to store an error message
835 * @return number of bytes written, usually "max", 0 on error
838 GNUNET_FS_data_reader_copy_(void *cls,
845 * Notification of FS that a search probe has made progress.
846 * This function is used INSTEAD of the client's event handler
847 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
849 * @param cls closure, always NULL (!), actual closure
850 * is in the client-context of the info struct
851 * @param info details about the event, specifying the event type
852 * and various bits about the event
853 * @return client-context (for the next progress call
854 * for this operation; should be set to NULL for
855 * SUSPEND and STOPPED events). The value returned
856 * will be passed to future callbacks in the respective
857 * field in the GNUNET_FS_ProgressInfo struct.
860 GNUNET_FS_search_probe_progress_ (void *cls,
861 const struct GNUNET_FS_ProgressInfo *info);
865 * Main function that performs the upload.
867 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
868 * @param tc task context
871 GNUNET_FS_publish_main_ (void *cls,
872 const struct GNUNET_SCHEDULER_TaskContext *tc);
876 * Function called once the hash of the file
877 * that is being unindexed has been computed.
879 * @param cls closure, unindex context
880 * @param file_id computed hash, NULL on error
883 GNUNET_FS_unindex_process_hash_ (void *cls,
884 const GNUNET_HashCode *file_id);
888 * Fill in all of the generic fields for a publish event and call the
891 * @param pi structure to fill in
892 * @param sc overall publishing context
893 * @param p file information for the file being published
894 * @param offset where in the file are we so far
895 * @return value returned from callback
898 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
899 struct GNUNET_FS_PublishContext *sc,
900 const struct GNUNET_FS_FileInformation *p,
905 * Fill in all of the generic fields for a download event and call the
908 * @param pi structure to fill in
909 * @param dc overall download context
912 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
913 struct GNUNET_FS_DownloadContext *dc);
917 * Task that creates the initial (top-level) download
918 * request for the file.
920 * @param cls the 'struct GNUNET_FS_DownloadContext'
921 * @param tc scheduler context
924 GNUNET_FS_download_start_task_ (void *cls,
925 const struct GNUNET_SCHEDULER_TaskContext *tc);
929 * Fill in all of the generic fields for
930 * an unindex event and call the callback.
932 * @param pi structure to fill in
933 * @param uc overall unindex context
934 * @param offset where we are in the file (for progress)
937 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
938 struct GNUNET_FS_UnindexContext *uc,
942 * Fill in all of the generic fields for a search event and
945 * @param pi structure to fill in
946 * @param sc overall search context
947 * @return value returned by the callback
950 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
951 struct GNUNET_FS_SearchContext *sc);
955 * Connect to the datastore and remove the blocks.
957 * @param uc context for the unindex operation.
960 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
963 * Build the request and actually initiate the search using the
966 * @param sc search context
967 * @return GNUNET_OK on success, GNUNET_SYSERR on error
970 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
973 * Start the downloading process (by entering the queue).
975 * @param dc our download context
978 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
982 * Start download probes for the given search result.
984 * @param sr the search result
987 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
990 * Remove serialization/deserialization file from disk.
992 * @param h master context
993 * @param ext component of the path
994 * @param ent entity identifier
997 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
1003 * Remove serialization/deserialization directory from disk.
1005 * @param h master context
1006 * @param ext component of the path
1007 * @param uni unique name of parent
1010 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
1016 * Synchronize this file-information struct with its mirror
1017 * on disk. Note that all internal FS-operations that change
1018 * file information data should already call "sync" internally,
1019 * so this function is likely not useful for clients.
1021 * @param fi the struct to sync
1024 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
1027 * Synchronize this publishing struct with its mirror
1028 * on disk. Note that all internal FS-operations that change
1029 * publishing structs should already call "sync" internally,
1030 * so this function is likely not useful for clients.
1032 * @param pc the struct to sync
1035 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
1038 * Synchronize this unindex struct with its mirror
1039 * on disk. Note that all internal FS-operations that change
1040 * publishing structs should already call "sync" internally,
1041 * so this function is likely not useful for clients.
1043 * @param uc the struct to sync
1046 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
1049 * Synchronize this search struct with its mirror
1050 * on disk. Note that all internal FS-operations that change
1051 * publishing structs should already call "sync" internally,
1052 * so this function is likely not useful for clients.
1054 * @param sc the struct to sync
1057 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
1060 * Synchronize this search result with its mirror
1061 * on disk. Note that all internal FS-operations that change
1062 * publishing structs should already call "sync" internally,
1063 * so this function is likely not useful for clients.
1065 * @param sr the struct to sync
1068 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
1071 * Synchronize this download struct with its mirror
1072 * on disk. Note that all internal FS-operations that change
1073 * publishing structs should already call "sync" internally,
1074 * so this function is likely not useful for clients.
1076 * @param dc the struct to sync
1079 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
1082 * Create SUSPEND event for the given publish operation
1083 * and then clean up our state (without stop signal).
1085 * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
1088 GNUNET_FS_publish_signal_suspend_ (void *cls);
1091 * Create SUSPEND event for the given search operation
1092 * and then clean up our state (without stop signal).
1094 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
1097 GNUNET_FS_search_signal_suspend_ (void *cls);
1100 * Create SUSPEND event for the given download operation
1101 * and then clean up our state (without stop signal).
1103 * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
1106 GNUNET_FS_download_signal_suspend_ (void *cls);
1109 * Create SUSPEND event for the given unindex operation
1110 * and then clean up our state (without stop signal).
1112 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
1115 GNUNET_FS_unindex_signal_suspend_ (void *cls);
1118 * Function signature of the functions that can be called
1119 * to trigger suspend signals and clean-up for top-level
1122 * @param cls closure
1124 typedef void (*SuspendSignalFunction)(void *cls);
1127 * We track all of the top-level activities of FS
1128 * so that we can signal 'suspend' on shutdown.
1130 struct TopLevelActivity
1133 * This is a doubly-linked list.
1135 struct TopLevelActivity *next;
1138 * This is a doubly-linked list.
1140 struct TopLevelActivity *prev;
1143 * Function to call for suspend-signalling and clean up.
1145 SuspendSignalFunction ssf;
1148 * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
1155 * Create a top-level activity entry.
1157 * @param h global fs handle
1158 * @param ssf suspend signal function to use
1159 * @param ssf_cls closure for ssf
1160 * @return fresh top-level activity handle
1162 struct TopLevelActivity *
1163 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
1164 SuspendSignalFunction ssf,
1169 * Destroy a top-level activity entry.
1171 * @param h global fs handle
1172 * @param top top level activity entry
1175 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
1176 struct TopLevelActivity *top);
1181 * Master context for most FS operations.
1183 struct GNUNET_FS_Handle
1186 * Configuration to use.
1188 const struct GNUNET_CONFIGURATION_Handle *cfg;
1191 * Name of our client.
1196 * Function to call with updates on our progress.
1198 GNUNET_FS_ProgressCallback upcb;
1206 * Head of DLL of top-level activities.
1208 struct TopLevelActivity *top_head;
1211 * Tail of DLL of top-level activities.
1213 struct TopLevelActivity *top_tail;
1216 * Head of DLL of running jobs.
1218 struct GNUNET_FS_QueueEntry *running_head;
1221 * Tail of DLL of running jobs.
1223 struct GNUNET_FS_QueueEntry *running_tail;
1226 * Head of DLL of pending jobs.
1228 struct GNUNET_FS_QueueEntry *pending_head;
1231 * Tail of DLL of pending jobs.
1233 struct GNUNET_FS_QueueEntry *pending_tail;
1236 * Task that processes the jobs in the running and pending queues
1237 * (and moves jobs around as needed).
1239 GNUNET_SCHEDULER_TaskIdentifier queue_job;
1242 * Average time we take for a single request to be satisfied.
1243 * FIXME: not yet calcualted properly...
1245 struct GNUNET_TIME_Relative avg_block_latency;
1248 * How many actual downloads do we have running right now?
1250 unsigned int active_downloads;
1253 * How many blocks do the active downloads have?
1255 unsigned int active_blocks;
1260 enum GNUNET_FS_Flags flags;
1263 * Maximum number of parallel downloads.
1265 unsigned int max_parallel_downloads;
1268 * Maximum number of parallel requests.
1270 unsigned int max_parallel_requests;
1276 * Handle for controlling a publication process.
1278 struct GNUNET_FS_PublishContext
1281 * Handle to the global fs context.
1283 struct GNUNET_FS_Handle *h;
1286 * Our top-level activity entry (if we are top-level, otherwise NULL).
1288 struct TopLevelActivity *top;
1291 * File-structure that is being shared.
1293 struct GNUNET_FS_FileInformation *fi;
1296 * Namespace that we are publishing in, NULL if we have no namespace.
1298 struct GNUNET_FS_Namespace *namespace;
1301 * ID of the content in the namespace, NULL if we have no namespace.
1306 * ID for future updates, NULL if we have no namespace or no updates.
1311 * Filename used for serializing information about this operation
1312 * (should be determined using 'mktemp').
1314 char *serialization;
1317 * Our own client handle for the FS service; only briefly used when
1318 * we start to index a file, otherwise NULL.
1320 struct GNUNET_CLIENT_Connection *client;
1323 * Current position in the file-tree for the upload.
1325 struct GNUNET_FS_FileInformation *fi_pos;
1328 * Non-null if we are currently hashing a file.
1330 struct GNUNET_CRYPTO_FileHashContext *fhc;
1333 * Connection to the datastore service.
1335 struct GNUNET_DATASTORE_Handle *dsh;
1338 * Queue entry for reservation/unreservation.
1340 struct GNUNET_DATASTORE_QueueEntry *qre;
1343 * ID of the task performing the upload. NO_TASK if the upload has
1346 GNUNET_SCHEDULER_TaskIdentifier upload_task;
1349 * Storage space to reserve for the operation.
1351 uint64_t reserve_space;
1354 * Overall number of entries to reserve for the
1355 * publish operation.
1357 uint32_t reserve_entries;
1360 * Typically GNUNET_NO. Set to GNUNET_YES if "upload_task" is
1361 * GNUNET_SCHEDULER_NO_TASK and we're waiting for a response from
1362 * the datastore service (in which case this struct must not be
1363 * freed until we have that response). If someone tries to stop the
1364 * download for good during this period, "in_network_wait" is set to
1365 * GNUNET_SYSERR which will cause the struct to be destroyed right
1366 * after we have the reply (or timeout) from the datastore service.
1368 int in_network_wait;
1371 * Options for publishing.
1373 enum GNUNET_FS_PublishOptions options;
1376 * Space reservation ID with datastore service
1382 * Set to GNUNET_YES if all processing has completed.
1389 * Phases of unindex processing (state machine).
1394 * We're currently hashing the file.
1396 UNINDEX_STATE_HASHING = 0,
1399 * We're telling the datastore to delete
1400 * the respective entries.
1402 UNINDEX_STATE_DS_REMOVE = 1,
1405 * We're notifying the FS service about
1408 UNINDEX_STATE_FS_NOTIFY = 2,
1413 UNINDEX_STATE_COMPLETE = 3,
1416 * We've encountered a fatal error.
1418 UNINDEX_STATE_ERROR = 4
1424 * Handle for controlling an unindexing operation.
1426 struct GNUNET_FS_UnindexContext
1430 * Global FS context.
1432 struct GNUNET_FS_Handle *h;
1435 * Our top-level activity entry.
1437 struct TopLevelActivity *top;
1440 * Name of the file that we are unindexing.
1445 * Short name under which we are serializing the state of this operation.
1447 char *serialization;
1450 * Connection to the FS service, only valid during the
1451 * UNINDEX_STATE_FS_NOTIFY phase.
1453 struct GNUNET_CLIENT_Connection *client;
1456 * Connection to the datastore service, only valid during the
1457 * UNINDEX_STATE_DS_NOTIFY phase.
1459 struct GNUNET_DATASTORE_Handle *dsh;
1462 * Pointer kept for the client.
1467 * Merkle-ish tree encoder context.
1469 struct GNUNET_FS_TreeEncoder *tc;
1472 * Handle used to read the file.
1474 struct GNUNET_DISK_FileHandle *fh;
1477 * Error message, NULL on success.
1482 * Context for hashing of the file.
1484 struct GNUNET_CRYPTO_FileHashContext *fhc;
1487 * Overall size of the file.
1492 * When did we start?
1494 struct GNUNET_TIME_Absolute start_time;
1497 * Hash of the file's contents (once computed).
1499 GNUNET_HashCode file_id;
1502 * Current operatinonal phase.
1504 enum UnindexState state;
1510 * Information we keep for each keyword in
1513 struct SearchRequestEntry
1516 * Hash of the original keyword, also known as the
1517 * key (for decrypting the KBlock).
1519 GNUNET_HashCode key;
1522 * Hash of the public key, also known as the query.
1524 GNUNET_HashCode query;
1527 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1528 * was found under this keyword. Note that the entries will point
1529 * to the same locations as those in the master result map (in
1530 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1531 * The key for each entry is the XOR of the key and query in the CHK
1532 * URI (as a unique identifier for the search result).
1534 struct GNUNET_CONTAINER_MultiHashMap *results;
1537 * Is this keyword a mandatory keyword
1538 * (started with '+')?
1546 * Handle for controlling a search.
1548 struct GNUNET_FS_SearchContext
1551 * Handle to the global FS context.
1553 struct GNUNET_FS_Handle *h;
1556 * Our top-level activity entry (if we are top-level, otherwise NULL).
1558 struct TopLevelActivity *top;
1561 * List of keywords that we're looking for.
1563 struct GNUNET_FS_Uri *uri;
1566 * For update-searches, link to the search result that triggered
1567 * the update search; otherwise NULL.
1569 struct GNUNET_FS_SearchResult *psearch_result;
1572 * Connection to the FS service.
1574 struct GNUNET_CLIENT_Connection *client;
1577 * Pointer we keep for the client.
1582 * Name of the file on disk we use for persistence.
1584 char *serialization;
1587 * Error message (non-NULL if this operation failed).
1592 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1593 * was found in the search. The key for each entry is the XOR of
1594 * the key and query in the CHK URI (as a unique identifier for the
1597 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1600 * Per-keyword information for a keyword search. This array will
1601 * have exactly as many entries as there were keywords.
1603 struct SearchRequestEntry *requests;
1606 * When did we start?
1608 struct GNUNET_TIME_Absolute start_time;
1611 * ID of a task that is using this struct and that must be cancelled
1612 * when the search is being stopped (if not
1613 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1614 * artificial delay when trying to reconnect to the FS service.
1616 GNUNET_SCHEDULER_TaskIdentifier task;
1619 * How many of the entries in the search request
1620 * map have been passed to the service so far?
1622 unsigned int search_request_map_offset;
1625 * How many of the keywords in the KSK
1626 * map have been passed to the service so far?
1628 unsigned int keyword_offset;
1631 * Anonymity level for the search.
1636 * Number of mandatory keywords in this query.
1638 uint32_t mandatory_count;
1641 * Options for the search.
1643 enum GNUNET_FS_SearchOptions options;
1648 * Information about an active download request.
1650 struct DownloadRequest
1653 * While pending, we keep all download requests in a linked list.
1655 struct DownloadRequest *next;
1658 * CHK for the request.
1660 struct ContentHashKey chk;
1663 * Offset of the corresponding block.
1668 * Depth of the corresponding block in the tree.
1673 * Set if this request is currently in the linked list of pending
1674 * requests. Needed in case we get a response for a request that we
1675 * have not yet send (i.e. due to two blocks with identical
1676 * content); in this case, we would need to remove the block from
1677 * the pending list (and need a fast way to check if the block is on
1686 * Closure for 'reconstruct_cont' and 'reconstruct_cb'.
1688 struct ReconstructContext;
1692 * Context for controlling a download.
1694 struct GNUNET_FS_DownloadContext
1698 * Global FS context.
1700 struct GNUNET_FS_Handle *h;
1703 * Our top-level activity entry (if we are top-level, otherwise NULL).
1705 struct TopLevelActivity *top;
1708 * Connection to the FS service.
1710 struct GNUNET_CLIENT_Connection *client;
1713 * Parent download (used when downloading files
1716 struct GNUNET_FS_DownloadContext *parent;
1719 * Associated search (used when downloading files
1720 * based on search results), or NULL for none.
1722 struct GNUNET_FS_SearchResult *search;
1725 * Head of list of child downloads.
1727 struct GNUNET_FS_DownloadContext *child_head;
1730 * Tail of list of child downloads.
1732 struct GNUNET_FS_DownloadContext *child_tail;
1735 * State for block reconstruction.
1737 struct ReconstructContext *rcc;
1740 * Previous download belonging to the same parent.
1742 struct GNUNET_FS_DownloadContext *prev;
1745 * Next download belonging to the same parent.
1747 struct GNUNET_FS_DownloadContext *next;
1750 * Context kept for the client.
1755 * URI that identifies the file that
1756 * we are downloading.
1758 struct GNUNET_FS_Uri *uri;
1761 * Known meta-data for the file (can be NULL).
1763 struct GNUNET_CONTAINER_MetaData *meta;
1766 * Error message, NULL if we're doing OK.
1771 * Random portion of filename we use for syncing state of this
1774 char *serialization;
1777 * Where are we writing the data (name of the
1778 * file, can be NULL!).
1783 * Where are we writing the data temporarily (name of the
1784 * file, can be NULL!); used if we do not have a permanent
1785 * name and we are a directory and we do a recursive download.
1787 char *temp_filename;
1790 * Map of active requests (those waiting
1791 * for a response). The key is the hash
1792 * of the encryped block (aka query).
1794 struct GNUNET_CONTAINER_MultiHashMap *active;
1797 * Linked list of pending requests.
1799 struct DownloadRequest *pending;
1802 * Non-NULL if we are currently having a request for
1803 * transmission pending with the client handle.
1805 struct GNUNET_CLIENT_TransmitHandle *th;
1808 * Our entry in the job queue.
1810 struct GNUNET_FS_QueueEntry *job_queue;
1813 * Identity of the peer having the content, or all-zeros
1814 * if we don't know of such a peer.
1816 struct GNUNET_PeerIdentity target;
1819 * ID of a task that is using this struct
1820 * and that must be cancelled when the download
1821 * is being stopped (if not GNUNET_SCHEDULER_NO_TASK).
1822 * Used for the task that adds some artificial
1823 * delay when trying to reconnect to the FS
1826 GNUNET_SCHEDULER_TaskIdentifier task;
1829 * Task used to start the download.
1831 GNUNET_SCHEDULER_TaskIdentifier start_task;
1834 * What was the size of the file on disk that we're downloading
1835 * before we started? Used to detect if there is a point in
1836 * checking an existing block on disk for matching the desired
1837 * content. 0 if the file did not exist already.
1839 uint64_t old_file_size;
1842 * What is the first offset that we're interested
1848 * How many bytes starting from offset are desired?
1849 * This is NOT the overall length of the file!
1854 * How many bytes have we already received within
1855 * the specified range (DBlocks only).
1860 * Time download was started.
1862 struct GNUNET_TIME_Absolute start_time;
1865 * Desired level of anonymity.
1870 * The depth of the file-tree.
1872 unsigned int treedepth;
1875 * Options for the download.
1877 enum GNUNET_FS_DownloadOptions options;
1880 * Flag set upon transitive completion (includes child downloads).
1881 * This flag is only set to GNUNET_YES for directories where all
1882 * child-downloads have also completed (and signalled completion).
1887 * Have we tried (and failed) to find matching full
1888 * data from the meta data yet?
1890 int tried_full_data;
1893 * Have we tried to reconstruct an IBLOCK from disk
1894 * and failed (and should hence not try again?)
1896 int reconstruct_failed;
1901 * Information about an (updateable) node in the
1904 struct NamespaceUpdateNode
1907 * Identifier for this node.
1912 * Identifier of children of this node.
1917 * Metadata for this entry.
1919 struct GNUNET_CONTAINER_MetaData *md;
1922 * URI of this entry in the namespace.
1924 struct GNUNET_FS_Uri *uri;
1927 * Namespace update generation ID. Used to ensure
1928 * freshness of the scc_id.
1933 * SCC this entry belongs to (if nug is current).
1935 unsigned int scc_id;
1940 struct GNUNET_FS_Namespace
1944 * Handle to the FS service context.
1946 struct GNUNET_FS_Handle *h;
1949 * Array with information about nodes in the namespace.
1951 struct NamespaceUpdateNode **update_nodes;
1954 * Private key for the namespace.
1956 struct GNUNET_CRYPTO_RsaPrivateKey *key;
1959 * Hash map mapping identifiers of update nodes
1960 * to the update nodes (initialized on-demand).
1962 struct GNUNET_CONTAINER_MultiHashMap *update_map;
1965 * Name of the file with the private key.
1970 * Name of the namespace.
1975 * Size of the update nodes array.
1977 unsigned int update_node_count;
1980 * Reference counter.
1985 * Generator for unique nug numbers.
1987 unsigned int nug_gen;
1992 * Message sent from a GNUnet (fs) publishing activity to the
1993 * gnunet-fs-service to initiate indexing of a file. The service is
1994 * supposed to check if the specified file is available and has the
1995 * same cryptographic hash. It should then respond with either a
1996 * confirmation or a denial.
1998 * On OSes where this works, it is considered acceptable if the
1999 * service only checks that the path, device and inode match (it can
2000 * then be assumed that the hash will also match without actually
2001 * computing it; this is an optimization that should be safe given
2002 * that the client is not our adversary).
2004 struct IndexStartMessage
2008 * Message type will be GNUNET_MESSAGE_TYPE_FS_INDEX_START.
2010 struct GNUNET_MessageHeader header;
2015 uint32_t reserved GNUNET_PACKED;
2018 * ID of device containing the file, as seen by the client. This
2019 * device ID is obtained using a call like "statvfs" (and converting
2020 * the "f_fsid" field to a 32-bit big-endian number). Use 0 if the
2021 * OS does not support this, in which case the service must do a
2022 * full hash recomputation.
2024 uint64_t device GNUNET_PACKED;
2027 * Inode of the file on the given device, as seen by the client
2028 * ("st_ino" field from "struct stat"). Use 0 if the OS does not
2029 * support this, in which case the service must do a full hash
2032 uint64_t inode GNUNET_PACKED;
2035 * Hash of the file that we would like to index.
2037 GNUNET_HashCode file_id;
2039 /* this is followed by a 0-terminated
2040 filename of a file with the hash
2041 "file_id" as seen by the client */
2047 * Message send by FS service in response to a request
2048 * asking for a list of all indexed files.
2050 struct IndexInfoMessage
2053 * Message type will be
2054 * GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY.
2056 struct GNUNET_MessageHeader header;
2061 uint32_t reserved GNUNET_PACKED;
2064 * Hash of the indexed file.
2066 GNUNET_HashCode file_id;
2068 /* this is followed by a 0-terminated
2069 filename of a file with the hash
2070 "file_id" as seen by the client */
2076 * Message sent from a GNUnet (fs) unindexing activity to the
2077 * gnunet-service-fs to indicate that a file will be unindexed. The
2078 * service is supposed to remove the file from the list of indexed
2079 * files and response with a confirmation message (even if the file
2080 * was already not on the list).
2082 struct UnindexMessage
2086 * Message type will be
2087 * GNUNET_MESSAGE_TYPE_FS_UNINDEX.
2089 struct GNUNET_MessageHeader header;
2094 uint32_t reserved GNUNET_PACKED;
2097 * Hash of the file that we will unindex.
2099 GNUNET_HashCode file_id;
2105 * Message sent from a GNUnet (fs) search activity to the
2106 * gnunet-service-fs to start a search.
2108 struct SearchMessage
2112 * Message type will be
2113 * GNUNET_MESSAGE_TYPE_FS_START_SEARCH.
2115 struct GNUNET_MessageHeader header;
2118 * Bitmask with options. Zero for no options, one for loopback-only.
2119 * Other bits are currently not defined.
2121 int32_t options GNUNET_PACKED;
2124 * Type of the content that we're looking for.
2126 uint32_t type GNUNET_PACKED;
2129 * Desired anonymity level, big-endian.
2131 uint32_t anonymity_level GNUNET_PACKED;
2134 * If the request is for a DBLOCK or IBLOCK, this is the identity of
2135 * the peer that is known to have a response. Set to all-zeros if
2136 * such a target is not known (note that even if OUR anonymity
2137 * level is >0 we may happen to know the responder's identity;
2138 * nevertheless, we should probably not use it for a DHT-lookup
2139 * or similar blunt actions in order to avoid exposing ourselves).
2141 * If the request is for an SBLOCK, this is the identity of the
2142 * pseudonym to which the SBLOCK belongs.
2144 * If the request is for a KBLOCK, "target" must be all zeros.
2146 GNUNET_HashCode target;
2149 * Hash of the keyword (aka query) for KBLOCKs; Hash of
2150 * the CHK-encoded block for DBLOCKS and IBLOCKS (aka query)
2151 * and hash of the identifier XORed with the target for
2152 * SBLOCKS (aka query).
2154 GNUNET_HashCode query;
2156 /* this is followed by the hash codes of already-known
2157 results (which should hence be excluded from what
2158 the service returns); naturally, this only applies
2159 to queries that can have multiple results, such as
2160 those for KBLOCKS (KSK) and SBLOCKS (SKS) */
2165 * Only the (mandatory) query is included.
2167 #define GET_MESSAGE_BIT_QUERY_ONLY 0
2170 * The peer identity of a peer waiting for the
2171 * reply is included (used if the response
2172 * should be transmitted to someone other than
2173 * the sender of the GET).
2175 #define GET_MESSAGE_BIT_RETURN_TO 1
2178 * The hash of the public key of the target
2179 * namespace is included (for SKS queries).
2181 #define GET_MESSAGE_BIT_SKS_NAMESPACE 2
2184 * The peer identity of a peer that had claimed to have the content
2185 * previously is included (can be used if responder-anonymity is not
2186 * desired; note that the precursor presumably lacked a direct
2187 * connection to the specified peer; still, the receiver is in no way
2188 * required to limit forwarding only to the specified peer, it should
2189 * only prefer it somewhat if possible).
2191 #define GET_MESSAGE_BIT_TRANSMIT_TO 4
2195 * Message sent between peers asking for FS-content.
2201 * Message type will be GNUNET_MESSAGE_TYPE_FS_GET.
2203 struct GNUNET_MessageHeader header;
2206 * Type of the query (block type).
2208 uint32_t type GNUNET_PACKED;
2211 * How important is this request (network byte order)
2213 uint32_t priority GNUNET_PACKED;
2216 * Relative time to live in MILLISECONDS (network byte order)
2218 int32_t ttl GNUNET_PACKED;
2221 * The content hash should be mutated using this value
2222 * before checking against the bloomfilter (used to
2223 * get many different filters for the same hash codes).
2224 * The number should be in big-endian format when used
2227 int32_t filter_mutator GNUNET_PACKED;
2230 * Which of the optional hash codes are present at the end of the
2231 * message? See GET_MESSAGE_BIT_xx constants. For each bit that is
2232 * set, an additional GNUNET_HashCode with the respective content
2233 * (in order of the bits) will be appended to the end of the GET
2236 uint32_t hash_bitmap GNUNET_PACKED;
2239 * Hashcodes of the file(s) we're looking for.
2240 * Details depend on the query type.
2242 GNUNET_HashCode query GNUNET_PACKED;
2244 /* this is followed by hash codes
2245 as specified in the "hash_bitmap";
2246 after that, an optional bloomfilter
2247 (with bits set for replies that should
2248 be suppressed) can be present */
2253 * Response from FS service with a result for a previous FS search.
2254 * Note that queries for DBLOCKS and IBLOCKS that have received a
2255 * single response are considered done. This message is transmitted
2256 * between peers as well as between the service and a client.
2262 * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
2264 struct GNUNET_MessageHeader header;
2267 * Type of the block (in big endian). Should never be zero.
2269 uint32_t type GNUNET_PACKED;
2272 * When does this result expire?
2274 struct GNUNET_TIME_AbsoluteNBO expiration;
2276 /* this is followed by the actual encrypted content */
2282 * Message send by a peer that wants to be excluded
2283 * from migration for a while.
2285 struct MigrationStopMessage
2288 * Message type will be
2289 * GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP.
2291 struct GNUNET_MessageHeader header;
2296 uint32_t reserved GNUNET_PACKED;
2299 * How long should the block last?
2301 struct GNUNET_TIME_RelativeNBO duration;