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