Update to v1.2.7
[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.2.7.  If you
35  * have installed wimlib and want to know how to use the @c imagex program,
36  * please see the man pages instead.
37  *
38  * wimlib is a C library to read, write, and mount archive files in the Windows
39  * Imaging Format (WIM files).  These files are normally created using the @c
40  * imagex.exe utility on Windows, but this library provides a free
41  * implementetion of @c imagex for UNIX-based systems and an API to allow other
42  * programs to read, write, and mount WIM files.  wimlib is comparable to
43  * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
44  *
45  * \section format WIM files
46  *
47  * A <b>Windows Imaging (WIM)</b> file is an archive.  Like some other archive
48  * formats such as ZIP, files in WIM archives may be compressed.  WIM archives
49  * support two Microsoft-specific compression formats:  @b LZX and @b XPRESS.
50  * Both are based on LZ77 and Huffman encoding, and both are supported by
51  * wimlib.
52  *
53  * Unlike ZIP files, WIM files can contain multiple independent toplevel
54  * directory trees known as @a images.  While each image has its own metadata,
55  * files are not duplicated for each image; instead, each file is included only
56  * once in the entire WIM. Microsoft did this so that in one WIM file, they
57  * could do things like have 5 different versions of Windows that are almost
58  * exactly the same.
59  *
60  * Microsoft provides documentation for the WIM file format, XPRESS compression
61  * format, and LZX compression format.  The XPRESS documentation is acceptable,
62  * but the LZX documentation is not entirely correct, and the WIM documentation
63  * itself is incomplete.
64  *
65  * A WIM file may be either stand-alone or split into multiple parts.
66  *
67  * \section ntfs NTFS support
68  *
69  * As of version 1.0.0, wimlib supports capturing and applying images directly
70  * to NTFS volumes.  This was made possible with the help of libntfs-3g from the
71  * NTFS-3g project.  This feature supports capturing and restoring NTFS-specific
72  * data such as security descriptors, alternate data streams, and reparse point
73  * data.
74
75  * The code for NTFS image capture and image application is complete enough that
76  * it is possible to apply an image from the "install.wim" contained in recent
77  * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
78  * NTFS volume, and then boot Windows from it after preparing the Boot
79  * Configuration Data.  In addition, a Windows installation can be captured (or
80  * backed up) into a WIM file, and then re-applied later.
81  *
82  * \section winpe Windows PE
83  *
84  * A major use for this library is to create customized images of Windows PE, the
85  * Windows Preinstallation Environment, without having to rely on Windows.  Windows
86  * PE is a lightweight version of Windows that can run entirely from memory and can
87  * be used to install Windows from local media or a network drive or perform
88  * maintenance.  Windows PE is the operating system that runs when you boot from
89  * the Windows installation media.
90  *
91  * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
92  * or Windows 8, in the file @c sources/boot.wim.  Windows PE can also be found
93  * in the Windows Automated Installation Kit (WAIK), which is free to download
94  * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
95  * install either the @c cabextract or @c p7zip programs.
96  *
97  * In addition, Windows installations and recovery partitions frequently contain a
98  * WIM containing an image of the Windows Recovery Environment, which is similar to
99  * Windows PE.
100  *
101  * \section starting Getting Started
102  *
103  * wimlib uses the GNU autotools, so it should be easy to install with
104  * <code>configure && make && sudo make install</code>; however, please see the
105  * README for more information about installing it.  To use wimlib in a program
106  * after installing it, include @c wimlib.h and link your program with @c -lwim.
107  *
108  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.  A ::WIMStruct
109  * may represent either a stand-alone WIM or one part of a split WIM.
110  *
111  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
112  * return an integer error code on failure.  Use wimlib_get_error_string() to
113  * get a string that describes an error code.  wimlib also can print error
114  * messages itself when an error happens, and these may be more informative than
115  * the error code; to enable this, call wimlib_set_print_errors().  Please note
116  * that this is for convenience only, and some errors can occur without a
117  * message being printed.
118  *
119  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
120  * the following exceptions:
121  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
122  * - You also must call wimlib_global_init() in the main thread to avoid any
123  *   race conditions with one-time allocations of memory.
124  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
125  *   concurrently in the same process, will daemonize the entire process when it
126  *   does so for the first time.  This includes changing the working directory
127  *   to the root directory.
128  *
129  * To open an existing WIM, use wimlib_open_wim().
130  *
131  * To create a new WIM that initially contains no images, use
132  * wimlib_create_new_wim().
133  *
134  * To add an image to a WIM file from a directory tree on your filesystem, call
135  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
136  * wimlib_open_wim() or from wimlib_create_new_wim().  wimlib_add_image() can
137  * also capture a WIM image directly from a NTFS volume if you provide the
138  * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
139  * the <code>--without-ntfs-3g</code> flag.
140  *
141  * To extract an image from a WIM file, call wimlib_extract_image().  You may
142  * extract an image either to a directory or directly to a NTFS volume, the
143  * latter of which will preserve NTFS-specific data such as security
144  * descriptors.
145  *
146  * wimlib supports mounting WIM files either read-only or read-write.  Mounting
147  * is done using wimlib_mount_image() and unmounting is done using
148  * wimlib_unmount_image().  Mounting can be done without root privileges because
149  * it is implemented using FUSE (Filesystem in Userspace).  If wimlib is
150  * compiled with the <code>--without-fuse</code> flag, these functions will be
151  * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
152  *
153  * After creating or modifying a WIM file, you can write it to a file using
154  * wimlib_write().  Alternatively,  if the WIM was originally read from a file
155  * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
156  * wimlib_overwrite() to overwrite the original file.
157  *
158  * Please note: merely by calling wimlib_add_image() or many of the other
159  * functions in this library that operate on ::WIMStruct's, you are @b not
160  * modifying the WIM file on disk.  Changes are not saved until you explicitly
161  * call wimlib_write() or wimlib_overwrite().
162  *
163  * After you are done with the WIM file, use wimlib_free() to free all memory
164  * associated with a ::WIMStruct and close all files associated with it.
165  *
166  * A number of functions take a pointer to a progress function of type
167  * ::wimlib_progress_func_t.  This function will be called periodically during
168  * the WIM operation(s) to report on the progress of the operation (for example,
169  * how many bytes have been written so far).
170  *
171  * \section imagex imagex
172  *
173  * wimlib comes with a command-line interface, the @b imagex program.  It is
174  * documented with man pages.  See its source code (@c programs/imagex.c in
175  * wimlib's source tree) for an example of how to use wimlib in your program.
176  *
177  * \section mkwinpeimg mkwinpeimg
178  *
179  * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
180  * man page.
181  *
182  * \section Limitations
183  *
184  * While wimlib supports the main features of WIM files, wimlib currently has
185  * the following limitations:
186  * - wimlib cannot be used on MS-Windows.
187  * - There is no way to add, remove, modify, or extract specific files in a WIM
188  *   without mounting it, other than by adding, removing, or extracting an
189  *   entire image.  The FUSE mount feature should be used for this purpose.
190  * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
191  *   than wimlib when using maximum (LZX) compression because it knows how to
192  *   split up LZX compressed blocks, which is not yet implemented in wimlib.
193  * - wimlib is experimental and likely contains bugs; use Microsoft's @a
194  *   imagex.exe if you want to make sure your WIM files are made "correctly".
195  * - The old WIM format from Vista pre-releases is not supported.
196  * - Compressed resource chunk sizes other than 32768 are not supported,
197  *   although this doesn't seem to be a problem because the chunk size always
198  *   seems to be this value.
199  * - wimlib does not provide a clone of the @b PEImg tool that allows you to
200  *   make certain Windows-specific modifications to a Windows PE image, such as
201  *   adding a driver or Windows component.  Such a tool could conceivably be
202  *   implemented on top of wimlib, although it likely would be hard to implement
203  *   because it would have to do very Windows-specific things such as
204  *   manipulating the driver store.  wimlib does provide the @b mkwinpeimg
205  *   script for a similar purpose, however.  With regards to adding drivers to
206  *   Windows PE, you have the option of putting them anywhere in the Windows PE
207  *   image, then loading them after boot using @b drvload.exe.
208  *
209  * \section legal License
210  *
211  * The wimlib library, as well as the programs and scripts distributed with it
212  * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
213  * License version 3 or later.
214  */
215
216 #ifndef _WIMLIB_H
217 #define _WIMLIB_H
218
219 #include <stdio.h>
220 #include <stddef.h>
221 #include <stdbool.h>
222 #include <inttypes.h>
223
224 /** Major version of the library (for example, the 1 in 1.2.5). */
225 #define WIMLIB_MAJOR_VERSION 1
226
227 /** Minor version of the library (for example, the 2 in 1.2.5). */
228 #define WIMLIB_MINOR_VERSION 2
229
230 /** Patch version of the library (for example, the 5 in 1.2.5). */
231 #define WIMLIB_PATCH_VERSION 7
232
233 /**
234  * Opaque structure that represents a WIM file.  This is an in-memory structure
235  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
236  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
237  * continuing to exist so that data can be read from it as needed.
238  *
239  * Most functions in this library will work the same way regardless of whether a
240  * given ::WIMStruct was obtained through wimlib_open_wim() or
241  * wimlib_create_new_wim().  Exceptions are documented.
242  *
243  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
244  * file from a ::WIMStruct.
245  */
246 typedef struct WIMStruct WIMStruct;
247
248 /**
249  * Specifies the compression type of a WIM file.
250  */
251 enum wimlib_compression_type {
252         /** An invalid compression type. */
253         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
254
255         /** The WIM does not include any compressed resources. */
256         WIMLIB_COMPRESSION_TYPE_NONE = 0,
257
258         /** Compressed resources in the WIM use LZX compression. */
259         WIMLIB_COMPRESSION_TYPE_LZX = 1,
260
261         /** Compressed resources in the WIM use XPRESS compression. */
262         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
263 };
264
265 /** Possible values of the first parameter to the user-supplied
266  * ::wimlib_progress_func_t progress function */
267 enum wimlib_progress_msg {
268
269         /** A WIM image is about to be extracted.  @a info will point to
270          * ::wimlib_progress_info.extract. */
271         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
272
273         /** The directory structure of the WIM image is about to be extracted.
274          * @a info will point to ::wimlib_progress_info.extract. */
275         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
276
277         /** The directory structure of the WIM image has been successfully
278          * extracted.  @a info will point to ::wimlib_progress_info.extract. */
279         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
280
281         /** The WIM image's files resources are currently being extracted.  @a
282          * info will point to ::wimlib_progress_info.extract. */
283         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
284
285         /** A file or directory is being extracted.  @a info will point to
286          * ::wimlib_progress_info.extract, and the @a cur_path member will be
287          * valid. */
288         WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
289
290         /** All the WIM files and directories have been extracted, and
291          * timestamps are about to be applied.  @a info will point to
292          * ::wimlib_progress_info.extract. */
293         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
294
295         /** A WIM image has been successfully extracted.  @a info will point to
296          * ::wimlib_progress_info.extract. */
297         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
298
299         /** The directory or NTFS volume is about to be scanned to build a tree
300          * of WIM dentries in-memory.  @a info will point to
301          * ::wimlib_progress_info.scan. */
302         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
303
304         /** A directory or file is being scanned.  @a info will point to
305          * ::wimlib_progress_info.scan, and its @a cur_path member will be
306          * valid.  This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
307          * is passed to wimlib_add_image(). */
308         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
309
310         /** The directory or NTFS volume has been successfully scanned, and a
311          * tree of WIM dentries has been built in-memory. @a info will point to
312          * ::wimlib_progress_info.scan. */
313         WIMLIB_PROGRESS_MSG_SCAN_END,
314
315         /**
316          * File resources are currently being written to the WIM.
317          * @a info will point to ::wimlib_progress_info.write_streams. */
318         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
319
320         /**
321          * The metadata resource for each image is about to be written to the
322          * WIM. @a info will not be valid. */
323         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
324
325         /**
326          * The metadata resource for each image has successfully been writen to
327          * the WIM.  @a info will not be valid. */
328         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
329
330         /**
331          * The temporary file has successfully been renamed to the original WIM
332          * file.  Only happens when wimlib_overwrite() is called and the
333          * overwrite is not done in-place.
334          * @a info will point to ::wimlib_progress_info.rename. */
335         WIMLIB_PROGRESS_MSG_RENAME,
336
337         /** The contents of the WIM are being checked against the integrity
338          * table.  Only happens when wimlib_open_wim() is called with the
339          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  @a info will point to
340          * ::wimlib_progress_info.integrity. */
341         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
342
343         /** An integrity table is being calculated for the WIM being written.
344          * Only happens when wimlib_write() or wimlib_overwrite() is called with
345          * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag.  @a info will point to
346          * ::wimlib_progress_info.integrity. */
347         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
348
349         /** A wimlib_join() operation is in progress.  @a info will point to
350          * ::wimlib_progress_info.join. */
351         WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
352
353         /** A wimlib_split() operation is in progress, and a new split part is
354          * about to be started.  @a info will point to
355          * ::wimlib_progress_info.split. */
356         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
357
358         /** A wimlib_split() operation is in progress, and a split part has been
359          * finished. @a info will point to ::wimlib_progress_info.split. */
360         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
361 };
362
363 /** A pointer to this union is passed to the user-supplied
364  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
365  * contained in this union will be applicable for the operation
366  * (::wimlib_progress_msg) indicated in the first argument to the progress
367  * function. */
368 union wimlib_progress_info {
369
370         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
371          * document them if they aren't given a name... */
372
373         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
374         struct wimlib_progress_info_write_streams {
375                 /** Number of bytes that are going to be written for all the
376                  * streams combined.  This is the amount in uncompressed data.
377                  * (The actual number of bytes will be less if the data is being
378                  * written compressed.) */
379                 uint64_t total_bytes;
380                 /** Number of streams that are going to be written. */
381                 uint64_t total_streams;
382
383                 /** Number of uncompressed bytes that have been written so far.
384                  * Will be 0 initially, and equal to @a total_bytes at the end.
385                  * */
386                 uint64_t completed_bytes;
387
388                 /** Number of streams that have been written.  Will be 0
389                  * initially, and equal to @a total_streams at the end. */
390                 uint64_t completed_streams;
391
392                 /** Number of threads that are being used to compress resources
393                  * (if applicable). */
394                 unsigned num_threads;
395
396                 /** The compression type being used to write the streams; either
397                  * ::WIMLIB_COMPRESSION_TYPE_NONE,
398                  * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
399                  * ::WIMLIB_COMPRESSION_TYPE_LZX. */
400                 int      compression_type;
401         } write_streams;
402
403         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
404          * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
405         struct wimlib_progress_info_scan {
406                 /** Directory or NTFS volume that is being scanned. */
407                 const char *source;
408
409                 /** Path to the file or directory that is about to be scanned,
410                  * relative to the root of the image capture or the NTFS volume.
411                  * */
412                 const char *cur_path;
413
414                 /** True iff @a cur_path is being excluded from the image
415                  * capture due to the capture configuration file. */
416                 bool excluded;
417
418                 /** Target path in the WIM.  Only valid on messages
419                  * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
420                  * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
421                 const char *wim_target_path;
422         } scan;
423
424         /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
425          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
426          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
427          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
428          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
429         struct wimlib_progress_info_extract {
430                 /** Number of the image being extracted (1-based). */
431                 int image;
432
433                 /** Flags passed to to wimlib_extract_image() */
434                 int extract_flags;
435
436                 /** Full path to the WIM file being extracted. */
437                 const char *wimfile_name;
438
439                 /** Name of the image being extracted. */
440                 const char *image_name;
441
442                 /** Directory or NTFS volume to which the image is being
443                  * extracted. */
444                 const char *target;
445
446                 /** Current dentry being extracted.  (Valid only if message is
447                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
448                 const char *cur_path;
449
450                 /** Number of bytes of uncompressed data that will be extracted.
451                  * Takes into account hard links (they are not counted for each
452                  * link.)
453                  * */
454                 uint64_t total_bytes;
455
456                 /** Number of bytes that have been written so far.  Will be 0
457                  * initially, and equal to @a total_bytes at the end. */
458                 uint64_t completed_bytes;
459
460                 /** Number of streams that will be extracted.  This may more or
461                  * less than the number of "files" to be extracted due to
462                  * special cases (hard links, symbolic links, and alternate data
463                  * streams.) */
464                 uint64_t num_streams;
465         } extract;
466
467         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
468         struct wimlib_progress_info_rename {
469                 /** Name of the temporary file that the WIM was written to. */
470                 const char *from;
471
472                 /** Name of the original WIM file to which the temporary file is
473                  * being renamed. */
474                 const char *to;
475         } rename;
476
477         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
478          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
479         struct wimlib_progress_info_integrity {
480                 /** Number of bytes from the end of the WIM header to the end of
481                  * the lookup table (the area that is covered by the SHA1
482                  * integrity checks.) */
483                 uint64_t total_bytes;
484
485                 /** Number of bytes that have been SHA1-summed so far.  Will be
486                  * 0 initially, and equal @a total_bytes at the end. */
487                 uint64_t completed_bytes;
488
489                 /** Number of chunks that the checksummed region is divided
490                  * into. */
491                 uint32_t total_chunks;
492
493                 /** Number of chunks that have been SHA1-summed so far.   Will
494                  * be 0 initially, and equal to @a total_chunks at the end. */
495                 uint32_t completed_chunks;
496
497                 /** Size of the chunks used for the integrity calculation. */
498                 uint32_t chunk_size;
499
500                 /** Filename of the WIM (only valid if the message is
501                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
502                 const char *filename;
503         } integrity;
504
505         /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
506         struct wimlib_progress_info_join {
507                 /** Total number of bytes of compressed data contained in all
508                  * the split WIM part's file and metadata resources. */
509                 uint64_t total_bytes;
510
511                 /** Number of bytes that have been copied to the joined WIM so
512                  * far.  Will be 0 initially, and equal to @a total_bytes at the
513                  * end. */
514                 uint64_t completed_bytes;
515
516                 /** Number of split WIM parts that have had all their file and
517                  * metadata resources copied over to the joined WIM so far. */
518                 unsigned completed_parts;
519
520                 /** Number of split WIM parts. */
521                 unsigned total_parts;
522         } join;
523
524         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
525          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
526         struct wimlib_progress_info_split {
527                 /** Total size of the original WIM's file and metadata resources
528                  * (compressed). */
529                 uint64_t total_bytes;
530
531                 /** Number of bytes of file and metadata resources that have
532                  * been copied out of the original WIM so far.  Will be 0
533                  * initially, and equal to @a total_bytes at the end. */
534                 uint64_t completed_bytes;
535
536                 /** Number of the split WIM part that is about to be started
537                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
538                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
539                 unsigned cur_part_number;
540
541                 /** Name of the split WIM part that is about to be started
542                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
543                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
544                 const char *part_name;
545         } split;
546 };
547
548 /** A user-supplied function that will be called periodically during certain WIM
549  * operations.  The first argument will be the type of operation that is being
550  * performed or is about to be started or has been completed.  The second
551  * argument will be a pointer to one of a number of structures depending on the
552  * first argument.  It may be @c NULL for some message types.
553  *
554  * The return value of the progress function is currently ignored, but it may do
555  * something in the future.  (Set it to 0 for now.)
556  */
557 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
558                                       const union wimlib_progress_info *info);
559
560 /** An array of these structures is passed to wimlib_add_image_multisource() to
561  * specify the sources from which to create a WIM image. */
562 struct wimlib_capture_source {
563         /** Absolute or relative path to a file or directory on the external
564          * filesystem to be included in the WIM image. */
565         char *fs_source_path;
566
567         /** Destination path in the WIM image.  Leading and trailing slashes are
568          * ignored.  The empty string or @c NULL means the root directory of the
569          * WIM image. */
570         char *wim_target_path;
571
572         /** Reserved; set to 0. */
573         long reserved;
574 };
575
576
577 /*****************************
578  * WIMLIB_ADD_IMAGE_FLAG_*   *
579  *****************************/
580
581 /** Directly capture a NTFS volume rather than a generic directory.  This flag
582  * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
583  * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.   */
584 #define WIMLIB_ADD_IMAGE_FLAG_NTFS                      0x00000001
585
586 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
587  * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
588 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE               0x00000002
589
590 /** Call the progress function with the message
591  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
592  * be scanned. */
593 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE                   0x00000004
594
595 /** Mark the image being added as the bootable image of the WIM. */
596 #define WIMLIB_ADD_IMAGE_FLAG_BOOT                      0x00000008
597
598 /** Store the UNIX owner, group, and mode.  This is done by adding a special
599  * alternate data stream to each regular file, symbolic link, and directory to
600  * contain this information.  Please note that this flag is for convenience
601  * only; Microsoft's version of imagex.exe will not understand this special
602  * information.  This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS.
603  * */
604 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA                 0x00000010
605
606 /******************************
607  * WIMLIB_EXPORT_FLAG_* *
608  ******************************/
609
610 /** See documentation for wimlib_export_image(). */
611 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
612
613 /******************************
614  * WIMLIB_EXTRACT_FLAG_*      *
615  ******************************/
616
617 /** Extract the image directly to a NTFS volume rather than a generic directory.
618  * */
619 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
620
621 /** When identical files are extracted from the WIM, always hard link them
622  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
623 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
624
625 /** When identical files are extracted from the WIM, always symlink them
626  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
627 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
628
629 /** Call the progress function with the argument
630  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
631  * extracted.  Note: these calls will be interspersed with calls for the message
632  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
633 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
634
635 /** Read the WIM file sequentially while extracting the image. */
636 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
637
638 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
639  * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
640 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
641
642 /******************************
643  * WIMLIB_MOUNT_FLAG_*        *
644  ******************************/
645
646 /** Mount the WIM image read-write rather than the default of read-only. */
647 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
648
649 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
650 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
651
652 /** Do not allow accessing alternate data streams in the mounted WIM image. */
653 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
654
655 /** Access alternate data streams in the mounted WIM image through extended file
656  * attributes.  This is the default mode. */
657 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
658
659 /** Access alternate data streams in the mounted WIM image by specifying the
660  * file name, a colon, then the alternate file stream name. */
661 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
662
663 /** Use UNIX file owners, groups, and modes if available in the WIM (see
664  * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
665 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
666
667 /** Allow other users to see the mounted filesystem.  (this passes the @c
668  * allow_other option to FUSE mount) */
669 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
670
671 /******************************
672  * WIMLIB_OPEN_FLAG_*         *
673  ******************************/
674
675 /** Verify the WIM contents against the WIM's integrity table, if present. */
676 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
677
678 /** Do not issue an error if the WIM is part of a split WIM. */
679 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
680
681 /******************************
682  * WIMLIB_UNMOUNT_FLAG_*      *
683  ******************************/
684
685 /** Include an integrity table in the WIM after it's been unmounted.  Ignored
686  * for read-only mounts. */
687 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
688
689 /** Unless this flag is given, changes to a read-write mounted WIM are
690  * discarded.  Ignored for read-only mounts. */
691 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
692
693 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
694 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
695
696 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
697 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
698
699 /******************************
700  * WIMLIB_WRITE_FLAG_*        *
701  ******************************/
702
703 /** Include an integrity table in the new WIM file. */
704 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
705
706 /** Re-build the entire WIM file rather than appending data to it, if possible.
707  * (Applies to wimlib_overwrite(), not wimlib_write()). */
708 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000002
709
710 /** Recompress all resources, even if they could otherwise be copied from a
711  * different WIM with the same compression type (in the case of
712  * wimlib_export_image() being called previously). */
713 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000004
714
715 /** Call fsync() when the WIM file is closed */
716 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000008
717
718 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
719  * after one or more calls to wimlib_delete_image(), which is to rebuild the
720  * entire WIM.
721  *
722  * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
723  * correctly remove the image from the WIM will be taken.  In particular, all
724  * streams will be left alone, even if they are no longer referenced.  This is
725  * probably not what you want, because almost no space will be spaced by
726  * deleting an image in this way. */
727 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000010
728
729 /**
730  * Possible values of the error code returned by many functions in wimlib.
731  *
732  * See the documentation for each wimlib function to see specifically what error
733  * codes can be returned by a given function, and what they mean.
734  */
735 /* Note: these are currently in alphabetic order, but new error codes should be
736  * added at the end to maintain a compatible ABI, except when it's being broken
737  * anyway. */
738 enum wimlib_error_code {
739         WIMLIB_ERR_SUCCESS = 0,
740         WIMLIB_ERR_ALREADY_LOCKED,
741         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
742         WIMLIB_ERR_DECOMPRESSION,
743         WIMLIB_ERR_DELETE_STAGING_DIR,
744         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
745         WIMLIB_ERR_FORK,
746         WIMLIB_ERR_FUSE,
747         WIMLIB_ERR_FUSERMOUNT,
748         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
749         WIMLIB_ERR_IMAGE_COUNT,
750         WIMLIB_ERR_IMAGE_NAME_COLLISION,
751         WIMLIB_ERR_INTEGRITY,
752         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
753         WIMLIB_ERR_INVALID_CHUNK_SIZE,
754         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
755         WIMLIB_ERR_INVALID_DENTRY,
756         WIMLIB_ERR_INVALID_HEADER_SIZE,
757         WIMLIB_ERR_INVALID_IMAGE,
758         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
759         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
760         WIMLIB_ERR_INVALID_PARAM,
761         WIMLIB_ERR_INVALID_PART_NUMBER,
762         WIMLIB_ERR_INVALID_RESOURCE_HASH,
763         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
764         WIMLIB_ERR_INVALID_SECURITY_DATA,
765         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
766         WIMLIB_ERR_INVALID_UTF8_STRING,
767         WIMLIB_ERR_INVALID_UTF16_STRING,
768         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
769         WIMLIB_ERR_LINK,
770         WIMLIB_ERR_MKDIR,
771         WIMLIB_ERR_MQUEUE,
772         WIMLIB_ERR_NOMEM,
773         WIMLIB_ERR_NOTDIR,
774         WIMLIB_ERR_NOT_A_WIM_FILE,
775         WIMLIB_ERR_NO_FILENAME,
776         WIMLIB_ERR_NTFS_3G,
777         WIMLIB_ERR_OPEN,
778         WIMLIB_ERR_OPENDIR,
779         WIMLIB_ERR_READLINK,
780         WIMLIB_ERR_READ,
781         WIMLIB_ERR_RENAME,
782         WIMLIB_ERR_REOPEN,
783         WIMLIB_ERR_RESOURCE_ORDER,
784         WIMLIB_ERR_SPECIAL_FILE,
785         WIMLIB_ERR_SPLIT_INVALID,
786         WIMLIB_ERR_SPLIT_UNSUPPORTED,
787         WIMLIB_ERR_STAT,
788         WIMLIB_ERR_TIMEOUT,
789         WIMLIB_ERR_UNKNOWN_VERSION,
790         WIMLIB_ERR_UNSUPPORTED,
791         WIMLIB_ERR_WRITE,
792         WIMLIB_ERR_XML,
793 };
794
795
796 /** Used to indicate that no WIM image or an invalid WIM image. */
797 #define WIMLIB_NO_IMAGE         0
798
799 /** Used to specify all images in the WIM. */
800 #define WIMLIB_ALL_IMAGES       (-1)
801
802 /**
803  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
804  *
805  * The directory tree of NTFS volume is read immediately for the purpose of
806  * constructing a directory entry tree in-memory.  Also, all files are read to
807  * calculate their SHA1 message digests.  However, because the directory tree
808  * may contain a very large amount of data, the files themselves are not read
809  * into memory permanently, and instead references to their paths saved.  The
810  * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
811  * called.
812  *
813  * See the manual page for the @c imagex program for more information about the
814  * "normal" capture mode versus the NTFS capture mode (entered by providing the
815  * flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
816  *
817  * Note that @b no changes are committed to the underlying WIM file (if
818  * any) until wimlib_write() or wimlib_overwrite() is called.
819  *
820  * @param wim
821  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
822  *      added.
823  * @param source
824  *      A path to a directory or unmounted NTFS volume that will be captured as
825  *      a WIM image.
826  * @param name
827  *      The name to give the image.  This must be non-@c NULL.
828  * @param config
829  *      Pointer to the contents of an image capture configuration file.  If @c
830  *      NULL, a default string is used.  Please see the manual page for
831  *      <b>imagex capture</b> for more information.
832  * @param config_len
833  *      Length of the string @a config in bytes, not including an optional
834  *      null-terminator.  Ignored if @a config is @c NULL.
835  * @param add_image_flags
836  *      Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
837  * @param progress_func
838  *      If non-NULL, a function that will be called periodically with the
839  *      progress of the current operation.
840  *
841  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
842  * discarded so that it appears to be in the same state as when this function
843  * was called.
844  *
845  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
846  *      There is already an image named @a name in @a wim.
847  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
848  *      @a config was not @c NULL and did not specify a valid image capture
849  *      configuration.
850  * @retval ::WIMLIB_ERR_INVALID_PARAM
851  *      @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
852  * @retval ::WIMLIB_ERR_NOMEM
853  *      Failed to allocate needed memory.
854  * @retval ::WIMLIB_ERR_NOTDIR
855  *      @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
856  *      not specified in @a add_image_flags).
857  * @retval ::WIMLIB_ERR_NTFS_3G
858  *      An error was returned from a libntfs-3g function when the NTFS volume
859  *      was being opened, scanned, or closed (only if
860  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
861  * @retval ::WIMLIB_ERR_OPEN
862  *      Failed to open a file or directory in the directory tree rooted at @a
863  *      source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
864  *      add_image_flags).
865  * @retval ::WIMLIB_ERR_READ
866  *      Failed to read a file in the directory tree rooted at @a source (only if
867  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
868  * @retval ::WIMLIB_ERR_SPECIAL_FILE
869  *      The directory tree rooted at @a source contains a special file that is
870  *      not a directory, regular file, or symbolic link.  This currently can
871  *      only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
872  *      add_image_flags, but it may be returned for unsupported NTFS files in
873  *      the future.
874  * @retval ::WIMLIB_ERR_STAT
875  *      Failed obtain the metadata for a file or directory in the directory tree
876  *      rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
877  *      specified in @a add_image_flags).
878  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
879  *      @a wim is part of a split WIM.  Adding an image to a split WIM is
880  *      unsupported.
881  * @retval ::WIMLIB_ERR_UNSUPPORTED
882  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
883  *      wimlib was configured with the @c --without-ntfs-3g flag.
884  */
885 extern int wimlib_add_image(WIMStruct *wim, const char *source,
886                             const char *name, const char *config,
887                             size_t config_len, int add_image_flags,
888                             wimlib_progress_func_t progress_func);
889
890 /** This function is equivalent to wimlib_add_image() except it allows for
891  * multiple sources to be combined into a single WIM image.  This is done by
892  * specifying the @a sources and @a num_sources parameters instead of the @a
893  * source parameter.  The rest of the parameters are the same as
894  * wimlib_add_image().  See the documentation for <b>imagex capture</b> for full
895  * details on how this mode works. */
896 extern int wimlib_add_image_multisource(WIMStruct *w,
897                                         struct wimlib_capture_source *sources,
898                                         size_t num_sources,
899                                         const char *name,
900                                         const char *config_str,
901                                         size_t config_len,
902                                         int add_image_flags,
903                                         wimlib_progress_func_t progress_func);
904
905 /**
906  * Creates a ::WIMStruct for a new WIM file.
907  *
908  * This only creates an in-memory structure for a WIM that initially contains no
909  * images.  No on-disk file is created until wimlib_write() is called.
910  *
911  * @param ctype
912  *      The type of compression to be used in the new WIM file.  Must be
913  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
914  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
915  * @param wim_ret
916  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
917  *      written to the memory location pointed to by this paramater.  The
918  *      ::WIMStruct must be freed using using wimlib_free() when finished with
919  *      it.
920  * @return 0 on success; nonzero on error.
921  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
922  *      @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
923  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
924  * @retval ::WIMLIB_ERR_NOMEM
925  *      Failed to allocate needed memory.
926  */
927 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
928
929 /**
930  * Deletes an image, or all images, from a WIM file.
931  *
932  * All streams referenced by the image(s) being deleted are removed from the
933  * lookup table of the WIM if they are not referenced by any other images in the
934  * WIM.
935  *
936  * Please note that @b no changes are committed to the underlying WIM file (if
937  * any) until wimlib_write() or wimlib_overwrite() is called.
938  *
939  * @param wim
940  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
941  *      being deleted.
942  * @param image
943  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
944  *      images.
945  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
946  * to be left unmodified only if @a image specified a single image.  If instead
947  * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
948  * possible for some but not all of the images to have been deleted when a
949  * failure status is returned.
950  *
951  * @retval ::WIMLIB_ERR_DECOMPRESSION
952  *      Could not decompress the metadata resource for @a image.
953  * @retval ::WIMLIB_ERR_INVALID_DENTRY
954  *      A directory entry in the metadata resource for @a image in the WIM is
955  *      invalid.
956  * @retval ::WIMLIB_ERR_INVALID_IMAGE
957  *      @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
958  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
959  *      The metadata resource for @a image in the WIM is invalid.
960  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
961  *      The security data for @a image in the WIM is invalid.
962  * @retval ::WIMLIB_ERR_NOMEM
963  *      Failed to allocate needed memory.
964  * @retval ::WIMLIB_ERR_READ
965  *      Could not read the metadata resource for @a image from the WIM.
966  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
967  *      @a wim is part of a split WIM.  Deleting an image from a split WIM is
968  *      unsupported.
969  */
970 extern int wimlib_delete_image(WIMStruct *wim, int image);
971
972 /**
973  * Exports an image, or all the images, from a WIM file, into another WIM file.
974  *
975  * The destination image is made to share the same dentry tree and security data
976  * structure as the source image.  This places some restrictions on additional
977  * functions that may be called.  wimlib_mount_image() may not be called on
978  * either the source image or the destination image without an intervening call
979  * to a function that un-shares the images, such as wimlib_free() on @a
980  * dest_wim, or wimlib_delete_image() on either the source or destination image.
981  * Furthermore, you may not call wimlib_free() on @a src_wim before calling
982  * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
983  * have references back to @a src_wim.
984  *
985  * Previous versions of this function left @a dest_wim in an indeterminate state
986  * on failure.  This is no longer the case; all changes to @a dest_wim made by
987  * this function are rolled back on failure.
988  *
989  * Previous versions of this function did not allow exporting an image that had
990  * been added by wimlib_add_image().  This is no longer the case; you may now
991  * export an image regardless of how it was added.
992  *
993  * Regardless of whether this function succeeds or fails, no changes are made to
994  * @a src_wim.
995  *
996  * Please note that no changes are committed to the underlying WIM file of @a
997  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
998  *
999  * @param src_wim
1000  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1001  *      WIM that contains the image(s) being exported.
1002  * @param src_image
1003  *      The image to export from @a src_wim.  Can be the number of an image, or
1004  *      ::WIMLIB_ALL_IMAGES to export all images.
1005  * @param dest_wim
1006  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
1007  *      being exported.
1008  * @param dest_name
1009  *      The name to give the exported image in the new WIM file.  If left @c
1010  *      NULL, the name from @a src_wim is used.  This parameter must be left @c
1011  *      NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1012  *      than one image; in that case, the names are all taken from the @a
1013  *      src_wim.  (This is allowed even if one or more images being exported has
1014  *      no name.)
1015  * @param dest_description
1016  *      The description to give the exported image in the new WIM file.  If left
1017  *      @c NULL, the description from the @a src_wim is used.  This parameter must
1018  *      be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1019  *      more than one image; in that case, the descriptions are all taken from
1020  *      @a src_wim.  (This is allowed even if one or more images being exported
1021  *      has no description.)
1022  * @param export_flags
1023  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1024  *      bootable, or 0 if which image is marked as bootable in the destination
1025  *      WIM is to be left unchanged.  If @a src_image is ::WIMLIB_ALL_IMAGES and
1026  *      there are multiple images in @a src_wim, specifying
1027  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1028  *      currently marked as bootable in @a src_wim; if that is the case, then
1029  *      that image is marked as bootable in the destination WIM.
1030  * @param additional_swms
1031  *      Array of pointers to the ::WIMStruct for each additional part in the
1032  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1033  *      need to be in any particular order, but they must include all parts of
1034  *      the split WIM other than the first part, which must be provided in the
1035  *      @a wim parameter.
1036  * @param num_additional_swms
1037  *      Number of additional WIM parts provided in the @a additional_swms array.
1038  *      This number should be one less than the total number of parts in the
1039  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1040  * @param progress_func
1041  *      If non-NULL, a function that will be called periodically with the
1042  *      progress of the current operation.
1043  *
1044  * @return 0 on success; nonzero on error.
1045  * @retval ::WIMLIB_ERR_DECOMPRESSION
1046  *      Could not decompress the metadata resource for @a src_image
1047  *      in @a src_wim
1048  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1049  *      One or more of the names being given to an exported image was already in
1050  *      use in the destination WIM.
1051  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1052  *      A directory entry in the metadata resource for @a src_image in @a
1053  *      src_wim is invalid.
1054  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1055  *      @a src_image does not exist in @a src_wim.
1056  * @retval ::WIMLIB_ERR_INVALID_PARAM
1057  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1058  *      ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1059  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
1060  *      dest_description were non-<code>NULL</code>, @a src_image was
1061  *      ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1062  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1063  *      The metadata resource for @a src_image in @a src_wim is invalid.
1064  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1065  *      The security data for @a src_image in @a src_wim is invalid.
1066  * @retval ::WIMLIB_ERR_NOMEM
1067  *      Failed to allocate needed memory.
1068  * @retval ::WIMLIB_ERR_READ
1069  *      Could not read the metadata resource for @a src_image from @a src_wim.
1070  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1071  *      The source WIM is a split WIM, but the parts specified do not form a
1072  *      complete split WIM because they do not include all the parts of the
1073  *      original WIM, there are duplicate parts, or not all the parts have the
1074  *      same GUID and compression type.
1075  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1076  *      @a dest_wim is part of a split WIM.  Exporting an image to a split WIM
1077  *      is unsupported.
1078  */
1079 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
1080                                WIMStruct *dest_wim, const char *dest_name,
1081                                const char *dest_description, int export_flags,
1082                                WIMStruct **additional_swms,
1083                                unsigned num_additional_swms,
1084                                wimlib_progress_func_t progress_func);
1085
1086 /**
1087  * Extracts an image, or all images, from a standalone or split WIM file to a
1088  * directory or a NTFS volume.
1089  *
1090  * Please see the manual page for the @c imagex program for more information
1091  * about the "normal" extraction mode versus the NTFS extraction mode
1092  * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1093  *
1094  * Extraction is done with one thread.
1095  *
1096  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1097  * returned if any resulting SHA1 message digests do not match the values
1098  * provided in the WIM file.  Therefore, if this function is successful, you can
1099  * be fairly sure that any compressed data in the WIM was uncompressed
1100  * correctly.
1101  *
1102  * @param wim
1103  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1104  *      split WIM.
1105  * @param image
1106  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1107  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1108  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1109  * @param target
1110  *      Directory to extract the WIM image(s) to (created if it does not already
1111  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1112  *      path to the unmounted NTFS volume to extract the image to.
1113  * @param extract_flags
1114  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1115  *      <br/> <br/>
1116  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1117  *      a NTFS volume to extract the image to.  The volume will be opened using
1118  *      NTFS-3g and the image will be extracted to the root of the NTFS volume.
1119  *      Otherwise, @a target is interpreted as a directory to extract the
1120  *      image(s) to.
1121  *      <br/> <br/>
1122  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1123  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1124  *      specified.  These flags cause extracted files that are identical to be
1125  *      hardlinked or symlinked together, depending on the flag.  These flags
1126  *      override the hard link groups that are specified in the WIM file itself.
1127  *      If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1128  *      hardlinked or symlinked across images if a file is found to occur in
1129  *      more than one image.
1130  *      <br/> <br/>
1131  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1132  *      name of each file or directory as it is extracted.
1133  *      <br/> <br/>
1134  *      If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1135  *      WIM sequentially, if possible.  If ::WIMLIB_ALL_IMAGES is specified,
1136  *      each image is considered separately with regards to the sequential
1137  *      order.  It is also possible for alternate data streams to break the
1138  *      sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1139  *      specified).
1140  * @param additional_swms
1141  *      Array of pointers to the ::WIMStruct for each additional part in the
1142  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1143  *      need to be in any particular order, but they must include all parts of
1144  *      the split WIM other than the first part, which must be provided in the
1145  *      @a wim parameter.
1146  * @param num_additional_swms
1147  *      Number of additional WIM parts provided in the @a additional_swms array.
1148  *      This number should be one less than the total number of parts in the
1149  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1150  *
1151  * @param progress_func
1152  *      If non-NULL, a function that will be called periodically with the
1153  *      progress of the current operation.
1154  *
1155  * @return 0 on success; nonzero on error.
1156  * @retval ::WIMLIB_ERR_DECOMPRESSION
1157  *      Could not decompress a resource (file or metadata) for @a image in @a
1158  *      wim.
1159  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1160  *      A directory entry in the metadata resource for @a image in @a wim is
1161  *      invalid.
1162  * @retval ::WIMLIB_ERR_INVALID_PARAM
1163  *      @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1164  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1165  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1166  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1167  *      specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1168  *      specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1169  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1170  *      specified in @a extract_flag.
1171  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1172  *      The SHA1 message digest of an extracted stream did not match the SHA1
1173  *      message digest given in the WIM file.
1174  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1175  *      A resource (file or metadata) for @a image in @a wim is invalid.
1176  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1177  *      The security data for @a image in @a wim is invalid.
1178  * @retval ::WIMLIB_ERR_LINK
1179 *       Failed to create a symbolic link or a hard link (only if
1180  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1181  * @retval ::WIMLIB_ERR_MKDIR
1182  *      Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1183  *      not specified in @a extract_flags).
1184  * @retval ::WIMLIB_ERR_NOMEM
1185  *      Failed to allocate needed memory.
1186  * @retval ::WIMLIB_ERR_NTFS_3G
1187  *      An error was returned from a libntfs-3g function while the WIM image was
1188  *      being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1189  *      was specified in @a extract_flags).
1190  * @retval ::WIMLIB_ERR_OPEN
1191  *      Could not open one of the files being extracted for writing (only if
1192  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1193  * @retval ::WIMLIB_ERR_READ
1194  *      A unexpected end-of-file or read error occurred when trying to read data
1195  *      from the WIM file associated with @a wim.
1196  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1197  *      The WIM is a split WIM, but the parts specified do not form a complete
1198  *      split WIM because they do not include all the parts of the original WIM,
1199  *      there are duplicate parts, or not all the parts have the same GUID and
1200  *      compression type.
1201  * @retval ::WIMLIB_ERR_UNSUPPORTED
1202  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1203  *      was configured with the @c --without-ntfs-3g flag.
1204  * @retval ::WIMLIB_ERR_WRITE
1205  *      Failed to write a file being extracted (only if
1206  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1207  */
1208 extern int wimlib_extract_image(WIMStruct *wim, int image,
1209                                 const char *target, int extract_flags,
1210                                 WIMStruct **additional_swms,
1211                                 unsigned num_additional_swms,
1212                                 wimlib_progress_func_t progress_func);
1213
1214 /**
1215  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1216  * includes a string of XML that describes the images contained in the WIM.
1217  * This function works on standalone WIMs as well as split WIM parts.
1218  *
1219  * @param wim
1220  *      Pointer to the ::WIMStruct for a WIM file.
1221  * @param fp
1222  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1223  *
1224  * @return 0 on success; nonzero on error.
1225  * @retval ::WIMLIB_ERR_WRITE
1226  *      Failed to completely write the XML data to @a fp.
1227  * @retval ::WIMLIB_ERR_INVALID_PARAM
1228  *      @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1229  */
1230 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1231
1232 /**
1233  * Frees all memory allocated for a WIMStruct and closes all files associated
1234  * with it.
1235  *
1236  * @param wim
1237  *      Pointer to the ::WIMStruct for a WIM file.
1238  *
1239  * @return This function has no return value.
1240  */
1241 extern void wimlib_free(WIMStruct *wim);
1242
1243 /**
1244  * Returns the index of the bootable image of the WIM.
1245  *
1246  * @param wim
1247  *      Pointer to the ::WIMStruct for a WIM file.
1248  *
1249  * @return
1250  *      0 if no image is marked as bootable, or the number of the image marked
1251  *      as bootable (numbered starting at 1).
1252  */
1253 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1254
1255 /**
1256  * Returns the compression type used in the WIM.
1257  *
1258  * @param wim
1259  *      Pointer to the ::WIMStruct for a WIM file
1260  *
1261  * @return
1262  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1263  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1264  */
1265 extern int wimlib_get_compression_type(const WIMStruct *wim);
1266
1267 /**
1268  * Converts a ::wimlib_compression_type value into a string.
1269  *
1270  * @param ctype
1271  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1272  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1273  *
1274  * @return
1275  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1276  *      respectively.
1277  */
1278 extern const char *wimlib_get_compression_type_string(int ctype);
1279
1280 /**
1281  * Converts an error code into a string describing it.
1282  *
1283  * @param code
1284  *      The error code returned by one of wimlib's functions.
1285  *
1286  * @return
1287  *      Pointer to a statically allocated string describing the error code,
1288  *      or @c NULL if the error code is not valid.
1289  */
1290 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1291
1292 /**
1293  * Returns the description of the specified image.
1294  *
1295  * @param wim
1296  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1297  *      standalone WIM or a split WIM part.
1298  * @param image
1299  *      The number of the image, numbered starting at 1.
1300  *
1301  * @return
1302  *      The description of the image, or @c NULL if there is no such image, or
1303  *      @c NULL if the specified image has no description.  The description
1304  *      string is in library-internal memory and may not be modified or freed;
1305  *      in addition, the string will become invalid if the description of the
1306  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1307  */
1308 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1309
1310 /**
1311  * Returns the name of the specified image.
1312  *
1313  * @param wim
1314  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1315  *      standalone WIM or a split WIM part.
1316  * @param image
1317  *      The number of the image, numbered starting at 1.
1318  *
1319  * @return
1320  *      The name of the image, or @c NULL if there is no such image.  The name
1321  *      string is in library-internal memory and may not be modified or freed;
1322  *      in addition, the string will become invalid if the name of the image is
1323  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
1324  *
1325  *      If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1326  *      the WIM to be unnamed, in which case an empty string will be returned
1327  *      when the corresponding name is requested.
1328  */
1329 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1330
1331
1332 /**
1333  * Returns the number of images contained in a WIM.
1334  *
1335  * @param wim
1336  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1337  *      standalone WIM or a split WIM part.
1338  *
1339  * @return
1340  *      The number of images contained in the WIM file.
1341  */
1342 extern int wimlib_get_num_images(const WIMStruct *wim);
1343
1344 /**
1345  * Returns the part number of a WIM in a split WIM and the total number of parts
1346  * of the split WIM.
1347  *
1348  * @param wim
1349  *      Pointer to the ::WIMStruct for a WIM file.
1350  * @param total_parts_ret
1351  *      If non-@c NULL, the total number of parts in the split WIM (1 for
1352  *      non-split WIMs) is written to this location.
1353  *
1354  * @return
1355  *      The part number of the WIM (1 for non-split WIMs)
1356  */
1357 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1358
1359 /**
1360  * Since wimlib 1.2.6:  Initialization function for wimlib.  This is not
1361  * re-entrant.  If you are calling wimlib functions concurrently in different
1362  * threads, then you must call this function serially first.  Otherwise, calling
1363  * this function is not required.
1364  *
1365  * @return 0 on success; nonzero on error.
1366  * @retval ::WIMLIB_ERR_NOMEM
1367  *      Could not allocate memory.
1368  * @retval ::WIMLIB_ERR_ICONV_NOT_AVAILABLE
1369  *      wimlib was configured @c --without-libntfs-3g at compilation time, and
1370  *      at runtime the @c iconv() set of functions did not seem to be available,
1371  *      perhaps due to missing files in the C library installation.
1372  *
1373  * If this function is not called or returns nonzero, then it will not be safe
1374  * to use wimlib in multiple threads.  Furthermore, a nonzero return value here
1375  * indicates that further calls into wimlib will probably fail when they try to
1376  * repeat the same initializations.
1377  */
1378 extern int wimlib_global_init();
1379
1380 /**
1381  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
1382  * You are not required to call this function, but it will release any global
1383  * memory allocated by the library.
1384  */
1385 extern void wimlib_global_cleanup();
1386
1387 /**
1388  * Returns true if the WIM has an integrity table.
1389  *
1390  * @param wim
1391  *      Pointer to the ::WIMStruct for a WIM file.
1392  * @return
1393  *      @c true if the WIM has an integrity table; @c false otherwise.  If @a
1394  *      wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1395  *      wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1396  *      been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1397  */
1398 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1399
1400
1401 /**
1402  * Determines if an image name is already used by some image in the WIM.
1403  *
1404  * @param wim
1405  *      Pointer to the ::WIMStruct for a WIM file.
1406  * @param name
1407  *      The name to check.
1408  *
1409  * @return
1410  *      @c true if there is already an image in @a wim named @a name; @c false
1411  *      if there is no image named @a name in @a wim.  If @a name is @c NULL or
1412  *      the empty string, @c false is returned.
1413  */
1414 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1415
1416 /**
1417  * Joins a split WIM into a stand-alone one-part WIM.
1418  *
1419  * @param swms
1420  *      An array of strings that gives the filenames of all parts of the split
1421  *      WIM.  No specific order is required, but all parts must be included with
1422  *      no duplicates.
1423  * @param num_swms
1424  *      Number of filenames in @a swms.
1425  * @param swm_open_flags
1426  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1427  *      part should be verified, if integrity tables are present.  Otherwise,
1428  *      set to 0.
1429  * @param wim_write_flags
1430  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1431  * @param output_path
1432  *      The path to write the one-part WIM to.
1433  * @param progress_func
1434  *      If non-NULL, a function that will be called periodically with the
1435  *      progress of the current operation.
1436  *
1437  * @return 0 on success; nonzero on error.  This function may return any value
1438  * returned by wimlib_open_wim() and wimlib_write() except
1439  * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1440  *
1441  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1442  *      The split WIMs do not form a valid WIM because they do not include all
1443  *      the parts of the original WIM, there are duplicate parts, or not all the
1444  *      parts have the same GUID and compression type.
1445  *
1446  * Note: the WIM's uncompressed and compressed resources are not checksummed
1447  * when they are copied from the split WIM parts to the joined WIM, nor are
1448  * compressed resources re-compressed.
1449  *
1450  * Note: wimlib_export_image() can provide similar functionality to
1451  * wimlib_join(), since it is possible to export all images from a split WIM.
1452  */
1453 extern int wimlib_join(const char * const *swms, unsigned num_swms,
1454                        const char *output_path, int swm_open_flags,
1455                        int wim_write_flags,
1456                        wimlib_progress_func_t progress_func);
1457
1458 /**
1459  * Mounts an image in a WIM file on a directory read-only or read-write.
1460  *
1461  * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1462  * process shall be daemonized.
1463  *
1464  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1465  * modifications to the WIM are staged in a temporary directory.
1466  *
1467  * It is safe to mount multiple images from the same WIM file read-only at the
1468  * same time, but only if different ::WIMStruct's are used.  It is @b not safe
1469  * to mount multiple images from the same WIM file read-write at the same time.
1470  *
1471  * wimlib_mount_image() cannot be used on an image that was exported with
1472  * wimlib_export_image() while the dentry trees for both images are still in
1473  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
1474  * that has just been added with wimlib_add_image(), unless the WIM has been
1475  * written and read into a new ::WIMStruct.
1476  *
1477  * @param wim
1478  *      Pointer to the ::WIMStruct containing the image to be mounted.
1479  * @param image
1480  *      The number of the image to mount, indexed starting from it.  It must be
1481  *      an existing, single image.
1482  * @param dir
1483  *      The path to an existing empty directory to mount the image on.
1484  * @param mount_flags
1485  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1486  *      <br/><br/>
1487  *      If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1488  *      rather than the default of read-only.
1489  *      <br/> <br/>
1490  *      WIMs may contain named (alternate) data streams, which are a somewhat
1491  *      obscure NTFS feature.  They can be read and written on a mounted WIM
1492  *      through one of several interfaces.  The interface to use if specified by
1493  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1494  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1495  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
1496  *      the XATTR interface.
1497  * @param additional_swms
1498  *      Array of pointers to the ::WIMStruct for each additional part in the
1499  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1500  *      need to be in any particular order, but they must include all parts of
1501  *      the split WIM other than the first part, which must be provided in the
1502  *      @a wim parameter.
1503  * @param num_additional_swms
1504  *      Number of additional WIM parts provided in the @a additional_swms array.
1505  *      This number should be one less than the total number of parts in the
1506  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1507  * @param staging_dir
1508  *      If non-NULL, the name of a directory in which the staging directory will
1509  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1510  *      in @a mount_flags.  If left @c NULL, the staging directory is created in
1511  *      the same directory as the WIM file that @a wim was originally read from.
1512  *
1513  * @return 0 on success; nonzero on error.
1514  *
1515  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1516  *      A read-write mount was requested, but an an exclusive advisory lock on
1517  *      the on-disk WIM file could not be acquired because another thread or
1518  *      process has mounted an image from the WIM read-write or is currently
1519  *      modifying the WIM in-place.
1520  * @retval ::WIMLIB_ERR_DECOMPRESSION
1521  *      Could not decompress the metadata resource for @a image in @a wim.
1522  * @retval ::WIMLIB_ERR_FUSE
1523  *      A non-zero status was returned by @c fuse_main().
1524  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1525  *      A directory entry in the metadata resource for @a image in @a wim is
1526  *      invalid.
1527  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1528  *      @a image does not specify an existing, single image in @a wim.
1529  * @retval ::WIMLIB_ERR_INVALID_PARAM
1530  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
1531  *      wimlib_export_image(), or @a image has been added with
1532  *      wimlib_add_image().
1533  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1534  *      The metadata resource for @a image in @a wim is invalid.
1535  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1536  *      The security data for @a image in @a wim is invalid.
1537  * @retval ::WIMLIB_ERR_MKDIR
1538  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1539  *      staging directory could not be created.
1540  * @retval ::WIMLIB_ERR_NOMEM
1541  *      Failed to allocate needed memory.
1542  * @retval ::WIMLIB_ERR_NOTDIR
1543  *      Could not determine the current working directory.
1544  * @retval ::WIMLIB_ERR_READ
1545  *      An unexpected end-of-file or read error occurred when trying to read
1546  *      data from the WIM file associated with @a wim.
1547  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1548  *      The WIM is a split WIM, but the parts specified do not form a complete
1549  *      split WIM because they do not include all the parts of the original WIM,
1550  *      there are duplicate parts, or not all the parts have the same GUID and
1551  *      compression type.
1552  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1553  *      The WIM is a split WIM and a read-write mount was requested.  We only
1554  *      support mounting a split WIM read-only.
1555  */
1556 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1557                               int mount_flags, WIMStruct **additional_swms,
1558                               unsigned num_additional_swms,
1559                               const char *staging_dir);
1560
1561 /**
1562  * Opens a WIM file and creates a ::WIMStruct for it.
1563  *
1564  * @param wim_file
1565  *      The path to the WIM file to open.
1566  * @param open_flags
1567  *      Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1568  *      ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1569  *      <br/> <br/>
1570  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1571  *      the WIM, if it exists, is checked, and this function will fail with an
1572  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1573  *      digests of the WIM do not exactly match the corresponding message
1574  *      digests given in the integrity table.
1575  *      <br/> <br/>
1576  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1577  *      WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1578  *      returned.  (This flag may be removed in the future, in which case no
1579  *      error will be issued when opening a split WIM.)
1580  *
1581  * @param progress_func
1582  *      If non-NULL, a function that will be called periodically with the
1583  *      progress of the current operation.
1584  *
1585  * @param wim_ret
1586  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1587  *      is written to the memory location pointed to by this parameter.  The
1588  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1589  *      it.
1590  *
1591  * @return 0 on success; nonzero on error.
1592  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1593  *      The lookup table of @a wim_file is compressed.  Support for this can be
1594  *      added to wimlib if needed, but it appears to be the case that the lookup
1595  *      table is never compressed.
1596  * @retval ::WIMLIB_ERR_IMAGE_COUNT
1597  *      The WIM is not the non-first part of a split WIM, and the number of
1598  *      metadata resources found in the WIM did not match the image count given
1599  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
1600  *      data for the WIM did not match the image count given in the WIM header.
1601  * @retval ::WIMLIB_ERR_INTEGRITY
1602  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1603  *      wim_file contains an integrity table, but the SHA1 message digest for a
1604  *      chunk of the WIM does not match the corresponding message digest given
1605  *      in the integrity table.
1606  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1607  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
1608  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1609  *      The header of @a wim_file says that resources in the WIM are compressed,
1610  *      but the header flag indicating LZX or XPRESS compression is not set.
1611  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1612  *      The length field of the WIM header is not 208.
1613  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1614  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1615  *      wim_file contains an integrity table, but the integrity table is
1616  *      invalid.
1617  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1618  *      The lookup table for the WIM contained duplicate entries that are not
1619  *      for metadata resources, or it contained an entry with a SHA1 message
1620  *      digest of all 0's.
1621  * @retval ::WIMLIB_ERR_NOMEM
1622  *      Failed to allocated needed memory.
1623  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1624  *      @a wim_file does not begin with the expected magic characters.
1625  * @retval ::WIMLIB_ERR_OPEN
1626  *      Failed to open the file @a wim_file for reading.
1627  * @retval ::WIMLIB_ERR_READ
1628  *      An unexpected end-of-file or read error occurred when trying to read
1629  *      data from @a wim_file.
1630  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1631  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1632  *      specified in @a open_flags.
1633  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1634  *      A number other than 0x10d00 is written in the version field of the WIM
1635  *      header of @a wim_file.  (Probably a pre-Vista WIM).
1636  * @retval ::WIMLIB_ERR_XML
1637  *      The XML data for @a wim_file is invalid.
1638  */
1639 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1640                            WIMStruct **wim_ret,
1641                            wimlib_progress_func_t progress_func);
1642
1643 /**
1644  * Overwrites the file that the WIM was originally read from, with changes made.
1645  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1646  * rather than wimlib_create_new_wim().
1647  *
1648  * There are two ways that a WIM may be overwritten.  The first is to do a full
1649  * rebuild.  In this mode, the new WIM is written to a temporary file and then
1650  * renamed to the original file after it is has been completely written.  The
1651  * temporary file is made in the same directory as the original WIM file.  A
1652  * full rebuild may take a while, but can be used even if images have been
1653  * modified or deleted, will produce a WIM with no holes, and has little chance
1654  * of unintentional data loss because the temporary WIM is fsync()ed before
1655  * being renamed to the original WIM.
1656  *
1657  * The second way to overwrite a WIM is by appending to the end of it and
1658  * overwriting the header.  This can be much faster than a full rebuild, but it
1659  * only works if the only operations on the WIM have been to change the header
1660  * and/or XML data, or to add new images.  Writing a WIM in this mode begins
1661  * with writing any new file resources *after* everything in the old WIM, even
1662  * though this will leave a hole where the old lookup table, XML data, and
1663  * integrity were.  This is done so that the WIM remains valid even if the
1664  * operation is aborted mid-write.  The WIM header is only overwritten at the
1665  * very last moment, and up until that point the WIM will be seen as the old
1666  * version.
1667  *
1668  * By default, the overwrite mode is determine automatically based on the past
1669  * operations performed on the ::WIMStruct.  Use the flag
1670  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1671  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1672  * images have been deleted from the WIM.
1673  *
1674  * In the temporary-file overwrite mode, no changes are made to the WIM on
1675  * failure, and the temporary file is deleted if possible.  Abnormal termination
1676  * of the program will result in the temporary file being orphaned.  In the
1677  * direct append mode, the WIM is truncated to the original length on failure;
1678  * and while abnormal termination of the program will result in extra data
1679  * appended to the original WIM, it should still be a valid WIM.
1680  *
1681  * @param wim
1682  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
1683  *      been in-memory changes made to it, which are then reflected in the
1684  *      output file.
1685  * @param write_flags
1686  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1687  *      ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1688  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1689  * @param num_threads
1690  *      Number of threads to use for compression (see wimlib_write()).
1691  * @param progress_func
1692  *      If non-NULL, a function that will be called periodically with the
1693  *      progress of the current operation.
1694  *
1695  * @return 0 on success; nonzero on error.  This function may return any value
1696  * returned by wimlib_write() as well as the following error codes:
1697  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1698  *      The WIM was going to be modifien in-place (with no temporary file), but
1699  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
1700  *      because another thread or process has mounted an image from the WIM
1701  *      read-write or is currently modifying the WIM in-place.
1702  * @retval ::WIMLIB_ERR_NO_FILENAME
1703  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1704  *      than a WIM read with wimlib_open_wim().
1705  * @retval ::WIMLIB_ERR_RENAME
1706  *      The temporary file that the WIM was written to could not be renamed to
1707  *      the original filename of @a wim.
1708  * @retval ::WIMLIB_ERR_REOPEN
1709  *      The WIM was overwritten successfully, but it could not be re-opened
1710  *      read-only.  Therefore, the resources in the WIM can no longer be
1711  *      accessed, so this limits the functions that can be called on @a wim
1712  *      before calling wimlib_free().
1713  */
1714 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1715                             unsigned num_threads,
1716                             wimlib_progress_func_t progress_func);
1717
1718 /**
1719  * Prints information about one image, or all images, contained in a WIM.
1720  *
1721  * @param wim
1722  *      Pointer to the ::WIMStruct for a WIM file.
1723  * @param image
1724  *      The image about which to print information.  Can be the number of an
1725  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1726  *      WIM.
1727  *
1728  * @return This function has no return value.  No error checking is done when
1729  * printing the information.  If @a image is invalid, an error message is
1730  * printed.
1731  */
1732 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1733
1734 /**
1735  * Prints the full paths to all files contained in an image, or all images, in a
1736  * WIM file.
1737  *
1738  * @param wim
1739  *      Pointer to the ::WIMStruct for a WIM file.
1740  * @param image
1741  *      Which image to print files for.  Can be the number of an image, or
1742  *      ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1743  *
1744  * @return 0 on success; nonzero on error.
1745  * @retval ::WIMLIB_ERR_DECOMPRESSION
1746  *      The metadata resource for one of the specified images could not be
1747  *      decompressed.
1748  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1749  *      A directory entry in the metadata resource for one of the specified
1750  *      images is invaled.
1751  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1752  *      @a image does not specify a valid image in @a wim, and is not
1753  *      ::WIMLIB_ALL_IMAGES.
1754  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1755  *      The metadata resource for one of the specified images is invalid.
1756  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1757  *      The security data for one of the specified images is invalid.
1758  * @retval ::WIMLIB_ERR_NOMEM
1759  *      Failed to allocate needed memory.
1760  * @retval ::WIMLIB_ERR_READ
1761  *      An unexpected read error or end-of-file occurred when reading the
1762  *      metadata resource for one of the specified images.
1763  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1764  *      @a wim was not a standalone WIM and was not the first part of a split
1765  *      WIM.
1766  */
1767 extern int wimlib_print_files(WIMStruct *wim, int image);
1768
1769 /**
1770  * Prints detailed information from the header of a WIM file.
1771  *
1772  * @param wim
1773  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1774  *      standalone WIM or part of a split WIM.
1775  *
1776  * @return This function has no return value.
1777  *
1778  */
1779 extern void wimlib_print_header(const WIMStruct *wim);
1780
1781 /**
1782  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
1783  * digests, as found in the directory entry tree in the WIM file, to file
1784  * resources in the WIM file.  This table includes one entry for each unique
1785  * file in the WIM, so it can be quite long.  There is only one lookup table per
1786  * WIM file, but each split WIM part has its own lookup table.
1787  *
1788  * @param wim
1789  *      Pointer to the ::WIMStruct for a WIM file.
1790  *
1791  * @return This function has no return value.
1792  */
1793 extern void wimlib_print_lookup_table(WIMStruct *wim);
1794
1795 /**
1796  * Prints the metadata of the specified image in a WIM file.  The metadata
1797  * consists of the security data as well as the directory entry tree.  Each
1798  * image has its own metadata.
1799  *
1800  * @param wim
1801  *      Pointer to the ::WIMStruct for a WIM file.
1802  * @param image
1803  *      Which image to print the metadata for.  Can be the number of an image,
1804  *      or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1805  *
1806  * @return 0 on success; nonzero on error.
1807  * @retval ::WIMLIB_ERR_DECOMPRESSION
1808  *      The metadata resource for one of the specified images could not be
1809  *      decompressed.
1810  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1811  *      A directory entry in the metadata resource for one of the specified
1812  *      images is invaled.
1813  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1814  *      @a image does not specify a valid image in @a wim, and is not
1815  *      ::WIMLIB_ALL_IMAGES.
1816  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1817  *      The metadata resource for one of the specified images is invalid.
1818  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1819  *      The security data for one of the specified images is invalid.
1820  * @retval ::WIMLIB_ERR_NOMEM
1821  *      Failed to allocate needed memory.
1822  * @retval ::WIMLIB_ERR_READ
1823  *      An unexpected read error or end-of-file occurred when reading the
1824  *      metadata resource for one of the specified images.
1825  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1826  *      @a wim was not a standalone WIM and was not the first part of a split
1827  *      WIM.
1828  */
1829 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1830
1831 /**
1832  * Prints some basic information about a WIM file.  All information printed by
1833  * this function is also printed by wimlib_print_header(), but
1834  * wimlib_print_wim_information() prints some of this information more concisely
1835  * and in a more readable form.
1836  *
1837  * @param wim
1838  *      Pointer to the ::WIMStruct for a WIM file.
1839  *
1840  * @return This function has no return value.
1841  */
1842 extern void wimlib_print_wim_information(const WIMStruct *wim);
1843
1844 /**
1845  * Translates a string specifying the name or number of an image in the WIM into
1846  * the number of the image.  The images are numbered starting at 1.
1847  *
1848  * @param wim
1849  *      Pointer to the ::WIMStruct for a WIM file.
1850  * @param image_name_or_num
1851  *      A string specifying the name or number of an image in the WIM.  If it
1852  *      parses to a positive integer, this integer is taken to specify the
1853  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
1854  *      be the name of an image, as given in the XML data for the WIM file.  It
1855  *      also may be the keyword "all" or the string "*", both of which will
1856  *      resolve to ::WIMLIB_ALL_IMAGES.
1857  *      <br/> <br/>
1858  *      There is no way to search for an image actually named "all", "*", or an
1859  *      integer number, or an image that has no name.  However, you can use
1860  *      wimlib_get_image_name() to get the name of any image.
1861  *
1862  * @return
1863  *      If the string resolved to a single existing image, the number of that
1864  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
1865  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
1866  *      ::WIMLIB_NO_IMAGE is returned.  If @a image_name_or_num was @c NULL or
1867  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1868  *      images in @a wim has no name.
1869  */
1870 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1871
1872 /**
1873  * Sets which image in the WIM is marked as bootable.
1874  *
1875  * @param wim
1876  *      Pointer to the ::WIMStruct for a WIM file.
1877  * @param boot_idx
1878  *      The number of the image to mark as bootable, or 0 to mark no image as
1879  *      bootable.
1880  * @return 0 on success; nonzero on error.
1881  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1882  *      @a boot_idx does not specify an existing image in @a wim, and it was not
1883  *      0.
1884  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1885  *      @a wim is part of a split WIM.  We do not support changing the boot
1886  *      index of a split WIM.
1887  */
1888 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1889
1890 /**
1891  * Changes the description of an image in the WIM.
1892  *
1893  * @param wim
1894  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1895  *      standalone WIM or part of a split WIM; however, you should set the same
1896  *      description on all parts of a split WIM.
1897  * @param image
1898  *      The number of the image for which to change the description.
1899  * @param description
1900  *      The new description to give the image.  It may be @c NULL, which
1901  *      indicates that the image is to be given no description.
1902  *
1903  * @return 0 on success; nonzero on error.
1904  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1905  *      @a image does not specify a single existing image in @a wim.
1906  * @retval ::WIMLIB_ERR_NOMEM
1907  *      Failed to allocate the memory needed to duplicate the @a description
1908  *      string.
1909  */
1910 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1911                                        const char *description);
1912
1913 /**
1914  * Changes what is written in the \<FLAGS\> element in the WIM XML data
1915  * (something like "Core" or "Ultimate")
1916  *
1917  * @param wim
1918  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1919  *      standalone WIM or part of a split WIM; however, you should set the same
1920  *      \<FLAGS\> element on all parts of a split WIM.
1921  * @param image
1922  *      The number of the image for which to change the description.
1923  * @param flags
1924  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
1925  *      indicates that the image is to be given no \<FLAGS\> element.
1926  *
1927  * @return 0 on success; nonzero on error.
1928  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1929  *      @a image does not specify a single existing image in @a wim.
1930  * @retval ::WIMLIB_ERR_NOMEM
1931  *      Failed to allocate the memory needed to duplicate the @a flags string.
1932  */
1933 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1934
1935 /**
1936  * Changes the name of an image in the WIM.
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; however, you should set the same
1941  *      name on all parts of a split WIM.
1942  * @param image
1943  *      The number of the image for which to change the name.
1944  * @param name
1945  *      The new name to give the image.  It must be a nonempty string.
1946  *
1947  * @return 0 on success; nonzero on error.
1948  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1949  *      There is already an image named @a name in @a wim.
1950  * @retval ::WIMLIB_ERR_INVALID_PARAM
1951  *      @a name was @c NULL or the empty string.
1952  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1953  *      @a image does not specify a single existing image in @a wim.
1954  * @retval ::WIMLIB_ERR_NOMEM
1955  *      Failed to allocate the memory needed to duplicate the @a name string.
1956  */
1957 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1958
1959 /**
1960  * Set the functions that wimlib uses to allocate and free memory.
1961  *
1962  * These settings are global and not per-WIM.
1963  *
1964  * The default is to use the default @c malloc() and @c free() from the C
1965  * library.
1966  *
1967  * Please note that some external functions, such as those in @c libntfs-3g, may
1968  * use the standard memory allocation functions.
1969  *
1970  * @param malloc_func
1971  *      A function equivalent to @c malloc() that wimlib will use to allocate
1972  *      memory.  If @c NULL, the allocator function is set back to the default
1973  *      @c malloc() from the C library.
1974  * @param free_func
1975  *      A function equivalent to @c free() that wimlib will use to free memory.
1976  *      If @c NULL, the free function is set back to the default @c free() from
1977  *      the C library.
1978  * @param realloc_func
1979  *      A function equivalent to @c realloc() that wimlib will use to reallocate
1980  *      memory.  If @c NULL, the free function is set back to the default @c
1981  *      realloc() from the C library.
1982  * @return 0 on success; nonzero on error.
1983  * @retval ::WIMLIB_ERR_UNSUPPORTED
1984  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
1985  *      so custom memory allocators are unsupported.
1986  */
1987 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1988                                  void (*free_func)(void *),
1989                                  void *(*realloc_func)(void *, size_t));
1990
1991 /**
1992  * Sets whether wimlib is to print error messages to @c stderr when a function
1993  * fails.  These error messages may provide information that cannot be
1994  * determined only from the error code that is returned.  Not every error will
1995  * result in an error message being printed.
1996  *
1997  * This setting is global and not per-WIM.
1998  *
1999  * By default, error messages are not printed.
2000  *
2001  * @param show_messages
2002  *      @c true if error messages are to be printed; @c false if error messages
2003  *      are not to be printed.
2004  *
2005  * @return 0 on success; nonzero on error.
2006  * @retval ::WIMLIB_ERR_UNSUPPORTED
2007  *      @a show_messages was @c true, but wimlib was compiled with the @c
2008  *      --without-error-messages option.   Therefore, error messages cannot be
2009  *      shown.
2010  */
2011 extern int wimlib_set_print_errors(bool show_messages);
2012
2013 /**
2014  * Splits a WIM into multiple parts.
2015  *
2016  * @param wim
2017  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
2018  *      WIM.
2019  * @param swm_name
2020  *      Name of the SWM file to create.  This will be the name of the first
2021  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
2022  *      appended before the suffix.
2023  * @param part_size
2024  *      The maximum size per part, in bytes.  It is not guaranteed that this
2025  *      will really be the maximum size per part, because some file resources in
2026  *      the WIM may be larger than this size, and the WIM file format provides
2027  *      no way to split up file resources among multiple WIMs.
2028  * @param write_flags
2029  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2030  *      included in the split WIM parts.
2031  * @param progress_func
2032  *      If non-NULL, a function that will be called periodically with the
2033  *      progress of the current operation.
2034  *
2035  * @return 0 on success; nonzero on error.  This function may return any value
2036  * returned by wimlib_write() as well as the following error codes:
2037  *
2038  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2039  *      @a wim is not part 1 of a stand-alone WIM.
2040  * @retval ::WIMLIB_ERR_INVALID_PARAM
2041  *      @a swm_name was @c NULL, or @a part_size was 0.
2042  *
2043  * Note: the WIM's uncompressed and compressed resources are not checksummed
2044  * when they are copied from the joined WIM to the split WIM parts, nor are
2045  * compressed resources re-compressed.
2046  */
2047 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
2048                         size_t part_size, int write_flags,
2049                         wimlib_progress_func_t progress_func);
2050
2051 /**
2052  * Unmounts a WIM image that was mounted using wimlib_mount_image().
2053  *
2054  * The image to unmount is specified by the path to the mountpoint, not the
2055  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2056  * touched and also may have been allocated in a different process.
2057  *
2058  * To unmount the image, the thread calling this function communicates with the
2059  * thread that is managing the mounted WIM image.  This function blocks until it
2060  * is known whether the unmount succeeded or failed.  In the case of a
2061  * read-write mounted WIM, the unmount is not considered to have succeeded until
2062  * all changes have been saved to the underlying WIM file.
2063  *
2064  * @param dir
2065  *      The directory that the WIM image was mounted on.
2066  * @param unmount_flags
2067  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2068  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2069  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
2070  *      mounts.
2071  * @param progress_func
2072  *      If non-NULL, a function that will be called periodically with the
2073  *      progress of the current operation.
2074  *
2075  * @return 0 on success; nonzero on error.
2076  *
2077  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2078  *      The filesystem daemon was unable to remove the staging directory and the
2079  *      temporary files that it contains.
2080  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2081  *      The filesystem daemon appears to have terminated before sending an exit
2082  *      status.
2083  * @retval ::WIMLIB_ERR_FORK
2084  *      Could not @c fork() the process.
2085  * @retval ::WIMLIB_ERR_FUSERMOUNT
2086  *      The @b fusermount program could not be executed or exited with a failure
2087  *      status.
2088  * @retval ::WIMLIB_ERR_MQUEUE
2089  *      Could not open a POSIX message queue to communicate with the filesystem
2090  *      daemon servicing the mounted filesystem, could not send a message
2091  *      through the queue, or could not receive a message through the queue.
2092  * @retval ::WIMLIB_ERR_NOMEM
2093  *      Failed to allocate needed memory.
2094  * @retval ::WIMLIB_ERR_OPEN
2095  *      The filesystem daemon could not open a temporary file for writing the
2096  *      new WIM.
2097  * @retval ::WIMLIB_ERR_READ
2098  *      A read error occurred when the filesystem daemon tried to a file from
2099  *      the staging directory
2100  * @retval ::WIMLIB_ERR_RENAME
2101  *      The filesystem daemon failed to rename the newly written WIM file to the
2102  *      original WIM file.
2103  * @retval ::WIMLIB_ERR_WRITE
2104  *      A write error occurred when the filesystem daemon was writing to the new
2105  *      WIM file, or the filesystem daemon was unable to flush changes that had
2106  *      been made to files in the staging directory.
2107  */
2108 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
2109                                 wimlib_progress_func_t progress_func);
2110
2111 /**
2112  * Writes a standalone WIM to a file.
2113  *
2114  * This brings in resources from any external locations, such as directory trees
2115  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2116  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2117  *
2118  * @param wim
2119  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
2120  *      changes made to it, which are then reflected in the output file.
2121  * @param path
2122  *      The path to the file to write the WIM to.
2123  * @param image
2124  *      The image inside the WIM to write.  Use ::WIMLIB_ALL_IMAGES to include all
2125  *      images.
2126  * @param write_flags
2127  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2128  *      ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2129  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2130  * @param num_threads
2131  *      Number of threads to use for compressing data.  If 0, the number of
2132  *      threads is taken to be the number of online processors.  Note: if no
2133  *      data compression needs to be done, no additional threads will be created
2134  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
2135  *      exporting an image from a compressed WIM to another WIM of the same
2136  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2137  *      write_flags).
2138  * @param progress_func
2139  *      If non-NULL, a function that will be called periodically with the
2140  *      progress of the current operation.
2141  *
2142  * @return 0 on success; nonzero on error.
2143  * @retval ::WIMLIB_ERR_DECOMPRESSION
2144  *      Failed to decompress a metadata or file resource in @a wim.
2145  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2146  *      A directory entry in the metadata resource for @a image in @a wim is
2147  *      invalid.
2148  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2149  *      @a image does not specify a single existing image in @a wim, and is not
2150  *      ::WIMLIB_ALL_IMAGES.
2151  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2152  *      A file that had previously been scanned for inclusion in the WIM by
2153  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
2154  *      message digest check.
2155  * @retval ::WIMLIB_ERR_INVALID_PARAM
2156  *      @a path was @c NULL.
2157  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2158  *      The metadata resource for @a image in @a wim is invalid.
2159  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2160  *      The security data for @a image in @a wim is invalid.
2161  * @retval ::WIMLIB_ERR_NOMEM
2162  *      Failed to allocate needed memory.
2163  * @retval ::WIMLIB_ERR_OPEN
2164  *      Failed to open @a path for writing, or some file resources in @a
2165  *      wim refer to files in the outside filesystem, and one of these files
2166  *      could not be opened for reading.
2167  * @retval ::WIMLIB_ERR_READ
2168  *      An error occurred when trying to read data from the WIM file associated
2169  *      with @a wim, or some file resources in @a wim refer to files in the
2170  *      outside filesystem, and a read error occurred when reading one of these
2171  *      files.
2172  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2173  *      @a wim is part of a split WIM.  You may not call this function on a
2174  *      split WIM.
2175  * @retval ::WIMLIB_ERR_WRITE
2176  *      An error occurred when trying to write data to the new WIM file at @a
2177  *      path.
2178  */
2179 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2180                         int write_flags, unsigned num_threads,
2181                         wimlib_progress_func_t progress_func);
2182
2183 #endif /* _WIMLIB_H */