extract: track READONLY attribute in supported_features
[wimlib] / include / wimlib / apply.h
1 #ifndef _WIMLIB_APPLY_H
2 #define _WIMLIB_APPLY_H
3
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"
9 #include "wimlib.h"
10
11 /* These can be treated as counts (for required_features) or booleans (for
12  * supported_features).  */
13 struct wim_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;
33 };
34
35 struct blob_descriptor;
36 struct read_blob_callbacks;
37 struct apply_operations;
38 struct wim_dentry;
39
40 struct apply_ctx {
41         /* The WIMStruct from which files are being extracted from the currently
42          * selected image.  */
43         WIMStruct *wim;
44
45         /* The target of the extraction, usually the path to a directory.  */
46         const tchar *target;
47
48         /* Length of @target in tchars.  */
49         size_t target_nchars;
50
51         /* Extraction flags (WIMLIB_EXTRACT_FLAG_*)  */
52         int extract_flags;
53
54         /* User-provided progress function, or NULL if not specified.  */
55         wimlib_progress_func_t progfunc;
56         void *progctx;
57
58         /* Progress data buffer, with progress.extract initialized.  */
59         union wimlib_progress_info progress;
60
61         /* Features required to extract the files (with counts)  */
62         struct wim_features required_features;
63
64         /* Features supported by the extraction mode (with booleans)  */
65         struct wim_features supported_features;
66
67         /* The members below should not be used outside of extract.c  */
68         const struct apply_operations *apply_ops;
69         u64 next_progress;
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;
75         u64 cur_blob_offset;
76         struct filedes tmpfile_fd;
77         tchar *tmpfile_name;
78         unsigned int count_until_file_progress;
79 };
80
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
83  * destinations.  */
84 #define MAX_OPEN_FILES 512
85
86 static inline int
87 extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
88 {
89         return call_progress(ctx->progfunc, msg, &ctx->progress, ctx->progctx);
90 }
91
92 extern int
93 do_file_extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg);
94
95 #define COUNT_PER_FILE_PROGRESS 256
96
97 static inline int
98 maybe_do_file_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
99 {
100         ctx->progress.extract.current_file_count++;
101         if (unlikely(!--ctx->count_until_file_progress))
102                 return do_file_extract_progress(ctx, msg);
103         return 0;
104 }
105
106 extern int
107 start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count);
108
109 extern int
110 start_file_metadata_phase(struct apply_ctx *ctx, u64 end_file_count);
111
112 /* Report that a file was created, prior to blob extraction.  */
113 static inline int
114 report_file_created(struct apply_ctx *ctx)
115 {
116         return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE);
117 }
118
119 /* Report that file metadata was applied, after blob extraction.  */
120 static inline int
121 report_file_metadata_applied(struct apply_ctx *ctx)
122 {
123         return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_METADATA);
124 }
125
126 extern int
127 end_file_structure_phase(struct apply_ctx *ctx);
128
129 extern int
130 end_file_metadata_phase(struct apply_ctx *ctx);
131
132 static inline int
133 report_apply_error(struct apply_ctx *ctx, int error_code, const tchar *path)
134 {
135         return report_error(ctx->progfunc, ctx->progctx, error_code, path);
136 }
137
138 #define inode_first_extraction_dentry(inode)                            \
139         ((inode)->i_first_extraction_alias)
140
141 #define inode_for_each_extraction_alias(dentry, inode)                  \
142         for (dentry = inode_first_extraction_dentry(inode);             \
143              dentry != NULL;                                            \
144              dentry = dentry->d_next_extraction_alias)
145
146 extern int
147 extract_blob_list(struct apply_ctx *ctx, const struct read_blob_callbacks *cbs);
148
149 /*
150  * Represents an extraction backend.
151  */
152 struct apply_operations {
153
154         /* Name of the extraction backend.  */
155         const char *name;
156
157         /*
158          * Query the features supported by the extraction backend.
159          *
160          * @target
161          *      The target string that was provided by the user.  (Often a
162          *      directory, but extraction backends are free to interpret this
163          *      differently.)
164          *
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.
170          *
171          * Return 0 if successful; otherwise a positive wimlib error code.
172          */
173         int (*get_supported_features)(const tchar *target,
174                                       struct wim_features *supported_features);
175
176         /*
177          * Main extraction routine.
178          *
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
182          * performance.
183          *
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.
189          *
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.
194          *
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.
199          *
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'.
205          *
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.
209          *
210          * The blobs required to be extracted will already be prepared in
211          * 'apply_ctx'.  The extraction backend should call extract_blob_list()
212          * to extract them.
213          *
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.
217          *
218          * Return 0 if successful; otherwise a positive wimlib error code.
219          */
220         int (*extract)(struct list_head *dentry_list, struct apply_ctx *ctx);
221
222         /*
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.
228          *
229          * This routine is optional.
230          *
231          * Return:
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.
235          */
236         int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx);
237
238         /*
239          * Size of the backend-specific extraction context.  It must contain
240          * 'struct apply_ctx' as its first member.
241          */
242         size_t context_size;
243
244         /*
245          * Set this if the extraction backend only supports extracting dentries
246          * that form a single tree, not multiple trees.
247          */
248         bool single_tree_only;
249 };
250
251 #ifdef __WIN32__
252   extern const struct apply_operations win32_apply_ops;
253 #else
254   extern const struct apply_operations unix_apply_ops;
255 #endif
256
257 #ifdef WITH_NTFS_3G
258   extern const struct apply_operations ntfs_3g_apply_ops;
259 #endif
260
261 #endif /* _WIMLIB_APPLY_H */