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