X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fwimlib_internal.h;h=55fcd8f308ad17d3dbb8fc884ce66b10337f0587;hb=5e2f9715d5c0e1f1c3fc30a53d14df69a8bdae4a;hp=a7ac5dc2cf302e78630f9694cbea34885c839de8;hpb=f3e97b29c4a8c564d54b0fd11cd43a9b4cd6a8ad;p=wimlib diff --git a/src/wimlib_internal.h b/src/wimlib_internal.h index a7ac5dc2..55fcd8f3 100644 --- a/src/wimlib_internal.h +++ b/src/wimlib_internal.h @@ -31,7 +31,7 @@ #include "list.h" #include "wimlib.h" -#ifdef WITH_FUSE +#if defined(WITH_FUSE) || defined(ENABLE_MULTITHREADED_COMPRESSION) #include #endif @@ -72,6 +72,8 @@ struct sd_set; * yet. The differences between the versions are undocumented. */ #define WIM_VERSION 0x10d00 +#define REPARSE_POINT_MAX_SIZE (16 * 1024) + /* Metadata for a resource in a WIM file. */ struct resource_entry { /* Size, in bytes, of the resource in the WIM file. */ @@ -195,9 +197,11 @@ struct wim_header { * file (if supported by the underlying filesystem). */ #define WIM_HDR_FLAG_WRITE_IN_PROGRESS 0x00000040 -/* 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. */ +/* Reparse point fixup flag. See docs for --rpfix and --norpfix in imagex, or + * WIMLIB_ADD_IMAGE_FLAG_{RPFIX,NORPFIX} in wimlib.h. Note that + * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for + * the WIM; it can still be overridder on a per-image basis. But there is no + * flag to set the default behavior for a specific image. */ #define WIM_HDR_FLAG_RP_FIX 0x00000080 /* Unused, reserved flag for another compression type */ @@ -268,25 +272,22 @@ struct wim_image_metadata { * different WIM image. */ u8 modified : 1; - /* 1 iff this image has been mounted read-write */ - u8 has_been_mounted_rw : 1; +#ifdef WITH_NTFS_3G + struct _ntfs_volume *ntfs_vol; +#endif }; /* The opaque structure exposed to the wimlib API. */ struct WIMStruct { - /* A pointer to the file indicated by @filename, opened for reading. */ - FILE *fp; + /* File descriptor for the WIM file, opened for reading, or -1 if it has + * not been opened or there is no associated file backing it yet. */ + int in_fd; -#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 (if any) currently being written. */ - FILE *out_fp; + /* File descriptor, opened either for writing only or for + * reading+writing, for the WIM file (if any) currently being written. + * */ + int out_fd; /* The name of the WIM file (if any) that has been opened. */ tchar *filename; @@ -294,9 +295,6 @@ struct WIMStruct { /* The lookup table for the WIM file. */ struct wim_lookup_table *lookup_table; - /* 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; @@ -310,10 +308,6 @@ struct WIMStruct { /* Temporary field */ 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. */ @@ -363,43 +357,45 @@ resource_is_compressed(const struct resource_entry *entry) return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED); } +/* Iterate over each inode in a WIM image that has not yet been hashed */ #define image_for_each_inode(inode, imd) \ list_for_each_entry(inode, &imd->inode_list, i_list) +/* Iterate over each stream in a WIM image that has not yet been hashed */ #define image_for_each_unhashed_stream(lte, imd) \ list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list) +/* Iterate over each stream in a WIM image that has not yet been hashed (safe + * against stream removal) */ +#define image_for_each_unhashed_stream_safe(lte, tmp, imd) \ + list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list) + #if 1 # define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry)) +# define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry)) #else static inline void copy_resource_entry(struct resource_entry *dst, const struct resource_entry *src) { - memcpy(dst, src, sizeof(struct resource_entry)); BUILD_BUG_ON(sizeof(struct resource_entry) != 24); ((u64*)dst)[0] = ((u64*)src)[0]; ((u64*)dst)[1] = ((u64*)src)[1]; ((u64*)dst)[2] = ((u64*)src)[2]; } + +static inline void +zero_resource_entry(struct resource_entry *entry) +{ + BUILD_BUG_ON(sizeof(struct resource_entry) != 24); + ((u64*)entry)[0] = 0; + ((u64*)entry)[1] = 0; + ((u64*)entry)[2] = 0; +} #endif /* add_image.c */ -extern bool -exclude_path(const tchar *path, size_t path_len, - const struct wimlib_capture_config *config, - bool exclude_prefix); - -/* 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 */ - /* 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). */ @@ -423,12 +419,72 @@ struct wim_inode_table { struct list_head extra_inodes; }; +/* Common parameters to implementations of building an in-memory dentry tree + * from an on-disk directory structure. */ +struct add_image_params { + /* Pointer to the lookup table of the WIM. */ + struct wim_lookup_table *lookup_table; + + /* Pointer to a hash table of inodes that have been captured for this + * WIM image so far. */ + struct wim_inode_table *inode_table; + + /* Pointer to the set of security descriptors that have been captured + * for this image so far. */ + struct sd_set *sd_set; + + /* Pointer to the capture configuration, which indicates whether any + * files should be excluded from capture or not. */ + const struct wimlib_capture_config *config; + + /* Flags that affect the capture operation (WIMLIB_ADD_IMAGE_FLAG_*) */ + int add_image_flags; + + /* If non-NULL, the user-supplied progress function. */ + wimlib_progress_func_t progress_func; + + /* Extra argument; set to point to a pointer to the ntfs_volume for + * libntfs-3g capture. */ + void *extra_arg; + + u64 capture_root_ino; + u64 capture_root_dev; +}; + + +/* capture_common.c */ + +extern bool +exclude_path(const tchar *path, size_t path_len, + const struct wimlib_capture_config *config, + bool exclude_prefix); + +extern struct wimlib_capture_config * +copy_capture_config(const struct wimlib_capture_config *config); + +extern int +copy_and_canonicalize_capture_config(const struct wimlib_capture_config *config, + struct wimlib_capture_config **config_copy_ret); + +extern void +free_capture_config(struct wimlib_capture_config *config); + +/* 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 */ + 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); + u64 ino, u64 devno, bool noshare, + struct wim_dentry **dentry_ret); extern void inode_ref_streams(struct wim_inode *inode); @@ -450,10 +506,11 @@ dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list); /* header.c */ extern int -read_header(FILE *fp, struct wim_header *hdr, int split_ok); +read_header(const tchar *filename, int in_fd, struct wim_header *hdr, + int split_ok); extern int -write_header(const struct wim_header *hdr, FILE *out); +write_header(const struct wim_header *hdr, int out_fd); extern int init_header(struct wim_header *hdr, int ctype); @@ -465,7 +522,8 @@ init_header(struct wim_header *hdr, int ctype); #define WIM_INTEGRITY_NONEXISTENT -2 extern int -write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry, +write_integrity_table(int fd, + struct resource_entry *integrity_res_entry, off_t new_lookup_table_end, off_t old_lookup_table_end, wimlib_progress_func_t progress_func); @@ -494,6 +552,11 @@ write_metadata_resource(WIMStruct *w); struct apply_args { WIMStruct *w; const tchar *target; + unsigned target_nchars; + unsigned wim_source_path_nchars; + struct wim_dentry *extract_root; + tchar *target_realpath; + unsigned target_realpath_len; int extract_flags; union wimlib_progress_info progress; wimlib_progress_func_t progress_func; @@ -505,16 +568,22 @@ struct apply_args { struct _ntfs_volume *vol; }; #endif - struct { - /* Normal apply only (UNIX) */ - unsigned long num_utime_warnings; - }; - + #ifdef __WIN32__ struct { /* Normal apply only (Win32) */ unsigned long num_set_sacl_priv_notheld; unsigned long num_set_sd_access_denied; + unsigned vol_flags; + unsigned long num_hard_links_failed; + unsigned long num_soft_links_failed; + bool have_vol_flags; }; + #else + struct { + /* Normal apply only (UNIX) */ + unsigned long num_utime_warnings; + }; + #endif }; }; @@ -529,7 +598,6 @@ libntfs3g_global_init(); /* ntfs-capture.c */ -/* The types of these two callbacks are intentionally the same. */ typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx); extern int @@ -541,20 +609,85 @@ read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte, 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); + struct add_image_params *ctx); + +#ifdef WITH_NTFS_3G +extern int +do_ntfs_umount(struct _ntfs_volume *vol); +#endif + +/* reparse.c */ + +/* Structured format for symbolic link, junction point, or mount point reparse + * data. */ +struct reparse_data { + /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */ + u32 rptag; + + /* Length of reparse data, not including the 8-byte header (ReparseTag, + * ReparseDataLength, ReparseReserved) */ + u16 rpdatalen; + + /* ReparseReserved */ + u16 rpreserved; + + /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points). + * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link; + * otherwise should be set to 0. */ +#define SYMBOLIC_LINK_RELATIVE 0x00000001 + u32 rpflags; + + /* Pointer to the substitute name of the link (UTF-16LE). */ + utf16lechar *substitute_name; + + /* Pointer to the print name of the link (UTF-16LE). */ + utf16lechar *print_name; + + /* Number of bytes of the substitute name, not including null terminator + * if present */ + u16 substitute_name_nbytes; + + /* Number of bytes of the print name, not including null terminator if + * present */ + u16 print_name_nbytes; +}; + +enum { + SUBST_NAME_IS_RELATIVE_LINK = -1, + SUBST_NAME_IS_VOLUME_JUNCTION = -2, + SUBST_NAME_IS_UNKNOWN = -3, +}; +extern int +parse_substitute_name(const utf16lechar *substitute_name, + u16 substitute_name_nbytes, + u32 rptag); + +extern int +parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata); + +extern int +make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf); + +extern int +wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf); + +#ifndef __WIN32__ +ssize_t +wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len); + +extern int +wim_inode_set_symlink(struct wim_inode *inode, const char *target, + struct wim_lookup_table *lookup_table); +#endif +extern tchar * +capture_fixup_absolute_symlink(tchar *dest, + u64 capture_root_ino, u64 capture_root_dev); + /* resource.c */ #define WIMLIB_RESOURCE_FLAG_RAW 0x1 -#define WIMLIB_RESOURCE_FLAG_THREADSAFE_READ 0x2 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS 0x4 -//#define WIMLIB_RESOURCE_FLAG_OVERWRITE_INPLACE 0x8 extern int read_resource_prefix(const struct wim_lookup_table_entry *lte, @@ -567,19 +700,14 @@ get_resource_entry(const void *p, struct resource_entry *entry); extern void * put_resource_entry(void *p, const struct resource_entry *entry); -extern int -read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf); - extern int read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte, - size_t size, u64 offset, void *buf, - bool threadsafe); + size_t size, u64 offset, void *buf); extern int -read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, - void *buf, bool thread_safe); +read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf); extern int -write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp, +write_wim_resource(struct wim_lookup_table_entry *lte, int out_fd, int out_ctype, struct resource_entry *out_res_entry, int flags); @@ -593,10 +721,16 @@ extern int extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte, int fd, u64 size); +extern int +sha1_resource(struct wim_lookup_table_entry *lte); + extern int copy_resource(struct wim_lookup_table_entry *lte, void *w); /* security.c */ +extern struct wim_security_data * +new_wim_security_data(); + extern int read_security_data(const u8 metadata_resource[], u64 metadata_resource_len, struct wim_security_data **sd_p); @@ -609,19 +743,18 @@ write_security_data(const struct wim_security_data *sd, u8 *p); extern void free_security_data(struct wim_security_data *sd); -/* symlink.c */ - +/* unix_capture.c */ #ifndef __WIN32__ -ssize_t -inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len, - const WIMStruct *w, bool threadsafe); - 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); +unix_build_dentry_tree(struct wim_dentry **root_ret, + const char *root_disk_path, + struct add_image_params *params); #endif +/* update_image.c */ +extern int +rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to); + /* verify.c */ extern int @@ -660,23 +793,26 @@ new_image_metadata(); extern struct wim_image_metadata ** new_image_metadata_array(unsigned num_images); +extern int +wim_checksum_unhashed_streams(WIMStruct *w); + +extern int +reopen_wim(WIMStruct *w); + +extern int +close_wim(WIMStruct *w); + /* write.c */ /* 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_FLAG_OVERWRITE_INPLACE 0x10000000 -#define WIMLIB_WRITE_MASK_PUBLIC 0x0fffffff +#define WIMLIB_WRITE_MASK_PUBLIC 0x1fffffff /* We are capturing a tree to be placed in the root of the WIM image */ #define WIMLIB_ADD_IMAGE_FLAG_ROOT 0x80000000 -/* 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); @@ -689,10 +825,10 @@ finish_write(WIMStruct *w, int image, int write_flags, #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK) extern int -lock_wim(WIMStruct *w, FILE *fp); +lock_wim(WIMStruct *w, int fd); #else static inline int -lock_wim(WIMStruct *w, FILE *fp) +lock_wim(WIMStruct *w, int fd) { return 0; }