4 * External header for wimlib.
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.
12 * Copyright (C) 2012, 2013 Eric Biggers
14 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
32 * \section intro Introduction
34 * This is the documentation for the library interface of wimlib 1.3.0. If you
35 * have installed wimlib and want to know how to use the @c imagex program,
36 * please see the man pages instead. Also: the actual project page where you
37 * can download the source code for the library is at <a
38 * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
40 * wimlib is a C library to read, write, and mount archive files in the Windows
41 * Imaging Format (WIM files). These files are normally created using the @c
42 * imagex.exe utility on Windows, but this library provides a free
43 * implementetion of @c imagex for UNIX-based systems and an API to allow other
44 * programs to read, write, and mount WIM files. wimlib is comparable to
45 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
47 * \section format WIM files
49 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
50 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
51 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
52 * Both are based on LZ77 and Huffman encoding, and both are supported by
55 * Unlike ZIP files, WIM files can contain multiple independent toplevel
56 * directory trees known as @a images. While each image has its own metadata,
57 * files are not duplicated for each image; instead, each file is included only
58 * once in the entire WIM. Microsoft did this so that in one WIM file, they
59 * could do things like have 5 different versions of Windows that are almost
62 * Microsoft provides documentation for the WIM file format, XPRESS compression
63 * format, and LZX compression format. The XPRESS documentation is acceptable,
64 * but the LZX documentation is not entirely correct, and the WIM documentation
65 * itself is incomplete.
67 * A WIM file may be either stand-alone or split into multiple parts.
69 * \section ntfs NTFS support
71 * As of version 1.0.0, wimlib supports capturing and applying images directly
72 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
73 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
74 * data such as security descriptors, alternate data streams, and reparse point
77 * The code for NTFS image capture and image application is complete enough that
78 * it is possible to apply an image from the "install.wim" contained in recent
79 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
80 * NTFS volume, and then boot Windows from it after preparing the Boot
81 * Configuration Data. In addition, a Windows installation can be captured (or
82 * backed up) into a WIM file, and then re-applied later.
84 * \section winpe Windows PE
86 * A major use for this library is to create customized images of Windows PE, the
87 * Windows Preinstallation Environment, without having to rely on Windows. Windows
88 * PE is a lightweight version of Windows that can run entirely from memory and can
89 * be used to install Windows from local media or a network drive or perform
90 * maintenance. Windows PE is the operating system that runs when you boot from
91 * the Windows installation media.
93 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
94 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
95 * in the Windows Automated Installation Kit (WAIK), which is free to download
96 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
97 * install either the @c cabextract or @c p7zip programs.
99 * In addition, Windows installations and recovery partitions frequently contain a
100 * WIM containing an image of the Windows Recovery Environment, which is similar to
103 * \section starting Getting Started
105 * wimlib uses the GNU autotools, so it should be easy to install with
106 * <code>configure && make && sudo make install</code>; however, please see the
107 * README for more information about installing it. To use wimlib in a program
108 * after installing it, include @c wimlib.h and link your program with @c -lwim.
110 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
111 * may represent either a stand-alone WIM or one part of a split WIM.
113 * All functions in wimlib's public API are prefixed with @c wimlib. Most
114 * return an integer error code on failure. Use wimlib_get_error_string() to
115 * get a string that describes an error code. wimlib also can print error
116 * messages itself when an error happens, and these may be more informative than
117 * the error code; to enable this, call wimlib_set_print_errors(). Please note
118 * that this is for convenience only, and some errors can occur without a
119 * message being printed.
121 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
122 * the following exceptions:
123 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
124 * - You also must call wimlib_global_init() in the main thread to avoid any
125 * race conditions with one-time allocations of memory.
126 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
127 * concurrently in the same process, will daemonize the entire process when it
128 * does so for the first time. This includes changing the working directory
129 * to the root directory.
131 * To open an existing WIM, use wimlib_open_wim().
133 * To create a new WIM that initially contains no images, use
134 * wimlib_create_new_wim().
136 * To add an image to a WIM file from a directory tree on your filesystem, call
137 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
138 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
139 * also capture a WIM image directly from a NTFS volume if you provide the
140 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
141 * the <code>--without-ntfs-3g</code> flag.
143 * To extract an image from a WIM file, call wimlib_extract_image(). You may
144 * extract an image either to a directory or directly to a NTFS volume, the
145 * latter of which will preserve NTFS-specific data such as security
148 * wimlib supports mounting WIM files either read-only or read-write. Mounting
149 * is done using wimlib_mount_image() and unmounting is done using
150 * wimlib_unmount_image(). Mounting can be done without root privileges because
151 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
152 * compiled with the <code>--without-fuse</code> flag, these functions will be
153 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
155 * After creating or modifying a WIM file, you can write it to a file using
156 * wimlib_write(). Alternatively, if the WIM was originally read from a file
157 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
158 * wimlib_overwrite() to overwrite the original file.
160 * Please note: merely by calling wimlib_add_image() or many of the other
161 * functions in this library that operate on ::WIMStruct's, you are @b not
162 * modifying the WIM file on disk. Changes are not saved until you explicitly
163 * call wimlib_write() or wimlib_overwrite().
165 * After you are done with the WIM file, use wimlib_free() to free all memory
166 * associated with a ::WIMStruct and close all files associated with it.
168 * A number of functions take a pointer to a progress function of type
169 * ::wimlib_progress_func_t. This function will be called periodically during
170 * the WIM operation(s) to report on the progress of the operation (for example,
171 * how many bytes have been written so far).
173 * \section imagex imagex
175 * wimlib comes with a command-line interface, the @b imagex program. It is
176 * documented with man pages. See its source code (@c programs/imagex.c in
177 * wimlib's source tree) for an example of how to use wimlib in your program.
179 * \section mkwinpeimg mkwinpeimg
181 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
184 * \section Limitations
186 * While wimlib supports the main features of WIM files, wimlib currently has
187 * the following limitations:
188 * - wimlib cannot be used on MS-Windows.
189 * - There is no way to add, remove, modify, or extract specific files in a WIM
190 * without mounting it, other than by adding, removing, or extracting an
191 * entire image. The FUSE mount feature should be used for this purpose.
192 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
193 * than wimlib when using maximum (LZX) compression because it knows how to
194 * split up LZX compressed blocks, which is not yet implemented in wimlib.
195 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
196 * imagex.exe if you want to make sure your WIM files are made "correctly".
197 * - The old WIM format from Vista pre-releases is not supported.
198 * - Compressed resource chunk sizes other than 32768 are not supported,
199 * although this doesn't seem to be a problem because the chunk size always
200 * seems to be this value.
201 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
202 * make certain Windows-specific modifications to a Windows PE image, such as
203 * adding a driver or Windows component. Such a tool could conceivably be
204 * implemented on top of wimlib, although it likely would be hard to implement
205 * because it would have to do very Windows-specific things such as
206 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
207 * script for a similar purpose, however. With regards to adding drivers to
208 * Windows PE, you have the option of putting them anywhere in the Windows PE
209 * image, then loading them after boot using @b drvload.exe.
211 * \section legal License
213 * The wimlib library, as well as the programs and scripts distributed with it
214 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
215 * License version 3 or later.
224 #include <inttypes.h>
226 /** Major version of the library (for example, the 1 in 1.2.5). */
227 #define WIMLIB_MAJOR_VERSION 1
229 /** Minor version of the library (for example, the 2 in 1.2.5). */
230 #define WIMLIB_MINOR_VERSION 3
232 /** Patch version of the library (for example, the 5 in 1.2.5). */
233 #define WIMLIB_PATCH_VERSION 0
236 * Opaque structure that represents a WIM file. This is an in-memory structure
237 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
238 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
239 * continuing to exist so that data can be read from it as needed.
241 * Most functions in this library will work the same way regardless of whether a
242 * given ::WIMStruct was obtained through wimlib_open_wim() or
243 * wimlib_create_new_wim(). Exceptions are documented.
245 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
246 * file from a ::WIMStruct.
248 typedef struct WIMStruct WIMStruct;
251 * Specifies the compression type of a WIM file.
253 enum wimlib_compression_type {
254 /** An invalid compression type. */
255 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
257 /** The WIM does not include any compressed resources. */
258 WIMLIB_COMPRESSION_TYPE_NONE = 0,
260 /** Compressed resources in the WIM use LZX compression. */
261 WIMLIB_COMPRESSION_TYPE_LZX = 1,
263 /** Compressed resources in the WIM use XPRESS compression. */
264 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
267 /** Possible values of the first parameter to the user-supplied
268 * ::wimlib_progress_func_t progress function */
269 enum wimlib_progress_msg {
271 /** A WIM image is about to be extracted. @a info will point to
272 * ::wimlib_progress_info.extract. */
273 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
275 /** The directory structure of the WIM image is about to be extracted.
276 * @a info will point to ::wimlib_progress_info.extract. */
277 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
279 /** The directory structure of the WIM image has been successfully
280 * extracted. @a info will point to ::wimlib_progress_info.extract. */
281 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
283 /** The WIM image's files resources are currently being extracted. @a
284 * info will point to ::wimlib_progress_info.extract. */
285 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
287 /** A file or directory is being extracted. @a info will point to
288 * ::wimlib_progress_info.extract, and the @a cur_path member will be
290 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
292 /** All the WIM files and directories have been extracted, and
293 * timestamps are about to be applied. @a info will point to
294 * ::wimlib_progress_info.extract. */
295 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
297 /** A WIM image has been successfully extracted. @a info will point to
298 * ::wimlib_progress_info.extract. */
299 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
301 /** The directory or NTFS volume is about to be scanned to build a tree
302 * of WIM dentries in-memory. @a info will point to
303 * ::wimlib_progress_info.scan. */
304 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
306 /** A directory or file is being scanned. @a info will point to
307 * ::wimlib_progress_info.scan, and its @a cur_path member will be
308 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
309 * is passed to wimlib_add_image(). */
310 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
312 /** The directory or NTFS volume has been successfully scanned, and a
313 * tree of WIM dentries has been built in-memory. @a info will point to
314 * ::wimlib_progress_info.scan. */
315 WIMLIB_PROGRESS_MSG_SCAN_END,
318 * File resources are currently being written to the WIM.
319 * @a info will point to ::wimlib_progress_info.write_streams. */
320 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
323 * The metadata resource for each image is about to be written to the
324 * WIM. @a info will not be valid. */
325 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
328 * The metadata resource for each image has successfully been writen to
329 * the WIM. @a info will not be valid. */
330 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
333 * The temporary file has successfully been renamed to the original WIM
334 * file. Only happens when wimlib_overwrite() is called and the
335 * overwrite is not done in-place.
336 * @a info will point to ::wimlib_progress_info.rename. */
337 WIMLIB_PROGRESS_MSG_RENAME,
339 /** The contents of the WIM are being checked against the integrity
340 * table. Only happens when wimlib_open_wim() is called with the
341 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
342 * ::wimlib_progress_info.integrity. */
343 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
345 /** An integrity table is being calculated for the WIM being written.
346 * Only happens when wimlib_write() or wimlib_overwrite() is called with
347 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
348 * ::wimlib_progress_info.integrity. */
349 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
351 /** A wimlib_join() operation is in progress. @a info will point to
352 * ::wimlib_progress_info.join. */
353 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
355 /** A wimlib_split() operation is in progress, and a new split part is
356 * about to be started. @a info will point to
357 * ::wimlib_progress_info.split. */
358 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
360 /** A wimlib_split() operation is in progress, and a split part has been
361 * finished. @a info will point to ::wimlib_progress_info.split. */
362 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
365 /** A pointer to this union is passed to the user-supplied
366 * ::wimlib_progress_func_t progress function. One (or none) of the structures
367 * contained in this union will be applicable for the operation
368 * (::wimlib_progress_msg) indicated in the first argument to the progress
370 union wimlib_progress_info {
372 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
373 * document them if they aren't given a name... */
375 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
376 struct wimlib_progress_info_write_streams {
377 /** Number of bytes that are going to be written for all the
378 * streams combined. This is the amount in uncompressed data.
379 * (The actual number of bytes will be less if the data is being
380 * written compressed.) */
381 uint64_t total_bytes;
382 /** Number of streams that are going to be written. */
383 uint64_t total_streams;
385 /** Number of uncompressed bytes that have been written so far.
386 * Will be 0 initially, and equal to @a total_bytes at the end.
388 uint64_t completed_bytes;
390 /** Number of streams that have been written. Will be 0
391 * initially, and equal to @a total_streams at the end. */
392 uint64_t completed_streams;
394 /** Number of threads that are being used to compress resources
395 * (if applicable). */
396 unsigned num_threads;
398 /** The compression type being used to write the streams; either
399 * ::WIMLIB_COMPRESSION_TYPE_NONE,
400 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
401 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
402 int compression_type;
405 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
406 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
407 struct wimlib_progress_info_scan {
408 /** Directory or NTFS volume that is being scanned. */
411 /** Path to the file or directory that is about to be scanned,
412 * relative to the root of the image capture or the NTFS volume.
414 const char *cur_path;
416 /** True iff @a cur_path is being excluded from the image
417 * capture due to the capture configuration file. */
420 /** Target path in the WIM. Only valid on messages
421 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
422 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
423 const char *wim_target_path;
426 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
427 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
428 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
429 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
430 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
431 struct wimlib_progress_info_extract {
432 /** Number of the image being extracted (1-based). */
435 /** Flags passed to to wimlib_extract_image() */
438 /** Full path to the WIM file being extracted. */
439 const char *wimfile_name;
441 /** Name of the image being extracted. */
442 const char *image_name;
444 /** Directory or NTFS volume to which the image is being
448 /** Current dentry being extracted. (Valid only if message is
449 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
450 const char *cur_path;
452 /** Number of bytes of uncompressed data that will be extracted.
453 * Takes into account hard links (they are not counted for each
456 uint64_t total_bytes;
458 /** Number of bytes that have been written so far. Will be 0
459 * initially, and equal to @a total_bytes at the end. */
460 uint64_t completed_bytes;
462 /** Number of streams that will be extracted. This may more or
463 * less than the number of "files" to be extracted due to
464 * special cases (hard links, symbolic links, and alternate data
466 uint64_t num_streams;
469 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
470 struct wimlib_progress_info_rename {
471 /** Name of the temporary file that the WIM was written to. */
474 /** Name of the original WIM file to which the temporary file is
479 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
480 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
481 struct wimlib_progress_info_integrity {
482 /** Number of bytes from the end of the WIM header to the end of
483 * the lookup table (the area that is covered by the SHA1
484 * integrity checks.) */
485 uint64_t total_bytes;
487 /** Number of bytes that have been SHA1-summed so far. Will be
488 * 0 initially, and equal @a total_bytes at the end. */
489 uint64_t completed_bytes;
491 /** Number of chunks that the checksummed region is divided
493 uint32_t total_chunks;
495 /** Number of chunks that have been SHA1-summed so far. Will
496 * be 0 initially, and equal to @a total_chunks at the end. */
497 uint32_t completed_chunks;
499 /** Size of the chunks used for the integrity calculation. */
502 /** Filename of the WIM (only valid if the message is
503 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
504 const char *filename;
507 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
508 struct wimlib_progress_info_join {
509 /** Total number of bytes of compressed data contained in all
510 * the split WIM part's file and metadata resources. */
511 uint64_t total_bytes;
513 /** Number of bytes that have been copied to the joined WIM so
514 * far. Will be 0 initially, and equal to @a total_bytes at the
516 uint64_t completed_bytes;
518 /** Number of split WIM parts that have had all their file and
519 * metadata resources copied over to the joined WIM so far. */
520 unsigned completed_parts;
522 /** Number of split WIM parts. */
523 unsigned total_parts;
526 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
527 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
528 struct wimlib_progress_info_split {
529 /** Total size of the original WIM's file and metadata resources
531 uint64_t total_bytes;
533 /** Number of bytes of file and metadata resources that have
534 * been copied out of the original WIM so far. Will be 0
535 * initially, and equal to @a total_bytes at the end. */
536 uint64_t completed_bytes;
538 /** Number of the split WIM part that is about to be started
539 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
540 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
541 unsigned cur_part_number;
543 /** Name of the split WIM part that is about to be started
544 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
545 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
546 const char *part_name;
550 /** A user-supplied function that will be called periodically during certain WIM
551 * operations. The first argument will be the type of operation that is being
552 * performed or is about to be started or has been completed. The second
553 * argument will be a pointer to one of a number of structures depending on the
554 * first argument. It may be @c NULL for some message types.
556 * The return value of the progress function is currently ignored, but it may do
557 * something in the future. (Set it to 0 for now.)
559 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
560 const union wimlib_progress_info *info);
562 /** An array of these structures is passed to wimlib_add_image_multisource() to
563 * specify the sources from which to create a WIM image. */
564 struct wimlib_capture_source {
565 /** Absolute or relative path to a file or directory on the external
566 * filesystem to be included in the WIM image. */
567 char *fs_source_path;
569 /** Destination path in the WIM image. Leading and trailing slashes are
570 * ignored. The empty string or @c NULL means the root directory of the
572 char *wim_target_path;
574 /** Reserved; set to 0. */
579 /*****************************
580 * WIMLIB_ADD_IMAGE_FLAG_* *
581 *****************************/
583 /** Directly capture a NTFS volume rather than a generic directory. This flag
584 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
585 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
586 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
588 /** Follow symlinks; archive and dump the files they point to. Cannot be used
589 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
590 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
592 /** Call the progress function with the message
593 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
595 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
597 /** Mark the image being added as the bootable image of the WIM. */
598 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
600 /** Store the UNIX owner, group, and mode. This is done by adding a special
601 * alternate data stream to each regular file, symbolic link, and directory to
602 * contain this information. Please note that this flag is for convenience
603 * only; Microsoft's version of imagex.exe will not understand this special
604 * information. This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS.
606 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
608 /******************************
609 * WIMLIB_EXPORT_FLAG_* *
610 ******************************/
612 /** See documentation for wimlib_export_image(). */
613 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
615 /******************************
616 * WIMLIB_EXTRACT_FLAG_* *
617 ******************************/
619 /** Extract the image directly to a NTFS volume rather than a generic directory.
621 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
623 /** When identical files are extracted from the WIM, always hard link them
624 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
625 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
627 /** When identical files are extracted from the WIM, always symlink them
628 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
629 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
631 /** Call the progress function with the argument
632 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
633 * extracted. Note: these calls will be interspersed with calls for the message
634 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
635 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
637 /** Read the WIM file sequentially while extracting the image. */
638 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
640 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
641 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
642 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
644 /******************************
645 * WIMLIB_MOUNT_FLAG_* *
646 ******************************/
648 /** Mount the WIM image read-write rather than the default of read-only. */
649 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
651 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
652 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
654 /** Do not allow accessing alternate data streams in the mounted WIM image. */
655 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
657 /** Access alternate data streams in the mounted WIM image through extended file
658 * attributes. This is the default mode. */
659 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
661 /** Access alternate data streams in the mounted WIM image by specifying the
662 * file name, a colon, then the alternate file stream name. */
663 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
665 /** Use UNIX file owners, groups, and modes if available in the WIM (see
666 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
667 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
669 /** Allow other users to see the mounted filesystem. (this passes the @c
670 * allow_other option to FUSE mount) */
671 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
673 /******************************
674 * WIMLIB_OPEN_FLAG_* *
675 ******************************/
677 /** Verify the WIM contents against the WIM's integrity table, if present. */
678 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
680 /** Do not issue an error if the WIM is part of a split WIM. */
681 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
683 /******************************
684 * WIMLIB_UNMOUNT_FLAG_* *
685 ******************************/
687 /** Include an integrity table in the WIM after it's been unmounted. Ignored
688 * for read-only mounts. */
689 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
691 /** Unless this flag is given, changes to a read-write mounted WIM are
692 * discarded. Ignored for read-only mounts. */
693 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
695 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
696 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
698 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
699 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
701 /******************************
702 * WIMLIB_WRITE_FLAG_* *
703 ******************************/
705 /** Include an integrity table in the new WIM file. */
706 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
708 /** Re-build the entire WIM file rather than appending data to it, if possible.
709 * (Applies to wimlib_overwrite(), not wimlib_write()). */
710 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
712 /** Recompress all resources, even if they could otherwise be copied from a
713 * different WIM with the same compression type (in the case of
714 * wimlib_export_image() being called previously). */
715 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
717 /** Call fsync() when the WIM file is closed */
718 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
720 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
721 * after one or more calls to wimlib_delete_image(), which is to rebuild the
724 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
725 * correctly remove the image from the WIM will be taken. In particular, all
726 * streams will be left alone, even if they are no longer referenced. This is
727 * probably not what you want, because almost no space will be spaced by
728 * deleting an image in this way. */
729 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
732 * Possible values of the error code returned by many functions in wimlib.
734 * See the documentation for each wimlib function to see specifically what error
735 * codes can be returned by a given function, and what they mean.
737 /* Note: these are currently in alphabetic order, but new error codes should be
738 * added at the end to maintain a compatible ABI, except when it's being broken
740 enum wimlib_error_code {
741 WIMLIB_ERR_SUCCESS = 0,
742 WIMLIB_ERR_ALREADY_LOCKED,
743 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
744 WIMLIB_ERR_DECOMPRESSION,
745 WIMLIB_ERR_DELETE_STAGING_DIR,
746 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
749 WIMLIB_ERR_FUSERMOUNT,
750 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
751 WIMLIB_ERR_IMAGE_COUNT,
752 WIMLIB_ERR_IMAGE_NAME_COLLISION,
753 WIMLIB_ERR_INTEGRITY,
754 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
755 WIMLIB_ERR_INVALID_CHUNK_SIZE,
756 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
757 WIMLIB_ERR_INVALID_DENTRY,
758 WIMLIB_ERR_INVALID_HEADER_SIZE,
759 WIMLIB_ERR_INVALID_IMAGE,
760 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
761 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
762 WIMLIB_ERR_INVALID_PARAM,
763 WIMLIB_ERR_INVALID_PART_NUMBER,
764 WIMLIB_ERR_INVALID_RESOURCE_HASH,
765 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
766 WIMLIB_ERR_INVALID_SECURITY_DATA,
767 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
768 WIMLIB_ERR_INVALID_UTF8_STRING,
769 WIMLIB_ERR_INVALID_UTF16_STRING,
770 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
776 WIMLIB_ERR_NOT_A_WIM_FILE,
777 WIMLIB_ERR_NO_FILENAME,
785 WIMLIB_ERR_RESOURCE_ORDER,
786 WIMLIB_ERR_SPECIAL_FILE,
787 WIMLIB_ERR_SPLIT_INVALID,
788 WIMLIB_ERR_SPLIT_UNSUPPORTED,
791 WIMLIB_ERR_UNKNOWN_VERSION,
792 WIMLIB_ERR_UNSUPPORTED,
795 WIMLIB_ERR_INVALID_OVERLAY,
799 /** Used to indicate that no WIM image or an invalid WIM image. */
800 #define WIMLIB_NO_IMAGE 0
802 /** Used to specify all images in the WIM. */
803 #define WIMLIB_ALL_IMAGES (-1)
806 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
808 * The directory tree of NTFS volume is read immediately for the purpose of
809 * constructing a directory entry tree in-memory. Also, all files are read to
810 * calculate their SHA1 message digests. However, because the directory tree
811 * may contain a very large amount of data, the files themselves are not read
812 * into memory permanently, and instead references to their paths saved. The
813 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
816 * See the manual page for the @c imagex program for more information about the
817 * "normal" capture mode versus the NTFS capture mode (entered by providing the
818 * flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
820 * Note that @b no changes are committed to the underlying WIM file (if
821 * any) until wimlib_write() or wimlib_overwrite() is called.
824 * Pointer to the ::WIMStruct for a WIM file to which the image will be
827 * A path to a directory or unmounted NTFS volume that will be captured as
830 * The name to give the image. This must be non-@c NULL.
832 * Pointer to the contents of an image capture configuration file. If @c
833 * NULL, a default string is used. Please see the manual page for
834 * <b>imagex capture</b> for more information.
836 * Length of the string @a config in bytes, not including an optional
837 * null-terminator. Ignored if @a config is @c NULL.
838 * @param add_image_flags
839 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
840 * @param progress_func
841 * If non-NULL, a function that will be called periodically with the
842 * progress of the current operation.
844 * @return 0 on success; nonzero on error. On error, changes to @a wim are
845 * discarded so that it appears to be in the same state as when this function
848 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
849 * There is already an image named @a name in @a wim.
850 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
851 * @a config was not @c NULL and did not specify a valid image capture
853 * @retval ::WIMLIB_ERR_INVALID_PARAM
854 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
855 * @retval ::WIMLIB_ERR_NOMEM
856 * Failed to allocate needed memory.
857 * @retval ::WIMLIB_ERR_NOTDIR
858 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
859 * not specified in @a add_image_flags).
860 * @retval ::WIMLIB_ERR_NTFS_3G
861 * An error was returned from a libntfs-3g function when the NTFS volume
862 * was being opened, scanned, or closed (only if
863 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
864 * @retval ::WIMLIB_ERR_OPEN
865 * Failed to open a file or directory in the directory tree rooted at @a
866 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
868 * @retval ::WIMLIB_ERR_READ
869 * Failed to read a file in the directory tree rooted at @a source (only if
870 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
871 * @retval ::WIMLIB_ERR_SPECIAL_FILE
872 * The directory tree rooted at @a source contains a special file that is
873 * not a directory, regular file, or symbolic link. This currently can
874 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
875 * add_image_flags, but it may be returned for unsupported NTFS files in
877 * @retval ::WIMLIB_ERR_STAT
878 * Failed obtain the metadata for a file or directory in the directory tree
879 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
880 * specified in @a add_image_flags).
881 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
882 * @a wim is part of a split WIM. Adding an image to a split WIM is
884 * @retval ::WIMLIB_ERR_UNSUPPORTED
885 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
886 * wimlib was configured with the @c --without-ntfs-3g flag.
888 extern int wimlib_add_image(WIMStruct *wim, const char *source,
889 const char *name, const char *config,
890 size_t config_len, int add_image_flags,
891 wimlib_progress_func_t progress_func);
893 /** This function is equivalent to wimlib_add_image() except it allows for
894 * multiple sources to be combined into a single WIM image. This is done by
895 * specifying the @a sources and @a num_sources parameters instead of the @a
896 * source parameter of wimlib_add_image(). The rest of the parameters are the
897 * same as wimlib_add_image(). See the documentation for <b>imagex capture</b>
898 * for full details on how this mode works.
900 * Additional note: @a sources is not a @c const parameter and you cannot
901 * assume that its contents are valid after this function returns. You must
902 * save pointers to the strings in these structures if you need to free them
903 * later, and/or save copies if needed.
905 * In addition to the error codes that wimlib_add_image() can return,
906 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
907 * when trying to overlay a non-directory on a directory or when otherwise
908 * trying to overlay multiple conflicting files to the same location in the WIM
909 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
910 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
911 * was not exactly one capture source with the target being the root directory.
912 * (In this respect, there is no advantage to using
913 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
915 extern int wimlib_add_image_multisource(WIMStruct *w,
916 struct wimlib_capture_source *sources,
919 const char *config_str,
922 wimlib_progress_func_t progress_func);
925 * Creates a ::WIMStruct for a new WIM file.
927 * This only creates an in-memory structure for a WIM that initially contains no
928 * images. No on-disk file is created until wimlib_write() is called.
931 * The type of compression to be used in the new WIM file. Must be
932 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
933 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
935 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
936 * written to the memory location pointed to by this paramater. The
937 * ::WIMStruct must be freed using using wimlib_free() when finished with
939 * @return 0 on success; nonzero on error.
940 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
941 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
942 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
943 * @retval ::WIMLIB_ERR_NOMEM
944 * Failed to allocate needed memory.
946 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
949 * Deletes an image, or all images, from a WIM file.
951 * All streams referenced by the image(s) being deleted are removed from the
952 * lookup table of the WIM if they are not referenced by any other images in the
955 * Please note that @b no changes are committed to the underlying WIM file (if
956 * any) until wimlib_write() or wimlib_overwrite() is called.
959 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
962 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
964 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
965 * to be left unmodified only if @a image specified a single image. If instead
966 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
967 * possible for some but not all of the images to have been deleted when a
968 * failure status is returned.
970 * @retval ::WIMLIB_ERR_DECOMPRESSION
971 * Could not decompress the metadata resource for @a image.
972 * @retval ::WIMLIB_ERR_INVALID_DENTRY
973 * A directory entry in the metadata resource for @a image in the WIM is
975 * @retval ::WIMLIB_ERR_INVALID_IMAGE
976 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
977 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
978 * The metadata resource for @a image in the WIM is invalid.
979 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
980 * The security data for @a image in the WIM is invalid.
981 * @retval ::WIMLIB_ERR_NOMEM
982 * Failed to allocate needed memory.
983 * @retval ::WIMLIB_ERR_READ
984 * Could not read the metadata resource for @a image from the WIM.
985 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
986 * @a wim is part of a split WIM. Deleting an image from a split WIM is
989 extern int wimlib_delete_image(WIMStruct *wim, int image);
992 * Exports an image, or all the images, from a WIM file, into another WIM file.
994 * The destination image is made to share the same dentry tree and security data
995 * structure as the source image. This places some restrictions on additional
996 * functions that may be called. wimlib_mount_image() may not be called on
997 * either the source image or the destination image without an intervening call
998 * to a function that un-shares the images, such as wimlib_free() on @a
999 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1000 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1001 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1002 * have references back to @a src_wim.
1004 * Previous versions of this function left @a dest_wim in an indeterminate state
1005 * on failure. This is no longer the case; all changes to @a dest_wim made by
1006 * this function are rolled back on failure.
1008 * Previous versions of this function did not allow exporting an image that had
1009 * been added by wimlib_add_image(). This is no longer the case; you may now
1010 * export an image regardless of how it was added.
1012 * Regardless of whether this function succeeds or fails, no changes are made to
1015 * Please note that no changes are committed to the underlying WIM file of @a
1016 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1019 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1020 * WIM that contains the image(s) being exported.
1022 * The image to export from @a src_wim. Can be the number of an image, or
1023 * ::WIMLIB_ALL_IMAGES to export all images.
1025 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1028 * The name to give the exported image in the new WIM file. If left @c
1029 * NULL, the name from @a src_wim is used. This parameter must be left @c
1030 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1031 * than one image; in that case, the names are all taken from the @a
1032 * src_wim. (This is allowed even if one or more images being exported has
1034 * @param dest_description
1035 * The description to give the exported image in the new WIM file. If left
1036 * @c NULL, the description from the @a src_wim is used. This parameter must
1037 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1038 * more than one image; in that case, the descriptions are all taken from
1039 * @a src_wim. (This is allowed even if one or more images being exported
1040 * has no description.)
1041 * @param export_flags
1042 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1043 * bootable, or 0 if which image is marked as bootable in the destination
1044 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1045 * there are multiple images in @a src_wim, specifying
1046 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1047 * currently marked as bootable in @a src_wim; if that is the case, then
1048 * that image is marked as bootable in the destination WIM.
1049 * @param additional_swms
1050 * Array of pointers to the ::WIMStruct for each additional part in the
1051 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1052 * need to be in any particular order, but they must include all parts of
1053 * the split WIM other than the first part, which must be provided in the
1055 * @param num_additional_swms
1056 * Number of additional WIM parts provided in the @a additional_swms array.
1057 * This number should be one less than the total number of parts in the
1058 * split WIM. Set to 0 if the WIM is a standalone WIM.
1059 * @param progress_func
1060 * If non-NULL, a function that will be called periodically with the
1061 * progress of the current operation.
1063 * @return 0 on success; nonzero on error.
1064 * @retval ::WIMLIB_ERR_DECOMPRESSION
1065 * Could not decompress the metadata resource for @a src_image
1067 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1068 * One or more of the names being given to an exported image was already in
1069 * use in the destination WIM.
1070 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1071 * A directory entry in the metadata resource for @a src_image in @a
1072 * src_wim is invalid.
1073 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1074 * @a src_image does not exist in @a src_wim.
1075 * @retval ::WIMLIB_ERR_INVALID_PARAM
1076 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1077 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1078 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1079 * dest_description were non-<code>NULL</code>, @a src_image was
1080 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1081 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1082 * The metadata resource for @a src_image in @a src_wim is invalid.
1083 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1084 * The security data for @a src_image in @a src_wim is invalid.
1085 * @retval ::WIMLIB_ERR_NOMEM
1086 * Failed to allocate needed memory.
1087 * @retval ::WIMLIB_ERR_READ
1088 * Could not read the metadata resource for @a src_image from @a src_wim.
1089 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1090 * The source WIM is a split WIM, but the parts specified do not form a
1091 * complete split WIM because they do not include all the parts of the
1092 * original WIM, there are duplicate parts, or not all the parts have the
1093 * same GUID and compression type.
1094 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1095 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1098 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
1099 WIMStruct *dest_wim, const char *dest_name,
1100 const char *dest_description, int export_flags,
1101 WIMStruct **additional_swms,
1102 unsigned num_additional_swms,
1103 wimlib_progress_func_t progress_func);
1106 * Extracts an image, or all images, from a standalone or split WIM file to a
1107 * directory or a NTFS volume.
1109 * Please see the manual page for the @c imagex program for more information
1110 * about the "normal" extraction mode versus the NTFS extraction mode
1111 * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1113 * Extraction is done with one thread.
1115 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1116 * returned if any resulting SHA1 message digests do not match the values
1117 * provided in the WIM file. Therefore, if this function is successful, you can
1118 * be fairly sure that any compressed data in the WIM was uncompressed
1122 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1125 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1126 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1127 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1129 * Directory to extract the WIM image(s) to (created if it does not already
1130 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1131 * path to the unmounted NTFS volume to extract the image to.
1132 * @param extract_flags
1133 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1135 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1136 * a NTFS volume to extract the image to. The volume will be opened using
1137 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1138 * Otherwise, @a target is interpreted as a directory to extract the
1141 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1142 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1143 * specified. These flags cause extracted files that are identical to be
1144 * hardlinked or symlinked together, depending on the flag. These flags
1145 * override the hard link groups that are specified in the WIM file itself.
1146 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1147 * hardlinked or symlinked across images if a file is found to occur in
1148 * more than one image.
1150 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1151 * name of each file or directory as it is extracted.
1153 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1154 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1155 * each image is considered separately with regards to the sequential
1156 * order. It is also possible for alternate data streams to break the
1157 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1159 * @param additional_swms
1160 * Array of pointers to the ::WIMStruct for each additional part in the
1161 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1162 * need to be in any particular order, but they must include all parts of
1163 * the split WIM other than the first part, which must be provided in the
1165 * @param num_additional_swms
1166 * Number of additional WIM parts provided in the @a additional_swms array.
1167 * This number should be one less than the total number of parts in the
1168 * split WIM. Set to 0 if the WIM is a standalone WIM.
1170 * @param progress_func
1171 * If non-NULL, a function that will be called periodically with the
1172 * progress of the current operation.
1174 * @return 0 on success; nonzero on error.
1175 * @retval ::WIMLIB_ERR_DECOMPRESSION
1176 * Could not decompress a resource (file or metadata) for @a image in @a
1178 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1179 * A directory entry in the metadata resource for @a image in @a wim is
1181 * @retval ::WIMLIB_ERR_INVALID_PARAM
1182 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1183 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1184 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1185 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1186 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1187 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1188 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1189 * specified in @a extract_flag.
1190 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1191 * The SHA1 message digest of an extracted stream did not match the SHA1
1192 * message digest given in the WIM file.
1193 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1194 * A resource (file or metadata) for @a image in @a wim is invalid.
1195 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1196 * The security data for @a image in @a wim is invalid.
1197 * @retval ::WIMLIB_ERR_LINK
1198 * Failed to create a symbolic link or a hard link (only if
1199 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1200 * @retval ::WIMLIB_ERR_MKDIR
1201 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1202 * not specified in @a extract_flags).
1203 * @retval ::WIMLIB_ERR_NOMEM
1204 * Failed to allocate needed memory.
1205 * @retval ::WIMLIB_ERR_NTFS_3G
1206 * An error was returned from a libntfs-3g function while the WIM image was
1207 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1208 * was specified in @a extract_flags).
1209 * @retval ::WIMLIB_ERR_OPEN
1210 * Could not open one of the files being extracted for writing (only if
1211 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1212 * @retval ::WIMLIB_ERR_READ
1213 * A unexpected end-of-file or read error occurred when trying to read data
1214 * from the WIM file associated with @a wim.
1215 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1216 * The WIM is a split WIM, but the parts specified do not form a complete
1217 * split WIM because they do not include all the parts of the original WIM,
1218 * there are duplicate parts, or not all the parts have the same GUID and
1220 * @retval ::WIMLIB_ERR_UNSUPPORTED
1221 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1222 * was configured with the @c --without-ntfs-3g flag.
1223 * @retval ::WIMLIB_ERR_WRITE
1224 * Failed to write a file being extracted (only if
1225 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1227 extern int wimlib_extract_image(WIMStruct *wim, int image,
1228 const char *target, int extract_flags,
1229 WIMStruct **additional_swms,
1230 unsigned num_additional_swms,
1231 wimlib_progress_func_t progress_func);
1234 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1235 * includes a string of XML that describes the images contained in the WIM.
1236 * This function works on standalone WIMs as well as split WIM parts.
1239 * Pointer to the ::WIMStruct for a WIM file.
1241 * @c stdout, or a FILE* opened for writing, to extract the data to.
1243 * @return 0 on success; nonzero on error.
1244 * @retval ::WIMLIB_ERR_WRITE
1245 * Failed to completely write the XML data to @a fp.
1246 * @retval ::WIMLIB_ERR_INVALID_PARAM
1247 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1249 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1252 * Frees all memory allocated for a WIMStruct and closes all files associated
1256 * Pointer to the ::WIMStruct for a WIM file.
1258 * @return This function has no return value.
1260 extern void wimlib_free(WIMStruct *wim);
1263 * Returns the index of the bootable image of the WIM.
1266 * Pointer to the ::WIMStruct for a WIM file.
1269 * 0 if no image is marked as bootable, or the number of the image marked
1270 * as bootable (numbered starting at 1).
1272 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1275 * Returns the compression type used in the WIM.
1278 * Pointer to the ::WIMStruct for a WIM file
1281 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1282 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1284 extern int wimlib_get_compression_type(const WIMStruct *wim);
1287 * Converts a ::wimlib_compression_type value into a string.
1290 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1291 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1294 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1297 extern const char *wimlib_get_compression_type_string(int ctype);
1300 * Converts an error code into a string describing it.
1303 * The error code returned by one of wimlib's functions.
1306 * Pointer to a statically allocated string describing the error code,
1307 * or @c NULL if the error code is not valid.
1309 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1312 * Returns the description of the specified image.
1315 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1316 * standalone WIM or a split WIM part.
1318 * The number of the image, numbered starting at 1.
1321 * The description of the image, or @c NULL if there is no such image, or
1322 * @c NULL if the specified image has no description. The description
1323 * string is in library-internal memory and may not be modified or freed;
1324 * in addition, the string will become invalid if the description of the
1325 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1327 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1330 * Returns the name of the specified image.
1333 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1334 * standalone WIM or a split WIM part.
1336 * The number of the image, numbered starting at 1.
1339 * The name of the image, or @c NULL if there is no such image. The name
1340 * string is in library-internal memory and may not be modified or freed;
1341 * in addition, the string will become invalid if the name of the image is
1342 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1344 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1345 * the WIM to be unnamed, in which case an empty string will be returned
1346 * when the corresponding name is requested.
1348 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1352 * Returns the number of images contained in a WIM.
1355 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1356 * standalone WIM or a split WIM part.
1359 * The number of images contained in the WIM file.
1361 extern int wimlib_get_num_images(const WIMStruct *wim);
1364 * Returns the part number of a WIM in a split WIM and the total number of parts
1368 * Pointer to the ::WIMStruct for a WIM file.
1369 * @param total_parts_ret
1370 * If non-@c NULL, the total number of parts in the split WIM (1 for
1371 * non-split WIMs) is written to this location.
1374 * The part number of the WIM (1 for non-split WIMs)
1376 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1379 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1380 * re-entrant. If you are calling wimlib functions concurrently in different
1381 * threads, then you must call this function serially first. Otherwise, calling
1382 * this function is not required.
1384 * @return 0 on success; nonzero on error.
1385 * @retval ::WIMLIB_ERR_NOMEM
1386 * Could not allocate memory.
1387 * @retval ::WIMLIB_ERR_ICONV_NOT_AVAILABLE
1388 * wimlib was configured @c --without-libntfs-3g at compilation time, and
1389 * at runtime the @c iconv() set of functions did not seem to be available,
1390 * perhaps due to missing files in the C library installation.
1392 * If this function is not called or returns nonzero, then it will not be safe
1393 * to use wimlib in multiple threads. Furthermore, a nonzero return value here
1394 * indicates that further calls into wimlib will probably fail when they try to
1395 * repeat the same initializations.
1397 extern int wimlib_global_init();
1400 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1401 * You are not required to call this function, but it will release any global
1402 * memory allocated by the library.
1404 extern void wimlib_global_cleanup();
1407 * Returns true if the WIM has an integrity table.
1410 * Pointer to the ::WIMStruct for a WIM file.
1412 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1413 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1414 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1415 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1417 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1421 * Determines if an image name is already used by some image in the WIM.
1424 * Pointer to the ::WIMStruct for a WIM file.
1426 * The name to check.
1429 * @c true if there is already an image in @a wim named @a name; @c false
1430 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1431 * the empty string, @c false is returned.
1433 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1436 * Joins a split WIM into a stand-alone one-part WIM.
1439 * An array of strings that gives the filenames of all parts of the split
1440 * WIM. No specific order is required, but all parts must be included with
1443 * Number of filenames in @a swms.
1444 * @param swm_open_flags
1445 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1446 * part should be verified, if integrity tables are present. Otherwise,
1448 * @param wim_write_flags
1449 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1450 * @param output_path
1451 * The path to write the one-part WIM to.
1452 * @param progress_func
1453 * If non-NULL, a function that will be called periodically with the
1454 * progress of the current operation.
1456 * @return 0 on success; nonzero on error. This function may return any value
1457 * returned by wimlib_open_wim() and wimlib_write() except
1458 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1460 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1461 * The split WIMs do not form a valid WIM because they do not include all
1462 * the parts of the original WIM, there are duplicate parts, or not all the
1463 * parts have the same GUID and compression type.
1465 * Note: the WIM's uncompressed and compressed resources are not checksummed
1466 * when they are copied from the split WIM parts to the joined WIM, nor are
1467 * compressed resources re-compressed.
1469 * Note: wimlib_export_image() can provide similar functionality to
1470 * wimlib_join(), since it is possible to export all images from a split WIM.
1472 extern int wimlib_join(const char * const *swms, unsigned num_swms,
1473 const char *output_path, int swm_open_flags,
1474 int wim_write_flags,
1475 wimlib_progress_func_t progress_func);
1478 * Mounts an image in a WIM file on a directory read-only or read-write.
1480 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1481 * process shall be daemonized.
1483 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1484 * modifications to the WIM are staged in a temporary directory.
1486 * It is safe to mount multiple images from the same WIM file read-only at the
1487 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1488 * to mount multiple images from the same WIM file read-write at the same time.
1490 * wimlib_mount_image() cannot be used on an image that was exported with
1491 * wimlib_export_image() while the dentry trees for both images are still in
1492 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1493 * that has just been added with wimlib_add_image(), unless the WIM has been
1494 * written and read into a new ::WIMStruct.
1497 * Pointer to the ::WIMStruct containing the image to be mounted.
1499 * The number of the image to mount, indexed starting from it. It must be
1500 * an existing, single image.
1502 * The path to an existing empty directory to mount the image on.
1503 * @param mount_flags
1504 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1506 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1507 * rather than the default of read-only.
1509 * WIMs may contain named (alternate) data streams, which are a somewhat
1510 * obscure NTFS feature. They can be read and written on a mounted WIM
1511 * through one of several interfaces. The interface to use if specified by
1512 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1513 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1514 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1515 * the XATTR interface.
1516 * @param additional_swms
1517 * Array of pointers to the ::WIMStruct for each additional part in the
1518 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1519 * need to be in any particular order, but they must include all parts of
1520 * the split WIM other than the first part, which must be provided in the
1522 * @param num_additional_swms
1523 * Number of additional WIM parts provided in the @a additional_swms array.
1524 * This number should be one less than the total number of parts in the
1525 * split WIM. Set to 0 if the WIM is a standalone WIM.
1526 * @param staging_dir
1527 * If non-NULL, the name of a directory in which the staging directory will
1528 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1529 * in @a mount_flags. If left @c NULL, the staging directory is created in
1530 * the same directory as the WIM file that @a wim was originally read from.
1532 * @return 0 on success; nonzero on error.
1534 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1535 * A read-write mount was requested, but an an exclusive advisory lock on
1536 * the on-disk WIM file could not be acquired because another thread or
1537 * process has mounted an image from the WIM read-write or is currently
1538 * modifying the WIM in-place.
1539 * @retval ::WIMLIB_ERR_DECOMPRESSION
1540 * Could not decompress the metadata resource for @a image in @a wim.
1541 * @retval ::WIMLIB_ERR_FUSE
1542 * A non-zero status was returned by @c fuse_main().
1543 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1544 * A directory entry in the metadata resource for @a image in @a wim is
1546 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1547 * @a image does not specify an existing, single image in @a wim.
1548 * @retval ::WIMLIB_ERR_INVALID_PARAM
1549 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1550 * wimlib_export_image(), or @a image has been added with
1551 * wimlib_add_image().
1552 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1553 * The metadata resource for @a image in @a wim is invalid.
1554 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1555 * The security data for @a image in @a wim is invalid.
1556 * @retval ::WIMLIB_ERR_MKDIR
1557 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1558 * staging directory could not be created.
1559 * @retval ::WIMLIB_ERR_NOMEM
1560 * Failed to allocate needed memory.
1561 * @retval ::WIMLIB_ERR_NOTDIR
1562 * Could not determine the current working directory.
1563 * @retval ::WIMLIB_ERR_READ
1564 * An unexpected end-of-file or read error occurred when trying to read
1565 * data from the WIM file associated with @a wim.
1566 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1567 * The WIM is a split WIM, but the parts specified do not form a complete
1568 * split WIM because they do not include all the parts of the original WIM,
1569 * there are duplicate parts, or not all the parts have the same GUID and
1571 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1572 * The WIM is a split WIM and a read-write mount was requested. We only
1573 * support mounting a split WIM read-only.
1575 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1576 int mount_flags, WIMStruct **additional_swms,
1577 unsigned num_additional_swms,
1578 const char *staging_dir);
1581 * Opens a WIM file and creates a ::WIMStruct for it.
1584 * The path to the WIM file to open.
1586 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1587 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1589 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1590 * the WIM, if it exists, is checked, and this function will fail with an
1591 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1592 * digests of the WIM do not exactly match the corresponding message
1593 * digests given in the integrity table.
1595 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1596 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1597 * returned. (This flag may be removed in the future, in which case no
1598 * error will be issued when opening a split WIM.)
1600 * @param progress_func
1601 * If non-NULL, a function that will be called periodically with the
1602 * progress of the current operation.
1605 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1606 * is written to the memory location pointed to by this parameter. The
1607 * ::WIMStruct must be freed using using wimlib_free() when finished with
1610 * @return 0 on success; nonzero on error.
1611 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1612 * The lookup table of @a wim_file is compressed. Support for this can be
1613 * added to wimlib if needed, but it appears to be the case that the lookup
1614 * table is never compressed.
1615 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1616 * The WIM is not the non-first part of a split WIM, and the number of
1617 * metadata resources found in the WIM did not match the image count given
1618 * in the WIM header, or the number of <IMAGE> elements in the XML
1619 * data for the WIM did not match the image count given in the WIM header.
1620 * @retval ::WIMLIB_ERR_INTEGRITY
1621 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1622 * wim_file contains an integrity table, but the SHA1 message digest for a
1623 * chunk of the WIM does not match the corresponding message digest given
1624 * in the integrity table.
1625 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1626 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1627 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1628 * The header of @a wim_file says that resources in the WIM are compressed,
1629 * but the header flag indicating LZX or XPRESS compression is not set.
1630 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1631 * The length field of the WIM header is not 208.
1632 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1633 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1634 * wim_file contains an integrity table, but the integrity table is
1636 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1637 * The lookup table for the WIM contained duplicate entries that are not
1638 * for metadata resources, or it contained an entry with a SHA1 message
1639 * digest of all 0's.
1640 * @retval ::WIMLIB_ERR_NOMEM
1641 * Failed to allocated needed memory.
1642 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1643 * @a wim_file does not begin with the expected magic characters.
1644 * @retval ::WIMLIB_ERR_OPEN
1645 * Failed to open the file @a wim_file for reading.
1646 * @retval ::WIMLIB_ERR_READ
1647 * An unexpected end-of-file or read error occurred when trying to read
1648 * data from @a wim_file.
1649 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1650 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1651 * specified in @a open_flags.
1652 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1653 * A number other than 0x10d00 is written in the version field of the WIM
1654 * header of @a wim_file. (Probably a pre-Vista WIM).
1655 * @retval ::WIMLIB_ERR_XML
1656 * The XML data for @a wim_file is invalid.
1658 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1659 WIMStruct **wim_ret,
1660 wimlib_progress_func_t progress_func);
1663 * Overwrites the file that the WIM was originally read from, with changes made.
1664 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1665 * rather than wimlib_create_new_wim().
1667 * There are two ways that a WIM may be overwritten. The first is to do a full
1668 * rebuild. In this mode, the new WIM is written to a temporary file and then
1669 * renamed to the original file after it is has been completely written. The
1670 * temporary file is made in the same directory as the original WIM file. A
1671 * full rebuild may take a while, but can be used even if images have been
1672 * modified or deleted, will produce a WIM with no holes, and has little chance
1673 * of unintentional data loss because the temporary WIM is fsync()ed before
1674 * being renamed to the original WIM.
1676 * The second way to overwrite a WIM is by appending to the end of it and
1677 * overwriting the header. This can be much faster than a full rebuild, but it
1678 * only works if the only operations on the WIM have been to change the header
1679 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1680 * with writing any new file resources *after* everything in the old WIM, even
1681 * though this will leave a hole where the old lookup table, XML data, and
1682 * integrity were. This is done so that the WIM remains valid even if the
1683 * operation is aborted mid-write. The WIM header is only overwritten at the
1684 * very last moment, and up until that point the WIM will be seen as the old
1687 * By default, the overwrite mode is determine automatically based on the past
1688 * operations performed on the ::WIMStruct. Use the flag
1689 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1690 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1691 * images have been deleted from the WIM.
1693 * In the temporary-file overwrite mode, no changes are made to the WIM on
1694 * failure, and the temporary file is deleted if possible. Abnormal termination
1695 * of the program will result in the temporary file being orphaned. In the
1696 * direct append mode, the WIM is truncated to the original length on failure;
1697 * and while abnormal termination of the program will result in extra data
1698 * appended to the original WIM, it should still be a valid WIM.
1701 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1702 * been in-memory changes made to it, which are then reflected in the
1704 * @param write_flags
1705 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1706 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1707 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1708 * @param num_threads
1709 * Number of threads to use for compression (see wimlib_write()).
1710 * @param progress_func
1711 * If non-NULL, a function that will be called periodically with the
1712 * progress of the current operation.
1714 * @return 0 on success; nonzero on error. This function may return any value
1715 * returned by wimlib_write() as well as the following error codes:
1716 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1717 * The WIM was going to be modifien in-place (with no temporary file), but
1718 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1719 * because another thread or process has mounted an image from the WIM
1720 * read-write or is currently modifying the WIM in-place.
1721 * @retval ::WIMLIB_ERR_NO_FILENAME
1722 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1723 * than a WIM read with wimlib_open_wim().
1724 * @retval ::WIMLIB_ERR_RENAME
1725 * The temporary file that the WIM was written to could not be renamed to
1726 * the original filename of @a wim.
1727 * @retval ::WIMLIB_ERR_REOPEN
1728 * The WIM was overwritten successfully, but it could not be re-opened
1729 * read-only. Therefore, the resources in the WIM can no longer be
1730 * accessed, so this limits the functions that can be called on @a wim
1731 * before calling wimlib_free().
1733 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1734 unsigned num_threads,
1735 wimlib_progress_func_t progress_func);
1738 * Prints information about one image, or all images, contained in a WIM.
1741 * Pointer to the ::WIMStruct for a WIM file.
1743 * The image about which to print information. Can be the number of an
1744 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1747 * @return This function has no return value. No error checking is done when
1748 * printing the information. If @a image is invalid, an error message is
1751 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1754 * Prints the full paths to all files contained in an image, or all images, in a
1758 * Pointer to the ::WIMStruct for a WIM file.
1760 * Which image to print files for. Can be the number of an image, or
1761 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1763 * @return 0 on success; nonzero on error.
1764 * @retval ::WIMLIB_ERR_DECOMPRESSION
1765 * The metadata resource for one of the specified images could not be
1767 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1768 * A directory entry in the metadata resource for one of the specified
1769 * images is invaled.
1770 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1771 * @a image does not specify a valid image in @a wim, and is not
1772 * ::WIMLIB_ALL_IMAGES.
1773 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1774 * The metadata resource for one of the specified images is invalid.
1775 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1776 * The security data for one of the specified images is invalid.
1777 * @retval ::WIMLIB_ERR_NOMEM
1778 * Failed to allocate needed memory.
1779 * @retval ::WIMLIB_ERR_READ
1780 * An unexpected read error or end-of-file occurred when reading the
1781 * metadata resource for one of the specified images.
1782 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1783 * @a wim was not a standalone WIM and was not the first part of a split
1786 extern int wimlib_print_files(WIMStruct *wim, int image);
1789 * Prints detailed information from the header of a WIM file.
1792 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1793 * standalone WIM or part of a split WIM.
1795 * @return This function has no return value.
1798 extern void wimlib_print_header(const WIMStruct *wim);
1801 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1802 * digests, as found in the directory entry tree in the WIM file, to file
1803 * resources in the WIM file. This table includes one entry for each unique
1804 * file in the WIM, so it can be quite long. There is only one lookup table per
1805 * WIM file, but each split WIM part has its own lookup table.
1808 * Pointer to the ::WIMStruct for a WIM file.
1810 * @return This function has no return value.
1812 extern void wimlib_print_lookup_table(WIMStruct *wim);
1815 * Prints the metadata of the specified image in a WIM file. The metadata
1816 * consists of the security data as well as the directory entry tree. Each
1817 * image has its own metadata.
1820 * Pointer to the ::WIMStruct for a WIM file.
1822 * Which image to print the metadata for. Can be the number of an image,
1823 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1825 * @return 0 on success; nonzero on error.
1826 * @retval ::WIMLIB_ERR_DECOMPRESSION
1827 * The metadata resource for one of the specified images could not be
1829 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1830 * A directory entry in the metadata resource for one of the specified
1831 * images is invaled.
1832 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1833 * @a image does not specify a valid image in @a wim, and is not
1834 * ::WIMLIB_ALL_IMAGES.
1835 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1836 * The metadata resource for one of the specified images is invalid.
1837 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1838 * The security data for one of the specified images is invalid.
1839 * @retval ::WIMLIB_ERR_NOMEM
1840 * Failed to allocate needed memory.
1841 * @retval ::WIMLIB_ERR_READ
1842 * An unexpected read error or end-of-file occurred when reading the
1843 * metadata resource for one of the specified images.
1844 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1845 * @a wim was not a standalone WIM and was not the first part of a split
1848 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1851 * Prints some basic information about a WIM file. All information printed by
1852 * this function is also printed by wimlib_print_header(), but
1853 * wimlib_print_wim_information() prints some of this information more concisely
1854 * and in a more readable form.
1857 * Pointer to the ::WIMStruct for a WIM file.
1859 * @return This function has no return value.
1861 extern void wimlib_print_wim_information(const WIMStruct *wim);
1864 * Translates a string specifying the name or number of an image in the WIM into
1865 * the number of the image. The images are numbered starting at 1.
1868 * Pointer to the ::WIMStruct for a WIM file.
1869 * @param image_name_or_num
1870 * A string specifying the name or number of an image in the WIM. If it
1871 * parses to a positive integer, this integer is taken to specify the
1872 * number of the image, indexed starting at 1. Otherwise, it is taken to
1873 * be the name of an image, as given in the XML data for the WIM file. It
1874 * also may be the keyword "all" or the string "*", both of which will
1875 * resolve to ::WIMLIB_ALL_IMAGES.
1877 * There is no way to search for an image actually named "all", "*", or an
1878 * integer number, or an image that has no name. However, you can use
1879 * wimlib_get_image_name() to get the name of any image.
1882 * If the string resolved to a single existing image, the number of that
1883 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
1884 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
1885 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
1886 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1887 * images in @a wim has no name.
1889 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1892 * Sets which image in the WIM is marked as bootable.
1895 * Pointer to the ::WIMStruct for a WIM file.
1897 * The number of the image to mark as bootable, or 0 to mark no image as
1899 * @return 0 on success; nonzero on error.
1900 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1901 * @a boot_idx does not specify an existing image in @a wim, and it was not
1903 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1904 * @a wim is part of a split WIM. We do not support changing the boot
1905 * index of a split WIM.
1907 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1910 * Changes the description of an image in the WIM.
1913 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1914 * standalone WIM or part of a split WIM; however, you should set the same
1915 * description on all parts of a split WIM.
1917 * The number of the image for which to change the description.
1918 * @param description
1919 * The new description to give the image. It may be @c NULL, which
1920 * indicates that the image is to be given no description.
1922 * @return 0 on success; nonzero on error.
1923 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1924 * @a image does not specify a single existing image in @a wim.
1925 * @retval ::WIMLIB_ERR_NOMEM
1926 * Failed to allocate the memory needed to duplicate the @a description
1929 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1930 const char *description);
1933 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1934 * (something like "Core" or "Ultimate")
1937 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1938 * standalone WIM or part of a split WIM; however, you should set the same
1939 * \<FLAGS\> element on all parts of a split WIM.
1941 * The number of the image for which to change the description.
1943 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1944 * indicates that the image is to be given no \<FLAGS\> element.
1946 * @return 0 on success; nonzero on error.
1947 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1948 * @a image does not specify a single existing image in @a wim.
1949 * @retval ::WIMLIB_ERR_NOMEM
1950 * Failed to allocate the memory needed to duplicate the @a flags string.
1952 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1955 * Changes the name of an image in the WIM.
1958 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1959 * standalone WIM or part of a split WIM; however, you should set the same
1960 * name on all parts of a split WIM.
1962 * The number of the image for which to change the name.
1964 * The new name to give the image. It must be a nonempty string.
1966 * @return 0 on success; nonzero on error.
1967 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1968 * There is already an image named @a name in @a wim.
1969 * @retval ::WIMLIB_ERR_INVALID_PARAM
1970 * @a name was @c NULL or the empty string.
1971 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1972 * @a image does not specify a single existing image in @a wim.
1973 * @retval ::WIMLIB_ERR_NOMEM
1974 * Failed to allocate the memory needed to duplicate the @a name string.
1976 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1979 * Set the functions that wimlib uses to allocate and free memory.
1981 * These settings are global and not per-WIM.
1983 * The default is to use the default @c malloc() and @c free() from the C
1986 * Please note that some external functions, such as those in @c libntfs-3g, may
1987 * use the standard memory allocation functions.
1989 * @param malloc_func
1990 * A function equivalent to @c malloc() that wimlib will use to allocate
1991 * memory. If @c NULL, the allocator function is set back to the default
1992 * @c malloc() from the C library.
1994 * A function equivalent to @c free() that wimlib will use to free memory.
1995 * If @c NULL, the free function is set back to the default @c free() from
1997 * @param realloc_func
1998 * A function equivalent to @c realloc() that wimlib will use to reallocate
1999 * memory. If @c NULL, the free function is set back to the default @c
2000 * realloc() from the C library.
2001 * @return 0 on success; nonzero on error.
2002 * @retval ::WIMLIB_ERR_UNSUPPORTED
2003 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2004 * so custom memory allocators are unsupported.
2006 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2007 void (*free_func)(void *),
2008 void *(*realloc_func)(void *, size_t));
2011 * Sets whether wimlib is to print error messages to @c stderr when a function
2012 * fails. These error messages may provide information that cannot be
2013 * determined only from the error code that is returned. Not every error will
2014 * result in an error message being printed.
2016 * This setting is global and not per-WIM.
2018 * By default, error messages are not printed.
2020 * @param show_messages
2021 * @c true if error messages are to be printed; @c false if error messages
2022 * are not to be printed.
2024 * @return 0 on success; nonzero on error.
2025 * @retval ::WIMLIB_ERR_UNSUPPORTED
2026 * @a show_messages was @c true, but wimlib was compiled with the @c
2027 * --without-error-messages option. Therefore, error messages cannot be
2030 extern int wimlib_set_print_errors(bool show_messages);
2033 * Splits a WIM into multiple parts.
2036 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2039 * Name of the SWM file to create. This will be the name of the first
2040 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2041 * appended before the suffix.
2043 * The maximum size per part, in bytes. It is not guaranteed that this
2044 * will really be the maximum size per part, because some file resources in
2045 * the WIM may be larger than this size, and the WIM file format provides
2046 * no way to split up file resources among multiple WIMs.
2047 * @param write_flags
2048 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2049 * included in the split WIM parts.
2050 * @param progress_func
2051 * If non-NULL, a function that will be called periodically with the
2052 * progress of the current operation.
2054 * @return 0 on success; nonzero on error. This function may return any value
2055 * returned by wimlib_write() as well as the following error codes:
2057 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2058 * @a wim is not part 1 of a stand-alone WIM.
2059 * @retval ::WIMLIB_ERR_INVALID_PARAM
2060 * @a swm_name was @c NULL, or @a part_size was 0.
2062 * Note: the WIM's uncompressed and compressed resources are not checksummed
2063 * when they are copied from the joined WIM to the split WIM parts, nor are
2064 * compressed resources re-compressed.
2066 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
2067 size_t part_size, int write_flags,
2068 wimlib_progress_func_t progress_func);
2071 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2073 * The image to unmount is specified by the path to the mountpoint, not the
2074 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2075 * touched and also may have been allocated in a different process.
2077 * To unmount the image, the thread calling this function communicates with the
2078 * thread that is managing the mounted WIM image. This function blocks until it
2079 * is known whether the unmount succeeded or failed. In the case of a
2080 * read-write mounted WIM, the unmount is not considered to have succeeded until
2081 * all changes have been saved to the underlying WIM file.
2084 * The directory that the WIM image was mounted on.
2085 * @param unmount_flags
2086 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2087 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2088 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2090 * @param progress_func
2091 * If non-NULL, a function that will be called periodically with the
2092 * progress of the current operation.
2094 * @return 0 on success; nonzero on error.
2096 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2097 * The filesystem daemon was unable to remove the staging directory and the
2098 * temporary files that it contains.
2099 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2100 * The filesystem daemon appears to have terminated before sending an exit
2102 * @retval ::WIMLIB_ERR_FORK
2103 * Could not @c fork() the process.
2104 * @retval ::WIMLIB_ERR_FUSERMOUNT
2105 * The @b fusermount program could not be executed or exited with a failure
2107 * @retval ::WIMLIB_ERR_MQUEUE
2108 * Could not open a POSIX message queue to communicate with the filesystem
2109 * daemon servicing the mounted filesystem, could not send a message
2110 * through the queue, or could not receive a message through the queue.
2111 * @retval ::WIMLIB_ERR_NOMEM
2112 * Failed to allocate needed memory.
2113 * @retval ::WIMLIB_ERR_OPEN
2114 * The filesystem daemon could not open a temporary file for writing the
2116 * @retval ::WIMLIB_ERR_READ
2117 * A read error occurred when the filesystem daemon tried to a file from
2118 * the staging directory
2119 * @retval ::WIMLIB_ERR_RENAME
2120 * The filesystem daemon failed to rename the newly written WIM file to the
2121 * original WIM file.
2122 * @retval ::WIMLIB_ERR_WRITE
2123 * A write error occurred when the filesystem daemon was writing to the new
2124 * WIM file, or the filesystem daemon was unable to flush changes that had
2125 * been made to files in the staging directory.
2127 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
2128 wimlib_progress_func_t progress_func);
2131 * Writes a standalone WIM to a file.
2133 * This brings in resources from any external locations, such as directory trees
2134 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2135 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2138 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2139 * changes made to it, which are then reflected in the output file.
2141 * The path to the file to write the WIM to.
2143 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2145 * @param write_flags
2146 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2147 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2148 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2149 * @param num_threads
2150 * Number of threads to use for compressing data. If 0, the number of
2151 * threads is taken to be the number of online processors. Note: if no
2152 * data compression needs to be done, no additional threads will be created
2153 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2154 * exporting an image from a compressed WIM to another WIM of the same
2155 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2157 * @param progress_func
2158 * If non-NULL, a function that will be called periodically with the
2159 * progress of the current operation.
2161 * @return 0 on success; nonzero on error.
2162 * @retval ::WIMLIB_ERR_DECOMPRESSION
2163 * Failed to decompress a metadata or file resource in @a wim.
2164 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2165 * A directory entry in the metadata resource for @a image in @a wim is
2167 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2168 * @a image does not specify a single existing image in @a wim, and is not
2169 * ::WIMLIB_ALL_IMAGES.
2170 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2171 * A file that had previously been scanned for inclusion in the WIM by
2172 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2173 * message digest check.
2174 * @retval ::WIMLIB_ERR_INVALID_PARAM
2175 * @a path was @c NULL.
2176 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2177 * The metadata resource for @a image in @a wim is invalid.
2178 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2179 * The security data for @a image in @a wim is invalid.
2180 * @retval ::WIMLIB_ERR_NOMEM
2181 * Failed to allocate needed memory.
2182 * @retval ::WIMLIB_ERR_OPEN
2183 * Failed to open @a path for writing, or some file resources in @a
2184 * wim refer to files in the outside filesystem, and one of these files
2185 * could not be opened for reading.
2186 * @retval ::WIMLIB_ERR_READ
2187 * An error occurred when trying to read data from the WIM file associated
2188 * with @a wim, or some file resources in @a wim refer to files in the
2189 * outside filesystem, and a read error occurred when reading one of these
2191 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2192 * @a wim is part of a split WIM. You may not call this function on a
2194 * @retval ::WIMLIB_ERR_WRITE
2195 * An error occurred when trying to write data to the new WIM file at @a
2198 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2199 int write_flags, unsigned num_threads,
2200 wimlib_progress_func_t progress_func);
2202 #endif /* _WIMLIB_H */