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, 2013 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.7. 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 following exceptions:
121 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
122 * - You also must call wimlib_global_init() in the main thread to avoid any
123 * race conditions with one-time allocations of memory.
124 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
125 * concurrently in the same process, will daemonize the entire process when it
126 * does so for the first time. This includes changing the working directory
127 * to the root directory.
129 * To open an existing WIM, use wimlib_open_wim().
131 * To create a new WIM that initially contains no images, use
132 * wimlib_create_new_wim().
134 * To add an image to a WIM file from a directory tree on your filesystem, call
135 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
136 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
137 * also capture a WIM image directly from a NTFS volume if you provide the
138 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
139 * the <code>--without-ntfs-3g</code> flag.
141 * To extract an image from a WIM file, call wimlib_extract_image(). You may
142 * extract an image either to a directory or directly to a NTFS volume, the
143 * latter of which will preserve NTFS-specific data such as security
146 * wimlib supports mounting WIM files either read-only or read-write. Mounting
147 * is done using wimlib_mount_image() and unmounting is done using
148 * wimlib_unmount_image(). Mounting can be done without root privileges because
149 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
150 * compiled with the <code>--without-fuse</code> flag, these functions will be
151 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
153 * After creating or modifying a WIM file, you can write it to a file using
154 * wimlib_write(). Alternatively, if the WIM was originally read from a file
155 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
156 * wimlib_overwrite() to overwrite the original file.
158 * Please note: merely by calling wimlib_add_image() or many of the other
159 * functions in this library that operate on ::WIMStruct's, you are @b not
160 * modifying the WIM file on disk. Changes are not saved until you explicitly
161 * call wimlib_write() or wimlib_overwrite().
163 * After you are done with the WIM file, use wimlib_free() to free all memory
164 * associated with a ::WIMStruct and close all files associated with it.
166 * A number of functions take a pointer to a progress function of type
167 * ::wimlib_progress_func_t. This function will be called periodically during
168 * the WIM operation(s) to report on the progress of the operation (for example,
169 * how many bytes have been written so far).
171 * \section imagex imagex
173 * wimlib comes with a command-line interface, the @b imagex program. It is
174 * documented with man pages. See its source code (@c programs/imagex.c in
175 * wimlib's source tree) for an example of how to use wimlib in your program.
177 * \section mkwinpeimg mkwinpeimg
179 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
182 * \section Limitations
184 * While wimlib supports the main features of WIM files, wimlib currently has
185 * the following limitations:
186 * - wimlib cannot be used on MS-Windows.
187 * - There is no way to add, remove, modify, or extract specific files in a WIM
188 * without mounting it, other than by adding, removing, or extracting an
189 * entire image. The FUSE mount feature should be used for this purpose.
190 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
191 * than wimlib when using maximum (LZX) compression because it knows how to
192 * split up LZX compressed blocks, which is not yet implemented in wimlib.
193 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
194 * imagex.exe if you want to make sure your WIM files are made "correctly".
195 * - The old WIM format from Vista pre-releases is not supported.
196 * - Compressed resource chunk sizes other than 32768 are not supported,
197 * although this doesn't seem to be a problem because the chunk size always
198 * seems to be this value.
199 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
200 * make certain Windows-specific modifications to a Windows PE image, such as
201 * adding a driver or Windows component. Such a tool could conceivably be
202 * implemented on top of wimlib, although it likely would be hard to implement
203 * because it would have to do very Windows-specific things such as
204 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
205 * script for a similar purpose, however. With regards to adding drivers to
206 * Windows PE, you have the option of putting them anywhere in the Windows PE
207 * image, then loading them after boot using @b drvload.exe.
209 * \section legal License
211 * The wimlib library, as well as the programs and scripts distributed with it
212 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
213 * License version 3 or later.
222 #include <inttypes.h>
224 /** Major version of the library (for example, the 1 in 1.2.5). */
225 #define WIMLIB_MAJOR_VERSION 1
227 /** Minor version of the library (for example, the 2 in 1.2.5). */
228 #define WIMLIB_MINOR_VERSION 2
230 /** Patch version of the library (for example, the 5 in 1.2.5). */
231 #define WIMLIB_PATCH_VERSION 7
234 * Opaque structure that represents a WIM file. This is an in-memory structure
235 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
236 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
237 * continuing to exist so that data can be read from it as needed.
239 * Most functions in this library will work the same way regardless of whether a
240 * given ::WIMStruct was obtained through wimlib_open_wim() or
241 * wimlib_create_new_wim(). Exceptions are documented.
243 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
244 * file from a ::WIMStruct.
246 typedef struct WIMStruct WIMStruct;
249 * Specifies the compression type of a WIM file.
251 enum wimlib_compression_type {
252 /** An invalid compression type. */
253 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
255 /** The WIM does not include any compressed resources. */
256 WIMLIB_COMPRESSION_TYPE_NONE = 0,
258 /** Compressed resources in the WIM use LZX compression. */
259 WIMLIB_COMPRESSION_TYPE_LZX = 1,
261 /** Compressed resources in the WIM use XPRESS compression. */
262 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
265 /** Possible values of the first parameter to the user-supplied
266 * ::wimlib_progress_func_t progress function */
267 enum wimlib_progress_msg {
269 /** A WIM image is about to be extracted. @a info will point to
270 * ::wimlib_progress_info.extract. */
271 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
273 /** The directory structure of the WIM image is about to be extracted.
274 * @a info will point to ::wimlib_progress_info.extract. */
275 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
277 /** The directory structure of the WIM image has been successfully
278 * extracted. @a info will point to ::wimlib_progress_info.extract. */
279 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
281 /** The WIM image's files resources are currently being extracted. @a
282 * info will point to ::wimlib_progress_info.extract. */
283 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
285 /** A file or directory is being extracted. @a info will point to
286 * ::wimlib_progress_info.extract, and the @a cur_path member will be
288 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
290 /** All the WIM files and directories have been extracted, and
291 * timestamps are about to be applied. @a info will point to
292 * ::wimlib_progress_info.extract. */
293 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
295 /** A WIM image has been successfully extracted. @a info will point to
296 * ::wimlib_progress_info.extract. */
297 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
299 /** The directory or NTFS volume is about to be scanned to build a tree
300 * of WIM dentries in-memory. @a info will point to
301 * ::wimlib_progress_info.scan. */
302 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
304 /** A directory or file is being scanned. @a info will point to
305 * ::wimlib_progress_info.scan, and its @a cur_path member will be
306 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
307 * is passed to wimlib_add_image(). */
308 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
310 /** The directory or NTFS volume has been successfully scanned, and a
311 * tree of WIM dentries has been built in-memory. @a info will point to
312 * ::wimlib_progress_info.scan. */
313 WIMLIB_PROGRESS_MSG_SCAN_END,
316 * File resources are currently being written to the WIM.
317 * @a info will point to ::wimlib_progress_info.write_streams. */
318 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
321 * The metadata resource for each image is about to be written to the
322 * WIM. @a info will not be valid. */
323 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
326 * The metadata resource for each image has successfully been writen to
327 * the WIM. @a info will not be valid. */
328 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
331 * The temporary file has successfully been renamed to the original WIM
332 * file. Only happens when wimlib_overwrite() is called and the
333 * overwrite is not done in-place.
334 * @a info will point to ::wimlib_progress_info.rename. */
335 WIMLIB_PROGRESS_MSG_RENAME,
337 /** The contents of the WIM are being checked against the integrity
338 * table. Only happens when wimlib_open_wim() is called with the
339 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
340 * ::wimlib_progress_info.integrity. */
341 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
343 /** An integrity table is being calculated for the WIM being written.
344 * Only happens when wimlib_write() or wimlib_overwrite() is called with
345 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
346 * ::wimlib_progress_info.integrity. */
347 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
349 /** A wimlib_join() operation is in progress. @a info will point to
350 * ::wimlib_progress_info.join. */
351 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
353 /** A wimlib_split() operation is in progress, and a new split part is
354 * about to be started. @a info will point to
355 * ::wimlib_progress_info.split. */
356 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
358 /** A wimlib_split() operation is in progress, and a split part has been
359 * finished. @a info will point to ::wimlib_progress_info.split. */
360 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
363 /** A pointer to this union is passed to the user-supplied
364 * ::wimlib_progress_func_t progress function. One (or none) of the structures
365 * contained in this union will be applicable for the operation
366 * (::wimlib_progress_msg) indicated in the first argument to the progress
368 union wimlib_progress_info {
370 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
371 * document them if they aren't given a name... */
373 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
374 struct wimlib_progress_info_write_streams {
375 /** Number of bytes that are going to be written for all the
376 * streams combined. This is the amount in uncompressed data.
377 * (The actual number of bytes will be less if the data is being
378 * written compressed.) */
379 uint64_t total_bytes;
380 /** Number of streams that are going to be written. */
381 uint64_t total_streams;
383 /** Number of uncompressed bytes that have been written so far.
384 * Will be 0 initially, and equal to @a total_bytes at the end.
386 uint64_t completed_bytes;
388 /** Number of streams that have been written. Will be 0
389 * initially, and equal to @a total_streams at the end. */
390 uint64_t completed_streams;
392 /** Number of threads that are being used to compress resources
393 * (if applicable). */
394 unsigned num_threads;
396 /** The compression type being used to write the streams; either
397 * ::WIMLIB_COMPRESSION_TYPE_NONE,
398 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
399 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
400 int compression_type;
403 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
404 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
405 struct wimlib_progress_info_scan {
406 /** Directory or NTFS volume that is being scanned. */
409 /** Path to the file or directory that is about to be scanned,
410 * relative to the root of the image capture or the NTFS volume.
412 const char *cur_path;
414 /** True iff @a cur_path is being excluded from the image
415 * capture due to the capture configuration file. */
418 /** Target path in the WIM. Only valid on messages
419 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
420 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
421 const char *wim_target_path;
424 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
425 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
426 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
427 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
428 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
429 struct wimlib_progress_info_extract {
430 /** Number of the image being extracted (1-based). */
433 /** Flags passed to to wimlib_extract_image() */
436 /** Full path to the WIM file being extracted. */
437 const char *wimfile_name;
439 /** Name of the image being extracted. */
440 const char *image_name;
442 /** Directory or NTFS volume to which the image is being
446 /** Current dentry being extracted. (Valid only if message is
447 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
448 const char *cur_path;
450 /** Number of bytes of uncompressed data that will be extracted.
451 * Takes into account hard links (they are not counted for each
454 uint64_t total_bytes;
456 /** Number of bytes that have been written so far. Will be 0
457 * initially, and equal to @a total_bytes at the end. */
458 uint64_t completed_bytes;
460 /** Number of streams that will be extracted. This may more or
461 * less than the number of "files" to be extracted due to
462 * special cases (hard links, symbolic links, and alternate data
464 uint64_t num_streams;
467 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
468 struct wimlib_progress_info_rename {
469 /** Name of the temporary file that the WIM was written to. */
472 /** Name of the original WIM file to which the temporary file is
477 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
478 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
479 struct wimlib_progress_info_integrity {
480 /** Number of bytes from the end of the WIM header to the end of
481 * the lookup table (the area that is covered by the SHA1
482 * integrity checks.) */
483 uint64_t total_bytes;
485 /** Number of bytes that have been SHA1-summed so far. Will be
486 * 0 initially, and equal @a total_bytes at the end. */
487 uint64_t completed_bytes;
489 /** Number of chunks that the checksummed region is divided
491 uint32_t total_chunks;
493 /** Number of chunks that have been SHA1-summed so far. Will
494 * be 0 initially, and equal to @a total_chunks at the end. */
495 uint32_t completed_chunks;
497 /** Size of the chunks used for the integrity calculation. */
500 /** Filename of the WIM (only valid if the message is
501 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
502 const char *filename;
505 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
506 struct wimlib_progress_info_join {
507 /** Total number of bytes of compressed data contained in all
508 * the split WIM part's file and metadata resources. */
509 uint64_t total_bytes;
511 /** Number of bytes that have been copied to the joined WIM so
512 * far. Will be 0 initially, and equal to @a total_bytes at the
514 uint64_t completed_bytes;
516 /** Number of split WIM parts that have had all their file and
517 * metadata resources copied over to the joined WIM so far. */
518 unsigned completed_parts;
520 /** Number of split WIM parts. */
521 unsigned total_parts;
524 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
525 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
526 struct wimlib_progress_info_split {
527 /** Total size of the original WIM's file and metadata resources
529 uint64_t total_bytes;
531 /** Number of bytes of file and metadata resources that have
532 * been copied out of the original WIM so far. Will be 0
533 * initially, and equal to @a total_bytes at the end. */
534 uint64_t completed_bytes;
536 /** Number of the split WIM part that is about to be started
537 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
538 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
539 unsigned cur_part_number;
541 /** Name of the split WIM part that is about to be started
542 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
543 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
544 const char *part_name;
548 /** A user-supplied function that will be called periodically during certain WIM
549 * operations. The first argument will be the type of operation that is being
550 * performed or is about to be started or has been completed. The second
551 * argument will be a pointer to one of a number of structures depending on the
552 * first argument. It may be @c NULL for some message types.
554 * The return value of the progress function is currently ignored, but it may do
555 * something in the future. (Set it to 0 for now.)
557 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
558 const union wimlib_progress_info *info);
560 /** An array of these structures is passed to wimlib_add_image_multisource() to
561 * specify the sources from which to create a WIM image. */
562 struct wimlib_capture_source {
563 /** Absolute or relative path to a file or directory on the external
564 * filesystem to be included in the WIM image. */
565 char *fs_source_path;
567 /** Destination path in the WIM image. Leading and trailing slashes are
568 * ignored. The empty string or @c NULL means the root directory of the
570 char *wim_target_path;
572 /** Reserved; set to 0. */
577 /*****************************
578 * WIMLIB_ADD_IMAGE_FLAG_* *
579 *****************************/
581 /** Directly capture a NTFS volume rather than a generic directory. This flag
582 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
583 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
584 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
586 /** Follow symlinks; archive and dump the files they point to. Cannot be used
587 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
588 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
590 /** Call the progress function with the message
591 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
593 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
595 /** Mark the image being added as the bootable image of the WIM. */
596 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
598 /** Store the UNIX owner, group, and mode. This is done by adding a special
599 * alternate data stream to each regular file, symbolic link, and directory to
600 * contain this information. Please note that this flag is for convenience
601 * only; Microsoft's version of imagex.exe will not understand this special
602 * information. This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS.
604 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
606 /******************************
607 * WIMLIB_EXPORT_FLAG_* *
608 ******************************/
610 /** See documentation for wimlib_export_image(). */
611 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
613 /******************************
614 * WIMLIB_EXTRACT_FLAG_* *
615 ******************************/
617 /** Extract the image directly to a NTFS volume rather than a generic directory.
619 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
621 /** When identical files are extracted from the WIM, always hard link them
622 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
623 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
625 /** When identical files are extracted from the WIM, always symlink them
626 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
627 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
629 /** Call the progress function with the argument
630 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
631 * extracted. Note: these calls will be interspersed with calls for the message
632 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
633 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
635 /** Read the WIM file sequentially while extracting the image. */
636 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
638 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
639 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
640 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
642 /******************************
643 * WIMLIB_MOUNT_FLAG_* *
644 ******************************/
646 /** Mount the WIM image read-write rather than the default of read-only. */
647 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
649 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
650 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
652 /** Do not allow accessing alternate data streams in the mounted WIM image. */
653 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
655 /** Access alternate data streams in the mounted WIM image through extended file
656 * attributes. This is the default mode. */
657 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
659 /** Access alternate data streams in the mounted WIM image by specifying the
660 * file name, a colon, then the alternate file stream name. */
661 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
663 /** Use UNIX file owners, groups, and modes if available in the WIM (see
664 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
665 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
667 /** Allow other users to see the mounted filesystem. (this passes the @c
668 * allow_other option to FUSE mount) */
669 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
671 /******************************
672 * WIMLIB_OPEN_FLAG_* *
673 ******************************/
675 /** Verify the WIM contents against the WIM's integrity table, if present. */
676 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
678 /** Do not issue an error if the WIM is part of a split WIM. */
679 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
681 /******************************
682 * WIMLIB_UNMOUNT_FLAG_* *
683 ******************************/
685 /** Include an integrity table in the WIM after it's been unmounted. Ignored
686 * for read-only mounts. */
687 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
689 /** Unless this flag is given, changes to a read-write mounted WIM are
690 * discarded. Ignored for read-only mounts. */
691 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
693 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
694 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
696 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
697 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
699 /******************************
700 * WIMLIB_WRITE_FLAG_* *
701 ******************************/
703 /** Include an integrity table in the new WIM file. */
704 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
706 /** Re-build the entire WIM file rather than appending data to it, if possible.
707 * (Applies to wimlib_overwrite(), not wimlib_write()). */
708 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
710 /** Recompress all resources, even if they could otherwise be copied from a
711 * different WIM with the same compression type (in the case of
712 * wimlib_export_image() being called previously). */
713 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
715 /** Call fsync() when the WIM file is closed */
716 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
718 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
719 * after one or more calls to wimlib_delete_image(), which is to rebuild the
722 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
723 * correctly remove the image from the WIM will be taken. In particular, all
724 * streams will be left alone, even if they are no longer referenced. This is
725 * probably not what you want, because almost no space will be spaced by
726 * deleting an image in this way. */
727 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
730 * Possible values of the error code returned by many functions in wimlib.
732 * See the documentation for each wimlib function to see specifically what error
733 * codes can be returned by a given function, and what they mean.
735 /* Note: these are currently in alphabetic order, but new error codes should be
736 * added at the end to maintain a compatible ABI, except when it's being broken
738 enum wimlib_error_code {
739 WIMLIB_ERR_SUCCESS = 0,
740 WIMLIB_ERR_ALREADY_LOCKED,
741 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
742 WIMLIB_ERR_DECOMPRESSION,
743 WIMLIB_ERR_DELETE_STAGING_DIR,
744 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
747 WIMLIB_ERR_FUSERMOUNT,
748 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
749 WIMLIB_ERR_IMAGE_COUNT,
750 WIMLIB_ERR_IMAGE_NAME_COLLISION,
751 WIMLIB_ERR_INTEGRITY,
752 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
753 WIMLIB_ERR_INVALID_CHUNK_SIZE,
754 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
755 WIMLIB_ERR_INVALID_DENTRY,
756 WIMLIB_ERR_INVALID_HEADER_SIZE,
757 WIMLIB_ERR_INVALID_IMAGE,
758 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
759 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
760 WIMLIB_ERR_INVALID_PARAM,
761 WIMLIB_ERR_INVALID_PART_NUMBER,
762 WIMLIB_ERR_INVALID_RESOURCE_HASH,
763 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
764 WIMLIB_ERR_INVALID_SECURITY_DATA,
765 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
766 WIMLIB_ERR_INVALID_UTF8_STRING,
767 WIMLIB_ERR_INVALID_UTF16_STRING,
768 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
774 WIMLIB_ERR_NOT_A_WIM_FILE,
775 WIMLIB_ERR_NO_FILENAME,
783 WIMLIB_ERR_RESOURCE_ORDER,
784 WIMLIB_ERR_SPECIAL_FILE,
785 WIMLIB_ERR_SPLIT_INVALID,
786 WIMLIB_ERR_SPLIT_UNSUPPORTED,
789 WIMLIB_ERR_UNKNOWN_VERSION,
790 WIMLIB_ERR_UNSUPPORTED,
793 WIMLIB_ERR_INVALID_OVERLAY,
797 /** Used to indicate that no WIM image or an invalid WIM image. */
798 #define WIMLIB_NO_IMAGE 0
800 /** Used to specify all images in the WIM. */
801 #define WIMLIB_ALL_IMAGES (-1)
804 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
806 * The directory tree of NTFS volume is read immediately for the purpose of
807 * constructing a directory entry tree in-memory. Also, all files are read to
808 * calculate their SHA1 message digests. However, because the directory tree
809 * may contain a very large amount of data, the files themselves are not read
810 * into memory permanently, and instead references to their paths saved. The
811 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
814 * See the manual page for the @c imagex program for more information about the
815 * "normal" capture mode versus the NTFS capture mode (entered by providing the
816 * flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
818 * Note that @b no changes are committed to the underlying WIM file (if
819 * any) until wimlib_write() or wimlib_overwrite() is called.
822 * Pointer to the ::WIMStruct for a WIM file to which the image will be
825 * A path to a directory or unmounted NTFS volume that will be captured as
828 * The name to give the image. This must be non-@c NULL.
830 * Pointer to the contents of an image capture configuration file. If @c
831 * NULL, a default string is used. Please see the manual page for
832 * <b>imagex capture</b> for more information.
834 * Length of the string @a config in bytes, not including an optional
835 * null-terminator. Ignored if @a config is @c NULL.
836 * @param add_image_flags
837 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
838 * @param progress_func
839 * If non-NULL, a function that will be called periodically with the
840 * progress of the current operation.
842 * @return 0 on success; nonzero on error. On error, changes to @a wim are
843 * discarded so that it appears to be in the same state as when this function
846 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
847 * There is already an image named @a name in @a wim.
848 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
849 * @a config was not @c NULL and did not specify a valid image capture
851 * @retval ::WIMLIB_ERR_INVALID_PARAM
852 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
853 * @retval ::WIMLIB_ERR_NOMEM
854 * Failed to allocate needed memory.
855 * @retval ::WIMLIB_ERR_NOTDIR
856 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
857 * not specified in @a add_image_flags).
858 * @retval ::WIMLIB_ERR_NTFS_3G
859 * An error was returned from a libntfs-3g function when the NTFS volume
860 * was being opened, scanned, or closed (only if
861 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
862 * @retval ::WIMLIB_ERR_OPEN
863 * Failed to open a file or directory in the directory tree rooted at @a
864 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
866 * @retval ::WIMLIB_ERR_READ
867 * Failed to read a file in the directory tree rooted at @a source (only if
868 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
869 * @retval ::WIMLIB_ERR_SPECIAL_FILE
870 * The directory tree rooted at @a source contains a special file that is
871 * not a directory, regular file, or symbolic link. This currently can
872 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
873 * add_image_flags, but it may be returned for unsupported NTFS files in
875 * @retval ::WIMLIB_ERR_STAT
876 * Failed obtain the metadata for a file or directory in the directory tree
877 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
878 * specified in @a add_image_flags).
879 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
880 * @a wim is part of a split WIM. Adding an image to a split WIM is
882 * @retval ::WIMLIB_ERR_UNSUPPORTED
883 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
884 * wimlib was configured with the @c --without-ntfs-3g flag.
886 extern int wimlib_add_image(WIMStruct *wim, const char *source,
887 const char *name, const char *config,
888 size_t config_len, int add_image_flags,
889 wimlib_progress_func_t progress_func);
891 /** This function is equivalent to wimlib_add_image() except it allows for
892 * multiple sources to be combined into a single WIM image. This is done by
893 * specifying the @a sources and @a num_sources parameters instead of the @a
894 * source parameter. The rest of the parameters are the same as
895 * wimlib_add_image(). See the documentation for <b>imagex capture</b> for full
896 * details on how this mode works.
898 * Additional notes: @a sources is not a @c const parameter and you cannot
899 * assume that its contents are valid after this function returns. You must
900 * save pointers to the strings in these structures if you need to free them
901 * later, and/or save copies if needed.
903 * It is also possible for this function to return ::WIMLIB_ERR_INVALID_OVERLAY
904 * when trying to overlay a non-directory on a directory or when otherwise
905 * trying to overlay multiple conflicting files to the same location in the WIM
907 extern int wimlib_add_image_multisource(WIMStruct *w,
908 struct wimlib_capture_source *sources,
911 const char *config_str,
914 wimlib_progress_func_t progress_func);
917 * Creates a ::WIMStruct for a new WIM file.
919 * This only creates an in-memory structure for a WIM that initially contains no
920 * images. No on-disk file is created until wimlib_write() is called.
923 * The type of compression to be used in the new WIM file. Must be
924 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
925 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
927 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
928 * written to the memory location pointed to by this paramater. The
929 * ::WIMStruct must be freed using using wimlib_free() when finished with
931 * @return 0 on success; nonzero on error.
932 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
933 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
934 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
935 * @retval ::WIMLIB_ERR_NOMEM
936 * Failed to allocate needed memory.
938 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
941 * Deletes an image, or all images, from a WIM file.
943 * All streams referenced by the image(s) being deleted are removed from the
944 * lookup table of the WIM if they are not referenced by any other images in the
947 * Please note that @b no changes are committed to the underlying WIM file (if
948 * any) until wimlib_write() or wimlib_overwrite() is called.
951 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
954 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
956 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
957 * to be left unmodified only if @a image specified a single image. If instead
958 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
959 * possible for some but not all of the images to have been deleted when a
960 * failure status is returned.
962 * @retval ::WIMLIB_ERR_DECOMPRESSION
963 * Could not decompress the metadata resource for @a image.
964 * @retval ::WIMLIB_ERR_INVALID_DENTRY
965 * A directory entry in the metadata resource for @a image in the WIM is
967 * @retval ::WIMLIB_ERR_INVALID_IMAGE
968 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
969 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
970 * The metadata resource for @a image in the WIM is invalid.
971 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
972 * The security data for @a image in the WIM is invalid.
973 * @retval ::WIMLIB_ERR_NOMEM
974 * Failed to allocate needed memory.
975 * @retval ::WIMLIB_ERR_READ
976 * Could not read the metadata resource for @a image from the WIM.
977 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
978 * @a wim is part of a split WIM. Deleting an image from a split WIM is
981 extern int wimlib_delete_image(WIMStruct *wim, int image);
984 * Exports an image, or all the images, from a WIM file, into another WIM file.
986 * The destination image is made to share the same dentry tree and security data
987 * structure as the source image. This places some restrictions on additional
988 * functions that may be called. wimlib_mount_image() may not be called on
989 * either the source image or the destination image without an intervening call
990 * to a function that un-shares the images, such as wimlib_free() on @a
991 * dest_wim, or wimlib_delete_image() on either the source or destination image.
992 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
993 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
994 * have references back to @a src_wim.
996 * Previous versions of this function left @a dest_wim in an indeterminate state
997 * on failure. This is no longer the case; all changes to @a dest_wim made by
998 * this function are rolled back on failure.
1000 * Previous versions of this function did not allow exporting an image that had
1001 * been added by wimlib_add_image(). This is no longer the case; you may now
1002 * export an image regardless of how it was added.
1004 * Regardless of whether this function succeeds or fails, no changes are made to
1007 * Please note that no changes are committed to the underlying WIM file of @a
1008 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1011 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1012 * WIM that contains the image(s) being exported.
1014 * The image to export from @a src_wim. Can be the number of an image, or
1015 * ::WIMLIB_ALL_IMAGES to export all images.
1017 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1020 * The name to give the exported image in the new WIM file. If left @c
1021 * NULL, the name from @a src_wim is used. This parameter must be left @c
1022 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1023 * than one image; in that case, the names are all taken from the @a
1024 * src_wim. (This is allowed even if one or more images being exported has
1026 * @param dest_description
1027 * The description to give the exported image in the new WIM file. If left
1028 * @c NULL, the description from the @a src_wim is used. This parameter must
1029 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1030 * more than one image; in that case, the descriptions are all taken from
1031 * @a src_wim. (This is allowed even if one or more images being exported
1032 * has no description.)
1033 * @param export_flags
1034 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1035 * bootable, or 0 if which image is marked as bootable in the destination
1036 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1037 * there are multiple images in @a src_wim, specifying
1038 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1039 * currently marked as bootable in @a src_wim; if that is the case, then
1040 * that image is marked as bootable in the destination WIM.
1041 * @param additional_swms
1042 * Array of pointers to the ::WIMStruct for each additional part in the
1043 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1044 * need to be in any particular order, but they must include all parts of
1045 * the split WIM other than the first part, which must be provided in the
1047 * @param num_additional_swms
1048 * Number of additional WIM parts provided in the @a additional_swms array.
1049 * This number should be one less than the total number of parts in the
1050 * split WIM. Set to 0 if the WIM is a standalone WIM.
1051 * @param progress_func
1052 * If non-NULL, a function that will be called periodically with the
1053 * progress of the current operation.
1055 * @return 0 on success; nonzero on error.
1056 * @retval ::WIMLIB_ERR_DECOMPRESSION
1057 * Could not decompress the metadata resource for @a src_image
1059 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1060 * One or more of the names being given to an exported image was already in
1061 * use in the destination WIM.
1062 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1063 * A directory entry in the metadata resource for @a src_image in @a
1064 * src_wim is invalid.
1065 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1066 * @a src_image does not exist in @a src_wim.
1067 * @retval ::WIMLIB_ERR_INVALID_PARAM
1068 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1069 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1070 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1071 * dest_description were non-<code>NULL</code>, @a src_image was
1072 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1073 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1074 * The metadata resource for @a src_image in @a src_wim is invalid.
1075 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1076 * The security data for @a src_image in @a src_wim is invalid.
1077 * @retval ::WIMLIB_ERR_NOMEM
1078 * Failed to allocate needed memory.
1079 * @retval ::WIMLIB_ERR_READ
1080 * Could not read the metadata resource for @a src_image from @a src_wim.
1081 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1082 * The source WIM is a split WIM, but the parts specified do not form a
1083 * complete split WIM because they do not include all the parts of the
1084 * original WIM, there are duplicate parts, or not all the parts have the
1085 * same GUID and compression type.
1086 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1087 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1090 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
1091 WIMStruct *dest_wim, const char *dest_name,
1092 const char *dest_description, int export_flags,
1093 WIMStruct **additional_swms,
1094 unsigned num_additional_swms,
1095 wimlib_progress_func_t progress_func);
1098 * Extracts an image, or all images, from a standalone or split WIM file to a
1099 * directory or a NTFS volume.
1101 * Please see the manual page for the @c imagex program for more information
1102 * about the "normal" extraction mode versus the NTFS extraction mode
1103 * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1105 * Extraction is done with one thread.
1107 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1108 * returned if any resulting SHA1 message digests do not match the values
1109 * provided in the WIM file. Therefore, if this function is successful, you can
1110 * be fairly sure that any compressed data in the WIM was uncompressed
1114 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1117 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1118 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1119 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1121 * Directory to extract the WIM image(s) to (created if it does not already
1122 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1123 * path to the unmounted NTFS volume to extract the image to.
1124 * @param extract_flags
1125 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1127 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1128 * a NTFS volume to extract the image to. The volume will be opened using
1129 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1130 * Otherwise, @a target is interpreted as a directory to extract the
1133 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1134 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1135 * specified. These flags cause extracted files that are identical to be
1136 * hardlinked or symlinked together, depending on the flag. These flags
1137 * override the hard link groups that are specified in the WIM file itself.
1138 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1139 * hardlinked or symlinked across images if a file is found to occur in
1140 * more than one image.
1142 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1143 * name of each file or directory as it is extracted.
1145 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1146 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1147 * each image is considered separately with regards to the sequential
1148 * order. It is also possible for alternate data streams to break the
1149 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1151 * @param additional_swms
1152 * Array of pointers to the ::WIMStruct for each additional part in the
1153 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1154 * need to be in any particular order, but they must include all parts of
1155 * the split WIM other than the first part, which must be provided in the
1157 * @param num_additional_swms
1158 * Number of additional WIM parts provided in the @a additional_swms array.
1159 * This number should be one less than the total number of parts in the
1160 * split WIM. Set to 0 if the WIM is a standalone WIM.
1162 * @param progress_func
1163 * If non-NULL, a function that will be called periodically with the
1164 * progress of the current operation.
1166 * @return 0 on success; nonzero on error.
1167 * @retval ::WIMLIB_ERR_DECOMPRESSION
1168 * Could not decompress a resource (file or metadata) for @a image in @a
1170 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1171 * A directory entry in the metadata resource for @a image in @a wim is
1173 * @retval ::WIMLIB_ERR_INVALID_PARAM
1174 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1175 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1176 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1177 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1178 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1179 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1180 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1181 * specified in @a extract_flag.
1182 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1183 * The SHA1 message digest of an extracted stream did not match the SHA1
1184 * message digest given in the WIM file.
1185 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1186 * A resource (file or metadata) for @a image in @a wim is invalid.
1187 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1188 * The security data for @a image in @a wim is invalid.
1189 * @retval ::WIMLIB_ERR_LINK
1190 * Failed to create a symbolic link or a hard link (only if
1191 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1192 * @retval ::WIMLIB_ERR_MKDIR
1193 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1194 * not specified in @a extract_flags).
1195 * @retval ::WIMLIB_ERR_NOMEM
1196 * Failed to allocate needed memory.
1197 * @retval ::WIMLIB_ERR_NTFS_3G
1198 * An error was returned from a libntfs-3g function while the WIM image was
1199 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1200 * was specified in @a extract_flags).
1201 * @retval ::WIMLIB_ERR_OPEN
1202 * Could not open one of the files being extracted for writing (only if
1203 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1204 * @retval ::WIMLIB_ERR_READ
1205 * A unexpected end-of-file or read error occurred when trying to read data
1206 * from the WIM file associated with @a wim.
1207 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1208 * The WIM is a split WIM, but the parts specified do not form a complete
1209 * split WIM because they do not include all the parts of the original WIM,
1210 * there are duplicate parts, or not all the parts have the same GUID and
1212 * @retval ::WIMLIB_ERR_UNSUPPORTED
1213 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1214 * was configured with the @c --without-ntfs-3g flag.
1215 * @retval ::WIMLIB_ERR_WRITE
1216 * Failed to write a file being extracted (only if
1217 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1219 extern int wimlib_extract_image(WIMStruct *wim, int image,
1220 const char *target, int extract_flags,
1221 WIMStruct **additional_swms,
1222 unsigned num_additional_swms,
1223 wimlib_progress_func_t progress_func);
1226 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1227 * includes a string of XML that describes the images contained in the WIM.
1228 * This function works on standalone WIMs as well as split WIM parts.
1231 * Pointer to the ::WIMStruct for a WIM file.
1233 * @c stdout, or a FILE* opened for writing, to extract the data to.
1235 * @return 0 on success; nonzero on error.
1236 * @retval ::WIMLIB_ERR_WRITE
1237 * Failed to completely write the XML data to @a fp.
1238 * @retval ::WIMLIB_ERR_INVALID_PARAM
1239 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1241 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1244 * Frees all memory allocated for a WIMStruct and closes all files associated
1248 * Pointer to the ::WIMStruct for a WIM file.
1250 * @return This function has no return value.
1252 extern void wimlib_free(WIMStruct *wim);
1255 * Returns the index of the bootable image of the WIM.
1258 * Pointer to the ::WIMStruct for a WIM file.
1261 * 0 if no image is marked as bootable, or the number of the image marked
1262 * as bootable (numbered starting at 1).
1264 extern int wimlib_get_boot_idx(const WIMStruct *wim);
1267 * Returns the compression type used in the WIM.
1270 * Pointer to the ::WIMStruct for a WIM file
1273 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1274 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1276 extern int wimlib_get_compression_type(const WIMStruct *wim);
1279 * Converts a ::wimlib_compression_type value into a string.
1282 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1283 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1286 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1289 extern const char *wimlib_get_compression_type_string(int ctype);
1292 * Converts an error code into a string describing it.
1295 * The error code returned by one of wimlib's functions.
1298 * Pointer to a statically allocated string describing the error code,
1299 * or @c NULL if the error code is not valid.
1301 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
1304 * Returns the description of the specified image.
1307 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1308 * standalone WIM or a split WIM part.
1310 * The number of the image, numbered starting at 1.
1313 * The description of the image, or @c NULL if there is no such image, or
1314 * @c NULL if the specified image has no description. The description
1315 * string is in library-internal memory and may not be modified or freed;
1316 * in addition, the string will become invalid if the description of the
1317 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1319 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
1322 * Returns the name of the specified image.
1325 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1326 * standalone WIM or a split WIM part.
1328 * The number of the image, numbered starting at 1.
1331 * The name of the image, or @c NULL if there is no such image. The name
1332 * string is in library-internal memory and may not be modified or freed;
1333 * in addition, the string will become invalid if the name of the image is
1334 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1336 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1337 * the WIM to be unnamed, in which case an empty string will be returned
1338 * when the corresponding name is requested.
1340 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
1344 * Returns the number of images contained in a WIM.
1347 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1348 * standalone WIM or a split WIM part.
1351 * The number of images contained in the WIM file.
1353 extern int wimlib_get_num_images(const WIMStruct *wim);
1356 * Returns the part number of a WIM in a split WIM and the total number of parts
1360 * Pointer to the ::WIMStruct for a WIM file.
1361 * @param total_parts_ret
1362 * If non-@c NULL, the total number of parts in the split WIM (1 for
1363 * non-split WIMs) is written to this location.
1366 * The part number of the WIM (1 for non-split WIMs)
1368 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1371 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1372 * re-entrant. If you are calling wimlib functions concurrently in different
1373 * threads, then you must call this function serially first. Otherwise, calling
1374 * this function is not required.
1376 * @return 0 on success; nonzero on error.
1377 * @retval ::WIMLIB_ERR_NOMEM
1378 * Could not allocate memory.
1379 * @retval ::WIMLIB_ERR_ICONV_NOT_AVAILABLE
1380 * wimlib was configured @c --without-libntfs-3g at compilation time, and
1381 * at runtime the @c iconv() set of functions did not seem to be available,
1382 * perhaps due to missing files in the C library installation.
1384 * If this function is not called or returns nonzero, then it will not be safe
1385 * to use wimlib in multiple threads. Furthermore, a nonzero return value here
1386 * indicates that further calls into wimlib will probably fail when they try to
1387 * repeat the same initializations.
1389 extern int wimlib_global_init();
1392 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1393 * You are not required to call this function, but it will release any global
1394 * memory allocated by the library.
1396 extern void wimlib_global_cleanup();
1399 * Returns true if the WIM has an integrity table.
1402 * Pointer to the ::WIMStruct for a WIM file.
1404 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1405 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1406 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1407 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1409 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
1413 * Determines if an image name is already used by some image in the WIM.
1416 * Pointer to the ::WIMStruct for a WIM file.
1418 * The name to check.
1421 * @c true if there is already an image in @a wim named @a name; @c false
1422 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1423 * the empty string, @c false is returned.
1425 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
1428 * Joins a split WIM into a stand-alone one-part WIM.
1431 * An array of strings that gives the filenames of all parts of the split
1432 * WIM. No specific order is required, but all parts must be included with
1435 * Number of filenames in @a swms.
1436 * @param swm_open_flags
1437 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1438 * part should be verified, if integrity tables are present. Otherwise,
1440 * @param wim_write_flags
1441 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1442 * @param output_path
1443 * The path to write the one-part WIM to.
1444 * @param progress_func
1445 * If non-NULL, a function that will be called periodically with the
1446 * progress of the current operation.
1448 * @return 0 on success; nonzero on error. This function may return any value
1449 * returned by wimlib_open_wim() and wimlib_write() except
1450 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1452 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1453 * The split WIMs do not form a valid WIM because they do not include all
1454 * the parts of the original WIM, there are duplicate parts, or not all the
1455 * parts have the same GUID and compression type.
1457 * Note: the WIM's uncompressed and compressed resources are not checksummed
1458 * when they are copied from the split WIM parts to the joined WIM, nor are
1459 * compressed resources re-compressed.
1461 * Note: wimlib_export_image() can provide similar functionality to
1462 * wimlib_join(), since it is possible to export all images from a split WIM.
1464 extern int wimlib_join(const char * const *swms, unsigned num_swms,
1465 const char *output_path, int swm_open_flags,
1466 int wim_write_flags,
1467 wimlib_progress_func_t progress_func);
1470 * Mounts an image in a WIM file on a directory read-only or read-write.
1472 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1473 * process shall be daemonized.
1475 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1476 * modifications to the WIM are staged in a temporary directory.
1478 * It is safe to mount multiple images from the same WIM file read-only at the
1479 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1480 * to mount multiple images from the same WIM file read-write at the same time.
1482 * wimlib_mount_image() cannot be used on an image that was exported with
1483 * wimlib_export_image() while the dentry trees for both images are still in
1484 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1485 * that has just been added with wimlib_add_image(), unless the WIM has been
1486 * written and read into a new ::WIMStruct.
1489 * Pointer to the ::WIMStruct containing the image to be mounted.
1491 * The number of the image to mount, indexed starting from it. It must be
1492 * an existing, single image.
1494 * The path to an existing empty directory to mount the image on.
1495 * @param mount_flags
1496 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1498 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1499 * rather than the default of read-only.
1501 * WIMs may contain named (alternate) data streams, which are a somewhat
1502 * obscure NTFS feature. They can be read and written on a mounted WIM
1503 * through one of several interfaces. The interface to use if specified by
1504 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1505 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1506 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1507 * the XATTR interface.
1508 * @param additional_swms
1509 * Array of pointers to the ::WIMStruct for each additional part in the
1510 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1511 * need to be in any particular order, but they must include all parts of
1512 * the split WIM other than the first part, which must be provided in the
1514 * @param num_additional_swms
1515 * Number of additional WIM parts provided in the @a additional_swms array.
1516 * This number should be one less than the total number of parts in the
1517 * split WIM. Set to 0 if the WIM is a standalone WIM.
1518 * @param staging_dir
1519 * If non-NULL, the name of a directory in which the staging directory will
1520 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1521 * in @a mount_flags. If left @c NULL, the staging directory is created in
1522 * the same directory as the WIM file that @a wim was originally read from.
1524 * @return 0 on success; nonzero on error.
1526 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1527 * A read-write mount was requested, but an an exclusive advisory lock on
1528 * the on-disk WIM file could not be acquired because another thread or
1529 * process has mounted an image from the WIM read-write or is currently
1530 * modifying the WIM in-place.
1531 * @retval ::WIMLIB_ERR_DECOMPRESSION
1532 * Could not decompress the metadata resource for @a image in @a wim.
1533 * @retval ::WIMLIB_ERR_FUSE
1534 * A non-zero status was returned by @c fuse_main().
1535 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1536 * A directory entry in the metadata resource for @a image in @a wim is
1538 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1539 * @a image does not specify an existing, single image in @a wim.
1540 * @retval ::WIMLIB_ERR_INVALID_PARAM
1541 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1542 * wimlib_export_image(), or @a image has been added with
1543 * wimlib_add_image().
1544 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1545 * The metadata resource for @a image in @a wim is invalid.
1546 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1547 * The security data for @a image in @a wim is invalid.
1548 * @retval ::WIMLIB_ERR_MKDIR
1549 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1550 * staging directory could not be created.
1551 * @retval ::WIMLIB_ERR_NOMEM
1552 * Failed to allocate needed memory.
1553 * @retval ::WIMLIB_ERR_NOTDIR
1554 * Could not determine the current working directory.
1555 * @retval ::WIMLIB_ERR_READ
1556 * An unexpected end-of-file or read error occurred when trying to read
1557 * data from the WIM file associated with @a wim.
1558 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1559 * The WIM is a split WIM, but the parts specified do not form a complete
1560 * split WIM because they do not include all the parts of the original WIM,
1561 * there are duplicate parts, or not all the parts have the same GUID and
1563 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1564 * The WIM is a split WIM and a read-write mount was requested. We only
1565 * support mounting a split WIM read-only.
1567 extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
1568 int mount_flags, WIMStruct **additional_swms,
1569 unsigned num_additional_swms,
1570 const char *staging_dir);
1573 * Opens a WIM file and creates a ::WIMStruct for it.
1576 * The path to the WIM file to open.
1578 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1579 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1581 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1582 * the WIM, if it exists, is checked, and this function will fail with an
1583 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1584 * digests of the WIM do not exactly match the corresponding message
1585 * digests given in the integrity table.
1587 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1588 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1589 * returned. (This flag may be removed in the future, in which case no
1590 * error will be issued when opening a split WIM.)
1592 * @param progress_func
1593 * If non-NULL, a function that will be called periodically with the
1594 * progress of the current operation.
1597 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1598 * is written to the memory location pointed to by this parameter. The
1599 * ::WIMStruct must be freed using using wimlib_free() when finished with
1602 * @return 0 on success; nonzero on error.
1603 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1604 * The lookup table of @a wim_file is compressed. Support for this can be
1605 * added to wimlib if needed, but it appears to be the case that the lookup
1606 * table is never compressed.
1607 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1608 * The WIM is not the non-first part of a split WIM, and the number of
1609 * metadata resources found in the WIM did not match the image count given
1610 * in the WIM header, or the number of <IMAGE> elements in the XML
1611 * data for the WIM did not match the image count given in the WIM header.
1612 * @retval ::WIMLIB_ERR_INTEGRITY
1613 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1614 * wim_file contains an integrity table, but the SHA1 message digest for a
1615 * chunk of the WIM does not match the corresponding message digest given
1616 * in the integrity table.
1617 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1618 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1619 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1620 * The header of @a wim_file says that resources in the WIM are compressed,
1621 * but the header flag indicating LZX or XPRESS compression is not set.
1622 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1623 * The length field of the WIM header is not 208.
1624 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1625 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1626 * wim_file contains an integrity table, but the integrity table is
1628 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1629 * The lookup table for the WIM contained duplicate entries that are not
1630 * for metadata resources, or it contained an entry with a SHA1 message
1631 * digest of all 0's.
1632 * @retval ::WIMLIB_ERR_NOMEM
1633 * Failed to allocated needed memory.
1634 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1635 * @a wim_file does not begin with the expected magic characters.
1636 * @retval ::WIMLIB_ERR_OPEN
1637 * Failed to open the file @a wim_file for reading.
1638 * @retval ::WIMLIB_ERR_READ
1639 * An unexpected end-of-file or read error occurred when trying to read
1640 * data from @a wim_file.
1641 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1642 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1643 * specified in @a open_flags.
1644 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1645 * A number other than 0x10d00 is written in the version field of the WIM
1646 * header of @a wim_file. (Probably a pre-Vista WIM).
1647 * @retval ::WIMLIB_ERR_XML
1648 * The XML data for @a wim_file is invalid.
1650 extern int wimlib_open_wim(const char *wim_file, int open_flags,
1651 WIMStruct **wim_ret,
1652 wimlib_progress_func_t progress_func);
1655 * Overwrites the file that the WIM was originally read from, with changes made.
1656 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1657 * rather than wimlib_create_new_wim().
1659 * There are two ways that a WIM may be overwritten. The first is to do a full
1660 * rebuild. In this mode, the new WIM is written to a temporary file and then
1661 * renamed to the original file after it is has been completely written. The
1662 * temporary file is made in the same directory as the original WIM file. A
1663 * full rebuild may take a while, but can be used even if images have been
1664 * modified or deleted, will produce a WIM with no holes, and has little chance
1665 * of unintentional data loss because the temporary WIM is fsync()ed before
1666 * being renamed to the original WIM.
1668 * The second way to overwrite a WIM is by appending to the end of it and
1669 * overwriting the header. This can be much faster than a full rebuild, but it
1670 * only works if the only operations on the WIM have been to change the header
1671 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1672 * with writing any new file resources *after* everything in the old WIM, even
1673 * though this will leave a hole where the old lookup table, XML data, and
1674 * integrity were. This is done so that the WIM remains valid even if the
1675 * operation is aborted mid-write. The WIM header is only overwritten at the
1676 * very last moment, and up until that point the WIM will be seen as the old
1679 * By default, the overwrite mode is determine automatically based on the past
1680 * operations performed on the ::WIMStruct. Use the flag
1681 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1682 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1683 * images have been deleted from the WIM.
1685 * In the temporary-file overwrite mode, no changes are made to the WIM on
1686 * failure, and the temporary file is deleted if possible. Abnormal termination
1687 * of the program will result in the temporary file being orphaned. In the
1688 * direct append mode, the WIM is truncated to the original length on failure;
1689 * and while abnormal termination of the program will result in extra data
1690 * appended to the original WIM, it should still be a valid WIM.
1693 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1694 * been in-memory changes made to it, which are then reflected in the
1696 * @param write_flags
1697 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1698 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1699 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1700 * @param num_threads
1701 * Number of threads to use for compression (see wimlib_write()).
1702 * @param progress_func
1703 * If non-NULL, a function that will be called periodically with the
1704 * progress of the current operation.
1706 * @return 0 on success; nonzero on error. This function may return any value
1707 * returned by wimlib_write() as well as the following error codes:
1708 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1709 * The WIM was going to be modifien in-place (with no temporary file), but
1710 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1711 * because another thread or process has mounted an image from the WIM
1712 * read-write or is currently modifying the WIM in-place.
1713 * @retval ::WIMLIB_ERR_NO_FILENAME
1714 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1715 * than a WIM read with wimlib_open_wim().
1716 * @retval ::WIMLIB_ERR_RENAME
1717 * The temporary file that the WIM was written to could not be renamed to
1718 * the original filename of @a wim.
1719 * @retval ::WIMLIB_ERR_REOPEN
1720 * The WIM was overwritten successfully, but it could not be re-opened
1721 * read-only. Therefore, the resources in the WIM can no longer be
1722 * accessed, so this limits the functions that can be called on @a wim
1723 * before calling wimlib_free().
1725 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1726 unsigned num_threads,
1727 wimlib_progress_func_t progress_func);
1730 * Prints information about one image, or all images, contained in a WIM.
1733 * Pointer to the ::WIMStruct for a WIM file.
1735 * The image about which to print information. Can be the number of an
1736 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1739 * @return This function has no return value. No error checking is done when
1740 * printing the information. If @a image is invalid, an error message is
1743 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1746 * Prints the full paths to all files contained in an image, or all images, in a
1750 * Pointer to the ::WIMStruct for a WIM file.
1752 * Which image to print files for. Can be the number of an image, or
1753 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1755 * @return 0 on success; nonzero on error.
1756 * @retval ::WIMLIB_ERR_DECOMPRESSION
1757 * The metadata resource for one of the specified images could not be
1759 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1760 * A directory entry in the metadata resource for one of the specified
1761 * images is invaled.
1762 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1763 * @a image does not specify a valid image in @a wim, and is not
1764 * ::WIMLIB_ALL_IMAGES.
1765 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1766 * The metadata resource for one of the specified images is invalid.
1767 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1768 * The security data for one of the specified images is invalid.
1769 * @retval ::WIMLIB_ERR_NOMEM
1770 * Failed to allocate needed memory.
1771 * @retval ::WIMLIB_ERR_READ
1772 * An unexpected read error or end-of-file occurred when reading the
1773 * metadata resource for one of the specified images.
1774 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1775 * @a wim was not a standalone WIM and was not the first part of a split
1778 extern int wimlib_print_files(WIMStruct *wim, int image);
1781 * Prints detailed information from the header of a WIM file.
1784 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1785 * standalone WIM or part of a split WIM.
1787 * @return This function has no return value.
1790 extern void wimlib_print_header(const WIMStruct *wim);
1793 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1794 * digests, as found in the directory entry tree in the WIM file, to file
1795 * resources in the WIM file. This table includes one entry for each unique
1796 * file in the WIM, so it can be quite long. There is only one lookup table per
1797 * WIM file, but each split WIM part has its own lookup table.
1800 * Pointer to the ::WIMStruct for a WIM file.
1802 * @return This function has no return value.
1804 extern void wimlib_print_lookup_table(WIMStruct *wim);
1807 * Prints the metadata of the specified image in a WIM file. The metadata
1808 * consists of the security data as well as the directory entry tree. Each
1809 * image has its own metadata.
1812 * Pointer to the ::WIMStruct for a WIM file.
1814 * Which image to print the metadata for. Can be the number of an image,
1815 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1817 * @return 0 on success; nonzero on error.
1818 * @retval ::WIMLIB_ERR_DECOMPRESSION
1819 * The metadata resource for one of the specified images could not be
1821 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1822 * A directory entry in the metadata resource for one of the specified
1823 * images is invaled.
1824 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1825 * @a image does not specify a valid image in @a wim, and is not
1826 * ::WIMLIB_ALL_IMAGES.
1827 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1828 * The metadata resource for one of the specified images is invalid.
1829 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1830 * The security data for one of the specified images is invalid.
1831 * @retval ::WIMLIB_ERR_NOMEM
1832 * Failed to allocate needed memory.
1833 * @retval ::WIMLIB_ERR_READ
1834 * An unexpected read error or end-of-file occurred when reading the
1835 * metadata resource for one of the specified images.
1836 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1837 * @a wim was not a standalone WIM and was not the first part of a split
1840 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1843 * Prints some basic information about a WIM file. All information printed by
1844 * this function is also printed by wimlib_print_header(), but
1845 * wimlib_print_wim_information() prints some of this information more concisely
1846 * and in a more readable form.
1849 * Pointer to the ::WIMStruct for a WIM file.
1851 * @return This function has no return value.
1853 extern void wimlib_print_wim_information(const WIMStruct *wim);
1856 * Translates a string specifying the name or number of an image in the WIM into
1857 * the number of the image. The images are numbered starting at 1.
1860 * Pointer to the ::WIMStruct for a WIM file.
1861 * @param image_name_or_num
1862 * A string specifying the name or number of an image in the WIM. If it
1863 * parses to a positive integer, this integer is taken to specify the
1864 * number of the image, indexed starting at 1. Otherwise, it is taken to
1865 * be the name of an image, as given in the XML data for the WIM file. It
1866 * also may be the keyword "all" or the string "*", both of which will
1867 * resolve to ::WIMLIB_ALL_IMAGES.
1869 * There is no way to search for an image actually named "all", "*", or an
1870 * integer number, or an image that has no name. However, you can use
1871 * wimlib_get_image_name() to get the name of any image.
1874 * If the string resolved to a single existing image, the number of that
1875 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
1876 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
1877 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
1878 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1879 * images in @a wim has no name.
1881 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1884 * Sets which image in the WIM is marked as bootable.
1887 * Pointer to the ::WIMStruct for a WIM file.
1889 * The number of the image to mark as bootable, or 0 to mark no image as
1891 * @return 0 on success; nonzero on error.
1892 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1893 * @a boot_idx does not specify an existing image in @a wim, and it was not
1895 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1896 * @a wim is part of a split WIM. We do not support changing the boot
1897 * index of a split WIM.
1899 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1902 * Changes the description of an image in the WIM.
1905 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1906 * standalone WIM or part of a split WIM; however, you should set the same
1907 * description on all parts of a split WIM.
1909 * The number of the image for which to change the description.
1910 * @param description
1911 * The new description to give the image. It may be @c NULL, which
1912 * indicates that the image is to be given no description.
1914 * @return 0 on success; nonzero on error.
1915 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1916 * @a image does not specify a single existing image in @a wim.
1917 * @retval ::WIMLIB_ERR_NOMEM
1918 * Failed to allocate the memory needed to duplicate the @a description
1921 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1922 const char *description);
1925 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1926 * (something like "Core" or "Ultimate")
1929 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1930 * standalone WIM or part of a split WIM; however, you should set the same
1931 * \<FLAGS\> element on all parts of a split WIM.
1933 * The number of the image for which to change the description.
1935 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1936 * indicates that the image is to be given no \<FLAGS\> element.
1938 * @return 0 on success; nonzero on error.
1939 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1940 * @a image does not specify a single existing image in @a wim.
1941 * @retval ::WIMLIB_ERR_NOMEM
1942 * Failed to allocate the memory needed to duplicate the @a flags string.
1944 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1947 * Changes the name of an image in the WIM.
1950 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1951 * standalone WIM or part of a split WIM; however, you should set the same
1952 * name on all parts of a split WIM.
1954 * The number of the image for which to change the name.
1956 * The new name to give the image. It must be a nonempty string.
1958 * @return 0 on success; nonzero on error.
1959 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1960 * There is already an image named @a name in @a wim.
1961 * @retval ::WIMLIB_ERR_INVALID_PARAM
1962 * @a name was @c NULL or the empty string.
1963 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1964 * @a image does not specify a single existing image in @a wim.
1965 * @retval ::WIMLIB_ERR_NOMEM
1966 * Failed to allocate the memory needed to duplicate the @a name string.
1968 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1971 * Set the functions that wimlib uses to allocate and free memory.
1973 * These settings are global and not per-WIM.
1975 * The default is to use the default @c malloc() and @c free() from the C
1978 * Please note that some external functions, such as those in @c libntfs-3g, may
1979 * use the standard memory allocation functions.
1981 * @param malloc_func
1982 * A function equivalent to @c malloc() that wimlib will use to allocate
1983 * memory. If @c NULL, the allocator function is set back to the default
1984 * @c malloc() from the C library.
1986 * A function equivalent to @c free() that wimlib will use to free memory.
1987 * If @c NULL, the free function is set back to the default @c free() from
1989 * @param realloc_func
1990 * A function equivalent to @c realloc() that wimlib will use to reallocate
1991 * memory. If @c NULL, the free function is set back to the default @c
1992 * realloc() from the C library.
1993 * @return 0 on success; nonzero on error.
1994 * @retval ::WIMLIB_ERR_UNSUPPORTED
1995 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1996 * so custom memory allocators are unsupported.
1998 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1999 void (*free_func)(void *),
2000 void *(*realloc_func)(void *, size_t));
2003 * Sets whether wimlib is to print error messages to @c stderr when a function
2004 * fails. These error messages may provide information that cannot be
2005 * determined only from the error code that is returned. Not every error will
2006 * result in an error message being printed.
2008 * This setting is global and not per-WIM.
2010 * By default, error messages are not printed.
2012 * @param show_messages
2013 * @c true if error messages are to be printed; @c false if error messages
2014 * are not to be printed.
2016 * @return 0 on success; nonzero on error.
2017 * @retval ::WIMLIB_ERR_UNSUPPORTED
2018 * @a show_messages was @c true, but wimlib was compiled with the @c
2019 * --without-error-messages option. Therefore, error messages cannot be
2022 extern int wimlib_set_print_errors(bool show_messages);
2025 * Splits a WIM into multiple parts.
2028 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2031 * Name of the SWM file to create. This will be the name of the first
2032 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2033 * appended before the suffix.
2035 * The maximum size per part, in bytes. It is not guaranteed that this
2036 * will really be the maximum size per part, because some file resources in
2037 * the WIM may be larger than this size, and the WIM file format provides
2038 * no way to split up file resources among multiple WIMs.
2039 * @param write_flags
2040 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2041 * included in the split WIM parts.
2042 * @param progress_func
2043 * If non-NULL, a function that will be called periodically with the
2044 * progress of the current operation.
2046 * @return 0 on success; nonzero on error. This function may return any value
2047 * returned by wimlib_write() as well as the following error codes:
2049 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2050 * @a wim is not part 1 of a stand-alone WIM.
2051 * @retval ::WIMLIB_ERR_INVALID_PARAM
2052 * @a swm_name was @c NULL, or @a part_size was 0.
2054 * Note: the WIM's uncompressed and compressed resources are not checksummed
2055 * when they are copied from the joined WIM to the split WIM parts, nor are
2056 * compressed resources re-compressed.
2058 extern int wimlib_split(WIMStruct *wim, const char *swm_name,
2059 size_t part_size, int write_flags,
2060 wimlib_progress_func_t progress_func);
2063 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2065 * The image to unmount is specified by the path to the mountpoint, not the
2066 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2067 * touched and also may have been allocated in a different process.
2069 * To unmount the image, the thread calling this function communicates with the
2070 * thread that is managing the mounted WIM image. This function blocks until it
2071 * is known whether the unmount succeeded or failed. In the case of a
2072 * read-write mounted WIM, the unmount is not considered to have succeeded until
2073 * all changes have been saved to the underlying WIM file.
2076 * The directory that the WIM image was mounted on.
2077 * @param unmount_flags
2078 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2079 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2080 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2082 * @param progress_func
2083 * If non-NULL, a function that will be called periodically with the
2084 * progress of the current operation.
2086 * @return 0 on success; nonzero on error.
2088 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2089 * The filesystem daemon was unable to remove the staging directory and the
2090 * temporary files that it contains.
2091 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2092 * The filesystem daemon appears to have terminated before sending an exit
2094 * @retval ::WIMLIB_ERR_FORK
2095 * Could not @c fork() the process.
2096 * @retval ::WIMLIB_ERR_FUSERMOUNT
2097 * The @b fusermount program could not be executed or exited with a failure
2099 * @retval ::WIMLIB_ERR_MQUEUE
2100 * Could not open a POSIX message queue to communicate with the filesystem
2101 * daemon servicing the mounted filesystem, could not send a message
2102 * through the queue, or could not receive a message through the queue.
2103 * @retval ::WIMLIB_ERR_NOMEM
2104 * Failed to allocate needed memory.
2105 * @retval ::WIMLIB_ERR_OPEN
2106 * The filesystem daemon could not open a temporary file for writing the
2108 * @retval ::WIMLIB_ERR_READ
2109 * A read error occurred when the filesystem daemon tried to a file from
2110 * the staging directory
2111 * @retval ::WIMLIB_ERR_RENAME
2112 * The filesystem daemon failed to rename the newly written WIM file to the
2113 * original WIM file.
2114 * @retval ::WIMLIB_ERR_WRITE
2115 * A write error occurred when the filesystem daemon was writing to the new
2116 * WIM file, or the filesystem daemon was unable to flush changes that had
2117 * been made to files in the staging directory.
2119 extern int wimlib_unmount_image(const char *dir, int unmount_flags,
2120 wimlib_progress_func_t progress_func);
2123 * Writes a standalone WIM to a file.
2125 * This brings in resources from any external locations, such as directory trees
2126 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2127 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2130 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2131 * changes made to it, which are then reflected in the output file.
2133 * The path to the file to write the WIM to.
2135 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2137 * @param write_flags
2138 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2139 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2140 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2141 * @param num_threads
2142 * Number of threads to use for compressing data. If 0, the number of
2143 * threads is taken to be the number of online processors. Note: if no
2144 * data compression needs to be done, no additional threads will be created
2145 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2146 * exporting an image from a compressed WIM to another WIM of the same
2147 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2149 * @param progress_func
2150 * If non-NULL, a function that will be called periodically with the
2151 * progress of the current operation.
2153 * @return 0 on success; nonzero on error.
2154 * @retval ::WIMLIB_ERR_DECOMPRESSION
2155 * Failed to decompress a metadata or file resource in @a wim.
2156 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2157 * A directory entry in the metadata resource for @a image in @a wim is
2159 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2160 * @a image does not specify a single existing image in @a wim, and is not
2161 * ::WIMLIB_ALL_IMAGES.
2162 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2163 * A file that had previously been scanned for inclusion in the WIM by
2164 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2165 * message digest check.
2166 * @retval ::WIMLIB_ERR_INVALID_PARAM
2167 * @a path was @c NULL.
2168 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2169 * The metadata resource for @a image in @a wim is invalid.
2170 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2171 * The security data for @a image in @a wim is invalid.
2172 * @retval ::WIMLIB_ERR_NOMEM
2173 * Failed to allocate needed memory.
2174 * @retval ::WIMLIB_ERR_OPEN
2175 * Failed to open @a path for writing, or some file resources in @a
2176 * wim refer to files in the outside filesystem, and one of these files
2177 * could not be opened for reading.
2178 * @retval ::WIMLIB_ERR_READ
2179 * An error occurred when trying to read data from the WIM file associated
2180 * with @a wim, or some file resources in @a wim refer to files in the
2181 * outside filesystem, and a read error occurred when reading one of these
2183 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2184 * @a wim is part of a split WIM. You may not call this function on a
2186 * @retval ::WIMLIB_ERR_WRITE
2187 * An error occurred when trying to write data to the new WIM file at @a
2190 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
2191 int write_flags, unsigned num_threads,
2192 wimlib_progress_func_t progress_func);
2194 #endif /* _WIMLIB_H */