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