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