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