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