X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib%2Fapply.h;h=f36f0b3f0e188c89d6934a07d35b60598f53fd38;hp=ed86481074d06bce71b476188a0f33962c4e0ec5;hb=8b709192cd2811b83c248fbe61ca4f11ee9de797;hpb=685da37ac736e4cff2cd69cd03188c28b14b3be7 diff --git a/include/wimlib/apply.h b/include/wimlib/apply.h index ed864810..f36f0b3f 100644 --- a/include/wimlib/apply.h +++ b/include/wimlib/apply.h @@ -31,8 +31,8 @@ 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; @@ -67,20 +67,20 @@ struct apply_ctx { 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) @@ -91,44 +91,59 @@ extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg) 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; } -/* Call this to reset the counter for report_file_created() and - * report_file_metadata_applied(). */ -static inline void -reset_file_progress(struct apply_ctx *ctx) -{ - ctx->count_until_file_progress = 1; -} +extern int +start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count); -/* Report that a file was created, prior to stream extraction. */ +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 stream extraction. */ +/* 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); } -/* 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 +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. @@ -183,18 +198,17 @@ struct apply_operations { * * '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 'file_name'. - * TODO: really, the extraction backends should be responsible for - * generating 'd_extraction_name'. + * 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'. - * 'd_inode->i_extraction_aliases' will contain a list of just the - * dentries of that inode being extracted. This will be a (possibly - * nonproper) subset of the 'd_inode->i_dentry' list. + * 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 streams required to be extracted will already be prepared in - * 'apply_ctx'. The extraction backend should call - * extract_stream_list() to extract them. + * 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 @@ -206,9 +220,10 @@ struct apply_operations { /* * Query whether the unnamed data stream of the specified file will be - * extracted as "externally backed". If so, the extraction backend is - * assumed to handle this separately, and the common extraction code - * will not register a usage of that stream. + * 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. * @@ -217,7 +232,7 @@ struct apply_operations { * = 0 if the file will be externally backed. * > 0 (wimlib error code) if another error occurred. */ - int (*will_externally_back)(struct wim_dentry *dentry, struct apply_ctx *ctx); + int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx); /* * Size of the backend-specific extraction context. It must contain