2 This file is part of GNUnet.
3 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
23 * @brief shared definitions for the FS library
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 * Pick a multiple of 2 here to achive 8-byte alignment! We also
39 * probably want DBlocks to have (roughly) the same size as IBlocks.
40 * With SHA-512, the optimal value is 32768 byte / 128 byte = 256 (128
41 * byte = 2 * 512 bits). DO NOT CHANGE!
43 #define CHK_PER_INODE 256
46 * Maximum size for a file to be considered for inlining in a
49 #define MAX_INLINE_SIZE 65536
52 * Name of the directory with top-level searches.
54 #define GNUNET_FS_SYNC_PATH_MASTER_SEARCH "search"
57 * Name of the directory with sub-searches (namespace-updates).
59 #define GNUNET_FS_SYNC_PATH_CHILD_SEARCH "search-child"
62 * Name of the directory with master downloads (not associated
63 * with search or part of another download).
65 #define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD "download"
68 * Name of the directory with downloads that are part of another
69 * download or a search.
71 #define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD "download-child"
74 * Name of the directory with publishing operations.
76 #define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH "publish"
79 * Name of the directory with files that are being published
81 #define GNUNET_FS_SYNC_PATH_FILE_INFO "publish-file"
84 * Name of the directory with unindex operations.
86 #define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX "unindex"
90 * @brief complete information needed
96 * Total size of the file in bytes. (network byte order (!))
101 * Query and key of the top GNUNET_EC_IBlock.
103 struct ContentHashKey chk;
108 * Information about a file and its location
109 * (peer claiming to share the file).
114 * Information about the shared file.
116 struct FileIdentifier fi;
119 * Identity of the peer sharing the file.
121 struct GNUNET_PeerIdentity peer;
124 * Time when this location URI expires.
126 struct GNUNET_TIME_Absolute expirationTime;
129 * Signature over the GNUNET_EC_FileIdentifier,
130 * peer identity and expiration time.
132 struct GNUNET_CRYPTO_EddsaSignature contentSignature;
138 enum GNUNET_FS_UriType
141 * Content-hash-key (simple file).
146 * Signed key space (file in namespace).
151 * Keyword search key (query with keywords).
156 * Location (chk with identity of hosting peer).
163 * A Universal Resource Identifier (URI), opaque.
170 enum GNUNET_FS_UriType type;
177 * Keywords start with a '+' if they are mandatory (in which
178 * case the '+' is NOT part of the keyword) and with a simple
179 * space if they are optional (in which case the space is ALSO
180 * not part of the actual keyword).
182 * Double-quotes to protect spaces and %-encoding are NOT used
183 * internally (only in URI-strings).
188 * Size of the keywords array.
190 unsigned int keywordCount;
196 * Identifier of the namespace.
198 struct GNUNET_CRYPTO_EcdsaPublicKey ns;
201 * Human-readable identifier chosen for this entry in the
208 * Information needed to retrieve a file (content-hash-key
211 struct FileIdentifier chk;
214 * Information needed to retrieve a file including signed
215 * location (identity of a peer) of the content.
223 * Information for a file or directory that is
224 * about to be published.
226 struct GNUNET_FS_FileInformation
229 * Files in a directory are kept as a linked list.
231 struct GNUNET_FS_FileInformation *next;
234 * If this is a file in a directory, "dir" refers to
235 * the directory; otherwise NULL.
237 struct GNUNET_FS_FileInformation *dir;
240 * Handle to the master context.
242 struct GNUNET_FS_Handle *h;
245 * Pointer kept for the client.
250 * Metadata to use for the file.
252 struct GNUNET_CONTAINER_MetaData *meta;
255 * Keywords to use for KBlocks.
257 struct GNUNET_FS_Uri *keywords;
260 * CHK for this file or directory. NULL if
261 * we have not yet computed it.
263 struct GNUNET_FS_Uri *chk_uri;
266 * SKS URI for this file or directory. NULL if
267 * we have not yet computed it.
269 struct GNUNET_FS_Uri *sks_uri;
272 * Block options for the file.
274 struct GNUNET_FS_BlockOptions bo;
277 * At what time did we start this upload?
279 struct GNUNET_TIME_Absolute start_time;
282 * Under what filename is this struct serialized
283 * (for operational persistence). Should be determined
289 * Encoder being used to publish this file.
291 struct GNUNET_FS_TreeEncoder *te;
294 * Error message (non-NULL if this operation failed).
299 * Name of the file or directory (must be an absolute path).
304 * Data describing either the file or the directory.
314 * Function that can be used to read the data for the file.
316 GNUNET_FS_DataReader reader;
319 * Closure for reader.
324 * If this file is being indexed, this value is set to the hash
325 * over the entire file (when the indexing process is started).
326 * Otherwise this field is not used.
328 struct GNUNET_HashCode file_id;
331 * Size of the file (in bytes).
336 * Should the file be indexed or inserted?
341 * Is "file_id" already valid? Set to #GNUNET_YES once the hash
342 * has been calculated.
347 * Has the service confirmed our INDEX_START request?
348 * #GNUNET_YES if this step has been completed.
350 int index_start_confirmed;
354 * Data for a directory.
359 * Linked list of entries in the directory.
361 struct GNUNET_FS_FileInformation *entries;
364 * Size of the directory itself (in bytes); 0 if the
365 * size has not yet been calculated.
370 * Pointer to the data for the directory (or NULL if not
376 * How much of the directory have we published (relative to @e contents_size).
378 uint64_t contents_completed;
381 * Sum of all of the sizes of all of the files in the directory.
383 uint64_t contents_size;
388 * Is this struct for a file or directory?
393 * Are we done publishing this file?
400 * Priorities for the queue.
402 enum GNUNET_FS_QueuePriority
405 * This is a probe (low priority).
407 GNUNET_FS_QUEUE_PRIORITY_PROBE,
412 GNUNET_FS_QUEUE_PRIORITY_NORMAL
417 * Entry in the job queue.
419 struct GNUNET_FS_QueueEntry
422 * This is a linked list.
424 struct GNUNET_FS_QueueEntry *next;
427 * This is a linked list.
429 struct GNUNET_FS_QueueEntry *prev;
432 * Function to call when the job is started.
434 GNUNET_SCHEDULER_TaskCallback start;
437 * Function to call when the job needs to stop (or is done / dequeued).
439 GNUNET_SCHEDULER_TaskCallback stop;
442 * Closure for start and stop.
447 * Handle to FS primary context.
449 struct GNUNET_FS_Handle *h;
452 * Message queue handle, or NULL if job is not running.
454 struct GNUNET_MQ_Handle *mq;
457 * Time the job was originally queued.
459 struct GNUNET_TIME_Absolute queue_time;
462 * Time the job was started last.
464 struct GNUNET_TIME_Absolute start_time;
467 * Total amount of time the job has been running (except for the
470 struct GNUNET_TIME_Relative run_time;
473 * How many blocks do the active downloads have?
478 * How important is this download?
480 enum GNUNET_FS_QueuePriority priority;
483 * How often have we (re)started this download?
485 unsigned int start_times;
488 * #GNUNET_YES if the job is active now.
495 * Information we store for each search result.
497 struct GNUNET_FS_SearchResult
500 * File-sharing context this result belongs to.
502 struct GNUNET_FS_Handle *h;
505 * Kept in a DLL while probing.
507 struct GNUNET_FS_SearchResult *next;
510 * Kept in a DLL while probing.
512 struct GNUNET_FS_SearchResult *prev;
515 * Search context this result belongs to; can be NULL
516 * for probes that come from a directory result.
518 struct GNUNET_FS_SearchContext *sc;
521 * URI to which this search result refers to.
523 struct GNUNET_FS_Uri *uri;
526 * Metadata for the search result.
528 struct GNUNET_CONTAINER_MetaData *meta;
531 * Client info for this search result.
536 * ID of a job that is currently probing this results' availability
537 * (NULL if we are not currently probing).
539 struct GNUNET_FS_DownloadContext *probe_ctx;
542 * ID of an associated download based on this search result (or
545 struct GNUNET_FS_DownloadContext *download;
548 * If this search result triggered an update search, this field
549 * links to the update search.
551 struct GNUNET_FS_SearchContext *update_search;
554 * Name under which this search result is stored on disk.
559 * Bitmap that specifies precisely which keywords have been matched already.
561 uint8_t *keyword_bitmap;
564 * Key for the search result based on the URI.
566 struct GNUNET_HashCode key;
569 * ID of the task that will clean up the probe_ctx should it not
570 * complete on time (and that will need to be cancelled if we clean
571 * up the search result before then).
573 struct GNUNET_SCHEDULER_Task *probe_cancel_task;
576 * When did the current probe become active?
578 struct GNUNET_TIME_Absolute probe_active_time;
581 * How much longer should we run the current probe before giving up?
583 struct GNUNET_TIME_Relative remaining_probe_time;
586 * Anonymity level to use for probes using this search result.
591 * Number of mandatory keywords for which we have NOT yet found the
592 * search result; when this value hits zero, the search result is
593 * given to the callback.
595 uint32_t mandatory_missing;
598 * Number of optional keywords under which this result was also
601 uint32_t optional_support;
604 * Number of availability tests that have succeeded for this result.
606 uint32_t availability_success;
609 * Number of availability trials that we have performed for this
612 uint32_t availability_trials;
617 * Add a job to the queue.
619 * @param h handle to the overall FS state
620 * @param start function to call to begin the job
621 * @param stop function to call to pause the job, or on dequeue (if the job was running)
622 * @param cls closure for start and stop
623 * @param blocks number of blocks this download has
624 * @param priority how important is this download
625 * @return queue handle
627 struct GNUNET_FS_QueueEntry *
628 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
629 GNUNET_SCHEDULER_TaskCallback start,
630 GNUNET_SCHEDULER_TaskCallback stop,
633 enum GNUNET_FS_QueuePriority priority);
637 * Dequeue a job from the queue.
639 * @param qe handle for the job
642 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe);
646 * Function that provides data by reading from a file.
648 * @param cls closure (points to the file information)
649 * @param offset offset to read from; it is possible
650 * that the caller might need to go backwards
652 * @param max maximum number of bytes that should be
653 * copied to @a buf; readers are not allowed
654 * to provide less data unless there is an error;
655 * a value of "0" will be used at the end to allow
656 * the reader to clean up its internal state
657 * @param buf where the reader should write the data
658 * @param emsg location for the reader to store an error message
659 * @return number of bytes written, usually "max", 0 on error
662 GNUNET_FS_data_reader_file_ (void *cls,
670 * Create the closure for the #GNUNET_FS_data_reader_file_() callback.
672 * @param filename file to read
673 * @return closure to use
676 GNUNET_FS_make_file_reader_context_ (const char *filename);
680 * Function that provides data by copying from a buffer.
682 * @param cls closure (points to the buffer)
683 * @param offset offset to read from; it is possible
684 * that the caller might need to go backwards
686 * @param max maximum number of bytes that should be
687 * copied to @a buf; readers are not allowed
688 * to provide less data unless there is an error;
689 * a value of "0" will be used at the end to allow
690 * the reader to clean up its internal state
691 * @param buf where the reader should write the data
692 * @param emsg location for the reader to store an error message
693 * @return number of bytes written, usually @a max, 0 on error
696 GNUNET_FS_data_reader_copy_ (void *cls,
704 * Notification of FS that a search probe has made progress.
705 * This function is used INSTEAD of the client's event handler
706 * for downloads where the #GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
708 * @param cls closure, always NULL (!), actual closure
709 * is in the client-context of the info struct
710 * @param info details about the event, specifying the event type
711 * and various bits about the event
712 * @return client-context (for the next progress call
713 * for this operation; should be set to NULL for
714 * SUSPEND and STOPPED events). The value returned
715 * will be passed to future callbacks in the respective
716 * field in the `struct GNUNET_FS_ProgressInfo`.
719 GNUNET_FS_search_probe_progress_ (void *cls,
720 const struct GNUNET_FS_ProgressInfo *info);
724 * Main function that performs the upload.
726 * @param cls `struct GNUNET_FS_PublishContext` identifies the upload
729 GNUNET_FS_publish_main_ (void *cls);
733 * Function called once the hash of the file
734 * that is being unindexed has been computed.
736 * @param cls closure, unindex context
737 * @param file_id computed hash, NULL on error
740 GNUNET_FS_unindex_process_hash_ (void *cls,
741 const struct GNUNET_HashCode *file_id);
745 * Extract the keywords for KBlock removal
747 * @param uc context for the unindex operation.
750 GNUNET_FS_unindex_do_extract_keywords_ (struct GNUNET_FS_UnindexContext *uc);
754 * If necessary, connect to the datastore and remove the KBlocks.
756 * @param uc context for the unindex operation.
759 GNUNET_FS_unindex_do_remove_kblocks_ (struct GNUNET_FS_UnindexContext *uc);
763 * Fill in all of the generic fields for a publish event and call the
766 * @param pi structure to fill in
767 * @param pc overall publishing context
768 * @param p file information for the file being published
769 * @param offset where in the file are we so far
770 * @return value returned from callback
773 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
774 struct GNUNET_FS_PublishContext *pc,
775 const struct GNUNET_FS_FileInformation *p,
780 * Fill in all of the generic fields for a download event and call the
783 * @param pi structure to fill in
784 * @param dc overall download context
787 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
788 struct GNUNET_FS_DownloadContext *dc);
792 * Task that creates the initial (top-level) download
793 * request for the file.
795 * @param cls the 'struct GNUNET_FS_DownloadContext'
798 GNUNET_FS_download_start_task_ (void *cls);
802 * Fill in all of the generic fields for
803 * an unindex event and call the callback.
805 * @param pi structure to fill in
806 * @param uc overall unindex context
807 * @param offset where we are in the file (for progress)
810 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
811 struct GNUNET_FS_UnindexContext *uc,
815 * Fill in all of the generic fields for a search event and
818 * @param pi structure to fill in
819 * @param h file-sharing handle
820 * @param sc overall search context
821 * @return value returned by the callback
824 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
825 struct GNUNET_FS_Handle *h,
826 struct GNUNET_FS_SearchContext *sc);
830 * Connect to the datastore and remove the blocks.
832 * @param uc context for the unindex operation.
835 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
838 * Build the request and actually initiate the search using the
841 * @param sc search context
842 * @return GNUNET_OK on success, GNUNET_SYSERR on error
845 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
848 * Start the downloading process (by entering the queue).
850 * @param dc our download context
853 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
857 * Start download probes for the given search result.
859 * @param sr the search result
862 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
866 * Remove serialization/deserialization file from disk.
868 * @param h master context
869 * @param ext component of the path
870 * @param ent entity identifier
873 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
879 * Remove serialization/deserialization directory from disk.
881 * @param h master context
882 * @param ext component of the path
883 * @param uni unique name of parent
886 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
892 * Synchronize this file-information struct with its mirror
893 * on disk. Note that all internal FS-operations that change
894 * file information data should already call "sync" internally,
895 * so this function is likely not useful for clients.
897 * @param fi the struct to sync
900 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
904 * Synchronize this publishing struct with its mirror
905 * on disk. Note that all internal FS-operations that change
906 * publishing structs should already call "sync" internally,
907 * so this function is likely not useful for clients.
909 * @param pc the struct to sync
912 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
916 * Synchronize this unindex struct with its mirror
917 * on disk. Note that all internal FS-operations that change
918 * publishing structs should already call "sync" internally,
919 * so this function is likely not useful for clients.
921 * @param uc the struct to sync
924 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
928 * Synchronize this search struct with its mirror
929 * on disk. Note that all internal FS-operations that change
930 * publishing structs should already call "sync" internally,
931 * so this function is likely not useful for clients.
933 * @param sc the struct to sync
936 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
940 * Synchronize this search result with its mirror
941 * on disk. Note that all internal FS-operations that change
942 * publishing structs should already call "sync" internally,
943 * so this function is likely not useful for clients.
945 * @param sr the struct to sync
948 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
952 * Synchronize this download struct with its mirror
953 * on disk. Note that all internal FS-operations that change
954 * publishing structs should already call "sync" internally,
955 * so this function is likely not useful for clients.
957 * @param dc the struct to sync
960 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
964 * Create SUSPEND event for the given publish operation
965 * and then clean up our state (without stop signal).
967 * @param cls the `struct GNUNET_FS_PublishContext` to signal for
970 GNUNET_FS_publish_signal_suspend_ (void *cls);
974 * Create SUSPEND event for the given search operation
975 * and then clean up our state (without stop signal).
977 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
980 GNUNET_FS_search_signal_suspend_ (void *cls);
984 * Create SUSPEND event for the given download operation
985 * and then clean up our state (without stop signal).
987 * @param cls the `struct GNUNET_FS_DownloadContext` to signal for
990 GNUNET_FS_download_signal_suspend_ (void *cls);
994 * Create SUSPEND event for the given unindex operation
995 * and then clean up our state (without stop signal).
997 * @param cls the `struct GNUNET_FS_UnindexContext` to signal for
1000 GNUNET_FS_unindex_signal_suspend_ (void *cls);
1004 * Function signature of the functions that can be called
1005 * to trigger suspend signals and clean-up for top-level
1008 * @param cls closure
1010 typedef void (*SuspendSignalFunction) (void *cls);
1013 * We track all of the top-level activities of FS
1014 * so that we can signal 'suspend' on shutdown.
1016 struct TopLevelActivity
1019 * This is a doubly-linked list.
1021 struct TopLevelActivity *next;
1024 * This is a doubly-linked list.
1026 struct TopLevelActivity *prev;
1029 * Function to call for suspend-signalling and clean up.
1031 SuspendSignalFunction ssf;
1034 * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
1041 * Create a top-level activity entry.
1043 * @param h global fs handle
1044 * @param ssf suspend signal function to use
1045 * @param ssf_cls closure for @a ssf
1046 * @return fresh top-level activity handle
1048 struct TopLevelActivity *
1049 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
1050 SuspendSignalFunction ssf,
1055 * Destroy a top-level activity entry.
1057 * @param h global fs handle
1058 * @param top top level activity entry
1061 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
1062 struct TopLevelActivity *top);
1066 * Master context for most FS operations.
1068 struct GNUNET_FS_Handle
1071 * Configuration to use.
1073 const struct GNUNET_CONFIGURATION_Handle *cfg;
1076 * Name of our client.
1081 * Function to call with updates on our progress.
1083 GNUNET_FS_ProgressCallback upcb;
1091 * Head of DLL of top-level activities.
1093 struct TopLevelActivity *top_head;
1096 * Tail of DLL of top-level activities.
1098 struct TopLevelActivity *top_tail;
1101 * Head of DLL of running jobs.
1103 struct GNUNET_FS_QueueEntry *running_head;
1106 * Tail of DLL of running jobs.
1108 struct GNUNET_FS_QueueEntry *running_tail;
1111 * Head of DLL of pending jobs.
1113 struct GNUNET_FS_QueueEntry *pending_head;
1116 * Tail of DLL of pending jobs.
1118 struct GNUNET_FS_QueueEntry *pending_tail;
1121 * Head of active probes.
1123 struct GNUNET_FS_SearchResult *probes_head;
1126 * Tail of active probes.
1128 struct GNUNET_FS_SearchResult *probes_tail;
1131 * Task that processes the jobs in the running and pending queues
1132 * (and moves jobs around as needed).
1134 struct GNUNET_SCHEDULER_Task *queue_job;
1137 * Task we use to report periodically to the application that
1138 * certain search probes (from @e probes_head) are still running.
1140 struct GNUNET_SCHEDULER_Task *probe_ping_task;
1143 * Average time we take for a single request to be satisfied.
1144 * FIXME: not yet calcualted properly...
1146 struct GNUNET_TIME_Relative avg_block_latency;
1149 * How many actual downloads do we have running right now?
1151 unsigned int active_downloads;
1154 * How many blocks do the active downloads have?
1156 unsigned int active_blocks;
1161 enum GNUNET_FS_Flags flags;
1164 * Maximum number of parallel downloads.
1166 unsigned int max_parallel_downloads;
1169 * Maximum number of parallel requests.
1171 unsigned int max_parallel_requests;
1176 * Handle for controlling a publication process.
1178 struct GNUNET_FS_PublishContext
1181 * Handle to the global fs context.
1183 struct GNUNET_FS_Handle *h;
1186 * Our top-level activity entry (if we are top-level, otherwise NULL).
1188 struct TopLevelActivity *top;
1191 * File-structure that is being shared.
1193 struct GNUNET_FS_FileInformation *fi;
1196 * Namespace that we are publishing in, NULL if we have no namespace.
1198 struct GNUNET_CRYPTO_EcdsaPrivateKey *ns;
1201 * ID of the content in the namespace, NULL if we have no namespace.
1206 * ID for future updates, NULL if we have no namespace or no updates.
1211 * Filename used for serializing information about this operation
1212 * (should be determined using 'mktemp').
1214 char *serialization;
1217 * Our own message queue for the FS service; only briefly used when
1218 * we start to index a file, otherwise NULL.
1220 struct GNUNET_MQ_Handle *mq;
1223 * Current position in the file-tree for the upload.
1225 struct GNUNET_FS_FileInformation *fi_pos;
1228 * Non-null if we are currently hashing a file.
1230 struct GNUNET_CRYPTO_FileHashContext *fhc;
1233 * Connection to the datastore service.
1235 struct GNUNET_DATASTORE_Handle *dsh;
1238 * Queue entry for reservation/unreservation.
1240 struct GNUNET_DATASTORE_QueueEntry *qre;
1243 * Context for SKS publishing operation that is part of this publishing operation
1244 * (NULL if not active).
1246 struct GNUNET_FS_PublishSksContext *sks_pc;
1249 * Context for KSK publishing operation that is part of this publishing operation
1250 * (NULL if not active).
1252 struct GNUNET_FS_PublishKskContext *ksk_pc;
1255 * ID of the task performing the upload. NO_TASK if the upload has
1258 struct GNUNET_SCHEDULER_Task *upload_task;
1261 * Storage space to reserve for the operation.
1263 uint64_t reserve_space;
1266 * Overall number of entries to reserve for the
1267 * publish operation.
1269 uint32_t reserve_entries;
1272 * Options for publishing.
1274 enum GNUNET_FS_PublishOptions options;
1277 * Space reservation ID with datastore service
1283 * Set to #GNUNET_YES if we were able to publish any block.
1284 * (and thus unindexing on error might make sense).
1289 * Set to #GNUNET_YES if all processing has completed.
1294 * Flag set to #GNUNET_YES if the next callback from
1295 * #GNUNET_FS_file_information_inspect should be skipped because it
1296 * is for the directory which was already processed with the parent.
1298 int skip_next_fi_callback;
1303 * Phases of unindex processing (state machine).
1308 * We're currently hashing the file.
1310 UNINDEX_STATE_HASHING = 0,
1313 * We're telling the datastore to delete
1314 * the respective DBlocks and IBlocks.
1316 UNINDEX_STATE_DS_REMOVE = 1,
1319 * Find out which keywords apply.
1321 UNINDEX_STATE_EXTRACT_KEYWORDS = 2,
1324 * We're telling the datastore to remove KBlocks.
1326 UNINDEX_STATE_DS_REMOVE_KBLOCKS = 3,
1329 * We're notifying the FS service about
1332 UNINDEX_STATE_FS_NOTIFY = 4,
1337 UNINDEX_STATE_COMPLETE = 5,
1340 * We've encountered a fatal error.
1342 UNINDEX_STATE_ERROR = 6
1347 * Handle for controlling an unindexing operation.
1349 struct GNUNET_FS_UnindexContext
1352 * The content hash key of the last block we processed, will in the
1353 * end be set to the CHK from the URI. Used to remove the KBlocks.
1355 struct ContentHashKey chk;
1358 * Global FS context.
1360 struct GNUNET_FS_Handle *h;
1363 * Our top-level activity entry.
1365 struct TopLevelActivity *top;
1368 * Directory scanner to find keywords (KBlock removal).
1370 struct GNUNET_FS_DirScanner *dscan;
1373 * Keywords found (telling us which KBlocks to remove).
1375 struct GNUNET_FS_Uri *ksk_uri;
1378 * Current offset in KSK removal.
1380 uint32_t ksk_offset;
1383 * Name of the file that we are unindexing.
1388 * Short name under which we are serializing the state of this operation.
1390 char *serialization;
1393 * Connection to the FS service, only valid during the
1394 * #UNINDEX_STATE_FS_NOTIFY phase.
1396 struct GNUNET_MQ_Handle *mq;
1399 * Connection to the datastore service, only valid during the
1400 * UNINDEX_STATE_DS_NOTIFY phase.
1402 struct GNUNET_DATASTORE_Handle *dsh;
1405 * Pointer kept for the client.
1410 * Merkle-ish tree encoder context.
1412 struct GNUNET_FS_TreeEncoder *tc;
1415 * Handle used to read the file.
1417 struct GNUNET_DISK_FileHandle *fh;
1420 * Handle to datastore 'get_key' operation issued for
1421 * obtaining KBlocks.
1423 struct GNUNET_DATASTORE_QueueEntry *dqe;
1426 * Current key for decrypting UBLocks from 'get_key' operation.
1428 struct GNUNET_HashCode ukey;
1431 * Current query of 'get_key' operation.
1433 struct GNUNET_HashCode uquery;
1436 * Error message, NULL on success.
1441 * Context for hashing of the file.
1443 struct GNUNET_CRYPTO_FileHashContext *fhc;
1446 * Overall size of the file.
1451 * When did we start?
1453 struct GNUNET_TIME_Absolute start_time;
1456 * Hash of the file's contents (once computed).
1458 struct GNUNET_HashCode file_id;
1461 * Current operatinonal phase.
1463 enum UnindexState state;
1468 * Information we keep for each keyword in a keyword search.
1470 struct SearchRequestEntry
1473 * Hash of the public key, also known as the query.
1475 struct GNUNET_HashCode uquery;
1478 * Derived public key, hashes to 'uquery'.
1480 struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
1483 * The original keyword, used to derive the
1484 * key (for decrypting the UBlock).
1489 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1490 * was found under this keyword. Note that the entries will point
1491 * to the same locations as those in the master result map (in
1492 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1493 * The key for each entry is the XOR of the key and query in the CHK
1494 * URI (as a unique identifier for the search result).
1496 struct GNUNET_CONTAINER_MultiHashMap *results;
1499 * Is this keyword a mandatory keyword
1500 * (started with '+')?
1507 * Handle for controlling a search.
1509 struct GNUNET_FS_SearchContext
1512 * Handle to the global FS context.
1514 struct GNUNET_FS_Handle *h;
1517 * Our top-level activity entry (if we are top-level, otherwise NULL).
1519 struct TopLevelActivity *top;
1522 * List of keywords that we're looking for.
1524 struct GNUNET_FS_Uri *uri;
1527 * For update-searches, link to the search result that triggered
1528 * the update search; otherwise NULL.
1530 struct GNUNET_FS_SearchResult *psearch_result;
1533 * Connection to the FS service.
1535 struct GNUNET_MQ_Handle *mq;
1538 * Pointer we keep for the client.
1543 * Name of the file on disk we use for persistence.
1545 char *serialization;
1548 * Error message (non-NULL if this operation failed).
1553 * Map that contains a `struct GNUNET_FS_SearchResult` for each result that
1554 * was found in the search. The key for each entry is the XOR of
1555 * the key and query in the CHK URI (as a unique identifier for the
1558 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1561 * Per-keyword information for a keyword search. This array will
1562 * have exactly as many entries as there were keywords.
1564 struct SearchRequestEntry *requests;
1567 * When did we start?
1569 struct GNUNET_TIME_Absolute start_time;
1572 * How long to wait before we try to reconnect to FS service?
1574 struct GNUNET_TIME_Relative reconnect_backoff;
1577 * ID of a task that is using this struct and that must be cancelled
1578 * when the search is being stopped (if not
1579 * NULL). Used for the task that adds some
1580 * artificial delay when trying to reconnect to the FS service.
1582 struct GNUNET_SCHEDULER_Task *task;
1585 * Anonymity level for the search.
1590 * Number of mandatory keywords in this query.
1592 uint32_t mandatory_count;
1595 * Options for the search.
1597 enum GNUNET_FS_SearchOptions options;
1602 * FSM for possible states a block can go through. The typical
1603 * order of progression is linear through the states, alternatives
1604 * are documented in the comments.
1606 enum BlockRequestState
1609 * Initial state, block has only been allocated (since it is
1610 * relevant to the overall download request).
1615 * We've checked the block on the path down the tree, and the
1616 * content on disk did match the desired CHK, but not all
1617 * the way down, so at the bottom some blocks will still
1618 * need to be reconstructed).
1620 BRS_RECONSTRUCT_DOWN = 1,
1623 * We've calculated the CHK bottom-up based on the meta data.
1624 * This may work, but if it did we have to write the meta data to
1625 * disk at the end (and we still need to check against the
1628 BRS_RECONSTRUCT_META_UP = 2,
1631 * We've calculated the CHK bottom-up based on what we have on
1632 * disk, which may not be what the desired CHK is. If the
1633 * reconstructed CHKs match whatever comes from above, we're
1634 * done with the respective subtree.
1636 BRS_RECONSTRUCT_UP = 3,
1639 * We've determined the real, desired CHK for this block
1640 * (full tree reconstruction failed), request is now pending.
1641 * If the CHK that bubbled up through reconstruction did match
1642 * the top-level request, the state machine for the subtree
1643 * would have moved to BRS_DOWNLOAD_UP.
1648 * We've successfully downloaded this block, but the children
1649 * still need to be either downloaded or verified (download
1650 * request propagates down). If the download fails, the
1651 * state machine for this block may move to
1652 * BRS_DOWNLOAD_ERROR instead.
1654 BRS_DOWNLOAD_DOWN = 5,
1657 * This block and all of its children have been downloaded
1658 * successfully (full completion propagates up).
1660 BRS_DOWNLOAD_UP = 6,
1663 * We got a block back that matched the query but did not hash to
1664 * the key (malicious publisher or hash collision); this block
1665 * can never be downloaded (error propagates up).
1672 * Information about an active download request.
1674 struct DownloadRequest
1677 * Parent in the CHK-tree.
1679 struct DownloadRequest *parent;
1682 * Array (!) of child-requests, or NULL for the bottom of the tree.
1684 struct DownloadRequest **children;
1687 * CHK for the request for this block (set during reconstruction
1688 * to what we have on disk, later to what we want to have).
1690 struct ContentHashKey chk;
1693 * Offset of the corresponding block. Specifically, first (!) byte of
1694 * the first DBLOCK in the subtree induced by block represented by
1700 * Number of entries in @e children array.
1702 unsigned int num_children;
1705 * Depth of the corresponding block in the tree. 0==DBLOCKs.
1710 * Offset of the CHK for this block in the parent block
1712 unsigned int chk_idx;
1717 enum BlockRequestState state;
1722 * (recursively) free download request structure
1724 * @param dr request to free
1727 GNUNET_FS_free_download_request_ (struct DownloadRequest *dr);
1731 * Stop the ping task for this search result.
1733 * @param sr result to start pinging for.
1736 GNUNET_FS_stop_probe_ping_task_ (struct GNUNET_FS_SearchResult *sr);
1740 * Context for controlling a download.
1742 struct GNUNET_FS_DownloadContext
1745 * Global FS context.
1747 struct GNUNET_FS_Handle *h;
1750 * Our top-level activity entry (if we are top-level, otherwise NULL).
1752 struct TopLevelActivity *top;
1755 * Connection to the FS service.
1757 struct GNUNET_MQ_Handle *mq;
1760 * Parent download (used when downloading files
1763 struct GNUNET_FS_DownloadContext *parent;
1766 * Associated search (used when downloading files
1767 * based on search results), or NULL for none.
1769 struct GNUNET_FS_SearchResult *search;
1772 * Head of list of child downloads.
1774 struct GNUNET_FS_DownloadContext *child_head;
1777 * Tail of list of child downloads.
1779 struct GNUNET_FS_DownloadContext *child_tail;
1782 * Previous download belonging to the same parent.
1784 struct GNUNET_FS_DownloadContext *prev;
1787 * Next download belonging to the same parent.
1789 struct GNUNET_FS_DownloadContext *next;
1792 * Context kept for the client.
1797 * URI that identifies the file that we are downloading.
1799 struct GNUNET_FS_Uri *uri;
1802 * Known meta-data for the file (can be NULL).
1804 struct GNUNET_CONTAINER_MetaData *meta;
1807 * Error message, NULL if we're doing OK.
1812 * Random portion of filename we use for syncing state of this
1815 char *serialization;
1818 * Where are we writing the data (name of the
1819 * file, can be NULL!).
1824 * Where are we writing the data temporarily (name of the
1825 * file, can be NULL!); used if we do not have a permanent
1826 * name and we are a directory and we do a recursive download.
1828 char *temp_filename;
1831 * Our entry in the job queue.
1833 struct GNUNET_FS_QueueEntry *job_queue;
1836 * Tree encoder used for the reconstruction.
1838 struct GNUNET_FS_TreeEncoder *te;
1841 * File handle for reading data from an existing file
1842 * (to pass to tree encoder).
1844 struct GNUNET_DISK_FileHandle *rfh;
1847 * Map of active requests (those waiting for a response). The key
1848 * is the hash of the encryped block (aka query).
1850 struct GNUNET_CONTAINER_MultiHashMap *active;
1853 * Top-level download request.
1855 struct DownloadRequest *top_request;
1858 * Identity of the peer having the content, or all-zeros
1859 * if we don't know of such a peer.
1861 struct GNUNET_PeerIdentity target;
1864 * ID of a task that is using this struct and that must be cancelled
1865 * when the download is being stopped (if not
1866 * NULL). Used for the task that adds some
1867 * artificial delay when trying to reconnect to the FS service or
1868 * the task processing incrementally the data on disk, or the
1869 * task requesting blocks, etc.
1871 struct GNUNET_SCHEDULER_Task *task;
1874 * What is the first offset that we're interested
1880 * How many bytes starting from offset are desired?
1881 * This is NOT the overall length of the file!
1886 * How many bytes have we already received within
1887 * the specified range (DBlocks only).
1892 * What was the size of the file on disk that we're downloading
1893 * before we started? Used to detect if there is a point in
1894 * checking an existing block on disk for matching the desired
1895 * content. 0 if the file did not exist already.
1897 uint64_t old_file_size;
1900 * Time download was started.
1902 struct GNUNET_TIME_Absolute start_time;
1905 * How long to wait before we try to reconnect to FS service?
1907 struct GNUNET_TIME_Relative reconnect_backoff;
1910 * Desired level of anonymity.
1915 * The depth of the file-tree.
1917 unsigned int treedepth;
1920 * Options for the download.
1922 enum GNUNET_FS_DownloadOptions options;
1925 * Flag set upon transitive completion (includes child downloads).
1926 * This flag is only set to #GNUNET_YES for directories where all
1927 * child-downloads have also completed (and signalled completion).
1932 * Are we ready to issue requests (reconstructions are finished)?
1940 /* end of fs_api.h */