X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib%2Fapply.h;h=f36f0b3f0e188c89d6934a07d35b60598f53fd38;hp=2f3b1cb941ab3b61a8821357f2cf2091d50a4f72;hb=8b709192cd2811b83c248fbe61ca4f11ee9de797;hpb=4c532e2a9f1a40e1c1a6ed44a50025cfbfab6e4f diff --git a/include/wimlib/apply.h b/include/wimlib/apply.h index 2f3b1cb9..f36f0b3f 100644 --- a/include/wimlib/apply.h +++ b/include/wimlib/apply.h @@ -1,6 +1,7 @@ #ifndef _WIMLIB_APPLY_H #define _WIMLIB_APPLY_H +#include "wimlib/compiler.h" #include "wimlib/file_io.h" #include "wimlib/list.h" #include "wimlib/progress.h" @@ -30,8 +31,10 @@ struct wim_features { unsigned long case_sensitive_filenames; }; -struct wim_lookup_table_entry; -struct read_stream_list_callbacks; +struct blob_descriptor; +struct read_blob_callbacks; +struct apply_operations; +struct wim_dentry; struct apply_ctx { /* The WIMStruct from which files are being extracted from the currently @@ -61,21 +64,23 @@ struct apply_ctx { struct wim_features supported_features; /* The members below should not be used outside of extract.c */ + const struct apply_operations *apply_ops; u64 next_progress; unsigned long invalid_sequence; - unsigned long num_streams_remaining; - struct list_head stream_list; - const struct read_stream_list_callbacks *saved_cbs; - struct wim_lookup_table_entry *cur_stream; - u64 cur_stream_offset; + unsigned long num_blobs_remaining; + struct list_head blob_list; + const struct read_blob_callbacks *saved_cbs; + struct blob_descriptor *cur_blob; + u64 cur_blob_offset; struct filedes tmpfile_fd; tchar *tmpfile_name; + unsigned int count_until_file_progress; }; /* Maximum number of UNIX file descriptors, NTFS attributes, or Windows file - * handles that can be opened simultaneously to extract a single-instance - * stream to multiple destinations. */ -#define MAX_OPEN_STREAMS 512 + * handles that can be opened simultaneously to extract a blob to multiple + * destinations. */ +#define MAX_OPEN_FILES 512 static inline int extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg) @@ -83,23 +88,162 @@ extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg) return call_progress(ctx->progfunc, msg, &ctx->progress, ctx->progctx); } -/* Returns any of the aliases of an inode that are being extracted. */ -#define inode_first_extraction_dentry(inode) \ - list_first_entry(&(inode)->i_extraction_aliases, \ - struct wim_dentry, d_extraction_alias_node) +extern int +do_file_extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg); + +#define COUNT_PER_FILE_PROGRESS 256 + +static inline int +maybe_do_file_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg) +{ + ctx->progress.extract.current_file_count++; + if (unlikely(!--ctx->count_until_file_progress)) + return do_file_extract_progress(ctx, msg); + return 0; +} + +extern int +start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count); + +extern int +start_file_metadata_phase(struct apply_ctx *ctx, u64 end_file_count); + +/* Report that a file was created, prior to blob extraction. */ +static inline int +report_file_created(struct apply_ctx *ctx) +{ + return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE); +} + +/* Report that file metadata was applied, after blob extraction. */ +static inline int +report_file_metadata_applied(struct apply_ctx *ctx) +{ + return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_METADATA); +} + +extern int +end_file_structure_phase(struct apply_ctx *ctx); + +extern int +end_file_metadata_phase(struct apply_ctx *ctx); + +static inline int +report_apply_error(struct apply_ctx *ctx, int error_code, const tchar *path) +{ + return report_error(ctx->progfunc, ctx->progctx, error_code, path); +} + +#define inode_first_extraction_dentry(inode) \ + ((inode)->i_first_extraction_alias) + +#define inode_for_each_extraction_alias(dentry, inode) \ + for (dentry = inode_first_extraction_dentry(inode); \ + dentry != NULL; \ + dentry = dentry->d_next_extraction_alias) extern int -extract_stream_list(struct apply_ctx *ctx, - const struct read_stream_list_callbacks *cbs); +extract_blob_list(struct apply_ctx *ctx, const struct read_blob_callbacks *cbs); +/* + * Represents an extraction backend. + */ struct apply_operations { + + /* Name of the extraction backend. */ const char *name; + + /* + * Query the features supported by the extraction backend. + * + * @target + * The target string that was provided by the user. (Often a + * directory, but extraction backends are free to interpret this + * differently.) + * + * @supported_features + * A structure, each of whose members represents a feature that may + * be supported by the extraction backend. For each feature that + * the extraction backend supports, this routine must set the + * corresponding member to a nonzero value. + * + * Return 0 if successful; otherwise a positive wimlib error code. + */ int (*get_supported_features)(const tchar *target, struct wim_features *supported_features); + /* + * Main extraction routine. + * + * The extraction backend is provided a list of dentries that have been + * prepared for extraction. It is free to extract them in any way that + * it chooses. Ideally, it should choose a method that maximizes + * performance. + * + * The target string will be provided in ctx->common.target. This might + * be a directory, although extraction backends are free to interpret it + * as they wish. TODO: in some cases, the common extraction code also + * interprets the target string. This should be completely isolated to + * extraction backends. + * + * The extraction flags will be provided in ctx->common.extract_flags. + * Extraction backends should examine them and implement the behaviors + * for as many flags as possible. Some flags are already handled by the + * common extraction code. TODO: this needs to be better formalized. + * + * @dentry_list, the list of dentries, will be ordered such that the + * ancestor of any dentry always precedes any descendents. Unless + * @single_tree_only is set, it's possible that the dentries consist of + * multiple disconnected trees. + * + * 'd_extraction_name' and 'd_extraction_name_nchars' of each dentry + * will be set to indicate the actual name with which the dentry should + * be extracted. This may or may not be the same as 'd_name'. TODO: + * really, the extraction backends should be responsible for generating + * 'd_extraction_name'. + * + * Each dentry will refer to a valid inode in 'd_inode'. Each inode + * will contain a list of dentries of that inode being extracted; this + * list may be shorter than the inode's full dentry list. + * + * The blobs required to be extracted will already be prepared in + * 'apply_ctx'. The extraction backend should call extract_blob_list() + * to extract them. + * + * The will_extract_dentry() utility function, given an arbitrary dentry + * in the WIM image (which may not be in the extraction list), can be + * used to determine if that dentry is in the extraction list. + * + * Return 0 if successful; otherwise a positive wimlib error code. + */ int (*extract)(struct list_head *dentry_list, struct apply_ctx *ctx); + /* + * Query whether the unnamed data stream of the specified file will be + * extracted as "externally backed" from the WIM archive itself. If so, + * then the extraction backend is assumed to handle this separately, and + * the common extraction code will not register a usage of the unnamed + * data stream's blob. + * + * This routine is optional. + * + * Return: + * < 0 if the file will *not* be externally backed. + * = 0 if the file will be externally backed. + * > 0 (wimlib error code) if another error occurred. + */ + int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx); + + /* + * Size of the backend-specific extraction context. It must contain + * 'struct apply_ctx' as its first member. + */ size_t context_size; + + /* + * Set this if the extraction backend only supports extracting dentries + * that form a single tree, not multiple trees. + */ bool single_tree_only; };