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 timestamps;
32 unsigned long case_sensitive_filenames;
35 struct blob_descriptor;
36 struct read_blob_callbacks;
37 struct apply_operations;
41 /* The WIMStruct from which files are being extracted from the currently
45 /* The target of the extraction, usually the path to a directory. */
48 /* Length of @target in tchars. */
51 /* Extraction flags (WIMLIB_EXTRACT_FLAG_*) */
54 /* User-provided progress function, or NULL if not specified. */
55 wimlib_progress_func_t progfunc;
58 /* Progress data buffer, with progress.extract initialized. */
59 union wimlib_progress_info progress;
61 /* Features required to extract the files (with counts) */
62 struct wim_features required_features;
64 /* Features supported by the extraction mode (with booleans) */
65 struct wim_features supported_features;
67 /* The members below should not be used outside of extract.c */
68 const struct apply_operations *apply_ops;
70 unsigned long invalid_sequence;
71 unsigned long num_blobs_remaining;
72 struct list_head blob_list;
73 const struct read_blob_callbacks *saved_cbs;
74 struct blob_descriptor *cur_blob;
76 struct filedes tmpfile_fd;
78 unsigned int count_until_file_progress;
81 /* Maximum number of UNIX file descriptors, NTFS attributes, or Windows file
82 * handles that can be opened simultaneously to extract a blob to multiple
84 #define MAX_OPEN_FILES 512
87 extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
89 return call_progress(ctx->progfunc, msg, &ctx->progress, ctx->progctx);
93 do_file_extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg);
95 #define COUNT_PER_FILE_PROGRESS 256
98 maybe_do_file_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
100 ctx->progress.extract.current_file_count++;
101 if (unlikely(!--ctx->count_until_file_progress))
102 return do_file_extract_progress(ctx, msg);
107 start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count);
110 start_file_metadata_phase(struct apply_ctx *ctx, u64 end_file_count);
112 /* Report that a file was created, prior to blob extraction. */
114 report_file_created(struct apply_ctx *ctx)
116 return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE);
119 /* Report that file metadata was applied, after blob extraction. */
121 report_file_metadata_applied(struct apply_ctx *ctx)
123 return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_METADATA);
127 end_file_structure_phase(struct apply_ctx *ctx);
130 end_file_metadata_phase(struct apply_ctx *ctx);
133 report_apply_error(struct apply_ctx *ctx, int error_code, const tchar *path)
135 return report_error(ctx->progfunc, ctx->progctx, error_code, path);
138 #define inode_first_extraction_dentry(inode) \
139 ((inode)->i_first_extraction_alias)
141 #define inode_for_each_extraction_alias(dentry, inode) \
142 for (dentry = inode_first_extraction_dentry(inode); \
144 dentry = dentry->d_next_extraction_alias)
147 extract_blob_list(struct apply_ctx *ctx, const struct read_blob_callbacks *cbs);
150 * Represents an extraction backend.
152 struct apply_operations {
154 /* Name of the extraction backend. */
158 * Query the features supported by the extraction backend.
161 * The target string that was provided by the user. (Often a
162 * directory, but extraction backends are free to interpret this
165 * @supported_features
166 * A structure, each of whose members represents a feature that may
167 * be supported by the extraction backend. For each feature that
168 * the extraction backend supports, this routine must set the
169 * corresponding member to a nonzero value.
171 * Return 0 if successful; otherwise a positive wimlib error code.
173 int (*get_supported_features)(const tchar *target,
174 struct wim_features *supported_features);
177 * Main extraction routine.
179 * The extraction backend is provided a list of dentries that have been
180 * prepared for extraction. It is free to extract them in any way that
181 * it chooses. Ideally, it should choose a method that maximizes
184 * The target string will be provided in ctx->common.target. This might
185 * be a directory, although extraction backends are free to interpret it
186 * as they wish. TODO: in some cases, the common extraction code also
187 * interprets the target string. This should be completely isolated to
188 * extraction backends.
190 * The extraction flags will be provided in ctx->common.extract_flags.
191 * Extraction backends should examine them and implement the behaviors
192 * for as many flags as possible. Some flags are already handled by the
193 * common extraction code. TODO: this needs to be better formalized.
195 * @dentry_list, the list of dentries, will be ordered such that the
196 * ancestor of any dentry always precedes any descendents. Unless
197 * @single_tree_only is set, it's possible that the dentries consist of
198 * multiple disconnected trees.
200 * 'd_extraction_name' and 'd_extraction_name_nchars' of each dentry
201 * will be set to indicate the actual name with which the dentry should
202 * be extracted. This may or may not be the same as 'd_name'. TODO:
203 * really, the extraction backends should be responsible for generating
204 * 'd_extraction_name'.
206 * Each dentry will refer to a valid inode in 'd_inode'. Each inode
207 * will contain a list of dentries of that inode being extracted; this
208 * list may be shorter than the inode's full dentry list.
210 * The blobs required to be extracted will already be prepared in
211 * 'apply_ctx'. The extraction backend should call extract_blob_list()
214 * The will_extract_dentry() utility function, given an arbitrary dentry
215 * in the WIM image (which may not be in the extraction list), can be
216 * used to determine if that dentry is in the extraction list.
218 * Return 0 if successful; otherwise a positive wimlib error code.
220 int (*extract)(struct list_head *dentry_list, struct apply_ctx *ctx);
223 * Query whether the unnamed data stream of the specified file will be
224 * extracted as "externally backed" from the WIM archive itself. If so,
225 * then the extraction backend is assumed to handle this separately, and
226 * the common extraction code will not register a usage of the unnamed
227 * data stream's blob.
229 * This routine is optional.
232 * < 0 if the file will *not* be externally backed.
233 * = 0 if the file will be externally backed.
234 * > 0 (wimlib error code) if another error occurred.
236 int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx);
239 * Size of the backend-specific extraction context. It must contain
240 * 'struct apply_ctx' as its first member.
245 * Set this if the extraction backend only supports extracting dentries
246 * that form a single tree, not multiple trees.
248 bool single_tree_only;
252 extern const struct apply_operations win32_apply_ops;
254 extern const struct apply_operations unix_apply_ops;
258 extern const struct apply_operations ntfs_3g_apply_ops;
261 #endif /* _WIMLIB_APPLY_H */