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.3.3. If you
35 * have installed wimlib and want to know how to use the @b wimlib-imagex
36 * program, please see the man pages instead. Also: the actual project page
37 * where you can download the source code for the library is at <a
38 * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
40 * wimlib is a C library to read, write, and mount archive files in the Windows
41 * Imaging Format (WIM files). These files are normally created using the
42 * ImageX (@a imagex.exe) utility on Windows, but this library provides a free
43 * implementation of ImageX for UNIX-based systems (and, since v1.3.0, for
44 * Windows systems) and an API to allow other programs to read, write, and mount
45 * WIM files. wimlib is comparable to Microsoft's WIMGAPI, but was designed
46 * independently and is not a clone of it.
48 * \section format WIM files
50 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
51 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
52 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
53 * Both are based on LZ77 and Huffman encoding, and both are supported by
56 * Unlike ZIP files, WIM files can contain multiple independent toplevel
57 * directory trees known as @a images. While each image has its own metadata,
58 * files are not duplicated for each image; instead, each file is included only
59 * once in the entire WIM. Microsoft did this so that in one WIM file, they
60 * could do things like have 5 different versions of Windows that are almost
63 * Microsoft provides documentation for the WIM file format, XPRESS compression
64 * format, and LZX compression format. The XPRESS documentation is acceptable,
65 * but the LZX documentation is not entirely correct, and the WIM documentation
66 * itself is incomplete.
68 * A WIM file may be either stand-alone or split into multiple parts.
70 * \section ntfs NTFS support
72 * As of version 1.0.0, wimlib supports capturing and applying images directly
73 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
74 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
75 * data such as security descriptors, alternate data streams, and reparse point
78 * The code for NTFS image capture and image application is complete enough that
79 * it is possible to apply an image from the "install.wim" contained in recent
80 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
81 * NTFS volume, and then boot Windows from it after preparing the Boot
82 * Configuration Data. In addition, a Windows installation can be captured (or
83 * backed up) into a WIM file, and then re-applied later.
85 * wimlib v1.3.0 and later also supports NTFS capture and apply in the native
86 * Windows build, which works slightly differently and relies on native Win32
87 * API calls rather than libntfs-3g.
89 * \section winpe Windows PE
91 * A major use for this library is to create customized images of Windows PE, the
92 * Windows Preinstallation Environment, without having to rely on Windows. Windows
93 * PE is a lightweight version of Windows that can run entirely from memory and can
94 * be used to install Windows from local media or a network drive or perform
95 * maintenance. Windows PE is the operating system that runs when you boot from
96 * the Windows installation media.
98 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
99 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
100 * in the Windows Automated Installation Kit (WAIK), which is free to download
101 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
102 * install either the @c cabextract or @c p7zip programs.
104 * In addition, Windows installations and recovery partitions frequently contain a
105 * WIM containing an image of the Windows Recovery Environment, which is similar to
108 * \section starting Getting Started
110 * wimlib uses the GNU autotools, so it should be easy to install with
111 * <code>configure && make && sudo make install</code>; however, please see the
112 * README for more information about installing it. To use wimlib in a program
113 * after installing it, include @c wimlib.h and link your program with @c -lwim.
115 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
116 * may represent either a stand-alone WIM or one part of a split WIM.
118 * All functions in wimlib's public API are prefixed with @c wimlib. Most
119 * return an integer error code on failure. Use wimlib_get_error_string() to
120 * get a string that describes an error code. wimlib also can print error
121 * messages itself when an error happens, and these may be more informative than
122 * the error code; to enable this, call wimlib_set_print_errors(). Please note
123 * that this is for convenience only, and some errors can occur without a
124 * message being printed.
126 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
127 * the following exceptions:
128 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
129 * - You also must call wimlib_global_init() in the main thread to avoid any
130 * race conditions with one-time allocations of memory.
131 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
132 * concurrently in the same process, will daemonize the entire process when it
133 * does so for the first time. This includes changing the working directory
134 * to the root directory.
136 * To open an existing WIM, use wimlib_open_wim().
138 * To create a new WIM that initially contains no images, use
139 * wimlib_create_new_wim().
141 * To add an image to a WIM file from a directory tree on your filesystem, call
142 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
143 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
144 * also capture a WIM image directly from a NTFS volume if you provide the
145 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
146 * the <code>--without-ntfs-3g</code> flag.
148 * To extract an image from a WIM file, call wimlib_extract_image(). You may
149 * extract an image either to a directory or directly to a NTFS volume, the
150 * latter of which will preserve NTFS-specific data such as security
153 * wimlib supports mounting WIM files either read-only or read-write. Mounting
154 * is done using wimlib_mount_image() and unmounting is done using
155 * wimlib_unmount_image(). Mounting can be done without root privileges because
156 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
157 * compiled with the <code>--without-fuse</code> flag, these functions will be
158 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
160 * After creating or modifying a WIM file, you can write it to a file using
161 * wimlib_write(). Alternatively, if the WIM was originally read from a file
162 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
163 * wimlib_overwrite() to overwrite the original file.
165 * Please note: merely by calling wimlib_add_image() or many of the other
166 * functions in this library that operate on ::WIMStruct's, you are @b not
167 * modifying the WIM file on disk. Changes are not saved until you explicitly
168 * call wimlib_write() or wimlib_overwrite().
170 * After you are done with the WIM file, use wimlib_free() to free all memory
171 * associated with a ::WIMStruct and close all files associated with it.
173 * A number of functions take a pointer to a progress function of type
174 * ::wimlib_progress_func_t. This function will be called periodically during
175 * the WIM operation(s) to report on the progress of the operation (for example,
176 * how many bytes have been written so far).
178 * \section imagex wimlib-imagex
180 * wimlib comes with a command-line interface, the @b wimlib-imagex program. It
181 * is documented with man pages. This program was originally just called @b
182 * imagex, but has been changed to @b wimlib-imagex to avoid confusion with
183 * Microsoft's @a imagex.exe (which would otherwise have exactly the same
184 * filename on Windows).
186 * \section mkwinpeimg mkwinpeimg
188 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
191 * \section encodings Locales and character encodings
193 * To support Windows as well as UNIX, wimlib's API typically takes and returns
194 * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
196 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
197 * and the encoding is UTF-16LE.
199 * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
200 * encoding is the locale-dependent multibyte encoding. I recommend you set your
201 * locale to a UTF-8 capable locale to avoid any issues. Also, by default,
202 * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
203 * wimlib_global_init() after having set your desired locale.
205 * \section Limitations
207 * While wimlib supports the main features of WIM files, wimlib currently has
208 * the following limitations:
209 * - There is no way to add, remove, modify, or extract specific files in a WIM
210 * without mounting it, other than by adding, removing, or extracting an
211 * entire image. The FUSE mount feature should be used for this purpose.
212 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
213 * than wimlib (~2% or 3% smaller) when using maximum (LZX) compression.
214 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
215 * imagex.exe if you want to make sure your WIM files are made "correctly".
216 * - The old WIM format from Vista pre-releases is not supported.
217 * - Compressed resource chunk sizes other than 32768 are not supported,
218 * although this doesn't seem to be a problem because the chunk size always
219 * seems to be this value.
220 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
221 * make certain Windows-specific modifications to a Windows PE image, such as
222 * adding a driver or Windows component. Such a tool could conceivably be
223 * implemented on top of wimlib, although it likely would be hard to implement
224 * because it would have to do very Windows-specific things such as
225 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
226 * script for a similar purpose, however. With regards to adding drivers to
227 * Windows PE, you have the option of putting them anywhere in the Windows PE
228 * image, then loading them after boot using @b drvload.exe.
229 * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
230 * Windows build has some limitations compared to the UNIX build.
231 * (The differences are documented better in the man pages for
232 * @b wimlib-imagex than here.)
234 * \section legal License
236 * The wimlib library, as well as the programs and scripts distributed with it
237 * (@b wimlib-imagex and @b mkwinpeimg), is licensed under the GNU General
238 * Public License version 3 or later.
247 #include <inttypes.h>
249 /** Major version of the library (for example, the 1 in 1.2.5). */
250 #define WIMLIB_MAJOR_VERSION 1
252 /** Minor version of the library (for example, the 2 in 1.2.5). */
253 #define WIMLIB_MINOR_VERSION 3
255 /** Patch version of the library (for example, the 5 in 1.2.5). */
256 #define WIMLIB_PATCH_VERSION 3
259 * Opaque structure that represents a WIM file. This is an in-memory structure
260 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
261 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
262 * continuing to exist so that data can be read from it as needed.
264 * Most functions in this library will work the same way regardless of whether a
265 * given ::WIMStruct was obtained through wimlib_open_wim() or
266 * wimlib_create_new_wim(). Exceptions are documented.
268 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
269 * file from a ::WIMStruct.
271 typedef struct WIMStruct WIMStruct;
274 typedef wchar_t wimlib_tchar;
276 /** See \ref encodings */
277 typedef char wimlib_tchar;
281 * Specifies the compression type of a WIM file.
283 enum wimlib_compression_type {
284 /** An invalid compression type. */
285 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
287 /** The WIM does not include any compressed resources. */
288 WIMLIB_COMPRESSION_TYPE_NONE = 0,
290 /** Compressed resources in the WIM use LZX compression. */
291 WIMLIB_COMPRESSION_TYPE_LZX = 1,
293 /** Compressed resources in the WIM use XPRESS compression. */
294 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
297 /** Possible values of the first parameter to the user-supplied
298 * ::wimlib_progress_func_t progress function */
299 enum wimlib_progress_msg {
301 /** A WIM image is about to be extracted. @a info will point to
302 * ::wimlib_progress_info.extract. */
303 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
305 /** The directory structure of the WIM image is about to be extracted.
306 * @a info will point to ::wimlib_progress_info.extract. */
307 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
309 /** The directory structure of the WIM image has been successfully
310 * extracted. @a info will point to ::wimlib_progress_info.extract. */
311 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
313 /** The WIM image's files resources are currently being extracted. @a
314 * info will point to ::wimlib_progress_info.extract. */
315 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
317 /** A file or directory is being extracted. @a info will point to
318 * ::wimlib_progress_info.extract, and the @a cur_path member will be
320 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
322 /** All the WIM files and directories have been extracted, and
323 * timestamps are about to be applied. @a info will point to
324 * ::wimlib_progress_info.extract. */
325 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
327 /** A WIM image has been successfully extracted. @a info will point to
328 * ::wimlib_progress_info.extract. */
329 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
331 /** The directory or NTFS volume is about to be scanned to build a tree
332 * of WIM dentries in-memory. @a info will point to
333 * ::wimlib_progress_info.scan. */
334 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
336 /** A directory or file is being scanned. @a info will point to
337 * ::wimlib_progress_info.scan, and its @a cur_path member will be
338 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
339 * is passed to wimlib_add_image(). */
340 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
342 /** The directory or NTFS volume has been successfully scanned, and a
343 * tree of WIM dentries has been built in-memory. @a info will point to
344 * ::wimlib_progress_info.scan. */
345 WIMLIB_PROGRESS_MSG_SCAN_END,
348 * File resources are currently being written to the WIM.
349 * @a info will point to ::wimlib_progress_info.write_streams. */
350 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
353 * The metadata resource for each image is about to be written to the
354 * WIM. @a info will not be valid. */
355 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
358 * The metadata resource for each image has successfully been writen to
359 * the WIM. @a info will not be valid. */
360 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
363 * The temporary file has successfully been renamed to the original WIM
364 * file. Only happens when wimlib_overwrite() is called and the
365 * overwrite is not done in-place.
366 * @a info will point to ::wimlib_progress_info.rename. */
367 WIMLIB_PROGRESS_MSG_RENAME,
369 /** The contents of the WIM are being checked against the integrity
370 * table. Only happens when wimlib_open_wim() is called with the
371 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
372 * ::wimlib_progress_info.integrity. */
373 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
375 /** An integrity table is being calculated for the WIM being written.
376 * Only happens when wimlib_write() or wimlib_overwrite() is called with
377 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
378 * ::wimlib_progress_info.integrity. */
379 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
381 /** A wimlib_join() operation is in progress. @a info will point to
382 * ::wimlib_progress_info.join. */
383 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
385 /** A wimlib_split() operation is in progress, and a new split part is
386 * about to be started. @a info will point to
387 * ::wimlib_progress_info.split. */
388 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
390 /** A wimlib_split() operation is in progress, and a split part has been
391 * finished. @a info will point to ::wimlib_progress_info.split. */
392 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
395 /** A pointer to this union is passed to the user-supplied
396 * ::wimlib_progress_func_t progress function. One (or none) of the structures
397 * contained in this union will be applicable for the operation
398 * (::wimlib_progress_msg) indicated in the first argument to the progress
400 union wimlib_progress_info {
402 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
403 * document them if they aren't given a name... */
405 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
406 struct wimlib_progress_info_write_streams {
407 /** Number of bytes that are going to be written for all the
408 * streams combined. This is the amount in uncompressed data.
409 * (The actual number of bytes will be less if the data is being
410 * written compressed.) */
411 uint64_t total_bytes;
412 /** Number of streams that are going to be written. */
413 uint64_t total_streams;
415 /** Number of uncompressed bytes that have been written so far.
416 * Will be 0 initially, and equal to @a total_bytes at the end.
418 uint64_t completed_bytes;
420 /** Number of streams that have been written. Will be 0
421 * initially, and equal to @a total_streams at the end. */
422 uint64_t completed_streams;
424 /** Number of threads that are being used to compress resources
425 * (if applicable). */
426 unsigned num_threads;
428 /** The compression type being used to write the streams; either
429 * ::WIMLIB_COMPRESSION_TYPE_NONE,
430 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
431 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
432 int compression_type;
434 /** Library internal use only. */
438 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
439 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
440 struct wimlib_progress_info_scan {
441 /** Directory or NTFS volume that is being scanned. */
442 const wimlib_tchar *source;
444 /** Path to the file or directory that is about to be scanned,
445 * relative to the root of the image capture or the NTFS volume.
447 const wimlib_tchar *cur_path;
449 /** True iff @a cur_path is being excluded from the image
450 * capture due to the capture configuration file. */
453 /** Target path in the WIM. Only valid on messages
454 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
455 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
456 const wimlib_tchar *wim_target_path;
459 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
460 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
461 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
462 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
463 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
464 struct wimlib_progress_info_extract {
465 /** Number of the image being extracted (1-based). */
468 /** Flags passed to to wimlib_extract_image() */
471 /** Full path to the WIM file being extracted. */
472 const wimlib_tchar *wimfile_name;
474 /** Name of the image being extracted. */
475 const wimlib_tchar *image_name;
477 /** Directory or NTFS volume to which the image is being
479 const wimlib_tchar *target;
481 /** Current dentry being extracted. (Valid only if message is
482 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
483 const wimlib_tchar *cur_path;
485 /** Number of bytes of uncompressed data that will be extracted.
486 * Takes into account hard links (they are not counted for each
489 uint64_t total_bytes;
491 /** Number of bytes that have been written so far. Will be 0
492 * initially, and equal to @a total_bytes at the end. */
493 uint64_t completed_bytes;
495 /** Number of streams that will be extracted. This may more or
496 * less than the number of "files" to be extracted due to
497 * special cases (hard links, symbolic links, and alternate data
499 uint64_t num_streams;
502 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
503 struct wimlib_progress_info_rename {
504 /** Name of the temporary file that the WIM was written to. */
505 const wimlib_tchar *from;
507 /** Name of the original WIM file to which the temporary file is
509 const wimlib_tchar *to;
512 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
513 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
514 struct wimlib_progress_info_integrity {
515 /** Number of bytes from the end of the WIM header to the end of
516 * the lookup table (the area that is covered by the SHA1
517 * integrity checks.) */
518 uint64_t total_bytes;
520 /** Number of bytes that have been SHA1-summed so far. Will be
521 * 0 initially, and equal @a total_bytes at the end. */
522 uint64_t completed_bytes;
524 /** Number of chunks that the checksummed region is divided
526 uint32_t total_chunks;
528 /** Number of chunks that have been SHA1-summed so far. Will
529 * be 0 initially, and equal to @a total_chunks at the end. */
530 uint32_t completed_chunks;
532 /** Size of the chunks used for the integrity calculation. */
535 /** Filename of the WIM (only valid if the message is
536 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
537 const wimlib_tchar *filename;
540 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
541 struct wimlib_progress_info_join {
542 /** Total number of bytes of compressed data contained in all
543 * the split WIM part's file and metadata resources. */
544 uint64_t total_bytes;
546 /** Number of bytes that have been copied to the joined WIM so
547 * far. Will be 0 initially, and equal to @a total_bytes at the
549 uint64_t completed_bytes;
551 /** Number of split WIM parts that have had all their file and
552 * metadata resources copied over to the joined WIM so far. */
553 unsigned completed_parts;
555 /** Number of split WIM parts. */
556 unsigned total_parts;
559 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
560 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
561 struct wimlib_progress_info_split {
562 /** Total size of the original WIM's file and metadata resources
564 uint64_t total_bytes;
566 /** Number of bytes of file and metadata resources that have
567 * been copied out of the original WIM so far. Will be 0
568 * initially, and equal to @a total_bytes at the end. */
569 uint64_t completed_bytes;
571 /** Number of the split WIM part that is about to be started
572 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
573 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
574 unsigned cur_part_number;
576 /** Name of the split WIM part that is about to be started
577 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
578 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
579 const wimlib_tchar *part_name;
583 /** A user-supplied function that will be called periodically during certain WIM
584 * operations. The first argument will be the type of operation that is being
585 * performed or is about to be started or has been completed. The second
586 * argument will be a pointer to one of a number of structures depending on the
587 * first argument. It may be @c NULL for some message types.
589 * The return value of the progress function is currently ignored, but it may do
590 * something in the future. (Set it to 0 for now.)
592 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
593 const union wimlib_progress_info *info);
595 /** An array of these structures is passed to wimlib_add_image_multisource() to
596 * specify the sources from which to create a WIM image. */
597 struct wimlib_capture_source {
598 /** Absolute or relative path to a file or directory on the external
599 * filesystem to be included in the WIM image. */
600 wimlib_tchar *fs_source_path;
602 /** Destination path in the WIM image. Leading and trailing slashes are
603 * ignored. The empty string or @c NULL means the root directory of the
605 wimlib_tchar *wim_target_path;
607 /** Reserved; set to 0. */
611 /** Structure that specifies a list of path patterns. */
612 struct wimlib_pattern_list {
613 /** Array of patterns. The patterns may be modified by library code,
614 * but the @a pats pointer itself will not. See the man page for
615 * <b>wimlib-imagex capture</b> for more information about allowed
619 /** Number of patterns in the @a pats array. */
622 /** Ignored; may be used by the calling code. */
623 size_t num_allocated_pats;
626 /** A structure that contains lists of wildcards that match paths to treat
627 * specially when capturing a WIM image. */
628 struct wimlib_capture_config {
629 /** Paths matching any pattern this list are excluded from being
630 * captured, except if the same path appears in @a
631 * exclusion_exception_pats. */
632 struct wimlib_pattern_list exclusion_pats;
634 /** Paths matching any pattern in this list are never excluded from
636 struct wimlib_pattern_list exclusion_exception_pats;
638 /** Reserved for future capture configuration options. */
639 struct wimlib_pattern_list reserved1;
641 /** Reserved for future capture configuration options. */
642 struct wimlib_pattern_list reserved2;
644 /** Library internal use only. */
645 wimlib_tchar *_prefix;
647 /** Library internal use only. */
648 size_t _prefix_num_tchars;
652 /*****************************
653 * WIMLIB_ADD_IMAGE_FLAG_* *
654 *****************************/
656 /** Directly capture a NTFS volume rather than a generic directory. This flag
657 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
658 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
659 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
661 /** Follow symlinks; archive and dump the files they point to. Cannot be used
662 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
663 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
665 /** Call the progress function with the message
666 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
668 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
670 /** Mark the image being added as the bootable image of the WIM. */
671 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
673 /** Store the UNIX owner, group, and mode. This is done by adding a special
674 * alternate data stream to each regular file, symbolic link, and directory to
675 * contain this information. Please note that this flag is for convenience
676 * only; Microsoft's @a imagex.exe will not understand this special information.
677 * This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
678 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
680 /** Do not capture security descriptors. Only has an effect in NTFS capture
681 * mode, or in Win32 native builds. */
682 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020
684 /** Fail immediately if the full security descriptor of any file or directory
685 * cannot be accessed. Only has an effect in Win32 native builds. The default
686 * behavior without this flag is to first try omitting the SACL from the
687 * security descriptor, then to try omitting the security descriptor entirely.
689 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS 0x00000040
691 /** Call the progress function with the message
692 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
693 * capture. This is a subset of the messages provided by
694 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
695 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE 0x00000080
697 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
698 * in the case of Windows) that point inside the directory being captured to
699 * instead be absolute relative to the directory being captured, rather than the
700 * current root; also exclude absolute symbolic links that point outside the
701 * directory tree being captured.
703 * Without this flag, the default is to do this only if WIM_HDR_FLAG_RP_FIX is
704 * set in the WIM header. WIM_HDR_FLAG_RP_FIX is set if the first image in a
705 * WIM is captured with WIMLIB_ADD_IMAGE_FLAG_RPFIX enabled and currently cannot
707 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX 0x00000100
709 /* Don't do reparse point fixups. Without this flag, the default is to do
710 * reparse point fixes if WIM_HDR_FLAG_RP_FIX is set in the WIM header. */
711 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX 0x00000200
713 /******************************
714 * WIMLIB_EXPORT_FLAG_* *
715 ******************************/
717 /** See documentation for wimlib_export_image(). */
718 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
720 /******************************
721 * WIMLIB_EXTRACT_FLAG_* *
722 ******************************/
724 /** Extract the image directly to a NTFS volume rather than a generic directory.
726 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
728 /** When identical files are extracted from the WIM, always hard link them
729 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
730 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
732 /** When identical files are extracted from the WIM, always symlink them
733 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
734 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
736 /** Call the progress function with the argument
737 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
738 * extracted. Note: these calls will be interspersed with calls for the message
739 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
740 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
742 /** Read the WIM file sequentially while extracting the image. */
743 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
745 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
746 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
747 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
749 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
750 * or in Win32 native builds. */
751 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
753 /** Fail immediately if the full security descriptor of any file or directory
754 * cannot be set exactly as specified in the WIM file. The default behavior
755 * without this flag is to fall back to setting the security descriptor with the
756 * SACL omitted, then only the default inherited security descriptor, if we do
757 * not have permission to set the desired one. */
758 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
760 /* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
761 * fixups on, so absolute symbolic links are junction points will be fixed to be
762 * absolute relative to the actual extraction root. Done by default if
763 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. */
764 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
766 /** Force reparse-point fixups on extraction off, regardless of the state of the
767 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
768 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
770 /******************************
771 * WIMLIB_MOUNT_FLAG_* *
772 ******************************/
774 /** Mount the WIM image read-write rather than the default of read-only. */
775 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
777 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
778 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
780 /** Do not allow accessing alternate data streams in the mounted WIM image. */
781 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
783 /** Access alternate data streams in the mounted WIM image through extended file
784 * attributes. This is the default mode. */
785 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
787 /** Access alternate data streams in the mounted WIM image by specifying the
788 * file name, a colon, then the alternate file stream name. */
789 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
791 /** Use UNIX file owners, groups, and modes if available in the WIM (see
792 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
793 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
795 /** Allow other users to see the mounted filesystem. (this passes the @c
796 * allow_other option to FUSE mount) */
797 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
799 /******************************
800 * WIMLIB_OPEN_FLAG_* *
801 ******************************/
803 /** Verify the WIM contents against the WIM's integrity table, if present. */
804 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
806 /** Do not issue an error if the WIM is part of a split WIM. */
807 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
809 /******************************
810 * WIMLIB_UNMOUNT_FLAG_* *
811 ******************************/
813 /** Include an integrity table in the WIM after it's been unmounted. Ignored
814 * for read-only mounts. */
815 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
817 /** Unless this flag is given, changes to a read-write mounted WIM are
818 * discarded. Ignored for read-only mounts. */
819 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
821 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
822 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
824 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
825 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
827 /******************************
828 * WIMLIB_WRITE_FLAG_* *
829 ******************************/
831 /** Include an integrity table in the new WIM file. */
832 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
834 /** Re-build the entire WIM file rather than appending data to it, if possible.
835 * (Applies to wimlib_overwrite(), not wimlib_write()). */
836 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
838 /** Recompress all resources, even if they could otherwise be copied from a
839 * different WIM with the same compression type (in the case of
840 * wimlib_export_image() being called previously). */
841 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
843 /** Call fsync() when the WIM file is closed */
844 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
846 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
847 * after one or more calls to wimlib_delete_image(), which is to rebuild the
850 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
851 * correctly remove the image from the WIM will be taken. In particular, all
852 * streams will be left alone, even if they are no longer referenced. This is
853 * probably not what you want, because almost no space will be spaced by
854 * deleting an image in this way. */
855 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
857 /** Assume that strings are represented in UTF-8, even if this is not the
858 * locale's character encoding. */
859 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
863 /****************************************************************
864 * Definition of struct wimlib_modify_command, with various flags
865 ****************************************************************/
868 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_ALL = 0x1,
869 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_NONDIRECTORIES = 0x2,
870 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_EMPTY_DIRECTORIES = 0x4,
871 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_DIRECTORIES = 0x8,
875 WIMLIB_DELETE_TREE_FLAG_FORCE = 0x1,
876 WIMLIB_DELETE_TREE_FLAG_RECURSIVE = 0x2,
877 WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR = 0x4,
881 WIMLIB_ADD_TREE_FLAG_DEREFERENCE = 0x1,
882 WIMLIB_ADD_TREE_FLAG_VERBOSE = 0x2,
883 WIMLIB_ADD_TREE_FLAG_UNIX_DATA = 0x4,
884 WIMLIB_ADD_TREE_FLAG_NOACLS = 0x8,
885 WIMLIB_ADD_TREE_FLAG_NTFS_VOLUME = 0x01,
886 WIMLIB_ADD_TREE_FLAG_OVERLAY = 0x02,
887 WIMLIB_ADD_TREE_FLAG_MAKE_NECESSARY_DIRS = 0x04,
890 enum wimlib_modify_op {
891 WIMLIB_MODIFY_OP_DELETE_TREE,
892 WIMLIB_MODIFY_OP_ADD_TREE,
893 WIMLIB_MODIFY_OP_MOVE_TREE,
896 struct wimlib_modify_command {
897 enum wimlib_modify_op op;
899 struct wimlib_modify_command_delete_tree {
900 int delete_tree_flags;
901 const wimlib_tchar *tree_wim_path;
902 unsigned long reserved;
905 struct wimlib_modify_command_add_tree {
907 const wimlib_tchar *fs_source_path;
908 const wimlib_tchar *wim_target_path;
909 unsigned long reserved;
912 struct wimlib_modify_command_move_tree {
914 const wimlib_tchar *wim_source_path;
915 const wimlib_tchar *wim_target_path;
916 unsigned long reserved;
924 * Possible values of the error code returned by many functions in wimlib.
926 * See the documentation for each wimlib function to see specifically what error
927 * codes can be returned by a given function, and what they mean.
929 /* Note: these are currently in alphabetic order, but new error codes should be
930 * added at the end to maintain a compatible ABI, except when it's being broken
932 enum wimlib_error_code {
933 WIMLIB_ERR_SUCCESS = 0,
934 WIMLIB_ERR_ALREADY_LOCKED,
935 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
936 WIMLIB_ERR_DECOMPRESSION,
937 WIMLIB_ERR_DELETE_STAGING_DIR,
938 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
941 WIMLIB_ERR_FUSERMOUNT,
942 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
943 WIMLIB_ERR_IMAGE_COUNT,
944 WIMLIB_ERR_IMAGE_NAME_COLLISION,
945 WIMLIB_ERR_INTEGRITY,
946 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
947 WIMLIB_ERR_INVALID_CHUNK_SIZE,
948 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
949 WIMLIB_ERR_INVALID_DENTRY,
950 WIMLIB_ERR_INVALID_HEADER_SIZE,
951 WIMLIB_ERR_INVALID_IMAGE,
952 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
953 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
954 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
955 WIMLIB_ERR_INVALID_OVERLAY,
956 WIMLIB_ERR_INVALID_PARAM,
957 WIMLIB_ERR_INVALID_PART_NUMBER,
958 WIMLIB_ERR_INVALID_RESOURCE_HASH,
959 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
960 WIMLIB_ERR_INVALID_SECURITY_DATA,
961 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
962 WIMLIB_ERR_INVALID_UTF16_STRING,
963 WIMLIB_ERR_INVALID_UTF8_STRING,
964 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
970 WIMLIB_ERR_NOT_A_WIM_FILE,
971 WIMLIB_ERR_NO_FILENAME,
979 WIMLIB_ERR_RESOURCE_ORDER,
980 WIMLIB_ERR_SPECIAL_FILE,
981 WIMLIB_ERR_SPLIT_INVALID,
982 WIMLIB_ERR_SPLIT_UNSUPPORTED,
985 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
986 WIMLIB_ERR_UNKNOWN_VERSION,
987 WIMLIB_ERR_UNSUPPORTED,
988 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
994 /** Used to indicate that no WIM image or an invalid WIM image. */
995 #define WIMLIB_NO_IMAGE 0
997 /** Used to specify all images in the WIM. */
998 #define WIMLIB_ALL_IMAGES (-1)
1001 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1003 * The directory tree of NTFS volume is read immediately for the purpose of
1004 * constructing a directory entry tree in-memory. Also, all files are read to
1005 * calculate their SHA1 message digests. However, because the directory tree
1006 * may contain a very large amount of data, the files themselves are not read
1007 * into memory permanently, and instead references to their paths saved. The
1008 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
1011 * See the manual page for the @b wimlib-imagex program for more information
1012 * about the "normal" capture mode versus the NTFS capture mode (entered by
1013 * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
1015 * Note that @b no changes are committed to the underlying WIM file (if
1016 * any) until wimlib_write() or wimlib_overwrite() is called.
1019 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1022 * A path to a directory or unmounted NTFS volume that will be captured as
1025 * The name to give the image. This must be non-@c NULL.
1027 * Capture configuration that specifies files, directories, or path globs
1028 * to exclude from being captured. If @c NULL, a dummy configuration where
1029 * no paths are treated specially is used.
1030 * @param add_image_flags
1031 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
1032 * @param progress_func
1033 * If non-NULL, a function that will be called periodically with the
1034 * progress of the current operation.
1036 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1037 * discarded so that it appears to be in the same state as when this function
1040 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1041 * There is already an image named @a name in @a wim.
1042 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
1043 * @a config was not @c NULL and did not specify a valid image capture
1045 * @retval ::WIMLIB_ERR_INVALID_PARAM
1046 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
1047 * @retval ::WIMLIB_ERR_NOMEM
1048 * Failed to allocate needed memory.
1049 * @retval ::WIMLIB_ERR_NOTDIR
1050 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
1051 * not specified in @a add_image_flags).
1052 * @retval ::WIMLIB_ERR_NTFS_3G
1053 * An error was returned from a libntfs-3g function when the NTFS volume
1054 * was being opened, scanned, or closed (only if
1055 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
1056 * @retval ::WIMLIB_ERR_OPEN
1057 * Failed to open a file or directory in the directory tree rooted at @a
1058 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
1060 * @retval ::WIMLIB_ERR_READ
1061 * Failed to read a file in the directory tree rooted at @a source (only if
1062 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
1063 * @retval ::WIMLIB_ERR_SPECIAL_FILE
1064 * The directory tree rooted at @a source contains a special file that is
1065 * not a directory, regular file, or symbolic link. This currently can
1066 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
1067 * add_image_flags, but it may be returned for unsupported NTFS files in
1069 * @retval ::WIMLIB_ERR_STAT
1070 * Failed obtain the metadata for a file or directory in the directory tree
1071 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
1072 * specified in @a add_image_flags).
1073 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1074 * @a wim is part of a split WIM. Adding an image to a split WIM is
1076 * @retval ::WIMLIB_ERR_UNSUPPORTED
1077 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
1078 * wimlib was configured with the @c --without-ntfs-3g flag.
1081 wimlib_add_image(WIMStruct *wim,
1082 const wimlib_tchar *source,
1083 const wimlib_tchar *name,
1084 struct wimlib_capture_config *config,
1085 int add_image_flags,
1086 wimlib_progress_func_t progress_func);
1088 /** This function is equivalent to wimlib_add_image() except it allows for
1089 * multiple sources to be combined into a single WIM image. This is done by
1090 * specifying the @a sources and @a num_sources parameters instead of the @a
1091 * source parameter of wimlib_add_image(). The rest of the parameters are the
1092 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1093 * capture</b> for full details on how this mode works.
1095 * Additional note: @a sources is not a @c const parameter and you cannot
1096 * assume that its contents are valid after this function returns. You must
1097 * save pointers to the strings in these structures if you need to free them
1098 * later, and/or save copies if needed.
1100 * In addition to the error codes that wimlib_add_image() can return,
1101 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1102 * when trying to overlay a non-directory on a directory or when otherwise
1103 * trying to overlay multiple conflicting files to the same location in the WIM
1104 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1105 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
1106 * was not exactly one capture source with the target being the root directory.
1107 * (In this respect, there is no advantage to using
1108 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1111 wimlib_add_image_multisource(WIMStruct *w,
1112 struct wimlib_capture_source *sources,
1114 const wimlib_tchar *name,
1115 struct wimlib_capture_config *config,
1116 int add_image_flags,
1117 wimlib_progress_func_t progress_func);
1120 * Creates a ::WIMStruct for a new WIM file.
1122 * This only creates an in-memory structure for a WIM that initially contains no
1123 * images. No on-disk file is created until wimlib_write() is called.
1126 * The type of compression to be used in the new WIM file. Must be
1127 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1128 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1130 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1131 * written to the memory location pointed to by this paramater. The
1132 * ::WIMStruct must be freed using using wimlib_free() when finished with
1134 * @return 0 on success; nonzero on error.
1135 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1136 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1137 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1138 * @retval ::WIMLIB_ERR_NOMEM
1139 * Failed to allocate needed memory.
1142 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1145 * Deletes an image, or all images, from a WIM file.
1147 * All streams referenced by the image(s) being deleted are removed from the
1148 * lookup table of the WIM if they are not referenced by any other images in the
1151 * Please note that @b no changes are committed to the underlying WIM file (if
1152 * any) until wimlib_write() or wimlib_overwrite() is called.
1155 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1158 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1160 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1161 * to be left unmodified only if @a image specified a single image. If instead
1162 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1163 * possible for some but not all of the images to have been deleted when a
1164 * failure status is returned.
1166 * @retval ::WIMLIB_ERR_DECOMPRESSION
1167 * Could not decompress the metadata resource for @a image.
1168 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1169 * A directory entry in the metadata resource for @a image in the WIM is
1171 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1172 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1173 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1174 * The metadata resource for @a image in the WIM is invalid.
1175 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1176 * The security data for @a image in the WIM is invalid.
1177 * @retval ::WIMLIB_ERR_NOMEM
1178 * Failed to allocate needed memory.
1179 * @retval ::WIMLIB_ERR_READ
1180 * Could not read the metadata resource for @a image from the WIM.
1181 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1182 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1186 wimlib_delete_image(WIMStruct *wim, int image);
1189 * Exports an image, or all the images, from a WIM file, into another WIM file.
1191 * The destination image is made to share the same dentry tree and security data
1192 * structure as the source image. This places some restrictions on additional
1193 * functions that may be called. wimlib_mount_image() may not be called on
1194 * either the source image or the destination image without an intervening call
1195 * to a function that un-shares the images, such as wimlib_free() on @a
1196 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1197 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1198 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1199 * have references back to @a src_wim.
1201 * Previous versions of this function left @a dest_wim in an indeterminate state
1202 * on failure. This is no longer the case; all changes to @a dest_wim made by
1203 * this function are rolled back on failure.
1205 * Previous versions of this function did not allow exporting an image that had
1206 * been added by wimlib_add_image(). This is no longer the case; you may now
1207 * export an image regardless of how it was added.
1209 * Regardless of whether this function succeeds or fails, no changes are made to
1212 * Please note that no changes are committed to the underlying WIM file of @a
1213 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1216 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1217 * WIM that contains the image(s) being exported.
1219 * The image to export from @a src_wim. Can be the number of an image, or
1220 * ::WIMLIB_ALL_IMAGES to export all images.
1222 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1225 * The name to give the exported image in the new WIM file. If left @c
1226 * NULL, the name from @a src_wim is used. This parameter must be left @c
1227 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1228 * than one image; in that case, the names are all taken from the @a
1229 * src_wim. (This is allowed even if one or more images being exported has
1231 * @param dest_description
1232 * The description to give the exported image in the new WIM file. If left
1233 * @c NULL, the description from the @a src_wim is used. This parameter must
1234 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1235 * more than one image; in that case, the descriptions are all taken from
1236 * @a src_wim. (This is allowed even if one or more images being exported
1237 * has no description.)
1238 * @param export_flags
1239 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1240 * bootable, or 0 if which image is marked as bootable in the destination
1241 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1242 * there are multiple images in @a src_wim, specifying
1243 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1244 * currently marked as bootable in @a src_wim; if that is the case, then
1245 * that image is marked as bootable in the destination WIM.
1246 * @param additional_swms
1247 * Array of pointers to the ::WIMStruct for each additional part in the
1248 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1249 * need to be in any particular order, but they must include all parts of
1250 * the split WIM other than the first part, which must be provided in the
1252 * @param num_additional_swms
1253 * Number of additional WIM parts provided in the @a additional_swms array.
1254 * This number should be one less than the total number of parts in the
1255 * split WIM. Set to 0 if the WIM is a standalone WIM.
1256 * @param progress_func
1257 * If non-NULL, a function that will be called periodically with the
1258 * progress of the current operation.
1260 * @return 0 on success; nonzero on error.
1261 * @retval ::WIMLIB_ERR_DECOMPRESSION
1262 * Could not decompress the metadata resource for @a src_image
1264 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1265 * One or more of the names being given to an exported image was already in
1266 * use in the destination WIM.
1267 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1268 * A directory entry in the metadata resource for @a src_image in @a
1269 * src_wim is invalid.
1270 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1271 * @a src_image does not exist in @a src_wim.
1272 * @retval ::WIMLIB_ERR_INVALID_PARAM
1273 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1274 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1275 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1276 * dest_description were non-<code>NULL</code>, @a src_image was
1277 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1278 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1279 * The metadata resource for @a src_image in @a src_wim is invalid.
1280 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1281 * The security data for @a src_image in @a src_wim is invalid.
1282 * @retval ::WIMLIB_ERR_NOMEM
1283 * Failed to allocate needed memory.
1284 * @retval ::WIMLIB_ERR_READ
1285 * Could not read the metadata resource for @a src_image from @a src_wim.
1286 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1287 * The source WIM is a split WIM, but the parts specified do not form a
1288 * complete split WIM because they do not include all the parts of the
1289 * original WIM, there are duplicate parts, or not all the parts have the
1290 * same GUID and compression type.
1291 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1292 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1296 wimlib_export_image(WIMStruct *src_wim, int src_image,
1297 WIMStruct *dest_wim,
1298 const wimlib_tchar *dest_name,
1299 const wimlib_tchar *dest_description,
1301 WIMStruct **additional_swms,
1302 unsigned num_additional_swms,
1303 wimlib_progress_func_t progress_func);
1306 * Extracts an image, or all images, from a standalone or split WIM file to a
1307 * directory or a NTFS volume.
1309 * Please see the manual page for the @c wimlib-imagex program for more
1310 * information about the "normal" extraction mode versus the NTFS extraction
1311 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1313 * Extraction is done with one thread.
1315 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1316 * returned if any resulting SHA1 message digests do not match the values
1317 * provided in the WIM file. Therefore, if this function is successful, you can
1318 * be fairly sure that any compressed data in the WIM was uncompressed
1322 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1325 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1326 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1327 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1329 * Directory to extract the WIM image(s) to (created if it does not already
1330 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1331 * path to the unmounted NTFS volume to extract the image to.
1332 * @param extract_flags
1333 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1335 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1336 * a NTFS volume to extract the image to. The volume will be opened using
1337 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1338 * Otherwise, @a target is interpreted as a directory to extract the
1341 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1342 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1343 * specified. These flags cause extracted files that are identical to be
1344 * hardlinked or symlinked together, depending on the flag. These flags
1345 * override the hard link groups that are specified in the WIM file itself.
1346 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1347 * hardlinked or symlinked across images if a file is found to occur in
1348 * more than one image.
1350 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1351 * name of each file or directory as it is extracted.
1353 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1354 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1355 * each image is considered separately with regards to the sequential
1356 * order. It is also possible for alternate data streams to break the
1357 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1359 * @param additional_swms
1360 * Array of pointers to the ::WIMStruct for each additional part in the
1361 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1362 * need to be in any particular order, but they must include all parts of
1363 * the split WIM other than the first part, which must be provided in the
1365 * @param num_additional_swms
1366 * Number of additional WIM parts provided in the @a additional_swms array.
1367 * This number should be one less than the total number of parts in the
1368 * split WIM. Set to 0 if the WIM is a standalone WIM.
1370 * @param progress_func
1371 * If non-NULL, a function that will be called periodically with the
1372 * progress of the current operation.
1374 * @return 0 on success; nonzero on error.
1375 * @retval ::WIMLIB_ERR_DECOMPRESSION
1376 * Could not decompress a resource (file or metadata) for @a image in @a
1378 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1379 * A directory entry in the metadata resource for @a image in @a wim is
1381 * @retval ::WIMLIB_ERR_INVALID_PARAM
1382 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1383 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1384 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1385 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1386 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1387 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1388 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1389 * specified in @a extract_flag.
1390 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1391 * The SHA1 message digest of an extracted stream did not match the SHA1
1392 * message digest given in the WIM file.
1393 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1394 * A resource (file or metadata) for @a image in @a wim is invalid.
1395 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1396 * The security data for @a image in @a wim is invalid.
1397 * @retval ::WIMLIB_ERR_LINK
1398 * Failed to create a symbolic link or a hard link (only if
1399 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1400 * @retval ::WIMLIB_ERR_MKDIR
1401 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1402 * not specified in @a extract_flags).
1403 * @retval ::WIMLIB_ERR_NOMEM
1404 * Failed to allocate needed memory.
1405 * @retval ::WIMLIB_ERR_NTFS_3G
1406 * An error was returned from a libntfs-3g function while the WIM image was
1407 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1408 * was specified in @a extract_flags).
1409 * @retval ::WIMLIB_ERR_OPEN
1410 * Could not open one of the files being extracted for writing (only if
1411 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1412 * @retval ::WIMLIB_ERR_READ
1413 * A unexpected end-of-file or read error occurred when trying to read data
1414 * from the WIM file associated with @a wim.
1415 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1416 * The WIM is a split WIM, but the parts specified do not form a complete
1417 * split WIM because they do not include all the parts of the original WIM,
1418 * there are duplicate parts, or not all the parts have the same GUID and
1420 * @retval ::WIMLIB_ERR_UNSUPPORTED
1421 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1422 * was configured with the @c --without-ntfs-3g flag.
1423 * @retval ::WIMLIB_ERR_WRITE
1424 * Failed to write a file being extracted (only if
1425 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1428 wimlib_extract_image(WIMStruct *wim, int image,
1429 const wimlib_tchar *target,
1431 WIMStruct **additional_swms,
1432 unsigned num_additional_swms,
1433 wimlib_progress_func_t progress_func);
1436 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1437 * includes a string of XML that describes the images contained in the WIM.
1438 * This function works on standalone WIMs as well as split WIM parts.
1441 * Pointer to the ::WIMStruct for a WIM file.
1443 * @c stdout, or a FILE* opened for writing, to extract the data to.
1445 * @return 0 on success; nonzero on error.
1446 * @retval ::WIMLIB_ERR_WRITE
1447 * Failed to completely write the XML data to @a fp.
1448 * @retval ::WIMLIB_ERR_INVALID_PARAM
1449 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1452 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1455 * Frees all memory allocated for a WIMStruct and closes all files associated
1459 * Pointer to the ::WIMStruct for a WIM file.
1461 * @return This function has no return value.
1464 wimlib_free(WIMStruct *wim);
1467 * Returns the index of the bootable image of the WIM.
1470 * Pointer to the ::WIMStruct for a WIM file.
1473 * 0 if no image is marked as bootable, or the number of the image marked
1474 * as bootable (numbered starting at 1).
1477 wimlib_get_boot_idx(const WIMStruct *wim);
1480 * Returns the compression type used in the WIM.
1483 * Pointer to the ::WIMStruct for a WIM file
1486 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1487 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1490 wimlib_get_compression_type(const WIMStruct *wim);
1493 * Converts a ::wimlib_compression_type value into a string.
1496 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1497 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1500 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1503 extern const wimlib_tchar *
1504 wimlib_get_compression_type_string(int ctype);
1507 * Converts an error code into a string describing it.
1510 * The error code returned by one of wimlib's functions.
1513 * Pointer to a statically allocated string describing the error code,
1514 * or @c NULL if the error code is not valid.
1516 extern const wimlib_tchar *
1517 wimlib_get_error_string(enum wimlib_error_code code);
1520 * Returns the description of the specified image.
1523 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1524 * standalone WIM or a split WIM part.
1526 * The number of the image, numbered starting at 1.
1529 * The description of the image, or @c NULL if there is no such image, or
1530 * @c NULL if the specified image has no description. The description
1531 * string is in library-internal memory and may not be modified or freed;
1532 * in addition, the string will become invalid if the description of the
1533 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1535 extern const wimlib_tchar *
1536 wimlib_get_image_description(const WIMStruct *wim, int image);
1539 * Returns the name of the specified image.
1542 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1543 * standalone WIM or a split WIM part.
1545 * The number of the image, numbered starting at 1.
1548 * The name of the image, or @c NULL if there is no such image. The name
1549 * string is in library-internal memory and may not be modified or freed;
1550 * in addition, the string will become invalid if the name of the image is
1551 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1553 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1554 * the WIM to be unnamed, in which case an empty string will be returned
1555 * when the corresponding name is requested.
1557 extern const wimlib_tchar *
1558 wimlib_get_image_name(const WIMStruct *wim, int image);
1562 * Returns the number of images contained in a WIM.
1565 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1566 * standalone WIM or a split WIM part.
1569 * The number of images contained in the WIM file.
1572 wimlib_get_num_images(const WIMStruct *wim);
1575 * Returns the part number of a WIM in a split WIM and the total number of parts
1579 * Pointer to the ::WIMStruct for a WIM file.
1580 * @param total_parts_ret
1581 * If non-@c NULL, the total number of parts in the split WIM (1 for
1582 * non-split WIMs) is written to this location.
1585 * The part number of the WIM (1 for non-split WIMs)
1588 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1591 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1592 * re-entrant. If you are calling wimlib functions concurrently in different
1593 * threads, then you must call this function serially first.
1595 * Since wimlib 1.3.0, you must call this function if the character encoding of
1596 * the current locale is not UTF-8 and you do not want wimlib to assume a UTF-8
1599 * Since wimlib 1.3.2, you must call this function if using the Windows-native
1600 * build of the library so that certain functions can be dynamically loaded from
1603 * Since wimlib 1.3.3, this function takes the @a init_flags parameter.
1606 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume that all input
1607 * data, including filenames, are in UTF-8, and that UTF-8 data can be
1608 * directly printed to the console.
1610 * @return 0; other error codes may be returned in future releases.
1613 wimlib_global_init(int init_flags);
1616 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1617 * You are not required to call this function, but it will release any global
1618 * memory allocated by the library.
1621 wimlib_global_cleanup();
1624 * Returns true if the WIM has an integrity table.
1627 * Pointer to the ::WIMStruct for a WIM file.
1629 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1630 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1631 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1632 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1635 wimlib_has_integrity_table(const WIMStruct *wim);
1638 * Determines if an image name is already used by some image in the WIM.
1641 * Pointer to the ::WIMStruct for a WIM file.
1643 * The name to check.
1646 * @c true if there is already an image in @a wim named @a name; @c false
1647 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1648 * the empty string, @c false is returned.
1651 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1654 * Joins a split WIM into a stand-alone one-part WIM.
1657 * An array of strings that gives the filenames of all parts of the split
1658 * WIM. No specific order is required, but all parts must be included with
1661 * Number of filenames in @a swms.
1662 * @param swm_open_flags
1663 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1664 * part should be verified, if integrity tables are present. Otherwise,
1666 * @param wim_write_flags
1667 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1668 * @param output_path
1669 * The path to write the one-part WIM to.
1670 * @param progress_func
1671 * If non-NULL, a function that will be called periodically with the
1672 * progress of the current operation.
1674 * @return 0 on success; nonzero on error. This function may return any value
1675 * returned by wimlib_open_wim() and wimlib_write() except
1676 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1678 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1679 * The split WIMs do not form a valid WIM because they do not include all
1680 * the parts of the original WIM, there are duplicate parts, or not all the
1681 * parts have the same GUID and compression type.
1683 * Note: the WIM's uncompressed and compressed resources are not checksummed
1684 * when they are copied from the split WIM parts to the joined WIM, nor are
1685 * compressed resources re-compressed.
1687 * Note: wimlib_export_image() can provide similar functionality to
1688 * wimlib_join(), since it is possible to export all images from a split WIM.
1691 wimlib_join(const wimlib_tchar * const *swms,
1693 const wimlib_tchar *output_path,
1695 int wim_write_flags,
1696 wimlib_progress_func_t progress_func);
1699 * Compress a chunk of a WIM resource using LZX compression.
1701 * This function is exported for convenience only and need not be used.
1704 * Uncompressed data of the chunk.
1706 * Size of the uncompressed chunk, in bytes.
1708 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1711 * The size of the compressed data written to @a out in bytes, or 0 if the
1712 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1714 * As a special requirement, the compression code is optimized for the WIM
1715 * format and therefore requires (@a chunk_size <= 32768).
1718 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1721 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1723 * Note that this will NOT work unmodified for LZX as used in the cabinet
1724 * format, which is not the same as in the WIM format!
1726 * This function is exported for convenience only and need not be used.
1728 * @param compressed_data
1729 * Pointer to the compressed data.
1731 * @param compressed_len
1732 * Length of the compressed data, in bytes.
1734 * @param uncompressed_data
1735 * Pointer to the buffer into which to write the uncompressed data.
1737 * @param uncompressed_len
1738 * Length of the uncompressed data. It must be 32768 bytes or less.
1741 * 0 on success; non-zero on failure.
1744 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1745 void *uncompressed_data, unsigned uncompressed_len);
1749 * Mounts an image in a WIM file on a directory read-only or read-write.
1751 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1752 * process shall be daemonized.
1754 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1755 * modifications to the WIM are staged in a temporary directory.
1757 * It is safe to mount multiple images from the same WIM file read-only at the
1758 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1759 * to mount multiple images from the same WIM file read-write at the same time.
1761 * wimlib_mount_image() cannot be used on an image that was exported with
1762 * wimlib_export_image() while the dentry trees for both images are still in
1763 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1764 * that has just been added with wimlib_add_image(), unless the WIM has been
1765 * written and read into a new ::WIMStruct.
1768 * Pointer to the ::WIMStruct containing the image to be mounted.
1770 * The number of the image to mount, indexed starting from it. It must be
1771 * an existing, single image.
1773 * The path to an existing empty directory to mount the image on.
1774 * @param mount_flags
1775 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1777 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1778 * rather than the default of read-only.
1780 * WIMs may contain named (alternate) data streams, which are a somewhat
1781 * obscure NTFS feature. They can be read and written on a mounted WIM
1782 * through one of several interfaces. The interface to use if specified by
1783 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1784 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1785 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1786 * the XATTR interface.
1787 * @param additional_swms
1788 * Array of pointers to the ::WIMStruct for each additional part in the
1789 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1790 * need to be in any particular order, but they must include all parts of
1791 * the split WIM other than the first part, which must be provided in the
1793 * @param num_additional_swms
1794 * Number of additional WIM parts provided in the @a additional_swms array.
1795 * This number should be one less than the total number of parts in the
1796 * split WIM. Set to 0 if the WIM is a standalone WIM.
1797 * @param staging_dir
1798 * If non-NULL, the name of a directory in which the staging directory will
1799 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1800 * in @a mount_flags. If left @c NULL, the staging directory is created in
1801 * the same directory as the WIM file that @a wim was originally read from.
1803 * @return 0 on success; nonzero on error.
1805 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1806 * A read-write mount was requested, but an an exclusive advisory lock on
1807 * the on-disk WIM file could not be acquired because another thread or
1808 * process has mounted an image from the WIM read-write or is currently
1809 * modifying the WIM in-place.
1810 * @retval ::WIMLIB_ERR_DECOMPRESSION
1811 * Could not decompress the metadata resource for @a image in @a wim.
1812 * @retval ::WIMLIB_ERR_FUSE
1813 * A non-zero status was returned by @c fuse_main().
1814 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1815 * A directory entry in the metadata resource for @a image in @a wim is
1817 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1818 * @a image does not specify an existing, single image in @a wim.
1819 * @retval ::WIMLIB_ERR_INVALID_PARAM
1820 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1821 * wimlib_export_image(), or @a image has been added with
1822 * wimlib_add_image().
1823 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1824 * The metadata resource for @a image in @a wim is invalid.
1825 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1826 * The security data for @a image in @a wim is invalid.
1827 * @retval ::WIMLIB_ERR_MKDIR
1828 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1829 * staging directory could not be created.
1830 * @retval ::WIMLIB_ERR_NOMEM
1831 * Failed to allocate needed memory.
1832 * @retval ::WIMLIB_ERR_NOTDIR
1833 * Could not determine the current working directory.
1834 * @retval ::WIMLIB_ERR_READ
1835 * An unexpected end-of-file or read error occurred when trying to read
1836 * data from the WIM file associated with @a wim.
1837 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1838 * The WIM is a split WIM, but the parts specified do not form a complete
1839 * split WIM because they do not include all the parts of the original WIM,
1840 * there are duplicate parts, or not all the parts have the same GUID and
1842 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1843 * The WIM is a split WIM and a read-write mount was requested. We only
1844 * support mounting a split WIM read-only.
1847 wimlib_mount_image(WIMStruct *wim,
1849 const wimlib_tchar *dir,
1851 WIMStruct **additional_swms,
1852 unsigned num_additional_swms,
1853 const wimlib_tchar *staging_dir);
1856 * Opens a WIM file and creates a ::WIMStruct for it.
1859 * The path to the WIM file to open.
1861 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1862 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1864 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1865 * the WIM, if it exists, is checked, and this function will fail with an
1866 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1867 * digests of the WIM do not exactly match the corresponding message
1868 * digests given in the integrity table.
1870 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1871 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1872 * returned. (This flag may be removed in the future, in which case no
1873 * error will be issued when opening a split WIM.)
1875 * @param progress_func
1876 * If non-NULL, a function that will be called periodically with the
1877 * progress of the current operation.
1880 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1881 * is written to the memory location pointed to by this parameter. The
1882 * ::WIMStruct must be freed using using wimlib_free() when finished with
1885 * @return 0 on success; nonzero on error.
1886 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1887 * The lookup table of @a wim_file is compressed. Support for this can be
1888 * added to wimlib if needed, but it appears to be the case that the lookup
1889 * table is never compressed.
1890 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1891 * The WIM is not the non-first part of a split WIM, and the number of
1892 * metadata resources found in the WIM did not match the image count given
1893 * in the WIM header, or the number of <IMAGE> elements in the XML
1894 * data for the WIM did not match the image count given in the WIM header.
1895 * @retval ::WIMLIB_ERR_INTEGRITY
1896 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1897 * wim_file contains an integrity table, but the SHA1 message digest for a
1898 * chunk of the WIM does not match the corresponding message digest given
1899 * in the integrity table.
1900 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1901 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1902 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1903 * The header of @a wim_file says that resources in the WIM are compressed,
1904 * but the header flag indicating LZX or XPRESS compression is not set.
1905 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1906 * The length field of the WIM header is not 208.
1907 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1908 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1909 * wim_file contains an integrity table, but the integrity table is
1911 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1912 * The lookup table for the WIM contained duplicate entries that are not
1913 * for metadata resources, or it contained an entry with a SHA1 message
1914 * digest of all 0's.
1915 * @retval ::WIMLIB_ERR_NOMEM
1916 * Failed to allocated needed memory.
1917 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1918 * @a wim_file does not begin with the expected magic characters.
1919 * @retval ::WIMLIB_ERR_OPEN
1920 * Failed to open the file @a wim_file for reading.
1921 * @retval ::WIMLIB_ERR_READ
1922 * An unexpected end-of-file or read error occurred when trying to read
1923 * data from @a wim_file.
1924 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1925 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1926 * specified in @a open_flags.
1927 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1928 * A number other than 0x10d00 is written in the version field of the WIM
1929 * header of @a wim_file. (Probably a pre-Vista WIM).
1930 * @retval ::WIMLIB_ERR_XML
1931 * The XML data for @a wim_file is invalid.
1934 wimlib_open_wim(const wimlib_tchar *wim_file,
1936 WIMStruct **wim_ret,
1937 wimlib_progress_func_t progress_func);
1940 * Overwrites the file that the WIM was originally read from, with changes made.
1941 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1942 * rather than wimlib_create_new_wim().
1944 * There are two ways that a WIM may be overwritten. The first is to do a full
1945 * rebuild. In this mode, the new WIM is written to a temporary file and then
1946 * renamed to the original file after it is has been completely written. The
1947 * temporary file is made in the same directory as the original WIM file. A
1948 * full rebuild may take a while, but can be used even if images have been
1949 * modified or deleted, will produce a WIM with no holes, and has little chance
1950 * of unintentional data loss because the temporary WIM is fsync()ed before
1951 * being renamed to the original WIM.
1953 * The second way to overwrite a WIM is by appending to the end of it and
1954 * overwriting the header. This can be much faster than a full rebuild, but it
1955 * only works if the only operations on the WIM have been to change the header
1956 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1957 * with writing any new file resources *after* everything in the old WIM, even
1958 * though this will leave a hole where the old lookup table, XML data, and
1959 * integrity were. This is done so that the WIM remains valid even if the
1960 * operation is aborted mid-write. The WIM header is only overwritten at the
1961 * very last moment, and up until that point the WIM will be seen as the old
1964 * By default, the overwrite mode is determine automatically based on the past
1965 * operations performed on the ::WIMStruct. Use the flag
1966 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1967 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1968 * images have been deleted from the WIM.
1970 * In the temporary-file overwrite mode, no changes are made to the WIM on
1971 * failure, and the temporary file is deleted if possible. Abnormal termination
1972 * of the program will result in the temporary file being orphaned. In the
1973 * direct append mode, the WIM is truncated to the original length on failure;
1974 * and while abnormal termination of the program will result in extra data
1975 * appended to the original WIM, it should still be a valid WIM.
1978 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1979 * been in-memory changes made to it, which are then reflected in the
1981 * @param write_flags
1982 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1983 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1984 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1985 * @param num_threads
1986 * Number of threads to use for compression (see wimlib_write()).
1987 * @param progress_func
1988 * If non-NULL, a function that will be called periodically with the
1989 * progress of the current operation.
1991 * @return 0 on success; nonzero on error. This function may return any value
1992 * returned by wimlib_write() as well as the following error codes:
1993 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1994 * The WIM was going to be modifien in-place (with no temporary file), but
1995 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1996 * because another thread or process has mounted an image from the WIM
1997 * read-write or is currently modifying the WIM in-place.
1998 * @retval ::WIMLIB_ERR_NO_FILENAME
1999 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2000 * than a WIM read with wimlib_open_wim().
2001 * @retval ::WIMLIB_ERR_RENAME
2002 * The temporary file that the WIM was written to could not be renamed to
2003 * the original filename of @a wim.
2004 * @retval ::WIMLIB_ERR_REOPEN
2005 * The WIM was overwritten successfully, but it could not be re-opened
2006 * read-only. Therefore, the resources in the WIM can no longer be
2007 * accessed, so this limits the functions that can be called on @a wim
2008 * before calling wimlib_free().
2011 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2012 wimlib_progress_func_t progress_func);
2015 * Prints information about one image, or all images, contained in a WIM.
2018 * Pointer to the ::WIMStruct for a WIM file.
2020 * The image about which to print information. Can be the number of an
2021 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2024 * @return This function has no return value. No error checking is done when
2025 * printing the information. If @a image is invalid, an error message is
2029 wimlib_print_available_images(const WIMStruct *wim, int image);
2032 * Prints the full paths to all files contained in an image, or all images, in a
2036 * Pointer to the ::WIMStruct for a WIM file.
2038 * Which image to print files for. Can be the number of an image, or
2039 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2041 * @return 0 on success; nonzero on error.
2042 * @retval ::WIMLIB_ERR_DECOMPRESSION
2043 * The metadata resource for one of the specified images could not be
2045 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2046 * A directory entry in the metadata resource for one of the specified
2047 * images is invaled.
2048 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2049 * @a image does not specify a valid image in @a wim, and is not
2050 * ::WIMLIB_ALL_IMAGES.
2051 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2052 * The metadata resource for one of the specified images is invalid.
2053 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2054 * The security data for one of the specified images is invalid.
2055 * @retval ::WIMLIB_ERR_NOMEM
2056 * Failed to allocate needed memory.
2057 * @retval ::WIMLIB_ERR_READ
2058 * An unexpected read error or end-of-file occurred when reading the
2059 * metadata resource for one of the specified images.
2060 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2061 * @a wim was not a standalone WIM and was not the first part of a split
2065 wimlib_print_files(WIMStruct *wim, int image);
2068 * Prints detailed information from the header of a WIM file.
2071 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2072 * standalone WIM or part of a split WIM.
2074 * @return This function has no return value.
2078 wimlib_print_header(const WIMStruct *wim);
2081 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2082 * digests, as found in the directory entry tree in the WIM file, to file
2083 * resources in the WIM file. This table includes one entry for each unique
2084 * file in the WIM, so it can be quite long. There is only one lookup table per
2085 * WIM file, but each split WIM part has its own lookup table.
2088 * Pointer to the ::WIMStruct for a WIM file.
2090 * @return This function has no return value.
2093 wimlib_print_lookup_table(WIMStruct *wim);
2096 * Prints the metadata of the specified image in a WIM file. The metadata
2097 * consists of the security data as well as the directory entry tree. Each
2098 * image has its own metadata.
2101 * Pointer to the ::WIMStruct for a WIM file.
2103 * Which image to print the metadata for. Can be the number of an image,
2104 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2106 * @return 0 on success; nonzero on error.
2107 * @retval ::WIMLIB_ERR_DECOMPRESSION
2108 * The metadata resource for one of the specified images could not be
2110 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2111 * A directory entry in the metadata resource for one of the specified
2112 * images is invaled.
2113 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2114 * @a image does not specify a valid image in @a wim, and is not
2115 * ::WIMLIB_ALL_IMAGES.
2116 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2117 * The metadata resource for one of the specified images is invalid.
2118 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2119 * The security data for one of the specified images is invalid.
2120 * @retval ::WIMLIB_ERR_NOMEM
2121 * Failed to allocate needed memory.
2122 * @retval ::WIMLIB_ERR_READ
2123 * An unexpected read error or end-of-file occurred when reading the
2124 * metadata resource for one of the specified images.
2125 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2126 * @a wim was not a standalone WIM and was not the first part of a split
2130 wimlib_print_metadata(WIMStruct *wim, int image);
2133 * Prints some basic information about a WIM file. All information printed by
2134 * this function is also printed by wimlib_print_header(), but
2135 * wimlib_print_wim_information() prints some of this information more concisely
2136 * and in a more readable form.
2139 * Pointer to the ::WIMStruct for a WIM file.
2141 * @return This function has no return value.
2144 wimlib_print_wim_information(const WIMStruct *wim);
2147 * Translates a string specifying the name or number of an image in the WIM into
2148 * the number of the image. The images are numbered starting at 1.
2151 * Pointer to the ::WIMStruct for a WIM file.
2152 * @param image_name_or_num
2153 * A string specifying the name or number of an image in the WIM. If it
2154 * parses to a positive integer, this integer is taken to specify the
2155 * number of the image, indexed starting at 1. Otherwise, it is taken to
2156 * be the name of an image, as given in the XML data for the WIM file. It
2157 * also may be the keyword "all" or the string "*", both of which will
2158 * resolve to ::WIMLIB_ALL_IMAGES.
2160 * There is no way to search for an image actually named "all", "*", or an
2161 * integer number, or an image that has no name. However, you can use
2162 * wimlib_get_image_name() to get the name of any image.
2165 * If the string resolved to a single existing image, the number of that
2166 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2167 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2168 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2169 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2170 * images in @a wim has no name.
2173 wimlib_resolve_image(WIMStruct *wim,
2174 const wimlib_tchar *image_name_or_num);
2177 * Sets which image in the WIM is marked as bootable.
2180 * Pointer to the ::WIMStruct for a WIM file.
2182 * The number of the image to mark as bootable, or 0 to mark no image as
2184 * @return 0 on success; nonzero on error.
2185 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2186 * @a boot_idx does not specify an existing image in @a wim, and it was not
2188 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2189 * @a wim is part of a split WIM. We do not support changing the boot
2190 * index of a split WIM.
2193 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2196 * Changes the description of an image in the WIM.
2199 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2200 * standalone WIM or part of a split WIM; however, you should set the same
2201 * description on all parts of a split WIM.
2203 * The number of the image for which to change the description.
2204 * @param description
2205 * The new description to give the image. It may be @c NULL, which
2206 * indicates that the image is to be given no description.
2208 * @return 0 on success; nonzero on error.
2209 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2210 * @a image does not specify a single existing image in @a wim.
2211 * @retval ::WIMLIB_ERR_NOMEM
2212 * Failed to allocate the memory needed to duplicate the @a description
2216 wimlib_set_image_descripton(WIMStruct *wim, int image,
2217 const wimlib_tchar *description);
2220 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2221 * (something like "Core" or "Ultimate")
2224 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2225 * standalone WIM or part of a split WIM; however, you should set the same
2226 * \<FLAGS\> element on all parts of a split WIM.
2228 * The number of the image for which to change the description.
2230 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2231 * indicates that the image is to be given no \<FLAGS\> element.
2233 * @return 0 on success; nonzero on error.
2234 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2235 * @a image does not specify a single existing image in @a wim.
2236 * @retval ::WIMLIB_ERR_NOMEM
2237 * Failed to allocate the memory needed to duplicate the @a flags string.
2239 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2240 const wimlib_tchar *flags);
2243 * Changes the name of an image in the WIM.
2246 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2247 * standalone WIM or part of a split WIM; however, you should set the same
2248 * name on all parts of a split WIM.
2250 * The number of the image for which to change the name.
2252 * The new name to give the image. It must be a nonempty string.
2254 * @return 0 on success; nonzero on error.
2255 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2256 * There is already an image named @a name in @a wim.
2257 * @retval ::WIMLIB_ERR_INVALID_PARAM
2258 * @a name was @c NULL or the empty string.
2259 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2260 * @a image does not specify a single existing image in @a wim.
2261 * @retval ::WIMLIB_ERR_NOMEM
2262 * Failed to allocate the memory needed to duplicate the @a name string.
2264 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2265 const wimlib_tchar *name);
2268 * Set the functions that wimlib uses to allocate and free memory.
2270 * These settings are global and not per-WIM.
2272 * The default is to use the default @c malloc() and @c free() from the C
2275 * Please note that some external functions, such as those in @c libntfs-3g, may
2276 * use the standard memory allocation functions.
2278 * @param malloc_func
2279 * A function equivalent to @c malloc() that wimlib will use to allocate
2280 * memory. If @c NULL, the allocator function is set back to the default
2281 * @c malloc() from the C library.
2283 * A function equivalent to @c free() that wimlib will use to free memory.
2284 * If @c NULL, the free function is set back to the default @c free() from
2286 * @param realloc_func
2287 * A function equivalent to @c realloc() that wimlib will use to reallocate
2288 * memory. If @c NULL, the free function is set back to the default @c
2289 * realloc() from the C library.
2290 * @return 0 on success; nonzero on error.
2291 * @retval ::WIMLIB_ERR_UNSUPPORTED
2292 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2293 * so custom memory allocators are unsupported.
2296 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2297 void (*free_func)(void *),
2298 void *(*realloc_func)(void *, size_t));
2301 * Sets whether wimlib is to print error messages to @c stderr when a function
2302 * fails. These error messages may provide information that cannot be
2303 * determined only from the error code that is returned. Not every error will
2304 * result in an error message being printed.
2306 * This setting is global and not per-WIM.
2308 * By default, error messages are not printed.
2310 * @param show_messages
2311 * @c true if error messages are to be printed; @c false if error messages
2312 * are not to be printed.
2314 * @return 0 on success; nonzero on error.
2315 * @retval ::WIMLIB_ERR_UNSUPPORTED
2316 * @a show_messages was @c true, but wimlib was compiled with the @c
2317 * --without-error-messages option. Therefore, error messages cannot be
2321 wimlib_set_print_errors(bool show_messages);
2324 * Splits a WIM into multiple parts.
2327 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2330 * Name of the SWM file to create. This will be the name of the first
2331 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2332 * appended before the suffix.
2334 * The maximum size per part, in bytes. It is not guaranteed that this
2335 * will really be the maximum size per part, because some file resources in
2336 * the WIM may be larger than this size, and the WIM file format provides
2337 * no way to split up file resources among multiple WIMs.
2338 * @param write_flags
2339 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2340 * included in the split WIM parts.
2341 * @param progress_func
2342 * If non-NULL, a function that will be called periodically with the
2343 * progress of the current operation.
2345 * @return 0 on success; nonzero on error. This function may return any value
2346 * returned by wimlib_write() as well as the following error codes:
2348 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2349 * @a wim is not part 1 of a stand-alone WIM.
2350 * @retval ::WIMLIB_ERR_INVALID_PARAM
2351 * @a swm_name was @c NULL, or @a part_size was 0.
2353 * Note: the WIM's uncompressed and compressed resources are not checksummed
2354 * when they are copied from the joined WIM to the split WIM parts, nor are
2355 * compressed resources re-compressed.
2358 wimlib_split(WIMStruct *wim,
2359 const wimlib_tchar *swm_name,
2362 wimlib_progress_func_t progress_func);
2365 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2367 * The image to unmount is specified by the path to the mountpoint, not the
2368 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2369 * touched and also may have been allocated in a different process.
2371 * To unmount the image, the thread calling this function communicates with the
2372 * thread that is managing the mounted WIM image. This function blocks until it
2373 * is known whether the unmount succeeded or failed. In the case of a
2374 * read-write mounted WIM, the unmount is not considered to have succeeded until
2375 * all changes have been saved to the underlying WIM file.
2378 * The directory that the WIM image was mounted on.
2379 * @param unmount_flags
2380 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2381 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2382 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2384 * @param progress_func
2385 * If non-NULL, a function that will be called periodically with the
2386 * progress of the current operation.
2388 * @return 0 on success; nonzero on error.
2390 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2391 * The filesystem daemon was unable to remove the staging directory and the
2392 * temporary files that it contains.
2393 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2394 * The filesystem daemon appears to have terminated before sending an exit
2396 * @retval ::WIMLIB_ERR_FORK
2397 * Could not @c fork() the process.
2398 * @retval ::WIMLIB_ERR_FUSERMOUNT
2399 * The @b fusermount program could not be executed or exited with a failure
2401 * @retval ::WIMLIB_ERR_MQUEUE
2402 * Could not open a POSIX message queue to communicate with the filesystem
2403 * daemon servicing the mounted filesystem, could not send a message
2404 * through the queue, or could not receive a message through the queue.
2405 * @retval ::WIMLIB_ERR_NOMEM
2406 * Failed to allocate needed memory.
2407 * @retval ::WIMLIB_ERR_OPEN
2408 * The filesystem daemon could not open a temporary file for writing the
2410 * @retval ::WIMLIB_ERR_READ
2411 * A read error occurred when the filesystem daemon tried to a file from
2412 * the staging directory
2413 * @retval ::WIMLIB_ERR_RENAME
2414 * The filesystem daemon failed to rename the newly written WIM file to the
2415 * original WIM file.
2416 * @retval ::WIMLIB_ERR_WRITE
2417 * A write error occurred when the filesystem daemon was writing to the new
2418 * WIM file, or the filesystem daemon was unable to flush changes that had
2419 * been made to files in the staging directory.
2422 wimlib_unmount_image(const wimlib_tchar *dir,
2424 wimlib_progress_func_t progress_func);
2427 * Writes a standalone WIM to a file.
2429 * This brings in resources from any external locations, such as directory trees
2430 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2431 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2434 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2435 * changes made to it, which are then reflected in the output file.
2437 * The path to the file to write the WIM to.
2439 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2441 * @param write_flags
2442 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2443 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2444 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2445 * @param num_threads
2446 * Number of threads to use for compressing data. If 0, the number of
2447 * threads is taken to be the number of online processors. Note: if no
2448 * data compression needs to be done, no additional threads will be created
2449 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2450 * exporting an image from a compressed WIM to another WIM of the same
2451 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2453 * @param progress_func
2454 * If non-NULL, a function that will be called periodically with the
2455 * progress of the current operation.
2457 * @return 0 on success; nonzero on error.
2458 * @retval ::WIMLIB_ERR_DECOMPRESSION
2459 * Failed to decompress a metadata or file resource in @a wim.
2460 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2461 * A directory entry in the metadata resource for @a image in @a wim is
2463 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2464 * @a image does not specify a single existing image in @a wim, and is not
2465 * ::WIMLIB_ALL_IMAGES.
2466 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2467 * A file that had previously been scanned for inclusion in the WIM by
2468 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2469 * message digest check.
2470 * @retval ::WIMLIB_ERR_INVALID_PARAM
2471 * @a path was @c NULL.
2472 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2473 * The metadata resource for @a image in @a wim is invalid.
2474 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2475 * The security data for @a image in @a wim is invalid.
2476 * @retval ::WIMLIB_ERR_NOMEM
2477 * Failed to allocate needed memory.
2478 * @retval ::WIMLIB_ERR_OPEN
2479 * Failed to open @a path for writing, or some file resources in @a
2480 * wim refer to files in the outside filesystem, and one of these files
2481 * could not be opened for reading.
2482 * @retval ::WIMLIB_ERR_READ
2483 * An error occurred when trying to read data from the WIM file associated
2484 * with @a wim, or some file resources in @a wim refer to files in the
2485 * outside filesystem, and a read error occurred when reading one of these
2487 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2488 * @a wim is part of a split WIM. You may not call this function on a
2490 * @retval ::WIMLIB_ERR_WRITE
2491 * An error occurred when trying to write data to the new WIM file at @a
2495 wimlib_write(WIMStruct *wim,
2496 const wimlib_tchar *path,
2499 unsigned num_threads,
2500 wimlib_progress_func_t progress_func);
2503 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2504 * the data using "XPRESS" compression.
2507 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2510 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2511 * the data is compressed using "XPRESS" compression.
2514 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2515 void *uncompressed_data, unsigned uncompressed_len);
2517 #endif /* _WIMLIB_H */