*/
/*
- * Copyright (C) 2010 Carl Thijssen
* Copyright (C) 2012 Eric Biggers
*
* This file is part of wimlib, a library for working with WIM files.
#include "config.h"
#include "util.h"
#include "list.h"
-
#include "wimlib.h"
#ifdef WITH_FUSE
#include <pthread.h>
#endif
+#define WIMLIB_MAKEVERSION(major, minor, patch) \
+ ((major << 20) | (minor << 10) | patch)
+
+
+#define WIMLIB_VERSION_CODE \
+ WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
+ WIMLIB_MINOR_VERSION,\
+ WIMLIB_PATCH_VERSION)
+
+#define WIMLIB_GET_PATCH_VERSION(version) \
+ ((version >> 0) & ((1 << 10) - 1))
+#define WIMLIB_GET_MINOR_VERSION(version) \
+ ((version >> 10) & ((1 << 10) - 1))
+#define WIMLIB_GET_MAJOR_VERSION(version) \
+ ((version >> 20) & ((1 << 10) - 1))
+
+
struct stat;
-struct dentry;
-struct inode;
+struct wim_dentry;
+struct wim_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
-#define WIM_INTEGRITY_OK 0
-#define WIM_INTEGRITY_NOT_OK -1
-#define WIM_INTEGRITY_NONEXISTENT -2
-
/* Metadata for a resource in a WIM file. */
struct resource_entry {
/* Size, in bytes, of the resource in the WIM file. */
* 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 {
/* Identifies the file as WIM file. Must be exactly
//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;
struct _ntfs_volume;
#endif
-/* Structure for security data. Each image in the WIM file has its own security
- * data. */
+/* Table of security descriptors for a WIM image. */
struct wim_security_data {
/* 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). */
+ * security descriptors, this field, when read from the on-disk metadata
+ * resource, 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.
- * 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.) */
+ * It is really an unsigned int on-disk, 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. */
u32 refcnt;
};
-struct inode_table;
+/* Metadata for a WIM image */
+struct wim_image_metadata {
-/* Metadata resource for an image. */
-struct image_metadata {
- /* Pointer to the root dentry for the image. */
- struct dentry *root_dentry;
+ /* Pointer to the root dentry of the image. */
+ struct wim_dentry *root_dentry;
- /* Pointer to the security data for the image. */
+ /* Pointer to the security data of the image. */
struct wim_security_data *security_data;
- /* A pointer to the lookup table entry for this image's metadata
- * resource. */
- struct lookup_table_entry *metadata_lte;
+ /* Pointer to the lookup table entry for this image's metadata resource
+ */
+ struct wim_lookup_table_entry *metadata_lte;
- /* Linked list of inodes for this image. */
+ /* Linked list of inodes of 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. */
+ /* 1 iff the dentry tree has been modified. If this is the case, the
+ * memory for the dentry tree should not be freed when switching to a
+ * different WIM image. */
u8 modified : 1;
- /* True iff this image has been mounted read-write. */
+ /* 1 iff this image has been mounted read-write */
u8 has_been_mounted_rw : 1;
};
-#define WIMLIB_RESOURCE_FLAG_RAW 0x1
-#define WIMLIB_RESOURCE_FLAG_MULTITHREADED 0x2
-#define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4
-
/* The opaque structure exposed to the wimlib API. */
struct WIMStruct {
/* FILE pointer for the WIM file (if any) currently being written. */
FILE *out_fp;
- /* The name of the WIM file that has been opened. */
+ /* The name of the WIM file (if any) that has been opened. */
char *filename;
/* The lookup table for the WIM file. */
- struct lookup_table *lookup_table;
+ struct wim_lookup_table *lookup_table;
/* Pointer to the XML data read from the WIM file. */
u8 *xml_data;
struct wim_info *wim_info;
/* Array of the image metadata, one for each image in the WIM. */
- struct image_metadata *image_metadata;
+ struct wim_image_metadata *image_metadata;
/* The header of the WIM file. */
struct wim_header hdr;
* image_metadata array. */
int current_image;
- /* %true iff any images have been deleted from this WIM. */
- bool deletion_occurred;
-
- bool all_images_verified;
- bool full_verification_in_progress;
+ u8 deletion_occurred : 1;
+ u8 all_images_verified : 1;
+ u8 full_verification_in_progress : 1;
+ u8 wim_locked : 1;
};
-
/* Inline utility functions for WIMStructs. */
-static inline struct dentry *wim_root_dentry(WIMStruct *w)
+static inline struct wim_dentry *wim_root_dentry(WIMStruct *w)
{
return w->image_metadata[w->current_image - 1].root_dentry;
}
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 wim_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;
};
-
-/* add_image.c */
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,
+extern int add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root,
struct wim_security_data *sd);
-/* hardlink.c */
+/* extract_image.c */
-/* Hash table to find inodes, identified by their inode ID.
- * */
-struct inode_table {
- /* Fields for the hash table */
- struct hlist_head *array;
- u64 num_entries;
- u64 capacity;
-
- /*
- * Linked list of "extra" inodes. These may be:
- *
- * - inodes with link count 1, which are all allowed to have 0 for their
- * inode number, meaning we cannot insert them into the hash table
- * before calling assign_inode_numbers().
- *
- * - Groups we create ourselves by splitting a nominal inode due to
- * inconsistencies in the dentries. These inodes will share a inode
- * ID with some other inode until assign_inode_numbers() is called.
- */
- struct hlist_head extra_inodes;
-};
+/* 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 */
-extern int init_inode_table(struct inode_table *table, size_t capacity);
-static inline void destroy_inode_table(struct inode_table *table)
-{
- FREE(table->array);
-}
-extern int inode_table_insert(struct dentry *dentry, void *__table);
extern u64 assign_inode_numbers(struct hlist_head *inode_list);
-extern int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
+
+extern int dentry_tree_fix_inodes(struct wim_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 */
+
+#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,
extern int new_joined_lookup_table(WIMStruct *w,
WIMStruct **additional_swms,
unsigned num_additional_swms,
- struct lookup_table **table_ret);
+ struct wim_lookup_table **table_ret);
-extern int verify_swm_set(WIMStruct *w,
- WIMStruct **additional_swms,
- unsigned num_additional_swms);
-extern int wim_run_full_verifications(WIMStruct *w);
+/* metadata_resource.c */
+
+extern int read_metadata_resource(WIMStruct *w,
+ struct wim_image_metadata *image_metadata);
+extern int write_metadata_resource(WIMStruct *w);
/* ntfs-apply.c */
#ifdef WITH_NTFS_3G
struct _ntfs_volume *vol;
#endif
- struct list_head empty_files;
wimlib_progress_func_t progress_func;
+ int (*apply_dentry)(struct wim_dentry *, void *);
};
-extern int apply_dentry_ntfs(struct dentry *dentry, void *arg);
-extern int apply_dentry_timestamps_ntfs(struct dentry *dentry, void *arg);
+extern int apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
+extern int apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
/* ntfs-capture.c */
-extern int build_dentry_tree_ntfs(struct dentry **root_p,
+extern int build_dentry_tree_ntfs(struct wim_dentry **root_p,
const char *device,
- struct lookup_table *lookup_table,
+ struct wim_lookup_table *lookup_table,
struct wim_security_data *sd,
const struct capture_config *config,
int add_image_flags,
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[],
+extern int read_wim_resource(const struct wim_lookup_table_entry *lte, u8 buf[],
size_t size, u64 offset, int flags);
-extern int read_full_wim_resource(const struct lookup_table_entry *lte,
+extern int read_full_wim_resource(const struct wim_lookup_table_entry *lte,
u8 buf[], int flags);
-extern int write_wim_resource(struct lookup_table_entry *lte,
+extern int write_wim_resource(struct wim_lookup_table_entry *lte,
FILE *out_fp, int out_ctype,
struct resource_entry *out_res_entry,
int flags);
-extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
- int fd, u64 size);
+typedef int (*extract_chunk_func_t)(const u8 *, size_t, u64, void *);
-extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
- int fd);
+extern int extract_wim_chunk_to_fd(const u8 *buf, size_t len,
+ u64 offset, void *arg);
-extern int read_metadata_resource(WIMStruct *w,
- struct image_metadata *image_metadata);
+extern int extract_wim_resource(const struct wim_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 wim_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);
+extern int write_dentry_resources(struct wim_dentry *dentry, void *wim_p);
+extern int copy_resource(struct wim_lookup_table_entry *lte, void *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 inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
+ssize_t inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
const WIMStruct *w, int read_resource_flags);
-extern void *make_symlink_reparse_data_buf(const char *symlink_target,
- size_t *len_ret);
-extern int inode_set_symlink(struct inode *inode,
+extern int inode_set_symlink(struct wim_inode *inode,
const char *target,
- struct lookup_table *lookup_table,
- struct lookup_table_entry **lte_ret);
+ struct wim_lookup_table *lookup_table,
+ struct wim_lookup_table_entry **lte_ret);
+
+/* verify.c */
+extern int verify_dentry(struct wim_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 select_wim_image(WIMStruct *w, int image);
-extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
-extern void destroy_image_metadata(struct image_metadata *imd,
- struct lookup_table *lt);
+extern void destroy_image_metadata(struct wim_image_metadata *imd,
+ struct wim_lookup_table *lt);
+
+/* win32.c */
+
+#if defined(__CYGWIN__) || defined(__WIN32__)
+extern int win32_read_file(const char *filename, void *handle, u64 offset,
+ size_t size, u8 *buf);
+extern void *win32_open_file(const void *path_utf16);
+extern void win32_close_file(void *handle);
+#ifdef ENABLE_ERROR_MESSAGES
+extern void win32_error(u32 err);
+#else
+#define win32_error(err)
+#endif
+#endif
+
+
+/* write.c */
/* Internal use only */
#define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE 0x80000000
#define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML 0x20000000
#define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff
-/* Internal use only */
-#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
-#define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000
-#define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
-
-
-/* write.c */
extern int begin_write(WIMStruct *w, const char *path, int write_flags);
extern void close_wim_writable(WIMStruct *w);
wimlib_progress_func_t progress_func);
#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
-extern int lock_wim(FILE *fp, const char *path);
+extern int lock_wim(WIMStruct *w, FILE *fp);
#else
-static inline int lock_wim(FILE *fp, const char *path)
+static inline int lock_wim(WIMStruct *w, FILE *fp)
{
return 0;
}
git://wimlib.net / wimlib / blobdiff