wimlib.net Git - wimlib/blob - 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 object_ids;
  32         unsigned long timestamps;
  33         unsigned long case_sensitive_filenames;
  34 };
  35
  36 struct blob_descriptor;
  37 struct read_blob_callbacks;
  38 struct apply_operations;
  39 struct wim_dentry;
  40
  41 struct apply_ctx {
  42         /* The WIMStruct from which files are being extracted from the currently
  43          * selected image.  */
  44         WIMStruct *wim;
  45
  46         /* The target of the extraction, usually the path to a directory.  */
  47         const tchar *target;
  48
  49         /* Length of @target in tchars.  */
  50         size_t target_nchars;
  51
  52         /* Extraction flags (WIMLIB_EXTRACT_FLAG_*)  */
  53         int extract_flags;
  54
  55         /* User-provided progress function, or NULL if not specified.  */
  56         wimlib_progress_func_t progfunc;
  57         void *progctx;
  58
  59         /* Progress data buffer, with progress.extract initialized.  */
  60         union wimlib_progress_info progress;
  61
  62         /* Features required to extract the files (with counts)  */
  63         struct wim_features required_features;
  64
  65         /* Features supported by the extraction mode (with booleans)  */
  66         struct wim_features supported_features;
  67
  68         /* The members below should not be used outside of extract.c  */
  69         const struct apply_operations *apply_ops;
  70         u64 next_progress;
  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 filedes tmpfile_fd;
  76         tchar *tmpfile_name;
  77         unsigned int count_until_file_progress;
  78 };
  79
  80 /* Maximum number of UNIX file descriptors, NTFS attributes, or Windows file
  81  * handles that can be opened simultaneously to extract a blob to multiple
  82  * destinations.  */
  83 #define MAX_OPEN_FILES 512
  84
  85 static inline int
  86 extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
  87 {
  88         return call_progress(ctx->progfunc, msg, &ctx->progress, ctx->progctx);
  89 }
  90
  91 extern int
  92 do_file_extract_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg);
  93
  94 #define COUNT_PER_FILE_PROGRESS 256
  95
  96 static inline int
  97 maybe_do_file_progress(struct apply_ctx *ctx, enum wimlib_progress_msg msg)
  98 {
  99         ctx->progress.extract.current_file_count++;
 100         if (unlikely(!--ctx->count_until_file_progress))
 101                 return do_file_extract_progress(ctx, msg);
 102         return 0;
 103 }
 104
 105 extern int
 106 start_file_structure_phase(struct apply_ctx *ctx, u64 end_file_count);
 107
 108 extern int
 109 start_file_metadata_phase(struct apply_ctx *ctx, u64 end_file_count);
 110
 111 /* Report that a file was created, prior to blob extraction.  */
 112 static inline int
 113 report_file_created(struct apply_ctx *ctx)
 114 {
 115         return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE);
 116 }
 117
 118 /* Report that file metadata was applied, after blob extraction.  */
 119 static inline int
 120 report_file_metadata_applied(struct apply_ctx *ctx)
 121 {
 122         return maybe_do_file_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_METADATA);
 123 }
 124
 125 extern int
 126 end_file_structure_phase(struct apply_ctx *ctx);
 127
 128 extern int
 129 end_file_metadata_phase(struct apply_ctx *ctx);
 130
 131 static inline int
 132 report_apply_error(struct apply_ctx *ctx, int error_code, const tchar *path)
 133 {
 134         return report_error(ctx->progfunc, ctx->progctx, error_code, path);
 135 }
 136
 137 extern bool
 138 detect_sparse_region(const void *data, size_t size, size_t *len_ret);
 139
 140 static inline bool
 141 maybe_detect_sparse_region(const void *data, size_t size, size_t *len_ret,
 142                            bool enabled)
 143 {
 144         if (!enabled) {
 145                 /* Force non-sparse without checking */
 146                 *len_ret = size;
 147                 return false;
 148         }
 149         return detect_sparse_region(data, size, len_ret);
 150 }
 151
 152 #define inode_first_extraction_dentry(inode)                            \
 153         ((inode)->i_first_extraction_alias)
 154
 155 #define inode_for_each_extraction_alias(dentry, inode)                  \
 156         for (dentry = inode_first_extraction_dentry(inode);             \
 157              dentry != NULL;                                            \
 158              dentry = dentry->d_next_extraction_alias)
 159
 160 extern int
 161 extract_blob_list(struct apply_ctx *ctx, const struct read_blob_callbacks *cbs);
 162
 163 /*
 164  * Represents an extraction backend.
 165  */
 166 struct apply_operations {
 167
 168         /* Name of the extraction backend.  */
 169         const char *name;
 170
 171         /*
 172          * Query the features supported by the extraction backend.
 173          *
 174          * @target
 175          *      The target string that was provided by the user.  (Often a
 176          *      directory, but extraction backends are free to interpret this
 177          *      differently.)
 178          *
 179          * @supported_features
 180          *      A structure, each of whose members represents a feature that may
 181          *      be supported by the extraction backend.  For each feature that
 182          *      the extraction backend supports, this routine must set the
 183          *      corresponding member to a nonzero value.
 184          *
 185          * Return 0 if successful; otherwise a positive wimlib error code.
 186          */
 187         int (*get_supported_features)(const tchar *target,
 188                                       struct wim_features *supported_features);
 189
 190         /*
 191          * Main extraction routine.
 192          *
 193          * The extraction backend is provided a list of dentries that have been
 194          * prepared for extraction.  It is free to extract them in any way that
 195          * it chooses.  Ideally, it should choose a method that maximizes
 196          * performance.
 197          *
 198          * The target string will be provided in ctx->common.target.  This might
 199          * be a directory, although extraction backends are free to interpret it
 200          * as they wish.  TODO: in some cases, the common extraction code also
 201          * interprets the target string.  This should be completely isolated to
 202          * extraction backends.
 203          *
 204          * The extraction flags will be provided in ctx->common.extract_flags.
 205          * Extraction backends should examine them and implement the behaviors
 206          * for as many flags as possible.  Some flags are already handled by the
 207          * common extraction code.  TODO: this needs to be better formalized.
 208          *
 209          * @dentry_list, the list of dentries, will be ordered such that the
 210          * ancestor of any dentry always precedes any descendents.  Unless
 211          * @single_tree_only is set, it's possible that the dentries consist of
 212          * multiple disconnected trees.
 213          *
 214          * 'd_extraction_name' and 'd_extraction_name_nchars' of each dentry
 215          * will be set to indicate the actual name with which the dentry should
 216          * be extracted.  This may or may not be the same as 'd_name'.  TODO:
 217          * really, the extraction backends should be responsible for generating
 218          * 'd_extraction_name'.
 219          *
 220          * Each dentry will refer to a valid inode in 'd_inode'.  Each inode
 221          * will contain a list of dentries of that inode being extracted; this
 222          * list may be shorter than the inode's full dentry list.
 223          *
 224          * The blobs required to be extracted will already be prepared in
 225          * 'apply_ctx'.  The extraction backend should call extract_blob_list()
 226          * to extract them.
 227          *
 228          * The will_extract_dentry() utility function, given an arbitrary dentry
 229          * in the WIM image (which may not be in the extraction list), can be
 230          * used to determine if that dentry is in the extraction list.
 231          *
 232          * Return 0 if successful; otherwise a positive wimlib error code.
 233          */
 234         int (*extract)(struct list_head *dentry_list, struct apply_ctx *ctx);
 235
 236         /*
 237          * Query whether the unnamed data stream of the specified file will be
 238          * extracted as "externally backed" from the WIM archive itself.  If so,
 239          * then the extraction backend is assumed to handle this separately, and
 240          * the common extraction code will not register a usage of the unnamed
 241          * data stream's blob.
 242          *
 243          * This routine is optional.
 244          *
 245          * Return:
 246          *      < 0 if the file will *not* be externally backed.
 247          *      = 0 if the file will be externally backed.
 248          *      > 0 (wimlib error code) if another error occurred.
 249          */
 250         int (*will_back_from_wim)(struct wim_dentry *dentry, struct apply_ctx *ctx);
 251
 252         /*
 253          * Size of the backend-specific extraction context.  It must contain
 254          * 'struct apply_ctx' as its first member.
 255          */
 256         size_t context_size;
 257
 258         /*
 259          * Set this if the extraction backend only supports extracting dentries
 260          * that form a single tree, not multiple trees.
 261          */
 262         bool single_tree_only;
 263 };
 264
 265 #ifdef __WIN32__
 266   extern const struct apply_operations win32_apply_ops;
 267 #else
 268   extern const struct apply_operations unix_apply_ops;
 269 #endif
 270
 271 #ifdef WITH_NTFS_3G
 272   extern const struct apply_operations ntfs_3g_apply_ops;
 273 #endif
 274
 275 #endif /* _WIMLIB_APPLY_H */