]> wimlib.net Git - wimlib/blobdiff - src/dentry.h
Fix wimfs_getattr()
[wimlib] / src / dentry.h
index 6c260fc2538f37f305b84c49f2d022156ada4938..613f6259e95c1b1884c81e6852a4e8e754b6534a 100644 (file)
@@ -3,8 +3,15 @@
 
 #include "util.h"
 #include "config.h"
+#include "list.h"
+#include "sha1.h"
 #include <string.h>
 
+
+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
 
@@ -13,8 +20,6 @@
 /* 
  * Reparse tags documented at 
  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
- *
- * IO_REPARSE_TAG_SYMLINK is the only one we really care about.
  */
 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO       0x00000000
 #define WIM_IO_REPARSE_TAG_RESERVED_ONE                0x00000001
 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
 
+struct lookup_table_entry;
+
 /* Alternate data stream entry */
 struct ads_entry {
-       /* SHA-1 message digest of stream contents */
-       u8 hash[WIM_HASH_SIZE];
+       union {
+               /* SHA-1 message digest of stream contents */
+               u8 hash[SHA1_HASH_SIZE];
+
+               /* The corresponding lookup table entry (only for resolved
+                * streams) */
+               struct lookup_table_entry *lte;
+       };
 
        /* Length of stream name (UTF-16) */
        u16 stream_name_len;
 
        /* Length of stream name (UTF-8) */
-       u16 stream_name_len_utf8;
+       u16 stream_name_utf8_len;
 
        /* Stream name (UTF-16) */
        char *stream_name;
 
        /* Stream name (UTF-8) */
        char *stream_name_utf8;
+
+       /* Doubly linked list of streams that share the same lookup table entry */
+       struct stream_list_head lte_group_list;
 };
 
 static inline u64 ads_entry_length(const struct ads_entry *entry)
@@ -68,7 +84,23 @@ static inline u64 ads_entry_length(const struct ads_entry *entry)
        return (len + 7) & ~7;
 }
 
-/* In-memory structure for a directory entry.  There is a directory tree for
+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 WIM directory entry.  There is a directory tree for
  * each image in the WIM.  */
 struct dentry {
        /* The parent of this directory entry. */
@@ -90,7 +122,6 @@ struct dentry {
         * included only the length field, but that takes up 8 bytes. */
        u64 length;
 
-
        /* The file attributes associated with this file. */
        u32 attributes;
 
@@ -103,10 +134,6 @@ struct dentry {
         * 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;
-
        /* Timestamps for the entry.  The timestamps are the number of
         * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
         * 1st, 1601, UTC. */
@@ -114,8 +141,20 @@ struct dentry {
        u64 last_access_time;
        u64 last_write_time;
 
-       /* A hash of the file's contents. */
-       u8 hash[WIM_HASH_SIZE];
+       /* true if the dentry's lookup table entry has been resolved (i.e. the
+        * @lte field is invalid, but the @hash field is not valid) */
+       bool resolved;
+
+       /* A hash of the file's contents, or a pointer to the lookup table entry
+        * for this dentry if the lookup table entries have been resolved.
+        *
+        * More specifically, this is for the un-named default file stream, as
+        * opposed to the alternate file streams, which may have their own
+        * lookup table entries.  */
+       union {
+               u8 hash[SHA1_HASH_SIZE];
+               struct lookup_table_entry *lte;
+       };
 
        /* Identity of a reparse point.  See
         * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
@@ -129,14 +168,6 @@ struct dentry {
         * read_dentry() function. */
        //u32 reparse_reserved;
 
-       /* If the reparse_reserved field existed, there would be a 4-byte gap
-        * here to align hard_link on an 8-byte field.  However,
-        * reparse_reserved does not actually exist, so there is no gap here. */
-
-       /* If the file is part of a hard link set, all the directory entries in
-        * the set will share the same value for this field. */
-       u64 hard_link;
-
        /* Number of alternate data streams associated with this file. */
        u16 num_ads;
 
@@ -168,31 +199,73 @@ struct dentry {
        /* Alternate stream entries for this dentry. */
        struct ads_entry *ads_entries;
 
-       /* Number of references to the dentry tree itself, as in multiple
-        * WIMStructs */
-       int refcnt;
+       union {
+               /* Number of references to the dentry tree itself, as in multiple
+                * WIMStructs */
+               u32 refcnt;
+
+               /* Number of times this dentry has been opened (only for
+                * directories!) */
+               u32 num_times_opened;
+       };
+
+       /* If the file is part of a hard link set, all the directory entries in
+        * the set will share the same value for this field. */
+       u64 hard_link;
+
+       enum {
+               /* This dentry is the owner of its ads_entries, although it may
+                * be in a hard link set */
+               ADS_ENTRIES_DEFAULT = 0,
+
+               /* This dentry is the owner of the ads_entries in the hard link
+                * set */
+               ADS_ENTRIES_OWNER,
+
+               /* This dentry shares its ads_entries with a dentry in the hard
+                * link set that has ADS_ENTRIES_OWNER set. */
+               ADS_ENTRIES_USER
+       } ads_entries_status;
+
+
+       /* List of dentries in the hard link set */
+       struct list_head link_group_list;
+
+       /* List of dentries sharing the same lookup table entry */
+       struct stream_list_head lte_group_list;
+
+       /* Path to extracted file on disk (used during extraction only) */
+       char *extracted_file;
 };
 
-/* Return hash of the "unnamed" (default) data stream. */
-static inline const u8 *dentry_hash(const struct dentry *dentry)
+
+/* Return the number of dentries in the hard link group */
+static inline size_t dentry_link_group_size(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;
+       const struct list_head *cur = &dentry->link_group_list;
+       size_t size = 0;
+       wimlib_assert(cur != NULL);
+       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 for_dentry_in_tree(struct dentry *root, 
                              int (*visitor)(struct dentry*, void*), 
                              void *args);
@@ -203,7 +276,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);
@@ -219,10 +296,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 struct dentry *clone_dentry(struct dentry *old);
 extern void free_dentry_tree(struct dentry *root,
-                            struct lookup_table *lookup_table, 
-                            bool lt_decrement_refcnt);
+                            struct lookup_table *lookup_table);
 extern int increment_dentry_refcnt(struct dentry *dentry, void *ignore);
 extern int decrement_dentry_refcnt(struct dentry *dentry, void *ignore);
 
@@ -241,19 +320,8 @@ 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;
-}
+/* Inline utility functions for dentries */
 
 static inline bool dentry_is_root(const struct dentry *dentry)
 {
@@ -272,18 +340,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 & 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_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)