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 /** Specifying this flag overrides the default behavior of wimlib_overwrite()
288 * after one or more calls to wimlib_delete_image(), which is to rebuild the
289 * entire WIM. If you specifiy this flag to wimlib_overwrite() instead, only
290 * minimal changes to correctly remove the image from the WIM will be taken. In
291 * particular, all streams will be left alone, even if they are no longer
292 * references. This is probably not what you want, because almost no space will
293 * be spaced by deleting an image in this way. */
294 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000040
296 /** Mark the image being added as the bootable image of the WIM. */
297 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
299 /** Print the name of each file or directory as it is scanned to be included in
301 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
303 /** Follow symlinks; archive and dump the files they point to. */
304 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000004
306 /** Show progress information when scanning a directory tree */
307 #define WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS 0x00000008
309 /** See documentation for wimlib_export_image(). */
310 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
312 /** Verify the integrity of the WIM if an integrity table is present. */
313 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
315 /** Print progress information when verifying integrity table. */
316 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
318 /** If this flag is not given, an error is issued if the WIM is part of a split
320 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
323 /** When identical files are extracted from the WIM, always hard link them
325 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
327 /** When identical files are extracted from the WIM, always symlink them
329 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
331 /** Print the name of each file as it is extracted from the WIM image. */
332 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
334 /** Read the WIM file sequentially while extracting the image. */
335 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
338 * Possible values of the error code returned by many functions in wimlib.
340 * See the documentation for each wimlib function to see specifically what error
341 * codes can be returned by a given function, and what they mean.
343 enum wimlib_error_code {
344 WIMLIB_ERR_SUCCESS = 0,
345 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
346 WIMLIB_ERR_DECOMPRESSION,
347 WIMLIB_ERR_DELETE_STAGING_DIR,
350 WIMLIB_ERR_FUSERMOUNT,
351 WIMLIB_ERR_IMAGE_COUNT,
352 WIMLIB_ERR_IMAGE_NAME_COLLISION,
353 WIMLIB_ERR_INTEGRITY,
354 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
355 WIMLIB_ERR_INVALID_CHUNK_SIZE,
356 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
357 WIMLIB_ERR_INVALID_DENTRY,
358 WIMLIB_ERR_INVALID_HEADER_SIZE,
359 WIMLIB_ERR_INVALID_IMAGE,
360 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
361 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
362 WIMLIB_ERR_INVALID_PARAM,
363 WIMLIB_ERR_INVALID_RESOURCE_HASH,
364 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
365 WIMLIB_ERR_INVALID_SECURITY_DATA,
371 WIMLIB_ERR_NOT_A_WIM_FILE,
372 WIMLIB_ERR_NO_FILENAME,
380 WIMLIB_ERR_RESOURCE_ORDER,
381 WIMLIB_ERR_SPECIAL_FILE,
382 WIMLIB_ERR_SPLIT_INVALID,
383 WIMLIB_ERR_SPLIT_UNSUPPORTED,
386 WIMLIB_ERR_UNKNOWN_VERSION,
387 WIMLIB_ERR_UNSUPPORTED,
393 /** Used to indicate that no WIM image is currently selected. */
394 #define WIM_NO_IMAGE 0
396 /** Used to specify all images in the WIM. */
397 #define WIM_ALL_IMAGES (-1)
401 * Adds an image to a WIM file from a directory tree on disk.
403 * The directory tree is read immediately for the purpose of constructing a
404 * directory entry tree in-memory. Also, all files are read to calculate their
405 * SHA1 message digests. However, because the directory tree may contain a very
406 * large amount of data, the files themselves are not read into memory
407 * permanently, and instead references to their paths saved. The files are then
408 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
411 * Pointer to the ::WIMStruct for a WIM file to which the image will be
414 * A path to a directory in the outside filesystem. It will become the
415 * root directory for the WIM image.
417 * The name to give the image. This must be non-@c NULL.
419 * Pointer to the contents of an image capture configuration file. If @c
420 * NULL, a default string is used. Please see the manual page for
421 * <b>imagex capture</b> for more information.
423 * Length of the string @a config in bytes. Ignored if @a config is @c
427 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
428 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
429 * marked as bootable is changed to the one being added. If
430 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
431 * printed as it is scanned or captured. If
432 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
433 * directories pointed to by symbolic links are archived rather than the
434 * symbolic links themselves. If ::WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS is
435 * specified, progress information will be printed (distinct from the
436 * verbose information).
438 * @return 0 on success; nonzero on error. On error, changes to @a wim are
439 * discarded so that it appears to be in the same state as when this function
442 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
443 * There is already an image named @a name in @a w.
444 * @retval ::WIMLIB_ERR_INVALID_PARAM
445 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
446 * @retval ::WIMLIB_ERR_NOMEM
447 * Failed to allocate needed memory.
448 * @retval ::WIMLIB_ERR_NOTDIR
449 * @a dir is not a directory.
450 * @retval ::WIMLIB_ERR_OPEN
451 * Failed to open a file or directory in the directory tree rooted at @a
453 * @retval ::WIMLIB_ERR_READ
454 * Failed to read a file in the directory tree rooted at @a dir.
455 * @retval ::WIMLIB_ERR_SPECIAL_FILE
456 * The directory tree rooted at @dir contains a special file that is not a
457 * directory, regular file, or symbolic link.
458 * @retval ::WIMLIB_ERR_STAT
459 * Failed obtain the metadata for a file or directory in the directory tree
461 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
462 * @a wim is part of a split WIM. Adding an image to a split WIM is
465 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
466 const char *name, const char *config,
467 size_t config_len, int flags);
470 * This function is similar to wimlib_add_image(), except instead of capturing
471 * the WIM image from a directory, it is captured from a NTFS volume specified
472 * by @a device. NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
473 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
474 * the reparse points exactly as they are.
476 extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
483 * This function is similar to wimlib_extract_image(), except that @a image may
484 * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
485 * device containing a NTFS volume to apply the image to. NTFS-3g errors are
486 * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
487 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
488 * apply mode we apply the reparse points and hard links exactly as they are in
491 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
492 const char *device, int flags,
493 WIMStruct **additional_swms,
494 unsigned num_additional_swms);
497 * Creates a WIMStruct for a new WIM file.
500 * The type of compression to be used in the new WIM file. Must be
501 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
502 * ::WIM_COMPRESSION_TYPE_XPRESS.
504 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
505 * written to the memory location pointed to by this paramater. The
506 * ::WIMStruct must be freed using using wimlib_free() when finished with
508 * @return 0 on success; nonzero on error.
509 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
510 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
511 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
512 * @retval ::WIMLIB_ERR_NOMEM
513 * Failed to allocate needed memory.
515 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
518 * Deletes an image, or all images, from a WIM file.
520 * All streams referenced by the image(s) being deleted are removed from the
521 * lookup table of the WIM if they are not referenced by any other images in the
525 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
528 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
530 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
531 * to be left unmodified only if @a image specified a single image. If instead
532 * @a image was ::WIM_ALL_IMAGES and @a wim contained more than one image, it's
533 * possible for some but not all of the images to have been deleted when a
534 * failure status is returned.
536 * @retval ::WIMLIB_ERR_DECOMPRESSION
537 * Could not decompress the metadata resource for @a image.
538 * @retval ::WIMLIB_ERR_INVALID_DENTRY
539 * A directory entry in the metadata resource for @a image in the WIM is
541 * @retval ::WIMLIB_ERR_INVALID_IMAGE
542 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
543 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
544 * The metadata resource for @a image in the WIM is invalid.
545 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
546 * The security data for @a image in the WIM is invalid.
547 * @retval ::WIMLIB_ERR_NOMEM
548 * Failed to allocate needed memory.
549 * @retval ::WIMLIB_ERR_READ
550 * Could not read the metadata resource for @a image from the WIM.
551 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
552 * @a wim is part of a split WIM. Deleting an image from a split WIM is
555 extern int wimlib_delete_image(WIMStruct *wim, int image);
558 * Exports an image, or all the images, from a WIM file, into another WIM file.
560 * The destination image is made to share the same dentry tree and security data
561 * structure as the source image. This places some restrictions on additional
562 * functions that may be called. wimlib_mount() may not be called on either the
563 * source image or the destination image without an intervening call to a
564 * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
565 * wimlib_delete_image() on either the source or destination image.
566 * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
567 * src_wim before any calls to functions such as wimlib_write() on @a dest_wim
568 * because @a dest_wim will have references back to @a src_wim.
570 * Previous versions of this function left @a dest_wim in an indeterminate state
571 * on failure. This is no longer the case; all changes to @a dest_wim made by
572 * this function are rolled back on failure.
574 * Previous versions of this function did not allow exporting an image that had
575 * been added by wimlib_add_image(). This is no longer the case; you may now
576 * export an image regardless of how it was added.
578 * Regardless of whether this function succeeds or fails, no user-visible
579 * changes are made to @a src_wim.
582 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
583 * WIM that contains the image(s) being exported.
585 * The image to export from @a src_wim. Can be the number of an image, or
586 * ::WIM_ALL_IMAGES to export all images.
588 * Pointer to the ::WIMStruct for a WIM file that will receive the images
591 * The name to give the exported image in the new WIM file. If left @c NULL,
592 * the name from @a src_wim is used. This parameter must be left @c NULL
593 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
594 * image; in that case, the names are all taken from the @a src_wim.
595 * @param dest_description
596 * The description to give the exported image in the new WIM file. If left
597 * @c NULL, the description from the @a src_wim is used. This parameter must
598 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
599 * more than one image; in that case, the descriptions are all taken from
602 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
603 * bootable, or 0 if which image is marked as bootable in the destination
604 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
605 * there are multiple images in @a src_wim, specifying
606 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
607 * currently marked as bootable in @a src_wim; if that is the case, then
608 * that image is marked as bootable in the destination WIM.
609 * @param additional_swms
610 * Array of pointers to the ::WIMStruct for each additional part in the
611 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
612 * need to be in any particular order, but they must include all parts of
613 * the split WIM other than the first part, which must be provided in the
615 * @param num_additional_swms
616 * Number of additional WIM parts provided in the @a additional_swms array.
617 * This number should be one less than the total number of parts in the
618 * split WIM. Set to 0 if the WIM is a standalone WIM.
620 * @return 0 on success; nonzero on error.
621 * @retval ::WIMLIB_ERR_DECOMPRESSION
622 * Could not decompress the metadata resource for @a src_image
624 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
625 * One or more of the names being given to an exported image was already in
626 * use in the destination WIM.
627 * @retval ::WIMLIB_ERR_INVALID_DENTRY
628 * A directory entry in the metadata resource for @a src_image in @a
629 * src_wim is invalid.
630 * @retval ::WIMLIB_ERR_INVALID_IMAGE
631 * @a src_image does not exist in @a src_wim.
632 * @retval ::WIMLIB_ERR_INVALID_PARAM
633 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
634 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
635 * @a src_wim are marked as bootable; or @a dest_name and/or @a
636 * dest_description were non-<code>NULL</code>, @a src_image was
637 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
638 * or @a dest_wim was @c NULL.
639 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
640 * The metadata resource for @a src_image in @a src_wim is invalid.
641 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
642 * The security data for @a src_image in @a src_wim is invalid.
643 * @retval ::WIMLIB_ERR_NOMEM
644 * Failed to allocate needed memory.
645 * @retval ::WIMLIB_ERR_READ
646 * Could not read the metadata resource for @a src_image from @a src_wim.
647 * @retval ::WIMLIB_ERR_SPLIT_INVALID
648 * The source WIM is a split WIM, but the parts specified do not form a
649 * complete split WIM because they do not include all the parts of the
650 * original WIM, there are duplicate parts, or not all the parts have the
651 * same GUID and compression type.
652 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
653 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
656 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
657 WIMStruct *dest_wim, const char *dest_name,
658 const char *dest_description, int flags,
659 WIMStruct **additional_swms,
660 unsigned num_additional_swms);
663 * Extracts an image, or all images, from a standalone or split WIM file.
666 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
669 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
670 * to specify that all images are to be extracted.
672 * Directory to extract the WIM image(s) to. It is created if it does not
675 * Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
677 * One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
678 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified. These flags cause
679 * extracted files that are identical to be hardlinked or symlinked
680 * together, depending on the flag. These flags override the hard link
681 * groups that are specified in the WIM file itself. If ::WIM_ALL_IMAGES
682 * is provided as the @a image parameter, files may be hardlinked or
683 * symlinked across images if a file is found to occur in more than one
686 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
687 * informational messages to be printed during the extraction, including
688 * the name of each extracted file or directory.
689 * @param additional_swms
690 * Array of pointers to the ::WIMStruct for each additional part in the
691 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
692 * need to be in any particular order, but they must include all parts of
693 * the split WIM other than the first part, which must be provided in the
695 * @param num_additional_swms
696 * Number of additional WIM parts provided in the @a additional_swms array.
697 * This number should be one less than the total number of parts in the
698 * split WIM. Set to 0 if the WIM is a standalone WIM.
700 * @return 0 on success; nonzero on error.
701 * @retval ::WIMLIB_ERR_DECOMPRESSION
702 * Could not decompress a resource (file or metadata) for @a image in @a
704 * @retval ::WIMLIB_ERR_INVALID_DENTRY
705 * A directory entry in the metadata resource for @a image in @a wim is
707 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
708 * The SHA1 message digest of an extracted stream did not match the SHA1
709 * message digest given in the WIM file.
710 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
711 * A resource (file or metadata) for @a image in @a wim is invalid.
712 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
713 * The security data for @a image in @a wim is invalid.
714 * @retval ::WIMLIB_ERR_LINK
715 * Failed to create a symbolic link or a hard link.
716 * @retval ::WIMLIB_ERR_MKDIR
717 * Failed create a needed directory.
718 * @retval ::WIMLIB_ERR_NOMEM
719 * Failed to allocate needed memory.
720 * @retval ::WIMLIB_ERR_OPEN
721 * Could not open one of the files being extracted for writing.
722 * @retval ::WIMLIB_ERR_READ
723 * A unexpected end-of-file or read error occurred when trying to read data
724 * from the WIM file associated with @a wim.
725 * @retval ::WIMLIB_ERR_SPLIT_INVALID
726 * The WIM is a split WIM, but the parts specified do not form a complete
727 * split WIM because they do not include all the parts of the original WIM,
728 * there are duplicate parts, or not all the parts have the same GUID and
730 * @retval ::WIMLIB_ERR_WRITE
731 * Failed to write a file being extracted.
733 extern int wimlib_extract_image(WIMStruct *wim, int image,
734 const char *output_dir, int flags,
735 WIMStruct **additional_swms,
736 unsigned num_additional_swms);
739 * Extracts the XML data for a WIM file to a file stream. Every WIM file
740 * includes a string of XML that describes the images contained in the WIM.
741 * This function works on standalone WIMs as well as split WIM parts.
744 * Pointer to the ::WIMStruct for a WIM file.
746 * @c stdout, or a FILE* opened for writing, to extract the data to.
748 * @return 0 on success; nonzero on error.
749 * @retval ::WIMLIB_ERR_WRITE
750 * Failed to completely write the XML data to @a fp.
752 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
755 * Frees all memory allocated for a WIMStruct and closes all files associated
759 * Pointer to the ::WIMStruct for a WIM file.
761 * @return This function has no return value.
763 extern void wimlib_free(WIMStruct *wim);
766 * Finds which image in a WIM is bootable.
769 * Pointer to the ::WIMStruct for a WIM file.
772 * 0 if no image is marked as bootable, or the number of the image marked
773 * as bootable (numbered starting at 1).
775 extern int wimlib_get_boot_idx(const WIMStruct *wim);
778 * Gets the compression type used in the WIM.
781 * Pointer to the ::WIMStruct for a WIM file
784 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
785 * ::WIM_COMPRESSION_TYPE_XPRESS.
787 extern int wimlib_get_compression_type(const WIMStruct *wim);
790 * Converts a compression type enumeration value into a string.
793 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
794 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
797 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
800 extern const char *wimlib_get_compression_type_string(int ctype);
803 * Converts an error code into a string describing it.
806 * The error code returned by one of wimlib's functions.
809 * Pointer to a statically allocated string describing the error code,
810 * or @c NULL if the error code is not valid.
812 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
815 * Returns the description of the specified image.
818 * Pointer to the ::WIMStruct for a WIM file. It may be either a
819 * standalone WIM or a split WIM part.
821 * The number of the image, numbered starting at 1.
824 * The description of the image, or @c NULL if there is no such image, or
825 * @c NULL if the specified image has no description. The description
826 * string is in library-internal memory and may not be modified or freed;
827 * in addition, the string will become invalid if the description of the
828 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
830 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
833 * Returns the name of the specified image.
836 * Pointer to the ::WIMStruct for a WIM file. It may be either a
837 * standalone WIM or a split WIM part.
839 * The number of the image, numbered starting at 1.
842 * The name of the image, or @c NULL if there is no such image. The name
843 * string is in library-internal memory and may not be modified or freed;
844 * in addition, the string will become invalid if the name of the image is
845 * changed, the image is deleted, or the ::WIMStruct is destroyed.
847 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
851 * Gets the number of images contained in the WIM.
854 * Pointer to the ::WIMStruct for a WIM file. It may be either a
855 * standalone WIM or a split WIM part.
858 * The number of images contained in the WIM file.
860 extern int wimlib_get_num_images(const WIMStruct *wim);
863 * Gets the part number of part of a split WIM.
866 * Pointer to the ::WIMStruct for a WIM file.
867 * @param total_parts_ret
868 * If non-@c NULL, the total number of parts in the split WIM (1 for
869 * non-split WIMs) is written to this location.
872 * The part number of the WIM (1 for non-split WIMs)
874 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
877 * Returns true if the WIM has an integrity table.
880 * Pointer to the ::WIMStruct for a WIM file.
882 * @c true if the WIM has an integrity table; @c false otherwise.
884 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
888 * Determines if an image name is already used by some image in the WIM.
891 * Pointer to the ::WIMStruct for a WIM file.
896 * @c true if there is already an image in @a wim named @a name; @c false
897 * if there is no image named @a name in @a wim. (If @a name is @c NULL,
898 * @c false is returned.)
900 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
903 * Joins a set of split WIMs into a one-part WIM.
906 * An array of strings that give the filenames of all parts of the split
909 * Number of filenames in @a swms.
911 * The path to write the one-part WIM to.
913 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
914 * tables (if present) when opening them, and include an integrity table in
917 * @return 0 on success; nonzero on error. This function may return any value
918 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
919 * as the following error codes:
921 * @retval ::WIMLIB_ERR_SPLIT_INVALID
922 * The split WIMs do not form a valid WIM because they do not include all
923 * the parts of the original WIM, there are duplicate parts, or not all the
924 * parts have the same GUID and compression type.
925 * @retval ::WIMLIB_ERR_WRITE
926 * An error occurred when trying to write data to the new WIM at @a output_path.
928 * Note that this function merely copies the resources, so it will not check to
929 * see if the resources, including the metadata resources, are valid or not.
931 * Also, after this function is called, the only function that may be called on
932 * the ::WIMStruct's in the @a swms array is wimlib_free().
934 extern int wimlib_join(const char **swms, unsigned num_swms,
935 const char *output_path, int flags);
938 * Mounts an image in a WIM file on a directory read-only or read-write.
940 * A daemon will be forked to service the filesystem.
942 * If the mount is read-write, modifications to the WIM are staged in a staging
945 * wimlib_mount() may be called from multiple threads without intervening calls
946 * to wimlib_unmount(), provided that different ::WIMStruct's are used. (This
947 * was not the case for versions of this library 1.0.3 and earlier.)
949 * wimlib_mount() cannot be used on an image that was exported with
950 * wimlib_export_image() while the dentry trees for both images are still in
951 * memory. In addition, wimlib_mount() may not be used to mount an image that
952 * has just been added with wimlib_add_image() or
953 * wimlib_add_image_from_ntfs_volume(), unless the WIM has been written and read
954 * into a new ::WIMStruct.
957 * Pointer to the ::WIMStruct for the WIM file to be mounted.
959 * The number of the image to mount, numbered from 1. It must be an
960 * existing, single image.
962 * The path to an existing directory to mount the image on.
964 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG. If
965 * ::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
966 * read-only. The interface to the WIM named data streams is specified by
967 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
968 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
969 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
970 * the XATTR interface.
971 * @param additional_swms
972 * Array of pointers to the ::WIMStruct for each additional part in the
973 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
974 * need to be in any particular order, but they must include all parts of
975 * the split WIM other than the first part, which must be provided in the
977 * @param num_additional_swms
978 * Number of additional WIM parts provided in the @a additional_swms array.
979 * This number should be one less than the total number of parts in the
980 * split WIM. Set to 0 if the WIM is a standalone WIM.
982 * @return 0 on success; nonzero on error.
983 * @retval ::WIMLIB_ERR_DECOMPRESSION
984 * Could not decompress the metadata resource for @a image in @a wim.
985 * @retval ::WIMLIB_ERR_FUSE
986 * A non-zero status was returned by @c fuse_main().
987 * @retval ::WIMLIB_ERR_INVALID_DENTRY
988 * A directory entry in the metadata resource for @a image in @a wim is
990 * @retval ::WIMLIB_ERR_INVALID_IMAGE
991 * @a image does not specify an existing, single image in @a wim.
992 * @retval ::WIMLIB_ERR_INVALID_PARAM
993 * @a image is shared among multiple ::WIMStruct's as a result of a call to
994 * wimlib_export_image(), or @a image has been added with
995 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
996 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
997 * The metadata resource for @a image in @a wim is invalid.
998 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
999 * The security data for @a image in @a wim is invalid.
1000 * @retval ::WIMLIB_ERR_MKDIR
1001 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
1002 * directory could not be created.
1003 * @retval ::WIMLIB_ERR_NOMEM
1004 * Failed to allocate needed memory.
1005 * @retval ::WIMLIB_ERR_NOTDIR
1006 * Could not determine the current working directory.
1007 * @retval ::WIMLIB_ERR_READ
1008 * An unexpected end-of-file or read error occurred when trying to read
1009 * data from the WIM file associated with @a wim.
1010 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1011 * The WIM is a split WIM, but the parts specified do not form a complete
1012 * split WIM because they do not include all the parts of the original WIM,
1013 * there are duplicate parts, or not all the parts have the same GUID and
1015 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1016 * The WIM is a split WIM and a read-write mount was requested. We only
1017 * support mounting a split WIM read-only.
1019 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
1020 WIMStruct **additional_swms,
1021 unsigned num_additional_swms);
1024 * Opens a WIM file and creates a ::WIMStruct for it.
1027 * The path to the WIM file to open.
1029 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1030 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1031 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
1032 * of the WIM, if it exists, is checked, and the function will fail with an
1033 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1034 * digests of the WIM do not exactly match the corresponding message
1035 * digests given in the integrity table.
1036 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
1037 * be shown if the integrity of the WIM is checked.
1038 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1039 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1040 * returned. (This flag may be removed in the future, in which case no
1041 * error will be issued when opening a split WIM.)
1044 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1045 * is written to the memory location pointed to by this parameter. The
1046 * ::WIMStruct must be freed using using wimlib_free() when finished with
1049 * @return 0 on success; nonzero on error.
1050 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1051 * The lookup table of @a wim_file is compressed. Support for this can be
1052 * added to wimlib if needed, but it appears to be the case that the lookup
1053 * table is never compressed.
1054 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1055 * The WIM is not the non-first part of a split WIM, and the number of
1056 * metadata resources found in the WIM did not match the image count given
1057 * in the WIM header, or the number of <IMAGE> elements in the XML
1058 * data for the WIM did not match the image count given in the WIM header.
1059 * @retval ::WIMLIB_ERR_INTEGRITY
1060 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1061 * wim_file contains an integrity table, but the SHA1 message digest for a
1062 * chunk of the WIM does not match the corresponding message digest given
1063 * in the integrity table.
1064 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1065 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1066 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1067 * The header of @a wim_file says that resources in the WIM are compressed,
1068 * but the header flag indicating LZX or XPRESS compression is not set.
1069 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1070 * The length field of the WIM header is not 208.
1071 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1072 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1073 * wim_file contains an integrity table, but the integrity table is
1075 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1076 * The lookup table for the WIM contained duplicate entries, or it
1077 * contained an entry with a SHA1 message digest of all 0's.
1078 * @retval ::WIMLIB_ERR_NOMEM
1079 * Failed to allocated needed memory.
1080 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1081 * @a wim_file does not begin with the expected magic characters.
1082 * @retval ::WIMLIB_ERR_OPEN
1083 * Failed to open the file @a wim_file for reading.
1084 * @retval ::WIMLIB_ERR_READ
1085 * An unexpected end-of-file or read error occurred when trying to read
1086 * data from @a wim_file.
1087 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1088 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1089 * givin in @a flags.
1090 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1091 * A number other than 0x10d00 is written in the version field of the WIM
1092 * header of @a wim_file.
1093 * @retval ::WIMLIB_ERR_XML
1094 * The XML data for @a wim_file is invalid.
1096 extern int wimlib_open_wim(const char *wim_file, int flags,
1097 WIMStruct **wim_ret);
1100 * Overwrites the file that the WIM was originally read from, with changes made.
1102 * There are two ways that a WIM may be overwritten. The first is to do a full
1103 * rebuild: the new WIM is written to a temporary file and then renamed to the
1104 * original file after it is has been completely written. The temporary file
1105 * currently is made in the same directory as the original WIM file. A full
1106 * rebuild may take a while, but can be used even if images have been modified
1107 * or deleted, will produce a WIM with no holes, and has little chance of
1108 * unintentional data loss because the temporary WIM is fsync()ed before being
1109 * renamed to the original WIM.
1111 * The second way to overwrite a WIM is by appending to the end of it. This can
1112 * be much faster than a full rebuild, but it only works if the only operations
1113 * on the WIM have been to change the header or XML data, or to add new images.
1114 * Writing a WIM in this mode begins with writing any new file resources *after*
1115 * everything in the old WIM, even though this will leave a hole where the old
1116 * lookup table, XML data, and integrity were. This is done so that the WIM
1117 * remains valid even if the operation is aborted mid-write.
1119 * By default, the overwrite mode is chosen based on the past operations
1120 * performed on the WIM. Use the flag ::WIMLIB_WRITE_FLAG_REBUILD to explicitly
1121 * request a full rebuild.
1123 * In the temporary-file overwrite mode, no changes are made to the WIM on
1124 * failure, and the temporary file is deleted (if possible). Abnormal
1125 * termination of the program will result in the temporary file being orphaned.
1126 * In the direct append mode, the WIM is truncated to the original length on
1127 * failure, while abnormal termination of the program will result in extra data
1128 * appended to the original WIM, but it will still be a valid WIM.
1131 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1132 * been in-memory changes made to it, which are then reflected in the
1134 * @param write_flags
1135 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1136 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1137 * @param num_threads
1138 * Number of threads to use for compression (see wimlib_write()).
1140 * @return 0 on success; nonzero on error. This function may return any value
1141 * returned by wimlib_write() as well as the following error codes:
1142 * @retval ::WIMLIB_ERR_NO_FILENAME
1143 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1144 * than a WIM read with wimlib_open_wim().
1145 * @retval ::WIMLIB_ERR_RENAME
1146 * The temporary file that the WIM was written to could not be renamed to
1147 * the original filename of @a wim.
1148 * @retval ::WIMLIB_ERR_REOPEN
1149 * The WIM was overwritten successfully, but it could not be re-opened
1150 * read-only. Therefore, the resources in the WIM can no longer be
1151 * accessed, so this limits the functions that can be called on @a wim
1152 * before calling wimlib_free().
1154 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1155 unsigned num_threads);
1158 * This function is deprecated; call wimlib_overwrite() instead.
1159 * (wimlib_overwrite() no longer rebuilds the full WIM unless it has to or is
1160 * specified explicitly with ::WIMLIB_WRITE_FLAG_REBUILD)
1162 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags);
1165 * Prints information about one image, or all images, contained in a WIM.
1168 * Pointer to the ::WIMStruct for a WIM file.
1170 * The image about which to print information. Can be the number of an
1171 * image, or ::WIM_ALL_IMAGES to print information about all images in the
1174 * @return This function has no return value. No error checking is done when
1175 * printing the information. If @a image is invalid, an error message is
1178 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1181 * Prints the full paths to all files contained in an image, or all images, in a
1185 * Pointer to the ::WIMStruct for a WIM file.
1187 * Which image to print files for. Can be the number of an image, or
1188 * ::WIM_ALL_IMAGES to print the files contained in all images.
1190 * @return 0 on success; nonzero on error.
1191 * @retval ::WIMLIB_ERR_DECOMPRESSION
1192 * The metadata resource for one of the specified images could not be
1194 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1195 * A directory entry in the metadata resource for one of the specified
1196 * images is invaled.
1197 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1198 * @a image does not specify a valid image in @a wim, and is not
1200 * @retval ::WIMLIB_ERR_INVALID_PARAM
1201 * @a wim was @c NULL.
1202 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1203 * The metadata resource for one of the specified images is invalid.
1204 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1205 * The security data for one of the specified images is invalid.
1206 * @retval ::WIMLIB_ERR_NOMEM
1207 * Failed to allocate needed memory.
1208 * @retval ::WIMLIB_ERR_READ
1209 * An unexpected read error or end-of-file occurred when reading the
1210 * metadata resource for one of the specified images.
1211 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1212 * @a wim was not a standalone WIM and was not the first part of a split
1215 extern int wimlib_print_files(WIMStruct *wim, int image);
1218 * Prints detailed information from the header of a WIM file.
1221 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1222 * standalone WIM or part of a split WIM.
1224 * @return This function has no return value.
1227 extern void wimlib_print_header(const WIMStruct *wim);
1230 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1231 * digests, as found in the directory entry tree in the WIM file, to file
1232 * resources in the WIM file. This table includes one entry for each unique
1233 * file in the WIM, so it can be quite long. There is only one lookup table per
1237 * Pointer to the ::WIMStruct for a WIM file.
1239 * @return This function has no return value.
1241 extern void wimlib_print_lookup_table(WIMStruct *wim);
1244 * Prints the metadata of the specified image in a WIM file. The metadata
1245 * consists of the security data as well as the directory entry tree, and each
1246 * image has its own metadata.
1249 * Pointer to the ::WIMStruct for a WIM file.
1251 * Which image to print the metadata for. Can be the number of an image,
1252 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1254 * @return 0 on success; nonzero on error.
1255 * @retval ::WIMLIB_ERR_DECOMPRESSION
1256 * The metadata resource for one of the specified images could not be
1258 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1259 * A directory entry in the metadata resource for one of the specified
1260 * images is invaled.
1261 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1262 * @a image does not specify a valid image in @a wim, and is not
1264 * @retval ::WIMLIB_ERR_INVALID_PARAM
1265 * @a wim was @c NULL.
1266 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1267 * The metadata resource for one of the specified images is invalid.
1268 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1269 * The security data for one of the specified images is invalid.
1270 * @retval ::WIMLIB_ERR_NOMEM
1271 * Failed to allocate needed memory.
1272 * @retval ::WIMLIB_ERR_READ
1273 * An unexpected read error or end-of-file occurred when reading the
1274 * metadata resource for one of the specified images.
1275 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1276 * @a wim was not a standalone WIM and was not the first part of a split
1279 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1282 * Prints some basic information about a WIM file. All information printed by
1283 * this function is also printed by wimlib_print_header(), but
1284 * wimlib_print_wim_information() prints some of this information more concisely
1285 * and in a more readable form.
1288 * Pointer to the ::WIMStruct for a WIM file.
1290 * @return This function has no return value.
1292 extern void wimlib_print_wim_information(const WIMStruct *wim);
1295 * Translates a string specifying the name or number of an image in the WIM into
1296 * the number of the image. The images are numbered starting at 1.
1299 * Pointer to the ::WIMStruct for a WIM file.
1300 * @param image_name_or_num
1301 * A string specifying which image. If it begins with a number, it is
1302 * taken to be a string specifying the image number. Otherwise, it is
1303 * taken to be the name of an image, as specified in the XML data for the
1304 * WIM file. It also may be the keyword "all" or the string "*", both of
1305 * which will resolve to ::WIM_ALL_IMAGES.
1308 * If the string resolved to a single existing image, the number of that
1309 * image, counting starting at 1, is returned. If the keyword "all" was
1310 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1313 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1316 * Sets which image in the WIM is marked as bootable.
1319 * Pointer to the ::WIMStruct for a WIM file.
1321 * The number of the image to mark as bootable, or 0 to mark no image as
1323 * @return 0 on success; nonzero on error.
1324 * @retval ::WIMLIB_ERR_INVALID_PARAM
1325 * @a wim was @c NULL.
1326 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1327 * @a boot_idx does not specify an existing image in @a wim, and it was not
1329 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1330 * @a wim is part of a split WIM. We do not support changing the boot
1331 * index of a split WIM.
1333 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1336 * Changes the description of an image in the WIM.
1339 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1340 * standalone WIM or part of a split WIM; however, you should set the same
1341 * description on all parts of a split WIM.
1343 * The number of the image for which to change the description.
1344 * @param description
1345 * The new description to give the image. It may be @c NULL, which
1346 * indicates that the image is to be given no description.
1348 * @return 0 on success; nonzero on error.
1349 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1350 * @a image does not specify a single existing image in @a wim.
1351 * @retval ::WIMLIB_ERR_INVALID_PARAM
1352 * @a wim was @c NULL.
1353 * @retval ::WIMLIB_ERR_NOMEM
1354 * Failed to allocate the memory needed to duplicate the @a description
1357 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1358 const char *description);
1361 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1362 * (something like "Core" or "Ultimate")
1365 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1366 * standalone WIM or part of a split WIM; however, you should set the same
1367 * \<FLAGS\> element on all parts of a split WIM.
1369 * The number of the image for which to change the description.
1371 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1372 * indicates that the image is to be given no \<FLAGS\> element.
1374 * @return 0 on success; nonzero on error.
1375 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1376 * @a image does not specify a single existing image in @a wim.
1377 * @retval ::WIMLIB_ERR_INVALID_PARAM
1378 * @a wim was @c NULL.
1379 * @retval ::WIMLIB_ERR_NOMEM
1380 * Failed to allocate the memory needed to duplicate the @a flags string.
1382 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1385 * Changes the name of an image in the WIM.
1388 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1389 * standalone WIM or part of a split WIM; however, you should set the same
1390 * name on all parts of a split WIM.
1392 * The number of the image for which to change the name.
1394 * The new name to give the image. It must not a nonempty string.
1396 * @return 0 on success; nonzero on error.
1397 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1398 * There is already an image named @a name in @a wim.
1399 * @retval ::WIMLIB_ERR_INVALID_PARAM
1400 * @a name was @c NULL or the empty string, or @a wim was @c NULL.
1401 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1402 * @a image does not specify a single existing image in @a wim.
1403 * @retval ::WIMLIB_ERR_NOMEM
1404 * Failed to allocate the memory needed to duplicate the @a name string.
1406 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1409 * Set the functions that wimlib uses to allocate and free memory.
1411 * These settings are global and not per-WIM.
1413 * The default is to use the default @c malloc() and @c free() from the C
1416 * Please note that some external functions we call still may use the standard
1417 * memory allocation functions.
1419 * @param malloc_func
1420 * A function equivalent to @c malloc() that wimlib will use to allocate
1421 * memory. If @c NULL, the allocator function is set back to the default
1422 * @c malloc() from the C library.
1424 * A function equivalent to @c free() that wimlib will use to free memory.
1425 * If @c NULL, the free function is set back to the default @c free() from
1427 * @param realloc_func
1428 * A function equivalent to @c realloc() that wimlib will use to reallocate
1429 * memory. If @c NULL, the free function is set back to the default @c
1430 * realloc() from the C library.
1431 * @return 0 on success; nonzero on error.
1432 * @retval ::WIMLIB_ERR_UNSUPPORTED
1433 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1434 * so custom memory allocators are unsupported.
1436 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1437 void (*free_func)(void *),
1438 void *(*realloc_func)(void *, size_t));
1441 * Sets whether wimlib is to print error messages to @c stderr when a function
1442 * fails. These error messages may provide information that cannot be
1443 * determined only from the error code that is returned. Not every error will
1444 * result in an error message being printed.
1446 * This setting is global and not per-WIM.
1448 * By default, error messages are not printed.
1450 * @param show_messages
1451 * @c true if error messages are to be printed; @c false if error messages
1452 * are not to be printed.
1454 * @return 0 on success; nonzero on error.
1455 * @retval ::WIMLIB_ERR_UNSUPPORTED
1456 * @a show_messages was @c true, but wimlib was compiled with the @c
1457 * --without-error-messages option. Therefore, error messages cannot be
1460 extern int wimlib_set_print_errors(bool show_messages);
1463 * Splits a WIM into multiple parts.
1466 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1468 * Name of the SWM file to create. This will be the name of the first
1469 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1472 * The maximum size per part, in bytes. It is not guaranteed that this
1473 * will really be the maximum size per part, because some file resources in
1474 * the WIM may be larger than this size, and the WIM file format provides
1475 * no way to split up file resources among multiple WIMs.
1477 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1478 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1480 * @return 0 on success; nonzero on error. This function may return any value
1481 * returned by wimlib_open_wim() as well as the following error codes:
1483 * @retval ::WIMLIB_ERR_WRITE
1484 * An error occurred when trying to write data to one of the split WIMs.
1487 extern int wimlib_split(const char *wimfile, const char *swm_name,
1488 size_t part_size, int flags);
1491 * Unmounts a WIM image that was mounted using wimlib_mount().
1493 * Blocks until it is known whether the mount succeeded or failed.
1495 * To perform this operation, the process calling wimlib_unmount() communicates
1496 * with the process that had called wimlib_mount().
1498 * There is currently a design problem with this function because it is hard to
1499 * know whether the filesystem daemon is still working or whether it has
1500 * crashed, has been killed, or has reached an infinite loop. However, ideally
1501 * there should be no infinite loops or crashes in the code, so this wouldn't be
1502 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1503 * can be very large) is implemented so that this function will not wait forever
1504 * before returning failure.
1507 * The directory that the WIM image was mounted on.
1509 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1510 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1513 * @return 0 on success; nonzero on error.
1514 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1515 * The filesystem daemon was unable to remove the staging directory and the
1516 * temporary files that it contains.
1517 * @retval ::WIMLIB_ERR_FORK
1518 * Could not @c fork() the process.
1519 * @retval ::WIMLIB_ERR_FUSERMOUNT
1520 * The @b fusermount program could not be executed or exited with a failure
1522 * @retval ::WIMLIB_ERR_MQUEUE
1523 * Could not open a POSIX message queue to communicate with the filesystem
1524 * daemon servicing the mounted filesystem, could not send a message
1525 * through the queue, or could not receive a message through the queue.
1526 * @retval ::WIMLIB_ERR_NOMEM
1527 * Failed to allocate needed memory.
1528 * @retval ::WIMLIB_ERR_OPEN
1529 * The filesystem daemon could not open a temporary file for writing the
1531 * @retval ::WIMLIB_ERR_TIMEOUT
1532 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1533 * the process of its exit status, so the WIM file probably was not written
1535 * @retval ::WIMLIB_ERR_READ
1536 * A read error occurred when the filesystem daemon tried to a file from
1537 * the staging directory
1538 * @retval ::WIMLIB_ERR_RENAME
1539 * The filesystem daemon failed to rename the newly written WIM file to the
1540 * original WIM file.
1541 * @retval ::WIMLIB_ERR_WRITE
1542 * A write error occurred when the filesystem daemon was writing to the new
1543 * WIM file, or the filesystem daemon was unable to flush changes that had
1544 * been made to files in the staging directory.
1546 extern int wimlib_unmount(const char *dir, int flags);
1549 * Writes the WIM to a file.
1552 * Pointer to the ::WIMStruct for a WIM file. There may have been
1553 * in-memory changes made to it, which are then reflected in the output
1556 * The path to the file to write the WIM to.
1558 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1560 * @param write_flags
1561 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1562 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1563 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1564 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1565 * is given, the progress of the calculation of the integrity table is
1567 * @param num_threads
1568 * Number of threads to use for compressing data. Autodetected if set to
1569 * 0. Note: if no data compression needs to be done, no threads will be
1570 * created regardless of this parameter (e.g. if writing an uncompressed
1571 * WIM, or exporting an image from a compressed WIM to another WIM of the
1572 * same compression type).
1574 * @return 0 on success; nonzero on error.
1575 * @retval ::WIMLIB_ERR_DECOMPRESSION
1576 * Failed to decompress a metadata or file resource in @a wim.
1577 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1578 * A directory entry in the metadata resource for @a image in @a wim is
1580 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1581 * @a image does not specify a single existing image in @a wim, and is not
1583 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1584 * A file that had previously been scanned for inclusion in the WIM by the
1585 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
1586 * concurrently modified, so it failed the SHA1 message digest check.
1587 * @retval ::WIMLIB_ERR_INVALID_PARAM
1588 * @a wim or @a path was @c NULL.
1589 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1590 * The metadata resource for @a image in @a wim is invalid.
1591 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1592 * The security data for @a image in @a wim is invalid.
1593 * @retval ::WIMLIB_ERR_NOMEM
1594 * Failed to allocate needed memory.
1595 * @retval ::WIMLIB_ERR_OPEN
1596 * Failed to open @a path for writing, or some file resources in @a
1597 * wim refer to files in the outside filesystem, and one of these files
1598 * could not be opened for reading.
1599 * @retval ::WIMLIB_ERR_READ
1600 * An error occurred when trying to read data from the WIM file associated
1601 * with @a wim, or some file resources in @a wim refer to files in the
1602 * outside filesystem, and a read error occurred when reading one of these
1604 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1605 * @a wim is part of a split WIM. You may not call this function on a
1607 * @retval ::WIMLIB_ERR_WRITE
1608 * An error occurred when trying to write data to the new WIM file at @a
1611 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
1612 int write_flags, unsigned num_threads);
1616 #endif /* _WIMLIB_H */