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