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 * This is the documentation for the library interface of wimlib 1.2.0. If you
35 * have installed wimlib and want to know how to use the @c imagex program,
36 * please see the man pages instead.
38 * wimlib is a C library to read, write, and mount archive files in the Windows
39 * Imaging Format (WIM files). These files are normally created using the @c
40 * imagex.exe utility on Windows, but this library provides a free
41 * implementetion of @c imagex for UNIX-based systems and an API to allow other
42 * programs to read, write, and mount WIM files. wimlib is comparable to
43 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
45 * \section format WIM files
47 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
48 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
49 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
50 * Both are based on LZ77 and Huffman encoding, and both are supported by
53 * Unlike ZIP files, WIM files can contain multiple independent toplevel
54 * directory trees known as @a images. While each image has its own metadata,
55 * files are not duplicated for each image; instead, each file is included only
56 * once in the entire WIM. Microsoft did this so that in one WIM file, they
57 * could do things like have 5 different versions of Windows that are almost
60 * Microsoft provides documentation for the WIM file format, XPRESS compression
61 * format, and LZX compression format. The XPRESS documentation is acceptable,
62 * but the LZX documentation is not entirely correct, and the WIM documentation
63 * itself is incomplete.
65 * A WIM file may be either stand-alone or split into multiple parts.
67 * \section ntfs NTFS support
69 * As of version 1.0.0, wimlib supports capturing and applying images directly
70 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
71 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
72 * data such as security descriptors, alternate data streams, and reparse point
75 * The code for NTFS image capture and image application is complete enough that
76 * it is possible to apply an image from the "install.wim" contained in recent
77 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
78 * NTFS volume, and then boot Windows from it after preparing the Boot
79 * Configuration Data. In addition, a Windows installation can be captured (or
80 * backed up) into a WIM file, and then re-applied later.
82 * \section winpe Windows PE
84 * A major use for this library is to create customized images of Windows PE, the
85 * Windows Preinstallation Environment, without having to rely on Windows. Windows
86 * PE is a lightweight version of Windows that can run entirely from memory and can
87 * be used to install Windows from local media or a network drive or perform
88 * maintenance. Windows PE is the operating system that runs when you boot from
89 * the Windows installation media.
91 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
92 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
93 * in the Windows Automated Installation Kit (WAIK), which is free to download
94 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
95 * install either the @c cabextract or @c p7zip programs.
97 * In addition, Windows installations and recovery partitions frequently contain a
98 * WIM containing an image of the Windows Recovery Environment, which is similar to
101 * \section starting Getting Started
103 * wimlib uses the GNU autotools, so it should be easy to install with
104 * <code>configure && make && sudo make install</code>; however, please see the
105 * README for more information about installing it. To use wimlib in a program
106 * after installing it, include @c wimlib.h and link your program with @c -lwim.
108 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
109 * may represent either a stand-alone WIM or one part of a split WIM.
111 * All functions in wimlib's public API are prefixed with @c wimlib. Most
112 * return an integer error code on failure. Use wimlib_get_error_string() to
113 * get a string that describes an error code. wimlib also can print error
114 * messages itself when an error happens, and these may be more informative than
115 * the error code; to enable this, call wimlib_set_print_errors(). Please note
116 * that this is for convenience only, and some errors can occur without a
117 * message being printed.
119 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
120 * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
121 * both apply globally.
123 * To open an existing WIM, use wimlib_open_wim().
125 * To create a new WIM that initially contains no images, use
126 * wimlib_create_new_wim().
128 * To add an image to a WIM file from a directory tree on your filesystem, call
129 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
130 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
131 * also capture a WIM image directly from a NTFS volume if you provide the
132 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
133 * the <code>--without-ntfs-3g</code> flag.
135 * To extract an image from a WIM file, call wimlib_extract_image(). You may
136 * extract an image either to a directory or directly to a NTFS volume, the
137 * latter of which will preserve NTFS-specific data such as security
140 * wimlib supports mounting WIM files either read-only or read-write. Mounting
141 * is done using wimlib_mount_image() and unmounting is done using
142 * wimlib_unmount_image(). Mounting can be done without root privileges because
143 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
144 * compiled with the <code>--without-fuse</code> flag, these functions will be
145 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
147 * After creating or modifying a WIM file, you can write it to a file using
148 * wimlib_write(). Alternatively, if the WIM was originally read from a file
149 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
150 * wimlib_overwrite() to overwrite the original file.
152 * Please note: merely by calling wimlib_add_image() or many of the other
153 * functions in this library that operate on ::WIMStruct's, you are @b not
154 * modifying the WIM file on disk. Changes are not saved until you explicitly
155 * call wimlib_write() or wimlib_overwrite().
157 * After you are done with the WIM file, use wimlib_free() to free all memory
158 * associated with a ::WIMStruct and close all files associated with it.
160 * A number of functions take a pointer to a progress function of type
161 * ::wimlib_progress_func_t. This function will be called periodically during
162 * the WIM operation(s) to report on the progress of the operation (for example,
163 * how many bytes have been written so far).
165 * \section imagex imagex
167 * wimlib comes with a command-line interface, the @b imagex program. It is
168 * documented with man pages. See its source code (@c programs/imagex.c in
169 * wimlib's source tree) for an example of how to use wimlib in your program.
171 * \section mkwinpeimg mkwinpeimg
173 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
176 * \section Limitations
178 * While wimlib supports the main features of WIM files, wimlib currently has
179 * the following limitations:
180 * - wimlib cannot be used on MS-Windows.
181 * - There is no way to add, remove, modify, or extract specific files in a WIM
182 * without mounting it, other than by adding, removing, or extracting an
183 * entire image. The FUSE mount feature should be used for this purpose.
184 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
185 * than wimlib when using maximum (LZX) compression because it knows how to
186 * split up LZX compressed blocks, which is not yet implemented in wimlib.
187 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
188 * imagex.exe if you want to make sure your WIM files are made "correctly".
189 * - The old WIM format from Vista pre-releases is not supported.
190 * - Compressed resource chunk sizes other than 32768 are not supported,
191 * although this doesn't seem to be a problem because the chunk size always
192 * seems to be this value.
193 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
194 * make certain Windows-specific modifications to a Windows PE image, such as
195 * adding a driver or Windows component. Such a tool could conceivably be
196 * implemented on top of wimlib, although it likely would be hard to implement
197 * because it would have to do very Windows-specific things such as
198 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
199 * script for a similar purpose, however. With regards to adding drivers to
200 * Windows PE, you have the option of putting them anywhere in the Windows PE
201 * image, then loading them after boot using @b drvload.exe.
203 * \section legal License
205 * The wimlib library, as well as the programs and scripts distributed with it
206 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
207 * License version 3 or later.
216 #include <inttypes.h>
218 #define WIMLIB_MAJOR_VERSION 1
219 #define WIMLIB_MINOR_VERSION 2
220 #define WIMLIB_PATCH_VERSION 0
223 * Opaque structure that represents a WIM file. This is an in-memory structure
224 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
225 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
226 * continuing to exist so that data can be read from it as needed.
228 * Most functions in this library will work the same way regardless of whether a
229 * given ::WIMStruct was obtained through wimlib_open_wim() or
230 * wimlib_create_new_wim(). Exceptions are documented.
232 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
233 * file from a ::WIMStruct.
235 typedef struct WIMStruct WIMStruct;
238 * Specifies the compression type of a WIM file.
240 enum wimlib_compression_type {
241 /** An invalid compression type. */
242 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
244 /** The WIM does not include any compressed resources. */
245 WIMLIB_COMPRESSION_TYPE_NONE = 0,
247 /** Compressed resources in the WIM use LZX compression. */
248 WIMLIB_COMPRESSION_TYPE_LZX = 1,
250 /** Compressed resources in the WIM use XPRESS compression. */
251 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
254 /** Possible values of the first parameter to the user-supplied
255 * ::wimlib_progress_func_t progress function */
256 enum wimlib_progress_msg {
258 /** A WIM image is about to be extracted. @a info will point to
259 * ::wimlib_progress_info.extract. */
260 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
262 /** The directory structure of the WIM image is about to be extracted.
263 * @a info will point to ::wimlib_progress_info.extract. */
264 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
266 /** The directory structure of the WIM image has been successfully
267 * extracted. @a info will point to ::wimlib_progress_info.extract. */
268 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
270 /** The WIM image's files resources are currently being extracted. @a
271 * info will point to ::wimlib_progress_info.extract. */
272 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
274 /** A file or directory is being extracted. @a info will point to
275 * ::wimlib_progress_info.extract, and the @a cur_path member will be
277 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
279 /** All the WIM files and directories have been extracted, and
280 * timestamps are about to be applied. @a info will point to
281 * ::wimlib_progress_info.extract. */
282 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
284 /** A WIM image has been successfully extracted. @a info will point to
285 * ::wimlib_progress_info.extract. */
286 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
288 /** The directory or NTFS volume is about to be scanned to build a tree
289 * of WIM dentries in-memory. @a info will point to
290 * ::wimlib_progress_info.scan. */
291 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
293 /** A directory or file is being scanned. @a info will point to
294 * ::wimlib_progress_info.scan, and its @a cur_path member will be
295 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
296 * is passed to wimlib_add_image(). */
297 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
299 /** The directory or NTFS volume has been successfully scanned, and a
300 * tree of WIM dentries has been built in-memory. @a info will point to
301 * ::wimlib_progress_info.scan. */
302 WIMLIB_PROGRESS_MSG_SCAN_END,
305 * File resources are currently being written to the WIM.
306 * @a info will point to ::wimlib_progress_info.write_streams. */
307 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
310 * The metadata resource for each image is about to be written to the
311 * WIM. @a info will not be valid. */
312 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
315 * The metadata resource for each image has successfully been writen to
316 * the WIM. @a info will not be valid. */
317 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
320 * The temporary file has successfully been renamed to the original WIM
321 * file. Only happens when wimlib_overwrite() is called and the
322 * overwrite is not done in-place.
323 * @a info will point to ::wimlib_progress_info.rename. */
324 WIMLIB_PROGRESS_MSG_RENAME,
326 /** The contents of the WIM are being checked against the integrity
327 * table. Only happens when wimlib_open_wim() is called with the
328 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
329 * ::wimlib_progress_info.integrity. */
330 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
332 /** An integrity table is being calculated for the WIM being written.
333 * Only happens when wimlib_write() or wimlib_overwrite() is called with
334 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
335 * ::wimlib_progress_info.integrity. */
336 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
338 /** A wimlib_join() operation is in progress. @a info will point to
339 * ::wimlib_progress_info.join. */
340 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
342 /** A wimlib_split() operation is in progress, and a new split part is
343 * about to be started. @a info will point to
344 * ::wimlib_progress_info.split. */
345 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
347 /** A wimlib_split() operation is in progress, and a split part has been
348 * finished. @a info will point to ::wimlib_progress_info.split. */
349 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
352 /** A pointer to this union is passed to the user-supplied
353 * ::wimlib_progress_func_t progress function. One (or none) of the structures
354 * contained in this union will be applicable for the operation
355 * (::wimlib_progress_msg) indicated in the first argument to the progress
357 union wimlib_progress_info {
359 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
360 * document them if they aren't given a name... */
362 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
363 struct wimlib_progress_info_write_streams {
364 /** Number of bytes that are going to be written for all the
365 * streams combined. This is the amount in uncompressed data.
366 * (The actual number of bytes will be less if the data is being
367 * written compressed.) */
368 uint64_t total_bytes;
369 /** Number of streams that are going to be written. */
370 uint64_t total_streams;
372 /** Number of uncompressed bytes that have been written so far.
373 * Will be 0 initially, and equal to @a total_bytes at the end.
375 uint64_t completed_bytes;
377 /** Number of streams that have been written. Will be 0
378 * initially, and equal to @a total_streams at the end. */
379 uint64_t completed_streams;
381 /** Number of threads that are being used to compress resources
382 * (if applicable). */
383 unsigned num_threads;
385 /** The compression type being used to write the streams; either
386 * ::WIMLIB_COMPRESSION_TYPE_NONE,
387 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
388 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
389 int compression_type;
392 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
393 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
394 struct wimlib_progress_info_scan {
395 /** Directory or NTFS volume that is being scanned. */
398 /** Path to the file or directory that is about to be scanned,
399 * relative to the root of the image capture or the NTFS volume.
401 const char *cur_path;
403 /** True iff @a cur_path is being excluded from the image
404 * capture due to the capture configuration file. */
408 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
409 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
410 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
411 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
412 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
413 struct wimlib_progress_info_extract {
414 /** Number of the image being extracted (1-based). */
417 /** Flags passed to to wimlib_extract_image() */
420 /** Full path to the WIM file being extracted. */
421 const char *wimfile_name;
423 /** Name of the image being extracted. */
424 const char *image_name;
426 /** Directory or NTFS volume to which the image is being
430 /** Current dentry being extracted. (Valid only if message is
431 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
432 const char *cur_path;
434 /** Number of bytes of uncompressed data that will be extracted.
435 * Takes into account hard links (they are not counted for each
438 uint64_t total_bytes;
440 /** Number of bytes that have been written so far. Will be 0
441 * initially, and equal to @a total_bytes at the end. */
442 uint64_t completed_bytes;
444 /** Number of streams that will be extracted. This may more or
445 * less than the number of "files" to be extracted due to
446 * special cases (hard links, symbolic links, and alternate data
448 uint64_t num_streams;
451 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
452 struct wimlib_progress_info_rename {
453 /** Name of the temporary file that the WIM was written to. */
456 /** Name of the original WIM file to which the temporary file is
461 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
462 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
463 struct wimlib_progress_info_integrity {
464 /** Number of bytes from the end of the WIM header to the end of
465 * the lookup table (the area that is covered by the SHA1
466 * integrity checks.) */
467 uint64_t total_bytes;
469 /** Number of bytes that have been SHA1-summed so far. Will be
470 * 0 initially, and equal @a total_bytes at the end. */
471 uint64_t completed_bytes;
473 /** Number of chunks that the checksummed region is divided
475 uint32_t total_chunks;
477 /** Number of chunks that have been SHA1-summed so far. Will
478 * be 0 initially, and equal to @a total_chunks at the end. */
479 uint32_t completed_chunks;
481 /** Size of the chunks used for the integrity calculation. */
484 /** Filename of the WIM (only valid if the message is
485 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
486 const char *filename;
489 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
490 struct wimlib_progress_info_join {
491 /** Total number of bytes of compressed data contained in all
492 * the split WIM part's file and metadata resources. */
493 uint64_t total_bytes;
495 /** Number of bytes that have been copied to the joined WIM so
496 * far. Will be 0 initially, and equal to @a total_bytes at the
498 uint64_t completed_bytes;
500 /** Number of split WIM parts that have had all their file and
501 * metadata resources copied over to the joined WIM so far. */
502 unsigned completed_parts;
504 /** Number of split WIM parts. */
505 unsigned total_parts;
508 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
509 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
510 struct wimlib_progress_info_split {
511 /** Total size of the original WIM's file and metadata resources
513 uint64_t total_bytes;
515 /** Number of bytes of file and metadata resources that have
516 * been copied out of the original WIM so far. Will be 0
517 * initially, and equal to @a total_bytes at the end. */
518 uint64_t completed_bytes;
520 /** Number of the split WIM part that is about to be started
521 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
522 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
523 unsigned cur_part_number;
525 /** Name of the split WIM part that is about to be started
526 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
527 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
528 const char *part_name;
532 /** A user-supplied function that will be called periodically during certain WIM
533 * operations. The first argument will be the type of operation that is being
534 * performed or is about to be started or has been completed. The second
535 * argument will be a pointer to one of a number of structures depending on the
536 * first argument. It may be @c NULL for some message types.
538 * The return value of the progress function is currently ignored, but it may do
539 * something in the future. (Set it to 0 for now.)
541 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
542 const union wimlib_progress_info *info);
545 /*****************************
546 * WIMLIB_ADD_IMAGE_FLAG_* *
547 *****************************/
549 /** Directly capture a NTFS volume rather than a generic directory */
550 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
552 /** Follow symlinks; archive and dump the files they point to. Cannot be used
553 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
554 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
556 /** Call the progress function with the message
557 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
559 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
561 /** Mark the image being added as the bootable image of the WIM. */
562 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
564 /******************************
565 * WIMLIB_EXPORT_FLAG_* *
566 ******************************/
568 /** See documentation for wimlib_export_image(). */
569 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
571 /******************************
572 * WIMLIB_EXTRACT_FLAG_* *
573 ******************************/
575 /** Extract the image directly to a NTFS volume rather than a generic directory.
577 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
579 /** When identical files are extracted from the WIM, always hard link them
580 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
581 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
583 /** When identical files are extracted from the WIM, always symlink them
584 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
585 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
587 /** Call the progress function with the argument
588 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
589 * extracted. Note: these calls will be interspersed with calls for the message
590 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
591 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
593 /** Read the WIM file sequentially while extracting the image. */
594 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
596 /******************************
597 * WIMLIB_MOUNT_FLAG_* *
598 ******************************/
600 /** Mount the WIM image read-write rather than the default of read-only. */
601 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
603 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
604 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
606 /** Do not allow accessing alternate data streams in the mounted WIM image. */
607 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
609 /** Access alternate data streams in the mounted WIM image through extended file
610 * attributes. This is the default mode. */
611 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
613 /** Access alternate data streams in the mounted WIM image by specifying the
614 * file name, a colon, then the alternate file stream name. */
615 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
617 /******************************
618 * WIMLIB_OPEN_FLAG_* *
619 ******************************/
621 /** Verify the WIM contents against the WIM's integrity table, if present. */
622 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
624 /** Do not issue an error if the WIM is part of a split WIM. */
625 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
627 /******************************
628 * WIMLIB_UNMOUNT_FLAG_* *
629 ******************************/
631 /** Include an integrity table in the WIM after it's been unmounted. Ignored
632 * for read-only mounts. */
633 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
635 /** Unless this flag is given, changes to a read-write mounted WIM are
636 * discarded. Ignored for read-only mounts. */
637 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
639 /******************************
640 * WIMLIB_WRITE_FLAG_* *
641 ******************************/
643 /** Include an integrity table in the new WIM file. */
644 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
646 /** Re-build the entire WIM file rather than appending data to it, if possible.
647 * (Applies to wimlib_overwrite(), not wimlib_write()). */
648 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
650 /** Recompress all resources, even if they could otherwise be copied from a
651 * different WIM with the same compression type (in the case of
652 * wimlib_export_image() being called previously). */
653 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
655 /** Call fsync() when the WIM file is closed */
656 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
658 /** Specifying this flag overrides the default behavior of wimlib_overwrite()
659 * after one or more calls to wimlib_delete_image(), which is to rebuild the
662 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
663 * correctly remove the image from the WIM will be taken. In particular, all
664 * streams will be left alone, even if they are no longer referenced. This is
665 * probably not what you want, because almost no space will be spaced by
666 * deleting an image in this way. */
667 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
670 * Possible values of the error code returned by many functions in wimlib.
672 * See the documentation for each wimlib function to see specifically what error
673 * codes can be returned by a given function, and what they mean.
675 enum wimlib_error_code {
676 WIMLIB_ERR_SUCCESS = 0,
677 WIMLIB_ERR_ALREADY_LOCKED,
678 WIMLIB_ERR_CHAR_CONVERSION,
679 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
680 WIMLIB_ERR_DECOMPRESSION,
681 WIMLIB_ERR_DELETE_STAGING_DIR,
684 WIMLIB_ERR_FUSERMOUNT,
685 WIMLIB_ERR_IMAGE_COUNT,
686 WIMLIB_ERR_IMAGE_NAME_COLLISION,
687 WIMLIB_ERR_INTEGRITY,
688 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
689 WIMLIB_ERR_INVALID_CHUNK_SIZE,
690 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
691 WIMLIB_ERR_INVALID_DENTRY,
692 WIMLIB_ERR_INVALID_HEADER_SIZE,
693 WIMLIB_ERR_INVALID_IMAGE,
694 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
695 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
696 WIMLIB_ERR_INVALID_PARAM,
697 WIMLIB_ERR_INVALID_PART_NUMBER,
698 WIMLIB_ERR_INVALID_RESOURCE_HASH,
699 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
700 WIMLIB_ERR_INVALID_SECURITY_DATA,
706 WIMLIB_ERR_NOT_A_WIM_FILE,
707 WIMLIB_ERR_NO_FILENAME,
715 WIMLIB_ERR_RESOURCE_ORDER,
716 WIMLIB_ERR_SPECIAL_FILE,
717 WIMLIB_ERR_SPLIT_INVALID,
718 WIMLIB_ERR_SPLIT_UNSUPPORTED,
721 WIMLIB_ERR_UNKNOWN_VERSION,
722 WIMLIB_ERR_UNSUPPORTED,
728 /** Used to indicate that no WIM image or an invalid WIM image. */
729 #define WIMLIB_NO_IMAGE 0
731 /** Used to specify all images in the WIM. */
732 #define WIMLIB_ALL_IMAGES (-1)
735 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
737 * The directory tree is read immediately for the purpose of constructing a
738 * directory entry tree in-memory. Also, all files are read to calculate their
739 * SHA1 message digests. However, because the directory tree may contain a very
740 * large amount of data, the files themselves are not read into memory
741 * permanently, and instead references to their paths saved. The files are then
742 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
744 * Please note that @b no changes are committed to the underlying WIM file (if
745 * any) until wimlib_write() or wimlib_overwrite() is called.
748 * Pointer to the ::WIMStruct for a WIM file to which the image will be
751 * A path to a directory or unmounted NTFS volume that will be captured as
754 * The name to give the image. This must be non-@c NULL.
756 * Pointer to the contents of an image capture configuration file. If @c
757 * NULL, a default string is used. Please see the manual page for
758 * <b>imagex capture</b> for more information.
760 * Length of the string @a config in bytes. Ignored if @a config is @c
763 * @param add_image_flags
764 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
765 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
766 * marked as bootable is changed to the one being added. If
767 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
768 * printed as it is scanned or captured. If
769 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
770 * directories pointed to by symbolic links are archived rather than the
771 * symbolic links themselves.
773 * @param progress_func
774 * If non-NULL, a function that will be called periodically with the
775 * progress of the current operation.
777 * @return 0 on success; nonzero on error. On error, changes to @a wim are
778 * discarded so that it appears to be in the same state as when this function
781 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
782 * There is already an image named @a name in @a wim.
783 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
784 * @a config was not @c NULL and did not specify a valid image capture
786 * @retval ::WIMLIB_ERR_INVALID_PARAM
787 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
788 * @retval ::WIMLIB_ERR_NOMEM
789 * Failed to allocate needed memory.
790 * @retval ::WIMLIB_ERR_NOTDIR
791 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
792 * not specified in @a add_image_flags).
793 * @retval ::WIMLIB_ERR_NTFS_3G
794 * An error was returned from a libntfs-3g function when the NTFS volume
795 * was being opened, scanned, or closed (only if
796 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
797 * @retval ::WIMLIB_ERR_OPEN
798 * Failed to open a file or directory in the directory tree rooted at @a
799 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
801 * @retval ::WIMLIB_ERR_READ
802 * Failed to read a file in the directory tree rooted at @a source (only if
803 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
804 * @retval ::WIMLIB_ERR_SPECIAL_FILE
805 * The directory tree rooted at @a source contains a special file that is
806 * not a directory, regular file, or symbolic link. This currently can
807 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
808 * add_image_flags, but it may be returned for unsupported NTFS files in
810 * @retval ::WIMLIB_ERR_STAT
811 * Failed obtain the metadata for a file or directory in the directory tree
812 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
813 * specified in @a add_image_flags).
814 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
815 * @a wim is part of a split WIM. Adding an image to a split WIM is
817 * @retval ::WIMLIB_ERR_UNSUPPORTED:
818 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
819 * wimlib was configured with the @c --without-ntfs-3g flag.
821 extern int wimlib_add_image(WIMStruct *wim, const char *source,
822 const char *name, const char *config,
823 size_t config_len, int add_image_flags,
824 wimlib_progress_func_t progress_func);
827 * Creates a ::WIMStruct for a new WIM file.
829 * This only creates an in-memory structure for a WIM that initially contains no
830 * images. No on-disk file is created until wimlib_write() is called.
833 * The type of compression to be used in the new WIM file. Must be
834 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
835 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
837 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
838 * written to the memory location pointed to by this paramater. The
839 * ::WIMStruct must be freed using using wimlib_free() when finished with
841 * @return 0 on success; nonzero on error.
842 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
843 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
844 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
845 * @retval ::WIMLIB_ERR_NOMEM
846 * Failed to allocate needed memory.
848 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
851 * Deletes an image, or all images, from a WIM file.
853 * All streams referenced by the image(s) being deleted are removed from the
854 * lookup table of the WIM if they are not referenced by any other images in the
857 * Please note that @b no changes are committed to the underlying WIM file (if
858 * any) until wimlib_write() or wimlib_overwrite() is called.
861 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
864 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
866 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
867 * to be left unmodified only if @a image specified a single image. If instead
868 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
869 * possible for some but not all of the images to have been deleted when a
870 * failure status is returned.
872 * @retval ::WIMLIB_ERR_DECOMPRESSION
873 * Could not decompress the metadata resource for @a image.
874 * @retval ::WIMLIB_ERR_INVALID_DENTRY
875 * A directory entry in the metadata resource for @a image in the WIM is
877 * @retval ::WIMLIB_ERR_INVALID_IMAGE
878 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
879 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
880 * The metadata resource for @a image in the WIM is invalid.
881 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
882 * The security data for @a image in the WIM is invalid.
883 * @retval ::WIMLIB_ERR_NOMEM
884 * Failed to allocate needed memory.
885 * @retval ::WIMLIB_ERR_READ
886 * Could not read the metadata resource for @a image from the WIM.
887 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
888 * @a wim is part of a split WIM. Deleting an image from a split WIM is
891 extern int wimlib_delete_image(WIMStruct *wim, int image);
894 * Exports an image, or all the images, from a WIM file, into another WIM file.
896 * The destination image is made to share the same dentry tree and security data
897 * structure as the source image. This places some restrictions on additional
898 * functions that may be called. wimlib_mount_image() may not be called on
899 * either the source image or the destination image without an intervening call
900 * to a function that un-shares the images, such as wimlib_free() on @a
901 * dest_wim, or wimlib_delete_image() on either the source or destination image.
902 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
903 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
904 * have references back to @a src_wim.
906 * Previous versions of this function left @a dest_wim in an indeterminate state
907 * on failure. This is no longer the case; all changes to @a dest_wim made by
908 * this function are rolled back on failure.
910 * Previous versions of this function did not allow exporting an image that had
911 * been added by wimlib_add_image(). This is no longer the case; you may now
912 * export an image regardless of how it was added.
914 * Regardless of whether this function succeeds or fails, no changes are made to
917 * Please note that no changes are committed to the underlying WIM file of @a
918 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
921 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
922 * WIM that contains the image(s) being exported.
924 * The image to export from @a src_wim. Can be the number of an image, or
925 * ::WIMLIB_ALL_IMAGES to export all images.
927 * Pointer to the ::WIMStruct for a WIM file that will receive the images
930 * The name to give the exported image in the new WIM file. If left @c
931 * NULL, the name from @a src_wim is used. This parameter must be left @c
932 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
933 * than one image; in that case, the names are all taken from the @a
934 * src_wim. (This is allowed even if one or more images being exported has
936 * @param dest_description
937 * The description to give the exported image in the new WIM file. If left
938 * @c NULL, the description from the @a src_wim is used. This parameter must
939 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
940 * more than one image; in that case, the descriptions are all taken from
941 * @a src_wim. (This is allowed even if one or more images being exported
942 * has no description.)
943 * @param export_flags
944 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
945 * bootable, or 0 if which image is marked as bootable in the destination
946 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
947 * there are multiple images in @a src_wim, specifying
948 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
949 * currently marked as bootable in @a src_wim; if that is the case, then
950 * that image is marked as bootable in the destination WIM.
951 * @param additional_swms
952 * Array of pointers to the ::WIMStruct for each additional part in the
953 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
954 * need to be in any particular order, but they must include all parts of
955 * the split WIM other than the first part, which must be provided in the
957 * @param num_additional_swms
958 * Number of additional WIM parts provided in the @a additional_swms array.
959 * This number should be one less than the total number of parts in the
960 * split WIM. Set to 0 if the WIM is a standalone WIM.
961 * @param progress_func
962 * If non-NULL, a function that will be called periodically with the
963 * progress of the current operation.
965 * @return 0 on success; nonzero on error.
966 * @retval ::WIMLIB_ERR_DECOMPRESSION
967 * Could not decompress the metadata resource for @a src_image
969 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
970 * One or more of the names being given to an exported image was already in
971 * use in the destination WIM.
972 * @retval ::WIMLIB_ERR_INVALID_DENTRY
973 * A directory entry in the metadata resource for @a src_image in @a
974 * src_wim is invalid.
975 * @retval ::WIMLIB_ERR_INVALID_IMAGE
976 * @a src_image does not exist in @a src_wim.
977 * @retval ::WIMLIB_ERR_INVALID_PARAM
978 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
979 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
980 * @a src_wim are marked as bootable; or @a dest_name and/or @a
981 * dest_description were non-<code>NULL</code>, @a src_image was
982 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
983 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
984 * The metadata resource for @a src_image in @a src_wim is invalid.
985 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
986 * The security data for @a src_image in @a src_wim is invalid.
987 * @retval ::WIMLIB_ERR_NOMEM
988 * Failed to allocate needed memory.
989 * @retval ::WIMLIB_ERR_READ
990 * Could not read the metadata resource for @a src_image from @a src_wim.
991 * @retval ::WIMLIB_ERR_SPLIT_INVALID
992 * The source WIM is a split WIM, but the parts specified do not form a
993 * complete split WIM because they do not include all the parts of the
994 * original WIM, there are duplicate parts, or not all the parts have the
995 * same GUID and compression type.
996 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
997 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1000 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
1001 WIMStruct *dest_wim, const char *dest_name,
1002 const char *dest_description, int export_flags,
1003 WIMStruct **additional_swms,
1004 unsigned num_additional_swms,
1005 wimlib_progress_func_t progress_func);
1008 * Extracts an image, or all images, from a standalone or split WIM file to a
1009 * directory or a NTFS volume.
1011 * Please see the manual page for the @c imagex program for more information
1012 * about the "normal" extraction mode versus the NTFS extraction mode
1013 * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1015 * Extraction is done with one thread.
1017 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1018 * returned if any resulting SHA1 message digests do not match the values
1019 * provided in the WIM file. Therefore, if this function is successful, you can
1020 * be fairly sure that any compressed data in the WIM was uncompressed
1024 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1027 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1028 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1029 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1031 * Directory to extract the WIM image(s) to (created if it does not already
1032 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1033 * path to the unmounted NTFS volume to extract the image to.
1034 * @param extract_flags
1035 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1037 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1038 * a NTFS volume to extract the image to. The volume will be opened using
1039 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1040 * Otherwise, @a target is interpreted as a directory to extract the
1043 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1044 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1045 * specified. These flags cause extracted files that are identical to be
1046 * hardlinked or symlinked together, depending on the flag. These flags
1047 * override the hard link groups that are specified in the WIM file itself.
1048 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1049 * hardlinked or symlinked across images if a file is found to occur in
1050 * more than one image.
1052 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1053 * name of each file or directory as it is extracted.
1055 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1056 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1057 * each image is considered separately with regards to the sequential
1058 * order. It is also possible for alternate data streams to break the
1059 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1061 * @param additional_swms
1062 * Array of pointers to the ::WIMStruct for each additional part in the
1063 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1064 * need to be in any particular order, but they must include all parts of
1065 * the split WIM other than the first part, which must be provided in the
1067 * @param num_additional_swms
1068 * Number of additional WIM parts provided in the @a additional_swms array.
1069 * This number should be one less than the total number of parts in the
1070 * split WIM. Set to 0 if the WIM is a standalone WIM.
1072 * @param progress_func
1073 * If non-NULL, a function that will be called periodically with the
1074 * progress of the current operation.
1076 * @return 0 on success; nonzero on error.
1077 * @retval ::WIMLIB_ERR_DECOMPRESSION
1078 * Could not decompress a resource (file or metadata) for @a image in @a
1080 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1081 * A directory entry in the metadata resource for @a image in @a wim is
1083 * @retval ::WIMLIB_ERR_INVALID_PARAM
1084 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1085 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags, or
1086 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1087 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1088 * specified in @a extract_flags, or ::WIMLIB_EXTRACT_FLAG_NTFS was
1089 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES.
1090 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1091 * The SHA1 message digest of an extracted stream did not match the SHA1
1092 * message digest given in the WIM file.
1093 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1094 * A resource (file or metadata) for @a image in @a wim is invalid.
1095 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1096 * The security data for @a image in @a wim is invalid.
1097 * @retval ::WIMLIB_ERR_LINK
1098 * Failed to create a symbolic link or a hard link (only if
1099 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1100 * @retval ::WIMLIB_ERR_MKDIR
1101 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1102 * not specified in @a extract_flags).
1103 * @retval ::WIMLIB_ERR_NOMEM
1104 * Failed to allocate needed memory.
1105 * @retval ::WIMLIB_ERR_NTFS_3G
1106 * An error was returned from a libntfs-3g function while the WIM image was
1107 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1108 * was specified in @a extract_flags).
1109 * @retval ::WIMLIB_ERR_OPEN
1110 * Could not open one of the files being extracted for writing (only if
1111 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1112 * @retval ::WIMLIB_ERR_READ
1113 * A unexpected end-of-file or read error occurred when trying to read data
1114 * from the WIM file associated with @a wim.
1115 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1116 * The WIM is a split WIM, but the parts specified do not form a complete
1117 * split WIM because they do not include all the parts of the original WIM,
1118 * there are duplicate parts, or not all the parts have the same GUID and
1120 * @retval ::WIMLIB_ERR_UNSUPPORTED
1121 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1122 * was configured with the @c --without-ntfs-3g flag.
1123 * @retval ::WIMLIB_ERR_WRITE
1124 * Failed to write a file being extracted (only if
1125 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1127 extern int wimlib_extract_image(WIMStruct *wim, int image,
1128 const char *target, int extract_flags,
1129 WIMStruct **additional_swms,
1130 unsigned num_additional_swms,
1131 wimlib_progress_func_t progress_func);
1134 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1135 * includes a string of XML that describes the images contained in the WIM.
1136 * This function works on standalone WIMs as well as split WIM parts.
1139 * Pointer to the ::WIMStruct for a WIM file.
1141 * @c stdout, or a FILE* opened for writing, to extract the data to.
1143 * @return 0 on success; nonzero on error.
1144 * @retval ::WIMLIB_ERR_WRITE
1145 * Failed to completely write the XML data to @a fp.
1146 * @retval ::WIMLIB_ERR_INVALID_PARAM
1147 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1149 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1152 * Frees all memory allocated for a WIMStruct and closes all files associated
1156 * Pointer to the ::WIMStruct for a WIM file.
1158 * @return This function has no return value.
1160 extern void wimlib_free(WIMStruct *wim);
1163 * Returns the index of the bootable image of the WIM.
1166 * Pointer to the ::WIMStruct for a WIM file.
1169 * 0 if no image is marked as bootable, or the number of the image marked
1170 * as bootable (numbered starting at 1).
1172 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1175 * Returns the compression type used in the WIM.
1178 * Pointer to the ::WIMStruct for a WIM file
1181 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1182 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1184 extern int wimlib_get_compression_type(const WIMStruct *wim);
1187 * Converts a ::wimlib_compression_type value into a string.
1190 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1191 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1194 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1197 extern const char *wimlib_get_compression_type_string(int ctype);
1200 * Converts an error code into a string describing it.
1203 * The error code returned by one of wimlib's functions.
1206 * Pointer to a statically allocated string describing the error code,
1207 * or @c NULL if the error code is not valid.
1209 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1212 * Returns the description of the specified image.
1215 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1216 * standalone WIM or a split WIM part.
1218 * The number of the image, numbered starting at 1.
1221 * The description of the image, or @c NULL if there is no such image, or
1222 * @c NULL if the specified image has no description. The description
1223 * string is in library-internal memory and may not be modified or freed;
1224 * in addition, the string will become invalid if the description of the
1225 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1227 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1230 * Returns the name of the specified image.
1233 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1234 * standalone WIM or a split WIM part.
1236 * The number of the image, numbered starting at 1.
1239 * The name of the image, or @c NULL if there is no such image. The name
1240 * string is in library-internal memory and may not be modified or freed;
1241 * in addition, the string will become invalid if the name of the image is
1242 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1244 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1245 * the WIM to be unnamed, in which case an empty string will be returned
1246 * when the corresponding name is requested.
1248 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1252 * Returns the number of images contained in a WIM.
1255 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1256 * standalone WIM or a split WIM part.
1259 * The number of images contained in the WIM file.
1261 extern int wimlib_get_num_images(const WIMStruct *wim);
1264 * Returns the part number of a WIM in a split WIM and the total number of parts
1268 * Pointer to the ::WIMStruct for a WIM file.
1269 * @param total_parts_ret
1270 * If non-@c NULL, the total number of parts in the split WIM (1 for
1271 * non-split WIMs) is written to this location.
1274 * The part number of the WIM (1 for non-split WIMs)
1276 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1279 * Returns true if the WIM has an integrity table.
1282 * Pointer to the ::WIMStruct for a WIM file.
1284 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1285 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1286 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1287 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1289 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1293 * Determines if an image name is already used by some image in the WIM.
1296 * Pointer to the ::WIMStruct for a WIM file.
1298 * The name to check.
1301 * @c true if there is already an image in @a wim named @a name; @c false
1302 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1303 * the empty string, @c false is returned.
1305 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1308 * Joins a split WIM into a stand-alone one-part WIM.
1311 * An array of strings that gives the filenames of all parts of the split
1312 * WIM. No specific order is required, but all parts must be included with
1315 * Number of filenames in @a swms.
1316 * @param swm_open_flags
1317 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1318 * part should be verified, if integrity tables are present. Otherwise,
1320 * @param wim_write_flags
1321 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1322 * @param output_path
1323 * The path to write the one-part WIM to.
1324 * @param progress_func
1325 * If non-NULL, a function that will be called periodically with the
1326 * progress of the current operation.
1328 * @return 0 on success; nonzero on error. This function may return any value
1329 * returned by wimlib_open_wim() and wimlib_write() except
1330 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1332 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1333 * The split WIMs do not form a valid WIM because they do not include all
1334 * the parts of the original WIM, there are duplicate parts, or not all the
1335 * parts have the same GUID and compression type.
1337 * Note: the WIM's uncompressed and compressed resources are not checksummed
1338 * when they are copied from the split WIM parts to the joined WIM, nor are
1339 * compressed resources re-compressed.
1341 * Note: wimlib_export_image() can provide similar functionality to
1342 * wimlib_join(), since it is possible to export all images from a split WIM.
1344 extern int wimlib_join(const char **swms, unsigned num_swms,
1345 const char *output_path, int swm_open_flags,
1346 int wim_write_flags,
1347 wimlib_progress_func_t progress_func);
1350 * Mounts an image in a WIM file on a directory read-only or read-write.
1352 * The calling thread will be daemonized service the filesystem, and this
1353 * function will not return until the image is unmounted, unless an error occurs
1354 * before the filesystem is successfully mounted.
1356 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1357 * modifications to the WIM are staged in a temporary directory.
1359 * It is safe to mount multiple images from the same WIM file read-only at the
1360 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1361 * to mount multiple images from the same WIM file read-write at the same time.
1363 * wimlib_mount_image() cannot be used on an image that was exported with
1364 * wimlib_export_image() while the dentry trees for both images are still in
1365 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1366 * that has just been added with wimlib_add_image(), unless the WIM has been
1367 * written and read into a new ::WIMStruct.
1370 * Pointer to the ::WIMStruct containing the image to be mounted.
1372 * The number of the image to mount, indexed starting from it. It must be
1373 * an existing, single image.
1375 * The path to an existing empty directory to mount the image on.
1376 * @param mount_flags
1377 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1379 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1380 * rather than the default of read-only.
1382 * WIMs may contain named (alternate) data streams, which are a somewhat
1383 * obscure NTFS feature. They can be read and written on a mounted WIM
1384 * through one of several interfaces. The interface to use if specified by
1385 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1386 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1387 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1388 * the XATTR interface.
1389 * @param additional_swms
1390 * Array of pointers to the ::WIMStruct for each additional part in the
1391 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1392 * need to be in any particular order, but they must include all parts of
1393 * the split WIM other than the first part, which must be provided in the
1395 * @param num_additional_swms
1396 * Number of additional WIM parts provided in the @a additional_swms array.
1397 * This number should be one less than the total number of parts in the
1398 * split WIM. Set to 0 if the WIM is a standalone WIM.
1399 * @param staging_dir
1400 * If non-NULL, the name of a directory in which the staging directory will
1401 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1402 * in @a mount_flags. If left @c NULL, the staging directory is created in
1403 * the same directory as the WIM file that @a wim was originally read from.
1405 * @return 0 on success; nonzero on error.
1406 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1407 * A read-write mount was requested, but an an exclusive advisory lock on
1408 * the on-disk WIM file could not be acquired because another thread or
1409 * process has mounted an image from the WIM read-write or is currently
1410 * modifying the WIM in-place.
1411 * @retval ::WIMLIB_ERR_DECOMPRESSION
1412 * Could not decompress the metadata resource for @a image in @a wim.
1413 * @retval ::WIMLIB_ERR_FUSE
1414 * A non-zero status was returned by @c fuse_main().
1415 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1416 * A directory entry in the metadata resource for @a image in @a wim is
1418 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1419 * @a image does not specify an existing, single image in @a wim.
1420 * @retval ::WIMLIB_ERR_INVALID_PARAM
1421 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1422 * wimlib_export_image(), or @a image has been added with
1423 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
1424 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1425 * The metadata resource for @a image in @a wim is invalid.
1426 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1427 * The security data for @a image in @a wim is invalid.
1428 * @retval ::WIMLIB_ERR_MKDIR
1429 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1430 * staging directory could not be created.
1431 * @retval ::WIMLIB_ERR_NOMEM
1432 * Failed to allocate needed memory.
1433 * @retval ::WIMLIB_ERR_NOTDIR
1434 * Could not determine the current working directory.
1435 * @retval ::WIMLIB_ERR_READ
1436 * An unexpected end-of-file or read error occurred when trying to read
1437 * data from the WIM file associated with @a wim.
1438 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1439 * The WIM is a split WIM, but the parts specified do not form a complete
1440 * split WIM because they do not include all the parts of the original WIM,
1441 * there are duplicate parts, or not all the parts have the same GUID and
1443 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1444 * The WIM is a split WIM and a read-write mount was requested. We only
1445 * support mounting a split WIM read-only.
1447 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1448 int mount_flags, WIMStruct **additional_swms,
1449 unsigned num_additional_swms,
1450 const char *staging_dir);
1453 * Opens a WIM file and creates a ::WIMStruct for it.
1456 * The path to the WIM file to open.
1458 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1459 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1461 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1462 * the WIM, if it exists, is checked, and this function will fail with an
1463 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1464 * digests of the WIM do not exactly match the corresponding message
1465 * digests given in the integrity table.
1467 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1468 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1469 * returned. (This flag may be removed in the future, in which case no
1470 * error will be issued when opening a split WIM.)
1472 * @param progress_func
1473 * If non-NULL, a function that will be called periodically with the
1474 * progress of the current operation.
1477 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1478 * is written to the memory location pointed to by this parameter. The
1479 * ::WIMStruct must be freed using using wimlib_free() when finished with
1482 * @return 0 on success; nonzero on error.
1483 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1484 * The lookup table of @a wim_file is compressed. Support for this can be
1485 * added to wimlib if needed, but it appears to be the case that the lookup
1486 * table is never compressed.
1487 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1488 * The WIM is not the non-first part of a split WIM, and the number of
1489 * metadata resources found in the WIM did not match the image count given
1490 * in the WIM header, or the number of <IMAGE> elements in the XML
1491 * data for the WIM did not match the image count given in the WIM header.
1492 * @retval ::WIMLIB_ERR_INTEGRITY
1493 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1494 * wim_file contains an integrity table, but the SHA1 message digest for a
1495 * chunk of the WIM does not match the corresponding message digest given
1496 * in the integrity table.
1497 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1498 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1499 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1500 * The header of @a wim_file says that resources in the WIM are compressed,
1501 * but the header flag indicating LZX or XPRESS compression is not set.
1502 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1503 * The length field of the WIM header is not 208.
1504 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1505 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1506 * wim_file contains an integrity table, but the integrity table is
1508 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1509 * The lookup table for the WIM contained duplicate entries that are not
1510 * for metadata resources, or it contained an entry with a SHA1 message
1511 * digest of all 0's.
1512 * @retval ::WIMLIB_ERR_NOMEM
1513 * Failed to allocated needed memory.
1514 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1515 * @a wim_file does not begin with the expected magic characters.
1516 * @retval ::WIMLIB_ERR_OPEN
1517 * Failed to open the file @a wim_file for reading.
1518 * @retval ::WIMLIB_ERR_READ
1519 * An unexpected end-of-file or read error occurred when trying to read
1520 * data from @a wim_file.
1521 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1522 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1523 * specified in @a open_flags.
1524 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1525 * A number other than 0x10d00 is written in the version field of the WIM
1526 * header of @a wim_file. (Probably a pre-Vista WIM).
1527 * @retval ::WIMLIB_ERR_XML
1528 * The XML data for @a wim_file is invalid.
1530 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1531 WIMStruct **wim_ret,
1532 wimlib_progress_func_t progress_func);
1535 * Overwrites the file that the WIM was originally read from, with changes made.
1536 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1537 * rather than wimlib_create_new_wim().
1539 * There are two ways that a WIM may be overwritten. The first is to do a full
1540 * rebuild. In this mode, the new WIM is written to a temporary file and then
1541 * renamed to the original file after it is has been completely written. The
1542 * temporary file is made in the same directory as the original WIM file. A
1543 * full rebuild may take a while, but can be used even if images have been
1544 * modified or deleted, will produce a WIM with no holes, and has little chance
1545 * of unintentional data loss because the temporary WIM is fsync()ed before
1546 * being renamed to the original WIM.
1548 * The second way to overwrite a WIM is by appending to the end of it and
1549 * overwriting the header. This can be much faster than a full rebuild, but it
1550 * only works if the only operations on the WIM have been to change the header
1551 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1552 * with writing any new file resources *after* everything in the old WIM, even
1553 * though this will leave a hole where the old lookup table, XML data, and
1554 * integrity were. This is done so that the WIM remains valid even if the
1555 * operation is aborted mid-write. The WIM header is only overwritten at the
1556 * very last moment, and up until that point the WIM will be seen as the old
1559 * By default, the overwrite mode is determine automatically based on the past
1560 * operations performed on the ::WIMStruct. Use the flag
1561 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1562 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1563 * images have been deleted from the WIM.
1565 * In the temporary-file overwrite mode, no changes are made to the WIM on
1566 * failure, and the temporary file is deleted if possible. Abnormal termination
1567 * of the program will result in the temporary file being orphaned. In the
1568 * direct append mode, the WIM is truncated to the original length on failure;
1569 * and while abnormal termination of the program will result in extra data
1570 * appended to the original WIM, it should still be a valid WIM.
1573 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1574 * been in-memory changes made to it, which are then reflected in the
1576 * @param write_flags
1577 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1578 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1579 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1580 * @param num_threads
1581 * Number of threads to use for compression (see wimlib_write()).
1582 * @param progress_func
1583 * If non-NULL, a function that will be called periodically with the
1584 * progress of the current operation.
1586 * @return 0 on success; nonzero on error. This function may return any value
1587 * returned by wimlib_write() as well as the following error codes:
1588 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1589 * The WIM was going to be modifien in-place (with no temporary file), but
1590 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1591 * because another thread or process has mounted an image from the WIM
1592 * read-write or is currently modifying the WIM in-place.
1593 * @retval ::WIMLIB_ERR_NO_FILENAME
1594 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1595 * than a WIM read with wimlib_open_wim().
1596 * @retval ::WIMLIB_ERR_RENAME
1597 * The temporary file that the WIM was written to could not be renamed to
1598 * the original filename of @a wim.
1599 * @retval ::WIMLIB_ERR_REOPEN
1600 * The WIM was overwritten successfully, but it could not be re-opened
1601 * read-only. Therefore, the resources in the WIM can no longer be
1602 * accessed, so this limits the functions that can be called on @a wim
1603 * before calling wimlib_free().
1605 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1606 unsigned num_threads,
1607 wimlib_progress_func_t progress_func);
1610 * Prints information about one image, or all images, contained in a WIM.
1613 * Pointer to the ::WIMStruct for a WIM file.
1615 * The image about which to print information. Can be the number of an
1616 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1619 * @return This function has no return value. No error checking is done when
1620 * printing the information. If @a image is invalid, an error message is
1623 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1626 * Prints the full paths to all files contained in an image, or all images, in a
1630 * Pointer to the ::WIMStruct for a WIM file.
1632 * Which image to print files for. Can be the number of an image, or
1633 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1635 * @return 0 on success; nonzero on error.
1636 * @retval ::WIMLIB_ERR_DECOMPRESSION
1637 * The metadata resource for one of the specified images could not be
1639 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1640 * A directory entry in the metadata resource for one of the specified
1641 * images is invaled.
1642 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1643 * @a image does not specify a valid image in @a wim, and is not
1644 * ::WIMLIB_ALL_IMAGES.
1645 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1646 * The metadata resource for one of the specified images is invalid.
1647 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1648 * The security data for one of the specified images is invalid.
1649 * @retval ::WIMLIB_ERR_NOMEM
1650 * Failed to allocate needed memory.
1651 * @retval ::WIMLIB_ERR_READ
1652 * An unexpected read error or end-of-file occurred when reading the
1653 * metadata resource for one of the specified images.
1654 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1655 * @a wim was not a standalone WIM and was not the first part of a split
1658 extern int wimlib_print_files(WIMStruct *wim, int image);
1661 * Prints detailed information from the header of a WIM file.
1664 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1665 * standalone WIM or part of a split WIM.
1667 * @return This function has no return value.
1670 extern void wimlib_print_header(const WIMStruct *wim);
1673 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1674 * digests, as found in the directory entry tree in the WIM file, to file
1675 * resources in the WIM file. This table includes one entry for each unique
1676 * file in the WIM, so it can be quite long. There is only one lookup table per
1677 * WIM file, but each split WIM part has its own lookup table.
1680 * Pointer to the ::WIMStruct for a WIM file.
1682 * @return This function has no return value.
1684 extern void wimlib_print_lookup_table(WIMStruct *wim);
1687 * Prints the metadata of the specified image in a WIM file. The metadata
1688 * consists of the security data as well as the directory entry tree. Each
1689 * image has its own metadata.
1692 * Pointer to the ::WIMStruct for a WIM file.
1694 * Which image to print the metadata for. Can be the number of an image,
1695 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1697 * @return 0 on success; nonzero on error.
1698 * @retval ::WIMLIB_ERR_DECOMPRESSION
1699 * The metadata resource for one of the specified images could not be
1701 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1702 * A directory entry in the metadata resource for one of the specified
1703 * images is invaled.
1704 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1705 * @a image does not specify a valid image in @a wim, and is not
1706 * ::WIMLIB_ALL_IMAGES.
1707 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1708 * The metadata resource for one of the specified images is invalid.
1709 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1710 * The security data for one of the specified images is invalid.
1711 * @retval ::WIMLIB_ERR_NOMEM
1712 * Failed to allocate needed memory.
1713 * @retval ::WIMLIB_ERR_READ
1714 * An unexpected read error or end-of-file occurred when reading the
1715 * metadata resource for one of the specified images.
1716 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1717 * @a wim was not a standalone WIM and was not the first part of a split
1720 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1723 * Prints some basic information about a WIM file. All information printed by
1724 * this function is also printed by wimlib_print_header(), but
1725 * wimlib_print_wim_information() prints some of this information more concisely
1726 * and in a more readable form.
1729 * Pointer to the ::WIMStruct for a WIM file.
1731 * @return This function has no return value.
1733 extern void wimlib_print_wim_information(const WIMStruct *wim);
1736 * Translates a string specifying the name or number of an image in the WIM into
1737 * the number of the image. The images are numbered starting at 1.
1740 * Pointer to the ::WIMStruct for a WIM file.
1741 * @param image_name_or_num
1742 * A string specifying the name or number of an image in the WIM. If it
1743 * parses to a positive integer, this integer is taken to specify the
1744 * number of the image, indexed starting at 1. Otherwise, it is taken to
1745 * be the name of an image, as given in the XML data for the WIM file. It
1746 * also may be the keyword "all" or the string "*", both of which will
1747 * resolve to ::WIMLIB_ALL_IMAGES.
1749 * There is no way to search for an image actually named "all", "*", or an
1750 * integer number, or an image that has no name. However, you can use
1751 * wimlib_get_image_name() to get the name of any image.
1754 * If the string resolved to a single existing image, the number of that
1755 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
1756 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
1757 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
1758 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1759 * images in @a wim has no name.
1761 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1764 * Sets which image in the WIM is marked as bootable.
1767 * Pointer to the ::WIMStruct for a WIM file.
1769 * The number of the image to mark as bootable, or 0 to mark no image as
1771 * @return 0 on success; nonzero on error.
1772 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1773 * @a boot_idx does not specify an existing image in @a wim, and it was not
1775 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1776 * @a wim is part of a split WIM. We do not support changing the boot
1777 * index of a split WIM.
1779 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1782 * Changes the description of an image in the WIM.
1785 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1786 * standalone WIM or part of a split WIM; however, you should set the same
1787 * description on all parts of a split WIM.
1789 * The number of the image for which to change the description.
1790 * @param description
1791 * The new description to give the image. It may be @c NULL, which
1792 * indicates that the image is to be given no description.
1794 * @return 0 on success; nonzero on error.
1795 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1796 * @a image does not specify a single existing image in @a wim.
1797 * @retval ::WIMLIB_ERR_NOMEM
1798 * Failed to allocate the memory needed to duplicate the @a description
1801 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1802 const char *description);
1805 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1806 * (something like "Core" or "Ultimate")
1809 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1810 * standalone WIM or part of a split WIM; however, you should set the same
1811 * \<FLAGS\> element on all parts of a split WIM.
1813 * The number of the image for which to change the description.
1815 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1816 * indicates that the image is to be given no \<FLAGS\> element.
1818 * @return 0 on success; nonzero on error.
1819 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1820 * @a image does not specify a single existing image in @a wim.
1821 * @retval ::WIMLIB_ERR_NOMEM
1822 * Failed to allocate the memory needed to duplicate the @a flags string.
1824 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1827 * Changes the name of an image in the WIM.
1830 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1831 * standalone WIM or part of a split WIM; however, you should set the same
1832 * name on all parts of a split WIM.
1834 * The number of the image for which to change the name.
1836 * The new name to give the image. It must not a nonempty string.
1838 * @return 0 on success; nonzero on error.
1839 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1840 * There is already an image named @a name in @a wim.
1841 * @retval ::WIMLIB_ERR_INVALID_PARAM
1842 * @a name was @c NULL or the empty string.
1843 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1844 * @a image does not specify a single existing image in @a wim.
1845 * @retval ::WIMLIB_ERR_NOMEM
1846 * Failed to allocate the memory needed to duplicate the @a name string.
1848 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1851 * Set the functions that wimlib uses to allocate and free memory.
1853 * These settings are global and not per-WIM.
1855 * The default is to use the default @c malloc() and @c free() from the C
1858 * Please note that some external functions, such as those in @c libntfs-3g, may
1859 * use the standard memory allocation functions.
1861 * @param malloc_func
1862 * A function equivalent to @c malloc() that wimlib will use to allocate
1863 * memory. If @c NULL, the allocator function is set back to the default
1864 * @c malloc() from the C library.
1866 * A function equivalent to @c free() that wimlib will use to free memory.
1867 * If @c NULL, the free function is set back to the default @c free() from
1869 * @param realloc_func
1870 * A function equivalent to @c realloc() that wimlib will use to reallocate
1871 * memory. If @c NULL, the free function is set back to the default @c
1872 * realloc() from the C library.
1873 * @return 0 on success; nonzero on error.
1874 * @retval ::WIMLIB_ERR_UNSUPPORTED
1875 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1876 * so custom memory allocators are unsupported.
1878 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1879 void (*free_func)(void *),
1880 void *(*realloc_func)(void *, size_t));
1883 * Sets whether wimlib is to print error messages to @c stderr when a function
1884 * fails. These error messages may provide information that cannot be
1885 * determined only from the error code that is returned. Not every error will
1886 * result in an error message being printed.
1888 * This setting is global and not per-WIM.
1890 * By default, error messages are not printed.
1892 * @param show_messages
1893 * @c true if error messages are to be printed; @c false if error messages
1894 * are not to be printed.
1896 * @return 0 on success; nonzero on error.
1897 * @retval ::WIMLIB_ERR_UNSUPPORTED
1898 * @a show_messages was @c true, but wimlib was compiled with the @c
1899 * --without-error-messages option. Therefore, error messages cannot be
1902 extern int wimlib_set_print_errors(bool show_messages);
1905 * Splits a WIM into multiple parts.
1908 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
1911 * Name of the SWM file to create. This will be the name of the first
1912 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1913 * appended before the suffix.
1915 * The maximum size per part, in bytes. It is not guaranteed that this
1916 * will really be the maximum size per part, because some file resources in
1917 * the WIM may be larger than this size, and the WIM file format provides
1918 * no way to split up file resources among multiple WIMs.
1919 * @param write_flags
1920 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
1921 * included in the split WIM parts.
1922 * @param progress_func
1923 * If non-NULL, a function that will be called periodically with the
1924 * progress of the current operation.
1926 * @return 0 on success; nonzero on error. This function may return any value
1927 * returned by wimlib_write() as well as the following error codes:
1929 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED:
1930 * @a wim is not part 1 of a stand-alone WIM.
1931 * @retval ::WIMLIB_ERR_INVALID_PARAM
1932 * @a swm_name was @c NULL, or @a part_size was 0.
1934 * Note: the WIM's uncompressed and compressed resources are not checksummed
1935 * when they are copied from the joined WIM to the split WIM parts, nor are
1936 * compressed resources re-compressed.
1938 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
1939 size_t part_size, int write_flags,
1940 wimlib_progress_func_t progress_func);
1943 * Unmounts a WIM image that was mounted using wimlib_mount_image().
1945 * The image to unmount is specified by the path to the mountpoint, not the
1946 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
1947 * touched and also may have been allocated in a different process.
1949 * To unmount the image, the thread calling this function communicates with the
1950 * thread that is managing the mounted WIM image. This function blocks until it
1951 * is known whether the unmount succeeded or failed. (This means until the
1952 * entire WIM has been re-written, in the case of a read-write mounted WIM.)
1954 * There is currently a design problem with this function because it is hard to
1955 * know whether the filesystem thread is still working or whether it has crashed
1956 * or has been killed. Currently, a timeout of 600 seconds (so long because
1957 * WIMs can be very large) is implemented so that this function will not wait
1958 * forever before returning failure.
1961 * The directory that the WIM image was mounted on.
1962 * @param unmount_flags
1963 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY and/or
1964 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1966 * @param progress_func
1967 * Currently ignored, but may be used for a progress callback in the
1968 * future. Set to @c NULL.
1970 * @return 0 on success; nonzero on error.
1971 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1972 * The filesystem daemon was unable to remove the staging directory and the
1973 * temporary files that it contains.
1974 * @retval ::WIMLIB_ERR_FORK
1975 * Could not @c fork() the process.
1976 * @retval ::WIMLIB_ERR_FUSERMOUNT
1977 * The @b fusermount program could not be executed or exited with a failure
1979 * @retval ::WIMLIB_ERR_MQUEUE
1980 * Could not open a POSIX message queue to communicate with the filesystem
1981 * daemon servicing the mounted filesystem, could not send a message
1982 * through the queue, or could not receive a message through the queue.
1983 * @retval ::WIMLIB_ERR_NOMEM
1984 * Failed to allocate needed memory.
1985 * @retval ::WIMLIB_ERR_OPEN
1986 * The filesystem daemon could not open a temporary file for writing the
1988 * @retval ::WIMLIB_ERR_TIMEOUT
1989 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1990 * the process of its exit status, so the WIM file probably was not written
1992 * @retval ::WIMLIB_ERR_READ
1993 * A read error occurred when the filesystem daemon tried to a file from
1994 * the staging directory
1995 * @retval ::WIMLIB_ERR_RENAME
1996 * The filesystem daemon failed to rename the newly written WIM file to the
1997 * original WIM file.
1998 * @retval ::WIMLIB_ERR_WRITE
1999 * A write error occurred when the filesystem daemon was writing to the new
2000 * WIM file, or the filesystem daemon was unable to flush changes that had
2001 * been made to files in the staging directory.
2003 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
2004 wimlib_progress_func_t progress_func);
2007 * Writes a standalone WIM to a file.
2009 * This brings in resources from any external locations, such as directory trees
2010 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2011 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2014 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2015 * changes made to it, which are then reflected in the output file.
2017 * The path to the file to write the WIM to.
2019 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2021 * @param write_flags
2022 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2023 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2024 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2025 * @param num_threads
2026 * Number of threads to use for compressing data. If 0, the number of
2027 * threads is taken to be the number of online processors. Note: if no
2028 * data compression needs to be done, no additional threads will be created
2029 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2030 * exporting an image from a compressed WIM to another WIM of the same
2031 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2033 * @param progress_func
2034 * If non-NULL, a function that will be called periodically with the
2035 * progress of the current operation.
2037 * @return 0 on success; nonzero on error.
2038 * @retval ::WIMLIB_ERR_DECOMPRESSION
2039 * Failed to decompress a metadata or file resource in @a wim.
2040 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2041 * A directory entry in the metadata resource for @a image in @a wim is
2043 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2044 * @a image does not specify a single existing image in @a wim, and is not
2045 * ::WIMLIB_ALL_IMAGES.
2046 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2047 * A file that had previously been scanned for inclusion in the WIM by the
2048 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
2049 * concurrently modified, so it failed the SHA1 message digest check.
2050 * @retval ::WIMLIB_ERR_INVALID_PARAM
2051 * @a path was @c NULL.
2052 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2053 * The metadata resource for @a image in @a wim is invalid.
2054 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2055 * The security data for @a image in @a wim is invalid.
2056 * @retval ::WIMLIB_ERR_NOMEM
2057 * Failed to allocate needed memory.
2058 * @retval ::WIMLIB_ERR_OPEN
2059 * Failed to open @a path for writing, or some file resources in @a
2060 * wim refer to files in the outside filesystem, and one of these files
2061 * could not be opened for reading.
2062 * @retval ::WIMLIB_ERR_READ
2063 * An error occurred when trying to read data from the WIM file associated
2064 * with @a wim, or some file resources in @a wim refer to files in the
2065 * outside filesystem, and a read error occurred when reading one of these
2067 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2068 * @a wim is part of a split WIM. You may not call this function on a
2070 * @retval ::WIMLIB_ERR_WRITE
2071 * An error occurred when trying to write data to the new WIM file at @a
2074 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2075 int write_flags, unsigned num_threads,
2076 wimlib_progress_func_t progress_func);
2078 #endif /* _WIMLIB_H */
git://wimlib.net / wimlib / blob