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