1 #ifndef _WIMLIB_APPLY_H
2 #define _WIMLIB_APPLY_H
4 #include "wimlib/compiler.h"
5 #include "wimlib/file_io.h"
6 #include "wimlib/list.h"
7 #include "wimlib/progress.h"
8 #include "wimlib/types.h"
11 /* These can be treated as counts (for required_features) or booleans (for
12 * supported_features). */
14 unsigned long readonly_files;
15 unsigned long hidden_files;
16 unsigned long system_files;
17 unsigned long archive_files;
18 unsigned long compressed_files;
19 unsigned long encrypted_files;
20 unsigned long encrypted_directories;
21 unsigned long not_context_indexed_files;
22 unsigned long sparse_files;
23 unsigned long named_data_streams;
24 unsigned long hard_links;
25 unsigned long reparse_points;
26 unsigned long symlink_reparse_points;
27 unsigned long other_reparse_points;
28 unsigned long security_descriptors;
29 unsigned long short_names;
30 unsigned long unix_data;
31 unsigned long object_ids;
32 unsigned long timestamps;
33 unsigned long case_sensitive_filenames;
36 struct blob_descriptor;
37 struct read_blob_callbacks;
38 struct apply_operations;
42 /* The WIMStruct from which files are being extracted from the currently
46 /* The target of the extraction, usually the path to a directory. */
49 /* Length of @target in tchars. */
52 /* Extraction flags (WIMLIB_EXTRACT_FLAG_*) */
55 /* User-provided progress function, or NULL if not specified. */
56 wimlib_progress_func_t progfunc;
59 /* Progress data buffer, with progress.extract initialized. */
60 union wimlib_progress_info progress;
62 /* Features required to extract the files (with counts) */
63 struct wim_features required_features;
65 /* Features supported by the extraction mode (with booleans) */
66 struct wim_features supported_features;
68 /* The members below should not be used outside of extract.c */
69 const struct apply_operations *apply_ops;
71 unsigned long invalid_sequence;
72 unsigned long num_blobs_remaining;
73 struct list_head blob_list;
74 const struct read_blob_callbacks *saved_cbs;
75 struct blob_descriptor *cur_blob;
77 struct filedes tmpfile_fd;
79 unsigned int count_until_file_progress;
82 /* Maximum number of UNIX file descriptors, NTFS attributes, or Windows file
83 * handles that can be opened simultaneously to extract a blob to multiple
85 #define MAX_OPEN_FILES 512
88 extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
90 return call_progress(ctx->progfunc, msg, &ctx->progress, ctx->progctx);
94 do_file_extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg);
96 #define COUNT_PER_FILE_PROGRESS 256
99 maybe_do_file_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
101 ctx->progress.extract.current_file_count++;
102 if (unlikely(!--ctx->count_until_file_progress))
103 return do_file_extract_progress(ctx, msg);
108 start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count);
111 start_file_metadata_phase(struct apply_ctx *ctx, u64 end_file_count);
113 /* Report that a file was created, prior to blob extraction. */
115 report_file_created(struct apply_ctx *ctx)
117 return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE);
120 /* Report that file metadata was applied, after blob extraction. */
122 report_file_metadata_applied(struct apply_ctx *ctx)
124 return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_METADATA);
128 end_file_structure_phase(struct apply_ctx *ctx);
131 end_file_metadata_phase(struct apply_ctx *ctx);
134 report_apply_error(struct apply_ctx *ctx, int error_code, const tchar *path)
136 return report_error(ctx->progfunc, ctx->progctx, error_code, path);
139 #define inode_first_extraction_dentry(inode) \
140 ((inode)->i_first_extraction_alias)
142 #define inode_for_each_extraction_alias(dentry, inode) \
143 for (dentry = inode_first_extraction_dentry(inode); \
145 dentry = dentry->d_next_extraction_alias)
148 extract_blob_list(struct apply_ctx *ctx, const struct read_blob_callbacks *cbs);
151 * Represents an extraction backend.
153 struct apply_operations {
155 /* Name of the extraction backend. */
159 * Query the features supported by the extraction backend.
162 * The target string that was provided by the user. (Often a
163 * directory, but extraction backends are free to interpret this
166 * @supported_features
167 * A structure, each of whose members represents a feature that may
168 * be supported by the extraction backend. For each feature that
169 * the extraction backend supports, this routine must set the
170 * corresponding member to a nonzero value.
172 * Return 0 if successful; otherwise a positive wimlib error code.
174 int (*get_supported_features)(const tchar *target,
175 struct wim_features *supported_features);
178 * Main extraction routine.
180 * The extraction backend is provided a list of dentries that have been
181 * prepared for extraction. It is free to extract them in any way that
182 * it chooses. Ideally, it should choose a method that maximizes
185 * The target string will be provided in ctx->common.target. This might
186 * be a directory, although extraction backends are free to interpret it
187 * as they wish. TODO: in some cases, the common extraction code also
188 * interprets the target string. This should be completely isolated to
189 * extraction backends.
191 * The extraction flags will be provided in ctx->common.extract_flags.
192 * Extraction backends should examine them and implement the behaviors
193 * for as many flags as possible. Some flags are already handled by the
194 * common extraction code. TODO: this needs to be better formalized.
196 * @dentry_list, the list of dentries, will be ordered such that the
197 * ancestor of any dentry always precedes any descendents. Unless
198 * @single_tree_only is set, it's possible that the dentries consist of
199 * multiple disconnected trees.
201 * 'd_extraction_name' and 'd_extraction_name_nchars' of each dentry
202 * will be set to indicate the actual name with which the dentry should
203 * be extracted. This may or may not be the same as 'd_name'. TODO:
204 * really, the extraction backends should be responsible for generating
205 * 'd_extraction_name'.
207 * Each dentry will refer to a valid inode in 'd_inode'. Each inode
208 * will contain a list of dentries of that inode being extracted; this
209 * list may be shorter than the inode's full dentry list.
211 * The blobs required to be extracted will already be prepared in
212 * 'apply_ctx'. The extraction backend should call extract_blob_list()
215 * The will_extract_dentry() utility function, given an arbitrary dentry
216 * in the WIM image (which may not be in the extraction list), can be
217 * used to determine if that dentry is in the extraction list.
219 * Return 0 if successful; otherwise a positive wimlib error code.
221 int (*extract)(struct list_head *dentry_list, struct apply_ctx *ctx);
224 * Query whether the unnamed data stream of the specified file will be
225 * extracted as "externally backed" from the WIM archive itself. If so,
226 * then the extraction backend is assumed to handle this separately, and
227 * the common extraction code will not register a usage of the unnamed
228 * data stream's blob.
230 * This routine is optional.
233 * < 0 if the file will *not* be externally backed.
234 * = 0 if the file will be externally backed.
235 * > 0 (wimlib error code) if another error occurred.
237 int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx);
240 * Size of the backend-specific extraction context. It must contain
241 * 'struct apply_ctx' as its first member.
246 * Set this if the extraction backend only supports extracting dentries
247 * that form a single tree, not multiple trees.
249 bool single_tree_only;
253 extern const struct apply_operations win32_apply_ops;
255 extern const struct apply_operations unix_apply_ops;
259 extern const struct apply_operations ntfs_3g_apply_ops;
262 #endif /* _WIMLIB_APPLY_H */