X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fdentry.h;h=3a3432eadbeafe36a41839235404b53b33884d2f;hb=ecdb6a689808479505db2761337493955269737b;hp=cf36e2256ed5e7ed498f1128e78059009b59e9d7;hpb=6f7956a06fcf92a304fae93e393e8eaee34e92d5;p=wimlib diff --git a/src/dentry.h b/src/dentry.h index cf36e225..3a3432ea 100644 --- a/src/dentry.h +++ b/src/dentry.h @@ -2,10 +2,95 @@ #define _WIMLIB_DENTRY_H #include "util.h" +#include "config.h" +#include "list.h" #include + +struct stat; +struct lookup_table; +typedef struct WIMStruct WIMStruct; + /* Size of the struct dentry up to and including the file_name_len. */ -#define WIM_DENTRY_DISK_SIZE 102 +#define WIM_DENTRY_DISK_SIZE 102 + +#define WIM_ADS_ENTRY_DISK_SIZE 38 + +#ifndef WIM_HASH_SIZE +#define WIM_HASH_SIZE 20 +#endif + +/* + * Reparse tags documented at + * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx + */ +#define WIM_IO_REPARSE_TAG_RESERVED_ZERO 0x00000000 +#define WIM_IO_REPARSE_TAG_RESERVED_ONE 0x00000001 +#define WIM_IO_REPARSE_TAG_MOUNT_POINT 0xA0000003 +#define WIM_IO_REPARSE_TAG_HSM 0xC0000004 +#define WIM_IO_REPARSE_TAG_HSM2 0x80000006 +#define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005 +#define WIM_IO_REPARSE_TAG_SIS 0x80000007 +#define WIM_IO_REPARSE_TAG_DFS 0x8000000A +#define WIM_IO_REPARSE_TAG_DFSR 0x80000012 +#define WIM_IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B +#define WIM_IO_REPARSE_TAG_SYMLINK 0xA000000C + +#define FILE_ATTRIBUTE_READONLY 0x00000001 +#define FILE_ATTRIBUTE_HIDDEN 0x00000002 +#define FILE_ATTRIBUTE_SYSTEM 0x00000004 +#define FILE_ATTRIBUTE_DIRECTORY 0x00000010 +#define FILE_ATTRIBUTE_ARCHIVE 0x00000020 +#define FILE_ATTRIBUTE_DEVICE 0x00000040 +#define FILE_ATTRIBUTE_NORMAL 0x00000080 +#define FILE_ATTRIBUTE_TEMPORARY 0x00000100 +#define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200 +#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400 +#define FILE_ATTRIBUTE_COMPRESSED 0x00000800 +#define FILE_ATTRIBUTE_OFFLINE 0x00001000 +#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000 +#define FILE_ATTRIBUTE_ENCRYPTED 0x00004000 +#define FILE_ATTRIBUTE_VIRTUAL 0x00010000 + +/* Alternate data stream entry */ +struct ads_entry { + /* SHA-1 message digest of stream contents */ + u8 hash[WIM_HASH_SIZE]; + + /* Length of stream name (UTF-16) */ + u16 stream_name_len; + + /* Length of stream name (UTF-8) */ + u16 stream_name_utf8_len; + + /* Stream name (UTF-16) */ + char *stream_name; + + /* Stream name (UTF-8) */ + char *stream_name_utf8; +}; + +static inline u64 ads_entry_length(const struct ads_entry *entry) +{ + u64 len = WIM_ADS_ENTRY_DISK_SIZE + entry->stream_name_len + 2; + return (len + 7) & ~7; +} + +static inline void destroy_ads_entry(struct ads_entry *entry) +{ + FREE(entry->stream_name); + FREE(entry->stream_name_utf8); + memset(entry, 0, sizeof(entry)); +} + +static inline bool ads_entry_has_name(const struct ads_entry *entry, + const char *name, size_t name_len) +{ + if (entry->stream_name_utf8_len != name_len) + return false; + return memcmp(entry->stream_name_utf8, name, name_len) == 0; +} + /* In-memory structure for a directory entry. There is a directory tree for * each image in the WIM. */ @@ -36,17 +121,15 @@ struct dentry { /* The index of the node in the security table that contains this file's * security information. If -1, no security information exists for this * file. */ -#ifdef ENABLE_SECURITY_DATA int32_t security_id; -#endif /* The offset, from the start of the metadata section, of this directory * entry's child files. 0 if the directory entry has no children. */ u64 subdir_offset; /* Reserved for future disuse. Currently ignoring these fields. */ - //u64 unused1; - //u64 unused2; + u64 unused1; + u64 unused2; /* Timestamps for the entry. The timestamps are the number of * 100-nanosecond intervals that have elapsed since 12:00 A.M., January @@ -58,13 +141,16 @@ struct dentry { /* A hash of the file's contents. */ u8 hash[WIM_HASH_SIZE]; - /* Identity of a reparse point (whatever that is). Currently ignoring - * this field*/ - //u32 reparse_tag; + /* Identity of a reparse point. See + * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx + * for what a reparse point is. */ + u32 reparse_tag; /* Although M$'s documentation does not tell you this, it seems that the * reparse_reserved field does not actually exist. So the hard_link - * field directly follows the reparse_tag on disk. */ + * field directly follows the reparse_tag on disk. EXCEPT when the + * dentry is actually a reparse point... well, just take a look at the + * read_dentry() function. */ //u32 reparse_reserved; /* If the reparse_reserved field existed, there would be a 4-byte gap @@ -75,9 +161,8 @@ struct dentry { * the set will share the same value for this field. */ u64 hard_link; - /* Number of WIMStreamEntry structures that follow this struct dentry. - * Currently ignoring this field. */ - //u16 streams; + /* Number of alternate data streams associated with this file. */ + u16 num_ads; /* Length of short filename, in bytes, not including the terminating * zero wide-character. */ @@ -104,34 +189,68 @@ struct dentry { char *full_path_utf8; u32 full_path_utf8_len; - /* Stream entries for this dentry. Currently being ignored. */ - //struct WIMStreamEntry *stream_entries; - - /* Number of references to the dentry tree itself, as in multiple - * WIMStructs */ - int refcnt; + /* Alternate stream entries for this dentry. */ + struct ads_entry *ads_entries; + + union { + /* Number of references to the dentry tree itself, as in multiple + * WIMStructs */ + int refcnt; + + /* Number of times this dentry has been opened (only for + * directories!) */ + u32 num_times_opened; + }; + + /* List of dentries in the hard link set */ + enum { + GROUP_INDEPENDENT, + GROUP_MASTER, + GROUP_SLAVE + } link_group_master_status; + struct list_head link_group_list; }; -#define WIM_FILE_ATTRIBUTE_READONLY 0x1 -#define WIM_FILE_ATTRIBUTE_HIDDEN 0x2 -#define WIM_FILE_ATTRIBUTE_SYSTEM 0x4 -#define WIM_FILE_ATTRIBUTE_DIRECTORY 0x10 -#define WIM_FILE_ATTRIBUTE_ARCHIVE 0x20 -#define WIM_FILE_ATTRIBUTE_DEVICE 0x40 -#define WIM_FILE_ATTRIBUTE_NORMAL 0x80 -#define WIM_FILE_ATTRIBUTE_TEMPORARY 0x100 -#define WIM_FILE_ATTRIBUTE_SPARSE_FILE 0x200 -#define WIM_FILE_ATTRIBUTE_REPARSE_POINT 0x400 -#define WIM_FILE_ATTRIBUTE_COMPRESSED 0x800 -#define WIM_FILE_ATTRIBUTE_OFFLINE 0x1000 -#define WIM_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x2000 -#define WIM_FILE_ATTRIBUTE_ENCRYPTED 0x4000 -#define WIM_FILE_ATTRIBUTE_VIRTUAL 0x10000 +/* Return hash of the "unnamed" (default) data stream. */ +static inline const u8 *dentry_hash(const struct dentry *dentry) +{ + /* If there are alternate data streams, the dentry hash field is zeroed + * out, and we need to find the hash in the un-named data stream (should + * be the first one, but check them in order just in case, and fall back + * to the dentry hash field if we can't find an unnamed data stream). */ + for (u16 i = 0; i < dentry->num_ads; i++) + if (dentry->ads_entries[i].stream_name_len == 0) + return dentry->ads_entries[i].hash; + return dentry->hash; +} + +static inline size_t dentry_link_group_size(const struct dentry *dentry) +{ + const struct list_head *cur = &dentry->link_group_list; + size_t size = 0; + do { + size++; + cur = cur->next; + } while (cur != &dentry->link_group_list); + return size; +} + +extern struct ads_entry *dentry_get_ads_entry(struct dentry *dentry, + const char *stream_name); + +extern struct ads_entry *dentry_add_ads(struct dentry *dentry, + const char *stream_name); + +extern void dentry_remove_ads(struct dentry *dentry, struct ads_entry *entry); + +extern const char *path_stream_name(const char *path); + +extern u64 dentry_total_length(const struct dentry *dentry); extern void stbuf_to_dentry(const struct stat *stbuf, struct dentry *dentry); -extern void dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf, - const struct lookup_table *table); +extern int dentry_to_stbuf(const struct dentry *dentry, struct stat *stbuf, + const struct lookup_table *table); extern int for_dentry_in_tree(struct dentry *root, int (*visitor)(struct dentry*, void*), @@ -143,7 +262,11 @@ extern int for_dentry_in_tree_depth(struct dentry *root, extern int calculate_dentry_full_path(struct dentry *dentry, void *ignore); extern void calculate_subdir_offsets(struct dentry *dentry, u64 *subdir_offset_p); +extern int get_names(char **name_utf16_ret, char **name_utf8_ret, + u16 *name_utf16_len_ret, u16 *name_utf8_len_ret, + const char *name); extern int change_dentry_name(struct dentry *dentry, const char *new_name); +extern int change_ads_name(struct ads_entry *entry, const char *new_name); extern void unlink_dentry(struct dentry *dentry); extern void link_dentry(struct dentry *dentry, struct dentry *parent); @@ -159,7 +282,12 @@ extern void dentry_update_all_timestamps(struct dentry *dentry); extern void init_dentry(struct dentry *dentry, const char *name); extern struct dentry *new_dentry(const char *name); +extern void dentry_free_ads_entries(struct dentry *dentry); extern void free_dentry(struct dentry *dentry); +extern void put_dentry(struct dentry *dentry); +extern int share_dentry_ads(struct dentry *master, + struct dentry *slave); +extern struct dentry *clone_dentry(struct dentry *old); extern void free_dentry_tree(struct dentry *root, struct lookup_table *lookup_table, bool lt_decrement_refcnt); @@ -181,19 +309,9 @@ extern int read_dentry_tree(const u8 metadata_resource[], extern u8 *write_dentry_tree(const struct dentry *tree, u8 *p); + /* Inline utility functions for WIMDentries */ -/* - * Returns true if @dentry has the UTF-8 file name @name that has length - * @name_len. - */ -static inline bool dentry_has_name(const struct dentry *dentry, const char *name, - size_t name_len) -{ - if (dentry->file_name_utf8_len != name_len) - return false; - return memcmp(dentry->file_name_utf8, name, name_len) == 0; -} static inline bool dentry_is_root(const struct dentry *dentry) { @@ -212,12 +330,22 @@ static inline bool dentry_is_only_child(const struct dentry *dentry) static inline bool dentry_is_directory(const struct dentry *dentry) { - return (dentry->attributes & WIM_FILE_ATTRIBUTE_DIRECTORY) != 0; + return (dentry->attributes & FILE_ATTRIBUTE_DIRECTORY) + && !(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT); +} + +/* For our purposes, we consider "real" symlinks and "junction points" to both + * be symlinks. */ +static inline bool dentry_is_symlink(const struct dentry *dentry) +{ + return (dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT) + && ((dentry->reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK) || + dentry->reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT); } static inline bool dentry_is_regular_file(const struct dentry *dentry) { - return !dentry_is_directory(dentry); + return !dentry_is_directory(dentry) && !dentry_is_symlink(dentry); } static inline bool dentry_is_empty_directory(const struct dentry *dentry)