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_CRYPTO_EccPublicKey peer;
126 * Time when this location URI expires.
128 struct GNUNET_TIME_Absolute expirationTime;
131 * RSA signature over the GNUNET_EC_FileIdentifier,
132 * GNUNET_hash of the peer and expiration time.
134 struct GNUNET_CRYPTO_EccSignature 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_EccPublicKey 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
384 * Is this struct for a file or directory?
389 * Are we done publishing this file?
397 * The job is now ready to run and should use the given client
398 * handle to communicate with the FS service.
401 * @param client handle to use for FS communication
403 typedef void (*GNUNET_FS_QueueStart) (void *cls,
404 struct GNUNET_CLIENT_Connection * client);
408 * The job must now stop to run and should destry the client handle as
409 * soon as possible (ideally prior to returning).
411 typedef void (*GNUNET_FS_QueueStop) (void *cls);
416 * Priorities for the queue.
418 enum GNUNET_FS_QueuePriority
421 * This is a probe (low priority).
423 GNUNET_FS_QUEUE_PRIORITY_PROBE,
428 GNUNET_FS_QUEUE_PRIORITY_NORMAL
433 * Entry in the job queue.
435 struct GNUNET_FS_QueueEntry
438 * This is a linked list.
440 struct GNUNET_FS_QueueEntry *next;
443 * This is a linked list.
445 struct GNUNET_FS_QueueEntry *prev;
448 * Function to call when the job is started.
450 GNUNET_FS_QueueStart start;
453 * Function to call when the job needs to stop (or is done / dequeued).
455 GNUNET_FS_QueueStop stop;
458 * Closure for start and stop.
463 * Handle to FS primary context.
465 struct GNUNET_FS_Handle *h;
468 * Client handle, or NULL if job is not running.
470 struct GNUNET_CLIENT_Connection *client;
473 * Time the job was originally queued.
475 struct GNUNET_TIME_Absolute queue_time;
478 * Time the job was started last.
480 struct GNUNET_TIME_Absolute start_time;
483 * Total amount of time the job has been running (except for the
486 struct GNUNET_TIME_Relative run_time;
489 * How many blocks do the active downloads have?
494 * How important is this download?
496 enum GNUNET_FS_QueuePriority priority;
499 * How often have we (re)started this download?
501 unsigned int start_times;
507 * Information we store for each search result.
509 struct GNUNET_FS_SearchResult
513 * File-sharing context this result belongs to.
515 struct GNUNET_FS_Handle *h;
518 * Search context this result belongs to; can be NULL
519 * for probes that come from a directory result.
521 struct GNUNET_FS_SearchContext *sc;
524 * URI to which this search result refers to.
526 struct GNUNET_FS_Uri *uri;
529 * Metadata for the search result.
531 struct GNUNET_CONTAINER_MetaData *meta;
534 * Client info for this search result.
539 * ID of a job that is currently probing this results' availability
540 * (NULL if we are not currently probing).
542 struct GNUNET_FS_DownloadContext *probe_ctx;
545 * ID of an associated download based on this search result (or
548 struct GNUNET_FS_DownloadContext *download;
551 * If this search result triggered an update search, this field
552 * links to the update search.
554 struct GNUNET_FS_SearchContext *update_search;
557 * Name under which this search result is stored on disk.
562 * Bitmap that specifies precisely which keywords have been matched already.
564 uint8_t *keyword_bitmap;
567 * Key for the search result
569 struct GNUNET_HashCode key;
572 * ID of the task that will clean up the probe_ctx should it not
573 * complete on time (and that will need to be cancelled if we clean
574 * up the search result before then).
576 GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
579 * Task we use to report periodically to the application that the
580 * probe is still running.
582 GNUNET_SCHEDULER_TaskIdentifier probe_ping_task;
585 * When did the current probe become active?
587 struct GNUNET_TIME_Absolute probe_active_time;
590 * How much longer should we run the current probe before giving up?
592 struct GNUNET_TIME_Relative remaining_probe_time;
595 * Anonymity level to use for probes using this search result.
600 * Number of mandatory keywords for which we have NOT yet found the
601 * search result; when this value hits zero, the search result is
602 * given to the callback.
604 uint32_t mandatory_missing;
607 * Number of optional keywords under which this result was also
610 uint32_t optional_support;
613 * Number of availability tests that have succeeded for this result.
615 uint32_t availability_success;
618 * Number of availability trials that we have performed for this
621 uint32_t availability_trials;
627 * Add a job to the queue.
629 * @param h handle to the overall FS state
630 * @param start function to call to begin the job
631 * @param stop function to call to pause the job, or on dequeue (if the job was running)
632 * @param cls closure for start and stop
633 * @param blocks number of blocks this download has
634 * @param priority how important is this download
635 * @return queue handle
637 struct GNUNET_FS_QueueEntry *
638 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
639 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
640 enum GNUNET_FS_QueuePriority priority);
644 * Dequeue a job from the queue.
646 * @param qe handle for the job
649 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe);
653 * Function that provides data by reading from a file.
655 * @param cls closure (points to the file information)
656 * @param offset offset to read from; it is possible
657 * that the caller might need to go backwards
659 * @param max maximum number of bytes that should be
660 * copied to buf; readers are not allowed
661 * to provide less data unless there is an error;
662 * a value of "0" will be used at the end to allow
663 * the reader to clean up its internal state
664 * @param buf where the reader should write the data
665 * @param emsg location for the reader to store an error message
666 * @return number of bytes written, usually "max", 0 on error
669 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
674 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
676 * @param filename file to read
677 * @return closure to use
680 GNUNET_FS_make_file_reader_context_ (const char *filename);
685 * Function that provides data by copying from a buffer.
687 * @param cls closure (points to the buffer)
688 * @param offset offset to read from; it is possible
689 * that the caller might need to go backwards
691 * @param max maximum number of bytes that should be
692 * copied to buf; readers are not allowed
693 * to provide less data unless there is an error;
694 * a value of "0" will be used at the end to allow
695 * the reader to clean up its internal state
696 * @param buf where the reader should write the data
697 * @param emsg location for the reader to store an error message
698 * @return number of bytes written, usually "max", 0 on error
701 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
705 * Notification of FS that a search probe has made progress.
706 * This function is used INSTEAD of the client's event handler
707 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
709 * @param cls closure, always NULL (!), actual closure
710 * is in the client-context of the info struct
711 * @param info details about the event, specifying the event type
712 * and various bits about the event
713 * @return client-context (for the next progress call
714 * for this operation; should be set to NULL for
715 * SUSPEND and STOPPED events). The value returned
716 * will be passed to future callbacks in the respective
717 * field in the GNUNET_FS_ProgressInfo struct.
720 GNUNET_FS_search_probe_progress_ (void *cls,
721 const struct GNUNET_FS_ProgressInfo *info);
725 * Main function that performs the upload.
727 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
728 * @param tc task context
731 GNUNET_FS_publish_main_ (void *cls,
732 const struct GNUNET_SCHEDULER_TaskContext *tc);
736 * Function called once the hash of the file
737 * that is being unindexed has been computed.
739 * @param cls closure, unindex context
740 * @param file_id computed hash, NULL on error
743 GNUNET_FS_unindex_process_hash_ (void *cls, const struct GNUNET_HashCode * file_id);
747 * Extract the keywords for KBlock removal
749 * @param uc context for the unindex operation.
752 GNUNET_FS_unindex_do_extract_keywords_ (struct GNUNET_FS_UnindexContext *uc);
756 * If necessary, connect to the datastore and remove the KBlocks.
758 * @param uc context for the unindex operation.
761 GNUNET_FS_unindex_do_remove_kblocks_ (struct GNUNET_FS_UnindexContext *uc);
765 * Fill in all of the generic fields for a publish event and call the
768 * @param pi structure to fill in
769 * @param pc overall publishing context
770 * @param p file information for the file being published
771 * @param offset where in the file are we so far
772 * @return value returned from callback
775 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
776 struct GNUNET_FS_PublishContext *pc,
777 const struct GNUNET_FS_FileInformation *p,
782 * Fill in all of the generic fields for a download event and call the
785 * @param pi structure to fill in
786 * @param dc overall download context
789 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
790 struct GNUNET_FS_DownloadContext *dc);
794 * Task that creates the initial (top-level) download
795 * request for the file.
797 * @param cls the 'struct GNUNET_FS_DownloadContext'
798 * @param tc scheduler context
801 GNUNET_FS_download_start_task_ (void *cls,
802 const struct GNUNET_SCHEDULER_TaskContext *tc);
807 * Fill in all of the generic fields for
808 * an unindex event and call the callback.
810 * @param pi structure to fill in
811 * @param uc overall unindex context
812 * @param offset where we are in the file (for progress)
815 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
816 struct GNUNET_FS_UnindexContext *uc,
820 * Fill in all of the generic fields for a search event and
823 * @param pi structure to fill in
824 * @param h file-sharing handle
825 * @param sc overall search context
826 * @return value returned by the callback
829 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
830 struct GNUNET_FS_Handle *h,
831 struct GNUNET_FS_SearchContext *sc);
835 * Connect to the datastore and remove the blocks.
837 * @param uc context for the unindex operation.
840 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
843 * Build the request and actually initiate the search using the
846 * @param sc search context
847 * @return GNUNET_OK on success, GNUNET_SYSERR on error
850 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
853 * Start the downloading process (by entering the queue).
855 * @param dc our download context
858 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
862 * Start download probes for the given search result.
864 * @param sr the search result
867 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
870 * Remove serialization/deserialization file from disk.
872 * @param h master context
873 * @param ext component of the path
874 * @param ent entity identifier
877 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
882 * Remove serialization/deserialization directory from disk.
884 * @param h master context
885 * @param ext component of the path
886 * @param uni unique name of parent
889 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
894 * Synchronize this file-information struct with its mirror
895 * on disk. Note that all internal FS-operations that change
896 * file information data should already call "sync" internally,
897 * so this function is likely not useful for clients.
899 * @param fi the struct to sync
902 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
905 * Synchronize this publishing struct with its mirror
906 * on disk. Note that all internal FS-operations that change
907 * publishing structs should already call "sync" internally,
908 * so this function is likely not useful for clients.
910 * @param pc the struct to sync
913 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);
927 * Synchronize this search struct with its mirror
928 * on disk. Note that all internal FS-operations that change
929 * publishing structs should already call "sync" internally,
930 * so this function is likely not useful for clients.
932 * @param sc the struct to sync
935 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
938 * Synchronize this search result with its mirror
939 * on disk. Note that all internal FS-operations that change
940 * publishing structs should already call "sync" internally,
941 * so this function is likely not useful for clients.
943 * @param sr the struct to sync
946 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
949 * Synchronize this download struct with its mirror
950 * on disk. Note that all internal FS-operations that change
951 * publishing structs should already call "sync" internally,
952 * so this function is likely not useful for clients.
954 * @param dc the struct to sync
957 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
960 * Create SUSPEND event for the given publish operation
961 * and then clean up our state (without stop signal).
963 * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
966 GNUNET_FS_publish_signal_suspend_ (void *cls);
969 * Create SUSPEND event for the given search operation
970 * and then clean up our state (without stop signal).
972 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
975 GNUNET_FS_search_signal_suspend_ (void *cls);
978 * Create SUSPEND event for the given download operation
979 * and then clean up our state (without stop signal).
981 * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
984 GNUNET_FS_download_signal_suspend_ (void *cls);
987 * Create SUSPEND event for the given unindex operation
988 * and then clean up our state (without stop signal).
990 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
993 GNUNET_FS_unindex_signal_suspend_ (void *cls);
996 * Function signature of the functions that can be called
997 * to trigger suspend signals and clean-up for top-level
1000 * @param cls closure
1002 typedef void (*SuspendSignalFunction) (void *cls);
1005 * We track all of the top-level activities of FS
1006 * so that we can signal 'suspend' on shutdown.
1008 struct TopLevelActivity
1011 * This is a doubly-linked list.
1013 struct TopLevelActivity *next;
1016 * This is a doubly-linked list.
1018 struct TopLevelActivity *prev;
1021 * Function to call for suspend-signalling and clean up.
1023 SuspendSignalFunction ssf;
1026 * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
1033 * Create a top-level activity entry.
1035 * @param h global fs handle
1036 * @param ssf suspend signal function to use
1037 * @param ssf_cls closure for ssf
1038 * @return fresh top-level activity handle
1040 struct TopLevelActivity *
1041 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
1046 * Destroy a top-level activity entry.
1048 * @param h global fs handle
1049 * @param top top level activity entry
1052 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top);
1057 * Master context for most FS operations.
1059 struct GNUNET_FS_Handle
1062 * Configuration to use.
1064 const struct GNUNET_CONFIGURATION_Handle *cfg;
1067 * Name of our client.
1072 * Function to call with updates on our progress.
1074 GNUNET_FS_ProgressCallback upcb;
1082 * Head of DLL of top-level activities.
1084 struct TopLevelActivity *top_head;
1087 * Tail of DLL of top-level activities.
1089 struct TopLevelActivity *top_tail;
1092 * Head of DLL of running jobs.
1094 struct GNUNET_FS_QueueEntry *running_head;
1097 * Tail of DLL of running jobs.
1099 struct GNUNET_FS_QueueEntry *running_tail;
1102 * Head of DLL of pending jobs.
1104 struct GNUNET_FS_QueueEntry *pending_head;
1107 * Tail of DLL of pending jobs.
1109 struct GNUNET_FS_QueueEntry *pending_tail;
1112 * Task that processes the jobs in the running and pending queues
1113 * (and moves jobs around as needed).
1115 GNUNET_SCHEDULER_TaskIdentifier queue_job;
1118 * Average time we take for a single request to be satisfied.
1119 * FIXME: not yet calcualted properly...
1121 struct GNUNET_TIME_Relative avg_block_latency;
1124 * How many actual downloads do we have running right now?
1126 unsigned int active_downloads;
1129 * How many blocks do the active downloads have?
1131 unsigned int active_blocks;
1136 enum GNUNET_FS_Flags flags;
1139 * Maximum number of parallel downloads.
1141 unsigned int max_parallel_downloads;
1144 * Maximum number of parallel requests.
1146 unsigned int max_parallel_requests;
1152 * Handle for controlling a publication process.
1154 struct GNUNET_FS_PublishContext
1157 * Handle to the global fs context.
1159 struct GNUNET_FS_Handle *h;
1162 * Our top-level activity entry (if we are top-level, otherwise NULL).
1164 struct TopLevelActivity *top;
1167 * File-structure that is being shared.
1169 struct GNUNET_FS_FileInformation *fi;
1172 * Namespace that we are publishing in, NULL if we have no namespace.
1174 struct GNUNET_CRYPTO_EccPrivateKey *ns;
1177 * ID of the content in the namespace, NULL if we have no namespace.
1182 * ID for future updates, NULL if we have no namespace or no updates.
1187 * Filename used for serializing information about this operation
1188 * (should be determined using 'mktemp').
1190 char *serialization;
1193 * Our own client handle for the FS service; only briefly used when
1194 * we start to index a file, otherwise NULL.
1196 struct GNUNET_CLIENT_Connection *client;
1199 * Current position in the file-tree for the upload.
1201 struct GNUNET_FS_FileInformation *fi_pos;
1204 * Non-null if we are currently hashing a file.
1206 struct GNUNET_CRYPTO_FileHashContext *fhc;
1209 * Connection to the datastore service.
1211 struct GNUNET_DATASTORE_Handle *dsh;
1214 * Queue entry for reservation/unreservation.
1216 struct GNUNET_DATASTORE_QueueEntry *qre;
1219 * Context for SKS publishing operation that is part of this publishing operation
1220 * (NULL if not active).
1222 struct GNUNET_FS_PublishSksContext *sks_pc;
1225 * Context for KSK publishing operation that is part of this publishing operation
1226 * (NULL if not active).
1228 struct GNUNET_FS_PublishKskContext *ksk_pc;
1231 * ID of the task performing the upload. NO_TASK if the upload has
1234 GNUNET_SCHEDULER_TaskIdentifier upload_task;
1237 * Storage space to reserve for the operation.
1239 uint64_t reserve_space;
1242 * Overall number of entries to reserve for the
1243 * publish operation.
1245 uint32_t reserve_entries;
1248 * Options for publishing.
1250 enum GNUNET_FS_PublishOptions options;
1253 * Space reservation ID with datastore service
1259 * Set to GNUNET_YES if all processing has completed.
1264 * Flag set to GNUNET_YES if the next callback from
1265 * GNUNET_FS_file_information_inspect should be skipped because it
1266 * is for the directory which was already processed with the parent.
1268 int skip_next_fi_callback;
1273 * Phases of unindex processing (state machine).
1278 * We're currently hashing the file.
1280 UNINDEX_STATE_HASHING = 0,
1283 * We're telling the datastore to delete
1284 * the respective DBlocks and IBlocks.
1286 UNINDEX_STATE_DS_REMOVE = 1,
1289 * Find out which keywords apply.
1291 UNINDEX_STATE_EXTRACT_KEYWORDS = 2,
1294 * We're telling the datastore to remove KBlocks.
1296 UNINDEX_STATE_DS_REMOVE_KBLOCKS = 3,
1299 * We're notifying the FS service about
1302 UNINDEX_STATE_FS_NOTIFY = 4,
1307 UNINDEX_STATE_COMPLETE = 5,
1310 * We've encountered a fatal error.
1312 UNINDEX_STATE_ERROR = 6
1317 * Handle for controlling an unindexing operation.
1319 struct GNUNET_FS_UnindexContext
1323 * The content hash key of the last block we processed, will in the
1324 * end be set to the CHK from the URI. Used to remove the KBlocks.
1326 struct ContentHashKey chk;
1329 * Global FS context.
1331 struct GNUNET_FS_Handle *h;
1334 * Our top-level activity entry.
1336 struct TopLevelActivity *top;
1339 * Directory scanner to find keywords (KBlock removal).
1341 struct GNUNET_FS_DirScanner *dscan;
1344 * Keywords found (telling us which KBlocks to remove).
1346 struct GNUNET_FS_Uri *ksk_uri;
1349 * Current offset in KSK removal.
1351 uint32_t ksk_offset;
1354 * Name of the file that we are unindexing.
1359 * Short name under which we are serializing the state of this operation.
1361 char *serialization;
1364 * Connection to the FS service, only valid during the
1365 * UNINDEX_STATE_FS_NOTIFY phase.
1367 struct GNUNET_CLIENT_Connection *client;
1370 * Connection to the datastore service, only valid during the
1371 * UNINDEX_STATE_DS_NOTIFY phase.
1373 struct GNUNET_DATASTORE_Handle *dsh;
1376 * Pointer kept for the client.
1381 * Merkle-ish tree encoder context.
1383 struct GNUNET_FS_TreeEncoder *tc;
1386 * Handle used to read the file.
1388 struct GNUNET_DISK_FileHandle *fh;
1391 * Handle to datastore 'get_key' operation issued for
1392 * obtaining KBlocks.
1394 struct GNUNET_DATASTORE_QueueEntry *dqe;
1397 * Current key for decrypting UBLocks from 'get_key' operation.
1399 struct GNUNET_HashCode ukey;
1402 * Current query of 'get_key' operation.
1404 struct GNUNET_HashCode uquery;
1407 * First content UID, 0 for none.
1412 * Error message, NULL on success.
1417 * Context for hashing of the file.
1419 struct GNUNET_CRYPTO_FileHashContext *fhc;
1422 * Overall size of the file.
1427 * Random offset given to 'GNUNET_DATASTORE_get_key'.
1432 * When did we start?
1434 struct GNUNET_TIME_Absolute start_time;
1437 * Hash of the file's contents (once computed).
1439 struct GNUNET_HashCode file_id;
1442 * Current operatinonal phase.
1444 enum UnindexState state;
1450 * Information we keep for each keyword in
1453 struct SearchRequestEntry
1457 * Hash of the public key, also known as the query.
1459 struct GNUNET_HashCode uquery;
1462 * Derived public key, hashes to 'uquery'.
1464 struct GNUNET_CRYPTO_EccPublicKey dpub;
1467 * The original keyword, used to derive the
1468 * key (for decrypting the UBlock).
1473 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1474 * was found under this keyword. Note that the entries will point
1475 * to the same locations as those in the master result map (in
1476 * "struct GNUNET_FS_SearchContext"), so they should not be freed.
1477 * The key for each entry is the XOR of the key and query in the CHK
1478 * URI (as a unique identifier for the search result).
1480 struct GNUNET_CONTAINER_MultiHashMap *results;
1483 * Is this keyword a mandatory keyword
1484 * (started with '+')?
1492 * Handle for controlling a search.
1494 struct GNUNET_FS_SearchContext
1497 * Handle to the global FS context.
1499 struct GNUNET_FS_Handle *h;
1502 * Our top-level activity entry (if we are top-level, otherwise NULL).
1504 struct TopLevelActivity *top;
1507 * List of keywords that we're looking for.
1509 struct GNUNET_FS_Uri *uri;
1512 * For update-searches, link to the search result that triggered
1513 * the update search; otherwise NULL.
1515 struct GNUNET_FS_SearchResult *psearch_result;
1518 * Connection to the FS service.
1520 struct GNUNET_CLIENT_Connection *client;
1523 * Pointer we keep for the client.
1528 * Name of the file on disk we use for persistence.
1530 char *serialization;
1533 * Error message (non-NULL if this operation failed).
1538 * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
1539 * was found in the search. The key for each entry is the XOR of
1540 * the key and query in the CHK URI (as a unique identifier for the
1543 struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
1546 * Per-keyword information for a keyword search. This array will
1547 * have exactly as many entries as there were keywords.
1549 struct SearchRequestEntry *requests;
1552 * When did we start?
1554 struct GNUNET_TIME_Absolute start_time;
1557 * How long to wait before we try to reconnect to FS service?
1559 struct GNUNET_TIME_Relative reconnect_backoff;
1562 * ID of a task that is using this struct and that must be cancelled
1563 * when the search is being stopped (if not
1564 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1565 * artificial delay when trying to reconnect to the FS service.
1567 GNUNET_SCHEDULER_TaskIdentifier task;
1570 * How many of the entries in the search request
1571 * map have been passed to the service so far?
1573 unsigned int search_request_map_offset;
1576 * How many of the keywords in the KSK
1577 * map have been passed to the service so far?
1579 unsigned int keyword_offset;
1582 * Anonymity level for the search.
1587 * Number of mandatory keywords in this query.
1589 uint32_t mandatory_count;
1592 * Options for the search.
1594 enum GNUNET_FS_SearchOptions options;
1599 * FSM for possible states a block can go through. The typical
1600 * order of progression is linear through the states, alternatives
1601 * are documented in the comments.
1603 enum BlockRequestState
1606 * Initial state, block has only been allocated (since it is
1607 * relevant to the overall download request).
1612 * We've checked the block on the path down the tree, and the
1613 * content on disk did match the desired CHK, but not all
1614 * the way down, so at the bottom some blocks will still
1615 * need to be reconstructed).
1617 BRS_RECONSTRUCT_DOWN = 1,
1620 * We've calculated the CHK bottom-up based on the meta data.
1621 * This may work, but if it did we have to write the meta data to
1622 * disk at the end (and we still need to check against the
1625 BRS_RECONSTRUCT_META_UP = 2,
1628 * We've calculated the CHK bottom-up based on what we have on
1629 * disk, which may not be what the desired CHK is. If the
1630 * reconstructed CHKs match whatever comes from above, we're
1631 * done with the respective subtree.
1633 BRS_RECONSTRUCT_UP = 3,
1636 * We've determined the real, desired CHK for this block
1637 * (full tree reconstruction failed), request is now pending.
1638 * If the CHK that bubbled up through reconstruction did match
1639 * the top-level request, the state machine for the subtree
1640 * would have moved to BRS_DOWNLOAD_UP.
1645 * We've successfully downloaded this block, but the children
1646 * still need to be either downloaded or verified (download
1647 * request propagates down). If the download fails, the
1648 * state machine for this block may move to
1649 * BRS_DOWNLOAD_ERROR instead.
1651 BRS_DOWNLOAD_DOWN = 5,
1654 * This block and all of its children have been downloaded
1655 * successfully (full completion propagates up).
1657 BRS_DOWNLOAD_UP = 6,
1660 * We got a block back that matched the query but did not hash to
1661 * the key (malicious publisher or hash collision); this block
1662 * can never be downloaded (error propagates up).
1669 * Information about an active download request.
1671 struct DownloadRequest
1674 * While pending, we keep all download requests in a doubly-linked list.
1676 struct DownloadRequest *next;
1679 * While pending, we keep all download requests in a doubly-linked list.
1681 struct DownloadRequest *prev;
1684 * Parent in the CHK-tree.
1686 struct DownloadRequest *parent;
1689 * Array (!) of child-requests, or NULL for the bottom of the tree.
1691 struct DownloadRequest **children;
1694 * CHK for the request for this block (set during reconstruction
1695 * to what we have on disk, later to what we want to have).
1697 struct ContentHashKey chk;
1700 * Offset of the corresponding block. Specifically, first (!) byte of
1701 * the first DBLOCK in the subtree induced by block represented by
1707 * Number of entries in 'children' array.
1709 unsigned int num_children;
1712 * Depth of the corresponding block in the tree. 0==DBLOCKs.
1717 * Offset of the CHK for this block in the parent block
1719 unsigned int chk_idx;
1724 enum BlockRequestState state;
1727 * GNUNET_YES if this entry is in the pending list.
1735 * (recursively) free download request structure
1737 * @param dr request to free
1740 GNUNET_FS_free_download_request_ (struct DownloadRequest *dr);
1744 * Context for controlling a download.
1746 struct GNUNET_FS_DownloadContext
1750 * Global FS context.
1752 struct GNUNET_FS_Handle *h;
1755 * Our top-level activity entry (if we are top-level, otherwise NULL).
1757 struct TopLevelActivity *top;
1760 * Connection to the FS service.
1762 struct GNUNET_CLIENT_Connection *client;
1765 * Parent download (used when downloading files
1768 struct GNUNET_FS_DownloadContext *parent;
1771 * Associated search (used when downloading files
1772 * based on search results), or NULL for none.
1774 struct GNUNET_FS_SearchResult *search;
1777 * Head of list of child downloads.
1779 struct GNUNET_FS_DownloadContext *child_head;
1782 * Tail of list of child downloads.
1784 struct GNUNET_FS_DownloadContext *child_tail;
1787 * Previous download belonging to the same parent.
1789 struct GNUNET_FS_DownloadContext *prev;
1792 * Next download belonging to the same parent.
1794 struct GNUNET_FS_DownloadContext *next;
1797 * Context kept for the client.
1802 * URI that identifies the file that we are downloading.
1804 struct GNUNET_FS_Uri *uri;
1807 * Known meta-data for the file (can be NULL).
1809 struct GNUNET_CONTAINER_MetaData *meta;
1812 * Error message, NULL if we're doing OK.
1817 * Random portion of filename we use for syncing state of this
1820 char *serialization;
1823 * Where are we writing the data (name of the
1824 * file, can be NULL!).
1829 * Where are we writing the data temporarily (name of the
1830 * file, can be NULL!); used if we do not have a permanent
1831 * name and we are a directory and we do a recursive download.
1833 char *temp_filename;
1836 * Our entry in the job queue.
1838 struct GNUNET_FS_QueueEntry *job_queue;
1841 * Non-NULL if we are currently having a request for
1842 * transmission pending with the client handle.
1844 struct GNUNET_CLIENT_TransmitHandle *th;
1847 * Tree encoder used for the reconstruction.
1849 struct GNUNET_FS_TreeEncoder *te;
1852 * File handle for reading data from an existing file
1853 * (to pass to tree encoder).
1855 struct GNUNET_DISK_FileHandle *rfh;
1858 * Map of active requests (those waiting for a response). The key
1859 * is the hash of the encryped block (aka query).
1861 struct GNUNET_CONTAINER_MultiHashMap *active;
1864 * Head of linked list of pending requests.
1866 struct DownloadRequest *pending_head;
1869 * Head of linked list of pending requests.
1871 struct DownloadRequest *pending_tail;
1874 * Top-level download request.
1876 struct DownloadRequest *top_request;
1879 * Identity of the peer having the content, or all-zeros
1880 * if we don't know of such a peer.
1882 struct GNUNET_PeerIdentity target;
1885 * ID of a task that is using this struct and that must be cancelled
1886 * when the download is being stopped (if not
1887 * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
1888 * artificial delay when trying to reconnect to the FS service or
1889 * the task processing incrementally the data on disk, or the
1890 * task requesting blocks, etc.
1892 GNUNET_SCHEDULER_TaskIdentifier task;
1895 * What is the first offset that we're interested
1901 * How many bytes starting from offset are desired?
1902 * This is NOT the overall length of the file!
1907 * How many bytes have we already received within
1908 * the specified range (DBlocks only).
1913 * What was the size of the file on disk that we're downloading
1914 * before we started? Used to detect if there is a point in
1915 * checking an existing block on disk for matching the desired
1916 * content. 0 if the file did not exist already.
1918 uint64_t old_file_size;
1921 * Time download was started.
1923 struct GNUNET_TIME_Absolute start_time;
1926 * How long to wait before we try to reconnect to FS service?
1928 struct GNUNET_TIME_Relative reconnect_backoff;
1931 * Desired level of anonymity.
1936 * The depth of the file-tree.
1938 unsigned int treedepth;
1941 * Options for the download.
1943 enum GNUNET_FS_DownloadOptions options;
1946 * Flag set upon transitive completion (includes child downloads).
1947 * This flag is only set to GNUNET_YES for directories where all
1948 * child-downloads have also completed (and signalled completion).
1953 * Have we started the receive continuation yet?
1958 * Are we ready to issue requests (reconstructions are finished)?
1967 /* end of fs_api.h */