+
/*
This file is part of GNUnet.
(C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
#include "gnunet_constants.h"
#include "gnunet_datastore_service.h"
#include "gnunet_fs_service.h"
+#include "gnunet_block_lib.h"
+
+/**
+ * Maximum size of the datastore queue for P2P operations.
+ */
+#define MAX_DATASTORE_QUEUE 16
+
+/**
+ * Maximum number of blocks we keep in memory for migration.
+ */
+#define MAX_MIGRATION_QUEUE 32
+
+/**
+ * How many peers do we select as possible
+ * targets per block obtained for migration?
+ */
+#define MIGRATION_LIST_SIZE 4
+
+/**
+ * To how many peers do we forward each migration block ultimately?
+ * This number must be smaller or equal to MIGRATION_LIST_SIZE. Using
+ * a smaller value allows for variation in available bandwidth (for
+ * migration) between the peers.
+ */
+#define MIGRATION_TARGET_COUNT 2
+
+/**
+ * Ratio for moving average delay calculation. The previous
+ * average goes in with a factor of (n-1) into the calculation.
+ * Must be > 0.
+ */
+#define RUNAVG_DELAY_N 16
/**
* Size of the individual blocks used for file-sharing.
*/
#define BLOOMFILTER_K 16
+/**
+ * Number of availability trials we perform per search result.
+ */
+#define AVAILABILITY_TRIALS_MAX 8
+
/**
* By how much (in ms) do we decrement the TTL
* at each hop?
*/
#define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
+/**
+ * Name of the directory with top-level searches.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_SEARCH "search"
+
+/**
+ * Name of the directory with sub-searches (namespace-updates).
+ */
+#define GNUNET_FS_SYNC_PATH_CHILD_SEARCH "search-child"
+
+/**
+ * Name of the directory with master downloads (not associated
+ * with search or part of another download).
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD "download"
+
+/**
+ * Name of the directory with downloads that are part of another
+ * download or a search.
+ */
+#define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD "download-child"
+
+/**
+ * Name of the directory with publishing operations.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH "publish"
+
+/**
+ * Name of the directory with files that are being published
+ */
+#define GNUNET_FS_SYNC_PATH_FILE_INFO "publish-file"
+
+/**
+ * Name of the directory with unindex operations.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX "unindex"
/**
*/
struct ContentHashKey
{
+ /**
+ * Hash of the original content, used for encryption.
+ */
GNUNET_HashCode key;
+
+ /**
+ * Hash of the encrypted content, used for querying.
+ */
GNUNET_HashCode query;
};
};
+/**
+ * Types of URIs.
+ */
enum uri_types
-{ chk, sks, ksk, loc };
+ {
+ /**
+ * Content-hash-key (simple file).
+ */
+ chk,
+
+ /**
+ * Signed key space (file in namespace).
+ */
+ sks,
+
+ /**
+ * Keyword search key (query with keywords).
+ */
+ ksk,
+
+ /**
+ * Location (chk with identity of hosting peer).
+ */
+ loc
+ };
/**
* A Universal Resource Identifier (URI), opaque.
*/
struct GNUNET_FS_Uri
{
+ /**
+ * Type of the URI.
+ */
enum uri_types type;
+
union
{
struct
*/
struct GNUNET_FS_FileInformation *dir;
+ /**
+ * Handle to the master context.
+ */
+ struct GNUNET_FS_Handle *h;
+
/**
* Pointer kept for the client.
*/
/**
* Under what filename is this struct serialized
- * (for operational persistence).
+ * (for operational persistence). Should be determined
+ * using 'mktemp'.
*/
char *serialization;
struct GNUNET_FS_TreeEncoder *te;
/**
- * Error message (non-NULL if this operation
- * failed).
+ * Error message (non-NULL if this operation failed).
*/
char *emsg;
+ /**
+ * Name of the file or directory (must be an absolute path).
+ */
+ char *filename;
+
/**
* Data describing either the file or the directory.
*/
void *reader_cls;
/**
- * Name of the file (must be an absolute path).
- * Only required for indexing. FIXME: not yet
- * initialized!
- */
- char *filename;
-
- /**
- * If this file is being indexed, this value
- * is set to the hash over the entire file
- * (when the indexing process is started).
+ * If this file is being indexed, this value is set to the hash
+ * over the entire file (when the indexing process is started).
* Otherwise this field is not used.
*/
GNUNET_HashCode file_id;
int do_index;
/**
- * Is "file_id" already valid? Set to GNUNET_YES
- * once the hash has been calculated.
+ * Is "file_id" already valid? Set to GNUNET_YES once the hash
+ * has been calculated.
*/
int have_hash;
*/
struct {
- /**
- * Name of the directory. FIXME: currently never set!
- */
- char *dirname;
-
/**
* Linked list of entries in the directory.
*/
} data;
- /**
- * Is this struct for a file or directory?
- */
- int is_directory;
-
/**
* Desired anonymity level.
*/
*/
uint32_t priority;
-};
-
-
-/**
- * Master context for most FS operations.
- */
-struct GNUNET_FS_Handle
-{
- /**
- * Scheduler.
- */
- struct GNUNET_SCHEDULER_Handle *sched;
-
- /**
- * Configuration to use.
- */
- const struct GNUNET_CONFIGURATION_Handle *cfg;
-
/**
- * Name of our client.
+ * Is this struct for a file or directory?
*/
- char *client_name;
+ int is_directory;
/**
- * Function to call with updates on our progress.
+ * Are we done publishing this file?
*/
- GNUNET_FS_ProgressCallback upcb;
+ int is_published;
- /**
- * Closure for upcb.
- */
- void *upcb_cls;
+};
- /**
- * Connection to the FS service.
- */
- struct GNUNET_CLIENT_Connection *client;
- /**
- * How many downloads probing availability
- * of search results do we have running
- * right now?
- */
- unsigned int active_probes;
+/**
+ * The job is now ready to run and should use the given client
+ * handle to communicate with the FS service.
+ *
+ * @param cls closure
+ * @param client handle to use for FS communication
+ */
+typedef void (*GNUNET_FS_QueueStart)(void *cls,
+ struct GNUNET_CLIENT_Connection *client);
- /**
- * General flags.
- */
- enum GNUNET_FS_Flags flags;
-};
+/**
+ * The job must now stop to run and should destry the client handle as
+ * soon as possible (ideally prior to returning).
+ */
+typedef void (*GNUNET_FS_QueueStop)(void *cls);
/**
- * Handle for controlling an upload.
+ * Entry in the job queue.
*/
-struct GNUNET_FS_PublishContext
+struct GNUNET_FS_QueueEntry
{
/**
- * Handle to the global fs context.
- */
- struct GNUNET_FS_Handle *h;
-
- /**
- * File-structure that is being shared.
+ * This is a linked list.
*/
- struct GNUNET_FS_FileInformation *fi;
+ struct GNUNET_FS_QueueEntry *next;
/**
- * Namespace that we are publishing in, NULL if we have no namespace.
+ * This is a linked list.
*/
- struct GNUNET_FS_Namespace *namespace;
+ struct GNUNET_FS_QueueEntry *prev;
/**
- * ID of the content in the namespace, NULL if we have no namespace.
+ * Function to call when the job is started.
*/
- char *nid;
+ GNUNET_FS_QueueStart start;
/**
- * ID for future updates, NULL if we have no namespace or no updates.
+ * Function to call when the job needs to stop (or is done / dequeued).
*/
- char *nuid;
+ GNUNET_FS_QueueStop stop;
/**
- * Our own client handle for the FS service;
- * only briefly used when we start to index a
- * file, otherwise NULL.
+ * Closure for start and stop.
*/
- struct GNUNET_CLIENT_Connection *client;
+ void *cls;
/**
- * Current position in the file-tree for the
- * upload.
- */
- struct GNUNET_FS_FileInformation *fi_pos;
+ * Handle to FS primary context.
+ */
+ struct GNUNET_FS_Handle *h;
/**
- * Connection to the datastore service.
+ * Client handle, or NULL if job is not running.
*/
- struct GNUNET_DATASTORE_Handle *dsh;
+ struct GNUNET_CLIENT_Connection *client;
/**
- * ID of the task performing the upload. NO_TASK
- * if the upload has completed.
+ * Time the job was originally queued.
*/
- GNUNET_SCHEDULER_TaskIdentifier upload_task;
+ struct GNUNET_TIME_Absolute queue_time;
/**
- * Typically GNUNET_NO. Set to GNUNET_YES if
- * "upload_task" is GNUNET_SCHEDULER_NO_TASK
- * and we're waiting for a response from the
- * datastore service (in which case this
- * struct must not be freed until we have that
- * response). If someone tries to stop the
- * download for good during this period,
- * "in_network_wait" is set to GNUNET_SYSERR
- * which will cause the struct to be destroyed
- * right after we have the reply (or timeout)
- * from the datastore service.
+ * Time the job was started last.
*/
- int in_network_wait;
+ struct GNUNET_TIME_Absolute start_time;
/**
- * Options for publishing.
+ * Total amount of time the job has been running (except for the
+ * current run).
*/
- enum GNUNET_FS_PublishOptions options;
+ struct GNUNET_TIME_Relative run_time;
/**
- * Space reservation ID with datastore service
- * for this upload.
+ * How many blocks do the active downloads have?
*/
- int rid;
+ unsigned int blocks;
/**
- * Set to GNUNET_YES if all processing has completed.
+ * How often have we (re)started this download?
*/
- int all_done;
-};
-
-
-/**
- * Phases of unindex processing (state machine).
- */
-enum UnindexState
- {
- /**
- * We're currently hashing the file.
- */
- UNINDEX_STATE_HASHING = 0,
-
- /**
- * We're notifying the FS service about
- * the unindexing.
- */
- UNINDEX_STATE_FS_NOTIFY = 1,
-
- /**
- * We're telling the datastore to delete
- * the respective entries.
- */
- UNINDEX_STATE_DS_REMOVE = 2,
+ unsigned int start_times;
- /**
- * We're done.
- */
- UNINDEX_STATE_COMPLETE = 3,
+};
- /**
- * We've encountered a fatal error.
- */
- UNINDEX_STATE_ERROR = 4,
- /**
- * We've been aborted. The next callback should clean up the
- * struct.
- */
- UNINDEX_STATE_ABORTED = 5
- };
/**
- * Handle for controlling an unindexing operation.
+ * Information we store for each search result.
*/
-struct GNUNET_FS_UnindexContext
+struct GNUNET_FS_SearchResult
{
-
- /**
- * Global FS context.
- */
- struct GNUNET_FS_Handle *h;
/**
- * Name of the file that we are unindexing.
+ * Search context this result belongs to.
*/
- char *filename;
+ struct GNUNET_FS_SearchContext *sc;
/**
- * Connection to the FS service,
- * only valid during the UNINDEX_STATE_FS_NOTIFY
- * phase.
+ * URI to which this search result refers to.
*/
- struct GNUNET_CLIENT_Connection *client;
+ struct GNUNET_FS_Uri *uri;
/**
- * Connection to the datastore service,
- * only valid during the UNINDEX_STATE_DS_NOTIFY
- * phase.
+ * Metadata for the search result.
*/
- struct GNUNET_DATASTORE_Handle *dsh;
+ struct GNUNET_CONTAINER_MetaData *meta;
/**
- * Pointer kept for the client.
+ * Client info for this search result.
*/
void *client_info;
/**
- * Merkle-ish tree encoder context.
+ * ID of a job that is currently probing this results' availability
+ * (NULL if we are not currently probing).
*/
- struct GNUNET_FS_TreeEncoder *tc;
+ struct GNUNET_FS_DownloadContext *probe_ctx;
/**
- * Handle used to read the file.
+ * ID of an associated download based on this search result (or
+ * NULL for none).
*/
- struct GNUNET_DISK_FileHandle *fh;
-
- /**
- * Overall size of the file.
- */
- uint64_t file_size;
+ struct GNUNET_FS_DownloadContext *download;
/**
- * When did we start?
+ * If this search result triggered an update search, this field
+ * links to the update search.
*/
- struct GNUNET_TIME_Absolute start_time;
+ struct GNUNET_FS_SearchContext *update_search;
/**
- * Hash of the file's contents (once
- * computed).
- */
- GNUNET_HashCode file_id;
-
- /**
- * Current operatinonal phase.
+ * Name under which this search result is stored on disk.
*/
- enum UnindexState state;
-
-};
-
-
-/**
- * Information we store for each search result.
- */
-struct SearchResult
-{
+ char *serialization;
/**
- * URI to which this search result
- * refers to.
+ * Key for the search result
*/
- struct GNUNET_FS_Uri *uri;
+ GNUNET_HashCode key;
/**
- * Metadata for the search result.
+ * ID of the task that will clean up the probe_ctx should it not
+ * complete on time (and that will need to be cancelled if we clean
+ * up the search result before then).
*/
- struct GNUNET_CONTAINER_MetaData *meta;
+ GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
/**
- * Client info for this search result.
+ * When did the current probe become active?
*/
- void *client_info;
+ struct GNUNET_TIME_Absolute probe_active_time;
/**
- * ID of a job that is currently probing
- * this results' availability (NULL if we
- * are not currently probing).
- */
- struct GNUNET_FS_DownloadContext *probe_ctx;
-
- /**
- * ID of the task that will clean up the probe_ctx
- * should it not complete on time (and that will
- * need to be cancelled if we clean up the search
- * result before then).
+ * How much longer should we run the current probe before giving up?
*/
- GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
+ struct GNUNET_TIME_Relative remaining_probe_time;
/**
- * Number of mandatory keywords for which
- * we have NOT yet found the search result;
- * when this value hits zero, the search
- * result is given to the callback.
+ * Number of mandatory keywords for which we have NOT yet found the
+ * search result; when this value hits zero, the search result is
+ * given to the callback.
*/
uint32_t mandatory_missing;
/**
- * Number of optional keywords under which
- * this result was also found.
+ * Number of optional keywords under which this result was also
+ * found.
*/
uint32_t optional_support;
/**
- * Number of availability tests that
- * have succeeded for this result.
+ * Number of availability tests that have succeeded for this result.
*/
uint32_t availability_success;
/**
- * Number of availability trials that we
- * have performed for this search result.
+ * Number of availability trials that we have performed for this
+ * search result.
*/
uint32_t availability_trials;
/**
- * Information we keep for each keyword in
- * a keyword search.
+ * Add a job to the queue.
+ *
+ * @param h handle to the overall FS state
+ * @param start function to call to begin the job
+ * @param stop function to call to pause the job, or on dequeue (if the job was running)
+ * @param cls closure for start and stop
+ * @param blocks number of blocks this download has
+ * @return queue handle
*/
-struct SearchRequestEntry
-{
- /**
- * Hash of the original keyword, also known as the
- * key (for decrypting the KBlock).
- */
- GNUNET_HashCode key;
+struct GNUNET_FS_QueueEntry *
+GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h,
+ GNUNET_FS_QueueStart start,
+ GNUNET_FS_QueueStop stop,
+ void *cls,
+ unsigned int blocks);
+
+
+/**
+ * Dequeue a job from the queue.
+ * @param qh handle for the job
+ */
+void
+GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh);
+
+
+/**
+ * Function that provides data by reading from a file.
+ *
+ * @param cls closure (points to the file information)
+ * @param offset offset to read from; it is possible
+ * that the caller might need to go backwards
+ * a bit at times
+ * @param max maximum number of bytes that should be
+ * copied to buf; readers are not allowed
+ * to provide less data unless there is an error;
+ * a value of "0" will be used at the end to allow
+ * the reader to clean up its internal state
+ * @param buf where the reader should write the data
+ * @param emsg location for the reader to store an error message
+ * @return number of bytes written, usually "max", 0 on error
+ */
+size_t
+GNUNET_FS_data_reader_file_(void *cls,
+ uint64_t offset,
+ size_t max,
+ void *buf,
+ char **emsg);
+
+
+/**
+ * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
+ *
+ * @param filename file to read
+ * @return closure to use
+ */
+void *
+GNUNET_FS_make_file_reader_context_ (const char *filename);
+
+
+
+/**
+ * Function that provides data by copying from a buffer.
+ *
+ * @param cls closure (points to the buffer)
+ * @param offset offset to read from; it is possible
+ * that the caller might need to go backwards
+ * a bit at times
+ * @param max maximum number of bytes that should be
+ * copied to buf; readers are not allowed
+ * to provide less data unless there is an error;
+ * a value of "0" will be used at the end to allow
+ * the reader to clean up its internal state
+ * @param buf where the reader should write the data
+ * @param emsg location for the reader to store an error message
+ * @return number of bytes written, usually "max", 0 on error
+ */
+size_t
+GNUNET_FS_data_reader_copy_(void *cls,
+ uint64_t offset,
+ size_t max,
+ void *buf,
+ char **emsg);
+
+/**
+ * Notification of FS that a search probe has made progress.
+ * This function is used INSTEAD of the client's event handler
+ * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
+ *
+ * @param cls closure, always NULL (!), actual closure
+ * is in the client-context of the info struct
+ * @param info details about the event, specifying the event type
+ * and various bits about the event
+ * @return client-context (for the next progress call
+ * for this operation; should be set to NULL for
+ * SUSPEND and STOPPED events). The value returned
+ * will be passed to future callbacks in the respective
+ * field in the GNUNET_FS_ProgressInfo struct.
+ */
+void*
+GNUNET_FS_search_probe_progress_ (void *cls,
+ const struct GNUNET_FS_ProgressInfo *info);
+
+
+/**
+ * Main function that performs the upload.
+ *
+ * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
+ * @param tc task context
+ */
+void
+GNUNET_FS_publish_main_ (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc);
+
+
+/**
+ * Function called once the hash of the file
+ * that is being unindexed has been computed.
+ *
+ * @param cls closure, unindex context
+ * @param file_id computed hash, NULL on error
+ */
+void
+GNUNET_FS_unindex_process_hash_ (void *cls,
+ const GNUNET_HashCode *file_id);
+
+
+/**
+ * Fill in all of the generic fields for a publish event and call the
+ * callback.
+ *
+ * @param pi structure to fill in
+ * @param sc overall publishing context
+ * @param p file information for the file being published
+ * @param offset where in the file are we so far
+ * @return value returned from callback
+ */
+void *
+GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
+ struct GNUNET_FS_PublishContext *sc,
+ const struct GNUNET_FS_FileInformation *p,
+ uint64_t offset);
+
+
+/**
+ * Fill in all of the generic fields for a download event and call the
+ * callback.
+ *
+ * @param pi structure to fill in
+ * @param dc overall download context
+ */
+void
+GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
+ struct GNUNET_FS_DownloadContext *dc);
+
+
+/**
+ * Fill in all of the generic fields for
+ * an unindex event and call the callback.
+ *
+ * @param pi structure to fill in
+ * @param uc overall unindex context
+ * @param offset where we are in the file (for progress)
+ */
+void
+GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
+ struct GNUNET_FS_UnindexContext *uc,
+ uint64_t offset);
+
+/**
+ * Fill in all of the generic fields for a search event and
+ * call the callback.
+ *
+ * @param pi structure to fill in
+ * @param sc overall search context
+ * @return value returned by the callback
+ */
+void *
+GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
+ struct GNUNET_FS_SearchContext *sc);
+
+
+/**
+ * Connect to the datastore and remove the blocks.
+ *
+ * @param uc context for the unindex operation.
+ */
+void
+GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc);
+
+/**
+ * Build the request and actually initiate the search using the
+ * GNUnet FS service.
+ *
+ * @param sc search context
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc);
+
+/**
+ * Start the downloading process (by entering the queue).
+ *
+ * @param dc our download context
+ */
+void
+GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc);
+
+
+/**
+ * Start download probes for the given search result.
+ *
+ * @param sr the search result
+ */
+void
+GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr);
+
+/**
+ * Remove serialization/deserialization file from disk.
+ *
+ * @param h master context
+ * @param ext component of the path
+ * @param ent entity identifier
+ */
+void
+GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
+ const char *ext,
+ const char *ent);
+
+
+/**
+ * Remove serialization/deserialization directory from disk.
+ *
+ * @param h master context
+ * @param ext component of the path
+ * @param uni unique name of parent
+ */
+void
+GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
+ const char *ext,
+ const char *uni);
+
+
+/**
+ * Synchronize this file-information struct with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * file information data should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param fi the struct to sync
+ */
+void
+GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f);
+
+/**
+ * Synchronize this publishing struct with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * publishing structs should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param pc the struct to sync
+ */
+void
+GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc);
+
+/**
+ * Synchronize this unindex struct with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * publishing structs should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param uc the struct to sync
+ */
+void
+GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc);
+
+/**
+ * Synchronize this search struct with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * publishing structs should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param sc the struct to sync
+ */
+void
+GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc);
+
+/**
+ * Synchronize this search result with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * publishing structs should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param sr the struct to sync
+ */
+void
+GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
+
+/**
+ * Synchronize this download struct with its mirror
+ * on disk. Note that all internal FS-operations that change
+ * publishing structs should already call "sync" internally,
+ * so this function is likely not useful for clients.
+ *
+ * @param dc the struct to sync
+ */
+void
+GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
+
+/**
+ * Create SUSPEND event for the given publish operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
+ */
+void
+GNUNET_FS_publish_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given search operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
+ */
+void
+GNUNET_FS_search_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given download operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
+ */
+void
+GNUNET_FS_download_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given unindex operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
+ */
+void
+GNUNET_FS_unindex_signal_suspend_ (void *cls);
+
+/**
+ * Function signature of the functions that can be called
+ * to trigger suspend signals and clean-up for top-level
+ * activities.
+ *
+ * @param cls closure
+ */
+typedef void (*SuspendSignalFunction)(void *cls);
+
+/**
+ * We track all of the top-level activities of FS
+ * so that we can signal 'suspend' on shutdown.
+ */
+struct TopLevelActivity
+{
+ /**
+ * This is a doubly-linked list.
+ */
+ struct TopLevelActivity *next;
+
+ /**
+ * This is a doubly-linked list.
+ */
+ struct TopLevelActivity *prev;
+
+ /**
+ * Function to call for suspend-signalling and clean up.
+ */
+ SuspendSignalFunction ssf;
+
+ /**
+ * Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
+ */
+ void *ssf_cls;
+};
+
+
+/**
+ * Create a top-level activity entry.
+ *
+ * @param h global fs handle
+ * @param ssf suspend signal function to use
+ * @param ssf_cls closure for ssf
+ * @return fresh top-level activity handle
+ */
+struct TopLevelActivity *
+GNUNET_FS_make_top (struct GNUNET_FS_Handle *h,
+ SuspendSignalFunction ssf,
+ void *ssf_cls);
+
+
+/**
+ * Destroy a top-level activity entry.
+ *
+ * @param h global fs handle
+ * @param top top level activity entry
+ */
+void
+GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
+ struct TopLevelActivity *top);
+
+
+
+/**
+ * Master context for most FS operations.
+ */
+struct GNUNET_FS_Handle
+{
+ /**
+ * Scheduler.
+ */
+ struct GNUNET_SCHEDULER_Handle *sched;
+
+ /**
+ * Configuration to use.
+ */
+ const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+ /**
+ * Name of our client.
+ */
+ char *client_name;
+
+ /**
+ * Function to call with updates on our progress.
+ */
+ GNUNET_FS_ProgressCallback upcb;
+
+ /**
+ * Closure for upcb.
+ */
+ void *upcb_cls;
+
+ /**
+ * Head of DLL of top-level activities.
+ */
+ struct TopLevelActivity *top_head;
+
+ /**
+ * Tail of DLL of top-level activities.
+ */
+ struct TopLevelActivity *top_tail;
+
+ /**
+ * Head of DLL of running jobs.
+ */
+ struct GNUNET_FS_QueueEntry *running_head;
+
+ /**
+ * Tail of DLL of running jobs.
+ */
+ struct GNUNET_FS_QueueEntry *running_tail;
+
+ /**
+ * Head of DLL of pending jobs.
+ */
+ struct GNUNET_FS_QueueEntry *pending_head;
+
+ /**
+ * Tail of DLL of pending jobs.
+ */
+ struct GNUNET_FS_QueueEntry *pending_tail;
+
+ /**
+ * Task that processes the jobs in the running and pending queues
+ * (and moves jobs around as needed).
+ */
+ GNUNET_SCHEDULER_TaskIdentifier queue_job;
+
+ /**
+ * Average time we take for a single request to be satisfied.
+ * FIXME: not yet calcualted properly...
+ */
+ struct GNUNET_TIME_Relative avg_block_latency;
+
+ /**
+ * How many actual downloads do we have running right now?
+ */
+ unsigned int active_downloads;
+
+ /**
+ * How many blocks do the active downloads have?
+ */
+ unsigned int active_blocks;
+
+ /**
+ * General flags.
+ */
+ enum GNUNET_FS_Flags flags;
+
+ /**
+ * Maximum number of parallel downloads.
+ */
+ unsigned int max_parallel_downloads;
+
+ /**
+ * Maximum number of parallel requests.
+ */
+ unsigned int max_parallel_requests;
+
+};
+
+
+/**
+ * Handle for controlling a publication process.
+ */
+struct GNUNET_FS_PublishContext
+{
+ /**
+ * Handle to the global fs context.
+ */
+ struct GNUNET_FS_Handle *h;
+
+ /**
+ * Our top-level activity entry (if we are top-level, otherwise NULL).
+ */
+ struct TopLevelActivity *top;
+
+ /**
+ * File-structure that is being shared.
+ */
+ struct GNUNET_FS_FileInformation *fi;
+
+ /**
+ * Namespace that we are publishing in, NULL if we have no namespace.
+ */
+ struct GNUNET_FS_Namespace *namespace;
+
+ /**
+ * ID of the content in the namespace, NULL if we have no namespace.
+ */
+ char *nid;
+
+ /**
+ * ID for future updates, NULL if we have no namespace or no updates.
+ */
+ char *nuid;
+
+ /**
+ * Filename used for serializing information about this operation
+ * (should be determined using 'mktemp').
+ */
+ char *serialization;
+
+ /**
+ * Our own client handle for the FS service; only briefly used when
+ * we start to index a file, otherwise NULL.
+ */
+ struct GNUNET_CLIENT_Connection *client;
+
+ /**
+ * Current position in the file-tree for the upload.
+ */
+ struct GNUNET_FS_FileInformation *fi_pos;
+
+ /**
+ * Connection to the datastore service.
+ */
+ struct GNUNET_DATASTORE_Handle *dsh;
+
+ /**
+ * ID of the task performing the upload. NO_TASK if the upload has
+ * completed.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier upload_task;
+
+ /**
+ * Typically GNUNET_NO. Set to GNUNET_YES if "upload_task" is
+ * GNUNET_SCHEDULER_NO_TASK and we're waiting for a response from
+ * the datastore service (in which case this struct must not be
+ * freed until we have that response). If someone tries to stop the
+ * download for good during this period, "in_network_wait" is set to
+ * GNUNET_SYSERR which will cause the struct to be destroyed right
+ * after we have the reply (or timeout) from the datastore service.
+ */
+ int in_network_wait;
+
+ /**
+ * Options for publishing.
+ */
+ enum GNUNET_FS_PublishOptions options;
+
+ /**
+ * Space reservation ID with datastore service
+ * for this upload.
+ */
+ int rid;
+
+ /**
+ * Set to GNUNET_YES if all processing has completed.
+ */
+ int all_done;
+};
+
+
+/**
+ * Phases of unindex processing (state machine).
+ */
+enum UnindexState
+ {
+ /**
+ * We're currently hashing the file.
+ */
+ UNINDEX_STATE_HASHING = 0,
+
+ /**
+ * We're telling the datastore to delete
+ * the respective entries.
+ */
+ UNINDEX_STATE_DS_REMOVE = 1,
+
+ /**
+ * We're notifying the FS service about
+ * the unindexing.
+ */
+ UNINDEX_STATE_FS_NOTIFY = 2,
+
+ /**
+ * We're done.
+ */
+ UNINDEX_STATE_COMPLETE = 3,
+
+ /**
+ * We've encountered a fatal error.
+ */
+ UNINDEX_STATE_ERROR = 4
+
+ };
+
+
+/**
+ * Handle for controlling an unindexing operation.
+ */
+struct GNUNET_FS_UnindexContext
+{
+
+ /**
+ * Global FS context.
+ */
+ struct GNUNET_FS_Handle *h;
+
+ /**
+ * Our top-level activity entry.
+ */
+ struct TopLevelActivity *top;
+
+ /**
+ * Name of the file that we are unindexing.
+ */
+ char *filename;
+
+ /**
+ * Short name under which we are serializing the state of this operation.
+ */
+ char *serialization;
+
+ /**
+ * Connection to the FS service, only valid during the
+ * UNINDEX_STATE_FS_NOTIFY phase.
+ */
+ struct GNUNET_CLIENT_Connection *client;
+
+ /**
+ * Connection to the datastore service, only valid during the
+ * UNINDEX_STATE_DS_NOTIFY phase.
+ */
+ struct GNUNET_DATASTORE_Handle *dsh;
+
+ /**
+ * Pointer kept for the client.
+ */
+ void *client_info;
+
+ /**
+ * Merkle-ish tree encoder context.
+ */
+ struct GNUNET_FS_TreeEncoder *tc;
+
+ /**
+ * Handle used to read the file.
+ */
+ struct GNUNET_DISK_FileHandle *fh;
+
+ /**
+ * Error message, NULL on success.
+ */
+ char *emsg;
+
+ /**
+ * Context for hashing of the file.
+ */
+ struct GNUNET_CRYPTO_FileHashContext *fhc;
+
+ /**
+ * Overall size of the file.
+ */
+ uint64_t file_size;
+
+ /**
+ * When did we start?
+ */
+ struct GNUNET_TIME_Absolute start_time;
+
+ /**
+ * Hash of the file's contents (once computed).
+ */
+ GNUNET_HashCode file_id;
+
+ /**
+ * Current operatinonal phase.
+ */
+ enum UnindexState state;
+
+};
+
+
+/**
+ * Information we keep for each keyword in
+ * a keyword search.
+ */
+struct SearchRequestEntry
+{
+ /**
+ * Hash of the original keyword, also known as the
+ * key (for decrypting the KBlock).
+ */
+ GNUNET_HashCode key;
/**
* Hash of the public key, also known as the query.
GNUNET_HashCode query;
/**
- * Map that contains a "struct SearchResult" for each result that
+ * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
* was found under this keyword. Note that the entries will point
* to the same locations as those in the master result map (in
* "struct GNUNET_FS_SearchContext"), so they should not be freed.
struct GNUNET_FS_Handle *h;
/**
- * List of keywords that we're looking for.
- */
- struct GNUNET_FS_Uri *uri;
-
- /**
- * For update-searches, link to the
- * base-SKS search that triggered the
- * update search; otherwise NULL.
+ * Our top-level activity entry (if we are top-level, otherwise NULL).
*/
- struct GNUNET_FS_SearchContext *parent;
+ struct TopLevelActivity *top;
/**
- * For update-searches, link to the
- * first child search that triggered the
- * update search; otherwise NULL.
+ * List of keywords that we're looking for.
*/
- struct GNUNET_FS_SearchContext *child_head;
+ struct GNUNET_FS_Uri *uri;
/**
- * For update-searches, link to the
- * last child search that triggered the
- * update search; otherwise NULL.
+ * For update-searches, link to the search result that triggered
+ * the update search; otherwise NULL.
*/
- struct GNUNET_FS_SearchContext *child_tail;
+ struct GNUNET_FS_SearchResult *psearch_result;
/**
- * For update-searches, link to the
- * next child belonging to the same parent.
+ * Connection to the FS service.
*/
- struct GNUNET_FS_SearchContext *next;
+ struct GNUNET_CLIENT_Connection *client;
/**
- * For update-searches, link to the
- * previous child belonging to the same
- * parent.
+ * Pointer we keep for the client.
*/
- struct GNUNET_FS_SearchContext *prev;
+ void *client_info;
/**
- * Connection to the FS service.
+ * Name of the file on disk we use for persistence.
*/
- struct GNUNET_CLIENT_Connection *client;
+ char *serialization;
/**
- * Pointer we keep for the client.
+ * Error message (non-NULL if this operation failed).
*/
- void *client_info;
+ char *emsg;
/**
- * Map that contains a "struct SearchResult" for each result that
+ * Map that contains a "struct GNUNET_FS_SearchResult" for each result that
* was found in the search. The key for each entry is the XOR of
* the key and query in the CHK URI (as a unique identifier for the
* search result).
struct GNUNET_CONTAINER_MultiHashMap *master_result_map;
/**
- * Per-keyword information for a keyword search.
- * This array will have exactly as many entries
- * as there were keywords.
+ * Per-keyword information for a keyword search. This array will
+ * have exactly as many entries as there were keywords.
*/
struct SearchRequestEntry *requests;
struct GNUNET_TIME_Absolute start_time;
/**
- * ID of a task that is using this struct
- * and that must be cancelled when the search
- * is being stopped (if not GNUNET_SCHEDULER_NO_TASK).
- * Used for the task that adds some artificial
- * delay when trying to reconnect to the FS
- * service.
+ * ID of a task that is using this struct and that must be cancelled
+ * when the search is being stopped (if not
+ * GNUNET_SCHEDULER_NO_TASK). Used for the task that adds some
+ * artificial delay when trying to reconnect to the FS service.
*/
GNUNET_SCHEDULER_TaskIdentifier task;
* Number of mandatory keywords in this query.
*/
uint32_t mandatory_count;
+
+ /**
+ * Options for the search.
+ */
+ enum GNUNET_FS_SearchOptions options;
};
struct DownloadRequest
{
/**
- * While pending, we keep all download requests
- * in a linked list.
+ * While pending, we keep all download requests in a linked list.
*/
struct DownloadRequest *next;
/**
* Set if this request is currently in the linked list of pending
* requests. Needed in case we get a response for a request that we
- * have not yet send (due to FS bug or two blocks with identical
+ * have not yet send (i.e. due to two blocks with identical
* content); in this case, we would need to remove the block from
* the pending list (and need a fast way to check if the block is on
* it).
* Global FS context.
*/
struct GNUNET_FS_Handle *h;
+
+ /**
+ * Our top-level activity entry (if we are top-level, otherwise NULL).
+ */
+ struct TopLevelActivity *top;
/**
* Connection to the FS service.
*/
struct GNUNET_FS_DownloadContext *parent;
+ /**
+ * Associated search (used when downloading files
+ * based on search results), or NULL for none.
+ */
+ struct GNUNET_FS_SearchResult *search;
+
+ /**
+ * Head of list of child downloads.
+ */
+ struct GNUNET_FS_DownloadContext *child_head;
+
+ /**
+ * Tail of list of child downloads.
+ */
+ struct GNUNET_FS_DownloadContext *child_tail;
+
+ /**
+ * Previous download belonging to the same parent.
+ */
+ struct GNUNET_FS_DownloadContext *prev;
+
+ /**
+ * Next download belonging to the same parent.
+ */
+ struct GNUNET_FS_DownloadContext *next;
+
/**
* Context kept for the client.
*/
*/
char *emsg;
+ /**
+ * Random portion of filename we use for syncing state of this
+ * download.
+ */
+ char *serialization;
+
/**
* Where are we writing the data (name of the
* file, can be NULL!).
*/
char *filename;
+ /**
+ * Where are we writing the data temporarily (name of the
+ * file, can be NULL!); used if we do not have a permanent
+ * name and we are a directory and we do a recursive download.
+ */
+ char *temp_filename;
+
/**
* Map of active requests (those waiting
* for a response). The key is the hash
*/
struct DownloadRequest *pending;
- /**
- * The file handle, NULL if we don't create
- * a file.
- */
- struct GNUNET_DISK_FileHandle *handle;
-
/**
* Non-NULL if we are currently having a request for
* transmission pending with the client handle.
*/
struct GNUNET_CLIENT_TransmitHandle *th;
+ /**
+ * Our entry in the job queue.
+ */
+ struct GNUNET_FS_QueueEntry *job_queue;
+
/**
* Identity of the peer having the content, or all-zeros
* if we don't know of such a peer.
*/
enum GNUNET_FS_DownloadOptions options;
+ /**
+ * Flag set upon transitive completion (includes child downloads).
+ * This flag is only set to GNUNET_YES for directories where all
+ * child-downloads have also completed (and signalled completion).
+ */
+ int has_finished;
+
};
struct GNUNET_FS_Namespace
char *filename;
/**
- * Reference counter.
- */
- unsigned int rc;
-};
-
-
-/**
- * @brief index block (indexing a DBlock that
- * can be obtained directly from reading
- * the plaintext file)
- */
-struct OnDemandBlock
-{
- /**
- * Hash code of the entire content of the
- * file that was indexed (used to uniquely
- * identify the plaintext file).
- */
- GNUNET_HashCode file_id;
-
- /**
- * At which offset should we be able to find
- * this on-demand encoded block? (in NBO)
- */
- uint64_t offset GNUNET_PACKED;
-
-};
-
-
-/**
- * @brief keyword block (advertising data under a keyword)
- */
-struct KBlock
-{
-
- /**
- * GNUNET_RSA_Signature using RSA-key generated from search keyword.
- */
- struct GNUNET_CRYPTO_RsaSignature signature;
-
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
-
- /**
- * Key generated (!) from the H(keyword) as the seed!
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
-
- /* 0-terminated URI here */
-
- /* variable-size Meta-Data follows here */
-
-};
-
-/**
- * @brief namespace content block (advertising data under an identifier in a namespace)
- */
-struct SBlock
-{
-
- /**
- * GNUNET_RSA_Signature using RSA-key of the namespace
- */
- struct GNUNET_CRYPTO_RsaSignature signature;
-
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
-
- /**
- * Hash of the hash of the human-readable identifier used for
- * this entry (the hash of the human-readable identifier is
- * used as the key for decryption; the xor of this identifier
- * and the hash of the "keyspace" is the datastore-query hash).
- */
- GNUNET_HashCode identifier;
-
- /**
- * Public key of the namespace.
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
- /* 0-terminated update-identifier here */
-
- /* 0-terminated URI here (except for NBlocks) */
-
- /* variable-size Meta-Data follows here */
-
-};
-
-
-/**
- * @brief namespace advertisement block (advertising root of a namespace)
- */
-struct NBlock
-{
-
- /**
- * GNUNET_RSA_Signature using RSA-key of the namespace
- */
- struct GNUNET_CRYPTO_RsaSignature signature;
-
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
+ * Name of the namespace.
+ */
+ char *name;
/**
- * Public key of the namespace.
+ * Reference counter.
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
- /* 0-terminated root identifier here */
-
- /* variable-size Meta-Data follows here */
-
+ unsigned int rc;
};
struct GNUNET_MessageHeader header;
/**
- * Should be zero.
+ * Bitmask with options. Zero for no options, one for loopback-only.
+ * Other bits are currently not defined.
*/
- int32_t reserved GNUNET_PACKED;
+ int32_t options GNUNET_PACKED;
/**
* Type of the content that we're looking for.
uint32_t priority GNUNET_PACKED;
/**
- * Relative time to live in GNUNET_CRON_MILLISECONDS (network byte order)
+ * Relative time to live in MILLISECONDS (network byte order)
*/
int32_t ttl GNUNET_PACKED;
projects / oweals / gnunet.git / blobdiff