69a58b0e0051ce6085beaed6643452b45c498299
[wimlib] / include / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  *
6  * This file contains extensive comments for generating documentation with
7  * Doxygen.  The built HTML documentation can be viewed at
8  * http://wimlib.sourceforge.net.
9  */
10
11 /*
12  * Copyright (C) 2012, 2013 Eric Biggers
13  *
14  * This file is part of wimlib, a library for working with WIM files.
15  *
16  * wimlib is free software; you can redistribute it and/or modify it under the
17  * terms of the GNU General Public License as published by the Free
18  * Software Foundation; either version 3 of the License, or (at your option)
19  * any later version.
20  *
21  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23  * A PARTICULAR PURPOSE. See the GNU General Public License for more
24  * details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with wimlib; if not, see http://www.gnu.org/licenses/.
28  */
29
30 /** \mainpage
31  *
32  * \section intro Introduction
33  *
34  * This is the documentation for the library interface of wimlib 1.5.0, a C
35  * library for creating, modifying, extracting, and mounting files in the
36  * Windows Imaging Format.  This documentation is intended for developers only.
37  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38  * program, please see the README file or manual pages.
39  *
40  * \section starting Getting Started
41  *
42  * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
43  * install with <code>configure && make && sudo make install</code>; however,
44  * please see the README for more information about installing it.  To use
45  * wimlib in a program after installing it, include @c wimlib.h and link your
46  * program with @c -lwim.
47  *
48  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.  A ::WIMStruct
49  * may represent either a stand-alone WIM or one part of a split WIM.
50  *
51  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
52  * return 0 on success and a positive error code on failure.  Use
53  * wimlib_get_error_string() to get a string that describes an error code.
54  * wimlib also can print error messages itself when an error happens, and these
55  * may be more informative than the error code; to enable this, call
56  * wimlib_set_print_errors().  Please note that this is for convenience only,
57  * and some errors can occur without a message being printed.
58  *
59  * First before calling any other functions, you should call
60  * wimlib_global_init() to initialize the library.
61  *
62  * To open an existing WIM, use wimlib_open_wim().
63  *
64  * To create a new WIM that initially contains no images, use
65  * wimlib_create_new_wim().
66  *
67  * To add an image to a WIM file from a directory tree on your filesystem, call
68  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
69  * wimlib_open_wim() or from wimlib_create_new_wim().  On UNIX-like systems,
70  * wimlib_add_image() can also capture a WIM image directly from a block device
71  * containing a NTFS filesystem.
72  *
73  * To extract an image from a WIM file, call wimlib_extract_image().  This can
74  * be done either to a directory, or, on UNIX-like systems, directly to a block
75  * device containing a NTFS filesystem.
76  *
77  * To extract individual files or directories from a WIM image, rather than a
78  * full image, call wimlib_extract_files().
79  *
80  * To programatically make changes to a WIM image without mounting it, call
81  * wimlib_update_image().
82  *
83  * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
84  * mounting WIM files either read-only or read-write.  Mounting is done using
85  * wimlib_mount_image() and unmounting is done using wimlib_unmount_image().
86  * Mounting can be done without root privileges because it is implemented using
87  * FUSE (Filesystem in Userspace).  If wimlib is compiled with the
88  * <code>--without-fuse</code> flag, these functions will be available but will
89  * fail with ::WIMLIB_ERR_UNSUPPORTED.
90  *
91  * After creating or modifying a WIM file, you can write it to a file using
92  * wimlib_write().  Alternatively,  if the WIM was originally read from a file
93  * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
94  * wimlib_overwrite() to overwrite the original file.  Still alternatively, you
95  * can write a WIM directly to a file descriptor by calling wimlib_write_to_fd()
96  * instead.
97  *
98  * wimlib supports a special "pipable" WIM format (which unfortunately is @b not
99  * compatible with Microsoft's software).  To create a pipable WIM, call
100  * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
101  * ::WIMLIB_WRITE_FLAG_PIPABLE specified.  Pipable WIMs are pipable in both
102  * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
103  * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
104  * a pipable WIM.  wimlib can also transparently open and operate on pipable WIM
105  * s using a seekable file descriptor using the regular function calls (e.g.
106  * wimlib_open_wim(), wimlib_extract_image()).
107  *
108  * Please note: merely by calling wimlib_add_image() or many of the other
109  * functions in this library that operate on ::WIMStruct's, you are @b not
110  * modifying the WIM file on disk.  Changes are not saved until you explicitly
111  * call wimlib_write() or wimlib_overwrite().
112  *
113  * After you are done with the WIM file, use wimlib_free() to free all memory
114  * associated with a ::WIMStruct and close all files associated with it.
115  *
116  * When you are completely done with using wimlib in your program, you should
117  * call wimlib_global_cleanup().
118  *
119  * A number of functions take a pointer to a progress function of type
120  * ::wimlib_progress_func_t.  This function will be called periodically during
121  * the WIM operation(s) to report on the progress of the operation (for example,
122  * how many bytes have been written so far).
123  *
124  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
125  * the following exceptions:
126  * - You must call wimlib_global_init() in one thread before calling any other
127  *   functions.
128  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
129  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
130  *   concurrently in the same process, will daemonize the entire process when it
131  *   does so for the first time.  This includes changing the working directory
132  *   to the root directory.
133  *
134  * \section encodings Locales and character encodings
135  *
136  * To support Windows as well as UNIX-like systems, wimlib's API typically takes
137  * and returns strings of ::wimlib_tchar, which are in a platform-dependent
138  * encoding.
139  *
140  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
141  * and the encoding is UTF-16LE.
142  *
143  * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
144  * and the encoding is the locale-dependent multibyte encoding.  I recommend you
145  * set your locale to a UTF-8 capable locale to avoid any issues.  Also, by
146  * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
147  * call wimlib_global_init() after having set your desired locale.
148  *
149  * \section Limitations
150  *
151  * This section documents some technical limitations of wimlib not already
152  * documented in the man page for @b wimlib-imagex.
153  *
154  * - The old WIM format from Vista pre-releases is not supported.
155  * - Compressed resource chunk sizes other than 32768 are not supported.  This
156  *   doesn't seem to be a real problem because the chunk size always seems to be
157  *   this value.
158  * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
159  *   functionality other than that already present in @b ImageX, that allows you
160  *   to make certain Windows-specific modifications to a Windows PE image, such
161  *   as adding a driver or Windows component.  Such a tool possibly could be
162  *   implemented on top of wimlib.
163  */
164
165 #ifndef _WIMLIB_H
166 #define _WIMLIB_H
167
168 #include <stdio.h>
169 #include <stddef.h>
170 #include <stdbool.h>
171 #include <inttypes.h>
172 #include <time.h>
173
174 /** Major version of the library (for example, the 1 in 1.2.5). */
175 #define WIMLIB_MAJOR_VERSION 1
176
177 /** Minor version of the library (for example, the 2 in 1.2.5). */
178 #define WIMLIB_MINOR_VERSION 5
179
180 /** Patch version of the library (for example, the 5 in 1.2.5). */
181 #define WIMLIB_PATCH_VERSION 0
182
183 /**
184  * Opaque structure that represents a WIM file.  This is an in-memory structure
185  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
186  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
187  * continuing to exist so that data can be read from it as needed.
188  *
189  * Most functions in this library will work the same way regardless of whether a
190  * given ::WIMStruct was obtained through wimlib_open_wim() or
191  * wimlib_create_new_wim().  Exceptions are documented.
192  *
193  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
194  * file from a ::WIMStruct.
195  */
196 #ifndef WIMLIB_WIMSTRUCT_DECLARED
197 typedef struct WIMStruct WIMStruct;
198 #define WIMLIB_WIMSTRUCT_DECLARED
199 #endif
200
201 #ifdef __WIN32__
202 typedef wchar_t wimlib_tchar;
203 #else
204 /** See \ref encodings */
205 typedef char wimlib_tchar;
206 #endif
207
208 #ifdef __WIN32__
209 /** Path separator for WIM paths passed back to progress callbacks. */
210 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
211 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
212 #else
213 /** Path separator for WIM paths passed back to progress callbacks. */
214 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
215 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
216 #endif
217
218 #ifdef __GNUC__
219 #  define _wimlib_deprecated __attribute__((deprecated))
220 #else
221 #  define _wimlib_deprecated
222 #endif
223
224 #define WIMLIB_GUID_LEN 16
225
226 /**
227  * Specifies the compression type of a WIM file.
228  */
229 enum wimlib_compression_type {
230         /** An invalid compression type. */
231         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
232
233         /** The WIM does not include any compressed resources. */
234         WIMLIB_COMPRESSION_TYPE_NONE = 0,
235
236         /** Compressed resources in the WIM use LZX compression. */
237         WIMLIB_COMPRESSION_TYPE_LZX = 1,
238
239         /** Compressed resources in the WIM use XPRESS compression. */
240         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
241 };
242
243 /** Possible values of the first parameter to the user-supplied
244  * ::wimlib_progress_func_t progress function */
245 enum wimlib_progress_msg {
246
247         /** A WIM image is about to be extracted.  @p info will point to
248          * ::wimlib_progress_info.extract. */
249         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
250
251         /** A file or directory tree within a WIM image (not the full image) is
252          * about to be extracted.  @p info will point to
253          * ::wimlib_progress_info.extract. */
254         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
255
256         /** The directory structure of the WIM image is about to be extracted.
257          * @p info will point to ::wimlib_progress_info.extract. */
258         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
259
260         /** The directory structure of the WIM image has been successfully
261          * extracted.  @p info will point to ::wimlib_progress_info.extract. */
262         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
263
264         /** The WIM image's files resources are currently being extracted.  @p
265          * info will point to ::wimlib_progress_info.extract. */
266         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
267
268         /** Starting to read a new part of a split pipable WIM over the pipe.
269          * @p info will point to ::wimlib_progress_info.extract.  */
270         WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
271
272         /** All the WIM files and directories have been extracted, and
273          * timestamps are about to be applied.  @p info will point to
274          * ::wimlib_progress_info.extract. */
275         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
276
277         /** A WIM image has been successfully extracted.  @p info will point to
278          * ::wimlib_progress_info.extract. */
279         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
280
281         /** A file or directory tree within a WIM image (not the full image) has
282          * been successfully extracted.  @p info will point to
283          * ::wimlib_progress_info.extract. */
284         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
285
286         /** The directory or NTFS volume is about to be scanned to build a tree
287          * of WIM dentries in-memory.  @p info will point to
288          * ::wimlib_progress_info.scan. */
289         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
290
291         /** A directory or file is being scanned.  @p info will point to
292          * ::wimlib_progress_info.scan, and its @p cur_path member will be
293          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
294          * is passed to wimlib_add_image(). */
295         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
296
297         /** The directory or NTFS volume has been successfully scanned, and a
298          * tree of WIM dentries has been built in-memory. @p info will point to
299          * ::wimlib_progress_info.scan. */
300         WIMLIB_PROGRESS_MSG_SCAN_END,
301
302         /**
303          * File resources are currently being written to the WIM.
304          * @p info will point to ::wimlib_progress_info.write_streams. */
305         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
306
307         /**
308          * The metadata resource for each image is about to be written to the
309          * WIM. @p info will not be valid. */
310         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
311
312         /**
313          * The metadata resource for each image has successfully been writen to
314          * the WIM.  @p info will not be valid. */
315         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
316
317         /**
318          * The temporary file has successfully been renamed to the original WIM
319          * file.  Only happens when wimlib_overwrite() is called and the
320          * overwrite is not done in-place.
321          * @p info will point to ::wimlib_progress_info.rename. */
322         WIMLIB_PROGRESS_MSG_RENAME,
323
324         /** The contents of the WIM are being checked against the integrity
325          * table.  Only happens when wimlib_open_wim() is called with the
326          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  @p info will point to
327          * ::wimlib_progress_info.integrity. */
328         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
329
330         /** An integrity table is being calculated for the WIM being written.
331          * Only happens when wimlib_write() or wimlib_overwrite() is called with
332          * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag.  @p info will point to
333          * ::wimlib_progress_info.integrity. */
334         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
335
336         /** Reserved.  (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
337          * but in wimlib v1.5.0 this was removed to simplify the code and now
338          * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.)  */
339         WIMLIB_PROGRESS_MSG_RESERVED,
340
341         /** A wimlib_split() operation is in progress, and a new split part is
342          * about to be started.  @p info will point to
343          * ::wimlib_progress_info.split. */
344         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
345
346         /** A wimlib_split() operation is in progress, and a split part has been
347          * finished. @p info will point to ::wimlib_progress_info.split. */
348         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
349
350         /**
351          * A WIM update command is just about to be executed; @p info will point
352          * to ::wimlib_progress_info.update.
353          */
354         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
355
356         /**
357          * A WIM update command has just been executed; @p info will point to
358          * ::wimlib_progress_info.update.
359          */
360         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
361
362 };
363
364 /** A pointer to this union is passed to the user-supplied
365  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
366  * contained in this union will be applicable for the operation
367  * (::wimlib_progress_msg) indicated in the first argument to the progress
368  * function. */
369 union wimlib_progress_info {
370
371         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
372          * document them if they aren't given a name... */
373
374         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
375         struct wimlib_progress_info_write_streams {
376                 /** Number of bytes that are going to be written for all the
377                  * streams combined.  This is the amount in uncompressed data.
378                  * (The actual number of bytes will be less if the data is being
379                  * written compressed.) */
380                 uint64_t total_bytes;
381
382                 /** Number of streams that are going to be written. */
383                 uint64_t total_streams;
384
385                 /** Number of uncompressed bytes that have been written so far.
386                  * Will be 0 initially, and equal to @p total_bytes at the end.
387                  * */
388                 uint64_t completed_bytes;
389
390                 /** Number of streams that have been written.  Will be 0
391                  * initially, and equal to @p total_streams at the end. */
392                 uint64_t completed_streams;
393
394                 /** Number of threads that are being used to compress resources
395                  * (if applicable).  */
396                 unsigned num_threads;
397
398                 /** The compression type being used to write the streams; either
399                  * ::WIMLIB_COMPRESSION_TYPE_NONE,
400                  * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
401                  * ::WIMLIB_COMPRESSION_TYPE_LZX. */
402                 int      compression_type;
403
404                 /** Number of split WIM parts from which streams are being
405                  * written (may be 0 if irrelevant).  */
406                 unsigned total_parts;
407
408                 /** Number of split WIM parts from which streams have been
409                  * written (may be 0 if irrelevant).  */
410                 unsigned completed_parts;
411         } write_streams;
412
413         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
414          * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
415         struct wimlib_progress_info_scan {
416                 /** Directory or NTFS volume that is being scanned. */
417                 const wimlib_tchar *source;
418
419                 /** Path to the file or directory that is about to be scanned,
420                  * relative to the root of the image capture or the NTFS volume.
421                  * */
422                 const wimlib_tchar *cur_path;
423
424                 enum {
425                         /** File or directory looks okay and will be captured.  */
426                         WIMLIB_SCAN_DENTRY_OK = 0,
427
428                         /** File or directory is being excluded from capture due
429                          * to the capture configuration file.  */
430                         WIMLIB_SCAN_DENTRY_EXCLUDED,
431
432                         /** File or directory is being excluded from capture due
433                          * to being unsupported (e.g. an encrypted or device
434                          * file).  */
435                         WIMLIB_SCAN_DENTRY_UNSUPPORTED,
436                 } status;
437
438                 /** Target path in the WIM.  Only valid on messages
439                  * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
440                  * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
441                 const wimlib_tchar *wim_target_path;
442         } scan;
443
444         /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
445          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
446          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
447          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
448          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
449         struct wimlib_progress_info_extract {
450                 /** Number of the image being extracted (1-based). */
451                 int image;
452
453                 /** Flags passed to to wimlib_extract_image() */
454                 int extract_flags;
455
456                 /** Full path to the WIM file being extracted. */
457                 const wimlib_tchar *wimfile_name;
458
459                 /** Name of the image being extracted. */
460                 const wimlib_tchar *image_name;
461
462                 /** Directory or NTFS volume to which the image is being
463                  * extracted. */
464                 const wimlib_tchar *target;
465
466                 /** Reserved.  */
467                 const wimlib_tchar *cur_path;
468
469                 /** Number of bytes of uncompressed data that will be extracted.
470                  * Takes into account hard links (they are not counted for each
471                  * link.)  */
472                 uint64_t total_bytes;
473
474                 /** Number of bytes that have been written so far.  Will be 0
475                  * initially, and equal to @p total_bytes at the end. */
476                 uint64_t completed_bytes;
477
478                 /** Number of streams that will be extracted.  This may more or
479                  * less than the number of "files" to be extracted due to
480                  * special cases (hard links, symbolic links, and alternate data
481                  * streams.) */
482                 uint64_t num_streams;
483
484                 /** Path to the root dentry within the WIM for the tree that is
485                  * being extracted.  Will be the empty string when extracting a
486                  * full image. */
487                 const wimlib_tchar *extract_root_wim_source_path;
488
489                 /** Currently only used for
490                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
491
492                 unsigned part_number;
493
494                 /** Currently only used for
495                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
496                 unsigned total_parts;
497
498                 /** Currently only used for
499                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
500                 uint8_t guid[WIMLIB_GUID_LEN];
501         } extract;
502
503         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
504         struct wimlib_progress_info_rename {
505                 /** Name of the temporary file that the WIM was written to. */
506                 const wimlib_tchar *from;
507
508                 /** Name of the original WIM file to which the temporary file is
509                  * being renamed. */
510                 const wimlib_tchar *to;
511         } rename;
512
513         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
514          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
515         struct wimlib_progress_info_update {
516                 /** Pointer to the update command that will be executed or has
517                  * just been executed. */
518                 const struct wimlib_update_command *command;
519
520                 /** Number of update commands that have been completed so far.
521                  */
522                 size_t completed_commands;
523
524                 /** Number of update commands that are being executed as part of
525                  * this call to wimlib_update_image(). */
526                 size_t total_commands;
527         } update;
528
529         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
530          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
531         struct wimlib_progress_info_integrity {
532                 /** Number of bytes from the end of the WIM header to the end of
533                  * the lookup table (the area that is covered by the SHA1
534                  * integrity checks.) */
535                 uint64_t total_bytes;
536
537                 /** Number of bytes that have been SHA1-summed so far.  Will be
538                  * 0 initially, and equal @p total_bytes at the end. */
539                 uint64_t completed_bytes;
540
541                 /** Number of chunks that the checksummed region is divided
542                  * into. */
543                 uint32_t total_chunks;
544
545                 /** Number of chunks that have been SHA1-summed so far.   Will
546                  * be 0 initially, and equal to @p total_chunks at the end. */
547                 uint32_t completed_chunks;
548
549                 /** Size of the chunks used for the integrity calculation. */
550                 uint32_t chunk_size;
551
552                 /** Filename of the WIM (only valid if the message is
553                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
554                 const wimlib_tchar *filename;
555         } integrity;
556
557         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
558          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
559         struct wimlib_progress_info_split {
560                 /** Total size of the original WIM's file and metadata resources
561                  * (compressed). */
562                 uint64_t total_bytes;
563
564                 /** Number of bytes of file and metadata resources that have
565                  * been copied out of the original WIM so far.  Will be 0
566                  * initially, and equal to @p total_bytes at the end. */
567                 uint64_t completed_bytes;
568
569                 /** Number of the split WIM part that is about to be started
570                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
571                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
572                 unsigned cur_part_number;
573
574                 /** Total number of split WIM parts that are being written.  */
575                 unsigned total_parts;
576
577                 /** Name of the split WIM part that is about to be started
578                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
579                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
580                 const wimlib_tchar *part_name;
581         } split;
582 };
583
584 /** A user-supplied function that will be called periodically during certain WIM
585  * operations.  The first argument will be the type of operation that is being
586  * performed or is about to be started or has been completed.  The second
587  * argument will be a pointer to one of a number of structures depending on the
588  * first argument.  It may be @c NULL for some message types.
589  *
590  * The return value of the progress function is currently ignored, but it may do
591  * something in the future.  (Set it to 0 for now.)
592  */
593 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
594                                       const union wimlib_progress_info *info);
595
596 /** An array of these structures is passed to wimlib_add_image_multisource() to
597  * specify the sources from which to create a WIM image. */
598 struct wimlib_capture_source {
599         /** Absolute or relative path to a file or directory on the external
600          * filesystem to be included in the WIM image. */
601         wimlib_tchar *fs_source_path;
602
603         /** Destination path in the WIM image.  Leading and trailing slashes are
604          * ignored.  The empty string or @c NULL means the root directory of the
605          * WIM image. */
606         wimlib_tchar *wim_target_path;
607
608         /** Reserved; set to 0. */
609         long reserved;
610 };
611
612 /** Structure that specifies a list of path patterns. */
613 struct wimlib_pattern_list {
614         /** Array of patterns.  The patterns may be modified by library code,
615          * but the @p pats pointer itself will not.  See the man page for
616          * <b>wimlib-imagex capture</b> for more information about allowed
617          * patterns. */
618         wimlib_tchar **pats;
619
620         /** Number of patterns in the @p pats array. */
621         size_t num_pats;
622
623         /** Ignored; may be used by the calling code. */
624         size_t num_allocated_pats;
625 };
626
627 /** A structure that contains lists of wildcards that match paths to treat
628  * specially when capturing a WIM image. */
629 struct wimlib_capture_config {
630         /** Paths matching any pattern this list are excluded from being
631          * captured, except if the same path appears in @p
632          * exclusion_exception_pats. */
633         struct wimlib_pattern_list exclusion_pats;
634
635         /** Paths matching any pattern in this list are never excluded from
636          * being captured. */
637         struct wimlib_pattern_list exclusion_exception_pats;
638
639         /** Reserved for future capture configuration options. */
640         struct wimlib_pattern_list reserved1;
641
642         /** Reserved for future capture configuration options. */
643         struct wimlib_pattern_list reserved2;
644
645         /** Library internal use only. */
646         wimlib_tchar *_prefix;
647
648         /** Library internal use only. */
649         size_t _prefix_num_tchars;
650 };
651
652 /** Set or unset the WIM header flag that marks it read-only
653  * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
654  * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter.  This
655  * is distinct from basic file permissions; this flag can be set on a WIM file
656  * that is physically writable.  If this flag is set, all further operations to
657  * modify the WIM will fail, except calling wimlib_overwrite() with
658  * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
659  * allows you to set this flag persistently on the underlying WIM file.
660  */
661 #define WIMLIB_CHANGE_READONLY_FLAG             0x00000001
662
663 /** Set the GUID (globally unique identifier) of the WIM file to the value
664  * specified in ::wimlib_wim_info.guid of the @p info parameter. */
665 #define WIMLIB_CHANGE_GUID                      0x00000002
666
667 /** Change the bootable image of the WIM to the value specified in
668  * ::wimlib_wim_info.boot_index of the @p info parameter.  */
669 #define WIMLIB_CHANGE_BOOT_INDEX                0x00000004
670
671 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
672  * in ::wimlib_wim_info.has_rpfix of the @p info parameter.  This flag generally
673  * indicates whether an image in the WIM has been captured with reparse-point
674  * fixups enabled.  wimlib also treats this flag as specifying whether to do
675  * reparse-point fixups by default when capturing or applying WIM images.  */
676 #define WIMLIB_CHANGE_RPFIX_FLAG                0x00000008
677
678 /** General information about a WIM file. */
679 struct wimlib_wim_info {
680
681         /** Globally unique identifier for the WIM file.  Note: all parts of a
682          * split WIM should have an identical value in this field.  */
683         uint8_t  guid[WIMLIB_GUID_LEN];
684
685         /** Number of images in the WIM.  */
686         uint32_t image_count;
687
688         /** 1-based index of the bootable image in the WIM, or 0 if no image is
689          * bootable.  */
690         uint32_t boot_index;
691
692         /** Version of the WIM file.  */
693         uint32_t wim_version;
694
695         /** Chunk size used for compression.  */
696         uint32_t chunk_size;
697
698         /** 1-based index of this part within a split WIM, or 1 if the WIM is
699          * standalone.  */
700         uint16_t part_number;
701
702         /** Total number of parts in the split WIM, or 1 if the WIM is
703          * standalone.  */
704         uint16_t total_parts;
705
706         /** One of the ::wimlib_compression_type values that specifies the
707          * method used to compress resources in the WIM.  */
708         int32_t  compression_type;
709
710         /** Size of the WIM file in bytes, excluding the XML data and integrity
711          * table.  */
712         uint64_t total_bytes;
713
714         /** 1 if the WIM has an integrity table.  Note: if the ::WIMStruct was
715          * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
716          * this will always be 0, even if the ::WIMStruct was written to
717          * somewhere by calling wimlib_write() with the
718          * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
719         uint32_t has_integrity_table : 1;
720
721         /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
722          * wimlib_create_new_wim(). */
723         uint32_t opened_from_file : 1;
724
725         /** 1 if the WIM is considered readonly for any reason. */
726         uint32_t is_readonly : 1;
727
728         /** 1 if reparse-point fixups are supposedly enabled for one or more
729          * images in the WIM.  */
730         uint32_t has_rpfix : 1;
731
732         /** 1 if the WIM is marked as read-only.  */
733         uint32_t is_marked_readonly : 1;
734
735         /** 1 if the WIM is part of a spanned set.  */
736         uint32_t spanned : 1;
737
738         uint32_t write_in_progress : 1;
739         uint32_t metadata_only : 1;
740         uint32_t resource_only : 1;
741
742         /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE).  */
743         uint32_t pipable : 1;
744         uint32_t reserved_flags : 22;
745         uint32_t reserved[9];
746 };
747
748 /** Information about a unique resource in the WIM file.
749  */
750 struct wimlib_resource_entry {
751         /** Uncompressed size of the resource in bytes. */
752         uint64_t uncompressed_size;
753
754         /** Compressed size of the resource in bytes.  This will be the same as
755          * @p uncompressed_size if the resource is uncompressed.  */
756         uint64_t compressed_size;
757
758         /** Offset, in bytes, of this resource from the start of the WIM file.
759          */
760         uint64_t offset;
761
762         /** SHA1 message digest of the resource's uncompressed contents.  */
763         uint8_t sha1_hash[20];
764
765         /** Which part number of the split WIM this resource is in.  This should
766          * be the same as the part number provided by wimlib_get_wim_info().  */
767         uint32_t part_number;
768
769         /** Number of times this resource is referenced over all WIM images.  */
770         uint32_t reference_count;
771
772         /** 1 if this resource is compressed.  */
773         uint32_t is_compressed : 1;
774
775         /** 1 if this resource is a metadata resource rather than a file
776          * resource.  */
777         uint32_t is_metadata : 1;
778
779         uint32_t is_free : 1;
780         uint32_t is_spanned : 1;
781         uint32_t reserved_flags : 28;
782         uint64_t reserved[4];
783 };
784
785 /** A stream of a file in the WIM.  */
786 struct wimlib_stream_entry {
787         /** Name of the stream, or NULL if the stream is unnamed. */
788         const wimlib_tchar *stream_name;
789         /** Location, size, etc. of the stream within the WIM file.  */
790         struct wimlib_resource_entry resource;
791         uint64_t reserved[4];
792 };
793
794 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
795  * Roughly, the information about a "file" in the WIM--- but really a directory
796  * entry ("dentry") because hard links are allowed.  The hard_link_group_id
797  * field can be used to distinguish actual file inodes.  */
798 struct wimlib_dir_entry {
799         /** Name of the file, or NULL if this file is unnamed (only possible for
800          * the root directory) */
801         const wimlib_tchar *filename;
802
803         /** 8.3 DOS name of this file, or NULL if this file has no such name.
804          * */
805         const wimlib_tchar *dos_name;
806
807         /** Full path to this file within the WIM image.  */
808         const wimlib_tchar *full_path;
809
810         /** Depth of this directory entry, where 0 is the root, 1 is the root's
811          * children, ..., etc. */
812         size_t depth;
813
814         /** Pointer to the security descriptor for this file, in Windows
815          * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
816          * security descriptor.  */
817         const char *security_descriptor;
818
819         /** Length of the above security descriptor.  */
820         size_t security_descriptor_size;
821
822 #define WIMLIB_FILE_ATTRIBUTE_READONLY            0x00000001
823 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN              0x00000002
824 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM              0x00000004
825 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY           0x00000010
826 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE             0x00000020
827 #define WIMLIB_FILE_ATTRIBUTE_DEVICE              0x00000040
828 #define WIMLIB_FILE_ATTRIBUTE_NORMAL              0x00000080
829 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY           0x00000100
830 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
831 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
832 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED          0x00000800
833 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE             0x00001000
834 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
835 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED           0x00004000
836 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL             0x00010000
837         /** File attributes, such as whether the file is a directory or not.
838          * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
839          * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
840          * on other platforms.  */
841         uint32_t attributes;
842
843 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO        0x00000000
844 #define WIMLIB_REPARSE_TAG_RESERVED_ONE         0x00000001
845 #define WIMLIB_REPARSE_TAG_MOUNT_POINT          0xA0000003
846 #define WIMLIB_REPARSE_TAG_HSM                  0xC0000004
847 #define WIMLIB_REPARSE_TAG_HSM2                 0x80000006
848 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
849 #define WIMLIB_REPARSE_TAG_SIS                  0x80000007
850 #define WIMLIB_REPARSE_TAG_DFS                  0x8000000A
851 #define WIMLIB_REPARSE_TAG_DFSR                 0x80000012
852 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER       0x8000000B
853 #define WIMLIB_REPARSE_TAG_SYMLINK              0xA000000C
854         /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
855          * attributes), this will give the reparse tag.  This tells you whether
856          * the reparse point is a symbolic link, junction point, or some other,
857          * more unusual kind of reparse point.  */
858         uint32_t reparse_tag;
859
860         /*  Number of (hard) links to this file.  */
861         uint32_t num_links;
862
863         /** Number of named data streams that this file has.  Normally 0.  */
864         uint32_t num_named_streams;
865
866         /** Roughly, the inode number of this file.  However, it may be 0 if
867          * @p num_links == 1.  */
868         uint64_t hard_link_group_id;
869
870         /** Time this file was created.  */
871         struct timespec creation_time;
872
873         /** Time this file was last written to.  */
874         struct timespec last_write_time;
875
876         /** Time this file was last accessed.  */
877         struct timespec last_access_time;
878         uint64_t reserved[16];
879
880         /** Array of streams that make up this file.  The first entry will
881          * always exist and will correspond to the unnamed data stream (default
882          * file contents), so it will have @p stream_name == @c NULL.  There
883          * will then be @p num_named_streams additional entries that specify the
884          * named data streams, if any, each of which will have @p stream_name !=
885          * @c NULL.  */
886         struct wimlib_stream_entry streams[];
887 };
888
889 /**
890  * Type of a callback function to wimlib_iterate_dir_tree().  Must return 0 on
891  * success.
892  */
893 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
894                                                   void *user_ctx);
895
896 /**
897  * Type of a callback function to wimlib_iterate_lookup_table().  Must return 0
898  * on success.
899  */
900 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
901                                                       void *user_ctx);
902
903 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
904  * just on the specified path. */
905 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
906
907 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
908  * itself; only its children (in the case of a non-empty directory) */
909 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN  0x00000002
910
911
912
913 /*****************************
914  * WIMLIB_ADD_FLAG_*
915  *****************************/
916
917 /** Directly capture a NTFS volume rather than a generic directory.  This flag
918  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
919  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
920 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
921
922 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
923  * with ::WIMLIB_ADD_FLAG_NTFS. */
924 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
925
926 /** Call the progress function with the message
927  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
928  * be scanned, or when a directory or file is being excluded from capture.  */
929 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
930
931 /** Mark the image being added as the bootable image of the WIM. */
932 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
933
934 /** Store the UNIX owner, group, and mode.  This is done by adding a special
935  * alternate data stream to each regular file, symbolic link, and directory to
936  * contain this information.  Please note that this flag is for convenience
937  * only; Microsoft's @a imagex.exe will not understand this special information.
938  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
939 #define WIMLIB_ADD_FLAG_UNIX_DATA                       0x00000010
940
941 /** Do not capture security descriptors.  Only has an effect in NTFS capture
942  * mode, or in Win32 native builds. */
943 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
944
945 /** Fail immediately if the full security descriptor of any file or directory
946  * cannot be accessed.  Only has an effect in Win32 native builds.  The default
947  * behavior without this flag is to first try omitting the SACL from the
948  * security descriptor, then to try omitting the security descriptor entirely.
949  * */
950 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
951
952 /** Call the progress function with the message
953  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
954  * capture.  This is a subset of the messages provided by
955  * ::WIMLIB_ADD_FLAG_VERBOSE. */
956 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
957
958 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
959  * in the case of Windows) that point inside the directory being captured to
960  * instead be absolute relative to the directory being captured, rather than the
961  * current root; also exclude absolute symbolic links that point outside the
962  * directory tree being captured.
963  *
964  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
965  * the WIM header or if this is the first image being added.
966  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
967  * reparse point fixups enabled and currently cannot be unset. */
968 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
969
970 /** Don't do reparse point fixups.  The default behavior is described in the
971  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
972 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
973
974 /** Do not exclude unsupported files or directories from capture; e.g. encrypted
975  * directories in NTFS-3g capture mode, or device files and FIFOs on UNIX-like
976  * systems.  Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file
977  * is encountered.  */
978 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE  0x00000400
979
980 /** Automatically select a capture configuration appropriate for capturing
981  * filesystems containing Windows operating systems.  When this flag is
982  * specified, the corresponding @p config parameter or member must be @c NULL.
983  *
984  * Currently, selecting this capture configuration will cause the following
985  * files and directories to be excluded from capture:
986  *
987  * - "\$ntfs.log"
988  * - "\hiberfil.sys"
989  * - "\pagefile.sys"
990  * - "\System Volume Information"
991  * - "\RECYCLER"
992  * - "\Windows\CSC"
993  *
994  * Note that the default behavior--- that is, when this flag is not specified
995  * and @p config is @c NULL--- is to use no capture configuration, meaning that
996  * no files are excluded from capture.
997  */
998 #define WIMLIB_ADD_FLAG_WINCONFIG               0x00000800
999
1000 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
1001 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
1002 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
1003 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
1004 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
1005 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
1006 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
1007 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1008 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
1009 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
1010 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1011                                                 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1012 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG         WIMLIB_ADD_FLAG_WINCONFIG
1013
1014 /******************************
1015  * WIMLIB_DELETE_FLAG_*
1016  ******************************/
1017
1018 /** Do not issue an error if the path to delete does not exist. */
1019 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
1020
1021 /** Delete the file or directory tree recursively; if not specified, an error is
1022  * issued if the path to delete is a directory. */
1023 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
1024
1025 /******************************
1026  * WIMLIB_EXPORT_FLAG_*
1027  ******************************/
1028
1029 /** See documentation for wimlib_export_image(). */
1030 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
1031
1032 /******************************
1033  * WIMLIB_EXTRACT_FLAG_*
1034  ******************************/
1035
1036 /** Extract the image directly to a NTFS volume rather than a generic directory.
1037  * This mode is only available if wimlib was compiled with libntfs-3g support;
1038  * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned.  In this mode, the
1039  * extraction target will be interpreted as the path to a NTFS volume image (as
1040  * a regular file or block device) rather than a directory.  It will be opened
1041  * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1042  * root directory.  Note: this flag cannot be used when wimlib_extract_image()
1043  * is called with ::WIMLIB_ALL_IMAGES as the @p image.  */
1044 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
1045
1046 /** When identical files are extracted from the WIM, always hard link them
1047  * together.  */
1048 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
1049
1050 /** When identical files are extracted from the WIM, always symlink them
1051  * together.  */
1052 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
1053
1054 /** This flag no longer does anything but is reserved for future use.  */
1055 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
1056
1057 /** Read the WIM file sequentially while extracting the image.  */
1058 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
1059
1060 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
1061  * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS.  */
1062 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
1063
1064 /** Do not extract security descriptors.  */
1065 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
1066
1067 /** Fail immediately if the full security descriptor of any file or directory
1068  * cannot be set exactly as specified in the WIM file.  On Windows, the default
1069  * behavior without this flag is to fall back to setting the security descriptor
1070  * with the SACL omitted, then only the default inherited security descriptor,
1071  * if we do not have permission to set the desired one.  */
1072 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
1073
1074 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX.  This forces
1075  * reparse-point fixups on, so absolute symbolic links or junction points will
1076  * be fixed to be absolute relative to the actual extraction root.  Reparse
1077  * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1078  * header.  This flag may only be specified when extracting a full image (not a
1079  * file or directory tree within one).  */
1080 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
1081
1082 /** Force reparse-point fixups on extraction off, regardless of the state of the
1083  * WIM_HDR_FLAG_RP_FIX flag in the WIM header.  */
1084 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
1085
1086 /** Extract the specified file to standard output.  This is only valid in an
1087  * extraction command that specifies the extraction of a regular file in the WIM
1088  * image.  */
1089 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
1090
1091 /** Instead of ignoring files and directories with names that cannot be
1092  * represented on the current platform (note: Windows has more restrictions on
1093  * filenames than POSIX-compliant systems), try to replace characters or append
1094  * junk to the names so that they can be extracted in some form.  */
1095 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
1096
1097 /** On Windows, when there exist two or more files with the same case
1098  * insensitive name but different case sensitive names, try to extract them all
1099  * by appending junk to the end of them, rather than arbitrarily extracting only
1100  * one.  */
1101 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
1102
1103 /** Do not ignore failure to set timestamps on extracted files.  */
1104 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS           0x00002000
1105
1106 /** Do not ignore failure to set short names on extracted files.  */
1107 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES          0x00004000
1108
1109 /** Do not ignore failure to extract symbolic links (and junction points, on
1110  * Windows) due to permissions problems.  By default, such failures are ignored
1111  * since the default configuration of Windows only allows the Administrator to
1112  * create symbolic links.  */
1113 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
1114
1115 /** TODO */
1116 #define WIMLIB_EXTRACT_FLAG_RESUME                      0x00010000
1117
1118
1119 /******************************
1120  * WIMLIB_MOUNT_FLAG_*
1121  ******************************/
1122
1123 /** Mount the WIM image read-write rather than the default of read-only. */
1124 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
1125
1126 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1127 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
1128
1129 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1130 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
1131
1132 /** Access alternate data streams in the mounted WIM image through extended file
1133  * attributes.  This is the default mode. */
1134 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
1135
1136 /** Access alternate data streams in the mounted WIM image by specifying the
1137  * file name, a colon, then the alternate file stream name. */
1138 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
1139
1140 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1141  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1142 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
1143
1144 /** Allow other users to see the mounted filesystem.  (this passes the @c
1145  * allow_other option to FUSE mount) */
1146 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
1147
1148 /******************************
1149  * WIMLIB_OPEN_FLAG_*
1150  ******************************/
1151
1152 /** Verify the WIM contents against the WIM's integrity table, if present.  This
1153  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1154  * checksummed and checked against the SHA1 message digests specified in the
1155  * integrity table.  ::WIMLIB_ERR_INTEGRITY is returned if there are any
1156  * mismatches.  */
1157 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
1158
1159 /** Do not issue an error if the WIM is part of a split WIM.  */
1160 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
1161
1162 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1163  * is not.  A WIM is considered writable only if it is writable at the
1164  * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1165  * header, and is not part of a spanned set.  It is not required to provide this
1166  * flag to make changes to the WIM, but with this flag you get the error sooner
1167  * rather than later. */
1168 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
1169
1170 /******************************
1171  * WIMLIB_UNMOUNT_FLAG_*
1172  ******************************/
1173
1174 /** Include an integrity table in the WIM after it's been unmounted.  Ignored
1175  * for read-only mounts. */
1176 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
1177
1178 /** Unless this flag is given, changes to a read-write mounted WIM are
1179  * discarded.  Ignored for read-only mounts. */
1180 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
1181
1182 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
1183 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
1184
1185 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1186 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
1187
1188 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
1189 #define WIMLIB_UNMOUNT_FLAG_LAZY                        0x00000010
1190
1191 /******************************
1192  * WIMLIB_UPDATE_FLAG_*
1193  ******************************/
1194
1195 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1196  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1197 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
1198
1199 /******************************
1200  * WIMLIB_WRITE_FLAG_*
1201  ******************************/
1202
1203 /** Include an integrity table in the WIM.
1204  *
1205  * For WIMs created with wimlib_open_wim(), the default behavior is to include
1206  * an integrity table if and only if one was present before.  For WIMs created
1207  * with wimlib_create_new_wim(), the default behavior is to not include an
1208  * integrity table.  */
1209 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
1210
1211 /** Do not include an integrity table in the new WIM file.  This is the default
1212  * behavior, unless the WIM already included an integrity table.  */
1213 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY            0x00000002
1214
1215 /** Write the WIM as "pipable".  After writing a WIM with this flag specified,
1216  * images from it can be applied directly from a pipe using
1217  * wimlib_extract_image_from_pipe().  See the documentation for the --pipable
1218  * flag of `wimlib-imagex capture' for more information.  Beware: WIMs written
1219  * with this flag will not be compatible with Microsoft's software.
1220  *
1221  * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1222  * WIM as pipable if and only if it was pipable before.  For WIMs created with
1223  * wimlib_create_new_wim(), the default behavior is to write the WIM as
1224  * non-pipable.  */
1225 #define WIMLIB_WRITE_FLAG_PIPABLE                       0x00000004
1226
1227 /** Do not write the WIM as "pipable".  This is the default behavior, unless the
1228  * WIM was pipable already.  */
1229 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE                   0x00000008
1230
1231 /** Recompress all resources, even if they could otherwise be copied from a
1232  * different WIM with the same compression type (in the case of
1233  * wimlib_export_image() being called previously).  This flag is also valid in
1234  * the @p wim_write_flags of wimlib_join(), in which case all resources included
1235  * in the joined WIM file will be recompressed.  */
1236 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000010
1237
1238 /** Call fsync() just before the WIM file is closed.  */
1239 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000020
1240
1241 /** wimlib_overwrite() only:  Re-build the entire WIM file rather than appending
1242  * data to it if possible.  */
1243 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000040
1244
1245 /** wimlib_overwrite() only:  Specifying this flag overrides the default
1246  * behavior of wimlib_overwrite() after one or more calls to
1247  * wimlib_delete_image(), which is to rebuild the entire WIM.  With this flag,
1248  * only minimal changes to correctly remove the image from the WIM will be
1249  * taken.  In particular, all streams will be left alone, even if they are no
1250  * longer referenced.  This is probably not what you want, because almost no
1251  * space will be saved by deleting an image in this way. */
1252 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000080
1253
1254 /** wimlib_overwrite() only:  Allow overwriting the WIM even if the readonly
1255  * flag is set in the WIM header.  This can be used in combination with
1256  * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1257  * set the readonly flag on the on-disk WIM file.  */
1258 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000100
1259
1260 /******************************
1261  * WIMLIB_INIT_FLAG_*
1262  ******************************/
1263
1264 /** Assume that strings are represented in UTF-8, even if this is not the
1265  * locale's character encoding.  Not used on Windows.  */
1266 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
1267
1268 /** Windows-only: do not attempt to acquire additional privileges (currently
1269  * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1270  * SeTakeOwnershipPrivilege) when initializing the library.  This is intended
1271  * for the case where the calling program manages these privileges itself.
1272  * Note: no error is issued if privileges cannot be acquired, although related
1273  * errors may be reported later, depending on if the operations performed
1274  * actually require additional privileges or not.  */
1275 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES        0x00000002
1276
1277 /** Specification of an update to perform on a WIM image. */
1278 struct wimlib_update_command {
1279
1280         /** The specific type of update to perform. */
1281         enum wimlib_update_op {
1282                 /** Add a new file or directory tree to the WIM image in a
1283                  * certain location. */
1284                 WIMLIB_UPDATE_OP_ADD = 0,
1285
1286                 /** Delete a file or directory tree from the WIM image. */
1287                 WIMLIB_UPDATE_OP_DELETE,
1288
1289                 /** Rename a file or directory tree in the WIM image. */
1290                 WIMLIB_UPDATE_OP_RENAME,
1291         } op;
1292         union {
1293                 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1294                 struct wimlib_add_command {
1295                         /** Filesystem path to the file or directory tree to
1296                          * add. */
1297                         wimlib_tchar *fs_source_path;
1298                         /** Path, specified from the root of the WIM image, at
1299                          * which to add the file or directory tree within the
1300                          * WIM image. */
1301                         wimlib_tchar *wim_target_path;
1302
1303                         /** Configuration for excluded files.  @c NULL means
1304                          * exclude no files (use no configuration), unless
1305                          * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1306                          * add_flags.  */
1307                         struct wimlib_capture_config *config;
1308
1309                         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1310                         int add_flags;
1311                 } add;
1312                 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1313                 struct wimlib_delete_command {
1314                         /** Path, specified from the root of the WIM image, for
1315                          * the file or directory tree within the WIM image to be
1316                          * deleted. */
1317                         wimlib_tchar *wim_path;
1318                         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1319                         int delete_flags;
1320                 } delete;
1321                 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1322                 struct wimlib_rename_command {
1323                         /** Path, specified from the root of the WIM image, for
1324                          * the source file or directory tree within the WIM
1325                          * image. */
1326                         wimlib_tchar *wim_source_path;
1327                         /** Path, specified from the root of the WIM image, for
1328                          * the destination file or directory tree within the WIM
1329                          * image. */
1330                         wimlib_tchar *wim_target_path;
1331                         /** Reserved; set to 0. */
1332                         int rename_flags;
1333                 } rename;
1334         };
1335 };
1336
1337 /** Specification of a file or directory tree to extract from a WIM image. */
1338 struct wimlib_extract_command {
1339         /** Path to file or directory tree within the WIM image to extract.  It
1340          * must be provided as an absolute path from the root of the WIM image.
1341          * The path separators may be either forward slashes or backslashes. */
1342         wimlib_tchar *wim_source_path;
1343
1344         /** Filesystem path to extract the file or directory tree to. */
1345         wimlib_tchar *fs_dest_path;
1346
1347         /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1348         int extract_flags;
1349 };
1350
1351 /**
1352  * Possible values of the error code returned by many functions in wimlib.
1353  *
1354  * See the documentation for each wimlib function to see specifically what error
1355  * codes can be returned by a given function, and what they mean.
1356  */
1357 enum wimlib_error_code {
1358         WIMLIB_ERR_SUCCESS = 0,
1359         WIMLIB_ERR_ALREADY_LOCKED,
1360         WIMLIB_ERR_DECOMPRESSION,
1361         WIMLIB_ERR_DELETE_STAGING_DIR,
1362         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1363         WIMLIB_ERR_FORK,
1364         WIMLIB_ERR_FUSE,
1365         WIMLIB_ERR_FUSERMOUNT,
1366         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1367         WIMLIB_ERR_IMAGE_COUNT,
1368         WIMLIB_ERR_IMAGE_NAME_COLLISION,
1369         WIMLIB_ERR_INTEGRITY,
1370         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1371         WIMLIB_ERR_INVALID_CHUNK_SIZE,
1372         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1373         WIMLIB_ERR_INVALID_HEADER,
1374         WIMLIB_ERR_INVALID_IMAGE,
1375         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1376         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1377         WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1378         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1379         WIMLIB_ERR_INVALID_OVERLAY,
1380         WIMLIB_ERR_INVALID_PARAM,
1381         WIMLIB_ERR_INVALID_PART_NUMBER,
1382         WIMLIB_ERR_INVALID_PIPABLE_WIM,
1383         WIMLIB_ERR_INVALID_REPARSE_DATA,
1384         WIMLIB_ERR_INVALID_RESOURCE_HASH,
1385         WIMLIB_ERR_INVALID_SECURITY_DATA,
1386         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1387         WIMLIB_ERR_INVALID_UTF16_STRING,
1388         WIMLIB_ERR_INVALID_UTF8_STRING,
1389         WIMLIB_ERR_IS_DIRECTORY,
1390         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1391         WIMLIB_ERR_LINK,
1392         WIMLIB_ERR_MKDIR,
1393         WIMLIB_ERR_MQUEUE,
1394         WIMLIB_ERR_NOMEM,
1395         WIMLIB_ERR_NOTDIR,
1396         WIMLIB_ERR_NOTEMPTY,
1397         WIMLIB_ERR_NOT_A_REGULAR_FILE,
1398         WIMLIB_ERR_NOT_A_WIM_FILE,
1399         WIMLIB_ERR_NOT_PIPABLE,
1400         WIMLIB_ERR_NO_FILENAME,
1401         WIMLIB_ERR_NTFS_3G,
1402         WIMLIB_ERR_OPEN,
1403         WIMLIB_ERR_OPENDIR,
1404         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1405         WIMLIB_ERR_READ,
1406         WIMLIB_ERR_READLINK,
1407         WIMLIB_ERR_RENAME,
1408         WIMLIB_ERR_REOPEN,
1409         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1410         WIMLIB_ERR_RESOURCE_NOT_FOUND,
1411         WIMLIB_ERR_RESOURCE_ORDER,
1412         WIMLIB_ERR_SET_ATTRIBUTES,
1413         WIMLIB_ERR_SET_REPARSE_DATA,
1414         WIMLIB_ERR_SET_SECURITY,
1415         WIMLIB_ERR_SET_SHORT_NAME,
1416         WIMLIB_ERR_SET_TIMESTAMPS,
1417         WIMLIB_ERR_SPLIT_INVALID,
1418         WIMLIB_ERR_SPLIT_UNSUPPORTED,
1419         WIMLIB_ERR_STAT,
1420         WIMLIB_ERR_TIMEOUT,
1421         WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1422         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1423         WIMLIB_ERR_UNKNOWN_VERSION,
1424         WIMLIB_ERR_UNSUPPORTED,
1425         WIMLIB_ERR_UNSUPPORTED_FILE,
1426         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1427         WIMLIB_ERR_WIM_IS_READONLY,
1428         WIMLIB_ERR_WRITE,
1429         WIMLIB_ERR_XML,
1430 };
1431
1432
1433 /** Used to indicate no WIM image or an invalid WIM image. */
1434 #define WIMLIB_NO_IMAGE         0
1435
1436 /** Used to specify all images in the WIM. */
1437 #define WIMLIB_ALL_IMAGES       (-1)
1438
1439 /**
1440  * Appends an empty image to a WIM file.  This empty image will initially
1441  * contain no files or directories, although if written without further
1442  * modifications, a root directory will be created automatically for it.  After
1443  * calling this function, you can use wimlib_update_image() to add files to the
1444  * new WIM image.  This gives you slightly more control over making the new
1445  * image compared to calling wimlib_add_image() or
1446  * wimlib_add_image_multisource() directly.
1447  *
1448  * @param wim
1449  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
1450  *      added.
1451  * @param name
1452  *      Name to give the new image.  If @c NULL or empty, the new image is given
1453  *      no name.  If nonempty, it must specify a name that does not already
1454  *      exist in @p wim.
1455  * @param new_idx_ret
1456  *      If non-<code>NULL</code>, the index of the newly added image is returned
1457  *      in this location.
1458  *
1459  * @return 0 on success; nonzero on failure.  The possible error codes are:
1460  *
1461  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1462  *      There is already an image in @p wim named @p name.
1463  * @retval ::WIMLIB_ERR_NOMEM
1464  *      Failed to allocate the memory needed to add the new image.
1465  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1466  *      The WIM file is considered read-only because of any of the reasons
1467  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1468  *      flag.
1469  */
1470 extern int
1471 wimlib_add_empty_image(WIMStruct *wim,
1472                        const wimlib_tchar *name,
1473                        int *new_idx_ret);
1474
1475 /**
1476  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1477  *
1478  * The directory tree or NTFS volume is scanned immediately to load the dentry
1479  * tree into memory, and file attributes and symbolic links are read.  However,
1480  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1481  * called.
1482  *
1483  * See the manual page for the @b wimlib-imagex program for more information
1484  * about the "normal" capture mode versus the NTFS capture mode (entered by
1485  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1486  *
1487  * Note that @b no changes are committed to the underlying WIM file (if
1488  * any) until wimlib_write() or wimlib_overwrite() is called.
1489  *
1490  * @param wim
1491  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
1492  *      added.
1493  * @param source
1494  *      A path to a directory or unmounted NTFS volume that will be captured as
1495  *      a WIM image.
1496  * @param name
1497  *      Name to give the new image.  If @c NULL or empty, the new image is given
1498  *      no name.  If nonempty, it must specify a name that does not already
1499  *      exist in @p wim.
1500  * @param config
1501  *      Capture configuration that specifies files, directories, or path globs
1502  *      to exclude from being captured.  If @c NULL, a dummy configuration where
1503  *      no paths are treated specially is used.
1504  * @param add_flags
1505  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1506  * @param progress_func
1507  *      If non-NULL, a function that will be called periodically with the
1508  *      progress of the current operation.  The progress messages that will be
1509  *      received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1510  *      ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1511  *      included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1512  *
1513  * @return 0 on success; nonzero on error.  On error, changes to @p wim are
1514  * discarded so that it appears to be in the same state as when this function
1515  * was called.
1516  *
1517  * This function is implemented by calling wimlib_add_empty_image(), then
1518  * calling wimlib_update_image() with a single "add" command, so any error code
1519  * returned by wimlib_add_empty_image() may be returned, as well as any error
1520  * codes returned by wimlib_update_image() other than ones documented as only
1521  * being returned specifically by an update involving delete or rename commands.
1522  */
1523 extern int
1524 wimlib_add_image(WIMStruct *wim,
1525                  const wimlib_tchar *source,
1526                  const wimlib_tchar *name,
1527                  const struct wimlib_capture_config *config,
1528                  int add_flags,
1529                  wimlib_progress_func_t progress_func);
1530
1531 /** This function is equivalent to wimlib_add_image() except it allows for
1532  * multiple sources to be combined into a single WIM image.  This is done by
1533  * specifying the @p sources and @p num_sources parameters instead of the @p
1534  * source parameter of wimlib_add_image().  The rest of the parameters are the
1535  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
1536  * capture</b> for full details on how this mode works.
1537  *
1538  * In addition to the error codes that wimlib_add_image() can return,
1539  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1540  * when trying to overlay a non-directory on a directory or when otherwise
1541  * trying to overlay multiple conflicting files to the same location in the WIM
1542  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
1543  * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1544  * was not exactly one capture source with the target being the root directory.
1545  * (In this respect, there is no advantage to using
1546  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1547  * NTFS mode.) */
1548 extern int
1549 wimlib_add_image_multisource(WIMStruct *wim,
1550                              const struct wimlib_capture_source *sources,
1551                              size_t num_sources,
1552                              const wimlib_tchar *name,
1553                              const struct wimlib_capture_config *config,
1554                              int add_flags,
1555                              wimlib_progress_func_t progress_func);
1556
1557 /**
1558  * Creates a ::WIMStruct for a new WIM file.
1559  *
1560  * This only creates an in-memory structure for a WIM that initially contains no
1561  * images.  No on-disk file is created until wimlib_write() is called.
1562  *
1563  * @param ctype
1564  *      The type of compression to be used in the new WIM file.  Must be
1565  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1566  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1567  * @param wim_ret
1568  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1569  *      written to the memory location pointed to by this paramater.  The
1570  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1571  *      it.
1572  * @return 0 on success; nonzero on error.
1573  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1574  *      @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1575  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1576  * @retval ::WIMLIB_ERR_NOMEM
1577  *      Failed to allocate needed memory.
1578  */
1579 extern int
1580 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1581
1582 /**
1583  * Deletes an image, or all images, from a WIM file.
1584  *
1585  * All streams referenced by the image(s) being deleted are removed from the
1586  * lookup table of the WIM if they are not referenced by any other images in the
1587  * WIM.
1588  *
1589  * Please note that @b no changes are committed to the underlying WIM file (if
1590  * any) until wimlib_write() or wimlib_overwrite() is called.
1591  *
1592  * @param wim
1593  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1594  *      being deleted.
1595  * @param image
1596  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1597  *      images.
1598  * @return 0 on success; nonzero on failure.  On failure, @p wim is guaranteed
1599  * to be left unmodified only if @p image specified a single image.  If instead
1600  * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
1601  * possible for some but not all of the images to have been deleted when a
1602  * failure status is returned.
1603  *
1604  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1605  *      @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1606  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1607  *      The WIM file is considered read-only because of any of the reasons
1608  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1609  *      flag.
1610  *
1611  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1612  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
1613  * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
1614  * indicate failure (for different reasons) to read the metadata resource for an
1615  * image that needed to be deleted.
1616  */
1617 extern int
1618 wimlib_delete_image(WIMStruct *wim, int image);
1619
1620 /**
1621  * Exports an image, or all the images, from a WIM file, into another WIM file.
1622  *
1623  * The destination image is made to share the same dentry tree and security data
1624  * structure as the source image.  This places some restrictions on additional
1625  * functions that may be called.  wimlib_mount_image() may not be called on
1626  * either the source image or the destination image without an intervening call
1627  * to a function that un-shares the images, such as wimlib_free() on @p
1628  * dest_wim, or wimlib_delete_image() on either the source or destination image.
1629  * Furthermore, you may not call wimlib_free() on @p src_wim before calling
1630  * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
1631  * have references back to @p src_wim.
1632  *
1633  * If this function fails, all changes to @p dest_wim are rolled back.
1634  *
1635  * Please note that no changes are committed to the underlying WIM file of @p
1636  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1637  *
1638  * @param src_wim
1639  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1640  *      WIM that contains the image(s) being exported.
1641  * @param src_image
1642  *      The image to export from @p src_wim.  Can be the number of an image, or
1643  *      ::WIMLIB_ALL_IMAGES to export all images.
1644  * @param dest_wim
1645  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
1646  *      being exported.
1647  * @param dest_name
1648  *      The name to give the exported image in the new WIM file.  If left @c
1649  *      NULL, the name from @p src_wim is used.  This parameter must be left @c
1650  *      NULL if @p src_image is ::WIMLIB_ALL_IMAGES and @p src_wim contains more
1651  *      than one image; in that case, the names are all taken from the @p
1652  *      src_wim.  (This is allowed even if one or more images being exported has
1653  *      no name.)
1654  * @param dest_description
1655  *      The description to give the exported image in the new WIM file.  If left
1656  *      @c NULL, the description from the @p src_wim is used.  This parameter must
1657  *      be left @c NULL if @p src_image is ::WIMLIB_ALL_IMAGES and @p src_wim contains
1658  *      more than one image; in that case, the descriptions are all taken from
1659  *      @p src_wim.  (This is allowed even if one or more images being exported
1660  *      has no description.)
1661  * @param export_flags
1662  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1663  *      bootable, or 0 if which image is marked as bootable in the destination
1664  *      WIM is to be left unchanged.  If @p src_image is ::WIMLIB_ALL_IMAGES and
1665  *      there are multiple images in @p src_wim, specifying
1666  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1667  *      currently marked as bootable in @p src_wim; if that is the case, then
1668  *      that image is marked as bootable in the destination WIM.
1669  * @param additional_swms
1670  *      Array of pointers to the ::WIMStruct for each additional part in the
1671  *      split WIM.  Ignored if @p num_additional_swms is 0.  The pointers do not
1672  *      need to be in any particular order, but they must include all parts of
1673  *      the split WIM other than the first part, which must be provided in the
1674  *      @p wim parameter.
1675  * @param num_additional_swms
1676  *      Number of additional WIM parts provided in the @p additional_swms array.
1677  *      This number should be one less than the total number of parts in the
1678  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1679  * @param progress_func
1680  *      If non-NULL, a function that will be called periodically with the
1681  *      progress of the current operation.
1682  *
1683  * @return 0 on success; nonzero on error.
1684  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1685  *      One or more of the names being given to an exported image was already in
1686  *      use in the destination WIM.
1687  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1688  *      @p src_image does not exist in @p src_wim.
1689  * @retval ::WIMLIB_ERR_INVALID_PARAM
1690  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @p flags, @p src_image was
1691  *      ::WIMLIB_ALL_IMAGES, @p src_wim contains multiple images, and no images in
1692  *      @p src_wim are marked as bootable; or @p dest_name and/or @p
1693  *      dest_description were non-<code>NULL</code>, @p src_image was
1694  *      ::WIMLIB_ALL_IMAGES, and @p src_wim contains multiple images.
1695  * @retval ::WIMLIB_ERR_NOMEM
1696  *      Failed to allocate needed memory.
1697  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1698  *      The source WIM is a split WIM, but the parts specified do not form a
1699  *      complete split WIM because they do not include all the parts of the
1700  *      split WIM, there are duplicate parts, or not all the parts are in fact
1701  *      from the same split WIM.
1702  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1703  *      @p dest_wim is considered read-only because of any of the reasons
1704  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1705  *      flag.
1706  *
1707  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1708  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
1709  * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
1710  * indicate failure (for different reasons) to read the metadata resource for an
1711  * image in @p src_wim that needed to be exported.
1712  */
1713 extern int
1714 wimlib_export_image(WIMStruct *src_wim, int src_image,
1715                     WIMStruct *dest_wim,
1716                     const wimlib_tchar *dest_name,
1717                     const wimlib_tchar *dest_description,
1718                     int export_flags,
1719                     WIMStruct **additional_swms,
1720                     unsigned num_additional_swms,
1721                     wimlib_progress_func_t progress_func);
1722
1723 /**
1724  * Extract zero or more files or directory trees from a WIM image.
1725  *
1726  * This generalizes the single-image extraction functionality of
1727  * wimlib_extract_image() to allow extracting only the specified subsets of the
1728  * image.
1729  *
1730  * @param wim
1731  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1732  *      split WIM.
1733  *
1734  * @param image
1735  *      The 1-based number of the image in @p wim from which the files or
1736  *      directory trees are to be extracted.  It cannot be ::WIMLIB_ALL_IMAGES.
1737  *
1738  * @param cmds
1739  *      An array of ::wimlib_extract_command structures that specifies the
1740  *      extractions to perform.
1741  *
1742  * @param num_cmds
1743  *      Number of commands in the @p cmds array.
1744  *
1745  * @param default_extract_flags
1746  *      Default extraction flags; the behavior shall be as if these flags had
1747  *      been specified in the ::wimlib_extract_command.extract_flags member in
1748  *      each extraction command, in combination with any flags already present.
1749  *
1750  * @param additional_swms
1751  *      Array of pointers to the ::WIMStruct for each additional part in the
1752  *      split WIM.  Ignored if @p num_additional_swms is 0.  The pointers do not
1753  *      need to be in any particular order, but they must include all parts of
1754  *      the split WIM other than the first part, which must be provided in the
1755  *      @p wim parameter.
1756  *
1757  * @param num_additional_swms
1758  *      Number of additional WIM parts provided in the @p additional_swms array.
1759  *      This number should be one less than the total number of parts in the
1760  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1761  *
1762  * @param progress_func
1763  *      If non-NULL, a function that will be called periodically with the
1764  *      progress of the current operation.
1765  *
1766  * @return 0 on success; nonzero on error.  The possible error codes include
1767  * most of those documented as returned by wimlib_extract_image() as well as the
1768  * following additional error codes:
1769  *
1770  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1771  *      @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
1772  *      the WIM file).
1773  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1774  *      The ::wimlib_extract_command.wim_source_path member in one of the
1775  *      extract commands did not exist in the WIM.
1776  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1777  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1778  *      in which ::wimlib_extract_command.wim_source_path existed but was not a
1779  *      regular file or directory.
1780  * @retval ::WIMLIB_ERR_INVALID_PARAM
1781  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1782  *      specified for some commands but not all; or
1783  *      ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1784  *      for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1785  *      for a command in which ::wimlib_extract_command.wim_source_path did not
1786  *      specify the root directory of the WIM image.
1787  */
1788 extern int
1789 wimlib_extract_files(WIMStruct *wim,
1790                      int image,
1791                      const struct wimlib_extract_command *cmds,
1792                      size_t num_cmds,
1793                      int default_extract_flags,
1794                      WIMStruct **additional_swms,
1795                      unsigned num_additional_swms,
1796                      wimlib_progress_func_t progress_func);
1797
1798 /**
1799  * Extracts an image, or all images, from a standalone or split WIM file to a
1800  * directory or directly to a NTFS volume image.
1801  *
1802  * The exact behavior of how wimlib extracts files from a WIM image is
1803  * controllable by the @p extract_flags parameter, but there also are
1804  * differences depending on the platform (UNIX-like vs Windows).  See the manual
1805  * page for <b>wimlib-imagex apply</b> for more information, including about the
1806  * special "NTFS volume extraction mode" entered by providing
1807  * ::WIMLIB_EXTRACT_FLAG_NTFS.
1808  *
1809  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1810  * returned if any resulting SHA1 message digests do not match the values
1811  * provided in the WIM file.  Therefore, if this function is successful, you can
1812  * be fairly sure that any compressed data in the WIM was uncompressed
1813  * correctly.
1814  *
1815  * @param wim
1816  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1817  *      split WIM.
1818  * @param image
1819  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1820  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1821  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
1822  * @param target
1823  *      Directory to extract the WIM image(s) to (created if it does not already
1824  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
1825  *      path to the unmounted NTFS volume to extract the image to.
1826  * @param extract_flags
1827  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1828  * @param additional_swms
1829  *      Array of pointers to the ::WIMStruct for each additional part in the
1830  *      split WIM.  Ignored if @p num_additional_swms is 0.  The pointers do not
1831  *      need to be in any particular order, but they must include all parts of
1832  *      the split WIM other than the first part, which must be provided in the
1833  *      @p wim parameter.
1834  * @param num_additional_swms
1835  *      Number of additional WIM parts provided in the @p additional_swms array.
1836  *      This number should be one less than the total number of parts in the
1837  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1838  *
1839  * @param progress_func
1840  *      If non-NULL, a function that will be called periodically with the
1841  *      progress of the current operation.
1842  *
1843  * @return 0 on success; nonzero on error.
1844  * @retval ::WIMLIB_ERR_DECOMPRESSION
1845  *      Failed to decompress a resource to be extracted, or failed to decompress
1846  *      a needed metadata resource.
1847  * @retval ::WIMLIB_ERR_INVALID_PARAM
1848  *      Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
1849  *      were specified in @p extract_flags; or both
1850  *      ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
1851  *      specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
1852  *      ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
1853  *      ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
1854  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
1855  *      @p image was ::WIMLIB_ALL_IMAGES.
1856  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
1857  *      The metadata resource for an image being extracted was invalid.
1858  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1859  *      The SHA1 message digest of an extracted stream did not match the SHA1
1860  *      message digest given in the WIM file.
1861  * @retval ::WIMLIB_ERR_LINK
1862  *      Failed to create a symbolic link or a hard link.
1863  * @retval ::WIMLIB_ERR_MKDIR
1864  *      Failed create a directory.
1865  * @retval ::WIMLIB_ERR_NOMEM
1866  *      Failed to allocate needed memory.
1867  * @retval ::WIMLIB_ERR_OPEN
1868  *      Could not create a file, or failed to open an already-extracted file.
1869  * @retval ::WIMLIB_ERR_READ
1870  *      Failed to read data from the WIM file associated with @p wim.
1871  * @retval ::WIMLIB_ERR_READLINK
1872  *      Failed to determine the target of a symbolic link in the WIM.
1873  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
1874  *      Failed to fix the target of an absolute symbolic link (e.g. if the
1875  *      target would have exceeded the maximum allowed length).  (Only if
1876  *      reparse data was supported by the extraction mode and
1877  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
1878  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1879  *      One of the files or directories that needed to be extracted referenced a
1880  *      stream not present in the WIM's lookup table (or in any of the lookup
1881  *      tables of the split WIM parts).
1882  * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
1883  *      Failed to set attributes on a file.
1884  * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
1885  *      Failed to set reparse data on a file (only if reparse data was supported
1886  *      by the extraction mode).
1887  * @retval ::WIMLIB_ERR_SET_SECURITY
1888  *      Failed to set security descriptor on a file
1889  *      (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
1890  *      extract_flags).
1891  * @retval ::WIMLIB_ERR_SET_SHORT_NAME
1892  *      Failed to set the short name of a file (only if
1893  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
1894  * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
1895  *      Failed to set timestamps on a file (only if
1896  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
1897  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1898  *      The WIM is a split WIM, but the parts specified do not form a complete
1899  *      split WIM because they do not include all the parts of the original WIM,
1900  *      there are duplicate parts, or not all the parts have the same GUID and
1901  *      compression type.
1902  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
1903  *      Unexpected end-of-file occurred when reading data from the WIM file
1904  *      associated with @p wim.
1905  * @retval ::WIMLIB_ERR_UNSUPPORTED
1906  *      A requested extraction flag, or the data or metadata that must be
1907  *      extracted to support it, is unsupported in the build and configuration
1908  *      of wimlib, or on the current platform or extraction mode or target
1909  *      volume.  Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
1910  *      ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
1911  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
1912  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
1913  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
1914  *      and ::WIMLIB_EXTRACT_FLAG_HARDLINK.  For example, if
1915  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
1916  *      extract_flags,
1917  *      ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
1918  *      or more files with short names, but extracting short names is not
1919  *      supported --- on Windows, this occurs if the target volume does not
1920  *      support short names, while on non-Windows, this occurs if
1921  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
1922  * @retval ::WIMLIB_ERR_WRITE
1923  *      Failed to write data to a file being extracted.
1924  */
1925 extern int
1926 wimlib_extract_image(WIMStruct *wim, int image,
1927                      const wimlib_tchar *target,
1928                      int extract_flags,
1929                      WIMStruct **additional_swms,
1930                      unsigned num_additional_swms,
1931                      wimlib_progress_func_t progress_func);
1932
1933 /**
1934  * Since wimlib v1.5.0:  Extract one or more images from a pipe on which a
1935  * pipable WIM is being sent.
1936  *
1937  * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
1938  * about pipable WIMs.
1939  *
1940  * This function operates in a special way to read the WIM fully sequentially.
1941  * As a result, there is no ::WIMStruct is made visible to library users, and
1942  * you cannot call wimlib_open_wim() on the pipe.  (You can, however, use
1943  * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
1944  * seekable file, not a pipe.)
1945  *
1946  * @param pipe_fd
1947  *      File descriptor, which may be a pipe, opened for reading and positioned
1948  *      at the start of the pipable WIM.
1949  * @param image_num_or_name
1950  *      String that specifies the 1-based index or name of the image to extract.
1951  *      It is translated to an image index using the same rules that
1952  *      wimlib_resolve_image() uses.  However, unlike wimlib_extract_image(),
1953  *      only a single image (not all images) can be specified.  Alternatively,
1954  *      specify @p NULL here to use the first image in the WIM if it contains
1955  *      exactly one image but otherwise return @p WIMLIB_ERR_INVALID_IMAGE.
1956  * @param target
1957  *      Same as the corresponding parameter to wimlib_extract_image().
1958  * @param extract_flags
1959  *      Same as the corresponding parameter to wimlib_extract_image(), except
1960  *      for the following exceptions:  ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
1961  *      always implied, since data is always read from @p pipe_fd sequentially
1962  *      in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
1963  *      result in ::WIMLIB_ERR_INVALID_PARAM being returned.
1964  * @param progress_func
1965  *      Same as the corresponding parameter to wimlib_extract_image(), except
1966  *      ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
1967  *      received.
1968  *
1969  * @return 0 on success; nonzero on error.  The possible error codes include
1970  * those returned by wimlib_extract_image() as well as the following:
1971  *
1972  * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
1973  *      Data read from the pipable WIM was invalid.
1974  * @retval ::WIMLIB_ERR_NOT_PIPABLE
1975  *      The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
1976  */
1977 extern int
1978 wimlib_extract_image_from_pipe(int pipe_fd,
1979                                const wimlib_tchar *image_num_or_name,
1980                                const wimlib_tchar *target, int extract_flags,
1981                                wimlib_progress_func_t progress_func);
1982
1983 /**
1984  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1985  * includes a string of XML that describes the images contained in the WIM.
1986  * This function works on standalone WIMs as well as split WIM parts.
1987  *
1988  * @param wim
1989  *      Pointer to the ::WIMStruct for a WIM file.
1990  * @param fp
1991  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1992  *
1993  * @return 0 on success; nonzero on error.
1994  * @retval ::WIMLIB_ERR_INVALID_PARAM
1995  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
1996  * @retval ::WIMLIB_ERR_NOMEM
1997  * @retval ::WIMLIB_ERR_READ
1998  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
1999  *      Failed to read the XML data from the WIM.
2000  * @retval ::WIMLIB_ERR_WRITE
2001  *      Failed to completely write the XML data to @p fp.
2002  */
2003 extern int
2004 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2005
2006 /**
2007  * Frees all memory allocated for a WIMStruct and closes all files associated
2008  * with it.
2009  *
2010  * @param wim
2011  *      Pointer to the ::WIMStruct for a WIM file.
2012  *
2013  * @return This function has no return value.
2014  */
2015 extern void
2016 wimlib_free(WIMStruct *wim);
2017
2018 /**
2019  * Converts a ::wimlib_compression_type value into a string.
2020  *
2021  * @param ctype
2022  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2023  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2024  *
2025  * @return
2026  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2027  *      respectively.
2028  */
2029 extern const wimlib_tchar *
2030 wimlib_get_compression_type_string(int ctype);
2031
2032 /**
2033  * Converts an error code into a string describing it.
2034  *
2035  * @param code
2036  *      The error code returned by one of wimlib's functions.
2037  *
2038  * @return
2039  *      Pointer to a statically allocated string describing the error code,
2040  *      or @c NULL if the error code is not valid.
2041  */
2042 extern const wimlib_tchar *
2043 wimlib_get_error_string(enum wimlib_error_code code);
2044
2045 /**
2046  * Returns the description of the specified image.
2047  *
2048  * @param wim
2049  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2050  *      standalone WIM or a split WIM part.
2051  * @param image
2052  *      The number of the image, numbered starting at 1.
2053  *
2054  * @return
2055  *      The description of the image, or @c NULL if there is no such image, or
2056  *      @c NULL if the specified image has no description.  The description
2057  *      string is in library-internal memory and may not be modified or freed;
2058  *      in addition, the string will become invalid if the description of the
2059  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2060  */
2061 extern const wimlib_tchar *
2062 wimlib_get_image_description(const WIMStruct *wim, int image);
2063
2064 /**
2065  * Returns the name of the specified image.
2066  *
2067  * @param wim
2068  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2069  *      standalone WIM or a split WIM part.
2070  * @param image
2071  *      The number of the image, numbered starting at 1.
2072  *
2073  * @return
2074  *      The name of the image, or @c NULL if there is no such image, or an empty
2075  *      string if the image is unnamed.  The name string is in
2076  *      library-internal memory and may not be modified or freed; in addition,
2077  *      the string will become invalid if the name of the image is changed, the
2078  *      image is deleted, or the ::WIMStruct is destroyed.
2079  */
2080 extern const wimlib_tchar *
2081 wimlib_get_image_name(const WIMStruct *wim, int image);
2082
2083
2084 /**
2085  * Get basic information about a WIM file.
2086  *
2087  * @param wim
2088  *      Pointer to the ::WIMStruct for a WIM file.  It may be for either a
2089  *      standalone WIM or part of a split WIM.
2090  * @param info
2091  *      A ::wimlib_wim_info structure that will be filled in with information
2092  *      about the WIM file.
2093  * @return
2094  *      0
2095  */
2096 extern int
2097 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2098
2099 /**
2100  * Initialization function for wimlib.  Call before using any other wimlib
2101  * function except wimlib_set_print_errors().  (However, currently this is not
2102  * strictly necessary and it will be called automatically if not done manually,
2103  * but you should not rely on this behavior.)
2104  *
2105  * @param init_flags
2106  *      Bitwise OR of ::WIMLIB_INIT_FLAG_ASSUME_UTF8 and/or
2107  *      ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES.
2108  *
2109  * @return 0; other error codes may be returned in future releases.
2110  */
2111 extern int
2112 wimlib_global_init(int init_flags);
2113
2114 /**
2115  * Cleanup function for wimlib.  You are not required to call this function, but
2116  * it will release any global resources allocated by the library.
2117  */
2118 extern void
2119 wimlib_global_cleanup(void);
2120
2121 /**
2122  * Determines if an image name is already used by some image in the WIM.
2123  *
2124  * @param wim
2125  *      Pointer to the ::WIMStruct for a WIM file.
2126  * @param name
2127  *      The name to check.
2128  *
2129  * @return
2130  *      @c true if there is already an image in @p wim named @p name; @c false
2131  *      if there is no image named @p name in @p wim.  If @p name is @c NULL or
2132  *      the empty string, @c false is returned.
2133  */
2134 extern bool
2135 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2136
2137 /**
2138  * Iterate through a file or directory tree in the WIM image.  By specifying
2139  * appropriate flags and a callback function, you can get the attributes of a
2140  * file in the WIM, get a directory listing, or even get a listing of the entire
2141  * WIM image.
2142  *
2143  * @param wim
2144  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
2145  *      split WIM.
2146  *
2147  * @param image
2148  *      The 1-based number of the image in @p wim that contains the files or
2149  *      directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2150  *      iteration on all images in the WIM.
2151  *
2152  * @param path
2153  *      Path in the WIM image at which to do the iteration.
2154  *
2155  * @param flags
2156  *      Bitwise OR of ::WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE and/or
2157  *      ::WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN.
2158  *
2159  * @param cb
2160  *      A callback function that will receive each directory entry.
2161  *
2162  * @param user_ctx
2163  *      An extra parameter that will always be passed to the callback function
2164  *      @p cb.
2165  *
2166  * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2167  * first nonzero value that was returned from @p cb.  However, additional error
2168  * codes may be returned, including the following:
2169  *
2170  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2171  *      @p path did not exist in the WIM image.
2172  * @retval ::WIMLIB_ERR_NOMEM
2173  *      Failed to allocate memory needed to create a ::wimlib_dir_entry.
2174  *
2175  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2176  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
2177  * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2178  * indicate failure (for different reasons) to read the metadata resource for an
2179  * image over which iteration needed to be done.
2180  */
2181 extern int
2182 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2183                         int flags,
2184                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2185
2186 /**
2187  * Iterate through the lookup table of a WIM file.  This can be used to directly
2188  * get a listing of the unique resources contained in a WIM file.  Both file
2189  * resources and metadata resources are included.
2190  *
2191  * @param wim
2192  *      Pointer to the ::WIMStruct of a standalone WIM file or a split WIM part.
2193  *      Note: metadata resources will only be included if the WIM is standalone
2194  *      or the first part of the split WIM.
2195  *
2196  * @param flags
2197  *      Reserved; set to 0.
2198  *
2199  * @param cb
2200  *      A callback function that will receive each resource.
2201  *
2202  * @param user_ctx
2203  *      An extra parameter that will always be passed to the callback function
2204  *      @p cb.
2205  *
2206  * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2207  * that was returned from @p cb.
2208  */
2209 extern int
2210 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2211                             wimlib_iterate_lookup_table_callback_t cb,
2212                             void *user_ctx);
2213
2214 /**
2215  * Joins a split WIM into a stand-alone one-part WIM.
2216  *
2217  * @param swms
2218  *      An array of strings that gives the filenames of all parts of the split
2219  *      WIM.  No specific order is required, but all parts must be included with
2220  *      no duplicates.
2221  * @param num_swms
2222  *      Number of filenames in @p swms.
2223  * @param swm_open_flags
2224  *      Open flags for the split WIM parts (e.g.
2225  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).  Note: WIMLIB_OPEN_FLAG_SPLIT_OK is
2226  *      automatically added to the value specified here.
2227  * @param wim_write_flags
2228  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2229  *      be used to write the joined WIM.
2230  * @param output_path
2231  *      The path to write the joined WIM file to.
2232  * @param progress_func
2233  *      If non-NULL, a function that will be called periodically with the
2234  *      progress of the current operation.
2235  *
2236  * @return 0 on success; nonzero on error.  This function may return most error
2237  * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2238  * as the following error code:
2239  *
2240  * @retval ::WIMLIB_ERR_SPLIT_INVALID
2241  *      The split WIMs do not form a valid WIM because they do not include all
2242  *      the parts of the original WIM, there are duplicate parts, or not all the
2243  *      parts have the same GUID and compression type.
2244  *
2245  * Note: wimlib_export_image() can provide similar functionality to
2246  * wimlib_join(), since it is possible to export all images from a split WIM.
2247  * Actually, wimlib_join() currently calls wimlib_export_image internally.
2248  */
2249 extern int
2250 wimlib_join(const wimlib_tchar * const *swms,
2251             unsigned num_swms,
2252             const wimlib_tchar *output_path,
2253             int swm_open_flags,
2254             int wim_write_flags,
2255             wimlib_progress_func_t progress_func);
2256
2257 /**
2258  * Compress a chunk of a WIM resource using LZX compression.
2259  *
2260  * This function is exported for convenience only and should only be used by
2261  * library clients looking to make use of wimlib's compression code for another
2262  * purpose.
2263  *
2264  * @param chunk
2265  *      Uncompressed data of the chunk.
2266  * @param chunk_size
2267  *      Size of the uncompressed chunk, in bytes.
2268  * @param out
2269  *      Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2270  *
2271  * @return
2272  *      The size of the compressed data written to @p out in bytes, or 0 if the
2273  *      data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2274  *
2275  * As a special requirement, the compression code is optimized for the WIM
2276  * format and therefore requires (@p chunk_size <= 32768).
2277  */
2278 extern unsigned
2279 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
2280
2281 /**
2282  * Decompresses a block of LZX-compressed data as used in the WIM file format.
2283  *
2284  * Note that this will NOT work unmodified for LZX as used in the cabinet
2285  * format, which is not the same as in the WIM format!
2286  *
2287  * This function is exported for convenience only and should only be used by
2288  * library clients looking to make use of wimlib's compression code for another
2289  * purpose.
2290  *
2291  * @param compressed_data
2292  *      Pointer to the compressed data.
2293  *
2294  * @param compressed_len
2295  *      Length of the compressed data, in bytes.
2296  *
2297  * @param uncompressed_data
2298  *      Pointer to the buffer into which to write the uncompressed data.
2299  *
2300  * @param uncompressed_len
2301  *      Length of the uncompressed data.  It must be 32768 bytes or less.
2302  *
2303  * @return
2304  *      0 on success; non-zero on failure.
2305  */
2306 extern int
2307 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2308                       void *uncompressed_data, unsigned uncompressed_len);
2309
2310
2311 /**
2312  * Mounts an image in a WIM file on a directory read-only or read-write.
2313  *
2314  * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2315  * supported if wimlib was configured with @c --without-fuse.  This includes
2316  * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2317  * cases.
2318  *
2319  * Calling this function daemonizes the process, unless
2320  * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs.  If the
2321  * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2322  * to the WIM are staged in a temporary directory.
2323  *
2324  * It is safe to mount multiple images from the same underlying WIM file
2325  * read-only at the same time, but only if different ::WIMStruct's are used.  It
2326  * is @b not safe to mount multiple images from the same WIM file read-write at
2327  * the same time.
2328  *
2329  * wimlib_mount_image() cannot be used on an image that was exported with
2330  * wimlib_export_image() while the dentry trees for both images are still in
2331  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
2332  * that already has modifications pending (e.g. an image added with
2333  * wimlib_add_image()).
2334  *
2335  * @param wim
2336  *      Pointer to the ::WIMStruct containing the image to be mounted.
2337  * @param image
2338  *      The number of the image to mount, indexed starting from it.  It must be
2339  *      an existing, single image.
2340  * @param dir
2341  *      The path to an existing empty directory to mount the image on.
2342  * @param mount_flags
2343  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2344  * @param additional_swms
2345  *      Array of pointers to the ::WIMStruct for each additional part in the
2346  *      split WIM.  Ignored if @p num_additional_swms is 0.  The pointers do not
2347  *      need to be in any particular order, but they must include all parts of
2348  *      the split WIM other than the first part, which must be provided in the
2349  *      @p wim parameter.
2350  * @param num_additional_swms
2351  *      Number of additional WIM parts provided in the @p additional_swms array.
2352  *      This number should be one less than the total number of parts in the
2353  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
2354  * @param staging_dir
2355  *      If non-NULL, the name of a directory in which the staging directory will
2356  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2357  *      in @p mount_flags.  If left @c NULL, the staging directory is created in
2358  *      the same directory as the WIM file that @p wim was originally read from.
2359  *
2360  * @return 0 on success; nonzero on error.
2361  *
2362  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2363  *      A read-write mount was requested, but an an exclusive advisory lock on
2364  *      the on-disk WIM file could not be acquired because another thread or
2365  *      process has mounted an image from the WIM read-write or is currently
2366  *      modifying the WIM in-place.
2367  * @retval ::WIMLIB_ERR_DECOMPRESSION
2368  *      Could not decompress the metadata resource for @p image in @p wim.
2369  * @retval ::WIMLIB_ERR_FUSE
2370  *      A non-zero status was returned by @c fuse_main().
2371  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2372  *      @p image does not specify an existing, single image in @p wim.
2373  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2374  *      The metadata resource for @p image is invalid.
2375  * @retval ::WIMLIB_ERR_INVALID_PARAM
2376  *      @p image is shared among multiple ::WIMStruct's as a result of a call to
2377  *      wimlib_export_image(), or @p image has been added with
2378  *      wimlib_add_image().
2379  * @retval ::WIMLIB_ERR_MKDIR
2380  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2381  *      staging directory could not be created.
2382  * @retval ::WIMLIB_ERR_NOMEM
2383  *      Failed to allocate needed memory.
2384  * @retval ::WIMLIB_ERR_NOTDIR
2385  *      Could not determine the current working directory.
2386  * @retval ::WIMLIB_ERR_READ
2387  *      Failed to read data from the WIM file associated with @p wim.
2388  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2389  *      One of the dentries in the image referenced a stream not present in the
2390  *      WIM's lookup table (or in any of the lookup tables of the split WIM
2391  *      parts).
2392  * @retval ::WIMLIB_ERR_SPLIT_INVALID
2393  *      The WIM is a split WIM, but the parts specified do not form a complete
2394  *      split WIM because they do not include all the parts of the original WIM,
2395  *      there are duplicate parts, or not all the parts have the same GUID and
2396  *      compression type.
2397  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2398  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2399  *      wim is considered read-only because of any of the reasons mentioned in
2400  *      the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2401  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2402  *      Unexpected end-of-file occurred while reading data from the WIM file
2403  *      associated with @p wim.
2404  * @retval ::WIMLIB_ERR_UNSUPPORTED
2405  *      Mounting is not supported, either because the platform is Windows, or
2406  *      because the platform is UNIX-like and wimlib was compiled with @c
2407  *      --without-fuse.
2408  */
2409 extern int
2410 wimlib_mount_image(WIMStruct *wim,
2411                    int image,
2412                    const wimlib_tchar *dir,
2413                    int mount_flags,
2414                    WIMStruct **additional_swms,
2415                    unsigned num_additional_swms,
2416                    const wimlib_tchar *staging_dir);
2417
2418 /**
2419  * Opens a WIM file and creates a ::WIMStruct for it.
2420  *
2421  * @param wim_file
2422  *      The path to the WIM file to open.
2423  *
2424  * @param open_flags
2425  *      Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2426  *
2427  * @param progress_func
2428  *      If non-NULL, a function that will be called periodically with the
2429  *      progress of the current operation.  Currently, the only messages sent
2430  *      will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2431  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2432  *
2433  * @param wim_ret
2434  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2435  *      is written to the memory location pointed to by this parameter.  The
2436  *      ::WIMStruct can be freed using using wimlib_free() when finished with
2437  *      it.
2438  *
2439  * @return 0 on success; nonzero on error.
2440  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2441  *      The WIM is not the non-first part of a split WIM, and the number of
2442  *      metadata resources found in the WIM did not match the image count given
2443  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
2444  *      data for the WIM did not match the image count given in the WIM header.
2445  * @retval ::WIMLIB_ERR_INTEGRITY
2446  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2447  *      wim_file contains an integrity table, but the SHA1 message digest for a
2448  *      chunk of the WIM does not match the corresponding message digest given
2449  *      in the integrity table.
2450  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2451  *      Resources in @p wim_file are compressed, but the chunk size is not 32768.
2452  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2453  *      The header of @p wim_file says that resources in the WIM are compressed,
2454  *      but the header flag indicating LZX or XPRESS compression is not set.
2455  * @retval ::WIMLIB_ERR_INVALID_HEADER
2456  *      The header of @p wim_file was otherwise invalid.
2457  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2458  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2459  *      wim_file contains an integrity table, but the integrity table is
2460  *      invalid.
2461  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2462  *      The lookup table for the WIM contained duplicate entries that are not
2463  *      for metadata resources, or it contained an entry with a SHA1 message
2464  *      digest of all 0's.
2465  * @retval ::WIMLIB_ERR_INVALID_PARAM
2466  *      @p wim_ret was @c NULL.
2467  * @retval ::WIMLIB_ERR_NOMEM
2468  *      Failed to allocated needed memory.
2469  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2470  *      @p wim_file does not begin with the expected magic characters.
2471  * @retval ::WIMLIB_ERR_OPEN
2472  *      Failed to open the file @p wim_file for reading.
2473  * @retval ::WIMLIB_ERR_READ
2474  *      Failed to read data from @p wim_file.
2475  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2476  *      @p wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2477  *      specified in @p open_flags.
2478  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2479  *      Unexpected end-of-file while reading data from @p wim_file.
2480  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2481  *      A number other than 0x10d00 is written in the version field of the WIM
2482  *      header of @p wim_file.  (May be a pre-Vista WIM.)
2483  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2484  *      ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2485  *      considered read-only because of any of the reasons mentioned in the
2486  *      documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2487  * @retval ::WIMLIB_ERR_XML
2488  *      The XML data for @p wim_file is invalid.
2489  */
2490 extern int
2491 wimlib_open_wim(const wimlib_tchar *wim_file,
2492                 int open_flags,
2493                 WIMStruct **wim_ret,
2494                 wimlib_progress_func_t progress_func);
2495
2496 /**
2497  * Overwrites the file that the WIM was originally read from, with changes made.
2498  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2499  * rather than wimlib_create_new_wim().
2500  *
2501  * There are two ways that a WIM may be overwritten.  The first is to do a full
2502  * rebuild.  In this mode, the new WIM is written to a temporary file and then
2503  * renamed to the original file after it is has been completely written.  The
2504  * temporary file is made in the same directory as the original WIM file.  A
2505  * full rebuild may take a while, but can be used even if images have been
2506  * modified or deleted, will produce a WIM with no holes, and has little chance
2507  * of unintentional data loss because the temporary WIM is fsync()ed before
2508  * being renamed to the original WIM.
2509  *
2510  * The second way to overwrite a WIM is by appending to the end of it and
2511  * overwriting the header.  This can be much faster than a full rebuild, but the
2512  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
2513  * begins with writing any new file resources *after* everything in the old WIM,
2514  * even though this will leave a hole where the old lookup table, XML data, and
2515  * integrity were.  This is done so that the WIM remains valid even if the
2516  * operation is aborted mid-write.  The WIM header is only overwritten at the
2517  * very last moment, and up until that point the WIM will be seen as the old
2518  * version.
2519  *
2520  * By default, wimlib_overwrite() does the append-style overwrite described
2521  * above, unless resources in the WIM are arranged in an unusual way or if
2522  * images have been deleted from the WIM.  Use the flag
2523  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2524  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2525  * images have been deleted from the WIM.
2526  *
2527  * In the temporary-file overwrite mode, no changes are made to the WIM on
2528  * failure, and the temporary file is deleted if possible.  Abnormal termination
2529  * of the program will result in the temporary file being orphaned.  In the
2530  * direct append mode, the WIM is truncated to the original length on failure;
2531  * and while abnormal termination of the program will result in extra data
2532  * appended to the original WIM, it should still be a valid WIM.
2533  *
2534  * If this function completes successfully, no more functions should be called
2535  * on @p wim other than wimlib_free().  You must use wimlib_open_wim() to read
2536  * the WIM file anew.
2537  *
2538  * @param wim
2539  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
2540  *      been in-memory changes made to it, which are then reflected in the
2541  *      output file.
2542  * @param write_flags
2543  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
2544  * @param num_threads
2545  *      Number of threads to use for compression (see wimlib_write()).
2546  * @param progress_func
2547  *      If non-NULL, a function that will be called periodically with the
2548  *      progress of the current operation.
2549  *
2550  * @return 0 on success; nonzero on error.  This function may return any value
2551  * returned by wimlib_write() as well as the following error codes:
2552  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2553  *      The WIM was going to be modified in-place (with no temporary file), but
2554  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
2555  *      because another thread or process has mounted an image from the WIM
2556  *      read-write or is currently modifying the WIM in-place.
2557  * @retval ::WIMLIB_ERR_NO_FILENAME
2558  *      @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
2559  *      than a WIM read with wimlib_open_wim().
2560  * @retval ::WIMLIB_ERR_RENAME
2561  *      The temporary file that the WIM was written to could not be renamed to
2562  *      the original filename of @p wim.
2563  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2564  *      The WIM file is considered read-only because of any of the reasons
2565  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2566  *      flag.
2567  */
2568 extern int
2569 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2570                  wimlib_progress_func_t progress_func);
2571
2572 /**
2573  * Prints information about one image, or all images, contained in a WIM.
2574  *
2575  * @param wim
2576  *      Pointer to the ::WIMStruct for a WIM file.
2577  * @param image
2578  *      The image about which to print information.  Can be the number of an
2579  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2580  *      WIM.
2581  *
2582  * @return This function has no return value.  No error checking is done when
2583  * printing the information.  If @p image is invalid, an error message is
2584  * printed.
2585  */
2586 extern void
2587 wimlib_print_available_images(const WIMStruct *wim, int image);
2588
2589 /**
2590  * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2591  * in a way that can be accessed programatically.
2592  */
2593 extern void
2594 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
2595
2596 /**
2597  * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2598  * information in a way that can be accessed programatically.
2599  */
2600 extern int
2601 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
2602
2603 /**
2604  * Translates a string specifying the name or number of an image in the WIM into
2605  * the number of the image.  The images are numbered starting at 1.
2606  *
2607  * @param wim
2608  *      Pointer to the ::WIMStruct for a WIM file.
2609  * @param image_name_or_num
2610  *      A string specifying the name or number of an image in the WIM.  If it
2611  *      parses to a positive integer, this integer is taken to specify the
2612  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
2613  *      be the name of an image, as given in the XML data for the WIM file.  It
2614  *      also may be the keyword "all" or the string "*", both of which will
2615  *      resolve to ::WIMLIB_ALL_IMAGES.
2616  *      <br/> <br/>
2617  *      There is no way to search for an image actually named "all", "*", or an
2618  *      integer number, or an image that has no name.  However, you can use
2619  *      wimlib_get_image_name() to get the name of any image.
2620  *
2621  * @return
2622  *      If the string resolved to a single existing image, the number of that
2623  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
2624  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
2625  *      ::WIMLIB_NO_IMAGE is returned.  If @p image_name_or_num was @c NULL or
2626  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2627  *      images in @p wim has no name.
2628  */
2629 extern int
2630 wimlib_resolve_image(WIMStruct *wim,
2631                      const wimlib_tchar *image_name_or_num);
2632
2633 /**
2634  * Changes the description of an image in the WIM.
2635  *
2636  * @param wim
2637  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2638  *      standalone WIM or part of a split WIM; however, you should set the same
2639  *      description on all parts of a split WIM.
2640  * @param image
2641  *      The number of the image for which to change the description.
2642  * @param description
2643  *      The new description to give the image.  It may be @c NULL, which
2644  *      indicates that the image is to be given no description.
2645  *
2646  * @return 0 on success; nonzero on error.
2647  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2648  *      @p image does not specify a single existing image in @p wim.
2649  * @retval ::WIMLIB_ERR_NOMEM
2650  *      Failed to allocate the memory needed to duplicate the @p description
2651  *      string.
2652  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2653  *      @p wim is considered read-only because of any of the reasons mentioned
2654  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2655  */
2656 extern int
2657 wimlib_set_image_descripton(WIMStruct *wim, int image,
2658                             const wimlib_tchar *description);
2659
2660 /**
2661  * Set basic information about a WIM.
2662  *
2663  * @param wim
2664  *      A WIMStruct for a standalone WIM file.
2665  * @param info
2666  *      A struct ::wimlib_wim_info that contains the information to set.  Only
2667  *      the information explicitly specified in the @p which flags need be
2668  *      valid.
2669  * @param which
2670  *      Flags that specify which information to set.  This is a bitwise OR of
2671  *      ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
2672  *      ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
2673  *
2674  * @return 0 on success; nonzero on failure.
2675  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2676  *      The WIM file is considered read-only because of any of the reasons
2677  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2678  *      flag.  However, as a special case, if you are using
2679  *      ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
2680  *      function will not fail due to the readonly flag being previously set.
2681  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2682  *      ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
2683  *      ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
2684  *      index in the WIM.
2685  */
2686 extern int
2687 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
2688                     int which);
2689
2690 /**
2691  * Changes what is written in the \<FLAGS\> element in the WIM XML data
2692  * (something like "Core" or "Ultimate")
2693  *
2694  * @param wim
2695  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2696  *      standalone WIM or part of a split WIM; however, you should set the same
2697  *      \<FLAGS\> element on all parts of a split WIM.
2698  * @param image
2699  *      The number of the image for which to change the description.
2700  * @param flags
2701  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
2702  *      indicates that the image is to be given no \<FLAGS\> element.
2703  *
2704  * @return 0 on success; nonzero on error.
2705  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2706  *      @p image does not specify a single existing image in @p wim.
2707  * @retval ::WIMLIB_ERR_NOMEM
2708  *      Failed to allocate the memory needed to duplicate the @p flags string.
2709  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2710  *      @p wim is considered read-only because of any of the reasons mentioned
2711  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2712  */
2713 extern int
2714 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
2715
2716 /**
2717  * Changes the name of an image in the WIM.
2718  *
2719  * @param wim
2720  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2721  *      standalone WIM or part of a split WIM; however, you should set the same
2722  *      name on all parts of a split WIM.
2723  * @param image
2724  *      The number of the image for which to change the name.
2725  * @param name
2726  *      New name to give the new image.  If @c NULL or empty, the new image is
2727  *      given no name.  If nonempty, it must specify a name that does not
2728  *      already exist in @p wim.
2729  *
2730  * @return 0 on success; nonzero on error.
2731  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2732  *      There is already an image named @p name in @p wim.
2733  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2734  *      @p image does not specify a single existing image in @p wim.
2735  * @retval ::WIMLIB_ERR_NOMEM
2736  *      Failed to allocate the memory needed to duplicate the @p name string.
2737  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2738  *      @p wim is considered read-only because of any of the reasons mentioned
2739  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2740  */
2741 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2742                                  const wimlib_tchar *name);
2743
2744 /**
2745  * Set the functions that wimlib uses to allocate and free memory.
2746  *
2747  * These settings are global and not per-WIM.
2748  *
2749  * The default is to use the default @c malloc() and @c free() from the C
2750  * library.
2751  *
2752  * Please note that some external functions, such as those in @c libntfs-3g, may
2753  * use the standard memory allocation functions.
2754  *
2755  * @param malloc_func
2756  *      A function equivalent to @c malloc() that wimlib will use to allocate
2757  *      memory.  If @c NULL, the allocator function is set back to the default
2758  *      @c malloc() from the C library.
2759  * @param free_func
2760  *      A function equivalent to @c free() that wimlib will use to free memory.
2761  *      If @c NULL, the free function is set back to the default @c free() from
2762  *      the C library.
2763  * @param realloc_func
2764  *      A function equivalent to @c realloc() that wimlib will use to reallocate
2765  *      memory.  If @c NULL, the free function is set back to the default @c
2766  *      realloc() from the C library.
2767  * @return 0 on success; nonzero on error.
2768  * @retval ::WIMLIB_ERR_UNSUPPORTED
2769  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
2770  *      so custom memory allocators are unsupported.
2771  */
2772 extern int
2773 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2774                             void (*free_func)(void *),
2775                             void *(*realloc_func)(void *, size_t));
2776
2777 /**
2778  * Sets whether wimlib is to print error messages to @c stderr when a function
2779  * fails.  These error messages may provide information that cannot be
2780  * determined only from the error code that is returned.  Not every error will
2781  * result in an error message being printed.
2782  *
2783  * This setting is global and not per-WIM.
2784  *
2785  * By default, error messages are not printed.
2786  *
2787  * This can be called before wimlib_global_init().
2788  *
2789  * @param show_messages
2790  *      @c true if error messages are to be printed; @c false if error messages
2791  *      are not to be printed.
2792  *
2793  * @return 0 on success; nonzero on error.
2794  * @retval ::WIMLIB_ERR_UNSUPPORTED
2795  *      @p show_messages was @c true, but wimlib was compiled with the @c
2796  *      --without-error-messages option.   Therefore, error messages cannot be
2797  *      shown.
2798  */
2799 extern int
2800 wimlib_set_print_errors(bool show_messages);
2801
2802 /**
2803  * Splits a WIM into multiple parts.
2804  *
2805  * @param wim
2806  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
2807  *      WIM.
2808  * @param swm_name
2809  *      Name of the SWM file to create.  This will be the name of the first
2810  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
2811  *      appended before the suffix.
2812  * @param part_size
2813  *      The maximum size per part, in bytes.  Unfortunately, it is not
2814  *      guaranteed that this will really be the maximum size per part, because
2815  *      some file resources in the WIM may be larger than this size, and the WIM
2816  *      file format provides no way to split up file resources among multiple
2817  *      WIMs.
2818  * @param write_flags
2819  *      Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG.  These
2820  *      flags will be used to write each split WIM part.  Specify 0 here to get
2821  *      the default behavior.
2822  * @param progress_func
2823  *      If non-NULL, a function that will be called periodically with the
2824  *      progress of the current operation
2825  *      (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
2826  *      ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
2827  *
2828  * @return 0 on success; nonzero on error.  This function may return most error
2829  * codes that can be returned by wimlib_write() as well as the following error
2830  * codes:
2831  *
2832  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2833  *      @p wim was not part 1 of a stand-alone WIM.
2834  * @retval ::WIMLIB_ERR_INVALID_PARAM
2835  *      @p swm_name was not a nonempty string, or @p part_size was 0.
2836  *
2837  * Note: the WIM's uncompressed and compressed resources are not checksummed
2838  * when they are copied from the joined WIM to the split WIM parts, nor are
2839  * compressed resources re-compressed (unless explicitly requested with
2840  * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
2841  */
2842 extern int
2843 wimlib_split(WIMStruct *wim,
2844              const wimlib_tchar *swm_name,
2845              uint64_t part_size,
2846              int write_flags,
2847              wimlib_progress_func_t progress_func);
2848
2849 /**
2850  * Unmounts a WIM image that was mounted using wimlib_mount_image().
2851  *
2852  * The image to unmount is specified by the path to the mountpoint, not the
2853  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2854  * touched and also may have been allocated in a different process.
2855  *
2856  * To unmount the image, the thread calling this function communicates with the
2857  * thread that is managing the mounted WIM image.  This function blocks until it
2858  * is known whether the unmount succeeded or failed.  In the case of a
2859  * read-write mounted WIM, the unmount is not considered to have succeeded until
2860  * all changes have been saved to the underlying WIM file.
2861  *
2862  * @param dir
2863  *      The directory that the WIM image was mounted on.
2864  * @param unmount_flags
2865  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2866  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2867  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
2868  *      mounts.
2869  * @param progress_func
2870  *      If non-NULL, a function that will be called periodically with the
2871  *      progress of the current operation.  Currently, only
2872  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
2873  *
2874  * @return 0 on success; nonzero on error.
2875  *
2876  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2877  *      The filesystem daemon was unable to remove the staging directory and the
2878  *      temporary files that it contains.
2879  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2880  *      The filesystem daemon appears to have terminated before sending an exit
2881  *      status.
2882  * @retval ::WIMLIB_ERR_FORK
2883  *      Could not @c fork() the process.
2884  * @retval ::WIMLIB_ERR_FUSERMOUNT
2885  *      The @b fusermount program could not be executed or exited with a failure
2886  *      status.
2887  * @retval ::WIMLIB_ERR_MQUEUE
2888  *      Could not open a POSIX message queue to communicate with the filesystem
2889  *      daemon servicing the mounted filesystem, could not send a message
2890  *      through the queue, or could not receive a message through the queue.
2891  * @retval ::WIMLIB_ERR_NOMEM
2892  *      Failed to allocate needed memory.
2893  * @retval ::WIMLIB_ERR_OPEN
2894  *      The filesystem daemon could not open a temporary file for writing the
2895  *      new WIM.
2896  * @retval ::WIMLIB_ERR_READ
2897  *      A read error occurred when the filesystem daemon tried to a file from
2898  *      the staging directory
2899  * @retval ::WIMLIB_ERR_RENAME
2900  *      The filesystem daemon failed to rename the newly written WIM file to the
2901  *      original WIM file.
2902  * @retval ::WIMLIB_ERR_UNSUPPORTED
2903  *      Mounting is not supported, either because the platform is Windows, or
2904  *      because the platform is UNIX-like and wimlib was compiled with @c
2905  *      --without-fuse.
2906  * @retval ::WIMLIB_ERR_WRITE
2907  *      A write error occurred when the filesystem daemon was writing to the new
2908  *      WIM file, or the filesystem daemon was unable to flush changes that had
2909  *      been made to files in the staging directory.
2910  */
2911 extern int
2912 wimlib_unmount_image(const wimlib_tchar *dir,
2913                      int unmount_flags,
2914                      wimlib_progress_func_t progress_func);
2915
2916 /**
2917  * Update a WIM image by adding, deleting, and/or renaming files or directories.
2918  *
2919  * @param wim
2920  *      Pointer to the ::WIMStruct for the WIM file to update.
2921  * @param image
2922  *      The 1-based index of the image in the WIM to update.  It cannot be
2923  *      ::WIMLIB_ALL_IMAGES.
2924  * @param cmds
2925  *      An array of ::wimlib_update_command's that specify the update operations
2926  *      to perform.
2927  * @param num_cmds
2928  *      Number of commands in @p cmds.
2929  * @param update_flags
2930  *      ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2931  * @param progress_func
2932  *      If non-NULL, a function that will be called periodically with the
2933  *      progress of the current operation.
2934  *
2935  * @return 0 on success; nonzero on error.  On failure, some but not all of the
2936  * update commands may have been executed.  No individual update command will
2937  * have been partially executed.  Possible error codes include:
2938  *
2939  * @retval ::WIMLIB_ERR_DECOMPRESSION
2940  *      Failed to decompress the metadata resource from @p image in @p wim.
2941  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2942  *      The capture configuration structure specified for an add command was
2943  *      invalid.
2944  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2945  *      @p image did not specify a single, existing image in @p wim.
2946  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2947  *      Attempted to perform an add command that conflicted with previously
2948  *      existing files in the WIM when an overlay was attempted.
2949  * @retval ::WIMLIB_ERR_INVALID_PARAM
2950  *      An unknown operation type was specified in the update commands; or,
2951  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2952  *      in the @p add_flags, but the same image had previously already been
2953  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2954  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
2955  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2956  *      specified in the @p add_flags for an add command in which @p
2957  *      wim_target_path was not the root directory of the WIM image.
2958  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2959  *      (Windows only):  While executing an add command, tried to capture a
2960  *      reparse point with invalid data.
2961  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2962  *      The metadata resource for @p image in @p wim is invalid.
2963  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2964  *      The security data for image @p image in @p wim is invalid.
2965  * @retval ::WIMLIB_ERR_IS_DIRECTORY
2966  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2967  *      for a WIM path that corresponded to a directory; or, a rename command
2968  *      attempted to rename a directory to a non-directory.
2969  * @retval ::WIMLIB_ERR_NOMEM
2970  *      Failed to allocate needed memory.
2971  * @retval ::WIMLIB_ERR_NOTDIR
2972  *      A rename command attempted to rename a directory to a non-directory; or,
2973  *      an add command was executed that attempted to set the root of the WIM
2974  *      image as a non-directory; or, a path component used as a directory in a
2975  *      rename command was not, in fact, a directory.
2976  * @retval ::WIMLIB_ERR_NOTEMPTY
2977  *      A rename command attempted to rename a directory to a non-empty
2978  *      directory.
2979  * @retval ::WIMLIB_ERR_NTFS_3G
2980  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2981  *      error occurred while reading data from the NTFS volume using libntfs-3g.
2982  * @retval ::WIMLIB_ERR_OPEN
2983  *      Failed to open a file to be captured while executing an add command.
2984  * @retval ::WIMLIB_ERR_OPENDIR
2985  *      Failed to open a directory to be captured while executing an add command.
2986  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2987  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2988  *      WIM path that did not exist; or, a rename command attempted to rename a
2989  *      file that does not exist.
2990  * @retval ::WIMLIB_ERR_READ
2991  *      Failed to read the metadata resource for @p image in @p wim; or, while
2992  *      executing an add command, failed to read data from a file or directory
2993  *      to be captured.
2994  * @retval ::WIMLIB_ERR_READLINK
2995  *      While executing an add command, failed to read the target of a symbolic
2996  *      link or junction point.
2997  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2998  *      (Windows only) Failed to perform a reparse point fixup because of
2999  *      problems with the data of a reparse point.
3000  * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3001  *      While executing an add command, attempted to capture a file that was not
3002  *      a supported file type (e.g. a device file).  Only if
3003  *      ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3004  *      for an update command.
3005  * @retval ::WIMLIB_ERR_STAT
3006  *      While executing an add command, failed to get attributes for a file or
3007  *      directory.
3008  * @retval ::WIMLIB_ERR_UNSUPPORTED
3009  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3010  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
3011  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3012  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3013  *      add_flags for an update command.
3014  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3015  *      The WIM file is considered read-only because of any of the reasons
3016  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3017  *      flag.
3018  */
3019 extern int
3020 wimlib_update_image(WIMStruct *wim,
3021                     int image,
3022                     const struct wimlib_update_command *cmds,
3023                     size_t num_cmds,
3024                     int update_flags,
3025                     wimlib_progress_func_t progress_func);
3026
3027 /**
3028  * Writes a standalone WIM to a file.
3029  *
3030  * This brings in resources from any external locations, such as directory trees
3031  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3032  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3033  *
3034  * @param wim
3035  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
3036  *      changes made to it, which are then reflected in the output file.
3037  * @param path
3038  *      The path to the file to write the WIM to.
3039  * @param image
3040  *      The 1-based index of the image inside the WIM to write.  Use
3041  *      ::WIMLIB_ALL_IMAGES to include all images.
3042  * @param write_flags
3043  *      Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3044  * @param num_threads
3045  *      Number of threads to use for compressing data.  If 0, the number of
3046  *      threads is taken to be the number of online processors.  Note: if no
3047  *      data compression needs to be done, no additional threads will be created
3048  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
3049  *      exporting an image from a compressed WIM to another WIM of the same
3050  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3051  *      write_flags).
3052  * @param progress_func
3053  *      If non-NULL, a function that will be called periodically with the
3054  *      progress of the current operation.  The possible messages are
3055  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3056  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3057  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3058  *
3059  * @return 0 on success; nonzero on error.
3060  *
3061  * @retval ::WIMLIB_ERR_DECOMPRESSION
3062  *      Failed to decompress a metadata or file resource in @p wim.
3063  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3064  *      @p image does not specify a single existing image in @p wim, and is not
3065  *      ::WIMLIB_ALL_IMAGES.
3066  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3067  *      A file that had previously been scanned for inclusion in the WIM by
3068  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
3069  *      message digest check.
3070  * @retval ::WIMLIB_ERR_INVALID_PARAM
3071  *      @p path was @c NULL.
3072  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
3073  *      The metadata resource for @p image in @p wim is invalid.
3074  * @retval ::WIMLIB_ERR_NOMEM
3075  *      Failed to allocate needed memory.
3076  * @retval ::WIMLIB_ERR_OPEN
3077  *      Failed to open @p path for writing, or some file resources in @p wim
3078  *      refer to files in the outside filesystem, and one of these files could
3079  *      not be opened for reading.
3080  * @retval ::WIMLIB_ERR_READ
3081  *      An error occurred when trying to read data from the WIM file associated
3082  *      with @p wim, or some file resources in @p wim refer to files in the
3083  *      outside filesystem, and a read error occurred when reading one of these
3084  *      files.
3085  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
3086  *      @p wim is part of a split WIM, not a standalone WIM.
3087  * @retval ::WIMLIB_ERR_WRITE
3088  *      An error occurred when trying to write data to the new WIM file.
3089  */
3090 extern int
3091 wimlib_write(WIMStruct *wim,
3092              const wimlib_tchar *path,
3093              int image,
3094              int write_flags,
3095              unsigned num_threads,
3096              wimlib_progress_func_t progress_func);
3097
3098 /**
3099  * Since wimlib v1.5.0:  Same as wimlib_write(), but write the WIM directly to a
3100  * file descriptor, which need not be seekable if the write is done in a special
3101  * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3102  * write_flags.  This can, for example, allow capturing a WIM image and
3103  * streaming it over the network.  See the documentation for
3104  * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3105  *
3106  * The file descriptor @p fd will @b not be closed when the write is complete;
3107  * the calling code is responsible for this.
3108  *
3109  * Returns 0 on success; nonzero on failure.  The possible error codes include
3110  * those that can be returned by wimlib_write() as well as the following:
3111  *
3112  * @retval ::WIMLIB_ERR_INVALID_PARAM
3113  *      @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3114  *      specified in @p write_flags.
3115  */
3116 extern int
3117 wimlib_write_to_fd(WIMStruct *wim,
3118                    int fd,
3119                    int image,
3120                    int write_flags,
3121                    unsigned num_threads,
3122                    wimlib_progress_func_t progress_func);
3123
3124 /**
3125  * This function is equivalent to wimlib_lzx_compress(), but instead compresses
3126  * the data using "XPRESS" compression.
3127  */
3128 extern unsigned
3129 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3130
3131 /**
3132  * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
3133  * the data is compressed using "XPRESS" compression.
3134  */
3135 extern int
3136 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3137                          void *uncompressed_data, unsigned uncompressed_len);
3138
3139 #endif /* _WIMLIB_H */