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