*/
/*
- * Copyright (C) 2010 Carl Thijssen
* Copyright (C) 2012 Eric Biggers
*
* This file is part of wimlib, a library for working with WIM files.
*
* wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
* any later version.
*
* wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
- * You should have received a copy of the GNU Lesser General Public License
+ * You should have received a copy of the GNU General Public License
* along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
#ifndef _WIMLIB_INTERNAL_H
#define _WIMLIB_INTERNAL_H
+#include "config.h"
#include "util.h"
+#include "list.h"
+#include "wimlib.h"
+
+#ifdef WITH_FUSE
+#include <pthread.h>
+#endif
struct stat;
+struct dentry;
+struct inode;
#define WIM_MAGIC_LEN 8
#define WIM_GID_LEN 16
#define WIM_UNUSED_LEN 60
-
/* Length of the WIM header on disk. */
#define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
* yet. The differences between the versions are undocumented. */
#define WIM_VERSION 0x10d00
-enum wim_integrity_status {
- WIM_INTEGRITY_OK,
- WIM_INTEGRITY_NOT_OK,
- WIM_INTEGRITY_NONEXISTENT,
-};
-
/* Metadata for a resource in a WIM file. */
struct resource_entry {
/* Size, in bytes, of the resource in the WIM file. */
/* Flags for the `flags' field of the struct resource_entry structure. */
-/* ??? */
+/* I haven't seen this flag used in any of the WIMs I have examined. I assume
+ * it means that there are no references to the stream, so the space is free.
+ * However, even after deleting files from a WIM mounted with `imagex.exe
+ * /mountrw', I could not see this flag being used. Either way, we don't
+ * actually use this flag for anything. */
#define WIM_RESHDR_FLAG_FREE 0x01
-/* Indicates that a file resource is a metadata resource. */
+/* Indicates that the stream is a metadata resource for a WIM image. */
#define WIM_RESHDR_FLAG_METADATA 0x02
-/* Indicates that a file resource is compressed. */
+/* Indicates that the stream is compressed. */
#define WIM_RESHDR_FLAG_COMPRESSED 0x04
-/* ??? */
+/* I haven't seen this flag used in any of the WIMs I have examined. Perhaps it
+ * means that a stream could possibly be split among multiple split WIM parts.
+ * However, `imagex.exe /split' does not seem to create any WIMs like this.
+ * Either way, we don't actually use this flag for anything. */
#define WIM_RESHDR_FLAG_SPANNED 0x08
-
/* Header at the very beginning of the WIM file. */
-struct wim_header {
+struct wim_header {
/* Identifies the file as WIM file. Must be exactly
* {'M', 'S', 'W', 'I', 'M', 0, 0, 0} */
- //u8 magic[WIM_MAGIC_LEN];
+ //u8 magic[WIM_MAGIC_LEN];
/* size of WIM header in bytes. */
//u32 hdr_size;
- /* Version of the WIM file. M$ provides no documentation about exactly
- * what this field affects about the file format, other than the fact
- * that more recent versions have a higher value. */
+ /* Version of the WIM file. Microsoft provides no documentation about
+ * exactly what this field affects about the file format, other than the
+ * fact that more recent versions have a higher value. */
//u32 version;
/* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
/* The size of the pieces that the uncompressed files were split up into
* when they were compressed. This should be the same as
- * WIM_CHUNK_SIZE. M$ incorrectly documents this as "the size of the
- * compressed .wim file in bytes".*/
+ * WIM_CHUNK_SIZE. Microsoft incorrectly documents this as "the size of
+ * the compressed .wim file in bytes".*/
//u32 chunk_size;
-
+
/* A unique identifier for the WIM file. */
- u8 guid[WIM_GID_LEN];
+ u8 guid[WIM_GID_LEN];
/* Part number of the WIM file in a spanned set. */
u16 part_number;
/* The index of the bootable image in the WIM file. If 0, there are no
* bootable images available. */
- u32 boot_idx;
+ u32 boot_idx;
/* The location of the optional integrity table used to verify the
* integrity WIM. Zeroed out if there is no integrity table.*/
//u8 unused[WIM_UNUSED_LEN];
};
-/* Flags for the `flags' field of the struct wim_header. */
-
+/* Flags for the `flags' field of the struct wim_header: */
-/* Reserved for future use by M$ */
+/* Reserved for future use */
#define WIM_HDR_FLAG_RESERVED 0x00000001
/* Files and metadata in the WIM are compressed. */
#define WIM_HDR_FLAG_COMPRESSION 0x00000002
-/* WIM is read-only. */
+/* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
#define WIM_HDR_FLAG_READONLY 0x00000004
/* Resource data specified by images in this WIM may be contained in a different
- * WIM */
+ * WIM. Or in other words, this WIM is part of a split WIM. */
#define WIM_HDR_FLAG_SPANNED 0x00000008
-/* The WIM contains resources only; no filesystem metadata. */
+/* The WIM contains resources only; no filesystem metadata. wimlib ignores this
+ * flag, as it looks for resources in all the WIMs anyway. */
#define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010
-/* The WIM contains metadata only. */
+/* The WIM contains metadata only. wimlib ignores this flag. Note that all the
+ * metadata resources for a split WIM should be in the first part. */
#define WIM_HDR_FLAG_METADATA_ONLY 0x00000020
-/* Lock field to prevent multiple writers from writing the WIM concurrently. */
-#define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
+/* Lock field to prevent multiple writers from writing the WIM concurrently.
+ * wimlib ignores this flag as it uses flock() to acquire a real lock on the
+ * file (if supported by the underlying filesystem). */
+#define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040
-/* Reparse point fixup ??? */
+/* Reparse point fixup ???
+ * This has something to do with absolute targets of reparse points / symbolic
+ * links but I don't know what. wimlib ignores this flag. */
#define WIM_HDR_FLAG_RP_FIX 0x00000080
-/* Unknown compression type */
+/* Unused, reserved flag for another compression type */
#define WIM_HDR_FLAG_COMPRESS_RESERVED 0x00010000
/* Resources within the WIM are compressed using "XPRESS" compression, which is
* a LZ77-based algorithm. */
#define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000
-typedef struct _ntfs_volume ntfs_volume;
+#ifdef WITH_NTFS_3G
+struct _ntfs_volume;
+#endif
/* Structure for security data. Each image in the WIM file has its own security
* data. */
struct wim_security_data {
- /* The total length of the security data, in bytes. A typical size is
- * 2048 bytes. If there is no security data, though (as in the WIMs
- * that wimlib writes, currently), it will be 8 bytes. */
+ /* The total length of the security data, in bytes. If there are no
+ * security descriptors, this field may be either 8 (which is correct)
+ * or 0 (which is interpreted as 0). */
u32 total_length;
- /* The number of security descriptors in the array @descriptors, below. */
- u32 num_entries;
+ /* The number of security descriptors in the array @descriptors, below.
+ * It is really an unsigned int, but it must fit into an int because the
+ * security ID's are signed. (Not like you would ever have more than a
+ * few hundred security descriptors anyway.) */
+ int32_t num_entries;
/* Array of sizes of the descriptors in the array @descriptors. */
u64 *sizes;
/* Array of descriptors. */
u8 **descriptors;
- /* keep track of how many WIMs reference this security data (used when
+ /* Keep track of how many WIMs reference this security data (used when
* exporting images between WIMs) */
u32 refcnt;
};
-struct link_group_table;
-
+struct inode_table;
/* Metadata resource for an image. */
struct image_metadata {
/* Pointer to the security data for the image. */
struct wim_security_data *security_data;
- /* Hard link group table */
- struct link_group_table *lgt;
-
/* A pointer to the lookup table entry for this image's metadata
* resource. */
struct lookup_table_entry *metadata_lte;
- /* True if the filesystem of the image has been modified. If this is
- * the case, the memory for the filesystem is not freed when switching
- * to a different WIM image. */
- bool modified;
+ /* Linked list of inodes for this image. */
+ struct hlist_head inode_list;
+ /* True iff the dentry tree has been modified. If this is the case, the
+ * memory for the dentry tree is not freed when switching to a different
+ * WIM image. */
+ u8 modified : 1;
+
+ /* True iff this image has been mounted read-write. */
+ u8 has_been_mounted_rw : 1;
};
/* The opaque structure exposed to the wimlib API. */
-typedef struct WIMStruct {
+struct WIMStruct {
/* A pointer to the file indicated by @filename, opened for reading. */
- FILE *fp;
+ FILE *fp;
+
+#ifdef WITH_FUSE
+ /* Extra file pointers to be used by concurrent readers */
+ FILE **fp_tab;
+ size_t num_allocated_fps;
+ pthread_mutex_t fp_tab_mutex;
+#endif
- /* FILE pointer for the WIM file that is being written. */
- FILE *out_fp;
+ /* FILE pointer for the WIM file (if any) currently being written. */
+ FILE *out_fp;
/* The name of the WIM file that has been opened. */
- char *filename;
+ char *filename;
- /* The lookup table for the WIM file. */
+ /* The lookup table for the WIM file. */
struct lookup_table *lookup_table;
/* Pointer to the XML data read from the WIM file. */
- u8 *xml_data;
+ u8 *xml_data;
- /* Information retrieved from the XML data, arranged
- * in an orderly manner. */
- struct wim_info *wim_info;
+ /* Information retrieved from the XML data, arranged in an orderly
+ * manner. */
+ struct wim_info *wim_info;
- /* Array of the image metadata of length image_count. Each image in the
- * WIM has a image metadata associated with it. */
- struct image_metadata *image_metadata;
+ /* Array of the image metadata, one for each image in the WIM. */
+ struct image_metadata *image_metadata;
/* The header of the WIM file. */
- struct wim_header hdr;
+ struct wim_header hdr;
- /* Temporary flags to use when extracting a WIM image or adding a WIM
- * image. */
+ /* Temporary fields */
union {
- int extract_flags;
- int add_flags;
- int write_flags;
bool write_metadata;
- ntfs_volume *ntfs_vol;
+ void *private;
};
+#ifdef WITH_NTFS_3G
+ struct _ntfs_volume *ntfs_vol;
+#endif
/* The currently selected image, indexed starting at 1. If not 0,
* subtract 1 from this to get the index of the current image in the
* image_metadata array. */
int current_image;
-} WIMStruct;
+ u8 deletion_occurred : 1;
+ u8 all_images_verified : 1;
+ u8 full_verification_in_progress : 1;
+};
/* Inline utility functions for WIMStructs. */
return w->image_metadata[w->current_image - 1].security_data;
}
-static inline struct lookup_table_entry*
-wim_metadata_lookup_table_entry(WIMStruct *w)
+static inline struct image_metadata *
+wim_get_current_image_metadata(WIMStruct *w)
{
- return w->image_metadata[w->current_image - 1].metadata_lte;
+ return &w->image_metadata[w->current_image - 1];
}
/* Nonzero if a struct resource_entry indicates a compressed resource. */
return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
}
-static inline struct image_metadata *
-wim_get_current_image_metadata(WIMStruct *w)
-{
- return &w->image_metadata[w->current_image - 1];
-}
+/* add_image.c */
struct pattern_list {
const char **pats;
char *prefix;
size_t prefix_len;
};
+extern bool exclude_path(const char *path,
+ const struct capture_config *config,
+ bool exclude_prefix);
+extern int add_new_dentry_tree(WIMStruct *dest_wim, struct dentry *root,
+ struct wim_security_data *sd);
+
+/* extract_image.c */
+
+/* Internal use only */
+#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
+#define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
+#define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
/* hardlink.c */
-struct link_group_table *new_link_group_table(u64 capacity);
-int link_group_table_insert(struct dentry *dentry,
- void *__table);
-void free_link_group_table(struct link_group_table *table);
-u64 assign_link_groups(struct link_group_table *table);
-int link_groups_free_duplicate_data(struct link_group_table *table);
+extern u64 assign_inode_numbers(struct hlist_head *inode_list);
+extern int dentry_tree_fix_inodes(struct dentry *root,
+ struct hlist_head *inode_list);
/* header.c */
extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
extern int init_header(struct wim_header *hdr, int ctype);
/* integrity.c */
-extern int write_integrity_table(FILE *out, u64 end_header_offset,
- u64 end_lookup_table_offset,
- int show_progress);
-extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
-/* modify.c */
-extern void destroy_image_metadata(struct image_metadata *imd,
- struct lookup_table *lt);
-extern bool exclude_path(const char *path,
- const struct capture_config *config,
- bool exclude_prefix);
-extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
- const char *config_str, size_t config_len,
- int flags,
- int (*capture_tree)(struct dentry **, const char *,
- struct lookup_table *,
- struct wim_security_data *,
- const struct capture_config *,
- int, void *),
- void *extra_arg);
+#define WIM_INTEGRITY_OK 0
+#define WIM_INTEGRITY_NOT_OK -1
+#define WIM_INTEGRITY_NONEXISTENT -2
+
+extern int write_integrity_table(FILE *out,
+ struct resource_entry *integrity_res_entry,
+ off_t new_lookup_table_end,
+ off_t old_lookup_table_end,
+ wimlib_progress_func_t progress_func);
+
+extern int check_wim_integrity(WIMStruct *w,
+ wimlib_progress_func_t progress_func);
+
+/* join.c */
+
+extern int new_joined_lookup_table(WIMStruct *w,
+ WIMStruct **additional_swms,
+ unsigned num_additional_swms,
+ struct lookup_table **table_ret);
+
+/* metadata_resource.c */
+
+extern int read_metadata_resource(WIMStruct *w,
+ struct image_metadata *image_metadata);
+extern int write_metadata_resource(WIMStruct *w);
+
+/* ntfs-apply.c */
+
+struct apply_args {
+ WIMStruct *w;
+ const char *target;
+ int extract_flags;
+ unsigned num_lutimes_warnings;
+ struct list_head *stream_list;
+ union wimlib_progress_info progress;
+#ifdef WITH_NTFS_3G
+ struct _ntfs_volume *vol;
+#endif
+ struct list_head empty_files;
+ wimlib_progress_func_t progress_func;
+};
+
+extern int apply_dentry_ntfs(struct dentry *dentry, void *arg);
+extern int apply_dentry_timestamps_ntfs(struct dentry *dentry, void *arg);
+
+/* ntfs-capture.c */
+extern int build_dentry_tree_ntfs(struct dentry **root_p,
+ const char *device,
+ struct lookup_table *lookup_table,
+ struct wim_security_data *sd,
+ const struct capture_config *config,
+ int add_image_flags,
+ wimlib_progress_func_t progress_func,
+ void *extra_arg);
/* resource.c */
+
+#define WIMLIB_RESOURCE_FLAG_RAW 0x1
+#define WIMLIB_RESOURCE_FLAG_MULTITHREADED 0x2
+#define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
+
extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
- size_t size, u64 offset, bool raw);
+ size_t size, u64 offset, int flags);
-extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]);
+extern int read_full_wim_resource(const struct lookup_table_entry *lte,
+ u8 buf[], int flags);
-extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
- int fd, u64 size);
+extern int write_wim_resource(struct lookup_table_entry *lte,
+ FILE *out_fp, int out_ctype,
+ struct resource_entry *out_res_entry,
+ int flags);
-extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
- int fd);
+typedef int (*extract_chunk_func_t)(const u8 *, size_t, u64, void *);
-extern int read_metadata_resource(FILE *fp, int wim_ctype,
- struct image_metadata *image_metadata);
+extern int extract_wim_chunk_to_fd(const u8 *buf, size_t len,
+ u64 offset, void *arg);
+
+extern int extract_wim_resource(const struct lookup_table_entry *lte,
+ u64 size, extract_chunk_func_t extract_chunk,
+ void *extract_chunk_arg);
+/*
+ * Extracts the first @size bytes of the WIM resource specified by @lte to the
+ * open file descriptor @fd.
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
+static inline int
+extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
+ int fd, u64 size)
+{
+ return extract_wim_resource(lte, size,
+ extract_wim_chunk_to_fd, &fd);
+}
extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
extern int copy_resource(struct lookup_table_entry *lte, void *w);
-extern int write_metadata_resource(WIMStruct *w);
/* security.c */
-int read_security_data(const u8 metadata_resource[],
- u64 metadata_resource_len, struct wim_security_data **sd_p);
-
-void print_security_data(const struct wim_security_data *sd);
-u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
-void free_security_data(struct wim_security_data *sd);
+extern int read_security_data(const u8 metadata_resource[],
+ u64 metadata_resource_len,
+ struct wim_security_data **sd_p);
+extern void print_security_data(const struct wim_security_data *sd);
+extern u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
+extern void free_security_data(struct wim_security_data *sd);
/* symlink.c */
-ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
- const WIMStruct *w);
-extern void *make_symlink_reparse_data_buf(const char *symlink_target,
- size_t *len_ret);
-extern int dentry_set_symlink(struct dentry *dentry,
- const char *target,
- struct lookup_table *lookup_table,
- struct lookup_table_entry **lte_ret);
+ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
+ const WIMStruct *w, int read_resource_flags);
+extern int inode_set_symlink(struct inode *inode,
+ const char *target,
+ struct lookup_table *lookup_table,
+ struct lookup_table_entry **lte_ret);
+
+/* verify.c */
+extern int verify_dentry(struct dentry *dentry, void *wim);
+extern int wim_run_full_verifications(WIMStruct *w);
+extern int verify_swm_set(WIMStruct *w,
+ WIMStruct **additional_swms,
+ unsigned num_additional_swms);
/* wim.c */
-extern WIMStruct *new_wim_struct();
-extern int wimlib_select_image(WIMStruct *w, int image);
-extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
+extern int select_wim_image(WIMStruct *w, int image);
extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
+extern void destroy_image_metadata(struct image_metadata *imd,
+ struct lookup_table *lt);
+
/* write.c */
-extern int finish_write(WIMStruct *w, int image, int flags,
- int write_lookup_table);
-extern int begin_write(WIMStruct *w, const char *path, int flags);
+/* Internal use only */
+#define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
+#define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
+#define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
+#define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
+extern int begin_write(WIMStruct *w, const char *path, int write_flags);
+extern void close_wim_writable(WIMStruct *w);
-#include "wimlib.h"
+extern int finish_write(WIMStruct *w, int image, int write_flags,
+ wimlib_progress_func_t progress_func);
+
+#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
+extern int lock_wim(FILE *fp, const char *path);
+#else
+static inline int lock_wim(FILE *fp, const char *path)
+{
+ return 0;
+}
+#endif
#endif /* _WIMLIB_INTERNAL_H */
git://wimlib.net / wimlib / blobdiff