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