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 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
97 * Total size of the file in bytes. (network byte order (!))
102 * Query and key of the top GNUNET_EC_IBlock.
104 struct ContentHashKey chk;
110 * Information about a file and its location
111 * (peer claiming to share the file).
116 * Information about the shared file.
118 struct FileIdentifier fi;
121 * Identity of the peer sharing the file.
123 struct GNUNET_PeerIdentity peer;
126 * Time when this location URI expires.
128 struct GNUNET_TIME_Absolute expirationTime;
131 * Signature over the GNUNET_EC_FileIdentifier,
132 * peer identity and expiration time.
134 struct GNUNET_CRYPTO_EddsaSignature contentSignature;
141 enum GNUNET_FS_UriType
144 * Content-hash-key (simple file).
149 * Signed key space (file in namespace).
154 * Keyword search key (query with keywords).
159 * Location (chk with identity of hosting peer).
166 * A Universal Resource Identifier (URI), opaque.
173 enum GNUNET_FS_UriType type;
180 * Keywords start with a '+' if they are mandatory (in which
181 * case the '+' is NOT part of the keyword) and with a simple
182 * space if they are optional (in which case the space is ALSO
183 * not part of the actual keyword).
185 * Double-quotes to protect spaces and %-encoding are NOT used
186 * internally (only in URI-strings).
191 * Size of the keywords array.
193 unsigned int keywordCount;
199 * Identifier of the namespace.
201 struct GNUNET_CRYPTO_EcdsaPublicKey ns;
204 * Human-readable identifier chosen for this entry in the
212 * Information needed to retrieve a file (content-hash-key
215 struct FileIdentifier chk;
218 * Information needed to retrieve a file including signed
219 * location (identity of a peer) of the content.
228 * Information for a file or directory that is
229 * about to be published.
231 struct GNUNET_FS_FileInformation
235 * Files in a directory are kept as a linked list.
237 struct GNUNET_FS_FileInformation *next;
240 * If this is a file in a directory, "dir" refers to
241 * the directory; otherwise NULL.
243 struct GNUNET_FS_FileInformation *dir;
246 * Handle to the master context.
248 struct GNUNET_FS_Handle *h;
251 * Pointer kept for the client.
256 * Metadata to use for the file.
258 struct GNUNET_CONTAINER_MetaData *meta;
261 * Keywords to use for KBlocks.
263 struct GNUNET_FS_Uri *keywords;
266 * CHK for this file or directory. NULL if
267 * we have not yet computed it.
269 struct GNUNET_FS_Uri *chk_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.
316 * Function that can be used to read the data for the file.
318 GNUNET_FS_DataReader reader;
321 * Closure for reader.
326 * If this file is being indexed, this value is set to the hash
327 * over the entire file (when the indexing process is started).
328 * Otherwise this field is not used.
330 struct GNUNET_HashCode file_id;
333 * Size of the file (in bytes).
338 * Should the file be indexed or inserted?
343 * Is "file_id" already valid? Set to #GNUNET_YES once the hash
344 * has been calculated.
349 * Has the service confirmed our INDEX_START request?
350 * #GNUNET_YES if this step has been completed.
352 int index_start_confirmed;
357 * Data for a directory.
363 * Linked list of entries in the directory.
365 struct GNUNET_FS_FileInformation *entries;
368 * Size of the directory itself (in bytes); 0 if the
369 * size has not yet been calculated.
374 * Pointer to the data for the directory (or NULL if not
380 * How much of the directory have we published (relative to @e contents_size).
382 uint64_t contents_completed;
385 * Sum of all of the sizes of all of the files in the directory.
387 uint64_t contents_size;
394 * Is this struct for a file or directory?
399 * Are we done publishing this file?
407 * The job is now ready to run and should use the given client
408 * handle to communicate with the FS service.
411 * @param client handle to use for FS communication
413 typedef void (*GNUNET_FS_QueueStart) (void *cls,
414 struct GNUNET_CLIENT_Connection * client);
418 * The job must now stop to run and should destry the client handle as
419 * soon as possible (ideally prior to returning).
421 typedef void (*GNUNET_FS_QueueStop) (void *cls);
426 * Priorities for the queue.
428 enum GNUNET_FS_QueuePriority
431 * This is a probe (low priority).
433 GNUNET_FS_QUEUE_PRIORITY_PROBE,
438 GNUNET_FS_QUEUE_PRIORITY_NORMAL
443 * Entry in the job queue.
445 struct GNUNET_FS_QueueEntry
448 * This is a linked list.
450 struct GNUNET_FS_QueueEntry *next;
453 * This is a linked list.
455 struct GNUNET_FS_QueueEntry *prev;
458 * Function to call when the job is started.
460 GNUNET_FS_QueueStart start;
463 * Function to call when the job needs to stop (or is done / dequeued).
465 GNUNET_FS_QueueStop stop;
468 * Closure for start and stop.
473 * Handle to FS primary context.
475 struct GNUNET_FS_Handle *h;
478 * Client handle, or NULL if job is not running.
480 struct GNUNET_CLIENT_Connection *client;
483 * Time the job was originally queued.
485 struct GNUNET_TIME_Absolute queue_time;
488 * Time the job was started last.
490 struct GNUNET_TIME_Absolute start_time;
493 * Total amount of time the job has been running (except for the
496 struct GNUNET_TIME_Relative run_time;
499 * How many blocks do the active downloads have?
504 * How important is this download?
506 enum GNUNET_FS_QueuePriority priority;
509 * How often have we (re)started this download?
511 unsigned int start_times;
517 * Information we store for each search result.
519 struct GNUNET_FS_SearchResult
523 * File-sharing context this result belongs to.
525 struct GNUNET_FS_Handle *h;
528 * Search context this result belongs to; can be NULL
529 * for probes that come from a directory result.
531 struct GNUNET_FS_SearchContext *sc;
534 * URI to which this search result refers to.
536 struct GNUNET_FS_Uri *uri;
539 * Metadata for the search result.
541 struct GNUNET_CONTAINER_MetaData *meta;
544 * Client info for this search result.
549 * ID of a job that is currently probing this results' availability
550 * (NULL if we are not currently probing).
552 struct GNUNET_FS_DownloadContext *probe_ctx;
555 * ID of an associated download based on this search result (or
558 struct GNUNET_FS_DownloadContext *download;
561 * If this search result triggered an update search, this field
562 * links to the update search.
564 struct GNUNET_FS_SearchContext *update_search;
567 * Name under which this search result is stored on disk.
572 * Bitmap that specifies precisely which keywords have been matched already.
574 uint8_t *keyword_bitmap;
577 * Key for the search result
579 struct GNUNET_HashCode key;
582 * ID of the task that will clean up the probe_ctx should it not
583 * complete on time (and that will need to be cancelled if we clean
584 * up the search result before then).
586 GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
589 * Task we use to report periodically to the application that the
590 * probe is still running.
592 GNUNET_SCHEDULER_TaskIdentifier probe_ping_task;
595 * When did the current probe become active?
597 struct GNUNET_TIME_Absolute probe_active_time;
600 * How much longer should we run the current probe before giving up?
602 struct GNUNET_TIME_Relative remaining_probe_time;
605 * Anonymity level to use for probes using this search result.
610 * Number of mandatory keywords for which we have NOT yet found the
611 * search result; when this value hits zero, the search result is
612 * given to the callback.
614 uint32_t mandatory_missing;
617 * Number of optional keywords under which this result was also
620 uint32_t optional_support;
623 * Number of availability tests that have succeeded for this result.
625 uint32_t availability_success;
628 * Number of availability trials that we have performed for this
631 uint32_t availability_trials;
637 * Add a job to the queue.
639 * @param h handle to the overall FS state
640 * @param start function to call to begin the job
641 * @param stop function to call to pause the job, or on dequeue (if the job was running)
642 * @param cls closure for start and stop
643 * @param blocks number of blocks this download has
644 * @param priority how important is this download
645 * @return queue handle
647 struct GNUNET_FS_QueueEntry *
648 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
649 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
650 enum GNUNET_FS_QueuePriority priority);
654 * Dequeue a job from the queue.
656 * @param qe handle for the job
659 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe);
663 * Function that provides data by reading from a file.
665 * @param cls closure (points to the file information)
666 * @param offset offset to read from; it is possible
667 * that the caller might need to go backwards
669 * @param max maximum number of bytes that should be
670 * copied to buf; readers are not allowed
671 * to provide less data unless there is an error;
672 * a value of "0" will be used at the end to allow
673 * the reader to clean up its internal state
674 * @param buf where the reader should write the data
675 * @param emsg location for the reader to store an error message
676 * @return number of bytes written, usually "max", 0 on error
679 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
684 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
686 * @param filename file to read
687 * @return closure to use
690 GNUNET_FS_make_file_reader_context_ (const char *filename);
695 * Function that provides data by copying from a buffer.
697 * @param cls closure (points to the buffer)
698 * @param offset offset to read from; it is possible
699 * that the caller might need to go backwards
701 * @param max maximum number of bytes that should be
702 * copied to buf; readers are not allowed
703 * to provide less data unless there is an error;
704 * a value of "0" will be used at the end to allow
705 * the reader to clean up its internal state
706 * @param buf where the reader should write the data
707 * @param emsg location for the reader to store an error message
708 * @return number of bytes written, usually "max", 0 on error
711 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
716 * Notification of FS that a search probe has made progress.
717 * This function is used INSTEAD of the client's event handler
718 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
720 * @param cls closure, always NULL (!), actual closure
721 * is in the client-context of the info struct
722 * @param info details about the event, specifying the event type
723 * and various bits about the event
724 * @return client-context (for the next progress call
725 * for this operation; should be set to NULL for
726 * SUSPEND and STOPPED events). The value returned
727 * will be passed to future callbacks in the respective
728 * field in the GNUNET_FS_ProgressInfo struct.
731 GNUNET_FS_search_probe_progress_ (void *cls,
732 const struct GNUNET_FS_ProgressInfo *info);
736 * Main function that performs the upload.
738 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
739 * @param tc task context
742 GNUNET_FS_publish_main_ (void *cls,
743 const struct GNUNET_SCHEDULER_TaskContext *tc);
747 * Function called once the hash of the file
748 * that is being unindexed has been computed.
750 * @param cls closure, unindex context
751 * @param file_id computed hash, NULL on error
754 GNUNET_FS_unindex_process_hash_ (void *cls, const struct GNUNET_HashCode * file_id);
758 * Extract the keywords for KBlock removal
760 * @param uc context for the unindex operation.
763 GNUNET_FS_unindex_do_extract_keywords_ (struct GNUNET_FS_UnindexContext *uc);
767 * If necessary, connect to the datastore and remove the KBlocks.
769 * @param uc context for the unindex operation.
772 GNUNET_FS_unindex_do_remove_kblocks_ (struct GNUNET_FS_UnindexContext *uc);
776 * Fill in all of the generic fields for a publish event and call the
779 * @param pi structure to fill in
780 * @param pc overall publishing context
781 * @param p file information for the file being published
782 * @param offset where in the file are we so far
783 * @return value returned from callback
786 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
787 struct GNUNET_FS_PublishContext *pc,
788 const struct GNUNET_FS_FileInformation *p,
793 * Fill in all of the generic fields for a download event and call the
796 * @param pi structure to fill in
797 * @param dc overall download context
800 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
801 struct GNUNET_FS_DownloadContext *dc);
805 * Task that creates the initial (top-level) download
806 * request for the file.
808 * @param cls the 'struct GNUNET_FS_DownloadContext'
809 * @param tc scheduler context
812 GNUNET_FS_download_start_task_ (void *cls,
813 const struct GNUNET_SCHEDULER_TaskContext *tc);
818 * Fill in all of the generic fields for
819 * an unindex event and call the callback.
821 * @param pi structure to fill in
822 * @param uc overall unindex context
823 * @param offset where we are in the file (for progress)
826 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
827 struct GNUNET_FS_UnindexContext *uc,
831 * Fill in all of the generic fields for a search event and
834 * @param pi structure to fill in
835 * @param h file-sharing handle
836 * @param sc overall search context
837 * @return value returned by the callback
840 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
841 struct GNUNET_FS_Handle *h,
842 struct GNUNET_FS_SearchContext *sc);
846 * Connect to the datastore and remove the blocks.
848 * @param uc context for the unindex operation.
851 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
854 * Build the request and actually initiate the search using the
857 * @param sc search context
858 * @return GNUNET_OK on success, GNUNET_SYSERR on error
861 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
864 * Start the downloading process (by entering the queue).
866 * @param dc our download context
869 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
873 * Start download probes for the given search result.
875 * @param sr the search result
878 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
881 * Remove serialization/deserialization file from disk.
883 * @param h master context
884 * @param ext component of the path
885 * @param ent entity identifier
888 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
893 * Remove serialization/deserialization directory from disk.
895 * @param h master context
896 * @param ext component of the path
897 * @param uni unique name of parent
900 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
905 * Synchronize this file-information struct with its mirror
906 * on disk. Note that all internal FS-operations that change
907 * file information data should already call "sync" internally,
908 * so this function is likely not useful for clients.
910 * @param fi the struct to sync
913 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
917 * Synchronize this publishing struct with its mirror
918 * on disk. Note that all internal FS-operations that change
919 * publishing structs should already call "sync" internally,
920 * so this function is likely not useful for clients.
922 * @param pc the struct to sync
925 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
929 * Synchronize this unindex struct with its mirror
930 * on disk. Note that all internal FS-operations that change
931 * publishing structs should already call "sync" internally,
932 * so this function is likely not useful for clients.
934 * @param uc the struct to sync
937 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
941 * Synchronize this search struct with its mirror
942 * on disk. Note that all internal FS-operations that change
943 * publishing structs should already call "sync" internally,
944 * so this function is likely not useful for clients.
946 * @param sc the struct to sync
949 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
953 * Synchronize this search result with its mirror
954 * on disk. Note that all internal FS-operations that change
955 * publishing structs should already call "sync" internally,
956 * so this function is likely not useful for clients.
958 * @param sr the struct to sync
961 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
965 * Synchronize this download struct with its mirror
966 * on disk. Note that all internal FS-operations that change
967 * publishing structs should already call "sync" internally,
968 * so this function is likely not useful for clients.
970 * @param dc the struct to sync
973 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
977 * Create SUSPEND event for the given publish operation
978 * and then clean up our state (without stop signal).
980 * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
983 GNUNET_FS_publish_signal_suspend_ (void *cls);
987 * Create SUSPEND event for the given search operation
988 * and then clean up our state (without stop signal).
990 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
993 GNUNET_FS_search_signal_suspend_ (void *cls);
997 * Create SUSPEND event for the given download operation
998 * and then clean up our state (without stop signal).
1000 * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
1003 GNUNET_FS_download_signal_suspend_ (void *cls);
1007 * Create SUSPEND event for the given unindex operation
1008 * and then clean up our state (without stop signal).
1010 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
1013 GNUNET_FS_unindex_signal_suspend_ (void *cls);
1017 * Function signature of the functions that can be called
1018 * to trigger suspend signals and clean-up for top-level
1021 * @param cls closure
1023 typedef void (*SuspendSignalFunction) (void *cls);
1026 * We track all of the top-level activities of FS
1027 * so that we can signal 'suspend' on shutdown.
1029 struct TopLevelActivity
1032 * This is a doubly-linked list.
1034 struct TopLevelActivity *next;
1037 * This is a doubly-linked list.
1039 struct TopLevelActivity *prev;
1042 * Function to call for suspend-signalling and clean up.
1044 SuspendSignalFunction ssf;
1047 * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
1054 * Create a top-level activity entry.
1056 * @param h global fs handle
1057 * @param ssf suspend signal function to use
1058 * @param ssf_cls closure for @a ssf
1059 * @return fresh top-level activity handle
1061 struct TopLevelActivity *
1062 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
1063 SuspendSignalFunction ssf,
1068 * Destroy a top-level activity entry.
1070 * @param h global fs handle
1071 * @param top top level activity entry
1074 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
1075 struct TopLevelActivity *top);
1080 * Master context for most FS operations.
1082 struct GNUNET_FS_Handle
1085 * Configuration to use.
1087 const struct GNUNET_CONFIGURATION_Handle *cfg;
1090 * Name of our client.
1095 * Function to call with updates on our progress.
1097 GNUNET_FS_ProgressCallback upcb;
1105 * Head of DLL of top-level activities.
1107 struct TopLevelActivity *top_head;
1110 * Tail of DLL of top-level activities.
1112 struct TopLevelActivity *top_tail;
1115 * Head of DLL of running jobs.
1117 struct GNUNET_FS_QueueEntry *running_head;
1120 * Tail of DLL of running jobs.
1122 struct GNUNET_FS_QueueEntry *running_tail;
1125 * Head of DLL of pending jobs.
1127 struct GNUNET_FS_QueueEntry *pending_head;
1130 * Tail of DLL of pending jobs.
1132 struct GNUNET_FS_QueueEntry *pending_tail;
1135 * Task that processes the jobs in the running and pending queues
1136 * (and moves jobs around as needed).
1138 GNUNET_SCHEDULER_TaskIdentifier queue_job;
1141 * Average time we take for a single request to be satisfied.
1142 * FIXME: not yet calcualted properly...
1144 struct GNUNET_TIME_Relative avg_block_latency;
1147 * How many actual downloads do we have running right now?
1149 unsigned int active_downloads;
1152 * How many blocks do the active downloads have?
1154 unsigned int active_blocks;
1159 enum GNUNET_FS_Flags flags;
1162 * Maximum number of parallel downloads.
1164 unsigned int max_parallel_downloads;
1167 * Maximum number of parallel requests.
1169 unsigned int max_parallel_requests;
1175 * Handle for controlling a publication process.
1177 struct GNUNET_FS_PublishContext
1180 * Handle to the global fs context.
1182 struct GNUNET_FS_Handle *h;
1185 * Our top-level activity entry (if we are top-level, otherwise NULL).
1187 struct TopLevelActivity *top;
1190 * File-structure that is being shared.
1192 struct GNUNET_FS_FileInformation *fi;
1195 * Namespace that we are publishing in, NULL if we have no namespace.
1197 struct GNUNET_CRYPTO_EcdsaPrivateKey *ns;
1200 * ID of the content in the namespace, NULL if we have no namespace.
1205 * ID for future updates, NULL if we have no namespace or no updates.
1210 * Filename used for serializing information about this operation
1211 * (should be determined using 'mktemp').
1213 char *serialization;
1216 * Our own client handle for the FS service; only briefly used when
1217 * we start to index a file, otherwise NULL.
1219 struct GNUNET_CLIENT_Connection *client;
1222 * Current position in the file-tree for the upload.
1224 struct GNUNET_FS_FileInformation *fi_pos;
1227 * Non-null if we are currently hashing a file.
1229 struct GNUNET_CRYPTO_FileHashContext *fhc;
1232 * Connection to the datastore service.
1234 struct GNUNET_DATASTORE_Handle *dsh;
1237 * Queue entry for reservation/unreservation.
1239 struct GNUNET_DATASTORE_QueueEntry *qre;
1242 * Context for SKS publishing operation that is part of this publishing operation
1243 * (NULL if not active).
1245 struct GNUNET_FS_PublishSksContext *sks_pc;
1248 * Context for KSK publishing operation that is part of this publishing operation
1249 * (NULL if not active).
1251 struct GNUNET_FS_PublishKskContext *ksk_pc;
1254 * ID of the task performing the upload. NO_TASK if the upload has
1257 GNUNET_SCHEDULER_TaskIdentifier upload_task;
1260 * Storage space to reserve for the operation.
1262 uint64_t reserve_space;
1265 * Overall number of entries to reserve for the
1266 * publish operation.
1268 uint32_t reserve_entries;
1271 * Options for publishing.
1273 enum GNUNET_FS_PublishOptions options;
1276 * Space reservation ID with datastore service
1282 * Set to #GNUNET_YES if all processing has completed.
1287 * Flag set to #GNUNET_YES if the next callback from
1288 * #GNUNET_FS_file_information_inspect should be skipped because it
1289 * is for the directory which was already processed with the parent.
1291 int skip_next_fi_callback;
1296 * Phases of unindex processing (state machine).
1301 * We're currently hashing the file.
1303 UNINDEX_STATE_HASHING = 0,
1306 * We're telling the datastore to delete
1307 * the respective DBlocks and IBlocks.
1309 UNINDEX_STATE_DS_REMOVE = 1,
1312 * Find out which keywords apply.
1314 UNINDEX_STATE_EXTRACT_KEYWORDS = 2,
1317 * We're telling the datastore to remove KBlocks.
1319 UNINDEX_STATE_DS_REMOVE_KBLOCKS = 3,
1322 * We're notifying the FS service about
1325 UNINDEX_STATE_FS_NOTIFY = 4,
1330 UNINDEX_STATE_COMPLETE = 5,
1333 * We've encountered a fatal error.
1335 UNINDEX_STATE_ERROR = 6
1340 * Handle for controlling an unindexing operation.
1342 struct GNUNET_FS_UnindexContext
1346 * The content hash key of the last block we processed, will in the
1347 * end be set to the CHK from the URI. Used to remove the KBlocks.
1349 struct ContentHashKey chk;
1352 * Global FS context.
1354 struct GNUNET_FS_Handle *h;
1357 * Our top-level activity entry.
1359 struct TopLevelActivity *top;
1362 * Directory scanner to find keywords (KBlock removal).
1364 struct GNUNET_FS_DirScanner *dscan;
1367 * Keywords found (telling us which KBlocks to remove).
1369 struct GNUNET_FS_Uri *ksk_uri;
1372 * Current offset in KSK removal.
1374 uint32_t ksk_offset;
1377 * Name of the file that we are unindexing.
1382 * Short name under which we are serializing the state of this operation.
1384 char *serialization;
1387 * Connection to the FS service, only valid during the
1388 * #UNINDEX_STATE_FS_NOTIFY phase.
1390 struct GNUNET_CLIENT_Connection *client;
1393 * Connection to the datastore service, only valid during the
1394 * UNINDEX_STATE_DS_NOTIFY phase.
1396 struct GNUNET_DATASTORE_Handle *dsh;
1399 * Pointer kept for the client.
1404 * Merkle-ish tree encoder context.
1406 struct GNUNET_FS_TreeEncoder *tc;
1409 * Handle used to read the file.
1411 struct GNUNET_DISK_FileHandle *fh;
1414 * Handle to datastore 'get_key' operation issued for
1415 * obtaining KBlocks.
1417 struct GNUNET_DATASTORE_QueueEntry *dqe;
1420 * Current key for decrypting UBLocks from 'get_key' operation.
1422 struct GNUNET_HashCode ukey;
1425 * Current query of 'get_key' operation.
1427 struct GNUNET_HashCode uquery;
1430 * First content UID, 0 for none.
1435 * Error message, NULL on success.
1440 * Context for hashing of the file.
1442 struct GNUNET_CRYPTO_FileHashContext *fhc;
1445 * Overall size of the file.
1450 * Random offset given to #GNUNET_DATASTORE_get_key.
1455 * When did we start?
1457 struct GNUNET_TIME_Absolute start_time;
1460 * Hash of the file's contents (once computed).
1462 struct GNUNET_HashCode file_id;
1465 * Current operatinonal phase.
1467 enum UnindexState state;
1473 * Information we keep for each keyword in
1476 struct SearchRequestEntry
1480 * Hash of the public key, also known as the query.
1482 struct GNUNET_HashCode uquery;
1485 * Derived public key, hashes to 'uquery'.
1487 struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
1490 * The original keyword, used to derive the
1491 * key (for decrypting the UBlock).
1496 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1497 * was found under this keyword. Note that the entries will point
1498 * to the same locations as those in the master result map (in
1499 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1500 * The key for each entry is the XOR of the key and query in the CHK
1501 * URI (as a unique identifier for the search result).
1503 struct GNUNET_CONTAINER_MultiHashMap *results;
1506 * Is this keyword a mandatory keyword
1507 * (started with '+')?
1515 * Handle for controlling a search.
1517 struct GNUNET_FS_SearchContext
1520 * Handle to the global FS context.
1522 struct GNUNET_FS_Handle *h;
1525 * Our top-level activity entry (if we are top-level, otherwise NULL).
1527 struct TopLevelActivity *top;
1530 * List of keywords that we're looking for.
1532 struct GNUNET_FS_Uri *uri;
1535 * For update-searches, link to the search result that triggered
1536 * the update search; otherwise NULL.
1538 struct GNUNET_FS_SearchResult *psearch_result;
1541 * Connection to the FS service.
1543 struct GNUNET_CLIENT_Connection *client;
1546 * Pointer we keep for the client.
1551 * Name of the file on disk we use for persistence.
1553 char *serialization;
1556 * Error message (non-NULL if this operation failed).
1561 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1562 * was found in the search. The key for each entry is the XOR of
1563 * the key and query in the CHK URI (as a unique identifier for the
1566 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1569 * Per-keyword information for a keyword search. This array will
1570 * have exactly as many entries as there were keywords.
1572 struct SearchRequestEntry *requests;
1575 * When did we start?
1577 struct GNUNET_TIME_Absolute start_time;
1580 * How long to wait before we try to reconnect to FS service?
1582 struct GNUNET_TIME_Relative reconnect_backoff;
1585 * ID of a task that is using this struct and that must be cancelled
1586 * when the search is being stopped (if not
1587 * #GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1588 * artificial delay when trying to reconnect to the FS service.
1590 GNUNET_SCHEDULER_TaskIdentifier task;
1593 * How many of the entries in the search request
1594 * map have been passed to the service so far?
1596 unsigned int search_request_map_offset;
1599 * How many of the keywords in the KSK
1600 * map have been passed to the service so far?
1602 unsigned int keyword_offset;
1605 * Anonymity level for the search.
1610 * Number of mandatory keywords in this query.
1612 uint32_t mandatory_count;
1615 * Options for the search.
1617 enum GNUNET_FS_SearchOptions options;
1622 * FSM for possible states a block can go through. The typical
1623 * order of progression is linear through the states, alternatives
1624 * are documented in the comments.
1626 enum BlockRequestState
1629 * Initial state, block has only been allocated (since it is
1630 * relevant to the overall download request).
1635 * We've checked the block on the path down the tree, and the
1636 * content on disk did match the desired CHK, but not all
1637 * the way down, so at the bottom some blocks will still
1638 * need to be reconstructed).
1640 BRS_RECONSTRUCT_DOWN = 1,
1643 * We've calculated the CHK bottom-up based on the meta data.
1644 * This may work, but if it did we have to write the meta data to
1645 * disk at the end (and we still need to check against the
1648 BRS_RECONSTRUCT_META_UP = 2,
1651 * We've calculated the CHK bottom-up based on what we have on
1652 * disk, which may not be what the desired CHK is. If the
1653 * reconstructed CHKs match whatever comes from above, we're
1654 * done with the respective subtree.
1656 BRS_RECONSTRUCT_UP = 3,
1659 * We've determined the real, desired CHK for this block
1660 * (full tree reconstruction failed), request is now pending.
1661 * If the CHK that bubbled up through reconstruction did match
1662 * the top-level request, the state machine for the subtree
1663 * would have moved to BRS_DOWNLOAD_UP.
1668 * We've successfully downloaded this block, but the children
1669 * still need to be either downloaded or verified (download
1670 * request propagates down). If the download fails, the
1671 * state machine for this block may move to
1672 * BRS_DOWNLOAD_ERROR instead.
1674 BRS_DOWNLOAD_DOWN = 5,
1677 * This block and all of its children have been downloaded
1678 * successfully (full completion propagates up).
1680 BRS_DOWNLOAD_UP = 6,
1683 * We got a block back that matched the query but did not hash to
1684 * the key (malicious publisher or hash collision); this block
1685 * can never be downloaded (error propagates up).
1692 * Information about an active download request.
1694 struct DownloadRequest
1697 * While pending, we keep all download requests in a doubly-linked list.
1699 struct DownloadRequest *next;
1702 * While pending, we keep all download requests in a doubly-linked list.
1704 struct DownloadRequest *prev;
1707 * Parent in the CHK-tree.
1709 struct DownloadRequest *parent;
1712 * Array (!) of child-requests, or NULL for the bottom of the tree.
1714 struct DownloadRequest **children;
1717 * CHK for the request for this block (set during reconstruction
1718 * to what we have on disk, later to what we want to have).
1720 struct ContentHashKey chk;
1723 * Offset of the corresponding block. Specifically, first (!) byte of
1724 * the first DBLOCK in the subtree induced by block represented by
1730 * Number of entries in 'children' array.
1732 unsigned int num_children;
1735 * Depth of the corresponding block in the tree. 0==DBLOCKs.
1740 * Offset of the CHK for this block in the parent block
1742 unsigned int chk_idx;
1747 enum BlockRequestState state;
1750 * #GNUNET_YES if this entry is in the pending list.
1758 * (recursively) free download request structure
1760 * @param dr request to free
1763 GNUNET_FS_free_download_request_ (struct DownloadRequest *dr);
1767 * Context for controlling a download.
1769 struct GNUNET_FS_DownloadContext
1773 * Global FS context.
1775 struct GNUNET_FS_Handle *h;
1778 * Our top-level activity entry (if we are top-level, otherwise NULL).
1780 struct TopLevelActivity *top;
1783 * Connection to the FS service.
1785 struct GNUNET_CLIENT_Connection *client;
1788 * Parent download (used when downloading files
1791 struct GNUNET_FS_DownloadContext *parent;
1794 * Associated search (used when downloading files
1795 * based on search results), or NULL for none.
1797 struct GNUNET_FS_SearchResult *search;
1800 * Head of list of child downloads.
1802 struct GNUNET_FS_DownloadContext *child_head;
1805 * Tail of list of child downloads.
1807 struct GNUNET_FS_DownloadContext *child_tail;
1810 * Previous download belonging to the same parent.
1812 struct GNUNET_FS_DownloadContext *prev;
1815 * Next download belonging to the same parent.
1817 struct GNUNET_FS_DownloadContext *next;
1820 * Context kept for the client.
1825 * URI that identifies the file that we are downloading.
1827 struct GNUNET_FS_Uri *uri;
1830 * Known meta-data for the file (can be NULL).
1832 struct GNUNET_CONTAINER_MetaData *meta;
1835 * Error message, NULL if we're doing OK.
1840 * Random portion of filename we use for syncing state of this
1843 char *serialization;
1846 * Where are we writing the data (name of the
1847 * file, can be NULL!).
1852 * Where are we writing the data temporarily (name of the
1853 * file, can be NULL!); used if we do not have a permanent
1854 * name and we are a directory and we do a recursive download.
1856 char *temp_filename;
1859 * Our entry in the job queue.
1861 struct GNUNET_FS_QueueEntry *job_queue;
1864 * Non-NULL if we are currently having a request for
1865 * transmission pending with the client handle.
1867 struct GNUNET_CLIENT_TransmitHandle *th;
1870 * Tree encoder used for the reconstruction.
1872 struct GNUNET_FS_TreeEncoder *te;
1875 * File handle for reading data from an existing file
1876 * (to pass to tree encoder).
1878 struct GNUNET_DISK_FileHandle *rfh;
1881 * Map of active requests (those waiting for a response). The key
1882 * is the hash of the encryped block (aka query).
1884 struct GNUNET_CONTAINER_MultiHashMap *active;
1887 * Head of linked list of pending requests.
1889 struct DownloadRequest *pending_head;
1892 * Head of linked list of pending requests.
1894 struct DownloadRequest *pending_tail;
1897 * Top-level download request.
1899 struct DownloadRequest *top_request;
1902 * Identity of the peer having the content, or all-zeros
1903 * if we don't know of such a peer.
1905 struct GNUNET_PeerIdentity target;
1908 * ID of a task that is using this struct and that must be cancelled
1909 * when the download is being stopped (if not
1910 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1911 * artificial delay when trying to reconnect to the FS service or
1912 * the task processing incrementally the data on disk, or the
1913 * task requesting blocks, etc.
1915 GNUNET_SCHEDULER_TaskIdentifier task;
1918 * What is the first offset that we're interested
1924 * How many bytes starting from offset are desired?
1925 * This is NOT the overall length of the file!
1930 * How many bytes have we already received within
1931 * the specified range (DBlocks only).
1936 * What was the size of the file on disk that we're downloading
1937 * before we started? Used to detect if there is a point in
1938 * checking an existing block on disk for matching the desired
1939 * content. 0 if the file did not exist already.
1941 uint64_t old_file_size;
1944 * Time download was started.
1946 struct GNUNET_TIME_Absolute start_time;
1949 * How long to wait before we try to reconnect to FS service?
1951 struct GNUNET_TIME_Relative reconnect_backoff;
1954 * Desired level of anonymity.
1959 * The depth of the file-tree.
1961 unsigned int treedepth;
1964 * Options for the download.
1966 enum GNUNET_FS_DownloadOptions options;
1969 * Flag set upon transitive completion (includes child downloads).
1970 * This flag is only set to #GNUNET_YES for directories where all
1971 * child-downloads have also completed (and signalled completion).
1976 * Have we started the receive continuation yet?
1981 * Are we ready to issue requests (reconstructions are finished)?
1990 /* end of fs_api.h */