4 * External header for wimlib.
8 * Copyright (C) 2012 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 * \section intro Introduction
30 * wimlib is a C library to read, write, and mount archive files in the Windows
31 * Imaging Format (WIM files). These files are normally created using the @c
32 * imagex.exe utility on Windows, but this library provides a free
33 * implementetion of @c imagex for UNIX-based systems and an API to allow other
34 * programs to read, write, and mount WIM files. wimlib is comparable to
35 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
37 * \section format WIM files
39 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
40 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
41 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
42 * Both are based on LZ77 and Huffman encoding, and both are supported by
45 * Unlike ZIP files, WIM files can contain multiple independent toplevel
46 * directory trees known as @a images. While each image has its own metadata,
47 * files are not duplicated for each image; instead, each file is included only
48 * once in the entire WIM. Microsoft did this so that in one WIM file, they
49 * could do things like have 5 different versions of Windows that are almost
52 * Microsoft provides documentation for the WIM file format, XPRESS compression
53 * format, and LZX compression format. The XPRESS documentation is acceptable,
54 * but the LZX documentation is not entirely correct, and the WIM documentation
55 * itself is very incomplete and is of unacceptable quality.
57 * A WIM file may be either stand-alone or split into multiple parts.
59 * \section winpe Windows PE
61 * A major use for this library is to create customized images of Windows PE, the
62 * Windows Preinstallation Environment, without having to rely on Windows. Windows
63 * PE is a lightweight version of Windows that can run entirely from memory and can
64 * be used to install Windows from local media or a network drive or perform
65 * maintenance. Windows PE is the operating system that runs when you boot from
66 * the Windows installation media.
68 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
69 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
70 * in the Windows Automated Installation Kit (WAIK), which is free to download
71 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
72 * install either the @c cabextract or @c p7zip programs.
74 * In addition, Windows installations and recovery partitions frequently contain a
75 * WIM containing an image of the Windows Recovery Environment, which is similar to
78 * \section ntfs NTFS support
80 * As of version 1.0.0, wimlib supports capturing and applying images directly
81 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
82 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
83 * data such as security descriptors, alternate data streams, and reparse point
86 * The code for NTFS image capture and image application is complete enough that
87 * it is possible to apply an image from the "install.wim" contained in recent
88 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
89 * NTFS volume, and then boot Windows from it after preparing the Boot
90 * Configuration Data. In addition, a Windows installation can be captured (or
91 * backed up) into a WIM file, and then re-applied later.
93 * \section starting Getting Started
95 * wimlib uses the GNU autotools, so it should be easy to install with
96 * <code>configure && make && sudo make install</code>; however, please see the
97 * README for more information about installing it. To use wimlib in a program
98 * after installing it, include @c wimlib.h and link your program with @c -lwim.
100 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
101 * may represent either a stand-alone WIM or one part of a split WIM.
103 * All functions in wimlib's public API are prefixed with @c wimlib. Most
104 * return an integer error code on failure. Use wimlib_get_error_string() to
105 * get a string that describes an error code. wimlib also can print error
106 * messages itself when an error happens, and these may be more informative than
107 * the error code; to enable this, call wimlib_set_print_errors(). Please note
108 * that this is for convenience only, and some errors can occur without a
109 * message being printed.
111 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112 * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
113 * both apply globally.
115 * To open an existing WIM, use wimlib_open_wim().
117 * To create a new WIM that initially contains no images, use
118 * wimlib_create_new_wim().
120 * To add an image to a WIM file from a directory tree on your filesystem, call
121 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
122 * wimlib_open_wim() or from wimlib_create_new_wim(). Alternatively, if you
123 * want to capture a WIM image directly from a NTFS volume while preserving
124 * NTFS-specific data such as security descriptors, call
125 * wimlib_add_image_from_ntfs_volume() instead.
127 * To extract an image from a WIM file, call wimlib_extract_image().
128 * Alternatively, if you want to apply a WIM image directly to a NTFS volume
129 * while setting NTFS-specific data such as security descriptors, call
130 * wimlib_apply_image_to_ntfs_volume().
132 * The NTFS functions will fail if wimlib was compiled with the
133 * <code>--without-ntfs-3g</code> flag.
135 * wimlib supports mounting WIM files either read-only or read-write. Mounting
136 * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
137 * Mounting can be done without root privileges because it is implemented using
138 * FUSE (Filesystem in Userspace). If wimlib is compiled with the
139 * <code>--without-fuse</code> flag, these functions will be available but will
142 * After creating or modifying a WIM file, you can write it to a file using
143 * wimlib_write(). Alternatively, if the WIM was originally read from a file,
144 * you can use wimlib_overwrite() to overwrite the original file.
146 * Please not: merely by calling wimlib_add_image() or many of the other
147 * functions in this library that operate on ::WIMStruct's, you are @b not
148 * modifing the WIM file on disk. Changes are not saved until you explicitly
149 * call wimlib_write() or wimlib_overwrite().
151 * After you are done with the WIM file, use wimlib_free() to free all memory
152 * associated with a ::WIMStruct and close all files associated with it.
154 * To see an example of how to use wimlib, see the file @c programs/imagex.c in
155 * wimlib's source tree.
157 * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
158 * for this. However, if wimlib calls into @c libntfs-3g, the custom memory
159 * allocator may not be used.
161 * \section imagex imagex
163 * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
165 * \section mkwinpeimg mkwinpeimg
167 * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
170 * \section Limitations
172 * While wimlib supports the main features of WIM files, wimlib currently has
173 * the following limitations:
174 * - Different versions of the WIM file format are unsupported. There is one
175 * different version of the format from development versions of Windows Vista,
176 * but I'm not planning to support it.
177 * - Compressed resource chunk sizes other than 32768 are unsupported (except for
178 * uncompressed WIMs, for which the chunk size field is ignored). As far as I
179 * can tell, other chunk sizes are not used in compressed WIMs. Let me know
180 * if you find a WIM file with a different chunk size.
181 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
182 * make certain Windows-specific modifications to a Windows PE image, such as
183 * adding a driver or Windows component. Such a tool could conceivably be
184 * implemented on top of wimlib, although it likely would be hard to implement
185 * because it would have to do very Windows-specific things such as
186 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
187 * script for a similar purpose, however. With regards to adding drivers to
188 * Windows PE, you have the option of putting them anywhere in the Windows PE
189 * image, then loading them after boot using @b drvload.exe.
190 * - There is not yet a way to extract specific files or directories from a WIM
191 * file without mounting it, or to add, remove, or modify files in a WIM
192 * without mounting it, other than by adding or removing an entire image. I
193 * can implement this if requested, but I intend the FUSE mount feature to be
194 * used for this purpose, as it is easy to do these things in whatever way you
195 * want after the image is mounted.
196 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
197 * than wimlib when using maximum (LZX) compression because it knows how to
198 * split up LZX compressed blocks, which is not yet implemented in wimlib.
199 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
200 * imagex.exe if you want to make sure your WIM files are made "correctly".
202 * \section legal License
204 * The wimlib library, as well as the programs and scripts distributed with it
205 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
206 * License version 3 or later.
216 #ifndef _WIMLIB_INTERNAL_H
218 * Opaque structure that represents a WIM file.
220 typedef struct WIMStruct WIMStruct;
224 * Specifies the compression type of a WIM file.
227 enum wim_compression_type {
228 /** An invalid compression type. */
229 WIM_COMPRESSION_TYPE_INVALID = -1,
231 /** The WIM does not include any compressed resources. */
232 WIM_COMPRESSION_TYPE_NONE = 0,
234 /** Compressed resources in the WIM use LZX compression. */
235 WIM_COMPRESSION_TYPE_LZX = 1,
237 /** Compressed resources in the WIM use XPRESS compression. */
238 WIM_COMPRESSION_TYPE_XPRESS = 2,
241 /** Mount the WIM read-write. */
242 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
244 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
245 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
247 /** Do not allow accessing alternate data streams. */
248 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000010
250 /** Access alternate data streams through extended file attributes. This is the
252 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000020
254 /** Access alternate data streams by specifying the file name, a colon, then the
255 * alternate file stream name. */
256 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
258 /** Include an integrity table in the new WIM being written during the unmount.
259 * Ignored for read-only mounts. */
260 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
262 /** Unless this flag is given, changes to a mounted WIM are discarded. Ignored
263 * for read-only mounts. */
264 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
266 /** Include an integrity table in the new WIM file. */
267 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
269 /** Print progress information when writing streams and when writing the
270 * integrity table. */
271 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS 0x00000002
273 /** Print file paths as we write then */
274 #define WIMLIB_WRITE_FLAG_VERBOSE 0x00000004
276 /** Call fsync() when the WIM file is closed */
277 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
279 /** Re-build the entire WIM file rather than appending data to it, if possible.
280 * (Applies to wimlib_overwrite(), not wimlib_write()). */
281 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000010
283 /** Do not copy compressed resources between WIMs if the compression type is the
284 * same. Instead, recompress them. */
285 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000020
287 /** Mark the image being added as the bootable image of the WIM. */
288 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
290 /** Print the name of each file or directory as it is scanned to be included in
292 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
294 /** Follow symlinks; archive and dump the files they point to. */
295 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000004
297 /** Show progress information when scanning a directory tree */
298 #define WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS 0x00000008
300 /** See documentation for wimlib_export_image(). */
301 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
303 /** Verify the integrity of the WIM if an integrity table is present. */
304 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
306 /** Print progress information when verifying integrity table. */
307 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
309 /** If this flag is not given, an error is issued if the WIM is part of a split
311 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
314 /** When identical files are extracted from the WIM, always hard link them
316 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
318 /** When identical files are extracted from the WIM, always symlink them
320 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
322 /** Print the name of each file as it is extracted from the WIM image. */
323 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
326 * Possible values of the error code returned by many functions in wimlib.
328 * See the documentation for each wimlib function to see specifically what error
329 * codes can be returned by a given function, and what they mean.
331 enum wimlib_error_code {
332 WIMLIB_ERR_SUCCESS = 0,
333 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
334 WIMLIB_ERR_DECOMPRESSION,
335 WIMLIB_ERR_DELETE_STAGING_DIR,
338 WIMLIB_ERR_FUSERMOUNT,
339 WIMLIB_ERR_IMAGE_COUNT,
340 WIMLIB_ERR_IMAGE_NAME_COLLISION,
341 WIMLIB_ERR_INTEGRITY,
342 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
343 WIMLIB_ERR_INVALID_CHUNK_SIZE,
344 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
345 WIMLIB_ERR_INVALID_DENTRY,
346 WIMLIB_ERR_INVALID_HEADER_SIZE,
347 WIMLIB_ERR_INVALID_IMAGE,
348 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
349 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
350 WIMLIB_ERR_INVALID_PARAM,
351 WIMLIB_ERR_INVALID_RESOURCE_HASH,
352 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
353 WIMLIB_ERR_INVALID_SECURITY_DATA,
359 WIMLIB_ERR_NOT_A_WIM_FILE,
360 WIMLIB_ERR_NO_FILENAME,
368 WIMLIB_ERR_RESOURCE_ORDER,
369 WIMLIB_ERR_SPECIAL_FILE,
370 WIMLIB_ERR_SPLIT_INVALID,
371 WIMLIB_ERR_SPLIT_UNSUPPORTED,
374 WIMLIB_ERR_UNKNOWN_VERSION,
375 WIMLIB_ERR_UNSUPPORTED,
381 /** Used to indicate that no WIM image is currently selected. */
382 #define WIM_NO_IMAGE 0
384 /** Used to specify all images in the WIM. */
385 #define WIM_ALL_IMAGES (-1)
389 * Adds an image to a WIM file from a directory tree on disk.
391 * The directory tree is read immediately for the purpose of constructing a
392 * directory entry tree in-memory. Also, all files are read to calculate their
393 * SHA1 message digests. However, because the directory tree may contain a very
394 * large amount of data, the files themselves are not read into memory
395 * permanently, and instead references to their paths saved. The files are then
396 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
399 * Pointer to the ::WIMStruct for a WIM file to which the image will be
402 * A path to a directory in the outside filesystem. It will become the
403 * root directory for the WIM image.
405 * The name to give the image. This must be non-@c NULL.
407 * Pointer to the contents of an image capture configuration file. If @c
408 * NULL, a default string is used. Please see the manual page for
409 * <b>imagex capture</b> for more information.
411 * Length of the string @a config in bytes. Ignored if @a config is @c
415 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
416 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
417 * marked as bootable is changed to the one being added. If
418 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
419 * printed as it is scanned or captured. If
420 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
421 * directories pointed to by symbolic links are archived rather than the
422 * symbolic links themselves. If ::WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS is
423 * specified, progress information will be printed (distinct from the
424 * verbose information).
426 * @return 0 on success; nonzero on error. On error, changes to @a wim are
427 * discarded so that it appears to be in the same state as when this function
430 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
431 * There is already an image named @a name in @a w.
432 * @retval ::WIMLIB_ERR_INVALID_PARAM
433 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
434 * @retval ::WIMLIB_ERR_NOMEM
435 * Failed to allocate needed memory.
436 * @retval ::WIMLIB_ERR_NOTDIR
437 * @a dir is not a directory.
438 * @retval ::WIMLIB_ERR_OPEN
439 * Failed to open a file or directory in the directory tree rooted at @a
441 * @retval ::WIMLIB_ERR_READ
442 * Failed to read a file in the directory tree rooted at @a dir.
443 * @retval ::WIMLIB_ERR_SPECIAL_FILE
444 * The directory tree rooted at @dir contains a special file that is not a
445 * directory, regular file, or symbolic link.
446 * @retval ::WIMLIB_ERR_STAT
447 * Failed obtain the metadata for a file or directory in the directory tree
449 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
450 * @a wim is part of a split WIM. Adding an image to a split WIM is
453 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
454 const char *name, const char *config,
455 size_t config_len, int flags);
458 * This function is similar to wimlib_add_image(), except instead of capturing
459 * the WIM image from a directory, it is captured from a NTFS volume specified
460 * by @a device. NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
461 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
462 * the reparse points exactly as they are.
464 extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
471 * This function is similar to wimlib_extract_image(), except that @a image may
472 * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
473 * device containing a NTFS volume to apply the image to. NTFS-3g errors are
474 * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
475 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
476 * apply mode we apply the reparse points and hard links exactly as they are in
479 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
480 const char *device, int flags,
481 WIMStruct **additional_swms,
482 unsigned num_additional_swms);
485 * Creates a WIMStruct for a new WIM file.
488 * The type of compression to be used in the new WIM file. Must be
489 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
490 * ::WIM_COMPRESSION_TYPE_XPRESS.
492 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
493 * written to the memory location pointed to by this paramater. The
494 * ::WIMStruct must be freed using using wimlib_free() when finished with
496 * @return 0 on success; nonzero on error.
497 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
498 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
499 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
500 * @retval ::WIMLIB_ERR_NOMEM
501 * Failed to allocate needed memory.
503 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
506 * Deletes an image, or all images, from a WIM file.
508 * All streams referenced by the image(s) being deleted are removed from the
509 * lookup table of the WIM if they are not referenced by any other images in the
513 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
516 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
518 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
519 * to be left unmodified only if @a image specified a single image. If instead
520 * @a image was ::WIM_ALL_IMAGES and @a wim contained more than one image, it's
521 * possible for some but not all of the images to have been deleted when a
522 * failure status is returned.
524 * @retval ::WIMLIB_ERR_DECOMPRESSION
525 * Could not decompress the metadata resource for @a image.
526 * @retval ::WIMLIB_ERR_INVALID_DENTRY
527 * A directory entry in the metadata resource for @a image in the WIM is
529 * @retval ::WIMLIB_ERR_INVALID_IMAGE
530 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
531 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
532 * The metadata resource for @a image in the WIM is invalid.
533 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
534 * The security data for @a image in the WIM is invalid.
535 * @retval ::WIMLIB_ERR_NOMEM
536 * Failed to allocate needed memory.
537 * @retval ::WIMLIB_ERR_READ
538 * Could not read the metadata resource for @a image from the WIM.
539 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
540 * @a wim is part of a split WIM. Deleting an image from a split WIM is
543 extern int wimlib_delete_image(WIMStruct *wim, int image);
546 * Exports an image, or all the images, from a WIM file, into another WIM file.
548 * The destination image is made to share the same dentry tree and security data
549 * structure as the source image. This places some restrictions on additional
550 * functions that may be called. wimlib_mount() may not be called on either the
551 * source image or the destination image without an intervening call to a
552 * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
553 * wimlib_delete_image() on either the source or destination image.
554 * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
555 * src_wim before any calls to functions such as wimlib_write() on @a dest_wim
556 * because @a dest_wim will have references back to @a src_wim.
558 * Previous versions of this function left @a dest_wim in an indeterminate state
559 * on failure. This is no longer the case; all changes to @a dest_wim made by
560 * this function are rolled back on failure.
562 * Previous versions of this function did not allow exporting an image that had
563 * been added by wimlib_add_image(). This is no longer the case; you may now
564 * export an image regardless of how it was added.
566 * Regardless of whether this function succeeds or fails, no user-visible
567 * changes are made to @a src_wim.
570 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
571 * WIM that contains the image(s) being exported.
573 * The image to export from @a src_wim. Can be the number of an image, or
574 * ::WIM_ALL_IMAGES to export all images.
576 * Pointer to the ::WIMStruct for a WIM file that will receive the images
579 * The name to give the exported image in the new WIM file. If left @c NULL,
580 * the name from @a src_wim is used. This parameter must be left @c NULL
581 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
582 * image; in that case, the names are all taken from the @a src_wim.
583 * @param dest_description
584 * The description to give the exported image in the new WIM file. If left
585 * @c NULL, the description from the @a src_wim is used. This parameter must
586 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
587 * more than one image; in that case, the descriptions are all taken from
590 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
591 * bootable, or 0 if which image is marked as bootable in the destination
592 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
593 * there are multiple images in @a src_wim, specifying
594 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
595 * currently marked as bootable in @a src_wim; if that is the case, then
596 * that image is marked as bootable in the destination WIM.
597 * @param additional_swms
598 * Array of pointers to the ::WIMStruct for each additional part in the
599 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
600 * need to be in any particular order, but they must include all parts of
601 * the split WIM other than the first part, which must be provided in the
603 * @param num_additional_swms
604 * Number of additional WIM parts provided in the @a additional_swms array.
605 * This number should be one less than the total number of parts in the
606 * split WIM. Set to 0 if the WIM is a standalone WIM.
608 * @return 0 on success; nonzero on error.
609 * @retval ::WIMLIB_ERR_DECOMPRESSION
610 * Could not decompress the metadata resource for @a src_image
612 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
613 * One or more of the names being given to an exported image was already in
614 * use in the destination WIM.
615 * @retval ::WIMLIB_ERR_INVALID_DENTRY
616 * A directory entry in the metadata resource for @a src_image in @a
617 * src_wim is invalid.
618 * @retval ::WIMLIB_ERR_INVALID_IMAGE
619 * @a src_image does not exist in @a src_wim.
620 * @retval ::WIMLIB_ERR_INVALID_PARAM
621 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
622 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
623 * @a src_wim are marked as bootable; or @a dest_name and/or @a
624 * dest_description were non-<code>NULL</code>, @a src_image was
625 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
626 * or @a dest_wim was @c NULL.
627 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
628 * The metadata resource for @a src_image in @a src_wim is invalid.
629 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
630 * The security data for @a src_image in @a src_wim is invalid.
631 * @retval ::WIMLIB_ERR_NOMEM
632 * Failed to allocate needed memory.
633 * @retval ::WIMLIB_ERR_READ
634 * Could not read the metadata resource for @a src_image from @a src_wim.
635 * @retval ::WIMLIB_ERR_SPLIT_INVALID
636 * The source WIM is a split WIM, but the parts specified do not form a
637 * complete split WIM because they do not include all the parts of the
638 * original WIM, there are duplicate parts, or not all the parts have the
639 * same GUID and compression type.
640 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
641 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
644 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
645 WIMStruct *dest_wim, const char *dest_name,
646 const char *dest_description, int flags,
647 WIMStruct **additional_swms,
648 unsigned num_additional_swms);
651 * Extracts an image, or all images, from a standalone or split WIM file.
654 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
657 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
658 * to specify that all images are to be extracted.
660 * Directory to extract the WIM image(s) to. It is created if it does not
663 * Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
665 * One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
666 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified. These flags cause
667 * extracted files that are identical to be hardlinked or symlinked
668 * together, depending on the flag. These flags override the hard link
669 * groups that are specified in the WIM file itself. If ::WIM_ALL_IMAGES
670 * is provided as the @a image parameter, files may be hardlinked or
671 * symlinked across images if a file is found to occur in more than one
674 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
675 * informational messages to be printed during the extraction, including
676 * the name of each extracted file or directory.
677 * @param additional_swms
678 * Array of pointers to the ::WIMStruct for each additional part in the
679 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
680 * need to be in any particular order, but they must include all parts of
681 * the split WIM other than the first part, which must be provided in the
683 * @param num_additional_swms
684 * Number of additional WIM parts provided in the @a additional_swms array.
685 * This number should be one less than the total number of parts in the
686 * split WIM. Set to 0 if the WIM is a standalone WIM.
688 * @return 0 on success; nonzero on error.
689 * @retval ::WIMLIB_ERR_DECOMPRESSION
690 * Could not decompress a resource (file or metadata) for @a image in @a
692 * @retval ::WIMLIB_ERR_INVALID_DENTRY
693 * A directory entry in the metadata resource for @a image in @a wim is
695 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
696 * The SHA1 message digest of an extracted stream did not match the SHA1
697 * message digest given in the WIM file.
698 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
699 * A resource (file or metadata) for @a image in @a wim is invalid.
700 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
701 * The security data for @a image in @a wim is invalid.
702 * @retval ::WIMLIB_ERR_LINK
703 * Failed to create a symbolic link or a hard link.
704 * @retval ::WIMLIB_ERR_MKDIR
705 * Failed create a needed directory.
706 * @retval ::WIMLIB_ERR_NOMEM
707 * Failed to allocate needed memory.
708 * @retval ::WIMLIB_ERR_OPEN
709 * Could not open one of the files being extracted for writing.
710 * @retval ::WIMLIB_ERR_READ
711 * A unexpected end-of-file or read error occurred when trying to read data
712 * from the WIM file associated with @a wim.
713 * @retval ::WIMLIB_ERR_SPLIT_INVALID
714 * The WIM is a split WIM, but the parts specified do not form a complete
715 * split WIM because they do not include all the parts of the original WIM,
716 * there are duplicate parts, or not all the parts have the same GUID and
718 * @retval ::WIMLIB_ERR_WRITE
719 * Failed to write a file being extracted.
721 extern int wimlib_extract_image(WIMStruct *wim, int image,
722 const char *output_dir, int flags,
723 WIMStruct **additional_swms,
724 unsigned num_additional_swms);
727 * Extracts the XML data for a WIM file to a file stream. Every WIM file
728 * includes a string of XML that describes the images contained in the WIM.
729 * This function works on standalone WIMs as well as split WIM parts.
732 * Pointer to the ::WIMStruct for a WIM file.
734 * @c stdout, or a FILE* opened for writing, to extract the data to.
736 * @return 0 on success; nonzero on error.
737 * @retval ::WIMLIB_ERR_WRITE
738 * Failed to completely write the XML data to @a fp.
740 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
743 * Frees all memory allocated for a WIMStruct and closes all files associated
747 * Pointer to the ::WIMStruct for a WIM file.
749 * @return This function has no return value.
751 extern void wimlib_free(WIMStruct *wim);
754 * Finds which image in a WIM is bootable.
757 * Pointer to the ::WIMStruct for a WIM file.
760 * 0 if no image is marked as bootable, or the number of the image marked
761 * as bootable (numbered starting at 1).
763 extern int wimlib_get_boot_idx(const WIMStruct *wim);
766 * Gets the compression type used in the WIM.
769 * Pointer to the ::WIMStruct for a WIM file
772 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
773 * ::WIM_COMPRESSION_TYPE_XPRESS.
775 extern int wimlib_get_compression_type(const WIMStruct *wim);
778 * Converts a compression type enumeration value into a string.
781 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
782 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
785 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
788 extern const char *wimlib_get_compression_type_string(int ctype);
791 * Converts an error code into a string describing it.
794 * The error code returned by one of wimlib's functions.
797 * Pointer to a statically allocated string describing the error code,
798 * or @c NULL if the error code is not valid.
800 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
803 * Returns the description of the specified image.
806 * Pointer to the ::WIMStruct for a WIM file. It may be either a
807 * standalone WIM or a split WIM part.
809 * The number of the image, numbered starting at 1.
812 * The description of the image, or @c NULL if there is no such image, or
813 * @c NULL if the specified image has no description. The description
814 * string is in library-internal memory and may not be modified or freed;
815 * in addition, the string will become invalid if the description of the
816 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
818 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
821 * Returns the name of the specified image.
824 * Pointer to the ::WIMStruct for a WIM file. It may be either a
825 * standalone WIM or a split WIM part.
827 * The number of the image, numbered starting at 1.
830 * The name of the image, or @c NULL if there is no such image. The name
831 * string is in library-internal memory and may not be modified or freed;
832 * in addition, the string will become invalid if the name of the image is
833 * changed, the image is deleted, or the ::WIMStruct is destroyed.
835 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
839 * Gets the number of images contained in the WIM.
842 * Pointer to the ::WIMStruct for a WIM file. It may be either a
843 * standalone WIM or a split WIM part.
846 * The number of images contained in the WIM file.
848 extern int wimlib_get_num_images(const WIMStruct *wim);
851 * Gets the part number of part of a split WIM.
854 * Pointer to the ::WIMStruct for a WIM file.
855 * @param total_parts_ret
856 * If non-@c NULL, the total number of parts in the split WIM (1 for
857 * non-split WIMs) is written to this location.
860 * The part number of the WIM (1 for non-split WIMs)
862 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
865 * Returns true if the WIM has an integrity table.
868 * Pointer to the ::WIMStruct for a WIM file.
870 * @c true if the WIM has an integrity table; @c false otherwise.
872 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
876 * Determines if an image name is already used by some image in the WIM.
879 * Pointer to the ::WIMStruct for a WIM file.
884 * @c true if there is already an image in @a wim named @a name; @c false
885 * if there is no image named @a name in @a wim. (If @a name is @c NULL,
886 * @c false is returned.)
888 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
891 * Joins a set of split WIMs into a one-part WIM.
894 * An array of strings that give the filenames of all parts of the split
897 * Number of filenames in @a swms.
899 * The path to write the one-part WIM to.
901 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
902 * tables (if present) when opening them, and include an integrity table in
905 * @return 0 on success; nonzero on error. This function may return any value
906 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
907 * as the following error codes:
909 * @retval ::WIMLIB_ERR_SPLIT_INVALID
910 * The split WIMs do not form a valid WIM because they do not include all
911 * the parts of the original WIM, there are duplicate parts, or not all the
912 * parts have the same GUID and compression type.
913 * @retval ::WIMLIB_ERR_WRITE
914 * An error occurred when trying to write data to the new WIM at @a output_path.
916 * Note that this function merely copies the resources, so it will not check to
917 * see if the resources, including the metadata resources, are valid or not.
919 * Also, after this function is called, the only function that may be called on
920 * the ::WIMStruct's in the @a swms array is wimlib_free().
922 extern int wimlib_join(const char **swms, unsigned num_swms,
923 const char *output_path, int flags);
926 * Mounts an image in a WIM file on a directory read-only or read-write.
928 * A daemon will be forked to service the filesystem.
930 * If the mount is read-write, modifications to the WIM are staged in a staging
933 * wimlib_mount() may be called from multiple threads without intervening calls
934 * to wimlib_unmount(), provided that different ::WIMStruct's are used. (This
935 * was not the case for versions of this library 1.0.3 and earlier.)
937 * wimlib_mount() cannot be used on an image that was exported with
938 * wimlib_export_image() while the dentry trees for both images are still in
939 * memory. In addition, wimlib_mount() may not be used to mount an image that
940 * has just been added with wimlib_add_image() or
941 * wimlib_add_image_from_ntfs_volume(), unless the WIM has been written and read
942 * into a new ::WIMStruct.
945 * Pointer to the ::WIMStruct for the WIM file to be mounted.
947 * The number of the image to mount, numbered from 1. It must be an
948 * existing, single image.
950 * The path to an existing directory to mount the image on.
952 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG. If
953 * ::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
954 * read-only. The interface to the WIM named data streams is specified by
955 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
956 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
957 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
958 * the XATTR interface.
959 * @param additional_swms
960 * Array of pointers to the ::WIMStruct for each additional part in the
961 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
962 * need to be in any particular order, but they must include all parts of
963 * the split WIM other than the first part, which must be provided in the
965 * @param num_additional_swms
966 * Number of additional WIM parts provided in the @a additional_swms array.
967 * This number should be one less than the total number of parts in the
968 * split WIM. Set to 0 if the WIM is a standalone WIM.
970 * @return 0 on success; nonzero on error.
971 * @retval ::WIMLIB_ERR_DECOMPRESSION
972 * Could not decompress the metadata resource for @a image in @a wim.
973 * @retval ::WIMLIB_ERR_FUSE
974 * A non-zero status was returned by @c fuse_main().
975 * @retval ::WIMLIB_ERR_INVALID_DENTRY
976 * A directory entry in the metadata resource for @a image in @a wim is
978 * @retval ::WIMLIB_ERR_INVALID_IMAGE
979 * @a image does not specify an existing, single image in @a wim.
980 * @retval ::WIMLIB_ERR_INVALID_PARAM
981 * @a image is shared among multiple ::WIMStruct's as a result of a call to
982 * wimlib_export_image(), or @a image has been added with
983 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
984 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
985 * The metadata resource for @a image in @a wim is invalid.
986 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
987 * The security data for @a image in @a wim is invalid.
988 * @retval ::WIMLIB_ERR_MKDIR
989 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
990 * directory could not be created.
991 * @retval ::WIMLIB_ERR_NOMEM
992 * Failed to allocate needed memory.
993 * @retval ::WIMLIB_ERR_NOTDIR
994 * Could not determine the current working directory.
995 * @retval ::WIMLIB_ERR_READ
996 * An unexpected end-of-file or read error occurred when trying to read
997 * data from the WIM file associated with @a wim.
998 * @retval ::WIMLIB_ERR_SPLIT_INVALID
999 * The WIM is a split WIM, but the parts specified do not form a complete
1000 * split WIM because they do not include all the parts of the original WIM,
1001 * there are duplicate parts, or not all the parts have the same GUID and
1003 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1004 * The WIM is a split WIM and a read-write mount was requested. We only
1005 * support mounting a split WIM read-only.
1007 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
1008 WIMStruct **additional_swms,
1009 unsigned num_additional_swms);
1012 * Opens a WIM file and creates a ::WIMStruct for it.
1015 * The path to the WIM file to open.
1017 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1018 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1019 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
1020 * of the WIM, if it exists, is checked, and the function will fail with an
1021 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1022 * digests of the WIM do not exactly match the corresponding message
1023 * digests given in the integrity table.
1024 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
1025 * be shown if the integrity of the WIM is checked.
1026 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1027 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1028 * returned. (This flag may be removed in the future, in which case no
1029 * error will be issued when opening a split WIM.)
1032 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1033 * is written to the memory location pointed to by this parameter. The
1034 * ::WIMStruct must be freed using using wimlib_free() when finished with
1037 * @return 0 on success; nonzero on error.
1038 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1039 * The lookup table of @a wim_file is compressed. Support for this can be
1040 * added to wimlib if needed, but it appears to be the case that the lookup
1041 * table is never compressed.
1042 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1043 * The WIM is not the non-first part of a split WIM, and the number of
1044 * metadata resources found in the WIM did not match the image count given
1045 * in the WIM header, or the number of <IMAGE> elements in the XML
1046 * data for the WIM did not match the image count given in the WIM header.
1047 * @retval ::WIMLIB_ERR_INTEGRITY
1048 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1049 * wim_file contains an integrity table, but the SHA1 message digest for a
1050 * chunk of the WIM does not match the corresponding message digest given
1051 * in the integrity table.
1052 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1053 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1054 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1055 * The header of @a wim_file says that resources in the WIM are compressed,
1056 * but the header flag indicating LZX or XPRESS compression is not set.
1057 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1058 * The length field of the WIM header is not 208.
1059 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1060 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1061 * wim_file contains an integrity table, but the integrity table is
1063 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1064 * The lookup table for the WIM contained duplicate entries, or it
1065 * contained an entry with a SHA1 message digest of all 0's.
1066 * @retval ::WIMLIB_ERR_NOMEM
1067 * Failed to allocated needed memory.
1068 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1069 * @a wim_file does not begin with the expected magic characters.
1070 * @retval ::WIMLIB_ERR_OPEN
1071 * Failed to open the file @a wim_file for reading.
1072 * @retval ::WIMLIB_ERR_READ
1073 * An unexpected end-of-file or read error occurred when trying to read
1074 * data from @a wim_file.
1075 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1076 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1077 * givin in @a flags.
1078 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1079 * A number other than 0x10d00 is written in the version field of the WIM
1080 * header of @a wim_file.
1081 * @retval ::WIMLIB_ERR_XML
1082 * The XML data for @a wim_file is invalid.
1084 extern int wimlib_open_wim(const char *wim_file, int flags,
1085 WIMStruct **wim_ret);
1088 * Overwrites the file that the WIM was originally read from, with changes made.
1090 * There are two ways that a WIM may be overwritten. The first is to do a full
1091 * rebuild: the new WIM is written to a temporary file and then renamed to the
1092 * original file after it is has been completely written. The temporary file
1093 * currently is made in the same directory as the original WIM file. A full
1094 * rebuild may take a while, but can be used even if images have been modified
1095 * or deleted, will produce a WIM with no holes, and has little chance of
1096 * unintentional data loss because the temporary WIM is fsync()ed before being
1097 * renamed to the original WIM.
1099 * The second way to overwrite a WIM is by appending to the end of it. This can
1100 * be much faster than a full rebuild, but it only works if the only operations
1101 * on the WIM have been to change the header or XML data, or to add new images.
1102 * Writing a WIM in this mode begins with writing any new file resources *after*
1103 * everything in the old WIM, even though this will leave a hole where the old
1104 * lookup table, XML data, and integrity were. This is done so that the WIM
1105 * remains valid even if the operation is aborted mid-write.
1107 * By default, the overwrite mode is chosen based on the past operations
1108 * performed on the WIM. Use the flag ::WIMLIB_WRITE_FLAG_REBUILD to explicitly
1109 * request a full rebuild.
1111 * In the temporary-file overwrite mode, no changes are made to the WIM on
1112 * failure, and the temporary file is deleted (if possible). Abnormal
1113 * termination of the program will result in the temporary file being orphaned.
1114 * In the direct append mode, the WIM is truncated to the original length on
1115 * failure, while abnormal termination of the program will result in extra data
1116 * appended to the original WIM, but it will still be a valid WIM.
1119 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1120 * been in-memory changes made to it, which are then reflected in the
1122 * @param write_flags
1123 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1124 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1125 * @param num_threads
1126 * Number of threads to use for compression (see wimlib_write()).
1128 * @return 0 on success; nonzero on error. This function may return any value
1129 * returned by wimlib_write() as well as the following error codes:
1130 * @retval ::WIMLIB_ERR_NO_FILENAME
1131 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1132 * than a WIM read with wimlib_open_wim().
1133 * @retval ::WIMLIB_ERR_RENAME
1134 * The temporary file that the WIM was written to could not be renamed to
1135 * the original filename of @a wim.
1136 * @retval ::WIMLIB_ERR_REOPEN
1137 * The WIM was overwritten successfully, but it could not be re-opened
1138 * read-only. Therefore, the resources in the WIM can no longer be
1139 * accessed, so this limits the functions that can be called on @a wim
1140 * before calling wimlib_free().
1142 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1143 unsigned num_threads);
1146 * This function is deprecated; call wimlib_overwrite() without the
1147 * WIMLIB_WRITE_FLAG_REBUILD flag instead.
1149 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags);
1152 * Prints information about one image, or all images, contained in a WIM.
1155 * Pointer to the ::WIMStruct for a WIM file.
1157 * The image about which to print information. Can be the number of an
1158 * image, or ::WIM_ALL_IMAGES to print information about all images in the
1161 * @return This function has no return value. No error checking is done when
1162 * printing the information. If @a image is invalid, an error message is
1165 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1168 * Prints the full paths to all files contained in an image, or all images, in a
1172 * Pointer to the ::WIMStruct for a WIM file.
1174 * Which image to print files for. Can be the number of an image, or
1175 * ::WIM_ALL_IMAGES to print the files contained in all images.
1177 * @return 0 on success; nonzero on error.
1178 * @retval ::WIMLIB_ERR_DECOMPRESSION
1179 * The metadata resource for one of the specified images could not be
1181 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1182 * A directory entry in the metadata resource for one of the specified
1183 * images is invaled.
1184 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1185 * @a image does not specify a valid image in @a wim, and is not
1187 * @retval ::WIMLIB_ERR_INVALID_PARAM
1188 * @a wim was @c NULL.
1189 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1190 * The metadata resource for one of the specified images is invalid.
1191 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1192 * The security data for one of the specified images is invalid.
1193 * @retval ::WIMLIB_ERR_NOMEM
1194 * Failed to allocate needed memory.
1195 * @retval ::WIMLIB_ERR_READ
1196 * An unexpected read error or end-of-file occurred when reading the
1197 * metadata resource for one of the specified images.
1198 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1199 * @a wim was not a standalone WIM and was not the first part of a split
1202 extern int wimlib_print_files(WIMStruct *wim, int image);
1205 * Prints detailed information from the header of a WIM file.
1208 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1209 * standalone WIM or part of a split WIM.
1211 * @return This function has no return value.
1214 extern void wimlib_print_header(const WIMStruct *wim);
1217 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1218 * digests, as found in the directory entry tree in the WIM file, to file
1219 * resources in the WIM file. This table includes one entry for each unique
1220 * file in the WIM, so it can be quite long. There is only one lookup table per
1224 * Pointer to the ::WIMStruct for a WIM file.
1226 * @return This function has no return value.
1228 extern void wimlib_print_lookup_table(WIMStruct *wim);
1231 * Prints the metadata of the specified image in a WIM file. The metadata
1232 * consists of the security data as well as the directory entry tree, and each
1233 * image has its own metadata.
1236 * Pointer to the ::WIMStruct for a WIM file.
1238 * Which image to print the metadata for. Can be the number of an image,
1239 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1241 * @return 0 on success; nonzero on error.
1242 * @retval ::WIMLIB_ERR_DECOMPRESSION
1243 * The metadata resource for one of the specified images could not be
1245 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1246 * A directory entry in the metadata resource for one of the specified
1247 * images is invaled.
1248 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1249 * @a image does not specify a valid image in @a wim, and is not
1251 * @retval ::WIMLIB_ERR_INVALID_PARAM
1252 * @a wim was @c NULL.
1253 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1254 * The metadata resource for one of the specified images is invalid.
1255 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1256 * The security data for one of the specified images is invalid.
1257 * @retval ::WIMLIB_ERR_NOMEM
1258 * Failed to allocate needed memory.
1259 * @retval ::WIMLIB_ERR_READ
1260 * An unexpected read error or end-of-file occurred when reading the
1261 * metadata resource for one of the specified images.
1262 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1263 * @a wim was not a standalone WIM and was not the first part of a split
1266 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1269 * Prints some basic information about a WIM file. All information printed by
1270 * this function is also printed by wimlib_print_header(), but
1271 * wimlib_print_wim_information() prints some of this information more concisely
1272 * and in a more readable form.
1275 * Pointer to the ::WIMStruct for a WIM file.
1277 * @return This function has no return value.
1279 extern void wimlib_print_wim_information(const WIMStruct *wim);
1282 * Translates a string specifying the name or number of an image in the WIM into
1283 * the number of the image. The images are numbered starting at 1.
1286 * Pointer to the ::WIMStruct for a WIM file.
1287 * @param image_name_or_num
1288 * A string specifying which image. If it begins with a number, it is
1289 * taken to be a string specifying the image number. Otherwise, it is
1290 * taken to be the name of an image, as specified in the XML data for the
1291 * WIM file. It also may be the keyword "all" or the string "*", both of
1292 * which will resolve to ::WIM_ALL_IMAGES.
1295 * If the string resolved to a single existing image, the number of that
1296 * image, counting starting at 1, is returned. If the keyword "all" was
1297 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1300 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1303 * Sets which image in the WIM is marked as bootable.
1306 * Pointer to the ::WIMStruct for a WIM file.
1308 * The number of the image to mark as bootable, or 0 to mark no image as
1310 * @return 0 on success; nonzero on error.
1311 * @retval ::WIMLIB_ERR_INVALID_PARAM
1312 * @a wim was @c NULL.
1313 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1314 * @a boot_idx does not specify an existing image in @a wim, and it was not
1316 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1317 * @a wim is part of a split WIM. We do not support changing the boot
1318 * index of a split WIM.
1320 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1323 * Changes the description of an image in the WIM.
1326 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1327 * standalone WIM or part of a split WIM; however, you should set the same
1328 * description on all parts of a split WIM.
1330 * The number of the image for which to change the description.
1331 * @param description
1332 * The new description to give the image. It may be @c NULL, which
1333 * indicates that the image is to be given no description.
1335 * @return 0 on success; nonzero on error.
1336 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1337 * @a image does not specify a single existing image in @a wim.
1338 * @retval ::WIMLIB_ERR_INVALID_PARAM
1339 * @a wim was @c NULL.
1340 * @retval ::WIMLIB_ERR_NOMEM
1341 * Failed to allocate the memory needed to duplicate the @a description
1344 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1345 const char *description);
1348 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1349 * (something like "Core" or "Ultimate")
1352 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1353 * standalone WIM or part of a split WIM; however, you should set the same
1354 * \<FLAGS\> element on all parts of a split WIM.
1356 * The number of the image for which to change the description.
1358 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1359 * indicates that the image is to be given no \<FLAGS\> element.
1361 * @return 0 on success; nonzero on error.
1362 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1363 * @a image does not specify a single existing image in @a wim.
1364 * @retval ::WIMLIB_ERR_INVALID_PARAM
1365 * @a wim was @c NULL.
1366 * @retval ::WIMLIB_ERR_NOMEM
1367 * Failed to allocate the memory needed to duplicate the @a flags string.
1369 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1372 * Changes the name of an image in the WIM.
1375 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1376 * standalone WIM or part of a split WIM; however, you should set the same
1377 * name on all parts of a split WIM.
1379 * The number of the image for which to change the name.
1381 * The new name to give the image. It must not a nonempty string.
1383 * @return 0 on success; nonzero on error.
1384 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1385 * There is already an image named @a name in @a wim.
1386 * @retval ::WIMLIB_ERR_INVALID_PARAM
1387 * @a name was @c NULL or the empty string, or @a wim was @c NULL.
1388 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1389 * @a image does not specify a single existing image in @a wim.
1390 * @retval ::WIMLIB_ERR_NOMEM
1391 * Failed to allocate the memory needed to duplicate the @a name string.
1393 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1396 * Set the functions that wimlib uses to allocate and free memory.
1398 * These settings are global and not per-WIM.
1400 * The default is to use the default @c malloc() and @c free() from the C
1403 * Please note that some external functions we call still may use the standard
1404 * memory allocation functions.
1406 * @param malloc_func
1407 * A function equivalent to @c malloc() that wimlib will use to allocate
1408 * memory. If @c NULL, the allocator function is set back to the default
1409 * @c malloc() from the C library.
1411 * A function equivalent to @c free() that wimlib will use to free memory.
1412 * If @c NULL, the free function is set back to the default @c free() from
1414 * @param realloc_func
1415 * A function equivalent to @c realloc() that wimlib will use to reallocate
1416 * memory. If @c NULL, the free function is set back to the default @c
1417 * realloc() from the C library.
1418 * @return 0 on success; nonzero on error.
1419 * @retval ::WIMLIB_ERR_UNSUPPORTED
1420 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1421 * so custom memory allocators are unsupported.
1423 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1424 void (*free_func)(void *),
1425 void *(*realloc_func)(void *, size_t));
1428 * Sets whether wimlib is to print error messages to @c stderr when a function
1429 * fails. These error messages may provide information that cannot be
1430 * determined only from the error code that is returned. Not every error will
1431 * result in an error message being printed.
1433 * This setting is global and not per-WIM.
1435 * By default, error messages are not printed.
1437 * @param show_messages
1438 * @c true if error messages are to be printed; @c false if error messages
1439 * are not to be printed.
1441 * @return 0 on success; nonzero on error.
1442 * @retval ::WIMLIB_ERR_UNSUPPORTED
1443 * @a show_messages was @c true, but wimlib was compiled with the @c
1444 * --without-error-messages option. Therefore, error messages cannot be
1447 extern int wimlib_set_print_errors(bool show_messages);
1450 * Splits a WIM into multiple parts.
1453 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1455 * Name of the SWM file to create. This will be the name of the first
1456 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1459 * The maximum size per part, in bytes. It is not guaranteed that this
1460 * will really be the maximum size per part, because some file resources in
1461 * the WIM may be larger than this size, and the WIM file format provides
1462 * no way to split up file resources among multiple WIMs.
1464 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1465 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1467 * @return 0 on success; nonzero on error. This function may return any value
1468 * returned by wimlib_open_wim() as well as the following error codes:
1470 * @retval ::WIMLIB_ERR_WRITE
1471 * An error occurred when trying to write data to one of the split WIMs.
1474 extern int wimlib_split(const char *wimfile, const char *swm_name,
1475 size_t part_size, int flags);
1478 * Unmounts a WIM image that was mounted using wimlib_mount().
1480 * Blocks until it is known whether the mount succeeded or failed.
1482 * To perform this operation, the process calling wimlib_unmount() communicates
1483 * with the process that had called wimlib_mount().
1485 * There is currently a design problem with this function because it is hard to
1486 * know whether the filesystem daemon is still working or whether it has
1487 * crashed, has been killed, or has reached an infinite loop. However, ideally
1488 * there should be no infinite loops or crashes in the code, so this wouldn't be
1489 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1490 * can be very large) is implemented so that this function will not wait forever
1491 * before returning failure.
1494 * The directory that the WIM image was mounted on.
1496 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1497 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1500 * @return 0 on success; nonzero on error.
1501 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1502 * The filesystem daemon was unable to remove the staging directory and the
1503 * temporary files that it contains.
1504 * @retval ::WIMLIB_ERR_FORK
1505 * Could not @c fork() the process.
1506 * @retval ::WIMLIB_ERR_FUSERMOUNT
1507 * The @b fusermount program could not be executed or exited with a failure
1509 * @retval ::WIMLIB_ERR_MQUEUE
1510 * Could not open a POSIX message queue to communicate with the filesystem
1511 * daemon servicing the mounted filesystem, could not send a message
1512 * through the queue, or could not receive a message through the queue.
1513 * @retval ::WIMLIB_ERR_NOMEM
1514 * Failed to allocate needed memory.
1515 * @retval ::WIMLIB_ERR_OPEN
1516 * The filesystem daemon could not open a temporary file for writing the
1518 * @retval ::WIMLIB_ERR_TIMEOUT
1519 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1520 * the process of its exit status, so the WIM file probably was not written
1522 * @retval ::WIMLIB_ERR_READ
1523 * A read error occurred when the filesystem daemon tried to a file from
1524 * the staging directory
1525 * @retval ::WIMLIB_ERR_RENAME
1526 * The filesystem daemon failed to rename the newly written WIM file to the
1527 * original WIM file.
1528 * @retval ::WIMLIB_ERR_WRITE
1529 * A write error occurred when the filesystem daemon was writing to the new
1530 * WIM file, or the filesystem daemon was unable to flush changes that had
1531 * been made to files in the staging directory.
1533 extern int wimlib_unmount(const char *dir, int flags);
1536 * Writes the WIM to a file.
1539 * Pointer to the ::WIMStruct for a WIM file. There may have been
1540 * in-memory changes made to it, which are then reflected in the output
1543 * The path to the file to write the WIM to.
1545 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1547 * @param write_flags
1548 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1549 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1550 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1551 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1552 * is given, the progress of the calculation of the integrity table is
1554 * @param num_threads
1555 * Number of threads to use for compressing data. Autodetected if set to
1556 * 0. Note: if no data compression needs to be done, no threads will be
1557 * created regardless of this parameter (e.g. if writing an uncompressed
1558 * WIM, or exporting an image from a compressed WIM to another WIM of the
1559 * same compression type).
1561 * @return 0 on success; nonzero on error.
1562 * @retval ::WIMLIB_ERR_DECOMPRESSION
1563 * Failed to decompress a metadata or file resource in @a wim.
1564 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1565 * A directory entry in the metadata resource for @a image in @a wim is
1567 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1568 * @a image does not specify a single existing image in @a wim, and is not
1570 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1571 * A file that had previously been scanned for inclusion in the WIM by the
1572 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
1573 * concurrently modified, so it failed the SHA1 message digest check.
1574 * @retval ::WIMLIB_ERR_INVALID_PARAM
1575 * @a wim or @a path was @c NULL.
1576 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1577 * The metadata resource for @a image in @a wim is invalid.
1578 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1579 * The security data for @a image in @a wim is invalid.
1580 * @retval ::WIMLIB_ERR_NOMEM
1581 * Failed to allocate needed memory.
1582 * @retval ::WIMLIB_ERR_OPEN
1583 * Failed to open @a path for writing, or some file resources in @a
1584 * wim refer to files in the outside filesystem, and one of these files
1585 * could not be opened for reading.
1586 * @retval ::WIMLIB_ERR_READ
1587 * An error occurred when trying to read data from the WIM file associated
1588 * with @a wim, or some file resources in @a wim refer to files in the
1589 * outside filesystem, and a read error occurred when reading one of these
1591 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1592 * @a wim is part of a split WIM. You may not call this function on a
1594 * @retval ::WIMLIB_ERR_WRITE
1595 * An error occurred when trying to write data to the new WIM file at @a
1598 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
1599 int write_flags, unsigned num_threads);
1603 #endif /* _WIMLIB_H */