wimlib.h: Fix docs for WIMLIB_OPEN_FLAG_WRITE_ACCESS
[wimlib] / include / 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.4.1, a C
35  * library for creating, modifying, extracting, and mounting files in the
36  * Windows Imaging Format.  This documentation is intended for developers only.
37  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38  * program, please see the README file.
39  *
40  * \section starting Getting Started
41  *
42  * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43  * install with <code>configure && make && sudo make install</code>; however,
44  * please see the README for more information about installing it.  To use
45  * wimlib in a program after installing it, include @c wimlib.h and link your
46  * program with @c -lwim.
47  *
48  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.  A ::WIMStruct
49  * may represent either a stand-alone WIM or one part of a split WIM.
50  *
51  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
52  * return 0 on success and a positive error code on failure.  Use
53  * wimlib_get_error_string() to get a string that describes an error code.
54  * wimlib also can print error messages itself when an error happens, and these
55  * may be more informative than the error code; to enable this, call
56  * wimlib_set_print_errors().  Please note that this is for convenience only,
57  * and some errors can occur without a message being printed.
58  *
59  * First before calling any other functions, you should call
60  * wimlib_global_init() to initialize the library.
61  *
62  * To open an existing WIM, use wimlib_open_wim().
63  *
64  * To create a new WIM that initially contains no images, use
65  * wimlib_create_new_wim().
66  *
67  * To add an image to a WIM file from a directory tree on your filesystem, call
68  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
69  * wimlib_open_wim() or from wimlib_create_new_wim().  On UNIX,
70  * wimlib_add_image() can also capture a WIM image directly from a block device
71  * containing a NTFS filesystem.
72  *
73  * To extract an image from a WIM file, call wimlib_extract_image().  This can
74  * be done either to a directory, or, on UNIX, directly to a block device
75  * containing a NTFS filesystem.
76  *
77  * To extract individual files or directories from a WIM image, rather than a
78  * full image, call wimlib_extract_files().
79  *
80  * To programatically make changes to a WIM image without mounting it, call
81  * wimlib_update_image().
82  *
83  * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84  * Mounting is done using wimlib_mount_image() and unmounting is done using
85  * wimlib_unmount_image().  Mounting can be done without root privileges because
86  * it is implemented using FUSE (Filesystem in Userspace).  If wimlib is
87  * compiled with the <code>--without-fuse</code> flag, these functions will be
88  * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
89  *
90  * After creating or modifying a WIM file, you can write it to a file using
91  * wimlib_write().  Alternatively,  if the WIM was originally read from a file
92  * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93  * wimlib_overwrite() to overwrite the original file.
94  *
95  * Please note: merely by calling wimlib_add_image() or many of the other
96  * functions in this library that operate on ::WIMStruct's, you are @b not
97  * modifying the WIM file on disk.  Changes are not saved until you explicitly
98  * call wimlib_write() or wimlib_overwrite().
99  *
100  * After you are done with the WIM file, use wimlib_free() to free all memory
101  * associated with a ::WIMStruct and close all files associated with it.
102  *
103  * When you are completely done with using wimlib in your program, you should
104  * call wimlib_global_cleanup().
105  *
106  * A number of functions take a pointer to a progress function of type
107  * ::wimlib_progress_func_t.  This function will be called periodically during
108  * the WIM operation(s) to report on the progress of the operation (for example,
109  * how many bytes have been written so far).
110  *
111  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112  * the following exceptions:
113  * - You must call wimlib_global_init() in one thread before calling any other
114  *   functions.
115  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
116  *   race conditions with one-time allocations of memory.
117  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
118  *   concurrently in the same process, will daemonize the entire process when it
119  *   does so for the first time.  This includes changing the working directory
120  *   to the root directory.
121  *
122  * \section encodings Locales and character encodings
123  *
124  * To support Windows as well as UNIX, wimlib's API typically takes and returns
125  * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
126  *
127  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
128  * and the encoding is UTF-16LE.
129  *
130  * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
131  * encoding is the locale-dependent multibyte encoding.  I recommend you set
132  * your locale to a UTF-8 capable locale to avoid any issues.  Also, by default,
133  * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
134  * wimlib_global_init() after having set your desired locale.
135  *
136  * \section Limitations
137  *
138  * This section documents some technical limitations of wimlib not already
139  * documented in the man page for @b wimlib-imagex.
140  *
141  * - The old WIM format from Vista pre-releases is not supported.
142  * - Compressed resource chunk sizes other than 32768 are not supported.  This
143  *   doesn't seem to be a real problem because the chunk size always seems to be
144  *   this value.
145  * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
146  *   functionality other than that already present in @b ImageX, that allows you
147  *   to make certain Windows-specific modifications to a Windows PE image, such
148  *   as adding a driver or Windows component.  Such a tool possibly could be
149  *   implemented on top of wimlib.
150  */
151
152 #ifndef _WIMLIB_H
153 #define _WIMLIB_H
154
155 #include <stdio.h>
156 #include <stddef.h>
157 #include <stdbool.h>
158 #include <inttypes.h>
159
160 /** Major version of the library (for example, the 1 in 1.2.5). */
161 #define WIMLIB_MAJOR_VERSION 1
162
163 /** Minor version of the library (for example, the 2 in 1.2.5). */
164 #define WIMLIB_MINOR_VERSION 4
165
166 /** Patch version of the library (for example, the 5 in 1.2.5). */
167 #define WIMLIB_PATCH_VERSION 1
168
169 /**
170  * Opaque structure that represents a WIM file.  This is an in-memory structure
171  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
172  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
173  * continuing to exist so that data can be read from it as needed.
174  *
175  * Most functions in this library will work the same way regardless of whether a
176  * given ::WIMStruct was obtained through wimlib_open_wim() or
177  * wimlib_create_new_wim().  Exceptions are documented.
178  *
179  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
180  * file from a ::WIMStruct.
181  */
182 #ifndef WIMLIB_WIMSTRUCT_DECLARED
183 typedef struct WIMStruct WIMStruct;
184 #define WIMLIB_WIMSTRUCT_DECLARED
185 #endif
186
187 #ifdef __WIN32__
188 typedef wchar_t wimlib_tchar;
189 #else
190 /** See \ref encodings */
191 typedef char wimlib_tchar;
192 #endif
193
194 #ifdef __WIN32__
195 /** Path separator for WIM paths passed back to progress callbacks. */
196 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
197 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
198 #else
199 /** Path separator for WIM paths passed back to progress callbacks. */
200 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
201 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
202 #endif
203
204 #ifdef __GNUC__
205 #  define _wimlib_deprecated __attribute__((deprecated))
206 #else
207 #  define _wimlib_deprecated
208 #endif
209
210 /**
211  * Specifies the compression type of a WIM file.
212  */
213 enum wimlib_compression_type {
214         /** An invalid compression type. */
215         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
216
217         /** The WIM does not include any compressed resources. */
218         WIMLIB_COMPRESSION_TYPE_NONE = 0,
219
220         /** Compressed resources in the WIM use LZX compression. */
221         WIMLIB_COMPRESSION_TYPE_LZX = 1,
222
223         /** Compressed resources in the WIM use XPRESS compression. */
224         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
225 };
226
227 /** Possible values of the first parameter to the user-supplied
228  * ::wimlib_progress_func_t progress function */
229 enum wimlib_progress_msg {
230
231         /** A WIM image is about to be extracted.  @a info will point to
232          * ::wimlib_progress_info.extract. */
233         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
234
235         /** A file or directory tree within a WIM image (not the full image) is
236          * about to be extracted.  @a info will point to
237          * ::wimlib_progress_info.extract. */
238         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
239
240         /** The directory structure of the WIM image is about to be extracted.
241          * @a info will point to ::wimlib_progress_info.extract. */
242         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
243
244         /** The directory structure of the WIM image has been successfully
245          * extracted.  @a info will point to ::wimlib_progress_info.extract. */
246         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
247
248         /** The WIM image's files resources are currently being extracted.  @a
249          * info will point to ::wimlib_progress_info.extract. */
250         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
251
252         /** A file or directory is being extracted.  @a info will point to
253          * ::wimlib_progress_info.extract, and the @a cur_path member will be
254          * valid. */
255         WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
256
257         /** All the WIM files and directories have been extracted, and
258          * timestamps are about to be applied.  @a info will point to
259          * ::wimlib_progress_info.extract. */
260         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
261
262         /** A WIM image has been successfully extracted.  @a info will point to
263          * ::wimlib_progress_info.extract. */
264         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
265
266         /** A file or directory tree within a WIM image (not the full image) has
267          * been successfully extracted.  @a info will point to
268          * ::wimlib_progress_info.extract. */
269         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
270
271         /** The directory or NTFS volume is about to be scanned to build a tree
272          * of WIM dentries in-memory.  @a info will point to
273          * ::wimlib_progress_info.scan. */
274         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
275
276         /** A directory or file is being scanned.  @a info will point to
277          * ::wimlib_progress_info.scan, and its @a cur_path member will be
278          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
279          * is passed to wimlib_add_image(). */
280         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
281
282         /** The directory or NTFS volume has been successfully scanned, and a
283          * tree of WIM dentries has been built in-memory. @a info will point to
284          * ::wimlib_progress_info.scan. */
285         WIMLIB_PROGRESS_MSG_SCAN_END,
286
287         /**
288          * File resources are currently being written to the WIM.
289          * @a info will point to ::wimlib_progress_info.write_streams. */
290         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
291
292         /**
293          * The metadata resource for each image is about to be written to the
294          * WIM. @a info will not be valid. */
295         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
296
297         /**
298          * The metadata resource for each image has successfully been writen to
299          * the WIM.  @a info will not be valid. */
300         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
301
302         /**
303          * The temporary file has successfully been renamed to the original WIM
304          * file.  Only happens when wimlib_overwrite() is called and the
305          * overwrite is not done in-place.
306          * @a info will point to ::wimlib_progress_info.rename. */
307         WIMLIB_PROGRESS_MSG_RENAME,
308
309         /** The contents of the WIM are being checked against the integrity
310          * table.  Only happens when wimlib_open_wim() is called with the
311          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  @a info will point to
312          * ::wimlib_progress_info.integrity. */
313         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
314
315         /** An integrity table is being calculated for the WIM being written.
316          * Only happens when wimlib_write() or wimlib_overwrite() is called with
317          * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag.  @a info will point to
318          * ::wimlib_progress_info.integrity. */
319         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
320
321         /** A wimlib_join() operation is in progress.  @a info will point to
322          * ::wimlib_progress_info.join. */
323         WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
324
325         /** A wimlib_split() operation is in progress, and a new split part is
326          * about to be started.  @a info will point to
327          * ::wimlib_progress_info.split. */
328         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
329
330         /** A wimlib_split() operation is in progress, and a split part has been
331          * finished. @a info will point to ::wimlib_progress_info.split. */
332         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
333
334         /**
335          * A WIM update command is just about to be executed; @a info will point
336          * to ::wimlib_progress_info.update.
337          */
338         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
339
340         /**
341          * A WIM update command has just been executed; @a info will point to
342          * ::wimlib_progress_info.update.
343          */
344         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
345
346 };
347
348 /** A pointer to this union is passed to the user-supplied
349  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
350  * contained in this union will be applicable for the operation
351  * (::wimlib_progress_msg) indicated in the first argument to the progress
352  * function. */
353 union wimlib_progress_info {
354
355         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
356          * document them if they aren't given a name... */
357
358         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
359         struct wimlib_progress_info_write_streams {
360                 /** Number of bytes that are going to be written for all the
361                  * streams combined.  This is the amount in uncompressed data.
362                  * (The actual number of bytes will be less if the data is being
363                  * written compressed.) */
364                 uint64_t total_bytes;
365                 /** Number of streams that are going to be written. */
366                 uint64_t total_streams;
367
368                 /** Number of uncompressed bytes that have been written so far.
369                  * Will be 0 initially, and equal to @a total_bytes at the end.
370                  * */
371                 uint64_t completed_bytes;
372
373                 /** Number of streams that have been written.  Will be 0
374                  * initially, and equal to @a total_streams at the end. */
375                 uint64_t completed_streams;
376
377                 /** Number of threads that are being used to compress resources
378                  * (if applicable). */
379                 unsigned num_threads;
380
381                 /** The compression type being used to write the streams; either
382                  * ::WIMLIB_COMPRESSION_TYPE_NONE,
383                  * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
384                  * ::WIMLIB_COMPRESSION_TYPE_LZX. */
385                 int      compression_type;
386
387                 /** Library internal use only. */
388                 uint64_t _private;
389         } write_streams;
390
391         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
392          * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
393         struct wimlib_progress_info_scan {
394                 /** Directory or NTFS volume that is being scanned. */
395                 const wimlib_tchar *source;
396
397                 /** Path to the file or directory that is about to be scanned,
398                  * relative to the root of the image capture or the NTFS volume.
399                  * */
400                 const wimlib_tchar *cur_path;
401
402                 /** True iff @a cur_path is being excluded from the image
403                  * capture due to the capture configuration file. */
404                 bool excluded;
405
406                 /** Target path in the WIM.  Only valid on messages
407                  * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
408                  * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
409                 const wimlib_tchar *wim_target_path;
410         } scan;
411
412         /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
413          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
414          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
415          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
416          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
417         struct wimlib_progress_info_extract {
418                 /** Number of the image being extracted (1-based). */
419                 int image;
420
421                 /** Flags passed to to wimlib_extract_image() */
422                 int extract_flags;
423
424                 /** Full path to the WIM file being extracted. */
425                 const wimlib_tchar *wimfile_name;
426
427                 /** Name of the image being extracted. */
428                 const wimlib_tchar *image_name;
429
430                 /** Directory or NTFS volume to which the image is being
431                  * extracted. */
432                 const wimlib_tchar *target;
433
434                 /** Current dentry being extracted.  (Valid only if message is
435                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
436                 const wimlib_tchar *cur_path;
437
438                 /** Number of bytes of uncompressed data that will be extracted.
439                  * Takes into account hard links (they are not counted for each
440                  * link.)
441                  * */
442                 uint64_t total_bytes;
443
444                 /** Number of bytes that have been written so far.  Will be 0
445                  * initially, and equal to @a total_bytes at the end. */
446                 uint64_t completed_bytes;
447
448                 /** Number of streams that will be extracted.  This may more or
449                  * less than the number of "files" to be extracted due to
450                  * special cases (hard links, symbolic links, and alternate data
451                  * streams.) */
452                 uint64_t num_streams;
453
454                 /** Path to the root dentry within the WIM for the tree that is
455                  * being extracted.  Will be the empty string when extracting a
456                  * full image. */
457                 const wimlib_tchar *extract_root_wim_source_path;
458         } extract;
459
460         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
461         struct wimlib_progress_info_rename {
462                 /** Name of the temporary file that the WIM was written to. */
463                 const wimlib_tchar *from;
464
465                 /** Name of the original WIM file to which the temporary file is
466                  * being renamed. */
467                 const wimlib_tchar *to;
468         } rename;
469
470         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
471          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
472         struct wimlib_progress_info_update {
473                 /** Pointer to the update command that will be executed or has
474                  * just been executed. */
475                 const struct wimlib_update_command *command;
476
477                 /** Number of update commands that have been completed so far.
478                  */
479                 size_t completed_commands;
480
481                 /** Number of update commands that are being executed as part of
482                  * this call to wimlib_update_image(). */
483                 size_t total_commands;
484         } update;
485
486         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
487          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
488         struct wimlib_progress_info_integrity {
489                 /** Number of bytes from the end of the WIM header to the end of
490                  * the lookup table (the area that is covered by the SHA1
491                  * integrity checks.) */
492                 uint64_t total_bytes;
493
494                 /** Number of bytes that have been SHA1-summed so far.  Will be
495                  * 0 initially, and equal @a total_bytes at the end. */
496                 uint64_t completed_bytes;
497
498                 /** Number of chunks that the checksummed region is divided
499                  * into. */
500                 uint32_t total_chunks;
501
502                 /** Number of chunks that have been SHA1-summed so far.   Will
503                  * be 0 initially, and equal to @a total_chunks at the end. */
504                 uint32_t completed_chunks;
505
506                 /** Size of the chunks used for the integrity calculation. */
507                 uint32_t chunk_size;
508
509                 /** Filename of the WIM (only valid if the message is
510                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
511                 const wimlib_tchar *filename;
512         } integrity;
513
514         /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
515         struct wimlib_progress_info_join {
516                 /** Total number of bytes of compressed data contained in all
517                  * the split WIM part's file and metadata resources. */
518                 uint64_t total_bytes;
519
520                 /** Number of bytes that have been copied to the joined WIM so
521                  * far.  Will be 0 initially, and equal to @a total_bytes at the
522                  * end. */
523                 uint64_t completed_bytes;
524
525                 /** Number of split WIM parts that have had all their file and
526                  * metadata resources copied over to the joined WIM so far. */
527                 unsigned completed_parts;
528
529                 /** Number of split WIM parts. */
530                 unsigned total_parts;
531         } join;
532
533         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
534          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
535         struct wimlib_progress_info_split {
536                 /** Total size of the original WIM's file and metadata resources
537                  * (compressed). */
538                 uint64_t total_bytes;
539
540                 /** Number of bytes of file and metadata resources that have
541                  * been copied out of the original WIM so far.  Will be 0
542                  * initially, and equal to @a total_bytes at the end. */
543                 uint64_t completed_bytes;
544
545                 /** Number of the split WIM part that is about to be started
546                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
547                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
548                 unsigned cur_part_number;
549
550                 /** Name of the split WIM part that is about to be started
551                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
552                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
553                 const wimlib_tchar *part_name;
554         } split;
555 };
556
557 /** A user-supplied function that will be called periodically during certain WIM
558  * operations.  The first argument will be the type of operation that is being
559  * performed or is about to be started or has been completed.  The second
560  * argument will be a pointer to one of a number of structures depending on the
561  * first argument.  It may be @c NULL for some message types.
562  *
563  * The return value of the progress function is currently ignored, but it may do
564  * something in the future.  (Set it to 0 for now.)
565  */
566 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
567                                       const union wimlib_progress_info *info);
568
569 /** An array of these structures is passed to wimlib_add_image_multisource() to
570  * specify the sources from which to create a WIM image. */
571 struct wimlib_capture_source {
572         /** Absolute or relative path to a file or directory on the external
573          * filesystem to be included in the WIM image. */
574         wimlib_tchar *fs_source_path;
575
576         /** Destination path in the WIM image.  Leading and trailing slashes are
577          * ignored.  The empty string or @c NULL means the root directory of the
578          * WIM image. */
579         wimlib_tchar *wim_target_path;
580
581         /** Reserved; set to 0. */
582         long reserved;
583 };
584
585 /** Structure that specifies a list of path patterns. */
586 struct wimlib_pattern_list {
587         /** Array of patterns.  The patterns may be modified by library code,
588          * but the @a pats pointer itself will not.  See the man page for
589          * <b>wimlib-imagex capture</b> for more information about allowed
590          * patterns. */
591         wimlib_tchar **pats;
592
593         /** Number of patterns in the @a pats array. */
594         size_t num_pats;
595
596         /** Ignored; may be used by the calling code. */
597         size_t num_allocated_pats;
598 };
599
600 /** A structure that contains lists of wildcards that match paths to treat
601  * specially when capturing a WIM image. */
602 struct wimlib_capture_config {
603         /** Paths matching any pattern this list are excluded from being
604          * captured, except if the same path appears in @a
605          * exclusion_exception_pats. */
606         struct wimlib_pattern_list exclusion_pats;
607
608         /** Paths matching any pattern in this list are never excluded from
609          * being captured. */
610         struct wimlib_pattern_list exclusion_exception_pats;
611
612         /** Reserved for future capture configuration options. */
613         struct wimlib_pattern_list reserved1;
614
615         /** Reserved for future capture configuration options. */
616         struct wimlib_pattern_list reserved2;
617
618         /** Library internal use only. */
619         const wimlib_tchar *_prefix;
620
621         /** Library internal use only. */
622         size_t _prefix_num_tchars;
623 };
624
625 /** Set or unset the WIM header flag that marks it read-only
626  * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
627  * ::wimlib_wim_info.is_marked_readonly member of the @a info parameter.  This
628  * is distinct from basic file permissions; this flag can be set on a WIM file
629  * that is physically writable.  If this flag is set, all further operations to
630  * modify the WIM will fail, except calling wimlib_overwrite() with
631  * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
632  * allows you to set this flag persistently on the underlying WIM file.
633  */
634 #define WIMLIB_CHANGE_READONLY_FLAG             0x00000001
635
636 /** Set the GUID (globally unique identifier) of the WIM file to the value
637  * specified in ::wimlib_wim_info.guid of the @a info parameter. */
638 #define WIMLIB_CHANGE_GUID                      0x00000002
639
640 /** Change the bootable image of the WIM to the value specified in
641  * ::wimlib_wim_info.boot_index of the @a info parameter.  */
642 #define WIMLIB_CHANGE_BOOT_INDEX                0x00000004
643
644 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
645  * in ::wimlib_wim_info.has_rpfix of the @a info parameter.  This flag generally
646  * indicates whether an image in the WIM has been captured with reparse-point
647  * fixups enabled.  wimlib also treats this flag as specifying whether to do
648  * reparse-point fixups by default when capturing or applying WIM images.  */
649 #define WIMLIB_CHANGE_RPFIX_FLAG                0x00000008
650
651 #define WIMLIB_GUID_LEN 16
652
653 /** General information about a WIM file. */
654 struct wimlib_wim_info {
655
656         /** Globally unique identifier for the WIM file.  Note: all parts of a
657          * split WIM should have an identical value in this field.  */
658         uint8_t  guid[WIMLIB_GUID_LEN];
659
660         /** Number of images in the WIM.  */
661         uint32_t image_count;
662
663         /** 1-based index of the bootable image in the WIM, or 0 if no image is
664          * bootable.  */
665         uint32_t boot_index;
666
667         /** Version of the WIM file.  */
668         uint32_t wim_version;
669
670         /** Chunk size used for compression.  */
671         uint32_t chunk_size;
672
673         /** 1-based index of this part within a split WIM, or 1 if the WIM is
674          * standalone.  */
675         uint16_t part_number;
676
677         /** Total number of parts in the split WIM, or 1 if the WIM is
678          * standalone.  */
679         uint16_t total_parts;
680
681         /** One of the ::wimlib_compression_type values that specifies the
682          * method used to compress resources in the WIM.  */
683         int32_t  compression_type;
684
685         /** Size of the WIM file in bytes, excluding the XML data and integrity
686          * table.  */
687         uint64_t total_bytes;
688
689         /** 1 if the WIM has an integrity table  */
690         uint32_t has_integrity_table : 1;
691
692         /** 1 if the WIM was created via wimlib_open_wim() rather than
693          * wimlib_create_new_wim(). */
694         uint32_t opened_from_file : 1;
695
696         /** 1 if the WIM is considered readonly for any reason. */
697         uint32_t is_readonly : 1;
698
699         /** 1 if reparse-point fixups are supposedly enabled for one or more
700          * images in the WIM.  */
701         uint32_t has_rpfix : 1;
702
703         /** 1 if the WIM is marked as read-only.  */
704         uint32_t is_marked_readonly : 1;
705
706         /** 1 if the WIM is part of a spanned set.  */
707         uint32_t spanned : 1;
708
709         uint32_t write_in_progress : 1;
710         uint32_t metadata_only : 1;
711         uint32_t resource_only : 1;
712         uint32_t reserved_flags : 24;
713         uint32_t reserved[9];
714 };
715
716
717 /*****************************
718  * WIMLIB_ADD_FLAG_*
719  *****************************/
720
721 /** Directly capture a NTFS volume rather than a generic directory.  This flag
722  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
723  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
724 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
725
726 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
727  * with ::WIMLIB_ADD_FLAG_NTFS. */
728 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
729
730 /** Call the progress function with the message
731  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
732  * be scanned. */
733 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
734
735 /** Mark the image being added as the bootable image of the WIM. */
736 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
737
738 /** Store the UNIX owner, group, and mode.  This is done by adding a special
739  * alternate data stream to each regular file, symbolic link, and directory to
740  * contain this information.  Please note that this flag is for convenience
741  * only; Microsoft's @a imagex.exe will not understand this special information.
742  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
743 #define WIMLIB_ADD_FLAG_UNIX_DATA                       0x00000010
744
745 /** Do not capture security descriptors.  Only has an effect in NTFS capture
746  * mode, or in Win32 native builds. */
747 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
748
749 /** Fail immediately if the full security descriptor of any file or directory
750  * cannot be accessed.  Only has an effect in Win32 native builds.  The default
751  * behavior without this flag is to first try omitting the SACL from the
752  * security descriptor, then to try omitting the security descriptor entirely.
753  * */
754 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
755
756 /** Call the progress function with the message
757  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
758  * capture.  This is a subset of the messages provided by
759  * ::WIMLIB_ADD_FLAG_VERBOSE. */
760 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
761
762 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
763  * in the case of Windows) that point inside the directory being captured to
764  * instead be absolute relative to the directory being captured, rather than the
765  * current root; also exclude absolute symbolic links that point outside the
766  * directory tree being captured.
767  *
768  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
769  * the WIM header or if this is the first image being added.
770  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
771  * reparse point fixups enabled and currently cannot be unset. */
772 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
773
774 /** Don't do reparse point fixups.  The default behavior is described in the
775  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
776 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
777
778 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
779 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
780 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
781 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
782 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
783 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
784 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
785 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
786 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
787 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
788
789 /******************************
790  * WIMLIB_DELETE_FLAG_*
791  ******************************/
792
793 /** Do not issue an error if the path to delete does not exist. */
794 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
795
796 /** Delete the file or directory tree recursively; if not specified, an error is
797  * issued if the path to delete is a directory. */
798 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
799
800 /******************************
801  * WIMLIB_EXPORT_FLAG_*
802  ******************************/
803
804 /** See documentation for wimlib_export_image(). */
805 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
806
807 /******************************
808  * WIMLIB_EXTRACT_FLAG_*
809  ******************************/
810
811 /** Extract the image directly to a NTFS volume rather than a generic directory.
812  * */
813 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
814
815 /** When identical files are extracted from the WIM, always hard link them
816  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
817 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
818
819 /** When identical files are extracted from the WIM, always symlink them
820  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
821 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
822
823 /** Call the progress function with the argument
824  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
825  * extracted.  Note: these calls will be interspersed with calls for the message
826  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
827 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
828
829 /** Read the WIM file sequentially while extracting the image. */
830 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
831
832 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
833  * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
834 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
835
836 /** Do not extract security descriptors.  Only has an effect in NTFS apply mode,
837  * or in Win32 native builds. */
838 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
839
840 /** Fail immediately if the full security descriptor of any file or directory
841  * cannot be set exactly as specified in the WIM file.  The default behavior
842  * without this flag is to fall back to setting the security descriptor with the
843  * SACL omitted, then only the default inherited security descriptor, if we do
844  * not have permission to set the desired one. */
845 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
846
847 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
848  * fixups on, so absolute symbolic links or junction points will be fixed to be
849  * absolute relative to the actual extraction root.  Done by default if
850  * WIM_HDR_FLAG_RP_FIX is set in the WIM header.  This flag may only be
851  * specified when extracting a full image. */
852 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
853
854 /** Force reparse-point fixups on extraction off, regardless of the state of the
855  * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
856 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
857
858 /** Extract files to standard output rather than to the filesystem. */
859 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
860
861 /** Instead of ignoring files and directories with names that cannot be
862  * represented on the current platform (note: Windows has more restrictions on
863  * filenames than UNIX), try to replace characters or append junk to the names
864  * so that they can be extracted in some form. */
865 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
866
867 /** On Windows, when there exist two or more files with the same case
868  * insensitive name but different case sensitive names, try to extract them all
869  * by appending junk to the end of them, rather than arbitrarily extracting only
870  * one. */
871 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
872
873 /******************************
874  * WIMLIB_MOUNT_FLAG_*
875  ******************************/
876
877 /** Mount the WIM image read-write rather than the default of read-only. */
878 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
879
880 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
881 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
882
883 /** Do not allow accessing alternate data streams in the mounted WIM image. */
884 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
885
886 /** Access alternate data streams in the mounted WIM image through extended file
887  * attributes.  This is the default mode. */
888 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
889
890 /** Access alternate data streams in the mounted WIM image by specifying the
891  * file name, a colon, then the alternate file stream name. */
892 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
893
894 /** Use UNIX file owners, groups, and modes if available in the WIM (see
895  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
896 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
897
898 /** Allow other users to see the mounted filesystem.  (this passes the @c
899  * allow_other option to FUSE mount) */
900 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
901
902 /******************************
903  * WIMLIB_OPEN_FLAG_*
904  ******************************/
905
906 /** Verify the WIM contents against the WIM's integrity table, if present.  This
907  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
908  * checksummed and checked against the SHA1 message digests specified in the
909  * integrity table.  WIMLIB_ERR_INTEGRITY is returned if there are any
910  * mismatches.  */
911 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
912
913 /** Do not issue an error if the WIM is part of a split WIM.  */
914 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
915
916 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
917  * is not.  A WIM is considered writable only if it is writable at the
918  * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
919  * header, and is not part of a spanned set.  It is not required to provide this
920  * flag to make changes to the WIM, but with this flag you get the error sooner
921  * rather than later. */
922 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
923
924 /******************************
925  * WIMLIB_UNMOUNT_FLAG_*
926  ******************************/
927
928 /** Include an integrity table in the WIM after it's been unmounted.  Ignored
929  * for read-only mounts. */
930 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
931
932 /** Unless this flag is given, changes to a read-write mounted WIM are
933  * discarded.  Ignored for read-only mounts. */
934 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
935
936 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
937 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
938
939 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
940 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
941
942 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
943 #define WIMLIB_UNMOUNT_FLAG_LAZY                        0x00000010
944
945 /******************************
946  * WIMLIB_UPDATE_FLAG_*
947  ******************************/
948
949 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
950  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
951 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
952
953 /******************************
954  * WIMLIB_WRITE_FLAG_*
955  ******************************/
956
957 /** Include an integrity table in the new WIM file. */
958 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
959
960 /** Re-build the entire WIM file rather than appending data to it, if possible.
961  * (Applies to wimlib_overwrite(), not wimlib_write()). */
962 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000002
963
964 /** Recompress all resources, even if they could otherwise be copied from a
965  * different WIM with the same compression type (in the case of
966  * wimlib_export_image() being called previously). */
967 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000004
968
969 /** Call fsync() when the WIM file is closed */
970 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000008
971
972 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
973  * after one or more calls to wimlib_delete_image(), which is to rebuild the
974  * entire WIM.
975  *
976  * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
977  * correctly remove the image from the WIM will be taken.  In particular, all
978  * streams will be left alone, even if they are no longer referenced.  This is
979  * probably not what you want, because almost no space will be spaced by
980  * deleting an image in this way. */
981 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000010
982
983 /** With wimlib_overwrite(), allow overwriting the WIM even if the readonly flag
984  * is set in the WIM header; this can be used in combination with
985  * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
986  * set the readonly flag on the on-disk WIM file. */
987 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000020
988
989 /******************************
990  * WIMLIB_INIT_FLAG_*
991  ******************************/
992
993 /** Assume that strings are represented in UTF-8, even if this is not the
994  * locale's character encoding. */
995 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
996
997 /** Specification of an update to perform on a WIM image. */
998 struct wimlib_update_command {
999
1000         /** The specific type of update to perform. */
1001         enum wimlib_update_op {
1002                 /** Add a new file or directory tree to the WIM image in a
1003                  * certain location. */
1004                 WIMLIB_UPDATE_OP_ADD = 0,
1005
1006                 /** Delete a file or directory tree from the WIM image. */
1007                 WIMLIB_UPDATE_OP_DELETE,
1008
1009                 /** Rename a file or directory tree in the WIM image. */
1010                 WIMLIB_UPDATE_OP_RENAME,
1011         } op;
1012         union {
1013                 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1014                 struct wimlib_add_command {
1015                         /** Filesystem path to the file or directory tree to
1016                          * add. */
1017                         wimlib_tchar *fs_source_path;
1018                         /** Path, specified from the root of the WIM image, at
1019                          * which to add the file or directory tree within the
1020                          * WIM image. */
1021                         wimlib_tchar *wim_target_path;
1022
1023                         /** Configuration for excluded files.  @c NULL means
1024                          * exclude no files. */
1025                         struct wimlib_capture_config *config;
1026
1027                         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1028                         int add_flags;
1029                 } add;
1030                 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1031                 struct wimlib_delete_command {
1032                         /** Path, specified from the root of the WIM image, for
1033                          * the file or directory tree within the WIM image to be
1034                          * deleted. */
1035                         wimlib_tchar *wim_path;
1036                         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1037                         int delete_flags;
1038                 } delete;
1039                 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1040                 struct wimlib_rename_command {
1041                         /** Path, specified from the root of the WIM image, for
1042                          * the source file or directory tree within the WIM
1043                          * image. */
1044                         wimlib_tchar *wim_source_path;
1045                         /** Path, specified from the root of the WIM image, for
1046                          * the destination file or directory tree within the WIM
1047                          * image. */
1048                         wimlib_tchar *wim_target_path;
1049                         /** Reserved; set to 0. */
1050                         int rename_flags;
1051                 } rename;
1052         };
1053 };
1054
1055 /** Specification of a file or directory tree to extract from a WIM image. */
1056 struct wimlib_extract_command {
1057         /** Path to file or directory tree within the WIM image to extract.  It
1058          * must be provided as an absolute path from the root of the WIM image.
1059          * The path separators may be either forward slashes or backslashes. */
1060         wimlib_tchar *wim_source_path;
1061
1062         /** Filesystem path to extract the file or directory tree to. */
1063         wimlib_tchar *fs_dest_path;
1064
1065         /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1066         int extract_flags;
1067 };
1068
1069 /**
1070  * Possible values of the error code returned by many functions in wimlib.
1071  *
1072  * See the documentation for each wimlib function to see specifically what error
1073  * codes can be returned by a given function, and what they mean.
1074  */
1075 enum wimlib_error_code {
1076         WIMLIB_ERR_SUCCESS = 0,
1077         WIMLIB_ERR_ALREADY_LOCKED,
1078         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
1079         WIMLIB_ERR_DECOMPRESSION,
1080         WIMLIB_ERR_DELETE_STAGING_DIR,
1081         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1082         WIMLIB_ERR_FORK,
1083         WIMLIB_ERR_FUSE,
1084         WIMLIB_ERR_FUSERMOUNT,
1085         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1086         WIMLIB_ERR_IMAGE_COUNT,
1087         WIMLIB_ERR_IMAGE_NAME_COLLISION,
1088         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
1089         WIMLIB_ERR_INTEGRITY,
1090         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1091         WIMLIB_ERR_INVALID_CHUNK_SIZE,
1092         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1093         WIMLIB_ERR_INVALID_DENTRY,
1094         WIMLIB_ERR_INVALID_HEADER_SIZE,
1095         WIMLIB_ERR_INVALID_IMAGE,
1096         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1097         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1098         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1099         WIMLIB_ERR_INVALID_OVERLAY,
1100         WIMLIB_ERR_INVALID_PARAM,
1101         WIMLIB_ERR_INVALID_PART_NUMBER,
1102         WIMLIB_ERR_INVALID_REPARSE_DATA,
1103         WIMLIB_ERR_INVALID_RESOURCE_HASH,
1104         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
1105         WIMLIB_ERR_INVALID_SECURITY_DATA,
1106         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1107         WIMLIB_ERR_INVALID_UTF16_STRING,
1108         WIMLIB_ERR_INVALID_UTF8_STRING,
1109         WIMLIB_ERR_IS_DIRECTORY,
1110         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1111         WIMLIB_ERR_LINK,
1112         WIMLIB_ERR_MKDIR,
1113         WIMLIB_ERR_MQUEUE,
1114         WIMLIB_ERR_NOMEM,
1115         WIMLIB_ERR_NOTDIR,
1116         WIMLIB_ERR_NOTEMPTY,
1117         WIMLIB_ERR_NOT_A_REGULAR_FILE,
1118         WIMLIB_ERR_NOT_A_WIM_FILE,
1119         WIMLIB_ERR_NO_FILENAME,
1120         WIMLIB_ERR_NTFS_3G,
1121         WIMLIB_ERR_OPEN,
1122         WIMLIB_ERR_OPENDIR,
1123         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1124         WIMLIB_ERR_READ,
1125         WIMLIB_ERR_READLINK,
1126         WIMLIB_ERR_RENAME,
1127         WIMLIB_ERR_REOPEN,
1128         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1129         WIMLIB_ERR_RESOURCE_ORDER,
1130         WIMLIB_ERR_SPECIAL_FILE,
1131         WIMLIB_ERR_SPLIT_INVALID,
1132         WIMLIB_ERR_SPLIT_UNSUPPORTED,
1133         WIMLIB_ERR_STAT,
1134         WIMLIB_ERR_TIMEOUT,
1135         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1136         WIMLIB_ERR_UNKNOWN_VERSION,
1137         WIMLIB_ERR_UNSUPPORTED,
1138         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1139         WIMLIB_ERR_WRITE,
1140         WIMLIB_ERR_XML,
1141         WIMLIB_ERR_WIM_IS_READONLY,
1142         WIMLIB_ERR_RESOURCE_NOT_FOUND,
1143 };
1144
1145
1146 /** Used to indicate no WIM image or an invalid WIM image. */
1147 #define WIMLIB_NO_IMAGE         0
1148
1149 /** Used to specify all images in the WIM. */
1150 #define WIMLIB_ALL_IMAGES       (-1)
1151
1152 /**
1153  * Appends an empty image to a WIM file.  This empty image will initially
1154  * contain no files or directories, although if written without further
1155  * modifications, a root directory will be created automatically for it.
1156  *
1157  * @param wim
1158  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
1159  *      added.
1160  * @param name
1161  *      Name to give the new image.  If @c NULL or empty, the new image is given
1162  *      no name.  If nonempty, it must specify a name that does not already
1163  *      exist in @a wim.
1164  * @param new_idx_ret
1165  *      If non-<code>NULL</code>, the index of the newly added image is returned
1166  *      in this location.
1167  *
1168  * @return 0 on success; nonzero on failure.  The possible error codes are:
1169  *
1170  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1171  *      There is already an image in @a wim named @a name.
1172  * @retval ::WIMLIB_ERR_NOMEM
1173  *      Failed to allocate the memory needed to add the new image.
1174  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1175  *      The WIM file is considered read-only because of any of the reasons
1176  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1177  *      flag.
1178  */
1179 extern int
1180 wimlib_add_empty_image(WIMStruct *wim,
1181                        const wimlib_tchar *name,
1182                        int *new_idx_ret);
1183
1184 /**
1185  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1186  *
1187  * The directory tree or NTFS volume is scanned immediately to load the dentry
1188  * tree into memory, and file attributes and symbolic links are read.  However,
1189  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1190  * called.
1191  *
1192  * See the manual page for the @b wimlib-imagex program for more information
1193  * about the "normal" capture mode versus the NTFS capture mode (entered by
1194  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1195  *
1196  * Note that @b no changes are committed to the underlying WIM file (if
1197  * any) until wimlib_write() or wimlib_overwrite() is called.
1198  *
1199  * @param wim
1200  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
1201  *      added.
1202  * @param source
1203  *      A path to a directory or unmounted NTFS volume that will be captured as
1204  *      a WIM image.
1205  * @param name
1206  *      Name to give the new image.  If @c NULL or empty, the new image is given
1207  *      no name.  If nonempty, it must specify a name that does not already
1208  *      exist in @a wim.
1209  * @param config
1210  *      Capture configuration that specifies files, directories, or path globs
1211  *      to exclude from being captured.  If @c NULL, a dummy configuration where
1212  *      no paths are treated specially is used.
1213  * @param add_flags
1214  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1215  * @param progress_func
1216  *      If non-NULL, a function that will be called periodically with the
1217  *      progress of the current operation.
1218  *
1219  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
1220  * discarded so that it appears to be in the same state as when this function
1221  * was called.
1222  *
1223  * This function is implemented by calling wimlib_add_empty_image(), then
1224  * calling wimlib_update_image() with a single "add" command, so any error code
1225  * returned by wimlib_add_empty_image() may be returned, as well as any error
1226  * codes returned by wimlib_update_image() other than ones documented as only
1227  * being returned specifically by an update involving delete or rename commands.
1228  */
1229 extern int
1230 wimlib_add_image(WIMStruct *wim,
1231                  const wimlib_tchar *source,
1232                  const wimlib_tchar *name,
1233                  const struct wimlib_capture_config *config,
1234                  int add_flags,
1235                  wimlib_progress_func_t progress_func);
1236
1237 /** This function is equivalent to wimlib_add_image() except it allows for
1238  * multiple sources to be combined into a single WIM image.  This is done by
1239  * specifying the @a sources and @a num_sources parameters instead of the @a
1240  * source parameter of wimlib_add_image().  The rest of the parameters are the
1241  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
1242  * capture</b> for full details on how this mode works.
1243  *
1244  * In addition to the error codes that wimlib_add_image() can return,
1245  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1246  * when trying to overlay a non-directory on a directory or when otherwise
1247  * trying to overlay multiple conflicting files to the same location in the WIM
1248  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
1249  * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1250  * was not exactly one capture source with the target being the root directory.
1251  * (In this respect, there is no advantage to using
1252  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1253  * NTFS mode.) */
1254 extern int
1255 wimlib_add_image_multisource(WIMStruct *wim,
1256                              const struct wimlib_capture_source *sources,
1257                              size_t num_sources,
1258                              const wimlib_tchar *name,
1259                              const struct wimlib_capture_config *config,
1260                              int add_flags,
1261                              wimlib_progress_func_t progress_func);
1262
1263 /**
1264  * Creates a ::WIMStruct for a new WIM file.
1265  *
1266  * This only creates an in-memory structure for a WIM that initially contains no
1267  * images.  No on-disk file is created until wimlib_write() is called.
1268  *
1269  * @param ctype
1270  *      The type of compression to be used in the new WIM file.  Must be
1271  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1272  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1273  * @param wim_ret
1274  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1275  *      written to the memory location pointed to by this paramater.  The
1276  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1277  *      it.
1278  * @return 0 on success; nonzero on error.
1279  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1280  *      @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1281  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1282  * @retval ::WIMLIB_ERR_NOMEM
1283  *      Failed to allocate needed memory.
1284  */
1285 extern int
1286 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1287
1288 /**
1289  * Deletes an image, or all images, from a WIM file.
1290  *
1291  * All streams referenced by the image(s) being deleted are removed from the
1292  * lookup table of the WIM if they are not referenced by any other images in the
1293  * WIM.
1294  *
1295  * Please note that @b no changes are committed to the underlying WIM file (if
1296  * any) until wimlib_write() or wimlib_overwrite() is called.
1297  *
1298  * @param wim
1299  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1300  *      being deleted.
1301  * @param image
1302  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1303  *      images.
1304  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
1305  * to be left unmodified only if @a image specified a single image.  If instead
1306  * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1307  * possible for some but not all of the images to have been deleted when a
1308  * failure status is returned.
1309  *
1310  * @retval ::WIMLIB_ERR_DECOMPRESSION
1311  *      Could not decompress the metadata resource for @a image.
1312  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1313  *      A directory entry in the metadata resource for @a image in the WIM is
1314  *      invalid.
1315  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1316  *      @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1317  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1318  *      The metadata resource for @a image in the WIM is invalid.
1319  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1320  *      The security data for @a image in the WIM is invalid.
1321  * @retval ::WIMLIB_ERR_NOMEM
1322  *      Failed to allocate needed memory.
1323  * @retval ::WIMLIB_ERR_READ
1324  *      Could not read the metadata resource for @a image from the WIM.
1325  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1326  *      The WIM file is considered read-only because of any of the reasons
1327  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1328  *      flag.
1329  */
1330 extern int
1331 wimlib_delete_image(WIMStruct *wim, int image);
1332
1333 /**
1334  * Exports an image, or all the images, from a WIM file, into another WIM file.
1335  *
1336  * The destination image is made to share the same dentry tree and security data
1337  * structure as the source image.  This places some restrictions on additional
1338  * functions that may be called.  wimlib_mount_image() may not be called on
1339  * either the source image or the destination image without an intervening call
1340  * to a function that un-shares the images, such as wimlib_free() on @a
1341  * dest_wim, or wimlib_delete_image() on either the source or destination image.
1342  * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1343  * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1344  * have references back to @a src_wim.
1345  *
1346  * If this function fails, all changes to @a dest_wim are rolled back.
1347  *
1348  * No changes shall be made to @a src_wim by this function.
1349  *
1350  * Please note that no changes are committed to the underlying WIM file of @a
1351  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1352  *
1353  * @param src_wim
1354  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1355  *      WIM that contains the image(s) being exported.
1356  * @param src_image
1357  *      The image to export from @a src_wim.  Can be the number of an image, or
1358  *      ::WIMLIB_ALL_IMAGES to export all images.
1359  * @param dest_wim
1360  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
1361  *      being exported.
1362  * @param dest_name
1363  *      The name to give the exported image in the new WIM file.  If left @c
1364  *      NULL, the name from @a src_wim is used.  This parameter must be left @c
1365  *      NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1366  *      than one image; in that case, the names are all taken from the @a
1367  *      src_wim.  (This is allowed even if one or more images being exported has
1368  *      no name.)
1369  * @param dest_description
1370  *      The description to give the exported image in the new WIM file.  If left
1371  *      @c NULL, the description from the @a src_wim is used.  This parameter must
1372  *      be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1373  *      more than one image; in that case, the descriptions are all taken from
1374  *      @a src_wim.  (This is allowed even if one or more images being exported
1375  *      has no description.)
1376  * @param export_flags
1377  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1378  *      bootable, or 0 if which image is marked as bootable in the destination
1379  *      WIM is to be left unchanged.  If @a src_image is ::WIMLIB_ALL_IMAGES and
1380  *      there are multiple images in @a src_wim, specifying
1381  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1382  *      currently marked as bootable in @a src_wim; if that is the case, then
1383  *      that image is marked as bootable in the destination WIM.
1384  * @param additional_swms
1385  *      Array of pointers to the ::WIMStruct for each additional part in the
1386  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1387  *      need to be in any particular order, but they must include all parts of
1388  *      the split WIM other than the first part, which must be provided in the
1389  *      @a wim parameter.
1390  * @param num_additional_swms
1391  *      Number of additional WIM parts provided in the @a additional_swms array.
1392  *      This number should be one less than the total number of parts in the
1393  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1394  * @param progress_func
1395  *      If non-NULL, a function that will be called periodically with the
1396  *      progress of the current operation.
1397  *
1398  * @return 0 on success; nonzero on error.
1399  * @retval ::WIMLIB_ERR_DECOMPRESSION
1400  *      Could not decompress the metadata resource for @a src_image
1401  *      in @a src_wim
1402  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1403  *      One or more of the names being given to an exported image was already in
1404  *      use in the destination WIM.
1405  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1406  *      A directory entry in the metadata resource for @a src_image in @a
1407  *      src_wim is invalid.
1408  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1409  *      @a src_image does not exist in @a src_wim.
1410  * @retval ::WIMLIB_ERR_INVALID_PARAM
1411  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1412  *      ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1413  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
1414  *      dest_description were non-<code>NULL</code>, @a src_image was
1415  *      ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1416  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1417  *      The metadata resource for @a src_image in @a src_wim is invalid.
1418  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1419  *      The security data for @a src_image in @a src_wim is invalid.
1420  * @retval ::WIMLIB_ERR_NOMEM
1421  *      Failed to allocate needed memory.
1422  * @retval ::WIMLIB_ERR_READ
1423  *      Could not read the metadata resource for @a src_image from @a src_wim.
1424  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1425  *      The source WIM is a split WIM, but the parts specified do not form a
1426  *      complete split WIM because they do not include all the parts of the
1427  *      original WIM, there are duplicate parts, or not all the parts have the
1428  *      same GUID and compression type.
1429  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1430  *      @a dest_wim is considered read-only because of any of the reasons
1431  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1432  *      flag.
1433  */
1434 extern int
1435 wimlib_export_image(WIMStruct *src_wim, int src_image,
1436                     WIMStruct *dest_wim,
1437                     const wimlib_tchar *dest_name,
1438                     const wimlib_tchar *dest_description,
1439                     int export_flags,
1440                     WIMStruct **additional_swms,
1441                     unsigned num_additional_swms,
1442                     wimlib_progress_func_t progress_func);
1443
1444 /**
1445  * Extract zero or more files or directory trees from a WIM image.
1446  *
1447  * This generalizes the single-image extraction functionality of
1448  * wimlib_extract_image() to allow extracting only the specified subsets of the
1449  * image.
1450  *
1451  * @param wim
1452  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1453  *      split WIM.
1454  *
1455  * @param image
1456  *      The 1-based number of the image in @a wim from which the files or
1457  *      directory trees are to be extracted.  It cannot be ::WIMLIB_ALL_IMAGES.
1458  *
1459  * @param cmds
1460  *      An array of ::wimlib_extract_command structures that specifies the
1461  *      extractions to perform.
1462  *
1463  * @param num_cmds
1464  *      Number of commands in the @a cmds array.
1465  *
1466  * @param default_extract_flags
1467  *      Default extraction flags; the behavior shall be as if these flags had
1468  *      been specified in the ::wimlib_extract_command.extract_flags member in
1469  *      each extraction command, in combination with any flags already present.
1470  *
1471  * @param additional_swms
1472  *      Array of pointers to the ::WIMStruct for each additional part in the
1473  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1474  *      need to be in any particular order, but they must include all parts of
1475  *      the split WIM other than the first part, which must be provided in the
1476  *      @a wim parameter.
1477  *
1478  * @param num_additional_swms
1479  *      Number of additional WIM parts provided in the @a additional_swms array.
1480  *      This number should be one less than the total number of parts in the
1481  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1482  *
1483  * @param progress_func
1484  *      If non-NULL, a function that will be called periodically with the
1485  *      progress of the current operation.
1486  *
1487  * @return 0 on success; nonzero on error.  The possible error codes include
1488  * those documented as returned by wimlib_extract_image() as well as the
1489  * following additional error codes:
1490  *
1491  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1492  *      The ::wimlib_extract_command.wim_source_path member in one of the
1493  *      extract commands did not exist in the WIM.
1494  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1495  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1496  *      in which ::wimlib_extract_command.wim_source_path existed but was not a
1497  *      regular file or directory.
1498  * @retval ::WIMLIB_ERR_INVALID_PARAM
1499  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1500  *      specified for some commands but not all; or
1501  *      ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1502  *      for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1503  *      for a command in which ::wimlib_extract_command.wim_source_path did not
1504  *      specify the root directory of the WIM image.
1505  */
1506 extern int
1507 wimlib_extract_files(WIMStruct *wim,
1508                      int image,
1509                      const struct wimlib_extract_command *cmds,
1510                      size_t num_cmds,
1511                      int default_extract_flags,
1512                      WIMStruct **additional_swms,
1513                      unsigned num_additional_swms,
1514                      wimlib_progress_func_t progress_func);
1515
1516 /**
1517  * Extracts an image, or all images, from a standalone or split WIM file to a
1518  * directory or a NTFS volume.
1519  *
1520  * Please see the manual page for the @c wimlib-imagex program for more
1521  * information about the "normal" extraction mode versus the NTFS extraction
1522  * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1523  *
1524  * Extraction is done with one thread.
1525  *
1526  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1527  * returned if any resulting SHA1 message digests do not match the values
1528  * provided in the WIM file.  Therefore, if this function is successful, you can
1529  * be fairly sure that any compressed data in the WIM was uncompressed
1530  * correctly.
1531  *
1532  * @param wim
1533  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1534  *      split WIM.
1535  * @param image
1536  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1537  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1538  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1539  * @param target
1540  *      Directory to extract the WIM image(s) to (created if it does not already
1541  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1542  *      path to the unmounted NTFS volume to extract the image to.
1543  * @param extract_flags
1544  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1545  *      <br/> <br/>
1546  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1547  *      a NTFS volume to extract the image to.  The volume will be opened using
1548  *      NTFS-3g and the image will be extracted to the root of the NTFS volume.
1549  *      Otherwise, @a target is interpreted as a directory to extract the
1550  *      image(s) to.
1551  *      <br/> <br/>
1552  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1553  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1554  *      specified.  These flags cause extracted files that are identical to be
1555  *      hardlinked or symlinked together, depending on the flag.  These flags
1556  *      override the hard link groups that are specified in the WIM file itself.
1557  *      If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1558  *      hardlinked or symlinked across images if a file is found to occur in
1559  *      more than one image.
1560  *      <br/> <br/>
1561  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1562  *      name of each file or directory as it is extracted.
1563  *      <br/> <br/>
1564  *      If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1565  *      WIM sequentially, if possible.  If ::WIMLIB_ALL_IMAGES is specified,
1566  *      each image is considered separately with regards to the sequential
1567  *      order.  It is also possible for alternate data streams to break the
1568  *      sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1569  *      specified).
1570  * @param additional_swms
1571  *      Array of pointers to the ::WIMStruct for each additional part in the
1572  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1573  *      need to be in any particular order, but they must include all parts of
1574  *      the split WIM other than the first part, which must be provided in the
1575  *      @a wim parameter.
1576  * @param num_additional_swms
1577  *      Number of additional WIM parts provided in the @a additional_swms array.
1578  *      This number should be one less than the total number of parts in the
1579  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1580  *
1581  * @param progress_func
1582  *      If non-NULL, a function that will be called periodically with the
1583  *      progress of the current operation.
1584  *
1585  * @return 0 on success; nonzero on error.
1586  * @retval ::WIMLIB_ERR_DECOMPRESSION
1587  *      Could not decompress a resource (file or metadata) for @a image in @a
1588  *      wim.
1589  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1590  *      A directory entry in the metadata resource for @a image in @a wim is
1591  *      invalid.
1592  * @retval ::WIMLIB_ERR_INVALID_PARAM
1593  *      @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1594  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1595  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1596  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1597  *      specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1598  *      specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1599  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1600  *      specified in @a extract_flag.
1601  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1602  *      The SHA1 message digest of an extracted stream did not match the SHA1
1603  *      message digest given in the WIM file.
1604  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1605  *      A resource (file or metadata) for @a image in @a wim is invalid.
1606  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1607  *      The security data for @a image in @a wim is invalid.
1608  * @retval ::WIMLIB_ERR_LINK
1609 *       Failed to create a symbolic link or a hard link (only if
1610  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1611  * @retval ::WIMLIB_ERR_MKDIR
1612  *      Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1613  *      not specified in @a extract_flags).
1614  * @retval ::WIMLIB_ERR_NOMEM
1615  *      Failed to allocate needed memory.
1616  * @retval ::WIMLIB_ERR_NTFS_3G
1617  *      An error was returned from a libntfs-3g function while the WIM image was
1618  *      being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1619  *      was specified in @a extract_flags).
1620  * @retval ::WIMLIB_ERR_OPEN
1621  *      Could not open one of the files being extracted for writing (only if
1622  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1623  * @retval ::WIMLIB_ERR_READ
1624  *      A unexpected end-of-file or read error occurred when trying to read data
1625  *      from the WIM file associated with @a wim.
1626  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1627  *      One of the dentries in the image referenced a stream not present in the
1628  *      WIM's lookup table (or in any of the lookup tables of the split WIM
1629  *      parts).
1630  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1631  *      The WIM is a split WIM, but the parts specified do not form a complete
1632  *      split WIM because they do not include all the parts of the original WIM,
1633  *      there are duplicate parts, or not all the parts have the same GUID and
1634  *      compression type.
1635  * @retval ::WIMLIB_ERR_UNSUPPORTED
1636  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1637  *      was configured with the @c --without-ntfs-3g flag.
1638  * @retval ::WIMLIB_ERR_WRITE
1639  *      Failed to write a file being extracted (only if
1640  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1641  */
1642 extern int
1643 wimlib_extract_image(WIMStruct *wim, int image,
1644                      const wimlib_tchar *target,
1645                      int extract_flags,
1646                      WIMStruct **additional_swms,
1647                      unsigned num_additional_swms,
1648                      wimlib_progress_func_t progress_func);
1649
1650 /**
1651  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1652  * includes a string of XML that describes the images contained in the WIM.
1653  * This function works on standalone WIMs as well as split WIM parts.
1654  *
1655  * @param wim
1656  *      Pointer to the ::WIMStruct for a WIM file.
1657  * @param fp
1658  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1659  *
1660  * @return 0 on success; nonzero on error.
1661  * @retval ::WIMLIB_ERR_INVALID_PARAM
1662  *      @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1663  * @retval ::WIMLIB_ERR_NOMEM
1664  *      Failed to allocate needed memory.
1665  * @retval ::WIMLIB_ERR_READ
1666  *      Failed to read the XML data from the WIM.
1667  * @retval ::WIMLIB_ERR_WRITE
1668  *      Failed to completely write the XML data to @a fp.
1669  */
1670 extern int
1671 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1672
1673 /**
1674  * Frees all memory allocated for a WIMStruct and closes all files associated
1675  * with it.
1676  *
1677  * @param wim
1678  *      Pointer to the ::WIMStruct for a WIM file.
1679  *
1680  * @return This function has no return value.
1681  */
1682 extern void
1683 wimlib_free(WIMStruct *wim);
1684
1685 /**
1686  * Deprecated in favor of wimlib_get_wim_info().
1687  */
1688 extern int
1689 wimlib_get_boot_idx(const WIMStruct *wim) _wimlib_deprecated;
1690
1691 /**
1692  * Deprecated in favor of wimlib_get_wim_info().
1693  */
1694 extern int
1695 wimlib_get_compression_type(const WIMStruct *wim) _wimlib_deprecated;
1696
1697 /**
1698  * Converts a ::wimlib_compression_type value into a string.
1699  *
1700  * @param ctype
1701  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1702  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1703  *
1704  * @return
1705  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1706  *      respectively.
1707  */
1708 extern const wimlib_tchar *
1709 wimlib_get_compression_type_string(int ctype);
1710
1711 /**
1712  * Converts an error code into a string describing it.
1713  *
1714  * @param code
1715  *      The error code returned by one of wimlib's functions.
1716  *
1717  * @return
1718  *      Pointer to a statically allocated string describing the error code,
1719  *      or @c NULL if the error code is not valid.
1720  */
1721 extern const wimlib_tchar *
1722 wimlib_get_error_string(enum wimlib_error_code code);
1723
1724 /**
1725  * Returns the description of the specified image.
1726  *
1727  * @param wim
1728  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1729  *      standalone WIM or a split WIM part.
1730  * @param image
1731  *      The number of the image, numbered starting at 1.
1732  *
1733  * @return
1734  *      The description of the image, or @c NULL if there is no such image, or
1735  *      @c NULL if the specified image has no description.  The description
1736  *      string is in library-internal memory and may not be modified or freed;
1737  *      in addition, the string will become invalid if the description of the
1738  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1739  */
1740 extern const wimlib_tchar *
1741 wimlib_get_image_description(const WIMStruct *wim, int image);
1742
1743 /**
1744  * Returns the name of the specified image.
1745  *
1746  * @param wim
1747  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1748  *      standalone WIM or a split WIM part.
1749  * @param image
1750  *      The number of the image, numbered starting at 1.
1751  *
1752  * @return
1753  *      The name of the image, or @c NULL if there is no such image.  The name
1754  *      string is in library-internal memory and may not be modified or freed;
1755  *      in addition, the string will become invalid if the name of the image is
1756  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
1757  *
1758  *      If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1759  *      the WIM to be unnamed, in which case an empty string will be returned
1760  *      when the corresponding name is requested.
1761  */
1762 extern const wimlib_tchar *
1763 wimlib_get_image_name(const WIMStruct *wim, int image);
1764
1765
1766 /**
1767  * Deprecated in favor of wimlib_get_wim_info().
1768  */
1769 extern int
1770 wimlib_get_num_images(const WIMStruct *wim) _wimlib_deprecated;
1771
1772 /**
1773  * Deprecated in favor of wimlib_get_wim_info().
1774  */
1775 extern int
1776 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret) _wimlib_deprecated;
1777
1778 /**
1779  * Get basic information about a WIM file.
1780  *
1781  * @param wim
1782  *      Pointer to the ::WIMStruct for a WIM file.  It may be for either a
1783  *      standalone WIM or part of a split WIM.
1784  * @param info
1785  *      A ::wimlib_wim_info structure that will be filled in with information
1786  *      about the WIM file.
1787  * @return
1788  *      0
1789  */
1790 extern int
1791 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
1792
1793 /**
1794  * Initialization function for wimlib.  Call before using any other wimlib
1795  * function.
1796  *
1797  * @param init_flags
1798  *      On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1799  *      that all input data, including filenames, are in UTF-8 rather than the
1800  *      locale-dependent character encoding which may or may not be UTF-8, and
1801  *      that UTF-8 data can be directly printed to the console.  On Windows, use
1802  *      0 for this parameter.
1803  *
1804  * @return 0; other error codes may be returned in future releases.
1805  */
1806 extern int
1807 wimlib_global_init(int init_flags);
1808
1809 /**
1810  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
1811  * You are not required to call this function, but it will release any global
1812  * memory allocated by the library.
1813  */
1814 extern void
1815 wimlib_global_cleanup(void);
1816
1817 /**
1818  * Returns true if the WIM has an integrity table.
1819  *
1820  * @param wim
1821  *      Pointer to the ::WIMStruct for a WIM file.
1822  * @return
1823  *      @c true if the WIM has an integrity table; @c false otherwise.  If @a
1824  *      wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1825  *      wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1826  *      been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1827  */
1828 extern bool
1829 wimlib_has_integrity_table(const WIMStruct *wim);
1830
1831 /**
1832  * Determines if an image name is already used by some image in the WIM.
1833  *
1834  * @param wim
1835  *      Pointer to the ::WIMStruct for a WIM file.
1836  * @param name
1837  *      The name to check.
1838  *
1839  * @return
1840  *      @c true if there is already an image in @a wim named @a name; @c false
1841  *      if there is no image named @a name in @a wim.  If @a name is @c NULL or
1842  *      the empty string, @c false is returned.
1843  */
1844 extern bool
1845 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1846
1847 /**
1848  * Joins a split WIM into a stand-alone one-part WIM.
1849  *
1850  * @param swms
1851  *      An array of strings that gives the filenames of all parts of the split
1852  *      WIM.  No specific order is required, but all parts must be included with
1853  *      no duplicates.
1854  * @param num_swms
1855  *      Number of filenames in @a swms.
1856  * @param swm_open_flags
1857  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1858  *      part should be verified, if integrity tables are present.  Otherwise,
1859  *      set to 0.
1860  * @param wim_write_flags
1861  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1862  * @param output_path
1863  *      The path to write the one-part WIM to.
1864  * @param progress_func
1865  *      If non-NULL, a function that will be called periodically with the
1866  *      progress of the current operation.
1867  *
1868  * @return 0 on success; nonzero on error.  This function may return any value
1869  * returned by wimlib_open_wim() and wimlib_write() except
1870  * ::WIMLIB_ERR_WIM_IS_READONLY, as well as the following error code:
1871  *
1872  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1873  *      The split WIMs do not form a valid WIM because they do not include all
1874  *      the parts of the original WIM, there are duplicate parts, or not all the
1875  *      parts have the same GUID and compression type.
1876  *
1877  * Note: the WIM's uncompressed and compressed resources are not checksummed
1878  * when they are copied from the split WIM parts to the joined WIM, nor are
1879  * compressed resources re-compressed.
1880  *
1881  * Note: wimlib_export_image() can provide similar functionality to
1882  * wimlib_join(), since it is possible to export all images from a split WIM.
1883  */
1884 extern int
1885 wimlib_join(const wimlib_tchar * const *swms,
1886             unsigned num_swms,
1887             const wimlib_tchar *output_path,
1888             int swm_open_flags,
1889             int wim_write_flags,
1890             wimlib_progress_func_t progress_func);
1891
1892 /**
1893  * Compress a chunk of a WIM resource using LZX compression.
1894  *
1895  * This function is exported for convenience only and need not be used.
1896  *
1897  * @param chunk
1898  *      Uncompressed data of the chunk.
1899  * @param chunk_size
1900  *      Size of the uncompressed chunk, in bytes.
1901  * @param out
1902  *      Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1903  *
1904  * @return
1905  *      The size of the compressed data written to @a out in bytes, or 0 if the
1906  *      data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1907  *
1908  * As a special requirement, the compression code is optimized for the WIM
1909  * format and therefore requires (@a chunk_size <= 32768).
1910  */
1911 extern unsigned
1912 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1913
1914 /**
1915  * Decompresses a block of LZX-compressed data as used in the WIM file format.
1916  *
1917  * Note that this will NOT work unmodified for LZX as used in the cabinet
1918  * format, which is not the same as in the WIM format!
1919  *
1920  * This function is exported for convenience only and need not be used.
1921  *
1922  * @param compressed_data
1923  *      Pointer to the compressed data.
1924  *
1925  * @param compressed_len
1926  *      Length of the compressed data, in bytes.
1927  *
1928  * @param uncompressed_data
1929  *      Pointer to the buffer into which to write the uncompressed data.
1930  *
1931  * @param uncompressed_len
1932  *      Length of the uncompressed data.  It must be 32768 bytes or less.
1933  *
1934  * @return
1935  *      0 on success; non-zero on failure.
1936  */
1937 extern int
1938 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1939                       void *uncompressed_data, unsigned uncompressed_len);
1940
1941
1942 /**
1943  * Mounts an image in a WIM file on a directory read-only or read-write.
1944  *
1945  * This is not supported on Windows.
1946  *
1947  * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1948  * process will be daemonized.
1949  *
1950  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1951  * modifications to the WIM are staged in a temporary directory.
1952  *
1953  * It is safe to mount multiple images from the same WIM file read-only at the
1954  * same time, but only if different ::WIMStruct's are used.  It is @b not safe
1955  * to mount multiple images from the same WIM file read-write at the same time.
1956  *
1957  * wimlib_mount_image() cannot be used on an image that was exported with
1958  * wimlib_export_image() while the dentry trees for both images are still in
1959  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
1960  * that has just been added with wimlib_add_image(), unless the WIM has been
1961  * written and read into a new ::WIMStruct.
1962  *
1963  * @param wim
1964  *      Pointer to the ::WIMStruct containing the image to be mounted.
1965  * @param image
1966  *      The number of the image to mount, indexed starting from it.  It must be
1967  *      an existing, single image.
1968  * @param dir
1969  *      The path to an existing empty directory to mount the image on.
1970  * @param mount_flags
1971  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1972  *      <br/><br/>
1973  *      If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1974  *      rather than the default of read-only.
1975  *      <br/> <br/>
1976  *      WIMs may contain named (alternate) data streams, which are a somewhat
1977  *      obscure NTFS feature.  They can be read and written on a mounted WIM
1978  *      through one of several interfaces.  The interface to use if specified by
1979  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1980  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1981  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
1982  *      the XATTR interface.
1983  * @param additional_swms
1984  *      Array of pointers to the ::WIMStruct for each additional part in the
1985  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1986  *      need to be in any particular order, but they must include all parts of
1987  *      the split WIM other than the first part, which must be provided in the
1988  *      @a wim parameter.
1989  * @param num_additional_swms
1990  *      Number of additional WIM parts provided in the @a additional_swms array.
1991  *      This number should be one less than the total number of parts in the
1992  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1993  * @param staging_dir
1994  *      If non-NULL, the name of a directory in which the staging directory will
1995  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1996  *      in @a mount_flags.  If left @c NULL, the staging directory is created in
1997  *      the same directory as the WIM file that @a wim was originally read from.
1998  *
1999  * @return 0 on success; nonzero on error.
2000  *
2001  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2002  *      A read-write mount was requested, but an an exclusive advisory lock on
2003  *      the on-disk WIM file could not be acquired because another thread or
2004  *      process has mounted an image from the WIM read-write or is currently
2005  *      modifying the WIM in-place.
2006  * @retval ::WIMLIB_ERR_DECOMPRESSION
2007  *      Could not decompress the metadata resource for @a image in @a wim.
2008  * @retval ::WIMLIB_ERR_FUSE
2009  *      A non-zero status was returned by @c fuse_main().
2010  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2011  *      A directory entry in the metadata resource for @a image in @a wim is
2012  *      invalid.
2013  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2014  *      @a image does not specify an existing, single image in @a wim.
2015  * @retval ::WIMLIB_ERR_INVALID_PARAM
2016  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
2017  *      wimlib_export_image(), or @a image has been added with
2018  *      wimlib_add_image().
2019  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2020  *      The metadata resource for @a image in @a wim is invalid.
2021  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2022  *      The security data for @a image in @a wim is invalid.
2023  * @retval ::WIMLIB_ERR_MKDIR
2024  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
2025  *      staging directory could not be created.
2026  * @retval ::WIMLIB_ERR_NOMEM
2027  *      Failed to allocate needed memory.
2028  * @retval ::WIMLIB_ERR_NOTDIR
2029  *      Could not determine the current working directory.
2030  * @retval ::WIMLIB_ERR_READ
2031  *      An unexpected end-of-file or read error occurred when trying to read
2032  *      data from the WIM file associated with @a wim.
2033  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2034  *      One of the dentries in the image referenced a stream not present in the
2035  *      WIM's lookup table (or in any of the lookup tables of the split WIM
2036  *      parts).
2037  * @retval ::WIMLIB_ERR_SPLIT_INVALID
2038  *      The WIM is a split WIM, but the parts specified do not form a complete
2039  *      split WIM because they do not include all the parts of the original WIM,
2040  *      there are duplicate parts, or not all the parts have the same GUID and
2041  *      compression type.
2042  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2043  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but @a
2044  *      wim is considered read-only because of any of the reasons mentioned in
2045  *      the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2046  * @retval ::WIMLIB_ERR_UNSUPPORTED
2047  *      Mounting is not supported, either because the platform is Windows, or
2048  *      because the platform is UNIX and wimlib was compiled with @c
2049  *      --without-fuse.
2050  */
2051 extern int
2052 wimlib_mount_image(WIMStruct *wim,
2053                    int image,
2054                    const wimlib_tchar *dir,
2055                    int mount_flags,
2056                    WIMStruct **additional_swms,
2057                    unsigned num_additional_swms,
2058                    const wimlib_tchar *staging_dir);
2059
2060 /**
2061  * Opens a WIM file and creates a ::WIMStruct for it.
2062  *
2063  * @param wim_file
2064  *      The path to the WIM file to open.
2065  * @param open_flags
2066  *      Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
2067  *      ::WIMLIB_OPEN_FLAG_SPLIT_OK and/or ::WIMLIB_OPEN_FLAG_WRITE_ACCESS.
2068  *
2069  * @param progress_func
2070  *      If non-NULL, a function that will be called periodically with the
2071  *      progress of the current operation.
2072  *
2073  * @param wim_ret
2074  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2075  *      is written to the memory location pointed to by this parameter.  The
2076  *      ::WIMStruct must be freed using using wimlib_free() when finished with
2077  *      it.
2078  *
2079  * @return 0 on success; nonzero on error.
2080  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
2081  *      The lookup table of @a wim_file is compressed.  Support for this can be
2082  *      added to wimlib if needed, but it appears to be the case that the lookup
2083  *      table is never compressed.
2084  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2085  *      The WIM is not the non-first part of a split WIM, and the number of
2086  *      metadata resources found in the WIM did not match the image count given
2087  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
2088  *      data for the WIM did not match the image count given in the WIM header.
2089  * @retval ::WIMLIB_ERR_INTEGRITY
2090  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2091  *      wim_file contains an integrity table, but the SHA1 message digest for a
2092  *      chunk of the WIM does not match the corresponding message digest given
2093  *      in the integrity table.
2094  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2095  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
2096  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2097  *      The header of @a wim_file says that resources in the WIM are compressed,
2098  *      but the header flag indicating LZX or XPRESS compression is not set.
2099  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
2100  *      The length field of the WIM header is not 208.
2101  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2102  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2103  *      wim_file contains an integrity table, but the integrity table is
2104  *      invalid.
2105  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2106  *      The lookup table for the WIM contained duplicate entries that are not
2107  *      for metadata resources, or it contained an entry with a SHA1 message
2108  *      digest of all 0's.
2109  * @retval ::WIMLIB_ERR_NOMEM
2110  *      Failed to allocated needed memory.
2111  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2112  *      @a wim_file does not begin with the expected magic characters.
2113  * @retval ::WIMLIB_ERR_OPEN
2114  *      Failed to open the file @a wim_file for reading.
2115  * @retval ::WIMLIB_ERR_READ
2116  *      An unexpected end-of-file or read error occurred when trying to read
2117  *      data from @a wim_file.
2118  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2119  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2120  *      specified in @a open_flags.
2121  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2122  *      A number other than 0x10d00 is written in the version field of the WIM
2123  *      header of @a wim_file.  (Probably a pre-Vista WIM).
2124  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2125  *      ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2126  *      considered read-only because of any of the reasons mentioned in the
2127  *      documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2128  * @retval ::WIMLIB_ERR_XML
2129  *      The XML data for @a wim_file is invalid.
2130  */
2131 extern int
2132 wimlib_open_wim(const wimlib_tchar *wim_file,
2133                 int open_flags,
2134                 WIMStruct **wim_ret,
2135                 wimlib_progress_func_t progress_func);
2136
2137 /**
2138  * Overwrites the file that the WIM was originally read from, with changes made.
2139  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2140  * rather than wimlib_create_new_wim().
2141  *
2142  * There are two ways that a WIM may be overwritten.  The first is to do a full
2143  * rebuild.  In this mode, the new WIM is written to a temporary file and then
2144  * renamed to the original file after it is has been completely written.  The
2145  * temporary file is made in the same directory as the original WIM file.  A
2146  * full rebuild may take a while, but can be used even if images have been
2147  * modified or deleted, will produce a WIM with no holes, and has little chance
2148  * of unintentional data loss because the temporary WIM is fsync()ed before
2149  * being renamed to the original WIM.
2150  *
2151  * The second way to overwrite a WIM is by appending to the end of it and
2152  * overwriting the header.  This can be much faster than a full rebuild, but the
2153  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
2154  * begins with writing any new file resources *after* everything in the old WIM,
2155  * even though this will leave a hole where the old lookup table, XML data, and
2156  * integrity were.  This is done so that the WIM remains valid even if the
2157  * operation is aborted mid-write.  The WIM header is only overwritten at the
2158  * very last moment, and up until that point the WIM will be seen as the old
2159  * version.
2160  *
2161  * By default, wimlib_overwrite() does the append-style overwrite described
2162  * above, unless resources in the WIM are arranged in an unusual way or if
2163  * images have been deleted from the WIM.  Use the flag
2164  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2165  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2166  * images have been deleted from the WIM.
2167  *
2168  * In the temporary-file overwrite mode, no changes are made to the WIM on
2169  * failure, and the temporary file is deleted if possible.  Abnormal termination
2170  * of the program will result in the temporary file being orphaned.  In the
2171  * direct append mode, the WIM is truncated to the original length on failure;
2172  * and while abnormal termination of the program will result in extra data
2173  * appended to the original WIM, it should still be a valid WIM.
2174  *
2175  * If this function completes successfully, no more functions should be called
2176  * on @a wim other than wimlib_free().  You must use wimlib_open_wim() to read
2177  * the WIM file anew.
2178  *
2179  * @param wim
2180  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
2181  *      been in-memory changes made to it, which are then reflected in the
2182  *      output file.
2183  * @param write_flags
2184  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2185  *      ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2186  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2187  * @param num_threads
2188  *      Number of threads to use for compression (see wimlib_write()).
2189  * @param progress_func
2190  *      If non-NULL, a function that will be called periodically with the
2191  *      progress of the current operation.
2192  *
2193  * @return 0 on success; nonzero on error.  This function may return any value
2194  * returned by wimlib_write() as well as the following error codes:
2195  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2196  *      The WIM was going to be modified in-place (with no temporary file), but
2197  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
2198  *      because another thread or process has mounted an image from the WIM
2199  *      read-write or is currently modifying the WIM in-place.
2200  * @retval ::WIMLIB_ERR_NO_FILENAME
2201  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2202  *      than a WIM read with wimlib_open_wim().
2203  * @retval ::WIMLIB_ERR_RENAME
2204  *      The temporary file that the WIM was written to could not be renamed to
2205  *      the original filename of @a wim.
2206  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2207  *      The WIM file is considered read-only because of any of the reasons
2208  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2209  *      flag.
2210  */
2211 extern int
2212 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2213                  wimlib_progress_func_t progress_func);
2214
2215 /**
2216  * Prints information about one image, or all images, contained in a WIM.
2217  *
2218  * @param wim
2219  *      Pointer to the ::WIMStruct for a WIM file.
2220  * @param image
2221  *      The image about which to print information.  Can be the number of an
2222  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2223  *      WIM.
2224  *
2225  * @return This function has no return value.  No error checking is done when
2226  * printing the information.  If @a image is invalid, an error message is
2227  * printed.
2228  */
2229 extern void
2230 wimlib_print_available_images(const WIMStruct *wim, int image);
2231
2232 /**
2233  * Prints the full paths to all files contained in an image, or all images, in a
2234  * WIM file.
2235  *
2236  * @param wim
2237  *      Pointer to the ::WIMStruct for a WIM file.
2238  * @param image
2239  *      Which image to print files for.  Can be the number of an image, or
2240  *      ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2241  *
2242  * @return 0 on success; nonzero on error.
2243  * @retval ::WIMLIB_ERR_DECOMPRESSION
2244  *      The metadata resource for one of the specified images could not be
2245  *      decompressed.
2246  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2247  *      A directory entry in the metadata resource for one of the specified
2248  *      images is invaled.
2249  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2250  *      @a image does not specify a valid image in @a wim, and is not
2251  *      ::WIMLIB_ALL_IMAGES.
2252  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2253  *      The metadata resource for one of the specified images is invalid.
2254  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2255  *      The security data for one of the specified images is invalid.
2256  * @retval ::WIMLIB_ERR_NOMEM
2257  *      Failed to allocate needed memory.
2258  * @retval ::WIMLIB_ERR_READ
2259  *      An unexpected read error or end-of-file occurred when reading the
2260  *      metadata resource for one of the specified images.
2261  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2262  *      @a wim was not a standalone WIM and was not the first part of a split
2263  *      WIM.
2264  */
2265 extern int
2266 wimlib_print_files(WIMStruct *wim, int image);
2267
2268 /**
2269  * Prints detailed information from the header of a WIM file.
2270  *
2271  * @param wim
2272  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2273  *      standalone WIM or part of a split WIM.
2274  *
2275  * @return This function has no return value.
2276  *
2277  */
2278 extern void
2279 wimlib_print_header(const WIMStruct *wim);
2280
2281 /**
2282  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
2283  * digests, as found in the directory entry tree in the WIM file, to file
2284  * resources in the WIM file.  This table includes one entry for each unique
2285  * file in the WIM, so it can be quite long.  There is only one lookup table per
2286  * WIM file, but each split WIM part has its own lookup table.
2287  *
2288  * @param wim
2289  *      Pointer to the ::WIMStruct for a WIM file.
2290  *
2291  * @return This function has no return value.
2292  */
2293 extern void
2294 wimlib_print_lookup_table(WIMStruct *wim);
2295
2296 /**
2297  * Prints the metadata of the specified image in a WIM file.  The metadata
2298  * consists of the security data as well as the directory entry tree.  Each
2299  * image has its own metadata.
2300  *
2301  * @param wim
2302  *      Pointer to the ::WIMStruct for a WIM file.
2303  * @param image
2304  *      Which image to print the metadata for.  Can be the number of an image,
2305  *      or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2306  *
2307  * @return 0 on success; nonzero on error.
2308  * @retval ::WIMLIB_ERR_DECOMPRESSION
2309  *      The metadata resource for one of the specified images could not be
2310  *      decompressed.
2311  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2312  *      A directory entry in the metadata resource for one of the specified
2313  *      images is invaled.
2314  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2315  *      @a image does not specify a valid image in @a wim, and is not
2316  *      ::WIMLIB_ALL_IMAGES.
2317  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2318  *      The metadata resource for one of the specified images is invalid.
2319  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2320  *      The security data for one of the specified images is invalid.
2321  * @retval ::WIMLIB_ERR_NOMEM
2322  *      Failed to allocate needed memory.
2323  * @retval ::WIMLIB_ERR_READ
2324  *      An unexpected read error or end-of-file occurred when reading the
2325  *      metadata resource for one of the specified images.
2326  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2327  *      @a wim was not a standalone WIM and was not the first part of a split
2328  *      WIM.
2329  */
2330 extern int
2331 wimlib_print_metadata(WIMStruct *wim, int image);
2332
2333 /**
2334  * Prints some basic information about a WIM file.  All information printed by
2335  * this function is also printed by wimlib_print_header(), but
2336  * wimlib_print_wim_information() prints some of this information more concisely
2337  * and in a more readable form.
2338  *
2339  * @param wim
2340  *      Pointer to the ::WIMStruct for a WIM file.
2341  *
2342  * @return This function has no return value.
2343  */
2344 extern void
2345 wimlib_print_wim_information(const WIMStruct *wim);
2346
2347 /**
2348  * Translates a string specifying the name or number of an image in the WIM into
2349  * the number of the image.  The images are numbered starting at 1.
2350  *
2351  * @param wim
2352  *      Pointer to the ::WIMStruct for a WIM file.
2353  * @param image_name_or_num
2354  *      A string specifying the name or number of an image in the WIM.  If it
2355  *      parses to a positive integer, this integer is taken to specify the
2356  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
2357  *      be the name of an image, as given in the XML data for the WIM file.  It
2358  *      also may be the keyword "all" or the string "*", both of which will
2359  *      resolve to ::WIMLIB_ALL_IMAGES.
2360  *      <br/> <br/>
2361  *      There is no way to search for an image actually named "all", "*", or an
2362  *      integer number, or an image that has no name.  However, you can use
2363  *      wimlib_get_image_name() to get the name of any image.
2364  *
2365  * @return
2366  *      If the string resolved to a single existing image, the number of that
2367  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
2368  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
2369  *      ::WIMLIB_NO_IMAGE is returned.  If @a image_name_or_num was @c NULL or
2370  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2371  *      images in @a wim has no name.
2372  */
2373 extern int
2374 wimlib_resolve_image(WIMStruct *wim,
2375                      const wimlib_tchar *image_name_or_num);
2376
2377 /**
2378  * Deprecated in favor of wimlib_set_wim_info().
2379  */
2380 extern int
2381 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx) _wimlib_deprecated;
2382
2383 /**
2384  * Changes the description of an image in the WIM.
2385  *
2386  * @param wim
2387  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2388  *      standalone WIM or part of a split WIM; however, you should set the same
2389  *      description on all parts of a split WIM.
2390  * @param image
2391  *      The number of the image for which to change the description.
2392  * @param description
2393  *      The new description to give the image.  It may be @c NULL, which
2394  *      indicates that the image is to be given no description.
2395  *
2396  * @return 0 on success; nonzero on error.
2397  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2398  *      @a image does not specify a single existing image in @a wim.
2399  * @retval ::WIMLIB_ERR_NOMEM
2400  *      Failed to allocate the memory needed to duplicate the @a description
2401  *      string.
2402  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2403  *      @a wim is considered read-only because of any of the reasons mentioned
2404  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2405  */
2406 extern int
2407 wimlib_set_image_descripton(WIMStruct *wim, int image,
2408                             const wimlib_tchar *description);
2409
2410 /**
2411  * Set basic information about a WIM.
2412  *
2413  * @param wim
2414  *      A WIMStruct for a standalone WIM file.
2415  * @param info
2416  *      A struct ::wimlib_wim_info that contains the information to set.  Only
2417  *      the information explicitly specified in the @a which flags need be
2418  *      valid.
2419  * @param which
2420  *      Flags that specify which information to set.  This is a bitwise OR of
2421  *      ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
2422  *      ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
2423  *
2424  * @return 0 on success; nonzero on failure.
2425  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2426  *      The WIM file is considered read-only because of any of the reasons
2427  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2428  *      flag.  However, as a special case, if you are using
2429  *      ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
2430  *      function will not fail due to the readonly flag being previously set.
2431  * @retval ::WIMLIB_ERR_IMAGE_COUNT
2432  *      ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
2433  *      ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
2434  *      index in the WIM.
2435  */
2436 extern int
2437 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
2438                     int which);
2439
2440 /**
2441  * Changes what is written in the \<FLAGS\> element in the WIM XML data
2442  * (something like "Core" or "Ultimate")
2443  *
2444  * @param wim
2445  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2446  *      standalone WIM or part of a split WIM; however, you should set the same
2447  *      \<FLAGS\> element on all parts of a split WIM.
2448  * @param image
2449  *      The number of the image for which to change the description.
2450  * @param flags
2451  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
2452  *      indicates that the image is to be given no \<FLAGS\> element.
2453  *
2454  * @return 0 on success; nonzero on error.
2455  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2456  *      @a image does not specify a single existing image in @a wim.
2457  * @retval ::WIMLIB_ERR_NOMEM
2458  *      Failed to allocate the memory needed to duplicate the @a flags string.
2459  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2460  *      @a wim is considered read-only because of any of the reasons mentioned
2461  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2462  */
2463 extern int
2464 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
2465
2466 /**
2467  * Changes the name of an image in the WIM.
2468  *
2469  * @param wim
2470  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2471  *      standalone WIM or part of a split WIM; however, you should set the same
2472  *      name on all parts of a split WIM.
2473  * @param image
2474  *      The number of the image for which to change the name.
2475  * @param name
2476  *      New name to give the new image.  If @c NULL or empty, the new image is
2477  *      given no name.  If nonempty, it must specify a name that does not
2478  *      already exist in @a wim.
2479  *
2480  * @return 0 on success; nonzero on error.
2481  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2482  *      There is already an image named @a name in @a wim.
2483  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2484  *      @a image does not specify a single existing image in @a wim.
2485  * @retval ::WIMLIB_ERR_NOMEM
2486  *      Failed to allocate the memory needed to duplicate the @a name string.
2487  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2488  *      @a wim is considered read-only because of any of the reasons mentioned
2489  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2490  */
2491 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2492                                  const wimlib_tchar *name);
2493
2494 /**
2495  * Set the functions that wimlib uses to allocate and free memory.
2496  *
2497  * These settings are global and not per-WIM.
2498  *
2499  * The default is to use the default @c malloc() and @c free() from the C
2500  * library.
2501  *
2502  * Please note that some external functions, such as those in @c libntfs-3g, may
2503  * use the standard memory allocation functions.
2504  *
2505  * @param malloc_func
2506  *      A function equivalent to @c malloc() that wimlib will use to allocate
2507  *      memory.  If @c NULL, the allocator function is set back to the default
2508  *      @c malloc() from the C library.
2509  * @param free_func
2510  *      A function equivalent to @c free() that wimlib will use to free memory.
2511  *      If @c NULL, the free function is set back to the default @c free() from
2512  *      the C library.
2513  * @param realloc_func
2514  *      A function equivalent to @c realloc() that wimlib will use to reallocate
2515  *      memory.  If @c NULL, the free function is set back to the default @c
2516  *      realloc() from the C library.
2517  * @return 0 on success; nonzero on error.
2518  * @retval ::WIMLIB_ERR_UNSUPPORTED
2519  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
2520  *      so custom memory allocators are unsupported.
2521  */
2522 extern int
2523 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2524                             void (*free_func)(void *),
2525                             void *(*realloc_func)(void *, size_t));
2526
2527 /**
2528  * Sets whether wimlib is to print error messages to @c stderr when a function
2529  * fails.  These error messages may provide information that cannot be
2530  * determined only from the error code that is returned.  Not every error will
2531  * result in an error message being printed.
2532  *
2533  * This setting is global and not per-WIM.
2534  *
2535  * By default, error messages are not printed.
2536  *
2537  * @param show_messages
2538  *      @c true if error messages are to be printed; @c false if error messages
2539  *      are not to be printed.
2540  *
2541  * @return 0 on success; nonzero on error.
2542  * @retval ::WIMLIB_ERR_UNSUPPORTED
2543  *      @a show_messages was @c true, but wimlib was compiled with the @c
2544  *      --without-error-messages option.   Therefore, error messages cannot be
2545  *      shown.
2546  */
2547 extern int
2548 wimlib_set_print_errors(bool show_messages);
2549
2550 /**
2551  * Splits a WIM into multiple parts.
2552  *
2553  * @param wim
2554  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
2555  *      WIM.
2556  * @param swm_name
2557  *      Name of the SWM file to create.  This will be the name of the first
2558  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
2559  *      appended before the suffix.
2560  * @param part_size
2561  *      The maximum size per part, in bytes.  It is not guaranteed that this
2562  *      will really be the maximum size per part, because some file resources in
2563  *      the WIM may be larger than this size, and the WIM file format provides
2564  *      no way to split up file resources among multiple WIMs.
2565  * @param write_flags
2566  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2567  *      included in the split WIM parts.
2568  * @param progress_func
2569  *      If non-NULL, a function that will be called periodically with the
2570  *      progress of the current operation.
2571  *
2572  * @return 0 on success; nonzero on error.  This function may return any value
2573  * returned by wimlib_write() as well as the following error codes:
2574  *
2575  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2576  *      @a wim is not part 1 of a stand-alone WIM.
2577  * @retval ::WIMLIB_ERR_INVALID_PARAM
2578  *      @a swm_name was @c NULL, or @a part_size was 0.
2579  *
2580  * Note: the WIM's uncompressed and compressed resources are not checksummed
2581  * when they are copied from the joined WIM to the split WIM parts, nor are
2582  * compressed resources re-compressed.
2583  */
2584 extern int
2585 wimlib_split(WIMStruct *wim,
2586              const wimlib_tchar *swm_name,
2587              size_t part_size,
2588              int write_flags,
2589              wimlib_progress_func_t progress_func);
2590
2591 /**
2592  * Unmounts a WIM image that was mounted using wimlib_mount_image().
2593  *
2594  * The image to unmount is specified by the path to the mountpoint, not the
2595  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2596  * touched and also may have been allocated in a different process.
2597  *
2598  * To unmount the image, the thread calling this function communicates with the
2599  * thread that is managing the mounted WIM image.  This function blocks until it
2600  * is known whether the unmount succeeded or failed.  In the case of a
2601  * read-write mounted WIM, the unmount is not considered to have succeeded until
2602  * all changes have been saved to the underlying WIM file.
2603  *
2604  * @param dir
2605  *      The directory that the WIM image was mounted on.
2606  * @param unmount_flags
2607  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2608  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2609  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
2610  *      mounts.
2611  * @param progress_func
2612  *      If non-NULL, a function that will be called periodically with the
2613  *      progress of the current operation.
2614  *
2615  * @return 0 on success; nonzero on error.
2616  *
2617  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2618  *      The filesystem daemon was unable to remove the staging directory and the
2619  *      temporary files that it contains.
2620  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2621  *      The filesystem daemon appears to have terminated before sending an exit
2622  *      status.
2623  * @retval ::WIMLIB_ERR_FORK
2624  *      Could not @c fork() the process.
2625  * @retval ::WIMLIB_ERR_FUSERMOUNT
2626  *      The @b fusermount program could not be executed or exited with a failure
2627  *      status.
2628  * @retval ::WIMLIB_ERR_MQUEUE
2629  *      Could not open a POSIX message queue to communicate with the filesystem
2630  *      daemon servicing the mounted filesystem, could not send a message
2631  *      through the queue, or could not receive a message through the queue.
2632  * @retval ::WIMLIB_ERR_NOMEM
2633  *      Failed to allocate needed memory.
2634  * @retval ::WIMLIB_ERR_OPEN
2635  *      The filesystem daemon could not open a temporary file for writing the
2636  *      new WIM.
2637  * @retval ::WIMLIB_ERR_READ
2638  *      A read error occurred when the filesystem daemon tried to a file from
2639  *      the staging directory
2640  * @retval ::WIMLIB_ERR_RENAME
2641  *      The filesystem daemon failed to rename the newly written WIM file to the
2642  *      original WIM file.
2643  * @retval ::WIMLIB_ERR_UNSUPPORTED
2644  *      Mounting is not supported, either because the platform is Windows, or
2645  *      because the platform is UNIX and wimlib was compiled with @c
2646  *      --without-fuse.
2647  * @retval ::WIMLIB_ERR_WRITE
2648  *      A write error occurred when the filesystem daemon was writing to the new
2649  *      WIM file, or the filesystem daemon was unable to flush changes that had
2650  *      been made to files in the staging directory.
2651  */
2652 extern int
2653 wimlib_unmount_image(const wimlib_tchar *dir,
2654                      int unmount_flags,
2655                      wimlib_progress_func_t progress_func);
2656
2657 /**
2658  * Update a WIM image by adding, deleting, and/or renaming files or directories.
2659  *
2660  * @param wim
2661  *      Pointer to the ::WIMStruct for the WIM file to update.
2662  * @param image
2663  *      The 1-based index of the image in the WIM to update.  It cannot be
2664  *      ::WIMLIB_ALL_IMAGES.
2665  * @param cmds
2666  *      An array of ::wimlib_update_command's that specify the update operations
2667  *      to perform.
2668  * @param num_cmds
2669  *      Number of commands in @a cmds.
2670  * @param update_flags
2671  *      ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2672  * @param progress_func
2673  *      If non-NULL, a function that will be called periodically with the
2674  *      progress of the current operation.
2675  *
2676  * @return 0 on success; nonzero on error.  On failure, some but not all of the
2677  * update commands may have been executed.  No individual update command will
2678  * have been partially executed.  Possible error codes include:
2679  *
2680  * @retval ::WIMLIB_ERR_DECOMPRESSION
2681  *      Failed to decompress the metadata resource from @a image in @a wim.
2682  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2683  *      The capture configuration structure specified for an add command was
2684  *      invalid.
2685  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2686  *      A directory entry for @a image in @a wim is invalid.
2687  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2688  *      @a image did not specify a single, existing image in @a wim.
2689  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2690  *      Attempted to perform an add command that conflicted with previously
2691  *      existing files in the WIM when an overlay was attempted.
2692  * @retval ::WIMLIB_ERR_INVALID_PARAM
2693  *      An unknown operation type was specified in the update commands; or,
2694  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2695  *      in the @a add_flags, but the same image had previously already been
2696  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2697  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2698  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2699  *      specified in the @a add_flags for an add command in which @a
2700  *      wim_target_path was not the root directory of the WIM image.
2701  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2702  *      (Windows only):  While executing an add command, tried to capture a
2703  *      reparse point with invalid data.
2704  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2705  *      The metadata resource for @a image in @a wim is invalid.
2706  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2707  *      The security data for image @a image in @a wim is invalid.
2708  * @retval ::WIMLIB_ERR_IS_DIRECTORY
2709  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2710  *      for a WIM path that corresponded to a directory; or, a rename command
2711  *      attempted to rename a directory to a non-directory.
2712  * @retval ::WIMLIB_ERR_NOMEM
2713  *      Failed to allocate needed memory.
2714  * @retval ::WIMLIB_ERR_NOTDIR
2715  *      A rename command attempted to rename a directory to a non-directory; or,
2716  *      an add command was executed that attempted to set the root of the WIM
2717  *      image as a non-directory; or, a path component used as a directory in a
2718  *      rename command was not, in fact, a directory.
2719  * @retval ::WIMLIB_ERR_NOTEMPTY
2720  *      A rename command attempted to rename a directory to a non-empty
2721  *      directory.
2722  * @retval ::WIMLIB_ERR_NTFS_3G
2723  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2724  *      error occurred while reading data from the NTFS volume using libntfs-3g.
2725  * @retval ::WIMLIB_ERR_OPEN
2726  *      Failed to open a file to be captured while executing an add command.
2727  * @retval ::WIMLIB_ERR_OPENDIR
2728  *      Failed to open a directory to be captured while executing an add command.
2729  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2730  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2731  *      WIM path that did not exist; or, a rename command attempted to rename a
2732  *      file that does not exist.
2733  * @retval ::WIMLIB_ERR_READ
2734  *      Failed to read the metadata resource for @a image in @a wim; or, while
2735  *      executing an add command, failed to read data from a file or directory
2736  *      to be captured.
2737  * @retval ::WIMLIB_ERR_READLINK
2738  *      While executing an add command, failed to read the target of a symbolic
2739  *      link or junction point.
2740  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2741  *      (Windows only) Failed to perform a reparse point fixup because of
2742  *      problems with the data of a reparse point.
2743  * @retval ::WIMLIB_ERR_SPECIAL_FILE
2744  *      While executing an add command, attempted to capture a file that was not
2745  *      a supported file type, such as a regular file, directory, symbolic link,
2746  *      or (on Windows) a reparse point.
2747  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2748  *      @a wim is part of a split WIM.  Updating a split WIM is unsupported.
2749  * @retval ::WIMLIB_ERR_STAT
2750  *      While executing an add command, failed to get attributes for a file or
2751  *      directory.
2752  * @retval ::WIMLIB_ERR_UNSUPPORTED
2753  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2754  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
2755  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2756  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2757  *      add_flags for an update command.
2758  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2759  *      The WIM file is considered read-only because of any of the reasons
2760  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2761  *      flag.
2762  */
2763 extern int
2764 wimlib_update_image(WIMStruct *wim,
2765                     int image,
2766                     const struct wimlib_update_command *cmds,
2767                     size_t num_cmds,
2768                     int update_flags,
2769                     wimlib_progress_func_t progress_func);
2770
2771 /**
2772  * Writes a standalone WIM to a file.
2773  *
2774  * This brings in resources from any external locations, such as directory trees
2775  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2776  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2777  *
2778  * @param wim
2779  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
2780  *      changes made to it, which are then reflected in the output file.
2781  * @param path
2782  *      The path to the file to write the WIM to.
2783  * @param image
2784  *      The image inside the WIM to write.  Use ::WIMLIB_ALL_IMAGES to include all
2785  *      images.
2786  * @param write_flags
2787  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2788  *      ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2789  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2790  * @param num_threads
2791  *      Number of threads to use for compressing data.  If 0, the number of
2792  *      threads is taken to be the number of online processors.  Note: if no
2793  *      data compression needs to be done, no additional threads will be created
2794  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
2795  *      exporting an image from a compressed WIM to another WIM of the same
2796  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2797  *      write_flags).
2798  * @param progress_func
2799  *      If non-NULL, a function that will be called periodically with the
2800  *      progress of the current operation.
2801  *
2802  * @return 0 on success; nonzero on error.
2803  * @retval ::WIMLIB_ERR_DECOMPRESSION
2804  *      Failed to decompress a metadata or file resource in @a wim.
2805  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2806  *      A directory entry in the metadata resource for @a image in @a wim is
2807  *      invalid.
2808  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2809  *      @a image does not specify a single existing image in @a wim, and is not
2810  *      ::WIMLIB_ALL_IMAGES.
2811  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2812  *      A file that had previously been scanned for inclusion in the WIM by
2813  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
2814  *      message digest check.
2815  * @retval ::WIMLIB_ERR_INVALID_PARAM
2816  *      @a path was @c NULL.
2817  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2818  *      The metadata resource for @a image in @a wim is invalid.
2819  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2820  *      The security data for @a image in @a wim is invalid.
2821  * @retval ::WIMLIB_ERR_NOMEM
2822  *      Failed to allocate needed memory.
2823  * @retval ::WIMLIB_ERR_OPEN
2824  *      Failed to open @a path for writing, or some file resources in @a
2825  *      wim refer to files in the outside filesystem, and one of these files
2826  *      could not be opened for reading.
2827  * @retval ::WIMLIB_ERR_READ
2828  *      An error occurred when trying to read data from the WIM file associated
2829  *      with @a wim, or some file resources in @a wim refer to files in the
2830  *      outside filesystem, and a read error occurred when reading one of these
2831  *      files.
2832  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2833  *      @a wim is part of a split WIM.  You may not call this function on a
2834  *      split WIM.
2835  * @retval ::WIMLIB_ERR_WRITE
2836  *      An error occurred when trying to write data to the new WIM file at @a
2837  *      path.
2838  */
2839 extern int
2840 wimlib_write(WIMStruct *wim,
2841              const wimlib_tchar *path,
2842              int image,
2843              int write_flags,
2844              unsigned num_threads,
2845              wimlib_progress_func_t progress_func);
2846
2847 /**
2848  * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2849  * the data using "XPRESS" compression.
2850  */
2851 extern unsigned
2852 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2853
2854 /**
2855  * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2856  * the data is compressed using "XPRESS" compression.
2857  */
2858 extern int
2859 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2860                          void *uncompressed_data, unsigned uncompressed_len);
2861
2862 #endif /* _WIMLIB_H */