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