73f5c32af31404fcc3bed7a1cf7c016348d11ea8
[wimlib] / src / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  */
6
7 /* 
8  * Copyright (C) 2012 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU Lesser General Public License as published by the Free
14  * Software Foundation; either version 2.1 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 /** \mainpage
27  *
28  * \section intro Introduction
29  *
30  * wimlib is a C library to read, write, and mount archive files in the Windows
31  * Imaging Format (WIM files).  These files are normally created using the @c
32  * imagex.exe utility on Windows, but this library provides a free
33  * implementetion of @c imagex for UNIX-based systems and an API to allow other
34  * programs to read, write, and mount WIM files.  wimlib is comparable to
35  * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
36  * 
37  * The main intended use of wimlib is to create customized images of Windows PE,
38  * the Windows Preinstallation Environment, without having to rely on Windows.
39  * Windows PE, which is the operating system that runs when you boot from the
40  * Windows Vista or Windows 7 DVD, is a lightweight version of Windows that can
41  * run entirely from memory. It can be used to install Windows from local media
42  * or a network drive or perform maintenance. 
43  * 
44  * You can find Windows PE on the installation media for Windows Vista, Windows
45  * 7, and Windows 8.  The Windows PE image itself is a WIM file, @c
46  * sources/boot.wim, on the ISO filesystem.  Windows PE can also be found in the
47  * Windows Automated Installation Kit (WAIK) inside the @c WinPE.cab file, which
48  * you can extract if you install the @c cabextract program.
49  *
50  * \section format WIM files
51  *
52  * A <b>Windows Imaging (WIM)</b> file is an archive.  Like some other archive
53  * formats such as ZIP, files in WIM archives may be compressed.  WIM archives
54  * support two Microsoft-specific compression formats:  @b LZX and @b XPRESS.
55  * Both are based on LZ77 and Huffman encoding, and both are supported by
56  * wimlib.
57  *
58  * Unlike ZIP files, WIM files can contain multiple independent toplevel
59  * directory trees known as @a images.  While each image has its own metadata,
60  * files are not duplicated for each image; instead, each file is included only
61  * once in the entire WIM. Microsoft did this so that in one WIM file, they
62  * could do things like have 5 different versions of Windows that are almost
63  * exactly the same.
64  *
65  * WIM files may contain a integrity table.  The integrity table, if it exists,
66  * is located at the end of the WIM file and contains SHA1 message digests of
67  * 10MB chunks of the WIM.
68  *
69  * Microsoft provides documentation for the WIM file format, XPRESS compression
70  * format, and LZX compression format.  However, there are errors and omissions
71  * in some places in their documentation.
72  *
73  * \section starting Getting Started
74  *
75  * wimlib uses the GNU autotools, so it should be easy to install with
76  * <code>configure && make && sudo make install</code>, provided that you have
77  * @c libxml2 and @c libfuse installed.  To use wimlib in a program after
78  * installing it, include @c wimlib.h and link your program with @c -lwim.
79  *
80  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.
81  *
82  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
83  * return an integer error code on failure.  Use wimlib_get_error_string() to
84  * get a string that describes an error code.  wimlib also can print error
85  * messages itself when an error happens, and these may be more informative than
86  * the error code; to enable this, call wimlib_set_print_errors().
87  *
88  * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
89  * following exceptions:  wimlib_set_print_errors() and
90  * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
91  * used by one ::WIMStruct at a time.
92  *
93  * To open an existing WIM, use wimlib_open_wim().
94  *
95  * To create a new WIM that initially contains no images, use
96  * wimlib_create_new_wim().
97  *
98  * To add an image to a WIM file from a directory tree on your filesystem, call
99  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
100  * wimlib_open_wim() or from wimlib_create_new_wim().
101  *
102  * To extract an image from a WIM file, call wimlib_set_output_dir() to set the
103  * output directory, then call wimlib_extract_image().
104  *
105  * wimlib supports mounting WIM files either read-only or read-write.  Mounting
106  * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
107  * Mounting can be done without root privileges because it is implemented using
108  * FUSE (Filesystem in Userspace).  If wimlib is compiled with the
109  * <code>--without-fuse</code> flag, these functions will be available but will
110  * fail.
111  *
112  * After creating or modifying a WIM file, you can write it to a file using
113  * wimlib_write().  Alternatively,  if the WIM was originally read from a file,
114  * you can use wimlib_overwrite() to overwrite the original file.  In some
115  * cases, wimlib_overwrite_xml_and_header() can be used instead.
116  *
117  * After you are done with the WIM file, use wimlib_free() to free all memory
118  * associated with a ::WIMStruct and close all files associated with it.
119  *
120  * To see an example of how to use wimlib, see the file
121  * @c programs/imagex.c in wimlib's source tree.
122  *
123  * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
124  * for this.
125  *
126  * \section imagex imagex
127  *
128  * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
129  *
130  * \section mkwinpeimg mkwinpeimg
131  * 
132  * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
133  * page.
134  *
135  * \section Limitations
136  *
137  * While wimlib supports the main features of WIM files, wimlib currently has
138  * the following limitations:
139  * - wimlib does not support modifying or creating "security data", which
140  *   describes the access rights of the files in the WIM.  This data is very
141  *   Windows-specific, and it would be difficult to do anything with it.
142  *   Microsoft's software can still read a WIM without security data, including
143  *   a boot.wim for Windows PE, but <b>do not expect to be able to use wimlib to
144  *   image a Windows installation and preserve file attributes</b>.  However, by
145  *   default, wimlib will preserve security data for existing WIMs.
146  * - There is no way to directly extract or mount split WIMs.
147  * - There is not yet any code to verify that there are no collisions between
148  *   different files that happen to have the same SHA1 message digest.
149  *   This is extremely unlikely, but could result in something bad such as a
150  *   file going missing.
151  * - Alternate stream entries for directory entries are ignored.
152  * - Different versions of the WIM file format, if they even exist, are
153  *   unsupported.  Let me know if you notice WIM files with a different version.
154  * - Chunk sizes other than 32768 are unsupported (except for uncompressed WIMs,
155  *   for which the chunk size field is ignored).  As far as I can tell, other
156  *   chunk sizes are not used in compressed WIMs.  Let me know if you find a WIM
157  *   file with a different chunk size.
158  * - wimlib does not provide a clone of the @b PEImg tool that allows you to
159  *   make certain Windows-specific modifications to a Windows PE image, such as
160  *   adding a driver or Windows component.  Such a tool could conceivably be
161  *   implemented on top of wimlib, although it likely would be hard to implement
162  *   because it would have to do very Windows-specific things such as
163  *   manipulating the driver store.  wimlib does provide the @b mkwinpeimg
164  *   script for a similar purpose, however.  With regards to adding drivers to
165  *   Windows PE, you have the option of putting them anywhere in the Windows PE
166  *   image, then loading them after boot using @b drvload.exe.
167  * - There is not yet a way to extract specific files or directories from a WIM
168  *   file without mounting it, or to add, remove, or modify files in a WIM
169  *   without mounting it, other than by adding or removing an entire image.  I
170  *   can implement this if requested, but I intend the FUSE mount feature to be
171  *   used for this purpose, as it is easy to do these things in whatever way you
172  *   want after the image is mounted.
173  *
174  * Currently, Microsoft's @a image.exe can create slightly smaller WIM files
175  * than wimlib when using maximum (LZX) compression because it knows how to
176  * split up LZX compressed blocks, which is not yet implemented in wimlib.
177  *
178  * wimlib is experimental and likely contains bugs; use Microsoft's @a
179  * imagex.exe if you want to make sure your WIM files are made "correctly".
180  *
181  * \section legal License
182  *
183  * The wimlib library is licensed under the GNU Lesser General Public License
184  * version 2.1 or later.
185  *
186  * @b imagex and @b mkwinpeiso are licensed under the GNU General Public License
187  * version 3 or later.
188  */
189
190 #ifndef _WIMLIB_H
191 #define _WIMLIB_H
192
193 #include <stdio.h>
194 #include <stddef.h>
195 #include <stdbool.h>
196
197 #ifndef _WIMLIB_INTERNAL_H
198 /** 
199  * Opaque structure that represents a WIM file. 
200  */
201 typedef struct WIMStruct WIMStruct;
202 #endif
203
204 /** 
205  * Specifies the way in which identical files are linked when extracting
206  * image(s) from the WIM. 
207  */
208 enum wim_link_type {
209 /** Hard link identical files when extracting files from the WIM. */
210         WIM_LINK_TYPE_HARD = 0,
211 /** Symbolic link identical files when extracting files from the WIM. */
212         WIM_LINK_TYPE_SYMBOLIC = 1,
213 /** Do not create links when extracting identical files from the WIM (default).
214  * */
215         WIM_LINK_TYPE_NONE = 2,
216 };
217
218 /**
219  * Specifies the compression type of a WIM file.
220  */
221
222 enum wim_compression_type {
223         /** An invalid compression type. */
224         WIM_COMPRESSION_TYPE_INVALID = -1,
225
226         /** The WIM does not include any compressed resources. */
227         WIM_COMPRESSION_TYPE_NONE = 0,
228
229         /** Compressed resources in the WIM use LZX compression. */
230         WIM_COMPRESSION_TYPE_LZX = 1,
231
232         /** Compressed resources in the WIM use XPRESS compression. */
233         WIM_COMPRESSION_TYPE_XPRESS = 2,
234 };
235
236 /** Mount the WIM read-write. */
237 #define WIMLIB_MOUNT_FLAG_READWRITE             0x00000001
238
239 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
240 #define WIMLIB_MOUNT_FLAG_DEBUG                 0x00000002
241
242 /** Do not allow accessing alternate data streams. */
243 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000010
244
245 /** Access alternate data streams through extended file attributes.  This is the
246  * default mode. */
247 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000020
248
249 /** Access alternate data streams by specifying the file name, a colon, then the
250  * alternate file stream name. */
251 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000040
252
253 /** Include an integrity table in the new WIM being written during the unmount. 
254  * Ignored for read-only mounts. */
255 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY     0x00000001
256
257 /** Unless this flag is given, changes to a mounted WIM are discarded.  Ignored
258  * for read-only mounts. */
259 #define WIMLIB_UNMOUNT_FLAG_COMMIT              0x00000002
260
261 /** Include an integrity table in the new WIM file. */
262 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY       0x00000001
263
264 /** Print progress information when writing the integrity table. */
265 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS         0x00000002
266
267 /** Print file paths as we write then */
268 #define WIMLIB_WRITE_FLAG_VERBOSE               0x00000004
269
270 /** Mark the image being added as the bootable image of the WIM. */
271 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              0x00000001
272
273 /** Print the name of each file or directory as it is scanned to be included in
274  * the WIM image. */
275 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           0x00000002
276
277 /** Apply NTFS-specific information to the captured WIM image.  This flag can
278  * only be specified if the directory being captured is on a NTFS filesystem
279  * mounted with NTFS-3g, and wimlib was compiled with support for NTFS-3g  */
280 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              0x00000004
281
282 /** Follow symlinks; archive and dump the files they point to. */
283 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       0x00000008
284
285 /** See documentation for wimlib_export_image(). */
286 #define WIMLIB_EXPORT_FLAG_BOOT                 0x00000001
287
288 /** Verify the integrity of the WIM if an integrity table is present. */
289 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY        0x00000001
290
291 /** Print progress information when verifying integrity table. */
292 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS          0x00000002
293
294 /** If this flag is not given, an error is issued if the WIM is part of a split
295  * WIM.  */
296 #define WIMLIB_OPEN_FLAG_SPLIT_OK               0x00000004
297
298
299 /** When identical files are extracted from the WIM, hard link them together. */
300 #define WIMLIB_EXTRACT_FLAG_HARDLINK            0x00000001
301
302 /** When identical files are extracted from the WIM, symlink them together. */
303 #define WIMLIB_EXTRACT_FLAG_SYMLINK             0x00000002
304
305 /** Print the name of each file as it is extracted from the WIM image. */
306 #define WIMLIB_EXTRACT_FLAG_VERBOSE             0x00000008
307
308 /**
309  * Possible values of the error code returned by many functions in wimlib.
310  *
311  * See the documentation for each wimlib function to see specifically what error
312  * codes can be returned by a given function, and what they mean.
313  */
314 enum wimlib_error_code {
315         WIMLIB_ERR_SUCCESS = 0,
316         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
317         WIMLIB_ERR_DECOMPRESSION,
318         WIMLIB_ERR_DELETE_STAGING_DIR,
319         WIMLIB_ERR_FORK,
320         WIMLIB_ERR_FUSE,
321         WIMLIB_ERR_FUSERMOUNT,
322         WIMLIB_ERR_IMAGE_COUNT,
323         WIMLIB_ERR_IMAGE_NAME_COLLISION,
324         WIMLIB_ERR_INTEGRITY,
325         WIMLIB_ERR_INVALID_CHUNK_SIZE,
326         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
327         WIMLIB_ERR_INVALID_DENTRY,
328         WIMLIB_ERR_INVALID_HEADER_SIZE,
329         WIMLIB_ERR_INVALID_IMAGE,
330         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
331         WIMLIB_ERR_INVALID_PARAM,
332         WIMLIB_ERR_INVALID_RESOURCE_HASH,
333         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
334         WIMLIB_ERR_INVALID_SECURITY_DATA,
335         WIMLIB_ERR_LINK,
336         WIMLIB_ERR_MKDIR,
337         WIMLIB_ERR_MQUEUE,
338         WIMLIB_ERR_NOMEM,
339         WIMLIB_ERR_NOTDIR,
340         WIMLIB_ERR_NOT_A_WIM_FILE,
341         WIMLIB_ERR_NOT_ROOT,
342         WIMLIB_ERR_NO_FILENAME,
343         WIMLIB_ERR_NTFS_3G,
344         WIMLIB_ERR_OPEN,
345         WIMLIB_ERR_OPENDIR,
346         WIMLIB_ERR_READLINK,
347         WIMLIB_ERR_READ,
348         WIMLIB_ERR_RENAME,
349         WIMLIB_ERR_SPECIAL_FILE,
350         WIMLIB_ERR_SPLIT_INVALID,
351         WIMLIB_ERR_SPLIT_UNSUPPORTED,
352         WIMLIB_ERR_STAT,
353         WIMLIB_ERR_TIMEOUT,
354         WIMLIB_ERR_UNKNOWN_VERSION,
355         WIMLIB_ERR_UNSUPPORTED,
356         WIMLIB_ERR_WRITE,
357         WIMLIB_ERR_XML,
358 };
359
360
361 /** Used to indicate that no WIM image is currently selected. */
362 #define WIM_NO_IMAGE    0
363
364 /** Used to specify all images in the WIM. */
365 #define WIM_ALL_IMAGES  (-1)
366
367
368 /**
369  * Adds an image to a WIM file from a directory tree on disk.
370  *
371  * The directory tree is read immediately for the purpose of constructing a
372  * directory entry tree in-memory.  Also, all files are read to calculate their
373  * SHA1 message digests.  However, because the directory tree may contain a very
374  * large amount of data, the files themselves are not read into memory
375  * permanently, and instead references to their paths saved.  This means that
376  * the directory tree must not be modified, other than by adding entirely new
377  * files or directories, before executing a call to wimlib_write() or
378  * wimlib_overwrite(). Otherwise, wimlib_write() may fail or incorrect files may
379  * be included in the WIM written by wimlib_write().
380  *
381  * @param wim
382  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
383  *      added.
384  * @param dir
385  *      A path to a directory in the outside filesystem.  It will become the
386  *      root directory for the WIM image.
387  * @param name
388  *      The name to give the image.  This must be non-@c NULL.
389  * @param description
390  *      The description to give the image.  This parameter may be left @c
391  *      NULL, in which case no description is given to the image.
392  * @param flags_element
393  *      What to put in the &lt;FLAGS&gt; element for the image's XML data.  This
394  *      parameter may be left @c NULL, in which case no &lt;FLAGS&gt; element is
395  *      given to the image.
396  * @param flags
397  *      If set to ::WIMLIB_ADD_IMAGE_FLAG_BOOT, change the image in @a wim
398  *      marked as bootable to the one being added. Otherwise, leave the boot
399  *      index unchanged.
400  *
401  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
402  * discarded so that it appears to be in the same state as when this function
403  * was called.
404  *
405  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION 
406  *      There is already an image named @a name in @a w.
407  * @retval ::WIMLIB_ERR_INVALID_PARAM 
408  *      @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
409  * @retval ::WIMLIB_ERR_NOMEM
410  *      Failed to allocate needed memory.
411  * @retval ::WIMLIB_ERR_NOTDIR
412  *      @a dir is not a directory.
413  * @retval ::WIMLIB_ERR_OPEN
414  *      Failed to open a file or directory in the directory tree rooted at @a
415  *      dir.
416  * @retval ::WIMLIB_ERR_READ
417  *      Failed to read a file in the directory tree rooted at @a dir.
418  * @retval ::WIMLIB_ERR_STAT
419  *      Failed obtain the metadata for a file or directory in the directory tree
420  *      rooted at @a dir.
421  *
422  */
423 extern int wimlib_add_image(WIMStruct *wim, const char *dir, 
424                             const char *name, const char *description, 
425                             const char *flags_element, int flags);
426
427 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
428                                              const char *device, int flags);
429
430 /** 
431  * Creates a WIMStruct for a new WIM file.
432  *
433  * @param ctype 
434  *      The type of compression to be used in the new WIM file.  Must be
435  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
436  *      ::WIM_COMPRESSION_TYPE_XPRESS.
437  * @param wim_ret
438  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
439  *      written to the memory location pointed to by this paramater.  The
440  *      ::WIMStruct must be freed using using wimlib_free() when finished with
441  *      it.
442  * @return 0 on success; nonzero on error.
443  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
444  *      @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
445  *      ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
446  * @retval ::WIMLIB_ERR_NOMEM
447  *      Failed to allocate needed memory.
448  */
449 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
450
451 /**
452  * Deletes an image, or all images, from a WIM file.
453  *
454  * All file resources referenced by the image(s) being deleted are removed from
455  * the WIM if they are not referenced by any other images in the WIM.
456  *
457  * @param wim
458  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
459  *      being deleted.
460  * @param image
461  *      The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
462  *      images.
463  * @return 0 on success; nonzero on error.  On error, @a wim is left in an
464  * indeterminate state and should be freed with wimlib_free().
465  * @retval ::WIMLIB_ERR_DECOMPRESSION
466  *      Could not decompress the metadata resource for @a image.
467  * @retval ::WIMLIB_ERR_INVALID_DENTRY
468  *      A directory entry in the metadata resource for @a image in the WIM is
469  *      invalid.
470  * @retval ::WIMLIB_ERR_INVALID_IMAGE
471  *      @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
472  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
473  *      The metadata resource for @a image in the WIM is invalid.       
474  * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
475  * @retval ::WIMLIB_ERR_READ
476  *      Could not read the metadata resource for @a image from the WIM.
477  */
478 extern int wimlib_delete_image(WIMStruct *wim, int image);
479
480 /**
481  * Copies an image, or all the images, from a WIM file, into another WIM file.
482  *
483  * @param src_wim
484  *      Pointer to the ::WIMStruct for a WIM file that contains the image(s)
485  *      being exported.
486  * @param src_image
487  *      The image to export from @a src_wim.  Can be the number of an image, or
488  *      ::WIM_ALL_IMAGES to export all images.
489  * @param dest_wim
490  *      Pointer to the ::WIMStruct for a WIM filethat will receive the images being
491  *      exported.
492  * @param dest_name
493  *      The name to give the exported image in the new WIM file.  If left @c NULL,
494  *      the name from @a src_wim is used.  This parameter must be left @c NULL
495  *      if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
496  *      image; in that case, the names are all taken from the @a src_wim.
497  * @param dest_description
498  *      The description to give the exported image in the new WIM file.  If left
499  *      @c NULL, the description from the @a src_wim is used.  This parameter must
500  *      be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
501  *      more than one image; in that case, the descriptions are all taken from
502  *      @a src_wim.
503  * @param flags
504  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
505  *      bootable, or 0 if which image is marked as bootable in the destination
506  *      WIM is to be left unchanged.  If @a src_image is ::WIM_ALL_IMAGES and
507  *      there are multiple images in @a src_wim, specifying
508  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
509  *      currently marked as bootable in @a src_wim; if that is the case, then
510  *      that image is marked as bootable in the destination WIM.
511  *
512  * @return 0 on success; nonzero on error.  On error, @dest_wim is left in an
513  * indeterminate state and should be freed with wimlib_free().
514  * @retval ::WIMLIB_ERR_DECOMPRESSION
515  *      Could not decompress the metadata resource for @a src_image
516  *      in @a src_wim
517  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
518  *      One or more of the names being given to an exported image was already in
519  *      use in the destination WIM.
520  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
521  *      A directory entry in the metadata resource for @a src_image in @a
522  *      src_wim is invalid.
523  * @retval ::WIMLIB_ERR_INVALID_IMAGE
524  *      @a src_image does not exist in @a src_wim.
525  * @retval ::WIMLIB_ERR_INVALID_PARAM
526  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
527  *      ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
528  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
529  *      dest_description were non-<code>NULL</code>, @a src_image was
530  *      ::WIM_ALL_IMAGES, and @a src_wim contains multiple images.
531  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
532  *      The metadata resource for @a src_image in @a src_wim is invalid.        
533  * @retval ::WIMLIB_ERR_NOMEM 
534  *      Failed to allocate needed memory.
535  * @retval ::WIMLIB_ERR_READ
536  *      Could not read the metadata resource for @a src_image from @a src_wim.
537  */
538 extern int wimlib_export_image(WIMStruct *src_wim, int src_image, 
539                                WIMStruct *dest_wim, const char *dest_name, 
540                                const char *dest_description, int flags);
541
542 /**
543  * Extracts an image, or all images, from a WIM file.
544  *
545  * The output directory must have been previously set with
546  * wimlib_set_output_dir().
547  *
548  * The link type used for extracted files is that specified by a previous call
549  * to wimlib_set_link_type(), or ::WIM_LINK_TYPE_NONE by default.
550  *
551  * @param wim
552  *      Pointer to the ::WIMStruct for a WIM file.
553  * @param image
554  *      The image to extract.  Can be the number of an image, or ::WIM_ALL_IMAGES
555  *      to specify that all images are to be extracted.
556  *
557  * @return 0 on success; nonzero on error.
558  * @retval ::WIMLIB_ERR_DECOMPRESSION
559  *      Could not decompress a resource (file or metadata) for @a image in @a
560  *      wim.
561  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
562  *      A directory entry in the metadata resource for @a image in @a wim is
563  *      invalid.
564  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
565  *      A resource (file or metadata) for @a image in @a wim is invalid.        
566  * @retval ::WIMLIB_ERR_LINK
567  *      Failed to create a symbolic link or a hard link.
568  * @retval ::WIMLIB_ERR_MKDIR
569  *      Failed create a needed directory.
570  * @retval ::WIMLIB_ERR_NOMEM
571  *      Failed to allocate needed memory.
572  * @retval ::WIMLIB_ERR_NOTDIR
573  *      wimlib_set_output_dir() has not been successfully called on @a wim.
574  * @retval ::WIMLIB_ERR_OPEN
575  *      Could not open one of the files being extracted for writing.
576  * @retval ::WIMLIB_ERR_READ
577  *      A unexpected end-of-file or read error occurred when trying to read data
578  *      from the WIM file associated with @a wim.
579  * @retval ::WIMLIB_ERR_WRITE
580  *      Failed to write a file being extracted.
581  */
582 extern int wimlib_extract_image(WIMStruct *wim, int image,
583                                 const char *output_dir, int flags);
584
585 /**
586  * Extracts the XML data for a WIM file to a file stream.  Every WIM file
587  * includes a string of XML that describes the images contained in the WIM.
588  *
589  * @param wim
590  *      Pointer to the ::WIMStruct for a WIM file.
591  * @param fp 
592  *      @c stdout, or a FILE* opened for writing, to extract the data to.  
593  *
594  * @return 0 on success; nonzero on error.
595  * @retval ::WIMLIB_ERR_WRITE
596  *      Failed to completely write the XML data to @a fp.
597  */
598 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
599
600 /**
601  * Frees all memory allocated for a WIMStruct and closes all files associated
602  * with it. 
603  *
604  * @param wim
605  *      Pointer to the ::WIMStruct for a WIM file.
606  *
607  * @return This function has no return value.
608  */
609 extern void wimlib_free(WIMStruct *wim);
610
611 /**
612  * Finds which image in a WIM is bootable.
613  *
614  * @param wim
615  *      Pointer to the ::WIMStruct for a WIM file.
616  * 
617  * @return
618  *      0 if no image is marked as bootable, or the number of the image marked
619  *      as bootable (numbered starting at 1).
620  */
621 extern int wimlib_get_boot_idx(const WIMStruct *wim);
622
623 /**
624  * Gets the compression type used in the WIM.
625  *
626  * @param wim
627  *      Pointer to the ::WIMStruct for a WIM file
628  * 
629  * @return
630  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
631  *      ::WIM_COMPRESSION_TYPE_XPRESS.
632  */
633 extern int wimlib_get_compression_type(const WIMStruct *wim);
634
635 /**
636  * Converts a compression type enumeration value into a string.
637  *
638  * @param ctype
639  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
640  *      ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
641  *
642  * @return
643  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
644  *      respectively.
645  */
646 extern const char *wimlib_get_compression_type_string(int ctype);
647
648 /**
649  * Converts an error code into a string describing it.
650  *
651  * @param code
652  *      The error code returned by one of wimlib's functions.
653  *
654  * @return
655  *      Pointer to a statically allocated string describing the error code,
656  *      or @c NULL if the error code is not valid.
657  */
658 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
659
660 /**
661  * Returns the description of the specified image.
662  *
663  * @param wim
664  *      Pointer to the ::WIMStruct for a WIM file.
665  * @param image
666  *      The number of the image, numbered starting at 1.
667  *
668  * @return
669  *      The description of the image, or @c NULL if there is no such image, or @c NULL
670  *      if the specified image has no description.
671  */
672 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
673
674 /**
675  * Returns the name of the specified image.
676  *
677  * @param wim
678  *      Pointer to the ::WIMStruct for a WIM file.
679  * @param image
680  *      The number of the image, numbered starting at 1.
681  *
682  * @return
683  *      The name of the image, or @c NULL if there is no such image.
684  */
685 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
686
687
688 /**
689  * Gets the number of images contained in the WIM.
690  *
691  * @param wim
692  *      Pointer to the ::WIMStruct for a WIM file.
693  * 
694  * @return
695  *      The number of images contained in the WIM file.
696  */
697 extern int wimlib_get_num_images(const WIMStruct *wim);
698
699 /**
700  * Gets the part number of the wim (in a split WIM).
701  *
702  * @param wim
703  *      Pointer to the ::WIMStruct for a WIM file.
704  * @param total_parts_ret
705  *      If non-@c NULL, the total number of parts in the split WIM (1 for
706  *      non-split WIMs) is written to this location.
707  *
708  * @return 
709  *      The part number of the WIM (1 for non-split WIMs)
710  */
711 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
712
713 /**
714  * Returns true if the WIM has an integrity table.
715  *
716  * @param wim
717  *      Pointer to the ::WIMStruct for a WIM file.
718  * @return
719  *      @c true if the WIM has an integrity table; false otherwise.
720  */
721 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
722
723
724 /**
725  * Determines if an image name is already used by some image in the WIM.
726  *
727  * @param wim
728  *      Pointer to the ::WIMStruct for a WIM file.
729  * @param name
730  *      The name to check.
731  *
732  * @return
733  *      @c true if there is already an image in @a wim named @a name; @c
734  *      false if there is no image named @a name in @a wim.
735  */
736 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
737
738 /**
739  * Joins a set of split WIMs into a one-part WIM.
740  *
741  * @param swms
742  *      An array of strings that give the filenames of all parts of the split
743  *      WIM.
744  * @param num_swms
745  *      Number of filenames in @a swms.
746  * @param output_path
747  *      The path to write the one-part WIM to.
748  * @param flags
749  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
750  *      tables (if present) when opening them, and include an integrity table in
751  *      the output WIM.
752  *
753  * @return 0 on success; nonzero on error.  This function may return any value
754  * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
755  * as the following error codes:
756  *
757  * @retval ::WIMLIB_ERR_SPLIT_INVALID
758  *      The split WIMs do not form a valid WIM because they do not include all
759  *      the parts of the original WIM, there are duplicate parts, or not all the
760  *      parts have the same GUID and compression type.
761  * @retval ::WIMLIB_ERR_WRITE
762  *      An error occurred when trying to write data to the new WIM at @a output_path.
763  *
764  * Note that this function merely copies the resources, so it will not check to
765  * see if the resources, including the metadata resource, are valid or not.
766  */
767 extern int wimlib_join(const char **swms, int num_swms,
768                        const char *output_path, int flags);
769
770 /**
771  * Mounts an image in a WIM file on a directory read-only or read-write.
772  *
773  * A daemon will be forked to service the filesystem.
774  *
775  * If the mount is read-write, modifications to the WIM are staged in a staging
776  * directory.
777  *
778  * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
779  * intervening wimlib_unmount()s.  If there was a way to have libfuse pass a
780  * pointer to user data to each FUSE callback, then this would be possible, but
781  * there doesn't seem to be a way to do this currently.
782  *
783  * @param wim
784  *      Pointer to the ::WIMStruct for the WIM file to be mounted.
785  * @param image
786  *      The number of the image to mount, numbered from 1.  It must be an
787  *      existing, single image.
788  * @param dir
789  *      The path to an existing directory to mount the image on.
790  * @param flags
791  *      Bitwise OR of the flags ::WIMLIB_MOUNT_FLAG_READWRITE or
792  *      ::WIMLIB_MOUNT_FLAG_DEBUG.  If ::WIMLIB_MOUNT_FLAG_READWRITE is not
793  *      given, the WIM is mounted read-only.
794  *
795  * @return 0 on success; nonzero on error.
796  * @retval ::WIMLIB_ERR_DECOMPRESSION
797  *      Could not decompress the metadata resource for @a image in @a wim.
798  * @retval ::WIMLIB_ERR_FUSE
799  *      A non-zero status was returned by @c fuse_main().
800  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
801  *      A directory entry in the metadata resource for @a image in @a wim is
802  *      invalid.
803  * @retval ::WIMLIB_ERR_INVALID_IMAGE
804  *      @a image does not specify an existing, single image in @a wim.
805  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
806  *      The metadata resource for @a image in @a wim is invalid.        
807  * @retval ::WIMLIB_ERR_MKDIR
808  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
809  *      directory could not be created.
810  * @retval ::WIMLIB_ERR_NOMEM
811  *      Failed to allocate needed memory.
812  * @retval ::WIMLIB_ERR_NOTDIR
813  *      Could not determine the current working directory.
814  * @retval ::WIMLIB_ERR_READ
815  *      An unexpected end-of-file or read error occurred when trying to read
816  *      data from the WIM file associated with @a wim.
817  *
818  */
819 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
820
821 /**
822  * Opens a WIM file and creates a ::WIMStruct for it.
823  *
824  * @param wim_file 
825  *      The path to the WIM file to open.
826  * @param flags
827  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
828  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
829  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
830  *      of the WIM, if it exists, is checked, and the function will fail with an
831  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
832  *      digests of the WIM do not exactly match the corresponding message
833  *      digests given in the integrity table.
834  *      If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
835  *      be shown if the integrity of the WIM is checked.
836  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
837  *      WIM is part of a split WIM.  However, wimlib does not fully support
838  *      split WIMs, so not all functions will work correctly after opening a
839  *      split WIM.  For example, you cannot use wimlib_mount() or
840  *      wimlib_extract_image() on a split WIM.
841  *
842  * @param wim_ret
843  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
844  *      is written to the memory location pointed to by this parameter.  The
845  *      ::WIMStruct must be freed using using wimlib_free() when finished with
846  *      it.
847  *
848  * @return 0 on success; nonzero on error.
849  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
850  *      The lookup table of @a wim_file is compressed.  Support for this can be
851  *      added to wimlib if needed, but it appears to be the case that the lookup
852  *      table is never compressed.
853  * @retval ::WIMLIB_ERR_IMAGE_COUNT
854  *      The WIM is not the non-first part of a split WIM, and the number of
855  *      metadata resources found in the WIM did not match the image count given
856  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
857  *      data for the WIM did not match the image count given in the WIM header.
858  * @retval ::WIMLIB_ERR_INTEGRITY
859  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
860  *      wim_file contains an integrity table, but the SHA1 message digest for a
861  *      chunk of the WIM does not match the corresponding message digest given
862  *      in the integrity table.
863  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
864  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
865  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
866  *      The header of @a wim_file says that resources in the WIM are compressed,
867  *      but the header flag indicating LZX or XPRESS compression is not set.
868  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
869  *      The length field of the WIM header is not 208.
870  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
871  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
872  *      wim_file contains an integrity table, but the integrity table is
873  *      invalid.
874  * @retval ::WIMLIB_ERR_NOMEM
875  *      Failed to allocated needed memory.
876  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
877  *      @a wim_file does not begin with the expected magic characters.
878  * @retval ::WIMLIB_ERR_OPEN
879  *      Failed to open the file @a wim_file for reading.
880  * @retval ::WIMLIB_ERR_READ
881  *      An unexpected end-of-file or read error occurred when trying to read
882  *      data from @a wim_file.
883  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
884  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
885  *      givin in @a flags.
886  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
887  *      A number other than 0x10d00 is written in the version field of the WIM
888  *      header of @a wim_file.
889  * @retval ::WIMLIB_ERR_XML
890  *      The XML data for @a wim_file is invalid.
891  */
892 extern int wimlib_open_wim(const char *wim_file, int flags, 
893                            WIMStruct **wim_ret);
894
895 /**
896  * Overwrites the file that the WIM was originally read from, with changes made.
897  *
898  * The new WIM is written to a temporary file and then renamed to the original
899  * file after it is has been completely written.  The temporary file currently
900  * is made in the same directory as the original WIM file.
901  *
902  * Note that it is not possible for this function to delete the original file
903  * before having written the new file because it is very likely that file
904  * resources in the new WIM file need to be retrieved from the old WIM file.
905  *
906  * After this function returns, @a wim must be freed using wimlib_free().  Any
907  * further actions on @a wim before doing this are undefined.
908  *
909  * @param wim
910  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
911  *      been in-memory changes made to it, which are then reflected in the
912  *      output file.
913  * @param flags 
914  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
915  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
916  *
917  * @return 0 on success; nonzero on error.  This function may return any value
918  * returned by wimlib_write() as well as the following error codes:
919  * @retval ::WIMLIB_ERR_NO_FILENAME
920  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
921  *      than a WIM read with wimlib_open_wim().
922  * @retval ::WIMLIB_ERR_RENAME
923  *      The temporary file that the WIM was written to could not be renamed to
924  *      the original filename of @a wim.
925  */
926 extern int wimlib_overwrite(WIMStruct *wim, int flags);
927
928 /**
929  * Updates the header and XML data of the WIM file, without the need to write
930  * out the entire WIM to a temporary file as in wimlib_write().
931  *
932  * This function must only be used if no files, directories, or images have been
933  * added, removed, or changed in the WIM.  It must be used when only the boot
934  * index or the name or description of image(s) has been changed.
935  *
936  * After this function returns, @a wim must be freed using wimlib_free().  Any
937  * further actions on @a wim before doing this are undefined.
938  *
939  * @param wim
940  *      Pointer to the ::WIMStruct for the WIM file to overwrite.
941  * @param flags 
942  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
943  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
944  *
945  * @return 0 on success; nonzero on error.
946  *
947  * @retval ::WIMLIB_ERR_NO_FILENAME
948  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
949  *      than a WIM read with wimlib_open_wim().
950  * @retval ::WIMLIB_ERR_NOMEM
951  *      Failed to allocate needed memory.
952  * @retval ::WIMLIB_ERR_OPEN
953  *      The WIM file associated with @a wim could not be re-opened read-write.
954  * @retval ::WIMLIB_ERR_READ
955  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
956  *      from the WIM file associated with @a wim could not be read to compute
957  *      the SHA1 message digests, or the old integrity table (if it existed)
958  *      could not be read.
959  * @retval ::WIMLIB_ERR_WRITE
960  *      Failed to write the WIM header, the XML data, or the integrity table to
961  *      the WIM file associated with @a wim.
962  */
963 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
964
965 /**
966  * Prints information about one image, or all images, contained in a WIM.
967  *
968  * @param wim
969  *      Pointer to the ::WIMStruct for a WIM file.
970  * @param image 
971  *      The image about which to print information.  Can be the number of an
972  *      image, or ::WIM_ALL_IMAGES to print information about all images in the
973  *      WIM.
974  * 
975  * @return This function has no return value.
976  */
977 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
978
979 /**
980  * Prints the full paths to all files contained in an image, or all images, in a
981  * WIM file.
982  *
983  * @param wim
984  *      Pointer to the ::WIMStruct for a WIM file.
985  * @param image 
986  *      Which image to print files for.  Can be the number of an image, or
987  *      ::WIM_ALL_IMAGES to print the files contained in all images.  
988  *
989  * @return 0 on success; nonzero on error.
990  * @retval ::WIMLIB_ERR_DECOMPRESSION
991  *      The metadata resource for one of the specified images could not be
992  *      decompressed.
993  * @retval ::WIMLIB_ERR_INVALID_DENTRY
994  *      A directory entry in the metadata resource for one of the specified
995  *      images is invaled.
996  * @retval ::WIMLIB_ERR_INVALID_IMAGE
997  *      @a image does not specify a valid image in @a wim, and is not
998  *      ::WIM_ALL_IMAGES.
999  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1000  *      The metadata resource for one of the specified images is invalid.
1001  * @retval ::WIMLIB_ERR_NOMEM
1002  *      Failed to allocate needed memory.
1003  * @retval ::WIMLIB_ERR_READ
1004  *      An unexpected read error or end-of-file occurred when reading the
1005  *      metadata resource for one of the specified images.
1006  */
1007 extern int wimlib_print_files(WIMStruct *wim, int image);
1008
1009 /**
1010  * Prints detailed information from the header of a WIM file.
1011  *
1012  * @param wim
1013  *      Pointer to the ::WIMStruct for a WIM file.
1014  *
1015  * @return This function has no return value.
1016  *
1017  */
1018 extern void wimlib_print_header(const WIMStruct *wim);
1019
1020 /** 
1021  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
1022  * digests, as found in the directory entry tree in the WIM file, to file
1023  * resources in the WIM file.  This table includes one entry for each unique
1024  * file in the WIM, so it can be quite long.  There is only one lookup table per
1025  * WIM.
1026  *
1027  * @param wim
1028  *      Pointer to the ::WIMStruct for a WIM file.
1029  *
1030  * @return This function has no return value.
1031  */
1032 extern void wimlib_print_lookup_table(WIMStruct *wim);
1033
1034 /**
1035  * Prints the metadata of the specified image in a WIM file.  The metadata
1036  * consists of the security data as well as the directory entry tree, and each
1037  * image has its own metadata.  
1038  *
1039  * @param wim
1040  *      Pointer to the ::WIMStruct for a WIM file.
1041  * @param image 
1042  *      Which image to print the metadata for.  Can be the number of an image,
1043  *      or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1044  *
1045  * @return 0 on success; nonzero on error.
1046  * @retval ::WIMLIB_ERR_DECOMPRESSION
1047  *      The metadata resource for one of the specified images could not be
1048  *      decompressed.
1049  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1050  *      A directory entry in the metadata resource for one of the specified
1051  *      images is invaled.
1052  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1053  *      @a image does not specify a valid image in @a wim, and is not
1054  *      ::WIM_ALL_IMAGES.
1055  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1056  *      The metadata resource for one of the specified images is invalid.
1057  * @retval ::WIMLIB_ERR_NOMEM
1058  *      Failed to allocate needed memory.
1059  * @retval ::WIMLIB_ERR_READ
1060  *      An unexpected read error or end-of-file occurred when reading the
1061  *      metadata resource for one of the specified images.
1062  */
1063 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1064
1065 /**
1066  * Prints some basic information about a WIM file.  All information printed by
1067  * this function is also printed by wimlib_print_header(), but
1068  * wimlib_print_wim_information() prints some of this information more concisely
1069  * and in a more readable form.
1070  *
1071  * @param wim
1072  *      Pointer to the ::WIMStruct for a WIM file.
1073  *
1074  * @return This function has no return value.  
1075  */
1076 extern void wimlib_print_wim_information(const WIMStruct *wim);
1077
1078 /**
1079  * Translates a string specifying the name or number of an image in the WIM into
1080  * the number of the image.  The images are numbered starting at 1.
1081  *
1082  * @param wim
1083  *      Pointer to the ::WIMStruct for a WIM file.
1084  * @param image_name_or_num  
1085  *      A string specifying which image.  If it begins with a number, it is
1086  *      taken to be a string specifying the image number.  Otherwise, it is
1087  *      taken to be the name of an image, as specified in the XML data for the
1088  *      WIM file.  It also may be the keyword "all", which will resolve to
1089  *      ::WIM_ALL_IMAGES.
1090  *
1091  * @return 
1092  *      If the string resolved to a single existing image, the number of that
1093  *      image, counting starting at 1, is returned.  If the keyword "all" was
1094  *      specified, ::WIM_ALL_IMAGES is returned.  Otherwise, ::WIM_NO_IMAGE is
1095  *      returned.
1096  */
1097 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1098
1099 /**
1100  * Sets which image in the WIM is marked as bootable.
1101  *
1102  * @param wim
1103  *      Pointer to the ::WIMStruct for a WIM file.
1104  * @param boot_idx
1105  *      The number of the image to mark as bootable, or 0 to mark no image as
1106  *      bootable.
1107  * @return 0 on success; nonzero on error.
1108  * @retval ::WIMLIB_ERR_INVALID_IMAGE 
1109  *      @a boot_idx does not specify an existing image in @a wim, and it was not
1110  *      0.
1111  */
1112 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1113
1114 /**
1115  * Changes the description of an image in the WIM.
1116  *
1117  * @param wim
1118  *      Pointer to the ::WIMStruct for a WIM file.
1119  * @param image
1120  *      The number of the image for which to change the description.
1121  * @param description
1122  *      The new description to give the image.  It may be @c NULL, which
1123  *      indicates that the image is to be given no description.
1124  *
1125  * @return 0 on success; nonzero on error.
1126  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1127  *      @a image does not specify a single existing image in @a wim.
1128  * @retval ::WIMLIB_ERR_NOMEM
1129  *      Failed to allocate the memory needed to duplicate the @a description
1130  *      string.
1131  */
1132 extern int wimlib_set_image_descripton(WIMStruct *wim, int image, 
1133                                        const char *description);
1134
1135 /**
1136  * Changes the name of an image in the WIM.
1137  *
1138  * @param wim
1139  *      Pointer to the ::WIMStruct for a WIM file.
1140  * @param image
1141  *      The number of the image for which to change the name.
1142  * @param name
1143  *      The new name to give the image.  It must not be @c NULL.
1144  *
1145  * @return 0 on success; nonzero on error.
1146  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1147  *      There is already an image named @a name in @a wim.
1148  * @retval ::WIMLIB_ERR_INVALID_PARAM
1149  *      @a name was @c NULL or the empty string.
1150  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1151  *      @a image does not specify a single existing image in @a wim.
1152  * @retval ::WIMLIB_ERR_NOMEM
1153  *      Failed to allocate the memory needed to duplicate the @a name string.
1154  */
1155 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1156
1157 /**
1158  * Sets the link type to use when extracting files from a WIM.  This applies
1159  * when extracting one image as well as when extracting all images.  Cross-image
1160  * links may save a lot of space because it is common for files to be referenced
1161  * multiple times in WIM files.  By default, the link type used for extraction
1162  * is ::WIM_LINK_TYPE_NONE, meaning that links are not created.
1163  *
1164  * @param wim
1165  *      Pointer to the ::WIMStruct for a WIM file
1166  * @param link_type
1167  *      ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC, or ::WIM_LINK_TYPE_HARD.
1168  *
1169  * @return 0 on success; nonzero on error.
1170  * @retval ::WIMLIB_ERR_INVALID_PARAM
1171  *      @a link_type was not ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC,
1172  *      or ::WIM_LINK_TYPE_HARD.
1173  */
1174 extern int wimlib_set_link_type(WIMStruct *wim, int link_type);
1175
1176 /**
1177  * Set the functions that wimlib uses to allocate and free memory.
1178  *
1179  * These settings are global and not per-WIM.
1180  *
1181  * The default is to use the default @c malloc() and @c free() from the C
1182  * library.
1183  *
1184  * @param malloc_func
1185  *      A function equivalent to @c malloc() that wimlib will use to allocate
1186  *      memory.  If @c NULL, the allocator function is set back to the default
1187  *      @c malloc() from the C library.
1188  * @param free_func
1189  *      A function equivalent to @c free() that wimlib will use to free memory.
1190  *      If @c NULL, the free function is set back to the default @c free() from
1191  *      the C library.
1192  * @param realloc_func
1193  *      A function equivalent to @c realloc() that wimlib will use to reallocate
1194  *      memory.  If @c NULL, the free function is set back to the default @c
1195  *      realloc() from the C library.
1196  * @return 0 on success; nonzero on error.
1197  * @retval ::WIMLIB_ERR_UNSUPPORTED
1198  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
1199  *      so custom memory allocators are unsupported.
1200  */
1201 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1202                                  void (*free_func)(void *),
1203                                  void *(*realloc_func)(void *, size_t));
1204
1205 /**
1206  * Sets whether wimlib is to print error messages to @c stderr when a function
1207  * fails or not.  These error messages may provide information that cannot be
1208  * determined only from the error code that is returned.
1209  *
1210  * This setting is global and not per-WIM.
1211  *
1212  * By default, error messages are not printed.
1213  *
1214  * @param show_messages
1215  *      @c true if error messages are to be printed; @c false if error messages
1216  *      are not to be printed.
1217  *
1218  * @return 0 on success; nonzero on error.
1219  * @retval ::WIMLIB_ERR_UNSUPPORTED
1220  *      @a show_messages was @c true, but wimlib was compiled with the @c
1221  *      --without-error-messages option.   Therefore, error messages cannot be
1222  *      shown.
1223  */
1224 extern int wimlib_set_print_errors(bool show_messages);
1225
1226 /**
1227  * Splits a WIM into multiple parts.
1228  *
1229  * @param wimfile
1230  *      Name of the WIM file to split.  It must be a standalone, one-part WIM.
1231  * @param swm_name
1232  *      Name of the SWM file to create.  This will be the name of the first
1233  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
1234  *      appended.
1235  * @param part_size
1236  *      The maximum size per part.  It is not guaranteed that this will really
1237  *      be the maximum size per part, because some file resources in the WIM may
1238  *      be larger than this size, and the WIM file format provides no way to
1239  *      split up file resources among multiple WIMs.
1240  * @param flags
1241  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1242  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1243  *
1244  * @return 0 on success; nonzero on error.  This function may return any value
1245  * returned by wimlib_open_wim() as well as the following error codes:
1246  *
1247  * @retval ::WIMLIB_ERR_WRITE
1248  *      An error occurred when trying to write data to one of the split WIMs.
1249  *
1250  */
1251 extern int wimlib_split(const char *wimfile, const char *swm_name, 
1252                         size_t part_size, int flags);
1253
1254 /**
1255  * Unmounts a WIM image that was mounted using wimlib_mount().
1256  *
1257  * Blocks until it is known whether the mount succeeded or failed.
1258  *
1259  * To perform this operation, the process calling wimlib_unmount() communicates
1260  * with the process that had called wimlib_mount().
1261  *
1262  * There is currently a design problem with this function because it is hard to
1263  * know whether the filesystem daemon is still working or whether it has
1264  * crashed, has been killed, or has reached an infinite loop. However, ideally
1265  * there should be no infinite loops or crashes in the code, so this wouldn't be
1266  * much of a problem.  Currently, a timeout of 600 seconds (so long because WIMs
1267  * can be very large) is implemented so that this function will not wait forever
1268  * before returning failure.  
1269  *
1270  * @param dir
1271  *      The directory that the WIM image was mounted on.
1272  * @param flags
1273  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1274  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT.  Neither of these flags affect read-only
1275  *      mounts.
1276  *
1277  * @return 0 on success; nonzero on error.
1278  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1279  *      The filesystem daemon was unable to remove the staging directory and the
1280  *      temporary files that it contains.
1281  * @retval ::WIMLIB_ERR_FORK
1282  *      Could not @c fork() the process.
1283  * @retval ::WIMLIB_ERR_FUSERMOUNT
1284  *      The @b fusermount program could not be executed or exited with a failure
1285  *      status.
1286  * @retval ::WIMLIB_ERR_MQUEUE
1287  *      Could not open a POSIX message queue to communicate with the filesystem
1288  *      daemon servicing the mounted filesystem, could not send a message
1289  *      through the queue, or could not receive a message through the queue.
1290  * @retval ::WIMLIB_ERR_NOMEM
1291  *      Failed to allocate needed memory.
1292  * @retval ::WIMLIB_ERR_OPEN
1293  *      The filesystem daemon could not open a temporary file for writing the
1294  *      new WIM.
1295  * @retval ::WIMLIB_ERR_TIMEOUT
1296  *      600 seconds elapsed while waiting for the filesystem daemon to notify
1297  *      the process of its exit status, so the WIM file probably was not written
1298  *      successfully.
1299  * @retval ::WIMLIB_ERR_READ
1300  *      A read error occurred when the filesystem daemon tried to a file from
1301  *      the staging directory
1302  * @retval ::WIMLIB_ERR_RENAME
1303  *      The filesystem daemon failed to rename the newly written WIM file to the
1304  *      original WIM file.
1305  * @retval ::WIMLIB_ERR_WRITE
1306  *      A write error occurred when the filesystem daemon was writing to the new
1307  *      WIM file, or the filesystem daemon was unable to flush changes that had
1308  *      been made to files in the staging directory.
1309  */
1310 extern int wimlib_unmount(const char *dir, int flags);
1311
1312 /**
1313  * Writes the WIM to a file.
1314  *
1315  * @param wim
1316  *      Pointer to the ::WIMStruct for a WIM file.  There may have been
1317  *      in-memory changes made to it, which are then reflected in the output
1318  *      file.
1319  * @param path
1320  *      The path to the file to write the WIM to.
1321  * @param image
1322  *      The image inside the WIM to write.  Use ::WIM_ALL_IMAGES to include all
1323  *      images.
1324  * @param flags 
1325  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1326  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.  If
1327  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1328  *      included in the WIM being written.  If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1329  *      is given, the progress of the calculation of the integrity table is
1330  *      shown.
1331  *
1332  * @return 0 on success; nonzero on error.
1333  * @retval ::WIMLIB_ERR_DECOMPRESSION
1334  *      Failed to decompress a metadata or file resource in @a wim.
1335  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
1336  *      A directory entry in the metadata resource for @a image in @a wim is
1337  *      invalid.
1338  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1339  *      @a image does not specify a single existing image in @a wim, and is not
1340  *      ::WIM_ALL_IMAGES.
1341  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1342  *      The metadata resource for @a image in @a wim is invalid.        
1343  * @retval ::WIMLIB_ERR_NOMEM
1344  *      Failed to allocate needed memory.
1345  * @retval ::WIMLIB_ERR_OPEN
1346  *      Failed to open @a path for writing, or some file resources in @a
1347  *      wim refer to files in the outside filesystem, and one of these files
1348  *      could not be opened for reading.
1349  * @retval ::WIMLIB_ERR_READ
1350  *      An error occurred when trying to read data from the WIM file associated
1351  *      with @a wim, or some file resources in @a wim refer to files in the
1352  *      outside filesystem, and a read error occurred when reading one of these
1353  *      files.
1354  * @retval ::WIMLIB_ERR_WRITE
1355  *      An error occurred when trying to write data to the new WIM file at @a
1356  *      path.
1357  */
1358 extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
1359
1360
1361
1362 #endif /* _WIMLIB_H */
1363