3 This file is part of GNUnet.
4 (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
6 GNUnet is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; either version 3, or (at your
9 option) any later version.
11 GNUnet is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNUnet; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
24 * @brief definitions for the entire fs module
25 * @author Igor Wronsky, Christian Grothoff
30 #include "gnunet_constants.h"
31 #include "gnunet_datastore_service.h"
32 #include "gnunet_fs_service.h"
33 #include "gnunet_block_lib.h"
37 * Maximum size of the datastore queue for P2P operations.
39 #define MAX_DATASTORE_QUEUE 16
42 * Maximum number of blocks we keep in memory for migration.
44 #define MAX_MIGRATION_QUEUE 32
47 * How many peers do we select as possible
48 * targets per block obtained for migration?
50 #define MIGRATION_LIST_SIZE 4
53 * To how many peers do we forward each migration block ultimately?
54 * This number must be smaller or equal to MIGRATION_LIST_SIZE. Using
55 * a smaller value allows for variation in available bandwidth (for
56 * migration) between the peers.
58 #define MIGRATION_TARGET_COUNT 2
61 * Ratio for moving average delay calculation. The previous
62 * average goes in with a factor of (n-1) into the calculation.
65 #define RUNAVG_DELAY_N 16
68 * Size of the individual blocks used for file-sharing.
70 #define DBLOCK_SIZE (32*1024)
73 * Maximum legal size for a kblock.
75 #define MAX_KBLOCK_SIZE (60 * 1024)
78 * Maximum legal size for an sblock.
80 #define MAX_SBLOCK_SIZE (60 * 1024)
83 * Maximum legal size for an nblock.
85 #define MAX_NBLOCK_SIZE (60 * 1024)
88 * Pick a multiple of 2 here to achive 8-byte alignment!
89 * We also probably want DBlocks to have (roughly) the
90 * same size as IBlocks. With SHA-512, the optimal
91 * value is 32768 byte / 128 byte = 256
92 * (128 byte = 2 * 512 bits). DO NOT CHANGE!
94 #define CHK_PER_INODE 256
98 * Maximum size for a file to be considered for
99 * inlining in a directory.
101 #define MAX_INLINE_SIZE 65536
105 * Blocksize to use when hashing files
106 * for indexing (blocksize for IO, not for
107 * the DBlocks). Larger blocksizes can
108 * be more efficient but will be more disruptive
109 * as far as the scheduler is concerned.
111 #define HASHING_BLOCKSIZE (1024 * 1024)
114 * Number of bits we set per entry in the bloomfilter.
117 #define BLOOMFILTER_K 16
120 * Number of availability trials we perform per search result.
122 #define AVAILABILITY_TRIALS_MAX 8
125 * By how much (in ms) do we decrement the TTL
128 #define TTL_DECREMENT 5000
131 * Length of the P2P success tracker. Note that
132 * having a very long list can also hurt performance.
134 #define P2P_SUCCESS_LIST_SIZE 8
138 * Length of the CS-2-P success tracker. Note that
139 * having a very long list can also hurt performance.
141 #define CS2P_SUCCESS_LIST_SIZE 8
144 * How long are we willing to wait for the datastore to be ready to
145 * process a request for a query without priority?
147 #define BASIC_DATASTORE_REQUEST_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
151 * How long are we willing to wait for the core to be ready to
152 * transmit a reply to the target peer (if we can not transmit
153 * until then, we will discard the reply).
155 #define ACCEPTABLE_REPLY_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
159 * Bandwidth value of an (effectively) 0-priority query.
161 #define QUERY_BANDWIDTH_VALUE 1
164 * Bandwidth value of a 0-priority content (must be
165 * fairly high compared to query since content is
166 * typically significantly larger -- and more valueable
167 * since it can take many queries to get one piece of
170 #define CONTENT_BANDWIDTH_VALUE 800
173 * By which amount do we decrement the TTL for simple forwarding /
174 * indirection of the query; in milli-seconds. Set somewhat in
175 * accordance to your network latency (above the time it'll take you
176 * to send a packet and get a reply).
178 #define TTL_DECREMENT 5000
181 * Until which load do we consider the peer idle and do not
182 * charge at all? (should be larger than GNUNET_IDLE_LOAD_THRESHOLD used
183 * by the rest of the code)!
185 #define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
188 * Name of the directory with top-level searches.
190 #define GNUNET_FS_SYNC_PATH_MASTER_SEARCH "search"
193 * Name of the directory with sub-searches (namespace-updates).
195 #define GNUNET_FS_SYNC_PATH_CHILD_SEARCH "search-child"
198 * Name of the directory with master downloads (not associated
199 * with search or part of another download).
201 #define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD "download"
204 * Name of the directory with downloads that are part of another
205 * download or a search.
207 #define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD "download-child"
210 * Name of the directory with publishing operations.
212 #define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH "publish"
215 * Name of the directory with files that are being published
217 #define GNUNET_FS_SYNC_PATH_FILE_INFO "publish-file"
220 * Name of the directory with unindex operations.
222 #define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX "unindex"
226 * @brief content hash key
228 struct ContentHashKey
231 * Hash of the original content, used for encryption.
236 * Hash of the encrypted content, used for querying.
238 GNUNET_HashCode query;
243 * @brief complete information needed
244 * to download a file.
246 struct FileIdentifier
250 * Total size of the file in bytes. (network byte order (!))
252 uint64_t file_length;
255 * Query and key of the top GNUNET_EC_IBlock.
257 struct ContentHashKey chk;
263 * Information about a file and its location
264 * (peer claiming to share the file).
269 * Information about the shared file.
271 struct FileIdentifier fi;
274 * Identity of the peer sharing the file.
276 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
279 * Time when this location URI expires.
281 struct GNUNET_TIME_Absolute expirationTime;
284 * RSA signature over the GNUNET_EC_FileIdentifier,
285 * GNUNET_hash of the peer and expiration time.
287 struct GNUNET_CRYPTO_RsaSignature contentSignature;
297 * Content-hash-key (simple file).
302 * Signed key space (file in namespace).
307 * Keyword search key (query with keywords).
312 * Location (chk with identity of hosting peer).
318 * A Universal Resource Identifier (URI), opaque.
332 * Keywords start with a '+' if they are
333 * mandatory (in which case the '+' is NOT
334 * part of the keyword) and with a
335 * simple space if they are optional
336 * (in which case the space is ALSO not
337 * part of the actual keyword).
339 * Double-quotes to protect spaces and
340 * %-encoding are NOT used internally
341 * (only in URI-strings).
346 * Size of the keywords array.
348 unsigned int keywordCount;
354 * Hash of the public key for the namespace.
356 GNUNET_HashCode namespace;
359 * Human-readable identifier chosen for this
360 * entry in the namespace.
366 * Information needed to retrieve a file (content-hash-key
369 struct FileIdentifier chk;
372 * Information needed to retrieve a file including signed
373 * location (identity of a peer) of the content.
382 * Information for a file or directory that is
383 * about to be published.
385 struct GNUNET_FS_FileInformation
389 * Files in a directory are kept as a linked list.
391 struct GNUNET_FS_FileInformation *next;
394 * If this is a file in a directory, "dir" refers to
395 * the directory; otherwise NULL.
397 struct GNUNET_FS_FileInformation *dir;
400 * Handle to the master context.
402 struct GNUNET_FS_Handle *h;
405 * Pointer kept for the client.
410 * Metadata to use for the file.
412 struct GNUNET_CONTAINER_MetaData *meta;
415 * Keywords to use for KBlocks.
417 struct GNUNET_FS_Uri *keywords;
420 * CHK for this file or directory. NULL if
421 * we have not yet computed it.
423 struct GNUNET_FS_Uri *chk_uri;
426 * At what time should the content expire?
428 struct GNUNET_TIME_Absolute expirationTime;
431 * At what time did we start this upload?
433 struct GNUNET_TIME_Absolute start_time;
436 * Under what filename is this struct serialized
437 * (for operational persistence). Should be determined
443 * Encoder being used to publish this file.
445 struct GNUNET_FS_TreeEncoder *te;
448 * Error message (non-NULL if this operation failed).
453 * Name of the file or directory (must be an absolute path).
458 * Data describing either the file or the directory.
469 * Function that can be used to read the data for the file.
471 GNUNET_FS_DataReader reader;
474 * Closure for reader.
479 * If this file is being indexed, this value is set to the hash
480 * over the entire file (when the indexing process is started).
481 * Otherwise this field is not used.
483 GNUNET_HashCode file_id;
486 * Size of the file (in bytes).
491 * Should the file be indexed or inserted?
496 * Is "file_id" already valid? Set to GNUNET_YES once the hash
497 * has been calculated.
502 * Has the service confirmed our INDEX_START request?
503 * GNUNET_YES if this step has been completed.
505 int index_start_confirmed;
510 * Data for a directory.
515 * Linked list of entries in the directory.
517 struct GNUNET_FS_FileInformation *entries;
520 * Size of the directory itself (in bytes); 0 if the
521 * size has not yet been calculated.
526 * Pointer to the data for the directory (or NULL if not
536 * Desired anonymity level.
541 * Desired priority (for keeping the content in the DB).
546 * Is this struct for a file or directory?
551 * Are we done publishing this file?
559 * The job is now ready to run and should use the given client
560 * handle to communicate with the FS service.
563 * @param client handle to use for FS communication
565 typedef void (*GNUNET_FS_QueueStart)(void *cls,
566 struct GNUNET_CLIENT_Connection *client);
570 * The job must now stop to run and should destry the client handle as
571 * soon as possible (ideally prior to returning).
573 typedef void (*GNUNET_FS_QueueStop)(void *cls);
577 * Entry in the job queue.
579 struct GNUNET_FS_QueueEntry
582 * This is a linked list.
584 struct GNUNET_FS_QueueEntry *next;
587 * This is a linked list.
589 struct GNUNET_FS_QueueEntry *prev;
592 * Function to call when the job is started.
594 GNUNET_FS_QueueStart start;
597 * Function to call when the job needs to stop (or is done / dequeued).
599 GNUNET_FS_QueueStop stop;
602 * Closure for start and stop.
607 * Handle to FS primary context.
609 struct GNUNET_FS_Handle *h;
612 * Client handle, or NULL if job is not running.
614 struct GNUNET_CLIENT_Connection *client;
617 * Time the job was originally queued.
619 struct GNUNET_TIME_Absolute queue_time;
622 * Time the job was started last.
624 struct GNUNET_TIME_Absolute start_time;
627 * Total amount of time the job has been running (except for the
630 struct GNUNET_TIME_Relative run_time;
633 * How many blocks do the active downloads have?
638 * How often have we (re)started this download?
640 unsigned int start_times;
648 * Information we store for each search result.
650 struct GNUNET_FS_SearchResult
654 * Search context this result belongs to.
656 struct GNUNET_FS_SearchContext *sc;
659 * URI to which this search result refers to.
661 struct GNUNET_FS_Uri *uri;
664 * Metadata for the search result.
666 struct GNUNET_CONTAINER_MetaData *meta;
669 * Client info for this search result.
674 * ID of a job that is currently probing this results' availability
675 * (NULL if we are not currently probing).
677 struct GNUNET_FS_DownloadContext *probe_ctx;
680 * ID of an associated download based on this search result (or
683 struct GNUNET_FS_DownloadContext *download;
686 * If this search result triggered an update search, this field
687 * links to the update search.
689 struct GNUNET_FS_SearchContext *update_search;
692 * Name under which this search result is stored on disk.
697 * Key for the search result
702 * ID of the task that will clean up the probe_ctx should it not
703 * complete on time (and that will need to be cancelled if we clean
704 * up the search result before then).
706 GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
709 * When did the current probe become active?
711 struct GNUNET_TIME_Absolute probe_active_time;
714 * How much longer should we run the current probe before giving up?
716 struct GNUNET_TIME_Relative remaining_probe_time;
719 * Number of mandatory keywords for which we have NOT yet found the
720 * search result; when this value hits zero, the search result is
721 * given to the callback.
723 uint32_t mandatory_missing;
726 * Number of optional keywords under which this result was also
729 uint32_t optional_support;
732 * Number of availability tests that have succeeded for this result.
734 uint32_t availability_success;
737 * Number of availability trials that we have performed for this
740 uint32_t availability_trials;
746 * Add a job to the queue.
748 * @param h handle to the overall FS state
749 * @param start function to call to begin the job
750 * @param stop function to call to pause the job, or on dequeue (if the job was running)
751 * @param cls closure for start and stop
752 * @param blocks number of blocks this download has
753 * @return queue handle
755 struct GNUNET_FS_QueueEntry *
756 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
757 GNUNET_FS_QueueStart start,
758 GNUNET_FS_QueueStop stop,
760 unsigned int blocks);
764 * Dequeue a job from the queue.
765 * @param qh handle for the job
768 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh);
772 * Function that provides data by reading from a file.
774 * @param cls closure (points to the file information)
775 * @param offset offset to read from; it is possible
776 * that the caller might need to go backwards
778 * @param max maximum number of bytes that should be
779 * copied to buf; readers are not allowed
780 * to provide less data unless there is an error;
781 * a value of "0" will be used at the end to allow
782 * the reader to clean up its internal state
783 * @param buf where the reader should write the data
784 * @param emsg location for the reader to store an error message
785 * @return number of bytes written, usually "max", 0 on error
788 GNUNET_FS_data_reader_file_(void *cls,
796 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
798 * @param filename file to read
799 * @return closure to use
802 GNUNET_FS_make_file_reader_context_ (const char *filename);
807 * Function that provides data by copying from a buffer.
809 * @param cls closure (points to the buffer)
810 * @param offset offset to read from; it is possible
811 * that the caller might need to go backwards
813 * @param max maximum number of bytes that should be
814 * copied to buf; readers are not allowed
815 * to provide less data unless there is an error;
816 * a value of "0" will be used at the end to allow
817 * the reader to clean up its internal state
818 * @param buf where the reader should write the data
819 * @param emsg location for the reader to store an error message
820 * @return number of bytes written, usually "max", 0 on error
823 GNUNET_FS_data_reader_copy_(void *cls,
830 * Notification of FS that a search probe has made progress.
831 * This function is used INSTEAD of the client's event handler
832 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
834 * @param cls closure, always NULL (!), actual closure
835 * is in the client-context of the info struct
836 * @param info details about the event, specifying the event type
837 * and various bits about the event
838 * @return client-context (for the next progress call
839 * for this operation; should be set to NULL for
840 * SUSPEND and STOPPED events). The value returned
841 * will be passed to future callbacks in the respective
842 * field in the GNUNET_FS_ProgressInfo struct.
845 GNUNET_FS_search_probe_progress_ (void *cls,
846 const struct GNUNET_FS_ProgressInfo *info);
850 * Main function that performs the upload.
852 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
853 * @param tc task context
856 GNUNET_FS_publish_main_ (void *cls,
857 const struct GNUNET_SCHEDULER_TaskContext *tc);
861 * Function called once the hash of the file
862 * that is being unindexed has been computed.
864 * @param cls closure, unindex context
865 * @param file_id computed hash, NULL on error
868 GNUNET_FS_unindex_process_hash_ (void *cls,
869 const GNUNET_HashCode *file_id);
873 * Fill in all of the generic fields for a publish event and call the
876 * @param pi structure to fill in
877 * @param sc overall publishing context
878 * @param p file information for the file being published
879 * @param offset where in the file are we so far
880 * @return value returned from callback
883 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
884 struct GNUNET_FS_PublishContext *sc,
885 const struct GNUNET_FS_FileInformation *p,
890 * Fill in all of the generic fields for a download event and call the
893 * @param pi structure to fill in
894 * @param dc overall download context
897 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
898 struct GNUNET_FS_DownloadContext *dc);
902 * Fill in all of the generic fields for
903 * an unindex event and call the callback.
905 * @param pi structure to fill in
906 * @param uc overall unindex context
907 * @param offset where we are in the file (for progress)
910 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
911 struct GNUNET_FS_UnindexContext *uc,
915 * Fill in all of the generic fields for a search event and
918 * @param pi structure to fill in
919 * @param sc overall search context
920 * @return value returned by the callback
923 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
924 struct GNUNET_FS_SearchContext *sc);
928 * Connect to the datastore and remove the blocks.
930 * @param uc context for the unindex operation.
933 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
936 * Build the request and actually initiate the search using the
939 * @param sc search context
940 * @return GNUNET_OK on success, GNUNET_SYSERR on error
943 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
946 * Start the downloading process (by entering the queue).
948 * @param dc our download context
951 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
955 * Start download probes for the given search result.
957 * @param sr the search result
960 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
963 * Remove serialization/deserialization file from disk.
965 * @param h master context
966 * @param ext component of the path
967 * @param ent entity identifier
970 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
976 * Remove serialization/deserialization directory from disk.
978 * @param h master context
979 * @param ext component of the path
980 * @param uni unique name of parent
983 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
989 * Synchronize this file-information struct with its mirror
990 * on disk. Note that all internal FS-operations that change
991 * file information data should already call "sync" internally,
992 * so this function is likely not useful for clients.
994 * @param fi the struct to sync
997 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
1000 * Synchronize this publishing struct with its mirror
1001 * on disk. Note that all internal FS-operations that change
1002 * publishing structs should already call "sync" internally,
1003 * so this function is likely not useful for clients.
1005 * @param pc the struct to sync
1008 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
1011 * Synchronize this unindex struct with its mirror
1012 * on disk. Note that all internal FS-operations that change
1013 * publishing structs should already call "sync" internally,
1014 * so this function is likely not useful for clients.
1016 * @param uc the struct to sync
1019 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
1022 * Synchronize this search struct with its mirror
1023 * on disk. Note that all internal FS-operations that change
1024 * publishing structs should already call "sync" internally,
1025 * so this function is likely not useful for clients.
1027 * @param sc the struct to sync
1030 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
1033 * Synchronize this search result with its mirror
1034 * on disk. Note that all internal FS-operations that change
1035 * publishing structs should already call "sync" internally,
1036 * so this function is likely not useful for clients.
1038 * @param sr the struct to sync
1041 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
1044 * Synchronize this download struct with its mirror
1045 * on disk. Note that all internal FS-operations that change
1046 * publishing structs should already call "sync" internally,
1047 * so this function is likely not useful for clients.
1049 * @param dc the struct to sync
1052 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
1055 * Create SUSPEND event for the given publish operation
1056 * and then clean up our state (without stop signal).
1058 * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
1061 GNUNET_FS_publish_signal_suspend_ (void *cls);
1064 * Create SUSPEND event for the given search operation
1065 * and then clean up our state (without stop signal).
1067 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
1070 GNUNET_FS_search_signal_suspend_ (void *cls);
1073 * Create SUSPEND event for the given download operation
1074 * and then clean up our state (without stop signal).
1076 * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
1079 GNUNET_FS_download_signal_suspend_ (void *cls);
1082 * Create SUSPEND event for the given unindex operation
1083 * and then clean up our state (without stop signal).
1085 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
1088 GNUNET_FS_unindex_signal_suspend_ (void *cls);
1091 * Function signature of the functions that can be called
1092 * to trigger suspend signals and clean-up for top-level
1095 * @param cls closure
1097 typedef void (*SuspendSignalFunction)(void *cls);
1100 * We track all of the top-level activities of FS
1101 * so that we can signal 'suspend' on shutdown.
1103 struct TopLevelActivity
1106 * This is a doubly-linked list.
1108 struct TopLevelActivity *next;
1111 * This is a doubly-linked list.
1113 struct TopLevelActivity *prev;
1116 * Function to call for suspend-signalling and clean up.
1118 SuspendSignalFunction ssf;
1121 * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
1128 * Create a top-level activity entry.
1130 * @param h global fs handle
1131 * @param ssf suspend signal function to use
1132 * @param ssf_cls closure for ssf
1133 * @return fresh top-level activity handle
1135 struct TopLevelActivity *
1136 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
1137 SuspendSignalFunction ssf,
1142 * Destroy a top-level activity entry.
1144 * @param h global fs handle
1145 * @param top top level activity entry
1148 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
1149 struct TopLevelActivity *top);
1154 * Master context for most FS operations.
1156 struct GNUNET_FS_Handle
1161 struct GNUNET_SCHEDULER_Handle *sched;
1164 * Configuration to use.
1166 const struct GNUNET_CONFIGURATION_Handle *cfg;
1169 * Name of our client.
1174 * Function to call with updates on our progress.
1176 GNUNET_FS_ProgressCallback upcb;
1184 * Head of DLL of top-level activities.
1186 struct TopLevelActivity *top_head;
1189 * Tail of DLL of top-level activities.
1191 struct TopLevelActivity *top_tail;
1194 * Head of DLL of running jobs.
1196 struct GNUNET_FS_QueueEntry *running_head;
1199 * Tail of DLL of running jobs.
1201 struct GNUNET_FS_QueueEntry *running_tail;
1204 * Head of DLL of pending jobs.
1206 struct GNUNET_FS_QueueEntry *pending_head;
1209 * Tail of DLL of pending jobs.
1211 struct GNUNET_FS_QueueEntry *pending_tail;
1214 * Task that processes the jobs in the running and pending queues
1215 * (and moves jobs around as needed).
1217 GNUNET_SCHEDULER_TaskIdentifier queue_job;
1220 * Average time we take for a single request to be satisfied.
1221 * FIXME: not yet calcualted properly...
1223 struct GNUNET_TIME_Relative avg_block_latency;
1226 * How many actual downloads do we have running right now?
1228 unsigned int active_downloads;
1231 * How many blocks do the active downloads have?
1233 unsigned int active_blocks;
1238 enum GNUNET_FS_Flags flags;
1241 * Maximum number of parallel downloads.
1243 unsigned int max_parallel_downloads;
1246 * Maximum number of parallel requests.
1248 unsigned int max_parallel_requests;
1254 * Handle for controlling a publication process.
1256 struct GNUNET_FS_PublishContext
1259 * Handle to the global fs context.
1261 struct GNUNET_FS_Handle *h;
1264 * Our top-level activity entry (if we are top-level, otherwise NULL).
1266 struct TopLevelActivity *top;
1269 * File-structure that is being shared.
1271 struct GNUNET_FS_FileInformation *fi;
1274 * Namespace that we are publishing in, NULL if we have no namespace.
1276 struct GNUNET_FS_Namespace *namespace;
1279 * ID of the content in the namespace, NULL if we have no namespace.
1284 * ID for future updates, NULL if we have no namespace or no updates.
1289 * Filename used for serializing information about this operation
1290 * (should be determined using 'mktemp').
1292 char *serialization;
1295 * Our own client handle for the FS service; only briefly used when
1296 * we start to index a file, otherwise NULL.
1298 struct GNUNET_CLIENT_Connection *client;
1301 * Current position in the file-tree for the upload.
1303 struct GNUNET_FS_FileInformation *fi_pos;
1306 * Non-null if we are currently hashing a file.
1308 struct GNUNET_CRYPTO_FileHashContext *fhc;
1311 * Connection to the datastore service.
1313 struct GNUNET_DATASTORE_Handle *dsh;
1316 * Queue entry for reservation/unreservation.
1318 struct GNUNET_DATASTORE_QueueEntry *qre;
1321 * ID of the task performing the upload. NO_TASK if the upload has
1324 GNUNET_SCHEDULER_TaskIdentifier upload_task;
1327 * Storage space to reserve for the operation.
1329 uint64_t reserve_space;
1332 * Overall number of entries to reserve for the
1333 * publish operation.
1335 uint32_t reserve_entries;
1338 * Typically GNUNET_NO. Set to GNUNET_YES if "upload_task" is
1339 * GNUNET_SCHEDULER_NO_TASK and we're waiting for a response from
1340 * the datastore service (in which case this struct must not be
1341 * freed until we have that response). If someone tries to stop the
1342 * download for good during this period, "in_network_wait" is set to
1343 * GNUNET_SYSERR which will cause the struct to be destroyed right
1344 * after we have the reply (or timeout) from the datastore service.
1346 int in_network_wait;
1349 * Options for publishing.
1351 enum GNUNET_FS_PublishOptions options;
1354 * Space reservation ID with datastore service
1360 * Set to GNUNET_YES if all processing has completed.
1367 * Phases of unindex processing (state machine).
1372 * We're currently hashing the file.
1374 UNINDEX_STATE_HASHING = 0,
1377 * We're telling the datastore to delete
1378 * the respective entries.
1380 UNINDEX_STATE_DS_REMOVE = 1,
1383 * We're notifying the FS service about
1386 UNINDEX_STATE_FS_NOTIFY = 2,
1391 UNINDEX_STATE_COMPLETE = 3,
1394 * We've encountered a fatal error.
1396 UNINDEX_STATE_ERROR = 4
1402 * Handle for controlling an unindexing operation.
1404 struct GNUNET_FS_UnindexContext
1408 * Global FS context.
1410 struct GNUNET_FS_Handle *h;
1413 * Our top-level activity entry.
1415 struct TopLevelActivity *top;
1418 * Name of the file that we are unindexing.
1423 * Short name under which we are serializing the state of this operation.
1425 char *serialization;
1428 * Connection to the FS service, only valid during the
1429 * UNINDEX_STATE_FS_NOTIFY phase.
1431 struct GNUNET_CLIENT_Connection *client;
1434 * Connection to the datastore service, only valid during the
1435 * UNINDEX_STATE_DS_NOTIFY phase.
1437 struct GNUNET_DATASTORE_Handle *dsh;
1440 * Pointer kept for the client.
1445 * Merkle-ish tree encoder context.
1447 struct GNUNET_FS_TreeEncoder *tc;
1450 * Handle used to read the file.
1452 struct GNUNET_DISK_FileHandle *fh;
1455 * Error message, NULL on success.
1460 * Context for hashing of the file.
1462 struct GNUNET_CRYPTO_FileHashContext *fhc;
1465 * Overall size of the file.
1470 * When did we start?
1472 struct GNUNET_TIME_Absolute start_time;
1475 * Hash of the file's contents (once computed).
1477 GNUNET_HashCode file_id;
1480 * Current operatinonal phase.
1482 enum UnindexState state;
1488 * Information we keep for each keyword in
1491 struct SearchRequestEntry
1494 * Hash of the original keyword, also known as the
1495 * key (for decrypting the KBlock).
1497 GNUNET_HashCode key;
1500 * Hash of the public key, also known as the query.
1502 GNUNET_HashCode query;
1505 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1506 * was found under this keyword. Note that the entries will point
1507 * to the same locations as those in the master result map (in
1508 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1509 * The key for each entry is the XOR of the key and query in the CHK
1510 * URI (as a unique identifier for the search result).
1512 struct GNUNET_CONTAINER_MultiHashMap *results;
1515 * Is this keyword a mandatory keyword
1516 * (started with '+')?
1524 * Handle for controlling a search.
1526 struct GNUNET_FS_SearchContext
1529 * Handle to the global FS context.
1531 struct GNUNET_FS_Handle *h;
1534 * Our top-level activity entry (if we are top-level, otherwise NULL).
1536 struct TopLevelActivity *top;
1539 * List of keywords that we're looking for.
1541 struct GNUNET_FS_Uri *uri;
1544 * For update-searches, link to the search result that triggered
1545 * the update search; otherwise NULL.
1547 struct GNUNET_FS_SearchResult *psearch_result;
1550 * Connection to the FS service.
1552 struct GNUNET_CLIENT_Connection *client;
1555 * Pointer we keep for the client.
1560 * Name of the file on disk we use for persistence.
1562 char *serialization;
1565 * Error message (non-NULL if this operation failed).
1570 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1571 * was found in the search. The key for each entry is the XOR of
1572 * the key and query in the CHK URI (as a unique identifier for the
1575 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1578 * Per-keyword information for a keyword search. This array will
1579 * have exactly as many entries as there were keywords.
1581 struct SearchRequestEntry *requests;
1584 * When did we start?
1586 struct GNUNET_TIME_Absolute start_time;
1589 * ID of a task that is using this struct and that must be cancelled
1590 * when the search is being stopped (if not
1591 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1592 * artificial delay when trying to reconnect to the FS service.
1594 GNUNET_SCHEDULER_TaskIdentifier task;
1597 * Anonymity level for the search.
1602 * Number of mandatory keywords in this query.
1604 uint32_t mandatory_count;
1607 * Options for the search.
1609 enum GNUNET_FS_SearchOptions options;
1614 * Information about an active download request.
1616 struct DownloadRequest
1619 * While pending, we keep all download requests in a linked list.
1621 struct DownloadRequest *next;
1624 * CHK for the request.
1626 struct ContentHashKey chk;
1629 * Offset of the corresponding block.
1634 * Depth of the corresponding block in the tree.
1639 * Set if this request is currently in the linked list of pending
1640 * requests. Needed in case we get a response for a request that we
1641 * have not yet send (i.e. due to two blocks with identical
1642 * content); in this case, we would need to remove the block from
1643 * the pending list (and need a fast way to check if the block is on
1652 * Context for controlling a download.
1654 struct GNUNET_FS_DownloadContext
1658 * Global FS context.
1660 struct GNUNET_FS_Handle *h;
1663 * Our top-level activity entry (if we are top-level, otherwise NULL).
1665 struct TopLevelActivity *top;
1668 * Connection to the FS service.
1670 struct GNUNET_CLIENT_Connection *client;
1673 * Parent download (used when downloading files
1676 struct GNUNET_FS_DownloadContext *parent;
1679 * Associated search (used when downloading files
1680 * based on search results), or NULL for none.
1682 struct GNUNET_FS_SearchResult *search;
1685 * Head of list of child downloads.
1687 struct GNUNET_FS_DownloadContext *child_head;
1690 * Tail of list of child downloads.
1692 struct GNUNET_FS_DownloadContext *child_tail;
1695 * Previous download belonging to the same parent.
1697 struct GNUNET_FS_DownloadContext *prev;
1700 * Next download belonging to the same parent.
1702 struct GNUNET_FS_DownloadContext *next;
1705 * Context kept for the client.
1710 * URI that identifies the file that
1711 * we are downloading.
1713 struct GNUNET_FS_Uri *uri;
1716 * Known meta-data for the file (can be NULL).
1718 struct GNUNET_CONTAINER_MetaData *meta;
1721 * Error message, NULL if we're doing OK.
1726 * Random portion of filename we use for syncing state of this
1729 char *serialization;
1732 * Where are we writing the data (name of the
1733 * file, can be NULL!).
1738 * Where are we writing the data temporarily (name of the
1739 * file, can be NULL!); used if we do not have a permanent
1740 * name and we are a directory and we do a recursive download.
1742 char *temp_filename;
1745 * Map of active requests (those waiting
1746 * for a response). The key is the hash
1747 * of the encryped block (aka query).
1749 struct GNUNET_CONTAINER_MultiHashMap *active;
1752 * Linked list of pending requests.
1754 struct DownloadRequest *pending;
1757 * Non-NULL if we are currently having a request for
1758 * transmission pending with the client handle.
1760 struct GNUNET_CLIENT_TransmitHandle *th;
1763 * Our entry in the job queue.
1765 struct GNUNET_FS_QueueEntry *job_queue;
1768 * Identity of the peer having the content, or all-zeros
1769 * if we don't know of such a peer.
1771 struct GNUNET_PeerIdentity target;
1774 * ID of a task that is using this struct
1775 * and that must be cancelled when the download
1776 * is being stopped (if not GNUNET_SCHEDULER_NO_TASK).
1777 * Used for the task that adds some artificial
1778 * delay when trying to reconnect to the FS
1781 GNUNET_SCHEDULER_TaskIdentifier task;
1784 * What was the size of the file on disk that we're downloading
1785 * before we started? Used to detect if there is a point in
1786 * checking an existing block on disk for matching the desired
1787 * content. 0 if the file did not exist already.
1789 uint64_t old_file_size;
1792 * What is the first offset that we're interested
1798 * How many bytes starting from offset are desired?
1799 * This is NOT the overall length of the file!
1804 * How many bytes have we already received within
1805 * the specified range (DBlocks only).
1810 * Time download was started.
1812 struct GNUNET_TIME_Absolute start_time;
1815 * Desired level of anonymity.
1820 * The depth of the file-tree.
1822 unsigned int treedepth;
1825 * Options for the download.
1827 enum GNUNET_FS_DownloadOptions options;
1830 * Flag set upon transitive completion (includes child downloads).
1831 * This flag is only set to GNUNET_YES for directories where all
1832 * child-downloads have also completed (and signalled completion).
1837 * Have we tried (and failed) to find matching full
1838 * data from the meta data yet?
1840 int tried_full_data;
1845 * Information about an (updateable) node in the
1848 struct NamespaceUpdateNode
1851 * Identifier for this node.
1856 * Identifier of children of this node.
1861 * Metadata for this entry.
1863 struct GNUNET_CONTAINER_MetaData *md;
1866 * URI of this entry in the namespace.
1868 struct GNUNET_FS_Uri *uri;
1871 * Namespace update generation ID. Used to ensure
1872 * freshness of the scc_id.
1877 * SCC this entry belongs to (if nug is current).
1879 unsigned int scc_id;
1884 struct GNUNET_FS_Namespace
1888 * Handle to the FS service context.
1890 struct GNUNET_FS_Handle *h;
1893 * Array with information about nodes in the namespace.
1895 struct NamespaceUpdateNode **update_nodes;
1898 * Private key for the namespace.
1900 struct GNUNET_CRYPTO_RsaPrivateKey *key;
1903 * Hash map mapping identifiers of update nodes
1904 * to the update nodes (initialized on-demand).
1906 struct GNUNET_CONTAINER_MultiHashMap *update_map;
1909 * Name of the file with the private key.
1914 * Name of the namespace.
1919 * Size of the update nodes array.
1921 unsigned int update_node_count;
1924 * Reference counter.
1929 * Generator for unique nug numbers.
1931 unsigned int nug_gen;
1936 * Message sent from a GNUnet (fs) publishing activity to the
1937 * gnunet-fs-service to initiate indexing of a file. The service is
1938 * supposed to check if the specified file is available and has the
1939 * same cryptographic hash. It should then respond with either a
1940 * confirmation or a denial.
1942 * On OSes where this works, it is considered acceptable if the
1943 * service only checks that the path, device and inode match (it can
1944 * then be assumed that the hash will also match without actually
1945 * computing it; this is an optimization that should be safe given
1946 * that the client is not our adversary).
1948 struct IndexStartMessage
1952 * Message type will be GNUNET_MESSAGE_TYPE_FS_INDEX_START.
1954 struct GNUNET_MessageHeader header;
1959 uint32_t reserved GNUNET_PACKED;
1962 * ID of device containing the file, as seen by the client. This
1963 * device ID is obtained using a call like "statvfs" (and converting
1964 * the "f_fsid" field to a 32-bit big-endian number). Use 0 if the
1965 * OS does not support this, in which case the service must do a
1966 * full hash recomputation.
1968 uint64_t device GNUNET_PACKED;
1971 * Inode of the file on the given device, as seen by the client
1972 * ("st_ino" field from "struct stat"). Use 0 if the OS does not
1973 * support this, in which case the service must do a full hash
1976 uint64_t inode GNUNET_PACKED;
1979 * Hash of the file that we would like to index.
1981 GNUNET_HashCode file_id;
1983 /* this is followed by a 0-terminated
1984 filename of a file with the hash
1985 "file_id" as seen by the client */
1991 * Message send by FS service in response to a request
1992 * asking for a list of all indexed files.
1994 struct IndexInfoMessage
1997 * Message type will be
1998 * GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY.
2000 struct GNUNET_MessageHeader header;
2005 uint32_t reserved GNUNET_PACKED;
2008 * Hash of the indexed file.
2010 GNUNET_HashCode file_id;
2012 /* this is followed by a 0-terminated
2013 filename of a file with the hash
2014 "file_id" as seen by the client */
2020 * Message sent from a GNUnet (fs) unindexing activity to the
2021 * gnunet-service-fs to indicate that a file will be unindexed. The
2022 * service is supposed to remove the file from the list of indexed
2023 * files and response with a confirmation message (even if the file
2024 * was already not on the list).
2026 struct UnindexMessage
2030 * Message type will be
2031 * GNUNET_MESSAGE_TYPE_FS_UNINDEX.
2033 struct GNUNET_MessageHeader header;
2038 uint32_t reserved GNUNET_PACKED;
2041 * Hash of the file that we will unindex.
2043 GNUNET_HashCode file_id;
2049 * Message sent from a GNUnet (fs) search activity to the
2050 * gnunet-service-fs to start a search.
2052 struct SearchMessage
2056 * Message type will be
2057 * GNUNET_MESSAGE_TYPE_FS_START_SEARCH.
2059 struct GNUNET_MessageHeader header;
2062 * Bitmask with options. Zero for no options, one for loopback-only.
2063 * Other bits are currently not defined.
2065 int32_t options GNUNET_PACKED;
2068 * Type of the content that we're looking for.
2070 uint32_t type GNUNET_PACKED;
2073 * Desired anonymity level, big-endian.
2075 uint32_t anonymity_level GNUNET_PACKED;
2078 * If the request is for a DBLOCK or IBLOCK, this is the identity of
2079 * the peer that is known to have a response. Set to all-zeros if
2080 * such a target is not known (note that even if OUR anonymity
2081 * level is >0 we may happen to know the responder's identity;
2082 * nevertheless, we should probably not use it for a DHT-lookup
2083 * or similar blunt actions in order to avoid exposing ourselves).
2085 * If the request is for an SBLOCK, this is the identity of the
2086 * pseudonym to which the SBLOCK belongs.
2088 * If the request is for a KBLOCK, "target" must be all zeros.
2090 GNUNET_HashCode target;
2093 * Hash of the keyword (aka query) for KBLOCKs; Hash of
2094 * the CHK-encoded block for DBLOCKS and IBLOCKS (aka query)
2095 * and hash of the identifier XORed with the target for
2096 * SBLOCKS (aka query).
2098 GNUNET_HashCode query;
2100 /* this is followed by the hash codes of already-known
2101 results (which should hence be excluded from what
2102 the service returns); naturally, this only applies
2103 to queries that can have multiple results, such as
2104 those for KBLOCKS (KSK) and SBLOCKS (SKS) */
2109 * Only the (mandatory) query is included.
2111 #define GET_MESSAGE_BIT_QUERY_ONLY 0
2114 * The peer identity of a peer waiting for the
2115 * reply is included (used if the response
2116 * should be transmitted to someone other than
2117 * the sender of the GET).
2119 #define GET_MESSAGE_BIT_RETURN_TO 1
2122 * The hash of the public key of the target
2123 * namespace is included (for SKS queries).
2125 #define GET_MESSAGE_BIT_SKS_NAMESPACE 2
2128 * The peer identity of a peer that had claimed to have the content
2129 * previously is included (can be used if responder-anonymity is not
2130 * desired; note that the precursor presumably lacked a direct
2131 * connection to the specified peer; still, the receiver is in no way
2132 * required to limit forwarding only to the specified peer, it should
2133 * only prefer it somewhat if possible).
2135 #define GET_MESSAGE_BIT_TRANSMIT_TO 4
2139 * Message sent between peers asking for FS-content.
2145 * Message type will be GNUNET_MESSAGE_TYPE_FS_GET.
2147 struct GNUNET_MessageHeader header;
2150 * Type of the query (block type).
2152 uint32_t type GNUNET_PACKED;
2155 * How important is this request (network byte order)
2157 uint32_t priority GNUNET_PACKED;
2160 * Relative time to live in MILLISECONDS (network byte order)
2162 int32_t ttl GNUNET_PACKED;
2165 * The content hash should be mutated using this value
2166 * before checking against the bloomfilter (used to
2167 * get many different filters for the same hash codes).
2168 * The number should be in big-endian format when used
2171 int32_t filter_mutator GNUNET_PACKED;
2174 * Which of the optional hash codes are present at the end of the
2175 * message? See GET_MESSAGE_BIT_xx constants. For each bit that is
2176 * set, an additional GNUNET_HashCode with the respective content
2177 * (in order of the bits) will be appended to the end of the GET
2180 uint32_t hash_bitmap GNUNET_PACKED;
2183 * Hashcodes of the file(s) we're looking for.
2184 * Details depend on the query type.
2186 GNUNET_HashCode query GNUNET_PACKED;
2188 /* this is followed by hash codes
2189 as specified in the "hash_bitmap";
2190 after that, an optional bloomfilter
2191 (with bits set for replies that should
2192 be suppressed) can be present */
2197 * Response from FS service with a result for a previous FS search.
2198 * Note that queries for DBLOCKS and IBLOCKS that have received a
2199 * single response are considered done. This message is transmitted
2200 * between peers as well as between the service and a client.
2206 * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
2208 struct GNUNET_MessageHeader header;
2211 * Type of the block (in big endian). Should never be zero.
2213 uint32_t type GNUNET_PACKED;
2216 * When does this result expire?
2218 struct GNUNET_TIME_AbsoluteNBO expiration;
2220 /* this is followed by the actual encrypted content */
2226 * Message send by a peer that wants to be excluded
2227 * from migration for a while.
2229 struct MigrationStopMessage
2232 * Message type will be
2233 * GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP.
2235 struct GNUNET_MessageHeader header;
2240 uint32_t reserved GNUNET_PACKED;
2243 * How long should the block last?
2245 struct GNUNET_TIME_RelativeNBO duration;