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 Lesser General Public License as published by the Free
14 * Software Foundation; either version 2.1 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 Lesser General Public License for more
22 * You should have received a copy of the GNU Lesser 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 * The main intended use of wimlib is to create customized images of Windows PE,
38 * the Windows Preinstallation Environment, without having to rely on Windows.
39 * Windows PE, which is the operating system that runs when you boot from the
40 * Windows Vista or Windows 7 DVD, is a lightweight version of Windows that can
41 * run entirely from memory. It can be used to install Windows from local media
42 * or a network drive or perform maintenance.
44 * You can find Windows PE on the installation media for Windows Vista, Windows
45 * 7, and Windows 8. The Windows PE image itself is a WIM file, @c
46 * sources/boot.wim, on the ISO filesystem. Windows PE can also be found in the
47 * Windows Automated Installation Kit (WAIK) inside the @c WinPE.cab file, which
48 * you can extract if you install the @c cabextract program.
50 * \section format WIM files
52 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
53 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
54 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
55 * Both are based on LZ77 and Huffman encoding, and both are supported by
58 * Unlike ZIP files, WIM files can contain multiple independent toplevel
59 * directory trees known as @a images. While each image has its own metadata,
60 * files are not duplicated for each image; instead, each file is included only
61 * once in the entire WIM. Microsoft did this so that in one WIM file, they
62 * could do things like have 5 different versions of Windows that are almost
65 * WIM files may contain a integrity table. The integrity table, if it exists,
66 * is located at the end of the WIM file and contains SHA1 message digests of
67 * 10MB chunks of the WIM.
69 * Microsoft provides documentation for the WIM file format, XPRESS compression
70 * format, and LZX compression format. However, there are errors and omissions
71 * in some places in their documentation.
73 * \section starting Getting Started
75 * wimlib uses the GNU autotools, so it should be easy to install with
76 * <code>configure && make && sudo make install</code>, provided that you have
77 * @c libxml2 and @c libfuse installed. To use wimlib in a program after
78 * installing it, include @c wimlib.h and link your program with @c -lwim.
80 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.
82 * All functions in wimlib's public API are prefixed with @c wimlib. Most
83 * return an integer error code on failure. Use wimlib_get_error_string() to
84 * get a string that describes an error code. wimlib also can print error
85 * messages itself when an error happens, and these may be more informative than
86 * the error code; to enable this, call wimlib_set_print_errors().
88 * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
89 * following exceptions: wimlib_set_print_errors() and
90 * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
91 * used by one ::WIMStruct at a time.
93 * To open an existing WIM, use wimlib_open_wim().
95 * To create a new WIM that initially contains no images, use
96 * wimlib_create_new_wim().
98 * To add an image to a WIM file from a directory tree on your filesystem, call
99 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
100 * wimlib_open_wim() or from wimlib_create_new_wim().
102 * To extract an image from a WIM file, call wimlib_set_output_dir() to set the
103 * output directory, then call wimlib_extract_image().
105 * wimlib supports mounting WIM files either read-only or read-write. Mounting
106 * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
107 * Mounting can be done without root privileges because it is implemented using
108 * FUSE (Filesystem in Userspace). If wimlib is compiled with the
109 * <code>--without-fuse</code> flag, these functions will be available but will
112 * After creating or modifying a WIM file, you can write it to a file using
113 * wimlib_write(). Alternatively, if the WIM was originally read from a file,
114 * you can use wimlib_overwrite() to overwrite the original file. In some
115 * cases, wimlib_overwrite_xml_and_header() can be used instead.
117 * After you are done with the WIM file, use wimlib_free() to free all memory
118 * associated with a ::WIMStruct and close all files associated with it.
120 * To see an example of how to use wimlib, see the file
121 * @c programs/imagex.c in wimlib's source tree.
123 * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
126 * \section imagex imagex
128 * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
130 * \section mkwinpeimg mkwinpeimg
132 * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
135 * \section Limitations
137 * While wimlib supports the main features of WIM files, wimlib currently has
138 * the following limitations:
139 * - wimlib does not support modifying or creating "security data", which
140 * describes the access rights of the files in the WIM. This data is very
141 * Windows-specific, and it would be difficult to do anything with it.
142 * Microsoft's software can still read a WIM without security data, including
143 * a boot.wim for Windows PE, but <b>do not expect to be able to use wimlib to
144 * image a Windows installation and preserve file attributes</b>. However, by
145 * default, wimlib will preserve security data for existing WIMs.
146 * - There is no way to directly extract or mount split WIMs.
147 * - There is not yet any code to verify that there are no collisions between
148 * different files that happen to have the same SHA1 message digest.
149 * This is extremely unlikely, but could result in something bad such as a
150 * file going missing.
151 * - Alternate stream entries for directory entries are ignored.
152 * - Different versions of the WIM file format, if they even exist, are
153 * unsupported. Let me know if you notice WIM files with a different version.
154 * - Chunk sizes other than 32768 are unsupported (except for uncompressed WIMs,
155 * for which the chunk size field is ignored). As far as I can tell, other
156 * chunk sizes are not used in compressed WIMs. Let me know if you find a WIM
157 * file with a different chunk size.
158 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
159 * make certain Windows-specific modifications to a Windows PE image, such as
160 * adding a driver or Windows component. Such a tool could conceivably be
161 * implemented on top of wimlib, although it likely would be hard to implement
162 * because it would have to do very Windows-specific things such as
163 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
164 * script for a similar purpose, however. With regards to adding drivers to
165 * Windows PE, you have the option of putting them anywhere in the Windows PE
166 * image, then loading them after boot using @b drvload.exe.
167 * - There is not yet a way to extract specific files or directories from a WIM
168 * file without mounting it, or to add, remove, or modify files in a WIM
169 * without mounting it, other than by adding or removing an entire image. I
170 * can implement this if requested, but I intend the FUSE mount feature to be
171 * used for this purpose, as it is easy to do these things in whatever way you
172 * want after the image is mounted.
174 * Currently, Microsoft's @a image.exe can create slightly smaller WIM files
175 * than wimlib when using maximum (LZX) compression because it knows how to
176 * split up LZX compressed blocks, which is not yet implemented in wimlib.
178 * wimlib is experimental and likely contains bugs; use Microsoft's @a
179 * imagex.exe if you want to make sure your WIM files are made "correctly".
181 * \section legal License
183 * The wimlib library is licensed under the GNU Lesser General Public License
184 * version 2.1 or later.
186 * @b imagex and @b mkwinpeiso are licensed under the GNU General Public License
187 * version 3 or later.
197 #ifndef _WIMLIB_INTERNAL_H
199 * Opaque structure that represents a WIM file.
201 typedef struct WIMStruct WIMStruct;
205 * Specifies the way in which identical files are linked when extracting
206 * image(s) from the WIM.
209 /** Hard link identical files when extracting files from the WIM. */
210 WIM_LINK_TYPE_HARD = 0,
211 /** Symbolic link identical files when extracting files from the WIM. */
212 WIM_LINK_TYPE_SYMBOLIC = 1,
213 /** Do not create links when extracting identical files from the WIM (default).
215 WIM_LINK_TYPE_NONE = 2,
219 * Specifies the compression type of a WIM file.
222 enum wim_compression_type {
223 /** An invalid compression type. */
224 WIM_COMPRESSION_TYPE_INVALID = -1,
226 /** The WIM does not include any compressed resources. */
227 WIM_COMPRESSION_TYPE_NONE = 0,
229 /** Compressed resources in the WIM use LZX compression. */
230 WIM_COMPRESSION_TYPE_LZX = 1,
232 /** Compressed resources in the WIM use XPRESS compression. */
233 WIM_COMPRESSION_TYPE_XPRESS = 2,
236 /** Mount the WIM read-write. */
237 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
239 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
240 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
242 /** Do not allow accessing alternate data streams. */
243 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000010
245 /** Access alternate data streams through extended file attributes. This is the
247 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000020
249 /** Access alternate data streams by specifying the file name, a colon, then the
250 * alternate file stream name. */
251 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
253 /** Include an integrity table in the new WIM being written during the unmount.
254 * Ignored for read-only mounts. */
255 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
257 /** Unless this flag is given, changes to a mounted WIM are discarded. Ignored
258 * for read-only mounts. */
259 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
261 /** Include an integrity table in the new WIM file. */
262 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
264 /** Print progress information when writing the integrity table. */
265 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS 0x00000002
267 /** Print file paths as we write then */
268 #define WIMLIB_WRITE_FLAG_VERBOSE 0x00000004
270 /** Mark the image being added as the bootable image of the WIM. */
271 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
273 /** Print the name of each file or directory as it is scanned to be included in
275 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
277 /** Apply NTFS-specific information to the captured WIM image. This flag can
278 * only be specified if the directory being captured is on a NTFS filesystem
279 * mounted with NTFS-3g, and wimlib was compiled with support for NTFS-3g */
280 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000004
282 /** Follow symlinks; archive and dump the files they point to. */
283 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000008
285 /** See documentation for wimlib_export_image(). */
286 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
288 /** Verify the integrity of the WIM if an integrity table is present. */
289 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
291 /** Print progress information when verifying integrity table. */
292 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
294 /** If this flag is not given, an error is issued if the WIM is part of a split
296 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
299 /** When identical files are extracted from the WIM, hard link them together. */
300 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
302 /** When identical files are extracted from the WIM, symlink them together. */
303 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
305 /** Print the name of each file as it is extracted from the WIM image. */
306 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
309 * Possible values of the error code returned by many functions in wimlib.
311 * See the documentation for each wimlib function to see specifically what error
312 * codes can be returned by a given function, and what they mean.
314 enum wimlib_error_code {
315 WIMLIB_ERR_SUCCESS = 0,
316 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
317 WIMLIB_ERR_DECOMPRESSION,
318 WIMLIB_ERR_DELETE_STAGING_DIR,
321 WIMLIB_ERR_FUSERMOUNT,
322 WIMLIB_ERR_IMAGE_COUNT,
323 WIMLIB_ERR_IMAGE_NAME_COLLISION,
324 WIMLIB_ERR_INTEGRITY,
325 WIMLIB_ERR_INVALID_CHUNK_SIZE,
326 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
327 WIMLIB_ERR_INVALID_DENTRY,
328 WIMLIB_ERR_INVALID_HEADER_SIZE,
329 WIMLIB_ERR_INVALID_IMAGE,
330 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
331 WIMLIB_ERR_INVALID_PARAM,
332 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
333 WIMLIB_ERR_INVALID_SECURITY_DATA,
339 WIMLIB_ERR_NOT_A_WIM_FILE,
341 WIMLIB_ERR_NO_FILENAME,
348 WIMLIB_ERR_SPECIAL_FILE,
349 WIMLIB_ERR_SPLIT_INVALID,
350 WIMLIB_ERR_SPLIT_UNSUPPORTED,
353 WIMLIB_ERR_UNKNOWN_VERSION,
354 WIMLIB_ERR_UNSUPPORTED,
360 /** Used to indicate that no WIM image is currently selected. */
361 #define WIM_NO_IMAGE 0
363 /** Used to specify all images in the WIM. */
364 #define WIM_ALL_IMAGES (-1)
368 * Adds an image to a WIM file from a directory tree on disk.
370 * The directory tree is read immediately for the purpose of constructing a
371 * directory entry tree in-memory. Also, all files are read to calculate their
372 * SHA1 message digests. However, because the directory tree may contain a very
373 * large amount of data, the files themselves are not read into memory
374 * permanently, and instead references to their paths saved. This means that
375 * the directory tree must not be modified, other than by adding entirely new
376 * files or directories, before executing a call to wimlib_write() or
377 * wimlib_overwrite(). Otherwise, wimlib_write() may fail or incorrect files may
378 * be included in the WIM written by wimlib_write().
381 * Pointer to the ::WIMStruct for a WIM file to which the image will be
384 * A path to a directory in the outside filesystem. It will become the
385 * root directory for the WIM image.
387 * The name to give the image. This must be non-@c NULL.
389 * The description to give the image. This parameter may be left @c
390 * NULL, in which case no description is given to the image.
391 * @param flags_element
392 * What to put in the <FLAGS> element for the image's XML data. This
393 * parameter may be left @c NULL, in which case no <FLAGS> element is
394 * given to the image.
396 * If set to ::WIMLIB_ADD_IMAGE_FLAG_BOOT, change the image in @a wim
397 * marked as bootable to the one being added. Otherwise, leave the boot
400 * @return 0 on success; nonzero on error. On error, changes to @a wim are
401 * discarded so that it appears to be in the same state as when this function
404 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
405 * There is already an image named @a name in @a w.
406 * @retval ::WIMLIB_ERR_INVALID_PARAM
407 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
408 * @retval ::WIMLIB_ERR_NOMEM
409 * Failed to allocate needed memory.
410 * @retval ::WIMLIB_ERR_NOTDIR
411 * @a dir is not a directory.
412 * @retval ::WIMLIB_ERR_OPEN
413 * Failed to open a file or directory in the directory tree rooted at @a
415 * @retval ::WIMLIB_ERR_READ
416 * Failed to read a file in the directory tree rooted at @a dir.
417 * @retval ::WIMLIB_ERR_STAT
418 * Failed obtain the metadata for a file or directory in the directory tree
422 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
423 const char *name, const char *description,
424 const char *flags_element, int flags);
426 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
427 const char *device, int flags);
430 * Creates a WIMStruct for a new WIM file.
433 * The type of compression to be used in the new WIM file. Must be
434 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
435 * ::WIM_COMPRESSION_TYPE_XPRESS.
437 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
438 * written to the memory location pointed to by this paramater. The
439 * ::WIMStruct must be freed using using wimlib_free() when finished with
441 * @return 0 on success; nonzero on error.
442 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
443 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
444 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
445 * @retval ::WIMLIB_ERR_NOMEM
446 * Failed to allocate needed memory.
448 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
451 * Deletes an image, or all images, from a WIM file.
453 * All file resources referenced by the image(s) being deleted are removed from
454 * the WIM if they are not referenced by any other images in the WIM.
457 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
460 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
462 * @return 0 on success; nonzero on error. On error, @a wim is left in an
463 * indeterminate state and should be freed with wimlib_free().
464 * @retval ::WIMLIB_ERR_DECOMPRESSION
465 * Could not decompress the metadata resource for @a image.
466 * @retval ::WIMLIB_ERR_INVALID_DENTRY
467 * A directory entry in the metadata resource for @a image in the WIM is
469 * @retval ::WIMLIB_ERR_INVALID_IMAGE
470 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
471 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
472 * The metadata resource for @a image in the WIM is invalid.
473 * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
474 * @retval ::WIMLIB_ERR_READ
475 * Could not read the metadata resource for @a image from the WIM.
477 extern int wimlib_delete_image(WIMStruct *wim, int image);
480 * Copies an image, or all the images, from a WIM file, into another WIM file.
483 * Pointer to the ::WIMStruct for a WIM file that contains the image(s)
486 * The image to export from @a src_wim. Can be the number of an image, or
487 * ::WIM_ALL_IMAGES to export all images.
489 * Pointer to the ::WIMStruct for a WIM filethat will receive the images being
492 * The name to give the exported image in the new WIM file. If left @c NULL,
493 * the name from @a src_wim is used. This parameter must be left @c NULL
494 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
495 * image; in that case, the names are all taken from the @a src_wim.
496 * @param dest_description
497 * The description to give the exported image in the new WIM file. If left
498 * @c NULL, the description from the @a src_wim is used. This parameter must
499 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
500 * more than one image; in that case, the descriptions are all taken from
503 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
504 * bootable, or 0 if which image is marked as bootable in the destination
505 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
506 * there are multiple images in @a src_wim, specifying
507 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
508 * currently marked as bootable in @a src_wim; if that is the case, then
509 * that image is marked as bootable in the destination WIM.
511 * @return 0 on success; nonzero on error. On error, @dest_wim is left in an
512 * indeterminate state and should be freed with wimlib_free().
513 * @retval ::WIMLIB_ERR_DECOMPRESSION
514 * Could not decompress the metadata resource for @a src_image
516 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
517 * One or more of the names being given to an exported image was already in
518 * use in the destination WIM.
519 * @retval ::WIMLIB_ERR_INVALID_DENTRY
520 * A directory entry in the metadata resource for @a src_image in @a
521 * src_wim is invalid.
522 * @retval ::WIMLIB_ERR_INVALID_IMAGE
523 * @a src_image does not exist in @a src_wim.
524 * @retval ::WIMLIB_ERR_INVALID_PARAM
525 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
526 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
527 * @a src_wim are marked as bootable; or @a dest_name and/or @a
528 * dest_description were non-<code>NULL</code>, @a src_image was
529 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images.
530 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
531 * The metadata resource for @a src_image in @a src_wim is invalid.
532 * @retval ::WIMLIB_ERR_NOMEM
533 * Failed to allocate needed memory.
534 * @retval ::WIMLIB_ERR_READ
535 * Could not read the metadata resource for @a src_image from @a src_wim.
537 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
538 WIMStruct *dest_wim, const char *dest_name,
539 const char *dest_description, int flags);
542 * Extracts an image, or all images, from a WIM file.
544 * The output directory must have been previously set with
545 * wimlib_set_output_dir().
547 * The link type used for extracted files is that specified by a previous call
548 * to wimlib_set_link_type(), or ::WIM_LINK_TYPE_NONE by default.
551 * Pointer to the ::WIMStruct for a WIM file.
553 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
554 * to specify that all images are to be extracted.
556 * @return 0 on success; nonzero on error.
557 * @retval ::WIMLIB_ERR_DECOMPRESSION
558 * Could not decompress a resource (file or metadata) for @a image in @a
560 * @retval ::WIMLIB_ERR_INVALID_DENTRY
561 * A directory entry in the metadata resource for @a image in @a wim is
563 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
564 * A resource (file or metadata) for @a image in @a wim is invalid.
565 * @retval ::WIMLIB_ERR_LINK
566 * Failed to create a symbolic link or a hard link.
567 * @retval ::WIMLIB_ERR_MKDIR
568 * Failed create a needed directory.
569 * @retval ::WIMLIB_ERR_NOMEM
570 * Failed to allocate needed memory.
571 * @retval ::WIMLIB_ERR_NOTDIR
572 * wimlib_set_output_dir() has not been successfully called on @a wim.
573 * @retval ::WIMLIB_ERR_OPEN
574 * Could not open one of the files being extracted for writing.
575 * @retval ::WIMLIB_ERR_READ
576 * A unexpected end-of-file or read error occurred when trying to read data
577 * from the WIM file associated with @a wim.
578 * @retval ::WIMLIB_ERR_WRITE
579 * Failed to write a file being extracted.
581 extern int wimlib_extract_image(WIMStruct *wim, int image,
582 const char *output_dir, int flags);
585 * Extracts the XML data for a WIM file to a file stream. Every WIM file
586 * includes a string of XML that describes the images contained in the WIM.
589 * Pointer to the ::WIMStruct for a WIM file.
591 * @c stdout, or a FILE* opened for writing, to extract the data to.
593 * @return 0 on success; nonzero on error.
594 * @retval ::WIMLIB_ERR_WRITE
595 * Failed to completely write the XML data to @a fp.
597 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
600 * Frees all memory allocated for a WIMStruct and closes all files associated
604 * Pointer to the ::WIMStruct for a WIM file.
606 * @return This function has no return value.
608 extern void wimlib_free(WIMStruct *wim);
611 * Finds which image in a WIM is bootable.
614 * Pointer to the ::WIMStruct for a WIM file.
617 * 0 if no image is marked as bootable, or the number of the image marked
618 * as bootable (numbered starting at 1).
620 extern int wimlib_get_boot_idx(const WIMStruct *wim);
623 * Gets the compression type used in the WIM.
626 * Pointer to the ::WIMStruct for a WIM file
629 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
630 * ::WIM_COMPRESSION_TYPE_XPRESS.
632 extern int wimlib_get_compression_type(const WIMStruct *wim);
635 * Converts a compression type enumeration value into a string.
638 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
639 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
642 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
645 extern const char *wimlib_get_compression_type_string(int ctype);
648 * Converts an error code into a string describing it.
651 * The error code returned by one of wimlib's functions.
654 * Pointer to a statically allocated string describing the error code,
655 * or @c NULL if the error code is not valid.
657 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
660 * Returns the description of the specified image.
663 * Pointer to the ::WIMStruct for a WIM file.
665 * The number of the image, numbered starting at 1.
668 * The description of the image, or @c NULL if there is no such image, or @c NULL
669 * if the specified image has no description.
671 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
674 * Returns the name of the specified image.
677 * Pointer to the ::WIMStruct for a WIM file.
679 * The number of the image, numbered starting at 1.
682 * The name of the image, or @c NULL if there is no such image.
684 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
688 * Gets the number of images contained in the WIM.
691 * Pointer to the ::WIMStruct for a WIM file.
694 * The number of images contained in the WIM file.
696 extern int wimlib_get_num_images(const WIMStruct *wim);
699 * Gets the part number of the wim (in a split WIM).
702 * Pointer to the ::WIMStruct for a WIM file.
703 * @param total_parts_ret
704 * If non-@c NULL, the total number of parts in the split WIM (1 for
705 * non-split WIMs) is written to this location.
708 * The part number of the WIM (1 for non-split WIMs)
710 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
713 * Returns true if the WIM has an integrity table.
716 * Pointer to the ::WIMStruct for a WIM file.
718 * @c true if the WIM has an integrity table; false otherwise.
720 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
724 * Determines if an image name is already used by some image in the WIM.
727 * Pointer to the ::WIMStruct for a WIM file.
732 * @c true if there is already an image in @a wim named @a name; @c
733 * false if there is no image named @a name in @a wim.
735 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
738 * Joins a set of split WIMs into a one-part WIM.
741 * An array of strings that give the filenames of all parts of the split
744 * Number of filenames in @a swms.
746 * The path to write the one-part WIM to.
748 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
749 * tables (if present) when opening them, and include an integrity table in
752 * @return 0 on success; nonzero on error. This function may return any value
753 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
754 * as the following error codes:
756 * @retval ::WIMLIB_ERR_SPLIT_INVALID
757 * The split WIMs do not form a valid WIM because they do not include all
758 * the parts of the original WIM, there are duplicate parts, or not all the
759 * parts have the same GUID and compression type.
760 * @retval ::WIMLIB_ERR_WRITE
761 * An error occurred when trying to write data to the new WIM at @a output_path.
763 * Note that this function merely copies the resources, so it will not check to
764 * see if the resources, including the metadata resource, are valid or not.
766 extern int wimlib_join(const char **swms, int num_swms,
767 const char *output_path, int flags);
770 * Mounts an image in a WIM file on a directory read-only or read-write.
772 * A daemon will be forked to service the filesystem.
774 * If the mount is read-write, modifications to the WIM are staged in a staging
777 * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
778 * intervening wimlib_unmount()s. If there was a way to have libfuse pass a
779 * pointer to user data to each FUSE callback, then this would be possible, but
780 * there doesn't seem to be a way to do this currently.
783 * Pointer to the ::WIMStruct for the WIM file to be mounted.
785 * The number of the image to mount, numbered from 1. It must be an
786 * existing, single image.
788 * The path to an existing directory to mount the image on.
790 * Bitwise OR of the flags ::WIMLIB_MOUNT_FLAG_READWRITE or
791 * ::WIMLIB_MOUNT_FLAG_DEBUG. If ::WIMLIB_MOUNT_FLAG_READWRITE is not
792 * given, the WIM is mounted read-only.
794 * @return 0 on success; nonzero on error.
795 * @retval ::WIMLIB_ERR_DECOMPRESSION
796 * Could not decompress the metadata resource for @a image in @a wim.
797 * @retval ::WIMLIB_ERR_FUSE
798 * A non-zero status was returned by @c fuse_main().
799 * @retval ::WIMLIB_ERR_INVALID_DENTRY
800 * A directory entry in the metadata resource for @a image in @a wim is
802 * @retval ::WIMLIB_ERR_INVALID_IMAGE
803 * @a image does not specify an existing, single image in @a wim.
804 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
805 * The metadata resource for @a image in @a wim is invalid.
806 * @retval ::WIMLIB_ERR_MKDIR
807 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
808 * directory could not be created.
809 * @retval ::WIMLIB_ERR_NOMEM
810 * Failed to allocate needed memory.
811 * @retval ::WIMLIB_ERR_NOTDIR
812 * Could not determine the current working directory.
813 * @retval ::WIMLIB_ERR_READ
814 * An unexpected end-of-file or read error occurred when trying to read
815 * data from the WIM file associated with @a wim.
818 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
821 * Opens a WIM file and creates a ::WIMStruct for it.
824 * The path to the WIM file to open.
826 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
827 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
828 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
829 * of the WIM, if it exists, is checked, and the function will fail with an
830 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
831 * digests of the WIM do not exactly match the corresponding message
832 * digests given in the integrity table.
833 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
834 * be shown if the integrity of the WIM is checked.
835 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
836 * WIM is part of a split WIM. However, wimlib does not fully support
837 * split WIMs, so not all functions will work correctly after opening a
838 * split WIM. For example, you cannot use wimlib_mount() or
839 * wimlib_extract_image() on a split WIM.
842 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
843 * is written to the memory location pointed to by this parameter. The
844 * ::WIMStruct must be freed using using wimlib_free() when finished with
847 * @return 0 on success; nonzero on error.
848 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
849 * The lookup table of @a wim_file is compressed. Support for this can be
850 * added to wimlib if needed, but it appears to be the case that the lookup
851 * table is never compressed.
852 * @retval ::WIMLIB_ERR_IMAGE_COUNT
853 * The WIM is not the non-first part of a split WIM, and the number of
854 * metadata resources found in the WIM did not match the image count given
855 * in the WIM header, or the number of <IMAGE> elements in the XML
856 * data for the WIM did not match the image count given in the WIM header.
857 * @retval ::WIMLIB_ERR_INTEGRITY
858 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
859 * wim_file contains an integrity table, but the SHA1 message digest for a
860 * chunk of the WIM does not match the corresponding message digest given
861 * in the integrity table.
862 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
863 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
864 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
865 * The header of @a wim_file says that resources in the WIM are compressed,
866 * but the header flag indicating LZX or XPRESS compression is not set.
867 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
868 * The length field of the WIM header is not 208.
869 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
870 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
871 * wim_file contains an integrity table, but the integrity table is
873 * @retval ::WIMLIB_ERR_NOMEM
874 * Failed to allocated needed memory.
875 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
876 * @a wim_file does not begin with the expected magic characters.
877 * @retval ::WIMLIB_ERR_OPEN
878 * Failed to open the file @a wim_file for reading.
879 * @retval ::WIMLIB_ERR_READ
880 * An unexpected end-of-file or read error occurred when trying to read
881 * data from @a wim_file.
882 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
883 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
885 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
886 * A number other than 0x10d00 is written in the version field of the WIM
887 * header of @a wim_file.
888 * @retval ::WIMLIB_ERR_XML
889 * The XML data for @a wim_file is invalid.
891 extern int wimlib_open_wim(const char *wim_file, int flags,
892 WIMStruct **wim_ret);
895 * Overwrites the file that the WIM was originally read from, with changes made.
897 * The new WIM is written to a temporary file and then renamed to the original
898 * file after it is has been completely written. The temporary file currently
899 * is made in the same directory as the original WIM file.
901 * Note that it is not possible for this function to delete the original file
902 * before having written the new file because it is very likely that file
903 * resources in the new WIM file need to be retrieved from the old WIM file.
905 * After this function returns, @a wim must be freed using wimlib_free(). Any
906 * further actions on @a wim before doing this are undefined.
909 * Pointer to the ::WIMStruct for the WIM file to write. There may have
910 * been in-memory changes made to it, which are then reflected in the
913 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
914 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
916 * @return 0 on success; nonzero on error. This function may return any value
917 * returned by wimlib_write() as well as the following error codes:
918 * @retval ::WIMLIB_ERR_NO_FILENAME
919 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
920 * than a WIM read with wimlib_open_wim().
921 * @retval ::WIMLIB_ERR_RENAME
922 * The temporary file that the WIM was written to could not be renamed to
923 * the original filename of @a wim.
925 extern int wimlib_overwrite(WIMStruct *wim, int flags);
928 * Updates the header and XML data of the WIM file, without the need to write
929 * out the entire WIM to a temporary file as in wimlib_write().
931 * This function must only be used if no files, directories, or images have been
932 * added, removed, or changed in the WIM. It must be used when only the boot
933 * index or the name or description of image(s) has been changed.
935 * After this function returns, @a wim must be freed using wimlib_free(). Any
936 * further actions on @a wim before doing this are undefined.
939 * Pointer to the ::WIMStruct for the WIM file to overwrite.
941 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
942 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
944 * @return 0 on success; nonzero on error.
946 * @retval ::WIMLIB_ERR_NO_FILENAME
947 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
948 * than a WIM read with wimlib_open_wim().
949 * @retval ::WIMLIB_ERR_NOMEM
950 * Failed to allocate needed memory.
951 * @retval ::WIMLIB_ERR_OPEN
952 * The WIM file associated with @a wim could not be re-opened read-write.
953 * @retval ::WIMLIB_ERR_READ
954 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
955 * from the WIM file associated with @a wim could not be read to compute
956 * the SHA1 message digests, or the old integrity table (if it existed)
958 * @retval ::WIMLIB_ERR_WRITE
959 * Failed to write the WIM header, the XML data, or the integrity table to
960 * the WIM file associated with @a wim.
962 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
965 * Prints information about one image, or all images, contained in a WIM.
968 * Pointer to the ::WIMStruct for a WIM file.
970 * The image about which to print information. Can be the number of an
971 * image, or ::WIM_ALL_IMAGES to print information about all images in the
974 * @return This function has no return value.
976 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
979 * Prints the full paths to all files contained in an image, or all images, in a
983 * Pointer to the ::WIMStruct for a WIM file.
985 * Which image to print files for. Can be the number of an image, or
986 * ::WIM_ALL_IMAGES to print the files contained in all images.
988 * @return 0 on success; nonzero on error.
989 * @retval ::WIMLIB_ERR_DECOMPRESSION
990 * The metadata resource for one of the specified images could not be
992 * @retval ::WIMLIB_ERR_INVALID_DENTRY
993 * A directory entry in the metadata resource for one of the specified
995 * @retval ::WIMLIB_ERR_INVALID_IMAGE
996 * @a image does not specify a valid image in @a wim, and is not
998 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
999 * The metadata resource for one of the specified images is invalid.
1000 * @retval ::WIMLIB_ERR_NOMEM
1001 * Failed to allocate needed memory.
1002 * @retval ::WIMLIB_ERR_READ
1003 * An unexpected read error or end-of-file occurred when reading the
1004 * metadata resource for one of the specified images.
1006 extern int wimlib_print_files(WIMStruct *wim, int image);
1009 * Prints detailed information from the header of a WIM file.
1012 * Pointer to the ::WIMStruct for a WIM file.
1014 * @return This function has no return value.
1017 extern void wimlib_print_header(const WIMStruct *wim);
1020 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1021 * digests, as found in the directory entry tree in the WIM file, to file
1022 * resources in the WIM file. This table includes one entry for each unique
1023 * file in the WIM, so it can be quite long. There is only one lookup table per
1027 * Pointer to the ::WIMStruct for a WIM file.
1029 * @return This function has no return value.
1031 extern void wimlib_print_lookup_table(WIMStruct *wim);
1034 * Prints the metadata of the specified image in a WIM file. The metadata
1035 * consists of the security data as well as the directory entry tree, and each
1036 * image has its own metadata.
1039 * Pointer to the ::WIMStruct for a WIM file.
1041 * Which image to print the metadata for. Can be the number of an image,
1042 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1044 * @return 0 on success; nonzero on error.
1045 * @retval ::WIMLIB_ERR_DECOMPRESSION
1046 * The metadata resource for one of the specified images could not be
1048 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1049 * A directory entry in the metadata resource for one of the specified
1050 * images is invaled.
1051 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1052 * @a image does not specify a valid image in @a wim, and is not
1054 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1055 * The metadata resource for one of the specified images is invalid.
1056 * @retval ::WIMLIB_ERR_NOMEM
1057 * Failed to allocate needed memory.
1058 * @retval ::WIMLIB_ERR_READ
1059 * An unexpected read error or end-of-file occurred when reading the
1060 * metadata resource for one of the specified images.
1062 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1065 * Prints some basic information about a WIM file. All information printed by
1066 * this function is also printed by wimlib_print_header(), but
1067 * wimlib_print_wim_information() prints some of this information more concisely
1068 * and in a more readable form.
1071 * Pointer to the ::WIMStruct for a WIM file.
1073 * @return This function has no return value.
1075 extern void wimlib_print_wim_information(const WIMStruct *wim);
1078 * Translates a string specifying the name or number of an image in the WIM into
1079 * the number of the image. The images are numbered starting at 1.
1082 * Pointer to the ::WIMStruct for a WIM file.
1083 * @param image_name_or_num
1084 * A string specifying which image. If it begins with a number, it is
1085 * taken to be a string specifying the image number. Otherwise, it is
1086 * taken to be the name of an image, as specified in the XML data for the
1087 * WIM file. It also may be the keyword "all", which will resolve to
1091 * If the string resolved to a single existing image, the number of that
1092 * image, counting starting at 1, is returned. If the keyword "all" was
1093 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1096 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1099 * Sets which image in the WIM is marked as bootable.
1102 * Pointer to the ::WIMStruct for a WIM file.
1104 * The number of the image to mark as bootable, or 0 to mark no image as
1106 * @return 0 on success; nonzero on error.
1107 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1108 * @a boot_idx does not specify an existing image in @a wim, and it was not
1111 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1114 * Changes the description of an image in the WIM.
1117 * Pointer to the ::WIMStruct for a WIM file.
1119 * The number of the image for which to change the description.
1120 * @param description
1121 * The new description to give the image. It may be @c NULL, which
1122 * indicates that the image is to be given no description.
1124 * @return 0 on success; nonzero on error.
1125 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1126 * @a image does not specify a single existing image in @a wim.
1127 * @retval ::WIMLIB_ERR_NOMEM
1128 * Failed to allocate the memory needed to duplicate the @a description
1131 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1132 const char *description);
1135 * Changes the name of an image in the WIM.
1138 * Pointer to the ::WIMStruct for a WIM file.
1140 * The number of the image for which to change the name.
1142 * The new name to give the image. It must not be @c NULL.
1144 * @return 0 on success; nonzero on error.
1145 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1146 * There is already an image named @a name in @a wim.
1147 * @retval ::WIMLIB_ERR_INVALID_PARAM
1148 * @a name was @c NULL or the empty string.
1149 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1150 * @a image does not specify a single existing image in @a wim.
1151 * @retval ::WIMLIB_ERR_NOMEM
1152 * Failed to allocate the memory needed to duplicate the @a name string.
1154 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1157 * Sets the link type to use when extracting files from a WIM. This applies
1158 * when extracting one image as well as when extracting all images. Cross-image
1159 * links may save a lot of space because it is common for files to be referenced
1160 * multiple times in WIM files. By default, the link type used for extraction
1161 * is ::WIM_LINK_TYPE_NONE, meaning that links are not created.
1164 * Pointer to the ::WIMStruct for a WIM file
1166 * ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC, or ::WIM_LINK_TYPE_HARD.
1168 * @return 0 on success; nonzero on error.
1169 * @retval ::WIMLIB_ERR_INVALID_PARAM
1170 * @a link_type was not ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC,
1171 * or ::WIM_LINK_TYPE_HARD.
1173 extern int wimlib_set_link_type(WIMStruct *wim, int link_type);
1176 * Set the functions that wimlib uses to allocate and free memory.
1178 * These settings are global and not per-WIM.
1180 * The default is to use the default @c malloc() and @c free() from the C
1183 * @param malloc_func
1184 * A function equivalent to @c malloc() that wimlib will use to allocate
1185 * memory. If @c NULL, the allocator function is set back to the default
1186 * @c malloc() from the C library.
1188 * A function equivalent to @c free() that wimlib will use to free memory.
1189 * If @c NULL, the free function is set back to the default @c free() from
1191 * @param realloc_func
1192 * A function equivalent to @c realloc() that wimlib will use to reallocate
1193 * memory. If @c NULL, the free function is set back to the default @c
1194 * realloc() from the C library.
1195 * @return 0 on success; nonzero on error.
1196 * @retval ::WIMLIB_ERR_UNSUPPORTED
1197 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1198 * so custom memory allocators are unsupported.
1200 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1201 void (*free_func)(void *),
1202 void *(*realloc_func)(void *, size_t));
1205 * Sets whether wimlib is to print error messages to @c stderr when a function
1206 * fails or not. These error messages may provide information that cannot be
1207 * determined only from the error code that is returned.
1209 * This setting is global and not per-WIM.
1211 * By default, error messages are not printed.
1213 * @param show_messages
1214 * @c true if error messages are to be printed; @c false if error messages
1215 * are not to be printed.
1217 * @return 0 on success; nonzero on error.
1218 * @retval ::WIMLIB_ERR_UNSUPPORTED
1219 * @a show_messages was @c true, but wimlib was compiled with the @c
1220 * --without-error-messages option. Therefore, error messages cannot be
1223 extern int wimlib_set_print_errors(bool show_messages);
1226 * Splits a WIM into multiple parts.
1229 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1231 * Name of the SWM file to create. This will be the name of the first
1232 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1235 * The maximum size per part. It is not guaranteed that this will really
1236 * be the maximum size per part, because some file resources in the WIM may
1237 * be larger than this size, and the WIM file format provides no way to
1238 * split up file resources among multiple WIMs.
1240 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1241 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1243 * @return 0 on success; nonzero on error. This function may return any value
1244 * returned by wimlib_open_wim() as well as the following error codes:
1246 * @retval ::WIMLIB_ERR_WRITE
1247 * An error occurred when trying to write data to one of the split WIMs.
1250 extern int wimlib_split(const char *wimfile, const char *swm_name,
1251 size_t part_size, int flags);
1254 * Unmounts a WIM image that was mounted using wimlib_mount().
1256 * Blocks until it is known whether the mount succeeded or failed.
1258 * To perform this operation, the process calling wimlib_unmount() communicates
1259 * with the process that had called wimlib_mount().
1261 * There is currently a design problem with this function because it is hard to
1262 * know whether the filesystem daemon is still working or whether it has
1263 * crashed, has been killed, or has reached an infinite loop. However, ideally
1264 * there should be no infinite loops or crashes in the code, so this wouldn't be
1265 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1266 * can be very large) is implemented so that this function will not wait forever
1267 * before returning failure.
1270 * The directory that the WIM image was mounted on.
1272 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1273 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1276 * @return 0 on success; nonzero on error.
1277 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1278 * The filesystem daemon was unable to remove the staging directory and the
1279 * temporary files that it contains.
1280 * @retval ::WIMLIB_ERR_FORK
1281 * Could not @c fork() the process.
1282 * @retval ::WIMLIB_ERR_FUSERMOUNT
1283 * The @b fusermount program could not be executed or exited with a failure
1285 * @retval ::WIMLIB_ERR_MQUEUE
1286 * Could not open a POSIX message queue to communicate with the filesystem
1287 * daemon servicing the mounted filesystem, could not send a message
1288 * through the queue, or could not receive a message through the queue.
1289 * @retval ::WIMLIB_ERR_NOMEM
1290 * Failed to allocate needed memory.
1291 * @retval ::WIMLIB_ERR_OPEN
1292 * The filesystem daemon could not open a temporary file for writing the
1294 * @retval ::WIMLIB_ERR_TIMEOUT
1295 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1296 * the process of its exit status, so the WIM file probably was not written
1298 * @retval ::WIMLIB_ERR_READ
1299 * A read error occurred when the filesystem daemon tried to a file from
1300 * the staging directory
1301 * @retval ::WIMLIB_ERR_RENAME
1302 * The filesystem daemon failed to rename the newly written WIM file to the
1303 * original WIM file.
1304 * @retval ::WIMLIB_ERR_WRITE
1305 * A write error occurred when the filesystem daemon was writing to the new
1306 * WIM file, or the filesystem daemon was unable to flush changes that had
1307 * been made to files in the staging directory.
1309 extern int wimlib_unmount(const char *dir, int flags);
1312 * Writes the WIM to a file.
1315 * Pointer to the ::WIMStruct for a WIM file. There may have been
1316 * in-memory changes made to it, which are then reflected in the output
1319 * The path to the file to write the WIM to.
1321 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1324 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1325 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1326 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1327 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1328 * is given, the progress of the calculation of the integrity table is
1331 * @return 0 on success; nonzero on error.
1332 * @retval ::WIMLIB_ERR_DECOMPRESSION
1333 * Failed to decompress a metadata or file resource in @a wim.
1334 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1335 * A directory entry in the metadata resource for @a image in @a wim is
1337 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1338 * @a image does not specify a single existing image in @a wim, and is not
1340 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1341 * The metadata resource for @a image in @a wim is invalid.
1342 * @retval ::WIMLIB_ERR_NOMEM
1343 * Failed to allocate needed memory.
1344 * @retval ::WIMLIB_ERR_OPEN
1345 * Failed to open @a path for writing, or some file resources in @a
1346 * wim refer to files in the outside filesystem, and one of these files
1347 * could not be opened for reading.
1348 * @retval ::WIMLIB_ERR_READ
1349 * An error occurred when trying to read data from the WIM file associated
1350 * with @a wim, or some file resources in @a wim refer to files in the
1351 * outside filesystem, and a read error occurred when reading one of these
1353 * @retval ::WIMLIB_ERR_WRITE
1354 * An error occurred when trying to write data to the new WIM file at @a
1357 extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
1361 #endif /* _WIMLIB_H */