]> wimlib.net Git - wimlib/blobdiff - src/dentry.h
NTFS capture updates
[wimlib] / src / dentry.h
index 9612836348152aaffb50cf38e17731e5ac5ddfe9..d634abcdc61173519f8f58fe016fe837bd500e7d 100644 (file)
@@ -4,6 +4,7 @@
 #include "util.h"
 #include "config.h"
 #include "list.h"
+#include "sha1.h"
 #include <string.h>
 
 
@@ -16,10 +17,6 @@ typedef struct WIMStruct WIMStruct;
 
 #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
@@ -58,7 +55,7 @@ struct lookup_table_entry;
 struct ads_entry {
        union {
                /* SHA-1 message digest of stream contents */
-               u8 hash[WIM_HASH_SIZE];
+               u8 hash[SHA1_HASH_SIZE];
 
                /* The corresponding lookup table entry (only for resolved
                 * streams) */
@@ -77,6 +74,7 @@ struct ads_entry {
        /* 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;
 };
 
@@ -102,7 +100,7 @@ static inline bool ads_entry_has_name(const struct ads_entry *entry,
 }
 
 
-/* In-memory structure for a directory entry.  There is a directory tree for
+/* 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. */
@@ -116,45 +114,54 @@ struct dentry {
        /* Pointer to a child of this directory entry. */
        struct dentry *children;
 
-       /* Size of directory entry, in bytes.  Typical size is around 104 to 120
-        * bytes. */
-       /* It is possible for the length field to be 0.  This situation, which
+       /* Size of directory entry on disk, in bytes.  Typical size is around
+        * 104 to 120 bytes.
+        *
+        * It is possible for the length field to be 0.  This situation, which
         * is undocumented, indicates the end of a list of sibling nodes in a
         * directory.  It also means the real length is 8, because the dentry
-        * included only the length field, but that takes up 8 bytes. */
+        * included only the length field, but that takes up 8 bytes.
+        *
+        * The length here includes the base directory entry on disk as well as
+        * the long and short filenames.  It does NOT include any alternate
+        * stream entries that may follow the directory entry, even though the
+        * size of those needs to be considered.
+        */
        u64 length;
 
        /* The file attributes associated with this file. */
        u32 attributes;
 
-       /* 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.  */
+       /* The index of the security descriptor in the WIM image's table of
+        * security descriptors that contains this file's security information.
+        * If -1, no security information exists for this file.  */
        int32_t security_id;
 
-       /* The offset, from the start of the metadata section, of this directory
-        * entry's child files.  0 if the directory entry has no children. */
+       /* The offset, from the start of the WIM metadata resource for this
+        * image, of this directory entry's child files.  0 if the directory
+        * entry has no children (as in the case of regular files or reparse
+        * points). */
        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
+       /* Timestamps for the dentry.  The timestamps are the number of
         * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
         * 1st, 1601, UTC. */
        u64 creation_time;
        u64 last_access_time;
        u64 last_write_time;
 
+       /* true if the dentry's lookup table entry has been resolved (i.e. the
+        * @lte field is valid, 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.  */
+        * opposed to the alternate (named) file streams, which may have their
+        * own lookup table entries.  */
        union {
-               u8 hash[WIM_HASH_SIZE];
+               u8 hash[SHA1_HASH_SIZE];
                struct lookup_table_entry *lte;
        };
 
@@ -204,7 +211,7 @@ struct dentry {
        union {
                /* Number of references to the dentry tree itself, as in multiple
                 * WIMStructs */
-               int refcnt;
+               u32 refcnt;
 
                /* Number of times this dentry has been opened (only for
                 * directories!) */
@@ -212,22 +219,26 @@ struct dentry {
        };
 
        /* 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. */
+        * the set will share the same value for this field. 
+        *
+        * Unfortunately, in some WIMs it is NOT the case that all dentries that
+        * share this field are actually in the same hard link set, although the
+        * WIMs that wimlib writes maintain this restriction. */
        u64 hard_link;
 
        enum {
                /* This dentry is the owner of its ads_entries, although it may
                 * be in a hard link set */
-               GROUP_INDEPENDENT = 0,
+               ADS_ENTRIES_DEFAULT = 0,
 
                /* This dentry is the owner of the ads_entries in the hard link
                 * set */
-               GROUP_MASTER,
+               ADS_ENTRIES_OWNER,
 
                /* This dentry shares its ads_entries with a dentry in the hard
-                * link set that has GROUP_MASTER set. */
-               GROUP_SLAVE
-       } link_group_master_status;
+                * link set that has ADS_ENTRIES_OWNER set. */
+               ADS_ENTRIES_USER
+       } ads_entries_status;
 
 
        /* List of dentries in the hard link set */
@@ -240,34 +251,13 @@ struct dentry {
        char *extracted_file;
 };
 
-/* 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;
-}
-
-/* Return lte for the "unnamed" (default) data stream.  Only for resolved
- * dentries */
-static inline struct lookup_table_entry *
-dentry_lte(const struct dentry *dentry)
-{
-       for (u16 i = 0; i < dentry->num_ads; i++)
-               if (dentry->ads_entries[i].stream_name_len == 0)
-                       return dentry->ads_entries[i].lte;
-       return dentry->lte;
-}
 
+/* Return the number of dentries in the hard link group */
 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;
+       wimlib_assert(cur != NULL);
        do {
                size++;
                cur = cur->next;
@@ -322,12 +312,9 @@ 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);
+                            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);
 
@@ -347,8 +334,7 @@ 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 */
-
+/* Inline utility functions for dentries */
 
 static inline bool dentry_is_root(const struct dentry *dentry)
 {