X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib_internal.h;h=49d1cbbc9751eb6c226a4fc764510963b795387b;hp=4271cd492b122a3b456eb521081eb1da2f59228a;hb=5cdd60306facd14cc9dcc24471386451294ca73c;hpb=21a83b1b20f5ae138bc4bb9bdedd80a2a2d92c0a diff --git a/src/wimlib_internal.h b/src/wimlib_internal.h index 4271cd49..49d1cbbc 100644 --- a/src/wimlib_internal.h +++ b/src/wimlib_internal.h @@ -11,25 +11,33 @@ * 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" + +#ifdef WITH_FUSE +#include +#endif struct stat; +struct dentry; +struct inode; #define WIM_MAGIC_LEN 8 #define WIM_GID_LEN 16 @@ -47,11 +55,9 @@ struct stat; * 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, -}; +#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 { @@ -71,24 +77,31 @@ struct resource_entry { /* 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; @@ -106,7 +119,7 @@ struct wim_header { * WIM_CHUNK_SIZE. M$ 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]; @@ -132,7 +145,7 @@ struct wim_header { /* 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.*/ @@ -142,8 +155,7 @@ struct wim_header { //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$ */ #define WIM_HDR_FLAG_RESERVED 0x00000001 @@ -151,26 +163,31 @@ struct wim_header { /* Files and metadata in the WIM are compressed. */ #define WIM_HDR_FLAG_COMPRESSION 0x00000002 -/* WIM is read-only. */ +/* WIM is read-only (we ignore this). */ #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. We ignore this + * flag, as we look for file resources in all the WIMs anyway. */ #define WIM_HDR_FLAG_RESOURCE_ONLY 0x00000010 -/* The WIM contains metadata only. */ +/* The WIM contains metadata only. We ignore 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. We + * ignore this flag. */ +#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. We ignore 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 @@ -181,6 +198,9 @@ struct wim_header { * a LZ77-based algorithm. */ #define WIM_HDR_FLAG_COMPRESS_LZX 0x00040000 +#ifdef WITH_NTFS_3G +struct _ntfs_volume; +#endif /* Structure for security data. Each image in the WIM file has its own security * data. */ @@ -190,8 +210,11 @@ struct wim_security_data { * that wimlib writes, currently), it will be 8 bytes. */ 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; @@ -204,7 +227,7 @@ struct wim_security_data { u32 refcnt; }; -struct link_group_table; +struct inode_table; /* Metadata resource for an image. */ @@ -215,62 +238,76 @@ 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; + struct hlist_head inode_list; + /* 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; + u8 modified : 1; + 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. */ typedef 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 *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; + 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; + 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; + bool write_metadata; + 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; - bool write_metadata; + /* %true iff any images have been deleted from this WIM. */ + bool deletion_occurred; } WIMStruct; @@ -281,12 +318,13 @@ static inline struct dentry *wim_root_dentry(WIMStruct *w) return w->image_metadata[w->current_image - 1].root_dentry; } -static inline struct dentry **wim_root_dentry_p(WIMStruct *w) +static inline struct wim_security_data * +wim_security_data(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 wim_security_data *wim_security_data(WIMStruct *w) +static inline const struct wim_security_data * +wim_const_security_data(const WIMStruct *w) { return w->image_metadata[w->current_image - 1].security_data; } @@ -303,19 +341,60 @@ static inline int resource_is_compressed(const struct resource_entry *entry) return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED); } -static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w) +static inline struct image_metadata * +wim_get_current_image_metadata(WIMStruct *w) { return &w->image_metadata[w->current_image - 1]; } +struct pattern_list { + const char **pats; + size_t num_pats; + size_t num_allocated_pats; +}; + +struct capture_config { + struct pattern_list exclusion_list; + struct pattern_list exclusion_exception; + struct pattern_list compression_exclusion_list; + struct pattern_list alignment_list; + char *config_str; + char *prefix; + size_t prefix_len; +}; + /* 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); +/* 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; +}; + +int init_inode_table(struct inode_table *table, size_t capacity); +static inline void destroy_inode_table(struct inode_table *table) +{ + FREE(table->array); +} +int inode_table_insert(struct dentry *dentry, void *__table); +u64 assign_inode_numbers(struct hlist_head *inode_list); +int fix_inodes(struct inode_table *table, struct hlist_head *inode_list); /* header.c */ @@ -324,14 +403,38 @@ extern int write_header(const struct wim_header *hdr, FILE *out); 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); - +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, + bool show_progress); +extern int check_wim_integrity(WIMStruct *w, bool show_progress); + +/* join.c */ + +extern int new_joined_lookup_table(WIMStruct *w, + WIMStruct **additional_swms, + unsigned num_additional_swms, + struct lookup_table **table_ret); + +extern int verify_swm_set(WIMStruct *w, + WIMStruct **additional_swms, + unsigned num_additional_swms); /* 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); /* resource.c */ extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry); @@ -340,9 +443,15 @@ 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); + size_t size, u64 offset, int flags); + +extern int read_full_wim_resource(const struct lookup_table_entry *lte, + u8 buf[], int flags); -extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]); +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_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd, u64 size); @@ -351,7 +460,7 @@ extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd); -extern int read_metadata_resource(FILE *fp, int wim_ctype, +extern int read_metadata_resource(WIMStruct *w, struct image_metadata *image_metadata); @@ -361,7 +470,7 @@ extern int write_metadata_resource(WIMStruct *w); /* security.c */ -int read_security_data(const u8 metadata_resource[], +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); @@ -369,26 +478,47 @@ u8 *write_security_data(const struct wim_security_data *sd, u8 *p); 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); +ssize_t inode_readlink(const struct 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 dentry_set_symlink(struct dentry *dentry, - const char *target, - struct lookup_table *lookup_table, - struct lookup_table_entry **lte_ret); +extern int inode_set_symlink(struct inode *inode, + const char *target, + struct lookup_table *lookup_table, + struct lookup_table_entry **lte_ret); + +extern void show_stream_op_progress(u64 *cur_size, u64 *next_size, + u64 total_size, u64 one_percent, + unsigned *cur_percent, + const struct lookup_table_entry *cur_lte, + const char *op); + +extern void finish_stream_op_progress(u64 total_size, const char *op); /* wim.c */ extern WIMStruct *new_wim_struct(); -extern int wimlib_select_image(WIMStruct *w, int image); +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 int open_wim_readable(WIMStruct *w, const char *path); +extern int open_wim_writable(WIMStruct *w, const char *path, + bool trunc, bool readable); -/* write.c */ -extern int finish_write(WIMStruct *w, int image, int flags, - int write_lookup_table); +/* 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 flags); +/* Internal use only */ +#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000 +#define WIMLIB_EXTRACT_FLAG_NO_STREAMS 0x40000000 +#define WIMLIB_EXTRACT_MASK_PUBLIC 0x2fffffff + + +/* write.c */ +extern int begin_write(WIMStruct *w, const char *path, int write_flags); +extern int finish_write(WIMStruct *w, int image, int write_flags); #include "wimlib.h"