* External header for wimlib.
*/
-/*
+/*
* Copyright (C) 2012 Eric Biggers
*
* This file is part of wimlib, a library for working with WIM files.
* A WIM file may be either stand-alone or split into multiple parts.
*
* \section winpe Windows PE
- *
+ *
* A major use for this library is to create customized images of Windows PE, the
* Windows Preinstallation Environment, without having to rely on Windows. Windows
* PE is a lightweight version of Windows that can run entirely from memory and can
* that this is for convenience only, and some errors can occur without a
* message being printed.
*
- * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
- * following exceptions: wimlib_set_print_errors() and
- * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
- * used by one ::WIMStruct at a time.
+ * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
+ * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
+ * both apply globally.
*
* To open an existing WIM, use wimlib_open_wim().
*
* wimlib comes with the <b>imagex</b> program, which is documented in man pages.
*
* \section mkwinpeimg mkwinpeimg
- *
+ *
* wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
* page.
*
#include <stdbool.h>
#ifndef _WIMLIB_INTERNAL_H
-/**
- * Opaque structure that represents a WIM file.
+/**
+ * Opaque structure that represents a WIM file.
*/
typedef struct WIMStruct WIMStruct;
#endif
* alternate file stream name. */
#define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
-/** Include an integrity table in the new WIM being written during the unmount.
+/** Include an integrity table in the new WIM being written during the unmount.
* Ignored for read-only mounts. */
#define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
WIMLIB_ERR_READLINK,
WIMLIB_ERR_READ,
WIMLIB_ERR_RENAME,
+ WIMLIB_ERR_RESOURCE_ORDER,
WIMLIB_ERR_SPECIAL_FILE,
WIMLIB_ERR_SPLIT_INVALID,
WIMLIB_ERR_SPLIT_UNSUPPORTED,
* @param config_len
* Length of the string @a config in bytes. Ignored if @a config is @c
* NULL.
- *
+ *
* @param flags
* Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
* ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
* discarded so that it appears to be in the same state as when this function
* was called.
*
- * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
+ * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
* There is already an image named @a name in @a w.
- * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
* @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
* @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate needed memory.
* dir.
* @retval ::WIMLIB_ERR_READ
* Failed to read a file in the directory tree rooted at @a dir.
+ * @retval ::WIMLIB_ERR_SPECIAL_FILE
+ * The directory tree rooted at @dir contains a special file that is not a
+ * directory, regular file, or symbolic link.
* @retval ::WIMLIB_ERR_STAT
* Failed obtain the metadata for a file or directory in the directory tree
* rooted at @a dir.
* @a wim is part of a split WIM. Adding an image to a split WIM is
* unsupported.
*/
-extern int wimlib_add_image(WIMStruct *wim, const char *dir,
+extern int wimlib_add_image(WIMStruct *wim, const char *dir,
const char *name, const char *config,
size_t config_len, int flags);
WIMStruct **additional_swms,
unsigned num_additional_swms);
-/**
+/**
* Creates a WIMStruct for a new WIM file.
*
- * @param ctype
+ * @param ctype
* The type of compression to be used in the new WIM file. Must be
* ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
* ::WIM_COMPRESSION_TYPE_XPRESS.
* @retval ::WIMLIB_ERR_INVALID_IMAGE
* @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- * The metadata resource for @a image in the WIM is invalid.
+ * The metadata resource for @a image in the WIM is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
- * The security data for @a image in the WIM is invalid.
+ * The security data for @a image in the WIM is invalid.
* @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate needed memory.
* @retval ::WIMLIB_ERR_READ
* @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
* One or more of the names being given to an exported image was already in
* use in the destination WIM.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
* A directory entry in the metadata resource for @a src_image in @a
* src_wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_IMAGE
* ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
* or @a dest_wim was @c NULL.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- * The metadata resource for @a src_image in @a src_wim is invalid.
+ * The metadata resource for @a src_image in @a src_wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
- * The security data for @a src_image in @a src_wim is invalid.
- * @retval ::WIMLIB_ERR_NOMEM
+ * The security data for @a src_image in @a src_wim is invalid.
+ * @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate needed memory.
* @retval ::WIMLIB_ERR_READ
* Could not read the metadata resource for @a src_image from @a src_wim.
* @a dest_wim is part of a split WIM. Exporting an image to a split WIM
* is unsupported.
*/
-extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
- WIMStruct *dest_wim, const char *dest_name,
+extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
+ WIMStruct *dest_wim, const char *dest_name,
const char *dest_description, int flags,
WIMStruct **additional_swms,
unsigned num_additional_swms);
* @retval ::WIMLIB_ERR_DECOMPRESSION
* Could not decompress a resource (file or metadata) for @a image in @a
* wim.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
* A directory entry in the metadata resource for @a image in @a wim is
* invalid.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
* The SHA1 message digest of an extracted stream did not match the SHA1
* message digest given in the WIM file.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- * A resource (file or metadata) for @a image in @a wim is invalid.
+ * A resource (file or metadata) for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
- * The security data for @a image in @a wim is invalid.
+ * The security data for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_LINK
* Failed to create a symbolic link or a hard link.
* @retval ::WIMLIB_ERR_MKDIR
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- * @param fp
- * @c stdout, or a FILE* opened for writing, to extract the data to.
+ * @param fp
+ * @c stdout, or a FILE* opened for writing, to extract the data to.
*
* @return 0 on success; nonzero on error.
* @retval ::WIMLIB_ERR_WRITE
/**
* Frees all memory allocated for a WIMStruct and closes all files associated
- * with it.
+ * with it.
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- *
+ *
* @return
* 0 if no image is marked as bootable, or the number of the image marked
* as bootable (numbered starting at 1).
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file
- *
+ *
* @return
* ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
* ::WIM_COMPRESSION_TYPE_XPRESS.
* @param wim
* Pointer to the ::WIMStruct for a WIM file. It may be either a
* standalone WIM or a split WIM part.
- *
+ *
* @return
* The number of images contained in the WIM file.
*/
* If non-@c NULL, the total number of parts in the split WIM (1 for
* non-split WIMs) is written to this location.
*
- * @return
+ * @return
* The part number of the WIM (1 for non-split WIMs)
*/
extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
* An error occurred when trying to write data to the new WIM at @a output_path.
*
* Note that this function merely copies the resources, so it will not check to
- * see if the resources, including the metadata resource, are valid or not.
+ * see if the resources, including the metadata resources, are valid or not.
+ *
+ * Also, after this function is called, the only function that may be called on
+ * the ::WIMStruct's in the @a swms array is wimlib_free().
*/
extern int wimlib_join(const char **swms, unsigned num_swms,
const char *output_path, int flags);
* If the mount is read-write, modifications to the WIM are staged in a staging
* directory.
*
- * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
- * intervening wimlib_unmount()s.
+ * wimlib_mount() may be called from multiple threads without intervening calls
+ * to wimlib_unmount(), provided that different ::WIMStruct's are used. (This
+ * was not the case for versions of this library 1.0.3 and earlier.)
*
* wimlib_mount() cannot be used on an image that was exported with
- * wimlib_export() while the dentry trees for both images are still in memory.
+ * wimlib_export_image() while the dentry trees for both images are still in
+ * memory.
*
* @param wim
* Pointer to the ::WIMStruct for the WIM file to be mounted.
* Could not decompress the metadata resource for @a image in @a wim.
* @retval ::WIMLIB_ERR_FUSE
* A non-zero status was returned by @c fuse_main().
- * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
* A directory entry in the metadata resource for @a image in @a wim is
* invalid.
* @retval ::WIMLIB_ERR_INVALID_IMAGE
* @a image does not specify an existing, single image in @a wim.
* @retval ::WIMLIB_ERR_INVALID_PARAM
* @a image is shared among multiple ::WIMStruct's as a result of a call to
- * wimlib_export().
+ * wimlib_export_image().
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- * The metadata resource for @a image in @a wim is invalid.
+ * The metadata resource for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
- * The security data for @a image in @a wim is invalid.
+ * The security data for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_MKDIR
* ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
* directory could not be created.
/**
* Opens a WIM file and creates a ::WIMStruct for it.
*
- * @param wim_file
+ * @param wim_file
* The path to the WIM file to open.
* @param flags
* Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
* If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
* be shown if the integrity of the WIM is checked.
* If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
- * WIM is part of a split WIM; otherwise WIMLIB_ERR_SPLIT_UNSUPPORTED is
+ * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
* returned. (This flag may be removed in the future, in which case no
* error will be issued when opening a split WIM.)
*
* @retval ::WIMLIB_ERR_XML
* The XML data for @a wim_file is invalid.
*/
-extern int wimlib_open_wim(const char *wim_file, int flags,
+extern int wimlib_open_wim(const char *wim_file, int flags,
WIMStruct **wim_ret);
/**
* Pointer to the ::WIMStruct for the WIM file to write. There may have
* been in-memory changes made to it, which are then reflected in the
* output file.
- * @param flags
+ * @param flags
* Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
* ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
*
*
* @param wim
* Pointer to the ::WIMStruct for the WIM file to overwrite.
- * @param flags
+ * @param flags
* Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
* ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
*
* from the WIM file associated with @a wim could not be read to compute
* the SHA1 message digests, or the old integrity table (if it existed)
* could not be read.
+ * @retval ::WIMLIB_ERR_RESOURCE_ORDER
+ * Stream resources appeared in the WIM after the XML data or integrity
+ * table, so we could not safely overwrite the XML data and integrity
+ * table. Note: this error should never be received from WIMs that were
+ * written by this library.
* @retval ::WIMLIB_ERR_WRITE
* Failed to write the WIM header, the XML data, or the integrity table to
* the WIM file associated with @a wim.
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- * @param image
+ * @param image
* The image about which to print information. Can be the number of an
* image, or ::WIM_ALL_IMAGES to print information about all images in the
* WIM.
- *
- * @return This function has no return value.
+ *
+ * @return This function has no return value. No error checking is done when
+ * printing the information. If @a image is invalid, an error message is
+ * printed.
*/
extern void wimlib_print_available_images(const WIMStruct *wim, int image);
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- * @param image
+ * @param image
* Which image to print files for. Can be the number of an image, or
- * ::WIM_ALL_IMAGES to print the files contained in all images.
+ * ::WIM_ALL_IMAGES to print the files contained in all images.
*
* @return 0 on success; nonzero on error.
* @retval ::WIMLIB_ERR_DECOMPRESSION
*/
extern void wimlib_print_header(const WIMStruct *wim);
-/**
+/**
* Prints the lookup table of a WIM file. The lookup table maps SHA1 message
* digests, as found in the directory entry tree in the WIM file, to file
* resources in the WIM file. This table includes one entry for each unique
/**
* Prints the metadata of the specified image in a WIM file. The metadata
* consists of the security data as well as the directory entry tree, and each
- * image has its own metadata.
+ * image has its own metadata.
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- * @param image
+ * @param image
* Which image to print the metadata for. Can be the number of an image,
* or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
*
- * @return This function has no return value.
+ * @return This function has no return value.
*/
extern void wimlib_print_wim_information(const WIMStruct *wim);
*
* @param wim
* Pointer to the ::WIMStruct for a WIM file.
- * @param image_name_or_num
+ * @param image_name_or_num
* A string specifying which image. If it begins with a number, it is
* taken to be a string specifying the image number. Otherwise, it is
* taken to be the name of an image, as specified in the XML data for the
* WIM file. It also may be the keyword "all" or the string "*", both of
* which will resolve to ::WIM_ALL_IMAGES.
*
- * @return
+ * @return
* If the string resolved to a single existing image, the number of that
* image, counting starting at 1, is returned. If the keyword "all" was
* specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
* @return 0 on success; nonzero on error.
* @retval ::WIMLIB_ERR_INVALID_PARAM
* @a wim was @c NULL.
- * @retval ::WIMLIB_ERR_INVALID_IMAGE
+ * @retval ::WIMLIB_ERR_INVALID_IMAGE
* @a boot_idx does not specify an existing image in @a wim, and it was not
* 0.
* @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
* Failed to allocate the memory needed to duplicate the @a description
* string.
*/
-extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
+extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
const char *description);
/**
* An error occurred when trying to write data to one of the split WIMs.
*
*/
-extern int wimlib_split(const char *wimfile, const char *swm_name,
+extern int wimlib_split(const char *wimfile, const char *swm_name,
size_t part_size, int flags);
/**
* there should be no infinite loops or crashes in the code, so this wouldn't be
* much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
* can be very large) is implemented so that this function will not wait forever
- * before returning failure.
+ * before returning failure.
*
* @param dir
* The directory that the WIM image was mounted on.
* @param image
* The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
* images.
- * @param flags
+ * @param flags
* Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
* ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
* ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
* @return 0 on success; nonzero on error.
* @retval ::WIMLIB_ERR_DECOMPRESSION
* Failed to decompress a metadata or file resource in @a wim.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
* A directory entry in the metadata resource for @a image in @a wim is
* invalid.
* @retval ::WIMLIB_ERR_INVALID_IMAGE
* @retval ::WIMLIB_ERR_INVALID_PARAM
* @a wim or @a path was @c NULL.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- * The metadata resource for @a image in @a wim is invalid.
+ * The metadata resource for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
* The security data for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_NOMEM
git://wimlib.net / wimlib / blobdiff