+
/*
This file is part of GNUnet.
(C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
#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 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_TreeEncoder *te;
/**
- * Error message (non-NULL if this operation
- * failed).
+ * Error message (non-NULL if this operation failed).
*/
char *emsg;
} data;
- /**
- * Is this struct for a file or directory?
- */
- int is_directory;
-
/**
* Desired anonymity level.
*/
*/
uint32_t priority;
+ /**
+ * Is this struct for a file or directory?
+ */
+ int is_directory;
+
+ /**
+ * Are we done publishing this file?
+ */
+ int is_published;
+
};
+/**
+ * Information we store for each search result.
+ */
+struct GNUNET_FS_SearchResult
+{
+
+ /**
+ * Search context this result belongs to.
+ */
+ struct GNUNET_FS_SearchContext *sc;
+
+ /**
+ * URI to which this search result refers to.
+ */
+ struct GNUNET_FS_Uri *uri;
+
+ /**
+ * Metadata for the search result.
+ */
+ struct GNUNET_CONTAINER_MetaData *meta;
+
+ /**
+ * Client info for this search result.
+ */
+ void *client_info;
+
+ /**
+ * 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 an associated download based on this search result (or
+ * NULL for none).
+ */
+ struct GNUNET_FS_DownloadContext *download;
+
+ /**
+ * If this search result triggered an update search, this field
+ * links to the update search.
+ */
+ struct GNUNET_FS_SearchContext *update_search;
+
+ /**
+ * Name under which this search result is stored on disk.
+ */
+ char *serialization;
+
+ /**
+ * Key for the search result
+ */
+ GNUNET_HashCode key;
+
+ /**
+ * 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).
+ */
+ GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
+
+ /**
+ * When did the current probe become active?
+ */
+ struct GNUNET_TIME_Absolute probe_active_time;
+
+ /**
+ * How much longer should we run the current probe before giving up?
+ */
+ 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.
+ */
+ uint32_t mandatory_missing;
+
+ /**
+ * 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.
+ */
+ uint32_t availability_success;
+
+ /**
+ * Number of availability trials that we have performed for this
+ * search result.
+ */
+ uint32_t availability_trials;
+
+};
+
+
/**
* Add a job to the queue.
*
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.
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.
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
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);
+
/**
void *upcb_cls;
/**
- * Connection to the FS service.
+ * Head of DLL of top-level activities.
*/
- struct GNUNET_CLIENT_Connection *client;
+ struct TopLevelActivity *top_head;
+
+ /**
+ * Tail of DLL of top-level activities.
+ */
+ struct TopLevelActivity *top_tail;
/**
* Head of DLL of running jobs.
*/
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.
*/
/**
* We've encountered a fatal error.
*/
- UNINDEX_STATE_ERROR = 4,
+ UNINDEX_STATE_ERROR = 4
- /**
- * We've been aborted. The next callback should clean up the
- * struct.
- */
- UNINDEX_STATE_ABORTED = 5
};
*/
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_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.
*/
};
-/**
- * Information we store for each search result.
- */
-struct SearchResult
-{
-
- /**
- * Search context this result belongs to.
- */
- struct GNUNET_FS_SearchContext *sc;
-
- /**
- * URI to which this search result refers to.
- */
- struct GNUNET_FS_Uri *uri;
-
- /**
- * Metadata for the search result.
- */
- struct GNUNET_CONTAINER_MetaData *meta;
-
- /**
- * Client info for this search result.
- */
- void *client_info;
-
- /**
- * 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).
- */
- GNUNET_SCHEDULER_TaskIdentifier probe_cancel_task;
-
- /**
- * When did the current probe become active?
- */
- struct GNUNET_TIME_Absolute probe_active_time;
-
- /**
- * How much longer should we run the current probe before giving up?
- */
- 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.
- */
- uint32_t mandatory_missing;
-
- /**
- * 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.
- */
- uint32_t availability_success;
-
- /**
- * 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.
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
+ * 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).
/**
* 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.
*/
*/
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!).
*/
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.
*/
char *filename;
+ /**
+ * Name of the namespace.
+ */
+ char *name;
+
/**
* Reference counter.
*/