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