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