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. In some
145 * cases, wimlib_overwrite_xml_and_header() can be used instead.
147 * After you are done with the WIM file, use wimlib_free() to free all memory
148 * associated with a ::WIMStruct and close all files associated with it.
150 * To see an example of how to use wimlib, see the file
151 * @c programs/imagex.c in wimlib's source tree.
153 * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
154 * for this. However, if wimlib calls into @c libntfs-3g, the custom memory
155 * allocator may not be used.
157 * \section imagex imagex
159 * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
161 * \section mkwinpeimg mkwinpeimg
163 * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
166 * \section Limitations
168 * While wimlib supports the main features of WIM files, wimlib currently has
169 * the following limitations:
170 * - Different versions of the WIM file format are unsupported. There is one
171 * different version of the format from development versions of Windows Vista,
172 * but I'm not planning to support it.
173 * - Compressed resource chunk sizes other than 32768 are unsupported (except for
174 * uncompressed WIMs, for which the chunk size field is ignored). As far as I
175 * can tell, other chunk sizes are not used in compressed WIMs. Let me know
176 * if you find a WIM file with a different chunk size.
177 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
178 * make certain Windows-specific modifications to a Windows PE image, such as
179 * adding a driver or Windows component. Such a tool could conceivably be
180 * implemented on top of wimlib, although it likely would be hard to implement
181 * because it would have to do very Windows-specific things such as
182 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
183 * script for a similar purpose, however. With regards to adding drivers to
184 * Windows PE, you have the option of putting them anywhere in the Windows PE
185 * image, then loading them after boot using @b drvload.exe.
186 * - There is not yet a way to extract specific files or directories from a WIM
187 * file without mounting it, or to add, remove, or modify files in a WIM
188 * without mounting it, other than by adding or removing an entire image. I
189 * can implement this if requested, but I intend the FUSE mount feature to be
190 * used for this purpose, as it is easy to do these things in whatever way you
191 * want after the image is mounted.
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".
198 * \section legal License
200 * The wimlib library, as well as the programs and scripts distributed with it
201 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
202 * License version 3 or later.
212 #ifndef _WIMLIB_INTERNAL_H
214 * Opaque structure that represents a WIM file.
216 typedef struct WIMStruct WIMStruct;
220 * Specifies the compression type of a WIM file.
223 enum wim_compression_type {
224 /** An invalid compression type. */
225 WIM_COMPRESSION_TYPE_INVALID = -1,
227 /** The WIM does not include any compressed resources. */
228 WIM_COMPRESSION_TYPE_NONE = 0,
230 /** Compressed resources in the WIM use LZX compression. */
231 WIM_COMPRESSION_TYPE_LZX = 1,
233 /** Compressed resources in the WIM use XPRESS compression. */
234 WIM_COMPRESSION_TYPE_XPRESS = 2,
237 /** Mount the WIM read-write. */
238 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
240 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
241 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
243 /** Do not allow accessing alternate data streams. */
244 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000010
246 /** Access alternate data streams through extended file attributes. This is the
248 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000020
250 /** Access alternate data streams by specifying the file name, a colon, then the
251 * alternate file stream name. */
252 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
254 /** Include an integrity table in the new WIM being written during the unmount.
255 * Ignored for read-only mounts. */
256 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
258 /** Unless this flag is given, changes to a mounted WIM are discarded. Ignored
259 * for read-only mounts. */
260 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
262 /** Include an integrity table in the new WIM file. */
263 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
265 /** Print progress information when writing streams and when writing the
266 * integrity table. */
267 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS 0x00000002
269 /** Print file paths as we write then */
270 #define WIMLIB_WRITE_FLAG_VERBOSE 0x00000004
272 /** Call fsync() when the WIM file is closed */
273 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
275 /** Mark the image being added as the bootable image of the WIM. */
276 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
278 /** Print the name of each file or directory as it is scanned to be included in
280 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
282 /** Follow symlinks; archive and dump the files they point to. */
283 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000004
285 /** Show progress information when scanning a directory tree */
286 #define WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS 0x00000008
288 /** See documentation for wimlib_export_image(). */
289 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
291 /** Verify the integrity of the WIM if an integrity table is present. */
292 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
294 /** Print progress information when verifying integrity table. */
295 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
297 /** If this flag is not given, an error is issued if the WIM is part of a split
299 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
302 /** When identical files are extracted from the WIM, always hard link them
304 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
306 /** When identical files are extracted from the WIM, always symlink them
308 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
310 /** Print the name of each file as it is extracted from the WIM image. */
311 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
314 * Possible values of the error code returned by many functions in wimlib.
316 * See the documentation for each wimlib function to see specifically what error
317 * codes can be returned by a given function, and what they mean.
319 enum wimlib_error_code {
320 WIMLIB_ERR_SUCCESS = 0,
321 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
322 WIMLIB_ERR_DECOMPRESSION,
323 WIMLIB_ERR_DELETE_STAGING_DIR,
326 WIMLIB_ERR_FUSERMOUNT,
327 WIMLIB_ERR_IMAGE_COUNT,
328 WIMLIB_ERR_IMAGE_NAME_COLLISION,
329 WIMLIB_ERR_INTEGRITY,
330 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
331 WIMLIB_ERR_INVALID_CHUNK_SIZE,
332 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
333 WIMLIB_ERR_INVALID_DENTRY,
334 WIMLIB_ERR_INVALID_HEADER_SIZE,
335 WIMLIB_ERR_INVALID_IMAGE,
336 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
337 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
338 WIMLIB_ERR_INVALID_PARAM,
339 WIMLIB_ERR_INVALID_RESOURCE_HASH,
340 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
341 WIMLIB_ERR_INVALID_SECURITY_DATA,
347 WIMLIB_ERR_NOT_A_WIM_FILE,
348 WIMLIB_ERR_NO_FILENAME,
355 WIMLIB_ERR_RESOURCE_ORDER,
356 WIMLIB_ERR_SPECIAL_FILE,
357 WIMLIB_ERR_SPLIT_INVALID,
358 WIMLIB_ERR_SPLIT_UNSUPPORTED,
361 WIMLIB_ERR_UNKNOWN_VERSION,
362 WIMLIB_ERR_UNSUPPORTED,
368 /** Used to indicate that no WIM image is currently selected. */
369 #define WIM_NO_IMAGE 0
371 /** Used to specify all images in the WIM. */
372 #define WIM_ALL_IMAGES (-1)
376 * Adds an image to a WIM file from a directory tree on disk.
378 * The directory tree is read immediately for the purpose of constructing a
379 * directory entry tree in-memory. Also, all files are read to calculate their
380 * SHA1 message digests. However, because the directory tree may contain a very
381 * large amount of data, the files themselves are not read into memory
382 * permanently, and instead references to their paths saved. The files are then
383 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
386 * Pointer to the ::WIMStruct for a WIM file to which the image will be
389 * A path to a directory in the outside filesystem. It will become the
390 * root directory for the WIM image.
392 * The name to give the image. This must be non-@c NULL.
394 * Pointer to the contents of an image capture configuration file. If @c
395 * NULL, a default string is used. Please see the manual page for
396 * <b>imagex capture</b> for more information.
398 * Length of the string @a config in bytes. Ignored if @a config is @c
402 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
403 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
404 * marked as bootable is changed to the one being added. If
405 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
406 * printed as it is scanned or captured. If
407 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
408 * directories pointed to by symbolic links are archived rather than the
409 * symbolic links themselves. If ::WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS is
410 * specified, progress information will be printed (distinct from the
411 * verbose information).
413 * @return 0 on success; nonzero on error. On error, changes to @a wim are
414 * discarded so that it appears to be in the same state as when this function
417 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
418 * There is already an image named @a name in @a w.
419 * @retval ::WIMLIB_ERR_INVALID_PARAM
420 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
421 * @retval ::WIMLIB_ERR_NOMEM
422 * Failed to allocate needed memory.
423 * @retval ::WIMLIB_ERR_NOTDIR
424 * @a dir is not a directory.
425 * @retval ::WIMLIB_ERR_OPEN
426 * Failed to open a file or directory in the directory tree rooted at @a
428 * @retval ::WIMLIB_ERR_READ
429 * Failed to read a file in the directory tree rooted at @a dir.
430 * @retval ::WIMLIB_ERR_SPECIAL_FILE
431 * The directory tree rooted at @dir contains a special file that is not a
432 * directory, regular file, or symbolic link.
433 * @retval ::WIMLIB_ERR_STAT
434 * Failed obtain the metadata for a file or directory in the directory tree
436 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
437 * @a wim is part of a split WIM. Adding an image to a split WIM is
440 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
441 const char *name, const char *config,
442 size_t config_len, int flags);
445 * This function is similar to wimlib_add_image(), except instead of capturing
446 * the WIM image from a directory, it is captured from a NTFS volume specified
447 * by @a device. NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
448 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
449 * the reparse points exactly as they are.
451 extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
458 * This function is similar to wimlib_extract_image(), except that @a image may
459 * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
460 * device containing a NTFS volume to apply the image to. NTFS-3g errors are
461 * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
462 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
463 * apply mode we apply the reparse points and hard links exactly as they are in
466 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
467 const char *device, int flags,
468 WIMStruct **additional_swms,
469 unsigned num_additional_swms);
472 * Creates a WIMStruct for a new WIM file.
475 * The type of compression to be used in the new WIM file. Must be
476 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
477 * ::WIM_COMPRESSION_TYPE_XPRESS.
479 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
480 * written to the memory location pointed to by this paramater. The
481 * ::WIMStruct must be freed using using wimlib_free() when finished with
483 * @return 0 on success; nonzero on error.
484 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
485 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
486 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
487 * @retval ::WIMLIB_ERR_NOMEM
488 * Failed to allocate needed memory.
490 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
493 * Deletes an image, or all images, from a WIM file.
495 * All streams referenced by the image(s) being deleted are removed from the
496 * lookup table of the WIM if they are not referenced by any other images in the
500 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
503 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
505 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
506 * to be left unmodified only if @a image specified a single image. If instead
507 * @a image was ::WIM_ALL_IMAGES and @a wim contained more than one image, it's
508 * possible for some but not all of the images to have been deleted when a
509 * failure status is returned.
511 * @retval ::WIMLIB_ERR_DECOMPRESSION
512 * Could not decompress the metadata resource for @a image.
513 * @retval ::WIMLIB_ERR_INVALID_DENTRY
514 * A directory entry in the metadata resource for @a image in the WIM is
516 * @retval ::WIMLIB_ERR_INVALID_IMAGE
517 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
518 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
519 * The metadata resource for @a image in the WIM is invalid.
520 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
521 * The security data for @a image in the WIM is invalid.
522 * @retval ::WIMLIB_ERR_NOMEM
523 * Failed to allocate needed memory.
524 * @retval ::WIMLIB_ERR_READ
525 * Could not read the metadata resource for @a image from the WIM.
526 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
527 * @a wim is part of a split WIM. Deleting an image from a split WIM is
530 extern int wimlib_delete_image(WIMStruct *wim, int image);
533 * Exports an image, or all the images, from a WIM file, into another WIM file.
535 * The destination image is made to share the same dentry tree and security data
536 * structure as the source image. This places some restrictions on additional
537 * functions that may be called. wimlib_mount() may not be called on either the
538 * source image or the destination image without an intervening call to a
539 * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
540 * wimlib_delete_image() on either the source or destination image.
541 * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
542 * src_wim before any calls to functions such as wimlib_write() on @a dest_wim
543 * because @a dest_wim will have references back to @a src_wim.
545 * Previous versions of this function left @a dest_wim in an indeterminate state
546 * on failure. This is no longer the case; all changes to @a dest_wim made by
547 * this function are rolled back on failure.
549 * Previous versions of this function did not allow exporting an image that had
550 * been added by wimlib_add_image(). This is no longer the case; you may now
551 * export an image regardless of how it was added.
553 * Regardless of whether this function succeeds or fails, no user-visible
554 * changes are made to @a src_wim.
557 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
558 * WIM that contains the image(s) being exported.
560 * The image to export from @a src_wim. Can be the number of an image, or
561 * ::WIM_ALL_IMAGES to export all images.
563 * Pointer to the ::WIMStruct for a WIM file that will receive the images
566 * The name to give the exported image in the new WIM file. If left @c NULL,
567 * the name from @a src_wim is used. This parameter must be left @c NULL
568 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
569 * image; in that case, the names are all taken from the @a src_wim.
570 * @param dest_description
571 * The description to give the exported image in the new WIM file. If left
572 * @c NULL, the description from the @a src_wim is used. This parameter must
573 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
574 * more than one image; in that case, the descriptions are all taken from
577 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
578 * bootable, or 0 if which image is marked as bootable in the destination
579 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
580 * there are multiple images in @a src_wim, specifying
581 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
582 * currently marked as bootable in @a src_wim; if that is the case, then
583 * that image is marked as bootable in the destination WIM.
584 * @param additional_swms
585 * Array of pointers to the ::WIMStruct for each additional part in the
586 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
587 * need to be in any particular order, but they must include all parts of
588 * the split WIM other than the first part, which must be provided in the
590 * @param num_additional_swms
591 * Number of additional WIM parts provided in the @a additional_swms array.
592 * This number should be one less than the total number of parts in the
593 * split WIM. Set to 0 if the WIM is a standalone WIM.
595 * @return 0 on success; nonzero on error.
596 * @retval ::WIMLIB_ERR_DECOMPRESSION
597 * Could not decompress the metadata resource for @a src_image
599 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
600 * One or more of the names being given to an exported image was already in
601 * use in the destination WIM.
602 * @retval ::WIMLIB_ERR_INVALID_DENTRY
603 * A directory entry in the metadata resource for @a src_image in @a
604 * src_wim is invalid.
605 * @retval ::WIMLIB_ERR_INVALID_IMAGE
606 * @a src_image does not exist in @a src_wim.
607 * @retval ::WIMLIB_ERR_INVALID_PARAM
608 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
609 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
610 * @a src_wim are marked as bootable; or @a dest_name and/or @a
611 * dest_description were non-<code>NULL</code>, @a src_image was
612 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
613 * or @a dest_wim was @c NULL.
614 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
615 * The metadata resource for @a src_image in @a src_wim is invalid.
616 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
617 * The security data for @a src_image in @a src_wim is invalid.
618 * @retval ::WIMLIB_ERR_NOMEM
619 * Failed to allocate needed memory.
620 * @retval ::WIMLIB_ERR_READ
621 * Could not read the metadata resource for @a src_image from @a src_wim.
622 * @retval ::WIMLIB_ERR_SPLIT_INVALID
623 * The source WIM is a split WIM, but the parts specified do not form a
624 * complete split WIM because they do not include all the parts of the
625 * original WIM, there are duplicate parts, or not all the parts have the
626 * same GUID and compression type.
627 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
628 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
631 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
632 WIMStruct *dest_wim, const char *dest_name,
633 const char *dest_description, int flags,
634 WIMStruct **additional_swms,
635 unsigned num_additional_swms);
638 * Extracts an image, or all images, from a standalone or split WIM file.
641 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
644 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
645 * to specify that all images are to be extracted.
647 * Directory to extract the WIM image(s) to. It is created if it does not
650 * Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
652 * One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
653 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified. These flags cause
654 * extracted files that are identical to be hardlinked or symlinked
655 * together, depending on the flag. These flags override the hard link
656 * groups that are specified in the WIM file itself. If ::WIM_ALL_IMAGES
657 * is provided as the @a image parameter, files may be hardlinked or
658 * symlinked across images if a file is found to occur in more than one
661 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
662 * informational messages to be printed during the extraction, including
663 * the name of each extracted file or directory.
664 * @param additional_swms
665 * Array of pointers to the ::WIMStruct for each additional part in the
666 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
667 * need to be in any particular order, but they must include all parts of
668 * the split WIM other than the first part, which must be provided in the
670 * @param num_additional_swms
671 * Number of additional WIM parts provided in the @a additional_swms array.
672 * This number should be one less than the total number of parts in the
673 * split WIM. Set to 0 if the WIM is a standalone WIM.
675 * @return 0 on success; nonzero on error.
676 * @retval ::WIMLIB_ERR_DECOMPRESSION
677 * Could not decompress a resource (file or metadata) for @a image in @a
679 * @retval ::WIMLIB_ERR_INVALID_DENTRY
680 * A directory entry in the metadata resource for @a image in @a wim is
682 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
683 * The SHA1 message digest of an extracted stream did not match the SHA1
684 * message digest given in the WIM file.
685 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
686 * A resource (file or metadata) for @a image in @a wim is invalid.
687 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
688 * The security data for @a image in @a wim is invalid.
689 * @retval ::WIMLIB_ERR_LINK
690 * Failed to create a symbolic link or a hard link.
691 * @retval ::WIMLIB_ERR_MKDIR
692 * Failed create a needed directory.
693 * @retval ::WIMLIB_ERR_NOMEM
694 * Failed to allocate needed memory.
695 * @retval ::WIMLIB_ERR_OPEN
696 * Could not open one of the files being extracted for writing.
697 * @retval ::WIMLIB_ERR_READ
698 * A unexpected end-of-file or read error occurred when trying to read data
699 * from the WIM file associated with @a wim.
700 * @retval ::WIMLIB_ERR_SPLIT_INVALID
701 * The WIM is a split WIM, but the parts specified do not form a complete
702 * split WIM because they do not include all the parts of the original WIM,
703 * there are duplicate parts, or not all the parts have the same GUID and
705 * @retval ::WIMLIB_ERR_WRITE
706 * Failed to write a file being extracted.
708 extern int wimlib_extract_image(WIMStruct *wim, int image,
709 const char *output_dir, int flags,
710 WIMStruct **additional_swms,
711 unsigned num_additional_swms);
714 * Extracts the XML data for a WIM file to a file stream. Every WIM file
715 * includes a string of XML that describes the images contained in the WIM.
716 * This function works on standalone WIMs as well as split WIM parts.
719 * Pointer to the ::WIMStruct for a WIM file.
721 * @c stdout, or a FILE* opened for writing, to extract the data to.
723 * @return 0 on success; nonzero on error.
724 * @retval ::WIMLIB_ERR_WRITE
725 * Failed to completely write the XML data to @a fp.
727 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
730 * Frees all memory allocated for a WIMStruct and closes all files associated
734 * Pointer to the ::WIMStruct for a WIM file.
736 * @return This function has no return value.
738 extern void wimlib_free(WIMStruct *wim);
741 * Finds which image in a WIM is bootable.
744 * Pointer to the ::WIMStruct for a WIM file.
747 * 0 if no image is marked as bootable, or the number of the image marked
748 * as bootable (numbered starting at 1).
750 extern int wimlib_get_boot_idx(const WIMStruct *wim);
753 * Gets the compression type used in the WIM.
756 * Pointer to the ::WIMStruct for a WIM file
759 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
760 * ::WIM_COMPRESSION_TYPE_XPRESS.
762 extern int wimlib_get_compression_type(const WIMStruct *wim);
765 * Converts a compression type enumeration value into a string.
768 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
769 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
772 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
775 extern const char *wimlib_get_compression_type_string(int ctype);
778 * Converts an error code into a string describing it.
781 * The error code returned by one of wimlib's functions.
784 * Pointer to a statically allocated string describing the error code,
785 * or @c NULL if the error code is not valid.
787 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
790 * Returns the description of the specified image.
793 * Pointer to the ::WIMStruct for a WIM file. It may be either a
794 * standalone WIM or a split WIM part.
796 * The number of the image, numbered starting at 1.
799 * The description of the image, or @c NULL if there is no such image, or
800 * @c NULL if the specified image has no description. The description
801 * string is in library-internal memory and may not be modified or freed;
802 * in addition, the string will become invalid if the description of the
803 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
805 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
808 * Returns the name of the specified image.
811 * Pointer to the ::WIMStruct for a WIM file. It may be either a
812 * standalone WIM or a split WIM part.
814 * The number of the image, numbered starting at 1.
817 * The name of the image, or @c NULL if there is no such image. The name
818 * string is in library-internal memory and may not be modified or freed;
819 * in addition, the string will become invalid if the name of the image is
820 * changed, the image is deleted, or the ::WIMStruct is destroyed.
822 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
826 * Gets the number of images contained in the WIM.
829 * Pointer to the ::WIMStruct for a WIM file. It may be either a
830 * standalone WIM or a split WIM part.
833 * The number of images contained in the WIM file.
835 extern int wimlib_get_num_images(const WIMStruct *wim);
838 * Gets the part number of part of a split WIM.
841 * Pointer to the ::WIMStruct for a WIM file.
842 * @param total_parts_ret
843 * If non-@c NULL, the total number of parts in the split WIM (1 for
844 * non-split WIMs) is written to this location.
847 * The part number of the WIM (1 for non-split WIMs)
849 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
852 * Returns true if the WIM has an integrity table.
855 * Pointer to the ::WIMStruct for a WIM file.
857 * @c true if the WIM has an integrity table; @c false otherwise.
859 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
863 * Determines if an image name is already used by some image in the WIM.
866 * Pointer to the ::WIMStruct for a WIM file.
871 * @c true if there is already an image in @a wim named @a name; @c false
872 * if there is no image named @a name in @a wim. (If @a name is @c NULL,
873 * @c false is returned.)
875 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
878 * Joins a set of split WIMs into a one-part WIM.
881 * An array of strings that give the filenames of all parts of the split
884 * Number of filenames in @a swms.
886 * The path to write the one-part WIM to.
888 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
889 * tables (if present) when opening them, and include an integrity table in
892 * @return 0 on success; nonzero on error. This function may return any value
893 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
894 * as the following error codes:
896 * @retval ::WIMLIB_ERR_SPLIT_INVALID
897 * The split WIMs do not form a valid WIM because they do not include all
898 * the parts of the original WIM, there are duplicate parts, or not all the
899 * parts have the same GUID and compression type.
900 * @retval ::WIMLIB_ERR_WRITE
901 * An error occurred when trying to write data to the new WIM at @a output_path.
903 * Note that this function merely copies the resources, so it will not check to
904 * see if the resources, including the metadata resources, are valid or not.
906 * Also, after this function is called, the only function that may be called on
907 * the ::WIMStruct's in the @a swms array is wimlib_free().
909 extern int wimlib_join(const char **swms, unsigned num_swms,
910 const char *output_path, int flags);
913 * Mounts an image in a WIM file on a directory read-only or read-write.
915 * A daemon will be forked to service the filesystem.
917 * If the mount is read-write, modifications to the WIM are staged in a staging
920 * wimlib_mount() may be called from multiple threads without intervening calls
921 * to wimlib_unmount(), provided that different ::WIMStruct's are used. (This
922 * was not the case for versions of this library 1.0.3 and earlier.)
924 * wimlib_mount() cannot be used on an image that was exported with
925 * wimlib_export_image() while the dentry trees for both images are still in
926 * memory. In addition, wimlib_mount() may not be used to mount an image that
927 * has just been added with wimlib_add_image() or
928 * wimlib_add_image_from_ntfs_volume(), unless the WIM has been written and read
929 * into a new ::WIMStruct.
932 * Pointer to the ::WIMStruct for the WIM file to be mounted.
934 * The number of the image to mount, numbered from 1. It must be an
935 * existing, single image.
937 * The path to an existing directory to mount the image on.
939 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG. If
940 * ::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
941 * read-only. The interface to the WIM named data streams is specified by
942 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
943 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
944 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
945 * the XATTR interface.
946 * @param additional_swms
947 * Array of pointers to the ::WIMStruct for each additional part in the
948 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
949 * need to be in any particular order, but they must include all parts of
950 * the split WIM other than the first part, which must be provided in the
952 * @param num_additional_swms
953 * Number of additional WIM parts provided in the @a additional_swms array.
954 * This number should be one less than the total number of parts in the
955 * split WIM. Set to 0 if the WIM is a standalone WIM.
957 * @return 0 on success; nonzero on error.
958 * @retval ::WIMLIB_ERR_DECOMPRESSION
959 * Could not decompress the metadata resource for @a image in @a wim.
960 * @retval ::WIMLIB_ERR_FUSE
961 * A non-zero status was returned by @c fuse_main().
962 * @retval ::WIMLIB_ERR_INVALID_DENTRY
963 * A directory entry in the metadata resource for @a image in @a wim is
965 * @retval ::WIMLIB_ERR_INVALID_IMAGE
966 * @a image does not specify an existing, single image in @a wim.
967 * @retval ::WIMLIB_ERR_INVALID_PARAM
968 * @a image is shared among multiple ::WIMStruct's as a result of a call to
969 * wimlib_export_image(), or @a image has been added with
970 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
971 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
972 * The metadata resource for @a image in @a wim is invalid.
973 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
974 * The security data for @a image in @a wim is invalid.
975 * @retval ::WIMLIB_ERR_MKDIR
976 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
977 * directory could not be created.
978 * @retval ::WIMLIB_ERR_NOMEM
979 * Failed to allocate needed memory.
980 * @retval ::WIMLIB_ERR_NOTDIR
981 * Could not determine the current working directory.
982 * @retval ::WIMLIB_ERR_READ
983 * An unexpected end-of-file or read error occurred when trying to read
984 * data from the WIM file associated with @a wim.
985 * @retval ::WIMLIB_ERR_SPLIT_INVALID
986 * The WIM is a split WIM, but the parts specified do not form a complete
987 * split WIM because they do not include all the parts of the original WIM,
988 * there are duplicate parts, or not all the parts have the same GUID and
990 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
991 * The WIM is a split WIM and a read-write mount was requested. We only
992 * support mounting a split WIM read-only.
994 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
995 WIMStruct **additional_swms,
996 unsigned num_additional_swms);
999 * Opens a WIM file and creates a ::WIMStruct for it.
1002 * The path to the WIM file to open.
1004 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1005 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1006 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
1007 * of the WIM, if it exists, is checked, and the function will fail with an
1008 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1009 * digests of the WIM do not exactly match the corresponding message
1010 * digests given in the integrity table.
1011 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
1012 * be shown if the integrity of the WIM is checked.
1013 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1014 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1015 * returned. (This flag may be removed in the future, in which case no
1016 * error will be issued when opening a split WIM.)
1019 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1020 * is written to the memory location pointed to by this parameter. The
1021 * ::WIMStruct must be freed using using wimlib_free() when finished with
1024 * @return 0 on success; nonzero on error.
1025 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1026 * The lookup table of @a wim_file is compressed. Support for this can be
1027 * added to wimlib if needed, but it appears to be the case that the lookup
1028 * table is never compressed.
1029 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1030 * The WIM is not the non-first part of a split WIM, and the number of
1031 * metadata resources found in the WIM did not match the image count given
1032 * in the WIM header, or the number of <IMAGE> elements in the XML
1033 * data for the WIM did not match the image count given in the WIM header.
1034 * @retval ::WIMLIB_ERR_INTEGRITY
1035 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1036 * wim_file contains an integrity table, but the SHA1 message digest for a
1037 * chunk of the WIM does not match the corresponding message digest given
1038 * in the integrity table.
1039 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1040 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1041 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1042 * The header of @a wim_file says that resources in the WIM are compressed,
1043 * but the header flag indicating LZX or XPRESS compression is not set.
1044 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1045 * The length field of the WIM header is not 208.
1046 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1047 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1048 * wim_file contains an integrity table, but the integrity table is
1050 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1051 * The lookup table for the WIM contained duplicate entries, or it
1052 * contained an entry with a SHA1 message digest of all 0's.
1053 * @retval ::WIMLIB_ERR_NOMEM
1054 * Failed to allocated needed memory.
1055 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1056 * @a wim_file does not begin with the expected magic characters.
1057 * @retval ::WIMLIB_ERR_OPEN
1058 * Failed to open the file @a wim_file for reading.
1059 * @retval ::WIMLIB_ERR_READ
1060 * An unexpected end-of-file or read error occurred when trying to read
1061 * data from @a wim_file.
1062 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1063 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1064 * givin in @a flags.
1065 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1066 * A number other than 0x10d00 is written in the version field of the WIM
1067 * header of @a wim_file.
1068 * @retval ::WIMLIB_ERR_XML
1069 * The XML data for @a wim_file is invalid.
1071 extern int wimlib_open_wim(const char *wim_file, int flags,
1072 WIMStruct **wim_ret);
1075 * Overwrites the file that the WIM was originally read from, with changes made.
1077 * The new WIM is written to a temporary file and then renamed to the original
1078 * file after it is has been completely written. The temporary file currently
1079 * is made in the same directory as the original WIM file.
1081 * After this function returns, @a wim must be freed using wimlib_free(). Any
1082 * further actions on @a wim before doing this are undefined.
1085 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1086 * been in-memory changes made to it, which are then reflected in the
1088 * @param write_flags
1089 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1090 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1091 * @param num_threads
1092 * Number of threads to use for compression (see wimlib_write()).
1094 * @return 0 on success; nonzero on error. This function may return any value
1095 * returned by wimlib_write() as well as the following error codes:
1096 * @retval ::WIMLIB_ERR_NO_FILENAME
1097 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1098 * than a WIM read with wimlib_open_wim().
1099 * @retval ::WIMLIB_ERR_RENAME
1100 * The temporary file that the WIM was written to could not be renamed to
1101 * the original filename of @a wim.
1103 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1104 unsigned num_threads);
1107 * Updates the header and XML data of the WIM file, without the need to write
1108 * out the entire WIM to a temporary file as in wimlib_write().
1110 * This function must only be used if no files, directories, or images have been
1111 * added, removed, or changed in the WIM. It must be used when only the boot
1112 * index or the name or description of image(s) has been changed.
1114 * After this function returns, @a wim must be freed using wimlib_free(). Any
1115 * further actions on @a wim before doing this are undefined.
1118 * Pointer to the ::WIMStruct for the WIM file to overwrite.
1119 * @param write_flags
1120 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1121 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1123 * @return 0 on success; nonzero on error.
1125 * @retval ::WIMLIB_ERR_NO_FILENAME
1126 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1127 * than a WIM read with wimlib_open_wim().
1128 * @retval ::WIMLIB_ERR_NOMEM
1129 * Failed to allocate needed memory.
1130 * @retval ::WIMLIB_ERR_OPEN
1131 * The WIM file associated with @a wim could not be re-opened read-write.
1132 * @retval ::WIMLIB_ERR_READ
1133 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
1134 * from the WIM file associated with @a wim could not be read to compute
1135 * the SHA1 message digests, or the old integrity table (if it existed)
1136 * could not be read.
1137 * @retval ::WIMLIB_ERR_RESOURCE_ORDER
1138 * Stream resources appeared in the WIM after the XML data or integrity
1139 * table, so we could not safely overwrite the XML data and integrity
1140 * table. Note: this error should never be received from WIMs that were
1141 * written by this library.
1142 * @retval ::WIMLIB_ERR_WRITE
1143 * Failed to write the WIM header, the XML data, or the integrity table to
1144 * the WIM file associated with @a wim.
1146 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags);
1149 * Prints information about one image, or all images, contained in a WIM.
1152 * Pointer to the ::WIMStruct for a WIM file.
1154 * The image about which to print information. Can be the number of an
1155 * image, or ::WIM_ALL_IMAGES to print information about all images in the
1158 * @return This function has no return value. No error checking is done when
1159 * printing the information. If @a image is invalid, an error message is
1162 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1165 * Prints the full paths to all files contained in an image, or all images, in a
1169 * Pointer to the ::WIMStruct for a WIM file.
1171 * Which image to print files for. Can be the number of an image, or
1172 * ::WIM_ALL_IMAGES to print the files contained in all images.
1174 * @return 0 on success; nonzero on error.
1175 * @retval ::WIMLIB_ERR_DECOMPRESSION
1176 * The metadata resource for one of the specified images could not be
1178 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1179 * A directory entry in the metadata resource for one of the specified
1180 * images is invaled.
1181 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1182 * @a image does not specify a valid image in @a wim, and is not
1184 * @retval ::WIMLIB_ERR_INVALID_PARAM
1185 * @a wim was @c NULL.
1186 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1187 * The metadata resource for one of the specified images is invalid.
1188 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1189 * The security data for one of the specified images is invalid.
1190 * @retval ::WIMLIB_ERR_NOMEM
1191 * Failed to allocate needed memory.
1192 * @retval ::WIMLIB_ERR_READ
1193 * An unexpected read error or end-of-file occurred when reading the
1194 * metadata resource for one of the specified images.
1195 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1196 * @a wim was not a standalone WIM and was not the first part of a split
1199 extern int wimlib_print_files(WIMStruct *wim, int image);
1202 * Prints detailed information from the header of a WIM file.
1205 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1206 * standalone WIM or part of a split WIM.
1208 * @return This function has no return value.
1211 extern void wimlib_print_header(const WIMStruct *wim);
1214 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1215 * digests, as found in the directory entry tree in the WIM file, to file
1216 * resources in the WIM file. This table includes one entry for each unique
1217 * file in the WIM, so it can be quite long. There is only one lookup table per
1221 * Pointer to the ::WIMStruct for a WIM file.
1223 * @return This function has no return value.
1225 extern void wimlib_print_lookup_table(WIMStruct *wim);
1228 * Prints the metadata of the specified image in a WIM file. The metadata
1229 * consists of the security data as well as the directory entry tree, and each
1230 * image has its own metadata.
1233 * Pointer to the ::WIMStruct for a WIM file.
1235 * Which image to print the metadata for. Can be the number of an image,
1236 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1238 * @return 0 on success; nonzero on error.
1239 * @retval ::WIMLIB_ERR_DECOMPRESSION
1240 * The metadata resource for one of the specified images could not be
1242 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1243 * A directory entry in the metadata resource for one of the specified
1244 * images is invaled.
1245 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1246 * @a image does not specify a valid image in @a wim, and is not
1248 * @retval ::WIMLIB_ERR_INVALID_PARAM
1249 * @a wim was @c NULL.
1250 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1251 * The metadata resource for one of the specified images is invalid.
1252 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1253 * The security data for one of the specified images is invalid.
1254 * @retval ::WIMLIB_ERR_NOMEM
1255 * Failed to allocate needed memory.
1256 * @retval ::WIMLIB_ERR_READ
1257 * An unexpected read error or end-of-file occurred when reading the
1258 * metadata resource for one of the specified images.
1259 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1260 * @a wim was not a standalone WIM and was not the first part of a split
1263 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1266 * Prints some basic information about a WIM file. All information printed by
1267 * this function is also printed by wimlib_print_header(), but
1268 * wimlib_print_wim_information() prints some of this information more concisely
1269 * and in a more readable form.
1272 * Pointer to the ::WIMStruct for a WIM file.
1274 * @return This function has no return value.
1276 extern void wimlib_print_wim_information(const WIMStruct *wim);
1279 * Translates a string specifying the name or number of an image in the WIM into
1280 * the number of the image. The images are numbered starting at 1.
1283 * Pointer to the ::WIMStruct for a WIM file.
1284 * @param image_name_or_num
1285 * A string specifying which image. If it begins with a number, it is
1286 * taken to be a string specifying the image number. Otherwise, it is
1287 * taken to be the name of an image, as specified in the XML data for the
1288 * WIM file. It also may be the keyword "all" or the string "*", both of
1289 * which will resolve to ::WIM_ALL_IMAGES.
1292 * If the string resolved to a single existing image, the number of that
1293 * image, counting starting at 1, is returned. If the keyword "all" was
1294 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1297 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1300 * Sets which image in the WIM is marked as bootable.
1303 * Pointer to the ::WIMStruct for a WIM file.
1305 * The number of the image to mark as bootable, or 0 to mark no image as
1307 * @return 0 on success; nonzero on error.
1308 * @retval ::WIMLIB_ERR_INVALID_PARAM
1309 * @a wim was @c NULL.
1310 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1311 * @a boot_idx does not specify an existing image in @a wim, and it was not
1313 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1314 * @a wim is part of a split WIM. We do not support changing the boot
1315 * index of a split WIM.
1317 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1320 * Changes the description of an image in the WIM.
1323 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1324 * standalone WIM or part of a split WIM; however, you should set the same
1325 * description on all parts of a split WIM.
1327 * The number of the image for which to change the description.
1328 * @param description
1329 * The new description to give the image. It may be @c NULL, which
1330 * indicates that the image is to be given no description.
1332 * @return 0 on success; nonzero on error.
1333 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1334 * @a image does not specify a single existing image in @a wim.
1335 * @retval ::WIMLIB_ERR_INVALID_PARAM
1336 * @a wim was @c NULL.
1337 * @retval ::WIMLIB_ERR_NOMEM
1338 * Failed to allocate the memory needed to duplicate the @a description
1341 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1342 const char *description);
1345 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1346 * (something like "Core" or "Ultimate")
1349 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1350 * standalone WIM or part of a split WIM; however, you should set the same
1351 * \<FLAGS\> element on all parts of a split WIM.
1353 * The number of the image for which to change the description.
1355 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1356 * indicates that the image is to be given no \<FLAGS\> element.
1358 * @return 0 on success; nonzero on error.
1359 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1360 * @a image does not specify a single existing image in @a wim.
1361 * @retval ::WIMLIB_ERR_INVALID_PARAM
1362 * @a wim was @c NULL.
1363 * @retval ::WIMLIB_ERR_NOMEM
1364 * Failed to allocate the memory needed to duplicate the @a flags string.
1366 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1369 * Changes the name of an image in the WIM.
1372 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1373 * standalone WIM or part of a split WIM; however, you should set the same
1374 * name on all parts of a split WIM.
1376 * The number of the image for which to change the name.
1378 * The new name to give the image. It must not a nonempty string.
1380 * @return 0 on success; nonzero on error.
1381 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1382 * There is already an image named @a name in @a wim.
1383 * @retval ::WIMLIB_ERR_INVALID_PARAM
1384 * @a name was @c NULL or the empty string, or @a wim was @c NULL.
1385 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1386 * @a image does not specify a single existing image in @a wim.
1387 * @retval ::WIMLIB_ERR_NOMEM
1388 * Failed to allocate the memory needed to duplicate the @a name string.
1390 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1393 * Set the functions that wimlib uses to allocate and free memory.
1395 * These settings are global and not per-WIM.
1397 * The default is to use the default @c malloc() and @c free() from the C
1400 * Please note that some external functions we call still may use the standard
1401 * memory allocation functions.
1403 * @param malloc_func
1404 * A function equivalent to @c malloc() that wimlib will use to allocate
1405 * memory. If @c NULL, the allocator function is set back to the default
1406 * @c malloc() from the C library.
1408 * A function equivalent to @c free() that wimlib will use to free memory.
1409 * If @c NULL, the free function is set back to the default @c free() from
1411 * @param realloc_func
1412 * A function equivalent to @c realloc() that wimlib will use to reallocate
1413 * memory. If @c NULL, the free function is set back to the default @c
1414 * realloc() from the C library.
1415 * @return 0 on success; nonzero on error.
1416 * @retval ::WIMLIB_ERR_UNSUPPORTED
1417 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1418 * so custom memory allocators are unsupported.
1420 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1421 void (*free_func)(void *),
1422 void *(*realloc_func)(void *, size_t));
1425 * Sets whether wimlib is to print error messages to @c stderr when a function
1426 * fails. These error messages may provide information that cannot be
1427 * determined only from the error code that is returned. Not every error will
1428 * result in an error message being printed.
1430 * This setting is global and not per-WIM.
1432 * By default, error messages are not printed.
1434 * @param show_messages
1435 * @c true if error messages are to be printed; @c false if error messages
1436 * are not to be printed.
1438 * @return 0 on success; nonzero on error.
1439 * @retval ::WIMLIB_ERR_UNSUPPORTED
1440 * @a show_messages was @c true, but wimlib was compiled with the @c
1441 * --without-error-messages option. Therefore, error messages cannot be
1444 extern int wimlib_set_print_errors(bool show_messages);
1447 * Splits a WIM into multiple parts.
1450 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1452 * Name of the SWM file to create. This will be the name of the first
1453 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1456 * The maximum size per part, in bytes. It is not guaranteed that this
1457 * will really be the maximum size per part, because some file resources in
1458 * the WIM may be larger than this size, and the WIM file format provides
1459 * no way to split up file resources among multiple WIMs.
1461 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1462 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1464 * @return 0 on success; nonzero on error. This function may return any value
1465 * returned by wimlib_open_wim() as well as the following error codes:
1467 * @retval ::WIMLIB_ERR_WRITE
1468 * An error occurred when trying to write data to one of the split WIMs.
1471 extern int wimlib_split(const char *wimfile, const char *swm_name,
1472 size_t part_size, int flags);
1475 * Unmounts a WIM image that was mounted using wimlib_mount().
1477 * Blocks until it is known whether the mount succeeded or failed.
1479 * To perform this operation, the process calling wimlib_unmount() communicates
1480 * with the process that had called wimlib_mount().
1482 * There is currently a design problem with this function because it is hard to
1483 * know whether the filesystem daemon is still working or whether it has
1484 * crashed, has been killed, or has reached an infinite loop. However, ideally
1485 * there should be no infinite loops or crashes in the code, so this wouldn't be
1486 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1487 * can be very large) is implemented so that this function will not wait forever
1488 * before returning failure.
1491 * The directory that the WIM image was mounted on.
1493 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1494 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1497 * @return 0 on success; nonzero on error.
1498 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1499 * The filesystem daemon was unable to remove the staging directory and the
1500 * temporary files that it contains.
1501 * @retval ::WIMLIB_ERR_FORK
1502 * Could not @c fork() the process.
1503 * @retval ::WIMLIB_ERR_FUSERMOUNT
1504 * The @b fusermount program could not be executed or exited with a failure
1506 * @retval ::WIMLIB_ERR_MQUEUE
1507 * Could not open a POSIX message queue to communicate with the filesystem
1508 * daemon servicing the mounted filesystem, could not send a message
1509 * through the queue, or could not receive a message through the queue.
1510 * @retval ::WIMLIB_ERR_NOMEM
1511 * Failed to allocate needed memory.
1512 * @retval ::WIMLIB_ERR_OPEN
1513 * The filesystem daemon could not open a temporary file for writing the
1515 * @retval ::WIMLIB_ERR_TIMEOUT
1516 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1517 * the process of its exit status, so the WIM file probably was not written
1519 * @retval ::WIMLIB_ERR_READ
1520 * A read error occurred when the filesystem daemon tried to a file from
1521 * the staging directory
1522 * @retval ::WIMLIB_ERR_RENAME
1523 * The filesystem daemon failed to rename the newly written WIM file to the
1524 * original WIM file.
1525 * @retval ::WIMLIB_ERR_WRITE
1526 * A write error occurred when the filesystem daemon was writing to the new
1527 * WIM file, or the filesystem daemon was unable to flush changes that had
1528 * been made to files in the staging directory.
1530 extern int wimlib_unmount(const char *dir, int flags);
1533 * Writes the WIM to a file.
1536 * Pointer to the ::WIMStruct for a WIM file. There may have been
1537 * in-memory changes made to it, which are then reflected in the output
1540 * The path to the file to write the WIM to.
1542 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1544 * @param write_flags
1545 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1546 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1547 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1548 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1549 * is given, the progress of the calculation of the integrity table is
1551 * @param num_threads
1552 * Number of threads to use for compressing data. Autodetected if set to
1553 * 0. Note: if no data compression needs to be done, no threads will be
1554 * created regardless of this parameter (e.g. if writing an uncompressed
1555 * WIM, or exporting an image from a compressed WIM to another WIM of the
1556 * same compression type).
1558 * @return 0 on success; nonzero on error.
1559 * @retval ::WIMLIB_ERR_DECOMPRESSION
1560 * Failed to decompress a metadata or file resource in @a wim.
1561 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1562 * A directory entry in the metadata resource for @a image in @a wim is
1564 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1565 * @a image does not specify a single existing image in @a wim, and is not
1567 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1568 * A file that had previously been scanned for inclusion in the WIM by the
1569 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
1570 * concurrently modified, so it failed the SHA1 message digest check.
1571 * @retval ::WIMLIB_ERR_INVALID_PARAM
1572 * @a wim or @a path was @c NULL.
1573 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1574 * The metadata resource for @a image in @a wim is invalid.
1575 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1576 * The security data for @a image in @a wim is invalid.
1577 * @retval ::WIMLIB_ERR_NOMEM
1578 * Failed to allocate needed memory.
1579 * @retval ::WIMLIB_ERR_OPEN
1580 * Failed to open @a path for writing, or some file resources in @a
1581 * wim refer to files in the outside filesystem, and one of these files
1582 * could not be opened for reading.
1583 * @retval ::WIMLIB_ERR_READ
1584 * An error occurred when trying to read data from the WIM file associated
1585 * with @a wim, or some file resources in @a wim refer to files in the
1586 * outside filesystem, and a read error occurred when reading one of these
1588 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1589 * @a wim is part of a split WIM. You may not call this function on a
1591 * @retval ::WIMLIB_ERR_WRITE
1592 * An error occurred when trying to write data to the new WIM file at @a
1595 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
1596 int write_flags, unsigned num_threads);
1600 #endif /* _WIMLIB_H */