1de5d045801bb5eeb09300a748c1a8d9e932cc6b
[wimlib] / src / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  *
6  * This file contains extensive comments for generating documentation with
7  * Doxygen.  The built HTML documentation can be viewed at
8  * http://wimlib.sourceforge.net.
9  */
10
11 /*
12  * Copyright (C) 2012 Eric Biggers
13  *
14  * This file is part of wimlib, a library for working with WIM files.
15  *
16  * wimlib is free software; you can redistribute it and/or modify it under the
17  * terms of the GNU General Public License as published by the Free
18  * Software Foundation; either version 3 of the License, or (at your option)
19  * any later version.
20  *
21  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23  * A PARTICULAR PURPOSE. See the GNU General Public License for more
24  * details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with wimlib; if not, see http://www.gnu.org/licenses/.
28  */
29
30 /** \mainpage
31  *
32  * \section intro Introduction
33  *
34  * This is the documentation for the library interface of wimlib 1.2.5.  If you
35  * have installed wimlib and want to know how to use the @c imagex program,
36  * please see the man pages instead.
37  *
38  * wimlib is a C library to read, write, and mount archive files in the Windows
39  * Imaging Format (WIM files).  These files are normally created using the @c
40  * imagex.exe utility on Windows, but this library provides a free
41  * implementetion of @c imagex for UNIX-based systems and an API to allow other
42  * programs to read, write, and mount WIM files.  wimlib is comparable to
43  * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
44  *
45  * \section format WIM files
46  *
47  * A <b>Windows Imaging (WIM)</b> file is an archive.  Like some other archive
48  * formats such as ZIP, files in WIM archives may be compressed.  WIM archives
49  * support two Microsoft-specific compression formats:  @b LZX and @b XPRESS.
50  * Both are based on LZ77 and Huffman encoding, and both are supported by
51  * wimlib.
52  *
53  * Unlike ZIP files, WIM files can contain multiple independent toplevel
54  * directory trees known as @a images.  While each image has its own metadata,
55  * files are not duplicated for each image; instead, each file is included only
56  * once in the entire WIM. Microsoft did this so that in one WIM file, they
57  * could do things like have 5 different versions of Windows that are almost
58  * exactly the same.
59  *
60  * Microsoft provides documentation for the WIM file format, XPRESS compression
61  * format, and LZX compression format.  The XPRESS documentation is acceptable,
62  * but the LZX documentation is not entirely correct, and the WIM documentation
63  * itself is incomplete.
64  *
65  * A WIM file may be either stand-alone or split into multiple parts.
66  *
67  * \section ntfs NTFS support
68  *
69  * As of version 1.0.0, wimlib supports capturing and applying images directly
70  * to NTFS volumes.  This was made possible with the help of libntfs-3g from the
71  * NTFS-3g project.  This feature supports capturing and restoring NTFS-specific
72  * data such as security descriptors, alternate data streams, and reparse point
73  * data.
74
75  * The code for NTFS image capture and image application is complete enough that
76  * it is possible to apply an image from the "install.wim" contained in recent
77  * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
78  * NTFS volume, and then boot Windows from it after preparing the Boot
79  * Configuration Data.  In addition, a Windows installation can be captured (or
80  * backed up) into a WIM file, and then re-applied later.
81  *
82  * \section winpe Windows PE
83  *
84  * A major use for this library is to create customized images of Windows PE, the
85  * Windows Preinstallation Environment, without having to rely on Windows.  Windows
86  * PE is a lightweight version of Windows that can run entirely from memory and can
87  * be used to install Windows from local media or a network drive or perform
88  * maintenance.  Windows PE is the operating system that runs when you boot from
89  * the Windows installation media.
90  *
91  * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
92  * or Windows 8, in the file @c sources/boot.wim.  Windows PE can also be found
93  * in the Windows Automated Installation Kit (WAIK), which is free to download
94  * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
95  * install either the @c cabextract or @c p7zip programs.
96  *
97  * In addition, Windows installations and recovery partitions frequently contain a
98  * WIM containing an image of the Windows Recovery Environment, which is similar to
99  * Windows PE.
100  *
101  * \section starting Getting Started
102  *
103  * wimlib uses the GNU autotools, so it should be easy to install with
104  * <code>configure && make && sudo make install</code>; however, please see the
105  * README for more information about installing it.  To use wimlib in a program
106  * after installing it, include @c wimlib.h and link your program with @c -lwim.
107  *
108  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.  A ::WIMStruct
109  * may represent either a stand-alone WIM or one part of a split WIM.
110  *
111  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
112  * return an integer error code on failure.  Use wimlib_get_error_string() to
113  * get a string that describes an error code.  wimlib also can print error
114  * messages itself when an error happens, and these may be more informative than
115  * the error code; to enable this, call wimlib_set_print_errors().  Please note
116  * that this is for convenience only, and some errors can occur without a
117  * message being printed.
118  *
119  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
120  * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
121  * both apply globally.
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 5
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 of NTFS volume is read immediately for the purpose of
749  * constructing a directory entry tree in-memory.  Also, all files are read to
750  * calculate their SHA1 message digests.  However, because the directory tree
751  * may contain a very large amount of data, the files themselves are not read
752  * into memory permanently, and instead references to their paths saved.  The
753  * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
754  * called.
755  *
756  * See the manual page for the @c imagex program for more information about the
757  * "normal" capture mode versus the NTFS capture mode (entered by providing the
758  * flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
759  *
760  * Note that @b no changes are committed to the underlying WIM file (if
761  * any) until wimlib_write() or wimlib_overwrite() is called.
762  *
763  * @param wim
764  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
765  *      added.
766  * @param source
767  *      A path to a directory or unmounted NTFS volume that will be captured as
768  *      a WIM image.
769  * @param name
770  *      The name to give the image.  This must be non-@c NULL.
771  * @param config
772  *      Pointer to the contents of an image capture configuration file.  If @c
773  *      NULL, a default string is used.  Please see the manual page for
774  *      <b>imagex capture</b> for more information.
775  * @param config_len
776  *      Length of the string @a config in bytes.  Ignored if @a config is @c
777  *      NULL.
778  * @param add_image_flags
779  *      Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
780  * @param progress_func
781  *      If non-NULL, a function that will be called periodically with the
782  *      progress of the current operation.
783  *
784  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
785  * discarded so that it appears to be in the same state as when this function
786  * was called.
787  *
788  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
789  *      There is already an image named @a name in @a wim.
790  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
791  *      @a config was not @c NULL and did not specify a valid image capture
792  *      configuration.
793  * @retval ::WIMLIB_ERR_INVALID_PARAM
794  *      @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
795  * @retval ::WIMLIB_ERR_NOMEM
796  *      Failed to allocate needed memory.
797  * @retval ::WIMLIB_ERR_NOTDIR
798  *      @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
799  *      not specified in @a add_image_flags).
800  * @retval ::WIMLIB_ERR_NTFS_3G
801  *      An error was returned from a libntfs-3g function when the NTFS volume
802  *      was being opened, scanned, or closed (only if
803  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
804  * @retval ::WIMLIB_ERR_OPEN
805  *      Failed to open a file or directory in the directory tree rooted at @a
806  *      source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
807  *      add_image_flags).
808  * @retval ::WIMLIB_ERR_READ
809  *      Failed to read a file in the directory tree rooted at @a source (only if
810  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
811  * @retval ::WIMLIB_ERR_SPECIAL_FILE
812  *      The directory tree rooted at @a source contains a special file that is
813  *      not a directory, regular file, or symbolic link.  This currently can
814  *      only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
815  *      add_image_flags, but it may be returned for unsupported NTFS files in
816  *      the future.
817  * @retval ::WIMLIB_ERR_STAT
818  *      Failed obtain the metadata for a file or directory in the directory tree
819  *      rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
820  *      specified in @a add_image_flags).
821  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
822  *      @a wim is part of a split WIM.  Adding an image to a split WIM is
823  *      unsupported.
824  * @retval ::WIMLIB_ERR_UNSUPPORTED
825  *      ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
826  *      wimlib was configured with the @c --without-ntfs-3g flag.
827  */
828 extern int wimlib_add_image(WIMStruct *wim, const char *source,
829                             const char *name, const char *config,
830                             size_t config_len, int add_image_flags,
831                             wimlib_progress_func_t progress_func);
832
833 /**
834  * Creates a ::WIMStruct for a new WIM file.
835  *
836  * This only creates an in-memory structure for a WIM that initially contains no
837  * images.  No on-disk file is created until wimlib_write() is called.
838  *
839  * @param ctype
840  *      The type of compression to be used in the new WIM file.  Must be
841  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
842  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
843  * @param wim_ret
844  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
845  *      written to the memory location pointed to by this paramater.  The
846  *      ::WIMStruct must be freed using using wimlib_free() when finished with
847  *      it.
848  * @return 0 on success; nonzero on error.
849  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
850  *      @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
851  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
852  * @retval ::WIMLIB_ERR_NOMEM
853  *      Failed to allocate needed memory.
854  */
855 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
856
857 /**
858  * Deletes an image, or all images, from a WIM file.
859  *
860  * All streams referenced by the image(s) being deleted are removed from the
861  * lookup table of the WIM if they are not referenced by any other images in the
862  * WIM.
863  *
864  * Please note that @b no changes are committed to the underlying WIM file (if
865  * any) until wimlib_write() or wimlib_overwrite() is called.
866  *
867  * @param wim
868  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
869  *      being deleted.
870  * @param image
871  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
872  *      images.
873  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
874  * to be left unmodified only if @a image specified a single image.  If instead
875  * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
876  * possible for some but not all of the images to have been deleted when a
877  * failure status is returned.
878  *
879  * @retval ::WIMLIB_ERR_DECOMPRESSION
880  *      Could not decompress the metadata resource for @a image.
881  * @retval ::WIMLIB_ERR_INVALID_DENTRY
882  *      A directory entry in the metadata resource for @a image in the WIM is
883  *      invalid.
884  * @retval ::WIMLIB_ERR_INVALID_IMAGE
885  *      @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
886  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
887  *      The metadata resource for @a image in the WIM is invalid.
888  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
889  *      The security data for @a image in the WIM is invalid.
890  * @retval ::WIMLIB_ERR_NOMEM
891  *      Failed to allocate needed memory.
892  * @retval ::WIMLIB_ERR_READ
893  *      Could not read the metadata resource for @a image from the WIM.
894  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
895  *      @a wim is part of a split WIM.  Deleting an image from a split WIM is
896  *      unsupported.
897  */
898 extern int wimlib_delete_image(WIMStruct *wim, int image);
899
900 /**
901  * Exports an image, or all the images, from a WIM file, into another WIM file.
902  *
903  * The destination image is made to share the same dentry tree and security data
904  * structure as the source image.  This places some restrictions on additional
905  * functions that may be called.  wimlib_mount_image() may not be called on
906  * either the source image or the destination image without an intervening call
907  * to a function that un-shares the images, such as wimlib_free() on @a
908  * dest_wim, or wimlib_delete_image() on either the source or destination image.
909  * Furthermore, you may not call wimlib_free() on @a src_wim before calling
910  * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
911  * have references back to @a src_wim.
912  *
913  * Previous versions of this function left @a dest_wim in an indeterminate state
914  * on failure.  This is no longer the case; all changes to @a dest_wim made by
915  * this function are rolled back on failure.
916  *
917  * Previous versions of this function did not allow exporting an image that had
918  * been added by wimlib_add_image().  This is no longer the case; you may now
919  * export an image regardless of how it was added.
920  *
921  * Regardless of whether this function succeeds or fails, no changes are made to
922  * @a src_wim.
923  *
924  * Please note that no changes are committed to the underlying WIM file of @a
925  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
926  *
927  * @param src_wim
928  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
929  *      WIM that contains the image(s) being exported.
930  * @param src_image
931  *      The image to export from @a src_wim.  Can be the number of an image, or
932  *      ::WIMLIB_ALL_IMAGES to export all images.
933  * @param dest_wim
934  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
935  *      being exported.
936  * @param dest_name
937  *      The name to give the exported image in the new WIM file.  If left @c
938  *      NULL, the name from @a src_wim is used.  This parameter must be left @c
939  *      NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
940  *      than one image; in that case, the names are all taken from the @a
941  *      src_wim.  (This is allowed even if one or more images being exported has
942  *      no name.)
943  * @param dest_description
944  *      The description to give the exported image in the new WIM file.  If left
945  *      @c NULL, the description from the @a src_wim is used.  This parameter must
946  *      be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
947  *      more than one image; in that case, the descriptions are all taken from
948  *      @a src_wim.  (This is allowed even if one or more images being exported
949  *      has no description.)
950  * @param export_flags
951  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
952  *      bootable, or 0 if which image is marked as bootable in the destination
953  *      WIM is to be left unchanged.  If @a src_image is ::WIMLIB_ALL_IMAGES and
954  *      there are multiple images in @a src_wim, specifying
955  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
956  *      currently marked as bootable in @a src_wim; if that is the case, then
957  *      that image is marked as bootable in the destination WIM.
958  * @param additional_swms
959  *      Array of pointers to the ::WIMStruct for each additional part in the
960  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
961  *      need to be in any particular order, but they must include all parts of
962  *      the split WIM other than the first part, which must be provided in the
963  *      @a wim parameter.
964  * @param num_additional_swms
965  *      Number of additional WIM parts provided in the @a additional_swms array.
966  *      This number should be one less than the total number of parts in the
967  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
968  * @param progress_func
969  *      If non-NULL, a function that will be called periodically with the
970  *      progress of the current operation.
971  *
972  * @return 0 on success; nonzero on error.
973  * @retval ::WIMLIB_ERR_DECOMPRESSION
974  *      Could not decompress the metadata resource for @a src_image
975  *      in @a src_wim
976  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
977  *      One or more of the names being given to an exported image was already in
978  *      use in the destination WIM.
979  * @retval ::WIMLIB_ERR_INVALID_DENTRY
980  *      A directory entry in the metadata resource for @a src_image in @a
981  *      src_wim is invalid.
982  * @retval ::WIMLIB_ERR_INVALID_IMAGE
983  *      @a src_image does not exist in @a src_wim.
984  * @retval ::WIMLIB_ERR_INVALID_PARAM
985  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
986  *      ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
987  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
988  *      dest_description were non-<code>NULL</code>, @a src_image was
989  *      ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
990  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
991  *      The metadata resource for @a src_image in @a src_wim is invalid.
992  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
993  *      The security data for @a src_image in @a src_wim is invalid.
994  * @retval ::WIMLIB_ERR_NOMEM
995  *      Failed to allocate needed memory.
996  * @retval ::WIMLIB_ERR_READ
997  *      Could not read the metadata resource for @a src_image from @a src_wim.
998  * @retval ::WIMLIB_ERR_SPLIT_INVALID
999  *      The source WIM is a split WIM, but the parts specified do not form a
1000  *      complete split WIM because they do not include all the parts of the
1001  *      original WIM, there are duplicate parts, or not all the parts have the
1002  *      same GUID and compression type.
1003  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1004  *      @a dest_wim is part of a split WIM.  Exporting an image to a split WIM
1005  *      is unsupported.
1006  */
1007 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
1008                                WIMStruct *dest_wim, const char *dest_name,
1009                                const char *dest_description, int export_flags,
1010                                WIMStruct **additional_swms,
1011                                unsigned num_additional_swms,
1012                                wimlib_progress_func_t progress_func);
1013
1014 /**
1015  * Extracts an image, or all images, from a standalone or split WIM file to a
1016  * directory or a NTFS volume.
1017  *
1018  * Please see the manual page for the @c imagex program for more information
1019  * about the "normal" extraction mode versus the NTFS extraction mode
1020  * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1021  *
1022  * Extraction is done with one thread.
1023  *
1024  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1025  * returned if any resulting SHA1 message digests do not match the values
1026  * provided in the WIM file.  Therefore, if this function is successful, you can
1027  * be fairly sure that any compressed data in the WIM was uncompressed
1028  * correctly.
1029  *
1030  * @param wim
1031  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1032  *      split WIM.
1033  * @param image
1034  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1035  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1036  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1037  * @param target
1038  *      Directory to extract the WIM image(s) to (created if it does not already
1039  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1040  *      path to the unmounted NTFS volume to extract the image to.
1041  * @param extract_flags
1042  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1043  *      <br/> <br/>
1044  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1045  *      a NTFS volume to extract the image to.  The volume will be opened using
1046  *      NTFS-3g and the image will be extracted to the root of the NTFS volume.
1047  *      Otherwise, @a target is interpreted as a directory to extract the
1048  *      image(s) to.
1049  *      <br/> <br/>
1050  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1051  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1052  *      specified.  These flags cause extracted files that are identical to be
1053  *      hardlinked or symlinked together, depending on the flag.  These flags
1054  *      override the hard link groups that are specified in the WIM file itself.
1055  *      If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1056  *      hardlinked or symlinked across images if a file is found to occur in
1057  *      more than one image.
1058  *      <br/> <br/>
1059  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1060  *      name of each file or directory as it is extracted.
1061  *      <br/> <br/>
1062  *      If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1063  *      WIM sequentially, if possible.  If ::WIMLIB_ALL_IMAGES is specified,
1064  *      each image is considered separately with regards to the sequential
1065  *      order.  It is also possible for alternate data streams to break the
1066  *      sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1067  *      specified).
1068  * @param additional_swms
1069  *      Array of pointers to the ::WIMStruct for each additional part in the
1070  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1071  *      need to be in any particular order, but they must include all parts of
1072  *      the split WIM other than the first part, which must be provided in the
1073  *      @a wim parameter.
1074  * @param num_additional_swms
1075  *      Number of additional WIM parts provided in the @a additional_swms array.
1076  *      This number should be one less than the total number of parts in the
1077  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1078  *
1079  * @param progress_func
1080  *      If non-NULL, a function that will be called periodically with the
1081  *      progress of the current operation.
1082  *
1083  * @return 0 on success; nonzero on error.
1084  * @retval ::WIMLIB_ERR_DECOMPRESSION
1085  *      Could not decompress a resource (file or metadata) for @a image in @a
1086  *      wim.
1087  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1088  *      A directory entry in the metadata resource for @a image in @a wim is
1089  *      invalid.
1090  * @retval ::WIMLIB_ERR_INVALID_PARAM
1091  *      @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1092  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags, or
1093  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1094  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1095  *      specified in @a extract_flags, or ::WIMLIB_EXTRACT_FLAG_NTFS was
1096  *      specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES.
1097  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1098  *      The SHA1 message digest of an extracted stream did not match the SHA1
1099  *      message digest given in the WIM file.
1100  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1101  *      A resource (file or metadata) for @a image in @a wim is invalid.
1102  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1103  *      The security data for @a image in @a wim is invalid.
1104  * @retval ::WIMLIB_ERR_LINK
1105 *       Failed to create a symbolic link or a hard link (only if
1106  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1107  * @retval ::WIMLIB_ERR_MKDIR
1108  *      Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1109  *      not specified in @a extract_flags).
1110  * @retval ::WIMLIB_ERR_NOMEM
1111  *      Failed to allocate needed memory.
1112  * @retval ::WIMLIB_ERR_NTFS_3G
1113  *      An error was returned from a libntfs-3g function while the WIM image was
1114  *      being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1115  *      was specified in @a extract_flags).
1116  * @retval ::WIMLIB_ERR_OPEN
1117  *      Could not open one of the files being extracted for writing (only if
1118  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1119  * @retval ::WIMLIB_ERR_READ
1120  *      A unexpected end-of-file or read error occurred when trying to read data
1121  *      from the WIM file associated with @a wim.
1122  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1123  *      The WIM is a split WIM, but the parts specified do not form a complete
1124  *      split WIM because they do not include all the parts of the original WIM,
1125  *      there are duplicate parts, or not all the parts have the same GUID and
1126  *      compression type.
1127  * @retval ::WIMLIB_ERR_UNSUPPORTED
1128  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1129  *      was configured with the @c --without-ntfs-3g flag.
1130  * @retval ::WIMLIB_ERR_WRITE
1131  *      Failed to write a file being extracted (only if
1132  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1133  */
1134 extern int wimlib_extract_image(WIMStruct *wim, int image,
1135                                 const char *target, int extract_flags,
1136                                 WIMStruct **additional_swms,
1137                                 unsigned num_additional_swms,
1138                                 wimlib_progress_func_t progress_func);
1139
1140 /**
1141  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1142  * includes a string of XML that describes the images contained in the WIM.
1143  * This function works on standalone WIMs as well as split WIM parts.
1144  *
1145  * @param wim
1146  *      Pointer to the ::WIMStruct for a WIM file.
1147  * @param fp
1148  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1149  *
1150  * @return 0 on success; nonzero on error.
1151  * @retval ::WIMLIB_ERR_WRITE
1152  *      Failed to completely write the XML data to @a fp.
1153  * @retval ::WIMLIB_ERR_INVALID_PARAM
1154  *      @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1155  */
1156 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1157
1158 /**
1159  * Frees all memory allocated for a WIMStruct and closes all files associated
1160  * with it.
1161  *
1162  * @param wim
1163  *      Pointer to the ::WIMStruct for a WIM file.
1164  *
1165  * @return This function has no return value.
1166  */
1167 extern void wimlib_free(WIMStruct *wim);
1168
1169 /**
1170  * Returns the index of the bootable image of the WIM.
1171  *
1172  * @param wim
1173  *      Pointer to the ::WIMStruct for a WIM file.
1174  *
1175  * @return
1176  *      0 if no image is marked as bootable, or the number of the image marked
1177  *      as bootable (numbered starting at 1).
1178  */
1179 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1180
1181 /**
1182  * Returns the compression type used in the WIM.
1183  *
1184  * @param wim
1185  *      Pointer to the ::WIMStruct for a WIM file
1186  *
1187  * @return
1188  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1189  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1190  */
1191 extern int wimlib_get_compression_type(const WIMStruct *wim);
1192
1193 /**
1194  * Converts a ::wimlib_compression_type value into a string.
1195  *
1196  * @param ctype
1197  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1198  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1199  *
1200  * @return
1201  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1202  *      respectively.
1203  */
1204 extern const char *wimlib_get_compression_type_string(int ctype);
1205
1206 /**
1207  * Converts an error code into a string describing it.
1208  *
1209  * @param code
1210  *      The error code returned by one of wimlib's functions.
1211  *
1212  * @return
1213  *      Pointer to a statically allocated string describing the error code,
1214  *      or @c NULL if the error code is not valid.
1215  */
1216 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1217
1218 /**
1219  * Returns the description of the specified image.
1220  *
1221  * @param wim
1222  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1223  *      standalone WIM or a split WIM part.
1224  * @param image
1225  *      The number of the image, numbered starting at 1.
1226  *
1227  * @return
1228  *      The description of the image, or @c NULL if there is no such image, or
1229  *      @c NULL if the specified image has no description.  The description
1230  *      string is in library-internal memory and may not be modified or freed;
1231  *      in addition, the string will become invalid if the description of the
1232  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1233  */
1234 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1235
1236 /**
1237  * Returns the name of the specified image.
1238  *
1239  * @param wim
1240  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1241  *      standalone WIM or a split WIM part.
1242  * @param image
1243  *      The number of the image, numbered starting at 1.
1244  *
1245  * @return
1246  *      The name of the image, or @c NULL if there is no such image.  The name
1247  *      string is in library-internal memory and may not be modified or freed;
1248  *      in addition, the string will become invalid if the name of the image is
1249  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
1250  *
1251  *      If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1252  *      the WIM to be unnamed, in which case an empty string will be returned
1253  *      when the corresponding name is requested.
1254  */
1255 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1256
1257
1258 /**
1259  * Returns the number of images contained in a WIM.
1260  *
1261  * @param wim
1262  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1263  *      standalone WIM or a split WIM part.
1264  *
1265  * @return
1266  *      The number of images contained in the WIM file.
1267  */
1268 extern int wimlib_get_num_images(const WIMStruct *wim);
1269
1270 /**
1271  * Returns the part number of a WIM in a split WIM and the total number of parts
1272  * of the split WIM.
1273  *
1274  * @param wim
1275  *      Pointer to the ::WIMStruct for a WIM file.
1276  * @param total_parts_ret
1277  *      If non-@c NULL, the total number of parts in the split WIM (1 for
1278  *      non-split WIMs) is written to this location.
1279  *
1280  * @return
1281  *      The part number of the WIM (1 for non-split WIMs)
1282  */
1283 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1284
1285 /**
1286  * Since wimlib 1.2.6:  Initialization function for wimlib.  This is not
1287  * re-entrant.  If you are calling wimlib functions concurrently in different
1288  * threads, then you must call this function serially first.  Otherwise, calling
1289  * this function is not required.
1290  *
1291  * @return 0 on success; nonzero on error.
1292  * @retval ::WIMLIB_ERR_NOMEM
1293  *      Could not allocate memory.
1294  * @retval ::WIMLIB_ERR_ICONV_NOT_AVAILABLE
1295  *      wimlib was configured --without-libntfs-3g at compilation time, and at
1296  *      runtime the iconv() set of functions did not seem to be available,
1297  *      perhaps due to missing files in the C library installation.
1298  *
1299  * If this function is not called or returns nonzero, then it will not be safe
1300  * to use wimlib in multiple threads.  Furthermore, a nonzero return value here
1301  * indicates that further calls into wimlib will probably fail when they try to
1302  * repeat the same initializations.
1303  */
1304 extern int wimlib_global_init();
1305
1306 /**
1307  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
1308  * You are not required to call this function, but it will release any global
1309  * memory allocated by the library.
1310  */
1311 extern void wimlib_global_cleanup();
1312
1313 /**
1314  * Returns true if the WIM has an integrity table.
1315  *
1316  * @param wim
1317  *      Pointer to the ::WIMStruct for a WIM file.
1318  * @return
1319  *      @c true if the WIM has an integrity table; @c false otherwise.  If @a
1320  *      wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1321  *      wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1322  *      been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1323  */
1324 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1325
1326
1327 /**
1328  * Determines if an image name is already used by some image in the WIM.
1329  *
1330  * @param wim
1331  *      Pointer to the ::WIMStruct for a WIM file.
1332  * @param name
1333  *      The name to check.
1334  *
1335  * @return
1336  *      @c true if there is already an image in @a wim named @a name; @c false
1337  *      if there is no image named @a name in @a wim.  If @a name is @c NULL or
1338  *      the empty string, @c false is returned.
1339  */
1340 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1341
1342 /**
1343  * Joins a split WIM into a stand-alone one-part WIM.
1344  *
1345  * @param swms
1346  *      An array of strings that gives the filenames of all parts of the split
1347  *      WIM.  No specific order is required, but all parts must be included with
1348  *      no duplicates.
1349  * @param num_swms
1350  *      Number of filenames in @a swms.
1351  * @param swm_open_flags
1352  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1353  *      part should be verified, if integrity tables are present.  Otherwise,
1354  *      set to 0.
1355  * @param wim_write_flags
1356  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1357  * @param output_path
1358  *      The path to write the one-part WIM to.
1359  * @param progress_func
1360  *      If non-NULL, a function that will be called periodically with the
1361  *      progress of the current operation.
1362  *
1363  * @return 0 on success; nonzero on error.  This function may return any value
1364  * returned by wimlib_open_wim() and wimlib_write() except
1365  * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1366  *
1367  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1368  *      The split WIMs do not form a valid WIM because they do not include all
1369  *      the parts of the original WIM, there are duplicate parts, or not all the
1370  *      parts have the same GUID and compression type.
1371  *
1372  * Note: the WIM's uncompressed and compressed resources are not checksummed
1373  * when they are copied from the split WIM parts to the joined WIM, nor are
1374  * compressed resources re-compressed.
1375  *
1376  * Note: wimlib_export_image() can provide similar functionality to
1377  * wimlib_join(), since it is possible to export all images from a split WIM.
1378  */
1379 extern int wimlib_join(const char **swms, unsigned num_swms,
1380                        const char *output_path, int swm_open_flags,
1381                        int wim_write_flags,
1382                        wimlib_progress_func_t progress_func);
1383
1384 /**
1385  * Mounts an image in a WIM file on a directory read-only or read-write.
1386  *
1387  * The calling thread will be daemonized to service the filesystem, and this
1388  * function will not return until the image is unmounted, unless an error occurs
1389  * before the filesystem is successfully mounted.
1390  *
1391  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1392  * modifications to the WIM are staged in a temporary directory.
1393  *
1394  * It is safe to mount multiple images from the same WIM file read-only at the
1395  * same time, but only if different ::WIMStruct's are used.  It is @b not safe
1396  * to mount multiple images from the same WIM file read-write at the same time.
1397  *
1398  * wimlib_mount_image() cannot be used on an image that was exported with
1399  * wimlib_export_image() while the dentry trees for both images are still in
1400  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
1401  * that has just been added with wimlib_add_image(), unless the WIM has been
1402  * written and read into a new ::WIMStruct.
1403  *
1404  * @param wim
1405  *      Pointer to the ::WIMStruct containing the image to be mounted.
1406  * @param image
1407  *      The number of the image to mount, indexed starting from it.  It must be
1408  *      an existing, single image.
1409  * @param dir
1410  *      The path to an existing empty directory to mount the image on.
1411  * @param mount_flags
1412  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1413  *      <br/><br/>
1414  *      If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1415  *      rather than the default of read-only.
1416  *      <br/> <br/>
1417  *      WIMs may contain named (alternate) data streams, which are a somewhat
1418  *      obscure NTFS feature.  They can be read and written on a mounted WIM
1419  *      through one of several interfaces.  The interface to use if specified by
1420  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1421  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1422  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
1423  *      the XATTR interface.
1424  * @param additional_swms
1425  *      Array of pointers to the ::WIMStruct for each additional part in the
1426  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1427  *      need to be in any particular order, but they must include all parts of
1428  *      the split WIM other than the first part, which must be provided in the
1429  *      @a wim parameter.
1430  * @param num_additional_swms
1431  *      Number of additional WIM parts provided in the @a additional_swms array.
1432  *      This number should be one less than the total number of parts in the
1433  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1434  * @param staging_dir
1435  *      If non-NULL, the name of a directory in which the staging directory will
1436  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1437  *      in @a mount_flags.  If left @c NULL, the staging directory is created in
1438  *      the same directory as the WIM file that @a wim was originally read from.
1439  *
1440  * @return 0 on success; nonzero on error.
1441  *
1442  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1443  *      A read-write mount was requested, but an an exclusive advisory lock on
1444  *      the on-disk WIM file could not be acquired because another thread or
1445  *      process has mounted an image from the WIM read-write or is currently
1446  *      modifying the WIM in-place.
1447  * @retval ::WIMLIB_ERR_DECOMPRESSION
1448  *      Could not decompress the metadata resource for @a image in @a wim.
1449  * @retval ::WIMLIB_ERR_FUSE
1450  *      A non-zero status was returned by @c fuse_main().
1451  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1452  *      A directory entry in the metadata resource for @a image in @a wim is
1453  *      invalid.
1454  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1455  *      @a image does not specify an existing, single image in @a wim.
1456  * @retval ::WIMLIB_ERR_INVALID_PARAM
1457  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
1458  *      wimlib_export_image(), or @a image has been added with
1459  *      wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
1460  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1461  *      The metadata resource for @a image in @a wim is invalid.
1462  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1463  *      The security data for @a image in @a wim is invalid.
1464  * @retval ::WIMLIB_ERR_MKDIR
1465  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1466  *      staging directory could not be created.
1467  * @retval ::WIMLIB_ERR_NOMEM
1468  *      Failed to allocate needed memory.
1469  * @retval ::WIMLIB_ERR_NOTDIR
1470  *      Could not determine the current working directory.
1471  * @retval ::WIMLIB_ERR_READ
1472  *      An unexpected end-of-file or read error occurred when trying to read
1473  *      data from the WIM file associated with @a wim.
1474  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1475  *      The WIM is a split WIM, but the parts specified do not form a complete
1476  *      split WIM because they do not include all the parts of the original WIM,
1477  *      there are duplicate parts, or not all the parts have the same GUID and
1478  *      compression type.
1479  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1480  *      The WIM is a split WIM and a read-write mount was requested.  We only
1481  *      support mounting a split WIM read-only.
1482  */
1483 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1484                               int mount_flags, WIMStruct **additional_swms,
1485                               unsigned num_additional_swms,
1486                               const char *staging_dir);
1487
1488 /**
1489  * Opens a WIM file and creates a ::WIMStruct for it.
1490  *
1491  * @param wim_file
1492  *      The path to the WIM file to open.
1493  * @param open_flags
1494  *      Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1495  *      ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1496  *      <br/> <br/>
1497  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1498  *      the WIM, if it exists, is checked, and this function will fail with an
1499  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1500  *      digests of the WIM do not exactly match the corresponding message
1501  *      digests given in the integrity table.
1502  *      <br/> <br/>
1503  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1504  *      WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1505  *      returned.  (This flag may be removed in the future, in which case no
1506  *      error will be issued when opening a split WIM.)
1507  *
1508  * @param progress_func
1509  *      If non-NULL, a function that will be called periodically with the
1510  *      progress of the current operation.
1511  *
1512  * @param wim_ret
1513  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1514  *      is written to the memory location pointed to by this parameter.  The
1515  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1516  *      it.
1517  *
1518  * @return 0 on success; nonzero on error.
1519  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1520  *      The lookup table of @a wim_file is compressed.  Support for this can be
1521  *      added to wimlib if needed, but it appears to be the case that the lookup
1522  *      table is never compressed.
1523  * @retval ::WIMLIB_ERR_IMAGE_COUNT
1524  *      The WIM is not the non-first part of a split WIM, and the number of
1525  *      metadata resources found in the WIM did not match the image count given
1526  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
1527  *      data for the WIM did not match the image count given in the WIM header.
1528  * @retval ::WIMLIB_ERR_INTEGRITY
1529  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1530  *      wim_file contains an integrity table, but the SHA1 message digest for a
1531  *      chunk of the WIM does not match the corresponding message digest given
1532  *      in the integrity table.
1533  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1534  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
1535  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1536  *      The header of @a wim_file says that resources in the WIM are compressed,
1537  *      but the header flag indicating LZX or XPRESS compression is not set.
1538  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1539  *      The length field of the WIM header is not 208.
1540  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1541  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1542  *      wim_file contains an integrity table, but the integrity table is
1543  *      invalid.
1544  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1545  *      The lookup table for the WIM contained duplicate entries that are not
1546  *      for metadata resources, or it contained an entry with a SHA1 message
1547  *      digest of all 0's.
1548  * @retval ::WIMLIB_ERR_NOMEM
1549  *      Failed to allocated needed memory.
1550  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1551  *      @a wim_file does not begin with the expected magic characters.
1552  * @retval ::WIMLIB_ERR_OPEN
1553  *      Failed to open the file @a wim_file for reading.
1554  * @retval ::WIMLIB_ERR_READ
1555  *      An unexpected end-of-file or read error occurred when trying to read
1556  *      data from @a wim_file.
1557  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1558  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1559  *      specified in @a open_flags.
1560  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1561  *      A number other than 0x10d00 is written in the version field of the WIM
1562  *      header of @a wim_file.  (Probably a pre-Vista WIM).
1563  * @retval ::WIMLIB_ERR_XML
1564  *      The XML data for @a wim_file is invalid.
1565  */
1566 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1567                            WIMStruct **wim_ret,
1568                            wimlib_progress_func_t progress_func);
1569
1570 /**
1571  * Overwrites the file that the WIM was originally read from, with changes made.
1572  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1573  * rather than wimlib_create_new_wim().
1574  *
1575  * There are two ways that a WIM may be overwritten.  The first is to do a full
1576  * rebuild.  In this mode, the new WIM is written to a temporary file and then
1577  * renamed to the original file after it is has been completely written.  The
1578  * temporary file is made in the same directory as the original WIM file.  A
1579  * full rebuild may take a while, but can be used even if images have been
1580  * modified or deleted, will produce a WIM with no holes, and has little chance
1581  * of unintentional data loss because the temporary WIM is fsync()ed before
1582  * being renamed to the original WIM.
1583  *
1584  * The second way to overwrite a WIM is by appending to the end of it and
1585  * overwriting the header.  This can be much faster than a full rebuild, but it
1586  * only works if the only operations on the WIM have been to change the header
1587  * and/or XML data, or to add new images.  Writing a WIM in this mode begins
1588  * with writing any new file resources *after* everything in the old WIM, even
1589  * though this will leave a hole where the old lookup table, XML data, and
1590  * integrity were.  This is done so that the WIM remains valid even if the
1591  * operation is aborted mid-write.  The WIM header is only overwritten at the
1592  * very last moment, and up until that point the WIM will be seen as the old
1593  * version.
1594  *
1595  * By default, the overwrite mode is determine automatically based on the past
1596  * operations performed on the ::WIMStruct.  Use the flag
1597  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1598  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1599  * images have been deleted from the WIM.
1600  *
1601  * In the temporary-file overwrite mode, no changes are made to the WIM on
1602  * failure, and the temporary file is deleted if possible.  Abnormal termination
1603  * of the program will result in the temporary file being orphaned.  In the
1604  * direct append mode, the WIM is truncated to the original length on failure;
1605  * and while abnormal termination of the program will result in extra data
1606  * appended to the original WIM, it should still be a valid WIM.
1607  *
1608  * @param wim
1609  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
1610  *      been in-memory changes made to it, which are then reflected in the
1611  *      output file.
1612  * @param write_flags
1613  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1614  *      ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1615  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1616  * @param num_threads
1617  *      Number of threads to use for compression (see wimlib_write()).
1618  * @param progress_func
1619  *      If non-NULL, a function that will be called periodically with the
1620  *      progress of the current operation.
1621  *
1622  * @return 0 on success; nonzero on error.  This function may return any value
1623  * returned by wimlib_write() as well as the following error codes:
1624  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1625  *      The WIM was going to be modifien in-place (with no temporary file), but
1626  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
1627  *      because another thread or process has mounted an image from the WIM
1628  *      read-write or is currently modifying the WIM in-place.
1629  * @retval ::WIMLIB_ERR_NO_FILENAME
1630  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1631  *      than a WIM read with wimlib_open_wim().
1632  * @retval ::WIMLIB_ERR_RENAME
1633  *      The temporary file that the WIM was written to could not be renamed to
1634  *      the original filename of @a wim.
1635  * @retval ::WIMLIB_ERR_REOPEN
1636  *      The WIM was overwritten successfully, but it could not be re-opened
1637  *      read-only.  Therefore, the resources in the WIM can no longer be
1638  *      accessed, so this limits the functions that can be called on @a wim
1639  *      before calling wimlib_free().
1640  */
1641 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1642                             unsigned num_threads,
1643                             wimlib_progress_func_t progress_func);
1644
1645 /**
1646  * Prints information about one image, or all images, contained in a WIM.
1647  *
1648  * @param wim
1649  *      Pointer to the ::WIMStruct for a WIM file.
1650  * @param image
1651  *      The image about which to print information.  Can be the number of an
1652  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1653  *      WIM.
1654  *
1655  * @return This function has no return value.  No error checking is done when
1656  * printing the information.  If @a image is invalid, an error message is
1657  * printed.
1658  */
1659 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1660
1661 /**
1662  * Prints the full paths to all files contained in an image, or all images, in a
1663  * WIM file.
1664  *
1665  * @param wim
1666  *      Pointer to the ::WIMStruct for a WIM file.
1667  * @param image
1668  *      Which image to print files for.  Can be the number of an image, or
1669  *      ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1670  *
1671  * @return 0 on success; nonzero on error.
1672  * @retval ::WIMLIB_ERR_DECOMPRESSION
1673  *      The metadata resource for one of the specified images could not be
1674  *      decompressed.
1675  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1676  *      A directory entry in the metadata resource for one of the specified
1677  *      images is invaled.
1678  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1679  *      @a image does not specify a valid image in @a wim, and is not
1680  *      ::WIMLIB_ALL_IMAGES.
1681  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1682  *      The metadata resource for one of the specified images is invalid.
1683  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1684  *      The security data for one of the specified images is invalid.
1685  * @retval ::WIMLIB_ERR_NOMEM
1686  *      Failed to allocate needed memory.
1687  * @retval ::WIMLIB_ERR_READ
1688  *      An unexpected read error or end-of-file occurred when reading the
1689  *      metadata resource for one of the specified images.
1690  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1691  *      @a wim was not a standalone WIM and was not the first part of a split
1692  *      WIM.
1693  */
1694 extern int wimlib_print_files(WIMStruct *wim, int image);
1695
1696 /**
1697  * Prints detailed information from the header of a WIM file.
1698  *
1699  * @param wim
1700  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1701  *      standalone WIM or part of a split WIM.
1702  *
1703  * @return This function has no return value.
1704  *
1705  */
1706 extern void wimlib_print_header(const WIMStruct *wim);
1707
1708 /**
1709  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
1710  * digests, as found in the directory entry tree in the WIM file, to file
1711  * resources in the WIM file.  This table includes one entry for each unique
1712  * file in the WIM, so it can be quite long.  There is only one lookup table per
1713  * WIM file, but each split WIM part has its own lookup table.
1714  *
1715  * @param wim
1716  *      Pointer to the ::WIMStruct for a WIM file.
1717  *
1718  * @return This function has no return value.
1719  */
1720 extern void wimlib_print_lookup_table(WIMStruct *wim);
1721
1722 /**
1723  * Prints the metadata of the specified image in a WIM file.  The metadata
1724  * consists of the security data as well as the directory entry tree.  Each
1725  * image has its own metadata.
1726  *
1727  * @param wim
1728  *      Pointer to the ::WIMStruct for a WIM file.
1729  * @param image
1730  *      Which image to print the metadata for.  Can be the number of an image,
1731  *      or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1732  *
1733  * @return 0 on success; nonzero on error.
1734  * @retval ::WIMLIB_ERR_DECOMPRESSION
1735  *      The metadata resource for one of the specified images could not be
1736  *      decompressed.
1737  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1738  *      A directory entry in the metadata resource for one of the specified
1739  *      images is invaled.
1740  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1741  *      @a image does not specify a valid image in @a wim, and is not
1742  *      ::WIMLIB_ALL_IMAGES.
1743  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1744  *      The metadata resource for one of the specified images is invalid.
1745  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1746  *      The security data for one of the specified images is invalid.
1747  * @retval ::WIMLIB_ERR_NOMEM
1748  *      Failed to allocate needed memory.
1749  * @retval ::WIMLIB_ERR_READ
1750  *      An unexpected read error or end-of-file occurred when reading the
1751  *      metadata resource for one of the specified images.
1752  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1753  *      @a wim was not a standalone WIM and was not the first part of a split
1754  *      WIM.
1755  */
1756 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1757
1758 /**
1759  * Prints some basic information about a WIM file.  All information printed by
1760  * this function is also printed by wimlib_print_header(), but
1761  * wimlib_print_wim_information() prints some of this information more concisely
1762  * and in a more readable form.
1763  *
1764  * @param wim
1765  *      Pointer to the ::WIMStruct for a WIM file.
1766  *
1767  * @return This function has no return value.
1768  */
1769 extern void wimlib_print_wim_information(const WIMStruct *wim);
1770
1771 /**
1772  * Translates a string specifying the name or number of an image in the WIM into
1773  * the number of the image.  The images are numbered starting at 1.
1774  *
1775  * @param wim
1776  *      Pointer to the ::WIMStruct for a WIM file.
1777  * @param image_name_or_num
1778  *      A string specifying the name or number of an image in the WIM.  If it
1779  *      parses to a positive integer, this integer is taken to specify the
1780  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
1781  *      be the name of an image, as given in the XML data for the WIM file.  It
1782  *      also may be the keyword "all" or the string "*", both of which will
1783  *      resolve to ::WIMLIB_ALL_IMAGES.
1784  *      <br/> <br/>
1785  *      There is no way to search for an image actually named "all", "*", or an
1786  *      integer number, or an image that has no name.  However, you can use
1787  *      wimlib_get_image_name() to get the name of any image.
1788  *
1789  * @return
1790  *      If the string resolved to a single existing image, the number of that
1791  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
1792  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
1793  *      ::WIMLIB_NO_IMAGE is returned.  If @a image_name_or_num was @c NULL or
1794  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1795  *      images in @a wim has no name.
1796  */
1797 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1798
1799 /**
1800  * Sets which image in the WIM is marked as bootable.
1801  *
1802  * @param wim
1803  *      Pointer to the ::WIMStruct for a WIM file.
1804  * @param boot_idx
1805  *      The number of the image to mark as bootable, or 0 to mark no image as
1806  *      bootable.
1807  * @return 0 on success; nonzero on error.
1808  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1809  *      @a boot_idx does not specify an existing image in @a wim, and it was not
1810  *      0.
1811  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1812  *      @a wim is part of a split WIM.  We do not support changing the boot
1813  *      index of a split WIM.
1814  */
1815 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1816
1817 /**
1818  * Changes the description of an image in the WIM.
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  *      description on all parts of a split WIM.
1824  * @param image
1825  *      The number of the image for which to change the description.
1826  * @param description
1827  *      The new description to give the image.  It may be @c NULL, which
1828  *      indicates that the image is to be given no description.
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 description
1835  *      string.
1836  */
1837 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1838                                        const char *description);
1839
1840 /**
1841  * Changes what is written in the \<FLAGS\> element in the WIM XML data
1842  * (something like "Core" or "Ultimate")
1843  *
1844  * @param wim
1845  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1846  *      standalone WIM or part of a split WIM; however, you should set the same
1847  *      \<FLAGS\> element on all parts of a split WIM.
1848  * @param image
1849  *      The number of the image for which to change the description.
1850  * @param flags
1851  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
1852  *      indicates that the image is to be given no \<FLAGS\> element.
1853  *
1854  * @return 0 on success; nonzero on error.
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 flags string.
1859  */
1860 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1861
1862 /**
1863  * Changes the name of an image in the WIM.
1864  *
1865  * @param wim
1866  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1867  *      standalone WIM or part of a split WIM; however, you should set the same
1868  *      name on all parts of a split WIM.
1869  * @param image
1870  *      The number of the image for which to change the name.
1871  * @param name
1872  *      The new name to give the image.  It must be a nonempty string.
1873  *
1874  * @return 0 on success; nonzero on error.
1875  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1876  *      There is already an image named @a name in @a wim.
1877  * @retval ::WIMLIB_ERR_INVALID_PARAM
1878  *      @a name was @c NULL or the empty string.
1879  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1880  *      @a image does not specify a single existing image in @a wim.
1881  * @retval ::WIMLIB_ERR_NOMEM
1882  *      Failed to allocate the memory needed to duplicate the @a name string.
1883  */
1884 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1885
1886 /**
1887  * Set the functions that wimlib uses to allocate and free memory.
1888  *
1889  * These settings are global and not per-WIM.
1890  *
1891  * The default is to use the default @c malloc() and @c free() from the C
1892  * library.
1893  *
1894  * Please note that some external functions, such as those in @c libntfs-3g, may
1895  * use the standard memory allocation functions.
1896  *
1897  * @param malloc_func
1898  *      A function equivalent to @c malloc() that wimlib will use to allocate
1899  *      memory.  If @c NULL, the allocator function is set back to the default
1900  *      @c malloc() from the C library.
1901  * @param free_func
1902  *      A function equivalent to @c free() that wimlib will use to free memory.
1903  *      If @c NULL, the free function is set back to the default @c free() from
1904  *      the C library.
1905  * @param realloc_func
1906  *      A function equivalent to @c realloc() that wimlib will use to reallocate
1907  *      memory.  If @c NULL, the free function is set back to the default @c
1908  *      realloc() from the C library.
1909  * @return 0 on success; nonzero on error.
1910  * @retval ::WIMLIB_ERR_UNSUPPORTED
1911  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
1912  *      so custom memory allocators are unsupported.
1913  */
1914 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1915                                  void (*free_func)(void *),
1916                                  void *(*realloc_func)(void *, size_t));
1917
1918 /**
1919  * Sets whether wimlib is to print error messages to @c stderr when a function
1920  * fails.  These error messages may provide information that cannot be
1921  * determined only from the error code that is returned.  Not every error will
1922  * result in an error message being printed.
1923  *
1924  * This setting is global and not per-WIM.
1925  *
1926  * By default, error messages are not printed.
1927  *
1928  * @param show_messages
1929  *      @c true if error messages are to be printed; @c false if error messages
1930  *      are not to be printed.
1931  *
1932  * @return 0 on success; nonzero on error.
1933  * @retval ::WIMLIB_ERR_UNSUPPORTED
1934  *      @a show_messages was @c true, but wimlib was compiled with the @c
1935  *      --without-error-messages option.   Therefore, error messages cannot be
1936  *      shown.
1937  */
1938 extern int wimlib_set_print_errors(bool show_messages);
1939
1940 /**
1941  * Splits a WIM into multiple parts.
1942  *
1943  * @param wim
1944  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
1945  *      WIM.
1946  * @param swm_name
1947  *      Name of the SWM file to create.  This will be the name of the first
1948  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
1949  *      appended before the suffix.
1950  * @param part_size
1951  *      The maximum size per part, in bytes.  It is not guaranteed that this
1952  *      will really be the maximum size per part, because some file resources in
1953  *      the WIM may be larger than this size, and the WIM file format provides
1954  *      no way to split up file resources among multiple WIMs.
1955  * @param write_flags
1956  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
1957  *      included in the split WIM parts.
1958  * @param progress_func
1959  *      If non-NULL, a function that will be called periodically with the
1960  *      progress of the current operation.
1961  *
1962  * @return 0 on success; nonzero on error.  This function may return any value
1963  * returned by wimlib_write() as well as the following error codes:
1964  *
1965  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1966  *      @a wim is not part 1 of a stand-alone WIM.
1967  * @retval ::WIMLIB_ERR_INVALID_PARAM
1968  *      @a swm_name was @c NULL, or @a part_size was 0.
1969  *
1970  * Note: the WIM's uncompressed and compressed resources are not checksummed
1971  * when they are copied from the joined WIM to the split WIM parts, nor are
1972  * compressed resources re-compressed.
1973  */
1974 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
1975                         size_t part_size, int write_flags,
1976                         wimlib_progress_func_t progress_func);
1977
1978 /**
1979  * Unmounts a WIM image that was mounted using wimlib_mount_image().
1980  *
1981  * The image to unmount is specified by the path to the mountpoint, not the
1982  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
1983  * touched and also may have been allocated in a different process.
1984  *
1985  * To unmount the image, the thread calling this function communicates with the
1986  * thread that is managing the mounted WIM image.  This function blocks until it
1987  * is known whether the unmount succeeded or failed.  In the case of a
1988  * read-write mounted WIM, the unmount is not considered to have succeeded until
1989  * all changes have been saved to the underlying WIM file.
1990  *
1991  * @param dir
1992  *      The directory that the WIM image was mounted on.
1993  * @param unmount_flags
1994  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
1995  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
1996  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
1997  *      mounts.
1998  * @param progress_func
1999  *      If non-NULL, a function that will be called periodically with the
2000  *      progress of the current operation.
2001  *
2002  * @return 0 on success; nonzero on error.
2003  *
2004  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2005  *      The filesystem daemon was unable to remove the staging directory and the
2006  *      temporary files that it contains.
2007  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2008  *      The filesystem daemon appears to have terminated before sending an exit
2009  *      status.
2010  * @retval ::WIMLIB_ERR_FORK
2011  *      Could not @c fork() the process.
2012  * @retval ::WIMLIB_ERR_FUSERMOUNT
2013  *      The @b fusermount program could not be executed or exited with a failure
2014  *      status.
2015  * @retval ::WIMLIB_ERR_MQUEUE
2016  *      Could not open a POSIX message queue to communicate with the filesystem
2017  *      daemon servicing the mounted filesystem, could not send a message
2018  *      through the queue, or could not receive a message through the queue.
2019  * @retval ::WIMLIB_ERR_NOMEM
2020  *      Failed to allocate needed memory.
2021  * @retval ::WIMLIB_ERR_OPEN
2022  *      The filesystem daemon could not open a temporary file for writing the
2023  *      new WIM.
2024  * @retval ::WIMLIB_ERR_READ
2025  *      A read error occurred when the filesystem daemon tried to a file from
2026  *      the staging directory
2027  * @retval ::WIMLIB_ERR_RENAME
2028  *      The filesystem daemon failed to rename the newly written WIM file to the
2029  *      original WIM file.
2030  * @retval ::WIMLIB_ERR_WRITE
2031  *      A write error occurred when the filesystem daemon was writing to the new
2032  *      WIM file, or the filesystem daemon was unable to flush changes that had
2033  *      been made to files in the staging directory.
2034  */
2035 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
2036                                 wimlib_progress_func_t progress_func);
2037
2038 /**
2039  * Writes a standalone WIM to a file.
2040  *
2041  * This brings in resources from any external locations, such as directory trees
2042  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2043  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2044  *
2045  * @param wim
2046  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
2047  *      changes made to it, which are then reflected in the output file.
2048  * @param path
2049  *      The path to the file to write the WIM to.
2050  * @param image
2051  *      The image inside the WIM to write.  Use ::WIMLIB_ALL_IMAGES to include all
2052  *      images.
2053  * @param write_flags
2054  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2055  *      ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2056  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2057  * @param num_threads
2058  *      Number of threads to use for compressing data.  If 0, the number of
2059  *      threads is taken to be the number of online processors.  Note: if no
2060  *      data compression needs to be done, no additional threads will be created
2061  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
2062  *      exporting an image from a compressed WIM to another WIM of the same
2063  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2064  *      write_flags).
2065  * @param progress_func
2066  *      If non-NULL, a function that will be called periodically with the
2067  *      progress of the current operation.
2068  *
2069  * @return 0 on success; nonzero on error.
2070  * @retval ::WIMLIB_ERR_DECOMPRESSION
2071  *      Failed to decompress a metadata or file resource in @a wim.
2072  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2073  *      A directory entry in the metadata resource for @a image in @a wim is
2074  *      invalid.
2075  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2076  *      @a image does not specify a single existing image in @a wim, and is not
2077  *      ::WIMLIB_ALL_IMAGES.
2078  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2079  *      A file that had previously been scanned for inclusion in the WIM by the
2080  *      wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
2081  *      concurrently modified, so it failed the SHA1 message digest check.
2082  * @retval ::WIMLIB_ERR_INVALID_PARAM
2083  *      @a path was @c NULL.
2084  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2085  *      The metadata resource for @a image in @a wim is invalid.
2086  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2087  *      The security data for @a image in @a wim is invalid.
2088  * @retval ::WIMLIB_ERR_NOMEM
2089  *      Failed to allocate needed memory.
2090  * @retval ::WIMLIB_ERR_OPEN
2091  *      Failed to open @a path for writing, or some file resources in @a
2092  *      wim refer to files in the outside filesystem, and one of these files
2093  *      could not be opened for reading.
2094  * @retval ::WIMLIB_ERR_READ
2095  *      An error occurred when trying to read data from the WIM file associated
2096  *      with @a wim, or some file resources in @a wim refer to files in the
2097  *      outside filesystem, and a read error occurred when reading one of these
2098  *      files.
2099  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2100  *      @a wim is part of a split WIM.  You may not call this function on a
2101  *      split WIM.
2102  * @retval ::WIMLIB_ERR_WRITE
2103  *      An error occurred when trying to write data to the new WIM file at @a
2104  *      path.
2105  */
2106 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2107                         int write_flags, unsigned num_threads,
2108                         wimlib_progress_func_t progress_func);
2109
2110 #endif /* _WIMLIB_H */