X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib_internal.h;h=3d7fb488f519fdc55cc4f91ba224337886d80447;hp=0f65a12d1f59a5ddba047a540bb2ba309b1bcfdd;hb=c6a1140e085f633273fcf47a6462bd9382ce118a;hpb=1530b6dab02a9e1e5faf81529ab502aee68d8cd2 diff --git a/src/wimlib_internal.h b/src/wimlib_internal.h index 0f65a12d..3d7fb488 100644 --- a/src/wimlib_internal.h +++ b/src/wimlib_internal.h @@ -5,7 +5,7 @@ */ /* - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * @@ -55,6 +55,7 @@ struct stat; struct wim_dentry; struct wim_inode; +struct sd_set; #define WIM_MAGIC_LEN 8 #define WIM_GID_LEN 16 @@ -214,18 +215,18 @@ struct wim_header { 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. */ @@ -239,29 +240,28 @@ struct wim_security_data { u32 refcnt; }; -struct wim_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. */ + /* 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. */ + /* 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; }; @@ -281,30 +281,28 @@ 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. */ - char *filename; + /* The name of the WIM file (if any) that has been opened. */ + tchar *filename; /* The lookup table for the WIM file. */ struct wim_lookup_table *lookup_table; - /* Pointer to the XML data read from the WIM file. */ - u8 *xml_data; + /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */ + utf16lechar *xml_data; /* Information retrieved from the XML data, arranged in an orderly * manner. */ 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; - /* Temporary fields */ - union { - bool write_metadata; - void *private; - }; + /* Temporary field */ + void *private; + #ifdef WITH_NTFS_3G struct _ntfs_volume *ntfs_vol; #endif @@ -316,13 +314,13 @@ struct WIMStruct { 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 wim_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; } @@ -338,40 +336,30 @@ wim_const_security_data(const WIMStruct *w) return w->image_metadata[w->current_image - 1].security_data; } -static inline struct image_metadata * +static inline struct wim_image_metadata * wim_get_current_image_metadata(WIMStruct *w) { return &w->image_metadata[w->current_image - 1]; } /* Nonzero if a struct resource_entry indicates a compressed resource. */ -static inline int resource_is_compressed(const struct resource_entry *entry) +static inline int +resource_is_compressed(const struct resource_entry *entry) { return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED); } /* add_image.c */ -struct pattern_list { - const char **pats; - size_t num_pats; - size_t num_allocated_pats; -}; +extern bool +exclude_path(const tchar *path, size_t path_len, + const struct wimlib_capture_config *config, + bool exclude_prefix); + +extern int +add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root, + struct wim_security_data *sd); -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; -}; -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 wim_dentry *root, - struct wim_security_data *sd); /* extract_image.c */ @@ -382,15 +370,60 @@ extern int add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root, /* hardlink.c */ -extern u64 assign_inode_numbers(struct hlist_head *inode_list); +/* Hash table to find inodes, given an inode number (in the case of reading + * a WIM images), or both an inode number and a device number (in the case of + * capturing a WIM image). */ +struct wim_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. + * + * - Groups we create ourselves by splitting a nominal inode due to + * inconsistencies in the dentries. These inodes will share an inode + * number with some other inode until assign_inode_numbers() is + * called. + */ + struct hlist_head extra_inodes; +}; + +extern int +init_inode_table(struct wim_inode_table *table, size_t capacity); + +extern int +inode_table_new_dentry(struct wim_inode_table *table, const tchar *name, + u64 ino, u64 devno, struct wim_dentry **dentry_ret); + +extern void +inode_table_prepare_inode_list(struct wim_inode_table *table, + struct hlist_head *head); + +static inline void +destroy_inode_table(struct wim_inode_table *table) +{ + FREE(table->array); +} -extern int dentry_tree_fix_inodes(struct wim_dentry *root, - 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 write_header(const struct wim_header *hdr, FILE *out); -extern int init_header(struct wim_header *hdr, int ctype); + +extern int +read_header(FILE *fp, struct wim_header *hdr, int split_ok); + +extern int +write_header(const struct wim_header *hdr, FILE *out); + +extern int +init_header(struct wim_header *hdr, int ctype); /* integrity.c */ @@ -398,57 +431,80 @@ extern int init_header(struct wim_header *hdr, int ctype); #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 +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); +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 wim_lookup_table **table_ret); +extern int +new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms, + unsigned num_additional_swms, + struct wim_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); +extern int +read_metadata_resource(WIMStruct *w, + struct wim_image_metadata *image_metadata); + +extern int +write_metadata_resource(WIMStruct *w); /* ntfs-apply.c */ struct apply_args { WIMStruct *w; - const char *target; + const tchar *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; int (*apply_dentry)(struct wim_dentry *, void *); + union { + #ifdef WITH_NTFS_3G + struct { + /* NTFS apply only */ + struct _ntfs_volume *vol; + }; + #endif + struct { + /* Normal apply only (UNIX) */ + unsigned long num_utime_warnings; + }; + + struct { + /* Normal apply only (Win32) */ + unsigned long num_set_sacl_priv_notheld; + unsigned long num_set_sd_access_denied; + }; + }; }; -extern int apply_dentry_ntfs(struct wim_dentry *dentry, void *arg); -extern int apply_dentry_timestamps_ntfs(struct wim_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); + +extern void +libntfs3g_global_init(); /* ntfs-capture.c */ -extern int build_dentry_tree_ntfs(struct wim_dentry **root_p, - const char *device, - struct wim_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); +extern int +build_dentry_tree_ntfs(struct wim_dentry **root_p, + const tchar *device, + struct wim_lookup_table *lookup_table, + struct wim_inode_table *inode_table, + struct sd_set *sd_set, + const struct wimlib_capture_config *config, + int add_image_flags, + wimlib_progress_func_t progress_func, + void *extra_arg); /* resource.c */ @@ -456,31 +512,39 @@ extern int build_dentry_tree_ntfs(struct wim_dentry **root_p, #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 const u8 * +get_resource_entry(const u8 *p, struct resource_entry *entry); -extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]); +extern u8 * +put_resource_entry(u8 *p, const struct resource_entry *entry); -extern int read_wim_resource(const struct wim_lookup_table_entry *lte, u8 buf[], - size_t size, u64 offset, int flags); +extern int +read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf); -extern int read_full_wim_resource(const struct wim_lookup_table_entry *lte, - u8 buf[], int flags); +extern int +read_wim_resource(const struct wim_lookup_table_entry *lte, void *buf, + size_t size, u64 offset, int flags); -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 +read_full_wim_resource(const struct wim_lookup_table_entry *lte, + void *buf, int flags); +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); -typedef int (*extract_chunk_func_t)(const u8 *, size_t, u64, void *); -extern int extract_wim_chunk_to_fd(const u8 *buf, size_t len, - u64 offset, void *arg); +typedef int (*extract_chunk_func_t)(const void *, size_t, u64, void *); + +extern int +extract_wim_chunk_to_fd(const void *buf, size_t len, u64 offset, void *arg); + +extern int +extract_wim_resource(const struct wim_lookup_table_entry *lte, + u64 size, extract_chunk_func_t extract_chunk, + void *extract_chunk_arg); -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. @@ -496,39 +560,62 @@ extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte, } -extern int write_dentry_resources(struct wim_dentry *dentry, void *wim_p); -extern int copy_resource(struct wim_lookup_table_entry *lte, void *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 */ -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); +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 wim_inode *inode, char *buf, size_t buf_len, - const WIMStruct *w, int read_resource_flags); -extern int inode_set_symlink(struct wim_inode *inode, - const char *target, - struct wim_lookup_table *lookup_table, - struct wim_lookup_table_entry **lte_ret); + +#ifndef __WIN32__ +ssize_t +inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len, + const WIMStruct *w, int read_resource_flags); + +extern int +inode_set_symlink(struct wim_inode *inode, const char *target, + struct wim_lookup_table *lookup_table, + struct wim_lookup_table_entry **lte_ret); +#endif /* 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); + +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 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 wim_lookup_table *lt); +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 wim_image_metadata *imd, + struct wim_lookup_table *lt); /* write.c */ @@ -538,16 +625,30 @@ extern void destroy_image_metadata(struct image_metadata *imd, #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); +/* We are capturing a tree to be placed in the root of the WIM image */ +#define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000 -extern int finish_write(WIMStruct *w, int image, int write_flags, - wimlib_progress_func_t progress_func); +/* We are capturing a dentry that will become the root of a tree to be added to + * the WIM image */ +#define WIMLIB_ADD_IMAGE_FLAG_SOURCE 0x40000000 + + +extern int +begin_write(WIMStruct *w, const tchar *path, int write_flags); + +extern void +close_wim_writable(WIMStruct *w); + +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(WIMStruct *w, FILE *fp); +extern int +lock_wim(WIMStruct *w, FILE *fp); #else -static inline int lock_wim(WIMStruct *w, FILE *fp) +static inline int +lock_wim(WIMStruct *w, FILE *fp) { return 0; }