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