decompress.h: Add likely(), unlikely() uses
[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.4.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.
39  *
40  * \section starting Getting Started
41  *
42  * wimlib uses the GNU autotools, so, on UNIX 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,
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, directly to a block device
75  * 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, wimlib supports mounting WIM files either read-only or read-write.
84  * Mounting is done using wimlib_mount_image() and unmounting is done using
85  * wimlib_unmount_image().  Mounting can be done without root privileges because
86  * it is implemented using FUSE (Filesystem in Userspace).  If wimlib is
87  * compiled with the <code>--without-fuse</code> flag, these functions will be
88  * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
89  *
90  * After creating or modifying a WIM file, you can write it to a file using
91  * wimlib_write().  Alternatively,  if the WIM was originally read from a file
92  * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93  * wimlib_overwrite() to overwrite the original file.
94  *
95  * Please note: merely by calling wimlib_add_image() or many of the other
96  * functions in this library that operate on ::WIMStruct's, you are @b not
97  * modifying the WIM file on disk.  Changes are not saved until you explicitly
98  * call wimlib_write() or wimlib_overwrite().
99  *
100  * After you are done with the WIM file, use wimlib_free() to free all memory
101  * associated with a ::WIMStruct and close all files associated with it.
102  *
103  * When you are completely done with using wimlib in your program, you should
104  * call wimlib_global_cleanup().
105  *
106  * A number of functions take a pointer to a progress function of type
107  * ::wimlib_progress_func_t.  This function will be called periodically during
108  * the WIM operation(s) to report on the progress of the operation (for example,
109  * how many bytes have been written so far).
110  *
111  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112  * the following exceptions:
113  * - You must call wimlib_global_init() in one thread before calling any other
114  *   functions.
115  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
116  *   race conditions with one-time allocations of memory.
117  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
118  *   concurrently in the same process, will daemonize the entire process when it
119  *   does so for the first time.  This includes changing the working directory
120  *   to the root directory.
121  *
122  * \section encodings Locales and character encodings
123  *
124  * To support Windows as well as UNIX, wimlib's API typically takes and returns
125  * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
126  *
127  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
128  * and the encoding is UTF-16LE.
129  *
130  * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
131  * encoding is the locale-dependent multibyte encoding.  I recommend you set
132  * your locale to a UTF-8 capable locale to avoid any issues.  Also, by default,
133  * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
134  * wimlib_global_init() after having set your desired locale.
135  *
136  * \section Limitations
137  *
138  * This section documents some technical limitations of wimlib not already
139  * documented in the man page for @b wimlib-imagex.
140  *
141  * - The old WIM format from Vista pre-releases is not supported.
142  * - Compressed resource chunk sizes other than 32768 are not supported.  This
143  *   doesn't seem to be a real problem because the chunk size always seems to be
144  *   this value.
145  * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
146  *   functionality other than that already present in @b ImageX, that allows you
147  *   to make certain Windows-specific modifications to a Windows PE image, such
148  *   as adding a driver or Windows component.  Such a tool possibly could be
149  *   implemented on top of wimlib.
150  */
151
152 #ifndef _WIMLIB_H
153 #define _WIMLIB_H
154
155 #include <stdio.h>
156 #include <stddef.h>
157 #include <stdbool.h>
158 #include <inttypes.h>
159
160 /** Major version of the library (for example, the 1 in 1.2.5). */
161 #define WIMLIB_MAJOR_VERSION 1
162
163 /** Minor version of the library (for example, the 2 in 1.2.5). */
164 #define WIMLIB_MINOR_VERSION 4
165
166 /** Patch version of the library (for example, the 5 in 1.2.5). */
167 #define WIMLIB_PATCH_VERSION 0
168
169 /**
170  * Opaque structure that represents a WIM file.  This is an in-memory structure
171  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
172  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
173  * continuing to exist so that data can be read from it as needed.
174  *
175  * Most functions in this library will work the same way regardless of whether a
176  * given ::WIMStruct was obtained through wimlib_open_wim() or
177  * wimlib_create_new_wim().  Exceptions are documented.
178  *
179  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
180  * file from a ::WIMStruct.
181  */
182 #ifndef WIMLIB_WIMSTRUCT_DECLARED
183 typedef struct WIMStruct WIMStruct;
184 #define WIMLIB_WIMSTRUCT_DECLARED
185 #endif
186
187 #ifdef __WIN32__
188 typedef wchar_t wimlib_tchar;
189 #else
190 /** See \ref encodings */
191 typedef char wimlib_tchar;
192 #endif
193
194 /**
195  * Specifies the compression type of a WIM file.
196  */
197 enum wimlib_compression_type {
198         /** An invalid compression type. */
199         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
200
201         /** The WIM does not include any compressed resources. */
202         WIMLIB_COMPRESSION_TYPE_NONE = 0,
203
204         /** Compressed resources in the WIM use LZX compression. */
205         WIMLIB_COMPRESSION_TYPE_LZX = 1,
206
207         /** Compressed resources in the WIM use XPRESS compression. */
208         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
209 };
210
211 /** Possible values of the first parameter to the user-supplied
212  * ::wimlib_progress_func_t progress function */
213 enum wimlib_progress_msg {
214
215         /** A WIM image is about to be extracted.  @a info will point to
216          * ::wimlib_progress_info.extract. */
217         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
218
219         /** A file or directory tree within a WIM image (not the full image) is
220          * about to be extracted.  @a info will point to
221          * ::wimlib_progress_info.extract. */
222         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
223
224         /** The directory structure of the WIM image is about to be extracted.
225          * @a info will point to ::wimlib_progress_info.extract. */
226         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
227
228         /** The directory structure of the WIM image has been successfully
229          * extracted.  @a info will point to ::wimlib_progress_info.extract. */
230         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
231
232         /** The WIM image's files resources are currently being extracted.  @a
233          * info will point to ::wimlib_progress_info.extract. */
234         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
235
236         /** A file or directory is being extracted.  @a info will point to
237          * ::wimlib_progress_info.extract, and the @a cur_path member will be
238          * valid. */
239         WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
240
241         /** All the WIM files and directories have been extracted, and
242          * timestamps are about to be applied.  @a info will point to
243          * ::wimlib_progress_info.extract. */
244         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
245
246         /** A WIM image has been successfully extracted.  @a info will point to
247          * ::wimlib_progress_info.extract. */
248         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
249
250         /** A file or directory tree within a WIM image (not the full image) has
251          * been successfully extracted.  @a info will point to
252          * ::wimlib_progress_info.extract. */
253         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
254
255         /** The directory or NTFS volume is about to be scanned to build a tree
256          * of WIM dentries in-memory.  @a info will point to
257          * ::wimlib_progress_info.scan. */
258         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
259
260         /** A directory or file is being scanned.  @a info will point to
261          * ::wimlib_progress_info.scan, and its @a cur_path member will be
262          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
263          * is passed to wimlib_add_image(). */
264         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
265
266         /** The directory or NTFS volume has been successfully scanned, and a
267          * tree of WIM dentries has been built in-memory. @a info will point to
268          * ::wimlib_progress_info.scan. */
269         WIMLIB_PROGRESS_MSG_SCAN_END,
270
271         /**
272          * File resources are currently being written to the WIM.
273          * @a info will point to ::wimlib_progress_info.write_streams. */
274         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
275
276         /**
277          * The metadata resource for each image is about to be written to the
278          * WIM. @a info will not be valid. */
279         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
280
281         /**
282          * The metadata resource for each image has successfully been writen to
283          * the WIM.  @a info will not be valid. */
284         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
285
286         /**
287          * The temporary file has successfully been renamed to the original WIM
288          * file.  Only happens when wimlib_overwrite() is called and the
289          * overwrite is not done in-place.
290          * @a info will point to ::wimlib_progress_info.rename. */
291         WIMLIB_PROGRESS_MSG_RENAME,
292
293         /** The contents of the WIM are being checked against the integrity
294          * table.  Only happens when wimlib_open_wim() is called with the
295          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  @a info will point to
296          * ::wimlib_progress_info.integrity. */
297         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
298
299         /** An integrity table is being calculated for the WIM being written.
300          * Only happens when wimlib_write() or wimlib_overwrite() is called with
301          * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag.  @a info will point to
302          * ::wimlib_progress_info.integrity. */
303         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
304
305         /** A wimlib_join() operation is in progress.  @a info will point to
306          * ::wimlib_progress_info.join. */
307         WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
308
309         /** A wimlib_split() operation is in progress, and a new split part is
310          * about to be started.  @a info will point to
311          * ::wimlib_progress_info.split. */
312         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
313
314         /** A wimlib_split() operation is in progress, and a split part has been
315          * finished. @a info will point to ::wimlib_progress_info.split. */
316         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
317 };
318
319 /** A pointer to this union is passed to the user-supplied
320  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
321  * contained in this union will be applicable for the operation
322  * (::wimlib_progress_msg) indicated in the first argument to the progress
323  * function. */
324 union wimlib_progress_info {
325
326         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
327          * document them if they aren't given a name... */
328
329         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
330         struct wimlib_progress_info_write_streams {
331                 /** Number of bytes that are going to be written for all the
332                  * streams combined.  This is the amount in uncompressed data.
333                  * (The actual number of bytes will be less if the data is being
334                  * written compressed.) */
335                 uint64_t total_bytes;
336                 /** Number of streams that are going to be written. */
337                 uint64_t total_streams;
338
339                 /** Number of uncompressed bytes that have been written so far.
340                  * Will be 0 initially, and equal to @a total_bytes at the end.
341                  * */
342                 uint64_t completed_bytes;
343
344                 /** Number of streams that have been written.  Will be 0
345                  * initially, and equal to @a total_streams at the end. */
346                 uint64_t completed_streams;
347
348                 /** Number of threads that are being used to compress resources
349                  * (if applicable). */
350                 unsigned num_threads;
351
352                 /** The compression type being used to write the streams; either
353                  * ::WIMLIB_COMPRESSION_TYPE_NONE,
354                  * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
355                  * ::WIMLIB_COMPRESSION_TYPE_LZX. */
356                 int      compression_type;
357
358                 /** Library internal use only. */
359                 uint64_t _private;
360         } write_streams;
361
362         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
363          * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
364         struct wimlib_progress_info_scan {
365                 /** Directory or NTFS volume that is being scanned. */
366                 const wimlib_tchar *source;
367
368                 /** Path to the file or directory that is about to be scanned,
369                  * relative to the root of the image capture or the NTFS volume.
370                  * */
371                 const wimlib_tchar *cur_path;
372
373                 /** True iff @a cur_path is being excluded from the image
374                  * capture due to the capture configuration file. */
375                 bool excluded;
376
377                 /** Target path in the WIM.  Only valid on messages
378                  * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
379                  * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
380                 const wimlib_tchar *wim_target_path;
381         } scan;
382
383         /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
384          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
385          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
386          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
387          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
388         struct wimlib_progress_info_extract {
389                 /** Number of the image being extracted (1-based). */
390                 int image;
391
392                 /** Flags passed to to wimlib_extract_image() */
393                 int extract_flags;
394
395                 /** Full path to the WIM file being extracted. */
396                 const wimlib_tchar *wimfile_name;
397
398                 /** Name of the image being extracted. */
399                 const wimlib_tchar *image_name;
400
401                 /** Directory or NTFS volume to which the image is being
402                  * extracted. */
403                 const wimlib_tchar *target;
404
405                 /** Current dentry being extracted.  (Valid only if message is
406                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
407                 const wimlib_tchar *cur_path;
408
409                 /** Number of bytes of uncompressed data that will be extracted.
410                  * Takes into account hard links (they are not counted for each
411                  * link.)
412                  * */
413                 uint64_t total_bytes;
414
415                 /** Number of bytes that have been written so far.  Will be 0
416                  * initially, and equal to @a total_bytes at the end. */
417                 uint64_t completed_bytes;
418
419                 /** Number of streams that will be extracted.  This may more or
420                  * less than the number of "files" to be extracted due to
421                  * special cases (hard links, symbolic links, and alternate data
422                  * streams.) */
423                 uint64_t num_streams;
424
425                 /** Path to the root dentry within the WIM for the tree that is
426                  * being extracted.  Will be the empty string when extracting a
427                  * full image. */
428                 const wimlib_tchar *extract_root_wim_source_path;
429         } extract;
430
431         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
432         struct wimlib_progress_info_rename {
433                 /** Name of the temporary file that the WIM was written to. */
434                 const wimlib_tchar *from;
435
436                 /** Name of the original WIM file to which the temporary file is
437                  * being renamed. */
438                 const wimlib_tchar *to;
439         } rename;
440
441         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
442          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
443         struct wimlib_progress_info_integrity {
444                 /** Number of bytes from the end of the WIM header to the end of
445                  * the lookup table (the area that is covered by the SHA1
446                  * integrity checks.) */
447                 uint64_t total_bytes;
448
449                 /** Number of bytes that have been SHA1-summed so far.  Will be
450                  * 0 initially, and equal @a total_bytes at the end. */
451                 uint64_t completed_bytes;
452
453                 /** Number of chunks that the checksummed region is divided
454                  * into. */
455                 uint32_t total_chunks;
456
457                 /** Number of chunks that have been SHA1-summed so far.   Will
458                  * be 0 initially, and equal to @a total_chunks at the end. */
459                 uint32_t completed_chunks;
460
461                 /** Size of the chunks used for the integrity calculation. */
462                 uint32_t chunk_size;
463
464                 /** Filename of the WIM (only valid if the message is
465                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
466                 const wimlib_tchar *filename;
467         } integrity;
468
469         /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
470         struct wimlib_progress_info_join {
471                 /** Total number of bytes of compressed data contained in all
472                  * the split WIM part's file and metadata resources. */
473                 uint64_t total_bytes;
474
475                 /** Number of bytes that have been copied to the joined WIM so
476                  * far.  Will be 0 initially, and equal to @a total_bytes at the
477                  * end. */
478                 uint64_t completed_bytes;
479
480                 /** Number of split WIM parts that have had all their file and
481                  * metadata resources copied over to the joined WIM so far. */
482                 unsigned completed_parts;
483
484                 /** Number of split WIM parts. */
485                 unsigned total_parts;
486         } join;
487
488         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
489          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
490         struct wimlib_progress_info_split {
491                 /** Total size of the original WIM's file and metadata resources
492                  * (compressed). */
493                 uint64_t total_bytes;
494
495                 /** Number of bytes of file and metadata resources that have
496                  * been copied out of the original WIM so far.  Will be 0
497                  * initially, and equal to @a total_bytes at the end. */
498                 uint64_t completed_bytes;
499
500                 /** Number of the split WIM part that is about to be started
501                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
502                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
503                 unsigned cur_part_number;
504
505                 /** Name of the split WIM part that is about to be started
506                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
507                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
508                 const wimlib_tchar *part_name;
509         } split;
510 };
511
512 /** A user-supplied function that will be called periodically during certain WIM
513  * operations.  The first argument will be the type of operation that is being
514  * performed or is about to be started or has been completed.  The second
515  * argument will be a pointer to one of a number of structures depending on the
516  * first argument.  It may be @c NULL for some message types.
517  *
518  * The return value of the progress function is currently ignored, but it may do
519  * something in the future.  (Set it to 0 for now.)
520  */
521 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
522                                       const union wimlib_progress_info *info);
523
524 /** An array of these structures is passed to wimlib_add_image_multisource() to
525  * specify the sources from which to create a WIM image. */
526 struct wimlib_capture_source {
527         /** Absolute or relative path to a file or directory on the external
528          * filesystem to be included in the WIM image. */
529         wimlib_tchar *fs_source_path;
530
531         /** Destination path in the WIM image.  Leading and trailing slashes are
532          * ignored.  The empty string or @c NULL means the root directory of the
533          * WIM image. */
534         wimlib_tchar *wim_target_path;
535
536         /** Reserved; set to 0. */
537         long reserved;
538 };
539
540 /** Structure that specifies a list of path patterns. */
541 struct wimlib_pattern_list {
542         /** Array of patterns.  The patterns may be modified by library code,
543          * but the @a pats pointer itself will not.  See the man page for
544          * <b>wimlib-imagex capture</b> for more information about allowed
545          * patterns. */
546         wimlib_tchar **pats;
547
548         /** Number of patterns in the @a pats array. */
549         size_t num_pats;
550
551         /** Ignored; may be used by the calling code. */
552         size_t num_allocated_pats;
553 };
554
555 /** A structure that contains lists of wildcards that match paths to treat
556  * specially when capturing a WIM image. */
557 struct wimlib_capture_config {
558         /** Paths matching any pattern this list are excluded from being
559          * captured, except if the same path appears in @a
560          * exclusion_exception_pats. */
561         struct wimlib_pattern_list exclusion_pats;
562
563         /** Paths matching any pattern in this list are never excluded from
564          * being captured. */
565         struct wimlib_pattern_list exclusion_exception_pats;
566
567         /** Reserved for future capture configuration options. */
568         struct wimlib_pattern_list reserved1;
569
570         /** Reserved for future capture configuration options. */
571         struct wimlib_pattern_list reserved2;
572
573         /** Library internal use only. */
574         const wimlib_tchar *_prefix;
575
576         /** Library internal use only. */
577         size_t _prefix_num_tchars;
578 };
579
580
581 /*****************************
582  * WIMLIB_ADD_FLAG_*
583  *****************************/
584
585 /** Directly capture a NTFS volume rather than a generic directory.  This flag
586  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
587  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
588 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
589
590 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
591  * with ::WIMLIB_ADD_FLAG_NTFS. */
592 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
593
594 /** Call the progress function with the message
595  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
596  * be scanned. */
597 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
598
599 /** Mark the image being added as the bootable image of the WIM. */
600 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
601
602 /** Store the UNIX owner, group, and mode.  This is done by adding a special
603  * alternate data stream to each regular file, symbolic link, and directory to
604  * contain this information.  Please note that this flag is for convenience
605  * only; Microsoft's @a imagex.exe will not understand this special information.
606  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
607 #define WIMLIB_ADD_FLAG_UNIX_DATA                       0x00000010
608
609 /** Do not capture security descriptors.  Only has an effect in NTFS capture
610  * mode, or in Win32 native builds. */
611 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
612
613 /** Fail immediately if the full security descriptor of any file or directory
614  * cannot be accessed.  Only has an effect in Win32 native builds.  The default
615  * behavior without this flag is to first try omitting the SACL from the
616  * security descriptor, then to try omitting the security descriptor entirely.
617  * */
618 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
619
620 /** Call the progress function with the message
621  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
622  * capture.  This is a subset of the messages provided by
623  * ::WIMLIB_ADD_FLAG_VERBOSE. */
624 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
625
626 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
627  * in the case of Windows) that point inside the directory being captured to
628  * instead be absolute relative to the directory being captured, rather than the
629  * current root; also exclude absolute symbolic links that point outside the
630  * directory tree being captured.
631  *
632  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
633  * the WIM header or if this is the first image being added.
634  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
635  * reparse point fixups enabled and currently cannot be unset. */
636 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
637
638 /** Don't do reparse point fixups.  The default behavior is described in the
639  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
640 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
641
642 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
643 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
644 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
645 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
646 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
647 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
648 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
649 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
650 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
651 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
652
653 /******************************
654  * WIMLIB_DELETE_FLAG_*
655  ******************************/
656
657 /** Do not issue an error if the path to delete does not exist. */
658 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
659
660 /** Delete the file or directory tree recursively; if not specified, an error is
661  * issued if the path to delete is a directory. */
662 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
663
664 /******************************
665  * WIMLIB_EXPORT_FLAG_*
666  ******************************/
667
668 /** See documentation for wimlib_export_image(). */
669 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
670
671 /******************************
672  * WIMLIB_EXTRACT_FLAG_*
673  ******************************/
674
675 /** Extract the image directly to a NTFS volume rather than a generic directory.
676  * */
677 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
678
679 /** When identical files are extracted from the WIM, always hard link them
680  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
681 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
682
683 /** When identical files are extracted from the WIM, always symlink them
684  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
685 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
686
687 /** Call the progress function with the argument
688  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
689  * extracted.  Note: these calls will be interspersed with calls for the message
690  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
691 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
692
693 /** Read the WIM file sequentially while extracting the image. */
694 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
695
696 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
697  * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
698 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
699
700 /** Do not extract security descriptors.  Only has an effect in NTFS apply mode,
701  * or in Win32 native builds. */
702 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
703
704 /** Fail immediately if the full security descriptor of any file or directory
705  * cannot be set exactly as specified in the WIM file.  The default behavior
706  * without this flag is to fall back to setting the security descriptor with the
707  * SACL omitted, then only the default inherited security descriptor, if we do
708  * not have permission to set the desired one. */
709 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
710
711 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
712  * fixups on, so absolute symbolic links or junction points will be fixed to be
713  * absolute relative to the actual extraction root.  Done by default if
714  * WIM_HDR_FLAG_RP_FIX is set in the WIM header.  This flag may only be
715  * specified when extracting a full image. */
716 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
717
718 /** Force reparse-point fixups on extraction off, regardless of the state of the
719  * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
720 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
721
722 /** Extract files to standard output rather than to the filesystem. */
723 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
724
725 /******************************
726  * WIMLIB_MOUNT_FLAG_*
727  ******************************/
728
729 /** Mount the WIM image read-write rather than the default of read-only. */
730 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
731
732 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
733 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
734
735 /** Do not allow accessing alternate data streams in the mounted WIM image. */
736 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
737
738 /** Access alternate data streams in the mounted WIM image through extended file
739  * attributes.  This is the default mode. */
740 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
741
742 /** Access alternate data streams in the mounted WIM image by specifying the
743  * file name, a colon, then the alternate file stream name. */
744 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
745
746 /** Use UNIX file owners, groups, and modes if available in the WIM (see
747  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
748 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
749
750 /** Allow other users to see the mounted filesystem.  (this passes the @c
751  * allow_other option to FUSE mount) */
752 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
753
754 /******************************
755  * WIMLIB_OPEN_FLAG_*
756  ******************************/
757
758 /** Verify the WIM contents against the WIM's integrity table, if present. */
759 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
760
761 /** Do not issue an error if the WIM is part of a split WIM. */
762 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
763
764 /******************************
765  * WIMLIB_UNMOUNT_FLAG_*
766  ******************************/
767
768 /** Include an integrity table in the WIM after it's been unmounted.  Ignored
769  * for read-only mounts. */
770 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
771
772 /** Unless this flag is given, changes to a read-write mounted WIM are
773  * discarded.  Ignored for read-only mounts. */
774 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
775
776 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
777 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
778
779 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
780 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
781
782 /******************************
783  * WIMLIB_WRITE_FLAG_*
784  ******************************/
785
786 /** Include an integrity table in the new WIM file. */
787 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
788
789 /** Re-build the entire WIM file rather than appending data to it, if possible.
790  * (Applies to wimlib_overwrite(), not wimlib_write()). */
791 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000002
792
793 /** Recompress all resources, even if they could otherwise be copied from a
794  * different WIM with the same compression type (in the case of
795  * wimlib_export_image() being called previously). */
796 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000004
797
798 /** Call fsync() when the WIM file is closed */
799 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000008
800
801 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
802  * after one or more calls to wimlib_delete_image(), which is to rebuild the
803  * entire WIM.
804  *
805  * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
806  * correctly remove the image from the WIM will be taken.  In particular, all
807  * streams will be left alone, even if they are no longer referenced.  This is
808  * probably not what you want, because almost no space will be spaced by
809  * deleting an image in this way. */
810 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000010
811
812 /******************************
813  * WIMLIB_INIT_FLAG_*
814  ******************************/
815
816 /** Assume that strings are represented in UTF-8, even if this is not the
817  * locale's character encoding. */
818 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
819
820 /** Specification of an update to perform on a WIM image. */
821 struct wimlib_update_command {
822
823         /** The specific type of update to perform. */
824         enum wimlib_update_op {
825                 /** Add a new file or directory tree to the WIM image in a
826                  * certain location. */
827                 WIMLIB_UPDATE_OP_ADD = 0,
828
829                 /** Delete a file or directory tree from the WIM image. */
830                 WIMLIB_UPDATE_OP_DELETE,
831
832                 /** Rename a file or directory tree in the WIM image. */
833                 WIMLIB_UPDATE_OP_RENAME,
834         } op;
835         union {
836                 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
837                 struct wimlib_add_command {
838                         /** Filesystem path to the file or directory tree to
839                          * add. */
840                         wimlib_tchar *fs_source_path;
841                         /** Path, specified from the root of the WIM image, at
842                          * which to add the file or directory tree within the
843                          * WIM image. */
844                         wimlib_tchar *wim_target_path;
845
846                         /** Configuration for excluded files.  @c NULL means
847                          * exclude no files. */
848                         struct wimlib_capture_config *config;
849
850                         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
851                         int add_flags;
852                 } add;
853                 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
854                 struct wimlib_delete_command {
855                         /** Path, specified from the root of the WIM image, for
856                          * the file or directory tree within the WIM image to be
857                          * deleted. */
858                         wimlib_tchar *wim_path;
859                         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
860                         int delete_flags;
861                 } delete;
862                 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
863                 struct wimlib_rename_command {
864                         /** Path, specified from the root of the WIM image, for
865                          * the source file or directory tree within the WIM
866                          * image. */
867                         wimlib_tchar *wim_source_path;
868                         /** Path, specified from the root of the WIM image, for
869                          * the destination file or directory tree within the WIM
870                          * image. */
871                         wimlib_tchar *wim_target_path;
872                         /** Reserved; set to 0. */
873                         int rename_flags;
874                 } rename;
875         };
876 };
877
878 /** Specification of a file or directory tree to extract from a WIM image. */
879 struct wimlib_extract_command {
880         /** Path to file or directory tree within the WIM image to extract.  It
881          * must be provided as an absolute path from the root of the WIM image.
882          * The path separators may be either forward slashes or backslashes. */
883         wimlib_tchar *wim_source_path;
884
885         /** Filesystem path to extract the file or directory tree to. */
886         wimlib_tchar *fs_dest_path;
887
888         /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
889         int extract_flags;
890 };
891
892 /**
893  * Possible values of the error code returned by many functions in wimlib.
894  *
895  * See the documentation for each wimlib function to see specifically what error
896  * codes can be returned by a given function, and what they mean.
897  */
898 enum wimlib_error_code {
899         WIMLIB_ERR_SUCCESS = 0,
900         WIMLIB_ERR_ALREADY_LOCKED,
901         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
902         WIMLIB_ERR_DECOMPRESSION,
903         WIMLIB_ERR_DELETE_STAGING_DIR,
904         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
905         WIMLIB_ERR_FORK,
906         WIMLIB_ERR_FUSE,
907         WIMLIB_ERR_FUSERMOUNT,
908         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
909         WIMLIB_ERR_IMAGE_COUNT,
910         WIMLIB_ERR_IMAGE_NAME_COLLISION,
911         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
912         WIMLIB_ERR_INTEGRITY,
913         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
914         WIMLIB_ERR_INVALID_CHUNK_SIZE,
915         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
916         WIMLIB_ERR_INVALID_DENTRY,
917         WIMLIB_ERR_INVALID_HEADER_SIZE,
918         WIMLIB_ERR_INVALID_IMAGE,
919         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
920         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
921         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
922         WIMLIB_ERR_INVALID_OVERLAY,
923         WIMLIB_ERR_INVALID_PARAM,
924         WIMLIB_ERR_INVALID_PART_NUMBER,
925         WIMLIB_ERR_INVALID_REPARSE_DATA,
926         WIMLIB_ERR_INVALID_RESOURCE_HASH,
927         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
928         WIMLIB_ERR_INVALID_SECURITY_DATA,
929         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
930         WIMLIB_ERR_INVALID_UTF16_STRING,
931         WIMLIB_ERR_INVALID_UTF8_STRING,
932         WIMLIB_ERR_IS_DIRECTORY,
933         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
934         WIMLIB_ERR_LINK,
935         WIMLIB_ERR_MKDIR,
936         WIMLIB_ERR_MQUEUE,
937         WIMLIB_ERR_NOMEM,
938         WIMLIB_ERR_NOTDIR,
939         WIMLIB_ERR_NOTEMPTY,
940         WIMLIB_ERR_NOT_A_REGULAR_FILE,
941         WIMLIB_ERR_NOT_A_WIM_FILE,
942         WIMLIB_ERR_NO_FILENAME,
943         WIMLIB_ERR_NTFS_3G,
944         WIMLIB_ERR_OPEN,
945         WIMLIB_ERR_OPENDIR,
946         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
947         WIMLIB_ERR_READ,
948         WIMLIB_ERR_READLINK,
949         WIMLIB_ERR_RENAME,
950         WIMLIB_ERR_REOPEN,
951         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
952         WIMLIB_ERR_RESOURCE_ORDER,
953         WIMLIB_ERR_SPECIAL_FILE,
954         WIMLIB_ERR_SPLIT_INVALID,
955         WIMLIB_ERR_SPLIT_UNSUPPORTED,
956         WIMLIB_ERR_STAT,
957         WIMLIB_ERR_TIMEOUT,
958         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
959         WIMLIB_ERR_UNKNOWN_VERSION,
960         WIMLIB_ERR_UNSUPPORTED,
961         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
962         WIMLIB_ERR_WRITE,
963         WIMLIB_ERR_XML,
964 };
965
966
967 /** Used to indicate no WIM image or an invalid WIM image. */
968 #define WIMLIB_NO_IMAGE         0
969
970 /** Used to specify all images in the WIM. */
971 #define WIMLIB_ALL_IMAGES       (-1)
972
973 /**
974  * Appends an empty image to a WIM file.  This empty image will initially
975  * contain no files or directories, although if written without further
976  * modifications, a root directory will be created automatically for it.
977  *
978  * @param wim
979  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
980  *      added.
981  * @param name
982  *      Name to give the new image.
983  * @param new_idx_ret
984  *      If non-<code>NULL</code>, the index of the newly added image is returned
985  *      in this location.
986  *
987  * @return 0 on success; nonzero on failure.  The possible error codes are:
988  *
989  * @retval ::WIMLIB_ERR_INVALID_PARAM
990  *      @a name was @c NULL or an empty string.
991  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
992  *      @a wim is part of a split WIM.
993  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
994  *      There is already an image in @a wim named @a name.
995  * @retval ::WIMLIB_ERR_NOMEM
996  *      Failed to allocate the memory needed to add the new image.
997  */
998 extern int
999 wimlib_add_empty_image(WIMStruct *wim,
1000                        const wimlib_tchar *name,
1001                        int *new_idx_ret);
1002
1003 /**
1004  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1005  *
1006  * The directory tree or NTFS volume is scanned immediately to load the dentry
1007  * tree into memory, and file attributes and symbolic links are read.  However,
1008  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1009  * called.
1010  *
1011  * See the manual page for the @b wimlib-imagex program for more information
1012  * about the "normal" capture mode versus the NTFS capture mode (entered by
1013  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1014  *
1015  * Note that @b no changes are committed to the underlying WIM file (if
1016  * any) until wimlib_write() or wimlib_overwrite() is called.
1017  *
1018  * @param wim
1019  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
1020  *      added.
1021  * @param source
1022  *      A path to a directory or unmounted NTFS volume that will be captured as
1023  *      a WIM image.
1024  * @param name
1025  *      The name to give the image.  It must be nonempty and must specify a name
1026  *      that does not yet exist in @a wim.
1027  * @param config
1028  *      Capture configuration that specifies files, directories, or path globs
1029  *      to exclude from being captured.  If @c NULL, a dummy configuration where
1030  *      no paths are treated specially is used.
1031  * @param add_flags
1032  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1033  * @param progress_func
1034  *      If non-NULL, a function that will be called periodically with the
1035  *      progress of the current operation.
1036  *
1037  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
1038  * discarded so that it appears to be in the same state as when this function
1039  * was called.
1040  *
1041  * This function is implemented by calling wimlib_add_empty_image(), then
1042  * calling wimlib_update_image() with a single "add" command, so any error code
1043  * returned by wimlib_add_empty_image() may be returned, as well as any error
1044  * codes returned by wimlib_update_image() other than ones documented as only
1045  * being returned specifically by an update involving delete or rename commands.
1046  */
1047 extern int
1048 wimlib_add_image(WIMStruct *wim,
1049                  const wimlib_tchar *source,
1050                  const wimlib_tchar *name,
1051                  const struct wimlib_capture_config *config,
1052                  int add_flags,
1053                  wimlib_progress_func_t progress_func);
1054
1055 /** This function is equivalent to wimlib_add_image() except it allows for
1056  * multiple sources to be combined into a single WIM image.  This is done by
1057  * specifying the @a sources and @a num_sources parameters instead of the @a
1058  * source parameter of wimlib_add_image().  The rest of the parameters are the
1059  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
1060  * capture</b> for full details on how this mode works.
1061  *
1062  * In addition to the error codes that wimlib_add_image() can return,
1063  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1064  * when trying to overlay a non-directory on a directory or when otherwise
1065  * trying to overlay multiple conflicting files to the same location in the WIM
1066  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
1067  * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1068  * was not exactly one capture source with the target being the root directory.
1069  * (In this respect, there is no advantage to using
1070  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1071  * NTFS mode.) */
1072 extern int
1073 wimlib_add_image_multisource(WIMStruct *wim,
1074                              const struct wimlib_capture_source *sources,
1075                              size_t num_sources,
1076                              const wimlib_tchar *name,
1077                              const struct wimlib_capture_config *config,
1078                              int add_flags,
1079                              wimlib_progress_func_t progress_func);
1080
1081 /**
1082  * Creates a ::WIMStruct for a new WIM file.
1083  *
1084  * This only creates an in-memory structure for a WIM that initially contains no
1085  * images.  No on-disk file is created until wimlib_write() is called.
1086  *
1087  * @param ctype
1088  *      The type of compression to be used in the new WIM file.  Must be
1089  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1090  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1091  * @param wim_ret
1092  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1093  *      written to the memory location pointed to by this paramater.  The
1094  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1095  *      it.
1096  * @return 0 on success; nonzero on error.
1097  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1098  *      @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1099  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1100  * @retval ::WIMLIB_ERR_NOMEM
1101  *      Failed to allocate needed memory.
1102  */
1103 extern int
1104 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1105
1106 /**
1107  * Deletes an image, or all images, from a WIM file.
1108  *
1109  * All streams referenced by the image(s) being deleted are removed from the
1110  * lookup table of the WIM if they are not referenced by any other images in the
1111  * WIM.
1112  *
1113  * Please note that @b no changes are committed to the underlying WIM file (if
1114  * any) until wimlib_write() or wimlib_overwrite() is called.
1115  *
1116  * @param wim
1117  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1118  *      being deleted.
1119  * @param image
1120  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1121  *      images.
1122  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
1123  * to be left unmodified only if @a image specified a single image.  If instead
1124  * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1125  * possible for some but not all of the images to have been deleted when a
1126  * failure status is returned.
1127  *
1128  * @retval ::WIMLIB_ERR_DECOMPRESSION
1129  *      Could not decompress the metadata resource for @a image.
1130  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1131  *      A directory entry in the metadata resource for @a image in the WIM is
1132  *      invalid.
1133  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1134  *      @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1135  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1136  *      The metadata resource for @a image in the WIM is invalid.
1137  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1138  *      The security data for @a image in the WIM is invalid.
1139  * @retval ::WIMLIB_ERR_NOMEM
1140  *      Failed to allocate needed memory.
1141  * @retval ::WIMLIB_ERR_READ
1142  *      Could not read the metadata resource for @a image from the WIM.
1143  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1144  *      @a wim is part of a split WIM.  Deleting an image from a split WIM is
1145  *      unsupported.
1146  */
1147 extern int
1148 wimlib_delete_image(WIMStruct *wim, int image);
1149
1150 /**
1151  * Exports an image, or all the images, from a WIM file, into another WIM file.
1152  *
1153  * The destination image is made to share the same dentry tree and security data
1154  * structure as the source image.  This places some restrictions on additional
1155  * functions that may be called.  wimlib_mount_image() may not be called on
1156  * either the source image or the destination image without an intervening call
1157  * to a function that un-shares the images, such as wimlib_free() on @a
1158  * dest_wim, or wimlib_delete_image() on either the source or destination image.
1159  * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1160  * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1161  * have references back to @a src_wim.
1162  *
1163  * If this function fails, all changes to @a dest_wim are rolled back.
1164  *
1165  * No changes shall be made to @a src_wim by this function.
1166  *
1167  * Please note that no changes are committed to the underlying WIM file of @a
1168  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1169  *
1170  * @param src_wim
1171  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1172  *      WIM that contains the image(s) being exported.
1173  * @param src_image
1174  *      The image to export from @a src_wim.  Can be the number of an image, or
1175  *      ::WIMLIB_ALL_IMAGES to export all images.
1176  * @param dest_wim
1177  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
1178  *      being exported.
1179  * @param dest_name
1180  *      The name to give the exported image in the new WIM file.  If left @c
1181  *      NULL, the name from @a src_wim is used.  This parameter must be left @c
1182  *      NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1183  *      than one image; in that case, the names are all taken from the @a
1184  *      src_wim.  (This is allowed even if one or more images being exported has
1185  *      no name.)
1186  * @param dest_description
1187  *      The description to give the exported image in the new WIM file.  If left
1188  *      @c NULL, the description from the @a src_wim is used.  This parameter must
1189  *      be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1190  *      more than one image; in that case, the descriptions are all taken from
1191  *      @a src_wim.  (This is allowed even if one or more images being exported
1192  *      has no description.)
1193  * @param export_flags
1194  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1195  *      bootable, or 0 if which image is marked as bootable in the destination
1196  *      WIM is to be left unchanged.  If @a src_image is ::WIMLIB_ALL_IMAGES and
1197  *      there are multiple images in @a src_wim, specifying
1198  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1199  *      currently marked as bootable in @a src_wim; if that is the case, then
1200  *      that image is marked as bootable in the destination WIM.
1201  * @param additional_swms
1202  *      Array of pointers to the ::WIMStruct for each additional part in the
1203  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1204  *      need to be in any particular order, but they must include all parts of
1205  *      the split WIM other than the first part, which must be provided in the
1206  *      @a wim parameter.
1207  * @param num_additional_swms
1208  *      Number of additional WIM parts provided in the @a additional_swms array.
1209  *      This number should be one less than the total number of parts in the
1210  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1211  * @param progress_func
1212  *      If non-NULL, a function that will be called periodically with the
1213  *      progress of the current operation.
1214  *
1215  * @return 0 on success; nonzero on error.
1216  * @retval ::WIMLIB_ERR_DECOMPRESSION
1217  *      Could not decompress the metadata resource for @a src_image
1218  *      in @a src_wim
1219  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1220  *      One or more of the names being given to an exported image was already in
1221  *      use in the destination WIM.
1222  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1223  *      A directory entry in the metadata resource for @a src_image in @a
1224  *      src_wim is invalid.
1225  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1226  *      @a src_image does not exist in @a src_wim.
1227  * @retval ::WIMLIB_ERR_INVALID_PARAM
1228  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1229  *      ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1230  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
1231  *      dest_description were non-<code>NULL</code>, @a src_image was
1232  *      ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1233  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1234  *      The metadata resource for @a src_image in @a src_wim is invalid.
1235  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1236  *      The security data for @a src_image in @a src_wim is invalid.
1237  * @retval ::WIMLIB_ERR_NOMEM
1238  *      Failed to allocate needed memory.
1239  * @retval ::WIMLIB_ERR_READ
1240  *      Could not read the metadata resource for @a src_image from @a src_wim.
1241  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1242  *      The source WIM is a split WIM, but the parts specified do not form a
1243  *      complete split WIM because they do not include all the parts of the
1244  *      original WIM, there are duplicate parts, or not all the parts have the
1245  *      same GUID and compression type.
1246  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1247  *      @a dest_wim is part of a split WIM.  Exporting an image to a split WIM
1248  *      is unsupported.
1249  */
1250 extern int
1251 wimlib_export_image(WIMStruct *src_wim, int src_image,
1252                     WIMStruct *dest_wim,
1253                     const wimlib_tchar *dest_name,
1254                     const wimlib_tchar *dest_description,
1255                     int export_flags,
1256                     WIMStruct **additional_swms,
1257                     unsigned num_additional_swms,
1258                     wimlib_progress_func_t progress_func);
1259
1260 /**
1261  * Extract zero or more files or directory trees from a WIM image.
1262  *
1263  * This generalizes the single-image extraction functionality of
1264  * wimlib_extract_image() to allow extracting only the specified subsets of the
1265  * image.
1266  *
1267  * @param wim
1268  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1269  *      split WIM.
1270  *
1271  * @param image
1272  *      The 1-based number of the image in @a wim from which the files or
1273  *      directory trees are to be extracted.  It cannot be ::WIMLIB_ALL_IMAGES.
1274  *
1275  * @param cmds
1276  *      An array of ::wimlib_extract_command structures that specifies the
1277  *      extractions to perform.
1278  *
1279  * @param num_cmds
1280  *      Number of commands in the @a cmds array.
1281  *
1282  * @param default_extract_flags
1283  *      Default extraction flags; the behavior shall be as if these flags had
1284  *      been specified in the ::wimlib_extract_command.extract_flags member in
1285  *      each extraction command, in combination with any flags already present.
1286  *
1287  * @param additional_swms
1288  *      Array of pointers to the ::WIMStruct for each additional part in the
1289  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1290  *      need to be in any particular order, but they must include all parts of
1291  *      the split WIM other than the first part, which must be provided in the
1292  *      @a wim parameter.
1293  *
1294  * @param num_additional_swms
1295  *      Number of additional WIM parts provided in the @a additional_swms array.
1296  *      This number should be one less than the total number of parts in the
1297  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1298  *
1299  * @param progress_func
1300  *      If non-NULL, a function that will be called periodically with the
1301  *      progress of the current operation.
1302  *
1303  * @return 0 on success; nonzero on error.  The possible error codes include
1304  * those documented as returned by wimlib_extract_image() as well as the
1305  * following additional error codes:
1306  *
1307  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1308  *      The ::wimlib_extract_command.wim_source_path member in one of the
1309  *      extract commands did not exist in the WIM.
1310  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1311  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1312  *      in which ::wimlib_extract_command.wim_source_path existed but was not a
1313  *      regular file or directory.
1314  * @retval ::WIMLIB_ERR_INVALID_PARAM
1315  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1316  *      specified for some commands but not all; or
1317  *      ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1318  *      for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1319  *      for a command in which ::wimlib_extract_command.wim_source_path did not
1320  *      specify the root directory of the WIM image.
1321  */
1322 extern int
1323 wimlib_extract_files(WIMStruct *wim,
1324                      int image,
1325                      const struct wimlib_extract_command *cmds,
1326                      size_t num_cmds,
1327                      int default_extract_flags,
1328                      WIMStruct **additional_swms,
1329                      unsigned num_additional_swms,
1330                      wimlib_progress_func_t progress_func);
1331
1332 /**
1333  * Extracts an image, or all images, from a standalone or split WIM file to a
1334  * directory or a NTFS volume.
1335  *
1336  * Please see the manual page for the @c wimlib-imagex program for more
1337  * information about the "normal" extraction mode versus the NTFS extraction
1338  * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1339  *
1340  * Extraction is done with one thread.
1341  *
1342  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1343  * returned if any resulting SHA1 message digests do not match the values
1344  * provided in the WIM file.  Therefore, if this function is successful, you can
1345  * be fairly sure that any compressed data in the WIM was uncompressed
1346  * correctly.
1347  *
1348  * @param wim
1349  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1350  *      split WIM.
1351  * @param image
1352  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1353  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1354  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1355  * @param target
1356  *      Directory to extract the WIM image(s) to (created if it does not already
1357  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1358  *      path to the unmounted NTFS volume to extract the image to.
1359  * @param extract_flags
1360  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1361  *      <br/> <br/>
1362  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1363  *      a NTFS volume to extract the image to.  The volume will be opened using
1364  *      NTFS-3g and the image will be extracted to the root of the NTFS volume.
1365  *      Otherwise, @a target is interpreted as a directory to extract the
1366  *      image(s) to.
1367  *      <br/> <br/>
1368  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1369  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1370  *      specified.  These flags cause extracted files that are identical to be
1371  *      hardlinked or symlinked together, depending on the flag.  These flags
1372  *      override the hard link groups that are specified in the WIM file itself.
1373  *      If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1374  *      hardlinked or symlinked across images if a file is found to occur in
1375  *      more than one image.
1376  *      <br/> <br/>
1377  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1378  *      name of each file or directory as it is extracted.
1379  *      <br/> <br/>
1380  *      If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1381  *      WIM sequentially, if possible.  If ::WIMLIB_ALL_IMAGES is specified,
1382  *      each image is considered separately with regards to the sequential
1383  *      order.  It is also possible for alternate data streams to break the
1384  *      sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1385  *      specified).
1386  * @param additional_swms
1387  *      Array of pointers to the ::WIMStruct for each additional part in the
1388  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1389  *      need to be in any particular order, but they must include all parts of
1390  *      the split WIM other than the first part, which must be provided in the
1391  *      @a wim parameter.
1392  * @param num_additional_swms
1393  *      Number of additional WIM parts provided in the @a additional_swms array.
1394  *      This number should be one less than the total number of parts in the
1395  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1396  *
1397  * @param progress_func
1398  *      If non-NULL, a function that will be called periodically with the
1399  *      progress of the current operation.
1400  *
1401  * @return 0 on success; nonzero on error.
1402  * @retval ::WIMLIB_ERR_DECOMPRESSION
1403  *      Could not decompress a resource (file or metadata) for @a image in @a
1404  *      wim.
1405  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1406  *      A directory entry in the metadata resource for @a image in @a wim is
1407  *      invalid.
1408  * @retval ::WIMLIB_ERR_INVALID_PARAM
1409  *      @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1410  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1411  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1412  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1413  *      specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1414  *      specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1415  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1416  *      specified in @a extract_flag.
1417  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1418  *      The SHA1 message digest of an extracted stream did not match the SHA1
1419  *      message digest given in the WIM file.
1420  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1421  *      A resource (file or metadata) for @a image in @a wim is invalid.
1422  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1423  *      The security data for @a image in @a wim is invalid.
1424  * @retval ::WIMLIB_ERR_LINK
1425 *       Failed to create a symbolic link or a hard link (only if
1426  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1427  * @retval ::WIMLIB_ERR_MKDIR
1428  *      Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1429  *      not specified in @a extract_flags).
1430  * @retval ::WIMLIB_ERR_NOMEM
1431  *      Failed to allocate needed memory.
1432  * @retval ::WIMLIB_ERR_NTFS_3G
1433  *      An error was returned from a libntfs-3g function while the WIM image was
1434  *      being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1435  *      was specified in @a extract_flags).
1436  * @retval ::WIMLIB_ERR_OPEN
1437  *      Could not open one of the files being extracted for writing (only if
1438  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1439  * @retval ::WIMLIB_ERR_READ
1440  *      A unexpected end-of-file or read error occurred when trying to read data
1441  *      from the WIM file associated with @a wim.
1442  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1443  *      The WIM is a split WIM, but the parts specified do not form a complete
1444  *      split WIM because they do not include all the parts of the original WIM,
1445  *      there are duplicate parts, or not all the parts have the same GUID and
1446  *      compression type.
1447  * @retval ::WIMLIB_ERR_UNSUPPORTED
1448  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1449  *      was configured with the @c --without-ntfs-3g flag.
1450  * @retval ::WIMLIB_ERR_WRITE
1451  *      Failed to write a file being extracted (only if
1452  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1453  */
1454 extern int
1455 wimlib_extract_image(WIMStruct *wim, int image,
1456                      const wimlib_tchar *target,
1457                      int extract_flags,
1458                      WIMStruct **additional_swms,
1459                      unsigned num_additional_swms,
1460                      wimlib_progress_func_t progress_func);
1461
1462 /**
1463  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1464  * includes a string of XML that describes the images contained in the WIM.
1465  * This function works on standalone WIMs as well as split WIM parts.
1466  *
1467  * @param wim
1468  *      Pointer to the ::WIMStruct for a WIM file.
1469  * @param fp
1470  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1471  *
1472  * @return 0 on success; nonzero on error.
1473  * @retval ::WIMLIB_ERR_INVALID_PARAM
1474  *      @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1475  * @retval ::WIMLIB_ERR_NOMEM
1476  *      Failed to allocate needed memory.
1477  * @retval ::WIMLIB_ERR_READ
1478  *      Failed to read the XML data from the WIM.
1479  * @retval ::WIMLIB_ERR_WRITE
1480  *      Failed to completely write the XML data to @a fp.
1481  */
1482 extern int
1483 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1484
1485 /**
1486  * Frees all memory allocated for a WIMStruct and closes all files associated
1487  * with it.
1488  *
1489  * @param wim
1490  *      Pointer to the ::WIMStruct for a WIM file.
1491  *
1492  * @return This function has no return value.
1493  */
1494 extern void
1495 wimlib_free(WIMStruct *wim);
1496
1497 /**
1498  * Returns the index of the bootable image of the WIM.
1499  *
1500  * @param wim
1501  *      Pointer to the ::WIMStruct for a WIM file.
1502  *
1503  * @return
1504  *      0 if no image is marked as bootable, or the number of the image marked
1505  *      as bootable (numbered starting at 1).
1506  */
1507 extern int
1508 wimlib_get_boot_idx(const WIMStruct *wim);
1509
1510 /**
1511  * Returns the compression type used in the WIM.
1512  *
1513  * @param wim
1514  *      Pointer to the ::WIMStruct for a WIM file
1515  *
1516  * @return
1517  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1518  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1519  */
1520 extern int
1521 wimlib_get_compression_type(const WIMStruct *wim);
1522
1523 /**
1524  * Converts a ::wimlib_compression_type value into a string.
1525  *
1526  * @param ctype
1527  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1528  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1529  *
1530  * @return
1531  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1532  *      respectively.
1533  */
1534 extern const wimlib_tchar *
1535 wimlib_get_compression_type_string(int ctype);
1536
1537 /**
1538  * Converts an error code into a string describing it.
1539  *
1540  * @param code
1541  *      The error code returned by one of wimlib's functions.
1542  *
1543  * @return
1544  *      Pointer to a statically allocated string describing the error code,
1545  *      or @c NULL if the error code is not valid.
1546  */
1547 extern const wimlib_tchar *
1548 wimlib_get_error_string(enum wimlib_error_code code);
1549
1550 /**
1551  * Returns the description of the specified image.
1552  *
1553  * @param wim
1554  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1555  *      standalone WIM or a split WIM part.
1556  * @param image
1557  *      The number of the image, numbered starting at 1.
1558  *
1559  * @return
1560  *      The description of the image, or @c NULL if there is no such image, or
1561  *      @c NULL if the specified image has no description.  The description
1562  *      string is in library-internal memory and may not be modified or freed;
1563  *      in addition, the string will become invalid if the description of the
1564  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1565  */
1566 extern const wimlib_tchar *
1567 wimlib_get_image_description(const WIMStruct *wim, int image);
1568
1569 /**
1570  * Returns the name of the specified image.
1571  *
1572  * @param wim
1573  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1574  *      standalone WIM or a split WIM part.
1575  * @param image
1576  *      The number of the image, numbered starting at 1.
1577  *
1578  * @return
1579  *      The name of the image, or @c NULL if there is no such image.  The name
1580  *      string is in library-internal memory and may not be modified or freed;
1581  *      in addition, the string will become invalid if the name of the image is
1582  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
1583  *
1584  *      If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1585  *      the WIM to be unnamed, in which case an empty string will be returned
1586  *      when the corresponding name is requested.
1587  */
1588 extern const wimlib_tchar *
1589 wimlib_get_image_name(const WIMStruct *wim, int image);
1590
1591
1592 /**
1593  * Returns the number of images contained in a WIM.
1594  *
1595  * @param wim
1596  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1597  *      standalone WIM or a split WIM part.
1598  *
1599  * @return
1600  *      The number of images contained in the WIM file.
1601  */
1602 extern int
1603 wimlib_get_num_images(const WIMStruct *wim);
1604
1605 /**
1606  * Returns the part number of a WIM in a split WIM and the total number of parts
1607  * of the split WIM.
1608  *
1609  * @param wim
1610  *      Pointer to the ::WIMStruct for a WIM file.
1611  * @param total_parts_ret
1612  *      If non-@c NULL, the total number of parts in the split WIM (1 for
1613  *      non-split WIMs) is written to this location.
1614  *
1615  * @return
1616  *      The part number of the WIM (1 for non-split WIMs)
1617  */
1618 extern int
1619 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1620
1621 /**
1622  * Initialization function for wimlib.  Call before using any other wimlib
1623  * function.
1624  *
1625  * @param init_flags
1626  *      On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1627  *      that all input data, including filenames, are in UTF-8 rather than the
1628  *      locale-dependent character encoding which may or may not be UTF-8, and
1629  *      that UTF-8 data can be directly printed to the console.  On Windows, use
1630  *      0 for this parameter.
1631  *
1632  * @return 0; other error codes may be returned in future releases.
1633  */
1634 extern int
1635 wimlib_global_init(int init_flags);
1636
1637 /**
1638  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
1639  * You are not required to call this function, but it will release any global
1640  * memory allocated by the library.
1641  */
1642 extern void
1643 wimlib_global_cleanup(void);
1644
1645 /**
1646  * Returns true if the WIM has an integrity table.
1647  *
1648  * @param wim
1649  *      Pointer to the ::WIMStruct for a WIM file.
1650  * @return
1651  *      @c true if the WIM has an integrity table; @c false otherwise.  If @a
1652  *      wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1653  *      wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1654  *      been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1655  */
1656 extern bool
1657 wimlib_has_integrity_table(const WIMStruct *wim);
1658
1659 /**
1660  * Determines if an image name is already used by some image in the WIM.
1661  *
1662  * @param wim
1663  *      Pointer to the ::WIMStruct for a WIM file.
1664  * @param name
1665  *      The name to check.
1666  *
1667  * @return
1668  *      @c true if there is already an image in @a wim named @a name; @c false
1669  *      if there is no image named @a name in @a wim.  If @a name is @c NULL or
1670  *      the empty string, @c false is returned.
1671  */
1672 extern bool
1673 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1674
1675 /**
1676  * Joins a split WIM into a stand-alone one-part WIM.
1677  *
1678  * @param swms
1679  *      An array of strings that gives the filenames of all parts of the split
1680  *      WIM.  No specific order is required, but all parts must be included with
1681  *      no duplicates.
1682  * @param num_swms
1683  *      Number of filenames in @a swms.
1684  * @param swm_open_flags
1685  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1686  *      part should be verified, if integrity tables are present.  Otherwise,
1687  *      set to 0.
1688  * @param wim_write_flags
1689  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1690  * @param output_path
1691  *      The path to write the one-part WIM to.
1692  * @param progress_func
1693  *      If non-NULL, a function that will be called periodically with the
1694  *      progress of the current operation.
1695  *
1696  * @return 0 on success; nonzero on error.  This function may return any value
1697  * returned by wimlib_open_wim() and wimlib_write() except
1698  * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1699  *
1700  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1701  *      The split WIMs do not form a valid WIM because they do not include all
1702  *      the parts of the original WIM, there are duplicate parts, or not all the
1703  *      parts have the same GUID and compression type.
1704  *
1705  * Note: the WIM's uncompressed and compressed resources are not checksummed
1706  * when they are copied from the split WIM parts to the joined WIM, nor are
1707  * compressed resources re-compressed.
1708  *
1709  * Note: wimlib_export_image() can provide similar functionality to
1710  * wimlib_join(), since it is possible to export all images from a split WIM.
1711  */
1712 extern int
1713 wimlib_join(const wimlib_tchar * const *swms,
1714             unsigned num_swms,
1715             const wimlib_tchar *output_path,
1716             int swm_open_flags,
1717             int wim_write_flags,
1718             wimlib_progress_func_t progress_func);
1719
1720 /**
1721  * Compress a chunk of a WIM resource using LZX compression.
1722  *
1723  * This function is exported for convenience only and need not be used.
1724  *
1725  * @param chunk
1726  *      Uncompressed data of the chunk.
1727  * @param chunk_size
1728  *      Size of the uncompressed chunk, in bytes.
1729  * @param out
1730  *      Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1731  *
1732  * @return
1733  *      The size of the compressed data written to @a out in bytes, or 0 if the
1734  *      data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1735  *
1736  * As a special requirement, the compression code is optimized for the WIM
1737  * format and therefore requires (@a chunk_size <= 32768).
1738  */
1739 extern unsigned
1740 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1741
1742 /**
1743  * Decompresses a block of LZX-compressed data as used in the WIM file format.
1744  *
1745  * Note that this will NOT work unmodified for LZX as used in the cabinet
1746  * format, which is not the same as in the WIM format!
1747  *
1748  * This function is exported for convenience only and need not be used.
1749  *
1750  * @param compressed_data
1751  *      Pointer to the compressed data.
1752  *
1753  * @param compressed_len
1754  *      Length of the compressed data, in bytes.
1755  *
1756  * @param uncompressed_data
1757  *      Pointer to the buffer into which to write the uncompressed data.
1758  *
1759  * @param uncompressed_len
1760  *      Length of the uncompressed data.  It must be 32768 bytes or less.
1761  *
1762  * @return
1763  *      0 on success; non-zero on failure.
1764  */
1765 extern int
1766 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1767                       void *uncompressed_data, unsigned uncompressed_len);
1768
1769
1770 /**
1771  * Mounts an image in a WIM file on a directory read-only or read-write.
1772  *
1773  * This is not supported on Windows.
1774  *
1775  * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1776  * process will be daemonized.
1777  *
1778  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1779  * modifications to the WIM are staged in a temporary directory.
1780  *
1781  * It is safe to mount multiple images from the same WIM file read-only at the
1782  * same time, but only if different ::WIMStruct's are used.  It is @b not safe
1783  * to mount multiple images from the same WIM file read-write at the same time.
1784  *
1785  * wimlib_mount_image() cannot be used on an image that was exported with
1786  * wimlib_export_image() while the dentry trees for both images are still in
1787  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
1788  * that has just been added with wimlib_add_image(), unless the WIM has been
1789  * written and read into a new ::WIMStruct.
1790  *
1791  * @param wim
1792  *      Pointer to the ::WIMStruct containing the image to be mounted.
1793  * @param image
1794  *      The number of the image to mount, indexed starting from it.  It must be
1795  *      an existing, single image.
1796  * @param dir
1797  *      The path to an existing empty directory to mount the image on.
1798  * @param mount_flags
1799  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1800  *      <br/><br/>
1801  *      If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1802  *      rather than the default of read-only.
1803  *      <br/> <br/>
1804  *      WIMs may contain named (alternate) data streams, which are a somewhat
1805  *      obscure NTFS feature.  They can be read and written on a mounted WIM
1806  *      through one of several interfaces.  The interface to use if specified by
1807  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1808  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1809  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
1810  *      the XATTR interface.
1811  * @param additional_swms
1812  *      Array of pointers to the ::WIMStruct for each additional part in the
1813  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1814  *      need to be in any particular order, but they must include all parts of
1815  *      the split WIM other than the first part, which must be provided in the
1816  *      @a wim parameter.
1817  * @param num_additional_swms
1818  *      Number of additional WIM parts provided in the @a additional_swms array.
1819  *      This number should be one less than the total number of parts in the
1820  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1821  * @param staging_dir
1822  *      If non-NULL, the name of a directory in which the staging directory will
1823  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1824  *      in @a mount_flags.  If left @c NULL, the staging directory is created in
1825  *      the same directory as the WIM file that @a wim was originally read from.
1826  *
1827  * @return 0 on success; nonzero on error.
1828  *
1829  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1830  *      A read-write mount was requested, but an an exclusive advisory lock on
1831  *      the on-disk WIM file could not be acquired because another thread or
1832  *      process has mounted an image from the WIM read-write or is currently
1833  *      modifying the WIM in-place.
1834  * @retval ::WIMLIB_ERR_DECOMPRESSION
1835  *      Could not decompress the metadata resource for @a image in @a wim.
1836  * @retval ::WIMLIB_ERR_FUSE
1837  *      A non-zero status was returned by @c fuse_main().
1838  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1839  *      A directory entry in the metadata resource for @a image in @a wim is
1840  *      invalid.
1841  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1842  *      @a image does not specify an existing, single image in @a wim.
1843  * @retval ::WIMLIB_ERR_INVALID_PARAM
1844  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
1845  *      wimlib_export_image(), or @a image has been added with
1846  *      wimlib_add_image().
1847  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1848  *      The metadata resource for @a image in @a wim is invalid.
1849  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1850  *      The security data for @a image in @a wim is invalid.
1851  * @retval ::WIMLIB_ERR_MKDIR
1852  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1853  *      staging directory could not be created.
1854  * @retval ::WIMLIB_ERR_NOMEM
1855  *      Failed to allocate needed memory.
1856  * @retval ::WIMLIB_ERR_NOTDIR
1857  *      Could not determine the current working directory.
1858  * @retval ::WIMLIB_ERR_READ
1859  *      An unexpected end-of-file or read error occurred when trying to read
1860  *      data from the WIM file associated with @a wim.
1861  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1862  *      The WIM is a split WIM, but the parts specified do not form a complete
1863  *      split WIM because they do not include all the parts of the original WIM,
1864  *      there are duplicate parts, or not all the parts have the same GUID and
1865  *      compression type.
1866  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1867  *      The WIM is a split WIM and a read-write mount was requested.  We only
1868  *      support mounting a split WIM read-only.
1869  * @retval ::WIMLIB_ERR_UNSUPPORTED
1870  *      Mounting is not supported, either because the platform is Windows, or
1871  *      because the platform is UNIX and wimlib was compiled with @c
1872  *      --without-fuse.
1873  */
1874 extern int
1875 wimlib_mount_image(WIMStruct *wim,
1876                    int image,
1877                    const wimlib_tchar *dir,
1878                    int mount_flags,
1879                    WIMStruct **additional_swms,
1880                    unsigned num_additional_swms,
1881                    const wimlib_tchar *staging_dir);
1882
1883 /**
1884  * Opens a WIM file and creates a ::WIMStruct for it.
1885  *
1886  * @param wim_file
1887  *      The path to the WIM file to open.
1888  * @param open_flags
1889  *      Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1890  *      ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1891  *      <br/> <br/>
1892  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1893  *      the WIM, if it exists, is checked, and this function will fail with an
1894  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1895  *      digests of the WIM do not exactly match the corresponding message
1896  *      digests given in the integrity table.
1897  *      <br/> <br/>
1898  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1899  *      WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1900  *      returned.  (This flag may be removed in the future, in which case no
1901  *      error will be issued when opening a split WIM.)
1902  *
1903  * @param progress_func
1904  *      If non-NULL, a function that will be called periodically with the
1905  *      progress of the current operation.
1906  *
1907  * @param wim_ret
1908  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1909  *      is written to the memory location pointed to by this parameter.  The
1910  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1911  *      it.
1912  *
1913  * @return 0 on success; nonzero on error.
1914  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1915  *      The lookup table of @a wim_file is compressed.  Support for this can be
1916  *      added to wimlib if needed, but it appears to be the case that the lookup
1917  *      table is never compressed.
1918  * @retval ::WIMLIB_ERR_IMAGE_COUNT
1919  *      The WIM is not the non-first part of a split WIM, and the number of
1920  *      metadata resources found in the WIM did not match the image count given
1921  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
1922  *      data for the WIM did not match the image count given in the WIM header.
1923  * @retval ::WIMLIB_ERR_INTEGRITY
1924  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1925  *      wim_file contains an integrity table, but the SHA1 message digest for a
1926  *      chunk of the WIM does not match the corresponding message digest given
1927  *      in the integrity table.
1928  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1929  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
1930  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1931  *      The header of @a wim_file says that resources in the WIM are compressed,
1932  *      but the header flag indicating LZX or XPRESS compression is not set.
1933  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1934  *      The length field of the WIM header is not 208.
1935  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1936  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1937  *      wim_file contains an integrity table, but the integrity table is
1938  *      invalid.
1939  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1940  *      The lookup table for the WIM contained duplicate entries that are not
1941  *      for metadata resources, or it contained an entry with a SHA1 message
1942  *      digest of all 0's.
1943  * @retval ::WIMLIB_ERR_NOMEM
1944  *      Failed to allocated needed memory.
1945  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1946  *      @a wim_file does not begin with the expected magic characters.
1947  * @retval ::WIMLIB_ERR_OPEN
1948  *      Failed to open the file @a wim_file for reading.
1949  * @retval ::WIMLIB_ERR_READ
1950  *      An unexpected end-of-file or read error occurred when trying to read
1951  *      data from @a wim_file.
1952  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1953  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1954  *      specified in @a open_flags.
1955  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1956  *      A number other than 0x10d00 is written in the version field of the WIM
1957  *      header of @a wim_file.  (Probably a pre-Vista WIM).
1958  * @retval ::WIMLIB_ERR_XML
1959  *      The XML data for @a wim_file is invalid.
1960  */
1961 extern int
1962 wimlib_open_wim(const wimlib_tchar *wim_file,
1963                 int open_flags,
1964                 WIMStruct **wim_ret,
1965                 wimlib_progress_func_t progress_func);
1966
1967 /**
1968  * Overwrites the file that the WIM was originally read from, with changes made.
1969  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1970  * rather than wimlib_create_new_wim().
1971  *
1972  * There are two ways that a WIM may be overwritten.  The first is to do a full
1973  * rebuild.  In this mode, the new WIM is written to a temporary file and then
1974  * renamed to the original file after it is has been completely written.  The
1975  * temporary file is made in the same directory as the original WIM file.  A
1976  * full rebuild may take a while, but can be used even if images have been
1977  * modified or deleted, will produce a WIM with no holes, and has little chance
1978  * of unintentional data loss because the temporary WIM is fsync()ed before
1979  * being renamed to the original WIM.
1980  *
1981  * The second way to overwrite a WIM is by appending to the end of it and
1982  * overwriting the header.  This can be much faster than a full rebuild, but the
1983  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
1984  * begins with writing any new file resources *after* everything in the old WIM,
1985  * even though this will leave a hole where the old lookup table, XML data, and
1986  * integrity were.  This is done so that the WIM remains valid even if the
1987  * operation is aborted mid-write.  The WIM header is only overwritten at the
1988  * very last moment, and up until that point the WIM will be seen as the old
1989  * version.
1990  *
1991  * By default, wimlib_overwrite() does the append-style overwrite described
1992  * above, unless resources in the WIM are arranged in an unusual way or if
1993  * images have been deleted from the WIM.  Use the flag
1994  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1995  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1996  * images have been deleted from the WIM.
1997  *
1998  * In the temporary-file overwrite mode, no changes are made to the WIM on
1999  * failure, and the temporary file is deleted if possible.  Abnormal termination
2000  * of the program will result in the temporary file being orphaned.  In the
2001  * direct append mode, the WIM is truncated to the original length on failure;
2002  * and while abnormal termination of the program will result in extra data
2003  * appended to the original WIM, it should still be a valid WIM.
2004  *
2005  * If this function completes successfully, no more functions should be called
2006  * on @a wim other than wimlib_free().  You must use wimlib_open_wim() to read
2007  * the WIM file anew.
2008  *
2009  * @param wim
2010  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
2011  *      been in-memory changes made to it, which are then reflected in the
2012  *      output file.
2013  * @param write_flags
2014  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2015  *      ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2016  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2017  * @param num_threads
2018  *      Number of threads to use for compression (see wimlib_write()).
2019  * @param progress_func
2020  *      If non-NULL, a function that will be called periodically with the
2021  *      progress of the current operation.
2022  *
2023  * @return 0 on success; nonzero on error.  This function may return any value
2024  * returned by wimlib_write() as well as the following error codes:
2025  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2026  *      The WIM was going to be modifien in-place (with no temporary file), but
2027  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
2028  *      because another thread or process has mounted an image from the WIM
2029  *      read-write or is currently modifying the WIM in-place.
2030  * @retval ::WIMLIB_ERR_NO_FILENAME
2031  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2032  *      than a WIM read with wimlib_open_wim().
2033  * @retval ::WIMLIB_ERR_RENAME
2034  *      The temporary file that the WIM was written to could not be renamed to
2035  *      the original filename of @a wim.
2036  */
2037 extern int
2038 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2039                  wimlib_progress_func_t progress_func);
2040
2041 /**
2042  * Prints information about one image, or all images, contained in a WIM.
2043  *
2044  * @param wim
2045  *      Pointer to the ::WIMStruct for a WIM file.
2046  * @param image
2047  *      The image about which to print information.  Can be the number of an
2048  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2049  *      WIM.
2050  *
2051  * @return This function has no return value.  No error checking is done when
2052  * printing the information.  If @a image is invalid, an error message is
2053  * printed.
2054  */
2055 extern void
2056 wimlib_print_available_images(const WIMStruct *wim, int image);
2057
2058 /**
2059  * Prints the full paths to all files contained in an image, or all images, in a
2060  * WIM file.
2061  *
2062  * @param wim
2063  *      Pointer to the ::WIMStruct for a WIM file.
2064  * @param image
2065  *      Which image to print files for.  Can be the number of an image, or
2066  *      ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2067  *
2068  * @return 0 on success; nonzero on error.
2069  * @retval ::WIMLIB_ERR_DECOMPRESSION
2070  *      The metadata resource for one of the specified images could not be
2071  *      decompressed.
2072  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2073  *      A directory entry in the metadata resource for one of the specified
2074  *      images is invaled.
2075  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2076  *      @a image does not specify a valid image in @a wim, and is not
2077  *      ::WIMLIB_ALL_IMAGES.
2078  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2079  *      The metadata resource for one of the specified images is invalid.
2080  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2081  *      The security data for one of the specified images is invalid.
2082  * @retval ::WIMLIB_ERR_NOMEM
2083  *      Failed to allocate needed memory.
2084  * @retval ::WIMLIB_ERR_READ
2085  *      An unexpected read error or end-of-file occurred when reading the
2086  *      metadata resource for one of the specified images.
2087  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2088  *      @a wim was not a standalone WIM and was not the first part of a split
2089  *      WIM.
2090  */
2091 extern int
2092 wimlib_print_files(WIMStruct *wim, int image);
2093
2094 /**
2095  * Prints detailed information from the header of a WIM file.
2096  *
2097  * @param wim
2098  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2099  *      standalone WIM or part of a split WIM.
2100  *
2101  * @return This function has no return value.
2102  *
2103  */
2104 extern void
2105 wimlib_print_header(const WIMStruct *wim);
2106
2107 /**
2108  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
2109  * digests, as found in the directory entry tree in the WIM file, to file
2110  * resources in the WIM file.  This table includes one entry for each unique
2111  * file in the WIM, so it can be quite long.  There is only one lookup table per
2112  * WIM file, but each split WIM part has its own lookup table.
2113  *
2114  * @param wim
2115  *      Pointer to the ::WIMStruct for a WIM file.
2116  *
2117  * @return This function has no return value.
2118  */
2119 extern void
2120 wimlib_print_lookup_table(WIMStruct *wim);
2121
2122 /**
2123  * Prints the metadata of the specified image in a WIM file.  The metadata
2124  * consists of the security data as well as the directory entry tree.  Each
2125  * image has its own metadata.
2126  *
2127  * @param wim
2128  *      Pointer to the ::WIMStruct for a WIM file.
2129  * @param image
2130  *      Which image to print the metadata for.  Can be the number of an image,
2131  *      or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2132  *
2133  * @return 0 on success; nonzero on error.
2134  * @retval ::WIMLIB_ERR_DECOMPRESSION
2135  *      The metadata resource for one of the specified images could not be
2136  *      decompressed.
2137  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2138  *      A directory entry in the metadata resource for one of the specified
2139  *      images is invaled.
2140  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2141  *      @a image does not specify a valid image in @a wim, and is not
2142  *      ::WIMLIB_ALL_IMAGES.
2143  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2144  *      The metadata resource for one of the specified images is invalid.
2145  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2146  *      The security data for one of the specified images is invalid.
2147  * @retval ::WIMLIB_ERR_NOMEM
2148  *      Failed to allocate needed memory.
2149  * @retval ::WIMLIB_ERR_READ
2150  *      An unexpected read error or end-of-file occurred when reading the
2151  *      metadata resource for one of the specified images.
2152  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2153  *      @a wim was not a standalone WIM and was not the first part of a split
2154  *      WIM.
2155  */
2156 extern int
2157 wimlib_print_metadata(WIMStruct *wim, int image);
2158
2159 /**
2160  * Prints some basic information about a WIM file.  All information printed by
2161  * this function is also printed by wimlib_print_header(), but
2162  * wimlib_print_wim_information() prints some of this information more concisely
2163  * and in a more readable form.
2164  *
2165  * @param wim
2166  *      Pointer to the ::WIMStruct for a WIM file.
2167  *
2168  * @return This function has no return value.
2169  */
2170 extern void
2171 wimlib_print_wim_information(const WIMStruct *wim);
2172
2173 /**
2174  * Translates a string specifying the name or number of an image in the WIM into
2175  * the number of the image.  The images are numbered starting at 1.
2176  *
2177  * @param wim
2178  *      Pointer to the ::WIMStruct for a WIM file.
2179  * @param image_name_or_num
2180  *      A string specifying the name or number of an image in the WIM.  If it
2181  *      parses to a positive integer, this integer is taken to specify the
2182  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
2183  *      be the name of an image, as given in the XML data for the WIM file.  It
2184  *      also may be the keyword "all" or the string "*", both of which will
2185  *      resolve to ::WIMLIB_ALL_IMAGES.
2186  *      <br/> <br/>
2187  *      There is no way to search for an image actually named "all", "*", or an
2188  *      integer number, or an image that has no name.  However, you can use
2189  *      wimlib_get_image_name() to get the name of any image.
2190  *
2191  * @return
2192  *      If the string resolved to a single existing image, the number of that
2193  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
2194  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
2195  *      ::WIMLIB_NO_IMAGE is returned.  If @a image_name_or_num was @c NULL or
2196  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2197  *      images in @a wim has no name.
2198  */
2199 extern int
2200 wimlib_resolve_image(WIMStruct *wim,
2201                      const wimlib_tchar *image_name_or_num);
2202
2203 /**
2204  * Sets which image in the WIM is marked as bootable.
2205  *
2206  * @param wim
2207  *      Pointer to the ::WIMStruct for a WIM file.
2208  * @param boot_idx
2209  *      The number of the image to mark as bootable, or 0 to mark no image as
2210  *      bootable.
2211  * @return 0 on success; nonzero on error.
2212  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2213  *      @a boot_idx does not specify an existing image in @a wim, and it was not
2214  *      0.
2215  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2216  *      @a wim is part of a split WIM.  We do not support changing the boot
2217  *      index of a split WIM.
2218  */
2219 extern int
2220 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2221
2222 /**
2223  * Changes the description of an image in the WIM.
2224  *
2225  * @param wim
2226  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2227  *      standalone WIM or part of a split WIM; however, you should set the same
2228  *      description on all parts of a split WIM.
2229  * @param image
2230  *      The number of the image for which to change the description.
2231  * @param description
2232  *      The new description to give the image.  It may be @c NULL, which
2233  *      indicates that the image is to be given no description.
2234  *
2235  * @return 0 on success; nonzero on error.
2236  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2237  *      @a image does not specify a single existing image in @a wim.
2238  * @retval ::WIMLIB_ERR_NOMEM
2239  *      Failed to allocate the memory needed to duplicate the @a description
2240  *      string.
2241  */
2242 extern int
2243 wimlib_set_image_descripton(WIMStruct *wim, int image,
2244                             const wimlib_tchar *description);
2245
2246 /**
2247  * Changes what is written in the \<FLAGS\> element in the WIM XML data
2248  * (something like "Core" or "Ultimate")
2249  *
2250  * @param wim
2251  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2252  *      standalone WIM or part of a split WIM; however, you should set the same
2253  *      \<FLAGS\> element on all parts of a split WIM.
2254  * @param image
2255  *      The number of the image for which to change the description.
2256  * @param flags
2257  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
2258  *      indicates that the image is to be given no \<FLAGS\> element.
2259  *
2260  * @return 0 on success; nonzero on error.
2261  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2262  *      @a image does not specify a single existing image in @a wim.
2263  * @retval ::WIMLIB_ERR_NOMEM
2264  *      Failed to allocate the memory needed to duplicate the @a flags string.
2265  */
2266 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2267                                   const wimlib_tchar *flags);
2268
2269 /**
2270  * Changes the name of an image in the WIM.
2271  *
2272  * @param wim
2273  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2274  *      standalone WIM or part of a split WIM; however, you should set the same
2275  *      name on all parts of a split WIM.
2276  * @param image
2277  *      The number of the image for which to change the name.
2278  * @param name
2279  *      The new name to give the image.  It must be a nonempty string.
2280  *
2281  * @return 0 on success; nonzero on error.
2282  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2283  *      There is already an image named @a name in @a wim.
2284  * @retval ::WIMLIB_ERR_INVALID_PARAM
2285  *      @a name was @c NULL or the empty string.
2286  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2287  *      @a image does not specify a single existing image in @a wim.
2288  * @retval ::WIMLIB_ERR_NOMEM
2289  *      Failed to allocate the memory needed to duplicate the @a name string.
2290  */
2291 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2292                                  const wimlib_tchar *name);
2293
2294 /**
2295  * Set the functions that wimlib uses to allocate and free memory.
2296  *
2297  * These settings are global and not per-WIM.
2298  *
2299  * The default is to use the default @c malloc() and @c free() from the C
2300  * library.
2301  *
2302  * Please note that some external functions, such as those in @c libntfs-3g, may
2303  * use the standard memory allocation functions.
2304  *
2305  * @param malloc_func
2306  *      A function equivalent to @c malloc() that wimlib will use to allocate
2307  *      memory.  If @c NULL, the allocator function is set back to the default
2308  *      @c malloc() from the C library.
2309  * @param free_func
2310  *      A function equivalent to @c free() that wimlib will use to free memory.
2311  *      If @c NULL, the free function is set back to the default @c free() from
2312  *      the C library.
2313  * @param realloc_func
2314  *      A function equivalent to @c realloc() that wimlib will use to reallocate
2315  *      memory.  If @c NULL, the free function is set back to the default @c
2316  *      realloc() from the C library.
2317  * @return 0 on success; nonzero on error.
2318  * @retval ::WIMLIB_ERR_UNSUPPORTED
2319  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
2320  *      so custom memory allocators are unsupported.
2321  */
2322 extern int
2323 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2324                             void (*free_func)(void *),
2325                             void *(*realloc_func)(void *, size_t));
2326
2327 /**
2328  * Sets whether wimlib is to print error messages to @c stderr when a function
2329  * fails.  These error messages may provide information that cannot be
2330  * determined only from the error code that is returned.  Not every error will
2331  * result in an error message being printed.
2332  *
2333  * This setting is global and not per-WIM.
2334  *
2335  * By default, error messages are not printed.
2336  *
2337  * @param show_messages
2338  *      @c true if error messages are to be printed; @c false if error messages
2339  *      are not to be printed.
2340  *
2341  * @return 0 on success; nonzero on error.
2342  * @retval ::WIMLIB_ERR_UNSUPPORTED
2343  *      @a show_messages was @c true, but wimlib was compiled with the @c
2344  *      --without-error-messages option.   Therefore, error messages cannot be
2345  *      shown.
2346  */
2347 extern int
2348 wimlib_set_print_errors(bool show_messages);
2349
2350 /**
2351  * Splits a WIM into multiple parts.
2352  *
2353  * @param wim
2354  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
2355  *      WIM.
2356  * @param swm_name
2357  *      Name of the SWM file to create.  This will be the name of the first
2358  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
2359  *      appended before the suffix.
2360  * @param part_size
2361  *      The maximum size per part, in bytes.  It is not guaranteed that this
2362  *      will really be the maximum size per part, because some file resources in
2363  *      the WIM may be larger than this size, and the WIM file format provides
2364  *      no way to split up file resources among multiple WIMs.
2365  * @param write_flags
2366  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2367  *      included in the split WIM parts.
2368  * @param progress_func
2369  *      If non-NULL, a function that will be called periodically with the
2370  *      progress of the current operation.
2371  *
2372  * @return 0 on success; nonzero on error.  This function may return any value
2373  * returned by wimlib_write() as well as the following error codes:
2374  *
2375  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2376  *      @a wim is not part 1 of a stand-alone WIM.
2377  * @retval ::WIMLIB_ERR_INVALID_PARAM
2378  *      @a swm_name was @c NULL, or @a part_size was 0.
2379  *
2380  * Note: the WIM's uncompressed and compressed resources are not checksummed
2381  * when they are copied from the joined WIM to the split WIM parts, nor are
2382  * compressed resources re-compressed.
2383  */
2384 extern int
2385 wimlib_split(WIMStruct *wim,
2386              const wimlib_tchar *swm_name,
2387              size_t part_size,
2388              int write_flags,
2389              wimlib_progress_func_t progress_func);
2390
2391 /**
2392  * Unmounts a WIM image that was mounted using wimlib_mount_image().
2393  *
2394  * The image to unmount is specified by the path to the mountpoint, not the
2395  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2396  * touched and also may have been allocated in a different process.
2397  *
2398  * To unmount the image, the thread calling this function communicates with the
2399  * thread that is managing the mounted WIM image.  This function blocks until it
2400  * is known whether the unmount succeeded or failed.  In the case of a
2401  * read-write mounted WIM, the unmount is not considered to have succeeded until
2402  * all changes have been saved to the underlying WIM file.
2403  *
2404  * @param dir
2405  *      The directory that the WIM image was mounted on.
2406  * @param unmount_flags
2407  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2408  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2409  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
2410  *      mounts.
2411  * @param progress_func
2412  *      If non-NULL, a function that will be called periodically with the
2413  *      progress of the current operation.
2414  *
2415  * @return 0 on success; nonzero on error.
2416  *
2417  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2418  *      The filesystem daemon was unable to remove the staging directory and the
2419  *      temporary files that it contains.
2420  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2421  *      The filesystem daemon appears to have terminated before sending an exit
2422  *      status.
2423  * @retval ::WIMLIB_ERR_FORK
2424  *      Could not @c fork() the process.
2425  * @retval ::WIMLIB_ERR_FUSERMOUNT
2426  *      The @b fusermount program could not be executed or exited with a failure
2427  *      status.
2428  * @retval ::WIMLIB_ERR_MQUEUE
2429  *      Could not open a POSIX message queue to communicate with the filesystem
2430  *      daemon servicing the mounted filesystem, could not send a message
2431  *      through the queue, or could not receive a message through the queue.
2432  * @retval ::WIMLIB_ERR_NOMEM
2433  *      Failed to allocate needed memory.
2434  * @retval ::WIMLIB_ERR_OPEN
2435  *      The filesystem daemon could not open a temporary file for writing the
2436  *      new WIM.
2437  * @retval ::WIMLIB_ERR_READ
2438  *      A read error occurred when the filesystem daemon tried to a file from
2439  *      the staging directory
2440  * @retval ::WIMLIB_ERR_RENAME
2441  *      The filesystem daemon failed to rename the newly written WIM file to the
2442  *      original WIM file.
2443  * @retval ::WIMLIB_ERR_UNSUPPORTED
2444  *      Mounting is not supported, either because the platform is Windows, or
2445  *      because the platform is UNIX and wimlib was compiled with @c
2446  *      --without-fuse.
2447  * @retval ::WIMLIB_ERR_WRITE
2448  *      A write error occurred when the filesystem daemon was writing to the new
2449  *      WIM file, or the filesystem daemon was unable to flush changes that had
2450  *      been made to files in the staging directory.
2451  */
2452 extern int
2453 wimlib_unmount_image(const wimlib_tchar *dir,
2454                      int unmount_flags,
2455                      wimlib_progress_func_t progress_func);
2456
2457 /**
2458  * Update a WIM image by adding, deleting, and/or renaming files or directories.
2459  *
2460  * @param wim
2461  *      Pointer to the ::WIMStruct for the WIM file to update.
2462  * @param image
2463  *      The 1-based index of the image in the WIM to update.  It cannot be
2464  *      ::WIMLIB_ALL_IMAGES.
2465  * @param cmds
2466  *      An array of ::wimlib_update_command's that specify the update operations
2467  *      to perform.
2468  * @param num_cmds
2469  *      Number of commands in @a cmds.
2470  * @param update_flags
2471  *      Reserved; must be 0.
2472  * @param progress_func
2473  *      If non-NULL, a function that will be called periodically with the
2474  *      progress of the current operation.
2475  *
2476  * @return 0 on success; nonzero on error.  On failure, some but not all of the
2477  * update commands may have been executed.  No individual update command will
2478  * have been partially executed.  Possible error codes include:
2479  *
2480  * @retval ::WIMLIB_ERR_DECOMPRESSION
2481  *      Failed to decompress the metadata resource from @a image in @a wim.
2482  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2483  *      The capture configuration structure specified for an add command was
2484  *      invalid.
2485  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2486  *      A directory entry for @a image in @a wim is invalid.
2487  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2488  *      @a image did not specify a single, existing image in @a wim.
2489  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2490  *      Attempted to perform an add command that conflicted with previously
2491  *      existing files in the WIM when an overlay was attempted.
2492  * @retval ::WIMLIB_ERR_INVALID_PARAM
2493  *      An unknown operation type was specified in the update commands; or,
2494  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2495  *      in the @a add_flags, but the same image had previously already been
2496  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2497  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2498  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2499  *      specified in the @a add_flags for an add command in which @a
2500  *      wim_target_path was not the root directory of the WIM image.
2501  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2502  *      (Windows only):  While executing an add command, tried to capture a
2503  *      reparse point with invalid data.
2504  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2505  *      The metadata resource for @a image in @a wim is invalid.
2506  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2507  *      The security data for image @a image in @a wim is invalid.
2508  * @retval ::WIMLIB_ERR_IS_DIRECTORY
2509  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2510  *      for a WIM path that corresponded to a directory; or, a rename command
2511  *      attempted to rename a directory to a non-directory.
2512  * @retval ::WIMLIB_ERR_NOMEM
2513  *      Failed to allocate needed memory.
2514  * @retval ::WIMLIB_ERR_NOTDIR
2515  *      A rename command attempted to rename a directory to a non-directory; or,
2516  *      an add command was executed that attempted to set the root of the WIM
2517  *      image as a non-directory; or, a path component used as a directory in a
2518  *      rename command was not, in fact, a directory.
2519  * @retval ::WIMLIB_ERR_NOTEMPTY
2520  *      A rename command attempted to rename a directory to a non-empty
2521  *      directory.
2522  * @retval ::WIMLIB_ERR_NTFS_3G
2523  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2524  *      error occurred while reading data from the NTFS volume using libntfs-3g.
2525  * @retval ::WIMLIB_ERR_OPEN
2526  *      Failed to open a file to be captured while executing an add command.
2527  * @retval ::WIMLIB_ERR_OPENDIR
2528  *      Failed to open a directory to be captured while executing an add command.
2529  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2530  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2531  *      WIM path that did not exist; or, a rename command attempted to rename a
2532  *      file that does not exist.
2533  * @retval ::WIMLIB_ERR_READ
2534  *      Failed to read the metadata resource for @a image in @a wim; or, while
2535  *      executing an add command, failed to read data from a file or directory
2536  *      to be captured.
2537  * @retval ::WIMLIB_ERR_READLINK
2538  *      While executing an add command, failed to read the target of a symbolic
2539  *      link or junction point.
2540  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2541  *      (Windows only) Failed to perform a reparse point fixup because of
2542  *      problems with the data of a reparse point.
2543  * @retval ::WIMLIB_ERR_SPECIAL_FILE
2544  *      While executing an add command, attempted to capture a file that was not
2545  *      a supported file type, such as a regular file, directory, symbolic link,
2546  *      or (on Windows) a reparse point.
2547  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2548  *      @a wim is part of a split WIM.  Updating a split WIM is unsupported.
2549  * @retval ::WIMLIB_ERR_STAT
2550  *      While executing an add command, failed to get attributes for a file or
2551  *      directory.
2552  * @retval ::WIMLIB_ERR_UNSUPPORTED
2553  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2554  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
2555  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2556  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2557  *      add_flags for an update command.
2558  */
2559 extern int
2560 wimlib_update_image(WIMStruct *wim,
2561                     int image,
2562                     const struct wimlib_update_command *cmds,
2563                     size_t num_cmds,
2564                     int update_flags,
2565                     wimlib_progress_func_t progress_func);
2566
2567 /**
2568  * Writes a standalone WIM to a file.
2569  *
2570  * This brings in resources from any external locations, such as directory trees
2571  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2572  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2573  *
2574  * @param wim
2575  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
2576  *      changes made to it, which are then reflected in the output file.
2577  * @param path
2578  *      The path to the file to write the WIM to.
2579  * @param image
2580  *      The image inside the WIM to write.  Use ::WIMLIB_ALL_IMAGES to include all
2581  *      images.
2582  * @param write_flags
2583  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2584  *      ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2585  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2586  * @param num_threads
2587  *      Number of threads to use for compressing data.  If 0, the number of
2588  *      threads is taken to be the number of online processors.  Note: if no
2589  *      data compression needs to be done, no additional threads will be created
2590  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
2591  *      exporting an image from a compressed WIM to another WIM of the same
2592  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2593  *      write_flags).
2594  * @param progress_func
2595  *      If non-NULL, a function that will be called periodically with the
2596  *      progress of the current operation.
2597  *
2598  * @return 0 on success; nonzero on error.
2599  * @retval ::WIMLIB_ERR_DECOMPRESSION
2600  *      Failed to decompress a metadata or file resource in @a wim.
2601  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2602  *      A directory entry in the metadata resource for @a image in @a wim is
2603  *      invalid.
2604  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2605  *      @a image does not specify a single existing image in @a wim, and is not
2606  *      ::WIMLIB_ALL_IMAGES.
2607  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2608  *      A file that had previously been scanned for inclusion in the WIM by
2609  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
2610  *      message digest check.
2611  * @retval ::WIMLIB_ERR_INVALID_PARAM
2612  *      @a path was @c NULL.
2613  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2614  *      The metadata resource for @a image in @a wim is invalid.
2615  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2616  *      The security data for @a image in @a wim is invalid.
2617  * @retval ::WIMLIB_ERR_NOMEM
2618  *      Failed to allocate needed memory.
2619  * @retval ::WIMLIB_ERR_OPEN
2620  *      Failed to open @a path for writing, or some file resources in @a
2621  *      wim refer to files in the outside filesystem, and one of these files
2622  *      could not be opened for reading.
2623  * @retval ::WIMLIB_ERR_READ
2624  *      An error occurred when trying to read data from the WIM file associated
2625  *      with @a wim, or some file resources in @a wim refer to files in the
2626  *      outside filesystem, and a read error occurred when reading one of these
2627  *      files.
2628  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2629  *      @a wim is part of a split WIM.  You may not call this function on a
2630  *      split WIM.
2631  * @retval ::WIMLIB_ERR_WRITE
2632  *      An error occurred when trying to write data to the new WIM file at @a
2633  *      path.
2634  */
2635 extern int
2636 wimlib_write(WIMStruct *wim,
2637              const wimlib_tchar *path,
2638              int image,
2639              int write_flags,
2640              unsigned num_threads,
2641              wimlib_progress_func_t progress_func);
2642
2643 /**
2644  * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2645  * the data using "XPRESS" compression.
2646  */
2647 extern unsigned
2648 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2649
2650 /**
2651  * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2652  * the data is compressed using "XPRESS" compression.
2653  */
2654 extern int
2655 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2656                          void *uncompressed_data, unsigned uncompressed_len);
2657
2658 #endif /* _WIMLIB_H */