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