4 * External header for wimlib.
6 * This file contains extensive comments for generating documentation with
7 * Doxygen. The built HTML documentation can be viewed at
8 * http://wimlib.sourceforge.net.
12 * Copyright (C) 2012 Eric Biggers
14 * This file is part of wimlib, a library for working with WIM files.
16 * wimlib is free software; you can redistribute it and/or modify it under the
17 * terms of the GNU General Public License as published by the Free
18 * Software Foundation; either version 3 of the License, or (at your option)
21 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23 * A PARTICULAR PURPOSE. See the GNU General Public License for more
26 * You should have received a copy of the GNU General Public License
27 * along with wimlib; if not, see http://www.gnu.org/licenses/.
32 * \section intro Introduction
34 * wimlib is a C library to read, write, and mount archive files in the Windows
35 * Imaging Format (WIM files). These files are normally created using the @c
36 * imagex.exe utility on Windows, but this library provides a free
37 * implementetion of @c imagex for UNIX-based systems and an API to allow other
38 * programs to read, write, and mount WIM files. wimlib is comparable to
39 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
41 * \section format WIM files
43 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
44 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
45 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
46 * Both are based on LZ77 and Huffman encoding, and both are supported by
49 * Unlike ZIP files, WIM files can contain multiple independent toplevel
50 * directory trees known as @a images. While each image has its own metadata,
51 * files are not duplicated for each image; instead, each file is included only
52 * once in the entire WIM. Microsoft did this so that in one WIM file, they
53 * could do things like have 5 different versions of Windows that are almost
56 * Microsoft provides documentation for the WIM file format, XPRESS compression
57 * format, and LZX compression format. The XPRESS documentation is acceptable,
58 * but the LZX documentation is not entirely correct, and the WIM documentation
59 * itself is incomplete.
61 * A WIM file may be either stand-alone or split into multiple parts.
63 * \section ntfs NTFS support
65 * As of version 1.0.0, wimlib supports capturing and applying images directly
66 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
67 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
68 * data such as security descriptors, alternate data streams, and reparse point
71 * The code for NTFS image capture and image application is complete enough that
72 * it is possible to apply an image from the "install.wim" contained in recent
73 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
74 * NTFS volume, and then boot Windows from it after preparing the Boot
75 * Configuration Data. In addition, a Windows installation can be captured (or
76 * backed up) into a WIM file, and then re-applied later.
78 * \section winpe Windows PE
80 * A major use for this library is to create customized images of Windows PE, the
81 * Windows Preinstallation Environment, without having to rely on Windows. Windows
82 * PE is a lightweight version of Windows that can run entirely from memory and can
83 * be used to install Windows from local media or a network drive or perform
84 * maintenance. Windows PE is the operating system that runs when you boot from
85 * the Windows installation media.
87 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
88 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
89 * in the Windows Automated Installation Kit (WAIK), which is free to download
90 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
91 * install either the @c cabextract or @c p7zip programs.
93 * In addition, Windows installations and recovery partitions frequently contain a
94 * WIM containing an image of the Windows Recovery Environment, which is similar to
97 * \section starting Getting Started
99 * wimlib uses the GNU autotools, so it should be easy to install with
100 * <code>configure && make && sudo make install</code>; however, please see the
101 * README for more information about installing it. To use wimlib in a program
102 * after installing it, include @c wimlib.h and link your program with @c -lwim.
104 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
105 * may represent either a stand-alone WIM or one part of a split WIM.
107 * All functions in wimlib's public API are prefixed with @c wimlib. Most
108 * return an integer error code on failure. Use wimlib_get_error_string() to
109 * get a string that describes an error code. wimlib also can print error
110 * messages itself when an error happens, and these may be more informative than
111 * the error code; to enable this, call wimlib_set_print_errors(). Please note
112 * that this is for convenience only, and some errors can occur without a
113 * message being printed.
115 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
116 * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
117 * both apply globally.
119 * To open an existing WIM, use wimlib_open_wim().
121 * To create a new WIM that initially contains no images, use
122 * wimlib_create_new_wim().
124 * To add an image to a WIM file from a directory tree on your filesystem, call
125 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
126 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
127 * also capture a WIM image directly from a NTFS volume if you provide the
128 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
129 * the <code>--without-ntfs-3g</code> flag.
131 * To extract an image from a WIM file, call wimlib_extract_image(). You may
132 * extract an image either to a directory or directly to a NTFS volume, the
133 * latter of which will preserve NTFS-specific data such as security
136 * wimlib supports mounting WIM files either read-only or read-write. Mounting
137 * is done using wimlib_mount_image() and unmounting is done using
138 * wimlib_unmount_image(). Mounting can be done without root privileges because
139 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
140 * compiled with the <code>--without-fuse</code> flag, these functions will be
141 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
143 * After creating or modifying a WIM file, you can write it to a file using
144 * wimlib_write(). Alternatively, if the WIM was originally read from a file
145 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
146 * wimlib_overwrite() to overwrite the original file.
148 * Please note: merely by calling wimlib_add_image() or many of the other
149 * functions in this library that operate on ::WIMStruct's, you are @b not
150 * modifying the WIM file on disk. Changes are not saved until you explicitly
151 * call wimlib_write() or wimlib_overwrite().
153 * After you are done with the WIM file, use wimlib_free() to free all memory
154 * associated with a ::WIMStruct and close all files associated with it.
156 * A number of functions take a pointer to a progress function of type
157 * ::wimlib_progress_func_t. This function will be called periodically during
158 * the WIM operation(s) to report on the progress of the operation (for example,
159 * how many bytes have been written so far).
161 * \section imagex imagex
163 * wimlib comes with a command-line interface, the @b imagex program. It is
164 * documented with man pages. See its source code (@c programs/imagex.c in
165 * wimlib's source tree) for an example of how to use wimlib in your program.
167 * \section mkwinpeimg mkwinpeimg
169 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
172 * \section Limitations
174 * While wimlib supports the main features of WIM files, wimlib currently has
175 * the following limitations:
176 * - wimlib cannot be used on MS-Windows.
177 * - There is no way to add, remove, modify, or extract specific files in a WIM
178 * without mounting it, other than by adding, removing, or extracting an
179 * entire image. The FUSE mount feature should be used for this purpose.
180 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
181 * than wimlib when using maximum (LZX) compression because it knows how to
182 * split up LZX compressed blocks, which is not yet implemented in wimlib.
183 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
184 * imagex.exe if you want to make sure your WIM files are made "correctly".
185 * - The old WIM format from Vista pre-releases is not supported.
186 * - Compressed resource chunk sizes other than 32768 are not supported,
187 * although this doesn't seem to be a problem because the chunk size always
188 * seems to be this value.
189 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
190 * make certain Windows-specific modifications to a Windows PE image, such as
191 * adding a driver or Windows component. Such a tool could conceivably be
192 * implemented on top of wimlib, although it likely would be hard to implement
193 * because it would have to do very Windows-specific things such as
194 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
195 * script for a similar purpose, however. With regards to adding drivers to
196 * Windows PE, you have the option of putting them anywhere in the Windows PE
197 * image, then loading them after boot using @b drvload.exe.
199 * \section legal License
201 * The wimlib library, as well as the programs and scripts distributed with it
202 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
203 * License version 3 or later.
212 #include <inttypes.h>
214 #define WIMLIB_MAJOR_VERSION 1
215 #define WIMLIB_MINOR_VERSION 2
216 #define WIMLIB_PATCH_VERSION 0
219 * Opaque structure that represents a WIM file. This is an in-memory structure
220 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
221 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
222 * continuing to exist so that data can be read from it as needed.
224 * Most functions in this library will work the same way regardless of whether a
225 * given ::WIMStruct was obtained through wimlib_open_wim() or
226 * wimlib_create_new_wim(). Exceptions are documented.
228 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
229 * file from a ::WIMStruct.
231 typedef struct WIMStruct WIMStruct;
234 * Specifies the compression type of a WIM file.
236 enum wimlib_compression_type {
237 /** An invalid compression type. */
238 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
240 /** The WIM does not include any compressed resources. */
241 WIMLIB_COMPRESSION_TYPE_NONE = 0,
243 /** Compressed resources in the WIM use LZX compression. */
244 WIMLIB_COMPRESSION_TYPE_LZX = 1,
246 /** Compressed resources in the WIM use XPRESS compression. */
247 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
250 /** Possible values of the first parameter to the user-supplied
251 * ::wimlib_progress_func_t progress function */
252 enum wimlib_progress_msg {
254 /** A WIM image is about to be extracted. @a info will point to
255 * ::wimlib_progress_info.extract. */
256 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
258 /** The directory structure of the WIM image is about to be extracted.
259 * @a info will point to ::wimlib_progress_info.extract. */
260 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
262 /** The directory structure of the WIM image has been successfully
263 * extracted. @a info will point to ::wimlib_progress_info.extract. */
264 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
266 /** The WIM image's files resources are currently being extracted. @a
267 * info will point to ::wimlib_progress_info.extract. */
268 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
270 /** A file or directory is being extracted. @a info will point to
271 * ::wimlib_progress_info.extract, and the @a cur_path member will be
273 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
275 /** All the WIM files and directories have been extracted, and
276 * timestamps are about to be applied. @a info will point to
277 * ::wimlib_progress_info.extract. */
278 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
280 /** A WIM image has been successfully extracted. @a info will point to
281 * ::wimlib_progress_info.extract. */
282 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
284 /** The directory or NTFS volume is about to be scanned to build a tree
285 * of WIM dentries in-memory. @a info will point to
286 * ::wimlib_progress_info.scan. */
287 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
289 /** A directory or file is being scanned. @a info will point to
290 * ::wimlib_progress_info.scan, and its @a cur_path member will be
291 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
292 * is passed to wimlib_add_image(). */
293 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
295 /** The directory or NTFS volume has been successfully scanned, and a
296 * tree of WIM dentries has been built in-memory. @a info will point to
297 * ::wimlib_progress_info.scan. */
298 WIMLIB_PROGRESS_MSG_SCAN_END,
301 * File resources are currently being written to the WIM.
302 * @a info will point to ::wimlib_progress_info.write_streams. */
303 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
306 * The metadata resource for each image is about to be written to the
307 * WIM. @a info will not be valid. */
308 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
311 * The metadata resource for each image has successfully been writen to
312 * the WIM. @a info will not be valid. */
313 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
316 * The temporary file has successfully been renamed to the original WIM
317 * file. Only happens when wimlib_overwrite() is called and the
318 * overwrite is not done in-place.
319 * @a info will point to ::wimlib_progress_info.rename. */
320 WIMLIB_PROGRESS_MSG_RENAME,
322 /** The contents of the WIM are being checked against the integrity
323 * table. Only happens when wimlib_open_wim() is called with the
324 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
325 * ::wimlib_progress_info.integrity. */
326 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
328 /** An integrity table is being calculated for the WIM being written.
329 * Only happens when wimlib_write() or wimlib_overwrite() is called with
330 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
331 * ::wimlib_progress_info.integrity. */
332 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
334 /** A wimlib_join() operation is in progress. @a info will point to
335 * ::wimlib_progress_info.join. */
336 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
338 /** A wimlib_split() operation is in progress, and a new split part is
339 * about to be started. @a info will point to
340 * ::wimlib_progress_info.split. */
341 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
343 /** A wimlib_split() operation is in progress, and a split part has been
344 * finished. @a info will point to ::wimlib_progress_info.split. */
345 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
348 /** A pointer to this union is passed to the user-supplied
349 * ::wimlib_progress_func_t progress function. One (or none) of the structures
350 * contained in this union will be applicable for the operation
351 * (::wimlib_progress_msg) indicated in the first argument to the progress
353 union wimlib_progress_info {
355 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
356 * document them if they aren't given a name... */
358 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
359 struct wimlib_progress_info_write_streams {
360 /** Number of bytes that are going to be written for all the
361 * streams combined. This is the amount in uncompressed data.
362 * (The actual number of bytes will be less if the data is being
363 * written compressed.) */
364 uint64_t total_bytes;
365 /** Number of streams that are going to be written. */
366 uint64_t total_streams;
368 /** Number of uncompressed bytes that have been written so far.
369 * Will be 0 initially, and equal to @a total_bytes at the end.
371 uint64_t completed_bytes;
373 /** Number of streams that have been written. Will be 0
374 * initially, and equal to @a total_streams at the end. */
375 uint64_t completed_streams;
377 /** Number of threads that are being used to compress resources
378 * (if applicable). */
379 unsigned num_threads;
381 /** The compression type being used to write the streams; either
382 * ::WIMLIB_COMPRESSION_TYPE_NONE,
383 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
384 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
385 int compression_type;
388 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
389 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
390 struct wimlib_progress_info_scan {
391 /** Directory or NTFS volume that is being scanned. */
394 /** Path to the file or directory that is about to be scanned,
395 * relative to the root of the image capture or the NTFS volume.
397 const char *cur_path;
399 /** True iff @a cur_path is being excluded from the image
400 * capture due to the capture configuration file. */
404 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
405 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
406 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
407 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
408 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
409 struct wimlib_progress_info_extract {
410 /** Number of the image being extracted (1-based). */
413 /** Name of the image being extracted. */
414 const char *image_name;
416 /** Directory or NTFS volume to which the image is being
420 /** Current dentry being extracted. (Valid only if message is
421 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
422 const char *cur_path;
424 /** Number of bytes of uncompressed data that will be extracted.
425 * Takes into account hard links (they are not counted for each
428 uint64_t total_bytes;
430 /** Number of bytes that have been written so far. Will be 0
431 * initially, and equal to @a total_bytes at the end. */
432 uint64_t completed_bytes;
434 /** Number of streams that will be extracted. This may more or
435 * less than the number of "files" to be extracted due to
436 * special cases (hard links, symbolic links, and alternate data
438 uint64_t num_streams;
441 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
442 struct wimlib_progress_info_rename {
443 /** Name of the temporary file that the WIM was written to. */
446 /** Name of the original WIM file to which the temporary file is
451 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
452 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
453 struct wimlib_progress_info_integrity {
454 /** Number of bytes from the end of the WIM header to the end of
455 * the lookup table (the area that is covered by the SHA1
456 * integrity checks.) */
457 uint64_t total_bytes;
459 /** Number of bytes that have been SHA1-summed so far. Will be
460 * 0 initially, and equal @a total_bytes at the end. */
461 uint64_t completed_bytes;
463 /** Number of chunks that the checksummed region is divided
465 uint32_t total_chunks;
467 /** Number of chunks that have been SHA1-summed so far. Will
468 * be 0 initially, and equal to @a total_chunks at the end. */
469 uint32_t completed_chunks;
471 /** Size of the chunks used for the integrity calculation. */
474 /** Filename of the WIM (only valid if the message is
475 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
476 const char *filename;
479 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
480 struct wimlib_progress_info_join {
481 /** Total number of bytes of compressed data contained in all
482 * the split WIM part's file and metadata resources. */
483 uint64_t total_bytes;
485 /** Number of bytes that have been copied to the joined WIM so
486 * far. Will be 0 initially, and equal to @a total_bytes at the
488 uint64_t completed_bytes;
490 /** Number of split WIM parts that have had all their file and
491 * metadata resources copied over to the joined WIM so far. */
492 unsigned completed_parts;
494 /** Number of split WIM parts. */
495 unsigned total_parts;
497 /** Name of the joined WIM file being written. */
498 const char *filename;
501 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
502 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
503 struct wimlib_progress_info_split {
504 /** Total size of the original WIM's file and metadata resources
506 uint64_t total_bytes;
508 /** Number of bytes of file and metadata resources that have
509 * been copied out of the original WIM so far. Will be 0
510 * initially, and equal to @a total_bytes at the end. */
511 uint64_t completed_bytes;
513 /** Number of the split WIM part that is about to be started
514 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
515 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
516 unsigned cur_part_number;
518 /** Name of the split WIM part that is about to be started
519 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
520 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
521 const char *part_name;
525 /** A user-supplied function that will be called periodically during certain WIM
526 * operations. The first argument will be the type of operation that is being
527 * performed or is about to be started or has been completed. The second
528 * argument will be a pointer to one of a number of structures depending on the
529 * first argument. It may be @c NULL for some message types.
531 * The return value of the progress function is currently ignored, but it may do
532 * something in the future. (Set it to 0 for now.)
534 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
535 const union wimlib_progress_info *info);
538 /*****************************
539 * WIMLIB_ADD_IMAGE_FLAG_* *
540 *****************************/
542 /** Directly capture a NTFS volume rather than a generic directory */
543 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
545 /** Follow symlinks; archive and dump the files they point to. Cannot be used
546 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
547 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
549 /** Call the progress function with the message
550 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
552 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
554 /** Mark the image being added as the bootable image of the WIM. */
555 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
557 /******************************
558 * WIMLIB_EXPORT_FLAG_* *
559 ******************************/
561 /** See documentation for wimlib_export_image(). */
562 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
564 /******************************
565 * WIMLIB_EXTRACT_FLAG_* *
566 ******************************/
568 /** Extract the image directly to a NTFS volume rather than a generic directory.
570 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
572 /** When identical files are extracted from the WIM, always hard link them
573 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
574 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
576 /** When identical files are extracted from the WIM, always symlink them
577 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
578 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
580 /** Call the progress function with the argument
581 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
582 * extracted. Note: these calls will be interspersed with calls for the message
583 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
584 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
586 /** Read the WIM file sequentially while extracting the image. */
587 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
589 /******************************
590 * WIMLIB_MOUNT_FLAG_* *
591 ******************************/
593 /** Mount the WIM image read-write rather than the default of read-only. */
594 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
596 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
597 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
599 /** Do not allow accessing alternate data streams in the mounted WIM image. */
600 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
602 /** Access alternate data streams in the mounted WIM image through extended file
603 * attributes. This is the default mode. */
604 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
606 /** Access alternate data streams in the mounted WIM image by specifying the
607 * file name, a colon, then the alternate file stream name. */
608 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
610 /******************************
611 * WIMLIB_OPEN_FLAG_* *
612 ******************************/
614 /** Verify the WIM contents against the WIM's integrity table, if present. */
615 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
617 /** Do not issue an error if the WIM is part of a split WIM. */
618 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
620 /******************************
621 * WIMLIB_UNMOUNT_FLAG_* *
622 ******************************/
624 /** Include an integrity table in the WIM after it's been unmounted. Ignored
625 * for read-only mounts. */
626 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
628 /** Unless this flag is given, changes to a read-write mounted WIM are
629 * discarded. Ignored for read-only mounts. */
630 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
632 /******************************
633 * WIMLIB_WRITE_FLAG_* *
634 ******************************/
636 /** Include an integrity table in the new WIM file. */
637 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
639 /** Re-build the entire WIM file rather than appending data to it, if possible.
640 * (Applies to wimlib_overwrite(), not wimlib_write()). */
641 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
643 /** Recompress all resources, even if they could otherwise be copied from a
644 * different WIM with the same compression type (in the case of
645 * wimlib_export_image() being called previously). */
646 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
648 /** Call fsync() when the WIM file is closed */
649 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
651 /** Specifying this flag overrides the default behavior of wimlib_overwrite()
652 * after one or more calls to wimlib_delete_image(), which is to rebuild the
655 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
656 * correctly remove the image from the WIM will be taken. In particular, all
657 * streams will be left alone, even if they are no longer referenced. This is
658 * probably not what you want, because almost no space will be spaced by
659 * deleting an image in this way. */
660 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
663 * Possible values of the error code returned by many functions in wimlib.
665 * See the documentation for each wimlib function to see specifically what error
666 * codes can be returned by a given function, and what they mean.
668 enum wimlib_error_code {
669 WIMLIB_ERR_SUCCESS = 0,
670 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
671 WIMLIB_ERR_DECOMPRESSION,
672 WIMLIB_ERR_DELETE_STAGING_DIR,
675 WIMLIB_ERR_FUSERMOUNT,
676 WIMLIB_ERR_IMAGE_COUNT,
677 WIMLIB_ERR_IMAGE_NAME_COLLISION,
678 WIMLIB_ERR_INTEGRITY,
679 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
680 WIMLIB_ERR_INVALID_CHUNK_SIZE,
681 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
682 WIMLIB_ERR_INVALID_DENTRY,
683 WIMLIB_ERR_INVALID_HEADER_SIZE,
684 WIMLIB_ERR_INVALID_IMAGE,
685 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
686 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
687 WIMLIB_ERR_INVALID_PARAM,
688 WIMLIB_ERR_INVALID_RESOURCE_HASH,
689 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
690 WIMLIB_ERR_INVALID_SECURITY_DATA,
696 WIMLIB_ERR_NOT_A_WIM_FILE,
697 WIMLIB_ERR_NO_FILENAME,
705 WIMLIB_ERR_RESOURCE_ORDER,
706 WIMLIB_ERR_SPECIAL_FILE,
707 WIMLIB_ERR_SPLIT_INVALID,
708 WIMLIB_ERR_SPLIT_UNSUPPORTED,
711 WIMLIB_ERR_UNKNOWN_VERSION,
712 WIMLIB_ERR_UNSUPPORTED,
718 /** Used to indicate that no WIM image or an invalid WIM image. */
719 #define WIMLIB_NO_IMAGE 0
721 /** Used to specify all images in the WIM. */
722 #define WIMLIB_ALL_IMAGES (-1)
725 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
727 * The directory tree is read immediately for the purpose of constructing a
728 * directory entry tree in-memory. Also, all files are read to calculate their
729 * SHA1 message digests. However, because the directory tree may contain a very
730 * large amount of data, the files themselves are not read into memory
731 * permanently, and instead references to their paths saved. The files are then
732 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
734 * Please note that @b no changes are committed to the underlying WIM file (if
735 * any) until wimlib_write() or wimlib_overwrite() is called.
738 * Pointer to the ::WIMStruct for a WIM file to which the image will be
741 * A path to a directory or unmounted NTFS volume that will be captured as
744 * The name to give the image. This must be non-@c NULL.
746 * Pointer to the contents of an image capture configuration file. If @c
747 * NULL, a default string is used. Please see the manual page for
748 * <b>imagex capture</b> for more information.
750 * Length of the string @a config in bytes. Ignored if @a config is @c
753 * @param add_image_flags
754 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
755 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
756 * marked as bootable is changed to the one being added. If
757 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
758 * printed as it is scanned or captured. If
759 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
760 * directories pointed to by symbolic links are archived rather than the
761 * symbolic links themselves.
763 * @param progress_func
764 * If non-NULL, a function that will be called periodically with the
765 * progress of the current operation.
767 * @return 0 on success; nonzero on error. On error, changes to @a wim are
768 * discarded so that it appears to be in the same state as when this function
771 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
772 * There is already an image named @a name in @a wim.
773 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
774 * @a config was not @c NULL and did not specify a valid image capture
776 * @retval ::WIMLIB_ERR_INVALID_PARAM
777 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
778 * @retval ::WIMLIB_ERR_NOMEM
779 * Failed to allocate needed memory.
780 * @retval ::WIMLIB_ERR_NOTDIR
781 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
782 * not specified in @a add_image_flags).
783 * @retval ::WIMLIB_ERR_NTFS_3G
784 * An error was returned from a libntfs-3g function when the NTFS volume
785 * was being opened, scanned, or closed (only if
786 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
787 * @retval ::WIMLIB_ERR_OPEN
788 * Failed to open a file or directory in the directory tree rooted at @a
789 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
791 * @retval ::WIMLIB_ERR_READ
792 * Failed to read a file in the directory tree rooted at @a source (only if
793 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
794 * @retval ::WIMLIB_ERR_SPECIAL_FILE
795 * The directory tree rooted at @a source contains a special file that is
796 * not a directory, regular file, or symbolic link. This currently can
797 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
798 * add_image_flags, but it may be returned for unsupported NTFS files in
800 * @retval ::WIMLIB_ERR_STAT
801 * Failed obtain the metadata for a file or directory in the directory tree
802 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
803 * specified in @a add_image_flags).
804 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
805 * @a wim is part of a split WIM. Adding an image to a split WIM is
807 * @retval ::WIMLIB_ERR_UNSUPPORTED:
808 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
809 * wimlib was configured with the @c --without-ntfs-3g flag.
811 extern int wimlib_add_image(WIMStruct *wim, const char *source,
812 const char *name, const char *config,
813 size_t config_len, int add_image_flags,
814 wimlib_progress_func_t progress_func);
817 * Creates a ::WIMStruct for a new WIM file.
819 * This only creates an in-memory structure for a WIM that initially contains no
820 * images. No on-disk file is created until wimlib_write() is called.
823 * The type of compression to be used in the new WIM file. Must be
824 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
825 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
827 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
828 * written to the memory location pointed to by this paramater. The
829 * ::WIMStruct must be freed using using wimlib_free() when finished with
831 * @return 0 on success; nonzero on error.
832 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
833 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
834 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
835 * @retval ::WIMLIB_ERR_NOMEM
836 * Failed to allocate needed memory.
838 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
841 * Deletes an image, or all images, from a WIM file.
843 * All streams referenced by the image(s) being deleted are removed from the
844 * lookup table of the WIM if they are not referenced by any other images in the
847 * Please note that @b no changes are committed to the underlying WIM file (if
848 * any) until wimlib_write() or wimlib_overwrite() is called.
851 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
854 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
856 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
857 * to be left unmodified only if @a image specified a single image. If instead
858 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
859 * possible for some but not all of the images to have been deleted when a
860 * failure status is returned.
862 * @retval ::WIMLIB_ERR_DECOMPRESSION
863 * Could not decompress the metadata resource for @a image.
864 * @retval ::WIMLIB_ERR_INVALID_DENTRY
865 * A directory entry in the metadata resource for @a image in the WIM is
867 * @retval ::WIMLIB_ERR_INVALID_IMAGE
868 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
869 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
870 * The metadata resource for @a image in the WIM is invalid.
871 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
872 * The security data for @a image in the WIM is invalid.
873 * @retval ::WIMLIB_ERR_NOMEM
874 * Failed to allocate needed memory.
875 * @retval ::WIMLIB_ERR_READ
876 * Could not read the metadata resource for @a image from the WIM.
877 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
878 * @a wim is part of a split WIM. Deleting an image from a split WIM is
881 extern int wimlib_delete_image(WIMStruct *wim, int image);
884 * Exports an image, or all the images, from a WIM file, into another WIM file.
886 * The destination image is made to share the same dentry tree and security data
887 * structure as the source image. This places some restrictions on additional
888 * functions that may be called. wimlib_mount_image() may not be called on
889 * either the source image or the destination image without an intervening call
890 * to a function that un-shares the images, such as wimlib_free() on @a
891 * dest_wim, or wimlib_delete_image() on either the source or destination image.
892 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
893 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
894 * have references back to @a src_wim.
896 * Previous versions of this function left @a dest_wim in an indeterminate state
897 * on failure. This is no longer the case; all changes to @a dest_wim made by
898 * this function are rolled back on failure.
900 * Previous versions of this function did not allow exporting an image that had
901 * been added by wimlib_add_image(). This is no longer the case; you may now
902 * export an image regardless of how it was added.
904 * Regardless of whether this function succeeds or fails, no changes are made to
907 * Please note that no changes are committed to the underlying WIM file of @a
908 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
911 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
912 * WIM that contains the image(s) being exported.
914 * The image to export from @a src_wim. Can be the number of an image, or
915 * ::WIMLIB_ALL_IMAGES to export all images.
917 * Pointer to the ::WIMStruct for a WIM file that will receive the images
920 * The name to give the exported image in the new WIM file. If left @c
921 * NULL, the name from @a src_wim is used. This parameter must be left @c
922 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
923 * than one image; in that case, the names are all taken from the @a
924 * src_wim. (This is allowed even if one or more images being exported has
926 * @param dest_description
927 * The description to give the exported image in the new WIM file. If left
928 * @c NULL, the description from the @a src_wim is used. This parameter must
929 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
930 * more than one image; in that case, the descriptions are all taken from
931 * @a src_wim. (This is allowed even if one or more images being exported
932 * has no description.)
933 * @param export_flags
934 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
935 * bootable, or 0 if which image is marked as bootable in the destination
936 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
937 * there are multiple images in @a src_wim, specifying
938 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
939 * currently marked as bootable in @a src_wim; if that is the case, then
940 * that image is marked as bootable in the destination WIM.
941 * @param additional_swms
942 * Array of pointers to the ::WIMStruct for each additional part in the
943 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
944 * need to be in any particular order, but they must include all parts of
945 * the split WIM other than the first part, which must be provided in the
947 * @param num_additional_swms
948 * Number of additional WIM parts provided in the @a additional_swms array.
949 * This number should be one less than the total number of parts in the
950 * split WIM. Set to 0 if the WIM is a standalone WIM.
951 * @param progress_func
952 * If non-NULL, a function that will be called periodically with the
953 * progress of the current operation.
955 * @return 0 on success; nonzero on error.
956 * @retval ::WIMLIB_ERR_DECOMPRESSION
957 * Could not decompress the metadata resource for @a src_image
959 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
960 * One or more of the names being given to an exported image was already in
961 * use in the destination WIM.
962 * @retval ::WIMLIB_ERR_INVALID_DENTRY
963 * A directory entry in the metadata resource for @a src_image in @a
964 * src_wim is invalid.
965 * @retval ::WIMLIB_ERR_INVALID_IMAGE
966 * @a src_image does not exist in @a src_wim.
967 * @retval ::WIMLIB_ERR_INVALID_PARAM
968 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
969 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
970 * @a src_wim are marked as bootable; or @a dest_name and/or @a
971 * dest_description were non-<code>NULL</code>, @a src_image was
972 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
973 * or @a dest_wim was @c NULL.
974 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
975 * The metadata resource for @a src_image in @a src_wim is invalid.
976 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
977 * The security data for @a src_image in @a src_wim is invalid.
978 * @retval ::WIMLIB_ERR_NOMEM
979 * Failed to allocate needed memory.
980 * @retval ::WIMLIB_ERR_READ
981 * Could not read the metadata resource for @a src_image from @a src_wim.
982 * @retval ::WIMLIB_ERR_SPLIT_INVALID
983 * The source WIM is a split WIM, but the parts specified do not form a
984 * complete split WIM because they do not include all the parts of the
985 * original WIM, there are duplicate parts, or not all the parts have the
986 * same GUID and compression type.
987 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
988 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
991 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
992 WIMStruct *dest_wim, const char *dest_name,
993 const char *dest_description, int export_flags,
994 WIMStruct **additional_swms,
995 unsigned num_additional_swms,
996 wimlib_progress_func_t progress_func);
999 * Extracts an image, or all images, from a standalone or split WIM file to a
1000 * directory or a NTFS volume.
1002 * Please see the manual page for the @c imagex program for more information
1003 * about the "normal" extraction mode versus the NTFS extraction mode
1004 * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1006 * Extraction is done with one thread.
1008 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1009 * returned if any resulting SHA1 message digests do not match the values
1010 * provided in the WIM file. Therefore, if this function is successful, you can
1011 * be fairly sure that any compressed data in the WIM was uncompressed
1015 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1018 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1019 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1020 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1022 * Directory to extract the WIM image(s) to (created if it does not already
1023 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1024 * path to the unmounted NTFS volume to extract the image to.
1025 * @param extract_flags
1026 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1028 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1029 * a NTFS volume to extract the image to. The volume will be opened using
1030 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1031 * Otherwise, @a target is interpreted as a directory to extract the
1034 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1035 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1036 * specified. These flags cause extracted files that are identical to be
1037 * hardlinked or symlinked together, depending on the flag. These flags
1038 * override the hard link groups that are specified in the WIM file itself.
1039 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1040 * hardlinked or symlinked across images if a file is found to occur in
1041 * more than one image.
1043 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1044 * name of each file or directory as it is extracted.
1046 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1047 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1048 * each image is considered separately with regards to the sequential
1049 * order. It is also possible for alternate data streams to break the
1050 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1052 * @param additional_swms
1053 * Array of pointers to the ::WIMStruct for each additional part in the
1054 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1055 * need to be in any particular order, but they must include all parts of
1056 * the split WIM other than the first part, which must be provided in the
1058 * @param num_additional_swms
1059 * Number of additional WIM parts provided in the @a additional_swms array.
1060 * This number should be one less than the total number of parts in the
1061 * split WIM. Set to 0 if the WIM is a standalone WIM.
1063 * @param progress_func
1064 * If non-NULL, a function that will be called periodically with the
1065 * progress of the current operation.
1067 * @return 0 on success; nonzero on error.
1068 * @retval ::WIMLIB_ERR_DECOMPRESSION
1069 * Could not decompress a resource (file or metadata) for @a image in @a
1071 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1072 * A directory entry in the metadata resource for @a image in @a wim is
1074 * @retval ::WIMLIB_ERR_INVALID_PARAM
1075 * @a wim was @c NULL, or @a target was @c NULL, or both
1076 * ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1077 * specified in @a extract_flags, or both ::WIMLIB_EXTRACT_FLAG_NTFS and
1078 * either ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK
1079 * were specified in @a extract_flags, or ::WIMLIB_EXTRACT_FLAG_NTFS was
1080 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES.
1081 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1082 * The SHA1 message digest of an extracted stream did not match the SHA1
1083 * message digest given in the WIM file.
1084 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1085 * A resource (file or metadata) for @a image in @a wim is invalid.
1086 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1087 * The security data for @a image in @a wim is invalid.
1088 * @retval ::WIMLIB_ERR_LINK
1089 * Failed to create a symbolic link or a hard link (only if
1090 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1091 * @retval ::WIMLIB_ERR_MKDIR
1092 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1093 * not specified in @a extract_flags).
1094 * @retval ::WIMLIB_ERR_NOMEM
1095 * Failed to allocate needed memory.
1096 * @retval ::WIMLIB_ERR_NTFS_3G
1097 * An error was returned from a libntfs-3g function while the WIM image was
1098 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1099 * was specified in @a extract_flags).
1100 * @retval ::WIMLIB_ERR_OPEN
1101 * Could not open one of the files being extracted for writing (only if
1102 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1103 * @retval ::WIMLIB_ERR_READ
1104 * A unexpected end-of-file or read error occurred when trying to read data
1105 * from the WIM file associated with @a wim.
1106 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1107 * The WIM is a split WIM, but the parts specified do not form a complete
1108 * split WIM because they do not include all the parts of the original WIM,
1109 * there are duplicate parts, or not all the parts have the same GUID and
1111 * @retval ::WIMLIB_ERR_UNSUPPORTED
1112 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1113 * was configured with the @c --without-ntfs-3g flag.
1114 * @retval ::WIMLIB_ERR_WRITE
1115 * Failed to write a file being extracted (only if
1116 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1118 extern int wimlib_extract_image(WIMStruct *wim, int image,
1119 const char *target, int extract_flags,
1120 WIMStruct **additional_swms,
1121 unsigned num_additional_swms,
1122 wimlib_progress_func_t progress_func);
1125 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1126 * includes a string of XML that describes the images contained in the WIM.
1127 * This function works on standalone WIMs as well as split WIM parts.
1130 * Pointer to the ::WIMStruct for a WIM file.
1132 * @c stdout, or a FILE* opened for writing, to extract the data to.
1134 * @return 0 on success; nonzero on error.
1135 * @retval ::WIMLIB_ERR_WRITE
1136 * Failed to completely write the XML data to @a fp.
1137 * @retval ::WIMLIB_ERR_INVALID_PARAM
1138 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1140 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1143 * Frees all memory allocated for a WIMStruct and closes all files associated
1147 * Pointer to the ::WIMStruct for a WIM file.
1149 * @return This function has no return value.
1151 extern void wimlib_free(WIMStruct *wim);
1154 * Returns the index of the bootable image of the WIM.
1157 * Pointer to the ::WIMStruct for a WIM file.
1160 * 0 if no image is marked as bootable, or the number of the image marked
1161 * as bootable (numbered starting at 1).
1163 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1166 * Returns the compression type used in the WIM.
1169 * Pointer to the ::WIMStruct for a WIM file
1172 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1173 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1175 extern int wimlib_get_compression_type(const WIMStruct *wim);
1178 * Converts a ::wimlib_compression_type value into a string.
1181 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1182 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1185 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1188 extern const char *wimlib_get_compression_type_string(int ctype);
1191 * Converts an error code into a string describing it.
1194 * The error code returned by one of wimlib's functions.
1197 * Pointer to a statically allocated string describing the error code,
1198 * or @c NULL if the error code is not valid.
1200 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1203 * Returns the description of the specified image.
1206 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1207 * standalone WIM or a split WIM part.
1209 * The number of the image, numbered starting at 1.
1212 * The description of the image, or @c NULL if there is no such image, or
1213 * @c NULL if the specified image has no description. The description
1214 * string is in library-internal memory and may not be modified or freed;
1215 * in addition, the string will become invalid if the description of the
1216 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1218 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1221 * Returns the name of the specified image.
1224 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1225 * standalone WIM or a split WIM part.
1227 * The number of the image, numbered starting at 1.
1230 * The name of the image, or @c NULL if there is no such image. The name
1231 * string is in library-internal memory and may not be modified or freed;
1232 * in addition, the string will become invalid if the name of the image is
1233 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1235 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1236 * the WIM to be unnamed, in which case an empty string will be returned
1237 * when the corresponding name is requested.
1239 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1243 * Returns the number of images contained in a WIM.
1246 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1247 * standalone WIM or a split WIM part.
1250 * The number of images contained in the WIM file.
1252 extern int wimlib_get_num_images(const WIMStruct *wim);
1255 * Returns the part number of a WIM in a split WIM and the total number of parts
1259 * Pointer to the ::WIMStruct for a WIM file.
1260 * @param total_parts_ret
1261 * If non-@c NULL, the total number of parts in the split WIM (1 for
1262 * non-split WIMs) is written to this location.
1265 * The part number of the WIM (1 for non-split WIMs)
1267 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1270 * Returns true if the WIM has an integrity table.
1273 * Pointer to the ::WIMStruct for a WIM file.
1275 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1276 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1277 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1278 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1280 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1284 * Determines if an image name is already used by some image in the WIM.
1287 * Pointer to the ::WIMStruct for a WIM file.
1289 * The name to check.
1292 * @c true if there is already an image in @a wim named @a name; @c false
1293 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1294 * the empty string, @c false is returned.
1296 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1299 * Joins a split WIM into a stand-alone one-part WIM.
1302 * An array of strings that gives the filenames of all parts of the split
1303 * WIM. No specific order is required, but all parts must be included with
1306 * Number of filenames in @a swms.
1307 * @param swm_open_flags
1308 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1309 * part should be verified, if integrity tables are present. Otherwise,
1311 * @param wim_write_flags
1312 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1313 * @param output_path
1314 * The path to write the one-part WIM to.
1315 * @param progress_func
1316 * If non-NULL, a function that will be called periodically with the
1317 * progress of the current operation.
1319 * @return 0 on success; nonzero on error. This function may return any value
1320 * returned by wimlib_open_wim() and wimlib_write() except
1321 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1323 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1324 * The split WIMs do not form a valid WIM because they do not include all
1325 * the parts of the original WIM, there are duplicate parts, or not all the
1326 * parts have the same GUID and compression type.
1328 * Note: the WIM's uncompressed and compressed resources are not checksummed
1329 * when they are copied from the split WIM parts to the joined WIM, nor are
1330 * compressed resources re-compressed.
1332 * Note: wimlib_export_image() can provide similar functionality to
1333 * wimlib_join(), since it is possible to export all images from a split WIM.
1335 extern int wimlib_join(const char **swms, unsigned num_swms,
1336 const char *output_path, int swm_open_flags,
1337 int wim_write_flags,
1338 wimlib_progress_func_t progress_func);
1341 * Mounts an image in a WIM file on a directory read-only or read-write.
1343 * A daemon will be forked to service the filesystem, unless
1344 * ::WIMLIB_MOUNT_FLAG_DEBUG is specified in @a mount_flags. In other words,
1345 * this function returns @b before the image is unmounted, and filesystem
1346 * requests are handled by a new thread. This also means that no functions may
1347 * be safely called on @a wim after wimlib_mount_image() has been called on any
1348 * images from it. (@a wim will be freed by the filesystem thread after the
1349 * filesystem is unmounted.)
1351 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1352 * modifications to the WIM are staged in a temporary directory created in the
1353 * process's working directory when this function is called.
1355 * It is safe to mount multiple images from the same WIM file read-only at the
1356 * same time (but different ::WIMStruct's should be used). However, it is @b
1357 * not safe to mount multiple images from the same WIM file read-write at the
1360 * wimlib_mount_image() cannot be used on an image that was exported with
1361 * wimlib_export_image() while the dentry trees for both images are still in
1362 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1363 * that has just been added with wimlib_add_image(), or unless the WIM has been
1364 * written and read into a new ::WIMStruct.
1367 * Pointer to the ::WIMStruct containing the image to be mounted.
1369 * The number of the image to mount, indexed starting from it. It must be
1370 * an existing, single image.
1372 * The path to an existing empty directory to mount the image on.
1373 * @param mount_flags
1374 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1376 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1377 * rather than the default of read-only.
1379 * WIMs may contain named (alternate) data streams, which are a somewhat
1380 * obscure NTFS feature. They can be read and written on a mounted WIM
1381 * through one of several interfaces. The interface to use if specified by
1382 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1383 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1384 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1385 * the XATTR interface.
1386 * @param additional_swms
1387 * Array of pointers to the ::WIMStruct for each additional part in the
1388 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1389 * need to be in any particular order, but they must include all parts of
1390 * the split WIM other than the first part, which must be provided in the
1392 * @param num_additional_swms
1393 * Number of additional WIM parts provided in the @a additional_swms array.
1394 * This number should be one less than the total number of parts in the
1395 * split WIM. Set to 0 if the WIM is a standalone WIM.
1396 * @param staging_dir
1397 * Currently ignored, but may provide a way to specify the staging
1398 * directory in the future. Set to @c NULL.
1400 * @return 0 on success; nonzero on error.
1401 * @retval ::WIMLIB_ERR_DECOMPRESSION
1402 * Could not decompress the metadata resource for @a image in @a wim.
1403 * @retval ::WIMLIB_ERR_FUSE
1404 * A non-zero status was returned by @c fuse_main().
1405 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1406 * A directory entry in the metadata resource for @a image in @a wim is
1408 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1409 * @a image does not specify an existing, single image in @a wim.
1410 * @retval ::WIMLIB_ERR_INVALID_PARAM
1411 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1412 * wimlib_export_image(), or @a image has been added with
1413 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
1414 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1415 * The metadata resource for @a image in @a wim is invalid.
1416 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1417 * The security data for @a image in @a wim is invalid.
1418 * @retval ::WIMLIB_ERR_MKDIR
1419 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1420 * staging directory could not be created.
1421 * @retval ::WIMLIB_ERR_NOMEM
1422 * Failed to allocate needed memory.
1423 * @retval ::WIMLIB_ERR_NOTDIR
1424 * Could not determine the current working directory.
1425 * @retval ::WIMLIB_ERR_READ
1426 * An unexpected end-of-file or read error occurred when trying to read
1427 * data from the WIM file associated with @a wim.
1428 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1429 * The WIM is a split WIM, but the parts specified do not form a complete
1430 * split WIM because they do not include all the parts of the original WIM,
1431 * there are duplicate parts, or not all the parts have the same GUID and
1433 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1434 * The WIM is a split WIM and a read-write mount was requested. We only
1435 * support mounting a split WIM read-only.
1437 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1438 int mount_flags, WIMStruct **additional_swms,
1439 unsigned num_additional_swms,
1440 const char *staging_dir);
1443 * Opens a WIM file and creates a ::WIMStruct for it.
1446 * The path to the WIM file to open.
1448 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1449 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1451 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1452 * the WIM, if it exists, is checked, and this function will fail with an
1453 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1454 * digests of the WIM do not exactly match the corresponding message
1455 * digests given in the integrity table.
1457 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1458 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1459 * returned. (This flag may be removed in the future, in which case no
1460 * error will be issued when opening a split WIM.)
1462 * @param progress_func
1463 * If non-NULL, a function that will be called periodically with the
1464 * progress of the current operation.
1467 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1468 * is written to the memory location pointed to by this parameter. The
1469 * ::WIMStruct must be freed using using wimlib_free() when finished with
1472 * @return 0 on success; nonzero on error.
1473 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1474 * The lookup table of @a wim_file is compressed. Support for this can be
1475 * added to wimlib if needed, but it appears to be the case that the lookup
1476 * table is never compressed.
1477 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1478 * The WIM is not the non-first part of a split WIM, and the number of
1479 * metadata resources found in the WIM did not match the image count given
1480 * in the WIM header, or the number of <IMAGE> elements in the XML
1481 * data for the WIM did not match the image count given in the WIM header.
1482 * @retval ::WIMLIB_ERR_INTEGRITY
1483 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1484 * wim_file contains an integrity table, but the SHA1 message digest for a
1485 * chunk of the WIM does not match the corresponding message digest given
1486 * in the integrity table.
1487 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1488 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1489 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1490 * The header of @a wim_file says that resources in the WIM are compressed,
1491 * but the header flag indicating LZX or XPRESS compression is not set.
1492 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1493 * The length field of the WIM header is not 208.
1494 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1495 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1496 * wim_file contains an integrity table, but the integrity table is
1498 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1499 * The lookup table for the WIM contained duplicate entries that are not
1500 * for metadata resources, or it contained an entry with a SHA1 message
1501 * digest of all 0's.
1502 * @retval ::WIMLIB_ERR_NOMEM
1503 * Failed to allocated needed memory.
1504 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1505 * @a wim_file does not begin with the expected magic characters.
1506 * @retval ::WIMLIB_ERR_OPEN
1507 * Failed to open the file @a wim_file for reading.
1508 * @retval ::WIMLIB_ERR_READ
1509 * An unexpected end-of-file or read error occurred when trying to read
1510 * data from @a wim_file.
1511 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1512 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1513 * specified in @a open_flags.
1514 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1515 * A number other than 0x10d00 is written in the version field of the WIM
1516 * header of @a wim_file. (Probably a pre-Vista WIM).
1517 * @retval ::WIMLIB_ERR_XML
1518 * The XML data for @a wim_file is invalid.
1520 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1521 WIMStruct **wim_ret,
1522 wimlib_progress_func_t progress_func);
1525 * Overwrites the file that the WIM was originally read from, with changes made.
1526 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1527 * rather than wimlib_create_new_wim().
1529 * There are two ways that a WIM may be overwritten. The first is to do a full
1530 * rebuild. In this mode, the new WIM is written to a temporary file and then
1531 * renamed to the original file after it is has been completely written. The
1532 * temporary file is made in the same directory as the original WIM file. A
1533 * full rebuild may take a while, but can be used even if images have been
1534 * modified or deleted, will produce a WIM with no holes, and has little chance
1535 * of unintentional data loss because the temporary WIM is fsync()ed before
1536 * being renamed to the original WIM.
1538 * The second way to overwrite a WIM is by appending to the end of it and
1539 * overwriting the header. This can be much faster than a full rebuild, but it
1540 * only works if the only operations on the WIM have been to change the header
1541 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1542 * with writing any new file resources *after* everything in the old WIM, even
1543 * though this will leave a hole where the old lookup table, XML data, and
1544 * integrity were. This is done so that the WIM remains valid even if the
1545 * operation is aborted mid-write. The WIM header is only overwritten at the
1546 * very last moment, and up until that point the WIM will be seen as the old
1549 * By default, the overwrite mode is determine automatically based on the past
1550 * operations performed on the ::WIMStruct. Use the flag
1551 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1552 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1553 * images have been deleted from the WIM.
1555 * In the temporary-file overwrite mode, no changes are made to the WIM on
1556 * failure, and the temporary file is deleted if possible. Abnormal termination
1557 * of the program will result in the temporary file being orphaned. In the
1558 * direct append mode, the WIM is truncated to the original length on failure;
1559 * and while abnormal termination of the program will result in extra data
1560 * appended to the original WIM, it should still be a valid WIM.
1563 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1564 * been in-memory changes made to it, which are then reflected in the
1566 * @param write_flags
1567 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1568 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1569 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1570 * @param num_threads
1571 * Number of threads to use for compression (see wimlib_write()).
1572 * @param progress_func
1573 * If non-NULL, a function that will be called periodically with the
1574 * progress of the current operation.
1576 * @return 0 on success; nonzero on error. This function may return any value
1577 * returned by wimlib_write() as well as the following error codes:
1578 * @retval ::WIMLIB_ERR_NO_FILENAME
1579 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1580 * than a WIM read with wimlib_open_wim().
1581 * @retval ::WIMLIB_ERR_RENAME
1582 * The temporary file that the WIM was written to could not be renamed to
1583 * the original filename of @a wim.
1584 * @retval ::WIMLIB_ERR_REOPEN
1585 * The WIM was overwritten successfully, but it could not be re-opened
1586 * read-only. Therefore, the resources in the WIM can no longer be
1587 * accessed, so this limits the functions that can be called on @a wim
1588 * before calling wimlib_free().
1590 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1591 unsigned num_threads,
1592 wimlib_progress_func_t progress_func);
1595 * Prints information about one image, or all images, contained in a WIM.
1598 * Pointer to the ::WIMStruct for a WIM file.
1600 * The image about which to print information. Can be the number of an
1601 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1604 * @return This function has no return value. No error checking is done when
1605 * printing the information. If @a image is invalid, an error message is
1608 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1611 * Prints the full paths to all files contained in an image, or all images, in a
1615 * Pointer to the ::WIMStruct for a WIM file.
1617 * Which image to print files for. Can be the number of an image, or
1618 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1620 * @return 0 on success; nonzero on error.
1621 * @retval ::WIMLIB_ERR_DECOMPRESSION
1622 * The metadata resource for one of the specified images could not be
1624 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1625 * A directory entry in the metadata resource for one of the specified
1626 * images is invaled.
1627 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1628 * @a image does not specify a valid image in @a wim, and is not
1629 * ::WIMLIB_ALL_IMAGES.
1630 * @retval ::WIMLIB_ERR_INVALID_PARAM
1631 * @a wim was @c NULL.
1632 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1633 * The metadata resource for one of the specified images is invalid.
1634 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1635 * The security data for one of the specified images is invalid.
1636 * @retval ::WIMLIB_ERR_NOMEM
1637 * Failed to allocate needed memory.
1638 * @retval ::WIMLIB_ERR_READ
1639 * An unexpected read error or end-of-file occurred when reading the
1640 * metadata resource for one of the specified images.
1641 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1642 * @a wim was not a standalone WIM and was not the first part of a split
1645 extern int wimlib_print_files(WIMStruct *wim, int image);
1648 * Prints detailed information from the header of a WIM file.
1651 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1652 * standalone WIM or part of a split WIM.
1654 * @return This function has no return value.
1657 extern void wimlib_print_header(const WIMStruct *wim);
1660 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1661 * digests, as found in the directory entry tree in the WIM file, to file
1662 * resources in the WIM file. This table includes one entry for each unique
1663 * file in the WIM, so it can be quite long. There is only one lookup table per
1664 * WIM file, but each split WIM part has its own lookup table.
1667 * Pointer to the ::WIMStruct for a WIM file.
1669 * @return This function has no return value.
1671 extern void wimlib_print_lookup_table(WIMStruct *wim);
1674 * Prints the metadata of the specified image in a WIM file. The metadata
1675 * consists of the security data as well as the directory entry tree. Each
1676 * image has its own metadata.
1679 * Pointer to the ::WIMStruct for a WIM file.
1681 * Which image to print the metadata for. Can be the number of an image,
1682 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1684 * @return 0 on success; nonzero on error.
1685 * @retval ::WIMLIB_ERR_DECOMPRESSION
1686 * The metadata resource for one of the specified images could not be
1688 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1689 * A directory entry in the metadata resource for one of the specified
1690 * images is invaled.
1691 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1692 * @a image does not specify a valid image in @a wim, and is not
1693 * ::WIMLIB_ALL_IMAGES.
1694 * @retval ::WIMLIB_ERR_INVALID_PARAM
1695 * @a wim was @c NULL.
1696 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1697 * The metadata resource for one of the specified images is invalid.
1698 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1699 * The security data for one of the specified images is invalid.
1700 * @retval ::WIMLIB_ERR_NOMEM
1701 * Failed to allocate needed memory.
1702 * @retval ::WIMLIB_ERR_READ
1703 * An unexpected read error or end-of-file occurred when reading the
1704 * metadata resource for one of the specified images.
1705 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1706 * @a wim was not a standalone WIM and was not the first part of a split
1709 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1712 * Prints some basic information about a WIM file. All information printed by
1713 * this function is also printed by wimlib_print_header(), but
1714 * wimlib_print_wim_information() prints some of this information more concisely
1715 * and in a more readable form.
1718 * Pointer to the ::WIMStruct for a WIM file.
1720 * @return This function has no return value.
1722 extern void wimlib_print_wim_information(const WIMStruct *wim);
1725 * Translates a string specifying the name or number of an image in the WIM into
1726 * the number of the image. The images are numbered starting at 1.
1729 * Pointer to the ::WIMStruct for a WIM file.
1730 * @param image_name_or_num
1731 * A string specifying the name or number of an image in the WIM. If it
1732 * parses to a positive integer, this integer is taken to specify the
1733 * number of the image, indexed starting at 1. Otherwise, it is taken to
1734 * be the name of an image, as given in the XML data for the WIM file. It
1735 * also may be the keyword "all" or the string "*", both of which will
1736 * resolve to ::WIMLIB_ALL_IMAGES.
1738 * There is no way to search for an image actually named "all", "*", or an
1739 * integer number, or an image that has no name. However, you can use
1740 * wimlib_get_image_name() to get the name of any image.
1743 * If the string resolved to a single existing image, the number of that
1744 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
1745 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
1746 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
1747 * the empty string, ::WIM_NO_IMAGE is returned, even if one or more images
1748 * in @a wim has no name.
1750 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1753 * Sets which image in the WIM is marked as bootable.
1756 * Pointer to the ::WIMStruct for a WIM file.
1758 * The number of the image to mark as bootable, or 0 to mark no image as
1760 * @return 0 on success; nonzero on error.
1761 * @retval ::WIMLIB_ERR_INVALID_PARAM
1762 * @a wim was @c NULL.
1763 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1764 * @a boot_idx does not specify an existing image in @a wim, and it was not
1766 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1767 * @a wim is part of a split WIM. We do not support changing the boot
1768 * index of a split WIM.
1770 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1773 * Changes the description of an image in the WIM.
1776 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1777 * standalone WIM or part of a split WIM; however, you should set the same
1778 * description on all parts of a split WIM.
1780 * The number of the image for which to change the description.
1781 * @param description
1782 * The new description to give the image. It may be @c NULL, which
1783 * indicates that the image is to be given no description.
1785 * @return 0 on success; nonzero on error.
1786 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1787 * @a image does not specify a single existing image in @a wim.
1788 * @retval ::WIMLIB_ERR_INVALID_PARAM
1789 * @a wim was @c NULL.
1790 * @retval ::WIMLIB_ERR_NOMEM
1791 * Failed to allocate the memory needed to duplicate the @a description
1794 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1795 const char *description);
1798 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1799 * (something like "Core" or "Ultimate")
1802 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1803 * standalone WIM or part of a split WIM; however, you should set the same
1804 * \<FLAGS\> element on all parts of a split WIM.
1806 * The number of the image for which to change the description.
1808 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1809 * indicates that the image is to be given no \<FLAGS\> element.
1811 * @return 0 on success; nonzero on error.
1812 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1813 * @a image does not specify a single existing image in @a wim.
1814 * @retval ::WIMLIB_ERR_INVALID_PARAM
1815 * @a wim was @c NULL.
1816 * @retval ::WIMLIB_ERR_NOMEM
1817 * Failed to allocate the memory needed to duplicate the @a flags string.
1819 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1822 * Changes the name of an image in the WIM.
1825 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1826 * standalone WIM or part of a split WIM; however, you should set the same
1827 * name on all parts of a split WIM.
1829 * The number of the image for which to change the name.
1831 * The new name to give the image. It must not a nonempty string.
1833 * @return 0 on success; nonzero on error.
1834 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1835 * There is already an image named @a name in @a wim.
1836 * @retval ::WIMLIB_ERR_INVALID_PARAM
1837 * @a name was @c NULL or the empty string, or @a wim was @c NULL.
1838 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1839 * @a image does not specify a single existing image in @a wim.
1840 * @retval ::WIMLIB_ERR_NOMEM
1841 * Failed to allocate the memory needed to duplicate the @a name string.
1843 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1846 * Set the functions that wimlib uses to allocate and free memory.
1848 * These settings are global and not per-WIM.
1850 * The default is to use the default @c malloc() and @c free() from the C
1853 * Please note that some external functions, such as those in @c libntfs-3g, may
1854 * use the standard memory allocation functions.
1856 * @param malloc_func
1857 * A function equivalent to @c malloc() that wimlib will use to allocate
1858 * memory. If @c NULL, the allocator function is set back to the default
1859 * @c malloc() from the C library.
1861 * A function equivalent to @c free() that wimlib will use to free memory.
1862 * If @c NULL, the free function is set back to the default @c free() from
1864 * @param realloc_func
1865 * A function equivalent to @c realloc() that wimlib will use to reallocate
1866 * memory. If @c NULL, the free function is set back to the default @c
1867 * realloc() from the C library.
1868 * @return 0 on success; nonzero on error.
1869 * @retval ::WIMLIB_ERR_UNSUPPORTED
1870 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1871 * so custom memory allocators are unsupported.
1873 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1874 void (*free_func)(void *),
1875 void *(*realloc_func)(void *, size_t));
1878 * Sets whether wimlib is to print error messages to @c stderr when a function
1879 * fails. These error messages may provide information that cannot be
1880 * determined only from the error code that is returned. Not every error will
1881 * result in an error message being printed.
1883 * This setting is global and not per-WIM.
1885 * By default, error messages are not printed.
1887 * @param show_messages
1888 * @c true if error messages are to be printed; @c false if error messages
1889 * are not to be printed.
1891 * @return 0 on success; nonzero on error.
1892 * @retval ::WIMLIB_ERR_UNSUPPORTED
1893 * @a show_messages was @c true, but wimlib was compiled with the @c
1894 * --without-error-messages option. Therefore, error messages cannot be
1897 extern int wimlib_set_print_errors(bool show_messages);
1900 * Splits a WIM into multiple parts.
1903 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
1906 * Name of the SWM file to create. This will be the name of the first
1907 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1908 * appended before the suffix.
1910 * The maximum size per part, in bytes. It is not guaranteed that this
1911 * will really be the maximum size per part, because some file resources in
1912 * the WIM may be larger than this size, and the WIM file format provides
1913 * no way to split up file resources among multiple WIMs.
1914 * @param write_flags
1915 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
1916 * included in the split WIM parts.
1917 * @param progress_func
1918 * If non-NULL, a function that will be called periodically with the
1919 * progress of the current operation.
1921 * @return 0 on success; nonzero on error. This function may return any value
1922 * returned by wimlib_write() as well as the following error codes:
1924 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED:
1925 * @a wim is not part 1 of a stand-alone WIM.
1926 * @retval ::WIMLIB_ERR_INVALID_PARAM
1927 * @a w was @c NULL, @a swm_name was @c NULL, or @a part_size was 0.
1929 * Note: the WIM's uncompressed and compressed resources are not checksummed
1930 * when they are copied from the joined WIM to the split WIM parts, nor are
1931 * compressed resources re-compressed.
1933 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
1934 size_t part_size, int write_flags,
1935 wimlib_progress_func_t progress_func);
1938 * Unmounts a WIM image that was mounted using wimlib_mount_image().
1940 * The image to unmount is specified by the path to the mountpoint, not the
1941 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
1942 * touched and also may have been allocated in a different process.
1944 * To unmount the image, the thread calling this function communicates with the
1945 * thread that is managing the mounted WIM image. This function blocks until it
1946 * is known whether the unmount succeeded or failed. (This means until the
1947 * entire WIM has been re-written, in the case of a read-write mounted WIM.)
1949 * There is currently a design problem with this function because it is hard to
1950 * know whether the filesystem thread is still working or whether it has crashed
1951 * or has been killed. Currently, a timeout of 600 seconds (so long because
1952 * WIMs can be very large) is implemented so that this function will not wait
1953 * forever before returning failure.
1956 * The directory that the WIM image was mounted on.
1957 * @param unmount_flags
1958 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY and/or
1959 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1961 * @param progress_func
1962 * Currently ignored, but may be used for a progress callback in the
1963 * future. Set to @c NULL.
1965 * @return 0 on success; nonzero on error.
1966 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1967 * The filesystem daemon was unable to remove the staging directory and the
1968 * temporary files that it contains.
1969 * @retval ::WIMLIB_ERR_FORK
1970 * Could not @c fork() the process.
1971 * @retval ::WIMLIB_ERR_FUSERMOUNT
1972 * The @b fusermount program could not be executed or exited with a failure
1974 * @retval ::WIMLIB_ERR_MQUEUE
1975 * Could not open a POSIX message queue to communicate with the filesystem
1976 * daemon servicing the mounted filesystem, could not send a message
1977 * through the queue, or could not receive a message through the queue.
1978 * @retval ::WIMLIB_ERR_NOMEM
1979 * Failed to allocate needed memory.
1980 * @retval ::WIMLIB_ERR_OPEN
1981 * The filesystem daemon could not open a temporary file for writing the
1983 * @retval ::WIMLIB_ERR_TIMEOUT
1984 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1985 * the process of its exit status, so the WIM file probably was not written
1987 * @retval ::WIMLIB_ERR_READ
1988 * A read error occurred when the filesystem daemon tried to a file from
1989 * the staging directory
1990 * @retval ::WIMLIB_ERR_RENAME
1991 * The filesystem daemon failed to rename the newly written WIM file to the
1992 * original WIM file.
1993 * @retval ::WIMLIB_ERR_WRITE
1994 * A write error occurred when the filesystem daemon was writing to the new
1995 * WIM file, or the filesystem daemon was unable to flush changes that had
1996 * been made to files in the staging directory.
1998 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
1999 wimlib_progress_func_t progress_func);
2002 * Writes a standalone WIM to a file.
2004 * This brings in resources from any external locations, such as directory trees
2005 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2006 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2009 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2010 * changes made to it, which are then reflected in the output file.
2012 * The path to the file to write the WIM to.
2014 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2016 * @param write_flags
2017 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2018 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2019 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2020 * @param num_threads
2021 * Number of threads to use for compressing data. If 0, the number of
2022 * threads is taken to be the number of online processors. Note: if no
2023 * data compression needs to be done, no additional threads will be created
2024 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2025 * exporting an image from a compressed WIM to another WIM of the same
2026 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2028 * @param progress_func
2029 * If non-NULL, a function that will be called periodically with the
2030 * progress of the current operation.
2032 * @return 0 on success; nonzero on error.
2033 * @retval ::WIMLIB_ERR_DECOMPRESSION
2034 * Failed to decompress a metadata or file resource in @a wim.
2035 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2036 * A directory entry in the metadata resource for @a image in @a wim is
2038 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2039 * @a image does not specify a single existing image in @a wim, and is not
2040 * ::WIMLIB_ALL_IMAGES.
2041 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2042 * A file that had previously been scanned for inclusion in the WIM by the
2043 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
2044 * concurrently modified, so it failed the SHA1 message digest check.
2045 * @retval ::WIMLIB_ERR_INVALID_PARAM
2046 * @a wim or @a path was @c NULL.
2047 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2048 * The metadata resource for @a image in @a wim is invalid.
2049 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2050 * The security data for @a image in @a wim is invalid.
2051 * @retval ::WIMLIB_ERR_NOMEM
2052 * Failed to allocate needed memory.
2053 * @retval ::WIMLIB_ERR_OPEN
2054 * Failed to open @a path for writing, or some file resources in @a
2055 * wim refer to files in the outside filesystem, and one of these files
2056 * could not be opened for reading.
2057 * @retval ::WIMLIB_ERR_READ
2058 * An error occurred when trying to read data from the WIM file associated
2059 * with @a wim, or some file resources in @a wim refer to files in the
2060 * outside filesystem, and a read error occurred when reading one of these
2062 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2063 * @a wim is part of a split WIM. You may not call this function on a
2065 * @retval ::WIMLIB_ERR_WRITE
2066 * An error occurred when trying to write data to the new WIM file at @a
2069 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2070 int write_flags, unsigned num_threads,
2071 wimlib_progress_func_t progress_func);
2073 #endif /* _WIMLIB_H */