]> wimlib.net Git - wimlib/blobdiff - src/hardlink.c
WIM capture: Share inodes immediately
[wimlib] / src / hardlink.c
index ed605d675b898aeafc70bf73756a966a0698e71e..ff42f26f32ba0955aee94f895059cb7f88f523e9 100644 (file)
@@ -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.
  *
  *                            -----------------
  */
 
-/* Hash table to find inodes, identified by their inode ID.
- * */
-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
-        *   before calling assign_inode_numbers().
-         *
-        * - Groups we create ourselves by splitting a nominal inode due to
-        *   inconsistencies in the dentries.  These inodes will share a inode
-        *   ID with some other inode until assign_inode_numbers() is called.
-        */
-       struct hlist_head extra_inodes;
-};
-
-static inline void destroy_inode_table(struct wim_inode_table *table)
-{
-       FREE(table->array);
-}
 
-static int init_inode_table(struct wim_inode_table *table, size_t capacity)
+int
+init_inode_table(struct wim_inode_table *table, size_t capacity)
 {
        table->array = CALLOC(capacity, sizeof(table->array[0]));
        if (!table->array) {
@@ -89,7 +64,8 @@ static int init_inode_table(struct wim_inode_table *table, size_t capacity)
        return 0;
 }
 
-static inline size_t inode_link_count(const struct wim_inode *inode)
+static inline size_t
+inode_link_count(const struct wim_inode *inode)
 {
        const struct list_head *cur;
        size_t size = 0;
@@ -101,9 +77,10 @@ static inline size_t inode_link_count(const struct wim_inode *inode)
 /* Insert a dentry into the inode table based on the inode number of the
  * attached inode (which came from the hard link group ID field of the on-disk
  * WIM dentry) */
-static int inode_table_insert(struct wim_dentry *dentry, void *__table)
+static int
+inode_table_insert(struct wim_dentry *dentry, void *_table)
 {
-       struct wim_inode_table *table = __table;
+       struct wim_inode_table *table = _table;
        struct wim_inode *d_inode = dentry->d_inode;
 
        if (d_inode->i_ino == 0) {
@@ -145,25 +122,86 @@ static int inode_table_insert(struct wim_dentry *dentry, void *__table)
        return 0;
 }
 
-static void print_inode_dentries(const struct wim_inode *inode)
+static struct wim_inode *
+inode_table_get_inode(struct wim_inode_table *table, u64 ino, u64 devno)
+{
+       u64 hash = hash_u64(hash_u64(ino) + hash_u64(devno));
+       size_t pos = hash % table->capacity;
+       struct wim_inode *inode;
+       struct hlist_node *cur;
+
+       hlist_for_each_entry(inode, cur, &table->array[pos], i_hlist) {
+               if (inode->i_ino == ino && inode->i_devno == devno) {
+                       DEBUG("Using existing inode {devno=%"PRIu64", ino=%"PRIu64"}",
+                             devno, ino);
+                       inode->i_nlink++;
+                       return inode;
+               }
+       }
+       inode = new_timeless_inode();
+       if (inode) {
+               inode->i_ino = ino;
+               inode->i_devno = devno;
+               hlist_add_head(&inode->i_hlist, &table->array[pos]);
+               table->num_entries++;
+       }
+       return inode;
+}
+
+/* Given a directory entry with the name @name for the file with the inode
+ * number @ino and device number @devno, create a new WIM dentry with an
+ * associated inode, where the inode is shared if an inode with the same @ino
+ * and @devno has already been created.  On success, the new WIM dentry is
+ * written to *dentry_ret, and its inode has i_nlink > 1 if a previously
+ * existing inode was used.
+ */
+int
+inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
+                      u64 ino, u64 devno, struct wim_dentry **dentry_ret)
+{
+       struct wim_dentry *dentry;
+       struct wim_inode *inode;
+       int ret;
+
+       ret = new_dentry(name, &dentry);
+       if (ret)
+               return ret;
+
+       inode = inode_table_get_inode(table, ino, devno);
+       if (!inode) {
+               free_dentry(dentry);
+               return WIMLIB_ERR_NOMEM;
+       }
+       dentry->d_inode = inode;
+       inode_add_dentry(dentry, inode);
+       *dentry_ret = dentry;
+       return 0;
+}
+
+#if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
+static void
+print_inode_dentries(const struct wim_inode *inode)
 {
        struct wim_dentry *dentry;
        inode_for_each_dentry(dentry, inode)
-               printf("`%s'\n", dentry->full_path_utf8);
+               tprintf(T("`%"TS"'\n"), dentry->full_path);
 }
+#endif
 
-static void inconsistent_inode(const struct wim_inode *inode)
+static void
+inconsistent_inode(const struct wim_inode *inode)
 {
+#ifdef ENABLE_ERROR_MESSAGES
        ERROR("An inconsistent hard link group that cannot be corrected has "
              "been detected");
        ERROR("The dentries are located at the following paths:");
-#ifdef ENABLE_ERROR_MESSAGES
        print_inode_dentries(inode);
 #endif
 }
 
-static bool ref_inodes_consistent(const struct wim_inode * restrict ref_inode_1,
-                                 const struct wim_inode * restrict ref_inode_2)
+static bool
+ref_inodes_consistent(const struct wim_inode * restrict ref_inode_1,
+                     const struct wim_inode * restrict ref_inode_2)
 {
        wimlib_assert(ref_inode_1 != ref_inode_2);
 
@@ -186,8 +224,9 @@ static bool ref_inodes_consistent(const struct wim_inode * restrict ref_inode_1,
        return true;
 }
 
-static bool inodes_consistent(const struct wim_inode * restrict ref_inode,
-                             const struct wim_inode * restrict inode)
+static bool
+inodes_consistent(const struct wim_inode * restrict ref_inode,
+                 const struct wim_inode * restrict inode)
 {
        wimlib_assert(ref_inode != inode);
 
@@ -211,7 +250,8 @@ static bool inodes_consistent(const struct wim_inode * restrict ref_inode,
 }
 
 /* Fix up a "true" inode and check for inconsistencies */
-static int fix_true_inode(struct wim_inode *inode, struct hlist_head *inode_list)
+static int
+fix_true_inode(struct wim_inode *inode, struct hlist_head *inode_list)
 {
        struct wim_dentry *dentry;
        struct wim_dentry *ref_dentry = NULL;
@@ -273,8 +313,9 @@ static int fix_true_inode(struct wim_inode *inode, struct hlist_head *inode_list
  * wim_inode's.  There will be just one `struct wim_inode' for each hard link
  * group remaining.
  */
-static int fix_nominal_inode(struct wim_inode *inode,
-                            struct hlist_head *inode_list)
+static int
+fix_nominal_inode(struct wim_inode *inode, struct hlist_head *inode_list,
+                 bool *ino_changes_needed)
 {
        struct wim_dentry *dentry;
        struct hlist_node *cur, *tmp;
@@ -366,23 +407,25 @@ next_dentry_2:
                list_for_each_entry(dentry, &dentries_with_no_data_streams, tmp_list)
                        inode_add_dentry(dentry, inode);
        }
-       #ifdef ENABLE_DEBUG
         if (num_true_inodes != 1) {
+       #ifdef ENABLE_DEBUG
                inode = container_of(true_inodes.first, struct wim_inode, i_hlist);
 
-               printf("Split nominal inode 0x%"PRIx64" into %zu "
-                      "inodes:\n",
-                      inode->i_ino, num_true_inodes);
-               puts("------------------------------------------------------------------------------");
+               tprintf(T("Split nominal inode 0x%"PRIx64" into %zu "
+                         "inodes:\n"), inode->i_ino, num_true_inodes);
+               tputs(T("----------------------------------------------------"
+                       "--------------------------"));
                size_t i = 1;
                hlist_for_each_entry(inode, cur, &true_inodes, i_hlist) {
-                       printf("[Split inode %zu]\n", i++);
+                       tprintf(T("[Split inode %zu]\n"), i++);
                        print_inode_dentries(inode);
-                       putchar('\n');
+                       tputchar(T('\n'));
                }
-               puts("------------------------------------------------------------------------------");
-        }
+               tputs(T("----------------------------------------------------"
+                       "--------------------------"));
        #endif
+               *ino_changes_needed = true;
+        }
 
        hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, i_hlist) {
                ret = fix_true_inode(inode, inode_list);
@@ -392,8 +435,9 @@ next_dentry_2:
        return 0;
 }
 
-static int fix_inodes(struct wim_inode_table *table,
-                     struct hlist_head *inode_list)
+static int
+fix_inodes(struct wim_inode_table *table, struct hlist_head *inode_list,
+          bool *ino_changes_needed)
 {
        struct wim_inode *inode;
        struct hlist_node *cur, *tmp;
@@ -401,7 +445,7 @@ static int fix_inodes(struct wim_inode_table *table,
        INIT_HLIST_HEAD(inode_list);
        for (u64 i = 0; i < table->capacity; i++) {
                hlist_for_each_entry_safe(inode, cur, tmp, &table->array[i], i_hlist) {
-                       ret = fix_nominal_inode(inode, inode_list);
+                       ret = fix_nominal_inode(inode, inode_list, ino_changes_needed);
                        if (ret != 0)
                                return ret;
                }
@@ -414,13 +458,13 @@ static int fix_inodes(struct wim_inode_table *table,
 /*
  * dentry_tree_fix_inodes():
  *
- * This function takes as input a tree of WIM dentries that has a different
- * inode associated with every dentry.  Sets of dentries that share the same
- * inode (a.k.a. hard link groups) are built using the i_ino field of each
- * inode, then the link count and alias list for one inode in each set is set
- * correctly and the unnecessary struct wim_inode's freed.  The effect is to
- * correctly associate exactly one struct wim_inode with each original inode,
- * regardless of how many dentries are aliases for that inode.
+ * This function takes as input a tree of WIM dentries that initially has a
+ * different inode associated with each dentry.  Sets of dentries that should
+ * share the same inode (a.k.a. hard link groups) are built using the i_ino
+ * field of each inode, then the link count and alias list for one inode in each
+ * set is set correctly and the unnecessary struct wim_inode's freed.  The
+ * effect is to correctly associate exactly one struct wim_inode with each
+ * original inode, regardless of how many dentries are aliases for that inode.
  *
  * The special inode number of 0 indicates that the dentry is in a hard link
  * group by itself, and therefore has a 'struct wim_inode' with i_nlink=1 to
@@ -429,45 +473,72 @@ static int fix_inodes(struct wim_inode_table *table,
  * This function also checks the dentries in each hard link group for
  * consistency.  In some WIMs, such as install.wim for some versions of Windows
  * 7, dentries can share the same hard link group ID but not actually be hard
- * linked to each other (e.g. to having different data streams).  This should be
- * an error, but this case needs be handled.  So, each "nominal" inode (the
- * inode based on the inode numbers provided in the WIM) is examined for
- * consistency and may be split into multiple "true" inodes that are maximally
- * sized consistent sets of dentries.
+ * linked to each other (based on conflicting information, such as file
+ * contents).  This should be an error, but this case needs be handled.  So,
+ * each "nominal" inode (the inode based on the inode numbers provided in the
+ * WIM) is examined for consistency and may be split into multiple "true" inodes
+ * that are maximally sized consistent sets of dentries.
  *
  * Return 0 on success; WIMLIB_ERR_NOMEM or WIMLIB_ERR_INVALID_DENTRY on
  * failure.  On success, the list of "true" inodes, linked by the i_hlist field,
  * is returned in the hlist @inode_list.
  */
-int dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list)
+int
+dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list)
 {
        struct wim_inode_table inode_tab;
        int ret;
+       bool ino_changes_needed;
 
        DEBUG("Inserting dentries into inode table");
        ret = init_inode_table(&inode_tab, 9001);
-       if (ret != 0)
+       if (ret)
                return ret;
 
        for_dentry_in_tree(root, inode_table_insert, &inode_tab);
 
        DEBUG("Cleaning up the hard link groups");
-       ret = fix_inodes(&inode_tab, inode_list);
+       ino_changes_needed = false;
+       ret = fix_inodes(&inode_tab, inode_list, &ino_changes_needed);
        destroy_inode_table(&inode_tab);
+
+       if (ret == 0 && ino_changes_needed) {
+               u64 cur_ino = 1;
+               struct hlist_node *tmp;
+               struct wim_inode *inode;
+
+               WARNING("Re-assigning inode numbers due to inode inconsistencies");
+               hlist_for_each_entry(inode, tmp, inode_list, i_hlist) {
+                       if (inode->i_nlink > 1)
+                               inode->i_ino = cur_ino++;
+                       else
+                               inode->i_ino = 0;
+               }
+       }
        return ret;
 }
 
-/* Assign inode numbers to a list of inode, and return the next available
- * number. */
-u64 assign_inode_numbers(struct hlist_head *inode_list)
+/* Assign consecutive inode numbers to the inodes in the inode table, and move
+ * the inodes to a single list @head. */
+void
+inode_table_prepare_inode_list(struct wim_inode_table *table,
+                              struct hlist_head *head)
 {
-       DEBUG("Assigning inode numbers");
        struct wim_inode *inode;
-       struct hlist_node *cur;
+       struct hlist_node *cur, *tmp;
        u64 cur_ino = 1;
-       hlist_for_each_entry(inode, cur, inode_list, i_hlist) {
-               inode->i_ino = cur_ino;
-               cur_ino++;
+
+       INIT_HLIST_HEAD(head);
+       for (size_t i = 0; i < table->capacity; i++) {
+               hlist_for_each_entry_safe(inode, cur, tmp, &table->array[i], i_hlist)
+               {
+                       if (inode->i_nlink > 1)
+                               inode->i_ino = cur_ino++;
+                       else
+                               inode->i_ino = 0;
+                       hlist_add_head(&inode->i_hlist, head);
+               }
+               INIT_HLIST_HEAD(&table->array[i]);
        }
-       return cur_ino;
+       table->num_entries = 0;
 }