Minor fixes
[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 /**
904  * @name Directory tree iteration flags
905  *
906  * The following flags can be passed to wimlib_iterate_dir_tree().
907  *
908  * @{
909  */
910
911 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
912  * just on the specified path. */
913 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
914
915 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
916  * itself; only its children (in the case of a non-empty directory) */
917 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN  0x00000002
918
919
920
921 /**
922  * @name Add flags
923  *
924  * The following flags can be passed to wimlib_add_image(),
925  * wimlib_add_image_multisource(), and add commands passed to
926  * wimlib_update_image().
927  *
928  * @{
929  */
930
931 /** Directly capture a NTFS volume rather than a generic directory.  This flag
932  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
933  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
934 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
935
936 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
937  * with ::WIMLIB_ADD_FLAG_NTFS. */
938 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
939
940 /** Call the progress function with the message
941  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
942  * be scanned, or when a directory or file is being excluded from capture.  */
943 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
944
945 /** Mark the image being added as the bootable image of the WIM. */
946 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
947
948 /** Store the UNIX owner, group, and mode.  This is done by adding a special
949  * alternate data stream to each regular file, symbolic link, and directory to
950  * contain this information.  Please note that this flag is for convenience
951  * only; Microsoft's @a imagex.exe will not understand this special information.
952  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
953 #define WIMLIB_ADD_FLAG_UNIX_DATA               0x00000010
954
955 /** Do not capture security descriptors.  Only has an effect in NTFS capture
956  * mode, or in Win32 native builds. */
957 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
958
959 /** Fail immediately if the full security descriptor of any file or directory
960  * cannot be accessed.  Only has an effect in Win32 native builds.  The default
961  * behavior without this flag is to first try omitting the SACL from the
962  * security descriptor, then to try omitting the security descriptor entirely.
963  * */
964 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
965
966 /** Call the progress function with the message
967  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
968  * capture.  This is a subset of the messages provided by
969  * ::WIMLIB_ADD_FLAG_VERBOSE. */
970 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
971
972 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
973  * in the case of Windows) that point inside the directory being captured to
974  * instead be absolute relative to the directory being captured, rather than the
975  * current root; also exclude absolute symbolic links that point outside the
976  * directory tree being captured.
977  *
978  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
979  * the WIM header or if this is the first image being added.
980  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
981  * reparse point fixups enabled and currently cannot be unset. */
982 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
983
984 /** Don't do reparse point fixups.  The default behavior is described in the
985  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
986 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
987
988 /** Do not automatically exclude unsupported files or directories from capture;
989  * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
990  * on UNIX-like systems.  Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
991  * such a file is encountered.  */
992 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE  0x00000400
993
994 /** Automatically select a capture configuration appropriate for capturing
995  * filesystems containing Windows operating systems.  When this flag is
996  * specified, the corresponding @p config parameter or member must be @c NULL.
997  *
998  * Currently, selecting this capture configuration will cause the following
999  * files and directories to be excluded from capture:
1000  *
1001  * - "\$ntfs.log"
1002  * - "\hiberfil.sys"
1003  * - "\pagefile.sys"
1004  * - "\System Volume Information"
1005  * - "\RECYCLER"
1006  * - "\Windows\CSC"
1007  *
1008  * Note that the default behavior--- that is, when this flag is not specified
1009  * and @p config is @c NULL--- is to use no capture configuration, meaning that
1010  * no files are excluded from capture.
1011  */
1012 #define WIMLIB_ADD_FLAG_WINCONFIG               0x00000800
1013
1014 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
1015 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
1016 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
1017 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
1018 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
1019 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
1020 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
1021 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1022 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
1023 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
1024 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1025                                                 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1026 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG         WIMLIB_ADD_FLAG_WINCONFIG
1027
1028 /**
1029  * @name Delete flags
1030  *
1031  * The following flags can be specified in delete commands passed to
1032  * wimlib_update_image().
1033  *
1034  * @{
1035  */
1036
1037 /** Do not issue an error if the path to delete does not exist. */
1038 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
1039
1040 /** Delete the file or directory tree recursively; if not specified, an error is
1041  * issued if the path to delete is a directory. */
1042 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
1043
1044 /**
1045  * @name Export flags
1046  *
1047  * The following flags can be passed to wimlib_export_image().
1048  *
1049  * @{
1050  */
1051
1052 /**
1053  * If a single image is being exported, mark it bootable in the destination WIM.
1054  * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1055  * the image in the source WIM (if any) that is marked as bootable is also
1056  * marked as bootable in the destination WIM.
1057  */
1058 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
1059
1060 /** Give the exported image(s) no names.  Avoids problems with image name
1061  * collisions.
1062  */
1063 #define WIMLIB_EXPORT_FLAG_NO_NAMES                     0x00000002
1064
1065 /** Give the exported image(s) no descriptions.  */
1066 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS              0x00000004
1067
1068 /**
1069  * @name Extract flags
1070  *
1071  * The following flags can be passed to wimlib_extract_image(),
1072  * wimlib_extract_files(), and wimlib_extract_image_from_pipe().
1073  *
1074  * @{
1075  */
1076
1077 /** Extract the image directly to a NTFS volume rather than a generic directory.
1078  * This mode is only available if wimlib was compiled with libntfs-3g support;
1079  * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned.  In this mode, the
1080  * extraction target will be interpreted as the path to a NTFS volume image (as
1081  * a regular file or block device) rather than a directory.  It will be opened
1082  * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1083  * root directory.  Note: this flag cannot be used when wimlib_extract_image()
1084  * is called with ::WIMLIB_ALL_IMAGES as the @p image.  */
1085 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
1086
1087 /** When identical files are extracted from the WIM, always hard link them
1088  * together.  */
1089 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
1090
1091 /** When identical files are extracted from the WIM, always symlink them
1092  * together.  */
1093 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
1094
1095 /** This flag no longer does anything but is reserved for future use.  */
1096 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
1097
1098 /** Read the WIM file sequentially while extracting the image.  */
1099 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
1100
1101 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.  Only
1102  * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1103  * specified.  */
1104 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
1105
1106 /** Do not extract security descriptors.  */
1107 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
1108
1109 /** Fail immediately if the full security descriptor of any file or directory
1110  * cannot be set exactly as specified in the WIM file.  On Windows, the default
1111  * behavior without this flag is to fall back to setting the security descriptor
1112  * with the SACL omitted, then only the default inherited security descriptor,
1113  * if we do not have permission to set the desired one.  */
1114 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
1115
1116 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX.  This forces
1117  * reparse-point fixups on, so absolute symbolic links or junction points will
1118  * be fixed to be absolute relative to the actual extraction root.  Reparse
1119  * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1120  * header.  This flag may only be specified when extracting a full image (not a
1121  * file or directory tree within one).  */
1122 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
1123
1124 /** Force reparse-point fixups on extraction off, regardless of the state of the
1125  * WIM_HDR_FLAG_RP_FIX flag in the WIM header.  */
1126 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
1127
1128 /** Extract the specified file to standard output.  This is only valid in an
1129  * extraction command that specifies the extraction of a regular file in the WIM
1130  * image.  */
1131 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
1132
1133 /** Instead of ignoring files and directories with names that cannot be
1134  * represented on the current platform (note: Windows has more restrictions on
1135  * filenames than POSIX-compliant systems), try to replace characters or append
1136  * junk to the names so that they can be extracted in some form.  */
1137 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
1138
1139 /** On Windows, when there exist two or more files with the same case
1140  * insensitive name but different case sensitive names, try to extract them all
1141  * by appending junk to the end of them, rather than arbitrarily extracting only
1142  * one.  */
1143 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
1144
1145 /** Do not ignore failure to set timestamps on extracted files.  */
1146 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS           0x00002000
1147
1148 /** Do not ignore failure to set short names on extracted files.  */
1149 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES          0x00004000
1150
1151 /** Do not ignore failure to extract symbolic links (and junction points, on
1152  * Windows) due to permissions problems.  By default, such failures are ignored
1153  * since the default configuration of Windows only allows the Administrator to
1154  * create symbolic links.  */
1155 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
1156
1157 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1158  * behavior is currently less than satisfactory.  Do not use (yet).  */
1159 #define WIMLIB_EXTRACT_FLAG_RESUME                      0x00010000
1160
1161 /**
1162  * @name Mount flags
1163  *
1164  * The following flags can be passed to wimlib_mount_image().
1165  *
1166  * @{
1167  */
1168
1169 /** Mount the WIM image read-write rather than the default of read-only. */
1170 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
1171
1172 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1173 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
1174
1175 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1176 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
1177
1178 /** Access alternate data streams in the mounted WIM image through extended file
1179  * attributes.  This is the default mode. */
1180 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
1181
1182 /** Access alternate data streams in the mounted WIM image by specifying the
1183  * file name, a colon, then the alternate file stream name. */
1184 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
1185
1186 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1187  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1188 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
1189
1190 /** Allow other users to see the mounted filesystem.  (this passes the @c
1191  * allow_other option to FUSE mount) */
1192 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
1193
1194 /**
1195  * @name Open flags
1196  *
1197  * The following flags can be passed to wimlib_open_wim() and several other
1198  * functions such as wimlib_join().
1199  * @{
1200  */
1201
1202 /** Verify the WIM contents against the WIM's integrity table, if present.  This
1203  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1204  * checksummed and checked against the SHA1 message digests specified in the
1205  * integrity table.  ::WIMLIB_ERR_INTEGRITY is returned if there are any
1206  * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1207  * integrity table is invalid).  */
1208 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
1209
1210 /** Do not issue an error if the WIM is part of a split WIM.  Programs must
1211  * specify this flag if they intend to open part of a split WIM, rather than
1212  * only supporting standalone WIMs.  */
1213 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
1214
1215 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1216  * is not.  A WIM is considered writable only if it is writable at the
1217  * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1218  * header, and is not part of a spanned set.  It is not required to provide this
1219  * flag before attempting to make changes to the WIM, but with this flag you get
1220  * an error sooner rather than later. */
1221 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
1222
1223 /**
1224  * @name Unmount flags
1225  *
1226  * The following flags can be passed to wimlib_unmount_image().
1227  * @{
1228  */
1229
1230 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
1231 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
1232
1233 /** Unless this flag is given, changes to a read-write mounted WIM are
1234  * discarded.  Ignored for read-only mounts.  */
1235 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
1236
1237 /** See ::WIMLIB_WRITE_FLAG_REBUILD.  */
1238 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
1239
1240 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1241 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
1242
1243 /** Do a "lazy" unmount (detach filesystem immediately, even if busy).  */
1244 #define WIMLIB_UNMOUNT_FLAG_LAZY                        0x00000010
1245
1246 /**
1247  * @name Update flags
1248  *
1249  * The following flags can be passed to wimlib_update_image().
1250  * @{
1251  */
1252
1253 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1254  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages.  */
1255 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
1256
1257 /**
1258  * @name Write flags
1259  *
1260  * The following flags can be passed to wimlib_write(), wimlib_overwrite(),
1261  * wimlib_write_to_fd(), and several other functions such as wimlib_join().
1262  * @{
1263  */
1264
1265 /** Include an integrity table in the WIM.
1266  *
1267  * For WIMs created with wimlib_open_wim(), the default behavior is to include
1268  * an integrity table if and only if one was present before.  For WIMs created
1269  * with wimlib_create_new_wim(), the default behavior is to not include an
1270  * integrity table.  */
1271 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
1272
1273 /** Do not include an integrity table in the new WIM file.  This is the default
1274  * behavior, unless the WIM already included an integrity table.  */
1275 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY            0x00000002
1276
1277 /** Write the WIM as "pipable".  After writing a WIM with this flag specified,
1278  * images from it can be applied directly from a pipe using
1279  * wimlib_extract_image_from_pipe().  See the documentation for the --pipable
1280  * flag of `wimlib-imagex capture' for more information.  Beware: WIMs written
1281  * with this flag will not be compatible with Microsoft's software.
1282  *
1283  * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1284  * WIM as pipable if and only if it was pipable before.  For WIMs created with
1285  * wimlib_create_new_wim(), the default behavior is to write the WIM as
1286  * non-pipable.  */
1287 #define WIMLIB_WRITE_FLAG_PIPABLE                       0x00000004
1288
1289 /** Do not write the WIM as "pipable".  This is the default behavior, unless the
1290  * WIM was pipable already.  */
1291 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE                   0x00000008
1292
1293 /** Recompress all resources, even if they could otherwise be copied from a
1294  * different WIM with the same compression type (in the case of
1295  * wimlib_export_image() being called previously).  This flag is also valid in
1296  * the @p wim_write_flags of wimlib_join(), in which case all resources included
1297  * in the joined WIM file will be recompressed.  */
1298 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000010
1299
1300 /** Call fsync() just before the WIM file is closed.  */
1301 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000020
1302
1303 /** wimlib_overwrite() only:  Re-build the entire WIM file rather than appending
1304  * data to it if possible.  */
1305 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000040
1306
1307 /** wimlib_overwrite() only:  Specifying this flag overrides the default
1308  * behavior of wimlib_overwrite() after one or more calls to
1309  * wimlib_delete_image(), which is to rebuild the entire WIM.  With this flag,
1310  * only minimal changes to correctly remove the image from the WIM will be
1311  * taken.  In particular, all streams will be left alone, even if they are no
1312  * longer referenced.  This is probably not what you want, because almost no
1313  * space will be saved by deleting an image in this way.  */
1314 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000080
1315
1316 /** wimlib_overwrite() only:  Allow overwriting the WIM even if the readonly
1317  * flag is set in the WIM header.  This can be used in combination with
1318  * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1319  * set the readonly flag on the on-disk WIM file.  */
1320 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000100
1321
1322 /** Do not include non-metadata resources already present in other WIMs.  This
1323  * flag can be used to write a "delta" WIM after resources from the WIM on which
1324  * the delta is to be based were referenced with
1325  * wimlib_reference_resource_files() or wimlib_reference_resources().  */
1326 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS            0x00000200
1327
1328 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1329  * are already present (not in external resource WIMs) and their reference
1330  * counts are correct, so the code does not need to recalculate which streams
1331  * are referenced.  This is for optimization purposes only, since with this flag
1332  * specified, the metadata resources may not need to be decompressed and parsed.
1333  *
1334  * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1335  * already implied for wimlib_overwrite().  */
1336 #define WIMLIB_WRITE_FLAG_STREAMS_OK                    0x00000400
1337
1338 /**
1339  * @name Init flags
1340  *
1341  * The following flags can be passed to wimlib_global_init().
1342  * @{
1343  */
1344
1345 /** Assume that strings are represented in UTF-8, even if this is not the
1346  * locale's character encoding.  This flag is ignored on Windows, where wimlib
1347  * always uses UTF-16LE.  */
1348 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
1349
1350 /** Windows-only: do not attempt to acquire additional privileges (currently
1351  * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1352  * SeTakeOwnershipPrivilege) when initializing the library.  This is intended
1353  * for the case where the calling program manages these privileges itself.
1354  * Note: no error is issued if privileges cannot be acquired, although related
1355  * errors may be reported later, depending on if the operations performed
1356  * actually require additional privileges or not.  */
1357 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES        0x00000002
1358
1359 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1360  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1361  * to read all possible data and metadata for a capture operation could not be
1362  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1363  */
1364 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES      0x00000004
1365
1366 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1367  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1368  * to restore all possible data and metadata for an apply operation could not be
1369  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1370  */
1371 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES        0x00000008
1372
1373 /**
1374  * @name Resource reference flags
1375  *
1376  * The following flags can be passed to wimlib_reference_resource_files() and
1377  * wimlib_reference_resources().
1378  * @{
1379  */
1380
1381 /** wimlib_reference_resource_files() only:  Enable shell-style filename
1382  * globbing.  */
1383 #define WIMLIB_REF_FLAG_GLOB_ENABLE             0x00000001
1384
1385 /** wimlib_reference_resource_files() only:  Issue an error
1386  * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files.  The
1387  * default behavior without this flag is to issue no error at that point, but
1388  * then attempt to open the glob as a literal path, which of course will fail
1389  * anyway if no file exists at that path.  No effect if
1390  * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified.  */
1391 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH     0x00000002
1392
1393 /**
1394  * @}
1395  */
1396
1397 /** Specification of an update to perform on a WIM image. */
1398 struct wimlib_update_command {
1399
1400         /** The specific type of update to perform. */
1401         enum wimlib_update_op {
1402                 /** Add a new file or directory tree to the WIM image in a
1403                  * certain location. */
1404                 WIMLIB_UPDATE_OP_ADD = 0,
1405
1406                 /** Delete a file or directory tree from the WIM image. */
1407                 WIMLIB_UPDATE_OP_DELETE,
1408
1409                 /** Rename a file or directory tree in the WIM image. */
1410                 WIMLIB_UPDATE_OP_RENAME,
1411         } op;
1412         union {
1413                 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1414                 struct wimlib_add_command {
1415                         /** Filesystem path to the file or directory tree to
1416                          * add. */
1417                         wimlib_tchar *fs_source_path;
1418                         /** Path, specified from the root of the WIM image, at
1419                          * which to add the file or directory tree within the
1420                          * WIM image. */
1421                         wimlib_tchar *wim_target_path;
1422
1423                         /** Configuration for excluded files.  @c NULL means
1424                          * exclude no files (use no configuration), unless
1425                          * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1426                          * add_flags.  */
1427                         struct wimlib_capture_config *config;
1428
1429                         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1430                         int add_flags;
1431                 } add;
1432                 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1433                 struct wimlib_delete_command {
1434                         /** Path, specified from the root of the WIM image, for
1435                          * the file or directory tree within the WIM image to be
1436                          * deleted. */
1437                         wimlib_tchar *wim_path;
1438                         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1439                         int delete_flags;
1440                 } delete;
1441                 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1442                 struct wimlib_rename_command {
1443                         /** Path, specified from the root of the WIM image, for
1444                          * the source file or directory tree within the WIM
1445                          * image. */
1446                         wimlib_tchar *wim_source_path;
1447                         /** Path, specified from the root of the WIM image, for
1448                          * the destination file or directory tree within the WIM
1449                          * image. */
1450                         wimlib_tchar *wim_target_path;
1451                         /** Reserved; set to 0. */
1452                         int rename_flags;
1453                 } rename;
1454         };
1455 };
1456
1457 /** Specification of a file or directory tree to extract from a WIM image. */
1458 struct wimlib_extract_command {
1459         /** Path to file or directory tree within the WIM image to extract.  It
1460          * must be provided as an absolute path from the root of the WIM image.
1461          * The path separators may be either forward slashes or backslashes. */
1462         wimlib_tchar *wim_source_path;
1463
1464         /** Filesystem path to extract the file or directory tree to. */
1465         wimlib_tchar *fs_dest_path;
1466
1467         /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1468         int extract_flags;
1469 };
1470
1471 /**
1472  * Possible values of the error code returned by many functions in wimlib.
1473  *
1474  * See the documentation for each wimlib function to see specifically what error
1475  * codes can be returned by a given function, and what they mean.
1476  */
1477 enum wimlib_error_code {
1478         WIMLIB_ERR_SUCCESS = 0,
1479         WIMLIB_ERR_ALREADY_LOCKED,
1480         WIMLIB_ERR_DECOMPRESSION,
1481         WIMLIB_ERR_DELETE_STAGING_DIR,
1482         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1483         WIMLIB_ERR_FORK,
1484         WIMLIB_ERR_FUSE,
1485         WIMLIB_ERR_FUSERMOUNT,
1486         WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1487         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1488         WIMLIB_ERR_IMAGE_COUNT,
1489         WIMLIB_ERR_IMAGE_NAME_COLLISION,
1490         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1491         WIMLIB_ERR_INTEGRITY,
1492         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1493         WIMLIB_ERR_INVALID_CHUNK_SIZE,
1494         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1495         WIMLIB_ERR_INVALID_HEADER,
1496         WIMLIB_ERR_INVALID_IMAGE,
1497         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1498         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1499         WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1500         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1501         WIMLIB_ERR_INVALID_OVERLAY,
1502         WIMLIB_ERR_INVALID_PARAM,
1503         WIMLIB_ERR_INVALID_PART_NUMBER,
1504         WIMLIB_ERR_INVALID_PIPABLE_WIM,
1505         WIMLIB_ERR_INVALID_REPARSE_DATA,
1506         WIMLIB_ERR_INVALID_RESOURCE_HASH,
1507         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1508         WIMLIB_ERR_INVALID_UTF16_STRING,
1509         WIMLIB_ERR_INVALID_UTF8_STRING,
1510         WIMLIB_ERR_IS_DIRECTORY,
1511         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1512         WIMLIB_ERR_LINK,
1513         WIMLIB_ERR_METADATA_NOT_FOUND,
1514         WIMLIB_ERR_MKDIR,
1515         WIMLIB_ERR_MQUEUE,
1516         WIMLIB_ERR_NOMEM,
1517         WIMLIB_ERR_NOTDIR,
1518         WIMLIB_ERR_NOTEMPTY,
1519         WIMLIB_ERR_NOT_A_REGULAR_FILE,
1520         WIMLIB_ERR_NOT_A_WIM_FILE,
1521         WIMLIB_ERR_NOT_PIPABLE,
1522         WIMLIB_ERR_NO_FILENAME,
1523         WIMLIB_ERR_NTFS_3G,
1524         WIMLIB_ERR_OPEN,
1525         WIMLIB_ERR_OPENDIR,
1526         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1527         WIMLIB_ERR_READ,
1528         WIMLIB_ERR_READLINK,
1529         WIMLIB_ERR_RENAME,
1530         WIMLIB_ERR_REOPEN,
1531         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1532         WIMLIB_ERR_RESOURCE_NOT_FOUND,
1533         WIMLIB_ERR_RESOURCE_ORDER,
1534         WIMLIB_ERR_SET_ATTRIBUTES,
1535         WIMLIB_ERR_SET_REPARSE_DATA,
1536         WIMLIB_ERR_SET_SECURITY,
1537         WIMLIB_ERR_SET_SHORT_NAME,
1538         WIMLIB_ERR_SET_TIMESTAMPS,
1539         WIMLIB_ERR_SPLIT_INVALID,
1540         WIMLIB_ERR_SPLIT_UNSUPPORTED,
1541         WIMLIB_ERR_STAT,
1542         WIMLIB_ERR_TIMEOUT,
1543         WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1544         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1545         WIMLIB_ERR_UNKNOWN_VERSION,
1546         WIMLIB_ERR_UNSUPPORTED,
1547         WIMLIB_ERR_UNSUPPORTED_FILE,
1548         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1549         WIMLIB_ERR_WIM_IS_READONLY,
1550         WIMLIB_ERR_WRITE,
1551         WIMLIB_ERR_XML,
1552 };
1553
1554
1555 /** Used to indicate no WIM image or an invalid WIM image. */
1556 #define WIMLIB_NO_IMAGE         0
1557
1558 /** Used to specify all images in the WIM. */
1559 #define WIMLIB_ALL_IMAGES       (-1)
1560
1561 /**
1562  * Appends an empty image to a WIM file.  This empty image will initially
1563  * contain no files or directories, although if written without further
1564  * modifications, a root directory will be created automatically for it.  After
1565  * calling this function, you can use wimlib_update_image() to add files to the
1566  * new WIM image.  This gives you slightly more control over making the new
1567  * image compared to calling wimlib_add_image() or
1568  * wimlib_add_image_multisource() directly.
1569  *
1570  * @param wim
1571  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
1572  *      added.
1573  * @param name
1574  *      Name to give the new image.  If @c NULL or empty, the new image is given
1575  *      no name.  If nonempty, it must specify a name that does not already
1576  *      exist in @p wim.
1577  * @param new_idx_ret
1578  *      If non-<code>NULL</code>, the index of the newly added image is returned
1579  *      in this location.
1580  *
1581  * @return 0 on success; nonzero on failure.  The possible error codes are:
1582  *
1583  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1584  *      There is already an image in @p wim named @p name.
1585  * @retval ::WIMLIB_ERR_NOMEM
1586  *      Failed to allocate the memory needed to add the new image.
1587  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1588  *      The WIM file is considered read-only because of any of the reasons
1589  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1590  *      flag.
1591  */
1592 extern int
1593 wimlib_add_empty_image(WIMStruct *wim,
1594                        const wimlib_tchar *name,
1595                        int *new_idx_ret);
1596
1597 /**
1598  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1599  *
1600  * The directory tree or NTFS volume is scanned immediately to load the dentry
1601  * tree into memory, and file attributes and symbolic links are read.  However,
1602  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1603  * called.
1604  *
1605  * See the manual page for the @b wimlib-imagex program for more information
1606  * about the "normal" capture mode versus the NTFS capture mode (entered by
1607  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1608  *
1609  * Note that @b no changes are committed to the underlying WIM file (if
1610  * any) until wimlib_write() or wimlib_overwrite() is called.
1611  *
1612  * @param wim
1613  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
1614  *      added.
1615  * @param source
1616  *      A path to a directory or unmounted NTFS volume that will be captured as
1617  *      a WIM image.
1618  * @param name
1619  *      Name to give the new image.  If @c NULL or empty, the new image is given
1620  *      no name.  If nonempty, it must specify a name that does not already
1621  *      exist in @p wim.
1622  * @param config
1623  *      Capture configuration that specifies files, directories, or path globs
1624  *      to exclude from being captured.  If @c NULL, a dummy configuration where
1625  *      no paths are treated specially is used.
1626  * @param add_flags
1627  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1628  * @param progress_func
1629  *      If non-NULL, a function that will be called periodically with the
1630  *      progress of the current operation.  The progress messages that will be
1631  *      received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1632  *      ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1633  *      included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1634  *
1635  * @return 0 on success; nonzero on error.  On error, changes to @p wim are
1636  * discarded so that it appears to be in the same state as when this function
1637  * was called.
1638  *
1639  * This function is implemented by calling wimlib_add_empty_image(), then
1640  * calling wimlib_update_image() with a single "add" command, so any error code
1641  * returned by wimlib_add_empty_image() may be returned, as well as any error
1642  * codes returned by wimlib_update_image() other than ones documented as only
1643  * being returned specifically by an update involving delete or rename commands.
1644  */
1645 extern int
1646 wimlib_add_image(WIMStruct *wim,
1647                  const wimlib_tchar *source,
1648                  const wimlib_tchar *name,
1649                  const struct wimlib_capture_config *config,
1650                  int add_flags,
1651                  wimlib_progress_func_t progress_func);
1652
1653 /** This function is equivalent to wimlib_add_image() except it allows for
1654  * multiple sources to be combined into a single WIM image.  This is done by
1655  * specifying the @p sources and @p num_sources parameters instead of the @p
1656  * source parameter of wimlib_add_image().  The rest of the parameters are the
1657  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
1658  * capture</b> for full details on how this mode works.
1659  *
1660  * In addition to the error codes that wimlib_add_image() can return,
1661  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1662  * when trying to overlay a non-directory on a directory or when otherwise
1663  * trying to overlay multiple conflicting files to the same location in the WIM
1664  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
1665  * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1666  * was not exactly one capture source with the target being the root directory.
1667  * (In this respect, there is no advantage to using
1668  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1669  * NTFS mode.) */
1670 extern int
1671 wimlib_add_image_multisource(WIMStruct *wim,
1672                              const struct wimlib_capture_source *sources,
1673                              size_t num_sources,
1674                              const wimlib_tchar *name,
1675                              const struct wimlib_capture_config *config,
1676                              int add_flags,
1677                              wimlib_progress_func_t progress_func);
1678
1679 /**
1680  * Creates a ::WIMStruct for a new WIM file.
1681  *
1682  * This only creates an in-memory structure for a WIM that initially contains no
1683  * images.  No on-disk file is created until wimlib_write() is called.
1684  *
1685  * @param ctype
1686  *      The type of compression to be used in the new WIM file.  Must be
1687  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1688  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1689  * @param wim_ret
1690  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1691  *      written to the memory location pointed to by this paramater.  The
1692  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1693  *      it.
1694  * @return 0 on success; nonzero on error.
1695  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1696  *      @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1697  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1698  * @retval ::WIMLIB_ERR_NOMEM
1699  *      Failed to allocate needed memory.
1700  */
1701 extern int
1702 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1703
1704 /**
1705  * Deletes an image, or all images, from a WIM file.
1706  *
1707  * All streams referenced by the image(s) being deleted are removed from the
1708  * lookup table of the WIM if they are not referenced by any other images in the
1709  * WIM.
1710  *
1711  * Please note that @b no changes are committed to the underlying WIM file (if
1712  * any) until wimlib_write() or wimlib_overwrite() is called.
1713  *
1714  * @param wim
1715  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1716  *      being deleted.
1717  * @param image
1718  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1719  *      images.
1720  * @return 0 on success; nonzero on failure.  On failure, @p wim is guaranteed
1721  * to be left unmodified only if @p image specified a single image.  If instead
1722  * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
1723  * possible for some but not all of the images to have been deleted when a
1724  * failure status is returned.
1725  *
1726  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1727  *      @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1728  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1729  *      The WIM file is considered read-only because of any of the reasons
1730  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1731  *      flag.
1732  *
1733  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1734  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
1735  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
1736  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
1737  * different reasons) to read the metadata resource for an image that needed to
1738  * be deleted.
1739  */
1740 extern int
1741 wimlib_delete_image(WIMStruct *wim, int image);
1742
1743 /**
1744  * Exports an image, or all the images, from a WIM file, into another WIM file.
1745  *
1746  * The destination image is made to share the same dentry tree and security data
1747  * structure as the source image.  This places some restrictions on additional
1748  * functions that may be called.  wimlib_mount_image() may not be called on
1749  * either the source image or the destination image without an intervening call
1750  * to a function that un-shares the images, such as wimlib_free() on @p
1751  * dest_wim, or wimlib_delete_image() on either the source or destination image.
1752  * Furthermore, you may not call wimlib_free() on @p src_wim before calling
1753  * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
1754  * have references back to @p src_wim.
1755  *
1756  * If this function fails, all changes to @p dest_wim are rolled back.
1757  *
1758  * Please note that no changes are committed to the underlying WIM file of @p
1759  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1760  *
1761  * @param src_wim
1762  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1763  *      WIM that contains the image(s) being exported.
1764  * @param src_image
1765  *      The image to export from @p src_wim, as either a 1-based image index to
1766  *      export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
1767  * @param dest_wim
1768  *      Pointer to the ::WIMStruct for a WIM that will receive the images being
1769  *      exported.
1770  * @param dest_name
1771  *      For single-image exports, the name to give the exported image in @p
1772  *      dest_wim.  If left @c NULL, the name from @p src_wim is used.  For
1773  *      ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
1774  *      that case, the names are all taken from @p src_wim.  This parameter is
1775  *      overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
1776  * @param dest_description
1777  *      For single-image exports, the description to give the exported image in
1778  *      the new WIM file.  If left @c NULL, the description from @p src_wim is
1779  *      used.  For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
1780  *      NULL; in that case, the description are all taken from @p src_wim.  This
1781  *      parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
1782  * @param export_flags
1783  *      Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
1784  * @param progress_func
1785  *      Currently ignored, but reserved for a function that will be called with
1786  *      information about the operation.  Use NULL if no additional information
1787  *      is desired.
1788  *
1789  * @return 0 on success; nonzero on error.
1790  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1791  *      One or more of the names being given to an exported image was already in
1792  *      use in the destination WIM.
1793  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1794  *      @p src_image does not exist in @p src_wim and was not
1795  *      ::WIMLIB_ALL_IMAGES.
1796  * @retval ::WIMLIB_ERR_INVALID_PARAM
1797  *      @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
1798  *      ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
1799  *      @c NULL.
1800  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
1801  *      Either @p src_wim or @p dest_wim did not contain metadata resources; for
1802  *      example, one of them was a non-first part of a split WIM.
1803  * @retval ::WIMLIB_ERR_NOMEM
1804  *      Failed to allocate needed memory.
1805  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1806  *      A resource that needed to be exported could not be found in either the
1807  *      source or destination WIMs.  This error can occur if, for example, @p
1808  *      src_wim is part of a split WIM but needed resources from the other split
1809  *      WIM parts were not referenced with wimlib_reference_resources() or
1810  *      wimlib_reference_resource_files() before the call to
1811  *      wimlib_export_image().
1812  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1813  *      @p dest_wim is considered read-only because of any of the reasons
1814  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1815  *      flag.
1816  *
1817  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1818  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
1819  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
1820  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
1821  * different reasons) to read the metadata resource for an image in @p src_wim
1822  * that needed to be exported.
1823  */
1824 extern int
1825 wimlib_export_image(WIMStruct *src_wim, int src_image,
1826                     WIMStruct *dest_wim,
1827                     const wimlib_tchar *dest_name,
1828                     const wimlib_tchar *dest_description,
1829                     int export_flags,
1830                     wimlib_progress_func_t progress_func);
1831
1832 /**
1833  * Extract zero or more files or directory trees from a WIM image.
1834  *
1835  * This generalizes the single-image extraction functionality of
1836  * wimlib_extract_image() to allow extracting only the specified subsets of the
1837  * image.
1838  *
1839  * @param wim
1840  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1841  *      split WIM.
1842  *
1843  * @param image
1844  *      The 1-based number of the image in @p wim from which the files or
1845  *      directory trees are to be extracted.  It cannot be ::WIMLIB_ALL_IMAGES.
1846  *
1847  * @param cmds
1848  *      An array of ::wimlib_extract_command structures that specifies the
1849  *      extractions to perform.
1850  *
1851  * @param num_cmds
1852  *      Number of commands in the @p cmds array.
1853  *
1854  * @param default_extract_flags
1855  *      Default extraction flags; the behavior shall be as if these flags had
1856  *      been specified in the ::wimlib_extract_command.extract_flags member in
1857  *      each extraction command, in combination with any flags already present.
1858  *
1859  * @param progress_func
1860  *      If non-NULL, a function that will be called periodically with the
1861  *      progress of the current operation.
1862  *
1863  * @return 0 on success; nonzero on error.  The possible error codes include
1864  * most of those documented as returned by wimlib_extract_image() as well as the
1865  * following additional error codes:
1866  *
1867  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1868  *      @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
1869  *      the WIM file).
1870  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1871  *      The ::wimlib_extract_command.wim_source_path member in one of the
1872  *      extract commands did not exist in the WIM.
1873  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1874  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1875  *      in which ::wimlib_extract_command.wim_source_path existed but was not a
1876  *      regular file or directory.
1877  * @retval ::WIMLIB_ERR_INVALID_PARAM
1878  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1879  *      specified for some commands but not all; or
1880  *      ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1881  *      for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1882  *      for a command in which ::wimlib_extract_command.wim_source_path did not
1883  *      specify the root directory of the WIM image.
1884  */
1885 extern int
1886 wimlib_extract_files(WIMStruct *wim,
1887                      int image,
1888                      const struct wimlib_extract_command *cmds,
1889                      size_t num_cmds,
1890                      int default_extract_flags,
1891                      wimlib_progress_func_t progress_func);
1892
1893 /**
1894  * Extracts an image, or all images, from a standalone or split WIM file to a
1895  * directory or directly to a NTFS volume image.
1896  *
1897  * The exact behavior of how wimlib extracts files from a WIM image is
1898  * controllable by the @p extract_flags parameter, but there also are
1899  * differences depending on the platform (UNIX-like vs Windows).  See the manual
1900  * page for <b>wimlib-imagex apply</b> for more information, including about the
1901  * special "NTFS volume extraction mode" entered by providing
1902  * ::WIMLIB_EXTRACT_FLAG_NTFS.
1903  *
1904  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1905  * returned if any resulting SHA1 message digests do not match the values
1906  * provided in the WIM file.  Therefore, if this function is successful, you can
1907  * be fairly sure that any compressed data in the WIM was uncompressed
1908  * correctly.
1909  *
1910  * @param wim
1911  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1912  *      split WIM.
1913  * @param image
1914  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1915  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1916  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
1917  * @param target
1918  *      Directory to extract the WIM image(s) to (created if it does not already
1919  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
1920  *      path to the unmounted NTFS volume to extract the image to.
1921  * @param extract_flags
1922  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1923  * @param progress_func
1924  *      If non-NULL, a function that will be called periodically with the
1925  *      progress of the current operation.
1926  *
1927  * @return 0 on success; nonzero on error.
1928  * @retval ::WIMLIB_ERR_DECOMPRESSION
1929  *      Failed to decompress a resource to be extracted.
1930  * @retval ::WIMLIB_ERR_INVALID_PARAM
1931  *      Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
1932  *      were specified in @p extract_flags; or both
1933  *      ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
1934  *      specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
1935  *      ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
1936  *      ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
1937  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
1938  *      @p image was ::WIMLIB_ALL_IMAGES.
1939  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1940  *      The SHA1 message digest of an extracted stream did not match the SHA1
1941  *      message digest given in the WIM file.
1942  * @retval ::WIMLIB_ERR_LINK
1943  *      Failed to create a symbolic link or a hard link.
1944  * @retval ::WIMLIB_ERR_MKDIR
1945  *      Failed create a directory.
1946  * @retval ::WIMLIB_ERR_NOMEM
1947  *      Failed to allocate needed memory.
1948  * @retval ::WIMLIB_ERR_OPEN
1949  *      Could not create a file, or failed to open an already-extracted file.
1950  * @retval ::WIMLIB_ERR_READ
1951  *      Failed to read data from the WIM file associated with @p wim.
1952  * @retval ::WIMLIB_ERR_READLINK
1953  *      Failed to determine the target of a symbolic link in the WIM.
1954  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
1955  *      Failed to fix the target of an absolute symbolic link (e.g. if the
1956  *      target would have exceeded the maximum allowed length).  (Only if
1957  *      reparse data was supported by the extraction mode and
1958  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
1959  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1960  *      One of the files or directories that needed to be extracted referenced a
1961  *      stream not present in the WIM's lookup table (or in any of the lookup
1962  *      tables of the split WIM parts).
1963  * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
1964  *      Failed to set attributes on a file.
1965  * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
1966  *      Failed to set reparse data on a file (only if reparse data was supported
1967  *      by the extraction mode).
1968  * @retval ::WIMLIB_ERR_SET_SECURITY
1969  *      Failed to set security descriptor on a file
1970  *      (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
1971  *      extract_flags).
1972  * @retval ::WIMLIB_ERR_SET_SHORT_NAME
1973  *      Failed to set the short name of a file (only if
1974  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
1975  * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
1976  *      Failed to set timestamps on a file (only if
1977  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
1978  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
1979  *      Unexpected end-of-file occurred when reading data from the WIM file
1980  *      associated with @p wim.
1981  * @retval ::WIMLIB_ERR_UNSUPPORTED
1982  *      A requested extraction flag, or the data or metadata that must be
1983  *      extracted to support it, is unsupported in the build and configuration
1984  *      of wimlib, or on the current platform or extraction mode or target
1985  *      volume.  Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
1986  *      ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
1987  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
1988  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
1989  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
1990  *      and ::WIMLIB_EXTRACT_FLAG_HARDLINK.  For example, if
1991  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
1992  *      extract_flags,
1993  *      ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
1994  *      or more files with short names, but extracting short names is not
1995  *      supported --- on Windows, this occurs if the target volume does not
1996  *      support short names, while on non-Windows, this occurs if
1997  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
1998  * @retval ::WIMLIB_ERR_WRITE
1999  *      Failed to write data to a file being extracted.
2000  *
2001  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2002  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2003  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2004  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2005  * different reasons) to read the metadata resource for an image that needed to
2006  * be extracted.
2007  */
2008 extern int
2009 wimlib_extract_image(WIMStruct *wim, int image,
2010                      const wimlib_tchar *target,
2011                      int extract_flags,
2012                      wimlib_progress_func_t progress_func);
2013
2014 /**
2015  * Since wimlib v1.5.0:  Extract one or more images from a pipe on which a
2016  * pipable WIM is being sent.
2017  *
2018  * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2019  * about pipable WIMs.
2020  *
2021  * This function operates in a special way to read the WIM fully sequentially.
2022  * As a result, there is no ::WIMStruct is made visible to library users, and
2023  * you cannot call wimlib_open_wim() on the pipe.  (You can, however, use
2024  * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2025  * seekable file, not a pipe.)
2026  *
2027  * @param pipe_fd
2028  *      File descriptor, which may be a pipe, opened for reading and positioned
2029  *      at the start of the pipable WIM.
2030  * @param image_num_or_name
2031  *      String that specifies the 1-based index or name of the image to extract.
2032  *      It is translated to an image index using the same rules that
2033  *      wimlib_resolve_image() uses.  However, unlike wimlib_extract_image(),
2034  *      only a single image (not all images) can be specified.  Alternatively,
2035  *      specify @p NULL here to use the first image in the WIM if it contains
2036  *      exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2037  * @param target
2038  *      Same as the corresponding parameter to wimlib_extract_image().
2039  * @param extract_flags
2040  *      Same as the corresponding parameter to wimlib_extract_image(), except
2041  *      for the following exceptions:  ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
2042  *      always implied, since data is always read from @p pipe_fd sequentially
2043  *      in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
2044  *      result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2045  * @param progress_func
2046  *      Same as the corresponding parameter to wimlib_extract_image(), except
2047  *      ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2048  *      received.
2049  *
2050  * @return 0 on success; nonzero on error.  The possible error codes include
2051  * those returned by wimlib_extract_image() as well as the following:
2052  *
2053  * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2054  *      Data read from the pipable WIM was invalid.
2055  * @retval ::WIMLIB_ERR_NOT_PIPABLE
2056  *      The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2057  */
2058 extern int
2059 wimlib_extract_image_from_pipe(int pipe_fd,
2060                                const wimlib_tchar *image_num_or_name,
2061                                const wimlib_tchar *target, int extract_flags,
2062                                wimlib_progress_func_t progress_func);
2063
2064 /**
2065  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
2066  * includes a string of XML that describes the images contained in the WIM.
2067  * This function works on standalone WIMs as well as split WIM parts.
2068  *
2069  * @param wim
2070  *      Pointer to the ::WIMStruct for a WIM file.
2071  * @param fp
2072  *      @c stdout, or a FILE* opened for writing, to extract the data to.
2073  *
2074  * @return 0 on success; nonzero on error.
2075  * @retval ::WIMLIB_ERR_INVALID_PARAM
2076  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2077  * @retval ::WIMLIB_ERR_NOMEM
2078  * @retval ::WIMLIB_ERR_READ
2079  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2080  *      Failed to read the XML data from the WIM.
2081  * @retval ::WIMLIB_ERR_WRITE
2082  *      Failed to completely write the XML data to @p fp.
2083  */
2084 extern int
2085 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2086
2087 /**
2088  * Frees all memory allocated for a WIMStruct and closes all files associated
2089  * with it.
2090  *
2091  * @param wim
2092  *      Pointer to the ::WIMStruct for a WIM file.
2093  *
2094  * @return This function has no return value.
2095  */
2096 extern void
2097 wimlib_free(WIMStruct *wim);
2098
2099 /**
2100  * Converts a ::wimlib_compression_type value into a string.
2101  *
2102  * @param ctype
2103  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2104  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2105  *
2106  * @return
2107  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2108  *      respectively.
2109  */
2110 extern const wimlib_tchar *
2111 wimlib_get_compression_type_string(int ctype);
2112
2113 /**
2114  * Converts an error code into a string describing it.
2115  *
2116  * @param code
2117  *      The error code returned by one of wimlib's functions.
2118  *
2119  * @return
2120  *      Pointer to a statically allocated string describing the error code,
2121  *      or @c NULL if the error code is not valid.
2122  */
2123 extern const wimlib_tchar *
2124 wimlib_get_error_string(enum wimlib_error_code code);
2125
2126 /**
2127  * Returns the description of the specified image.
2128  *
2129  * @param wim
2130  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2131  *      standalone WIM or a split WIM part.
2132  * @param image
2133  *      The number of the image, numbered starting at 1.
2134  *
2135  * @return
2136  *      The description of the image, or @c NULL if there is no such image, or
2137  *      @c NULL if the specified image has no description.  The description
2138  *      string is in library-internal memory and may not be modified or freed;
2139  *      in addition, the string will become invalid if the description of the
2140  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2141  */
2142 extern const wimlib_tchar *
2143 wimlib_get_image_description(const WIMStruct *wim, int image);
2144
2145 /**
2146  * Returns the name of the specified image.
2147  *
2148  * @param wim
2149  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2150  *      standalone WIM or a split WIM part.
2151  * @param image
2152  *      The number of the image, numbered starting at 1.
2153  *
2154  * @return
2155  *      The name of the image, or @c NULL if there is no such image, or an empty
2156  *      string if the image is unnamed.  The name string is in
2157  *      library-internal memory and may not be modified or freed; in addition,
2158  *      the string will become invalid if the name of the image is changed, the
2159  *      image is deleted, or the ::WIMStruct is destroyed.
2160  */
2161 extern const wimlib_tchar *
2162 wimlib_get_image_name(const WIMStruct *wim, int image);
2163
2164
2165 /**
2166  * Get basic information about a WIM file.
2167  *
2168  * @param wim
2169  *      Pointer to the ::WIMStruct for a WIM file.  It may be for either a
2170  *      standalone WIM or part of a split WIM.
2171  * @param info
2172  *      A ::wimlib_wim_info structure that will be filled in with information
2173  *      about the WIM file.
2174  * @return
2175  *      0
2176  */
2177 extern int
2178 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2179
2180 /**
2181  * Initialization function for wimlib.  Call before using any other wimlib
2182  * function except wimlib_set_print_errors().  (However, currently this is not
2183  * strictly necessary and it will be called automatically if not done manually,
2184  * but you should not rely on this behavior.)
2185  *
2186  * @param init_flags
2187  *      Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2188  *
2189  * @return 0 on success; nonzero on failure.  Currently, only the following
2190  * error code is defined:
2191  *
2192  * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2193  *      ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2194  *      ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2195  *      init_flags, but the corresponding privileges could not be acquired.
2196  */
2197 extern int
2198 wimlib_global_init(int init_flags);
2199
2200 /**
2201  * Cleanup function for wimlib.  You are not required to call this function, but
2202  * it will release any global resources allocated by the library.
2203  */
2204 extern void
2205 wimlib_global_cleanup(void);
2206
2207 /**
2208  * Determines if an image name is already used by some image in the WIM.
2209  *
2210  * @param wim
2211  *      Pointer to the ::WIMStruct for a WIM file.
2212  * @param name
2213  *      The name to check.
2214  *
2215  * @return
2216  *      @c true if there is already an image in @p wim named @p name; @c false
2217  *      if there is no image named @p name in @p wim.  If @p name is @c NULL or
2218  *      the empty string, @c false is returned.
2219  */
2220 extern bool
2221 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2222
2223 /**
2224  * Iterate through a file or directory tree in the WIM image.  By specifying
2225  * appropriate flags and a callback function, you can get the attributes of a
2226  * file in the WIM, get a directory listing, or even get a listing of the entire
2227  * WIM image.
2228  *
2229  * @param wim
2230  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
2231  *      split WIM.
2232  *
2233  * @param image
2234  *      The 1-based number of the image in @p wim that contains the files or
2235  *      directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2236  *      iteration on all images in the WIM.
2237  *
2238  * @param path
2239  *      Path in the WIM image at which to do the iteration.
2240  *
2241  * @param flags
2242  *      Bitwise OR of ::WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE and/or
2243  *      ::WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN.
2244  *
2245  * @param cb
2246  *      A callback function that will receive each directory entry.
2247  *
2248  * @param user_ctx
2249  *      An extra parameter that will always be passed to the callback function
2250  *      @p cb.
2251  *
2252  * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2253  * first nonzero value that was returned from @p cb.  However, additional error
2254  * codes may be returned, including the following:
2255  *
2256  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2257  *      @p path did not exist in the WIM image.
2258  * @retval ::WIMLIB_ERR_NOMEM
2259  *      Failed to allocate memory needed to create a ::wimlib_dir_entry.
2260  *
2261  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2262  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2263  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2264  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2265  * different reasons) to read the metadata resource for an image over which
2266  * iteration needed to be done.
2267  */
2268 extern int
2269 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2270                         int flags,
2271                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2272
2273 /**
2274  * Iterate through the lookup table of a WIM file.  This can be used to directly
2275  * get a listing of the unique resources contained in a WIM file.  Both file
2276  * resources and metadata resources are included.
2277  *
2278  * @param wim
2279  *      Pointer to the ::WIMStruct of a standalone WIM file or a split WIM part.
2280  *      Note: metadata resources will only be included if the WIM is standalone
2281  *      or the first part of the split WIM.
2282  *
2283  * @param flags
2284  *      Reserved; set to 0.
2285  *
2286  * @param cb
2287  *      A callback function that will receive each resource.
2288  *
2289  * @param user_ctx
2290  *      An extra parameter that will always be passed to the callback function
2291  *      @p cb.
2292  *
2293  * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2294  * that was returned from @p cb.
2295  */
2296 extern int
2297 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2298                             wimlib_iterate_lookup_table_callback_t cb,
2299                             void *user_ctx);
2300
2301 /**
2302  * Joins a split WIM into a stand-alone one-part WIM.
2303  *
2304  * @param swms
2305  *      An array of strings that gives the filenames of all parts of the split
2306  *      WIM.  No specific order is required, but all parts must be included with
2307  *      no duplicates.
2308  * @param num_swms
2309  *      Number of filenames in @p swms.
2310  * @param swm_open_flags
2311  *      Open flags for the split WIM parts (e.g.
2312  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).  Note: ::WIMLIB_OPEN_FLAG_SPLIT_OK
2313  *      is automatically added to the value specified here.
2314  * @param wim_write_flags
2315  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2316  *      be used to write the joined WIM.
2317  * @param output_path
2318  *      The path to write the joined WIM file to.
2319  * @param progress_func
2320  *      If non-NULL, a function that will be called periodically with the
2321  *      progress of the current operation.
2322  *
2323  * @return 0 on success; nonzero on error.  This function may return most error
2324  * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2325  * as the following error code:
2326  *
2327  * @retval ::WIMLIB_ERR_SPLIT_INVALID
2328  *      The split WIMs do not form a valid WIM because they do not include all
2329  *      the parts of the original WIM, there are duplicate parts, or not all the
2330  *      parts have the same GUID and compression type.
2331  *
2332  * Note: wimlib_export_image() can provide similar functionality to
2333  * wimlib_join(), since it is possible to export all images from a split WIM
2334  * into a new ::WIMStruct, then write it.  However, wimlib_join() may have
2335  * better performance than this method.
2336  */
2337 extern int
2338 wimlib_join(const wimlib_tchar * const *swms,
2339             unsigned num_swms,
2340             const wimlib_tchar *output_path,
2341             int swm_open_flags,
2342             int wim_write_flags,
2343             wimlib_progress_func_t progress_func);
2344
2345 /**
2346  * Compress a chunk of a WIM resource using LZX compression.
2347  *
2348  * This function is exported for convenience only and should only be used by
2349  * library clients looking to make use of wimlib's compression code for another
2350  * purpose.
2351  *
2352  * @param chunk
2353  *      Uncompressed data of the chunk.
2354  * @param chunk_size
2355  *      Size of the uncompressed chunk, in bytes.
2356  * @param out
2357  *      Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2358  *
2359  * @return
2360  *      The size of the compressed data written to @p out in bytes, or 0 if the
2361  *      data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2362  *
2363  * As a special requirement, the compression code is optimized for the WIM
2364  * format and therefore requires (@p chunk_size <= 32768).
2365  */
2366 extern unsigned
2367 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
2368
2369 /**
2370  * Decompresses a block of LZX-compressed data as used in the WIM file format.
2371  *
2372  * Note that this will NOT work unmodified for LZX as used in the cabinet
2373  * format, which is not the same as in the WIM format!
2374  *
2375  * This function is exported for convenience only and should only be used by
2376  * library clients looking to make use of wimlib's compression code for another
2377  * purpose.
2378  *
2379  * @param compressed_data
2380  *      Pointer to the compressed data.
2381  *
2382  * @param compressed_len
2383  *      Length of the compressed data, in bytes.
2384  *
2385  * @param uncompressed_data
2386  *      Pointer to the buffer into which to write the uncompressed data.
2387  *
2388  * @param uncompressed_len
2389  *      Length of the uncompressed data.  It must be 32768 bytes or less.
2390  *
2391  * @return
2392  *      0 on success; non-zero on failure.
2393  */
2394 extern int
2395 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2396                       void *uncompressed_data, unsigned uncompressed_len);
2397
2398
2399 /**
2400  * Mounts an image in a WIM file on a directory read-only or read-write.
2401  *
2402  * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2403  * supported if wimlib was configured with @c --without-fuse.  This includes
2404  * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2405  * cases.
2406  *
2407  * Calling this function daemonizes the process, unless
2408  * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs.  If the
2409  * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2410  * to the WIM are staged in a temporary directory.
2411  *
2412  * It is safe to mount multiple images from the same underlying WIM file
2413  * read-only at the same time, but only if different ::WIMStruct's are used.  It
2414  * is @b not safe to mount multiple images from the same WIM file read-write at
2415  * the same time.
2416  *
2417  * wimlib_mount_image() cannot be used on an image that was exported with
2418  * wimlib_export_image() while the dentry trees for both images are still in
2419  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
2420  * that already has modifications pending (e.g. an image added with
2421  * wimlib_add_image()).
2422  *
2423  * @param wim
2424  *      Pointer to the ::WIMStruct containing the image to be mounted.
2425  * @param image
2426  *      The number of the image to mount, indexed starting from it.  It must be
2427  *      an existing, single image.
2428  * @param dir
2429  *      The path to an existing empty directory to mount the image on.
2430  * @param mount_flags
2431  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2432  * @param staging_dir
2433  *      If non-NULL, the name of a directory in which the staging directory will
2434  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2435  *      in @p mount_flags.  If left @c NULL, the staging directory is created in
2436  *      the same directory as the WIM file that @p wim was originally read from.
2437  *
2438  * @return 0 on success; nonzero on error.
2439  *
2440  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2441  *      A read-write mount was requested, but an an exclusive advisory lock on
2442  *      the on-disk WIM file could not be acquired because another thread or
2443  *      process has mounted an image from the WIM read-write or is currently
2444  *      modifying the WIM in-place.
2445  * @retval ::WIMLIB_ERR_FUSE
2446  *      A non-zero status was returned by @c fuse_main().
2447  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2448  *      @p image does not specify an existing, single image in @p wim.
2449  * @retval ::WIMLIB_ERR_INVALID_PARAM
2450  *      @p image is shared among multiple ::WIMStruct's as a result of a call to
2451  *      wimlib_export_image(), or @p image has been added with
2452  *      wimlib_add_image().
2453  * @retval ::WIMLIB_ERR_MKDIR
2454  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2455  *      staging directory could not be created.
2456  * @retval ::WIMLIB_ERR_NOTDIR
2457  *      Could not determine the current working directory.
2458  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2459  *      One of the dentries in the image referenced a stream not present in the
2460  *      WIM's lookup table (or in any of the lookup tables of the split WIM
2461  *      parts).
2462  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2463  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2464  *      wim is considered read-only because of any of the reasons mentioned in
2465  *      the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2466  * @retval ::WIMLIB_ERR_UNSUPPORTED
2467  *      Mounting is not supported, either because the platform is Windows, or
2468  *      because the platform is UNIX-like and wimlib was compiled with @c
2469  *      --without-fuse.
2470  *
2471  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2472  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2473  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2474  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2475  * different reasons) to read the metadata resource for the image to mount.
2476  */
2477 extern int
2478 wimlib_mount_image(WIMStruct *wim,
2479                    int image,
2480                    const wimlib_tchar *dir,
2481                    int mount_flags,
2482                    const wimlib_tchar *staging_dir);
2483
2484 /**
2485  * Opens a WIM file and creates a ::WIMStruct for it.
2486  *
2487  * @param wim_file
2488  *      The path to the WIM file to open.
2489  *
2490  * @param open_flags
2491  *      Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2492  *
2493  * @param progress_func
2494  *      If non-NULL, a function that will be called periodically with the
2495  *      progress of the current operation.  Currently, the only messages sent
2496  *      will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2497  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2498  *
2499  * @param wim_ret
2500  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2501  *      is written to the memory location pointed to by this parameter.  The
2502  *      ::WIMStruct can be freed using using wimlib_free() when finished with
2503  *      it.
2504  *
2505  * @return 0 on success; nonzero on error.
2506  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2507  *      The WIM is not the non-first part of a split WIM, and the number of
2508  *      metadata resources found in the WIM did not match the image count given
2509  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
2510  *      data for the WIM did not match the image count given in the WIM header.
2511  * @retval ::WIMLIB_ERR_INTEGRITY
2512  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2513  *      wim_file contains an integrity table, but the SHA1 message digest for a
2514  *      chunk of the WIM does not match the corresponding message digest given
2515  *      in the integrity table.
2516  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2517  *      Resources in @p wim_file are compressed, but the chunk size is not 32768.
2518  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2519  *      The header of @p wim_file says that resources in the WIM are compressed,
2520  *      but the header flag indicating LZX or XPRESS compression is not set.
2521  * @retval ::WIMLIB_ERR_INVALID_HEADER
2522  *      The header of @p wim_file was otherwise invalid.
2523  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2524  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2525  *      wim_file contains an integrity table, but the integrity table is
2526  *      invalid.
2527  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2528  *      The lookup table for the WIM contained duplicate entries that are not
2529  *      for metadata resources, or it contained an entry with a SHA1 message
2530  *      digest of all 0's.
2531  * @retval ::WIMLIB_ERR_INVALID_PARAM
2532  *      @p wim_ret was @c NULL.
2533  * @retval ::WIMLIB_ERR_NOMEM
2534  *      Failed to allocated needed memory.
2535  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2536  *      @p wim_file does not begin with the expected magic characters.
2537  * @retval ::WIMLIB_ERR_OPEN
2538  *      Failed to open the file @p wim_file for reading.
2539  * @retval ::WIMLIB_ERR_READ
2540  *      Failed to read data from @p wim_file.
2541  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2542  *      @p wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2543  *      specified in @p open_flags.
2544  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2545  *      Unexpected end-of-file while reading data from @p wim_file.
2546  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2547  *      A number other than 0x10d00 is written in the version field of the WIM
2548  *      header of @p wim_file.  (May be a pre-Vista WIM.)
2549  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2550  *      ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2551  *      considered read-only because of any of the reasons mentioned in the
2552  *      documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2553  * @retval ::WIMLIB_ERR_XML
2554  *      The XML data for @p wim_file is invalid.
2555  */
2556 extern int
2557 wimlib_open_wim(const wimlib_tchar *wim_file,
2558                 int open_flags,
2559                 WIMStruct **wim_ret,
2560                 wimlib_progress_func_t progress_func);
2561
2562 /**
2563  * Overwrites the file that the WIM was originally read from, with changes made.
2564  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2565  * rather than wimlib_create_new_wim().
2566  *
2567  * There are two ways that a WIM may be overwritten.  The first is to do a full
2568  * rebuild.  In this mode, the new WIM is written to a temporary file and then
2569  * renamed to the original file after it is has been completely written.  The
2570  * temporary file is made in the same directory as the original WIM file.  A
2571  * full rebuild may take a while, but can be used even if images have been
2572  * modified or deleted, will produce a WIM with no holes, and has little chance
2573  * of unintentional data loss because the temporary WIM is fsync()ed before
2574  * being renamed to the original WIM.
2575  *
2576  * The second way to overwrite a WIM is by appending to the end of it and
2577  * overwriting the header.  This can be much faster than a full rebuild, but the
2578  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
2579  * begins with writing any new file resources *after* everything in the old WIM,
2580  * even though this will leave a hole where the old lookup table, XML data, and
2581  * integrity were.  This is done so that the WIM remains valid even if the
2582  * operation is aborted mid-write.  The WIM header is only overwritten at the
2583  * very last moment, and up until that point the WIM will be seen as the old
2584  * version.
2585  *
2586  * By default, wimlib_overwrite() does the append-style overwrite described
2587  * above, unless resources in the WIM are arranged in an unusual way or if
2588  * images have been deleted from the WIM.  Use the flag
2589  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2590  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2591  * images have been deleted from the WIM.
2592  *
2593  * In the temporary-file overwrite mode, no changes are made to the WIM on
2594  * failure, and the temporary file is deleted if possible.  Abnormal termination
2595  * of the program will result in the temporary file being orphaned.  In the
2596  * direct append mode, the WIM is truncated to the original length on failure;
2597  * and while abnormal termination of the program will result in extra data
2598  * appended to the original WIM, it should still be a valid WIM.
2599  *
2600  * If this function completes successfully, no more functions should be called
2601  * on @p wim other than wimlib_free().  You must use wimlib_open_wim() to read
2602  * the WIM file anew.
2603  *
2604  * @param wim
2605  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
2606  *      been in-memory changes made to it, which are then reflected in the
2607  *      output file.
2608  * @param write_flags
2609  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
2610  * @param num_threads
2611  *      Number of threads to use for compression (see wimlib_write()).
2612  * @param progress_func
2613  *      If non-NULL, a function that will be called periodically with the
2614  *      progress of the current operation.
2615  *
2616  * @return 0 on success; nonzero on error.  This function may return most error
2617  * codes returned by wimlib_write() as well as the following error codes:
2618  *
2619  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2620  *      The WIM was going to be modified in-place (with no temporary file), but
2621  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
2622  *      because another thread or process has mounted an image from the WIM
2623  *      read-write or is currently modifying the WIM in-place.
2624  * @retval ::WIMLIB_ERR_NO_FILENAME
2625  *      @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
2626  *      than a WIM read with wimlib_open_wim().
2627  * @retval ::WIMLIB_ERR_RENAME
2628  *      The temporary file that the WIM was written to could not be renamed to
2629  *      the original filename of @p wim.
2630  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2631  *      The WIM file is considered read-only because of any of the reasons
2632  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2633  *      flag.
2634  */
2635 extern int
2636 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2637                  wimlib_progress_func_t progress_func);
2638
2639 /**
2640  * Prints information about one image, or all images, contained in a WIM.
2641  *
2642  * @param wim
2643  *      Pointer to the ::WIMStruct for a WIM file.
2644  * @param image
2645  *      The image about which to print information.  Can be the number of an
2646  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2647  *      WIM.
2648  *
2649  * @return This function has no return value.  No error checking is done when
2650  * printing the information.  If @p image is invalid, an error message is
2651  * printed.
2652  */
2653 extern void
2654 wimlib_print_available_images(const WIMStruct *wim, int image);
2655
2656 /**
2657  * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2658  * in a way that can be accessed programatically.
2659  */
2660 extern void
2661 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
2662
2663 /**
2664  * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2665  * information in a way that can be accessed programatically.
2666  */
2667 extern int
2668 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
2669
2670 /**
2671  * Reference resources from other WIM files or split WIM parts.  This function
2672  * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
2673  * to load needed resources (that is, "streams" keyed by SHA1 message digest)
2674  * from other files, before calling a function such as wimlib_extract_image()
2675  * that requires the resources to be present.
2676  *
2677  * @param wim
2678  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
2679  *      necessarily "standalone".  In the case of split WIMs, this should be the
2680  *      first part, since only the first part contains the metadata resources.
2681  *      In the case of delta WIMs, this should be the delta WIM rather than the
2682  *      WIM on which it is based.
2683  * @param resource_wimfiles_or_globs
2684  *      Array of paths to WIM files and/or split WIM parts to reference.
2685  *      Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
2686  *      ref_flags, these are treated as globs rather than literal paths.  That
2687  *      is, using this function you can specify zero or more globs, each of
2688  *      which expands to one or more literal paths.
2689  * @param count
2690  *      Number of entries in @p resource_wimfiles_or_globs.
2691  * @param ref_flags
2692  *      Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
2693  *      ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
2694  * @param open_flags
2695  *      Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
2696  *      pass to internal calls to wimlib_open_wim() on the reference files.
2697  *      Note: ::WIMLIB_OPEN_FLAG_SPLIT_OK will be supplied regardless of this
2698  *      parameter.
2699  * @param progress_func
2700  *      Passed to internal calls to wimlib_open_wim() on the reference files.
2701  *
2702  * @return 0 on success; nonzero on error.
2703  *
2704  * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
2705  *      One of the specified globs did not match any paths (only with both
2706  *      ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
2707  *      specified in @p ref_flags).
2708  * @retval ::WIMLIB_ERR_NOMEM
2709  *      Failed to allocate memory.
2710  * @retval ::WIMLIB_ERR_READ
2711  *      I/O or permissions error while processing a file glob.
2712  *
2713  * This function can additionally return most values that can be returned by
2714  * wimlib_open_wim().
2715  */
2716 extern int
2717 wimlib_reference_resource_files(WIMStruct *wim,
2718                                 const wimlib_tchar * const *resource_wimfiles_or_globs,
2719                                 unsigned count,
2720                                 int ref_flags,
2721                                 int open_flags,
2722                                 wimlib_progress_func_t progress_func);
2723
2724 /**
2725  * Similar to wimlib_reference_resource_files(), but operates at a lower level
2726  * where the caller must open the ::WIMStruct for each referenced file itself.
2727  *
2728  * @param wim
2729  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
2730  *      necessarily "standalone".  In the case of split WIMs, this should be the
2731  *      first part, since only the first part contains the metadata resources.
2732  * @param resource_wims
2733  *      Array of pointers to the ::WIMStruct's for additional resource WIMs or
2734  *      split WIM parts to reference.
2735  * @param num_resource_wims
2736  *      Number of entries in @p resource_wims.
2737  * @param ref_flags
2738  *      Currently ignored (set to 0).
2739  *
2740  * @return 0 on success; nonzero on error.  On success, the ::WIMStruct's of the
2741  * @p resource_wims are referenced internally by @p wim and must not be freed
2742  * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
2743  * been freed with wimlib_free(), or immediately before freeing @p wim with
2744  * wimlib_free().
2745  *
2746  * @retval ::WIMLIB_ERR_INVALID_PARAM
2747  *      @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
2748  *      resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
2749  * @retval ::WIMLIB_ERR_NOMEM
2750  *      Failed to allocate memory.
2751  */
2752 extern int
2753 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
2754                            unsigned num_resource_wims, int ref_flags);
2755
2756 /**
2757  * Declares that a newly added image is mostly the same as a prior image, but
2758  * captured at a later point in time, possibly with some modifications in the
2759  * intervening time.  This is designed to be used in incremental backups of the
2760  * same filesystem or directory tree.
2761  *
2762  * This function compares the metadata of the directory tree of the newly added
2763  * image against that of the old image.  Any files that are present in both the
2764  * newly added image and the old image and have timestamps that indicate they
2765  * haven't been modified are deemed not to have been modified and have their
2766  * SHA1 message digest copied from the old image.  Because of this and because
2767  * WIM uses single-instance streams, such files need not be read from the
2768  * filesystem when the WIM is being written or overwritten.  Note that these
2769  * unchanged files will still be "archived" and will be logically present in the
2770  * new image; the optimization is that they don't need to actually be read from
2771  * the filesystem because the WIM already contains them.
2772  *
2773  * This function is provided to optimize incremental backups.  The resulting WIM
2774  * file will still be the same regardless of whether this function is called.
2775  * (This is, however, assuming that timestamps have not been manipulated or
2776  * unmaintained as to trick this function into thinking a file has not been
2777  * modified when really it has.  To partly guard against such cases, other
2778  * metadata such as file sizes will be checked as well.)
2779  *
2780  * This function must be called after adding the new image (e.g. with
2781  * wimlib_add_image()), but before writing the updated WIM file (e.g. with
2782  * wimlib_overwrite()).
2783  *
2784  * @param wim
2785  *      Pointer to the ::WIMStruct for a WIM.
2786  * @param new_image
2787  *      1-based index in the WIM of the newly added image.  This image can have
2788  *      been added with wimlib_add_image() or wimlib_add_image_multisource(), or
2789  *      wimlib_add_empty_image() followed by wimlib_update_image().
2790  * @param template_wim
2791  *      The ::WIMStruct for the WIM containing the template image.  This can be
2792  *      the same as @p wim, or it can be a different ::WIMStruct.
2793  * @param template_image
2794  *      1-based index in the WIM of a template image that reflects a prior state
2795  *      of the directory tree being captured.
2796  * @param flags
2797  *      Reserved; must be 0.
2798  * @param progress_func
2799  *      Currently ignored, but reserved for a function that will be called with
2800  *      information about the operation.  Use NULL if no additional information
2801  *      is desired.
2802  *
2803  * @return 0 on success; nonzero on error.
2804  *
2805  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2806  *      @p new_image and/or @p template_image were not a valid image indices in
2807  *      the WIM.
2808  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2809  *      The specified ::WIMStruct did not actually contain the metadata resource
2810  *      for the new or template image; for example, it was a non-first part of a
2811  *      split WIM.
2812  * @retval ::WIMLIB_ERR_NOMEM
2813  *      Failed to allocate needed memory.
2814  * @retval ::WIMLIB_ERR_INVALID_PARAM
2815  *      @p new_image was equal to @p template_image, or @p new_image specified
2816  *      an image that had not been modified since opening the WIM.
2817  *
2818  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2819  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2820  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2821  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2822  * different reasons) to read the metadata resource for the template image.
2823  */
2824 extern int
2825 wimlib_reference_template_image(WIMStruct *wim, int new_image,
2826                                 WIMStruct *template_wim, int template_image,
2827                                 int flags, wimlib_progress_func_t progress_func);
2828
2829 /**
2830  * Translates a string specifying the name or number of an image in the WIM into
2831  * the number of the image.  The images are numbered starting at 1.
2832  *
2833  * @param wim
2834  *      Pointer to the ::WIMStruct for a WIM file.
2835  * @param image_name_or_num
2836  *      A string specifying the name or number of an image in the WIM.  If it
2837  *      parses to a positive integer, this integer is taken to specify the
2838  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
2839  *      be the name of an image, as given in the XML data for the WIM file.  It
2840  *      also may be the keyword "all" or the string "*", both of which will
2841  *      resolve to ::WIMLIB_ALL_IMAGES.
2842  *      <br/> <br/>
2843  *      There is no way to search for an image actually named "all", "*", or an
2844  *      integer number, or an image that has no name.  However, you can use
2845  *      wimlib_get_image_name() to get the name of any image.
2846  *
2847  * @return
2848  *      If the string resolved to a single existing image, the number of that
2849  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
2850  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
2851  *      ::WIMLIB_NO_IMAGE is returned.  If @p image_name_or_num was @c NULL or
2852  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2853  *      images in @p wim has no name.
2854  */
2855 extern int
2856 wimlib_resolve_image(WIMStruct *wim,
2857                      const wimlib_tchar *image_name_or_num);
2858
2859 /**
2860  * Changes the description of an image in the WIM.
2861  *
2862  * @param wim
2863  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2864  *      standalone WIM or part of a split WIM; however, you should set the same
2865  *      description on all parts of a split WIM.
2866  * @param image
2867  *      The number of the image for which to change the description.
2868  * @param description
2869  *      The new description to give the image.  It may be @c NULL, which
2870  *      indicates that the image is to be given no description.
2871  *
2872  * @return 0 on success; nonzero on error.
2873  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2874  *      @p image does not specify a single existing image in @p wim.
2875  * @retval ::WIMLIB_ERR_NOMEM
2876  *      Failed to allocate the memory needed to duplicate the @p description
2877  *      string.
2878  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2879  *      @p wim is considered read-only because of any of the reasons mentioned
2880  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2881  */
2882 extern int
2883 wimlib_set_image_descripton(WIMStruct *wim, int image,
2884                             const wimlib_tchar *description);
2885
2886 /**
2887  * Set basic information about a WIM.
2888  *
2889  * @param wim
2890  *      A WIMStruct for a standalone WIM file.
2891  * @param info
2892  *      A struct ::wimlib_wim_info that contains the information to set.  Only
2893  *      the information explicitly specified in the @p which flags need be
2894  *      valid.
2895  * @param which
2896  *      Flags that specify which information to set.  This is a bitwise OR of
2897  *      ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
2898  *      ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
2899  *
2900  * @return 0 on success; nonzero on failure.
2901  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2902  *      The WIM file is considered read-only because of any of the reasons
2903  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2904  *      flag.  However, as a special case, if you are using
2905  *      ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
2906  *      function will not fail due to the readonly flag being previously set.
2907  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2908  *      ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
2909  *      ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
2910  *      index in the WIM.
2911  */
2912 extern int
2913 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
2914                     int which);
2915
2916 /**
2917  * Changes what is written in the \<FLAGS\> element in the WIM XML data
2918  * (something like "Core" or "Ultimate")
2919  *
2920  * @param wim
2921  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2922  *      standalone WIM or part of a split WIM; however, you should set the same
2923  *      \<FLAGS\> element on all parts of a split WIM.
2924  * @param image
2925  *      The number of the image for which to change the description.
2926  * @param flags
2927  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
2928  *      indicates that the image is to be given no \<FLAGS\> element.
2929  *
2930  * @return 0 on success; nonzero on error.
2931  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2932  *      @p image does not specify a single existing image in @p wim.
2933  * @retval ::WIMLIB_ERR_NOMEM
2934  *      Failed to allocate the memory needed to duplicate the @p flags string.
2935  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2936  *      @p wim is considered read-only because of any of the reasons mentioned
2937  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2938  */
2939 extern int
2940 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
2941
2942 /**
2943  * Changes the name of an image in the WIM.
2944  *
2945  * @param wim
2946  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2947  *      standalone WIM or part of a split WIM; however, you should set the same
2948  *      name on all parts of a split WIM.
2949  * @param image
2950  *      The number of the image for which to change the name.
2951  * @param name
2952  *      New name to give the new image.  If @c NULL or empty, the new image is
2953  *      given no name.  If nonempty, it must specify a name that does not
2954  *      already exist in @p wim.
2955  *
2956  * @return 0 on success; nonzero on error.
2957  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2958  *      There is already an image named @p name in @p wim.
2959  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2960  *      @p image does not specify a single existing image in @p wim.
2961  * @retval ::WIMLIB_ERR_NOMEM
2962  *      Failed to allocate the memory needed to duplicate the @p name string.
2963  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2964  *      @p wim is considered read-only because of any of the reasons mentioned
2965  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2966  */
2967 extern int
2968 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
2969
2970 /**
2971  * Set the functions that wimlib uses to allocate and free memory.
2972  *
2973  * These settings are global and not per-WIM.
2974  *
2975  * The default is to use the default @c malloc() and @c free() from the C
2976  * library.
2977  *
2978  * Please note that some external functions, such as those in @c libntfs-3g, may
2979  * use the standard memory allocation functions.
2980  *
2981  * @param malloc_func
2982  *      A function equivalent to @c malloc() that wimlib will use to allocate
2983  *      memory.  If @c NULL, the allocator function is set back to the default
2984  *      @c malloc() from the C library.
2985  * @param free_func
2986  *      A function equivalent to @c free() that wimlib will use to free memory.
2987  *      If @c NULL, the free function is set back to the default @c free() from
2988  *      the C library.
2989  * @param realloc_func
2990  *      A function equivalent to @c realloc() that wimlib will use to reallocate
2991  *      memory.  If @c NULL, the free function is set back to the default @c
2992  *      realloc() from the C library.
2993  * @return 0 on success; nonzero on error.
2994  * @retval ::WIMLIB_ERR_UNSUPPORTED
2995  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
2996  *      so custom memory allocators are unsupported.
2997  */
2998 extern int
2999 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3000                             void (*free_func)(void *),
3001                             void *(*realloc_func)(void *, size_t));
3002
3003 /**
3004  * Sets whether wimlib is to print error messages to @c stderr when a function
3005  * fails.  These error messages may provide information that cannot be
3006  * determined only from the error code that is returned.  Not every error will
3007  * result in an error message being printed.
3008  *
3009  * This setting is global and not per-WIM.
3010  *
3011  * By default, error messages are not printed.
3012  *
3013  * This can be called before wimlib_global_init().
3014  *
3015  * @param show_messages
3016  *      @c true if error messages are to be printed; @c false if error messages
3017  *      are not to be printed.
3018  *
3019  * @return 0 on success; nonzero on error.
3020  * @retval ::WIMLIB_ERR_UNSUPPORTED
3021  *      @p show_messages was @c true, but wimlib was compiled with the @c
3022  *      --without-error-messages option.   Therefore, error messages cannot be
3023  *      shown.
3024  */
3025 extern int
3026 wimlib_set_print_errors(bool show_messages);
3027
3028 /**
3029  * Splits a WIM into multiple parts.
3030  *
3031  * @param wim
3032  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
3033  *      WIM.
3034  * @param swm_name
3035  *      Name of the SWM file to create.  This will be the name of the first
3036  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
3037  *      appended before the suffix.
3038  * @param part_size
3039  *      The maximum size per part, in bytes.  Unfortunately, it is not
3040  *      guaranteed that this will really be the maximum size per part, because
3041  *      some file resources in the WIM may be larger than this size, and the WIM
3042  *      file format provides no way to split up file resources among multiple
3043  *      WIMs.
3044  * @param write_flags
3045  *      Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG.  These
3046  *      flags will be used to write each split WIM part.  Specify 0 here to get
3047  *      the default behavior.
3048  * @param progress_func
3049  *      If non-NULL, a function that will be called periodically with the
3050  *      progress of the current operation
3051  *      (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3052  *      ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3053  *
3054  * @return 0 on success; nonzero on error.  This function may return most error
3055  * codes that can be returned by wimlib_write() as well as the following error
3056  * codes:
3057  *
3058  * @retval ::WIMLIB_ERR_INVALID_PARAM
3059  *      @p swm_name was not a nonempty string, or @p part_size was 0.
3060  *
3061  * Note: the WIM's uncompressed and compressed resources are not checksummed
3062  * when they are copied from the joined WIM to the split WIM parts, nor are
3063  * compressed resources re-compressed (unless explicitly requested with
3064  * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3065  */
3066 extern int
3067 wimlib_split(WIMStruct *wim,
3068              const wimlib_tchar *swm_name,
3069              uint64_t part_size,
3070              int write_flags,
3071              wimlib_progress_func_t progress_func);
3072
3073 /**
3074  * Unmounts a WIM image that was mounted using wimlib_mount_image().
3075  *
3076  * The image to unmount is specified by the path to the mountpoint, not the
3077  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3078  * touched and also may have been allocated in a different process.
3079  *
3080  * To unmount the image, the thread calling this function communicates with the
3081  * thread that is managing the mounted WIM image.  This function blocks until it
3082  * is known whether the unmount succeeded or failed.  In the case of a
3083  * read-write mounted WIM, the unmount is not considered to have succeeded until
3084  * all changes have been saved to the underlying WIM file.
3085  *
3086  * @param dir
3087  *      The directory that the WIM image was mounted on.
3088  * @param unmount_flags
3089  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3090  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3091  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
3092  *      mounts.
3093  * @param progress_func
3094  *      If non-NULL, a function that will be called periodically with the
3095  *      progress of the current operation.  Currently, only
3096  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3097  *
3098  * @return 0 on success; nonzero on error.
3099  *
3100  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3101  *      The filesystem daemon was unable to remove the staging directory and the
3102  *      temporary files that it contains.
3103  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3104  *      The filesystem daemon appears to have terminated before sending an exit
3105  *      status.
3106  * @retval ::WIMLIB_ERR_FORK
3107  *      Could not @c fork() the process.
3108  * @retval ::WIMLIB_ERR_FUSERMOUNT
3109  *      The @b fusermount program could not be executed or exited with a failure
3110  *      status.
3111  * @retval ::WIMLIB_ERR_MQUEUE
3112  *      Could not open a POSIX message queue to communicate with the filesystem
3113  *      daemon servicing the mounted filesystem, could not send a message
3114  *      through the queue, or could not receive a message through the queue.
3115  * @retval ::WIMLIB_ERR_NOMEM
3116  *      Failed to allocate needed memory.
3117  * @retval ::WIMLIB_ERR_OPEN
3118  *      The filesystem daemon could not open a temporary file for writing the
3119  *      new WIM.
3120  * @retval ::WIMLIB_ERR_READ
3121  *      A read error occurred when the filesystem daemon tried to a file from
3122  *      the staging directory
3123  * @retval ::WIMLIB_ERR_RENAME
3124  *      The filesystem daemon failed to rename the newly written WIM file to the
3125  *      original WIM file.
3126  * @retval ::WIMLIB_ERR_UNSUPPORTED
3127  *      Mounting is not supported, either because the platform is Windows, or
3128  *      because the platform is UNIX-like and wimlib was compiled with @c
3129  *      --without-fuse.
3130  * @retval ::WIMLIB_ERR_WRITE
3131  *      A write error occurred when the filesystem daemon was writing to the new
3132  *      WIM file, or the filesystem daemon was unable to flush changes that had
3133  *      been made to files in the staging directory.
3134  */
3135 extern int
3136 wimlib_unmount_image(const wimlib_tchar *dir,
3137                      int unmount_flags,
3138                      wimlib_progress_func_t progress_func);
3139
3140 /**
3141  * Update a WIM image by adding, deleting, and/or renaming files or directories.
3142  *
3143  * @param wim
3144  *      Pointer to the ::WIMStruct for the WIM file to update.
3145  * @param image
3146  *      The 1-based index of the image in the WIM to update.  It cannot be
3147  *      ::WIMLIB_ALL_IMAGES.
3148  * @param cmds
3149  *      An array of ::wimlib_update_command's that specify the update operations
3150  *      to perform.
3151  * @param num_cmds
3152  *      Number of commands in @p cmds.
3153  * @param update_flags
3154  *      ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3155  * @param progress_func
3156  *      If non-NULL, a function that will be called periodically with the
3157  *      progress of the current operation.
3158  *
3159  * @return 0 on success; nonzero on error.  On failure, some but not all of the
3160  * update commands may have been executed.  No individual update command will
3161  * have been partially executed.  Possible error codes include:
3162  *
3163  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3164  *      The capture configuration structure specified for an add command was
3165  *      invalid.
3166  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3167  *      @p image did not specify a single, existing image in @p wim.
3168  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3169  *      Attempted to perform an add command that conflicted with previously
3170  *      existing files in the WIM when an overlay was attempted.
3171  * @retval ::WIMLIB_ERR_INVALID_PARAM
3172  *      An unknown operation type was specified in the update commands; or,
3173  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3174  *      in the @p add_flags, but the same image had previously already been
3175  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3176  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3177  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3178  *      specified in the @p add_flags for an add command in which @p
3179  *      wim_target_path was not the root directory of the WIM image.
3180  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3181  *      (Windows only):  While executing an add command, tried to capture a
3182  *      reparse point with invalid data.
3183  * @retval ::WIMLIB_ERR_IS_DIRECTORY
3184  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3185  *      for a WIM path that corresponded to a directory; or, a rename command
3186  *      attempted to rename a directory to a non-directory.
3187  * @retval ::WIMLIB_ERR_NOMEM
3188  *      Failed to allocate needed memory.
3189  * @retval ::WIMLIB_ERR_NOTDIR
3190  *      A rename command attempted to rename a directory to a non-directory; or,
3191  *      an add command was executed that attempted to set the root of the WIM
3192  *      image as a non-directory; or, a path component used as a directory in a
3193  *      rename command was not, in fact, a directory.
3194  * @retval ::WIMLIB_ERR_NOTEMPTY
3195  *      A rename command attempted to rename a directory to a non-empty
3196  *      directory.
3197  * @retval ::WIMLIB_ERR_NTFS_3G
3198  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3199  *      error occurred while reading data from the NTFS volume using libntfs-3g.
3200  * @retval ::WIMLIB_ERR_OPEN
3201  *      Failed to open a file to be captured while executing an add command.
3202  * @retval ::WIMLIB_ERR_OPENDIR
3203  *      Failed to open a directory to be captured while executing an add command.
3204  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3205  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3206  *      WIM path that did not exist; or, a rename command attempted to rename a
3207  *      file that does not exist.
3208  * @retval ::WIMLIB_ERR_READ
3209  *      While executing an add command, failed to read data from a file or
3210  *      directory to be captured.
3211  * @retval ::WIMLIB_ERR_READLINK
3212  *      While executing an add command, failed to read the target of a symbolic
3213  *      link or junction point.
3214  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3215  *      (Windows only) Failed to perform a reparse point fixup because of
3216  *      problems with the data of a reparse point.
3217  * @retval ::WIMLIB_ERR_STAT
3218  *      While executing an add command, failed to get attributes for a file or
3219  *      directory.
3220  * @retval ::WIMLIB_ERR_UNSUPPORTED
3221  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3222  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
3223  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3224  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3225  *      add_flags for an update command.
3226  * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3227  *      While executing an add command, attempted to capture a file that was not
3228  *      a supported file type (e.g. a device file).  Only if
3229  *      ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3230  *      for an update command.
3231  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3232  *      The WIM file is considered read-only because of any of the reasons
3233  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3234  *      flag.
3235  *
3236  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3237  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3238  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3239  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3240  * different reasons) to read the metadata resource for an image that needed to
3241  * be updated.
3242  */
3243 extern int
3244 wimlib_update_image(WIMStruct *wim,
3245                     int image,
3246                     const struct wimlib_update_command *cmds,
3247                     size_t num_cmds,
3248                     int update_flags,
3249                     wimlib_progress_func_t progress_func);
3250
3251 /**
3252  * Writes a standalone WIM to a file.
3253  *
3254  * This brings in resources from any external locations, such as directory trees
3255  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3256  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3257  *
3258  * @param wim
3259  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
3260  *      changes made to it, which are then reflected in the output file.
3261  * @param path
3262  *      The path to the file to write the WIM to.
3263  * @param image
3264  *      The 1-based index of the image inside the WIM to write.  Use
3265  *      ::WIMLIB_ALL_IMAGES to include all images.
3266  * @param write_flags
3267  *      Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3268  * @param num_threads
3269  *      Number of threads to use for compressing data.  If 0, the number of
3270  *      threads is taken to be the number of online processors.  Note: if no
3271  *      data compression needs to be done, no additional threads will be created
3272  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
3273  *      exporting an image from a compressed WIM to another WIM of the same
3274  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3275  *      write_flags).
3276  * @param progress_func
3277  *      If non-NULL, a function that will be called periodically with the
3278  *      progress of the current operation.  The possible messages are
3279  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3280  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3281  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3282  *
3283  * @return 0 on success; nonzero on error.
3284  *
3285  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3286  *      @p image does not specify a single existing image in @p wim, and is not
3287  *      ::WIMLIB_ALL_IMAGES.
3288  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3289  *      A file that had previously been scanned for inclusion in the WIM by
3290  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
3291  *      message digest check.
3292  * @retval ::WIMLIB_ERR_INVALID_PARAM
3293  *      @p path was @c NULL.
3294  * @retval ::WIMLIB_ERR_NOMEM
3295  *      Failed to allocate needed memory.
3296  * @retval ::WIMLIB_ERR_OPEN
3297  *      Failed to open @p path for writing, or some file resources in @p wim
3298  *      refer to files in the outside filesystem, and one of these files could
3299  *      not be opened for reading.
3300  * @retval ::WIMLIB_ERR_READ
3301  *      An error occurred when trying to read data from the WIM file associated
3302  *      with @p wim, or some file resources in @p wim refer to files in the
3303  *      outside filesystem, and a read error occurred when reading one of these
3304  *      files.
3305  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3306  *      A stream that needed to be written could not be found in the stream
3307  *      lookup table of @p wim.  This error can occur if, for example, @p wim is
3308  *      part of a split WIM but needed resources from the other split WIM parts
3309  *      were not referenced with wimlib_reference_resources() or
3310  *      wimlib_reference_resource_files() before the call to wimlib_write().
3311  * @retval ::WIMLIB_ERR_WRITE
3312  *      An error occurred when trying to write data to the new WIM file.
3313  *
3314  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3315  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3316  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3317  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3318  * different reasons) to read the metadata resource for an image that needed to
3319  * be written.
3320  */
3321 extern int
3322 wimlib_write(WIMStruct *wim,
3323              const wimlib_tchar *path,
3324              int image,
3325              int write_flags,
3326              unsigned num_threads,
3327              wimlib_progress_func_t progress_func);
3328
3329 /**
3330  * Since wimlib v1.5.0:  Same as wimlib_write(), but write the WIM directly to a
3331  * file descriptor, which need not be seekable if the write is done in a special
3332  * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3333  * write_flags.  This can, for example, allow capturing a WIM image and
3334  * streaming it over the network.  See the documentation for
3335  * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3336  *
3337  * The file descriptor @p fd will @b not be closed when the write is complete;
3338  * the calling code is responsible for this.
3339  *
3340  * Returns 0 on success; nonzero on failure.  The possible error codes include
3341  * those that can be returned by wimlib_write() as well as the following:
3342  *
3343  * @retval ::WIMLIB_ERR_INVALID_PARAM
3344  *      @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3345  *      specified in @p write_flags.
3346  */
3347 extern int
3348 wimlib_write_to_fd(WIMStruct *wim,
3349                    int fd,
3350                    int image,
3351                    int write_flags,
3352                    unsigned num_threads,
3353                    wimlib_progress_func_t progress_func);
3354
3355 /**
3356  * This function is equivalent to wimlib_lzx_compress(), but instead compresses
3357  * the data using "XPRESS" compression.
3358  */
3359 extern unsigned
3360 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3361
3362 /**
3363  * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
3364  * the data is compressed using "XPRESS" compression.
3365  */
3366 extern int
3367 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3368                          void *uncompressed_data, unsigned uncompressed_len);
3369
3370 #endif /* _WIMLIB_H */